Merge pull request #74 from 05nelsonm/mn/feature/tor-setting-dormant-client-timeout

Add setting to enable torrc config option DormantClientTimeout

Author: 05nelsonm

sampleapp/src/main/java/io/matthewnelson/sampleapp/topl_android/MyTorSettings.kt

@@ -74,6 +74,9 @@ import io.matthewnelson.topl_core_base.TorSettings
  * */
 class MyTorSettings: TorSettings() {
 
+    override val dormantClientTimeout: Int?
+        get() = DEFAULT__DORMANT_CLIENT_TIMEOUT
+
     override val disableNetwork: Boolean
         get() = DEFAULT__DISABLE_NETWORK
 

topl-core-base/src/main/java/io/matthewnelson/topl_core_base/TorSettings.kt

@@ -110,6 +110,7 @@ abstract class TorSettings: BaseConsts() {
      * things up if you're simply looking to use a Socks5 Proxy to connect to.
      * */
     companion object {
+        const val DEFAULT__DORMANT_CLIENT_TIMEOUT = 10
         const val DEFAULT__DISABLE_NETWORK = true
         const val DEFAULT__ENTRY_NODES = ""
         const val DEFAULT__EXCLUDED_NODES = ""
@@ -150,6 +151,16 @@ abstract class TorSettings: BaseConsts() {
      * */
     abstract val customTorrc: String?
 
+    /**
+     * Adds to the torrc file "DormantClientTimeout <your value> minutes"
+     *
+     * Minimum value 10. Any value less than or equal to 9 will fall back to using the value of 10
+     * when writing the config to the torrc file. Set `null` to disable
+     *
+     * See [DEFAULT__DORMANT_CLIENT_TIMEOUT]
+     * */
+    abstract val dormantClientTimeout: Int?
+
     /**
      * OnionProxyManager will enable this on startup using the TorControlConnection based off
      * of the device's network state. Setting this to `true` is highly recommended.

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

@@ -318,6 +318,27 @@ class TorSettingsBuilder internal constructor(
         else
             this
 
+    fun dormantClientTimetout(minutes: Int): TorSettingsBuilder {
+        val value = if (minutes < 10)
+            10
+        else
+            minutes
+        buffer.append("DormantClientTimeout $value minutes\n")
+        return this
+    }
+
+    @SettingsConfig
+    fun dormantClientTimeoutFromSettings(): TorSettingsBuilder {
+        return when (val minutes = torSettings.dormantClientTimeout) {
+            null -> {
+                this
+            }
+            else -> {
+                dormantClientTimetout(minutes)
+            }
+        }
+    }
+
     fun disableNetwork(disable: Boolean): TorSettingsBuilder {
         val disableNetwork = if (disable) "1" else "0"
         buffer.append("DisableNetwork $disableNetwork\n")

topl-service/src/main/java/io/matthewnelson/topl_service/service/components/onionproxy/ServiceTorSettings.kt

@@ -98,6 +98,16 @@ class ServiceTorSettings internal constructor(
     val defaultTorSettings: TorSettings
 ): TorSettings() {
 
+    override val dormantClientTimeout: Int?
+        get() = servicePrefs.getInt(PrefKeyInt.DORMANT_CLIENT_TIMEOUT, defaultTorSettings.dormantClientTimeout)
+
+    fun dormantClientTimeoutSave(minutes: Int?) {
+        if (minutes == defaultTorSettings.dormantClientTimeout)
+            servicePrefs.remove(PrefKeyInt.DORMANT_CLIENT_TIMEOUT)
+        else
+            servicePrefs.putInt(PrefKeyInt.DORMANT_CLIENT_TIMEOUT, minutes)
+    }
+
     override val disableNetwork: Boolean
         get() = servicePrefs.getBoolean(PrefKeyBoolean.DISABLE_NETWORK, defaultTorSettings.disableNetwork)
 

topl-service/src/main/java/io/matthewnelson/topl_service/util/ServiceConsts.kt

@@ -210,13 +210,15 @@ abstract class ServiceConsts: BaseConsts() {
     }
 
     @StringDef(
+        PrefKeyInt.DORMANT_CLIENT_TIMEOUT,
         PrefKeyInt.PROXY_PORT,
         PrefKeyInt.PROXY_SOCKS5_SERVER_PORT
     )
     @Retention(AnnotationRetention.SOURCE)
     annotation class PrefKeyInt {
         companion object {
             // Keys for returning Ints
+            const val DORMANT_CLIENT_TIMEOUT = "DORMANT_CLIENT_TIMEOUT"
             const val PROXY_PORT = "PROXY_PORT"
             const val PROXY_SOCKS5_SERVER_PORT = "PROXY_SOCKS5_SERVER_PORT"
         }

topl-service/src/test/java/io/matthewnelson/test_helpers/application_provided_classes/TestTorSettings.kt

@@ -70,6 +70,9 @@ import io.matthewnelson.topl_core_base.TorSettings
 
 internal class TestTorSettings: TorSettings() {
 
+    override val dormantClientTimeout: Int?
+        get() = DEFAULT__DORMANT_CLIENT_TIMEOUT
+
     override val disableNetwork: Boolean
         get() = DEFAULT__DISABLE_NETWORK