Plugins.cpp

// Copyright (c) 2020- PPSSPP Project.

// 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, version 2.0 or later versions.

// 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 2.0 for more details.

// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/

// Official git repository and contact information can be found at
// https://github.com/hrydgard/ppsspp and http://www.ppsspp.org/.

#include <set>
#include <mutex>

#include "Common/Data/Format/IniFile.h"
#include "Common/File/FileUtil.h"
#include "Common/File/DirListing.h"
#include "Common/Serialize/SerializeFuncs.h"
#include "Common/System/OSD.h"
#include "Common/Data/Text/I18n.h"
#include "Common/StringUtils.h"
#include "Core/Config.h"
#include "Core/MemMap.h"
#include "Core/System.h"
#include "Core/ELF/ParamSFO.h"
#include "Core/HLE/Plugins.h"
#include "Core/HLE/sceKernelModule.h"

namespace HLEPlugins {

std::mutex g_inputMutex;
float PluginDataAxis[JOYSTICK_AXIS_MAX];
std::map<int, uint8_t> PluginDataKeys;

static bool anyEnabled = false;
static std::vector<std::string> prxPlugins;

static PluginInfo ReadPluginIni(const std::string &subdir, IniFile &ini) {
	PluginInfo info;

	auto options = ini.GetOrCreateSection("options");
	std::string value;

	if (options->Get("type", &value)) {
		if (value == "prx") {
			info.type = PluginType::PRX;
		}
	}

	value.clear();
	if (options->Get("filename", &value)) {
		info.name = value;
		info.filename = "ms0:/PSP/PLUGINS/" + subdir + "/" + value;
	} else {
		info.type = PluginType::INVALID;
	}

	value.clear();
	if (options->Get("name", &value)) {
		info.name = value;
	}

	info.version = 0;
	info.memory = 0;
	options->Get("version", &info.version);
	options->Get("memory", &info.memory);
	if (info.memory > 93) {
		ERROR_LOG(Log::System, "Plugin memory too high, using 93 MB");
		info.memory = 93;
	}

	if (info.version == 0) {
		ERROR_LOG(Log::System, "Plugin without version ignored: %s", subdir.c_str());
		info.type = PluginType::INVALID;
		info.memory = 0;
	} else if (info.type == PluginType::INVALID && !info.filename.empty()) {
		ERROR_LOG(Log::System, "Plugin without valid type: %s", subdir.c_str());
	}

	return info;
}

std::vector<PluginInfo> FindPlugins(const std::string &gameID, const std::string &lang) {
	std::vector<File::FileInfo> pluginDirs;
	GetFilesInDir(GetSysDirectory(DIRECTORY_PLUGINS), &pluginDirs);

	std::vector<PluginInfo> found;
	for (const auto &subdir : pluginDirs) {
		const Path &subdirFullName = subdir.fullName;
		if (!subdir.isDirectory || !File::Exists(subdirFullName / "plugin.ini"))
			continue;

		IniFile ini;
		if (!ini.Load(subdirFullName / "plugin.ini")) {
			ERROR_LOG(Log::System, "Failed to load plugin ini: %s/plugin.ini", subdirFullName.c_str());
			continue;
		}

		std::set<std::string> matches;

		std::string gameIni;

		// TODO: Should just use getsection and fail the ini if not found, I guess.
		const Section *games = ini.GetSection("games");
		if (games) {
			gameIni.clear();
			if (games->Get(gameID.c_str(), &gameIni)) {
				if (!strcasecmp(gameIni.c_str(), "true")) {
					matches.insert("plugin.ini");
				} else if (!strcasecmp(gameIni.c_str(), "false")) {
					continue;
				} else if (!gameIni.empty()) {
					matches.insert(gameIni);
				}
			}
			gameIni.clear();
			if (games->Get("ALL", &gameIni)) {
				if (!strcasecmp(gameIni.c_str(), "true")) {
					matches.insert("plugin.ini");
				} else if (!gameIni.empty()) {
					matches.insert(gameIni);
				}
			}
		}

		std::set<std::string> langMatches;
		for (const std::string &subini : matches) {
			if (!ini.Load(subdirFullName / subini)) {
				ERROR_LOG(Log::System, "Failed to load plugin ini: %s/%s", subdirFullName.c_str(), subini.c_str());
				continue;
			}

			found.push_back(ReadPluginIni(subdir.name, ini));
			gameIni.clear();
			if (ini.GetOrCreateSection("lang")->Get(lang.c_str(), &gameIni)) {
				if (!gameIni.empty() && matches.find(gameIni) == matches.end()) {
					langMatches.insert(gameIni);
				}
			}
		}

		for (const std::string &subini : langMatches) {
			if (!ini.Load(subdirFullName / subini)) {
				ERROR_LOG(Log::System, "Failed to load plugin ini: %s/%s", subdirFullName.c_str(), subini.c_str());
				continue;
			}

			found.push_back(ReadPluginIni(subdir.name, ini));
		}
	}

	return found;
}

void Init() {
	if (!g_Config.bLoadPlugins) {
		return;
	}

	std::vector<PluginInfo> plugins = FindPlugins(g_paramSFO.GetDiscID(), g_Config.sLanguageIni);
	for (auto &plugin : plugins) {
		if (plugin.memory << 20 > Memory::g_MemorySize) {
			Memory::g_MemorySize = plugin.memory << 20;
			anyEnabled = true;
		}

		if (plugin.type == PluginType::PRX) {
			prxPlugins.push_back(plugin.filename);
			anyEnabled = true;
		}
	}
}

bool Load(PSPModule *pluginWaitingModule, SceUID threadID) {
	bool started = false;

	auto sy = GetI18NCategory(I18NCat::SYSTEM);

	for (const std::string &filename : prxPlugins) {
		if (!g_Config.bEnablePlugins) {
			WARN_LOG(Log::System, "Plugins are disabled, ignoring enabled plugin %s", filename.c_str());
			continue;
		}

		std::string error_string = "";
		SceUID module = KernelLoadModule(filename, &error_string);
		if (!error_string.empty() || module < 0) {
			ERROR_LOG(Log::System, "Unable to load plugin %s (module %d): '%s'", filename.c_str(), module, error_string.c_str());
			continue;
		}

		int ret = __KernelStartModule(module, 0, 0, 0, nullptr, nullptr);
		if (ret < 0) {
			ERROR_LOG(Log::System, "Unable to start plugin %s: %08x", filename.c_str(), ret);
		} else {
			std::string shortName = Path(filename).GetFilename();
			g_OSD.Show(OSDType::MESSAGE_SUCCESS, ApplySafeSubstitutions(sy->T("Loaded plugin: %1"), shortName), 6.0f);
			started = true;
			pluginWaitingModule->startingPlugins.push_back(module);
			u32 error;
			PSPModule *plugin_module = kernelObjects.Get<PSPModule>(module, error);
			plugin_module->pluginWaitingThread = threadID;
		}

		INFO_LOG(Log::System, "Loaded plugin: %s", filename.c_str());
	}

	std::lock_guard<std::mutex> guard(g_inputMutex);
	PluginDataKeys.clear();
	return started;
}

void Unload() {
	// Nothing to do here, for now.
}

void Shutdown() {
	prxPlugins.clear();
	anyEnabled = false;
	std::lock_guard<std::mutex> guard(g_inputMutex);
	PluginDataKeys.clear();
}

void DoState(PointerWrap &p) {
	auto s = p.Section("Plugins", 0, 1);
	if (!s)
		return;

	// Remember if any were enabled.
	Do(p, anyEnabled);
}

bool HasEnabled() {
	return anyEnabled;
}

void SetKey(int key, uint8_t value) {
	if (anyEnabled) {
		std::lock_guard<std::mutex> guard(g_inputMutex);
		PluginDataKeys[key] = value;
	}
}

uint8_t GetKey(int key) {
	std::lock_guard<std::mutex> guard(g_inputMutex);
	return PluginDataKeys[key];
}

}  // namespace