Issue 5010 - Allow to preload subscription files

libadblockplus-android-settings/src/org/adblockplus/libadblockplus/android/settings/AdblockHelper.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.settings;
 
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.util.Log;
 
 import org.adblockplus.libadblockplus.android.AdblockEngine;
+import org.adblockplus.libadblockplus.android.AndroidWebRequestResourceWrapper;
 import org.adblockplus.libadblockplus.android.Utils;
 
+import java.io.File;
+import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * AdblockHelper shared resources
  * (singleton)
  */
 public class AdblockHelper
 {
   private static final String TAG = Utils.getTag(AdblockHelper.class);
 
+  // basePath to store subscription files
+  public static final String BASE_PATH_DIRECTORY = "adblock";

[diegocarloslima, 2017/03/28 13:47:15]

I would suggest to move this constant to AdblockEngine. That way, its easier to
keep consistency between the classes that uses this path (for instance,
AdblockHelper and AdblockWebView)

[anton, 2017/03/28 13:59:06]

Acknowledged.

+
   /**
-   * Suggested preference name
+   * Suggested preference name to store settings
    */
   public static final String PREFERENCE_NAME = "ADBLOCK";
+
+  /**
+   * Suggested preference name to store intercepted subscription requests
+   */
+  public static final String PRELOAD_PREFERENCE_NAME = "ADBLOCK_PRELOAD";
   private static AdblockHelper _instance;
 
   private Context context;
   private boolean developmentBuild;
-  private String preferenceName;
+  private String settingsPreferenceName;
+  private String preloadedPreferenceName;
+  private Map<String, Integer> URLtoResourceIdMap;

[diegocarloslima, 2017/03/28 13:47:15]

'toResource' should be 'ToResource'. Also, it's recommended by Android
guidelines to treat abbreviations/acronyms as words: So here it should be 'url'
instead of 'URL'. See
https://source.android.com/source/code-style.html#treat-acronyms-as-words

[anton, 2017/03/28 13:59:06]

Acknowledged.

   private AdblockEngine engine;
   private AdblockSettingsStorage storage;
   private CountDownLatch engineCreated;
 
   /*
     Simple ARC management for AdblockEngine
     Use `retain` and `release`
    */
 
   private AtomicInteger referenceCounter = new AtomicInteger(0);
@@ skipping 25 matching lines @@
 
   public AdblockSettingsStorage getStorage()
   {
     return storage;
   }
 
   /**
    * Init with context
    * @param context application context
    * @param developmentBuild debug or release?
-   * @param preferenceName Shared Preferences name
+   * @param preferenceName Shared Preferences name to store adlock settings
    */
-  public void init(Context context, boolean developmentBuild, String preferenceName)
+  public AdblockHelper init(Context context, boolean developmentBuild, String preferenceName)
   {
     this.context = context.getApplicationContext();
     this.developmentBuild = developmentBuild;
-    this.preferenceName = preferenceName;
+    this.settingsPreferenceName = preferenceName;
+    return this;
+  }
+
+  /**
+   * Use preloaded subscriptions
+   * @param preferenceName Shared Preferences name to store intercepted requests stats
+   * @param URLtoResourceIdMap
+   */
+  public void preloadSubscriptions(String preferenceName, Map<String, Integer> URLtoResourceIdMap)

[diegocarloslima, 2017/03/28 13:47:15]

same suggestion here, change 'URLtoResourceIdMap' to 'urlToResourceIdMap'

[anton, 2017/03/28 13:59:06]

Acknowledged.

+  {
+    this.preloadedPreferenceName = preferenceName;
+    this.URLtoResourceIdMap = URLtoResourceIdMap;
   }
 
   private void createAdblock()
   {
     Log.d(TAG, "Creating adblock engine ...");
 
     // read and apply current settings
-    SharedPreferences prefs = context.getSharedPreferences(preferenceName, Context.MODE_PRIVATE);
-    storage = new SharedPrefsStorage(prefs);
+    SharedPreferences settingsPrefs = context.getSharedPreferences(
+      settingsPreferenceName,
+      Context.MODE_PRIVATE);
+    storage = new SharedPrefsStorage(settingsPrefs);
 
-    engine = AdblockEngine.create(
-      AdblockEngine.generateAppInfo(context, developmentBuild),
-      context.getCacheDir().getAbsolutePath(),
-      true); // `true` as we need element hiding
+    File basePath = context.getDir(BASE_PATH_DIRECTORY, Context.MODE_PRIVATE);
+    AdblockEngine.Builder builder = AdblockEngine
+      .builder(
+        AdblockEngine.generateAppInfo(context, developmentBuild),
+        basePath.getAbsolutePath())
+      .enableElementHiding(true);
+
+    // if preloaded subscriptions provided
+    if (preloadedPreferenceName != null)
+    {
+      SharedPreferences preloadedSubscriptionsPrefs = context.getSharedPreferences(
+        preloadedPreferenceName,
+        Context.MODE_PRIVATE);
+      builder.preloadSubscriptions(
+        context,
+        URLtoResourceIdMap,
+        new AndroidWebRequestResourceWrapper.SharedPrefsStorage(preloadedSubscriptionsPrefs));
+    }
+
+    engine = builder.build();
+
     Log.d(TAG, "AdblockHelper engine created");
 
     AdblockSettings settings = storage.load();
     if (settings != null)
     {
       Log.d(TAG, "Applying saved adblock settings to adblock engine");
       // apply last saved settings to adblock engine
 
       // all the settings except `enabled` and whitelisted domains are saved by adblock engine itself
       engine.setEnabled(settings.isAdblockEnabled());
@@ skipping 98 matching lines @@
         engineCreated.countDown();
         engineCreated = null;
       }
       else
       {
         disposeAdblock();
       }
     }
   }
 }