2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1570528:1576894 (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>
292 <td><directive module="mod_lua">LuaHookLog</directive></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. Mod_lua peut
296 s'intercaler au départ de ce processus et ainsi contrôler la
302 <p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
303 argument (sauf LuaAuthzProvider qui reçoit aussi des arguments en
304 provenance de la directive Require). Elles peuvent renvoyer une valeur,
305 selon la fonction, mais il s'agit en général d'un
306 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
307 que vous pouvez écrire dans Lua sous la forme <code>apache2.OK</code>,
308 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
311 <highlight language="lua">
312 <strong>translate_name.lua</strong><br/>
313 -- exemple d'accroche qui réécrit un URI en chemin du système de
318 function translate_name(r)
319 if r.uri == "/translate-name" then
320 r.filename = r.document_root .. "/find_me.txt"
323 -- on ne gère pas cette URL et on donne sa chance à un autre module
324 return apache2.DECLINED
329 <highlight language="lua">
330 <strong>translate_name2.lua</strong><br/>
331 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
332 un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
333 travailler sur la substitution, y compris l'accroche translate_name
334 de base dont les tables de correspondances se basent sur DocumentRoot.
336 Note: utilisez le drapeau early/late de la directive pour
337 l'exécuter avant ou après mod_alias.
342 function translate_name(r)
343 if r.uri == "/translate-name" then
344 r.uri = "/find_me.txt"
345 return apache2.DECLINED
347 return apache2.DECLINED
352 <section id="datastructures"><title>Structures de données</title>
357 <p>request_rec est considérée en tant que donnée utilisateur.
358 Elle possède une métatable qui vous permet d'accomplir des
359 choses intéressantes. Pour la plus grande partie, elle possède
360 les mêmes champs que la structure request_rec, la
361 plupart d'entre eux étant accessibles en lecture et écriture (le
362 contenu des champs de la table peut être modifié, mais les
363 champs eux-mêmes ne peuvent pas être établis en tant que tables
366 <table border="1" style="zebra">
369 <th><strong>Nom</strong></th>
370 <th><strong>Type Lua</strong></th>
371 <th><strong>Modifiable</strong></th>
372 <th><strong>Description</strong></th>
375 <td><code>allowoverrides</code></td>
378 <td>L'option AllowOverride s'applique à la requête courante.</td>
381 <td><code>ap_auth_type</code></td>
384 <td>Ce champ contient le type d'authentification effectuée
385 (par exemple <code>basic</code>)</td>
388 <td><code>args</code></td>
391 <td>La chaîne de paramètres de la requête (par exemple
392 <code>foo=bar&name=johnsmith</code>)</td>
395 <td><code>assbackwards</code></td>
398 <td>contient true s'il s'agit d'une requête de style HTTP/0.9
399 (par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
402 <td><code>auth_name</code></td>
405 <td>La chaîne d'identification utilisée pour la vérification
406 de l'autorisation d'accès (si elle est disponible).</td>
409 <td><code>banner</code></td>
412 <td>La bannière du serveur, par exemple <code>Apache HTTP
413 Server/2.4.3 openssl/0.9.8c</code></td>
416 <td><code>basic_auth_pw</code></td>
419 <td>Le mot de passe pour l'authentification de base envoyé
420 avec la requête, s'il existe</td>
423 <td><code>canonical_filename</code></td>
426 <td>Le nom de fichier canonique de la requête</td>
429 <td><code>content_encoding</code></td>
432 <td>Le type de codage du contenu de la requête courante</td>
435 <td><code>content_type</code></td>
438 <td>Le type de contenu de la requête courante, tel qu'il a été
439 déterminé au cours de la phase type_check (par exemple
440 <code>image/gif</code> ou <code>text/html</code>)</td>
444 <td><code>context_prefix</code></td>
450 <td><code>context_document_root</code></td>
457 <td><code>document_root</code></td>
460 <td>La racine des documents du serveur</td>
463 <td><code>err_headers_out</code></td>
466 <td>L'en-tête MIME de l'environnement pour la réponse, écrit
467 même en cas d'erreur et conservé pendant les redirections
471 <td><code>filename</code></td>
474 <td>Le nom de fichier correspondant à la requête, par exemple
475 /www/example.com/foo.txt. Il peut être modifié au cours des
476 phases translate-name ou map-to-storage du traitement de la
477 requête pour permettre au gestionnaire par défaut (ou aux
478 gestionnaires de script) de servir une version du fichier
479 autre que celle demandée.</td>
482 <td><code>handler</code></td>
485 <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
486 doit traiter la requête, par exemple <code>lua-script</code>
487 si elle doit être traitée par mod_lua. Cette valeur est en
488 général définie via les directives <directive
489 module="mod_mime">AddHandler</directive> ou <directive
490 module="core">SetHandler</directive>, mais peut aussi l'être
491 via mod_lua pour permettre à un autre gestionnaire de traiter
492 une requête spécifique qui ne serait pas traitée par défaut
497 <td><code>headers_in</code></td>
500 <td>Les en-têtes MIME de l'environnement de la requête. Il
501 s'agit des en-têtes comme <code>Host, User-Agent,
502 Referer</code>, etc...</td>
505 <td><code>headers_out</code></td>
508 <td>Les en-têtes MIME de l'environnement de la réponse.</td>
511 <td><code>hostname</code></td>
514 <td>Le nom d'hôte, tel que défini par l'en-tête
515 <code>Host:</code> ou par un URI complet.</td>
518 <td><code>is_https</code></td>
521 <td>Indique si la requête à été faite via HTTPS</td>
524 <td><code>is_initial_req</code></td>
527 <td>Indique si la requête courante est la requête initiale ou
528 une sous-requête.</td>
531 <td><code>limit_req_body</code></td>
534 <td>La taille maximale du corps de la requête, ou 0 si aucune
538 <td><code>log_id</code></td>
541 <td>L'identifiant de la requête dans les journaux d'accès ou
545 <td><code>method</code></td>
548 <td>La méthode de la requête, par exemple <code>GET</code> ou
549 <code>POST</code>.</td>
552 <td><code>notes</code></td>
555 <td>Une liste de notes qui peuvent être transmises d'un module
556 à l'autre.</td>
559 <td><code>options</code></td>
562 <td>La valeur de la directive Options pour la requête
566 <td><code>path_info</code></td>
569 <td>La valeur de PATH_INFO extraite de la requête.</td>
572 <td><code>port</code></td>
575 <td>Le port du serveur utilisé par la requête.</td>
578 <td><code>protocol</code></td>
581 <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></td>
584 <td><code>proxyreq</code></td>
587 <td>Indique s'il s'agit d'une requête mandatée ou non. Cette
588 valeur est en général définie au cours de la phase
589 post_read_request/translate_name du traitement de la requête.</td>
592 <td><code>range</code></td>
595 <td>Le contenu de l'en-tête <code>Range:</code>.</td>
598 <td><code>remaining</code></td>
601 <td>Le nombre d'octets du corps de la requête restant à lire.</td>
604 <td><code>server_built</code></td>
607 <td>La date de compilation du serveur.</td>
610 <td><code>server_name</code></td>
613 <td>Le nom du serveur pour cette requête.</td>
616 <td><code>some_auth_required</code></td>
619 <td>Indique si une autorisation est/était requise pour cette
623 <td><code>subprocess_env</code></td>
626 <td>Le jeu de variables d'environnement pour cette requête.</td>
629 <td><code>started</code></td>
632 <td>Le moment où le serveur a été (re)démarré, en secondes
633 depuis epoch (1er janvier 1970)</td>
636 <td><code>status</code></td>
639 <td>Le code de retour (courant) pour cette requête, par
640 exemple <code>200</code> ou <code>404</code>.</td>
643 <td><code>the_request</code></td>
646 <td>La chaîne de la requête telle qu'elle a été envoyée par le
647 client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
650 <td><code>unparsed_uri</code></td>
653 <td>La partie URI non interprétée de la requête</td>
656 <td><code>uri</code></td>
659 <td>L'URI après interprétation par httpd</td>
662 <td><code>user</code></td>
665 <td>Si une authentification a été effectuée, nom de
666 l'utilisateur authentifié.</td>
669 <td><code>useragent_ip</code></td>
672 <td>L'adresse IP de l'agent qui a envoyé la requête</td>
678 <section id="functions"><title>Méthodes de l'objet request_rec</title>
680 <p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
682 <highlight language="lua">
683 r:flush() -- vide le tampon de sortie
684 -- Renvoie true si le vidage a été effectué avec succès,
685 false dans le cas contraire.
687 while nous_avons_des_données_à_envoyer do
688 r:puts("Bla bla bla\n") -- envoi des données à envoyer vers le tampon
689 r:flush() -- vidage du tampon (envoi au client)
690 r.usleep(500000) -- mise en attente pendant 0.5 secondes et bouclage
694 <highlight language="lua">
695 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
697 r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
700 <highlight language="lua">
701 r:sendfile(filename) -- envoie un fichier entier au client en
702 utilisant sendfile s'il est supporté par la plateforme :
704 if use_sendfile_thing then
705 r:sendfile("/var/www/large_file.img")
709 <highlight language="lua">
710 r:parseargs() -- renvoie deux tables : une table standard de couples
711 clé/valeur pour les données GET simples, et une autre pour les données
712 multivaluées (par exemple foo=1&foo=2&foo=3) :
714 local GET, GETMULTI = r:parseargs()
715 r:puts("Votre nom est : " .. GET['name'] or "Unknown")
719 <highlight language="lua">
720 r:parsebody()([sizeLimit]) -- interprète le corps de la requête
721 en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
722 peut être fourni pour spécifier le nombre maximal d'octets à
723 interpréter. La valeur par défaut est 8192.
725 local POST, POSTMULTI = r:parsebody(1024*1024)
726 r:puts("Votre nom est : " .. POST['name'] or "Unknown")
730 <highlight language="lua">
731 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
734 <highlight language="lua">
735 r:write("une simple chaîne") -- affichage dans le
736 corps de la réponse
739 <highlight language="lua">
740 r:escape_html("<html>test</html>") -- Echappe le
741 code HTML et renvoie le résultat
744 <highlight language="lua">
745 r:base64_encode(string) -- Encode une chaîne à l'aide du
746 standard de codage Base64.
748 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
751 <highlight language="lua">
752 r:base64_decode(string) -- Décode une chaîne codée en Base64.
754 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
757 <highlight language="lua">
758 r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne
759 en mode binaire (binary safe).
761 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
764 <highlight language="lua">
765 r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne
766 en mode binaire (binary safe).
768 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
771 <highlight language="lua">
772 r:escape(string) -- Echappe une chaîne de type URL.
774 local url = "http://foo.bar/1 2 3 & 4 + 5"
775 local escaped = r:escape(url) -- renvoie 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
778 <highlight language="lua">
779 r:unescape(string) -- Déséchappe une chaîne de type URL.
781 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
782 local unescaped = r:unescape(url) -- renvoie 'http://foo.bar/1 2 3 & 4 + 5'
785 <highlight language="lua">
786 r:construct_url(string) -- Construit une URL à partir d'un URI
788 local url = r:construct_url(r.uri)
791 <highlight language="lua">
792 r.mpm_query(number) -- Interroge le serveur à propos de son
793 module MPM via la requête ap_mpm_query.
795 local mpm = r.mpm_query(14)
797 r:puts("Ce serveur utilise le MPM Event")
801 <highlight language="lua">
802 r:expr(string) -- Evalue une chaîne de type <a
803 href="../expr.html">expr</a>.
805 if r:expr("%{HTTP_HOST} =~ /^www/") then
806 r:puts("Ce nom d'hôte commence par www")
810 <highlight language="lua">
811 r:scoreboard_process(a) -- Interroge le serveur à propos du
812 processus à la position <code>a</code>.
814 local process = r:scoreboard_process(1)
815 r:puts("Le serveur 1 a comme PID " .. process.pid)
818 <highlight language="lua">
819 r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
820 thread <code>b</code>, dans le processus <code>a</code>.
822 local thread = r:scoreboard_worker(1, 1)
823 r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
824 état est " .. thread.status)
827 <highlight language="lua">
828 r:clock() -- Renvoie l'heure courante avec une précision d'une
832 <highlight language="lua">
833 r:requestbody(filename) -- Lit et renvoie le corps d'une requête. Si
834 'filename' est spécifié, le corps de requête n'est pas renvoyé, mais
835 sauvegardé dans le fichier correspondant.
837 local input = r:requestbody()
838 r:puts("Vous m'avez envoyé le corps de requête suivant :\n")
842 <highlight language="lua">
843 r:add_input_filter(filter_name) -- Ajoute le filtre en entrée
847 <highlight language="lua">
848 r:module_info(module_name) -- Interroge le serveur à propos d'un
851 local mod = r.module_info("mod_lua.c")
853 for k, v in pairs(mod.commands) do
854 r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives implémentées par ce module
859 <highlight language="lua">
860 r:loaded_modules() -- Renvoie une liste des modules chargés par
863 for k, module in pairs(r:loaded_modules()) do
864 r:puts("J'ai chargé le module " .. module .. "\n")
868 <highlight language="lua">
869 r:runtime_dir_relative(filename) -- Génère le nom d'un fichier run-time
870 (par exemple la mémoire partagée "file") relativement au répertoire de
874 <highlight language="lua">
875 r:server_info() -- Renvoie une table contenant des informations
876 à propos du serveur, comme le nom de l'exécutable httpd, le
877 module mpm utilisé, etc...
880 <highlight language="lua">
881 r:set_document_root(file_path) -- Définit la racine des
882 documents pour la requête à file_path.
885 <highlight language="lua">
886 r:add_version_component(component_string) -- Ajoute un élément à
887 la bannière du serveur.
890 <highlight language="lua">
891 r:set_context_info(prefix, docroot) -- Définit le préfixe et la
892 racine des documents du contexte pour une requête.
895 <highlight language="lua">
896 r:os_escape_path(file_path) -- Convertit un chemin du système de
897 fichiers en URL indépendamment du système d'exploitation.
900 <highlight language="lua">
901 r:escape_logitem(string) -- Echappe une chaîne pour
905 <highlight language="lua">
906 r.strcmp_match(string, pattern) -- Vérifie si 'string' correspond à
907 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
908 'www.example.com' correspond à '*.example.com' ?
910 local match = r.strcmp_match("foobar.com", "foo*.com")
912 r:puts("foobar.com matches foo*.com")
916 <highlight language="lua">
917 r:set_keepalive() -- Définit l'état de persistance d'une
918 requête. Renvoie true dans la mesure du possible, false dans le
922 <highlight language="lua">
923 r:make_etag() -- Génère et renvoie le etag pour la requête
927 <highlight language="lua">
928 r:send_interim_response(clear) -- Renvoie une réponse d'intérim (1xx) au
929 client. Si 'clear' est vrai, les en-têtes disponibles seront envoyés et
933 <highlight language="lua">
934 r:custom_response(status_code, string) -- Génère et définit une réponse
935 personnalisée pour un code d'état particulier. Le fonctionnement est
936 très proche de celui de la directive ErrorDocument.
938 r:custom_response(404, "Baleted!")
941 <highlight language="lua">
942 r.exists_config_define(string) -- Vérifie si une définition de
943 configuration existe.
945 if r.exists_config_define("FOO") then
946 r:puts("httpd a probablement été lancé avec l'option -DFOO, ou FOO a
947 été défini dans la configuration")
951 <highlight language="lua">
952 r:state_query(string) -- Interroge le serveur à propos de son
956 <highlight language="lua">
957 r:stat(filename [,wanted]) -- Exécute stat() sur un fichier, et renvoie
958 une table contenant des informations à propos de ce fichier.
960 local info = r:stat("/var/www/foo.txt")
962 r:puts("Ce fichier existe et a été modifié pour la dernière fois à : " .. info.modified)
966 <highlight language="lua">
967 r:regex(string, pattern [,flags]) -- Exécute une recherche à base
968 d'expression rationnelle sur une chaîne, et renvoie les
969 éventuelles correspondances trouvées.
971 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
973 r:puts("L'expression rationnelle correspond et le dernier mot
974 capturé ($2) est : " .. matches[2])
977 -- Exemple avec insensibilité à la casse :
978 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
980 -- les drapeaux peuvent être une combibaison bit à bit de :
981 -- 0x01: insensibilité à la casse
982 -- 0x02: recherche multiligne
985 <highlight language="lua">
986 r.usleep(microsecondes) -- Interrompt l'exécution du script pendant le nombre de microsecondes spécifié.
989 <highlight language="lua">
990 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
991 base de données et renvoie une classe database. Voir '<a
992 href="#databases">Connectivité aux bases de données</a>' pour plus de
996 <highlight language="lua">
997 r:ivm_set("key", value) -- Défini une variable Inter-VM avec une valeur spécifique.
998 -- Ces valeurs sont conservées même si la VM est
999 -- arrêtée ou non utilisée, et ne doivent donc être
1000 -- utilisées que si MaxConnectionsPerChild > 0.
1001 -- Les valeurs peuvent être de type number, string
1002 -- ou boolean et sont stockées séparément pour
1003 -- chaque processus (elles ne seront donc pas d'une
1004 -- grande utilité si l'on utilise le mpm prefork).
1006 r:ivm_get("key") -- Lit le contenu d'une variable définie via ivm_set. Renvoie
1007 -- le contenu de la variable si elle existe, ou nil
1008 -- dans le cas contraire.
1010 -- Voici un exemple de lecture/écriture qui sauvegarde une variable
1011 -- globale en dehors de la VM :
1013 -- La première VM qui effectue l'appel suivant n'obtiendra aucune
1014 -- valeur, et devra la créer
1015 local foo = r:ivm_get("cached_data")
1017 foo = do_some_calcs() -- simulation de valeurs de retour
1018 r:ivm_set("cached_data", foo) -- définition globale de la variable
1020 r:puts("La donnée en cache est : ", foo)
1023 <highlight language="lua">
1024 r:htpassword(string [,algorithm [,cost]]) -- Génère un hash de mot de passe à partir d'une chaîne.
1025 -- algorithm: 0 = APMD5 (défaut), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
1026 -- cost: ne s'utilise qu'avec l'algorythme BCRYPT (défaut = 5).
1029 <highlight language="lua">
1030 r:mkdir(dir [,mode]) -- Crée un répertoire et définit son mode via le paramètre optionnel mode.
1033 <highlight language="lua">
1034 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.
1037 <highlight language="lua">
1038 r:rmdir(dir) -- Supprime un répertoire.
1041 <highlight language="lua">
1042 r:touch(file [,mtime]) -- Définit la date de modification d'un fichier à la date courante ou à la valeur optionnelle mtime en msec.
1045 <highlight language="lua">
1046 r:get_direntries(dir) -- Renvoie une table contenant toutes les entrées de répertoires.
1048 -- Renvoie un chemin sous forme éclatée en chemin, fichier, extension
1050 local dir = r.context_document_root
1051 for _, f in ipairs(r:get_direntries(dir)) do
1052 local info = r:stat(dir .. "/" .. f)
1054 local mtime = os.date(fmt, info.mtime / 1000000)
1055 local ftype = (info.filetype == 2) and "[dir] " or "[file]"
1056 r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
1062 <highlight language="lua">
1063 r.date_parse_rfc(string) -- Interprète une chaîne date/heure et renvoie l'équivalent en secondes depuis epoche.
1066 <highlight language="lua">
1067 r:getcookie(key) -- Obtient un cookie HTTP
1070 <highlight language="lua">
1071 r:setcookie(key, value, secure, expires) -- Définit un cookie HTTP, par exemple :
1072 r:setcookie("foo", "bar and stuff", false, os.time() + 86400)
1075 <highlight language="lua">
1076 r:wsupgrade() -- Met à jour une connexion vers les WebSockets si possible (et si demandé) :
1077 if r:wsupgrade() then -- si la mise à jour est possible :
1078 r:wswrite("Bienvenue dans les websockets!") -- écrit quelque chose à l'intention du client
1079 r:wsclose() -- Au revoir !
1083 <highlight language="lua">
1084 r:wsread() -- Lit un cadre de websocket depuis une connexion vers websocket mise à jour (voir ci-dessus) :
1086 local line, isFinal = r:wsread() -- isFinal indique s'il s'agit du cadre final.
1087 -- dans le cas contraire, on peut lire les cadres suivants
1088 r:wswrite("Vous avez écrit : " .. line)
1091 <highlight language="lua">
1092 r:wswrite(line) -- écrit un cadre vers un client WebSocket :
1093 r:wswrite("Bonjour le Monde !")
1096 <highlight language="lua">
1097 r:wsclose() -- ferme une requête WebSocket et l'achève pour httpd :
1099 if r:wsupgrade() then
1100 r:wswrite("Ecrire quelque chose : ")
1101 local line = r:wsread() or "nothing"
1102 r:wswrite("Vous avez écrit : " .. line);
1103 r:wswrite("Au revoir !")
1107 <highlight language="lua">
1108 r:wspeek() -- Vérifie s'il y a des données à lire
1110 -- Se met en sommeil tant que rien ne nous est envoyé ...
1111 while r:wspeek() == false do
1114 -- Il y a des données à lire !
1115 local line = r:wsread()
1121 <section id="logging"><title>Fonctions de journalisation</title>
1123 <highlight language="lua">
1124 -- exemples de messages de journalisation
1125 r:trace1("Ceci est un message de journalisation de niveau
1126 trace") -- les niveaux valides vont de trace1 à trace8 <br />
1127 r:debug("Ceci est un message de journalisation de niveau debug")<br />
1128 r:info("Ceci est un message de journalisation de niveau info")<br />
1129 r:notice("Ceci est un message de journalisation de niveau notice")<br />
1130 r:warn("Ceci est un message de journalisation de niveau warn")<br />
1131 r:err("Ceci est un message de journalisation de niveau err")<br />
1132 r:alert("Ceci est un message de journalisation de niveau alert")<br />
1133 r:crit("Ceci est un message de journalisation de niveau crit")<br />
1134 r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
1139 <section id="apache2"><title>Paquet apache2</title>
1140 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
1141 contenu suivant :</p>
1144 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1145 s'ils ont traité la requête.</dd>
1146 <dt>apache2.DECLINED</dt>
1147 <dd>Constante interne DECLINED. Les gestionnaires renverront cette
1148 valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
1149 <dt>apache2.DONE</dt>
1150 <dd>Constante interne DONE.</dd>
1151 <dt>apache2.version</dt>
1152 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
1153 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1154 <dd>Code d'état HTTP</dd>
1155 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1156 <dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
1157 <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1158 <dd>constantes internes utilisées par <module>mod_authz_core</module></dd>
1161 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
1165 <section id="modifying_buckets">
1166 <title>Modification de contenu avec les filtres lua</title>
1168 Les fonctions de filtrage implémentées via les directives <directive
1169 module="mod_lua">LuaInputFilter</directive> ou <directive
1170 module="mod_lua">LuaOutputFilter</directive> sont conçues comme des
1171 fonctions de 3ème phase non blocantes utilisant des sous-routines
1172 pour suspendre et reprendre l'exécution d'une fonction lorsque des
1173 paquets de données sont envoyés à la chaîne de filtrage. La
1174 structure de base d'une telle fonction est :
1176 <highlight language="lua">
1178 -- Nous indiquons tout d'abord que nous sommes prêts à recevoir des
1179 -- blocs de données.
1180 -- Avant ceci, nous pouvons définir notre environnement, tester
1181 -- certaines conditions, et, si nous le jugeons nécessaire, refuser le
1182 -- filtrage d'une requête :
1183 if something_bad then
1184 return -- Le filtrage est sauté
1186 -- Sans se préoccuper des données que nous devons éventuellement ajouter, un arrêt est réalisé ici.
1187 -- Noter que les filtres de sortie sont les seuls capables d'ajouter des éléments au début des données.
1188 -- Les filtres en entrée peuvent ajouter des éléments à la fin des données au stade final.
1190 coroutine.yield([optional header to be prepended to the content])
1192 -- Après cet arrêt, nous allons recevoir d'autres blocs de données, un par un ;
1193 -- nous pouvons les traiter comme il nous plaît et procéder à la réponse.
1194 -- Ces blocs sont conservés dans la variable globale 'bucket', nous réalisons donc
1195 -- une boucle pour vérifier que 'bucket' n'est pas vide :
1196 while bucket ~= nil do
1197 local output = mangle(bucket) -- Do some stuff to the content
1198 coroutine.yield(output) -- Return our new content to the filter chain
1201 -- Une fois les blocs de données épuisés, 'bucket' est positionné à une valeur vide ('nil'),
1202 -- ce qui va nous faire sortir de cette boucle et nous amener à l'étape suivante.
1203 -- On peut ajouter ce qu'on veut à la fin des données à cette étape, qui constitue le dernier
1204 -- arrêt. Les filtres d'entrée comme de sortie peuvent servir à ajouter des éléments à la fin
1205 -- des données à cette étape.
1206 coroutine.yield([optional footer to be appended to the content])
1210 <section id="databases">
1211 <title>Connectivité aux bases de données</title>
1212 <p>Mod_lua implémente une fonctionnalité basique de connexion aux
1213 bases de données permettant d'envoyer des requêtes ou d'exécuter des
1214 commandes auprès des moteurs de base de données les plus courants
1215 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1217 <p>L'exemple suivant montre comment se connecter à une base de
1218 données et extraire des informations d'une table :</p>
1219 <highlight language="lua">
1221 -- connexion à la base de données
1222 local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,dbname=mydb")
1224 -- Sélection de certaines informations
1225 local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1227 local rows = results(0) -- extrait tous les enregistrements en mode synchrone
1228 for k, row in pairs(rows) do
1229 r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
1232 r:puts("Database query error: " .. err)
1236 r:puts("Connexion à la base de données impossible : " .. err)
1241 Pour utiliser <module>mod_dbd</module>, spécifiez
1242 <code>mod_dbd</code> comme type de base de données, ou laissez le champ
1245 <highlight language="lua">
1246 local database = r:dbacquire("mod_dbd")
1248 <section id="database_object">
1249 <title>L'objet database et ses méthodes</title>
1250 <p>L'objet database renvoyé par <code>dbacquire</code> possède
1251 les méthodes suivantes :</p>
1252 <p><strong>Sélection normale et requête vers une base de données
1254 <highlight language="lua">
1255 -- Exécution d'une requête et renvoie du nombre d'enregistrements
1257 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1259 -- Exécution d'une requête et renvoie du résultat qui peut être utilisé
1260 en mode synchrone ou asynchrone :
1261 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1263 <p><strong>Utilisation de requêtes préparées (recommandé) :</strong></p>
1264 <highlight language="lua">
1265 -- Création et exécution d'une requête préparée :
1266 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1268 local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
1271 -- Extrait une requête préparée depuis une directive DBDPrepareSQL :
1272 local statement, errmsg = database:prepared(r, "someTag")
1274 local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête
1278 <p><strong>Echappement de valeurs, fermeture de la base données,
1280 <highlight language="lua">
1281 -- Echappe une valeur pour pouvoir l'utiliser dans une requête :
1282 local escaped = database:escape(r, [["'|blabla]])
1284 -- Ferme une base de données et libère les liens vers cette dernière :
1287 -- Vérifie si une connexion à une base de données est en service et
1288 opérationnelle :
1289 local connected = database:active()
1292 <section id="result_sets">
1293 <title>Travail avec les jeux d'enregistrements renvoyés par les requêtes</title>
1294 <p>Les jeux d'enregistrements renvoyés par <code>db:select</code> ou par des
1295 requêtes préparées créées par <code>db:prepare</code> permettent de
1296 sélectionner des enregistrements en mode synchrone ou
1297 asynchrone, selon le nombre d'enregistrements spécifié :<br/>
1298 <code>result(0)</code> sélectionne tous les enregistrements en mode
1299 synchrone en renvoyant une table d'enregistrements.<br/>
1300 <code>result(-1)</code> sélectionne le prochain enregistrement disponible en
1301 mode asynchrone.<br/>
1302 <code>result(N)</code> sélectionne l'enregistrement numéro
1303 <code>N</code> en mode asynchrone.
1305 <highlight language="lua">
1306 -- extrait un jeu d'enregistrements via une requête régulière :
1307 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1309 local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone
1310 local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone
1311 local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone
1312 local row = result(-1, true) -- Lit l'enregistrement suivant en utilisant les noms d'enregistrements comme index.
1314 <p>Il est possible de construire une fonction qui renvoie une
1315 fonction itérative permettant de traiter tous les enregistrement en mode
1316 synchrone ou asynchrone selon la valeur de l'argument async :
1318 <highlight language="lua">
1319 function rows(resultset, async)
1321 local function getnext()
1323 local row = resultset(-1)
1324 return row and a or nil, row
1327 return pairs(resultset(0))
1329 return getnext, self
1333 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1335 -- sélectionne des enregistrements en mode asynchrone :
1336 local result, err = statement:select(20)
1338 for index, row in rows(result, true) do
1343 -- sélectionne des enregistrements en mode synchrone :
1344 local result, err = statement:select(20)
1346 for index, row in rows(result, false) do
1353 <section id="closing_databases">
1354 <title>Fermeture d'une connexion à une base de données</title>
1356 <p>Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
1357 données doivent être fermées avec <code>database:close()</code>. Si vous
1358 ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
1359 que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
1360 pas avoir trop de connexions vers la base de données inutilisées. Les
1361 deux mesures suivantes sont pratiquement identiques :
1363 <highlight language="lua">
1364 -- Méthode 1 : fermeture manuelle de la connexion
1365 local database = r:dbacquire("mod_dbd")
1366 database:close() -- c'est tout
1368 -- Méthode 2 : on laisse le collecteur de résidus la fermer
1369 local database = r:dbacquire("mod_dbd")
1370 database = nil -- on coupe le lien
1371 collectgarbage() -- fermeture de la connexion par le collecteur de résidus
1374 <section id="database_caveat">
1375 <title>Précautions à prendre lorsque l'on travaille avec les bases
1376 de données</title>
1377 <p>Bien que les fonctions <code>query</code> et <code>run</code>
1378 soient toujours disponibles, il est recommandé d'utiliser des requêtes
1379 préparées chaque fois que possible, afin d'une part d'optimiser les
1380 performances (si votre connexion reste longtemps en vie), et d'autre part
1381 minimiser le risque d'attaques par injection SQL. Les fonctions
1382 <code>run</code> et <code>query</code> ne doivent être utilisées que
1383 lorsque la requête ne contient pas de variables (requête statique). Dans
1384 le cas des requêtes dynamiques, utilisez <code>db:prepare</code> ou
1385 <code>db:prepared</code>.
1392 <name>LuaRoot</name>
1393 <description>Spécifie le chemin de base pour la résolution des chemins
1394 relatifs dans les directives de mod_lua</description>
1395 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
1396 <contextlist><context>server config</context><context>virtual host</context>
1397 <context>directory</context><context>.htaccess</context>
1399 <override>All</override>
1402 <p>Cette directive permet de spécifier le chemin de base qui sera
1403 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
1404 l'absence de cette directive, les chemins relatifs sont résolus par
1405 rapport au répertoire de travail courant, ce qui ne sera pas
1406 toujours approprié pour un serveur.</p>
1408 </directivesynopsis>
1411 <name>LuaScope</name>
1412 <description>Une valeur parmi once, request, conn, thread -- la valeur
1413 par défaut est once</description>
1414 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
1415 <default>LuaScope once</default>
1416 <contextlist><context>server config</context><context>virtual host</context>
1417 <context>directory</context><context>.htaccess</context>
1419 <override>All</override>
1422 <p>Cette directive permet de spécifier la durée de vie de
1423 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
1424 par défaut est "once".</p>
1427 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
1429 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
1430 qui est basé sur le même fichier dans la requête, et qui se trouve
1431 aussi dans la portée de la requête.</dd>
1433 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
1435 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
1436 de vie du thread qui traite la requête (disponible seulement avec
1437 les MPMs threadés).</dd>
1439 <dt>server:</dt> <dd>Le comportement est ici différent, car la
1440 portée du serveur présente une durée de vie assez longue, et
1441 plusieurs threads vont partager le même server_rec. Pour gérer tout
1442 ceci, les états lua du serveur sont stockés dans une liste de ressources
1443 apr. Les arguments <code>min</code> et <code>max</code> permettent
1444 de spécifier les nombres minimaux et maximaux d'états lua à stocker
1447 <p>En général, les portées <code>thread</code> et <code>server</code>
1448 sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
1449 de régénérer de nouveaux états Lua à chaque requête (comme c'est le
1450 cas avec le MPM event, où même les connexions persistantes utilisent un
1451 nouveau thread pour chaque requête). Si vous pensez que vos scripts
1452 n'auront pas de problème s'il réutilisent un état, alors les portées
1453 <code>thread</code> ou <code>server</code> doivent être utilisées car
1454 elles présenteront de meilleures performances. Alors que la portée
1455 <code>thread</code> fournira les réponses les plus rapides, la portée
1456 <code>server</code> utilisera moins de mémoire car les états sont
1457 rassemblés dans des jeux, permettant par exemple à 1000 threads de
1458 partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
1459 requise par la portée <code>thread</code>.
1462 </directivesynopsis>
1465 <name>LuaMapHandler</name>
1466 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
1467 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
1468 [nom-fonction]</syntax>
1469 <contextlist><context>server config</context><context>virtual host</context>
1470 <context>directory</context><context>.htaccess</context>
1472 <override>All</override>
1474 <p>Cette directive permet de faire correspondre un modèle d'uri avec
1475 une fonction de gestionnaire située dans un fichier spécifique. Elle
1476 utilise les expressions rationnelles PCRE pour mettre en
1477 correspondance l'uri, et supporte les groupes de correspondance
1478 d'interpolation dans le chemin du fichier et le nom de la fonction.
1479 Prenez garde aux problèmes de sécurité en écrivant vos expressions
1481 <example><title>Exemples :</title>
1482 <highlight language="config">
1483 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1486 <p>Cette directive va faire correspondre des uri comme
1487 /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
1488 fonction de gestionnaire handle_show au niveau de la vm lua
1489 après chargement de ce fichier.</p>
1491 <highlight language="config">
1492 LuaMapHandler /bingo /scripts/wombat.lua
1494 <p>Cette directive invoquera la fonction "handle" qui est la
1495 valeur par défaut si aucun nom de fonction spécifique n'est
1496 spécifié.</p>
1498 </directivesynopsis>
1501 <name>LuaPackagePath</name>
1502 <description>Ajoute un répertoire au package.path de lua</description>
1503 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
1504 <contextlist><context>server config</context><context>virtual host</context>
1505 <context>directory</context><context>.htaccess</context>
1507 <override>All</override>
1508 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
1509 chemins de recherche du module lua. Elle suit les mêmes conventions
1510 que lua. Ceci modifie le package.path dans les vms lua.</p>
1512 <example><title>Exemples :</title>
1513 <highlight language="config">
1514 LuaPackagePath /scripts/lib/?.lua
1515 LuaPackagePath /scripts/lib/?/init.lua
1519 </directivesynopsis>
1522 <name>LuaPackageCPath</name>
1523 <description>Ajoute un répertoire au package.cpath de lua</description>
1524 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
1525 <contextlist><context>server config</context><context>virtual host</context>
1526 <context>directory</context><context>.htaccess</context>
1528 <override>All</override>
1531 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
1532 de recherche des bibliothèques partagées de lua. Ceci modifie le
1533 package.cpath dans les vms lua.</p>
1536 </directivesynopsis>
1539 <name>LuaCodeCache</name>
1540 <description>Configure le cache de code compilé.</description>
1541 <syntax>LuaCodeCache stat|forever|never</syntax>
1542 <default>LuaCodeCache stat</default>
1544 <context>server config</context><context>virtual host</context>
1545 <context>directory</context><context>.htaccess</context>
1547 <override>All</override>
1550 Cette directive permet de définir le comportement du cache de code
1551 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
1552 du niveau le plus haut (et pas les scripts inclus) est vérifié à
1553 chaque fois que ce fichier est nécessaire, et est rechargé si la
1554 date de modification est plus récente que celle du script déjà
1555 chargé. Les autres valeurs permettent respectivement de garder le
1556 fichier en cache perpétuellement (forever - jamais vérifié ni
1557 remplacé), ou de ne jamais le mettre en cache (never).</p>
1559 <p>En général, les valeurs stat et forever sont utilisées pour un
1560 serveur en production, et les valeurs stat ou never pour un serveur
1561 en développement.</p>
1563 <example><title>Exemples :</title>
1564 <highlight language="config">
1566 LuaCodeCache forever
1572 </directivesynopsis>
1575 <name>LuaHookTranslateName</name>
1576 <description>Fournit un point d'entrée à la phase du nom de
1577 traduction du traitement de la requête</description>
1578 <syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>
1579 <contextlist><context>server config</context><context>virtual host</context>
1581 <override>All</override>
1582 <compatibility>Le troisième argument optionnel est disponible depuis la
1583 version 2.3.15 du serveur HTTP Apache.</compatibility>
1586 Cette directive permet d'ajouter un point d'entrée (à
1587 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
1588 requête. La fonction hook accepte un seul argument, le request_rec,
1589 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
1590 ou une constante définie dans le module apache2 : apache2.OK,
1591 apache2.DECLINED, ou apache2.DONE.</p>
1593 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
1594 (hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
1595 d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
1596 traduction, il doit juste renvoyer apache2.DECLINED. Si le
1597 traitement de la requête doit être interrompu, la valeur renvoyée
1598 doit être apache2.DONE.</p>
1602 <highlight language="config">
1604 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1607 <highlight language="lua">
1608 -- /scripts/conf/hooks.lua --
1610 function silly_mapper(r)
1611 if r.uri == "/" then
1612 r.filename = "/var/www/home.lua"
1615 return apache2.DECLINED
1620 <note><title>Contexte</title><p>Cette directive ne peut être
1621 utilisée ni à l'intérieur d'une section <directive type="section"
1622 module="core">Directory</directive> ou <directive type="section"
1623 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1625 <note><title>Ordonnancement</title><p>Les arguments optionnels
1626 "early" ou "late" permettent de contrôler le moment auquel ce script
1627 s'exécute par rapport aux autres modules.</p></note>
1629 </directivesynopsis>
1632 <name>LuaHookFixups</name>
1633 <description>Fournit un point d'entrée pour la phase de correction du
1634 traitement de la requête</description>
1635 <syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>
1636 <contextlist><context>server config</context><context>virtual host</context>
1637 <context>directory</context><context>.htaccess</context>
1639 <override>All</override>
1642 Idem LuaHookTranslateName, mais s'exécute durant la phase de
1646 </directivesynopsis>
1649 <name>LuaHookLog</name>
1650 <description>Permet une insertion dans la phase de journalisation du
1651 traitement d'une requête</description>
1652 <syntax>LuaHookLog /path/to/lua/script.lua log_function_name</syntax>
1653 <contextlist><context>server config</context><context>virtual host</context>
1654 <context>directory</context><context>.htaccess</context>
1656 <override>All</override>
1659 Ce dispositif d'insertion simple permet d'exécuter une fonction
1660 lorsque httpd entre dans la phase de journalisation du traitement
1661 d'une requête. Vous pouvez ainsi ajouter des données à vos propres
1662 entrées de journalisation, manipuler les entrées du journal standard
1663 avant leur enregistrement ou empêcher l'enregistrement d'une entrée
1664 dans le journal. Pour empêcher l'enregistrement normal des entrées
1665 du journal, renvoyez simplement <code>apache2.DONE</code> dans votre
1666 gestionnaire de journalisation, ou au contraire, renvoyez
1667 <code>apache2.OK</code> pour que httpd effectue une journalisation
1671 <highlight language="config">
1672 LuaHookLog /path/to/script.lua logger
1674 <highlight language="lua">
1675 -- /path/to/script.lua --
1677 -- on joue à pile ou face :
1678 -- Si on obtient 1, on écrit dans notre propre journal Lua et on dit
1679 -- à httpd de ne pas enregistrer d'entrée dans le journal standard..
1680 -- Si on obtient 2, on nettoie un peu les données avant que httpd ne
1681 -- les enregistre dans le journal standard.
1683 if math.random(1,2) == 1 then
1684 -- On effectue notre propre journalisation et le journal
1685 -- standard n'est pas alimenté
1686 local f = io.open("/foo/secret.log", "a")
1688 f:write("Quelque chose de secret est arrivé à " .. r.uri .. "\n")
1691 return apache2.DONE -- On dit à httpd de ne rien enregistrer
1692 --dans le journal standard
1694 r.uri = r.uri:gsub("somesecretstuff", "") -- nettoie les données
1695 return apache2.OK -- et httpd doit alors les enregistrer.
1700 </directivesynopsis>
1704 <name>LuaHookMapToStorage</name>
1705 <description>Fournit un point d'entrée pour la phase map_to_storage du
1706 traitement de la requête</description>
1707 <syntax>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</syntax>
1708 <contextlist><context>server config</context><context>virtual host</context>
1709 <context>directory</context><context>.htaccess</context>
1711 <override>All</override>
1713 <p>Identique à la directive
1714 <directive>LuaHookTranslateName</directive>, mais s'exécute à la
1715 phase map-to-storage du traitement de la requête. Les modules comme
1716 mod_cache agissent pendant cette phase, ce qui permet de présenter
1717 un exemple intéressant de ce que l'on peut faire ici :</p>
1718 <highlight language="config">
1719 LuaHookMapToStorage /path/to/lua/script.lua check_cache
1721 <highlight language="lua">
1725 function read_file(filename)
1726 local input = io.open(filename, "r")
1728 local data = input:read("*a")
1729 cached_files[filename] = data
1730 file = cached_files[filename]
1733 return cached_files[filename]
1736 function check_cache(r)
1737 if r.filename:match("%.png$") then -- Only match PNG files
1738 local file = cached_files[r.filename] -- Check cache entries
1740 file = read_file(r.filename) -- Read file into cache
1742 if file then -- If file exists, write it out
1745 r:info(("Sent %s to client from cache"):format(r.filename))
1746 return apache2.DONE -- skip default handler for PNG files
1749 return apache2.DECLINED -- If we had nothing to do, let others serve this.
1754 </directivesynopsis>
1757 <name>LuaHookCheckUserID</name>
1758 <description>Fournit un point d'entrée pour la phase check_user_id du
1759 traitement de la requête</description>
1760 <syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1761 <contextlist><context>server config</context><context>virtual host</context>
1762 <context>directory</context><context>.htaccess</context>
1764 <override>All</override>
1765 <compatibility>Le troisième argument optionnel est disponible depuis la
1766 version 2.3.15 du serveur HTTP Apache.</compatibility>
1768 <note><title>Ordonnancement</title><p>Les arguments optionnels
1769 "early" ou "late" permettent de contrôler le moment auquel ce script
1770 s'exécute par rapport aux autres modules.</p></note>
1772 </directivesynopsis>
1775 <name>LuaHookTypeChecker</name>
1776 <description>Fournit un point d'entrée pour la phase type_checker du
1777 traitement de la requête</description>
1778 <syntax>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</syntax>
1779 <contextlist><context>server config</context><context>virtual host</context>
1780 <context>directory</context><context>.htaccess</context>
1782 <override>All</override>
1783 <usage><p>...</p></usage>
1784 </directivesynopsis>
1787 <name>LuaHookAuthChecker</name>
1788 <description>Fournit un point d'entrée pour la phase auth_checker du
1789 traitement de la requête</description>
1790 <syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1791 <contextlist><context>server config</context><context>virtual host</context>
1792 <context>directory</context><context>.htaccess</context>
1794 <override>All</override>
1795 <compatibility>Le troisième argument optionnel est disponible depuis la
1796 version 2.3.15 du serveur HTTP Apache.</compatibility>
1798 <p>Invoque une fonction lua au cours de la phase auth_checker du
1799 traitement de la requête. Cette directive peut s'utiliser pour
1800 implémenter une vérification arbitraire de l'authentification et de
1801 l'autorisation. Voici un exemple très simple :
1803 <highlight language="lua">
1806 -- fonction d'accroche authcheck fictive
1807 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
1808 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
1809 -- navigateur d'effectuer une authentification basique. Si la requête
1810 -- comporte des données d'authentification, elles ne sont pas vraiment
1811 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
1812 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
1813 -- accepte la requête.
1814 function authcheck_hook(r)
1816 -- recherche des informations d'authentification
1817 auth = r.headers_in['Authorization']
1819 -- définition d'un utilisateur par défaut
1823 if r.user == nil then
1824 r:debug("authcheck: user is nil, returning 401")
1825 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1827 elseif r.user == "foo" then
1828 r:debug('user foo: OK')
1830 r:debug("authcheck: user='" .. r.user .. "'")
1831 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1837 <note><title>Ordonnancement</title><p>Les arguments optionnels
1838 "early" ou "late" permettent de contrôler le moment auquel ce script
1839 s'exécute par rapport aux autres modules.</p></note>
1841 </directivesynopsis>
1844 <name>LuaHookAccessChecker</name>
1845 <description>Fournit un point d'entrée pour la phase access_checker du
1846 traitement de la requête</description>
1847 <syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1848 <contextlist><context>server config</context><context>virtual host</context>
1849 <context>directory</context><context>.htaccess</context>
1851 <override>All</override>
1852 <compatibility>Le troisième argument optionnel est disponible depuis la
1853 version 2.3.15 du serveur HTTP Apache.</compatibility>
1856 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1857 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1859 <note><title>Ordonnancement</title><p>Les arguments optionnels
1860 "early" ou "late" permettent de contrôler le moment auquel ce script
1861 s'exécute par rapport aux autres modules.</p></note>
1863 </directivesynopsis>
1865 <name>LuaHookInsertFilter</name>
1866 <description>Fournit un point d'entrée pour la phase insert_filter du
1867 traitement de la requête</description>
1868 <syntax>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</syntax>
1869 <contextlist><context>server config</context><context>virtual host</context>
1870 <context>directory</context><context>.htaccess</context>
1872 <override>All</override>
1873 <usage><p>Non encore implémenté</p></usage>
1874 </directivesynopsis>
1877 <name>LuaInherit</name>
1878 <description>Contrôle la manière dont les sections de configuration
1879 parentes sont fusionnées dans les enfants</description>
1880 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1881 <default>LuaInherit parent-first</default>
1882 <contextlist><context>server config</context><context>virtual host</context>
1883 <context>directory</context><context>.htaccess</context>
1885 <override>All</override>
1886 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1887 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1888 des sections de configuration Directory ou Location qui se
1889 chevauchent, les scripts
1890 définis dans les sections les plus spécifiques s'exécutent
1891 <em>après</em> ceux définis dans les sections plus génériques
1892 (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1893 en sorte que le contexte parent ne s'applique pas du tout.</p>
1895 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1896 ignorer les directives LuaHook* situées dans les sections de
1897 configuration parentes.</p></usage>
1898 </directivesynopsis>
1901 <name>LuaQuickHandler</name>
1902 <description>Fournit un point d'entrée pour la gestion rapide du
1903 traitement de la requête</description>
1904 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1905 <contextlist><context>server config</context><context>virtual host</context>
1906 <context>directory</context><context>.htaccess</context>
1908 <override>All</override>
1910 <p>Cette phase s'exécute juste après l'attribution de la requête à
1911 un serveur virtuel, et permet d'effectuer certains traitements avant
1912 le déroulement des autres phases, ou de servir une requête sans
1913 avoir à la traduire, l'associer à un espace de stockage, etc...
1914 Comme cette phase s'exécute avant toute autre, les directives telles
1915 que <directive type="section" module="core">Location</directive> ou
1916 <directive type="section" module="core">Directory</directive> ne
1917 sont pas encore prises en compte, car Les URI n'ont pas encore été
1918 entièrement interprétés.
1920 <note><title>Contexte</title><p>Cette directive ne peut être
1921 utilisée ni à l'intérieur d'une section <directive type="section"
1922 module="core">Directory</directive> ou <directive type="section"
1923 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1925 </directivesynopsis>
1928 <name>LuaAuthzProvider</name>
1929 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1931 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1932 <contextlist><context>server config</context> </contextlist>
1933 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1936 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1937 d'autorisation, elle peut être appelée via la directive <directive
1938 module="mod_authz_core">Require</directive> :</p>
1941 <highlight language="config">
1942 LuaRoot /usr/local/apache2/lua
1943 LuaAuthzProvider foo authz.lua authz_check_foo
1948 <highlight language="lua">
1950 function authz_check_foo(r, who)
1951 if r.user ~= who then return apache2.AUTHZ_DENIED
1952 return apache2.AUTHZ_GRANTED
1957 </directivesynopsis>
1960 <name>LuaInputFilter</name>
1961 <description>Fournit une fonction Lua pour le filtrage en entrée</description>
1962 <syntax>LuaInputFilter filter_name /path/to/lua/script.lua function_name</syntax>
1963 <contextlist><context>server config</context> </contextlist>
1964 <compatibility>Disponible depuis la version 2.5.0 du serveur HTTP
1965 Apache</compatibility>
1968 <p>Cette directive permet d'ajouter un filtre en entrée sous la forme
1969 d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
1970 entrée fonctionnent comme des sous-routines, intervenant dans un premier
1971 temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
1972 paquet de données doit être transmis à la chaîne, et éventuellement
1973 produisant toute donnée à ajouter aux données en entrée. La variable
1974 globale <code>bucket</code> contient les paquets de données tels qu'ils
1975 sont transmis au script Lua :
1978 <highlight language="config">
1979 LuaInputFilter myInputFilter /www/filter.lua input_filter
1980 <FilesMatch "\.lua>
1981 SetInputFilter myInputFilter
1984 <highlight language="lua">
1986 Exemple de filtre en entrée qui convertit toutes les données POST en
1989 function input_filter(r)
1990 print("luaInputFilter called") -- debug print
1991 coroutine.yield() -- Yield and wait for buckets
1992 while bucket do -- For each bucket, do...
1993 local output = string.upper(bucket) -- Convertit toutes les données POST en majuscules
1994 coroutine.yield(output) -- Envoie les données traitées à la chaîne
1996 -- plus aucune donnée à traiter.
1997 coroutine.yield("&filterSignature=1234") -- Ajoute une signature à la fin
2001 Le filtre en entrée peut interdire ou sauter un filtre s'il est
2002 considéré comme indésirable :
2004 <highlight language="lua">
2005 function input_filter(r)
2007 return -- Empêche tout simplement le filtrage et transmet le contenu original
2009 coroutine.yield() -- attend des paquets de données
2010 ... -- insert les filtres ici
2014 Voir "<a href="#modifying_buckets">Modification de contenu avec les
2015 filtres Lua</a>" pour plus de détails.
2018 </directivesynopsis>
2021 <name>LuaOutputFilter</name>
2022 <description>Fournit une fonction Lua pour le filtrage de contenu en
2023 sortie</description>
2024 <syntax>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</syntax>
2025 <contextlist><context>server config</context> </contextlist>
2026 <compatibility>Disponible à partir de la version 2.5.0 du serveur HTTP
2027 Apache</compatibility>
2030 <p>>Cette directive permet d'ajouter un filtre en sortie sous la forme
2031 d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
2032 entrée fonctionnent comme des sous-routines, intervenant dans un premier
2033 temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
2034 paquet de données doit être transmis à la chaîne, et éventuellement
2035 produisant toute donnée à ajouter aux données en sortie. La variable
2036 globale <code>bucket</code> contient les paquets de données tels qu'ils
2037 sont transmis au script Lua :
2040 <highlight language="config">
2041 LuaOutputFilter myOutputFilter /www/filter.lua output_filter
2042 <FilesMatch "\.lua>
2043 SetOutputFilter myOutputFilter
2046 <highlight language="lua">
2048 Exemple de filtre en sortie qui échappe toutes les entités HTML en
2051 function output_filter(r)
2052 coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Ajoute des données au début de la sortie, puis attend des paquets de données à traiter
2053 while bucket do -- Pour chaque paquet, faire ...
2054 local output = r:escape_html(bucket) -- Echappe les données en sortie
2055 coroutine.yield(output) -- Envoie les données traitées à la chaîne
2057 -- plus aucune donnée à traiter.
2061 Comme les filres en entrée, le filtre en sortie peut interdire ou sauter un filtre s'il est
2062 considéré comme indésirable :
2064 <highlight language="lua">
2065 function output_filter(r)
2066 if not r.content_type:match("text/html") then
2067 return -- Empêche tout simplement le filtrage et transmet le contenu original
2069 coroutine.yield() -- attend des paquets de données
2070 ... -- insert les filtres ici
2073 <note><title>Les filtres Lua avec <module>mod_filter</module></title>
2074 <p>Lorsqu'on utilise un filtre Lua comme fournisseur sous-jacent via la
2075 directive <directive module="mod_filter">FilterProvider</directive>, le
2076 filtrage ne fonctionnera que si <var>filter-name</var> est identique à
2077 <var>provider-name</var>.
2081 Voir "<a href="#modifying_buckets">Modification de contenu avec les
2082 filtres Lua</a>" pour plus de détails.
2086 </directivesynopsis>
projects / apache / blob