#1890 feat: add button to save log to file and share it

Author: sds100

CHANGELOG.md

@@ -2,11 +2,15 @@
 
 #### TO BE RELEASED
 
+## Added
+
+- #1890 add button to save log to file and share it. The clipboard button now cuts off older entries and keeps newest ones.
+
 ## Fixed
 
 - Only autostart PRO mode with Shizuku if Shizuku permission is granted. Otherwise fallback to method with Wireless Debugging and WRITE_SECURE_SETTINGS permission.
 - Starting system bridge for the first time would be janky because granting READ_LOGS kills the app process. Only grant for READ_LOGS when sharing logcat from settings.
-- #1886 mobile data actions work in PRO mode
+- #1886 mobile data actions work in PRO mode.
 
 ## [4.0.0 Beta 1](https://github.com/sds100/KeyMapper/releases/tag/v4.0.0-beta.01)
 

base/src/main/java/io/github/sds100/keymapper/base/logging/DisplayLogUseCase.kt

@@ -1,26 +1,39 @@
 package io.github.sds100.keymapper.base.logging
 
+import android.content.Context
+import androidx.core.net.toUri
+import dagger.hilt.android.qualifiers.ApplicationContext
 import io.github.sds100.keymapper.base.R
+import io.github.sds100.keymapper.base.utils.ShareUtils
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
+import io.github.sds100.keymapper.common.BuildConfigProvider
 import io.github.sds100.keymapper.data.entities.LogEntryEntity
 import io.github.sds100.keymapper.data.repositories.LogRepository
 import io.github.sds100.keymapper.system.clipboard.ClipboardAdapter
 import io.github.sds100.keymapper.system.files.FileAdapter
+import io.github.sds100.keymapper.system.files.FileUtils
+import io.github.sds100.keymapper.system.files.IFile
 import java.text.SimpleDateFormat
 import java.util.Date
 import java.util.Locale
 import javax.inject.Inject
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.flowOn
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 
 class DisplayLogUseCaseImpl @Inject constructor(
+    @ApplicationContext private val ctx: Context,
+    private val coroutineScope: CoroutineScope,
     private val repository: LogRepository,
     private val resourceProvider: ResourceProvider,
     private val clipboardAdapter: ClipboardAdapter,
     private val fileAdapter: FileAdapter,
+    private val buildConfigProvider: BuildConfigProvider,
 ) : DisplayLogUseCase {
     private val dateFormat = SimpleDateFormat("MM/dd HH:mm:ss.SSS", Locale.getDefault())
     private val severityString: Map<Int, String> = mapOf(
@@ -56,12 +69,37 @@ class DisplayLogUseCaseImpl @Inject constructor(
 
             logEntries
                 .reversed()
-                .joinToString(separator = "\n") { entry ->
-                    val date = dateFormat.format(Date(entry.time))
+                .joinToString(separator = "\n", transform = ::entryToString)
+                .also { append(it) }
+        }
+    }
+
+    private fun entryToString(entry: LogEntryEntity): String {
+        val date = dateFormat.format(Date(entry.time))
+
+        return "$date ${severityString[entry.severity]} ${entry.message}"
+    }
 
-                    return@joinToString "$date ${severityString[entry.severity]} ${entry.message}"
+    override fun shareFile() {
+        val fileName = "logs/key_mapper_log_${FileUtils.createFileDate()}.txt"
+
+        coroutineScope.launch {
+            withContext(Dispatchers.IO) {
+                val logEntries = repository.log.first()
+                val logText = logEntries.joinToString(separator = "\n", transform = ::entryToString)
+
+                val file: IFile = fileAdapter.getPrivateFile(fileName)
+                file.createFile()
+
+                with(file.outputStream()?.bufferedWriter()) {
+                    this?.write(logText)
+                    this?.flush()
                 }
-                .also { append(it) }
+
+                val publicUri = fileAdapter.getPublicUriForPrivateFile(file)
+
+                ShareUtils.shareFile(ctx, publicUri.toUri(), buildConfigProvider.packageName)
+            }
         }
     }
 }
@@ -70,4 +108,5 @@ interface DisplayLogUseCase {
     val log: Flow<List<LogEntry>>
     fun clearLog()
     suspend fun copyToClipboard()
+    fun shareFile()
 }

base/src/main/java/io/github/sds100/keymapper/base/logging/LogScreen.kt

@@ -16,6 +16,7 @@ import androidx.compose.foundation.lazy.rememberLazyListState
 import androidx.compose.material.icons.Icons
 import androidx.compose.material.icons.automirrored.rounded.ArrowBack
 import androidx.compose.material.icons.outlined.ContentCopy
+import androidx.compose.material.icons.outlined.Share
 import androidx.compose.material3.BottomAppBar
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Icon
@@ -53,6 +54,7 @@ fun LogScreen(
         modifier = modifier,
         onBackClick = onBackClick,
         onCopyToClipboardClick = viewModel::onCopyToClipboardClick,
+        onShareClick = viewModel::onShareFileClick,
         onClearLogClick = viewModel::onClearLogClick,
         content = {
             Content(
@@ -69,6 +71,7 @@ private fun LogScreen(
     modifier: Modifier = Modifier,
     onBackClick: () -> Unit = {},
     onCopyToClipboardClick: () -> Unit = {},
+    onShareClick: () -> Unit = {},
     onClearLogClick: () -> Unit = {},
     content: @Composable () -> Unit,
 ) {
@@ -96,6 +99,13 @@ private fun LogScreen(
                     )
                 }
                 Spacer(Modifier.weight(1f))
+                IconButton(onClick = onShareClick) {
+                    Icon(
+                        imageVector = Icons.Outlined.Share,
+                        contentDescription = stringResource(R.string.action_share_log),
+                    )
+                }
+
                 IconButton(onClick = onCopyToClipboardClick) {
                     Icon(
                         imageVector = Icons.Outlined.ContentCopy,

base/src/main/java/io/github/sds100/keymapper/base/logging/LogViewModel.kt

@@ -42,6 +42,12 @@ class LogViewModel @Inject constructor(private val displayLogUseCase: DisplayLog
         }
     }
 
+    fun onShareFileClick() {
+        viewModelScope.launch {
+            displayLogUseCase.shareFile()
+        }
+    }
+
     fun onClearLogClick() {
         displayLogUseCase.clearLog()
     }

base/src/main/res/values/strings.xml

@@ -388,7 +388,7 @@
     <string name="action_backup_everything">Back up everything</string>
     <string name="action_tap_to_pause_keymaps">Tap to pause</string>
     <string name="action_tap_to_resume_keymaps">Tap to resume</string>
-    <string name="action_save_log">Save</string>
+    <string name="action_share_log">Share</string>
     <string name="action_short_log_message">Toggle short messages</string>
     <string name="action_copy_log">Copy</string>
     <string name="action_clear_log">Clear</string>