2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1442083:1477001 (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 à
57 <section id="basicconf"><title>Configuration de base</title>
59 <p>La directive de base pour le chargement du module est</p>
61 <highlight language="config">
62 LoadModule lua_module modules/mod_lua.so
66 <code>mod_lua</code> fournit un gestionnaire nommé
67 <code>lua-script</code> qui peut être utilisé avec une directive
68 <code>AddHandler</code> :</p>
70 <highlight language="config">
71 AddHandler lua-script .lua
75 Ceci aura pour effet de faire traiter les requêtes pour les fichiers
76 dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
77 invoquant cette fonction de <code>gestion</code> de fichier.
80 <p>Pour plus de détails, voir la directive
81 <directive>LuaMapHandler</directive>.
86 <section id="writinghandlers"><title>Ecrire des gestionnaires</title>
87 <p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
88 point d'accroche (hook) spécifique responsable de la génération de la
89 réponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
90 <module>mod_status</module> sont des exemples de modules comportant un
93 <p><code>mod_lua</code> cherche toujours à invoquer une fonction Lua pour le
94 gestionnaire, plutôt que de simplement évaluer le corps d'un script dans
95 le style de CGI. Une fonction de gestionnaire se présente comme suit :</p>
98 <highlight language="lua">
99 <strong>example.lua</strong>
100 -- exemple de gestionnaire
105 Il s'agit du nom de méthode par défaut pour les gestionnaires Lua ;
106 voir les noms de fonctions optionnels dans la directive
107 LuaMapHandler pour choisir un point d'entrée différent.
110 r.content_type = "text/plain"
111 r:puts("Hello Lua World!\n")
113 if r.method == 'GET' then
114 for k, v in pairs( r:parseargs() ) do
115 r:puts( string.format("%s: %s\n", k, v) )
117 elseif r.method == 'POST' then
118 for k, v in pairs( r:parsebody() ) do
119 r:puts( string.format("%s: %s\n", k, v) )
123 r:puts("Unsupported HTTP method " .. r.method)
129 Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
130 d'un formulaire dans un page au format texte.
134 Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
135 gestionnaires (ou points d'entrée, ou filtres) dans le même script.
139 <section id="writingauthzproviders">
140 <title>Ecriture de fournisseurs d'autorisation</title>
142 <p><module>mod_authz_core</module> fournit une interface d'autorisation
143 de haut niveau bien plus facile à utiliser que dans les hooks
144 correspondants. Le premier argument de la directive <directive
145 module="mod_authz_core">Require</directive> permet de spécifier le
146 fournisseur d'autorisation à utiliser. Pour chaque directive <directive
147 module="mod_authz_core">Require</directive>,
148 <module>mod_authz_core</module> appellera le fournisseur d'autorisation
149 spécifié, le reste de la ligne constituant les paramètres. Le
150 fournisseur considéré va alors vérifier les autorisations et fournir le
151 résultat dans une valeur de retour.</p>
153 <p>En général, le fournisseur authz est appelé avant l'authentification.
154 S'il doit connaître le nom d'utilisateur authentifié (ou si
155 l'utilisateur est appelé à être authentifié), le fournisseur doit
156 renvoyer <code>apache2.AUTHZ_DENIED_NO_USER</code>, ce qui va
157 déclancher le processus d'authentification et un deuxième appel du
158 fournisseur authz.</p>
160 <p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
161 une adresse IP et un nom d'utilisateur. Elle autorise l'accès dans le
162 cas où la requête provient de l'adresse IP spécifiée, ou si
163 l'utilisateur authentifié correspond au second argument :</p>
165 <highlight language="lua">
166 <strong>authz_provider.lua</strong><br/>
170 function authz_check_foo(r, ip, user)
171 if r.useragent_ip == ip then
172 return apache2.AUTHZ_GRANTED
173 elseif r.user == nil then
174 return apache2.AUTHZ_DENIED_NO_USER
175 elseif r.user == user then
176 return apache2.AUTHZ_GRANTED
178 return apache2.AUTHZ_DENIED
183 <p>La configuration suivante enregistre cette fonction en tant que
184 fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
185 <highlight language="config">
186 LuaAuthzProvider foo authz_provider.lua authz_check_foo
188 Require foo 10.1.2.3 john_doe
194 <section id="writinghooks"><title>Ecriture de fonctions d'accroche
197 <p>Les fonctions d'accroche déterminent la manière dont les modules (et
198 les scripts Lua) participent au traitement des requêtes. Chaque type
199 d'accroche proposé par le serveur a un rôle spécifique, comme
200 l'association de requêtes au système de fichiers, le contrôle d'accès,
201 ou la définition de types MIME. Il existe aussi des accroches à usage
202 général qui s'exécutent simplement à des moments opportuns du cycle
203 de vie de la requête.</p>
205 <p>Les fonctions d'accroche acceptent l'objet de la requête comme seul
206 et unique argument. Elles peuvent renvoyer une valeur, selon la
207 fonction, mais il s'agit en général d'un
208 code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
209 que vous pouvez écrire dans lua sous la forme <code>apache2.OK</code>,
210 <code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
212 <highlight language="lua">
213 <strong>translate_name.lua</strong>
214 -- exemple d'accroche qui réécrit un URI en chemin du système de
219 function translate_name(r)
220 if r.uri == "/translate-name" then
221 r.filename = r.document_root .. "/find_me.txt"
224 -- on ne gère pas cette URL et on donne sa chance à un autre module
225 return apache2.DECLINED
229 <highlight language="lua">
230 <strong>translate_name2.lua</strong>
231 --[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
232 un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
233 travailler sur la substitution, y compris l'accroche translate_name
234 de base dont les tables de correspondances se basent sur DocumentRoot.
236 Note: actuellement, il est impossible de prévoir si cette action
237 s'exécute avant ou après mod_alias.
242 function translate_name(r)
243 if r.uri == "/translate-name" then
244 r.uri = "/find_me.txt"
245 return apache2.DECLINED
247 return apache2.DECLINED
252 <section id="datastructures"><title>Structures de données</title>
257 <p>request_rec est considérée en tant que donnée utilisateur.
258 Elle possède une métatable qui vous permet d'accomplir des
259 choses intéressantes. Pour la plus grande partie, elle possède
260 les mêmes champs que la structure request_rec (voir httpd.h en
261 attendant que cette documentation soit plus complète), la
262 plupart d'entre eux étant accessibles en lecture et écriture (le
263 contenu des champs de la table peut être modifié, mais les
264 champs eux-mêmes ne peuvent pas être établis en tant que tables
270 <th><strong>Nom</strong></th>
271 <th><strong>Type Lua</strong></th>
272 <th><strong>Modifiable</strong></th>
275 <td><code>ap_auth_type</code></td>
280 <td><code>args</code></td>
285 <td><code>assbackwards</code></td>
291 <td><code>canonical_filename</code></td>
296 <td><code>content_encoding</code></td>
301 <td><code>content_type</code></td>
306 <td><code>context_prefix</code></td>
311 <td><code>context_document_root</code></td>
317 <td><code>document_root</code></td>
322 <td><code>err_headers_out</code></td>
327 <td><code>filename</code></td>
332 <td><code>handler</code></td>
337 <td><code>headers_in</code></td>
342 <td><code>headers_out</code></td>
347 <td><code>hostname</code></td>
352 <td><code>log_id</code></td>
357 <td><code>method</code></td>
362 <td><code>notes</code></td>
367 <td><code>path_info</code></td>
372 <td><code>protocol</code></td>
377 <td><code>proxyreq</code></td>
382 <td><code>range</code></td>
387 <td><code>subprocess_env</code></td>
392 <td><code>status</code></td>
397 <td><code>the_request</code></td>
402 <td><code>unparsed_uri</code></td>
407 <td><code>uri</code></td>
412 <td><code>user</code></td>
417 <td><code>useragent_ip</code></td>
423 <p>La structure request_rec possède (au minimum) les méthodes
426 <highlight language="lua">
427 r:addoutputfilter(name|function) -- ajoute un filtre en sortie
430 <highlight language="lua">
431 r:parseargs() -- renvoie une table lua contenant la chaîne
432 d'arguments de la requête
435 <highlight language="lua">
436 r:parsebody()([sizeLimit]) -- interprète le corps de la requête
437 en tant que POST et renvoie une table lua. Un nombre optionnel
438 peut être fourni pour spécifier le nombre maximal d'octets à
439 interpréter. La valeur par défaut est 8192.
442 <highlight language="lua">
443 r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
446 <highlight language="lua">
447 r:write("une simple chaîne") -- affichage dans le
448 corps de la réponse
451 <highlight language="lua">
452 r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
453 base de données et renvoie une classe database. Voir '<a
454 href="#databases">Connectivité aux bases de données</a>' pour plus de
462 <section id="logging"><title>Fonctions de journalisation</title>
464 <highlight language="lua">
465 -- exemples de messages de journalisation
466 r:trace1("Ceci est un message de journalisation de niveau
467 trace") -- les niveaux valides vont de trace1 à trace8 <br />
468 r:debug("Ceci est un message de journalisation de niveau debug")<br />
469 r:info("Ceci est un message de journalisation de niveau info")<br />
470 r:notice("Ceci est un message de journalisation de niveau notice")<br />
471 r:warn("Ceci est un message de journalisation de niveau warn")<br />
472 r:err("Ceci est un message de journalisation de niveau err")<br />
473 r:alert("Ceci est un message de journalisation de niveau alert")<br />
474 r:crit("Ceci est un message de journalisation de niveau crit")<br />
475 r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
480 <section id="apache2"><title>Paquet apache2</title>
481 <p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
482 contenu suivant :</p>
485 <dd>Constante interne OK. Les gestionnaires renverront cette valeur
486 s'ils ont traité la requête.</dd>
487 <dt>apache2.DECLINED</dt>
488 <dd>Constante interne DECLINED. Les gestionnaires renverront cette
489 valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
490 <dt>apache2.DONE</dt>
491 <dd>Constante interne DONE.</dd>
492 <dt>apache2.version</dt>
493 <dd>Chaîne contenant la version du serveur HTTP Apache</dd>
494 <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
495 <dd>Code d'état HTTP</dd>
496 <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
497 <dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
499 <p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
502 <section id="databases">
503 <title>Connectivité aux bases de données</title>
504 <p>Mod_lua implémente une fonctionnalité basique de connexion aux
505 bases de données permettant d'envoyer des requêtes ou d'exécuter des
506 commandes auprès des moteurs de base de données les plus courants
507 (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
509 <p>L'exemple suivant montre comment se connecter à une base de
510 données et extraire des informations d'une table :</p>
511 <highlight language="lua">
513 -- connexion à la base de données
514 local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
516 -- Sélection de certaines informations
517 local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
519 local rows = results(0) -- extrait tous les enregistrements en mode synchrone
520 for k, row in pairs(rows) do
521 r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) )
524 r:puts("Database query error: " .. err)
528 r:puts("Connexion à la base de données impossible : " .. err)
533 Pour utiliser <module>mod_dbd</module>, spécifiez
534 <code>mod_dbd</code> comme type de base de données, ou laissez le champ
537 <highlight language="lua">
538 local database = r:dbacquire("mod_dbd")
540 <section id="database_object">
541 <title>L'objet database et ses méthodes</title>
542 <p>L'objet database renvoyé par <code>dbacquire</code> possède
543 les méthodes suivantes :</p>
544 <p><strong>Sélection normale et requête vers une base de données
546 <highlight language="lua">
547 -- Exécution d'une requête et renvoie du nombre d'enregistrements
549 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
551 -- Exécution d'une requête et renvoie du résultat qui peut être utilisé
552 en mode synchrone ou asynchrone :
553 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
555 <p><strong>Utilisation de requêtes préparées (recommandé) :</strong></p>
556 <highlight language="lua">
557 -- Création et exécution d'une requête préparée :
558 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
560 local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
563 -- Extrait une requête préparée depuis une directive DBDPrepareSQL :
564 local statement, errmsg = database:prepared(r, "someTag")
566 local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête
570 <p><strong>Echappement de valeurs, fermeture de la base données,
572 <highlight language="lua">
573 -- Echappe une valeur pour pouvoir l'utiliser dans une requête :
574 local escaped = database:escape(r, [["'|blabla]])
576 -- Ferme une base de données et libère les liens vers cette dernière :
579 -- Vérifie si une connexion à une base de données est en service et
580 opérationnelle :
581 local connected = database:active()
584 <section id="result_sets">
585 <title>Travail avec les jeux d'enregistrements renvoyés par les requêtes</title>
586 <p>Les jeux d'enregistrements renvoyés par <code>db:select</code> ou par des
587 requêtes préparées créées par <code>db:prepare</code> permettent de
588 sélectionner des enregistrements en mode synchrone ou
589 asynchrone, selon le nombre d'enregistrements spécifié :<br/>
590 <code>result(0)</code> sélectionne tous les enregistrements en mode
591 synchrone en renvoyant une table d'enregistrements.<br/>
592 <code>result(-1)</code> sélectionne le prochain enregistrement disponible en
593 mode asynchrone.<br/>
594 <code>result(N)</code> sélectionne l'enregistrement numéro
595 <code>N</code> en mode asynchrone.
597 <highlight language="lua">
598 -- extrait un jeu d'enregistrements via une requête régulière :
599 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
601 local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone
602 local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone
603 local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone
605 <p>Il est possible de construire une fonction qui renvoie une
606 fonction itérative permettant de traiter tous les enregistrement en mode
607 synchrone ou asynchrone selon la valeur de l'argument async :
609 <highlight language="lua">
610 function rows(resultset, async)
612 local function getnext()
614 local row = resultset(-1)
615 return row and a or nil, row
618 return pairs(resultset(0))
624 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")
626 -- sélectionne des enregistrements en mode asynchrone :
627 local result, err = statement:select(20)
629 for index, row in rows(result, true) do
634 -- sélectionne des enregistrements en mode synchrone :
635 local result, err = statement:select(20)
637 for index, row in rows(result, false) do
644 <section id="closing_databases">
645 <title>Fermeture d'une connexion à une base de données</title>
647 <p>Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
648 données doivent être fermées avec <code>database:close()</code>. Si vous
649 ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
650 que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
651 pas avoir trop de connexions vers la base de données inutilisées. Les
652 deux mesures suivantes sont pratiquement identiques :
654 <highlight language="lua">
655 -- Méthode 1 : fermeture manuelle de la connexion
656 local database = r:dbacquire("mod_dbd")
657 database:close() -- c'est tout
659 -- Méthode 2 : on laisse le collecteur de résidus la fermer
660 local database = r:dbacquire("mod_dbd")
661 database = nil -- on coupe le lien
662 collectgarbage() -- fermeture de la connexion par le collecteur de résidus
665 <section id="database_caveat">
666 <title>Précautions à prendre lorsque l'on travaille avec les bases
667 de données</title>
668 <p>Bien que les fonctions <code>query</code> et <code>run</code>
669 soient toujours disponibles, il est recommandé d'utiliser des requêtes
670 préparées chaque fois que possible, afin d'une part d'optimiser les
671 performances (si votre connexion reste longtemps en vie), et d'autre part
672 minimiser le risque d'attaques par injection SQL. Les fonctions
673 <code>run</code> et <code>query</code> ne doivent être utilisées que
674 lorsque la requête ne contient pas de variables (requête statique). Dans
675 le cas des requêtes dynamiques, utilisez <code>db:prepare</code> ou
676 <code>db:prepared</code>.
684 <description>Spécifie le chemin de base pour la résolution des chemins
685 relatifs dans les directives de mod_lua</description>
686 <syntax>LuaRoot /chemin/vers/un/répertoire</syntax>
687 <contextlist><context>server config</context><context>virtual host</context>
688 <context>directory</context><context>.htaccess</context>
690 <override>All</override>
693 <p>Cette directive permet de spécifier le chemin de base qui sera
694 utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
695 l'absence de cette directive, les chemins relatifs sont résolus par
696 rapport au répertoire de travail courant, ce qui ne sera pas
697 toujours approprié pour un serveur.</p>
702 <name>LuaScope</name>
703 <description>Une valeur parmi once, request, conn, thread -- la valeur
704 par défaut est once</description>
705 <syntax>LuaScope once|request|conn|thread -- la valeur par défaur est
707 <default>LuaScope once</default>
708 <contextlist><context>server config</context><context>virtual host</context>
709 <context>directory</context><context>.htaccess</context>
711 <override>All</override>
714 <p>Cette directive permet de spécifier la durée de vie de
715 l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
716 par défaut est "once".</p>
719 <dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
721 <dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
722 qui est basé sur le même fichier dans la requête, et qui se trouve
723 aussi dans la portée de la requête.</dd>
725 <dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
726 <dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
727 de vie du thread qui traite la requête (disponible seulement avec
728 les MPMs threadés).</dd>
730 <dt>server:</dt> <dd>Le comportement est ici différent, car la
731 portée du serveur présente une durée de vie assez longue, et
732 plusieurs threads vont partager le même server_rec. Pour gérer tout
733 ceci, les interpréteurs sont stockés dans une liste de ressources
734 apr. Les arguments min et max ont été prévus pour spécifier une
735 taille de jeu, mais sont inutilisés pour le moment.</dd>
742 +/* Not implemented in 2.4.x yet */
744 <name>LuaMapHandler</name>
745 <description>Met en correspondance un chemin avec un gestionnaire lua</description>
746 <syntax>LuaMapHandler modele-uri /chemin/vers/lua/script.lua
747 [nom-fonction]</syntax>
748 <contextlist><context>server config</context><context>virtual host</context>
749 <context>directory</context><context>.htaccess</context>
751 <override>All</override>
753 <p>Cette directive permet de faire correspondre un modèle d'uri avec
754 une fonction de gestionnaire située dans un fichier spécifique. Elle
755 utilise les expressions rationnelles PCRE pour mettre en
756 correspondance l'uri, et supporte les groupes de correspondance
757 d'interpolation dans le chemin du fichier et le nom de la fonction.
758 Prenez garde aux problèmes de sécurité en écrivant vos expressions
760 <example><title>Exemples :</title>
761 <highlight language="config">
762 LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
765 <p>Cette directive va faire correspondre des uri comme
766 /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la
767 fonction de gestionnaire handle_show au niveau de la vm lua
768 après chargement de ce fichier.</p>
770 <highlight language="config">
771 LuaMapHandler /bingo /scripts/wombat.lua
773 <p>Cette directive invoquera la fonction "handle" qui est la
774 valeur par défaut si aucun nom de fonction spécifique n'est
775 spécifié.</p>
781 <name>LuaPackagePath</name>
782 <description>Ajoute un répertoire au package.path de lua</description>
783 <syntax>LuaPackagePath /chemin/vers/include/?.lua</syntax>
784 <contextlist><context>server config</context><context>virtual host</context>
785 <context>directory</context><context>.htaccess</context>
787 <override>All</override>
788 <usage><p>Cette directive permet d'ajouter un chemin à la liste des
789 chemins de recherche du module lua. Elle suit les mêmes conventions
790 que lua. Ceci modifie le package.path dans les vms lua.</p>
792 <example><title>Exemples :</title>
793 <highlight language="config">
794 LuaPackagePath /scripts/lib/?.lua
795 LuaPackagePath /scripts/lib/?/init.lua
802 <name>LuaPackageCPath</name>
803 <description>Ajoute un répertoire au package.cpath de lua</description>
804 <syntax>LuaPackageCPath /chemin/vers/include/?.soa</syntax>
805 <contextlist><context>server config</context><context>virtual host</context>
806 <context>directory</context><context>.htaccess</context>
808 <override>All</override>
811 <p>Cette directive permet d'ajouter un chemin à la liste des chemins
812 de recherche des bibliothèques partagées de lua. Ceci modifie le
813 package.cpath dans les vms lua.</p>
818 <!-- Not implemented yet
820 <name>LuaCodeCache</name>
821 <description>Configure le cache de code compilé.</description>
822 <syntax>LuaCodeCache stat|forever|never</syntax>
823 <default>LuaCodeCache stat</default>
824 <contextlist><context>server config</context><context>virtual host</context>
825 <context>directory</context><context>.htaccess</context>
827 <override>All</override>
830 Cette directive permet de définir le comportement du cache de code
831 en mémoire. La valeur par défaut est stat ; dans ce cas, le script
832 du niveau le plus haut (et pas les scripts inclus) est vérifié à
833 chaque fois que ce fichier est nécessaire, et est rechargé si la
834 date de modification est plus récente que celle du script déjà
835 chargé. Les autres valeurs permettent respectivement de garder le
836 fichier en cache perpétuellement (forever - jamais vérifié ni
837 remplacé), ou de ne jamais le mettre en cache (never).</p>
839 <p>En général, les valeurs stat et forever sont utilisées pour un
840 serveur en production, et les valeurs stat ou never pour un serveur
841 en développement.</p>
843 <example><title>Exemples :</title>
844 <highlight language="config">
856 <name>LuaHookTranslateName</name>
857 <description>Fournit un point d'entrée à la phase du nom de
858 traduction du traitement de la requête</description>
859 <syntax>LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late]</syntax>
860 <contextlist><context>server config</context><context>virtual host</context>
862 <override>All</override>
863 <compatibility>Le troisième argument optionnel est disponible depuis la
864 version 2.3.15 du serveur HTTP Apache.</compatibility>
867 Cette directive permet d'ajouter un point d'entrée (à
868 APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
869 requête. La fonction hook accepte un seul argument, le request_rec,
870 et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
871 ou une constante définie dans le module apache2 : apache2.OK,
872 apache2.DECLINED, ou apache2.DONE.</p>
874 <p>Pour ceux qui ne sont pas familiers avec les points d'entrée
875 (hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
876 d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
877 traduction, il doit juste renvoyer apache2.DECLINED. Si le
878 traitement de la requête doit être interrompu, la valeur renvoyée
879 doit être apache2.DONE.</p>
883 <highlight language="config">
885 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
888 <highlight language="lua">
889 -- /scripts/conf/hooks.lua --
891 function silly_mapper(r)
893 r.filename = "/var/www/home.lua"
896 return apache2.DECLINED
901 <note><title>Contexte</title><p>Cette directive ne peut être
902 utilisée ni à l'intérieur d'une section <directive type="section"
903 module="core">Directory</directive> ou <directive type="section"
904 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
906 <note><title>Ordonnancement</title><p>Les arguments optionnels
907 "early" ou "late" permettent de contrôler le moment auquel ce script
908 s'exécute par rapport aux autres modules.</p></note>
913 <name>LuaHookFixups</name>
914 <description>Fournit un point d'entrée pour la phase de correction du
915 traitement de la requête</description>
916 <syntax>LuaHookFixups /chemin/vers/lua/script.lua hook_function_name</syntax>
917 <contextlist><context>server config</context><context>virtual host</context>
918 <context>directory</context><context>.htaccess</context>
920 <override>All</override>
923 Idem LuaHookTranslateName, mais s'exécute durant la phase de
930 <name>LuaHookMapToStorage</name>
931 <description>Fournit un point d'entrée pour la phase map_to_storage du
932 traitement de la requête</description>
933 <syntax>LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name</syntax>
934 <contextlist><context>server config</context><context>virtual host</context>
935 <context>directory</context><context>.htaccess</context>
937 <override>All</override>
938 <usage><p>...</p></usage>
942 <name>LuaHookCheckUserID</name>
943 <description>Fournit un point d'entrée pour la phase check_user_id du
944 traitement de la requête</description>
945 <syntax>LuaHookCheckUserID /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
946 <contextlist><context>server config</context><context>virtual host</context>
947 <context>directory</context><context>.htaccess</context>
949 <override>All</override>
950 <compatibility>Le troisième argument optionnel est disponible depuis la
951 version 2.3.15 du serveur HTTP Apache.</compatibility>
953 <note><title>Ordonnancement</title><p>Les arguments optionnels
954 "early" ou "late" permettent de contrôler le moment auquel ce script
955 s'exécute par rapport aux autres modules.</p></note>
960 <name>LuaHookTypeChecker</name>
961 <description>Fournit un point d'entrée pour la phase type_checker du
962 traitement de la requête</description>
963 <syntax>LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name</syntax>
964 <contextlist><context>server config</context><context>virtual host</context>
965 <context>directory</context><context>.htaccess</context>
967 <override>All</override>
968 <usage><p>...</p></usage>
972 <name>LuaHookAuthChecker</name>
973 <description>Fournit un point d'entrée pour la phase auth_checker du
974 traitement de la requête</description>
975 <syntax>LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
976 <contextlist><context>server config</context><context>virtual host</context>
977 <context>directory</context><context>.htaccess</context>
979 <override>All</override>
980 <compatibility>Le troisième argument optionnel est disponible depuis la
981 version 2.3.15 du serveur HTTP Apache.</compatibility>
983 <p>Invoque une fonction lua au cours de la phase auth_checker du
984 traitement de la requête. Cette directive peut s'utiliser pour
985 implémenter une vérification arbitraire de l'authentification et de
986 l'autorisation. Voici un exemple très simple :
988 <highlight language="lua">
991 -- fonction d'accroche authcheck fictive
992 -- Si la requête ne contient aucune donnée d'authentification, l'en-tête
993 -- de la réponse est défini et un code 401 est renvoyé afin de demander au
994 -- navigateur d'effectuer une authentification basique. Si la requête
995 -- comporte des données d'authentification, elles ne sont pas vraiment
996 -- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
997 -- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
998 -- accepte la requête.
999 function authcheck_hook(r)
1001 -- recherche des informations d'authentification
1002 auth = r.headers_in['Authorization']
1004 -- définition d'un utilisateur par défaut
1008 if r.user == nil then
1009 r:debug("authcheck: user is nil, returning 401")
1010 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1012 elseif r.user == "foo" then
1013 r:debug('user foo: OK')
1015 r:debug("authcheck: user='" .. r.user .. "'")
1016 r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1022 <note><title>Ordonnancement</title><p>Les arguments optionnels
1023 "early" ou "late" permettent de contrôler le moment auquel ce script
1024 s'exécute par rapport aux autres modules.</p></note>
1026 </directivesynopsis>
1029 <name>LuaHookAccessChecker</name>
1030 <description>Fournit un point d'entrée pour la phase access_checker du
1031 traitement de la requête</description>
1032 <syntax>LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late]</syntax>
1033 <contextlist><context>server config</context><context>virtual host</context>
1034 <context>directory</context><context>.htaccess</context>
1036 <override>All</override>
1037 <compatibility>Le troisième argument optionnel est disponible depuis la
1038 version 2.3.15 du serveur HTTP Apache.</compatibility>
1041 <p>Ajoute votre fonction d'accroche à la phase access_checker. Une
1042 fonction d'accroche access checker renvoie en général OK, DECLINED, ou
1044 <note><title>Ordonnancement</title><p>Les arguments optionnels
1045 "early" ou "late" permettent de contrôler le moment auquel ce script
1046 s'exécute par rapport aux autres modules.</p></note>
1048 </directivesynopsis>
1050 <name>LuaHookInsertFilter</name>
1051 <description>Fournit un point d'entrée pour la phase insert_filter du
1052 traitement de la requête</description>
1053 <syntax>LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name</syntax>
1054 <contextlist><context>server config</context><context>virtual host</context>
1055 <context>directory</context><context>.htaccess</context>
1057 <override>All</override>
1058 <usage><p>Non encore implémenté</p></usage>
1059 </directivesynopsis>
1062 <name>LuaInherit</name>
1063 <description>Contrôle la manière dont les sections de configuration
1064 parentes sont fusionnées dans les enfants</description>
1065 <syntax>LuaInherit none|parent-first|parent-last</syntax>
1066 <default>LuaInherit parent-first</default>
1067 <contextlist><context>server config</context><context>virtual host</context>
1068 <context>directory</context><context>.htaccess</context>
1070 <override>All</override>
1071 <compatibility>Versions 2.4.0 et supérieures</compatibility>
1072 <usage><p>Par défaut, si des directives LuaHook* se trouvent dans
1073 des sections de configuration Directory ou Location qui se
1074 chevauchent, les scripts
1075 définis dans les sections les plus spécifiques s'exécutent
1076 <em>après</em> ceux définis dans les sections plus génériques
1077 (LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
1078 en sorte que le contexte parent ne s'applique pas du tout.</p>
1080 <p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
1081 ignorer les directives LuaHook* situées dans les sections de
1082 configuration parentes.</p></usage>
1083 </directivesynopsis>
1086 <name>LuaQuickHandler</name>
1087 <description>Fournit un point d'entrée pour la gestion rapide du
1088 traitement de la requête</description>
1089 <syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
1090 <contextlist><context>server config</context><context>virtual host</context>
1092 <override>All</override>
1094 <note><title>Contexte</title><p>Cette directive ne peut être
1095 utilisée ni à l'intérieur d'une section <directive type="section"
1096 module="core">Directory</directive> ou <directive type="section"
1097 module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
1099 </directivesynopsis>
1102 <name>LuaAuthzProvider</name>
1103 <description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
1105 <syntax>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</syntax>
1106 <contextlist><context>server config</context> </contextlist>
1107 <compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
1110 <p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
1111 d'autorisation, elle peut être appelée via la directive <directive
1112 module="mod_authz_core">Require</directive> :</p>
1116 <highlight language="config">
1117 LuaRoot /usr/local/apache2/lua
1118 LuaAuthzProvider foo authz.lua authz_check_foo
1126 </directivesynopsis>