599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<?xml version="1.0"?>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<?xml-stylesheet type="text/xsl" href="/style/manual.fr.xsl"?>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<modulesynopsis metafile="mod_lua.xml.meta">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<name>mod_lua</name>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<description>Fournit des points d'entr&eacute;e Lua dans diff&eacute;rentes parties du

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Grafftraitement des requ&ecirc;tes httpd</description>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<status>Experimental</status>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<sourcefile>mod_lua.c</sourcefile>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<identifier>lua_module</identifier>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<compatibility>versions 2.3 et sup&eacute;rieures</compatibility>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<summary>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>Ce module permet d'ajouter au serveur des extensions sous forme de

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffscripts &eacute;crits dans le langage de programmation Lua.

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<module>mod_lua</module> fournit de nombreuses extensions

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff(hooks) disponibles avec les modules natifs du serveur HTTP Apache,

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffcomme les associations de requ&ecirc;tes &agrave; des fichiers, la g&eacute;n&eacute;ration de

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffr&eacute;ponses dynamiques, le contr&ocirc;le d'acc&egrave;s, l'authentification et

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffl'autorisation.</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>Vous trouverez davantage d'informations &agrave; propos du langage de

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffprogrammation Lua sur <a href="http://www.lua.org/">le site web de

599c6d44f4d41aab5d3da98214492eb26e674b65Michael GraffLua</a>.</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<note><code>mod_lua</code> est encore au stade exp&eacute;rimental. Son mode

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffd'utilisation et son comportement pourront changer &agrave; tout moment jusqu'&agrave;

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffce qu'il passe au stade stable, et ce m&ecirc;me entre deux versions stables

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise &agrave;

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffjour.</note>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</summary>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<section id="basicconf"><title>Configuration de base</title>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>La directive de base pour le chargement du module est</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<highlight language="config">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff LoadModule lua_module modules/mod_lua.so

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</highlight>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<code>AddHandler</code> :</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<highlight language="config">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael GraffAddHandler lua-script .lua

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</highlight>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael GraffCeci aura pour effet de faire traiter les requ&ecirc;tes pour les fichiers

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffdont l'extension est <code>.lua</code> par <code>mod_lua</code> en

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffinvoquant cette fonction de <code>gestion</code> de fichier.

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<directive>LuaMapHandler</directive>.

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff </p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</section>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffr&eacute;ponse. <module>mod_proxy</module>, <module>mod_cgi</module> et

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffgestionnaire.</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<highlight language="lua">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<strong>example.lua</strong><br/>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff-- exemple de gestionnaire

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffrequire "string"

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff--[[

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff voir les noms de fonctions optionnels dans la directive

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff--]]

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Grafffunction handle(r)

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff r.content_type = "text/plain"

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff if r.method == 'GET' then

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff end

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff elseif r.method == 'POST' then

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff end

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff else

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff r:puts("Unsupported HTTP method " .. r.method)

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff end

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffend

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</highlight>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffd'un formulaire dans un page au format texte.

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<p>

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff</section>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<section id="writingauthzproviders">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<title>Ecriture de fournisseurs d'autorisation</title>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffde haut niveau bien plus facile &agrave; utiliser que dans les hooks

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffcorrespondants. Le premier argument de la directive <directive

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Grafffournisseur d'autorisation &agrave; utiliser. Pour chaque directive <directive

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffmodule="mod_authz_core">Require</directive>,

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<module>mod_authz_core</module> appellera le fournisseur d'autorisation

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Grafffournisseur consid&eacute;r&eacute; va alors v&eacute;rifier les autorisations et fournir le

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffr&eacute;sultat dans une valeur de retour.</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffrenvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Grafffournisseur authz.</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

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

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

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

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graffl'utilisateur authentifi&eacute; correspond au second argument :</p>

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<highlight language="lua">

599c6d44f4d41aab5d3da98214492eb26e674b65Michael Graff<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. Il existe aussi des accroches &agrave; usage

g&eacute;n&eacute;ral qui s'ex&eacute;cutent simplement &agrave; des moments opportuns du cycle

de vie de la requ&ecirc;te.</p>

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

et unique argument. 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: actuellement, il est impossible de pr&eacute;voir si cette action

s'ex&eacute;cute 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 (voir httpd.h en

attendant que cette documentation soit plus compl&egrave;te), 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">

<tr>

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

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

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

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>boolean</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>table</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>table</td>

<td>oui</td>

</tr>

<tr>

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

<td>table</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>table</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>table</td>

<td>oui</td>

</tr>

<tr>

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

<td>number</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>oui</td>

</tr>

<tr>

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

<td>string</td>

<td>non</td>

</tr>

</table>

<p>La structure request_rec poss&egrave;de (au minimum) les m&eacute;thodes

suivantes :</p>

<highlight language="lua">

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

