// SPDX-License-Identifier: GPL-3.0-only /* * Prism Launcher - Minecraft Launcher * Copyright (C) 2022 Sefa Eyeoglu * Copyright (c) 2023 Trial97 * * 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, see . * * 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 #include #include #include #include #include #include #include #include #include #include #include #if defined(LAUNCHER_APPLICATION) #include "minecraft/mod/Mod.h" #endif #include "tasks/Task.h" namespace MMCZip { using FilterFunction = std::function; /** * Merge two zip files, using a filter function */ bool mergeZipFiles(QuaZip* into, QFileInfo from, QSet& contained, const FilterFunction 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& 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 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 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 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, FilterFunction excludeFilter); #if defined(LAUNCHER_APPLICATION) class ExportToZipTask : public Task { public: ExportToZipTask(QString outputPath, QDir dir, QFileInfoList files, QString destinationPrefix = "", bool followSymlinks = false) : m_output_path(outputPath) , m_output(outputPath) , m_dir(dir) , m_files(files) , m_destination_prefix(destinationPrefix) , m_follow_symlinks(followSymlinks) { setAbortable(true); }; ExportToZipTask(QString outputPath, QString dir, QFileInfoList files, QString destinationPrefix = "", bool followSymlinks = false) : ExportToZipTask(outputPath, QDir(dir), files, destinationPrefix, followSymlinks){}; 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; 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 m_extra_files; QFuture m_build_zip_future; QFutureWatcher m_build_zip_watcher; }; class ExtractZipTask : public Task { public: ExtractZipTask(std::shared_ptr input, QDir outputDir, QString subdirectory = "") : m_input(input), m_output_dir(outputDir), m_subdirectory(subdirectory) {} virtual ~ExtractZipTask() = default; typedef std::optional ZipResult; protected: virtual void executeTask() override; bool abort() override; ZipResult extractZip(); void finish(); private: std::shared_ptr m_input; QDir m_output_dir; QString m_subdirectory; QFuture m_zip_future; QFutureWatcher m_zip_watcher; }; #endif } // namespace MMCZip