Initial commit

backends/fs/chroot/chroot-fs-factory.cpp

@@ -0,0 +1,87 @@
+/* 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/>.
+ *
+ */
+
+#if defined(POSIX)
+
+#define FORBIDDEN_SYMBOL_EXCEPTION_time_h
+#define FORBIDDEN_SYMBOL_EXCEPTION_unistd_h
+#define FORBIDDEN_SYMBOL_EXCEPTION_mkdir
+#define FORBIDDEN_SYMBOL_EXCEPTION_exit		//Needed for IRIX's unistd.h
+#define FORBIDDEN_SYMBOL_EXCEPTION_random
+#define FORBIDDEN_SYMBOL_EXCEPTION_srandom
+
+#include <unistd.h>
+
+#include "backends/fs/chroot/chroot-fs-factory.h"
+#include "backends/fs/chroot/chroot-fs.h"
+
+ChRootFilesystemFactory::ChRootFilesystemFactory(const Common::String &root)
+	: _root(root) {
+}
+
+AbstractFSNode *ChRootFilesystemFactory::makeRootFileNode() const {
+	return new ChRootFilesystemNode(_root, "/");
+}
+
+AbstractFSNode *ChRootFilesystemFactory::makeCurrentDirectoryFileNode() const {
+	char buf[MAXPATHLEN];
+	if (getcwd(buf, MAXPATHLEN) == NULL) {
+		return NULL;
+	}
+
+	Common::String curPath(buf);
+	if (curPath.hasPrefix(_root + Common::String("/"))) {
+		return new ChRootFilesystemNode(_root, buf + _root.size());
+	}
+	for (auto it = _virtualDrives.begin() ; it != _virtualDrives.end() ; ++it) {
+		if (curPath.hasPrefix(it->_value + Common::String("/")))
+			return new ChRootFilesystemNode(it->_value, buf + it->_value.size(), it->_key);
+	}
+
+	return new ChRootFilesystemNode(_root, "/");
+}
+
+AbstractFSNode *ChRootFilesystemFactory::makeFileNodePath(const Common::String &path) const {
+	assert(!path.empty());
+	size_t driveEnd = path.findFirstOf('/');
+	if (driveEnd != Common::String::npos && driveEnd > 0) {
+		auto it = _virtualDrives.find(path.substr(0, driveEnd));
+		if (it != _virtualDrives.end())
+			return new ChRootFilesystemNode(it->_value, path.substr(driveEnd), it->_key);
+	}
+	return new ChRootFilesystemNode(_root, path);
+}
+
+void ChRootFilesystemFactory::addVirtualDrive(const Common::String &name, const Common::String &path) {
+	_virtualDrives[name] = path;
+}
+
+Common::String ChRootFilesystemFactory::getSystemFullPath(const Common::String& path) const {
+	size_t driveEnd = path.findFirstOf('/');
+	if (driveEnd != Common::String::npos && driveEnd > 0) {
+		auto it = _virtualDrives.find(path.substr(0, driveEnd));
+		if (it != _virtualDrives.end())
+			return it->_value + path.substr(driveEnd);
+	}
+	return _root + path;
+}
+
+#endif

backends/fs/chroot/chroot-fs-factory.h

@@ -0,0 +1,50 @@
+/* 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/>.
+ *
+ */
+
+
+#ifndef BACKENDS_FS_CHROOT_CHROOT_FS_FACTORY_H
+#define BACKENDS_FS_CHROOT_CHROOT_FS_FACTORY_H
+
+#include "backends/fs/fs-factory.h"
+
+/**
+ * FIXME: Warning, using this factory in your backend may silently break some
+ * features. Instances are, for example, the FluidSynth code, and the POSIX
+ * plugin code.
+ */
+class ChRootFilesystemFactory final : public FilesystemFactory {
+public:
+	explicit ChRootFilesystemFactory(const Common::String &root);
+
+	AbstractFSNode *makeRootFileNode() const override;
+	AbstractFSNode *makeCurrentDirectoryFileNode() const override;
+	AbstractFSNode *makeFileNodePath(const Common::String &path) const override;
+	
+	void addVirtualDrive(const Common::String &name, const Common::String &path);
+
+	Common::String getSystemFullPath(const Common::String& path) const override;
+
+private:
+	const Common::String _root;
+	Common::StringMap _virtualDrives;
+};
+
+#endif /* BACKENDS_FS_CHROOT_CHROOT_FS_FACTORY_H */

backends/fs/chroot/chroot-fs.cpp

