Issue 4657 - Add Acceptable Ads API

include/AdblockPlus/FilterEngine.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 101 matching lines @@
      * subscription URL.
      */
     void UpdateFilters();
 
     /**
      * Checks if the subscription is currently being updated.
      * @return `true` if the subscription is currently being updated.
      */
     bool IsUpdating();
 
+    /**
+     * Indicates whether the subscription is acceptable ads subscription.
+     * @return `true` if this subscription is acceptable ads subscription.
+     */
+    bool IsAA();

[hub, 2017/03/17 20:04:15]

Shouldn't this be a const method?

[sergei, 2017/03/17 22:10:06]

I do agree that it should be const because for the user logically it does not
modify the state, although it's a bit tough decision, therefore I would like to
consider it separately and make this change in another commit as well as fix it
in other places. So far I would like to have it non-const "for consistency".

See, https://issues.adblockplus.org/ticket/5013.

[hub, 2017/04/05 13:35:02]

As it is right now, IsUpdating() above is const, so the consistency "const".

[sergei, 2017/04/05 14:43:29]

fixed.

+
     bool operator==(const Subscription& subscription) const;
 
     /**
      * Creates a wrapper for an existing JavaScript subscription object.
      * Normally you shouldn't call this directly, but use
      * FilterEngine::GetSubscription() instead.
      * @param value JavaScript subscription object.
      */
     Subscription(JsValue&& value);
   };
@@ skipping 168 matching lines @@
      */
     std::vector<SubscriptionPtr> GetListedSubscriptions() const;
 
     /**
      * Retrieves all recommended subscriptions.
      * @return List of recommended subscriptions.
      */
     std::vector<SubscriptionPtr> FetchAvailableSubscriptions() const;
 
     /**
+     * Ensures that Acceptable Ads subscription is enabled or disabled.
+     * @param enabled
+     *   - if the value is `true`
+     *     - ensure that the filter set includes an enabled AA subscription,
+     *       adding it if needed and enabling it if disabled.
+     *   - if the value is `false`
+     *     - if an AA subscription is present, disable it.
+     *     - if absent, do nothing.
+     */
+    void SetAAEnabled(bool enabled);
+
+    /**
+     * Checks whether Acceptable Ads subscription is enabled.
+     * @return `true` if acceptable ads subscription is present and enabled.
+     */
+    bool IsAAEnabled() const;
+
+    /**
+     * Retrieves the URL of Acceptable Ads subscription, what makes the URL
+     * available even if subscription is not add yet.
+     * @return Returns URL of Acceptable Ads.
+     */
+    std::string GetAAUrl() const;
+
+    /**
      * Invokes the listener set via SetNotificationAvailableCallback() with the
      * next notification to be shown.
      * @param url URL to match notifications to (optional).
      */
     void ShowNextNotification(const std::string& url = std::string());
 
     /**
      * Sets the callback invoked when a notification should be shown.
      * @param callback Callback to invoke.
      */
@@ skipping 191 matching lines @@
       const JsValueList& params);
     FilterPtr GetWhitelistingFilter(const std::string& url,
       ContentTypeMask contentTypeMask, const std::string& documentUrl) const;
     FilterPtr GetWhitelistingFilter(const std::string& url,
       ContentTypeMask contentTypeMask,
       const std::vector<std::string>& documentUrls) const;
   };
 }
 
 #endif