2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1495666:1498179 (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"
120 if r.method == 'GET' then
121 r:puts("Hello Lua World!\n")
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 r:puts("Hello Lua World!\n")
127 for k, v in pairs( r:parsebody() ) do
128 r:puts( string.format("%s: %s\n", k, v) )
131 elseif r.method == 'PUT' then
132 -- message d'erreur personnalisé
133 r:puts("Unsupported HTTP method " .. r.method)
137 -- message d'erreur ErrorDocument
145 Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
146 d'un formulaire dans un page au format texte.
150 Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
151 gestionnaires (ou points d'entrée, ou filtres) dans le même script.
155 <section id="writingauthzproviders">
156 <title>Ecriture de fournisseurs d'autorisation</title>
158 <p><module>mod_authz_core</module> fournit une interface d'autorisation
159 de haut niveau bien plus facile à utiliser que dans les hooks
160 correspondants. Le premier argument de la directive <directive
161 module="mod_authz_core">Require</directive> permet de spécifier le
162 fournisseur d'autorisation à utiliser. Pour chaque directive <directive
163 module="mod_authz_core">Require</directive>,
164 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
165 spécifié, le reste de la ligne constituant les paramètres. Le
166 fournisseur considéré va alors vérifier les autorisations et fournir le
167 résultat dans une valeur de retour.</p>
169 <p>En général, le fournisseur authz est appelé avant l'authentification.
170 S'il doit connaître le nom d'utilisateur authentifié (ou si
171 l'utilisateur est appelé à être authentifié), le fournisseur doit
172 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
173 déclancher le processus d'authentification et un deuxième appel du
174 fournisseur authz.</p>
176 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
177 une adresse IP et un nom d'utilisateur. Elle autorise l'accès dans le
178 cas où la requête provient de l'adresse IP spécifiée, ou si
179 l'utilisateur authentifié correspond au second argument :</p>
181 <highlight language="lua">
182 <strong>authz_provider.lua</strong><br/>
186 function authz_check_foo(r, ip, user)
187 if r.useragent_ip == ip then
188 return apache2.AUTHZ_GRANTED
189 elseif r.user == nil then
190 return apache2.AUTHZ_DENIED_NO_USER
191 elseif r.user == user then
192 return apache2.AUTHZ_GRANTED
194 return apache2.AUTHZ_DENIED
199 <p>La configuration suivante enregistre cette fonction en tant que
200 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
201 <highlight language="config">
202 LuaAuthzProvider foo authz_provider.lua authz_check_foo
204 Require foo 10.1.2.3 john_doe
210 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
213 <p>Les fonctions d'accroche déterminent la manière dont les modules (et
214 les scripts Lua) participent au traitement des requêtes. Chaque type
215 d'accroche proposé par le serveur a un rôle spécifique, comme
216 l'association de requêtes au système de fichiers, le contrôle d'accès,
217 ou la définition de types MIME : </p>
219 <table border="1" style="zebra">
221 <th>Phase d'accroche</th>
222 <th>Directive mod_lua</th>
226 <td>Gestionnaire rapide</td>
227 <td><directive module="mod_lua">LuaQuickHandler</directive></td>
228 <td>Il s'agit de la première accroche appelée lorsqu'une requête
229 a été associée à un serveur ou un serveur virtuel.</td>
232 <td>Phase de traduction</td>
233 <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
234 <td>Cette phase traduit l'URI de la requête en nom de fichier
235 sur le système. Ce sont des modules comme
236 <module>mod_alias</module> et <module>mod_rewrite</module> qui
237 interviennent au cours de cette phase.</td>
240 <td>Choix du lieu de stockage de la ressource</td>
241 <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
242 <td>Cette phase définit le lieu de stockage de la ressource :
243 physique, en cache ou externe/mandaté. Elle est assurée par les
244 modules de mandat ou de mise en cache.</td>
247 <td>Autorisation d'accès</td>
248 <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
249 <td>Cette phase vérifie si un client a l'autorisation d'accès à
250 la ressource. Elle s'exécute avant l'authentification de
251 l'utisateur ; il faut donc être prudent.
255 <td>Vérification de l'identifiant utilisateur</td>
256 <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
257 <td>Cette phase vérifie l'identifiant de l'utilisateur ayant
258 fait l'objet d'une négociation.</td>
261 <td>Vérification de l'autorisation d'accès</td>
262 <td><directive module="mod_lua">LuaHookAuthChecker</directive>
264 <directive module="mod_lua">LuaAuthzProvider</directive></td>
265 <td>Cette phase vérifie l'autorisation d'accès d'un utilisateur
266 en fonction des ses paramètres de connexion, comme
267 l'identifiant, le certificat, etc...
271 <td>Vérification du type de la ressource</td>
272 <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
273 <td>Cette phase assigne un type de contenu et un gestionnaire à
277 <td>Derniers réglages</td>
278 <td><directive module="mod_lua">LuaHookFixups</directive></td>
279 <td>C'est la dernière phase avant l'activation des gestionnaires
280 de contenu. Toute modification de dernière minute à la requête
281 doit être effectuée ici.</td>
284 <td>Gestionnaire de contenu</td>
285 <td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
286 <td>C'est durant cette phase que le contenu est traité. Les
287 fichiers sont lus, interprétés, certains sont exécutés, et le
288 résultat obtenu est envoyé au client.</td>
291 <td>Journalisation</td>
293 <td>Lorsqu'une requête a été traitée, plusieurs phases de
294 journalisation interviennent, et enregistrent leurs résultats
295 dans les fichiers d'erreur ou d'accès.</td>
300 <p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
301 argument (sauf LuaAuthzProvider qui reçoit aussi des arguments en
302 provenance de la directive Require). Elles peuvent renvoyer une valeur,
303 selon la fonction, mais il s'agit en général d'un
304 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
305 que vous pouvez écrire dans Lua sous la forme <code>apache2.OK</code>,
306 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
309 <highlight language="lua">
310 <strong>translate_name.lua</strong><br/>
311 -- exemple d'accroche qui réécrit un URI en chemin du système de
316 function translate_name(r)
317 if r.uri == "/translate-name" then
318 r.filename = r.document_root .. "/find_me.txt"
321 -- on ne gère pas cette URL et on donne sa chance à un autre module
322 return apache2.DECLINED
327 <highlight language="lua">
328 <strong>translate_name2.lua</strong><br/>
329 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
330 un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
331 travailler sur la substitution, y compris l'accroche translate_name
332 de base dont les tables de correspondances se basent sur DocumentRoot.
334 Note: utilisez le drapeau early/late de la directive pour
335 l'exécuter avant ou après mod_alias.
340 function translate_name(r)
341 if r.uri == "/translate-name" then
342 r.uri = "/find_me.txt"
343 return apache2.DECLINED
345 return apache2.DECLINED
350 <section id="datastructures"><title>Structures de données</title>
355 <p>request_rec est considérée en tant que donnée utilisateur.
356 Elle possède une métatable qui vous permet d'accomplir des
357 choses intéressantes. Pour la plus grande partie, elle possède
358 les mêmes champs que la structure request_rec, la
359 plupart d'entre eux étant accessibles en lecture et écriture (le
360 contenu des champs de la table peut être modifié, mais les
361 champs eux-mêmes ne peuvent pas être établis en tant que tables
364 <table border="1" style="zebra">
367 <th><strong>Nom</strong></th>
368 <th><strong>Type Lua</strong></th>
369 <th><strong>Modifiable</strong></th>
370 <th><strong>Description</strong></th>
373 <td><code>allowoverrides</code></td>
376 <td>L'option AllowOverride s'applique à la requête courante.</td>
379 <td><code>ap_auth_type</code></td>
382 <td>Ce champ contient le type d'authentification effectuée
383 (par exemple <code>basic</code>)</td>
386 <td><code>args</code></td>
389 <td>La chaîne de paramètres de la requête (par exemple
390 <code>foo=bar&name=johnsmith</code>)</td>
393 <td><code>assbackwards</code></td>
396 <td>contient true s'il s'agit d'une requête de style HTTP/0.9
397 (par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
400 <td><code>auth_name</code></td>
403 <td>La chaîne d'identification utilisée pour la vérification
404 de l'autorisation d'accès (si elle est disponible).</td>
407 <td><code>banner</code></td>
410 <td>La bannière du serveur, par exemple <code>Apache HTTP
411 Server/2.4.3 openssl/0.9.8c</code></td>
414 <td><code>basic_auth_pw</code></td>
417 <td>Le mot de passe pour l'authentification de base envoyé
418 avec la requête, s'il existe</td>
421 <td><code>canonical_filename</code></td>
424 <td>Le nom de fichier canonique de la requête</td>
427 <td><code>content_encoding</code></td>
430 <td>Le type de codage du contenu de la requête courante</td>
433 <td><code>content_type</code></td>
436 <td>Le type de contenu de la requête courante, tel qu'il a été
437 déterminé au cours de la phase type_check (par exemple
438 <code>image/gif</code> ou <code>text/html</code>)</td>
442 <td><code>context_prefix</code></td>
448 <td><code>context_document_root</code></td>
455 <td><code>document_root</code></td>
458 <td>La racine des documents du serveur</td>
461 <td><code>err_headers_out</code></td>
464 <td>L'en-tête MIME de l'environnement pour la réponse, écrit
465 même en cas d'erreur et conservé pendant les redirections
469 <td><code>filename</code></td>
472 <td>Le nom de fichier correspondant à la requête, par exemple
473 /www/example.com/foo.txt. Il peut être modifié au cours des
474 phases translate-name ou map-to-storage du traitement de la
475 requête pour permettre au gestionnaire par défaut (ou aux
476 gestionnaires de script) de servir une version du fichier
477 autre que celle demandée.</td>
480 <td><code>handler</code></td>
483 <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
484 doit traiter la requête, par exemple <code>lua-script</code>
485 si elle doit être traitée par mod_lua. Cette valeur est en
486 général définie via les directives <directive
487 module="mod_mime">AddHandler</directive> ou <directive
488 module="core">SetHandler</directive>, mais peut aussi l'être
489 via mod_lua pour permettre à un autre gestionnaire de traiter
490 une requête spécifique qui ne serait pas traitée par défaut
495 <td><code>headers_in</code></td>
498 <td>Les en-têtes MIME de l'environnement de la requête. Il
499 s'agit des en-têtes comme <code>Host, User-Agent,
500 Referer</code>, etc...</td>
503 <td><code>headers_out</code></td>
506 <td>Les en-têtes MIME de l'environnement de la réponse.</td>
509 <td><code>hostname</code></td>
512 <td>Le nom d'hôte, tel que défini par l'en-tête
513 <code>Host:</code> ou par un URI complet.</td>
516 <td><code>is_https</code></td>
519 <td>Indique si la requête à été faite via HTTPS</td>
522 <td><code>is_initial_req</code></td>
525 <td>Indique si la requête courante est la requête initiale ou
526 une sous-requête.</td>
529 <td><code>limit_req_body</code></td>
532 <td>La taille maximale du corps de la requête, ou 0 si aucune
536 <td><code>log_id</code></td>
539 <td>L'identifiant de la requête dans les journaux d'accès ou
543 <td><code>method</code></td>
546 <td>La méthode de la requête, par exemple <code>GET</code> ou
547 <code>POST</code>.</td>
550 <td><code>notes</code></td>
553 <td>Une liste de notes qui peuvent être transmises d'un module
554 à l'autre.</td>
557 <td><code>options</code></td>
560 <td>La valeur de la directive Options pour la requête
564 <td><code>path_info</code></td>
567 <td>La valeur de PATH_INFO extraite de la requête.</td>
570 <td><code>port</code></td>
573 <td>Le port du serveur utilisé par la requête.</td>
576 <td><code>protocol</code></td>
579 <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></td>
582 <td><code>proxyreq</code></td>
585 <td>Indique s'il s'agit d'une requête mandatée ou non. Cette
586 valeur est en général définie au cours de la phase
587 post_read_request/translate_name du traitement de la requête.</td>
590 <td><code>range</code></td>
593 <td>Le contenu de l'en-tête <code>Range:</code>.</td>
596 <td><code>remaining</code></td>
599 <td>Le nombre d'octets du corps de la requête restant à lire.</td>
602 <td><code>server_built</code></td>
605 <td>La date de compilation du serveur.</td>
608 <td><code>server_name</code></td>
611 <td>Le nom du serveur pour cette requête.</td>
614 <td><code>some_auth_required</code></td>
617 <td>Indique si une autorisation est/était requise pour cette
621 <td><code>subprocess_env</code></td>
624 <td>Le jeu de variables d'environnement pour cette requête.</td>
627 <td><code>started</code></td>
630 <td>Le moment où le serveur a été (re)démarré, en secondes
631 depuis epoch (1er janvier 1970)</td>
634 <td><code>status</code></td>
637 <td>Le code de retour (courant) pour cette requête, par
638 exemple <code>200</code> ou <code>404</code>.</td>
641 <td><code>the_request</code></td>
644 <td>La chaîne de la requête telle qu'elle a été envoyée par le
645 client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
648 <td><code>unparsed_uri</code></td>
651 <td>La partie URI non interprétée de la requête</td>
654 <td><code>uri</code></td>
657 <td>L'URI après interprétation par httpd</td>
660 <td><code>user</code></td>
663 <td>Si une authentification a été effectuée, nom de
664 l'utilisateur authentifié.</td>
667 <td><code>useragent_ip</code></td>
670 <td>L'adresse IP de l'agent qui a envoyé la requête</td>
676 <section id="functions"><title>Méthodes de l'objet request_rec</title>
678 <p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
680 <highlight language="lua">
681 r:flush() -- vide le tampon de sortie
682 -- Renvoie true si le vidage a été effectué avec succès,
683 false dans le cas contraire.
685 while nous_avons_des_données_à_envoyer do
686 r:puts("Bla bla bla\n") -- envoi des données à envoyer vers le tampon
687 r:flush() -- vidage du tampon (envoi au client)
688 r:sleep(0.5) -- mise en attente et bouclage
692 <highlight language="lua">
693 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
695 r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
698 <highlight language="lua">
699 r:sendfile(filename) -- envoie un fichier entier au client en
700 utilisant sendfile s'il est supporté par la plateforme :
702 if use_sendfile_thing then
703 r:sendfile("/var/www/large_file.img")
707 <highlight language="lua">
708 r:parseargs() -- renvoie deux tables : une table standard de couples
709 clé/valeur pour les données GET simples, et une autre pour les données
710 multivaluées (par exemple foo=1&foo=2&foo=3) :
712 local GET, GETMULTI = r:parseargs()
713 r:puts("Votre nom est : " .. GET['name'] or "Unknown")
717 <highlight language="lua">
718 r:parsebody()([sizeLimit]) -- interprète le corps de la requête
719 en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
720 peut être fourni pour spécifier le nombre maximal d'octets à
721 interpréter. La valeur par défaut est 8192.
723 local POST, POSTMULTI = r:parsebody(1024*1024)
724 r:puts("Votre nom est : " .. POST['name'] or "Unknown")
728 <highlight language="lua">
729 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
732 <highlight language="lua">
733 r:write("une simple chaîne") -- affichage dans le
734 corps de la réponse
737 <highlight language="lua">
738 r:escape_html("<html>test</html>") -- Echappe le
739 code HTML et renvoie le résultat
742 <highlight language="lua">
743 r:base64_encode(string) -- Encode une chaîne à l'aide du
744 standard de codage Base64.
746 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
749 <highlight language="lua">
750 r:base64_decode(string) -- Décode une chaîne codée en Base64.
752 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
755 <highlight language="lua">
756 r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne
757 en mode binaire (binary safe).
759 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
762 <highlight language="lua">
763 r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne
764 en mode binaire (binary safe).
766 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
769 <highlight language="lua">
770 r:escape(string) -- Echappe une chaîne de type URL.
772 local url = "http://foo.bar/1 2 3 & 4 + 5"
773 local escaped = r:escape(url) -- renvoie 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
776 <highlight language="lua">
777 r:unescape(string) -- Déséchappe une chaîne de type URL.
779 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
780 local unescaped = r:unescape(url) -- renvoie 'http://foo.bar/1 2 3 & 4 + 5'
783 <highlight language="lua">
784 r:construct_url(string) -- Construit une URL à partir d'un URI
786 local url = r:construct_url(r.uri)
789 <highlight language="lua">
790 r:mpm_query(number) -- Interroge le serveur à propos de son
791 module MPM via la requête ap_mpm_query.
793 local mpm = r.mpm_query(14)
795 r:puts("Ce serveur utilise le MPM Event")
799 <highlight language="lua">
800 r:expr(string) -- Evalue une chaîne de type <a
801 href="../expr.html">expr</a>.
803 if r:expr("%{HTTP_HOST} =~ /^www/") then
804 r:puts("Ce nom d'hôte commence par www")
808 <highlight language="lua">
809 r:scoreboard_process(a) -- Interroge le serveur à propos du
810 processus à la position <code>a</code>.
812 local process = r:scoreboard_process(1)
813 r:puts("Le serveur 1 a comme PID " .. process.pid)
816 <highlight language="lua">
817 r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
818 thread <code>b</code>, dans le processus <code>a</code>.
820 local thread = r:scoreboard_worker(1, 1)
821 r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
822 état est " .. thread.status)
825 <highlight language="lua">
826 r:clock() -- Renvoie l'heure courante avec une précision d'une
830 <highlight language="lua">
831 r:requestbody(filename) -- Lit et renvoie le corps d'une requête. Si
832 'filename' est spécifié, le corps de requête n'est pas renvoyé, mais
833 sauvegardé dans le fichier correspondant.
835 local input = r:requestbody()
836 r:puts("Vous m'avez envoyé le corps de requête suivant :\n")
840 <highlight language="lua">
841 r:add_input_filter(filter_name) -- Ajoute le filtre en entrée
845 <highlight language="lua">
846 r:module_info(module_name) -- Interroge le serveur à propos d'un
849 local mod = r.module_info("mod_lua.c")
851 for k, v in pairs(mod.commands) do
852 r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives implémentées par ce module
857 <highlight language="lua">
858 r:loaded_modules() -- Renvoie une liste des modules chargés par
861 for k, module in pairs(r:loaded_modules()) do
862 r:puts("J'ai chargé le module " .. module .. "\n")
866 <highlight language="lua">
867 r:runtime_dir_relative(filename) -- Génère le nom d'un fichier run-time
868 (par exemple la mémoire partagée "file") relativement au répertoire de
872 <highlight language="lua">
873 r:server_info() -- Renvoie une table contenant des informations
874 à propos du serveur, comme le nom de l'exécutable httpd, le
875 module mpm utilisé, etc...
878 <highlight language="lua">
879 r:set_document_root(file_path) -- Définit la racine des
880 documents pour la requête à file_path.
883 <highlight language="lua">
884 r:add_version_component(component_string) -- Ajoute un élément à
885 la bannière du serveur.
888 <highlight language="lua">
889 r:set_context_info(prefix, docroot) -- Définit le préfixe et la
890 racine des documents du contexte pour une requête.
893 <highlight language="lua">
894 r:os_escape_path(file_path) -- Convertit un chemin du système de
895 fichiers en URL indépendamment du système d'exploitation.
898 <highlight language="lua">
899 r:escape_logitem(string) -- Echappe une chaîne pour
903 <highlight language="lua">
904 r.strcmp_match(string, pattern) -- Vérifie si 'string' correspond à
905 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
906 'www.example.com' correspond à '*.example.com' ?
908 local match = r.strcmp_match("foobar.com", "foo*.com")
910 r:puts("foobar.com matches foo*.com")
914 <highlight language="lua">
915 r:set_keepalive() -- Définit l'état de persistance d'une
916 requête. Renvoie true dans la mesure du possible, false dans le
920 <highlight language="lua">
921 r:make_etag() -- Génère et renvoie le etag pour la requête
925 <highlight language="lua">
926 r:send_interim_response(clear) -- Renvoie une réponse d'intérim (1xx) au
927 client. Si 'clear' est vrai, les en-têtes disponibles seront envoyés et
931 <highlight language="lua">
932 r:custom_response(status_code, string) -- Génère et définit une réponse
933 personnalisée pour un code d'état particulier. Le fonctionnement est
934 très proche de celui de la directive ErrorDocument.
936 r:custom_response(404, "Baleted!")
939 <highlight language="lua">
940 r.exists_config_define(string) -- Vérifie si une définition de
941 configuration existe.
943 if r.exists_config_define("FOO") then
944 r:puts("httpd a probablement été lancé avec l'option -DFOO, ou FOO a
945 été défini dans la configuration")
949 <highlight language="lua">
950 r:state_query(string) -- Interroge le serveur à propos de son
954 <highlight language="lua">
955 r:stat(filename [,wanted]) -- Exécute stat() sur un fichier, et renvoie
956 une table contenant des informations à propos de ce fichier.
958 local info = r:stat("/var/www/foo.txt")
960 r:puts("Ce fichier existe et a été modifié pour la dernière fois à : " .. info.modified)
964 <highlight language="lua">
965 r:regex(string, pattern [,flags]) -- Exécute une recherche à base
966 d'expression rationnelle sur une chaîne, et renvoie les
967 éventuelles correspondances trouvées.
969 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
971 r:puts("L'expression rationnelle correspond et le dernier mot
972 capturé ($2) est : " .. matches[2])
975 -- Exemple avec insensibilité à la casse :
976 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
978 -- les drapeaux peuvent être une combibaison bit à bit de :
979 -- 0x01: insensibilité à la casse
980 -- 0x02: recherche multiligne
983 <highlight language="lua">
984 r:sleep(secondes) -- Interrompt l'exécution du script pendant le nombre de secondes spécifié.
985 -- La valeur peut être spécifiée sous la forme d'un nombre décimal comme 1.25 pour plus de précision.
988 <highlight language="lua">
989 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
990 base de données et renvoie une classe database. Voir '<a
991 href="#databases">Connectivité aux bases de données</a>' pour plus de
995 <highlight language="lua">
996 r:ivm_set("key", value) -- Défini une variable Inter-VM avec une valeur spécifique.
997 -- Ces valeurs sont conservées même si la VM est
998 -- arrêtée ou non utilisée, et ne doivent donc être
999 -- utilisées que si MaxConnectionsPerChild > 0.
1000 -- Les valeurs peuvent être de type number, string
1001 -- ou boolean et sont stockées séparément pour
1002 -- chaque processus (elles ne seront donc pas d'une
1003 -- grande utilité si l'on utilise le mpm prefork).
1005 r:ivm_get("key") -- Lit le contenu d'une variable définie via ivm_set. Renvoie
1006 -- le contenu de la variable si elle existe, ou nil
1007 -- dans le cas contraire.
1009 -- Voici un exemple de lecture/écriture qui sauvegarde une variable
1010 -- globale en dehors de la VM :
1012 -- La première VM qui effectue l'appel suivant n'obtiendra aucune
1013 -- valeur, et devra la créer
1014 local foo = r:ivm_get("cached_data")
1016 foo = do_some_calcs() -- simulation de valeurs de retour
1017 r:ivm_set("cached_data", foo) -- définition globale de la variable
1019 r:puts("La donnée en cache est : ", foo)
1022 <highlight language="lua">
1023 r:htpassword(string [,algorithm [,cost]]) -- Génère un hash de mot de passe à partir d'une chaîne.
1024 -- algorithm: 0 = APMD5 (défaut), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
1025 -- cost: ne s'utilise qu'avec l'algorythme BCRYPT (défaut = 5).
1028 <highlight language="lua">
1029 r:mkdir(dir [,mode]) -- Crée un répertoire et définit son mode via le paramètre optionnel mode.
1032 <highlight language="lua">
1033 r:mkrdir(dir [,mode]) -- Crée des répertoires de manière récursive et définit leur mode via le paramètre optionnel mode.
1036 <highlight language="lua">
1037 r:rmdir(dir) -- Supprime un répertoire.
1040 <highlight language="lua">
1041 r:touch(file [,mtime]) -- Définit la date de modification d'un fichier à la date courante ou à la valeur optionnelle mtime en msec.
1044 <highlight language="lua">
1045 r:get_direntries(dir) -- Renvoie une table contenant toutes les entrées de répertoires.
1047 -- Renvoie un chemin sous forme éclatée en chemin, fichier, extension
1048 function split_path(path)
1049 return path:match("(.-)([^\\/]-%.?([^%.\\/]*))$")
1053 local cwd, _, _ = split_path(r.filename)
1054 for _, f in ipairs(r:get_direntries(cwd)) do
1055 local info = r:stat(cwd .. f)
1057 local mtime = os.date(fmt, info.mtime / 1000000)
1058 local ftype = (info.filetype == 2) and "[dir] " or "[file]"
1059 r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
1065 <highlight language="lua">
1066 r.date_parse_rfc(string) -- Interprète une chaîne date/heure et renvoie l'équivalent en secondes depuis epoche.
1071 <section id="logging"><title>Fonctions de journalisation</title>
1073 <highlight language="lua">
1074 -- exemples de messages de journalisation
1075 r:trace1("Ceci est un message de journalisation de niveau
1076 trace") -- les niveaux valides vont de trace1 à trace8 <br />
1077 r:debug("Ceci est un message de journalisation de niveau debug")<br />
1078 r:info("Ceci est un message de journalisation de niveau info")<br />
1079 r:notice("Ceci est un message de journalisation de niveau notice")<br />
1080 r:warn("Ceci est un message de journalisation de niveau warn")<br />
1081 r:err("Ceci est un message de journalisation de niveau err")<br />
1082 r:alert("Ceci est un message de journalisation de niveau alert")<br />
1083 r:crit("Ceci est un message de journalisation de niveau crit")<br />
1084 r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
1089 <section id="apache2"><title>Paquet apache2</title>
1090 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
1091 contenu suivant :</p>
1094 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1095 s'ils ont traité la requête.</dd>
1096 <dt>apache2.DECLINED</dt>
1097 <dd>Constante interne DECLINED. Les gestionnaires renverront cette
1098 valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
1099 <dt>apache2.DONE</dt>
1100 <dd>Constante interne DONE.</dd>
1101 <dt>apache2.version</dt>
1102 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
1103 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1104 <dd>Code d'état HTTP</dd>
1105 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1106 <dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
1107 <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1108 <dd>constantes internes utilisées par <module>mod_authz_core</module></dd>
1111 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
1115 <section id="modifying_buckets">
1116 <title>Modification de contenu avec les filtres lua</title>
1118 Les fonctions de filtrage implémentées via les directives <directive
1119 module="mod_lua">LuaInputFilter</directive> ou <directive
1120 module="mod_lua">LuaOutputFilter</directive> sont conçues comme des
1121 fonctions de 3ème phase non blocantes utilisant des sous-routines
1122 pour suspendre et reprendre l'exécution d'une fonction lorsque des
1123 paquets de données sont envoyés à la chaîne de filtrage. La
1124 structure de base d'une telle fonction est :
1126 <highlight language="lua">
1128 -- Nous indiquons tout d'abord que nous sommes prêts à recevoir des
1129 -- blocs de données.
1130 -- Avant ceci, nous pouvons définir notre environnement, tester
1131 -- certaines conditions, et, si nous le jugeons nécessaire, refuser le
1132 -- filtrage d'une requête :
1133 if something_bad then
1134 return -- Le filtrage est sauté
1136 -- Sans se préoccuper des données que nous devons éventuellement ajouter, un arrêt est réalisé ici.
1137 -- Noter que les filtres de sortie sont les seuls capables d'ajouter des éléments au début des données.
1138 -- Les filtres en entrée peuvent ajouter des éléments à la fin des données au stade final.
1140 coroutine.yield([optional header to be prepended to the content])
1142 -- Après cet arrêt, nous allons recevoir d'autres blocs de données, un par un ;
1143 -- nous pouvons les traiter comme il nous plaît et procéder à la réponse.
1144 -- Ces blocs sont conservés dans la variable globale 'bucket', nous réalisons donc
1145 -- une boucle pour vérifier que 'bucket' n'est pas vide :
1146 while bucket ~= nil do
1147 local output = mangle(bucket) -- Do some stuff to the content
1148 coroutine.yield(output) -- Return our new content to the filter chain
1151 -- Une fois les blocs de données épuisés, 'bucket' est positionné à une valeur vide ('nil'),
1152 -- ce qui va nous faire sortir de cette boucle et nous amener à l'étape suivante.
1153 -- On peut ajouter ce qu'on veut à la fin des données à cette étape, qui constitue le dernier
1154 -- arrêt. Les filtres d'entrée comme de sortie peuvent servir à ajouter des éléments à la fin
1155 -- des données à cette étape.
1156 coroutine.yield([optional footer to be appended to the content])
1160 <section id="databases">
1161 <title>Connectivité aux bases de données</title>
1162 <p>Mod_lua implémente une fonctionnalité basique de connexion aux
1163 bases de données permettant d'envoyer des requêtes ou d'exécuter des
1164 commandes auprès des moteurs de base de données les plus courants
1165 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1167 <p>L'exemple suivant montre comment se connecter à une base de
1168 données et extraire des informations d'une table :</p>
1169 <highlight language="lua">
1171 -- connexion à la base de données
1172 local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
1174 -- Sélection de certaines informations
1175 local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1177 local rows = results(0) -- extrait tous les enregistrements en mode synchrone
1178 for k, row in pairs(rows) do
1179 r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
1182 r:puts("Database query error: " .. err)
1186 r:puts("Connexion à la base de données impossible : " .. err)
1191 Pour utiliser <module>mod_dbd</module>, spécifiez
1192 <code>mod_dbd</code> comme type de base de données, ou laissez le champ
1195 <highlight language="lua">
1196 local database = r:dbacquire("mod_dbd")
1198 <section id="database_object">
1199 <title>L'objet database et ses méthodes</title>
1200 <p>L'objet database renvoyé par <code>dbacquire</code> possède
1201 les méthodes suivantes :</p>
1202 <p><strong>Sélection normale et requête vers une base de données
1204 <highlight language="lua">
1205 -- Exécution d'une requête et renvoie du nombre d'enregistrements
1207 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1209 -- Exécution d'une requête et renvoie du résultat qui peut être utilisé
1210 en mode synchrone ou asynchrone :
1211 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1213 <p><strong>Utilisation de requêtes préparées (recommandé) :</strong></p>
1214 <highlight language="lua">
1215 -- Création et exécution d'une requête préparée :
1216 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1218 local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
1221 -- Extrait une requête préparée depuis une directive DBDPrepareSQL :
1222 local statement, errmsg = database:prepared(r, "someTag")
1224 local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête
1228 <p><strong>Echappement de valeurs, fermeture de la base données,
1230 <highlight language="lua">
1231 -- Echappe une valeur pour pouvoir l'utiliser dans une requête :
1232 local escaped = database:escape(r, [["'|blabla]])
1234 -- Ferme une base de données et libère les liens vers cette dernière :
1237 -- Vérifie si une connexion à une base de données est en service et
1238 opérationnelle :
1239 local connected = database:active()
1242 <section id="result_sets">
1243 <title>Travail avec les jeux d'enregistrements renvoyés par les requêtes</title>
1244 <p>Les jeux d'enregistrements renvoyés par <code>db:select</code> ou par des
1245 requêtes préparées créées par <code>db:prepare</code> permettent de
1246 sélectionner des enregistrements en mode synchrone ou
1247 asynchrone, selon le nombre d'enregistrements spécifié :<br/>
1248 <code>result(0)</code> sélectionne tous les enregistrements en mode
1249 synchrone en renvoyant une table d'enregistrements.<br/>
1250 <code>result(-1)</code> sélectionne le prochain enregistrement disponible en
1251 mode asynchrone.<br/>
1252 <code>result(N)</code> sélectionne l'enregistrement numéro
1253 <code>N</code> en mode asynchrone.
1255 <highlight language="lua">
1256 -- extrait un jeu d'enregistrements via une requête régulière :
1257 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1259 local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone
1260 local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone
1261 local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone
1263 <p>Il est possible de construire une fonction qui renvoie une
1264 fonction itérative permettant de traiter tous les enregistrement en mode
1265 synchrone ou asynchrone selon la valeur de l'argument async :
1267 <highlight language="lua">
1268 function rows(resultset, async)
1270 local function getnext()
1272 local row = resultset(-1)
1273 return row and a or nil, row
1276 return pairs(resultset(0))
1278 return getnext, self
1282 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1284 -- sélectionne des enregistrements en mode asynchrone :
1285 local result, err = statement:select(20)
1287 for index, row in rows(result, true) do
1292 -- sélectionne des enregistrements en mode synchrone :
1293 local result, err = statement:select(20)
1295 for index, row in rows(result, false) do
1302 <section id="closing_databases">
1303 <title>Fermeture d'une connexion à une base de données</title>
1305 <p>Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
1306 données doivent être fermées avec <code>database:close()</code>. Si vous
1307 ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
1308 que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
1309 pas avoir trop de connexions vers la base de données inutilisées. Les
1310 deux mesures suivantes sont pratiquement identiques :
1312 <highlight language="lua">
1313 -- Méthode 1 : fermeture manuelle de la connexion
1314 local database = r:dbacquire("mod_dbd")
1315 database:close() -- c'est tout
1317 -- Méthode 2 : on laisse le collecteur de résidus la fermer
1318 local database = r:dbacquire("mod_dbd")
1319 database = nil -- on coupe le lien
1320 collectgarbage() -- fermeture de la connexion par le collecteur de résidus
1323 <section id="database_caveat">
1324 <title>Précautions à prendre lorsque l'on travaille avec les bases
1325 de données</title>
1326 <p>Bien que les fonctions <code>query</code> et <code>run</code>
1327 soient toujours disponibles, il est recommandé d'utiliser des requêtes
1328 préparées chaque fois que possible, afin d'une part d'optimiser les
1329 performances (si votre connexion reste longtemps en vie), et d'autre part
1330 minimiser le risque d'attaques par injection SQL. Les fonctions
1331 <code>run</code> et <code>query</code> ne doivent être utilisées que
1332 lorsque la requête ne contient pas de variables (requête statique). Dans
1333 le cas des requêtes dynamiques, utilisez <code>db:prepare</code> ou
1334 <code>db:prepared</code>.
1341 <name>LuaRoot</name>
1342 <description>Spécifie le chemin de base pour la résolution des chemins
1343 relatifs dans les directives de mod_lua</description>
1344 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
1345 <contextlist><context>server config</context><context>virtual host</context>
1346 <context>directory</context><context>.htaccess</context>
1348 <override>All</override>
1351 <p>Cette directive permet de spécifier le chemin de base qui sera
1352 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
1353 l'absence de cette directive, les chemins relatifs sont résolus par
1354 rapport au répertoire de travail courant, ce qui ne sera pas
1355 toujours approprié pour un serveur.</p>
1357 </directivesynopsis>
1360 <name>LuaScope</name>
1361 <description>Une valeur parmi once, request, conn, thread -- la valeur
1362 par défaut est once</description>
1363 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
1364 <default>LuaScope once</default>
1365 <contextlist><context>server config</context><context>virtual host</context>
1366 <context>directory</context><context>.htaccess</context>
1368 <override>All</override>
1371 <p>Cette directive permet de spécifier la durée de vie de
1372 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
1373 par défaut est "once".</p>
1376 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
1378 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
1379 qui est basé sur le même fichier dans la requête, et qui se trouve
1380 aussi dans la portée de la requête.</dd>
1382 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
1384 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
1385 de vie du thread qui traite la requête (disponible seulement avec
1386 les MPMs threadés).</dd>
1388 <dt>server:</dt> <dd>Le comportement est ici différent, car la
1389 portée du serveur présente une durée de vie assez longue, et
1390 plusieurs threads vont partager le même server_rec. Pour gérer tout
1391 ceci, les états lua du serveur sont stockés dans une liste de ressources
1392 apr. Les arguments <code>min</code> et <code>max</code> permettent
1393 de spécifier les nombres minimaux et maximaux d'états lua à stocker
1396 <p>En général, les portées <code>thread</code> et <code>server</code>
1397 sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
1398 de régénérer de nouveaux états Lua à chaque requête (comme c'est le
1399 cas avec le MPM event, où même les connexions persistantes utilisent un
1400 nouveau thread pour chaque requête). Si vous pensez que vos scripts
1401 n'auront pas de problème s'il réutilisent un état, alors les portées
1402 <code>thread</code> ou <code>server</code> doivent être utilisées car
1403 elles présenteront de meilleures performances. Alors que la portée
1404 <code>thread</code> fournira les réponses les plus rapides, la portée
1405 <code>server</code> utilisera moins de mémoire car les états sont
1406 rassemblés dans des jeux, permettant par exemple à 1000 threads de
1407 partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
1408 requise par la portée <code>thread</code>.
1411 </directivesynopsis>
1414 <name>LuaMapHandler</name>
1415 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
1416 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
1417 [nom-fonction]</syntax>
1418 <contextlist><context>server config</context><context>virtual host</context>
1419 <context>directory</context><context>.htaccess</context>
1421 <override>All</override>
1423 <p>Cette directive permet de faire correspondre un modèle d'uri avec
1424 une fonction de gestionnaire située dans un fichier spécifique. Elle
1425 utilise les expressions rationnelles PCRE pour mettre en
1426 correspondance l'uri, et supporte les groupes de correspondance
1427 d'interpolation dans le chemin du fichier et le nom de la fonction.
1428 Prenez garde aux problèmes de sécurité en écrivant vos expressions
1430 <example><title>Exemples :</title>
1431 <highlight language="config">
1432 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1435 <p>Cette directive va faire correspondre des uri comme
1436 /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
1437 fonction de gestionnaire handle_show au niveau de la vm lua
1438 après chargement de ce fichier.</p>
1440 <highlight language="config">
1441 LuaMapHandler /bingo /scripts/wombat.lua
1443 <p>Cette directive invoquera la fonction "handle" qui est la
1444 valeur par défaut si aucun nom de fonction spécifique n'est
1445 spécifié.</p>
1447 </directivesynopsis>
1450 <name>LuaPackagePath</name>
1451 <description>Ajoute un répertoire au package.path de lua</description>
1452 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
1453 <contextlist><context>server config</context><context>virtual host</context>
1454 <context>directory</context><context>.htaccess</context>
1456 <override>All</override>
1457 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
1458 chemins de recherche du module lua. Elle suit les mêmes conventions
1459 que lua. Ceci modifie le package.path dans les vms lua.</p>
1461 <example><title>Exemples :</title>
1462 <highlight language="config">
1463 LuaPackagePath /scripts/lib/?.lua
1464 LuaPackagePath /scripts/lib/?/init.lua
1468 </directivesynopsis>
1471 <name>LuaPackageCPath</name>
1472 <description>Ajoute un répertoire au package.cpath de lua</description>
1473 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
1474 <contextlist><context>server config</context><context>virtual host</context>
1475 <context>directory</context><context>.htaccess</context>
1477 <override>All</override>
1480 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
1481 de recherche des bibliothèques partagées de lua. Ceci modifie le
1482 package.cpath dans les vms lua.</p>
1485 </directivesynopsis>
1488 <name>LuaCodeCache</name>
1489 <description>Configure le cache de code compilé.</description>
1490 <syntax>LuaCodeCache stat|forever|never</syntax>
1491 <default>LuaCodeCache stat</default>
1493 <context>server config</context><context>virtual host</context>
1494 <context>directory</context><context>.htaccess</context>
1496 <override>All</override>
1499 Cette directive permet de définir le comportement du cache de code
1500 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
1501 du niveau le plus haut (et pas les scripts inclus) est vérifié à
1502 chaque fois que ce fichier est nécessaire, et est rechargé si la
1503 date de modification est plus récente que celle du script déjà
1504 chargé. Les autres valeurs permettent respectivement de garder le
1505 fichier en cache perpétuellement (forever - jamais vérifié ni
1506 remplacé), ou de ne jamais le mettre en cache (never).</p>
1508 <p>En général, les valeurs stat et forever sont utilisées pour un
1509 serveur en production, et les valeurs stat ou never pour un serveur
1510 en développement.</p>
1512 <example><title>Exemples :</title>
1513 <highlight language="config">
1515 LuaCodeCache forever
1521 </directivesynopsis>
1524 <name>LuaHookTranslateName</name>
1525 <description>Fournit un point d'entrée à la phase du nom de
1526 traduction du traitement de la requête</description>
1527 <syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>
1528 <contextlist><context>server config</context><context>virtual host</context>
1530 <override>All</override>
1531 <compatibility>Le troisième argument optionnel est disponible depuis la
1532 version 2.3.15 du serveur HTTP Apache.</compatibility>
1535 Cette directive permet d'ajouter un point d'entrée (à
1536 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
1537 requête. La fonction hook accepte un seul argument, le request_rec,
1538 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
1539 ou une constante définie dans le module apache2 : apache2.OK,
1540 apache2.DECLINED, ou apache2.DONE.</p>
1542 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
1543 (hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
1544 d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
1545 traduction, il doit juste renvoyer apache2.DECLINED. Si le
1546 traitement de la requête doit être interrompu, la valeur renvoyée
1547 doit être apache2.DONE.</p>
1551 <highlight language="config">
1553 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1556 <highlight language="lua">
1557 -- /scripts/conf/hooks.lua --
1559 function silly_mapper(r)
1560 if r.uri == "/" then
1561 r.filename = "/var/www/home.lua"
1564 return apache2.DECLINED
1569 <note><title>Contexte</title><p>Cette directive ne peut être
1570 utilisée ni à l'intérieur d'une section <directive type="section"
1571 module="core">Directory</directive> ou <directive type="section"
1572 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1574 <note><title>Ordonnancement</title><p>Les arguments optionnels
1575 "early" ou "late" permettent de contrôler le moment auquel ce script
1576 s'exécute par rapport aux autres modules.</p></note>
1578 </directivesynopsis>
1581 <name>LuaHookFixups</name>
1582 <description>Fournit un point d'entrée pour la phase de correction du
1583 traitement de la requête</description>
1584 <syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>
1585 <contextlist><context>server config</context><context>virtual host</context>
1586 <context>directory</context><context>.htaccess</context>
1588 <override>All</override>
1591 Idem LuaHookTranslateName, mais s'exécute durant la phase de
1595 </directivesynopsis>
1598 <name>LuaHookMapToStorage</name>
1599 <description>Fournit un point d'entrée pour la phase map_to_storage du
1600 traitement de la requête</description>
1601 <syntax>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</syntax>
1602 <contextlist><context>server config</context><context>virtual host</context>
1603 <context>directory</context><context>.htaccess</context>
1605 <override>All</override>
1607 <p>Identique à la directive
1608 <directive>LuaHookTranslateName</directive>, mais s'exécute à la
1609 phase map-to-storage du traitement de la requête. Les modules comme
1610 mod_cache agissent pendant cette phase, ce qui permet de présenter
1611 un exemple intéressant de ce que l'on peut faire ici :</p>
1612 <highlight language="config">
1613 LuaHookMapToStorage /path/to/lua/script.lua check_cache
1615 <highlight language="lua">
1619 function read_file(filename)
1620 local input = io.open(filename, "r")
1622 local data = input:read("*a")
1623 cached_files[filename] = data
1624 file = cached_files[filename]
1627 return cached_files[filename]
1630 function check_cache(r)
1631 if r.filename:match("%.png$") then -- Only match PNG files
1632 local file = cached_files[r.filename] -- Check cache entries
1634 file = read_file(r.filename) -- Read file into cache
1636 if file then -- If file exists, write it out
1639 r:info(("Sent %s to client from cache"):format(r.filename))
1640 return apache2.DONE -- skip default handler for PNG files
1643 return apache2.DECLINED -- If we had nothing to do, let others serve this.
1648 </directivesynopsis>
1651 <name>LuaHookCheckUserID</name>
1652 <description>Fournit un point d'entrée pour la phase check_user_id du
1653 traitement de la requête</description>
1654 <syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1655 <contextlist><context>server config</context><context>virtual host</context>
1656 <context>directory</context><context>.htaccess</context>
1658 <override>All</override>
1659 <compatibility>Le troisième argument optionnel est disponible depuis la
1660 version 2.3.15 du serveur HTTP Apache.</compatibility>
1662 <note><title>Ordonnancement</title><p>Les arguments optionnels
1663 "early" ou "late" permettent de contrôler le moment auquel ce script
1664 s'exécute par rapport aux autres modules.</p></note>
1666 </directivesynopsis>
1669 <name>LuaHookTypeChecker</name>
1670 <description>Fournit un point d'entrée pour la phase type_checker du
1671 traitement de la requête</description>
1672 <syntax>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</syntax>
1673 <contextlist><context>server config</context><context>virtual host</context>
1674 <context>directory</context><context>.htaccess</context>
1676 <override>All</override>
1677 <usage><p>...</p></usage>
1678 </directivesynopsis>
1681 <name>LuaHookAuthChecker</name>
1682 <description>Fournit un point d'entrée pour la phase auth_checker du
1683 traitement de la requête</description>
1684 <syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1685 <contextlist><context>server config</context><context>virtual host</context>
1686 <context>directory</context><context>.htaccess</context>
1688 <override>All</override>
1689 <compatibility>Le troisième argument optionnel est disponible depuis la
1690 version 2.3.15 du serveur HTTP Apache.</compatibility>
1692 <p>Invoque une fonction lua au cours de la phase auth_checker du
1693 traitement de la requête. Cette directive peut s'utiliser pour
1694 implémenter une vérification arbitraire de l'authentification et de
1695 l'autorisation. Voici un exemple très simple :
1697 <highlight language="lua">
1700 -- fonction d'accroche authcheck fictive
1701 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
1702 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
1703 -- navigateur d'effectuer une authentification basique. Si la requête
1704 -- comporte des données d'authentification, elles ne sont pas vraiment
1705 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
1706 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
1707 -- accepte la requête.
1708 function authcheck_hook(r)
1710 -- recherche des informations d'authentification
1711 auth = r.headers_in['Authorization']
1713 -- définition d'un utilisateur par défaut
1717 if r.user == nil then
1718 r:debug("authcheck: user is nil, returning 401")
1719 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1721 elseif r.user == "foo" then
1722 r:debug('user foo: OK')
1724 r:debug("authcheck: user='" .. r.user .. "'")
1725 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1731 <note><title>Ordonnancement</title><p>Les arguments optionnels
1732 "early" ou "late" permettent de contrôler le moment auquel ce script
1733 s'exécute par rapport aux autres modules.</p></note>
1735 </directivesynopsis>
1738 <name>LuaHookAccessChecker</name>
1739 <description>Fournit un point d'entrée pour la phase access_checker du
1740 traitement de la requête</description>
1741 <syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1742 <contextlist><context>server config</context><context>virtual host</context>
1743 <context>directory</context><context>.htaccess</context>
1745 <override>All</override>
1746 <compatibility>Le troisième argument optionnel est disponible depuis la
1747 version 2.3.15 du serveur HTTP Apache.</compatibility>
1750 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1751 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1753 <note><title>Ordonnancement</title><p>Les arguments optionnels
1754 "early" ou "late" permettent de contrôler le moment auquel ce script
1755 s'exécute par rapport aux autres modules.</p></note>
1757 </directivesynopsis>
1759 <name>LuaHookInsertFilter</name>
1760 <description>Fournit un point d'entrée pour la phase insert_filter du
1761 traitement de la requête</description>
1762 <syntax>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</syntax>
1763 <contextlist><context>server config</context><context>virtual host</context>
1764 <context>directory</context><context>.htaccess</context>
1766 <override>All</override>
1767 <usage><p>Non encore implémenté</p></usage>
1768 </directivesynopsis>
1771 <name>LuaInherit</name>
1772 <description>Contrôle la manière dont les sections de configuration
1773 parentes sont fusionnées dans les enfants</description>
1774 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1775 <default>LuaInherit parent-first</default>
1776 <contextlist><context>server config</context><context>virtual host</context>
1777 <context>directory</context><context>.htaccess</context>
1779 <override>All</override>
1780 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1781 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1782 des sections de configuration Directory ou Location qui se
1783 chevauchent, les scripts
1784 définis dans les sections les plus spécifiques s'exécutent
1785 <em>après</em> ceux définis dans les sections plus génériques
1786 (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1787 en sorte que le contexte parent ne s'applique pas du tout.</p>
1789 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1790 ignorer les directives LuaHook* situées dans les sections de
1791 configuration parentes.</p></usage>
1792 </directivesynopsis>
1795 <name>LuaQuickHandler</name>
1796 <description>Fournit un point d'entrée pour la gestion rapide du
1797 traitement de la requête</description>
1798 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1799 <contextlist><context>server config</context><context>virtual host</context>
1800 <context>directory</context><context>.htaccess</context>
1802 <override>All</override>
1804 <p>Cette phase s'exécute juste après l'attribution de la requête à
1805 un serveur virtuel, et permet d'effectuer certains traitements avant
1806 le déroulement des autres phases, ou de servir une requête sans
1807 avoir à la traduire, l'associer à un espace de stockage, etc...
1808 Comme cette phase s'exécute avant toute autre, les directives telles
1809 que <directive type="section" module="core">Location</directive> ou
1810 <directive type="section" module="core">Directory</directive> ne
1811 sont pas encore prises en compte, car Les URI n'ont pas encore été
1812 entièrement interprétés.
1814 <note><title>Contexte</title><p>Cette directive ne peut être
1815 utilisée ni à l'intérieur d'une section <directive type="section"
1816 module="core">Directory</directive> ou <directive type="section"
1817 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1819 </directivesynopsis>
1822 <name>LuaAuthzProvider</name>
1823 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1825 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1826 <contextlist><context>server config</context> </contextlist>
1827 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1830 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1831 d'autorisation, elle peut être appelée via la directive <directive
1832 module="mod_authz_core">Require</directive> :</p>
1835 <highlight language="config">
1836 LuaRoot /usr/local/apache2/lua
1837 LuaAuthzProvider foo authz.lua authz_check_foo
1842 <highlight language="lua">
1844 function authz_check_foo(r, who)
1845 if r.user ~= who then return apache2.AUTHZ_DENIED
1846 return apache2.AUTHZ_GRANTED
1851 </directivesynopsis>