Issue 4084 - Do not use @@bidi_dir directly in adblockplusui

messageResponder.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2016 Eyeo GmbH
+ * 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/>.
  */
 
+/* globals require */
+
+"use strict";
+
 (function(global)
 {
-  if (!global.ext)
-    global.ext = require("ext_background");
-
-  var Prefs = require("prefs").Prefs;
-  var Utils = require("utils").Utils;
-  var FilterStorage = require("filterStorage").FilterStorage;
-  var FilterNotifier = require("filterNotifier").FilterNotifier;
-  var defaultMatcher = require("matcher").defaultMatcher;
-  var CSSRules = require("cssRules").CSSRules;
-  var NotificationStorage = require("notification").Notification;
-
-  var filterClasses = require("filterClasses");
-  var Filter = filterClasses.Filter;
-  var BlockingFilter = filterClasses.BlockingFilter;
-  var RegExpFilter = filterClasses.RegExpFilter;
-  var Synchronizer = require("synchronizer").Synchronizer;
-
-  var info = require("info");
-  var subscriptionClasses = require("subscriptionClasses");
-  var Subscription = subscriptionClasses.Subscription;
-  var DownloadableSubscription = subscriptionClasses.DownloadableSubscription;
-  var SpecialSubscription = subscriptionClasses.SpecialSubscription;
+  let ext = global.ext || require("ext_background");
+
+  const {port} = require("messaging");
+  const {Prefs} = require("prefs");
+  const {Utils} = require("utils");
+  const {FilterStorage} = require("filterStorage");
+  const {FilterNotifier} = require("filterNotifier");
+  const {defaultMatcher} = require("matcher");
+  const {ElemHideEmulation} = require("elemHideEmulation");
+  const {Notification: NotificationStorage} = require("notification");
+
+  const {Filter, BlockingFilter, RegExpFilter} = require("filterClasses");
+  const {Synchronizer} = require("synchronizer");
+
+  const info = require("info");
+  const {Subscription,
+         DownloadableSubscription,
+         SpecialSubscription} = require("subscriptionClasses");
 
   // Some modules doesn't exist on Firefox. Moreover,
   // require() throws an exception on Firefox in that case.
   // However, try/catch causes the whole function to to be
   // deoptimized on V8. So we wrap it into another function.
   function tryRequire(module)
   {
     try
     {
       return require(module);
     }
     catch (e)
     {
       return null;
     }
   }
 
   function convertObject(keys, obj)
   {
-    var result = {};
-    for (var i = 0; i < keys.length; i++)
-    {
-      var key = keys[i];
+    let result = {};
+    for (let key of keys)
+    {
       if (key in obj)
         result[key] = obj[key];
     }
     return result;
   }
 
   function convertSubscription(subscription)
   {
-    var obj = convertObject(["disabled", "downloadStatus", "homepage",
+    let obj = convertObject(["disabled", "downloadStatus", "homepage",
                              "lastDownload", "title", "url"], subscription);
+    if (subscription instanceof SpecialSubscription)
+      obj.filters = subscription.filters.map(convertFilter);
     obj.isDownloading = Synchronizer.isExecuting(subscription.url);
     return obj;
   }
 
-  var convertFilter = convertObject.bind(null, ["text"]);
-
-  var changeListeners = new global.ext.PageMap();
-  var listenedPreferences = Object.create(null);
-  var listenedFilterChanges = Object.create(null);
-  var messageTypes = {
-    "app": "app.respond",
-    "filter": "filters.respond",
-    "pref": "prefs.respond",
-    "subscription": "subscriptions.respond"
-  };
-
-  function sendMessage(type, action)
-  {
-    var pages = changeListeners.keys();
+  let convertFilter = convertObject.bind(null, ["text"]);
+
+  let changeListeners = new ext.PageMap();
+  let listenedPreferences = Object.create(null);
+  let listenedFilterChanges = Object.create(null);
+  let messageTypes = new Map([
+    ["app", "app.respond"],
+    ["filter", "filters.respond"],
+    ["pref", "prefs.respond"],
+    ["subscription", "subscriptions.respond"]
+  ]);
+
+  function sendMessage(type, action, ...args)
+  {
+    let pages = changeListeners.keys();
     if (pages.length == 0)
       return;
 
-    var args = [];
-    for (var i = 2; i < arguments.length; i++)
-    {
-      var arg = arguments[i];
+    let convertedArgs = [];
+    for (let arg of args)
+    {
       if (arg instanceof Subscription)
-        args.push(convertSubscription(arg));
+        convertedArgs.push(convertSubscription(arg));
       else if (arg instanceof Filter)
-        args.push(convertFilter(arg));
+        convertedArgs.push(convertFilter(arg));
       else
-        args.push(arg);
-    }
-
-    for (var j = 0; j < pages.length; j++)
-    {
-      var page = pages[j];
-      var filters = changeListeners.get(page);
-      var actions = filters[type];
+        convertedArgs.push(arg);
+    }
+
+    for (let page of pages)
+    {
+      let filters = changeListeners.get(page);
+      let actions = filters[type];
       if (actions && actions.indexOf(action) != -1)
       {
         page.sendMessage({
-          type: messageTypes[type],
-          action: action,
-          args: args
+          type: messageTypes.get(type),
+          action,
+          args: convertedArgs
         });
       }
     }
   }
 
   function addFilterListeners(type, actions)
   {
-    actions.forEach(function(action)
-    {
-      var name;
+    for (let action of actions)
+    {
+      let name;
       if (type == "filter" && action == "loaded")
         name = "load";
       else
         name = type + "." + action;
 
       if (!(name in listenedFilterChanges))
       {
         listenedFilterChanges[name] = null;
-        FilterNotifier.on(name, function()
+        FilterNotifier.on(name, (...args) =>
         {
-          var args = [type, action];
-          for (var i = 0; i < arguments.length; i++)
-            args.push(arguments[i]);
-          sendMessage.apply(null, args);
+          sendMessage(type, action, ...args);
         });
       }
-    });
+    }
   }
 
   function getListenerFilters(page)
   {
-    var listenerFilters = changeListeners.get(page);
+    let listenerFilters = changeListeners.get(page);
     if (!listenerFilters)
     {
       listenerFilters = Object.create(null);
       changeListeners.set(page, listenerFilters);
     }
     return listenerFilters;
   }
 
-  global.ext.onMessage.addListener(function(message, sender, callback)
-  {
-    switch (message.type)
-    {
-      case "app.get":
-        if (message.what == "issues")
+  port.on("app.get", (message, sender) =>
+  {
+    if (message.what == "issues")
+    {
+      let subscriptionInit = tryRequire("subscriptionInit");
+      let result = subscriptionInit ? subscriptionInit.reinitialized : false;
+      return {filterlistsReinitialized: result};
+    }
+
+    if (message.what == "doclink")
+      return Utils.getDocLink(message.link);
+
+    if (message.what == "localeInfo")
+    {
+      let bidiDir;
+      if ("chromeRegistry" in Utils)
+      {
+        let isRtl = Utils.chromeRegistry.isLocaleRTL("adblockplus");
+        bidiDir = isRtl ? "rtl" : "ltr";
+      }
+      else
+        bidiDir = Utils.readingDirection;
+
+      return {locale: Utils.appLocale, bidiDir};
+    }
+
+    if (message.what == "features")
+    {
+      return {
+        devToolsPanel: info.platform == "chromium"
+      };
+    }
+
+    return info[message.what];
+  });
+
+  port.on("app.listen", (message, sender) =>
+  {
+    getListenerFilters(sender.page).app = message.filter;
+  });
+
+  port.on("app.open", (message, sender) =>
+  {
+    if (message.what == "options")
+      ext.showOptions();
+  });
+
+  port.on("filters.add", (message, sender) =>
+  {
+    let result = require("filterValidation").parseFilter(message.text);
+    let errors = [];
+    if (result.error)
+      errors.push(result.error.toString());
+    else if (result.filter)
+      FilterStorage.addFilter(result.filter);
+
+    return errors;
+  });
+
+  port.on("filters.blocked", (message, sender) =>
+  {
+    let filter = defaultMatcher.matchesAny(message.url,
+      RegExpFilter.typeMap[message.requestType], message.docDomain,
+      message.thirdParty);
+
+    return filter instanceof BlockingFilter;
+  });
+
+  port.on("filters.get", (message, sender) =>
+  {
+    if (message.what == "elemhideemulation")
+    {
+      let filters = [];
+      const {checkWhitelisted} = require("whitelisting");
+
+      if (Prefs.enabled && !checkWhitelisted(sender.page, sender.frame,
+                            RegExpFilter.typeMap.DOCUMENT |
+                            RegExpFilter.typeMap.ELEMHIDE))
+      {
+        let {hostname} = sender.frame.url;
+        filters = ElemHideEmulation.getRulesForDomain(hostname);
+        filters = filters.map((filter) =>
         {
-          var subscriptionInit = tryRequire("subscriptionInit");
-          callback({
-            filterlistsReinitialized: subscriptionInit ? subscriptionInit.reinitialized : false,
-            legacySafariVersion: (info.platform == "safari" && (
-                Services.vc.compare(info.platformVersion, "6.0") < 0 ||   // beforeload breaks websites in Safari 5
-                Services.vc.compare(info.platformVersion, "6.1") == 0 ||  // extensions are broken in 6.1 and 7.0
-                Services.vc.compare(info.platformVersion, "7.0") == 0))
-          });
-        }
-        else if (message.what == "doclink")
-          callback(Utils.getDocLink(message.link));
-        else if (message.what == "localeInfo")
+          return {
+            selector: filter.selector,
+            text: filter.text
+          };
+        });
+      }
+      return filters;
+    }
+
+    let subscription = Subscription.fromURL(message.subscriptionUrl);
+    if (!subscription)
+      return [];
+
+    return subscription.filters.map(convertFilter);
+  });
+
+  port.on("filters.importRaw", (message, sender) =>
+  {
+    let result = require("filterValidation").parseFilters(message.text);
+    let errors = [];
+    for (let error of result.errors)
+    {
+      if (error.type != "unexpected-filter-list-header")
+        errors.push(error.toString());
+    }
+
+    if (errors.length > 0)
+      return errors;
+
+    let seenFilter = Object.create(null);
+    for (let filter of result.filters)
+    {
+      FilterStorage.addFilter(filter);
+      seenFilter[filter.text] = null;
+    }
+
+    if (!message.removeExisting)
+      return errors;
+
+    for (let subscription of FilterStorage.subscriptions)
+    {
+      if (!(subscription instanceof SpecialSubscription))
+        continue;
+
+      for (let j = subscription.filters.length - 1; j >= 0; j--)
+      {
+        let filter = subscription.filters[j];
+        if (/^@@\|\|([^/:]+)\^\$document$/.test(filter.text))
+          continue;
+
+        if (!(filter.text in seenFilter))
+          FilterStorage.removeFilter(filter);
+      }
+    }
+
+    return errors;
+  });
+
+  port.on("filters.listen", (message, sender) =>
+  {
+    getListenerFilters(sender.page).filter = message.filter;
+    addFilterListeners("filter", message.filter);
+  });
+
+  port.on("filters.remove", (message, sender) =>
+  {
+    let filter = Filter.fromText(message.text);
+    let subscription = null;
+    if (message.subscriptionUrl)
+      subscription = Subscription.fromURL(message.subscriptionUrl);
+
+    if (!subscription)
+      FilterStorage.removeFilter(filter);
+    else
+      FilterStorage.removeFilter(filter, subscription, message.index);
+  });
+
+  port.on("prefs.get", (message, sender) =>
+  {
+    return Prefs[message.key];
+  });
+
+  port.on("prefs.listen", (message, sender) =>
+  {
+    getListenerFilters(sender.page).pref = message.filter;
+    for (let preference of message.filter)
+    {
+      if (!(preference in listenedPreferences))
+      {
+        listenedPreferences[preference] = null;
+        Prefs.on(preference, () =>
         {
-          var bidiDir;
-          if ("chromeRegistry" in Utils)
-            bidiDir = Utils.chromeRegistry.isLocaleRTL("adblockplus") ? "rtl" : "ltr";
-          else
-            bidiDir = Utils.readingDirection;

[Sebastian Noack, 2016/05/30 14:16:57]

I guess we should move the logic for @@bidi_dir and @@ui_locale from
ext/common.js here. If those aren't supported by ext.chrome.getMessage() on all
platforms, the mock implementation shouldn't support it either, otherwise
somebody might start using it without noticing that it won't work on Edge.

-
-          callback({locale: Utils.appLocale, bidiDir: bidiDir});
-        }
-        else if (message.what == "features")
-        {
-          callback({
-            devToolsPanel: info.platform == "chromium",
-            safariContentBlocker: "safari" in global
-                && "extension" in global.safari
-                && "setContentBlocker" in global.safari.extension
-          });
-        }
-        else
-          callback(info[message.what]);
-        break;
-      case "app.listen":
-        getListenerFilters(sender.page).app = message.filter;
-        break;
-      case "app.open":
-        if (message.what == "options")
-          ext.showOptions();
-        break;
-      case "filters.add":
-        var result = require("filterValidation").parseFilter(message.text);
-        var errors = [];
-        if (result.error)
-          errors.push(result.error.toString());
-        else if (result.filter)
-          FilterStorage.addFilter(result.filter);
-        callback(errors);
-        break;
-      case "filters.blocked":
-        var filter = defaultMatcher.matchesAny(message.url,
-          RegExpFilter.typeMap[message.requestType], message.docDomain,
-          message.thirdParty);
-        callback(filter instanceof BlockingFilter);
-        break;
-      case "filters.get":
-        if (message.what == "cssproperties")
-        {
-          var filters = [];
-          var checkWhitelisted = require("whitelisting").checkWhitelisted;
-
-          if (!checkWhitelisted(sender.page, sender.frame,
-                                RegExpFilter.typeMap.DOCUMENT |
-                                RegExpFilter.typeMap.ELEMHIDE))
-          {
-            filters = CSSRules.getRulesForDomain(sender.frame.url.hostname);
-            filters = filters.map(function(filter)
-            {
-              return {
-                prefix: filter.selectorPrefix,
-                suffix: filter.selectorSuffix,
-                regexp: filter.regexpString
-              };
-            });
-          }
-          callback(filters);
-          break;
-        }
-
-        var subscription = Subscription.fromURL(message.subscriptionUrl);
-        if (!subscription)
-        {
-          callback([]);
-          break;
-        }
-
-        callback(subscription.filters.map(convertFilter));
-        break;
-      case "filters.importRaw":
-        var result = require("filterValidation").parseFilters(message.text);
-        var errors = [];
-        for (var i = 0; i < result.errors.length; i++)
-        {
-          var error = result.errors[i];
-          if (error.type != "unexpected-filter-list-header")
-            errors.push(error.toString());
-        }
-
-        callback(errors);
-        if (errors.length > 0)
-          return;
-
-        var seenFilter = Object.create(null);
-        for (var i = 0; i < result.filters.length; i++)
-        {
-          var filter = result.filters[i];
-          FilterStorage.addFilter(filter);
-          seenFilter[filter.text] = null;
-        }
-
-        if (!message.removeExisting)
-          return;
-
-        for (var i = 0; i < FilterStorage.subscriptions.length; i++)
-        {
-          var subscription = FilterStorage.subscriptions[i];
-          if (!(subscription instanceof SpecialSubscription))
-            continue;
-
-          for (var j = subscription.filters.length - 1; j >= 0; j--)
-          {
-            var filter = subscription.filters[j];
-            if (/^@@\|\|([^\/:]+)\^\$document$/.test(filter.text))
-              continue;
-
-            if (!(filter.text in seenFilter))
-              FilterStorage.removeFilter(filter);
-          }
-        }
-        break;
-      case "filters.listen":
-        getListenerFilters(sender.page).filter = message.filter;
-        addFilterListeners("filter", message.filter);
-        break;
-      case "filters.remove":
-        var filter = Filter.fromText(message.text);
-        var subscription = null;
-        if (message.subscriptionUrl)
-          subscription = Subscription.fromURL(message.subscriptionUrl);
-
-        if (!subscription)
-          FilterStorage.removeFilter(filter);
-        else
-          FilterStorage.removeFilter(filter, subscription, message.index);
-        break;
-      case "prefs.get":
-        callback(Prefs[message.key]);
-        break;
-      case "prefs.listen":
-        getListenerFilters(sender.page).pref = message.filter;
-        message.filter.forEach(function(preference)
-        {
-          if (!(preference in listenedPreferences))
-          {
-            listenedPreferences[preference] = null;
-            Prefs.on(preference, function()
-            {
-              sendMessage("pref", preference, Prefs[preference]);
-            });
-          }
+          sendMessage("pref", preference, Prefs[preference]);
         });
-        break;
-      case "prefs.toggle":
-        if (message.key == "notifications_ignoredcategories")
-          NotificationStorage.toggleIgnoreCategory("*");
-        else
-          Prefs[message.key] = !Prefs[message.key];
-        break;
-      case "subscriptions.add":
-        var subscription = Subscription.fromURL(message.url);
-        if ("title" in message)
-          subscription.title = message.title;
-        if ("homepage" in message)
-          subscription.homepage = message.homepage;
-
-        if (message.confirm)
-        {
-          ext.showOptions(function()
-          {
-            sendMessage("app", "addSubscription", subscription);
-          });
-        }
-        else
-        {
-          subscription.disabled = false;
-          FilterStorage.addSubscription(subscription);
-
-          if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
-            Synchronizer.execute(subscription);
-        }
-        break;
-      case "subscriptions.get":
-        var subscriptions = FilterStorage.subscriptions.filter(function(s)
-        {
-          if (message.ignoreDisabled && s.disabled)
-            return false;
-          if (s instanceof DownloadableSubscription && message.downloadable)
-            return true;
-          if (s instanceof SpecialSubscription && message.special)
-            return true;
-          return false;
-        });
-        callback(subscriptions.map(convertSubscription));
-        break;
-      case "subscriptions.listen":
-        getListenerFilters(sender.page).subscription = message.filter;
-        addFilterListeners("subscription", message.filter);
-        break;
-      case "subscriptions.remove":
-        var subscription = Subscription.fromURL(message.url);
-        if (subscription.url in FilterStorage.knownSubscriptions)
-          FilterStorage.removeSubscription(subscription);
-        break;
-      case "subscriptions.toggle":
-        var subscription = Subscription.fromURL(message.url);
-        if (subscription.url in FilterStorage.knownSubscriptions)
-        {
-          if (subscription.disabled || message.keepInstalled)
-            subscription.disabled = !subscription.disabled;
-          else
-            FilterStorage.removeSubscription(subscription);
-        }
-        else
-        {
-          subscription.disabled = false;
-          subscription.title = message.title;
-          subscription.homepage = message.homepage;
-          FilterStorage.addSubscription(subscription);
-          if (!subscription.lastDownload)
-            Synchronizer.execute(subscription);
-        }
-        break;
-      case "subscriptions.update":
-        var subscriptions = message.url ? [Subscription.fromURL(message.url)] :
-                            FilterStorage.subscriptions;
-        for (var i = 0; i < subscriptions.length; i++)
-        {
-          var subscription = subscriptions[i];
-          if (subscription instanceof DownloadableSubscription)
-            Synchronizer.execute(subscription, true);
-        }
-        break;
+      }
+    }
+  });
+
+  port.on("prefs.toggle", (message, sender) =>
+  {
+    if (message.key == "notifications_ignoredcategories")
+      NotificationStorage.toggleIgnoreCategory("*");
+    else
+      Prefs[message.key] = !Prefs[message.key];
+  });
+
+  port.on("subscriptions.add", (message, sender) =>
+  {
+    let subscription = Subscription.fromURL(message.url);
+    if ("title" in message)
+      subscription.title = message.title;
+    if ("homepage" in message)
+      subscription.homepage = message.homepage;
+
+    if (message.confirm)
+    {
+      ext.showOptions(() =>
+      {
+        sendMessage("app", "addSubscription", subscription);
+      });
+    }
+    else
+    {
+      subscription.disabled = false;
+      FilterStorage.addSubscription(subscription);
+
+      if (subscription instanceof DownloadableSubscription &&
+          !subscription.lastDownload)
+        Synchronizer.execute(subscription);
+    }
+  });
+
+  port.on("subscriptions.get", (message, sender) =>
+  {
+    let subscriptions = FilterStorage.subscriptions.filter((s) =>
+    {
+      if (message.ignoreDisabled && s.disabled)
+        return false;
+      if (s instanceof DownloadableSubscription && message.downloadable)
+        return true;
+      if (s instanceof SpecialSubscription && message.special)
+        return true;
+      return false;
+    });
+
+    return subscriptions.map(convertSubscription);
+  });
+
+  port.on("subscriptions.listen", (message, sender) =>
+  {
+    getListenerFilters(sender.page).subscription = message.filter;
+    addFilterListeners("subscription", message.filter);
+  });
+
+  port.on("subscriptions.remove", (message, sender) =>
+  {
+    let subscription = Subscription.fromURL(message.url);
+    if (subscription.url in FilterStorage.knownSubscriptions)
+      FilterStorage.removeSubscription(subscription);
+  });
+
+  port.on("subscriptions.toggle", (message, sender) =>
+  {
+    let subscription = Subscription.fromURL(message.url);
+    if (subscription.url in FilterStorage.knownSubscriptions)
+    {
+      if (subscription.disabled || message.keepInstalled)
+        subscription.disabled = !subscription.disabled;
+      else
+        FilterStorage.removeSubscription(subscription);
+    }
+    else
+    {
+      subscription.disabled = false;
+      subscription.title = message.title;
+      subscription.homepage = message.homepage;
+      FilterStorage.addSubscription(subscription);
+      if (!subscription.lastDownload)
+        Synchronizer.execute(subscription);
+    }
+  });
+
+  port.on("subscriptions.update", (message, sender) =>
+  {
+    let {subscriptions} = FilterStorage;
+    if (message.url)
+      subscriptions = [Subscription.fromURL(message.url)];
+
+    for (let subscription of subscriptions)
+    {
+      if (subscription instanceof DownloadableSubscription)
+        Synchronizer.execute(subscription, true);
     }
   });
 })(this);