Merge pull request #505 from flowln/improve_download_ux

This commit is contained in:
Sefa Eyeoglu 2022-05-30 13:41:02 +02:00 committed by GitHub
commit 9054ee18a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 178 additions and 146 deletions

View File

@ -33,11 +33,22 @@ void SequentialTask::executeTask()
bool SequentialTask::abort() bool SequentialTask::abort()
{ {
bool succeeded = true; if(m_currentIndex == -1 || m_currentIndex >= m_queue.size()) {
for (auto& task : m_queue) { if(m_currentIndex == -1) {
if (!task->abort()) succeeded = false; // Don't call emitAborted() here, we want to bypass the 'is the task running' check
emit aborted();
emit finished();
}
m_queue.clear();
return true;
} }
bool succeeded = m_queue[m_currentIndex]->abort();
m_queue.clear();
if(succeeded)
emitAborted();
return succeeded; return succeeded;
} }
@ -76,7 +87,7 @@ void SequentialTask::subTaskProgress(qint64 current, qint64 total)
setProgress(0, 100); setProgress(0, 100);
return; return;
} }
setProgress(m_currentIndex, m_queue.count()); setProgress(m_currentIndex + 1, m_queue.count());
m_stepProgress = current; m_stepProgress = current;
m_stepTotalProgress = total; m_stepTotalProgress = total;

View File

@ -77,18 +77,20 @@ void ModDownloadDialog::confirm()
auto keys = modTask.keys(); auto keys = modTask.keys();
keys.sort(Qt::CaseInsensitive); keys.sort(Qt::CaseInsensitive);
auto confirm_dialog = ReviewMessageBox::create( auto confirm_dialog = ReviewMessageBox::create(this, tr("Confirm mods to download"));
this,
tr("Confirm mods to download")
);
for(auto& task : keys){ for (auto& task : keys) {
confirm_dialog->appendMod(task, modTask.find(task).value()->getFilename()); confirm_dialog->appendMod({ task, modTask.find(task).value()->getFilename() });
} }
connect(confirm_dialog, &QDialog::accepted, this, &ModDownloadDialog::accept); if (confirm_dialog->exec()) {
auto deselected = confirm_dialog->deselectedMods();
for (auto name : deselected) {
modTask.remove(name);
}
confirm_dialog->open(); this->accept();
}
} }
void ModDownloadDialog::accept() void ModDownloadDialog::accept()
@ -132,6 +134,12 @@ bool ModDownloadDialog::isModSelected(const QString &name, const QString& filena
return iter != modTask.end() && (iter.value()->getFilename() == filename); return iter != modTask.end() && (iter.value()->getFilename() == filename);
} }
bool ModDownloadDialog::isModSelected(const QString &name) const
{
auto iter = modTask.find(name);
return iter != modTask.end();
}
ModDownloadDialog::~ModDownloadDialog() ModDownloadDialog::~ModDownloadDialog()
{ {
} }

View File

@ -32,6 +32,7 @@ public:
void addSelectedMod(const QString & name = QString(), ModDownloadTask * task = nullptr); void addSelectedMod(const QString & name = QString(), ModDownloadTask * task = nullptr);
void removeSelectedMod(const QString & name = QString()); void removeSelectedMod(const QString & name = QString());
bool isModSelected(const QString & name, const QString & filename) const; bool isModSelected(const QString & name, const QString & filename) const;
bool isModSelected(const QString & name) const;
const QList<ModDownloadTask*> getTasks(); const QList<ModDownloadTask*> getTasks();
const std::shared_ptr<ModFolderModel> &mods; const std::shared_ptr<ModFolderModel> &mods;
@ -41,8 +42,6 @@ public slots:
void accept() override; void accept() override;
void reject() override; void reject() override;
//private slots:
private: private:
Ui::ModDownloadDialog *ui = nullptr; Ui::ModDownloadDialog *ui = nullptr;
PageContainer * m_container = nullptr; PageContainer * m_container = nullptr;

