Fuel

Fuel

Mozilla Add-ons Workshop,
20 septembre 2008

Laurent Jouanneau

• "Senior Software Engineer" chez Disruptive Innovations
• Domaines d'expertise :
  • Standards du web (openweb.eu.org)
  • Développement web avec PHP
  • Technologie Mozilla (xulfr.org)

• Vous avez dit Fuel ?
• Fuel, et le développement devient aisé
• Les objets Fuel
• Le futur de Fuel

• L'usage des composants XPCOM en JS est
  • rebarbatif
  • Souvent API "bas niveau"
  • parfois même complexe
  • pour finalement un résultat simple
• Cela rend les extensions difficiles à développer, à maintenir...
• La solution: FUEL

• Nouveauté dans Firefox 3.0
• Bibliothèque d'objets encapsulant l'API
  de quelques composants XPCOM courant dans le développement d'une extension
• Facilite le développement

Récupérer une préférence avec XPCOM :

var prefs =
  Components
    .classes["@mozilla.org/preferences-service;1"]
    .getService(Components.interfaces.nsIPrefService)
    .getBranch("browser.zoom.");
var isZoom = prefs.getBoolPref("full");
            

Avec FUEL :

  var isZoom = Application
              .prefs
              .getValue("browser.zoom.full", true);
            

• Un objet principal : Application
• Propriétés simples : id, name, version
• Propriétés pour accéder aux autres composants :
  • console
  • extensions
  • prefs
  • storage
  • events
  • bookmarks
  • windows et activeWindow

Application.console.log("message")

Affiche un message

Application.console.open()

Ouvre la fenêtre de console

.has("foo.bar")

La préférence existe-t-elle ?

.getValue("foo.bar", "default")

Récupère une valeur

.setValue("foo.bar","valeur")

Change la valeur

.get("foo.bar")

Renvoi un objet Preference :
name, type, value, locked, modified, branch, events

Application.extensions
.get("extensionid").prefs.get("foo.bar")

Récupère la préference "extensions.extensionid.foo.bar"

Récupèrer un objet Extension :

var ext = Application.extensions.get("extension_id")

• Propriétés : id, name, version
• firstRun : indique si il s'agit du premier démarrage de l'extension
• prefs, storage, events (uninstall)

Permet de stocker des données durant le temps de vie de l'application

Application.storage...

• .has(name)
• .get(name, defaultvalue)
• .set(name, value)

= stockage centralisé pour toutes les fenêtres

function onUninstall(event) {
  // code...
}
var ext = Application.extensions.get("extension_id");

ext.events.addEventListener("uninstall", onUninstall);
ext.events.removeEventListener("uninstall", onUninstall);
        

var win = Application.activeWindow

Récupérer la fenêtre courante

win.tabs

liste des onglets

win.activeTab

L'onglet courant

win.open(nsIURIobject)

Ouvre un nouvel onglet

win.events

events: TabOpen, TabClose, TabMove, TabSelect

function onTabOpen(event) {
  // faire quelque chose
}

var activeWin = Application.activeWindow;
activeWin.events.addListener("TabOpen", onTabOpen);

var browserTab = activeWin.open(url("http://mozilla.org"));

// helper  (pourquoi pas plus simple ?)
function url(spec) {
  var ios = Components
    .classes["@mozilla.org/network/io-service;1"]
    .getService(Components.interfaces.nsIIOService);
  return ios.newURI(spec, null, null);
}

tab.document

la page html affichée

tab.focus()

tab.close()

tab.moveBefore(otherTab)

tab.moveToEnd()

+/- redondance avec la balise tabbrowser

• Objet BookmarkFolder pour représenter les répertoires
• Objet Bookmark pour représenter un bookmark
• Application.bookmarks : liste des répertoires racines
  • menu
  • toolbar
  • tags
  • unfield

addBookmark(titre, URI), addSeparator(),
addFolder(titre), remove()

id, title, description, type

annotations

parent, children

events

event possible: "add", "addchild", "remove", "removechild", "change", "move"

remove()

id, title, uri, description, keywords, type

annotations

parent

events

events possible : "remove", "change", "visit", "move"

var bookmark =
  Application.bookmarks.toolbar
    .addBookmark("Mozilla", url("http://www.mozilla.com"));
bookmark.keyword = "webdev";

alert(bookmark.title);
alert(bookmark.uri.spec);

bookmark.events.addListener("change",
      function(event) { alert(event.data); });
bookmark.title = "MoCo"; // should alert "title"

• Pas de grandes evolutions prévues
• Évolutions en fonction des demandes des développeurs d'extensions
• Manipulation des sidebars ?
• Gestion des moteurs de recherche ?
• Impression ?
• Manipuler les fichiers ?