qSlicerExtensionsManagerModel.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.

  This file was originally developed by Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qSlicerExtensionsManagerModel_h
#define __qSlicerExtensionsManagerModel_h

// Qt includes
#include <QHash>
#include <QStringList>
#include <QUrl>
#include <QSettings>
#include <QUuid>
#include <QVariantMap>

// CTK includes
#include <ctkErrorLogModel.h>

// QtGUI includes
#include "qSlicerBaseQTCoreExport.h"
#include "qSlicerExtensionDownloadTask.h"

class QNetworkReply;
class qSlicerExtensionsManagerModelPrivate;
class QStandardItemModel;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerExtensionsManagerModel : public QObject
{
  Q_OBJECT
  Q_PROPERTY(int numberOfInstalledExtensions READ numberOfInstalledExtensions NOTIFY modelUpdated)
  Q_PROPERTY(int installedExtensionsCount READ installedExtensionsCount NOTIFY modelUpdated)
  Q_PROPERTY(int managedExtensionsCount READ managedExtensionsCount NOTIFY modelUpdated)
  Q_PROPERTY(QStringList managedExtensions READ managedExtensions NOTIFY modelUpdated)
  Q_PROPERTY(QStringList bookmarkedExtensions READ bookmarkedExtensions NOTIFY modelUpdated)
  Q_PROPERTY(QStringList installedExtensions READ installedExtensions NOTIFY modelUpdated)
  Q_PROPERTY(QStringList enabledExtensions READ enabledExtensions NOTIFY modelUpdated)
  Q_PROPERTY(QStringList availableUpdateExtensions READ availableUpdateExtensions NOTIFY modelUpdated)
  Q_PROPERTY(bool newExtensionEnabledByDefault READ newExtensionEnabledByDefault WRITE setNewExtensionEnabledByDefault NOTIFY newExtensionEnabledByDefaultChanged)
  Q_PROPERTY(bool interactive READ interactive WRITE setInteractive NOTIFY interactiveChanged)
  Q_PROPERTY(QString extensionsSettingsFilePath READ extensionsSettingsFilePath WRITE setExtensionsSettingsFilePath NOTIFY extensionsSettingsFilePathChanged)
  Q_PROPERTY(QString slicerRevision READ slicerRevision WRITE setSlicerRevision NOTIFY slicerRevisionChanged)
  Q_PROPERTY(QString slicerOs READ slicerOs WRITE setSlicerOs NOTIFY slicerOsChanged)
  Q_PROPERTY(QString slicerArch READ slicerArch WRITE setSlicerArch NOTIFY slicerArchChanged)
  Q_PROPERTY(bool autoUpdateCheck READ autoUpdateCheck WRITE setAutoUpdateCheck NOTIFY autoUpdateSettingsChanged)
  Q_PROPERTY(bool autoUpdateInstall READ autoUpdateInstall WRITE setAutoUpdateInstall NOTIFY autoUpdateSettingsChanged)
  Q_PROPERTY(bool autoInstallDependencies READ autoInstallDependencies WRITE setAutoInstallDependencies NOTIFY autoUpdateSettingsChanged)
  Q_PROPERTY(QStringList activeTasks READ activeTasks NOTIFY activeTasksChanged DESIGNABLE false)

public:
  typedef QObject Superclass;

  typedef qSlicerExtensionsManagerModelPrivate Pimpl;

  typedef qSlicerExtensionsManagerModel Self;

  explicit qSlicerExtensionsManagerModel(QObject* parent = nullptr);

  ~qSlicerExtensionsManagerModel() override;

  typedef QVariantMap ExtensionMetadataType;

  enum ServerAPI
    {
    Girder_v1 = 1,
    ServerAPI_Last
    };

  int serverAPI() const;

  static QString serverAPIToString(int serverAPI);

  static int serverAPIFromString(const QString& str);

  Q_INVOKABLE QUrl serverUrl()const;

  Q_INVOKABLE QUrl frontendServerUrl()const;

  Q_INVOKABLE QUrl extensionsListUrl()const;

  Q_INVOKABLE QString extensionsInstallPath()const;

  Q_INVOKABLE QString extensionInstallPath(const QString& extensionName) const;

