Initial commit

engines/ags/shared/util/file.cpp

@@ -0,0 +1,222 @@
+/* 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 "ags/shared/core/platform.h"
+#include "ags/shared/util/buffered_stream.h"
+#include "ags/shared/util/directory.h"
+#include "ags/shared/util/file.h"
+#include "ags/shared/util/file_stream.h"
+#include "ags/shared/util/path.h"
+#include "ags/shared/util/stdio_compat.h"
+#include "common/file.h"
+#include "common/savefile.h"
+#include "common/system.h"
+
+namespace AGS3 {
+namespace AGS {
+namespace Shared {
+
+bool File::IsDirectory(const String &filename) {
+	// stat() does not like trailing slashes, remove them
+	String fixed_path = Path::MakePathNoSlash(filename);
+	return ags_directory_exists(fixed_path.GetCStr()) != 0;
+}
+
+bool File::IsFile(const String &filename) {
+	return ags_file_exists(filename.GetCStr()) != 0;
+}
+
+bool File::IsFileOrDir(const String &filename) {
+	// stat() does not like trailing slashes, remove them
+	String fixed_path = Path::MakePathNoSlash(filename);
+	return ags_path_exists(fixed_path.GetCStr()) != 0;
+}
+
+soff_t File::GetFileSize(const String &filename) {
+	if (filename.IsEmpty())
+		return 0;
+	return ags_file_size(filename.GetCStr());
+}
+
+bool File::TestReadFile(const String &filename) {
+	if (filename.IsEmpty())
+		return false;
+	return ags_file_exists(filename.GetCStr());
+}
+
+bool File::TestWriteFile(const String &filename) {
+	if (filename.IsEmpty())
+		return false;
+	return TestCreateFile(filename);
+}
+
+bool File::TestCreateFile(const String &filename) {
+	if (filename.IsEmpty())
+		return false;
+
+	Common::OutSaveFile *sf = g_system->getSavefileManager()->openForSaving(filename);
+	bool result = sf != nullptr;
+	delete sf;
+
+	return result;
+}
+
+bool File::DeleteFile(const String &filename) {
+	// Only allow deleting files in the savegame folder
+	if (filename.CompareLeftNoCase(SAVE_FOLDER_PREFIX) != 0) {
+		warning("Cannot delete file %s. Only files in the savegame directory can be deleted", filename.GetCStr());
+		return false;
+	}
+	Common::String file(filename.GetCStr() + strlen(SAVE_FOLDER_PREFIX));
+	return g_system->getSavefileManager()->removeSavefile(file);
+}
+
+bool File::RenameFile(const String &old_name, const String &new_name) {
+	// Only allow renaming files in the savegame folder
+	if (old_name.CompareLeftNoCase(SAVE_FOLDER_PREFIX) || new_name.CompareLeftNoCase(SAVE_FOLDER_PREFIX)) {
+		warning("Cannot rename file %s to %s. Only files in the savegame directory can be renamed", old_name.GetCStr(), new_name.GetCStr());
+		return false;
+	}
+	Common::String file_old(old_name.GetCStr() + strlen(SAVE_FOLDER_PREFIX));
+	Common::String file_new(new_name.GetCStr() + strlen(SAVE_FOLDER_PREFIX));
+	return g_system->getSavefileManager()->renameSavefile(file_old, file_new);
+}
+
+bool File::CopyFile(const String &src_path, const String &dst_path, bool overwrite) {
+	// Only allow copying files to the savegame folder
+	// In theory it should be possible to copy any file to to save folder, but
+	// let's restrict only to files that are already in the save folder for now
+	if (src_path.CompareLeftNoCase(SAVE_FOLDER_PREFIX) || dst_path.CompareLeftNoCase(SAVE_FOLDER_PREFIX)) {
+		warning("Cannot copy file %s to %s. Source and destination files must be in the savegame directory", src_path.GetCStr(), dst_path.GetCStr());
+		return false;
+	}
+	if (ags_file_exists(dst_path.GetCStr()) && !overwrite) {
+		warning("Cannot copy file %s to %s. File exists", src_path.GetCStr(), dst_path.GetCStr());
+		return false;
+	}
+	Common::String file_src(src_path.GetCStr() + strlen(SAVE_FOLDER_PREFIX));
+	Common::String file_dest(dst_path.GetCStr() + strlen(SAVE_FOLDER_PREFIX));
+	return g_system->getSavefileManager()->copySavefile(file_src, file_dest);
+}
+
+bool File::GetFileModesFromCMode(const String &cmode, FileOpenMode &open_mode, FileWorkMode &work_mode) {
+	// We do not test for 'b' and 't' here, because text mode reading/writing should be done with
+	// the use of ITextReader and ITextWriter implementations.
+	// The number of supported variants here is quite limited due the restrictions AGS makes on them.
+	bool read_base_mode = false;
+	// Default mode is open/read for safety reasons
+	open_mode = kFile_Open;
+	work_mode = kFile_Read;
+	for (size_t c = 0; c < cmode.GetLength(); ++c) {
+		if (read_base_mode) {
+			if (cmode[c] == '+') {
+				work_mode = kFile_ReadWrite;
+			}
+			break;
+		} else {
+			if (cmode[c] == 'r') {
+				open_mode = kFile_Open;
+				work_mode = kFile_Read;
+				read_base_mode = true;
+			} else if (cmode[c] == 'a') {
+				open_mode = kFile_Create;
+				work_mode = kFile_Write;
+				read_base_mode = true;
+			} else if (cmode[c] == 'w') {
+				open_mode = kFile_CreateAlways;
+				work_mode = kFile_Write;
+				read_base_mode = true;
+			}
+		}
+	}
+	return read_base_mode;
+}
+
+String File::GetCMode(FileOpenMode open_mode, FileWorkMode work_mode) {
+	String mode;
+	if (open_mode == kFile_Open) {
+		if (work_mode == kFile_Read)
+			mode.AppendChar('r');
+		else if (work_mode == kFile_Write || work_mode == kFile_ReadWrite)
+			mode.Append("r+");
+	} else if (open_mode == kFile_Create) {
+		if (work_mode == kFile_Write)
+			mode.AppendChar('a');
+		else if (work_mode == kFile_Read || work_mode == kFile_ReadWrite)
+			mode.Append("a+");
+	} else if (open_mode == kFile_CreateAlways) {
+		if (work_mode == kFile_Write)
+			mode.AppendChar('w');
+		else if (work_mode == kFile_Read || work_mode == kFile_ReadWrite)
+			mode.Append("w+");
+	}
+	mode.AppendChar('b');
+	return mode;
+}
+
+Stream *File::OpenFile(const String &filename, FileOpenMode open_mode, FileWorkMode work_mode) {
+	Stream *fs = nullptr;
+	//  try {
+	fs = new BufferedStream(filename, open_mode, work_mode);
+	if (fs != nullptr && !fs->IsValid()) {
+		delete fs;
+		fs = nullptr;
+	}
+	//  } catch (std::runtime_error) {
+	//      fs = nullptr;
+	//  }
+
+	return fs;
+}
+
+Stream *File::OpenStdin() {
+	error("TODO: File::OpenStdin");
+}
+
+Stream *File::OpenStdout() {
+	error("TODO: File::OpenStdout");
+}
+
+Stream *File::OpenStderr() {
+	error("TODO: File::OpenStderr");
+}
+
+String File::FindFileCI(const String &dir_name, const String &file_name) {
+	return Path::ConcatPaths(dir_name, file_name);
+}
+
+Stream *File::OpenFileCI(const String &file_name, FileOpenMode open_mode, FileWorkMode work_mode) {
+	return File::OpenFile(file_name, open_mode, work_mode);
+}
+
+Stream *File::OpenFile(const String &filename, soff_t start_off, soff_t end_off) {
+	Stream *fs = new BufferedSectionStream(filename, start_off, end_off, kFile_Open, kFile_Read);
+	if (fs != nullptr && !fs->IsValid()) {
+		delete fs;
+		return nullptr;
+	}
+
+	return fs;
+}
+
+} // namespace Shared
+} // namespace AGS
+} // namespace AGS3