Update feature completed for Windows

Author: niello

data/misc/update.cmd

@@ -3,6 +3,7 @@
 set AppFileSlashesEsc=%~1
 set InstallPath=%~2
 set UpdatePath=%~3
+set "PrevVersionBackupPath=%InstallPath%_old"
 
 :: Wait for all processes running from this .exe to finish
 :loop
@@ -13,7 +14,7 @@ if %errorlevel% neq 1 (
 )
 
 :: Rename an application directory into a temporary folder with the previous version backup
-move /y "%InstallPath%" "%InstallPath%Tmp"
+move /y "%InstallPath%" "%PrevVersionBackupPath%"
 if %errorlevel% neq 0 (
 	set "ResultCode=10"
 	set "ResultMsg=Failed to rename an installation directory to create a previous version backup"
@@ -25,17 +26,17 @@ mkdir "%InstallPath%"
 (robocopy "%UpdatePath%" "%InstallPath%" *.* /r:5 /w:2 /e /move >nul) & if %errorlevel% lss 8 set errorlevel=0
 if %errorlevel% neq 0 (
     :: Restore backup
-    move /y "%InstallPath%Tmp" "%InstallPath%"
+    move /y "%PrevVersionBackupPath%" "%InstallPath%"
 	set "ResultCode=20"
 	set "ResultMsg=Failed to move an update to the installation directory"
 	goto :run
 )
 
 :: Remove a temporary folder with the previous version backup
-rmdir /S /Q "%InstallPath%Tmp" | rem
+rmdir /S /Q "%PrevVersionBackupPath%" | rem
 if %errorlevel% neq 0 (
 	set "ResultCode=30"
-	set "ResultMsg=Updated successfully but failed to remove temporary folder %InstallPath%Tmp"
+	set "ResultMsg=Updated successfully but failed to remove temporary folder %PrevVersionBackupPath%"
     goto :run
 )
 

src/Application.cpp

@@ -191,6 +191,11 @@ QString Application::getDocumentationPath() const
     return QDir::current().absoluteFilePath("doc");
 }
 
