Module Apache mod_lua

Configuration de base

La directive de base pour le chargement du module est

    LoadModule lua_module modules/mod_lua.so

mod_lua fournit un gestionnaire nomm� lua-script qui peut �tre utilis� avec une directive AddHandler :

AddHandler lua-script .lua

Ceci aura pour effet de faire traiter les requ�tes pour les fichiers dont l'extension est .lua par mod_lua en invoquant cette fonction de gestion de fichier.

Pour plus de d�tails, voir la directive LuaMapHandler.

Ecrire des gestionnaires

Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de point d'accroche (hook) sp�cifique responsable de la g�n�ration de la r�ponse. mod_proxy, mod_cgi et mod_status sont des exemples de modules comportant un gestionnaire.

mod_lua cherche toujours � invoquer une fonction Lua pour le gestionnaire, plut�t que de simplement �valuer le corps d'un script dans le style de CGI. Une fonction de gestionnaire se pr�sente comme suit :

example.lua

-- exemple de gestionnaire

require "string"

--[[
     Il s'agit du nom de m�thode par d�faut pour les gestionnaires Lua ;
     voir les noms de fonctions optionnels dans la directive
     LuaMapHandler pour choisir un point d'entr�e diff�rent.
--]]
function handle(r)
    r.content_type = "text/plain"

    if r.method == 'GET' then
    	r:puts("Hello Lua World!\n")
        for k, v in pairs( r:parseargs() ) do
            r:puts( string.format("%s: %s\n", k, v) )
        end
    elseif r.method == 'POST' then
    	r:puts("Hello Lua World!\n")
        for k, v in pairs( r:parsebody() ) do
            r:puts( string.format("%s: %s\n", k, v) )
        end
    else
    elseif r.method == 'PUT' then
-- message d'erreur personnalis�
        r:puts("Unsupported HTTP method " .. r.method)
	r.status = 405
        return apache2.ok
    else
-- message d'erreur ErrorDocument
        return 501
    end
    return apache2.OK
end

Ce gestionnaire se contente d'afficher les arguments cod�s d'un uri ou d'un formulaire dans un page au format texte.

Cela signifie que vous pouvez (et �tes encourag� �) avoir plusieurs gestionnaires (ou points d'entr�e, ou filtres) dans le m�me script.

Ecriture de fournisseurs d'autorisation

mod_authz_core fournit une interface d'autorisation de haut niveau bien plus facile � utiliser que dans les hooks correspondants. Le premier argument de la directive Require permet de sp�cifier le fournisseur d'autorisation � utiliser. Pour chaque directive Require, mod_authz_core appellera le fournisseur d'autorisation sp�cifi�, le reste de la ligne constituant les param�tres. Le fournisseur consid�r� va alors v�rifier les autorisations et fournir le r�sultat dans une valeur de retour.

En g�n�ral, le fournisseur authz est appel� avant l'authentification. S'il doit conna�tre le nom d'utilisateur authentifi� (ou si l'utilisateur est appel� � �tre authentifi�), le fournisseur doit renvoyer apache2.AUTHZ_DENIED_NO_USER, ce qui va d�clancher le processus d'authentification et un deuxi�me appel du fournisseur authz.

La fonction du fournisseur authz ci-dessous accepte deux arguments, une adresse IP et un nom d'utilisateur. Elle autorise l'acc�s dans le cas o� la requ�te provient de l'adresse IP sp�cifi�e, ou si l'utilisateur authentifi� correspond au second argument :

authz_provider.lua


require 'apache2'

function authz_check_foo(r, ip, user)
    if r.useragent_ip == ip then
        return apache2.AUTHZ_GRANTED
    elseif r.user == nil then
        return apache2.AUTHZ_DENIED_NO_USER
    elseif r.user == user then
        return apache2.AUTHZ_GRANTED
    else
        return apache2.AUTHZ_DENIED
    end
end

La configuration suivante enregistre cette fonction en tant que fournisseur foo, et la configure por l'URL / :

LuaAuthzProvider foo authz_provider.lua authz_check_foo
<Location />
  Require foo 10.1.2.3 john_doe
