<-
Apache > Serveur HTTP > Documentation > Version 2.4 > Modules

Module Apache mod_rewrite

Langues Disponibles:  en  |  fr 

Description:Ce module fournit un moteur de réécriture à base de règles permettant de réécrire les URLs des requêtes à la volée
Statut:Extension
Identificateur de Module:rewrite_module
Fichier Source:mod_rewrite.c

Sommaire

Le module mod_rewrite utilise un moteur de réécriture à base de règles, basé sur un interpréteur d'expressions rationnelles PCRE, pour réécrire les URLs à la volée. Par défaut, mod_rewrite met en correspondance une URL avec le système de fichiers. Cependant, on peut aussi l'utiliser pour rediriger une URL vers une autre URL, ou pour invoquer une requête interne à destination du mandataire.

mod_rewrite fournit une méthode souple et puissante pour manipuler les URLs en utilisant un nombre illimité de règles. Chaque règle peut être associée à un nombre illimité de conditions, afin de vous permettre de réécrire les URLs en fonction de variables du serveur, de variables d'environnement, d'en-têtes HTTP, ou de repères temporels.

mod_rewrite agit sur la totalité de l'URL, y compris la partie chemin. Une règle de réécriture peut être invoquée dans apache2.conf ou dans un fichier .htaccess. Le chemin généré par une règle de réécriture peut inclure une chaîne de paramètres, ou peut renvoyer vers un traitement secondaire interne, une redirection vers une requête externe ou vers le mandataire interne.

Vous trouverez d'avantage de détails, discussions et exemples dans la documentation détaillée sur mod_rewrite.

Directives

Sujets

top

Journalisation

mod_rewrite offre une journalisation détaillée de ses actions aux niveaux de journalisation trace1 à trace8. Le niveau de journalisation peut être défini de manière spécifique à mod_rewrite via la directive LogLevel : jusqu'au niveau debug aucune action n'est journalisée, alors qu'elles le sont pratiquement toutes au niveau trace8.

L'utilisation d'un niveau de journalisation élevé pour mod_rewrite va ralentir votre serveur HTTP Apache de manière dramatique ! N'utilisez un niveau de journalisation supérieur à trace2 qu'à des fins de débogage !

Exemple

      LogLevel alert rewrite:trace3
      

RewriteLog

Ceux qui sont familiers avec les versions précédentes de mod_rewrite vont probablement rechercher en vain les directives RewriteLog et RewriteLogLevel. Elles ont été en effet remplacées par une configuration de la journalisation par module, comme mentionné plus haut.

Pour extraire les traces spécifiques à mod_rewrite, affichez le fichier journal en redirigeant la sortie vers grep :

tail -f error_log|fgrep '[rewrite:'

top

RewriteBase Directive

Description:Définit l'URL de base pour les réécritures au niveau répertoire
Syntaxe:RewriteBase chemin URL
Défaut:Pas de valeur par défaut
Contexte:répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteBase permet de spécifier le préfixe d'URL à utiliser dans un contexte de répertoire (htaccess) pour les directives RewriteRule qui réécrivent vers un chemin relatif.

Cette directive est obligatoire si vous utilisez un chemin relatif dans une substitution, et dans un contexte de répertoire (htaccess), sauf si au moins une de ces conditions est vérifiée :

Dans l'exemple ci-dessous, la directive RewriteBase est nécessaire afin d'éviter une réécriture en http://example.com/opt/myapp-1.2.3/welcome.html car la ressource n'était pas relative à la racine des documents. Cette erreur de configuration aurait conduit le serveur à rechercher un répertoire "opt" à la racine des documents.

DocumentRoot /var/www/example.com
Alias /myapp /opt/myapp-1.2.3
<Directory /opt/myapp-1.2.3>
 RewriteEngine On
    RewriteBase /myapp/
    RewriteRule ^index\.html$  welcome.html
</Directory>
top

RewriteCond Directive

Description:Définit une condition qui devra être satisfaite pour que la réécriture soit effectuée
Syntaxe: RewriteCond chaîne de test expression de comparaison
Contexte:configuration du serveur, serveur virtuel, répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteCond permet de définir une condition d'exécution d'une règle. Une ou plusieurs conditions RewriteCond peuvent précéder une directive RewriteRule. La règle de réécriture correspondante n'est ainsi exécutée que si ces conditions sont satisfaites, et si l'URI correspond au modèle spécifié dans la règle.

