Merge branch 'release_2.1.0'

Author: 05nelsonm

docs/changelog.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## Version 2.1.0 (2021-01-30)
+ - New Features Added:
+     - `topl-service:TorService` Lifecycle Events are now broadcast to `TorServiceEventBroadcaster`
+     - `topl-service-base:ServiceExecutionHooks` have been implemented such that library users can
+     leverage suspension functions at key points of `TorService`'s operation, and allow for synchronous
+     code execution.
+     - Moved `topl-service:ServiceActionName` String definitions to `topl-service-base` to expose them
+     such that library users can utilize them in their implementation of `TorServiceEventBroadcaster`
+ - Bug Fixes:
+     - Kotlin internal visibility modifier is public from Java code.
+     See Issue <a href="https://github.com/05nelsonm/TorOnionProxyLibrary-Android/issues/100" target="_blank">100</a>
+     - Duplicate v3 Client Authentication files were inhibiting Tor from starting properly.
+     See Issue <a href="https://github.com/05nelsonm/TorOnionProxyLibrary-Android/issues/105" target="_blank">105</a>
+     - Tor notice messages were modified between 0.4.4.0 and 0.4.5.4-rc, which caused
+     `topl-service:ServiceEventBroadcaster`'s notice message filter to miss broadcasting of ports.
+     See Issue <a href="https://github.com/05nelsonm/TorOnionProxyLibrary-Android/issues/110" target="_blank">110</a>
+ - Dependencies were bumped to latest stable releases.
+
 ## Version 2.0.2 (2020-10-19)
  - Bug Fix: Notifications not showing on API 25 and below [12abbf7](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/commit/12abbf7faec781cb2c9b0a9babf3fe0e3d6cb352)
  - Deprecates `ServiceNotification.Builder.setContentIntentData` in favor of

docs/roadmap.md

@@ -10,6 +10,5 @@
  :material-checkbox-blank-outline: Pass-through commands to the TorControlConnection
  :material-checkbox-blank-outline: Transport Plugin support
  :material-checkbox-blank-outline: v3 Hidden Service Creation
- :material-checkbox-blank-outline: Settings/Debug Activity (so devs don't have to create one if they don't wish to)
 
 [back](index.md)

docs/topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/-init-.md

@@ -22,7 +22,15 @@ See [BaseConsts.BroadcastType](../-base-consts/-broadcast-type/index.md)s
  *
  * @param [torService] [BaseService] for context.
  * */
-internal class ServiceEventBroadcaster(private val torService: BaseService): EventBroadcaster() {
+internal class ServiceEventBroadcaster private constructor(
+    private val torService: BaseService
+): EventBroadcaster() {
+
+    companion object {
+        @JvmSynthetic
+        fun instantiate(torService: BaseService): ServiceEventBroadcaster =
+            ServiceEventBroadcaster(torService)
+    }
 
     private val scopeMain: CoroutineScope
         get() = torService.getScopeMain()
@@ -180,28 +188,28 @@ internal class ServiceEventBroadcaster(private val torService: BaseService): Eve
             }
             // Dns Port
             // NOTICE|OnionProxyManager|Opened DNS listener on 127.0.0.1:5400
-            msg.contains("Opened DNS listener on ") -> {
+            msg.contains("Opened DNS listener ") -> {
                 dnsPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Http Tunnel Port
             // NOTICE|BaseEventListener|Opened HTTP tunnel listener on 127.0.0.1:8118
-            msg.contains("Opened HTTP tunnel listener on ") -> {
+            msg.contains("Opened HTTP tunnel listener ") -> {
                 httpTunnelPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Socks Port
             // NOTICE|BaseEventListener|Opened Socks listener on 127.0.0.1:9050
-            msg.contains("Opened Socks listener on ") -> {
+            msg.contains("Opened Socks listener ") -> {
                 socksPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Trans Port
             // NOTICE|BaseEventListener|Opened Transparent pf/netfilter listener on 127.0.0.1:9040
-            msg.contains("Opened Transparent pf/netfilter listener on ") -> {
+            msg.contains("Opened Transparent pf/netfilter listener ") -> {
                 transPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()

docs/topl-core-base/io.matthewnelson.topl_core_base/-event-broadcaster/index.md

@@ -22,7 +22,15 @@ See [BaseConsts.BroadcastType](../-base-consts/-broadcast-type/index.md)s
  *
  * @param [torService] [BaseService] for context.
  * */
-internal class ServiceEventBroadcaster(private val torService: BaseService): EventBroadcaster() {
+internal class ServiceEventBroadcaster private constructor(
+    private val torService: BaseService
+): EventBroadcaster() {
+
+    companion object {
+        @JvmSynthetic
+        fun instantiate(torService: BaseService): ServiceEventBroadcaster =
+            ServiceEventBroadcaster(torService)
+    }
 
     private val scopeMain: CoroutineScope
         get() = torService.getScopeMain()
@@ -180,28 +188,28 @@ internal class ServiceEventBroadcaster(private val torService: BaseService): Eve
             }
             // Dns Port
             // NOTICE|OnionProxyManager|Opened DNS listener on 127.0.0.1:5400
-            msg.contains("Opened DNS listener on ") -> {
+            msg.contains("Opened DNS listener ") -> {
                 dnsPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Http Tunnel Port
             // NOTICE|BaseEventListener|Opened HTTP tunnel listener on 127.0.0.1:8118
-            msg.contains("Opened HTTP tunnel listener on ") -> {
+            msg.contains("Opened HTTP tunnel listener ") -> {
                 httpTunnelPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Socks Port
             // NOTICE|BaseEventListener|Opened Socks listener on 127.0.0.1:9050
-            msg.contains("Opened Socks listener on ") -> {
+            msg.contains("Opened Socks listener ") -> {
                 socksPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()
             }
             // Trans Port
             // NOTICE|BaseEventListener|Opened Transparent pf/netfilter listener on 127.0.0.1:9040
-            msg.contains("Opened Transparent pf/netfilter listener on ") -> {
+            msg.contains("Opened Transparent pf/netfilter listener ") -> {
                 transPort = getPortFromMsg(msg)
                 if (isBootstrappingComplete())
                     updateAppEventBroadcasterWithPortInfo()

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/debug.md

@@ -2,7 +2,7 @@
 
 # debug
 
-`fun debug(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L122)
+`fun debug(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L131)
 
 Will only broadcast if [hasDebugLogs](#) is on.
 

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/error.md

@@ -2,4 +2,4 @@
 
 # error
 
-`fun error(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L148)
+`fun error(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L157)

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/exception.md

@@ -2,4 +2,4 @@
 
 # exception
 
-`fun exception(e: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L129)
+`fun exception(e: `[`Exception`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L138)

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/notice.md

@@ -2,4 +2,4 @@
 
 # notice
 
-`fun notice(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L136)
+`fun notice(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L145)

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/tor-state.md

@@ -2,4 +2,4 @@
 
 # torState
 
-`fun torState(state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, networkState: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L154)
+`fun torState(state: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, networkState: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L163)

docs/topl-core/io.matthewnelson.topl_core.broadcaster/-broadcast-logger/warn.md

@@ -2,4 +2,4 @@
 
 # warn
 
-`fun warn(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L142)
+`fun warn(msg: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) [(source)](https://github.com/05nelsonm/TorOnionProxyLibrary-Android/blob/master/topl-core/src/main/java/io/matthewnelson/topl_core/broadcaster/BroadcastLogger.kt#L151)