mirror of
https://github.com/PrismLauncher/PrismLauncher.git
synced 2025-04-29 22:24:26 +02:00
Refactor ResourcePack
Signed-off-by: Trial97 <alexandru.tripon97@gmail.com>
This commit is contained in:
parent
0b6ce5525d
commit
23ffc4d8b9
@ -35,8 +35,6 @@ class Version;
|
|||||||
class DataPack : public Resource {
|
class DataPack : public Resource {
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
using Ptr = shared_qobject_ptr<Resource>;
|
|
||||||
|
|
||||||
DataPack(QObject* parent = nullptr) : Resource(parent) {}
|
DataPack(QObject* parent = nullptr) : Resource(parent) {}
|
||||||
DataPack(QFileInfo file_info) : Resource(file_info) {}
|
DataPack(QFileInfo file_info) : Resource(file_info) {}
|
||||||
|
|
||||||
@ -59,6 +57,8 @@ class DataPack : public Resource {
|
|||||||
[[nodiscard]] int compare(Resource const& other, SortType type) const override;
|
[[nodiscard]] int compare(Resource const& other, SortType type) const override;
|
||||||
[[nodiscard]] bool applyFilter(QRegularExpression filter) const override;
|
[[nodiscard]] bool applyFilter(QRegularExpression filter) const override;
|
||||||
|
|
||||||
|
virtual QString directory() { return "/data"; }
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
mutable QMutex m_data_lock;
|
mutable QMutex m_data_lock;
|
||||||
|
|
||||||
|
@ -42,13 +42,6 @@ void ResourcePack::setPackFormat(int new_format_id)
|
|||||||
m_pack_format = new_format_id;
|
m_pack_format = new_format_id;
|
||||||
}
|
}
|
||||||
|
|
||||||
void ResourcePack::setDescription(QString new_description)
|
|
||||||
{
|
|
||||||
QMutexLocker locker(&m_data_lock);
|
|
||||||
|
|
||||||
m_description = new_description;
|
|
||||||
}
|
|
||||||
|
|
||||||
void ResourcePack::setImage(QImage new_image) const
|
void ResourcePack::setImage(QImage new_image) const
|
||||||
{
|
{
|
||||||
QMutexLocker locker(&m_data_lock);
|
QMutexLocker locker(&m_data_lock);
|
||||||
@ -90,7 +83,7 @@ QPixmap ResourcePack::image(QSize size, Qt::AspectRatioMode mode) const
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Imaged got evicted from the cache. Re-process it and retry.
|
// Imaged got evicted from the cache. Re-process it and retry.
|
||||||
ResourcePackUtils::processPackPNG(*this);
|
ResourcePackUtils::processPackPNG(this);
|
||||||
return image(size);
|
return image(size);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -102,44 +95,3 @@ std::pair<Version, Version> ResourcePack::compatibleVersions() const
|
|||||||
|
|
||||||
return s_pack_format_versions.constFind(m_pack_format).value();
|
return s_pack_format_versions.constFind(m_pack_format).value();
|
||||||
}
|
}
|
||||||
|
|
||||||
int ResourcePack::compare(const Resource& other, SortType type) const
|
|
||||||
{
|
|
||||||
auto const& cast_other = static_cast<ResourcePack const&>(other);
|
|
||||||
switch (type) {
|
|
||||||
default:
|
|
||||||
return Resource::compare(other, type);
|
|
||||||
case SortType::PACK_FORMAT: {
|
|
||||||
auto this_ver = packFormat();
|
|
||||||
auto other_ver = cast_other.packFormat();
|
|
||||||
|
|
||||||
if (this_ver > other_ver)
|
|
||||||
return 1;
|
|
||||||
if (this_ver < other_ver)
|
|
||||||
return -1;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool ResourcePack::applyFilter(QRegularExpression filter) const
|
|
||||||
{
|
|
||||||
if (filter.match(description()).hasMatch())
|
|
||||||
return true;
|
|
||||||
|
|
||||||
if (filter.match(QString::number(packFormat())).hasMatch())
|
|
||||||
return true;
|
|
||||||
|
|
||||||
if (filter.match(compatibleVersions().first.toString()).hasMatch())
|
|
||||||
return true;
|
|
||||||
if (filter.match(compatibleVersions().second.toString()).hasMatch())
|
|
||||||
return true;
|
|
||||||
|
|
||||||
return Resource::applyFilter(filter);
|
|
||||||
}
|
|
||||||
|
|
||||||
bool ResourcePack::valid() const
|
|
||||||
{
|
|
||||||
return m_pack_format != 0;
|
|
||||||
}
|
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include "Resource.h"
|
#include "Resource.h"
|
||||||
|
#include "minecraft/mod/DataPack.h"
|
||||||
|
|
||||||
#include <QImage>
|
#include <QImage>
|
||||||
#include <QMutex>
|
#include <QMutex>
|
||||||
@ -14,51 +15,27 @@ class Version;
|
|||||||
* Store localized descriptions
|
* Store localized descriptions
|
||||||
* */
|
* */
|
||||||
|
|
||||||
class ResourcePack : public Resource {
|
class ResourcePack : public DataPack {
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
using Ptr = shared_qobject_ptr<Resource>;
|
ResourcePack(QObject* parent = nullptr) : DataPack(parent) {}
|
||||||
|
ResourcePack(QFileInfo file_info) : DataPack(file_info) {}
|
||||||
|
|
||||||
ResourcePack(QObject* parent = nullptr) : Resource(parent) {}
|
|
||||||
ResourcePack(QFileInfo file_info) : Resource(file_info) {}
|
|
||||||
|
|
||||||
/** Gets the numerical ID of the pack format. */
|
|
||||||
[[nodiscard]] int packFormat() const { return m_pack_format; }
|
|
||||||
/** Gets, respectively, the lower and upper versions supported by the set pack format. */
|
/** Gets, respectively, the lower and upper versions supported by the set pack format. */
|
||||||
[[nodiscard]] std::pair<Version, Version> compatibleVersions() const;
|
[[nodiscard]] std::pair<Version, Version> compatibleVersions() const;
|
||||||
|
|
||||||
/** Gets the description of the resource pack. */
|
|
||||||
[[nodiscard]] QString description() const { return m_description; }
|
|
||||||
|
|
||||||
/** Gets the image of the resource pack, converted to a QPixmap for drawing, and scaled to size. */
|
/** Gets the image of the resource pack, converted to a QPixmap for drawing, and scaled to size. */
|
||||||
[[nodiscard]] QPixmap image(QSize size, Qt::AspectRatioMode mode = Qt::AspectRatioMode::IgnoreAspectRatio) const;
|
[[nodiscard]] QPixmap image(QSize size, Qt::AspectRatioMode mode = Qt::AspectRatioMode::IgnoreAspectRatio) const;
|
||||||
|
|
||||||
/** Thread-safe. */
|
|
||||||
void setPackFormat(int new_format_id);
|
|
||||||
|
|
||||||
/** Thread-safe. */
|
|
||||||
void setDescription(QString new_description);
|
|
||||||
|
|
||||||
/** Thread-safe. */
|
/** Thread-safe. */
|
||||||
void setImage(QImage new_image) const;
|
void setImage(QImage new_image) const;
|
||||||
|
|
||||||
bool valid() const override;
|
/** Thread-safe. */
|
||||||
|
void setPackFormat(int new_format_id);
|
||||||
|
|
||||||
[[nodiscard]] int compare(Resource const& other, SortType type) const override;
|
virtual QString directory() { return "/assets"; }
|
||||||
[[nodiscard]] bool applyFilter(QRegularExpression filter) const override;
|
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
mutable QMutex m_data_lock;
|
|
||||||
|
|
||||||
/* The 'version' of a resource pack, as defined in the pack.mcmeta file.
|
|
||||||
* See https://minecraft.wiki/w/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
|
|
||||||
*/
|
|
||||||
int m_pack_format = 0;
|
|
||||||
|
|
||||||
/** The resource pack's description, as defined in the pack.mcmeta file.
|
|
||||||
*/
|
|
||||||
QString m_description;
|
|
||||||
|
|
||||||
/** The resource pack's image file cache key, for access in the QPixmapCache global instance.
|
/** The resource pack's image file cache key, for access in the QPixmapCache global instance.
|
||||||
*
|
*
|
||||||
* The 'was_ever_used' state simply identifies whether the key was never inserted on the cache (true),
|
* The 'was_ever_used' state simply identifies whether the key was never inserted on the cache (true),
|
||||||
|
@ -44,7 +44,7 @@
|
|||||||
#include "Application.h"
|
#include "Application.h"
|
||||||
#include "Version.h"
|
#include "Version.h"
|
||||||
|
|
||||||
#include "minecraft/mod/tasks/LocalResourcePackParseTask.h"
|
#include "minecraft/mod/tasks/LocalDataPackParseTask.h"
|
||||||
|
|
||||||
ResourcePackFolderModel::ResourcePackFolderModel(const QDir& dir, BaseInstance* instance, bool is_indexed, bool create_dir, QObject* parent)
|
ResourcePackFolderModel::ResourcePackFolderModel(const QDir& dir, BaseInstance* instance, bool is_indexed, bool create_dir, QObject* parent)
|
||||||
: ResourceFolderModel(dir, instance, is_indexed, create_dir, parent)
|
: ResourceFolderModel(dir, instance, is_indexed, create_dir, parent)
|
||||||
@ -191,5 +191,5 @@ int ResourcePackFolderModel::columnCount(const QModelIndex& parent) const
|
|||||||
|
|
||||||
Task* ResourcePackFolderModel::createParseTask(Resource& resource)
|
Task* ResourcePackFolderModel::createParseTask(Resource& resource)
|
||||||
{
|
{
|
||||||
return new LocalResourcePackParseTask(m_next_resolution_ticket, static_cast<ResourcePack&>(resource));
|
return new LocalDataPackParseTask(m_next_resolution_ticket, dynamic_cast<ResourcePack*>(&resource));
|
||||||
}
|
}
|
||||||
|
@ -23,6 +23,8 @@
|
|||||||
|
|
||||||
#include "FileSystem.h"
|
#include "FileSystem.h"
|
||||||
#include "Json.h"
|
#include "Json.h"
|
||||||
|
#include "minecraft/mod/ResourcePack.h"
|
||||||
|
#include "minecraft/mod/tasks/LocalResourcePackParseTask.h"
|
||||||
|
|
||||||
#include <quazip/quazip.h>
|
#include <quazip/quazip.h>
|
||||||
#include <quazip/quazipdir.h>
|
#include <quazip/quazipdir.h>
|
||||||
@ -32,9 +34,9 @@
|
|||||||
|
|
||||||
namespace DataPackUtils {
|
namespace DataPackUtils {
|
||||||
|
|
||||||
bool process(DataPack& pack, ProcessingLevel level)
|
bool process(DataPack* pack, ProcessingLevel level)
|
||||||
{
|
{
|
||||||
switch (pack.type()) {
|
switch (pack->type()) {
|
||||||
case ResourceType::FOLDER:
|
case ResourceType::FOLDER:
|
||||||
return DataPackUtils::processFolder(pack, level);
|
return DataPackUtils::processFolder(pack, level);
|
||||||
case ResourceType::ZIPFILE:
|
case ResourceType::ZIPFILE:
|
||||||
@ -45,16 +47,16 @@ bool process(DataPack& pack, ProcessingLevel level)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
bool processFolder(DataPack& pack, ProcessingLevel level)
|
bool processFolder(DataPack* pack, ProcessingLevel level)
|
||||||
{
|
{
|
||||||
Q_ASSERT(pack.type() == ResourceType::FOLDER);
|
Q_ASSERT(pack->type() == ResourceType::FOLDER);
|
||||||
|
|
||||||
auto mcmeta_invalid = [&pack]() {
|
auto mcmeta_invalid = [&pack]() {
|
||||||
qWarning() << "Data pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
qWarning() << "Data pack at" << pack->fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
||||||
return false; // the mcmeta is not optional
|
return false; // the mcmeta is not optional
|
||||||
};
|
};
|
||||||
|
|
||||||
QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
|
QFileInfo mcmeta_file_info(FS::PathCombine(pack->fileinfo().filePath(), "pack.mcmeta"));
|
||||||
if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
|
if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
|
||||||
QFile mcmeta_file(mcmeta_file_info.filePath());
|
QFile mcmeta_file(mcmeta_file_info.filePath());
|
||||||
if (!mcmeta_file.open(QIODevice::ReadOnly))
|
if (!mcmeta_file.open(QIODevice::ReadOnly))
|
||||||
@ -72,7 +74,7 @@ bool processFolder(DataPack& pack, ProcessingLevel level)
|
|||||||
return mcmeta_invalid(); // mcmeta file isn't a valid file
|
return mcmeta_invalid(); // mcmeta file isn't a valid file
|
||||||
}
|
}
|
||||||
|
|
||||||
QFileInfo data_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "data"));
|
QFileInfo data_dir_info(FS::PathCombine(pack->fileinfo().filePath(), pack->directory()));
|
||||||
if (!data_dir_info.exists() || !data_dir_info.isDir()) {
|
if (!data_dir_info.exists() || !data_dir_info.isDir()) {
|
||||||
return false; // data dir does not exists or isn't valid
|
return false; // data dir does not exists or isn't valid
|
||||||
}
|
}
|
||||||
@ -80,22 +82,46 @@ bool processFolder(DataPack& pack, ProcessingLevel level)
|
|||||||
if (level == ProcessingLevel::BasicInfoOnly) {
|
if (level == ProcessingLevel::BasicInfoOnly) {
|
||||||
return true; // only need basic info already checked
|
return true; // only need basic info already checked
|
||||||
}
|
}
|
||||||
|
if (auto rp = dynamic_cast<ResourcePack*>(pack)) {
|
||||||
|
auto png_invalid = [&pack]() {
|
||||||
|
qWarning() << "Resource pack at" << pack->fileinfo().filePath() << "does not have a valid pack.png";
|
||||||
|
return true; // the png is optional
|
||||||
|
};
|
||||||
|
|
||||||
|
QFileInfo image_file_info(FS::PathCombine(pack->fileinfo().filePath(), "pack.png"));
|
||||||
|
if (image_file_info.exists() && image_file_info.isFile()) {
|
||||||
|
QFile pack_png_file(image_file_info.filePath());
|
||||||
|
if (!pack_png_file.open(QIODevice::ReadOnly))
|
||||||
|
return png_invalid(); // can't open pack.png file
|
||||||
|
|
||||||
|
auto data = pack_png_file.readAll();
|
||||||
|
|
||||||
|
bool pack_png_result = ResourcePackUtils::processPackPNG(rp, std::move(data));
|
||||||
|
|
||||||
|
pack_png_file.close();
|
||||||
|
if (!pack_png_result) {
|
||||||
|
return png_invalid(); // pack.png invalid
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return png_invalid(); // pack.png does not exists or is not a valid file.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return true; // all tests passed
|
return true; // all tests passed
|
||||||
}
|
}
|
||||||
|
|
||||||
bool processZIP(DataPack& pack, ProcessingLevel level)
|
bool processZIP(DataPack* pack, ProcessingLevel level)
|
||||||
{
|
{
|
||||||
Q_ASSERT(pack.type() == ResourceType::ZIPFILE);
|
Q_ASSERT(pack->type() == ResourceType::ZIPFILE);
|
||||||
|
|
||||||
QuaZip zip(pack.fileinfo().filePath());
|
QuaZip zip(pack->fileinfo().filePath());
|
||||||
if (!zip.open(QuaZip::mdUnzip))
|
if (!zip.open(QuaZip::mdUnzip))
|
||||||
return false; // can't open zip file
|
return false; // can't open zip file
|
||||||
|
|
||||||
QuaZipFile file(&zip);
|
QuaZipFile file(&zip);
|
||||||
|
|
||||||
auto mcmeta_invalid = [&pack]() {
|
auto mcmeta_invalid = [&pack]() {
|
||||||
qWarning() << "Data pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
qWarning() << "Data pack at" << pack->fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
||||||
return false; // the mcmeta is not optional
|
return false; // the mcmeta is not optional
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -119,7 +145,7 @@ bool processZIP(DataPack& pack, ProcessingLevel level)
|
|||||||
}
|
}
|
||||||
|
|
||||||
QuaZipDir zipDir(&zip);
|
QuaZipDir zipDir(&zip);
|
||||||
if (!zipDir.exists("/data")) {
|
if (!zipDir.exists(pack->directory())) {
|
||||||
return false; // data dir does not exists at zip root
|
return false; // data dir does not exists at zip root
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -127,21 +153,49 @@ bool processZIP(DataPack& pack, ProcessingLevel level)
|
|||||||
zip.close();
|
zip.close();
|
||||||
return true; // only need basic info already checked
|
return true; // only need basic info already checked
|
||||||
}
|
}
|
||||||
|
if (auto rp = dynamic_cast<ResourcePack*>(pack)) {
|
||||||
|
auto png_invalid = [&pack]() {
|
||||||
|
qWarning() << "Resource pack at" << pack->fileinfo().filePath() << "does not have a valid pack.png";
|
||||||
|
return true; // the png is optional
|
||||||
|
};
|
||||||
|
|
||||||
|
if (zip.setCurrentFile("pack.png")) {
|
||||||
|
if (!file.open(QIODevice::ReadOnly)) {
|
||||||
|
qCritical() << "Failed to open file in zip.";
|
||||||
|
zip.close();
|
||||||
|
return png_invalid();
|
||||||
|
}
|
||||||
|
|
||||||
|
auto data = file.readAll();
|
||||||
|
|
||||||
|
bool pack_png_result = ResourcePackUtils::processPackPNG(rp, std::move(data));
|
||||||
|
|
||||||
|
file.close();
|
||||||
|
zip.close();
|
||||||
|
if (!pack_png_result) {
|
||||||
|
return png_invalid(); // pack.png invalid
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
zip.close();
|
||||||
|
return png_invalid(); // could not set pack.mcmeta as current file.
|
||||||
|
}
|
||||||
|
}
|
||||||
zip.close();
|
zip.close();
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
// https://minecraft.wiki/w/Data_pack#pack.mcmeta
|
// https://minecraft.wiki/w/Data_pack#pack.mcmeta
|
||||||
bool processMCMeta(DataPack& pack, QByteArray&& raw_data)
|
// https://minecraft.wiki/w/Raw_JSON_text_format
|
||||||
|
// https://minecraft.wiki/w/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
|
||||||
|
bool processMCMeta(DataPack* pack, QByteArray&& raw_data)
|
||||||
{
|
{
|
||||||
try {
|
try {
|
||||||
auto json_doc = QJsonDocument::fromJson(raw_data);
|
auto json_doc = QJsonDocument::fromJson(raw_data);
|
||||||
auto pack_obj = Json::requireObject(json_doc.object(), "pack", {});
|
auto pack_obj = Json::requireObject(json_doc.object(), "pack", {});
|
||||||
|
|
||||||
pack.setPackFormat(Json::ensureInteger(pack_obj, "pack_format", 0));
|
pack->setPackFormat(Json::ensureInteger(pack_obj, "pack_format", 0));
|
||||||
pack.setDescription(Json::ensureString(pack_obj, "description", ""));
|
pack->setDescription(ResourcePackUtils::processComponent(pack_obj.value("description")));
|
||||||
} catch (Json::JsonException& e) {
|
} catch (Json::JsonException& e) {
|
||||||
qWarning() << "JsonException: " << e.what() << e.cause();
|
qWarning() << "JsonException: " << e.what() << e.cause();
|
||||||
return false;
|
return false;
|
||||||
@ -152,26 +206,19 @@ bool processMCMeta(DataPack& pack, QByteArray&& raw_data)
|
|||||||
bool validate(QFileInfo file)
|
bool validate(QFileInfo file)
|
||||||
{
|
{
|
||||||
DataPack dp{ file };
|
DataPack dp{ file };
|
||||||
return DataPackUtils::process(dp, ProcessingLevel::BasicInfoOnly) && dp.valid();
|
return DataPackUtils::process(&dp, ProcessingLevel::BasicInfoOnly) && dp.valid();
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace DataPackUtils
|
} // namespace DataPackUtils
|
||||||
|
|
||||||
LocalDataPackParseTask::LocalDataPackParseTask(int token, DataPack& dp) : Task(false), m_token(token), m_data_pack(dp) {}
|
LocalDataPackParseTask::LocalDataPackParseTask(int token, DataPack* dp) : Task(false), m_token(token), m_data_pack(dp) {}
|
||||||
|
|
||||||
bool LocalDataPackParseTask::abort()
|
|
||||||
{
|
|
||||||
m_aborted = true;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void LocalDataPackParseTask::executeTask()
|
void LocalDataPackParseTask::executeTask()
|
||||||
{
|
{
|
||||||
if (!DataPackUtils::process(m_data_pack))
|
if (!DataPackUtils::process(m_data_pack)) {
|
||||||
|
emitFailed("process failed");
|
||||||
return;
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
if (m_aborted)
|
emitSucceeded();
|
||||||
emitAborted();
|
|
||||||
else
|
|
||||||
emitSucceeded();
|
|
||||||
}
|
}
|
||||||
|
@ -32,12 +32,12 @@ namespace DataPackUtils {
|
|||||||
|
|
||||||
enum class ProcessingLevel { Full, BasicInfoOnly };
|
enum class ProcessingLevel { Full, BasicInfoOnly };
|
||||||
|
|
||||||
bool process(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
bool process(DataPack* pack, ProcessingLevel level = ProcessingLevel::Full);
|
||||||
|
|
||||||
bool processZIP(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
bool processZIP(DataPack* pack, ProcessingLevel level = ProcessingLevel::Full);
|
||||||
bool processFolder(DataPack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
bool processFolder(DataPack* pack, ProcessingLevel level = ProcessingLevel::Full);
|
||||||
|
|
||||||
bool processMCMeta(DataPack& pack, QByteArray&& raw_data);
|
bool processMCMeta(DataPack* pack, QByteArray&& raw_data);
|
||||||
|
|
||||||
/** Checks whether a file is valid as a data pack or not. */
|
/** Checks whether a file is valid as a data pack or not. */
|
||||||
bool validate(QFileInfo file);
|
bool validate(QFileInfo file);
|
||||||
@ -47,10 +47,7 @@ bool validate(QFileInfo file);
|
|||||||
class LocalDataPackParseTask : public Task {
|
class LocalDataPackParseTask : public Task {
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
LocalDataPackParseTask(int token, DataPack& dp);
|
LocalDataPackParseTask(int token, DataPack* dp);
|
||||||
|
|
||||||
[[nodiscard]] bool canAbort() const override { return true; }
|
|
||||||
bool abort() override;
|
|
||||||
|
|
||||||
void executeTask() override;
|
void executeTask() override;
|
||||||
|
|
||||||
@ -59,7 +56,5 @@ class LocalDataPackParseTask : public Task {
|
|||||||
private:
|
private:
|
||||||
int m_token;
|
int m_token;
|
||||||
|
|
||||||
DataPack& m_data_pack;
|
DataPack* m_data_pack;
|
||||||
|
|
||||||
bool m_aborted = false;
|
|
||||||
};
|
};
|
||||||
|
@ -20,6 +20,7 @@
|
|||||||
|
|
||||||
#include "FileSystem.h"
|
#include "FileSystem.h"
|
||||||
#include "Json.h"
|
#include "Json.h"
|
||||||
|
#include "minecraft/mod/tasks/LocalDataPackParseTask.h"
|
||||||
|
|
||||||
#include <quazip/quazip.h>
|
#include <quazip/quazip.h>
|
||||||
#include <quazip/quazipdir.h>
|
#include <quazip/quazipdir.h>
|
||||||
@ -29,155 +30,6 @@
|
|||||||
|
|
||||||
namespace ResourcePackUtils {
|
namespace ResourcePackUtils {
|
||||||
|
|
||||||
bool process(ResourcePack& pack, ProcessingLevel level)
|
|
||||||
{
|
|
||||||
switch (pack.type()) {
|
|
||||||
case ResourceType::FOLDER:
|
|
||||||
return ResourcePackUtils::processFolder(pack, level);
|
|
||||||
case ResourceType::ZIPFILE:
|
|
||||||
return ResourcePackUtils::processZIP(pack, level);
|
|
||||||
default:
|
|
||||||
qWarning() << "Invalid type for resource pack parse task!";
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
bool processFolder(ResourcePack& pack, ProcessingLevel level)
|
|
||||||
{
|
|
||||||
Q_ASSERT(pack.type() == ResourceType::FOLDER);
|
|
||||||
|
|
||||||
auto mcmeta_invalid = [&pack]() {
|
|
||||||
qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
|
||||||
return false; // the mcmeta is not optional
|
|
||||||
};
|
|
||||||
|
|
||||||
QFileInfo mcmeta_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.mcmeta"));
|
|
||||||
if (mcmeta_file_info.exists() && mcmeta_file_info.isFile()) {
|
|
||||||
QFile mcmeta_file(mcmeta_file_info.filePath());
|
|
||||||
if (!mcmeta_file.open(QIODevice::ReadOnly))
|
|
||||||
return mcmeta_invalid(); // can't open mcmeta file
|
|
||||||
|
|
||||||
auto data = mcmeta_file.readAll();
|
|
||||||
|
|
||||||
bool mcmeta_result = ResourcePackUtils::processMCMeta(pack, std::move(data));
|
|
||||||
|
|
||||||
mcmeta_file.close();
|
|
||||||
if (!mcmeta_result) {
|
|
||||||
return mcmeta_invalid(); // mcmeta invalid
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return mcmeta_invalid(); // mcmeta file isn't a valid file
|
|
||||||
}
|
|
||||||
|
|
||||||
QFileInfo assets_dir_info(FS::PathCombine(pack.fileinfo().filePath(), "assets"));
|
|
||||||
if (!assets_dir_info.exists() || !assets_dir_info.isDir()) {
|
|
||||||
return false; // assets dir does not exists or isn't valid
|
|
||||||
}
|
|
||||||
|
|
||||||
if (level == ProcessingLevel::BasicInfoOnly) {
|
|
||||||
return true; // only need basic info already checked
|
|
||||||
}
|
|
||||||
|
|
||||||
auto png_invalid = [&pack]() {
|
|
||||||
qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.png";
|
|
||||||
return true; // the png is optional
|
|
||||||
};
|
|
||||||
|
|
||||||
QFileInfo image_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.png"));
|
|
||||||
if (image_file_info.exists() && image_file_info.isFile()) {
|
|
||||||
QFile pack_png_file(image_file_info.filePath());
|
|
||||||
if (!pack_png_file.open(QIODevice::ReadOnly))
|
|
||||||
return png_invalid(); // can't open pack.png file
|
|
||||||
|
|
||||||
auto data = pack_png_file.readAll();
|
|
||||||
|
|
||||||
bool pack_png_result = ResourcePackUtils::processPackPNG(pack, std::move(data));
|
|
||||||
|
|
||||||
pack_png_file.close();
|
|
||||||
if (!pack_png_result) {
|
|
||||||
return png_invalid(); // pack.png invalid
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return png_invalid(); // pack.png does not exists or is not a valid file.
|
|
||||||
}
|
|
||||||
|
|
||||||
return true; // all tests passed
|
|
||||||
}
|
|
||||||
|
|
||||||
bool processZIP(ResourcePack& pack, ProcessingLevel level)
|
|
||||||
{
|
|
||||||
Q_ASSERT(pack.type() == ResourceType::ZIPFILE);
|
|
||||||
|
|
||||||
QuaZip zip(pack.fileinfo().filePath());
|
|
||||||
if (!zip.open(QuaZip::mdUnzip))
|
|
||||||
return false; // can't open zip file
|
|
||||||
|
|
||||||
QuaZipFile file(&zip);
|
|
||||||
|
|
||||||
auto mcmeta_invalid = [&pack]() {
|
|
||||||
qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.mcmeta";
|
|
||||||
return false; // the mcmeta is not optional
|
|
||||||
};
|
|
||||||
|
|
||||||
if (zip.setCurrentFile("pack.mcmeta")) {
|
|
||||||
if (!file.open(QIODevice::ReadOnly)) {
|
|
||||||
qCritical() << "Failed to open file in zip.";
|
|
||||||
zip.close();
|
|
||||||
return mcmeta_invalid();
|
|
||||||
}
|
|
||||||
|
|
||||||
auto data = file.readAll();
|
|
||||||
|
|
||||||
bool mcmeta_result = ResourcePackUtils::processMCMeta(pack, std::move(data));
|
|
||||||
|
|
||||||
file.close();
|
|
||||||
if (!mcmeta_result) {
|
|
||||||
return mcmeta_invalid(); // mcmeta invalid
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
return mcmeta_invalid(); // could not set pack.mcmeta as current file.
|
|
||||||
}
|
|
||||||
|
|
||||||
QuaZipDir zipDir(&zip);
|
|
||||||
if (!zipDir.exists("/assets")) {
|
|
||||||
return false; // assets dir does not exists at zip root
|
|
||||||
}
|
|
||||||
|
|
||||||
if (level == ProcessingLevel::BasicInfoOnly) {
|
|
||||||
zip.close();
|
|
||||||
return true; // only need basic info already checked
|
|
||||||
}
|
|
||||||
|
|
||||||
auto png_invalid = [&pack]() {
|
|
||||||
qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.png";
|
|
||||||
return true; // the png is optional
|
|
||||||
};
|
|
||||||
|
|
||||||
if (zip.setCurrentFile("pack.png")) {
|
|
||||||
if (!file.open(QIODevice::ReadOnly)) {
|
|
||||||
qCritical() << "Failed to open file in zip.";
|
|
||||||
zip.close();
|
|
||||||
return png_invalid();
|
|
||||||
}
|
|
||||||
|
|
||||||
auto data = file.readAll();
|
|
||||||
|
|
||||||
bool pack_png_result = ResourcePackUtils::processPackPNG(pack, std::move(data));
|
|
||||||
|
|
||||||
file.close();
|
|
||||||
zip.close();
|
|
||||||
if (!pack_png_result) {
|
|
||||||
return png_invalid(); // pack.png invalid
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
zip.close();
|
|
||||||
return png_invalid(); // could not set pack.mcmeta as current file.
|
|
||||||
}
|
|
||||||
|
|
||||||
zip.close();
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
QString buildStyle(const QJsonObject& obj)
|
QString buildStyle(const QJsonObject& obj)
|
||||||
{
|
{
|
||||||
QStringList styles;
|
QStringList styles;
|
||||||
@ -259,30 +111,11 @@ QString processComponent(const QJsonValue& value, bool strikethrough, bool under
|
|||||||
return {};
|
return {};
|
||||||
}
|
}
|
||||||
|
|
||||||
// https://minecraft.wiki/w/Raw_JSON_text_format
|
bool processPackPNG(const ResourcePack* pack, QByteArray&& raw_data)
|
||||||
// https://minecraft.wiki/w/Tutorials/Creating_a_resource_pack#Formatting_pack.mcmeta
|
|
||||||
bool processMCMeta(ResourcePack& pack, QByteArray&& raw_data)
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
auto json_doc = QJsonDocument::fromJson(raw_data);
|
|
||||||
auto pack_obj = Json::requireObject(json_doc.object(), "pack", {});
|
|
||||||
|
|
||||||
pack.setPackFormat(Json::ensureInteger(pack_obj, "pack_format", 0));
|
|
||||||
|
|
||||||
pack.setDescription(processComponent(pack_obj.value("description")));
|
|
||||||
|
|
||||||
} catch (Json::JsonException& e) {
|
|
||||||
qWarning() << "JsonException: " << e.what() << e.cause();
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool processPackPNG(const ResourcePack& pack, QByteArray&& raw_data)
|
|
||||||
{
|
{
|
||||||
auto img = QImage::fromData(raw_data);
|
auto img = QImage::fromData(raw_data);
|
||||||
if (!img.isNull()) {
|
if (!img.isNull()) {
|
||||||
pack.setImage(img);
|
pack->setImage(img);
|
||||||
} else {
|
} else {
|
||||||
qWarning() << "Failed to parse pack.png.";
|
qWarning() << "Failed to parse pack.png.";
|
||||||
return false;
|
return false;
|
||||||
@ -290,16 +123,16 @@ bool processPackPNG(const ResourcePack& pack, QByteArray&& raw_data)
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool processPackPNG(const ResourcePack& pack)
|
bool processPackPNG(const ResourcePack* pack)
|
||||||
{
|
{
|
||||||
auto png_invalid = [&pack]() {
|
auto png_invalid = [&pack]() {
|
||||||
qWarning() << "Resource pack at" << pack.fileinfo().filePath() << "does not have a valid pack.png";
|
qWarning() << "Resource pack at" << pack->fileinfo().filePath() << "does not have a valid pack.png";
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
|
||||||
switch (pack.type()) {
|
switch (pack->type()) {
|
||||||
case ResourceType::FOLDER: {
|
case ResourceType::FOLDER: {
|
||||||
QFileInfo image_file_info(FS::PathCombine(pack.fileinfo().filePath(), "pack.png"));
|
QFileInfo image_file_info(FS::PathCombine(pack->fileinfo().filePath(), "pack.png"));
|
||||||
if (image_file_info.exists() && image_file_info.isFile()) {
|
if (image_file_info.exists() && image_file_info.isFile()) {
|
||||||
QFile pack_png_file(image_file_info.filePath());
|
QFile pack_png_file(image_file_info.filePath());
|
||||||
if (!pack_png_file.open(QIODevice::ReadOnly))
|
if (!pack_png_file.open(QIODevice::ReadOnly))
|
||||||
@ -319,7 +152,7 @@ bool processPackPNG(const ResourcePack& pack)
|
|||||||
return false; // not processed correctly; https://github.com/PrismLauncher/PrismLauncher/issues/1740
|
return false; // not processed correctly; https://github.com/PrismLauncher/PrismLauncher/issues/1740
|
||||||
}
|
}
|
||||||
case ResourceType::ZIPFILE: {
|
case ResourceType::ZIPFILE: {
|
||||||
QuaZip zip(pack.fileinfo().filePath());
|
QuaZip zip(pack->fileinfo().filePath());
|
||||||
if (!zip.open(QuaZip::mdUnzip))
|
if (!zip.open(QuaZip::mdUnzip))
|
||||||
return false; // can't open zip file
|
return false; // can't open zip file
|
||||||
|
|
||||||
@ -353,28 +186,7 @@ bool processPackPNG(const ResourcePack& pack)
|
|||||||
bool validate(QFileInfo file)
|
bool validate(QFileInfo file)
|
||||||
{
|
{
|
||||||
ResourcePack rp{ file };
|
ResourcePack rp{ file };
|
||||||
return ResourcePackUtils::process(rp, ProcessingLevel::BasicInfoOnly) && rp.valid();
|
return DataPackUtils::process(&rp, DataPackUtils::ProcessingLevel::BasicInfoOnly) && rp.valid();
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace ResourcePackUtils
|
} // namespace ResourcePackUtils
|
||||||
|
|
||||||
LocalResourcePackParseTask::LocalResourcePackParseTask(int token, ResourcePack& rp) : Task(false), m_token(token), m_resource_pack(rp) {}
|
|
||||||
|
|
||||||
bool LocalResourcePackParseTask::abort()
|
|
||||||
{
|
|
||||||
m_aborted = true;
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void LocalResourcePackParseTask::executeTask()
|
|
||||||
{
|
|
||||||
if (!ResourcePackUtils::process(m_resource_pack)) {
|
|
||||||
emitFailed("this is not a resource pack");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (m_aborted)
|
|
||||||
emitAborted();
|
|
||||||
else
|
|
||||||
emitSucceeded();
|
|
||||||
}
|
|
||||||
|
@ -23,44 +23,14 @@
|
|||||||
|
|
||||||
#include "minecraft/mod/ResourcePack.h"
|
#include "minecraft/mod/ResourcePack.h"
|
||||||
|
|
||||||
#include "tasks/Task.h"
|
|
||||||
|
|
||||||
namespace ResourcePackUtils {
|
namespace ResourcePackUtils {
|
||||||
|
|
||||||
enum class ProcessingLevel { Full, BasicInfoOnly };
|
|
||||||
|
|
||||||
bool process(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
|
||||||
|
|
||||||
bool processZIP(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
|
||||||
bool processFolder(ResourcePack& pack, ProcessingLevel level = ProcessingLevel::Full);
|
|
||||||
|
|
||||||
QString processComponent(const QJsonValue& value, bool strikethrough = false, bool underline = false);
|
QString processComponent(const QJsonValue& value, bool strikethrough = false, bool underline = false);
|
||||||
bool processMCMeta(ResourcePack& pack, QByteArray&& raw_data);
|
bool processPackPNG(const ResourcePack* pack, QByteArray&& raw_data);
|
||||||
bool processPackPNG(const ResourcePack& pack, QByteArray&& raw_data);
|
|
||||||
|
|
||||||
/// processes ONLY the pack.png (rest of the pack may be invalid)
|
/// processes ONLY the pack.png (rest of the pack may be invalid)
|
||||||
bool processPackPNG(const ResourcePack& pack);
|
bool processPackPNG(const ResourcePack* pack);
|
||||||
|
|
||||||
/** Checks whether a file is valid as a resource pack or not. */
|
/** Checks whether a file is valid as a resource pack or not. */
|
||||||
bool validate(QFileInfo file);
|
bool validate(QFileInfo file);
|
||||||
} // namespace ResourcePackUtils
|
} // namespace ResourcePackUtils
|
||||||
|
|
||||||
class LocalResourcePackParseTask : public Task {
|
|
||||||
Q_OBJECT
|
|
||||||
public:
|
|
||||||
LocalResourcePackParseTask(int token, ResourcePack& rp);
|
|
||||||
|
|
||||||
[[nodiscard]] bool canAbort() const override { return true; }
|
|
||||||
bool abort() override;
|
|
||||||
|
|
||||||
void executeTask() override;
|
|
||||||
|
|
||||||
[[nodiscard]] int token() const { return m_token; }
|
|
||||||
|
|
||||||
private:
|
|
||||||
int m_token;
|
|
||||||
|
|
||||||
ResourcePack& m_resource_pack;
|
|
||||||
|
|
||||||
bool m_aborted = false;
|
|
||||||
};
|
|
||||||
|
@ -180,8 +180,10 @@ bool LocalWorldSaveParseTask::abort()
|
|||||||
|
|
||||||
void LocalWorldSaveParseTask::executeTask()
|
void LocalWorldSaveParseTask::executeTask()
|
||||||
{
|
{
|
||||||
if (!WorldSaveUtils::process(m_save))
|
if (!WorldSaveUtils::process(m_save)) {
|
||||||
|
emitFailed("this is not a world");
|
||||||
return;
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
if (m_aborted)
|
if (m_aborted)
|
||||||
emitAborted();
|
emitAborted();
|
||||||
|
@ -38,7 +38,7 @@ class DataPackParseTest : public QObject {
|
|||||||
QString zip_dp = FS::PathCombine(source, "test_data_pack_boogaloo.zip");
|
QString zip_dp = FS::PathCombine(source, "test_data_pack_boogaloo.zip");
|
||||||
DataPack pack{ QFileInfo(zip_dp) };
|
DataPack pack{ QFileInfo(zip_dp) };
|
||||||
|
|
||||||
bool valid = DataPackUtils::processZIP(pack);
|
bool valid = DataPackUtils::processZIP(&pack);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 4);
|
QVERIFY(pack.packFormat() == 4);
|
||||||
QVERIFY(pack.description() == "Some data pack 2 boobgaloo");
|
QVERIFY(pack.description() == "Some data pack 2 boobgaloo");
|
||||||
@ -52,7 +52,7 @@ class DataPackParseTest : public QObject {
|
|||||||
QString folder_dp = FS::PathCombine(source, "test_folder");
|
QString folder_dp = FS::PathCombine(source, "test_folder");
|
||||||
DataPack pack{ QFileInfo(folder_dp) };
|
DataPack pack{ QFileInfo(folder_dp) };
|
||||||
|
|
||||||
bool valid = DataPackUtils::processFolder(pack);
|
bool valid = DataPackUtils::processFolder(&pack);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 10);
|
QVERIFY(pack.packFormat() == 10);
|
||||||
QVERIFY(pack.description() == "Some data pack, maybe");
|
QVERIFY(pack.description() == "Some data pack, maybe");
|
||||||
@ -66,7 +66,7 @@ class DataPackParseTest : public QObject {
|
|||||||
QString folder_dp = FS::PathCombine(source, "another_test_folder");
|
QString folder_dp = FS::PathCombine(source, "another_test_folder");
|
||||||
DataPack pack{ QFileInfo(folder_dp) };
|
DataPack pack{ QFileInfo(folder_dp) };
|
||||||
|
|
||||||
bool valid = DataPackUtils::process(pack);
|
bool valid = DataPackUtils::process(&pack);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 6);
|
QVERIFY(pack.packFormat() == 6);
|
||||||
QVERIFY(pack.description() == "Some data pack three, leaves on the tree");
|
QVERIFY(pack.description() == "Some data pack three, leaves on the tree");
|
||||||
|
@ -18,6 +18,7 @@
|
|||||||
|
|
||||||
#include <QTest>
|
#include <QTest>
|
||||||
#include <QTimer>
|
#include <QTimer>
|
||||||
|
#include "minecraft/mod/tasks/LocalDataPackParseTask.h"
|
||||||
|
|
||||||
#include <FileSystem.h>
|
#include <FileSystem.h>
|
||||||
|
|
||||||
@ -35,7 +36,7 @@ class ResourcePackParseTest : public QObject {
|
|||||||
QString zip_rp = FS::PathCombine(source, "test_resource_pack_idk.zip");
|
QString zip_rp = FS::PathCombine(source, "test_resource_pack_idk.zip");
|
||||||
ResourcePack pack{ QFileInfo(zip_rp) };
|
ResourcePack pack{ QFileInfo(zip_rp) };
|
||||||
|
|
||||||
bool valid = ResourcePackUtils::processZIP(pack, ResourcePackUtils::ProcessingLevel::BasicInfoOnly);
|
bool valid = DataPackUtils::processZIP(&pack, DataPackUtils::ProcessingLevel::BasicInfoOnly);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 3);
|
QVERIFY(pack.packFormat() == 3);
|
||||||
QVERIFY(pack.description() ==
|
QVERIFY(pack.description() ==
|
||||||
@ -51,7 +52,7 @@ class ResourcePackParseTest : public QObject {
|
|||||||
QString folder_rp = FS::PathCombine(source, "test_folder");
|
QString folder_rp = FS::PathCombine(source, "test_folder");
|
||||||
ResourcePack pack{ QFileInfo(folder_rp) };
|
ResourcePack pack{ QFileInfo(folder_rp) };
|
||||||
|
|
||||||
bool valid = ResourcePackUtils::processFolder(pack, ResourcePackUtils::ProcessingLevel::BasicInfoOnly);
|
bool valid = DataPackUtils::processFolder(&pack, DataPackUtils::ProcessingLevel::BasicInfoOnly);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 1);
|
QVERIFY(pack.packFormat() == 1);
|
||||||
QVERIFY(pack.description() == "Some resource pack maybe");
|
QVERIFY(pack.description() == "Some resource pack maybe");
|
||||||
@ -65,7 +66,7 @@ class ResourcePackParseTest : public QObject {
|
|||||||
QString folder_rp = FS::PathCombine(source, "another_test_folder");
|
QString folder_rp = FS::PathCombine(source, "another_test_folder");
|
||||||
ResourcePack pack{ QFileInfo(folder_rp) };
|
ResourcePack pack{ QFileInfo(folder_rp) };
|
||||||
|
|
||||||
bool valid = ResourcePackUtils::process(pack, ResourcePackUtils::ProcessingLevel::BasicInfoOnly);
|
bool valid = DataPackUtils::process(&pack, DataPackUtils::ProcessingLevel::BasicInfoOnly);
|
||||||
|
|
||||||
QVERIFY(pack.packFormat() == 6);
|
QVERIFY(pack.packFormat() == 6);
|
||||||
QVERIFY(pack.description() == "o quartel pegou fogo, policia deu sinal, acode acode acode a bandeira nacional");
|
QVERIFY(pack.description() == "o quartel pegou fogo, policia deu sinal, acode acode acode a bandeira nacional");
|
||||||
|
Loading…
x
Reference in New Issue
Block a user