OmniWeb

LUA WEB-сервер

Особенности

1. Скорость и компактность — неизменные цели этого программного обеспечения.
2. Интеграция с GNU libmicrohttpd (0.9.59), LuaJIT (2.1.0b3), lua-CJson, lua-resty-template, tinyxml2.
3. Поддержка таймеров и ежедневных задач.

Пример проекта

Team — система управления лёгкими проектами. После версии Team 2.0 переписана на Go. Для ознакомления с использованием рекомендуется перейти к версии 1.x.

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

Конфигурационный файл omni.ini:

; Основные настройки
[main]
port=80                                 ; HTTP-порт для прослушивания, по умолчанию 80
expire=900000                           ; Время хранения данных по умолчанию (в миллисекундах), по умолчанию 15 минут
verbose=no                              ; Отображать ли подробные журналы доступа (yes|no), по умолчанию no
use_session=yes                         ; Включить ли сессии, по умолчанию нет
#script_entry=script/app.lua            ; Файл входа
#scheduler_script=scripts/scheduler.lua ; Скрипт планирования времени, если не установлен, планирование времени не используется

; Пользовательские страницы ошибок, поддерживают только статические страницы
[error_pages]
#404=scripts/view/404.html
#405=scripts/view/405.html

; Список каталогов для загрузки файлов, alias=path
[shared_dirs]
#upload=uploads ; Доступ к /upload/1.txt указывает на ./uploads/1.txt
#some=E:\1      ; Доступ к /some/1.txt указывает на E:\1\1.txt

; Другие пользовательские настройки

[Примечание] Содержимое конфигурационного файла будет записано в глобальную таблицу Lua config.

Каталог развёртывания

См. каталог bin.

somewhere               -- Указанная пользователем папка
|
|-- omni/omni.exe       -- Исполняемый файл, скомпилированный в выпуске
|-- omni.ini            -- Конфигурационный файл
|
|-- www                 -- Папка со статическими файлами (css, images, fonts, js и т. д.)
|   |-- favicon.ico     -- Значок сайта
|   |-- css             -- CSS
|   |-- js              -- JS
|   |-- fonts           -- Fonts
|   |-- images          -- Изображения
|
|-- scripts             -- Папка с кодом и шаблонами
    |-- app.lua         -- Обязательный, определение маршрута (распределение запросов)
    |-- controller      -- Контроллер
    |-- model           -- Модель данных
    |-- vendor          -- Плагины LuaJIT (рекомендуется искать в luapower)
    |-- view            -- Папка шаблонов

Маршрутизация

1. Поддерживает регулярные выражения (Posix Regex).

2. Интерфейс: | Метод | Описание | | --- | --- | | router:get(filter, proc) | GET-маршрут | | router:post(filter, proc) | POST-маршрут | | router:any(filter, proc) | Маршрут без ограничений |

3. Пример:

-- Главная страница
router:get('^/$', function(req, rsp)
    custom_router(default_ctrl, default_action, req, rsp);
end);

-- MVC
router:any('^/([A-Za-z][A-Za-z0-9_/]*)/([A-Za-z][A-Za-z0-9_]*)$', function(req, rsp, controller, action)
    custom_router(controller, action, req, rsp);
end);

-- MVC (действие по умолчанию)
router:any('^/([A-Za-z][A-Za-z0-9_]*)$', function(req, rsp, controller)
    custom_router(controller, default_action, req, rsp);
end);

-- MVC (действие по умолчанию, многоуровневый контроллер)
router:any('^/([A-Za-z][A-Za-z0-9_/]*)/$', function(req, rsp, controller)
    custom_router(controller, default_action, req, rsp);
end);

Запрос (таблица маршрутизации proc, первый параметр)

[Примечание] Загруженные файлы будут автоматически удалены после завершения запроса. Если необходимо сохранить файл, используйте os.cp(from, to) для копирования в другую папку.

Ответ (класс маршрутизации proc, второй параметр)

Сессия

1. Сессии доступны после настройки use_session = yes в файле omni.ini.
2. Сессия является глобальной таблицей, изменения автоматически сохраняются.
3. Очистить сессию можно, выполнив session = {}.

Шаблоны

1. Синтаксис см. в lua-resty-template.
2. Вызов рендеринга через rsp:html(view, data, is_plain).

Глобальное хранилище

Использует хранилище key-value со строковыми значениями. Поскольку каждый HTTP-сеанс использует отдельную Lua VM, данные, которые необходимо хранить глобально, следует использовать в storage.

Интерфейс Lua-слоя C++

Расширяет библиотеку os.

Глобальные функции

JSON

| Функция | Возвращаемое значение | Описание | | json.encode(v) | строка | Преобразует переменную Lua в строку JSON. | | json.decode(v) | v | Разбирает строку JSON и преобразует её в переменную Lua.

XML

| Функция | Возвращаемое значение | Описание | | xml.parse(xml_string) | таблица | Анализирует XML и возвращает таблицу формата {name=xxx, value=xxx, attr={}, children={} }.

BASE64

| Функция | Возвращаемое значение | Описание | | b64.encode(s) | строка | Выполняет кодирование Base64 строки s. | | b64.decode(s) | строка | Декодирует строку s, закодированную с помощью Base64.

LOGGER

| Функция | Возвращаемое значение | Описание | | log.verbose(s) | nil | Выводит информацию уровня Verbose. | | log.info(s) | nil | Выводит информацию уровня INFO. | | log.warn(s) | nil | Выводит предупреждение. | | log.error(s) | nil | Выводит сообщение об ошибке.