Serveur Apache HTTP Version 2.4

Apache > Serveur HTTP > Documentation > Version 2.4 > Modules

# Module Apache mod_macro

Langues Disponibles: en | fr

Description: | Ce module permet d'utiliser des macros dans les fichiers de configuration Apache.
Statut: | Base
Identificateur de Module: | macro_module
Fichier Source: | mod_macro.c
Compatibilité: | Disponible à partir de la version 2.4.5 du serveur HTTP Apache

### Sommaire

Ce module permet de définir et d'utiliser des macros dans les fichiers de configuration Apache. Ces macros peuvent avoir des paramètres qui sont expansés à l'utilisation (les paramètres sont remplacés par la valeur passée en argument), et le résultat de la substitution est traité normalement.

### Directives

### Sujets

- Caractéristiques

- Commentaires

## Caractéristiques

Définition d'une macro :

- dans une section <Macro> au style conforme à la syntaxe des fichiers de configuration Apache.
- l'utilisateur choisit le nom de la macro et de ses paramètres.
- les noms de macro sont insensibles à la casse, comme les directives Apache.
- les noms de paramètres sont par contre sensibles à la casse.
- les paramètres d'une macro doivent avoir des noms distincts.
- il y a une erreur si un paramètre a un nom vide.
- la redéfinition d'une macro génère un avertissement.
- des définitions de macros peuvent être imbriquées les unes dans les autres... (mais dans quel but ?)
- les paramètres inutilisés génèrent un avertissement.
- les noms de paramètre en préfixe les uns des autres génèrent un avertissement.
- les noms de paramètre non préfixés par un des caractères '`$%@`' génèrent un avertissement pour encourager cette bonne pratique.
- les différents préfixes proposés permettent de gérer les interactions avec d'autres directives comme `Define`.
- un conseil : il peut être utile d'ajouter des accolades autour du nom d'un paramètre, par exemple `${foo}`, de manière à ce que le paramètre puisse être utilisé entouré de caractères, par exemple `bla${foo}bla`.
- génère un avertissement si le contenu de la macro est vide.
- génère un avertissement si le système détecte que les sections à l'intérieur d'une macro ne sont pas correctement imbriquées.
- la portée lexicale des paramètres d'une macro est restreinte au texte de la macro elle-même... en particulier elle n'est pas propagée aux inclusions.
- il n'y a pas de contrainte sur le contenu d'une macro.

  Cela signifie que vous pouvez mettre une section perl ou n'importe quoi d'autre dans une macro. Il n'y a pas d'autre contrainte sur la structure lexicale et syntaxique de la macro (guillemets, espaces...) que d'attendre une séquence de ligne avec éventuellement des continuations.

Utilisation d'une macro:

- le nombre d'arguments doit être cohérent avec la définition.
- toutes les occurences des paramètres sont substituées par leur valeur.
- en cas de conflit, le nom le plus long est choisi.
- une récursion dans l'expansion d'une macro est détectée et interrompue avec envoi d'un message d'erreur.
- si un argument vide est détecté, un avertissement est généré.
- le système s'efforce de générer une description précise de la localisation des erreurs.
- les valeurs des paramètres préfixées par `$` et `%` ne sont pas échappées.
- les valeurs des paramètres préfixées par `@` sont échappées par des guillemets.

Suppression de la définition d'une macro :

- la macro supprimée doit avoir été définie auparavant.

    <Macro DirGroup $dir $group>
      <Directory $dir>
        require group $group
      </Directory>
    </Macro>

    Use DirGroup /www/apache/private private
    Use DirGroup /www/apache/server  admin

    UndefMacro DirGroup

## <Macro> Directive

Description: | Définition d'une macro dans un fichier de configuration
Syntaxe: | `<Macro nom [par1 .. parN]> ... </Macro>`
Contexte: | configuration du serveur, serveur virtuel, répertoire
Statut: | Base
Module: | mod_macro

La directive `Macro` permet de définir une macro dans un fichier de configuration Apache. Le premier argument est le nom de la macro, et les arguments suivants sont les paramètres. Il est de bon aloi de préfixer les noms des paramètres d'une macro avec un caractère parmi '`$%@`', et d'éviter d'en faire de même avec les noms de macros.

    <Macro LocalAccessPolicy>
      order deny,allow
      deny from all
      allow from 10.2.16.0/24
    </Macro>

    <Macro RestrictedAccessPolicy $ipnumbers>
       order deny,allow
       deny from all
       allow from $ipnumbers
    </Macro>

## undefMacro Directive

Description: | Undefine a macro
Syntaxe: | `UndefMacro name`
Contexte: | configuration du serveur, serveur virtuel, répertoire
Statut: | Base
Module: | mod_macro

La documentation de cette directive n'a pas encore t traduite. Veuillez vous reporter la version en langue anglaise.

## Use Directive

Description: | Utilisation d'une macro
Syntaxe: | `Use nom [valeur1 ... valeurN]`
Contexte: | configuration du serveur, serveur virtuel, répertoire
Statut: | Base
Module: | mod_macro

La directive `Use` permet d'utiliser une macro. La macro considérée est expansée. Son nombre d'arguments doit être égal au nombre de paramètres précisés dans sa définition. Les valeurs passées en argument sont attribuées aux paramètres correspondants et substituées avant l'interprétation du texte de la macro.

    Use LocalAccessPolicy
    ...
    Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"

est équivalent, avec les macros définies ci-dessus à :

    order deny,allow
    deny from all
    allow from 10.2.16.0/24
    ...
    order deny,allow
    deny from all
    allow from 192.54.172.0/24 192.54.148.0/24

Langues Disponibles: en | fr

## Commentaires

Notice:
This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our mailing lists.