File: ModInstaller.h

package info (click to toggle)
0ad 0.0.23.1-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 78,412 kB
  • sloc: cpp: 245,162; ansic: 200,249; javascript: 19,244; python: 13,754; sh: 6,104; perl: 4,620; makefile: 977; xml: 810; java: 533; ruby: 229; erlang: 46; pascal: 30; sql: 21; tcl: 4
file content (84 lines) | stat: -rw-r--r-- 2,133 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* Copyright (C) 2018 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 "CStr.h"
#include "lib/file/vfs/vfs.h"
#include "scriptinterface/ScriptInterface.h"

#include <vector>

/**
 * Install a mod into the mods directory.
 */
class CModInstaller
{
public:
	enum ModInstallationResult
	{
		SUCCESS,
		FAIL_ON_VFS_MOUNT,
		FAIL_ON_MOD_LOAD,
		FAIL_ON_PARSE_JSON,
		FAIL_ON_EXTRACT_NAME,
		FAIL_ON_MOD_MOVE
	};

	/**
	 * Initialise the mod installer for processing the given mod.
	 *
	 * @param modsdir path to the data directory that contains mods
	 * @param tempdir path to a writable directory for temporary files
	 */
	CModInstaller(const OsPath& modsdir, const OsPath& tempdir);

	~CModInstaller();

	/**
	 * Process and unpack the mod.
	 * @param mod path of .pyromod/.zip file
	 * @param keepFile if true, copy the file, if false move it
	 */
	ModInstallationResult Install(
		const OsPath& mod,
		const std::shared_ptr<ScriptRuntime>& scriptRuntime,
		bool keepFile);

	/**
	 * @return a list of all mods installed so far by this CModInstaller.
	 */
	const std::vector<CStr>& GetInstalledMods() const;

	/**
	 * @return whether the path has a mod-like extension.
	 */
	static bool IsDefaultModExtension(const Path& ext)
	{
		return ext == ".pyromod" || ext == ".zip";
	}

private:
	PIVFS m_VFS;
	OsPath m_ModsDir;
	OsPath m_TempDir;
	VfsPath m_CacheDir;
	std::vector<CStr> m_InstalledMods;
};

#endif // INCLUDED_MODINSTALLER