feat: mobile data only auto-tunneling

Added support for configuring auto-tunneling to only tunnel on mobile data with no location permissions necessary. Improved UI on support screen and updated support resource links. Changed UI on setting screen to hide trusted wifi networks configuration when not in use. Changed verbiage on settings screen to make auto-tunneling configuration more intuitive. Fixed UI bug where analytics expansion could show on deactivated tunnels. Closes #55 Closes #56
2026-07-03 14:07:49 +02:00 · 2023-12-05 01:14:19 -05:00
parent ff87bee3b4
commit 16e65aec9f
14 changed files with 374 additions and 110 deletions
@@ -16,4 +16,5 @@ object Constants {
    const val ALLOWED_FILE_TYPES = "*/*"
    const val GOOGLE_TV_EXPLORER_STUB = "com.google.android.tv.frameworkpackagestubs"
    const val ANDROID_TV_EXPLORER_STUB = "com.android.tv.frameworkpackagestubs"
+    const val EMAIL_MIME_TYPE = "message/rfc822"
 }
@@ -7,8 +7,8 @@ import androidx.room.TypeConverters
 import com.zaneschepke.wireguardautotunnel.repository.model.Settings
 import com.zaneschepke.wireguardautotunnel.repository.model.TunnelConfig

-@Database(entities = [Settings::class, TunnelConfig::class], version = 2, autoMigrations = [
-    AutoMigration(from = 1, to = 2)
+@Database(entities = [Settings::class, TunnelConfig::class], version = 3, autoMigrations = [
+    AutoMigration(from = 1, to = 2), AutoMigration(from = 2, to = 3)
 ], exportSchema = true)
@TypeConverters(DatabaseListConverters::class)
 abstract class AppDatabase : RoomDatabase() {
@@ -15,6 +15,7 @@ data class Settings(
    @ColumnInfo(name = "is_tunnel_on_ethernet_enabled") var isTunnelOnEthernetEnabled : Boolean = false,
    @ColumnInfo(name = "is_shortcuts_enabled", defaultValue = "false") var isShortcutsEnabled : Boolean = false,
    @ColumnInfo(name = "is_battery_saver_enabled", defaultValue = "false") var isBatterySaverEnabled : Boolean = false,
+    @ColumnInfo(name = "is_tunnel_on_wifi_enabled", defaultValue = "false") var isTunnelOnWifiEnabled : Boolean = false,
 ) {
    fun isTunnelConfigDefault(tunnelConfig: TunnelConfig) : Boolean {
        return if (defaultTunnel != null) {
@@ -261,6 +261,7 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
                ServiceManager.stopVpnService(this)
            } else if (!isEthernetConnected && isWifiConnected &&
                !setting.trustedNetworkSSIDs.contains(currentNetworkSSID) &&
+                setting.isTunnelOnWifiEnabled &&
                (vpnService.getState() != Tunnel.State.UP)
            ) {
                ServiceManager.startVpnService(this, tunnelConfig)
@@ -269,6 +270,11 @@ class WireGuardConnectivityWatcherService : ForegroundService() {
                (vpnService.getState() == Tunnel.State.UP)
            ) {
                ServiceManager.stopVpnService(this)
+            } else if (!isEthernetConnected && (isWifiConnected &&
+                        !setting.isTunnelOnWifiEnabled &&
+                (vpnService.getState() == Tunnel.State.UP)
+            )) {
+                ServiceManager.stopVpnService(this)
            }
            delay(Constants.VPN_CONNECTIVITY_CHECK_INTERVAL)
        }
@@ -440,10 +440,12 @@ fun MainScreen(
                                    }
                                }
                            } else {
+                                val checked = state == Tunnel.State.UP && tunnel.name == tunnelName
+                                if(!checked) expanded.value = false
                                @Composable
                                fun TunnelSwitch() = Switch(
                                    modifier = Modifier.focusRequester(focusRequester),
-                                    checked = (state == Tunnel.State.UP && tunnel.name == tunnelName),
+                                    checked = checked,
                                    onCheckedChange = { checked ->
                                        if(!checked) expanded.value = false
                                        onTunnelToggle(checked, tunnel)
@@ -5,6 +5,7 @@ import android.content.Intent
 import android.net.Uri
 import android.os.Build
 import android.provider.Settings
+import androidx.compose.animation.AnimatedVisibility
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.interaction.MutableInteractionSource
 import androidx.compose.foundation.layout.Arrangement
@@ -104,6 +105,8 @@ fun SettingsScreen(
    var showAuthPrompt by remember { mutableStateOf(false) }
    var didExportFiles by remember { mutableStateOf(false) }

+
+
    val screenPadding = 5.dp
    val fillMaxWidth = .85f

@@ -276,8 +279,11 @@ fun SettingsScreen(
            modifier = (if (WireGuardAutoTunnel.isRunningOnAndroidTv(context))
                Modifier
                    .height(IntrinsicSize.Min)
-                    .fillMaxWidth(fillMaxWidth).padding(top = 10.dp)
-            else Modifier.fillMaxWidth(fillMaxWidth).padding(top = 60.dp)).padding(bottom = 25.dp)
+                    .fillMaxWidth(fillMaxWidth)
+                    .padding(top = 10.dp)
+            else Modifier
+                .fillMaxWidth(fillMaxWidth)
+                .padding(top = 60.dp)).padding(bottom = 25.dp)
        ) {
            Column(
                horizontalAlignment = Alignment.Start,
@@ -285,66 +291,77 @@ fun SettingsScreen(
                modifier = Modifier.padding(15.dp)
            ) {
                SectionTitle(title = stringResource(id = R.string.auto_tunneling), padding = screenPadding)
-                Text(
-                    stringResource(R.string.trusted_ssid),
-                    textAlign = TextAlign.Center,
-                    modifier = Modifier.padding(screenPadding, bottom = 5.dp, top = 5.dp)
+                ConfigurationToggle(
+                    stringResource(id = R.string.tunnel_on_wifi),
+                    enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled),
+                    checked = settings.isTunnelOnWifiEnabled,
+                    padding = screenPadding,
+                    onCheckChanged = {
+                        scope.launch {
+                            viewModel.onToggleTunnelOnWifi()
+                        }
+                    },
+                    modifier = Modifier.focusRequester(focusRequester)
                )
-                val focus = Modifier.focusRequester(focusRequester)
-                FlowRow(
-                    modifier = (if(trustedSSIDs.isEmpty()) Modifier else
-                        focus).padding(screenPadding),
-                    horizontalArrangement = Arrangement.spacedBy(8.dp),
-                    verticalArrangement = Arrangement.SpaceEvenly
-                ) {
-                    trustedSSIDs.forEach { ssid ->
-                        ClickableIconButton(
-                            onIconClick = {
-                                scope.launch {
-                                    viewModel.onDeleteTrustedSSID(ssid)
+                AnimatedVisibility(visible = settings.isTunnelOnWifiEnabled) {
+                    Column {
+                        FlowRow(
+                            modifier = Modifier.padding(screenPadding),
+                            horizontalArrangement = Arrangement.spacedBy(8.dp),
+                            verticalArrangement = Arrangement.SpaceEvenly
+                        ) {
+                            trustedSSIDs.forEach { ssid ->
+                                ClickableIconButton(
+                                    onIconClick = {
+                                        scope.launch {
+                                            viewModel.onDeleteTrustedSSID(ssid)
+                                        }
+                                    },
+                                    text = ssid,
+                                    icon = Icons.Filled.Close,
+                                    enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled)
+                                )
+                            }
+                            if(trustedSSIDs.isEmpty()) {
+                                Text(stringResource(R.string.none), fontStyle = FontStyle.Italic, color = Color.Gray)
+                            }
+                        }
+                        OutlinedTextField(
+                            enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled),
+                            value = currentText,
+                            onValueChange = { currentText = it },
+                            label = { Text(stringResource(R.string.add_trusted_ssid)) },
+                            modifier = Modifier
+                                .padding(start = screenPadding, top = 5.dp, bottom = 10.dp)
+                                .onFocusChanged {
+                                    if (WireGuardAutoTunnel.isRunningOnAndroidTv(context)) {
+                                        keyboardController?.hide()
+                                    }
+                                },
+                            maxLines = 1,
+                            keyboardOptions = KeyboardOptions(
+                                capitalization = KeyboardCapitalization.None,
+                                imeAction = ImeAction.Done
+                            ),
+                            keyboardActions = KeyboardActions(
+                                onDone = {
+                                    saveTrustedSSID()
+                                }
+                            ),
+                            trailingIcon = {
+                                IconButton(onClick = { saveTrustedSSID() }) {
+                                    Icon(
+                                        imageVector = Icons.Outlined.Add,
+                                        contentDescription = if (currentText == "") stringResource(id = R.string.trusted_ssid_empty_description) else stringResource(
+                                            id = R.string.trusted_ssid_value_description
+                                        ),
+                                        tint = if (currentText == "") Color.Transparent else MaterialTheme.colorScheme.primary
+                                    )
                                }
                            },
-                            text = ssid,
-                            icon = Icons.Filled.Close,
-                            enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled)
                        )
                    }
-                    if(trustedSSIDs.isEmpty()) {
-                        Text(stringResource(R.string.none), fontStyle = FontStyle.Italic, color = Color.Gray)
-                    }
                }
-                OutlinedTextField(
-                    enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled),
-                    value = currentText,
-                    onValueChange = { currentText = it },
-                    label = { Text(stringResource(R.string.add_trusted_ssid)) },
-                    modifier = (if(trustedSSIDs.isEmpty()) focus else Modifier).padding(start = screenPadding, top = 5.dp).onFocusChanged {
-                        if(WireGuardAutoTunnel.isRunningOnAndroidTv(context)) {
-                            keyboardController?.hide()
-                        }
-                    },
-                    maxLines = 1,
-                    keyboardOptions = KeyboardOptions(
-                        capitalization = KeyboardCapitalization.None,
-                        imeAction = ImeAction.Done
-                    ),
-                    keyboardActions = KeyboardActions(
-                        onDone = {
-                            saveTrustedSSID()
-                        }
-                    ),
-                    trailingIcon = {
-                        IconButton(onClick = { saveTrustedSSID() }) {
-                            Icon(
-                                imageVector = Icons.Outlined.Add,
-                                contentDescription = if (currentText == "") stringResource(id = R.string.trusted_ssid_empty_description) else stringResource(
-                                    id = R.string.trusted_ssid_value_description
-                                ),
-                                tint = if (currentText == "") Color.Transparent else MaterialTheme.colorScheme.primary
-                            )
-                        }
-                    },
-                )
                ConfigurationToggle(stringResource(R.string.tunnel_mobile_data),
                    enabled = !(settings.isAutoTunnelEnabled || settings.isAlwaysOnVpnEnabled),
                    checked = settings.isTunnelOnMobileDataEnabled,
@@ -376,27 +393,36 @@ fun SettingsScreen(
                        }
                    }
                )
-                ConfigurationToggle(stringResource(R.string.enable_auto_tunnel),
-                    enabled = !settings.isAlwaysOnVpnEnabled,
-                    checked = settings.isAutoTunnelEnabled,
-                    padding = screenPadding,
-                    onCheckChanged = {
-                        if(!isAllAutoTunnelPermissionsEnabled()) {
-                            val message = if(viewModel.isLocationServicesNeeded()){
-                                context.getString(R.string.location_services_required)
-                            } else if(!isBackgroundLocationGranted){
-                                context.getString(R.string.background_location_required)
-                            } else {
-                                context.getString(R.string.precise_location_required)
+                Row(
+                    verticalAlignment = Alignment.CenterVertically,
+                    modifier = Modifier
+                        .fillMaxSize()
+                        .padding(top = 5.dp),
+                    horizontalArrangement = Arrangement.Center
+                ) {
+                    TextButton(
+                        enabled = !settings.isAlwaysOnVpnEnabled,
+                        onClick = {
+                            //TODO fix logic for mobile only
+                            if(!isAllAutoTunnelPermissionsEnabled() && settings.isTunnelOnWifiEnabled) {
+                                val message = if(!isBackgroundLocationGranted) {
+                                    context.getString(R.string.background_location_required)
+                                } else if(viewModel.isLocationServicesNeeded()) {
+                                    context.getString(R.string.location_services_required)
+                                } else {
+                                    context.getString(R.string.precise_location_required)
+                                }
+                                showSnackbarMessage(message)
+                            } else scope.launch {
+                                viewModel.toggleAutoTunnel()
                            }
-                            showSnackbarMessage(message)
-                        } else scope.launch {
-                            viewModel.toggleAutoTunnel()
-                        }
+                        }) {
+                        val autoTunnelButtonText = if(settings.isAutoTunnelEnabled) stringResource(R.string.disable_auto_tunnel)
+                        else stringResource(id = R.string.enable_auto_tunnel)
+                        Text(autoTunnelButtonText)
                    }
-                )
+                }
            }
-
        }
        if(!WireGuardAutoTunnel.isRunningOnAndroidTv(context)) {
            Surface(
@@ -404,7 +430,8 @@ fun SettingsScreen(
                shadowElevation = 2.dp,
                shape = RoundedCornerShape(12.dp),
                color = MaterialTheme.colorScheme.surface,
-                modifier = Modifier.fillMaxWidth(fillMaxWidth)
+                modifier = Modifier
+                    .fillMaxWidth(fillMaxWidth)
                    .height(IntrinsicSize.Min)
                    .padding(bottom = 180.dp)
            ) {
@@ -137,4 +137,10 @@ class SettingsViewModel @Inject constructor(private val application : Applicatio
            isBatterySaverEnabled = !_settings.value.isBatterySaverEnabled
        ))
    }
+
+    suspend fun onToggleTunnelOnWifi() {
+        settingsRepo.save(_settings.value.copy(
+            isTunnelOnWifiEnabled = !_settings.value.isTunnelOnWifiEnabled
+        ))
+    }
 }
@@ -1,22 +1,34 @@
 package com.zaneschepke.wireguardautotunnel.ui.screens.support

 import android.content.Intent
+import android.content.Intent.createChooser
 import android.net.Uri
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.focusable
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.IntrinsicSize
 import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.Spacer
 import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.size
 import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.shape.RoundedCornerShape
 import androidx.compose.foundation.verticalScroll
+import androidx.compose.material.icons.Icons
+import androidx.compose.material.icons.rounded.ArrowForward
+import androidx.compose.material.icons.rounded.Book
+import androidx.compose.material.icons.rounded.Mail
+import androidx.compose.material3.Divider
 import androidx.compose.material3.Icon
-import androidx.compose.material3.IconButton
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Surface
 import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
@@ -31,18 +43,32 @@ import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.text.style.TextDecoration
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
+import androidx.core.content.ContextCompat.startActivity
+import com.zaneschepke.wireguardautotunnel.BuildConfig
+import com.zaneschepke.wireguardautotunnel.Constants
 import com.zaneschepke.wireguardautotunnel.R
+import com.zaneschepke.wireguardautotunnel.WireGuardAutoTunnel

@Composable
 fun SupportScreen(padding : PaddingValues, focusRequester: FocusRequester) {

    val context = LocalContext.current
+    val fillMaxWidth = .85f

    fun openWebPage(url: String) {
        val webpage: Uri = Uri.parse(url)
        val intent = Intent(Intent.ACTION_VIEW, webpage)
        context.startActivity(intent)
    }
+    
+    fun launchEmail() {
+        val intent = Intent(Intent.ACTION_SEND).apply {
+            type = Constants.EMAIL_MIME_TYPE
+            putExtra(Intent.EXTRA_EMAIL, context.getString(R.string.my_email))
+            putExtra(Intent.EXTRA_SUBJECT, context.getString(R.string.email_subject))
+        }
+        startActivity(context,createChooser(intent, context.getString(R.string.email_chooser)),null)
+    }

        Column(horizontalAlignment = Alignment.CenterHorizontally,
            verticalArrangement = Arrangement.Top,
@@ -51,23 +77,65 @@ fun SupportScreen(padding : PaddingValues, focusRequester: FocusRequester) {
                .verticalScroll(rememberScrollState())
                .focusable()
                .padding(padding)) {
-            Text(stringResource(R.string.support_text), textAlign = TextAlign.Center, modifier = Modifier.padding(30.dp), fontSize = 15.sp)
-            Row(
-                modifier = Modifier
-                    .fillMaxWidth()
-                    .padding(14.dp),
-                verticalAlignment = Alignment.CenterVertically,
-                horizontalArrangement = Arrangement.SpaceEvenly
+            Surface(
+                tonalElevation = 2.dp,
+                shadowElevation = 2.dp,
+                shape = RoundedCornerShape(12.dp),
+                color = MaterialTheme.colorScheme.surface,
+                modifier = (if (WireGuardAutoTunnel.isRunningOnAndroidTv(context))
+                    Modifier
+                        .height(IntrinsicSize.Min)
+                        .fillMaxWidth(fillMaxWidth)
+                        .padding(top = 10.dp)
+                else Modifier
+                    .fillMaxWidth(fillMaxWidth)
+                    .padding(top = 20.dp)).padding(bottom = 25.dp)
            ) {
-                IconButton(onClick = {
-                    openWebPage(context.resources.getString(R.string.discord_url))
-                }) {
-                    Icon(imageVector = ImageVector.vectorResource(R.drawable.discord), "Discord")
-                }
-                IconButton(modifier = Modifier.focusRequester(focusRequester),onClick = {
-                    openWebPage(context.resources.getString(R.string.github_url))
-                }) {
-                    Icon(imageVector = ImageVector.vectorResource(R.drawable.github), "Github")
+                Column(modifier = Modifier.padding(20.dp)) {
+                    Text(stringResource(R.string.thank_you), textAlign = TextAlign.Start, modifier = Modifier.padding(bottom = 20.dp), fontSize = 16.sp)
+                    Text(stringResource(id = R.string.support_help_text), textAlign = TextAlign.Start, fontSize = 16.sp, modifier = Modifier.padding(bottom = 20.dp))
+                    TextButton(onClick = { openWebPage(context.resources.getString(R.string.docs_url)) }, modifier = Modifier.padding(vertical = 5.dp).focusRequester(focusRequester)) {
+                        Row(horizontalArrangement = Arrangement.SpaceBetween, verticalAlignment = Alignment.CenterVertically, modifier = Modifier.fillMaxWidth()) {
+                            Row {
+                                Icon(Icons.Rounded.Book, stringResource(id = R.string.docs))
+                                Text(stringResource(id = R.string.docs_description), textAlign = TextAlign.Justify, modifier = Modifier.padding(start = 10.dp))
+                            }
+                            Icon(Icons.Rounded.ArrowForward, stringResource(id = R.string.go))
+                        }
+                    }
+                    Divider(color = MaterialTheme.colorScheme.onBackground, thickness = 0.5.dp)
+                    TextButton(onClick = { openWebPage(context.resources.getString(R.string.discord_url)) }, modifier = Modifier.padding(vertical = 5.dp)) {
+                        Row(horizontalArrangement = Arrangement.SpaceBetween, verticalAlignment = Alignment.CenterVertically, modifier = Modifier.fillMaxWidth()) {
+                            Row {
+                                Icon(imageVector = ImageVector.vectorResource(R.drawable.discord), stringResource(
+                                    id = R.string.discord), Modifier.size(25.dp))
+                                Text(stringResource(id = R.string.discord_description), textAlign = TextAlign.Justify, modifier = Modifier.padding(start = 10.dp))
+                            }
+                            Icon(Icons.Rounded.ArrowForward, stringResource(id = R.string.go))
+                        }
+                    }
+                    Divider(color = MaterialTheme.colorScheme.onBackground, thickness = 0.5.dp)
+                    TextButton(onClick = { openWebPage(context.resources.getString(R.string.github_url)) }, modifier = Modifier.padding(vertical = 5.dp)) {
+                        Row(horizontalArrangement = Arrangement.SpaceBetween, verticalAlignment = Alignment.CenterVertically, modifier = Modifier.fillMaxWidth()) {
+                            Row {
+                                Icon(imageVector = ImageVector.vectorResource(R.drawable.github), stringResource(
+                                    id = R.string.github
+                                ), Modifier.size(25.dp))
+                                Text("Open an issue", textAlign = TextAlign.Justify, modifier = Modifier.padding(start = 10.dp))
+                            }
+                            Icon(Icons.Rounded.ArrowForward, stringResource(id = R.string.go))
+                        }
+                    }
+                    Divider(color = MaterialTheme.colorScheme.onBackground, thickness = 0.5.dp)
+                    TextButton(onClick = { launchEmail() }, modifier = Modifier.padding(vertical = 5.dp)) {
+                        Row(horizontalArrangement = Arrangement.SpaceBetween, verticalAlignment = Alignment.CenterVertically, modifier = Modifier.fillMaxWidth()) {
+                            Row {
+                                Icon(Icons.Rounded.Mail, stringResource(id = R.string.email))
+                                Text(stringResource(id = R.string.email_description), textAlign = TextAlign.Justify, modifier = Modifier.padding(start = 10.dp))
+                            }
+                            Icon(Icons.Rounded.ArrowForward, stringResource(id = R.string.go))
+                        }
+                    }
                }
            }
            Spacer(modifier = Modifier.weight(1f))
@@ -75,6 +143,6 @@ fun SupportScreen(padding : PaddingValues, focusRequester: FocusRequester) {
                modifier = Modifier.clickable {
                openWebPage(context.resources.getString(R.string.privacy_policy_url))
            })
-            Text("App version: ${com.zaneschepke.wireguardautotunnel.BuildConfig.VERSION_NAME}", Modifier.padding(25.dp))
+            Text("App version: ${BuildConfig.VERSION_NAME}", Modifier.padding(25.dp))
        }
    }