Serveur HTTP Apache Version 2.5
Description: | Fournit des points d'entrée Lua dans différentes parties du traitement des requêtes httpd |
---|---|
Statut: | Extension |
Identificateur de Module: | lua_module |
Fichier Source: | mod_lua.c |
Compatibilité: | versions 2.3 et supérieures |
Ce module permet d'ajouter au serveur des extensions sous forme de
scripts écrits dans le langage de programmation Lua.
mod_lua
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.
Vous trouverez davantage d'informations à propos du langage de programmation Lua sur le site web de Lua.
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.
La directive de base pour le chargement du module est
LoadModule lua_module modules/mod_lua.so
mod_lua
fournit un gestionnaire nommé
lua-script
qui peut être utilisé avec une directive
SetHandler
ou AddHandler
:
<Files "*.lua"> SetHandler lua-script </Files>
Ceci aura pour effet de faire traiter les requêtes pour les fichiers
dont l'extension est .lua
par mod_lua
en
invoquant cette fonction de gestion
de fichier.
Pour plus de détails, voir la directive
LuaMapHandler
.
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. mod_proxy
, mod_cgi
et
mod_status
sont des exemples de modules comportant un
gestionnaire.
mod_lua
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 :
example.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.content_type = "text/plain" 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 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
Ce gestionnaire se contente d'afficher les arguments codés d'un uri ou d'un formulaire dans un page au format texte.
Cela signifie que vous pouvez (et êtes encouragé à) avoir plusieurs gestionnaires (ou points d'entrée, ou filtres) dans le même script.
mod_authz_core
fournit une interface d'autorisation
de haut niveau bien plus facile à utiliser que dans les hooks
correspondants. Le premier argument de la directive Require
permet de spécifier le
fournisseur d'autorisation à utiliser. Pour chaque directive Require
,
mod_authz_core
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.
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
renvoyer apache2.AUTHZ_DENIED_NO_USER
, ce qui va
déclancher le processus d'authentification et un deuxième appel du
fournisseur authz.
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 :
authz_provider.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
La configuration suivante enregistre cette fonction en tant que
fournisseur foo
, et la configure por l'URL /
:
LuaAuthzProvider foo authz_provider.lua authz_check_foo <Location "/"> Require foo 10.1.2.3 john_doe </Location>
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 :
Phase d'accroche | Directive mod_lua | Description |
---|---|---|
Gestionnaire rapide | LuaQuickHandler |
Il s'agit de la première accroche appelée lorsqu'une requête a été associée à un serveur ou un serveur virtuel. |
Phase de traduction | LuaHookTranslateName |
Cette phase traduit l'URI de la requête en nom de fichier
sur le système. Ce sont des modules comme
mod_alias et mod_rewrite qui
interviennent au cours de cette phase. |
Choix du lieu de stockage de la ressource | LuaHookMapToStorage |
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. |
Autorisation d'accès | LuaHookAccessChecker |
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. |
Vérification de l'identifiant utilisateur | LuaHookCheckUserID |
Cette phase vérifie l'identifiant de l'utilisateur ayant fait l'objet d'une négociation. |
Vérification de l'autorisation d'accès | LuaHookAuthChecker
ou
LuaAuthzProvider |
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... |
Vérification du type de la ressource | LuaHookTypeChecker |
Cette phase assigne un type de contenu et un gestionnaire à la ressource. |
Derniers réglages | LuaHookFixups |
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. |
Gestionnaire de contenu | fichiers fx. .lua ou directive LuaMapHandler |
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. |
Journalisation | LuaHookLog |
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. Mod_lua peut s'intercaler au départ de ce processus et ainsi contrôler la journalisation. |
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 apache2.OK
,
apache2.DONE
, ou apache2.DECLINED
.
translate_name.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 r.filename = r.document_root .. "/find_me.txt" return apache2.OK end -- on ne gère pas cette URL et on donne sa chance à un autre module return apache2.DECLINED end
translate_name2.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. Note: utilisez le drapeau early/late de la directive pour 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
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).
Nom | Type Lua | Modifiable | Description |
---|---|---|---|
allowoverrides |
string | non | L'option AllowOverride s'applique à la requête courante. |
ap_auth_type |
string | non | Ce champ contient le type d'authentification effectuée
(par exemple basic ) |
args |
string | oui | La chaîne de paramètres de la requête (par exemple
foo=bar&name=johnsmith ) |
assbackwards |
boolean | non | contient true s'il s'agit d'une requête de style HTTP/0.9
(par exemple GET /foo (sans champs d'en-tête) ) |
auth_name |
string | non | La chaîne d'identification utilisée pour la vérification de l'autorisation d'accès (si elle est disponible). |
banner |
string | non | La bannière du serveur, par exemple Apache HTTP
Server/2.4.3 openssl/0.9.8c |
basic_auth_pw |
string | non | Le mot de passe pour l'authentification de base envoyé avec la requête, s'il existe |
canonical_filename |
string | non | Le nom de fichier canonique de la requête |
content_encoding |
string | non | Le type de codage du contenu de la requête courante |
content_type |
string | oui | 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
image/gif ou text/html ) |
context_prefix |
string | non | |
context_document_root |
string | non | |
document_root |
string | non | La racine des documents du serveur |
err_headers_out |
table | non | 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 |
filename |
string | oui | 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. |
handler |
string | oui | Le nom du gestionnaire qui
doit traiter la requête, par exemple lua-script
si elle doit être traitée par mod_lua. Cette valeur est en
général définie via les directives AddHandler ou SetHandler , 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.
|
headers_in |
table | oui | Les en-têtes MIME de l'environnement de la requête. Il
s'agit des en-têtes comme Host, User-Agent,
Referer , etc... |
headers_out |
table | oui | Les en-têtes MIME de l'environnement de la réponse. |
hostname |
string | non | Le nom d'hôte, tel que défini par l'en-tête
Host: ou par un URI complet. |
is_https |
boolean | non | Indique si la requête à été faite via HTTPS |
is_initial_req |
boolean | non | Indique si la requête courante est la requête initiale ou une sous-requête. |
limit_req_body |
number | non | La taille maximale du corps de la requête, ou 0 si aucune limite. |
log_id |
string | non | L'identifiant de la requête dans les journaux d'accès ou d'erreur. |
method |
string | non | La méthode de la requête, par exemple GET ou
POST . |
notes |
table | oui | Une liste de notes qui peuvent être transmises d'un module à l'autre. |
options |
string | non | La valeur de la directive Options pour la requête courante. |
path_info |
string | non | La valeur de PATH_INFO extraite de la requête. |
port |
number | non | Le port du serveur utilisé par la requête. |
protocol |
string | non | Le protocole utilisé, par exemple HTTP/1.1 |
proxyreq |
string | oui | 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. |
range |
string | non | Le contenu de l'en-tête Range: . |
remaining |
number | non | Le nombre d'octets du corps de la requête restant à lire. |
server_built |
string | non | La date de compilation du serveur. |
server_name |
string | non | Le nom du serveur pour cette requête. |
some_auth_required |
boolean | non | Indique si une autorisation est/était requise pour cette requête. |
subprocess_env |
table | oui | Le jeu de variables d'environnement pour cette requête. |
started |
number | non | Le moment où le serveur a été (re)démarré, en secondes depuis epoch (1er janvier 1970) |
status |
number | oui | Le code de retour (courant) pour cette requête, par
exemple 200 ou 404 . |
the_request |
string | non | La chaîne de la requête telle qu'elle a été envoyée par le
client, par exemple GET /foo/bar HTTP/1.1 . |
unparsed_uri |
string | non | La partie URI non interprétée de la requête |
uri |
string | oui | L'URI après interprétation par httpd |
user |
string | oui | Si une authentification a été effectuée, nom de l'utilisateur authentifié. |
useragent_ip |
string | non | L'adresse IP de l'agent qui a envoyé la requête |
L'objet request_rec possède (au minimum) les méthodes suivantes :
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.usleep(500000) -- mise en attente pendant 0.5 secondes et bouclage end
r:add_output_filter(filter_name) -- ajoute un filtre en sortie r:add_output_filter("fooFilter") -- insère le filtre fooFilter dans le flux de sortie
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
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")
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")
r:puts("bonjour", " le monde", "!") -- affichage dans le corps de la réponse
r:write("une simple chaîne") -- affichage dans le corps de la réponse
r:escape_html("<html>test</html>") -- Echappe le code HTML et renvoie le résultat
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=
r:base64_decode(string) -- Décode une chaîne codée en Base64. local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
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
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
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'
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'
r:construct_url(string) -- Construit une URL à partir d'un URI local url = r:construct_url(r.uri)
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
r:expr(string) -- Evalue une chaîne de type expr. if r:expr("%{HTTP_HOST} =~ /^www/") then r:puts("Ce nom d'hôte commence par www") end
r:scoreboard_process(a) -- Interroge le serveur à propos du
-- processus à la position a
.
local process = r:scoreboard_process(1)
r:puts("Le serveur 1 a comme PID " .. process.pid)
r:scoreboard_worker(a, b) -- Interroge le serveur à propos du -- threadb
, dans le processusa
. 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)
r:clock() -- Renvoie l'heure courante avec une précision d'une microseconde.
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)
r:add_input_filter(filter_name) -- Ajoute le filtre en entrée 'filter_name'.
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
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
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.
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...
r:set_document_root(file_path) -- Définit la racine des documents -- pour la requête à file_path.
r:add_version_component(component_string) -- Ajoute un élément à -- la bannière du serveur.
r:set_context_info(prefix, docroot) -- Définit le préfixe et la -- racine des documents du contexte pour une requête.
r:os_escape_path(file_path) -- Convertit un chemin du système de -- fichiers en URL indépendamment du système d'exploitation.
r:escape_logitem(string) -- Echappe une chaîne pour journalisation.
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
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.
r:make_etag() -- Génère et renvoie le etag pour la requête courante.
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.
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!")
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
r:state_query(string) -- Interroge le serveur à propos de son état.
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
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
r.usleep(microsecondes) -- Interrompt l'exécution du script pendant le nombre de microsecondes spécifié.
r:dbacquire(dbType[, dbParams]) -- Acquiert une connexion à une base de données et renvoie une classe database. -- Voir 'Connectivité aux bases de données' -- pour plus de détails.
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
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).
r:mkdir(dir [,mode]) -- Crée un répertoire et définit son mode via le paramètre optionnel mode.
r:mkrdir(dir [,mode]) -- Crée des répertoires de manière récursive et définit -- leur mode via le paramètre optionnel mode.
r:rmdir(dir) -- Supprime un répertoire.
r:touch(file [,mtime]) -- Définit la date de modification d'un fichier à la date courante ou à -- la valeur optionnelle mtime en msec.
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 handle(r) local dir = r.context_document_root for _, f in ipairs(r:get_direntries(dir)) do local info = r:stat(dir .. "/" .. 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
r.date_parse_rfc(string) -- Interprète une chaîne date/heure et renvoie l'équivalent en secondes depuis epoche.
r:getcookie(key) -- Obtient un cookie HTTP
r:setcookie(key, value, secure, expires) -- Définit un cookie HTTP, par exemple : r:setcookie("foo", "bar and stuff", false, os.time() + 86400)
r:wsupgrade() -- Met à jour une connexion vers les WebSockets si possible (et si demandé) : if r:wsupgrade() then -- si la mise à jour est possible : r:wswrite("Bienvenue dans les websockets!") -- écrit quelque chose à l'intention du client r:wsclose() -- Au revoir ! end
r:wsread() -- Lit un cadre de websocket depuis une connexion vers websocket mise à jour (voir ci-dessus) : local line, isFinal = r:wsread() -- isFinal indique s'il s'agit du cadre final. -- dans le cas contraire, on peut lire les cadres suivants r:wswrite("Vous avez écrit : " .. line)
r:wswrite(line) -- écrit un cadre vers un client WebSocket : r:wswrite("Bonjour le Monde !")
r:wsclose() -- ferme une requête WebSocket et l'achève pour httpd : if r:wsupgrade() then r:wswrite("Ecrire quelque chose : ") local line = r:wsread() or "nothing" r:wswrite("Vous avez écrit : " .. line); r:wswrite("Au revoir !") r:wsclose() end
r:wspeek() -- Vérifie s'il y a des données à lire -- Se met en sommeil tant que rien ne nous est envoyé ... while r:wspeek() == false do r.usleep(50000) end -- Il y a des données à lire ! local line = r:wsread()
r:config() -- Extrait une arborescence de l'ensemble de -- la configuration de httpd pouvant être parcourue
r:activeconfig() -- Extrait une arborescence de la configuration active -- de httpd (pour le serveur virtuel sélectionné)
-- exemples de messages de journalisation r:trace1("Ceci est un message de journalisation de niveau trace") -- les niveaux valides vont de trace1 à trace8 r:debug("Ceci est un message de journalisation de niveau debug") r:info("Ceci est un message de journalisation de niveau info") r:notice("Ceci est un message de journalisation de niveau notice") r:warn("Ceci est un message de journalisation de niveau warn") r:err("Ceci est un message de journalisation de niveau err") r:alert("Ceci est un message de journalisation de niveau alert") r:crit("Ceci est un message de journalisation de niveau crit") r:emerg("Ceci est un message de journalisation de niveau emerg")
Le paquet nommé apache2
est fourni avec (au minimum) le
contenu suivant :
mod_proxy
mod_authz_core
Les autres codes d'état HTTP ne sont pas encore implémentés.
Les fonctions de filtrage implémentées via les directives LuaInputFilter
ou LuaOutputFilter
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 :
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
Mod_lua implémente une fonctionnalité basique de connexion aux bases de données permettant d'envoyer des requêtes ou d'exécuter des commandes auprès des moteurs de base de données les plus courants (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle), ainsi que mod_dbd.
L'exemple suivant montre comment se connecter à une base de données et extraire des informations d'une table :
function handle(r) -- connexion à la base de données local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,dbname=mydb") if not err then -- Sélection de certaines informations local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1") if not err then local rows = results(0) -- extrait tous les enregistrements en mode synchrone for k, row in pairs(rows) do r:puts( string.format("Name: %s, Age: %s<br/>", row[1], row[2]) ) end else r:puts("Database query error: " .. err) end database:close() else r:puts("Connexion à la base de données impossible : " .. err) end end
Pour utiliser mod_dbd
, spécifiez
mod_dbd
comme type de base de données, ou laissez le champ
vide :
local database = r:dbacquire("mod_dbd")
L'objet database renvoyé par dbacquire
possède
les méthodes suivantes :
Sélection normale et requête vers une base de données :
-- Exécution d'une requête et renvoie du nombre d'enregistrements affectés : local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1") -- Exécution d'une requête et renvoie du résultat qui peut être utilisé en mode synchrone ou asynchrone : local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
Utilisation de requêtes préparées (recommandé) :
-- 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 end -- Extrait une requête préparée depuis une directive DBDPrepareSQL : local statement, errmsg = database:prepared(r, "someTag") if not errmsg then local result, errmsg = statement:select("John Doe", 123) -- injecte les valeurs "John Doe" et 123 dans la requête end
Echappement de valeurs, fermeture de la base données, etc...
-- Echappe une valeur pour pouvoir l'utiliser dans une requête : local escaped = database:escape(r, [["'|blabla]]) -- Ferme une base de données et libère les liens vers cette dernière : database:close() -- Vérifie si une connexion à une base de données est en service et opérationnelle : local connected = database:active()
Les jeux d'enregistrements renvoyés par db:select
ou par des
requêtes préparées créées par db:prepare
permettent de
sélectionner des enregistrements en mode synchrone ou
asynchrone, selon le nombre d'enregistrements spécifié :
result(0)
sélectionne tous les enregistrements en mode
synchrone en renvoyant une table d'enregistrements.
result(-1)
sélectionne le prochain enregistrement disponible en
mode asynchrone.
result(N)
sélectionne l'enregistrement numéro
N
en mode asynchrone.
-- extrait un jeu d'enregistrements via une requête régulière : local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1") local rows = result(0) -- sélectionne tous les enregistrements en mode synchrone local row = result(-1) -- sélectionne le prochain enregistrement disponible en mode asynchrone local row = result(1234) -- sélectionne l'enregistrement 1234 en mode asynchrone local row = result(-1, true) -- Lit l'enregistrement suivant en utilisant les noms d'enregistrements comme index.
Il est possible de construire une fonction qui renvoie une fonction itérative permettant de traiter tous les enregistrement en mode synchrone ou asynchrone selon la valeur de l'argument async :
function rows(resultset, async) local a = 0 local function getnext() a = a + 1 local row = resultset(-1) return row and a or nil, row end if not async then return pairs(resultset(0)) else return getnext, self end end local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u") if not err then -- sélectionne des enregistrements en mode asynchrone : local result, err = statement:select(20) if not err then for index, row in rows(result, true) do .... end end -- sélectionne des enregistrements en mode synchrone : local result, err = statement:select(20) if not err then for index, row in rows(result, false) do .... end end end
Lorsqu'elles ne sont plus utilisées, les connexions aux bases de
données doivent être fermées avec database:close()
. Si vous
ne les fermez pas manuellement, mod_lua les fermera peut-être en tant
que résidus collectés, mais si ce n'est pas le cas, vous pouvez finir
pas avoir trop de connexions vers la base de données inutilisées. Les
deux mesures suivantes sont pratiquement identiques :
-- Méthode 1 : fermeture manuelle de la connexion local database = r:dbacquire("mod_dbd") database:close() -- c'est tout -- Méthode 2 : on laisse le collecteur de résidus la fermer local database = r:dbacquire("mod_dbd") database = nil -- on coupe le lien collectgarbage() -- fermeture de la connexion par le collecteur de résidus
Bien que les fonctions query
et run
soient toujours disponibles, il est recommandé d'utiliser des requêtes
préparées chaque fois que possible, afin d'une part d'optimiser les
performances (si votre connexion reste longtemps en vie), et d'autre part
minimiser le risque d'attaques par injection SQL. Les fonctions
run
et query
ne doivent être utilisées que
lorsque la requête ne contient pas de variables (requête statique). Dans
le cas des requêtes dynamiques, utilisez db:prepare
ou
db:prepared
.
Description: | Branche une fonction fournisseur d'autorisation dans mod_authz_core
|
---|---|
Syntaxe: | LuaAuthzProvider provider_name /path/to/lua/script.lua function_name |
Contexte: | configuration globale |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Disponible depuis la version 2.4.3 du serveur HTTP Apache |
Lorsqu'une fonction lua a été enregistrée en tant que fournisseur
d'autorisation, elle peut être appelée via la directive Require
:
LuaRoot /usr/local/apache2/lua LuaAuthzProvider foo authz.lua authz_check_foo <Location "/"> Require foo johndoe </Location>
require "apache2" function authz_check_foo(r, who) if r.user ~= who then return apache2.AUTHZ_DENIED return apache2.AUTHZ_GRANTED end
Description: | Configure le cache de code compilé. |
---|---|
Syntaxe: | LuaCodeCache stat|forever|never |
Défaut: | LuaCodeCache stat |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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).
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.
LuaCodeCache stat LuaCodeCache forever LuaCodeCache never
Description: | Fournit un point d'entrée pour la phase access_checker du traitement de la requête |
---|---|
Syntaxe: | LuaHookAccessChecker /chemin/vers/lua/script.lua hook_function_name [early|late] |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Le troisième argument optionnel est disponible depuis la version 2.3.15 du serveur HTTP Apache. |
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.
Les arguments optionnels "early" ou "late" permettent de contrôler le moment auquel ce script s'exécute par rapport aux autres modules.
Description: | Fournit un point d'entrée pour la phase auth_checker du traitement de la requête |
---|---|
Syntaxe: | LuaHookAuthChecker /chemin/vers/lua/script.lua hook_function_name [early|late] |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Le troisième argument optionnel est disponible depuis la version 2.3.15 du serveur HTTP Apache. |
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 :
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
Les arguments optionnels "early" ou "late" permettent de contrôler le moment auquel ce script s'exécute par rapport aux autres modules.
Description: | Fournit un point d'entrée pour la phase check_user_id du traitement de la requête |
---|---|
Syntaxe: | LuaHookCheckUserID /path/to/lua/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Description: | Fournit un point d'entrée pour la phase de correction du traitement de la requête |
---|---|
Syntaxe: | LuaHookFixups /chemin/vers/lua/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Idem LuaHookTranslateName, mais s'exécute durant la phase de correction.
Description: | Fournit un point d'entrée pour la phase insert_filter du traitement de la requête |
---|---|
Syntaxe: | LuaHookInsertFilter /chemin/vers/lua/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Non encore implémenté
Description: | Permet une insertion dans la phase de journalisation du traitement d'une requête |
---|---|
Syntaxe: | LuaHookLog /path/to/lua/script.lua log_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Ce dispositif d'insertion simple permet d'exécuter une fonction
lorsque httpd entre dans la phase de journalisation du traitement
d'une requête. Vous pouvez ainsi ajouter des données à vos propres
entrées de journalisation, manipuler les entrées du journal standard
avant leur enregistrement ou empêcher l'enregistrement d'une entrée
dans le journal. Pour empêcher l'enregistrement normal des entrées
du journal, renvoyez simplement apache2.DONE
dans votre
gestionnaire de journalisation, ou au contraire, renvoyez
apache2.OK
pour que httpd effectue une journalisation
normale.
Exemple :
LuaHookLog /path/to/script.lua logger
-- /path/to/script.lua -- function logger(r) -- on joue à pile ou face : -- Si on obtient 1, on écrit dans notre propre journal Lua et on dit -- à httpd de ne pas enregistrer d'entrée dans le journal standard.. -- Si on obtient 2, on nettoie un peu les données avant que httpd ne -- les enregistre dans le journal standard. if math.random(1,2) == 1 then -- On effectue notre propre journalisation et le journal -- standard n'est pas alimenté local f = io.open("/foo/secret.log", "a") if f then f:write("Quelque chose de secret est arrivé à " .. r.uri .. "\n") f:close() end return apache2.DONE -- On dit à httpd de ne rien enregistrer --dans le journal standard else r.uri = r.uri:gsub("somesecretstuff", "") -- nettoie les données return apache2.OK -- et httpd doit alors les enregistrer. end end
Description: | Fournit un point d'entrée pour la phase map_to_storage du traitement de la requête |
---|---|
Syntaxe: | LuaHookMapToStorage /chemin/vers/lua/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Identique à la directive
LuaHookTranslateName
, 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 :
LuaHookMapToStorage /path/to/lua/script.lua check_cache
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 -- Ne concerne que les fichiers PNG local file = cached_files[r.filename] -- Vérifie les entrées du cache if not file then file = read_file(r.filename) -- Lit le fichier vers le cache end if file then -- Si le fichier existe, on l'envoie r.status = 200 r:write(file) r:info(("%s a été envoyé au client depuis le cache"):format(r.filename)) return apache2.DONE -- cout-circuite le gestionnaire par défaut des fichiers PNG end end return apache2.DECLINED -- Si nous n'avons rien eu à faire, nous laissons les autres s'en charger end
Description: | Fournit un point d'entrée à la phase du nom de traduction du traitement de la requête |
---|---|
Syntaxe: | LuaHookTranslateName /chemin/vers/lua/script.lua nom_fonction_hook [early|late] |
Contexte: | configuration globale, serveur virtuel |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Le troisième argument optionnel est disponible depuis la version 2.3.15 du serveur HTTP Apache. |
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, apache2.DECLINED, ou apache2.DONE.
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.
Exemple :
# httpd.conf LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
-- /scripts/conf/hooks.lua -- require "apache2" function silly_mapper(r) if r.uri == "/" then r.filename = "/var/www/home.lua" return apache2.OK else return apache2.DECLINED end end
Cette directive ne peut être
utilisée ni à l'intérieur d'une section <Directory>
ou <Files>
, ni dans un fichier htaccess.
Les arguments optionnels "early" ou "late" permettent de contrôler le moment auquel ce script s'exécute par rapport aux autres modules.
Description: | Fournit un point d'entrée pour la phase type_checker du traitement de la requête |
---|---|
Syntaxe: | LuaHookTypeChecker /chemin/vers/lua/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Cette directive fournit un point d'entrée pour la phase type_checker du traitement de la requête. Cette phase correspond au moment où la requête se voit assigner un type et un gestionnaire de contenu, et peut donc être utilisée pour modifier le type et le gestionnaire en fonction de l'entrée :
LuaHookTypeChecker "/path/to/lua/script.lua" type_checker
function type_checker(r) if r.uri:match("%.to_gif$") then -- foo.png.to_gif convient r.content_type = "image/gif" -- affectation du type image/gif r.handler = "gifWizard" -- force le traitement de la requête par le module gifWizard r.filename = r.uri:gsub("%.to_gif$", "") -- corrige le nom du fichier demandé return apache2.OK end return apache2.DECLINED end
Description: | Contrôle la manière dont les sections de configuration parentes sont fusionnées dans les enfants |
---|---|
Syntaxe: | LuaInherit none|parent-first|parent-last |
Défaut: | LuaInherit parent-first |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Versions 2.4.0 et supérieures |
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 après 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.
Jusqu'aux versions 2.3.x, le comportement par défaut consistait à ignorer les directives LuaHook* situées dans les sections de configuration parentes.
Description: | Fournit une fonction Lua pour le filtrage en entrée |
---|---|
Syntaxe: | LuaInputFilter filter_name /path/to/lua/script.lua function_name |
Contexte: | configuration globale |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Disponible depuis la version 2.4.5 du serveur HTTP Apache |
Cette directive permet d'ajouter un filtre en entrée sous la forme
d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
entrée fonctionnent comme des sous-routines, intervenant dans un premier
temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
paquet de données doit être transmis à la chaîne, et éventuellement
produisant toute donnée à ajouter aux données en entrée. La variable
globale bucket
contient les paquets de données tels qu'ils
sont transmis au script Lua :
LuaInputFilter myInputFilter /www/filter.lua input_filter <Files "*.lua"> SetInputFilter myInputFilter </Files>
--[[ Exemple de filtre en entrée qui convertit toutes les données POST en majuscules. ]]-- function input_filter(r) print("luaInputFilter called") -- pour débogage coroutine.yield() -- attend des paquets de données while bucket do -- Pour chaque paquet, faire ... local output = string.upper(bucket) -- Convertit toutes les données POST en majuscules coroutine.yield(output) -- Envoie les données traitées à la chaîne de filtrage end -- plus aucune donnée à traiter. coroutine.yield("&filterSignature=1234") -- Ajoute une signature à la fin end
Le filtre en entrée peut interdire ou sauter un filtre s'il est considéré comme indésirable :
function input_filter(r) if not good then return -- Empêche tout simplement le filtrage et transmet le contenu original end coroutine.yield() -- attend des paquets de données ... -- insert les filtres ici end
Voir "Modification de contenu avec les filtres Lua" pour plus de détails.
Description: | Met en correspondance un chemin avec un gestionnaire lua |
---|---|
Syntaxe: | LuaMapHandler modele-uri /chemin/vers/lua/script.lua
[nom-fonction] |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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.
LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
Cette directive va faire correspondre des uri comme /photos/show?id=9 au fichier /scripts/photos.lua, et invoquera la fonction de gestionnaire handle_show au niveau de la vm lua après chargement de ce fichier.
LuaMapHandler /bingo /scripts/wombat.lua
Cette directive invoquera la fonction "handle" qui est la valeur par défaut si aucun nom de fonction spécifique n'est spécifié.
Description: | Fournit une fonction Lua pour le filtrage de contenu en sortie |
---|---|
Syntaxe: | LuaOutputFilter filter_name /path/to/lua/script.lua function_name |
Contexte: | configuration globale |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
Compatibilité: | Disponible à partir de la version 2.4.5 du serveur HTTP Apache |
>Cette directive permet d'ajouter un filtre en sortie sous la forme
d'une fonction Lua. A l'instar des filtres en sorties, les filtres en
entrée fonctionnent comme des sous-routines, intervenant dans un premier
temps avant l'envoi du contenu des tampons, puis chaque fois qu'un
paquet de données doit être transmis à la chaîne, et éventuellement
produisant toute donnée à ajouter aux données en sortie. La variable
globale bucket
contient les paquets de données tels qu'ils
sont transmis au script Lua :
LuaOutputFilter myOutputFilter /www/filter.lua output_filter <Files "*.lua"> SetOutputFilter myOutputFilter </Files>
--[[ Exemple de filtre en sortie qui échappe toutes les entités HTML en sortie ]]-- function output_filter(r) coroutine.yield("(Handled by myOutputFilter)<br/>\n") -- Ajoute des données au début de la sortie, -- puis attend des paquets de données à traiter while bucket do -- Pour chaque paquet, faire ... local output = r:escape_html(bucket) -- Echappe les données en sortie coroutine.yield(output) -- Envoie les données traitées à la chaîne end -- plus aucune donnée à traiter. end
Comme les filres en entrée, le filtre en sortie peut interdire ou sauter un filtre s'il est considéré comme indésirable :
function output_filter(r) if not r.content_type:match("text/html") then return -- Empêche tout simplement le filtrage et transmet le contenu original end coroutine.yield() -- attend des paquets de données ... -- insert les filtres ici end
mod_filter
Lorsqu'on utilise un filtre Lua comme fournisseur sous-jacent via la
directive FilterProvider
, le
filtrage ne fonctionnera que si filter-name est identique à
provider-name.
Voir "Modification de contenu avec les filtres Lua" pour plus de détails.
Description: | Ajoute un répertoire au package.cpath de lua |
---|---|
Syntaxe: | LuaPackageCPath /chemin/vers/include/?.soa |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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.
Description: | Ajoute un répertoire au package.path de lua |
---|---|
Syntaxe: | LuaPackagePath /chemin/vers/include/?.lua |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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.
LuaPackagePath /scripts/lib/?.lua LuaPackagePath /scripts/lib/?/init.lua
Description: | Fournit un point d'entrée pour la gestion rapide du traitement de la requête |
---|---|
Syntaxe: | LuaQuickHandler /path/to/script.lua hook_function_name |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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 <Location>
ou
<Directory>
ne
sont pas encore prises en compte, car Les URI n'ont pas encore été
entièrement interprétés.
Cette directive ne peut être
utilisée ni à l'intérieur d'une section <Directory>
ou <Files>
, ni dans un fichier htaccess.
Description: | Spécifie le chemin de base pour la résolution des chemins relatifs dans les directives de mod_lua |
---|---|
Syntaxe: | LuaRoot /chemin/vers/un/répertoire |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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.
Description: | Une valeur parmi once, request, conn, thread -- la valeur par défaut est once |
---|---|
Syntaxe: | LuaScope once|request|conn|thread|server [min] [max] |
Défaut: | LuaScope once |
Contexte: | configuration globale, serveur virtuel, répertoire, .htaccess |
Surcharges autorisées: | All |
Statut: | Extension |
Module: | mod_lua |
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".
min
et max
permettent
de spécifier les nombres minimaux et maximaux d'états lua à stocker
dans la liste.En général, les portées thread
et server
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
thread
ou server
doivent être utilisées car
elles présenteront de meilleures performances. Alors que la portée
thread
fournira les réponses les plus rapides, la portée
server
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 thread
.