OSCAR-code/oscar/aboutdialog.cpp

/* OSCAR AboutDialog Implementation
 *
 * Date created: 7/5/2018
 *
 * Copyright (c) 2018 Mark Watkins <mark@jedimark.net>
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License. See the file COPYING in the main directory of the Source Directory. */

#include <QDesktopServices>
#include <QFile>
#include <QDebug>
#include <QMessageBox>

#include "version.h"
#include "SleepLib/appsettings.h"
#include "aboutdialog.h"
#include "ui_aboutdialog.h"


AboutDialog::AboutDialog(QWidget *parent) :
    QDialog(parent),
    ui(new Ui::AboutDialog)
{
    ui->setupUi(this);

    ui->aboutText->setHtml(getAbout());
    ui->creditsText->setHtml(getCredits());
    ui->licenseText->setHtml(getLicense());
    ui->relnotesText->setHtml(getRelnotes());
    ui->versionLabel->setText("");

//    QString gitrev = gitRevision();
//
//    if (!gitrev.isEmpty()) {
//        gitrev = tr("Revision: %1").arg(QString("<a href='https://gitlab.com/sleepyhead/sleepyhead-code/commit/%1'>%1</a>").arg(gitrev))+"<br/>"
//                +tr("Branch: %1").arg(QString("<a href='https://gitlab.com/sleepyhead/sleepyhead-code/commits/%1'>%1</a>").arg(gitBranch()))+"<br/>"
//                +tr("Build Date: %1").arg(__DATE__)+"<br/>"
//                +tr("Graphics Engine: %1").arg(getGraphicsEngine());
//    }

    QString path = GetAppData();
    QString text = /* gitrev + */ "<br/><br/><a href=\"file:///"+path+"\">"+tr("Show data folder")+"</a>";
    ui->infoLabel->setText(text);


    setWindowTitle(tr("About OSCAR %1").arg(getVersion().displayString()));
    setMinimumSize(QSize(400,400));
    this->setWindowFlags(this->windowFlags() & ~Qt::WindowContextHelpButtonHint);
    connect(ui->closeButton, SIGNAL(clicked(bool)), this, SLOT(accept()));

    int idx=AppSetting->showAboutDialog();
    if (idx<0) idx = 0; // start in about tab
    ui->tabWidget->setCurrentIndex(idx);
}

AboutDialog::~AboutDialog()
{
    disconnect(ui->closeButton, SIGNAL(clicked(bool)), this, SLOT(accept()));
    delete ui;
}

/***************************************************
void AboutDialog::on_donateButton_clicked()
{
//    QDesktopServices::openUrl(QUrl("http://sleepyhead.jedimark.net/donate.php"));
    QMessageBox::information(nullptr, STR_MessageBox_Information, tr("Donations are not yet implemented"));
}
******************************************************/

QString AboutDialog::getFilename(QString name)
{
    QString filename;
    QString language = AppSetting->language();
    if (language == "en_US") {
        filename = ":docs/"+name+".html";
    } else {
        QString docRoot = appResourcePath() + "/Html/";
        filename = docRoot + name + "-" + language + ".html";
        if ( ! QFile::exists(filename) )
            filename = ":docs/"+name+".html";
    }
    qDebug() << "Looking for " + filename;
    return filename;
}

QString AboutDialog::getAbout()
{
    QString aboutFile = getFilename("about");
    QFile clfile(aboutFile);
    QString text = tr("Sorry, could not locate About file.");
    if (clfile.open(QIODevice::ReadOnly)) {
        text = clfile.readAll();
    } else
        qDebug() << "Failed to open About file";

    return text;
}

QString AboutDialog::getCredits()
{
    QString creditsFile = getFilename("credits");
    QFile clfile(creditsFile);
    QString text = tr("Sorry, could not locate Credits file.");
    if (clfile.open(QIODevice::ReadOnly)) {
        text = clfile.readAll();
    }

    return text;
}

