#42 Enable reading update info from GitHub Packages REST API

src/blackconfig/buildconfig.cpp

@@ -149,6 +149,18 @@ namespace BlackConfig
         }
     }
 
+    const QString& CBuildConfig::gitHubRepoUrl()
+    {
+        static const QString url = "https://github.com/swift-project/pilotclient/";
+        return url;
+    }
+
+    const QString& CBuildConfig::gitHubRepoApiUrl()
+    {
+        static const QString url = "https://api.github.com/repos/swift-project/pilotclient/";
+        return url;
+    }
+
     const QString &CBuildConfig::buildDateAndTime()
     {
         // http://en.cppreference.com/w/cpp/preprocessor/replace#Predefined_macros

src/blackconfig/buildconfig.h

@@ -118,6 +118,12 @@ namespace BlackConfig
         //! Vatsim client key
         static const QString &vatsimPrivateKey(); // defined in buildconfig_gen.cpp.in
 
+        //! GitHub repository URL
+        static const QString &gitHubRepoUrl();
+
+        //! GitHub Packages REST API URL
+        static const QString &gitHubRepoApiUrl();
+
         //! Returns SHA-1 of git HEAD at build time
         static const QString &gitHeadSha1();
 

src/blackcore/application.cpp

@@ -159,11 +159,15 @@ namespace BlackCore
             m_setupReader.reset(new CSetupReader(this));
             connect(m_setupReader.data(), &CSetupReader::setupHandlingCompleted, this, &CApplication::onSetupHandlingCompleted, Qt::QueuedConnection);
             connect(m_setupReader.data(), &CSetupReader::setupHandlingCompleted, this, &CApplication::setupHandlingCompleted, Qt::QueuedConnection); // hand thru
-            connect(m_setupReader.data(), &CSetupReader::updateInfoAvailable, this, &CApplication::updateInfoAvailable, Qt::QueuedConnection);
             connect(m_setupReader.data(), &CSetupReader::successfullyReadSharedUrl, m_networkWatchDog, &CNetworkWatchdog::setWorkingSharedUrl, Qt::QueuedConnection);
 
             this->addParserOptions(m_setupReader->getCmdLineOptions()); // add options from reader
 
+            // check for updates
+            m_gitHubPackagesReader.reset(new CGitHubPackagesReader(this));
+            connect(m_gitHubPackagesReader.data(), &CGitHubPackagesReader::updateInfoAvailable, this, &CApplication::updateInfoAvailable, Qt::QueuedConnection);
+            reloadUpdateInfo();
+
             // startup done
             connect(this, &CApplication::startUpCompleted, this, &CApplication::onStartUpCompleted, Qt::QueuedConnection);
             connect(this, &CApplication::coreFacadeStarted, this, &CApplication::onCoreFacadeStarted, Qt::QueuedConnection);
@@ -336,9 +340,15 @@ namespace BlackCore
     CUpdateInfo CApplication::getUpdateInfo() const
     {
         if (m_shutdown) { return CUpdateInfo(); }
-        const CSetupReader *r = m_setupReader.data();
+        if (!m_gitHubPackagesReader) { return CUpdateInfo(); }
-        if (!r) { return CUpdateInfo(); }
+        return m_gitHubPackagesReader->getUpdateInfo();
-        return r->getUpdateInfo();
+    }
+
+    void CApplication::reloadUpdateInfo()
+    {
+        if (m_shutdown) { return; }
+        if (!m_gitHubPackagesReader) { return; }
+        m_gitHubPackagesReader->readUpdateInfo();
     }
 
     CDistribution CApplication::getOwnDistribution() const
@@ -1099,6 +1109,11 @@ namespace BlackCore
             m_webDataServices.reset();
         }
 
