Added ability to backup settings, databases & images

app/src/main/AndroidManifest.xml

@@ -8,7 +8,7 @@
     <uses-permission android:name="android.permission.VIBRATE" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
-    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.BROADCAST_STICKY" />
@@ -119,6 +119,22 @@
         <activity android:name=".activities.DriveModeActivity" />
         <activity android:name=".activities.PermissionActivity" />
         <activity android:name=".activities.LockScreenActivity" />
+        <activity
+            android:name=".activities.backup.RestoreActivity"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="android.intent.action.VIEW" />
+
+                <category android:name="android.intent.category.DEFAULT" />
+
+                <data android:scheme="file" />
+                <data android:mimeType="*/*" />
+                <data android:pathPattern=".*\\.rmbak" />
+            </intent-filter>
+        </activity>
+        <activity
+            android:name=".activities.backup.BackupActivity"
+            android:exported="true" />
 
         <activity
             android:name=".appshortcuts.AppShortcutLauncherActivity"
@@ -133,14 +149,14 @@
             android:name=".cast.ExpandedControlsActivity"
             android:label="@string/app_name"
             android:launchMode="singleTask"
-            android:theme="@style/Theme.AppCompat.NoActionBar"
-            android:screenOrientation="portrait">
+            android:screenOrientation="portrait"
+            android:theme="@style/Theme.AppCompat.NoActionBar">
             <intent-filter>
-                <action android:name="android.intent.action.MAIN"/>
+                <action android:name="android.intent.action.MAIN" />
             </intent-filter>
             <meta-data
                 android:name="android.support.PARENT_ACTIVITY"
-                android:value=".activities.MainActivity"/>
+                android:value=".activities.MainActivity" />
         </activity>
 
         <provider
@@ -265,13 +281,13 @@
         <!-- Android Auto -->
         <meta-data
             android:name="com.google.android.gms.car.application"
-            android:resource="@xml/automotive_app_desc"/>
+            android:resource="@xml/automotive_app_desc" />
         <meta-data
             android:name="com.google.android.gms.car.application.theme"
             android:resource="@style/CarTheme" />
         <meta-data
             android:name="com.google.android.gms.car.notification.SmallIcon"
-            android:resource="@drawable/ic_notification"/>
+            android:resource="@drawable/ic_notification" />
 
         <!-- ChromeCast -->
         <meta-data

app/src/main/java/code/name/monkey/retromusic/activities/backup/BackupActivity.kt

@@ -0,0 +1,85 @@
+package code.name.monkey.retromusic.activities.backup
+
+import android.os.Bundle
+import android.widget.Toast
+import androidx.activity.viewModels
+import androidx.core.view.isVisible
+import androidx.lifecycle.lifecycleScope
+import androidx.recyclerview.widget.LinearLayoutManager
+import androidx.recyclerview.widget.RecyclerView
+import code.name.monkey.retromusic.R
+import code.name.monkey.retromusic.activities.base.AbsThemeActivity
+import code.name.monkey.retromusic.adapter.backup.BackupAdapter
+import code.name.monkey.retromusic.databinding.ActivityBackupBinding
+import code.name.monkey.retromusic.helper.BackupHelper
+import com.google.android.material.shape.MaterialShapeDrawable
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+
+class BackupActivity : AbsThemeActivity() {
+
+    private val backupViewModel by viewModels<BackupViewModel>()
+    private var backupAdapter: BackupAdapter? = null
+
+    lateinit var binding: ActivityBackupBinding
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        binding = ActivityBackupBinding.inflate(layoutInflater)
+        setContentView(binding.root)
+        binding.appBarLayout.statusBarForeground =
+            MaterialShapeDrawable.createWithElevationOverlay(this)
+        binding.toolbar.setNavigationIcon(R.drawable.ic_keyboard_backspace_black)
+        initAdapter()
+        setupRecyclerview()
+        backupViewModel.backupsLiveData.observe(this) {
+            if (it.isNotEmpty())
+                backupAdapter?.swapDataset(it)
+            else
+                backupAdapter?.swapDataset(listOf())
+        }
+        backupViewModel.loadBackups()
+        setupButtons()
+    }
+
+    private fun setupButtons() {
+        binding.createBackup.setOnClickListener {
+            lifecycleScope.launch {
+                BackupHelper.createBackup(this@BackupActivity)
+                backupViewModel.loadBackups()
+                withContext(Dispatchers.Main) {
+                    Toast.makeText(
+                        this@BackupActivity,
+                        "Backup Completed Successfully",
+                        Toast.LENGTH_SHORT
+                    ).show()
+                }
+            }
+        }
+    }
+
+    private fun initAdapter() {
+        backupAdapter = BackupAdapter(this@BackupActivity, ArrayList())
+        backupAdapter?.registerAdapterDataObserver(object : RecyclerView.AdapterDataObserver() {
+            override fun onChanged() {
+                super.onChanged()
+                checkIsEmpty()
+            }
+        })
+    }
+
+    private fun checkIsEmpty() {
+        binding.emptyText.setText(R.string.no_backups_found)
+        (backupAdapter!!.itemCount == 0).run {
+            binding.empty.isVisible = this
+            binding.backupTitle.isVisible = this
+        }
+    }
+
+    fun setupRecyclerview() {
+        binding.backupRecyclerview.apply {
+            layoutManager = LinearLayoutManager(context)
+            adapter = backupAdapter
+        }
+    }
+}

