ConfigurationManager.h

#ifndef _ots_ConfigurationManager_h_
#define _ots_ConfigurationManager_h_
 
#include <map>
#include <mutex>
#include <set>
#include <string>
#include <thread>
 
#include "artdaq-core/Utilities/TimeUtils.hh"
#include "otsdaq/ConfigurationInterface/ConfigurationInterface.h"
#include "otsdaq/ConfigurationInterface/ConfigurationTree.h"
#include "otsdaq/TableCore/TableVersion.h"
 
namespace ots
{
class ProgressBar;
 
#define __GET_CONFIG__(X) getTable<X>(QUOTE(X))
 
class ConfigurationManager
{
    friend class ConfigurationManagerRW;
    friend class GatewaySupervisor;
 
  public:
    typedef std::map<std::string,
                     std::pair<std::pair<std::string, TableGroupKey>,
                               std::map<std::string, TableVersion> /* memberMap */
                               >>
        lastGroupLoad_t;
 
    //==============================================================================
    static const unsigned int PROCESSOR_COUNT;
 
    static const std::string READONLY_USER;
    static const std::string ACTIVE_GROUPS_FILENAME;
    static const std::string ALIAS_VERSION_PREAMBLE;
    static const std::string SCRATCH_VERSION_ALIAS;
    static const std::string SUBSYSTEM_COMMON_VERSION_ALIAS;
    static const std::string SUBSYSTEM_COMMON_OVERRIDE_VERSION_ALIAS;
 
    static const std::string XDAQ_CONTEXT_TABLE_NAME;
    static const std::string XDAQ_APPLICATION_TABLE_NAME;
    static const std::string XDAQ_APP_PROPERTY_TABLE_NAME;
    static const std::string GROUP_ALIASES_TABLE_NAME;
    static const std::string VERSION_ALIASES_TABLE_NAME;
    static const std::string ARTDAQ_TOP_TABLE_NAME;
    static const std::string DESKTOP_ICON_TABLE_NAME;
 
    static const std::string GROUP_TYPE_NAME_CONTEXT;
    static const std::string GROUP_TYPE_NAME_BACKBONE;
    static const std::string GROUP_TYPE_NAME_ITERATE;
    static const std::string GROUP_TYPE_NAME_CONFIGURATION;
    static const std::string GROUP_TYPE_NAME_UNKNOWN;
 
    static const std::string LAST_TABLE_GROUP_SAVE_PATH;
    static const std::string LAST_ACTIVATED_CONFIG_GROUP_FILE;
    static const std::string LAST_ACTIVATED_CONTEXT_GROUP_FILE;
    static const std::string LAST_ACTIVATED_BACKBONE_GROUP_FILE;
    static const std::string LAST_ACTIVATED_ITERATE_GROUP_FILE;
 
    static const std::string ACTIVATED_CONFIGS_FILE;
    static const std::string ACTIVATED_CONTEXTS_FILE;
    static const std::string ACTIVATED_BACKBONES_FILE;
    static const std::string ACTIVATED_ITERATES_FILE;
 
    static const std::string LAST_ATTEMPTED_CONFIGURE_CONFIG_ALIAS_FILE;
    static const std::string LAST_ATTEMPTED_CONFIGURE_CONFIG_GROUP_FILE;
 
    static const std::string ATTEMPTED_CONFIGURE_CONFIG_ALIASES_FILE;
    static const std::string ATTEMPTED_CONFIGURE_CONFIGS_FILE;
 
    static const std::string LAST_CONFIGURED_CONFIG_ALIAS_FILE;
    static const std::string LAST_CONFIGURED_CONFIG_GROUP_FILE;
    static const std::string LAST_CONFIGURED_CONTEXT_GROUP_FILE;
    static const std::string LAST_CONFIGURED_BACKBONE_GROUP_FILE;
    static const std::string LAST_CONFIGURED_ITERATE_GROUP_FILE;
 
