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)
+  {
+    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)
+  {
+    /*
+     * Issue 3364 (https://issues.adblockplus.org/ticket/3364) introduced the
+     * feature to re-enabled element hiding.
+     *
+     * Nothing changes for Adblock Plus for Android, as `this.elemhideEnabled`
+     * is `false`, which results in an empty list being returned and converted
+     * into a `(String[])null` in AdblockPlus.java, which is the only place
+     * this function here is called from Adblock Plus for Android.
+     *
+     * If element hiding is enabled, then this function now first checks for
+     * possible whitelisting of either the document or element hiding for
+     * the given URL and returns an empty list if so. This is needed to
+     * ensure correct functioning of e.g. acceptable ads.
+     */
+    if (!this.elemhideEnabled
+        || 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;
+  }
 }