fix: file import handling

Fixes bug causing crashes when importing a file that is not a .conf file. Fixes file import on AndroidTV and FireTV Closes #39 Fixes usability issue on AndroidTV where textboxes immediately open the keyboard on hover. Allows users two keypress access to turning on tunnels from app load. Closes #36 Improves service efficiencies by making coroutines lifecycle aware.
zaneschepke · Oct 13, 2023 · 3217305 · 3217305
1 parent 2912238
commit 3217305
Show file tree

Hide file tree

Showing 18 changed files with 246 additions and 193 deletions.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -14,8 +14,8 @@ android {
         applicationId = "com.zaneschepke.wireguardautotunnel"
         minSdk = 26
         targetSdk = 34
-        versionCode = 31000
-        versionName = "3.1.0"
+        versionCode = 31100
+        versionName = "3.1.1"
 
         multiDexEnabled = true
 
@@ -81,6 +81,8 @@ val generalImplementation by configurations
 dependencies {
     implementation(libs.androidx.core.ktx)
     implementation(libs.androidx.lifecycle.runtime.ktx)
+    // optional - helpers for implementing LifecycleOwner in a Service
+    implementation(libs.androidx.lifecycle.service)
     implementation(libs.androidx.activity.compose)
     implementation(platform(libs.androidx.compose.bom))
     implementation(libs.androidx.compose.ui)

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/Constants.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/Constants.kt
@@ -12,5 +12,6 @@ object Constants {
     const val URI_CONTENT_SCHEME = "content"
     const val URI_PACKAGE_SCHEME = "package"
     const val ALLOWED_FILE_TYPES = "*/*"
-    const val ANDROID_TV_STUBS = "com.google.android.tv.frameworkpackagestubs"
+    const val GOOGLE_TV_EXPLORER_STUB = "com.google.android.tv.frameworkpackagestubs"
+    const val ANDROID_TV_EXPLORER_STUB = "com.android.tv.frameworkpackagestubs"
 }
diff --git a/...src/main/java/com/zaneschepke/wireguardautotunnel/service/foreground/ForegroundService.kt b/...src/main/java/com/zaneschepke/wireguardautotunnel/service/foreground/ForegroundService.kt
@@ -1,22 +1,24 @@
 package com.zaneschepke.wireguardautotunnel.service.foreground
 
-import android.app.Service
 import android.content.Intent
 import android.os.Bundle
 import android.os.IBinder
+import androidx.lifecycle.LifecycleService
 import timber.log.Timber
 
 
-open class ForegroundService : Service() {
+open class ForegroundService : LifecycleService() {
 
     private var isServiceStarted = false
 
     override fun onBind(intent: Intent): IBinder? {
+        super.onBind(intent)
         // We don't provide binding, so return null
         return null
     }
 
     override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
+        super.onStartCommand(intent, flags, startId)
         Timber.d("onStartCommand executed with startId: $startId")
         if (intent != null) {
             val action = intent.action

diff --git a/...zaneschepke/wireguardautotunnel/service/foreground/WireGuardConnectivityWatcherService.kt b/...zaneschepke/wireguardautotunnel/service/foreground/WireGuardConnectivityWatcherService.kt
@@ -7,6 +7,7 @@ import android.content.Intent
 import android.os.Bundle
 import android.os.PowerManager
 import android.os.SystemClock
+import androidx.lifecycle.lifecycleScope
 import com.wireguard.android.backend.Tunnel
 import com.zaneschepke.wireguardautotunnel.Constants
 import com.zaneschepke.wireguardautotunnel.R
@@ -66,7 +67,7 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
 
     override fun onCreate() {
         super.onCreate()
-        CoroutineScope(Dispatchers.Main).launch {
+        lifecycleScope.launch(Dispatchers.Main) {
             launchWatcherNotification()
         }
     }
@@ -122,6 +123,9 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
         wakeLock =
             (getSystemService(Context.POWER_SERVICE) as PowerManager).run {
                 newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "$tag::lock").apply {
+                    //TODO decide what to do here with the wakelock
+                    //this is draining battery. Perhaps users only care for VPN to connect when their screen is on
+                    //and they are actively using apps
                     acquire()
                 }
             }
@@ -134,7 +138,7 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
     }
 
     private fun startWatcherJob() {
-        watcherJob = CoroutineScope(Dispatchers.IO).launch {
+        watcherJob = lifecycleScope.launch(Dispatchers.IO) {
             val settings = settingsRepo.getAll();
             if(settings.isNotEmpty()) {
                 setting = settings[0]

diff --git a/...ain/java/com/zaneschepke/wireguardautotunnel/service/foreground/WireGuardTunnelService.kt b/...ain/java/com/zaneschepke/wireguardautotunnel/service/foreground/WireGuardTunnelService.kt
@@ -3,6 +3,7 @@ package com.zaneschepke.wireguardautotunnel.service.foreground
 import android.app.PendingIntent
 import android.content.Intent
 import android.os.Bundle
+import androidx.lifecycle.lifecycleScope
 import com.zaneschepke.wireguardautotunnel.R
 import com.zaneschepke.wireguardautotunnel.receiver.NotificationActionReceiver
 import com.zaneschepke.wireguardautotunnel.repository.SettingsDoa
@@ -38,7 +39,7 @@ class WireGuardTunnelService : ForegroundService() {
 
     override fun onCreate() {
         super.onCreate()
-        CoroutineScope(Dispatchers.Main).launch {
+        lifecycleScope.launch(Dispatchers.Main) {
             launchVpnStartingNotification()
         }
     }
@@ -48,7 +49,7 @@ class WireGuardTunnelService : ForegroundService() {
         launchVpnStartingNotification()
         val tunnelConfigString = extras?.getString(getString(R.string.tunnel_extras_key))
         cancelJob()
-        job = CoroutineScope(Dispatchers.IO).launch {
+        job = lifecycleScope.launch(Dispatchers.IO) {
             if(tunnelConfigString != null) {
                 try {
                     val tunnelConfig = TunnelConfig.from(tunnelConfigString)
@@ -70,32 +71,32 @@ class WireGuardTunnelService : ForegroundService() {
                     }
                 }
             }
-        }
-        CoroutineScope(job).launch {
-            var didShowConnected = false
-            var didShowFailedHandshakeNotification = false
-            vpnService.handshakeStatus.collect {
-                when(it) {
-                    HandshakeStatus.NOT_STARTED -> {
-                    }
-                    HandshakeStatus.NEVER_CONNECTED -> {
-                        if(!didShowFailedHandshakeNotification) {
-                            launchVpnConnectionFailedNotification(getString(R.string.initial_connection_failure_message))
-                            didShowFailedHandshakeNotification = true
-                            didShowConnected = false
+            launch {
+                var didShowConnected = false
+                var didShowFailedHandshakeNotification = false
+                vpnService.handshakeStatus.collect {
+                    when(it) {
+                        HandshakeStatus.NOT_STARTED -> {
                         }
-                    }
-                    HandshakeStatus.HEALTHY -> {
-                        if(!didShowConnected) {
-                            launchVpnConnectedNotification()
-                            didShowConnected = true
+                        HandshakeStatus.NEVER_CONNECTED -> {
+                            if(!didShowFailedHandshakeNotification) {
+                                launchVpnConnectionFailedNotification(getString(R.string.initial_connection_failure_message))
+                                didShowFailedHandshakeNotification = true
+                                didShowConnected = false
+                            }
                         }
-                    }
-                    HandshakeStatus.UNHEALTHY -> {
-                        if(!didShowFailedHandshakeNotification) {
-                            launchVpnConnectionFailedNotification(getString(R.string.lost_connection_failure_message))
-                            didShowFailedHandshakeNotification = true
-                            didShowConnected = false
+                        HandshakeStatus.HEALTHY -> {
+                            if(!didShowConnected) {
+                                launchVpnConnectedNotification()
+                                didShowConnected = true
+                            }
+                        }
+                        HandshakeStatus.UNHEALTHY -> {
+                            if(!didShowFailedHandshakeNotification) {
+                                launchVpnConnectionFailedNotification(getString(R.string.lost_connection_failure_message))
+                                didShowFailedHandshakeNotification = true
+                                didShowConnected = false
+                            }
                         }
                     }
                 }
@@ -105,7 +106,7 @@ class WireGuardTunnelService : ForegroundService() {
 
     override fun stopService(extras : Bundle?) {
         super.stopService(extras)
-        CoroutineScope(Dispatchers.IO).launch {
+        lifecycleScope.launch(Dispatchers.IO) {
             vpnService.stopTunnel()
         }
         cancelJob()

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/shortcut/ShortcutsActivity.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/shortcut/ShortcutsActivity.kt
@@ -13,6 +13,7 @@ import com.zaneschepke.wireguardautotunnel.util.WgTunnelException
 import dagger.hilt.android.AndroidEntryPoint
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.cancel
 import kotlinx.coroutines.launch
 import timber.log.Timber
 import javax.inject.Inject
@@ -62,6 +63,11 @@ class ShortcutsActivity : ComponentActivity() {
         finish()
     }
 
+    override fun onDestroy() {
+        super.onDestroy()
+        scope.cancel()
+    }
+
     private suspend fun getSettings() : Settings {
         val settings = settingsRepo.getAll()
         return if (settings.isNotEmpty()) {

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tile/TunnelControlTile.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tile/TunnelControlTile.kt
@@ -55,6 +55,11 @@ class TunnelControlTile : TileService() {
         cancelJob()
     }
 
+    override fun onDestroy() {
+        super.onDestroy()
+        scope.cancel()
+    }
+
     override fun onClick() {
         super.onClick()
         unlockAndRun {

diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tunnel/WireGuardTunnel.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/service/tunnel/WireGuardTunnel.kt
@@ -11,6 +11,7 @@ import com.zaneschepke.wireguardautotunnel.util.NumberUtils
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
+import kotlinx.coroutines.cancel
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.MutableSharedFlow
@@ -46,6 +47,8 @@ class WireGuardTunnel @Inject constructor(private val backend : Backend,
     override val handshakeStatus: SharedFlow<HandshakeStatus>
         get() = _handshakeStatus.asSharedFlow()
 
+    private val scope = CoroutineScope(Dispatchers.IO);
+
     private lateinit var statsJob : Job
 
 
@@ -70,11 +73,12 @@ class WireGuardTunnel @Inject constructor(private val backend : Backend,
         return _tunnelName.value
     }
 
-    override suspend  fun stopTunnel() {
+    override suspend fun stopTunnel() {
         try {
             if(getState() == Tunnel.State.UP) {
                 val state = backend.setState(this, Tunnel.State.DOWN, null)
                 _state.emit(state)
+                scope.cancel()
             }
         } catch (e : BackendException) {
             Timber.e("Failed to stop tunnel with error: ${e.message}")
@@ -89,7 +93,7 @@ class WireGuardTunnel @Inject constructor(private val backend : Backend,
         val tunnel = this;
         _state.tryEmit(state)
         if(state == Tunnel.State.UP) {
-            statsJob = CoroutineScope(Dispatchers.IO).launch {
+            statsJob = scope.launch {
                 val handshakeMap = HashMap<Key, Long>()
                 var neverHadHandshakeCounter = 0
                 while (true) {
@@ -128,4 +132,6 @@ class WireGuardTunnel @Inject constructor(private val backend : Backend,
             _lastHandshake.tryEmit(emptyMap())
         }
     }
+
+
 }
diff --git a/app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/ViewState.kt b/app/src/main/java/com/zaneschepke/wireguardautotunnel/ui/ViewState.kt
diff --git a/...rc/main/java/com/zaneschepke/wireguardautotunnel/ui/common/config/ConfigurationTextBox.kt b/...rc/main/java/com/zaneschepke/wireguardautotunnel/ui/common/config/ConfigurationTextBox.kt
@@ -12,7 +12,7 @@ import androidx.compose.ui.text.input.KeyboardCapitalization
 
 @Composable
 fun
-        ConfigurationTextBox(value : String, hint : String, onValueChange : (String) -> Unit, label : String, onDone : () -> Unit, modifier: Modifier) {
+        ConfigurationTextBox(value : String, hint : String, onValueChange : (String) -> Unit, keyboardActions : KeyboardActions, label : String, modifier: Modifier) {
    OutlinedTextField(
         modifier = modifier,
         value = value,
@@ -29,10 +29,6 @@ fun
             capitalization = KeyboardCapitalization.None,
             imeAction = ImeAction.Done
         ),
-        keyboardActions = KeyboardActions(
-            onDone = {
-                onDone()
-            }
-        ),
+        keyboardActions = keyboardActions,
     )
 }
diff --git a/...src/main/java/com/zaneschepke/wireguardautotunnel/ui/common/config/ConfigurationToggle.kt b/...src/main/java/com/zaneschepke/wireguardautotunnel/ui/common/config/ConfigurationToggle.kt
@@ -1,7 +1,6 @@
 package com.zaneschepke.wireguardautotunnel.ui.common.config
 
 import androidx.compose.foundation.layout.Arrangement
-import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.padding
@@ -14,7 +13,7 @@ import androidx.compose.ui.unit.Dp
 
 @Composable
 fun ConfigurationToggle(label : String, enabled : Boolean, checked : Boolean, padding : Dp,
-                        onCheckChanged : () -> Unit) {
+                        onCheckChanged : () -> Unit, modifier : Modifier = Modifier) {
     Row(
         modifier = Modifier
             .fillMaxWidth()
@@ -24,6 +23,7 @@ fun ConfigurationToggle(label : String, enabled : Boolean, checked : Boolean, pa
     ) {
         Text(label)
         Switch(
+            modifier = modifier,
             enabled = enabled,
             checked = checked,
             onCheckedChange = {