Issue 616 - Enforce $generichide and $genericblock in Chrome

background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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/>.
  */
 
 with(require("filterClasses"))
 {
   this.Filter = Filter;
-  this.RegExpFilter = RegExpFilter;
   this.BlockingFilter = BlockingFilter;
   this.WhitelistFilter = WhitelistFilter;
+  this.RegExpFilter = RegExpFilter;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
   this.SpecialSubscription = SpecialSubscription;
 }
 with(require("whitelisting"))
 {
   this.isPageWhitelisted = isPageWhitelisted;
   this.isFrameWhitelisted = isFrameWhitelisted;
   this.processKey = processKey;
   this.getKey = getKey;
 }
 with(require("url"))
 {
   this.stringifyURL = stringifyURL;
   this.isThirdParty = isThirdParty;
   this.extractHostFromFrame = extractHostFromFrame;
 }
-with(require("icon"))
-{
-  this.updateIcon = updateIcon;
-  this.startIconAnimation = startIconAnimation;
-  this.stopIconAnimation = stopIconAnimation;
-}
 var FilterStorage = require("filterStorage").FilterStorage;
+var FilterNotifier = require("filterNotifier").FilterNotifier;
 var ElemHide = require("elemHide").ElemHide;
 var defaultMatcher = require("matcher").defaultMatcher;
 var Prefs = require("prefs").Prefs;
 var Synchronizer = require("synchronizer").Synchronizer;
 var Utils = require("utils").Utils;
-var NotificationStorage = require("notification").Notification;
-var initAntiAdblockNotification = require("antiadblockInit").initAntiAdblockNotification;
 var parseFilters = require("filterValidation").parseFilters;
-
-// Some types cannot be distinguished
-RegExpFilter.typeMap.OBJECT_SUBREQUEST = RegExpFilter.typeMap.OBJECT;
-RegExpFilter.typeMap.MEDIA = RegExpFilter.typeMap.FONT = RegExpFilter.typeMap.OTHER;
-
-// Chrome on Linux does not fully support chrome.notifications until version 35
-// https://code.google.com/p/chromium/issues/detail?id=291485
-var canUseChromeNotifications = require("info").platform == "chromium"
-  && "notifications" in chrome
-  && (navigator.platform.indexOf("Linux") == -1 || parseInt(require("info").applicationVersion, 10) > 34);
+var composeFilters = require("filterComposer").composeFilters;
+var updateIcon = require("icon").updateIcon;
+var initNotifications = require("notificationHelper").initNotifications;
 
 var seenDataCorruption = false;
 var filterlistsReinitialized = false;
