Issue 2376 - Implement custom filters in new options page

messageResponder.js

Index: messageResponder.js
===================================================================
--- a/messageResponder.js
+++ b/messageResponder.js
@@ -30,6 +30,7 @@
   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;
@@ -55,6 +56,23 @@
     "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")
@@ -85,21 +103,8 @@
       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)
   {
@@ -178,7 +183,11 @@
         break;
       case "filters.add":
         var filter = Filter.fromText(message.text);
-        FilterStorage.addFilter(filter);
+        var result = filterValidation.parseFilter(message.text);
+        if (result.error && result.error.type != "empty-filter")

[Thomas Greiner, 2015/07/15 08:32:38]

Look at the else-case. This means that empty filters will be added. What you
want is this:

if (result.error)
{
  if (result.error.type != "empty-filter")
    sendMessage(...);
}
else
  FilterStorage.addFilter(result.filter);

[Sebastian Noack, 2015/07/15 09:00:45]

There is no error type "empty-filter". As I said, the result will be {filter:
null} in this case. So the logic here should look like:

  if (result.error)
    sendMessage("app", "error", [result.error.toString()], sender.page);
  else if (result.filter)
    FilterStorage.addFilter(result.filter);

[saroyanm, 2015/07/15 10:47:11]

I think it was misunderstanding, what I understood from your previouse message
that you would like to keep that entire logic in parseFilter, which is in
filterValidation module, so I've created a separate review where I've added new
"empty-filter" error to parseFilter function.
Should have aligned with you before implementing.
Done.

[Sebastian Noack, 2015/07/15 11:19:59]

What I meant is, that you should merely leave the check for empty filters to the
filterValidation module, which is already implemented there as
!Filter.normlize(text), and returns {filter: null} in that case.

+          sendMessage("app", "error", [result.error.toString()], sender.page);
+        else
+          FilterStorage.addFilter(result.filter);
         break;
       case "filters.blocked":
         var filter = defaultMatcher.matchesAny(message.url, message.requestType,
@@ -195,6 +204,48 @@
         
         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" &&
+              error.type != "empty-filter")
+            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;