Module Apache mod_macro

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
    

Exemples

Un exemple typique d'utilisation de mod_macro est la création dynamique de serveurs virtuels.

## Définition d'une macro VHost pour les configurations répétitives

<Macro VHost $host $port $dir>
  Listen $port
  <VirtualHost *:$port>

    ServerName $host
    DocumentRoot $dir

    <Directory $dir>
      # directives propres au répertoire $dir ...
    </Directory>

    # restriction d'accès au sous-répertoire intranet.
    <Directory $dir/intranet>
      Require ip 10.0.0.0/8
    </Directory>
  </VirtualHost>
</Macro>

## Utilisation de la macro VHost avec différents arguments.

Use VHost www.apache.org 80 /vhosts/apache/htdocs
Use VHost example.org 8080 /vhosts/example/htdocs
Use VHost www.example.fr 1234 /vhosts/example.fr/htdocs