-require("filterNotifier").FilterNotifier.addListener(function(action)
-{
-  if (action == "load")
-  {
-    var addonVersion = require("info").addonVersion;
-    var prevVersion = ext.storage.currentVersion;
+
+function init()
+{
+  var filtersLoaded = false;
+  var prefsLoaded = false;
+
+  var checkLoaded = function()
+  {
+    if (!filtersLoaded || !prefsLoaded)
+      return;
+
+    var info = require("info");
+    var previousVersion = Prefs.currentVersion;
 
     // There are no filters stored so we need to reinitialize all filterlists
     if (!FilterStorage.firstRun && FilterStorage.subscriptions.length === 0)
     {
       filterlistsReinitialized = true;
-      prevVersion = null;
-    }
-
-    if (prevVersion != addonVersion || FilterStorage.firstRun)
-    {
-      seenDataCorruption = prevVersion && FilterStorage.firstRun;
-      ext.storage.currentVersion = addonVersion;
-      addSubscription(prevVersion);
-    }
-
-    if (canUseChromeNotifications)
-      initChromeNotifications();
-    initAntiAdblockNotification();
+      previousVersion = null;
+    }
+
+    if (previousVersion != info.addonVersion || FilterStorage.firstRun)
+    {
+      seenDataCorruption = previousVersion && FilterStorage.firstRun;
+      Prefs.currentVersion = info.addonVersion;
+      addSubscription(previousVersion);
+    }
 
     // The "Hide placeholders" option has been removed from the UI in 1.8.8.1285
     // So we reset the option for users updating from older versions.
-    if (prevVersion && Services.vc.compare(prevVersion, "1.8.8.1285") < 0)
+    if (previousVersion && Services.vc.compare(previousVersion, "1.8.8.1285") < 0)
       Prefs.hidePlaceholders = true;
-  }
-
-  // update browser actions when whitelisting might have changed,
-  // due to loading filters or saving filter changes
-  if (action == "load" || action == "save")
+
+    initNotifications();
+
+    // Update browser actions and context menus when whitelisting might have
+    // changed. That is now when initally loading the filters and later when
+    // importing backups or saving filter changes.
+    FilterNotifier.addListener(function(action)
+    {
+      if (action == "load" || action == "save")
+        refreshIconAndContextMenuForAllPages();
+    });
     refreshIconAndContextMenuForAllPages();
-});
+  };
+
+  var onFilterAction = function(action)
+  {
+    if (action == "load")
+    {
+      FilterNotifier.removeListener(onFilterAction);
+      filtersLoaded = true;
+      checkLoaded();
+    }
+  };
+
+  var onPrefsLoaded = function()
+  {
+    Prefs.onLoaded.removeListener(onPrefsLoaded);
+    prefsLoaded = true;
+    checkLoaded();
+  };
+
+  FilterNotifier.addListener(onFilterAction);
+  Prefs.onLoaded.addListener(onPrefsLoaded);
+}
+init();
 
 // Special-case domains for which we cannot use style-based hiding rules.
 // See http://crbug.com/68705.
 var noStyleRulesHosts = ["mail.google.com", "mail.yahoo.com", "www.google.com"];
 
 var htmlPages = new ext.PageMap();
-
-function removeDeprecatedOptions()
-{
-  var deprecatedOptions = ["specialCaseYouTube", "experimental", "disableInlineTextAds"];
-  deprecatedOptions.forEach(function(option)
-  {
-    if (option in ext.storage)
-      delete ext.storage[option];
-  });
-}
-
-// Remove deprecated options before we do anything else.
-removeDeprecatedOptions();
-
-var activeNotification = null;
 
 var contextMenuItem = {
   title: ext.i18n.getMessage("block_element"),
   contexts: ["image", "video", "audio"],
   onclick: function(page)
   {
     page.sendMessage({type: "clickhide-new-filter"});
   }
 };
 
@@ skipping 82 matching lines @@
       if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
         Synchronizer.execute(subscription);
     }
   }
 
   if (!addSubscription && !addAcceptable)
     return;
 
   function notifyUser()
   {
-    ext.pages.open(ext.getURL("firstRun.html"));
+    if (!Prefs.suppress_first_run_page)
+      ext.pages.open(ext.getURL("firstRun.html"));
   }
 
   if (addSubscription)
   {
     // Load subscriptions data
     var request = new XMLHttpRequest();
     request.open("GET", "subscriptions.xml");
     request.addEventListener("load", function()
     {
       var node = Utils.chooseFilterSubscription(request.responseXML.getElementsByTagName("subscription"));
       var subscription = (node ? Subscription.fromURL(node.getAttribute("url")) : null);
       if (subscription)
       {
         FilterStorage.addSubscription(subscription);
         subscription.disabled = false;
         subscription.title = node.getAttribute("title");
         subscription.homepage = node.getAttribute("homepage");
         if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
           Synchronizer.execute(subscription);
 
           notifyUser();
       }
     }, false);
     request.send(null);
   }
   else
     notifyUser();
 }
 
