Erweiterungen für Firefox 3 aktualisieren

Dieser Artikel liefert nützliche Informationen für Entwickler, die ihre Erweiterungen aktualisieren möchten, um eine einwandfreie Funktion unter Firefox 3 zu gewährleisten.

Vorweg eine hilfreiche Anmerkung: Wenn die einzig notwendige Änderung an der Erweiterung der Eintrag maxVersion im Installationsmanifest ist und die Erweiterung auf addons.mozilla.org bereitgestellt wird, ist es nicht nötig eine neue Version der Erweiterung zu veröffentlichen. Im »Developer Control Panel« auf AMO kann die maxVersion, ohne einen neuen Upload, eingestellt werden. Dadurch kann auch vermieden werden, dass die Erweiterung nochmal überprüft werden muss.

Schritt 1: Installationsmanifest aktualisieren

Der erste Schritt - und für die meisten Erweiterungen der einzig Nötige - ist eine Aktualisierung der Installationsmanifestdatei, install.rdf, um die Erweiterung als Firefox 3 kompatibel zu kennzeichnen.

Als erstes muss die Zeile zur Kennzeichnung der maximal kompatiblen Firefox-Version gefunden werden (welche für Firefox 2 so aussehen sollte):

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

Um als Firefox 3 kompatibel zu gelten, reicht die folgende Änderung:

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

Danach muss die Erweiterung neu installiert werden.

Dabei sollte darauf geachtet werden, dass Firefox 3 keine extra ".0" in der Versionsnummer hat, anstatt "3.0.0.*, sollte nur "3.0.*" verwendet werden.

Es gab (und es wird weiterhin welche geben) eine Reihe von API Veränderungen, die dazu führen, dass einige Erweiterungen nicht weiter funktionieren. Es wird an einer kompletten Liste gearbeitet, die diese Veränderungen aufzählt.

Hinweis: Wenn die Erweiterung noch immer ein Install.js Skript, anstatt eines Installationsmanifests benutzt, sollte ein Wechsel jetzt getätigt werden. Firefox 3 unterstützt keine install.js Skripte in XPI Dateien mehr.

Das Installationsmanifest lokalisieren

Firefox 3 führt neue Eigenschaften ein, um lokalisierte Beschreibungen zu ermöglichen. Die alte Methode funktioniert nach wie vor, auch wenn die neue Firefox-Version erlaubt, sogar dann die lokalisierten Sprachdaten zu nutzen, wenn die Erweiterung deaktiviert oder noch zur Installation vorgesehen ist.

Schritt 2: Sichere Updates zur Verfügung stellen

Falls die Erweiterungen selbst bereitgestellt wird und nicht bei addons.mozilla.org angeboten wird, müssen sichere Updates selbst verwaltet werden. Dazu können die Updates entweder über eine SSL Webseite angeboten werden oder die Updates werden mit einem Kryptographieschlüssel signiert. Weitere Informationen dazu unter: Sichere Updates.

Schritt 3: Mit geänderten APIs umgehen

Mehrere APIs haben sich erheblich geändert. Die wichtigsten davon, die sich auf viele Erweiterungen auswirken, sind:

DOM

Nodes from external documents should be cloned using document.importNode() (or adopted using document.adoptNode()) before they can be inserted into the current document. For more on the Node.ownerDocument issues, see the W3C DOM FAQ.

Firefox doesn't currently enforce this rule (it did for a while during the development of Firefox 3, but too many sites break when this rule is enforced). We encourage Web developers to fix their code to follow this rule for improved future compatibility.

Lesezeichen & Chronik

Falls die Erweiterung in irgendeiner Art auf Lesezeichen oder die Chronik zugreift, sind umfangreichere Änderungen nötig, um die Kompatibilität mit Firefox 3 zu gewährleisten. Die alte API zum Zugriff auf diese Informationen wurde durch die neue Places Architektur ersetzt. Im Leitfaden zur Places Migration finden sich dazu weitere Details, auch wie die bestehende Erweiterung auf die »Places« API aktualisiert werden kann.

Download-Manager