TestString est une chaîne qui peut contenir les extensions suivantes en plus du texte simple :

Si la chaîne de test contient la valeur spéciale expr, expression de comparaison sera traité en tant qu'expression rationnelle de type ap_expr. Si des en-têtes HTTP sont référencés dans l'expression rationnelle, et si le drapeau novary n'est pas activé, ils seront ajoutés à l'en-tête Vary.

Autres points à connaître ::

  1. Les variables SCRIPT_FILENAME et REQUEST_FILENAME contiennent toutes deux la valeur du champ filename de la structure interne request_recdu serveur HTTP Apache. Le premier nom correspond au nom de variable bien connu CGI, alors que le second est l'équivalent de REQUEST_URI (qui contient la valeur du champ uri de request_rec).

    Si une substitution intervient et si la réécriture se poursuit, la valeur des deux variables sera mise à jour en conséquence.

    Dans le contexte du serveur principal (c'est à dire avant que la requête ne soit mise en correspondance avec le système de fichiers), SCRIPT_FILENAME et REQUEST_FILENAME ne peuvent pas contenir le chemin entier dans le système de fichiers local car ce chemin b'est pas connu à ce stade du traitement. Dans ce cas, les deux variables contiendront la valeur de REQUEST_URI. Pour obtenir le chemin complet de la requête dans le système de fichiers local dans le contexte du serveur principal, utilisez une référence avant à base d'URL %{LA-U:REQUEST_FILENAME} pour déterminer la valeur finale de REQUEST_FILENAME.

  2. %{ENV:variable}, où variable peut correspondre à une variable d'environnement quelconque.
  3. %{ENV:variable} est aussi disponible, où variable peut correspondre à toute variable d'environnement. Peut être consulté via des structures internes d'Apache httpd et (si on ne les trouve pas ici) via la fonction getenv() à partir du processus du serveur Apache httpd.
  4. Que mod_ssl soit chargé ou non, on peut utiliser %{SSL:variable}, où variable peut être remplacé par le nom d'une variable d'environnement SSL . Si mod_ssl n'est pas chargé, cette variable contiendra toujours une chaîne vide. Exemple : %{SSL:SSL_CIPHER_USEKEYSIZE} pourra contenir la valeur 128.
  5. On peut utiliser %{HTTP:en-tête}, où en-tête peut correspondre à tout nom d'en-tête MIME HTTP, pour extraire la valeur d'un en-tête envoyé dans la requête HTTP. Par exemple, %{HTTP:Proxy-Connection} contiendra la valeur de l'en-tête HTTP "Proxy-Connection:". Si on utilise un en-tête HTTP dans une condition, et si cette condition est évaluée à vrai pour la requête, cet en-tête sera ajouté à l'en-tête Vary de la réponse. Il ne le sera pas si la condition est évaluée à faux. L'ajout de l'en-tête HTTP à l'en-tête Vary est nécessaire à une mise en cache appropriée.

    Il faut garder à l'esprit que les conditions suivent une logique de cout-circuit si le drapeau 'ornext|OR' est utilisé, et que de ce fait, certaines d'entre elles ne seront pas évaluées.

  6. A des fins de référence avant, on peut utiliser, %{LA-U:variable}, qui permet d'effectuer une sous-requête interne à base d'URL, afin de déterminer la valeur finale de variable. Ceci permet d'accéder à la valeur d'une variable pour la réécriture inconnue à ce stade du traitement, mais qui sera définie au cours d'une phase ultérieure.

    Par exemple, pour effectuer une réécriture dépendant de la variable REMOTE_USER dans le contexte du serveur principal (fichier apache2.conf), vous devez utiliser %{LA-U:REMOTE_USER} - cette variable est définie par la phase d'autorisation qui intervient après la phase de traduction d'URL (pendant laquelle mod_rewrite opère).

    Par contre, comme mod_rewrite implémente son contexte de répertoire (fichier .htaccess) via la phase Fixup de l'API, et comme la phase d'autorisation intervient avant cette dernière, vous pouvez vous contenter d'utiliser %{REMOTE_USER} dans ce contexte.

  7. %{LA-F:variable} peut être utilisée pour effectuer une sous-requête interne (basée sur le nom de fichier), afin de déterminer la valeur finale de variable. La plupart du temps, elle est identique à LA-U (voir ci-dessus).

expression de comparaison est une expression rationnelle qui est appliquée à l'instance actuelle de chaîne de test. chaîne de test est d'abord évaluée, puis comparée à l'expression de comparaison.

expression de comparaison est en général une expression rationnelle compatible perl, mais vous disposez des syntaxes supplémentaires suivantes pour effectuer d'autres tests utiles sur chaîne de test :

  1. Vous pouvez préfixer l'expression avec un caractère '!' (point d'exclamation) pour indiquer une expression de non-correspondance.
  2. Vous pouvez effectuer des comparaisons lexicographiques de chaînes :
    • '<expression' (inférieur au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est inférieure au sens lexicographique à l'expression.
    • '>expression' (supérieur au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est supérieure au sens lexicographique à l'expression.
    • '=expression' (égal au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est égale au sens lexicographique à l'expression (les deux chaînes sont exactement identiques, caractère pour caractère). Si expression est "" (deux guillemets), chaîne de test est comparée à la chaîne vide.
    • '<=expression de comparaison' (inférieur ou égal à au sens lexicographique)
      Considère l'expression de comparaison comme une chaîne de caractères et la compare au sens lexicographique à la chaîne de test. Vrai si chaîne de test précède lexicographiquement expression de comparaison, ou est égale à expression de comparaison (les deux chaînes sont identiques, caractère pour caractère).
    • '>=expression de comparaison' (supérieur ou égal à au sens lexicographique)
      Considère l'expression de comparaison comme une chaîne de caractères et la compare au sens lexicographique à la chaîne de test. Vrai si chaîne de test suit lexicographiquement expression de comparaison, ou est égale à expression de comparaison (les deux chaînes sont identiques, caractère pour caractère).
  3. Vous pouvez effectuer des comparaisons d'entiers :
    • '-eq' (est numériquement égal à)
      La chaîne de test est considérée comme un entier, et est comparée numériquement à l'expression de comparaison. Vrai si les deux expressions sont numériquement égales.
    • '-ge' (est numériquement supérieur ou égal à)
      La chaîne de test est considérée comme un entier, et est comparée numériquement à l'expression de comparaison. Vrai si chaîne de test est numériquement supérieure ou égale à expression de comparaison.
    • '-gt' (est numériquement supérieur à)
      La chaîne de test est considérée comme un entier, et est comparée numériquement à l'expression de comparaison. Vrai si chaîne de test est numériquement supérieure à expression de comparaison.
    • '-le' (est numériquement inférieur ou égal à)
      La chaîne de test est considérée comme un entier, et est comparée numériquement à l'expression de comparaison. Vrai si chaîne de test est numériquement inférieure ou égale à expression de comparaison. Attention à la confusion avec le drapeau -l en utilisant la variante the -L ou -h.
    • '-lt' (est numériquement inférieur à)
      La chaîne de test est considérée comme un entier, et est comparée numériquement à l'expression de comparaison. Vrai si chaîne de test est numériquement inférieure à expression de comparaison. Attention à la confusion avec le drapeau -l en utilisant la variante the -L ou -h.
  4. Vous pouvez effectuer différents tests sur les attributs de fichier :
    • '-d' (est un répertoire - directory)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un répertoire.
    • '-f' (est un fichier régulier)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un fichier régulier.
    • '-F' (test de l'existence d'un fichier via une sous-requête)
      Vérifie si chaîne de test est un fichier valide, accessible à travers tous les contrôles d'accès du serveur actuellement configurés pour ce chemin. C'est une sous-requête interne qui effectue cette vérification - à utiliser avec précautions car les performances du serveur peuvent s'en trouver affectées !
    • '-H' (est un lien symbolique, selon la convention bash)
      Voir -l.
    • '-l' (est un lien symbolique)
      Considère la chaîne de test comme un chemin et vérifie son existence et si elle est un lien symbolique. On peut aussi utiliser la convention bash -L ou -h lorsqu'il y a risque de confusion avec les tests -lt ou -le.
    • '-L' (est un lien symbolique, selon la convention bash)
      Voir -l.
    • '-s' (est un fichier régulier d'une certaine taille)
      Considère la chaîne de test comme un chemin et vérifie son existence et si elle est un fichier régulier d'une taille supérieure à zéro.
    • '-U' (test de l'existence d'une URL via une sous-requête)
      Vérifie si chaîne de test est une URL v