</Location>

Ecriture de fonctions d'accroche (hooks)

Les fonctions d'accroche d�terminent la mani�re dont les modules (et les scripts Lua) participent au traitement des requ�tes. Chaque type d'accroche propos� par le serveur a un r�le sp�cifique, comme l'association de requ�tes au syst�me de fichiers, le contr�le d'acc�s, ou la d�finition de types MIME :

Les fonctions d'accroche re�oivent l'objet de la requ�te comme seul argument (sauf LuaAuthzProvider qui re�oit aussi des arguments en provenance de la directive Require). Elles peuvent renvoyer une valeur, selon la fonction, mais il s'agit en g�n�ral d'un code d'�tat HTTP ou des valeurs OK, DONE, ou DECLINED, que vous pouvez �crire dans Lua sous la forme apache2.OK, apache2.DONE, ou apache2.DECLINED.

translate_name.lua

-- exemple d'accroche qui r��crit un URI en chemin du syst�me de
fichiers.

require 'apache2'

function translate_name(r)
    if r.uri == "/translate-name" then
        r.filename = r.document_root .. "/find_me.txt"
        return apache2.OK
    end
    -- on ne g�re pas cette URL et on donne sa chance � un autre module
    return apache2.DECLINED
end

translate_name2.lua

--[[ exemple d'accroche qui r��crit un URI vers un autre URI. Il renvoie
	un apache2.DECLINED pour permettre � un autre interpr�teur d'URL de
	travailler sur la substitution, y compris l'accroche translate_name
	de base dont les tables de correspondances se basent sur DocumentRoot.

     Note: utilisez le drapeau early/late de la directive pour
     l'ex�cuter avant ou apr�s mod_alias.
--]]

require 'apache2'

function translate_name(r)
    if r.uri == "/translate-name" then
        r.uri = "/find_me.txt"
        return apache2.DECLINED
    end
    return apache2.DECLINED
end

Structures de donn�es

request_rec

request_rec est consid�r�e en tant que donn�e utilisateur. Elle poss�de une m�tatable qui vous permet d'accomplir des choses int�ressantes. Pour la plus grande partie, elle poss�de les m�mes champs que la structure request_rec, la plupart d'entre eux �tant accessibles en lecture et �criture (le contenu des champs de la table peut �tre modifi�, mais les champs eux-m�mes ne peuvent pas �tre �tablis en tant que tables distinctes).

