Exclude cache_prefs from backup

Author: Pygmalion69

app/src/main/AndroidManifest.xml

@@ -9,6 +9,8 @@
 
     <application
         android:allowBackup="true"
+        android:fullBackupContent="@xml/backup_rules"
+        android:dataExtractionRules="@xml/data_extraction_rules"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"

app/src/main/java/org/nitri/opentopo/CacheSettingsFragment.kt

@@ -16,8 +16,10 @@ import androidx.appcompat.widget.SwitchCompat
 import androidx.fragment.app.DialogFragment
 import androidx.localbroadcastmanager.content.LocalBroadcastManager
 import androidx.preference.PreferenceManager
+import android.content.SharedPreferences
 import org.osmdroid.config.Configuration
 import java.io.File
+import androidx.core.content.edit
 
 
 class CacheSettingsFragment : DialogFragment() {
@@ -30,18 +32,21 @@ class CacheSettingsFragment : DialogFragment() {
         val inflater = requireActivity().layoutInflater
         @SuppressLint("InflateParams") val view =
             inflater.inflate(R.layout.fragment_cache_settings, null)
-        val prefs = PreferenceManager.getDefaultSharedPreferences(requireActivity().applicationContext)
+        val defaultPrefs = PreferenceManager.getDefaultSharedPreferences(requireActivity().applicationContext)
+        val cachePrefs: SharedPreferences = requireActivity().getSharedPreferences("cache_prefs", Context.MODE_PRIVATE)
         val tvExternalStorageRoot = view.findViewById<TextView>(R.id.tvExternalStorageRoot)
         val swExternalStorage = view.findViewById<SwitchCompat>(R.id.swExternalStorage)
         etTileCache = view.findViewById(R.id.etTileCache)
         etCacheSize = view.findViewById(R.id.etCacheSize)
         val basePath = Configuration.getInstance().osmdroidBasePath
         val storageRoot = basePath?.absolutePath ?: getString(R.string.unknown_symbol)
         tvExternalStorageRoot.text = getString(R.string.storage_root, storageRoot)
-        val currentExternalStorage = prefs.getBoolean(PREF_EXTERNAL_STORAGE, false)
+        val currentExternalStorage = cachePrefs.getBoolean(PREF_EXTERNAL_STORAGE,
+            defaultPrefs.getBoolean(PREF_EXTERNAL_STORAGE, false)
+        )
         swExternalStorage.isChecked = currentExternalStorage
-        val currentTileCache = prefs.getString(PREF_TILE_CACHE, DEFAULT_TILE_CACHE)
-        val currentCacheSize = prefs.getInt(PREF_CACHE_SIZE, DEFAULT_CACHE_SIZE)
+        val currentTileCache = defaultPrefs.getString(PREF_TILE_CACHE, DEFAULT_TILE_CACHE)
+        val currentCacheSize = defaultPrefs.getInt(PREF_CACHE_SIZE, DEFAULT_CACHE_SIZE)
         etTileCache.setText(currentTileCache)
         etCacheSize.setText(currentCacheSize.toString())
         builder.setView(view)
@@ -56,13 +61,12 @@ class CacheSettingsFragment : DialogFragment() {
                 }
 
                 if (newCacheSize > 0) {
-                    val editor = prefs.edit()
-                    editor.apply {
-                        putBoolean(PREF_EXTERNAL_STORAGE, newExternalStorage)
+                    defaultPrefs.edit().apply {
                         putString(PREF_TILE_CACHE, newTileCache)
                         putInt(PREF_CACHE_SIZE, newCacheSize)
                         apply()
                     }
+                    cachePrefs.edit { putBoolean(PREF_EXTERNAL_STORAGE, newExternalStorage) }
                     val cacheDir = File("$storageRoot/$newTileCache")
                     if (cacheDir.mkdirs()) {
                         Log.i(TAG, "Tile cache created: $newTileCache")
@@ -71,7 +75,7 @@ class CacheSettingsFragment : DialogFragment() {
                     configuration.osmdroidTileCache = cacheDir
                     configuration.tileFileSystemCacheMaxBytes =
                         newCacheSize.toLong() * 1024 * 1024
-                    configuration.save(requireActivity().applicationContext, prefs)
+                    configuration.save(requireActivity().applicationContext, defaultPrefs)
                     val intent = Intent(ACTION_CACHE_CHANGED);
                     val localBroadcastManager = LocalBroadcastManager.getInstance(
                         requireActivity()
@@ -94,7 +98,6 @@ class CacheSettingsFragment : DialogFragment() {
         return dialog
     }
 
-
     override fun onResume() {
         super.onResume()
         val dialog = dialog as AlertDialog?

app/src/main/java/org/nitri/opentopo/MapFragment.kt

@@ -160,7 +160,13 @@ class MapFragment : Fragment(), LocationListener, PopupMenu.OnMenuItemClickListe
         sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)
         val configuration = Configuration.getInstance()
         configuration.userAgentValue = BuildConfig.APPLICATION_ID
-        val basePath = Utils.getOsmdroidBasePath(context, sharedPreferences.getBoolean(CacheSettingsFragment.PREF_EXTERNAL_STORAGE, false))
+        val externalPrefs = requireActivity().getSharedPreferences("cache_prefs", Context.MODE_PRIVATE)
+                val externalStorage = if (externalPrefs.contains(CacheSettingsFragment.PREF_EXTERNAL_STORAGE)) {
+                    externalPrefs.getBoolean(CacheSettingsFragment.PREF_EXTERNAL_STORAGE, false)
+                } else {
+                    sharedPreferences.getBoolean(CacheSettingsFragment.PREF_EXTERNAL_STORAGE, false)
+                }
+                val basePath = Utils.getOsmdroidBasePath(context, externalStorage)
         configuration.osmdroidBasePath = basePath
         val tileCache = File(configuration.osmdroidBasePath.absolutePath,
             sharedPreferences.getString(CacheSettingsFragment.PREF_TILE_CACHE, CacheSettingsFragment.DEFAULT_TILE_CACHE)

app/src/main/res/xml/backup_rules.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<full-backup-content>
+    <!-- Exclude the dedicated SharedPreferences file that holds the external storage toggle -->
+    <exclude domain="sharedpref" path="cache_prefs.xml" />
+</full-backup-content>

app/src/main/res/xml/data_extraction_rules.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<data-extraction-rules>
+    <cloud-backup>
+        <!-- Exclude the dedicated SharedPreferences file from cloud backups on Android 12+ -->
+        <exclude domain="sharedpref" path="cache_prefs.xml" />
+    </cloud-backup>
+    <device-transfer>
+        <!-- Exclude from device-to-device transfer as well -->
+        <exclude domain="sharedpref" path="cache_prefs.xml" />
+    </device-transfer>
+</data-extraction-rules>