qSlicerApplicationUpdateManager.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

==============================================================================*/

#ifndef __qSlicerApplicationUpdateManager_h
#define __qSlicerApplicationUpdateManager_h

// Qt includes
#include <QObject>
#include <QUrl>
#include <QUuid>

// QtGUI includes
#include "qSlicerBaseQTCoreExport.h"

class qSlicerApplicationUpdateManagerPrivate;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerApplicationUpdateManager : public QObject
{
  Q_OBJECT
  Q_PROPERTY(QString slicerRevision READ slicerRevision)
  Q_PROPERTY(QString slicerOs READ slicerOs)
  Q_PROPERTY(QString slicerArch READ slicerArch)
  Q_PROPERTY(bool autoUpdateCheck READ autoUpdateCheck WRITE setAutoUpdateCheck NOTIFY autoUpdateCheckChanged)
  Q_PROPERTY(bool isUpdateAvailable READ isUpdateAvailable NOTIFY updateAvailable)
  Q_PROPERTY(QString latestReleaseVersion READ latestReleaseVersion)
  Q_PROPERTY(QUrl applicationDownloadPageUrl READ applicationDownloadPageUrl)

public:
  typedef QObject Superclass;

  typedef qSlicerApplicationUpdateManagerPrivate Pimpl;

  typedef qSlicerApplicationUpdateManager Self;

  explicit qSlicerApplicationUpdateManager(QObject* parent = nullptr);

  ~qSlicerApplicationUpdateManager() override;

  Q_INVOKABLE QUrl serverUrl()const;

  bool autoUpdateCheck()const;

  bool checkForUpdate(bool force, bool waitForCompletion);

  QDateTime lastUpdateCheckTime() const;

  bool isUpdateAvailable() const;

  QString latestReleaseVersion() const;

  QString latestReleaseRevision() const;

  QUrl applicationDownloadPageUrl() const;

  QString slicerRevision()const;

  QString slicerOs()const;

  QString slicerArch()const;

  void setSlicerRequirements(const QString& revision, const QString& os, const QString& arch);

  static bool isApplicationUpdateEnabled();

public slots:

  void checkForUpdate();

  void setAutoUpdateCheck(bool enable);

signals:

  void updateAvailable(bool isAvailable);

  void updateCheckCompleted(bool success);

  void slicerRequirementsChanged(const QString& revision, const QString& os, const QString& arch);

  void autoUpdateCheckChanged();

protected slots:

  bool onReleaseInfoQueryFinished(const QUuid& requestId);
  void refreshUpdateAvailable();

protected:
  QScopedPointer<qSlicerApplicationUpdateManagerPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerApplicationUpdateManager);
  Q_DISABLE_COPY(qSlicerApplicationUpdateManager);
};

#endif