Issue 5010 - Allow to preload subscription files

libadblockplus-android/src/org/adblockplus/libadblockplus/android/AdblockEngine.java

 /*
  * 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
  * 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.libadblockplus.android;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.Set;
 
 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;
 import org.adblockplus.libadblockplus.ShowNotificationCallback;
 import org.adblockplus.libadblockplus.Subscription;
 import org.adblockplus.libadblockplus.UpdateAvailableCallback;
 import org.adblockplus.libadblockplus.UpdateCheckDoneCallback;
+import org.adblockplus.libadblockplus.WebRequest;
 
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager.NameNotFoundException;
 import android.os.Build.VERSION;
+import android.os.Handler;
+import android.os.Looper;
 import android.util.Log;
 
 public final class AdblockEngine
 {
+  // default base path to store subscription files in android app
+  public static final String BASE_PATH_DIRECTORY = "adblock";
+
   private static final String TAG = Utils.getTag(AdblockEngine.class);
 
   /*
    * The fields below are volatile because:
    *
    * I encountered JNI related bugs/crashes caused by JNI backed Java objects. It seemed that under
    * certain conditions the objects were optimized away which resulted in crashes when trying to
    * release the object, sometimes even on access.
    *
    * The only solution that really worked was to declare the variables holding the references
    * volatile, this seems to prevent the JNI from 'optimizing away' those objects (as a volatile
    * 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 WebRequest webRequest;
   private volatile UpdateAvailableCallback updateAvailableCallback;
   private volatile UpdateCheckDoneCallback updateCheckDoneCallback;
   private volatile FilterChangeCallback filterChangeCallback;
   private volatile ShowNotificationCallback showNotificationCallback;
-  private final boolean elemhideEnabled;
+  private volatile boolean elemhideEnabled;
   private volatile boolean enabled = true;
-  private List<String> whitelistedDomains;
-
-  private AdblockEngine(final boolean enableElemhide)
-  {
-    this.elemhideEnabled = enableElemhide;
-  }
+  private volatile List<String> whitelistedDomains;
 
   public static AppInfo generateAppInfo(final Context context, boolean developmentBuild)
   {
     String version = "0";
     try
     {
       final PackageInfo info = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
       version = info.versionName;
       if (developmentBuild)
         version += "." + info.versionCode;
     }
     catch (final NameNotFoundException e)
     {
       Log.e(TAG, "Failed to get the application version number", e);
     }
     final String sdkVersion = String.valueOf(VERSION.SDK_INT);
     final String locale = Locale.getDefault().toString().replace('_', '-');
 
     return AppInfo.builder()
         .setVersion(version)
         .setApplicationVersion(sdkVersion)
         .setLocale(locale)
         .setDevelopmentBuild(developmentBuild)
         .build();
   }
 
-  public static AdblockEngine create(final AppInfo appInfo,
-                                     final String basePath, boolean enableElemhide,
-                                     UpdateAvailableCallback updateAvailableCallback,
-                                     UpdateCheckDoneCallback updateCheckDoneCallback,
-                                     ShowNotificationCallback showNotificationCallback,
-                                     FilterChangeCallback filterChangeCallback)
+  /**
+   * Builds Adblock engine
+   */
+  public static class Builder
   {
-    Log.w(TAG, "Create");
+    private Context context;
+    private Map<String, Integer> URLtoResourceIdMap;
+    private AndroidWebRequestResourceWrapper.Storage resourceStorage;
+    private AndroidWebRequest androidWebRequest;
+    private AppInfo appInfo;
+    private String basePath;
 
-    final AdblockEngine engine = new AdblockEngine(enableElemhide);
+    private AdblockEngine engine;
 
-    engine.jsEngine = new JsEngine(appInfo);
-    engine.jsEngine.setDefaultFileSystem(basePath);
+    protected Builder(final AppInfo appInfo, final String basePath)
+    {
+      engine = new AdblockEngine();
+      engine.elemhideEnabled = true;
 
-    engine.logSystem = new AndroidLogSystem();
-    engine.jsEngine.setLogSystem(engine.logSystem);
-
-    engine.webRequest = new AndroidWebRequest(enableElemhide);
-    engine.jsEngine.setWebRequest(engine.webRequest);
-
-    engine.filterEngine = new FilterEngine(engine.jsEngine);
-
-    engine.updateAvailableCallback = updateAvailableCallback;
-    if (engine.updateAvailableCallback != null)
-    {
-      engine.filterEngine.setUpdateAvailableCallback(updateAvailableCallback);
+      // we can't create JsEngine and FilterEngine right now as it starts to download subscriptions
+      // and requests (AndroidWebRequest and probbaly wrappers) are not specified yet
+      this.appInfo = appInfo;
+      this.basePath = basePath;
     }
 
-    engine.updateCheckDoneCallback = updateCheckDoneCallback;
-
-    engine.showNotificationCallback = showNotificationCallback;
-    if (engine.showNotificationCallback != null)
+    public Builder enableElementHiding(boolean enable)
     {
-      engine.filterEngine.setShowNotificationCallback(showNotificationCallback);
+      engine.elemhideEnabled = enable;
+      return this;
     }
 
-    engine.filterChangeCallback = filterChangeCallback;
-    if (engine.filterChangeCallback != null)
+    public Builder preloadSubscriptions(Context context,
+                                        Map<String, Integer> URLtoResourceIdMap,
+                                        AndroidWebRequestResourceWrapper.Storage storage)
     {
-      engine.filterEngine.setFilterChangeCallback(filterChangeCallback);
+      this.context = context;
+      this.URLtoResourceIdMap = URLtoResourceIdMap;
+      this.resourceStorage = storage;
+      return this;
     }
 
-    engine.webRequest.updateSubscriptionURLs(engine.filterEngine);
+    public Builder setUpdateAvailableCallback(UpdateAvailableCallback callback)
+    {
+      engine.updateAvailableCallback = callback;
+      return this;
+    }
 
-    return engine;
+    public Builder setUpdateCheckDoneCallback(UpdateCheckDoneCallback callback)
+    {
+      engine.updateCheckDoneCallback = callback;
+      return this;
+    }
+
+    public Builder setShowNotificationCallback(ShowNotificationCallback callback)
+    {
+      engine.showNotificationCallback = callback;
+      return this;
+    }
+
+    public Builder setFilterChangeCallback(FilterChangeCallback callback)
+    {
+      engine.filterChangeCallback = callback;
+      return this;
+    }
+
+    private void initRequests()
+    {
+      androidWebRequest = new AndroidWebRequest(engine.elemhideEnabled);
+      engine.webRequest = androidWebRequest;
+
+      if (URLtoResourceIdMap != null)
+      {
+        AndroidWebRequestResourceWrapper wrapper = new AndroidWebRequestResourceWrapper(
+          context, engine.webRequest, URLtoResourceIdMap, resourceStorage);
+        wrapper.setListener(engine.resourceWrapperListener);
+
+        engine.webRequest = wrapper;
+      }
+    }
+
+    private void initCallbacks()
+    {
+      if (engine.updateAvailableCallback != null)
+      {
+        engine.filterEngine.setUpdateAvailableCallback(engine.updateAvailableCallback);
+      }
+
+      if (engine.showNotificationCallback != null)
+      {
+        engine.filterEngine.setShowNotificationCallback(engine.showNotificationCallback);
+      }
+
+      if (engine.filterChangeCallback != null)
+      {
+        engine.filterEngine.setFilterChangeCallback(engine.filterChangeCallback);
+      }
+    }
+
+    public AdblockEngine build()
+    {
+      initRequests();
+
+      // webRequest should be ready to be used passed right after JsEngine is created
+      createEngines();
+
+      initCallbacks();
+
+      androidWebRequest.updateSubscriptionURLs(engine.filterEngine);
+
+      return engine;
+    }
+
+    private void createEngines()
+    {
+      engine.jsEngine = new JsEngine(appInfo);
+      engine.jsEngine.setDefaultFileSystem(basePath);
+
+      engine.jsEngine.setWebRequest(engine.webRequest);
+
+      engine.logSystem = new AndroidLogSystem();
+      engine.jsEngine.setLogSystem(engine.logSystem);
+
+      engine.filterEngine = new FilterEngine(engine.jsEngine);
+    }
   }
 
-  public static AdblockEngine create(final AppInfo appInfo,
-                                     final String basePath, boolean elemhideEnabled)
+  public static Builder builder(AppInfo appInfo, String basePath)
   {
-    return create(appInfo, basePath, elemhideEnabled, null, null, null, null);
+    return new Builder(appInfo, basePath);
   }
 
+  private AndroidWebRequestResourceWrapper.Listener resourceWrapperListener =
+    new AndroidWebRequestResourceWrapper.Listener()

[diegocarloslima, 2017/03/30 09:42:07]

Since this member variable never changes, you should consider declaring it final

[anton, 2017/03/30 10:27:16]

Acknowledged.

+  {
+    private static final int UPDATE_DELAY_MS = 1 * 1000;
+
+    private Handler handler = new Handler(Looper.getMainLooper());

[diegocarloslima, 2017/03/30 09:42:07]

Since this member variable never changes, you should consider declaring it final

[anton, 2017/03/30 10:27:16]

Acknowledged.

+
+    private Runnable forceUpdateRunnable = new Runnable()

[diegocarloslima, 2017/03/30 09:42:07]

Since this member variable never changes, you should consider declaring it final

+    {
+      public void run() {
+        // Filter Engine can be already disposed
+        if (filterEngine != null)
+        {
+          Log.d(TAG, "Force update subscriptions");
+          filterEngine.forceUpdateCheck(updateCheckDoneCallback);
+        }
+      }
+    };
+
+    @Override
+    public void onIntercepted(String url, int resourceId)
+    {
+      // we need to force update subscriptions ASAP after preloaded one is returned
+      // but we should note that multiple interceptions (for main easylist and AA) and force update once only
+
+      // adding into main thread queue to avoid concurrency issues (start update while updating)
+      // as usually onIntercepted() is invoked in background thread
+      handler.removeCallbacks(forceUpdateRunnable);
+      handler.postDelayed(forceUpdateRunnable, UPDATE_DELAY_MS);
+
+      Log.d(TAG, "Scheduled force update in " + UPDATE_DELAY_MS);
+    }
+  };
+
   public void dispose()
   {
     Log.w(TAG, "Dispose");
 
     if (this.logSystem != null)
     {
       this.logSystem.dispose();
       this.logSystem = null;
     }
 
@@ skipping 298 matching lines @@
   public void setWhitelistedDomains(List<String> domains)
   {
     this.whitelistedDomains = domains;
   }
 
   public List<String> getWhitelistedDomains()
   {
     return whitelistedDomains;
   }
 }