New install

Bump deps/json from `3780b41` to `a259ecc`

.gitmodules

@@ -29,3 +29,6 @@
 [submodule "deps/SQLiteCpp"]
 	path = deps/SQLiteCpp
 	url = https://github.com/SRombauts/SQLiteCpp
+[submodule "deps/plutonium-sdk"]
+	path = deps/plutonium-sdk
+	url = https://github.com/plutoniummod/plutonium-sdk.git

README.md

@@ -9,6 +9,9 @@ Detours and reimplements the entire GSC VM + compiler.
 
 Adds custom GSC functions.
 
+# Installation
+Move the `t4sp-server-plugin.dll` to `%LOCALAPPDATA%\Plutonium\plugins\`, the plugin will be loaded when you start up a dedicated server for Plutonium T4SP.
+
 ## FileIO
 This plugin provides FileIO interface to GSC for reading and writing files, this is exact to [CoD4x's](https://github.com/callofduty4x/CoD4x_Server/blob/master/scriptdocumentation/script_functions_reference.md#file-operations) interface.
 
@@ -17,7 +20,7 @@ However, all reads and writes will take place strictly and only in the `scriptda
 All files will be closed upon GSC restart (map_restart or fast_restart or missionfailed, etc), only a maximum of 10 files may be opened at once.
 
 * `<bool> FS_TestFile(<filename string>)` Returns `true` if the file exists, `false` otherwise.
-* `<bool> FS_Remove(<filename string>)` Deletes the file, return `true` if successful, `false` otherwise.
+* `<bool> FS_Remove(<filename string>, <(optional) use_global bool>)` Deletes the file, return `true` if successful, `false` otherwise. `use_global` will use non mod specific folder.
   ```gsc
   // test to see if "scriptdata/test.txt" file exists
   if (FS_TestFile("test.txt")) // not a typo, all file io will take place inside the "scriptdata" folder
@@ -39,7 +42,7 @@ All files will be closed upon GSC restart (map_restart or fast_restart or missio
   FS_FCloseAll(); // close them all
   ```
 
-* `<int> FS_FOpen(<filename string>, <mode string>)` Tries to open the file, mode must be one of `read`, `write` (clears the file), `append` (appends to the file), returns the filehandle. Will return `0` if failed to open.
+* `<int> FS_FOpen(<filename string>, <mode string>, <(optional) use_global bool>)` Tries to open the file, mode must be one of `read`, `write` (clears the file), `append` (appends to the file), returns the filehandle. Will return `0` if failed to open. `use_global` will use non mod specific folder (only applies to `write` mode).
 * `FS_FClose(<filehandle int>)` Closes the file pointed by the filehandle given, which was returned from `FS_FOpen`.
   ```gsc
   // opens "scriptdata/test.txt", all io will take place inside the "scriptdata" folder
@@ -58,8 +61,8 @@ All files will be closed upon GSC restart (map_restart or fast_restart or missio
 
   ```
 
-* `<string> FS_ReadLine(<filehandle int>)` Reads a line from the file pointed by the filehandle, removes the newline char. Returns `undefined` when nothing is left to read. Will not read more than 8192 characters at once. Filehandle must be opened for reading.
+* `<string> FS_ReadLine(<filehandle int>)` Reads a line from the file pointed by the filehandle, removes the newline char. Returns `undefined` when nothing is left to read. Will not read more than 65536 characters at once. Filehandle must be opened for reading.
-* `<string> FS_Read(<filehandle int>, <bytes int>(optional))` Reads number of bytes from the file. If bytes is `undefined`, reads the entire file. No more than 8192 characters will be read at once. Returns `undefined` if there are nothing left to read.
+* `<string> FS_Read(<filehandle int>, <bytes int>(optional))` Reads number of bytes from the file. If bytes is `undefined`, reads the entire file. No more than 65536 characters will be read at once. Returns `undefined` if there are nothing left to read.
   ```gsc
   // open the file for reading
 
@@ -89,8 +92,23 @@ All files will be closed upon GSC restart (map_restart or fast_restart or missio
   // close the file
   ```
 
