Module Apache mod_example

Langues Disponibles: en | fr | ko

Description:	Illustration de l'API des modules Apache
Statut:	Expï¿½rimental
Identificateurï¿½deï¿½Module:	example_module
Fichierï¿½Source:	mod_example.c

Sommaire

Certains fichiers situï¿½s dans le rï¿½pertoire modules/experimental de l'arborescence de la distribution d'Apache sont fournis ï¿½ titre d'exemples pour ceux qui souhaitent ï¿½crire des modules qui utilisent l'API d'Apache.

Le fichier principal est mod_example.c, qui constitue une illustration exhaustive des diffï¿½rents mï¿½canismes et syntaxes d'appels. En aucun cas un module additionnel n'aura ï¿½ inclure des routines pour tous les appels - il n'en nï¿½cessitera au contraire qu'un petit nombre !

Le module example fonctionne rï¿½ellement. Si vous le chargez dans votre serveur, activez le gestionnaire "example-handler" dans une section location, et essayez d'accï¿½der ï¿½ la zone du site web correspondante, vous verrez s'afficher certaines sorties que le module example produit au cours des diffï¿½rents appels.

Directives

Example

Commentaires

Compilation du module example

Pour inclure le module example dans votre serveur, effectuez les ï¿½tapes suivantes :

Exï¿½cutez configure avec l'option --enable-example.
Compilez le serveur (exï¿½cutez la commande "make").

Pour ajouter votre propre module :

cp modules/experimental/mod_example.c modules/nouveau_module/mod_monexemple.c
Modifiez le fichier.
Crï¿½ez modules/nouveau_module/config.m4.
1. Ajoutez APACHE_MODPATH_INIT(nouveau_module).
2. Copiez la ligne APACHE_MODULE contenant "example" depuis modules/experimental/config.m4.
3. Remplacez le premier argument "example" par monexemple.
4. Remplacez le second argument par une brï¿½ve description de votre module. Cette description sera utilisï¿½e par la commande configure --help.
5. Si la compilation de votre module nï¿½cessite des drapeaux de compilation C, des drapeaux d'ï¿½dition de liens, ou de bibliothï¿½ques supplï¿½mentaires, ajoutez les respectivement ï¿½ CFLAGS, LDFLAGS et LIBS. Reportez-vous aux fichiers config.m4 des rï¿½pertoires des autres modules pour plus d'exemples.
6. Ajoutez APACHE_MODPATH_FINISH.
Crï¿½ez le fichier module/nouveau_module/Makefile.in. Si la compilation de votre module ne nï¿½cessite pas d'instructions particuliï¿½res, ce fichier ne doit contenir que la ligne include $(top_srcdir)/build/special.mk.
Exï¿½cutez ./buildconf ï¿½ la racine du rï¿½pertoire.
Compilez le serveur aprï¿½s avoir exï¿½cutï¿½ la commande configure avec l'option --enable-monexemple.

Utilisation du module `mod_example`

Pour activer le module example, ajoutez ï¿½ votre fichier apache2.conf un bloc du style :

<Location /example-info>
   SetHandler example-handler
</Location>

Vous pouvez aussi ajouter ce qui suit dans un fichier .htaccess, puis accï¿½der au fichier "test.example" ï¿½ partir du rï¿½pertoire correspondant :

   AddHandler example-handler .example

Aprï¿½s avoir rechargï¿½ la configuration ou redï¿½marrï¿½ votre serveur, vous devriez pouvoir accï¿½der ï¿½ ce fichier et voir s'afficher ce qui a ï¿½tï¿½ dï¿½crit plus haut.

Example Directive

Description:	Directive de dï¿½monstration pour illustrer l'API des modules Apache
Syntaxe:	`Example`
Contexte:	configuration du serveur, serveur virtuel, rï¿½pertoire, .htaccess
Statut:	Expï¿½rimental
Module:	mod_example

La directive Example n'a pour fonction que de dï¿½finir un drapeau de dï¿½monstration que le gestionnaire de contenu du module example va afficher. Elle ne possï¿½de aucun argument. Si vous naviguez vers une URL ï¿½ laquelle le gestionnaire de contenu example s'applique, vous verrez s'afficher les routines du module, ainsi que l'ordre dans lequel elles ont ï¿½tï¿½ appelï¿½es pour servir le document demandï¿½. On peut observer l'effet de cette directive dans la phrase "Example directive declared here: YES/NO".