From OpenSCADAWiki
Jump to: navigation, search
This page is a translated version of the page Modules/WebUser and the translation is 100% complete.

Other languages:
English • ‎российский • ‎українська
Модуль Ім'я Версія Ліцензія Джерело Мови Платформи Тип Автор Опис
WebUser WWW-сторінка користувача 1.0 GPL2 ui_WebUser.so en,uk,ru,de x86,x86_64,ARM Користувацькі інтерфейси Роман Савоченко Забезпечує створення власних WWW-сторінок на внутрішній мові OpenSCADA.

Модуль надає користувачу механізм створення WWW-сторінок, а також дозволяє обробляти інші WWW-запити на внутрішній мові OpenSCADA, зазвичай це JavaLikeCalc, не залучаючи при цьому низькорівневого програмування. У ролі обробнику сторінок модуль дозволяє використовувати стандартні шаблони DAQ. Використання шаблонів DAQ дозволяє створювати бібліотеки WWW-сторінок та виклик їх у цьому модулі багаторазово, як їх реалізації, а також надає контекст даних виконання шаблону із їх зв'язуванням з даними підсистеми "Збір Даних".

Окрім приналежності модуля до OpenSCADA він також належить та є модулем модуля транспортного протоколу Protocol.HTTP. Власне виклик модулю WebUser здійснюється з Protocol.HTTP та за посередництвом розширеного механізму комунікації, експортованими у цьому модулі функціями: HTTP_GET(), HTTP_POST().

Адресація сторінок починається із другого елементу URI. Що пов'язано із тим, що перший елемент URI використовується для ідентифікації самого модуля користувацького WWW-інтерфейсу. Наприклад, URL http://localhost.localdomain:10002/WebUser/UserPage можна розшифрувати як виклик користувацької сторінки "UserPage" цього модуля на хості "localhost.localdomain" через порт 10002. У випадку відсутності другого елементу URI та вказання на відображення індексу користувацьких сторінок у конфігурації — формується індекс сторінок (рис.1).

Рис.1. Індекс користувацьких сторінок.

Головна вкладка конфігурації модуля (рис.2) містить стан модуля, надає можливість обрання сторінки по замовченню та дозволяє формувати перелік користувацьких сторінок.

Рис.2. Основна вкладка конфігурації модуля.

WWW-сторінки

Модуль надає можливість створення реалізацій WWW-сторінок у об'єкті "Користувацька WWW-сторінка" (рис.3).

Рис.3. Головна вкладка конфігурації користувацької сторінки.

Головна вкладка містить основні налаштування користувацької WWW-сторінки:

  • Розділ "Стан" — містить властивості, які характеризують стан сторінки: статус, "Ввімкнено", ім'я БД (яка містить конфігурацію) та дату останньої модифікації.
  • Ідентифікатор, ім'я та опис сторінки.
  • Стан "Ввімкнено", у який переводити сторінку при завантажені.
  • Мова прямої процедури або DAQ-шаблон, пов'язаний зі сторінкою.

Всі запити до користувацьких сторінок спрямовуються до процедури обробки запитів користувацької сторінки, або до процедури DAQ-шаблону, яка представлена на вкладці "Програма" об'єкту сторінки користувача (рис.4). У випадку з DAQ-шаблоном також надається вкладка конфігурації шаблону (рис.5).

Рис.4. Вкладка "Процедура" об'єкту користувацької WWW-сторінки.

Вкладка процедури обробки запитів до користувацької сторінки містить:

  • Таблицю контексту даних процедури. Переважно має сенс лише при роботі за шаблоном та де можна контролювати цей процес обробки, включно з можливістю втручання через зміну значень даних.
  • Текст прямої процедури сторінки, відсутній у режимі роботи за шаблоном.
  • Зв'язки на дані підсистеми "Збір Даних", які видимі та доступні для визначення у режимі роботи за шаблоном та у ввімкненому стані об'єкту сторінки.

Для прямої процедури обробки предвизначено, та обов'язкові або опціональні до створення у шаблоні, наступні атрибути обміну з протоколом HTTP:

  • Результат (rez) <Рядок> — результат оброки, за замовченням — "200 OK"; у режимі DAQ-шаблону Ви маєте писати сюди прямо, не оператором "return";
  • Запит HTTP (HTTPreq) <Рядок> — метод HTTP запиту: GET, POST;
  • URL (url) <Рядок> — URI запиту;
  • WWW-сторінка (page) <Рядок> — вміст сторінки Get/Post, як для запиту так і відповіді;
  • Відправник (sender) <Рядок> — відправник запиту;
  • Користувач (user) <Рядок> — аутентифікований користувач;
  • HTTP змінні (HTTPvars) <Об'єкт> — HTTP змінні; змінені та додані змінні (окрім "Date", "Server", "Accept-Ranges" та "Content-Length") будуть розташовані у пакеті відповіді;
  • Параметри URL (URLprms) <Об'єкт> — параметри URL;
  • Елементи вмісту (cnts) <Об'єкт::Array<XMLNodeObj>> — елементи вмісту для POST;
  • Цей об'єкт (this) <Об'єкт> — вказівник на об'єкт цієї сторінки;
  • Об'єкт протоколу (prt) <Об'єкт> — вказівник на об'єкт вхідної частини HTTP-протоколу.

Загальний сценарій запиту користувацької сторінки:

  • Зовнішня мережева станція формує HTTP запит з URI виду "/WebUser/{UserPage}", який попадає на транспорт OpenSCADA із значенням поля конфігурації "Протокол", рівного "HTTP".
  • Транспорт спрямовує запит на модуль транспортного протоколу "Protocol.HTTP".
  • Модуль транспортного протоколу, відповідно до першого елементу URI, спрямовує запит цьому модулю.
  • Цей модуль обирає об'єкт сторінки користувача, яка вказана у другому елементі URI.
  • Здійснюється ініціалізація змінних HTTP-протоколу для процедури сторінки:
    • HTTPreq — встановлюється у значення рядка "GET" або "POST", залежно від типу запиту;
    • url — адреса запитаного ресурсу (URI);
    • page — вміст сторінки, що передається, для методу "POST";
    • sender — адреса відправника запиту;
    • user — ідентифікатор аутентифікованого користувача, якщо аутентифікація мала місце;
    • HTTPvars — розібраний перелік змінних протоколу HTTP у вигляді властивостей об'єкту;
    • URLprms — розібраний перелік параметрів URL у вигляді властивостей об'єкту;
    • cnts — розібрані елементи вмісту для POST, у Array<XMLNodeObj>, з вмістом елементів у тексті з властивостями, у атрибутах XMLNodeObj.
  • Виклик процедури на виконання, яка, обробивши запит, формує вміст сторінки у "page" та результат запиту у "rez".
  • На завершення формується відповідь з кодом повернення HTTP із "rez" та вмістом із "page", а також зміненими та доповненими змінними протоколу HTTP із "HTTPvars".