# Apache Rivet

2002 2003 Apache Software Foundation
The Rivet Team
The Apache Software Foundation

    	  rivet-dev@tcl.apache.org

Dmitry the Zuryanovich Russian Translation

    dtz@xepb.ru

Этот документ в переводах на другие языки: English, Italian

This document is based on version 1.34 of the original English version.

## Введение в Apache Rivet

Apache Rivet - это система для генерации динамических веб страниц, встроенная модулем в http сервер Apache. Она задумывалась как система быстрая, мощная, расширяемая и достаточно простая для внедрения. Стоит заметить что с Apache Rivet вы получаете надежную платформу которая не только может интегрироваться в web, но и может быть использована вне его. GUI, инструментарий администратора, XML, манипуляции с БД, консольные приложения могут использовать тот же код, который используется при разработках web-приложений. Это достигается применением языка TCL - вне и внутри Apache сервера.

В этом документе мы постараемся помочь вам быстро разобраться как можно создавать web- приложения, и показать вам дальнейшие пути для разработки приложений используя rivet для самых разнообразных применений.

Эта документация - как и весь rivet, и тем более ее перевод на русский - это работа, которая не заврешена, и будем надеяться будет продолжаться еще очень долго. Если вы видите что что-то где-то почему-то не так - то пишите об этом, мы сами за всем не углядим без вашей помощи. Это Свободное программное обеспечение!

## Установка Apache Rivet

- Check Dependencies/Проверка связей между программным обеспечением

  Для того чтобы установить rivet, вам в первую очередь понадобится сам Tcl, версии 8.4 или выше и веб сервер Apache версий 1.3.x. Известно что все должно работать на Linux, FreeBSD,OpenBSD, Solaris и HPUX. Возможно что можно заставить работать даже на Windows NT - в дистрибутиве написано как это делать.

- Скачайте себе Rivet

  Возьмите исходники отсюда . На данный момент это единственный способ получить rivet. Возможно в дальнейшем появится FreeBSD port, Debian package, RPM и бинарники под Windows.

- Скачайте и соберите Apache

  Rivety нужны заголовки (.h) от Apache. Самый простой способ - это скачать исходники Apache, хотя во многих системах (Debian, например) позволяют поставить отдельно заголовки и прочие вещи, необходимые для разработчиков. Если вы хотите собрать rivet в статике (вместо того чтобы грузить его как .so), то вам придется скачать все исходники apache отсюда . Мы рекомендуем собирать rivet как динамическую библиотеку (shared object), и соответственно собирать его отдельно от Apache.

  Исходный код apache берут тут:

- Разархивация исходников

  Сейчас мы будем считать что apache вами был каким-то образом установлен. Теперь вы должны разархивировать исходники rivet там где вы хотите их собирать.

      gunzip tcl-rivet-X.X.X.tar.gz
      tar -xvf tcl-rivet-X.X.X.tar.gz

- Компиляция Rivet

  Rivet использует некую свою уникальную систему компиляции которую мы специально придумали именно для него. Она использует информацию из инсталяций Apache (через `apxs`)и Tcl, для того чтобы собрать rivet через набор Tcl скриптов, которые находятся `buildscripts/` тут.

  1. Запустите ./configure.tcl

     По смыслу это практчески то же что и `configure`, скрипт который встречается в большинстве систем. Он, конечно же, написан на Tcl. У него есть несколько полезных аргументов:

     -help

       Показывает справку.

     -enable-symbols

       Компилирует Rivet c символами для дебаггера.

     -prefix directory

       Место в котором будет установлен Rivet.

     -with-apxs file

       file который должен использоваться как apxs binary для сбора информации о инсталлированном Apache

     -with-tclconfig file

       Использовать file как tclConfig.sh.

         cd src/
         ./configure.tcl
         Configuring
         .........done.

  2. Запустите make.tcl

     Сейчас нужно скомпилировать Rivet:

         ./make.tcl option

     где option может быть `shared` или `static`.

  3. Установка

     Сейчас самое время запустить `./make.tcl install` чтобы все установить. Эта команда должна скопировать получившийся .so файл (типа `mod_rivet.so`), если он конечно скомпилируется, в директорию Apache `libexec`, а так же установит некоторое количество полезных скриптов и прочего кода.

