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

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

Модуль транспортного протоколу HTTP призначено для реалізації підтримки мережевого протоколу HTTP(Hypertext Transfer Protocol) у OpenSCADA.

Протокол HTTP використовується для передачі вмісту WWW. Так, через HTTP передаються наступні типи документів: html, xhtml, png, javascript та багато інших. Підтримка HTTP у OpenSCADA, у комплексі із транспортом Sockets, дозволяє реалізовувати різні користувацькі функції на основі WWW інтерфейсу. Модуль реалізує два основних методи протоколу HTTP: GET та POST. Модуль забезпечує контроль цілісності HTTP-запитів та, спільно з транспортом Sockets, дозволяє "збирати" цілісні запити з їх фрагментів, а також забезпечувати утримання з'єднання "живим" (Keep-Alive).

Для гнучкого підключення користувацьких інтерфейсів до даного модуля, використовується модульний механізм у межах самого цього модуля. У ролі модулів використовуються модулі підсистеми "Користувацькі інтерфейси" з додатковим інформаційним полем "SubType", яке має значення "WWW".

У запитах до Web ресурсів прийнято використовувати URL(Universal Resource Locator). Відтак, URL передається як основний параметр через HTTP. Перший елемент URL запиту використовується для ідентифікації модуля UI. Наприклад, URL "http://localhost:10002/WebCfg" означає звернення до модуля "WebCfg" на хості "http://localhost:10002". У випадку помилкового визначення ідентифікатору модуля, або при звернені взагалі без ідентифікатору, модуль генерує інформаційний діалог про вхід та вибір одного з доступних користувацьких інтерфейсів. Приклад діалогу показано на рисунку 1.

Рис.1. Діалог вибору модуля WWW-інтерфейсу.

Модулем підтримується багатомовність, яка вмикається динамічним перекладом повідомлень OpenSCADA.

Мова кінцевого користувацького інтерфейсу визначається шляхом та у послідовності:

  • URL параметр "lang".
  • Мова користувача, що увійшов.
  • Мова Web-браузеру з HTTP властивості "Accept-Language".
  • Загальна мова процесу OpenSCADA.

Отримана таким чином мова використовується для побудови інтерфейсів цього модуля та передається WWW під-модулям у HTTP властивості "oscd_lang", через аргумент "vars" функцій "GET" та "POST".

Для конфігурації та керування цим модулем, надається конфігураційна сторінка інтерфейсу керування OpenSCADA (Рис.3) де Ви можете здійснювати:

  • Контроль за активними сеансами автентифікації.
  • Конфігурацію:
    • Правила доступу для заборони та дозволу. Кожний рядок є окремим правилом та Ви можете використовувати шаблони, на кшталт "*/WebVision/*", або регулярні вирази, на кшталт "/[^/]+/WebVision/.+/".
    • HTML-шаблон користувацького інтерфейсу та користувацької головної сторінки. У полях HTML-шаблону має вказуватися адреса до файлу HTML/XHTML, який буде використано у формуванні внутрішніх-сервісних інтерфейсів та головної сторінки. Внутрішні-сервісні інтерфейси, це наприклад: обрання модулів, сторінка авторизації та подібне у WEB-модулів. Від шаблону вимагається коректність XHTML, яка дозволяє розібрати файл XML-парсером, а також наявність мітки "#####CONTEXT#####" у місці розташування динамічного вмісту, що обов'язково для внутрішніх-сервісних інтерфейсів. Ресурсні файли шаблонів представлено зображеннями, CSS та JavaScript файлами, та які шукаються від теки у якій вказано розташування файлу шаблону та від поточної теки. Для іншого, до мови, файлу шаблону, Ви можете додати суфікс мови у кінець цього файлу "{Мій Шаблон}_{мова}.html", але обирати у конфігураційних полях основний-базовий файл шаблону "{Мій Шаблон}.html". У випадку виявлення помилок у шаблоні, буде використано стандартний вбудований інтерфейс. У якості прикладу шаблонів Ви можете подивитися такі найбільш вживані:
    • БД активних сеансів аутентифікації передбачає зовнішню таблицю активних сеансів аутентифікації — "HTTP_AuthSessions", яка вмикається для непорожнього значення та надає можливість спільного використання аутентифікації між різними станціями OpenSCADA та її короткого збереження на час вимкнення станції.
    • Час життя, перелік користувачів дозволених до аутентифікації та встановлення автоматичного входу.