QString AboutDialog::getRelnotes()
{
    QString relNotesFile = getFilename("release_notes");
    QFile clfile(relNotesFile);
    QString changeLog = tr("Sorry, could not locate Release Notes.");
    if (clfile.open(QIODevice::ReadOnly)) {
        //Todo, write XML parser and only show the latest..
        //QTextStream ts(&clfile);
        changeLog = clfile.readAll();
    }

    QString text = "<html>"
    "<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"></head>"
    "<body><span style=\" font-size:20pt;\">"+tr("Release Notes")+"</span><br/>"
    "<span style=\" font-size:14pt;\">"+tr("OSCAR %1").arg(getVersion())+"</span>"
    "<hr/>";
    if (getVersion().IsReleaseVersion() == false) {
        text += "<p><font color='red' size=+1><b>"+tr("Important:")+"</b></font> "
        "<font size=+1><i>"+tr("As this is a pre-release version, it is recommended that you <b>back up your data folder manually</b> before proceeding, because attempting to roll back later may break things.")+"</i></font></p><hr/>";
    }
    text += changeLog;
    text += "</body></html>";
    return text;
}

QString AboutDialog::getLicense()
{
    QString text;
    QString licenseFile = ":/docs/GPLv3-"+AppSetting->language();
    if (!QFile::exists(licenseFile)) {
        ui->licenceLabel->setText(tr("To see if the license text is available in your language, see %1.").arg("<a href=\"https://www.gnu.org/licenses/translations.en.html\">https://www.gnu.org/licenses/translations.en.html</a>"));
        ui->licenceLabel->setVisible(true);
        licenseFile = ":/docs/GPLv3-en_US";
    } else {
        ui->licenceLabel->setVisible(false);
    }

    QFile file(licenseFile);
    if (file.open(QIODevice::ReadOnly)) {
        text = "<div align=center>"+QString(file.readAll()).replace("\n","<br/>")+"</div>";
    }
    return text;
}
Sorry, massive list of small changes - debugging, sleepyhead deleteion, etc 2019-03-10 16:03:19 +00:00			`/* OSCAR AboutDialog Implementation`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`*`
			`* Date created: 7/5/2018`
			`*`
			`* Copyright (c) 2018 Mark Watkins <mark@jedimark.net>`
			`*`
			`* This file is subject to the terms and conditions of the GNU General Public`
			`* License. See the file COPYING in the main directory of the Source Directory. */`

			`#include <QDesktopServices>`
			`#include <QFile>`
More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`#include <QDebug>`
			`#include <QMessageBox>`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00
			`#include "version.h"`
			`#include "SleepLib/appsettings.h"`
			`#include "aboutdialog.h"`
			`#include "ui_aboutdialog.h"`


			`AboutDialog::AboutDialog(QWidget *parent) :`
			`QDialog(parent),`
			`ui(new Ui::AboutDialog)`
			`{`
			`ui->setupUi(this);`

More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`ui->aboutText->setHtml(getAbout());`
			`ui->creditsText->setHtml(getCredits());`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`ui->licenseText->setHtml(getLicense());`
			`ui->relnotesText->setHtml(getRelnotes());`
Update version display throughout to use the new information and be consistent. The full version now includes the build/git information embedded within it as build metadata according to the Semantic Versioning 2.0.0 spec, for example: "1.1.0-beta-1+branch-name-a1b2c3d". Now the full version string, with all detail is always displayed EXCEPT for release versions, in which case just the simple version number ("1.1.0") is displayed in the primary UI. - Main window title: simple version for release versions, full version string otherwise - Notifications: same as main window title - System tray: same as main window title - About window title: same as main window title - About window release notes: always include full version string - Reports: always include full version string - Under the logo (about dialog, profile selector, new profile window): removed, as it is largely redundant and can interfere with the window geometry. - Database upgrade alert: same as main window title - Database newer alert: same as main window title The full version string is also included within the preference and profile .xml files, but because build metadata is ignored in version comparisons, differences in builds will not cause any spurious alerts. However, changes in prerelease versions will continue to be significant, as they should be. 2020-01-16 18:05:55 +00:00			`ui->versionLabel->setText("");`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00
sleepyhead changed to OSCR where appropriate 2019-02-13 18:22:54 +00:00			`// QString gitrev = gitRevision();`
			`//`
			`// if (!gitrev.isEmpty()) {`
			`// gitrev = tr("Revision: %1").arg(QString("<a href='https://gitlab.com/sleepyhead/sleepyhead-code/commit/%1'>%1</a>").arg(gitrev))+"<br/>"`
			`// +tr("Branch: %1").arg(QString("<a href='https://gitlab.com/sleepyhead/sleepyhead-code/commits/%1'>%1</a>").arg(gitBranch()))+"<br/>"`
			`// +tr("Build Date: %1").arg(__DATE__)+"<br/>"`
			`// +tr("Graphics Engine: %1").arg(getGraphicsEngine());`
			`// }`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00
