aboutform.cpp

Go to the documentation of this file.

/*
    Copyright © 2014-2019 by The qTox Project Contributors
 
    This file is part of qTox, a Qt-based graphical interface for Tox.
 
    qTox is libre 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, either version 3 of the License, or
    (at your option) any later version.
 
    qTox 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 qTox.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#include "aboutform.h"
#include "ui_aboutsettings.h"
 
#include "src/net/updatecheck.h"
#include "src/persistence/profile.h"
#include "src/persistence/settings.h"
#include "src/widget/style.h"
#include "src/widget/tool/recursivesignalblocker.h"
#include "src/widget/translator.h"
 
#include <tox/tox.h>
 
#include <QDebug>
#include <QDesktopServices>
#include <QPushButton>
#include <QTimer>
 
#include <memory>
 
// index of UI in the QStackedWidget
enum class updateIndex
{
    available = 0,
    upToDate = 1,
    failed = 2
};
 
AboutForm::AboutForm(UpdateCheck* updateCheck)
    : GenericForm(QPixmap(":/img/settings/general.png"))
    , bodyUI(new Ui::AboutSettings)
    , progressTimer(new QTimer(this))
    , updateCheck(updateCheck)
{
    bodyUI->setupUi(this);
 
#if !UPDATE_CHECK_ENABLED
    bodyUI->updateStack->setVisible(false);
#endif
    bodyUI->unstableVersion->setVisible(false);
#if UPDATE_CHECK_ENABLED
    connect(updateCheck, &UpdateCheck::versionIsUnstable, this, &AboutForm::onUnstableVersion);
#endif
 
    // block all child signals during initialization
    const RecursiveSignalBlocker signalBlocker(this);
 
    replaceVersions();
 
    if (QString(GIT_VERSION).indexOf(" ") > -1)
        bodyUI->gitVersion->setOpenExternalLinks(false);
 
    eventsInit();
    Translator::registerHandler(std::bind(&AboutForm::retranslateUi, this), this);
}
 
void AboutForm::replaceVersions()
{
    // TODO: When we finally have stable releases: build-in a way to tell
    // nightly builds from stable releases.
 
    QString TOXCORE_VERSION = QString::number(tox_version_major()) + "."
                              + QString::number(tox_version_minor()) + "."
                              + QString::number(tox_version_patch());
 
    bodyUI->youAreUsing->setText(tr("You are using qTox version %1.").arg(QString(GIT_DESCRIBE)));
 
#if UPDATE_CHECK_ENABLED
    if (updateCheck != nullptr) {
        connect(updateCheck, &UpdateCheck::updateAvailable, this, &AboutForm::onUpdateAvailable);
        connect(updateCheck, &UpdateCheck::upToDate, this, &AboutForm::onUpToDate);
        connect(updateCheck, &UpdateCheck::updateCheckFailed, this, &AboutForm::onUpdateCheckFailed);
    } else {
        qWarning() << "AboutForm passed null UpdateCheck!";
    }
#else
    qDebug() << "AboutForm not showing updates, qTox built without UPDATE_CHECK";
#endif
 
    QString commitLink = "https://github.com/qTox/qTox/commit/" + QString(GIT_VERSION);
    bodyUI->gitVersion->setText(
        tr("Commit hash: %1").arg(createLink(commitLink, QString(GIT_VERSION))));
 
    bodyUI->toxCoreVersion->setText(tr("toxcore version: %1").arg(TOXCORE_VERSION));
    bodyUI->qtVersion->setText(tr("Qt version: %1").arg(QT_VERSION_STR));
 
    QString issueBody = QString("##### Brief Description\n\n"
                                "OS: %1\n"
                                "qTox version: %2\n"
                                "Commit hash: %3\n"
                                "toxcore: %4\n"
                                "Qt: %5\n…\n\n"
                                "Reproducible: Always / Almost Always / Sometimes"
                                " / Rarely / Couldn't Reproduce\n\n"
                                "##### Steps to reproduce\n\n"
                                "1. \n2. \n3. …\n\n"
                                "##### Observed Behavior\n\n\n"
                                "##### Expected Behavior\n\n\n"
                                "##### Additional Info\n"
                                "(links, images, etc go here)\n\n"
                                "----\n\n"
                                "More information on how to write good bug reports in the wiki: "
                                "https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports.\n\n"
                                "Please remove any unnecessary template section before submitting.")
                            .arg(QSysInfo::prettyProductName(), GIT_DESCRIBE, GIT_VERSION,
                                 TOXCORE_VERSION, QT_VERSION_STR);
 
    issueBody.replace("#", "%23").replace(":", "%3A");
 
    bodyUI->knownIssues->setText(
        tr("A list of all known issues may be found at our %1 at Github."
           " If you discover a bug or security vulnerability within"
           " qTox, please report it according to the guidelines in our"
           " %2 wiki article.",
 
           "`%1` is replaced by translation of `bug tracker`"
           "\n`%2` is replaced by translation of `Writing Useful Bug Reports`")
            .arg(createLink("https://github.com/qTox/qTox/issues",
                            tr("bug-tracker", "Replaces `%1` in the `A list of all known…`")))
            .arg(createLink("https://github.com/qTox/qTox/wiki/Writing-Useful-Bug-Reports",
                            tr("Writing Useful Bug Reports",
                               "Replaces `%2` in the `A list of all known…`"))));
 
    bodyUI->clickToReport->setText(
        createLink("https://github.com/qTox/qTox/issues/new?body=" + QUrl(issueBody).toEncoded(),
                   QString("<b>%1</b>").arg(tr("Click here to report a bug."))));
 
 
    QString authorInfo =
        QString("<p>%1</p><p>%2</p>")
            .arg(tr("Original author: %1").arg(createLink("https://github.com/tux3", "tux3")))
            .arg(
                tr("See a full list of %1 at Github",
                   "`%1` is replaced with translation of word `contributors`")
                    .arg(createLink("https://qtox.github.io/gitstats/authors.html",
                                    tr("contributors", "Replaces `%1` in `See a full list of…`"))));
 
    bodyUI->authorInfo->setText(authorInfo);
}
 
void AboutForm::onUpdateAvailable(QString latestVersion, QUrl link)
{
    QObject::disconnect(linkConnection);
    linkConnection = connect(bodyUI->updateAvailableButton, &QPushButton::clicked,
                             [link]() { QDesktopServices::openUrl(link); });
    bodyUI->updateStack->setCurrentIndex(static_cast<int>(updateIndex::available));
}
 
void AboutForm::onUpToDate()
{
    bodyUI->updateStack->setCurrentIndex(static_cast<int>(updateIndex::upToDate));
}
 
void AboutForm::onUpdateCheckFailed()
{
    bodyUI->updateStack->setCurrentIndex(static_cast<int>(updateIndex::failed));
}
 
void AboutForm::reloadTheme()
{
    replaceVersions();
}
 
void AboutForm::onUnstableVersion()
{
    bodyUI->updateStack->hide();
    bodyUI->unstableVersion->setVisible(true);
}
 
QString AboutForm::createLink(QString path, QString text) const
{
    return QString::fromUtf8(
               "<a href=\"%1\" style=\"text-decoration: underline; color:%2;\">%3</a>")
        .arg(path, Style::getColor(Style::Link).name(), text);
}
 
AboutForm::~AboutForm()
{
    Translator::unregister(this);
    delete bodyUI;
}
 
void AboutForm::retranslateUi()
{
    bodyUI->retranslateUi(this);
    replaceVersions();
}