Added abstraction for frames, to fix domain-based rules, whitelisting and ad counter on Safari

safari/ext/background.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
@@ skipping 63 matching lines @@
     }
   };
 
 
   /* Tabs */
 
   Tab = function(tab)
   {
     this._tab = tab;
 
+    this.browserAction = new BrowserAction(this);
+
     this.onLoading = new LoadingTabEventTarget(tab);
     this.onBeforeNavigate = new TabEventTarget(tab, "beforeNavigate", false);
     this.onCompleted = new TabEventTarget(tab, "navigate", false);
     this.onActivated = new TabEventTarget(tab, "activate", false);
     this.onRemoved = new TabEventTarget(tab, "close", false);
   };
   Tab.prototype = {
     get url()
     {
       return this._tab.url;
     },
     close: function()
     {
       this._tab.close();
     },
     activate: function()
     {
       this._tab.activate();
     },
     sendMessage: function(message, responseCallback)
     {
       _sendMessage(
         message, responseCallback,
         this._tab.page, this._tab
       );
-    },
-    browserAction: {
-      setIcon: function(path)
-      {
-        safari.extension.toolbarItems[0].image = safari.extension.baseURI + path;
-      },
-      setTitle: function(title)
-      {
-        safari.extension.toolbarItems[0].toolTip = title;
-      },
-      setBadge: function(badge)
-      {
-        if (!badge)
-          safari.extension.toolbarItems[0].badge = 0;
-        else if ("number" in badge)
-          safari.extension.toolbarItems[0].badge = badge.number;
-      }
     }
   };
 
   TabMap = function(deleteTabOnBeforeNavigate)
   {
     this._tabs = [];
     this._values = [];
 
     this._deleteOnEvent = this._deleteOnEvent.bind(this);
     this._deleteTabOnBeforeNavigate = deleteTabOnBeforeNavigate;
@@ skipping 41 matching lines @@
       {
         this._tabs.splice(idx, 1);
         this._values.splice(idx, 1);
 
         tab.removeEventListener("close", this._deleteOnEvent, false);
         tab.removeEventListener("beforeNavigate", this._deleteOnEvent, false);
       }
     },
     _deleteOnEvent: function(event)
     {
-      // delay so that other event handlers can still lookup this tab
+      // delay so that other event handlers can still look this tab up
       setTimeout(this._delete.bind(this, event.target), 0);

[Felix Dahlke, 2014/01/18 13:39:19]

s/lookup this tab/look this tab up/

[Sebastian Noack, 2014/01/19 10:19:40]

Done.

     }
   };
   TabMap.prototype["delete"] = function(tab)
   {
     this._delete(tab._tab);
   };
