mod_lua.html.fr revision 1f1b6bf13313fdd14a45e52e553d3ff28689b717
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_lua - Serveur Apache HTTP Version 2.5</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
</script>
<body>
<div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p>
<p class="apache">Serveur Apache HTTP Version 2.5</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">Serveur HTTP</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Module Apache mod_lua</h1>
<div class="toplang">
<p><span>Langues Disponibles: </span><a href="/en/mod/mod_lua.html" hreflang="en" rel="alternate" title="English"> en </a> |
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Fournit des points d'entr�e Lua dans diff�rentes parties du
traitement des requ�tes httpd</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Identificateur�de�Module:</a></th><td>lua_module</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibilit�:</a></th><td>versions 2.3 et sup�rieures</td></tr></table>
<h3>Sommaire</h3>
<p>Ce module permet d'ajouter au serveur des extensions sous forme de
scripts �crits dans le langage de programmation Lua.
<code class="module"><a href="/mod/mod_lua.html">mod_lua</a></code> fournit de nombreuses extensions
(hooks) disponibles avec les modules natifs du serveur HTTP Apache,
comme les associations de requ�tes � des fichiers, la g�n�ration de
r�ponses dynamiques, le contr�le d'acc�s, l'authentification et
l'autorisation.</p>
<p>Vous trouverez davantage d'informations � propos du langage de
programmation Lua sur <a href="http://www.lua.org/">le site web de
Lua</a>.</p>
<div class="note"><code>mod_lua</code> est encore au stade exp�rimental. Son mode
d'utilisation et son comportement pourront changer � tout moment jusqu'�
ce qu'il passe au stade stable, et ce m�me entre deux versions stables
2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise �
jour.</div>
<div class="warning"><h3>Avertissement</h3>
<p>Ce module poss�de une grande capacit� d'action sur le fonctrionnement
de httpd, ce qui lui conf�re une grande puissance, mais peut aussi
induire un risque de s�curit�. Il est d�conseill� d'utiliser ce module
sur un serveur partag� avec des utilisateurs auxquels vous ne pouvez pas
accorder une confiance absolue, car il peut permettre de modifier le
fonctionnement interne de httpd.</p>
</div>
</div>
<div id="quickview"><h3>Sujets</h3>
<ul id="topics">
<li><img alt="" src="/images/down.gif" /> <a href="#writinghandlers">Ecrire des gestionnaires</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#writingauthzproviders">Ecriture de fournisseurs d'autorisation</a></li>
(hooks)</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#functions">M�thodes de l'objet request_rec</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#modifying_buckets">Modification de contenu avec les filtres lua</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#databases">Connectivit� aux bases de donn�es</a></li>
</ul><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="/images/down.gif" /> <a href="#luahookaccesschecker">LuaHookAccessChecker</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#luahookinsertfilter">LuaHookInsertFilter</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#luahookmaptostorage">LuaHookMapToStorage</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#luahooktranslatename">LuaHookTranslateName</a></li>
</ul>
<ul class="seealso"><li><a href="#comments_section">Commentaires</a></li></ul></div>
<div class="section">
<h2><a name="basicconf" id="basicconf">Configuration de base</a></h2>
<p>La directive de base pour le chargement du module est</p>
<p>
<code>mod_lua</code> fournit un gestionnaire nomm�
<code>lua-script</code> qui peut �tre utilis� avec une directive
<code class="directive"><a href="/mod/core.html#sethandler">SetHandler</a></code> ou <code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code> :</p>
<pre class="prettyprint lang-config"><Files *.lua>
SetHandler lua-script
</Files></pre>
<p>
Ceci aura pour effet de faire traiter les requ�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�tails, voir la directive
<code class="directive">LuaMapHandler</code>.
</p>
<div class="section">
<h2><a name="writinghandlers" id="writinghandlers">Ecrire des gestionnaires</a></h2>
<p>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. <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code>, <code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code> et
<code class="module"><a href="/mod/mod_status.html">mod_status</a></code> sont des exemples de modules comportant un
gestionnaire.</p>
<p><code>mod_lua</code> 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 :</p>
<pre class="prettyprint lang-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)
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</pre>
<p>
Ce gestionnaire se contente d'afficher les arguments cod�s d'un uri ou
d'un formulaire dans un page au format texte.
</p>
<p>
Cela signifie que vous pouvez (et �tes encourag� �) avoir plusieurs
gestionnaires (ou points d'entr�e, ou filtres) dans le m�me script.
</p>
<div class="section">
<h2><a name="writingauthzproviders" id="writingauthzproviders">Ecriture de fournisseurs d'autorisation</a></h2>
<p><code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code> fournit une interface d'autorisation
de haut niveau bien plus facile � utiliser que dans les hooks
correspondants. Le premier argument de la directive <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> permet de sp�cifier le
fournisseur d'autorisation � utiliser. Pour chaque directive <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code>,
<code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code> 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.</p>
<p>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
d�clancher le processus d'authentification et un deuxi�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�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 :</p>
<pre class="prettyprint lang-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</pre>
<p>La configuration suivante enregistre cette fonction en tant que
fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
<Location />
Require foo 10.1.2.3 john_doe
</Location></pre>
<div class="section">
<h2><a name="writinghooks" id="writinghooks">Ecriture de fonctions d'accroche
(hooks)</a></h2>
<p>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 : </p>
<table class="bordered"><tr class="header">
<th>Phase d'accroche</th>
<th>Directive mod_lua</th>
<th>Description</th>
</tr>
<tr>
<td>Gestionnaire rapide</td>
<td><code class="directive"><a href="#luaquickhandler">LuaQuickHandler</a></code></td>
<td>Il s'agit de la premi�re accroche appel�e lorsqu'une requ�te
a �t� associ�e � un serveur ou un serveur virtuel.</td>
</tr>
<tr class="odd">
<td>Phase de traduction</td>
<td><code class="directive"><a href="#luahooktranslatename">LuaHookTranslateName</a></code></td>
<td>Cette phase traduit l'URI de la requ�te en nom de fichier
sur le syst�me. Ce sont des modules comme
<code class="module"><a href="/mod/mod_alias.html">mod_alias</a></code> et <code class="module"><a href="/mod/mod_rewrite.html">mod_rewrite</a></code> qui
interviennent au cours de cette phase.</td>
</tr>
<tr>
<td>Choix du lieu de stockage de la ressource</td>
<td><code class="directive"><a href="#luahookmaptostorage">LuaHookMapToStorage</a></code></td>
<td>Cette phase d�finit le lieu de stockage de la ressource :
modules de mandat ou de mise en cache.</td>
</tr>
<tr class="odd">
<td>Autorisation d'acc�s</td>
<td><code class="directive"><a href="#luahookaccesschecker">LuaHookAccessChecker</a></code></td>
<td>Cette phase v�rifie si un client a l'autorisation d'acc�s �
la ressource. Elle s'ex�cute avant l'authentification de
l'utisateur ; il faut donc �tre prudent.
</td>
</tr>
<tr>
<td>V�rification de l'identifiant utilisateur</td>
<td><code class="directive"><a href="#luahookcheckuserid">LuaHookCheckUserID</a></code></td>
<td>Cette phase v�rifie l'identifiant de l'utilisateur ayant
fait l'objet d'une n�gociation.</td>
</tr>
<tr class="odd">
<td>V�rification de l'autorisation d'acc�s</td>
<td><code class="directive"><a href="#luahookauthchecker">LuaHookAuthChecker</a></code>
ou
<code class="directive"><a href="#luaauthzprovider">LuaAuthzProvider</a></code></td>
<td>Cette phase v�rifie l'autorisation d'acc�s d'un utilisateur
en fonction des ses param�tres de connexion, comme
l'identifiant, le certificat, etc...
</td>
</tr>
<tr>
<td>V�rification du type de la ressource</td>
<td><code class="directive"><a href="#luahooktypechecker">LuaHookTypeChecker</a></code></td>
<td>Cette phase assigne un type de contenu et un gestionnaire �
la ressource.</td>
</tr>
<tr class="odd">
<td>Derniers r�glages</td>
<td><code class="directive"><a href="#luahookfixups">LuaHookFixups</a></code></td>
<td>C'est la derni�re phase avant l'activation des gestionnaires
de contenu. Toute modification de derni�re minute � la requ�te
doit �tre effectu�e ici.</td>
</tr>
<tr>
<td>Gestionnaire de contenu</td>
<td>fichiers fx. <code>.lua</code> ou directive <code class="directive"><a href="#luamaphandler">LuaMapHandler</a></code></td>
<td>C'est durant cette phase que le contenu est trait�. Les
fichiers sont lus, interpr�t�s, certains sont ex�cut�s, et le
r�sultat obtenu est envoy� au client.</td>
</tr>
<tr class="odd">
<td>Journalisation</td>
<td><code class="directive"><a href="#luahooklog">LuaHookLog</a></code></td>
<td>Lorsqu'une requ�te a �t� trait�e, plusieurs phases de
journalisation interviennent, et enregistrent leurs r�sultats
dans les fichiers d'erreur ou d'acc�s. Mod_lua peut
s'intercaler au d�part de ce processus et ainsi contr�ler la
journalisation.</td>
</tr>
</table>
<p>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,
<pre class="prettyprint lang-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
return apache2.OK
end
-- on ne g�re pas cette URL et on donne sa chance � un autre module
return apache2.DECLINED
end</pre>
<pre class="prettyprint lang-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.
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</pre>
<div class="section">
<h2><a name="datastructures" id="datastructures">Structures de donn�es</a></h2>
<dl>
<dt>request_rec</dt>
<dd>
<p>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).</p>
<table class="bordered"><tr class="header">
<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 � la requ�te courante.</td>
</tr>
<tr class="odd">
<td><code>ap_auth_type</code></td>
<td>string</td>
<td>non</td>
<td>Ce champ contient le type d'authentification effectu�e
(par exemple <code>basic</code>)</td>
</tr>
<tr>
<td><code>args</code></td>
<td>string</td>
<td>oui</td>
<td>La cha�ne de param�tres de la requ�te (par exemple
<code>foo=bar&name=johnsmith</code>)</td>
</tr>
<tr class="odd">
<td><code>assbackwards</code></td>
<td>boolean</td>
<td>non</td>
(par exemple <code>GET /foo</code> (sans champs d'en-t�te) )</td>
</tr>
<tr>
<td><code>auth_name</code></td>
<td>string</td>
<td>non</td>
<td>La cha�ne d'identification utilis�e pour la v�rification
de l'autorisation d'acc�s (si elle est disponible).</td>
</tr>
<tr class="odd">
<td><code>banner</code></td>
<td>string</td>
<td>non</td>
<td>La banni�re du serveur, par exemple <code>Apache HTTP
</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�
avec la requ�te, s'il existe</td>
</tr>
<tr class="odd">
<td><code>canonical_filename</code></td>
<td>string</td>
<td>non</td>
<td>Le nom de fichier canonique de la requ�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�te courante</td>
</tr>
<tr class="odd">
<td><code>content_type</code></td>
<td>string</td>
<td>oui</td>
<td>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
</tr>
<tr>
<td><code>context_prefix</code></td>
<td>string</td>
<td>non</td>
<td />
</tr>
<tr class="odd">
<td><code>context_document_root</code></td>
<td>string</td>
<td>non</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 class="odd">
<td><code>err_headers_out</code></td>
<td>table</td>
<td>non</td>
<td>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</td>
</tr>
<tr>
<td><code>filename</code></td>
<td>string</td>
<td>oui</td>
<td>Le nom de fichier correspondant � la requ�te, par exemple
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.</td>
</tr>
<tr class="odd">
<td><code>handler</code></td>
<td>string</td>
<td>oui</td>
doit traiter la requ�te, par exemple <code>lua-script</code>
si elle doit �tre trait�e par mod_lua. Cette valeur est en
g�n�ral d�finie via les directives <code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code> ou <code class="directive"><a href="/mod/core.html#sethandler">SetHandler</a></code>, 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.
</td>
</tr>
<tr>
<td><code>headers_in</code></td>
<td>table</td>
<td>oui</td>
<td>Les en-t�tes MIME de l'environnement de la requ�te. Il
s'agit des en-t�tes comme <code>Host, User-Agent,
Referer</code>, etc...</td>
</tr>
<tr class="odd">
<td><code>headers_out</code></td>
<td>table</td>
<td>oui</td>
<td>Les en-t�tes MIME de l'environnement de la r�ponse.</td>
</tr>
<tr>
<td><code>hostname</code></td>
<td>string</td>
<td>non</td>
<td>Le nom d'h�te, tel que d�fini par l'en-t�te
<code>Host:</code> ou par un URI complet.</td>
</tr>
<tr class="odd">
<td><code>is_https</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si la requ�te � �t� faite via HTTPS</td>
</tr>
<tr>
<td><code>is_initial_req</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si la requ�te courante est la requ�te initiale ou
une sous-requ�te.</td>
</tr>
<tr class="odd">
<td><code>limit_req_body</code></td>
<td>number</td>
<td>non</td>
<td>La taille maximale du corps de la requ�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�te dans les journaux d'acc�s ou
d'erreur.</td>
</tr>
<tr class="odd">
<td><code>method</code></td>
<td>string</td>
<td>non</td>
<td>La m�thode de la requ�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 �tre transmises d'un module
� l'autre.</td>
</tr>
<tr class="odd">
<td><code>options</code></td>
<td>string</td>
<td>non</td>
<td>La valeur de la directive Options pour la requ�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�te.</td>
</tr>
<tr class="odd">
<td><code>port</code></td>
<td>number</td>
<td>non</td>
<td>Le port du serveur utilis� par la requ�te.</td>
</tr>
<tr>
<td><code>protocol</code></td>
<td>string</td>
<td>non</td>
</tr>
<tr class="odd">
<td><code>proxyreq</code></td>
<td>string</td>
<td>oui</td>
<td>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
</tr>
<tr>
<td><code>range</code></td>
<td>string</td>
<td>non</td>
<td>Le contenu de l'en-t�te <code>Range:</code>.</td>
</tr>
<tr class="odd">
<td><code>remaining</code></td>
<td>number</td>
<td>non</td>
<td>Le nombre d'octets du corps de la requ�te restant � 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 class="odd">
<td><code>server_name</code></td>
<td>string</td>
<td>non</td>
<td>Le nom du serveur pour cette requ�te.</td>
</tr>
<tr>
<td><code>some_auth_required</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si une autorisation est/�tait requise pour cette
requ�te.</td>
</tr>
<tr class="odd">
<td><code>subprocess_env</code></td>
<td>table</td>
<td>oui</td>
<td>Le jeu de variables d'environnement pour cette requ�te.</td>
</tr>
<tr>
<td><code>started</code></td>
<td>number</td>
<td>non</td>
<td>Le moment o� le serveur a �t� (re)d�marr�, en secondes
depuis epoch (1er janvier 1970)</td>
</tr>
<tr class="odd">
<td><code>status</code></td>
<td>number</td>
<td>oui</td>
<td>Le code de retour (courant) pour cette requ�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�ne de la requ�te telle qu'elle a �t� envoy�e par le
</tr>
<tr class="odd">
<td><code>unparsed_uri</code></td>
<td>string</td>
<td>non</td>
<td>La partie URI non interpr�t�e de la requ�te</td>
</tr>
<tr>
<td><code>uri</code></td>
<td>string</td>
<td>oui</td>
<td>L'URI apr�s interpr�tation par httpd</td>
</tr>
<tr class="odd">
<td><code>user</code></td>
<td>string</td>
<td>oui</td>
<td>Si une authentification a �t� effectu�e, nom de
l'utilisateur authentifi�.</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� la requ�te</td>
</tr>
</table>
</dd>
</dl>
<div class="section">
<h2><a name="functions" id="functions">M�thodes de l'objet request_rec</a></h2>
<p>L'objet request_rec poss�de (au minimum) les m�thodes suivantes :</p>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r:addoutputfilter(name|function) -- ajoute un filtre en sortie
r:addoutputfilter("fooFilter") -- ins�re le filtre fooFilter dans le flux de sortie</pre>
<pre class="prettyprint lang-lua">r:sendfile(filename) -- envoie un fichier entier au client en utilisant sendfile s'il est
-- support� par la plateforme :
if use_sendfile_thing then
end</pre>
<pre class="prettyprint lang-lua">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")</pre>
<pre class="prettyprint lang-lua">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")</pre>
<pre class="prettyprint lang-lua">r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la r�ponse</pre>
<pre class="prettyprint lang-lua">r:write("une simple cha�ne") -- affichage dans le corps de la r�ponse</pre>
<pre class="prettyprint lang-lua">r:escape_html("<html>test</html>") -- Echappe le code HTML et renvoie le r�sultat</pre>
<pre class="prettyprint lang-lua">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=</pre>
<pre class="prettyprint lang-lua">r:base64_decode(string) -- D�code une cha�ne cod�e en Base64.
local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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'</pre>
<pre class="prettyprint lang-lua">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'</pre>
<pre class="prettyprint lang-lua">r:construct_url(string) -- Construit une URL � partir d'un URI
local url = r:construct_url(r.uri)</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r:expr(string) -- Evalue une cha�ne de type <a href="/expr.html">expr</a>.
if r:expr("%{HTTP_HOST} =~ /^www/") then
r:puts("Ce nom d'h�te commence par www")
end</pre>
<pre class="prettyprint lang-lua">r:scoreboard_process(a) -- Interroge le serveur � propos du
-- processus � la position <code>a</code>.
local process = r:scoreboard_process(1)
r:puts("Le serveur 1 a comme PID " .. process.pid)</pre>
<pre class="prettyprint lang-lua">r:scoreboard_worker(a, b) -- Interroge le serveur � 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
�tat est " .. thread.status)</pre>
<pre class="prettyprint lang-lua">r:clock() -- Renvoie l'heure courante avec une pr�cision d'une microseconde.</pre>
<pre class="prettyprint lang-lua">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)</pre>
<pre class="prettyprint lang-lua">r:add_input_filter(filter_name) -- Ajoute le filtre en entr�e 'filter_name'.</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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.</pre>
<pre class="prettyprint lang-lua">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...</pre>
<pre class="prettyprint lang-lua">r:set_document_root(file_path) -- D�finit la racine des documents
-- pour la requ�te � file_path.</pre>
<pre class="prettyprint lang-lua">r:add_version_component(component_string) -- Ajoute un �l�ment �
-- la banni�re du serveur.</pre>
<pre class="prettyprint lang-lua">r:set_context_info(prefix, docroot) -- D�finit le pr�fixe et la
-- racine des documents du contexte pour une requ�te.</pre>
<pre class="prettyprint lang-lua">r:os_escape_path(file_path) -- Convertit un chemin du syst�me de
-- fichiers en URL ind�pendamment du syst�me d'exploitation.</pre>
<pre class="prettyprint lang-lua">r:escape_logitem(string) -- Echappe une cha�ne pour journalisation.</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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.</pre>
<pre class="prettyprint lang-lua">r:make_etag() -- G�n�re et renvoie le etag pour la requ�te courante.</pre>
<pre class="prettyprint lang-lua">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.</pre>
<pre class="prettyprint lang-lua">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!")</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r:state_query(string) -- Interroge le serveur � propos de son �tat.</pre>
<pre class="prettyprint lang-lua">r:stat(filename [,wanted]) -- Ex�cute stat() sur un fichier, et renvoie une table contenant
-- des informations � propos de ce fichier.
if info then
r:puts("Ce fichier existe et a �t� modifi� pour la derni�re fois � : " .. info.modified)
end</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r.usleep(microsecondes) -- Interrompt l'ex�cution du script pendant le nombre de microsecondes sp�cifi�.</pre>
<pre class="prettyprint lang-lua">r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion � une base de donn�es et renvoie une classe database.
-- Voir '<a href="#databases">Connectivit� aux bases de donn�es</a>'
-- pour plus de d�tails.</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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).</pre>
<pre class="prettyprint lang-lua">r:mkdir(dir [,mode]) -- Cr�e un r�pertoire et d�finit son mode via le param�tre optionnel mode.</pre>
<pre class="prettyprint lang-lua">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.</pre>
<pre class="prettyprint lang-lua">r:rmdir(dir) -- Supprime un r�pertoire.</pre>
<pre class="prettyprint lang-lua">r:touch(file [,mtime]) -- D�finit la date de modification d'un fichier � la date courante ou �
-- la valeur optionnelle mtime en msec.</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r.date_parse_rfc(string) -- Interpr�te une cha�ne date/heure et renvoie l'�quivalent en secondes depuis epoche.</pre>
<pre class="prettyprint lang-lua">r:getcookie(key) -- Obtient un cookie HTTP</pre>
<pre class="prettyprint lang-lua">r:setcookie(key, value, secure, expires) -- D�finit un cookie HTTP, par exemple :
r:setcookie("foo", "bar and stuff", false, os.time() + 86400)</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">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)</pre>
<pre class="prettyprint lang-lua">r:wswrite(line) -- �crit un cadre vers un client WebSocket :
r:wswrite("Bonjour le Monde !")</pre>
<pre class="prettyprint lang-lua">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</pre>
<pre class="prettyprint lang-lua">r:wspeek() -- V�rifie s'il y a des donn�es � lire
-- Se met en sommeil tant que rien ne nous est envoy� ...
while r:wspeek() == false do
r.usleep(50000)
end
-- Il y a des donn�es � lire !
local line = r:wsread()</pre>
<pre class="prettyprint lang-lua">r:config() -- Extrait une arborescence de l'ensemble de
-- la configuration de httpd pouvant �tre parcourue</pre>
<pre class="prettyprint lang-lua">r:activeconfig() -- Extrait une arborescence de la configuration active
-- de httpd (pour le serveur virtuel s�lectionn�)</pre>
<div class="section">
<h2><a name="logging" id="logging">Fonctions de journalisation</a></h2>
<pre class="prettyprint lang-lua"> -- exemples de messages de journalisation
r:trace1("Ceci est un message de journalisation de niveau
trace") -- les niveaux valides vont de trace1 � 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 />
</pre>
<div class="section">
<h2><a name="apache2" id="apache2">Paquet apache2</a></h2>
<p>Le paquet nomm� <code>apache2</code> est fourni avec (au minimum) le
contenu suivant :</p>
<dl>
<dd>Constante interne OK. Les gestionnaires renverront cette valeur
s'ils ont trait� la requ�te.</dd>
<dd>Constante interne DECLINED. Les gestionnaires renverront cette
valeur s'ils n'ont pas l'intention de traiter la requ�te.</dd>
<dd>Constante interne DONE.</dd>
<dd>Cha�ne contenant la version du serveur HTTP Apache</dd>
<dd>Code d'�tat HTTP</dd>
<dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
<dd>Constantes internes utilis�es par <code class="module"><a href="/mod/mod_proxy.html">mod_proxy</a></code></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�es par <code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code></dd>
</dl>
<p>Les autres codes d'�tat HTTP ne sont pas encore impl�ment�s.</p>
<div class="section">
<h2><a name="modifying_buckets" id="modifying_buckets">Modification de contenu avec les filtres lua</a></h2>
<p>
Les fonctions de filtrage impl�ment�es via les directives <code class="directive"><a href="#luainputfilter">LuaInputFilter</a></code> ou <code class="directive"><a href="#luaoutputfilter">LuaOutputFilter</a></code> 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 :
</p>
<pre class="prettyprint lang-lua">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</pre>
<div class="section">
<h2><a name="databases" id="databases">Connectivit� aux bases de donn�es</a></h2>
<p>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.
</p>
<p>L'exemple suivant montre comment se connecter � une base de
donn�es et extraire des informations d'une table :</p>
<pre class="prettyprint lang-lua">function handle(r)
-- connexion � la base de donn�es
local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,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</pre>
<p>
<code>mod_dbd</code> comme type de base de donn�es, ou laissez le champ
vide :
</p>
<pre class="prettyprint lang-lua">local database = r:dbacquire("mod_dbd")</pre>
<h3><a name="database_object" id="database_object">L'objet database et ses m�thodes</a></h3>
<p>L'objet database renvoy� par <code>dbacquire</code> poss�de
les m�thodes suivantes :</p>
<p><strong>S�lection normale et requ�te vers une base de donn�es
:</strong></p>
<pre class="prettyprint lang-lua">-- 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")</pre>
<p><strong>Utilisation de requ�tes pr�par�es (recommand�) :</strong></p>
<pre class="prettyprint lang-lua">-- 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</pre>
<p><strong>Echappement de valeurs, fermeture de la base donn�es,
etc...</strong></p>
<pre class="prettyprint lang-lua">-- 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()</pre>
<h3><a name="result_sets" id="result_sets">Travail avec les jeux d'enregistrements renvoy�s par les requ�tes</a></h3>
<p>Les jeux d'enregistrements renvoy�s par <code>db:select</code> ou par des
requ�tes pr�par�es cr��es par <code>db:prepare</code> permettent de
s�lectionner des enregistrements en mode synchrone ou
asynchrone, selon le nombre d'enregistrements sp�cifi� :<br />
<code>result(0)</code> s�lectionne tous les enregistrements en mode
synchrone en renvoyant une table d'enregistrements.<br />
<code>result(-1)</code> s�lectionne le prochain enregistrement disponible en
mode asynchrone.<br />
<code>result(N)</code> s�lectionne l'enregistrement num�ro
<code>N</code> en mode asynchrone.
</p>
<pre class="prettyprint lang-lua">-- 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
local row = result(-1, true) -- Lit l'enregistrement suivant en utilisant les noms d'enregistrements comme index.</pre>
<p>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 :
</p>
<pre class="prettyprint lang-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�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</pre>
<h3><a name="closing_databases" id="closing_databases">Fermeture d'une connexion � une base de donn�es</a></h3>
<p>Lorsqu'elles ne sont plus utilis�es, les connexions aux bases de
donn�es doivent �tre ferm�es avec <code>database:close()</code>. 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 :
</p>
<pre class="prettyprint lang-lua">-- 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</pre>
<h3><a name="database_caveat" id="database_caveat">Pr�cautions � prendre lorsque l'on travaille avec les bases
de donn�es</a></h3>
<p>Bien que les fonctions <code>query</code> et <code>run</code>
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
<code>run</code> et <code>query</code> 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 <code>db:prepare</code> ou
<code>db:prepared</code>.
</p>
</div>
<div class="directive-section"><h2><a name="luaauthzprovider" id="luaauthzprovider">Directive</a> <a name="LuaAuthzProvider" id="LuaAuthzProvider">LuaAuthzProvider</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Branche une fonction fournisseur d'autorisation dans <code class="module"><a href="/mod/mod_authz_core.html">mod_authz_core</a></code>
</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Disponible depuis la version 2.4.3 du serveur HTTP Apache</td></tr>
</table>
<p>Lorsqu'une fonction lua a �t� enregistr�e en tant que fournisseur
d'autorisation, elle peut �tre appel�e via la directive <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> :</p>
LuaAuthzProvider foo authz.lua authz_check_foo
<Location />
Require foo johndoe
</Location></pre>
<pre class="prettyprint lang-lua">require "apache2"
function authz_check_foo(r, who)
if r.user ~= who then return apache2.AUTHZ_DENIED
return apache2.AUTHZ_GRANTED
end</pre>
</div>
<div class="directive-section"><h2><a name="luacodecache" id="luacodecache">Directive</a> <a name="LuaCodeCache" id="LuaCodeCache">LuaCodeCache</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure le cache de code compil�.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaCodeCache stat|forever|never</code></td></tr>
<tr><th><a href="directive-dict.html#Default">D�faut:</a></th><td><code>LuaCodeCache stat</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table><p>
Cette directive permet de d�finir le comportement du cache de code
en m�moire. La valeur par d�faut est stat ; dans ce cas, le script
du niveau le plus haut (et pas les scripts inclus) est v�rifi� �
chaque fois que ce fichier est n�cessaire, et est recharg� si la
date de modification est plus r�cente que celle du script d�j�
charg�. Les autres valeurs permettent respectivement de garder le
fichier en cache perp�tuellement (forever - jamais v�rifi� ni
remplac�), ou de ne jamais le mettre en cache (never).</p>
<p>En g�n�ral, les valeurs stat et forever sont utilis�es pour un
serveur en production, et les valeurs stat ou never pour un serveur
en d�veloppement.</p>
<div class="example"><h3>Exemples :</h3><pre class="prettyprint lang-config">LuaCodeCache stat
LuaCodeCache forever
LuaCodeCache never</pre>
</div>
</div>
<div class="directive-section"><h2><a name="luahookaccesschecker" id="luahookaccesschecker">Directive</a> <a name="LuaHookAccessChecker" id="LuaHookAccessChecker">LuaHookAccessChecker</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase access_checker du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Le troisi�me argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</td></tr>
</table>
<p>Ajoute votre fonction d'accroche � la phase access_checker. Une
fonction d'accroche access checker renvoie en g�n�ral OK, DECLINED, ou
HTTP_FORBIDDEN.</p>
<div class="note"><h3>Ordonnancement</h3><p>Les arguments optionnels
"early" ou "late" permettent de contr�ler le moment auquel ce script
s'ex�cute par rapport aux autres modules.</p></div>
</div>
<div class="directive-section"><h2><a name="luahookauthchecker" id="luahookauthchecker">Directive</a> <a name="LuaHookAuthChecker" id="LuaHookAuthChecker">LuaHookAuthChecker</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase auth_checker du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Le troisi�me argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</td></tr>
</table>
<p>Invoque une fonction lua au cours de la phase auth_checker du
traitement de la requ�te. Cette directive peut s'utiliser pour
impl�menter une v�rification arbitraire de l'authentification et de
l'autorisation. Voici un exemple tr�s simple :
</p>
<pre class="prettyprint lang-lua">require 'apache2'
-- fonction d'accroche authcheck fictive
-- Si la requ�te ne contient aucune donn�e d'authentification, l'en-t�te
-- de la r�ponse est d�fini et un code 401 est renvoy� afin de demander au
-- navigateur d'effectuer une authentification basique. Si la requ�te
-- comporte des donn�es d'authentification, elles ne sont pas vraiment
-- consult�es, mais on admet la prise en compte de l'utilisateur 'foo' et
-- on la valide. On v�rifie ensuite si l'utilisateur est bien 'foo' et on
-- accepte la requ�te.
function authcheck_hook(r)
-- recherche des informations d'authentification
auth = r.headers_in['Authorization']
if auth ~= nil then
-- d�finition d'un utilisateur par d�faut
r.user = 'foo'
end
if r.user == nil then
r:debug("authcheck: user is nil, returning 401")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return 401
elseif r.user == "foo" then
r:debug('user foo: OK')
else
r:debug("authcheck: user='" .. r.user .. "'")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return 401
end
return apache2.OK
end</pre>
<div class="note"><h3>Ordonnancement</h3><p>Les arguments optionnels
"early" ou "late" permettent de contr�ler le moment auquel ce script
s'ex�cute par rapport aux autres modules.</p></div>
</div>
<div class="directive-section"><h2><a name="luahookcheckuserid" id="luahookcheckuserid">Directive</a> <a name="LuaHookCheckUserID" id="LuaHookCheckUserID">LuaHookCheckUserID</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase check_user_id du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
</div>
<div class="directive-section"><h2><a name="luahookfixups" id="luahookfixups">Directive</a> <a name="LuaHookFixups" id="LuaHookFixups">LuaHookFixups</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase de correction du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>
Idem LuaHookTranslateName, mais s'ex�cute durant la phase de
correction.
</p>
</div>
<div class="directive-section"><h2><a name="luahookinsertfilter" id="luahookinsertfilter">Directive</a> <a name="LuaHookInsertFilter" id="LuaHookInsertFilter">LuaHookInsertFilter</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase insert_filter du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table><p>Non encore impl�ment�</p>
</div>
<div class="directive-section"><h2><a name="luahooklog" id="luahooklog">Directive</a> <a name="LuaHookLog" id="LuaHookLog">LuaHookLog</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Permet une insertion dans la phase de journalisation du
traitement d'une requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookLog /path/to/lua/script.lua log_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>
Ce dispositif d'insertion simple permet d'ex�cuter une fonction
lorsque httpd entre dans la phase de journalisation du traitement
d'une requ�te. Vous pouvez ainsi ajouter des donn�es � vos propres
entr�es de journalisation, manipuler les entr�es du journal standard
avant leur enregistrement ou emp�cher l'enregistrement d'une entr�e
dans le journal. Pour emp�cher l'enregistrement normal des entr�es
gestionnaire de journalisation, ou au contraire, renvoyez
normale.
</p>
<p>Exemple :</p>
function logger(r)
-- on joue � pile ou face :
-- Si on obtient 1, on �crit dans notre propre journal Lua et on dit
-- � httpd de ne pas enregistrer d'entr�e dans le journal standard..
-- Si on obtient 2, on nettoie un peu les donn�es avant que httpd ne
-- les enregistre dans le journal standard.
if math.random(1,2) == 1 then
-- On effectue notre propre journalisation et le journal
-- standard n'est pas aliment�
if f then
f:write("Quelque chose de secret est arriv� � " .. r.uri .. "\n")
f:close()
end
return apache2.DONE -- On dit � httpd de ne rien enregistrer
--dans le journal standard
else
return apache2.OK -- et httpd doit alors les enregistrer.
end
end</pre>
</div>
<div class="directive-section"><h2><a name="luahookmaptostorage" id="luahookmaptostorage">Directive</a> <a name="LuaHookMapToStorage" id="LuaHookMapToStorage">LuaHookMapToStorage</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase map_to_storage du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Identique � la directive
<code class="directive">LuaHookTranslateName</code>, mais s'ex�cute � la
phase map-to-storage du traitement de la requ�te. Les modules comme
mod_cache agissent pendant cette phase, ce qui permet de pr�senter
un exemple int�ressant de ce que l'on peut faire ici :</p>
<pre class="prettyprint lang-lua">require"apache2"
cached_files = {}
function read_file(filename)
local input = io.open(filename, "r")
if input then
local data = input:read("*a")
cached_files[filename] = data
file = cached_files[filename]
input:close()
end
return cached_files[filename]
end
function check_cache(r)
if r.filename:match("%.png$") then -- Ne concerne que les fichiers PNG
local file = cached_files[r.filename] -- V�rifie les entr�es du cache
if not file then
file = read_file(r.filename) -- Lit le fichier vers le cache
end
if file then -- Si le fichier existe, on l'envoie
r.status = 200
r:write(file)
r:info(("%s a �t� envoy� au client depuis le cache"):format(r.filename))
return apache2.DONE -- cout-circuite le gestionnaire par d�faut des fichiers PNG
end
end
return apache2.DECLINED -- Si nous n'avons rien eu � faire, nous laissons les autres s'en charger
end</pre>
</div>
<div class="directive-section"><h2><a name="luahooktranslatename" id="luahooktranslatename">Directive</a> <a name="LuaHookTranslateName" id="LuaHookTranslateName">LuaHookTranslateName</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e � la phase du nom de
traduction du traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Le troisi�me argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</td></tr>
</table><p>
Cette directive permet d'ajouter un point d'entr�e (�
APR_HOOK_MIDDLE) � la phase du nom de traduction du traitement de la
requ�te. La fonction hook accepte un seul argument, le request_rec,
et doit renvoyer un code d'�tat qui est soit un code d'erreur HTTP,
ou une constante d�finie dans le module apache2 : apache2.OK,
<p>Pour ceux qui ne sont pas familiers avec les points d'entr�e
(hook), en gros, chaque hook sera invoqu� jusqu'� 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�te doit �tre interrompu, la valeur renvoy�e
doit �tre apache2.DONE.</p>
<p>Exemple :</p>
require "apache2"
function silly_mapper(r)
if r.uri == "/" then
return apache2.OK
else
return apache2.DECLINED
end
end</pre>
<div class="note"><h3>Contexte</h3><p>Cette directive ne peut �tre
utilis�e ni � l'int�rieur d'une section <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> ou <code class="directive"><a href="/mod/core.html#files"><Files></a></code>, ni dans un fichier htaccess.</p></div>
<div class="note"><h3>Ordonnancement</h3><p>Les arguments optionnels
"early" ou "late" permettent de contr�ler le moment auquel ce script
s'ex�cute par rapport aux autres modules.</p></div>
</div>
<div class="directive-section"><h2><a name="luahooktypechecker" id="luahooktypechecker">Directive</a> <a name="LuaHookTypeChecker" id="LuaHookTypeChecker">LuaHookTypeChecker</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la phase type_checker du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table><p>...</p>
</div>
<div class="directive-section"><h2><a name="luainherit" id="luainherit">Directive</a> <a name="LuaInherit" id="LuaInherit">LuaInherit</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Contr�le la mani�re dont les sections de configuration
parentes sont fusionn�es dans les enfants</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaInherit none|parent-first|parent-last</code></td></tr>
<tr><th><a href="directive-dict.html#Default">D�faut:</a></th><td><code>LuaInherit parent-first</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Versions 2.4.0 et sup�rieures</td></tr>
</table><p>Par d�faut, si des directives LuaHook* se trouvent dans
des sections de configuration Directory ou Location qui se
chevauchent, les scripts
d�finis dans les sections les plus sp�cifiques s'ex�cutent
<em>apr�s</em> ceux d�finis dans les sections plus g�n�riques
(LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
en sorte que le contexte parent ne s'applique pas du tout.</p>
<p>Jusqu'aux versions 2.3.x, le comportement par d�faut consistait �
ignorer les directives LuaHook* situ�es dans les sections de
configuration parentes.</p>
</div>
<div class="directive-section"><h2><a name="luainputfilter" id="luainputfilter">Directive</a> <a name="LuaInputFilter" id="LuaInputFilter">LuaInputFilter</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit une fonction Lua pour le filtrage en entr�e</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaInputFilter filter_name /path/to/lua/script.lua function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Disponible depuis la version 2.4.5 du serveur HTTP
Apache</td></tr>
</table>
<p>Cette directive permet d'ajouter un filtre en entr�e sous la forme
d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
entr�e fonctionnent comme des sous-routines, intervenant dans un premier
temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
paquet de donn�es doit �tre transmis � la cha�ne, et �ventuellement
produisant toute donn�e � ajouter aux donn�es en entr�e. La variable
globale <code>bucket</code> contient les paquets de donn�es tels qu'ils
sont transmis au script Lua :
</p>
<Files *.lua>
SetInputFilter myInputFilter
</Files></pre>
<pre class="prettyprint lang-lua">--[[
Exemple de filtre en entr�e qui convertit toutes les donn�es POST en
majuscules.
]]--
function input_filter(r)
print("luaInputFilter called") -- pour d�bogage
coroutine.yield() -- attend des paquets de donn�es
while bucket do -- Pour chaque paquet, faire ...
local output = string.upper(bucket) -- Convertit toutes les donn�es POST en majuscules
coroutine.yield(output) -- Envoie les donn�es trait�es � la cha�ne de filtrage
end
-- plus aucune donn�e � traiter.
coroutine.yield("&filterSignature=1234") -- Ajoute une signature � la fin
end</pre>
<p>
Le filtre en entr�e peut interdire ou sauter un filtre s'il est
consid�r� comme ind�sirable :
</p>
<pre class="prettyprint lang-lua">function input_filter(r)
if not good then
return -- Emp�che tout simplement le filtrage et transmet le contenu original
end
coroutine.yield() -- attend des paquets de donn�es
... -- insert les filtres ici
end</pre>
<p>
Voir "<a href="#modifying_buckets">Modification de contenu avec les
filtres Lua</a>" pour plus de d�tails.
</p>
</div>
<div class="directive-section"><h2><a name="luamaphandler" id="luamaphandler">Directive</a> <a name="LuaMapHandler" id="LuaMapHandler">LuaMapHandler</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Met en correspondance un chemin avec un gestionnaire lua</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
[nom-fonction]</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Cette directive permet de faire correspondre un mod�le d'uri avec
une fonction de gestionnaire situ�e dans un fichier sp�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�mes de s�curit� en �crivant vos expressions
rationnelles.</p>
<div class="example"><h3>Exemples :</h3><pre class="prettyprint lang-config">LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2</pre>
</div>
<p>Cette directive va faire correspondre des uri comme
fonction de gestionnaire handle_show au niveau de la vm lua
apr�s chargement de ce fichier.</p>
<p>Cette directive invoquera la fonction "handle" qui est la
valeur par d�faut si aucun nom de fonction sp�cifique n'est
sp�cifi�.</p>
</div>
<div class="directive-section"><h2><a name="luaoutputfilter" id="luaoutputfilter">Directive</a> <a name="LuaOutputFilter" id="LuaOutputFilter">LuaOutputFilter</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit une fonction Lua pour le filtrage de contenu en
sortie</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur</td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibilit�:</a></th><td>Disponible � partir de la version 2.4.5 du serveur HTTP
Apache</td></tr>
</table>
<p>>Cette directive permet d'ajouter un filtre en sortie sous la forme
d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
entr�e fonctionnent comme des sous-routines, intervenant dans un premier
temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
paquet de donn�es doit �tre transmis � la cha�ne, et �ventuellement
produisant toute donn�e � ajouter aux donn�es en sortie. La variable
globale <code>bucket</code> contient les paquets de donn�es tels qu'ils
sont transmis au script Lua :
</p>
<Files *.lua>
SetOutputFilter myOutputFilter
</Files></pre>
<pre class="prettyprint lang-lua">--[[
Exemple de filtre en sortie qui �chappe toutes les entit�s HTML en
sortie
]]--
function output_filter(r)
coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Ajoute des donn�es au d�but de la sortie,
-- puis attend des paquets de donn�es � traiter
while bucket do -- Pour chaque paquet, faire ...
local output = r:escape_html(bucket) -- Echappe les donn�es en sortie
coroutine.yield(output) -- Envoie les donn�es trait�es � la cha�ne
end
-- plus aucune donn�e � traiter.
end</pre>
<p>
Comme les filres en entr�e, le filtre en sortie peut interdire ou sauter un filtre s'il est
consid�r� comme ind�sirable :
</p>
<pre class="prettyprint lang-lua">function output_filter(r)
return -- Emp�che tout simplement le filtrage et transmet le contenu original
end
coroutine.yield() -- attend des paquets de donn�es
... -- insert les filtres ici
end</pre>
<div class="note"><h3>Les filtres Lua avec <code class="module"><a href="/mod/mod_filter.html">mod_filter</a></code></h3>
<p>Lorsqu'on utilise un filtre Lua comme fournisseur sous-jacent via la
directive <code class="directive"><a href="/mod/mod_filter.html#filterprovider">FilterProvider</a></code>, le
filtrage ne fonctionnera que si <var>filter-name</var> est identique �
<var>provider-name</var>.
</p> </div>
<p>
Voir "<a href="#modifying_buckets">Modification de contenu avec les
filtres Lua</a>" pour plus de d�tails.
</p>
</div>
<div class="directive-section"><h2><a name="luapackagecpath" id="luapackagecpath">Directive</a> <a name="LuaPackageCPath" id="LuaPackageCPath">LuaPackageCPath</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ajoute un r�pertoire au package.cpath de lua</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaPackageCPath /chemin/vers/include/?.soa</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Cette directive permet d'ajouter un chemin � la liste des chemins
de recherche des biblioth�ques partag�es de lua. Ceci modifie le
package.cpath dans les vms lua.</p>
</div>
<div class="directive-section"><h2><a name="luapackagepath" id="luapackagepath">Directive</a> <a name="LuaPackagePath" id="LuaPackagePath">LuaPackagePath</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ajoute un r�pertoire au package.path de lua</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaPackagePath /chemin/vers/include/?.lua</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table><p>Cette directive permet d'ajouter un chemin � la liste des
chemins de recherche du module lua. Elle suit les m�mes conventions
que lua. Ceci modifie le package.path dans les vms lua.</p>
<div class="example"><h3>Exemples :</h3><pre class="prettyprint lang-config">LuaPackagePath /scripts/lib/?.lua
</div>
</div>
<div class="directive-section"><h2><a name="luaquickhandler" id="luaquickhandler">Directive</a> <a name="LuaQuickHandler" id="LuaQuickHandler">LuaQuickHandler</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Fournit un point d'entr�e pour la gestion rapide du
traitement de la requ�te</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaQuickHandler /path/to/script.lua hook_function_name</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Cette phase s'ex�cute juste apr�s l'attribution de la requ�te �
un serveur virtuel, et permet d'effectuer certains traitements avant
le d�roulement des autres phases, ou de servir une requ�te sans
avoir � la traduire, l'associer � un espace de stockage, etc...
Comme cette phase s'ex�cute avant toute autre, les directives telles
sont pas encore prises en compte, car Les URI n'ont pas encore �t�
enti�rement interpr�t�s.
</p>
<div class="note"><h3>Contexte</h3><p>Cette directive ne peut �tre
utilis�e ni � l'int�rieur d'une section <code class="directive"><a href="/mod/core.html#directory"><Directory></a></code> ou <code class="directive"><a href="/mod/core.html#files"><Files></a></code>, ni dans un fichier htaccess.</p></div>
</div>
<div class="directive-section"><h2><a name="luaroot" id="luaroot">Directive</a> <a name="LuaRoot" id="LuaRoot">LuaRoot</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sp�cifie le chemin de base pour la r�solution des chemins
relatifs dans les directives de mod_lua</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaRoot /chemin/vers/un/r�pertoire</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Cette directive permet de sp�cifier le chemin de base qui sera
utilis� pour �valuer tous les chemins relatifs dans mod_lua. En
l'absence de cette directive, les chemins relatifs sont r�solus par
rapport au r�pertoire de travail courant, ce qui ne sera pas
toujours appropri� pour un serveur.</p>
</div>
<div class="directive-section"><h2><a name="luascope" id="luascope">Directive</a> <a name="LuaScope" id="LuaScope">LuaScope</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Une valeur parmi once, request, conn, thread -- la valeur par d�faut est once</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>LuaScope once|request|conn|thread|server [min] [max]</code></td></tr>
<tr><th><a href="directive-dict.html#Default">D�faut:</a></th><td><code>LuaScope once</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire, .htaccess</td></tr>
</table>
<p>Cette directive permet de sp�cifier la dur�e de vie de
l'interpr�teur Lua qui sera utilis� dans ce "r�pertoire". La valeur
par d�faut est "once".</p>
<dl>
<dt>once:</dt> <dd>utilise l'interpr�teur une fois.</dd>
<dt>request:</dt> <dd>utilise l'interpr�teur pour traiter tout ce
qui est bas� sur le m�me fichier dans la requ�te, et qui se trouve
aussi dans la port�e de la requ�te.</dd>
<dt>conn:</dt> <dd>idem request, mais attach� � connection_rec</dd>
<dt>thread:</dt> <dd>Utilise l'interpr�teur pendant toute la dur�e
de vie du thread qui traite la requ�te (disponible seulement avec
les MPMs thread�s).</dd>
<dt>server:</dt> <dd>Le comportement est ici diff�rent, car la
port�e du serveur pr�sente une dur�e de vie assez longue, et
plusieurs threads vont partager le m�me server_rec. Pour g�rer tout
ceci, les �tats lua du serveur sont stock�s dans une liste de ressources
apr. Les arguments <code>min</code> et <code>max</code> permettent
de sp�cifier les nombres minimaux et maximaux d'�tats lua � stocker
dans la liste.</dd>
</dl>
<p>En g�n�ral, les port�es <code>thread</code> et <code>server</code>
sont 2 � 3 fois plus rapides que les autres, car elles n'ont pas besoin
de r�g�n�rer de nouveaux �tats Lua � chaque requ�te (comme c'est le
cas avec le MPM event, o� m�me les connexions persistantes utilisent un
nouveau thread pour chaque requ�te). Si vous pensez que vos scripts
n'auront pas de probl�me s'il r�utilisent un �tat, alors les port�es
<code>thread</code> ou <code>server</code> doivent �tre utilis�es car
elles pr�senteront de meilleures performances. Alors que la port�e
<code>thread</code> fournira les r�ponses les plus rapides, la port�e
<code>server</code> utilisera moins de m�moire car les �tats sont
rassembl�s dans des jeux, permettant par exemple � 1000 threads de
partager 100 �tats Lua, ne n�cessitant ainsi que 10% de la m�moire
requise par la port�e <code>thread</code>.
</p>
</div>
</div>
<div class="bottomlang">
<p><span>Langues Disponibles: </span><a href="/en/mod/mod_lua.html" hreflang="en" rel="alternate" title="English"> en </a> |
</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Commentaires</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
var comments_shortname = 'httpd';
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_lua.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
}
else {
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
}
})(window, document);
//--><!]]></script></div><div id="footer">
<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Autoris� sous <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>