Initial commit

engines/ultima/shared/engine/data_archive.cpp

@@ -0,0 +1,241 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include "ultima/shared/engine/data_archive.h"
+#include "common/config-manager.h"
+#include "common/file.h"
+#include "common/translation.h"
+#include "common/compression/unzip.h"
+
+namespace Ultima {
+namespace Shared {
+
+#define DATA_FILENAME "ultima.dat"
+
+class UltimaDataArchiveMember : public Common::ArchiveMember {
+private:
+	Common::SharedPtr<Common::ArchiveMember> _member;
+	Common::Path _publicFolder;
+	Common::Path _innerfolder;
+public:
+	UltimaDataArchiveMember(Common::SharedPtr<Common::ArchiveMember> member,
+		const Common::Path &subfolder) :
+		_member(member), _publicFolder("data/"), _innerfolder(subfolder) {
+	}
+	~UltimaDataArchiveMember() override {}
+	Common::SeekableReadStream *createReadStream() const override {
+		return _member->createReadStream();
+	}
+	Common::SeekableReadStream *createReadStreamForAltStream(Common::AltStreamType altStreamType) const override {
+		return _member->createReadStreamForAltStream(altStreamType);
+	}
+	Common::Path getPathInArchive() const override {
+		Common::Path name = _member->getPathInArchive();
+		assert(name.isRelativeTo(_innerfolder));
+		return _publicFolder.join(name.relativeTo(_innerfolder));
+	}
+	Common::U32String getDisplayName() const override {
+		return _member->getDisplayName();
+	}
+	
+	Common::String getFileName() const override { return _member->getFileName(); }
+	Common::String getName() const override { return getPathInArchive().toString('/'); }
+
+	bool isDirectory() const override { return _member->isDirectory(); }
+};
+
+/*-------------------------------------------------------------------*/
+
+bool UltimaDataArchive::load(const Common::Path &subfolder,
+		int reqMajorVersion, int reqMinorVersion, Common::U32String &errorMsg) {
+	Common::Archive *dataArchive = nullptr;
+	Common::File f;
+
+#ifndef RELEASE_BUILD
+	Common::FSNode folder;
+	if (ConfMan.hasKey("extrapath")) {
+		if ((folder = Common::FSNode(ConfMan.getPath("extrapath"))).exists()
+				&& (folder = folder.getChild("files")).exists()
+				&& (folder = folder.getChild(subfolder.baseName())).exists()) {
+			f.open(folder.getChild("version.txt"));
+		}
+	}
+
+#endif
+	if (!f.isOpen()) {
+		if (!Common::File::exists(DATA_FILENAME) ||
+			(dataArchive = Common::makeZipArchive(DATA_FILENAME)) == 0 ||
+			!f.open(subfolder.join("version.txt"), *dataArchive)) {
+			delete dataArchive;
+			errorMsg = Common::U32String::format(_("Could not locate engine data %s"), DATA_FILENAME);
+			return false;
+		}
+	}
+
+	// Validate the version
+	char buffer[5];
+	f.read(buffer, 4);
+	buffer[4] = '\0';
+
+	int major = 0, minor = 0;
+	if (buffer[1] == '.') {
+		major = buffer[0] - '0';
+		minor = atoi(&buffer[2]);
+	}
+
+	if (major != reqMajorVersion || minor != reqMinorVersion) {
+		delete dataArchive;
+		errorMsg = Common::U32String::format(_("Out of date engine data. Expected %d.%d, but got version %d.%d"),
+			reqMajorVersion, reqMinorVersion, major, minor);
+		return false;
+	}
+
+	// It was all validated correctly
+	Common::Archive *archive;
+#ifndef RELEASE_BUILD
+	if (!dataArchive)
+		archive = new UltimaDataArchiveProxy(folder);
+	else
+#endif
+		archive = new UltimaDataArchive(dataArchive, subfolder);
+
+	SearchMan.add("data", archive);
+	return true;
+}
+
+/*-------------------------------------------------------------------*/
+
+bool UltimaDataArchive::hasFile(const Common::Path &path) const {
+	if (!path.isRelativeTo(_publicFolder))
+		return false;
+
+	Common::Path realFilename = innerToPublic(path);
+	return _zip->hasFile(realFilename);
+}
+
+int UltimaDataArchive::listMatchingMembers(Common::ArchiveMemberList &list, const Common::Path &pattern, bool matchPathComponents) const {
+	Common::ArchiveMemberList innerList;
+	int numMatches = 0;
+	// Test whether we can skip filtering.
+	bool matchAll = matchPathComponents && pattern == "*";
+
+	// First, get all zip members relevant to the current game
+	_zip->listMatchingMembers(innerList, _innerfolder.appendComponent("*"), true);
+
+	// Modify the results to change the filename, then filter with pattern
+	for (const auto &innerMember : innerList) {
+		Common::ArchiveMemberPtr member = Common::ArchiveMemberPtr(
+			new UltimaDataArchiveMember(innerMember, _innerfolder));
+		if (matchAll || member->getPathInArchive().toString().matchString(pattern.toString(), true, matchPathComponents ? nullptr : "/")) {
+			list.push_back(member);
+			++numMatches;
+		}
+	}
+	return numMatches;
+}
+
+int UltimaDataArchive::listMembers(Common::ArchiveMemberList &list) const {
+	return listMatchingMembers(list, "*", true);
+}
+
+const Common::ArchiveMemberPtr UltimaDataArchive::getMember(const Common::Path &path) const {
+	if (!hasFile(path))
+		return Common::ArchiveMemberPtr();
+
+	return Common::ArchiveMemberPtr(new Common::GenericArchiveMember(path, *this));
+}
+
+Common::SeekableReadStream *UltimaDataArchive::createReadStreamForMember(const Common::Path &path) const {
+	if (hasFile(path)) {
+		Common::Path filename = innerToPublic(path);
+		return _zip->createReadStreamForMember(filename);
+	}
+
+	return nullptr;
+}
+
+bool UltimaDataArchive::isPathDirectory(const Common::Path &path) const {
+	return _zip->isPathDirectory(innerToPublic(path));
+}
+/*-------------------------------------------------------------------*/
+
+#ifndef RELEASE_BUILD
+
+const Common::ArchiveMemberPtr UltimaDataArchiveProxy::getMember(const Common::Path &path) const {
+	if (!hasFile(path))
+		return Common::ArchiveMemberPtr();
+
+	return Common::ArchiveMemberPtr(new Common::GenericArchiveMember(path, *this));
+}
+
+Common::SeekableReadStream *UltimaDataArchiveProxy::createReadStreamForMember(const Common::Path &path) const {
+	if (hasFile(path))
+		return getNode(path).createReadStream();
+
+	return nullptr;
+}
+
+Common::FSNode UltimaDataArchiveProxy::getNode(const Common::Path &name) const {
+	Common::Path remainingName = name.relativeTo(_publicFolder);
+	Common::FSNode node = _folder;
+
+	Common::StringArray components = remainingName.splitComponents();
+
+	if (components.empty()) {
+		return node;
+	}
+
+	for(Common::StringArray::const_iterator it = components.begin(); it != components.end() - 1; it++) {
+		node = node.getChild(*it);
+		if (!node.exists())
+			return node;
+	}
+
+	node = node.getChild(*(components.end() - 1));
+
+	return node;
+}
+
+int UltimaDataArchiveProxy::listMembers(Common::ArchiveMemberList &list) const {
+	return listMatchingMembers(list, "*", true);
+}
+
+int UltimaDataArchiveProxy::listMatchingMembers(Common::ArchiveMemberList &list,
+		const Common::Path &pattern, bool matchPathComponents) const {
+	// Let FSDirectory adjust the filenames for us by using its prefix feature.
+	// Note: dir is intentionally constructed again on each call to prevent stale entries due to caching:
+	// Since this proxy class is intended for use during development, picking up modifications while the
+	// game is running might be useful.
+	const int maxDepth = 255; // chosen arbitrarily
+	Common::FSDirectory dir(_publicFolder, _folder, maxDepth, false, false, true);
+	if (matchPathComponents && pattern == "*")
+		return dir.listMembers(list);
+	else
+		return dir.listMatchingMembers(list, pattern, matchPathComponents);
+}
+
+bool UltimaDataArchiveProxy::isPathDirectory(const Common::Path &path) const {
+	return getNode(path).isDirectory();
+}
+#endif
+
+} // End of namespace Shared
+} // End of namespace Ultima