Ticket #4027: 4027_mod_installation.patch

source/main.cpp

@@ -49 +49 @@
 #include "ps/Globals.h"
 #include "ps/Hotkey.h"
 #include "ps/Loader.h"
+#include "ps/ModInstaller.h"
 #include "ps/Profile.h"
 #include "ps/Profiler2.h"
 #include "ps/Pyrogenesis.h"
@@ -443 +444 @@
             return;
         }
     }
+    
+    const bool isModInstallation = args.Has("install-mod");
+    const OsPath modPath(isModInstallation ? args.Get("install-mod") : "");
 
+    if (isModInstallation)
+    {
+        if (!FileExists(modPath))
+        {
+            debug_printf("ERROR: The mod file '%s' does not exist!\n", modPath.string8().c_str());
+            return;
+        }
+        if (DirectoryExists(modPath))
+        {
+            debug_printf("ERROR: The mod file '%s' is a directory!\n", modPath.string8().c_str());
+            return;
+        }
+        if (modPath.Basename().empty())
+        {
+            debug_printf("ERROR: The name of the mod file '%s' is empty!\n", modPath.string8().c_str());
+            return;
+        }
+    }
+
     // We need to initialize SpiderMonkey and libxml2 in the main thread before
     // any thread uses them. So initialize them here before we might run Atlas.
     ScriptEngine scriptEngine;
@@ -483 +506 @@
         CXeromyces::Terminate();
         return;
     }
+    
+    if (isModInstallation)
+    {
+        Paths paths(args);
+        
+        CModInstaller installer(paths.UserData() / "mods", paths.Cache());
 
+        // Creates a directory with the name extracted from a `mod.json`
+        installer.Install(modPath);
+
+        CXeromyces::Terminate();
+        return;
+    }
+
     // run in archive-building mode if requested
     if (args.Has("archivebuild"))
     {

source/ps/ModInstaller.cpp

@@ +1 @@
+/* Copyright (C) 2016 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. 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.
+ *
+ * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "precompiled.h"
+
+#include "ModInstaller.h"
+
+#include "lib/file/vfs/vfs_util.h"
+#include "ps/Filesystem.h"
+#include "ps/XML/Xeromyces.h"
+
+#include <boost/filesystem/operations.hpp>
+#include <fstream>
+
+CModInstaller::CModInstaller(const OsPath& modsdir, const OsPath& tempdir) :
+    m_ModsDir(modsdir), m_TempDir(tempdir / "_modscache"), m_CacheDir("cache/")
+{
+    m_VFS = CreateVfs(16 * MiB);
+
+    CreateDirectories(m_TempDir, 0700);
+
+    const int runtimeSize = 8 * MiB;
+    const int heapGrowthBytesGCTrigger = 1 * MiB;
+    m_ScriptRuntime = ScriptInterface::CreateRuntime(std::shared_ptr<ScriptRuntime>(), runtimeSize, heapGrowthBytesGCTrigger);
+}
+
+CModInstaller::~CModInstaller()
+{
+    m_VFS.reset();
+
+    m_ScriptRuntime.reset();
+
+    DeleteDirectory(m_TempDir);
+}
+
+void CModInstaller::Install(const OsPath& mod)
+{
+#define BOOST_WARN_IF_FAIL(expression) try { (expression); } catch (boost::filesystem::filesystem_error& ex) { debug_printf("%s", ex.what()); }
+
+    const OsPath modTemp = m_TempDir / mod.Basename() / mod.Filename().ChangeExtension(L".zip");
+    CreateDirectories(modTemp.Parent(), 0700);
+
+    BOOST_WARN_IF_FAIL(boost::filesystem::copy_file(mod.string8(), modTemp.string8(), boost::filesystem::copy_option::overwrite_if_exists));
+    
+    // Load the mod to VFS
+    if (m_VFS->Mount(m_CacheDir, m_TempDir / "") != INFO::OK)
+        return;
+    CVFSFile modinfo;
+    PSRETURN modinfo_status = modinfo.Load(m_VFS, m_CacheDir / modTemp.Basename() / "mod.json", false);
+    m_VFS->Clear();
+    if (modinfo_status != PSRETURN_OK)
+        return;
+
+    // Extract the name of the mod
+    ScriptInterface scriptInterface("Engine", "ModInstaller", m_ScriptRuntime);
+    JSContext* cx = scriptInterface.GetContext();
+    JS::RootedValue json_val(cx);
+    if (!scriptInterface.ParseJSON(modinfo.GetAsString(), &json_val))
+        return;
+    JS::RootedObject json_obj(cx, json_val.toObjectOrNull());
+    JS::RootedValue name_val(cx);
+    if (!JS_GetProperty(cx, json_obj, "name", &name_val))
+        return;
+    std::string modName;
+    ScriptInterface::FromJSVal(cx, name_val, modName);
+    if (modName.empty())
+        return;
+
+    const OsPath modDir = m_ModsDir / modName;
+    const OsPath modPath = modDir / (modName + ".zip");
+    
+    // Create a directory with the next structure:
+    //   mod-name/
+    //   +mod-name.zip
+    CreateDirectories(modDir, 0700);
+    BOOST_WARN_IF_FAIL(boost::filesystem::rename(modTemp.string8(), modPath.string8()));
+    DeleteDirectory(modTemp.Parent());
+
+#ifdef OS_WIN
+    std::ofstream mod_json((modDir / "mod.json").string8());
+    if (mod_json.good())
+    {
+        mod_json << modinfo.GetAsString();
+        mod_json.close();
+    }
+#endif
+    
+    // Remove the original file
+    BOOST_WARN_IF_FAIL(boost::filesystem::remove(mod.string8()));
+#undef BOOST_WARN_IF_FAIL
+}

source/ps/ModInstaller.h

@@ +1 @@
+/* Copyright (C) 2016 Wildfire Games.
+ * This file is part of 0 A.D.
+ *
+ * 0 A.D. 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.
+ *
+ * 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef INCLUDED_MODINSTALLER
+#define INCLUDED_MODINSTALLER
+
+#include "lib/file/vfs/vfs.h"
+#include "scriptinterface/ScriptInterface.h"
+
+/**
+ * Install a mod into the mods directory.
+ */
+class CModInstaller
+{
+public:
+    /**
+     * Initialise the mod installer for processing the given mod.
+     *
+     * @param modsdir path to the data directory, containing mods
+     * @param tempdir path to a writable directory for temporary files
+     */
+    CModInstaller(const OsPath& modsdir, const OsPath& tempdir);
+
+    ~CModInstaller();
+
+    /**
+     * Do all the processing and unpacking.
+     * @param mod path of .pyromod file of mod
+     */
+    void Install(const OsPath& mod);
+
+private:
+
+    PIVFS m_VFS;
+    OsPath m_ModsDir;
+    OsPath m_TempDir;
+    VfsPath m_CacheDir;
+
+    std::shared_ptr<ScriptRuntime> m_ScriptRuntime;
+};
+
+#endif // INCLUDED_MODINSTALLER