expr.xml.fr revision c3a2738228cb6ba4a48c425711e728d3410a458e
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!-- English Revision : 1151373 -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<manualpage metafile="expr.xml.meta">
<title>Les expressions dans le serveur HTTP Apache</title>
<summary>
<p>Historiquement, il existe de nombreuses variantes dans la syntaxe
des expressions permettant d'exprimer une condition dans les
différents modules du serveur HTTP Apache. À ce titre, des travaux sont
en cours pour n'utiliser qu'une seule variante nommée
<em>ap_expr</em>, pour toutes les directives de configuration. Ce
document décrit l'interpréteur d'expressions <em>ap_expr</em>.
</p>
<p>Le type d'expression <em>ap_expr</em> est appelé à remplacer la
plupart des autres types d'expressions dans HTTPD. Par exemple, la
directive obsolète <directive
module="mod_ssl">SSLRequire</directive> peut être remplacée par la
directive <a href="mod/mod_authz_core.html#reqexpr">Require
expr</a>.
</p>
</summary>
<seealso><directive module="core">If</directive></seealso>
<seealso><directive module="core" type="section">If</directive></seealso>
<seealso><directive module="core" type="section">ElseIf</directive></seealso>
<seealso><directive module="core" type="section">Else</directive></seealso>
<seealso><directive module="mod_rewrite">RewriteCond</directive></seealso>
<seealso><directive module="mod_setenvif">SetEnvIfExpr</directive></seealso>
<seealso><directive module="mod_filter">FilterProvider</directive></seealso>
<seealso><directive module="mod_ssl">SSLRequire</directive></seealso>
<seealso><directive module="mod_log_debug">LogMessage</directive></seealso>
<seealso><module>mod_include</module></seealso>
<section id="grammar">
<title>Syntaxe en Forme de Backus-Naur</title>
(souvent abrégée en BNF, de l'anglais Backus-Naur Form) est une notation permettant de décrire
les règles syntaxiques des langages de programmation.
</p>
<blockquote>
<pre>
expr ::= "<strong>true</strong>" | "<strong>false</strong>"
| "<strong>!</strong>" expr
| expr "<strong>&&</strong>" expr
| expr "<strong>||</strong>" expr
| "<strong>(</strong>" expr "<strong>)</strong>"
| comp
comp ::= stringcomp
| integercomp
| unaryop word
| word binaryop word
| word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
| word "<strong>in</strong>" listfunction
| word "<strong>=~</strong>" regex
| word "<strong>!~</strong>" regex
stringcomp ::= word "<strong>==</strong>" word
| word "<strong>!=</strong>" word
| word "<strong><</strong>" word
| word "<strong><=</strong>" word
| word "<strong>></strong>" word
| word "<strong>>=</strong>" word
integercomp ::= word "<strong>-eq</strong>" word | word "<strong>eq</strong>" word
| word "<strong>-ne</strong>" word | word "<strong>ne</strong>" word
| word "<strong>-lt</strong>" word | word "<strong>lt</strong>" word
| word "<strong>-le</strong>" word | word "<strong>le</strong>" word
| word "<strong>-gt</strong>" word | word "<strong>gt</strong>" word
| word "<strong>-ge</strong>" word | word "<strong>ge</strong>" word
wordlist ::= word
| wordlist "<strong>,</strong>" word
word ::= word "<strong>.</strong>" word
| digit
| "<strong>'</strong>" string "<strong>'</strong>"
| "<strong>"</strong>" string "<strong>"</strong>"
| variable
| rebackref
| function
string ::= stringpart
| string stringpart
stringpart ::= cstring
| variable
| rebackref
cstring ::= ...
digit ::= [0-9]+
variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
| "<strong>%{</strong>" funcname "<strong>:</strong>" funcargs "<strong>}</strong>"
rebackref ::= "<strong>$</strong>" [0-9]
function ::= funcname "<strong>(</strong>" word "<strong>)</strong>"
listfunction ::= listfuncname "<strong>(</strong>" word "<strong>)</strong>"
</pre>
</blockquote>
</section>
<section id="vars">
<title>Variables</title>
<p>L'interpréteur d'expressions fournit plusieurs variables de la
forme <code>%{HTTP_HOST}</code>. Notez que la valeur d'une variable
peut dépendre de la phase du traitement de la requête au cours de
laquelle elle est évaluée. Par exemple, une expression utilisée dans
une directive <directive><If ></directive> sera évaluée avant
la phase d'authentification. Par conséquent, la variable
<code>%{REMOTE_USER}</code> ne sera pas encore définie à ce stade.</p>
<p>Les variables suivantes contiennent la valeur de l'en-tête de
requête HTTP correspondant. La <a href="#functions">fonction</a>
<code>req</code> permet d'extraire les valeurs des autres en-têtes.</p>
<table border="1" style="zebra">
<columnspec><column width="1"/></columnspec>
<tr><th>Nom</th></tr>
<tr><td><code>HTTP_ACCEPT</code></td></tr>
<tr><td><code>HTTP_FORWARDED</code></td></tr>
<tr><td><code>HTTP_HOST</code></td></tr>
<tr><td><code>HTTP_PROXY_CONNECTION</code></td></tr>
<tr><td><code>HTTP_REFERER</code></td></tr>
<tr><td><code>HTTP_USER_AGENT</code></td></tr>
</table>
<p>Autres variables liées aux requêtes</p>
<table border="1" style="zebra">
<columnspec><column width=".4"/><column width=".6"/></columnspec>
<tr><th>Nom</th><th>Description</th></tr>
<tr><td><code>REQUEST_METHOD</code></td>
<td>La méthode HTTP de la requête entrante (par exemple
<code>GET</code>)</td></tr>
<tr><td><code>REQUEST_SCHEME</code></td>
<td>Le protocole associé à l'URI de la requête</td></tr>
<tr><td><code>REQUEST_URI</code></td>
<td>L'URI de la requête</td></tr>
<tr><td><code>DOCUMENT_URI</code></td>
<td>Idem REQUEST_URI</td></tr>
<tr><td><code>REQUEST_FILENAME</code></td>
<td>Le chemin complet dans le système de fichiers local du
fichier ou du script correspondant à la requête, si le serveur
l'a dèjà déterminé à l'instant où <code>REQUEST_FILENAME</code>
est référencée. Dans le cas contraire, comme dans un
contexte de serveur virtuel, même valeur que <code>REQUEST_URI</code> </td></tr>
<tr><td><code>SCRIPT_FILENAME</code></td>
<td>Identique à <code>REQUEST_FILENAME</code></td></tr>
<tr><td><code>LAST_MODIFIED</code></td>
<td>La date et heure de dernière modification du fichier au
format <code>20101231235959</code>, si elle est déjà connue du
serveur au moment où <code>LAST_MODIFIED</code> est référencé.
</td></tr>
<tr><td><code>SCRIPT_USER</code></td>
<td>Le nom d'utilisateur du propriétaire du script.</td></tr>
<tr><td><code>SCRIPT_GROUP</code></td>
<td>Le nom du groupe auquel appartient le script.</td></tr>
<tr><td><code>PATH_INFO</code></td>
<td>L'information relative au nom de chemin située en fin, voir
la directive <directive module="core">AcceptPathInfo</directive></td></tr>
<tr><td><code>QUERY_STRING</code></td>
<td>La chaîne de paramètres de la requête courante</td></tr>
<tr><td><code>IS_SUBREQ</code></td>
<td>"<code>true</code>" si la requête courante est une
sous-requête, "<code>false</code>" dans le cas contraire</td></tr>
<tr><td><code>THE_REQUEST</code></td>
<tr><td><code>REMOTE_ADDR</code></td>
<td>L'adresse IP de l'hôte distant</td></tr>
<tr><td><code>REMOTE_HOST</code></td>
<td>Le nom d'hôte de l'hôte distant</td></tr>
<tr><td><code>REMOTE_USER</code></td>
<td>Le nom de l'utilisateur authentifié (s'il existe)</td></tr>
<tr><td><code>REMOTE_IDENT</code></td>
<td>Le nom de l'utilisateur défini par <module>mod_ident</module></td></tr>
<tr><td><code>SERVER_NAME</code></td>
<td>La valeur de la directive <directive
module="core">ServerName</directive> du serveur virtuel courant</td></tr>
<tr><td><code>SERVER_PORT</code></td>
<td>Le port associé au serveur virtuel courant ; voir la
directive <directive module="core">ServerName</directive></td></tr>
<tr><td><code>SERVER_ADMIN</code></td>
<td>La valeur de la directive <directive
module="core">ServerAdmin</directive> du serveur virtuel courant</td></tr>
<tr><td><code>SERVER_PROTOCOL</code></td>
<td>Le protocole utilisé par la requête</td></tr>
<tr><td><code>DOCUMENT_ROOT</code></td>
<td>La valeur de la directive <directive
module="core">DocumentRoot</directive> du serveur virtuel
courant</td></tr>
<tr><td><code>AUTH_TYPE</code></td>
<td>La valeur de la directive <directive
module="mod_authn_core">AuthType</directive> (par exemple
"<code>basic</code>")</td></tr>
<tr><td><code>CONTENT_TYPE</code></td>
<td>Le type de contenu de la réponse</td></tr>
<tr><td><code>HANDLER</code></td>
généré la réponse</td></tr>
<tr><td><code>HTTPS</code></td>
<td>"<code>on</code>" si la requête utilise https,
"<code>off</code>" dans le cas contraire</td></tr>
<tr><td><code>IPV6</code></td>
<td>"<code>on</code>" si la connexion utilise IPv6,
"<code>off</code>" dans le cas contraire</td></tr>
<tr><td><code>REQUEST_STATUS</code></td>
<td>Le code d'erreur HTTP de la requête</td></tr>
<tr><td><code>REQUEST_LOG_ID</code></td>
<td>L'identifiant du message d'erreur associé à la requête (voir
la directive <directive
module="core">ErrorLogFormat</directive>)</td></tr>
<tr><td><code>CONN_LOG_ID</code></td>
<td>L'identifiant du message d'erreur associé à la connexion
(voir la directive <directive
module="core">ErrorLogFormat</directive>)</td></tr>
</table>
<p>Variables diverses</p>
<table border="1" style="zebra">
<columnspec><column width=".4"/><column width=".6"/></columnspec>
<tr><th>Nom</th><th>Description</th></tr>
<tr><td><code>TIME_YEAR</code></td>
<td>L'année courante (par exemple <code>2010</code>)</td></tr>
<tr><td><code>TIME_MON</code></td>
<td>Le mois courant (<code>1</code>, ..., <code>12</code>)</td></tr>
<tr><td><code>TIME_DAY</code></td>
<td>Le jour courant dans le mois</td></tr>
<tr><td><code>TIME_HOUR</code></td>
<td>Les heures de la date courante (<code>0</code>, ...,
<code>23</code>)</td></tr>
<tr><td><code>TIME_MIN</code></td>
<td>Les minutes de la date courante</td></tr>
<tr><td><code>TIME_SEC</code></td>
<td>Les secondes de la date courante</td></tr>
<tr><td><code>TIME_WDAY</code></td>
<td>Le jour de la semaine (à partir de <code>0</code> pour
dimanche)</td></tr>
<tr><td><code>TIME</code></td>
<td>La date et heure au format <code>20101231235959</code></td></tr>
<tr><td><code>SERVER_SOFTWARE</code></td>
<td>La chaîne contenant la version du serveur</td></tr>
<tr><td><code>API_VERSION</code></td>
<td>La date de la version de l'API (module magic number)</td></tr>
</table>
<p>Certains modules, comme <module>mod_ssl</module>, définissent des
variables supplémentaires.</p>
</section>
<section id="binop">
<title>Opérateurs binaires</title>
<p>À l'exception de quelques opérateurs de comparaison internes, les
opérateurs binaires sont de la forme
"<code>-[a-zA-Z][a-zA-Z0-9_]+</code>", autrement dit un signe moins
et au moins deux caractères. Le nom est insensible à la casse. Les
modules peuvent fournir des opérateurs binaires supplémentaires.</p>
<section id="comp">
<title>Opérateurs de comparaison</title>
<table border="1" style="zebra">
<columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
<tr><th>Nom</th><th>Alternative</th> <th>Description</th></tr>
<tr><td><code>==</code></td>
<td><code>=</code></td>
<td>Egalité de chaînes</td></tr>
<tr><td><code>!=</code></td>
<td></td>
<td>Inégalité de chaînes</td></tr>
<tr><td><code><</code></td>
<td></td>
<td>Chaîne inférieure à</td></tr>
<tr><td><code><=</code></td>
<td></td>
<td>Chaîne inférieure ou égale à</td></tr>
<tr><td><code>></code></td>
<td></td>
<td>Chaîne supérieure à</td></tr>
<tr><td><code>>=</code></td>
<td></td>
<td>Chaîne supérieure ou égale à</td></tr>
<tr><td><code>-eq</code></td>
<td><code>eq</code></td>
<td>Egalité d'entiers</td></tr>
<tr><td><code>-ne</code></td>
<td><code>ne</code></td>
<td>Inégalité d'entiers</td></tr>
<tr><td><code>-lt</code></td>
<td><code>lt</code></td>
<td>Entier inférieur à</td></tr>
<tr><td><code>-le</code></td>
<td><code>le</code></td>
<td>Entier inférieur ou égal à</td></tr>
<tr><td><code>-gt</code></td>
<td><code>gt</code></td>
<td>Entier supérieur à</td></tr>
<tr><td><code>-ge</code></td>
<td><code>ge</code></td>
<td>Entier supérieur ou égal à</td></tr>
</table>
</section>
<section id="binaryother">
<title>Autres opérateurs binaires</title>
<table border="1" style="zebra">
<columnspec><column width=".2"/><column width=".8"/></columnspec>
<tr><th>Nom</th><th>Description</th></tr>
<tr><td><code>-ipmatch</code></td>
<tr><td><code>-strmatch</code></td>
<td>la chaîne de gauche correspond au modèle constitué par la
chaîne de droite (contenant des caractères génériques *, ?, [])</td></tr>
<tr><td><code>-strcmatch</code></td>
<td>idem <code>-strmatch</code>, mais insensible à la casse</td></tr>
<tr><td><code>-fnmatch</code></td>
<td>idem <code>-strmatch</code>, mais les slashes ne sont pas
pris en compte par les caractères génériques</td></tr>
</table>
</section>
</section>
<section id="unnop">
<title>Opérateurs unaires</title>
<p>Les opérateurs unaires acceptent un seul argument et sont
de la forme "<code>-[a-zA-Z]</code>",
autrement dit le signe moins et un caractère. Le nom <em>est</em>
sensible à la casse. Les modules peuvent fournir des opérateurs
unaires supplémentaires.</p>
<table border="1" style="zebra">
<columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
<tr><th>Nom</th><th>Description</th><th>Restreint</th></tr>
<tr><td><code>-d</code></td>
<td>L'argument est traité comme un nom de fichier.
Vrai si le fichier existe et correspond à un
répertoire</td><td>oui</td></tr>
<tr><td><code>-e</code></td>
<td>L'argument est traité comme un nom de fichier. Vrai si le
fichier (ou dir ou special) existe</td><td>oui</td></tr>
<tr><td><code>-f</code></td>
<td>L'argument est traité comme un nom de fichier. Vrai si le
fichier existe et correspond à un fichier
régulier</td><td>oui</td></tr>
<tr><td><code>-L</code></td>
<td>L'argument est traité comme un nom de fichier. Vrai si le
fichier existe et correspond à un lien
symbolique</td><td>oui</td></tr>
<tr><td><code>-h</code></td>
<td>L'argument est traité comme un nom de fichier. Vrai si le
fichier existe et correspond à un lien symbolique
(identique à <code>-L</code>)</td><td>oui</td></tr>
<tr><td><code>-F</code></td>
<td>Vrai si la chaîne correspond a un fichier valide, accessible
avec tous les contrôles d'accès configurés pour ce chemin. A
cette fin, une sous-requête effectue la vérification, et vous
devez utiliser ce drapeau avec soin car il peut impacter les
performances de votre serveur !</td><td></td></tr>
<tr><td><code>-U</code></td>
<td>Vrai si la chaîne correspond a une URL valide, accessible
avec tous les contrôles d'accès configurés pour ce chemin. A
cette fin, une sous-requête effectue la vérification, et vous
devez utiliser ce drapeau avec soin car il peut impacter les
performances de votre serveur !</td><td></td></tr>
<tr><td><code>-A</code></td>
<td>Alias pour <code>-U</code></td><td></td></tr>
<tr><td><code>-n</code></td>
<td>Vrai si la chaîne n'est pas vide</td><td></td></tr>
<tr><td><code>-z</code></td>
<td>Vrai si la chaîne est vide</td><td></td></tr>
<tr><td><code>-T</code></td>
<td>Faux si la chaîne est vide, "<code>0</code>",
"<code>off</code>", "<code>false</code>", ou "<code>no</code>"
(insensibilité à la casse). Vrai dans le cas contraire.</td><td></td></tr>
<tr><td><code>-R</code></td>
<td>Idem "<code>%{REMOTE_ADDR} -ipmatch ...</code>", en plus
efficace
</td><td></td></tr>
</table>
<p>Les opérateurs marqués comme "restreints" ne sont pas disponibles
avec certains modules comme <module>mod_include</module>.</p>
</section>
<section id="functions">
<title>Fonctions</title>
<p>Normalement, les fonctions dont la valeur est une chaîne acceptent une chaîne
comme argument et renvoient une chaîne. Les noms de fonctions sont
insensibles à la casse. Les modules peuvent fournir des fonctions
supplémentaires.</p>
<table border="1" style="zebra">
<columnspec><column width=".2"/><column width=".8"/></columnspec>
<tr><th>Nom</th><th>Description</th><th>Restreint</th></tr>
<tr><td><code>req</code>, <code>http</code></td>
<td>Lit l'en-tête de requête HTTP</td><td></td></tr>
<tr><td><code>resp</code></td>
<td>Lit l'en-tête de réponse HTTP</td><td></td></tr>
<tr><td><code>reqenv</code></td>
<td>Recherche une variable d'environnement de requête</td><td></td></tr>
<tr><td><code>osenv</code></td>
<td>Recherche une variable d'environnement du système
d'exploitation</td><td></td></tr>
<tr><td><code>note</code></td>
<td>Recherche une note de requête</td><td></td></tr>
<tr><td><code>env</code></td>
<td>Renvoie le premier résultat positif de <code>note</code>,
<code>reqenv</code>, <code>osenv</code></td><td></td></tr>
<tr><td><code>tolower</code></td>
<td>Convertit une chaîne en minuscules</td><td></td></tr>
<tr><td><code>toupper</code></td>
<td>Convertit une chaîne en majuscules</td><td></td></tr>
<tr><td><code>escape</code></td>
<td>Echappe les caractères spéciaux en codage hexadécimal</td><td></td></tr>
<tr><td><code>unescape</code></td>
<td>"Déséchappe" les chaînes codées
en hexadécimal, en ne gardant encodés que les slashes; renvoie la chaîne vide
si la séquence %00 est rencontrée</td><td></td></tr>
<tr><td><code>file</code></td>
<td>Lit le contenu d'un fichier</td><td>oui</td></tr>
<tr><td><code>filesize</code></td>
<td>Renvoie la taille d'un fichier (ou 0 si le fichier n'existe
pas ou ne correspond pas à un fichier régulier)</td><td>oui</td></tr>
</table>
<p>Les fonctions marquées comme "restreints" ne sont pas disponibles
avec certains modules comme <module>mod_include</module>.</p>
<p>En plus des fonctions dont la valeur est une chaîne, il existe
aussi des fonctions dont la valeur est une liste, qui acceptent une
chaîne comme argument, et renvoient une liste de mots, autrement dit
une liste de chaînes. La liste de mot peut être utilisée avec
l'opérateur spécial <code>-in</code>. Les noms de fonctions sont
insensibles à la casse. Les modules peuvent fournir des fonctions
supplémentaires.</p>
<p>Il n'existe pas de fonctions internes dont la valeur est une
liste. Le module <module>mod_ssl</module> fournit la fonction
<code>PeerExtList</code>. Voir la description de la directive
<directive module="mod_ssl">SSLRequire</directive> pour plus de
détails (notez que la fonction <code>PeerExtList</code> peut aussi
être utilisée en dehors de la directive <directive
module="mod_ssl">SSLRequire</directive>).</p>
</section>
<section id="other">
<title>Autres</title>
<table border="1" style="zebra">
<columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
<tr><th>Nom</th><th>Alternative</th> <th>Description</th></tr>
<tr><td><code>-in</code></td>
<td><code>in</code></td>
<td>chaîne contenue dans une liste de chaînes</td></tr>
<tr><td><code>/regexp/</code></td>
<td><code>m#regexp#</code></td>
<td>Expression rationnelle (la seconde forme permet de spécifier
des délimiteurs autres que /)</td></tr>
<tr><td><code>/regexp/i</code></td>
<td><code>m#regexp#i</code></td>
<td>Expression rationnelle insensible à la casse</td></tr>
<tr><td><code>$0 ... $9</code></td>
<td></td>
<td>Références arrières dans les expressions rationnelles</td></tr>
</table>
<section id="rebackref">
<title>Références arrières dans les expressions rationnelles</title>
<p>Les chaînes <code>$0</code> ... <code>$9</code> permettent de
référencer les groupes de capture en provenance d'expressions
rationnelles précédemment exécutées et mises en correspondance avec
succès. Elles ne peuvent normalement être utilisées que dans la
même expression que celle mise en correspondance, mais certains
modules permettent de les utiliser de manière spéciale.</p>
</section>
</section>
</manualpage>