- Конфигурация Apache

  Конфигурировать Rivet достаточно просто - начнем с того что добавим сам модуль:

      LoadModule rivet_module /usr/lib/apache/1.3/mod_rivet.so

  После этого Apache должен знать что ему надо загрузить Rivet как shared object, чтобы иметь возможность его использовать. Далее мы должны объяснить Apache какие файлы надо обрабатывать Rivetом и как это делать:

      AddType application/x-httpd-rivet .rvt
                AddType application/x-rivet-tcl .tcl

  Эти директивы объяснят Apache что файлы с расширением `.rvt` и `.tcl` надо обрабатывать Rivetом.

  Все остальные директивы описаны тут .

## Конфигурационные параметры Rivet Apache

Это - разнообразный набор установок которые могут быть сделаны в конфигурационнном файле Apache с целью изменения поведения Rivet. Их формат такой: `RivetDirConf`, `RivetUserConf`, `RivetServerConf`, что означает что DirConf имеет более высокий приоритет и перебивает установки в UserConf, что в свою очередь перебивает ServerConf.

`RivetServerConf` CacheSize GlobalInitScript ChildInitScript ChildExitScript BeforeScript AfterScript ErrorScript UploadDirectory UploadMaxSize UploadFilesToVar SeperateVirtualInterps

  `RivetServerConf` Устанавливает глобальные опции для всего сервера

  CacheSize size

    Устанавливает опции для внутреннего кеша для страниц, где `size` - количество компилированных страниц которые будут хранится в кеше для испозьзования в будущем. По умолчанию - `MaxRequestsPerChild` / 5, или 50, если `MaxRequestsPerChild` установлен в 0.

  GlobalInitScript script

    Tcl скрипт который должен быть запущен для каждого интерпретатора.`script` - обычный Tcl скрипт, поэтому чтобы запустить файл -

        RivetServerConf GlobalInitScript "source /var/www/foobar.tcl"

  ChildInitScript script

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

  ChildExitScript script

    Скрипт который будет выполняться когда каждый порожденный Apache процесс оканчивает работу. Это идеальное место чтобы освобождать все ресурсы занятые в `ChildInitScript`.

  BeforeScript script

    Скрипт который будет выполняться перед тем как сервер запустит .rvt страницу. Может быть использован для того, чтобы, например, создавать стандарный header (в терминологии http, например - image/png). Также может быть использован для того чтобы подгружать код который будет использоваться на каждой странице, если вы не хотите это делать в `GlobalInitScript` `ChildInitScript` когда вы разрабатываете веб сайт в первый раз (примечание переводчика: не понимаю, о чем это он? последняя строка - построчник)

    Этот код исполняется на глобальном уровне, а не в том namespace в котором исполняются страницы
  AfterScript script

    Скрипт который будет вызываться после каждой (.rvt) страницы.

  ErrorScript script

    Если внутри rivet произойдет ошибка, то он сооружает некую html-страницу с информацией о том, что собственно, произошло. Если же `ErrorScript` указан, то можно создать свою страницу, которая будет вызываться в этом случае. Это может быть полезно когда вы не хотите показывать пользователю свой код с ошибками.

  UploadDirectory directory

    Директория в которую надо складывать загруженые (uploaded) пользователем файлы.

  UploadMaxSize size

    Максимальный размер для загруженных (uploaded) файлов.

  UploadFilesToVar yes no

    Эта установка регулирует возможность закачки (upload) файлов прямо в Tcl переменную. Если у вас установлено ограничение по размеру на закачиваемые файлы, а вам не особенно хочется общаться со слишком большими файлами, то эта установка позволяет вам складывать их на диск.

  SeperateVirtualInterps yes no

    Если эта опция установлена, то rivet будет создавать отдельный интерпретатор Tcl на каждый VirtualHost в терминологии Apache. Это полезно в ситуации когда вы - хостер и надо чтобы для каждого клиента был свой собственный интерпретатор, чтобы они друг с другом не конфликтовали.

`RivetDirConf` BeforeScript AfterScript ErrorScript UploadDirectory

  Эта установка - тоже самое что `RivetServerConf`, кроме того что они касаются только той директории в которой они указаны, и ее поддиректорий. Можно использовать в `Directory` разделах.

`RivetUserConf` BeforeScript AfterScript ErrorScript UploadDirectory

  Эти опции - то же самое что и `RivetServerConf`, кроме лишь того что они действуют только для указанной директории, и ее поддиректорий

## Rivet: Tcl команды и переменные

var var_qs var_post get the value of a form variable.
`var` get list exists number all `var_qs` get list exists number all `var_post` get list exists number all

