Refactor log viewer activity

3 files changed, 232 insertions, 0 deletions

diff --git a/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogLiveData.kt b/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogLiveData.kt
new file mode 100644
index 0000000..f410a8c
--- /dev/null
+++ b/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogLiveData.kt
@@ -0,0 +1,74 @@
+/*
+ * Tinc App, an Android binding and user interface for the tinc mesh VPN daemon
+ * Copyright (C) 2017-2018 Pacien TRAN-GIRARD
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.pacien.tincapp.activities.viewlog
+
+import android.arch.lifecycle.LiveData
+import org.pacien.tincapp.commands.Executor
+import org.pacien.tincapp.commands.Tinc
+import java.util.*
+import kotlin.concurrent.timer
+
+/**
+ * @author pacien
+ */
+class LogLiveData(private val netName: String, private val logLevel: Int, private val logLineSize: Int) : LiveData<List<String>>() {
+  private val updateInterval = 250L // milliseconds
+  private val executor = Executor
+  private val log = LinkedList<String>()
+  private var loggerProcess: Process? = null
+  private var logUpdateTimer: Timer? = null
+
+  override fun onActive() {
+    loggerProcess = startNewLogger()
+    logUpdateTimer = timer(period = updateInterval, action = { outputLog() })
+  }
+
+  override fun onInactive() {
+    loggerProcess?.destroy()
+    logUpdateTimer?.apply { cancel() }?.apply { purge() }
+  }
+
+  private fun startNewLogger(): Process {
+    val newProcess = Tinc.log(netName, logLevel)
+    executor.runAsyncTask { captureProcessOutput(newProcess) }
+    return newProcess
+  }
+
+  private fun captureProcessOutput(process: Process) {
+    process.inputStream?.use { inputStream ->
+      inputStream.bufferedReader().useLines { lines ->
+        lines.forEach { appendToLog(it) }
+      }
+    }
+  }
+
+  private fun appendToLog(line: String) {
+    synchronized(log) {
+      if (log.size >= logLineSize) log.removeFirst()
+      log.addLast(line)
+    }
+  }
+
+  private fun outputLog() {
+    synchronized(log) {
+      val logView = ArrayList(log)
+      postValue(logView)
+    }
+  }
+}
diff --git a/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogViewModel.kt b/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogViewModel.kt
new file mode 100644
index 0000000..d9f0017
--- /dev/null
+++ b/app/src/main/java/org/pacien/tincapp/activities/viewlog/LogViewModel.kt
@@ -0,0 +1,33 @@
+/*
+ * Tinc App, an Android binding and user interface for the tinc mesh VPN daemon
+ * Copyright (C) 2017-2018 Pacien TRAN-GIRARD
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.pacien.tincapp.activities.viewlog
+
+import android.arch.lifecycle.ViewModel
+import org.pacien.tincapp.service.TincVpnService
+
+/**
+ * @author pacien
+ */
+class LogViewModel : ViewModel() {
+  private val logLevelNumeric = 5
+  val logLevelText = "DEBUG"
+  val netName by lazy { TincVpnService.getCurrentNetName()!! }
+  val log by lazy { LogLiveData(netName, logLevelNumeric, 250) }
+  var logging = true
+}
diff --git a/app/src/main/java/org/pacien/tincapp/activities/viewlog/ViewLogActivity.kt b/app/src/main/java/org/pacien/tincapp/activities/viewlog/ViewLogActivity.kt
new file mode 100644
index 0000000..a4e2216
--- /dev/null
+++ b/app/src/main/java/org/pacien/tincapp/activities/viewlog/ViewLogActivity.kt
@@ -0,0 +1,125 @@
+/*
+ * Tinc App, an Android binding and user interface for the tinc mesh VPN daemon
+ * Copyright (C) 2017-2018 Pacien TRAN-GIRARD
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package org.pacien.tincapp.activities.viewlog
+
+import android.arch.lifecycle.Observer
+import android.arch.lifecycle.ViewModelProviders
+import android.content.Intent
+import android.os.Bundle
+import android.view.Menu
+import android.view.MenuItem
+import android.view.View
+import android.widget.ScrollView
+import kotlinx.android.synthetic.main.base.*
+import kotlinx.android.synthetic.main.view_log_activity.*
+import org.pacien.tincapp.R
+import org.pacien.tincapp.activities.BaseActivity
+
+/**
+ * @author pacien
+ */
+class ViewLogActivity : BaseActivity() {
+  private val viewModel by lazy { ViewModelProviders.of(this).get(LogViewModel::class.java) }
+  private val logObserver: Observer<List<String>> = Observer { showLog(it) }
+  private var toggleButton: MenuItem? = null
+
+  override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+    supportActionBar.setDisplayHomeAsUpEnabled(true)
+    layoutInflater.inflate(R.layout.view_log_activity, main_content)
+    enableLogging(viewModel.logging)
+  }
+
+  override fun onCreateOptionsMenu(m: Menu): Boolean {
+    menuInflater.inflate(R.menu.menu_viewlog, m)
+    toggleButton = m.findItem(R.id.log_viewer_action_toggle)
+    return super.onCreateOptionsMenu(m)
+  }
+
+  override fun onSupportNavigateUp(): Boolean {
+    finish()
+    return true
+  }
+
+  @Suppress("UNUSED_PARAMETER")
+  fun shareLog(m: MenuItem) {
+    val logSnippet = viewModel.log.value?.joinToString("\n")
+    val shareIntent = Intent(Intent.ACTION_SEND)
+      .setType("text/plain")
+      .putExtra(Intent.EXTRA_TEXT, logSnippet)
+
+    startActivityChooser(shareIntent, resources.getString(R.string.log_view_menu_share_log))
+  }
+
+  @Suppress("UNUSED_PARAMETER")
+  fun toggleLogging(m: MenuItem) =
+    enableLogging(!viewModel.logging)
+
+  private fun enableLogging(enable: Boolean) {
+    setLoggingStateSubtitle(enable)
+    setPauseButtonState(!enable)
+    enableScrolling(!enable)
+    viewModel.logging = enable
+
+    if (enable)
+      viewModel.log.observe(this, logObserver)
+    else
+      viewModel.log.removeObservers(this)