Arguments de la requête d'autoindexation

La chaîne de paramètres de la requête peut contenir de nombreux arguments permettant dans une certaine mesure au client de contrôler l'ordre de l'index du répertoire, ainsi que la liste des fichiers à afficher. Si vous souhaitez désactiver cette fonctionnalité, utilisez l'option IndexOptions IgnoreClient.

Les en-têtes de tri des colonnes eux-mêmes sont des hyper-liens auto-référant qui ajoutent les options de tri à la requête énumérées ci-dessous qui peuvent être ajoutées à toute requête concernant la ressource répertoire.

• C=N trie l'affichage en fonction du nom de fichier
• C=M trie l'affichage en fonction de la date de dernière modification, puis du nom de fichier
• C=S trie l'affichage en fonction de la taille, puis du nom de fichier
• C=D trie l'affichage en fonction de la description, puis du nom de fichier
• O=A trie l'affichage selon l'ordre croissant
• O=D trie l'affichage selon l'ordre décroissant
• F=0 affiche le listing sous la forme d'une simple liste (sans FancyIndex)
• F=1 affiche le listing avec en-têtes de colonnes sous forme de liens hyper-textes (FancyIndexed)
• F=2 affiche le listing sous forme de table HTML avec en-têtes de colonnes contenant des liens hyper-textes (FancyIndexed)
• V=0 désactive le tri en fonction de la version
• V=1 active le tri en fonction de la version
• P=modèle n'affiche que les fichiers correspondant au modèle spécifié

Notez que l'argument 'P' (pour Pattern) n'est testé qu'après que les directives habituelles IndexIgnore ont été traitées, et que tous les noms de fichiers sont encore assujettis aux mêmes critères que pour tout autre listing auto-indexé. L'interpréteur d'arguments de requête de mod_autoindex s'arrête immédiatement s'il rencontre une option non reconnue. Les arguments de requête doivent être bien formés, selon la table ci-dessus.

Les options de requêtes sont illustrées par l'exemple ci-dessous, qui peut être copié et collé dans un fichier header.html. Notez que l'argument inconnu "X", pour le bouton submit, est introduit en dernier afin de s'assurer que tous les arguments ont été interprétés avant que mod_autoindex ne rencontre l'entrée X=Go.

Directive AddAlt

La directive AddAlt permet d'afficher un texte optionnel pour un fichier, à la place d'un icône, dans le cas d'un affichage FancyIndexing. fichier est une extension de fichier, un nom de fichier partiel, une expression avec caractères génériques ou un nom de fichier complet permettant de caractériser le(s) fichier(s) concerné(s). Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affiché si le client ne peut pas afficher d'images, si le chargement d'images est désactivé ou si l'icône ne peut pas être trouvé.

AddAlt "PDF file" *.pdf
AddAlt Compressed *.gz *.zip *.Z

Directive AddAltByEncoding

La directive AddAltByEncoding permet d'afficher un texte optionnel à la place d'un icône pour un fichier dans le cas d'un affichage FancyIndexing. codage MIME doit être un type valide, comme x-compress. Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affiché si le client ne peut pas afficher d'images, si le chargement d'images est désactivé ou si l'icône ne peut pas être trouvé.

AddAltByEncoding gzip x-gzip

Directive AddAltByType

La directive AddAltByType permet d'afficher un texte optionnel à la place d'un icône pour un fichier dans le cas d'un affichage FancyIndexing. type MIME doit être un type MIME valide, comme text/html. Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affiché si le client ne peut pas afficher d'images, si le chargement d'images est désactivé ou si l'icône ne peut pas être trouvé.

AddAltByType 'Fichier texte' text/plain

Directive AddDescription

