UsageService.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidKernel/DllConfig.h"
#include "MantidKernel/InternetHelper.h"
#include "MantidKernel/SingletonHolder.h"
#include "MantidTypes/Core/DateAndTime.h"
 
#include <json/value.h>
 
#include <Poco/ActiveMethod.h>
#include <Poco/Timer.h>
 
#include <mutex>
#include <queue>
 
namespace Mantid {
namespace Kernel {
 
enum class FeatureType { Algorithm, Interface, Feature, Function };
 
class FeatureUsage {
public:
  FeatureUsage(const FeatureType &type, std::string name, const bool internal, std::string application);
  bool operator<(const FeatureUsage &r) const;
 
  ::Json::Value asJson() const;
 
  FeatureType type;
  std::string name;
  bool internal;
  std::string application;
 
protected:
  std::string featureTypeToString() const;
};
 
class MANTID_KERNEL_DLL UsageServiceImpl {
public:
  void setApplicationName(const std::string &name);
  std::string getApplicationName() const;
  void setInterval(const uint32_t seconds = 60);
  void registerStartup();
  void registerFeatureUsage(const FeatureType &type, const std::vector<std::string> &name, const bool internal);
  void registerFeatureUsage(const FeatureType &type, const std::string &name, const bool internal);
  void registerFeatureUsage(const FeatureType &type, std::initializer_list<std::string> name, const bool internal);
 
  bool isEnabled() const;
  void setEnabled(const bool enabled);
  void clear();
  void flush();
  void shutdown();
  Types::Core::time_duration getUpTime();
  Types::Core::DateAndTime getStartTime() { return m_startTime; }
 
protected:
  UsageServiceImpl();
  virtual ~UsageServiceImpl() = default;
  virtual std::string generateStartupMessage();
  virtual std::string generateFeatureUsageMessage();
  virtual Kernel::InternetHelper::HTTPStatus sendReport(const std::string &message, const std::string &url);
 
private:
  friend struct Mantid::Kernel::CreateUsingNew<UsageServiceImpl>;
  UsageServiceImpl(const UsageServiceImpl &);
  UsageServiceImpl &operator=(const UsageServiceImpl &);
 
  void sendStartupReport();
  void sendFeatureUsageReport(const bool synchronous);
 
  InternetHelper::HTTPStatus sendStartupAsyncImpl(const std::string &message);
  InternetHelper::HTTPStatus sendFeatureAsyncImpl(const std::string &message);
 
  void timerCallback(Poco::Timer &);
 
  // generate Json header for feature calls
  ::Json::Value generateFeatureHeader();
 
  Poco::Timer m_timer;
 
  uint32_t m_timerTicks;
  uint32_t m_timerTicksTarget;
 
  std::queue<FeatureUsage> m_FeatureQueue;
  size_t m_FeatureQueueSizeThreshold;
  bool m_isEnabled;
  mutable std::mutex m_mutex;
  std::string m_application;
  Types::Core::DateAndTime m_startTime;
 
  Poco::ActiveMethod<InternetHelper::HTTPStatus, std::string, UsageServiceImpl> m_startupActiveMethod;
  Poco::ActiveMethod<InternetHelper::HTTPStatus, std::string, UsageServiceImpl> m_featureActiveMethod;
 
  std::string m_url;
};
 
EXTERN_MANTID_KERNEL template class MANTID_KERNEL_DLL Mantid::Kernel::SingletonHolder<UsageServiceImpl>;
using UsageService = Mantid::Kernel::SingletonHolder<UsageServiceImpl>;
 
} // namespace Kernel
} // namespace Mantid