config.hpp

Go to the documentation of this file.

 
#ifndef CORE_UTILS_BAT_CONFIG_HPP_
#define CORE_UTILS_BAT_CONFIG_HPP_
 
// System headers
#include <string>
#include <any>
 
// Third party headers
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/program_options.hpp>
#include <boost/optional.hpp>
 
// Local headers
#include <utils/bat/logger.hpp>
#include <utils/bat/iConfig.hpp>
#include <core/dit/fits/fits.hpp>
 
// New CII Config Service
#include <config-ng/ciiConfigApi.hpp>
 
namespace utils::bat {
 
  constexpr auto CONFIG_DEFAULT_PROCNAME         = "notset";
  constexpr auto CONFIG_DEFAULT_FILENAME         = "";
  constexpr auto CONFIG_DEFAULT_SCXML_FILENAME   = "";
  constexpr auto CONFIG_DEFAULT_LOGLEVEL         = "ERROR";
  constexpr auto CONFIG_DEFAULT_DB_ENDPOINT      = "127.0.0.1:6379";
  constexpr unsigned int  CONFIG_DEFAULT_DB_TIMEOUT       = 2000;
  constexpr auto CONFIG_DEFAULT_REQ_ENDPOINT     = "";
  constexpr auto CONFIG_DEFAULT_PUB_ENDPOINT     = "";
  constexpr auto CONFIG_DEFAULT_OLDB_URI         = "cii.oldb:///";
 
  constexpr unsigned int CONFIG_DEFAULT_WAIT_TOUT = 1000;
  constexpr unsigned int CONFIG_DEFAULT_CMD_TOUT = 60000;
 
  // DB key delimiter
  constexpr auto CONFIG_DB_DELIMITER             = "/";
 
  // Keys used internally to for reporting server state in the DB
  constexpr auto KEY_CONTROL_STATE         = "state";
  constexpr auto KEY_CONTROL_SUBSTATE      = "substate";
  constexpr auto KEY_CONTROL_STATUS        = "status";
  constexpr auto KEY_CONTROL_STATE_STR     = "state_str";
  constexpr auto KEY_CONTROL_SUBSTATE_STR  = "substate_str";
 
  // Keys used for configuration parameters
  constexpr auto KEY_CONFIG_REQ_ENDPOINT   = "req_endpoint";
  constexpr auto KEY_CONFIG_PUB_ENDPOINT   = "pub_endpoint";
  constexpr auto KEY_CONFIG_DB_ENDPOINT    = "db_endpoint";
  constexpr auto KEY_CONFIG_DB_TIMEOUT     = "db_timeout";
  constexpr auto KEY_CONFIG_DB_TASK_PERIOD = "db_task_period";
  constexpr auto KEY_CONFIG_SM_SCXML       = "scxml";
  constexpr auto KEY_CONFIG_FILENAME       = "filename";
  constexpr auto KEY_CONFIG_LOG_LEVEL      = "log_level";
  constexpr auto KEY_CONFIG_LOG_PROP       = "log_properties";
  constexpr auto KEY_CONFIG_SERVER_ID      = "server_id";
  constexpr auto KEY_CONFIG_SERVER         = "server";
  constexpr auto KEY_CONFIG_WAITTOUT       = "mon_timeout";
  constexpr auto KEY_CONFIG_CMDTOUT        = "req_timeout";
  constexpr auto KEY_CONFIG_DICTIONARIES   = "dictionaries";
  constexpr auto KEY_CONFIG_DB_PREFIX      = "oldb_prefix";
  constexpr auto KEY_CONFIG_FITS_PREFIX    = "fits_prefix";
  constexpr auto KEY_CONFIG_VERSION        = "version";
 
  // DB keys
  constexpr auto KEY_DB_STATES             = "states";
 
  using DbPair = std::pair<std::string, std::any>;
  using DbVector = std::vector<DbPair>;
 
  struct CliConfig {
      inline boost::optional<std::string> GetServerId() {
          return m_server_id;
      }
 
      inline boost::optional<std::string> GetLogLevel() {
          return m_log_level;
      }
 
      inline boost::optional<std::string> GetConfigFile() {
          return m_config_file;
      }
 
      inline boost::optional<std::string> GetReqEndpoint() {
          return m_req_endpoint;
      }
 
      inline boost::optional<std::string> GetLogPropFile() {
          return m_log_prop_file;
      }
 
       // Used boost optionals for its good integration with boost command line handling
       boost::optional<std::string> m_server_id;
       boost::optional<std::string> m_log_level;
       boost::optional<std::string> m_config_file;
       boost::optional<std::string> m_req_endpoint;
       boost::optional<std::string> m_log_prop_file;
    };
 
  class Config : public IConfig {
  public:
 
 
    Config();
 
     bool ParseOptions(int argc, char* argv[]) override;
 
     void LoadConfig(const std::string& filename = "", bool reset = false) override;
 
    virtual ~Config() = default;
 
     const std::string GetServerId() const override;
 
     const std::string GetMsgReplierEndpoint() const  override;
 
     const std::string GetMsgPubEndpoint()  const override;
 
     const timeval GetDbTimeout() const override;
 
     const unsigned int GetDbConnTimeout() const override;
 
     const unsigned int  GetDbTaskPeriod() const override;
 
     const std::string GetSmScxmlFilename() const  override;
 
     const std::string GetConfigFilename() const  override;
 
     const std::string GetLogProperties() const  override;
 
     const std::string GetLogLevel() const override;
      const unsigned int  GetReqTout() const override;
 
      const unsigned int  GetMonTout() const override;
 
      const std::string  GetOldbPrefix() const;
 
      const std::string  GetFitsPrefix() const;
 
 
      const std::string GetConfigAsString() const  override;
 
      void SetConfigAsString(const std::string& config)  override;
 
      std::string GetResolvedFilename(const std::string& config);
 
      const elt::configng::CiiConfigInstanceNamespace&  GetInstance() const;
 
      core::dit::did::Did& GetDid();
 
      virtual void GetConfigList(DbVector& cfg_list);
 
      CliConfig& GetCliCfg();
 
      void SetConfigFilename(const std::string cfg_file);
 
      const std::string   GetVersion() const;
 
  protected:
      void MergeConfig(const elt::configng::CiiConfigDocument &doc, bool check=true);
 
      void CheckConfig(const elt::configng::CiiConfigDocument &doc) const;
 
  private:
      void OverrideFromCmdLine();
 
      void SetLogProperties(const std::string& filename);
 
  protected:
      std::unique_ptr<elt::configng::CiiConfigDocument> m_config_doc;
      CliConfig                 m_cli_config;
      boost::posix_time::ptime  m_file_utc;
      std::string               m_config_filename;
      core::dit::did::Did       m_did;
      log4cplus::Logger         m_logger;
 
  private:
    Config(const Config&) = delete;              
    Config& operator=(const Config&) = delete;  
 
  private:    
    std::stringstream m_default_stream;
    int               m_num_dictionaries;
  };
 
 
}  // namespace
 
 
#endif  // CORE_UTILS_BAT_CONFIG_HPP_