Implement dual logging for application context

4 files changed, 91 insertions, 21 deletions

diff --git a/app/src/main/java/org/pacien/tincapp/context/App.kt b/app/src/main/java/org/pacien/tincapp/context/App.kt
index d79ae3e..53049f3 100644
--- a/app/src/main/java/org/pacien/tincapp/context/App.kt
+++ b/app/src/main/java/org/pacien/tincapp/context/App.kt
@@ -9,15 +9,31 @@ import android.support.annotation.StringRes
 import android.support.v7.app.AlertDialog
 import android.view.WindowManager
 import org.pacien.tincapp.R
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 
 /**
  * @author pacien
  */
-class App : Application() {
+class App : Application(), Thread.UncaughtExceptionHandler {
+  private var logger: Logger? = null
+  private var systemCrashHandler: Thread.UncaughtExceptionHandler? = null
+
   override fun onCreate() {
     super.onCreate()
     appContext = applicationContext
     handler = Handler()
+
+    AppLogger.configure()
+    logger = LoggerFactory.getLogger(this.javaClass)
+
+    systemCrashHandler = Thread.getDefaultUncaughtExceptionHandler()
+    Thread.setDefaultUncaughtExceptionHandler(this)
+  }
+
+  override fun uncaughtException(thread: Thread, throwable: Throwable) {
+    logger?.error("Fatal application error.", throwable)
+    systemCrashHandler?.uncaughtException(thread, throwable)
   }
 
   companion object {
diff --git a/app/src/main/java/org/pacien/tincapp/context/AppLogger.kt b/app/src/main/java/org/pacien/tincapp/context/AppLogger.kt
new file mode 100644
index 0000000..e240e70
--- /dev/null
+++ b/app/src/main/java/org/pacien/tincapp/context/AppLogger.kt
@@ -0,0 +1,45 @@
+package org.pacien.tincapp.context
+
+import ch.qos.logback.classic.Logger
+import ch.qos.logback.classic.LoggerContext
+import ch.qos.logback.classic.android.LogcatAppender
+import ch.qos.logback.classic.encoder.PatternLayoutEncoder
+import ch.qos.logback.classic.spi.ILoggingEvent
+import ch.qos.logback.core.Context
+import ch.qos.logback.core.FileAppender
+import org.slf4j.LoggerFactory
+
+/**
+ * @author pacien
+ */
+object AppLogger {
+  private const val LOGCAT_PATTERN = "[%thread] %msg%n%rEx"
+  private const val LOGFILE_PATTERN = "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n%rEx"
+
+  fun configure() {
+    (LoggerFactory.getILoggerFactory() as LoggerContext)
+      .apply { reset() }
+      .let { loggerContext ->
+        (LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME) as Logger)
+          .apply {
+            addAppender(LogcatAppender()
+              .apply { context = loggerContext }
+              .apply { encoder = patternEncoder(loggerContext, LOGCAT_PATTERN) }
+              .apply { start() })
+          }
+          .apply {
+            addAppender(FileAppender<ILoggingEvent>()
+              .apply { context = loggerContext }
+              .apply { encoder = patternEncoder(loggerContext, LOGFILE_PATTERN) }
+              .apply { file = AppPaths.appLogFile().absolutePath }
+              .apply { start() })
+          }
+      }
+  }
+
+  private fun patternEncoder(ctx: Context, pat: String) =
+    PatternLayoutEncoder()
+      .apply { context = ctx }
+      .apply { pattern = pat }
+      .apply { start() }
+}
diff --git a/app/src/main/java/org/pacien/tincapp/context/AppPaths.kt b/app/src/main/java/org/pacien/tincapp/context/AppPaths.kt
index 9315060..4b36dfe 100644
--- a/app/src/main/java/org/pacien/tincapp/context/AppPaths.kt
+++ b/app/src/main/java/org/pacien/tincapp/context/AppPaths.kt
@@ -10,21 +10,22 @@ import java.io.FileNotFoundException
  * @implNote Logs and PID files are stored in the cache directory for easy clean up.
  */
 object AppPaths {
-  private val TINCD_BIN = "libtincd.so"
-  private val TINC_BIN = "libtinc.so"
+  private const val TINCD_BIN = "libtincd.so"
+  private const val TINC_BIN = "libtinc.so"
 
-  private val LOGFILE_FORMAT = "tinc.%s.log"
-  private val PIDFILE_FORMAT = "tinc.%s.pid"
+  private const val APPLOG_FILE = "tincapp.log"
+  private const val LOGFILE_FORMAT = "tinc.%s.log"
+  private const val PIDFILE_FORMAT = "tinc.%s.pid"
 
-  private val NET_CONF_FILE = "network.conf"
-  private val NET_TINC_CONF_FILE = "tinc.conf"
-  private val NET_HOSTS_DIR = "hosts"
-  private val NET_INVITATION_FILE = "invitation-data"
-  private val NET_DEFAULT_ED25519_PRIVATE_KEY_FILE = "ed25519_key.priv"
-  private val NET_DEFAULT_RSA_PRIVATE_KEY_FILE = "rsa_key.priv"
+  private const val NET_CONF_FILE = "network.conf"
+  private const val NET_TINC_CONF_FILE = "tinc.conf"
+  private const val NET_HOSTS_DIR = "hosts"
+  private const val NET_INVITATION_FILE = "invitation-data"
+  private const val NET_DEFAULT_ED25519_PRIVATE_KEY_FILE = "ed25519_key.priv"
+  private const val NET_DEFAULT_RSA_PRIVATE_KEY_FILE = "rsa_key.priv"
 
   fun storageAvailable() =
-  Environment.getExternalStorageState().let { it == Environment.MEDIA_MOUNTED && it != Environment.MEDIA_MOUNTED_READ_ONLY }
+    Environment.getExternalStorageState().let { it == Environment.MEDIA_MOUNTED && it != Environment.MEDIA_MOUNTED_READ_ONLY }
 
   fun cacheDir() = App.getContext().externalCacheDir
   fun confDir() = App.getContext().getExternalFilesDir(null)
@@ -37,6 +38,7 @@ object AppPaths {
   fun invitationFile(netName: String) = File(confDir(netName), NET_INVITATION_FILE)
   fun logFile(netName: String) = File(cacheDir(), String.format(LOGFILE_FORMAT, netName))
   fun pidFile(netName: String) = File(App.getContext().cacheDir, String.format(PIDFILE_FORMAT, netName))
+  fun appLogFile() = File(cacheDir(), APPLOG_FILE)
 
   fun existing(f: File) = f.apply { if (!exists()) throw FileNotFoundException(f.absolutePath) }
 
diff --git a/app/src/main/java/org/pacien/tincapp/service/TincVpnService.kt b/app/src/main/java/org/pacien/tincapp/service/TincVpnService.kt
index 0bf72a1..69811f4 100644
--- a/app/src/main/java/org/pacien/tincapp/service/TincVpnService.kt
+++ b/app/src/main/java/org/pacien/tincapp/service/TincVpnService.kt
@@ -5,7 +5,6 @@ import android.content.Intent
 import android.net.VpnService
 import android.os.ParcelFileDescriptor
 import android.support.v4.content.LocalBroadcastManager
-import android.util.Log
 import java8.util.concurrent.CompletableFuture
 import org.apache.commons.configuration2.ex.ConversionException
 import org.bouncycastle.openssl.PEMException
@@ -22,19 +21,28 @@ import org.pacien.tincapp.extensions.Java.applyIgnoringException
 import org.pacien.tincapp.extensions.VpnServiceBuilder.applyCfg
 import org.pacien.tincapp.intent.Actions
 import org.pacien.tincapp.utils.TincKeyring
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 import java.io.FileNotFoundException
 
 /**
  * @author pacien
  */
 class TincVpnService : VpnService() {
+  private var logger: Logger? = null
+
+  override fun onCreate() {
+    super.onCreate()
+    logger = LoggerFactory.getLogger(this.javaClass)
+  }
+
   override fun onDestroy() {
     stopVpn()
     super.onDestroy()
   }
 
   override fun onStartCommand(intent: Intent, flags: Int, startId: Int): Int {
-    Log.i(TAG, intent.action)
+    logger?.info("Intent received: {}", intent.action)
 
     when {
       intent.action == Actions.ACTION_CONNECT && intent.scheme == Actions.TINC_SCHEME ->
@@ -61,7 +69,7 @@ class TincVpnService : VpnService() {
     if (!AppPaths.confDir(netName).exists())
       return reportError(resources.getString(R.string.message_no_configuration_for_network_format, netName), docTopic = "configuration")
 
-    Log.i(TAG, "Starting tinc daemon for network \"$netName\".")
+    logger?.info("Starting tinc daemon for network \"$netName\".")
     if (isConnected()) stopVpn()
 
     val interfaceCfg = try {
@@ -108,17 +116,17 @@ class TincVpnService : VpnService() {