]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_lua.xml.fr
xforms
[apache] / docs / manual / mod / mod_lua.xml.fr
1 <?xml version="1.0"?>
2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1477000:1490095 (outdated) -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
7
8 <!--
9  Licensed to the Apache Software Foundation (ASF) under one or more
10  contributor license agreements.  See the NOTICE file distributed with
11  this work for additional information regarding copyright ownership.
12  The ASF licenses this file to You under the Apache License, Version 2.0
13  (the "License"); you may not use this file except in compliance with
14  the License.  You may obtain a copy of the License at
15
16      http://www.apache.org/licenses/LICENSE-2.0
17
18  Unless required by applicable law or agreed to in writing, software
19  distributed under the License is distributed on an "AS IS" BASIS,
20  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21  See the License for the specific language governing permissions and
22  limitations under the License.
23 -->
24
25 <modulesynopsis metafile="mod_lua.xml.meta">
26
27 <name>mod_lua</name>
28
29 <description>Fournit des points d'entr&eacute;e Lua dans diff&eacute;rentes parties du
30 traitement des requ&ecirc;tes httpd</description>
31 <status>Experimental</status>
32 <sourcefile>mod_lua.c</sourcefile>
33 <identifier>lua_module</identifier>
34 <compatibility>versions 2.3 et sup&eacute;rieures</compatibility>
35
36 <summary>
37 <p>Ce module permet d'ajouter au serveur des extensions sous forme de
38 scripts &eacute;crits dans le langage de programmation Lua.
39 <module>mod_lua</module> fournit de nombreuses extensions
40 (hooks) disponibles avec les modules natifs du serveur HTTP Apache,
41 comme les associations de requ&ecirc;tes &agrave; des fichiers, la g&eacute;n&eacute;ration de
42 r&eacute;ponses dynamiques, le contr&ocirc;le d'acc&egrave;s, l'authentification et
43 l'autorisation.</p>
44
45 <p>Vous trouverez davantage d'informations &agrave; propos du langage de
46 programmation Lua sur <a href="http://www.lua.org/">le site web de
47 Lua</a>.</p>
48
49 <note><code>mod_lua</code> est encore au stade exp&eacute;rimental. Son mode
50 d'utilisation et son comportement pourront changer &agrave; tout moment jusqu'&agrave;
51 ce qu'il passe au stade stable, et ce m&ecirc;me entre deux versions stables
52 2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise &agrave;
53 jour.</note>
54
55 <note type="warning"><title>Avertissement</title>
56 <p>Ce module poss&egrave;de une grande capacit&eacute; d'action sur le fonctrionnement
57 de httpd, ce qui lui conf&egrave;re une grande puissance, mais peut aussi
58 induire un risque de s&eacute;curit&eacute;. Il est d&eacute;conseill&eacute; d'utiliser ce module
59 sur un serveur partag&eacute; avec des utilisateurs auxquels vous ne pouvez pas
60 accorder une confiance absolue, car il peut permettre de modifier le
61 fonctionnement interne de httpd.</p>
62 </note>
63
64 </summary>
65
66 <section id="basicconf"><title>Configuration de base</title>
67
68 <p>La directive de base pour le chargement du module est</p>
69
70 <highlight language="config">
71     LoadModule lua_module modules/mod_lua.so
72 </highlight>
73
74 <p>
75 <code>mod_lua</code> fournit un gestionnaire nomm&eacute;
76 <code>lua-script</code> qui peut &ecirc;tre utilis&eacute; avec une directive
77 <code>AddHandler</code> :</p>
78
79 <highlight language="config">
80 AddHandler lua-script .lua
81 </highlight>
82
83 <p>
84 Ceci aura pour effet de faire traiter les requ&ecirc;tes pour les fichiers
85 dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
86 invoquant cette fonction de <code>gestion</code> de fichier.
87 </p>
88
89 <p>Pour plus de d&eacute;tails, voir la directive
90 <directive>LuaMapHandler</directive>.
91  </p>
92 </section>
93
94 <section id="writinghandlers"><title>Ecrire des gestionnaires</title>
95 <p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
96 point d'accroche (hook) sp&eacute;cifique responsable de la g&eacute;n&eacute;ration de la
97 r&eacute;ponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
98 <module>mod_status</module> sont des exemples de modules comportant un
99 gestionnaire.</p>
100
101 <p><code>mod_lua</code> cherche toujours &agrave; invoquer une fonction Lua pour le
102 gestionnaire, plut&ocirc;t que de simplement &eacute;valuer le corps d'un script dans
103 le style de CGI. Une fonction de gestionnaire se pr&eacute;sente comme suit :</p>
104
105
106 <highlight language="lua">
107 <strong>example.lua</strong><br/>
108 -- exemple de gestionnaire
109
110 require "string"
111
112 --[[
113      Il s'agit du nom de m&eacute;thode par d&eacute;faut pour les gestionnaires Lua ;
114      voir les noms de fonctions optionnels dans la directive
115      LuaMapHandler pour choisir un point d'entr&eacute;e diff&eacute;rent.
116 --]]
117 function handle(r)
118     r.content_type = "text/plain"
119     r:puts("Hello Lua World!\n")
120
121     if r.method == 'GET' then
122         for k, v in pairs( r:parseargs() ) do
123             r:puts( string.format("%s: %s\n", k, v) )
124         end
125     elseif r.method == 'POST' then
126         for k, v in pairs( r:parsebody() ) do
127             r:puts( string.format("%s: %s\n", k, v) )
128         end
129     else
130         r:puts("Unsupported HTTP method " .. r.method)
131     end
132 end
133 </highlight>
134
135 <p>
136 Ce gestionnaire se contente d'afficher les arguments cod&eacute;s d'un uri ou
137 d'un formulaire dans un page au format texte.
138 </p>
139
140 <p>
141 Cela signifie que vous pouvez (et &ecirc;tes encourag&eacute; &agrave;) avoir plusieurs
142 gestionnaires (ou points d'entr&eacute;e, ou filtres) dans le m&ecirc;me script.
143 </p>
144
145 </section>
146 <section id="writingauthzproviders">
147 <title>Ecriture de fournisseurs d'autorisation</title>
148
149 <p><module>mod_authz_core</module> fournit une interface d'autorisation
150 de haut niveau bien plus facile &agrave; utiliser que dans les hooks
151 correspondants. Le premier argument de la directive <directive
152 module="mod_authz_core">Require</directive> permet de sp&eacute;cifier le
153 fournisseur d'autorisation &agrave; utiliser. Pour chaque directive <directive
154 module="mod_authz_core">Require</directive>,
155 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
156 sp&eacute;cifi&eacute;, le reste de la ligne constituant les param&egrave;tres. Le
157 fournisseur consid&eacute;r&eacute; va alors v&eacute;rifier les autorisations et fournir le
158 r&eacute;sultat dans une valeur de retour.</p>
159
160 <p>En g&eacute;n&eacute;ral, le fournisseur authz est appel&eacute; avant l'authentification.
161 S'il doit conna&icirc;tre le nom d'utilisateur authentifi&eacute; (ou si
162 l'utilisateur est appel&eacute; &agrave; &ecirc;tre authentifi&eacute;), le fournisseur doit
163 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
164 d&eacute;clancher le processus d'authentification et un deuxi&egrave;me appel du
165 fournisseur authz.</p>
166
167 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
168 une adresse IP et un nom d'utilisateur. Elle autorise l'acc&egrave;s dans le
169 cas o&ugrave; la requ&ecirc;te provient de l'adresse IP sp&eacute;cifi&eacute;e, ou si
170 l'utilisateur authentifi&eacute; correspond au second argument :</p>
171
172 <highlight language="lua">
173 <strong>authz_provider.lua</strong><br/>
174
175 require 'apache2'
176
177 function authz_check_foo(r, ip, user)
178     if r.useragent_ip == ip then
179         return apache2.AUTHZ_GRANTED
180     elseif r.user == nil then
181         return apache2.AUTHZ_DENIED_NO_USER
182     elseif r.user == user then
183         return apache2.AUTHZ_GRANTED
184     else
185         return apache2.AUTHZ_DENIED
186     end
187 end
188 </highlight>
189
190 <p>La configuration suivante enregistre cette fonction en tant que
191 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
192 <highlight language="config">
193 LuaAuthzProvider foo authz_provider.lua authz_check_foo
194 &lt;Location /&gt;
195   Require foo 10.1.2.3 john_doe
196 &lt;/Location&gt;
197 </highlight>
198
199 </section>
200
201 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
202 (hooks)</title>
203
204 <p>Les fonctions d'accroche d&eacute;terminent la mani&egrave;re dont les modules (et
205 les scripts Lua) participent au traitement des requ&ecirc;tes. Chaque type
206 d'accroche propos&eacute; par le serveur a un r&ocirc;le sp&eacute;cifique, comme
207 l'association de requ&ecirc;tes au syst&egrave;me de fichiers, le contr&ocirc;le d'acc&egrave;s,
208 ou la d&eacute;finition de types MIME : </p>
209
210 <table border="1" style="zebra">
211     <tr>
212         <th>Phase d'accroche</th>
213         <th>Directive mod_lua</th>
214         <th>Description</th>
215     </tr>
216     <tr>
217         <td>Gestionnaire rapide</td>
218         <td><directive module="mod_lua">LuaQuickHandler</directive></td>
219         <td>Il s'agit de la premi&egrave;re accroche appel&eacute;e lorsqu'une requ&ecirc;te
220         a &eacute;t&eacute; associ&eacute;e &agrave; un serveur ou un serveur virtuel.</td>
221     </tr>
222     <tr>
223         <td>Phase de traduction</td>
224         <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
225         <td>Cette phase traduit l'URI de la requ&ecirc;te en nom de fichier
226         sur le syst&egrave;me. Ce sont des modules comme
227         <module>mod_alias</module> et <module>mod_rewrite</module> qui
228         interviennent au cours de cette phase.</td>
229     </tr>
230     <tr>
231         <td>Choix du lieu de stockage de la ressource</td>
232         <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
233         <td>Cette phase d&eacute;finit le lieu de stockage de la ressource :
234         physique, en cache ou externe/mandat&eacute;. Elle est assur&eacute;e par les
235         modules de mandat ou de mise en cache.</td>
236     </tr>
237     <tr>
238         <td>Autorisation d'acc&egrave;s</td>
239         <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
240         <td>Cette phase v&eacute;rifie si un client a l'autorisation d'acc&egrave;s &agrave;
241         la ressource. Elle s'ex&eacute;cute avant l'authentification de
242         l'utisateur ; il faut donc &ecirc;tre prudent.
243         </td>
244     </tr>
245     <tr>
246         <td>V&eacute;rification de l'identifiant utilisateur</td>
247         <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
248         <td>Cette phase v&eacute;rifie l'identifiant de l'utilisateur ayant
249         fait l'objet d'une n&eacute;gociation.</td>
250     </tr>
251     <tr>
252         <td>V&eacute;rification de l'autorisation d'acc&egrave;s</td>
253         <td><directive module="mod_lua">LuaHookAuthChecker</directive>
254         ou
255             <directive module="mod_lua">LuaAuthzProvider</directive></td>
256         <td>Cette phase v&eacute;rifie l'autorisation d'acc&egrave;s d'un utilisateur
257         en fonction des ses param&egrave;tres de connexion, comme
258         l'identifiant, le certificat, etc...
259         </td>
260     </tr>
261     <tr>
262         <td>V&eacute;rification du type de la ressource</td>
263         <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
264         <td>Cette phase assigne un type de contenu et un gestionnaire &agrave;
265         la ressource.</td>
266     </tr>
267     <tr>
268         <td>Derniers r&eacute;glages</td>
269         <td><directive module="mod_lua">LuaHookFixups</directive></td>
270         <td>C'est la derni&egrave;re phase avant l'activation des gestionnaires
271         de contenu. Toute modification de derni&egrave;re minute &agrave; la requ&ecirc;te
272         doit &ecirc;tre effectu&eacute;e ici.</td>
273     </tr>
274     <tr>
275         <td>Gestionnaire de contenu</td>
276         <td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
277         <td>C'est durant cette phase que le contenu est trait&eacute;. Les
278         fichiers sont lus, interpr&eacute;t&eacute;s, certains sont ex&eacute;cut&eacute;s, et le
279         r&eacute;sultat obtenu est envoy&eacute; au client.</td>
280     </tr>
281     <tr>
282         <td>Journalisation</td>
283         <td>aucune</td>
284         <td>Lorsqu'une requ&ecirc;te a &eacute;t&eacute; trait&eacute;e, plusieurs phases de
285         journalisation interviennent, et enregistrent leurs r&eacute;sultats
286         dans les fichiers d'erreur ou d'acc&egrave;s.</td>
287     </tr>
288
289 </table>
290
291 <p>Les fonctions d'accroche re&ccedil;oivent l'objet de la requ&ecirc;te comme seul
292 argument (sauf LuaAuthzProvider qui re&ccedil;oit aussi des arguments en
293 provenance de la directive Require). Elles peuvent renvoyer une valeur,
294 selon la fonction, mais il s'agit en g&eacute;n&eacute;ral d'un
295 code d'&eacute;tat HTTP ou des valeurs OK, DONE, ou DECLINED,
296 que vous pouvez &eacute;crire dans Lua sous la forme <code>apache2.OK</code>,
297 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
298
299
300 <highlight language="lua">
301 <strong>translate_name.lua</strong><br/>
302 -- exemple d'accroche qui r&eacute;&eacute;crit un URI en chemin du syst&egrave;me de
303 fichiers.
304
305 require 'apache2'
306
307 function translate_name(r)
308     if r.uri == "/translate-name" then
309         r.filename = r.document_root .. "/find_me.txt"
310         return apache2.OK
311     end
312     -- on ne g&egrave;re pas cette URL et on donne sa chance &agrave; un autre module
313     return apache2.DECLINED
314 end
315 </highlight>
316
317
318 <highlight language="lua">
319 <strong>translate_name2.lua</strong><br/>
320 --[[ exemple d'accroche qui r&eacute;&eacute;crit un URI vers un autre URI. Il renvoie
321         un apache2.DECLINED pour permettre &agrave; un autre interpr&eacute;teur d'URL de
322         travailler sur la substitution, y compris l'accroche translate_name
323         de base dont les tables de correspondances se basent sur DocumentRoot.
324
325      Note: utilisez le drapeau early/late de la directive pour
326      l'ex&eacute;cuter avant ou apr&egrave;s mod_alias.
327 --]]
328
329 require 'apache2'
330
331 function translate_name(r)
332     if r.uri == "/translate-name" then
333         r.uri = "/find_me.txt"
334         return apache2.DECLINED
335     end
336     return apache2.DECLINED
337 end
338 </highlight>
339 </section>
340
341 <section id="datastructures"><title>Structures de donn&eacute;es</title>
342
343 <dl>
344 <dt>request_rec</dt>
345         <dd>
346         <p>request_rec est consid&eacute;r&eacute;e en tant que donn&eacute;e utilisateur.
347         Elle poss&egrave;de une m&eacute;tatable qui vous permet d'accomplir des
348         choses int&eacute;ressantes. Pour la plus grande partie, elle poss&egrave;de
349         les m&ecirc;mes champs que la structure request_rec, la
350         plupart d'entre eux &eacute;tant accessibles en lecture et &eacute;criture (le
351         contenu des champs de la table peut &ecirc;tre modifi&eacute;, mais les
352         champs eux-m&ecirc;mes ne peuvent pas &ecirc;tre &eacute;tablis en tant que tables
353         distinctes).</p>
354
355         <table border="1" style="zebra">
356
357         <tr>
358           <th><strong>Nom</strong></th>
359           <th><strong>Type Lua</strong></th>
360           <th><strong>Modifiable</strong></th>
361           <th><strong>Description</strong></th>
362         </tr>
363         <tr>
364           <td><code>allowoverrides</code></td>
365           <td>string</td>
366           <td>non</td>
367           <td>L'option AllowOverride s'applique &agrave; la requ&ecirc;te courante.</td>
368         </tr>
369         <tr>
370           <td><code>ap_auth_type</code></td>
371           <td>string</td>
372           <td>non</td>
373           <td>Ce champ contient le type d'authentification effectu&eacute;e
374           (par exemple <code>basic</code>)</td>
375         </tr>
376         <tr>
377           <td><code>args</code></td>
378           <td>string</td>
379           <td>oui</td>
380           <td>La cha&icirc;ne de param&egrave;tres de la requ&ecirc;te (par exemple
381           <code>foo=bar&amp;name=johnsmith</code>)</td>
382         </tr>
383         <tr>
384           <td><code>assbackwards</code></td>
385           <td>boolean</td>
386           <td>non</td>
387           <td>contient true s'il s'agit d'une requ&ecirc;te de style HTTP/0.9
388           (par exemple <code>GET /foo</code> (sans champs d'en-t&ecirc;te) )</td>
389         </tr>
390         <tr>
391           <td><code>auth_name</code></td>
392           <td>string</td>
393           <td>non</td>
394           <td>La cha&icirc;ne d'identification utilis&eacute;e pour la v&eacute;rification
395           de l'autorisation d'acc&egrave;s (si elle est disponible).</td>
396         </tr>
397         <tr>
398           <td><code>banner</code></td>
399           <td>string</td>
400           <td>non</td>
401           <td>La banni&egrave;re du serveur, par exemple <code>Apache HTTP
402           Server/2.4.3 openssl/0.9.8c</code></td>
403         </tr>
404         <tr>
405           <td><code>basic_auth_pw</code></td>
406           <td>string</td>
407           <td>non</td>
408           <td>Le mot de passe pour l'authentification de base envoy&eacute;
409           avec la requ&ecirc;te, s'il existe</td>
410         </tr>
411         <tr>
412           <td><code>canonical_filename</code></td>
413           <td>string</td>
414           <td>non</td>
415           <td>Le nom de fichier canonique de la requ&ecirc;te</td>
416         </tr>
417         <tr>
418           <td><code>content_encoding</code></td>
419           <td>string</td>
420           <td>non</td>
421           <td>Le type de codage du contenu de la requ&ecirc;te courante</td>
422         </tr>
423         <tr>
424           <td><code>content_type</code></td>
425           <td>string</td>
426           <td>oui</td>
427           <td>Le type de contenu de la requ&ecirc;te courante, tel qu'il a &eacute;t&eacute;
428           d&eacute;termin&eacute; au cours de la phase type_check (par exemple
429           <code>image/gif</code> ou <code>text/html</code>)</td>
430         </tr>
431
432         <tr>
433           <td><code>context_prefix</code></td>
434           <td>string</td>
435           <td>non</td>
436           <td></td>
437         </tr>
438         <tr>
439           <td><code>context_document_root</code></td>
440           <td>string</td>
441           <td>non</td>
442           <td></td>
443         </tr>
444
445         <tr>
446           <td><code>document_root</code></td>
447           <td>string</td>
448           <td>non</td>
449           <td>La racine des documents du serveur</td>
450         </tr>
451         <tr>
452           <td><code>err_headers_out</code></td>
453           <td>table</td>
454           <td>non</td>
455           <td>L'en-t&ecirc;te MIME de l'environnement pour la r&eacute;ponse, &eacute;crit
456           m&ecirc;me en cas d'erreur et conserv&eacute; pendant les redirections
457           internes</td>
458         </tr>
459         <tr>
460           <td><code>filename</code></td>
461           <td>string</td>
462           <td>oui</td>
463           <td>Le nom de fichier correspondant &agrave; la requ&ecirc;te, par exemple
464           /www/example.com/foo.txt. Il peut &ecirc;tre modifi&eacute; au cours des
465           phases translate-name ou map-to-storage du traitement de la
466           requ&ecirc;te pour permettre au gestionnaire par d&eacute;faut (ou aux
467           gestionnaires de script) de servir une version du fichier
468           autre que celle demand&eacute;e.</td>
469         </tr>
470         <tr>
471           <td><code>handler</code></td>
472           <td>string</td>
473           <td>oui</td>
474           <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
475           doit traiter la requ&ecirc;te, par exemple <code>lua-script</code>
476           si elle doit &ecirc;tre trait&eacute;e par mod_lua. Cette valeur est en
477           g&eacute;n&eacute;ral d&eacute;finie via les directives <directive
478           module="mod_mime">AddHandler</directive> ou <directive
479           module="core">SetHandler</directive>, mais peut aussi l'&ecirc;tre
480           via mod_lua pour permettre &agrave; un autre gestionnaire de traiter
481           une requ&ecirc;te sp&eacute;cifique qui ne serait pas trait&eacute;e par d&eacute;faut
482           par ce dernier.
483             </td>
484         </tr>
485         <tr>
486           <td><code>headers_in</code></td>
487           <td>table</td>
488           <td>oui</td>
489           <td>Les en-t&ecirc;tes MIME de l'environnement de la requ&ecirc;te. Il
490           s'agit des en-t&ecirc;tes comme <code>Host, User-Agent,
491           Referer</code>, etc...</td>
492         </tr>
493         <tr>
494           <td><code>headers_out</code></td>
495           <td>table</td>
496           <td>oui</td>
497           <td>Les en-t&ecirc;tes MIME de l'environnement de la r&eacute;ponse.</td>
498         </tr>
499         <tr>
500           <td><code>hostname</code></td>
501           <td>string</td>
502           <td>non</td>
503           <td>Le nom d'h&ocirc;te, tel que d&eacute;fini par l'en-t&ecirc;te
504           <code>Host:</code> ou par un URI complet.</td>
505         </tr>
506         <tr>
507           <td><code>is_https</code></td>
508           <td>boolean</td>
509           <td>non</td>
510           <td>Indique si la requ&ecirc;te &agrave; &eacute;t&eacute; faite via HTTPS</td>
511         </tr>
512         <tr>
513           <td><code>is_initial_req</code></td>
514           <td>boolean</td>
515           <td>non</td>
516           <td>Indique si la requ&ecirc;te courante est la requ&ecirc;te initiale ou
517           une sous-requ&ecirc;te.</td>
518         </tr>
519         <tr>
520           <td><code>limit_req_body</code></td>
521           <td>number</td>
522           <td>non</td>
523           <td>La taille maximale du corps de la requ&ecirc;te, ou 0 si aucune
524           limite.</td>
525         </tr>
526         <tr>
527         <td><code>log_id</code></td>
528           <td>string</td>
529           <td>non</td>
530           <td>L'identifiant de la requ&ecirc;te dans les journaux d'acc&egrave;s ou
531           d'erreur.</td>
532         </tr>
533         <tr>
534           <td><code>method</code></td>
535           <td>string</td>
536           <td>non</td>
537           <td>La m&eacute;thode de la requ&ecirc;te, par exemple <code>GET</code> ou
538           <code>POST</code>.</td>
539         </tr>
540         <tr>
541           <td><code>notes</code></td>
542           <td>table</td>
543           <td>oui</td>
544           <td>Une liste de notes qui peuvent &ecirc;tre transmises d'un module
545           &agrave; l'autre.</td>
546         </tr>
547         <tr>
548           <td><code>options</code></td>
549           <td>string</td>
550           <td>non</td>
551           <td>La valeur de la directive Options pour la requ&ecirc;te
552           courante.</td>
553         </tr>
554         <tr>
555           <td><code>path_info</code></td>
556           <td>string</td>
557           <td>non</td>
558           <td>La valeur de PATH_INFO extraite de la requ&ecirc;te.</td>
559         </tr>
560         <tr>
561           <td><code>port</code></td>
562           <td>number</td>
563           <td>non</td>
564           <td>Le port du serveur utilis&eacute; par la requ&ecirc;te.</td>
565         </tr>
566         <tr>
567           <td><code>protocol</code></td>
568           <td>string</td>
569           <td>non</td>
570           <td>Le protocole utilis&eacute;, par exemple <code>HTTP/1.1</code></td>
571         </tr>
572         <tr>
573           <td><code>proxyreq</code></td>
574           <td>string</td>
575           <td>oui</td>
576           <td>Indique s'il s'agit d'une requ&ecirc;te mandat&eacute;e ou non. Cette
577           valeur est en g&eacute;n&eacute;ral d&eacute;finie au cours de la phase
578           post_read_request/translate_name du traitement de la requ&ecirc;te.</td>
579         </tr>
580         <tr>
581           <td><code>range</code></td>
582           <td>string</td>
583           <td>non</td>
584           <td>Le contenu de l'en-t&ecirc;te <code>Range:</code>.</td>
585         </tr>
586         <tr>
587           <td><code>remaining</code></td>
588           <td>number</td>
589           <td>non</td>
590           <td>Le nombre d'octets du corps de la requ&ecirc;te restant &agrave; lire.</td>
591         </tr>
592         <tr>
593           <td><code>server_built</code></td>
594           <td>string</td>
595           <td>non</td>
596           <td>La date de compilation du serveur.</td>
597         </tr>
598         <tr>
599           <td><code>server_name</code></td>
600           <td>string</td>
601           <td>non</td>
602           <td>Le nom du serveur pour cette requ&ecirc;te.</td>
603         </tr>
604         <tr>
605           <td><code>some_auth_required</code></td>
606           <td>boolean</td>
607           <td>non</td>
608           <td>Indique si une autorisation est/&eacute;tait requise pour cette
609           requ&ecirc;te.</td>
610         </tr>
611         <tr>
612           <td><code>subprocess_env</code></td>
613           <td>table</td>
614           <td>oui</td>
615           <td>Le jeu de variables d'environnement pour cette requ&ecirc;te.</td>
616         </tr>
617         <tr>
618           <td><code>started</code></td>
619           <td>number</td>
620           <td>non</td>
621           <td>Le moment o&ugrave; le serveur a &eacute;t&eacute; (re)d&eacute;marr&eacute;, en secondes
622           depuis epoch (1er janvier 1970)</td>
623         </tr>
624         <tr>
625           <td><code>status</code></td>
626           <td>number</td>
627           <td>oui</td>
628           <td>Le code de retour (courant) pour cette requ&ecirc;te, par
629           exemple <code>200</code> ou <code>404</code>.</td>
630         </tr>
631         <tr>
632           <td><code>the_request</code></td>
633           <td>string</td>
634           <td>non</td>
635           <td>La cha&icirc;ne de la requ&ecirc;te telle qu'elle a &eacute;t&eacute; envoy&eacute;e par le
636           client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
637         </tr>
638         <tr>
639           <td><code>unparsed_uri</code></td>
640           <td>string</td>
641           <td>non</td>
642           <td>La partie URI non interpr&eacute;t&eacute;e de la requ&ecirc;te</td>
643         </tr>
644         <tr>
645           <td><code>uri</code></td>
646           <td>string</td>
647           <td>oui</td>
648           <td>L'URI apr&egrave;s interpr&eacute;tation par httpd</td>
649         </tr>
650         <tr>
651           <td><code>user</code></td>
652           <td>string</td>
653           <td>oui</td>
654           <td>Si une authentification a &eacute;t&eacute; effectu&eacute;e, nom de
655           l'utilisateur authentifi&eacute;.</td>
656         </tr>
657         <tr>
658           <td><code>useragent_ip</code></td>
659           <td>string</td>
660           <td>non</td>
661           <td>L'adresse IP de l'agent qui a envoy&eacute; la requ&ecirc;te</td>
662         </tr>
663         </table>
664         </dd>
665     </dl>
666 </section>
667 <section id="functions"><title>M&eacute;thodes de l'objet request_rec</title>
668
669 <p>L'objet request_rec poss&egrave;de (au minimum) les m&eacute;thodes suivantes :</p>
670
671 <highlight language="lua">
672 r:flush()   -- vide le tampon de sortie
673             -- Renvoie true si le vidage a &eacute;t&eacute; effectu&eacute; avec succ&egrave;s,
674             false dans le cas contraire.
675
676 while nous_avons_des_donn&eacute;es_&agrave;_envoyer do
677     r:puts("Bla bla bla\n") -- envoi des donn&eacute;es &agrave; envoyer vers le tampon
678     r:flush() -- vidage du tampon (envoi au client)
679     r:sleep(0.5) -- mise en attente et bouclage
680 end
681 </highlight>
682
683 <highlight language="lua">
684 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
685
686 r:addoutputfilter("fooFilter") -- ins&egrave;re le filtre fooFilter dans le flux de sortie
687 </highlight>
688
689 <highlight language="lua">
690 r:sendfile(filename) -- envoie un fichier entier au client en
691 utilisant sendfile s'il est support&eacute; par la plateforme :
692
693 if use_sendfile_thing then
694     r:sendfile("/var/www/large_file.img")
695 end
696 </highlight>
697
698 <highlight language="lua">
699 r:parseargs() -- renvoie deux tables : une table standard de couples
700 cl&eacute;/valeur pour les donn&eacute;es GET simples, et une autre pour les donn&eacute;es
701 multivalu&eacute;es (par exemple foo=1&amp;foo=2&amp;foo=3) :
702
703 local GET, GETMULTI = r:parseargs()
704 r:puts("Votre nom est : " .. GET['name'] or "Unknown")
705 </highlight>
706
707
708 <highlight language="lua">
709 r:parsebody()([sizeLimit]) -- interpr&egrave;te le corps de la requ&ecirc;te
710 en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
711 peut &ecirc;tre fourni pour sp&eacute;cifier le nombre maximal d'octets &agrave;
712 interpr&eacute;ter. La valeur par d&eacute;faut est 8192.
713
714 local POST, POSTMULTI = r:parsebody(1024*1024)
715 r:puts("Votre nom est : " .. POST['name'] or "Unknown")
716 </highlight>
717
718
719 <highlight language="lua">
720 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la r&eacute;ponse
721 </highlight>
722
723 <highlight language="lua">
724 r:write("une simple cha&icirc;ne") -- affichage dans le
725 corps de la r&eacute;ponse
726 </highlight>
727
728 <highlight language="lua">
729 r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Echappe le
730 code HTML et renvoie le r&eacute;sultat
731 </highlight>
732
733 <highlight language="lua">
734 r:base64_encode(string) -- Encode une cha&icirc;ne &agrave; l'aide du
735 standard de codage Base64.
736
737 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
738 </highlight>
739
740 <highlight language="lua">
741 r:base64_decode(string) -- D&eacute;code une cha&icirc;ne cod&eacute;e en Base64.
742
743 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
744 </highlight>
745
746 <highlight language="lua">
747 r:md5(string) -- Calcule et renvoie le condens&eacute; MD5 d'une cha&icirc;ne
748 en mode binaire (binary safe).
749
750 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
751 </highlight>
752
753 <highlight language="lua">
754 r:sha1(string) -- Calcule et renvoie le condens&eacute; SHA1 d'une cha&icirc;ne
755 en mode binaire (binary safe).
756
757 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
758 </highlight>
759
760 <highlight language="lua">
761 r:escape(string) -- Echappe une cha&icirc;ne de type URL.
762
763 local url = "http://foo.bar/1 2 3 &amp; 4 + 5"
764 local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
765 </highlight>
766
767 <highlight language="lua">
768 r:unescape(string) -- D&eacute;s&eacute;chappe une cha&icirc;ne de type URL.
769
770 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
771 local unescaped = r:escape(url) -- returns 'http://foo.bar/1 2 3 &amp; 4 + 5'
772 </highlight>
773
774 <highlight language="lua">
775 r:mpm_query(number) -- Interroge le serveur &agrave; propos de son
776 module MPM via la requ&ecirc;te ap_mpm_query.
777
778 local mpm = r.mpm_query(14)
779 if mpm == 1 then
780     r:puts("Ce serveur utilise le MPM Event")
781 end
782 </highlight>
783
784 <highlight language="lua">
785 r:expr(string) -- Evalue une cha&icirc;ne de type <a
786 href="../expr.html">expr</a>.
787
788 if r:expr("%{HTTP_HOST} =~ /^www/") then
789     r:puts("Ce nom d'h&ocirc;te commence par www")
790 end
791 </highlight>
792
793 <highlight language="lua">
794 r:scoreboard_process(a) -- Interroge le serveur &agrave; propos du
795 processus &agrave; la position <code>a</code>.
796
797 local process = r:scoreboard_process(1)
798 r:puts("Le serveur 1 a comme PID " .. process.pid)
799 </highlight>
800
801 <highlight language="lua">
802 r:scoreboard_worker(a, b) -- Interroge le serveur &agrave; propos du
803 thread <code>b</code>, dans le processus <code>a</code>.
804
805 local thread = r:scoreboard_worker(1, 1)
806 r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
807 &eacute;tat est " .. thread.status)
808 </highlight>
809
810 <highlight language="lua">
811 r:clock() -- Renvoie l'heure courante avec une pr&eacute;cision d'une
812 microseconde.
813 </highlight>
814
815 <highlight language="lua">
816 r:requestbody(filename) -- Lit et renvoie le corps d'une requ&ecirc;te. Si
817 'filename' est sp&eacute;cifi&eacute;, le corps de requ&ecirc;te n'est pas renvoy&eacute;, mais
818 sauvegard&eacute; dans le fichier correspondant.
819
820 local input = r:requestbody()
821 r:puts("Vous m'avez envoy&eacute; le corps de requ&ecirc;te suivant :\n")
822 r:puts(input)
823 </highlight>
824
825 <highlight language="lua">
826 r:add_input_filter(filter_name) -- Ajoute le filtre en entr&eacute;e
827 'filter_name'.
828 </highlight>
829
830 <highlight language="lua">
831 r:module_info(module_name) -- Interroge le serveur &agrave; propos d'un
832 module.
833
834 local mod = r.module_info("mod_lua.c")
835 if mod then
836     for k, v in pairs(mod.commands) do
837        r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives impl&eacute;ment&eacute;es par ce module
838     end
839 end
840 </highlight>
841
842 <highlight language="lua">
843 r:loaded_modules() -- Renvoie une liste des modules charg&eacute;s par
844 httpd.
845
846 for k, module in pairs(r:loaded_modules()) do
847     r:puts("J'ai charg&eacute; le module " .. module .. "\n")
848 end
849 </highlight>
850
851 <highlight language="lua">
852 r:runtime_dir_relative(filename) -- G&eacute;n&egrave;re le nom d'un fichier run-time
853 (par exemple la m&eacute;moire partag&eacute;e "file") relativement au r&eacute;pertoire de
854 run-time. 
855 </highlight>
856
857 <highlight language="lua">
858 r:server_info() -- Renvoie une table contenant des informations
859 &agrave; propos du serveur, comme le nom de l'ex&eacute;cutable httpd, le
860 module mpm utilis&eacute;, etc...
861 </highlight>
862
863 <highlight language="lua">
864 r:set_document_root(file_path) -- D&eacute;finit la racine des
865 documents pour la requ&ecirc;te &agrave; file_path.
866 </highlight>
867
868 <highlight language="lua">
869 r:add_version_component(component_string) -- Ajoute un &eacute;l&eacute;ment &agrave;
870 la banni&egrave;re du serveur.
871 </highlight>
872
873 <highlight language="lua">
874 r:set_context_info(prefix, docroot) -- D&eacute;finit le pr&eacute;fixe et la
875 racine des documents du contexte pour une requ&ecirc;te.
876 </highlight>
877
878 <highlight language="lua">
879 r:os_escape_path(file_path) -- Convertit un chemin du syst&egrave;me de
880 fichiers en URL ind&eacute;pendamment du syst&egrave;me d'exploitation.
881 </highlight>
882
883 <highlight language="lua">
884 r:escape_logitem(string) -- Echappe une cha&icirc;ne pour
885 journalisation.
886 </highlight>
887
888 <highlight language="lua">
889 r.strcmp_match(string, pattern) -- V&eacute;rifie si 'string' correspond &agrave;
890 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
891 'www.example.com' correspond &agrave; '*.example.com' ?
892
893 local match = r.strcmp_match("foobar.com", "foo*.com")
894 if match then 
895     r:puts("foobar.com matches foo*.com")
896 end
897 </highlight>
898
899 <highlight language="lua">
900 r:set_keepalive() -- D&eacute;finit l'&eacute;tat de persistance d'une
901 requ&ecirc;te. Renvoie true dans la mesure du possible, false dans le
902 cas contraire.
903 </highlight>
904
905 <highlight language="lua">
906 r:make_etag() -- G&eacute;n&egrave;re et renvoie le etag pour la requ&ecirc;te
907 courante.
908 </highlight>
909
910 <highlight language="lua">
911 r:send_interim_response(clear) -- Renvoie une r&eacute;ponse d'int&eacute;rim (1xx) au
912 client. Si 'clear' est vrai, les en-t&ecirc;tes disponibles seront envoy&eacute;s et
913 effac&eacute;s.
914 </highlight>
915
916 <highlight language="lua">
917 r:custom_response(status_code, string) -- G&eacute;n&egrave;re et d&eacute;finit une r&eacute;ponse
918 personnalis&eacute;e pour un code d'&eacute;tat particulier. Le fonctionnement est
919 tr&egrave;s proche de celui de la directive ErrorDocument.
920
921 r:custom_response(404, "Baleted!")
922 </highlight>
923
924 <highlight language="lua">
925 r.exists_config_define(string) -- V&eacute;rifie si une d&eacute;finition de
926 configuration existe.
927
928 if r.exists_config_define("FOO") then
929     r:puts("httpd a probablement &eacute;t&eacute; lanc&eacute; avec l'option -DFOO, ou FOO a
930     &eacute;t&eacute; d&eacute;fini dans la configuration")
931 end
932 </highlight>
933
934 <highlight language="lua">
935 r:state_query(string) -- Interroge le serveur &agrave; propos de son
936 &eacute;tat.
937 </highlight>
938
939 <highlight language="lua">
940 r:stat(filename) -- Ex&eacute;cute stat() sur un fichier, et renvoie
941 une table contenant des informations &agrave; propos de ce fichier.
942
943 local info = r:stat("/var/www/foo.txt")
944 if info then
945     r:puts("Ce fichier existe et a &eacute;t&eacute; modifi&eacute; pour la derni&egrave;re fois &agrave; : " .. info.modified)
946 end
947 </highlight>
948
949 <highlight language="lua">
950 r:regex(string, pattern, [drapeaux]) -- Ex&eacute;cute une recherche &agrave; base
951 d'expression rationnelle sur une cha&icirc;ne, et renvoie les
952 &eacute;ventuelles correspondances trouv&eacute;es.
953
954 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
955 if matches then
956     r:puts("L'expression rationnelle correspond et le dernier mot
957     captur&eacute; ($2) est : " .. matches[2])
958 end
959
960 -- Exemple avec insensibilit&eacute; &agrave; la casse :
961 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
962
963 -- les drapeaux peuvent &ecirc;tre une combibaison bit &agrave; bit de :
964 -- 0x01: insensibilit&eacute; &agrave; la casse
965 -- 0x02: recherche multiligne
966 </highlight>
967
968 <highlight language="lua">
969 r:sleep(secondes) -- Interrompt l'ex&eacute;cution du script pendant le nombre de secondes sp&eacute;cifi&eacute;.
970                   -- La valeur peut &ecirc;tre sp&eacute;cifi&eacute;e sous la forme d'un nombre d&eacute;cimal comme 1.25 pour plus de pr&eacute;cision.
971 </highlight>
972
973 <highlight language="lua">
974 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion &agrave; une
975 base de donn&eacute;es et renvoie une classe database. Voir '<a
976 href="#databases">Connectivit&eacute; aux bases de donn&eacute;es</a>' pour plus de
977 d&eacute;tails.
978 </highlight>
979
980 <highlight language="lua">
981 r:ivm_set("key", value) -- D&eacute;fini une variable Inter-VM avec une valeur sp&eacute;cifique.
982                         -- Ces valeurs sont conserv&eacute;es m&ecirc;me si la VM est
983                         -- arr&ecirc;t&eacute;e ou non utilis&eacute;e, et ne doivent donc &ecirc;tre
984                         -- utilis&eacute;es que si MaxConnectionsPerChild > 0.
985                         -- Les valeurs peuvent &ecirc;tre de type number, string
986                         -- ou boolean et sont stock&eacute;es s&eacute;par&eacute;ment pour
987                         -- chaque processus (elles ne seront donc pas d'une
988                         -- grande utilit&eacute; si l'on utilise le mpm prefork).
989                         
990 r:ivm_get("key")        -- Lit le contenu d'une variable d&eacute;finie via ivm_set. Renvoie
991                         -- le contenu de la variable si elle existe, ou nil
992                         -- dans le cas contraire.
993                         
994 -- Voici un exemple de lecture/&eacute;criture qui sauvegarde une variable
995 -- globale en dehors de la VM :
996 function handle(r)
997     -- La premi&egrave;re VM qui effectue l'appel suivant n'obtiendra aucune
998     -- valeur, et devra la cr&eacute;er
999     local foo = r:ivm_get("cached_data")
1000     if not foo then
1001         foo = do_some_calcs() -- simulation de valeurs de retour
1002         r:ivm_set("cached_data", foo) -- d&eacute;finition globale de la variable
1003     end
1004     r:puts("La donn&eacute;e en cache est : ", foo)
1005 end                     
1006 </highlight>
1007
1008 </section>
1009
1010 <section id="logging"><title>Fonctions de journalisation</title>
1011
1012 <highlight language="lua">
1013         -- exemples de messages de journalisation
1014         r:trace1("Ceci est un message de journalisation de niveau
1015         trace") -- les niveaux valides vont de trace1 &agrave; trace8 <br />
1016         r:debug("Ceci est un message de journalisation de niveau debug")<br />
1017         r:info("Ceci est un message de journalisation de niveau info")<br />
1018         r:notice("Ceci est un message de journalisation de niveau notice")<br />
1019         r:warn("Ceci est un message de journalisation de niveau warn")<br />
1020         r:err("Ceci est un message de journalisation de niveau err")<br />
1021         r:alert("Ceci est un message de journalisation de niveau alert")<br />
1022         r:crit("Ceci est un message de journalisation de niveau crit")<br />
1023         r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
1024 </highlight>
1025
1026 </section>
1027
1028 <section id="apache2"><title>Paquet apache2</title>
1029 <p>Le paquet nomm&eacute; <code>apache2</code> est fourni avec (au minimum) le
1030 contenu suivant :</p>
1031 <dl>
1032   <dt>apache2.OK</dt>
1033   <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1034   s'ils ont trait&eacute; la requ&ecirc;te.</dd>
1035   <dt>apache2.DECLINED</dt>
1036   <dd>Constante interne DECLINED. Les gestionnaires renverront cette
1037   valeur s'ils n'ont pas l'intention de traiter la requ&ecirc;te.</dd>
1038   <dt>apache2.DONE</dt>
1039   <dd>Constante interne DONE.</dd>
1040   <dt>apache2.version</dt>
1041   <dd>Cha&icirc;ne contenant la version du serveur HTTP Apache</dd>
1042   <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1043   <dd>Code d'&eacute;tat HTTP</dd>
1044   <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1045   <dd>Constantes internes utilis&eacute;es par <module>mod_proxy</module></dd>
1046   <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1047   <dd>constantes internes utilis&eacute;es par <module>mod_authz_core</module></dd>
1048
1049 </dl>
1050 <p>Les autres codes d'&eacute;tat HTTP ne sont pas encore impl&eacute;ment&eacute;s.</p>
1051 </section>
1052
1053
1054 <section id="modifying_buckets">
1055     <title>Modification de contenu avec les filtres lua</title>
1056     <p>
1057     Les fonctions de filtrage impl&eacute;ment&eacute;es via les directives <directive
1058     module="mod_lua">LuaInputFilter</directive> ou <directive
1059     module="mod_lua">LuaOutputFilter</directive> sont con&ccedil;ues comme des
1060     fonctions de 3&egrave;me phase non blocantes utilisant des sous-routines
1061     pour suspendre et reprendre l'ex&eacute;cution d'une fonction lorsque des
1062     paquets de donn&eacute;es sont envoy&eacute;s &agrave; la cha&icirc;ne de filtrage. La
1063     structure de base d'une telle fonction est :
1064     </p>
1065     <highlight language="lua">
1066 function filter(r)
1067     -- Nous indiquons tout d'abord que nous sommes pr&ecirc;ts &agrave; recevoir des
1068     -- blocs de donn&eacute;es.
1069     -- Avant ceci, nous pouvons d&eacute;finir notre environnement, tester
1070     -- certaines conditions, et, si nous le jugeons n&eacute;cessaire, refuser le
1071     -- filtrage d'une requ&ecirc;te :
1072     if something_bad then
1073         return -- Le filtrage est saut&eacute;
1074     end
1075     -- Sans se pr&eacute;occuper des donn&eacute;es que nous devons &eacute;ventuellement ajouter, un arr&ecirc;t est r&eacute;alis&eacute; ici.
1076     -- Noter que les filtres de sortie sont les seuls capables d'ajouter des &eacute;l&eacute;ments au d&eacute;but des donn&eacute;es.
1077     -- Les filtres en entr&eacute;e peuvent ajouter des &eacute;l&eacute;ments &agrave; la fin des donn&eacute;es au stade final.
1078
1079     coroutine.yield([optional header to be prepended to the content])
1080
1081     -- Apr&egrave;s cet arr&ecirc;t, nous allons recevoir d'autres blocs de donn&eacute;es, un par un ;
1082     -- nous pouvons les traiter comme il nous pla&icirc;t et proc&eacute;der &agrave; la r&eacute;ponse.
1083     -- Ces blocs sont conserv&eacute;s dans la variable globale 'bucket', nous r&eacute;alisons donc
1084     -- une boucle pour v&eacute;rifier que 'bucket' n'est pas vide :
1085     while bucket ~= nil do
1086         local output = mangle(bucket) -- Do some stuff to the content
1087         coroutine.yield(output) -- Return our new content to the filter chain
1088     end
1089
1090     -- Une fois les blocs de donn&eacute;es &eacute;puis&eacute;s, 'bucket' est positionn&eacute; &agrave; une valeur vide ('nil'),
1091     -- ce qui va nous faire sortir de cette boucle et nous amener &agrave; l'&eacute;tape suivante.
1092     -- On peut ajouter ce qu'on veut &agrave; la fin des donn&eacute;es &agrave; cette &eacute;tape, qui constitue le dernier
1093     -- arr&ecirc;t. Les filtres d'entr&eacute;e comme de sortie peuvent servir &agrave; ajouter des &eacute;l&eacute;ments &agrave; la fin
1094     --  des donn&eacute;es &agrave; cette &eacute;tape.
1095     coroutine.yield([optional footer to be appended to the content])
1096 end
1097     </highlight>
1098 </section>
1099 <section id="databases">
1100     <title>Connectivit&eacute; aux bases de donn&eacute;es</title>
1101     <p>Mod_lua impl&eacute;mente une fonctionnalit&eacute; basique de connexion aux
1102 bases de donn&eacute;es permettant d'envoyer des requ&ecirc;tes ou d'ex&eacute;cuter des
1103 commandes aupr&egrave;s des moteurs de base de donn&eacute;es les plus courants
1104 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1105     </p>
1106     <p>L'exemple suivant montre comment se connecter &agrave; une base de
1107 donn&eacute;es et extraire des informations d'une table :</p>
1108     <highlight language="lua">
1109 function handle(r)
1110     -- connexion &agrave; la base de donn&eacute;es
1111     local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
1112     if not err then
1113         -- S&eacute;lection de certaines informations
1114         local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1115         if not err then
1116             local rows = results(0) -- extrait tous les enregistrements en mode synchrone
1117             for k, row in pairs(rows) do
1118                 r:puts( string.format("Name: %s, Age: %s&lt;br/&gt;", row[1], row[2]) )
1119             end
1120         else
1121             r:puts("Database query error: " .. err)
1122         end
1123         database:close()
1124     else
1125         r:puts("Connexion &agrave; la base de donn&eacute;es impossible : " .. err)
1126     end
1127 end
1128     </highlight>
1129     <p>
1130     Pour utiliser <module>mod_dbd</module>, sp&eacute;cifiez
1131 <code>mod_dbd</code> comme type de base de donn&eacute;es, ou laissez le champ
1132 vide :
1133     </p>
1134     <highlight language="lua">
1135     local database = r:dbacquire("mod_dbd")
1136     </highlight>
1137     <section id="database_object">
1138         <title>L'objet database et ses m&eacute;thodes</title>
1139         <p>L'objet database renvoy&eacute; par <code>dbacquire</code> poss&egrave;de
1140 les m&eacute;thodes suivantes :</p>
1141         <p><strong>S&eacute;lection normale et requ&ecirc;te vers une base de donn&eacute;es
1142 :</strong></p>
1143     <highlight language="lua">
1144 -- Ex&eacute;cution d'une requ&ecirc;te et renvoie du nombre d'enregistrements
1145 affect&eacute;s :
1146 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1147
1148 -- Ex&eacute;cution d'une requ&ecirc;te et renvoie du r&eacute;sultat qui peut &ecirc;tre utilis&eacute;
1149 en mode synchrone ou asynchrone :
1150 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1151     </highlight>
1152         <p><strong>Utilisation de requ&ecirc;tes pr&eacute;par&eacute;es (recommand&eacute;) :</strong></p>
1153     <highlight language="lua">
1154 -- Cr&eacute;ation et ex&eacute;cution d'une requ&ecirc;te pr&eacute;par&eacute;e :
1155 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1156 if not errmsg then
1157     local result, errmsg = statement:query(20) -- ex&eacute;cute la requ&ecirc;te pour age &gt; 20
1158 end
1159
1160 -- Extrait une requ&ecirc;te pr&eacute;par&eacute;e depuis une directive DBDPrepareSQL :
1161 local statement, errmsg = database:prepared(r, "someTag")
1162 if not errmsg then
1163     local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requ&ecirc;te
1164 end
1165
1166 </highlight>
1167         <p><strong>Echappement de valeurs, fermeture de la base donn&eacute;es,
1168 etc...</strong></p>
1169     <highlight language="lua">
1170 -- Echappe une valeur pour pouvoir l'utiliser dans une requ&ecirc;te :
1171 local escaped = database:escape(r, [["'|blabla]])
1172
1173 -- Ferme une base de donn&eacute;es et lib&egrave;re les liens vers cette derni&egrave;re :
1174 database:close()
1175
1176 -- V&eacute;rifie si une connexion &agrave; une base de donn&eacute;es est en service et
1177 op&eacute;rationnelle :
1178 local connected = database:active()
1179     </highlight>
1180     </section>
1181     <section id="result_sets">
1182     <title>Travail avec les jeux d'enregistrements renvoy&eacute;s par les requ&ecirc;tes</title>
1183     <p>Les jeux d'enregistrements renvoy&eacute;s par <code>db:select</code> ou par des
1184 requ&ecirc;tes pr&eacute;par&eacute;es cr&eacute;&eacute;es par <code>db:prepare</code> permettent de
1185 s&eacute;lectionner des enregistrements en mode synchrone ou
1186 asynchrone, selon le nombre d'enregistrements sp&eacute;cifi&eacute; :<br/>
1187     <code>result(0)</code> s&eacute;lectionne tous les enregistrements en mode
1188 synchrone en renvoyant une table d'enregistrements.<br/>
1189     <code>result(-1)</code> s&eacute;lectionne le prochain enregistrement disponible en
1190 mode asynchrone.<br/>
1191     <code>result(N)</code> s&eacute;lectionne l'enregistrement num&eacute;ro
1192 <code>N</code> en mode asynchrone.
1193     </p>
1194     <highlight language="lua">
1195 -- extrait un jeu d'enregistrements via une requ&ecirc;te r&eacute;guli&egrave;re :
1196 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1197
1198 local rows = result(0) -- s&eacute;lectionne tous les enregistrements en mode synchrone
1199 local row = result(-1) -- s&eacute;lectionne le prochain enregistrement disponible en mode asynchrone
1200 local row = result(1234) -- s&eacute;lectionne l'enregistrement 1234 en mode asynchrone
1201     </highlight>
1202     <p>Il est possible de construire une fonction qui renvoie une
1203 fonction it&eacute;rative permettant de traiter tous les enregistrement en mode
1204 synchrone ou asynchrone selon la valeur de l'argument async :
1205     </p>
1206     <highlight language="lua">
1207 function rows(resultset, async)
1208     local a = 0
1209     local function getnext()
1210         a = a + 1
1211         local row = resultset(-1)
1212         return row and a or nil, row
1213     end
1214     if not async then
1215         return pairs(resultset(0))
1216     else
1217         return getnext, self
1218     end
1219 end
1220
1221 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1222 if not err then
1223      -- s&eacute;lectionne des enregistrements en mode asynchrone :
1224     local result, err = statement:select(20)
1225     if not err then
1226         for index, row in rows(result, true) do
1227             ....
1228         end
1229     end
1230
1231      -- s&eacute;lectionne des enregistrements en mode synchrone :
1232     local result, err = statement:select(20)
1233     if not err then
1234         for index, row in rows(result, false) do
1235             ....
1236         end
1237     end
1238 end
1239     </highlight>
1240     </section>
1241     <section id="closing_databases">
1242         <title>Fermeture d'une connexion &agrave; une base de donn&eacute;es</title>
1243
1244     <p>Lorsqu'elles ne sont plus utilis&eacute;es, les connexions aux bases de
1245 donn&eacute;es doivent &ecirc;tre ferm&eacute;es avec <code>database:close()</code>. Si vous
1246 ne les fermez pas manuellement, mod_lua les fermera peut-&ecirc;tre en tant
1247 que r&eacute;sidus collect&eacute;s, mais si ce n'est pas le cas, vous pouvez finir
1248 pas avoir trop de connexions vers la base de donn&eacute;es inutilis&eacute;es. Les
1249 deux mesures suivantes sont pratiquement identiques :
1250     </p>
1251     <highlight language="lua">
1252 -- M&eacute;thode 1 : fermeture manuelle de la connexion
1253 local database = r:dbacquire("mod_dbd")
1254 database:close() -- c'est tout
1255
1256 -- M&eacute;thode 2 : on laisse le collecteur de r&eacute;sidus la fermer
1257 local database = r:dbacquire("mod_dbd")
1258 database = nil -- on coupe le lien
1259 collectgarbage() -- fermeture de la connexion par le collecteur de r&eacute;sidus
1260 </highlight>
1261     </section>
1262     <section id="database_caveat">
1263     <title>Pr&eacute;cautions &agrave; prendre lorsque l'on travaille avec les bases
1264 de donn&eacute;es</title>
1265     <p>Bien que les fonctions <code>query</code> et <code>run</code>
1266 soient toujours disponibles, il est recommand&eacute; d'utiliser des requ&ecirc;tes
1267 pr&eacute;par&eacute;es chaque fois que possible, afin d'une part d'optimiser les
1268 performances (si votre connexion reste longtemps en vie), et d'autre part
1269 minimiser le risque d'attaques par injection SQL. Les fonctions
1270 <code>run</code> et <code>query</code> ne doivent &ecirc;tre utilis&eacute;es que
1271 lorsque la requ&ecirc;te ne contient pas de variables (requ&ecirc;te statique). Dans
1272 le cas des requ&ecirc;tes dynamiques, utilisez <code>db:prepare</code> ou
1273 <code>db:prepared</code>.
1274     </p>
1275     </section>
1276
1277 </section>
1278
1279 <directivesynopsis>
1280 <name>LuaRoot</name>
1281 <description>Sp&eacute;cifie le chemin de base pour la r&eacute;solution des chemins
1282 relatifs dans les directives de mod_lua</description>
1283 <syntax>LuaRoot /chemin/vers/un/r&eacute;pertoire</syntax>
1284 <contextlist><context>server config</context><context>virtual host</context>
1285 <context>directory</context><context>.htaccess</context>
1286 </contextlist>
1287 <override>All</override>
1288
1289 <usage>
1290     <p>Cette directive permet de sp&eacute;cifier le chemin de base qui sera
1291     utilis&eacute; pour &eacute;valuer tous les chemins relatifs dans mod_lua. En
1292     l'absence de cette directive, les chemins relatifs sont r&eacute;solus par
1293     rapport au r&eacute;pertoire de travail courant, ce qui ne sera pas
1294     toujours appropri&eacute; pour un serveur.</p>
1295 </usage>
1296 </directivesynopsis>
1297
1298 <directivesynopsis>
1299 <name>LuaScope</name>
1300 <description>Une valeur parmi once, request, conn, thread -- la valeur
1301 par d&eacute;faut est once</description>
1302 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
1303 <default>LuaScope once</default>
1304 <contextlist><context>server config</context><context>virtual host</context>
1305 <context>directory</context><context>.htaccess</context>
1306 </contextlist>
1307 <override>All</override>
1308
1309 <usage>
1310     <p>Cette directive permet de sp&eacute;cifier la dur&eacute;e de vie de
1311     l'interpr&eacute;teur Lua qui sera utilis&eacute; dans ce "r&eacute;pertoire". La valeur
1312     par d&eacute;faut est "once".</p>
1313
1314    <dl>
1315     <dt>once:</dt> <dd>utilise l'interpr&eacute;teur une fois.</dd>
1316
1317     <dt>request:</dt> <dd>utilise l'interpr&eacute;teur pour traiter tout ce
1318     qui est bas&eacute; sur le m&ecirc;me fichier dans la requ&ecirc;te, et qui se trouve
1319     aussi dans la port&eacute;e de la requ&ecirc;te.</dd>
1320
1321     <dt>conn:</dt> <dd>idem request, mais attach&eacute; &agrave; connection_rec</dd>
1322
1323     <dt>thread:</dt> <dd>Utilise l'interpr&eacute;teur pendant toute la dur&eacute;e
1324     de vie du thread qui traite la requ&ecirc;te (disponible seulement avec
1325     les MPMs thread&eacute;s).</dd>
1326
1327     <dt>server:</dt>  <dd>Le comportement est ici diff&eacute;rent, car la
1328     port&eacute;e du serveur pr&eacute;sente une dur&eacute;e de vie assez longue, et
1329     plusieurs threads vont partager le m&ecirc;me server_rec. Pour g&eacute;rer tout
1330     ceci, les &eacute;tats lua du serveur sont stock&eacute;s dans une liste de ressources
1331     apr. Les arguments <code>min</code> et <code>max</code> permettent
1332     de sp&eacute;cifier les nombres minimaux et maximaux d'&eacute;tats lua &agrave; stocker
1333     dans la liste.</dd>
1334    </dl>
1335    <p>En g&eacute;n&eacute;ral, les port&eacute;es <code>thread</code> et <code>server</code>
1336    sont 2 &agrave; 3 fois plus rapides que les autres, car elles n'ont pas besoin
1337    de r&eacute;g&eacute;n&eacute;rer de nouveaux &eacute;tats Lua &agrave; chaque requ&ecirc;te (comme c'est le
1338    cas avec le MPM event, o&ugrave; m&ecirc;me les connexions persistantes utilisent un
1339    nouveau thread pour chaque requ&ecirc;te). Si vous pensez que vos scripts
1340    n'auront pas de probl&egrave;me s'il r&eacute;utilisent un &eacute;tat, alors les port&eacute;es
1341    <code>thread</code> ou <code>server</code> doivent &ecirc;tre utilis&eacute;es car
1342    elles pr&eacute;senteront de meilleures performances. Alors que la port&eacute;e
1343    <code>thread</code> fournira les r&eacute;ponses les plus rapides, la port&eacute;e
1344    <code>server</code> utilisera moins de m&eacute;moire car les &eacute;tats sont
1345    rassembl&eacute;s dans des jeux, permettant par exemple &agrave; 1000 threads de
1346    partager 100 &eacute;tats Lua, ne n&eacute;cessitant ainsi que 10% de la m&eacute;moire
1347    requise par la port&eacute;e <code>thread</code>.
1348     </p>
1349 </usage>
1350 </directivesynopsis>
1351
1352 <directivesynopsis>
1353 <name>LuaMapHandler</name>
1354 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
1355 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
1356 [nom-fonction]</syntax>
1357 <contextlist><context>server config</context><context>virtual host</context>
1358 <context>directory</context><context>.htaccess</context>
1359 </contextlist>
1360 <override>All</override>
1361 <usage>
1362     <p>Cette directive permet de faire correspondre un mod&egrave;le d'uri avec
1363     une fonction de gestionnaire situ&eacute;e dans un fichier sp&eacute;cifique. Elle
1364     utilise les expressions rationnelles PCRE pour mettre en
1365     correspondance l'uri, et supporte les groupes de correspondance
1366     d'interpolation dans le chemin du fichier et le nom de la fonction.
1367     Prenez garde aux probl&egrave;mes de s&eacute;curit&eacute; en &eacute;crivant vos expressions
1368     rationnelles.</p>
1369    <example><title>Exemples :</title>
1370     <highlight language="config">
1371     LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1372     </highlight>
1373    </example>
1374         <p>Cette directive va faire correspondre des uri comme
1375         /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
1376         fonction de gestionnaire handle_show au niveau de la vm lua
1377         apr&egrave;s chargement de ce fichier.</p>
1378
1379 <highlight language="config">
1380     LuaMapHandler /bingo /scripts/wombat.lua
1381 </highlight>
1382         <p>Cette directive invoquera la fonction "handle" qui est la
1383         valeur par d&eacute;faut si aucun nom de fonction sp&eacute;cifique n'est
1384         sp&eacute;cifi&eacute;.</p>
1385 </usage>
1386 </directivesynopsis>
1387
1388 <directivesynopsis>
1389 <name>LuaPackagePath</name>
1390 <description>Ajoute un r&eacute;pertoire au package.path de lua</description>
1391 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
1392 <contextlist><context>server config</context><context>virtual host</context>
1393 <context>directory</context><context>.htaccess</context>
1394 </contextlist>
1395 <override>All</override>
1396     <usage><p>Cette directive permet d'ajouter un chemin &agrave; la liste des
1397     chemins de recherche du module lua. Elle suit les m&ecirc;mes conventions
1398     que lua. Ceci modifie le package.path dans les vms lua.</p>
1399
1400     <example><title>Exemples :</title>
1401         <highlight language="config">
1402 LuaPackagePath /scripts/lib/?.lua
1403 LuaPackagePath /scripts/lib/?/init.lua
1404     </highlight>
1405     </example>
1406 </usage>
1407 </directivesynopsis>
1408
1409 <directivesynopsis>
1410 <name>LuaPackageCPath</name>
1411 <description>Ajoute un r&eacute;pertoire au package.cpath de lua</description>
1412 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
1413 <contextlist><context>server config</context><context>virtual host</context>
1414 <context>directory</context><context>.htaccess</context>
1415 </contextlist>
1416 <override>All</override>
1417
1418 <usage>
1419     <p>Cette directive permet d'ajouter un chemin &agrave; la liste des chemins
1420     de recherche des biblioth&egrave;ques partag&eacute;es de lua. Ceci modifie le
1421     package.cpath dans les vms lua.</p>
1422
1423 </usage>
1424 </directivesynopsis>
1425
1426 <directivesynopsis>
1427 <name>LuaCodeCache</name>
1428 <description>Configure le cache de code compil&eacute;.</description>
1429 <syntax>LuaCodeCache stat|forever|never</syntax>
1430 <default>LuaCodeCache stat</default>
1431 <contextlist>
1432 <context>server config</context><context>virtual host</context>
1433 <context>directory</context><context>.htaccess</context>
1434 </contextlist>
1435 <override>All</override>
1436
1437 <usage><p>
1438     Cette directive permet de d&eacute;finir le comportement du cache de code
1439     en m&eacute;moire. La valeur par d&eacute;faut est stat ; dans ce cas, le script
1440     du niveau le plus haut (et pas les scripts inclus) est v&eacute;rifi&eacute; &agrave;
1441     chaque fois que ce fichier est n&eacute;cessaire, et est recharg&eacute; si la
1442     date de modification est plus r&eacute;cente que celle du script d&eacute;j&agrave;
1443     charg&eacute;. Les autres valeurs permettent respectivement de garder le
1444     fichier en cache perp&eacute;tuellement (forever - jamais v&eacute;rifi&eacute; ni
1445     remplac&eacute;), ou de ne jamais le mettre en cache (never).</p>
1446
1447     <p>En g&eacute;n&eacute;ral, les valeurs stat et forever sont utilis&eacute;es pour un
1448     serveur en production, et les valeurs stat ou never pour un serveur
1449     en d&eacute;veloppement.</p>
1450
1451     <example><title>Exemples :</title>
1452         <highlight language="config">
1453 LuaCodeCache stat
1454 LuaCodeCache forever
1455 LuaCodeCache never
1456     </highlight>
1457     </example>
1458
1459 </usage>
1460 </directivesynopsis>
1461
1462 <directivesynopsis>
1463 <name>LuaHookTranslateName</name>
1464 <description>Fournit un point d'entr&eacute;e &agrave; la phase du nom de
1465 traduction du traitement de la requ&ecirc;te</description>
1466 <syntax>LuaHookTranslateName  /chemin/vers/lua/script.lua  nom_fonction_hook [early|late]</syntax>
1467 <contextlist><context>server config</context><context>virtual host</context>
1468 </contextlist>
1469 <override>All</override>
1470 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1471 version 2.3.15 du serveur HTTP Apache.</compatibility>
1472
1473 <usage><p>
1474     Cette directive permet d'ajouter un point d'entr&eacute;e (&agrave;
1475     APR_HOOK_MIDDLE) &agrave; la phase du nom de traduction du traitement de la
1476     requ&ecirc;te. La fonction hook accepte un seul argument, le request_rec,
1477     et doit renvoyer un code d'&eacute;tat qui est soit un code d'erreur HTTP,
1478     ou une constante d&eacute;finie dans le module apache2 :  apache2.OK,
1479     apache2.DECLINED, ou apache2.DONE.</p>
1480
1481     <p>Pour ceux qui ne sont pas familiers avec les points d'entr&eacute;e
1482     (hook), en gros, chaque hook sera invoqu&eacute; jusqu'&agrave; ce que l'un
1483     d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
1484     traduction, il doit juste renvoyer apache2.DECLINED. Si le
1485     traitement de la requ&ecirc;te doit &ecirc;tre interrompu, la valeur renvoy&eacute;e
1486     doit &ecirc;tre apache2.DONE.</p>
1487
1488     <p>Exemple :</p>
1489
1490 <highlight language="config">
1491 # httpd.conf
1492 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1493 </highlight>
1494
1495 <highlight language="lua">
1496 -- /scripts/conf/hooks.lua --
1497 require "apache2"
1498 function silly_mapper(r)
1499     if r.uri == "/" then
1500         r.filename = "/var/www/home.lua"
1501         return apache2.OK
1502     else
1503         return apache2.DECLINED
1504     end
1505 end
1506 </highlight>
1507
1508    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
1509    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
1510    module="core">Directory</directive> ou <directive type="section"
1511    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1512
1513    <note><title>Ordonnancement</title><p>Les arguments optionnels
1514    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1515    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1516 </usage>
1517 </directivesynopsis>
1518
1519 <directivesynopsis>
1520 <name>LuaHookFixups</name>
1521 <description>Fournit un point d'entr&eacute;e pour la phase de correction du
1522 traitement de la requ&ecirc;te</description>
1523 <syntax>LuaHookFixups  /chemin/vers/lua/script.lua hook_function_name</syntax>
1524 <contextlist><context>server config</context><context>virtual host</context>
1525 <context>directory</context><context>.htaccess</context>
1526 </contextlist>
1527 <override>All</override>
1528 <usage>
1529 <p>
1530     Idem LuaHookTranslateName, mais s'ex&eacute;cute durant la phase de
1531     correction.
1532 </p>
1533 </usage>
1534 </directivesynopsis>
1535
1536 <directivesynopsis>
1537 <name>LuaHookMapToStorage</name>
1538 <description>Fournit un point d'entr&eacute;e pour la phase map_to_storage du
1539 traitement de la requ&ecirc;te</description>
1540 <syntax>LuaHookMapToStorage  /chemin/vers/lua/script.lua hook_function_name</syntax>
1541 <contextlist><context>server config</context><context>virtual host</context>
1542 <context>directory</context><context>.htaccess</context>
1543 </contextlist>
1544 <override>All</override>
1545     <usage>
1546     <p>Identique &agrave; la directive
1547     <directive>LuaHookTranslateName</directive>, mais s'ex&eacute;cute &agrave; la
1548     phase map-to-storage du traitement de la requ&ecirc;te. Les modules comme
1549     mod_cache agissent pendant cette phase, ce qui permet de pr&eacute;senter
1550     un exemple int&eacute;ressant de ce que l'on peut faire ici :</p>
1551     <highlight language="config">
1552     LuaHookMapToStorage /path/to/lua/script.lua check_cache
1553     </highlight>
1554     <highlight language="lua">
1555 require"apache2"
1556 cached_files = {}
1557
1558 function read_file(filename)
1559     local input = io.open(filename, "r")
1560     if input then
1561         local data = input:read("*a")
1562         cached_files[filename] = data
1563         file = cached_files[filename]
1564         input:close()
1565     end
1566     return cached_files[filename]
1567 end
1568
1569 function check_cache(r)
1570     if r.filename:match("%.png$") then -- Only match PNG files
1571         local file = cached_files[r.filename] -- Check cache entries
1572         if not file then
1573             file = read_file(r.filename)  -- Read file into cache
1574         end
1575         if file then -- If file exists, write it out
1576             r.status = 200
1577             r:write(file)
1578             r:info(("Sent %s to client from cache"):format(r.filename))
1579             return apache2.DONE -- skip default handler for PNG files
1580         end
1581     end
1582     return apache2.DECLINED -- If we had nothing to do, let others serve this.
1583 end
1584     </highlight>
1585
1586     </usage>
1587 </directivesynopsis>
1588
1589 <directivesynopsis>
1590 <name>LuaHookCheckUserID</name>
1591 <description>Fournit un point d'entr&eacute;e pour la phase check_user_id du
1592 traitement de la requ&ecirc;te</description>
1593 <syntax>LuaHookCheckUserID  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1594 <contextlist><context>server config</context><context>virtual host</context>
1595 <context>directory</context><context>.htaccess</context>
1596 </contextlist>
1597 <override>All</override>
1598 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1599 version 2.3.15 du serveur HTTP Apache.</compatibility>
1600 <usage><p>...</p>
1601    <note><title>Ordonnancement</title><p>Les arguments optionnels
1602    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1603    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1604 </usage>
1605 </directivesynopsis>
1606
1607 <directivesynopsis>
1608 <name>LuaHookTypeChecker</name>
1609 <description>Fournit un point d'entr&eacute;e pour la phase type_checker du
1610 traitement de la requ&ecirc;te</description>
1611 <syntax>LuaHookTypeChecker  /chemin/vers/lua/script.lua hook_function_name</syntax>
1612 <contextlist><context>server config</context><context>virtual host</context>
1613 <context>directory</context><context>.htaccess</context>
1614 </contextlist>
1615 <override>All</override>
1616     <usage><p>...</p></usage>
1617 </directivesynopsis>
1618
1619 <directivesynopsis>
1620 <name>LuaHookAuthChecker</name>
1621 <description>Fournit un point d'entr&eacute;e pour la phase auth_checker du
1622 traitement de la requ&ecirc;te</description>
1623 <syntax>LuaHookAuthChecker  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1624 <contextlist><context>server config</context><context>virtual host</context>
1625 <context>directory</context><context>.htaccess</context>
1626 </contextlist>
1627 <override>All</override>
1628 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1629 version 2.3.15 du serveur HTTP Apache.</compatibility>
1630     <usage>
1631 <p>Invoque une fonction lua au cours de la phase auth_checker du
1632 traitement de la requ&ecirc;te. Cette directive peut s'utiliser pour
1633 impl&eacute;menter une v&eacute;rification arbitraire de l'authentification et de
1634 l'autorisation. Voici un exemple tr&egrave;s simple :
1635 </p>
1636 <highlight language="lua">
1637 require 'apache2'
1638
1639 -- fonction d'accroche authcheck fictive
1640 -- Si la requ&ecirc;te ne contient aucune donn&eacute;e d'authentification, l'en-t&ecirc;te
1641 -- de la r&eacute;ponse est d&eacute;fini et un code 401 est renvoy&eacute; afin de demander au
1642 -- navigateur d'effectuer une authentification basique. Si la requ&ecirc;te
1643 -- comporte des donn&eacute;es d'authentification, elles ne sont pas vraiment
1644 -- consult&eacute;es, mais on admet la prise en compte de l'utilisateur 'foo' et
1645 -- on la valide. On v&eacute;rifie ensuite si l'utilisateur est bien 'foo' et on
1646 -- accepte la requ&ecirc;te.
1647 function authcheck_hook(r)
1648
1649    -- recherche des informations d'authentification
1650    auth = r.headers_in['Authorization']
1651    if auth ~= nil then
1652      -- d&eacute;finition d'un utilisateur par d&eacute;faut
1653      r.user = 'foo'
1654    end
1655
1656    if r.user == nil then
1657       r:debug("authcheck: user is nil, returning 401")
1658       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1659       return 401
1660    elseif r.user == "foo" then
1661       r:debug('user foo: OK')
1662    else
1663       r:debug("authcheck: user='" .. r.user .. "'")
1664       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1665       return 401
1666    end
1667    return apache2.OK
1668 end
1669 </highlight>
1670 <note><title>Ordonnancement</title><p>Les arguments optionnels
1671    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1672    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1673 </usage>
1674 </directivesynopsis>
1675
1676 <directivesynopsis>
1677 <name>LuaHookAccessChecker</name>
1678 <description>Fournit un point d'entr&eacute;e pour la phase access_checker du
1679 traitement de la requ&ecirc;te</description>
1680 <syntax>LuaHookAccessChecker  /chemin/vers/lua/script.lua  hook_function_name [early|late]</syntax>
1681 <contextlist><context>server config</context><context>virtual host</context>
1682 <context>directory</context><context>.htaccess</context>
1683 </contextlist>
1684 <override>All</override>
1685 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1686 version 2.3.15 du serveur HTTP Apache.</compatibility>
1687
1688 <usage>
1689 <p>Ajoute votre fonction d'accroche &agrave; la phase access_checker. Une
1690 fonction d'accroche access checker renvoie en g&eacute;n&eacute;ral OK, DECLINED, ou
1691 HTTP_FORBIDDEN.</p>
1692 <note><title>Ordonnancement</title><p>Les arguments optionnels
1693    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1694    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1695 </usage>
1696 </directivesynopsis>
1697 <directivesynopsis>
1698 <name>LuaHookInsertFilter</name>
1699 <description>Fournit un point d'entr&eacute;e pour la phase insert_filter du
1700 traitement de la requ&ecirc;te</description>
1701 <syntax>LuaHookInsertFilter  /chemin/vers/lua/script.lua hook_function_name</syntax>
1702 <contextlist><context>server config</context><context>virtual host</context>
1703 <context>directory</context><context>.htaccess</context>
1704 </contextlist>
1705 <override>All</override>
1706     <usage><p>Non encore impl&eacute;ment&eacute;</p></usage>
1707 </directivesynopsis>
1708
1709 <directivesynopsis>
1710 <name>LuaInherit</name>
1711 <description>Contr&ocirc;le la mani&egrave;re dont les sections de configuration
1712 parentes sont fusionn&eacute;es dans les enfants</description>
1713 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1714 <default>LuaInherit parent-first</default>
1715 <contextlist><context>server config</context><context>virtual host</context>
1716 <context>directory</context><context>.htaccess</context>
1717 </contextlist>
1718 <override>All</override>
1719 <compatibility>Versions 2.4.0 et sup&eacute;rieures</compatibility>
1720     <usage><p>Par d&eacute;faut, si des directives LuaHook* se trouvent dans
1721     des sections de configuration Directory ou Location qui se
1722     chevauchent, les scripts
1723     d&eacute;finis dans les sections les plus sp&eacute;cifiques s'ex&eacute;cutent
1724     <em>apr&egrave;s</em> ceux d&eacute;finis dans les sections plus g&eacute;n&eacute;riques
1725     (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1726     en sorte que le contexte parent ne s'applique pas du tout.</p>
1727
1728     <p>Jusqu'aux versions 2.3.x, le comportement par d&eacute;faut consistait &agrave;
1729     ignorer les directives LuaHook* situ&eacute;es dans les sections de
1730     configuration parentes.</p></usage>
1731 </directivesynopsis>
1732
1733 <directivesynopsis>
1734 <name>LuaQuickHandler</name>
1735 <description>Fournit un point d'entr&eacute;e pour la gestion rapide du
1736 traitement de la requ&ecirc;te</description>
1737 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1738 <contextlist><context>server config</context><context>virtual host</context>
1739 <context>directory</context><context>.htaccess</context>
1740 </contextlist>
1741 <override>All</override>
1742 <usage>
1743     <p>Cette phase s'ex&eacute;cute juste apr&egrave;s l'attribution de la requ&ecirc;te &agrave;
1744     un serveur virtuel, et permet d'effectuer certains traitements avant
1745     le d&eacute;roulement des autres phases, ou de servir une requ&ecirc;te sans
1746     avoir &agrave; la traduire, l'associer &agrave; un espace de stockage, etc...
1747     Comme cette phase s'ex&eacute;cute avant toute autre, les directives telles
1748     que <directive type="section" module="core">Location</directive> ou
1749     <directive type="section" module="core">Directory</directive> ne
1750     sont pas encore prises en compte, car Les URI n'ont pas encore &eacute;t&eacute;
1751     enti&egrave;rement interpr&eacute;t&eacute;s.
1752     </p>
1753    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
1754    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
1755    module="core">Directory</directive> ou <directive type="section"
1756    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1757 </usage>
1758 </directivesynopsis>
1759
1760 <directivesynopsis>
1761 <name>LuaAuthzProvider</name>
1762 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1763 </description>
1764 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1765 <contextlist><context>server config</context> </contextlist>
1766 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1767
1768 <usage>
1769 <p>Lorsqu'une fonction lua a &eacute;t&eacute; enregistr&eacute;e en tant que fournisseur
1770 d'autorisation, elle peut &ecirc;tre appel&eacute;e via la directive <directive
1771 module="mod_authz_core">Require</directive> :</p>
1772
1773
1774 <highlight language="config">
1775 LuaRoot /usr/local/apache2/lua
1776 LuaAuthzProvider foo authz.lua authz_check_foo
1777 &lt;Location /&gt;
1778   Require foo johndoe
1779 &lt;/Location&gt;
1780 </highlight>
1781 <highlight language="lua">
1782 require "apache2"
1783 function authz_check_foo(r, who)
1784     if r.user ~= who then return apache2.AUTHZ_DENIED
1785     return apache2.AUTHZ_GRANTED
1786 end
1787 </highlight>
1788
1789 </usage>
1790 </directivesynopsis>
1791
1792
1793 </modulesynopsis>
1794