Change Settings/AppRoot to Settings/AppData to reduce confusion between execuable path and data folder path 2019-03-25 23:43:04 +00:00			`QString path = GetAppData();`
sleepyhead changed to OSCR where appropriate 2019-02-13 18:22:54 +00:00			`QString text = /* gitrev + */ "<br/><br/><a href=\"file:///"+path+"\">"+tr("Show data folder")+"</a>";`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`ui->infoLabel->setText(text);`


Update version display throughout to use the new information and be consistent. The full version now includes the build/git information embedded within it as build metadata according to the Semantic Versioning 2.0.0 spec, for example: "1.1.0-beta-1+branch-name-a1b2c3d". Now the full version string, with all detail is always displayed EXCEPT for release versions, in which case just the simple version number ("1.1.0") is displayed in the primary UI. - Main window title: simple version for release versions, full version string otherwise - Notifications: same as main window title - System tray: same as main window title - About window title: same as main window title - About window release notes: always include full version string - Reports: always include full version string - Under the logo (about dialog, profile selector, new profile window): removed, as it is largely redundant and can interfere with the window geometry. - Database upgrade alert: same as main window title - Database newer alert: same as main window title The full version string is also included within the preference and profile .xml files, but because build metadata is ignored in version comparisons, differences in builds will not cause any spurious alerts. However, changes in prerelease versions will continue to be significant, as they should be. 2020-01-16 18:05:55 +00:00			`setWindowTitle(tr("About OSCAR %1").arg(getVersion().displayString()));`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`setMinimumSize(QSize(400,400));`
Remove the Help ? from title bars 2019-04-08 01:54:04 +00:00			`this->setWindowFlags(this->windowFlags() & ~Qt::WindowContextHelpButtonHint);`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`connect(ui->closeButton, SIGNAL(clicked(bool)), this, SLOT(accept()));`

			`int idx=AppSetting->showAboutDialog();`
			`if (idx<0) idx = 0; // start in about tab`
			`ui->tabWidget->setCurrentIndex(idx);`
			`}`

			`AboutDialog::~AboutDialog()`
			`{`
			`disconnect(ui->closeButton, SIGNAL(clicked(bool)), this, SLOT(accept()));`
			`delete ui;`
			`}`

More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`/***************************************************`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`void AboutDialog::on_donateButton_clicked()`
			`{`
changed references to jedimark where appropriate 2019-02-12 21:57:03 +00:00			`// QDesktopServices::openUrl(QUrl("http://sleepyhead.jedimark.net/donate.php"));`
More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`QMessageBox::information(nullptr, STR_MessageBox_Information, tr("Donations are not yet implemented"));`
			`}`
			`******************************************************/`

Allow for translated html texts 2019-03-20 13:49:17 +00:00			`QString AboutDialog::getFilename(QString name)`
			`{`
			`QString filename;`
			`QString language = AppSetting->language();`
			`if (language == "en_US") {`
			`filename = ":docs/"+name+".html";`
			`} else {`
			`QString docRoot = appResourcePath() + "/Html/";`
Fixed typo in filename creation and added fallback to en_US version. 2019-04-06 11:17:35 +00:00			`filename = docRoot + name + "-" + language + ".html";`
			`if ( ! QFile::exists(filename) )`
			`filename = ":docs/"+name+".html";`
Allow for translated html texts 2019-03-20 13:49:17 +00:00			`}`
			`qDebug() << "Looking for " + filename;`
			`return filename;`
			`}`

More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`QString AboutDialog::getAbout()`
			`{`
Allow for translated html texts 2019-03-20 13:49:17 +00:00			`QString aboutFile = getFilename("about");`
			`QFile clfile(aboutFile);`
More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`QString text = tr("Sorry, could not locate About file.");`
			`if (clfile.open(QIODevice::ReadOnly)) {`
			`text = clfile.readAll();`
			`} else`
			`qDebug() << "Failed to open About file";`

			`return text;`
			`}`

			`QString AboutDialog::getCredits()`
			`{`