app/src/main/java/code/name/monkey/retromusic/activities/backup/BackupViewModel.kt

@@ -0,0 +1,23 @@
+package code.name.monkey.retromusic.activities.backup
+
+import androidx.lifecycle.MutableLiveData
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import code.name.monkey.retromusic.helper.BackupHelper
+import kotlinx.coroutines.launch
+import java.io.File
+
+class BackupViewModel : ViewModel() {
+    private val backupsMutableLiveData = MutableLiveData<List<File>>()
+    val backupsLiveData = backupsMutableLiveData
+
+    fun loadBackups() {
+        viewModelScope.launch {
+            File(BackupHelper.backupRootPath).listFiles { _, name ->
+                return@listFiles name.endsWith(BackupHelper.backupExt)
+            }?.toList()?.let {
+                backupsMutableLiveData.value = it
+            }
+        }
+    }
+}

app/src/main/java/code/name/monkey/retromusic/activities/backup/RestoreActivity.kt

@@ -0,0 +1,12 @@
+package code.name.monkey.retromusic.activities.backup
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import code.name.monkey.retromusic.R
+
+class RestoreActivity : AppCompatActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_restore)
+    }
+}

app/src/main/java/code/name/monkey/retromusic/adapter/backup/BackupAdapter.kt

@@ -0,0 +1,40 @@
+package code.name.monkey.retromusic.adapter.backup
+
+import android.content.Context
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.widget.TextView
+import androidx.recyclerview.widget.RecyclerView
+import code.name.monkey.retromusic.R
+import java.io.File
+
+class BackupAdapter(
+    val context: Context,
+    var dataSet: MutableList<File>,
+) : RecyclerView.Adapter<BackupAdapter.ViewHolder>() {
+
+    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder {
+        return ViewHolder(
+            LayoutInflater.from(context).inflate(R.layout.item_list_card, parent, false)
+        )
+    }
+
+    override fun onBindViewHolder(holder: ViewHolder, position: Int) {
+        holder.title.text = dataSet[position].nameWithoutExtension
+    }
+
+    override fun getItemCount(): Int = dataSet.size
+
+    fun swapDataset(dataSet: List<File>) {
+        this.dataSet = ArrayList(dataSet)
+        notifyDataSetChanged()
+    }
+
+    inner class ViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
+        val title: TextView = itemView.findViewById(R.id.title)
+
+        init {
+        }
+    }
+}

app/src/main/java/code/name/monkey/retromusic/helper/BackupHelper.kt

@@ -0,0 +1,71 @@
+package code.name.monkey.retromusic.helper
+
+import android.content.Context
+import android.os.Environment
+import code.name.monkey.retromusic.BuildConfig
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+import java.io.*
+import java.util.zip.ZipEntry
+import java.util.zip.ZipOutputStream
+
+object BackupHelper {
+    suspend fun createBackup(context: Context) {
+        withContext(Dispatchers.IO) {
+            val finalPath = backupRootPath + System.currentTimeMillis().toString() + backupExt
+            val zipItems = mutableListOf<ZipItem>()
+            zipItems.addAll(getDatabaseZipItems(context))
+            zipItems.addAll(getSettingsZipItems(context))
+            getUserImageZipItems(context)?.let { zipItems.addAll(it) }
+            zipAll(zipItems, finalPath)
+        }
+    }
+
+    private fun zipAll(zipItems: List<ZipItem>, finalPath: String) {
+        ZipOutputStream(BufferedOutputStream(FileOutputStream(finalPath))).use { out ->
+            for (zipItem in zipItems) {
+                FileInputStream(zipItem.filePath).use { fi ->
+                    BufferedInputStream(fi).use { origin ->
+                        val entry = ZipEntry(zipItem.zipPath)
+                        out.putNextEntry(entry)
+                        origin.copyTo(out, 1024)
+                    }
+                }
+            }
+        }
+    }
+
+    private fun getDatabaseZipItems(context: Context): List<ZipItem> {
+        return context.databaseList().filter {
+            it.endsWith(".db")
+        }.map {
+            ZipItem(context.getDatabasePath(it).absolutePath, "databases${File.separator}$it")
+        }
+    }
+
+    private fun getSettingsZipItems(context: Context): List<ZipItem> {
+        val sharedPrefPath = context.filesDir.parentFile?.absolutePath + "/shared_prefs/"
+        return listOf(
+            "${BuildConfig.APPLICATION_ID}_preferences.xml", // App settings pref path
+            "$THEME_PREFS_KEY_DEFAULT.xml"  // appthemehelper pref path
+        ).map {
+            ZipItem(sharedPrefPath + it, "preferences${File.separator}$it")
+        }
+    }
+
+    private fun getUserImageZipItems(context: Context): List<ZipItem>? {
+        return context.filesDir.listFiles { _, name ->
+            name.endsWith(".jpg")
+        }?.map {
+            ZipItem(it.absolutePath, "userImages${File.separator}${it.name}")
+        }
+    }
+
+    val backupRootPath =
+        Environment.getExternalStorageDirectory().toString() + "/RetroMusic/Backups/"
+    const val backupExt = ".rmbak"
+    private const val THEME_PREFS_KEY_DEFAULT = "[[kabouzeid_app-theme-helper]]"
+
+}
+
+data class ZipItem(val filePath: String, val zipPath: String)

