Firefox-Addon erstellen und verteilen

Schon immer wollte ich mehr darüber wissen, wie im Firefox Addons erstellt werden. Weniger hinsichtlich der Programmierung in den verschiedenen Internettechnologien, mehr vom Prozess betrachtet, wie diese auf die Endgeräte kommen. Da kam nachfolgende Herausforderung in einem mittelständischen Unternehmen zur richtigen Zeit.

Aufgabenstellung

Die interne Bookshelf-Wissensdatenbank¹ ist für die Anwender leichter zugänglich zu machen. Das kann mit einem eigenen Suchdienst-Provider² erfolgen. Auch das Markieren eines Wortes auf einer beliebigen Website und Suche per Rechtsklick aus dem Kontextmenü heraus ist eine Möglichkeit. Besondere Herausforderung bei diesem Kunden: Viele Arbeitsplätze sind aus guten Gründen nicht mit dem Internet verbunden. Ein Deployment innerhalb des Enterprise AD³ muss per Gruppenrichtlinie⁴ von eigenen, nicht-öffentlichen Servern erfolgen.

Voraussetzungen

Zum Einsatz kommt ausschließlich der Firefox ESR⁵, eine für Unternehmen angepasste Version mit der Fähigkeit, Addons auch außerhalb von addons.mozilla.org⁶ (abgekürzt: AMO) installieren zu können. Mozilla nennt diese Art der Verteilung “self-distribution”.⁷ Darüber hinaus wird ein Firefox-Entwickler-Konto benötigt. Die Registrierung ist kostenlos und benötigt lediglich eine funktionierende Email-Adresse.⁸

Aufbau

Ein Firefox-Addon ist vereinfacht gesagt Javascript-Code, das im geöffneten Firefox zwischen Anwender und einer Website ausgeführt wird. Es kann auf Objekte und Events des Browsers über eine API zugreifen⁹ und ihm stehen alle Elemente einer geöffneten Website im DOM¹⁰ zur Verfügung.

Als Bundle¹¹ trägt ein Addon die Dateierweiterung .xpi¹² und ist nichts anderes als eine gezippte Datei. Die Struktur für die enthaltenen Skripte, Sprachfassungen, Dateisignaturen und sonstige Assets wie Grafiken und Icons ist vorgegeben. Die wichtigsten Informationen stehen in einer manifest.json Datei im Root des Bundles. Ein eindeutiger Name muss nach dem Schema addon-name@domain-des-herstellers zusammen gesetzt sein.¹³

Damit das Addon auf einen Rechtsklick reagieren kann, wird eine background.js Datei¹⁴ erstellt, die das Kontextmenü um einen Eintrag erweitert. Mit dem aktuell markierten Text als Suchbegriff wird ein neues Tab mit den Suchergebnissen geöffnet. Der Host books.name.local in den nachfolgenden Quelltexten ist als Platzhalter zu verstehen.

browser.browserAction.onClicked.addListener(
  function(tab) {
    browser.tabs.create( { url: "https://books.name.local" } );
    }
);

searchBooks = function(word) {
  var query = word.selectionText;
  query = query.replace(" ",  " ");
  browser.tabs.create({url: "https://books.name.local/search?term=" + query});
};

browser.contextMenus.create({
  title: "Suche in Wissensdatenbank nach \"%s\"",
  contexts:["selection"],
  onclick: searchBooks
});

Zusätzlich ist die Wissensdatenbank als Such-Provider im Firefox anzulegen. Das erfolgt in der für jedes Addon obligatorischen Manifest-Datei im Abschnitt “chrome_settings_overrides”:¹⁵

 "chrome_settings_overrides": {
 	"search_provider": {
		"name": "Interne Wissensdatenbank",
		"keyword": "@books",
      		"favicon_url": "https://books.name.local/favicon.ico",
      		"search_url": "https://books.name.local/search?term={searchTerms}",
      		"encoding": "UTF-8",
      		"is_default": true
    		}
	},

