Merge pull request #76 from 05nelsonm/mn/feature/network-receiver-delayed-disable

Add a delay to setting Tor conf DisableNetwork on connectivity change

Author: 05nelsonm

sampleapp/src/main/java/io/matthewnelson/sampleapp/App.kt

@@ -159,6 +159,7 @@ class App: Application() {
             application: Application,
             serviceNotificationBuilder: ServiceNotification.Builder,
             backgroundManagerPolicy: BackgroundManager.Builder.Policy,
+            disableNetworkDelay: Long,
             restartTimeDelay: Long,
             stopServiceTimeDelay: Long,
             stopServiceOnTaskRemoved: Boolean,
@@ -173,6 +174,7 @@ class App: Application() {
                 geoipAssetPath = "common/geoip",
                 geoip6AssetPath = "common/geoip6"
             )
+                .addTimeToDisableNetworkDelay(disableNetworkDelay)
                 .addTimeToRestartTorDelay(restartTimeDelay)
                 .addTimeToStopServiceDelay(stopServiceTimeDelay)
                 .disableStopServiceOnTaskRemoved(stopServiceOnTaskRemoved)
@@ -200,6 +202,7 @@ class App: Application() {
                 this,
                 serviceNotificationBuilder,
                 generateBackgroundManagerPolicy(prefs),
+                LibraryPrefs.getControllerDisableNetworkDelay(prefs),
                 LibraryPrefs.getControllerRestartDelaySetting(prefs),
                 stopTorDelaySettingAtAppStartup.toLong(),
                 LibraryPrefs.getControllerDisableStopServiceOnTaskRemovedSetting(prefs),
@@ -224,6 +227,7 @@ class App: Application() {
                 this,
                 serviceNotificationBuilder,
                 generateBackgroundManagerPolicy(prefs, BackgroundPolicy.RUN_IN_FOREGROUND, true),
+                LibraryPrefs.getControllerDisableNetworkDelay(prefs),
                 LibraryPrefs.getControllerRestartDelaySetting(prefs),
                 stopTorDelaySettingAtAppStartup.toLong(),
                 LibraryPrefs.getControllerDisableStopServiceOnTaskRemovedSetting(prefs),

sampleapp/src/main/java/io/matthewnelson/sampleapp/ui/fragments/settings/library/SettingsLibraryFragment.kt

@@ -148,6 +148,7 @@ class SettingsLibraryFragment : Fragment() {
                 view.context.applicationContext as Application,
                 notificationBuilder,
                 backgroundManagerPolicy,
+                controllerOptions.getDisableNetworkDelayValue(),
                 controllerOptions.getRestartDelayValue(),
                 controllerOptions.getStopDelayTime(),
                 controllerOptions.disableStopServiceOnTaskRemoved,

sampleapp/src/main/java/io/matthewnelson/sampleapp/ui/fragments/settings/library/components/ControllerOptions.kt

@@ -87,32 +87,34 @@ class ControllerOptions(view: View, prefs: Prefs) {
         const val RELEASE = "Release"
     }
 
+    private var initialDisableNetworkDelayTime: Long =
+        LibraryPrefs.getControllerDisableNetworkDelay(prefs)
+
     private var initialRestartDelayTime: Long =
-        LibraryPrefs.getControllerRestartDelaySetting(
-            prefs
-        )
+        LibraryPrefs.getControllerRestartDelaySetting(prefs)
 
     private var initialStopDelayTime: Long =
-        LibraryPrefs.getControllerStopDelaySetting(
-            prefs
-        )
+        LibraryPrefs.getControllerStopDelaySetting(prefs)
 
     private var initialDisableStopServiceOnTaskRemoved: Boolean =
-        LibraryPrefs.getControllerDisableStopServiceOnTaskRemovedSetting(
-            prefs
-        )
+        LibraryPrefs.getControllerDisableStopServiceOnTaskRemovedSetting(prefs)
+
     var disableStopServiceOnTaskRemoved: Boolean = initialDisableStopServiceOnTaskRemoved
         private set
 
     private var initialBuildConfigDebug: Boolean =
-        LibraryPrefs.getControllerBuildConfigDebugSetting(
-            prefs
-        )
+        LibraryPrefs.getControllerBuildConfigDebugSetting(prefs)
+
     var buildConfigDebug: Boolean = initialBuildConfigDebug
         private set
 
     fun saveSettings(prefs: Prefs): Boolean {
         var somethingChanged = false
+        if (getDisableNetworkDelayValue() != initialDisableNetworkDelayTime) {
+            prefs.write(LibraryPrefs.CONTROLLER_DISABLE_NETWORK_DELAY, getDisableNetworkDelayValue())
+            initialDisableNetworkDelayTime = getDisableNetworkDelayValue()
+            somethingChanged = true
+        }
         if (getRestartDelayValue() != initialRestartDelayTime) {
             prefs.write(LibraryPrefs.CONTROLLER_RESTART_DELAY, getRestartDelayValue())
             initialRestartDelayTime = getRestartDelayValue()
@@ -136,6 +138,9 @@ class ControllerOptions(view: View, prefs: Prefs) {
         return somethingChanged
     }
 
+    fun getDisableNetworkDelayValue(): Long =
+        getEditTextValueLong(editTextDisableNetworkDelay)
+
     fun getRestartDelayValue(): Long =
         getEditTextValueLong(editTextRestartDelay)
 
@@ -150,6 +155,7 @@ class ControllerOptions(view: View, prefs: Prefs) {
         }
     }
 
+    private lateinit var editTextDisableNetworkDelay: EditText
     private lateinit var editTextRestartDelay: EditText
     private lateinit var editTextStopDelay: EditText
     private lateinit var spinnerDisableStopOnTaskRemoved: Spinner
@@ -165,18 +171,25 @@ class ControllerOptions(view: View, prefs: Prefs) {
     }
 
     private fun findViews(view: View) {
+        editTextDisableNetworkDelay = view.findViewById(R.id.settings_library_edit_text_controller_disable_network_delay)
         editTextRestartDelay = view.findViewById(R.id.settings_library_edit_text_controller_restart_delay)
         editTextStopDelay = view.findViewById(R.id.settings_library_edit_text_controller_stop_delay)
         spinnerDisableStopOnTaskRemoved = view.findViewById(R.id.settings_library_spinner_controller_stop_on_task_removed)
         spinnerBuildConfig = view.findViewById(R.id.settings_library_spinner_controller_build_config)
     }
 
     private fun initEditTextViews() {
+        editTextDisableNetworkDelay.filters = arrayOf(InputFilter.LengthFilter(4))
+        if (initialDisableNetworkDelayTime > 0L)
+            editTextDisableNetworkDelay.setText(initialDisableNetworkDelayTime.toString())
+
         editTextRestartDelay.filters = arrayOf(InputFilter.LengthFilter(4))
-        editTextRestartDelay.setText(initialRestartDelayTime.toString())
+        if (initialRestartDelayTime > 0L)
+            editTextRestartDelay.setText(initialRestartDelayTime.toString())
 
         editTextStopDelay.filters = arrayOf(InputFilter.LengthFilter(4))
-        editTextStopDelay.setText(initialStopDelayTime.toString())
+        if (initialStopDelayTime > 0L)
+            editTextStopDelay.setText(initialStopDelayTime.toString())
     }
 
     private fun initSpinnerControllerDisableStopOnTaskRemoved(context: Context) {

sampleapp/src/main/java/io/matthewnelson/sampleapp/ui/fragments/settings/library/components/LibraryPrefs.kt

@@ -88,6 +88,7 @@ object LibraryPrefs {
 
     // Controller Keys
     const val CONTROLLER_BUILD_CONFIG_DEBUG = "CONTROLLER_BUILD_CONFIG_DEBUG"
+    const val CONTROLLER_DISABLE_NETWORK_DELAY = "CONTROLLER_DISABLE_NETWORK_DELAY"
     const val CONTROLLER_RESTART_DELAY = "CONTROLLER_RESTART_DELAY"
     const val CONTROLLER_STOP_DELAY = "CONTROLLER_STOP_DELAY"
     const val CONTROLLER_DISABLE_STOP_SERVICE_TASK_REMOVED = "CONTROLLER_DISABLE_STOP_SERVICE_TASK_REMOVED"
@@ -119,6 +120,9 @@ object LibraryPrefs {
         prefs.read(BACKGROUND_MANAGER_KILL_APP, true)
 
     // Controller Settings
+    fun getControllerDisableNetworkDelay(prefs: Prefs): Long =
+        prefs.read(CONTROLLER_DISABLE_NETWORK_DELAY, 0L)
+
     fun getControllerRestartDelaySetting(prefs: Prefs): Long =
         prefs.read(CONTROLLER_RESTART_DELAY, 100L)
 

sampleapp/src/main/res/layout/fragment_settings_library.xml

@@ -329,6 +329,26 @@
                     android:orientation="vertical"
                     app:layout_constraintGuide_percent=".40" />
 
+                <TextView
+                    android:id="@+id/settings_library_text_view_controller_disable_network_delay"
+                    style="@style/SpinnerTextView"
+                    android:text="@string/settings_library_text_view_controller_disable_network_delay"
+                    app:layout_constraintBottom_toBottomOf="@+id/settings_library_edit_text_controller_disable_network_delay"
+                    app:layout_constraintEnd_toEndOf="@+id/settings_library_controller_guide_left"
+                    app:layout_constraintStart_toStartOf="parent"
+                    app:layout_constraintTop_toTopOf="@+id/settings_library_edit_text_controller_disable_network_delay" />
+
+                <EditText
+                    android:id="@+id/settings_library_edit_text_controller_disable_network_delay"
+                    android:layout_width="0dp"
+                    android:layout_height="wrap_content"
+                    android:gravity="center_horizontal"
+                    android:hint="@string/settings_library_edit_text_controller_disable_network_delay"
+                    android:inputType="number"
+                    app:layout_constraintEnd_toEndOf="parent"
+                    app:layout_constraintStart_toEndOf="@+id/settings_library_controller_guide_left"
+                    app:layout_constraintTop_toTopOf="parent" />
+
                 <TextView
                     android:id="@+id/settings_library_text_view_controller_restart_delay"
                     style="@style/SpinnerTextView"
@@ -347,7 +367,7 @@
                     android:inputType="number"
                     app:layout_constraintEnd_toEndOf="parent"
                     app:layout_constraintStart_toEndOf="@+id/settings_library_controller_guide_left"
-                    app:layout_constraintTop_toTopOf="parent" />
+                    app:layout_constraintTop_toBottomOf="@+id/settings_library_edit_text_controller_disable_network_delay" />
 
                 <TextView
                     android:id="@+id/settings_library_text_view_controller_stop_delay"

sampleapp/src/main/res/values/strings.xml

@@ -65,9 +65,11 @@
         implementing the Library into your own application</string>
 
     <string name="settings_library_button_save">Save Settings</string>
-    <string name="settings_library_text_view_controller_restart_delay">Restart Delay (ms):</string>
+    <string name="settings_library_text_view_controller_disable_network_delay">Disable Net Delay:</string>
+    <string name="settings_library_edit_text_controller_disable_network_delay">6_000ms + your value</string>
+    <string name="settings_library_text_view_controller_restart_delay">Restart Delay:</string>
     <string name="settings_library_edit_text_controller_restart_delay">500ms + your value</string>
-    <string name="settings_library_text_view_controller_stop_delay">Stop Delay (ms):</string>
+    <string name="settings_library_text_view_controller_stop_delay">Stop Delay:</string>
     <string name="settings_library_edit_text_controller_stop_delay">100ms + your value</string>
     <string name="settings_library_text_view_controller_stop_on_task_removed">On Task Removed:</string>
     <string name="settings_library_text_view_controller_build_config">Build Config:</string>

topl-core/src/main/java/io/matthewnelson/topl_core/OnionProxyManager.kt

@@ -90,11 +90,9 @@
 package io.matthewnelson.topl_core
 
 import android.content.Context
-import android.content.IntentFilter
 import android.net.ConnectivityManager
 import io.matthewnelson.topl_core_base.EventBroadcaster
 import io.matthewnelson.topl_core.listener.BaseEventListener
-import io.matthewnelson.topl_core.receiver.NetworkStateReceiver
 import io.matthewnelson.topl_core.settings.TorSettingsBuilder
 import io.matthewnelson.topl_core.broadcaster.BroadcastLogger
 import io.matthewnelson.topl_core.broadcaster.BroadcastLoggerHelper
@@ -220,8 +218,6 @@ class OnionProxyManager(
         broadcastLogger.warn("TorControlConnection is not responding properly to $methodCall")
     }
 
-    @Volatile
-    private var networkStateReceiver: NetworkStateReceiver? = null
     @Volatile
     private var controlSocket: Socket? = null
     // If controlConnection is not null then this means that a connection exists and the Tor OP
@@ -384,21 +380,6 @@ class OnionProxyManager(
             }
 
             torStateMachine.setTorState(TorState.OFF)
-
-            if (networkStateReceiver == null) return
-
-            try {
-                appContext.unregisterReceiver(networkStateReceiver)
-            } catch (e: IllegalArgumentException) {
-                // There is a race condition where if someone calls stop before
-                // installAndStartTorOp is done then we could get an exception because
-                // the network state receiver might not be properly registered.
-                broadcastLogger.exception(
-                    IllegalArgumentException(
-                        "Someone tried calling stop before registering of NetworkStateReceiver", e
-                    )
-                )
-            }
         }
     }
 
@@ -416,6 +397,13 @@ class OnionProxyManager(
             false
         }
 
+    @Suppress("DEPRECATION")
+    fun hasNetworkConnectivity(): Boolean {
+        val connectivityManager = appContext
+            .getSystemService(Context.CONNECTIVITY_SERVICE) as ConnectivityManager?
+        return connectivityManager?.activeNetworkInfo?.isConnected ?: false
+    }
+
     private val disableNetworkLock = Object()
     /**
      * Tells the Tor OP if it should accept network connections.
@@ -424,11 +412,12 @@ class OnionProxyManager(
      * such that [torStateMachine] will reflect the proper
      * [io.matthewnelson.topl_core_base.BaseConsts.TorNetworkState].
      *
-     * @param [disable] If true then the Tor OP will **not** accept SOCKS connections, otherwise yes.
+     * @param [disable] Sets Tor config DisableNetwork (1 if `true`, 0 if `false`)
      * @throws [IOException] if having issues with TorControlConnection#setConf
-     * @throws [KotlinNullPointerException] if [controlConnection] is null even after checking.
+     * @throws [NullPointerException] if [controlConnection] is null even after checking.
      */
-    @Throws(IOException::class, KotlinNullPointerException::class)
+    @Synchronized
+    @Throws(IOException::class, NullPointerException::class)
     fun disableNetwork(disable: Boolean) {
         synchronized(disableNetworkLock) {
             if (!hasControlConnection) return
@@ -518,6 +507,11 @@ class OnionProxyManager(
     /**
      * Starts tor control service if it isn't already running.
      *
+     * If the device does not have connectivity, [disableNetwork] will not be called to set
+     * Tor's config for DisableNetwork to false (0). Handling connectivity changes should be done
+     * via your own [android.content.BroadcastReceiver] and by calling [disableNetwork] when
+     * appropriate.
+     *
      * @throws [IOException] File errors
      * @throws [SecurityException] Unauthorized access to file/directory.
      * @throws [IllegalArgumentException] if [onionProxyContext] methods are passed incorrect
@@ -589,7 +583,13 @@ class OnionProxyManager(
                 controlConnection.setEvents(listOf(*eventListener.CONTROL_COMMAND_EVENTS))
             }
 
-            disableNetwork(false)
+            if (hasNetworkConnectivity())
+                disableNetwork(false)
+            else
+                broadcastLogger.warn(
+                    "No Network Connectivity. Foregoing enabling of Tor Network."
+                )
+
         } catch (e: Exception) {
             torProcess?.destroy()
             this.controlConnection = null
@@ -599,12 +599,6 @@ class OnionProxyManager(
         }
 
         torStateMachine.setTorState(TorState.ON)
-
-        networkStateReceiver = NetworkStateReceiver(this)
-
-        @Suppress("DEPRECATION")
-        val filter = IntentFilter(ConnectivityManager.CONNECTIVITY_ACTION)
-        appContext.registerReceiver(networkStateReceiver, filter)
         broadcastLogger.notice("Completed starting of Tor")
     }
 
@@ -894,7 +888,7 @@ class OnionProxyManager(
     @Synchronized
     suspend fun signalNewNym() {
         if (!hasControlConnection || !isBootstrapped) return
-        if (networkStateReceiver?.networkConnectivity != true) {
+        if (!hasNetworkConnectivity()) {
             broadcastLogger.notice("NEWNYM: $NEWNYM_NO_NETWORK")
             return
         }