app/src/main/res/drawable/ic_backup.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M19.35,10.04C18.67,6.59 15.64,4 12,4 9.11,4 6.6,5.64 5.35,8.04 2.34,8.36 0,10.91 0,14c0,3.31 2.69,6 6,6h13c2.76,0 5,-2.24 5,-5 0,-2.64 -2.05,-4.78 -4.65,-4.96zM14,13v4h-4v-4H7l5,-5 5,5h-3z" />
+</vector>

app/src/main/res/drawable/ic_restore.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M13,3c-4.97,0 -9,4.03 -9,9L1,12l3.89,3.89 0.07,0.14L9,12L6,12c0,-3.87 3.13,-7 7,-7s7,3.13 7,7 -3.13,7 -7,7c-1.93,0 -3.68,-0.79 -4.94,-2.06l-1.42,1.42C8.27,19.99 10.51,21 13,21c4.97,0 9,-4.03 9,-9s-4.03,-9 -9,-9zM12,8v5l4.28,2.54 0.72,-1.21 -3.5,-2.08L13.5,8L12,8z" />
+</vector>

app/src/main/res/layout/activity_backup.xml

@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:background="?colorSurface"
+    android:fitsSystemWindows="true"
+    android:transitionGroup="true">
+
+    <com.google.android.material.appbar.AppBarLayout
+        android:id="@+id/appBarLayout"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:fitsSystemWindows="true">
+
+        <FrameLayout
+            android:id="@+id/toolbar_container"
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            app:layout_scrollFlags="scroll|enterAlways">
+
+            <androidx.appcompat.widget.Toolbar
+                android:id="@+id/toolbar"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content"
+                app:navigationIcon="@drawable/ic_search"
+                app:popupTheme="?attr/toolbarPopupTheme"
+                app:title="@null"
+                tools:ignore="UnusedAttribute">
+
+                <com.google.android.material.textview.MaterialTextView
+                    android:id="@+id/appNameText"
+                    android:layout_width="wrap_content"
+                    android:layout_height="wrap_content"
+                    android:layout_gravity="center"
+                    android:text="@string/backup_restore_title"
+                    android:textAppearance="@style/TextViewHeadline6"
+                    android:textStyle="bold" />
+            </androidx.appcompat.widget.Toolbar>
+        </FrameLayout>
+    </com.google.android.material.appbar.AppBarLayout>
+
+    <androidx.constraintlayout.widget.ConstraintLayout
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        app:layout_behavior="com.google.android.material.appbar.AppBarLayout$ScrollingViewBehavior">
+
+        <com.google.android.material.button.MaterialButton
+            android:id="@+id/create_backup"
+            style="@style/Widget.Material3.Button.OutlinedButton"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:layout_marginStart="16dp"
+            android:layout_marginEnd="4dp"
+            android:paddingVertical="10dp"
+            android:text="@string/create_new_backup"
+            android:textAppearance="@style/TextViewButton"
+            android:textColor="?android:attr/textColorPrimary"
+            app:backgroundTint="?attr/colorSurface"
+            app:icon="@drawable/ic_backup"
+            app:iconGravity="start"
+            app:layout_constraintEnd_toStartOf="@+id/restore_backup"
+            app:layout_constraintHorizontal_bias="0.5"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toTopOf="parent" />
+
+        <com.google.android.material.button.MaterialButton
+            android:id="@+id/restore_backup"
+            style="@style/Widget.Material3.Button.Icon"
+            android:layout_width="0dp"
+            android:layout_height="0dp"
+            android:layout_marginStart="4dp"
+            android:layout_marginEnd="16dp"
+            android:paddingVertical="10dp"
+            android:text="@string/restore"
+            android:textAppearance="@style/TextViewButton"
+            app:icon="@drawable/ic_restore"
+            app:iconGravity="start"
+            app:layout_constraintBottom_toBottomOf="@+id/create_backup"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintHorizontal_bias="0.5"
+            app:layout_constraintStart_toEndOf="@+id/create_backup"
+            app:layout_constraintTop_toTopOf="@+id/create_backup" />
+
+        <TextView
+            android:id="@+id/backup_title"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_margin="16dp"
+            android:text="@string/backup_title"
+            app:layout_constraintLeft_toLeftOf="parent"
+            app:layout_constraintTop_toBottomOf="@id/create_backup" />
+
+        <androidx.recyclerview.widget.RecyclerView
+            android:id="@+id/backup_recyclerview"
+            android:layout_width="0dp"
+            android:layout_height="0dp"
+            android:layout_marginTop="16dp"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toBottomOf="@+id/backup_title" />
+
+        <LinearLayout
+            android:id="@android:id/empty"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_gravity="center"
+            android:gravity="center"
+            android:orientation="vertical"
+            android:visibility="gone"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toTopOf="parent"
+            tools:visibility="visible">
+
+            <com.google.android.material.textview.MaterialTextView
+                android:id="@+id/emptyEmoji"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_marginBottom="16dp"
+                android:text="@string/empty_text_emoji"
+                android:textAppearance="@style/TextViewHeadline3" />
+
+            <com.google.android.material.textview.MaterialTextView
+                android:id="@+id/emptyText"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_gravity="center"
+                android:text="@string/empty"
+                android:textAppearance="@style/TextViewHeadline5"
+                android:textColor="?android:attr/textColorSecondary"
+                tools:visibility="visible" />
+        </LinearLayout>
+
+    </androidx.constraintlayout.widget.ConstraintLayout>
+</androidx.coordinatorlayout.widget.CoordinatorLayout>

