ppsspp/Core/Util/GameManager.h

// Copyright (c) 2013- 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/.


// Manages the PSP/GAME directory contents.
//
// Not concerned with full ISOs.

#pragma once

#include <thread>
#include <atomic>
#include <optional>

#include "Common/Net/HTTPClient.h"
#include "Common/Data/Text/I18n.h"

enum class GameManagerState {
	IDLE,
	DOWNLOADING,
	INSTALLING,
};

struct ZipFileTask {
	std::optional<ZipFileInfo> zipFileInfo;
	Path url;  // Same as filename if installing from disk. Probably not really useful.
	Path fileName;
	Path destination;  // If set, will override the default destination.
	bool deleteAfter;
};

struct zip;
class FileLoader;
class Path;
struct ZipFileInfo;

class GameManager {
public:
	GameManager();

	bool IsGameInstalled(const std::string &name);

	// This starts off a background process.
	bool DownloadAndInstall(const std::string &storeZipUrl);
	bool IsDownloading(const std::string &storeZipUrl);

	// Cancels the download in progress, if any.
	bool CancelDownload();

	float DownloadSpeedKBps();

	// Call from time to time to check on completed downloads from the
	// main UI thread.
	void Update();

	GameManagerState GetState() {
		if (InstallInProgress() || installDonePending_)
			return GameManagerState::INSTALLING;
		if (curDownload_)
			return GameManagerState::DOWNLOADING;
		return GameManagerState::IDLE;
	}

	float GetCurrentInstallProgressPercentage() const {
		return installProgress_;
	}
	void ResetInstallError();
	// Translated, empty if the last install didn't fail.
	std::string GetInstallError() const;

	// Only returns false if there's already an installation in progress.
	bool InstallZipOnThread(ZipFileTask task);

	// Installs a game update from a .pkg into PSP/GAME/<DISC_ID>. Same contract as the above -
	// only returns false if something else is already installing. See Core/Util/PkgUnpack.h.
	bool InstallPkgOnThread(const Path &pkgPath, bool deleteAfter);

	// Separate kind of functionality from InstallZipOnThread, so doesn't re-use the task struct.
	bool UninstallGameOnThread(const std::string &name);

	// Extracts the contents of an open zip archive into dest. Exposed for testing.
	// maxTotalSize limits the total decompressed size (zip bomb protection).
	bool ExtractZipContents(struct zip *z, const Path &dest, const ZipFileInfo &info, bool allowRoot, int64_t maxTotalSize = 0x100000000ULL);
	// Extracts a PS1 disc's files (ZipFileInfo::discFiles), into a folder of their own if there's more
	// than one. Exposed for testing.
	bool InstallZippedPS1Disc(struct zip *z, const std::vector<std::string> &files, const Path &destDir);

private:
	void InstallZipContents(ZipFileTask task);
	void InstallPkgContents(Path pkgPath, bool deleteAfter);
	bool InstallMemstickZip(const Path &zipFile, const Path &dest, const ZipFileInfo &info);
	bool InstallZippedISO(struct zip *z, int isoFileIndex, const Path &destDir);
	void UninstallGame(const std::string &name);

	void InstallDone();

	bool ExtractFile(struct zip *z, int file_index, const Path &outFilename, int64_t *bytesCopied, int64_t allBytes, int64_t maxTotalSize = 0x100000000ULL);
	bool DetectTexturePackDest(struct zip *z, int iniIndex, Path &dest);
	// key is a translation key in cat, translated when the UI asks for it.
	void SetInstallError(I18NCat cat, const char *key);

	bool InstallInProgress() const { return installThread_.joinable(); }

	Path GetTempFilename() const;
	std::string GetGameID(const Path &path) const;
	std::string GetPBPGameID(FileLoader *loader) const;
	std::string GetISOGameID(FileLoader *loader) const;
	std::shared_ptr<http::Request> curDownload_;
	std::thread installThread_;
	std::atomic<bool> installDonePending_{};
	std::atomic<bool> cleanRecentsAfter_{};

	float installProgress_ = 0.0f;
	I18NCat installErrorCat_{};
	const char *installErrorKey_ = nullptr;
};

extern GameManager g_GameManager;

bool ZipCanExtractWithoutOverwrite(struct zip *z, const Path &destination, int stripChars, int maxOkFiles);