14. Интерфейс управления системой и динамическое дерево объектов системы (TCntrNode)
Для полного покрытия ключевых компонентов системы сетью объектов единой структуры предназначен объект узла динамического дерева TCntrNode. На этот объект возлагаются следующие функции:
- единообразного доступа к компонентам системы, включая блокировки динамического доступа;
- построение распределённого интерфейса управления.
Любой объект, имеющий потребность в предоставлении динамического доступа к себе или своим компонентам должен наследоваться от объекта узла динамического дерева TCntrNode. Данное родство автоматически включает узел в динамическое дерево объектов, охваченное как прямой, так и обратной связью, а также предоставляет возможность создания контейнеров под собственные дочерние узлы. В дополнении к этому узел получает возможность упреждения про включение и исключение/удаление узла из дерева с возможностью отказа от исключения/удаления.
Интерфейс управления системы включён в состав объекта TCntrNode и, соответственно, охватывает все узлы динамического дерева системы, позволяя единообразно управлять системой вне зависимости от используемого клиентского инструмента. Интерфейс управления системой выполнен на основе языка разметки XML. Можно придумать множество способов использования интерфейса управления системой, в качестве примера отметим следующие наиболее яркие решения:
- Web интерфейс конфигурации;
- GUI интерфейс конфигурации (QT, GTK+, ...);
- отражение конфигурации в сеть для распределённого управления множеством из единой среды администрирования;
- использование в роли протокола для доступа к данным объектов из сети;
- предоставление сервисных функций для доступа третьих приложений и отдельных компонентов OpenSCADA к внутренним данным.
Интерфейс управления системой реализован посредством составляющих:
- информационной структуры конфигурационной пользовательской страницы;
- динамической части в виде запросов на получение, модификацию данных и сервисных запросов;
- контейнера или группы вышеуказанных элементов.
Информационная иерархическая структура содержит информацию о публичных элементах управления и может быть использована для построения пользовательских диалогов управления узлами системы.
Динамическая часть содержит сценарии обслуживания запросов к элементам управления, описанным в информационной структуре, а также скрытые элементы управления в виде сервисных функций, используемые для унифицированного доступа к узлу.
Контейнер позволяет собрать в один запрос несколько информационных структур и динамических частей, оптимизируя тем самым время запроса особенно на сетевых высоколатентных интерфейсах.
Общий интерфейс управления строится из отдельных узлов динамического дерева. Иерархическое наследование от объекта TCntrNode позволяет реализовывать многоуровневое дополнение конфигурации интерфейса управления. Общий вид динамического дерева узлов представлен на рис. 8.
Рис. 8. Пример динамического дерева узлов системы OpenSCADA.
Узлы системы, содержащие данные для интерфейса управления системой также должны подключаться в динамическое дерево объектов.
Подключение узла в динамическое дерево производится следующим образом:
- наследование объекта TCntrNode или его потомка;
- формирование информационной структуры;
- обслуживание запросов к динамическим данным.
14.1. Синтаксис запроса и ответа интерфейса управления
Весь обмен с интерфейсом управления производится посредством языка XML. При этом внутренний обмен выполняется разобранной структурой языка XML (DOM), а внешний — посредством преобразования в поток символов сплошного XML-файла и обратно.
Запрос выполняется посредством отправки одного контейнера с некоторыми параметрами в атрибутах. Результат помещается в полученный контейнер с изменением некоторых атрибутов корневого контейнера. В общем виде контейнер запроса можно записать следующим образом:
<cmd path="/TreePath" user="user" force="1"/>
Где:
path — путь к узлу или ветви узла;
user — пользователь системы от имени которого направлен запрос;
force — признак выполнить запрос без предупреждения.
В подтверждение результата запроса устанавливается атрибут результата rez в значения: 0-запрос прошел, 1-предупреждение (с возможностью выполнения), 2-ошибка. В случае ошибки и предупреждения сообщения записываются в текст контейнера и атрибут mcat (категория сообщения): <cmd path="/TreePath" user="user" force="1" rez="2" mcat="sub_DAQ/mod_BlockCalc>Невозможно удалить узел</cmd>.
Группирующий запрос "CntrReqs" обрабатываются на уровне API узла и не требуют отдельной обработки в пользовательском коде. Фактически в тег "CntrReqs" могут помещаться любые другие запросы с возможностью иерархической группировки путём включения внутренних тегов "CntrReqs". Единственным атрибутом этого тега является атрибут path, который указывает путь к узлу и является основой для внутренних запросов.
<CntrReqs path="/sub_DAQ/cntr_gate">
<get path="/%2fprm%2fcfg%2fNAME"/>
<get path="/%2fprm%2fcfg%2fDESCR"/>
<list path="/%2fserv%2fattr"/>
</CntrReqs>
14.2. Тег информационной структуры для описания групп дочерних веток страницы
Каждая страница может содержать группы дочерних ветвей. Для описания групп ветвей предусмотрен тег branches. Тег содержит описание групп ветвей посредством вложенных тегов grp. К тегу группы возможен доступ как на "чтение" (видимость) так и на модификацию (выполнение команд добавления и удаления элементов группы), следовательно элемент триады доступа может принимать значения:
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение, и на запись.
Действия над группой элементов полностью совпадают с действиями над списком визуальных элементов "list", о котором написано ниже.
14.3. Теги описания информационной структуры интерфейса управления
Информационные теги для языка XML составляют алфавит формирования описания конфигурационных диалогов. Команда запроса информационной части имеет вид: <info path="/TreePath" user="user"/>
В результате запроса будет получена информационная структура страницы в соответствии с привилегиями указанного пользователя.
14.3.1. Тег области "area"
Области описываются тегом area и предназначены для группировки элементов по различным признакам. Область может включать другие элементы и области. Корневые области формируют закладки в представлении пользовательского интерфейса. К тегу возможен доступ только на "чтение" или "видимость", следовательно элемент триады доступа может принимать значение 00, если доступ отсутствует, или 04, если присутствует.
<area id='base' dscr='Base information'>
<fld id='host' dscr='Host name' tp='str'/>
<fld id='user' dscr='Operated user' tp='str'/>
<fld id='sys' dscr='Station system' tp='str'/>
<area id='other' dscr='Other options'>
<fld id='val' dscr='Value' tp='real'/>
</area>
</area>
14.3.2. Теги данных
Теги, описывающие данные, сведены в таблице 1.
Таблица 1. Теги, описывающие данные
| Тег | Описание |
| <fld> | Простейшие данные строкового, целого, вещественного и логического типов. |
| <list> | Списки с данными строкового, целого, вещественного и логического типов. |
| <table> | Таблицы с данными в ячейках строкового, целого, вещественного и логического типов. |
| <img> | Изображения. |
a) Тег "fld"
<fld id='host' dscr='Host name' tp='str'/>
<fld id='user' dscr='Operated user' tp='str'/>
<fld id='sys' dscr='Station system' tp='str'/>
К тегу возможен доступ как на "чтение", так и на "запись", следовательно элемент триады доступа может принимать значения:
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение и на запись.
Тип элемента, описываемого тегом "fld", указывается атрибутом tp (таблица 2).
Таблица 2. Значения атрибута tp тега "fld".
| Тег tp | Описание |
| str | Строковый тип. <fld id='host' dscr='Host name' tp='str'/> |
| dec | Целое число в десятичном представлении. <fld id='debug' dscr='Debug level' tp='dec'/> |
| oct | Целое число в восьмеричном представлении. <fld id='cr_file_perm' dscr='Make files permissions(default 0644)' tp='oct' len='3'/> |
| hex | Целое число в шестнадцатеричном представлении. |
| real | Вещественное число. |
| bool | Логический признак ("false"|"true"). <fld id='log_sysl' dscr='Direct messages to syslog' tp='bool'/> |
| time | Время в секундах (от 01/01/1970). <fld id='v_beg' dscr='Start time' tp='time'/> |
Таблица 3. Действия над элементом, описанным тегом "fld".
| Операция | Действие |
| Опрос | Запрос: команда "get": <get path="/fld_teg" user="user"/>. Результат: подтверждение со значением в тексте тега или сообщение об ошибке. |
| Модификация | Запрос: команда "set": <set path="/fld_teg" user="user">value</set> Результат: подтверждение или сообщение об ошибке. |
| Запрос правил подсветки синтаксиса, для текстовых полей (определён атрибут "rows"). | Запрос: команда "SnthHgl": <SnthHgl path="/fld_teg" user="user"/> Результат: подтверждение со списком правил подсветки синтаксиса:
<rule expr="\b(if|else|for|while|in|using|new|var|break|continue|return|Array|Object)\b" color="darkblue" font_weight="1"/> |
b) Тег "list"
<list id='mod_auto' dscr='List of shared libs(modules)' tp='str' dest='file'/>
К тегу возможен доступ как на "чтение", так и на "запись"(модификацию), следовательно элемент триады доступа может принимать значения:
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение и на запись.
Тип элементов в списке указывается атрибутом tp. Значения атрибута tp приведены в таблице 1.
Таблица 4. Действия над списком.
c) Тег "table"
<table id='a_mess' key='0' col_lst="0;1;2">
<list id='0' dscr='Id' acs='4' tp='str'/>
<list id='1' dscr='Name' acs='4' tp='str'/>
<list id='2' dscr='Type' acs='4' tp='str'/>
<list id='3' dscr='Hide' acs='4' tp='bool'/>
</table>
К тегу таблицы и колонкам отдельно возможен доступ как на "чтение", так и на "запись"(модификацию), следовательно элемент триады доступа может принимать значения:
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение и на запись.
Если указан атрибут key и в нём перечислены ключевые колонки, то работа с таблицей переходит в режим адресации по идентификаторам колонок и ключам.
Таблица 5. Действия над таблицей.
d) Тег "img"
<img id='ico' descr='Иконка страницы'/>
К тегу возможен доступ как на "чтение", так и на "запись", следовательно элемент триады доступа может принимать значения:
04 — присутствует доступ только на чтение;
02 — присутствует доступ только на запись, обычно такое значение не имеет смысла поскольку доступ на запись подразумевает и доступ на чтение;
06 — присутствует доступ и на чтение и на запись.
Тег предназначен для передачи изображений клиентам интерфейса управления. Под изображением могут выступать: иконки страниц, графики массивов значений и другие данные, которые можно представить в графическом виде.
Поддерживаются команды запросов:
- <get path="/fld_teg" user="user"/> — запрос изображения;
- <set path="/fld_teg" user="user">img</set> — загрузка изображения.
e) Команды с параметрами. Тег "comm"
<comm id='add'>
<fld id='tm' tp='time'/>
<fld id='cat' tp='str'/>
<fld id='lvl' tp='dec' min='0' max='7'/>
<fld id='mess' tp='str'/>
</comm>
К тегу возможен доступ как на "чтение" или видимость+обслуживание запросов, так и на модификацию или выполнение команды, следовательно элемент триады доступа может принимать значение 00, если доступ отсутствует вообще; 04, если команду можно увидеть; и 06, если команду можно инициировать.
Предназначен для передачи команд и действий узлу, а также может использоваться для создания ссылок на другие страницы. Команды могут включать параметры. Параметры описываются тегом "fld".
Поддерживаются команды запросов:
- Вызов команды:
<set path="/fld_teg" user="user"/>
<fld id='tm'>1023456244</fld>
<fld id='cat'>*</fld>
<fld id='lvl'>2</fld>
<fld id='mess'>Test mess</fld>
</set>
- Загрузка ссылки на другую страницу:
<get path="/fld_teg" user="user" tp="lnk"/>"
Результатом является подтверждение или сообщение об ошибке.
f) Ветки (дочерние узлы)
<list id='k_br' dscr='Kernel branches' tp='br'/>
Ветки описываются обычным списком "list" со специальными атрибутами tp='br'. Методика запроса и модификации веток полностью совпадает с методикой работы со списком "list".
14.4 Иерархические зависимости информационных элементов языка управления
Пример страницы узла языка управления:
<oscada_cntr>
<area id='a_gen' dscr='Generic control'>
<fld id='config' dscr='Config file' tp='str' dest='file'/>
<fld id='cr_file_perm' dscr='Files' tp='oct' len='3'/>
<fld id='cr_dir_perm' dscr='Directories' tp='oct' len='3'/>
<comm id='upd_opt' dscr='Update options(from config)'/>
<comm id='quit' dscr='Quit'/>
</area>
<area id='a_kern' dscr='Kernels'>
<list id='k_br' dscr='Kernels' tp='br'/>
</area>
</oscada_cntr>
Таблица 6. Иерархические зависимости информационных элементов языка:
14.5. Объект узла динамического дерева (TCntrNode)
| Наследуется: | Всеми динамическими и управляемыми объектами прямо или через потомков. |
Данные:
Именованные права доступа к элементам управления (define):
- R_R_R_ (0444) — доступ всем только на чтение;
- R_R___ (0440) — доступ на чтение только владельцу и группе;
- R_____ (0400) — доступ на чтение только владельцу;
- RWRWRW (0666) — полный доступ для всех;
- RWRWR_ (0664) — полный доступ владельцу и группе, а всем остальным только на чтение;
- RWR_R_ (0644) — полный доступ владельцу, а группе и всем остальным только на чтение;
- RWR___ (0640) — полный доступ владельцу, только на чтение - группе и закрыт всем остальным;
- RW____ (0600) — полный доступ владельцу, а группе и всем остальным закрыт.
Флаги динамического узла (enum TCntrNode::Flag):
- TCntrNode::DoDisable — отключение (0);
- TCntrNode::Disabled — отключен (1);
- TCntrNode::DoEnable — включение (2);
- TCntrNode::Enabled — включен (3);
- TCntrNode::SelfModify — признак модификации узла (0x04);
- TCntrNode::SelfModifyS — признак сохранения модификации узла в "load_()" (0x08);
- TCntrNode::SelfSaveForceOnChild — принудительно сохранять, вызывать "save_()", если изменены-сохраняются дочерние узлы (0x10).
Флаги режимов включения/отключения узла (enum TCntrNode::Flag):
- TCntrNode::NodeConnect — подключение узла;
- TCntrNode::NodeRestore — восстановление подключения узла.
Флаги модификации узла (enum TCntrNode::ModifFlag):
- TCntrNode::Self — данный узел модифицирован;
- TCntrNode::Child — модифицированы дочерние узлы;
- TCntrNode::All — модифицирован данный узел и дочерние.
Публичные методы:
- TCntrNode( TCntrNode *prev = NULL ); — Инициализация с указанием родительского узла prev.
- virtual string objName( ); — Имя объекта. Объект-наследник должен доопределить суммарное имя объекта.
- virtual TCntrNode &operator=( const TCntrNode &node ); — Виртуальная функция копирования узлов динамического дерева.
- void cntrCmd( XMLNode *opt, int lev = 0, const string &path = "", int off = 0 ); — Команда работы с интерфейсом управления системы. Поддерживаются транспортные переходы по полному пути вида: где %2fgen закодированный вложенный путь к конкретному полю страницы (/gen).
- static XMLNode *ctrId( XMLNode *inf, const string &n_id, bool noex = false ); — Получение узла XML по значению атрибута 'id' n_id. Поддерживаются запросы XML узла по полному пути к нему вида (node1/node2/node3).
- static XMLNode *_ctrMkNode( const char *n_nd, XMLNode *nd, int pos, const char *req, const string &dscr, int perm = 0777, const char *user = "root", const char *grp = "root" );
static XMLNode *ctrMkNode2( const char *n_nd, XMLNode *nd, int pos, const char *req, const string &dscr, int perm = 0777, const char *user = "root", const char *grp = "root", ... );
— Добавление элемента управления на страницу. Возможно указание множества дополнительных атрибутов в количестве n_attr в виде: "{атрибут1},{значений1},{атрибут2},{значений2},..." или по нулевому указателю в конце последовательности пар.
- bool ctrRemoveNode( XMLNode *nd, const char *path ); — Удаление элемента управления path на странице nd.
- static bool ctrChkNode( XMLNode *nd, const char *cmd="get", int perm=0444, const char *user="root", const char *grp="root", char mode=04, const char *warn = NULL ); — Проверка на получение динамической команды cmd и наличие прав на её исполнение.
- ResMtx &dataRes( ); — Мютекс использования ресурсов узла общего назначения.
- virtual const char *nodeName( ) const; — Имя узла.
- virtual const char *nodeNameSYSM( ) const; — Имя элемента расположения системного сообщения, для помещения его в текст системного сообщения функцией "mess_sys" и "err_sys". Пустое значение, по умолчанию, для пропуска данного узла.
- string nodePath( char sep = 0, bool from_root = true ) const; — Получение полного пути к узлу, начиная с корня from_root, и используя разделитель sep или обычную запись пути.
- void nodeList( vector<string> &list, const string& gid = "" ); — Список дочерних узлов list в указанной группе gid.
- AutoHD<TCntrNode> nodeAt( const string &path, int lev = 0, char sep = 0, int off = 0, bool noex = false ); — Подключение к дочернему узлу.
- void nodeDel( const string &path, char sep = 0, int flag = 0 ); — Удаление узла по его полному пути.
- static void nodeCopy( const string &src, const string &dst, const string &user = "root" ); — Копирование узлов динамического дерева.
- TCntrNode *nodePrev( bool noex = false ) const; — Адрес родительского узла.
- char nodeFlg( ); — Флаги узла.
- void setNodeFlg( char flg ); — Установка флагов TCntrNode::SelfModify, TCntrNode::SelfModifyS и TCntrNode::SelfSaveForceOnChild.
- char nodeMode( ) const; — Состояние узла.
- unsigned nodeUse( bool selfOnly ); — Количество подключений к узлу. selfOnly — только собственных подключений, без дочерних.
- unsigned nodePos( ); — Положение данного узла в контейнере узла-владельца. Достоверно только для упорядоченных контейнеров.
- int isModify( int mflg = TCntrNode::All ); — Проверка факта модификации узла или ветви узлов.
- void modif( bool save = false ); — Установка признака модифицированности узла, с признаком сохранения save.
- void modifG( ); — Установка признака модифицированности ветви узлов.
- void modifClr( bool save = false ); — Очистка признака модифицированности узла или признака сохранения save.
- void modifGClr( ); — Очистка признака модифицированности ветви узлов.
- void load( TConfig *cfg = NULL, string *errs = NULL ); — Загрузка узла динамического дерева для готовой конфигурации cfg. Ошибки загрузки помещаются строками в errs.
- void save( unsigned lev = 0, string *errs = NULL ); — Сохранение узла динамического дерева, на уровне вложенности lev (служебный). Ошибки сохранения помещаются строками в errs.
- virtual void AHDConnect( ); — Подключение к узлу (захват ресурса).
- virtual bool AHDDisConnect( ); — Отключение от узла (освобождение ресурса). Удаление при нулевом результате.
- void mess_sys( int8_t level, const char *fmt, ... ); — Формирование системного сообщения для пути узла в качестве категории, уровня level, форматированного сообщения fmt, дополненного расположением узла, и следующими аргументами.
- TError err_sys( const char *fmt, ... ) const; TError err_sys( int cod, const char *fmt, ... ) const; — Формирование объекта ошибки для пути узла в качестве категории, кода cod, форматированного сообщения fmt, дополненного расположением узла, и следующими аргументами.
- virtual TVariant objPropGet( const string &id ); — Запрос свойства узла как пользовательского объекта.
- virtual void objPropSet( const string &id, TVariant val ); — Установка свойства узла как пользовательского объекта.
- virtual TVariant objFuncCall( const string &id, vector<TVariant> &prms ); — Вызов функции узла как пользовательского объекта.
- int8_t grpSize( ); — Количество контейнеров с дочерними узлами.
- int8_t grpId( const string &sid ); — Получение индекса группы по её идентификатору.
- virtual AutoHD<TCntrNode> chldAt( int8_t igr, const string &name, const string &user = "" ) const; — Подключение к дочернему узлу name контейнера gr пользователя user.
- void chldList( int8_t igr, vector<string> &list, bool noex = false ) const; — Список дочерних узлов list в указанном контейнере gr.
- bool chldPresent( int8_t igr, const string &name ) const; — Проверка на присутствие указанного дочернего узла name в контейнере gr.
Защищённые методы:
- virtual void cntrCmdProc( XMLNode *req ); — Функция обслуживания запросов интерфейса управления. Должна переопределяться у потомка.
- void nodeEn( int flag = 0 ); — Включение узла.
- void nodeDis( long tm = 0, int flag = 0 ); — Отключение узла с передачей флага.
- void nodeDelAll( ); — Очистка всех контейнеров с дочерними узлами.
- void setNodePrev( TCntrNode *node ); — Установка родительского узла в node.
- void setNodeMode( char mode ); — Установка состояния узла.
- GrpEl &grpAt( int8_t id ); — Доступ к структуре группы.
- unsigned grpAdd( const string &id, bool ordered = false ); — Добавление контейнера дочерних узлов с префиксом id и возможностью упорядоченного хранения ordered. Возвращает идентификатор нового контейнера.
- void grpDel( int8_t id ); — Удаление контейнера дочерних узлов id.
- virtual void chldAdd( int8_t igr, TCntrNode *node, int pos = -1 ); — Добавление дочернего узла node в контейнер gr и позицию pos.
- void chldDel( int8_t igr, const string &name, long tm = -1, int flag = 0 ); — Удаление дочернего узла name из контейнера gr с флагом flag.
- virtual void preEnable( int flag ); — Упреждение о подключении. Вызывается перед реальным подключением.
- virtual void postEnable( int flag ); — Упреждение о подключении. Вызывается после реального подключения.
- virtual void preDisable( int flag ); — Упреждение о отключении. Вызывается перед реальным отключением.
- virtual void postDisable( int flag ); — Упреждение о отключении. Вызывается после реального отключения (перед удалением).
- virtual void load_( ); virtual void load_( TConfig *cfg ); — Функция вызова загрузки узла у потомка для готовой конфигурации cfg.
- virtual void save_( ); — Функция вызова сохранения узла у потомка.