Рис.3. Сторінка налаштування модуля.

1 Аутентифікація

Модулем підтримується аутентифікація у OpenSCADA при надані доступу до модулів WEB-інтерфейсів (рис.2).

Рис.2. Діалог авторизації у OpenSCADA.

Для полегшення роботи з Web-інтерфейсами модуль передбачає можливість автоматичного входу від ім'я вказаного користувача. Конфігурація автоматичного входу здійснюється на сторінці налаштування модуля (рис.3). Автоматичний вхід здійснюється за збігом адреси, вказаної у стовпчику "Адреса", та від ім'я користувача, вказаного у стовпчику "Користувач".

Для більшої безпеки Ви можете визначити тільки Web-користувачів, у переліку користувачів дозволених до аутентифікації.

2 Модулі WEB-інтерфейсу

Модулі користувацького інтерфейсу (UI), які призначені для спільної роботи з модулем HTTP, мають встановлювати інформаційне поле "SubType" значенням "WWW" та поле "Auth" значенням "1", якщо модуль потребує автентифікації при вході. Для зв'язування модуля HTTP та модулів UI використовується розширений механізм комунікації. Цей механізм передбачає експорт інтерфейсних функцій. У даному, випадку UI модулі мають експортувати функції:

  • void HTTP_GET(const string &url, string &page, vector<string> &vars, const string &user, TProtocolIn *iprt); АБО
void HttpGet( const string &url, string &page, const string &sender, vector<string> &vars, const string &user ); — Метод GET з параметрами:
url — адреса запиту;
page — сторінка з відповіддю;
sender — адреса відправника;
vars — змінні запиту;
user — користувач;
iprt — посилання на об'єкт вхідної частини протоколу.
  • void HTTP_POST(const string &url, string &page, vector<string> &vars, const string &user, TProtocolIn *iprt); АБО
void HttpPost( const string &url, string &page, const string &sender, vector<string> &vars, const string &user ); — метод POST з параметрами:
url — адреса запиту;
page — сторінка з відповіддю та вмістом тіла запиту POST;
sender — адреса відправника;
vars — змінні запиту;
user — користувач;
iprt — посилання на об'єкт вхідної частини протоколу.

Надалі, у випадку надходження HTTP запиту "GET" буде викликатися функція "HTTP_GET" або "HttpGet", а у випадку запиту "POST" буде викликатися функція "HTTP_POST" або "HttpPost", у відповідному модулі UI.

3 Функція вихідних запитів користувацького API

Функція вихідних запитів (messIO()) оперує обміном вмістом HTTP-запитів, загорнутими у XML-пакети. Структура запиту має вигляд:

<req Host="host" URI="uri">
  <prm id="pId">pVal</prm>
  <cnt name="cName" filename="cFileName">
    <prm id="cpId">cpVal</prm>
    cVal
  </cnt>
  reqVal
</req>
Де:
  • req — метод запиту, підтримується методи "GET" та "POST".
  • host — адреса вузла http-серверу у форматі {HostAddr}:{HostIp}. Якщо дане поле опущено то використовується адреса вузла, вказана у полі адреси транспорту.
  • uri — адреса ресурсу на http-сервері, зазвичай файл або тека.
  • pId, pVal — ідентифікатор та значення додаткового http-параметру. Http-параметрів може бути вказано багато, окремими prm тегами.
  • cName, cFileName, cVal — ім'я, ім'я-файлу та значення елементу вмісту POST-запиту. Елементів вмісту може бути вказано багато, окремими cnt тегами.
  • cpId, cpVal — ідентифікатор та значення додаткового параметру вмісту. Параметрів вмісту може бути вказано багато, окремими prm тегами;
  • reqVal — одинокий вміст POST запиту.

