diff options
Diffstat (limited to 'archived/projt-launcher/launcher/MMCZip.h')
| -rw-r--r-- | archived/projt-launcher/launcher/MMCZip.h | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/archived/projt-launcher/launcher/MMCZip.h b/archived/projt-launcher/launcher/MMCZip.h new file mode 100644 index 0000000000..aca4daac43 --- /dev/null +++ b/archived/projt-launcher/launcher/MMCZip.h @@ -0,0 +1,282 @@ +// SPDX-License-Identifier: GPL-3.0-only +// SPDX-FileCopyrightText: 2026 Project Tick +// SPDX-FileContributor: Project Tick Team +/* + * ProjT Launcher - Minecraft Launcher + * Copyright (C) 2026 Project Tick + * + * 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 3. + * + * 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 for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * === Upstream License Block (Do Not Modify) ============================== + * + * + * + * Prism Launcher - Minecraft Launcher + * Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net> + * Copyright (c) 2023-2024 Trial97 <alexandru.tripon97@gmail.com> + * + * 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 3. + * + * 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 for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * This file incorporates work covered by the following copyright and + * permission notice: + * + * Copyright 2013-2021 MultiMC Contributors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ======================================================================== */ + +#pragma once + +#include <quazip.h> +#include <quazip/JlCompress.h> +#include <QDir> +#include <QFileInfo> +#include <QFuture> +#include <QFutureWatcher> +#include <QHash> +#include <QSet> +#include <QString> +#include <functional> +#include <memory> +#include <optional> + +#if defined(LAUNCHER_APPLICATION) +#include "minecraft/mod/Mod.hpp" +#endif +#include "Filter.h" +#include "tasks/Task.h" + +namespace MMCZip +{ + using FilterFileFunction = std::function<bool(const QFileInfo&)>; + + /** + * Merge two zip files, using a filter function + */ + bool mergeZipFiles(QuaZip* into, QFileInfo from, QSet<QString>& contained, const Filter& filter = nullptr); + + /** + * Compress directory, by providing a list of files to compress + * \param zip target archive + * \param dir directory that will be compressed (to compress with relative paths) + * \param files list of files to compress + * \param followSymlinks should follow symlinks when compressing file data + * \return true for success or false for failure + */ + bool compressDirFiles(QuaZip* zip, QString dir, QFileInfoList files, bool followSymlinks = false); + + /** + * Compress directory, by providing a list of files to compress + * \param fileCompressed target archive file + * \param dir directory that will be compressed (to compress with relative paths) + * \param files list of files to compress + * \param followSymlinks should follow symlinks when compressing file data + * \return true for success or false for failure + */ + bool compressDirFiles(QString fileCompressed, QString dir, QFileInfoList files, bool followSymlinks = false); + +#if defined(LAUNCHER_APPLICATION) + /** + * take a source jar, add mods to it, resulting in target jar + */ + bool createModdedJar(QString sourceJarPath, QString targetJarPath, const QList<Mod*>& mods); +#endif + /** + * Find a single file in archive by file name (not path) + * + * \param ignore_paths paths to skip when recursing the search + * + * \return the path prefix where the file is + */ + QString findFolderOfFileInZip(QuaZip* zip, + const QString& what, + const QStringList& ignore_paths = {}, + const QString& root = QString("")); + + /** + * Find a multiple files of the same name in archive by file name + * If a file is found in a path, no deeper paths are searched + * + * \return true if anything was found + */ + bool findFilesInZip(QuaZip* zip, const QString& what, QStringList& result, const QString& root = QString()); + + /** + * Extract a subdirectory from an archive + */ + std::optional<QStringList> extractSubDir(QuaZip* zip, const QString& subdir, const QString& target); + + bool extractRelFile(QuaZip* zip, const QString& file, const QString& target); + + /** + * Extract a whole archive. + * + * \param fileCompressed The name of the archive. + * \param dir The directory to extract to, the current directory if left empty. + * \return The list of the full paths of the files extracted, empty on failure. + */ + std::optional<QStringList> extractDir(QString fileCompressed, QString dir); + + /** + * Extract a subdirectory from an archive + * + * \param fileCompressed The name of the archive. + * \param subdir The directory within the archive to extract + * \param dir The directory to extract to, the current directory if left empty. + * \return The list of the full paths of the files extracted, empty on failure. + */ + std::optional<QStringList> extractDir(QString fileCompressed, QString subdir, QString dir); + + /** + * Extract a single file from an archive into a directory + * + * \param fileCompressed The name of the archive. + * \param file The file within the archive to extract + * \param dir The directory to extract to, the current directory if left empty. + * \return true for success or false for failure + */ + bool extractFile(QString fileCompressed, QString file, QString dir); + + /** + * Populate a QFileInfoList with a directory tree recursively, while allowing to excludeFilter what shouldn't be + * included. + * \param rootDir directory to start off + * \param subDir subdirectory, should be nullptr for first invocation + * \param files resulting list of QFileInfo + * \param excludeFilter function to excludeFilter which files shouldn't be included (returning true means to excude) + * \return true for success or false for failure + */ + bool collectFileListRecursively(const QString& rootDir, + const QString& subDir, + QFileInfoList* files, + FilterFileFunction excludeFilter); + +#if defined(LAUNCHER_APPLICATION) + class ExportToZipTask : public Task + { + Q_OBJECT + public: + ExportToZipTask(QString outputPath, + QDir dir, + QFileInfoList files, + QString destinationPrefix = "", + bool followSymlinks = false, + bool utf8Enabled = false) + : m_output_path(outputPath), + m_output(outputPath), + m_dir(dir), + m_files(files), + m_destination_prefix(destinationPrefix), + m_follow_symlinks(followSymlinks) + { + setAbortable(true); + m_output.setUtf8Enabled(utf8Enabled); + }; + ExportToZipTask(QString outputPath, + QString dir, + QFileInfoList files, + QString destinationPrefix = "", + bool followSymlinks = false, + bool utf8Enabled = false) + : ExportToZipTask(outputPath, QDir(dir), files, destinationPrefix, followSymlinks, utf8Enabled) {}; + + virtual ~ExportToZipTask() = default; + + void setExcludeFiles(QStringList excludeFiles) + { + m_exclude_files = excludeFiles; + } + void addExtraFile(QString fileName, QByteArray data) + { + m_extra_files.insert(fileName, data); + } + + using ZipResult = std::optional<QString>; + + protected: + virtual void executeTask() override; + bool abort() override; + + ZipResult exportZip(); + void finish(); + + private: + QString m_output_path; + QuaZip m_output; + QDir m_dir; + QFileInfoList m_files; + QString m_destination_prefix; + bool m_follow_symlinks; + QStringList m_exclude_files; + QHash<QString, QByteArray> m_extra_files; + + QFuture<ZipResult> m_build_zip_future; + QFutureWatcher<ZipResult> m_build_zip_watcher; + }; + + class ExtractZipTask : public Task + { + Q_OBJECT + public: + ExtractZipTask(QString input, QDir outputDir, QString subdirectory = "") + : ExtractZipTask(std::make_shared<QuaZip>(input), outputDir, subdirectory) + {} + ExtractZipTask(std::shared_ptr<QuaZip> input, QDir outputDir, QString subdirectory = "") + : m_input(input), + m_output_dir(outputDir), + m_subdirectory(subdirectory) + {} + virtual ~ExtractZipTask() = default; + + using ZipResult = std::optional<QString>; + + protected: + virtual void executeTask() override; + bool abort() override; + + ZipResult extractZip(); + void finish(); + + private: + std::shared_ptr<QuaZip> m_input; + QDir m_output_dir; + QString m_subdirectory; + + QFuture<ZipResult> m_zip_future; + QFutureWatcher<ZipResult> m_zip_watcher; + }; +#endif +} // namespace MMCZip |