7215N/A<?xml version="1.0"?>

7215N/A<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

7215N/A<?xml-stylesheet type="text/xsl" href="/style/manual.fr.xsl"?>

7215N/A

7215N/A

7215N/A<modulesynopsis metafile="mod_lua.xml.meta">

7215N/A

7215N/A<name>mod_lua</name>

7215N/A

7215N/A<description>Fournit des points d'entr&eacute;e Lua dans diff&eacute;rentes parties du

7215N/Atraitement des requ&ecirc;tes httpd</description>

7215N/A<status>Experimental</status>

7215N/A<sourcefile>mod_lua.c</sourcefile>

7215N/A<identifier>lua_module</identifier>

7215N/A<compatibility>versions 2.3 et sup&eacute;rieures</compatibility>

7215N/A

7215N/A<summary>

7215N/A<p>Ce module permet d'ajouter au serveur des extensions sous forme de

7215N/Ascripts &eacute;crits dans le langage de programmation Lua.

7215N/A<module>mod_lua</module> fournit de nombreuses extensions

7215N/A(hooks) disponibles avec les modules natifs du serveur HTTP Apache,

7215N/Acomme les associations de requ&ecirc;tes &agrave; des fichiers, la g&eacute;n&eacute;ration de

7215N/Ar&eacute;ponses dynamiques, le contr&ocirc;le d'acc&egrave;s, l'authentification et

7215N/Al'autorisation.</p>

7215N/A

7215N/A<p>Vous trouverez davantage d'informations &agrave; propos du langage de

7215N/Aprogrammation Lua sur <a href="http://www.lua.org/">le site web de

7215N/ALua</a>.</p>

7215N/A

7215N/A<note><code>mod_lua</code> est encore au stade exp&eacute;rimental. Son mode

7215N/Ad'utilisation et son comportement pourront changer &agrave; tout moment jusqu'&agrave;

7215N/Ace qu'il passe au stade stable, et ce m&ecirc;me entre deux versions stables

7215N/A2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise &agrave;

7215N/Ajour.</note>

7215N/A

7215N/A<note type="warning"><title>Avertissement</title>

7215N/A<p>Ce module poss&egrave;de une grande capacit&eacute; d'action sur le fonctrionnement

7215N/Ade httpd, ce qui lui conf&egrave;re une grande puissance, mais peut aussi

7215N/Ainduire un risque de s&eacute;curit&eacute;. Il est d&eacute;conseill&eacute; d'utiliser ce module

7215N/Asur un serveur partag&eacute; avec des utilisateurs auxquels vous ne pouvez pas

7215N/Aaccorder une confiance absolue, car il peut permettre de modifier le

7215N/Afonctionnement interne de httpd.</p>

7215N/A</note>

7215N/A

7215N/A</summary>

7215N/A

7215N/A<section id="basicconf"><title>Configuration de base</title>

7215N/A

7215N/A<p>La directive de base pour le chargement du module est</p>

7215N/A

7215N/A<highlight language="config">

7215N/A LoadModule lua_module modules/mod_lua.so

</highlight>

<p>

<code>mod_lua</code> fournit un gestionnaire nomm&eacute;

<code>lua-script</code> qui peut &ecirc;tre utilis&eacute; avec une directive

<code>AddHandler</code> :</p>

<highlight language="config">

AddHandler lua-script .lua

</highlight>

<p>

Ceci aura pour effet de faire traiter les requ&ecirc;tes pour les fichiers

dont l'extension est <code>.lua</code> par <code>mod_lua</code> en

invoquant cette fonction de <code>gestion</code> de fichier.

</p>

<p>Pour plus de d&eacute;tails, voir la directive

<directive>LuaMapHandler</directive>.

</p>

</section>

<section id="writinghandlers"><title>Ecrire des gestionnaires</title>

<p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de

point d'accroche (hook) sp&eacute;cifique responsable de la g&eacute;n&eacute;ration de la

r&eacute;ponse. <module>mod_proxy</module>, <module>mod_cgi</module> et

<module>mod_status</module> sont des exemples de modules comportant un

gestionnaire.</p>

<p><code>mod_lua</code> cherche toujours &agrave; invoquer une fonction Lua pour le

gestionnaire, plut&ocirc;t que de simplement &eacute;valuer le corps d'un script dans

le style de CGI. Une fonction de gestionnaire se pr&eacute;sente comme suit :</p>

<highlight language="lua">

<strong>example.lua</strong><br/>

-- exemple de gestionnaire

require "string"

--[[

Il s'agit du nom de m&eacute;thode par d&eacute;faut pour les gestionnaires Lua ;

voir les noms de fonctions optionnels dans la directive

LuaMapHandler pour choisir un point d'entr&eacute;e diff&eacute;rent.

--]]

function handle(r)

r.content_type = "text/plain"

r:puts("Hello Lua World!\n")

if r.method == 'GET' then

for k, v in pairs( r:parseargs() ) do

r:puts( string.format("%s: %s\n", k, v) )

end

elseif r.method == 'POST' then

for k, v in pairs( r:parsebody() ) do

r:puts( string.format("%s: %s\n", k, v) )

end

else

r:puts("Unsupported HTTP method " .. r.method)

end

end

</highlight>

<p>

Ce gestionnaire se contente d'afficher les arguments cod&eacute;s d'un uri ou

d'un formulaire dans un page au format texte.

</p>

<p>

Cela signifie que vous pouvez (et &ecirc;tes encourag&eacute; &agrave;) avoir plusieurs