Nom	Type Lua	Modifiable	Description
allowoverrides	string	non	L'option AllowOverride s'applique � la requ�te courante.
ap_auth_type	string	non	Ce champ contient le type d'authentification effectu�e (par exemple basic)
args	string	oui	La cha�ne de param�tres de la requ�te (par exemple foo=bar&name=johnsmith)
assbackwards	boolean	non	contient true s'il s'agit d'une requ�te de style HTTP/0.9 (par exemple GET /foo (sans champs d'en-t�te) )
auth_name	string	non	La cha�ne d'identification utilis�e pour la v�rification de l'autorisation d'acc�s (si elle est disponible).
banner	string	non	La banni�re du serveur, par exemple Apache HTTP Server/2.4.3 openssl/0.9.8c
basic_auth_pw	string	non	Le mot de passe pour l'authentification de base envoy� avec la requ�te, s'il existe
canonical_filename	string	non	Le nom de fichier canonique de la requ�te
content_encoding	string	non	Le type de codage du contenu de la requ�te courante
content_type	string	oui	Le type de contenu de la requ�te courante, tel qu'il a �t� d�termin� au cours de la phase type_check (par exemple image/gif ou text/html)
context_prefix	string	non
context_document_root	string	non
document_root	string	non	La racine des documents du serveur
err_headers_out	table	non	L'en-t�te MIME de l'environnement pour la r�ponse, �crit m�me en cas d'erreur et conserv� pendant les redirections internes
filename	string	oui	Le nom de fichier correspondant � la requ�te, par exemple /www/example.com/foo.txt. Il peut �tre modifi� au cours des phases translate-name ou map-to-storage du traitement de la requ�te pour permettre au gestionnaire par d�faut (ou aux gestionnaires de script) de servir une version du fichier autre que celle demand�e.
handler	string	oui	Le nom du gestionnaire qui doit traiter la requ�te, par exemple lua-script si elle doit �tre trait�e par mod_lua. Cette valeur est en g�n�ral d�finie via les directives AddHandler ou SetHandler, mais peut aussi l'�tre via mod_lua pour permettre � un autre gestionnaire de traiter une requ�te sp�cifique qui ne serait pas trait�e par d�faut par ce dernier.
headers_in	table	oui	Les en-t�tes MIME de l'environnement de la requ�te. Il s'agit des en-t�tes comme Host, User-Agent, Referer, etc...
headers_out	table	oui	Les en-t�tes MIME de l'environnement de la r�ponse.
hostname	string	non	Le nom d'h�te, tel que d�fini par l'en-t�te Host: ou par un URI complet.
is_https	boolean	non	Indique si la requ�te � �t� faite via HTTPS
is_initial_req	boolean	non	Indique si la requ�te courante est la requ�te initiale ou une sous-requ�te.
limit_req_body	number	non	La taille maximale du corps de la requ�te, ou 0 si aucune limite.
log_id	string	non	L'identifiant de la requ�te dans les journaux d'acc�s ou d'erreur.
method	string	non	La m�thode de la requ�te, par exemple GET ou POST.
notes	table	oui	Une liste de notes qui peuvent �tre transmises d'un module � l'autre.
options	string	non	La valeur de la directive Options pour la requ�te courante.
path_info	string	non	La valeur de PATH_INFO extraite de la requ�te.
port	number	non	Le port du serveur utilis� par la requ�te.
protocol	string	non	Le protocole utilis�, par exemple HTTP/1.1
proxyreq	string	oui	Indique s'il s'agit d'une requ�te mandat�e ou non. Cette valeur est en g�n�ral d�finie au cours de la phase post_read_request/translate_name du traitement de la requ�te.
range	string	non	Le contenu de l'en-t�te Range:.
remaining	number	non	Le nombre d'octets du corps de la requ�te restant � lire.
server_built	string	non	La date de compilation du serveur.
server_name	string	non	Le nom du serveur pour cette requ�te.
some_auth_required	boolean	non	Indique si une autorisation est/�tait requise pour cette requ�te.
subprocess_env	table	oui	Le jeu de variables d'environnement pour cette requ�te.
started	number	non	Le moment o� le serveur a �t� (re)d�marr�, en secondes depuis epoch (1er janvier 1970)
status	number	oui	Le code de retour (courant) pour cette requ�te, par exemple 200 ou 404.
the_request	string	non	La cha�ne de la requ�te telle qu'elle a �t� envoy�e par le client, par exemple GET /foo/bar HTTP/1.1.
unparsed_uri	string	non	La partie URI non interpr�t�e de la requ�te
uri	string	oui	L'URI apr�s interpr�tation par httpd
user	string	oui	Si une authentification a �t� effectu�e, nom de l'utilisateur authentifi�.
useragent_ip	string	non	L'adresse IP de l'agent qui a envoy� la requ�te

M�thodes de l'objet request_rec

L'objet request_rec poss�de (au minimum) les m�thodes suivantes :

r:flush()   -- vide le tampon de sortie
            -- Renvoie true si le vidage a �t� effectu� avec succ�s,
	    false dans le cas contraire.

while nous_avons_des_donn�es_�_envoyer do
    r:puts("Bla bla bla\n") -- envoi des donn�es � envoyer vers le tampon
    r:flush() -- vidage du tampon (envoi au client)
    r.usleep(500000) -- mise en attente pendant 0.5 secondes et bouclage
end

r:addoutputfilter(name|function) -- ajoute un filtre en sortie

r:addoutputfilter("fooFilter") -- ins�re le filtre fooFilter dans le flux de sortie

r:sendfile(filename) -- envoie un fichier entier au client en
utilisant sendfile s'il est support� par la plateforme :

