Fix toolbar icon customization in Australis

lib/customizableUI.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2013 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
  * @fileOverview This emulates a subset of the CustomizableUI API from Firefox 28.
  */
 
+let {XPCOMUtils} = Cu.import("resource://gre/modules/XPCOMUtils.jsm", null);
+
 let {Utils} = require("utils");
 
+// UI module has to be referenced lazily to avoid circular references
+XPCOMUtils.defineLazyGetter(this, "UI", function() require("ui").UI);
+
 let widgets = Map();
-
-function findElement(/**Window*/ window, /**String|String[]*/ id) /**Element*/
-{
-  if (id instanceof Array)
-  {
-    for (let candidate of id)
-    {
-      let result = window.document.getElementById(candidate);
-      if (result)
-        return result;
-    }
-    return null;
-  }
-  else
-    return window.document.getElementById(id);
-}
 
 function getToolbox(/**Window*/ window, /**Widget*/ widget) /**Element*/
 {
   if (!("defaultArea" in widget) || !widget.defaultArea)
     return null;
 
-  let toolbar = findElement(window, widget.defaultArea);
+  let toolbar = UI.findElement(window, widget.defaultArea);
   if (!toolbar)
     return null;
 
   let toolbox = toolbar.toolbox;
   if (toolbox && ("palette" in toolbox) && toolbox.palette)
     return toolbox;
   else
     return null;
 }
 
@@ skipping 10 matching lines @@
   for (let child of toolbox.palette.children)
     if (child.id == id)
       return child;
 
   return null;
 }
 
 function restoreWidget(/**Element*/ toolbox, /**Widget*/ widget)
 {
   // Create node
-  let node = toolbox.ownerDocument.createElement("toolbarbutton");
-  node.setAttribute("id", widget.id);
+  let node = widget.onBuild(toolbox.ownerDocument);
   if (typeof widget.onClick == "function")
     node.addEventListener("click", widget.onClick, false);
   if (typeof widget.onCommand == "function")
     node.addEventListener("command", widget.onCommand, false);
-  if (typeof widget.onCreated == "function")
-    widget.onCreated(node);
 
   // Insert into the palette first
   toolbox.palette.insertBefore(node, toolbox.palette.firstChild);
 
   // Now find out where we should put it
   let position = toolbox.getAttribute(widget.positionAttribute);
   if (!/^\S*,\S*,\S*$/.test(position))
     position = null;
 
   if (position == null)
@@ skipping 44 matching lines @@
   if (visible == "visible" && !parent)
   {
     let insertionPoint = {
       parent: widget.defaultArea
     };
     if (typeof widget.defaultBefore != "undefined")
       insertionPoint.before = widget.defaultBefore;
     if (typeof widget.defaultAfter != "undefined")
       insertionPoint.after = widget.defaultAfter;
 
-    let {UI} = require("ui");
     [parent, before] = UI.resolveInsertionPoint(toolbox.ownerDocument.defaultView, insertionPoint);
   }
 
   if (parent && parent.localName != "toolbar")
     parent = null;
 
   if (visible != "visible")
   {
     // Move to palette if the item is currently visible
     let node = toolbox.ownerDocument.getElementById(widget.id);
@@ skipping 35 matching lines @@
     saveState(toolbox, widget);
 }
 
 function saveState(/**Element*/ toolbox, /**Widget*/ widget)
 {
   let node = toolbox.ownerDocument.getElementById(widget.id);
 
   let position = toolbox.getAttribute(widget.positionAttribute) || "hidden,,";
   if (node)
   {
-    if (typeof widget.onCreated == "function")
-      widget.onCreated(node);
+    if (typeof widget.onAdded == "function")
+      widget.onAdded(node)
 
     let toolbar = getToolbar(node);
     position = "visible," + toolbar.id + "," + (node.nextSibling ? node.nextSibling.id : "");
   }
   else
     position = position.replace(/^visible,/, "hidden,")
 
   toolbox.setAttribute(widget.positionAttribute, position);
   toolbox.ownerDocument.persist(toolbox.id, widget.positionAttribute);
 }
 
 let CustomizableUI = exports.CustomizableUI =
 {
   createWidget: function(widget)
   {
     if (typeof widget.id == "undefined" ||
         typeof widget.defaultArea == "undefined" ||
         typeof widget.positionAttribute == "undefined")
     {
       throw new Error("Unexpected: required property missing from the widget data");
     }
     widgets.set(widget.id, widget);
 
     // Show widget in any existing windows
-    let {UI} = require("ui");
     for (let window of UI.applicationWindows)
     {
       let toolbox = getToolbox(window, widget);
       if (toolbox)
       {
         toolbox.addEventListener("aftercustomization", onToolbarCustomization, false);
         restoreWidget(toolbox, widget);
       }
     }
   },
 
   destroyWidget: function(id)
   {
     // Don't do anything here. This function is called on shutdown,
     // removeFromWindow will take care of cleaning up already.
   },
 
   getPlacementOfWidget: function(id)
   {
-    let {UI} = require("ui");
     let window = UI.currentWindow;
     if (!window)
       return null;
 
     let widget = window.document.getElementById(id);
     if (!widget)
       return null;
 
     let toolbar = getToolbar(widget);
     if (!toolbar)
       return null;
 
-    let items = toolbar.currentSet.split(",");
-    let index = items.indexOf(id);
-    if (index < 0)
-      return null;
-    else
-      return {area: toolbar.id, placement: index};
-  },
-
-  addWidgetToArea: function(id, area, position)
-  {
-    let {UI} = require("ui");
+    return {area: toolbar.id};
+  },
+
+  addWidgetToArea: function(id)
+  {
+    // Note: the official API function also has area and position parameters.
+    // We ignore those here and simply restore the previous position instead.
     let widget = widgets.get(id);
     for (let window of UI.applicationWindows)
     {
       let toolbox = getToolbox(window, widget);
       if (!toolbox)
         continue;
 
       let position = toolbox.getAttribute(widget.positionAttribute);
       if (position)
         position = position.replace(/^hidden,/, "visible,");
       showWidget(toolbox, widget, position);
     }
   },
 
   removeWidgetFromArea: function(id)
   {
-    let {UI} = require("ui");
     let widget = widgets.get(id);
     for (let window of UI.applicationWindows)
     {
       let toolbox = getToolbox(window, widget);
       if (!toolbox)
         continue;
 
       let position = toolbox.getAttribute(widget.positionAttribute);
       if (position)
         position = position.replace(/^visible,/, "hidden,");
@@ skipping 34 matching lines @@
     for (let [id, widget] of widgets)
     {
       let toolbox = getToolbox(window, widget);
       if (toolbox)
         toolbox.removeEventListener("aftercustomization", onToolbarCustomization, false);
 
       removeWidget(window, widget);
     }
   }
 });