-Prefs.addListener(function(name)
+Prefs.onChanged.addListener(function(name)
 {
   if (name == "shouldShowBlockElementMenu")
     refreshIconAndContextMenuForAllPages();
 });
-
-function prepareNotificationIconAndPopup()
-{
-  var animateIcon = (activeNotification.type !== "question");
-  activeNotification.onClicked = function()
-  {
-    if (animateIcon)
-      stopIconAnimation();
-    notificationClosed();
-  };
-  if (animateIcon)
-    startIconAnimation(activeNotification.type);
-}
-
-function openNotificationLinks()
-{
-  if (activeNotification.links)
-  {
-    activeNotification.links.forEach(function(link)
-    {
-      ext.windows.getLastFocused(function(win)
-      {
-        win.openTab(Utils.getDocLink(link));
-      });
-    });
-  }
-}
-
-function notificationButtonClick(buttonIndex)
-{
-  if (activeNotification.type === "question")
-  {
-    NotificationStorage.triggerQuestionListeners(activeNotification.id, buttonIndex === 0);
-    NotificationStorage.markAsShown(activeNotification.id);
-    activeNotification.onClicked();
-  }
-  else if (activeNotification.links && activeNotification.links[buttonIndex])
-  {
-    ext.windows.getLastFocused(function(win)
-    {
-      win.openTab(Utils.getDocLink(activeNotification.links[buttonIndex]));
-    });
-  }
-}
-
-function notificationClosed()
-{
-  activeNotification = null;
-}
-
-function imgToBase64(url, callback)
-{
-  var canvas = document.createElement("canvas"),
-  ctx = canvas.getContext("2d"),
-  img = new Image;
-  img.src = url;
-  img.onload = function()
-  {
-    canvas.height = img.height;
-    canvas.width = img.width;
-    ctx.drawImage(img, 0, 0);
-    callback(canvas.toDataURL("image/png"));
-    canvas = null;
-  };
-}
-
-function initChromeNotifications()
-{
-  // Chrome hides notifications in notification center when clicked so we need to clear them
-  function clearActiveNotification(notificationId)
-  {
-    if (activeNotification && activeNotification.type != "question" && !("links" in activeNotification))
-      return;
-
-    chrome.notifications.clear(notificationId, function(wasCleared)
-    {
-      if (wasCleared)
-        notificationClosed();
-    });
-  }
-
-  chrome.notifications.onButtonClicked.addListener(function(notificationId, buttonIndex)
-  {
-    notificationButtonClick(buttonIndex);
-    clearActiveNotification(notificationId);
-  });
-  chrome.notifications.onClicked.addListener(clearActiveNotification);
-  chrome.notifications.onClosed.addListener(notificationClosed);
-}
-
-function showNotification(notification)
-{
-  if (activeNotification && activeNotification.id === notification.id)
-    return;
-
-  activeNotification = notification;
-  if (activeNotification.type === "critical" || activeNotification.type === "question")
-  {
-    var texts = NotificationStorage.getLocalizedTexts(notification);
-    var title = texts.title || "";
-    var message = texts.message ? texts.message.replace(/<\/?(a|strong)>/g, "") : "";
-    var iconUrl = ext.getURL("icons/abp-128.png");
-    var hasLinks = activeNotification.links && activeNotification.links.length > 0;
-
-    if (canUseChromeNotifications)
-    {
-      var opts = {
-        type: "basic",
-        title: title,
-        message: message,
-        buttons: [],
-        priority: 2 // We use the highest priority to prevent the notification from closing automatically
-      };
-      if (activeNotification.type === "question")
-      {
-        opts.buttons.push({title: ext.i18n.getMessage("overlay_notification_button_yes")});
-        opts.buttons.push({title: ext.i18n.getMessage("overlay_notification_button_no")});
-      }
-      else
-      {
-        var regex = /<a>(.*?)<\/a>/g;
-        var plainMessage = texts.message || "";
-        var match;
-        while (match = regex.exec(plainMessage))
-          opts.buttons.push({title: match[1]});
-      }
-
-      imgToBase64(iconUrl, function(iconData)
-      {
-        opts["iconUrl"] = iconData;
-        chrome.notifications.create("", opts, function() {});
-      });
-    }
-    else if ("Notification" in window && activeNotification.type !== "question")
-    {
-      if (hasLinks)
-        message += " " + ext.i18n.getMessage("notification_without_buttons");
-
-      imgToBase64(iconUrl, function(iconData)
-      {
-        var notification = new Notification(
-          title,
-          {
-            lang: Utils.appLocale,
-            dir: ext.i18n.getMessage("@@bidi_dir"),
-            body: message,
-            icon: iconData
-          }
-        );
-
-        notification.addEventListener("click", openNotificationLinks);
-        notification.addEventListener("close", notificationClosed);
-      });
-    }
-    else
-    {
-      var message = title + "\n" + message;
-      if (hasLinks)
-        message += "\n\n" + ext.i18n.getMessage("notification_with_buttons");
-
-      var approved = confirm(message);
-      if (activeNotification.type === "question")
-        notificationButtonClick(approved ? 0 : 1);
-      else if (approved)
-        openNotificationLinks();
-    }
-  }
-  prepareNotificationIconAndPopup();
-}
 
 // This is a hack to speedup loading of the options page on Safari.
 // Once we replaced the background page proxy with message passing
 // this global function should removed.
 function getUserFilters()
 {
   var filters = [];
   var exceptions = [];
 
   for (var i = 0; i < FilterStorage.subscriptions.length; i++)
@@ skipping 15 matching lines @@
   return {filters: filters, exceptions: exceptions};
 }
 
 ext.onMessage.addListener(function (msg, sender, sendResponse)
 {
   switch (msg.type)
   {
     case "get-selectors":
       var selectors = [];
 
-      if (!isFrameWhitelisted(sender.page, sender.frame, "DOCUMENT") &&
-          !isFrameWhitelisted(sender.page, sender.frame, "ELEMHIDE"))
+      if (!isFrameWhitelisted(sender.page, sender.frame,
+                              RegExpFilter.typeMap.DOCUMENT | RegExpFilter.typeMap.ELEMHIDE))
       {
         var noStyleRules = false;
-        var specificOnly = isFrameWhitelisted(sender.page, sender.frame, "GENERICHIDE");

[Sebastian Noack, 2015/03/12 12:36:12]

I'm concerned about the performance implications running yet another filter
match here. We already have serious issues with the performance of this code.

Currently we look for "DOCUMENT" exception rules, if there are none we look for
"ELEMHIDE" exception rules, and if there are still none we now also look for
"GENERICHIDE" exception rules.

So how about optimizing Matcher.matchesAny() to consider multiple types? The
algorithm could look roughly like this:

function matchesAny(types)
{
  result = null;
  priority = types.length - 1;

  for (filter of filters)
  {
    for (i = 0; i <= priority; i++)
    {
      if (filter.matches(types[i]))
      {
         result = filter;
         priority = i;
      }
    }

    if (priority == 0)
      break;
  }

  return filter;
}

[kzar, 2015/03/12 19:22:45]

That sound sensible to me but as you mentioned to me on IRC this would require a
new (blocking) issue to be filed and fixed to adapt matchesAny first.

What's your opinion here Wladimir?

+        var specificOnly = isFrameWhitelisted(sender.page, sender.frame,
+                                              RegExpFilter.typeMap.GENERICHIDE);
         var host = extractHostFromFrame(sender.frame);
 
         for (var i = 0; i < noStyleRulesHosts.length; i++)
         {
           var noStyleHost = noStyleRulesHosts[i];
           if (host == noStyleHost || (host.length > noStyleHost.length &&
                                       host.substr(host.length - noStyleHost.length - 1) == "." + noStyleHost))
           {
             noStyleRules = true;
           }
         }
         selectors = ElemHide.getSelectorsForDomain(host, specificOnly);
         if (noStyleRules)
         {
           selectors = selectors.filter(function(s)
           {
             return !/\[style[\^\$]?=/.test(s);
           });
         }
       }
 
       sendResponse(selectors);
       break;
     case "should-collapse":
-      if (isFrameWhitelisted(sender.page, sender.frame, "DOCUMENT"))
+      if (isFrameWhitelisted(sender.page, sender.frame, RegExpFilter.typeMap.DOCUMENT))
       {
         sendResponse(false);
         break;
       }
 
-      var url = new URL(msg.url);
+      var typeMask = RegExpFilter.typeMap[msg.mediatype];
       var documentHost = extractHostFromFrame(sender.frame);
-      var filter = defaultMatcher.matchesAny(
-        stringifyURL(url), msg.mediatype,
-        documentHost, isThirdParty(url, documentHost)
-      );
-
-      if (filter instanceof BlockingFilter)
-      {
-        var collapse = filter.collapse;
-        if (collapse == null)
-          collapse = Prefs.hidePlaceholders;
-        sendResponse(collapse);
-      }
-      else
-        sendResponse(false);
+      var blocked = false;
+
+      for (var i = 0; i < msg.urls.length; i++)
+      {
+        var url = new URL(msg.urls[i], msg.baseURL);
+        var filter = defaultMatcher.matchesAny(
+          stringifyURL(url), typeMask,
+          documentHost, isThirdParty(url, documentHost)
+        );
+
+        if (filter instanceof BlockingFilter)
+        {
+          if (filter.collapse != null)
+          {
+            sendResponse(filter.collapse);
+            return;
+          }
+
+          blocked = true;
+        }
+      }
+
+      sendResponse(blocked && Prefs.hidePlaceholders);
       break;
     case "get-domain-enabled-state":
       // Returns whether this domain is in the exclusion list.
       // The browser action popup asks us this.
       if(sender.page)
       {
         sendResponse({enabled: !isPageWhitelisted(sender.page)});
         return;
       }
       break;
     case "add-filters":
-      var filters;
-      try
-      {
-        filters = parseFilters(msg.text);
-      }
-      catch (error)
-      {
-        sendResponse({status: "invalid", error: error});
+      var result = parseFilters(msg.text);
+
+      if (result.errors.length > 0)
+      {
+        sendResponse({status: "invalid", error: result.errors.join("\n")});
         break;
       }
 
-      for (var i = 0; i < filters.length; i++)
-        FilterStorage.addFilter(filters[i]);
+      for (var i = 0; i < result.filters.length; i++)
+        FilterStorage.addFilter(result.filters[i]);
 
       sendResponse({status: "ok"});
       break;
     case "add-subscription":
       ext.showOptions(function(page)
       {
         page.sendMessage(msg);
       });
       break;
     case "add-sitekey":
       processKey(msg.token, sender.page, sender.frame);
       break;
     case "report-html-page":
       htmlPages.set(sender.page, null);
       refreshIconAndContextMenu(sender.page);
+      break;
+    case "compose-filters":
+      sendResponse(composeFilters({
+        tagName: msg.tagName,
+        id: msg.id,
+        src: msg.src,
+        style: msg.style,
+        classes: msg.classes,
+        urls: msg.urls,
+        type: msg.mediatype,
+        baseURL: msg.baseURL,
+        page: sender.page,
+        frame: sender.frame
+      }));
       break;
     case "forward":
       if (sender.page)
       {
         if (msg.expectsResponse)
         {
           sender.page.sendMessage(msg.payload, sendResponse);
           return true;
         }
 
         sender.page.sendMessage(msg.payload);
       }
       break;
   }
 });
 
 // update icon when page changes location
 ext.pages.onLoading.addListener(function(page)
 {
   page.sendMessage({type: "clickhide-deactivate"});
   refreshIconAndContextMenu(page);
 });
-
-setTimeout(function()
-{
-  var notificationToShow = NotificationStorage.getNextToShow();
-  if (notificationToShow)
-    showNotification(notificationToShow);
-}, 3 * 60 * 1000);