feat: WinUI Update Center (#112)

* feat: Better updating backend

* feat: Update center

Author: nlogozzo

libapplication/include/controllers/mainwindowcontroller.h

@@ -13,9 +13,11 @@
 #include <libnick/app/datafilemanager.h>
 #include <libnick/app/windowgeometry.h>
 #include <libnick/events/event.h>
+#include <libnick/events/parameventargs.h>
 #include <libnick/notifications/notificationsenteventargs.h>
 #include <libnick/taskbar/taskbaritem.h>
 #include <libnick/update/updater.h>
+#include <libnick/update/version.h>
 #include "controllers/preferencesviewcontroller.h"
 #include "models/startupinformation.h"
 #include "models/theme.h"
@@ -43,6 +45,16 @@ namespace Nickvision::Application::Shared::Controllers
          * @return The notification sent event
          */
         Nickvision::Events::Event<Nickvision::Notifications::NotificationSentEventArgs>& notificationSent();
+        /**
+         * @brief Gets the event for when an application update is available.
+         * @return The application update available event
+         */
+        Nickvision::Events::Event<Nickvision::Events::ParamEventArgs<Nickvision::Update::Version>>& appUpdateAvailable();
+        /**
+         * @brief Gets the event for when an application update's progress is changed.
+         * @return The application update progress changed event
+         */
+        Nickvision::Events::Event<Nickvision::Events::ParamEventArgs<double>>& appUpdateProgressChanged();
         /**
          * @brief Gets the AppInfo object for the application
          * @return The current AppInfo object
@@ -53,6 +65,16 @@ namespace Nickvision::Application::Shared::Controllers
          * @return The preferred theme
          */
         Models::Theme getTheme();
+        /**
+         * @brief Gets the preferred update type for the application.
+         * @return The preferred update type
+         */
+        Update::VersionType getPreferredUpdateType();
+        /**
+         * @brief Sets the preferred update type for the application.
+         * @param type The preferred update type
+         */
+        void setPreferredUpdateType(Update::VersionType type);
         /**
          * @brief Gets the debugging information for the application.
          * @param extraInformation Extra, ui-specific, information to include in the debug info statement
@@ -78,26 +100,19 @@ namespace Nickvision::Application::Shared::Controllers
         const Models::StartupInformation& startup(HWND hwnd);
 #elif defined(__linux__)
         const Models::StartupInformation& startup(const std::string& desktopFile);
-#else     
+#else
         const Models::StartupInformation& startup();
 #endif
         /**
          * @brief Shuts down the application.
          * @param geometry The window geometry to save
          */
         void shutdown(const Nickvision::App::WindowGeometry& geometry);
-        /**
-         * @brief Checks for an application update and sends a notification if one is available.
-         * @param noUpdateNotification Send an app notification if no update is available.
-         */
-        void checkForUpdates(bool noUpdateNotification) const;
 #ifdef _WIN32
         /**
-         * @brief Downloads and installs the latest application update in the background.
-         * @brief Will send a notification if the update fails.
-         * @brief MainWindowController::checkForUpdates() must be called before this method.
+         * @brief Starts downloading and installing the latest application update for Windows in the background.
          */
-        void windowsUpdate();
+        void startWindowsUpdate();
 #endif
         /**
          * @brief Gets the string for greeting on the home page.
@@ -138,6 +153,8 @@ namespace Nickvision::Application::Shared::Controllers
     private:
         bool m_started;
         std::vector<std::string> m_args;
+        Nickvision::Events::Event<Nickvision::Events::ParamEventArgs<Nickvision::Update::Version>> m_appUpdateAvailable;
+        Nickvision::Events::Event<Nickvision::Events::ParamEventArgs<double>> m_appUpdateProgressChanged;
         Nickvision::App::AppInfo m_appInfo;
         Nickvision::App::DataFileManager m_dataFileManager;
         std::shared_ptr<Nickvision::Update::Updater> m_updater;

libapplication/include/controllers/preferencesviewcontroller.h

@@ -47,16 +47,6 @@ namespace Nickvision::Application::Shared::Controllers
          * @param index The index of the preferred translation language in the available languages list
          */
         void setTranslationLanguage(size_t index);
-        /**
-         * @brief Gets whether or not to automatically check for application updates.
-         * @return True to automatically check for updates, else false
-         */
-        bool getAutomaticallyCheckForUpdates() const;
-        /**
-         * @brief Sets whether or not to automatically check for application updates.
-         * @param check Whether or not to automatically check for updates
-         */
-        void setAutomaticallyCheckForUpdates(bool check);
         /**
          * @brief Saves the current configuration to disk.
          */

libapplication/include/models/configuration.h

@@ -4,6 +4,7 @@
 #include <string>
 #include <libnick/app/datafilebase.h>
 #include <libnick/app/windowgeometry.h>
+#include <libnick/update/versiontype.h>
 #include "theme.h"
 
 namespace Nickvision::Application::Shared::Models
@@ -54,15 +55,15 @@ namespace Nickvision::Application::Shared::Models
          */
         void setWindowGeometry(const App::WindowGeometry& geometry);
         /**
-         * @brief Gets whether or not to automatically check for application updates.
-         * @return True to automatically check for updates, else false
+         * @brief Gets the preferred update type for the application.
+         * @return The preferred update type
          */
-        bool getAutomaticallyCheckForUpdates() const;
+        Update::VersionType getPreferredUpdateType() const;
         /**
-         * @brief Sets whether or not to automatically check for application updates.
-         * @param check Whether or not to automatically check for updates
+         * @brief Sets the preferred update type for the application.
+         * @param type The new preferred update type
          */
-        void setAutomaticallyCheckForUpdates(bool check);
+        void setPreferredUpdateType(Update::VersionType type);
     };
 }
 

