Apache La référence Ben Laurie Et Peter Laurie

Prev Next

Portage vers Apache 2.0

En plus de notre présentation précédente sur l’écriture de nouveaux modules pour Apache 2.0, qui est essentiellement identique à l’écriture pour Apache 1.x, nous allons vous montrer ici comment en porter un.

Tout d’abord, il est sûrement plus facile de compiler le module avec apxs (bien que nous n’aimions pas beaucoup cette approche, elle est malheureusement bien plus facile). Vous devrez avoir configuré Apache de la façon suivante :

./configure --enable-so

La compilation de mod_reveal est alors assez simple :

apxs -c mod_reveal.c

Cela produira le fichier .libs/mod_reveal.so (si vous utilisez l’option -i, apxs l’installera gentiment dans /usr/local/apache2/lib ). Cependant, la compilation de la version 1.x de mod_reveal produit un grand nombre d’erreurs (vous pourriez vous économiser beaucoup de soucis en ajoutant -Wc,-Wall et -Wc,-Werror à la ligne de commande). Le premier problème est que certains fichiers en-têtes ont été divisés et déplacés. Nous devons donc ajouter :

#include "http_request.h"

pour disposer de la définition de server_rec.

De plus, de nombreuses structures de données et fonctions d’Apache 1.3 ont des noms qui peuvent provoquer des conflits avec les autres bibliothèques, ils ont donc tous été préfixés pour tenter de les rendre uniques. Les préfixes sont ap_, apr_ et apu_ selon qu’ils appartiennent à Apache, à APR ou à APR-util. Les noms des structures de données ont également été suffixés par _t : ainsi, pool est devenu apr_pool_t. De nombreuses fonctions sont passées de ap_ à apr_ : ap_pstrcat( ), par exemple, est devenu apr_pstrcat( ) et nécessite maintenant l’inclusion du fichier apr_strings.h.

Les fonctions qui ne prenaient pas de paramètres pool doivent maintenant le faire. Ainsi :

ap_add_version_component("Reveal/0.0");

devient :

ap_add_version_component(pPool,"Reveal/0.0");

La structure de commande contrôle maintenant les types et utilise des macros spéciales pour chaque type de commande, en fonction de son nombre de paramètres. Ainsi :

static command_rec aCommands[]=

{

{ "RevealTag", RevealTag, NULL, ACCESS_CONF|OR_ALL, TAKE1,
"a tag for this section"},

{ "RevealServerTag", RevealServerTag, NULL, RSRC_CONF, TAKE1,

"a tag for this server" },

{ NULL }

};

devient :

static command_rec aCommands[]=

{

AP_INIT_TAKE1("RevealTag", RevealTag, NULL, ACCESS_CONF|OR_ALL,

"a tag for this section"),

AP_INIT_TAKE1("RevealServerTag", RevealServerTag, NULL, RSRC_CONF,

"a tag for this server" ),

{ NULL }

};

Une conséquence de cette vérification des types est que l’on ne peut plus utiliser d’astuces. Ainsi :

