Issue 6865 - Update ABP dependency to version 3.2

adblockplus/extensionBridge.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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, RegExpFilter} = require("filterClasses");
-let {FilterNotifier} = require("filterNotifier");
-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");
-
-const SUBSCRIPTIONS_SAVED_PREF = "subscriptions_saved";
-const USER_REMOVED_BLOCK_SUBS_PREF = "user_removed_block_subscriptions";
-const USER_REMOVED_EXCEPTIONS_SUB_PREF = "user_removed_exception_subscription";
-
-function initFilterListeners()
-{
-  FilterNotifier.on("load", onFiltersLoad);
-  FilterNotifier.on("save", onFiltersSave);
-}
-
-function onFiltersLoad()
-{
-  let detectedSubscriptionFailure = !hasBlockSubscription() &&
-    (!getBoolPref(SUBSCRIPTIONS_SAVED_PREF) || !getBoolPref(USER_REMOVED_BLOCK_SUBS_PREF) || FilterStorage.loadFromDiskFailed);
-
-  // We will only try to recover the default subscription settings if the addonVersion hasn't changed,
-  // otherwise it will be handled in firstRunActions(), inside ui.js
-  let {addonVersion} = require("info");
-  if (Prefs.currentVersion == addonVersion && detectedSubscriptionFailure)
-  {
-    if (getBoolPref(USER_REMOVED_EXCEPTIONS_SUB_PREF))
-    {
-      UI.addSubscription(UI.currentWindow, Prefs.currentVersion);
-    }
-    else
-    {
-      UI.addSubscription(UI.currentWindow, "0.0");
-    }
-  }
-  EventDispatcher.instance.sendRequest({type: "Abb:OnFiltersLoad"});
-}
-
-function onFiltersSave()
-{
-  if (hasBlockSubscription())
-  {
-    setBoolPref(SUBSCRIPTIONS_SAVED_PREF, true);
-  }
-  EventDispatcher.instance.sendRequest({type: "Abb:OnFiltersSave"});
-}
-
-function getBoolPref(name)
-{
-  let branch = getPrefsBranch();
+"use strict";
+
+const {defaultMatcher} = require("matcher");
+const {Filter, RegExpFilter} = require("filterClasses");
+const {FilterNotifier} = require("filterNotifier");
+const {FilterStorage} = require("filterStorage");
+const {Prefs} = require("prefs");
+const {Subscription, DownloadableSubscription, SpecialSubscription} =
+    require("subscriptionClasses");
+const {Synchronizer} = require("synchronizer");
+
+const ENABLE_PROP = "enable";
+const HOST_PROP = "host";
+const TITLE_PROP = "title";
+const URL_PROP = "url";
+
+function init()
+{
+  Promise.all([FilterNotifier.once("load"), Prefs.untilLoaded]).then(onLoaded);
+}
+
+function onLoaded()
+{
+  browser.runtime.abbRegisterRequestListener(handleRequest);
+  browser.runtime.abbSendRequest("Abb:OnLoaded");

[Thomas Greiner, 2018/08/27 15:24:41]

Detail: The "Abb:" prefix seems redundant here since we're already calling
`abbSendRequest()`. Instead, we could just prepend it in ext-c-runtime.js.

[diegocarloslima, 2018/08/27 21:19:16]

Acknowledged.

+  FilterNotifier.on("save", onFiltersSaved);
+}
+
+function onFiltersSaved()
+{
+  browser.runtime.abbSendRequest("Abb:OnFiltersSaved");
+}
+
+function handleRequest(data)
+{
+

[anton, 2018/08/27 05:57:10]

do we need this empty line?

[diegocarloslima, 2018/08/27 21:19:16]

Acknowledged.

+  switch ((data["action"]))
+  {
+    case "getAdblockPlusEnabled":
+      return successData(Prefs.enabled);
+
+    case "setAdblockPlusEnabled":
+      if (!checkData(data, ENABLE_PROP)) break;
+      Prefs.enabled = !!data[ENABLE_PROP];
+      return successData();
+
+    case "getAcceptableAdsEnabled":
+      return successData(isSubscriptionEnabled(
+          Prefs.subscriptions_exceptionsurl));
+
+    case "setAcceptableAdsEnabled":
+      if (!checkData(data, ENABLE_PROP)) break;
+      const acceptableAdsTitle = "Allow non-intrusive advertising";
+      setSubscriptionEnabled(!!data[ENABLE_PROP],
+          Prefs.subscriptions_exceptionsurl, acceptableAdsTitle);
+      return successData(getAllSubscriptions());

[Thomas Greiner, 2018/08/27 15:24:41]

The previous version didn't return anything but I couldn't find where this
function is being used to check whether the return value is actually being used.

My assumption would be that it isn't since the `getAllSubscriptions()` function
is preceded by a "remove" comment. If that's the case let's remove the return
value and the `getAllSubscriptions()` function.

[diegocarloslima, 2018/08/27 21:19:16]

Yeah, this was some test code that I forgot to remove ^^

+
+    case "getEnabledSubscriptions":
+      return successData(getEnabledSubscriptions());
+
+    case "isSubscriptionEnabled":
+      if (!checkData(data, URL_PROP)) break;
+      return successData(isSubscriptionEnabled(data[URL_PROP]));
+
+    case "addSubscription":
+      if (!checkData(data, URL_PROP)) break;
+      setSubscriptionEnabled(true, data[URL_PROP], data[TITLE_PROP]);
+      return successData();
+
+    case "removeSubscription":
+      if (!checkData(data, URL_PROP)) break;
+      setSubscriptionEnabled(false, data[URL_PROP]);
+      return successData();
+
+    case "getWhitelistedDomains":
+      return successData(getWhitelistedDomains());
+
+    case "isDomainWhitelisted":
+      if (!checkData(data, [URL_PROP, HOST_PROP])) break;
+      return successData(isDomainWhitelisted(data[URL_PROP], data[HOST_PROP]));
+
+    case "whitelistDomain":
+      if (!checkData(data, [ENABLE_PROP, URL_PROP, HOST_PROP])) break;
+      setDomainWhitelisted(!!data[ENABLE_PROP], data[URL_PROP], data[HOST_PROP]);
+      return successData();
+
+  }
+  return errorData("Malformed request");
+}
+
+// remove
+function getAllSubscriptions()
+{
+  return FilterStorage.subscriptions.map(sub => ({"title": sub.title, "url": sub.url, "downloadable": (sub instanceof DownloadableSubscription), "special": (sub instanceof SpecialSubscription), "disabled": sub.disabled}));
+}
+
+function getEnabledSubscriptions()
+{
+  return FilterStorage.subscriptions.filter(sub => !sub.disabled).map(sub =>
+      ({[TITLE_PROP]: sub.title, [URL_PROP]: sub.url}));
+}
+
+function isSubscriptionEnabled(url)
+{
+  const sub = Subscription.fromURL(url);
+  return sub.url in FilterStorage.knownSubscriptions && !sub.disabled;
+}
+
+function setSubscriptionEnabled(isEnabled, url, title)
+{
+  if (isSubscriptionEnabled(url) == isEnabled) return;
+  if (isEnabled) addSubscription(url, title);
+  else removeSubscription(url);
+}
+
+function addSubscription(url, title)
+{
+  const sub = Subscription.fromURL(url);
+  sub.disabled = false;
+  if (title) sub.title = title;
+  FilterStorage.addSubscription(sub);
+
+  if (sub instanceof DownloadableSubscription && !sub.lastDownload)
+  {
+    Synchronizer.execute(sub);
+  }
+}
+
+function removeSubscription(url)
+{
+  FilterStorage.removeSubscription(Subscription.fromURL(url));
+}
+
+function addFilter(text)
+{
+  const filter = Filter.fromText(text);
+  if (filter.disabled) filter.disabled = false;
+  if (!filter.subscriptions.length) FilterStorage.addFilter(filter);
+}
+
+function removeFilter(filter)
+{
+  FilterStorage.removeFilter(filter);
+  if (filter.subscriptions.length) filter.disabled = true;
+}
+
+function getWhitelistedDomains()
+{
+  const whitelistRegex = /^@@\|\|([^/:]+)\^\$document$/;
+  const results = [];
+
+  FilterStorage.subscriptions.forEach(function(sub) {
+    if (!(sub instanceof SpecialSubscription) || sub.disabled) return;
+    sub.filters.forEach(function(filter) {

[Thomas Greiner, 2018/08/27 15:24:41]

Suggestion: If you want you can use a for-of loop instead of
`Array.prototype.forEach()`.

i.e. for (let filter of filters)

That way those loops will also be compatible with `Set` when we change the
implementation of the data structure in Core (see #6559).

[diegocarloslima, 2018/08/27 21:19:16]

Acknowledged.

+      const match = filter.text.match(whitelistRegex);
+      if (match) results.push({[URL_PROP]: match[1]});
+    });
+  });
+
+  return results;
+}
+
+function flatIt(array)

[Thomas Greiner, 2018/08/27 15:24:41]

Detail: You can more efficiently implement that using

Array.prototype.concat.apply([], array)

at least until Firefox 62 which will add `Array.prototype.flat()` so we could
even polyfill it until then.

[diegocarloslima, 2018/08/27 21:19:16]

This was also some test code ^^

+{
+  let flatArray = [];
+  array.forEach(function(item) {
+    flatArray = flatArray.concat(item);
+  });
+  return flatArray;
+}
+
+function isDomainWhitelisted(url, host)
+{
+  return !!getWhitelistingFilter(url, host);
+}
+
+function setDomainWhitelisted(isWhitelisted, url, host)
+{
+  if (isDomainWhitelisted(url, host) == isWhitelisted) return;
+  if (isWhitelisted) addDomainToWhitelist(host);
+  else removeDomainFromWhitelist(url, host);
+}
+
+function addDomainToWhitelist(host)
+{
+  addFilter("@@||" + host + "^$document");
+}
+
+function removeDomainFromWhitelist(url, host)
+{
+  let filter = getWhitelistingFilter(url, host);
+  while (filter)
+  {
+    removeFilter(filter);
+    filter = getWhitelistingFilter(url, host);
+  }
+}
+
+function getWhitelistingFilter(url, host)
+{
   try
   {
-    return branch.getBoolPref(name);
-  }
-  catch (e)
-  {
-    return null;
-  }
-}
-
-function setBoolPref(name, value)
-{
-  let branch = getPrefsBranch();
-  branch.setBoolPref(name, value);
-  Services.prefs.savePrefFile(null);
-}
-
-function getPrefsBranch()
-{
-  let {addonRoot, addonName} = require("info");
-  let branchName = "extensions." + addonName + ".";
-  return Services.prefs.getBranch(branchName);
-}
-
-function hasBlockSubscription()
-{
-  return FilterStorage.subscriptions.some(
-    subscription => subscription instanceof DownloadableSubscription && subscription.url != Prefs.subscriptions_exceptionsurl);
-}
-
-function getWhitelistingFilter(url, host)
-{
-  try
-  {
     return defaultMatcher.whitelist.matchesAny(
-      url, RegExpFilter.typeMap.DOCUMENT, host, false, null, false);
-  }
-  catch (e)
-  {
-    return null;
-  }
-}
-
-var AdblockPlusApi =
-{
-  get filtersLoaded()
-  {
-    return !FilterStorage._loading;
-  },
-  get adblockPlusEnabled()
-  {
-    return Prefs.enabled;
-  },
-  set adblockPlusEnabled(adblockPlusEnabled)
-  {
-    Prefs.enabled = adblockPlusEnabled
-  },
-  get acceptableAdsEnabled()
-  {
-    return FilterStorage.subscriptions.some(
-      (subscription) => subscription.url == Prefs.subscriptions_exceptionsurl);
-  },
-  set acceptableAdsEnabled(acceptableAdsEnabled)
-  {
-    if (acceptableAdsEnabled != AdblockPlusApi.acceptableAdsEnabled)
-      UI.toggleAcceptableAds();
-  },
-  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 subscriptionToAdd = Subscription.fromURL(url);
-    if (title)
-      subscriptionToAdd.title = title;
-    FilterStorage.addSubscription(subscriptionToAdd);
-    let subscription = FilterStorage.knownSubscriptions[url];
-    if (subscription)
-    {
-      subscription.disabled = false;
-      if (!subscription.lastDownload)
-      {
-        Synchronizer.execute(subscription);
-      }
-    }
-    if (url == Prefs.subscriptions_exceptionsurl)
-    {
-      setBoolPref(USER_REMOVED_EXCEPTIONS_SUB_PREF, false);
-    }
-    else if (hasBlockSubscription())
-    {
-      setBoolPref(USER_REMOVED_BLOCK_SUBS_PREF, false);
-    }
-  },
-  removeSubscription: function(url)
-  {
-    FilterStorage.removeSubscription(FilterStorage.knownSubscriptions[url]);
-    if (url == Prefs.subscriptions_exceptionsurl)
-    {
-      setBoolPref(USER_REMOVED_EXCEPTIONS_SUB_PREF, true);
-    }
-    else if (!hasBlockSubscription())
-    {
-      setBoolPref(USER_REMOVED_BLOCK_SUBS_PREF, true);
-    }
-  },
-  getActiveSubscriptions: function()
-  {
-    let subscriptions = [];
-    for (let i = 0; i < FilterStorage.subscriptions.length; i++)
-    {
-      let subscription = FilterStorage.subscriptions[i];
-      if (!subscription.disabled)
-        subscriptions.push({"title": subscription.title, "url": subscription.url});
-    }
-    return subscriptions;
-  },
-  get whitelistedWebsites()
-  {
-    let whitelistedWebsites = [];
-    for (let i = 0; i < FilterStorage.subscriptions.length; i++)
-    {
-      let subscription = FilterStorage.subscriptions[i];
-      if (subscription.url && subscription.url.startsWith("~user~") && subscription.filters)
-      {
-        for (let j = 0; j < subscription.filters.length; j++)
-        {
-          let filter = subscription.filters[j];
-          let whitelistMatch = filter.text ? filter.text.match(/^@@\|\|([^/:]+)\^\$document$/) : null;
-          if(whitelistMatch)
-          {
-            whitelistedWebsites.push({"url": whitelistMatch[1]})
-          }
-        }
-      }
-    }
-    return whitelistedWebsites;
-  },
-  isWebsiteWhitelisted: function(url, host)
-  {
-    return !!getWhitelistingFilter(url, host);
-  },
-  whitelistWebsite: function(url, host, whitelisted)
-  {
-    if (whitelisted)
-    {
-      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, host);
-      while (filter)
-      {
-        FilterStorage.removeFilter(filter);
-        if (filter.subscriptions.length)
-        {
-          filter.disabled = true;
-        }
-        filter = getWhitelistingFilter(url);
-      }
-    }
-  },
-  initCommunication: function()
-  {
-    initFilterListeners();
-
-    EventDispatcher.instance.registerListener((event, data, callback) =>
-    {
-      if (!data)
-      {
-        callback.onError("malformed request");
-        return;
-      }
-
-      if (!this.filtersLoaded)
-      {
-        callback.onError("filters not loaded");
-        return;
-      }
-
-      switch (data["action"])
-      {
-        case "getAdblockPlusEnabled":
-          callback.onSuccess({"value": this.adblockPlusEnabled});
-          return;
-        case "setAdblockPlusEnabled":
-          if ("enable" in data)
-          {
-            this.adblockPlusEnabled = !!data["enable"];
-            callback.onSuccess({});
-            return;
-          }
-          break;
-        case "getAcceptableAdsEnabled":
-          callback.onSuccess({"value": this.acceptableAdsEnabled});
-          return;
-        case "setAcceptableAdsEnabled":
-          if ("enable" in data)
-          {
-            this.acceptableAdsEnabled = !!data["enable"];
-            callback.onSuccess({});
-            return;
-          }
-          break;
-        case "getSubscriptionsXml":
-          callback.onSuccess({"value": this.subscriptionsXml});
-          return;
-        case "getActiveSubscriptions":
-          callback.onSuccess({"value": this.getActiveSubscriptions()});
-          return;
-        case "isSubscriptionListed":
-          if ("url" in data)
-          {
-            callback.onSuccess({"value": this.isSubscriptionListed(data["url"])});
-            return;
-          }
-          break;
-        case "addSubscription":
-          if ("url" in data)
-          {
-            this.addSubscription(data["url"], data["title"]);
-            callback.onSuccess({});
-            return;
-          }
-          break;
-        case "removeSubscription":
-          if ("url" in data)
-          {
-            this.removeSubscription(data["url"]);
-            callback.onSuccess({});
-            return;
-          }
-          break;
-        case "getWhitelistedWebsites":
-          callback.onSuccess({"value": this.whitelistedWebsites});
-          return;
-        case "isWebsiteWhitelisted":
-          if ("url" in data && "host" in data)
-          {
-            callback.onSuccess({"value": this.isWebsiteWhitelisted(data["url"], data["host"])});
-            return;
-          }
-          break;
-        case "whitelistWebsite":
-          if ("url" in data && "host" in data && "whitelisted" in data)
-          {
-            this.whitelistWebsite(data["url"], data["host"], data["whitelisted"]);
-            callback.onSuccess({});
-            return;
-          }
-          break;
-      }
-      callback.onError("malformed request");
-    }, "AdblockPlus:Api");
-  }
-};
+        url, RegExpFilter.typeMap.DOCUMENT, host, false, null, false);
+  }
+  catch (e) {}
+  return null;
+}
+
+function checkData(data, check)
+{
+  if (!data) return false;
+  const properties = [].concat(check || []);
+  return properties.every(function(item) {
+    return item in data;
+  });
+}
+
+function successData(value)
+{
+  const data = {};
+  data.success = true;
+  if (value != null) data.value = value;
+  return data;
+}
+
+function errorData(errorMsg)
+{
+  const data = {};
+  if (errorMsg) data.errorMsg = errorMsg;

[Thomas Greiner, 2018/08/27 15:24:42]

The endpoint in ext-c-runtime.js expects this property to be called "error", not
"errorMsg".

Also the success value doesn't appear to be accessed in ext-c-runtime.js so
maybe I'm just misunderstanding how the implementation works. So feel free to
ignore my comment in case it doesn't apply.

[diegocarloslima, 2018/08/27 21:19:16]

Acknowledged.

+  return data;
+}
+
+init();