PrismLauncher/launcher/minecraft/AssetsUtils.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

321 lines
9.8 KiB
C++
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* Prism Launcher - Minecraft Launcher
* Copyright (c) 2022 flowln <flowlnlnln@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, 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 <QCryptographicHash>
#include <QDebug>
#include <QDir>
#include <QDirIterator>
#include <QFileInfo>
#include <QJsonDocument>
#include <QJsonObject>
#include <QJsonParseError>
#include <QVariant>
#include "AssetsUtils.h"
#include "BuildConfig.h"
#include "FileSystem.h"
#include "net/ApiDownload.h"
#include "net/ChecksumValidator.h"
#include "Application.h"
namespace {
QSet<QString> collectPathsFromDir(QString dirPath)
{
QFileInfo dirInfo(dirPath);
if (!dirInfo.exists()) {
return {};
}
QSet<QString> out;
QDirIterator iter(dirPath, QDirIterator::Subdirectories);
while (iter.hasNext()) {
QString value = iter.next();
QFileInfo info(value);
if (info.isFile()) {
out.insert(value);
qDebug() << value;
}
}
return out;
}
} // namespace
namespace AssetsUtils {
/*
* Returns true on success, with index populated
* index is undefined otherwise
*/
bool loadAssetsIndexJson(const QString& assetsId, const QString& path, AssetsIndex& index)
{
2013-12-10 06:12:52 +00:00
/*
{
"objects": {
"icons/icon_16x16.png": {
"hash": "bdf48ef6b5d0d23bbb02e17d04865216179f510a",
"size": 3665
},
...
}
}
}
2013-12-10 06:12:52 +00:00
*/
2018-07-15 13:51:05 +01:00
QFile file(path);
2018-07-15 13:51:05 +01:00
// Try to open the file and fail if we can't.
// TODO: We should probably report this error to the user.
if (!file.open(QIODevice::ReadOnly)) {
qCritical() << "Failed to read assets index file" << path;
return false;
}
index.id = assetsId;
2018-07-15 13:51:05 +01:00
// Read the file and close it.
QByteArray jsonData = file.readAll();
file.close();
2018-07-15 13:51:05 +01:00
QJsonParseError parseError;
QJsonDocument jsonDoc = QJsonDocument::fromJson(jsonData, &parseError);
2018-07-15 13:51:05 +01:00
// Fail if the JSON is invalid.
if (parseError.error != QJsonParseError::NoError) {
qCritical() << "Failed to parse assets index file:" << parseError.errorString() << "at offset "
<< QString::number(parseError.offset);
return false;
}
2018-07-15 13:51:05 +01:00
// Make sure the root is an object.
if (!jsonDoc.isObject()) {
qCritical() << "Invalid assets index JSON: Root should be an array.";
return false;
}
2018-07-15 13:51:05 +01:00
QJsonObject root = jsonDoc.object();
2018-07-15 13:51:05 +01:00
QJsonValue isVirtual = root.value("virtual");
if (!isVirtual.isUndefined()) {
index.isVirtual = isVirtual.toBool(false);
}
QJsonValue mapToResources = root.value("map_to_resources");
if (!mapToResources.isUndefined()) {
index.mapToResources = mapToResources.toBool(false);
}
2018-07-15 13:51:05 +01:00
QJsonValue objects = root.value("objects");
QVariantMap map = objects.toVariant().toMap();
2018-07-15 13:51:05 +01:00
for (QVariantMap::const_iterator iter = map.begin(); iter != map.end(); ++iter) {
// qDebug() << iter.key();
2018-07-15 13:51:05 +01:00
QVariant variant = iter.value();
QVariantMap nested_objects = variant.toMap();
2018-07-15 13:51:05 +01:00
AssetObject object;
2018-07-15 13:51:05 +01:00
for (QVariantMap::const_iterator nested_iter = nested_objects.begin(); nested_iter != nested_objects.end(); ++nested_iter) {
// qDebug() << nested_iter.key() << nested_iter.value().toString();
QString key = nested_iter.key();
QVariant value = nested_iter.value();
2018-07-15 13:51:05 +01:00
if (key == "hash") {
object.hash = value.toString();
} else if (key == "size") {
object.size = value.toDouble();
}
}
2018-07-15 13:51:05 +01:00
index.objects.insert(iter.key(), object);
}
2018-07-15 13:51:05 +01:00
return true;
}
2015-01-27 21:31:07 +00:00
// FIXME: ugly code duplication
QDir getAssetsDir(const QString& assetsId, const QString& resourcesFolder)
2015-01-27 21:31:07 +00:00
{
QDir assetsDir = QDir("assets/");
2015-10-05 00:47:27 +01:00
QDir indexDir = QDir(FS::PathCombine(assetsDir.path(), "indexes"));
QDir objectDir = QDir(FS::PathCombine(assetsDir.path(), "objects"));
QDir virtualDir = QDir(FS::PathCombine(assetsDir.path(), "virtual"));
2018-07-15 13:51:05 +01:00
2015-10-05 00:47:27 +01:00
QString indexPath = FS::PathCombine(indexDir.path(), assetsId + ".json");
2015-01-27 21:31:07 +00:00
QFile indexFile(indexPath);
2015-10-05 00:47:27 +01:00
QDir virtualRoot(FS::PathCombine(virtualDir.path(), assetsId));
2018-07-15 13:51:05 +01:00
if (!indexFile.exists()) {
qCritical() << "No assets index file" << indexPath << "; can't determine assets path!";
2015-01-27 21:31:07 +00:00
return virtualRoot;
}
2018-07-15 13:51:05 +01:00
AssetsIndex index;
if (!AssetsUtils::loadAssetsIndexJson(assetsId, indexPath, index)) {
qCritical() << "Failed to load asset index file" << indexPath << "; can't determine assets path!";
return virtualRoot;
}
QString targetPath;
if (index.isVirtual) {
return virtualRoot;
} else if (index.mapToResources) {
return QDir(resourcesFolder);
}
return virtualRoot;
}
// FIXME: ugly code duplication
bool reconstructAssets(QString assetsId, QString resourcesFolder)
{
QDir assetsDir = QDir("assets/");
QDir indexDir = QDir(FS::PathCombine(assetsDir.path(), "indexes"));
QDir objectDir = QDir(FS::PathCombine(assetsDir.path(), "objects"));
QDir virtualDir = QDir(FS::PathCombine(assetsDir.path(), "virtual"));
QString indexPath = FS::PathCombine(indexDir.path(), assetsId + ".json");
QFile indexFile(indexPath);
QDir virtualRoot(FS::PathCombine(virtualDir.path(), assetsId));
if (!indexFile.exists()) {
qCritical() << "No assets index file" << indexPath << "; can't reconstruct assets!";
return false;
}
qDebug() << "reconstructAssets" << assetsDir.path() << indexDir.path() << objectDir.path() << virtualDir.path() << virtualRoot.path();
2018-07-15 13:51:05 +01:00
2015-01-27 21:31:07 +00:00
AssetsIndex index;
if (!AssetsUtils::loadAssetsIndexJson(assetsId, indexPath, index)) {
qCritical() << "Failed to load asset index file" << indexPath << "; can't reconstruct assets!";
return false;
}
2018-07-15 13:51:05 +01:00
QString targetPath;
bool removeLeftovers = false;
if (index.isVirtual) {
targetPath = virtualRoot.path();
removeLeftovers = true;
qDebug() << "Reconstructing virtual assets folder at" << targetPath;
} else if (index.mapToResources) {
targetPath = resourcesFolder;
qDebug() << "Reconstructing resources folder at" << targetPath;
}
2018-07-15 13:51:05 +01:00
if (!targetPath.isNull()) {
auto presentFiles = collectPathsFromDir(targetPath);
for (QString map : index.objects.keys()) {
2015-01-27 21:31:07 +00:00
AssetObject asset_object = index.objects.value(map);
QString target_path = FS::PathCombine(targetPath, map);
2015-01-27 21:31:07 +00:00
QFile target(target_path);
2018-07-15 13:51:05 +01:00
2015-01-27 21:31:07 +00:00
QString tlk = asset_object.hash.left(2);
2018-07-15 13:51:05 +01:00
2015-10-05 00:47:27 +01:00
QString original_path = FS::PathCombine(objectDir.path(), tlk, asset_object.hash);
2015-01-27 21:31:07 +00:00
QFile original(original_path);
if (!original.exists())
continue;
presentFiles.remove(target_path);
if (!target.exists()) {
2015-01-27 21:31:07 +00:00
QFileInfo info(target_path);
QDir target_dir = info.dir();
qDebug() << target_dir.path();
FS::ensureFolderPathExists(target_dir.path());
2018-07-15 13:51:05 +01:00
2015-01-27 21:31:07 +00:00
bool couldCopy = original.copy(target_path);
qDebug() << " Copying" << original_path << "to" << target_path << QString::number(couldCopy);
2015-01-27 21:31:07 +00:00
}
}
2018-07-15 13:51:05 +01:00
2015-01-27 21:31:07 +00:00
// TODO: Write last used time to virtualRoot/.lastused
if (removeLeftovers) {
for (auto& file : presentFiles) {
qDebug() << "Would remove" << file;
}
}
2015-01-27 21:31:07 +00:00
}
return true;
2015-01-27 21:31:07 +00:00
}
} // namespace AssetsUtils
NetAction::Ptr AssetObject::getDownloadAction()
{
QFileInfo objectFile(getLocalPath());
if ((!objectFile.isFile()) || (objectFile.size() != size)) {
auto objectDL = Net::ApiDownload::makeFile(getUrl(), objectFile.filePath());
if (hash.size()) {
auto rawHash = QByteArray::fromHex(hash.toLatin1());
objectDL->addValidator(new Net::ChecksumValidator(QCryptographicHash::Sha1, rawHash));
}
objectDL->setProgress(objectDL->getProgress(), size);
return objectDL;
}
return nullptr;
}
QString AssetObject::getLocalPath()
{
return "assets/objects/" + getRelPath();
}
QUrl AssetObject::getUrl()
{
return BuildConfig.RESOURCE_BASE + getRelPath();
}
QString AssetObject::getRelPath()
{
return hash.left(2) + "/" + hash;
}
NetJob::Ptr AssetsIndex::getDownloadJob()
{
auto job = makeShared<NetJob>(QObject::tr("Assets for %1").arg(id), APPLICATION->network());
for (auto& object : objects.values()) {
auto dl = object.getDownloadAction();
if (dl) {
job->addNetAction(dl);
}
}
if (job->size())
return job;
return nullptr;
}