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 10 matching lines @@
     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 filterClasses = require("filterClasses");
   var Filter = filterClasses.Filter;
-  var WhitelistFilter = filterClasses.WhitelistFilter
   var BlockingFilter = filterClasses.BlockingFilter;
   var Synchronizer = require("synchronizer").Synchronizer;
-  var parseFilters = require("filterValidation").parseFilters;
-  var parseFilter = require("filterValidation").parseFilter;
+  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 convertFilterParsingError = convertObject.bind(null, ["type",
-    "reason", "selector"]);
   var convertFilter = convertObject.bind(null, ["text"]);
 
   var changeListeners = null;
   var messageTypes = {
     "app": "app.listen",
     "filter": "filters.listen",
     "subscription": "subscriptions.listen"
   };
 
-  function sendMessage(page, type, action, args)
+  function sendMessage(type, action, args, page)
   {
-    page.sendMessage({
-      type: type,
-      action: action,
-      args: args
-    });
+    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)
@@ skipping 12 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)
-        sendMessage(pages[i], messageTypes[type], action, args);
-    }
-  };
-
-  function sendError(error, page)
-  {
-    var type = "app";
-    var action = "error";

[saroyanm, 2015/07/13 14:09:52]

@Thomas for Error handling, is it something that users should subscribe, or we
can go with current implementation ?

[Thomas Greiner, 2015/07/13 15:54:21]

The user is subscribing to it with the "app.listen" method and by specifying
"error" as a filter. The latter of which is currently missing so I added a
separate comment about adding that.

-    console.log(error);
-    error = convertFilterParsingError(error);
-    if (!page)
-    {
-      var pages = changeListeners.keys();
-      for (var i = 0; i < pages.length; i++)
-        sendMessage(pages[i], messageTypes[type], action, error);
-    }
-    else
-      sendMessage(page, messageTypes[type], action, [error]);
+    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":
@@ skipping 59 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 = parseFilters(message.text);
-        var errors = result.errors.filter(function(error)
-        {
-          return error.type != "unexpected-filter-list-header";
-        });
+        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)
         {
-          sendError(errors.join("\n"), sender.page);
+          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;
 
-          var filters = subscription.filters.slice();
-          for (var j = 0; j < filters.length; j++)
+          for (var j = subscription.filters.length - 1; j >= 0; j--)
           {
-            var filter = filters[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.parse":
-        var result = parseFilter(message.text);
-        if (result.error)
-          sendError(result.error, sender.page);
-        else
-          FilterStorage.addFilter(result.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
@@ skipping 54 matching lines @@
           subscription.title = message.title;
           subscription.homepage = message.homepage;
           FilterStorage.addSubscription(subscription);
           if (!subscription.lastDownload)
             Synchronizer.execute(subscription);
         }
         break;
     }
   });
 })(this);