Module Apache mod_macro

Utilisation

On d�finit une macro � l'aide des blocs <Macro> qui contiennent la portion de votre configuration qui intervient de mani�re r�p�titive, y compris les variables pour les parties qui devront �tre substitu�es.

Par exemple, vous pouvez utiliser une macro pour d�finir un bloc <VirtualHost>, afin de pouvoir d�finir de nombreux serveurs virtuels similaires :

<Macro VHost $name $domain>
<VirtualHost *:80>
    ServerName $domain
    ServerAlias www.$domain

    DocumentRoot /var/www/vhosts/$name
    ErrorLog /var/log/httpd/$name.error_log
    CustomLog /var/log/httpd/$name.access_log combined
</VirtualHost>
</Macro>

Comme les directives de configuration httpd, les noms des macros sont insensibles � la casse, � la diff�rence des variables qui y sont, elles, sensibles.

Vous pouvez alors invoquer cette macro autant de fois que vous le voulez pour cr�er des serveurs virtuels

Use VHost example example.com
Use VHost myhost hostname.org
Use VHost apache apache.org

UndefMacro VHost
    

Au d�marrage du serveur, chacune de ces invocations Use sera remplac�e par une d�finition de serveur virtuel compl�te, comme d�crit dans la d�finition de la Macro.

La directive UndefMacro permet d'�viter les conflits de d�finitions qui pourraient provenir de l'utilisation ult�rieure de macros contenant les m�mes noms de variables.

Vous trouverez une version plus �labor�e de cet exemple plus loin dans la section Exemples.

Conseils

Les noms de param�tres doivent commencer par un sigil tel que $, %, ou @, de fa�on � ce qu'ils soient clairement identifiables, mais aussi afin de faciliter les interactions avec les autres directives, comme la directive de base Define. Dans le cas contraire, vous recevrez un avertissement. En tout �tat de cause, il est conseill� d'avoir une bonne connaissance globale de la configuration du serveur, afin d'�viter la r�utilisation des m�mes variables � diff�rents niveaux, ce qui peut �tre � l'origine de confusions.

Les param�tres pr�fix�s par $ ou % ne sont pas �chapp�s. Les param�tres pr�fix�s par @ sont �chapp�s entre guillemets.

Evitez de pr�fixer un param�tre par le nom d'un autre param�tre (par exemple, pr�sence simultan�e des param�tres $win et $winter), car ceci peut introduire de la confusion lors de l'�valuation des expressions. Si cela se produit, c'est le nom de param�tre le plus long possible qui sera utilis�.

Si vous d�sirez ins�rer une valeur dans une cha�ne, il est conseill� de l'entourer d'accolades afin d'�viter toute confusion :

<Macro DocRoot ${docroot}>
    DocumentRoot /var/www/${docroot}/htdocs
</Macro>

Exemples

D�finition de serveurs virtuels

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

    # Racine des documents publique
    <Directory $dir>
      Require all granted
    </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

Suppression d'une d�finition de macro

Il est recommand� de supprimer la d�finition d'une macro apr�s l'avoir utilis�e. Ceci permet d'�viter les confusions au sein d'un fichier de configuration complexe o� des conflits entre noms de variables peuvent survenir.

<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