1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE manualpage SYSTEM "./style/manualpage.dtd">
3 <?xml-stylesheet type="text/xsl" href="./style/manual.fr.xsl"?>
4 <!-- English Revision : 1055507 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
9 Licensed to the Apache Software Foundation (ASF) under one or more
10 contributor license agreements. See the NOTICE file distributed with
11 this work for additional information regarding copyright ownership.
12 The ASF licenses this file to You under the Apache License, Version 2.0
13 (the "License"); you may not use this file except in compliance with
14 the License. You may obtain a copy of the License at
16 http://www.apache.org/licenses/LICENSE-2.0
18 Unless required by applicable law or agreed to in writing, software
19 distributed under the License is distributed on an "AS IS" BASIS,
20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 See the License for the specific language governing permissions and
22 limitations under the License.
25 <manualpage metafile="expr.xml.meta">
27 <title>Les expressions dans le serveur HTTP Apache</title>
30 <p>Historiquement, il existe de nombreuses variantes dans la syntaxe
31 des expressions permettant d'exprimer une condition dans les
32 différents modules du serveur HTTP Apache. À ce titre, des travaux sont
33 en cours pour n'utiliser qu'une seule variante nommée
34 <em>ap_expr</em>, pour toutes les directives de configuration. Ce
35 document décrit l'interpréteur d'expressions <em>ap_expr</em>.
39 <seealso><directive module="core">If</directive></seealso>
40 <seealso><module>mod_rewrite</module></seealso>
41 <seealso><module>mod_include</module></seealso>
42 <seealso><module>mod_setenvif</module></seealso>
43 <seealso><directive module="mod_ssl">SSLRequire</directive></seealso>
44 <seealso><directive module="mod_filter">FilterProvider</directive></seealso>
46 <section id="grammar">
47 <title>Syntaxe en Forme de Backus-Naur</title>
48 <p>La <a href="http://fr.wikipedia.org/wiki/Forme_de_Backus-Naur">Forme de Backus-Naur</a>
49 (souvent abrégée en BNF, de l'anglais Backus-Naur Form) est une notation permettant de décrire
50 les règles syntaxiques des langages de programmation.
54 expr ::= "<strong>true</strong>" | "<strong>false</strong>"
55 | "<strong>!</strong>" expr
56 | expr "<strong>&&</strong>" expr
57 | expr "<strong>||</strong>" expr
58 | "<strong>(</strong>" expr "<strong>)</strong>"
65 | word "<strong>in</strong>" "<strong>{</strong>" wordlist "<strong>}</strong>"
66 | word "<strong>in</strong>" listfunction
67 | word "<strong>=~</strong>" regex
68 | word "<strong>!~</strong>" regex
71 stringcomp ::= word "<strong>==</strong>" word
72 | word "<strong>!=</strong>" word
73 | word "<strong><</strong>" word
74 | word "<strong><=</strong>" word
75 | word "<strong>></strong>" word
76 | word "<strong>>=</strong>" word
78 integercomp ::= word "<strong>-eq</strong>" word | word "<strong>eq</strong>" word
79 | word "<strong>-ne</strong>" word | word "<strong>ne</strong>" word
80 | word "<strong>-lt</strong>" word | word "<strong>lt</strong>" word
81 | word "<strong>-le</strong>" word | word "<strong>le</strong>" word
82 | word "<strong>-gt</strong>" word | word "<strong>gt</strong>" word
83 | word "<strong>-ge</strong>" word | word "<strong>ge</strong>" word
86 | wordlist "<strong>,</strong>" word
88 word ::= word "<strong>.</strong>" word
90 | "<strong>'</strong>" string "<strong>'</strong>"
91 | "<strong>"</strong>" string "<strong>"</strong>"
99 stringpart ::= cstring
106 variable ::= "<strong>%{</strong>" varname "<strong>}</strong>"
107 | "<strong>%{</strong>" funcname "<strong>:</strong>" funcargs "<strong>}</strong>"
109 rebackref ::= "<strong>$</strong>" [0-9]
111 function ::= funcname "<strong>(</strong>" word "<strong>)</strong>"
113 listfunction ::= listfuncname "<strong>(</strong>" word "<strong>)</strong>"
120 <title>Variables</title>
122 <p>L'interpréteur d'expressions fournit plusieurs variables de la
123 forme <code>%{HTTP_HOST}</code>. Notez que la valeur d'une variable
124 peut dépendre de la phase du traitement de la requête au cours de
125 laquelle elle est évaluée. Par exemple, une expression utilisée dans
126 une directive <directive><If ></directive> sera évaluée avant
127 la phase d'authentification. Par conséquent, la variable
128 <code>%{REMOTE_USER}</code> ne sera pas encore définie à ce stade.</p>
130 <p>Les variables suivantes contiennent la valeur de l'en-tête de
131 requête HTTP correspondant. La <a href="#functions">fonction</a>
132 <code>req</code> permet d'extraire les valeurs des autres en-têtes.</p>
134 <table border="1" style="zebra">
135 <columnspec><column width="1"/></columnspec>
137 <tr><th>Name</th></tr>
138 <tr><td><code>HTTP_ACCEPT</code></td></tr>
139 <tr><td><code>HTTP_FORWARDED</code></td></tr>
140 <tr><td><code>HTTP_HOST</code></td></tr>
141 <tr><td><code>HTTP_PROXY_CONNECTION</code></td></tr>
142 <tr><td><code>HTTP_REFERER</code></td></tr>
143 <tr><td><code>HTTP_USER_AGENT</code></td></tr>
147 <p>Autres variables liées aux requêtes</p>
149 <table border="1" style="zebra">
150 <columnspec><column width=".4"/><column width=".6"/></columnspec>
152 <tr><th>Nom</th><th>Description</th></tr>
153 <tr><td><code>REQUEST_METHOD</code></td>
154 <td>La méthode HTTP de la requête entrante (par exemple
155 <code>GET</code>)</td></tr>
156 <tr><td><code>REQUEST_SCHEME</code></td>
157 <td>Le protocole associé à l'URI de la requête</td></tr>
158 <tr><td><code>REQUEST_URI</code></td>
159 <td>L'URI de la requête</td></tr>
160 <tr><td><code>REQUEST_FILENAME</code></td>
162 <tr><td><code>SCRIPT_FILENAME</code></td>
163 <td>Identique à <code>REQUEST_FILENAME</code></td></tr>
164 <tr><td><code>SCRIPT_USER</code></td>
165 <td>Le nom d'utilisateur du propriétaire du script.</td></tr>
166 <tr><td><code>SCRIPT_GROUP</code></td>
167 <td>Le nom du groupe auquel appartient le script.</td></tr>
168 <tr><td><code>PATH_INFO</code></td>
170 <tr><td><code>QUERY_STRING</code></td>
171 <td>La chaîne de paramètres de la requête courante</td></tr>
172 <tr><td><code>IS_SUBREQ</code></td>
173 <td>"<code>true</code>" si la requête courante est une
174 sous-requête, "<code>false</code>" dans le cas contraire</td></tr>
175 <tr><td><code>THE_REQUEST</code></td>
176 <td>La requête complète (par exemple "<code>GET /index.html
177 HTTP/1.1</code>")</td></tr>
178 <tr><td><code>REMOTE_ADDR</code></td>
179 <td>L'adresse IP de l'hôte distant</td></tr>
180 <tr><td><code>REMOTE_HOST</code></td>
181 <td>Le nom d'hôte de l'hôte distant</td></tr>
182 <tr><td><code>REMOTE_USER</code></td>
183 <td>Le nom de l'utilisateur authentifié (s'il existe)</td></tr>
184 <tr><td><code>REMOTE_IDENT</code></td>
185 <td>Le nom de l'utilisateur défini par <module>mod_ident</module></td></tr>
186 <tr><td><code>SERVER_NAME</code></td>
187 <td>La valeur de la directive <directive
188 module="core">ServerName</directive> du serveur virtuel courant</td></tr>
189 <tr><td><code>SERVER_PORT</code></td>
190 <td>Le port associé au serveur virtuel courant ; voir la
191 directive <directive module="core">ServerName</directive></td></tr>
192 <tr><td><code>SERVER_ADMIN</code></td>
193 <td>La valeur de la directive <directive
194 module="core">ServerAdmin</directive> du serveur virtuel courant</td></tr>
195 <tr><td><code>SERVER_PROTOCOL</code></td>
196 <td>Le protocole utilisé par la requête</td></tr>
197 <tr><td><code>DOCUMENT_ROOT</code></td>
198 <td>La valeur de la directive <directive
199 module="core">DocumentRoot</directive> du serveur virtuel
201 <tr><td><code>AUTH_TYPE</code></td>
202 <td>La valeur de la directive <directive
203 module="mod_authn_core">AuthType</directive> (par exemple
204 "<code>basic</code>")</td></tr>
205 <tr><td><code>CONTENT_TYPE</code></td>
206 <td>Le type de contenu de la réponse</td></tr>
207 <tr><td><code>HANDLER</code></td>
208 <td>Le nom du <a href="handler.html">gestionnaire</a> qui a
209 généré la réponse</td></tr>
210 <tr><td><code>HTTPS</code></td>
211 <td>"<code>on</code>" si la requête utilise https,
212 "<code>off</code>" dans le cas contraire</td></tr>
213 <tr><td><code>IPV6</code></td>
214 <td>"<code>on</code>" si la connexion utilise IPv6,
215 "<code>off</code>" dans le cas contraire</td></tr>
216 <tr><td><code>REQUEST_LOG_ID</code></td>
217 <td>L'identifiant du message d'erreur associé à la requête (voir
218 la directive <directive
219 module="core">ErrorLogFormat</directive>)</td></tr>
220 <tr><td><code>CONN_LOG_ID</code></td>
221 <td>L'identifiant du message d'erreur associé à la connexion
222 (voir la directive <directive
223 module="core">ErrorLogFormat</directive>)</td></tr>
227 <p>Variables diverses</p>
229 <table border="1" style="zebra">
230 <columnspec><column width=".4"/><column width=".6"/></columnspec>
232 <tr><th>Nom</th><th>Description</th></tr>
233 <tr><td><code>TIME_YEAR</code></td>
234 <td>L'année courante (par exemple <code>2010</code>)</td></tr>
235 <tr><td><code>TIME_MON</code></td>
236 <td>Le mois courant (<code>1</code>, ..., <code>12</code>)</td></tr>
237 <tr><td><code>TIME_DAY</code></td>
238 <td>Le jour courant dans le mois</td></tr>
239 <tr><td><code>TIME_HOUR</code></td>
240 <td>Les heures de la date courante (<code>0</code>, ...,
241 <code>23</code>)</td></tr>
242 <tr><td><code>TIME_MIN</code></td>
243 <td>Les minutes de la date courante</td></tr>
244 <tr><td><code>TIME_SEC</code></td>
245 <td>Les secondes de la date courante</td></tr>
246 <tr><td><code>TIME_WDAY</code></td>
247 <td>Le jour de la semaine (à partir de <code>0</code> pour
249 <tr><td><code>TIME</code></td>
250 <td>La date et heure au format <code>20101231235959</code></td></tr>
251 <tr><td><code>SERVER_SOFTWARE</code></td>
252 <td>La chaîne contenant la version du serveur</td></tr>
253 <tr><td><code>API_VERSION</code></td>
254 <td>La date de la version de l'API (module magic number)</td></tr>
257 <p>Certains modules, comme <module>mod_ssl</module>, définissent des
258 variables supplémentaires.</p>
263 <title>Opérateurs binaires</title>
265 <p>À l'exception de quelques opérateurs de comparaison internes, les
266 opérateurs binaires sont de la forme
267 "<code>-[a-zA-Z][a-zA-Z0-9_]+</code>", autrement dit un signe moins
268 et au moins deux caractères. Le nom est insensible à la casse. Les
269 modules peuvent fournir des opérateurs binaires supplémentaires.</p>
272 <title>Opérateurs de comparaison</title>
274 <table border="1" style="zebra">
275 <columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
277 <tr><th>Nom</th><th>Alternative</th> <th>Description</th></tr>
278 <tr><td><code>==</code></td>
279 <td><code>=</code></td>
280 <td>Egalité de chaînes</td></tr>
281 <tr><td><code>!=</code></td>
283 <td>Inégalité de chaînes</td></tr>
284 <tr><td><code><</code></td>
286 <td>Chaîne inférieure à</td></tr>
287 <tr><td><code><=</code></td>
289 <td>Chaîne inférieure ou égale à</td></tr>
290 <tr><td><code>></code></td>
292 <td>Chaîne supérieure à</td></tr>
293 <tr><td><code>>=</code></td>
295 <td>Chaîne supérieure ou égale à</td></tr>
296 <tr><td><code>-eq</code></td>
297 <td><code>eq</code></td>
298 <td>Egalité d'entiers</td></tr>
299 <tr><td><code>-ne</code></td>
300 <td><code>ne</code></td>
301 <td>Inégalité d'entiers</td></tr>
302 <tr><td><code>-lt</code></td>
303 <td><code>lt</code></td>
304 <td>Entier inférieur à</td></tr>
305 <tr><td><code>-le</code></td>
306 <td><code>le</code></td>
307 <td>Entier inférieur ou égal à</td></tr>
308 <tr><td><code>-gt</code></td>
309 <td><code>gt</code></td>
310 <td>Entier supérieur à</td></tr>
311 <tr><td><code>-ge</code></td>
312 <td><code>ge</code></td>
313 <td>Entier supérieur ou égal à</td></tr>
317 <section id="binaryother">
318 <title>Autres opérateurs binaires</title>
320 <table border="1" style="zebra">
321 <columnspec><column width=".2"/><column width=".8"/></columnspec>
323 <tr><th>Nom</th><th>Description</th></tr>
324 <tr><td><code>-ipmatch</code></td>
325 <td>L'adresse IP correspond à adresse/masque</td></tr>
326 <tr><td><code>-strmatch</code></td>
327 <td>la chaîne de gauche correspond au modèle constitué par la
328 chaîne de droite (contenant des caractères génériques *, ?, [])</td></tr>
329 <tr><td><code>-strcmatch</code></td>
330 <td>idem <code>-strmatch</code>, mais insensible à la casse</td></tr>
331 <tr><td><code>-fnmatch</code></td>
332 <td>idem <code>-strmatch</code>, mais les slashes ne sont pas
333 pris en compte par les caractères génériques</td></tr>
340 <title>Opérateurs unaires</title>
342 <p>Les opérateurs unaires sont de la forme "<code>-[a-zA-Z]</code>",
343 autrement dit le signe moins et un caractère. Le nom <em>est</em>
344 sensible à la casse. Les modules peuvent fournir des opérateurs
345 unaires supplémentaires.</p>
347 <table border="1" style="zebra">
348 <columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
350 <tr><th>Nom</th><th>Description</th></tr>
351 <tr><td><code>-n</code></td>
352 <td>Vrai si la chaîne n'est pas vide</td></tr>
353 <tr><td><code>-z</code></td>
354 <td>Vrai si la chaîne est vide</td></tr>
355 <tr><td><code>-T</code></td>
356 <td>Faux si la chaîne est vide, "<code>0</code>",
357 "<code>off</code>", "<code>false</code>", ou "<code>no</code>"
358 (insensibilité à la casse). Vrai dans le cas contraire.</td></tr>
359 <tr><td><code>-R</code></td>
360 <td>Idem "<code>%{REMOTE_ADDR} -ipmatch ...</code>", en plus
367 <section id="functions">
368 <title>Fonctions</title>
370 <p>Normalement, les fonctions dont la valeur est une chaîne acceptent une chaîne
371 comme argument et renvoient une chaîne. Les noms de fonctions sont
372 insensibles à la casse. Les modules peuvent fournir des fonctions
375 <table border="1" style="zebra">
376 <columnspec><column width=".2"/><column width=".8"/></columnspec>
378 <tr><th>Nom</th><th>Description</th></tr>
379 <tr><td><code>req</code>, <code>http</code></td>
380 <td>Lit l'en-tête de requête HTTP</td></tr>
381 <tr><td><code>resp</code></td>
382 <td>Lit l'en-tête de réponse HTTP</td></tr>
383 <tr><td><code>reqenv</code></td>
384 <td>Recherche une variable d'environnement de requête</td></tr>
385 <tr><td><code>osenv</code></td>
386 <td>Recherche une variable d'environnement du système
387 d'exploitation</td></tr>
388 <tr><td><code>note</code></td>
389 <td>Recherche une note de requête</td></tr>
390 <tr><td><code>env</code></td>
391 <td>Renvoie le premier résultat positif de <code>note</code>,
392 <code>reqenv</code>, <code>osenv</code></td></tr>
393 <tr><td><code>tolower</code></td>
394 <td>Convertit une chaîne en minuscules</td></tr>
395 <tr><td><code>toupper</code></td>
396 <td>Convertit une chaîne en majuscules</td></tr>
397 <tr><td><code>escape</code></td>
398 <td>Echappe les caractères spéciaux en codage hexadécimal</td></tr>
399 <tr><td><code>unescape</code></td>
400 <td>"Déséchappe" les chaînes codées en hexadécimal en conservant
401 le codage des caractères spéciaux aux URLs (XXX: describe better)</td></tr>
402 <tr><td><code>file</code></td>
403 <td>Lit le contenu d'un fichier</td></tr>
406 <p>En plus des fonctions dont la valeur est une chaîne, il existe
407 aussi des fonctions dont la valeur est une liste, qui acceptent une
408 chaîne comme argument, et renvoient une liste de mots, autrement dit
409 une liste de chaînes. La liste de mot peut être utilisée avec
410 l'opérateur spécial <code>-in</code>. Les noms de fonctions sont
411 insensibles à la casse. Les modules peuvent fournir des fonctions
414 <p>Il n'existe pas de fonctions internes dont la valeur est une
415 liste. Le module <module>mod_ssl</module> fournit la fonction
416 <code>PeerExtList</code>. Voir la description de la directive
417 <directive module="mod_ssl">SSLRequire</directive> pour plus de
418 détails (notez que la fonction <code>PeerExtList</code> peut aussi
419 être utilisée en dehors de la directive <directive
420 module="mod_ssl">SSLRequire</directive>).</p>
425 <title>Autres</title>
427 <table border="1" style="zebra">
428 <columnspec><column width=".2"/><column width=".2"/><column width=".6"/></columnspec>
430 <tr><th>Nom</th><th>Alternative</th> <th>Description</th></tr>
431 <tr><td><code>-in</code></td>
432 <td><code>in</code></td>
433 <td>chaîne contenue dans une liste de chaînes</td></tr>
434 <tr><td><code>/regexp/</code></td>
435 <td><code>m#regexp#</code></td>
436 <td>Expression rationnelle (la seconde forme permet de spécifier
437 des délimiteurs autres que /)</td></tr>
438 <tr><td><code>/regexp/i</code></td>
439 <td><code>m#regexp#i</code></td>
440 <td>Expression rationnelle insensible à la casse</td></tr>
441 <tr><td><code>$0 ... $9</code></td>
443 <td>Références arrières dans les expressions rationnelles</td></tr>
446 <section id="rebackref">
447 <title>Références arrières dans les expressions rationnelles</title>
448 <p>Les chaînes <code>$0</code> ... <code>$9</code> permettent de
449 référencer les groupes de capture en provenance d'expressions
450 rationnelles précédemment exécutées et mises en correspondance avec
451 succès. Elles ne peuvent normalement être utilisées que dans la
452 même expression que celle mise en correspondance, mais certains
453 modules permettent de les utiliser de manière spéciale.</p>