Issue 4657 - Add Acceptable Ads API

lib/api.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2016 Eyeo GmbH
+ * Copyright (C) 2006-2017 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.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 var API = (function()
 {
   var Filter = require("filterClasses").Filter;
   var Subscription = require("subscriptionClasses").Subscription;
   var SpecialSubscription = require("subscriptionClasses").SpecialSubscription;
   var FilterStorage = require("filterStorage").FilterStorage;
   var defaultMatcher = require("matcher").defaultMatcher;
   var ElemHide = require("elemHide").ElemHide;
   var Synchronizer = require("synchronizer").Synchronizer;
   var Prefs = require("prefs").Prefs;
   var checkForUpdates = require("updater").checkForUpdates;
   var Notification = require("notification").Notification;
 
-  // returns first element of the array that satifies predicate.

[sergei, 2016/12/02 16:36:06]

Should I move it into utils.js or extend Array.prototype
(https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects...

[sergei, 2016/12/02 16:38:02]

I meant extend in compat.js.

The link is
https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects...

[Eric, 2016/12/05 14:40:58]

At the point of use, it would be better to use the syntax of whatever the
emerging standard is and avoid a custom function that does the same thing.

At the point of definition, use the standard function if already present and add
a shim if not.

[sergei, 2017/03/17 15:55:25]

Done.

-  var find = function (array, pred) {
-    for (var i = 0; i < array.length; ++i)
-      if (pred(array[i]))
-        return array[i];
-  };
-
   return {
     getFilterFromText: function(text)
     {
       text = Filter.normalize(text);
       if (!text)
         throw "Attempted to create a filter from empty text";
       return Filter.fromText(text);
     },
 
     isListedFilter: function(filter)
@@ skipping 94 matching lines @@
         result.push(subscription);
       }
       return result;
     },
 
     isAASubscription: function(subscription)
     {
       return subscription.url == Prefs.subscriptions_exceptionsurl;
     },
 
-    setAASubscriptionEnabled: function (enabled)

[Eric, 2016/12/05 14:40:58]

Nit: extra space after 'function'

[sergei, 2017/03/17 15:55:25]

Done.

-    {
-      var aaSubscription = find(FilterStorage.subscriptions, API.isAASubscription);

[Eric, 2016/12/05 14:40:58]

See comment on line 173

+    setAASubscriptionEnabled: function(enabled)
+    {
+      var aaSubscription = FilterStorage.subscriptions.find(API.isAASubscription);
       if (!enabled)
       {
         if (aaSubscription && !aaSubscription.disabled)
           aaSubscription.disabled = true;
         return;
       }
-      if (!aaSubscription) {
+      if (!aaSubscription)
+      {
         aaSubscription = Subscription.fromURL(Prefs.subscriptions_exceptionsurl);
         FilterStorage.addSubscription(aaSubscription);
       }
       if (aaSubscription.disabled)
         aaSubscription.disabled = false;
       if (!aaSubscription.lastDownload)
         Synchronizer.execute(aaSubscription);
     },
 
     isAASubscriptionEnabled: function()
     {
-      var aaSubscription = find(FilterStorage.subscriptions, API.isAASubscription);

[Eric, 2016/12/05 14:40:58]

Also see comment on line 154.

With the above line this is repeated code. Not sure it matters a lot, but these
"find" statements better belong as a method on "FilterStorage". Consider writing
this as an augment on that class that could migrate into adblockpluscore. I'm a
bit surprised something like this isn't already there.

[sergei, 2017/03/17 15:55:25]

I would like to avoid augmenting of FilterStorage because it looks like a hack.
I would like to rather have in the core some ????FilterStorage which extends
FilterStorage and has functionality related to Acceptable Ads.

+      var aaSubscription = FilterStorage.subscriptions.find(API.isAASubscription);
       return aaSubscription && !aaSubscription.disabled;
     },
 
     showNextNotification: function(url)
     {
       Notification.showNext(url);
     },
 
     getNotificationTexts: function(notification)
     {
@@ skipping 22 matching lines @@
       return Prefs[pref];
     },
 
     setPref: function(pref, value)
     {
       Prefs[pref] = value;
     },
 
     forceUpdateCheck: function(eventName)
     {
-      checkForUpdates(_triggerEvent.bind(null, eventName));
+      checkForUpdates(eventName ? _triggerEvent.bind(null, eventName) : null);
     },
 
     getHostFromUrl: function(url)
     {
       return extractHostFromURL(url);
     },
 
     compareVersions: function(v1, v2)
     {
       return Services.vc.compare(v1, v2);
     }
   };
 })();