Issue 5081 - Make libadblockplus-android users supply the application and applicationVersion parame…

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.IsAllowedConnectionCallback;
-import org.adblockplus.libadblockplus.UpdateCheckDoneCallback;

[anton, 2017/03/31 13:34:21]

not related to the task directly

[diegocarloslima, 2017/03/31 14:07:14]

I would prefer this to be in a separate task, but since this is an urgent code
review, I wouldn't insist that much

 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;

[anton, 2017/03/31 13:34:21]

not related to the task directly - just cleanup

 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);
 
   /**
    * 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 String basePath;
   private boolean developmentBuild;
   private String settingsPreferenceName;
   private String preloadedPreferenceName;
   private Map<String, Integer> urlToResourceIdMap;
+  private String application;
+  private String applicationVersion;
   private AdblockEngine engine;
   private AdblockSettingsStorage storage;
   private CountDownLatch engineCreated;
 
   private IsAllowedConnectionCallback isAllowedConnectionCallback;
 
   /*
     Simple ARC management for AdblockEngine
     Use `retain` and `release`
    */
@@ skipping 49 matching lines @@
     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)
+  public AdblockHelper preloadSubscriptions(String preferenceName, Map<String, Integer> urlToResourceIdMap)
   {
     this.preloadedPreferenceName = preferenceName;
     this.urlToResourceIdMap = urlToResourceIdMap;
+    return this;
+  }
+
+  /**
+   * Use for requests to identify the client
+   * @param application application
+   */
+  public AdblockHelper setApplication(String application)
+  {
+    this.application = application;
+    return this;
+  }
+
+  /**
+   * Use for requests to identify the client
+   * @param applicationVersion application
+   */
+  public AdblockHelper setApplicationVersion(String applicationVersion)
+  {
+    this.applicationVersion = applicationVersion;
+    return this;

[diegocarloslima, 2017/03/31 14:07:14]

By the ticket description, it seems that application and applicationVersion
should be mandatory instead of optional. If so, this should be included in
init() method

[anton, 2017/03/31 14:16:08]

if they are required then i agree. it's not clear from the task

   }
 
   private void createAdblock()
   {
     this.isAllowedConnectionCallback = new IsAllowedConnectionCallbackImpl(context);
 
     Log.d(TAG, "Creating adblock engine ...");
 
     // read and apply current settings
     SharedPreferences settingsPrefs = context.getSharedPreferences(
       settingsPreferenceName,
       Context.MODE_PRIVATE);
     storage = new SharedPrefsStorage(settingsPrefs);
 
     AdblockEngine.Builder builder = AdblockEngine
       .builder(
-        AdblockEngine.generateAppInfo(context, developmentBuild),
+        AdblockEngine.generateAppInfo(context, developmentBuild, application, applicationVersion),
         basePath)
       .setIsAllowedConnectionCallback(isAllowedConnectionCallback)
       .enableElementHiding(true);
 
     // if preloaded subscriptions provided
     if (preloadedPreferenceName != null)
     {
       SharedPreferences preloadedSubscriptionsPrefs = context.getSharedPreferences(
         preloadedPreferenceName,
         Context.MODE_PRIVATE);
@@ skipping 128 matching lines @@
         engineCreated.countDown();
         engineCreated = null;
       }
       else
       {
         disposeAdblock();
       }
     }
   }
 }