Issue 2376 - Implement custom filters in new options page

messageResponder.js

 /*
  * 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 12 matching lines @@
   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 filterClasses = require("filterClasses");
   var Filter = filterClasses.Filter;
   var BlockingFilter = filterClasses.BlockingFilter;
   var Synchronizer = require("synchronizer").Synchronizer;
+  var filterValidation = require("filterValidation");
 
   var subscriptionClasses = require("subscriptionClasses");
   var Subscription = subscriptionClasses.Subscription;
   var DownloadableSubscription = subscriptionClasses.DownloadableSubscription;
   var SpecialSubscription = subscriptionClasses.SpecialSubscription;
 
   function convertObject(keys, obj)
   {
     var result = {};
     for (var i = 0; i < keys.length; i++)
       result[keys[i]] = obj[keys[i]];
     return result;
   }
 
   var convertSubscription = convertObject.bind(null, ["disabled",
     "downloadStatus", "homepage", "lastSuccess", "title", "url"]);
   var convertFilter = convertObject.bind(null, ["text"]);
 
   var changeListeners = null;
   var messageTypes = {
     "app": "app.listen",
     "filter": "filters.listen",
     "subscription": "subscriptions.listen"
   };
 
+  function sendMessage(type, action, args, page)
+  {
+    var pages = page ? [page] : changeListeners.keys();
+    for (var i = 0; i < pages.length; i++)
+    {
+      var filters = changeListeners.get(pages[i]);
+      if (filters[type] && filters[type].indexOf(action) >= 0)
+      {
+        pages[i].sendMessage({
+          type:  messageTypes[type],
+          action: action,
+          args: args
+        });
+      }
+    }
+  }
+
   function onFilterChange(action)
   {
     if (action == "load")
       action = "filter.loaded";
 
     var parts = action.split(".", 2);
     var type;
     if (parts.length == 1)
     {
       type = "app";
@@ skipping 10 matching lines @@
 
     var args = Array.prototype.slice.call(arguments, 1).map(function(arg)
     {
       if (arg instanceof Subscription)
         return convertSubscription(arg);
       else if (arg instanceof Filter)
         return convertFilter(arg);
       else
         return arg;
     });
-
-    var pages = changeListeners.keys();
-    for (var i = 0; i < pages.length; i++)
-    {
-      var filters = changeListeners.get(pages[i]);
-      if (filters[type] && filters[type].indexOf(action) >= 0)
-      {
-        pages[i].sendMessage({
-          type: messageTypes[type],
-          action: action,
-          args: args
-        });
-      }
-    }
-  };
+    sendMessage(type, action, args);
+  }
 
   global.ext.onMessage.addListener(function(message, sender, callback)
   {
     var listenerFilters = null;
     switch (message.type)
     {
       case "app.listen":
       case "filters.listen":
       case "subscriptions.listen":
         if (!changeListeners)
@@ skipping 58 matching lines @@
           listenerFilters.app = message.filter;
         else
           delete listenerFilters.app;
         break;
       case "app.open":
         if (message.what == "options")
           ext.showOptions();
         break;
       case "filters.add":
         var filter = Filter.fromText(message.text);
-        FilterStorage.addFilter(filter);
+        var result = filterValidation.parseFilter(message.text);
+        if (result.error)
+          sendMessage("app", "error", [result.error.toString()], sender.page);
+        else if (result.filter)
+          FilterStorage.addFilter(result.filter);
         break;
       case "filters.blocked":
         var filter = defaultMatcher.matchesAny(message.url, message.requestType,
           message.docDomain, message.thirdParty);
         callback(filter instanceof BlockingFilter);
         break;
       case "filters.get":
         var subscription = Subscription.fromURL(message.subscriptionUrl);
         if (!subscription)
         {
           callback([]);
           break;
         }
         
         callback(subscription.filters.map(convertFilter));
+        break;
+      case "filters.importRaw":
+        var result = 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());
+        }
+
+        if (errors.length > 0)
+        {
+          sendMessage("app", "error", errors, sender.page);
+          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;
+        }
+
+        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":
         if (message.filter)
           listenerFilters.filter = message.filter;
         else
           delete listenerFilters.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 "filters.importRaw":

[Thomas Greiner, 2015/06/30 09:23:27]

It's easier to search for the right method if the cases are ordered
alphabetically so could you please move them to the according position?

[saroyanm, 2015/07/08 18:25:39]

Done.

-        var parseFilters = require("filterValidation").parseFilters;
-        var result = parseFilters(message.text);
-
-        var errors = result.errors.filter(function(e)

[Thomas Greiner, 2015/06/30 09:23:27]

Please rename this variable from "e" to "error". Generally, I'd avoid shortening
variables wherever it makes sense to avoid confusion.

[saroyanm, 2015/07/08 18:25:39]

Done, Agree

-        {
-          return e.type != "unexpected-filter-list-header";

[Thomas Greiner, 2015/06/30 09:23:26]

I'm aware that you didn't write this but what's the reason for excluding this
kind of error?

[saroyanm, 2015/07/08 18:25:40]

It's being fired when the the filter starts with "[".
I can't see reason excluding this error. If it's invalid filter we should
somehow inform the user I guess. Should we remove the check ?

[Thomas Greiner, 2015/07/09 11:07:54]

Asked Sebastian about this and the line of reasoning is to not throw an error
when people copy&paste an entire filter list. Instead it silently strips the
filter list header.

So until we got a better solution for that let's keep it in there.

-        });
-
-        if (errors.length > 0)
-        {
-          alert(errors.join("\n"));
-          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;
-        }
-
-        var remove = [];
-        for (var i = 0; i < FilterStorage.subscriptions.length; i++)
-        {
-          var subscription = FilterStorage.subscriptions[i];
-          if (!(subscription instanceof SpecialSubscription))
-            continue;
-
-          for (var j = 0; j < subscription.filters.length; j++)
-          {
-            var filter = subscription.filters[j];
-            if (filter instanceof WhitelistFilter && /^@@\|\|([^\/:]+)\^\$document$/.test(filter.text))

[Thomas Greiner, 2015/06/30 09:23:27]

Beware of the 80 characters limit

[saroyanm, 2015/07/08 18:25:39]

Done.

-              continue;
-
-            if (!(filter.text in seenFilter))
-              FilterStorage.removeFilter(filter);
-          }
-        }
-        break;
-      case "parse.filter":

[Thomas Greiner, 2015/06/30 09:23:27]

This name is inconsistent with the other ones which follow the pattern
`<object>.<action>`. Therefore I'd suggest renaming it to "filters.parse".

[saroyanm, 2015/07/08 18:25:40]

Done.

-        var parseFilter = require("filterValidation").parseFilter;

[Thomas Greiner, 2015/06/30 09:23:26]

No need to require it each time it's called so please move this to the beginning
of the file where you already resolve all of the other dependencies.

Also found this in "filters.importRaw".

[saroyanm, 2015/07/08 18:25:40]

Agree, was stupid.

-        callback(parseFilter(message.text));

[Thomas Greiner, 2015/06/30 09:23:26]

"parseFilter" returns an instance of `Filter` (e.g. `WhitelistFilter`). However,
those object types don't exist in the context of the options page so you need to
convert it to a plain object before using `convertFilter`.
Same applies to `FilterParsingError` for which, however, there's no conversion
function yet.

var result = parseFilter(message.text);
callback({
  error: convertFilterParsingError(result.error),
  filter: convertFilter(result.filter)
});

[saroyanm, 2015/07/08 18:25:39]

Good point, done.

         break;
       case "prefs.get":
         callback(Prefs[message.key]);
         break;
       case "subscriptions.add":
         if (message.url in FilterStorage.knownSubscriptions)
           return;
 
         var subscription = Subscription.fromURL(message.url);
         if (!subscription)
@@ skipping 43 matching lines @@
           subscription.title = message.title;
           subscription.homepage = message.homepage;
           FilterStorage.addSubscription(subscription);
           if (!subscription.lastDownload)
             Synchronizer.execute(subscription);
         }
         break;
     }
   });
 })(this);