    static const std::string CONFIGURED_CONFIG_ALIASES_FILE;
    static const std::string CONFIGURED_CONFIGS_FILE;
    static const std::string CONFIGURED_CONTEXTS_FILE;
    static const std::string CONFIGURED_BACKBONES_FILE;
    static const std::string CONFIGURED_ITERATES_FILE;
 
    static const std::string LAST_STARTED_CONFIG_ALIAS_FILE;
    static const std::string LAST_STARTED_CONFIG_GROUP_FILE;
    static const std::string LAST_STARTED_CONTEXT_GROUP_FILE;
    static const std::string LAST_STARTED_BACKBONE_GROUP_FILE;
    static const std::string LAST_STARTED_ITERATE_GROUP_FILE;
 
    static const std::string STARTED_CONFIG_ALIASES_FILE;
    static const std::string STARTED_CONFIGS_FILE;
    static const std::string STARTED_CONTEXTS_FILE;
    static const std::string STARTED_BACKBONES_FILE;
    static const std::string STARTED_ITERATES_FILE;
 
    static const std::string CONFIGURED_OR_STARTED_CONFIG_ALIASES_FILE;
    static const std::string CONFIGURED_OR_STARTED_CONFIGS_FILE;
    static const std::string CONFIGURED_OR_STARTED_CONTEXTS_FILE;
    static const std::string CONFIGURED_OR_STARTED_BACKBONES_FILE;
    static const std::string CONFIGURED_OR_STARTED_ITERATES_FILE;
 
    static const uint8_t METADATA_COL_ALIASES;
    static const uint8_t METADATA_COL_COMMENT;
    static const uint8_t METADATA_COL_AUTHOR;
    static const uint8_t METADATA_COL_TIMESTAMP;
 
    static const std::string CONTEXT_SUBSYSTEM_OPTIONAL_TABLE;
    static const std::string UNKNOWN_INFO;
    static const std::string UNKNOWN_TIME;
 
    enum class GroupType
    {
        UNKNOWN_TYPE,
        CONTEXT_TYPE,
        BACKBONE_TYPE,
        ITERATE_TYPE,
        CONFIGURATION_TYPE
    };
 
    enum class LoadGroupType
    {
        ALL_TYPES,
        ONLY_BACKBONE_OR_CONTEXT_TYPES,
        ONLY_BACKBONE_TYPE
    };
 
    // clang-format off
 
    static const std::set<std::string>& getFixedContextMemberNames  (void);
    static const std::set<std::string>& getBackboneMemberNames      (void);
    static const std::set<std::string>& getIterateMemberNames       (void);
    const std::set<std::string>&        getActiveContextMemberNames (void);
    const std::set<std::string>&        getConfigurationMemberNames (void);
 
    static const std::string&           convertGroupTypeToName      (const ConfigurationManager::GroupType& groupTypeId);
    static ConfigurationManager::GroupType getTypeOfGroup           (const std::map<std::string /*name*/, TableVersion /*version*/>& memberMap);
    static const std::string&           getTypeNameOfGroup          (const std::map<std::string /*name*/, TableVersion /*version*/>& memberMap);
 
    //==============================================================================
    ConfigurationManager(bool initForWriteAccess  = false,
                         bool initializeFromFhicl = false,
                         bool forceNotFirstInContext = false);
    virtual ~ConfigurationManager(void);
 
 
 
    void                                init                        (std::string* accumulatedErrors = 0, bool initForWriteAccess = false, std::string* accumulatedWarnings = 0);
    void                                destroy                     (void);
    void                                destroyTableGroup           (const std::string& theGroup = "", bool onlyDeactivate = false);
 
