Alterator on rails

(alterator fbi)

Меня часто спрашивали, а возможно ли работать с alterator, не занимаясь написанием интерфейсов на Scheme.
Отвечаю. Да, теперь это возможно. Пока работает только для html, но вполне возможно что появится реализация для чистого Qt.

Распределение обязанностей участников проекта становится следующим:

• Системный администратор пишет бакенды, на любимом скриптовом языке
• Дизайнер интерфейсов, рисует красивые html-страницы
• Создатель решения, легко и ненавязычиво склеивает всё это небольшим количеством кода на Scheme

Давайте совместно пройдём все эти шаги и поймём как всё делается:

1. Администратор

Пусть у нас есть бакенд управления пользователями, который предоставляет следующую модель:
/users – пользователи системы
/users/<name> – конкректный пользователь системы

Свойства каждого объекта пользователя:

• home – домашний каталог
• gecos – комментарий
• shell – оболочка, запускаемая при входе в систему

Возможно протестировать свой модуль при помощи интерфейса командной строки:

$ alterator -l -c cmdline.layout /users/stas_a action read (("/users/stas_a" gecos "hasher satellite for stas" home "/dev/null" shell "/dev/null"))

При использовании пакета alterator-fbi, возможна прямая работа (и отладка) бакенда через html-интерфейс.
Чтобы механизм, заключённый в alterator-fbi смог понять как надо отображать тот или иной бакенд
(кто есть объект, а кто список объектов), ему надо немного помочь.

Для каждого бакенда с именем <бакенд>, который мы желаем видеть в html интерфейсе, создаём парный бакенд с именем «template-<бакенд>". Он и будет отвечать на все вопросы по отображению своего напарника.

Для users, бакенд template-users, будет выглядеть примерно следующим образом:
#!/bin/sh #turn off auto expansion set -f . /usr/share/alterator/build/backend3.sh on_message() { case "$in_action" in #information for renderer template) if [ "$in__objects" = "/" ];then echo '(' echo 'template "list" ' echo 'title "System users"' echo 'keys (gecos)' echo 'fields ("User" "Comment")' echo ')' else echo '(' echo 'template "object"' echo 'title "User information"' echo ')' fi ;; info) if [ "$in__objects" = "/" ]; then echo '()' else echo '(' echo 'gecos (input title "Comment")' echo 'home (input title "Home directory")' echo 'shell (select title "Shell" options "shells")' echo ')' fi ;; *) echo '#f' esac } message_loop

Как видите, это самый обыкновенный бакенд, который отвечает на вопросы template и info.
Вопрос template, самый главный. В примере с users мы говорим, что:

• /users – это список объектов (будет представлен как таблица), озаглавленный “System users”, помимо простого перечисления имён мы хотим тут же в табличке увидеть и комментарии к ним (ключ gecos). Колонки таблицы озаглавлены как “User” и “Comment”.
• /users/<name> – это одиночный объект, озаглавленный “User Information”.

Вопрос info, дополнительный. Он может вообще отсутствовать, всё зависит от того что мы попросили в разделе “template”.
В данном случае мы просто перечисляем поля объекта, с которыми хотели бы работать через html-интерфейс.

Для каждого поля сообщается имя поля в команде woo (например home для получения значения домашнего каталога пользователя), а также информация о типе поля. Возможные типы:

• input – простая строка ввода
• textarea – многострочное текстовое поле
• select – выбор одного варианта из возможных. Одним из параметров идёт адрес, откуда из бакенда следует взять полный список вариантов. В данном случае список возможных оболочек для объекта /users/<name> будет браться в результате запроса “list” по адресу /users/<name>/shells.

Вот в общем-то и всё что требуется от администратора. После того как запускается alterator с раскладкой fbi.layout (alterator -c fbi.layout),
можно направляться по адресу "http://hostname/fcgi-bin/alterator-template.scm/users" и работать с бакендом.

Обратите внимание, что окончание пути совпадает именем объекта внутри woo, например объекту '/users/test' соответствует адрес
http://hostname/fcgi-bin/alterator-template.scm/users/test.

Сразу же вы получаете возможность и редактировать и создавать и удалять объекты. То есть пользуясь готовыми интерфейсными шаблонами администратор может, при желании, отлаживать работу бакенда прямо в том виде как он будет потом работать на сервере.

Дизайнер