  Q_INVOKABLE QStringList extensionModulePaths(const QString& extensionName)const;

  Q_INVOKABLE QString extensionDescriptionFile(const QString& extensionName) const;

  void setNewExtensionEnabledByDefault(bool value);
  bool newExtensionEnabledByDefault()const;

  bool autoUpdateCheck()const;
  bool autoUpdateInstall()const;
  bool autoInstallDependencies()const;

  bool interactive()const;

  enum MatadataSource
    {
    MetadataAll = 0, 
    MetadataLocal,   
    MetadataServer   
    };
  Q_INVOKABLE ExtensionMetadataType extensionMetadata(const QString& extensionName, int source = MetadataAll)const;

  Q_INVOKABLE QString extensionDescription(const QString& extensionName)const;

  int managedExtensionsCount()const;

  QStringList managedExtensions()const;

  bool isExtensionLoaded(const QString& extensionName) const;

  Q_INVOKABLE bool isExtensionInstalled(const QString& extensionName)const;

  int installedExtensionsCount()const;

  int numberOfInstalledExtensions()const;

  QStringList installedExtensions()const;

  Q_INVOKABLE bool isExtensionBookmarked(const QString& extensionName)const;

  Q_INVOKABLE bool isExtensionEnabled(const QString& extensionName)const;

  QStringList scheduledForUpdateExtensions() const;

  Q_INVOKABLE bool isExtensionUpdateAvailable(const QString& extensionName)const;

  QStringList availableUpdateExtensions()const;

  Q_INVOKABLE bool isExtensionScheduledForUpdate(const QString& extensionName)const;

  QStringList scheduledForUninstallExtensions() const;

  Q_INVOKABLE bool isExtensionScheduledForUninstall(const QString& extensionName)const;

  QStringList bookmarkedExtensions()const;

  QStringList enabledExtensions()const;

  QString extensionsSettingsFilePath()const;
  void setExtensionsSettingsFilePath(const QString& extensionsSettingsFilePath);

  QString slicerRevision()const;
  void setSlicerRevision(const QString& revision);

  QString slicerOs()const;
  void setSlicerOs(const QString& os);

  QString slicerArch()const;
  void setSlicerArch(const QString& arch);

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

  QString slicerVersion()const;
  void setSlicerVersion(const QString& version);

  Q_INVOKABLE QStringList isExtensionCompatible(const QString& extensionName, const QString& slicerRevision,
                                                const QString& slicerOs, const QString& slicerArch) const;

  Q_INVOKABLE QStringList isExtensionCompatible(const QString& extensionName) const;

  Q_INVOKABLE bool installExtension(const QString &archiveFile, bool installDependencies = true, bool waitForCompletion = false);

  Q_INVOKABLE bool installExtension(const QString& extensionName,
                                    ExtensionMetadataType extensionMetadata,
                                    const QString &archiveFile, bool installDependencies = true,
                                    bool waitForCompletion = false);

  bool uninstallExtension(const QString& extensionName);

  Q_INVOKABLE bool extractExtensionArchive(const QString& extensionName,
                                           const QString& archiveFile,
                                           const QString &destinationPath);

  Q_INVOKABLE const QStandardItemModel * model()const;

  QDateTime lastUpdateTimeExtensionsMetadataFromServer();

  QStringList activeTasks() const;

  static QHash<QString, QString> serverToExtensionDescriptionKey(int serverAPI);

  static ExtensionMetadataType convertExtensionMetadata(const ExtensionMetadataType &extensionMetadata, int serverAPI);

  static QStringList serverKeysToIgnore(int serverAPI);

  static ExtensionMetadataType filterExtensionMetadata(const ExtensionMetadataType &extensionMetadata, int serverAPI);

  static QStringList readArrayValues(QSettings& settings,
                                     const QString& arrayName, const QString fieldName);

  static void writeArrayValues(QSettings& settings, const QStringList& values,
                               const QString& arrayName, const QString fieldName);

  static bool writeExtensionDescriptionFile(const QString& file,
                                            const ExtensionMetadataType& metadata);

  static ExtensionMetadataType parseExtensionDescriptionFile(const QString& file);

public slots:

  void setExtensionBookmarked(const QString& extensionName, bool value);