    //==============================================================================
    std::chrono::steady_clock::time_point                       startClockTime_, deltaClockTime_;
    std::string /* sinceStart deltaLastCheck */ runTimeSeconds() {
 
        //((double)(clock()-startClockTime_))/CLOCKS_PER_SEC;};
        std::string retStr =
            std::to_string(artdaq::TimeUtils::GetElapsedTime(startClockTime_))
            + "s " +
            std::to_string(artdaq::TimeUtils::GetElapsedTime(deltaClockTime_)) + "s";
        deltaClockTime_ = std::chrono::steady_clock::now();
        return retStr;
    };
 
    void                                loadTableGroup              (
        const std::string&                                     tableGroupName,
        const TableGroupKey&                                   tableGroupKey,
        bool                                                   doActivate         = false,
        std::map<std::string, TableVersion>*                   groupMembers       = 0,
        ProgressBar*                                           progressBar        = 0,
        std::string*                                           accumulateWarnings = 0,
        std::string*                                           groupComment       = 0,
        std::string*                                           groupAuthor        = 0,
        std::string*                                           groupCreateTime    = 0,
        bool                                                   doNotLoadMember    = false,
        std::string*                                           groupTypeString    = 0,
        std::map<std::string /*name*/, std::string /*alias*/>* groupAliases       = 0,
        ConfigurationManager::LoadGroupType                    groupTypeToLoad    = ConfigurationManager::LoadGroupType::ALL_TYPES,
        bool                                                   ignoreVersionTracking = false,
        std::map<std::string /* tableName */,
            TableVersion>                                      mergeInTables = {},
        std::map<std::string /* tableName */,
            TableVersion>                                      overrideTables = {});
    void                                copyTableGroupFromCache     (
        const ConfigurationManager&                             cacheConfigMgr,
        const std::map<std::string, TableVersion>&              groupMembers,
        const std::string&                                      configGroupName     = "",
        const TableGroupKey&                                    tableGroupKey       = TableGroupKey(TableGroupKey::INVALID),
        bool                                                    doActivate        = false,
        bool                                                    ignoreVersionTracking = false);
    std::pair<std::string /* groupName */, TableGroupKey>
                                        getGroupOfLoadedTable       (const std::string& tableName) const;
    void                                loadMemberMap               (const std::map<std::string /*name*/, TableVersion /*version*/>& memberMap, std::string* accumulateWarnings = 0);
    TableGroupKey                       loadConfigurationBackbone   (void);
 
    //================
    template<class T>
    const T*                            getTable                    (const std::string& tableName) const
    {
        const TableBase* srcPtr = getTableByName(tableName);
        const T* retPtr = dynamic_cast<const T*>(srcPtr); if(retPtr == nullptr) { __SS__ << "Illegal cast of '" << tableName << "' to type " << StringMacros::getTypeName<T>() << " (s=" << static_cast<const void*>(srcPtr) <<", t=" << typeid(srcPtr).name() << ")"<< __E__; __SS_THROW__ } return retPtr;
    }
    const TableBase*                    getTableByName              (const std::string& configurationName) const;
 
    void                                dumpActiveConfiguration     (const std::string& filePath, const std::string& dumpType, const std::string& configurationAlias, const std::string& subsystemCommonList, const std::string& subsystemCommonOverrideList, const std::string& logEntry, const std::string& activeUsers, const std::string& activeStateMachine, std::ostream& altOut = std::cout);
    void                                dumpMacroMakerModeFhicl     (void);
 
