Mise à jour des extensions pour Firefox 3

Un article de MDC.

Cet article fournit des informations qui seront utiles pour les développeurs désirant mettre à jour leurs extensions pour qu'elles fonctionnent correctement avec Firefox 3.

Avant d'aller plus loin, voici une indication utile : si la seule modification dont votre extension a besoin est une mise à jour du champ maxVersion dans son manifeste d'installation, et que celle-ci est hébergée sur addons.mozilla.org, il n'est pas vraiment nécessaire de renvoyer une nouvelle version de votre extension ! Utilisez simplement le Developer Control Panel sur AMO pour ajuster la valeur de maxVersion. Cela vous évitera également la revérification de votre extension.

[modifier] Première étape : mise à jour du manifeste d'installation

La première étape — et pour la plupart des extensions la seule qui sera nécessaire — est de mettre à jour le fichier de manifeste d'installation, install.rdf, pour indiquer sa compatibilité avec Firefox 3.

Trouvez simplement la ligne indiquant la version maximale compatible de Firefox (qui, pour Firefox 2, ressemblait probablement à ceci) :

 <em:maxVersion>2.0.0.*</em:maxVersion>

Modifiez-la pour indiquer la compatibilité avec Firefox 3 :

 <em:maxVersion>3.0.*</em:maxVersion>

Et réinstallez ensuite votre extension.

Notez que Firefox 3 n'a plus besoin d'un « .0 » supplémentaire dans son numéro de version, donc au lieu d'utiliser « 3.0.0.* », il ne faut plus indiquer que « 3.0.* ».

Il y a eu (et il y aura encore) un certain nombre de changements dans les API qui poseront probablement des problèmes à certaines. Nous sommes encore en train d'établir une liste complète de ces changements.

[modifier] Ajout de localisations au manifeste d'installation

Firefox 3 permet d'utiliser de nouvelles propriétés dans le manifeste d'installation pour spécifier des descriptions localisées. Les anciennes méthodes continuent à fonctionner, mais la nouvelle permet à Firefox de charger les localisations même lorsque le module complémentaire est désactivé ou sur le point d'être installé. Consultez Localisation des descriptions d'extensions pour plus de détails.

[modifier] Deuxième étape : s'assurer de fournir des mises à jour sécurisées

Si vous hébergez des modules complémentaires vous-mêmes et pas sur un fournisseur d'hébergement sécurisé comme addons.mozilla.org, vous devrez fournir une méthode sécurisée de mise à jour pour vos modules. Pour ce faire, il faudrait soit héberger vos mises à jour sur un site SSL, ou utiliser des clés cryptographiques pour signer les informations de mise à jour. Consultez Mises à jour sécurisées pour plus d'informations.

[modifier] Troisième étape : s'occuper des changements d'API

Plusieurs API ont changé de manière significative. Les changements les plus importants, qui affecteront probablement un grand nombre d'extensions, sont les suivants :

[modifier] DOM

Les nœuds provenant de documents externes doivent être clonés à l'aide de importNode (ou adoptés avec adoptNode) avant de pouvoir être insérés dans le document courant. Pour en savoir plus sur les problèmes de ownerDocument, consultez la FAQ DOM du W3C (en anglais).

Gecko n'obligeait pas à utiliser importNode et adoptNode avant sa version 1.9. Depuis les versions 1.9 alphas, si un nœud n'est pas adopté ou importé avant d'être utilisé dans un autre document, l'exception WRONG_DOCUMENT_ERR est déclenchée (NS_ERROR_DOM_WRONG_DOCUMENT_ERR).

[modifier] Marque-pages et historique

Si votre extension accède aux marque-pages ou à des données de l'historique d'une manière ou d'une autre, elle devra être substantiellement modifiée pour être compatible avec Firefox 3. Les anciennes API pour accéder à ces informations ont été remplacées par la nouvelle architecture Places. Consultez le guide de migration pour Places pour des détails sur la mise à jour de vos extensions existantes en utilisant l'API Places.

[modifier] Gestionnaire de téléchargement

L'API du gestionnaire de téléchargement a légèrement changé suite à la transition d'un stockage de données RDF vers l'API Storage. La transition devrait être très facile à faire. En outre, l'API permettant d'examiner la progression des téléchargements a été modifiée pour permettre l'existence de plusieurs écouteurs sur le gestionnaire de téléchargement. Consultez nsIDownloadManager, nsIDownloadProgressListener et Surveillance de téléchargements pour plus d'informations.

[modifier] Gestionnaire de mots de passe

Si votre extension accède à des informations d'identification à l'aide du Gestionnaire de mots de passe, elle devra être adaptée pour utiliser la nouvelle API du gestionnaire d'identification.

• L'article Utilisation de nsILoginManager fournit des exemples, dont une démonstration d'écriture d'extension fonctionnant à la fois avec le Gestionnaire de mots de passe et le Gestionnaire d'identification, afin qu'elle fonctionne tant avec Firefox que dans les versions précédentes.
• nsILoginInfo
• nsILoginManager

[modifier] Interfaces supprimées

Les interfaces suivantes ont été retirées de Gecko 1.9, sur lequel se base Firefox 3. Si votre extension utilise l'une ou l'autre d'entre-elles, vous devrez mettre à jour votre code :

• nsIDOMPaintListener
• nsIDOMScrollListener
• nsIDOMMutationListener
• nsIDOMPageTransitionListener

[modifier] Autres changements

Ajoutez ici les changements simples que vous avez dû faire à vos extensions pour qu'elles fonctionnent avec Firefox 3.

• Les implémentations de nsIAboutModule doivent à présent supporter la méthode getURIFlags. Consultez nsIAboutModule.idl pour la documentation. Ceci affecte les extensions qui fournissent de nouvelles URI about:. (bug 337746)
• L'élément tabbrowser ne fait plus partie du « toolkit » (bug 339964). Cela signifie qu'il n'est plus disponible pour les applications XUL et extensions. Il continue cependant à être utilisé dans la fenêtre principale de Firefox (browser.xul).
• Les changements dans les proxys nsISupports [1] et éventuellement aux interfaces liées aux threads doivent être documentés.
• Si vous utilisez des instructions de traitement XML processing comme <?xml-stylesheet ?> dans vos fichiers XUL, tenez compte des changements effectués dans le bug 319654 :
  1. Les instructions de traitement XML sont à présent ajoutées au DOM des documents XUL. Cela signifie que document.firstChild n'est plus forcément l'élément racine. Si vous avez besoin de l'élément racine dans votre script, utilisez plutôt document.documentElement.
  2. Les instructions de traitement <?xml-stylesheet ?> et <?xul-overlay ?> n'ont plus d'effet en dehors du prologue du document.
• window.top.addEventListener("load", onTidyBrowserTopLoad, true) n'est pas appelé pour tous les cadres et sous-cadres. Une solution est proposée à l'adresse suivante : http://www.htmlpedia.org/wiki/InternalFirefox3
• content.window.getSelection() fournit un objet (qui peut être converti en une chaîne avec toString()), contrairement à l'ancienne content.document.getSelection(), à présent dépréciée, qui renvoie une chaîne.