Allow for translated html texts 2019-03-20 13:49:17 +00:00			`QString creditsFile = getFilename("credits");`
			`QFile clfile(creditsFile);`
More SleepyHead->OSCR, and remove Updater and Donate features 2019-02-15 01:37:29 +00:00			`QString text = tr("Sorry, could not locate Credits file.");`
			`if (clfile.open(QIODevice::ReadOnly)) {`
			`text = clfile.readAll();`
			`}`

			`return text;`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`}`

			`QString AboutDialog::getRelnotes()`
			`{`
Allow for translated html texts 2019-03-20 13:49:17 +00:00			`QString relNotesFile = getFilename("release_notes");`
			`QFile clfile(relNotesFile);`
Sorry, massive list of small changes - debugging, sleepyhead deleteion, etc 2019-03-10 16:03:19 +00:00			`QString changeLog = tr("Sorry, could not locate Release Notes.");`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`if (clfile.open(QIODevice::ReadOnly)) {`
			`//Todo, write XML parser and only show the latest..`
			`//QTextStream ts(&clfile);`
			`changeLog = clfile.readAll();`
			`}`

			`QString text = "<html>"`
			`"<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"></head>"`
			`"<body><span style=\" font-size:20pt;\">"+tr("Release Notes")+"</span><br/>"`
Update version display throughout to use the new information and be consistent. The full version now includes the build/git information embedded within it as build metadata according to the Semantic Versioning 2.0.0 spec, for example: "1.1.0-beta-1+branch-name-a1b2c3d". Now the full version string, with all detail is always displayed EXCEPT for release versions, in which case just the simple version number ("1.1.0") is displayed in the primary UI. - Main window title: simple version for release versions, full version string otherwise - Notifications: same as main window title - System tray: same as main window title - About window title: same as main window title - About window release notes: always include full version string - Reports: always include full version string - Under the logo (about dialog, profile selector, new profile window): removed, as it is largely redundant and can interfere with the window geometry. - Database upgrade alert: same as main window title - Database newer alert: same as main window title The full version string is also included within the preference and profile .xml files, but because build metadata is ignored in version comparisons, differences in builds will not cause any spurious alerts. However, changes in prerelease versions will continue to be significant, as they should be. 2020-01-16 18:05:55 +00:00			`"<span style=\" font-size:14pt;\">"+tr("OSCAR %1").arg(getVersion())+"</span>"`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`"<hr/>";`
Replace VersionString with getVersion() everywhere. 2020-01-16 00:45:46 +00:00			`if (getVersion().IsReleaseVersion() == false) {`
Clean up tr() strings a bit and hunt for untranslateables 2018-06-14 07:25:54 +00:00			`text += "<p><font color='red' size=+1><b>"+tr("Important:")+"</b></font> "`
Fix spelling error. 2019-08-22 09:24:47 +00:00			`"<font size=+1><i>"+tr("As this is a pre-release version, it is recommended that you <b>back up your data folder manually</b> before proceeding, because attempting to roll back later may break things.")+"</i></font></p><hr/>";`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`}`
			`text += changeLog;`
			`text += "</body></html>";`
			`return text;`
			`}`

			`QString AboutDialog::getLicense()`
			`{`
			`QString text;`
			`QString licenseFile = ":/docs/GPLv3-"+AppSetting->language();`
			`if (!QFile::exists(licenseFile)) {`
Clean up tr() strings a bit and hunt for untranslateables 2018-06-14 07:25:54 +00:00			`ui->licenceLabel->setText(tr("To see if the license text is available in your language, see %1.").arg("<a href=\"https://www.gnu.org/licenses/translations.en.html\">https://www.gnu.org/licenses/translations.en.html</a>"));`
New mega AboutDialog combining, about, license, release notes, etc 2018-05-07 12:13:07 +00:00			`ui->licenceLabel->setVisible(true);`
			`licenseFile = ":/docs/GPLv3-en_US";`
			`} else {`
			`ui->licenceLabel->setVisible(false);`
			`}`

			`QFile file(licenseFile);`
			`if (file.open(QIODevice::ReadOnly)) {`
			`text = "<div align=center>"+QString(file.readAll()).replace("\n","<br/>")+"</div>";`
			`}`
			`return text;`
			`}`