Débogage de DLL ISAPI

L'environnement de développement Delphi permet un débogage aisé des applications Desktop, en revanche la tâche est plus ardue lorsqu'il s'agit d'applications web. Je vais expliquer et mettre en pratique une méthode de débogage d'applications ISAPI sous W2000/XP.

Petits rappels sur la définition d'une ISAPI : Internet Server Application Programming Interface. Cette interface a été conçue par Microsoft pour que son serveur web IIS (Internet Information Server) puisse déléguer la prise en charge d'une requête HTTP à une application extérieure. On parle alors de génération de pages web dynamiques.

Quels sont les comportements possibles d'un serveur web lorsqu'il reçoit une requête à traiter ? Soit l'URL est une ressource fixe localisable par le serveur web (généralement une page web HTML), auquel cas ce dernier la transmet en réponse (page statique). Si cette URL ne contient pas de ressource spécifique à récupérer, c'est qu'elle comporte probablement des informations indiquant qu'une application tierce doit se charger de générer la page web : le serveur délègue alors le traitement de la requête HTTP à cette application.

Exemple d'une URL désignant une ressource spécifique localisable :

• http://www.developpez.com/delphi/article_sylvain.html

Exemple d'une URL qui va être prise en charge par une application tierce respectant l'API isapi :

• http://msdn.microsoft.com/search.dll?keywords=toto

L'application ISAPI est une dll qui exporte des méthodes imposées (GetExtensionVersion, HttpExtensionProc et TerminateExtension). HttpExtensionProc est la méthode qui doit retourner la réponse HTTP. À charge du développeur de la dll. Pour cela il dispose en paramètre d'un bloc de données relatives à la requête.

C'est tout le code interne à cette dll que nous souhaitons pouvoir déboguer. De la prise en charge de la requête jusqu'à la fourniture de la réponse.

Développer une dll isapi en implémentant une méthode HttpExtensionProc revient à travailler à plutôt bas niveau, c'est-à-dire proche du système d'exploitation. C'est pour cela que Borland avait créé WebBroker puis Websnap qui sont deux frameworks isapi fournissant des services au développeur (création d'objets d'application, gestion login, génération simplifiée de pages web, etc.), le deuxième étant plus évolué - et plus complexe - que le premier.

Le framework de développement web autour d'une ISAPI le plus avancé que je connaisse est XMLCLX issu de l'environnement de développement XMLRAD (http://xmlrad.com). Les frameworks dont je viens de parler ont été développés avec Delphi, on peut donc les déboguer avec la technique que nous allons voir.

Autre exemple : vous connaissez probablement PHP. Il est possible d'installer une distribution de PHP de type ISAPI. L'interpréteur PHP est compilé dans une DLL ISAPI; cette DLL récupère la requête HTTP, exécute l'interprétation PHP puis retransmet le flux résultat au serveur web. Par contre, je n'ai pas vérifié, mais il est probable que cette ISAPI soit écrite en C++ et qu'elle ait été compilée avec gcc. Si la compil peut-être effectuée avec CBuilder alors notre technique de débogage marchera tout aussi bien. Il serait alors possible de rentrer dans les arcanes de l'interpréteur PHP…

Créez une application serveur web ISAPI. Si vous n'avez jamais touché à ce domaine de développement, le tutoriel suivant devrait vous lancer sur la voie : (http://jplamon.developpez.com/isapi/ ). (Allez aussi faire un tour sur www.delphicenter.net qui propose des infos et héberge des isapi.)

Copiez la dll générée dans un répertoire IIS qui en Autorisation d'exécution indique : scripts et exécutables. En général, le répertoire \inetpub\scripts est configuré ainsi :

Assurez-vous de spécifier la protection d'application à : élevée (isolé). Même si vous ne voulez pas que votre site en production repose sur ce modèle de protection, il est possible de le changer à tout moment. Que se passe-t-il quand on choisit une protection élevée ? Windows crée un composant COM+, qui exécutera l'application (la dll isapi) dans un espace mémoire protégé, indépendant de l'espace mémoire de IIS. En plus, cette application pourra profiter des services offerts par COM+.

Il n'y a pas grand-chose à vérifier dans les propriétés du composant COM+. Il faut récupérer le ProcessID (identifiant de composant COM+) pour l'indiquer à Delphi. Ouvrez le Panneau de configuration, puis Outils d'administration et enfin choisissez Services de Composants. Vous allez obtenir l'écran suivant :

Ne vous inquiétez pas si la liste d'applications COM+ n'est pas la même sur votre écran que celle présentée dans ce tutoriel. Peu importe, il faut juste localiser l'application Scripts :

Dans l'écran de propriétés, nous allons vérifier que l'utilisateur pouvant exécuter l'application COM+ est bien l'utilisateur interactif (onglet Identité). Cela nous évitera d'être confrontés à des problèmes d'authentification. Ensuite nous allons copier dans le presse-papier le ProcessID de l'application (onglet Général) :

L'étape suivante va nous amener à configurer Delphi pour le débogage de cette application. Très simple, ouvrez le menu Exécuter/Paramètres :

Le champ Application hôte doit indiquer l'emplacement de l'exécutable dllhost.exe.

Cet exécutable est fourni par Windows et se trouve normalement dans \WinNT\System32, mais si vous tournez avec Windows XP (cas particulier par rapport à W2000), alors effectuez une copie de dllhost.exe vers le dossier dans lequel est placée votre dll isapi.

Le champ Paramètres doit indiquer le ProcessID de l'application. Respectez la syntaxe visible sur le screenshot, et rappelez-vous que vous venez de stocker l'ID dans le presse-papier. CTRL V fera votre affaire :-)

