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
  * 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/>.
  */
 
 var EXPORTED_SYMBOLS = ["AdblockPlusApi"];
 
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 const Cr = Components.results;
 const Cu = Components.utils;
 
 Cu.import("resource://gre/modules/Services.jsm");
 Cu.import("resource://gre/modules/Messaging.jsm");
 
+let XMLHttpRequest = Components.Constructor(
+    "@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 uriObject = Services.io.newURI(url, null, null);
+  try
+  {
+    return defaultMatcher.whitelist.matchesAny(
+      uriObject.spec, "DOCUMENT", uriObject.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);
   },
   set acceptableAdsEnabled(acceptableAdsEnabled)
   {
     if (acceptableAdsEnabled != AdblockPlusApi.acceptableAdsEnabled)
       UI.toggleAcceptableAds();
   },
-  initCommunication: function()
-  {
-    RequestService.addListener((function(data)
-    {
-      if (!data)
-        return {"success": false, "error": "malformed request"};
-
-      if (data["action"] == "getFiltersLoaded")
-        return {"success": true, "value": this.filtersLoaded};
-
-      if (!this.filtersLoaded)
-        return {"success": false, "error": "filters not loaded"};
-
-      switch (data["action"])
-      {
-        case "getAcceptableAdsEnabled":
-          return {"success": true, "value": this.acceptableAdsEnabled};
-        case "setAcceptableAdsEnabled":
-          if ("enable" in data)
-          {
-            this.acceptableAdsEnabled = !!data["enable"];
-            return {"success" : true};
-          }
-          return {"success": false, "error": "malformed request"};
-      }
-      return {"success": false, "error": "malformed request"};
-    }).bind(this), "AdblockPlus:Api");
-  },
-  isLocal: function(location)
-  {
-    return !location.schemeIs("http") && !location.schemeIs("https");
-  },
-  isPageWhitelisted: function(location)
-  {
-    return defaultMatcher.whitelist.matchesAny(
-      location.spec, "DOCUMENT", location.host, false, null);
-  },
-  whitelistSite: function(location, whitelisted)
-  {
+  get subscriptionsXml()
+  {
+    let request = new XMLHttpRequest();
+    // Synchronous requests are deprecated, but using an asynchronous request
+    // here (for a static resource that doesn't need to be downloaded anyway)
+    // would require a huge code change on the Java side, so we stick to
+    // synchronous requests
+    request.open("GET",
+                 "chrome://adblockplus/content/ui/subscriptions.xml",
+                 false);
+    request.send();
+    return request.responseText;
+  },
+  isSubscriptionListed: function(url)
+  {
+    return url in FilterStorage.knownSubscriptions;
+  },
+  addSubscription: function(url, title)
+  {
+    let subscription = Subscription.fromURL(url);
+    subscription.title = title;
+    FilterStorage.addSubscription(subscription);
+    if (!subscription.lastDownload)
+    {
+      Synchronizer.execute(subscription);
+    }
+  },
+  removeSubscription: function(url)
+  {
+    FilterStorage.removeSubscription(
+      FilterStorage.knownSubscriptions[url]);
+  },
+  isLocal: function(url)
+  {
+    let uriObject = Services.io.newURI(url, null, null);
+    return !uriObject.schemeIs("http") && !uriObject.schemeIs("https");
+  },
+  isPageWhitelisted: function(url)
+  {
+    return AdblockPlusApi.isLocal(url) || !!getWhitelistingFilter(url);
+  },
+  whitelistSite: function(url, whitelisted)
+  {
+    let uriObject = Services.io.newURI(url, null, null);
     if (whitelisted)
     {
-      var host = location.host.replace(/^www\./, "");
+      var host = uriObject.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 = AdblockPlusApi.isPageWhitelisted(location);
+      var filter = getWhitelistingFilter(url);
       while (filter)
       {
         FilterStorage.removeFilter(filter);
         if (filter.subscriptions.length)
           filter.disabled = true;
-        filter = AdblockPlusApi.isPageWhitelisted(location);
+        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};
+
+      if (!this.filtersLoaded)
+        return {"success": false, "error": "filters not loaded"};
+
+      switch (data["action"])
+      {
+        case "getAcceptableAdsEnabled":
+          return {"success": true, "value": this.acceptableAdsEnabled};
+        case "setAcceptableAdsEnabled":
+          if ("enable" in data)
+          {
+            this.acceptableAdsEnabled = !!data["enable"];
+            return {"success": true};
+          }
+          break;
+        case "getSubscriptionsXml":
+          return {"success": true, "value": this.subscriptionsXml};
+        case "isSubscriptionListed":
+          if ("url" in data)
+          {
+            return {"success": true,
+                "value": this.isSubscriptionListed(data["url"])};
+          }
+          break;
+        case "addSubscription":
+          if ("url" in data && "title" in data)
+          {
+            this.addSubscription(data["url"], data["title"]);
+            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"]);
+            return {"success": true};
+          }
+          break;
+      }
+      return {"success": false, "error": "malformed request"};
+    }).bind(this), "AdblockPlus:Api");
   }
 };
-