PrismLauncher/launcher/ui/dialogs/ProgressDialog.cpp

/* 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 "ProgressDialog.h"
#include "ui_ProgressDialog.h"

#include <QDebug>
#include <QKeyEvent>

#include "tasks/Task.h"

ProgressDialog::ProgressDialog(QWidget* parent) : QDialog(parent), ui(new Ui::ProgressDialog)
{
    ui->setupUi(this);
    this->setWindowFlags(this->windowFlags() & ~Qt::WindowContextHelpButtonHint);
    setSkipButton(false);
    changeProgress(0, 100);
}

void ProgressDialog::setSkipButton(bool present, QString label)
{
    ui->skipButton->setAutoDefault(false);
    ui->skipButton->setDefault(false);
    ui->skipButton->setFocusPolicy(Qt::ClickFocus);
    ui->skipButton->setEnabled(present);
    ui->skipButton->setVisible(present);
    ui->skipButton->setText(label);
    updateSize();
}

void ProgressDialog::on_skipButton_clicked(bool checked)
{
    Q_UNUSED(checked);
    task->abort();
    QDialog::reject();
}

ProgressDialog::~ProgressDialog()
{
    delete ui;
}

void ProgressDialog::updateSize()
{
    QSize qSize = QSize(480, minimumSizeHint().height());
    resize(qSize);
    setFixedSize(qSize);
}

int ProgressDialog::execWithTask(Task* task)
{
    this->task = task;
    QDialog::DialogCode result;

    if (!task) {
        qDebug() << "Programmer error: progress dialog created with null task.";
        return Accepted;
    }

    if (handleImmediateResult(result)) {
        return result;
    }

    // Connect signals.
    connect(task, SIGNAL(started()), SLOT(onTaskStarted()));
    connect(task, SIGNAL(failed(QString)), SLOT(onTaskFailed(QString)));
    connect(task, SIGNAL(succeeded()), SLOT(onTaskSucceeded()));
    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, &Task::aborted, [this] { onTaskFailed(tr("Aborted by user")); });

    m_is_multi_step = task->isMultiStep();
    if (!m_is_multi_step) {
        ui->globalStatusLabel->setHidden(true);
        ui->globalProgressBar->setHidden(true);
    }

    // if this didn't connect to an already running task, invoke start
    if (!task->isRunning()) {
        task->start();
    }
    if (task->isRunning()) {
        changeProgress(task->getProgress(), task->getTotalProgress());
        changeStatus(task->getStatus());
        return QDialog::exec();
    } else if (handleImmediateResult(result)) {
        return result;
    } else {
        return QDialog::Rejected;
    }
}

// TODO: only provide the unique_ptr overloads
int ProgressDialog::execWithTask(std::unique_ptr<Task>&& task)
{
    connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater);
    return execWithTask(task.release());
}
int ProgressDialog::execWithTask(std::unique_ptr<Task>& task)
{
    connect(this, &ProgressDialog::destroyed, task.get(), &Task::deleteLater);
    return execWithTask(task.release());
}

bool ProgressDialog::handleImmediateResult(QDialog::DialogCode& result)
{
    if (task->isFinished()) {
        if (task->wasSuccessful()) {
            result = QDialog::Accepted;
        } else {
            result = QDialog::Rejected;
        }
        return true;
    }
    return false;
}

Task* ProgressDialog::getTask()
{
    return task;
}

void ProgressDialog::onTaskStarted() {}

void ProgressDialog::onTaskFailed(QString failure)
{
    reject();
}

void ProgressDialog::onTaskSucceeded()
{
    accept();
}

void ProgressDialog::changeStatus(const QString& status)
{
    ui->globalStatusLabel->setText(task->getStatus());
    ui->statusLabel->setText(task->getStepStatus());

    updateSize();
}

void ProgressDialog::changeProgress(qint64 current, qint64 total)
{
    ui->globalProgressBar->setMaximum(total);
    ui->globalProgressBar->setValue(current);

    if (!m_is_multi_step) {
        ui->taskProgressBar->setMaximum(total);
        ui->taskProgressBar->setValue(current);
    } else {
        ui->taskProgressBar->setMaximum(task->getStepProgress());
        ui->taskProgressBar->setValue(task->getStepTotalProgress());
    }
}

void ProgressDialog::keyPressEvent(QKeyEvent* e)
{
    if (ui->skipButton->isVisible()) {
        if (e->key() == Qt::Key_Escape) {
            on_skipButton_clicked(true);
            return;
        } else if (e->key() == Qt::Key_Tab) {
            ui->skipButton->setFocusPolicy(Qt::StrongFocus);
            ui->skipButton->setFocus();
            ui->skipButton->setAutoDefault(true);
            ui->skipButton->setDefault(true);
            return;
        }
    }
    QDialog::keyPressEvent(e);
}

void ProgressDialog::closeEvent(QCloseEvent* e)
{
    if (task && task->isRunning()) {
        e->ignore();
    } else {
        QDialog::closeEvent(e);
    }
}