2021-05-13 11:43:33 +02:00
|
|
|
/* Copyright (C) 2021 Wildfire Games.
|
2018-04-15 03:46:28 +02:00
|
|
|
* 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"
|
2021-08-22 15:20:41 +02:00
|
|
|
#include "lib/file/file_system.h"
|
|
|
|
#include "ps/CLogger.h"
|
2018-04-15 03:46:28 +02:00
|
|
|
#include "ps/Filesystem.h"
|
|
|
|
#include "ps/XML/Xeromyces.h"
|
2021-05-14 12:18:03 +02:00
|
|
|
#include "scriptinterface/ScriptInterface.h"
|
|
|
|
#include "scriptinterface/JSON.h"
|
2018-04-15 03:46:28 +02:00
|
|
|
|
|
|
|
#include <fstream>
|
|
|
|
|
|
|
|
CModInstaller::CModInstaller(const OsPath& modsdir, const OsPath& tempdir) :
|
|
|
|
m_ModsDir(modsdir), m_TempDir(tempdir / "_modscache"), m_CacheDir("cache/")
|
|
|
|
{
|
|
|
|
m_VFS = CreateVfs();
|
|
|
|
CreateDirectories(m_TempDir, 0700);
|
|
|
|
}
|
|
|
|
|
|
|
|
CModInstaller::~CModInstaller()
|
|
|
|
{
|
|
|
|
m_VFS.reset();
|
|
|
|
DeleteDirectory(m_TempDir);
|
|
|
|
}
|
|
|
|
|
|
|
|
CModInstaller::ModInstallationResult CModInstaller::Install(
|
|
|
|
const OsPath& mod,
|
2020-11-14 11:57:50 +01:00
|
|
|
const std::shared_ptr<ScriptContext>& scriptContext,
|
2018-04-22 20:14:45 +02:00
|
|
|
bool keepFile)
|
2018-04-15 03:46:28 +02:00
|
|
|
{
|
|
|
|
const OsPath modTemp = m_TempDir / mod.Basename() / mod.Filename().ChangeExtension(L".zip");
|
|
|
|
CreateDirectories(modTemp.Parent(), 0700);
|
|
|
|
|
2018-04-22 20:14:45 +02:00
|
|
|
if (keepFile)
|
2021-08-22 13:35:34 +02:00
|
|
|
{
|
|
|
|
if (CopyFile(mod, modTemp, true) != INFO::OK)
|
|
|
|
{
|
|
|
|
LOGERROR("Failed to copy '%s' to '%s'", mod.string8().c_str(), modTemp.string8().c_str());
|
|
|
|
return FAIL_ON_MOD_COPY;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else if (RenameFile(mod, modTemp) != INFO::OK)
|
|
|
|
{
|
|
|
|
LOGERROR("Failed to rename '%s' into '%s'", mod.string8().c_str(), modTemp.string8().c_str());
|
|
|
|
return FAIL_ON_MOD_MOVE;
|
|
|
|
}
|
2018-04-15 03:46:28 +02:00
|
|
|
|
|
|
|
// Load the mod to VFS
|
|
|
|
if (m_VFS->Mount(m_CacheDir, m_TempDir / "") != INFO::OK)
|
|
|
|
return FAIL_ON_VFS_MOUNT;
|
|
|
|
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 FAIL_ON_MOD_LOAD;
|
|
|
|
|
|
|
|
// Extract the name of the mod
|
|
|
|
CStr modName;
|
2020-11-13 14:18:22 +01:00
|
|
|
{
|
2020-11-14 11:57:50 +01:00
|
|
|
ScriptInterface scriptInterface("Engine", "ModInstaller", scriptContext);
|
Improve JS Exception handling.
- Check for pending exceptions after function calls and script
executions.
- Call LOGERROR instead of JS_ReportError when there is a conversion
error in FromJSVal, since that can only be called from C++ (where JS
errors don't really make sense). Instead, C++ callers of FromJSVal
should handle the failure and, themselves, either report an error or
simply do something else.
- Wrap JS_ReportError since that makes updating it later easier.
This isn't a systematical fix since ToJSVal also ought return a boolean
for failures, and we probably should trigger errors instead of warnings
on 'implicit' conversions, rather a preparation diff.
Part of the SM52 migration, stage: SM45 compatible (actually SM52
incompatible, too).
Based on a patch by: Itms
Comments by: Vladislavbelov, Stan`
Refs #742, #4893
Differential Revision: https://code.wildfiregames.com/D3093
This was SVN commit r24187.
2020-11-15 19:29:17 +01:00
|
|
|
ScriptRequest rq(scriptInterface);
|
2020-11-13 14:18:22 +01:00
|
|
|
|
|
|
|
JS::RootedValue json_val(rq.cx);
|
2021-05-14 12:18:03 +02:00
|
|
|
if (!Script::ParseJSON(rq, modinfo.GetAsString(), &json_val))
|
2020-11-13 14:18:22 +01:00
|
|
|
return FAIL_ON_PARSE_JSON;
|
|
|
|
JS::RootedObject json_obj(rq.cx, json_val.toObjectOrNull());
|
|
|
|
JS::RootedValue name_val(rq.cx);
|
|
|
|
if (!JS_GetProperty(rq.cx, json_obj, "name", &name_val))
|
|
|
|
return FAIL_ON_EXTRACT_NAME;
|
2021-05-13 11:43:33 +02:00
|
|
|
Script::FromJSVal(rq, name_val, modName);
|
2020-11-13 14:18:22 +01:00
|
|
|
if (modName.empty())
|
|
|
|
return FAIL_ON_EXTRACT_NAME;
|
|
|
|
}
|
2018-04-15 03:46:28 +02:00
|
|
|
|
|
|
|
const OsPath modDir = m_ModsDir / modName;
|
|
|
|
const OsPath modPath = modDir / (modName + ".zip");
|
|
|
|
|
|
|
|
// Create a directory with the following structure:
|
|
|
|
// mod-name/
|
|
|
|
// mod-name.zip
|
2021-05-16 15:50:05 +02:00
|
|
|
// mod.json
|
2018-04-15 03:46:28 +02:00
|
|
|
CreateDirectories(modDir, 0700);
|
2021-08-22 13:35:34 +02:00
|
|
|
if (RenameFile(modTemp, modPath) != INFO::OK)
|
|
|
|
{
|
|
|
|
LOGERROR("Failed to rename '%s' into '%s'", modTemp.string8().c_str(), modPath.string8().c_str());
|
2018-04-15 03:46:28 +02:00
|
|
|
return FAIL_ON_MOD_MOVE;
|
2021-08-22 13:35:34 +02:00
|
|
|
}
|
|
|
|
|
2018-04-15 03:46:28 +02:00
|
|
|
DeleteDirectory(modTemp.Parent());
|
|
|
|
|
|
|
|
std::ofstream mod_json((modDir / "mod.json").string8());
|
|
|
|
if (mod_json.good())
|
|
|
|
{
|
|
|
|
mod_json << modinfo.GetAsString();
|
|
|
|
mod_json.close();
|
|
|
|
}
|
2021-05-16 15:50:05 +02:00
|
|
|
else
|
|
|
|
return FAIL_ON_JSON_WRITE;
|
2018-04-15 03:46:28 +02:00
|
|
|
|
|
|
|
m_InstalledMods.emplace_back(modName);
|
|
|
|
|
|
|
|
return SUCCESS;
|
|
|
|
}
|
|
|
|
|
|
|
|
const std::vector<CStr>& CModInstaller::GetInstalledMods() const
|
|
|
|
{
|
|
|
|
return m_InstalledMods;
|
|
|
|
}
|