if use_sendfile_thing then
    r:sendfile("/var/www/large_file.img")
end

r:parseargs() -- renvoie deux tables : une table standard de couples
cl�/valeur pour les donn�es GET simples, et une autre pour les donn�es
multivalu�es (par exemple foo=1&foo=2&foo=3) :

local GET, GETMULTI = r:parseargs()
r:puts("Votre nom est : " .. GET['name'] or "Unknown")

r:parsebody()([sizeLimit]) -- interpr�te le corps de la requ�te
en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
peut �tre fourni pour sp�cifier le nombre maximal d'octets �
interpr�ter. La valeur par d�faut est 8192.

local POST, POSTMULTI = r:parsebody(1024*1024)
r:puts("Votre nom est : " .. POST['name'] or "Unknown")

r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la r�ponse

r:write("une simple cha�ne") -- affichage dans le
corps de la r�ponse

r:escape_html("<html>test</html>") -- Echappe le
code HTML et renvoie le r�sultat

r:base64_encode(string) -- Encode une cha�ne � l'aide du
standard de codage Base64.

local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=

r:base64_decode(string) -- D�code une cha�ne cod�e en Base64.

local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'

r:md5(string) -- Calcule et renvoie le condens� MD5 d'une cha�ne
en mode binaire (binary safe).

local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339

r:sha1(string) -- Calcule et renvoie le condens� SHA1 d'une cha�ne
en mode binaire (binary safe).

local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19

r:escape(string) -- Echappe une cha�ne de type URL.

local url = "http://foo.bar/1 2 3 & 4 + 5"
local escaped = r:escape(url) -- renvoie 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'

r:unescape(string) -- D�s�chappe une cha�ne de type URL.

local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
local unescaped = r:unescape(url) -- renvoie 'http://foo.bar/1 2 3 & 4 + 5'

r:construct_url(string) -- Construit une URL � partir d'un URI

local url = r:construct_url(r.uri)

r.mpm_query(number) -- Interroge le serveur � propos de son
module MPM via la requ�te ap_mpm_query.

local mpm = r.mpm_query(14)
if mpm == 1 then
    r:puts("Ce serveur utilise le MPM Event")
end

r:expr(string) -- Evalue une cha�ne de type expr.

if r:expr("%{HTTP_HOST} =~ /^www/") then
    r:puts("Ce nom d'h�te commence par www")
end

r:scoreboard_process(a) -- Interroge le serveur � propos du
processus � la position a.

local process = r:scoreboard_process(1)
r:puts("Le serveur 1 a comme PID " .. process.pid)

r:scoreboard_worker(a, b) -- Interroge le serveur � propos du
thread b, dans le processus a.

local thread = r:scoreboard_worker(1, 1)
r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
�tat est " .. thread.status)

r:clock() -- Renvoie l'heure courante avec une pr�cision d'une
microseconde.

r:requestbody(filename) -- Lit et renvoie le corps d'une requ�te. Si
'filename' est sp�cifi�, le corps de requ�te n'est pas renvoy�, mais
sauvegard� dans le fichier correspondant.

local input = r:requestbody()
r:puts("Vous m'avez envoy� le corps de requ�te suivant :\n")
r:puts(input)

r:add_input_filter(filter_name) -- Ajoute le filtre en entr�e
'filter_name'.

r:module_info(module_name) -- Interroge le serveur � propos d'un
module.

local mod = r.module_info("mod_lua.c")
if mod then
    for k, v in pairs(mod.commands) do
       r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives impl�ment�es par ce module
    end
end

r:loaded_modules() -- Renvoie une liste des modules charg�s par
httpd.

for k, module in pairs(r:loaded_modules()) do
    r:puts("J'ai charg� le module " .. module .. "\n")
end

r:runtime_dir_relative(filename) -- G�n�re le nom d'un fichier run-time
(par exemple la m�moire partag�e "file") relativement au r�pertoire de
run-time. 

r:server_info() -- Renvoie une table contenant des informations
� propos du serveur, comme le nom de l'ex�cutable httpd, le
module mpm utilis�, etc...