#### Описание

Команда `var` предназначена для доступа к переменным которые были переданы методами GET или POST, не делая между ними никакой разницы. Стоит заметить что есть еще две формы команды `var`: `var_qs` и `var_post`. Эти команды рассматривают только переменные переданные GETом и POSTом, соответственно.

get varname default

  Возвращает значение переменной `varname` как строку, причем даже в случае когда у переменной есть несколько значений Если же такой переменной не было передано - то возвращается `default`, а если и оно не было указано - то "" - пустая строка.

list varname

  Возвращает значение переменной `varname` как список, если для этой переменной было много значений.

exists varname

  Возвращает 1 если `varname` вам передана, и 0 если нет.

number

  Возвращает количество переменных.

all

  Возвращает список из имен переменных и их значений.

См. так же .

upload предназначена для обработки закачанных (uploaded) файлов.
`upload` channel save data exists size type filename

#### Описание

Команда upload предназначена для обработки закачанных (uploaded) файлов. Обратите внимание что поведение этой команды зависит от конфигурации Apache и Rivet.

channel uploadname

  Если передано имя закачанного файла, то `uploadname`, возвращает Tcl handle (как open (?)) для обращения к этому файлу.

save uploadname filename

  Сохраняет `uploadname` в файле `filename`.

data uploadname

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

size uploadname

  Возвращает размер закачанного файла.

type

  Возвращает значение `Content-type`, если оно установлено, или пустую строчку, если нет.

filename uploadname

  Возвращает имя закачанного файла на клиентской машине.

names

  Возвращает список имен переменных для всех закачанных файлов

См. так же .

load_response Сохряняет переданные данные в массиве.
`load_response` arrayName

#### Описание

Сохраняет в массиве все переменные, переданные из формы
load_env Загужает переменные окружения (environment).
`load_env` array_name

#### Описание

Загружает в указанный массив переменные окружения. По умолчанию делает это в массив `::request::env`

Так как страницы выполняются в пространстве имен `::request`, то нет необходимости обращатся к этому массиву по полному имени - вполне можно ограничиться просто `env` (примечание переводчика: щааааз!).

load_headers Загружает заголовки (headers) из запроса (requestа).
`load_headers` array_name

#### Описание

Загужает клиентские HTTP заголовки в указанный массив, или в `headers` если имя массива не указано.

load_cookies Загружает клиентские cookie.
`load_cookies` array_name

#### Описание

Загужает переданные клиентом Cookie в указанный массив, или в `headers` если имя массива не указано.

include Считывает файл без всякой модификации.
`include` filename_name

#### Описание

Подгружает файл без обратки тэгов <? и ?>. Это лучший способ включить HTML файл или другой статический контент.

parse обрабатывает файл Rivetом.
`parse` filename

#### Описание

Почти то же что и команда Tcl `source`, но только с учетом тегов <? и ?>, используемых Rivetом. Этой командой можно вызывать один .rvt файл из другого.

headers установка и обработка заголовков HTTP.
`headers` set redirect add type numeric

#### Описание

Команда `headers` предназначена для работы с заголовками http.

set headername value

  Устанавливает разнообразные заголовки и значения.

redirect uri

  Перенаправление (redirect) с текущей страницы на новый URI. Обязана быть в самом начале кода.

add headername value

  Добавляет текст в заголовок `headername`.

type content-type

  Эта команда устанавливает HTTP заголовок `Content-type` который возвращается клиенту при обращении к странице. Это полезно если вы отдаете содержимое отличное от text/html или указываете кодировку.

numeric response code

  Устанавливает код http-ответа, типа 200, 404 или 500.

makeurl Формирует url'и основываясь на hostname, port.
`makeurl` filename

#### Описание

Создает URL который ссылается сам на себя исходя из имени файла. Например,

    makeurl /tclp.gif

вернет `http://[hostname]:[port]/tclp.gif`. взяв информацию о hostname и порте из достоверного источника
cookie работает с cookies.
`cookie` set cookieName cookiValue -days expireInDays -hours expireInHours -minutes expireInMinutes -expires Wdy, DD-Mon-YYYY HH:MM:SS GMT -path uriPathCookieAppliesTo -secure 1/0 `cookie` get cookieName

#### Описание

Эта команда преденазаначена для установки или считывания переданных Cookies. Когда вам передают cookie, эта команда вам передает значение, или же пустую строку, если вам такую cookie не передали.

