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
@@ skipping 20 matching lines @@
 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 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 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 Map<String, Integer> urlToResourceIdMap;
   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 to store adlock settings
+   * @param preferenceName Shared Preferences name to store adblock settings
    */
   public AdblockHelper init(Context context, boolean developmentBuild, String preferenceName)
   {
     this.context = context.getApplicationContext();
     this.developmentBuild = developmentBuild;
     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.

+   * @param urlToResourceIdMap
+   */
+  public void preloadSubscriptions(String preferenceName, Map<String, Integer> urlToResourceIdMap)
   {
     this.preloadedPreferenceName = preferenceName;
-    this.URLtoResourceIdMap = URLtoResourceIdMap;
+    this.urlToResourceIdMap = urlToResourceIdMap;
   }
 
   private void createAdblock()
   {
     Log.d(TAG, "Creating adblock engine ...");
 
     // read and apply current settings
     SharedPreferences settingsPrefs = context.getSharedPreferences(
       settingsPreferenceName,
       Context.MODE_PRIVATE);
     storage = new SharedPrefsStorage(settingsPrefs);
 
-    File basePath = context.getDir(BASE_PATH_DIRECTORY, Context.MODE_PRIVATE);
+    File basePath = context.getDir(AdblockEngine.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,
+        urlToResourceIdMap,
         new AndroidWebRequestResourceWrapper.SharedPrefsStorage(preloadedSubscriptionsPrefs));
     }
 
     engine = builder.build();
 
     Log.d(TAG, "AdblockHelper engine created");
 
     AdblockSettings settings = storage.load();
     if (settings != null)
     {
@@ skipping 103 matching lines @@
         engineCreated.countDown();
         engineCreated = null;
       }
       else
       {
         disposeAdblock();
       }
     }
   }
 }