Результатом запиту є відповідь зі структурою:

<req Host="host" URI="uri" err="err" Protocol="prt" RezCod="rCod" RezStr="rStr">
    <prm id="pId">pVal</prm>
    respVal
</req>
Де:
  • req — метод запиту.
  • host — адреса вузла http-серверу.
  • uri — адреса ресурсу.
  • err — помилка, яка виникла під час запиту. У випадку вдалого запиту це поле порожнє.
  • RezCod, RezStr — результат запиту у вигляді коду та тексту.
  • pId, pVal — ідентифікатор та значення додаткового http-параметру відповіді. Http-параметрів може бути багато, визначені окремими prm тегами.
  • respVal — вміст відповіді.

Наведемо формування GET та POST запитів на мові JavaLikeCalc.JavaScript, у якості прикладу використання даної функції у користувацьких процедурах:

//GET запит HTML сторінки
req = SYS.XMLNode("GET");
req.setAttr("URI","/");
SYS.Transport.Sockets.out_testHTTP.messIO(req,"HTTP");
test = req.text();

//GET запит та збереження файлу
req = SYS.XMLNode("GET");
req.setAttr("URI","/oscadaArch/Work/openscada-0.9-r2188.tar.lzma");
SYS.Transport.Sockets.out_testHTTP.messIO(req,"HTTP");
if(!req.attr("err").length) SYS.fileWrite("/var/tmp/recvFile.tmp", req.text());

//POST запит
req = SYS.XMLNode("POST");
req.setAttr("URI","/WebUser/FlowTec.txt");
cntNode = req.childAdd("cnt").setAttr("name","pole0").setAttr("filename","Object2-k001-100309-17.txt");
cntNode.childAdd("prm").setAttr("id","Content-Type").setText("text/plain");
cntText = "Object2-k001\r\n";
cntText += "\r\n";
cntText += "v002\r\n";
cntText += " n1\r\n";
cntText += "  09.03.10 16   Polnyj    7155.25    216.0  32.000  17.5\r\n";
cntText += "v005\r\n";
cntText += " n1\r\n";
cntText += "  09.03.10 16   Polnyj     188.81    350.0   4.000  40.0\r\n";
cntText += "\r\n";
cntNode.setText(cntText);
SYS.Transport.Sockets.out_testHTTP.messIO(req,"HTTP");

4 API користувацького програмування

Вхідна частина об'єкту модуля (SYS.Protocol.HTTP.{In})

  • bool pgAccess(string URL) — перевіряє доступність сторінки, визначеної у URL.
    • URL — URL сторінки, що перевіряється.
  • string pgCreator(string cnt, string rcode = "200 OK", string httpattrs = "Content-Type: text/html;charset={SYS}", string htmlHeadEls = "", string forceTmplFile = "", string lang = "" ) — формує сторінку або ресурс із вмістом cnt, загорнутим у HTTP з результатом rcode, із додатковими атрибутами HTTP httpattrs, додатковим елементом заголовку HTML htmlHeadEls та використанням файлу шаблону forceTmplFile та для мови lang.
    • cnt — вміст сторінки або ресурсу (зображення, XML, CSS, JavaScript, ...);
    • rcode — результуючий код HTTP, на кшталт "200 OK"; порожнє значення вимикає додання HTTP заголовку;
    • httpattrs — додаткові атрибути HTTP, переважно це "Content-Type" із значенням по замовченню "text/html;charset={SYS}"; тільки для "Content-Type: text/html" буде здійснюватися загортання у внутрішній/сервісний, або визначений forceTmplFile, HTML-шаблон;
    • htmlHeadEls — додатковий тег заголовку HTML, переважно це META з "Refresh" для вказаного URL;
    • forceTmplFile — файл прямо визначеного шаблону для перекриття внутрішнього/сервісного або головної сторінки.
    • lang — мова інтерфейсу, що формується.