</highlight>

<highlight language="lua">

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

d'arguments de la requ&ecirc;te

</highlight>

<highlight language="lua">

r:parsebody() -- interpr&egrave;te toutes donn&eacute;es POST de la requ&ecirc;te et

les renvoie sous forme de table Lua

</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>

</dd>

</dl>

</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>

</dl>

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

</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, server -- la valeur

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

<syntax>LuaScope once|request|conn|server [max|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>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 interpr&eacute;teurs sont stock&eacute;s dans une liste de ressources

apr. Les arguments min et max ont &eacute;t&eacute; pr&eacute;vus pour sp&eacute;cifier une

taille de jeu, mais sont inutilis&eacute;s pour le moment.</dd>

</dl>

</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>

<context>directory</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>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookMapToStorage</name>

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

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

<syntax>LuaHookMapToStorage /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>...</p></usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookCheckUserID</name>

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

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

<syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>

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

<context>directory</context><context>.htaccess</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>...</p>

<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>LuaHookTypeChecker</name>

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

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

<syntax>LuaHookTypeChecker /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>...</p></usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookAuthChecker</name>

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

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

<syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>

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

<context>directory</context><context>.htaccess</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>Invoque une fonction lua au cours de la phase auth_checker du

traitement de la requ&ecirc;te. Cette directive peut s'utiliser pour

impl&eacute;menter une v&eacute;rification arbitraire de l'authentification et de

l'autorisation. Voici un exemple tr&egrave;s simple :

</p>

<highlight language="lua">

require 'apache2'

-- fonction d'accroche authcheck fictive

-- Si la requ&ecirc;te ne contient aucune donn&eacute;e d'authentification, l'en-t&ecirc;te

-- de la r&eacute;ponse est d&eacute;fini et un code 401 est renvoy&eacute; afin de demander au

-- navigateur d'effectuer une authentification basique. Si la requ&ecirc;te

-- comporte des donn&eacute;es d'authentification, elles ne sont pas vraiment

-- consult&eacute;es, mais on admet la prise en compte de l'utilisateur 'foo' et

-- on la valide. On v&eacute;rifie ensuite si l'utilisateur est bien 'foo' et on

-- accepte la requ&ecirc;te.

function authcheck_hook(r)

-- recherche des informations d'authentification

auth = r.headers_in['Authorization']

if auth ~= nil then

-- d&eacute;finition d'un utilisateur par d&eacute;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

</highlight>

<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>LuaHookAccessChecker</name>

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

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

<syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>

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

<context>directory</context><context>.htaccess</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>Ajoute votre fonction d'accroche &agrave; la phase access_checker. Une

fonction d'accroche access checker renvoie en g&eacute;n&eacute;ral OK, DECLINED, ou

HTTP_FORBIDDEN.</p>

<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>LuaHookInsertFilter</name>

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

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

<syntax>LuaHookInsertFilter /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>Non encore impl&eacute;ment&eacute;</p></usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaInherit</name>

<description>Contr&ocirc;le la mani&egrave;re dont les sections de configuration

parentes sont fusionn&eacute;es dans les enfants</description>

<syntax>LuaInherit none|parent-first|parent-last</syntax>

<default>LuaInherit parent-first</default>

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

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

</contextlist>

<override>All</override>

<compatibility>Versions 2.4.0 et sup&eacute;rieures</compatibility>

<usage><p>Par d&eacute;faut, si des directives LuaHook* se trouvent dans

des sections de configuration Directory ou Location qui se

chevauchent, les scripts

d&eacute;finis dans les sections les plus sp&eacute;cifiques s'ex&eacute;cutent

<em>apr&egrave;s</em> ceux d&eacute;finis dans les sections plus g&eacute;n&eacute;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&eacute;faut consistait &agrave;

ignorer les directives LuaHook* situ&eacute;es dans les sections de

configuration parentes.</p></usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaQuickHandler</name>

<description>Fournit un point d'entr&eacute;e pour la gestion rapide du

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

<syntax></syntax>

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

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

</contextlist>

<override>All</override>

<usage><p>...</p>

<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>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaAuthzProvider</name>

<description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>

</description>

<syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>

<contextlist><context>server config</context> </contextlist>

<compatibility>Disponible depuis la version 2.5.0 du serveur HTTP Apache</compatibility>

<usage>

<p>Lorsqu'une fonction lua a &eacute;t&eacute; enregistr&eacute;e en tant que fournisseur

d'autorisation, elle peut &ecirc;tre appel&eacute;e via la directive <directive

module="mod_authz_core">Require</directive> :</p>

<example>

<highlight language="config">

LuaRoot /usr/local/apache2/lua

LuaAuthzProvider foo authz.lua authz_check_foo

&lt;Location /&gt;

Require foo bar

&lt;/Location&gt;

</highlight>

</example>

</usage>

</directivesynopsis>

</modulesynopsis>