Please note, this is a STATIC archive of website developer.mozilla.org from November 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

 

Introduction

Ce tutoriel va vous présenter les étapes requises pour construire une extension très basique, qui ajoute un bouton contenant le texte « Salut tout le monde ! » à la Barre d'état du navigateur Firefox.

Note : ce tutoriel traite de la construction d'extensions pour Firefox 1.5 et les versions ultérieures. D'autres tutoriels existent pour construire des extensions destinées à des versions plus anciennes de Firefox.

Configuration de l'environnement de développement

Les extensions sont empaquetées et distribuées dans des fichiers ZIP, ou Bundles, avec l'extension xpi (prononcé « zippy »). Le contenu d'un fichier XPI s'arrange de la manière suivante :

extension.xpi :
              /install.rdf
              /components/*
              /components/cmdline.js
              /defaults/
              /defaults/preferences/*.js
              /plugins/*
              /chrome.manifest
              /chrome/icons/default/*
              /chrome/
              /chrome/content/

Par conséquent, il est plus facile de disposer vos fichiers sources selon une méthode similaire, à moins que vous ne désiriez écrire quelque Makefile ou script shell pour empaqueter et zipper tous vos fichiers. Mais même si c'est dans vos cordes, les tests sont plus simples en arrangeant vos fichiers de cette manière à cause d'une particularité du système de modules complémentaires proposé par Firefox 1.5 et supérieurs.

Bien, commençons. Créez un dossier pour votre extension quelque part sur votre disque dur, par exemple C:\extensions\mon_extension\ ou ~/extensions/mon_extension/. Dans celui-ci, créez un autre dossier nommé chrome, et dans ce dernier créez un dossier nommé content. Dans les systèmes Unix, il est habituellement possible de créer ces deux répertoires à la fois en lançant juste mkdir -p chrome/content depuis le répertoire racine de l'extension.

À la racine du dossier de votre extension, au même niveau que le dossier chrome, créez deux nouveaux fichiers texte vides, l'un appelé chrome.manifest et l'autre appelé install.rdf.

Par exemple :

#!/bin/sh
h=$HOME/moExt
mkdir -p $h/my_extension/chrome/content
touch $h/my_extension/chrome.manifest $h/my_extension/install.rdf

Vous trouverez plus d'astuces sur la mise en place d'un environnement de développement dans l'article Mise en place d'un environnement de développement d'extensions.

Créer le manifeste d'installation

Ouvrez le fichier nommé install.rdf que vous avez créé au premier niveau de la hiérarchie de dossiers de votre extension, et placez ceci à l'intérieur :

<?xml version="1.0"?>

<RDF xmlns="https://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:em="https://www.mozilla.org/2004/em-rdf#">

  <Description about="urn:mozilla:install-manifest">
    <em:id>[email protected]</em:id>
    <em:version>1.0</em:version>
    <em:type>2</em:type>
   
    <!-- L'application cible de votre extension, 
         avec les versions minimums et maximums supportées. --> 
    <em:targetApplication>
      <Description>
        <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
        <em:minVersion>1.5</em:minVersion>
        <em:maxVersion>3.*</em:maxVersion>
      </Description>
    </em:targetApplication>
   
    <!-- Méta-données visibles -->
    <em:name>Exemple</em:name>
    <em:description>Une extension test</em:description>
    <em:creator>Votre nom ici</em:creator>
    <em:homepageURL>https://www.example.com/</em:homepageURL>
  </Description>      
</RDF>
  • [email protected] — L'ID de votre extension. C'est une valeur que vous inventez pour identifier votre extension dans un format d'adresse électronique (attention, il ne doit pas forcément s'agir de votre propre adresse électronique ni même d'une adresse réelle, seul le format doit être correct). Il faut qu'il soit unique. Vous pouvez également utiliser un GUID.
  • Spécifiez <em:type>2</em:type> — le 2 indique qu'il s'agit d'une extension. Dans le cas d'un thème il s'agirait d'un 4 (voir les types de manifestes d'installations pour les autres codes).
  • {ec8030f7-c20a-464f-9b0e-13a3a9e97384} — L'ID de l'application Firefox.
  • 1.5 — la version minimum de Firefox avec laquelle votre extension fonctionnera. C'est la version minimum avec laquelle vous vous engagez à tester et corriger les bogues.
  • 3.* — La version maximum de Firefox avec laquelle votre extension fonctionnera. Elle ne doit pas être supérieure à la dernière version courante ! Dans ce cas précis, « 3.* » indique que l'extension fonctionnera avec les versions 3.0 à 3.x de Firefox.

(Dans Firefox 3.0.1, vous ne pouvez pas définir en même temps em:minVersion et em:maxVersion à "3.0.*". Si vous essayez d'installer une telle extension, vous obtiendrez une erreur indiquant qu'elle n'est pas compatible avec Firefox 3.0.1. La raison n'est pas très claire, mais il suffit de définir em:minVersion à "3" et em:maxVersion à "3.0.*")

Les extensions prévues pour fonctionner avec Firefox 2.0.0.x tout au plus doivent indiquer « 2.0.0.* » comme version maximum.

Voir les manifestes d'installation pour une liste complète des propriétés requises et optionnelles.

Enregistrez le fichier.

Extension du navigateur avec XUL

L'interface utilisateur de Firefox est écrite en XUL et JavaScript. Le XUL est une grammaire XML qui fournit des éléments d'interface comme des boutons, des menus, des barres d'outils, des arbres, etc. Les actions utilisateur sont liées à des fonctionnalités utilisant JavaScript.

Pour modifier le navigateur, on remanie des parties de l'interface utilisateur (UI) du navigateur en ajoutant ou modifiant des éléments. Des contrôles sont ajoutés en insérant de nouveaux éléments DOM XUL dans la fenêtre du navigateur, et peuvent être modifiés en utilisant des scripts et en attachant des gestionnaires d'événements.

Le navigateur est implémenté dans un fichier XUL nommé browser.xul (content/browser/browser.xul se trouve dans $FIREFOX_INSTALL_DIR/chrome/browser.jar). Dans browser.xul, nous pouvons trouver la Barre d'état, qui ressemble à quelque chose de ce genre :

<statusbar id="status-bar">
 ... <statusbarpanel>s ...
</statusbar>

<statusbar id="status-bar"> est un « point de fusion » pour un overlay XUL.

Les overlays XUL

Les overlays XUL sont un moyen d'attacher d'autres éléments d'interface utilisateur à un document XUL au moment de l'exécution. Un overlay XUL est un fichier .xul qui spécifie des fragments de XUL à insérer dans des points de fusion spécifiques au sein d'un document « maître ». Ces fragments peuvent spécifier des éléments d'interface à insérer, supprimer ou modifier.

Exemple de document overlay XUL

<?xml version="1.0"?>
<overlay id="sample" 
         xmlns="https://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 <statusbar id="status-bar">
  <statusbarpanel id="my-panel" label="Salut tout le monde !"/>
 </statusbar>
</overlay>

L'élément <statusbar> nommé par l'identifiant status-bar spécifie le « point de fusion » auquel nous voulons nous fixer au sein de la fenêtre du navigateur.

L'enfant <statusbarpanel> est un nouvel élément d'interface que nous désirons insérer au sein du point de fusion.

Prenez l'exemple de code ci-dessus et enregistrez le dans un fichier nommé exemple.xul dans le dossier chrome/content que vous avez créé.

Voir plus bas pour plus d'informations au sujet de la fusion d'éléments d'interface et de la modification de l'interface utilisateur en utilisant des overlays.

Les URI chrome

Les fichiers XUL font partie des « paquets chrome » - ensembles de composants d'interface utilisateur qui sont chargés via des URI chrome://. Plutôt que de charger le navigateur à partir du disque en utilisant les URI file:// (puisque la localisation de Firefox sur le système peut changer selon les plateformes et les systèmes), les développeurs Mozilla ont trouvé une solution pour créer des URI que l'application installée connaît pour le contenu XUL.

Le navigateur est : chrome://browser/content/browser.xul Essayez de rentrer cette URL dans la Barre d'adresse de Firefox !

Les URI chrome comprennent plusieurs composants :

  • Premièrement, le schéma URI (chrome) qui explique à la bibliothèque réseau de Firefox qu'il s'agit d'une URI chrome. Il indique que le contenu de cette URI devra être traité comme du chrome. Par opposition, http dirait à Firefox de traiter l'URI comme une page Web.
  • Deuxièmement, un nom de paquet (dans l'exemple ci-dessus, browser qui identifie le paquet de composants d'interface utilisateur). Il doit être aussi spécifique à votre extension que possible, afin d'éviter les collisions entre extensions.
  • Troisièmement, le type de données requis. Il y a trois types : content (XUL, JavaScript, bindings XML XBL, etc., qui forme la structure et le comportement d'une UI d'application), locale (DTD, fichiers .properties, etc. qui contiennent les chaînes de caractères pour la localisation de l'UI), et skin (CSS et images qui forment le thème de l'UI).
  • Enfin, un nom de fichier à charger.

Donc, chrome://foo/skin/bar.png charge le fichier bar.png de la section thème skin de foo.

Quand du contenu est chargé à l'aide d'une URI chrome, Firefox utilise le registre chrome pour traduire ces URI en adresses de fichiers sources réels sur le disque (ou dans les paquets JAR).

Créer un fichier chrome.manifest

Pour plus d'informations sur les fichiers chrome.manifest et les propriétés qu'ils permettent, voir la référence sur les enregistrements chrome.

Ouvrez le fichier nommé chrome.manifest que vous avez créé au même niveau que le répertoire chrome, à la racine de la hiérarchie du dossier source de votre extension.

Ajoutez ce code :

content     exemple    chrome/content/

(N'oubliez pas la barre oblique finale, / ! Sans elle, le paquet ne sera pas enregistré.)

Ceci spécifie :

  1. le type de données au sein d'un paquet chrome
  2. le nom du paquet chrome (assurez-vous d'utiliser uniquement des caractères en minuscules pour le nom du paquet (« exemple ») étant donné que Firefox/Thunderbird ne supportent pas les changements de casse dans les versions 2 et antérieures — bug 132183)
  3. l'emplacement des fichiers du paquet chrome

Donc, cette ligne indique que pour le paquet chrome exemple, nous pouvons trouver ses fichiers content à l'emplacement chrome/content qui est un chemin relatif à l'emplacement du chrome.manifest.

Notez que les fichiers content, locale et skin doivent être maintenus dans des dossiers nommés content, locale et skin au sein de votre sous-répertoire chrome.

Enregistrez le fichier. Quand vous lancerez Firefox avec votre extension (ceci sera expliqué plus loin dans le tutoriel), il enregistrera le paquet chrome.

Enregistrer un overlay

Il est nécessaire que Firefox fusionne votre overlay avec la fenêtre du navigateur à chaque fois qu'il affiche celle-ci. Ajoutez donc cette ligne à votre fichier chrome.manifest :

overlay chrome://browser/content/browser.xul chrome://exemple/content/exemple.xul

Cette ligne indique à Firefox de fusionner exemple.xul dans browser.xul lorsque browser.xul est chargé.

Test

Tout d'abord, il faut indiquer au navigateur comment trouver votre extension. Dans les jours sombres de Firefox 1.0, cela signifiait un empaquetage de l'extension en un XPI et une installation via l'interface utilisateur, ce qui était franchement fastidieux. À présent, c'est devenu plus simple. Au cours de la phase de développement, vous pouvez pointer Firefox vers le dossier dans lequel vous développez l'extension, et il sera chargé à chaque démarrage de Firefox.

  1. Localisez votre dossier de profil par défaut. Celui-ci se trouve quelque part sous le dossier de profil (Profile Folder), par exemple dans le sous-dossier Firefox/Profiles/<profile_id>.default/.
  2. Ouvrez le dossier extensions. Il devrait déjà exister si vous avez la moindre extension installée. Créez-le s'il n'existe pas.
  3. Créez un nouveau fichier texte portant le même nom que l'id de votre extension (par exemple [email protected]), et mettez y le chemin vers le dossier de développement de votre extension (par exemple C:\extensions\mon_extension\ ou ~/extensions/mon_extension)

(N'oubliez pas la barre oblique finale, « / » ! Sans elle, l'extension ne sera pas enregistrée.)

(« mon_extension » peut ne pas fonctionner ! La redirection semble poser problème si le nom du dossier contient un caractère souligné.)

Votre extension est maintenant prête à être testée !

(Re)démarrez Firefox. Firefox détectera le lien textuel vers votre extension, et l'installera. À l'apparition du navigateur, vous devriez voir le texte « Salut tout le monde ! » dans la Barre d'état (en bas à droite.)

Vous pouvez maintenant revenir dans le fichier .xul pour faire d'autres modifications, qui apparaîtront après un redémarrage.

Image:Bonjour_barre_taches.png

Image:Bonjour_gestionnaire_extensions.png

Empaquetage

Maintenant que votre extension fonctionne, vous pouvez l'empaqueter.

Compressez au format zip le contenu du dossier de votre extension (pas le dossier de l'extension lui-même), et renommez le fichier zip pour avoir une extension en .xpi. Sous Windows XP, cela peut se faire facilement en sélectionnant tous les fichiers et sous-dossiers du dossier de votre extension, en faisant un clic droit et en choisissant « Envoyer vers → Dossier Compressé ». Un fichier .zip sera crée pour vous. Renommez le, et c'est terminé.

Sous Mac OS X, vous pouvez cliquer avec le bouton de droite sur le dossier de l'extension et choisir « Créer une archive depuis… » pour créer le fichier zip. Cependant, comme Mac OS X ajoute des fichiers cachés aux dossiers afin de suivre les méta-données des autres fichiers, il vaut mieux utiliser le Terminal, supprimer les fichiers cachés (dont les noms commencent par un point), et utiliser ensuite la commande zip en ligne de commande pour créer le fichier zip.

Sous Linux, vous utiliserez probablement de même l'outil zip en ligne de commande.

Si vous avez installé l'extension « Extension Builder », elle peut compiler le fichier .xpi pour vous (Outils → Extension Developer → Extension Builder). Naviguez simplement vers le répertoire où se trouve votre extension (install.rdf etc.), et cliquez sur le bouton « Build Extension ». Cette extension dispose d'une série d'outils facilitant le développement.

À présent, chargez le .xpi sur votre serveur, en vérifiant qu'il est distribué avec le type mime application/x-xpinstall. Vous pouvez créer un lien pour permettre aux personnes intéressées de le télécharger et de l'installer. Dans le but de tester simplement notre fichier .xpi, nous pouvons simplement le glisser dans la fenêtre des extensions via Outils → Extensions dans Firefox 1.5 ou Outils → Modules complémentaires → Extensions dans les versions suivantes.

Installation depuis une page Web

Il existe de nombreuses façons d'installer une extension depuis une page Web, parmi lesquelles un lien direct vers les fichiers XPI et l'utilisation de l'objet InstallTrigger. Les auteurs d'extensions et de pages Web sont encouragés à utiliser le méthode InstallTrigger pour l'installation de XPIs, c'est celle qui est la plus agréable pour l'utilisateur.

Utilisation de addons.mozilla.org

Mozilla Add-ons est un site de distribution où il est possible d'héberger vos extensions gratuitement. Votre extension sera conservée sur le site miroir de Mozilla pour en garantir la disponibilité de téléchargement, même si elle devenait très populaire. Le site propose également aux utilisateurs une installation facile, et distribuera automatiquement les mises à jour. En plus de cela, il permet aux utilisateurs de commenter et de vous envoyer un retour d'expérience sur votre extension. Il est fortement recommandé d'utiliser Mozilla Add-ons pour distribuer vos extensions.

Visitez https://addons.mozilla.org/developers/ pour créer un compte et commencer à distribuer vos extensions.

Note : Votre extension sera validée plus rapidement et téléchargée plus souvent si vous donnez une bonne description et quelques captures d'écran de l'extension en action.

Enregistrement d'extensions dans le registre de Windows

Sous Windows, des informations à propos des extensions peuvent être ajoutées à la base de registres, et ces extensions seront identifiées automatiquement repérées au prochain démarrage de l'application. Cela permet aux programmes d'installation d'applications externes d'ajouter facilement des points d'accès à leurs commandes sous la forme d'une extension. Consultez Ajout d'extensions avec la base de registres de Windows pour plus d'informations.

Plus d'informations sur les overlays XUL

En plus d'ajouter des contrôles d'interface utilisateur au point de fusion, il est possible d'utiliser des fragments XUL au sein d'overlays afin de :

  • Modifier des attributs sur le point de fusion, par exemple <statusbar id="status-bar" hidden="true" /> (masque la barre d'état)
  • Retirer le point de fusion du document maître, par exemple <statusbar id="status-bar" removeelement="true" />
  • Contrôler la position des contrôles insérés :
<statusbarpanel position="1" .../>

<statusbarpanel insertbefore="autre-id" .../>

<statusbarpanel insertafter="autre-id" .../>

Création de nouveaux composants d'interface utilisateur

Il est possible de créer vos propres fenêtres et boîtes de dialogues en tant que fichiers .xul séparés, de fournir des fonctionnalités en implémentant des actions utilisateur dans des fichiers .js et d'utiliser des méthodes DOM pour manipuler des contrôles UI. Vous pouvez également utiliser des règles de style dans des fichiers .css pour attacher des images, définir des couleurs etc.

Consultez la documentation XUL pour plus de ressources pour les développeurs XUL.

Fichiers par défaut

Les fichiers par défaut utilisés pour constituer le profil d'un utilisateur doivent être placés dans le dossier defaults/ à la racine de la hiérarchie du dossier de votre extension. Les fichiers .js de préférences par défaut doivent se trouver dans defaults/preferences/ — lorsqu'ils y sont placés il seront chargés automatiquement par le système de préférences de Firefox à son démarrage afin d'être accessibles via l'API de préférences.

Un exemple de fichier de préférences par défaut :

pref("extensions.example.username", "Joe"); // une préférence chaîne
pref("extensions.example.sort", 2); // une préférence entière
pref("extensions.example.showAdvanced", true); // une préférence booléenne

 

Composants XPCOM

Firefox permet d'utiliser des composants XPCOM dans les extensions. De nouveaux composants peuvent être implémentés facilement en JavaScript, ou en C++ (à l'aide du SDK Gecko).

Placez tous vos fichiers .js ou .dll dans le répertoire components/ — ils sont automatiquement enregistrés au premier démarrage de Firefox après l'installation de votre extension.

Pour plus d'information, consultez Comment rédiger un composant XPCOM en JavaScript, en:How to build a binary XPCOM component using Visual Studio et le livre de la création des composants XPCOM (en).

Lancement de l'application en ligne de commande

Une des utilisations possibles de nouveaux composants XPCOM est d'ajouter un paramètre de ligne de commande à Firefox ou Thunderbird. Cette technique peut être utilisée pour lancer une extension comme s'il s'agissait d'une application :

 firefox.exe -myapp

Ceci devrait se trouver dans la page Ligne de commande. Cela se fait en ajoutant un composant contenant la fonction... function NSGetModule(comMgr, fileSpec) { return myAppHandlerModule; } Cette fonction est exécutée par Firefox à chaque lancement de l'application. Firefox enregistre myAppHandlerModule en appelant sa fonction 'registerSelf()'. Ensuite, la factory de myAppHandlerModule est obtenue via 'getClassObject()'. Celle-ci est alors utilisée pour créer le handle avec sa fonction 'createInstance(). Enfin, la fonction 'handle(cmdline)' traite la ligne de commande cmdline avec ses fonctions handleFlagWithParam() et handleFlag().

Consultez Chrome: Ligne de commande et ce sujet de forum (en) pour plus de détails.

Localisation

Pour gérer plus d'une langue, vous devez séparer les chaînes de caractères de votre contenu à l'aide d'entités et de string bundles. Il est beaucoup plus facile de faire au moment du développement de l'extension que d'y revenir par la suite.

Les informations de localisation sont stockées dans le répertoire locale de l'extension. Par exemple, pour ajouter une locale à notre extension, créez un répertoire appelé "locale" dans chrome (là où se trouve le répertoire "content") et ajoutez la ligne suivante au fichier chrome.manifest :

 locale sample en-US chrome/locale/en-US/

Pour créer des valeurs d'attributs localisables en XUL, placez les valeurs dans un fichier .ent (ou un fichier .dtd) placé dans le répertoire locale, qui devrait ressembler à ceci :

<!ENTITY  button.label     "Cliquez ici">
<!ENTITY  button.accesskey "C">

Incluez-le ensuite en haut de votre document XUL (juste en dessous de <?xml version"1.0"?>), comme ceci :

<!DOCTYPE window SYSTEM "chrome://packagename/locale/filename.ent">

où window est la valeur localName de l'élément racine du document XUL, et la valeur de la propriété SYSTEM est l'URI chrome du fichier d'entités. Dans notre exemple, l'élément racine est overlay.

Pour utiliser les entités, modifiez votre XUL pour qu'il ressemble à ceci :

<button label="&button.label;" accesskey="&button.accesskey;"/>

Le registre chrome s'assurera que le fichier d'entités sera chargé du paquet de localisation correspondant à la locale sélectionnée.

Pour les chaînes que vous utilisez dans des scripts, créez un fichier .properties, un fichier texte ayant une chaîne sur chaque ligne dans ce format :

clé=valeur

et utilisez ensuite nsIStringBundleService/nsIStringBundle ou la balise <stringbundle> pour charger les valeurs dans le script.

Comprendre le navigateur

Utilisez l'inspecteur DOM (ne fait pas partie de l'installation Standard de Firefox, vous devrez le réinstaller en choisissant l'installation personnalisée et choisir Inspecteur DOM (ou Outils de développement dans Firefox 1.5) si l'élément « Inspecteur DOM » n'est pas présent dans le menu Outils de votre navigateur) pour examiner la fenêtre du navigateur ou toute autre fenêtre XUL que vous désirez étendre.

Utilisez le bouton de recherche de nœuds par pointage et clic en haut à gauche de la barre d'outils de l'inspecteur DOM pour cliquer sur un élément de la fenêtre XUL afin de le sélectionner. Lorsque vous effectuez cette manipulation, l'arbre hiérarchique DOM de l'inspecteur DOM se positionnera sur le nœud sur lequel vous avez cliqué.

Utilisez le panneau de droite de l'inspecteur DOM pour découvrir les points de fusion et leurs attributs id que vous pouvez utiliser pour insérer vos éléments via des overlays. Si vous n'arrivez pas à découvrir un élément avec un id avec lequel vous pouvez fusionner, il peut être nécessaire d'ajouter un script à votre overlay et d'insérer vos éléments lorsque l'évènement load se déclenchera sur la fenêtre XUL maître.

Débogage d'extensions

Outils analytiques de débogage

  • L'Inspecteur DOM — inspectez les attributs, la structure DOM, les règles de style CSS qui sont appliquées (c'est-à-dire découvrez pourquoi vos règles de style ne semblent pas fonctionner sur un élément — un outil indispensable !)
  • Venkman — définissez des points d'arrêt en JavaScript et examinez les piles d'appel
  • arguments.callee.caller en JavaScript — accédez à la pile d'appel d'une fonction

Débogage avec printf

  • Utilisez dump("string") (consultez le lien pour plus de détails ; quelques modifications de configuration sont nécessaires)
  • Utilisez nsIConsoleService pour écrire dans la console JavaScript

Débogage avancé

Démarrage rapide

Vous pouvez utiliser l'outil en ligne Extension Wizard afin de générer une extension basique sur laquelle vous pourrez travailler.

La création d'une extension de type « Salut tout le monde ! », similaire à ce que vous pouvez générer à l'aide de l'outil Extension Wizard, est décrite ligne par ligne dans ce tutoriel de MozillaZine Knowledge Base (en).

Pour plus d'informations

Étiquettes et contributeurs liés au document

Étiquettes : 
 Contributeurs à cette page : teoli, tregagnon, fscholz, Chbok, Yozh88, BenoitL, Fredchat, Dylan.urbain, Verruckt, Shinigami, Omic, Omnisilver, Indigo, Mgjbot, Takenbot, Nicoprog, Jimich, Matdere, Gorrk, Nicogui, M'vy, JulienA
 Dernière mise à jour par : teoli,