Die Download-Manager API hat sich durch den Wechsel vom RDF Datenspeicher zur Storage API ein wenig geändert. Der Wechsel sollte relativ einfach durchzuführen sein. Außerdem hat sich die API zum Überwachen des Downloadfortschritts geändert, um mehrere Download-Manager Listeners zu unterstützen. Unter nsIDownloadManager, nsIDownloadProgressListener und Downloads überwachen sind weitere Informationen verfügbar.

Passwort-Manager

Wenn die Erweiterung den Passwort-Manager benutzt, um auf Anmeldeinformationen zuzugreifen muss die Erweiterung auf die neue Login Manager API umgestellt werden.

Der Artikel Verwendung von nsILoginManager enthält Beispiele. Darunter findet sich auch eine Demo wie die Erweiterung sowohl den Passwort-Manager als auch den Login-Manager benutzen kann. Dadurch kann die Erweiterung von Firefox 3 und von früheren Versionen genutzt werden.
nsILoginInfo
nsILoginManager

Es kann aber auch der integrierte Speicher des Passwort-Managers überschrieben werden, falls eine eigene Implementierung in der Erweiterung angeboten werden soll. Weitere Details unter Ein Login-Manager Speichermodul erstellen.

Popups (Menü, Kontextmenü, Tooltips und Eingabefelder)

Das XUL Popup-System wurde im Firefox 3 stark verändert. Das Popup-System umfasst Hauptmenüs, Kontextmenüs und Popup Eingabefelder. Der Artikel zu Popups beschreibt detailliert wie das System funktioniert. Zu beachten ist außerdem, dass popup.showPopup zugunsten von popup.openPopup und popup.openPopupAtScreen als veraltet gekennzeichnet wurde.

Autovervollständigung

Die handleEnter() Methode im nsIAutoCompleteController Interface wurde um ein Argument erweitert. Dieses kennzeichnet, ob der abgesendete Text im Autovervollständigungspopup ausgewählt wurde oder, ob der Benutzer nach seiner Eingabe »Enter« gedrückt hat.

DOMParser

Wenn ein DOMParser instanziiert wird, erbt er das vom aufrufenden Code repräsentierte Dokument sowie documentURI und baseURI des aufrufenden Fensters.
Hat der Aufrufende Code UniversalXPConnect Privilegien, kann er Parameter an new DOMParser() übergeben. Werden weniger als drei Parameter übergeben werden die übrig gebliebenen standardmäßig mit null belegt.
- Der erste Parameter ist das zu parsende Dokument und überschreibt den für gewöhnlich geerbten Standardwert.
- Der zweite Parameter enthält documentURI.
- Der dritte Parameter enthält baseURI.
Falls ein DOMParser durch einen Auftrag aufgerufen wird, wie z.B. durch createInstance(), nicht die init() Methode des DOM-Parsers aufgerufen wird und versucht wird eine Parseroperation zu starten, wird der DOMParser automatisch mit einem null Dokument und null Verweisen auf documentURI und baseURI erstellt und instanziiert.

Keine weitere Verwendung der internen String API

Die interne String API wird nicht weiter ausgeführt, stattdessen muss die externe String API benutzt werden. Einige nützliche Informationen dazu:

Entfernte Interfaces

Folgende Interfaces wurden aus, der im Firefox 3 enthaltenen, Gecko-Engine 1.9 entfernt. Wenn die Erweiterung eines davon nutzt, muss der Code aktualisiert werden:

nsIDOMPaintListener
nsIDOMScrollListener
nsIDOMMutationListener
nsIDOMPageTransitionListener
nsICloseAllWindows (Siehe Bug 386200)

Schritt 4: Auf Chrome Änderungen überprüfen

Es gab einige Veränderungen im Chrome-Layout, die eventuell auch Erweiterungen betreffen.

Neue Boxen

Es wurden kleinere Änderungen an der Oberfläche vorgenommen, die Änderungen an der Erweiterung nötig machen könnten. Eine neue vbox mit dem Namen »browser-bottombox« wurde hinzugefügt, welche die »Find Bar« und die »Status Bar« am unteren Rand des Browsers umschließt. Auch wenn dies nicht die Anzeige selbst beeinflusst, kann dies deine Erweiterung betreffen falls diese »Overlays« verwendet, die Elemente ändern, die relativ zu besagten Elementen positioniert sind.

