Switch to URL-based Git config and refactor Git settings (#1008)

* Make Git config URL-based and refactor

* Use Kotlin style null handling for string prefs

* Also show an error if generated URL can't be parsed

* Add some testcases for migration strategy

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>

Co-authored-by: Harsh Shandilya <me@msfjarvis.dev>

1 files changed, 83 insertions, 0 deletions

diff --git a/app/src/main/java/com/zeapo/pwdstore/Migrations.kt b/app/src/main/java/com/zeapo/pwdstore/Migrations.kt
new file mode 100644
index 00000000..1e1943d8
--- /dev/null
+++ b/app/src/main/java/com/zeapo/pwdstore/Migrations.kt
@@ -0,0 +1,83 @@
+/*
+ * Copyright © 2014-2020 The Android Password Store Authors. All Rights Reserved.
+ * SPDX-License-Identifier: GPL-3.0-only
+ */
+@file:Suppress("DEPRECATION")
+
+package com.zeapo.pwdstore
+
+import android.content.Context
+import androidx.core.content.edit
+import com.github.ajalt.timberkt.e
+import com.github.ajalt.timberkt.i
+import com.zeapo.pwdstore.git.config.GitSettings
+import com.zeapo.pwdstore.git.config.Protocol
+import com.zeapo.pwdstore.utils.PreferenceKeys
+import com.zeapo.pwdstore.utils.getString
+import com.zeapo.pwdstore.utils.sharedPrefs
+import java.net.URI
+
+fun runMigrations(context: Context) {
+    migrateToGitUrlBasedConfig(context)
+}
+
+private fun migrateToGitUrlBasedConfig(context: Context) {
+    val serverHostname = context.sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_SERVER)
+        ?: return
+    i { "Migrating to URL-based Git config" }
+    val serverPort = context.sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_PORT) ?: ""
+    val serverUser = context.sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_USERNAME) ?: ""
+    val serverPath = context.sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_LOCATION) ?: ""
+    val protocol = Protocol.fromString(context.sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_PROTOCOL))
+
+    // Whether we need the leading ssh:// depends on the use of a custom port.
+    val hostnamePart = serverHostname.removePrefix("ssh://")
+    val url = when (protocol) {
+        Protocol.Ssh -> {
+            val userPart = if (serverUser.isEmpty()) "" else "${serverUser.trimEnd('@')}@"
+            val portPart =
+                if (serverPort == "22" || serverPort.isEmpty()) "" else ":$serverPort"
+            if (portPart.isEmpty()) {
+                "$userPart$hostnamePart:$serverPath"
+            } else {
+                // Only absolute paths are supported with custom ports.
+                if (!serverPath.startsWith('/'))
+                    null
+                else
+                    // We have to specify the ssh scheme as this is the only way to pass a custom
+                    // port.
+                    "ssh://$userPart$hostnamePart$portPart$serverPath"
+            }
+        }
+        Protocol.Https -> {
+            val portPart =
+                if (serverPort == "443" || serverPort.isEmpty()) "" else ":$serverPort"
+            val pathPart = serverPath.trimStart('/', ':')
+            val urlWithFreeEntryScheme = "$hostnamePart$portPart/$pathPart"
+            val url = when {
+                urlWithFreeEntryScheme.startsWith("https://") -> urlWithFreeEntryScheme
+                urlWithFreeEntryScheme.startsWith("http://") -> urlWithFreeEntryScheme.replaceFirst("http", "https")
+                else -> "https://$urlWithFreeEntryScheme"
+            }
+            try {
+                if (URI(url).rawAuthority != null)
+                    url
+                else
+                    null
+            } catch (_: Exception) {
+                null
+            }
+        }
+    }
+
+    context.sharedPrefs.edit {
+        remove(PreferenceKeys.GIT_REMOTE_LOCATION)
+        remove(PreferenceKeys.GIT_REMOTE_PORT)
+        remove(PreferenceKeys.GIT_REMOTE_SERVER)
+        remove(PreferenceKeys.GIT_REMOTE_USERNAME)
+    }
+    if (url == null || !GitSettings.updateUrlIfValid(url)) {
+        e { "Failed to migrate to URL-based Git config, generated URL is invalid" }
+    }
+}
+