Add Unzipper.

5 files changed, 193 insertions, 0 deletions

diff --git a/src/lib/unzipper.cc b/src/lib/unzipper.cc
new file mode 100644
index 000000000..2add8f2a9
--- /dev/null
+++ b/src/lib/unzipper.cc
@@ -0,0 +1,89 @@
+/*
+    Copyright (C) 2024 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    DCP-o-matic is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include "dcpomatic_assert.h"
+#include "exceptions.h"
+#include "unzipper.h"
+#include <dcp/filesystem.h>
+#include <dcp/scope_guard.h>
+#include <zip.h>
+#include <boost/filesystem.hpp>
+#include <stdexcept>
+
+#include "i18n.h"
+
+
+using std::runtime_error;
+using std::shared_ptr;
+using std::string;
+
+
+Unzipper::Unzipper(boost::filesystem::path file)
+{
+	int error;
+	_zip = zip_open(dcp::filesystem::fix_long_path(file).string().c_str(), ZIP_RDONLY, &error);
+	if (!_zip) {
+		throw FileError("could not open ZIP file", file);
+	}
+}
+
+
+Unzipper::~Unzipper()
+{
+	zip_close(_zip);
+}
+
+
+string
+Unzipper::get(string const& filename)
+{
+	auto file = zip_fopen(_zip, filename.c_str(), 0);
+	if (!file) {
+		throw runtime_error(String::compose(_("Could not find file %1 in ZIP file"), filename));
+	}
+
+	dcp::ScopeGuard sg = [file]() { zip_fclose(file); };
+
+	int constexpr maximum = 65536;
+
+	dcp::ArrayData data(maximum);
+	int remaining = maximum;
+	uint8_t* next = data.data();
+
+	while (remaining > 0) {
+		auto read = zip_fread(file, next, remaining);
+		if (read == 0) {
+			break;
+		} else if (read == -1) {
+			throw runtime_error("Could not read from ZIP file");
+		}
+
+		next += read;
+		remaining -= read;
+	}
+
+	if (remaining == 0) {
+		throw runtime_error("File from ZIP is too big");
+	}
+
+	return string(reinterpret_cast<char*>(data.data()), maximum - remaining);
+}
+
diff --git a/src/lib/unzipper.h b/src/lib/unzipper.h
new file mode 100644
index 000000000..7cab6e5f4
--- /dev/null
+++ b/src/lib/unzipper.h
@@ -0,0 +1,43 @@
+/*
+    Copyright (C) 2024 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    DCP-o-matic is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include <boost/filesystem.hpp>
+#include <memory>
+#include <vector>
+
+
+class Unzipper
+{
+public:
+	explicit Unzipper(boost::filesystem::path file);
+	~Unzipper();
+
+	Unzipper(Unzipper const&) = delete;
+	Unzipper& operator=(Unzipper const&) = delete;
+
+	std::string get(std::string const& filename);
+
+private:
+	struct zip* _zip;
+	std::vector<std::shared_ptr<std::string>> _store;
+};
+
+
diff --git a/src/lib/wscript b/src/lib/wscript
index 2849409f8..0d61d7a69 100644
--- a/src/lib/wscript
+++ b/src/lib/wscript
@@ -194,6 +194,7 @@ sources = """
           rough_duration.cc
           signal_manager.cc
           stdout_log.cc
+          unzipper.cc
           update_checker.cc
           upload_job.cc
           uploader.cc
diff --git a/test/unzipper_test.cc b/test/unzipper_test.cc
new file mode 100644
index 000000000..f78f15c3f
--- /dev/null
+++ b/test/unzipper_test.cc
@@ -0,0 +1,59 @@
+/*
+    Copyright (C) 2024 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    DCP-o-matic is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+/** @file  test/unzipper_test.cc
+ *  @brief Test Unzipper class.
+ *  @ingroup selfcontained
+ */
+
+
+#include "lib/exceptions.h"
+#include "lib/unzipper.h"
+#include "lib/zipper.h"
+#include "test.h"
+#include <dcp/filesystem.h>
+#include <dcp/util.h>
+#include <boost/test/unit_test.hpp>
+#include <boost/filesystem.hpp>
+
+
+using std::string;
+
+
+/** Basic test of Unzipper working normally */
+BOOST_AUTO_TEST_CASE(unzipper_test1)
+{
+	boost::system::error_code ec;
+	boost::filesystem::remove("build/test/zipped.zip", ec);
+
+	Zipper zipper("build/test/zipped.zip");
+	zipper.add("foo.txt", "1234567890");
+	zipper.add("bar.txt", "xxxxxxCCCCbbbbbbb1");
+	zipper.add("its_bigger_than_that_chris_its_large.txt", string(128 * 1024, 'X'));
+	zipper.close();
+
+	Unzipper unzipper("build/test/zipped.zip");
+	BOOST_CHECK_EQUAL(unzipper.get("foo.txt"), "1234567890");
+	BOOST_CHECK_EQUAL(unzipper.get("bar.txt"), "xxxxxxCCCCbbbbbbb1");
+	BOOST_CHECK_THROW(unzipper.get("hatstand"), std::runtime_error);
+	BOOST_CHECK_THROW(unzipper.get("its_bigger_than_that_chris_its_large.txt"), std::runtime_error);
+}
+
diff --git a/test/wscript b/test/wscript
index 7930397f6..a98f15d5b 100644
--- a/test/wscript
+++ b/test/wscript
@@ -163,6 +163,7 @@ def build(bld):
                  threed_test.cc
                  time_calculation_test.cc
                  torture_test.cc
+                 unzipper_test.cc
                  update_checker_test.cc
                  upmixer_a_test.cc
                  util_test.cc