clock_to_rfc850_gmt Возвращает время согласно rfc850 основываясь на [clock seconds].
`clock_to_rfc850_gmt` seconds

#### Описание

Конвертирует unix-time (количество секунд с 1970 года) в формат RFC850, который требует чтобы оно было GMT.

html создает html выделения в тексте.
`html` string arg

#### Описание

Выводит текст с возможностию передачи HTML тэгов, переданных как аргументы. Пример:

    html "Test" b i

produces: `<b><i>Test</i></b>`
incr0 увеличивает переменную на 1 или делает ее равной 1 если переменная не существовала.
`incr0` varname num

#### Описание

Прибавляет 1 к `varname` `num` раз. Если такой переменной не существовало, то создает таковую и присваивает ей 1, а не возвращает ошибку.

parray команда Tcl's `parray` с html-форматированием.
`parray` arrayName pattern

#### Описание

Версия стандартной команды Tcl `parray`. Делает то же самое, но с красивым html оформлением.

## Примеры использования

Далее - примеры использования Rivet. Подразумевается что читатель имеет некоторые знания Tcl. Если же вы его не знаете - не волнуйтесь, это простой язык, и множество как минимум англоязычной документации и учебников доступно в сети. Посмотрите например сюда .

Hello World

Естественно, первым примером будет "Hello World".

Мы предполагаем что к этому моменту Apache сконфигурирован и понимает .rvt файлы, создадим файл `hello.rvt` в месте где Apache сможет его найдти со следующим содержимым:

    &hello.rvt;

Если вы обратитесь к этому файлу через броузер, вы должны увидеть практически чистую страницу с надписью "Helo World" (без кавычек).

Создание таблицы

В следующем, тоже простом примере мы покажем как создать таблицы:

    &table.rvt;

Если вы вчитаетесь в код, то убедитесь что это чистейший Tcl. Мы можем запустить этот код и вне Rivet - и он будет генерировать такой же HTML!

Результат должен быть похож на:

Доступ к переменным

А тут мы продемонстрируем как обращаться с переменными переданными вам методом POST или GET.

Из такой HTML формы:

    &vars.html;

Мы можем использовать rivet скрипт чтобы получить доступ к этим переменным:

    &vars.rvt;

Первый оператор проверяет что переменная `boss` была переданна скрипту, и потом что-то делает с этой информацией. Если же такой нет - то в список ошибок добавляется сообщение об этом прискорбном факте.

Во втором куске кода, переменная `salary` обрабатывается примерно таким же образом, и к тому же еще и проверяется на то является ли она числом.

Если переменная `boss` не введена - то она заменяется на "Mr. Burns".

А последний кусок кода немножко хитрее, потому что переменная `skills` - это listbox, и в принципе может иметь несколько значений, и тут мы покажем как с ними поступать.

Скрипт далее проверяет что `errlist` пустой (а если нет - то информирует вас об ошибках) и говорит что спасибо и все такое.

Закачка файлов (Upload)

Пусть есть такой HTML код `upload.html`

    &upload.html;

Из такого Tcl кода, например, (под названием `upload.rvt`) мы получаем доступ к загруженному файлу.

    &upload.rvt;

## Rivet Tcl packagы

Кроме всего прочего, Rivet - это еще и набор полезных packageй.

- commserver - это package который может быть использован при IPC. Страшно экспериментальный. Ему нужен comm из tcllib

- dio - абстрактный интерфейс работы с базами данных.

- dtcl - модуль для обеспечения совместимости с mod_dtcl

- form - для создания forms.

- rivet - еще куча полезных процедур.

- tclrivet

## Ресурсы и как получить помощь

### Mailing Lists

Mailing List (список рассылка) - это первейшее место куда надо обращаться за помощью, если, конечно, вы не нашли ответа в документации. Пишите на rivet-user@tcl.apache.org. Если у вас есть мысли, идеи, или просто соображения о Rivet и его коде, то пишите на rivet-dev@tcl.apache.org. Чтобы подписаться на оба листа, пишите email на rivet-list-subscribe@tcl.apache.org.

Архивы списка рассылки доступны тут

### Новостная группа

Новостная группа - это хорошее место для вопросов по Tcl вообще. Но и разработчики Rivet туда тоже заглядывают, можно и туда писать, но лучше в список рассылки.

### Веб сайты

Есть некоторое количество полезных веб сайтов про Apache и Tcl.

- это домашняя страница проекта Apache Tcl. Сюда надо ходить за свежими версиями софта.