@@ -0,0 +1,124 @@
+/* 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/>.
+ *
+ */
+
+#if defined(POSIX)
+
+#include "backends/fs/chroot/chroot-fs.h"
+
+ChRootFilesystemNode::ChRootFilesystemNode(const Common::String &root, POSIXFilesystemNode *node, const Common::String &drive) {
+	_root = Common::normalizePath(root, '/');
+	_drive = drive;
+	_realNode = node;
+}
+
+ChRootFilesystemNode::ChRootFilesystemNode(const Common::String &root, const Common::String &path, const Common::String &drive) {
+	_root = Common::normalizePath(root, '/');
+	_drive = drive;
+	_realNode = new POSIXFilesystemNode(addPathComponent(root, path));
+}
+
+ChRootFilesystemNode::~ChRootFilesystemNode() {
+	delete _realNode;
+}
+
+bool ChRootFilesystemNode::exists() const {
+	return _realNode->exists();
+}
+
+Common::U32String ChRootFilesystemNode::getDisplayName() const {
+	return _realNode->getDisplayName();
+}
+
+Common::String ChRootFilesystemNode::getName() const {
+	return _realNode->getName();
+}
+
+Common::String ChRootFilesystemNode::getPath() const {
+	Common::String path = _realNode->getPath();
+	if (path.size() > _root.size())
+		return _drive + Common::String(path.c_str() + _root.size());
+	return _drive + "/";
+}
+
+bool ChRootFilesystemNode::isDirectory() const {
+	return _realNode->isDirectory();
+}
+
+bool ChRootFilesystemNode::isReadable() const {
+	return _realNode->isReadable();
+}
+
+bool ChRootFilesystemNode::isWritable() const {
+	// Assume virtual drives are not writable
+	if (!_drive.empty())
+		return false;
+	return _realNode->isWritable();
+}
+
+AbstractFSNode *ChRootFilesystemNode::getChild(const Common::String &n) const {
+	return new ChRootFilesystemNode(_root, (POSIXFilesystemNode *)_realNode->getChild(n), _drive);
+}
+
+bool ChRootFilesystemNode::getChildren(AbstractFSList &list, ListMode mode, bool hidden) const {
+	AbstractFSList tmp;
+	if (!_realNode->getChildren(tmp, mode, hidden)) {
+		return false;
+	}
+
+	for (AbstractFSList::iterator i=tmp.begin(); i!=tmp.end(); ++i) {
+		list.push_back(new ChRootFilesystemNode(_root, (POSIXFilesystemNode *) *i, _drive));
+	}
+
+	return true;
+}
+
+AbstractFSNode *ChRootFilesystemNode::getParent() const {
+	if (getPath() == _drive + "/")
+		return nullptr;
+	return new ChRootFilesystemNode(_root, (POSIXFilesystemNode *)_realNode->getParent(), _drive);
+}
+
+Common::SeekableReadStream *ChRootFilesystemNode::createReadStream() {
+	return _realNode->createReadStream();
+}
+
+Common::SeekableWriteStream *ChRootFilesystemNode::createWriteStream(bool atomic) {
+	return _realNode->createWriteStream(atomic);
+}
+
+bool ChRootFilesystemNode::createDirectory() {
+	return _realNode->createDirectory();
+}
+
+Common::String ChRootFilesystemNode::addPathComponent(const Common::String &path, const Common::String &component) {
+	const char sep = '/';
+	if (path.lastChar() == sep && component.firstChar() == sep) {
+		return Common::String::format("%s%s", path.c_str(), component.c_str() + 1);
+	}
+
+	if (path.lastChar() == sep || component.firstChar() == sep) {
+		return Common::String::format("%s%s", path.c_str(), component.c_str());
+	}
+
+	return Common::String::format("%s%c%s", path.c_str(), sep, component.c_str());
+}
+
+#endif

backends/fs/chroot/chroot-fs.h

@@ -0,0 +1,58 @@
+/* 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/>.
+ *
+ */
+
+#ifndef BACKENDS_FS_CHROOT_CHROOT_FS_H
+#define BACKENDS_FS_CHROOT_CHROOT_FS_H
+
+#include "backends/fs/posix/posix-fs.h"
+
+class ChRootFilesystemNode final : public AbstractFSNode {
+	Common::String _root;
+	Common::String _drive;
+	POSIXFilesystemNode *_realNode;
+
+	ChRootFilesystemNode(const Common::String &root, POSIXFilesystemNode *, const Common::String &drive);
+
+public:
+	ChRootFilesystemNode(const Common::String &root, const Common::String &path, const Common::String &drive = Common::String());
+	~ChRootFilesystemNode() override;
+
+	bool exists() const override;
+	Common::U32String getDisplayName() const override;
+	Common::String getName() const override;
+	Common::String getPath() const override;
+	bool isDirectory() const override;
+	bool isReadable() const override;
+	bool isWritable() const override;
+
+	AbstractFSNode *getChild(const Common::String &n) const override;
+	bool getChildren(AbstractFSList &list, ListMode mode, bool hidden) const override;
+	AbstractFSNode *getParent() const override;
+
+	Common::SeekableReadStream *createReadStream() override;
+	Common::SeekableWriteStream *createWriteStream(bool atomic) override;
+	bool createDirectory() override;
+
+private:
+	static Common::String addPathComponent(const Common::String &path, const Common::String &component);
+};
+
+#endif /* BACKENDS_FS_CHROOT_CHROOT_FS_H */