feat: backup & restore functionality (#40)

gouravkhunger · web-flow · commit 3857255ac486 · 2025-08-15T18:37:06.000+05:30
* chore: bump bootstrap to v0.1.4

* ui(SettingsActivity.kt): add backup &amp; restore options

* feat: backup &amp; restore functionality

* feat: improvements like confrimation dialog, etc

* fix: edge case in ui terminal logging sync
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -25,7 +25,7 @@ plugins {
     alias(libs.plugins.jetbrainsKotlinAndroid)
 }
 
-val bootstrapVersion = "v0.1.3"
+val bootstrapVersion = "v0.1.4"
 
 android {
     namespace = "xyz.jekyllex"
@@ -166,7 +166,7 @@ fun getGitHash(): String {
     return "\"" + stdout.toString().trim() + "\""
 }
 
-fun downloadBootstrap(arch: String, expectedChecksum: String, version: String) {
+fun downloadBootstrap(arch: String, expectedChecksum: String) {
     val buffer = ByteArray(8192)
     val digest = MessageDigest.getInstance("SHA-256")
     val zipDownloadFile = File(project.rootDir, "bootstraps/ruby-${arch}.zip")
@@ -182,12 +182,13 @@ fun downloadBootstrap(arch: String, expectedChecksum: String, version: String) {
         val checksum = BigInteger(1, digest.digest()).toString(16)
         if (checksum != expectedChecksum) {
             logger.quiet("Deleting old local file with wrong hash: ${zipDownloadFile.absolutePath}")
+            File("${zipDownloadFile.absolutePath}.done").delete()
             zipDownloadFile.delete()
         }
     }
 
     if (!zipDownloadFile.exists()) {
-        val remoteUrl = "https://dl.jekyllex.xyz/ruby/$version/$arch.zip"
+        val remoteUrl = "https://dl.jekyllex.xyz/ruby/$bootstrapVersion/$arch.zip"
         logger.quiet("Downloading $remoteUrl ...")
 
         zipDownloadFile.parentFile.mkdirs()
@@ -317,13 +318,13 @@ tasks {
     val downloadBootstraps by registering {
         doFirst {
             val map = mapOf(
-                "aarch64" to "266b081bb64e33541808e2f627e4667ed8f8ef10a0edbfe736c3338c97930e9b",
-                "arm" to "57f7c270d6203323af3d30f626b1c41a1d59d0e6a6cb0b57a5e908c7a6349c35",
-                "i686" to "8353c79ca752d754f00da4cd33b6245c253d79a852c8066a1e0809684d178539",
-                "x86_64" to "46556fa1b3b690d0c105f7c110f2dd5d57d9a3ab0c29eab2fa3a963d2db41aea"
+                "aarch64" to "6dfa705dcff38f0ade4f5ac202c49a14b863d25fbf994f71ef21a9ad7eb2a9ce",
+                "arm" to "8874edb85cb3a9d7ee49c6670fa10e30340eddb02a551769c78349697d4cc962",
+                "i686" to "c4531c473b084ccef0f367cb19dd633636aacf55043f5031d6b0e3c0814dbcfe",
+                "x86_64" to "d1f28ff6a08c128974a6d777af06c4603a07c129d877d608072c4596bef6cee8"
             )
 
-            map.forEach { (arch, checksum) -> downloadBootstrap(arch, checksum, bootstrapVersion) }
+            map.forEach { (arch, checksum) -> downloadBootstrap(arch, checksum) }
         }
     }
 }
diff --git a/app/src/main/java/xyz/jekyllex/services/ProcessService.kt b/app/src/main/java/xyz/jekyllex/services/ProcessService.kt
@@ -154,11 +154,10 @@ class ProcessService : Service() {
     fun cd(dir: String) {
         val defaultSession = _sessions.value.first()
         val currentDir = defaultSession.dir.value
-        defaultSession.cd(dir)
-        if (isRunning) return
-        defaultSession.appendLog(
+        if (!isRunning) defaultSession.appendLog(
             "${currentDir.formatDir("/")} $ cd ${dir.formatDir("/")}"
         )
+        defaultSession.cd(dir)
     }
 
     fun exec(cmd: Array<String>, dir: String? = null, callBack: () -> Unit = {}) {
diff --git a/app/src/main/java/xyz/jekyllex/ui/activities/settings/SettingsActivity.kt b/app/src/main/java/xyz/jekyllex/ui/activities/settings/SettingsActivity.kt
@@ -30,7 +30,9 @@ import android.net.Uri
 import android.os.Bundle
 import android.widget.Toast
 import androidx.activity.ComponentActivity
+import androidx.activity.compose.rememberLauncherForActivityResult
 import androidx.activity.compose.setContent
+import androidx.activity.result.contract.ActivityResultContracts
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.layout.padding
@@ -45,6 +47,9 @@ import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Scaffold
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalClipboardManager
 import androidx.compose.ui.platform.LocalContext
@@ -54,6 +59,10 @@ import androidx.compose.ui.text.SpanStyle
 import androidx.compose.ui.text.buildAnnotatedString
 import androidx.compose.ui.text.withStyle
 import androidx.compose.ui.unit.dp
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import me.zhanghai.compose.preference.ProvidePreferenceLocals
 import me.zhanghai.compose.preference.footerPreference
 import me.zhanghai.compose.preference.listPreference
@@ -72,6 +81,13 @@ import xyz.jekyllex.utils.Setting.*
 import xyz.jekyllex.utils.trimQuotes
 import xyz.jekyllex.BuildConfig
 import xyz.jekyllex.ui.activities.viewer.WebPageViewer
+import xyz.jekyllex.ui.components.GenericDialog
+import xyz.jekyllex.ui.components.ProgressDialog
+import xyz.jekyllex.utils.Commands.rm
+import xyz.jekyllex.utils.Commands.rmDir
+import xyz.jekyllex.utils.Commands.shell
+import xyz.jekyllex.utils.Commands.unzip
+import xyz.jekyllex.utils.Commands.zip
 import xyz.jekyllex.utils.Constants.DOCS
 import xyz.jekyllex.utils.Constants.TERMS
 import xyz.jekyllex.utils.Constants.PRIVACY
@@ -80,8 +96,15 @@ import xyz.jekyllex.utils.Constants.themeMap
 import xyz.jekyllex.utils.Constants.ISSUES_URL
 import xyz.jekyllex.utils.Constants.PAT_SETTINGS_URL
 import xyz.jekyllex.utils.Constants.EDITOR_PREVIEWS_URL
+import xyz.jekyllex.utils.Constants.HOME_DIR
+import xyz.jekyllex.utils.Constants.TMP_DIR
+import xyz.jekyllex.utils.mergeCommands
+import java.io.File
+import java.io.FileInputStream
+import java.io.FileOutputStream
 
 class SettingsActivity : ComponentActivity() {
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
@@ -95,8 +118,107 @@ class SettingsActivity : ComponentActivity() {
 
 @Composable
 fun SettingsView() {
+    val coroutineScope = rememberCoroutineScope()
     val context = LocalContext.current as Activity
     val clipboardManager = LocalClipboardManager.current
+    val processing = remember { mutableStateOf(false) }
+    val restoreConfirmation = remember { mutableStateOf<Uri?>(null) }
+
+    val picker = rememberLauncherForActivityResult(ActivityResultContracts.GetContent()) { uri ->
+        uri?.let {
+            restoreConfirmation.value = uri
+        } ?: run {
+            Toast.makeText(context, "No file selected!", Toast.LENGTH_SHORT)
+                .show()
+        }
+    }
+
+    val saver = rememberLauncherForActivityResult(
+        contract = ActivityResultContracts.StartActivityForResult()
+    ) { result ->
+        val uri = result.data?.data
+        val file = File(HOME_DIR, "backup.zip")
+        uri?.let {
+            coroutineScope.launch(Dispatchers.IO) {
+                try {
+                    context.contentResolver.openOutputStream(uri)?.use { outputStream ->
+                        FileInputStream(file).use { inputStream ->
+                            inputStream.copyTo(outputStream)
+                        }
+                    }
+                    withContext(Dispatchers.Main) {
+                        Toast.makeText(context, "Backup saved!", Toast.LENGTH_SHORT).show()
+                    }
+                } catch (e: Exception) {
+                    e.printStackTrace()
+                    withContext(Dispatchers.Main) {
+                        Toast.makeText(context, "Failed to save backup file!", Toast.LENGTH_SHORT)
+                            .show()
+                    }
+                }
+                file.delete()
+            }
+        } ?: run {
+            file.delete()
+            Toast.makeText(context, "No location selected!", Toast.LENGTH_SHORT)
+                .show()
+        }
+    }
+
+    if (processing.value) {
+        ProgressDialog(dialogTitle = "Processing...")
+    }
+
+    if (restoreConfirmation.value != null) {
+        GenericDialog(
+            isCancellable = false,
+            dialogTitle = "Restore data",
+            dialogText = "Are you sure you want to restore data from the selected file?\n\n" +
+                    "This will overwrite all existing data.",
+            onDismissRequest = {
+                restoreConfirmation.value = null
+            },
+            onConfirmation = confirmation@{
+                val uri = restoreConfirmation.value ?: return@confirmation
+                val file = File(TMP_DIR, "backup-${System.currentTimeMillis()}.zip")
+                restoreConfirmation.value = null
+                coroutineScope.launch(Dispatchers.IO) {
+                    processing.value = true
+                    try {
+                        context.contentResolver.openInputStream(uri)?.use { inputStream ->
+                            FileOutputStream(file).use { outputStream ->
+                                inputStream.copyTo(outputStream)
+                            }
+                        }
+                        NativeUtils.exec(
+                            shell(
+                                mergeCommands(
+                                    rmDir("*", ".*"),
+                                    unzip(file.absolutePath, "-d", "$HOME_DIR/")
+                                )
+                            )
+                        )
+                        processing.value = false
+                        withContext(Dispatchers.Main) {
+                            Toast.makeText(
+                                context,
+                                "Backup restored successfully!",
+                                Toast.LENGTH_SHORT
+                            ).show()
+                        }
+                    } catch (e: Exception) {
+                        e.printStackTrace()
+                        withContext(Dispatchers.Main) {
+                            processing.value = false
+                            Toast.makeText(context, "Failed to fetch backup file!", Toast.LENGTH_SHORT)
+                                .show()
+                        }
+                    }
+                    file.delete()
+                }
+            }
+        )
+    }
 
     Scaffold(
         topBar = {
@@ -384,6 +506,47 @@ fun SettingsView() {
                     },
                 )
 
+                preferenceCategory(
+                    key = "advanced",
+                    title = { Text("Advanced") },
+                )
+
+                preference(
+                    key = "backup",
+                    onClick = {
+                        processing.value = true
+                        NativeUtils.exec(
+                            shell(
+                                mergeCommands(
+                                    rm("backup.zip"),
+                                    zip("-r", "backup.zip", ".", "-x", "'.bundle/*'")
+                                ),
+                            ),
+                            CoroutineScope(Dispatchers.IO)
+                        ) {
+                            processing.value = false
+                            withContext(Dispatchers.Main) {
+                                saver.launch(
+                                    Intent(Intent.ACTION_CREATE_DOCUMENT).apply {
+                                        type = "application/zip"
+                                        addCategory(Intent.CATEGORY_OPENABLE)
+                                        putExtra(Intent.EXTRA_TITLE, "backup.zip")
+                                    }
+                                )
+                            }
+                        }
+                    },
+                    title = { Text(context.getString(R.string.backup_setting_title)) },
+                    summary = { Text(context.getString(R.string.backup_setting_summary)) },
+                )
+
+                preference(
+                    key = "restore",
+                    onClick = { picker.launch("application/zip") },
+                    title = { Text(context.getString(R.string.restore_setting_title)) },
+                    summary = { Text(context.getString(R.string.restore_setting_summary)) },
+                )
+
                 preferenceCategory(
                     key = "other",
                     title = { Text("Other") }
diff --git a/app/src/main/java/xyz/jekyllex/ui/components/ProgressDialog.kt b/app/src/main/java/xyz/jekyllex/ui/components/ProgressDialog.kt
@@ -0,0 +1,74 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Gourav Khunger
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package xyz.jekyllex.ui.components
+
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.size
+import androidx.compose.foundation.layout.wrapContentHeight
+import androidx.compose.foundation.layout.wrapContentWidth
+import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material3.BasicAlertDialog
+import androidx.compose.material3.CircularProgressIndicator
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Surface
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.unit.dp
+
+@Composable
+fun ProgressDialog(
+    dialogTitle: String,
+    isCancellable: Boolean = false,
+    onDismissRequest: () -> Unit = {},
+) {
+    BasicAlertDialog (
+        onDismissRequest = {
+            if (isCancellable) onDismissRequest()
+        },
+    ) {
+        Surface(
+            shape = RoundedCornerShape(8.dp),
+            modifier = Modifier.wrapContentWidth().wrapContentHeight(),
+        ) {
+            Row(
+                modifier = Modifier.padding(20.dp),
+                verticalAlignment = Alignment.CenterVertically
+            ) {
+                CircularProgressIndicator(
+                    strokeWidth = 2.dp,
+                    modifier = Modifier.size(24.dp)
+                )
+                Text(
+                    text = dialogTitle,
+                    modifier = Modifier.padding(start = 16.dp),
+                    style = MaterialTheme.typography.titleMedium,
+                )
+            }
+        }
+    }
+}
diff --git a/app/src/main/java/xyz/jekyllex/utils/Commands.kt b/app/src/main/java/xyz/jekyllex/utils/Commands.kt
@@ -27,13 +27,15 @@ package xyz.jekyllex.utils
 object Commands {
     fun cat(vararg file: String): Array<String> = arrayOf("cat", *file)
     fun rm(vararg files: String): Array<String> = arrayOf("rm", *files)
+    fun zip(vararg command: String): Array<String> = arrayOf("zip", *command)
     fun rmDir(vararg dirs: String): Array<String> = arrayOf("rm", "-rf", *dirs)
     fun mv(src: String, dest: String): Array<String> = arrayOf("mv", src, dest)
     fun stat(vararg command: String): Array<String> = arrayOf("stat", *command)
     fun echo(vararg command: String): Array<String> = arrayOf("echo", *command)
     fun touch(vararg command: String): Array<String> = arrayOf("touch", *command)
     fun mkDir(vararg command: String): Array<String> = arrayOf("mkdir", *command)
     fun diskUsage(vararg command: String): Array<String> = arrayOf("du", *command)
+    fun unzip(vararg command: String): Array<String> = arrayOf("unzip", *command)
     fun shell(vararg command: String): Array<String> = arrayOf("/bin/sh", "-c", *command)
 
     fun git(vararg command: String): Array<String> = arrayOf("git", *command)
diff --git a/app/src/main/java/xyz/jekyllex/utils/Utils.kt b/app/src/main/java/xyz/jekyllex/utils/Utils.kt
@@ -42,8 +42,8 @@ import xyz.jekyllex.utils.Constants.editorExtensions
 import xyz.jekyllex.ui.activities.editor.EditorActivity
 import xyz.jekyllex.utils.Constants.COMMAND_NOT_ALLOWED
 
-fun Array<String>.isDenied(): Boolean = Constants.denyList.any { this.getOrNull(0) == it }
 fun Array<String>.drop(n: Int): Array<String> = this.toList().drop(n).toTypedArray()
+fun Array<String>.isDenied(): Boolean = Constants.denyList.any { this.getOrNull(0) == it }
 
 fun Array<String>.transform(context: Context): Array<String> = this.let {
     val settings = Settings(context)
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -130,6 +130,15 @@
 
     <string name="theme_setting_title">Color theme</string>
 
+    <string name="backup_setting_title">Backup</string>
+    <string name="backup_setting_summary">
+        Backup all projects to a zip file and store it at an external location.
+    </string>
+    <string name="restore_setting_title">Restore</string>
+    <string name="restore_setting_summary">
+        Choose a zip file to restore projects from. Wipes all existing data.
+    </string>
+
     <string name="docs">Docs</string>
     <string name="report">Report</string>
     <string name="licenses">Licenses</string>

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ plugins {`
`25`	`25`	`alias(libs.plugins.jetbrainsKotlinAndroid)`
`26`	`26`	`}`
`27`	`27`
`28`		`-val bootstrapVersion = "v0.1.3"`
	`28`	`+val bootstrapVersion = "v0.1.4"`
`29`	`29`
`30`	`30`	`android {`
`31`	`31`	`namespace = "xyz.jekyllex"`
`@@ -166,7 +166,7 @@ fun getGitHash(): String {`
`166`	`166`	`return "\"" + stdout.toString().trim() + "\""`
`167`	`167`	`}`
`168`	`168`
`169`		`-fun downloadBootstrap(arch: String, expectedChecksum: String, version: String) {`
	`169`	`+fun downloadBootstrap(arch: String, expectedChecksum: String) {`
`170`	`170`	`val buffer = ByteArray(8192)`
`171`	`171`	`val digest = MessageDigest.getInstance("SHA-256")`
`172`	`172`	`val zipDownloadFile = File(project.rootDir, "bootstraps/ruby-${arch}.zip")`
`@@ -182,12 +182,13 @@ fun downloadBootstrap(arch: String, expectedChecksum: String, version: String) {`
`182`	`182`	`val checksum = BigInteger(1, digest.digest()).toString(16)`
`183`	`183`	`if (checksum != expectedChecksum) {`
`184`	`184`	`logger.quiet("Deleting old local file with wrong hash: ${zipDownloadFile.absolutePath}")`
	`185`	`+ File("${zipDownloadFile.absolutePath}.done").delete()`
`185`	`186`	`zipDownloadFile.delete()`
`186`	`187`	`}`
`187`	`188`	`}`
`188`	`189`
`189`	`190`	`if (!zipDownloadFile.exists()) {`
`190`		`- val remoteUrl = "https://dl.jekyllex.xyz/ruby/$version/$arch.zip"`
	`191`	`+ val remoteUrl = "https://dl.jekyllex.xyz/ruby/$bootstrapVersion/$arch.zip"`
`191`	`192`	`logger.quiet("Downloading $remoteUrl ...")`
`192`	`193`
`193`	`194`	`zipDownloadFile.parentFile.mkdirs()`
`@@ -317,13 +318,13 @@ tasks {`
`317`	`318`	`val downloadBootstraps by registering {`
`318`	`319`	`doFirst {`
`319`	`320`	`val map = mapOf(`
`320`		`- "aarch64" to "266b081bb64e33541808e2f627e4667ed8f8ef10a0edbfe736c3338c97930e9b",`
`321`		`- "arm" to "57f7c270d6203323af3d30f626b1c41a1d59d0e6a6cb0b57a5e908c7a6349c35",`
`322`		`- "i686" to "8353c79ca752d754f00da4cd33b6245c253d79a852c8066a1e0809684d178539",`
`323`		`- "x86_64" to "46556fa1b3b690d0c105f7c110f2dd5d57d9a3ab0c29eab2fa3a963d2db41aea"`
	`321`	`+ "aarch64" to "6dfa705dcff38f0ade4f5ac202c49a14b863d25fbf994f71ef21a9ad7eb2a9ce",`
	`322`	`+ "arm" to "8874edb85cb3a9d7ee49c6670fa10e30340eddb02a551769c78349697d4cc962",`
	`323`	`+ "i686" to "c4531c473b084ccef0f367cb19dd633636aacf55043f5031d6b0e3c0814dbcfe",`
	`324`	`+ "x86_64" to "d1f28ff6a08c128974a6d777af06c4603a07c129d877d608072c4596bef6cee8"`
`324`	`325`	`)`
`325`	`326`
`326`		`- map.forEach { (arch, checksum) -> downloadBootstrap(arch, checksum, bootstrapVersion) }`
	`327`	`+ map.forEach { (arch, checksum) -> downloadBootstrap(arch, checksum) }`
`327`	`328`	`}`
`328`	`329`	`}`
`329`	`330`	`}`
Original file line number	Diff line number	Diff line change
`@@ -154,11 +154,10 @@ class ProcessService : Service() {`
`154`	`154`	`fun cd(dir: String) {`
`155`	`155`	`val defaultSession = _sessions.value.first()`
`156`	`156`	`val currentDir = defaultSession.dir.value`
`157`		`- defaultSession.cd(dir)`
`158`		`- if (isRunning) return`
`159`		`- defaultSession.appendLog(`
	`157`	`+ if (!isRunning) defaultSession.appendLog(`
`160`	`158`	`"${currentDir.formatDir("/")} $ cd ${dir.formatDir("/")}"`
`161`	`159`	`)`
	`160`	`+ defaultSession.cd(dir)`
`162`	`161`	`}`
`163`	`162`
`164`	`163`	`fun exec(cmd: Array<String>, dir: String? = null, callBack: () -> Unit = {}) {`