Issue 5316 - Adds dynamic filter types to devtools panel

messageResponder.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2017 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.
  *
@@ skipping 15 matching lines @@
   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 resource types are not available on Chrome

[Jon Sonesen, 2017/08/21 15:31:07]

This comment probably needs to be improved

[Thomas Greiner, 2017/08/22 11:21:47]

Indeed… what are you trying to express here?

[Jon Sonesen, 2017/08/24 11:29:06]

Yeah I dunno, I thought it would make sense to explain the logic for exposing
the requestBlocker.filterTypes to the devtools panel...but maybe it is not
needed?

[Thomas Greiner, 2017/08/25 17:11:35]

Agreed, I don't think it adds value to add a comment here.

-  port.on("request.getTypes", (message, sender) =>
-    Array.from(require("requestBlocker").filterTypes));

[Thomas Greiner, 2017/08/22 11:21:47]

Why did you decide to make `filterTypes` a `Set` if you're converting it into an
array in the only place you're using it?

[Sebastian Noack, 2017/08/22 11:38:28]

The way filter types are accumulated in adblockpluschrome there will naturally
be duplicates. By using a Set these duplicates are automatically eliminated. Of
course, we could do the conversion to an array already inside adblockpluschrome.
But since allowing duplicates don't make any sense here anyway, a Set seems to
be an appropriate data structure to expose.

[Thomas Greiner, 2017/08/25 17:11:35]

Ok, not great either way then, I guess. Thanks for explaining the reasoning.

+  const {
+    Subscription,
+    DownloadableSubscription,
+    SpecialSubscription
+  } = require("subscriptionClasses");
+
+  port.on("types.get", (message, sender) =>
+  {
+    let filterTypes = Array.from(require("requestBlocker").filterTypes);
+    filterTypes.push(...filterTypes.splice(filterTypes.indexOf("OTHER"), 1));
+    return filterTypes;
+  });
 
   // 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);
@@ skipping 115 matching lines @@
 
     if (message.what == "localeInfo")
     {
       let bidiDir;
       if ("chromeRegistry" in Utils)
       {
         let isRtl = Utils.chromeRegistry.isLocaleRTL("adblockplus");
         bidiDir = isRtl ? "rtl" : "ltr";
       }
       else
-        bidiDir = ext.i18n.getMessage("@@bidi_dir");
+        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();
+    {
+      ext.showOptions(() =>
+      {
+        if (!message.action)
+          return;
+
+        sendMessage("app", message.action, ...message.args);
+      });
+    }
   });
 
   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);
@@ skipping 10 matching lines @@
     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 isWhitelisted = checkWhitelisted(sender.page, sender.frame,
+        RegExpFilter.typeMap.DOCUMENT | RegExpFilter.typeMap.ELEMHIDE);
+      if (Prefs.enabled && !isWhitelisted)
       {
         let {hostname} = sender.frame.url;
         filters = ElemHideEmulation.getRulesForDomain(hostname);
         filters = filters.map((filter) =>
         {
           return {
             selector: filter.selector,
             text: filter.text
           };
         });
@@ skipping 179 matching lines @@
     let {subscriptions} = FilterStorage;
     if (message.url)
       subscriptions = [Subscription.fromURL(message.url)];
 
     for (let subscription of subscriptions)
     {
       if (subscription instanceof DownloadableSubscription)
         Synchronizer.execute(subscription, true);
     }
   });
-
-  port.on("request.getTypes", (message, sender) =>
-    Array.from(require("requestBlocker").filterTypes));

[Thomas Greiner, 2017/08/22 11:21:47]

This is exactly the same code as the one above so let's remove it.

[Jon Sonesen, 2017/08/24 11:29:06]

Acknowledged.

 })(this);