Issue 2351 - Add a custom menu item for whitelisting the current site

adblockplus/Api.jsm

 /*
  * 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
@@ skipping 18 matching lines @@
     "@mozilla.org/xmlextras/xmlhttprequest;1", "nsIXMLHttpRequest");
 
 function require(module)
 {
   let result = {};
   result.wrappedJSObject = result;
   Services.obs.notifyObservers(result, "adblockplus-require", module);
   return result.exports;
 }
 
+let {Filter} = require("filterClasses");
 let {FilterStorage} = require("filterStorage");
+let {defaultMatcher} = require("matcher");
 let {Prefs} = require("prefs");
 let {Subscription, SpecialSubscription, RegularSubscription, DownloadableSubscription, ExternalSubscription} = require("subscriptionClasses");
 let {Synchronizer} = require("synchronizer");
 let {UI} = require("ui");
 
+function getWhitelistingFilter(url)
+{
+  let location = Services.io.newURI(url, null, null);
+  try
+  {
+    return defaultMatcher.whitelist.matchesAny(
+      location.spec, "DOCUMENT", location.host, false, null);
+  }
+  catch (e)
+  {
+    return null;
+  }
+}
+
 var AdblockPlusApi =
 {
   get filtersLoaded()
   {
     return !FilterStorage._loading;
   },
   get acceptableAdsEnabled()
   {
     return FilterStorage.subscriptions.some(
       (subscription) => subscription.url == Prefs.subscriptions_exceptionsurl);
@@ skipping 28 matching lines @@
     if (!subscription.lastDownload)
     {
       Synchronizer.execute(subscription);
     }
   },
   removeSubscription: function(url)
   {
     FilterStorage.removeSubscription(
       FilterStorage.knownSubscriptions[url]);
   },
+  isLocal: function(url)
+  {
+    let location = Services.io.newURI(url, null, null);
+    return !location.schemeIs("http") && !location.schemeIs("https");
+  },
+  isPageWhitelisted: function(url)
+  {
+    return !!getWhitelistingFilter(url);
+  },
+  whitelistSite: function(url, whitelisted)
+  {
+    let location = Services.io.newURI(url, null, null);
+    if (whitelisted)
+    {
+      var host = location.host.replace(/^www\./, "");
+      var filter = Filter.fromText("@@||" + host + "^$document");
+      if (filter.subscriptions.length && filter.disabled)
+        filter.disabled = false;
+      else
+      {
+        filter.disabled = false;
+        FilterStorage.addFilter(filter);
+      }
+    }
+    else
+    {
+      // Remove any exception rules applying to this URL
+      var filter = getWhitelistingFilter(url);
+      while (filter)
+      {
+        FilterStorage.removeFilter(filter);
+        if (filter.subscriptions.length)
+          filter.disabled = true;
+        filter = getWhitelistingFilter(url);
+      }
+    }
+  },
   initCommunication: function()
   {
     RequestService.addListener((function(data)
     {
       if (!data)
         return {"success": false, "error": "malformed request"};
 
       if (data["action"] == "getFiltersLoaded")
         return {"success": true, "value": this.filtersLoaded};
 
@@ skipping 27 matching lines @@
             return {"success": true};
           }
           break;
         case "removeSubscription":
           if ("url" in data)
           {
             this.removeSubscription(data["url"]);
             return {"success": true};
           }
           break;
+        case "isLocal":
+          if ("url" in data)
+            return {"success": true,
+                    "value": this.isLocal(data["url"])};
+          break;
+        case "isPageWhitelisted":
+          if ("url" in data)
+            return {"success": true,
+                    "value": this.isPageWhitelisted(data["url"])};
+          break;
+        case "whitelistSite":
+          if ("url" in data && "whitelisted" in data)
+          {
+            this.whitelistSite(data["url"], data["whitelisted"] == "true");

[René Jeschke, 2015/05/06 10:56:33]

Wouldn't it be better to use a 'boolean' here (data["whitelisted"]), instead a
'string', as we are passing a JSON opject that understands booleans?

[Felix Dahlke, 2015/05/06 16:42:50]

Done.

+            return {"success": true};
+          }
+          break;
       }
       return {"success": false, "error": "malformed request"};
     }).bind(this), "AdblockPlus:Api");
   }
 };
-