Issue 5235 - Refactoring on SharedPrefs

adblockplussbrowser/src/org/adblockplus/sbrowser/contentblocker/engine/Engine.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 27 matching lines @@
 import java.util.Map;
 import java.util.Set;
 import java.util.TreeSet;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.locks.ReentrantLock;
 import java.util.regex.Pattern;
 
 import org.adblockplus.adblockplussbrowser.R;
 import org.adblockplus.sbrowser.contentblocker.MainPreferences;
+import org.adblockplus.sbrowser.contentblocker.util.SharedPrefsUtils;
 
 import android.content.Context;
 import android.content.Intent;
-import android.content.SharedPreferences;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.content.pm.ResolveInfo;
 import android.net.ConnectivityManager;
 import android.net.NetworkInfo;
 import android.net.Uri;
 import android.os.Handler;
 import android.os.Looper;
-import android.preference.PreferenceManager;
 import android.text.TextUtils;
 import android.util.Log;
 
 public final class Engine
 {
   private static final String TAG = Engine.class.getSimpleName();
 
   // TODO make use of this regex's
   public static final Pattern RE_SUBSCRIPTION_HEADER = Pattern.compile(
       "\\[Adblock(?:\\s*Plus\\s*([\\d\\.]+)?)?\\]", Pattern.CASE_INSENSITIVE);
@@ skipping 10 matching lines @@
   public static final String USER_FILTERS_TITLE = "__filters";
   public static final String USER_EXCEPTIONS_TITLE = "__exceptions";
 
   public static final String SBROWSER_APP_ID = "com.sec.android.app.sbrowser";
   public static final String ACTION_OPEN_SETTINGS = "com.samsung.android.sbrowser.contentBlocker.ACTION_SETTING";
   public static final String ACTION_UPDATE = "com.samsung.android.sbrowser.contentBlocker.ACTION_UPDATE";
   public static final String EASYLIST_URL = "https://easylist-downloads.adblockplus.org/easylist.txt";
 
   public static final String SUBSCRIPTIONS_EXCEPTIONSURL = "subscriptions_exceptionsurl";
 
-  private static final String PREFS_KEY_PREVIOUS_VERSION = "key_previous_version";
-
   // The value below specifies an interval of [x, 2*x[, where x =
   // INITIAL_UPDATE_CHECK_DELAY_SECONDS
   private static final long INITIAL_UPDATE_CHECK_DELAY_SECONDS = 5;
   private static final long UPDATE_CHECK_INTERVAL_MINUTES = 30;
   private static final long BROADCAST_COMBINATION_DELAY_MILLIS = 2500;
 
   public static final long MILLIS_PER_SECOND = 1000;
   public static final long MILLIS_PER_MINUTE = 60 * MILLIS_PER_SECOND;
   public static final long MILLIS_PER_HOUR = 60 * MILLIS_PER_MINUTE;
   public static final long MILLIS_PER_DAY = 24 * MILLIS_PER_HOUR;
@@ skipping 119 matching lines @@
   boolean canUseInternet()
   {
     final ConnectivityManager connManager = (ConnectivityManager) this.serviceContext
         .getSystemService(Context.CONNECTIVITY_SERVICE);
     final NetworkInfo current = connManager.getActiveNetworkInfo();
     if (current == null)
     {
       return false;
     }
 
-    final SharedPreferences prefs = PreferenceManager
-        .getDefaultSharedPreferences(this.serviceContext);
-    final boolean wifiOnly = prefs.getString(
-        this.serviceContext.getString(R.string.key_automatic_updates), "1").equals("1");
+    final boolean wifiOnly = "1".equals(SharedPrefsUtils.getString(

[anton, 2017/05/29 05:33:03]

why boolean variable is stored as string? wouldn't it be better to declare final
String wifiOnlyDefault="1"

[diegocarloslima, 2017/05/31 14:32:09]

This is because the preference value is stored by a ListPreference in
preferences_main.xml which entryValues are numeric. I think that it was
implemented this way so it would support adding a 3rd option in the future. But
even if we change this, it wouldn't be in the scope of this issue.

+        this.serviceContext, R.string.key_automatic_updates , "1"));
 
     if (wifiOnly)
     {
       if (current.isConnected() && !current.isRoaming())
       {
         switch (current.getType())
         {
           case ConnectivityManager.TYPE_BLUETOOTH:
           case ConnectivityManager.TYPE_ETHERNET:
           case ConnectivityManager.TYPE_WIFI:
@@ skipping 34 matching lines @@
 
   private void createAndWriteFile()
   {
     this.lock();
     try
     {
       Log.d(TAG, "Writing filters...");
       final File filterFile = this.subscriptions.createAndWriteFile();
       writeWhitelistedWebsites(this.serviceContext, filterFile);
 
-      final SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(this.serviceContext);
-      final String key = this.serviceContext.getString(R.string.key_cached_filter_path);
-      prefs.edit().putString(key, filterFile.getAbsolutePath()).commit();
+      SharedPrefsUtils.putString(
+          this.serviceContext, R.string.key_cached_filter_path, filterFile.getAbsolutePath());
 
       Log.d(TAG, "Cleaning up cache...");
       final File dummyFile = getDummyFilterFile(this.serviceContext);
       final File[] cacheDirFiles = getFilterCacheDir(this.serviceContext).listFiles();
       if (cacheDirFiles != null)
       {
         for (final File file : cacheDirFiles)
         {
           if (!file.equals(dummyFile) && !file.equals(filterFile))
           {
@@ skipping 41 matching lines @@
   {
     return this.wasFirstRun;
   }
 
   private void migrateFromPreviousVersion(final Context context)
   {
     try
     {
       final int versionCode = context.getPackageManager().getPackageInfo(context.getPackageName(),
           0).versionCode;
-      final SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
-      int previous = prefs.getInt(PREFS_KEY_PREVIOUS_VERSION, 0);
-      if (versionCode > previous)
+
+      final int previousVersionCode = SharedPrefsUtils.getInt(
+          context, R.string.key_previous_version_code, 0);
+
+      if (versionCode > previousVersionCode)
       {
-        if (previous > 0)
+        if (previousVersionCode > 0)
         {
           // We can do possible migration stuff here
           // Currently we only persist the new version code
         }
-        prefs.edit().putInt(PREFS_KEY_PREVIOUS_VERSION, versionCode).commit();
+        SharedPrefsUtils.putInt(context, R.string.key_previous_version_code, versionCode);
       }
     }
     catch (final Throwable t)
     {
       Log.e(TAG, "Failed on migration, please clear all application data", t);
     }
   }
 
   static Engine create(final Context context) throws IOException
   {
@@ skipping 134 matching lines @@
 
   public static void writeFilterHeaders(Writer writer) throws IOException
   {
     writer.write("[Adblock Plus 2.0]\n");
     writer.write("! This file was automatically created.\n");
   }
 
   private static void writeWhitelistedWebsites(Context context, File filterFile) throws IOException
   {
     Log.d(TAG, "Writing whitelisted websites...");
-    final SharedPreferences prefs =
-        PreferenceManager.getDefaultSharedPreferences(context.getApplicationContext());
-    final String key = context.getString(R.string.key_whitelisted_websites);
-
     final Set<String> whitelistedWebsites = new TreeSet<>();
-    whitelistedWebsites.addAll(prefs.getStringSet(key, Collections.<String>emptySet()));
+    whitelistedWebsites.addAll(SharedPrefsUtils.getStringSet(
+        context, R.string.key_whitelisted_websites, Collections.<String>emptySet()));
 
     try (final BufferedWriter w = new BufferedWriter( new OutputStreamWriter(
         new FileOutputStream(filterFile, true), StandardCharsets.UTF_8)))
     {
       for (final String url : whitelistedWebsites)
       {
         try
         {
           final URI uri = new URI(url);
           final String host = uri.getHost() != null ? uri.getHost() : uri.getPath();
           w.write("@@||" + host + "^$document");
           w.write('\n');
         }
         catch (URISyntaxException e)
         {
           Log.w(TAG, "Failed to parse whitelisted website: " + url);
           continue;
         }
       }
     }
   }
 
   private static File getCachedFilterFile(Context context)
   {
-    final SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
-    final String cachedFilterPath = prefs.getString(context.getString(R.string.key_cached_filter_path), null);
+    final String cachedFilterPath = SharedPrefsUtils.getString(
+        context, R.string.key_cached_filter_path, null);
+
     if (cachedFilterPath != null)
     {
       return new File(cachedFilterPath);
     }
 
     return null;
   }
 
   private static File getDummyFilterFile(Context context)
   {
@@ skipping 216 matching lines @@
       Log.d(TAG, headers.toString());
       this.downloader.enqueueDownload(this.createDownloadURL(sub), sub.getId(), headers);
     }
   }
 
   public void connectivityChanged()
   {
     this.downloader.connectivityChanged();
   }
 }