]> 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: 1467562:1467730 (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
674 while nous_avons_des_donn&eacute;es_&agrave;_envoyer do
675     r:puts("Bla bla bla\n") -- envoi des donn&eacute;es &agrave; envoyer vers le tampon
676     r:flush() -- vidage du tampon (envoi au client)
677     r:sleep(0.5) -- mise en attente et bouclage
678 +end
679 </highlight>
680
681 <highlight language="lua">
682 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
683
684 r:addoutputfilter("fooFilter") -- ins&egrave;re le filtre fooFilter dans le flux de sortie
685 </highlight>
686
687 <highlight language="lua">
688 r:sendfile(filename) -- envoie un fichier entier au client en
689 utilisant sendfile s'il est support&eacute; par la plateforme :
690
691 if use_sendfile_thing then
692     r:sendfile("/var/www/large_file.img")
693 end
694 </highlight>
695
696 <highlight language="lua">
697 r:parseargs() -- renvoie une table Lua contenant la cha&icirc;ne
698 d'arguments de la requ&ecirc;te
699
700 local GET = r:parseargs()
701 +r:puts("Votre nom est : " .. GET['name'] or "Unknown")
702 </highlight>
703
704
705 <highlight language="lua">
706 r:parsebody()([sizeLimit]) -- interpr&egrave;te le corps de la requ&ecirc;te
707 en tant que POST et renvoie une table lua. Un nombre optionnel
708 peut &ecirc;tre fourni pour sp&eacute;cifier le nombre maximal d'octets &agrave;
709 interpr&eacute;ter. La valeur par d&eacute;faut est 8192.
710
711 local POST = r:parsebody(1024*1024)
712 +r:puts("Votre nom est : " .. POST['name'] or "Unknown")
713 </highlight>
714
715
716 <highlight language="lua">
717 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la r&eacute;ponse
718 </highlight>
719
720 <highlight language="lua">
721 r:write("une simple cha&icirc;ne") -- affichage dans le
722 corps de la r&eacute;ponse
723 </highlight>
724
725 <highlight language="lua">
726 r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Echappe le
727 code HTML et renvoie le r&eacute;sultat
728 </highlight>
729
730 <highlight language="lua">
731 r:base64_encode(string) -- Encode une cha&icirc;ne &agrave; l'aide du
732 standard de codage Base64.
733
734 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
735 </highlight>
736
737 <highlight language="lua">
738 r:base64_decode(string) -- D&eacute;code une cha&icirc;ne cod&eacute;e en Base64.
739
740 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
741 </highlight>
742
743 <highlight language="lua">
744 r:md5(string) -- Calcule et renvoie le condens&eacute; MD5 d'une cha&icirc;ne
745 en mode binaire (binary safe).
746
747 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
748 </highlight>
749
750 <highlight language="lua">
751 r:sha1(string) -- Calcule et renvoie le condens&eacute; SHA1 d'une cha&icirc;ne
752 en mode binaire (binary safe).
753
754 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
755 </highlight>
756
757 <highlight language="lua">
758 r:escape(string) -- Echappe une cha&icirc;ne de type URL.
759
760 local url = "http://foo.bar/1 2 3 &amp; 4 + 5"
761 local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
762 </highlight>
763
764 <highlight language="lua">
765 r:unescape(string) -- D&eacute;s&eacute;chappe une cha&icirc;ne de type URL.
766
767 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
768 local unescaped = r:escape(url) -- returns 'http://foo.bar/1 2 3 &amp; 4 + 5'
769 </highlight>
770
771 <highlight language="lua">
772 r:mpm_query(number) -- Interroge le serveur &agrave; propos de son
773 module MPM via la requ&ecirc;te ap_mpm_query.
774
775 local mpm = r.mpm_query(14)
776 if mpm == 1 then
777     r:puts("Ce serveur utilise le MPM Event")
778 end
779 </highlight>
780
781 <highlight language="lua">
782 r:expr(string) -- Evalue une cha&icirc;ne de type <a
783 href="../expr.html">expr</a>.
784
785 if r:expr("%{HTTP_HOST} =~ /^www/") then
786     r:puts("Ce nom d'h&ocirc;te commence par www")
787 end
788 </highlight>
789
790 <highlight language="lua">
791 r:scoreboard_process(a) -- Interroge le serveur &agrave; propos du
792 processus &agrave; la position <code>a</code>.
793
794 local process = r:scoreboard_process(1)
795 r:puts("Le serveur 1 a comme PID " .. process.pid)
796 </highlight>
797
798 <highlight language="lua">
799 r:scoreboard_worker(a, b) -- Interroge le serveur &agrave; propos du
800 thread <code>b</code>, dans le processus <code>a</code>.
801
802 local thread = r:scoreboard_worker(1, 1)
803 r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
804 &eacute;tat est " .. thread.status)
805 </highlight>
806
807 <highlight language="lua">
808 r:started() -- Renvoie l'heure du dernier (re)d&eacute;marrage du
809 serveur.
810 </highlight>
811
812 <highlight language="lua">
813 r:clock() -- Renvoie l'heure courante avec une pr&eacute;cision d'une
814 microseconde.
815 </highlight>
816
817 <highlight language="lua">
818 r:requestbody(filename) -- Lit et renvoie le corps d'une requ&ecirc;te. Si
819 'filename' est sp&eacute;cifi&eacute;, le corps de requ&ecirc;te n'est pas renvoy&eacute;, mais
820 sauvegard&eacute; dans le fichier correspondant.
821
822 local input = r:requestbody()
823 r:puts("Vous m'avez envoy&eacute; le corps de requ&ecirc;te suivant :\n")
824 r:puts(input)
825 </highlight>
826
827 <highlight language="lua">
828 r:add_input_filter(filter_name) -- Ajoute le filtre en entr&eacute;e
829 'filter_name'.
830 </highlight>
831
832 <highlight language="lua">
833 r:module_info(module_name) -- Interroge le serveur &agrave; propos d'un
834 module.
835
836 local mod = r.module_info("mod_lua.c")
837 if mod then
838     for k, v in pairs(mod.commands) do
839        r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives impl&eacute;ment&eacute;es par ce module
840     end
841 end
842 </highlight>
843
844 <highlight language="lua">
845 r:loaded_modules() -- Renvoie une liste des modules charg&eacute;s par
846 httpd.
847
848 for k, module in pairs(r:loaded_modules()) do
849     r:puts("J'ai charg&eacute; le module " .. module .. "\n")
850 end
851 </highlight>
852
853 <highlight language="lua">
854 r:runtime_dir_relative(filename) -- G&eacute;n&egrave;re le nom d'un fichier run-time
855 (par exemple la m&eacute;moire partag&eacute;e "file") relativement au r&eacute;pertoire de
856 run-time. 
857 </highlight>
858
859 <highlight language="lua">
860 r:server_info() -- Renvoie une table contenant des informations
861 &agrave; propos du serveur, comme le nom de l'ex&eacute;cutable httpd, le
862 module mpm utilis&eacute;, etc...
863 </highlight>
864
865 <highlight language="lua">
866 r:set_document_root(file_path) -- D&eacute;finit la racine des
867 documents pour la requ&ecirc;te &agrave; file_path.
868 </highlight>
869
870 <highlight language="lua">
871 r:add_version_component(component_string) -- Ajoute un &eacute;l&eacute;ment &agrave;
872 la banni&egrave;re du serveur.
873 </highlight>
874
875 <highlight language="lua">
876 r:set_context_info(prefix, docroot) -- D&eacute;finit le pr&eacute;fixe et la
877 racine des documents du contexte pour une requ&ecirc;te.
878 </highlight>
879
880 <highlight language="lua">
881 r:os_escape_path(file_path) -- Convertit un chemin du syst&egrave;me de
882 fichiers en URL ind&eacute;pendamment du syst&egrave;me d'exploitation.
883 </highlight>
884
885 <highlight language="lua">
886 r:escape_logitem(string) -- Echappe une cha&icirc;ne pour
887 journalisation.
888 </highlight>
889
890 <highlight language="lua">
891 r:strcmp_match(string, pattern) -- V&eacute;rifie si 'string' correspond &agrave;
892 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
893 'www.example.com' correspond &agrave; '*.example.com' ?
894
895 local match = r:strcmp_match("foobar.com", "foo*.com")
896 if match then 
897     r:puts("foobar.com matches foo*.com")
898 end
899 </highlight>
900
901 <highlight language="lua">
902 r:set_keepalive() -- D&eacute;finit l'&eacute;tat de persistance d'une
903 requ&ecirc;te. Renvoie true dans la mesure du possible, false dans le
904 cas contraire.
905 </highlight>
906
907 <highlight language="lua">
908 r:make_etag() -- G&eacute;n&egrave;re et renvoie le etag pour la requ&ecirc;te
909 courante.
910 </highlight>
911
912 <highlight language="lua">
913 r:send_interim_response(clear) -- Renvoie une r&eacute;ponse d'int&eacute;rim (1xx) au
914 client. Si 'clear' est vrai, les en-t&ecirc;tes disponibles seront envoy&eacute;s et
915 effac&eacute;s.
916 </highlight>
917
918 <highlight language="lua">
919 r:custom_response(status_code, string) -- G&eacute;n&egrave;re et d&eacute;finit une r&eacute;ponse
920 personnalis&eacute;e pour un code d'&eacute;tat particulier. Le fonctionnement est
921 tr&egrave;s proche de celui de la directive ErrorDocument.
922
923 r:custom_response(404, "Baleted!")
924 </highlight>
925
926 <highlight language="lua">
927 r:exists_config_define(string) -- V&eacute;rifie si une d&eacute;finition de
928 configuration existe.
929
930 if r:exists_config_define("FOO") then
931     r:puts("httpd a probablement &eacute;t&eacute; lanc&eacute; avec l'option -DFOO, ou FOO a
932     &eacute;t&eacute; d&eacute;fini dans la configuration")
933 end
934 </highlight>
935
936 <highlight language="lua">
937 r:state_query(string) -- Interroge le serveur &agrave; propos de son
938 &eacute;tat.
939 </highlight>
940
941 <highlight language="lua">
942 r:stat(filename) -- Ex&eacute;cute stat() sur un fichier, et renvoie
943 une table contenant des informations &agrave; propos de ce fichier.
944
945 local info = r:stat("/var/www/foo.txt")
946 if info then
947     r:puts("Ce fichier existe et a &eacute;t&eacute; modifi&eacute; pour la derni&egrave;re fois &agrave; : " .. info.modified)
948 end
949 </highlight>
950
951 <highlight language="lua">
952 r:regex(string, pattern) -- Ex&eacute;cute une recherche &agrave; base
953 d'expression rationnelle sur une cha&icirc;ne, et renvoie les
954 &eacute;ventuelles correspondances trouv&eacute;es.
955
956 local matches = r:regex("foo bar baz", "foo (\w+) (\S*)")
957 if matches then
958     r:puts("L'expression rationnelle correspond et le dernier mot
959     captur&eacute; ($2) est : " .. matches[2])
960 end
961 </highlight>
962
963 <highlight language="lua">
964 r:sleep(secondes) -- Interrompt l'ex&eacute;cution du script pendant le nombre de secondes sp&eacute;cifi&eacute;.
965                   -- 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.
966 </highlight>
967
968 <highlight language="lua">
969 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion &agrave; une
970 base de donn&eacute;es et renvoie une classe database. Voir '<a
971 href="#databases">Connectivit&eacute; aux bases de donn&eacute;es</a>' pour plus de
972 d&eacute;tails.
973 </highlight>
974         
975
976 </section>
977
978 <section id="logging"><title>Fonctions de journalisation</title>
979
980 <highlight language="lua">
981         -- exemples de messages de journalisation
982         r:trace1("Ceci est un message de journalisation de niveau
983         trace") -- les niveaux valides vont de trace1 &agrave; trace8 <br />
984         r:debug("Ceci est un message de journalisation de niveau debug")<br />
985         r:info("Ceci est un message de journalisation de niveau info")<br />
986         r:notice("Ceci est un message de journalisation de niveau notice")<br />
987         r:warn("Ceci est un message de journalisation de niveau warn")<br />
988         r:err("Ceci est un message de journalisation de niveau err")<br />
989         r:alert("Ceci est un message de journalisation de niveau alert")<br />
990         r:crit("Ceci est un message de journalisation de niveau crit")<br />
991         r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
992 </highlight>
993
994 </section>
995
996 <section id="apache2"><title>Paquet apache2</title>
997 <p>Le paquet nomm&eacute; <code>apache2</code> est fourni avec (au minimum) le
998 contenu suivant :</p>
999 <dl>
1000   <dt>apache2.OK</dt>
1001   <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1002   s'ils ont trait&eacute; la requ&ecirc;te.</dd>
1003   <dt>apache2.DECLINED</dt>
1004   <dd>Constante interne DECLINED. Les gestionnaires renverront cette
1005   valeur s'ils n'ont pas l'intention de traiter la requ&ecirc;te.</dd>
1006   <dt>apache2.DONE</dt>
1007   <dd>Constante interne DONE.</dd>
1008   <dt>apache2.version</dt>
1009   <dd>Cha&icirc;ne contenant la version du serveur HTTP Apache</dd>
1010   <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1011   <dd>Code d'&eacute;tat HTTP</dd>
1012   <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1013   <dd>Constantes internes utilis&eacute;es par <module>mod_proxy</module></dd>
1014   <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1015   <dd>constantes internes utilis&eacute;es par <module>mod_authz_core</module></dd>
1016
1017 </dl>
1018 <p>Les autres codes d'&eacute;tat HTTP ne sont pas encore impl&eacute;ment&eacute;s.</p>
1019 </section>
1020
1021
1022 <section id="modifying_buckets">
1023     <title>Modification de contenu avec les filtres lua</title>
1024     <p>
1025     Les fonctions de filtrage impl&eacute;ment&eacute;es via les directives <directive
1026     module="mod_lua">LuaInputFilter</directive> ou <directive
1027     module="mod_lua">LuaOutputFilter</directive> sont con&ccedil;ues comme des
1028     fonctions de 3&egrave;me phase non blocantes utilisant des sous-routines
1029     pour suspendre et reprendre l'ex&eacute;cution d'une fonction lorsque des
1030     paquets de donn&eacute;es sont envoy&eacute;s &agrave; la cha&icirc;ne de filtrage. La
1031     structure de base d'une telle fonction est :
1032     </p>
1033     <highlight language="lua">
1034 function filter(r)
1035     -- Nous indiquons tout d'abord que nous sommes pr&ecirc;ts &agrave; recevoir des
1036     -- blocs de donn&eacute;es.
1037     -- Avant ceci, nous pouvons d&eacute;finir notre environnement, tester
1038     -- certaines conditions, et, si nous le jugeons n&eacute;cessaire, refuser le
1039     -- filtrage d'une requ&ecirc;te :
1040     if something_bad then
1041         return -- Le filtrage est saut&eacute;
1042     end
1043     -- 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.
1044     -- 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.
1045     -- Les filtres en entr&eacute;e peuvent ajouter des &eacute;l&eacute;ments &agrave; la fin des donn&eacute;es au stade final.
1046
1047     coroutine.yield([optional header to be prepended to the content])
1048
1049     -- Apr&egrave;s cet arr&ecirc;t, nous allons recevoir d'autres blocs de donn&eacute;es, un par un ;
1050     -- nous pouvons les traiter comme il nous pla&icirc;t et proc&eacute;der &agrave; la r&eacute;ponse.
1051     -- Ces blocs sont conserv&eacute;s dans la variable globale 'bucket', nous r&eacute;alisons donc
1052     -- une boucle pour v&eacute;rifier que 'bucket' n'est pas vide :
1053     while bucket ~= nil do
1054         local output = mangle(bucket) -- Do some stuff to the content
1055         coroutine.yield(output) -- Return our new content to the filter chain
1056     end
1057
1058     -- Une fois les blocs de donn&eacute;es &eacute;puis&eacute;s, 'bucket' est positionn&eacute; &agrave; une valeur vide ('nil'),
1059     -- ce qui va nous faire sortir de cette boucle et nous amener &agrave; l'&eacute;tape suivante.
1060     -- On peut ajouter ce qu'on veut &agrave; la fin des donn&eacute;es &agrave; cette &eacute;tape, qui constitue le dernier
1061     -- arr&ecirc;t. Les filtres d'entr&eacute;e comme de sortie peuvent servir &agrave; ajouter des &eacute;l&eacute;ments &agrave; la fin
1062     --  des donn&eacute;es &agrave; cette &eacute;tape.
1063     coroutine.yield([optional footer to be appended to the content])
1064 end
1065     </highlight>
1066 </section>
1067 <section id="databases">
1068     <title>Connectivit&eacute; aux bases de donn&eacute;es</title>
1069     <p>Mod_lua impl&eacute;mente une fonctionnalit&eacute; basique de connexion aux
1070 bases de donn&eacute;es permettant d'envoyer des requ&ecirc;tes ou d'ex&eacute;cuter des
1071 commandes aupr&egrave;s des moteurs de base de donn&eacute;es les plus courants
1072 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1073     </p>
1074     <p>L'exemple suivant montre comment se connecter &agrave; une base de
1075 donn&eacute;es et extraire des informations d'une table :</p>
1076     <highlight language="lua">
1077 function handle(r)
1078     -- connexion &agrave; la base de donn&eacute;es
1079     local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
1080     if not err then
1081         -- S&eacute;lection de certaines informations
1082         local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1083         if not err then
1084             local rows = results(0) -- extrait tous les enregistrements en mode synchrone
1085             for k, row in pairs(rows) do
1086                 r:puts( string.format("Name: %s, Age: %s&lt;br/&gt;", row[1], row[2]) )
1087             end
1088         else
1089             r:puts("Database query error: " .. err)
1090         end
1091         database:close()
1092     else
1093         r:puts("Connexion &agrave; la base de donn&eacute;es impossible : " .. err)
1094     end
1095 end
1096     </highlight>
1097     <p>
1098     Pour utiliser <module>mod_dbd</module>, sp&eacute;cifiez
1099 <code>mod_dbd</code> comme type de base de donn&eacute;es, ou laissez le champ
1100 vide :
1101     </p>
1102     <highlight language="lua">
1103     local database = r:dbacquire("mod_dbd")
1104     </highlight>
1105     <section id="database_object">
1106         <title>L'objet database et ses m&eacute;thodes</title>
1107         <p>L'objet database renvoy&eacute; par <code>dbacquire</code> poss&egrave;de
1108 les m&eacute;thodes suivantes :</p>
1109         <p><strong>S&eacute;lection normale et requ&ecirc;te vers une base de donn&eacute;es
1110 :</strong></p>
1111     <highlight language="lua">
1112 -- Ex&eacute;cution d'une requ&ecirc;te et renvoie du nombre d'enregistrements
1113 affect&eacute;s :
1114 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1115
1116 -- Ex&eacute;cution d'une requ&ecirc;te et renvoie du r&eacute;sultat qui peut &ecirc;tre utilis&eacute;
1117 en mode synchrone ou asynchrone :
1118 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1119     </highlight>
1120         <p><strong>Utilisation de requ&ecirc;tes pr&eacute;par&eacute;es (recommand&eacute;) :</strong></p>
1121     <highlight language="lua">
1122 -- Cr&eacute;ation et ex&eacute;cution d'une requ&ecirc;te pr&eacute;par&eacute;e :
1123 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1124 if not errmsg then
1125     local result, errmsg = statement:query(20) -- ex&eacute;cute la requ&ecirc;te pour age &gt; 20
1126 end
1127
1128 -- Extrait une requ&ecirc;te pr&eacute;par&eacute;e depuis une directive DBDPrepareSQL :
1129 local statement, errmsg = database:prepared(r, "someTag")
1130 if not errmsg then
1131     local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requ&ecirc;te
1132 end
1133
1134 </highlight>
1135         <p><strong>Echappement de valeurs, fermeture de la base donn&eacute;es,
1136 etc...</strong></p>
1137     <highlight language="lua">
1138 -- Echappe une valeur pour pouvoir l'utiliser dans une requ&ecirc;te :
1139 local escaped = database:escape(r, [["'|blabla]])
1140
1141 -- Ferme une base de donn&eacute;es et lib&egrave;re les liens vers cette derni&egrave;re :
1142 database:close()
1143
1144 -- V&eacute;rifie si une connexion &agrave; une base de donn&eacute;es est en service et
1145 op&eacute;rationnelle :
1146 local connected = database:active()
1147     </highlight>
1148     </section>
1149     <section id="result_sets">
1150     <title>Travail avec les jeux d'enregistrements renvoy&eacute;s par les requ&ecirc;tes</title>
1151     <p>Les jeux d'enregistrements renvoy&eacute;s par <code>db:select</code> ou par des
1152 requ&ecirc;tes pr&eacute;par&eacute;es cr&eacute;&eacute;es par <code>db:prepare</code> permettent de
1153 s&eacute;lectionner des enregistrements en mode synchrone ou
1154 asynchrone, selon le nombre d'enregistrements sp&eacute;cifi&eacute; :<br/>
1155     <code>result(0)</code> s&eacute;lectionne tous les enregistrements en mode
1156 synchrone en renvoyant une table d'enregistrements.<br/>
1157     <code>result(-1)</code> s&eacute;lectionne le prochain enregistrement disponible en
1158 mode asynchrone.<br/>
1159     <code>result(N)</code> s&eacute;lectionne l'enregistrement num&eacute;ro
1160 <code>N</code> en mode asynchrone.
1161     </p>
1162     <highlight language="lua">
1163 -- extrait un jeu d'enregistrements via une requ&ecirc;te r&eacute;guli&egrave;re :
1164 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1165
1166 local rows = result(0) -- s&eacute;lectionne tous les enregistrements en mode synchrone
1167 local row = result(-1) -- s&eacute;lectionne le prochain enregistrement disponible en mode asynchrone
1168 local row = result(1234) -- s&eacute;lectionne l'enregistrement 1234 en mode asynchrone
1169     </highlight>
1170     <p>Il est possible de construire une fonction qui renvoie une
1171 fonction it&eacute;rative permettant de traiter tous les enregistrement en mode
1172 synchrone ou asynchrone selon la valeur de l'argument async :
1173     </p>
1174     <highlight language="lua">
1175 function rows(resultset, async)
1176     local a = 0
1177     local function getnext()
1178         a = a + 1
1179         local row = resultset(-1)
1180         return row and a or nil, row
1181     end
1182     if not async then
1183         return pairs(resultset(0))
1184     else
1185         return getnext, self
1186     end
1187 end
1188
1189 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1190 if not err then
1191      -- s&eacute;lectionne des enregistrements en mode asynchrone :
1192     local result, err = statement:select(20)
1193     if not err then
1194         for index, row in rows(result, true) do
1195             ....
1196         end
1197     end
1198
1199      -- s&eacute;lectionne des enregistrements en mode synchrone :
1200     local result, err = statement:select(20)
1201     if not err then
1202         for index, row in rows(result, false) do
1203             ....
1204         end
1205     end
1206 end
1207     </highlight>
1208     </section>
1209     <section id="closing_databases">
1210         <title>Fermeture d'une connexion &agrave; une base de donn&eacute;es</title>
1211
1212     <p>Lorsqu'elles ne sont plus utilis&eacute;es, les connexions aux bases de
1213 donn&eacute;es doivent &ecirc;tre ferm&eacute;es avec <code>database:close()</code>. Si vous
1214 ne les fermez pas manuellement, mod_lua les fermera peut-&ecirc;tre en tant
1215 que r&eacute;sidus collect&eacute;s, mais si ce n'est pas le cas, vous pouvez finir
1216 pas avoir trop de connexions vers la base de donn&eacute;es inutilis&eacute;es. Les
1217 deux mesures suivantes sont pratiquement identiques :
1218     </p>
1219     <highlight language="lua">
1220 -- M&eacute;thode 1 : fermeture manuelle de la connexion
1221 local database = r:dbacquire("mod_dbd")
1222 database:close() -- c'est tout
1223
1224 -- M&eacute;thode 2 : on laisse le collecteur de r&eacute;sidus la fermer
1225 local database = r:dbacquire("mod_dbd")
1226 database = nil -- on coupe le lien
1227 collectgarbage() -- fermeture de la connexion par le collecteur de r&eacute;sidus
1228 </highlight>
1229     </section>
1230     <section id="database_caveat">
1231     <title>Pr&eacute;cautions &agrave; prendre lorsque l'on travaille avec les bases
1232 de donn&eacute;es</title>
1233     <p>Bien que les fonctions <code>query</code> et <code>run</code>
1234 soient toujours disponibles, il est recommand&eacute; d'utiliser des requ&ecirc;tes
1235 pr&eacute;par&eacute;es chaque fois que possible, afin d'une part d'optimiser les
1236 performances (si votre connexion reste longtemps en vie), et d'autre part
1237 minimiser le risque d'attaques par injection SQL. Les fonctions
1238 <code>run</code> et <code>query</code> ne doivent &ecirc;tre utilis&eacute;es que
1239 lorsque la requ&ecirc;te ne contient pas de variables (requ&ecirc;te statique). Dans
1240 le cas des requ&ecirc;tes dynamiques, utilisez <code>db:prepare</code> ou
1241 <code>db:prepared</code>.
1242     </p>
1243     </section>
1244
1245 </section>
1246
1247 <directivesynopsis>
1248 <name>LuaRoot</name>
1249 <description>Sp&eacute;cifie le chemin de base pour la r&eacute;solution des chemins
1250 relatifs dans les directives de mod_lua</description>
1251 <syntax>LuaRoot /chemin/vers/un/r&eacute;pertoire</syntax>
1252 <contextlist><context>server config</context><context>virtual host</context>
1253 <context>directory</context><context>.htaccess</context>
1254 </contextlist>
1255 <override>All</override>
1256
1257 <usage>
1258     <p>Cette directive permet de sp&eacute;cifier le chemin de base qui sera
1259     utilis&eacute; pour &eacute;valuer tous les chemins relatifs dans mod_lua. En
1260     l'absence de cette directive, les chemins relatifs sont r&eacute;solus par
1261     rapport au r&eacute;pertoire de travail courant, ce qui ne sera pas
1262     toujours appropri&eacute; pour un serveur.</p>
1263 </usage>
1264 </directivesynopsis>
1265
1266 <directivesynopsis>
1267 <name>LuaScope</name>
1268 <description>Une valeur parmi once, request, conn, thread -- la valeur
1269 par d&eacute;faut est once</description>
1270 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
1271 <default>LuaScope once</default>
1272 <contextlist><context>server config</context><context>virtual host</context>
1273 <context>directory</context><context>.htaccess</context>
1274 </contextlist>
1275 <override>All</override>
1276
1277 <usage>
1278     <p>Cette directive permet de sp&eacute;cifier la dur&eacute;e de vie de
1279     l'interpr&eacute;teur Lua qui sera utilis&eacute; dans ce "r&eacute;pertoire". La valeur
1280     par d&eacute;faut est "once".</p>
1281
1282    <dl>
1283     <dt>once:</dt> <dd>utilise l'interpr&eacute;teur une fois.</dd>
1284
1285     <dt>request:</dt> <dd>utilise l'interpr&eacute;teur pour traiter tout ce
1286     qui est bas&eacute; sur le m&ecirc;me fichier dans la requ&ecirc;te, et qui se trouve
1287     aussi dans la port&eacute;e de la requ&ecirc;te.</dd>
1288
1289     <dt>conn:</dt> <dd>idem request, mais attach&eacute; &agrave; connection_rec</dd>
1290
1291     <dt>thread:</dt> <dd>Utilise l'interpr&eacute;teur pendant toute la dur&eacute;e
1292     de vie du thread qui traite la requ&ecirc;te (disponible seulement avec
1293     les MPMs thread&eacute;s).</dd>
1294
1295     <dt>server:</dt>  <dd>Le comportement est ici diff&eacute;rent, car la
1296     port&eacute;e du serveur pr&eacute;sente une dur&eacute;e de vie assez longue, et
1297     plusieurs threads vont partager le m&ecirc;me server_rec. Pour g&eacute;rer tout
1298     ceci, les &eacute;tats lua du serveur sont stock&eacute;s dans une liste de ressources
1299     apr. Les arguments <code>min</code> et <code>max</code> permettent
1300     de sp&eacute;cifier les nombres minimaux et maximaux d'&eacute;tats lua &agrave; stocker
1301     dans la liste.</dd>
1302    </dl>
1303    <p>En g&eacute;n&eacute;ral, les port&eacute;es <code>thread</code> et <code>server</code>
1304    sont 2 &agrave; 3 fois plus rapides que les autres, car elles n'ont pas besoin
1305    de r&eacute;g&eacute;n&eacute;rer de nouveaux &eacute;tats Lua &agrave; chaque requ&ecirc;te (comme c'est le
1306    cas avec le MPM event, o&ugrave; m&ecirc;me les connexions persistantes utilisent un
1307    nouveau thread pour chaque requ&ecirc;te). Si vous pensez que vos scripts
1308    n'auront pas de probl&egrave;me s'il r&eacute;utilisent un &eacute;tat, alors les port&eacute;es
1309    <code>thread</code> ou <code>server</code> doivent &ecirc;tre utilis&eacute;es car
1310    elles pr&eacute;senteront de meilleures performances. Alors que la port&eacute;e
1311    <code>thread</code> fournira les r&eacute;ponses les plus rapides, la port&eacute;e
1312    <code>server</code> utilisera moins de m&eacute;moire car les &eacute;tats sont
1313    rassembl&eacute;s dans des jeux, permettant par exemple &agrave; 1000 threads de
1314    partager 100 &eacute;tats Lua, ne n&eacute;cessitant ainsi que 10% de la m&eacute;moire
1315    requise par la port&eacute;e <code>thread</code>.
1316     </p>
1317 </usage>
1318 </directivesynopsis>
1319
1320 <directivesynopsis>
1321 <name>LuaMapHandler</name>
1322 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
1323 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
1324 [nom-fonction]</syntax>
1325 <contextlist><context>server config</context><context>virtual host</context>
1326 <context>directory</context><context>.htaccess</context>
1327 </contextlist>
1328 <override>All</override>
1329 <usage>
1330     <p>Cette directive permet de faire correspondre un mod&egrave;le d'uri avec
1331     une fonction de gestionnaire situ&eacute;e dans un fichier sp&eacute;cifique. Elle
1332     utilise les expressions rationnelles PCRE pour mettre en
1333     correspondance l'uri, et supporte les groupes de correspondance
1334     d'interpolation dans le chemin du fichier et le nom de la fonction.
1335     Prenez garde aux probl&egrave;mes de s&eacute;curit&eacute; en &eacute;crivant vos expressions
1336     rationnelles.</p>
1337    <example><title>Exemples :</title>
1338     <highlight language="config">
1339     LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1340     </highlight>
1341    </example>
1342         <p>Cette directive va faire correspondre des uri comme
1343         /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
1344         fonction de gestionnaire handle_show au niveau de la vm lua
1345         apr&egrave;s chargement de ce fichier.</p>
1346
1347 <highlight language="config">
1348     LuaMapHandler /bingo /scripts/wombat.lua
1349 </highlight>
1350         <p>Cette directive invoquera la fonction "handle" qui est la
1351         valeur par d&eacute;faut si aucun nom de fonction sp&eacute;cifique n'est
1352         sp&eacute;cifi&eacute;.</p>
1353 </usage>
1354 </directivesynopsis>
1355
1356 <directivesynopsis>
1357 <name>LuaPackagePath</name>
1358 <description>Ajoute un r&eacute;pertoire au package.path de lua</description>
1359 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
1360 <contextlist><context>server config</context><context>virtual host</context>
1361 <context>directory</context><context>.htaccess</context>
1362 </contextlist>
1363 <override>All</override>
1364     <usage><p>Cette directive permet d'ajouter un chemin &agrave; la liste des
1365     chemins de recherche du module lua. Elle suit les m&ecirc;mes conventions
1366     que lua. Ceci modifie le package.path dans les vms lua.</p>
1367
1368     <example><title>Exemples :</title>
1369         <highlight language="config">
1370 LuaPackagePath /scripts/lib/?.lua
1371 LuaPackagePath /scripts/lib/?/init.lua
1372     </highlight>
1373     </example>
1374 </usage>
1375 </directivesynopsis>
1376
1377 <directivesynopsis>
1378 <name>LuaPackageCPath</name>
1379 <description>Ajoute un r&eacute;pertoire au package.cpath de lua</description>
1380 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
1381 <contextlist><context>server config</context><context>virtual host</context>
1382 <context>directory</context><context>.htaccess</context>
1383 </contextlist>
1384 <override>All</override>
1385
1386 <usage>
1387     <p>Cette directive permet d'ajouter un chemin &agrave; la liste des chemins
1388     de recherche des biblioth&egrave;ques partag&eacute;es de lua. Ceci modifie le
1389     package.cpath dans les vms lua.</p>
1390
1391 </usage>
1392 </directivesynopsis>
1393
1394 <directivesynopsis>
1395 <name>LuaCodeCache</name>
1396 <description>Configure le cache de code compil&eacute;.</description>
1397 <syntax>LuaCodeCache stat|forever|never</syntax>
1398 <default>LuaCodeCache stat</default>
1399 <contextlist>
1400 <context>server config</context><context>virtual host</context>
1401 <context>directory</context><context>.htaccess</context>
1402 </contextlist>
1403 <override>All</override>
1404
1405 <usage><p>
1406     Cette directive permet de d&eacute;finir le comportement du cache de code
1407     en m&eacute;moire. La valeur par d&eacute;faut est stat ; dans ce cas, le script
1408     du niveau le plus haut (et pas les scripts inclus) est v&eacute;rifi&eacute; &agrave;
1409     chaque fois que ce fichier est n&eacute;cessaire, et est recharg&eacute; si la
1410     date de modification est plus r&eacute;cente que celle du script d&eacute;j&agrave;
1411     charg&eacute;. Les autres valeurs permettent respectivement de garder le
1412     fichier en cache perp&eacute;tuellement (forever - jamais v&eacute;rifi&eacute; ni
1413     remplac&eacute;), ou de ne jamais le mettre en cache (never).</p>
1414
1415     <p>En g&eacute;n&eacute;ral, les valeurs stat et forever sont utilis&eacute;es pour un
1416     serveur en production, et les valeurs stat ou never pour un serveur
1417     en d&eacute;veloppement.</p>
1418
1419     <example><title>Exemples :</title>
1420         <highlight language="config">
1421 LuaCodeCache stat
1422 LuaCodeCache forever
1423 LuaCodeCache never
1424     </highlight>
1425     </example>
1426
1427 </usage>
1428 </directivesynopsis>
1429
1430 <directivesynopsis>
1431 <name>LuaHookTranslateName</name>
1432 <description>Fournit un point d'entr&eacute;e &agrave; la phase du nom de
1433 traduction du traitement de la requ&ecirc;te</description>
1434 <syntax>LuaHookTranslateName  /chemin/vers/lua/script.lua  nom_fonction_hook [early|late]</syntax>
1435 <contextlist><context>server config</context><context>virtual host</context>
1436 </contextlist>
1437 <override>All</override>
1438 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1439 version 2.3.15 du serveur HTTP Apache.</compatibility>
1440
1441 <usage><p>
1442     Cette directive permet d'ajouter un point d'entr&eacute;e (&agrave;
1443     APR_HOOK_MIDDLE) &agrave; la phase du nom de traduction du traitement de la
1444     requ&ecirc;te. La fonction hook accepte un seul argument, le request_rec,
1445     et doit renvoyer un code d'&eacute;tat qui est soit un code d'erreur HTTP,
1446     ou une constante d&eacute;finie dans le module apache2 :  apache2.OK,
1447     apache2.DECLINED, ou apache2.DONE.</p>
1448
1449     <p>Pour ceux qui ne sont pas familiers avec les points d'entr&eacute;e
1450     (hook), en gros, chaque hook sera invoqu&eacute; jusqu'&agrave; ce que l'un
1451     d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
1452     traduction, il doit juste renvoyer apache2.DECLINED. Si le
1453     traitement de la requ&ecirc;te doit &ecirc;tre interrompu, la valeur renvoy&eacute;e
1454     doit &ecirc;tre apache2.DONE.</p>
1455
1456     <p>Exemple :</p>
1457
1458 <highlight language="config">
1459 # httpd.conf
1460 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1461 </highlight>
1462
1463 <highlight language="lua">
1464 -- /scripts/conf/hooks.lua --
1465 require "apache2"
1466 function silly_mapper(r)
1467     if r.uri == "/" then
1468         r.filename = "/var/www/home.lua"
1469         return apache2.OK
1470     else
1471         return apache2.DECLINED
1472     end
1473 end
1474 </highlight>
1475
1476    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
1477    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
1478    module="core">Directory</directive> ou <directive type="section"
1479    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1480
1481    <note><title>Ordonnancement</title><p>Les arguments optionnels
1482    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1483    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1484 </usage>
1485 </directivesynopsis>
1486
1487 <directivesynopsis>
1488 <name>LuaHookFixups</name>
1489 <description>Fournit un point d'entr&eacute;e pour la phase de correction du
1490 traitement de la requ&ecirc;te</description>
1491 <syntax>LuaHookFixups  /chemin/vers/lua/script.lua hook_function_name</syntax>
1492 <contextlist><context>server config</context><context>virtual host</context>
1493 <context>directory</context><context>.htaccess</context>
1494 </contextlist>
1495 <override>All</override>
1496 <usage>
1497 <p>
1498     Idem LuaHookTranslateName, mais s'ex&eacute;cute durant la phase de
1499     correction.
1500 </p>
1501 </usage>
1502 </directivesynopsis>
1503
1504 <directivesynopsis>
1505 <name>LuaHookMapToStorage</name>
1506 <description>Fournit un point d'entr&eacute;e pour la phase map_to_storage du
1507 traitement de la requ&ecirc;te</description>
1508 <syntax>LuaHookMapToStorage  /chemin/vers/lua/script.lua hook_function_name</syntax>
1509 <contextlist><context>server config</context><context>virtual host</context>
1510 <context>directory</context><context>.htaccess</context>
1511 </contextlist>
1512 <override>All</override>
1513     <usage>
1514     <p>Identique &agrave; la directive
1515     <directive>LuaHookTranslateName</directive>, mais s'ex&eacute;cute &agrave; la
1516     phase map-to-storage du traitement de la requ&ecirc;te. Les modules comme
1517     mod_cache agissent pendant cette phase, ce qui permet de pr&eacute;senter
1518     un exemple int&eacute;ressant de ce que l'on peut faire ici :</p>
1519     <highlight language="config">
1520     LuaHookMapToStorage /path/to/lua/script.lua check_cache
1521     </highlight>
1522     <highlight language="lua">
1523 require"apache2"
1524 cached_files = {}
1525
1526 function read_file(filename)
1527     local input = io.open(filename, "r")
1528     if input then
1529         local data = input:read("*a")
1530         cached_files[filename] = data
1531         file = cached_files[filename]
1532         input:close()
1533     end
1534     return cached_files[filename]
1535 end
1536
1537 function check_cache(r)
1538     if r.filename:match("%.png$") then -- Only match PNG files
1539         local file = cached_files[r.filename] -- Check cache entries
1540         if not file then
1541             file = read_file(r.filename)  -- Read file into cache
1542         end
1543         if file then -- If file exists, write it out
1544             r.status = 200
1545             r:write(file)
1546             r:info(("Sent %s to client from cache"):format(r.filename))
1547             return apache2.DONE -- skip default handler for PNG files
1548         end
1549     end
1550     return apache2.DECLINED -- If we had nothing to do, let others serve this.
1551 end
1552     </highlight>
1553
1554     </usage>
1555 </directivesynopsis>
1556
1557 <directivesynopsis>
1558 <name>LuaHookCheckUserID</name>
1559 <description>Fournit un point d'entr&eacute;e pour la phase check_user_id du
1560 traitement de la requ&ecirc;te</description>
1561 <syntax>LuaHookCheckUserID  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1562 <contextlist><context>server config</context><context>virtual host</context>
1563 <context>directory</context><context>.htaccess</context>
1564 </contextlist>
1565 <override>All</override>
1566 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1567 version 2.3.15 du serveur HTTP Apache.</compatibility>
1568 <usage><p>...</p>
1569    <note><title>Ordonnancement</title><p>Les arguments optionnels
1570    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1571    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1572 </usage>
1573 </directivesynopsis>
1574
1575 <directivesynopsis>
1576 <name>LuaHookTypeChecker</name>
1577 <description>Fournit un point d'entr&eacute;e pour la phase type_checker du
1578 traitement de la requ&ecirc;te</description>
1579 <syntax>LuaHookTypeChecker  /chemin/vers/lua/script.lua hook_function_name</syntax>
1580 <contextlist><context>server config</context><context>virtual host</context>
1581 <context>directory</context><context>.htaccess</context>
1582 </contextlist>
1583 <override>All</override>
1584     <usage><p>...</p></usage>
1585 </directivesynopsis>
1586
1587 <directivesynopsis>
1588 <name>LuaHookAuthChecker</name>
1589 <description>Fournit un point d'entr&eacute;e pour la phase auth_checker du
1590 traitement de la requ&ecirc;te</description>
1591 <syntax>LuaHookAuthChecker  /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1592 <contextlist><context>server config</context><context>virtual host</context>
1593 <context>directory</context><context>.htaccess</context>
1594 </contextlist>
1595 <override>All</override>
1596 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1597 version 2.3.15 du serveur HTTP Apache.</compatibility>
1598     <usage>
1599 <p>Invoque une fonction lua au cours de la phase auth_checker du
1600 traitement de la requ&ecirc;te. Cette directive peut s'utiliser pour
1601 impl&eacute;menter une v&eacute;rification arbitraire de l'authentification et de
1602 l'autorisation. Voici un exemple tr&egrave;s simple :
1603 </p>
1604 <highlight language="lua">
1605 require 'apache2'
1606
1607 -- fonction d'accroche authcheck fictive
1608 -- Si la requ&ecirc;te ne contient aucune donn&eacute;e d'authentification, l'en-t&ecirc;te
1609 -- de la r&eacute;ponse est d&eacute;fini et un code 401 est renvoy&eacute; afin de demander au
1610 -- navigateur d'effectuer une authentification basique. Si la requ&ecirc;te
1611 -- comporte des donn&eacute;es d'authentification, elles ne sont pas vraiment
1612 -- consult&eacute;es, mais on admet la prise en compte de l'utilisateur 'foo' et
1613 -- on la valide. On v&eacute;rifie ensuite si l'utilisateur est bien 'foo' et on
1614 -- accepte la requ&ecirc;te.
1615 function authcheck_hook(r)
1616
1617    -- recherche des informations d'authentification
1618    auth = r.headers_in['Authorization']
1619    if auth ~= nil then
1620      -- d&eacute;finition d'un utilisateur par d&eacute;faut
1621      r.user = 'foo'
1622    end
1623
1624    if r.user == nil then
1625       r:debug("authcheck: user is nil, returning 401")
1626       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1627       return 401
1628    elseif r.user == "foo" then
1629       r:debug('user foo: OK')
1630    else
1631       r:debug("authcheck: user='" .. r.user .. "'")
1632       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1633       return 401
1634    end
1635    return apache2.OK
1636 end
1637 </highlight>
1638 <note><title>Ordonnancement</title><p>Les arguments optionnels
1639    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1640    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1641 </usage>
1642 </directivesynopsis>
1643
1644 <directivesynopsis>
1645 <name>LuaHookAccessChecker</name>
1646 <description>Fournit un point d'entr&eacute;e pour la phase access_checker du
1647 traitement de la requ&ecirc;te</description>
1648 <syntax>LuaHookAccessChecker  /chemin/vers/lua/script.lua  hook_function_name [early|late]</syntax>
1649 <contextlist><context>server config</context><context>virtual host</context>
1650 <context>directory</context><context>.htaccess</context>
1651 </contextlist>
1652 <override>All</override>
1653 <compatibility>Le troisi&egrave;me argument optionnel est disponible depuis la
1654 version 2.3.15 du serveur HTTP Apache.</compatibility>
1655
1656 <usage>
1657 <p>Ajoute votre fonction d'accroche &agrave; la phase access_checker. Une
1658 fonction d'accroche access checker renvoie en g&eacute;n&eacute;ral OK, DECLINED, ou
1659 HTTP_FORBIDDEN.</p>
1660 <note><title>Ordonnancement</title><p>Les arguments optionnels
1661    "early" ou "late" permettent de contr&ocirc;ler le moment auquel ce script
1662    s'ex&eacute;cute par rapport aux autres modules.</p></note>
1663 </usage>
1664 </directivesynopsis>
1665 <directivesynopsis>
1666 <name>LuaHookInsertFilter</name>
1667 <description>Fournit un point d'entr&eacute;e pour la phase insert_filter du
1668 traitement de la requ&ecirc;te</description>
1669 <syntax>LuaHookInsertFilter  /chemin/vers/lua/script.lua hook_function_name</syntax>
1670 <contextlist><context>server config</context><context>virtual host</context>
1671 <context>directory</context><context>.htaccess</context>
1672 </contextlist>
1673 <override>All</override>
1674     <usage><p>Non encore impl&eacute;ment&eacute;</p></usage>
1675 </directivesynopsis>
1676
1677 <directivesynopsis>
1678 <name>LuaInherit</name>
1679 <description>Contr&ocirc;le la mani&egrave;re dont les sections de configuration
1680 parentes sont fusionn&eacute;es dans les enfants</description>
1681 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1682 <default>LuaInherit parent-first</default>
1683 <contextlist><context>server config</context><context>virtual host</context>
1684 <context>directory</context><context>.htaccess</context>
1685 </contextlist>
1686 <override>All</override>
1687 <compatibility>Versions 2.4.0 et sup&eacute;rieures</compatibility>
1688     <usage><p>Par d&eacute;faut, si des directives LuaHook* se trouvent dans
1689     des sections de configuration Directory ou Location qui se
1690     chevauchent, les scripts
1691     d&eacute;finis dans les sections les plus sp&eacute;cifiques s'ex&eacute;cutent
1692     <em>apr&egrave;s</em> ceux d&eacute;finis dans les sections plus g&eacute;n&eacute;riques
1693     (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1694     en sorte que le contexte parent ne s'applique pas du tout.</p>
1695
1696     <p>Jusqu'aux versions 2.3.x, le comportement par d&eacute;faut consistait &agrave;
1697     ignorer les directives LuaHook* situ&eacute;es dans les sections de
1698     configuration parentes.</p></usage>
1699 </directivesynopsis>
1700
1701 <directivesynopsis>
1702 <name>LuaQuickHandler</name>
1703 <description>Fournit un point d'entr&eacute;e pour la gestion rapide du
1704 traitement de la requ&ecirc;te</description>
1705 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1706 <contextlist><context>server config</context><context>virtual host</context>
1707 <context>directory</context><context>.htaccess</context>
1708 </contextlist>
1709 <override>All</override>
1710 <usage>
1711     <p>Cette phase s'ex&eacute;cute juste apr&egrave;s l'attribution de la requ&ecirc;te &agrave;
1712     un serveur virtuel, et permet d'effectuer certains traitements avant
1713     le d&eacute;roulement des autres phases, ou de servir une requ&ecirc;te sans
1714     avoir &agrave; la traduire, l'associer &agrave; un espace de stockage, etc...
1715     Comme cette phase s'ex&eacute;cute avant toute autre, les directives telles
1716     que <directive type="section" module="core">Location</directive> ou
1717     <directive type="section" module="core">Directory</directive> ne
1718     sont pas encore prises en compte, car Les URI n'ont pas encore &eacute;t&eacute;
1719     enti&egrave;rement interpr&eacute;t&eacute;s.
1720     </p>
1721    <note><title>Contexte</title><p>Cette directive ne peut &ecirc;tre
1722    utilis&eacute;e ni &agrave; l'int&eacute;rieur d'une section <directive type="section"
1723    module="core">Directory</directive> ou <directive type="section"
1724    module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1725 </usage>
1726 </directivesynopsis>
1727
1728 <directivesynopsis>
1729 <name>LuaAuthzProvider</name>
1730 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1731 </description>
1732 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1733 <contextlist><context>server config</context> </contextlist>
1734 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1735
1736 <usage>
1737 <p>Lorsqu'une fonction lua a &eacute;t&eacute; enregistr&eacute;e en tant que fournisseur
1738 d'autorisation, elle peut &ecirc;tre appel&eacute;e via la directive <directive
1739 module="mod_authz_core">Require</directive> :</p>
1740
1741
1742 <highlight language="config">
1743 LuaRoot /usr/local/apache2/lua
1744 LuaAuthzProvider foo authz.lua authz_check_foo
1745 &lt;Location /&gt;
1746   Require foo johndoe
1747 &lt;/Location&gt;
1748 </highlight>
1749 <highlight language="lua">
1750 require "apache2"
1751 function authz_check_foo(r, who)
1752     if r.user ~= who then return apache2.AUTHZ_DENIED
1753     return apache2.AUTHZ_GRANTED
1754 end
1755 </highlight>
1756
1757 </usage>
1758 </directivesynopsis>
1759
1760
1761 </modulesynopsis>
1762