Issue 3364 - Implement JNI bindings for IsDocument/ElemhideWhitelisted

src/org/adblockplus/android/ABPEngine.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.android;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
 
 import org.adblockplus.libadblockplus.AppInfo;
 import org.adblockplus.libadblockplus.Filter;
 import org.adblockplus.libadblockplus.FilterChangeCallback;
 import org.adblockplus.libadblockplus.FilterEngine;
 import org.adblockplus.libadblockplus.FilterEngine.ContentType;
 import org.adblockplus.libadblockplus.JsEngine;
 import org.adblockplus.libadblockplus.LogSystem;
@@ skipping 26 matching lines @@
    * variable might be changed at any time from any thread).
    */
   private volatile JsEngine jsEngine;
   private volatile FilterEngine filterEngine;
   private volatile LogSystem logSystem;
   private volatile AndroidWebRequest webRequest;
   private volatile UpdateAvailableCallback updateAvailableCallback;
   private volatile UpdateCheckDoneCallback updateCheckDoneCallback;
   private volatile FilterChangeCallback filterChangeCallback;
   private volatile ShowNotificationCallback showNotificationCallback;
+  private final boolean elemhideEnabled;
 
-  private ABPEngine(final Context context)
+  private ABPEngine(final Context context, final boolean enableElemhide)
   {
     this.context = context;
+    this.elemhideEnabled = enableElemhide;
   }
 
   public static AppInfo generateAppInfo(final Context context)
   {
     final boolean developmentBuild = !context.getResources().getBoolean(R.bool.def_release);
     String version = "0";
     try
     {
       final PackageInfo info = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
       version = info.versionName;
@@ skipping 10 matching lines @@
     return AppInfo.builder()
         .setVersion(version)
         .setApplicationVersion(sdkVersion)
         .setLocale(locale)
         .setDevelopmentBuild(developmentBuild)
         .build();
   }
 
   public static ABPEngine create(final Context context, final AppInfo appInfo, final String basePath)
   {
-    final ABPEngine engine = new ABPEngine(context);
+    return create(context, appInfo, basePath, false);
+  }
+
+  public static ABPEngine create(final Context context, final AppInfo appInfo, final String basePath, boolean enableElemhide)
+  {
+    final ABPEngine engine = new ABPEngine(context, enableElemhide);
 
     engine.jsEngine = new JsEngine(appInfo);
     engine.jsEngine.setDefaultFileSystem(basePath);
 
     engine.logSystem = new AndroidLogSystem();
     engine.jsEngine.setLogSystem(engine.logSystem);
 
-    engine.webRequest = new AndroidWebRequest();
+    engine.webRequest = new AndroidWebRequest(enableElemhide);
     engine.jsEngine.setWebRequest(engine.webRequest);
 
     engine.filterEngine = new FilterEngine(engine.jsEngine);
 
     engine.webRequest.updateSubscriptionURLs(engine.filterEngine);
 
     engine.updateAvailableCallback = new AndroidUpdateAvailableCallback(context);
     engine.filterEngine.setUpdateAvailableCallback(engine.updateAvailableCallback);
     engine.filterChangeCallback = new AndroidFilterChangeCallback(context);
     engine.filterEngine.setFilterChangeCallback(engine.filterChangeCallback);
@@ skipping 56 matching lines @@
       this.showNotificationCallback.dispose();
       this.showNotificationCallback = null;
     }
   }
 
   public boolean isFirstRun()
   {
     return this.filterEngine.isFirstRun();
   }
 
+  public boolean isElemhideEnabled()
+  {
+    return this.elemhideEnabled;
+  }
+
   private static org.adblockplus.android.Subscription convertJsSubscription(final Subscription jsSubscription)
   {
     final org.adblockplus.android.Subscription subscription = new org.adblockplus.android.Subscription();
 
     subscription.title = jsSubscription.getProperty("title").toString();
     subscription.url = jsSubscription.getProperty("url").toString();
 
     return subscription;
   }
 
@@ skipping 76 matching lines @@
     // (to re-enable in-app ads blocking, proposed on 12.11.2012 Monday meeting)
     // (documentUrls contains the referrers on Android)
     if (referrerChainArray.length == 0 && (filter.getProperty("text").toString()).contains("||"))
     {
       return false;
     }
 
     return filter.getType() != Filter.Type.EXCEPTION;
   }
 
+  public boolean isDocumentWhitelisted(final String url, final String[] referrerChainArray)

[Felix Dahlke, 2015/12/04 15:43:20]

It's a bit unfortunate that this was called "referrerChainArray" above, because
it's actually the "documentUrls", same as in libadblockplus. The referrer chain
is one (crude!) way of determining the document URLs.

But let's keep it consistent with matches() above.

[René Jeschke, 2015/12/04 15:55:59]

Done.

Remark: "matches above" uses also "referrerChainArray" :D

[Felix Dahlke, 2015/12/04 16:37:36]

I don't get the impression you read the part where I wrote: "But let's keep it
consistent with matches() above." :D

[René Jeschke, 2015/12/04 16:54:47]

Frell ...



reverted :D

+  {
+    return this.filterEngine.isDocumentWhitelisted(url, referrerChainArray);
+  }
+
+  public boolean isElemhideWhitelisted(final String url, final String[] referrerChainArray)
+  {
+    return this.filterEngine.isElemhideWhitelisted(url, referrerChainArray);
+  }
+
+  public List<String> getElementHidingSelectors(final String url, final String[] referrerChainArray)
+  {
+    if (!this.elemhideEnabled

[Felix Dahlke, 2015/12/04 15:43:20]

This deserves a comment. Until now this was just a forwarding function, now it's
adding logic, logic that we would eventually like to see in
ElemHide.getSelectorsForDomain. We should create an issue for that and refer to
it here.

[René Jeschke, 2015/12/04 15:55:59]

Nope, we don't need an issue for that. 'elemhideEnabled' is purely and solely
Adblock Plus for Android specific. This flag is here to ensure that ABPdroid is
still working as before (filtering elemhide rules while downloading and
returning 'no' filters) and that ASUS is able to use element hiding without
adding code.

I will add a comment, if you still want this.

[Felix Dahlke, 2015/12/04 16:37:36]

Sorry, went for the wrong line here, I meant the isDocumentWhitelisted() ||
isElemhideWhitelisted() check below, this one makes sense of course.

[René Jeschke, 2015/12/04 16:54:47]

Added some comments here and there.

[Felix Dahlke, 2015/12/04 17:03:37]

Nice, but that's still not what I meant :D I meant the fact that we are checking
isDocumentWhitelisted and isElemhideWhitelisted here.

However, considering that this is really ABP for Android and not really the
libadblockplus bindings, I guess that's fine here.

+        || this.isDocumentWhitelisted(url, referrerChainArray)
+        || this.isElemhideWhitelisted(url, referrerChainArray))
+    {
+      return new ArrayList<String>();
+    }
+    return this.filterEngine.getElementHidingSelectors(url);
+  }
+
   public void checkForUpdates()
   {
     this.filterEngine.forceUpdateCheck(this.updateCheckDoneCallback);
   }
 
   public void updateSubscriptionStatus(final String url)
   {
     final Subscription sub = this.filterEngine.getSubscription(url);
     if (sub != null)
     {
       Utils.updateSubscriptionStatus(this.context, sub);
     }
   }
+
+  public FilterEngine getFilterEngine()
+  {
+    return this.filterEngine;
+  }
 }