+QString Application::getUpdatePath() const
+{
+    return QDir::temp().absoluteFilePath("CEEDUpdate");
+}
+
 void Application::checkForUpdates()
 {
     if (!Utils::isInternetConnected())
@@ -225,10 +230,25 @@ void Application::checkForUpdates()
 
             QVersionNumber latestVersion = QVersionNumber::fromString(latestVersionStr);
             QVersionNumber currentVersion = QVersionNumber::fromString(applicationVersion());
-            //if (latestVersion.normalized() > currentVersion.normalized())
+            if (latestVersion.normalized() > currentVersion.normalized())
             {
-                // TODO: check if we failed to update to the latestVersion before, write in a statusbar?
-                //!!!forced update check must clear this value before calling app::checkForUpdate()!
+                if (_settings->getQSettings()->value("update/failed").toBool())
+                {
+                    auto savedVersion = QVersionNumber::fromString(_settings->getQSettings()->value("update/version").toString());
+                    if (latestVersion.normalized() == savedVersion.normalized())
+                    {
+                        _mainWindow->setStatusMessage(tr("Auto-update to %1 is blocked because it failed before. "
+                                                         "Use Help->Check For Updates to try again.").arg(latestVersionStr));
+                        return;
+                    }
+                    else
+                    {
+                        _settings->getQSettings()->remove("update");
+
+                        QDir updateDir(getUpdatePath());
+                        if (updateDir.exists()) updateDir.removeRecursively();
+                    }
+                }
 
                 UpdateDialog dlg(currentVersion, latestVersion, releaseInfo);
                 dlg.exec();
@@ -247,10 +267,10 @@ void Application::checkForUpdates()
 void Application::onUpdateError(const QUrl& url, const QString& errorString)
 {
     _mainWindow->setStatusMessage("Failed to check for updates");
-    qCritical() << "Network error '" << errorString << "' accessing " << url;
+    qCritical() << "Update error: '" << errorString << "' accessing " << url;
 
-    const auto response = QMessageBox::question(_mainWindow, "Update check failed",
-            QString("Update failed with error:\n%1\n\nOpen releases web page?").arg(errorString),
+    const auto response = QMessageBox::question(_mainWindow, tr("Update check failed"),
+            tr("Update failed with error:\n%1\n\nOpen releases web page?").arg(errorString),
             QMessageBox::Yes | QMessageBox::No,
             QMessageBox::Yes);
 
@@ -269,13 +289,75 @@ void Application::checkUpdateResults()
     if (!updateLaunched)
         QMessageBox::warning(_mainWindow, tr("Warning"), tr("An application was launched by an updater script but no update was scheduled!"));
 
+    int updateResult = -1;
+    QString updateMessage = "<Not launched by updater>";
     if (startedByUpdater)
     {
-        const auto updateResult = _cmdLine->value("updateResult").toInt();
-        const auto updateMessage = _cmdLine->value("updateMessage");
+        updateResult = _cmdLine->value("updateResult").toInt();
+        updateMessage = tr(_cmdLine->value("updateMessage").toUtf8());
+    }
+
+    auto currentVersion = QVersionNumber::fromString(applicationVersion());
+    auto savedVersion = QVersionNumber::fromString(_settings->getQSettings()->value("update/version").toString());
+    if (currentVersion.normalized() == savedVersion.normalized())
+    {
+        // Updated but couldn't remove a tmp folder, let's try again
+        if (updateResult == 30)
+        {
+            QDir backupDir(applicationDirPath() + "_old");
+            if (!backupDir.exists() || backupDir.removeRecursively())
+            {
+                updateResult = 0;
+                updateMessage = tr("Updated successfully");
+            }
+        }
 
-        //!!!DBG TMP!
-        QMessageBox::warning(_mainWindow, "Update results", tr("Code: %1\nMsg: %2").arg(updateResult).arg(updateMessage));
+        QDir updateDir(getUpdatePath());
+        if (updateDir.exists()) updateDir.removeRecursively();
+
+        auto releaseWebPage = _settings->getQSettings()->value("update/webPage").toString();
+        if (releaseWebPage.isEmpty())
+            releaseWebPage= "https://github.com/cegui/ceed-cpp/releases/tag/v" + currentVersion.toString();
+
+        _settings->getQSettings()->remove("update");
+
+        if (updateResult == 0 && startedByUpdater)
+        {
+            // NB: \n is replaced with <br/> to indicate Qt that this is a rich text
+            QMessageBox::information(_mainWindow, tr("Updated"),
+                                     tr("Updated to %1.<br/>"
+                                        "Visit <a href=\"%2\">release page</a> for the full release description.<br/><br/>"
+                                        "Updater result code: %3<br/>"
+                                        "Updater message: %4")
+                                     .arg(currentVersion.toString())
+                                     .arg(releaseWebPage)
+                                     .arg(updateResult)
+                                     .arg(updateMessage));
+        }
+        else
+        {
+            QMessageBox::warning(_mainWindow, tr("Updated with problems"),
+                                 tr("Application executable is updated to %1, yet something gone wrong. "
+                                    "Please check updater results and reinstall manually if you encounter problems.\n\n"
+                                    "Updater result code: %2\n"
+                                    "Updater message: %3")
+                                 .arg(currentVersion.toString())
+                                 .arg(updateResult)
+                                 .arg(updateMessage));
+        }
+    }
+    else
+    {
+        QMessageBox::critical(_mainWindow, tr("Update failed"),
+                              tr("Failed to update to %1.\n"
+                                 "Automatic update will be blocked for this version.\n"
+                                 "Use Help->Check For Updates to remove the block.\n\n"
+                                 "Updater result code: %2\n"
+                                 "Updater message: %3")
+                              .arg(savedVersion.toString())
+                              .arg(updateResult)
+                              .arg(updateMessage));
+        _settings->getQSettings()->setValue("update/failed", true);
     }
 }
 

src/Application.h

@@ -32,6 +32,7 @@ class Application : public QApplication
     void setActionsEnabled(const QString& groupId, bool enabled);
 
     QString getDocumentationPath() const;
+    QString getUpdatePath() const;
 
     void checkForUpdates();
 

src/ui/MainWindow.cpp

@@ -1350,6 +1350,14 @@ void MainWindow::on_actionNewOtherFile_triggered()
     }
 }
 
+void MainWindow::on_actionCheckForUpdates_triggered()
+{
+    // Forced check for update removes a failed flag which prevents an auto-update
+    auto app = qobject_cast<Application*>(qApp);
+    app->getSettings()->getQSettings()->remove("update/failed");
+    app->checkForUpdates();
+}
+
 void MainWindow::openNewEditor(EditorBasePtr editor)
 {
     if (!editor) return;

src/ui/MainWindow.h

@@ -119,6 +119,7 @@ private slots:
     void on_actionNewLayout_triggered();
     void on_actionNewImageset_triggered();
     void on_actionNewOtherFile_triggered();
+    void on_actionCheckForUpdates_triggered();
 
 private:
 

src/ui/dialogs/UpdateDialog.cpp

@@ -64,7 +64,14 @@ UpdateDialog::UpdateDialog(const QVersionNumber& currentVersion, const QVersionN
     }
     else
     {
+#ifdef Q_OS_WIN
         versionStr += tr(" (%3 MB)").arg(static_cast<double>(_releaseAssetSize) / MB, 0, 'f', 1);
+#else
+        // TODO: support auto-update for Linux & Mac!
+        ui->btnUpdate->setEnabled(false);
+        ui->btnUpdate->setText(tr("<Not auto-updatable>"));
+        ui->btnUpdate->setToolTip(tr("Auto-updates are not yet implemented for your OS,\nplease visit a release web page and download manually"));
+#endif
     }
 
     _releaseWebPage = releaseInfo.value("html_url").toString();
@@ -119,7 +126,8 @@ void UpdateDialog::closeEvent(QCloseEvent* event)
 
 void UpdateDialog::on_btnUpdate_clicked()
 {
-    QSettings* settings = qobject_cast<Application*>(qApp)->getSettings()->getQSettings();
+    auto app = qobject_cast<Application*>(qApp);
+    QSettings* settings = app->getSettings()->getQSettings();
 
     // Check if we already have an update package downloaded
     QString packageName;
@@ -133,8 +141,8 @@ void UpdateDialog::on_btnUpdate_clicked()
             packageName = settings->value("update/package", QString()).toString();
             if (!packageName.isEmpty())
             {
-                const QString fileName = QDir::tempPath() + QDir::separator() + "CEEDUpdate" + QDir::separator() + packageName + ".zip";
-                if (!QFileInfo::exists(fileName))
+                const QString fileName = QDir(app->getUpdatePath()).absoluteFilePath(packageName + ".zip");
+                if (QFileInfo(fileName).size() != _releaseAssetSize)
                     packageName.clear();
             }
         }
@@ -162,22 +170,18 @@ void UpdateDialog::downloadUpdate()
     // FIXME QTBUG: Qt 5.15.2 freezes in QMessageBox::question below
     //setWindowFlags(windowFlags() & ~Qt::WindowCloseButtonHint);
 
-    QDir tmpDir = QDir::temp();
-    if (tmpDir.cd("CEEDUpdate"))
-    {
-        // Our cache is verified to be invalid, let's erase it and start clean
-        tmpDir.removeRecursively();
-        tmpDir.cdUp();
-    }
+    auto app = qobject_cast<Application*>(qApp);
 
-    tmpDir.mkdir("CEEDUpdate");
-    tmpDir.cd("CEEDUpdate");
+    // Our cache is verified to be invalid, let's erase it and start clean
+    QDir updateDir(app->getUpdatePath());
+    if (updateDir.exists()) updateDir.removeRecursively();
+    updateDir.mkpath(".");
 
-    QSettings* settings = qobject_cast<Application*>(qApp)->getSettings()->getQSettings();
+    QSettings* settings = app->getSettings()->getQSettings();
     settings->remove("update");
 
     // Reserve disk space for the download
-    QFile file(tmpDir.absoluteFilePath(_releaseAssetFileName));
+    QFile file(updateDir.absoluteFilePath(_releaseAssetFileName));
     try
     {
         if (file.open(QFile::WriteOnly))
@@ -327,7 +331,9 @@ void UpdateDialog::installUpdate(const QString& packageName)
 
     // Unpack a zip package
 
-    QDir updateDir = QDir(QDir::temp().absoluteFilePath("CEEDUpdate"));
+    auto app = qobject_cast<Application*>(qApp);
+
+    QDir updateDir = QDir(app->getUpdatePath());
     QString packageDirPath = updateDir.absoluteFilePath(packageName);
     QDir packageDir(packageDirPath);
     const QString packageZipPath = packageDirPath + ".zip";
@@ -388,11 +394,11 @@ void UpdateDialog::installUpdate(const QString& packageName)
 #endif
 
     // Remember that we started an update to check results on the next CEED launch
-    QSettings* settings = qobject_cast<Application*>(qApp)->getSettings()->getQSettings();
+    QSettings* settings = app->getSettings()->getQSettings();
     settings->setValue("update/launched", true);
+    settings->setValue("update/webPage", _releaseWebPage.toString());
 
-    //!!!DBG TMP! TODO: uncomment!
-    //exit(0);
+    exit(0);
 }
 
 void UpdateDialog::onUpdateError(const QString& error)

src/util/Utils.cpp

@@ -17,9 +17,6 @@
 #undef min
 #undef max
 
-//!!!DBG TMP!
-#include <qdebug.h>
-
 namespace Utils
 {
 

ui/MainWindow.ui

@@ -155,6 +155,7 @@
     <addaction name="actionQt"/>
     <addaction name="actionLicense"/>
     <addaction name="separator"/>
+    <addaction name="actionCheckForUpdates"/>
     <addaction name="actionAbout"/>
    </widget>
    <widget class="QMenu" name="menu_Edit">
@@ -754,6 +755,14 @@
     <string>Ctrl+D</string>
    </property>
   </action>
+  <action name="actionCheckForUpdates">
+   <property name="text">
+    <string>Check For Updates</string>
+   </property>
+   <property name="toolTip">
+    <string>Checks the latest official release on GitHub</string>
+   </property>
+  </action>
  </widget>
  <resources>
   <include location="../data/Resources.qrc"/>