libapplication/src/controllers/mainwindowcontroller.cpp

@@ -53,9 +53,7 @@ namespace Nickvision::Application::Shared::Controllers
         {
             Gettext::changeLanguage(translationLanguage);
         }
-#ifdef _WIN32
         m_updater = std::make_shared<Updater>(m_appInfo.getSourceRepo());
-#endif
     }
 
     Event<EventArgs>& MainWindowController::configurationSaved()
@@ -68,6 +66,16 @@ namespace Nickvision::Application::Shared::Controllers
         return AppNotification::sent();
     }
 
+    Event<ParamEventArgs<Version>>& MainWindowController::appUpdateAvailable()
+    {
+        return m_appUpdateAvailable;
+    }
+
+    Event<ParamEventArgs<double>>& MainWindowController::appUpdateProgressChanged()
+    {
+        return m_appUpdateProgressChanged;
+    }
+
     const AppInfo& MainWindowController::getAppInfo() const
     {
         return m_appInfo;
@@ -78,6 +86,16 @@ namespace Nickvision::Application::Shared::Controllers
         return m_dataFileManager.get<Configuration>(CONFIG_FILE_KEY).getTheme();
     }
 
+    VersionType MainWindowController::getPreferredUpdateType()
+    {
+        return m_dataFileManager.get<Configuration>(CONFIG_FILE_KEY).getPreferredUpdateType();
+    }
+
+    void MainWindowController::setPreferredUpdateType(VersionType type)
+    {
+        m_dataFileManager.get<Configuration>(CONFIG_FILE_KEY).setPreferredUpdateType(type);
+    }
+
     std::string MainWindowController::getDebugInformation(const std::string& extraInformation) const
     {
         std::stringstream builder;
@@ -120,13 +138,22 @@ namespace Nickvision::Application::Shared::Controllers
         //Load taskbar item
 #ifdef _WIN32
         m_taskbar.connect(hwnd);
-        if (m_dataFileManager.get<Configuration>(CONFIG_FILE_KEY).getAutomaticallyCheckForUpdates())
-        {
-            checkForUpdates(false);
-        }
 #elif defined(__linux__)
         m_taskbar.connect(desktopFile);
 #endif
+        //Start checking for app updates
+        std::thread workerUpdates{ [this]()
+        {
+            Version latest{ m_updater->fetchCurrentVersion(getPreferredUpdateType()) };
+            if(!latest.empty())
+            {
+                if(latest > m_appInfo.getVersion())
+                {
+                    m_appUpdateAvailable.invoke({ latest });
+                }
+            }
+        } };
+        workerUpdates.detach();
         m_started = true;
         return info;
     }
@@ -138,46 +165,26 @@ namespace Nickvision::Application::Shared::Controllers
         config.save();
     }
 