r:set_document_root(file_path) -- D�finit la racine des
documents pour la requ�te � file_path.

r:add_version_component(component_string) -- Ajoute un �l�ment �
la banni�re du serveur.

r:set_context_info(prefix, docroot) -- D�finit le pr�fixe et la
racine des documents du contexte pour une requ�te.

r:os_escape_path(file_path) -- Convertit un chemin du syst�me de
fichiers en URL ind�pendamment du syst�me d'exploitation.

r:escape_logitem(string) -- Echappe une cha�ne pour
journalisation.

r.strcmp_match(string, pattern) -- V�rifie si 'string' correspond �
'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
'www.example.com' correspond � '*.example.com' ?

local match = r.strcmp_match("foobar.com", "foo*.com")
if match then 
    r:puts("foobar.com matches foo*.com")
end

r:set_keepalive() -- D�finit l'�tat de persistance d'une
requ�te. Renvoie true dans la mesure du possible, false dans le
cas contraire.

r:make_etag() -- G�n�re et renvoie le etag pour la requ�te
courante.

r:send_interim_response(clear) -- Renvoie une r�ponse d'int�rim (1xx) au
client. Si 'clear' est vrai, les en-t�tes disponibles seront envoy�s et
effac�s.

r:custom_response(status_code, string) -- G�n�re et d�finit une r�ponse
personnalis�e pour un code d'�tat particulier. Le fonctionnement est
tr�s proche de celui de la directive ErrorDocument.

r:custom_response(404, "Baleted!")

r.exists_config_define(string) -- V�rifie si une d�finition de
configuration existe.