- по всем вопросам касающимся Apache

- классическое место где гнездится Tcl.

- Tcl's Wiki, весьма полезный ресурс для задавания вопросов, получения ответов и отвечания на них для тех кто крут.

### Система отлова ошибок

Apache Rivet использует ВсеАпачную Систему Отлова Ошибок (ВАСОО) . Всякие проблемы пишите сюда, или - что тоже полезно - вы можете выяснить опыт ее решения, если кто-то уже с ней сталкивался.

### IRC

Иногда случается что кто-то из команды Rivet доступен по IRC на irc.freenode.net, канал #tcl.

### Редактирование Rivet файлов

Для двух популярных редакторов emacs и vim есть код для удобного редактирования файлов Rivet. Идея в том что редактор, завидев теги <? and ?> переключается то в режим HTML, то в Tcl. Эти файлы `two-mode-mode.el` и `rvt.vim` находятся в директории `contrib/`.

## Внутренности Rivet

Эта секция давно устарела, поскольку новый код добавляется, а старый убирается. Так что лучше читайте исходники - они рулез!. А если вам интересны изменения, то пользуйтесь `cvs`

### Инициализация

Когда apavhe запускается (или когда запускается использующий TCL дочерний процесс Apache если Tcl собран с поддержкой threads), вызывается `Rivet_InitTclStuff`, который создает новый интерпретатор, по одному на каждый виртуальный хост, в зависимости от конфигурации. Также инициализируются всякие вещи типа RivetChan канальная система (channel system), создаются специфичные для Rivet Tcl команды и исполняется Rivetовский channel system, creates the Rivet-specific Tcl commands, and `init.tcl`. Система кеширования, опять же, и если есть `GlobalInitScript`, то и он запускается.

### RivetChan

Система RivetChan была создана для того чтобы перенаправлять стандартный поток вывода (stdout). По этой причине вы можете использовать стандартную команду `puts` в страницах .rvt. (примечание переводчика: и `fconfigure` тоже, что полезно). Она также создает канал который буферизует output, и перенаправляет его в систему ввода-вывода Apache.

### Команда `global`

Rivet сделан так, что должен запускать Tcl код с минимальным количеством неожиданностей, Но иногда приходится идти на компромиссы - в этом случае вам и пригодится команда `global`. Проблема в том что эта команда создаст вам действительно глобальную переменную, и если пользователь просто задействует старый код без изменений, скорее всего он захочет получить доступ к переменным из других програм, не желая заботиться проверкой того как передается эта переменная из страницы в страницу. По этому поводу мы и создали процедурку `::request::global` которая и выполняет роль команды `global` в Rivet страницах. Если вам на самом деле нужны настоящие глобальные переменные, используйте команду `::global` или добавьте :: namespace к переменным которые вы хотите сделать глобальными

### Обработка страниц, выполнение и кеширование

Когда выполняется Rivet страница, она превращается в обычный Tcl скрипт, опираясь на символы <? ?>. Все что вне их рассматривается как большой большой аргумент для `puts`, а все что внутри - рассматривается как Tcl код.

Каждый .rvt файл выполняется в простанстве имен `::request`, по этому нет необходимости каждый раз создавать по новому интерпретатору. По этой же причине глобальные переменные (примечание преводчика: звиняйте, не понял) By running in its own namespace, though, each page will not run afoul of local variables created by other scripts, because they will be deleted automatically when the namespace goes away after Apache finishes handling the request.

Одна из существующих ныне проблем подобного подхода - это отсутсвие механизма сборщика мусора, например, если вы не закрыли хэндл файла - то это плохо. Поэтому будьте добры, закрывайте все что наоткрывали.

После того как скрипт загружен и преобразован в "чистый Tcl", он опять же кешируется, и по этой причине может быть использован в следующий раз без лишних преобразований и обращений к диску. Количество кешируемых скриптов можно изменить в конфиге. Таким образом можно значительно поднять производительность системы.

## Переход с mod_dtcl или NeoWebScript (NWS)

Обратная совместимость не была никогда особой целью разработчиков, но мы ее все равно предоставляем по историческим причинам и с учетом пожеланий тех кто переключается на Rivet с mod_dtcl и NeoWebScript (NWS).

### mod_dtcl

Rivet базируется на коде mod_dtcl, но достаточно хорошо переработан. Основная идея осталась та же, но большое количетво команд изменилось.

### NeoWebScript

Потом.