epic18: Manage VPN services for Tor or Tracker control

8 files changed, 39 insertions, 187 deletions

diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/LocationMode.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/entities/LocationMode.kt
deleted file mode 100644
index 62581eb..0000000
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/LocationMode.kt
+++ /dev/null
@@ -1,22 +0,0 @@
-/*
- * Copyright (C) 2021 E FOUNDATION
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
-
-package foundation.e.advancedprivacy.domain.entities
-
-enum class LocationMode {
-    REAL_LOCATION, RANDOM_LOCATION, SPECIFIC_LOCATION
-}
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/MainFeatures.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/entities/MainFeatures.kt
deleted file mode 100644
index c63d3ab..0000000
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/MainFeatures.kt
+++ /dev/null
@@ -1,22 +0,0 @@
-/*
- * Copyright (C) 2022 E FOUNDATION
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
-
-package foundation.e.advancedprivacy.domain.entities
-
-enum class MainFeatures {
-    TRACKERS_CONTROL, FAKE_LOCATION, IP_SCRAMBLING
-}
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/ShowFeaturesWarning.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/entities/ShowFeaturesWarning.kt
deleted file mode 100644
index 0d8e0e8..0000000
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/entities/ShowFeaturesWarning.kt
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * Copyright (C) 2023 MURENA SAS
- * Copyright (C) 2022 E FOUNDATION
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- */
-package foundation.e.advancedprivacy.domain.entities
-
-import android.content.Intent
-import android.os.Parcelable
-import kotlinx.parcelize.Parcelize
-
-sealed class ShowFeaturesWarning : Parcelable {
-    @Parcelize
-    object TrackersControl : ShowFeaturesWarning()
-    @Parcelize
-    object FakeLocation : ShowFeaturesWarning()
-    @Parcelize
-    data class IpScrambling(val startVpnDisclaimer: Intent? = null) : ShowFeaturesWarning()
-}
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/FakeLocationStateUseCase.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/FakeLocationStateUseCase.kt
index 983ba71..282116e 100644
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/FakeLocationStateUseCase.kt
+++ b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/FakeLocationStateUseCase.kt
@@ -25,10 +25,10 @@ import android.location.Location
 import android.location.LocationListener
 import android.location.LocationManager
 import android.os.Bundle
-import foundation.e.advancedprivacy.data.repositories.LocalStateRepository
 import foundation.e.advancedprivacy.domain.entities.AppOpModes
 import foundation.e.advancedprivacy.domain.entities.ApplicationDescription
 import foundation.e.advancedprivacy.domain.entities.LocationMode
+import foundation.e.advancedprivacy.domain.repositories.LocalStateRepository
 import foundation.e.advancedprivacy.dummy.CityDataSource
 import foundation.e.advancedprivacy.externalinterfaces.permissions.IPermissionsPrivacyModule
 import foundation.e.advancedprivacy.fakelocation.domain.usecases.FakeLocationModule
