PrismLauncher/launcher/FileSystem.cpp

398 lines
11 KiB
C++
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
*
* 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 <https://www.gnu.org/licenses/>.
*
* 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.
*/
#include "FileSystem.h"
#include <QDebug>
#include <QDir>
#include <QDirIterator>
#include <QFile>
#include <QFileInfo>
#include <QSaveFile>
#include <QStandardPaths>
#include <QTextStream>
#include <QUrl>
#if defined Q_OS_WIN32
#include <objbase.h>
#include <objidl.h>
#include <shlguid.h>
#include <shlobj.h>
#include <shobjidl.h>
#include <sys/utime.h>
#include <windows.h>
#include <winnls.h>
#include <string>
#else
#include <utime.h>
#endif
#include <filesystem>
#if defined Q_OS_WIN32
std::wstring toStdString(QString s)
{
return s.toStdWString();
}
#else
std::string toStdString(QString s)
{
return s.toStdString();
}
#endif
namespace FS {
void ensureExists(const QDir& dir)
{
if (!QDir().mkpath(dir.absolutePath())) {
throw FileSystemException("Unable to create folder " + dir.dirName() + " (" + dir.absolutePath() + ")");
2018-07-15 13:51:05 +01:00
}
}
void write(const QString& filename, const QByteArray& data)
{
2018-07-15 13:51:05 +01:00
ensureExists(QFileInfo(filename).dir());
QSaveFile file(filename);
if (!file.open(QSaveFile::WriteOnly)) {
throw FileSystemException("Couldn't open " + filename + " for writing: " + file.errorString());
2018-07-15 13:51:05 +01:00
}
if (data.size() != file.write(data)) {
throw FileSystemException("Error writing data to " + filename + ": " + file.errorString());
2018-07-15 13:51:05 +01:00
}
if (!file.commit()) {
throw FileSystemException("Error while committing data to " + filename + ": " + file.errorString());
2018-07-15 13:51:05 +01:00
}
}
QByteArray read(const QString& filename)
{
2018-07-15 13:51:05 +01:00
QFile file(filename);
if (!file.open(QFile::ReadOnly)) {
throw FileSystemException("Unable to open " + filename + " for reading: " + file.errorString());
2018-07-15 13:51:05 +01:00
}
const qint64 size = file.size();
QByteArray data(int(size), 0);
const qint64 ret = file.read(data.data(), size);
if (ret == -1 || ret != size) {
throw FileSystemException("Error reading data from " + filename + ": " + file.errorString());
2018-07-15 13:51:05 +01:00
}
return data;
}
2015-10-05 00:47:27 +01:00
2016-11-17 03:09:24 +00:00
bool updateTimestamp(const QString& filename)
{
#ifdef Q_OS_WIN32
2018-07-15 13:51:05 +01:00
std::wstring filename_utf_16 = filename.toStdWString();
return (_wutime64(filename_utf_16.c_str(), nullptr) == 0);
#else
2018-07-15 13:51:05 +01:00
QByteArray filenameBA = QFile::encodeName(filename);
return (utime(filenameBA.data(), nullptr) == 0);
#endif
2016-11-17 03:09:24 +00:00
}
bool ensureFilePathExists(QString filenamepath)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
QFileInfo a(filenamepath);
QDir dir;
QString ensuredPath = a.path();
bool success = dir.mkpath(ensuredPath);
return success;
2015-10-05 00:47:27 +01:00
}
bool ensureFolderPathExists(QString foldernamepath)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
QFileInfo a(foldernamepath);
QDir dir;
QString ensuredPath = a.filePath();
bool success = dir.mkpath(ensuredPath);
return success;
2015-10-05 00:47:27 +01:00
}
bool copy::operator()(const QString& offset)
2015-10-05 00:47:27 +01:00
{
using copy_opts = std::filesystem::copy_options;
// NOTE always deep copy on windows. the alternatives are too messy.
#if defined Q_OS_WIN32
2018-07-15 13:51:05 +01:00
m_followSymlinks = true;
#endif
2018-07-15 13:51:05 +01:00
auto src = PathCombine(m_src.absolutePath(), offset);
auto dst = PathCombine(m_dst.absolutePath(), offset);
std::error_code err;
2018-07-15 13:51:05 +01:00
std::filesystem::copy_options opt = copy_opts::none;
// The default behavior is to follow symlinks
if (!m_followSymlinks)
opt |= copy_opts::copy_symlinks;
// We can't use copy_opts::recursive because we need to take into account the
// blacklisted paths, so we iterate over the source directory, and if there's no blacklist
// match, we copy the file.
QDir src_dir(src);
QDirIterator source_it(src, QDir::Filter::Files, QDirIterator::Subdirectories);
while (source_it.hasNext()) {
auto src_path = source_it.next();
auto relative_path = src_dir.relativeFilePath(src_path);
if (m_blacklist && m_blacklist->matches(relative_path))
continue;
auto dst_path = PathCombine(dst, relative_path);
ensureFilePathExists(dst_path);
std::filesystem::copy(toStdString(src_path), toStdString(dst_path), opt, err);
if (err) {
qWarning() << "Failed to copy files:" << QString::fromStdString(err.message());
qDebug() << "Source file:" << src_path;
qDebug() << "Destination file:" << dst_path;
2018-07-15 13:51:05 +01:00
}
}
return err.value() == 0;
2015-10-05 00:47:27 +01:00
}
bool deletePath(QString path)
2015-10-05 00:47:27 +01:00
{
std::error_code err;
std::filesystem::remove_all(toStdString(path), err);
2018-07-15 13:51:05 +01:00
if (err) {
qWarning() << "Failed to remove files:" << QString::fromStdString(err.message());
2018-07-15 13:51:05 +01:00
}
return err.value() == 0;
2015-10-05 00:47:27 +01:00
}
bool trash(QString path, QString *pathInTrash = nullptr)
{
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
return false;
#else
return QFile::moveToTrash(path, pathInTrash);
#endif
}
2015-10-05 00:47:27 +01:00
QString PathCombine(const QString& path1, const QString& path2)
2015-10-05 00:47:27 +01:00
{
if (!path1.size())
2018-07-15 13:51:05 +01:00
return path2;
if (!path2.size())
2018-07-15 13:51:05 +01:00
return path1;
2015-10-05 00:47:27 +01:00
return QDir::cleanPath(path1 + QDir::separator() + path2);
}
QString PathCombine(const QString& path1, const QString& path2, const QString& path3)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
return PathCombine(PathCombine(path1, path2), path3);
2015-10-05 00:47:27 +01:00
}
QString PathCombine(const QString& path1, const QString& path2, const QString& path3, const QString& path4)
{
2018-07-15 13:51:05 +01:00
return PathCombine(PathCombine(path1, path2, path3), path4);
}
QString AbsolutePath(QString path)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
return QFileInfo(path).absolutePath();
2015-10-05 00:47:27 +01:00
}
QString ResolveExecutable(QString path)
2015-10-05 00:47:27 +01:00
{
if (path.isEmpty()) {
2018-07-15 13:51:05 +01:00
return QString();
}
if (!path.contains('/')) {
2018-07-15 13:51:05 +01:00
path = QStandardPaths::findExecutable(path);
}
QFileInfo pathInfo(path);
if (!pathInfo.exists() || !pathInfo.isExecutable()) {
2018-07-15 13:51:05 +01:00
return QString();
}
return pathInfo.absoluteFilePath();
2015-10-05 00:47:27 +01:00
}
/**
* Normalize path
*
* Any paths inside the current folder will be normalized to relative paths (to current)
2015-10-05 00:47:27 +01:00
* Other paths will be made absolute
*/
QString NormalizePath(QString path)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
QDir a = QDir::currentPath();
QString currentAbsolute = a.absolutePath();
QDir b(path);
QString newAbsolute = b.absolutePath();
if (newAbsolute.startsWith(currentAbsolute)) {
2018-07-15 13:51:05 +01:00
return a.relativeFilePath(newAbsolute);
} else {
2018-07-15 13:51:05 +01:00
return newAbsolute;
}
2015-10-05 00:47:27 +01:00
}
2019-08-13 06:39:00 +01:00
QString badFilenameChars = "\"\\/?<>:;*|!+\r\n";
2015-10-05 00:47:27 +01:00
QString RemoveInvalidFilenameChars(QString string, QChar replaceWith)
2015-10-05 00:47:27 +01:00
{
for (int i = 0; i < string.length(); i++) {
if (badFilenameChars.contains(string[i])) {
2018-07-15 13:51:05 +01:00
string[i] = replaceWith;
}
}
return string;
2015-10-05 00:47:27 +01:00
}
QString DirNameFromString(QString string, QString inDir)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
int num = 0;
QString baseName = RemoveInvalidFilenameChars(string, '-');
QString dirName;
do {
if (num == 0) {
2018-07-15 13:51:05 +01:00
dirName = baseName;
} else {
dirName = baseName + "(" + QString::number(num) + ")";
2018-07-15 13:51:05 +01:00
}
// If it's over 9000
if (num > 9000)
return "";
num++;
} while (QFileInfo(PathCombine(inDir, dirName)).exists());
return dirName;
2015-10-05 00:47:27 +01:00
}
// Does the folder path contain any '!'? If yes, return true, otherwise false.
2015-10-05 00:47:27 +01:00
// (This is a problem for Java)
bool checkProblemticPathJava(QDir folder)
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
QString pathfoldername = folder.absolutePath();
return pathfoldername.contains("!", Qt::CaseInsensitive);
2015-10-05 00:47:27 +01:00
}
QString getDesktopDir()
2015-10-05 00:47:27 +01:00
{
2018-07-15 13:51:05 +01:00
return QStandardPaths::writableLocation(QStandardPaths::DesktopLocation);
2015-10-05 00:47:27 +01:00
}
// Cross-platform Shortcut creation
bool createShortCut(QString location, QString dest, QStringList args, QString name, QString icon)
2015-10-05 00:47:27 +01:00
{
2021-12-12 00:35:46 +00:00
#if defined(Q_OS_LINUX) || defined(Q_OS_FREEBSD)
2018-07-15 13:51:05 +01:00
location = PathCombine(location, name + ".desktop");
2015-10-05 00:47:27 +01:00
2018-07-15 13:51:05 +01:00
QFile f(location);
f.open(QIODevice::WriteOnly | QIODevice::Text);
QTextStream stream(&f);
2015-10-05 00:47:27 +01:00
2018-07-15 13:51:05 +01:00
QString argstring;
if (!args.empty())
argstring = " '" + args.join("' '") + "'";
2015-10-05 00:47:27 +01:00
2018-07-15 13:51:05 +01:00
stream << "[Desktop Entry]"
<< "\n";
stream << "Type=Application"
<< "\n";
stream << "TryExec=" << dest.toLocal8Bit() << "\n";
stream << "Exec=" << dest.toLocal8Bit() << argstring.toLocal8Bit() << "\n";
stream << "Name=" << name.toLocal8Bit() << "\n";
stream << "Icon=" << icon.toLocal8Bit() << "\n";
2015-10-05 00:47:27 +01:00
2018-07-15 13:51:05 +01:00
stream.flush();
f.close();
2015-10-05 00:47:27 +01:00
f.setPermissions(f.permissions() | QFileDevice::ExeOwner | QFileDevice::ExeGroup | QFileDevice::ExeOther);
2015-10-05 00:47:27 +01:00
2018-07-15 13:51:05 +01:00
return true;
2015-10-05 00:47:27 +01:00
#elif defined Q_OS_WIN
2018-07-15 13:51:05 +01:00
// TODO: Fix
// QFile file(PathCombine(location, name + ".lnk"));
// WCHAR *file_w;
// WCHAR *dest_w;
// WCHAR *args_w;
// file.fileName().toWCharArray(file_w);
// dest.toWCharArray(dest_w);
// QString argStr;
// for (int i = 0; i < args.count(); i++)
// {
// argStr.append(args[i]);
// argStr.append(" ");
// }
// argStr.toWCharArray(args_w);
// return SUCCEEDED(CreateLink(file_w, dest_w, args_w));
return false;
2015-10-05 00:47:27 +01:00
#else
2018-07-15 13:51:05 +01:00
qWarning("Desktop Shortcuts not supported on your platform!");
return false;
2015-10-05 00:47:27 +01:00
#endif
}
bool overrideFolder(QString overwritten_path, QString override_path)
{
using copy_opts = std::filesystem::copy_options;
if (!FS::ensureFolderPathExists(overwritten_path))
return false;
std::error_code err;
std::filesystem::copy_options opt = copy_opts::recursive | copy_opts::overwrite_existing;
std::filesystem::copy(toStdString(override_path), toStdString(overwritten_path), opt, err);
if (err) {
qCritical() << QString("Failed to apply override from %1 to %2").arg(override_path, overwritten_path);
qCritical() << "Reason:" << QString::fromStdString(err.message());
}
return err.value() == 0;
}
}