Voilà, votre dll isapi est prête au débogage. D'autres méthodes existent, notamment désigner inetinfo comme application hôte (méthode préconisée lorsque vous êtes en protection d'application basse). À vous d'essayer et de conserver ce qui vous semble le plus simple et efficace.

Pour déboguer l'application, posez des points d'arrêt dans le code source. Et ensuite, exécutez l'application (F9). Attention il est important que ce soit Delphi qui soit à l'origine du chargement de la dll, ensuite seulement vous pouvez ouvrir le navigateur Internet de votre choix (Mozilla c'est bien ;-) et invoquer les URL de votre application. Normalement, l'application s'arrêtera sur vos points d'arrêt.

Il peut arriver que Delphi ne s'arrête pas sur les points d'arrêt comme prévu. J'ai pu identifier plusieurs causes possibles qui auront toutes la même solution :

1. La dll était déjà montée en mémoire, car une URL avait été invoquée par mon navigateur web avant que je n'exécute l'application à partir de Delphi ;
2. Le pas à pas fonctionne, mais une exception est déclenchée. Parfois, à la requête suivante, le débogage ne fonctionne plus ;
3. Dans le même esprit, au bout d'un temps déterminé (cf. délai d'expiration du composant COM+), le débogage ne fonctionne plus. Pour les points 2. et 3., je pense que cela est dû à la fonctionnalité COM+ de recyclage de processus, qui consiste à relancer une nouvelle instance de dllhost quand certains critères sont rencontrés. Pour le point 3. il est aisé d'augmenter le délai d'expiration ;
4. Le ProcessID n'est pas le bon, car au fur et à mesure du temps, on peut avoir créé plusieurs instances de composant COM+ sur la même application (sur le même répertoire virtuel IIS). Il faut alors les supprimer de manière à ce qu'un seul ne reste et travailler avec son ProcessID respectif. Attention, le menu de suppression d'un composant COM+ n'est pas accessible par défaut, il faut au préalable le permettre dans les propriétés de ce même composant (onglet Avancé, cadre Protection, décocher « Désactiver les suppressions »).

Solution

Dans tous les cas cités, il suffit de redémarrer les services Internet server (menu Démarrer/Exécuter/iisreset), et ensuite de relancer l'application avec Delphi, et tout fonctionne parfaitement.

Nous voilà arrivés au terme de ce tutoriel, j'espère que c'était compréhensible et que vos points d'arrêt seront vénérés :-)) N'hésitez à m'adresser vos remarques, compléments et suggestions d'amélioration de cet article. À bientôt !