+
+  ext.tabs = {
+    onLoading: new LoadingTabEventTarget(safari.application),
+    onBeforeNavigate: new TabEventTarget(safari.application, "beforeNavigate", true),
+    onCompleted: new TabEventTarget(safari.application, "navigate", true),
+    onActivated: new TabEventTarget(safari.application, "activate", true),
+    onRemoved: new TabEventTarget(safari.application, "close", true)
+  };
+
+
+  /* Browser actions */
+
+  var toolbarItemProperties = {};
+
+  var getToolbarItemProperty = function(name)
+  {
+    var property = toolbarItemProperties[name];
+    if (!property)
+    {
+      property = {tabs: new TabMap()};
+      toolbarItemProperties[name] = property;
+    }
+    return property;
+  };
+
+  var getToolbarItemForWindow = function(win)
+  {
+    for (var i = 0; i < safari.extension.toolbarItems.length; i++)
+    {
+      var toolbarItem = safari.extension.toolbarItems[i];
+
+      if (toolbarItem.browserWindow == win)
+        return toolbarItem;
+    }
+
+    return null;
+  };
+
+  var BrowserAction = function(tab)
+  {
+    this._tab = tab;
+  };
+  BrowserAction.prototype = {
+    _set: function(name, value)
+    {
+      var currentWindow = this._tab._tab.browserWindow;
+      var toolbarItem = getToolbarItemForWindow(currentWindow);
+
+      if (toolbarItem)
+      {
+        var property = getToolbarItemProperty(name);
+        property.tabs.set(this._tab, value);
+
+        if (!("global" in property))
+          property.global = toolbarItem[name];
+
+        if (this._tab._tab == currentWindow.activeTab)
+          toolbarItem[name] = value;
+      }
+    },
+    setIcon: function(path)
+    {
+      this._set("image", safari.extension.baseURI + path);
+    },
+    setTitle: function(title)
+    {
+      this._set("label", title);
+      this._set("toolTip", title);
+    },
+    setBadge: function(badge)
+    {
+      if (!badge)
+        this._set("badge", 0);
+      else if ("number" in badge)
+        this._set("badge", badge.number);
+    }
+  };
+
+  ext.tabs.onActivated.addListener(function(tab)
+  {
+    var toolbarItem = getToolbarItemForWindow(tab._tab.browserWindow);
+
+    if (!toolbarItem)
+      return;
+
+    for (var name in toolbarItemProperties)
+    {
+      var property = toolbarItemProperties[name];
+
+      if (property.tabs.has(tab))
+        toolbarItem[name] = property.tabs.get(tab);
+      else
+        toolbarItem[name] = property.global;
+    }
+  });
 
 
   /* Windows */
 
   Window = function(win)
   {
     this._win = win;
   }
   Window.prototype = {
     get visible()
@@ skipping 20 matching lines @@
 
 
   /* Frames */
 
   Frame = function(url, isTopLevel, tab)
   {
     this.url = url;
 
     // there is no way to discover frames with Safari's API.
     // so if this isn't the top level frame, assume that the parent is.
     // this is the best we can do for Safari. :(

[Felix Dahlke, 2014/01/18 13:39:19]

We could cache a chain of frames like we do in Android. It's just an
approximation, but better for whitelisting. That's something for a follow-up
though, this is fine for now.

     if (!isTopLevel)
       this.parent = new Frame(tab.url, true);
     else
       this.parent = null;
   };
 
 
   /* Background page proxy */
 
   var proxy = {
@@ skipping 285 matching lines @@
       {
         return new Window(win);
       }));
     },
     getLastFocused: function(callback)
     {
       callback(new Window(safari.application.activeBrowserWindow));
     }
   };
 
-  ext.tabs = {
-    onLoading: new LoadingTabEventTarget(safari.application),
-    onBeforeNavigate: new TabEventTarget(safari.application, "beforeNavigate", true),
-    onCompleted: new TabEventTarget(safari.application, "navigate", true),
-    onActivated: new TabEventTarget(safari.application, "activate", true),
-    onRemoved: new TabEventTarget(safari.application, "close", true)
-  };
-
   ext.backgroundPage = {
     getWindow: function()
     {
       return safari.extension.globalPage.contentWindow;
     }
   };
 
   ext.onMessage = new BackgroundMessageEventTarget();
 
-  // TODO: Implement context menu
+  var contextMenuItems = [];
+  var isContextMenuHidden = true;
   ext.contextMenus = {
-    create: function(title, contexts, onclick) {},
-    removeAll: function(callback) {}
-  };
+    addMenuItem: function(title, contexts, onclick)
+    {
+      contextMenuItems.push({
+        id: String(contextMenuItems.length), 
+        title: title,
+        item: null,
+        contexts: contexts,
+        onclick: onclick
+      });
+      this.showMenuItems();
+    },
+    removeMenuItems: function()
+    {
+      contextMenuItems = [];
+      this.hideMenuItems();
+    },
+    showMenuItems: function()
+    {
+      isContextMenuHidden = false;
+    },
+    hideMenuItems: function()
+    {
+      isContextMenuHidden = true;
+    }
+  };
+
+  // Create context menu items
+  safari.application.addEventListener("contextmenu", function(event)
+  {
+    if (isContextMenuHidden)
+      return;
+
+    var context = event.userInfo.tagName;
+    if (context == "img")
+      context = "image";
+    if (!event.userInfo.srcUrl)
+      context = null;
+
+    for (var i = 0; i < contextMenuItems.length; i++)
+    {
+      // Supported contexts are: all, audio, image, video
+      var menuItem = contextMenuItems[i];
+      if (menuItem.contexts.indexOf("all") == -1 && menuItem.contexts.indexOf(context) == -1)
+        continue;
+      
+      event.contextMenu.appendContextMenuItem(menuItem.id, menuItem.title);
+    }
+  }, false);
+
+  // Handle context menu item clicks
+  safari.application.addEventListener("command", function(event)
+  {
+    for (var i = 0; i < contextMenuItems.length; i++)
+    {
+      if (contextMenuItems[i].id == event.command)
+      {
+        contextMenuItems[i].onclick(event.userInfo.srcUrl, new Tab(safari.application.activeBrowserWindow.activeTab));
+        break;
+      }
+    }
+  }, false);
 })();