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
@@ skipping 273 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)
   {
+    /*
+     * 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

[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;
   }
 }