Merge pull request #4 from 05nelsonm/mn/feature/register-multiple-jtorctl-listeners

Adds ability to register multiple jtorctl listeners to the TorControlConnection

Author: 05nelsonm

gradle/dependencies.gradle

@@ -19,7 +19,10 @@ ext.deps = [
         ],
     ],
     gradleVersions: "com.github.ben-manes:gradle-versions-plugin:0.20.0",
+
+    // Update TorServiceController.Builder documentation if bumping versions.
     jtorctl: "info.guardianproject:jtorctl:0.4",
+
     junit: "junit:junit:4.12",
     kotlin: [
         coroutinesCore: "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.6",

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

@@ -41,6 +41,7 @@ import io.matthewnelson.topl_core.util.OnionProxyConsts.ConfigFile
 import io.matthewnelson.topl_core.util.FileUtilities
 import io.matthewnelson.topl_core.util.WriteObserver
 import io.matthewnelson.topl_core_base.TorStates
+import net.freehaven.tor.control.EventListener
 import net.freehaven.tor.control.TorControlCommands
 import net.freehaven.tor.control.TorControlConnection
 import org.slf4j.Logger
@@ -61,20 +62,22 @@ import java.util.concurrent.TimeUnit
  *
  * This class began life as TorPlugin from the Briar Project
  *
- * @param [context] Context
+ * @param [context] Context.
  * @param [onionProxyContext] [OnionProxyContext]
- * @param [eventBroadcaster] [EventBroadcaster]? will fallback to defaults if null
- * @param [baseEventListener] [BaseEventListener]? will fallback to defaults if null
+ * @param [eventBroadcaster] [EventBroadcaster]? will fallback to defaults if null.
+ * @param [primaryEventListener] [BaseEventListener]? will fallback to defaults if null.
+ * @param [additionalEventListeners] Array<[EventListener]?>? add additional listeners at Tor [start].
  */
 class OnionProxyManager(
     private val context: Context,
     val onionProxyContext: OnionProxyContext,
     eventBroadcaster: EventBroadcaster?,
-    baseEventListener: BaseEventListener?
+    primaryEventListener: BaseEventListener?,
+    private val additionalEventListeners: Array<EventListener?>?
 ): TorStates() {
 
     val eventBroadcaster = eventBroadcaster ?: DefaultEventBroadcaster(onionProxyContext.torSettings)
-    private val eventListener = baseEventListener ?: DefaultEventListener()
+    private val eventListener = primaryEventListener ?: DefaultEventListener()
 
     private companion object {
         const val OWNER = "__OwningControllerProcess"
@@ -250,6 +253,17 @@ class OnionProxyManager(
             } catch (eeee: IOException) {}
 
         } finally {
+
+            try {
+                controlConnection!!.removeRawEventListener(eventListener)
+                if (!additionalEventListeners.isNullOrEmpty())
+                    additionalEventListeners.forEach { listener ->
+                        listener?.let {
+                            controlConnection!!.removeRawEventListener(it)
+                        }
+                    }
+            } catch (e: KotlinNullPointerException) {}
+
             controlConnection = null
             if (controlSocket != null) {
                 try {
@@ -431,7 +445,15 @@ class OnionProxyManager(
 
             if (eventListener.CONTROL_COMMAND_EVENTS.isNotEmpty()) {
                 eventBroadcaster.broadcastNotice("adding control port event listener")
+
                 controlConnection.addRawEventListener(eventListener)
+                if (!additionalEventListeners.isNullOrEmpty())
+                    additionalEventListeners.forEach { listener ->
+                        listener?.let {
+                            controlConnection.addRawEventListener(it)
+                        }
+                    }
+
                 controlConnection.setEvents(listOf(*eventListener.CONTROL_COMMAND_EVENTS))
                 eventBroadcaster.broadcastNotice("SUCCESS added control port event listener")
             }

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

@@ -12,6 +12,7 @@ import io.matthewnelson.topl_service.service.ActionConsts.ServiceAction
 import androidx.core.app.NotificationCompat.NotificationVisibility
 import io.matthewnelson.topl_core_base.TorConfigFiles
 import io.matthewnelson.topl_core_base.TorSettings
+import net.freehaven.tor.control.EventListener
 
 class TorServiceController private constructor() {
 
@@ -57,6 +58,7 @@ class TorServiceController private constructor() {
     ) {
 
         private lateinit var torConfigFiles: TorConfigFiles
+        private lateinit var additionalEventListener: EventListener
 
         /**
          * If you wish to customize the file structure of how Tor is installed in your app,
@@ -77,6 +79,26 @@ class TorServiceController private constructor() {
             return this
         }
 
+        /**
+         * This will require adding the `jtorctl` library:
+         *
+         *  - Add `implementation "info.guardianproject:jtorctl:0.4"` to your dependencies block
+         *
+         * Extend the [EventListener] class and implement the overridden methods. It will be
+         * registered when Tor is started up so messages from Tor will be piped to it.
+         *
+         * This is limited to adding only 1 event listener. Also, see which
+         *
+         * See [io.matthewnelson.topl_service.onionproxy.OnionProxyEventListener] for an example
+         * and what `CONTROL_COMMAND_EVENTS` will be registered to be listened for.
+         *
+         * @param [jtorctlEventListener] [EventListener]
+         * */
+        fun addTorEventListener(jtorctlEventListener: EventListener): Builder {
+            this.additionalEventListener = jtorctlEventListener
+            return this
+        }
+
         /**
          * Customize the service notification to your application.
          *
@@ -302,10 +324,16 @@ class TorServiceController private constructor() {
                 } else {
                     TorConfigFiles.createConfig(context.applicationContext)
                 }
+            val eventListener =
+                if (::additionalEventListener.isInitialized)
+                    this.additionalEventListener
+                else
+                    null
 
             TorService.initialize(
                 torConfigFiles,
                 torSettings,
+                eventListener,
                 buildConfigVersion,
                 geoipAssetPath,
                 geoip6AssetPath

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

@@ -17,7 +17,7 @@ import java.util.concurrent.TimeoutException
  *
  * @param [torService] for context.
  * @param [torConfigFiles] [TorConfigFiles] to know where files/directories are.
- * @param [appVersionCode] Mitigate copying of geoip files to app updates only. Use [BuildConfig.VERSION_CODE].
+ * @param [buildConfigVersionCode] Mitigate copying of geoip files to app updates only. Use [BuildConfig.VERSION_CODE].
  * @param [geoIpAssetPath] The path to geoip file within the application, ex: "common/geoip"
  * @param [geoIp6AssetPath] The path to geoip6 file within the application, ex: "common/geoip6"
  *
@@ -26,7 +26,7 @@ import java.util.concurrent.TimeoutException
 internal class OnionProxyInstaller(
     private val torService: TorService,
     private val torConfigFiles: TorConfigFiles,
-    private val appVersionCode: Int,
+    private val buildConfigVersionCode: Int,
     private val geoIpAssetPath: String,
     private val geoIp6AssetPath: String
 ): TorInstaller() {
@@ -45,13 +45,16 @@ internal class OnionProxyInstaller(
             geoIp6FileCoppied = ""
 
         // If the app version has been increased, or if this is a debug build of topl-service
-        // module, copy over geoip assets then update SharedPreferences with the new appVersion
-        if (appVersionCode > prefs.getInt("APP_VERSION", -1) ?: -1 || BuildConfig.DEBUG) {
+        // module, copy over geoip assets then update SharedPreferences with the updated
+        // version code. Mitigates copying to be done only if a version upgrade is had.
+        if (buildConfigVersionCode > prefs.getInt("BUILD_CONFIG_VERSION_CODE", -1) ?: -1 ||
+            BuildConfig.DEBUG
+        ) {
             if (!::geoIpFileCoppied.isInitialized)
                 copyAsset(geoIpAssetPath, torConfigFiles.geoIpFile)
             if (!::geoIp6FileCoppied.isInitialized)
                 copyAsset(geoIp6AssetPath, torConfigFiles.geoIpv6File)
-            prefs.putInt("APP_VERSION", appVersionCode)
+            prefs.putInt("BUILD_CONFIG_VERSION_CODE", buildConfigVersionCode)
         }
     }
 

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

@@ -16,28 +16,32 @@ import io.matthewnelson.topl_service.onionproxy.OnionProxyEventBroadcaster
 import io.matthewnelson.topl_service.onionproxy.OnionProxyEventListener
 import io.matthewnelson.topl_service.onionproxy.OnionProxyInstaller
 import io.matthewnelson.topl_service.service.ActionConsts.ServiceAction
+import net.freehaven.tor.control.EventListener
 
 internal class TorService: Service() {
 
     companion object {
         private lateinit var torConfigFiles: TorConfigFiles
         private lateinit var torSettings: TorSettings
-        private var buildConfigVersion: Int = -1
+        private var additionalEventListener: EventListener? = null
+        private var buildConfigVersionCode: Int = -1
         private lateinit var geoipAssetPath: String
         private lateinit var geoip6AssetPath: String
 
         fun initialize(
-            config: TorConfigFiles,
-            settings: TorSettings,
-            buildVersion: Int,
-            geoipPath: String,
-            geoip6Path: String
+            torConfigFiles: TorConfigFiles,
+            torSettings: TorSettings,
+            additionalEventListener: EventListener?,
+            buildConfigVersionCode: Int,
+            geoipAssetPath: String,
+            geoip6AssetPath: String
         ) {
-            torConfigFiles = config
-            torSettings = settings
-            buildConfigVersion = buildVersion
-            geoipAssetPath = geoipPath
-            geoip6AssetPath = geoip6Path
+            this.torConfigFiles = torConfigFiles
+            this.torSettings = torSettings
+            this.additionalEventListener = additionalEventListener
+            this.buildConfigVersionCode = buildConfigVersionCode
+            this.geoipAssetPath = geoipAssetPath
+            this.geoip6AssetPath = geoip6AssetPath
         }
 
         // Intents/LocalBroadcastManager
@@ -59,7 +63,7 @@ internal class TorService: Service() {
         val onionProxyInstaller = OnionProxyInstaller(
             this,
             torConfigFiles,
-            buildConfigVersion,
+            buildConfigVersionCode,
             geoipAssetPath,
             geoip6AssetPath
         )
@@ -69,11 +73,13 @@ internal class TorService: Service() {
             torServiceSettings
         )
         val onionProxyEventBroadcaster = OnionProxyEventBroadcaster(this, torServiceSettings)
+        val onionProxyEventListener = OnionProxyEventListener(this, onionProxyEventBroadcaster)
         onionProxyManager = OnionProxyManager(
             this,
             onionProxyContext,
             onionProxyEventBroadcaster,
-            OnionProxyEventListener(this, onionProxyEventBroadcaster)
+            onionProxyEventListener,
+            arrayOf(additionalEventListener)
         )
         onionProxyManager.setup()
     }