View File

@ -16,12 +16,12 @@
#include "ProgressDialog.h" #include "ProgressDialog.h"
#include "ui_ProgressDialog.h" #include "ui_ProgressDialog.h"
#include <QKeyEvent>
#include <QDebug> #include <QDebug>
#include <QKeyEvent>
#include "tasks/Task.h" #include "tasks/Task.h"
ProgressDialog::ProgressDialog(QWidget *parent) : QDialog(parent), ui(new Ui::ProgressDialog) ProgressDialog::ProgressDialog(QWidget* parent) : QDialog(parent), ui(new Ui::ProgressDialog)
{ {
ui->setupUi(this); ui->setupUi(this);
this->setWindowFlags(this->windowFlags() & ~Qt::WindowContextHelpButtonHint); this->setWindowFlags(this->windowFlags() & ~Qt::WindowContextHelpButtonHint);
@ -44,6 +44,7 @@ void ProgressDialog::on_skipButton_clicked(bool checked)
{ {
Q_UNUSED(checked); Q_UNUSED(checked);
task->abort(); task->abort();
QDialog::reject();
} }
ProgressDialog::~ProgressDialog() ProgressDialog::~ProgressDialog()
@ -53,24 +54,22 @@ ProgressDialog::~ProgressDialog()
void ProgressDialog::updateSize() void ProgressDialog::updateSize()
{ {
QSize qSize = QSize(480, minimumSizeHint().height()); QSize qSize = QSize(480, minimumSizeHint().height());
resize(qSize); resize(qSize);
setFixedSize(qSize); setFixedSize(qSize);
} }
int ProgressDialog::execWithTask(Task *task) int ProgressDialog::execWithTask(Task* task)
{ {
this->task = task; this->task = task;
QDialog::DialogCode result; QDialog::DialogCode result;
if(!task) if (!task) {
{
qDebug() << "Programmer error: progress dialog created with null task."; qDebug() << "Programmer error: progress dialog created with null task.";
return Accepted; return Accepted;
} }
if(handleImmediateResult(result)) if (handleImmediateResult(result)) {
{
return result; return result;
} }
@ -78,58 +77,51 @@ int ProgressDialog::execWithTask(Task *task)
connect(task, SIGNAL(started()), SLOT(onTaskStarted())); connect(task, SIGNAL(started()), SLOT(onTaskStarted()));
connect(task, SIGNAL(failed(QString)), SLOT(onTaskFailed(QString))); connect(task, SIGNAL(failed(QString)), SLOT(onTaskFailed(QString)));
connect(task, SIGNAL(succeeded()), SLOT(onTaskSucceeded())); connect(task, SIGNAL(succeeded()), SLOT(onTaskSucceeded()));
connect(task, SIGNAL(status(QString)), SLOT(changeStatus(const QString &))); connect(task, SIGNAL(status(QString)), SLOT(changeStatus(const QString&)));
connect(task, SIGNAL(stepStatus(QString)), SLOT(changeStatus(const QString&)));
connect(task, SIGNAL(progress(qint64, qint64)), SLOT(changeProgress(qint64, qint64))); connect(task, SIGNAL(progress(qint64, qint64)), SLOT(changeProgress(qint64, qint64)));
connect(task, &Task::aborted, [this] { onTaskFailed(tr("Aborted by user")); });
m_is_multi_step = task->isMultiStep(); m_is_multi_step = task->isMultiStep();
if(!m_is_multi_step){ if (!m_is_multi_step) {
ui->globalStatusLabel->setHidden(true); ui->globalStatusLabel->setHidden(true);
ui->globalProgressBar->setHidden(true); ui->globalProgressBar->setHidden(true);
} }
// if this didn't connect to an already running task, invoke start // if this didn't connect to an already running task, invoke start
if(!task->isRunning()) if (!task->isRunning()) {
{
task->start(); task->start();
} }
if(task->isRunning()) if (task->isRunning()) {
{
changeProgress(task->getProgress(), task->getTotalProgress()); changeProgress(task->getProgress(), task->getTotalProgress());
changeStatus(task->getStatus()); changeStatus(task->getStatus());
return QDialog::exec(); return QDialog::exec();
} } else if (handleImmediateResult(result)) {
else if(handleImmediateResult(result))
{
return result; return result;
} } else {
else
{
return QDialog::Rejected; return QDialog::Rejected;
} }
} }
// TODO: only provide the unique_ptr overloads // TODO: only provide the unique_ptr overloads
int ProgressDialog::execWithTask(std::unique_ptr<Task> &&task) int ProgressDialog::execWithTask(std::unique_ptr<Task>&& task)
{ {
connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater); connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater);
return execWithTask(task.release()); return execWithTask(task.release());
} }
int ProgressDialog::execWithTask(std::unique_ptr<Task> &task) int ProgressDialog::execWithTask(std::unique_ptr<Task>& task)
{ {
connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater); connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater);
return execWithTask(task.release()); return execWithTask(task.release());
} }
bool ProgressDialog::handleImmediateResult(QDialog::DialogCode &result) bool ProgressDialog::handleImmediateResult(QDialog::DialogCode& result)
{ {
if(task->isFinished()) if (task->isFinished()) {
{ if (task->wasSuccessful()) {
if(task->wasSuccessful())
{
result = QDialog::Accepted; result = QDialog::Accepted;
} } else {
else
{
result = QDialog::Rejected; result = QDialog::Rejected;
} }
return true; return true;
@ -137,14 +129,12 @@ bool ProgressDialog::handleImmediateResult(QDialog::DialogCode &result)
return false; return false;
} }
Task *ProgressDialog::getTask() Task* ProgressDialog::getTask()
{ {
return task; return task;
} }
void ProgressDialog::onTaskStarted() void ProgressDialog::onTaskStarted() {}
{
}
void ProgressDialog::onTaskFailed(QString failure) void ProgressDialog::onTaskFailed(QString failure)
{ {
@ -156,10 +146,11 @@ void ProgressDialog::onTaskSucceeded()
accept(); accept();
} }
void ProgressDialog::changeStatus(const QString &status) void ProgressDialog::changeStatus(const QString& status)
{ {
ui->globalStatusLabel->setText(task->getStatus());
ui->statusLabel->setText(task->getStepStatus()); ui->statusLabel->setText(task->getStepStatus());
ui->globalStatusLabel->setText(status);
updateSize(); updateSize();
} }
@ -168,27 +159,22 @@ void ProgressDialog::changeProgress(qint64 current, qint64 total)
ui->globalProgressBar->setMaximum(total); ui->globalProgressBar->setMaximum(total);
ui->globalProgressBar->setValue(current); ui->globalProgressBar->setValue(current);
if(!m_is_multi_step){ if (!m_is_multi_step) {
ui->taskProgressBar->setMaximum(total); ui->taskProgressBar->setMaximum(total);
ui->taskProgressBar->setValue(current); ui->taskProgressBar->setValue(current);
} } else {
else{
ui->taskProgressBar->setMaximum(task->getStepProgress()); ui->taskProgressBar->setMaximum(task->getStepProgress());
ui->taskProgressBar->setValue(task->getStepTotalProgress()); ui->taskProgressBar->setValue(task->getStepTotalProgress());
} }
} }
void ProgressDialog::keyPressEvent(QKeyEvent *e) void ProgressDialog::keyPressEvent(QKeyEvent* e)
{ {
if(ui->skipButton->isVisible()) if (ui->skipButton->isVisible()) {
{ if (e->key() == Qt::Key_Escape) {
if (e->key() == Qt::Key_Escape)
{
on_skipButton_clicked(true); on_skipButton_clicked(true);
return; return;
} } else if (e->key() == Qt::Key_Tab) {
else if(e->key() == Qt::Key_Tab)
{
ui->skipButton->setFocusPolicy(Qt::StrongFocus); ui->skipButton->setFocusPolicy(Qt::StrongFocus);
ui->skipButton->setFocus(); ui->skipButton->setFocus();
ui->skipButton->setAutoDefault(true); ui->skipButton->setAutoDefault(true);
@ -199,14 +185,11 @@ void ProgressDialog::keyPressEvent(QKeyEvent *e)
QDialog::keyPressEvent(e); QDialog::keyPressEvent(e);
} }
void ProgressDialog::closeEvent(QCloseEvent *e) void ProgressDialog::closeEvent(QCloseEvent* e)
{ {
if (task && task->isRunning()) if (task && task->isRunning()) {
{
e->ignore(); e->ignore();
} } else {
else
{
QDialog::closeEvent(e); QDialog::closeEvent(e);
} }
} }

View File

@ -40,6 +40,12 @@
</item> </item>
<item row="2" column="0"> <item row="2" column="0">
<widget class="QLabel" name="statusLabel"> <widget class="QLabel" name="statusLabel">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="text"> <property name="text">
<string>Task Status...</string> <string>Task Status...</string>
</property> </property>

View File

@ -5,6 +5,9 @@ ReviewMessageBox::ReviewMessageBox(QWidget* parent, QString const& title, QStrin
: QDialog(parent), ui(new Ui::ReviewMessageBox) : QDialog(parent), ui(new Ui::ReviewMessageBox)
{ {
ui->setupUi(this); ui->setupUi(this);
connect(ui->buttonBox, &QDialogButtonBox::accepted, this, &ReviewMessageBox::accept);
connect(ui->buttonBox, &QDialogButtonBox::rejected, this, &ReviewMessageBox::reject);
} }
ReviewMessageBox::~ReviewMessageBox() ReviewMessageBox::~ReviewMessageBox()
@ -17,15 +20,33 @@ auto ReviewMessageBox::create(QWidget* parent, QString&& title, QString&& icon)
return new ReviewMessageBox(parent, title, icon); return new ReviewMessageBox(parent, title, icon);
} }
void ReviewMessageBox::appendMod(const QString& name, const QString& filename) void ReviewMessageBox::appendMod(ModInformation&& info)
{ {
auto itemTop = new QTreeWidgetItem(ui->modTreeWidget); auto itemTop = new QTreeWidgetItem(ui->modTreeWidget);
itemTop->setText(0, name); itemTop->setCheckState(0, Qt::CheckState::Checked);
itemTop->setText(0, info.name);
auto filenameItem = new QTreeWidgetItem(itemTop); auto filenameItem = new QTreeWidgetItem(itemTop);
filenameItem->setText(0, tr("Filename: %1").arg(filename)); filenameItem->setText(0, tr("Filename: %1").arg(info.filename));
itemTop->insertChildren(0, { filenameItem }); itemTop->insertChildren(0, { filenameItem });
ui->modTreeWidget->addTopLevelItem(itemTop); ui->modTreeWidget->addTopLevelItem(itemTop);
} }
auto ReviewMessageBox::deselectedMods() -> QStringList
{
QStringList list;
auto* item = ui->modTreeWidget->topLevelItem(0);
for (int i = 0; item != nullptr; ++i) {
if (item->checkState(0) == Qt::CheckState::Unchecked) {
list.append(item->text(0));
}
item = ui->modTreeWidget->topLevelItem(i);
}
return list;
}

View File

@ -6,17 +6,23 @@ namespace Ui {
class ReviewMessageBox; class ReviewMessageBox;
} }
class ReviewMessageBox final : public QDialog { class ReviewMessageBox : public QDialog {
Q_OBJECT Q_OBJECT
public: public:
static auto create(QWidget* parent, QString&& title, QString&& icon = "") -> ReviewMessageBox*; static auto create(QWidget* parent, QString&& title, QString&& icon = "") -> ReviewMessageBox*;
void appendMod(const QString& name, const QString& filename); using ModInformation = struct {
QString name;
QString filename;
};
void appendMod(ModInformation&& info);
auto deselectedMods() -> QStringList;
~ReviewMessageBox(); ~ReviewMessageBox();
private: protected:
ReviewMessageBox(QWidget* parent, const QString& title, const QString& icon); ReviewMessageBox(QWidget* parent, const QString& title, const QString& icon);
Ui::ReviewMessageBox* ui; Ui::ReviewMessageBox* ui;

View File

@ -6,8 +6,8 @@
<rect> <rect>
<x>0</x> <x>0</x>
<y>0</y> <y>0</y>
<width>400</width> <width>500</width>
<height>300</height> <height>350</height>
</rect> </rect>
</property> </property>
<property name="windowTitle"> <property name="windowTitle">
@ -20,24 +20,7 @@
<bool>true</bool> <bool>true</bool>
</property> </property>
<layout class="QGridLayout" name="gridLayout"> <layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="QLabel" name="label">
<property name="text">
<string>You're about to download the following mods:</string>
</property>
</widget>
</item>
<item row="2" column="0"> <item row="2" column="0">
<widget class="QDialogButtonBox" name="buttonBox">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="standardButtons">
<set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
</property>
</widget>
</item>
<item row="1" column="0">
<widget class="QTreeWidget" name="modTreeWidget"> <widget class="QTreeWidget" name="modTreeWidget">
<property name="alternatingRowColors"> <property name="alternatingRowColors">
<bool>true</bool> <bool>true</bool>
@ -58,41 +41,33 @@
</column> </column>
</widget> </widget>
</item> </item>
<item row="1" column="0">
<widget class="QLabel" name="explainLabel">
<property name="text">
<string>You're about to download the following mods:</string>
</property>
</widget>
</item>
<item row="5" column="0" rowspan="2">
<layout class="QHBoxLayout" name="horizontalLayout">
<item>
<widget class="QLabel" name="onlyCheckedLabel">
<property name="text">
<string>Only mods with a check will be downloaded!</string>
</property>
</widget>
</item>
<item>
<widget class="QDialogButtonBox" name="buttonBox">
<property name="standardButtons">
<set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
</property>
</widget>
</item>
</layout>
</item>
</layout> </layout>
</widget> </widget>
<resources/> <resources/>
<connections> <connections/>
<connection>
<sender>buttonBox</sender>
<signal>accepted()</signal>
<receiver>ReviewMessageBox</receiver>
<slot>accept()</slot>
<hints>
<hint type="sourcelabel">
<x>200</x>
<y>265</y>
</hint>
<hint type="destinationlabel">
<x>199</x>
<y>149</y>
</hint>
</hints>
</connection>
<connection>
<sender>buttonBox</sender>
<signal>rejected()</signal>
<receiver>ReviewMessageBox</receiver>
<slot>reject()</slot>
<hints>
<hint type="sourcelabel">
<x>200</x>
<y>265</y>
</hint>
<hint type="destinationlabel">
<x>199</x>
<y>149</y>
</hint>
</hints>
</connection>
</connections>
</ui> </ui>

View File

@ -402,6 +402,10 @@ void ModFolderPage::on_actionInstall_mods_triggered()
CustomMessageBox::selectable(this, tr("Error"), reason, QMessageBox::Critical)->show(); CustomMessageBox::selectable(this, tr("Error"), reason, QMessageBox::Critical)->show();
tasks->deleteLater(); tasks->deleteLater();
}); });
connect(tasks, &Task::aborted, [this, tasks]() {
CustomMessageBox::selectable(this, tr("Aborted"), tr("Download stopped by user."), QMessageBox::Information)->show();
tasks->deleteLater();
});
connect(tasks, &Task::succeeded, [this, tasks]() { connect(tasks, &Task::succeeded, [this, tasks]() {
QStringList warnings = tasks->warnings(); QStringList warnings = tasks->warnings();
if (warnings.count()) { CustomMessageBox::selectable(this, tr("Warnings"), warnings.join('\n'), QMessageBox::Warning)->show(); } if (warnings.count()) { CustomMessageBox::selectable(this, tr("Warnings"), warnings.join('\n'), QMessageBox::Warning)->show(); }
@ -411,6 +415,7 @@ void ModFolderPage::on_actionInstall_mods_triggered()
for (auto task : mdownload.getTasks()) { for (auto task : mdownload.getTasks()) {
tasks->addTask(task); tasks->addTask(task);
} }
ProgressDialog loadDialog(this); ProgressDialog loadDialog(this);
loadDialog.setSkipButton(true, tr("Abort")); loadDialog.setSkipButton(true, tr("Abort"));
loadDialog.execWithTask(tasks); loadDialog.execWithTask(tasks);

View File

@ -38,27 +38,44 @@ auto ListModel::data(const QModelIndex& index, int role) const -> QVariant
} }
ModPlatform::IndexedPack pack = modpacks.at(pos); ModPlatform::IndexedPack pack = modpacks.at(pos);
if (role == Qt::DisplayRole) { switch (role) {
return pack.name; case Qt::DisplayRole: {
} else if (role == Qt::ToolTipRole) { return pack.name;
if (pack.description.length() > 100) {
// some magic to prevent to long tooltips and replace html linebreaks
QString edit = pack.description.left(97);
edit = edit.left(edit.lastIndexOf("<br>")).left(edit.lastIndexOf(" ")).append("...");
return edit;
} }
return pack.description; case Qt::ToolTipRole: {
} else if (role == Qt::DecorationRole) { if (pack.description.length() > 100) {
if (m_logoMap.contains(pack.logoName)) { // some magic to prevent to long tooltips and replace html linebreaks
return (m_logoMap.value(pack.logoName)); QString edit = pack.description.left(97);
edit = edit.left(edit.lastIndexOf("<br>")).left(edit.lastIndexOf(" ")).append("...");
return edit;
}
return pack.description;
} }
QIcon icon = APPLICATION->getThemedIcon("screenshot-placeholder"); case Qt::DecorationRole: {
((ListModel*)this)->requestLogo(pack.logoName, pack.logoUrl); if (m_logoMap.contains(pack.logoName)) {
return icon; return (m_logoMap.value(pack.logoName));
} else if (role == Qt::UserRole) { }
QVariant v; QIcon icon = APPLICATION->getThemedIcon("screenshot-placeholder");
v.setValue(pack); // un-const-ify this
return v; ((ListModel*)this)->requestLogo(pack.logoName, pack.logoUrl);
return icon;
}
case Qt::UserRole: {
QVariant v;
v.setValue(pack);
return v;
}
case Qt::FontRole: {
QFont font;
if (m_parent->getDialog()->isModSelected(pack.name)) {
font.setBold(true);
font.setUnderline(true);
}
return font;
}
default:
break;
} }
return {}; return {};

View File

@ -41,6 +41,7 @@ class ModPage : public QWidget, public BasePage {
auto apiProvider() const -> const ModAPI* { return api.get(); }; auto apiProvider() const -> const ModAPI* { return api.get(); };
auto getFilter() const -> const std::shared_ptr<ModFilterWidget::Filter> { return m_filter; } auto getFilter() const -> const std::shared_ptr<ModFilterWidget::Filter> { return m_filter; }
auto getDialog() const -> const ModDownloadDialog* { return dialog; }
auto getCurrent() -> ModPlatform::IndexedPack& { return current; } auto getCurrent() -> ModPlatform::IndexedPack& { return current; }
void updateModVersions(int prev_count = -1); void updateModVersions(int prev_count = -1);