fullmoon
1.0.0
Fullmoon-это быстро и минималистичная веб-структура, основанная на Redbeans-портативном распределимом веб-сервере с одним файлом.
Все, что необходимо для разработки и распространения, поступает в один файл без внешних зависимостей и после упаковки с помощью Redbean Runs в Windows, Linux или MacOS. Ниже приведен полный пример приложения Fullmoon:
local fm = require " fullmoon "
fm . setTemplate ( " hello " , " Hello, {%& name %} " )
fm . setRoute ( " /hello/:name " , function ( r )
return fm . serveContent ( " hello " , { name = r . params . name })
end )
fm . run () После того, как он упакован в Redbean, его можно запустить с помощью ./redbean.com , который запускает сервер, который возвращает «Привет, мир» в запрос HTTP (S), отправленный на http: // localhost: 8080/hello/world.
Redbean-это распределимый кроссплатформенный веб-сервер с одним файлом с уникальными и мощными качествами. В то время как существует несколько веб-фреймворков на основе LUA (Lapis, LOR, Sailor, Pegasus и другие), ни один из них не интегрируется с Redbean (хотя есть экспериментальная структура Anpan).
Fullmoon - это легкая и минималистичная веб -структура, которая написана с точки зрения демонстрации всех возможностей, которые предоставляет Redbean, расширяя и увеличивая их простейшим и наиболее эффективным способом. Он работает быстро и поставляется с включенными батареями (маршруты, шаблоны, генерация JSON и многое другое).
Fullmoon следует философии LUA и предоставляет минимальный набор инструментов для объединения по мере необходимости и использования в качестве основы для развития.
fork , socket , общая память и многое другоеЗагрузите копию Redbean, выполнив следующие команды (пропустите вторые, если запустить эти команды в Windows):
curl -o redbean.com https://redbean.dev/redbean-2.2.com
chmod +x redbean.comПоследний номер версии можно получить с помощью следующего запроса:
curl https://redbean.dev/latest.txtДругой вариант - построить Redbeans из источника, следуя инструкциям для сборки источника.
fullmoon.lua .lua/.init.lua (например, код LUA, показанный в описании). Другой вариант - разместить код приложения в отдельный файл (например, .lua/myapp.lua ) и добавить require "myapp" к .init.lua . Вот как представлены все включенные примеры.
zip redbean.com .init.lua .lua/fullmoon.lua Если код приложения хранится в отдельном файле LUA, как описано выше, обязательно поместите его в каталог .lua/ Directory, а также застегивает этот файл.
./redbean.comЕсли эта команда выполняется на Linux и выбрасывает ошибку о том, чтобы не найти интерпретатора, она должна быть исправлена с помощью следующей команды (хотя обратите внимание, что она может не выжить в перезапуске системы):
sudo sh -c " echo ':APE:M::MZqFpD::/bin/sh:' >/proc/sys/fs/binfmt_misc/register "Если эта команда создает загадочные ошибки на WSL или вине при использовании Redbean 2.x, они могут быть исправлены путем отключения binfmt_misc:
sudo sh -c ' echo -1 >/proc/sys/fs/binfmt_misc/status 'Запустите браузер, указывающий по адресу http: // localhost: 8080/hello/world, и он должен вернуть «Привет, мир» (при условии, что приложение использует код, показанный во введении, или в разделе «Использование»).
Самый простой пример должен (1) загрузить модуль, (2) настроить один маршрут и (3) запустить приложение:
local fm = require " fullmoon " -- (1)
fm . setRoute ( " /hello " , function ( r ) return " Hello, world " end ) -- (2)
fm . run () -- (3) Это приложение отвечает на любой запрос на /hello url с возвращением контента «Привет, мир» (и код статуса 200) и отвечает кодом состояния 404 для всех других запросов.
setRoute(route[, action]) : регистрирует маршрут. Если route является строкой, то он используется в качестве выражения маршрута для сравнения пути запроса против. Если это таблица, то его элементы представляют собой строки, которые используются в качестве маршрутов, а его хэш -значения - это условия, с которыми маршруты проверяются. Если второй параметр является функцией, то он выполняется, если все условия выполняются. Если это строка, то она используется в качестве выражения маршрута, и запрос обрабатывается так, как если бы он отправляется по указанному маршруту (действует как внутренний перенаправление). Если какое -либо условие не выполнено, то следующий маршрут проверяется. Выражение маршрута может иметь несколько параметров и дополнительных частей. Обработчик действий принимает таблицу запросов, которая обеспечивает доступ к параметрам запроса и маршрута, а также к заголовкам, куки и сеансу.
setTemplate(name, template[, parameters]) : регистрирует шаблон с указанным именем или набором шаблонов из каталога. Если template является строкой, то он составлен в обработчик шаблона. Если это функция, она сохраняется и вызывается, когда запрашивается рендеринг шаблона. Если это таблица, то его первым элементом является шаблон или функция, а остальные используются в качестве параметров. Например, указание ContentType как одного из параметров устанавливает заголовок Content-Type для сгенерированного контента. Несколько шаблонов ( 500 , json и другие) предоставляются по умолчанию и могут быть перезаписаны. parameters - это таблица с параметрами шаблона, хранящиеся как пары имени/значения (ссылка на переменные в шаблоне).
serveResponse(status[, headers][, body]) : отправляет HTTP -ответ с использованием предоставленного status , headers и значений body . headers - это необязательная таблица, заполненная парами HTTP -имени/значения. Если предоставлено, этот набор заголовков удаляет все остальные заголовки, установленные ранее во время обработки того же запроса. Названия заголовков нечувствительны , но предоставляемые псевдонимы для имен заголовков с тисками чувствительны к случаям : {ContentType = "foo"} является альтернативной формой для {["Content-Type"] = "foo"} . body - дополнительная строка.
serveContent(name, parameters) : рендерирует шаблон с использованием предоставленных параметров. name - это строка, которая называет шаблон (в соответствии с установленным вызовом setTemplate ), а parameters - это таблица с параметрами шаблона, хранящиеся как пары имени/значения (ссылка на переменные в шаблоне).
run([options]) : запускает сервер, используя настроенные маршруты. По умолчанию сервер прослушивает локальный и порт 8080. Эти значения могут быть изменены, установив значения addr и port в таблице options .
Запуск примеров требует, чтобы включить оператор require в файле .init.lua , который загружает модуль с каждым примером кода, поэтому для примера Showcase, реализованного в showcase.lua , .init.lua включает следующее:
-- this is the content of .init.lua
require " showcase "
-- this loads `showcase` module from `.lua/showcase.lua` file,
-- which also loads its `fullmoon` dependency from `.lua/fullmoon.lua`Пример витрины демонстрирует несколько функций полной функции:
serveAsset )serveRedirect )Следующие файлы должны быть добавлены в исполняемый файл/архив Redbean:
.init.lua - требуется "витрина" .lua/fullmoon.lua .lua/showcase.lua
Пример Techempower реализует различные типы тестов для тестов веб-структуры с использованием Fullmoon и базы данных SQLite в памяти.
Этот пример демонстрирует несколько функций Fullmoon/Redbean:
Следующие файлы должны быть добавлены в исполняемый файл/архив Redbean:
.init.lua - требуется "techbench" .lua/fullmoon.lua .lua/techbench.lua
Пример платы HTMX демонстрирует простое приложение, которое генерирует фрагменты HTML, доставленные клиенту с использованием библиотеки HTMX.
Этот пример демонстрирует несколько функций Fullmoon/Redbean:
Следующие файлы должны быть добавлены в исполняемый файл/архив Redbean:
.init.lua - требуется "htmxboard" .lua/fullmoon.lua .lua/htmxboard.lua Assets/styles.css TMPL/* - Все файлы из примеров/htmxboard/directory tmpl
Примечание 1: Поскольку все данные хранятся в памяти, этот пример выполняется в режиме Uniprocess.
ПРИМЕЧАНИЕ 2: Эти примеры извлекают HTMX, HyperScript и сортируемые библиотеки из внешних ресурсов, но эти библиотеки также могут храниться в качестве локальных активов, что обеспечивает полностью самодостаточный портативный пакет распределения.
Пример HTMX SSE демонстрирует способ создания серверных событий (SSE), которые могут быть переданы клиенту (что показывает результаты с использованием библиотеки HTMX и ее расширения SSE).
Этот пример демонстрирует несколько функций Fullmoon/Redbean:
streamContent )Следующие файлы должны быть добавлены в исполняемый файл/архив Redbean:
.init.lua - требуется "htmxsse" .lua/fullmoon.lua .lua/htmxsse.lua
Каждое полное приложение следует тому же базовому потоку с пятью основными компонентами:
Давайте посмотрим на каждый из компонентов, начиная с маршрутизации запроса.
Fullmoon обрабатывает каждый HTTP -запрос, используя один и тот же процесс:
false или nil возвращается от обработчика действий (и иначе продолжает процесс) В целом, определения маршрутов, определяющие URL -адреса (и набор условий) с обработчиками действий (которые являются регулярной функцией LUA). Все условия проверяются в случайном порядке для каждого URL, который соответствует определению маршрута. Как только любое условие не удается, обработка маршрута прерывается, а следующий маршрут проверяется с одним исключением : любое условие может установить значение otherwise , которое запускает ответ с указанным кодом состояния.
Если маршрут не соответствует запросу, то запускается обработка по умолчанию 404, которая может быть настроена путем регистрации пользовательского шаблона 404 ( fm.setTemplate("404", "My 404 page...") ).
Каждый маршрут идет по пути, который точно соответствует, поэтому маршрут "/hello" соответствует запросам /hello и не совпадает /hell , /hello-world или /hello/world . Маршрут ниже отвечает "Привет, мир!" Для всех запросов, направленных по пути /hello , и возвращает 404 для всех других запросов.
fm . setRoute ( " /hello " , function ( r ) return " Hello, World! " end ) Чтобы соответствовать пути, где /hello является лишь частью его, можно использовать дополнительные параметры и SPLAT.
В дополнение к фиксированным маршрутам, любой путь может включать заполнители для параметров, которые идентифицируются A : сразу же сразу же имя параметра:
fm . setRoute ( " /hello/:name " ,
function ( r ) return " Hello, " .. ( r . params . name ) end ) Каждый параметр соответствует одному или нескольким символам, кроме / , поэтому маршрут "/hello/:name" совпадает /hello/alice , /hello/bob , /hello/123 и не совпадает /hello/bob/and/alice (из -за Несопоненные переходные черты) или /hello/ (потому что длина фрагмента, связанного с сопоставлением, равна нулю).
Имена параметров могут включать только буквенно -цифровые символы и _ .
Доступ к параметрам можно получить с помощью таблицы запросов и ее таблицы params , так что r.params.name можно использовать для получения значения параметра name из более раннего примера.
Любой указанный фрагмент или параметр маршрута может быть объявлен необязательным путем завершения его в скобки:
fm . setRoute ( " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) В примере выше, как /hello так и /hello/Bob принимаются, но не /hello/ , так как следующий черта является частью необязательного фрагмента, и :name все еще ожидает одного или нескольких символов.
Любой непревзойденный необязательный параметр становится false в качестве его значения, поэтому в приведенном выше случае «Привет, мир!» возвращается для URL -адреса запроса /hello .
Можно указать более одного дополнительного параметра, и могут быть вложены дополнительные фрагменты, поэтому оба "/posts(/:pid/comments(/:cid))" и "/posts(/:pid)/comments(/:cid)" являются действительными значениями маршрута.
Существует еще один вид параметра, который называется Splat, который написан как * и соответствует нулю или более символам, включая прямую черту ( / ). SPLAT также хранится в таблице params под именем splat . Например, маршрут "/download/*" совпадает /download/my/file.zip file.zip, а Splat получает значение my/file.zip . Если в одном и том же маршруте необходимо несколько сплатов, то Splats могут быть назначены имена, аналогичные другими параметрами: /download/*path/*fname.zip (хотя такой же результат может быть достигнут с помощью /download/*path/:fname.zip , как первый SPAT захватывает все части пути, кроме имени файла).
Все параметры (включая SPLAT) могут появляться в любой части пути и могут быть окружены другим текстом, который необходимо точно соответствовать. Это означает, что маршрут "/download/*/:name.:ext" соответствует /download/my/path/file.zip и params.name получает file , params.ext получает zip и params.splat получает значения my/path .
Другая причина использования SPLAT - разрешить несколько маршрутов с одним и тем же путем, зарегистрированным в системе. Текущая реализация перезаписывает маршруты с тем же именем и избегать того, что названный Splat может использоваться для создания уникальных путей. Например,
fm . setRoute ( " /*dosomething1 " , function ( r ) return " something 1 " end )
fm . setRoute ( " /*dosomething2 " , function ( r ) return " something 2 " end )Это может использоваться в ситуациях, когда есть набор условий, которые необходимо проверить в обработчике действий, и хотя может быть возможно объединить оба маршрута в один, иногда он чище, чтобы держать их отдельными.
Значение по умолчанию для параметров - все символы (кроме / ) длины одной или нескольких. Чтобы указать другой набор допустимых символов, его можно добавить в конце имени переменной; Например, использование :id[%d] вместо :id изменяет параметр, чтобы соответствовать только цифрам.
fm . setRoute ( " /hello(/:id[%d]) " ,
function ( r ) return " Hello, " .. ( r . params . id or " World! " ) end ) Поддерживаются следующие классы персонажей LUA: %w , %d , %a , %l , %u и %x ; Любой характер пунктуации (включая % и ] ) также может быть сбежал с % . Негативные классы (написанные в LUA как %W ) не поддерживаются , но не поддерживается не в установленном синтаксисе, поэтому [^%d] соответствует параметру, который не включает никаких цифр.
Обратите внимание, что количество повторений нельзя изменить (так :id[%d]* не является допустимым способом принять цифры с нулевым или более младшим), так как разрешены только наборы, и значения все еще принимают один или несколько символов. Если требуется дополнительная гибкость в описании приемлемых форматов, то для расширения логики сопоставления можно использовать пользовательские валидаторы.
Параметры запроса и формы можно получить так же, как параметры пути, используя таблицу params в таблице request , которая передается каждому обработчику действия. Обратите внимание, что если есть конфликт между именами параметров и запросов/форм, то имена параметров имеют приоритет .
Существует один особый случай, который может привести к возвращению таблицы вместо строкового значения: если имя параметра запроса/формы заканчивается в [] , то все результаты сопоставления (один или несколько) возвращаются в виде таблицы. Например, для строки запроса a[]=10&a[]&a[]=12&a[]= значение params["a[]"] IS {10, false, 12, ""} .
При написании этих имен параметров может потребоваться несколько кронштейнов, params.a можно использовать в качестве ярлыка для params["a[]"] причем обе формы возвращают одну и ту же таблицу.
Параметры многопоставления также обрабатываются при запросе и могут быть доступны так же, как и остальные параметры с использованием таблицы params . Например, параметры с simple и more имен могут быть извлечены из сообщения с типом содержимого multipart/form-data с использованием params.simple и params.more .
Поскольку некоторые из содержимого многопоставления могут включать в себя дополнительные заголовки и параметры в этих заголовках, к ним можно получить доступ с полем multipart of the params :
fm . setRoute ({ " /hello " , simple = " value " }, function ( r )
return " Show " .. r . params . simple .. " " .. r . params . multipart . more . data )
end ) В таблице multipart включают все части сообщения Multipart (поэтому она может быть итерацией из -за использования ipairs ), но также позволяет доступ, используя имена параметров ( params.multipart.more ). Каждый из элементов также является таблицей, которая включает в себя следующие поля:
nil если нет.nil если нет. Эта многопотевая обработка потребляет любые многопорядки подтипов и обрабатывает рекурсивные многоуровневые сообщения. Он также вставляет часть со значением Content-ID , соответствующим параметру start в первой позиции.
Несмотря на все более ранние примеры, показывающие один маршрут, это редко бывает в реальных приложениях; Когда присутствуют несколько маршрутов, они всегда оцениваются в том порядке, в котором они зарегистрированы .
Один вызов setRoute также может устанавливать несколько маршрутов, когда они имеют одинаковый набор условий, и делиться одним и тем же обработчиком действий:
fm . setRoute ({ " /route1 " , " /route2 " }, handler )Это эквивалентно двум вызовам, устанавливающим каждый маршрут по отдельности:
fm . setRoute ( " /route1 " , handler )
fm . setRoute ( " /route2 " , handler )Учитывая, что маршруты оцениваются в том порядке, в котором они установлены, сначала необходимо установить более селективные маршруты, в противном случае они не могут получить шанс оценить:
fm . setRoute ( " /user/bob " , handlerBob )
fm . setRoute ( " /user/:name " , handlerName ) Если маршруты установлены в противоположном порядке, /user/bob никогда не может быть проверен, если обработчик действия "/user/:name" возвращает false результат.
Как описано ранее, если ни один из маршрутов не соответствует, возвращается ответ с кодом состояния 404. Могут быть случаи, когда это не желательно; Например, когда приложение включает в себя сценарии LUA для обработки запросов, которые явно не зарегистрированы в качестве маршрутов. В этих случаях можно добавить маршрут, который реализует обработку Redbean по умолчанию (имя параметра SPLAT используется только для устранения этого маршрута по сравнению с другими маршрутами /* , которые могут использоваться в других местах):
fm . setRoute ( " /*catchall " , fm . servePath ) Каждый маршрут может быть предоставлен дополнительным именем, которое полезно при ссылке на этот маршрут, когда его URL должен генерироваться на основе конкретных значений параметров. При условии, что функция makePath принимает либо имя маршрута, либо сам URL -адрес маршрута, а также таблицу параметров и возвращает путь с заполненными заполнителями параметров:
fm . setRoute ( " /user/:name " , handlerName )
fm . setRoute ({ " /post/:id " , routeName = " post " }, handlerPost )
fm . makePath ( " /user/:name " , { name = " Bob " }) -- > /user/Bob
fm . makePath ( " /post/:id " , { id = 123 }) -- > /post/123
fm . makePath ( " post " , { id = 123 }) -- > /post/123, same as the previous oneЕсли два маршрута используют одно и то же имя, то имя связано с тем, что было зарегистрировано последним, но оба маршрута все еще присутствуют.
Имя маршрута также можно использовать с внешними/статическими маршрутами, которые используются только для генерации URL.
Если маршрут используется только для генерации пути, то он даже не должен иметь обработчика маршрута:
fm . setRoute ({ " https://youtu.be/:videoid " , routeName = " youtube " })
fm . makePath ( " youtube " , { videoid = " abc " }) -- > https://youtu.be/abcМаршрут без какого -либо обработчика действий пропускается во время процесса соответствия маршрута.
Внутренние маршруты позволяют перенаправлять один набор URL -адресов другому. Целевой URL может указывать на статический ресурс или сценарий .lua . Например, если запросы на одно местоположение необходимо перенаправить в другое, следующие запросы на конфигурацию перенаправляют запросы на любые ресурсы в /blog/ url в соответствии с /new-blog/ url, если существует целевой ресурс:
fm . setRoute ( " /blog/* " , " /new-blog/* " ) Этот маршрут принимает запрос на /blog/post1 и обслуживает /new-blog/post1 в качестве ответа, если существует активы /new-blog/post1 . Если актив не существует, то следующий маршрут проверяется. Аналогичным образом, использование fm.setRoute("/static/*", "/*") вызывает запросы для /static/help.txt для обслуживания ресурса /help.txt .
Оба URL -адреса могут включать параметры, которые заполнены, если разрешены:
fm . setRoute ( " /blog/:file " , " /new-blog/:file.html " ) -- <<-- serve "nice" URLs
fm . setRoute ( " /new-blog/:file.html " , fm . serveAsset ) -- <<-- serve original URLs Этот пример разрешает «красивые» URL -адреса, служащие их «HTML» версии. Обратите внимание, что это не запускает перенаправление на стороне клиента путем возвращения кода состояния 3xx , но вместо этого обрабатывает повторную маршруту внутри. Также обратите внимание, что второе правило необходимо для обслуживания «оригинальных» URL-адресов, так как они не обрабатываются первым правилом, потому что, если запрос предназначен для /blog/mylink.html , то перенаправленный URL-адрес- /new-blog/mylink.html.html , который вряд ли существует, поэтому маршрут пропускается, а следующий проверяется. Если требуется обработка сепараторов пути, *path вместо :file , AS, As * позволяет сепараторов пути.
Если приложению необходимо выполнять различные функции в зависимости от конкретных значений атрибутов запроса (например, метода), эта библиотека предоставляет две основные параметры: (1) Проверьте значение атрибута request.method == "GET" проверку) и (2) добавьте условие, которое отфильтровывает запросы, так что запросы, используя указанное значение атрибута, достигают обработчика действия. Этот раздел описывает второй вариант более подробно.
Каждый зарегистрированный маршрут по умолчанию отвечает на все методы HTTP (get, post, post и т. Д.), Но можно настроить каждый маршрут только на конкретные методы HTTP:
fm . setRoute ( fm . GET " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) В этом случае синтаксис fm.GET"/hello(/:name)" настраивает маршрут только для принятия запросов GET . Этот синтаксис эквивалентен прохождению таблицы с маршрутом и любыми дополнительными условиями фильтрации:
fm . setRoute ({ " /hello(/:name) " , method = " GET " },
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end )Если необходимо указать более одного метода, то вместо одного строкового значения может быть передана таблица со списком методов:
fm . setRoute ({ " /hello(/:name) " , method = { " GET " , " POST " }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) Каждый маршрут, который разрешает запрос GET также (неявно), позволяет запросить HEAD , и этот запрос обрабатывается путем возврата всех заголовков без отправки самого тела. Если по какой -то причине эта неявная обработка не желательна, то добавление HEAD = false в таблицу методов отключает ее (как в method = {"GET", "POST", HEAD = false} ).
Обратите внимание, что запросы с методами не сопоставляя не отклоняются, а скорее проваливаются, чтобы проверить другие маршруты и запустить код состояния 404, возвращаемый, если они не соответствуют совпаданию (за одним исключением).
В дополнение к method , другие условия могут быть применены с использованием host , clientAddr , serverAddr , scheme , заголовков запросов и параметров. Например, указание name = "Bob" в качестве одного из условий гарантирует значение параметра name «BOB» для обработки действий.
Любой заголовок запроса может быть проверен с использованием имени заголовка в качестве ключа, поэтому ContentType = "multipart/form-data" выполняется, если значение заголовка Content-Type является multipart/form-data . Обратите внимание, что значение заголовка может включать другие элементы (граница или Charset как часть значения Content-Type ), и сравнивается только фактический тип носителя.
Поскольку имена для заголовков, параметры и свойства могут перекрываться, они проверяются в следующем порядке:
ContentType ,method , port , host и т. Д.) И Заголовок Host также проверяется в первую очередь (несмотря на одно слово), поэтому ссылается на фильтры Host на основе Host заголовка, при этом ссылается на фильтры host на основе host свойства.
Строковые значения - не единственные значения, которые можно использовать в условных маршрутах. Если более одного значения приемлемо, передача таблицы позволяет предоставить список приемлемых значений. Например, если Bob и Alice являются приемлемыми значениями, то name = {Bob = true, Alice = true} выражает это как условие.
Два специальных значения, передаваемых в таблице, позволяют применять регулярную экспозицию или проверку шаблона :
regex : принимает строку, которая имеет регулярное выражение. Например, name = {regex = "^(Bob|Alice)$"} имеет тот же результат, что и проверка хэша, показанную ранее в этом разделеpattern : принимает строку с выражением образца LUA. Например, name = {pattern = "^%u%l+$"} принимает значения, которые начинаются с символа заглавного покрытия, за которым следует один или несколько нижних символов. Эти две проверки могут быть объединены с проверкой существования таблицы: name = {Bob = true, regex = "^Alice$"} принимает значения Bob и Alice . Если первая проверка существующей таблицы не выполняется, то результаты выражения regex или pattern возвращаются.
Последний тип пользовательского валидатора - это функция. Предоставленная функция получает значение для проверки, и ее результат оценивается как false или true . Например, прохождение id = tonumber гарантирует, что значение id является числом. В качестве другого примера, clientAddr = fm.isLoopbackIp гарантирует, что адрес клиента является IP -адресом Loopback.
fm . setRoute ({ " /local-only " , clientAddr = fm . isLoopbackIp },
function ( r ) return " Local content " end )Поскольку функция валидатора может быть сгенерирована динамически, это тоже работает:
local function isLessThan ( n )
return function ( l ) return tonumber ( l ) < n end
end
fm . setRoute ( fm . POST { " /upload " , ContentLength = isLessThan ( 100000 )},
function ( r ) ... handle the upload ... end )Важно помнить, что функция валидатора фактически возвращает функцию, которая вызывается во время запроса, чтобы применить чек. В предыдущем примере возвращаемая функция принимает значение заголовка и сравнивает его с пределом, снятым во время его создания.
В некоторых случаях неспособность удовлетворить условия является достаточной причиной вернуть некоторый ответ на клиент, не проверяя другие маршруты. В таком случае настройка значения в otherwise случае или функция возвращает либо ответ с указанным статусом, либо результат функции:
local function isLessThan ( n )
return function ( l ) return tonumber ( l ) < n end
end
fm . setRoute ( fm . POST { " /upload " ,
ContentLength = isLessThan ( 100000 ), otherwise = 413
}, function ( r ) ... handle the upload ... end ) В этом примере двигатель маршрутизации соответствует маршруту, а затем проверяет два условия, сравнивающие значение метода с POST и значение заголовка Content-Length с результатом функции isLessThan . Если одно из условий не совпадает, код состояния, указанный в otherwise значении, возвращается с остальной частью ответа.
Если условие otherwise необходимо применить только к проверке ContentLength , то значение otherwise вместе с функцией валидатора может быть перемещено в таблицу, связанную с проверкой ContentLength :
fm . setRoute ( fm . POST { " /upload " ,
ContentLength = { isLessThan ( 100000 ), otherwise = 413 }
}, function ( r ) ... handle the upload ... end ) Разница между двумя последними примерами заключается в том, что в этом примере только сбой проверки длины ContentLength запускает ответ 413 (и все другие методы проходят на другие маршруты), в то время как в предыдущем как method , так и сбои проверки ContentLength запускают один и тот же ответ 413.
Обратите внимание, что когда проверенное значение равна nil , проверка на таблицу считается действительной, и маршрут принимается. Например, проверка на необязательный параметр, сделанный против строки ( name = "Bo" ), не удастся, если значение params.name равна nil , но проходит, если такая же проверка сделана против таблицы ( name = {Bo=true, Mo=true} ), включая проверки regex/pattern. Если это нежелательно, то пользовательская функция валидатора может явно проверить ожидаемое значение.
Рассмотрим следующий пример:
fm . setRoute ({ " /hello(/:name) " ,
method = { " GET " , " POST " , otherwise = 405 }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) В этом случае, если эта конечная точка доступна с помощью метода PUT , то вместо проверки других маршрутов (поскольку условие method не выполняется), возвращается код состояния 405, как настроено с указанным значением otherwise . Как задокументировано в другом месте, этот маршрут также принимает HEAD запрос (даже если он не указан), как принимается запрос GET .
Когда код состояния 405 (плохой метод) возвращается, и заголовок Allow не установлен, он устанавливается в список методов, разрешенных маршрутом. В приведенном выше случае он установлен, чтобы GET, POST, HEAD, OPTIONS , так как это методы, разрешенные этой конфигурацией. Если значение otherwise является функцией (а не номером), то возвращение надлежащего результата и установка заголовка Allow является обязанностью этой функции.
Значение otherwise также может быть установлено на функцию, которая обеспечивает большую гибкость, чем просто настройка кода состояния. Например, настройка otherwise = fm.serveResponse(413, "Payload Too Large") запускает ответ с указанным кодом состояния и сообщением.
Проверка формы обработки часто требует определения набора условий для того же параметра и пользовательского сообщения об ошибке, которое, возможно, потребуется возвращать, когда условия не выполняются, и они предоставляются специальными валидаторами, возвращенными функцией makeValidator :
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
}
fm . setRoute ( fm . POST { " /signin " , _ = validator }, function ( r )
-- do something useful with name and password
return fm . serveRedirect ( 307 , " / " )
end )В этом примере валидатор настроен для проверки двух параметров - «Имя» и «Пароль» - для их длины MIN и MAX и вернуть сообщение, когда один из параметров не выполняет проверку.
Поскольку проверка сбоя приводит к пропуску маршрута, при условии, что значение otherwise позволяет возвращать ошибку как часть ответа:
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
otherwise = function ( error )
return fm . serveContent ( " signin " , { error = error })
end ,
} В этом случае обработчик otherwise получает сообщение об ошибке (или таблицу с сообщениями, если запрошен, передавая all вариант, описанную ниже), которое можно предоставить в качестве параметра шаблона и возвращен клиенту.
Другой вариант - вызов функции валидатора непосредственно в обработчике действий и вернуть ее результаты:
local validator = fm . makeValidator {
{ " name " , minlen = 5 , maxlen = 64 , msg = " Invalid %s format " },
{ " password " , minlen = 5 , maxlen = 128 , msg = " Invalid %s format " },
}
fm . setRoute ( fm . POST { " /signin " }, function ( r )
local valid , error = validator ( r . params )
if valid then
return fm . serveRedirect ( " / " ) -- status code is optional
else
return fm . serveContent ( " signin " , { error = error })
end
end ) В этом примере валидатор называется непосредственно и передается таблицей ( r.params ) со всеми значениями параметров, позволяющих функции валидатора проверять значения по указанным правилам.
Функция валидатора затем возвращает true к успеху сигнала или nil, error чтобы сигнализировать о неспособности проверить одно из правил. Это позволяет валидатору быть завершенным в assert если сценарий должен сразу же вернуть ошибку:
assert ( validator ( r . params )) -- throw an error if validation fails
return fm . serveRedirect ( 307 , " / " ) -- return redirect in other casesДоступны следующие проверки валидатора:
minlen : (целое число) проверяет минимальную длину строки.maxlen : (целое число) проверяет максимальную длину строки.test : (функция) вызывает функцию, которая передается один параметр и, как ожидается, вернет true или nil | false [, error] .oneof : ( value | { table of values to be compared against } ) проверяет, соответствует ли параметр одно из предоставленных значений.pattern : (Строка) проверяет, соответствует ли параметр выражение шаблона LUA.В дополнение к проверкам, правила могут включать варианты:
optional : (bool) делает параметр необязательным, когда он nil . Все параметры требуются по умолчанию, поэтому эта опция позволяет пропускать правила, когда параметр не предоставлен. Все правила все еще применяются, если параметр не является нулевым.msg : (String) добавляет сообщение клиента для этого, если один из его проверки не стерж, что перезаписывает сообщения из отдельных проверок. Сообщение может включать в себя заполнитель ( %s ), который будет заменен на имя параметра.The validator itself also accepts several options that modify how the generated errors are returned or handled:
otherwise : (function) sets an error handler that is called when one of the checks fails. The function receives the error(s) triggered by the checks.all : (bool) configures the validator to return all errors instead of just the first one. By default only one (first) error is returned as a string, so if all errors are requested, they are returned as a table with each error being a separate item.key : (bool) configures the validator to return error(s) as values in a hash table (instead of element) where the keys are parameter names. This is useful to pass the table with errors to a template that can then display errors.name and errors.password error messages next to their input fields. An action handler receives all incoming HTTP requests filtered for a particular route. Each of the examples shown so far includes an action handler, which is passed as a second parameter to the setRoute method.
Multiple action handlers can be executed in the course of handling one request and as soon as one handler returns a result that is evaluated as a non- false value, the route handling process ends. Returning false or nil from an action handler continues the processing, which allows implementing some common processing that applies to multiple routes (similar to what is done using "before" filters in other frameworks):
local uroute = " /user/:id "
fm . setRoute ({ uroute .. " /* " , method = { " GET " , " POST " , otherwise = 405 }},
function ( r )
-- retrieve user information based on r.params.id
-- and store in r.user (as one of the options);
-- return error if user is not found
return false -- continue handling
end )
fm . setRoute ( fm . GET ( uroute .. " /view " ), function ( r ) ... end )
fm . setRoute ( fm . GET ( uroute .. " /edit " ), function ( r ) ... end )
fm . setRoute ( fm . POST ( uroute .. " /edit " ), function ( r ) ... end )In this example, the first route can generate three outcomes:
method check) is not matched, then the 405 status code is returned.false , which continues processing with other routes, or fails to retrieve the user and returns an error.In general, an action handler can return any of the following values:
true : this stops any further processing, sets the headers that have been specified so far, and returns the generated or set response body.false or nil : this stops the processing of the current route and proceeds to the next one.Content-Type is set based on the body content (using a primitive heuristic) if not set explicitly.serve* methods): this executes the requested method and returns an empty string or true to signal the end of the processing.true is returned (and a warning is logged). Normally any processing that results in a Lua error is returned to the client as a server error response (with the 500 status code). To assist with local debugging, the error message includes a stack trace, but only if the request is sent from a loopback or private IP (or if redbean is launched with the -E command line option).
It may be desirable to return a specific response through multiple layers of function calls, in which case the error may be triggered with a function value instead of a string value. For example, executing error(fm.serve404) results in returning the 404 status code, which is similar to using return fm.serve404 , but can be executed in a function called from an action handler (and only from inside an action handler).
Here is a more complex example that returns the 404 status code if no record is fetched (assuming there is a table test with a field id ):
local function AnyOr404(res, err)
if not res then error(err) end
-- serve 404 when no record is returned
if res == db.NONE then error(fm.serve404) end
return res, err
end
fm.setRoute("/", function(r)
local row = AnyOr404(dbm:fetchOne("SELECT id FROM test"))
return row.id
end)
This example uses the serve404 function, but any other serve* method can also be used.
Each action handler accepts a request table that includes the following attributes:
method : request HTTP method (GET, POST, and others).host : request host (if provided) or the bind address.serverAddr : address to which listening server socket is bound.remoteAddr : client ip4 address encoded as a number. This takes into consideration reverse proxy scenarios. Use formatIp function to convert to a string representing the address.scheme : request URL scheme (if any).path : request URL path that is guaranteed to begin with / .authority : request URL with scheme, host, and port present.url : request URL as an ASCII string with illegal characters percent encoded.body : request message body (if present) or an empty string.date : request date as a Unix timestamp.time : current time as a Unix timestamp with 0.0001s precision.The request table also has several utility functions, as well as headers, cookies, and session tables that allow retrieving request headers, cookies, and session and setting of headers and cookies that are included with the response.
The same request table is given as a parameter to all (matched) action handlers, so it can be used as a mechanism to pass values between those action handlers, as any value assigned as a field in one handler is available in all other action handlers Полем
The headers table provides access to the request headers. For example, r.headers["Content-Type"] returns the value of the Content-Type header. This form of header access is case-insensitive. A shorter form is also available ( r.headers.ContentType ), but only for registered headers and is case-sensitive with the capitalization preserved.
The request headers can also be set using the same syntax. For example, r.headers.MyHeader = "value" sets MyHeader: value response header. As the headers are set at the end of the action handler processing, headers set earlier can also be removed by assigning a nil value.
Repeatable headers can also be assigned with values separated by commas: r.headers.Allow = "GET, POST" .
The cookies table provides access to the request cookies. For example, r.cookies.token returns the value of the token cookie.
The cookies can also be set using the same syntax. For example, r.cookies.token = "new value" sets token cookie to new value . If the cookie needs to have its attributes set as well, then the value and the attributes need to be passed as a table: r.cookies.token = {"new value", secure = true, httponly = true} .
The following cookie attributes are supported:
expires : sets the maximum lifetime of the cookie as an HTTP-date timestamp. Can be specified as a date in the RFC1123 (string) format or as a UNIX timestamp (number of seconds).maxage : sets number of seconds until the cookie expires. A zero or negative number expires the cookie immediately. If both expires and maxage are set, maxage has precedence.domain : sets the host to which the cookie is going to be sent.path : sets the path that must be present in the request URL, or the client is not going to send the Cookie header.secure : (bool) requests the cookie to be only send to the server when a request is made with the https: scheme.httponly : (bool) forbids JavaScript from accessing the cookie.samesite : ( Strict , Lax , or None ) controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks. Note that httponly and samesite="Strict" are set by default; a different set of defaults can be provided using cookieOptions passed to the run method. Any attributes set with a table overwrite the default , so if Secure needs to be enabled, make sure to also pass httponly and samesite options.
To delete a cookie, set its value to false : for example, r.cookies.token = false deletes the value of the token cookie.
The session table provides access to the session table that can be used to set or retrieve session values. For example, r.session.counter returns the counter value set previously. The session values can also be set using the same syntax. For example, r.session.counter = 2 sets the counter value to 2 .
The session allows storing of nested values and other Lua values. If the session needs to be removed, it can be set to an empty table or a nil value. Each session is signed with an application secret, which is assigned a random string by default and can be changed by setting session options.
The following functions are available as both request functions (as fields in the request table) and as library functions:
makePath(route[, parameters]) : creates a path from either a route name or a path string by populating its parameters using values from the parameters table (when provided). The path doesn't need to be just a path component of a URL and can be a full URL as well. Optional parts are removed if they include parameters that are not provided.makeUrl([url,] options) : creates a URL using the provided value and a set of URL parameters provided in the options table: scheme, user, pass, host, port, path, and fragment. The url parameter is optional; the current request URL is used if url is not specified. Any of the options can be provided or removed (using false as the value). For example, makeUrl({scheme="https"}) sets the scheme for the current URL to https .escapeHtml(string) : escapes HTML entities ( &><"' ) by replacing them with their HTML entity counterparts ( &><"' ).escapePath(path) : applies URL encoding ( %XX ) escaping path unsafe characters (anything other than -.~_@:!$&'()*+,;=0-9A-Za-z/ ).formatHttpDateTime(seconds) : converts UNIX timestamp (in seconds) to an RFC1123 string ( Mon, 21 Feb 2022 15:37:13 GMT ).Templates provide a simple and convenient way to return a predefined and parametrized content instead of generating it piece by piece.
The included template engine supports mixing an arbitrary text with Lua statements/expressions wrapped into {% %} tags. All the code in templates uses a regular Lua syntax, so there is no new syntax to learn. There are three ways to include some Lua code:
{% statement %} : used for Lua statements . For example, {% if true then %}Hello{% end %} renders Hello .{%& expression %} : used for Lua expressions rendered as HTML-safe text. For example, {%& '2 & 2' %} renders 2 & 2{%= expression %} : used for Lua expressions rendered as-is (without escaping). For example, {%= 2 + 2 %} renders 4 . Be careful, as HTML is not escaped with {%= } , this should be used carefully due to the potential for XSS attacks.The template engine provides two main functions to use with templates:
setTemplate(name, text[, parameters]) : registers a template with the provided name and text (and uses parameters as its default parameters). There are special cases where name or text parameters may not be strings, with some of those cases covered in the Loading templates section. parameters is a table with template parameters as name/value pairs (referenced as variables in the template).render(name, parameters) : renders a registered template using the parameters table to set values in the template (with key/value in the table assigned to name/value in the template).There is only one template with a given name, so registering a template with an existing name replaces this previously registered template. This is probably rarely needed, but can be used to overwrite default templates.
Here is an example that renders Hello, World! to the output buffer:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . render ( " hello " , { title = " World " })Rendering statements using the expression syntax or expressions using the statement syntax is a syntax error that is reported when the template is registered. Function calls can be used with either syntax.
Any template error (syntax or run-time) includes a template name and a line number within the template. For example, calling fm.setTemplate("hello", "Hello, {%& if title then end %}!") results in throwing hello:1: unexpected symbol near 'if' error (as it inserts a Lua statement using the expression syntax).
Templates can also be loaded from a file or a directory using the same setTemplate function, which is described later in the Loading templates section.
There are several aspects worth noting, as they may differ from how templates are processed in other frameworks:
json and sse templates are implemented using this approach.Each template accepts parameters that then can be used in its rendering logic. Parameters can be passed in two ways: (1) when the template is registered and (2) when the template is rendered. Passing parameters during registration allows to set default values that are used if no parameter is provided during rendering. Например,
fm . setTemplate ( " hello " , " Hello, {%& title %}! " , { title = " World " })
fm . render ( " hello " ) -- renders `Hello, World!`
fm . render ( " hello " , { title = " All " }) -- renders `Hello, All!` nil or false values are rendered as empty strings without throwing any error, but any operation on a nil value is likely to result in a Lua error. For example, doing {%& title .. '!' %} (without title set) results in attempt to concatenate a nil value (global 'title') error.
There is no constraint on what values can be passed to a template, so any Lua value can be passed and then used inside a template.
In addition to the values that can be passed to templates, there are two special tables that provide access to cross-template values :
vars : provides access to values registered with setTemplateVar , andblock : provides access to template fragments that can be overwritten by other templates. Any value registered with setTemplateVar becomes accessible from any template through the vars table. In the following example, the vars.title value is set by the earlier setTemplateVar('title', 'World') call:
fm . setTemplateVar ( ' title ' , ' World ' )
fm . setTemplate ( " hello " , " Hello, {%& vars.title %}! " )
fm . render ( " hello " ) -- renders `Hello, World!` While undefined values are rendered as empty string by default (which may be convenient in most cases), there are still situations when it is preferrable to not allow undefined values to be silently handled. In this a special template variable ( if-nil ) can be set to handle those cases to throw an error or to log a message. For example, the following code throws an error, as the missing value is undefined, which triggers if-nil handler:
fm . setTemplateVar ( ' if-nil ' , function () error " missing value " end )
fm . setTemplate ( " hello " , " Hello, {%& vars.missing %}! " )
fm . render ( " hello " ) -- throws "missing value" error Templates can be also rendered from other templates by using the render function, which is available in every template:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . setTemplate ( " header " , " <h1>{% render('hello', {title = title}) %}</h1> " )
---- -----------------------------└──────────────────────────────┘----------
fm . render ( " header " , { title = ' World ' }) -- renders `<h1>Hello, World!</h1>`There are no limits on how templates can be rendered from other templates, but no checks for loops are made either, so having circular references in template rendering (when a template A renders a template B, which in turn renders A again) is going to cause a Lua error.
It's worth noting that the render function doesn't return the value of the template it renders, but instead puts it directly into the output buffer.
This ability to render templates from other templates allows producing layouts of any complexity. There are two ways to go about it:
To dynamically choose the template to use at render time, the template name itself can be passed as a parameter:
fm . setTemplate ( " hello " , " Hello, {%& title %}! " )
fm . setTemplate ( " bye " , " Bye, {%& title %}! " )
fm . setTemplate ( " header " , " <h1>{% render(content, {title = title}) %}</h1> " )
fm . render ( " header " , { title = ' World ' , content = ' hello ' }) This example renders either <h1>Hello, World!</h1> or <h1>Bye, World!</h1> depending on the value of the content parameter.
Using blocks allows defining template fragments that can (optionally) be overwritten from other templates (usually called "child" or "inherited" templates). The following example demonstrates this approach:
fm . setTemplate ( " header " , [[
<h1>
{% function block.greet() %} -- define a (default) block
Hi
{% end %}
{% block.greet() %}, -- render the block
{%& title %}!
</h1>
]] )
fm . setTemplate ( " hello " , [[
{% function block.greet() %} -- overwrite the `header` block (if any)
Hello
{% end %}
{% render('header', {title=title}) %}!
]] )
fm . setTemplate ( " bye " , [[
{% function block.greet() %} -- overwrite the `header` block (if any)
Bye
{% end %}
{% render('header', {title=title}) %}!
]] )
-- normally only one of the three `render` calls is needed,
-- so all three are shown for illustrative purposes only
fm . render ( " hello " , { title = ' World ' }) -- renders <h1>Hello, World!</h1>
fm . render ( " bye " , { title = ' World ' }) -- renders `<h1>Bye, World!</h1>`
fm . render ( " header " , { title = ' World ' }) -- renders `<h1>Hi, World!</h1>` In this example the header template becomes the "layout" and defines the greet block with Hi as its content. The block is defined as a function in the block table with the content it needs to produce. It's followed by a call to the block.greet function to include its content in the template.
This is important to emphasize, as in addition to defining a block, it also needs to be called from the base/layout template at the point where it is expected to be rendered.
The hello template also defines block.greet function with a different content and then renders the header template. When the header template is rendered, it uses the content of the block.greet function as defined in the hello template. In this way, the child template "redefines" the greet block with its own content, inserting it into the appropriate place into the parent template.
It works the same way for the bye and header templates. There is nothing special about these "block" functions other than the fact that they are defined in the block table.
This concepts is useful for template composition at any depth. For example, let's define a modal template with a header and a footer with action buttons:
fm . setTemplate ( " modal " , [[
<div class="modal">
<div class="modal-title">
{% function block.modal_title() %}
Details
{% end %}
{% block.modal_title() %}
</div>
<div class="modal-content">
{% block.modal_content() %}
</div>
<div class="modal-actions">
{% function block.modal_actions() %}
<button>Cancel</button>
<button>Save</button>
{% end %}
{% block.modal_actions() %}
</div>
</div>
]] )Now, in a template that renders the modal, the blocks can be overwritten to customize the content:
fm . setTemplate ( " page " , [[
{% function block.modal_title() %}
Insert photo
{% end %}
{% function block.modal_content() %}
<div class="photo-dropzone">Upload photo here</div>
{% end %}
{% render('modal') %}
]] )This enables easily building composable layouts and components, such as headers and footers, cards, modals, or anything else that requires the ability to dynamically customize sections in other templates.
Here is an example to illustrate how nested blocks work together:
-- base/layout template
{ % function block . greet () % } -- 1. defines default "greet" block
Hi
{ % end % }
{ % block . greet () % } -- 2. calls "greet" block
-- child template
{ % function block . greet () % } -- 3. defines "greet" block
Hello
{ % end % }
{ % render ( ' base ' ) % } -- 4. renders "base" template
-- grandchild template
{ % function block . greet () % } -- 5. defines "greet" block
Bye
{ % end % }
{ % render ( ' child ' ) % } -- 6. renders "child" template In this example the "child" template "extends" the base template and any block.greet content defined in the child template is rendered inside the "base" template (when and where the block.greet() function is called). The default block.greet block doesn't need to be defined in the base template, but when it is present (step 1), it sets the content to be rendered (step 2) if the block is not overwritten in a child template and needs to be defined before block.greet function is called.
Similarly, block.greet in the child template needs to be defined before (step 3) the base template is rendered (step 4) to have a desired effect.
If one of the templates in the current render tree doesn't define the block, then the later defined block is going to be used. For example, if the grandchild template doesn't define the block in step 5, then the greet block from the child template is going to be used when the grandchild template is rendered.
If none of the block.greet functions is defined, then block.greet() fails (in the base template). To make the block optional , just check the function before calling. For example, block.greet and block.greet() .
In those cases where the "overwritten" block may still need to be rendered, it's possible to reference that block directly from the template that defines it, as shown in the following example:
fm . setTemplate ( " header " , [[
<h1>
{% function block.greet() %}
Hi
{% end %}
{% block.greet() %}, {%& title %}!
</h1>
]] )
fm . setTemplate ( " bye " , [[
{% block.header.greet() %},
{% function block.greet() %}
Bye
{% end %}
{% render('header', {title=title}) %}!
]] )
fm . render ( " bye " , { title = ' World ' }) -- renders `<h1>Hi, Bye, World!</h1>` In this case, {% block.header.greet() %} in the bye template renders the greet block from the header template. This only works with the templates that are currently being rendered and is intended to simulate the "super" reference (albeit with explicit template references). The general syntax of this call is block.<templatename>.<blockname>() .
As blocks are simply regular Lua functions, there are no restrictions on how blocks can be nested into other blocks or how blocks are defined relative to template fragments or other Lua statements included in the templates.
In addition to registering templates from a string, the templates can be loaded and registered from a file or a directory using the same setTemplate function, but passing a table with the directory and a list of mappings from file extensions to template types to load. For example, calling fm.setTemplate({"/views/", tmpl = "fmt"}) loads all *.tmpl files from the /views/ directory (and its subdirectories) and registers each of them as the fmt template, which is the default template type. Only those files that match the extension are loaded and multiple extension mappings can be specified in one call.
Each loaded template gets its name based on the full path starting from the specified directory: the file /views/hello.tmpl is registered as a template with the name "hello" (without the extension), whereas the file /views/greet/bye.tmpl is registered as a template with the name "greet/bye" (and this is the exact name to use to load the template).
There are two caveats worth mentioning, both related to the directory processing. The first one is related to the trailing slash in the directory name passed to setTemplate . It's recommended to provide one, as the specified value is used as a prefix, so if /view is specified, it's going to match both /view/ and /views/ directories (if present), which may or may not be the intended result Полем
The second caveat is related to how external directories are used during template search. Since redbean allows access to external directories when configured using the -D option or directory option (see Running application for details), there may be multiple locations for the same template available. The search for the template follows these steps:
setTemplate call); This allows to have a working copy of a template to be modified and processed from the file system (assuming the -D option is used) during development without modifying its copy in the archive.
Even though using fm.render is sufficient to get a template rendered, for consistency with other serve* functions, the library provides the serveContent function, which is similar to fm.render , but allows the action handler to complete after serving the content:
fm . setTemplate ( " hello " , " Hello, {%& name %} " )
fm . setRoute ( " /hello/:name " , function ( r )
return fm . serveContent ( " hello " , { name = r . params . name })
end ) There is also one subtle difference between render and serveContent methods that comes into play when serving static templates . It may be tempting to directly render a static template in response to a route with something like this:
fm . setTemplate ( " hello " , " Hello, World! " )
-- option 1:
fm . setRoute ( " /hello " , fm . render ( " hello " ))
---- ---------------------└─────┘-------- not going to work
-- option 2:
fm . setRoute ( " /hello " , fm . serveContent ( " hello " ))
---- ---------------------└───────────┘-- works as expected The first approach is not going to work, as the call to fm.render is going to be made when setRoute is called (and the route is only being set up) and not when a request is being handled. When the serveContent method is using (the second option), it's implemented in a way that delays the processing until the request is handled, thus avoiding the issue. If the template content depends on some values in the request, then the serverContent call has to be wrapped into a function to accept and pass those variables (as shown in the earlier /hello/:name route example).
Most of the time, the library configuration is focused on handling of incoming requests, but in some cases it may be desirable to trigger and handle internal events. The library supports job scheduling using cron syntax, with configured jobs executed at the scheduled time (as long as the redbean instance is running). A new schedule can be registered using the setSchedule method:
---- ----------- ┌─────────── minute (0-59)
---- ----------- │ ┌───────── hour (0-23)
---- ----------- │ │ ┌─────── day of the month (1-31)
---- ----------- │ │ │ ┌───── month (1-12 or Jan-Dec)
---- ----------- │ │ │ │ ┌─── day of the week (0-6 or Sun-Mon)
---- ----------- │ │ │ │ │ --
---- ----------- │ │ │ │ │ --
fm . setSchedule ( " * * * * * " , function () fm . logInfo ( " every minute " ) end )All the standard and some non-standard cron expressions are supported:
* : describes any values in the allowed range., : uses to form a list of items, for example, 1,2,3 .- : creates an (inclusive) range; for example, 1-3 is equivalent to 1,2,3 . Open ranges are allowed as well, so -3 is equivalent to 1-3 for months and 0-3 for minutes and hours./ : describes a step for ranges. It selects a subset of the values in the range, using the step value; for example, 2-9/3 is equivalent to 2,5,8 (it starts with 2, then adds a step value to get 5 and 8). Non-numeric values are supported for months ( Jan-Dec ) and days of week ( Sun-Mon ) in any capitalization. Using 7 for Sun is supported too.
By default all functions are executed in a separate (forked) process. If the execution within the same process is needed, then setSchedule can be passed a third parameter (a table) to set sameProc value as one of the options: {sameProc = true} .
Some of the caveats to be aware of:
OnServerHeartbeat hook, so a version of Redbean that provides that (v2.0.16+) should be used.and (instead of an or ), so when both are specified, the job is executed when both are satisfied (and not when both or either are specified). In other words, * * 13 * Fri is only valid on Friday the 13th and not on any Friday. If the or behavior is needed, then the schedule can be split into two to handle each condition separately.sameProc = true option to avoid forking.Sun available on both ends (as 0 or 7), so it's better to use closed ranges in this case to avoid ambiguity.6-100 for months is corrected to 6-12 .Each action handler generates some sort of response to send back to the client. In addition to strings, the application can return the following results:
serveResponse ),serveContent ),serveRedirect ),serveAsset ),serveError ),serveIndex ), andservePath ). Each of these methods can be used as the return value from an action handler. serveAsset , servePath , and serveIndex methods can also be used as action handlers directly:
fm . setRoute ( " /static/* " , fm . serveAsset )
fm . setRoute ( " /blog/ " , fm . serveIndex ( " /new-blog/ " )) The first route configures all existing assets to be served from /static/* location; the second route configures /blog/ URL to return the index ( index.lua or index.html resource) from /new-blog/ directory.
serveResponse(status[, headers][, body]) : sends an HTTP response using provided status , headers , and body values. headers is an optional table populated with HTTP header name/value pairs. If provided, this set of headers removes all other headers set earlier during the handling of the same request. Similar to the headers set using the request.headers field, the names are case-insensitive , but provided aliases for header names with dashes are case-sensitive : {ContentType = "foo"} is an alternative form for {["Content-Type"] = "foo"} . body is an optional string.
Consider the following example:
return fm . serveResponse ( 413 , " Payload Too Large " ) This returns the 413 status code and sets the body of the returned message to Payload Too Large (with the header table not specified).
If only the status code needs to be set, the library provides a short form using the serve### syntax:
return fm . serve413It can also be used as the action handler itself:
fm . setRoute ( fm . PUT " /status " , fm . serve402 ) serveContent(name, parameters) renders a template using provided parameters. name is a string that names the template (as set by a setTemplate call) and parameters is a table with template parameters (referenced as variables in the template).
Fullmoon's function makeStorage is a way to connect to, and use a SQLite3 database. makeStorage returns a database management table which contains a rich set of functions to use with the connected database.
The run method executes the configured application. By default the server is launched listening on localhost and port 8080. Both of these values can be changed by passing addr and port options:
fm . run ({ addr = " localhost " , port = 8080 }) The following options are supported; the default values are shown in parentheses and options marked with mult can set multiple values by passing a table:
addr : sets the address to listen on (mult)brand : sets the Server header value ( "redbean/v# fullmoon/v#" )cache : configures Cache-Control and Expires headers (in seconds) for all static assets served. A negative value disables the headers. Zero value means no cache.certificate : sets the TLS certificate value (mult)directory : sets local directory to serve assets from in addition to serving them from the archive within the executable itself (mult)headers : sets default headers added to each response by passing a table with HTTP header name/value pairslogMessages : enables logging of response headerslogBodies : enables logging of request bodies (POST/PUT/etc.)logPath : sets the log file path on the local file systempidPath : sets the pid file path on the local file systemport : sets the port number to listen on (8080)privateKey : sets the TLS private key value (mult)sslTicketLifetime : sets the duration (in seconds) of the ssl ticket (86400)trustedIp : configures IP address to trust (mult). This option accepts two values (IP and CIDR values), so they need to be passed as a table within a table specifying multiple parameters: trustedIp = {{ParseIp("103.31.4.0"), 22}, {ParseIp("104.16.0.0"), 13}}tokenBucket : enables DDOS protection. This option accepts zero to 5 values (passed as a table within a table); an empty table can be passed to use default values: tokenBucket = {{}} Each option can accept a simple value ( port = 80 ), a list of values ( port = {8080, 8081} ) or a list of parameters. Since both the list of values and the list of parameters are passed as tables, the list of values takes precedence, so if a list of parameters needs to be passed to an option (like trustedIp ), it has to be wrapped into a table: trustedIp = {{ParseIp("103.31.4.0"), 22}} . If only one parameter needs to be passed, then both trustedIp = {ParseIp("103.31.4.0")} and trustedIp = ParseIp("103.31.4.0") can work.
The key and certificate string values can be populated using the getAsset method that can access both assets packaged within the webserver archive and those stored in the file system.
There are also default cookie and session options that can be assigned using cookieOptions and sessionOptions tables described below.
cookieOptions sets default options for all cookie values assigned using request.cookie.name = value syntax ( {httponly=true, samesite="Strict"} ). It is still possible to overwrite default values using table assignment: request.cookie.name = {value, secure=false} .
sessionOptions sets default options for the session value assigned using request.session.attribute = value syntax ( {name="fullmoon_session", hash="SHA256", secret=true, format="lua"} ). If the secret value is set to true , then a random key is assigned each time the server is started ; if verbose logging is enabled (by either adding -v option for Redbean or by using fm.setLogLevel(fm.kLogVerbose) call), then a message is logged explaining how to apply the current random value to make it permanent.
Setting this value to false or an empty string applies hashing without a secret key.
The results shown are from runs in the same environment and on the same hardware as the published redbean benchmark (thanks to @jart for executing the tests!). Even though these tests are using pre-1.5 version of redbean and 0.10 version of Fullmoon, the current versions of redbean/Fullmoon are expected to deliver similar performance.
The tests are using exactly the same code that is shown in the introduction with one small change: using {%= name %} instead of {%& name %} in the template, which skips HTML escaping. This code demonstrates routing, parameter handling and template processing.
$ wrk -t 12 -c 120 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
12 threads and 120 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 312.06us 4.39ms 207.16ms 99.85%
Req/Sec 32.48k 6.69k 71.37k 82.25%
3913229 requests in 10.10s, 783.71MB read
Requests/sec: 387477.76
Transfer/sec: 77.60MB
The following test is using the same configuration, but redbean is compiled with MODE=optlinux option:
$ wrk -t 12 -c 120 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
12 threads and 120 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 346.31us 5.13ms 207.31ms 99.81%
Req/Sec 36.18k 6.70k 90.47k 80.92%
4359909 requests in 10.10s, 0.85GB read
Requests/sec: 431684.80
Transfer/sec: 86.45MB
The following two tests demonstrate the latency of the request handling by Fullmoon and by redbean serving a static asset (no concurrency):
$ wrk -t 1 -c 1 http://127.0.0.1:8080/user/paul
Running 10s test @ http://127.0.0.1:8080/user/paul
1 threads and 1 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 15.75us 7.64us 272.00us 93.32%
Req/Sec 65.54k 589.15 66.58k 74.26%
658897 requests in 10.10s, 131.96MB read
Requests/sec: 65241.45
Transfer/sec: 13.07MB
The following are the results from redbean itself on static compressed assets:
$ wrk -H 'Accept-Encoding: gzip' -t 1 -c 1 htt://10.10.10.124:8080/tool/net/demo/index.html
Running 10s test @ htt://10.10.10.124:8080/tool/net/demo/index.html
1 threads and 1 connections
Thread Stats Avg Stdev Max +/- Stdev
Latency 7.40us 1.95us 252.00us 97.05%
Req/Sec 129.66k 3.20k 135.98k 64.36%
1302424 requests in 10.10s, 1.01GB read
Requests/sec: 128963.75
Transfer/sec: 102.70MB
Berwyn Hoyt included Redbean results in his lua server benchmark results, which shows redbean outperforming a comparable nginx/openresty implementation.
Highly experimental with everything being subject to change.
The core components are more stable and have been rarely updated since v0.3. Usually, the documented interfaces are much more stable than undocumented ones. Those commits that modified some of the interfaces are marked with COMPAT label, so can be easily identified to review for any compatibility issues.
Some of the obsolete methods are still present (with a warning logged when used) to be removed later.
Paul Kulchenko ([email protected])
See LICENSE.
