aboutsummaryrefslogtreecommitdiffstats
path: root/app/src/main/java/dev/msfjarvis/aps/util/settings/Migrations.kt
blob: fc506995494e92e90fe146d7151ffa87c073103e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * Copyright © 2014-2020 The Android Password Store Authors. All Rights Reserved.
 * SPDX-License-Identifier: GPL-3.0-only
 */
@file:Suppress("DEPRECATION")

package dev.msfjarvis.aps.util.settings

import android.content.Context
import android.content.SharedPreferences
import androidx.core.content.edit
import com.github.ajalt.timberkt.e
import com.github.ajalt.timberkt.i
import com.github.michaelbull.result.get
import com.github.michaelbull.result.runCatching
import dev.msfjarvis.aps.util.git.sshj.SshKey
import dev.msfjarvis.aps.util.extensions.getString
import dev.msfjarvis.aps.util.extensions.sharedPrefs
import java.io.File
import java.net.URI

fun runMigrations(context: Context) {
    val sharedPrefs = context.sharedPrefs
    migrateToGitUrlBasedConfig(sharedPrefs)
    migrateToHideAll(sharedPrefs)
    migrateToSshKey(context, sharedPrefs)
}

private fun migrateToGitUrlBasedConfig(sharedPrefs: SharedPreferences) {
    val serverHostname = sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_SERVER)
        ?: return
    i { "Migrating to URL-based Git config" }
    val serverPort = sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_PORT) ?: ""
    val serverUser = sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_USERNAME) ?: ""
    val serverPath = sharedPrefs.getString(PreferenceKeys.GIT_REMOTE_LOCATION) ?: ""
    val protocol = Protocol.fromString(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"
            }
            runCatching {
                if (URI(url).rawAuthority != null)
                    url
                else
                    null
            }.get()
        }
    }

    sharedPrefs.edit {
        remove(PreferenceKeys.GIT_REMOTE_LOCATION)
        remove(PreferenceKeys.GIT_REMOTE_PORT)
        remove(PreferenceKeys.GIT_REMOTE_SERVER)
        remove(PreferenceKeys.GIT_REMOTE_USERNAME)
        remove(PreferenceKeys.GIT_REMOTE_PROTOCOL)
    }
    if (url == null || GitSettings.updateConnectionSettingsIfValid(
            newAuthMode = GitSettings.authMode,
            newUrl = url,
            newBranch = GitSettings.branch) != GitSettings.UpdateConnectionSettingsResult.Valid) {
        e { "Failed to migrate to URL-based Git config, generated URL is invalid" }
    }
}

private fun migrateToHideAll(sharedPrefs: SharedPreferences) {
    sharedPrefs.all[PreferenceKeys.SHOW_HIDDEN_FOLDERS] ?: return
    val isHidden = sharedPrefs.getBoolean(PreferenceKeys.SHOW_HIDDEN_FOLDERS, false)
    sharedPrefs.edit {
        remove(PreferenceKeys.SHOW_HIDDEN_FOLDERS)
        putBoolean(PreferenceKeys.SHOW_HIDDEN_CONTENTS, isHidden)
    }
}

private fun migrateToSshKey(context: Context, sharedPrefs: SharedPreferences) {
    val privateKeyFile = File(context.filesDir, ".ssh_key")
    if (sharedPrefs.contains(PreferenceKeys.USE_GENERATED_KEY) &&
        !SshKey.exists &&
        privateKeyFile.exists()) {
        // Currently uses a private key imported or generated with an old version of Password Store.
        // Generated keys come with a public key which the user should still be able to view after
        // the migration (not possible for regular imported keys), hence the special case.
        val isGeneratedKey = sharedPrefs.getBoolean(PreferenceKeys.USE_GENERATED_KEY, false)
        SshKey.useLegacyKey(isGeneratedKey)
        sharedPrefs.edit {
            remove(PreferenceKeys.USE_GENERATED_KEY)
        }
    }
}