2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1477000:1490091 (outdated) -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
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
16 http://www.apache.org/licenses/LICENSE-2.0
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.
25 <modulesynopsis metafile="mod_lua.xml.meta">
29 <description>Fournit des points d'entrée Lua dans différentes parties du
30 traitement des requê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érieures</compatibility>
37 <p>Ce module permet d'ajouter au serveur des extensions sous forme de
38 scripts é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êtes à des fichiers, la génération de
42 réponses dynamiques, le contrôle d'accès, l'authentification et
45 <p>Vous trouverez davantage d'informations à propos du langage de
46 programmation Lua sur <a href="http://www.lua.org/">le site web de
49 <note><code>mod_lua</code> est encore au stade expérimental. Son mode
50 d'utilisation et son comportement pourront changer à tout moment jusqu'à
51 ce qu'il passe au stade stable, et ce même entre deux versions stables
52 2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise à
55 <note type="warning"><title>Avertissement</title>
56 <p>Ce module possède une grande capacité d'action sur le fonctrionnement
57 de httpd, ce qui lui confère une grande puissance, mais peut aussi
58 induire un risque de sécurité. Il est déconseillé d'utiliser ce module
59 sur un serveur partagé 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>
66 <section id="basicconf"><title>Configuration de base</title>
68 <p>La directive de base pour le chargement du module est</p>
70 <highlight language="config">
71 LoadModule lua_module modules/mod_lua.so
75 <code>mod_lua</code> fournit un gestionnaire nommé
76 <code>lua-script</code> qui peut être utilisé avec une directive
77 <code>AddHandler</code> :</p>
79 <highlight language="config">
80 AddHandler lua-script .lua
84 Ceci aura pour effet de faire traiter les requê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.
89 <p>Pour plus de détails, voir la directive
90 <directive>LuaMapHandler</directive>.
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écifique responsable de la génération de la
97 réponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
98 <module>mod_status</module> sont des exemples de modules comportant un
101 <p><code>mod_lua</code> cherche toujours à invoquer une fonction Lua pour le
102 gestionnaire, plutôt que de simplement évaluer le corps d'un script dans
103 le style de CGI. Une fonction de gestionnaire se présente comme suit :</p>
106 <highlight language="lua">
107 <strong>example.lua</strong><br/>
108 -- exemple de gestionnaire
113 Il s'agit du nom de méthode par défaut pour les gestionnaires Lua ;
114 voir les noms de fonctions optionnels dans la directive
115 LuaMapHandler pour choisir un point d'entrée différent.
118 r.content_type = "text/plain"
119 r:puts("Hello Lua World!\n")
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) )
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) )
130 r:puts("Unsupported HTTP method " .. r.method)
136 Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
137 d'un formulaire dans un page au format texte.
141 Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
142 gestionnaires (ou points d'entrée, ou filtres) dans le même script.
146 <section id="writingauthzproviders">
147 <title>Ecriture de fournisseurs d'autorisation</title>
149 <p><module>mod_authz_core</module> fournit une interface d'autorisation
150 de haut niveau bien plus facile à utiliser que dans les hooks
151 correspondants. Le premier argument de la directive <directive
152 module="mod_authz_core">Require</directive> permet de spécifier le
153 fournisseur d'autorisation à 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écifié, le reste de la ligne constituant les paramètres. Le
157 fournisseur considéré va alors vérifier les autorisations et fournir le
158 résultat dans une valeur de retour.</p>
160 <p>En général, le fournisseur authz est appelé avant l'authentification.
161 S'il doit connaître le nom d'utilisateur authentifié (ou si
162 l'utilisateur est appelé à être authentifié), le fournisseur doit
163 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
164 déclancher le processus d'authentification et un deuxième appel du
165 fournisseur authz.</p>
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ès dans le
169 cas où la requête provient de l'adresse IP spécifiée, ou si
170 l'utilisateur authentifié correspond au second argument :</p>
172 <highlight language="lua">
173 <strong>authz_provider.lua</strong><br/>
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
185 return apache2.AUTHZ_DENIED
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
195 Require foo 10.1.2.3 john_doe
201 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
204 <p>Les fonctions d'accroche déterminent la manière dont les modules (et
205 les scripts Lua) participent au traitement des requêtes. Chaque type
206 d'accroche proposé par le serveur a un rôle spécifique, comme
207 l'association de requêtes au système de fichiers, le contrôle d'accès,
208 ou la définition de types MIME : </p>
210 <table border="1" style="zebra">
212 <th>Phase d'accroche</th>
213 <th>Directive mod_lua</th>
217 <td>Gestionnaire rapide</td>
218 <td><directive module="mod_lua">LuaQuickHandler</directive></td>
219 <td>Il s'agit de la première accroche appelée lorsqu'une requête
220 a été associée à un serveur ou un serveur virtuel.</td>
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ête en nom de fichier
226 sur le systè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>
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éfinit le lieu de stockage de la ressource :
234 physique, en cache ou externe/mandaté. Elle est assurée par les
235 modules de mandat ou de mise en cache.</td>
238 <td>Autorisation d'accès</td>
239 <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
240 <td>Cette phase vérifie si un client a l'autorisation d'accès à
241 la ressource. Elle s'exécute avant l'authentification de
242 l'utisateur ; il faut donc être prudent.
246 <td>Vérification de l'identifiant utilisateur</td>
247 <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
248 <td>Cette phase vérifie l'identifiant de l'utilisateur ayant
249 fait l'objet d'une négociation.</td>
252 <td>Vérification de l'autorisation d'accès</td>
253 <td><directive module="mod_lua">LuaHookAuthChecker</directive>
255 <directive module="mod_lua">LuaAuthzProvider</directive></td>
256 <td>Cette phase vérifie l'autorisation d'accès d'un utilisateur
257 en fonction des ses paramètres de connexion, comme
258 l'identifiant, le certificat, etc...
262 <td>Vé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 à
268 <td>Derniers réglages</td>
269 <td><directive module="mod_lua">LuaHookFixups</directive></td>
270 <td>C'est la dernière phase avant l'activation des gestionnaires
271 de contenu. Toute modification de dernière minute à la requête
272 doit être effectuée ici.</td>
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é. Les
278 fichiers sont lus, interprétés, certains sont exécutés, et le
279 résultat obtenu est envoyé au client.</td>
282 <td>Journalisation</td>
284 <td>Lorsqu'une requête a été traitée, plusieurs phases de
285 journalisation interviennent, et enregistrent leurs résultats
286 dans les fichiers d'erreur ou d'accès.</td>
291 <p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
292 argument (sauf LuaAuthzProvider qui reç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énéral d'un
295 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
296 que vous pouvez écrire dans Lua sous la forme <code>apache2.OK</code>,
297 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
300 <highlight language="lua">
301 <strong>translate_name.lua</strong><br/>
302 -- exemple d'accroche qui réécrit un URI en chemin du système de
307 function translate_name(r)
308 if r.uri == "/translate-name" then
309 r.filename = r.document_root .. "/find_me.txt"
312 -- on ne gère pas cette URL et on donne sa chance à un autre module
313 return apache2.DECLINED
318 <highlight language="lua">
319 <strong>translate_name2.lua</strong><br/>
320 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
321 un apache2.DECLINED pour permettre à un autre interpré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.
325 Note: utilisez le drapeau early/late de la directive pour
326 l'exécuter avant ou après mod_alias.
331 function translate_name(r)
332 if r.uri == "/translate-name" then
333 r.uri = "/find_me.txt"
334 return apache2.DECLINED
336 return apache2.DECLINED
341 <section id="datastructures"><title>Structures de données</title>
346 <p>request_rec est considérée en tant que donnée utilisateur.
347 Elle possède une métatable qui vous permet d'accomplir des
348 choses intéressantes. Pour la plus grande partie, elle possède
349 les mêmes champs que la structure request_rec, la
350 plupart d'entre eux étant accessibles en lecture et écriture (le
351 contenu des champs de la table peut être modifié, mais les
352 champs eux-mêmes ne peuvent pas être établis en tant que tables
355 <table border="1" style="zebra">
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>
364 <td><code>allowoverrides</code></td>
367 <td>L'option AllowOverride s'applique à la requête courante.</td>
370 <td><code>ap_auth_type</code></td>
373 <td>Ce champ contient le type d'authentification effectuée
374 (par exemple <code>basic</code>)</td>
377 <td><code>args</code></td>
380 <td>La chaîne de paramètres de la requête (par exemple
381 <code>foo=bar&name=johnsmith</code>)</td>
384 <td><code>assbackwards</code></td>
387 <td>contient true s'il s'agit d'une requête de style HTTP/0.9
388 (par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
391 <td><code>auth_name</code></td>
394 <td>La chaîne d'identification utilisée pour la vérification
395 de l'autorisation d'accès (si elle est disponible).</td>
398 <td><code>banner</code></td>
401 <td>La bannière du serveur, par exemple <code>Apache HTTP
402 Server/2.4.3 openssl/0.9.8c</code></td>
405 <td><code>basic_auth_pw</code></td>
408 <td>Le mot de passe pour l'authentification de base envoyé
409 avec la requête, s'il existe</td>
412 <td><code>canonical_filename</code></td>
415 <td>Le nom de fichier canonique de la requête</td>
418 <td><code>content_encoding</code></td>
421 <td>Le type de codage du contenu de la requête courante</td>
424 <td><code>content_type</code></td>
427 <td>Le type de contenu de la requête courante, tel qu'il a été
428 déterminé au cours de la phase type_check (par exemple
429 <code>image/gif</code> ou <code>text/html</code>)</td>
433 <td><code>context_prefix</code></td>
439 <td><code>context_document_root</code></td>
446 <td><code>document_root</code></td>
449 <td>La racine des documents du serveur</td>
452 <td><code>err_headers_out</code></td>
455 <td>L'en-tête MIME de l'environnement pour la réponse, écrit
456 même en cas d'erreur et conservé pendant les redirections
460 <td><code>filename</code></td>
463 <td>Le nom de fichier correspondant à la requête, par exemple
464 /www/example.com/foo.txt. Il peut être modifié au cours des
465 phases translate-name ou map-to-storage du traitement de la
466 requête pour permettre au gestionnaire par défaut (ou aux
467 gestionnaires de script) de servir une version du fichier
468 autre que celle demandée.</td>
471 <td><code>handler</code></td>
474 <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
475 doit traiter la requête, par exemple <code>lua-script</code>
476 si elle doit être traitée par mod_lua. Cette valeur est en
477 général définie via les directives <directive
478 module="mod_mime">AddHandler</directive> ou <directive
479 module="core">SetHandler</directive>, mais peut aussi l'être
480 via mod_lua pour permettre à un autre gestionnaire de traiter
481 une requête spécifique qui ne serait pas traitée par défaut
486 <td><code>headers_in</code></td>
489 <td>Les en-têtes MIME de l'environnement de la requête. Il
490 s'agit des en-têtes comme <code>Host, User-Agent,
491 Referer</code>, etc...</td>
494 <td><code>headers_out</code></td>
497 <td>Les en-têtes MIME de l'environnement de la réponse.</td>
500 <td><code>hostname</code></td>
503 <td>Le nom d'hôte, tel que défini par l'en-tête
504 <code>Host:</code> ou par un URI complet.</td>
507 <td><code>is_https</code></td>
510 <td>Indique si la requête à été faite via HTTPS</td>
513 <td><code>is_initial_req</code></td>
516 <td>Indique si la requête courante est la requête initiale ou
517 une sous-requête.</td>
520 <td><code>limit_req_body</code></td>
523 <td>La taille maximale du corps de la requête, ou 0 si aucune
527 <td><code>log_id</code></td>
530 <td>L'identifiant de la requête dans les journaux d'accès ou
534 <td><code>method</code></td>
537 <td>La méthode de la requête, par exemple <code>GET</code> ou
538 <code>POST</code>.</td>
541 <td><code>notes</code></td>
544 <td>Une liste de notes qui peuvent être transmises d'un module
545 à l'autre.</td>
548 <td><code>options</code></td>
551 <td>La valeur de la directive Options pour la requête
555 <td><code>path_info</code></td>
558 <td>La valeur de PATH_INFO extraite de la requête.</td>
561 <td><code>port</code></td>
564 <td>Le port du serveur utilisé par la requête.</td>
567 <td><code>protocol</code></td>
570 <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></td>
573 <td><code>proxyreq</code></td>
576 <td>Indique s'il s'agit d'une requête mandatée ou non. Cette
577 valeur est en général définie au cours de la phase
578 post_read_request/translate_name du traitement de la requête.</td>
581 <td><code>range</code></td>
584 <td>Le contenu de l'en-tête <code>Range:</code>.</td>
587 <td><code>remaining</code></td>
590 <td>Le nombre d'octets du corps de la requête restant à lire.</td>
593 <td><code>server_built</code></td>
596 <td>La date de compilation du serveur.</td>
599 <td><code>server_name</code></td>
602 <td>Le nom du serveur pour cette requête.</td>
605 <td><code>some_auth_required</code></td>
608 <td>Indique si une autorisation est/était requise pour cette
612 <td><code>subprocess_env</code></td>
615 <td>Le jeu de variables d'environnement pour cette requête.</td>
618 <td><code>started</code></td>
621 <td>Le moment où le serveur a été (re)démarré, en secondes
622 depuis epoch (1er janvier 1970)</td>
625 <td><code>status</code></td>
628 <td>Le code de retour (courant) pour cette requête, par
629 exemple <code>200</code> ou <code>404</code>.</td>
632 <td><code>the_request</code></td>
635 <td>La chaîne de la requête telle qu'elle a été envoyée par le
636 client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
639 <td><code>unparsed_uri</code></td>
642 <td>La partie URI non interprétée de la requête</td>
645 <td><code>uri</code></td>
648 <td>L'URI après interprétation par httpd</td>
651 <td><code>user</code></td>
654 <td>Si une authentification a été effectuée, nom de
655 l'utilisateur authentifié.</td>
658 <td><code>useragent_ip</code></td>
661 <td>L'adresse IP de l'agent qui a envoyé la requête</td>
667 <section id="functions"><title>Méthodes de l'objet request_rec</title>
669 <p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
671 <highlight language="lua">
672 r:flush() -- vide le tampon de sortie
673 -- Renvoie true si le vidage a été effectué avec succès,
674 false dans le cas contraire.
676 while nous_avons_des_données_à_envoyer do
677 r:puts("Bla bla bla\n") -- envoi des données à envoyer vers le tampon
678 r:flush() -- vidage du tampon (envoi au client)
679 r:sleep(0.5) -- mise en attente et bouclage
683 <highlight language="lua">
684 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
686 r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
689 <highlight language="lua">
690 r:sendfile(filename) -- envoie un fichier entier au client en
691 utilisant sendfile s'il est supporté par la plateforme :
693 if use_sendfile_thing then
694 r:sendfile("/var/www/large_file.img")
698 <highlight language="lua">
699 r:parseargs() -- renvoie deux tables : une table standard de couples
700 clé/valeur pour les données GET simples, et une autre pour les données
701 multivaluées (par exemple foo=1&foo=2&foo=3) :
703 local GET, GETMULTI = r:parseargs()
704 r:puts("Votre nom est : " .. GET['name'] or "Unknown")
708 <highlight language="lua">
709 r:parsebody()([sizeLimit]) -- interprète le corps de la requête
710 en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
711 peut être fourni pour spécifier le nombre maximal d'octets à
712 interpréter. La valeur par défaut est 8192.
714 local POST, POSTMULTI = r:parsebody(1024*1024)
715 r:puts("Votre nom est : " .. POST['name'] or "Unknown")
719 <highlight language="lua">
720 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
723 <highlight language="lua">
724 r:write("une simple chaîne") -- affichage dans le
725 corps de la réponse
728 <highlight language="lua">
729 r:escape_html("<html>test</html>") -- Echappe le
730 code HTML et renvoie le résultat
733 <highlight language="lua">
734 r:base64_encode(string) -- Encode une chaîne à l'aide du
735 standard de codage Base64.
737 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
740 <highlight language="lua">
741 r:base64_decode(string) -- Décode une chaîne codée en Base64.
743 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
746 <highlight language="lua">
747 r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne
748 en mode binaire (binary safe).
750 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
753 <highlight language="lua">
754 r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne
755 en mode binaire (binary safe).
757 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
760 <highlight language="lua">
761 r:escape(string) -- Echappe une chaîne de type URL.
763 local url = "http://foo.bar/1 2 3 & 4 + 5"
764 local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
767 <highlight language="lua">
768 r:unescape(string) -- Déséchappe une chaîne de type URL.
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 & 4 + 5'
774 <highlight language="lua">
775 r:mpm_query(number) -- Interroge le serveur à propos de son
776 module MPM via la requête ap_mpm_query.
778 local mpm = r.mpm_query(14)
780 r:puts("Ce serveur utilise le MPM Event")
784 <highlight language="lua">
785 r:expr(string) -- Evalue une chaîne de type <a
786 href="../expr.html">expr</a>.
788 if r:expr("%{HTTP_HOST} =~ /^www/") then
789 r:puts("Ce nom d'hôte commence par www")
793 <highlight language="lua">
794 r:scoreboard_process(a) -- Interroge le serveur à propos du
795 processus à la position <code>a</code>.
797 local process = r:scoreboard_process(1)
798 r:puts("Le serveur 1 a comme PID " .. process.pid)
801 <highlight language="lua">
802 r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
803 thread <code>b</code>, dans le processus <code>a</code>.
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 état est " .. thread.status)
810 <highlight language="lua">
811 r:clock() -- Renvoie l'heure courante avec une précision d'une
815 <highlight language="lua">
816 r:requestbody(filename) -- Lit et renvoie le corps d'une requête. Si
817 'filename' est spécifié, le corps de requête n'est pas renvoyé, mais
818 sauvegardé dans le fichier correspondant.
820 local input = r:requestbody()
821 r:puts("Vous m'avez envoyé le corps de requête suivant :\n")
825 <highlight language="lua">
826 r:add_input_filter(filter_name) -- Ajoute le filtre en entrée
830 <highlight language="lua">
831 r:module_info(module_name) -- Interroge le serveur à propos d'un
834 local mod = r.module_info("mod_lua.c")
836 for k, v in pairs(mod.commands) do
837 r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives implémentées par ce module
842 <highlight language="lua">
843 r:loaded_modules() -- Renvoie une liste des modules chargés par
846 for k, module in pairs(r:loaded_modules()) do
847 r:puts("J'ai chargé le module " .. module .. "\n")
851 <highlight language="lua">
852 r:runtime_dir_relative(filename) -- Génère le nom d'un fichier run-time
853 (par exemple la mémoire partagée "file") relativement au répertoire de
857 <highlight language="lua">
858 r:server_info() -- Renvoie une table contenant des informations
859 à propos du serveur, comme le nom de l'exécutable httpd, le
860 module mpm utilisé, etc...
863 <highlight language="lua">
864 r:set_document_root(file_path) -- Définit la racine des
865 documents pour la requête à file_path.
868 <highlight language="lua">
869 r:add_version_component(component_string) -- Ajoute un élément à
870 la bannière du serveur.
873 <highlight language="lua">
874 r:set_context_info(prefix, docroot) -- Définit le préfixe et la
875 racine des documents du contexte pour une requête.
878 <highlight language="lua">
879 r:os_escape_path(file_path) -- Convertit un chemin du système de
880 fichiers en URL indépendamment du système d'exploitation.
883 <highlight language="lua">
884 r:escape_logitem(string) -- Echappe une chaîne pour
888 <highlight language="lua">
889 r.strcmp_match(string, pattern) -- Vérifie si 'string' correspond à
890 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
891 'www.example.com' correspond à '*.example.com' ?
893 local match = r.strcmp_match("foobar.com", "foo*.com")
895 r:puts("foobar.com matches foo*.com")
899 <highlight language="lua">
900 r:set_keepalive() -- Définit l'état de persistance d'une
901 requête. Renvoie true dans la mesure du possible, false dans le
905 <highlight language="lua">
906 r:make_etag() -- Génère et renvoie le etag pour la requête
910 <highlight language="lua">
911 r:send_interim_response(clear) -- Renvoie une réponse d'intérim (1xx) au
912 client. Si 'clear' est vrai, les en-têtes disponibles seront envoyés et
916 <highlight language="lua">
917 r:custom_response(status_code, string) -- Génère et définit une réponse
918 personnalisée pour un code d'état particulier. Le fonctionnement est
919 très proche de celui de la directive ErrorDocument.
921 r:custom_response(404, "Baleted!")
924 <highlight language="lua">
925 r.exists_config_define(string) -- Vérifie si une définition de
926 configuration existe.
928 if r.exists_config_define("FOO") then
929 r:puts("httpd a probablement été lancé avec l'option -DFOO, ou FOO a
930 été défini dans la configuration")
934 <highlight language="lua">
935 r:state_query(string) -- Interroge le serveur à propos de son
939 <highlight language="lua">
940 r:stat(filename) -- Exécute stat() sur un fichier, et renvoie
941 une table contenant des informations à propos de ce fichier.
943 local info = r:stat("/var/www/foo.txt")
945 r:puts("Ce fichier existe et a été modifié pour la dernière fois à : " .. info.modified)
949 <highlight language="lua">
950 r:regex(string, pattern, [drapeaux]) -- Exécute une recherche à base
951 d'expression rationnelle sur une chaîne, et renvoie les
952 éventuelles correspondances trouvées.
954 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
956 r:puts("L'expression rationnelle correspond et le dernier mot
957 capturé ($2) est : " .. matches[2])
960 -- Exemple avec insensibilité à la casse :
961 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
963 -- les drapeaux peuvent être une combibaison bit à bit de :
964 -- 0x01: insensibilité à la casse
965 -- 0x02: recherche multiligne
968 <highlight language="lua">
969 r:sleep(secondes) -- Interrompt l'exécution du script pendant le nombre de secondes spécifié.
970 -- La valeur peut être spécifiée sous la forme d'un nombre décimal comme 1.25 pour plus de précision.
973 <highlight language="lua">
974 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
975 base de données et renvoie une classe database. Voir '<a
976 href="#databases">Connectivité aux bases de données</a>' pour plus de
980 <highlight language="lua">
981 r:ivm_set("key", value) -- Défini une variable Inter-VM avec une valeur spécifique.
982 -- Ces valeurs sont conservées même si la VM est
983 -- arrêtée ou non utilisée, et ne doivent donc être
984 -- utilisées que si MaxConnectionsPerChild > 0.
985 -- Les valeurs peuvent être de type number, string
986 -- ou boolean et sont stockées séparément pour
987 -- chaque processus (elles ne seront donc pas d'une
988 -- grande utilité si l'on utilise le mpm prefork).
990 r:ivm_get("key") -- Lit le contenu d'une variable définie via ivm_set. Renvoie
991 -- le contenu de la variable si elle existe, ou nil
992 -- dans le cas contraire.
994 -- Voici un exemple de lecture/écriture qui sauvegarde une variable
995 -- globale en dehors de la VM :
997 -- La première VM qui effectue l'appel suivant n'obtiendra aucune
998 -- valeur, et devra la créer
999 local foo = r:ivm_get("cached_data")
1001 foo = do_some_calcs() -- simulation de valeurs de retour
1002 r:ivm_set("cached_data", foo) -- définition globale de la variable
1004 r:puts("La donnée en cache est : ", foo)
1010 <section id="logging"><title>Fonctions de journalisation</title>
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 à 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 />
1028 <section id="apache2"><title>Paquet apache2</title>
1029 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
1030 contenu suivant :</p>
1033 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1034 s'ils ont traité la requê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ête.</dd>
1038 <dt>apache2.DONE</dt>
1039 <dd>Constante interne DONE.</dd>
1040 <dt>apache2.version</dt>
1041 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
1042 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1043 <dd>Code d'état HTTP</dd>
1044 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1045 <dd>Constantes internes utilisé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ées par <module>mod_authz_core</module></dd>
1050 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
1054 <section id="modifying_buckets">
1055 <title>Modification de contenu avec les filtres lua</title>
1057 Les fonctions de filtrage implémentées via les directives <directive
1058 module="mod_lua">LuaInputFilter</directive> ou <directive
1059 module="mod_lua">LuaOutputFilter</directive> sont conçues comme des
1060 fonctions de 3ème phase non blocantes utilisant des sous-routines
1061 pour suspendre et reprendre l'exécution d'une fonction lorsque des
1062 paquets de données sont envoyés à la chaîne de filtrage. La
1063 structure de base d'une telle fonction est :
1065 <highlight language="lua">
1067 -- Nous indiquons tout d'abord que nous sommes prêts à recevoir des
1068 -- blocs de données.
1069 -- Avant ceci, nous pouvons définir notre environnement, tester
1070 -- certaines conditions, et, si nous le jugeons nécessaire, refuser le
1071 -- filtrage d'une requête :
1072 if something_bad then
1073 return -- Le filtrage est sauté
1075 -- Sans se préoccuper des données que nous devons éventuellement ajouter, un arrêt est réalisé ici.
1076 -- Noter que les filtres de sortie sont les seuls capables d'ajouter des éléments au début des données.
1077 -- Les filtres en entrée peuvent ajouter des éléments à la fin des données au stade final.
1079 coroutine.yield([optional header to be prepended to the content])
1081 -- Après cet arrêt, nous allons recevoir d'autres blocs de données, un par un ;
1082 -- nous pouvons les traiter comme il nous plaît et procéder à la réponse.
1083 -- Ces blocs sont conservés dans la variable globale 'bucket', nous réalisons donc
1084 -- une boucle pour vé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
1090 -- Une fois les blocs de données épuisés, 'bucket' est positionné à une valeur vide ('nil'),
1091 -- ce qui va nous faire sortir de cette boucle et nous amener à l'étape suivante.
1092 -- On peut ajouter ce qu'on veut à la fin des données à cette étape, qui constitue le dernier
1093 -- arrêt. Les filtres d'entrée comme de sortie peuvent servir à ajouter des éléments à la fin
1094 -- des données à cette étape.
1095 coroutine.yield([optional footer to be appended to the content])
1099 <section id="databases">
1100 <title>Connectivité aux bases de données</title>
1101 <p>Mod_lua implémente une fonctionnalité basique de connexion aux
1102 bases de données permettant d'envoyer des requêtes ou d'exécuter des
1103 commandes auprès des moteurs de base de données les plus courants
1104 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1106 <p>L'exemple suivant montre comment se connecter à une base de
1107 données et extraire des informations d'une table :</p>
1108 <highlight language="lua">
1110 -- connexion à la base de données
1111 local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
1113 -- Sélection de certaines informations
1114 local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
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<br/>", row[1], row[2]) )
1121 r:puts("Database query error: " .. err)
1125 r:puts("Connexion à la base de données impossible : " .. err)
1130 Pour utiliser <module>mod_dbd</module>, spécifiez
1131 <code>mod_dbd</code> comme type de base de données, ou laissez le champ
1134 <highlight language="lua">
1135 local database = r:dbacquire("mod_dbd")
1137 <section id="database_object">
1138 <title>L'objet database et ses méthodes</title>
1139 <p>L'objet database renvoyé par <code>dbacquire</code> possède
1140 les méthodes suivantes :</p>
1141 <p><strong>Sélection normale et requête vers une base de données
1143 <highlight language="lua">
1144 -- Exécution d'une requête et renvoie du nombre d'enregistrements
1146 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1148 -- Exécution d'une requête et renvoie du résultat qui peut être utilisé
1149 en mode synchrone ou asynchrone :
1150 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1152 <p><strong>Utilisation de requêtes préparées (recommandé) :</strong></p>
1153 <highlight language="lua">
1154 -- Création et exécution d'une requête préparée :
1155 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1157 local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
1160 -- Extrait une requête préparée depuis une directive DBDPrepareSQL :
1161 local statement, errmsg = database:prepared(r, "someTag")
1163 local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête
1167 <p><strong>Echappement de valeurs, fermeture de la base données,
1169 <highlight language="lua">
1170 -- Echappe une valeur pour pouvoir l'utiliser dans une requête :
1171 local escaped = database:escape(r, [["'|blabla]])
1173 -- Ferme une base de données et libère les liens vers cette dernière :
1176 -- Vérifie si une connexion à une base de données est en service et
1177 opérationnelle :
1178 local connected = database:active()
1181 <section id="result_sets">
1182 <title>Travail avec les jeux d'enregistrements renvoyés par les requêtes</title>
1183 <p>Les jeux d'enregistrements renvoyés par <code>db:select</code> ou par des
1184 requêtes préparées créées par <code>db:prepare</code> permettent de
1185 sélectionner des enregistrements en mode synchrone ou
1186 asynchrone, selon le nombre d'enregistrements spécifié :<br/>
1187 <code>result(0)</code> sélectionne tous les enregistrements en mode
1188 synchrone en renvoyant une table d'enregistrements.<br/>
1189 <code>result(-1)</code> sélectionne le prochain enregistrement disponible en
1190 mode asynchrone.<br/>
1191 <code>result(N)</code> sélectionne l'enregistrement numéro
1192 <code>N</code> en mode asynchrone.
1194 <highlight language="lua">
1195 -- extrait un jeu d'enregistrements via une requête régulière :
1196 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1198 local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone
1199 local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone
1200 local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone
1202 <p>Il est possible de construire une fonction qui renvoie une
1203 fonction itérative permettant de traiter tous les enregistrement en mode
1204 synchrone ou asynchrone selon la valeur de l'argument async :
1206 <highlight language="lua">
1207 function rows(resultset, async)
1209 local function getnext()
1211 local row = resultset(-1)
1212 return row and a or nil, row
1215 return pairs(resultset(0))
1217 return getnext, self
1221 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1223 -- sélectionne des enregistrements en mode asynchrone :
1224 local result, err = statement:select(20)
1226 for index, row in rows(result, true) do
1231 -- sélectionne des enregistrements en mode synchrone :
1232 local result, err = statement:select(20)
1234 for index, row in rows(result, false) do
1241 <section id="closing_databases">
1242 <title>Fermeture d'une connexion à une base de données</title>
1244 <p>Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
1245 données doivent être fermées avec <code>database:close()</code>. Si vous
1246 ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
1247 que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
1248 pas avoir trop de connexions vers la base de données inutilisées. Les
1249 deux mesures suivantes sont pratiquement identiques :
1251 <highlight language="lua">
1252 -- Méthode 1 : fermeture manuelle de la connexion
1253 local database = r:dbacquire("mod_dbd")
1254 database:close() -- c'est tout
1256 -- Méthode 2 : on laisse le collecteur de ré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ésidus
1262 <section id="database_caveat">
1263 <title>Précautions à prendre lorsque l'on travaille avec les bases
1264 de données</title>
1265 <p>Bien que les fonctions <code>query</code> et <code>run</code>
1266 soient toujours disponibles, il est recommandé d'utiliser des requêtes
1267 préparé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 être utilisées que
1271 lorsque la requête ne contient pas de variables (requête statique). Dans
1272 le cas des requêtes dynamiques, utilisez <code>db:prepare</code> ou
1273 <code>db:prepared</code>.
1280 <name>LuaRoot</name>
1281 <description>Spécifie le chemin de base pour la résolution des chemins
1282 relatifs dans les directives de mod_lua</description>
1283 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
1284 <contextlist><context>server config</context><context>virtual host</context>
1285 <context>directory</context><context>.htaccess</context>
1287 <override>All</override>
1290 <p>Cette directive permet de spécifier le chemin de base qui sera
1291 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
1292 l'absence de cette directive, les chemins relatifs sont résolus par
1293 rapport au répertoire de travail courant, ce qui ne sera pas
1294 toujours approprié pour un serveur.</p>
1296 </directivesynopsis>
1299 <name>LuaScope</name>
1300 <description>Une valeur parmi once, request, conn, thread -- la valeur
1301 par dé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>
1307 <override>All</override>
1310 <p>Cette directive permet de spécifier la durée de vie de
1311 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
1312 par défaut est "once".</p>
1315 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
1317 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
1318 qui est basé sur le même fichier dans la requête, et qui se trouve
1319 aussi dans la portée de la requête.</dd>
1321 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
1323 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
1324 de vie du thread qui traite la requête (disponible seulement avec
1325 les MPMs threadés).</dd>
1327 <dt>server:</dt> <dd>Le comportement est ici différent, car la
1328 portée du serveur présente une durée de vie assez longue, et
1329 plusieurs threads vont partager le même server_rec. Pour gérer tout
1330 ceci, les états lua du serveur sont stockés dans une liste de ressources
1331 apr. Les arguments <code>min</code> et <code>max</code> permettent
1332 de spécifier les nombres minimaux et maximaux d'états lua à stocker
1335 <p>En général, les portées <code>thread</code> et <code>server</code>
1336 sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
1337 de régénérer de nouveaux états Lua à chaque requête (comme c'est le
1338 cas avec le MPM event, où même les connexions persistantes utilisent un
1339 nouveau thread pour chaque requête). Si vous pensez que vos scripts
1340 n'auront pas de problème s'il réutilisent un état, alors les portées
1341 <code>thread</code> ou <code>server</code> doivent être utilisées car
1342 elles présenteront de meilleures performances. Alors que la portée
1343 <code>thread</code> fournira les réponses les plus rapides, la portée
1344 <code>server</code> utilisera moins de mémoire car les états sont
1345 rassemblés dans des jeux, permettant par exemple à 1000 threads de
1346 partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
1347 requise par la portée <code>thread</code>.
1350 </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>
1360 <override>All</override>
1362 <p>Cette directive permet de faire correspondre un modèle d'uri avec
1363 une fonction de gestionnaire située dans un fichier spé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èmes de sécurité en écrivant vos expressions
1369 <example><title>Exemples :</title>
1370 <highlight language="config">
1371 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
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ès chargement de ce fichier.</p>
1379 <highlight language="config">
1380 LuaMapHandler /bingo /scripts/wombat.lua
1382 <p>Cette directive invoquera la fonction "handle" qui est la
1383 valeur par défaut si aucun nom de fonction spécifique n'est
1384 spécifié.</p>
1386 </directivesynopsis>
1389 <name>LuaPackagePath</name>
1390 <description>Ajoute un ré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>
1395 <override>All</override>
1396 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
1397 chemins de recherche du module lua. Elle suit les mêmes conventions
1398 que lua. Ceci modifie le package.path dans les vms lua.</p>
1400 <example><title>Exemples :</title>
1401 <highlight language="config">
1402 LuaPackagePath /scripts/lib/?.lua
1403 LuaPackagePath /scripts/lib/?/init.lua
1407 </directivesynopsis>
1410 <name>LuaPackageCPath</name>
1411 <description>Ajoute un ré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>
1416 <override>All</override>
1419 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
1420 de recherche des bibliothèques partagées de lua. Ceci modifie le
1421 package.cpath dans les vms lua.</p>
1424 </directivesynopsis>
1427 <name>LuaCodeCache</name>
1428 <description>Configure le cache de code compilé.</description>
1429 <syntax>LuaCodeCache stat|forever|never</syntax>
1430 <default>LuaCodeCache stat</default>
1432 <context>server config</context><context>virtual host</context>
1433 <context>directory</context><context>.htaccess</context>
1435 <override>All</override>
1438 Cette directive permet de définir le comportement du cache de code
1439 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
1440 du niveau le plus haut (et pas les scripts inclus) est vérifié à
1441 chaque fois que ce fichier est nécessaire, et est rechargé si la
1442 date de modification est plus récente que celle du script déjà
1443 chargé. Les autres valeurs permettent respectivement de garder le
1444 fichier en cache perpétuellement (forever - jamais vérifié ni
1445 remplacé), ou de ne jamais le mettre en cache (never).</p>
1447 <p>En général, les valeurs stat et forever sont utilisées pour un
1448 serveur en production, et les valeurs stat ou never pour un serveur
1449 en développement.</p>
1451 <example><title>Exemples :</title>
1452 <highlight language="config">
1454 LuaCodeCache forever
1460 </directivesynopsis>
1463 <name>LuaHookTranslateName</name>
1464 <description>Fournit un point d'entrée à la phase du nom de
1465 traduction du traitement de la requê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>
1469 <override>All</override>
1470 <compatibility>Le troisième argument optionnel est disponible depuis la
1471 version 2.3.15 du serveur HTTP Apache.</compatibility>
1474 Cette directive permet d'ajouter un point d'entrée (à
1475 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
1476 requête. La fonction hook accepte un seul argument, le request_rec,
1477 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
1478 ou une constante définie dans le module apache2 : apache2.OK,
1479 apache2.DECLINED, ou apache2.DONE.</p>
1481 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
1482 (hook), en gros, chaque hook sera invoqué jusqu'à 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ête doit être interrompu, la valeur renvoyée
1486 doit être apache2.DONE.</p>
1490 <highlight language="config">
1492 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1495 <highlight language="lua">
1496 -- /scripts/conf/hooks.lua --
1498 function silly_mapper(r)
1499 if r.uri == "/" then
1500 r.filename = "/var/www/home.lua"
1503 return apache2.DECLINED
1508 <note><title>Contexte</title><p>Cette directive ne peut être
1509 utilisée ni à l'inté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>
1513 <note><title>Ordonnancement</title><p>Les arguments optionnels
1514 "early" ou "late" permettent de contrôler le moment auquel ce script
1515 s'exécute par rapport aux autres modules.</p></note>
1517 </directivesynopsis>
1520 <name>LuaHookFixups</name>
1521 <description>Fournit un point d'entrée pour la phase de correction du
1522 traitement de la requê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>
1527 <override>All</override>
1530 Idem LuaHookTranslateName, mais s'exécute durant la phase de
1534 </directivesynopsis>
1537 <name>LuaHookMapToStorage</name>
1538 <description>Fournit un point d'entrée pour la phase map_to_storage du
1539 traitement de la requê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>
1544 <override>All</override>
1546 <p>Identique à la directive
1547 <directive>LuaHookTranslateName</directive>, mais s'exécute à la
1548 phase map-to-storage du traitement de la requête. Les modules comme
1549 mod_cache agissent pendant cette phase, ce qui permet de présenter
1550 un exemple intéressant de ce que l'on peut faire ici :</p>
1551 <highlight language="config">
1552 LuaHookMapToStorage /path/to/lua/script.lua check_cache
1554 <highlight language="lua">
1558 function read_file(filename)
1559 local input = io.open(filename, "r")
1561 local data = input:read("*a")
1562 cached_files[filename] = data
1563 file = cached_files[filename]
1566 return cached_files[filename]
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
1573 file = read_file(r.filename) -- Read file into cache
1575 if file then -- If file exists, write it out
1578 r:info(("Sent %s to client from cache"):format(r.filename))
1579 return apache2.DONE -- skip default handler for PNG files
1582 return apache2.DECLINED -- If we had nothing to do, let others serve this.
1587 </directivesynopsis>
1590 <name>LuaHookCheckUserID</name>
1591 <description>Fournit un point d'entrée pour la phase check_user_id du
1592 traitement de la requê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>
1597 <override>All</override>
1598 <compatibility>Le troisième argument optionnel est disponible depuis la
1599 version 2.3.15 du serveur HTTP Apache.</compatibility>
1601 <note><title>Ordonnancement</title><p>Les arguments optionnels
1602 "early" ou "late" permettent de contrôler le moment auquel ce script
1603 s'exécute par rapport aux autres modules.</p></note>
1605 </directivesynopsis>
1608 <name>LuaHookTypeChecker</name>
1609 <description>Fournit un point d'entrée pour la phase type_checker du
1610 traitement de la requê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>
1615 <override>All</override>
1616 <usage><p>...</p></usage>
1617 </directivesynopsis>
1620 <name>LuaHookAuthChecker</name>
1621 <description>Fournit un point d'entrée pour la phase auth_checker du
1622 traitement de la requê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>
1627 <override>All</override>
1628 <compatibility>Le troisième argument optionnel est disponible depuis la
1629 version 2.3.15 du serveur HTTP Apache.</compatibility>
1631 <p>Invoque une fonction lua au cours de la phase auth_checker du
1632 traitement de la requête. Cette directive peut s'utiliser pour
1633 implémenter une vérification arbitraire de l'authentification et de
1634 l'autorisation. Voici un exemple très simple :
1636 <highlight language="lua">
1639 -- fonction d'accroche authcheck fictive
1640 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
1641 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
1642 -- navigateur d'effectuer une authentification basique. Si la requête
1643 -- comporte des données d'authentification, elles ne sont pas vraiment
1644 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
1645 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
1646 -- accepte la requête.
1647 function authcheck_hook(r)
1649 -- recherche des informations d'authentification
1650 auth = r.headers_in['Authorization']
1652 -- définition d'un utilisateur par défaut
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"'
1660 elseif r.user == "foo" then
1661 r:debug('user foo: OK')
1663 r:debug("authcheck: user='" .. r.user .. "'")
1664 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1670 <note><title>Ordonnancement</title><p>Les arguments optionnels
1671 "early" ou "late" permettent de contrôler le moment auquel ce script
1672 s'exécute par rapport aux autres modules.</p></note>
1674 </directivesynopsis>
1677 <name>LuaHookAccessChecker</name>
1678 <description>Fournit un point d'entrée pour la phase access_checker du
1679 traitement de la requê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>
1684 <override>All</override>
1685 <compatibility>Le troisième argument optionnel est disponible depuis la
1686 version 2.3.15 du serveur HTTP Apache.</compatibility>
1689 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1690 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1692 <note><title>Ordonnancement</title><p>Les arguments optionnels
1693 "early" ou "late" permettent de contrôler le moment auquel ce script
1694 s'exécute par rapport aux autres modules.</p></note>
1696 </directivesynopsis>
1698 <name>LuaHookInsertFilter</name>
1699 <description>Fournit un point d'entrée pour la phase insert_filter du
1700 traitement de la requê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>
1705 <override>All</override>
1706 <usage><p>Non encore implémenté</p></usage>
1707 </directivesynopsis>
1710 <name>LuaInherit</name>
1711 <description>Contrôle la manière dont les sections de configuration
1712 parentes sont fusionné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>
1718 <override>All</override>
1719 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1720 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1721 des sections de configuration Directory ou Location qui se
1722 chevauchent, les scripts
1723 définis dans les sections les plus spécifiques s'exécutent
1724 <em>après</em> ceux définis dans les sections plus géné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>
1728 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1729 ignorer les directives LuaHook* situées dans les sections de
1730 configuration parentes.</p></usage>
1731 </directivesynopsis>
1734 <name>LuaQuickHandler</name>
1735 <description>Fournit un point d'entrée pour la gestion rapide du
1736 traitement de la requê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>
1741 <override>All</override>
1743 <p>Cette phase s'exécute juste après l'attribution de la requête à
1744 un serveur virtuel, et permet d'effectuer certains traitements avant
1745 le déroulement des autres phases, ou de servir une requête sans
1746 avoir à la traduire, l'associer à un espace de stockage, etc...
1747 Comme cette phase s'exé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 été
1751 entièrement interprétés.
1753 <note><title>Contexte</title><p>Cette directive ne peut être
1754 utilisée ni à l'inté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>
1758 </directivesynopsis>
1761 <name>LuaAuthzProvider</name>
1762 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
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>
1769 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1770 d'autorisation, elle peut être appelée via la directive <directive
1771 module="mod_authz_core">Require</directive> :</p>
1774 <highlight language="config">
1775 LuaRoot /usr/local/apache2/lua
1776 LuaAuthzProvider foo authz.lua authz_check_foo
1781 <highlight language="lua">
1783 function authz_check_foo(r, who)
1784 if r.user ~= who then return apache2.AUTHZ_DENIED
1785 return apache2.AUTHZ_GRANTED
1790 </directivesynopsis>