Issue 154 - Added devtools panel showing blocked and blockable items

chrome/ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2015 Eyeo GmbH
+ * Copyright (C) 2006-2016 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.
  *
@@ skipping 78 matching lines @@
       }
 
       chrome.tabs.query(rawInfo, function(tabs)
       {
         callback(tabs.map(function(tab)
         {
           return new Page(tab);
         }));
       });
     },
-    onLoading: new ext._EventTarget()
+    onLoading: new ext._EventTarget(),
+    onActivated: new ext._EventTarget()
   };
 
   chrome.tabs.onUpdated.addListener(function(tabId, changeInfo, tab)
   {
     if (changeInfo.status == "loading")
       ext.pages.onLoading._dispatch(new Page(tab));
   });
 
   chrome.webNavigation.onBeforeNavigate.addListener(function(details)
   {
@@ skipping 27 matching lines @@
     ext._removeFromAllPageMaps(tabId);
     delete framesOfTabs[tabId];
   }
 
   chrome.tabs.onReplaced.addListener(function(addedTabId, removedTabId)
   {
     forgetTab(removedTabId);
   });
 
   chrome.tabs.onRemoved.addListener(forgetTab);
+
+  chrome.tabs.onActivated.addListener(details =>
+  {
+    ext.pages.onActivated._dispatch(new Page({id: details.tabId}));
+  });
 
 
   /* Browser actions */
 
   var BrowserAction = function(tabId)
   {
     this._tabId = tabId;
     this._changes = null;
   };
   BrowserAction.prototype = {
@@ skipping 134 matching lines @@
   ContextMenus.prototype = {
     create: function(item)
     {
       var items = contextMenuItems.get(this._page);
       if (!items)
         contextMenuItems.set(this._page, items = []);
 
       items.push(item);
       updateContextMenu();
     },
-    removeAll: function()
-    {
-      contextMenuItems.delete(this._page);
-      updateContextMenu();
+    remove: function(item)
+    {
+      let items = contextMenuItems.get(this._page);
+      if (items)
+      {
+        let index = items.indexOf(item);
+        if (index != -1)
+        {
+          items.splice(index, 1);
+          updateContextMenu();
+        }
+      }
     }
   };
 
   chrome.tabs.onActivated.addListener(updateContextMenu);
 
   chrome.windows.onFocusChanged.addListener(function(windowId)
   {
     if (windowId != chrome.windows.WINDOW_ID_NONE)
       updateContextMenu();
   });
 
 
   /* Web requests */
 
   var framesOfTabs = Object.create(null);
 
   ext.getFrame = function(tabId, frameId)
   {
     return (framesOfTabs[tabId] || {})[frameId];
   };
 
+  var handlerBehaviorChangedQuota = chrome.webRequest.MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES;
+
+  function propagateHandlerBehaviorChange()
+  {
+    // Make sure to not call handlerBehaviorChanged() more often than allowed
+    // by chrome.webRequest.MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES.
+    // Otherwise Chrome notifies the user that this extension is causing issues.
+    if (handlerBehaviorChangedQuota > 0)
+    {
+      chrome.webNavigation.onBeforeNavigate.removeListener(propagateHandlerBehaviorChange);
+      chrome.webRequest.handlerBehaviorChanged();
+
+      handlerBehaviorChangedQuota--;
+      setTimeout(function() { handlerBehaviorChangedQuota++; }, 600000);
+    }
+  }
+
   ext.webRequest = {
     onBeforeRequest: new ext._EventTarget(),
-    handlerBehaviorChanged: chrome.webRequest.handlerBehaviorChanged
-  };
-
-  // Since Chrome 38 requests of type 'object' (e.g. requests
-  // initiated by Flash) are mistakenly reported with the type 'other'.
-  // https://code.google.com/p/chromium/issues/detail?id=410382
-  if (parseInt(navigator.userAgent.match(/\bChrome\/(\d+)/)[1], 10) >= 38)
-  {
-    ext.webRequest.indistinguishableTypes = [
-      ["OTHER", "OBJECT", "OBJECT_SUBREQUEST"]
-    ];
-  }
-  else
-  {
-    ext.webRequest.indistinguishableTypes = [
-      ["OBJECT", "OBJECT_SUBREQUEST"],
-      ["OTHER", "MEDIA", "FONT"]
-    ];
-  }
+    handlerBehaviorChanged: function()
+    {
+      // Defer handlerBehaviorChanged() until navigation occurs.
+      // There wouldn't be any visible effect when calling it earlier,
+      // but it's an expensive operation and that way we avoid to call
+      // it multiple times, if multiple filters are added/removed.
+      var onBeforeNavigate = chrome.webNavigation.onBeforeNavigate;
+      if (!onBeforeNavigate.hasListener(propagateHandlerBehaviorChange))
+        onBeforeNavigate.addListener(propagateHandlerBehaviorChange);
+    },
+    getIndistinguishableTypes: function()
+    {
+      // Chrome 38-48 mistakenly reports requests of type `object`
+      // (e.g. requests initiated by Flash) with the type `other`.
+      // https://code.google.com/p/chromium/issues/detail?id=410382
+      var match = navigator.userAgent.match(/\bChrome\/(\d+)/);
+      if (match)
+      {
+        var version = parseInt(match[1], 10);
+        if (version >= 38 && version <= 48)
+          return [["OTHER", "OBJECT", "OBJECT_SUBREQUEST"]];
+      }
+
+      // Chrome <44 doesn't have ResourceType.
+      var ResourceType = chrome.webRequest.ResourceType || {};
+
+      // Before Chrome 49, requests of the type `font` and `ping`
+      // have been reported with the type `other`.
+      // https://code.google.com/p/chromium/issues/detail?id=410382
+      var otherTypes = ["OTHER", "MEDIA"];
+      if (!("FONT" in ResourceType))
+        otherTypes.push("FONT");
+      if (!("PING" in ResourceType))
+        otherTypes.push("PING");
+
+      return [["OBJECT", "OBJECT_SUBREQUEST"], otherTypes];
+    }
+  };
 
   chrome.tabs.query({}, function(tabs)
   {
     tabs.forEach(function(tab)
     {
       chrome.webNavigation.getAllFrames({tabId: tab.id}, function(details)
       {
         if (details && details.length > 0)
         {
           var frames = framesOfTabs[tab.id] = Object.create(null);
 
           for (var i = 0; i < details.length; i++)
             frames[details[i].frameId] = {url: new URL(details[i].url), parent: null};
 
           for (var i = 0; i < details.length; i++)
           {
             var parentFrameId = details[i].parentFrameId;
 
             if (parentFrameId != -1)
               frames[details[i].frameId].parent = frames[parentFrameId];
           }
         }
       });
     });
   });
 
   chrome.webRequest.onBeforeRequest.addListener(function(details)
   {
-    try
-    {
-      // the high-level code isn't interested in requests that aren't related
-      // to a tab and since those can only be handled in Chrome, we ignore
-      // them here instead of in the browser independent high-level code.
-      if (details.tabId == -1)
-        return;
-
-      var isMainFrame = details.type == "main_frame" || (
-
-        // assume that the first request belongs to the top frame. Chrome
-        // may give the top frame the type "object" instead of "main_frame".
-        // https://code.google.com/p/chromium/issues/detail?id=281711
-        details.frameId == 0 && !(details.tabId in framesOfTabs)
-      );
-
-      var frames = null;
-      if (!isMainFrame)
-        frames = framesOfTabs[details.tabId];
-      if (!frames)
-        frames = framesOfTabs[details.tabId] = Object.create(null);
-
-      var frame = null;
-      var url = new URL(details.url);
-      if (!isMainFrame)
-      {
-        // we are looking for the frame that contains the element that
-        // is about to load, however if a frame is loading the surrounding
-        // frame is indicated by parentFrameId instead of frameId
-        var frameId;
-        var requestType;
-        if (details.type == "sub_frame")
-        {
-          frameId = details.parentFrameId;
-          requestType = "SUBDOCUMENT";
-        }
-        else
-        {
-          frameId = details.frameId;
-          requestType = details.type.toUpperCase();
-        }
-
-        frame = frames[frameId] || frames[Object.keys(frames)[0]];
-
-        if (frame)
-        {
-          var results = ext.webRequest.onBeforeRequest._dispatch(
-            url,
-            requestType,
-            new Page({id: details.tabId}),
-            frame
-          );
-
-          if (results.indexOf(false) != -1)
-            return {cancel: true};
-        }
-      }
-
-      if (isMainFrame || details.type == "sub_frame")
-        frames[details.frameId] = {url: url, parent: frame};
-    }
-    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);
-    }
+    // the high-level code isn't interested in requests that aren't related
+    // to a tab and since those can only be handled in Chrome, we ignore
+    // them here instead of in the browser independent high-level code.
+    if (details.tabId == -1)
+      return;
+
+    var isMainFrame = details.type == "main_frame" || (
+
+      // assume that the first request belongs to the top frame. Chrome 29
+      // may give the top frame the type "object" instead of "main_frame".
+      // https://code.google.com/p/chromium/issues/detail?id=281711
+      details.frameId == 0 && !(details.tabId in framesOfTabs)
+    );
+
+    var frames = null;
+    if (!isMainFrame)
+      frames = framesOfTabs[details.tabId];
+    if (!frames)
+      frames = framesOfTabs[details.tabId] = Object.create(null);
+
+    var frame = null;
+    var url = new URL(details.url);
+    if (!isMainFrame)
+    {
+      // we are looking for the frame that contains the element that
+      // is about to load, however if a frame is loading the surrounding
+      // frame is indicated by parentFrameId instead of frameId
+      var frameId;
+      var requestType;
+      if (details.type == "sub_frame")
+      {
+        frameId = details.parentFrameId;
+        requestType = "SUBDOCUMENT";
+      }
+      else
+      {
+        frameId = details.frameId;
+        requestType = details.type.toUpperCase();
+      }
+
+      frame = frames[frameId] || frames[Object.keys(frames)[0]];
+
+      if (frame)
+      {
+        var results = ext.webRequest.onBeforeRequest._dispatch(
+          url,
+          requestType,
+          new Page({id: details.tabId}),
+          frame
+        );
+
+        if (results.indexOf(false) != -1)
+          return {cancel: true};
+      }
+    }
+
+    if (isMainFrame || details.type == "sub_frame")
+      frames[details.frameId] = {url: url, parent: frame};
   }, {urls: ["http://*/*", "https://*/*"]}, ["blocking"]);
 
 
   /* Message passing */
 
   chrome.runtime.onMessage.addListener(function(message, rawSender, sendResponse)
   {
     var sender = {};
 
     // Add "page" and "frame" if the message was sent by a content script.
@@ skipping 28 matching lines @@
           }
 
           return frames[0];
         }
       };
     }
 
     return ext.onMessage._dispatch(message, sender, sendResponse).indexOf(true) != -1;
   });
 