gestionnaires (ou points d'entr&eacute;e, ou filtres) dans le m&ecirc;me script.

</p>

</section>

<section id="writingauthzproviders">

<title>Ecriture de fournisseurs d'autorisation</title>

<p><module>mod_authz_core</module> fournit une interface d'autorisation

de haut niveau bien plus facile &agrave; utiliser que dans les hooks

correspondants. Le premier argument de la directive <directive

module="mod_authz_core">Require</directive> permet de sp&eacute;cifier le

fournisseur d'autorisation &agrave; utiliser. Pour chaque directive <directive

module="mod_authz_core">Require</directive>,

<module>mod_authz_core</module> appellera le fournisseur d'autorisation

sp&eacute;cifi&eacute;, le reste de la ligne constituant les param&egrave;tres. Le

fournisseur consid&eacute;r&eacute; va alors v&eacute;rifier les autorisations et fournir le

r&eacute;sultat dans une valeur de retour.</p>

<p>En g&eacute;n&eacute;ral, le fournisseur authz est appel&eacute; avant l'authentification.

S'il doit conna&icirc;tre le nom d'utilisateur authentifi&eacute; (ou si

l'utilisateur est appel&eacute; &agrave; &ecirc;tre authentifi&eacute;), le fournisseur doit

renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va

d&eacute;clancher le processus d'authentification et un deuxi&egrave;me appel du

fournisseur authz.</p>

<p>La fonction du fournisseur authz ci-dessous accepte deux arguments,

une adresse IP et un nom d'utilisateur. Elle autorise l'acc&egrave;s dans le

cas o&ugrave; la requ&ecirc;te provient de l'adresse IP sp&eacute;cifi&eacute;e, ou si

l'utilisateur authentifi&eacute; correspond au second argument :</p>

<highlight language="lua">

<strong>authz_provider.lua</strong><br/>

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

</highlight>

<p>La configuration suivante enregistre cette fonction en tant que

fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>

<highlight language="config">

LuaAuthzProvider foo authz_provider.lua authz_check_foo

&lt;Location /&gt;

Require foo 10.1.2.3 john_doe

&lt;/Location&gt;

</highlight>

</section>

<section id="writinghooks"><title>Ecriture de fonctions d'accroche

(hooks)</title>

<p>Les fonctions d'accroche d&eacute;terminent la mani&egrave;re dont les modules (et

les scripts Lua) participent au traitement des requ&ecirc;tes. Chaque type

d'accroche propos&eacute; par le serveur a un r&ocirc;le sp&eacute;cifique, comme

l'association de requ&ecirc;tes au syst&egrave;me de fichiers, le contr&ocirc;le d'acc&egrave;s,

ou la d&eacute;finition de types MIME : </p>

<table border="1" style="zebra">

<tr>

<th>Phase d'accroche</th>

<th>Directive mod_lua</th>

<th>Description</th>

</tr>

<tr>

<td>Gestionnaire rapide</td>

<td><directive module="mod_lua">LuaQuickHandler</directive></td>

<td>Il s'agit de la premi&egrave;re accroche appel&eacute;e lorsqu'une requ&ecirc;te

a &eacute;t&eacute; associ&eacute;e &agrave; un serveur ou un serveur virtuel.</td>

</tr>

<tr>

<td>Phase de traduction</td>

<td><directive module="mod_lua">LuaHookTranslateName</directive></td>

<td>Cette phase traduit l'URI de la requ&ecirc;te en nom de fichier

sur le syst&egrave;me. Ce sont des modules comme

<module>mod_alias</module> et <module>mod_rewrite</module> qui

interviennent au cours de cette phase.</td>

</tr>

<tr>

<td>Choix du lieu de stockage de la ressource</td>

<td><directive module="mod_lua">LuaHookMapToStorage</directive></td>

<td>Cette phase d&eacute;finit le lieu de stockage de la ressource :

physique, en cache ou externe/mandat&eacute;. Elle est assur&eacute;e par les

modules de mandat ou de mise en cache.</td>

</tr>

<tr>

<td>Autorisation d'acc&egrave;s</td>

<td><directive module="mod_lua">LuaHookAccessChecker</directive></td>

<td>Cette phase v&eacute;rifie si un client a l'autorisation d'acc&egrave;s &agrave;

la ressource. Elle s'ex&eacute;cute avant l'authentification de

l'utisateur ; il faut donc &ecirc;tre prudent.

</td>

</tr>

<tr>

<td>V&eacute;rification de l'identifiant utilisateur</td>

<td><directive module="mod_lua">LuaHookCheckUserID</directive></td>

<td>Cette phase v&eacute;rifie l'identifiant de l'utilisateur ayant

fait l'objet d'une n&eacute;gociation.</td>

</tr>

<tr>

<td>V&eacute;rification de l'autorisation d'acc&egrave;s</td>

<td><directive module="mod_lua">LuaHookAuthChecker</directive>

ou

<directive module="mod_lua">LuaAuthzProvider</directive></td>

<td>Cette phase v&eacute;rifie l'autorisation d'acc&egrave;s d'un utilisateur

en fonction des ses param&egrave;tres de connexion, comme

l'identifiant, le certificat, etc...

</td>

</tr>

<tr>

<td>V&eacute;rification du type de la ressource</td>

<td><directive module="mod_lua">LuaHookTypeChecker</directive></td>

<td>Cette phase assigne un type de contenu et un gestionnaire &agrave;

la ressource.</td>

</tr>

<tr>

<td>Derniers r&eacute;glages</td>

<td><directive module="mod_lua">LuaHookFixups</directive></td>

<td>C'est la derni&egrave;re phase avant l'activation des gestionnaires

de contenu. Toute modification de derni&egrave;re minute &agrave; la requ&ecirc;te

doit &ecirc;tre effectu&eacute;e ici.</td>

</tr>

<tr>

<td>Gestionnaire de contenu</td>

<td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>

<td>C'est durant cette phase que le contenu est trait&eacute;. Les

fichiers sont lus, interpr&eacute;t&eacute;s, certains sont ex&eacute;cut&eacute;s, et le

r&eacute;sultat obtenu est envoy&eacute; au client.</td>

</tr>

<tr>

<td>Journalisation</td>

<td>aucune</td>

<td>Lorsqu'une requ&ecirc;te a &eacute;t&eacute; trait&eacute;e, plusieurs phases de

journalisation interviennent, et enregistrent leurs r&eacute;sultats

dans les fichiers d'erreur ou d'acc&egrave;s.</td>

</tr>

</table>

<p>Les fonctions d'accroche re&ccedil;oivent l'objet de la requ&ecirc;te comme seul

argument (sauf LuaAuthzProvider qui re&ccedil;oit aussi des arguments en

provenance de la directive Require). Elles peuvent renvoyer une valeur,

selon la fonction, mais il s'agit en g&eacute;n&eacute;ral d'un

code d'&eacute;tat HTTP ou des valeurs OK, DONE, ou DECLINED,

que vous pouvez &eacute;crire dans Lua sous la forme <code>apache2.OK</code>,

<code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>

<highlight language="lua">

<strong>translate_name.lua</strong><br/>

-- exemple d'accroche qui r&eacute;&eacute;crit un URI en chemin du syst&egrave;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&egrave;re pas cette URL et on donne sa chance &agrave; un autre module

return apache2.DECLINED

end

</highlight>

<highlight language="lua">

<strong>translate_name2.lua</strong><br/>

--[[ exemple d'accroche qui r&eacute;&eacute;crit un URI vers un autre URI. Il renvoie

un apache2.DECLINED pour permettre &agrave; un autre interpr&eacute;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&eacute;cuter avant ou apr&egrave;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

</highlight>

</section>

<section id="datastructures"><title>Structures de donn&eacute;es</title>

<dl>

<dt>request_rec</dt>

<dd>

<p>request_rec est consid&eacute;r&eacute;e en tant que donn&eacute;e utilisateur.

Elle poss&egrave;de une m&eacute;tatable qui vous permet d'accomplir des

choses int&eacute;ressantes. Pour la plus grande partie, elle poss&egrave;de

les m&ecirc;mes champs que la structure request_rec, la

plupart d'entre eux &eacute;tant accessibles en lecture et &eacute;criture (le

contenu des champs de la table peut &ecirc;tre modifi&eacute;, mais les

champs eux-m&ecirc;mes ne peuvent pas &ecirc;tre &eacute;tablis en tant que tables

distinctes).</p>

<table border="1" style="zebra">

<tr>

<th><strong>Nom</strong></th>

<th><strong>Type Lua</strong></th>

<th><strong>Modifiable</strong></th>

<th><strong>Description</strong></th>

</tr>

<tr>

<td><code>allowoverrides</code></td>

<td>string</td>

<td>non</td>

<td>L'option AllowOverride s'applique &agrave; la requ&ecirc;te courante.</td>

</tr>

<tr>

<td><code>ap_auth_type</code></td>

<td>string</td>

<td>non</td>

<td>Ce champ contient le type d'authentification effectu&eacute;e

(par exemple <code>basic</code>)</td>

</tr>

<tr>

<td><code>args</code></td>

<td>string</td>

<td>oui</td>

<td>La cha&icirc;ne de param&egrave;tres de la requ&ecirc;te (par exemple

<code>foo=bar&amp;name=johnsmith</code>)</td>

</tr>

<tr>

<td><code>assbackwards</code></td>

<td>boolean</td>

<td>non</td>

<td>contient true s'il s'agit d'une requ&ecirc;te de style HTTP/0.9

(par exemple <code>GET /foo</code> (sans champs d'en-t&ecirc;te) )</td>

</tr>

<tr>

<td><code>auth_name</code></td>

<td>string</td>

<td>non</td>

<td>La cha&icirc;ne d'identification utilis&eacute;e pour la v&eacute;rification

de l'autorisation d'acc&egrave;s (si elle est disponible).</td>

</tr>

<tr>

<td><code>banner</code></td>

<td>string</td>

<td>non</td>

<td>La banni&egrave;re du serveur, par exemple <code>Apache HTTP

Server/2.4.3 openssl/0.9.8c</code></td>

</tr>

<tr>

<td><code>basic_auth_pw</code></td>

<td>string</td>

<td>non</td>

<td>Le mot de passe pour l'authentification de base envoy&eacute;

avec la requ&ecirc;te, s'il existe</td>

</tr>

<tr>

<td><code>canonical_filename</code></td>

<td>string</td>

<td>non</td>

<td>Le nom de fichier canonique de la requ&ecirc;te</td>

</tr>

<tr>

<td><code>content_encoding</code></td>

<td>string</td>

<td>non</td>

<td>Le type de codage du contenu de la requ&ecirc;te courante</td>

</tr>

<tr>

<td><code>content_type</code></td>

<td>string</td>

<td>oui</td>

<td>Le type de contenu de la requ&ecirc;te courante, tel qu'il a &eacute;t&eacute;

d&eacute;termin&eacute; au cours de la phase type_check (par exemple

<code>image/gif</code> ou <code>text/html</code>)</td>

</tr>

<tr>

<td><code>context_prefix</code></td>

<td>string</td>

<td>non</td>

<td></td>

</tr>

<tr>

<td><code>context_document_root</code></td>

<td>string</td>

<td>non</td>

<td></td>

</tr>

<tr>

<td><code>document_root</code></td>

<td>string</td>

<td>non</td>

<td>La racine des documents du serveur</td>

</tr>

<tr>

<td><code>err_headers_out</code></td>

<td>table</td>

<td>non</td>

<td>L'en-t&ecirc;te MIME de l'environnement pour la r&eacute;ponse, &eacute;crit

m&ecirc;me en cas d'erreur et conserv&eacute; pendant les redirections

internes</td>

</tr>

<tr>

<td><code>filename</code></td>

<td>string</td>

<td>oui</td>

<td>Le nom de fichier correspondant &agrave; la requ&ecirc;te, par exemple

/www/example.com/foo.txt. Il peut &ecirc;tre modifi&eacute; au cours des

phases translate-name ou map-to-storage du traitement de la

requ&ecirc;te pour permettre au gestionnaire par d&eacute;faut (ou aux

gestionnaires de script) de servir une version du fichier

autre que celle demand&eacute;e.</td>

</tr>

<tr>

<td><code>handler</code></td>

<td>string</td>

<td>oui</td>

<td>Le nom du <a href="/handler.html">gestionnaire</a> qui

doit traiter la requ&ecirc;te, par exemple <code>lua-script</code>

si elle doit &ecirc;tre trait&eacute;e par mod_lua. Cette valeur est en

g&eacute;n&eacute;ral d&eacute;finie via les directives <directive

module="mod_mime">AddHandler</directive> ou <directive

module="core">SetHandler</directive>, mais peut aussi l'&ecirc;tre

via mod_lua pour permettre &agrave; un autre gestionnaire de traiter

une requ&ecirc;te sp&eacute;cifique qui ne serait pas trait&eacute;e par d&eacute;faut

par ce dernier.

</td>

</tr>

<tr>

<td><code>headers_in</code></td>

<td>table</td>

<td>oui</td>

<td>Les en-t&ecirc;tes MIME de l'environnement de la requ&ecirc;te. Il

s'agit des en-t&ecirc;tes comme <code>Host, User-Agent,

Referer</code>, etc...</td>

</tr>

<tr>

<td><code>headers_out</code></td>

<td>table</td>

<td>oui</td>

<td>Les en-t&ecirc;tes MIME de l'environnement de la r&eacute;ponse.</td>

</tr>

<tr>

<td><code>hostname</code></td>

<td>string</td>

<td>non</td>

<td>Le nom d'h&ocirc;te, tel que d&eacute;fini par l'en-t&ecirc;te

<code>Host:</code> ou par un URI complet.</td>

</tr>

<tr>

<td><code>is_https</code></td>

<td>boolean</td>

<td>non</td>

<td>Indique si la requ&ecirc;te &agrave; &eacute;t&eacute; faite via HTTPS</td>

</tr>

<tr>

<td><code>is_initial_req</code></td>

<td>boolean</td>

<td>non</td>

<td>Indique si la requ&ecirc;te courante est la requ&ecirc;te initiale ou

une sous-requ&ecirc;te.</td>

</tr>

<tr>

<td><code>limit_req_body</code></td>

<td>number</td>

<td>non</td>

<td>La taille maximale du corps de la requ&ecirc;te, ou 0 si aucune

limite.</td>

</tr>

<tr>

<td><code>log_id</code></td>

<td>string</td>

<td>non</td>

<td>L'identifiant de la requ&ecirc;te dans les journaux d'acc&egrave;s ou

d'erreur.</td>

</tr>

<tr>

<td><code>method</code></td>

<td>string</td>

<td>non</td>

<td>La m&eacute;thode de la requ&ecirc;te, par exemple <code>GET</code> ou

<code>POST</code>.</td>

</tr>

<tr>

<td><code>notes</code></td>

<td>table</td>

<td>oui</td>

<td>Une liste de notes qui peuvent &ecirc;tre transmises d'un module

&agrave; l'autre.</td>

</tr>

<tr>

<td><code>options</code></td>

<td>string</td>

<td>non</td>

<td>La valeur de la directive Options pour la requ&ecirc;te

courante.</td>

</tr>

<tr>

<td><code>path_info</code></td>

<td>string</td>

<td>non</td>

<td>La valeur de PATH_INFO extraite de la requ&ecirc;te.</td>

</tr>

<tr>

<td><code>port</code></td>

<td>number</td>

<td>non</td>

<td>Le port du serveur utilis&eacute; par la requ&ecirc;te.</td>

</tr>

<tr>

<td><code>protocol</code></td>

<td>string</td>

<td>non</td>

<td>Le protocole utilis&eacute;, par exemple <code>HTTP/1.1</code></td>

</tr>

<tr>

<td><code>proxyreq</code></td>

<td>string</td>

<td>oui</td>

<td>Indique s'il s'agit d'une requ&ecirc;te mandat&eacute;e ou non. Cette

valeur est en g&eacute;n&eacute;ral d&eacute;finie au cours de la phase

post_read_request/translate_name du traitement de la requ&ecirc;te.</td>

</tr>

<tr>

<td><code>range</code></td>

<td>string</td>

<td>non</td>

<td>Le contenu de l'en-t&ecirc;te <code>Range:</code>.</td>

</tr>

<tr>

<td><code>remaining</code></td>

<td>number</td>

<td>non</td>

<td>Le nombre d'octets du corps de la requ&ecirc;te restant &agrave; lire.</td>

</tr>

<tr>

<td><code>server_built</code></td>

<td>string</td>

<td>non</td>

<td>La date de compilation du serveur.</td>

</tr>

<tr>

<td><code>server_name</code></td>

<td>string</td>

<td>non</td>

<td>Le nom du serveur pour cette requ&ecirc;te.</td>

</tr>

<tr>

<td><code>some_auth_required</code></td>

<td>boolean</td>

<td>non</td>

<td>Indique si une autorisation est/&eacute;tait requise pour cette

requ&ecirc;te.</td>

</tr>

<tr>

<td><code>subprocess_env</code></td>

<td>table</td>

<td>oui</td>

<td>Le jeu de variables d'environnement pour cette requ&ecirc;te.</td>

</tr>

<tr>

<td><code>started</code></td>

<td>number</td>

<td>non</td>

<td>Le moment o&ugrave; le serveur a &eacute;t&eacute; (re)d&eacute;marr&eacute;, en secondes

depuis epoch (1er janvier 1970)</td>

</tr>

<tr>

<td><code>status</code></td>

<td>number</td>

<td>oui</td>

<td>Le code de retour (courant) pour cette requ&ecirc;te, par

exemple <code>200</code> ou <code>404</code>.</td>

</tr>

<tr>

<td><code>the_request</code></td>

<td>string</td>

<td>non</td>

<td>La cha&icirc;ne de la requ&ecirc;te telle qu'elle a &eacute;t&eacute; envoy&eacute;e par le

client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>

</tr>

<tr>

<td><code>unparsed_uri</code></td>

<td>string</td>

<td>non</td>

<td>La partie URI non interpr&eacute;t&eacute;e de la requ&ecirc;te</td>

</tr>

<tr>

<td><code>uri</code></td>

<td>string</td>

<td>oui</td>

<td>L'URI apr&egrave;s interpr&eacute;tation par httpd</td>

</tr>

<tr>

<td><code>user</code></td>

<td>string</td>

<td>oui</td>

<td>Si une authentification a &eacute;t&eacute; effectu&eacute;e, nom de

l'utilisateur authentifi&eacute;.</td>

</tr>

<tr>

<td><code>useragent_ip</code></td>

<td>string</td>

<td>non</td>

<td>L'adresse IP de l'agent qui a envoy&eacute; la requ&ecirc;te</td>

</tr>

</table>

</dd>

</dl>

</section>

<section id="functions"><title>M&eacute;thodes de l'objet request_rec</title>

<p>L'objet request_rec poss&egrave;de (au minimum) les m&eacute;thodes suivantes :</p>

<highlight language="lua">

r:flush() -- vide le tampon de sortie

-- Renvoie true si le vidage a &eacute;t&eacute; effectu&eacute; avec succ&egrave;s,

false dans le cas contraire.

while nous_avons_des_donn&eacute;es_&agrave;_envoyer do

r:puts("Bla bla bla\n") -- envoi des donn&eacute;es &agrave; envoyer vers le tampon

r:flush() -- vidage du tampon (envoi au client)

r:sleep(0.5) -- mise en attente et bouclage

+end

</highlight>

<highlight language="lua">

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

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

</highlight>

<highlight language="lua">

r:sendfile(filename) -- envoie un fichier entier au client en

utilisant sendfile s'il est support&eacute; par la plateforme :

if use_sendfile_thing then

r:sendfile("/var/www/large_file.img")

end

</highlight>

<highlight language="lua">

r:parseargs() -- renvoie une table Lua contenant la cha&icirc;ne

d'arguments de la requ&ecirc;te

local GET = r:parseargs()

+r:puts("Votre nom est : " .. GET['name'] or "Unknown")

</highlight>

<highlight language="lua">

r:parsebody()([sizeLimit]) -- interpr&egrave;te le corps de la requ&ecirc;te

en tant que POST et renvoie une table lua. Un nombre optionnel

peut &ecirc;tre fourni pour sp&eacute;cifier le nombre maximal d'octets &agrave;

interpr&eacute;ter. La valeur par d&eacute;faut est 8192.

local POST = r:parsebody(1024*1024)

+r:puts("Votre nom est : " .. POST['name'] or "Unknown")

</highlight>

<highlight language="lua">

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

</highlight>

<highlight language="lua">

r:write("une simple cha&icirc;ne") -- affichage dans le

corps de la r&eacute;ponse

</highlight>

<highlight language="lua">

r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Echappe le

code HTML et renvoie le r&eacute;sultat

</highlight>

<highlight language="lua">

r:base64_encode(string) -- Encode une cha&icirc;ne &agrave; l'aide du

standard de codage Base64.

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

</highlight>

<highlight language="lua">

r:base64_decode(string) -- D&eacute;code une cha&icirc;ne cod&eacute;e en Base64.

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

</highlight>

<highlight language="lua">

r:md5(string) -- Calcule et renvoie le condens&eacute; MD5 d'une cha&icirc;ne

en mode binaire (binary safe).

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

</highlight>

<highlight language="lua">

r:sha1(string) -- Calcule et renvoie le condens&eacute; SHA1 d'une cha&icirc;ne

en mode binaire (binary safe).

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

</highlight>

<highlight language="lua">

r:escape(string) -- Echappe une cha&icirc;ne de type URL.

local url = "http://foo.bar/1 2 3 &amp; 4 + 5"

local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'

</highlight>

<highlight language="lua">

r:unescape(string) -- D&eacute;s&eacute;chappe une cha&icirc;ne de type URL.

local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"

local unescaped = r:escape(url) -- returns 'http://foo.bar/1 2 3 &amp; 4 + 5'

</highlight>

<highlight language="lua">

r:mpm_query(number) -- Interroge le serveur &agrave; propos de son

module MPM via la requ&ecirc;te ap_mpm_query.

local mpm = r.mpm_query(14)

if mpm == 1 then

r:puts("Ce serveur utilise le MPM Event")

end

</highlight>

<highlight language="lua">

r:expr(string) -- Evalue une cha&icirc;ne de type <a

href="/expr.html">expr</a>.

if r:expr("%{HTTP_HOST} =~ /^www/") then

r:puts("Ce nom d'h&ocirc;te commence par www")

end

</highlight>

<highlight language="lua">

r:scoreboard_process(a) -- Interroge le serveur &agrave; propos du

processus &agrave; la position <code>a</code>.

local process = r:scoreboard_process(1)

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

</highlight>

<highlight language="lua">

r:scoreboard_worker(a, b) -- Interroge le serveur &agrave; propos du

thread <code>b</code>, dans le processus <code>a</code>.

local thread = r:scoreboard_worker(1, 1)

r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son

&eacute;tat est " .. thread.status)

</highlight>

<highlight language="lua">

r:clock() -- Renvoie l'heure courante avec une pr&eacute;cision d'une

microseconde.

</highlight>

<highlight language="lua">

r:requestbody(filename) -- Lit et renvoie le corps d'une requ&ecirc;te. Si

'filename' est sp&eacute;cifi&eacute;, le corps de requ&ecirc;te n'est pas renvoy&eacute;, mais

sauvegard&eacute; dans le fichier correspondant.

local input = r:requestbody()

r:puts("Vous m'avez envoy&eacute; le corps de requ&ecirc;te suivant :\n")

r:puts(input)

</highlight>

<highlight language="lua">

r:add_input_filter(filter_name) -- Ajoute le filtre en entr&eacute;e

'filter_name'.

</highlight>

<highlight language="lua">

r:module_info(module_name) -- Interroge le serveur &agrave; 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&eacute;ment&eacute;es par ce module

end

end

</highlight>

<highlight language="lua">

r:loaded_modules() -- Renvoie une liste des modules charg&eacute;s par

httpd.

for k, module in pairs(r:loaded_modules()) do

r:puts("J'ai charg&eacute; le module " .. module .. "\n")

end

</highlight>

<highlight language="lua">

r:runtime_dir_relative(filename) -- G&eacute;n&egrave;re le nom d'un fichier run-time

(par exemple la m&eacute;moire partag&eacute;e "file") relativement au r&eacute;pertoire de

run-time.

</highlight>

<highlight language="lua">

r:server_info() -- Renvoie une table contenant des informations

&agrave; propos du serveur, comme le nom de l'ex&eacute;cutable httpd, le

module mpm utilis&eacute;, etc...

</highlight>

<highlight language="lua">

r:set_document_root(file_path) -- D&eacute;finit la racine des

documents pour la requ&ecirc;te &agrave; file_path.

</highlight>

<highlight language="lua">

r:add_version_component(component_string) -- Ajoute un &eacute;l&eacute;ment &agrave;

la banni&egrave;re du serveur.

</highlight>

<highlight language="lua">

r:set_context_info(prefix, docroot) -- D&eacute;finit le pr&eacute;fixe et la

racine des documents du contexte pour une requ&ecirc;te.

</highlight>

<highlight language="lua">

r:os_escape_path(file_path) -- Convertit un chemin du syst&egrave;me de

fichiers en URL ind&eacute;pendamment du syst&egrave;me d'exploitation.

</highlight>

<highlight language="lua">

r:escape_logitem(string) -- Echappe une cha&icirc;ne pour

journalisation.

</highlight>

<highlight language="lua">

r.strcmp_match(string, pattern) -- V&eacute;rifie si 'string' correspond &agrave;

'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que

'www.example.com' correspond &agrave; '*.example.com' ?

local match = r.strcmp_match("foobar.com", "foo*.com")

if match then

r:puts("foobar.com matches foo*.com")

end

</highlight>

<highlight language="lua">

r:set_keepalive() -- D&eacute;finit l'&eacute;tat de persistance d'une

requ&ecirc;te. Renvoie true dans la mesure du possible, false dans le

cas contraire.

</highlight>

<highlight language="lua">

r:make_etag() -- G&eacute;n&egrave;re et renvoie le etag pour la requ&ecirc;te

courante.

</highlight>

<highlight language="lua">

r:send_interim_response(clear) -- Renvoie une r&eacute;ponse d'int&eacute;rim (1xx) au

client. Si 'clear' est vrai, les en-t&ecirc;tes disponibles seront envoy&eacute;s et

effac&eacute;s.

</highlight>

<highlight language="lua">

r:custom_response(status_code, string) -- G&eacute;n&egrave;re et d&eacute;finit une r&eacute;ponse

personnalis&eacute;e pour un code d'&eacute;tat particulier. Le fonctionnement est

tr&egrave;s proche de celui de la directive ErrorDocument.

r:custom_response(404, "Baleted!")

</highlight>

<highlight language="lua">

r.exists_config_define(string) -- V&eacute;rifie si une d&eacute;finition de

configuration existe.

if r.exists_config_define("FOO") then

r:puts("httpd a probablement &eacute;t&eacute; lanc&eacute; avec l'option -DFOO, ou FOO a

&eacute;t&eacute; d&eacute;fini dans la configuration")

end

</highlight>

<highlight language="lua">

r:state_query(string) -- Interroge le serveur &agrave; propos de son

&eacute;tat.

</highlight>

<highlight language="lua">

r:stat(filename) -- Ex&eacute;cute stat() sur un fichier, et renvoie

une table contenant des informations &agrave; propos de ce fichier.

local info = r:stat("/var/www/foo.txt")

if info then

r:puts("Ce fichier existe et a &eacute;t&eacute; modifi&eacute; pour la derni&egrave;re fois &agrave; : " .. info.modified)

end

</highlight>

<highlight language="lua">

r:regex(string, pattern, [drapeaux]) -- Ex&eacute;cute une recherche &agrave; base

d'expression rationnelle sur une cha&icirc;ne, et renvoie les

&eacute;ventuelles correspondances trouv&eacute;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&eacute; ($2) est : " .. matches[2])

end

-- Exemple avec insensibilit&eacute; &agrave; la casse :

local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)

-- les drapeaux peuvent &ecirc;tre une combibaison bit &agrave; bit de :

-- 0x01: insensibilit&eacute; &agrave; la casse

-- 0x02: recherche multiligne

</highlight>

<highlight language="lua">

r:sleep(secondes) -- Interrompt l'ex&eacute;cution du script pendant le nombre de secondes sp&eacute;cifi&eacute;.

-- La valeur peut &ecirc;tre sp&eacute;cifi&eacute;e sous la forme d'un nombre d&eacute;cimal comme 1.25 pour plus de pr&eacute;cision.

</highlight>

<highlight language="lua">

r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion &agrave; une

base de donn&eacute;es et renvoie une classe database. Voir '<a

href="#databases">Connectivit&eacute; aux bases de donn&eacute;es</a>' pour plus de

d&eacute;tails.

</highlight>

<highlight language="lua">

r:ivm_set("key", value) -- D&eacute;fini une variable Inter-VM avec une valeur sp&eacute;cifique.

-- Ces valeurs sont conserv&eacute;es m&ecirc;me si la VM est

-- arr&ecirc;t&eacute;e ou non utilis&eacute;e, et ne doivent donc &ecirc;tre

-- utilis&eacute;es que si MaxConnectionsPerChild > 0.

-- Les valeurs peuvent &ecirc;tre de type number, string

-- ou boolean et sont stock&eacute;es s&eacute;par&eacute;ment pour

-- chaque processus (elles ne seront donc pas d'une

-- grande utilit&eacute; si l'on utilise le mpm prefork).

r:ivm_get("key") -- Lit le contenu d'une variable d&eacute;finie via ivm_set. Renvoie

-- le contenu de la variable si elle existe, ou nil

-- dans le cas contraire.

-- Voici un exemple de lecture/&eacute;criture qui sauvegarde une variable

-- globale en dehors de la VM :

function handle(r)

-- La premi&egrave;re VM qui effectue l'appel suivant n'obtiendra aucune

-- valeur, et devra la cr&eacute;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&eacute;finition globale de la variable

end

r:puts("La donn&eacute;e en cache est : ", foo)

end

</highlight>

</section>

<section id="logging"><title>Fonctions de journalisation</title>

<highlight language="lua">

-- exemples de messages de journalisation

r:trace1("Ceci est un message de journalisation de niveau

trace") -- les niveaux valides vont de trace1 &agrave; trace8 <br />

r:debug("Ceci est un message de journalisation de niveau debug")<br />

r:info("Ceci est un message de journalisation de niveau info")<br />

r:notice("Ceci est un message de journalisation de niveau notice")<br />

r:warn("Ceci est un message de journalisation de niveau warn")<br />

r:err("Ceci est un message de journalisation de niveau err")<br />

r:alert("Ceci est un message de journalisation de niveau alert")<br />

r:crit("Ceci est un message de journalisation de niveau crit")<br />

r:emerg("Ceci est un message de journalisation de niveau emerg")<br />

</highlight>

</section>

<section id="apache2"><title>Paquet apache2</title>

<p>Le paquet nomm&eacute; <code>apache2</code> est fourni avec (au minimum) le

contenu suivant :</p>

<dl>

<dt>apache2.OK</dt>

<dd>Constante interne OK. Les gestionnaires renverront cette valeur

s'ils ont trait&eacute; la requ&ecirc;te.</dd>

<dt>apache2.DECLINED</dt>

<dd>Constante interne DECLINED. Les gestionnaires renverront cette

valeur s'ils n'ont pas l'intention de traiter la requ&ecirc;te.</dd>

<dt>apache2.DONE</dt>

<dd>Constante interne DONE.</dd>

<dt>apache2.version</dt>

<dd>Cha&icirc;ne contenant la version du serveur HTTP Apache</dd>

<dt>apache2.HTTP_MOVED_TEMPORARILY</dt>

<dd>Code d'&eacute;tat HTTP</dd>

<dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>

<dd>Constantes internes utilis&eacute;es par <module>mod_proxy</module></dd>

<dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>

<dd>constantes internes utilis&eacute;es par <module>mod_authz_core</module></dd>

</dl>

<p>Les autres codes d'&eacute;tat HTTP ne sont pas encore impl&eacute;ment&eacute;s.</p>

</section>

<section id="modifying_buckets">

<title>Modification de contenu avec les filtres lua</title>

<p>

Les fonctions de filtrage impl&eacute;ment&eacute;es via les directives <directive

module="mod_lua">LuaInputFilter</directive> ou <directive

module="mod_lua">LuaOutputFilter</directive> sont con&ccedil;ues comme des

fonctions de 3&egrave;me phase non blocantes utilisant des sous-routines

pour suspendre et reprendre l'ex&eacute;cution d'une fonction lorsque des

paquets de donn&eacute;es sont envoy&eacute;s &agrave; la cha&icirc;ne de filtrage. La

structure de base d'une telle fonction est :

</p>

<highlight language="lua">

function filter(r)

-- Nous indiquons tout d'abord que nous sommes pr&ecirc;ts &agrave; recevoir des

-- blocs de donn&eacute;es.

-- Avant ceci, nous pouvons d&eacute;finir notre environnement, tester

-- certaines conditions, et, si nous le jugeons n&eacute;cessaire, refuser le

-- filtrage d'une requ&ecirc;te :

if something_bad then

return -- Le filtrage est saut&eacute;

end

-- Sans se pr&eacute;occuper des donn&eacute;es que nous devons &eacute;ventuellement ajouter, un arr&ecirc;t est r&eacute;alis&eacute; ici.

-- Noter que les filtres de sortie sont les seuls capables d'ajouter des &eacute;l&eacute;ments au d&eacute;but des donn&eacute;es.

-- Les filtres en entr&eacute;e peuvent ajouter des &eacute;l&eacute;ments &agrave; la fin des donn&eacute;es au stade final.

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

-- Apr&egrave;s cet arr&ecirc;t, nous allons recevoir d'autres blocs de donn&eacute;es, un par un ;

-- nous pouvons les traiter comme il nous pla&icirc;t et proc&eacute;der &agrave; la r&eacute;ponse.

-- Ces blocs sont conserv&eacute;s dans la variable globale 'bucket', nous r&eacute;alisons donc

-- une boucle pour v&eacute;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&eacute;es &eacute;puis&eacute;s, 'bucket' est positionn&eacute; &agrave; une valeur vide ('nil'),

-- ce qui va nous faire sortir de cette boucle et nous amener &agrave; l'&eacute;tape suivante.

-- On peut ajouter ce qu'on veut &agrave; la fin des donn&eacute;es &agrave; cette &eacute;tape, qui constitue le dernier

-- arr&ecirc;t. Les filtres d'entr&eacute;e comme de sortie peuvent servir &agrave; ajouter des &eacute;l&eacute;ments &agrave; la fin

-- des donn&eacute;es &agrave; cette &eacute;tape.

coroutine.yield([optional footer to be appended to the content])

end

</highlight>

</section>

<section id="databases">

<title>Connectivit&eacute; aux bases de donn&eacute;es</title>

<p>Mod_lua impl&eacute;mente une fonctionnalit&eacute; basique de connexion aux

bases de donn&eacute;es permettant d'envoyer des requ&ecirc;tes ou d'ex&eacute;cuter des

commandes aupr&egrave;s des moteurs de base de donn&eacute;es les plus courants

(mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.

</p>

<p>L'exemple suivant montre comment se connecter &agrave; une base de

donn&eacute;es et extraire des informations d'une table :</p>

<highlight language="lua">

function handle(r)

-- connexion &agrave; la base de donn&eacute;es

local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")

if not err then

-- S&eacute;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&lt;br/&gt;", row[1], row[2]) )

end

else

r:puts("Database query error: " .. err)

end

database:close()

else

r:puts("Connexion &agrave; la base de donn&eacute;es impossible : " .. err)

end

end

</highlight>

<p>

Pour utiliser <module>mod_dbd</module>, sp&eacute;cifiez

<code>mod_dbd</code> comme type de base de donn&eacute;es, ou laissez le champ

vide :

</p>

<highlight language="lua">

local database = r:dbacquire("mod_dbd")

</highlight>

<section id="database_object">

<title>L'objet database et ses m&eacute;thodes</title>

<p>L'objet database renvoy&eacute; par <code>dbacquire</code> poss&egrave;de

les m&eacute;thodes suivantes :</p>

<p><strong>S&eacute;lection normale et requ&ecirc;te vers une base de donn&eacute;es

:</strong></p>

<highlight language="lua">

-- Ex&eacute;cution d'une requ&ecirc;te et renvoie du nombre d'enregistrements

affect&eacute;s :

local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")

-- Ex&eacute;cution d'une requ&ecirc;te et renvoie du r&eacute;sultat qui peut &ecirc;tre utilis&eacute;

en mode synchrone ou asynchrone :

local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")

</highlight>

<p><strong>Utilisation de requ&ecirc;tes pr&eacute;par&eacute;es (recommand&eacute;) :</strong></p>

<highlight language="lua">

-- Cr&eacute;ation et ex&eacute;cution d'une requ&ecirc;te pr&eacute;par&eacute;e :

local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")

if not errmsg then

local result, errmsg = statement:query(20) -- ex&eacute;cute la requ&ecirc;te pour age &gt; 20

end

-- Extrait une requ&ecirc;te pr&eacute;par&eacute;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&ecirc;te

end

</highlight>

<p><strong>Echappement de valeurs, fermeture de la base donn&eacute;es,

etc...</strong></p>

<highlight language="lua">

-- Echappe une valeur pour pouvoir l'utiliser dans une requ&ecirc;te :

local escaped = database:escape(r, [["'|blabla]])

-- Ferme une base de donn&eacute;es et lib&egrave;re les liens vers cette derni&egrave;re :

database:close()

-- V&eacute;rifie si une connexion &agrave; une base de donn&eacute;es est en service et

op&eacute;rationnelle :

local connected = database:active()

</highlight>

</section>

<section id="result_sets">

<title>Travail avec les jeux d'enregistrements renvoy&eacute;s par les requ&ecirc;tes</title>

<p>Les jeux d'enregistrements renvoy&eacute;s par <code>db:select</code> ou par des

requ&ecirc;tes pr&eacute;par&eacute;es cr&eacute;&eacute;es par <code>db:prepare</code> permettent de

s&eacute;lectionner des enregistrements en mode synchrone ou

asynchrone, selon le nombre d'enregistrements sp&eacute;cifi&eacute; :<br/>

<code>result(0)</code> s&eacute;lectionne tous les enregistrements en mode

synchrone en renvoyant une table d'enregistrements.<br/>

<code>result(-1)</code> s&eacute;lectionne le prochain enregistrement disponible en

mode asynchrone.<br/>

<code>result(N)</code> s&eacute;lectionne l'enregistrement num&eacute;ro

<code>N</code> en mode asynchrone.

</p>

<highlight language="lua">

-- extrait un jeu d'enregistrements via une requ&ecirc;te r&eacute;guli&egrave;re :

local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")

local rows = result(0) -- s&eacute;lectionne tous les enregistrements en mode synchrone

local row = result(-1) -- s&eacute;lectionne le prochain enregistrement disponible en mode asynchrone

local row = result(1234) -- s&eacute;lectionne l'enregistrement 1234 en mode asynchrone

</highlight>

<p>Il est possible de construire une fonction qui renvoie une

fonction it&eacute;rative permettant de traiter tous les enregistrement en mode

synchrone ou asynchrone selon la valeur de l'argument async :

</p>

<highlight language="lua">

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&eacute;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&eacute;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

</highlight>

</section>

<section id="closing_databases">

<title>Fermeture d'une connexion &agrave; une base de donn&eacute;es</title>

<p>Lorsqu'elles ne sont plus utilis&eacute;es, les connexions aux bases de

donn&eacute;es doivent &ecirc;tre ferm&eacute;es avec <code>database:close()</code>. Si vous

ne les fermez pas manuellement, mod_lua les fermera peut-&ecirc;tre en tant

que r&eacute;sidus collect&eacute;s, mais si ce n'est pas le cas, vous pouvez finir

pas avoir trop de connexions vers la base de donn&eacute;es inutilis&eacute;es. Les

deux mesures suivantes sont pratiquement identiques :

</p>

<highlight language="lua">

-- M&eacute;thode 1 : fermeture manuelle de la connexion

local database = r:dbacquire("mod_dbd")

database:close() -- c'est tout

-- M&eacute;thode 2 : on laisse le collecteur de r&eacute;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&eacute;sidus

</highlight>

</section>

<section id="database_caveat">

<title>Pr&eacute;cautions &agrave; prendre lorsque l'on travaille avec les bases

de donn&eacute;es</title>

<p>Bien que les fonctions <code>query</code> et <code>run</code>

soient toujours disponibles, il est recommand&eacute; d'utiliser des requ&ecirc;tes

pr&eacute;par&eacute;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

<code>run</code> et <code>query</code> ne doivent &ecirc;tre utilis&eacute;es que

lorsque la requ&ecirc;te ne contient pas de variables (requ&ecirc;te statique). Dans

le cas des requ&ecirc;tes dynamiques, utilisez <code>db:prepare</code> ou

<code>db:prepared</code>.

</p>

</section>

</section>

<directivesynopsis>

<name>LuaRoot</name>

<description>Sp&eacute;cifie le chemin de base pour la r&eacute;solution des chemins

relatifs dans les directives de mod_lua</description>

<syntax>LuaRoot /chemin/vers/un/r&eacute;pertoire</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Cette directive permet de sp&eacute;cifier le chemin de base qui sera

utilis&eacute; pour &eacute;valuer tous les chemins relatifs dans mod_lua. En

l'absence de cette directive, les chemins relatifs sont r&eacute;solus par

rapport au r&eacute;pertoire de travail courant, ce qui ne sera pas

toujours appropri&eacute; pour un serveur.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaScope</name>

<description>Une valeur parmi once, request, conn, thread -- la valeur

par d&eacute;faut est once</description>

<syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>

<default>LuaScope once</default>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Cette directive permet de sp&eacute;cifier la dur&eacute;e de vie de

l'interpr&eacute;teur Lua qui sera utilis&eacute; dans ce "r&eacute;pertoire". La valeur

par d&eacute;faut est "once".</p>

<dl>

<dt>once:</dt> <dd>utilise l'interpr&eacute;teur une fois.</dd>

<dt>request:</dt> <dd>utilise l'interpr&eacute;teur pour traiter tout ce

qui est bas&eacute; sur le m&ecirc;me fichier dans la requ&ecirc;te, et qui se trouve

aussi dans la port&eacute;e de la requ&ecirc;te.</dd>

<dt>conn:</dt> <dd>idem request, mais attach&eacute; &agrave; connection_rec</dd>

<dt>thread:</dt> <dd>Utilise l'interpr&eacute;teur pendant toute la dur&eacute;e

de vie du thread qui traite la requ&ecirc;te (disponible seulement avec

les MPMs thread&eacute;s).</dd>

<dt>server:</dt> <dd>Le comportement est ici diff&eacute;rent, car la

port&eacute;e du serveur pr&eacute;sente une dur&eacute;e de vie assez longue, et

plusieurs threads vont partager le m&ecirc;me server_rec. Pour g&eacute;rer tout

ceci, les &eacute;tats lua du serveur sont stock&eacute;s dans une liste de ressources

apr. Les arguments <code>min</code> et <code>max</code> permettent

de sp&eacute;cifier les nombres minimaux et maximaux d'&eacute;tats lua &agrave; stocker

dans la liste.</dd>

</dl>

<p>En g&eacute;n&eacute;ral, les port&eacute;es <code>thread</code> et <code>server</code>

sont 2 &agrave; 3 fois plus rapides que les autres, car elles n'ont pas besoin

de r&eacute;g&eacute;n&eacute;rer de nouveaux &eacute;tats Lua &agrave; chaque requ&ecirc;te (comme c'est le

cas avec le MPM event, o&ugrave; m&ecirc;me les connexions persistantes utilisent un

nouveau thread pour chaque requ&ecirc;te). Si vous pensez que vos scripts

n'auront pas de probl&egrave;me s'il r&eacute;utilisent un &eacute;tat, alors les port&eacute;es

<code>thread</code> ou <code>server</code> doivent &ecirc;tre utilis&eacute;es car

elles pr&eacute;senteront de meilleures performances. Alors que la port&eacute;e

<code>thread</code> fournira les r&eacute;ponses les plus rapides, la port&eacute;e

<code>server</code> utilisera moins de m&eacute;moire car les &eacute;tats sont

rassembl&eacute;s dans des jeux, permettant par exemple &agrave; 1000 threads de

partager 100 &eacute;tats Lua, ne n&eacute;cessitant ainsi que 10% de la m&eacute;moire

requise par la port&eacute;e <code>thread</code>.

</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaMapHandler</name>

<description>Met en correspondance un chemin avec un gestionnaire lua</description>

<syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua

[nom-fonction]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Cette directive permet de faire correspondre un mod&egrave;le d'uri avec

une fonction de gestionnaire situ&eacute;e dans un fichier sp&eacute;cifique. Elle

utilise les expressions rationnelles PCRE pour mettre en

correspondance l'uri, et supporte les groupes de correspondance

d'interpolation dans le chemin du fichier et le nom de la fonction.

Prenez garde aux probl&egrave;mes de s&eacute;curit&eacute; en &eacute;crivant vos expressions

rationnelles.</p>

<example><title>Exemples :</title>

<highlight language="config">

LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2

</highlight>

</example>

<p>Cette directive va faire correspondre des uri comme

/photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la

fonction de gestionnaire handle_show au niveau de la vm lua

apr&egrave;s chargement de ce fichier.</p>

<highlight language="config">

LuaMapHandler /bingo /scripts/wombat.lua

</highlight>

<p>Cette directive invoquera la fonction "handle" qui est la

valeur par d&eacute;faut si aucun nom de fonction sp&eacute;cifique n'est

sp&eacute;cifi&eacute;.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaPackagePath</name>

<description>Ajoute un r&eacute;pertoire au package.path de lua</description>

<syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>Cette directive permet d'ajouter un chemin &agrave; la liste des

chemins de recherche du module lua. Elle suit les m&ecirc;mes conventions

que lua. Ceci modifie le package.path dans les vms lua.</p>

<example><title>Exemples :</title>

<highlight language="config">

LuaPackagePath /scripts/lib/?.lua

LuaPackagePath /scripts/lib/?/init.lua

</highlight>

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaPackageCPath</name>

<description>Ajoute un r&eacute;pertoire au package.cpath de lua</description>

<syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Cette directive permet d'ajouter un chemin &agrave; la liste des chemins

de recherche des biblioth&egrave;ques partag&eacute;es de lua. Ceci modifie le

package.cpath dans les vms lua.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaCodeCache</name>

<description>Configure le cache de code compil&eacute;.</description>

<syntax>LuaCodeCache stat|forever|never</syntax>

<default>LuaCodeCache stat</default>

<contextlist>

<context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>

Cette directive permet de d&eacute;finir le comportement du cache de code

en m&eacute;moire. La valeur par d&eacute;faut est stat ; dans ce cas, le script

du niveau le plus haut (et pas les scripts inclus) est v&eacute;rifi&eacute; &agrave;

chaque fois que ce fichier est n&eacute;cessaire, et est recharg&eacute; si la

date de modification est plus r&eacute;cente que celle du script d&eacute;j&agrave;

charg&eacute;. Les autres valeurs permettent respectivement de garder le

fichier en cache perp&eacute;tuellement (forever - jamais v&eacute;rifi&eacute; ni

remplac&eacute;), ou de ne jamais le mettre en cache (never).</p>

<p>En g&eacute;n&eacute;ral, les valeurs stat et forever sont utilis&eacute;es pour un

serveur en production, et les valeurs stat ou never pour un serveur

en d&eacute;veloppement.</p>

<example><title>Exemples :</title>

<highlight language="config">

LuaCodeCache stat

LuaCodeCache forever

LuaCodeCache never

</highlight>

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookTranslateName</name>

<description>Fournit un point d'entr&eacute;e &agrave; la phase du nom de

traduction du traitement de la requ&ecirc;te</description>

<syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>

<override>All</override>

<compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la

version 2.3.15 du serveur HTTP Apache.</compatibility>

<usage><p>

Cette directive permet d'ajouter un point d'entr&eacute;e (&agrave;

APR_HOOK_MIDDLE) &agrave; la phase du nom de traduction du traitement de la

requ&ecirc;te. La fonction hook accepte un seul argument, le request_rec,

et doit renvoyer un code d'&eacute;tat qui est soit un code d'erreur HTTP,

ou une constante d&eacute;finie dans le module apache2 : apache2.OK,

apache2.DECLINED, ou apache2.DONE.</p>

<p>Pour ceux qui ne sont pas familiers avec les points d'entr&eacute;e

(hook), en gros, chaque hook sera invoqu&eacute; jusqu'&agrave; ce que l'un

d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la

traduction, il doit juste renvoyer apache2.DECLINED. Si le

traitement de la requ&ecirc;te doit &ecirc;tre interrompu, la valeur renvoy&eacute;e

doit &ecirc;tre apache2.DONE.</p>

<p>Exemple :</p>

<highlight language="config">

# httpd.conf

LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper

</highlight>

<highlight language="lua">

-- /scripts/conf/hooks.lua --

require "apache2"

function silly_mapper(r)

if r.uri == "/" then

r.filename = "/var/www/home.lua"

return apache2.OK

else

return apache2.DECLINED

end

end

</highlight>

<note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre

utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"

module="core">Directory</directive> ou <directive type="section"

module="core">Files</directive>, ni dans un fichier htaccess.</p></note>

<note><title>Ordonnancement</title><p>Les arguments optionnels

"early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script

s'ex&eacute;cute par rapport aux autres modules.</p></note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookFixups</name>

<description>Fournit un point d'entr&eacute;e pour la phase de correction du

traitement de la requ&ecirc;te</description>

<syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>

Idem LuaHookTranslateName, mais s'ex&eacute;cute durant la phase de

correction.

</p>