[localserver] add ability to change port and credentials, see #138

capcom6 · capcom6 · commit 6b44548b7758 · 2024-11-30T20:46:45.000+07:00
diff --git a/app/src/main/java/me/capcom/smsgateway/helpers/SettingsHelper.kt b/app/src/main/java/me/capcom/smsgateway/helpers/SettingsHelper.kt
@@ -5,12 +5,15 @@ import android.content.Context
 import android.content.pm.PackageManager
 import androidx.core.content.edit
 import androidx.preference.PreferenceManager
-import com.aventrix.jnanoid.jnanoid.NanoIdUtils
 import me.capcom.smsgateway.receivers.BootReceiver
 
 class SettingsHelper(private val context: Context) {
     private val settings = PreferenceManager.getDefaultSharedPreferences(context)
 
+    init {
+        migrate()
+    }
+
     var autostart: Boolean
         get() = settings.getBoolean(PREF_KEY_AUTOSTART, false)
         set(value) {
@@ -24,30 +27,24 @@ class SettingsHelper(private val context: Context) {
             settings.edit { putBoolean(PREF_KEY_AUTOSTART, value) }
         }
 
-    var serverPort: Int
-        get() = settings.getInt(PREF_KEY_SERVER_PORT, 8080)
-        set(value) = settings.edit { putInt(PREF_KEY_SERVER_PORT, value) }
-
-    var serverToken: String
-        get() = settings.getString(PREF_KEY_SERVER_TOKEN, null)
-            ?: NanoIdUtils.randomNanoId(
-                NanoIdUtils.DEFAULT_NUMBER_GENERATOR,
-                NanoIdUtils.DEFAULT_ALPHABET,
-                8
-            )
-                .also { serverToken = it }
-        set(value) = settings.edit { putString(PREF_KEY_SERVER_TOKEN, value) }
-
     var fcmToken: String?
         get() = settings.getString(PREF_KEY_FCM_TOKEN, null)
         set(value) = settings.edit { putString(PREF_KEY_FCM_TOKEN, value) }
 
+    private fun migrate() {
+        // remove after 2025-11-28
+        val PREF_KEY_SERVER_TOKEN = "server_token"
+        if (settings.contains(PREF_KEY_SERVER_TOKEN)) {
+            settings.edit(true) {
+                putString("localserver.PASSWORD", settings.getString(PREF_KEY_SERVER_TOKEN, null))
+                remove(PREF_KEY_SERVER_TOKEN)
+            }
+        }
+    }
+
     companion object {
         private const val PREF_KEY_AUTOSTART = "autostart"
 
-        private const val PREF_KEY_SERVER_PORT = "server_port"
-        private const val PREF_KEY_SERVER_TOKEN = "server_token"
-
         private const val PREF_KEY_FCM_TOKEN = "fcm_token"
     }
 }
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/localserver/LocalServerSettings.kt b/app/src/main/java/me/capcom/smsgateway/modules/localserver/LocalServerSettings.kt
@@ -1,5 +1,6 @@
 package me.capcom.smsgateway.modules.localserver
 
+import com.aventrix.jnanoid.jnanoid.NanoIdUtils
 import me.capcom.smsgateway.modules.settings.KeyValueStorage
 import me.capcom.smsgateway.modules.settings.get
 
@@ -14,9 +15,26 @@ class LocalServerSettings(
         get() = storage.get<String?>(DEVICE_ID)
         set(value) = storage.set(DEVICE_ID, value)
 
+    val port: Int
+        get() = storage.get<Int>(PORT) ?: 8080
+
+    val username: String
+        get() = storage.get<String?>(USERNAME)
+            ?: "sms"
+    val password: String
+        get() = storage.get<String?>(PASSWORD)
+            ?: NanoIdUtils.randomNanoId(
+                NanoIdUtils.DEFAULT_NUMBER_GENERATOR,
+                NanoIdUtils.DEFAULT_ALPHABET,
+                8
+            ).also { storage.set(PASSWORD, it) }
+
     companion object {
         private const val ENABLED = "ENABLED"
 
         private const val DEVICE_ID = "DEVICE_ID"
+        private const val PORT = "PORT"
+        private const val USERNAME = "USERNAME"
+        private const val PASSWORD = "PASSWORD"
     }
 }
diff --git a/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt b/app/src/main/java/me/capcom/smsgateway/modules/localserver/WebService.kt
@@ -37,7 +37,6 @@ import me.capcom.smsgateway.R
 import me.capcom.smsgateway.domain.EntitySource
 import me.capcom.smsgateway.domain.ProcessingState
 import me.capcom.smsgateway.extensions.configure
-import me.capcom.smsgateway.helpers.SettingsHelper
 import me.capcom.smsgateway.modules.health.HealthService
 import me.capcom.smsgateway.modules.health.domain.Status
 import me.capcom.smsgateway.modules.localserver.domain.Device
@@ -55,7 +54,7 @@ import kotlin.concurrent.thread
 
 class WebService : Service() {
 
-    private val settingsHelper: SettingsHelper by inject()
+    private val settings: LocalServerSettings by inject()
     private val messagesService: MessagesService by inject()
     private val notificationsService: NotificationsService by inject()
     private val healthService: HealthService by inject()
@@ -75,17 +74,20 @@ class WebService : Service() {
     private val server by lazy {
         embeddedServer(
             Netty,
-            port = settingsHelper.serverPort,
+            port = port,
             watchPaths = emptyList(),
         ) {
             install(Authentication) {
                 basic("auth-basic") {
                     realm = "Access to SMS Gateway"
                     validate { credentials ->
-                        if (credentials.name == "sms" && credentials.password == settingsHelper.serverToken) {
-                            UserIdPrincipal(credentials.name)
-                        } else {
-                            null
+                        when {
+                            credentials.name == username
+                                    && credentials.password == password -> UserIdPrincipal(
+                                credentials.name
+                            )
+
+                            else -> null
                         }
                     }
                 }
@@ -271,6 +273,10 @@ class WebService : Service() {
         }
     }
 
+    private val port = settings.port
+    private val username = settings.username
+    private val password = settings.password
+
     override fun onCreate() {
         super.onCreate()
 
@@ -287,7 +293,7 @@ class WebService : Service() {
             NotificationsService.NOTIFICATION_ID_LOCAL_SERVICE,
             getString(
                 R.string.sms_gateway_is_running_on_port,
-                settingsHelper.serverPort
+                port
             )
         )
 
diff --git a/app/src/main/java/me/capcom/smsgateway/ui/HomeFragment.kt b/app/src/main/java/me/capcom/smsgateway/ui/HomeFragment.kt
@@ -71,17 +71,6 @@ class HomeFragment : Fragment() {
         binding.textLocalUsername.movementMethod = LinkMovementMethod.getInstance()
         binding.textLocalPassword.movementMethod = LinkMovementMethod.getInstance()
 
-        binding.textLocalUsername.text = makeCopyableLink(
-            Html.fromHtml(
-                "<a href>sms</a>"
-            )
-        )
-        binding.textLocalPassword.text = makeCopyableLink(
-            Html.fromHtml(
-                "<a href>${settingsHelper.serverToken}</a>"
-            )
-        )
-
         binding.switchAutostart.isChecked = settingsHelper.autostart
 
         binding.switchAutostart.setOnCheckedChangeListener { _, isChecked ->
@@ -132,13 +121,24 @@ class HomeFragment : Fragment() {
 
         viewLifecycleOwner.lifecycleScope.launch {
             events.collect<IPReceivedEvent> { event ->
+                binding.textLocalUsername.text = makeCopyableLink(
+                    Html.fromHtml(
+                        "<a href>${localServerSettings.username}</a>"
+                    )
+                )
+                binding.textLocalPassword.text = makeCopyableLink(
+                    Html.fromHtml(
+                        "<a href>${localServerSettings.password}</a>"
+                    )
+                )
+
                 binding.textLocalIP.text = event.localIP?.let {
                     makeCopyableLink(
                         Html.fromHtml(
                             getString(
                                 R.string.settings_local_address_is,
                                 event.localIP,
-                                settingsHelper.serverPort
+                                localServerSettings.port
                             )
                         )
                     )
@@ -151,7 +151,7 @@ class HomeFragment : Fragment() {
                             getString(
                                 R.string.settings_public_address_is,
                                 event.publicIP,
-                                settingsHelper.serverPort
+                                localServerSettings.port
                             )
                         )
                     )
diff --git a/app/src/main/java/me/capcom/smsgateway/ui/settings/LocalServerSettingsFragment.kt b/app/src/main/java/me/capcom/smsgateway/ui/settings/LocalServerSettingsFragment.kt
@@ -0,0 +1,93 @@
+package me.capcom.smsgateway.ui.settings
+
+import android.os.Bundle
+import android.text.InputType
+import android.util.TypedValue
+import android.view.View
+import android.widget.Toast
+import androidx.preference.EditTextPreference
+import androidx.preference.Preference
+import androidx.preference.PreferenceFragmentCompat
+import me.capcom.smsgateway.R
+
+class LocalServerSettingsFragment : PreferenceFragmentCompat() {
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+
+        val backgroundValue = TypedValue()
+        requireContext().theme.resolveAttribute(
+            android.R.attr.colorBackground,
+            backgroundValue,
+            true
+        )
+
+        view.setBackgroundColor(backgroundValue.data)
+    }
+
+    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
+        setPreferencesFromResource(R.xml.local_server_preferences, rootKey)
+
+        findPreference<EditTextPreference>("localserver.PORT")?.setOnPreferenceChangeListener { _, newValue ->
+            val value = newValue as? String
+            val intValue = value?.toIntOrNull()
+            if (intValue == null || intValue < 1024 || intValue > 65535) {
+                showToast(
+                    getString(
+                        R.string.is_not_a_valid_port_must_be_between_1024_and_65535,
+                        value
+                    )
+                )
+                return@setOnPreferenceChangeListener false
+            }
+
+            true
+        }
+
+        findPreference<EditTextPreference>("localserver.USERNAME")?.setOnPreferenceChangeListener { _, newValue ->
+            val value = newValue as? String
+            if ((value?.length ?: 0) < 3) {
+                showToast(getString(R.string.username_must_be_at_least_3_characters))
+                return@setOnPreferenceChangeListener false
+            }
+
+            true
+        }
+        findPreference<EditTextPreference>("localserver.PASSWORD")?.setOnPreferenceChangeListener { _, newValue ->
+            val value = newValue as? String
+            if ((value?.length ?: 0) < 8) {
+                showToast(getString(R.string.password_must_be_at_least_8_characters))
+                return@setOnPreferenceChangeListener false
+            }
+
+            true
+        }
+    }
+
+    override fun onDisplayPreferenceDialog(preference: Preference) {
+        if (preference.key == "localserver.PORT"
+        ) {
+            (preference as EditTextPreference).setOnBindEditTextListener {
+                it.inputType = InputType.TYPE_CLASS_NUMBER
+                it.setSelectAllOnFocus(true)
+                it.selectAll()
+            }
+        }
+
+        if (preference.key == "localserver.PASSWORD"
+            || preference.key == "localserver.USERNAME"
+        ) {
+            (preference as EditTextPreference).setOnBindEditTextListener {
+                it.inputType = InputType.TYPE_CLASS_TEXT
+                it.setSelectAllOnFocus(true)
+                it.selectAll()
+            }
+        }
+
+        super.onDisplayPreferenceDialog(preference)
+    }
+
+    private fun showToast(message: String) {
+        Toast.makeText(requireContext(), message, Toast.LENGTH_SHORT).show()
+    }
+}
diff --git a/app/src/main/res/drawable-notnight/ic_password.xml b/app/src/main/res/drawable-notnight/ic_password.xml
@@ -0,0 +1,12 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="#000000"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M2,17h20v2H2V17zM3.15,12.95L4,11.47l0.85,1.48l1.3,-0.75L5.3,10.72H7v-1.5H5.3l0.85,-1.47L4.85,7L4,8.47L3.15,7l-1.3,0.75L2.7,9.22H1v1.5h1.7L1.85,12.2L3.15,12.95zM9.85,12.2l1.3,0.75L12,11.47l0.85,1.48l1.3,-0.75l-0.85,-1.48H15v-1.5h-1.7l0.85,-1.47L12.85,7L12,8.47L11.15,7l-1.3,0.75l0.85,1.47H9v1.5h1.7L9.85,12.2zM23,9.22h-1.7l0.85,-1.47L20.85,7L20,8.47L19.15,7l-1.3,0.75l0.85,1.47H17v1.5h1.7l-0.85,1.48l1.3,0.75L20,11.47l0.85,1.48l1.3,-0.75l-0.85,-1.48H23V9.22z" />
+
+</vector>
diff --git a/app/src/main/res/drawable-notnight/ic_username.xml b/app/src/main/res/drawable-notnight/ic_username.xml
@@ -0,0 +1,12 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:tint="#000000"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M12,12c2.21,0 4,-1.79 4,-4s-1.79,-4 -4,-4 -4,1.79 -4,4 1.79,4 4,4zM12,14c-2.67,0 -8,1.34 -8,4v2h16v-2c0,-2.66 -5.33,-4 -8,-4z" />
+
+</vector>
diff --git a/app/src/main/res/drawable/ic_password.xml b/app/src/main/res/drawable/ic_password.xml
@@ -0,0 +1,11 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M2,17h20v2H2V17zM3.15,12.95L4,11.47l0.85,1.48l1.3,-0.75L5.3,10.72H7v-1.5H5.3l0.85,-1.47L4.85,7L4,8.47L3.15,7l-1.3,0.75L2.7,9.22H1v1.5h1.7L1.85,12.2L3.15,12.95zM9.85,12.2l1.3,0.75L12,11.47l0.85,1.48l1.3,-0.75l-0.85,-1.48H15v-1.5h-1.7l0.85,-1.47L12.85,7L12,8.47L11.15,7l-1.3,0.75l0.85,1.47H9v1.5h1.7L9.85,12.2zM23,9.22h-1.7l0.85,-1.47L20.85,7L20,8.47L19.15,7l-1.3,0.75l0.85,1.47H17v1.5h1.7l-0.85,1.48l1.3,0.75L20,11.47l0.85,1.48l1.3,-0.75l-0.85,-1.48H23V9.22z" />
+
+</vector>
diff --git a/app/src/main/res/drawable/ic_username.xml b/app/src/main/res/drawable/ic_username.xml
@@ -0,0 +1,11 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M12,12c2.21,0 4,-1.79 4,-4s-1.79,-4 -4,-4 -4,1.79 -4,4 1.79,4 4,4zM12,14c-2.67,0 -8,1.34 -8,4v2h16v-2c0,-2.66 -5.33,-4 -8,-4z" />
+
+</vector>
diff --git a/app/src/main/res/layout/fragment_settings.xml b/app/src/main/res/layout/fragment_settings.xml
@@ -71,7 +71,7 @@
                     android:layout_height="wrap_content"
                     android:layout_gravity="end"
                     android:layout_margin="4dp"
-                    android:text="@string/username" />
+                    android:text="@string/label_username" />
 
                 <TextView
                     android:id="@+id/textLocalUsername"
@@ -87,7 +87,7 @@
                     android:layout_height="wrap_content"
                     android:layout_gravity="end"
                     android:layout_margin="4dp"
-                    android:text="@string/password" />
+                    android:text="@string/label_password" />
 
                 <TextView
                     android:id="@+id/textLocalPassword"
@@ -137,7 +137,7 @@
                     android:layout_height="wrap_content"
                     android:layout_gravity="end"
                     android:layout_margin="4dp"
-                    android:text="@string/username" />
+                    android:text="@string/label_username" />
 
                 <TextView
                     android:id="@+id/textRemoteUsername"
@@ -152,7 +152,7 @@
                     android:layout_height="wrap_content"
                     android:layout_gravity="end"
                     android:layout_margin="4dp"
-                    android:text="@string/password" />
+                    android:text="@string/label_password" />
 
                 <TextView
                     android:id="@+id/textRemotePassword"
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
diff --git a/app/src/main/res/xml/local_server_preferences.xml b/app/src/main/res/xml/local_server_preferences.xml
diff --git a/app/src/main/res/xml/root_preferences.xml b/app/src/main/res/xml/root_preferences.xml
