mod_lua.xml.fr revision 3cc904d50af0d158203499cdf8aed4acc5b024e4
<?xml version="1.0"?>
<!-- English Revision : 1420377 -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<modulesynopsis metafile="mod_lua.xml.meta">
<name>mod_lua</name>
<description>Fournit des points d'entrée Lua dans différentes parties du
traitement des requêtes httpd</description>
<status>Experimental</status>
<identifier>lua_module</identifier>
<compatibility>versions 2.3 et supérieures</compatibility>
<summary>
<p>Ce module permet d'ajouter au serveur des extensions sous forme de
scripts écrits dans le langage de programmation Lua.
<module>mod_lua</module> fournit de nombreuses extensions
(hooks) disponibles avec les modules natifs du serveur HTTP Apache,
comme les associations de requêtes à des fichiers, la génération de
réponses dynamiques, le contrôle d'accès, l'authentification et
l'autorisation.</p>
<p>Vous trouverez davantage d'informations à propos du langage de
programmation Lua sur <a href="http://www.lua.org/">le site web de
Lua</a>.</p>
<note><code>mod_lua</code> est encore au stade expérimental. Son mode
d'utilisation et son comportement pourront changer à tout moment jusqu'à
ce qu'il passe au stade stable, et ce même entre deux versions stables
2.4.x. N'oublez pas de consulter le fichier CHANGES avant toute mise à
jour.</note>
<note type="warning"><title>Avertissement</title>
<p>Ce module possède une grande capacité d'action sur le fonctrionnement
de httpd, ce qui lui confère une grande puissance, mais peut aussi
induire un risque de sécurité. Il est déconseillé d'utiliser ce module
sur un serveur partagé avec des utilisateurs auxquels vous ne pouvez pas
accorder une confiance absolue, car il peut permettre de modifier le
fonctionnement interne de httpd.</p>
</note>
</summary>
<section id="basicconf"><title>Configuration de base</title>
<p>La directive de base pour le chargement du module est</p>
<highlight language="config">
LoadModule lua_module modules/mod_lua.so
</highlight>
<p>
<code>mod_lua</code> fournit un gestionnaire nommé
<code>lua-script</code> qui peut être utilisé avec une directive
<code>AddHandler</code> :</p>
<highlight language="config">
AddHandler lua-script .lua
</highlight>
<p>
Ceci aura pour effet de faire traiter les requêtes pour les fichiers
dont l'extension est <code>.lua</code> par <code>mod_lua</code> en
invoquant cette fonction de <code>gestion</code> de fichier.
</p>
<p>Pour plus de détails, voir la directive
<directive>LuaMapHandler</directive>.
</p>
</section>
<section id="writinghandlers"><title>Ecrire des gestionnaires</title>
<p>Dans l'API du serveur HTTP Apache, un gestionnaire est une sorte de
point d'accroche (hook) spécifique responsable de la génération de la
réponse. <module>mod_proxy</module>, <module>mod_cgi</module> et
<module>mod_status</module> sont des exemples de modules comportant un
gestionnaire.</p>
<p><code>mod_lua</code> cherche toujours à invoquer une fonction Lua pour le
gestionnaire, plutôt que de simplement évaluer le corps d'un script dans
le style de CGI. Une fonction de gestionnaire se présente comme suit :</p>
<highlight language="lua">
-- exemple de gestionnaire
require "string"
--[[
Il s'agit du nom de méthode par défaut pour les gestionnaires Lua ;
voir les noms de fonctions optionnels dans la directive
LuaMapHandler pour choisir un point d'entrée différent.
--]]
function handle(r)
r:puts("Hello Lua World!\n")
if r.method == 'GET' then
for k, v in pairs( r:parseargs() ) do
r:puts( string.format("%s: %s\n", k, v) )
end
elseif r.method == 'POST' then
for k, v in pairs( r:parsebody() ) do
r:puts( string.format("%s: %s\n", k, v) )
end
else
r:puts("Unsupported HTTP method " .. r.method)
end
end
</highlight>
<p>
Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou
d'un formulaire dans un page au format texte.
</p>
<p>
Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs
gestionnaires (ou points d'entrée, ou filtres) dans le même script.
</p>
</section>
<section id="writingauthzproviders">
<title>Ecriture de fournisseurs d'autorisation</title>
<p><module>mod_authz_core</module> fournit une interface d'autorisation
de haut niveau bien plus facile à utiliser que dans les hooks
correspondants. Le premier argument de la directive <directive
module="mod_authz_core">Require</directive> permet de spécifier le
fournisseur d'autorisation à utiliser. Pour chaque directive <directive
module="mod_authz_core">Require</directive>,
<module>mod_authz_core</module> appellera le fournisseur d'autorisation
spécifié, le reste de la ligne constituant les paramètres. Le
fournisseur considéré va alors vérifier les autorisations et fournir le
résultat dans une valeur de retour.</p>
<p>En général, le fournisseur authz est appelé avant l'authentification.
S'il doit connaître le nom d'utilisateur authentifié (ou si
l'utilisateur est appelé à être authentifié), le fournisseur doit
déclancher le processus d'authentification et un deuxième appel du
fournisseur authz.</p>
<p>La fonction du fournisseur authz ci-dessous accepte deux arguments,
une adresse IP et un nom d'utilisateur. Elle autorise l'accès dans le
cas où la requête provient de l'adresse IP spécifiée, ou si
l'utilisateur authentifié correspond au second argument :</p>
<highlight language="lua">
require 'apache2'
function authz_check_foo(r, ip, user)
if r.useragent_ip == ip then
return apache2.AUTHZ_GRANTED
elseif r.user == nil then
return apache2.AUTHZ_DENIED_NO_USER
elseif r.user == user then
return apache2.AUTHZ_GRANTED
else
return apache2.AUTHZ_DENIED
end
end
</highlight>
<p>La configuration suivante enregistre cette fonction en tant que
fournisseur <code>foo</code>, et la configure por l'URL <code>/</code> :</p>
<highlight language="config">
LuaAuthzProvider foo authz_provider.lua authz_check_foo
<Location />
Require foo 10.1.2.3 john_doe
</Location>
</highlight>
</section>
<section id="writinghooks"><title>Ecriture de fonctions d'accroche
(hooks)</title>
<p>Les fonctions d'accroche déterminent la manière dont les modules (et
les scripts Lua) participent au traitement des requêtes. Chaque type
d'accroche proposé par le serveur a un rôle spécifique, comme
l'association de requêtes au système de fichiers, le contrôle d'accès,
ou la définition de types MIME : </p>
<table border="1" style="zebra">
<tr>
<th>Phase d'accroche</th>
<th>Directive mod_lua</th>
<th>Description</th>
</tr>
<tr>
<td>Gestionnaire rapide</td>
<td><directive module="mod_lua">LuaQuickHandler</directive></td>
<td>Il s'agit de la première accroche appelée lorsqu'une requête
a été associée à un serveur ou un serveur virtuel.</td>
</tr>
<tr>
<td>Phase de traduction</td>
<td><directive module="mod_lua">LuaHookTranslateName</directive></td>
<td>Cette phase traduit l'URI de la requête en nom de fichier
sur le système. Ce sont des modules comme
<module>mod_alias</module> et <module>mod_rewrite</module> qui
interviennent au cours de cette phase.</td>
</tr>
<tr>
<td>Choix du lieu de stockage de la ressource</td>
<td><directive module="mod_lua">LuaHookMapToStorage</directive></td>
<td>Cette phase définit le lieu de stockage de la ressource :
modules de mandat ou de mise en cache.</td>
</tr>
<tr>
<td>Autorisation d'accès</td>
<td><directive module="mod_lua">LuaHookAccessChecker</directive></td>
<td>Cette phase vérifie si un client a l'autorisation d'accès à
la ressource. Elle s'exécute avant l'authentification de
l'utisateur ; il faut donc être prudent.
</td>
</tr>
<tr>
<td>Vérification de l'identifiant utilisateur</td>
<td><directive module="mod_lua">LuaHookCheckUserID</directive></td>
<td>Cette phase vérifie l'identifiant de l'utilisateur ayant
fait l'objet d'une négociation.</td>
</tr>
<tr>
<td>Vérification de l'autorisation d'accès</td>
<td><directive module="mod_lua">LuaHookAuthChecker</directive>
ou
<directive module="mod_lua">LuaAuthzProvider</directive></td>
<td>Cette phase vérifie l'autorisation d'accès d'un utilisateur
en fonction des ses paramètres de connexion, comme
l'identifiant, le certificat, etc...
</td>
</tr>
<tr>
<td>Vérification du type de la ressource</td>
<td><directive module="mod_lua">LuaHookTypeChecker</directive></td>
<td>Cette phase assigne un type de contenu et un gestionnaire à
la ressource.</td>
</tr>
<tr>
<td>Derniers réglages</td>
<td><directive module="mod_lua">LuaHookFixups</directive></td>
<td>C'est la dernière phase avant l'activation des gestionnaires
de contenu. Toute modification de dernière minute à la requête
doit être effectuée ici.</td>
</tr>
<tr>
<td>Gestionnaire de contenu</td>
<td>fichiers fx. <code>.lua</code> ou directive <directive module="mod_lua">LuaMapHandler</directive></td>
<td>C'est durant cette phase que le contenu est traité. Les
fichiers sont lus, interprétés, certains sont exécutés, et le
résultat obtenu est envoyé au client.</td>
</tr>
<tr>
<td>Journalisation</td>
<td>aucune</td>
<td>Lorsqu'une requête a été traitée, plusieurs phases de
journalisation interviennent, et enregistrent leurs résultats
dans les fichiers d'erreur ou d'accès.</td>
</tr>
</table>
<p>Les fonctions d'accroche reçoivent l'objet de la requête comme seul
argument (sauf LuaAuthzProvider qui reçoit aussi des arguments en
provenance de la directive Require). Elles peuvent renvoyer une valeur,
selon la fonction, mais il s'agit en général d'un
code d'état HTTP ou des valeurs OK, DONE, ou DECLINED,
<highlight language="lua">
-- exemple d'accroche qui réécrit un URI en chemin du système de
fichiers.
require 'apache2'
function translate_name(r)
if r.uri == "/translate-name" then
return apache2.OK
end
-- on ne gère pas cette URL et on donne sa chance à un autre module
return apache2.DECLINED
end
</highlight>
<highlight language="lua">
--[[ exemple d'accroche qui réécrit un URI vers un autre URI. Il renvoie
un apache2.DECLINED pour permettre à un autre interpréteur d'URL de
travailler sur la substitution, y compris l'accroche translate_name
de base dont les tables de correspondances se basent sur DocumentRoot.
l'exécuter avant ou après mod_alias.
--]]
require 'apache2'
function translate_name(r)
if r.uri == "/translate-name" then
r.uri = "/find_me.txt"
return apache2.DECLINED
end
return apache2.DECLINED
end
</highlight>
</section>
<section id="datastructures"><title>Structures de données</title>
<dl>
<dt>request_rec</dt>
<dd>
<p>request_rec est considérée en tant que donnée utilisateur.
Elle possède une métatable qui vous permet d'accomplir des
choses intéressantes. Pour la plus grande partie, elle possède
les mêmes champs que la structure request_rec, la
plupart d'entre eux étant accessibles en lecture et écriture (le
contenu des champs de la table peut être modifié, mais les
champs eux-mêmes ne peuvent pas être établis en tant que tables
distinctes).</p>
<table border="1" style="zebra">
<tr>
<th><strong>Nom</strong></th>
<th><strong>Type Lua</strong></th>
<th><strong>Modifiable</strong></th>
<th><strong>Description</strong></th>
</tr>
<tr>
<td><code>allowoverrides</code></td>
<td>string</td>
<td>non</td>
<td>L'option AllowOverride s'applique à la requête courante.</td>
</tr>
<tr>
<td><code>ap_auth_type</code></td>
<td>string</td>
<td>non</td>
<td>Ce champ contient le type d'authentification effectuée
(par exemple <code>basic</code>)</td>
</tr>
<tr>
<td><code>args</code></td>
<td>string</td>
<td>oui</td>
<td>La chaîne de paramètres de la requête (par exemple
<code>foo=bar&name=johnsmith</code>)</td>
</tr>
<tr>
<td><code>assbackwards</code></td>
<td>boolean</td>
<td>non</td>
(par exemple <code>GET /foo</code> (sans champs d'en-tête) )</td>
</tr>
<tr>
<td><code>auth_name</code></td>
<td>string</td>
<td>non</td>
<td>La chaîne d'identification utilisée pour la vérification
de l'autorisation d'accès (si elle est disponible).</td>
</tr>
<tr>
<td><code>banner</code></td>
<td>string</td>
<td>non</td>
<td>La bannière du serveur, par exemple <code>Apache HTTP
</tr>
<tr>
<td><code>basic_auth_pw</code></td>
<td>string</td>
<td>non</td>
<td>Le mot de passe pour l'authentification de base envoyé
avec la requête, s'il existe</td>
</tr>
<tr>
<td><code>canonical_filename</code></td>
<td>string</td>
<td>non</td>
<td>Le nom de fichier canonique de la requête</td>
</tr>
<tr>
<td><code>content_encoding</code></td>
<td>string</td>
<td>non</td>
<td>Le type de codage du contenu de la requête courante</td>
</tr>
<tr>
<td><code>content_type</code></td>
<td>string</td>
<td>oui</td>
<td>Le type de contenu de la requête courante, tel qu'il a été
déterminé au cours de la phase type_check (par exemple
</tr>
<tr>
<td><code>context_prefix</code></td>
<td>string</td>
<td>non</td>
<td></td>
</tr>
<tr>
<td><code>context_document_root</code></td>
<td>string</td>
<td>non</td>
<td></td>
</tr>
<tr>
<td><code>document_root</code></td>
<td>string</td>
<td>non</td>
<td>La racine des documents du serveur</td>
</tr>
<tr>
<td><code>err_headers_out</code></td>
<td>table</td>
<td>non</td>
<td>L'en-tête MIME de l'environnement pour la réponse, écrit
même en cas d'erreur et conservé pendant les redirections
internes</td>
</tr>
<tr>
<td><code>filename</code></td>
<td>string</td>
<td>oui</td>
<td>Le nom de fichier correspondant à la requête, par exemple
phases translate-name ou map-to-storage du traitement de la
requête pour permettre au gestionnaire par défaut (ou aux
gestionnaires de script) de servir une version du fichier
autre que celle demandée.</td>
</tr>
<tr>
<td><code>handler</code></td>
<td>string</td>
<td>oui</td>
doit traiter la requête, par exemple <code>lua-script</code>
si elle doit être traitée par mod_lua. Cette valeur est en
général définie via les directives <directive
module="mod_mime">AddHandler</directive> ou <directive
module="core">SetHandler</directive>, mais peut aussi l'être
via mod_lua pour permettre à un autre gestionnaire de traiter
une requête spécifique qui ne serait pas traitée par défaut
par ce dernier.
</td>
</tr>
<tr>
<td><code>headers_in</code></td>
<td>table</td>
<td>oui</td>
<td>Les en-têtes MIME de l'environnement de la requête. Il
s'agit des en-têtes comme <code>Host, User-Agent,
Referer</code>, etc...</td>
</tr>
<tr>
<td><code>headers_out</code></td>
<td>table</td>
<td>oui</td>
<td>Les en-têtes MIME de l'environnement de la réponse.</td>
</tr>
<tr>
<td><code>hostname</code></td>
<td>string</td>
<td>non</td>
<td>Le nom d'hôte, tel que défini par l'en-tête
<code>Host:</code> ou par un URI complet.</td>
</tr>
<tr>
<td><code>is_https</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si la requête à été faite via HTTPS</td>
</tr>
<tr>
<td><code>is_initial_req</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si la requête courante est la requête initiale ou
une sous-requête.</td>
</tr>
<tr>
<td><code>limit_req_body</code></td>
<td>number</td>
<td>non</td>
<td>La taille maximale du corps de la requête, ou 0 si aucune
limite.</td>
</tr>
<tr>
<td><code>log_id</code></td>
<td>string</td>
<td>non</td>
<td>L'identifiant de la requête dans les journaux d'accès ou
d'erreur.</td>
</tr>
<tr>
<td><code>method</code></td>
<td>string</td>
<td>non</td>
<td>La méthode de la requête, par exemple <code>GET</code> ou
<code>POST</code>.</td>
</tr>
<tr>
<td><code>notes</code></td>
<td>table</td>
<td>oui</td>
<td>Une liste de notes qui peuvent être transmises d'un module
à l'autre.</td>
</tr>
<tr>
<td><code>options</code></td>
<td>string</td>
<td>non</td>
<td>La valeur de la directive Options pour la requête
courante.</td>
</tr>
<tr>
<td><code>path_info</code></td>
<td>string</td>
<td>non</td>
<td>La valeur de PATH_INFO extraite de la requête.</td>
</tr>
<tr>
<td><code>port</code></td>
<td>number</td>
<td>non</td>
<td>Le port du serveur utilisé par la requête.</td>
</tr>
<tr>
<td><code>protocol</code></td>
<td>string</td>
<td>non</td>
</tr>
<tr>
<td><code>proxyreq</code></td>
<td>string</td>
<td>oui</td>
<td>Indique s'il s'agit d'une requête mandatée ou non. Cette
valeur est en général définie au cours de la phase
</tr>
<tr>
<td><code>range</code></td>
<td>string</td>
<td>non</td>
<td>Le contenu de l'en-tête <code>Range:</code>.</td>
</tr>
<tr>
<td><code>remaining</code></td>
<td>number</td>
<td>non</td>
<td>Le nombre d'octets du corps de la requête restant à lire.</td>
</tr>
<tr>
<td><code>server_built</code></td>
<td>string</td>
<td>non</td>
<td>La date de compilation du serveur.</td>
</tr>
<tr>
<td><code>server_name</code></td>
<td>string</td>
<td>non</td>
<td>Le nom du serveur pour cette requête.</td>
</tr>
<tr>
<td><code>some_auth_required</code></td>
<td>boolean</td>
<td>non</td>
<td>Indique si une autorisation est/était requise pour cette
requête.</td>
</tr>
<tr>
<td><code>subprocess_env</code></td>
<td>table</td>
<td>oui</td>
<td>Le jeu de variables d'environnement pour cette requête.</td>
</tr>
<tr>
<td><code>started</code></td>
<td>number</td>
<td>non</td>
<td>Le moment où le serveur a été (re)démarré, en secondes
depuis epoch (1er janvier 1970)</td>
</tr>
<tr>
<td><code>status</code></td>
<td>number</td>
<td>oui</td>
<td>Le code de retour (courant) pour cette requête, par
exemple <code>200</code> ou <code>404</code>.</td>
</tr>
<tr>
<td><code>the_request</code></td>
<td>string</td>
<td>non</td>
<td>La chaîne de la requête telle qu'elle a été envoyée par le
</tr>
<tr>
<td><code>unparsed_uri</code></td>
<td>string</td>
<td>non</td>
<td>La partie URI non interprétée de la requête</td>
</tr>
<tr>
<td><code>uri</code></td>
<td>string</td>
<td>oui</td>
<td>L'URI après interprétation par httpd</td>
</tr>
<tr>
<td><code>user</code></td>
<td>string</td>
<td>oui</td>
<td>Si une authentification a été effectuée, nom de
l'utilisateur authentifié.</td>
</tr>
<tr>
<td><code>useragent_ip</code></td>
<td>string</td>
<td>non</td>
<td>L'adresse IP de l'agent qui a envoyé la requête</td>
</tr>
</table>
<p>La structure request_rec possède (au minimum) les méthodes
suivantes :</p>
<highlight language="lua">
r:flush() -- vide le tampon de sortie
</highlight>
<highlight language="lua">
r:addoutputfilter(name|function) -- ajoute un filtre en sortie
</highlight>
<highlight language="lua">
r:sendfile(filename) -- envoie un fichier entier au client en
utilisant sendfile s'il est supporté par la plateforme
</highlight>
<highlight language="lua">
r:parseargs() -- renvoie une table Lua contenant la chaîne
d'arguments de la requête
</highlight>
<highlight language="lua">
r:parsebody()([sizeLimit]) -- interprète le corps de la requête
en tant que POST et renvoie une table lua. Un nombre optionnel
peut être fourni pour spécifier le nombre maximal d'octets à
interpréter. La valeur par défaut est 8192.
</highlight>
<highlight language="lua">
r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
</highlight>
<highlight language="lua">
r:write("une simple chaîne") -- affichage dans le
corps de la réponse
</highlight>
<highlight language="lua">
r:escape_html("<html>test</html>") -- Echappe le
code HTML et renvoie le résultat
</highlight>
<highlight language="lua">
r:base64_encode(string) -- Encode une chaîne à l'aide du
standard de codage Base64.
</highlight>
<highlight language="lua">
r:base64_decode(string) -- Décode une chaîne codée en Base64.
</highlight>
<highlight language="lua">
r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne
en mode binaire (binary safe).
</highlight>
<highlight language="lua">
r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne
en mode binaire (binary safe).
</highlight>
<highlight language="lua">
r:escape(string) -- Echappe une chaîne de type URL.
</highlight>
<highlight language="lua">
r:unescape(string) -- Déséchappe une chaîne de type URL.
</highlight>
<highlight language="lua">
r:banner() -- Renvoie la bannière du serveur courant.
</highlight>
<highlight language="lua">
r:port() -- Renvoie le port du serveur courant utilisé pour la
requête.
</highlight>
<highlight language="lua">
r:mpm_query(number) -- Interroge le serveur à propos de son
module MPM via la requête ap_mpm_query.
</highlight>
<highlight language="lua">
r:expr(string) -- Evalue une chaîne de type <a
href="/expr.html">expr</a>.
</highlight>
<highlight language="lua">
r:scoreboard_process(a) -- Interroge le serveur à propos du
processus à la position <code>a</code>.
</highlight>
<highlight language="lua">
r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
thread <code>b</code>, dans le processus <code>a</code>.
</highlight>
<highlight language="lua">
r:started() -- Renvoie l'heure du dernier (re)démarrage du
serveur.
</highlight>
<highlight language="lua">
r:clock() -- Renvoie l'heure courante avec une précision d'une
microseconde.
</highlight>
<highlight language="lua">
r:requestbody(filename) -- Lit et renvoie le corps d'une requête. Si
'filename' est spécifié, le corps de requête n'est pas renvoyé, mais
sauvegardé dans le fichier correspondant.
</highlight>
<highlight language="lua">
r:add_input_filter(filter_name) -- Ajoute le filtre en entrée
'filter_name'.
</highlight>
<highlight language="lua">
r:module_info(module_name) -- Interroge le serveur à propos d'un
module.
</highlight>
<highlight language="lua">
r:loaded_modules() -- Renvoie une liste des modules chargés par
httpd.
</highlight>
<highlight language="lua">
r:runtime_dir_relative(filename) -- Génère le nom d'un fichier run-time
(par exemple la mémoire partagée "file") relativement au répertoire de
run-time.
</highlight>
<highlight language="lua">
r:server_info() -- Renvoie une table contenant des informations
à propos du serveur, comme le nom de l'exécutable httpd, le
module mpm utilisé, etc...
</highlight>
<highlight language="lua">
r:set_document_root(file_path) -- Définit la racine des
documents pour la requête à file_path.
</highlight>
<highlight language="lua">
r:add_version_component(component_string) -- Ajoute un élément à
la bannière du serveur.
</highlight>
<highlight language="lua">
r:set_context_info(prefix, docroot) -- Définit le préfixe et la
racine des documents du contexte pour une requête.
</highlight>
<highlight language="lua">
r:os_escape_path(file_path) -- Convertit un chemin du système de
fichiers en URL indépendamment du système d'exploitation.
</highlight>
<highlight language="lua">
r:escape_logitem(string) -- Echappe une chaîne pour
journalisation.
</highlight>
<highlight language="lua">
r:strcmp_match(string, pattern) -- Vérifie si 'string' correspond à
'pattern' via la fonction strcmp_match (GLOBs). Par exemple, est-ce que
'www.example.com' correspond à '*.example.com' ?
</highlight>
<highlight language="lua">
r:set_keepalive() -- Définit l'état de persistance d'une
requête. Renvoie true dans la mesure du possible, false dans le
cas contraire.
</highlight>
<highlight language="lua">
r:make_etag() -- Génère et renvoie le etag pour la requête
courante.
</highlight>
<highlight language="lua">
r:send_interim_response(clear) -- Renvoie une réponse d'intérim (1xx) au
client. Si 'clear' est vrai, les en-têtes disponibles seront envoyés et
effacés.
</highlight>
<highlight language="lua">
r:custom_response(status_code, string) -- Génère et définit une réponse
personnalisée pour un code d'état particulier. Le fonctionnement est
très proche de celui de la directive ErrorDocument.
</highlight>
<highlight language="lua">
r:exists_config_define(string) -- Vérifie si une définition de
configuration existe.
</highlight>
<highlight language="lua">
r:state_query(string) -- Interroge le serveur à propos de son
état.
</highlight>
<highlight language="lua">
r:stat(filename) -- Exécute stat() sur un fichier, et renvoie
une table contenant des informations à propos de ce fichier.
</highlight>
<highlight language="lua">
r:regex(string, pattern) -- Exécute une recherche à base
d'expression rationnelle sur une chaîne, et renvoie les
éventuelles correspondances trouvées.
</highlight>
<highlight language="lua">
r:sleep(secondes) -- Interrompt l'exécution du script pendant le
nombre de secondes spécifié.
</highlight>
</dd>
</dl>
</section>
<section id="logging"><title>Fonctions de journalisation</title>
<highlight language="lua">
-- exemples de messages de journalisation
r:trace1("Ceci est un message de journalisation de niveau
trace") -- les niveaux valides vont de trace1 à trace8 <br />
r:debug("Ceci est un message de journalisation de niveau debug")<br />
r:info("Ceci est un message de journalisation de niveau info")<br />
r:notice("Ceci est un message de journalisation de niveau notice")<br />
r:warn("Ceci est un message de journalisation de niveau warn")<br />
r:err("Ceci est un message de journalisation de niveau err")<br />
r:alert("Ceci est un message de journalisation de niveau alert")<br />
r:crit("Ceci est un message de journalisation de niveau crit")<br />
r:emerg("Ceci est un message de journalisation de niveau emerg")<br />
</highlight>
</section>
<section id="apache2"><title>Paquet apache2</title>
<p>Le paquet nommé <code>apache2</code> est fourni avec (au minimum) le
contenu suivant :</p>
<dl>
<dd>Constante interne OK. Les gestionnaires renverront cette valeur
s'ils ont traité la requête.</dd>
<dd>Constante interne DECLINED. Les gestionnaires renverront cette
valeur s'ils n'ont pas l'intention de traiter la requête.</dd>
<dd>Constante interne DONE.</dd>
<dd>Chaîne contenant la version du serveur HTTP Apache</dd>
<dd>Code d'état HTTP</dd>
<dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
<dd>Constantes internes utilisées par <module>mod_proxy</module></dd>
<dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
<dd>constantes internes utilisées par <module>mod_authz_core</module></dd>
</dl>
<p>Les autres codes d'état HTTP ne sont pas encore implémentés.</p>
</section>
<section id="modifying_buckets">
<title>Modification de contenu avec les filtres lua</title>
<p>
Les fonctions de filtrage implémentées via les directives <directive
module="mod_lua">LuaInputFilter</directive> ou <directive
module="mod_lua">LuaOutputFilter</directive> sont conçues comme des
fonctions de 3ème phase non blocantes utilisant des sous-routines
pour suspendre et reprendre l'exécution d'une fonction lorsque des
paquets de données sont envoyés à la chaîne de filtrage. La
structure de base d'une telle fonction est :
</p>
<highlight language="lua">
function filter(r)
-- Nous indiquons tout d'abord que nous sommes prêts à recevoir des
-- blocs de données.
-- Avant ceci, nous pouvons définir notre environnement, tester
-- certaines conditions, et, si nous le jugeons nécessaire, refuser le
-- filtrage d'une requête :
if something_bad then
return -- Le filtrage est sauté
end
-- Sans se préoccuper des données que nous devons éventuellement ajouter, un arrêt est réalisé ici.
-- Noter que les filtres de sortie sont les seuls capables d'ajouter des éléments au début des données.
-- Les filtres en entrée peuvent ajouter des éléments à la fin des données au stade final.
coroutine.yield([optional header to be prepended to the content])
-- Après cet arrêt, nous allons recevoir d'autres blocs de données, un par un ;
-- nous pouvons les traiter comme il nous plaît et procéder à la réponse.
-- Ces blocs sont conservés dans la variable globale 'bucket', nous réalisons donc
-- une boucle pour vérifier que 'bucket' n'est pas vide :
while bucket ~= nil do
local output = mangle(bucket) -- Do some stuff to the content
coroutine.yield(output) -- Return our new content to the filter chain
end
-- Une fois les blocs de données épuisés, 'bucket' est positionné à une valeur vide ('nil'),
-- ce qui va nous faire sortir de cette boucle et nous amener à l'étape suivante.
-- On peut ajouter ce qu'on veut à la fin des données à cette étape, qui constitue le dernier
-- arrêt. Les filtres d'entrée comme de sortie peuvent servir à ajouter des éléments à la fin
-- des données à cette étape.
coroutine.yield([optional footer to be appended to the content])
end
</highlight>
</section>
<directivesynopsis>
<name>LuaRoot</name>
<description>Spécifie le chemin de base pour la résolution des chemins
relatifs dans les directives de mod_lua</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Cette directive permet de spécifier le chemin de base qui sera
utilisé pour évaluer tous les chemins relatifs dans mod_lua. En
l'absence de cette directive, les chemins relatifs sont résolus par
rapport au répertoire de travail courant, ce qui ne sera pas
toujours approprié pour un serveur.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaScope</name>
<description>Une valeur parmi once, request, conn, thread -- la valeur
par défaut est once</description>
<syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>
<default>LuaScope once</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Cette directive permet de spécifier la durée de vie de
l'interpréteur Lua qui sera utilisé dans ce "répertoire". La valeur
par défaut est "once".</p>
<dl>
<dt>once:</dt> <dd>utilise l'interpréteur une fois.</dd>
<dt>request:</dt> <dd>utilise l'interpréteur pour traiter tout ce
qui est basé sur le même fichier dans la requête, et qui se trouve
aussi dans la portée de la requête.</dd>
<dt>conn:</dt> <dd>idem request, mais attaché à connection_rec</dd>
<dt>thread:</dt> <dd>Utilise l'interpréteur pendant toute la durée
de vie du thread qui traite la requête (disponible seulement avec
les MPMs threadés).</dd>
<dt>server:</dt> <dd>Le comportement est ici différent, car la
portée du serveur présente une durée de vie assez longue, et
plusieurs threads vont partager le même server_rec. Pour gérer tout
ceci, les états lua du serveur sont stockés dans une liste de ressources
apr. Les arguments <code>min</code> et <code>max</code> permettent
de spécifier les nombres minimaux et maximaux d'états lua à stocker
dans la liste.</dd>
</dl>
<p>En général, les portées <code>thread</code> et <code>server</code>
sont 2 à 3 fois plus rapides que les autres, car elles n'ont pas besoin
de régénérer de nouveaux états Lua à chaque requête (comme c'est le
cas avec le MPM event, où même les connexions persistantes utilisent un
nouveau thread pour chaque requête). Si vous pensez que vos scripts
n'auront pas de problème s'il réutilisent un état, alors les portées
<code>thread</code> ou <code>server</code> doivent être utilisées car
elles présenteront de meilleures performances. Alors que la portée
<code>thread</code> fournira les réponses les plus rapides, la portée
<code>server</code> utilisera moins de mémoire car les états sont
rassemblés dans des jeux, permettant par exemple à 1000 threads de
partager 100 états Lua, ne nécessitant ainsi que 10% de la mémoire
requise par la portée <code>thread</code>.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaMapHandler</name>
<description>Met en correspondance un chemin avec un gestionnaire lua</description>
[nom-fonction]</syntax>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Cette directive permet de faire correspondre un modèle d'uri avec
une fonction de gestionnaire située dans un fichier spécifique. Elle
utilise les expressions rationnelles PCRE pour mettre en
correspondance l'uri, et supporte les groupes de correspondance
d'interpolation dans le chemin du fichier et le nom de la fonction.
Prenez garde aux problèmes de sécurité en écrivant vos expressions
rationnelles.</p>
<example><title>Exemples :</title>
<highlight language="config">
LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
</highlight>
</example>
<p>Cette directive va faire correspondre des uri comme
fonction de gestionnaire handle_show au niveau de la vm lua
après chargement de ce fichier.</p>
<highlight language="config">
LuaMapHandler /bingo /scripts/wombat.lua
</highlight>
<p>Cette directive invoquera la fonction "handle" qui est la
valeur par défaut si aucun nom de fonction spécifique n'est
spécifié.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaPackagePath</name>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage><p>Cette directive permet d'ajouter un chemin à la liste des
chemins de recherche du module lua. Elle suit les mêmes conventions
que lua. Ceci modifie le package.path dans les vms lua.</p>
<example><title>Exemples :</title>
<highlight language="config">
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaPackageCPath</name>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Cette directive permet d'ajouter un chemin à la liste des chemins
de recherche des bibliothèques partagées de lua. Ceci modifie le
package.cpath dans les vms lua.</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaCodeCache</name>
<description>Configure le cache de code compilé.</description>
<syntax>LuaCodeCache stat|forever|never</syntax>
<default>LuaCodeCache stat</default>
<contextlist>
<context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage><p>
Cette directive permet de définir le comportement du cache de code
en mémoire. La valeur par défaut est stat ; dans ce cas, le script
du niveau le plus haut (et pas les scripts inclus) est vérifié à
chaque fois que ce fichier est nécessaire, et est rechargé si la
date de modification est plus récente que celle du script déjà
chargé. Les autres valeurs permettent respectivement de garder le
fichier en cache perpétuellement (forever - jamais vérifié ni
remplacé), ou de ne jamais le mettre en cache (never).</p>
<p>En général, les valeurs stat et forever sont utilisées pour un
serveur en production, et les valeurs stat ou never pour un serveur
en développement.</p>
<example><title>Exemples :</title>
<highlight language="config">
LuaCodeCache stat
LuaCodeCache forever
LuaCodeCache never
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookTranslateName</name>
<description>Fournit un point d'entrée à la phase du nom de
traduction du traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
</contextlist>
<override>All</override>
<compatibility>Le troisième argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</compatibility>
<usage><p>
Cette directive permet d'ajouter un point d'entrée (à
APR_HOOK_MIDDLE) à la phase du nom de traduction du traitement de la
requête. La fonction hook accepte un seul argument, le request_rec,
et doit renvoyer un code d'état qui est soit un code d'erreur HTTP,
ou une constante définie dans le module apache2 : apache2.OK,
<p>Pour ceux qui ne sont pas familiers avec les points d'entrée
(hook), en gros, chaque hook sera invoqué jusqu'à ce que l'un
d'entre eux renvoie apache2.OK. Si un hook n'effectuer pas la
traduction, il doit juste renvoyer apache2.DECLINED. Si le
traitement de la requête doit être interrompu, la valeur renvoyée
doit être apache2.DONE.</p>
<p>Exemple :</p>
<highlight language="config">
</highlight>
<highlight language="lua">
require "apache2"
function silly_mapper(r)
if r.uri == "/" then
return apache2.OK
else
return apache2.DECLINED
end
end
</highlight>
<note><title>Contexte</title><p>Cette directive ne peut être
utilisée ni à l'intérieur d'une section <directive type="section"
module="core">Directory</directive> ou <directive type="section"
module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
<note><title>Ordonnancement</title><p>Les arguments optionnels
"early" ou "late" permettent de contrôler le moment auquel ce script
s'exécute par rapport aux autres modules.</p></note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookFixups</name>
<description>Fournit un point d'entrée pour la phase de correction du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>
Idem LuaHookTranslateName, mais s'exécute durant la phase de
correction.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookMapToStorage</name>
<description>Fournit un point d'entrée pour la phase map_to_storage du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Identique à la directive
<directive>LuaHookTranslateName</directive>, mais s'exécute à la
phase map-to-storage du traitement de la requête. Les modules comme
mod_cache agissent pendant cette phase, ce qui permet de présenter
un exemple intéressant de ce que l'on peut faire ici :</p>
<highlight language="config">
</highlight>
<highlight language="lua">
require"apache2"
cached_files = {}
function read_file(filename)
local input = io.open(filename, "r")
if input then
local data = input:read("*a")
cached_files[filename] = data
file = cached_files[filename]
input:close()
end
return cached_files[filename]
end
function check_cache(r)
if r.filename:match("%.png$") then -- Only match PNG files
local file = cached_files[r.filename] -- Check cache entries
if not file then
file = read_file(r.filename) -- Read file into cache
end
if file then -- If file exists, write it out
r.status = 200
r:write(file)
r:info(("Sent %s to client from cache"):format(r.filename))
return apache2.DONE -- skip default handler for PNG files
end
end
return apache2.DECLINED -- If we had nothing to do, let others serve this.
end
</highlight>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookCheckUserID</name>
<description>Fournit un point d'entrée pour la phase check_user_id du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>Le troisième argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</compatibility>
<usage><p>...</p>
<note><title>Ordonnancement</title><p>Les arguments optionnels
"early" ou "late" permettent de contrôler le moment auquel ce script
s'exécute par rapport aux autres modules.</p></note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookTypeChecker</name>
<description>Fournit un point d'entrée pour la phase type_checker du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage><p>...</p></usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookAuthChecker</name>
<description>Fournit un point d'entrée pour la phase auth_checker du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>Le troisième argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</compatibility>
<usage>
<p>Invoque une fonction lua au cours de la phase auth_checker du
traitement de la requête. Cette directive peut s'utiliser pour
implémenter une vérification arbitraire de l'authentification et de
l'autorisation. Voici un exemple très simple :
</p>
<highlight language="lua">
require 'apache2'
-- fonction d'accroche authcheck fictive
-- Si la requête ne contient aucune donnée d'authentification, l'en-tête
-- de la réponse est défini et un code 401 est renvoyé afin de demander au
-- navigateur d'effectuer une authentification basique. Si la requête
-- comporte des données d'authentification, elles ne sont pas vraiment
-- consultées, mais on admet la prise en compte de l'utilisateur 'foo' et
-- on la valide. On vérifie ensuite si l'utilisateur est bien 'foo' et on
-- accepte la requête.
function authcheck_hook(r)
-- recherche des informations d'authentification
auth = r.headers_in['Authorization']
if auth ~= nil then
-- définition d'un utilisateur par défaut
r.user = 'foo'
end
if r.user == nil then
r:debug("authcheck: user is nil, returning 401")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return 401
elseif r.user == "foo" then
r:debug('user foo: OK')
else
r:debug("authcheck: user='" .. r.user .. "'")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return 401
end
return apache2.OK
end
</highlight>
<note><title>Ordonnancement</title><p>Les arguments optionnels
"early" ou "late" permettent de contrôler le moment auquel ce script
s'exécute par rapport aux autres modules.</p></note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookAccessChecker</name>
<description>Fournit un point d'entrée pour la phase access_checker du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>Le troisième argument optionnel est disponible depuis la
version 2.3.15 du serveur HTTP Apache.</compatibility>
<usage>
<p>Ajoute votre fonction d'accroche à la phase access_checker. Une
fonction d'accroche access checker renvoie en général OK, DECLINED, ou
HTTP_FORBIDDEN.</p>
<note><title>Ordonnancement</title><p>Les arguments optionnels
"early" ou "late" permettent de contrôler le moment auquel ce script
s'exécute par rapport aux autres modules.</p></note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaHookInsertFilter</name>
<description>Fournit un point d'entrée pour la phase insert_filter du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage><p>Non encore implémenté</p></usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaInherit</name>
<description>Contrôle la manière dont les sections de configuration
parentes sont fusionnées dans les enfants</description>
<syntax>LuaInherit none|parent-first|parent-last</syntax>
<default>LuaInherit parent-first</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<compatibility>Versions 2.4.0 et supérieures</compatibility>
<usage><p>Par défaut, si des directives LuaHook* se trouvent dans
des sections de configuration Directory ou Location qui se
chevauchent, les scripts
définis dans les sections les plus spécifiques s'exécutent
<em>après</em> ceux définis dans les sections plus génériques
(LuaInherit parent-first). Vous pouvez inverser cet ordre, ou faire
en sorte que le contexte parent ne s'applique pas du tout.</p>
<p>Jusqu'aux versions 2.3.x, le comportement par défaut consistait à
ignorer les directives LuaHook* situées dans les sections de
configuration parentes.</p></usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaQuickHandler</name>
<description>Fournit un point d'entrée pour la gestion rapide du
traitement de la requête</description>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
<usage>
<p>Cette phase s'exécute juste après l'attribution de la requête à
un serveur virtuel, et permet d'effectuer certains traitements avant
le déroulement des autres phases, ou de servir une requête sans
avoir à la traduire, l'associer à un espace de stockage, etc...
Comme cette phase s'exécute avant toute autre, les directives telles
que <directive type="section" module="core">Location</directive> ou
<directive type="section" module="core">Directory</directive> ne
sont pas encore prises en compte, car Les URI n'ont pas encore été
entièrement interprétés.
</p>
<note><title>Contexte</title><p>Cette directive ne peut être
utilisée ni à l'intérieur d'une section <directive type="section"
module="core">Directory</directive> ou <directive type="section"
module="core">Files</directive>, ni dans un fichier htaccess.</p></note>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>LuaAuthzProvider</name>
<description>Branche une fonction fournisseur d'autorisation dans <module>mod_authz_core</module>
</description>
<contextlist><context>server config</context> </contextlist>
<compatibility>Disponible depuis la version 2.4.3 du serveur HTTP Apache</compatibility>
<usage>
<p>Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
d'autorisation, elle peut être appelée via la directive <directive
module="mod_authz_core">Require</directive> :</p>
<highlight language="config">
LuaAuthzProvider foo authz.lua authz_check_foo
<Location />
Require foo johndoe
</Location>
</highlight>
<highlight language="lua">
require "apache2"
function authz_check_foo(r, who)
if r.user ~= who then return apache2.AUTHZ_DENIED
return apache2.AUTHZ_GRANTED
end
</highlight>
</usage>
</directivesynopsis>
</modulesynopsis>