Интерфейсные шаблоны по умолчанию совсем не плохо, но людям свойственно стремиться к прекрасному, особенно когда они собираются потом это прекрасное кому-то продать ;)

Дизайнер может так же как и администратор не отвлекаться на особенности внутреннего устройства конструкторва, он просто делает красивые формы, отмечая особым образом те фрагменты интерфейса, в которые должны попасть реальные данные бакенда.

Конструктор

Конструктору единственному надо знать устройство инструмента с которым он работает. Но знания эти не многочисленные и приятные.

Пусть администратор написал нам бакенд для редактирования общих настроек сети (имя машины, сервера DNS) – net-general, отладил его.
Возможно даже посмотрел как он работает внутри интересующего нас решения с помощью готового шаблона “object”.

Пусть теперь дизайнер нарисовал для нас красивую форму, в которой должны будут появиться реальные данные.
Внешне форма выглядит так:

А html-код устроен таким образом, что нам надо просто «добавить» свои поля к div отмеченным соответствующим классом.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> <html> <head> <title>Alterator-FBI:Edit object</title> <link type="text/css" rel="stylesheet" href="/fbi/net-general.css"/> <meta http-equiv="Cache-Control" value="no-cache"/> <meta http-equiv="Content-Type" value="text/html;charset=utf-8"/> </head> <body> <div class="title"> <img src="/fbi/alterator-network.gif"/> General Network Options </div> <form method="POST"> <div class="hostname"><span class="label">Hostname:</span></div> <table> <tbody> <tr> <td> <div class="search"> <p><span class="label">Search Domains:</span></p> </div> </td> <td> <div class="dns"> <p><span class="label">Domain Name Servers (DNS):</span></p> </div> </td> </tr> </tbody> </table> <p> <input class="button" type="submit"/> <input class="button" type="reset"/> </p> </form> </body> </html>

Сразу оговорюсь, что возможно производить любые модификации созданного шаблона, вплоть до создания собственных тегов со специальными параметрами.

Итак, все компоненты готовы, начинаем собирать наше творение воедино. Сначала в «подсказывающем» бакенде template-net-general, скажем что мы хотим использовать интерфейсный шаблон не “object”, а некий “net-general”

!/bin/sh #turn off auto expansion set -f . /usr/share/alterator/build/backend3.sh on_message() { case "$in_action" in #information for renderer template) if [ "$in__objects" = "/" ];then echo '(template "net-general" )' else echo '#f' fi ;; *) echo '#f' esac } message_loop

А затем и создадим сам шаблон:
(define (get-net-general url url-args template-args) (call-with-woo-read "/net-general" (lambda(obj) (template "/var/www/html/fbi/net-general.html" (tag: "div" (@ 'class "hostname") (@ 'template-operation 'append-content) (html:input 'hostname (woo-get-option obj 'hostname))) (tag: "div" (@ 'class "search") (@ 'template-operation 'append-content) (html:textarea 'search (woo-get-option obj 'search) (@ 'cols "40") (@ 'rows "5"))) (tag: "div" (@ 'class "dns") (@ 'template-operation 'append-content) (html:textarea 'dns (woo-get-option obj 'dns) (@ 'cols "40") (@ 'rows "5"))))))) (define (post-net-general url url-args template-args) (woo-catch (thunk (apply woo-write "/net-general" (alist->plist (woo-args url-args))) (template "/var/www/html/fbi/net-general.html" (tag: "form" (html: "p" (html: "b" "Request completed")) (html: "p" (html:a "[Return]" url))))) html:woo-error)) ;;register as an "object" template (register-get-template "net-general" get-net-general) (register-post-template "net-general" post-net-general)

Что же тут происходит?

Регистрируются два обработчика. Один на get запросы, второй на post.
В каждом из случаев производятся запросы к соответствующем бакенду и результат выводится в виде «подстановок» в готовой html страничке, созданной дизайнером.
Использование html-шаблона вовсе не обязательно, но предпочтительно.

Созданный шаблон назовём так как нам нравится (например net-general.scm) и поместим в каталог /usr/share/alterator/templates.

Запускаем браузер, идём по адресу http://hostname/fcgi-bin/alterator-template.scm/net-general и наблюдаем результат:

Вот и всё, интерфейс готов к употреблению.

Конечно я не вдавался в подробности как создаются собственные интерфейсные шаблоны – всё будет описано в отдельном документе.