Issue 2351 - Add a custom menu item for whitelisting the current site

mobile/android/thirdparty/org/adblockplus/browser/AddOnBridge.java

 /*
  * 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
  * 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/>.
  */
 
 package org.adblockplus.browser;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import android.annotation.SuppressLint;
 import android.os.Handler;
 import android.os.HandlerThread;
 import android.util.Log;
 
 import org.json.JSONException;
 import org.json.JSONObject;
 import org.mozilla.gecko.GeckoAppShell;
 import org.mozilla.gecko.util.GeckoRequest;
 import org.mozilla.gecko.util.NativeJSObject;
@@ skipping 97 matching lines @@
   public static void setBoolean(final AdblockPlusApiCallback callback, final String name,
       final boolean enable)
   {
     Log.d(TAG, "setBoolean " + enable + " for " + name);
     GeckoAppShell.sendRequestToGecko(
         new ChainedRequest(
             createRequestData("set" + makeFirstCharacterUppercase(name), enable),
             callback));
   }
 
-  private static void sendSubscriptionRequest(final AdblockPlusApiCallback callback,
-      final String action, final String url, final String title)
+  private static void callFunction(final AdblockPlusApiCallback callback, final String name,

[René Jeschke, 2015/05/06 10:56:33]

I must admit, that I would prefer 
'final JSONObject parameters'
instead of
'final Map<String, String> parameters' 
here, because:
1. We only create _one_ object instead of two
2. With your solution we can not use numbers, booleans, arrays, dictionaries,
... which feels like a very limited approach for a generic function

[Felix Dahlke, 2015/05/06 16:42:50]

As discussed on IRC: A Map is not great, but we'd have to duplicate the
exception handling around JSONObject.put. We'll go with a Map<String, Object>
for now to avoid stringly typing :P

+      final Map<String, String> parameters)
   {
-    final JSONObject obj = createRequestData(action);
+    final JSONObject requestData = createRequestData(name);
     try
     {
-      obj.put("url", url);
-      if (title != null)
-      {
-        obj.put("title", title);
-      }
+      for (Map.Entry<String, String> entry : parameters.entrySet())
+        requestData.put(entry.getKey(), entry.getValue());
     }
     catch (JSONException e)
     {
       // we're only adding sane objects
       Log.e(TAG, "Creating request data failed with: " + e.getMessage(), e);
     }
-    GeckoAppShell.sendRequestToGecko(new ChainedRequest(obj, callback));
+    GeckoAppShell.sendRequestToGecko(new ChainedRequest(requestData, callback));
   }
 
   public static void querySubscriptionListStatus(final AdblockPlusApiCallback callback,
       final String url)
   {
     Log.d(TAG, "querySubscriptionListStatus for " + url);
-    sendSubscriptionRequest(callback, "isSubscriptionListed", url, null);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    callFunction(callback, "isSubscriptionListed", parameters);
   }
 
   public static void addSubscription(final AdblockPlusApiCallback callback,
       final String url, final String title)
   {
     Log.d(TAG, "addSubscription for " + url + " (" + title + ")");
-    sendSubscriptionRequest(callback, "addSubscription", url, title);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    parameters.put("title", title);
+    callFunction(callback, "addSubscription", parameters);
   }
 
   public static void removeSubscription(final AdblockPlusApiCallback callback,
       final String url)
   {
     Log.d(TAG, "removeSubscription for " + url);
-    sendSubscriptionRequest(callback, "removeSubscription", url, null);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    callFunction(callback, "removeSubscription", parameters);
+  }
+
+  public static void queryIsLocal(final AdblockPlusApiCallback callback,
+      final String url)
+  {
+    Log.d(TAG, "queryIsLocal for " + url);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    callFunction(callback, "isLocal", parameters);
+  }
+
+  public static void queryIsPageWhitelisted(final AdblockPlusApiCallback callback,
+      final String url)
+  {
+    Log.d(TAG, "queryIsPageWhitelisted for " + url);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    callFunction(callback, "isPageWhitelisted", parameters);
+  }
+
+  public static void whitelistSite(final AdblockPlusApiCallback callback, final String url,
+      final boolean whitelisted)
+  {
+    Log.d(TAG, "whitelistSite for " + url);
+    final Map<String, String> parameters = new HashMap<String, String>();
+    parameters.put("url", url);
+    parameters.put("whitelisted", String.valueOf(whitelisted));

[René Jeschke, 2015/05/06 10:56:33]

See comment in Api.jsm and above ... having a JSONObject would allow us to use a
boolean directly here, without stringly typing.

+    callFunction(callback, "whitelistSite", parameters);
   }
 
   private static class ChainedRequest extends GeckoRequest
   {
     private final JSONObject value;
     private final AdblockPlusApiCallback apiCallback;
     private final boolean checkForFiltersLoaded;
     private final long creationTime;
 
     public ChainedRequest(final JSONObject value, final AdblockPlusApiCallback callback,
@@ skipping 106 matching lines @@
           this.invokeSuccessCallback(jsObject);
         }
         else
         {
           this.invokeFailureCallback(jsObject);
         }
       }
     }
   }
 }