Issue 1528 - Implemented backend for general tab of new options page

background.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 13 matching lines @@
       var params = window.location.search.substr(1).split("&");
       for (var i = 0; i < params.length; i++)
       {
         var parts = params[i].split("=", 2);
         if (parts.length == 2 && parts[0] in data)
           data[parts[0]] = decodeURIComponent(parts[1]);
       }
     }
   }
 
-  var subscriptions =[
-    "https://easylist-downloads.adblockplus.org/easylistgermany+easylist.txt",
-    "https://easylist-downloads.adblockplus.org/exceptionrules.txt",
-    "https://easylist-downloads.adblockplus.org/fanboy-social.txt",
-    "~user~786254"
-  ];
-  var filters = [
-    "@@||alternate.de^$document",
-    "@@||der.postillion.com^$document", 
-    "@@||taz.de^$document",
-    "@@||amazon.de^$document"
-  ];
-
   var modules = {};
   global.require = function(module)
   {
     return modules[module];
   };
 
   modules.utils = {
     Utils: {
       getDocLink: function(link)
       {
@@ skipping 10 matching lines @@
 
   modules.subscriptionClasses = {
     Subscription: function(url)
     {
       this.url = url;
       this.title = "Subscription " + url;
       this.disabled = false;
       this.lastDownload = 1234;
     },
 
-    SpecialSubscription: function(url) {

[Felix Dahlke, 2015/05/28 20:35:41]

Nit: Opening brace on the next line?

[Thomas Greiner, 2015/06/08 16:12:43]

Done.

+    SpecialSubscription: function(url)
+    {
       this.url = url;
       this.disabled = false;
-      this.filters = filters.map(modules.filterClasses.Filter.fromText);
+      this.filters = knownFilters.slice();
     }
   };
   modules.subscriptionClasses.Subscription.fromURL = function(url)
   {
     if (/^https?:\/\//.test(url))
       return new modules.subscriptionClasses.Subscription(url);
     else
       return new modules.subscriptionClasses.SpecialSubscription(url);
   };
   modules.subscriptionClasses.DownloadableSubscription = modules.subscriptionClasses.Subscription;
 
   modules.filterStorage = {
     FilterStorage: {
       get subscriptions()
       {
         var subscriptions = [];
         for (var url in modules.filterStorage.FilterStorage.knownSubscriptions)
           subscriptions.push(modules.filterStorage.FilterStorage.knownSubscriptions[url]);
         return subscriptions;
       },
 
       get knownSubscriptions()
       {
-        subscriptions = subscriptions.reduce(function(obj, subscription)

[Felix Dahlke, 2015/05/28 20:35:41]

Can we do something less complex here? Took a while for me to understand the
code because of this. How about properly initialising subscriptions to begin
with rather than changing it like this on first use?

[Thomas Greiner, 2015/06/08 16:12:43]

Done.

-        {
-          obj[subscription] = modules.subscriptionClasses.Subscription.fromURL(subscription);
-          return obj;
-        }, Object.create(null));
-        
-        Object.defineProperty(modules.filterStorage.FilterStorage, "knownSubscriptions", {

[Felix Dahlke, 2015/05/28 20:35:41]

Nit: Opening brace on the next line?

[Thomas Greiner, 2015/06/08 16:12:43]

Done.

-          get: function()
+        return knownSubscriptions;
+      },
+
+      addSubscription: function(subscription)
+      {
+        if (!(subscription.url in modules.filterStorage.FilterStorage.knownSubscriptions))
+        {
+          knownSubscriptions[subscription.url] = modules.subscriptionClasses.Subscription.fromURL(subscription.url);
+          modules.filterNotifier.FilterNotifier.triggerListeners("subscription.added", subscription);
+        }
+      },
+
+      removeSubscription: function(subscription)
+      {
+        if (subscription.url in modules.filterStorage.FilterStorage.knownSubscriptions)
+        {
+          delete knownSubscriptions[subscription.url];
+          modules.filterNotifier.FilterNotifier.triggerListeners("subscription.removed", subscription);
+        }
+      },
+
+      addFilter: function(filter)
+      {
+        for (var i = 0; i < customSubscription.filters.length; i++)
+        {
+          if (customSubscription.filters[i].text == filter.text)
+            return;
+        }
+        customSubscription.filters.push(filter);
+        modules.filterNotifier.FilterNotifier.triggerListeners("filter.added", filter);
+      },
+
+      removeFilter: function(filter)
+      {
+        for (var i = 0; i < customSubscription.filters.length; i++)
+        {
+          if (customSubscription.filters[i].text == filter.text)
           {
-            return subscriptions;
-          }
-        });
-        
-        return modules.filterStorage.FilterStorage.knownSubscriptions;
-      },
-
-      addSubscription: function(subscription)
-      {
-        if (!(subscription.url in modules.filterStorage.FilterStorage.knownSubscriptions))
-        {
-          subscriptions[subscription.url] = modules.subscriptionClasses.Subscription.fromURL(subscription.url);
-          modules.filterNotifier.FilterNotifier.triggerListeners("subscription.added", subscription);
-        }
-      },
-
-      removeSubscription: function(subscription)
-      {
-        if (subscription.url in modules.filterStorage.FilterStorage.knownSubscriptions)
-        {
-          delete subscriptions[subscription.url];
-          modules.filterNotifier.FilterNotifier.triggerListeners("subscription.removed", subscription);
-        }
-      },
-
-      addFilter: function(filter)
-      {
-        var subscription = modules.filterStorage.FilterStorage.knownSubscriptions["~user~786254"];

[Felix Dahlke, 2015/05/28 20:35:41]

Seeing this used a few times - how about a "constant"?

[Thomas Greiner, 2015/06/08 16:12:43]

Done.

-        for (var i = 0; i < subscription.filters.length; i++)
-        {
-          if (subscription.filters[i].text == filter.text)
-            return;
-        }
-        subscription.filters.push(filter);
-        modules.filterNotifier.FilterNotifier.triggerListeners("filter.added", filter);
-      },
-
-      removeFilter: function(filter)
-      {
-        var subscription = modules.filterStorage.FilterStorage.knownSubscriptions["~user~786254"];
-        for (var i = 0; i < subscription.filters.length; i++)
-        {
-          if (subscription.filters[i].text == filter.text)
-          {
-            subscription.filters.splice(i, 1);
+            customSubscription.filters.splice(i, 1);
             modules.filterNotifier.FilterNotifier.triggerListeners("filter.removed", filter);
             return;
           }
         }
       }
     }
   };
 
   modules.filterClasses = {
     BlockingFilter: function() {},
@@ skipping 51 matching lines @@
           listeners[i].apply(null, args);
       }
     }
   };
 
   modules.info = {
     platform: "gecko",
     platformVersion: "34.0",
     application: "firefox",
     applicationVersion: "34.0",
-    addon: "adblockplus",

[Felix Dahlke, 2015/05/28 20:35:41]

Shouldn't this be `addonName`?

[Thomas Greiner, 2015/06/08 16:12:43]

Done. Thanks for pointing out this inconsistency.

Note that currently only `addonVersion` is used but I still added it for
completeness' sake. So we could even get rid of it if you prefer that.

+    addonName: "adblockplus",
     addonVersion: "2.6.7"
   };
   updateFromURL(modules.info);
 
   global.Services = {
     vc: {
       compare: function(v1, v2)
       {
         return parseFloat(v1) - parseFloat(v2);
       }
     }
   };
+
+  var filters = [
+    "@@||alternate.de^$document",
+    "@@||der.postillion.com^$document", 
+    "@@||taz.de^$document",
+    "@@||amazon.de^$document"
+  ];
+  var knownFilters = filters.map(modules.filterClasses.Filter.fromText);
+
+  var subscriptions = [
+    "https://easylist-downloads.adblockplus.org/easylistgermany+easylist.txt",
+    "https://easylist-downloads.adblockplus.org/exceptionrules.txt",
+    "https://easylist-downloads.adblockplus.org/fanboy-social.txt",
+    "~user~786254"
+  ];
+  var knownSubscriptions = Object.create(null);
+  for (var subscriptionUrl of subscriptions)
+    knownSubscriptions[subscriptionUrl] = modules.subscriptionClasses.Subscription.fromURL(subscriptionUrl);

[Thomas Greiner, 2015/06/08 16:12:43]

FYI: This is basically the same what I did with `Array.reduce()` before.

+  var customSubscription = knownSubscriptions["~user~786254"];
 
   var issues = {seenDataCorruption: false, filterlistsReinitialized: false};
   updateFromURL(issues);
   global.seenDataCorruption = issues.seenDataCorruption;
   global.filterlistsReinitialized = issues.filterlistsReinitialized;
   
   var events = {addSubscription: false};
   updateFromURL(events);
   if (events.addSubscription)
   {
     // We don't know how long it will take for the page to fully load
     // so we'll post the message after one second
     setTimeout(function()
     {
       window.postMessage({
         type: "message",
         payload: {
           title: "Custom subscription",
           url: "http://example.com/custom.txt",
           type: "add-subscription"
         }
       }, "*");
     }, 1000);
   }
 })(this);