software_update.h

Go to the documentation of this file.

 
#ifndef SOFTWARE_UPDATE_H
#define SOFTWARE_UPDATE_H
 
#include <QObject>
#include <QUrl>
#include <QMutex>
#include <QTimer>
#include <QVersionNumber>
 
class QNetworkAccessManager;
class QNetworkReply;
 
class ShutdownEvent {
public:
    void accept();
    void reject(const QString& reason = {});
 
    bool isAccepted() const;
    QString reason() const;
 
private:
    bool accepted_ = false;
    bool rejected_ = false;
    QString reason_;
};
 
struct AppcastItem {
    QString title;
    QVersionNumber version;
    QVersionNumber shortVersion;
    QUrl downloadUrl;
    QUrl releaseNotesUrl;
    QString os;           // "windows", "macos", or empty (= all)
    qint64 length = 0;
    QString edSignature;
};
 
class SoftwareUpdate : public QObject
{
        Q_OBJECT
public:
    SoftwareUpdate(const SoftwareUpdate&) = delete;
    SoftwareUpdate& operator=(const SoftwareUpdate&) = delete;
 
    static SoftwareUpdate* instance();
 
    void init(bool runWithoutSilentCheck = false);
 
    void cleanup();
 
    static void performUIUpdate();
 
    static QString info();
 
    static bool plattformSupported();
 
    /**** Utility functions if the automatic update check needs to be manipulated through the UI ****/
 
    void startAutoCheck(int intervalSeconds = 0);
    void stopAutoCheck();
    bool isAutoCheckEnabled() const;
 
signals:
    void updateAvailable(QString newVersion, QString releaseNotes);
    void updateCheckFailed(const QString& errorString);
    void updateEngaged();
    void appShutdownRequested(ShutdownEvent* shutdownEvent);
 
private:
    static SoftwareUpdate* instance_;
    static QMutex mutex_;
    static QMutex updateMutex_;
 
    QTimer* updateCheckTimer_;
    QNetworkAccessManager* networkAccessManager_;
 
    QUrl updateUrl() const;
    QList<AppcastItem> parseAppcast(const QByteArray &data) const;
 
#if defined(_WIN32)
    static int __cdecl softwareUpdateCanShutdownCallback();
    static void __cdecl shutdownRequestCallback();
    static void __cdecl softwareUpdateEngaged();
#elif defined(__APPLE__)
    static void onPostponeRelaunch(void (*proceed)(void *ctx), void *ctx);
#endif /* if */
 
private slots:
    void onNetworkReplyFinished(QNetworkReply* reply);
    void checkForUpdates();
 
protected:
    explicit SoftwareUpdate(QObject *parent = nullptr);
    ~SoftwareUpdate();
};
 
#endif /* SOFTWARE_UPDATE_H */