<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
-<!-- English Revision: 1477001:1493935 (outdated) -->
+<!-- English Revision : 1493935 -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->
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>
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>
<highlight language="lua">
-<strong>example.lua</strong>
+<strong>example.lua</strong><br/>
-- exemple de gestionnaire
require "string"
--]]
function handle(r)
r.content_type = "text/plain"
- r:puts("Hello Lua World!\n")
if r.method == 'GET' then
+ r:puts("Hello Lua World!\n")
for k, v in pairs( r:parseargs() ) do
r:puts( string.format("%s: %s\n", k, v) )
- end
+ end
elseif r.method == 'POST' then
+ r:puts("Hello Lua World!\n")
for k, v in pairs( r:parsebody() ) do
r:puts( string.format("%s: %s\n", k, v) )
end
-
else
+ elseif r.method == 'PUT' then
+-- message d'erreur personnalisé
r:puts("Unsupported HTTP method " .. r.method)
+ r.status = 405
+ return apache2.ok
+ else
+-- message d'erreur ErrorDocument
+ return 501
end
+ return apache2.OK
end
</highlight>
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. Il existe aussi des accroches à usage
-général qui s'exécutent simplement à des moments opportuns du cycle
-de vie de la requête.</p>
-
-<p>Les fonctions d'accroche acceptent l'objet de la requête comme seul
-et unique argument. Elles peuvent renvoyer une valeur, selon la
-fonction, mais il s'agit en général d'un
+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 :
+ physique, en cache ou externe/mandaté. Elle est assurée par les
+ 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,
-que vous pouvez écrire dans lua sous la forme <code>apache2.OK</code>,
+que vous pouvez écrire dans Lua sous la forme <code>apache2.OK</code>,
<code>apache2.DONE</code>, ou <code>apache2.DECLINED</code>.</p>
+
<highlight language="lua">
-<strong>translate_name.lua</strong>
+<strong>translate_name.lua</strong><br/>
-- exemple d'accroche qui réécrit un URI en chemin du système de
fichiers.
end
</highlight>
+
<highlight language="lua">
-<strong>translate_name2.lua</strong>
+<strong>translate_name2.lua</strong><br/>
--[[ 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.
- Note: actuellement, il est impossible de prévoir si cette action
- s'exécute avant ou après mod_alias.
+ Note: utilisez le drapeau early/late de la directive pour
+ l'exécuter avant ou après mod_alias.
--]]
require 'apache2'
<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 (voir httpd.h en
- attendant que cette documentation soit plus complète), la
+ 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">
+ <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>
+ <td>contient true s'il s'agit d'une requête de style HTTP/0.9
+ (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
+ Server/2.4.3 openssl/0.9.8c</code></td>
+ </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
+ <code>image/gif</code> ou <code>text/html</code>)</td>
</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
+ /www/example.com/foo.txt. Il peut être modifié au cours des
+ 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>
+ <td>Le nom du <a href="../handler.html">gestionnaire</a> qui
+ 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><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>
+ <td>Le protocole utilisé, par exemple <code>HTTP/1.1</code></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
+ post_read_request/translate_name du traitement de la requête.</td>
</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
+ client, par exemple <code>GET /foo/bar HTTP/1.1</code>.</td>
</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>
+ </dd>
+ </dl>
+</section>
+<section id="functions"><title>Méthodes de l'objet request_rec</title>
- <p>La structure request_rec possède (au minimum) les méthodes
- suivantes :</p>
+<p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
- <highlight language="lua">
- r:addoutputfilter(name|function) -- ajoute un filtre en sortie
- </highlight>
+<highlight language="lua">
+r:flush() -- vide le tampon de sortie
+ -- Renvoie true si le vidage a été effectué avec succès,
+ false dans le cas contraire.
+
+while nous_avons_des_données_à_envoyer do
+ r:puts("Bla bla bla\n") -- envoi des données à envoyer vers le tampon
+ r:flush() -- vidage du tampon (envoi au client)
+ r:sleep(0.5) -- mise en attente et bouclage
+end
+</highlight>
- <highlight language="lua">
- r:parseargs() -- renvoie deux tables : une table standard de couples
- clé/valeur pour les données GET simples, et une autre pour les données
- multivaluées (par exemple foo=1&foo=2&foo=3) :
+<highlight language="lua">
+r:addoutputfilter(name|function) -- ajoute un filtre en sortie
- local GET, GETMULTI = r:parseargs()
- r:puts("Votre nom est : " .. GET['name'] or "Unknown")
- </highlight>
+r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
+</highlight>
- <highlight language="lua">
- r:parsebody([sizeLimit]) -- interprète le corps de la requête
- en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
- peut être fourni pour spécifier le nombre maximal d'octets à
- interpréter. La valeur par défaut est 8192 :
+<highlight language="lua">
+r:sendfile(filename) -- envoie un fichier entier au client en
+utilisant sendfile s'il est supporté par la plateforme :
+
+if use_sendfile_thing then
+ r:sendfile("/var/www/large_file.img")
+end
+</highlight>
+
+<highlight language="lua">
+r:parseargs() -- renvoie deux tables : une table standard de couples
+clé/valeur pour les données GET simples, et une autre pour les données
+multivaluées (par exemple foo=1&foo=2&foo=3) :
+
+local GET, GETMULTI = r:parseargs()
+r:puts("Votre nom est : " .. GET['name'] or "Unknown")
+</highlight>
- local POST, POSTMULTI = r:parsebody(1024*1024)
- r:puts("Votre nom est : " .. POST['name'] or "Unknown")
- </highlight>
- <highlight language="lua">
- r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
- </highlight>
+<highlight language="lua">
+r:parsebody()([sizeLimit]) -- interprète le corps de la requête
+en tant que POST et renvoie deux tables lua, comme r:parseargs(). Un nombre optionnel
+peut être fourni pour spécifier le nombre maximal d'octets à
+interpréter. La valeur par défaut est 8192.
+
+local POST, POSTMULTI = r:parsebody(1024*1024)
+r:puts("Votre nom est : " .. POST['name'] or "Unknown")
+</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.
+
+local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
+</highlight>
+
+<highlight language="lua">
+r:base64_decode(string) -- Décode une chaîne codée en Base64.
+
+local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
+</highlight>
+
+<highlight language="lua">
+r:md5(string) -- Calcule et renvoie le condensé MD5 d'une chaîne
+en mode binaire (binary safe).
+
+local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
+</highlight>
+
+<highlight language="lua">
+r:sha1(string) -- Calcule et renvoie le condensé SHA1 d'une chaîne
+en mode binaire (binary safe).
+
+local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
+</highlight>
- <highlight language="lua">
- r:write("une simple chaîne") -- affichage dans le
- corps de la réponse
- </highlight>
+<highlight language="lua">
+r:escape(string) -- Echappe une chaîne de type URL.
+
+local url = "http://foo.bar/1 2 3 & 4 + 5"
+local escaped = r:escape(url) -- renvoie 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
+</highlight>
+
+<highlight language="lua">
+r:unescape(string) -- Déséchappe une chaîne de type URL.
+
+local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
+local unescaped = r:unescape(url) -- renvoie 'http://foo.bar/1 2 3 & 4 + 5'
+</highlight>
+
+<highlight language="lua">
+r:construct_url(string) -- Construit une URL à partir d'un URI
+
+local url = r:construct_url(r.uri)
+</highlight>
+
+<highlight language="lua">
+r:mpm_query(number) -- Interroge le serveur à propos de son
+module MPM via la requête ap_mpm_query.
+
+local mpm = r.mpm_query(14)
+if mpm == 1 then
+ r:puts("Ce serveur utilise le MPM Event")
+end
+</highlight>
+
+<highlight language="lua">
+r:expr(string) -- Evalue une chaîne de type <a
+href="../expr.html">expr</a>.
+
+if r:expr("%{HTTP_HOST} =~ /^www/") then
+ r:puts("Ce nom d'hôte commence par www")
+end
+</highlight>
+
+<highlight language="lua">
+r:scoreboard_process(a) -- Interroge le serveur à propos du
+processus à la position <code>a</code>.
+
+local process = r:scoreboard_process(1)
+r:puts("Le serveur 1 a comme PID " .. process.pid)
+</highlight>
+
+<highlight language="lua">
+r:scoreboard_worker(a, b) -- Interroge le serveur à propos du
+thread <code>b</code>, dans le processus <code>a</code>.
+
+local thread = r:scoreboard_worker(1, 1)
+r:puts("L'ID du thread 1 du serveur 1 est " .. thread.tid .. " et son
+état est " .. thread.status)
+</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.
+
+local input = r:requestbody()
+r:puts("Vous m'avez envoyé le corps de requête suivant :\n")
+r:puts(input)
+</highlight>
- <highlight language="lua">
- r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
+<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.
+
+local mod = r.module_info("mod_lua.c")
+if mod then
+ for k, v in pairs(mod.commands) do
+ r:puts( ("%s: %s\n"):format(k,v)) -- affiche toutes les directives implémentées par ce module
+ end
+end
+</highlight>
+
+<highlight language="lua">
+r:loaded_modules() -- Renvoie une liste des modules chargés par
+httpd.
+
+for k, module in pairs(r:loaded_modules()) do
+ r:puts("J'ai chargé le module " .. module .. "\n")
+end
+</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' ?
+
+local match = r.strcmp_match("foobar.com", "foo*.com")
+if match then
+ r:puts("foobar.com matches foo*.com")
+end
+</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.
+
+r:custom_response(404, "Baleted!")
+</highlight>
+
+<highlight language="lua">
+r.exists_config_define(string) -- Vérifie si une définition de
+configuration existe.
+
+if r.exists_config_define("FOO") then
+ r:puts("httpd a probablement été lancé avec l'option -DFOO, ou FOO a
+ été défini dans la configuration")
+end
+</highlight>
+
+<highlight language="lua">
+r:state_query(string) -- Interroge le serveur à propos de son
+état.
+</highlight>
+
+<highlight language="lua">
+r:stat(filename [,wanted]) -- Exécute stat() sur un fichier, et renvoie
+une table contenant des informations à propos de ce fichier.
+
+local info = r:stat("/var/www/foo.txt")
+if info then
+ r:puts("Ce fichier existe et a été modifié pour la dernière fois à : " .. info.modified)
+end
+</highlight>
+
+<highlight language="lua">
+r:regex(string, pattern [,flags]) -- Exécute une recherche à base
+d'expression rationnelle sur une chaîne, et renvoie les
+éventuelles correspondances trouvées.
+
+local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
+if matches then
+ r:puts("L'expression rationnelle correspond et le dernier mot
+ capturé ($2) est : " .. matches[2])
+end
+
+-- Exemple avec insensibilité à la casse :
+local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
+
+-- les drapeaux peuvent être une combibaison bit à bit de :
+-- 0x01: insensibilité à la casse
+-- 0x02: recherche multiligne
+</highlight>
+
+<highlight language="lua">
+r:sleep(secondes) -- Interrompt l'exécution du script pendant le nombre de secondes spécifié.
+ -- La valeur peut être spécifiée sous la forme d'un nombre décimal comme 1.25 pour plus de précision.
+</highlight>
+
+<highlight language="lua">
+r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
base de données et renvoie une classe database. Voir '<a
href="#databases">Connectivité aux bases de données</a>' pour plus de
détails.
- </highlight>
- </dd>
- </dl>
+</highlight>
+
+<highlight language="lua">
+r:ivm_set("key", value) -- Défini une variable Inter-VM avec une valeur spécifique.
+ -- Ces valeurs sont conservées même si la VM est
+ -- arrêtée ou non utilisée, et ne doivent donc être
+ -- utilisées que si MaxConnectionsPerChild > 0.
+ -- Les valeurs peuvent être de type number, string
+ -- ou boolean et sont stockées séparément pour
+ -- chaque processus (elles ne seront donc pas d'une
+ -- grande utilité si l'on utilise le mpm prefork).
+
+r:ivm_get("key") -- Lit le contenu d'une variable définie via ivm_set. Renvoie
+ -- le contenu de la variable si elle existe, ou nil
+ -- dans le cas contraire.
+
+-- Voici un exemple de lecture/écriture qui sauvegarde une variable
+-- globale en dehors de la VM :
+function handle(r)
+ -- La première VM qui effectue l'appel suivant n'obtiendra aucune
+ -- valeur, et devra la créer
+ local foo = r:ivm_get("cached_data")
+ if not foo then
+ foo = do_some_calcs() -- simulation de valeurs de retour
+ r:ivm_set("cached_data", foo) -- définition globale de la variable
+ end
+ r:puts("La donnée en cache est : ", foo)
+end
+</highlight>
+<highlight language="lua">
+r:htpassword(string [,algorithm [,cost]]) -- Génère un hash de mot de passe à partir d'une chaîne.
+ -- algorithm: 0 = APMD5 (défaut), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
+ -- cost: ne s'utilise qu'avec l'algorythme BCRYPT (défaut = 5).
+</highlight>
+
+<highlight language="lua">
+r:mkdir(dir [,mode]) -- Crée un répertoire et définit son mode via le paramètre optionnel mode.
+</highlight>
+
+<highlight language="lua">
+r:rmdir(dir) -- Supprime un répertoire.
+</highlight>
+
+<highlight language="lua">
+r:get_direntries(dir) -- Renvoie une table contenant toutes les entrées de répertoires.
+
+-- Renvoie un chemin sous forme éclatée en chemin, fichier, extension
+function split_path(path)
+ return path:match("(.-)([^\\/]-%.?([^%.\\/]*))$")
+end
+
+function handle(r)
+ local cwd, _, _ = split_path(r.filename)
+ for _, f in ipairs(r:get_direntries(cwd)) do
+ local info = r:stat(cwd .. f)
+ if info then
+ local mtime = os.date(fmt, info.mtime / 1000000)
+ local ftype = (info.filetype == 2) and "[dir] " or "[file]"
+ r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
+ end
+ end
+end
+</highlight>
+
+<highlight language="lua">
+r.date_parse_rfc(string) -- Interprète une chaîne date/heure et renvoie l'équivalent en secondes depuis epoche.
+</highlight>
</section>
<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>
<section id="databases">
<title>Connectivité aux bases de données</title>
<p>Mod_lua implémente une fonctionnalité basique de connexion aux
<p>L'exemple suivant montre comment se connecter à une base de
données et extraire des informations d'une table :</p>
<highlight language="lua">
-function handler(r)
+function handle(r)
-- connexion à la base de données
local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
if not err then
-- Création et exécution d'une requête préparée :
local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")
if not errmsg then
- local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
+ local result, errmsg = statement:query(20) -- exécute la requête pour age > 20
end
-- Extrait une requête préparée depuis une directive DBDPrepareSQL :
<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 -- la valeur par défaur est
-once</syntax>
+<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>
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>
-<!-- not implemented
+
<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 interpréteurs sont stockés dans une liste de ressources
- apr. Les arguments min et max ont été prévus pour spécifier une
- taille de jeu, mais sont inutilisés pour le moment.</dd>
--->
+ 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>
-<!--
-/* Not implemented in 2.4.x yet */
<directivesynopsis>
<name>LuaMapHandler</name>
<description>Met en correspondance un chemin avec un gestionnaire lua</description>
spécifié.</p>
</usage>
</directivesynopsis>
--->
<directivesynopsis>
<name>LuaPackagePath</name>
</usage>
</directivesynopsis>
-<!-- Not implemented yet
<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>
+<contextlist>
+<context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
</usage>
</directivesynopsis>
--->
<directivesynopsis>
<name>LuaHookTranslateName</name>
<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
- <usage><p>...</p></usage>
+ <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">
+ LuaHookMapToStorage /path/to/lua/script.lua check_cache
+ </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>
traitement de la requête</description>
<syntax>LuaQuickHandler /path/to/script.lua hook_function_name</syntax>
<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
</contextlist>
<override>All</override>
-<usage><p>...</p>
+<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="mod_authz_core">Require</directive> :</p>
-<example>
<highlight language="config">
LuaRoot /usr/local/apache2/lua
LuaAuthzProvider foo authz.lua authz_check_foo
<Location />
- Require foo bar
+ Require foo johndoe
</Location>
</highlight>
-</example>
+<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>
projects / apache / commitdiff