Merge pull request #66 from 05nelsonm/mn/feature/sample-app-upgrades

Sample App Upgrades

Author: 05nelsonm

gradle/dependencies.gradle

@@ -6,12 +6,13 @@ ext.versions = [
     'coroutines': '1.3.8',
     'lifecycle': '2.2.0',
     'kotlin': '1.3.72',
+    'navigation': '2.3.0',
 ]
 
 ext.deps = [
     androidGradlePlugin: "com.android.tools.build:gradle:4.0.1",
     androidx: [
-        appCompat: "androidx.appcompat:appcompat:1.1.0",
+        appCompat: "androidx.appcompat:appcompat:1.2.0",
         constraintLayout: "androidx.constraintlayout:constraintlayout:1.1.3",
         core: "androidx.core:core-ktx:1.3.1",
         lifecycle: [
@@ -22,6 +23,12 @@ ext.deps = [
             runtime: "androidx.lifecycle:lifecycle-runtime-ktx:${versions.lifecycle}",
             service: "androidx.lifecycle:lifecycle-service:${versions.lifecycle}",
         ],
+        navigation: [
+            fragment: "androidx.navigation:navigation-fragment:${versions.navigation}",
+            fragmentKtx: "androidx.navigation:navigation-fragment-ktx:${versions.navigation}",
+            ui: "androidx.navigation:navigation-ui:${versions.navigation}",
+            uiKtx: "androidx.navigation:navigation-ui-ktx:${versions.navigation}",
+        ],
         recyclerView: "androidx.recyclerview:recyclerview:1.1.0",
         test: [
             core: "androidx.test:core:1.2.0",

sampleapp/build.gradle

@@ -97,12 +97,18 @@ dependencies {
     implementation deps.androidx.lifecycle.commonJava8
     implementation deps.androidx.lifecycle.liveData
     implementation deps.androidx.lifecycle.reactiveStreams
+    implementation deps.androidx.navigation.fragment
+    implementation deps.androidx.navigation.fragmentKtx
+    implementation deps.androidx.navigation.ui
+    implementation deps.androidx.navigation.uiKtx
     implementation deps.androidx.recyclerView
     implementation deps.kotlin.coroutinesCore
     implementation deps.kotlin.coroutinesAndroid
     implementation deps.kotlin.stdlib
 
+    implementation 'io.matthewnelson.encrypted-storage:encrypted-storage:2.0.0'
     implementation 'io.matthewnelson.topl-android:tor-binary:0.4.3.5a'
+    implementation 'androidx.legacy:legacy-support-v4:1.0.0'
 
     testImplementation deps.junit
 

sampleapp/src/main/AndroidManifest.xml

@@ -1,7 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
     package="io.matthewnelson.sampleapp">
 
+    <!-- encrypted_storage dependency requires minSdk 23, but only if using the
+         encryption (which we're not) -->
+    <uses-sdk tools:overrideLibrary="io.matthewnelson.encrypted_storage, androidx.security" />
+
     <application
         android:name=".App"
         android:allowBackup="true"
@@ -10,7 +15,8 @@
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/AppTheme">
-        <activity android:name=".MainActivity">
+        <activity android:name=".ui.MainActivity"
+            android:screenOrientation="portrait" >
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 

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

@@ -67,128 +67,151 @@
 package io.matthewnelson.sampleapp
 
 import android.app.Application
-import android.content.Context
 import android.os.Process
-import androidx.core.app.NotificationCompat
-import io.matthewnelson.topl_core_base.TorConfigFiles
+import android.widget.Toast
+import io.matthewnelson.encrypted_storage.Prefs
+import io.matthewnelson.sampleapp.topl_android.MyEventBroadcaster
+import io.matthewnelson.sampleapp.topl_android.MyTorSettings
+import io.matthewnelson.sampleapp.ui.MainActivity
+import io.matthewnelson.sampleapp.ui.fragments.settings.library.LibraryPrefs
 import io.matthewnelson.topl_service.TorServiceController
 import io.matthewnelson.topl_service.notification.ServiceNotification
 import io.matthewnelson.topl_service.lifecycle.BackgroundManager
-import java.io.File
 
 /**
  * @suppress
+ *
+ * See [io.matthewnelson.sampleapp.topl_android.CodeSamples] for code samples
  * */
 class App: Application() {
 
-    override fun onCreate() {
-        super.onCreate()
-        setupTorServices(this, TorConfigFiles.createConfig(this))
-        TorServiceController.appEventBroadcaster?.let {
-            (it as MyEventBroadcaster).broadcastLogMessage(
-                "SampleApp|Application|Process ID: ${Process.myPid()}"
+    companion object {
+        const val PREFS_NAME = "TOPL-Android_SampleApp"
+        lateinit var stopTorDelaySettingAtAppStartup: String
+            private set
+
+        /**
+         * See [io.matthewnelson.sampleapp.topl_android.CodeSamples.generateTorServiceNotificationBuilder]
+         * for a cleaner sample
+         * */
+        fun generateTorServiceNotificationBuilder(
+            visibility: Int,
+            iconColorRes: Int,
+            enableRestart: Boolean,
+            enableStop: Boolean,
+            show: Boolean
+        ): ServiceNotification.Builder {
+            return ServiceNotification.Builder(
+                channelName = "TOPL-Android Demo",
+                channelDescription = "TorOnionProxyLibrary-Android Demo",
+                channelID = "TOPL-Android Demo",
+                notificationID = 615
             )
+                .setActivityToBeOpenedOnTap(
+                    clazz = MainActivity::class.java,
+                    intentExtrasKey = null,
+                    intentExtras = null,
+                    intentRequestCode = null
+                )
+
+                .setVisibility(visibility)
+                .setCustomColor(iconColorRes)
+                .enableTorRestartButton(enableRestart)
+                .enableTorStopButton(enableStop)
+                .showNotification(show)
         }
-        TorServiceController.startTor()
-    }
-
-    private fun generateTorServiceNotificationBuilder(): ServiceNotification.Builder {
-//  private fun generateTorServiceNotificationBuilder(): ServiceNotification.Builder {
-        return ServiceNotification.Builder(
-            channelName = "TorService Channel",
-            channelDescription = "Tor Channel",
-            channelID = "My Sample Application",
-            notificationID = 615
-        )
-            .setActivityToBeOpenedOnTap(
-                clazz = MainActivity::class.java,
-                intentExtrasKey = null,
-                intentExtras = null,
-                intentRequestCode = null
-            )
-            .setImageTorNetworkingEnabled(drawableRes = R.drawable.tor_stat_network_enabled)
-            .setImageTorNetworkingDisabled(drawableRes = R.drawable.tor_stat_network_disabled)
-            .setImageTorDataTransfer(drawableRes = R.drawable.tor_stat_network_dataxfer)
-            .setImageTorErrors(drawableRes = R.drawable.tor_stat_notifyerr)
-            .setVisibility(visibility = NotificationCompat.VISIBILITY_PRIVATE)
-            .setCustomColor(colorRes = R.color.primaryColor)
-            .enableTorRestartButton(enable = true)
-            .enableTorStopButton(enable = true)
-            .showNotification(show = true)
-//  }
-    }
 
-    private fun generateBackgroundManagerPolicy(): BackgroundManager.Builder.Policy {
-//  private fun generateBackgroundManagerPolicy(): BackgroundManager.Builder.Policy {
-        return BackgroundManager.Builder()
+        /**
+         * See [io.matthewnelson.sampleapp.topl_android.CodeSamples.generateBackgroundManagerPolicy]
+         * for a cleaner sample
+         * */
+        fun generateBackgroundManagerPolicy(
+            prefs: Prefs,
+            policy: String? = null,
+            killApp: Boolean? = null,
+            executionDelay: Int? = null
+        ): BackgroundManager.Builder.Policy {
+            val builder = BackgroundManager.Builder()
+            return when (policy ?: LibraryPrefs.getBackgroundManagerPolicySetting(prefs)) {
+                LibraryPrefs.BACKGROUND_MANAGER_POLICY_FOREGROUND -> {
+                    builder.runServiceInForeground(
+                        killApp ?: LibraryPrefs.getBackgroundManagerKillAppSetting(prefs)
+                    )
+                }
+                LibraryPrefs.BACKGROUND_MANAGER_POLICY_RESPECT -> {
+                    builder.respectResourcesWhileInBackground(
+                        executionDelay ?: LibraryPrefs.getBackgroundManagerExecuteDelaySetting(prefs)
+                    )
+                }
+                else -> {
+                    builder.respectResourcesWhileInBackground(20)
+                }
+            }
+        }
 
-            // All available options present. Only 1 is able to be chosen.
-            .respectResourcesWhileInBackground(secondsFrom5To45 = 20)
-            //.runServiceInForeground(killAppIfTaskIsRemoved = true)
-//  }
+        /**
+         * See [io.matthewnelson.sampleapp.topl_android.CodeSamples.setupTorServices]
+         * for a cleaner sample
+         * */
+        fun setupTorServices(
+            application: Application,
+            serviceNotificationBuilder: ServiceNotification.Builder,
+            backgroundManagerPolicy: BackgroundManager.Builder.Policy,
+            restartTimeDelay: Long,
+            stopServiceTimeDelay: Long,
+            stopServiceOnTaskRemoved: Boolean,
+            buildConfigDebug: Boolean
+        ) {
+            TorServiceController.Builder(
+                application = application,
+                torServiceNotificationBuilder = serviceNotificationBuilder,
+                backgroundManagerPolicy = backgroundManagerPolicy,
+                buildConfigVersionCode = BuildConfig.VERSION_CODE,
+                torSettings = MyTorSettings(),
+                geoipAssetPath = "common/geoip",
+                geoip6AssetPath = "common/geoip6"
+            )
+                .addTimeToRestartTorDelay(restartTimeDelay)
+                .addTimeToStopServiceDelay(stopServiceTimeDelay)
+                .disableStopServiceOnTaskRemoved(stopServiceOnTaskRemoved)
+                .setBuildConfigDebug(buildConfigDebug)
+                .setEventBroadcaster(eventBroadcaster = MyEventBroadcaster())
+                .build()
+        }
     }
 
-    private fun setupTorServices(application: Application, torConfigFiles: TorConfigFiles) {
-//  private fun setupTorServices(application: Application, torConfigFiles: TorConfigFiles ) {
-        TorServiceController.Builder(
-            application = application,
-            torServiceNotificationBuilder = generateTorServiceNotificationBuilder(),
-            backgroundManagerPolicy = generateBackgroundManagerPolicy(),
-            buildConfigVersionCode = BuildConfig.VERSION_CODE,
-
-            // Can instantiate directly here then access it from
-            // TorServiceController.Companion.getTorSettings() and cast what's returned
-            // as MyTorSettings
-            torSettings = MyTorSettings(),
-
-            // These should live somewhere in your module's assets directory,
-            // ex: my-project/my-application-module/src/main/assets/common/geoip
-            // ex: my-project/my-application-module/src/main/assets/common/geoip6
-            geoipAssetPath = "common/geoip",
-            geoip6AssetPath = "common/geoip6"
+    override fun onCreate() {
+        super.onCreate()
+        val prefs = Prefs.createUnencrypted(PREFS_NAME, this)
+
+        val serviceNotificationBuilder = generateTorServiceNotificationBuilder(
+            LibraryPrefs.getNotificationVisibilitySetting(prefs),
+            LibraryPrefs.getNotificationColorSetting(prefs),
+            LibraryPrefs.getNotificationRestartEnableSetting(prefs),
+            LibraryPrefs.getNotificationStopEnableSetting(prefs),
+            LibraryPrefs.getNotificationShowSetting(prefs)
         )
-            .addTimeToRestartTorDelay(milliseconds = 100L)
-            .addTimeToStopServiceDelay(milliseconds = 100L)
-            .disableStopServiceOnTaskRemoved(disable = false)
-            .setBuildConfigDebug(buildConfigDebug = BuildConfig.DEBUG)
-
-            // Can instantiate directly here then access it from
-            // TorServiceController.Companion?.appEventBroadcaster and cast what's returned
-            // as MyEventBroadcaster
-            .setEventBroadcaster(eventBroadcaster = MyEventBroadcaster())
-
-            // Only needed if you wish to customize the directories/files used by Tor if
-            // the defaults aren't to your liking.
-            .useCustomTorConfigFiles(torConfigFiles = torConfigFiles)
-
-            .build()
-//  }
-    }
-
-    fun customTorConfigFilesSetup(context: Context): TorConfigFiles {
-//  fun customTorConfigFilesSetup(context: Context): TorConfigFiles {
-
-        // This is modifying the directory hierarchy from TorService's
-        // default setup. For example, if you are using binaries for Tor that
-        // are named differently that that expressed in TorConfigFiles.createConfig()
 
-        // Post Android API 28 requires that executable files be contained in your
-        // application's data/app directory, as they can no longer execute from data/data.
-        val installDir = File(context.applicationInfo.nativeLibraryDir)
-
-        // Will create a directory within your application's data/data dir
-        val configDir = context.getDir("torservice", Context.MODE_PRIVATE)
-
-        val builder = TorConfigFiles.Builder(installDir, configDir)
-
-        // Customize the tor executable file name. Requires that the executable file
-        // be in your module's src/main/jniLibs directory. If you are getting your
-        // executable files via a dependency be sure to consult that Library's documentation.
-        builder.torExecutable(File(installDir, "libtor.so"))
-
-        // customize further via the builder methods...
+        stopTorDelaySettingAtAppStartup = LibraryPrefs.getControllerStopDelaySetting(prefs).toString()
+
+        try {
+            setupTorServices(
+                this,
+                serviceNotificationBuilder,
+                generateBackgroundManagerPolicy(prefs),
+                LibraryPrefs.getControllerRestartDelaySetting(prefs),
+                stopTorDelaySettingAtAppStartup.toLong(),
+                LibraryPrefs.getControllerDisableStopServiceOnTaskRemovedSetting(prefs),
+                LibraryPrefs.getControllerBuildConfigDebugSetting(prefs)
+            )
 
-        return builder.build()
-//  }
+            TorServiceController.appEventBroadcaster?.let {
+                (it as MyEventBroadcaster).broadcastLogMessage(
+                    "SampleApp|Application|Process ID: ${Process.myPid()}"
+                )
+            }
+        } catch (e: Exception) {
+            Toast.makeText(this, e.message, Toast.LENGTH_LONG).show()
+        }
     }
 }