-    void MainWindowController::checkForUpdates(bool noUpdateNotification) const
+#ifdef _WIN32
+    void MainWindowController::startWindowsUpdate()
     {
-        if(!m_updater)
-        {
-            return;
-        }
-        std::thread worker{ [this, noUpdateNotification]()
+        std::thread worker{ [this]()
         {
-            Version latest{ m_updater->fetchCurrentVersion(VersionType::Stable) };
-            if(!latest.empty())
+            m_appUpdateProgressChanged.invoke({ 0.0 });
+            bool res{ m_updater->windowsUpdate(getPreferredUpdateType(), { [this](curl_off_t downloadTotal, curl_off_t downloadNow, curl_off_t, curl_off_t, intptr_t) -> bool
             {
-                if(latest > m_appInfo.getVersion())
+                if(downloadTotal == 0)
                 {
-#ifdef PORTABLE_BUILD
-                    AppNotification::send({ _("New version of Application available"), NotificationSeverity::Success });
-#else
-                    AppNotification::send({ _("New version of Application available"), NotificationSeverity::Success, "update" });
-#endif
-                    return;
+                    return true;
                 }
-            }
-            if(noUpdateNotification)
+                m_appUpdateProgressChanged.invoke({ static_cast<double>(static_cast<long double>(downloadNow) / static_cast<long double>(downloadTotal)) });
+                return true;
+            } }) };
+            if(res)
             {
-                AppNotification::send({ _("No Application update available"), NotificationSeverity::Warning });
+                m_appUpdateProgressChanged.invoke({ 1.0 });
             }
-        } };
-        worker.detach();
-    }
-
-#ifdef _WIN32
-    void MainWindowController::windowsUpdate()
-    {
-        if(!m_updater)
-        {
-            return;
-        }
-        AppNotification::send({ _("The update is downloading in the background and will start once it finishes"), NotificationSeverity::Informational });
-        std::thread worker{ [this]()
-        {
-            if(!m_updater->windowsUpdate(VersionType::Stable))
+            else
             {
                 AppNotification::send({ _("Unable to download and install update"), NotificationSeverity::Error });
             }

libapplication/src/controllers/preferencesviewcontroller.cpp

@@ -77,16 +77,6 @@ namespace Nickvision::Application::Shared::Controllers
         }
     }
 
-    bool PreferencesViewController::getAutomaticallyCheckForUpdates() const
-    {
-        return m_configuration.getAutomaticallyCheckForUpdates();
-    }
-
-    void PreferencesViewController::setAutomaticallyCheckForUpdates(bool check)
-    {
-        m_configuration.setAutomaticallyCheckForUpdates(check);
-    }
-
     void PreferencesViewController::saveConfiguration()
     {
         m_configuration.save();

libapplication/src/models/configuration.cpp

@@ -1,8 +1,7 @@
 #include "models/configuration.h"
-#include <libnick/system/environment.h>
 
 using namespace Nickvision::App;
-using namespace Nickvision::System;
+using namespace Nickvision::Update;
 
 namespace Nickvision::Application::Shared::Models
 {
@@ -46,13 +45,13 @@ namespace Nickvision::Application::Shared::Models
         m_json["WindowGeometry"] = geometry.toJson();
     }
 
-    bool Configuration::getAutomaticallyCheckForUpdates() const
+    VersionType Configuration::getPreferredUpdateType() const
     {
-        return m_json["AutomaticallyCheckForUpdates"].is_bool() ? m_json["AutomaticallyCheckForUpdates"].as_bool() : Environment::getOperatingSystem() == OperatingSystem::Windows;
+        return m_json["PreferredUpdateType"].is_int64() ? static_cast<VersionType>(m_json["PreferredUpdateType"].as_int64()) : VersionType::Stable;
     }
 
-    void Configuration::setAutomaticallyCheckForUpdates(bool check)
+    void Configuration::setPreferredUpdateType(VersionType type)
     {
-        m_json["AutomaticallyCheckForUpdates"] = check;
+        m_json["PreferredUpdateType"] = static_cast<int>(type);
     }
 }

org.nickvision.application.winui/CMakeLists.txt

@@ -22,7 +22,6 @@ if(WIN32)
         "../resources/windows/${PROJECT_NAME}.manifest"
         "../resources/windows/${PROJECT_NAME}.rc"
         "pch.cpp" "pch.h"
-        "Controls/AboutDialog.xaml.cpp" "Controls/AboutDialog.xaml.h" "Controls/AboutDialog.xaml" "Controls/AboutDialog.idl"
         "Controls/SettingsRow.xaml.cpp" "Controls/SettingsRow.xaml.h" "Controls/SettingsRow.xaml" "Controls/SettingsRow.idl"
         "Controls/StatusPage.xaml.cpp" "Controls/StatusPage.xaml.h" "Controls/StatusPage.xaml" "Controls/StatusPage.idl"
         "Controls/TitleBar.xaml.cpp" "Controls/TitleBar.xaml.h" "Controls/TitleBar.xaml" "Controls/TitleBar.idl"