ScriptRepository.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 <string>
#include <vector>
 
#include "MantidAPI/DllConfig.h"
#include "MantidKernel/DateAndTime.h"
#include <vector>
 
namespace Mantid {
namespace API {
 
struct ScriptInfo {
  std::string author;
  Types::Core::DateAndTime pub_date;
  bool auto_update;
  bool directory;
};
 
enum SCRIPTSTATUS {
  BOTH_UNCHANGED = 0,
  REMOTE_ONLY = (1u << 0),
  LOCAL_ONLY = (1u << 1),
  REMOTE_CHANGED = (1u << 2),
  LOCAL_CHANGED = (1u << 3),
  BOTH_CHANGED = (REMOTE_CHANGED | LOCAL_CHANGED)
};
 
class MANTID_API_DLL ScriptRepoException : public std::exception {
 
public:
  ScriptRepoException(const std::string &info = std::string("Unknown Exception"))
      : m_systemError(""), m_userInfo(info), m_filepath(""){};
 
  ScriptRepoException(const std::string &info, const std::string &system, const std::string &file = std::string(),
                      int line = -1);
 
  const char *what() const noexcept override;
 
  const std::string &systemError() const { return m_systemError; };
  const std::string &filePath() const { return m_filepath; };
 
private:
  std::string m_systemError;
  std::string m_userInfo;
  std::string m_filepath;
};
 
//----------------------------------------------------------------------
class MANTID_API_DLL ScriptRepository {
public:
  virtual ~ScriptRepository() = default;
  virtual ScriptInfo info(const std::string &path) = 0;
 
  virtual const std::string &description(const std::string &path) = 0;
 
  ScriptInfo fileInfo(const std::string &path) { return info(path); }
 
  virtual std::vector<std::string> listFiles() = 0;
 
  virtual void download(const std::string &file_path) = 0;
 
  virtual SCRIPTSTATUS fileStatus(const std::string &file_path) = 0;
 
  virtual bool isValid() = 0;
 
  virtual void install(const std::string &local_path) = 0;
 
  virtual void connect(const std::string &webserverurl = "") = 0;
 
  virtual std::vector<std::string> check4Update() = 0;
 
  virtual void upload(const std::string &file_path, const std::string &comment, const std::string &author,
                      const std::string &email) = 0;
 
  virtual void remove(const std::string &file_path, const std::string &comment, const std::string &author,
                      const std::string &email) = 0;
 
  virtual void setIgnorePatterns(const std::string &patterns) = 0;
 
  virtual std::string ignorePatterns() = 0;
 
  virtual int setAutoUpdate(const std::string &path, bool option = true) = 0;
};
 
using ScriptRepository_sptr = std::shared_ptr<ScriptRepository>;
} // namespace API
} // namespace Mantid