    std::map<std::string /*groupAlias*/,
         std::pair<std::string /*groupName*/,
         TableGroupKey>>                getActiveGroupAliases       (void);
    std::map<std::string /*tableName*/,
        std::map<std::string /*aliasName*/,
        TableVersion>>                  getVersionAliases           (void) const;
    std::set<std::pair<std::string /*tableName*/,
        TableVersion>>                  getVersionAliases           (const std::string& tableAliasNeedle) const; 
    std::pair<std::string /*groupName*/,
        TableGroupKey>                  getTableGroupFromAlias      (std::string systemAlias, ProgressBar* progressBar = 0);
    std::map<std::string /*groupType*/,
         std::pair<std::string /*groupName*/,
         TableGroupKey>>                getActiveTableGroups        (void) const;
    const std::map<std::string /*groupType*/,
        std::pair<std::string /*groupName*/,
        TableGroupKey>>&                getFailedTableGroups        (void) const {return lastFailedGroupLoad_;}
    const lastGroupLoad_t&              getLastTableGroups          (void) const {return lastGroupLoad_;}
    const std::string&                  getActiveGroupName          (const ConfigurationManager::GroupType& type = ConfigurationManager::GroupType::CONFIGURATION_TYPE) const;
    TableGroupKey                       getActiveGroupKey           (const ConfigurationManager::GroupType& type = ConfigurationManager::GroupType::CONFIGURATION_TYPE) const;
 
    ConfigurationTree                   getNode                     (const std::string& nodeString, bool doNotThrowOnBrokenUIDLinks = false) const;  
    std::map<std::string, ConfigurationTree>
                                        getNodes                    (const std::string& nodeString) const;
    ConfigurationTree                   getContextNode              (const std::string& contextUID, const std::string& applicationUID) const;
    ConfigurationTree                   getSupervisorNode           (const std::string& contextUID, const std::string& applicationUID) const;
    ConfigurationTree                   getSupervisorTableNode      (const std::string& contextUID, const std::string& applicationUID) const;
    ConfigurationTree                   getGatewaySupervisorNode    (void) const;
 
    std::vector<std::pair<std::string /*childName*/,
        ConfigurationTree>>             getChildren                 (std::map<std::string, TableVersion>* memberMap = 0, std::string* accumulatedTreeErrors = 0) const;
    std::map<std::string /*childName*/,
        ConfigurationTree>              getChildrenMap              (std::map<std::string, TableVersion>* memberMap = 0, std::string* accumulatedTreeErrors = 0) const;
    std::string                         getFirstPathToNode          (const ConfigurationTree& node, const std::string& startPath = "/") const;
 
    std::map<std::string, TableVersion> getActiveVersions           (void) const;
 
    const std::string&                  getOwnerContext             (void) { return ownerContextUID_; }
    const std::string&                  getOwnerApp                 (void) { return ownerAppUID_; }
    bool                                isOwnerFirstAppInContext    (void);
 
    std::map<std::string /*groupType*/,
         std::pair<std::string /*groupName*/,
         TableGroupKey>>                        getOtherSubsystemActiveTableGroups      (const std::string& otherSubsystemUID, std::string* userDataPathPtr = nullptr, std::string* hostnamePtr = nullptr, std::string* usernamePtr = nullptr);
    void                                        getOtherSubsystemInstanceInfo           (const std::string& otherSubsystemUID, std::string* userDataPathPtr = nullptr, std::string* hostnamePtr = nullptr, std::string* usernamePtr = nullptr, std::string* fullNamePtr = nullptr);
    std::set<std::string  /* configAlias */>    getOtherSubsystemConfigAliases          (const std::string& otherSubsystemUID);
    std::set<std::string  /* configAlias */>    getOtherSubsystemFilteredConfigAliases  (const std::string& otherSubsystemUID, const std::string& otherSubsystemFsmName );
    void                                        getOtherSubsystemConfigAliasInfo        (const std::string& otherSubsystemUID, const std::string& configAlias, std::pair<std::string, TableGroupKey>& groupTranslation, std::string& groupComment, std::string& groupAuthor, std::string& groupCreationTime);
 
    //==============================================================================
    std::shared_ptr<TableGroupKey>      makeTheTableGroupKey        (TableGroupKey key);
    void                                restoreActiveTableGroups    (bool throwErrors = false, const std::string& pathToActiveGroupsFile = "", ConfigurationManager::LoadGroupType onlyLoadIfBackboneOrContext = ConfigurationManager::LoadGroupType::ALL_TYPES, std::string* accumulatedWarnings = 0);
 