  void setExtensionEnabled(const QString& extensionName, bool value);

  bool downloadAndInstallExtension(const QString& extensionId, bool installDependencies = true, bool waitForCompletion = false);

  bool downloadAndInstallExtensionByName(const QString& extensionName, bool installDependencies = true, bool waitForCompletion = false);

  bool scheduleExtensionForUninstall(const QString& extensionName);

  bool cancelExtensionScheduledForUninstall(const QString& extensionName);

  bool updateExtensionsMetadataFromServer(bool force = false, bool waitForCompletion = false);

  void checkForExtensionsUpdates();

  bool scheduleExtensionForUpdate(const QString& extensionName);

  bool cancelExtensionScheduledForUpdate(const QString& extensionName);

  bool updateScheduledExtensions(QStringList &updatedExtensions);

  bool updateScheduledExtensions();

  bool uninstallScheduledExtensions(QStringList &uninstalledExtensions);

  bool uninstallScheduledExtensions();

  void identifyIncompatibleExtensions();

  bool exportExtensionList(QString& exportFilePath);

  QStringList checkInstallPrerequisites() const;

  void aboutToLoadExtensions();

  void updateModel();

  void setAutoUpdateCheck(bool enable);
  void setAutoUpdateInstall(bool enable);
  void setAutoInstallDependencies(bool enable);
  void setInteractive(bool value);

  Q_INVOKABLE bool waitForAllTasksCompletion(int timeoutMsec = -1)const;

signals:

  void downloadStarted(QNetworkReply * reply);

  void downloadFinished(QNetworkReply * reply);

  void updateDownloadProgress(const QString& extensionName,
                              qint64 received, qint64 total);

  void modelUpdated();

  void updateExtensionsMetadataFromServerCompleted(bool success);

  void extensionUpdateAvailable(const QString& extensionName);

  void extensionUpdatesAvailable(bool available);

  void extensionInstalled(const QString& extensionName);

  void extensionUpdated(const QString& extensionName);

  void extensionMetadataUpdated(const QString& extensionName);

  void extensionScheduledForUninstall(const QString& extensionName);

  void extensionCancelledScheduleForUninstall(const QString& extensionName);

  void extensionScheduledForUpdate(const QString& extensionName);

  void extensionCancelledScheduleForUpdate(const QString& extensionName);

  void extensionUninstalled(const QString& extensionName);

  void extensionBookmarkedChanged(const QString& extensionName, bool value);

  void extensionEnabledChanged(const QString& extensionName, bool value);

  void extensionIdentifedAsIncompatible(const QString& extensionName);

  void newExtensionEnabledByDefaultChanged(bool value);

  void slicerRequirementsChanged(const QString& revision, const QString& os, const QString& arch);
  void slicerArchChanged(const QString& slicerArch);
  void slicerOsChanged(const QString& slicerOs);
  void slicerRevisionChanged(const QString& slicerRevision);

  void interactiveChanged(bool interactive);

  void slicerVersionChanged(const QString& slicerVersion);

  void messageLogged(const QString& text, ctkErrorLogLevel::LogLevels level) const;

  void installDownloadProgress(const QString& extensionName, qint64 received, qint64 total);

  void extensionsSettingsFilePathChanged(const QString& extensionsSettingsFilePath);

  void autoUpdateSettingsChanged();

  void activeTasksChanged();

protected slots:

  void onInstallDownloadProgress(qSlicerExtensionDownloadTask* task, qint64 received, qint64 total);

  void onInstallDownloadFinished(qSlicerExtensionDownloadTask* task);

  void onUpdateDownloadFinished(qSlicerExtensionDownloadTask* task);

  void onUpdateDownloadProgress(qSlicerExtensionDownloadTask* task,
                                qint64 received, qint64 total);

  bool onExtensionsMetadataFromServerQueryFinished(const QUuid& requestId);

protected:
  QScopedPointer<qSlicerExtensionsManagerModelPrivate> d_ptr;

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

Q_DECLARE_METATYPE(qSlicerExtensionsManagerModel::ServerAPI);

// Metatype already declared in qSlicerIO.h
//Q_DECLARE_METATYPE(qSlicerExtensionsManagerModel::ExtensionMetadataType)

#endif