fullmoon
1.0.0
O Fullmoon é uma estrutura da Web rápida e minimalista, baseada no Redbean-um servidor web portátil e distribuível de arquivo único.
Tudo o necessário para o desenvolvimento e a distribuição vem em um único arquivo sem dependências externas e após a embalagem com as execuções RedBean no Windows, Linux ou MacOS. A seguir, é apresentado um exemplo completo de um aplicativo de lua full:
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 () Depois de ser embalado com o RedBean, ele pode ser lançado usando ./redbean.com , que inicia um servidor que retorna "Hello, World" a uma solicitação HTTP (s) enviada para http: // localhost: 8080/hello/World.
O Redbean é um servidor web de plataforma cruzada distribuível de um único arquivo com qualidades exclusivas e poderosas. Embora existam várias estruturas da Web baseadas em Lua (Lapis, Lor, Sailor, Pegasus e outros), nenhum deles se integra ao Redbean (embora exista uma estrutura experimental ANPAN).
A Fullmoon é uma estrutura da Web leve e minimalista, escrita da perspectiva de mostrar todos os recursos que o Redbean fornece, estendendo e aumentando -os da maneira mais simples e mais eficiente. Ele funciona rápido e vem com baterias incluídas (rotas, modelos, geração JSON e muito mais).
A Fullmoon segue a filosofia da Lua e fornece um conjunto mínimo de ferramentas para combinar conforme necessário e usar conforme a base para construir.
fork de plataforma cruzada, socket , memória compartilhada e muito maisBaixe uma cópia do Redbean executando os seguintes comandos (pule o segundo se executando esses comandos no Windows):
curl -o redbean.com https://redbean.dev/redbean-2.2.com
chmod +x redbean.comO número mais recente da versão pode ser recuperado com a seguinte solicitação:
curl https://redbean.dev/latest.txtOutra opção é construir o RedBean a partir da fonte seguindo as instruções para a compilação de origem.
fullmoon.lua para .lua/ diretório.init.lua (por exemplo, o código Lua mostrado na descrição). Outra opção é colocar o código do aplicativo em um arquivo separado (por exemplo, .lua/myapp.lua ) e adicionar require "myapp" para .init.lua . É assim que todos os exemplos incluídos são apresentados.
zip redbean.com .init.lua .lua/fullmoon.lua Se o código do aplicativo for armazenado em um arquivo Lua separado, conforme descrito acima, coloque -o dentro do .lua/ diretório e zip esse arquivo também.
./redbean.comSe este comando for executado no Linux e lançar um erro sobre não encontrar o intérprete, ele deverá ser corrigido executando o seguinte comando (embora observe que ele não pode sobreviver a um reinicialização do sistema):
sudo sh -c " echo ':APE:M::MZqFpD::/bin/sh:' >/proc/sys/fs/binfmt_misc/register "Se este comando produzir erros intrigantes no WSL ou vinho ao usar o Redbean 2.x, eles poderão ser corrigidos desativando o Binfmt_misc:
sudo sh -c ' echo -1 >/proc/sys/fs/binfmt_misc/status 'Inicie um navegador apontando para http: // localhost: 8080/hello/World e deve retornar "Hello, World" (supondo que o aplicativo esteja usando o código mostrado na introdução ou na seção de uso).
O exemplo mais simples precisa (1) carregar o módulo, (2) configurar uma rota e (3) executar o aplicativo:
local fm = require " fullmoon " -- (1)
fm . setRoute ( " /hello " , function ( r ) return " Hello, world " end ) -- (2)
fm . run () -- (3) Este aplicativo responde a qualquer solicitação de /hello URL com o conteúdo de retorno "Hello, World" (e o código de status 200) e responde com o código de status 404 para todas as outras solicitações.
setRoute(route[, action]) : registra uma rota. Se route for uma string, ela será usada como uma expressão de rota para comparar o caminho de solicitação. Se for uma tabela, seus elementos são strings que são usados como rotas e seus valores de hash são condições contra as quais as rotas são verificadas. Se o segundo parâmetro for uma função, ele será executado se todas as condições forem satisfeitas. Se for uma string, é usado como uma expressão de rota e a solicitação é processada como se fosse enviada na rota especificada (atua como um redirecionamento interno). Se alguma condição não estiver satisfeita, a próxima rota será verificada. A expressão da rota pode ter vários parâmetros e peças opcionais. O manipulador de ação aceita uma tabela de solicitação que fornece acesso aos parâmetros de solicitação e rotear, bem como cabeçalhos, cookies e sessão.
setTemplate(name, template[, parameters]) : registra um modelo com o nome especificado ou um conjunto de modelos de um diretório. Se template for uma string, ele será compilado em um manipulador de modelo. Se for uma função, é armazenado e chamado quando a renderização do modelo é solicitada. Se for uma tabela, seu primeiro elemento é um modelo ou uma função e o restante é usado como opções. Por exemplo, especificar ContentType como uma das opções define o cabeçalho Content-Type para o conteúdo gerado. Vários modelos ( 500 , json e outros) são fornecidos por padrão e podem ser substituídos. parameters é uma tabela com parâmetros de modelo armazenados como pares de nome/valor (referenciados como variáveis no modelo).
serveResponse(status[, headers][, body]) : envia uma resposta HTTP usando status , headers e valores body fornecidos. headers são uma tabela opcional preenchida com pares de nomes/valores do cabeçalho HTTP. Se fornecido, esse conjunto de cabeçalhos remove todos os outros cabeçalhos definidos anteriormente durante o manuseio da mesma solicitação. Os nomes dos cabeçalhos são insensíveis a maiúsculas , mas os aliases para nomes de cabeçalho com traços são sensíveis à caixa : {ContentType = "foo"} é uma forma alternativa para {["Content-Type"] = "foo"} . body é uma corda opcional.
serveContent(name, parameters) : renderiza um modelo usando parâmetros fornecidos. name é uma string que nomeia o modelo (conforme definido por uma chamada setTemplate ) e parameters são uma tabela com parâmetros de modelo armazenados como pares de nome/valor (referenciados como variáveis no modelo).
run([options]) : executa o servidor usando rotas configuradas. Por padrão, o servidor ouve o localhost e a porta 8080. Esses valores podem ser alterados definindo valores addr e port na tabela options .
Exemplos de execução requer a inclusão de uma declaração require no arquivo .init.lua , que carrega o módulo com cada código de exemplo; portanto, para o exemplo de showcase implementado em showcase.lua , .init.lua inclui o seguinte:
-- 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`O exemplo do Showcase demonstra vários recursos de lua cheia:
serveAsset )serveRedirect )Os seguintes arquivos precisam ser adicionados ao Redbean Executável/Arquivo:
.Init.lua - requer "mostra" .lua/fullmoon.lua .lua/showcase.lua
O exemplo do TechemPower implementa vários tipos de teste para os benchmarks da estrutura da web usando o Fullmoon e um banco de dados SQLite na memória.
Este exemplo demonstra vários recursos de lua full/Redbean:
Os seguintes arquivos precisam ser adicionados ao Redbean Executável/Arquivo:
.init.lua - requer "Techbench" .lua/fullmoon.lua .lua/Techbench.lua
O exemplo da placa HTMX demonstra um aplicativo simples que gera fragmentos HTML entregues ao cliente usando a biblioteca HTMX.
Este exemplo demonstra vários recursos de lua full/Redbean:
Os seguintes arquivos precisam ser adicionados ao Redbean Executável/Arquivo:
.init.lua - requer "htmxboard" .lua/fullmoon.lua .lua/htmxboard.lua ativos/styles.css TMPL/* - Todos os arquivos do diretório Exemplos/Htmxboard/TMPL
Nota 1: Como todos os dados são armazenados na memória, este exemplo é executado no modo Uniprocess.
Nota 2: Esses exemplos recuperam bibliotecas HTMX, Hiperscript e classificáveis a partir de recursos externos, mas essas bibliotecas também podem ser armazenadas como ativos locais, fornecendo assim um pacote de distribuição portátil completamente auto-suficiente.
O exemplo do HTMX SSE demonstra uma maneira de gerar eventos enviados pelo servidor (SSE) que podem ser transmitidos para um cliente (que mostra resultados usando a biblioteca HTMX e sua extensão SSE).
Este exemplo demonstra vários recursos de lua full/Redbean:
streamContent )Os seguintes arquivos precisam ser adicionados ao Redbean Executável/Arquivo:
.init.lua - requer "htmxssse" .lua/fullmoon.lua .lua/htmxsse.lua
Cada aplicativo Fullmoon segue o mesmo fluxo básico com cinco componentes principais:
Vejamos cada um dos componentes a partir do roteamento da solicitação.
Fullmoon lida com cada solicitação HTTP usando o mesmo processo:
false ou nil retornado do manipulador de ação (e continua o processo de outra forma) Em geral, as definições de rota ligam URLs de solicitação (e um conjunto de condições) aos manipuladores de ação (que são a função Lua regular). Todas as condições são verificadas em uma ordem aleatória para cada URL que corresponde à definição da rota. Assim que qualquer condição falhar, o processamento da rota é abortado e a próxima rota é verificada com uma exceção : qualquer condição pode definir o valor otherwise , que aciona uma resposta com o código de status especificado.
Se nenhuma rota corresponder à solicitação, o processamento padrão 404 será acionado, que pode ser personalizado registrando um modelo 404 personalizado ( fm.setTemplate("404", "My 404 page...") ).
Cada rota segue exatamente um caminho que corresponde, então a rota "/hello" corresponde a solicitações de /hello e não corresponde /hell , /hello-world , ou /hello/world . A rota abaixo responde com "Olá, mundo!" Para todas as solicitações direcionadas para o caminho /hello e retorna 404 para todas as outras solicitações.
fm . setRoute ( " /hello " , function ( r ) return " Hello, World! " end ) Para corresponder a um caminho onde /hello é apenas uma parte, parâmetros opcionais e splat podem ser usados.
Além das rotas fixas, qualquer caminho pode incluir espaços reservados para parâmetros, que são identificados por a : seguido imediatamente pelo nome do parâmetro:
fm . setRoute ( " /hello/:name " ,
function ( r ) return " Hello, " .. ( r . params . name ) end ) Cada parâmetro corresponde a um ou mais caracteres, exceto / , então a rota "/hello/:name" corresponde /hello/alice , /hello/bob , /hello/123 e não corresponde /hello/bob/and/alice (por causa de as barras para frente não correspondidas) ou /hello/ (porque o comprimento do fragmento a ser correspondido é zero).
Os nomes de parâmetros podem incluir apenas caracteres alfanuméricos e _ .
Os parâmetros podem ser acessados usando a tabela de solicitações e sua tabela params , de modo que r.params.name possa ser usado para obter o valor do parâmetro de name do exemplo anterior.
Qualquer fragmento ou parâmetro de rota especificado pode ser declarado opcional, envolvendo -o em parênteses:
fm . setRoute ( " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) No exemplo acima, ambos /hello e /hello/Bob são aceitos, mas não /hello/ , como a barra traseira faz parte do fragmento opcional e :name ainda espera um ou mais caracteres.
Qualquer parâmetro opcional incomparável fica false como seu valor; portanto, no caso acima "Olá, mundo!" é devolvido para o URL /hello request.
Mais de um parâmetro opcional pode ser especificado e os fragmentos opcionais podem ser aninhados; portanto, ambos "/posts(/:pid/comments(/:cid))" e "/posts(/:pid)/comments(/:cid)" são valores de rota válidos.
Existe outro tipo de parâmetro chamado splat que é escrito como * e corresponde a zero ou mais caracteres, incluindo uma barra para a frente ( / ). O splat também é armazenado na tabela params sob o nome splat . Por exemplo, a rota "/download/*" Matches /download/my/file.zip e o splat recebe o valor do my/file.zip . Se vários splats forem necessários na mesma rota, os splats poderão ser atribuídos nomes semelhantes a outros parâmetros: /download/*path/*fname.zip (embora o mesmo resultado possa ser alcançado usando /download/*path/:fname.zip th/Path/:fname.zip , como o primeiro splat captura todas as partes do caminho, exceto o nome do arquivo).
Todos os parâmetros (incluindo o splat) podem aparecer em qualquer parte do caminho e podem ser cercados por outro texto, que precisa ser exatamente correspondido. Isso significa que a rota "/download/*/:name.:ext" Matches /download/my/path/file.zip e params.name recebe file , params.ext recebe zip e params.splat recebe my/path .
Outro motivo para usar o SPLAT é permitir que várias rotas com o mesmo caminho sejam registradas no sistema. A implementação atual substitui as rotas com o mesmo nome e para evitar que um SPLAT nomeado possa ser usado para criar caminhos exclusivos. Por exemplo,
fm . setRoute ( " /*dosomething1 " , function ( r ) return " something 1 " end )
fm . setRoute ( " /*dosomething2 " , function ( r ) return " something 2 " end )Isso pode ser usado em situações em que há um conjunto de condições que precisam ser verificadas no manipulador de ação e, embora seja possível combinar as duas rotas em uma, às vezes é mais limpo mantê -las separadas.
O valor padrão para os parâmetros são todos os caracteres (exceto / ) do comprimento um ou mais. Para especificar um conjunto diferente de caracteres válidos, ele pode ser adicionado no final do nome da variável; Por exemplo, usando :id[%d] em vez de :id altera o parâmetro para corresponder apenas a dígitos.
fm . setRoute ( " /hello(/:id[%d]) " ,
function ( r ) return " Hello, " .. ( r . params . id or " World! " ) end ) As seguintes classes de caracteres Lua são suportadas: %w , %d , %a , %l , %u e %x ; Qualquer caráter de pontuação (incluindo % e ] ) também pode ser escapar com % . As classes negativas (escritas em Lua como %W ) não são suportadas , mas a sintaxe não no set é suportada; portanto, [^%d] corresponde a um parâmetro que não inclui dígitos.
Observe que o número de repetições não pode ser alterado (então :id[%d]* não é uma maneira válida de aceitar dígitos zero ou mais), pois apenas os conjuntos são permitidos e os valores ainda aceitam um ou mais caracteres. Se for necessária mais flexibilidade na descrição de formatos aceitáveis, os validadores personalizados poderão ser usados para estender a lógica correspondente.
Os parâmetros de consulta e formulário podem ser acessados da mesma maneira que os parâmetros do caminho usando a tabela params na tabela request que é passada para cada manipulador de ação. Observe que, se houver um conflito entre os nomes de parâmetro e consulta/formulário, os nomes dos parâmetros terão precedência .
Há um caso especial que pode resultar em uma tabela retornada em vez de um valor de string: se o nome do parâmetro de consulta/formulário terminar em [] , todos os resultados correspondentes (um ou mais) serão retornados como uma tabela. Por exemplo, para uma sequência de consulta a[]=10&a[]&a[]=12&a[]= o valor de params["a[]"] é {10, false, 12, ""} .
Como a gravação desses nomes de parâmetros pode exigir vários colchetes, params.a podem ser usados como um atalho para params["a[]"] com ambos os formulários retornando a mesma tabela.
Os parâmetros multiparts também são processados quando solicitados e podem ser acessados da mesma maneira que o restante dos parâmetros usando a tabela params . Por exemplo, parâmetros com nomes simple e more podem ser recuperados de uma mensagem com tipo de conteúdo multipart/form-data usando params.simple e params.more .
Como alguns dos conteúdos de múltiplos podem incluir cabeçalhos e parâmetros adicionais nesses cabeçalhos, eles podem ser acessados com o campo multipart da tabela params :
fm . setRoute ({ " /hello " , simple = " value " }, function ( r )
return " Show " .. r . params . simple .. " " .. r . params . multipart . more . data )
end ) A tabela multipart inclui todas as partes da mensagem multipart (para que possa ser iterada usando ipairs ), mas também permite o acesso usando nomes de parâmetros ( params.multipart.more ). Cada um dos elementos também é uma tabela que inclui os seguintes campos:
nil se não.nil se não. Esse processamento multipart consome quaisquer subtipos multipartidários e lida com mensagens multipartrárias recursivas. Ele também insere uma peça com o valor Content-ID que corresponde ao parâmetro start na primeira posição.
Apesar de todos os exemplos anteriores mostrarem uma única rota, raramente é o caso em aplicações reais; Quando várias rotas estão presentes, elas são sempre avaliadas na ordem em que são registradas .
Uma chamada setRoute também pode definir várias rotas quando elas têm o mesmo conjunto de condições e compartilhar o mesmo manipulador de ação:
fm . setRoute ({ " /route1 " , " /route2 " }, handler )Isso é equivalente a duas chamadas, definindo cada rota individualmente:
fm . setRoute ( " /route1 " , handler )
fm . setRoute ( " /route2 " , handler )Dado que as rotas são avaliadas na ordem em que estão definidas, rotas mais seletivas precisam ser definidas primeiro, caso contrário elas podem não ter a chance de serem avaliadas:
fm . setRoute ( " /user/bob " , handlerBob )
fm . setRoute ( " /user/:name " , handlerName ) Se as rotas estiverem definidas na ordem oposta, /user/bob nunca poderá ser verificado enquanto o manipulador de ação "/user/:name" retornará algum resultado não false .
Conforme descrito anteriormente, se nenhuma das rotas corresponde, uma resposta com um código de status 404 será retornada. Pode haver casos em que isso não seja desejável; Por exemplo, quando o aplicativo inclui scripts Lua para lidar com solicitações que não são explicitamente registradas como rotas. Nesses casos, pode-se acrescentar uma rota de captura-total que implementa o processamento RedBean padrão (o nome do parâmetro splat é usado apenas para desambiguar essa rota contra /* rotas que podem ser usadas em outros lugares):
fm . setRoute ( " /*catchall " , fm . servePath ) Cada rota pode ser fornecida com um nome opcional, que é útil para referenciar essa rota quando o URL precisa ser gerado com base em valores específicos de parâmetros. A função makePath , desde que aceite um nome de rota ou um URL de rota, bem como a tabela de parâmetros e retorna um caminho com os espaços espanholas de parâmetros povoados:
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 oneSe duas rotas usarem o mesmo nome, o nome estará associado ao último registrado, mas as duas rotas ainda estão presentes.
O nome da rota também pode ser usado com rotas externas/estáticas que são usadas apenas para geração de URL.
Se a rota for usada apenas para geração de caminhos, nem precisará ter um manipulador de rota:
fm . setRoute ({ " https://youtu.be/:videoid " , routeName = " youtube " })
fm . makePath ( " youtube " , { videoid = " abc " }) -- > https://youtu.be/abcUma rota sem qualquer manipulador de ação é ignorada durante o processo de correspondência de rota.
As rotas internas permitem o redirecionamento de um conjunto de URLs para um diferente. O URL de destino pode apontar para um recurso estático ou um script .lua . Por exemplo, se os pedidos de um local precisarem ser redirecionados para outro, a seguinte configuração redirecionar solicitações de quaisquer recursos sob /blog/ url para aqueles que estão sob /new-blog/ URL desde que exista o recurso de destino:
fm . setRoute ( " /blog/* " , " /new-blog/* " ) Esta rota aceita uma solicitação para /blog/post1 e serve /new-blog/post1 como sua resposta, desde que exista um ativo /new-blog/post1 . Se o ativo não existir, a próxima rota será verificada. Da mesma forma, o uso de fm.setRoute("/static/*", "/*") faz com que solicitações para /static/help.txt sejam servidas recursos /help.txt .
Ambos os URLs podem incluir parâmetros que são preenchidos se resolvidos:
fm . setRoute ( " /blog/:file " , " /new-blog/:file.html " ) -- <<-- serve "nice" URLs
fm . setRoute ( " /new-blog/:file.html " , fm . serveAsset ) -- <<-- serve original URLs Este exemplo resolve URLs "NICE" que servem suas versões "HTML". Observe que isso não aciona o redirecionamento do lado do cliente retornando o código de status 3xx , mas lida com a redação internamente. Observe também que a segunda regra é necessária para servir os URLs "originais", pois não são tratados pela primeira regra, porque se a solicitação for para /blog/mylink.html , o URL redirecionado é /new-blog/mylink.html.html , que provavelmente não existe, então a rota é ignorada e a próxima é verificada. Se o manuseio dos separadores de caminho também for necessário, *path pode ser usado em vez de :file , como * permite separadores de caminho.
Se um aplicativo precisar executar diferentes funções, dependendo de valores específicos dos atributos de solicitação (por exemplo, um método), esta biblioteca fornece duas opções principais: (1) Verifique o valor do atributo um manipulador de ação (por exemplo, usando request.method == "GET" ) e (2) Adicione uma condição que filtra solicitações de modo que apenas solicite o uso do valor do atributo especificado, alcance o manipulador de ação. Esta seção descreve a segunda opção com mais detalhes.
Cada rota registrada por padrão responde a todos os métodos HTTP (Get, Put, Post etc.), mas é possível configurar cada rota para responder apenas a métodos HTTP específicos:
fm . setRoute ( fm . GET " /hello(/:name) " ,
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) Nesse caso, a sintaxe fm.GET"/hello(/:name)" configura a rota para aceitar apenas solicitações GET . Esta sintaxe é equivalente a passar uma tabela com a rota e quaisquer condições adicionais de filtragem:
fm . setRoute ({ " /hello(/:name) " , method = " GET " },
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end )Se mais de um método precisar ser especificado, uma tabela com uma lista de métodos poderá ser passada em vez de um valor de string:
fm . setRoute ({ " /hello(/:name) " , method = { " GET " , " POST " }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) Cada rota que permite uma solicitação GET também (implicitamente) permite uma solicitação HEAD e essa solicitação é tratada retornando todos os cabeçalhos sem enviar o próprio corpo. Se, por algum motivo, esse manuseio implícito não for desejável, adicionar HEAD = false à tabela de métodos o desativa (como no method = {"GET", "POST", HEAD = false} ).
Observe que as solicitações com métodos de não correspondência não são rejeitadas, mas que caem para serem verificadas por outras rotas e acionar o código de status 404 retornado se não forem correspondentes (com uma exceção).
Além do method , outras condições podem ser aplicadas usando host , clientAddr , serverAddr , scheme , cabeçalhos de solicitação e parâmetros. Por exemplo, especificar name = "Bob" como uma das condições garante que o valor do parâmetro name seja "bob" para que o manipulador de ação seja chamado.
Qualquer cabeçalho de solicitação pode ser verificado usando o nome do cabeçalho como a chave; portanto, ContentType = "multipart/form-data" estiver satisfeito se o valor do cabeçalho Content-Type for multipart/form-data . Observe que o valor do cabeçalho pode incluir outros elementos (um limite ou um charset como parte do valor Content-Type ) e apenas o tipo de mídia real é comparado.
Como os nomes para cabeçalhos, parâmetros e propriedades podem se sobrepor, eles são verificados na seguinte ordem:
ContentType ,method , port , host , etc.) e O cabeçalho Host também é verificado primeiro (apesar de ser uma única palavra), portanto, referenciar filtros Host com base no Host de cabeçalho, enquanto faz referência a filtros host com base no host da propriedade.
Os valores da string não são os únicos valores que podem ser usados em rotas condicionais. Se mais de um valor for aceitável, a transmissão de uma tabela permitirá fornecer uma lista de valores aceitáveis. Por exemplo, se Bob e Alice são valores aceitáveis, então name = {Bob = true, Alice = true} expressa isso como uma condição.
Dois valores especiais passados em uma tabela permitem aplicar um regex ou uma validação de padrão :
regex : aceita uma string que tenha uma expressão regular. Por exemplo, name = {regex = "^(Bob|Alice)$"} tem o mesmo resultado que a verificação de hash mostrada anteriormente nesta seçãopattern : aceita uma string com uma expressão de padrão Lua. Por exemplo, name = {pattern = "^%u%l+$"} aceita valores que começam com um caractere de maiúsculas seguidas por um ou mais caracteres minúsculos. Essas duas verificações podem ser combinadas com a verificação da existência da tabela: name = {Bob = true, regex = "^Alice$"} aceita valores Bob e Alice . Se a primeira verificação de existência de tabela falhar, os resultados da expressão regex ou pattern serão retornados.
O último tipo de validador personalizado é uma função. A função fornecida recebe o valor para validar e seu resultado é avaliado como false ou true . Por exemplo, a passagem de id = tonumber garante que o valor id seja um número. Como outro exemplo, clientAddr = fm.isLoopbackIp garante que o endereço do cliente seja um endereço IP de loopback.
fm . setRoute ({ " /local-only " , clientAddr = fm . isLoopbackIp },
function ( r ) return " Local content " end )Como a função do validador pode ser gerada dinamicamente, isso também funciona:
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 )É importante ter em mente que a função do validador realmente retorna uma função que é chamada durante uma solicitação para aplicar o cheque. No exemplo anterior, a função retornada aceita um valor de cabeçalho e o compara com o limite passado durante sua criação.
Em alguns casos, não satisfazer uma condição é um motivo suficiente para retornar alguma resposta ao cliente sem verificar outras rotas. Em um caso como esse, definir o valor otherwise para um número ou uma função retorna uma resposta com o status especificado ou o resultado da função:
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 ) Neste exemplo, o mecanismo de roteamento corresponde à rota e, em seguida, valida as duas condições comparando o valor do método com POST e o valor do cabeçalho Content-Length com o resultado da função isLessThan . Se uma das condições não corresponder, o código de status especificado pelo valor otherwise será retornado com o restante da resposta.
Se a condição otherwise precisar se aplicar apenas à verificação ContentLength , o valor otherwise junto com a função Validador poderá ser movido para uma tabela associada à verificação ContentLength :
fm . setRoute ( fm . POST { " /upload " ,
ContentLength = { isLessThan ( 100000 ), otherwise = 413 }
}, function ( r ) ... handle the upload ... end ) A diferença entre os dois últimos exemplos é que, neste exemplo, apenas a falha de verificação ContentLength desencadeia a resposta 413 (e todos os outros métodos caem em outras rotas), enquanto no method anterior e falhas de verificação ContentLength acionam a mesma resposta 413.
Observe que quando o valor verificado é nil , o cheque contra uma tabela é considerado válido e a rota é aceita. Por exemplo, uma verificação de um parâmetro opcional feito contra uma string ( name = {Bo=true, Mo=true} name = "Bo" ) falha se o valor de params.name nil name = {Bo=true, Mo=true} ), incluindo verificações de regex/padrões. Se isso não for desejável, uma função de validador personalizada pode verificar explicitamente o valor esperado.
Considere o seguinte exemplo:
fm . setRoute ({ " /hello(/:name) " ,
method = { " GET " , " POST " , otherwise = 405 }},
function ( r ) return " Hello, " .. ( r . params . name or " World! " ) end ) Nesse caso, se esse endpoint for acessado com o método PUT , em vez de verificar outras rotas (como a condição method não é atendida), o código de status 405 será retornado, conforme configurado com o valor especificado otherwise . Conforme documentado em outro lugar, essa rota também aceita uma solicitação HEAD (mesmo quando não listada), pois uma solicitação GET é aceita.
Quando o código de status 405 (Método Bad) é retornado e o cabeçalho Allow não é definido, ele é definido para a lista de métodos permitidos pela rota. No caso acima, ele está definido para GET, POST, HEAD, OPTIONS , pois esses são os métodos permitidos por essa configuração. Se o valor otherwise for uma função (em vez de um número), retornar um resultado adequado e definir o cabeçalho Allow é de responsabilidade dessa função.
O valor otherwise também pode ser definido como uma função, que fornece mais flexibilidade do que apenas definir um código de status. Por exemplo, definir otherwise = fm.serveResponse(413, "Payload Too Large") aciona uma resposta com o código e a mensagem de status especificados.
O manuseio da validação do formulário geralmente requer especificar um conjunto de condições para o mesmo parâmetro e uma mensagem de erro personalizada que pode precisar ser retornada quando as condições não forem satisfeitas e estas são fornecidas por validadores especiais devolvidos pela função 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 )Neste exemplo, o validador está configurado para verificar dois parâmetros - "nome" e "senha" - para seus comprimentos Min e máximo e retornar uma mensagem quando um dos parâmetros falhar na verificação.
Como a verificação falhada faz com que a rota seja ignorada, desde otherwise o valor permita que o erro seja retornado como parte da resposta:
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 ,
} Nesse otherwise , o manipulador recebe a mensagem de erro (ou uma tabela com mensagens, se solicitada, passando a opção all coberta abaixo) que pode ser fornecida como um parâmetro de modelo e retornado ao cliente.
Outra opção é chamar a função do validador diretamente em um manipulador de ação e retornar seus resultados:
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 ) Neste exemplo, o validador é chamado diretamente e é passado uma tabela ( r.params ) com todos os valores de parâmetros para permitir que a função do validador verifique os valores em relação às regras especificadas.
A função do validador retorna true para sinalizar sucesso ou nil, error para sinalizar uma falha em verificar uma das regras. Isso permite que a chamada do validador seja embrulhada em uma assert se o script precisar retornar um erro imediatamente:
assert ( validator ( r . params )) -- throw an error if validation fails
return fm . serveRedirect ( 307 , " / " ) -- return redirect in other casesOs seguintes verificações de validador estão disponíveis:
minlen : (número inteiro) verifica o comprimento mínimo de uma string.maxlen : (número inteiro) verifica o comprimento máximo de uma string.test : (função) chama uma função que é passada um parâmetro e deve retornar true ou nil | false [, error] .oneof : ( value | { table of values to be compared against } ) verifica se o parâmetro corresponde a um dos valores fornecidos.pattern : (String) Verifica se o parâmetro corresponde a uma expressão de padrão Lua.Além dos cheques, as regras podem incluir opções:
optional : (BOOL) Torna um parâmetro opcional quando é nil . Todos os parâmetros são necessários por padrão, portanto, essa opção permite que as regras sejam ignoradas quando o parâmetro não for fornecido. Todas as regras ainda são aplicadas se o parâmetro não for nulo.msg : (string) adiciona uma mensagem do cliente para isso se uma de suas verificações falhar, que substitui as mensagens de verificações individuais. A mensagem pode incluir um espaço reservado ( %s ), que será substituído por um nome de parâmetro.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. Por exemplo,
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.
