Issue 375 - Make context menus per page

chrome/ext/background.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 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/>.
  */
 
 (function()
 {
   /* Pages */
 
   var Page = ext.Page = function(tab)
   {
     this._id = tab.id;
     this._url = tab.url;
 
     this.browserAction = new BrowserAction(tab.id);
+    this.contextMenus = new ContextMenus(this);
   };
   Page.prototype = {
     get url()
     {
       // usually our Page objects are created from Chrome's Tab objects, which
       // provide the url. So we can return the url given in the constructor.
       if (this._url != null)
         return this._url;
 
       // but sometimes we only have the tab id when we create a Page object.
@@ skipping 122 matching lines @@
       {
         chrome.browserAction.setBadgeText({
           tabId: this._tabId,
           text: badge.number.toString()
         });
       }
     }
   };
 
 
+  /* Context menus */
+
+  var contextMenuItems = new ext.PageMap();
+  var contextMenuUpdating = false;
+
+  var updateContextMenu = function()
+  {
+    if (contextMenuUpdating)
+      return;
+
+    contextMenuUpdating = true;
+
+    chrome.tabs.query({active: true, lastFocusedWindow: true}, function(tabs)
+    {
+      chrome.contextMenus.removeAll(function()
+      {
+        contextMenuUpdating = false;
+
+        if (tabs.length == 0)
+          return;
+
+        var items = contextMenuItems.get({_id: tabs[0].id});
+
+        if (!items)
+          return;
+
+        for (var i = 0; i < items.length; i++)
+        {
+          chrome.contextMenus.create({
+            title:    items[i].title,
+            contexts: items[i].contexts,
+            onclick:  items[i].onclick
+          });
+        }
+      });
+    });
+  };
+
+  var ContextMenus = function(page)
+  {
+    this._page = page;
+  };
+  ContextMenus.prototype = {
+    create: function(item)
+    {
+      var items = contextMenuItems.get(this._page);
+      if (!items)
+        contextMenuItems.set(this._page, items = []);
+
+      items.push(item);
+      updateContextMenu();

[Wladimir Palant, 2014/04/25 11:35:50]

How many unnecessary updates will this trigger when the extension starts up? How
about checking tab.active here? Same for removeAll() below.

[Sebastian Noack, 2014/04/25 11:48:03]

This was considered and addressed by baling out in
updateContextMenu() if there is already a pending update.

+    },
+    removeAll: function()
+    {
+      contextMenuItems.delete(this._page);
+      updateContextMenu();
+    }
+  };
+
+  chrome.tabs.onActivated.addListener(updateContextMenu);
+
+  chrome.windows.onFocusChanged.addListener(function(windowId)
+  {
+    if (windowId != chrome.windows.WINDOW_ID_NONE)
+      updateContextMenu();
+  });
+
+
   /* Web requests */
 
   var framesOfTabs = {__proto__: null};
 
   ext.getFrame = function(tabId, frameId)
   {
     return (framesOfTabs[tabId] || {})[frameId];
   };
 
   ext.webRequest = {
@@ skipping 73 matching lines @@
     catch (e)
     {
       // recent versions of Chrome cancel the request when an error occurs in
       // the onBeforeRequest listener. However in our case it is preferred, to
       // let potentially some ads through, rather than blocking legit requests.
       console.error(e);
     }
   }, {urls: ["<all_urls>"]}, ["blocking"]);
 
 
-  /* Context menus */
-
-  var contextMenuItems = [];
-  var isContextMenuHidden = true;
-
-  ext.contextMenus = {
-    addMenuItem: function(title, contexts, onclick)
-    {
-      contextMenuItems.push({
-        title: title,
-        contexts: contexts,
-        onclick: function(info, tab)
-        {
-          onclick(info.srcUrl, new Page(tab));
-        }
-      });
-      this.showMenuItems();
-    },
-    removeMenuItems: function()
-    {
-      contextMenuItems = [];
-      this.hideMenuItems();
-    },
-    showMenuItems: function()
-    {
-      if (!isContextMenuHidden)
-        return;
-
-      chrome.contextMenus.removeAll(function()
-      {
-        for (var i = 0; i < contextMenuItems.length; i++)
-        {
-          var item = contextMenuItems[i];
-          chrome.contextMenus.create({
-            title: item.title,
-            contexts: item.contexts,
-            onclick: item.onclick
-          });
-        }
-      });
-      isContextMenuHidden = false;
-    },
-    hideMenuItems: function()
-    {
-      if (isContextMenuHidden)
-        return;
-
-      chrome.contextMenus.removeAll();
-      isContextMenuHidden = true;
-    }
-  };
-
-
   /* Message passing */
 
   chrome.runtime.onMessage.addListener(function(message, rawSender, sendResponse)
   {
     var sender = {
       page: new Page(rawSender.tab),
       frame: {
         url: rawSender.url,
         get parent()
         {
@@ skipping 14 matching lines @@
     };
 
     return ext.onMessage._dispatch(message, sender, sendResponse);
   });
 
 
   /* Storage */
 
   ext.storage = localStorage;
 })();