app/src/main/res/layout/activity_restore.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    tools:context=".activities.backup.RestoreActivity">
+
+</androidx.constraintlayout.widget.ConstraintLayout>

app/src/main/res/layout/item_list_card.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<com.google.android.material.card.MaterialCardView xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content"
+    android:layout_margin="8dp"
+    app:cardCornerRadius="8dp"
+    tools:ignore="MissingPrefix"
+    android:minHeight="?attr/listPreferredItemHeight">
+
+    <androidx.constraintlayout.widget.ConstraintLayout
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:layout_gravity="center">
+
+        <androidx.appcompat.widget.AppCompatImageView
+            android:id="@+id/image"
+            android:layout_width="40dp"
+            android:layout_height="40dp"
+            android:layout_gravity="center_vertical"
+            android:layout_marginStart="16dp"
+            android:scaleType="centerCrop"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toStartOf="@id/title"
+            app:layout_constraintStart_toStartOf="parent"
+            app:layout_constraintTop_toTopOf="parent" />
+
+
+        <com.google.android.material.textview.MaterialTextView
+            android:id="@+id/title"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:ellipsize="end"
+            android:maxLines="1"
+            android:paddingHorizontal="16dp"
+            android:textAppearance="@style/TextViewSubtitle1"
+            android:textColor="?android:attr/textColorPrimary"
+            app:layout_constraintBottom_toTopOf="@+id/text"
+            app:layout_constraintEnd_toStartOf="@id/menu"
+            app:layout_constraintHorizontal_bias="0.5"
+            app:layout_constraintStart_toEndOf="@id/image"
+            app:layout_constraintTop_toTopOf="parent"
+            app:layout_constraintVertical_chainStyle="packed"
+            tools:text="@tools:sample/full_names" />
+
+        <com.google.android.material.textview.MaterialTextView
+            android:id="@+id/text"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:ellipsize="end"
+            android:maxLines="1"
+            android:paddingHorizontal="16dp"
+            android:textAppearance="@style/TextViewBody2"
+            android:textColor="?android:attr/textColorSecondary"
+            android:visibility="gone"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toStartOf="@id/menu"
+            app:layout_constraintHorizontal_bias="0.5"
+            app:layout_constraintStart_toEndOf="@id/image"
+            app:layout_constraintTop_toBottomOf="@+id/title"
+            tools:text="@tools:sample/full_names" />
+
+        <androidx.appcompat.widget.AppCompatImageView
+            android:id="@+id/menu"
+            style="@style/OverFlowButton"
+            android:layout_gravity="center_vertical"
+            android:layout_weight="0"
+            app:layout_constraintBottom_toBottomOf="parent"
+            app:layout_constraintEnd_toEndOf="parent"
+            app:layout_constraintTop_toTopOf="parent"
+            app:tint="?attr/colorControlNormal" />
+    </androidx.constraintlayout.widget.ConstraintLayout>
+</com.google.android.material.card.MaterialCardView>