Cette directive permet d'afficher une description pour un fichier, dans le cas d'un affichage FancyIndexing. fichier est une extension de fichier, un nom de fichier partiel, une expression avec caractères génériques ou un nom de fichier complet permettant de caractériser le fichier. texte doit être entouré de guillemets (").

AddDescription "The planet Mars" mars.gif
AddDescription "My friend Marshall" friends/mars.gif

La taille par défaut, habituelle du champ de description est de 23 octets. L'option IndexOptions SuppressIcon ajoute 6 octets, l'option IndexOptions SuppressSize en ajoute 7 et l'option IndexOptions SuppressLastModified en ajoute 19. Ainsi, la plus grande taille par défaut qui peut être assignée à la colonne description est de 55 octets.

Comme l'argument fichier peut être un nom de fichier partiel, vous devez garder à l'esprit qu'un nom de fichier partiel trop court pourra correspondre à des fichiers non voulus. Par exemple, le.html correspondra au fichier le.html, mais aussi au fichier example.html. En cas d'ambiguïté, utilisez un nom de fichier aussi complet que possible, et ordonnez votre liste de directives AddDescription en conséquence.

Voir le mot-clé DescriptionWidth de la directive module="mod_autoindex">IndexOptions pour plus de détails sur la manière d'augmenter la taille de cette colonne, ou pour permettre des descriptions de taille illimitée.

Directive AddIcon

Cette directive permet de déterminer l'icône à afficher à côté d'un fichier dont le nom se termine par nom, dans le cas d'un affichage FancyIndexing. icône est une URL relative (échappée par des caractères '%') vers l'icône, une URL distante pleinement qualifiée, ou de la forme (alttext,url), où alttext est le symbole texte correspondant à l'icône à afficher dans les navigateurs en mode texte.

nom correspond à ^^DIRECTORY^^ pour les répertoires, ^^BLANKICON^^ pour les lignes vides (pour personnaliser la présentation du listing), une extension de fichier, une expression avec caractères génériques, un nom de fichier partiel ou un nom de fichier complet.

^^BLANKICON^^ n'est utilisé que pour le formatage, et n'est donc pas nécessaire si vous utilisez IndexOptions HTMLTable.

#Examples
AddIcon (IMG,/icons/image.png) .gif .jpg .png
AddIcon /icons/dir.png ^^DIRECTORY^^
AddIcon /icons/backup.png *~

Lorsque c'est possible, il est préférable d'utiliser AddIconByType plutôt que AddIcon.

Directive AddIconByEncoding

Cette directive permet de déterminer l'icône à afficher à côté d'un fichier dans le cas d'un affichage FancyIndexing. icône est une URL relative (échappée par des caractères '%') vers l'icône, une URL pleinement qualifiée, ou de la forme (alttext,url), où alttext est le symbole texte correspondant à l'icône à afficher dans les navigateurs en mode texte.

codage MIME doit être un codage valide, comme x-compress.

AddIconByEncoding /icons/compress.png x-compress

Directive AddIconByType

Cette directive permet de déterminer l'icône à afficher à côté d'un fichier de type MIME type MIME dans le cas d'un affichage FancyIndexing. icône est une URL relative (échappée par des caractères '%') vers l'icône, une URL pleinement qualifiée, ou de la forme (alttext,url), où alttext est le symbole texte correspondant à l'icône à afficher dans les navigateurs en mode texte.

type MIME est une expression avec caractères génériques représentant le type MIME.

AddIconByType (IMG,/icons/image.png) image/*

Directive DefaultIcon

La directive DefaultIcon permet de définir l'icône à afficher à côté d'un fichier lorsqu'aucun icône spécifique n'a été précisé, dans le cas d'un affichage FancyIndexing. chemin URL est une URL relative (échappée par des caractères '%') vers l'icône ou une URL pleinement qualifiée.

DefaultIcon /icon/unknown.png

Directive HeaderName

La directive HeaderName permet de définir le nom du fichier qui sera inséré au début de la page contenant l'index. nom fichier est le nom du fichier à inclure.

HeaderName HEADER.html

HeaderName /include/HEADER.html

AddType text/html .cgi

Si le fichier spécifié par la directive HeaderName contient les en-têtes d'un document HTML ((<html>, <head>, etc...), vous serez probablement amené à définir IndexOptions +SuppressHTMLPreamble, de manière à ce que ces balises ne soient pas répétées.

Voir aussi

• ReadmeName

Directive IndexHeadInsert

La directive IndexHeadInsert permet de spécifier une chaîne de caractères à insérer dans la section <head> du code HTML généré pour la page d'index.

IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"

Directive IndexIgnore

La directive IndexIgnore permet d'effectuer des ajouts à la liste des fichiers à cacher lors de l'affichage de l'index d'un répertoire. fichier est une expression avec caractères génériques de style shell ou un nom de fichier complet. Plusieurs directives IndexIgnore effectuent des ajouts à la liste, et ne remplacent pas la liste des fichiers à ignorer. Par défaut, la liste contient . (le répertoire courant).

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

Directive IndexIgnoreReset

La directive IndexIgnoreReset supprime toute liste de fichiers définie par la directive IndexIgnore et héritée par ailleurs d'autres sections de configuration.

<Directory "/var/www">
    IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
</Directory>
<Directory "/var/www/backups">
    IndexIgnoreReset ON
    IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
</Directory>

Directive IndexOptions

La directive IndexOptions permet de spécifier les options de configuration de l'indexation du répertoire. option peut prendre l'une des valeurs suivantes :

AddAltClass

Ajoute une déclaration de classe CSS supplémentaire à chaque enregistrement de la table du listing du répertoire dans le cas où IndexOptions HTMLTable est activé et où un IndexStyleSheet a été défini. Plutôt que d'appliquer à chaque enregistrement de la table les classes standards even et odd, c'est ici une classe even-ALT ou odd-ALT qui sera appliquée, où ALT sera soit le texte alternatif standard associé au style du fichier (par exemple snd, txt, img, etc...), soit le texte alternatif défini par une des différentes directives AddAlt*.

Charset=jeu de caractères (Versions 2.0.61 et supérieures du serveur HTTP Apache)

Le mot-clé Charset vous permet de spécifier le jeu de caractères de la page générée. La valeur par défaut est UTF-8 sous Windows et MAC OS X, et ISO-8859-1 dans les autres cas (en fait selon que le système de fichiers sous-jacent utilise les noms de fichiers en Unicode ou non).

IndexOptions Charset=UTF-8

DescriptionWidth=[n | *]

Le mot-clé DescriptionWidth vous permet de spécifier la taille en caractères de la colonne description.

Avec -DescriptionWidth (ou si l'option n'est pas définie), mod_autoindex calcule la meilleure taille.

DescriptionWidth=n fixe la taille de la colonne à n octets.

DescriptionWidth=* ajuste la taille de la colonne à la plus longue chaîne de description. Voir la section concernant AddDescription pour les dangers inhérants à la troncature des descriptions.

FancyIndexing

Cette option active l'indexation "améliorée" des répertoires, c'est à dire avec en-têtes de colonnes sous forme d'hyper-liens auto-référants.

FoldersFirst

Lorsque cette option est activée, la liste des sous-répertoires apparaîtra toujours en premier, suivie de la liste des fichiers normaux du répertoire. Le listing comporte principalement deux parties, les fichiers et les sous-répertoires, chacun d'eux étant trié séparément et les sous-répertoires affichés en premier. Par exemple, si l'ordre de tri est décroissant par nom, et si FoldersFirst est activé, le sous-répertoire Zed sera affiché avant le sous-répertoire Beta, qui sera lui-même affiché avant les fichiers normaux Gamma et Alpha. Cette option n'a d'effet que si FancyIndexing est aussi activé.

HTMLTable

Cette option pour l'affichage FancyIndexing permet de construire une table simple pour l'affichage de l'index du répertoire. Cette option s'avèrera particulièrement nécessaire pour les plates-formes où utf-8 est activé et dans le cas où les noms de fichiers ou les chaînes de description alternent entre les ordres de lecture gauche à droite et droite à gauche.

IconsAreLinks

Configure la partie réservée aux icônes de l'ancrage pour le nom de fichier, dans le cas d'un affichage "amélioré".

IconHeight[=pixels]

Si cette option est présente, en combinaison avec IconWidth, le serveur va inclure les attributs height et width dans la balise img qui référence le fichier de l'icône. Ceci va permettre au navigateur de prévoir les caractéristiques de la page sans devoir attendre que toutes les images aient été chargées. En l'absence de cette option, c'est la hauteur standard définie par le logiciel Apache httpd qui est choisie comme valeur par défaut. Cette option n'a d'effet que si FancyIndexing est aussi activé.

IconWidth[=pixels]

Si cette option est présente, en combinaison avec IconHeight, le serveur va inclure les attributs height et width dans la balise img qui référence le fichier de l'icône. Ceci va permettre au navigateur de prévoir les caractéristiques de la page sans devoir attendre que toutes les images aient été chargées. En l'absence de cette option, c'est la largeur standard définie par le logiciel Apache httpd qui est choisie comme valeur par défaut.

IgnoreCase

Si cette option est activée, les noms sont triés sans tenir compte de la casse. Par exemple, si le tri s'effectue sur les noms dans l'ordre croissant, et si IgnoreCase est activé, le fichier Zeta apparaîtra après le fichier alfa (Note : le fichier GAMMA apparaîtra toujours avant le fichier gamma).

IgnoreClient

Si cette option est activée, mod_autoindex va ignorer toutes les variables de requête fournies par le client, y compris les informations de tri (ce qui implique l'activation de l'option SuppressColumnSorting).

NameWidth=[n | *]

Le mot-clé NameWidth vous permet de spécifier la largeur en octets de la colonne correspondant au nom du fichier.

Avec -NameWidth (ou si l'option n'est pas définie), mod_autoindex va calculer la meilleure largeur possible, mais jusqu'à une largeur maximale de 20 octets.

NameWidth=n fixe la largeur de la colonne à n octets.

NameWidth=* définit la largeur de colonne à la valeur nécessaire.

ScanHTMLTitles

L'activation de cette option permet d'extraire le titre des documents HTML dans le cas d'un affichage "amélioré". Si le fichier ne possède aucune description définie par la directive AddDescription, httpd va lire le document pour tenter d'en extraire le titre. Ce processus est coûteux en ressources disque et CPU.

ShowForbidden

Si cette option est activée, Apache httpd affichera les fichiers normalement cachés suite au retour des valeurs HTTP_UNAUTHORIZED ou HTTP_FORBIDDEN par la sous-requête.

SuppressColumnSorting

Si cette option est activée, Apache httpd supprimera les liens hyper-texte dans les en-têtes de colonnes dans le cas d'un affichage "amélioré". Par défaut, ces en-têtes constituent des liens hyper-texte, et la sélection de l'un d'entre eux va trier l'index du répertoire en fonction des valeurs de la colonne correspondante. Cependant, les arguments de la chaîne de paramètres de la requête ajoutés à l'URL seront toujours ignorés. Ce comportement est contrôlé par l'option IndexOptions IgnoreClient.

SuppressDescription

L'activation de cette option va supprimer la description des fichiers dans le cas d'un affichage "amélioré". Par défaut aucune description de fichier n'est définie, et par conséquent l'utilisation de cette option va permettre de récupérer un espace à l'écran de 23 caractères pouvant être utilisé pour autre chose. Voir la directive AddDescription pour plus d'informations à propos de la définition des descriptions de fichiers. Voir aussi l'option d'index DescriptionWidth pour limiter la taille de la colonne description. Cette option n'a d'effet que si FancyIndexing est aussi activé.

SuppressHTMLPreamble

Si le répertoire contient effectivement le fichier spécifié par la directive HeaderName, le module inclut en général le contenu du fichier après avoir inséré un préambule HTML standard (<html>, <head>, etc...). L'activation de l'option SuppressHTMLPreamble supprime l'insertion de ce préambule, et le module va alors commencer l'affichage directement par le contenu du fichier d'en-tête. Dans ce cas par contre, le fichier d'en-tête doit contenir des instructions HTML appropriées. S'il n'y a pas de fichier d'en-tête, le préambule est généré comme dans le cas général. Si vous spécifiez aussi une directive ReadmeName, et si ce fichier existe, les balises de fermeture closing </body></html> seront aussi omises dans la sortie, en supposant que vous ayez placé ces balises de fermeture dans ce fichier.

SuppressIcon

L'activation de cette option supprime l'affichage des icônes dans le cas d'un affichage "amélioré". La combinaison de SuppressIcon et SuppressRules permet de générer une sortie au format HTML 3.2 qui, selon les dernières spécifications, interdit les éléments img et hr dans les blocs pre (utilisés pour formater les affichages "améliorés").

SuppressLastModified

L'activation de cette option supprime l'affichage de la date de dernière modification dans le cas d'un affichage "amélioré". Cette option n'a d'effet que si FancyIndexing est aussi activé.

SuppressRules

L'activation de cette option supprime l'affichage des lignes horizontales (éléments hr) dans les index de répertoires. La combinaison de SuppressIcon et SuppressRules permet de générer une sortie au format HTML 3.2 qui, selon les dernières spécifications, interdit les éléments img et hr dans les blocs pre (utilisés pour formater les affichages "améliorés"). Cette option n'a d'effet que si FancyIndexing est aussi activé.

SuppressSize

L'activation de cette option supprime l'affichage de la taille du fichier dans le cas d'un affichage "amélioré". Cette option n'a d'effet que si FancyIndexing est aussi activé.

TrackModified

Cette option renvoie les valeurs Last-Modified et ETag pour le répertoire indexé dans l'en-tête HTTP. Elle n'est valide que si le système d'exploitation et le système de fichiers renvoient des résultats appropriés pour la fonction stat(). C'est le cas de certains systèmes Unix, ainsi que JFS sous OS/2 ou les volumes NTFS sous Win32. Ce n'est par contre pas le cas des volumes FAT Win32 et OS/2. Lorsque cette option est activée, le client ou le mandataire peuvent détecter les changements dans la liste des fichiers lorsqu'ils effectuent une requête HEAD. Notez que certains systèmes d'exploitation détectent correctement les nouveaux fichiers et les fichiers supprimés, mais ne détectent pas les modifications de tailles ou de dates des fichiers du répertoire. Les modifications de taille ou de date d'un fichier existant ne mettent pas à jour l'en-tête Last-Modified sur toutes les plate-formes Unix. Si c'est le cas, laissez cette option désactivée.

Type=type MIME (Versions 2.0.61 et supérieures du serveur HTTP Apache)

Le mot-clé Type vous permet de spécifier le type MIME de la page générée. La valeur par défaut est text/html.

IndexOptions Type=text/plain

UseOldDateFormat (Apache HTTP Server versions 2.4.26 et ultérieures)

Le format de date utilisé dans le champ Last Modified avait été modifié par inadvertance de "%d-%b-%Y %H:%M" en "%Y-%m-%d %H:%M" dans la version 2.4.0. Cette option permet de restaurer le format de date des versions 2.2 et antérieures.

VersionSort (Versions 2.0a3 et supérieures du serveur HTTP Apache)

Le mot-clé VersionSort permet de trier les fichiers contenant des numéros de version d'une manière spécifique. Les chaînes sont triées comme d'habitude, excepté les sous-chaînes de chiffres du nom de fichier et de sa description qui sont comparées en fonction de leur valeur numérique.

Exemple :

foo-1.7
foo-1.7.2
foo-1.7.12
foo-1.8.2
foo-1.8.2a
foo-1.12

Si le nombre commence par le chiffre 0, il est considéré comme la partie fractionnaire d'un nombre :

foo-1.001
foo-1.002
foo-1.030
foo-1.04

XHTML (Versions 2.0.49 et supérieures du serveur HTTP Apache)

Le mot-clé XHTML enjoint mod_autoindex de générer du code XHTML 1.0 au lieu de HTML 3.2. Cette option n'a d'effet que si FancyIndexing est aussi activé.

Options d'index incrémentales

Vous devez porter une attention particulière à la manière dont les IndexOptions multiples sont traitées.

• Plusieurs directives IndexOptions apparaissant dans la même section directory sont maintenant fusionnées. Le résultat de :

  <Directory "/foo">
      IndexOptions HTMLTable
      IndexOptions SuppressColumnsorting
  </Directory>

  est équivalent à

  IndexOptions HTMLTable SuppressColumnsorting

• L'ajout de la syntaxe incrémentale (en préfixant les mots-clés avec + ou -).

Chaque fois qu'un mot-clé préfixé par '+' ou '-' est trouvé, il est appliqué aux définitions des IndexOptions courantes (qui ont été éventuellement héritées d'un directory de niveau supérieur). Par contre, si un mot-clé non préfixé est trouvé, il supprime toutes les definitions héritées, ainsi que toute définition incrémentale. Considérons l'exemple suivant :

IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize

L'effet global est équivalent à l'effet qu'aurait provoqué IndexOptions FancyIndexing +SuppressSize, car l'option non préfixée FancyIndexing annule les mots-clés incrémentaux situés avant elle, mais leur permet ensuite de s'incrémenter à nouveau.

Pour définir inconditionnellement les IndexOptions pour un répertoire particulier, tout en supprimant les définitions héritées, spécifiez les mots-clés sans préfixe + ou -

Directive IndexOrderDefault

La directive IndexOrderDefault s'utilise en combinaison avec l'option d'index FancyIndexing. Par défaut, les index de répertoires "améliorés" sont affichés selon l'ordre croissant des noms de fichiers ; la directive IndexOrderDefault vous permet de modifier ce comportement.

La directive IndexOrderDefault accepte deux arguments. Le premier est soit Ascending, soit Descending, et indique l'ordre de tri. Le second doit prendre une des valeurs Name, Date, Size, ou Description, et permet d'identifier la clé primaire. La clé secondaire est toujours le nom du fichier selon un ordre croissant.

Si vous le désirez, vous pouvez empêcher le client de modifier l'ordre de tri de la liste en ajoutant l'option d'index SuppressColumnSorting qui supprime le lien de définition du tri de l'en-tête de la colonne, ainsi que l'option IgnoreClient qui empêche ce même client de passer outre vos préférences de tri en ajoutant manuellement des options de tri à la chaîne de paramètres de la requête.

Directive IndexStyleSheet

La directive IndexStyleSheet permet de définir le nom du fichier qui servira de feuille de style CSS pour l'index.

IndexStyleSheet "/css/style.css"

L'utilisation de cette directive en conjonction avec IndexOptions HTMLTable ajoute plusieurs classes CSS au document HTML résultant. Un identifiant CSS indexlist est attribué à l'ensemble de la table et les classes suivantes sont associées aux différentes parties du listing :

Directive ReadmeName

La directive ReadmeName permet de définir le nom du fichier dont le contenu sera ajouté à la fin de l'index. nom-fichier est le nom du fichier à inclure, et est considéré comme relatif au répertoire faisant l'objet de l'index. Si nom-fichier commence par un slash '/', comme dans l'exemple 2, il sera considéré comme relatif au répertoire défini par la directive DocumentRoot.

# Example 1
ReadmeName FOOTER.html

# Example 2
ReadmeName /include/FOOTER.html

Voir aussi la directive HeaderName, où cette fonctionnalité est décrite plus en détails.