Add save import/export in UI

5 files changed, 247 insertions, 0 deletions

diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/features/DocumentProvider.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/features/DocumentProvider.kt
index e6e9a6fe8..4c3a9ca80 100644
--- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/features/DocumentProvider.kt
+++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/features/DocumentProvider.kt
@@ -13,6 +13,7 @@ import android.os.ParcelFileDescriptor
 import android.provider.DocumentsContract
 import android.provider.DocumentsProvider
 import android.webkit.MimeTypeMap
+import org.yuzu.yuzu_emu.BuildConfig
 import org.yuzu.yuzu_emu.R
 import org.yuzu.yuzu_emu.YuzuApplication
 import org.yuzu.yuzu_emu.getPublicFilesDir
@@ -43,6 +44,7 @@ class DocumentProvider : DocumentsProvider() {
             DocumentsContract.Document.COLUMN_SIZE
         )
 
+        const val AUTHORITY : String = BuildConfig.APPLICATION_ID + ".user"
         const val ROOT_ID: String = "root"
     }
 
diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt
index 3a334a74c..7cd2409df 100644
--- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt
+++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt
@@ -99,6 +99,11 @@ class HomeSettingsFragment : Fragment() {
                 R.drawable.ic_add
             ) { mainActivity.getGamesDirectory.launch(Intent(Intent.ACTION_OPEN_DOCUMENT_TREE).data) },
             HomeSetting(
+                R.string.import_export_saves,
+                R.string.import_export_saves_description,
+                R.drawable.ic_save
+            ) { ImportExportSavesFragment().show(parentFragmentManager, ImportExportSavesFragment.TAG) },
+            HomeSetting(
                 R.string.install_prod_keys,
                 R.string.install_prod_keys_description,
                 R.drawable.ic_unlock
diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/ImportExportSavesFragment.kt b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/ImportExportSavesFragment.kt
new file mode 100644
index 000000000..20c1b6be5
--- /dev/null
+++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/ImportExportSavesFragment.kt
@@ -0,0 +1,226 @@
+// SPDX-FileCopyrightText: 2023 yuzu Emulator Project
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+package org.yuzu.yuzu_emu.fragments
+
+import android.app.Dialog
+import android.content.Intent
+import android.net.Uri
+import android.os.Bundle
+import android.provider.DocumentsContract
+import android.widget.Toast
+import androidx.activity.result.ActivityResultLauncher
+import androidx.activity.result.contract.ActivityResultContracts
+import androidx.documentfile.provider.DocumentFile
+import androidx.fragment.app.DialogFragment
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
+import org.yuzu.yuzu_emu.R
+import org.yuzu.yuzu_emu.YuzuApplication
+import org.yuzu.yuzu_emu.features.DocumentProvider
+import org.yuzu.yuzu_emu.getPublicFilesDir
+import java.io.BufferedInputStream
+import java.io.BufferedOutputStream
+import java.io.File
+import java.io.FileOutputStream
+import java.io.FilenameFilter
+import java.io.IOException
+import java.io.InputStream
+import java.time.LocalDateTime
+import java.time.format.DateTimeFormatter
+import java.util.zip.ZipEntry
+import java.util.zip.ZipInputStream
+import java.util.zip.ZipOutputStream
+
+class ImportExportSavesFragment : DialogFragment() {
+    private val context = YuzuApplication.appContext
+    private val savesFolder =
+        "${context.getPublicFilesDir().canonicalPath}/nand/user/save/0000000000000000"
+
+    // Get first subfolder in saves folder (should be the user folder)
+    private val savesFolderRoot = File(savesFolder).listFiles()?.firstOrNull()?.canonicalPath ?: ""
+    private var lastZipCreated: File? = null
+
+    private lateinit var startForResultExportSave: ActivityResultLauncher<Intent>
+    private lateinit var documentPicker: ActivityResultLauncher<Array<String>>
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+
+        val activityResultRegistry = requireActivity().activityResultRegistry
+        startForResultExportSave = activityResultRegistry.register(
+            "startForResultExportSaveKey",
+            ActivityResultContracts.StartActivityForResult()
+        ) {
+            File(context.getPublicFilesDir().canonicalPath, "temp").deleteRecursively()
+        }
+        documentPicker = activityResultRegistry.register(
+            "documentPickerKey",
+            ActivityResultContracts.OpenDocument()
+        ) {
+            it?.let { uri -> importSave(uri) }
+        }
+    }
+
+    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+        return MaterialAlertDialogBuilder(requireContext())
+            .setTitle("Import/Export Saves")
+            .setPositiveButton("Export") { _, _ ->
+                exportSave()
+            }
+            .setNeutralButton("Import") { _, _ ->
+                documentPicker.launch(arrayOf("application/zip"))
+            }
+            .show()
+    }
+
+    /**
+     * Zips the save files located in the given folder path and creates a new zip file with the current date and time.
+     * @return true if the zip file is successfully created, false otherwise.
+     */
+    private fun zipSave(): Boolean {
+        try {
+            val tempFolder = File(requireContext().getPublicFilesDir().canonicalPath, "temp")
+            tempFolder.mkdirs()
+            val saveFolder = File(savesFolderRoot)
+            val outputZipFile = File(
+                tempFolder, "Yuzu saves - ${LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm"))}.zip"
+            )
+            outputZipFile.createNewFile()
+            ZipOutputStream(BufferedOutputStream(FileOutputStream(outputZipFile))).use { zos ->
+                saveFolder.walkTopDown().forEach { file ->
+                    val zipFileName =
+                        file.absolutePath.removePrefix(savesFolderRoot).removePrefix("/")
+                    if (zipFileName == "")
+                        return@forEach
+                    val entry = ZipEntry("$zipFileName${(if (file.isDirectory) "/" else "")}")
+                    zos.putNextEntry(entry)
+                    if (file.isFile)
+                        file.inputStream().use { fis -> fis.copyTo(zos) }
+                }
+            }
+            lastZipCreated = outputZipFile
+        } catch (e: Exception) {
+            return false
+        }
+        return true
+    }
+
+    /**
+     * Extracts the save files located in the given zip file and copies them to the saves folder.
+     * @exception IOException if the file was being created outside of the target directory
+     */
+    private fun unzip(zipStream: InputStream, destDir: File): Boolean {
+        val zis = ZipInputStream(BufferedInputStream(zipStream))
+        var entry: ZipEntry? = zis.nextEntry
+        while (entry != null) {
+            val entryName = entry.name
+            val entryFile = File(destDir, entryName)
+            if (!entryFile.canonicalPath.startsWith(destDir.canonicalPath + File.separator)) {
+                zis.close()
+                throw IOException("Entry is outside of the target dir: " + entryFile.name)
+            }
+            if (entry.isDirectory) {
+                entryFile.mkdirs()
+            } else {
+                entryFile.parentFile?.mkdirs()
+                entryFile.createNewFile()
+                entryFile.outputStream().use { fos -> zis.copyTo(fos) }
+            }
+            entry = zis.nextEntry
+        }
+        zis.close()
+        return true
+    }
+
+    /**
+     * Exports the save file located in the given folder path by creating a zip file and sharing it via intent.
+     */
+    private fun exportSave() {
+        CoroutineScope(Dispatchers.IO).launch {
+            val wasZipCreated = zipSave()
+            val lastZipFile = lastZipCreated
+            if (!wasZipCreated || lastZipFile == null) {
+                withContext(Dispatchers.Main) {
+                    Toast.makeText(context, "Failed to export save", Toast.LENGTH_LONG).show()
+                }
+                return@launch
+            }
+
+            withContext(Dispatchers.Main) {
+                val file = DocumentFile.fromSingleUri(
+                    context, DocumentsContract.buildDocumentUri(
+                        DocumentProvider.AUTHORITY,
+                        "${DocumentProvider.ROOT_ID}/temp/${lastZipCreated?.name}"
+                    )
+                )!!
+                val intent = Intent(Intent.ACTION_SEND)
+                    .setDataAndType(file.uri, "application/zip")
+                    .addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION)
+                    .putExtra(Intent.EXTRA_STREAM, file.uri)
+                startForResultExportSave.launch(Intent.createChooser(intent, "Share save file"))
+            }
+        }
+    }
+
+    /**
+     * Imports the save files contained in the zip file, and replaces any existing ones with the new save file.
+     * @param zipUri The Uri of the zip file containing the save file(s) to import.
+     */
+    private fun importSave(zipUri: Uri) {
+        val inputZip = context.contentResolver.openInputStream(zipUri)
+        // A zip needs to have at least one subfolder named after a TitleId in order to be considered valid.
+        var validZip = false
+        val savesFolder = File(savesFolderRoot)
+        val cacheSaveDir = File("${context.cacheDir.path}/saves/")
+        cacheSaveDir.mkdir()
+
+        if (inputZip == null) {
+            Toast.makeText(context, context.getString(R.string.fatal_error), Toast.LENGTH_LONG)
+                .show()
+            return
+        }
+
+        val filterTitleId =
+            FilenameFilter { _, dirName -> dirName.matches(Regex("^0100[\\dA-Fa-f]{12}$")) }
+
+        try {
+            CoroutineScope(Dispatchers.IO).launch {
+                unzip(inputZip, cacheSaveDir)
+                cacheSaveDir.list(filterTitleId)?.forEach { savePath ->
+                    File(savesFolder, savePath).deleteRecursively()
+                    File(cacheSaveDir, savePath).copyRecursively(File(savesFolder, savePath), true)
+                    validZip = true
+                }
+
+                withContext(Dispatchers.Main) {
+                    if (!validZip) {
+                        Toast.makeText(
+                            context,
+                            context.getString(R.string.save_file_invalid_zip_structure),
+                            Toast.LENGTH_LONG
+                        ).show()
+                        return@withContext
+                    }
+                    Toast.makeText(
+                        context,
+                        context.getString(R.string.save_file_imported_success),
+                        Toast.LENGTH_LONG
+                    ).show()
+                }
+
+                cacheSaveDir.deleteRecursively()
+            }
+        } catch (e: Exception) {
+            Toast.makeText(context, context.getString(R.string.fatal_error), Toast.LENGTH_LONG)
+                .show()
+        }
+    }
+
+    companion object {
+        const val TAG = "ImportExportSavesFragment"
+    }
+}
diff --git a/src/android/app/src/main/res/drawable/ic_save.xml b/src/android/app/src/main/res/drawable/ic_save.xml
new file mode 100644
index 000000000..a9af3d9cf
--- /dev/null
+++ b/src/android/app/src/main/res/drawable/ic_save.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="960"
+    android:viewportHeight="960"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M200,840Q167,840 143.5,816.5Q120,793 120,760L120,200Q120,167 143.5,143.5Q167,120 200,120L647,120Q663,120 677.5,126Q692,132 703,143L817,257Q828,268 834,282.5Q840,297 840,313L840,760Q840,793 816.5,816.5Q793,840 760,840L200,840ZM760,314L646,200L200,200Q200,200 200,200Q200,200 200,200L200,760Q200,760 200,760Q200,760 200,760L760,760Q760,760 760,760Q760,760 760,760L760,314ZM480,720Q530,720 565,685Q600,650 600,600Q600,550 565,515Q530,480 480,480Q430,480 395,515Q360,550 360,600Q360,650 395,685Q430,720 480,720ZM280,400L560,400Q577,400 588.5,388.5Q600,377 600,360L600,280Q600,263 588.5,251.5Q577,240 560,240L280,240Q263,240 251.5,251.5Q240,263 240,280L240,360Q240,377 251.5,388.5Q263,400 280,400ZM200,314L200,760Q200,760 200,760Q200,760 200,760L200,760Q200,760 200,760Q200,760 200,760L200,200Q200,200 200,200Q200,200 200,200L200,200L200,314Z"/>
+</vector>
diff --git a/src/android/app/src/main/res/values/strings.xml b/src/android/app/src/main/res/values/strings.xml
index cffa3ff0b..9754dccd7 100644
--- a/src/android/app/src/main/res/values/strings.xml
+++ b/src/android/app/src/main/res/values/strings.xml
@@ -80,6 +80,10 @@
     <string name="no_file_manager">No file manager found</string>
     <string name="notification_no_directory_link">Could not open yuzu directory</string>
     <string name="notification_no_directory_link_description">Please locate the user folder with the file manager\'s side panel manually.</string>
+    <string name="import_export_saves">Import/Export Saves</string>
+    <string name="import_export_saves_description">Import or export save files</string>
+    <string name="save_file_imported_success">The save files were imported successfully</string>
+    <string name="save_file_invalid_zip_structure">Invalid Zip directory structure: the first subfolder name must be the Title ID of the game.</string>
 
     <!-- About screen strings -->
     <string name="gaia_is_not_real">Gaia isn\'t real</string>