otsdaq_doxygen/otsdaq-utilities/ConfigurationGUISupervisor_8h_source.html

 #ifndef _ots_ConfigurationGUISupervisor_h_

 #define _ots_ConfigurationGUISupervisor_h_


 #include "otsdaq/ConfigurationInterface/ConfigurationManagerRW.h"

 #include "otsdaq/CoreSupervisors/CoreSupervisorBase.h"


 namespace ots

 {

 // clang-format off


 class ConfigurationGUISupervisor : public CoreSupervisorBase

 {

   public:

     static xdaq::Application* instantiate(xdaq::ApplicationStub* s);


                             ConfigurationGUISupervisor              (xdaq::ApplicationStub* s);

     virtual                 ~ConfigurationGUISupervisor             (void);


     void                    init                                    (void);

     void                    destroy                                 (void);


     virtual void            defaultPage                             (xgi::Input* in, xgi::Output* out) override;

     virtual void            request                                 (const std::string& requestType,cgicc::Cgicc& cgiIn, HttpXmlDocument& xmlOut, const WebUsers::RequestUserInfo& userInfo) override;


     virtual void            setSupervisorPropertyDefaults           (void) override;

     virtual void            forceSupervisorPropertyValues           (void) override;


   private:

     void                    handleSaveTableInfoXML                  (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     std::string&            tableName,

                                                                     const std::string&      columnCSV,

                                                                     const std::string&      tableDescription,

                                                                     const std::string&      columnChoicesCSV,

                                                                     bool                    allowOverwrite = false);

     void                    handleDeleteTableInfoXML                (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     std::string&            tableName);


     void                    handleGroupAliasesXML                   (HttpXmlDocument&       xmldoc, ConfigurationManagerRW* cfgMgr);

     void                    handleSetGroupAliasInBackboneXML        (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupAliasCSV,

                                                                     const std::string&      groupNameCSV,

                                                                     const std::string&      groupKeyCSV,

                                                                     const std::string&      author);

     void                    handleSetTableAliasInBackboneXML        (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      versionAlias,

                                                                     const std::string&      tableName,

                                                                     TableVersion            version,

                                                                     const std::string&      author);

     void                    handleAliasGroupMembersInBackboneXML    (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      versionAlias,

                                                                     const std::string&      groupName,

                                                                     TableGroupKey           groupKey,

                                                                     const std::string&      author);

     void                    handleVersionAliasesXML                 (HttpXmlDocument&       xmldoc, ConfigurationManagerRW* cfgMgr);

     void                    handleTableGroupsXML                    (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     bool                    returnMembers);

     void                    handleGetTableGroupTypeXML              (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      configList);


     void                    handleTablesXML                         (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      filterStartTime,

                                                                     const std::string&      filterEndTime,

                                                                     const std::string&      filterMode = "created" /* "created" or "loaded" */);

     void                    handleGetTableXML                       (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      tableName,

                                                                     TableVersion            version,

                                                                     bool                    allowIllegalColumns = false,

                                                                     bool                    getRawData = false,

                                                                     bool                    descriptionOnly = false);


     void                    setupActiveTablesXML                    (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      modifiedTables,

                                                                     bool                    refreshAll      = true,

                                                                     bool                    getGroupInfo    = false,

                                                                     std::map<std::string /*name*/,

                                                                         TableVersion /*version*/>* returnMemberMap = 0,

                                                                     bool                    outputActiveTables = true,

                                                                     std::string*            accumulatedErrors  = 0);

     void                    handleFillTreeViewXML                   (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     unsigned int            depth,

                                                                     bool                    hideStatusFalse,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      filterList,

                                                                     const std::string&      diffGroupName = "",

                                                                     const TableGroupKey&    diffGroupKey = TableGroupKey());

     static void             recursiveTreeToXML                      (const ConfigurationTree& t,

                                                                     unsigned int            depth,

                                                                     HttpXmlDocument&        xmldoc,

                                                                     DOMElement*             parentEl,

                                                                     bool                    hideStatusFalse,

                                                                     std::optional<std::reference_wrapper<const ConfigurationTree>> diffTree = std::nullopt);

     void                    handleFillTreeNodeCommonFieldsXML       (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     unsigned int            depth,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      fieldList);

     void                    handleFillUniqueFieldValuesForRecordsXML(HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      fieldList);

     void                    handleFillGetTreeNodeFieldValuesXML     (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      fieldList);

     void                    handleFillSetTreeNodeFieldValuesXML     (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      fieldList,

                                                                     const std::string&      valueList,

                                                                     const std::string&      author);

     void                    handleFillCreateTreeNodeRecordsXML      (HttpXmlDocument&        xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      author);

     void                    handleFillDeleteTreeNodeRecordsXML      (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList);

     void                    handleFillRenameTreeNodeRecordsXML      (HttpXmlDocument&        xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     const std::string&      newRecordList);

     void                    handleFillCopyTreeNodeRecordsXML        (HttpXmlDocument&        xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      startPath,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      recordList,

                                                                     unsigned int            numberOfCopies = 1);

     void                    handleFillModifiedTablesXML             (HttpXmlDocument&       xmldoc, ConfigurationManagerRW* cfgMgr);


     void                    handleSaveTreeNodeEditXML               (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      tableName,

                                                                     TableVersion            version,

                                                                     const std::string&      type,

                                                                     const std::string&      uid,

                                                                     const std::string&      column,

                                                                     const std::string&      newValue,

                                                                     const std::string&      author);

     void                    handleGetAffectedGroupsXML              (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      rootGroupName,

                                                                     const TableGroupKey&    rootGroupKey,

                                                                     const std::string&      modifiedTables);

     void                    handleGetLinkToChoicesXML               (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      linkToTableName,

                                                                     const TableVersion&     linkToTableVersion,

                                                                     const std::string&      linkIdType,

                                                                     const std::string&      linkIndex,

                                                                     const std::string&      linkInitId);


     void                    handleSavePlanCommandSequenceXML        (HttpXmlDocument&       xmldoc,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const std::string&      modifiedTables,

                                                                     const std::string&      author,

                                                                     const std::string&      planName,

                                                                     const std::string&      commandString);


     void                    handleMergeGroupsXML                    (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupANameContext,

                                                                     const TableGroupKey&    groupAKeyContext,

                                                                     const std::string&      groupBNameContext,

                                                                     const TableGroupKey&    groupBKeyContext,

                                                                     const std::string&      groupANameConfig,

                                                                     const TableGroupKey&    groupAKeyConfig,

                                                                     const std::string&      groupBNameConfig,

                                                                     const TableGroupKey&    groupBKeyConfig,

                                                                     const std::string&      author,

                                                                     const std::string&      mergeApproach);


     void                    handleGetArtdaqNodeRecordsXML           (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      modifiedTables);

     void                    handleSaveArtdaqNodeRecordsXML          (const std::string&      nodeString,

                                                                     const std::string&      subsystemString,

                                                                     HttpXmlDocument&        xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      modifiedTables);

     void                    handleLoadArtdaqNodeLayoutXML           (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManager*   cfgMgr,

                                                                     const std::string&      contextGroupName = "",

                                                                     const TableGroupKey&    contextGroupKey  = TableGroupKey()) const;

     void                    handleSaveArtdaqNodeLayoutXML           (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      layoutString,

                                                                     const std::string&      contextGroupName = "",

                                                                     const TableGroupKey&    contextGroupKey  = TableGroupKey());

     void                    handleOtherSubsystemActiveGroups        (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     bool                    getFullList,

                                                                     std::string             targetSubsystem = "");

     void                    handleGroupDiff                         (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      groupName,

                                                                     const TableGroupKey&    groupKey,

                                                                     const TableGroupKey&    diffKey = TableGroupKey(),

                                                                     const std::string&      diffGroupName = "");

     void                    handleTableDiff                         (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      tableName,

                                                                     const TableVersion&     vA,

                                                                     const TableVersion&     vB);

     void                    handleSearchFieldInGroupXML             (HttpXmlDocument&       xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string&      searchText,

                                                                     const bool              activeGroupsOnly,

                                                                     const std::string&      groupType,

                                                                     const std::string&      optionGroups,

                                                                     const std::string&      versionsToCheck);

     void                    handleSearchFieldInTableXML(            HttpXmlDocument& xmlOut,

                                                                     ConfigurationManagerRW* cfgMgr,

                                                                     const std::string& searchText,

                                                                     const std::string& tableName,

                                                                     const std::string& searchVersionToCheck,

                                                                     bool activeTablesOnly);


     void                    testXDAQContext                         (void);


     enum

     {

         CONFIGURATION_MANAGER_EXPIRATION_TIME   = 60 * 60 * 24 * 2,

         CONFIGURATION_MANAGER_REFRESH_THRESHOLD = 60 * 60 * 24,

     };


     ConfigurationManagerRW* refreshUserSession                      (std::string username,

                                                                     bool        refresh);


     std::map<std::string, ConfigurationManagerRW*> userConfigurationManagers_;

     std::map<std::string, time_t>                  userLastUseTime_;

 };


 // clang-format on

 }  // namespace ots


 #endif

ots::ConfigurationGUISupervisor
Definition: ConfigurationGUISupervisor.h:14

ots::ConfigurationGUISupervisor::forceSupervisorPropertyValues
virtual void forceSupervisorPropertyValues(void) override
override to force supervisor property values (and ignore user settings)
Definition: ConfigurationGUISupervisor.cc:156

ots::ConfigurationGUISupervisor::setSupervisorPropertyDefaults
virtual void setSupervisorPropertyDefaults(void) override
Definition: ConfigurationGUISupervisor.cc:137

ots::ConfigurationGUISupervisor::ConfigurationGUISupervisor
ConfigurationGUISupervisor(xdaq::ApplicationStub *s)
Definition: ConfigurationGUISupervisor.cc:41

ots::ConfigurationGUISupervisor::instantiate
static xdaq::Application * instantiate(xdaq::ApplicationStub *s)
Definition: ConfigurationGUISupervisor.cc:32

ots::ConfigurationManagerRW

ots::ConfigurationManager

ots::ConfigurationTree

ots::CoreSupervisorBase

ots::HttpXmlDocument

ots::TableGroupKey

ots::TableVersion