0xf8/pollymc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

properly handle a currently running hashing task

Browse Source 
Signed-off-by: Rachel Powers <508861+Ryex@users.noreply.github.com>
This commit is contained in:
Rachel Powers 2022-11-11 15:45:40 -07:00
parent 5909af9878
commit 3f6cc17818
4 changed files with 94 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
launcher/modplatform/flame/FlameInstanceCreationTask.cpp
View File

@ -396,7 +396,7 @@ void FlameCreationTask::idResolverSucceeded(QEventLoop& loop)
tr("The following files are not available for download in third party launchers.<br/>"
"You will need to manually download them and add them to the instance.<br/><br/>"
"Your configured global mods folder and default downloads folder<br/>"
"are automatically checked for the downloaded mods.<br/>"
"are automatically checked for the downloaded mods and they will be copied to the instance if found.<br/>"
"Optionally, you may drag and drop the downloaded mods onto this dialog or add a folder to watch<br/>"
"if you did not download the mods to a default location."),
blocked_mods);

2
launcher/modplatform/modpacksch/FTBPackInstallTask.cpp
View File

@ -214,7 +214,7 @@ void PackInstallTask::onResolveModsSucceeded()
tr("The following files are not available for download in third party launchers.<br/>"
"You will need to manually download them and add them to the instance.<br/><br/>"
"Your configured global mods folder and default downloads folder<br/>"
"are automatically checked for the downloaded mods.<br/>"
"are automatically checked for the downloaded mods and they will be copied to the instance if found.<br/>"
"Optionally, you may drag and drop the downloaded mods onto this dialog or add a folder to watch<br/>"
"if you did not download the mods to a default location."),
m_blocked_mods);

113
launcher/ui/dialogs/BlockedModsDialog.cpp
View File

