Issue 1282 - Don't generate filters conflicting with existing exception rules

background.js

 /*
- * This file is part of Adblock Plus <http://adblockplus.org/>,
- * Copyright (C) 2006-2014 Eyeo GmbH
+ * 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;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
   this.SpecialSubscription = SpecialSubscription;
 }
 with(require("whitelisting"))
 {
-  this.isWhitelisted = isWhitelisted;
+  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 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 Notification = require("notification").Notification;
+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;
+var composeFilters = require("filterComposer").composeFilters;
 
 // 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 seenDataCorruption = false;
 var filterlistsReinitialized = false;
 require("filterNotifier").FilterNotifier.addListener(function(action)
@@ skipping 59 matching lines @@
   contexts: ["image", "video", "audio"],
   onclick: function(page)
   {
     page.sendMessage({type: "clickhide-new-filter"});
   }
 };
 
 // Adds or removes browser action icon according to options.
 function refreshIconAndContextMenu(page)
 {
-  var whitelisted = isWhitelisted(page.url);
-
-  var iconFilename;
-  if (whitelisted && require("info").platform != "safari")
-    // There is no grayscale version of the icon for whitelisted pages
-    // when using Safari, because icons are grayscale already and icons
-    // aren't per page in Safari.
-    iconFilename = "icons/abp-$size-whitelisted.png";
-  else
-    iconFilename = "icons/abp-$size.png";
-
-  page.browserAction.setIcon(iconFilename);
-  iconAnimation.registerPage(page, iconFilename);
+  var whitelisted = isPageWhitelisted(page);
+  updateIcon(page, whitelisted);
 
   // show or hide the context menu entry dependent on whether
   // adblocking is active on that page
   page.contextMenus.removeAll();
-
   if (Prefs.shouldShowBlockElementMenu && !whitelisted && htmlPages.has(page))
     page.contextMenus.create(contextMenuItem);
 }
 
 function refreshIconAndContextMenuForAllPages()
 {
   ext.pages.query({}, function(pages)
   {
     pages.forEach(refreshIconAndContextMenu);
   });
@@ skipping 99 matching lines @@
   else
     notifyUser();
 }
 
 Prefs.addListener(function(name)
 {
   if (name == "shouldShowBlockElementMenu")
     refreshIconAndContextMenuForAllPages();
 });
 
-// TODO: This hack should be removed, however currently
-// the firstRun page still calls backgroundPage.openOptions()
-openOptions = ext.showOptions;
-
 function prepareNotificationIconAndPopup()
 {
   var animateIcon = (activeNotification.type !== "question");
   activeNotification.onClicked = function()
   {
     if (animateIcon)
-      iconAnimation.stop();
+      stopIconAnimation();
     notificationClosed();
   };
   if (animateIcon)
-    iconAnimation.update(activeNotification.type);
+    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")
   {
-    Notification.triggerQuestionListeners(activeNotification.id, buttonIndex === 0);
-    Notification.markAsShown(activeNotification.id);
+    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]));
     });
   }
 }
@@ skipping 44 matching lines @@
 }
 
 function showNotification(notification)
 {
   if (activeNotification && activeNotification.id === notification.id)
     return;
 
   activeNotification = notification;
   if (activeNotification.type === "critical" || activeNotification.type === "question")
   {
-    var hasWebkitNotifications = typeof webkitNotifications !== "undefined";
-    if (hasWebkitNotifications && "createHTMLNotification" in webkitNotifications)
-    {
-      var notification = webkitNotifications.createHTMLNotification("notification.html");
-      notification.show();
-      prepareNotificationIconAndPopup();
-      return;
-    }
-
-    var texts = Notification.getLocalizedTexts(notification);
+    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 iconUrl = ext.getURL("icons/detailed/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
@@ skipping 11 matching lines @@
         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 (hasWebkitNotifications && "createNotification" in webkitNotifications && activeNotification.type !== "question")
+    else if ("Notification" in window && activeNotification.type !== "question")
     {
       if (hasLinks)
         message += " " + ext.i18n.getMessage("notification_without_buttons");
 
       imgToBase64(iconUrl, function(iconData)
       {
-        var notification = webkitNotifications.createNotification(iconData, title, message);
-        notification.show();
-        notification.addEventListener("click", openNotificationLinks, false);
-        notification.addEventListener("close", notificationClosed, false);
+        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")
@@ skipping 65 matching lines @@
 
       sendResponse(selectors);
       break;
     case "should-collapse":
       if (isFrameWhitelisted(sender.page, sender.frame, "DOCUMENT"))
       {
         sendResponse(false);
         break;
       }
 
-      var requestHost = extractHostFromURL(msg.url);
+      var url = new URL(msg.url);
       var documentHost = extractHostFromFrame(sender.frame);
-      var thirdParty = isThirdParty(requestHost, documentHost);
-      var filter = defaultMatcher.matchesAny(msg.url, msg.mediatype, documentHost, thirdParty);
+      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);
       break;
-    case "check-whitelisted-urls":
-      var documentHost = extractHostFromFrame(sender.frame);
-      var sitekey = getKey(sender.page, sender.frame);
-
-      var result = Object.create(null);
-      for (var i = 0; i < msg.urls.length; i++)
-      {
-        var requestUrl = msg.urls[i];
-        var requestHost = extractHostFromURL(requestUrl);
-
-        var filter = defaultMatcher.matchesAny(
-          requestUrl, msg.mediatype, documentHost,
-          isThirdParty(requestHost, documentHost),
-          sitekey
-        );
-
-        result[requestUrl] = filter instanceof WhitelistFilter;
-      }
-
-      sendResponse(result);
-      break;
-    case "get-filters-from-selectors":
-      var filters = [];
-      var selectors = [];
-
-      if (!isFrameWhitelisted(sender.page, sender.frame, "ELEMHIDE"))
-      {
-        var documentHost = extractHostFromFrame(sender.frame);
-
-        for (var i = 0; i < msg.selectors.length; i++)
-        {
-          var selector = msg.selectors[i];
-          var filter = documentHost + "##" + selector;
-
-          if (!ElemHide.getException(Filter.fromText(filter), documentHost))
-          {
-            filters.push(filter);
-            selectors.push(selector);
-          }
-        }
-      }
-
-      sendResponse({filters: filters, selectors: selectors});
-      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: !isWhitelisted(sender.page.url)});
+        sendResponse({enabled: !isPageWhitelisted(sender.page)});
         return;
       }
       break;
     case "add-filters":
       var filters;
       try
       {
         filters = parseFilters(msg.text);
       }
       catch (error)
@@ skipping 13 matching lines @@
         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)
       {
-        sender.page.sendMessage(msg.payload, sendResponse);
-        // Return true to indicate that we want to call
-        // sendResponse asynchronously
-        return true;
-      }
-      break;
-    default:
-      sendResponse({});
+        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 = Notification.getNextToShow();
+  var notificationToShow = NotificationStorage.getNextToShow();
   if (notificationToShow)
     showNotification(notificationToShow);
 }, 3 * 60 * 1000);