+        if (m_gitHubPackagesReader)
+        {
+            m_gitHubPackagesReader.reset();
+        }
+
         if (m_setupReader)
         {
             m_setupReader->gracefulShutdown();

src/blackcore/application.h

@@ -15,6 +15,7 @@
 #include "blackcore/corefacadeconfig.h"
 #include "blackcore/db/databasereaderconfig.h"
 #include "blackcore/data/globalsetup.h"
+#include "blackcore/githubpackagesreader.h"
 #include "blackcore/application/applicationsettings.h"
 #include "blackcore/inputmanager.h"
 #include "blackcore/webreaderflags.h"
@@ -166,9 +167,11 @@ namespace BlackCore
         Data::CGlobalSetup getGlobalSetup() const;
 
         //! Update info
-        //! \threadsafe
         BlackMisc::Db::CUpdateInfo getUpdateInfo() const;
 
+        //! Reload update info
+        void reloadUpdateInfo();
+
         //! Own distribution
         //! \threadsafe
         BlackMisc::Db::CDistribution getOwnDistribution() const;
@@ -714,6 +717,7 @@ namespace BlackCore
         BlackMisc::CApplicationInfo            m_applicationInfo;         //!< Application if specified
         QScopedPointer<CCoreFacade>            m_coreFacade;              //!< core facade if any
         QScopedPointer<CSetupReader>           m_setupReader;             //!< setup reader
+        QScopedPointer<CGitHubPackagesReader>  m_gitHubPackagesReader;    //!< github packages reader
         QScopedPointer<CWebDataServices>       m_webDataServices;         //!< web data services
         QScopedPointer<BlackMisc::CFileLogger> m_fileLogger;              //!< file logger
         QPointer<CCookieManager>               m_cookieManager;           //!< single cookie manager for our access manager

src/blackcore/githubpackagesreader.cpp

@@ -0,0 +1,52 @@
+/* Copyright (C) 2020
+ * swift project community / contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
+ * or distributed except according to the terms contained in the LICENSE file.
+ */
+
+//! \file
+
+#include "githubpackagesreader.h"
+#include "blackcore/application.h"
+#include "blackconfig/buildconfig.h"
+#include <QNetworkAccessManager>
+#include <QNetworkRequest>
+#include <QNetworkReply>
+#include <QStringBuilder>
+#include <QUrl>
+
+using namespace BlackMisc::Db;
+using namespace BlackConfig;
+
+namespace BlackCore
+{
+    CGitHubPackagesReader::CGitHubPackagesReader(QObject *parent) : QObject(parent)
+    {}
+
+    void CGitHubPackagesReader::readUpdateInfo()
+    {
+        // https://docs.github.com/en/rest/reference/repos#releases
+
+        const QNetworkRequest request(QUrl(CBuildConfig::gitHubRepoApiUrl() % u"releases"));
+        auto reply = sApp->getNetworkAccessManager()->get(request);
+        connect(reply, &QNetworkReply::finished, this, [this, reply]
+        {
+            if (reply->error() == QNetworkReply::NoError)
+            {
+                const auto updateInfo = CUpdateInfo::fromGitHubReleasesJson(reply->readAll());
+                if (!updateInfo.isEmpty())
+                {
+                    m_updateInfo.set(updateInfo);
+                }
+            }
+            reply->deleteLater();
+        });
+    }
+
+    CUpdateInfo CGitHubPackagesReader::getUpdateInfo() const
+    {
+        return m_updateInfo.get();
+    }
+}

src/blackcore/githubpackagesreader.h

@@ -0,0 +1,45 @@
+/* Copyright (C) 2020
+ * swift project community / contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
+ * or distributed except according to the terms contained in the LICENSE file.
+ */
+
+//! \file
+
+#ifndef BLACKCORE_GITHUBPACKAGESREADER_H
+#define BLACKCORE_GITHUBPACKAGESREADER_H
+
+#include "blackmisc/db/updateinfo.h"
+#include <QObject>
+
+namespace BlackCore
+{
+    /*!
+     * Read available updates from GitHub Packages REST API.
+     */
+    class CGitHubPackagesReader : public QObject
+    {
+        Q_OBJECT
+
+    public:
+        //! Constructor.
+        CGitHubPackagesReader(QObject *parent = nullptr);
+
+        //! Read updates from GitHub Packages.
+        void readUpdateInfo();
+
+        //! Get updates cached from previous read.
+        BlackMisc::Db::CUpdateInfo getUpdateInfo() const;
+
+    signals:
+        //! Updates have been received from GitHub Packages.
+        void updateInfoAvailable(bool available);
+
+    private:
+        BlackMisc::CData<BlackMisc::Db::TUpdateInfo> m_updateInfo { this };
+    };
+}
+
+#endif

src/blackgui/components/updateinfocomponent.cpp

@@ -86,8 +86,7 @@ namespace BlackGui
         void CUpdateInfoComponent::requestLoadOfSetup()
         {
             if (!sGui || sGui->isShuttingDown()) { return; }
-            const CStatusMessageList msgs(sGui->requestReloadOfSetupAndVersion());
+            sGui->reloadUpdateInfo();
-            CLogMessage::preformatted(msgs);
         }
 
         void CUpdateInfoComponent::changedUpdateInfo()

src/blackmisc/db/updateinfo.cpp

@@ -7,8 +7,12 @@
  */
 
 #include "updateinfo.h"
+#include "blackmisc/stringutils.h"
 #include "blackconfig/buildconfig.h"
 #include <QStringBuilder>
+#include <QJsonDocument>
+#include <QJsonObject>
+#include <QJsonArray>
 
 using namespace BlackConfig;
 
@@ -148,5 +152,56 @@ namespace BlackMisc
             if (jsonString.isEmpty()) { return CUpdateInfo(); }
             return CUpdateInfo::fromDatabaseJson(Json::jsonObjectFromString(jsonString));
         }