-  // We have to ensure there is at least one listener for the onConnect event.
-  // Otherwise we can't connect a port later, which we need to do in order to
-  // detect when the extension is reloaded, disabled or uninstalled.
-  chrome.runtime.onConnect.addListener(function() {});
-
 
   /* Storage */
 
-  ext.storage = localStorage;
-
+  ext.storage = {
+    get: function(keys, callback)
+    {
+      chrome.storage.local.get(keys, callback);
+    },
+    set: function(key, value, callback)
+    {
+      let items = {};
+      items[key] = value;
+      chrome.storage.local.set(items, callback);
+    },
+    remove: function(key, callback)
+    {
+      chrome.storage.local.remove(key, callback);
+    },
+    onChanged: chrome.storage.onChanged
+  };
 
   /* Options */
 
   ext.showOptions = function(callback)
   {
     chrome.windows.getLastFocused(function(win)
     {
       var optionsUrl = chrome.extension.getURL("options.html");
       var queryInfo = {url: optionsUrl};
 
@@ skipping 15 matching lines @@
           if (callback)
             callback(new Page(tab));
         }
         else
         {
           ext.pages.open(optionsUrl, callback);
         }
       });
     });
   };
-
-
-  /* Devtools panel */
-
-  var Panel = function(inspectedTabId, port)
-  {
-    this.inspectedTabId = inspectedTabId;
-    this._port = port;
-  };
-  Panel.prototype = {
-    sendMessage: function(message)
-    {
-      this._port.postMessage(message);
-    },
-    get onRemoved()
-    {
-      return this._port.onDisconnect;
-    }
-  };
-
-  ext.devtools = {
-    onCreated: new ext._EventTarget()
-  };
-
-  chrome.runtime.onConnect.addListener(function(port)
-  {
-    var match = port.name.match(/^devtools-(\d+)$/);
-    if (match)
-    {
-      var panel = new Panel(parseInt(match[1], 10), port);
-      ext.devtools.onCreated._dispatch(panel);
-    }
-  });
 })();