RepoModel.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/ScriptRepository.h"
#include "MantidQtWidgets/Common/DllOption.h"
#include <QAbstractItemModel>
#include <QDialog>
#include <QFutureWatcher>
#include <QList>
#include <QMessageBox>
#include <QModelIndex>
#include <QStringList>
#include <QVariant>
#include <QWidget>
 
class QLineEdit;
class QCheckBox;
class QTextEdit;
 
namespace MantidQt {
namespace API {
 
const QString REMOTEONLY = "REMOTE_ONLY";
const QString LOCALONLY = "LOCAL_ONLY";
const QString LOCALCHANGED = "LOCAL_CHANGED";
const QString REMOTECHANGED = "REMOTE_CHANGED";
const QString BOTHUNCHANGED = "UPDATED";
const QString BOTHCHANGED = "CHANGED";
const QString UPLOADST = "UPLOADING";
const QString DOWNLOADST = "DOWNLOADING";
const QString PROTECTEDENTRY = "protected";
const QString DELETABLEENTRY = "deletable";
 
class EXPORT_OPT_MANTIDQT_COMMON RepoModel : public QAbstractItemModel {
  Q_OBJECT
 
  class RepoItem {
  public:
    // construct the RepoItem passing the script repository path
    RepoItem(QString label, QString path = "/", RepoItem *parent = nullptr);
 
    ~RepoItem();
    // append child to build the directory tree
    void appendChild(RepoItem *child);
    // access to the row_th file/folder child of this entry
    RepoItem *child(int row) const;
    int row() const;
    // return the number of files/folders that are children of this entry
    int childCount() const;
    const QString &path() const { return keypath; };
    const QString &label() const { return m_label; };
    RepoItem *parent() const { return parentItem; };
    bool removeChild(int row);
 
  private:
    QList<RepoItem *> childItems;
    QString m_label;
    QString keypath;
    RepoItem *parentItem;
 
  private:
    RepoItem(const RepoItem &);
    const RepoItem &operator=(const RepoItem &);
  };
 
  class UploadForm : public QDialog {
  public:
    UploadForm(const QString &file2upload, QWidget *parent = nullptr);
    ~UploadForm() override;
    QString email();
    QString author();
    QString comment();
    bool saveInfo();
    void setEmail(const QString & /*email*/);
    void setAuthor(const QString & /*author*/);
    void lastSaveOption(bool option);
 
  protected:
    QLineEdit *author_le;
    QLineEdit *email_le;
    QCheckBox *save_ck;
    QTextEdit *comment_te;
  };
 
  class DeleteQueryBox : public QMessageBox {
  public:
    DeleteQueryBox(const QString &path, QWidget *parent = nullptr);
    ~DeleteQueryBox() override;
    QString comment();
 
  private:
    QTextEdit *comment_te;
  };
 
public:
  RepoModel(QObject *parent = nullptr);
  ~RepoModel() override;
  QVariant data(const QModelIndex &index, int role) const override;
  Qt::ItemFlags flags(const QModelIndex &index) const override;
  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
  QModelIndex parent(const QModelIndex &index) const override;
  int rowCount(const QModelIndex &parent = QModelIndex()) const override;
  int columnCount(const QModelIndex &parent = QModelIndex()) const override;
  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
 
  static const QString &localOnlySt();
  static const QString &remoteOnlySt();
  static const QString &localChangedSt();
  static const QString &remoteChangedSt();
  static const QString &updatedSt();
  static const QString &bothChangedSt();
  static const QString &downloadSt();
  static const QString &uploadSt();
 
  QString fileDescription(const QModelIndex &index);
  QString filePath(const QModelIndex &index);
  QString author(const QModelIndex &index);
 
signals:
  void executingThread(bool /*_t1*/);
 
private:
  void setupModelData(RepoItem *parent);
  const QString &fromStatus(Mantid::API::SCRIPTSTATUS status) const;
  RepoItem *rootItem;
  Mantid::API::ScriptRepository_sptr repo_ptr;
  QString repo_path;
  RepoItem *getParent(const QString &folder, QList<RepoItem *> &parents);
 
  Q_DISABLE_COPY(RepoModel)
 
  
  void handleExceptions(const Mantid::API::ScriptRepoException &ex, const QString &title,
                        bool showWarning = true) const;
 
  // handle download in thread
  QFuture<QString> download_threads;
  QFutureWatcher<QString> download_watcher;
  QModelIndex download_index;
  QString downloading_path;
  bool isDownloading(const QModelIndex &index) const;
private slots:
  void downloadFinished();
 
private:
  // handle connection to the uploader server in thread
  // this connection are used to upload or deleting files.
 
  // QFuture variable, used to check if the thread is running, alive, etc...
  QFuture<QString> upload_threads;
  // The mechanism to have a call back function executed after finishing the
  // thread
  QFutureWatcher<QString> upload_watcher;
  // keep track of the file being used to the connection with uploader
  QString uploading_path;
  QModelIndex upload_index;
  // check if the file pointed by the index is inside a connection with uploader
  bool isUploading(const QModelIndex &index) const;
private slots:
  // call back method executed after finishing the thread
  void uploadFinished();
};
 
} // namespace API
} // namespace MantidQt