-
-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rewrite Backup & Restore functionality (#55)
* Add backup package * Bump target SDK, upgrade AGP version, switch from KAPT to KSP & more * Add backup manager & rework on backup related stuff * Minor fix --------- Signed-off-by: starry-shivam <[email protected]>
- Loading branch information
1 parent
81ce673
commit 88c1464
Showing
20 changed files
with
418 additions
and
114 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 128 additions & 0 deletions
128
app/src/main/java/com/starry/greenstash/backup/BackupManager.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package com.starry.greenstash.backup | ||
|
|
||
| import android.content.Context | ||
| import android.content.Intent | ||
| import android.graphics.Bitmap | ||
| import android.util.Log | ||
| import androidx.core.content.FileProvider | ||
| import com.google.gson.Gson | ||
| import com.google.gson.GsonBuilder | ||
| import com.starry.greenstash.BuildConfig | ||
| import com.starry.greenstash.database.core.GoalWithTransactions | ||
| import com.starry.greenstash.database.goal.GoalDao | ||
| import com.starry.greenstash.utils.updateText | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.withContext | ||
| import java.io.File | ||
| import java.time.LocalDateTime | ||
|
|
||
| /** | ||
| * Handles all backup & restore related functionalities. | ||
| * Note: Access this class using DI instead of manually initialising. | ||
| */ | ||
| class BackupManager(private val context: Context, private val goalDao: GoalDao) { | ||
|
|
||
| /** | ||
| * Instance of [Gson] with custom type adaptor applied for serializing | ||
| * and deserializing [Bitmap] fields. | ||
| */ | ||
| private val gsonInstance = GsonBuilder() | ||
| .registerTypeAdapter(Bitmap::class.java, BitmapTypeAdapter()) | ||
| .setDateFormat(ISO8601_DATE_FORMAT) | ||
| .create() | ||
|
|
||
| companion object { | ||
| /** Backup schema version. */ | ||
| const val BACKUP_SCHEMA_VERSION = 1 | ||
| /** Authority for using file provider API. */ | ||
| private const val FILE_PROVIDER_AUTHORITY = "${BuildConfig.APPLICATION_ID}.provider" | ||
| /** An ISO-8601 date format for Gson */ | ||
| private const val ISO8601_DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ" | ||
| } | ||
|
|
||
| /** | ||
| * Model for backup json data, containing current schema version | ||
| * and timestamp when backup was created. | ||
| */ | ||
| data class BackupJsonModel( | ||
| val version: Int = BACKUP_SCHEMA_VERSION, | ||
| val timestamp: Long, | ||
| val data: List<GoalWithTransactions> | ||
| ) | ||
|
|
||
| /** | ||
| * Logger function with pre-applied tag. | ||
| */ | ||
| private fun log(message: String) { | ||
| Log.d("BackupManager", message) | ||
| } | ||
|
|
||
| /** | ||
| * Creates a database backup by converting goals and transaction data into json | ||
| * then saving that json file into cache directory and retuning a chooser intent | ||
| * for the backup file. | ||
| * | ||
| * @return a chooser [Intent] for newly created backup file. | ||
| */ | ||
| suspend fun createDatabaseBackup(): Intent = withContext(Dispatchers.IO) { | ||
| log("Fetching goals from database and serialising into json...") | ||
| val goalsWithTransactions = goalDao.getAllGoals() | ||
| val jsonString = gsonInstance.toJson( | ||
| BackupJsonModel( | ||
| timestamp = System.currentTimeMillis(), | ||
| data = goalsWithTransactions | ||
| ) | ||
| ) | ||
|
|
||
| log("Creating backup json file inside cache directory...") | ||
| val fileName = "Greenstash-Backup (${LocalDateTime.now()}).json" | ||
| val file = File(context.cacheDir, fileName) | ||
| file.updateText(jsonString) | ||
| val uri = FileProvider.getUriForFile(context, FILE_PROVIDER_AUTHORITY, file) | ||
|
|
||
| log("Building and returning chooser intent for backup file.") | ||
| return@withContext Intent(Intent.ACTION_SEND).apply { | ||
| type = "application/json" | ||
| addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION) | ||
| putExtra(Intent.EXTRA_STREAM, uri) | ||
| putExtra(Intent.EXTRA_SUBJECT, "Greenstash Backup") | ||
| putExtra(Intent.EXTRA_TEXT, "Created at ${LocalDateTime.now()}") | ||
| }.let { intent -> Intent.createChooser(intent, fileName) } | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Restores a database backup by deserializing the backup json string | ||
| * and saving goals and transactions back into the database. | ||
| * | ||
| * @param jsonString a valid backup json as sting. | ||
| * @param onFailure callback to be called if [BackupManager] failed parse the json string. | ||
| * @param onSuccess callback to be called after backup was successfully restored. | ||
| */ | ||
| suspend fun restoreDatabaseBackup( | ||
| jsonString: String, | ||
| onFailure: () -> Unit, | ||
| onSuccess: () -> Unit | ||
| ) = withContext(Dispatchers.IO) { | ||
|
|
||
| // Parse json string. | ||
| log("Parsing backup json file...") | ||
| val backupData: BackupJsonModel? = try { | ||
| gsonInstance.fromJson(jsonString, BackupJsonModel::class.java) | ||
| } catch (exc: Exception) { | ||
| log("Failed to parse backup json file! Err: ${exc.message}") | ||
| exc.printStackTrace() | ||
| null | ||
| } | ||
|
|
||
| if (backupData?.data == null) { | ||
| withContext(Dispatchers.Main) { onFailure() } | ||
| return@withContext | ||
| } | ||
|
|
||
| // Insert goal & transaction data into database. | ||
| log("Inserting goals & transactions into the database...") | ||
| goalDao.insertGoalWithTransaction(backupData.data) | ||
| withContext(Dispatchers.Main) { onSuccess() } | ||
| } | ||
| } |
Oops, something went wrong.