diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionArtifacts.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionArtifacts.kt index 9ec21c2090..c356bf0d04 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionArtifacts.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionArtifacts.kt @@ -200,22 +200,86 @@ object SessionArtifacts { internal fun recordedClient(dir: File): String? = runCatching { File(dir, CLIENT_FILE).readText().trim() }.getOrNull()?.takeIf { it == "arm64" || it == "x86_64" } + private const val LOG_MARKS = "steam-log-marks.txt" + private const val MAX_STEAM_LOG = 8L * 1024 * 1024 + private const val HEAD = 4096L + + private class Mark(val size: Long, val head: String) + + fun markSteamLogs(dir: File, logs: File) { + val lines = logs.listFiles { f -> f.isFile }?.mapNotNull { f -> + val size = f.length() + head(f, size)?.let { "$size\t$it\t${f.name}" } + } ?: return + runCatching { File(dir, LOG_MARKS).writeText(lines.joinToString("") { "$it\n" }) } + } + + private fun head(f: File, length: Long): String? = runCatching { + val buf = ByteArray(minOf(length, HEAD).toInt()) + f.inputStream().use { input -> + var off = 0 + while (off < buf.size) { + val n = input.read(buf, off, buf.size - off) + if (n < 0) return@runCatching null + off += n + } + } + java.security.MessageDigest.getInstance("SHA-1").digest(buf).joinToString("") { "%02x".format(it) } + }.getOrNull() + + private fun steamLogMarks(dir: File): List? = runCatching { + File(dir, LOG_MARKS).readLines().mapNotNull { line -> + val parts = line.split('\t', limit = 3) + parts.getOrNull(0)?.toLongOrNull()?.let { size -> parts.getOrNull(1)?.let { Mark(size, it) } } + } + }.getOrNull() + + private fun startOf(src: File, size: Long, marks: List): Long { + val heads = HashMap() + return marks.filter { it.size <= size }.sortedByDescending { it.size } + .firstOrNull { m -> heads.getOrPut(minOf(m.size, HEAD)) { head(src, m.size) } == m.head }?.size ?: 0L + } + private fun copySteamLogs(context: Context, dir: File, record: Record, steamArch: String? = null) { val logs = File(steamArch?.let { SessionPrefs.steamRoot(context, it) } ?: SessionPrefs.activeSteamRoot(context), "logs") if (!logs.isDirectory) return val out = File(dir, "steam").apply { mkdirs() } - logs.listFiles { f -> f.isFile && f.length() < 8L * 1024 * 1024 }?.forEach { src -> + copySessionLogs(logs, dir, out).forEach { dst -> record.files[dst] = Scrubbed(dst.length(), dst.lastModified()) } + Log.i(TAG, "collected ${out.listFiles()?.size ?: 0} Steam log(s), scrubbed, into $out") + } + + internal fun copySessionLogs(logs: File, dir: File, out: File): List { + val marks = steamLogMarks(dir) + val copied = ArrayList() + logs.listFiles { f -> f.isFile }?.forEach { src -> + val size = src.length() + val from = marks?.let { startOf(src, size, it) } ?: 0L + if (marks != null && from == size || size - from >= MAX_STEAM_LOG) return@forEach try { val dst = File(out, src.name) - dst.bufferedWriter().use { w -> - src.forEachLine { line -> w.write(LogRedactor.redact(line)); w.newLine() } + src.inputStream().buffered().use { input -> + var left = if (from > 0) from - 1 else 0L + while (left > 0) { + val skipped = input.skip(left) + if (skipped <= 0) break + left -= skipped + } + if (from > 0 && input.read() != '\n'.code) { + while (true) { + val c = input.read() + if (c < 0 || c == '\n'.code) break + } + } + dst.bufferedWriter().use { w -> + input.bufferedReader().forEachLine { line -> w.write(LogRedactor.redact(line)); w.newLine() } + } } - record.files[dst] = Scrubbed(dst.length(), dst.lastModified()) + copied.add(dst) } catch (e: Exception) { Log.w(TAG, "could not scrub ${src.name}", e) } } - Log.i(TAG, "collected ${out.listFiles()?.size ?: 0} Steam log(s), scrubbed, into $out") + return copied } @Synchronized diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt index 762de4f93b..ebc9212390 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt @@ -710,7 +710,10 @@ class SessionService : Service() { SessionState.steamClientArch = if (steamHere) SessionPrefs.steamClientArch(this) else null SessionState.steamClientArch?.let { arch -> guest.add("BL_STEAM_CLIENT_ARCH=$arch") - SessionPaths.current()?.let { SessionArtifacts.recordClient(it, arch) } + SessionPaths.current()?.let { + SessionArtifacts.recordClient(it, arch) + SessionArtifacts.markSteamLogs(it, File(SessionPrefs.steamRoot(this, arch), "logs")) + } if (arch == "x86_64") FexCatalog.cached(this)?.let { guest.addAll(FexCatalog.environment(it)) } } if (SessionState.mode == MODE_STEAM) { diff --git a/app/src/test/java/com/droiddeck/launcher/session/SessionSteamLogsTest.kt b/app/src/test/java/com/droiddeck/launcher/session/SessionSteamLogsTest.kt new file mode 100644 index 0000000000..60c57ecfd5 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionSteamLogsTest.kt @@ -0,0 +1,62 @@ +package com.droiddeck.launcher.session + +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder +import java.io.File + +class SessionSteamLogsTest { + @get:Rule val tmp = TemporaryFolder() + + private fun names(files: List) = files.map { it.name }.sorted() + + @Test fun onlyWhatTheSessionWroteIsCollected() { + val logs = tmp.newFolder("logs") + val session = tmp.newFolder("session") + val out = tmp.newFolder("out") + File(logs, "console_log.txt").writeText("old line\n") + File(logs, "cef_log.txt").writeText("old cef\n") + File(logs, "cef_log.previous.txt").writeText("older cef\n") + File(logs, "shrunk.txt").writeText("a long old line\n") + File(logs, "untouched.txt").writeText("nothing new\n") + SessionArtifacts.markSteamLogs(session, logs) + + File(logs, "console_log.txt").appendText("new line\n") + File(logs, "cef_log.previous.txt").delete() + File(logs, "cef_log.txt").renameTo(File(logs, "cef_log.previous.txt")) + File(logs, "cef_log.txt").writeText("this session's cef\n") + File(logs, "shrunk.txt").writeText("short\n") + File(logs, "content_log.txt").writeText("created this session\n") + + val copied = SessionArtifacts.copySessionLogs(logs, session, out) + assertEquals(listOf("cef_log.txt", "console_log.txt", "content_log.txt", "shrunk.txt"), names(copied)) + assertEquals("new line\n", File(out, "console_log.txt").readText()) + assertEquals("this session's cef\n", File(out, "cef_log.txt").readText()) + assertEquals("short\n", File(out, "shrunk.txt").readText()) + assertFalse(File(out, "cef_log.previous.txt").exists()) + assertFalse(File(out, "untouched.txt").exists()) + } + + @Test fun aLineCutByTheMarkIsLeftOut() { + val logs = tmp.newFolder("logs") + val session = tmp.newFolder("session") + val out = tmp.newFolder("out") + File(logs, "web.txt").writeText("old\nGET /x?sessionid=") + SessionArtifacts.markSteamLogs(session, logs) + File(logs, "web.txt").appendText("abcdef123456 200\nnext line\n") + SessionArtifacts.copySessionLogs(logs, session, out) + assertEquals("next line\n", File(out, "web.txt").readText()) + } + + @Test fun withoutMarksEveryLogUnderTheCapIsCollectedAndRedacted() { + val logs = tmp.newFolder("logs") + val out = tmp.newFolder("out") + File(logs, "web.txt").writeText("GET /x?sessionid=abcdef123456 200\n") + File(logs, "big.txt").outputStream().use { it.write(ByteArray(8 * 1024 * 1024)) } + val copied = SessionArtifacts.copySessionLogs(logs, tmp.newFolder("session"), out) + assertEquals(listOf("web.txt"), names(copied)) + assertFalse(File(out, "web.txt").readText().contains("abcdef123456")) + } +} diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session index d8a44be52f..368740c147 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session @@ -86,12 +86,6 @@ run_gamescope() ( collect_steam_logs() { [ -n "${BL_DEBUG_DIR:-}" ] || return 0 - local steam_root=${XDG_DATA_HOME:-$HOME/.local/share}/Steam - [ "${steam_x64:-0}" = 1 ] && steam_root=${BL_X64_HOME:-$HOME/.droiddeck-x64}/.local/share/Steam - mkdir -p "$BL_DEBUG_DIR/steam" 2>/dev/null || return 0 - [ -d "$steam_root/logs" ] && find "$steam_root/logs" -maxdepth 1 -type f -size -8192k \ - -exec cp {} "$BL_DEBUG_DIR/steam/" \; 2>/dev/null - [ "${steam_x64:-0}" = 0 ] && [ -f "$HOME/.steam/steam/logs/steamwebhelper.log" ] && cp "$HOME/.steam/steam/logs/steamwebhelper.log" "$BL_DEBUG_DIR/steam/" 2>/dev/null local sync_store=$HOME/.local/share/droiddeck-esync sync_file if [ -d "$sync_store" ] && mkdir -p "$BL_DEBUG_DIR/droiddeck-esync" 2>/dev/null; then for sync_file in launches.log tools.tsv wanted.tsv prefixes.json; do @@ -102,7 +96,6 @@ collect_steam_logs() { if [ -d "$fex_state" ] && mkdir -p "$BL_DEBUG_DIR/droiddeck-fex" 2>/dev/null; then cp "$fex_state/status.json" "$fex_state/config/Config.json" "$BL_DEBUG_DIR/droiddeck-fex/" 2>/dev/null fi - echo "== steam logs copied to $BL_DEBUG_DIR/steam" } trap 'collect_steam_logs 2>/dev/null || true' TERM INT HUP if [ -n "${BL_VK_DRIVER:-}" ]; then