Auch wenn das Erstellen eines Addons als 5-Minuten-Sache beworben wird¹⁶ habe ich mit 2-3 Stunden deutlich länger gebraucht. Haupthindernis war die schlechte und unübersichtliche Dokumentation im Mozilla Development Network¹⁷. Vor 10-15 Jahren war diese einst wegweisend und Referenz für alle Internet-Technologien. Heute ist diese gefühlt nur noch ein Schatten ihrer selbst. Aus für mich unerklärlich und besonders ärgerlichen Gründen fehlen Datumsangaben oder mindestens Hinweise “Achtung, nicht mehr gültig!” auf veraltete Versionen. So habe ich zum Beispiel Zeit für ein Bash-Skript verloren, weil ich fälschlicherweise annahm, die Signaturen im .xpi Bundle selbst vor einem Upload erzeugen zu müssen. Erfreulicherweise erledigt das Mozilla, zeigt aber eine Warnung.

Das Signieren und Freischalten erfolgte erfreulich schnell. Gefühlt nur wenige Minuten nach dem Upload konnte ich die fertige .xpi Datei wieder herunter laden. Antworten auf Fragen nach dem Quelltext oder Review-Hinweise an Mozilla brauchte ich nicht zu geben.

Ein alternativer Weg ohne Web-Oberfläche ist mit dem Kommandozeilen-Tool web-ext möglich.¹⁸ Bei weiterer Betrachtung, insbesondere dessen Voraussetzungen und Abhängigkeiten, habe ich von einer Installation Abstand genommen.¹⁹

Deployment

Das Side-Loading durch einfaches Kopieren der Datei in einen Ordner funktioniert seit Firefox 74 nicht mehr.²⁰ Wer ein Addon nur für sich erstellt, kann es manuell durch Öffnen im Firefox ESR auch ohne Signing nutzen. Die Nutzung in einem Standard-Firefox oder bei Download von einem eigenen Server macht ein Signing durch Mozilla erforderlich.²¹ Ein Webserver mit der .xpi Datei muss den entsprechenden Content-Type gesetzt haben.²²

Für das AD-Deployment im Netzwerk des Kunden wird das neue Addon in die Liste der bestehenden Addons mit dem https-Download-Link aufgenommen. Zusätzlich sind die “sicheren” Addon-Seiten um den eigenen Server zu ergänzen. Das .admx Template kann von Github geladen werden.²³ Das Mozilla-Projekt bietet leider keine eigene Ressourcen.

Positiv bei der automatischen Verteilung via Gruppenrichtlinien im Vergleich zur manuellen Weitergabe ist, dass Endanwender nicht mit zusätzlichen Sicherheitshinweisen oder Nachfragen im Firefox belästigt werden. Lediglich bei Änderung der Standard-Suchmaschine gibt es eine.

Wie es sich gehört bekam der Kunde das Firefox-Addon für die Suche in seiner internen Wissensdatenbank als Git-Repository in einer freien GPL-Lizenz übergeben.

Zusammenfassung

Hat man den Bogen einmal raus, ist das Erstellen, Signieren und Verteilen von Firefox-Addons sehr einfach. Der Firefox übernimmt bei Hinterlegung einer passenden Update-URL in der Manifest-Datei auch die automatische Aktualisierung sofern keine anderweitigen Einstellungen in einer Gruppenrichtlinie dem entgegenstehen.

In der Theorie lassen sich Addons browserübergreifend sowohl für Mozilla Firefox, Google Chrome, Microsoft Edge, Apple Safari und demnächst auch Gnome Web erstellen. Praktisch unterscheiden sich die APIs so deutlich, dass ich mich bei dem Versuch in eine Zeit zurück geworfen fühlte, als unter jeder Seite ein “Best viewed in 800x600 with” Button eingeblendet war.

Die Dokumentation im Mozilla Development Network empfinde ich als suboptimal, wenn nicht sogar sträflich vernachlässigt. Für mich leider ein Anzeichen für krasses Mißmanagement²⁴, wo viel Geld in Marketing und Management geworfen wird. Die relevanten Dinge²⁵ und eine schlanke Engine zum Einbinden in eigene Softwareprojekte á la Blink²⁶ oder WebKit²⁷ fehlen. Das aber ist eine Geschichte für ein andermal.

In diesem Sinne,
Euer Tomas Jakobs