2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision : 1375917 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
9 Licensed to the Apache Software Foundation (ASF) under one or more
10 contributor license agreements. See the NOTICE file distributed with
11 this work for additional information regarding copyright ownership.
12 The ASF licenses this file to You under the Apache License, Version 2.0
13 (the "License"); you may not use this file except in compliance with
14 the License. You may obtain a copy of the License at
16 http://www.apache.org/licenses/LICENSE-2.0
18 Unless required by applicable law or agreed to in writing, software
19 distributed under the License is distributed on an "AS IS" BASIS,
20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 See the License for the specific language governing permissions and
22 limitations under the License.
25 <modulesynopsis metafile="mod_lua.xml.meta">
29 <description>Fournit des points d'entrée Lua dans différentes parties du
30 traitement des requêtes httpd</description>
31 <status>Experimental</status>
32 <sourcefile>mod_lua.c</sourcefile>
33 <identifier>lua_module</identifier>
34 <compatibility>versions 2.3 et supérieures</compatibility>
37 <p>Ce module permet d'ajouter au serveur des extensions sous forme de
38 scripts écrits dans le langage de programmation Lua.
39 <module>mod_lua</module> fournit de nombreuses extensions
40 (hooks) disponibles avec les modules natifs du serveur HTTP Apache,
41 comme les associations de requêtes à des fichiers, la génération de
42 réponses dynamiques, le contrôle d'accès, l'authentification et
45 <p>Vous trouverez davantage d'informations à propos du langage de
46 programmation Lua sur <a href="http://www.lua.org/">le site web de
49 <note><code>mod_lua</code> est encore au stade expérimental. Son mode
50 d'utilisation et son comportement pourront changer à tout moment jusqu'à
51 ce qu'il passe au stade stable, et ce même entre deux versions stables
52 2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise à
55 <note type="warning"><title>Avertissement</title>
56 <p>Ce module possède une grande capacité d'action sur le fonctrionnement
57 de httpd, ce qui lui confère une grande puissance, mais peut aussi
58 induire un risque de sécurité. Il est déconseillé d'utiliser ce module
59 sur un serveur partagé avec des utilisateurs auxquels vous ne pouvez pas
60 accorder une confiance absolue, car il peut permettre de modifier le
61 fonctionnement interne de httpd.</p>
66 <section id="basicconf"><title>Configuration de base</title>
68 <p>La directive de base pour le chargement du module est</p>
70 <highlight language="config">
71 LoadModule lua_module modules/mod_lua.so
75 <code>mod_lua</code> fournit un gestionnaire nommé
76 <code>lua-script</code> qui peut être utilisé avec une directive
77 <code>AddHandler</code> :</p>
79 <highlight language="config">
80 AddHandler lua-script .lua
84 Ceci aura pour effet de faire traiter les requêtes pour les fichiers
85 dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
86 invoquant cette fonction de <code>gestion</code> de fichier.
89 <p>Pour plus de détails, voir la directive
90 <directive>LuaMapHandler</directive>.
94 <section id="writinghandlers"><title>Ecrire des gestionnaires</title>
95 <p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
96 point d'accroche (hook) spécifique responsable de la génération de la
97 réponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
98 <module>mod_status</module> sont des exemples de modules comportant un
101 <p><code>mod_lua</code> cherche toujours à invoquer une fonction Lua pour le
102 gestionnaire, plutôt que de simplement évaluer le corps d'un script dans
103 le style de CGI. Une fonction de gestionnaire se présente comme suit :</p>
106 <highlight language="lua">
107 <strong>example.lua</strong><br/>
108 -- exemple de gestionnaire
113 Il s'agit du nom de méthode par défaut pour les gestionnaires Lua ;
114 voir les noms de fonctions optionnels dans la directive
115 LuaMapHandler pour choisir un point d'entrée différent.
118 r.content_type = "text/plain"
119 r:puts("Hello Lua World!\n")
121 if r.method == 'GET' then
122 for k, v in pairs( r:parseargs() ) do
123 r:puts( string.format("%s: %s\n", k, v) )
125 elseif r.method == 'POST' then
126 for k, v in pairs( r:parsebody() ) do
127 r:puts( string.format("%s: %s\n", k, v) )
130 r:puts("Unsupported HTTP method " .. r.method)
136 Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
137 d'un formulaire dans un page au format texte.
141 Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
142 gestionnaires (ou points d'entrée, ou filtres) dans le même script.
146 <section id="writingauthzproviders">
147 <title>Ecriture de fournisseurs d'autorisation</title>
149 <p><module>mod_authz_core</module> fournit une interface d'autorisation
150 de haut niveau bien plus facile à utiliser que dans les hooks
151 correspondants. Le premier argument de la directive <directive
152 module="mod_authz_core">Require</directive> permet de spécifier le
153 fournisseur d'autorisation à utiliser. Pour chaque directive <directive
154 module="mod_authz_core">Require</directive>,
155 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
156 spécifié, le reste de la ligne constituant les paramètres. Le
157 fournisseur considéré va alors vérifier les autorisations et fournir le
158 résultat dans une valeur de retour.</p>
160 <p>En général, le fournisseur authz est appelé avant l'authentification.
161 S'il doit connaître le nom d'utilisateur authentifié (ou si
162 l'utilisateur est appelé à être authentifié), le fournisseur doit
163 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
164 déclancher le processus d'authentification et un deuxième appel du
165 fournisseur authz.</p>
167 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
168 une adresse IP et un nom d'utilisateur. Elle autorise l'accès dans le
169 cas où la requête provient de l'adresse IP spécifiée, ou si
170 l'utilisateur authentifié correspond au second argument :</p>
172 <highlight language="lua">
173 <strong>authz_provider.lua</strong><br/>
177 function authz_check_foo(r, ip, user)
178 if r.useragent_ip == ip then
179 return apache2.AUTHZ_GRANTED
180 elseif r.user == nil then
181 return apache2.AUTHZ_DENIED_NO_USER
182 elseif r.user == user then
183 return apache2.AUTHZ_GRANTED
185 return apache2.AUTHZ_DENIED
190 <p>La configuration suivante enregistre cette fonction en tant que
191 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
192 <highlight language="config">
193 LuaAuthzProvider foo authz_provider.lua authz_check_foo
195 Require foo 10.1.2.3 john_doe
201 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
204 <p>Les fonctions d'accroche déterminent la manière dont les modules (et
205 les scripts Lua) participent au traitement des requêtes. Chaque type
206 d'accroche proposé par le serveur a un rôle spécifique, comme
207 l'association de requêtes au système de fichiers, le contrôle d'accès,
208 ou la définition de types MIME : </p>
210 <table border="1" style="zebra">
212 <th>Phase d'accroche</th>
213 <th>Directive mod_lua</th>
217 <td>Gestionnaire rapide</td>
218 <td><directive module="mod_lua">LuaQuickHandler</directive></td>
219 <td>Il s'agit de la première accroche appelée lorsqu'une requête
220 a été associée à un serveur ou un serveur virtuel.</td>
223 <td>Phase de traduction</td>
224 <td><directive module="mod_lua">LuaHookTranslateName</directive></td>
225 <td>Cette phase traduit l'URI de la requête en nom de fichier
226 sur le système. Ce sont des modules comme
227 <module>mod_alias</module> et <module>mod_rewrite</module> qui
228 interviennent au cours de cette phase.</td>
231 <td>Choix du lieu de stockage de la ressource</td>
232 <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
233 <td>Cette phase définit le lieu de stockage de la ressource :
234 physique, en cache ou externe/mandaté. Elle est assurée par les
235 modules de mandat ou de mise en cache.</td>
238 <td>Autorisation d'accès</td>
239 <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
240 <td>Cette phase vérifie si un client a l'autorisation d'accès à
241 la ressource. Elle s'exécute avant l'authentification de
242 l'utisateur ; il faut donc être prudent.
246 <td>Vérification de l'identifiant utilisateur</td>
247 <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
248 <td>Cette phase vérifie l'identifiant de l'utilisateur ayant
249 fait l'objet d'une négociation.</td>
252 <td>Vérification de l'autorisation d'accès</td>
253 <td><directive module="mod_lua">LuaHookAuthChecker</directive>
255 <directive module="mod_lua">LuaAuthzProvider</directive></td>
256 <td>Cette phase vérifie l'autorisation d'accès d'un utilisateur
257 en fonction des ses paramètres de connexion, comme
258 l'identifiant, le certificat, etc...
262 <td>Vérification du type de la ressource</td>
263 <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
264 <td>Cette phase assigne un type de contenu et un gestionnaire à
268 <td>Derniers réglages</td>
269 <td><directive module="mod_lua">LuaHookFixups</directive></td>
270 <td>C'est la dernière phase avant l'activation des gestionnaires
271 de contenu. Toute modification de dernière minute à la requête
272 doit être effectuée ici.</td>
275 <td>Gestionnaire de contenu</td>
276 <td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
277 <td>C'est durant cette phase que le contenu est traité. Les
278 fichiers sont lus, interprétés, certains sont exécutés, et le
279 résultat obtenu est envoyé au client.</td>
282 <td>Journalisation</td>
284 <td>Lorsqu'une requête a été traitée, plusieurs phases de
285 journalisation interviennent, et enregistrent leurs résultats
286 dans les fichiers d'erreur ou d'accès.</td>
291 <p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
292 argument (sauf LuaAuthzProvider qui reçoit aussi des arguments en
293 provenance de la directive Require). Elles peuvent renvoyer une valeur,
294 selon la fonction, mais il s'agit en général d'un
295 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
296 que vous pouvez écrire dans lua sous la forme <code>apache2.OK</code>,
297 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
300 <highlight language="lua">
301 <strong>translate_name.lua</strong><br/>
302 -- exemple d'accroche qui réécrit un URI en chemin du système de
307 function translate_name(r)
308 if r.uri == "/translate-name" then
309 r.filename = r.document_root .. "/find_me.txt"
312 -- on ne gère pas cette URL et on donne sa chance à un autre module
313 return apache2.DECLINED
318 <highlight language="lua">
319 <strong>translate_name2.lua</strong><br/>
320 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
321 un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
322 travailler sur la substitution, y compris l'accroche translate_name
323 de base dont les tables de correspondances se basent sur DocumentRoot.
325 Note: utilisez le drapeau early/late de la directive pour
326 l'exécuter avant ou après mod_alias.
331 function translate_name(r)
332 if r.uri == "/translate-name" then
333 r.uri = "/find_me.txt"
334 return apache2.DECLINED
336 return apache2.DECLINED
341 <section id="datastructures"><title>Structures de données</title>
346 <p>request_rec est considérée en tant que donnée utilisateur.
347 Elle possède une métatable qui vous permet d'accomplir des
348 choses intéressantes. Pour la plus grande partie, elle possède
349 les mêmes champs que la structure request_rec, la
350 plupart d'entre eux étant accessibles en lecture et écriture (le
351 contenu des champs de la table peut être modifié, mais les
352 champs eux-mêmes ne peuvent pas être établis en tant que tables
355 <table border="1" style="zebra">
358 <th><strong>Nom</strong></th>
359 <th><strong>Type Lua</strong></th>
360 <th><strong>Modifiable</strong></th>
361 <th><strong>Description</strong></th>
364 <td><code>allowoverrides</code></td>
367 <td>L'option AllowOverride s'applique à la requête courante.</td>
370 <td><code>ap_auth_type</code></td>
373 <td>Ce champ contient le type d'authentification effectuée
374 (par exemple <code>basic</code>)</td>
377 <td><code>args</code></td>
380 <td>La chaîne de paramètres de la requête (par exemple
381 <code>foo=bar&name=johnsmith</code>)</td>
384 <td><code>assbackwards</code></td>
387 <td>contient true s'il s'agit d'une requête de style HTTP/0.9
388 (par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
391 <td><code>auth_name</code></td>
394 <td>La chaîne d'identification utilisée pour la vérification
395 de l'autorisation d'accès (si elle est disponible).</td>
398 <td><code>banner</code></td>
401 <td>La bannière du serveur, par exemple <code>Apache HTTP
402 Server/2.4.3 openssl/0.9.8c</code></td>
405 <td><code>basic_auth_pw</code></td>
408 <td>Le mot de passe pour l'authentification de base envoyé
409 avec la requête, s'il existe</td>
412 <td><code>canonical_filename</code></td>
415 <td>Le nom de fichier canonique de la requête</td>
418 <td><code>content_encoding</code></td>
421 <td>Le type de codage du contenu de la requête courante</td>
424 <td><code>content_type</code></td>
427 <td>Le type de contenu de la requête courante, tel qu'il a été
428 déterminé au cours de la phase type_check (par exemple
429 <code>image/gif</code> ou <code>text/html</code>)</td>
433 <td><code>context_prefix</code></td>
439 <td><code>context_document_root</code></td>
446 <td><code>document_root</code></td>
449 <td>La racine des documents du serveur</td>
452 <td><code>err_headers_out</code></td>
455 <td>L'en-tête MIME de l'environnement pour la réponse, écrit
456 même en cas d'erreur et conservé pendant les redirections
460 <td><code>filename</code></td>
463 <td>Le nom de fichier correspondant à la requête, par exemple
464 /www/example.com/foo.txt. Il peut être modifié au cours des
465 phases translate-name ou map-to-storage du traitement de la
466 requête pour permettre au gestionnaire par défaut (ou aux
467 gestionnaires de script) de servir une version du fichier
468 autre que celle demandée.</td>
471 <td><code>handler</code></td>
474 <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
475 doit traiter la requête, par exemple <code>lua-script</code>
476 si elle doit être traitée par mod_lua. Cette valeur est en
477 général définie via les directives <directive
478 module="mod_mime">AddHandler</directive> ou <directive
479 module="core">SetHandler</directive>, mais peut aussi l'être
480 via mod_lua pour permettre à un autre gestionnaire de traiter
481 une requête spécifique qui ne serait pas traitée par défaut
486 <td><code>headers_in</code></td>
489 <td>Les en-têtes MIME de l'environnement de la requête. Il
490 s'agit des en-têtes comme <code>Host, User-Agent,
491 Referer</code>, etc...</td>
494 <td><code>headers_out</code></td>
497 <td>Les en-têtes MIME de l'environnement de la réponse.</td>
500 <td><code>hostname</code></td>
503 <td>Le nom d'hôte, tel que défini par l'en-tête
504 <code>Host:</code> ou par un URI complet.</td>
507 <td><code>is_https</code></td>
510 <td>Indique si la requête à été faite via HTTPS</td>
513 <td><code>is_initial_req</code></td>
516 <td>Indique si la requête courante est la requête initiale ou
517 une sous-requête.</td>
520 <td><code>limit_req_body</code></td>
523 <td>La taille maximale du corps de la requête, ou 0 si aucune
527 <td><code>log_id</code></td>
530 <td>L'identifiant de la requête dans les journaux d'accès ou
534 <td><code>method</code></td>
537 <td>La méthode de la requête, par exemple <code>GET</code> ou
538 <code>POST</code>.</td>
541 <td><code>notes</code></td>
544 <td>Une liste de notes qui peuvent être transmises d'un module
545 à l'autre.</td>
548 <td><code>options</code></td>
551 <td>La valeur de la directive Options pour la requête
555 <td><code>path_info</code></td>
558 <td>La valeur de PATH_INFO extraite de la requête.</td>
561 <td><code>port</code></td>
564 <td>Le port du serveur utilisé par la requête.</td>
567 <td><code>protocol</code></td>
570 <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></td>
573 <td><code>proxyreq</code></td>
576 <td>Indique s'il s'agit d'une requête mandatée ou non. Cette
577 valeur est en général définie au cours de la phase
578 post_read_request/translate_name du traitement de la requête.</td>
581 <td><code>range</code></td>
584 <td>Le contenu de l'en-tête <code>Range:</code>.</td>
587 <td><code>remaining</code></td>
590 <td>Le nombre d'octets du corps de la requête restant à lire.</td>
593 <td><code>server_built</code></td>
596 <td>La date de compilation du serveur.</td>
599 <td><code>server_name</code></td>
602 <td>Le nom du serveur pour cette requête.</td>
605 <td><code>some_auth_required</code></td>
608 <td>Indique si une autorisation est/était requise pour cette
612 <td><code>subprocess_env</code></td>
615 <td>Le jeu de variables d'environnement pour cette requête.</td>
618 <td><code>started</code></td>
621 <td>Le moment où le serveur a été (re)démarré, en secondes
622 depuis epoch (1er janvier 1970)</td>
625 <td><code>status</code></td>
628 <td>Le code de retour (courant) pour cette requête, par
629 exemple <code>200</code> ou <code>404</code>.</td>
632 <td><code>the_request</code></td>
635 <td>La chaîne de la requête telle qu'elle a été envoyée par le
636 client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
639 <td><code>unparsed_uri</code></td>
642 <td>La partie URI non interprétée de la requête</td>
645 <td><code>uri</code></td>
648 <td>L'URI après interprétation par httpd</td>
651 <td><code>user</code></td>
654 <td>Si une authentification a été effectuée, nom de
655 l'utilisateur authentifié.</td>
658 <td><code>useragent_ip</code></td>
661 <td>L'adresse IP de l'agent qui a envoyé la requête</td>
665 <p>La structure request_rec possède (au minimum) les méthodes
668 <highlight language="lua">
669 r:flush() -- vide le tampon de sortie
672 <highlight language="lua">
673 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
676 <highlight language="lua">
677 r:sendfile(filename) -- envoie un fichier entier au client en
678 utilisant sendfile s'il est supporté par la plateforme
681 <highlight language="lua">
682 r:parseargs() -- renvoie une table Lua contenant la chaîne
683 d'arguments de la requête
687 <highlight language="lua">
688 r:parsebody()([sizeLimit]) -- interprète le corps de la requête
689 en tant que POST et renvoie une table lua. Un nombre optionnel
690 peut être fourni pour spécifier le nombre maximal d'octets à
691 interpréter. La valeur par défaut est 8192.
695 <highlight language="lua">
696 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
699 <highlight language="lua">
700 r:write("une simple chaîne") -- affichage dans le
701 corps de la réponse
704 <highlight language="lua">
705 r:escape_html("<html>test</html>") -- Echappe le
706 code HTML et renvoie le résultat
713 <section id="logging"><title>Fonctions de journalisation</title>
715 <highlight language="lua">
716 -- exemples de messages de journalisation
717 r:trace1("Ceci est un message de journalisation de niveau
718 trace") -- les niveaux valides vont de trace1 à trace8 <br />
719 r:debug("Ceci est un message de journalisation de niveau debug")<br />
720 r:info("Ceci est un message de journalisation de niveau info")<br />
721 r:notice("Ceci est un message de journalisation de niveau notice")<br />
722 r:warn("Ceci est un message de journalisation de niveau warn")<br />
723 r:err("Ceci est un message de journalisation de niveau err")<br />
724 r:alert("Ceci est un message de journalisation de niveau alert")<br />
725 r:crit("Ceci est un message de journalisation de niveau crit")<br />
726 r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
731 <section id="apache2"><title>Paquet apache2</title>
732 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
733 contenu suivant :</p>
736 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
737 s'ils ont traité la requête.</dd>
738 <dt>apache2.DECLINED</dt>
739 <dd>Constante interne DECLINED. Les gestionnaires renverront cette
740 valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
741 <dt>apache2.DONE</dt>
742 <dd>Constante interne DONE.</dd>
743 <dt>apache2.version</dt>
744 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
745 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
746 <dd>Code d'état HTTP</dd>
747 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
748 <dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
749 <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
750 <dd>constantes internes utilisées par <module>mod_authz_core</module></dd>
753 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
760 <description>Spécifie le chemin de base pour la résolution des chemins
761 relatifs dans les directives de mod_lua</description>
762 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
763 <contextlist><context>server config</context><context>virtual host</context>
764 <context>directory</context><context>.htaccess</context>
766 <override>All</override>
769 <p>Cette directive permet de spécifier le chemin de base qui sera
770 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
771 l'absence de cette directive, les chemins relatifs sont résolus par
772 rapport au répertoire de travail courant, ce qui ne sera pas
773 toujours approprié pour un serveur.</p>
778 <name>LuaScope</name>
779 <description>Une valeur parmi once, request, conn, thread -- la valeur
780 par défaut est once</description>
781 <syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
782 <default>LuaScope once</default>
783 <contextlist><context>server config</context><context>virtual host</context>
784 <context>directory</context><context>.htaccess</context>
786 <override>All</override>
789 <p>Cette directive permet de spécifier la durée de vie de
790 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
791 par défaut est "once".</p>
794 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
796 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
797 qui est basé sur le même fichier dans la requête, et qui se trouve
798 aussi dans la portée de la requête.</dd>
800 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
802 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
803 de vie du thread qui traite la requête (disponible seulement avec
804 les MPMs threadés).</dd>
806 <dt>server:</dt> <dd>Le comportement est ici différent, car la
807 portée du serveur présente une durée de vie assez longue, et
808 plusieurs threads vont partager le même server_rec. Pour gérer tout
809 ceci, les états lua du serveur sont stockés dans une liste de ressources
810 apr. Les arguments <code>min</code> et <code>max</code> permettent
811 de spécifier les nombres minimaux et maximaux d'états lua à stocker
814 <p>En général, les portées <code>thread</code> et <code>server</code>
815 sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
816 de régénérer de nouveaux états Lua à chaque requête (comme c'est le
817 cas avec le MPM event, où même les connexions persistantes utilisent un
818 nouveau thread pour chaque requête). Si vous pensez que vos scripts
819 n'auront pas de problème s'il réutilisent un état, alors les portées
820 <code>thread</code> ou <code>server</code> doivent être utilisées car
821 elles présenteront de meilleures performances. Alors que la portée
822 <code>thread</code> fournira les réponses les plus rapides, la portée
823 <code>server</code> utilisera moins de mémoire car les états sont
824 rassemblés dans des jeux, permettant par exemple à 1000 threads de
825 partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
826 requise par la portée <code>thread</code>.
832 <name>LuaMapHandler</name>
833 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
834 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
835 [nom-fonction]</syntax>
836 <contextlist><context>server config</context><context>virtual host</context>
837 <context>directory</context><context>.htaccess</context>
839 <override>All</override>
841 <p>Cette directive permet de faire correspondre un modèle d'uri avec
842 une fonction de gestionnaire située dans un fichier spécifique. Elle
843 utilise les expressions rationnelles PCRE pour mettre en
844 correspondance l'uri, et supporte les groupes de correspondance
845 d'interpolation dans le chemin du fichier et le nom de la fonction.
846 Prenez garde aux problèmes de sécurité en écrivant vos expressions
848 <example><title>Exemples :</title>
849 <highlight language="config">
850 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
853 <p>Cette directive va faire correspondre des uri comme
854 /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
855 fonction de gestionnaire handle_show au niveau de la vm lua
856 après chargement de ce fichier.</p>
858 <highlight language="config">
859 LuaMapHandler /bingo /scripts/wombat.lua
861 <p>Cette directive invoquera la fonction "handle" qui est la
862 valeur par défaut si aucun nom de fonction spécifique n'est
863 spécifié.</p>
868 <name>LuaPackagePath</name>
869 <description>Ajoute un répertoire au package.path de lua</description>
870 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
871 <contextlist><context>server config</context><context>virtual host</context>
872 <context>directory</context><context>.htaccess</context>
874 <override>All</override>
875 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
876 chemins de recherche du module lua. Elle suit les mêmes conventions
877 que lua. Ceci modifie le package.path dans les vms lua.</p>
879 <example><title>Exemples :</title>
880 <highlight language="config">
881 LuaPackagePath /scripts/lib/?.lua
882 LuaPackagePath /scripts/lib/?/init.lua
889 <name>LuaPackageCPath</name>
890 <description>Ajoute un répertoire au package.cpath de lua</description>
891 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
892 <contextlist><context>server config</context><context>virtual host</context>
893 <context>directory</context><context>.htaccess</context>
895 <override>All</override>
898 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
899 de recherche des bibliothèques partagées de lua. Ceci modifie le
900 package.cpath dans les vms lua.</p>
906 <name>LuaCodeCache</name>
907 <description>Configure le cache de code compilé.</description>
908 <syntax>LuaCodeCache stat|forever|never</syntax>
909 <default>LuaCodeCache stat</default>
911 <context>server config</context><context>virtual host</context>
912 <context>directory</context><context>.htaccess</context>
914 <override>All</override>
917 Cette directive permet de définir le comportement du cache de code
918 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
919 du niveau le plus haut (et pas les scripts inclus) est vérifié à
920 chaque fois que ce fichier est nécessaire, et est rechargé si la
921 date de modification est plus récente que celle du script déjà
922 chargé. Les autres valeurs permettent respectivement de garder le
923 fichier en cache perpétuellement (forever - jamais vérifié ni
924 remplacé), ou de ne jamais le mettre en cache (never).</p>
926 <p>En général, les valeurs stat et forever sont utilisées pour un
927 serveur en production, et les valeurs stat ou never pour un serveur
928 en développement.</p>
930 <example><title>Exemples :</title>
931 <highlight language="config">
942 <name>LuaHookTranslateName</name>
943 <description>Fournit un point d'entrée à la phase du nom de
944 traduction du traitement de la requête</description>
945 <syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>
946 <contextlist><context>server config</context><context>virtual host</context>
948 <override>All</override>
949 <compatibility>Le troisième argument optionnel est disponible depuis la
950 version 2.3.15 du serveur HTTP Apache.</compatibility>
953 Cette directive permet d'ajouter un point d'entrée (à
954 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
955 requête. La fonction hook accepte un seul argument, le request_rec,
956 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
957 ou une constante définie dans le module apache2 : apache2.OK,
958 apache2.DECLINED, ou apache2.DONE.</p>
960 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
961 (hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
962 d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
963 traduction, il doit juste renvoyer apache2.DECLINED. Si le
964 traitement de la requête doit être interrompu, la valeur renvoyée
965 doit être apache2.DONE.</p>
969 <highlight language="config">
971 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
974 <highlight language="lua">
975 -- /scripts/conf/hooks.lua --
977 function silly_mapper(r)
979 r.filename = "/var/www/home.lua"
982 return apache2.DECLINED
987 <note><title>Contexte</title><p>Cette directive ne peut être
988 utilisée ni à l'intérieur d'une section <directive type="section"
989 module="core">Directory</directive> ou <directive type="section"
990 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
992 <note><title>Ordonnancement</title><p>Les arguments optionnels
993 "early" ou "late" permettent de contrôler le moment auquel ce script
994 s'exécute par rapport aux autres modules.</p></note>
999 <name>LuaHookFixups</name>
1000 <description>Fournit un point d'entrée pour la phase de correction du
1001 traitement de la requête</description>
1002 <syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>
1003 <contextlist><context>server config</context><context>virtual host</context>
1004 <context>directory</context><context>.htaccess</context>
1006 <override>All</override>
1009 Idem LuaHookTranslateName, mais s'exécute durant la phase de
1013 </directivesynopsis>
1016 <name>LuaHookMapToStorage</name>
1017 <description>Fournit un point d'entrée pour la phase map_to_storage du
1018 traitement de la requête</description>
1019 <syntax>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</syntax>
1020 <contextlist><context>server config</context><context>virtual host</context>
1021 <context>directory</context><context>.htaccess</context>
1023 <override>All</override>
1025 <p>Identique à la directive
1026 <directive>LuaHookTranslateName</directive>, mais s'exécute à la
1027 phase map-to-storage du traitement de la requête. Les modules comme
1028 mod_cache agissent pendant cette phase, ce qui permet de présenter
1029 un exemple intéressant de ce que l'on peut faire ici :</p>
1030 <highlight language="config">
1031 LuaHookMapToStorage /path/to/lua/script.lua check_cache
1033 <highlight language="lua">
1037 function read_file(filename)
1038 local input = io.open(filename, "r")
1040 local data = input:read("*a")
1041 cached_files[filename] = data
1042 file = cached_files[filename]
1045 return cached_files[filename]
1048 function check_cache(r)
1049 if r.filename:match("%.png$") then -- Only match PNG files
1050 local file = cached_files[r.filename] -- Check cache entries
1052 file = read_file(r.filename) -- Read file into cache
1054 if file then -- If file exists, write it out
1057 r:info(("Sent %s to client from cache"):format(r.filename))
1058 return apache2.DONE -- skip default handler for PNG files
1061 return apache2.DECLINED -- If we had nothing to do, let others serve this.
1066 </directivesynopsis>
1069 <name>LuaHookCheckUserID</name>
1070 <description>Fournit un point d'entrée pour la phase check_user_id du
1071 traitement de la requête</description>
1072 <syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1073 <contextlist><context>server config</context><context>virtual host</context>
1074 <context>directory</context><context>.htaccess</context>
1076 <override>All</override>
1077 <compatibility>Le troisième argument optionnel est disponible depuis la
1078 version 2.3.15 du serveur HTTP Apache.</compatibility>
1080 <note><title>Ordonnancement</title><p>Les arguments optionnels
1081 "early" ou "late" permettent de contrôler le moment auquel ce script
1082 s'exécute par rapport aux autres modules.</p></note>
1084 </directivesynopsis>
1087 <name>LuaHookTypeChecker</name>
1088 <description>Fournit un point d'entrée pour la phase type_checker du
1089 traitement de la requête</description>
1090 <syntax>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</syntax>
1091 <contextlist><context>server config</context><context>virtual host</context>
1092 <context>directory</context><context>.htaccess</context>
1094 <override>All</override>
1095 <usage><p>...</p></usage>
1096 </directivesynopsis>
1099 <name>LuaHookAuthChecker</name>
1100 <description>Fournit un point d'entrée pour la phase auth_checker du
1101 traitement de la requête</description>
1102 <syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1103 <contextlist><context>server config</context><context>virtual host</context>
1104 <context>directory</context><context>.htaccess</context>
1106 <override>All</override>
1107 <compatibility>Le troisième argument optionnel est disponible depuis la
1108 version 2.3.15 du serveur HTTP Apache.</compatibility>
1110 <p>Invoque une fonction lua au cours de la phase auth_checker du
1111 traitement de la requête. Cette directive peut s'utiliser pour
1112 implémenter une vérification arbitraire de l'authentification et de
1113 l'autorisation. Voici un exemple très simple :
1115 <highlight language="lua">
1118 -- fonction d'accroche authcheck fictive
1119 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
1120 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
1121 -- navigateur d'effectuer une authentification basique. Si la requête
1122 -- comporte des données d'authentification, elles ne sont pas vraiment
1123 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
1124 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
1125 -- accepte la requête.
1126 function authcheck_hook(r)
1128 -- recherche des informations d'authentification
1129 auth = r.headers_in['Authorization']
1131 -- définition d'un utilisateur par défaut
1135 if r.user == nil then
1136 r:debug("authcheck: user is nil, returning 401")
1137 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1139 elseif r.user == "foo" then
1140 r:debug('user foo: OK')
1142 r:debug("authcheck: user='" .. r.user .. "'")
1143 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1149 <note><title>Ordonnancement</title><p>Les arguments optionnels
1150 "early" ou "late" permettent de contrôler le moment auquel ce script
1151 s'exécute par rapport aux autres modules.</p></note>
1153 </directivesynopsis>
1156 <name>LuaHookAccessChecker</name>
1157 <description>Fournit un point d'entrée pour la phase access_checker du
1158 traitement de la requête</description>
1159 <syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1160 <contextlist><context>server config</context><context>virtual host</context>
1161 <context>directory</context><context>.htaccess</context>
1163 <override>All</override>
1164 <compatibility>Le troisième argument optionnel est disponible depuis la
1165 version 2.3.15 du serveur HTTP Apache.</compatibility>
1168 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1169 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1171 <note><title>Ordonnancement</title><p>Les arguments optionnels
1172 "early" ou "late" permettent de contrôler le moment auquel ce script
1173 s'exécute par rapport aux autres modules.</p></note>
1175 </directivesynopsis>
1177 <name>LuaHookInsertFilter</name>
1178 <description>Fournit un point d'entrée pour la phase insert_filter du
1179 traitement de la requête</description>
1180 <syntax>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</syntax>
1181 <contextlist><context>server config</context><context>virtual host</context>
1182 <context>directory</context><context>.htaccess</context>
1184 <override>All</override>
1185 <usage><p>Non encore implémenté</p></usage>
1186 </directivesynopsis>
1189 <name>LuaInherit</name>
1190 <description>Contrôle la manière dont les sections de configuration
1191 parentes sont fusionnées dans les enfants</description>
1192 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1193 <default>LuaInherit parent-first</default>
1194 <contextlist><context>server config</context><context>virtual host</context>
1195 <context>directory</context><context>.htaccess</context>
1197 <override>All</override>
1198 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1199 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1200 des sections de configuration Directory ou Location qui se
1201 chevauchent, les scripts
1202 définis dans les sections les plus spécifiques s'exécutent
1203 <em>après</em> ceux définis dans les sections plus génériques
1204 (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1205 en sorte que le contexte parent ne s'applique pas du tout.</p>
1207 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1208 ignorer les directives LuaHook* situées dans les sections de
1209 configuration parentes.</p></usage>
1210 </directivesynopsis>
1213 <name>LuaQuickHandler</name>
1214 <description>Fournit un point d'entrée pour la gestion rapide du
1215 traitement de la requête</description>
1216 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1217 <contextlist><context>server config</context><context>virtual host</context>
1218 <context>directory</context><context>.htaccess</context>
1220 <override>All</override>
1222 <p>Cette phase s'exécute juste après l'attribution de la requête à
1223 un serveur virtuel, et permet d'effectuer certains traitements avant
1224 le déroulement des autres phases, ou de servir une requête sans
1225 avoir à la traduire, l'associer à un espace de stockage, etc...
1226 Comme cette phase s'exécute avant toute autre, les directives telles
1227 que <directive type="section" module="core">Location</directive> ou
1228 <directive type="section" module="core">Directory</directive> ne
1229 sont pas encore prises en compte, car Les URI n'ont pas encore été
1230 entièrement interprétés.
1232 <note><title>Contexte</title><p>Cette directive ne peut être
1233 utilisée ni à l'intérieur d'une section <directive type="section"
1234 module="core">Directory</directive> ou <directive type="section"
1235 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1237 </directivesynopsis>
1240 <name>LuaAuthzProvider</name>
1241 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1243 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1244 <contextlist><context>server config</context> </contextlist>
1245 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1248 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1249 d'autorisation, elle peut être appelée via la directive <directive
1250 module="mod_authz_core">Require</directive> :</p>
1253 <highlight language="config">
1254 LuaRoot /usr/local/apache2/lua
1255 LuaAuthzProvider foo authz.lua authz_check_foo
1260 <highlight language="lua">
1262 function authz_check_foo(r, who)
1263 if r.user ~= who then return apache2.AUTHZ_DENIED
1264 return apache2.AUTHZ_GRANTED
1269 </directivesynopsis>