-# Installation
+* `<array of strings> FS_ListFiles(<folder string>)` Returns a list of files inside of the folder given.
-Move the `t4sp-server-plugin.dll` to `%LOCALAPPDATA%\Plutonium\storage\t4\plugins\`, the plugin will be loaded when you start up a dedicated server for Plutonium T4SP.
+  ```gsc
+  folder = "testfolder/";
+  files = FS_ListFiles(folder);
+
+  for (i = 0; i < files.size; i++)
+  {
+    filename = files[i];
+
+    // do something with the filename
+    filepath = folder + filename;
+  }
+  ```
+  
+* `<int> FS_Length(<filehandle int>)` Returns the length in bytes of the open'd file.
+* `<int> FS_GetSeek(<filehandle int>)` Returns the seek of the open'd file (only for reading).
+* `<int> FS_Seek(<filehandle int>, <seek int>)` Sets the seek of the open'd file (only for reading).
 
 # Credits
 - momo5502 (https://github.com/momo5502)

deps/premake/plutonium-sdk.lua

@@ -0,0 +1,18 @@
+plutonium_sdk = {
+    source = path.join(dependencies.basePath, "plutonium-sdk"),
+}
+
+function plutonium_sdk.import()
+    plutonium_sdk.includes()
+end
+
+function plutonium_sdk.includes()
+    includedirs {
+        plutonium_sdk.source,
+    }
+end
+
+function plutonium_sdk.project()
+end
+
+table.insert(dependencies, plutonium_sdk)

src/codsrc/clientscript/cscr_stringlist.cpp

@@ -67,11 +67,18 @@ namespace codsrc
 	{
 		int len;
 
-		for ( len = refString->u.s.byteLen - 1;
+		if (!refString->u.s.byteLen)
-			refString->str[len];
-			len += 256 )
 		{
-			;
+			len = 256 - 1; //Bugfix for 256 % 256 = 0 or 512 % 256 = 0 or... Just promote it to 256
+		}
+		else
+		{
+			len = refString->u.s.byteLen - 1;
+		}
+
+		while (refString->str[len])
+		{
+			len += 256;
 		}
 
 		return len;

src/component/fileio.cpp

@@ -10,6 +10,7 @@ namespace fileio
 	namespace
 	{
 		static constexpr size_t max_fhs = 10;
+		static constexpr size_t max_gsc_string = 0x10000 - 1;
 
 		enum class scr_fh_type_e
 		{
@@ -33,15 +34,16 @@ namespace fileio
 
 		bool validate_scr_path(const std::string& fpath)
 		{
-			if (fpath.empty())
+			auto toks = utils::string::split(fpath, '/');
-			{
-				return false;
-			}
 
-			constexpr static std::array bad_strings { R"(..)", R"(../)", R"(..\)" };
+			for (const auto& tok : toks)
-			for (auto i = 0u; i < bad_strings.size(); i++)
 			{
-				if (fpath.find(bad_strings[i]) != std::string::npos)
+				if (tok == "." || tok == "..")
+				{
+					return false;
+				}
+
+				if (tok.find(":") != std::string::npos)
 				{
 					return false;
 				}
@@ -50,17 +52,21 @@ namespace fileio
 			return true;
 		}
 
-		std::string build_base_path(const std::string& path)
+		std::string build_base_path(const std::string& path_)
 		{
+			auto path = path_;
+			std::replace(path.begin(), path.end(), '\\', '/');
+
 			if (!validate_scr_path(path))
 			{
-				game::Scr_Error(utils::string::va("Invalid path: %s", path.c_str()), game::SCRIPTINSTANCE_SERVER, false);
+				game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, utils::string::va("Invalid path: %s", path_.c_str()));
 			}
 
+			// its sandboxed, but what about symlinks?
 			return path.starts_with("scriptdata/") ? path : "scriptdata/" + path;
 		}
 
-		std::filesystem::path build_full_path(const std::string& path)
+		std::filesystem::path build_full_path(const std::string& path, bool use_global)
 		{
 			static game::dvar_s* fs_localAppData = nullptr;
 			static game::dvar_s* fs_gamedir = nullptr;
@@ -75,7 +81,7 @@ namespace fileio
 				fs_gamedir = game::Dvar_FindVar("fs_game");
 			}
 
-			return std::filesystem::path(fs_localAppData->current.string) / (*fs_gamedir->current.string ? fs_gamedir->current.string : "raw") / path;
+			return std::filesystem::path(fs_localAppData->current.string) / (!use_global && *fs_gamedir->current.string ? fs_gamedir->current.string : "raw") / path;
 		}
 
 		void free_scr_fh(scr_fh_t& scr_fh)
@@ -101,18 +107,25 @@ namespace fileio
 			}
 		}
 
-		void fwrite_to_file(bool append_newline)
+		int scr_get_fh()
 		{
 			auto fh = game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 0) - 1;
 
 			if (fh < 0 || fh >= max_fhs)
 			{
-				game::Scr_Error("fs_fwrite: invalid filehandle", game::SCRIPTINSTANCE_SERVER, false);
+				game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "fs_fwrite: invalid filehandle");
 			}
 
+			return fh;
+		}
+
+		void fwrite_to_file(bool append_newline)
+		{
+			auto fh = scr_get_fh();
+
 			if (scr_fhs[fh].type != scr_fh_type_e::WRITE && scr_fhs[fh].type != scr_fh_type_e::APPEND)
 			{
-				game::Scr_Error("File not opened for writing", game::SCRIPTINSTANCE_SERVER, false);
+				game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened for writing");
 			}
 
 			std::string to_write = game::Scr_GetString(1, game::SCRIPTINSTANCE_SERVER);
@@ -169,7 +182,7 @@ namespace fileio
 					{
 						if (scr_fd.type != scr_fh_type_e::UNUSED && scr_fd.base_path == fpath)
 						{
-							game::Scr_Error("File already opened", game::SCRIPTINSTANCE_SERVER, false);
+							game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File already opened");
 						}
 					}
 
@@ -185,7 +198,7 @@ namespace fileio
 
 					if (i >= max_fhs)
 					{
-						game::Scr_Error("Too many files opened", game::SCRIPTINSTANCE_SERVER, false);
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "Too many files opened");
 					}
 
 					// check mode
@@ -224,7 +237,7 @@ namespace fileio
 					}
 					else if (mode == "write"s || mode == "append"s)
 					{
-						auto full_path = build_full_path(fpath);
+						auto full_path = build_full_path(fpath, game::Scr_GetNumParam(game::SCRIPTINSTANCE_SERVER) >= 3 && game::Scr_GetType(game::SCRIPTINSTANCE_SERVER, 2) == game::VAR_INTEGER && game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 2));
 
 						if (!utils::io::write_file(full_path.string(), "", (mode == "append"s)))
 						{
@@ -239,7 +252,7 @@ namespace fileio
 					}
 					else
 					{
-						game::Scr_Error(utils::string::va("Invalid mode: %s", mode), game::SCRIPTINSTANCE_SERVER, false);
+						game::Scr_ParamError(1, game::SCRIPTINSTANCE_SERVER, utils::string::va("Invalid mode: %s", mode));
 					}
 
 #ifdef DEBUG
@@ -260,16 +273,11 @@ namespace fileio
 
 			gsc::function::add("fs_readline", []()
 				{
-					auto fh = game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 0) - 1;
+					auto fh = scr_get_fh();
-
-					if (fh < 0 || fh >= max_fhs)
-					{
-						game::Scr_Error("Invalid filehandle", game::SCRIPTINSTANCE_SERVER, false);
-					}
 
 					if (scr_fhs[fh].type != scr_fh_type_e::READ)
 					{
-						game::Scr_Error("File not opened for reading", game::SCRIPTINSTANCE_SERVER, false);
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened for reading");
 					}
 
 					// file is completed being read
@@ -293,10 +301,10 @@ namespace fileio
 						}
 					}
 
-					if (bytes_to_read > 8191)
+					if (bytes_to_read > max_gsc_string)
 					{
 						found_nl = false;
-						bytes_to_read = 8191;
+						bytes_to_read = max_gsc_string;
 
 						game::Com_PrintWarning(game::CON_CHANNEL_SCRIPT, "Line was too long in file %s, truncating\n", scr_fhs[fh].base_path.c_str());
 					}
@@ -318,16 +326,11 @@ namespace fileio
 
 			gsc::function::add("fs_read", []()
 				{
-					auto fh = game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 0) - 1;
+					auto fh = scr_get_fh();
-
-					if (fh < 0 || fh >= max_fhs)
-					{
-						game::Scr_Error("Invalid filehandle", game::SCRIPTINSTANCE_SERVER, false);
-					}
 
 					if (scr_fhs[fh].type != scr_fh_type_e::READ)
 					{
-						game::Scr_Error("File not opened for reading", game::SCRIPTINSTANCE_SERVER, false);
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened for reading");
 					}
 
 					// file is completed being read
@@ -344,13 +347,13 @@ namespace fileio
 
 						if (bytes_to_read <= 0)
 						{
-							game::Scr_Error("Trying to read <1 bytes", game::SCRIPTINSTANCE_SERVER, false);
+							game::Scr_ParamError(1, game::SCRIPTINSTANCE_SERVER, "Trying to read <1 bytes");
 						}
 					}
 
-					if (bytes_to_read > 8191)
+					if (bytes_to_read > max_gsc_string)
 					{
-						bytes_to_read = 8191;
+						bytes_to_read = max_gsc_string;
 
 						game::Com_PrintWarning(game::CON_CHANNEL_SCRIPT, "Line was too long in file %s, truncating\n", scr_fhs[fh].base_path.c_str());
 					}
@@ -369,16 +372,11 @@ namespace fileio
 
 			gsc::function::add("fs_fclose", []()
 				{
-					auto fh = game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 0) - 1;
+					auto fh = scr_get_fh();
-
-					if (fh < 0 || fh >= max_fhs)
-					{
-						game::Scr_Error("Invalid filehandle", game::SCRIPTINSTANCE_SERVER, false);
-					}
 
 					if (scr_fhs[fh].type == scr_fh_type_e::UNUSED)
 					{
-						game::Scr_Error("File not opened", game::SCRIPTINSTANCE_SERVER, false);
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened");
 					}
 
 					free_scr_fh(scr_fhs[fh]);
@@ -386,10 +384,48 @@ namespace fileio
 					game::Scr_AddInt(game::SCRIPTINSTANCE_SERVER, 1);
 				});
 
+			gsc::function::add("fs_length", []()
+				{
+					auto fh = scr_get_fh();
+
+					if (scr_fhs[fh].type == scr_fh_type_e::UNUSED)
+					{
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened");
+					}
+
+					game::Scr_AddInt(game::SCRIPTINSTANCE_SERVER, scr_fhs[fh].file_length);
+				});
+
+			gsc::function::add("fs_getseek", []()
+				{
+					auto fh = scr_get_fh();
+
+					// write seek would require completely redoing how we write files...
+					if (scr_fhs[fh].type != scr_fh_type_e::READ)
+					{
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened for reading");
+					}
+
+					game::Scr_AddInt(game::SCRIPTINSTANCE_SERVER, scr_fhs[fh].seek);
+				});
+
+			gsc::function::add("fs_seek", []()
+				{
+					auto fh = scr_get_fh();
+
+					if (scr_fhs[fh].type != scr_fh_type_e::READ)
+					{
+						game::Scr_ParamError(0, game::SCRIPTINSTANCE_SERVER, "File not opened for reading");
+					}
+
+					scr_fhs[fh].seek = std::clamp(game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 1), 0, scr_fhs[fh].file_length);
+					game::Scr_AddInt(game::SCRIPTINSTANCE_SERVER, 1);
+				});
+
 			gsc::function::add("fs_remove", []()
 				{
 					auto fpath = build_base_path(game::Scr_GetString(0, game::SCRIPTINSTANCE_SERVER));
-					auto full_path = build_full_path(fpath);
+					auto full_path = build_full_path(fpath, game::Scr_GetNumParam(game::SCRIPTINSTANCE_SERVER) >= 2 && game::Scr_GetType(game::SCRIPTINSTANCE_SERVER, 1) == game::VAR_INTEGER && game::Scr_GetInt(game::SCRIPTINSTANCE_SERVER, 1));
 
 					if (!utils::io::remove_file(full_path.string()))
 					{
@@ -400,6 +436,23 @@ namespace fileio
 
 					game::Scr_AddInt(game::SCRIPTINSTANCE_SERVER, 1);
 				});
+
+			gsc::function::add("fs_listfiles", []()
+				{
+					auto fpath = build_base_path(game::Scr_GetString(0, game::SCRIPTINSTANCE_SERVER));
+
+					int numfiles;
+					auto* files = game::FS_ListFiles(fpath.c_str(), "", game::FS_LIST_ALL, &numfiles);
+
+					game::Scr_MakeArray(game::SCRIPTINSTANCE_SERVER);
+					for (int i = 0; i < numfiles; i++)
+					{
+						game::Scr_AddString(game::SCRIPTINSTANCE_SERVER, files[i]);
+						game::Scr_AddArray(game::SCRIPTINSTANCE_SERVER);
+					}
+
+					game::FS_FreeFileList(files);
+				});
 		}
 	}
 

src/dllmain.cpp

@@ -1,40 +1,11 @@
 #include <stdinc.hpp>
-#include "loader/component_loader.hpp"
-#include "component/signatures.hpp"
 
-#include <utils/hook.hpp>
+PLUTONIUM_API plutonium::sdk::plugin* PLUTONIUM_CALLBACK on_initialize()
+{
+	return plugin::get();
+}
 
 BOOL APIENTRY DllMain(HMODULE /*module_*/, DWORD ul_reason_for_call, LPVOID /*reserved_*/)
 {
-	if (ul_reason_for_call == DLL_PROCESS_ATTACH)
-	{
-		if (game::environment::t4sp())
-		{
-			if (!signatures::process())
-			{
-				MessageBoxA(NULL,
-					std::format("This version of t4sp-server-plugin is outdated.\n" \
-						"Download the latest dll from here: https://github.com/JezuzLizard/T4SP-Server-Plugin/releases\n" \
-						"'{}' failed", signatures::get_err_reason()).c_str(),
-					"ERROR", MB_ICONERROR);
-
-				return FALSE;
-			}
-
-			if (game::plutonium::printf.get() != nullptr)
-			{
-				utils::hook::jump(reinterpret_cast<uintptr_t>(&printf), game::plutonium::printf);
-			}
-
-			component_loader::post_unpack();
-		}
-		else
-		{
-			MessageBoxA(nullptr, "Unsupported game executable. (t4sp is only supported)", "ERROR, BRO!", 0);
-
-			return FALSE;
-		}
-	}
-
 	return TRUE;
 }

src/game/game.cpp

@@ -231,6 +231,21 @@ namespace game
 		*cmd_functions = newCmd;
 	}
 
+	// restored
+	const char** FS_ListFiles(const char* path, const char* extension, FsListBehavior_e behavior, int* numfiles)
+	{
+		return FS_ListFilteredFiles(*fs_searchpaths, path, extension, nullptr, behavior, numfiles);
+	}
+
+	// restored
+	void FS_FreeFileList(const char** list)
+	{
+		if ( list )
+		{
+			Hunk_UserDestroy((HunkUser*)*(list - 1));
+		}
+	}
+
 	// restored
 	void Sys_EnterCriticalSection(CriticalSection critSect)
 	{

src/game/symbols.hpp

@@ -78,6 +78,9 @@ namespace game
 	void Sys_EnterCriticalSection(CriticalSection critSect);
 	void Sys_LeaveCriticalSection(CriticalSection critSect);
 
+	const char** FS_ListFiles(const char* path, const char* extension, FsListBehavior_e behavior, int* numfiles);
+	void FS_FreeFileList(const char** list);
+
 	// Variables
 	WEAK symbol<CRITICAL_SECTION> s_criticalSection{ 0x0, 0x2298D08 };
 	WEAK symbol<HunkUser*> g_DebugHunkUser{ 0x0, 0x212B2EC };

src/plugin.cpp

@@ -0,0 +1,73 @@
+#include <stdinc.hpp>
+#include "component/signatures.hpp"
+
+#include <utils/hook.hpp>
+#include "loader/component_loader.hpp"
+
+namespace plugin
+{
+	std::uint32_t plugin::plugin_version()
+	{
+		return 1;
+	}
+
+	const char* plugin::plugin_name()
+	{
+		return "t4sp-server-plugin";
+	}
+
+	bool plugin::is_game_supported(plutonium::sdk::game game)
+	{
+		return game == plutonium::sdk::game::t4;
+	}
+
+	void plugin::on_startup(plutonium::sdk::iinterface* interface_ptr, plutonium::sdk::game game)
+	{
+		this->interface_ = interface_ptr;
+		this->game_ = game;
+
+		if (!game::environment::t4sp())
+		{
+			MessageBoxA(nullptr, "Unsupported game executable. (t4sp is only supported)", "ERROR, BRO!", 0);
+			return;
+		}
+
+		if (!signatures::process())
+		{
+			MessageBoxA(NULL,
+				std::format("This version of t4sp-server-plugin is outdated.\n" \
+					"Download the latest dll from here: https://github.com/JezuzLizard/T4SP-Server-Plugin/releases\n" \
+					"'{}' failed", signatures::get_err_reason()).c_str(),
+				"ERROR", MB_ICONERROR);
+
+			return;
+		}
+
+		if (game::plutonium::printf.get() != nullptr)
+		{
+			utils::hook::jump(reinterpret_cast<uintptr_t>(&printf), game::plutonium::printf);
+		}
+
+		component_loader::post_unpack();
+	}
+
+	void plugin::on_shutdown()
+	{
+	}
+
+	plutonium::sdk::iinterface* plugin::get_interface()
+	{
+		return this->interface_;
+	}
+
+	plutonium::sdk::game plugin::get_game()
+	{
+		return this->game_;
+	}
+
+	plugin* get()
+	{
+		static plugin instance;
+		return &instance;
+	}
+}

src/plugin.hpp

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <plutonium_sdk.hpp>
+
+namespace plugin
+{
+	class plugin : public plutonium::sdk::plugin
+	{
+	public:
+		~plugin() = default;
+
+		std::uint32_t plugin_version() override;
+		const char* plugin_name() override;
+
+		bool is_game_supported(plutonium::sdk::game game) override;
+
+		void on_startup(plutonium::sdk::iinterface* interface_ptr, plutonium::sdk::game game) override;
+		void on_shutdown() override;
+
+		plutonium::sdk::iinterface* get_interface();
+		plutonium::sdk::game get_game();
+
+	private:
+		plutonium::sdk::iinterface* interface_{};
+		plutonium::sdk::game game_{};
+
+	};
+
+	plugin* get();
+}

src/stdinc.hpp

@@ -71,6 +71,8 @@
 #include "game/structs.hpp"
 #include "game/symbols.hpp"
 
+#include "plugin.hpp"
+
 std::string build_gsc_dump(game::scriptInstance_t inst);
 void push_opcode_history(game::scriptInstance_t inst, game::OpcodeVM op);
 void push_builtin_history(game::scriptInstance_t inst, int idx);