<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
-<!-- English Revision: 1455272:1467562 (outdated) -->
+<!-- English Revision : 1467562 -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->
</section>
<section id="functions"><title>Méthodes de l'objet request_rec</title>
- <p>L'objet 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">
+<p>L'objet request_rec possède (au minimum) les méthodes suivantes :</p>
+
+<highlight language="lua">
+r:flush() -- vide le tampon de sortie
+
+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:addoutputfilter(name|function) -- ajoute un filtre en sortie
+
+r:addoutputfilter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
+</highlight>
+
+<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 une table Lua contenant la chaîne
+d'arguments de la requête
+
+local GET = r:parseargs()
++r:puts("Votre nom est : " .. GET['name'] or "Unknown")
+</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.
+
+local POST = 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:escape(string) -- Echappe une chaîne de type URL.
+
+local url = "http://foo.bar/1 2 3 & 4 + 5"
+local escaped = r:escape(url) -- returns '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:escape(url) -- returns 'http://foo.bar/1 2 3 & 4 + 5'
+</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: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>
+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:module_info(module_name) -- Interroge le serveur à propos d'un
- module.
- </highlight>
+<highlight language="lua">
+r:add_input_filter(filter_name) -- Ajoute le filtre en entrée
+'filter_name'.
+</highlight>
- <highlight language="lua">
- r:loaded_modules() -- Renvoie une liste des modules chargés par
- httpd.
- </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">
+<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">
+</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>
+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:make_etag() -- Génère et renvoie le etag pour la requête
+courante.
+</highlight>
- <highlight language="lua">
+<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>
- <highlight language="lua">
+<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: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) -- 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) -- 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
+</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>
- <highlight language="lua">
- r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une
+<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>
+</highlight>
</section>
-- 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 :
projects / apache / commitdiff