Zum Beispiel, wenn vorher etwas überlagert wurde, wie im folgendem Codeschnipsel:

<window id="main-window">
  <something insertbefore="status-bar" />
</window>

Sollte es nun so überlagert werden:

<vbox id="browser-bottombox">
  <something insertbefore="status-bar" />
</vbox>

Oder, um Firefox 2 und Firefox 3 gleichermaßen zu behandeln, kann der folgende Code zum Einsatz kommen:

<window id="main-window">
  <vbox id="browser-bottombox" insertbefore="status-bar">
    <something insertbefore="status-bar" />
  </vbox>
</window>

Veränderte Boxen

Erweiterungen, die auf die »appcontent« Box überlagern wollten, versuchten dies über das Floaten von Chrome-Inhalten über Dokumenteninhalten. Jetzt wird dann nicht mehr angezeigt. Die Erweiterung sollte auf das neue XUL panel Element aktualisiert werden. Falls es erwünscht ist, dass das Panel nach einer Verzögerung weiter angezeigt wird, sollte noautohide auf true gesetzt werden.

Weitere Änderungen

Einfache Änderungen, die Sie bei der Aktualisierung Ihrer Erweiterung auf Firefox 3 machen mussten, können Sie hier gerne eintragen!

chrome://browser/base/utilityOverlay.js wird aus Sicherheitsgründen nicht länger unterstützt. Falls dies vorher verwendet wurde, sollte auf chrome://browser/content/utilityOverlay.js. gewechselt werden.
Bei nsIAboutModule Implementierungen wird nun getURIFlags Methode benötigt. Siehe nsIAboutModule.idl für weitere Dokumentation. Das betrifft Erweiterungen, die neue about: URIs verwenden. (Bug 337746)
Das tabbrowser Element ist kein Teil mehr von »toolkit« (Bug 339964). Das bedeutet, dass dieses Element nicht länger für XUL Anwendungen und Erweiterungen verfügbar ist. Es wird weiterhin in Firefox' Hauptfenster (browser.xul) benutzt.
Veränderungen an nsISupports proxies und möglicherweise ab Thread-bezogenen Interfaces muss noch dokumentiert werden.
Wenn XML Prozessanweisungen wie <?xml-stylesheet ?> in XUL Dateien verwendet werden, sollten Änderungen durch Bug 319654 beachtet werden:
1. XML Prozessanweisungen werden nun in das XUL DOM hinzugefügt. Das bedeutet, dass document.firstChild nicht unbedingt mehr das Root-Element sein muss. Wenn das Wurzelelement angesprochen werden muss sollte document.documentElement verwendet werden.
2. <?xml-stylesheet ?> und <?xul-overlay ?> Prozessanweisungen haben jetzt außerhalb des Dokumentprologs keinen Effekt mehr.
window.addEventListener("load", myFunc, true) wird nicht ausgeführt, wenn Webinhalte geladen werden (Browser eine Seite lädt). Durch Bug 296639 wurde die Art und Weise in der innere und äußere Fenster kommunizieren verändert. Ein einfacher Fix, der auch in Firefox 2 funktioniert: gBrowser.addEventListener("load", myFunc, true) wie hier beschrieben.
content.window.getSelection() gibt ein Objekt zurück (welches durch toString() zu einem String umgewandelt werden kann), im Gegensatz zu dem jetzt veraltetem content.document.getSelection(), welches einen String zurück gibt.
event.preventBubble() war Firefox 2 in deprecated und wurde in Firefox 3 entfernt. Es sollte event.stopPropagation() verwendet werden, was in Firefox 2 ebenso funktioniert.
Timers, die durch setTimeout() initialisiert wurden, werden nun von modalen Fenstern, durch den Fix von Bug 52209, geblockt. Es könnte nsITimer stattdessen verwendet werden.
Wenn die Erweiterung einer nicht vertrauten Quelle (z.B. eine Webseite) Zugang zu Chrome zulassen muss, sollte die neue contentaccessible Flag benutzt werden.