Module Apache mod_dir

Directive DirectoryCheckHandler

La directive DirectoryCheckHandler permet de faire en sorte que mod_dir recherche un index de répertoire ou ajoute des slashes de fin lorsqu'un autre gestionnaire à été défini pour l'URL considérée. Les gestionnaires peuvent être définis à via des directives telles que SetHandler ou par d'autres modules tels que mod_rewrite au cours des substitutions de niveau répertoire.

Dans les versions antérieures à 2.4, ce module ne modifiait pas son comportement si un autre gestionnaire avait été défini pour l'URL considérée. Ceci permettait de servir des index de répertoires même si une directive SetHandler avait été définie pour un répertoire entier, mais pouvait aussi être à l'origine de conflits avec d'autres modules comme mod_rewrite.

Directive DirectoryIndex

La directive DirectoryIndex permet de définir une liste de fichiers ressources à rechercher lorsqu'un client envoie une requête pour l'index d'un répertoire, en ajoutant un '/' à la fin du nom de ce dernier. url locale est l'URL (codée avec caractères '%') d'un document du serveur, relative au répertoire faisant l'objet de la requête ; il s'agit en général du nom d'un fichier situé dans le répertoire. Si plusieurs URLs sont fournies, le serveur renverra la première d'entre elles qui correspond à une ressource existante. Si aucune ressource ne correspond à la liste des URLs spécifiées, et si l'option Indexes est définie, le serveur générera son propre listing du répertoire.

DirectoryIndex index.html

Avec cette configuration, une requête pour l'URL https://example.com/docs/ renverrait au client la ressource https://example.com/docs/index.html si elle existe, ou provoquerait la génération du listing du répertoire si la ressource n'existe pas.

Notez qu'il n'est pas nécessaire que les documents soient relatifs au répertoire ;

DirectoryIndex index.html index.txt  /cgi-bin/index.pl

provoquerait l'exécution du script CGI /cgi-bin/index.pl si aucun des fichiers index.html ou index.txt n'existe dans le répertoire considéré.

La spécification du seul argument "disabled" empêche mod_dir de rechercher un index. Un argument "disabled" sera interprété de manière littérale si d'autres arguments sont présents avant ou après lui, même s'ils sont eux-mêmes des arguments "disabled".

Note: Positionner plusieurs directives DirectoryIndex au coeur du même context complète la liste des ressources et ne l'écrase pas :

# Exemple A: Positionner index.html en page d'index, puis ajouter index.php.
<Directory "/foo">
    DirectoryIndex index.html
    DirectoryIndex index.php
</Directory>

# Exemple B: La même chose que l'exemple A, mais réalisé au moyen d'une seule directive.
<Directory "/foo">
    DirectoryIndex index.html index.php
</Directory>

# Exemple C: Pour remplacer la liste des ressources, il faut d'abord la vider :
# Ici, seul index.php restera référencé comme ressource d'index.
<Directory "/foo">
    DirectoryIndex index.html
    DirectoryIndex disabled
    DirectoryIndex index.php
</Directory>

Directive DirectoryIndexRedirect

Par défaut, c'est la page définie par la directive DirectoryIndex qui est sélectionnée et renvoyée de manière transparente au client. La directive DirectoryIndexRedirect permet de rediriger le client via une redirection de type 3xx.

Les arguments acceptés sont :

• on : envoie une redirection 302 vers l'index choisi.
• off : n'envoie aucune redirection. Il s'agit du comportement historique de mod_dir.
• permanent : envoie une redirection 301 (permanent) vers l'index choisi.
• temp : ceci est équivalent à on
• seeother : envoie une redirection 303 (également appelée "See Other") vers l'index choisi.
• 3xx-code : envoie une redirection accompagnée du code 3xx choisi.

DirectoryIndexRedirect on

Une requête pour https://example.com/docs/ se solderait par une redirection temporaire vers https://example.com/docs/index.html si cette ressource existe.

Directive DirectorySlash

La directive DirectorySlash permet de déterminer si mod_dir doit corriger ou non les URLs pointant vers un répertoire.

En général, si un utilisateur envoie une requête pour une ressource sans slash de fin, cette ressource représentant un répertoire, mod_dir le redirige vers la même ressource, mais en ajoutant un slash de fin, et ceci pour plusieurs bonnes raisons :

• La requête de l'utilisateur contiendra finalement l'URL canonique de la ressource
• mod_autoindex fonctionnera correctement. Comme il n'indique pas le chemin dans le lien, le chemin de l'URL serait incorrect.
• La directive DirectoryIndex n'est évaluée que pour les répertoires se terminant par un slash.
• Les références à des URLs relatives dans les pages html fonctionneront alors correctement.

Si vous ne souhaitez pas voir ces effets, et si les raisons évoquées ci-dessus ne s'appliquent pas à vous, vous pouvez désactiver la redirection comme indiqué ci-dessous. Gardez cependant à l'esprit que ceci peut avoir des répercutions en matière de sécurité.

# voir l'avertissement de sécurité ci-dessous !
<Location "/some/path">
    DirectorySlash Off
    SetHandler some-handler
</Location>

Notez aussi que certains navigateurs peuvent modifier par erreur des requêtes POST en requêtes GET lors d'une redirection, les données POST étant alors perdues.

Directive FallbackResource

Cette directive permet de définir un traitement pour toute URL qui ne correspond à aucune ressource de votre système de fichiers, et qui provoquerait sans cela l'envoi d'un code d'erreur HTTP 404 (Not Found). Par exemple

FallbackResource /not-404.php

fait en sorte que les requêtes ne correspondant à aucun fichier soient traitées par non-404.php, sans affecter les requêtes pour des fichiers existants.

Il est souvent souhaitable qu'un seul fichier ou ressource traite toutes les requêtes à destination d'un répertoire particulier, sauf pour les requêtes qui correspondent à un fichier ou script existant. On y fait souvent référence sous le terme 'contrôleur frontal'.

Dans les versions plus anciennes de httpd, cet effet nécessitait en général mod_rewrite, et l'utilisation des tests conditionnels -f et -d pour vérifier l'existence des fichiers et répertoires. Maintenant, une seule ligne de configuration est nécessaire.

FallbackResource /index.php

Les fichiers existants comme des images, des fichiers css, etc... seront traités normalement.

L'argument disabled permet de désactiver cette fonctionnalité dans le cas où l'héritage d'un répertoire parent n'est pas souhaité.

Pour un URI intermédiaire tel que https://example.com/blog/, cet URI intermédiaire doit être spécifié en tant que url-locale :

<Directory "/web/example.com/htdocs/blog">
    FallbackResource /blog/index.php
</Directory>
<Directory "/web/example.com/htdocs/blog/images">
    FallbackResource disabled
</Directory>