@@ -49,11 +49,10 @@ class FakeLocationStateUseCase(
     private val appContext: Context,
     coroutineScope: CoroutineScope
 ) {
-    companion object {
-        private const val TAG = "FakeLocationStateUseCase"
-    }
+    private val _configuredLocationMode = MutableStateFlow<Triple<LocationMode, Float?, Float?>>(
+        Triple(LocationMode.REAL_LOCATION, null, null)
+    )
 
-    private val _configuredLocationMode = MutableStateFlow<Triple<LocationMode, Float?, Float?>>(Triple(LocationMode.REAL_LOCATION, null, null))
     val configuredLocationMode: StateFlow<Triple<LocationMode, Float?, Float?>> = _configuredLocationMode
 
     init {
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/GetQuickPrivacyStateUseCase.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/GetQuickPrivacyStateUseCase.kt
index 1b8f62c..480d3b3 100644
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/GetQuickPrivacyStateUseCase.kt
+++ b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/GetQuickPrivacyStateUseCase.kt
@@ -1,4 +1,5 @@
 /*
+ * Copyright (C) 2023 MURENA SAS
  * Copyright (C) 2021 E FOUNDATION
  *
  * This program is free software: you can redistribute it and/or modify
@@ -17,12 +18,12 @@
 
 package foundation.e.advancedprivacy.domain.usecases
 
-import foundation.e.advancedprivacy.data.repositories.LocalStateRepository
 import foundation.e.advancedprivacy.domain.entities.ApplicationDescription
-import foundation.e.advancedprivacy.domain.entities.FeatureServiceState
+import foundation.e.advancedprivacy.domain.entities.FeatureState
 import foundation.e.advancedprivacy.domain.entities.LocationMode
 import foundation.e.advancedprivacy.domain.entities.QuickPrivacyState
 import foundation.e.advancedprivacy.domain.entities.TrackerMode
+import foundation.e.advancedprivacy.domain.repositories.LocalStateRepository
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.SharedFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -41,13 +42,13 @@ class GetQuickPrivacyStateUseCase(
         when {
             !isBlockTrackers &&
                 locationMode == LocationMode.REAL_LOCATION &&
-                internetPrivacyMode == FeatureServiceState.OFF -> QuickPrivacyState.DISABLED
+                internetPrivacyMode == FeatureState.OFF -> QuickPrivacyState.DISABLED
 
             isAllTrackersBlocked &&
                 locationMode != LocationMode.REAL_LOCATION &&
                 internetPrivacyMode in listOf(
-                FeatureServiceState.ON,
-                FeatureServiceState.STARTING
+                FeatureState.ON,
+                FeatureState.STARTING
             ) -> QuickPrivacyState.FULL_ENABLED
 
             else -> QuickPrivacyState.ENABLED
@@ -71,7 +72,7 @@ class GetQuickPrivacyStateUseCase(
 
     val locationMode: StateFlow<LocationMode> = localStateRepository.locationMode
 
-    val ipScramblingMode: Flow<FeatureServiceState> =
+    val ipScramblingMode: Flow<FeatureState> =
         localStateRepository.internetPrivacyMode
 
     fun toggleTrackers(enabled: Boolean?) {
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/IpScramblingStateUseCase.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/IpScramblingStateUseCase.kt
index 79c79f7..00613dd 100644
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/IpScramblingStateUseCase.kt
+++ b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/IpScramblingStateUseCase.kt
@@ -18,43 +18,27 @@
 
 package foundation.e.advancedprivacy.domain.usecases
 
-import android.content.Intent
-import foundation.e.advancedprivacy.common.isStandaloneBuild
 import foundation.e.advancedprivacy.data.repositories.AppListsRepository
-import foundation.e.advancedprivacy.data.repositories.LocalStateRepository
-import foundation.e.advancedprivacy.domain.entities.ApplicationDescription
-import foundation.e.advancedprivacy.domain.entities.FeatureServiceState
-import foundation.e.advancedprivacy.externalinterfaces.permissions.IPermissionsPrivacyModule
-import foundation.e.advancedprivacy.ipscrambler.OrbotServiceSupervisor
-import foundation.e.advancedprivacy.trackers.domain.externalinterfaces.TrackersServiceSupervisor
+import foundation.e.advancedprivacy.domain.entities.FeatureState
+import foundation.e.advancedprivacy.domain.repositories.LocalStateRepository
+import foundation.e.advancedprivacy.ipscrambler.OrbotSupervisor
 import kotlinx.coroutines.CoroutineScope
-import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.map
-import kotlinx.coroutines.launch
 
 class IpScramblingStateUseCase(
-    private val orbotServiceSupervisor: OrbotServiceSupervisor,
-    private val permissionsPrivacyModule: IPermissionsPrivacyModule,
-    private val appDesc: ApplicationDescription,
+    private val orbotSupervisor: OrbotSupervisor,
     private val localStateRepository: LocalStateRepository,
     private val appListsRepository: AppListsRepository,
-    private val trackersServiceSupervisor: TrackersServiceSupervisor,
     private val coroutineScope: CoroutineScope
 ) {
-    val internetPrivacyMode: StateFlow<FeatureServiceState> = orbotServiceSupervisor.state
+    val internetPrivacyMode: StateFlow<FeatureState> = orbotSupervisor.state
 
     init {
-        orbotServiceSupervisor.requestStatus()
+        orbotSupervisor.requestStatus()
 
-        coroutineScope.launch(Dispatchers.Default) {
-            localStateRepository.ipScramblingSetting.collect {
-                applySettings(it)
-            }
-        }
-
-        orbotServiceSupervisor.state.map {
+        orbotSupervisor.state.map {
             localStateRepository.internetPrivacyMode.value = it
         }.launchIn(coroutineScope)
     }
@@ -68,7 +52,7 @@ class IpScramblingStateUseCase(
     }
 
     val bypassTorApps: Set<String> get() {
-        var whitelist = orbotServiceSupervisor.appList
+        var whitelist = orbotSupervisor.appList
         if (getHiddenPackageNames().any { it in whitelist }) {
             val mutable = whitelist.toMutableSet()
             mutable.removeAll(getHiddenPackageNames())
@@ -86,7 +70,7 @@ class IpScramblingStateUseCase(
 
     fun toggleBypassTor(packageName: String) {
         val visibleList = bypassTorApps.toMutableSet()
-        val rawList = orbotServiceSupervisor.appList.toMutableSet()
+        val rawList = orbotSupervisor.appList.toMutableSet()
 
         if (visibleList.contains(packageName)) {
             if (packageName == appListsRepository.dummySystemApp.packageName) {
@@ -105,69 +89,16 @@ class IpScramblingStateUseCase(
                 rawList.add(packageName)
             }
         }
-        orbotServiceSupervisor.appList = rawList
+        orbotSupervisor.appList = rawList
     }
 
-    val availablesLocations: List<String> = orbotServiceSupervisor.getAvailablesLocations().sorted()
+    val availablesLocations: List<String> = orbotSupervisor.getAvailablesLocations().sorted()
 
-    val exitCountry: String get() = orbotServiceSupervisor.getExitCountryCode()
+    val exitCountry: String get() = orbotSupervisor.getExitCountryCode()
 
     suspend fun setExitCountry(locationId: String) {
         if (locationId != exitCountry) {
-            orbotServiceSupervisor.setExitCountryCode(locationId)
+            orbotSupervisor.setExitCountryCode(locationId)
         }
     }
-
-    private suspend fun applySettings(isIpScramblingEnabled: Boolean) {
-        val currentMode = localStateRepository.internetPrivacyMode.value
-        when {
-            isIpScramblingEnabled && currentMode in setOf(FeatureServiceState.OFF, FeatureServiceState.STOPPING) ->
-                applyStartIpScrambling()
-
-            !isIpScramblingEnabled && currentMode in setOf(FeatureServiceState.ON, FeatureServiceState.STARTING) ->
-                orbotServiceSupervisor.stop()
-
-            else -> {}
-        }
-    }
-
-    private suspend fun applyStartIpScrambling() {
-        val authorizeVpnIntent = orbotServiceSupervisor.prepareAndroidVpn()
-        if (authorizeVpnIntent == null) {
-            localStateRepository.emitStartVpnDisclaimer(null)
-
-            startIpScrambling()
-            return
-        }
-
-        acquireVpnAuthorization(authorizeVpnIntent)
-    }
-
-    private suspend fun acquireVpnAuthorization(authorizeVpnIntent: Intent) {
-        val authorized = permissionsPrivacyModule.setVpnPackageAuthorization(appDesc.packageName)
-        val alwaysOnVpnPackage = permissionsPrivacyModule.getAlwaysOnVpnPackage()
-
-        when {
-            authorized && alwaysOnVpnPackage == null -> {
-                localStateRepository.emitStartVpnDisclaimer(null)
-                startIpScrambling()
-            }
-            authorized && alwaysOnVpnPackage != null -> {
-                localStateRepository.emitOtherVpnRunning(
-                    permissionsPrivacyModule.getApplicationDescription(
-                        packageName = alwaysOnVpnPackage,
-                        withIcon = false
-                    )
-                )
-                localStateRepository.setIpScramblingSetting(enabled = false)
-            }
-            else -> localStateRepository.emitStartVpnDisclaimer(authorizeVpnIntent)
-        }
-    }
-
-    fun startIpScrambling() {
-        localStateRepository.internetPrivacyMode.value = FeatureServiceState.STARTING
-        orbotServiceSupervisor.setDNSFilter((trackersServiceSupervisor.dnsFilterForIpScrambling))
-        orbotServiceSupervisor.start(enableNotification = isStandaloneBuild)
-    }
 }
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/ShowFeaturesWarningUseCase.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/ShowFeaturesWarningUseCase.kt
index c99d5f1..f8a0986 100644
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/ShowFeaturesWarningUseCase.kt
+++ b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/ShowFeaturesWarningUseCase.kt
@@ -1,4 +1,5 @@
 /*
+ * Copyright (C) 2023 MURENA SAS
  * Copyright (C) 2022 E FOUNDATION
  *
  * This program is free software: you can redistribute it and/or modify
@@ -17,11 +18,11 @@
 
 package foundation.e.advancedprivacy.domain.usecases
 
-import foundation.e.advancedprivacy.data.repositories.LocalStateRepository
-import foundation.e.advancedprivacy.domain.entities.ShowFeaturesWarning
-import foundation.e.advancedprivacy.domain.entities.ShowFeaturesWarning.FakeLocation
-import foundation.e.advancedprivacy.domain.entities.ShowFeaturesWarning.IpScrambling
-import foundation.e.advancedprivacy.domain.entities.ShowFeaturesWarning.TrackersControl
+import foundation.e.advancedprivacy.domain.entities.MainFeatures
+import foundation.e.advancedprivacy.domain.entities.MainFeatures.FakeLocation
+import foundation.e.advancedprivacy.domain.entities.MainFeatures.IpScrambling
+import foundation.e.advancedprivacy.domain.entities.MainFeatures.TrackersControl
+import foundation.e.advancedprivacy.domain.repositories.LocalStateRepository
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.drop
 import kotlinx.coroutines.flow.dropWhile
@@ -33,24 +34,22 @@ class ShowFeaturesWarningUseCase(
     private val localStateRepository: LocalStateRepository
 ) {
 
-    fun showWarning(): Flow<ShowFeaturesWarning> {
+    fun showWarning(): Flow<MainFeatures> {
         return merge(
-            localStateRepository.blockTrackers.drop(1).dropWhile { !it }
-                .filter { it && !localStateRepository.hideWarningTrackers }
-                .map { TrackersControl },
             localStateRepository.fakeLocationEnabled.drop(1).dropWhile { !it }
                 .filter { it && !localStateRepository.hideWarningLocation }
                 .map { FakeLocation },
             localStateRepository.startVpnDisclaimer.filter {
-                it.startVpnDisclaimer != null || !localStateRepository.hideWarningIpScrambling
+                (it is IpScrambling && !localStateRepository.hideWarningIpScrambling) ||
+                    (it is TrackersControl && !localStateRepository.hideWarningTrackers)
             }
         )
     }
 
-    fun doNotShowAgain(feature: ShowFeaturesWarning) {
+    fun doNotShowAgain(feature: MainFeatures) {
         when (feature) {
-            TrackersControl -> localStateRepository.hideWarningTrackers = true
-            FakeLocation -> localStateRepository.hideWarningLocation = true
+            is TrackersControl -> localStateRepository.hideWarningTrackers = true
+            is FakeLocation -> localStateRepository.hideWarningLocation = true
             is IpScrambling -> localStateRepository.hideWarningIpScrambling = true
         }
     }
diff --git a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/TrackersStateUseCase.kt b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/TrackersStateUseCase.kt
index 9b79dcc..2c47d70 100644
--- a/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/TrackersStateUseCase.kt
+++ b/app/src/main/java/foundation/e/advancedprivacy/domain/usecases/TrackersStateUseCase.kt
@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2021 E FOUNDATION, 2022 - 2023 MURENA SAS
+ * Copyright (C) 2022 - 2023 MURENA SAS
+ * Copyright (C) 2021 E FOUNDATION
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,11 +19,10 @@
 package foundation.e.advancedprivacy.domain.usecases
 
 import foundation.e.advancedprivacy.data.repositories.AppListsRepository
-import foundation.e.advancedprivacy.data.repositories.LocalStateRepository
 import foundation.e.advancedprivacy.domain.entities.ApplicationDescription
+import foundation.e.advancedprivacy.domain.repositories.LocalStateRepository
 import foundation.e.advancedprivacy.trackers.data.WhitelistRepository
 import foundation.e.advancedprivacy.trackers.domain.entities.Tracker
-import foundation.e.advancedprivacy.trackers.domain.externalinterfaces.TrackersServiceSupervisor
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 
@@ -30,7 +30,6 @@ class TrackersStateUseCase(
     private val whitelistRepository: WhitelistRepository,
     private val localStateRepository: LocalStateRepository,
     private val appListsRepository: AppListsRepository,
-    private val trackersServiceSupervisor: TrackersServiceSupervisor,
     coroutineScope: CoroutineScope,
 ) {
     init {
@@ -40,8 +39,6 @@ class TrackersStateUseCase(
                 updateAllTrackersBlockedState()
             }
         }
-
-        trackersServiceSupervisor.start()
     }
 
     private fun updateAllTrackersBlockedState() {