if r.exists_config_define("FOO") then
    r:puts("httpd a probablement �t� lanc� avec l'option -DFOO, ou FOO a
    �t� d�fini dans la configuration")
end

r:state_query(string) -- Interroge le serveur � propos de son
�tat.

r:stat(filename [,wanted]) -- Ex�cute stat() sur un fichier, et renvoie
une table contenant des informations � propos de ce fichier.

local info = r:stat("/var/www/foo.txt")
if info then
    r:puts("Ce fichier existe et a �t� modifi� pour la derni�re fois � : " .. info.modified)
end

r:regex(string, pattern [,flags]) -- Ex�cute une recherche � base
d'expression rationnelle sur une cha�ne, et renvoie les
�ventuelles correspondances trouv�es.

local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
if matches then
    r:puts("L'expression rationnelle correspond et le dernier mot
    captur� ($2) est : " .. matches[2])
end

-- Exemple avec insensibilit� � la casse :
local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)

-- les drapeaux peuvent �tre une combibaison bit � bit de :
-- 0x01: insensibilit� � la casse
-- 0x02: recherche multiligne

r.usleep(microsecondes) -- Interrompt l'ex�cution du script pendant le nombre de microsecondes sp�cifi�.

r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion � une
base de donn�es et renvoie une classe database. Voir 'Connectivit� aux bases de donn�es' pour plus de
d�tails.

r:ivm_set("key", value) -- D�fini une variable Inter-VM avec une valeur sp�cifique.
                        -- Ces valeurs sont conserv�es m�me si la VM est
			-- arr�t�e ou non utilis�e, et ne doivent donc �tre
			-- utilis�es que si MaxConnectionsPerChild > 0.
			-- Les valeurs peuvent �tre de type number, string
			-- ou boolean et sont stock�es s�par�ment pour
			-- chaque processus (elles ne seront donc pas d'une
			-- grande utilit� si l'on utilise le mpm prefork).
                        
r:ivm_get("key")        -- Lit le contenu d'une variable d�finie via ivm_set. Renvoie
			-- le contenu de la variable si elle existe, ou nil
			-- dans le cas contraire.
                        
-- Voici un exemple de lecture/�criture qui sauvegarde une variable
-- globale en dehors de la VM :
function handle(r)
    -- La premi�re VM qui effectue l'appel suivant n'obtiendra aucune
    -- valeur, et devra la cr�er
    local foo = r:ivm_get("cached_data")
    if not foo then
        foo = do_some_calcs() -- simulation de valeurs de retour
        r:ivm_set("cached_data", foo) -- d�finition globale de la variable
    end
    r:puts("La donn�e en cache est : ", foo)
end			

r:htpassword(string [,algorithm [,cost]]) -- G�n�re un hash de mot de passe � partir d'une cha�ne.
                                          -- algorithm: 0 = APMD5 (d�faut), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
                                          -- cost: ne s'utilise qu'avec l'algorythme BCRYPT (d�faut = 5).

r:mkdir(dir [,mode]) -- Cr�e un r�pertoire et d�finit son mode via le param�tre optionnel mode.

r:mkrdir(dir [,mode]) -- Cr�e des r�pertoires de mani�re r�cursive et d�finit leur mode via le param�tre optionnel mode.

r:rmdir(dir) -- Supprime un r�pertoire.

r:touch(file [,mtime]) -- D�finit la date de modification d'un fichier � la date courante ou � la valeur optionnelle mtime en msec.

r:get_direntries(dir) -- Renvoie une table contenant toutes les entr�es de r�pertoires.

-- Renvoie un chemin sous forme �clat�e en chemin, fichier, extension
function handle(r)
  local dir = r.context_document_root
  for _, f in ipairs(r:get_direntries(dir)) do
    local info = r:stat(dir .. "/" .. f)
    if info then
      local mtime = os.date(fmt, info.mtime / 1000000)
      local ftype = (info.filetype == 2) and "[dir] " or "[file]"
      r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
    end
  end
end

r.date_parse_rfc(string) -- Interpr�te une cha�ne date/heure et renvoie l'�quivalent en secondes depuis epoche.

r:getcookie(key) -- Obtient un cookie HTTP

r:setcookie(key, value, secure, expires) -- D�finit un cookie HTTP, par exemple :
r:setcookie("foo", "bar and stuff", false, os.time() + 86400)

r:wsupgrade() -- Met � jour une connexion vers les WebSockets si possible (et si demand�) :
if r:wsupgrade() then -- si la mise � jour est possible :
    r:wswrite("Bienvenue dans les websockets!") -- �crit quelque chose � l'intention du client
    r:wsclose()  -- Au revoir !
end

r:wsread() -- Lit un cadre de websocket depuis une connexion vers websocket mise � jour (voir ci-dessus) :
           
local line, isFinal = r:wsread() -- isFinal indique s'il s'agit du cadre final.
                                 -- dans le cas contraire, on peut lire les cadres suivants
r:wswrite("Vous avez �crit : " .. line)

r:wswrite(line) -- �crit un cadre vers un client WebSocket :
r:wswrite("Bonjour le Monde !")

r:wsclose() -- ferme une requ�te WebSocket et l'ach�ve pour httpd :

if r:wsupgrade() then
    r:wswrite("Ecrire quelque chose : ")
    local line = r:wsread() or "nothing"
    r:wswrite("Vous avez �crit : " .. line);
    r:wswrite("Au revoir !")
    r:wsclose()
end

Fonctions de journalisation

	-- exemples de messages de journalisation
	r:trace1("Ceci est un message de journalisation de niveau
	trace") -- les niveaux valides vont de trace1 � trace8 

        r:debug("Ceci est un message de journalisation de niveau debug")

        r:info("Ceci est un message de journalisation de niveau info")

        r:notice("Ceci est un message de journalisation de niveau notice")

        r:warn("Ceci est un message de journalisation de niveau warn")

        r:err("Ceci est un message de journalisation de niveau err")

        r:alert("Ceci est un message de journalisation de niveau alert")

        r:crit("Ceci est un message de journalisation de niveau crit")

        r:emerg("Ceci est un message de journalisation de niveau emerg")

Paquet apache2

Le paquet nomm� apache2 est fourni avec (au minimum) le contenu suivant :

apache2.OK

Constante interne OK. Les gestionnaires renverront cette valeur s'ils ont trait� la requ�te.

apache2.DECLINED

Constante interne DECLINED. Les gestionnaires renverront cette valeur s'ils n'ont pas l'intention de traiter la requ�te.

apache2.DONE

Constante interne DONE.

apache2.version

Cha�ne contenant la version du serveur HTTP Apache

apache2.HTTP_MOVED_TEMPORARILY

Code d'�tat HTTP

apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE

Constantes internes utilis�es par mod_proxy

apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER

constantes internes utilis�es par mod_authz_core

Les autres codes d'�tat HTTP ne sont pas encore impl�ment�s.

Modification de contenu avec les filtres lua

Les fonctions de filtrage impl�ment�es via les directives LuaInputFilter ou LuaOutputFilter sont con�ues comme des fonctions de 3�me phase non blocantes utilisant des sous-routines pour suspendre et reprendre l'ex�cution d'une fonction lorsque des paquets de donn�es sont envoy�s � la cha�ne de filtrage. La structure de base d'une telle fonction est :

function filter(r)
    -- Nous indiquons tout d'abord que nous sommes pr�ts � recevoir des
    -- blocs de donn�es.
    -- Avant ceci, nous pouvons d�finir notre environnement, tester
    -- certaines conditions, et, si nous le jugeons n�cessaire, refuser le
    -- filtrage d'une requ�te :
    if something_bad then
        return -- Le filtrage est saut�
    end
    -- Sans se pr�occuper des donn�es que nous devons �ventuellement ajouter, un arr�t est r�alis� ici.
    -- Noter que les filtres de sortie sont les seuls capables d'ajouter des �l�ments au d�but des donn�es.
    -- Les filtres en entr�e peuvent ajouter des �l�ments � la fin des donn�es au stade final.

    coroutine.yield([optional header to be prepended to the content])

    -- Apr�s cet arr�t, nous allons recevoir d'autres blocs de donn�es, un par un ;
    -- nous pouvons les traiter comme il nous pla�t et proc�der � la r�ponse.
    -- Ces blocs sont conserv�s dans la variable globale 'bucket', nous r�alisons donc
    -- une boucle pour v�rifier que 'bucket' n'est pas vide :
    while bucket ~= nil do
        local output = mangle(bucket) -- Do some stuff to the content
        coroutine.yield(output) -- Return our new content to the filter chain
    end

    -- Une fois les blocs de donn�es �puis�s, 'bucket' est positionn� � une valeur vide ('nil'),
    -- ce qui va nous faire sortir de cette boucle et nous amener � l'�tape suivante.
    -- On peut ajouter ce qu'on veut � la fin des donn�es � cette �tape, qui constitue le dernier
    -- arr�t. Les filtres d'entr�e comme de sortie peuvent servir � ajouter des �l�ments � la fin
    --  des donn�es � cette �tape.
    coroutine.yield([optional footer to be appended to the content])
end
    

Connectivit� aux bases de donn�es

Mod_lua impl�mente une fonctionnalit� basique de connexion aux bases de donn�es permettant d'envoyer des requ�tes ou d'ex�cuter des commandes aupr�s des moteurs de base de donn�es les plus courants (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.

L'exemple suivant montre comment se connecter � une base de donn�es et extraire des informations d'une table :

function handle(r)
    -- connexion � la base de donn�es
    local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
    if not err then
        -- S�lection de certaines informations
        local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
        if not err then
            local rows = results(0) -- extrait tous les enregistrements en mode synchrone
            for k, row in pairs(rows) do
                r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
            end
        else
            r:puts("Database query error: " .. err)
        end
        database:close()
    else
        r:puts("Connexion � la base de donn�es impossible : " .. err)
    end
end
    

Pour utiliser mod_dbd, sp�cifiez mod_dbd comme type de base de donn�es, ou laissez le champ vide :

    local database = r:dbacquire("mod_dbd")
    

L'objet database et ses m�thodes

L'objet database renvoy� par dbacquire poss�de les m�thodes suivantes :

S�lection normale et requ�te vers une base de donn�es :

-- Ex�cution d'une requ�te et renvoie du nombre d'enregistrements
affect�s :
local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")

-- Ex�cution d'une requ�te et renvoie du r�sultat qui peut �tre utilis�
en mode synchrone ou asynchrone :
local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
    

Utilisation de requ�tes pr�par�es (recommand�) :

-- Cr�ation et ex�cution d'une requ�te pr�par�e :
local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
if not errmsg then
    local result, errmsg = statement:query(20) -- ex�cute la requ�te pour age > 20
end

-- Extrait une requ�te pr�par�e depuis une directive DBDPrepareSQL :
local statement, errmsg = database:prepared(r, "someTag")
if not errmsg then
    local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requ�te
end

Echappement de valeurs, fermeture de la base donn�es, etc...

-- Echappe une valeur pour pouvoir l'utiliser dans une requ�te :
local escaped = database:escape(r, [["'|blabla]])

-- Ferme une base de donn�es et lib�re les liens vers cette derni�re :
database:close()

-- V�rifie si une connexion � une base de donn�es est en service et
op�rationnelle :
local connected = database:active()
    

Travail avec les jeux d'enregistrements renvoy�s par les requ�tes

Les jeux d'enregistrements renvoy�s par db:select ou par des requ�tes pr�par�es cr��es par db:prepare permettent de s�lectionner des enregistrements en mode synchrone ou asynchrone, selon le nombre d'enregistrements sp�cifi� :
result(0) s�lectionne tous les enregistrements en mode synchrone en renvoyant une table d'enregistrements.
result(-1) s�lectionne le prochain enregistrement disponible en mode asynchrone.
result(N) s�lectionne l'enregistrement num�ro N en mode asynchrone.

-- extrait un jeu d'enregistrements via une requ�te r�guli�re :
local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")

local rows = result(0) -- s�lectionne tous les enregistrements en mode synchrone
local row = result(-1) -- s�lectionne le prochain enregistrement disponible en mode asynchrone
local row = result(1234) -- s�lectionne l'enregistrement 1234 en mode asynchrone
    

Il est possible de construire une fonction qui renvoie une fonction it�rative permettant de traiter tous les enregistrement en mode synchrone ou asynchrone selon la valeur de l'argument async :

function rows(resultset, async)
    local a = 0
    local function getnext()
        a = a + 1
        local row = resultset(-1)
        return row and a or nil, row
    end
    if not async then
        return pairs(resultset(0))
    else
        return getnext, self
    end
end

local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
if not err then
     -- s�lectionne des enregistrements en mode asynchrone :
    local result, err = statement:select(20)
    if not err then
        for index, row in rows(result, true) do
            ....
        end
    end

     -- s�lectionne des enregistrements en mode synchrone :
    local result, err = statement:select(20)
    if not err then
        for index, row in rows(result, false) do
            ....
        end
    end
end
    

Fermeture d'une connexion � une base de donn�es

Lorsqu'elles ne sont plus utilis�es, les connexions aux bases de donn�es doivent �tre ferm�es avec database:close(). Si vous ne les fermez pas manuellement, mod_lua les fermera peut-�tre en tant que r�sidus collect�s, mais si ce n'est pas le cas, vous pouvez finir pas avoir trop de connexions vers la base de donn�es inutilis�es. Les deux mesures suivantes sont pratiquement identiques :

-- M�thode 1 : fermeture manuelle de la connexion
local database = r:dbacquire("mod_dbd")
database:close() -- c'est tout

-- M�thode 2 : on laisse le collecteur de r�sidus la fermer
local database = r:dbacquire("mod_dbd")
database = nil -- on coupe le lien
collectgarbage() -- fermeture de la connexion par le collecteur de r�sidus

Pr�cautions � prendre lorsque l'on travaille avec les bases de donn�es

Bien que les fonctions query et run soient toujours disponibles, il est recommand� d'utiliser des requ�tes pr�par�es chaque fois que possible, afin d'une part d'optimiser les performances (si votre connexion reste longtemps en vie), et d'autre part minimiser le risque d'attaques par injection SQL. Les fonctions run et query ne doivent �tre utilis�es que lorsque la requ�te ne contient pas de variables (requ�te statique). Dans le cas des requ�tes dynamiques, utilisez db:prepare ou db:prepared.