2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1598962:1604336 (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 <directive module="core">SetHandler</directive> ou <directive
78 module="mod_mime">AddHandler</directive> :</p>
80 <highlight language="config">
87 Ceci aura pour effet de faire traiter les requêtes pour les fichiers
88 dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
89 invoquant cette fonction de <code>gestion</code> de fichier.
92 <p>Pour plus de détails, voir la directive
93 <directive>LuaMapHandler</directive>.
97 <section id="writinghandlers"><title>Ecrire des gestionnaires</title>
98 <p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
99 point d'accroche (hook) spécifique responsable de la génération de la
100 réponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
101 <module>mod_status</module> sont des exemples de modules comportant un
104 <p><code>mod_lua</code> cherche toujours à invoquer une fonction Lua pour le
105 gestionnaire, plutôt que de simplement évaluer le corps d'un script dans
106 le style de CGI. Une fonction de gestionnaire se présente comme suit :</p>
109 <highlight language="lua">
110 <strong>example.lua</strong><br/>
111 -- exemple de gestionnaire
116 Il s'agit du nom de méthode par défaut pour les gestionnaires Lua ;
117 voir les noms de fonctions optionnels dans la directive
118 LuaMapHandler pour choisir un point d'entrée différent.
121 r.content_type = "text/plain"
123 if r.method == 'GET' then
124 r:puts("Hello Lua World!\n")
125 for k, v in pairs( r:parseargs() ) do
126 r:puts( string.format("%s: %s\n", k, v) )
128 elseif r.method == 'POST' then
129 r:puts("Hello Lua World!\n")
130 for k, v in pairs( r:parsebody() ) do
131 r:puts( string.format("%s: %s\n", k, v) )
134 elseif r.method == 'PUT' then
135 -- message d'erreur personnalisé
136 r:puts("Unsupported HTTP method " .. r.method)
140 -- message d'erreur ErrorDocument
148 Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
149 d'un formulaire dans un page au format texte.
153 Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
154 gestionnaires (ou points d'entrée, ou filtres) dans le même script.
158 <section id="writingauthzproviders">
159 <title>Ecriture de fournisseurs d'autorisation</title>
161 <p><module>mod_authz_core</module> fournit une interface d'autorisation
162 de haut niveau bien plus facile à utiliser que dans les hooks
163 correspondants. Le premier argument de la directive <directive
164 module="mod_authz_core">Require</directive> permet de spécifier le
165 fournisseur d'autorisation à utiliser. Pour chaque directive <directive
166 module="mod_authz_core">Require</directive>,
167 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
168 spécifié, le reste de la ligne constituant les paramètres. Le
169 fournisseur considéré va alors vérifier les autorisations et fournir le
170 résultat dans une valeur de retour.</p>
172 <p>En général, le fournisseur authz est appelé avant l'authentification.
173 S'il doit connaître le nom d'utilisateur authentifié (ou si
174 l'utilisateur est appelé à être authentifié), le fournisseur doit
175 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
176 déclancher le processus d'authentification et un deuxième appel du
177 fournisseur authz.</p>
179 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
180 une adresse IP et un nom d'utilisateur. Elle autorise l'accès dans le
181 cas où la requête provient de l'adresse IP spécifiée, ou si
182 l'utilisateur authentifié correspond au second argument :</p>
184 <highlight language="lua">
185 <strong>authz_provider.lua</strong><br/>
189 function authz_check_foo(r, ip, user)
190 if r.useragent_ip == ip then
191 return apache2.AUTHZ_GRANTED
192 elseif r.user == nil then
193 return apache2.AUTHZ_DENIED_NO_USER
194 elseif r.user == user then
195 return apache2.AUTHZ_GRANTED
197 return apache2.AUTHZ_DENIED
202 <p>La configuration suivante enregistre cette fonction en tant que
203 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
204 <highlight language="config">
205 LuaAuthzProvider foo authz_provider.lua authz_check_foo
207 Require foo 10.1.2.3 john_doe
213 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
216 <p>Les fonctions d'accroche déterminent la manière dont les modules (et
217 les scripts Lua) participent au traitement des requêtes. Chaque type
218 d'accroche proposé par le serveur a un rôle spécifique, comme
219 l'association de requêtes au système de fichiers, le contrôle d'accès,
220 ou la définition de types MIME : </p>
222 <table border="1" style="zebra">
224 <th>Phase d'accroche</th>
225 <th>Directive mod_lua</th>
229 <td>Gestionnaire rapide</td>
230 <td><directive module="mod_lua">LuaQuickHandler</directive></td>
231 <td>Il s'agit de la première accroche appelée lorsqu'une requête
232 a été associée à un serveur ou un serveur virtuel.</td>
235 <td>Phase de traduction</td>
236 <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
237 <td>Cette phase traduit l'URI de la requête en nom de fichier
238 sur le système. Ce sont des modules comme
239 <module>mod_alias</module> et <module>mod_rewrite</module> qui
240 interviennent au cours de cette phase.</td>
243 <td>Choix du lieu de stockage de la ressource</td>
244 <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
245 <td>Cette phase définit le lieu de stockage de la ressource :
246 physique, en cache ou externe/mandaté. Elle est assurée par les
247 modules de mandat ou de mise en cache.</td>
250 <td>Autorisation d'accès</td>
251 <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
252 <td>Cette phase vérifie si un client a l'autorisation d'accès à
253 la ressource. Elle s'exécute avant l'authentification de
254 l'utisateur ; il faut donc être prudent.
258 <td>Vérification de l'identifiant utilisateur</td>
259 <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
260 <td>Cette phase vérifie l'identifiant de l'utilisateur ayant
261 fait l'objet d'une négociation.</td>
264 <td>Vérification de l'autorisation d'accès</td>
265 <td><directive module="mod_lua">LuaHookAuthChecker</directive>
267 <directive module="mod_lua">LuaAuthzProvider</directive></td>
268 <td>Cette phase vérifie l'autorisation d'accès d'un utilisateur
269 en fonction des ses paramètres de connexion, comme
270 l'identifiant, le certificat, etc...
274 <td>Vérification du type de la ressource</td>
275 <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
276 <td>Cette phase assigne un type de contenu et un gestionnaire à
280 <td>Derniers réglages</td>
281 <td><directive module="mod_lua">LuaHookFixups</directive></td>
282 <td>C'est la dernière phase avant l'activation des gestionnaires
283 de contenu. Toute modification de dernière minute à la requête
284 doit être effectuée ici.</td>
287 <td>Gestionnaire de contenu</td>
288 <td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
289 <td>C'est durant cette phase que le contenu est traité. Les
290 fichiers sont lus, interprétés, certains sont exécutés, et le
291 résultat obtenu est envoyé au client.</td>
294 <td>Journalisation</td>
295 <td><directive module="mod_lua">LuaHookLog</directive></td>
296 <td>Lorsqu'une requête a été traitée, plusieurs phases de
297 journalisation interviennent, et enregistrent leurs résultats
298 dans les fichiers d'erreur ou d'accès. Mod_lua peut
299 s'intercaler au départ de ce processus et ainsi contrôler la
305 <p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
306 argument (sauf LuaAuthzProvider qui reçoit aussi des arguments en
307 provenance de la directive Require). Elles peuvent renvoyer une valeur,
308 selon la fonction, mais il s'agit en général d'un
309 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
310 que vous pouvez écrire dans Lua sous la forme <code>apache2.OK</code>,
311 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
314 <highlight language="lua">
315 <strong>translate_name.lua</strong><br/>
316 -- exemple d'accroche qui réécrit un URI en chemin du système de fichiers.
320 function translate_name(r)
321 if r.uri == "/translate-name" then
322 r.filename = r.document_root .. "/find_me.txt"
325 -- on ne gère pas cette URL et on donne sa chance à un autre module
326 return apache2.DECLINED
331 <highlight language="lua">
332 <strong>translate_name2.lua</strong><br/>
333 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
334 un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
335 travailler sur la substitution, y compris l'accroche translate_name
336 de base dont les tables de correspondances se basent sur DocumentRoot.
338 Note: utilisez le drapeau early/late de la directive pour
339 l'exécuter avant ou après mod_alias.
344 function translate_name(r)
345 if r.uri == "/translate-name" then
346 r.uri = "/find_me.txt"
347 return apache2.DECLINED
349 return apache2.DECLINED
354 <section id="datastructures"><title>Structures de données</title>
359 <p>request_rec est considérée en tant que donnée utilisateur.
360 Elle possède une métatable qui vous permet d'accomplir des
361 choses intéressantes. Pour la plus grande partie, elle possède
362 les mêmes champs que la structure request_rec, la
363 plupart d'entre eux étant accessibles en lecture et écriture (le
364 contenu des champs de la table peut être modifié, mais les
365 champs eux-mêmes ne peuvent pas être établis en tant que tables
368 <table border="1" style="zebra">
371 <th><strong>Nom</strong></th>
372 <th><strong>Type Lua</strong></th>
373 <th><strong>Modifiable</strong></th>
374 <th><strong>Description</strong></th>
377 <td><code>allowoverrides</code></td>
380 <td>L'option AllowOverride s'applique à la requête courante.</td>
383 <td><code>ap_auth_type</code></td>
386 <td>Ce champ contient le type d'authentification effectuée
387 (par exemple <code>basic</code>)</td>
390 <td><code>args</code></td>
393 <td>La chaîne de paramètres de la requête (par exemple
394 <code>foo=bar&name=johnsmith</code>)</td>
397 <td><code>assbackwards</code></td>
400 <td>contient true s'il s'agit d'une requête de style HTTP/0.9
401 (par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
404 <td><code>auth_name</code></td>
407 <td>La chaîne d'identification utilisée pour la vérification
408 de l'autorisation d'accès (si elle est disponible).</td>
411 <td><code>banner</code></td>
414 <td>La bannière du serveur, par exemple <code>Apache HTTP
415 Server/2.4.3 openssl/0.9.8c</code></td>
418 <td><code>basic_auth_pw</code></td>
421 <td>Le mot de passe pour l'authentification de base envoyé
422 avec la requête, s'il existe</td>
425 <td><code>canonical_filename</code></td>
428 <td>Le nom de fichier canonique de la requête</td>
431 <td><code>content_encoding</code></td>
434 <td>Le type de codage du contenu de la requête courante</td>
437 <td><code>content_type</code></td>
440 <td>Le type de contenu de la requête courante, tel qu'il a été
441 déterminé au cours de la phase type_check (par exemple
442 <code>image/gif</code> ou <code>text/html</code>)</td>
446 <td><code>context_prefix</code></td>
452 <td><code>context_document_root</code></td>
459 <td><code>document_root</code></td>
462 <td>La racine des documents du serveur</td>
465 <td><code>err_headers_out</code></td>
468 <td>L'en-tête MIME de l'environnement pour la réponse, écrit
469 même en cas d'erreur et conservé pendant les redirections
473 <td><code>filename</code></td>
476 <td>Le nom de fichier correspondant à la requête, par exemple
477 /www/example.com/foo.txt. Il peut être modifié au cours des
478 phases translate-name ou map-to-storage du traitement de la
479 requête pour permettre au gestionnaire par défaut (ou aux
480 gestionnaires de script) de servir une version du fichier
481 autre que celle demandée.</td>
484 <td><code>handler</code></td>
487 <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
488 doit traiter la requête, par exemple <code>lua-script</code>
489 si elle doit être traitée par mod_lua. Cette valeur est en
490 général définie via les directives <directive
491 module="mod_mime">AddHandler</directive> ou <directive
492 module="core">SetHandler</directive>, mais peut aussi l'être
493 via mod_lua pour permettre à un autre gestionnaire de traiter
494 une requête spécifique qui ne serait pas traitée par défaut
499 <td><code>headers_in</code></td>
502 <td>Les en-têtes MIME de l'environnement de la requête. Il
503 s'agit des en-têtes comme <code>Host, User-Agent,
504 Referer</code>, etc...</td>
507 <td><code>headers_out</code></td>
510 <td>Les en-têtes MIME de l'environnement de la réponse.</td>
513 <td><code>hostname</code></td>
516 <td>Le nom d'hôte, tel que défini par l'en-tête
517 <code>Host:</code> ou par un URI complet.</td>
520 <td><code>is_https</code></td>
523 <td>Indique si la requête à été faite via HTTPS</td>
526 <td><code>is_initial_req</code></td>
529 <td>Indique si la requête courante est la requête initiale ou
530 une sous-requête.</td>
533 <td><code>limit_req_body</code></td>
536 <td>La taille maximale du corps de la requête, ou 0 si aucune
540 <td><code>log_id</code></td>
543 <td>L'identifiant de la requête dans les journaux d'accès ou
547 <td><code>method</code></td>
550 <td>La méthode de la requête, par exemple <code>GET</code> ou
551 <code>POST</code>.</td>
554 <td><code>notes</code></td>
557 <td>Une liste de notes qui peuvent être transmises d'un module
558 à l'autre.</td>
561 <td><code>options</code></td>
564 <td>La valeur de la directive Options pour la requête
568 <td><code>path_info</code></td>
571 <td>La valeur de PATH_INFO extraite de la requête.</td>
574 <td><code>port</code></td>
577 <td>Le port du serveur utilisé par la requête.</td>
580 <td><code>protocol</code></td>
583 <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></td>
586 <td><code>proxyreq</code></td>
589 <td>Indique s'il s'agit d'une requête mandatée ou non. Cette
590 valeur est en général définie au cours de la phase
591 post_read_request/translate_name du traitement de la requête.</td>
594 <td><code>range</code></td>
597 <td>Le contenu de l'en-tête <code>Range:</code>.</td>
600 <td><code>remaining</code></td>
603 <td>Le nombre d'octets du corps de la requête restant à lire.</td>
606 <td><code>server_built</code></td>
609 <td>La date de compilation du serveur.</td>
612 <td><code>server_name</code></td>
615 <td>Le nom du serveur pour cette requête.</td>
618 <td><code>some_auth_required</code></td>
621 <td>Indique si une autorisation est/était requise pour cette
625 <td><code>subprocess_env</code></td>
628 <td>Le jeu de variables d'environnement pour cette requête.</td>
631 <td><code>started</code></td>
634 <td>Le moment où le serveur a été (re)démarré, en secondes
635 depuis epoch (1er janvier 1970)</td>
638 <td><code>status</code></td>
641 <td>Le code de retour (courant) pour cette requête, par
642 exemple <code>200</code> ou <code>404</code>.</td>
645 <td><code>the_request</code></td>
648 <td>La chaîne de la requête telle qu'elle a été envoyée par le
649 client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
652 <td><code>unparsed_uri</code></td>
655 <td>La partie URI non interprétée de la requête</td>
658 <td><code>uri</code></td>
661 <td>L'URI après interprétation par httpd</td>
664 <td><code>user</code></td>
667 <td>Si une authentification a été effectuée, nom de
668 l'utilisateur authentifié.</td>
671 <td><code>useragent_ip</code></td>
674 <td>L'adresse IP de l'agent qui a envoyé la requête</td>
680 <section id="functions"><title>Méthodes de l'objet request_rec</title>
682 <p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
684 <highlight language="lua">
685 r:flush() -- vide le tampon de sortie
686 -- Renvoie true si le vidage a été effectué avec succès,
687 -- false dans le cas contraire.
689 while nous_avons_des_données_à_envoyer do
690 r:puts("Bla bla bla\n") -- envoi des données à envoyer vers le tampon
691 r:flush() -- vidage du tampon (envoi au client)
692 r.usleep(500000) -- mise en attente pendant 0.5 secondes et bouclage
696 <highlight language="lua">
697 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
699 r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
702 <highlight language="lua">
703 r:sendfile(filename) -- envoie un fichier entier au client en utilisant sendfile s'il est
704 -- supporté par la plateforme :
706 if use_sendfile_thing then
707 r:sendfile("/var/www/large_file.img")
711 <highlight language="lua">
712 r:parseargs() -- renvoie deux tables : une table standard de couples
713 -- clé/valeur pour les données GET simples,
714 -- et une autre pour les données
715 -- multivaluées (par exemple foo=1&foo=2&foo=3) :
717 local GET, GETMULTI = r:parseargs()
718 r:puts("Votre nom est : " .. GET['name'] or "Unknown")
722 <highlight language="lua">
723 r:parsebody()([sizeLimit]) -- interprète le corps de la
724 -- requête en tant que POST et renvoie
725 -- deux tables lua, comme r:parseargs(). Un
726 -- nombre optionnel peut être fourni
727 -- pour spécifier le nombre maximal
728 -- d'octets à interpréter. La
729 -- valeur par défaut est 8192.
731 local POST, POSTMULTI = r:parsebody(1024*1024)
732 r:puts("Votre nom est : " .. POST['name'] or "Unknown")
736 <highlight language="lua">
737 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
740 <highlight language="lua">
741 r:write("une simple chaîne") -- affichage dans le corps de la réponse
744 <highlight language="lua">
745 r:escape_html("<html>test</html>") -- Echappe le code HTML et renvoie le résultat
748 <highlight language="lua">
749 r:base64_encode(string) -- Encode une chaîne à l'aide du standard de codage Base64.
751 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
754 <highlight language="lua">
755 r:base64_decode(string) -- Décode une chaîne codée en Base64.
757 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
760 <highlight language="lua">
761 r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne en mode binaire (binary safe).
763 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
766 <highlight language="lua">
767 r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne en mode binaire (binary safe).
769 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
772 <highlight language="lua">
773 r:escape(string) -- Echappe une chaîne de type URL.
775 local url = "http://foo.bar/1 2 3 & 4 + 5"
776 local escaped = r:escape(url) -- renvoie 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
779 <highlight language="lua">
780 r:unescape(string) -- Déséchappe une chaîne de type URL.
782 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
783 local unescaped = r:unescape(url) -- renvoie 'http://foo.bar/1 2 3 & 4 + 5'
786 <highlight language="lua">
787 r:construct_url(string) -- Construit une URL à partir d'un URI
789 local url = r:construct_url(r.uri)
792 <highlight language="lua">
793 r.mpm_query(number) -- Interroge le serveur à propos de son 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 href="../expr.html">expr</a>.
804 if r:expr("%{HTTP_HOST} =~ /^www/") then
805 r:puts("Ce nom d'hôte commence par www")
809 <highlight language="lua">
810 r:scoreboard_process(a) -- Interroge le serveur à propos du
811 -- processus à la position <code>a</code>.
813 local process = r:scoreboard_process(1)
814 r:puts("Le serveur 1 a comme PID " .. process.pid)
817 <highlight language="lua">
818 r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
819 -- thread <code>b</code>, dans le processus <code>a</code>.
821 local thread = r:scoreboard_worker(1, 1)
822 r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
823 état est " .. thread.status)
826 <highlight language="lua">
827 r:clock() -- Renvoie l'heure courante avec une précision d'une microseconde.
830 <highlight language="lua">
831 r:requestbody(filename) -- Lit et renvoie le corps d'une requête.
832 -- Si 'filename' est spécifié, le
833 -- corps de requête n'est pas
834 -- renvoyé, mais sauvegardé dans
835 -- 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 'filter_name'.
846 <highlight language="lua">
847 r:module_info(module_name) -- Interroge le serveur à propos d'un module.
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
853 -- implémentées par ce module.
858 <highlight language="lua">
859 r:loaded_modules() -- Renvoie une liste des modules chargés par httpd.
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
869 -- "file") relativement au répertoire de run-time.
872 <highlight language="lua">
873 r:server_info() -- Renvoie une table contenant des informations à
874 -- propos du serveur, comme le nom de
875 -- l'exécutable httpd, le module mpm utilisé, etc...
878 <highlight language="lua">
879 r:set_document_root(file_path) -- Définit la racine des documents
880 -- 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 journalisation.
902 <highlight language="lua">
903 r.strcmp_match(string, pattern) -- Vérifie si 'string' correspond à
904 -- 'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
905 -- 'www.example.com' correspond à '*.example.com' ?
907 local match = r.strcmp_match("foobar.com", "foo*.com")
909 r:puts("foobar.com matches foo*.com")
913 <highlight language="lua">
914 r:set_keepalive() -- Définit l'état de persistance d'une requête.
915 -- Renvoie true dans la mesure du possible, false dans le cas contraire.
918 <highlight language="lua">
919 r:make_etag() -- Génère et renvoie le etag pour la requête courante.
922 <highlight language="lua">
923 r:send_interim_response(clear) -- Renvoie une réponse d'intérim (1xx) au
924 -- client. Si 'clear' est vrai, les en-têtes disponibles
925 -- seront envoyés et effacés.
928 <highlight language="lua">
929 r:custom_response(status_code, string) -- Génère et définit une réponse
930 -- personnalisée pour un code d'état particulier.
931 -- Le fonctionnement est très proche de celui de la directive ErrorDocument.
933 r:custom_response(404, "Baleted!")
936 <highlight language="lua">
937 r.exists_config_define(string) -- Vérifie si une définition de configuration existe.
939 if r.exists_config_define("FOO") then
940 r:puts("httpd a probablement été lancé avec l'option -DFOO, ou FOO a
941 été défini dans la configuration")
945 <highlight language="lua">
946 r:state_query(string) -- Interroge le serveur à propos de son état.
949 <highlight language="lua">
950 r:stat(filename [,wanted]) -- Exécute stat() sur un fichier, et renvoie une table contenant
951 -- des informations à propos de ce fichier.
953 local info = r:stat("/var/www/foo.txt")
955 r:puts("Ce fichier existe et a été modifié pour la dernière fois à : " .. info.modified)
959 <highlight language="lua">
960 r:regex(string, pattern [,flags]) -- Exécute une recherche à base d'expression rationnelle
961 -- sur une chaîne, et renvoie les éventuelles correspondances trouvées.
963 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
965 r:puts("L'expression rationnelle correspond et le dernier mot
966 capturé ($2) est : " .. matches[2])
969 -- Exemple avec insensibilité à la casse :
970 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
972 -- les drapeaux peuvent être une combibaison bit à bit de :
973 -- 0x01: insensibilité à la casse
974 -- 0x02: recherche multiligne
977 <highlight language="lua">
978 r.usleep(microsecondes) -- Interrompt l'exécution du script pendant le nombre de microsecondes spécifié.
981 <highlight language="lua">
982 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une base de données et renvoie une classe database.
983 -- Voir '<a href="#databases">Connectivité aux bases de données</a>'
984 -- pour plus de détails.
987 <highlight language="lua">
988 r:ivm_set("key", value) -- Défini une variable Inter-VM avec une valeur spécifique.
989 -- Ces valeurs sont conservées même si la VM est
990 -- arrêtée ou non utilisée, et ne doivent donc être
991 -- utilisées que si MaxConnectionsPerChild > 0.
992 -- Les valeurs peuvent être de type number, string
993 -- ou boolean et sont stockées séparément pour
994 -- chaque processus (elles ne seront donc pas d'une
995 -- grande utilité si l'on utilise le mpm prefork).
997 r:ivm_get("key") -- Lit le contenu d'une variable définie via ivm_set. Renvoie
998 -- le contenu de la variable si elle existe, ou nil
999 -- dans le cas contraire.
1001 -- Voici un exemple de lecture/écriture qui sauvegarde une variable
1002 -- globale en dehors de la VM :
1004 -- La première VM qui effectue l'appel suivant n'obtiendra aucune
1005 -- valeur, et devra la créer
1006 local foo = r:ivm_get("cached_data")
1008 foo = do_some_calcs() -- simulation de valeurs de retour
1009 r:ivm_set("cached_data", foo) -- définition globale de la variable
1011 r:puts("La donnée en cache est : ", foo)
1014 <highlight language="lua">
1015 r:htpassword(string [,algorithm [,cost]]) -- Génère un hash de mot de passe à partir d'une chaîne.
1016 -- algorithm: 0 = APMD5 (défaut), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
1017 -- cost: ne s'utilise qu'avec l'algorythme BCRYPT (défaut = 5).
1020 <highlight language="lua">
1021 r:mkdir(dir [,mode]) -- Crée un répertoire et définit son mode via le paramètre optionnel mode.
1024 <highlight language="lua">
1025 r:mkrdir(dir [,mode]) -- Crée des répertoires de manière récursive et définit
1026 -- leur mode via le paramètre optionnel mode.
1029 <highlight language="lua">
1030 r:rmdir(dir) -- Supprime un répertoire.
1033 <highlight language="lua">
1034 r:touch(file [,mtime]) -- Définit la date de modification d'un fichier à la date courante ou à
1035 -- la valeur optionnelle mtime en msec.
1038 <highlight language="lua">
1039 r:get_direntries(dir) -- Renvoie une table contenant toutes les entrées de répertoires.
1041 -- Renvoie un chemin sous forme éclatée en chemin, fichier, extension
1043 local dir = r.context_document_root
1044 for _, f in ipairs(r:get_direntries(dir)) do
1045 local info = r:stat(dir .. "/" .. f)
1047 local mtime = os.date(fmt, info.mtime / 1000000)
1048 local ftype = (info.filetype == 2) and "[dir] " or "[file]"
1049 r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
1055 <highlight language="lua">
1056 r.date_parse_rfc(string) -- Interprète une chaîne date/heure et renvoie l'équivalent en secondes depuis epoche.
1059 <highlight language="lua">
1060 r:getcookie(key) -- Obtient un cookie HTTP
1063 <highlight language="lua">
1064 r:setcookie(key, value, secure, expires) -- Définit un cookie HTTP, par exemple :
1065 r:setcookie("foo", "bar and stuff", false, os.time() + 86400)
1068 <highlight language="lua">
1069 r:wsupgrade() -- Met à jour une connexion vers les WebSockets si possible (et si demandé) :
1070 if r:wsupgrade() then -- si la mise à jour est possible :
1071 r:wswrite("Bienvenue dans les websockets!") -- écrit quelque chose à l'intention du client
1072 r:wsclose() -- Au revoir !
1076 <highlight language="lua">
1077 r:wsread() -- Lit un cadre de websocket depuis une connexion vers websocket mise à jour (voir ci-dessus) :
1079 local line, isFinal = r:wsread() -- isFinal indique s'il s'agit du cadre final.
1080 -- dans le cas contraire, on peut lire les cadres suivants
1081 r:wswrite("Vous avez écrit : " .. line)
1084 <highlight language="lua">
1085 r:wswrite(line) -- écrit un cadre vers un client WebSocket :
1086 r:wswrite("Bonjour le Monde !")
1089 <highlight language="lua">
1090 r:wsclose() -- ferme une requête WebSocket et l'achève pour httpd :
1092 if r:wsupgrade() then
1093 r:wswrite("Ecrire quelque chose : ")
1094 local line = r:wsread() or "nothing"
1095 r:wswrite("Vous avez écrit : " .. line);
1096 r:wswrite("Au revoir !")
1100 <highlight language="lua">
1101 r:wspeek() -- Vérifie s'il y a des données à lire
1103 -- Se met en sommeil tant que rien ne nous est envoyé ...
1104 while r:wspeek() == false do
1107 -- Il y a des données à lire !
1108 local line = r:wsread()
1114 <section id="logging"><title>Fonctions de journalisation</title>
1116 <highlight language="lua">
1117 -- exemples de messages de journalisation
1118 r:trace1("Ceci est un message de journalisation de niveau
1119 trace") -- les niveaux valides vont de trace1 à trace8 <br />
1120 r:debug("Ceci est un message de journalisation de niveau debug")<br />
1121 r:info("Ceci est un message de journalisation de niveau info")<br />
1122 r:notice("Ceci est un message de journalisation de niveau notice")<br />
1123 r:warn("Ceci est un message de journalisation de niveau warn")<br />
1124 r:err("Ceci est un message de journalisation de niveau err")<br />
1125 r:alert("Ceci est un message de journalisation de niveau alert")<br />
1126 r:crit("Ceci est un message de journalisation de niveau crit")<br />
1127 r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
1132 <section id="apache2"><title>Paquet apache2</title>
1133 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
1134 contenu suivant :</p>
1137 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
1138 s'ils ont traité la requête.</dd>
1139 <dt>apache2.DECLINED</dt>
1140 <dd>Constante interne DECLINED. Les gestionnaires renverront cette
1141 valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
1142 <dt>apache2.DONE</dt>
1143 <dd>Constante interne DONE.</dd>
1144 <dt>apache2.version</dt>
1145 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
1146 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1147 <dd>Code d'état HTTP</dd>
1148 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1149 <dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
1150 <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1151 <dd>constantes internes utilisées par <module>mod_authz_core</module></dd>
1154 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
1158 <section id="modifying_buckets">
1159 <title>Modification de contenu avec les filtres lua</title>
1161 Les fonctions de filtrage implémentées via les directives <directive
1162 module="mod_lua">LuaInputFilter</directive> ou <directive
1163 module="mod_lua">LuaOutputFilter</directive> sont conçues comme des
1164 fonctions de 3ème phase non blocantes utilisant des sous-routines
1165 pour suspendre et reprendre l'exécution d'une fonction lorsque des
1166 paquets de données sont envoyés à la chaîne de filtrage. La
1167 structure de base d'une telle fonction est :
1169 <highlight language="lua">
1171 -- Nous indiquons tout d'abord que nous sommes prêts à recevoir des
1172 -- blocs de données.
1173 -- Avant ceci, nous pouvons définir notre environnement, tester
1174 -- certaines conditions, et, si nous le jugeons nécessaire, refuser le
1175 -- filtrage d'une requête :
1176 if something_bad then
1177 return -- Le filtrage est sauté
1179 -- Sans se préoccuper des données que nous devons éventuellement ajouter, un arrêt est réalisé ici.
1180 -- Noter que les filtres de sortie sont les seuls capables d'ajouter des éléments au début des données.
1181 -- Les filtres en entrée peuvent ajouter des éléments à la fin des données au stade final.
1183 coroutine.yield([optional header to be prepended to the content])
1185 -- Après cet arrêt, nous allons recevoir d'autres blocs de données, un par un ;
1186 -- nous pouvons les traiter comme il nous plaît et procéder à la réponse.
1187 -- Ces blocs sont conservés dans la variable globale 'bucket', nous réalisons donc
1188 -- une boucle pour vérifier que 'bucket' n'est pas vide :
1189 while bucket ~= nil do
1190 local output = mangle(bucket) -- Do some stuff to the content
1191 coroutine.yield(output) -- Return our new content to the filter chain
1194 -- Une fois les blocs de données épuisés, 'bucket' est positionné à une valeur vide ('nil'),
1195 -- ce qui va nous faire sortir de cette boucle et nous amener à l'étape suivante.
1196 -- On peut ajouter ce qu'on veut à la fin des données à cette étape, qui constitue le dernier
1197 -- arrêt. Les filtres d'entrée comme de sortie peuvent servir à ajouter des éléments à la fin
1198 -- des données à cette étape.
1199 coroutine.yield([optional footer to be appended to the content])
1203 <section id="databases">
1204 <title>Connectivité aux bases de données</title>
1205 <p>Mod_lua implémente une fonctionnalité basique de connexion aux
1206 bases de données permettant d'envoyer des requêtes ou d'exécuter des
1207 commandes auprès des moteurs de base de données les plus courants
1208 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
1210 <p>L'exemple suivant montre comment se connecter à une base de
1211 données et extraire des informations d'une table :</p>
1212 <highlight language="lua">
1214 -- connexion à la base de données
1215 local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,dbname=mydb")
1217 -- Sélection de certaines informations
1218 local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1220 local rows = results(0) -- extrait tous les enregistrements en mode synchrone
1221 for k, row in pairs(rows) do
1222 r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
1225 r:puts("Database query error: " .. err)
1229 r:puts("Connexion à la base de données impossible : " .. err)
1234 Pour utiliser <module>mod_dbd</module>, spécifiez
1235 <code>mod_dbd</code> comme type de base de données, ou laissez le champ
1238 <highlight language="lua">
1239 local database = r:dbacquire("mod_dbd")
1241 <section id="database_object">
1242 <title>L'objet database et ses méthodes</title>
1243 <p>L'objet database renvoyé par <code>dbacquire</code> possède
1244 les méthodes suivantes :</p>
1245 <p><strong>Sélection normale et requête vers une base de données
1247 <highlight language="lua">
1248 -- Exécution d'une requête et renvoie du nombre d'enregistrements
1250 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1252 -- Exécution d'une requête et renvoie du résultat qui peut être utilisé
1253 en mode synchrone ou asynchrone :
1254 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1256 <p><strong>Utilisation de requêtes préparées (recommandé) :</strong></p>
1257 <highlight language="lua">
1258 -- Création et exécution d'une requête préparée :
1259 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
1261 local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
1264 -- Extrait une requête préparée depuis une directive DBDPrepareSQL :
1265 local statement, errmsg = database:prepared(r, "someTag")
1267 local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête
1271 <p><strong>Echappement de valeurs, fermeture de la base données,
1273 <highlight language="lua">
1274 -- Echappe une valeur pour pouvoir l'utiliser dans une requête :
1275 local escaped = database:escape(r, [["'|blabla]])
1277 -- Ferme une base de données et libère les liens vers cette dernière :
1280 -- Vérifie si une connexion à une base de données est en service et
1281 opérationnelle :
1282 local connected = database:active()
1285 <section id="result_sets">
1286 <title>Travail avec les jeux d'enregistrements renvoyés par les requêtes</title>
1287 <p>Les jeux d'enregistrements renvoyés par <code>db:select</code> ou par des
1288 requêtes préparées créées par <code>db:prepare</code> permettent de
1289 sélectionner des enregistrements en mode synchrone ou
1290 asynchrone, selon le nombre d'enregistrements spécifié :<br/>
1291 <code>result(0)</code> sélectionne tous les enregistrements en mode
1292 synchrone en renvoyant une table d'enregistrements.<br/>
1293 <code>result(-1)</code> sélectionne le prochain enregistrement disponible en
1294 mode asynchrone.<br/>
1295 <code>result(N)</code> sélectionne l'enregistrement numéro
1296 <code>N</code> en mode asynchrone.
1298 <highlight language="lua">
1299 -- extrait un jeu d'enregistrements via une requête régulière :
1300 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1302 local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone
1303 local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone
1304 local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone
1305 local row = result(-1, true) -- Lit l'enregistrement suivant en utilisant les noms d'enregistrements comme index.
1307 <p>Il est possible de construire une fonction qui renvoie une
1308 fonction itérative permettant de traiter tous les enregistrement en mode
1309 synchrone ou asynchrone selon la valeur de l'argument async :
1311 <highlight language="lua">
1312 function rows(resultset, async)
1314 local function getnext()
1316 local row = resultset(-1)
1317 return row and a or nil, row
1320 return pairs(resultset(0))
1322 return getnext, self
1326 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
1328 -- sélectionne des enregistrements en mode asynchrone :
1329 local result, err = statement:select(20)
1331 for index, row in rows(result, true) do
1336 -- sélectionne des enregistrements en mode synchrone :
1337 local result, err = statement:select(20)
1339 for index, row in rows(result, false) do
1346 <section id="closing_databases">
1347 <title>Fermeture d'une connexion à une base de données</title>
1349 <p>Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
1350 données doivent être fermées avec <code>database:close()</code>. Si vous
1351 ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
1352 que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
1353 pas avoir trop de connexions vers la base de données inutilisées. Les
1354 deux mesures suivantes sont pratiquement identiques :
1356 <highlight language="lua">
1357 -- Méthode 1 : fermeture manuelle de la connexion
1358 local database = r:dbacquire("mod_dbd")
1359 database:close() -- c'est tout
1361 -- Méthode 2 : on laisse le collecteur de résidus la fermer
1362 local database = r:dbacquire("mod_dbd")
1363 database = nil -- on coupe le lien
1364 collectgarbage() -- fermeture de la connexion par le collecteur de résidus
1367 <section id="database_caveat">
1368 <title>Précautions à prendre lorsque l'on travaille avec les bases
1369 de données</title>
1370 <p>Bien que les fonctions <code>query</code> et <code>run</code>
1371 soient toujours disponibles, il est recommandé d'utiliser des requêtes
1372 préparées chaque fois que possible, afin d'une part d'optimiser les
1373 performances (si votre connexion reste longtemps en vie), et d'autre part
1374 minimiser le risque d'attaques par injection SQL. Les fonctions
1375 <code>run</code> et <code>query</code> ne doivent être utilisées que
1376 lorsque la requête ne contient pas de variables (requête statique). Dans
1377 le cas des requêtes dynamiques, utilisez <code>db:prepare</code> ou
1378 <code>db:prepared</code>.
1385 <name>LuaRoot</name>
1386 <description>Spécifie le chemin de base pour la résolution des chemins
1387 relatifs dans les directives de mod_lua</description>
1388 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
1389 <contextlist><context>server config</context><context>virtual host</context>
1390 <context>directory</context><context>.htaccess</context>
1392 <override>All</override>
1395 <p>Cette directive permet de spécifier le chemin de base qui sera
1396 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
1397 l'absence de cette directive, les chemins relatifs sont résolus par
1398 rapport au répertoire de travail courant, ce qui ne sera pas
1399 toujours approprié pour un serveur.</p>
1401 </directivesynopsis>
1404 <name>LuaScope</name>
1405 <description>Une valeur parmi once, request, conn, thread -- la valeur par défaut est once</description>
1406 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
1407 <default>LuaScope once</default>
1408 <contextlist><context>server config</context><context>virtual host</context>
1409 <context>directory</context><context>.htaccess</context>
1411 <override>All</override>
1414 <p>Cette directive permet de spécifier la durée de vie de
1415 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
1416 par défaut est "once".</p>
1419 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
1421 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
1422 qui est basé sur le même fichier dans la requête, et qui se trouve
1423 aussi dans la portée de la requête.</dd>
1425 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
1427 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
1428 de vie du thread qui traite la requête (disponible seulement avec
1429 les MPMs threadés).</dd>
1431 <dt>server:</dt> <dd>Le comportement est ici différent, car la
1432 portée du serveur présente une durée de vie assez longue, et
1433 plusieurs threads vont partager le même server_rec. Pour gérer tout
1434 ceci, les états lua du serveur sont stockés dans une liste de ressources
1435 apr. Les arguments <code>min</code> et <code>max</code> permettent
1436 de spécifier les nombres minimaux et maximaux d'états lua à stocker
1439 <p>En général, les portées <code>thread</code> et <code>server</code>
1440 sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
1441 de régénérer de nouveaux états Lua à chaque requête (comme c'est le
1442 cas avec le MPM event, où même les connexions persistantes utilisent un
1443 nouveau thread pour chaque requête). Si vous pensez que vos scripts
1444 n'auront pas de problème s'il réutilisent un état, alors les portées
1445 <code>thread</code> ou <code>server</code> doivent être utilisées car
1446 elles présenteront de meilleures performances. Alors que la portée
1447 <code>thread</code> fournira les réponses les plus rapides, la portée
1448 <code>server</code> utilisera moins de mémoire car les états sont
1449 rassemblés dans des jeux, permettant par exemple à 1000 threads de
1450 partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
1451 requise par la portée <code>thread</code>.
1454 </directivesynopsis>
1457 <name>LuaMapHandler</name>
1458 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
1459 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
1460 [nom-fonction]</syntax>
1461 <contextlist><context>server config</context><context>virtual host</context>
1462 <context>directory</context><context>.htaccess</context>
1464 <override>All</override>
1466 <p>Cette directive permet de faire correspondre un modèle d'uri avec
1467 une fonction de gestionnaire située dans un fichier spécifique. Elle
1468 utilise les expressions rationnelles PCRE pour mettre en
1469 correspondance l'uri, et supporte les groupes de correspondance
1470 d'interpolation dans le chemin du fichier et le nom de la fonction.
1471 Prenez garde aux problèmes de sécurité en écrivant vos expressions
1473 <example><title>Exemples :</title>
1474 <highlight language="config">
1475 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1478 <p>Cette directive va faire correspondre des uri comme
1479 /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
1480 fonction de gestionnaire handle_show au niveau de la vm lua
1481 après chargement de ce fichier.</p>
1483 <highlight language="config">
1484 LuaMapHandler /bingo /scripts/wombat.lua
1486 <p>Cette directive invoquera la fonction "handle" qui est la
1487 valeur par défaut si aucun nom de fonction spécifique n'est
1488 spécifié.</p>
1490 </directivesynopsis>
1493 <name>LuaPackagePath</name>
1494 <description>Ajoute un répertoire au package.path de lua</description>
1495 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
1496 <contextlist><context>server config</context><context>virtual host</context>
1497 <context>directory</context><context>.htaccess</context>
1499 <override>All</override>
1500 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
1501 chemins de recherche du module lua. Elle suit les mêmes conventions
1502 que lua. Ceci modifie le package.path dans les vms lua.</p>
1504 <example><title>Exemples :</title>
1505 <highlight language="config">
1506 LuaPackagePath /scripts/lib/?.lua
1507 LuaPackagePath /scripts/lib/?/init.lua
1511 </directivesynopsis>
1514 <name>LuaPackageCPath</name>
1515 <description>Ajoute un répertoire au package.cpath de lua</description>
1516 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
1517 <contextlist><context>server config</context><context>virtual host</context>
1518 <context>directory</context><context>.htaccess</context>
1520 <override>All</override>
1523 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
1524 de recherche des bibliothèques partagées de lua. Ceci modifie le
1525 package.cpath dans les vms lua.</p>
1528 </directivesynopsis>
1531 <name>LuaCodeCache</name>
1532 <description>Configure le cache de code compilé.</description>
1533 <syntax>LuaCodeCache stat|forever|never</syntax>
1534 <default>LuaCodeCache stat</default>
1536 <context>server config</context><context>virtual host</context>
1537 <context>directory</context><context>.htaccess</context>
1539 <override>All</override>
1542 Cette directive permet de définir le comportement du cache de code
1543 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
1544 du niveau le plus haut (et pas les scripts inclus) est vérifié à
1545 chaque fois que ce fichier est nécessaire, et est rechargé si la
1546 date de modification est plus récente que celle du script déjà
1547 chargé. Les autres valeurs permettent respectivement de garder le
1548 fichier en cache perpétuellement (forever - jamais vérifié ni
1549 remplacé), ou de ne jamais le mettre en cache (never).</p>
1551 <p>En général, les valeurs stat et forever sont utilisées pour un
1552 serveur en production, et les valeurs stat ou never pour un serveur
1553 en développement.</p>
1555 <example><title>Exemples :</title>
1556 <highlight language="config">
1558 LuaCodeCache forever
1564 </directivesynopsis>
1567 <name>LuaHookTranslateName</name>
1568 <description>Fournit un point d'entrée à la phase du nom de
1569 traduction du traitement de la requête</description>
1570 <syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>
1571 <contextlist><context>server config</context><context>virtual host</context>
1573 <override>All</override>
1574 <compatibility>Le troisième argument optionnel est disponible depuis la
1575 version 2.3.15 du serveur HTTP Apache.</compatibility>
1578 Cette directive permet d'ajouter un point d'entrée (à
1579 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
1580 requête. La fonction hook accepte un seul argument, le request_rec,
1581 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
1582 ou une constante définie dans le module apache2 : apache2.OK,
1583 apache2.DECLINED, ou apache2.DONE.</p>
1585 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
1586 (hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
1587 d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
1588 traduction, il doit juste renvoyer apache2.DECLINED. Si le
1589 traitement de la requête doit être interrompu, la valeur renvoyée
1590 doit être apache2.DONE.</p>
1594 <highlight language="config">
1596 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1599 <highlight language="lua">
1600 -- /scripts/conf/hooks.lua --
1602 function silly_mapper(r)
1603 if r.uri == "/" then
1604 r.filename = "/var/www/home.lua"
1607 return apache2.DECLINED
1612 <note><title>Contexte</title><p>Cette directive ne peut être
1613 utilisée ni à l'intérieur d'une section <directive type="section"
1614 module="core">Directory</directive> ou <directive type="section"
1615 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1617 <note><title>Ordonnancement</title><p>Les arguments optionnels
1618 "early" ou "late" permettent de contrôler le moment auquel ce script
1619 s'exécute par rapport aux autres modules.</p></note>
1621 </directivesynopsis>
1624 <name>LuaHookFixups</name>
1625 <description>Fournit un point d'entrée pour la phase de correction du
1626 traitement de la requête</description>
1627 <syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>
1628 <contextlist><context>server config</context><context>virtual host</context>
1629 <context>directory</context><context>.htaccess</context>
1631 <override>All</override>
1634 Idem LuaHookTranslateName, mais s'exécute durant la phase de
1638 </directivesynopsis>
1641 <name>LuaHookLog</name>
1642 <description>Permet une insertion dans la phase de journalisation du
1643 traitement d'une requête</description>
1644 <syntax>LuaHookLog /path/to/lua/script.lua log_function_name</syntax>
1645 <contextlist><context>server config</context><context>virtual host</context>
1646 <context>directory</context><context>.htaccess</context>
1648 <override>All</override>
1651 Ce dispositif d'insertion simple permet d'exécuter une fonction
1652 lorsque httpd entre dans la phase de journalisation du traitement
1653 d'une requête. Vous pouvez ainsi ajouter des données à vos propres
1654 entrées de journalisation, manipuler les entrées du journal standard
1655 avant leur enregistrement ou empêcher l'enregistrement d'une entrée
1656 dans le journal. Pour empêcher l'enregistrement normal des entrées
1657 du journal, renvoyez simplement <code>apache2.DONE</code> dans votre
1658 gestionnaire de journalisation, ou au contraire, renvoyez
1659 <code>apache2.OK</code> pour que httpd effectue une journalisation
1663 <highlight language="config">
1664 LuaHookLog /path/to/script.lua logger
1666 <highlight language="lua">
1667 -- /path/to/script.lua --
1669 -- on joue à pile ou face :
1670 -- Si on obtient 1, on écrit dans notre propre journal Lua et on dit
1671 -- à httpd de ne pas enregistrer d'entrée dans le journal standard..
1672 -- Si on obtient 2, on nettoie un peu les données avant que httpd ne
1673 -- les enregistre dans le journal standard.
1675 if math.random(1,2) == 1 then
1676 -- On effectue notre propre journalisation et le journal
1677 -- standard n'est pas alimenté
1678 local f = io.open("/foo/secret.log", "a")
1680 f:write("Quelque chose de secret est arrivé à " .. r.uri .. "\n")
1683 return apache2.DONE -- On dit à httpd de ne rien enregistrer
1684 --dans le journal standard
1686 r.uri = r.uri:gsub("somesecretstuff", "") -- nettoie les données
1687 return apache2.OK -- et httpd doit alors les enregistrer.
1692 </directivesynopsis>
1696 <name>LuaHookMapToStorage</name>
1697 <description>Fournit un point d'entrée pour la phase map_to_storage du
1698 traitement de la requête</description>
1699 <syntax>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</syntax>
1700 <contextlist><context>server config</context><context>virtual host</context>
1701 <context>directory</context><context>.htaccess</context>
1703 <override>All</override>
1705 <p>Identique à la directive
1706 <directive>LuaHookTranslateName</directive>, mais s'exécute à la
1707 phase map-to-storage du traitement de la requête. Les modules comme
1708 mod_cache agissent pendant cette phase, ce qui permet de présenter
1709 un exemple intéressant de ce que l'on peut faire ici :</p>
1710 <highlight language="config">
1711 LuaHookMapToStorage /path/to/lua/script.lua check_cache
1713 <highlight language="lua">
1717 function read_file(filename)
1718 local input = io.open(filename, "r")
1720 local data = input:read("*a")
1721 cached_files[filename] = data
1722 file = cached_files[filename]
1725 return cached_files[filename]
1728 function check_cache(r)
1729 if r.filename:match("%.png$") then -- Ne concerne que les fichiers PNG
1730 local file = cached_files[r.filename] -- Vérifie les entrées du cache
1732 file = read_file(r.filename) -- Lit le fichier vers le cache
1734 if file then -- Si le fichier existe, on l'envoie
1737 r:info(("%s a été envoyé au client depuis le cache"):format(r.filename))
1738 return apache2.DONE -- cout-circuite le gestionnaire par défaut des fichiers PNG
1741 return apache2.DECLINED -- Si nous n'avons rien eu à faire, nous laissons les autres s'en charger
1746 </directivesynopsis>
1749 <name>LuaHookCheckUserID</name>
1750 <description>Fournit un point d'entrée pour la phase check_user_id du
1751 traitement de la requête</description>
1752 <syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1753 <contextlist><context>server config</context><context>virtual host</context>
1754 <context>directory</context><context>.htaccess</context>
1756 <override>All</override>
1757 <compatibility>Le troisième argument optionnel est disponible depuis la
1758 version 2.3.15 du serveur HTTP Apache.</compatibility>
1760 <note><title>Ordonnancement</title><p>Les arguments optionnels
1761 "early" ou "late" permettent de contrôler le moment auquel ce script
1762 s'exécute par rapport aux autres modules.</p></note>
1764 </directivesynopsis>
1767 <name>LuaHookTypeChecker</name>
1768 <description>Fournit un point d'entrée pour la phase type_checker du
1769 traitement de la requête</description>
1770 <syntax>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</syntax>
1771 <contextlist><context>server config</context><context>virtual host</context>
1772 <context>directory</context><context>.htaccess</context>
1774 <override>All</override>
1775 <usage><p>...</p></usage>
1776 </directivesynopsis>
1779 <name>LuaHookAuthChecker</name>
1780 <description>Fournit un point d'entrée pour la phase auth_checker du
1781 traitement de la requête</description>
1782 <syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1783 <contextlist><context>server config</context><context>virtual host</context>
1784 <context>directory</context><context>.htaccess</context>
1786 <override>All</override>
1787 <compatibility>Le troisième argument optionnel est disponible depuis la
1788 version 2.3.15 du serveur HTTP Apache.</compatibility>
1790 <p>Invoque une fonction lua au cours de la phase auth_checker du
1791 traitement de la requête. Cette directive peut s'utiliser pour
1792 implémenter une vérification arbitraire de l'authentification et de
1793 l'autorisation. Voici un exemple très simple :
1795 <highlight language="lua">
1798 -- fonction d'accroche authcheck fictive
1799 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
1800 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
1801 -- navigateur d'effectuer une authentification basique. Si la requête
1802 -- comporte des données d'authentification, elles ne sont pas vraiment
1803 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
1804 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
1805 -- accepte la requête.
1806 function authcheck_hook(r)
1808 -- recherche des informations d'authentification
1809 auth = r.headers_in['Authorization']
1811 -- définition d'un utilisateur par défaut
1815 if r.user == nil then
1816 r:debug("authcheck: user is nil, returning 401")
1817 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1819 elseif r.user == "foo" then
1820 r:debug('user foo: OK')
1822 r:debug("authcheck: user='" .. r.user .. "'")
1823 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1829 <note><title>Ordonnancement</title><p>Les arguments optionnels
1830 "early" ou "late" permettent de contrôler le moment auquel ce script
1831 s'exécute par rapport aux autres modules.</p></note>
1833 </directivesynopsis>
1836 <name>LuaHookAccessChecker</name>
1837 <description>Fournit un point d'entrée pour la phase access_checker du
1838 traitement de la requête</description>
1839 <syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1840 <contextlist><context>server config</context><context>virtual host</context>
1841 <context>directory</context><context>.htaccess</context>
1843 <override>All</override>
1844 <compatibility>Le troisième argument optionnel est disponible depuis la
1845 version 2.3.15 du serveur HTTP Apache.</compatibility>
1848 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1849 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1851 <note><title>Ordonnancement</title><p>Les arguments optionnels
1852 "early" ou "late" permettent de contrôler le moment auquel ce script
1853 s'exécute par rapport aux autres modules.</p></note>
1855 </directivesynopsis>
1857 <name>LuaHookInsertFilter</name>
1858 <description>Fournit un point d'entrée pour la phase insert_filter du
1859 traitement de la requête</description>
1860 <syntax>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</syntax>
1861 <contextlist><context>server config</context><context>virtual host</context>
1862 <context>directory</context><context>.htaccess</context>
1864 <override>All</override>
1865 <usage><p>Non encore implémenté</p></usage>
1866 </directivesynopsis>
1869 <name>LuaInherit</name>
1870 <description>Contrôle la manière dont les sections de configuration
1871 parentes sont fusionnées dans les enfants</description>
1872 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1873 <default>LuaInherit parent-first</default>
1874 <contextlist><context>server config</context><context>virtual host</context>
1875 <context>directory</context><context>.htaccess</context>
1877 <override>All</override>
1878 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1879 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1880 des sections de configuration Directory ou Location qui se
1881 chevauchent, les scripts
1882 définis dans les sections les plus spécifiques s'exécutent
1883 <em>après</em> ceux définis dans les sections plus génériques
1884 (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1885 en sorte que le contexte parent ne s'applique pas du tout.</p>
1887 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1888 ignorer les directives LuaHook* situées dans les sections de
1889 configuration parentes.</p></usage>
1890 </directivesynopsis>
1893 <name>LuaQuickHandler</name>
1894 <description>Fournit un point d'entrée pour la gestion rapide du
1895 traitement de la requête</description>
1896 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1897 <contextlist><context>server config</context><context>virtual host</context>
1898 <context>directory</context><context>.htaccess</context>
1900 <override>All</override>
1902 <p>Cette phase s'exécute juste après l'attribution de la requête à
1903 un serveur virtuel, et permet d'effectuer certains traitements avant
1904 le déroulement des autres phases, ou de servir une requête sans
1905 avoir à la traduire, l'associer à un espace de stockage, etc...
1906 Comme cette phase s'exécute avant toute autre, les directives telles
1907 que <directive type="section" module="core">Location</directive> ou
1908 <directive type="section" module="core">Directory</directive> ne
1909 sont pas encore prises en compte, car Les URI n'ont pas encore été
1910 entièrement interprétés.
1912 <note><title>Contexte</title><p>Cette directive ne peut être
1913 utilisée ni à l'intérieur d'une section <directive type="section"
1914 module="core">Directory</directive> ou <directive type="section"
1915 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1917 </directivesynopsis>
1920 <name>LuaAuthzProvider</name>
1921 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1923 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1924 <contextlist><context>server config</context> </contextlist>
1925 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1928 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1929 d'autorisation, elle peut être appelée via la directive <directive
1930 module="mod_authz_core">Require</directive> :</p>
1933 <highlight language="config">
1934 LuaRoot /usr/local/apache2/lua
1935 LuaAuthzProvider foo authz.lua authz_check_foo
1940 <highlight language="lua">
1942 function authz_check_foo(r, who)
1943 if r.user ~= who then return apache2.AUTHZ_DENIED
1944 return apache2.AUTHZ_GRANTED
1949 </directivesynopsis>
1952 <name>LuaInputFilter</name>
1953 <description>Fournit une fonction Lua pour le filtrage en entrée</description>
1954 <syntax>LuaInputFilter filter_name /path/to/lua/script.lua function_name</syntax>
1955 <contextlist><context>server config</context> </contextlist>
1956 <compatibility>Disponible depuis la version 2.4.5 du serveur HTTP
1957 Apache</compatibility>
1960 <p>Cette directive permet d'ajouter un filtre en entrée sous la forme
1961 d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
1962 entrée fonctionnent comme des sous-routines, intervenant dans un premier
1963 temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
1964 paquet de données doit être transmis à la chaîne, et éventuellement
1965 produisant toute donnée à ajouter aux données en entrée. La variable
1966 globale <code>bucket</code> contient les paquets de données tels qu'ils
1967 sont transmis au script Lua :
1970 <highlight language="config">
1971 LuaInputFilter myInputFilter /www/filter.lua input_filter
1973 SetInputFilter myInputFilter
1976 <highlight language="lua">
1978 Exemple de filtre en entrée qui convertit toutes les données POST en
1981 function input_filter(r)
1982 print("luaInputFilter called") -- pour débogage
1983 coroutine.yield() -- attend des paquets de données
1984 while bucket do -- Pour chaque paquet, faire ...
1985 local output = string.upper(bucket) -- Convertit toutes les données POST en majuscules
1986 coroutine.yield(output) -- Envoie les données traitées à la chaîne de filtrage
1988 -- plus aucune donnée à traiter.
1989 coroutine.yield("&filterSignature=1234") -- Ajoute une signature à la fin
1993 Le filtre en entrée peut interdire ou sauter un filtre s'il est
1994 considéré comme indésirable :
1996 <highlight language="lua">
1997 function input_filter(r)
1999 return -- Empêche tout simplement le filtrage et transmet le contenu original
2001 coroutine.yield() -- attend des paquets de données
2002 ... -- insert les filtres ici
2006 Voir "<a href="#modifying_buckets">Modification de contenu avec les
2007 filtres Lua</a>" pour plus de détails.
2010 </directivesynopsis>
2013 <name>LuaOutputFilter</name>
2014 <description>Fournit une fonction Lua pour le filtrage de contenu en
2015 sortie</description>
2016 <syntax>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</syntax>
2017 <contextlist><context>server config</context> </contextlist>
2018 <compatibility>Disponible à partir de la version 2.4.5 du serveur HTTP
2019 Apache</compatibility>
2022 <p>>Cette directive permet d'ajouter un filtre en sortie sous la forme
2023 d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
2024 entrée fonctionnent comme des sous-routines, intervenant dans un premier
2025 temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
2026 paquet de données doit être transmis à la chaîne, et éventuellement
2027 produisant toute donnée à ajouter aux données en sortie. La variable
2028 globale <code>bucket</code> contient les paquets de données tels qu'ils
2029 sont transmis au script Lua :
2032 <highlight language="config">
2033 LuaOutputFilter myOutputFilter /www/filter.lua output_filter
2035 SetOutputFilter myOutputFilter
2038 <highlight language="lua">
2040 Exemple de filtre en sortie qui échappe toutes les entités HTML en
2043 function output_filter(r)
2044 coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Ajoute des données au début de la sortie,
2045 -- puis attend des paquets de données à traiter
2046 while bucket do -- Pour chaque paquet, faire ...
2047 local output = r:escape_html(bucket) -- Echappe les données en sortie
2048 coroutine.yield(output) -- Envoie les données traitées à la chaîne
2050 -- plus aucune donnée à traiter.
2054 Comme les filres en entrée, le filtre en sortie peut interdire ou sauter un filtre s'il est
2055 considéré comme indésirable :
2057 <highlight language="lua">
2058 function output_filter(r)
2059 if not r.content_type:match("text/html") then
2060 return -- Empêche tout simplement le filtrage et transmet le contenu original
2062 coroutine.yield() -- attend des paquets de données
2063 ... -- insert les filtres ici
2066 <note><title>Les filtres Lua avec <module>mod_filter</module></title>
2067 <p>Lorsqu'on utilise un filtre Lua comme fournisseur sous-jacent via la
2068 directive <directive module="mod_filter">FilterProvider</directive>, le
2069 filtrage ne fonctionnera que si <var>filter-name</var> est identique à
2070 <var>provider-name</var>.
2074 Voir "<a href="#modifying_buckets">Modification de contenu avec les
2075 filtres Lua</a>" pour plus de détails.
2079 </directivesynopsis>