static const char *RevealServerTag(cmd_parms *cmd, SPerDir *pPerDir, char *arg)
{

devient :

static const char *RevealServerTag(cmd_parms *cmd, void *_pPerDir,
const char *arg)

{

SPerDir *pPerDir=_pPerDir;

Les handlers ont totalement été modifiés et sont maintenant gérés par des hooks. Ainsi, à la place de :

static int RevealHandler(request_rec *pReq)

{

SPerDir *pPerDir=ap_get_module_config(pReq->per_dir_config,

&reveal_module);

SPerServer *pPerServer=ap_get_module_config(pReq->server->

module_config,&reveal_module);

static handler_rec aHandlers[]=

{

{ "reveal", RevealHandler },

{ NULL },

};

nous avons maintenant :

static int RevealHandler(request_rec *pReq)

{

SPerDir *pPerDir;

SPerServer *pPerServer;

if(strcmp(pReq->handler,"reveal"))

return DECLINED;

pPerDir=ap_get_module_config(pReq->per_dir_config, &reveal_module);

pPerServer=ap_get_module_config(pReq->server->module_config, &reveal_module);

et une entrée ap_hook_handler( ) dans la fonction RegisterHooks( ) mentionnée plus loin.

Évidemment, nous n’avons pas présenté toutes les modifications de l’API mais celle d’Apache 2.0, à la différence de celle d’Apache 1.x, est soigneusement documentée. Cette documentation est disponible à la fois dans les fichiers en-têtes et, via l’utilisation de l’outil doxygen, sur le Web (et, évidemment, dans la distribution). La documentation web d’APR et APR-util est disponible sur http://apr.apache.org/. Pour produire une documentation de tout ce qui est documenté, faites :

make dox

à la racine des sources d’Apache 2.0, bien qu’au moment où ce livre est écrit, il faille légèrement modifier docs/doxygen.conf. Il n’y a, malheureusement, pas d’autres moyens actuellement pour connaître les modifications de l’API que de la parcourir. À ce titre, la commande grep vous sera très utile.

Lorsque les modifications de l’API ont été traitées, le problème suivant consiste à basculer vers le nouveau système de hooks. Dans la version 1.3, nous avions :

module reveal_module = {

STANDARD_MODULE_STUFF,

RevealInit, /* initializer */

RevealCreateDir, /* dir config creater */

RevealMergeDir, /* dir merger --- default is to override */

RevealCreateServer, /* server config */

RevealMergeServer, /* merge server configs */

aCommands, /* command table */ a

Handlers, /* handlers */

RevealTranslate, /* filename translation */

RevealCheckUserID, /* check_user_id */

RevealCheckAuth, /* check auth */

RevealCheckAccess, /* check access */

RevealTypeChecker, /* type_checker */

RevealFixups, /* fixups */

RevealLogger, /* logger */

RevealHeaderParser, /* header parser */

RevealChildInit, /* child init */

RevealChildExit, /* child exit */

RevealPostReadRequest, /* post read request */

};

Dans la version 2.0, cela devient beaucoup plus court car tous les hooks sont maintenant initialisés dans une seule fonction. Tout cela est détaillé dans le chapitre précédent, mais voici ce que cela donnerait :

static void RegisterHooks(apr_pool_t *pPool)

{

ap_hook_post_config(RevealInit,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_handler(RevealHandler,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_translate_name(RevealTranslate,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_check_user_id(RevealCheckUserID,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_auth_checker(RevealCheckAuth,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_access_checker(RevealCheckAccess,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_type_checker(RevealTypeChecker,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_fixups(RevealFixups,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_log_transaction(RevealLogger,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_header_parser(RevealHeaderParser,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_child_init(RevealChildInit,NULL,NULL,APR_HOOK_MIDDLE);

ap_hook_post_read_request(RevealPostReadRequest,NULL,NULL,APR_HOOK_MIDDLE);

}

module reveal_module = {

STANDARD20_MODULE_STUFF,

RevealCreateDir, /* dir config creater */

RevealMergeDir, /* dir merger --- default is to override */

RevealCreateServer, /* server config */

RevealMergeServer, /* merge server configs */

aCommands, /* command table */

RegisterHooks /* hook registration */

};

Un problème mineur est que :

static void RevealChildInit(server_rec *pServer,apr_pool_t *pPool)

doit maintenant être :

static void RevealChildInit(apr_pool_t *pPool,server_rec *pServer)

Et, ce qui est plus effrayant :

static void RevealInit(server_rec *pServer,apr_pool_t *pPool)

devient :

static int RevealInit(apr_pool_t *pPool,apr_pool_t *pLog,apr_pool_t *pTemp,
server_rec *pServer)

et renvoie une valeur OK, ce qui convient très bien à notre cas. Notez également que nous n’avons plus de hook child_exit -- une fonction pool-cleanup peut s’en charger.

C’est tout (pour ce module au moins) ! Il reste maintenant à le charger avec une directive AddModule appropriée :

LoadModule reveal_module .mod_reveal.so

et il se comportera exactement comme la version Apache 1.3.

Prev Next