    void                                setOwnerContext             (const std::string& contextUID) { ownerContextUID_ = contextUID; }
    void                                setOwnerApp                 (const std::string& appUID) { ownerAppUID_ = appUID; }
    static void                         saveGroupNameAndKey         (const std::pair<std::string /*group name*/, TableGroupKey>& theGroup,const std::string& fileName, bool appendMode = false, const std::string& associatedUser = "");
    static std::pair<
            std::string /*group name*/,
            TableGroupKey>              loadGroupNameAndKey         (const std::string& fileName, std::string& returnedTimeString);
    static std::vector<std::map<std::string /* group field key */,
            std::string /* group field value */>>
                                        loadGroupHistory            (const std::string& groupAction, const std::string& groupType, bool formatTime = false);
    static std::vector<std::map<std::string /* group field key */,
            std::string /* group field value */>>
                                        loadGroupHistory            (const std::string& fileName, bool formatTime = false);
 
    void                                initPrereqsForARTDAQ        (void);
 
    bool                                                forceNotFirstInContext_ = false;
 
  private:
                                        ConfigurationManager        (const std::string& userName);  
 
    TableBase*                          getDesktopIconTable         (void); 
 
    void                                initializeFromFhicl         (const std::string& fhiclPath);
    void                                recursiveInitFromFhiclPSet  (const std::string& tableName, const fhicl::ParameterSet& pset, const std::string& recordName = "", const std::string& groupName = "", const std::string& groupLinkIndex = "");
    void                                recursiveTreeToFhicl        (ConfigurationTree node, std::ostream& out, std::string& tabStr, std::string& commentStr, unsigned int depth = -1);
    static void                         initTableThread             (ConfigurationManager*                  cfgMgr,
                                                                    ots::TableBase*                         table,
                                                                    std::string*                            threadErrors,
                                                                    std::mutex*                             threadMutex,
                                                                    std::shared_ptr<std::atomic<bool>>      threadDone);
    static void                         fillTableThread             (ConfigurationInterface*                theInterface,
                                                                    std::map<std::string, ots::TableBase *>*nameToTableMap,
                                                                    ots::TableBase*                         table,
                                                                    std::string                             tableName,
                                                                    ots::TableVersion                       version,
                                                                    std::string*                            threadErrors,
                                                                    std::mutex*                             threadMutex,
                                                                    std::shared_ptr<std::atomic<bool>>      threadDone);
 
 
  protected:
    TableBase*                          getVersionedTableByName     (const std::string& tableName, TableVersion version, bool looseColumnMatching = false, std::string* accumulatedErrors = 0, bool getRawData = false);
 
    std::string                                         mfSubject_;
  private:
    std::string                                         username_;  
    ConfigurationInterface*                             theInterface_;
    std::shared_ptr<TableGroupKey>                      theConfigurationTableGroupKey_, theContextTableGroupKey_, theBackboneTableGroupKey_, theIterateTableGroupKey_;
    std::string                                         theConfigurationTableGroup_, theContextTableGroup_, theBackboneTableGroup_, theIterateTableGroup_;
 
    std::map<std::string,
        std::pair<std::string, TableGroupKey>>          lastFailedGroupLoad_;
    lastGroupLoad_t                                     lastGroupLoad_;
 
 
 
    std::map<std::string, TableBase*>                   nameToTableMap_;
 
    TableBase                                           groupMetadataTable_;    
 
    std::string                                         ownerContextUID_;  
    std::string                                         ownerAppUID_;  
 
    std::mutex                                          metaDataTableMutex_;
 
    static const std::set<std::string>
        fixedContextMemberNames_;  
    static const std::set<std::string>
        backboneMemberNames_;                                
    static const std::set<std::string> iterateMemberNames_;  
    std::set<std::string>              contextMemberNames_,  
        configurationMemberNames_;  
 
    // clang-format on
};
}  // namespace ots
 
#endif