@ -1,4 +1,5 @@
#include "BlockedModsDialog.h"
#include <qfileinfo.h>
#include <QDesktopServices>
#include <QDialogButtonBox>
#include <QPushButton>
@ -13,9 +14,10 @@
#include <QFileInfo>
BlockedModsDialog::BlockedModsDialog(QWidget* parent, const QString& title, const QString& text, QList<BlockedMod>& mods)
: QDialog(parent), ui(new Ui::BlockedModsDialog), mods(mods)
: QDialog(parent), ui(new Ui::BlockedModsDialog), m_mods(mods)
{
hashing_task = shared_qobject_ptr<ConcurrentTask>(new ConcurrentTask(this, "MakeHashesTask", 10));
m_hashing_task = shared_qobject_ptr<ConcurrentTask>(new ConcurrentTask(this, "MakeHashesTask", 10));
connect(m_hashing_task.get(), &Task::finished, this, &BlockedModsDialog::hashTaskFinished);
ui->setupUi(this);
@ -25,11 +27,11 @@ BlockedModsDialog::BlockedModsDialog(QWidget* parent, const QString& title, cons
auto downloadFolderButton = ui->buttonBox->addButton(tr("Add Download Folder"), QDialogButtonBox::ActionRole);
connect(downloadFolderButton, &QPushButton::clicked, this, &BlockedModsDialog::addDownloadFolder);
connect(&watcher, &QFileSystemWatcher::directoryChanged, this, &BlockedModsDialog::directoryChanged);
connect(&m_watcher, &QFileSystemWatcher::directoryChanged, this, &BlockedModsDialog::directoryChanged);
qDebug() << "Mods List: " << mods;
qDebug() << "[Blocked Mods Dialog] Mods List: " << mods;
setupWatch();
scanPaths();
@ -57,16 +59,23 @@ void BlockedModsDialog::dragEnterEvent(QDragEnterEvent *e) {
void BlockedModsDialog::dropEvent(QDropEvent *e)
{
foreach (const QUrl &url, e->mimeData()->urls()) {
QString file = url.toLocalFile();
qDebug() << "Dropped file:" << file;
addHashTask(file);
QString filePath = url.toLocalFile();
qDebug() << "[Blocked Mods Dialog] Dropped file:" << filePath;
addHashTask(filePath);
// watch for changes
QFileInfo file = QFileInfo(filePath);
QString path = file.dir().absolutePath();
qDebug() << "[Blocked Mods Dialog] Adding watch path:" << path;
m_watcher.addPath(path);
}
hashing_task->start();
scanPaths();
update();
}
void BlockedModsDialog::openAll()
{
for (auto& mod : mods) {
for (auto& mod : m_mods) {
QDesktopServices::openUrl(mod.websiteUrl);
}
}
@ -77,8 +86,10 @@ void BlockedModsDialog::addDownloadFolder() {
tr("Select directory where you downloaded the mods"),
QStandardPaths::writableLocation(QStandardPaths::DownloadLocation),
QFileDialog::ShowDirsOnly);
watcher.addPath(dir);
scanPath(dir);
qDebug() << "[Blocked Mods Dialog] Adding watch path:" << dir;
m_watcher.addPath(dir);
scanPath(dir, true);
update();
}
/// @brief update UI with current status of the blocked mod detection
@ -87,7 +98,7 @@ void BlockedModsDialog::update()
QString text;
QString span;
for (auto& mod : mods) {
for (auto& mod : m_mods) {
if (mod.matched) {
// &#x2714; -> html for HEAVY CHECK MARK : ✔
span = QString(tr("<span style=\"color:green\"> &#x2714; Found at %1 </span>")).arg(mod.localPath);
@ -111,9 +122,9 @@ void BlockedModsDialog::update()
/// @param path the path to the changed directory
void BlockedModsDialog::directoryChanged(QString path)
{
qDebug() << "Directory changed: " << path;
qDebug() << "[Blocked Mods Dialog] Directory changed: " << path;
validateMatchedMods();
scanPath(path);
scanPath(path, true);
}
/// @brief add the user downloads folder and the global mods folder to the filesystem watcher
@ -121,22 +132,23 @@ void BlockedModsDialog::setupWatch()
{
const QString downloadsFolder = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
const QString modsFolder = APPLICATION->settings()->get("CentralModsDir").toString();
watcher.addPath(downloadsFolder);
watcher.addPath(modsFolder);
m_watcher.addPath(downloadsFolder);
m_watcher.addPath(modsFolder);
}
/// @brief scan all watched folder
void BlockedModsDialog::scanPaths()
{
for (auto& dir : watcher.directories()) {
scanPath(dir);
for (auto& dir : m_watcher.directories()) {
scanPath(dir, false);
}
runHashTask();
}
/// @brief Scan the directory at path, skip paths that do not contain a file name
/// of a blocked mod we are looking for
/// @param path the directory to scan
void BlockedModsDialog::scanPath(QString path)
void BlockedModsDialog::scanPath(QString path, bool start_task)
{
QDir scan_dir(path);
QDirIterator scan_it(path, QDir::Filter::Files | QDir::Filter::Hidden, QDirIterator::NoIteratorFlags);
@ -150,21 +162,35 @@ void BlockedModsDialog::scanPath(QString path)
addHashTask(file);
}
hashing_task->start();
if (start_task) {
runHashTask();
}
}
/// @brief add a hashing task for the file located at path, add the path to the pending set if the hasing task is already running
/// @param path the path to the local file being hashed
void BlockedModsDialog::addHashTask(QString path) {
if (m_hashing_task->isRunning()) {
qDebug() << "[Blocked Mods Dialog] adding a Hash task for" << path << "to the pending set.";
m_pending_hash_paths.insert(path);
} else {
buildHashTask(path);
}
}
/// @brief add a hashing task for the file located at path and connect it to check that hash against
/// our blocked mods list
/// @param path the path to the local file being hashed
void BlockedModsDialog::addHashTask(QString path) {
void BlockedModsDialog::buildHashTask(QString path) {
auto hash_task = Hashing::createBlockedModHasher(path, ModPlatform::Provider::FLAME, "sha1");
qDebug() << "Creating Hash task for path: " << path;
qDebug() << "[Blocked Mods Dialog] Creating Hash task for path: " << path;
connect(hash_task.get(), &Task::succeeded, [this, hash_task, path] { checkMatchHash(hash_task->getResult(), path); });
connect(hash_task.get(), &Task::failed, [path] { qDebug() << "Failed to hash path: " << path; });
hashing_task->addTask(hash_task);
m_hashing_task->addTask(hash_task);
}
/// @brief check if the computed hash for the provided path matches a blocked
@ -175,9 +201,9 @@ void BlockedModsDialog::checkMatchHash(QString hash, QString path)
{
bool match = false;
qDebug() << "Checking for match on hash: " << hash << "| From path:" << path;
qDebug() << "[Blocked Mods Dialog] Checking for match on hash: " << hash << "| From path:" << path;
for (auto& mod : mods) {
for (auto& mod : m_mods) {
if (mod.matched) {
continue;
}
@ -186,7 +212,7 @@ void BlockedModsDialog::checkMatchHash(QString hash, QString path)
mod.localPath = path;
match = true;
qDebug() << "Hash match found:" << mod.name << hash << "| From path:" << path;
qDebug() << "[Blocked Mods Dialog] Hash match found:" << mod.name << hash << "| From path:" << path;
break;
}
@ -205,9 +231,9 @@ bool BlockedModsDialog::checkValidPath(QString path)
QFileInfo file = QFileInfo(path);
QString filename = file.fileName();
for (auto& mod : mods) {
for (auto& mod : m_mods) {
if (mod.name.compare(filename, Qt::CaseInsensitive) == 0) {
qDebug() << "Name match found:" << mod.name << "| From path:" << path;
qDebug() << "[Blocked Mods Dialog] Name match found:" << mod.name << "| From path:" << path;
return true;
}
}
@ -217,13 +243,13 @@ bool BlockedModsDialog::checkValidPath(QString path)
bool BlockedModsDialog::allModsMatched()
{
return std::all_of(mods.begin(), mods.end(), [](auto const& mod) { return mod.matched; });
return std::all_of(m_mods.begin(), m_mods.end(), [](auto const& mod) { return mod.matched; });
}
/// @brief ensure matched file paths still exist
void BlockedModsDialog::validateMatchedMods() {
bool changed = false;
for (auto& mod : mods) {
for (auto& mod : m_mods) {
if (mod.matched) {
QFileInfo file = QFileInfo(mod.localPath);
if (!file.exists() || !file.isFile()) {
@ -238,6 +264,33 @@ void BlockedModsDialog::validateMatchedMods() {
}
}
/// @brief run hast task or mark a pending run if it is already runing
void BlockedModsDialog::runHashTask() {
if (!m_hashing_task->isRunning()) {
m_rehash_pending = false;
m_hashing_task->start();
} else {
qDebug() << "[Blocked Mods Dialog] queueing another run of the hashing task";
qDebug() << "[Blocked Mods Dialog] pending hash tasks:" << m_pending_hash_paths;
m_rehash_pending = true;
}
}
void BlockedModsDialog::hashTaskFinished() {
qDebug() << "[Blocked Mods Dialog] All hash tasks finished";
if (m_rehash_pending) {
qDebug() << "[Blocked Mods Dialog] there was a pending rehash, building and running tasks";
auto path = m_pending_hash_paths.begin();
while (path != m_pending_hash_paths.end()) {
buildHashTask(*path);
path = m_pending_hash_paths.erase(path);
}
runHashTask();
}
}
/// qDebug print support for the BlockedMod struct
QDebug operator<<(QDebug debug, const BlockedMod& m)
{

13
launcher/ui/dialogs/BlockedModsDialog.h
View File

@ -39,9 +39,11 @@ protected:
private:
Ui::BlockedModsDialog *ui;
QList<BlockedMod> &mods;
QFileSystemWatcher watcher;
shared_qobject_ptr<ConcurrentTask> hashing_task;
QList<BlockedMod> &m_mods;
QFileSystemWatcher m_watcher;
shared_qobject_ptr<ConcurrentTask> m_hashing_task;
QSet<QString> m_pending_hash_paths;
bool m_rehash_pending;
void openAll();
void addDownloadFolder();
@ -49,10 +51,13 @@ private:
void directoryChanged(QString path);
void setupWatch();
void scanPaths();
void scanPath(QString path);
void scanPath(QString path, bool start_task);
void addHashTask(QString path);
void buildHashTask(QString path);
void checkMatchHash(QString hash, QString path);
void validateMatchedMods();
void runHashTask();
void hashTaskFinished();
bool checkValidPath(QString path);
bool allModsMatched();