+
+        CUpdateInfo CUpdateInfo::fromGitHubReleasesJson(const QByteArray &jsonData)
+        {
+            // https://docs.github.com/en/rest/reference/repos#releases
+
+            const QString url = CBuildConfig::gitHubRepoUrl() + QStringLiteral("releases/download");
+            CDistribution alphaDistribution("ALPHA", 5, false);
+            CDistribution betaDistribution("BETA", 10, false);
+            alphaDistribution.addDownloadUrl(url);
+            betaDistribution.addDownloadUrl(url);
+
+            CUpdateInfo result;
+            result.m_distributions = { alphaDistribution, betaDistribution };
+
+            for (const QJsonValue &release : QJsonDocument::fromJson(jsonData).array())
+            {
+                QString version = release[QLatin1String("tag_name")].toString();
+                if (version.isEmpty() || version[0] != 'v') { continue; }
+                version.remove(0, 1);
+                if (containsChar(version, [](QChar c) { return c != '.' && !is09(c); })) { continue; }
+
+                bool existing = !release[QLatin1String("draft")].toBool();
+                bool alpha = release[QLatin1String("prerelease")].toBool();
+
+                for (const QJsonValue &asset : release[QLatin1String("assets")].toArray())
+                {
+                    QString name = asset[QLatin1String("name")].toString();
+                    QString filename = QStringLiteral("v%1/%2").arg(version, name);
+                    int size = asset[QLatin1String("size")].toInt();
+
+                    CArtifact::ArtifactType type = CArtifact::UnknownArtifact;
+                    if      (name.startsWith(QStringLiteral("swiftinstaller"))) { type = CArtifact::PilotClientInstaller; }
+                    else if (name.startsWith(QStringLiteral("swiftsymbols")))   { type = CArtifact::Symbols; }
+                    else if (name.startsWith(QStringLiteral("xswiftbus")))      { type = CArtifact::XSwiftBus; }
+
+                    CPlatform platform;
+                    if      (name.contains(QStringLiteral("windows-32"))) { platform = CPlatform::win32Platform(); }
+                    else if (name.contains(QStringLiteral("windows-64"))) { platform = CPlatform::win64Platform(); }
+                    else if (name.contains(QStringLiteral("linux-64")))   { platform = CPlatform::linuxPlatform(); }
+                    else if (name.contains(QStringLiteral("macos-64")))   { platform = CPlatform::macOSPlatform(); }
+                    else if (name.contains(QStringLiteral("allos")))      { platform = CPlatform::allOs(); }
+
+                    CArtifact artifact(filename, version, {}, type, size, existing, platform);
+                    artifact.setDistributions({ alpha ? alphaDistribution : betaDistribution });
+
+                    if (type == CArtifact::PilotClientInstaller) { result.m_artifactsPilotClient.push_back(artifact); }
+                    else if (type == CArtifact::XSwiftBus) { result.m_artifactsXSwiftBus.push_back(artifact); }
+                }
+            }
+            return result;
+        }
     } // ns
 } // ns

src/blackmisc/db/updateinfo.h

@@ -97,6 +97,9 @@ namespace BlackMisc
             //! Object from database JSOn format
             static CUpdateInfo fromDatabaseJson(const QString &jsonString);
 
+            //! Object from GitHub Releases REST API JSON format
+            static CUpdateInfo fromGitHubReleasesJson(const QByteArray &jsonData);
+
         private:
             CArtifactList m_artifactsPilotClient; //!< artifacts pilot client
             CArtifactList m_artifactsXSwiftBus;   //!< artifacts XSwiftBus