diff --git a/README.md b/README.md index 97043973e1..62e7939526 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Compatibility and performance vary by device; hardware validation is limited. De ## Credits and licence -GPL-3.0. Runtime, shim, input, and controller work build on WinNative and Bannerlator (maxjivi05). Epic Games and GOG support build on [Phobos’s](https://github.com/phobos665) adaptation of [Legendary](https://github.com/legendary-gl/legendary) and [gogdl](https://github.com/Heroic-Games-Launcher/heroic-gogdl), respectively. The registry entries a GOG game's install script (`goggame-.script`) sets are read the way [Heroic Games Launcher](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher)'s GOG setup (GPL-3.0) reads them. LSFG frame generation is from the work of Camille LaVey and the [Eden](https://eden-emu.dev) emulator project, following [lsfg-vk](https://github.com/PancakeTAS/lsfg-vk), ported to WinNative and DroidDeck by [@maxjivi05](https://github.com/maxjivi05); it needs your own copy of [Lossless Scaling](https://store.steampowered.com/app/993090/) and ships none of its shaders. x86 AppImages, and any whose own runtime cannot unpack them, are unpacked with [uruntime](https://github.com/VHSgunzo/uruntime) by VHSgunzo (MIT), shipped unmodified with its licence, which also starts the arm64 emulator AppImages whose own runtime cannot run its extractor on Android. The Steam client's audio goes through [@The412Banner](https://github.com/The412Banner)'s [DirectAudio](https://github.com/The412Banner/directaudio) PulseAudio sink (LGPL-2.1-or-later), built from `tools/directaudio/sink` with its request size kept to its ring so clients are not asked to queue 100 ms ahead. mmap ring-buffer controller input was developed by ribbit384 ([WinNative #345](https://github.com/WinNative-Emu/WinNative/pull/345)). Why the x86-64 Steam client refused the arm64 client's sign-in was checked by reading Steam's saved token with the `ConnectCache` format from [deadlock-api-ingest](https://github.com/deadlock-api/deadlock-api-ingest). x86 programs that link OpenSSL 3 under FEX use the copy in the [Steam Linux Runtime 4.0](https://gitlab.steamos.cloud/steamrt/steamrt) platform. Hooks written with `WriteProcessMemory` into code [FEX](https://github.com/FEX-Emu/FEX) has translated go through `/proc//mem` again when the kernel refuses `process_vm_writev`, as [Wine](https://gitlab.winehq.org/wine/wine)'s `server/ptrace.c` wrote them before Wine 11. x86 Linux games under FEX get the same `/etc/asound.conf` that [pressure-vessel](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools) writes into the Steam Linux Runtime, so ALSA plays through PulseAudio. Games render with [Mesa](https://gitlab.freedesktop.org/mesa/mesa) Turnip's own per-render-pass choice between tile memory and system memory, while the Steam client keeps `TU_DEBUG=sysmem`; [FEX](https://github.com/FEX-Emu/FEX)'s code disk cache was checked in its source and is already on through Proton. See [LICENSE](LICENSE). Steam and Proton belong to Valve Corporation; this project is not affiliated with Valve. +GPL-3.0. Runtime, shim, input, and controller work build on WinNative and Bannerlator (maxjivi05). Epic Games and GOG support build on [Phobos’s](https://github.com/phobos665) adaptation of [Legendary](https://github.com/legendary-gl/legendary) and [gogdl](https://github.com/Heroic-Games-Launcher/heroic-gogdl), respectively. The registry entries a GOG game's install script (`goggame-.script`) sets are read the way [Heroic Games Launcher](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher)'s GOG setup (GPL-3.0) reads them. LSFG frame generation is from the work of Camille LaVey and the [Eden](https://eden-emu.dev) emulator project, following [lsfg-vk](https://github.com/PancakeTAS/lsfg-vk), ported to WinNative and DroidDeck by [@maxjivi05](https://github.com/maxjivi05); it needs your own copy of [Lossless Scaling](https://store.steampowered.com/app/993090/) and ships none of its shaders. x86 AppImages, and any whose own runtime cannot unpack them, are unpacked with [uruntime](https://github.com/VHSgunzo/uruntime) by VHSgunzo (MIT), shipped unmodified with its licence, which also starts the arm64 emulator AppImages whose own runtime cannot run its extractor on Android. The Steam client's audio goes through [@The412Banner](https://github.com/The412Banner)'s [DirectAudio](https://github.com/The412Banner/directaudio) PulseAudio sink (LGPL-2.1-or-later), built from `tools/directaudio/sink` with its request size kept to its ring so clients are not asked to queue 100 ms ahead. mmap ring-buffer controller input was developed by ribbit384 ([WinNative #345](https://github.com/WinNative-Emu/WinNative/pull/345)). Why the x86-64 Steam client refused the arm64 client's sign-in was checked by reading Steam's saved token with the `ConnectCache` format from [deadlock-api-ingest](https://github.com/deadlock-api/deadlock-api-ingest). x86 programs that link OpenSSL 3 under FEX use the copy in the [Steam Linux Runtime 4.0](https://gitlab.steamos.cloud/steamrt/steamrt) platform. Hooks written with `WriteProcessMemory` into code [FEX](https://github.com/FEX-Emu/FEX) has translated go through `/proc//mem` again when the kernel refuses `process_vm_writev`, as [Wine](https://gitlab.winehq.org/wine/wine)'s `server/ptrace.c` wrote them before Wine 11. x86 Linux games under FEX get the same `/etc/asound.conf` that [pressure-vessel](https://gitlab.steamos.cloud/steamrt/steam-runtime-tools) writes into the Steam Linux Runtime, so ALSA plays through PulseAudio. Games render with [Mesa](https://gitlab.freedesktop.org/mesa/mesa) Turnip's own per-render-pass choice between tile memory and system memory, while the Steam client keeps `TU_DEBUG=sysmem`; [FEX](https://github.com/FEX-Emu/FEX)'s code disk cache was checked in its source and is already on through Proton. The proot fast path picks the guest name of a host file bound under several names in the order [PRoot](https://github.com/proot-me/proot)'s `path/binding.c` (GPL-2.0-or-later) sorts its bindings, so links and `/proc/self/fd` read back as they do through proot. The session's [PipeWire](https://gitlab.freedesktop.org/pipewire/pipewire) (MIT) opens its sockets with the per-socket access settings documented in its `module-access.c`, and [WirePlumber](https://gitlab.freedesktop.org/pipewire/wireplumber) (MIT) keeps those clients at full permissions through its `access.rules`. Wine write watches use the userfaultfd support in [Proton](https://github.com/ValveSoftware/wine)'s `dlls/ntdll/unix/virtual.c` (LGPL-2.1-or-later): libblsession gives it the arm64 syscall number and answers its `PAGEMAP_SCAN` from `/proc/self/pagemap` where Android refuses the ioctl. See [LICENSE](LICENSE). Steam and Proton belong to Valve Corporation; this project is not affiliated with Valve. XR glasses support builds on WinNative's VITURE glasses work. VITURE protocol details were checked against [XRLinuxDriver](https://github.com/wheaney/XRLinuxDriver) by [@wheaney](https://github.com/wheaney), including the VITURE protocol header it ships, [ar-drivers-rs](https://github.com/badicsalex/ar-drivers-rs) by [@badicsalex](https://github.com/badicsalex) and the [go-macos/iokit VITURE package](https://pkg.go.dev/github.com/go-macos/iokit/viture); the optional VITURE SDK belongs to VITURE and is not included. RayNeo support adapts [@informalTechCode](https://github.com/informalTechCode)'s [RayNeo-Air-Series-3DoF-Scaffold](https://github.com/informalTechCode/RayNeo-Air-Series-3DoF-Scaffold) (Apache-2.0) and references [@verncat](https://github.com/verncat)'s [RayNeo-Air-3S-Pro-OpenVR](https://github.com/verncat/RayNeo-Air-3S-Pro-OpenVR) (MIT) and [Monado](https://gitlab.freedesktop.org/monado/monado) (BSL-1.0); see [docs/third-party/rayneo](docs/third-party/rayneo/README.md). XREAL 1S support references [XRLinuxDriver](https://github.com/wheaney/XRLinuxDriver) and [xrealOneDeviceKit](https://github.com/wheaney/xrealOneDeviceKit) by @wheaney, [xreal_one_driver](https://github.com/rohitsangwan01/xreal_one_driver) by [@rohitsangwan01](https://github.com/rohitsangwan01) (MIT) and [xr-tools](https://github.com/0xcaff/xr-tools) by [@0xcaff](https://github.com/0xcaff). Rokid support follows the Rokid protocol notes in [ar-drivers-rs](https://github.com/badicsalex/ar-drivers-rs) and @badicsalex's [Void Computing write-ups](https://voidcomputing.hu/blog/worse-better-prettier/), and [Monado](https://gitlab.freedesktop.org/monado/monado)'s Rokid driver. The REDMAGIC glasses-display findings draw on [@mekhontsev](https://github.com/mekhontsev)'s [MagicDesk investigation](https://github.com/mekhontsev/magicdesk/blob/main/docs/xr-resolution-fix.md) and [@Coding-BR](https://github.com/Coding-BR)'s [decompiled Nubia kernel](https://github.com/Coding-BR/android_kernel_nubia_sm8850_qwjujube). VITURE, RayNeo, XREAL, Rokid and REDMAGIC are trademarks of their owners; this project is not affiliated with them. diff --git a/app/build.gradle b/app/build.gradle index c889af5882..e81b92711c 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -122,8 +122,8 @@ android { applicationId "com.droiddeck.launcher" minSdkVersion 26 targetSdkVersion 28 - versionCode 14 - versionName "0.5.0" + versionCode 15 + versionName "0.6.0" buildConfigField "String", "BUILD_LABEL", "\"${escapedBuildLabel}\"" buildConfigField "String", "SOURCE_COMMIT", "\"${sourceCommit}\"" buildConfigField "int", "PR_NUMBER", "${prNumber}" diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index 5439940930..fcd9b2e11b 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -61,7 +61,7 @@ @@ -84,8 +84,8 @@ @@ -97,7 +97,7 @@ diff --git a/app/src/main/java/com/droiddeck/launcher/MainActivity.kt b/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt similarity index 99% rename from app/src/main/java/com/droiddeck/launcher/MainActivity.kt rename to app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt index b0c6e574c0..2ca43f5024 100644 --- a/app/src/main/java/com/droiddeck/launcher/MainActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt @@ -80,7 +80,7 @@ import com.droiddeck.launcher.session.GameStorage import com.droiddeck.launcher.input.SecondScreenDisplay import com.droiddeck.launcher.input.SecondScreenDisplays -class MainActivity : ComponentActivity() { +class FrontEndActivity : ComponentActivity() { override fun attachBaseContext(newBase: android.content.Context) { super.attachBaseContext(newBase) com.droiddeck.launcher.core.AppLanguage.applyTo(this, newBase) @@ -701,7 +701,7 @@ class MainActivity : ComponentActivity() { else { switchPoll = null switchingTo = null - android.widget.Toast.makeText(this@MainActivity, R.string.game_link_session_busy, android.widget.Toast.LENGTH_LONG).show() + android.widget.Toast.makeText(this@FrontEndActivity, R.string.game_link_session_busy, android.widget.Toast.LENGTH_LONG).show() } return } @@ -759,6 +759,7 @@ class MainActivity : ComponentActivity() { downloadPrefix = DownloadSource.custom(this) DownloadSource.probe() animationsEnabled = SessionPrefs.animationsEnabled(this) + LauncherIcon.repair(this, intent?.component) launcherIcon = LauncherIcon.current(this) gameStoresEnabled = SessionPrefs.gameStoresEnabled(this) gameStoresSpeedTier = SessionPrefs.gameStoresSpeedTier(this) @@ -1039,7 +1040,7 @@ class MainActivity : ComponentActivity() { onWirelessAdbPair = { host, port, code, complete -> Thread({ val result = runCatching { - kotlinx.coroutines.runBlocking { WirelessAdbFix.pair(this@MainActivity, host, port, code) } + kotlinx.coroutines.runBlocking { WirelessAdbFix.pair(this@FrontEndActivity, host, port, code) } } val error = result.exceptionOrNull()?.let { it.localizedMessage ?: getString(R.string.main_wadb_pair_failed) } ui.post { complete(error) } @@ -1047,13 +1048,13 @@ class MainActivity : ComponentActivity() { }, onFindWirelessAdbPort = { host, complete -> Thread({ - val port = WirelessAdbFix.findConnectPort(this@MainActivity, host) + val port = WirelessAdbFix.findConnectPort(this@FrontEndActivity, host) ui.post { complete(port) } }, "wireless-adb-discovery").start() }, onWirelessAdbApply = { host, port, enabled, complete -> Thread({ - val result = runCatching { WirelessAdbFix.setChildProcessLimit(this@MainActivity, host, port, enabled) } + val result = runCatching { WirelessAdbFix.setChildProcessLimit(this@FrontEndActivity, host, port, enabled) } val error = result.exceptionOrNull()?.let { it.localizedMessage ?: getString(R.string.main_wadb_command_failed) } ui.post { if (error == null) refreshPhantomStatus() @@ -1063,7 +1064,7 @@ class MainActivity : ComponentActivity() { }, onSetPhantomProcessLimit = { enabled, complete -> Thread({ - val result = runCatching { WirelessAdbFix.setUsingSavedPairing(this@MainActivity, enabled) } + val result = runCatching { WirelessAdbFix.setUsingSavedPairing(this@FrontEndActivity, enabled) } val error = result.exceptionOrNull()?.let { it.localizedMessage ?: getString(R.string.main_wadb_unavailable) } ui.post { if (error == null) refreshPhantomStatus() @@ -1119,7 +1120,7 @@ class MainActivity : ComponentActivity() { showNonAdreno?.let { release -> ConfirmDialog( title = androidx.compose.ui.res.stringResource(R.string.main_non_adreno_title), - text = androidx.compose.ui.res.stringResource(R.string.main_non_adreno_text, com.droiddeck.launcher.core.DeviceSupport.gpuName(this@MainActivity), release.size / 1e6), + text = androidx.compose.ui.res.stringResource(R.string.main_non_adreno_text, com.droiddeck.launcher.core.DeviceSupport.gpuName(this@FrontEndActivity), release.size / 1e6), confirm = androidx.compose.ui.res.stringResource(R.string.main_install_anyway), onConfirm = { showNonAdreno = null; install(release) }, onDismiss = { showNonAdreno = null }, @@ -2033,7 +2034,7 @@ class MainActivity : ComponentActivity() { steamGamesX64 = scannedX64 steamGames = all.map { g -> val newer = current[g.appId] - if (newer != null && g.library != Library.ADDED && steamArtRefreshes[g.appId] != artRefreshesAtStart[g.appId]) g.withArt(newer.art, newer.hero, newer.icon) else g + if (newer != null && g.library != Library.ADDED && steamArtRefreshes[g.appId] != artRefreshesAtStart[g.appId]) g.withArt(newer.art, newer.hero, newer.icon, newer.logo) else g } shortcutLibraryScanning = false handleGameLink(all) diff --git a/app/src/main/java/com/droiddeck/launcher/HomeActivity.kt b/app/src/main/java/com/droiddeck/launcher/HomeActivity.kt index 54526834b5..71304e8837 100644 --- a/app/src/main/java/com/droiddeck/launcher/HomeActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/HomeActivity.kt @@ -23,7 +23,7 @@ class HomeActivity : Activity() { .setAction(SessionService.ACTION_HOME_GUIDE) .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP) } else { - Intent(this, MainActivity::class.java) + Intent(this, FrontEndActivity::class.java) .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP) } startActivity(destination) diff --git a/app/src/main/java/com/droiddeck/launcher/LauncherIcon.kt b/app/src/main/java/com/droiddeck/launcher/LauncherIcon.kt index 9183df76e8..89c33523ac 100644 --- a/app/src/main/java/com/droiddeck/launcher/LauncherIcon.kt +++ b/app/src/main/java/com/droiddeck/launcher/LauncherIcon.kt @@ -8,7 +8,7 @@ object LauncherIcon { const val DARK = "dark" const val LIGHT = "light" - private val aliases = linkedMapOf(DARK to "com.droiddeck.launcher.LauncherDark", LIGHT to "com.droiddeck.launcher.LauncherLight") + private val aliases = linkedMapOf(DARK to "com.droiddeck.launcher.MainActivity", LIGHT to "com.droiddeck.launcher.LauncherLight") val options: List> = listOf( DARK to R.string.setup_launcher_icon_dark, @@ -29,6 +29,12 @@ object LauncherIcon { fun activity(context: Context): ComponentName = component(context, current(context)) + fun repair(context: Context, launchedFrom: ComponentName?) { + if (!enabled(context, DARK) || !enabled(context, LIGHT) || launchedFrom == component(context, DARK)) return + context.packageManager.setComponentEnabledSetting(component(context, DARK), + PackageManager.COMPONENT_ENABLED_STATE_DISABLED, PackageManager.DONT_KILL_APP) + } + fun set(context: Context, style: String) { if (style !in aliases || style == current(context)) return val pm = context.packageManager diff --git a/app/src/main/java/com/droiddeck/launcher/core/WirelessAdbPairingService.kt b/app/src/main/java/com/droiddeck/launcher/core/WirelessAdbPairingService.kt index f8806c7c03..c924f85329 100644 --- a/app/src/main/java/com/droiddeck/launcher/core/WirelessAdbPairingService.kt +++ b/app/src/main/java/com/droiddeck/launcher/core/WirelessAdbPairingService.kt @@ -14,7 +14,7 @@ import android.os.Build import android.os.Handler import android.os.IBinder import android.os.Looper -import com.droiddeck.launcher.MainActivity +import com.droiddeck.launcher.FrontEndActivity import com.droiddeck.launcher.R import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.StateFlow @@ -185,7 +185,7 @@ class WirelessAdbPairingService : Service() { enableVibration(false) }) val open = PendingIntent.getActivity(this, 0, - Intent(this, MainActivity::class.java).setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_REORDER_TO_FRONT), + Intent(this, FrontEndActivity::class.java).setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_REORDER_TO_FRONT), PendingIntent.FLAG_IMMUTABLE) val cancel = PendingIntent.getService(this, 1, Intent(this, WirelessAdbPairingService::class.java).setAction(ACTION_CANCEL), PendingIntent.FLAG_IMMUTABLE) diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt index 62d04d2477..8315c22e9e 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGameArt.kt @@ -5,6 +5,8 @@ import android.graphics.Bitmap import android.util.Log import com.droiddeck.launcher.files.PeIconExtractor import com.droiddeck.launcher.session.SessionPrefs +import com.droiddeck.launcher.stores.StoreArt +import com.droiddeck.launcher.stores.StoreGameSidecar import org.json.JSONObject import java.io.File import java.net.HttpURLConnection @@ -228,41 +230,93 @@ object AddedGameArt { return if (tmp.renameTo(png)) png else null } - fun fetchMissing(context: Context, games: List): Boolean { + internal class Sources( + val storeLogo: (AddedGames.Game) -> Boolean, + val steamSearch: (String) -> Int?, + val steam: (String, File, Set) -> Boolean, + val sgdbGame: (String, Int?, String) -> Int?, + val sgdb: (String, Int, File, Set) -> Boolean, + ) + + private val network = Sources( + storeLogo = ::storeLogo, + steamSearch = { name -> search(name)?.toIntOrNull() }, + steam = ::download, + sgdbGame = SteamGridDb::gameId, + sgdb = SteamGridDb::download, + ) + + private val EXTRAS = setOf(Slot.LOGO, Slot.ICON) + private val STEAM_SLOTS = setOf(Slot.COVER, Slot.WIDE, Slot.BACKGROUND, Slot.LOGO) + internal const val EXTRAS_TRIED = "extras-tried" + + internal fun missing(context: Context, game: AddedGames.Game): Set { + val own = local(game) + val cache = cacheDir(context, game) + fun has(slot: Slot, mine: File?, cached: String) = chosen(cache, slot) != null || mine != null || File(cache, cached).isFile + return Slot.values().filterNot { slot -> + when (slot) { + Slot.COVER -> has(slot, own.portrait, "p.jpg") + Slot.WIDE -> has(slot, own.header, "header.jpg") + Slot.BACKGROUND -> has(slot, own.hero, "hero.jpg") + Slot.LOGO -> has(slot, own.logo, "logo.png") + Slot.ICON -> has(slot, own.icon, "icon-sgdb.png") + } + }.toSet() + } + + private fun storeLogo(game: AddedGames.Game): Boolean { + val url = StoreGameSidecar.read(game.folder)?.logo ?: return false + return StoreArt.fetchLogo(game.folder, url) + } + + fun fetchMissing(context: Context, games: List): Boolean = + fetchMissing(context, games, SteamGridDb.key(context), network) + + internal fun fetchMissing(context: Context, games: List, sgdbKey: String, sources: Sources): Boolean { if (!SessionPrefs.addedGamesArt(context)) return false - val sgdbKey = SteamGridDb.key(context) val keyChangedAt = SteamGridDb.keyChangedAt(context) var sgdbDown = false var changed = false for (game in games) { - if (local(game).portrait != null) continue + val start = missing(context, game) + val full = Slot.COVER in start + val allowed = if (full) Slot.values().toSet() else EXTRAS + var need = start intersect allowed + if (need.isEmpty() || (need == setOf(Slot.ICON) && sgdbKey.isEmpty())) continue val cache = cacheDir(context, game) - if (File(cache, "p.jpg").isFile) continue + val tried = File(cache, EXTRAS_TRIED) + if (!full && tried.isFile && tried.lastModified() >= keyChangedAt && System.currentTimeMillis() - tried.lastModified() < RETRY_AFTER_MS) continue cache.mkdirs() - val match = steamMatch(context, game) { name -> - runCatching { search(name) }.onFailure { Log.w(TAG, "${game.name}: store search failed (${it.message})") }.getOrNull()?.toIntOrNull() + if (Slot.LOGO in need && game.source != Library.ADDED && runCatching { sources.storeLogo(game) }.getOrDefault(false)) { + changed = true + need = need - Slot.LOGO } - val appId = match.appId?.takeIf { match.certainty == SteamMatch.Certainty.FILES } - val id = match.appId?.toString() - if (id != null && download(id, cache)) changed = true - if (File(cache, "p.jpg").isFile || sgdbKey.isEmpty() || sgdbDown) continue - val stored: String? = try { - remembered(File(cache, "sgdb-id"), keyChangedAt) { - SteamGridDb.gameId(sgdbKey, appId ?: id?.toIntOrNull(), game.name)?.toString() + val match by lazy { + steamMatch(context, game) { name -> + runCatching { sources.steamSearch(name) }.onFailure { Log.w(TAG, "${game.name}: store search failed (${it.message})") }.getOrNull() } - } catch (e: Exception) { - Log.w(TAG, "${game.name}: SteamGridDB lookup failed (${e.javaClass.simpleName}); not asking again this pass") - sgdbDown = true - null } - val gridId = stored?.toIntOrNull() ?: continue - val grabbed = try { - SteamGridDb.download(sgdbKey, gridId, cache) - } catch (e: Exception) { - sgdbDown = true - false + val steamWant = need intersect STEAM_SLOTS + if (steamWant.isNotEmpty()) { + val id = match.appId?.toString() + if (id != null && sources.steam(id, cache, steamWant)) changed = true + need = missing(context, game) intersect allowed } - if (grabbed) changed = true + var asked = true + if (need.isNotEmpty() && sgdbKey.isNotEmpty()) { + if (sgdbDown) asked = false else try { + val gridId = remembered(File(cache, "sgdb-id"), keyChangedAt) { + sources.sgdbGame(sgdbKey, match.appId, game.name)?.toString() + }?.toIntOrNull() + if (gridId != null && sources.sgdb(sgdbKey, gridId, cache, need)) changed = true + } catch (e: Exception) { + Log.w(TAG, "${game.name}: SteamGridDB failed (${e.javaClass.simpleName}); not asking again this pass") + sgdbDown = true + asked = false + } + } + if ((missing(context, game) intersect EXTRAS).isEmpty()) tried.delete() else if (asked) tried.writeText("") } return changed } @@ -314,11 +368,13 @@ object AddedGameArt { return pickStoreResult(name, (0 until items.length()).map { items.getJSONObject(it) }.map { it.optString("id") to it.optString("name") }) } - private fun download(id: String, cache: File): Boolean { + private fun download(id: String, cache: File, slots: Set): Boolean { var got = false - for ((remote, localName) in listOf( - "library_600x900.jpg" to "p.jpg", "header.jpg" to "header.jpg", "library_hero.jpg" to "hero.jpg", "logo.png" to "logo.png", + for ((slot, remote, localName) in listOf( + Triple(Slot.COVER, "library_600x900.jpg", "p.jpg"), Triple(Slot.WIDE, "header.jpg", "header.jpg"), + Triple(Slot.BACKGROUND, "library_hero.jpg", "hero.jpg"), Triple(Slot.LOGO, "logo.png", "logo.png"), )) { + if (slot !in slots) continue val dst = File(cache, localName) if (dst.isFile) continue val bytes = get("$CDN$id/$remote") ?: steamAssetUrl(id, remote)?.let { get(it) } ?: continue diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/GameShortcuts.kt b/app/src/main/java/com/droiddeck/launcher/frontend/GameShortcuts.kt index 80cdd93c1b..45b2452694 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/GameShortcuts.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/GameShortcuts.kt @@ -11,13 +11,13 @@ import android.graphics.drawable.Icon import android.net.Uri import android.widget.Toast import com.droiddeck.launcher.LauncherIcon -import com.droiddeck.launcher.MainActivity +import com.droiddeck.launcher.FrontEndActivity import com.droiddeck.launcher.R import java.io.File object GameShortcuts { fun launchIntent(context: Context, gameId: String) = Intent(Intent.ACTION_VIEW, - Uri.parse(GameLaunchLink.uri(gameId)), context, MainActivity::class.java) + Uri.parse(GameLaunchLink.uri(gameId)), context, FrontEndActivity::class.java) .addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP) private fun info(context: Context, game: Library.SteamGame): ShortcutInfo { diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt b/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt index 1242d9add1..91691cb1e7 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt @@ -16,9 +16,10 @@ object Library { val icon: File? = null, val source: String = SOURCE_STEAM, val storeId: String? = null, + val logo: File? = null, ) { - fun withArt(art: File?, hero: File?, icon: File?) = - SteamGame(appId, name, art, library, gameId, hero, lastPlayed, gameFiles, protonPrefix, icon, source, storeId) + fun withArt(art: File?, hero: File?, icon: File?, logo: File? = this.logo) = + SteamGame(appId, name, art, library, gameId, hero, lastPlayed, gameFiles, protonPrefix, icon, source, storeId, logo) val gameIdString: String get() = java.lang.Long.toUnsignedString(gameId) val profileKey: String get() = if (library == ADDED) java.lang.Integer.toUnsignedString(appId) else appId.toString() @@ -68,6 +69,7 @@ object Library { ) private val STEAM_CAPSULES = listOf("library_capsule.jpg", "library_600x900.jpg") private val STEAM_HEROES = listOf("library_hero.jpg") + internal val STEAM_LOGOS = listOf("logo.png") private val STEAM_ICON = Regex("[a-fA-F0-9]{40}\\.(jpg|png)") private val NAME = Regex("^\\s*\"name\"\\s*\"([^\"]*)\"", RegexOption.MULTILINE) private val STATE = Regex("^\\s*\"StateFlags\"\\s*\"(\\d+)\"", RegexOption.MULTILINE) @@ -131,6 +133,7 @@ object Library { protonPrefix = protonPrefix(context, appId.toLong(), library, roots), icon = steamCacheImage(cache, appId, listOf("icon.jpg", "icon.png")) ?: File(cache, appId.toString()).listFiles()?.firstOrNull { it.isFile && STEAM_ICON.matches(it.name) }, + logo = steamCacheImage(cache, appId, STEAM_LOGOS), )) } } @@ -203,6 +206,7 @@ object Library { protonPrefix = protonPrefix(context, g.steamAppId?.toLong() ?: g.appId, libraries = roots), icon = art.icon?.takeIf { it.extension.lowercase() != "ico" }, source = g.source, storeId = g.storeId, + logo = art.logo, ) } diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt b/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt index 3d03b23073..cd30e400cf 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt @@ -27,6 +27,7 @@ object LibraryCache { icon = o.file("icon"), source = o.optString("source").ifEmpty { if (o.getString("library") == Library.ADDED) Library.ADDED else Library.SOURCE_STEAM }, storeId = o.optString("storeId").ifEmpty { null }, + logo = o.file("logo"), ) } to x64 }.getOrElse { e -> Log.w(TAG, "unreadable, ignored: ${e.message}"); Pair(emptyList(), false) } @@ -44,7 +45,7 @@ object LibraryCache { for (g in games) array.put( JSONObject().put("appId", g.appId).put("name", g.name).put("library", g.library).put("gameId", g.gameId) .put("lastPlayed", g.lastPlayed).putFile("art", g.art).putFile("hero", g.hero) - .putFile("gameFiles", g.gameFiles).putFile("protonPrefix", g.protonPrefix).putFile("icon", g.icon) + .putFile("gameFiles", g.gameFiles).putFile("protonPrefix", g.protonPrefix).putFile("icon", g.icon).putFile("logo", g.logo) .put("source", g.source).apply { g.storeId?.let { put("storeId", it) } }, ) val f = file(context) diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt index cb4f49f0fd..25a3cb8fb5 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGameArt.kt @@ -22,10 +22,12 @@ object SteamGameArt { val cover = chosenFile(context, game.appId, AddedGameArt.Slot.COVER) val hero = chosenFile(context, game.appId, AddedGameArt.Slot.BACKGROUND) val icon = chosenFile(context, game.appId, AddedGameArt.Slot.ICON) - if (cover == null && hero == null && icon == null) return game + val logo = chosenFile(context, game.appId, AddedGameArt.Slot.LOGO) + if (cover == null && hero == null && icon == null && logo == null) return game return Library.SteamGame( game.appId, game.name, cover ?: game.art, game.library, game.gameId, hero ?: game.hero, game.lastPlayed, game.gameFiles, game.protonPrefix, icon ?: game.icon, game.source, game.storeId, + logo ?: game.logo, ) } diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt index dec6c24cfb..2eaa89410d 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/SteamGridDb.kt @@ -84,18 +84,23 @@ object SteamGridDb { .filter { it.second > 0 && it.first > 0 } .maxByOrNull { it.second }?.first - fun download(key: String, id: Int, cache: File): Boolean { + internal fun cacheName(slot: AddedGameArt.Slot): String = + when (slot) { + AddedGameArt.Slot.COVER -> "p.jpg" + AddedGameArt.Slot.WIDE -> "header.jpg" + AddedGameArt.Slot.BACKGROUND -> "hero.jpg" + AddedGameArt.Slot.LOGO -> "logo.png" + AddedGameArt.Slot.ICON -> "icon-sgdb.png" + } + + fun download(key: String, id: Int, cache: File, slots: Set = AddedGameArt.Slot.values().toSet()): Boolean { var got = false - for ((path, local) in listOf( - "grids/game/$id?dimensions=600x900&$QUERY" to "p.jpg", - "grids/game/$id?dimensions=460x215,920x430&$QUERY" to "header.jpg", - "heroes/game/$id?$QUERY" to "hero.jpg", - "logos/game/$id?$QUERY" to "logo.png", - "icons/game/$id?$QUERY" to "icon-sgdb.png", - )) { + for (slot in AddedGameArt.Slot.values()) { + if (slot !in slots) continue + val local = cacheName(slot) val dst = File(cache, local) if (dst.isFile) continue - val items = json(key, "$API/$path")?.optJSONArray("data") ?: continue + val items = json(key, "$API/${path(id, slot)}")?.optJSONArray("data") ?: continue val url = best(items, local.endsWith(".png")) ?: continue val bytes = AddedGameArt.get(url) ?: continue val tmp = File(cache, "$local.tmp") diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/RuntimeInstallService.kt b/app/src/main/java/com/droiddeck/launcher/runtime/RuntimeInstallService.kt index d2cee04350..aa53092fe2 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/RuntimeInstallService.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/RuntimeInstallService.kt @@ -9,7 +9,7 @@ import android.content.Context import android.content.Intent import android.os.Build import android.os.IBinder -import com.droiddeck.launcher.MainActivity +import com.droiddeck.launcher.FrontEndActivity import com.droiddeck.launcher.R class RuntimeInstallService : Service() { @@ -75,7 +75,7 @@ class RuntimeInstallService : Service() { enableVibration(false) }) val open = PendingIntent.getActivity(this, 0, - Intent(this, MainActivity::class.java).setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_REORDER_TO_FRONT), + Intent(this, FrontEndActivity::class.java).setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_REORDER_TO_FRONT), PendingIntent.FLAG_IMMUTABLE) return Notification.Builder(this, CHANNEL_ID) .setSmallIcon(R.drawable.ic_stat_session) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt index 27bf133f18..a740eb088e 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt @@ -94,6 +94,20 @@ object StoreAccounts { return json.optString("display_name", "").ifEmpty { json.optString("username", "") }.ifEmpty { store.label } } + /** The name the Stores page shows. Xbox shows the gamertag, else the sign-in email with its name part masked. */ + fun displayName(context: Context, store: Store): String? { + if (store != Store.XBOX) return signedInAs(context, store) + val json = read(context, store) ?: return if (isUnavailable(store)) store.label else null + val signedIn = json.optString("username").takeIf { it.isNotBlank() } ?: return null + json.optString("gamertag").takeIf { it.isNotBlank() }?.let { return it } + return maskEmail(signedIn) + } + + internal fun maskEmail(name: String): String { + val at = name.indexOf('@') + return if (at <= 0) name.take(1) + "•••" else name.take(1) + "•••" + name.substring(at) + } + private fun seal(f: File, json: JSONObject, retry: Boolean = false): File? { if (keystoreFailed && !retry) return null val text = json.toString() diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreArt.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreArt.kt index 4b2b0b8039..14415fd9c6 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreArt.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreArt.kt @@ -14,13 +14,45 @@ object StoreArt { fun fetchInto(folder: File, sidecar: StoreGameSidecar) { sidecar.cover?.let { place(it, File(folder, "cover.jpg")) } - val wide = sidecar.hero ?: return - if (place(wide, File(folder, "hero.jpg"))) { - val header = File(folder, "header.jpg") - if (!header.isFile) runCatching { File(folder, "hero.jpg").copyTo(header, overwrite = true) } + sidecar.hero?.let { wide -> + if (place(wide, File(folder, "hero.jpg"))) { + val header = File(folder, "header.jpg") + if (!header.isFile) runCatching { File(folder, "hero.jpg").copyTo(header, overwrite = true) } + } + } + sidecar.logo?.let { fetchLogo(folder, it) } + } + + fun fetchLogo(folder: File, url: String): Boolean { + val dst = File(folder, LOGO) + if (dst.isFile && dst.length() > 0) return true + return writeLogo(get(url) ?: return false, dst) + } + + /** A logo is drawn over the hero, so it stays a PNG with its transparency instead of going through [place]. */ + internal fun writeLogo(bytes: ByteArray, dst: File): Boolean { + if (dst.isFile && dst.length() > 0) return true + val bitmap = runCatching { BitmapFactory.decodeByteArray(bytes, 0, bytes.size) }.getOrNull() ?: return false + val tmp = File(dst.path + ".tmp") + return try { + if (bitmap.width <= 0 || bitmap.height <= 0) return false + if (isPng(bytes)) tmp.writeBytes(bytes) else tmp.outputStream().use { bitmap.compress(Bitmap.CompressFormat.PNG, 100, it) } + tmp.renameTo(dst) + } catch (e: Exception) { + Log.w(TAG, "${dst.name}: ${e.javaClass.simpleName}") + false + } finally { + tmp.delete() + bitmap.recycle() } } + private val PNG_MAGIC = byteArrayOf(0x89.toByte(), 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A) + + private fun isPng(bytes: ByteArray): Boolean = bytes.size > PNG_MAGIC.size && PNG_MAGIC.indices.all { bytes[it] == PNG_MAGIC[it] } + + const val LOGO = "logo.png" + private fun place(url: String, dst: File): Boolean { if (dst.isFile && dst.length() > 0) return true val bytes = get(url) ?: return false diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt index debaf4ad04..cfb0ed53de 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt @@ -23,6 +23,7 @@ data class CatalogItem( val mature: Boolean = false, val subscription: Boolean = false, val includedWith: String = "", + val logoUrl: String? = null, ) { val accessible: Boolean get() = owned || subscription /** Licensed now, or a supported package the account's subscription can install. */ diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreGameSidecar.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreGameSidecar.kt index 25850f7479..aa42aa75e8 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreGameSidecar.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreGameSidecar.kt @@ -22,6 +22,7 @@ class StoreGameSidecar( val epic: EpicOptions = EpicOptions(), val cloud: Boolean = true, val achievements: Boolean = true, + val logo: String? = null, ) { val isInstalled: Boolean get() = state == STATE_INSTALLED @@ -33,7 +34,8 @@ class StoreGameSidecar( env: Map = this.env, installVersion: String = this.installVersion, installedAt: Long = this.installedAt, cover: String? = this.cover, hero: String? = this.hero, extra: Map = this.extra, state: String = this.state, epic: EpicOptions = this.epic, cloud: Boolean = this.cloud, achievements: Boolean = this.achievements, - ) = StoreGameSidecar(store, id, title, exe, launcher, args, env, installVersion, installedAt, cover, hero, extra, state, epic, cloud, achievements) + logo: String? = this.logo, + ) = StoreGameSidecar(store, id, title, exe, launcher, args, env, installVersion, installedAt, cover, hero, extra, state, epic, cloud, achievements, logo) fun toJson(): JSONObject = JSONObject().apply { put("version", VERSION) @@ -52,6 +54,7 @@ class StoreGameSidecar( if (installedAt > 0L) put("installedAt", installedAt) if (!cover.isNullOrEmpty()) put("cover", cover) if (!hero.isNullOrEmpty()) put("hero", hero) + if (!logo.isNullOrEmpty()) put("logo", logo) if (extra.isNotEmpty()) put("extra", JSONObject(extra as Map<*, *>)) } @@ -129,6 +132,7 @@ class StoreGameSidecar( epic = o.optJSONObject("epic")?.let { e -> EpicOptions(eos = e.optBoolean("eos", true), offline = e.optBoolean("offline", false)) } ?: EpicOptions(), cloud = o.optBoolean("cloud", true), achievements = o.optBoolean("achievements", true), + logo = o.optString("logo", "").ifEmpty { null }, ) } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreInstalls.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreInstalls.kt index 9b3f7136d6..65fdf6e921 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreInstalls.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreInstalls.kt @@ -40,7 +40,7 @@ object StoreInstalls { val app = context.applicationContext onStep?.invoke(0, STEPS) val before = StoreGameSidecar.read(folder) - val finished = StoreLaunch.writeLauncher(folder, sidecar.copy(state = StoreGameSidecar.STATE_INSTALLED, epic = before?.epic ?: sidecar.epic, cloud = before?.cloud ?: sidecar.cloud, achievements = before?.achievements ?: sidecar.achievements)) + val finished = StoreLaunch.writeLauncher(folder, sidecar.copy(state = StoreGameSidecar.STATE_INSTALLED, epic = before?.epic ?: sidecar.epic, cloud = before?.cloud ?: sidecar.cloud, achievements = before?.achievements ?: sidecar.achievements, logo = sidecar.logo ?: before?.logo)) finished.write(folder) if (StoreGameSidecar.read(folder)?.isInstalled != true) throw java.io.IOException("the install record could not be written in ${folder.name}") onStep?.invoke(1, STEPS) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLogFiles.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLogFiles.kt index 0af6590120..bd94cfc3bc 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLogFiles.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLogFiles.kt @@ -24,6 +24,11 @@ object StoreLogFiles { Thread({ android.os.Process.setThreadPriority(android.os.Process.THREAD_PRIORITY_BACKGROUND); r.run() }, "store-log-flush").apply { isDaemon = true } } + private val CLOCK = SimpleDateFormat("HH:mm:ss.SSS", Locale.US) + + /** Appends [text] with a time stamp. Works in any of the app's processes. */ + fun stamped(context: Context, text: String) = append(context, "${synchronized(CLOCK) { CLOCK.format(Date()) }} $text") + fun append(context: Context, line: String) { val app = context.applicationContext pending.add(line) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt index e780733d97..317757a8bf 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt @@ -10,9 +10,6 @@ import androidx.compose.runtime.mutableStateMapOf import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.setValue import com.droiddeck.launcher.stores.download.DownloadEntry -import java.text.SimpleDateFormat -import java.util.Date -import java.util.Locale object StoresState { private const val TAG = "Stores" @@ -79,7 +76,7 @@ object StoresState { val app = context.applicationContext com.droiddeck.launcher.stores.download.SavedQueue.restore(app) background("stores-refresh") { - val found = Store.entries.mapNotNull { store -> StoreAccounts.signedInAs(app, store)?.let { store to it } } + val found = Store.entries.mapNotNull { store -> StoreAccounts.displayName(app, store)?.let { store to it } } val onDisk = StoreInstallRoot.gameFolders(app).mapNotNull { folder -> StoreGameSidecar.read(folder)?.takeIf { it.isInstalled }?.let { InstalledStoreGame(it, folder) } } @@ -262,7 +259,7 @@ object StoresState { val text = StoreLog.redactLine(raw) Log.i(TAG, text) val app = appContext ?: return - StoreLogFiles.append(app, "${synchronized(CLOCK) { CLOCK.format(Date()) }} $text") + StoreLogFiles.stamped(app, text) } private var appContext: Context? = null @@ -295,8 +292,6 @@ object StoresState { } }, name).start() } - - private val CLOCK = SimpleDateFormat("HH:mm:ss.SSS", Locale.US) } interface StoreBackend { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonInstaller.kt b/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonInstaller.kt index 7eff5fbbe9..401f621ede 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonInstaller.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonInstaller.kt @@ -124,6 +124,7 @@ internal class AmazonInstaller( installVersion = versionId, installedAt = System.currentTimeMillis(), cover = cover, hero = item.imageUrl, extra = mapOf("entitlementId" to entitlementId, "sku" to sku), + logo = item.logoUrl, ) StoreInstalls.complete(app, folder, sidecar, onStep = { done, steps -> handle.stageProgress(done.toLong(), steps.toLong()) }) return folder.path diff --git a/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonLibrary.kt b/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonLibrary.kt index 841fe9217a..41f049979b 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonLibrary.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/amazon/AmazonLibrary.kt @@ -24,6 +24,7 @@ data class AmazonGame( val publisher: String = "", val productSku: String = "", val versionId: String = "", + val logoUrl: String = "", ) object AmazonLibrary { @@ -42,7 +43,8 @@ object AmazonLibrary { JSONObject() .put("productId", g.productId).put("entitlementId", g.entitlementId).put("title", g.title) .put("artUrl", g.artUrl).put("heroUrl", g.heroUrl).put("developer", g.developer) - .put("publisher", g.publisher).put("productSku", g.productSku).put("versionId", g.versionId), + .put("publisher", g.publisher).put("productSku", g.productSku).put("versionId", g.versionId) + .apply { if (g.logoUrl.isNotEmpty()) put("logoUrl", g.logoUrl) }, ) }.toString() @@ -60,6 +62,7 @@ object AmazonLibrary { publisher = o.optString("publisher", ""), productSku = o.optString("productSku", ""), versionId = o.optString("versionId", ""), + logoUrl = o.optString("logoUrl", ""), ) } return tidy(games) @@ -94,6 +97,7 @@ object AmazonLibrary { sizeBytes = prefs.getLong("size_${game.productId}", 0L).takeIf { it > 0 } ?: 0L, storeUrl = STORE_URL, extra = mapOf("entitlementId" to game.entitlementId, "sku" to game.productSku, "version" to ""), + logoUrl = game.logoUrl.ifEmpty { null }, ) } @@ -106,7 +110,7 @@ object AmazonLibrary { } } - private fun gameFrom(o: JSONObject, before: AmazonGame?): AmazonGame = AmazonGame( + internal fun gameFrom(o: JSONObject, before: AmazonGame?): AmazonGame = AmazonGame( productId = o.optString("productId"), entitlementId = o.optString("entitlementId"), title = o.optString("title"), @@ -116,6 +120,7 @@ object AmazonLibrary { publisher = o.optString("publisher"), productSku = o.optString("sku"), versionId = before?.versionId.orEmpty(), + logoUrl = o.optString("logo").ifEmpty { before?.logoUrl.orEmpty() }, ) private fun backfillPosters(app: Context, games: List) { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/download/SavedQueue.kt b/app/src/main/java/com/droiddeck/launcher/stores/download/SavedQueue.kt index 5a5eae4fa0..a9a25759e1 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/download/SavedQueue.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/download/SavedQueue.kt @@ -77,6 +77,7 @@ object SavedQueue { private fun itemJson(i: CatalogItem) = JSONObject().apply { put("store", i.store.id); put("id", i.id); put("title", i.title) put("image", i.imageUrl ?: ""); put("tall", i.tallImageUrl ?: "") + i.logoUrl?.let { put("logo", it) } put("tags", i.tags); put("developer", i.developer); put("description", i.description) put("size", i.sizeBytes); put("owned", i.owned); put("subscription", i.subscription) put("extra", JSONObject(i.extra)) @@ -91,6 +92,7 @@ object SavedQueue { tags = o.optString("tags"), developer = o.optString("developer"), description = o.optString("description"), owned = o.optBoolean("owned", true), subscription = o.optBoolean("subscription"), sizeBytes = o.optLong("size"), extra = extra?.keys()?.asSequence()?.associateWith { extra.getString(it) } ?: emptyMap(), + logoUrl = o.optString("logo").ifEmpty { null }, ) } } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/download/StoreDownloadService.kt b/app/src/main/java/com/droiddeck/launcher/stores/download/StoreDownloadService.kt index a32bceeb69..1f80eecf55 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/download/StoreDownloadService.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/download/StoreDownloadService.kt @@ -15,7 +15,7 @@ import android.os.IBinder import android.os.Looper import android.os.PowerManager import android.util.Log -import com.droiddeck.launcher.MainActivity +import com.droiddeck.launcher.FrontEndActivity import com.droiddeck.launcher.R import com.droiddeck.launcher.core.DeviceSupport import com.droiddeck.launcher.stores.StoresState @@ -189,7 +189,7 @@ class StoreDownloadService : Service() { } private fun openPage(context: Context, nav: String, code: Int): PendingIntent = - PendingIntent.getActivity(context, code, Intent(context, MainActivity::class.java).putExtra(EXTRA_NAV, nav) + PendingIntent.getActivity(context, code, Intent(context, FrontEndActivity::class.java).putExtra(EXTRA_NAV, nav) .addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_CLEAR_TOP), PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT) private fun openDownloads(context: Context, code: Int) = openPage(context, "stores:downloads", code) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicInstaller.kt b/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicInstaller.kt index 8d40d002bf..3be966b968 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicInstaller.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicInstaller.kt @@ -133,7 +133,7 @@ internal class EpicInstaller( val sidecar = StoreGameSidecar( Store.EPIC, item.id, item.title, exe = picked.ifEmpty { "game.exe" }, args = args, installVersion = result.optString("buildVersion"), installedAt = System.currentTimeMillis(), - cover = cover, hero = item.imageUrl, extra = extra, + cover = cover, hero = item.imageUrl, extra = extra, logo = item.logoUrl, ) StoreInstalls.complete(app, folder, sidecar, onStep = { done, steps -> handle.stageProgress(done.toLong(), steps.toLong()) }) val disk = result.optLong("diskBytes", 0L) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicLibrary.kt b/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicLibrary.kt index be665881b8..32a485bfba 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicLibrary.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/epic/EpicLibrary.kt @@ -25,6 +25,7 @@ data class EpicGame( val releaseDate: String = "", val publisher: String = "", val isDlc: Boolean = false, + val artLogo: String = "", ) object EpicLibrary { @@ -50,7 +51,8 @@ object EpicLibrary { .put("title", g.title).put("artCover", g.artCover).put("artSquare", g.artSquare) .put("developer", g.developer).put("description", g.description).put("version", g.version) .put("installSize", g.installSize).put("canRunOffline", g.canRunOffline) - .put("releaseDate", g.releaseDate).put("publisher", g.publisher), + .put("releaseDate", g.releaseDate).put("publisher", g.publisher) + .apply { if (g.artLogo.isNotEmpty()) put("artLogo", g.artLogo) }, ) }.toString() @@ -73,6 +75,7 @@ object EpicLibrary { canRunOffline = o.optBoolean("canRunOffline", true), releaseDate = o.optString("releaseDate", ""), publisher = o.optString("publisher", ""), + artLogo = o.optString("artLogo", ""), ) } return tidy(games) @@ -106,6 +109,7 @@ object EpicLibrary { sizeBytes = prefs.getLong("size_${game.appName}", 0L).takeIf { it > 0 } ?: game.installSize, storeUrl = "https://store.epicgames.com/en-US/browse?q=" + URLEncoder.encode(title, "UTF-8"), extra = mapOf("namespace" to game.namespace, "catalogItemId" to game.catalogItemId, "version" to game.version), + logoUrl = game.artLogo.ifEmpty { null }, ) } @@ -128,6 +132,7 @@ object EpicLibrary { releaseDate = pick("releaseDate", before?.releaseDate.orEmpty()), publisher = pick("publisher", before?.publisher.orEmpty()), isDlc = d.optBoolean("dlc", false), + artLogo = pick("logo", before?.artLogo.orEmpty()), ) } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt index 1ba78d7951..acb7333e82 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt @@ -11,10 +11,12 @@ import com.droiddeck.launcher.stores.StoreInstallRoot import com.droiddeck.launcher.stores.StoreInstalls import com.droiddeck.launcher.stores.StoreLanguage import com.droiddeck.launcher.stores.StoreLoginActivity +import com.droiddeck.launcher.stores.StoreNet import com.droiddeck.launcher.stores.StoresState import com.droiddeck.launcher.stores.download.DownloadEntry import com.droiddeck.launcher.stores.download.DownloadQueue import com.droiddeck.launcher.stores.download.DownloadStage +import org.json.JSONObject import java.io.File import java.util.concurrent.atomic.AtomicBoolean @@ -85,6 +87,13 @@ object GogBackend : StoreBackend { override fun uninstall(context: Context, game: InstalledStoreGame) {} + private fun fetchLogo(id: String): String? = + runCatching { StoreNet.get("https://api.gog.com/v2/games/$id?locale=en-US")?.let { logoOf(JSONObject(it)) } }.getOrNull() + + /** `images.logo2x` from the products API is an opaque banner, not a logo; the v2 `logo` link is a transparent PNG. */ + internal fun logoOf(v2: JSONObject): String? = + GogStoreCatalog.absolutize(v2.optJSONObject("_links")?.optJSONObject("logo")?.optString("href")).takeIf { it.startsWith("https://") } + private class InstallJob(val app: Context, val game: GogGame, val item: CatalogItem, val folder: File) : DownloadQueue.DownloadJob { private val cancelled = AtomicBoolean(false) @@ -118,6 +127,7 @@ object GogBackend : StoreBackend { Store.GOG, game.gameId, game.title, exe = result.exeRelative.ifEmpty { "" }, installVersion = result.buildId, installedAt = System.currentTimeMillis(), cover = item.tallImageUrl ?: item.imageUrl, hero = item.imageUrl, + logo = item.logoUrl ?: fetchLogo(game.gameId), extra = mapOf(com.droiddeck.launcher.frontend.WinCompSources.GOG_DEPENDENCIES to result.dependencies.joinToString(",")) + (if (result.dependenciesRead) mapOf(com.droiddeck.launcher.frontend.WinCompSources.LIST_READ to "1") else emptyMap()) + mapOf(StoreLanguage.EXTRA to installedLanguage), diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt index 24d7ff622b..9121a35c9b 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt @@ -53,7 +53,7 @@ object XboxBackend : StoreBackend { else StoresState.status.remove(store) } } - if (cached != null && !cached.needsRefresh(force)) return@Thread + if (cached != null && !cached.needsRefresh(force)) { XboxGamertag.ensure(app); return@Thread } val response = Xodus.run(app, listOf("library", "--json", "--market", market)) val licenses = XboxCatalog.access(response, account, market, report = { StoresState.logLine("Xbox: $it") }) val products = XboxCatalog.rawProducts(licenses.keys.toList(), market) @@ -73,6 +73,7 @@ object XboxBackend : StoreBackend { StoresState.problems.remove(store) } } + if (current == generation) XboxGamertag.ensure(app) } catch (e: Exception) { StoresState.post { if (current == generation) { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt index 40cd28225b..ffe4b9de6b 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt @@ -29,10 +29,16 @@ internal class XboxCredentials(private val app: Context, expectedGeneration: Str } private fun rejected(reason: String): Boolean { - android.util.Log.w("XboxCredentials", "Rejected credential peer: $reason") + note("Rejected credential peer: $reason") return false } + /** Also written to the stores log: sign-in runs in its own process, where only that file reaches a shared log. */ + private fun note(text: String) { + android.util.Log.w("XboxCredentials", text) + com.droiddeck.launcher.stores.StoreLogFiles.stamped(app, "Xbox credentials: $text") + } + private fun authorized(pid: Int): Boolean { if (!bound.await(5, java.util.concurrent.TimeUnit.SECONDS) || closed) return rejected("unbound") val process = backend ?: return rejected("missing-child") @@ -88,7 +94,7 @@ internal class XboxCredentials(private val app: Context, expectedGeneration: Str answer(request) } }.getOrElse { - android.util.Log.w("XboxCredentials", "Credential request rejected: ${it.javaClass.simpleName}") + note("Credential request rejected: ${it.javaClass.simpleName}") JSONObject().put("ok", false) } runCatching { it.outputStream.write((reply.toString() + "\n").toByteArray()) } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxGamertag.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxGamertag.kt new file mode 100644 index 0000000000..b065e8bafe --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxGamertag.kt @@ -0,0 +1,51 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreAccounts +import com.droiddeck.launcher.stores.StoresState +/** Keeps the account's Xbox gamertag in its record so the Stores page can show it instead of the sign-in email. */ +internal object XboxGamertag { + /** `xodus-cli profile` allows itself 45 s, and starting it through PRoot adds to that. */ + private const val TIMEOUT_SECONDS = 75L + private val triedGeneration = java.util.concurrent.atomic.AtomicReference(null) + + internal fun valid(value: String): Boolean = value.isNotEmpty() && value.length <= 64 && value.none { it.isISOControl() } + + /** Reads the gamertag with `xodus-cli profile` and stores it; false when Xbox didn't return one. */ + fun refresh(app: Context, credentialGeneration: String? = null): Boolean = try { + val gamertag = Xodus.run(app, listOf("profile", "--json"), timeout = TIMEOUT_SECONDS, credentialGeneration = credentialGeneration) + .optString("gamertag").trim() + require(valid(gamertag)) + XboxCredentials.lifecycle(app, credentialGeneration) { + val record = StoreAccounts.read(app, Store.XBOX) ?: error("Xbox credentials missing") + record.put("gamertag", gamertag) + StoreAccounts.write(app, Store.XBOX, record) + } + StoresState.logLine("Xbox: gamertag read") + true + } catch (e: Exception) { + StoresState.logLine("Xbox: gamertag unavailable (${XboxLoginActivity.failure(e)})") + false + } + + /** Fetches a missing gamertag once per signed-in account, on its own thread so it never holds up a library sync. */ + fun ensure(app: Context) { + Thread({ + runCatching { + val generation = XboxCredentials.lifecycle(app) { it } + if (!StoreAccounts.read(app, Store.XBOX)?.optString("gamertag").isNullOrBlank()) return@runCatching + if (!shouldTryRefresh(generation)) return@runCatching + if (refresh(app, generation)) StoresState.refresh(app) + }.onFailure { StoresState.logLine("Xbox: gamertag check failed (${it.javaClass.simpleName})") } + }, "xbox-gamertag").start() + } + + internal fun shouldTryRefresh(generation: String): Boolean { + while (true) { + val previous = triedGeneration.get() + if (previous == generation) return false + if (triedGeneration.compareAndSet(previous, generation)) return true + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt index 01e19158f1..bdfb27d09a 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt @@ -4,6 +4,7 @@ import android.annotation.SuppressLint import android.graphics.Color import android.net.Uri import android.os.Bundle +import android.util.Log import android.webkit.CookieManager import android.webkit.WebResourceRequest import android.webkit.WebView @@ -14,8 +15,11 @@ import android.widget.TextView import androidx.activity.ComponentActivity import androidx.webkit.WebViewCompat import androidx.webkit.WebViewFeature +import com.droiddeck.launcher.core.AddonPack import com.droiddeck.launcher.stores.Store import com.droiddeck.launcher.stores.StoreAccounts +import com.droiddeck.launcher.stores.StoreLogFiles +import com.droiddeck.launcher.stores.StoreLog import org.json.JSONObject import java.util.concurrent.TimeUnit @@ -26,6 +30,7 @@ class XboxLoginActivity : ComponentActivity() { @Volatile private var child: Xodus.Child? = null @Volatile private var session = 0L @Volatile private var closed = false + @Volatile private var step = "starting" @SuppressLint("SetJavaScriptEnabled") override fun onCreate(savedInstanceState: Bundle?) { @@ -49,10 +54,18 @@ class XboxLoginActivity : ComponentActivity() { if (closed) return@Thread try { val accountGeneration = XboxCredentials.lifecycle(applicationContext) { it } + progress("downloading the Xbox components", "Downloading Xbox components…") + check(AddonPack.XBOX.await(applicationContext, { !closed }) { state -> + if (state is AddonPack.State.Downloading) show("Downloading Xbox components… ${(state.progress * 100).toInt()}%") + }) { "Couldn't download the Xbox components. Check your connection and try again." } + if (closed) return@Thread + progress("starting the Xbox helper", "Starting the Xbox helper…") Xodus.start(applicationContext, listOf("--external-webview-stdio", "login"), credentialGeneration = accountGeneration).use { process -> child = process if (closed) return@use - Xodus.diagnostics(process) + // StoresState.logLine writes no file in this process, so the reason would miss the shared log. + Xodus.diagnostics(process) { logStep(it) } + progress("waiting for the Xbox helper", "Waiting for the Xbox helper…") val timer = Thread({ runCatching { if (!process.process.waitFor(10, TimeUnit.MINUTES)) process.process.destroy() } }, "xbox-login-timeout").apply { start() } @@ -68,16 +81,19 @@ class XboxLoginActivity : ComponentActivity() { check(!ready && frame.getInt("version") == 1) ready = true process.send(JSONObject().put("type", "hello").put("version", 1)) + progress("waiting for Microsoft's sign-in page", "Opening Microsoft sign-in…") } "open" -> { val next = frame.getLong("session") check(ready && next > latest && next <= 32 && trusted(frame.getString("url"))) latest = next; session = next + step = "loading Microsoft's sign-in page" runOnUiThread { if (!closed) open(frame) } } "close" -> { check(frame.getLong("session") == session) session = 0L + step = "completing the sign-in" runOnUiThread { disposeView(); status.text = "Completing Microsoft sign-in…" } } "context" -> { @@ -95,26 +111,52 @@ class XboxLoginActivity : ComponentActivity() { else -> error("Unsupported Xbox sign-in response") } } - check(process.process.waitFor(5, TimeUnit.SECONDS) && process.process.exitValue() == 0 && ready && latest > 0 && session == 0L) + if (closed) return@use + check(process.process.waitFor(5, TimeUnit.SECONDS)) { "the Xbox helper did not exit" } + val exit = process.process.exitValue() + check(exit == 0) { "the Xbox helper stopped with exit code $exit" } + check(ready) { "the Xbox helper never became ready" } + check(latest > 0) { "Microsoft's sign-in page was never requested" } + check(session == 0L) { "the sign-in page was closed before Microsoft finished" } timer.interrupt() } child = null if (closed) return@Thread + step = "saving the account" val account = Xodus.run(applicationContext, listOf("account", "--json"), credentialGeneration = accountGeneration) - check(account.optBoolean("stored")) + check(account.optBoolean("stored")) { "Xbox did not save the account" } XboxCredentials.lifecycle(this, accountGeneration) { val record = StoreAccounts.read(this, Store.XBOX) ?: error("Xbox credentials missing") record.put("username", account.getString("username")) StoreAccounts.write(this, Store.XBOX, record) } + logStep("signed in") runOnUiThread { finish() } } catch (e: Exception) { child = null - if (!closed) runOnUiThread { disposeView(); status.text = "Microsoft sign-in did not complete. Close this window and try again." } + if (closed) return@Thread + val failed = step + val reason = failure(e) + logStep("failed while $failed: $reason") + runOnUiThread { + disposeView() + status.text = "Microsoft sign-in did not complete.\nFailed while $failed: $reason\nClose this window and try again." + } } }, "xbox-login").start() } + private fun show(text: String) = runOnUiThread { if (!closed && view == null) status.text = text } + + private fun progress(name: String, text: String) { step = name; show(text) } + + /** Written to the stores log, which the shared log zip carries; the main process's log helpers don't run in this process. */ + private fun logStep(line: String) { + val text = StoreLog.redactLine("Xbox sign-in: $line") + Log.i(TAG, text) + StoreLogFiles.stamped(applicationContext, text) + } + @SuppressLint("SetJavaScriptEnabled") private fun open(frame: JSONObject) { disposeView() @@ -172,6 +214,15 @@ class XboxLoginActivity : ComponentActivity() { } companion object { + private const val TAG = "XboxLogin" + + /** Our own check messages are safe to show; anything else is named by its type, never its text, which may hold sign-in data. */ + internal fun failure(e: Exception): String { + val message = e.message.orEmpty() + return if (e is IllegalStateException && message.isNotBlank() && message != "Check failed." && message.length <= 160) message + else e.javaClass.simpleName.ifBlank { "error" } + } + private val hosts = setOf("login.live.com", "account.live.com", "login.microsoftonline.com", "login.microsoft.com", "account.microsoft.com", "sisu.xboxlive.com") private val origins = hosts.map { "https://$it" }.toSet() private val allowedHeaders = setOf("cxh-capabilities", "cxh-correlationid", "cxh-msabinaryversion", "cxh-identityclientbinaryversion", "cxh-osversioninfo", "cxh-platform", "cxh-protocol", "cxh-source", "hostapp") diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt index 6e7c30df84..fde5b0650c 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt @@ -133,11 +133,12 @@ internal object Xodus { } } - fun diagnostics(child: Child): Thread = Thread({ + /** Passes the backend's known stderr diagnostics to [report]; other stderr text never leaves the process. */ + fun diagnostics(child: Child, report: (String) -> Unit = { com.droiddeck.launcher.stores.StoresState.logLine("Xbox: $it") }): Thread = Thread({ runCatching { child.process.errorStream.bufferedReader().useLines { lines -> lines.forEach { line -> - if (line.matches(Regex("NEXUS_CREDENTIAL_ERROR_V1 [a-z-]{1,48}|NEXUS_LIBRARY_DIAGNOSTIC_V1 [a-z-]{1,48} [0-9]{1,3} [0-9]{1,6}|NEXUS_SESSION_DIAGNOSTIC_V1 [a-z-]{1,64}|Account library unavailable \\([a-z-]{1,64}\\); credentials and installed games are unchanged\\.|Account library timed out; installed games are unchanged\\."))) - com.droiddeck.launcher.stores.StoresState.logLine("Xbox: $line") + if (line.matches(Regex("NEXUS_CREDENTIAL_ERROR_V1 [a-z-]{1,48}|NEXUS_LIBRARY_DIAGNOSTIC_V1 [a-z-]{1,48} [0-9]{1,3} [0-9]{1,6}|NEXUS_SESSION_DIAGNOSTIC_V1 [a-z-]{1,64}|Account library unavailable \\([a-z-]{1,64}\\); credentials and installed games are unchanged\\.|Account library timed out; installed games are unchanged\\.|Xbox profile is temporarily unavailable \\([a-z-]{1,48}\\); stored account is unchanged\\.|Xbox profile request timed out; stored account is unchanged\\."))) + report(line) } } } }, "xbox-diagnostics").apply { start() } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt b/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt index dcb5eece6d..c7b78ee05c 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/FrontEndGames.kt @@ -27,6 +27,7 @@ import androidx.compose.foundation.layout.heightIn import androidx.compose.foundation.layout.padding import androidx.compose.foundation.layout.size import androidx.compose.foundation.layout.width +import androidx.compose.foundation.layout.widthIn import androidx.compose.foundation.rememberScrollState import androidx.compose.foundation.shape.RoundedCornerShape import androidx.compose.foundation.verticalScroll @@ -341,11 +342,24 @@ private fun ColumnScope.GameHeroCopy(g: Library.SteamGame, titleSize: androidx.c maxLines = 1, overflow = TextOverflow.Ellipsis, ) } - Text( + GameTitle(g, titleSize) + Spacer(Modifier.height(8.dp)) +} + +@Composable +private fun GameTitle(g: Library.SteamGame, titleSize: androidx.compose.ui.unit.TextUnit) { + val logo = g.logo + var failed by remember(logo) { androidx.compose.runtime.mutableStateOf(false) } + if (logo != null && !failed) { + AsyncImage( + model = logo, contentDescription = g.name, contentScale = ContentScale.Fit, alignment = Alignment.CenterStart, + onError = { failed = true }, + modifier = Modifier.padding(vertical = 4.dp).height((titleSize.value * 2.2f).dp).widthIn(max = (titleSize.value * 9f).dp).testTag("game-logo"), + ) + } else Text( g.name, fontSize = titleSize, lineHeight = titleSize * 1.15f, fontWeight = FontWeight.Bold, color = MaterialTheme.colorScheme.onBackground, maxLines = 2, overflow = TextOverflow.Ellipsis, ) - Spacer(Modifier.height(8.dp)) } @Composable diff --git a/app/src/main/rust/stores/src/amazon/library.rs b/app/src/main/rust/stores/src/amazon/library.rs index ec9ba55f86..46360a907b 100644 --- a/app/src/main/rust/stores/src/amazon/library.rs +++ b/app/src/main/rust/stores/src/amazon/library.rs @@ -21,6 +21,7 @@ pub struct Game { pub parent_product_id: String, pub art: String, pub hero: String, + pub logo: String, pub developer: String, pub publisher: String, } @@ -39,6 +40,7 @@ impl Game { "sku": self.sku, "art": self.art, "hero": self.hero, + "logo": self.logo, "developer": self.developer, "publisher": self.publisher, "dlc": self.is_dlc(), @@ -83,6 +85,7 @@ pub fn read_entitlement(e: &Value) -> Option { ], ) .to_string(), + logo: str_at(product, &["productDetail", "details", "logoUrl"]).to_string(), developer: str_at(product, &["productDetail", "details", "developer"]).to_string(), publisher: str_at(product, &["productDetail", "details", "publisher"]).to_string(), }) @@ -178,17 +181,20 @@ mod tests { fn entitlement_fields_and_fallbacks() { let e = json!({"id":"ent-1","product":{"id":"amzn1.adg.product.x","title":"Game","sku":"SKU1", "productDetail":{"iconUrl":"","details":{"pgCrownImageUrl":"crown","backgroundUrl1":"bg1", - "developer":"Dev","publisher":"Pub","productType":"GAME"}}}}); + "logoUrl":"logo","developer":"Dev","publisher":"Pub","productType":"GAME"}}}}); let g = read_entitlement(&e).unwrap(); assert_eq!(g.entitlement_id, "ent-1"); assert_eq!(g.art, "crown"); assert_eq!(g.hero, "bg1"); + assert_eq!(g.logo, "logo"); + assert_eq!(g.to_json()["logo"], "logo"); assert_eq!(g.product_type, "GAME"); assert!(!g.is_dlc()); let untitled = read_entitlement(&json!({"product":{"id":"p","type":"DLC","baseProductId":"q"}})).unwrap(); assert_eq!(untitled.title, "Unknown"); assert_eq!(untitled.entitlement_id, ""); assert_eq!(untitled.parent_product_id, "q"); + assert_eq!(untitled.logo, ""); assert!(untitled.is_dlc()); assert!(read_entitlement(&json!({"id":"x"})).is_none()); assert!(read_entitlement(&json!({"id":"x","product":{"id":""}})).is_none()); diff --git a/app/src/main/rust/stores/src/epic/catalog.rs b/app/src/main/rust/stores/src/epic/catalog.rs index 4589ce276b..420d656e80 100644 --- a/app/src/main/rust/stores/src/epic/catalog.rs +++ b/app/src/main/rust/stores/src/epic/catalog.rs @@ -71,6 +71,7 @@ pub fn details_of(entry: &Value) -> Value { "releaseDate": release, "tall": image(entry, &["DieselGameBoxTall"]), "wide": image(entry, &["DieselGameBox", "Thumbnail"]), + "logo": image(entry, &["DieselGameBoxLogo"]), "canRunOffline": offline, "dlc": main_game.is_some_and(|m| !m.is_null()), "mainGameId": main_game.map(|m| net::str_of(m, "id")).unwrap_or(""), @@ -102,7 +103,8 @@ mod tests { "keyImages": [ {"type": "Thumbnail", "url": "thumb"}, {"type": "DieselGameBox", "url": ""}, - {"type": "DieselGameBoxTall", "url": "tall"} + {"type": "DieselGameBoxTall", "url": "tall"}, + {"type": "DieselGameBoxLogo", "url": "logo"} ], "customAttributes": {"CanRunOffline": {"value": "FALSE"}, "publisherName": {"value": " Pub "}}, "seller": {"name": "Seller"}, @@ -113,6 +115,7 @@ mod tests { assert_eq!(d["title"], "Game"); assert_eq!(d["tall"], "tall"); assert_eq!(d["wide"], "thumb"); + assert_eq!(d["logo"], "logo"); assert_eq!(d["publisher"], "Pub"); assert_eq!(d["canRunOffline"], false); assert_eq!(d["releaseDate"], "2020-01-01T00:00:00.000Z"); @@ -123,6 +126,7 @@ mod tests { assert_eq!(dlc["publisher"], "S"); assert_eq!(dlc["releaseDate"], "v"); assert_eq!(dlc["canRunOffline"], true); + assert_eq!(dlc["logo"], ""); assert_eq!(pick_entry(&json!({"x": {"title": "Only"}}), "y").unwrap()["title"], "Only"); } } diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtFillTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtFillTest.kt new file mode 100644 index 0000000000..473c43922a --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/frontend/AddedGameArtFillTest.kt @@ -0,0 +1,163 @@ +package com.droiddeck.launcher.frontend + +import com.droiddeck.launcher.frontend.AddedGameArt.Slot +import com.droiddeck.launcher.session.SessionPrefs +import org.junit.Assert.assertArrayEquals +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertTrue +import org.junit.Assert.fail +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config +import java.io.File + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33]) +class AddedGameArtFillTest { + private val app get() = RuntimeEnvironment.getApplication() + @get:Rule val tmp = TemporaryFolder() + + private val coverBytes = byteArrayOf(9, 9, 9) + + private fun game(name: String, appId: Long, cover: Boolean = true, source: String = Library.ADDED): AddedGames.Game { + val dir = tmp.newFolder(name) + File(dir, "steam_appid.txt").writeText("504230") + if (cover) File(dir, "cover.jpg").writeBytes(coverBytes) + val exe = File(dir, "$name.exe").apply { writeText("x") } + return AddedGames.Game(dir, name, exe, "/g/$name.exe", "/g", appId, appId, emptyList(), source = source) + } + + private class Calls { + val steam = ArrayList>() + val sgdb = ArrayList>() + var lookups = 0 + var store = 0 + } + + private val steamNames = mapOf(Slot.COVER to "p.jpg", Slot.WIDE to "header.jpg", Slot.BACKGROUND to "hero.jpg", Slot.LOGO to "logo.png") + + private fun sources( + calls: Calls, steamHas: Set = emptySet(), sgdbHas: Set = emptySet(), + storeHas: Boolean = false, sgdbFails: Boolean = false, + ) = AddedGameArt.Sources( + storeLogo = { g -> + calls.store++ + if (storeHas) File(g.folder, "logo.png").writeBytes(byteArrayOf(4)) + storeHas + }, + steamSearch = { fail("searched although the game names its appid"); null }, + steam = { id, cache, slots -> + assertEquals("504230", id) + calls.steam += slots + (slots intersect steamHas).onEach { File(cache, steamNames.getValue(it)).writeBytes(byteArrayOf(1)) }.isNotEmpty() + }, + sgdbGame = { _, steamId, _ -> + calls.lookups++ + assertEquals(504230, steamId) + 77 + }, + sgdb = { _, id, cache, slots -> + assertEquals(77, id) + if (sgdbFails) throw SteamGridDb.Failed(SteamGridDb.Status.OFFLINE) + calls.sgdb += slots + (slots intersect sgdbHas).onEach { File(cache, SteamGridDb.cacheName(it)).writeBytes(byteArrayOf(2)) }.isNotEmpty() + }, + ) + + @Test fun aGameWithItsOwnCoverStillGetsItsLogoAndIcon() { + val g = game("Celeste", 0x81000001L) + val calls = Calls() + assertTrue(AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls, steamHas = setOf(Slot.LOGO), sgdbHas = setOf(Slot.ICON)))) + assertEquals(listOf(setOf(Slot.LOGO)), calls.steam) + assertEquals(listOf(setOf(Slot.ICON)), calls.sgdb) + assertEquals(0, calls.store) + val cache = AddedGameArt.cacheDir(app, g) + assertFalse(File(cache, "p.jpg").exists()) + assertArrayEquals(coverBytes, File(g.folder, "cover.jpg").readBytes()) + val art = AddedGameArt.resolve(app, g) + assertEquals(File(g.folder, "cover.jpg"), art.portrait) + assertEquals(File(cache, "logo.png"), art.logo) + assertEquals(File(cache, "icon-sgdb.png"), art.icon) + assertFalse(File(cache, AddedGameArt.EXTRAS_TRIED).exists()) + } + + @Test fun filledOrChosenSlotsAreNeverAskedFor() { + val g = game("Hades", 0x81000002L) + File(g.folder, "logo.png").writeBytes(byteArrayOf(5)) + val picked = File(tmp.root, "mine.png").apply { writeBytes(byteArrayOf(6)) } + assertTrue(AddedGameArt.store(AddedGameArt.cacheDir(app, g), Slot.ICON, AddedGameArt.Option(AddedGameArt.FILE, picked.path, picked.path))) + val calls = Calls() + assertFalse(AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls, steamHas = Slot.values().toSet(), sgdbHas = Slot.values().toSet()))) + assertTrue(calls.steam.isEmpty() && calls.sgdb.isEmpty() && calls.lookups == 0) + assertArrayEquals(byteArrayOf(5), File(g.folder, "logo.png").readBytes()) + } + + @Test fun withoutAKeyAMissingIconAloneAsksNothing() { + val g = game("Inside", 0x81000003L) + File(g.folder, "logo.png").writeBytes(byteArrayOf(5)) + val calls = Calls() + assertFalse(AddedGameArt.fetchMissing(app, listOf(g), "", sources(calls))) + assertTrue(calls.steam.isEmpty() && calls.sgdb.isEmpty() && calls.lookups == 0) + assertFalse(AddedGameArt.cacheDir(app, g).exists()) + } + + @Test fun aMissIsAskedAgainOnlyAfterAWeek() { + val g = game("Limbo", 0x81000004L) + val calls = Calls() + assertFalse(AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls))) + assertEquals(listOf(setOf(Slot.LOGO)), calls.steam) + assertEquals(listOf(setOf(Slot.LOGO, Slot.ICON)), calls.sgdb) + AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls)) + assertEquals(1, calls.steam.size) + assertEquals(1, calls.sgdb.size) + val tried = File(AddedGameArt.cacheDir(app, g), AddedGameArt.EXTRAS_TRIED) + assertTrue(tried.setLastModified(System.currentTimeMillis() - 8L * 24 * 3600 * 1000)) + assertTrue(AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls, steamHas = setOf(Slot.LOGO), sgdbHas = setOf(Slot.ICON)))) + assertEquals(2, calls.steam.size) + assertEquals(setOf(Slot.ICON), calls.sgdb.last()) + assertFalse(tried.exists()) + } + + @Test fun theStoresOwnLogoComesFirst() { + val g = game("Metalstorm", 0x81000005L, source = "gog") + val calls = Calls() + assertTrue(AddedGameArt.fetchMissing(app, listOf(g), "key", sources(calls, storeHas = true, steamHas = setOf(Slot.LOGO), sgdbHas = setOf(Slot.ICON)))) + assertEquals(1, calls.store) + assertTrue(calls.steam.isEmpty()) + assertEquals(listOf(setOf(Slot.ICON)), calls.sgdb) + assertEquals(File(g.folder, "logo.png"), AddedGameArt.resolve(app, g).logo) + } + + @Test fun aGameWithoutACoverStillGetsEverySlot() { + val g = game("Tunic", 0x81000006L, cover = false) + val calls = Calls() + assertTrue(AddedGameArt.fetchMissing(app, listOf(g), "key", + sources(calls, steamHas = setOf(Slot.COVER, Slot.WIDE, Slot.BACKGROUND), sgdbHas = setOf(Slot.LOGO, Slot.ICON)))) + assertEquals(listOf(setOf(Slot.COVER, Slot.WIDE, Slot.BACKGROUND, Slot.LOGO)), calls.steam) + assertEquals(listOf(setOf(Slot.LOGO, Slot.ICON)), calls.sgdb) + assertTrue(AddedGameArt.missing(app, g).isEmpty()) + } + + @Test fun aSteamGridDbFailureIsNotRememberedAndStopsThePass() { + val first = game("Gris", 0x81000007L) + val second = game("Hollow", 0x81000008L) + val calls = Calls() + AddedGameArt.fetchMissing(app, listOf(first, second), "key", sources(calls, sgdbFails = true)) + assertEquals(2, calls.steam.size) + assertEquals(1, calls.lookups) + assertFalse(File(AddedGameArt.cacheDir(app, first), AddedGameArt.EXTRAS_TRIED).exists()) + assertFalse(File(AddedGameArt.cacheDir(app, second), AddedGameArt.EXTRAS_TRIED).exists()) + } + + @Test fun nothingIsFetchedWhenArtIsOff() { + SessionPrefs.setAddedGamesArt(app, false) + val calls = Calls() + assertFalse(AddedGameArt.fetchMissing(app, listOf(game("Off", 0x81000009L)), "key", sources(calls))) + assertTrue(calls.steam.isEmpty()) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/GameLaunchLinkTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/GameLaunchLinkTest.kt index 9493a630b4..1fbd8c4914 100644 --- a/app/src/test/java/com/droiddeck/launcher/frontend/GameLaunchLinkTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/frontend/GameLaunchLinkTest.kt @@ -4,7 +4,7 @@ import android.content.Intent import android.net.Uri import android.app.Activity import com.droiddeck.launcher.LauncherIcon -import com.droiddeck.launcher.MainActivity +import com.droiddeck.launcher.FrontEndActivity import com.droiddeck.launcher.frontend.Library import org.junit.Assert.assertEquals import org.junit.Assert.assertNotNull @@ -54,7 +54,7 @@ class GameShortcutIntentTest { assertEquals(Intent.ACTION_VIEW, intent.action) assertEquals(Uri.parse("droiddeck://game/$id"), intent.data) - assertEquals(MainActivity::class.java.name, intent.component?.className) + assertEquals(FrontEndActivity::class.java.name, intent.component?.className) assertEquals(android.content.Intent.FLAG_ACTIVITY_CLEAR_TOP or android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP, intent.flags) } @@ -69,8 +69,8 @@ class GameShortcutIntentTest { val launch = requireNotNull(shortcut.intent) assertEquals("game:8400", shortcut.id) assertEquals("Geometry Wars: Retro Evolved", shortcut.shortLabel.toString()) - assertEquals("com.droiddeck.launcher.LauncherDark", shortcut.activity?.className) - assertEquals(MainActivity::class.java.name, launch.component?.className) + assertEquals("com.droiddeck.launcher.MainActivity", shortcut.activity?.className) + assertEquals(FrontEndActivity::class.java.name, launch.component?.className) assertEquals(Intent.ACTION_VIEW, launch.action) assertEquals(Uri.parse("droiddeck://game/8400"), launch.data) assertEquals(Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP, launch.flags) @@ -93,4 +93,38 @@ class GameShortcutIntentTest { assertNotNull(GameShortcuts.result(activity, game)) } + + @Test fun theDefaultLauncherEntryKeepsTheMainActivityName() { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + val launchers = activity.packageManager.queryIntentActivities( + Intent(Intent.ACTION_MAIN).addCategory(Intent.CATEGORY_LAUNCHER).setPackage(activity.packageName), 0) + + assertEquals(listOf("com.droiddeck.launcher.MainActivity"), launchers.map { it.activityInfo.name }) + assertEquals(android.content.ComponentName(activity, "com.droiddeck.launcher.MainActivity"), LauncherIcon.activity(activity)) + } + + @Test fun repairDropsTheDefaultIconLeftBesideAChosenLightIcon() { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + val pm = activity.packageManager + pm.setComponentEnabledSetting(android.content.ComponentName(activity, "com.droiddeck.launcher.LauncherLight"), + android.content.pm.PackageManager.COMPONENT_ENABLED_STATE_ENABLED, android.content.pm.PackageManager.DONT_KILL_APP) + val dark = android.content.ComponentName(activity, "com.droiddeck.launcher.MainActivity") + + LauncherIcon.repair(activity, dark) + assertEquals(android.content.pm.PackageManager.COMPONENT_ENABLED_STATE_DEFAULT, pm.getComponentEnabledSetting(dark)) + + LauncherIcon.repair(activity, android.content.ComponentName(activity, "com.droiddeck.launcher.LauncherLight")) + assertEquals(android.content.pm.PackageManager.COMPONENT_ENABLED_STATE_DISABLED, pm.getComponentEnabledSetting(dark)) + assertEquals(LauncherIcon.LIGHT, LauncherIcon.current(activity)) + } + + @Test fun repairLeavesASingleIconAlone() { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + val dark = android.content.ComponentName(activity, "com.droiddeck.launcher.MainActivity") + + LauncherIcon.repair(activity, null) + + assertEquals(android.content.pm.PackageManager.COMPONENT_ENABLED_STATE_DEFAULT, activity.packageManager.getComponentEnabledSetting(dark)) + assertEquals(LauncherIcon.DARK, LauncherIcon.current(activity)) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/GameLogoTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/GameLogoTest.kt new file mode 100644 index 0000000000..5a577f5b37 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/frontend/GameLogoTest.kt @@ -0,0 +1,80 @@ +package com.droiddeck.launcher.frontend + +import com.droiddeck.launcher.session.SessionPrefs +import org.json.JSONArray +import org.json.JSONObject +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Before +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config +import java.io.File + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33]) +class GameLogoTest { + private val app get() = RuntimeEnvironment.getApplication() + @get:Rule val tmp = TemporaryFolder() + + @Before fun noGamesFolders() { + AddedGamesPublisher.now = true + SessionPrefs.setGameStorage(app, SessionPrefs.GAME_STORAGE_OFF, "") + SessionPrefs.setAddedGamesDirs(app, emptyList()) + } + + private fun image(name: String) = File(tmp.root, name).apply { parentFile?.mkdirs(); writeBytes(ByteArray(8) { 1 }) } + + @Test fun steamsCachedLogoIsFoundInTheAppFolderOrAHashedOne() { + val cache = tmp.newFolder("librarycache") + val logo = File(cache, "620/3f1c/logo.png").apply { parentFile?.mkdirs(); writeBytes(ByteArray(4) { 1 }) } + assertEquals(logo, Library.steamCacheImage(cache, 620, Library.STEAM_LOGOS)) + File(cache, "730").mkdirs() + File(cache, "730/logo.png").writeBytes(ByteArray(0)) + assertNull(Library.steamCacheImage(cache, 730, Library.STEAM_LOGOS)) + } + + @Test fun aChosenLogoWinsOverSteamsAndKeepsTheRest() { + val stock = image("logo.png") + val game = Library.SteamGame(620, "Portal 2", null, "Steam library", logo = stock) + assertTrue(SteamGameArt.withOverrides(app, game) === game) + val picked = image("mine.png") + assertTrue(SteamGameArt.choose(app, game, AddedGameArt.Slot.LOGO, AddedGameArt.Option(AddedGameArt.FILE, picked.path, picked.path))) + val shown = SteamGameArt.withOverrides(app, game) + assertTrue(shown.logo!!.name.startsWith("chosen-logo")) + assertNull(shown.art) + SteamGameArt.reset(app, game, AddedGameArt.Slot.LOGO) + assertEquals(stock, SteamGameArt.withOverrides(app, game).logo) + } + + @Test fun anAddedGameShowsItsFolderLogoUnlessOneWasChosen() { + val dir = tmp.newFolder("Celeste") + val own = File(dir, "logo.png").apply { writeBytes(ByteArray(4) { 1 }) } + val exe = File(dir, "Celeste.exe").apply { writeText("x") } + val g = AddedGames.Game(dir, "Celeste", exe, "/g/Celeste.exe", "/g", 0x82000001L, 0x82000001L, emptyList(), source = "gog") + assertEquals(own, Library.addedGame(app, g, emptyList()).logo) + val picked = image("pick.png") + assertTrue(AddedGameArt.choose(app, g, AddedGameArt.Slot.LOGO, AddedGameArt.Option(AddedGameArt.FILE, picked.path, picked.path))) + assertTrue(Library.addedGame(app, g, emptyList()).logo!!.name.startsWith("chosen-logo")) + val bare = AddedGames.Game(tmp.newFolder("Bare"), "Bare", exe, "/g/Bare.exe", "/g", 0x82000002L, 0x82000002L, emptyList()) + assertNull(Library.addedGame(app, bare, emptyList()).logo) + } + + @Test fun theLibraryCacheKeepsTheLogoAndReadsOlderEntries() { + val logo = image("logo.png") + val game = Library.SteamGame(620, "Portal 2", null, "Steam library", logo = logo) + LibraryCache.save(app, listOf(game, Library.SteamGame(730, "CS2", null, "Steam library"))) + val back = LibraryCache.load(app) + assertEquals(logo, back[0].logo) + assertNull(back[1].logo) + assertEquals(logo, game.withArt(null, null, null).logo) + val file = File(app.filesDir, "library-cache.json") + file.writeText(JSONArray().put(JSONObject().put("appId", 1).put("name", "Old").put("library", "x").put("gameId", 1L)).toString()) + assertNull(LibraryCache.load(app).single().logo) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt index e0c657a147..2dde17cab1 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt @@ -131,6 +131,25 @@ class StoreAccountsCipherTest { assertEquals("test@example.test", StoreAccounts.signedInAs(app, Store.XBOX)) } + @Test fun xboxShowsTheGamertagElseAMaskedEmail() { + StoreAccounts.write(app, Store.XBOX, JSONObject().put("username", "player@example.test")) + assertEquals("p•••@example.test", StoreAccounts.displayName(app, Store.XBOX)) + StoreAccounts.write(app, Store.XBOX, JSONObject().put("username", "player@example.test").put("gamertag", "Some Gamertag")) + assertEquals("Some Gamertag", StoreAccounts.displayName(app, Store.XBOX)) + assertEquals("player@example.test", StoreAccounts.signedInAs(app, Store.XBOX)) + StoreAccounts.write(app, Store.EPIC, creds) + assertEquals("Someone", StoreAccounts.displayName(app, Store.EPIC)) + assertEquals("n•••", StoreAccounts.maskEmail("nickname")) + } + + @Test fun xboxDisplayNameDoesNotRevealEmailWhenCredentialsAreTemporarilyUnavailable() { + StoreAccounts.write(app, Store.XBOX, JSONObject().put("username", "player@example.test")) + StoreAccounts.keys = Flaky(key, 1) { java.security.ProviderException("busy") } + assertEquals(Store.XBOX.label, StoreAccounts.displayName(app, Store.XBOX)) + assertTrue(StoreAccounts.isUnavailable(Store.XBOX)) + assertTrue(file(Store.XBOX).exists()) + } + @Test fun signOutRemovesTheFile() { StoreAccounts.write(app, Store.GOG, creds) StoreAccounts.clear(app, Store.GOG) diff --git a/app/src/test/java/com/droiddeck/launcher/stores/StoreGameSidecarTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/StoreGameSidecarTest.kt index 213cbf9a14..b7ad90b56d 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/StoreGameSidecarTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/StoreGameSidecarTest.kt @@ -34,6 +34,17 @@ class StoreGameSidecarTest { assertEquals("ns", back.extra["namespace"]) } + @Test fun theStoreLogoRoundTripsAndOlderFilesHaveNone() { + val withLogo = sample.copy(logo = "https://x/logo.png") + val back = StoreGameSidecar.parse(withLogo.toJson().toString())!! + assertEquals("https://x/logo.png", back.logo) + assertEquals("https://x/logo.png", back.copy(state = StoreGameSidecar.STATE_UPDATING).logo) + assertFalse(sample.toJson().has("logo")) + assertNull(StoreGameSidecar.parse(sample.toJson().toString())!!.logo) + assertNull(StoreGameSidecar.parse("""{"store":"gog","id":"1","title":"T","exe":"game.exe","cover":"c","hero":"h"}""")!!.logo) + assertNull(StoreGameSidecar.parse("""{"store":"gog","id":"1","title":"T","exe":"game.exe","logo":""}""")!!.logo) + } + @Test fun defaultsWhenFieldsAreAbsent() { val back = StoreGameSidecar.parse("""{"store":"gog","id":"1","title":"T","exe":"bin\\game.exe","addToSteam":false}""")!! assertEquals("bin/game.exe", back.exe) diff --git a/app/src/test/java/com/droiddeck/launcher/stores/StoreLogoTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/StoreLogoTest.kt new file mode 100644 index 0000000000..71a6c1d8e7 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/StoreLogoTest.kt @@ -0,0 +1,88 @@ +package com.droiddeck.launcher.stores + +import android.graphics.Bitmap +import android.graphics.BitmapFactory +import android.graphics.Color +import com.droiddeck.launcher.stores.amazon.AmazonLibrary +import com.droiddeck.launcher.stores.gog.GogBackend +import org.json.JSONObject +import org.junit.Assert.assertArrayEquals +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config +import org.robolectric.annotation.GraphicsMode +import java.io.ByteArrayOutputStream +import java.io.File + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33]) +@GraphicsMode(GraphicsMode.Mode.NATIVE) +class StoreLogoTest { + @get:Rule val tmp = TemporaryFolder() + + private fun encoded(format: Bitmap.CompressFormat): ByteArray { + val bmp = Bitmap.createBitmap(8, 4, Bitmap.Config.ARGB_8888) + bmp.eraseColor(Color.TRANSPARENT) + bmp.setPixel(1, 1, Color.RED) + return ByteArrayOutputStream().also { bmp.compress(format, 100, it) }.toByteArray() + } + + @Test fun aPngLogoIsKeptAsItCameWithItsTransparency() { + val png = encoded(Bitmap.CompressFormat.PNG) + val dst = File(tmp.root, StoreArt.LOGO) + assertTrue(StoreArt.writeLogo(png, dst)) + assertArrayEquals(png, dst.readBytes()) + val back = BitmapFactory.decodeFile(dst.path) + assertEquals(0, Color.alpha(back.getPixel(0, 0))) + assertEquals(Color.RED, back.getPixel(1, 1)) + assertFalse(File(dst.path + ".tmp").exists()) + } + + @Test fun anotherImageFormatIsStoredAsPng() { + val dst = File(tmp.root, StoreArt.LOGO) + assertTrue(StoreArt.writeLogo(encoded(Bitmap.CompressFormat.JPEG), dst)) + val head = dst.readBytes().take(4) + assertEquals(listOf(0x89.toByte(), 'P'.code.toByte(), 'N'.code.toByte(), 'G'.code.toByte()), head) + assertEquals(8, BitmapFactory.decodeFile(dst.path).width) + } + + @Test fun whatIsNotAnImageIsRefusedAndAnExistingLogoStays() { + val dst = File(tmp.root, StoreArt.LOGO) + assertFalse(StoreArt.writeLogo("not found".toByteArray(), dst)) + assertFalse(dst.exists()) + dst.writeBytes(byteArrayOf(1, 2, 3)) + assertTrue(StoreArt.writeLogo(encoded(Bitmap.CompressFormat.PNG), dst)) + assertArrayEquals(byteArrayOf(1, 2, 3), dst.readBytes()) + assertTrue(StoreArt.fetchLogo(tmp.root, "https://invalid.example/logo.png")) + } + + @Test fun gogTakesTheV2LogoLinkOnly() { + val v2 = JSONObject("""{"_links":{"logo":{"href":"https://images.gog-statics.com/abc_logo.png"},"galaxyBackgroundImage":{"href":"https://x/bg.jpg"}}}""") + assertEquals("https://images.gog-statics.com/abc_logo.png", GogBackend.logoOf(v2)) + assertEquals("https://images.gog-statics.com/rel.png", GogBackend.logoOf(JSONObject("""{"_links":{"logo":{"href":"//images.gog-statics.com/rel.png"}}}"""))) + assertNull(GogBackend.logoOf(JSONObject("""{"_links":{}}"""))) + assertNull(GogBackend.logoOf(JSONObject("""{"images":{"logo2x":"https://x/glx_logo_2x.jpg"}}"""))) + assertNull(GogBackend.logoOf(JSONObject("""{"_links":{"logo":{"href":"http://x/logo.png"}}}"""))) + } + + @Test fun amazonKeepsTheLogoFromTheLibraryAndItsCache() { + val app = RuntimeEnvironment.getApplication() + val fresh = AmazonLibrary.gameFrom(JSONObject().put("productId", "p").put("title", "Game").put("logo", "https://m/logo.png"), null) + assertEquals("https://m/logo.png", fresh.logoUrl) + assertEquals("https://m/logo.png", AmazonLibrary.toCatalogItem(app, fresh).logoUrl) + assertEquals(listOf(fresh), AmazonLibrary.fromCacheJson(AmazonLibrary.toCacheJson(listOf(fresh)))) + val kept = AmazonLibrary.gameFrom(JSONObject().put("productId", "p").put("title", "Game"), fresh) + assertEquals("https://m/logo.png", kept.logoUrl) + val none = AmazonLibrary.gameFrom(JSONObject().put("productId", "q").put("title", "Other"), null) + assertNull(AmazonLibrary.toCatalogItem(app, none).logoUrl) + assertEquals("", AmazonLibrary.fromCacheJson("""[{"productId":"old","title":"Old"}]""").single().logoUrl) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/epic/EpicLibraryTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/epic/EpicLibraryTest.kt index 4eb819043a..a3f156e1b0 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/epic/EpicLibraryTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/epic/EpicLibraryTest.kt @@ -83,6 +83,18 @@ class EpicLibraryTest { assertEquals("Fig", EpicLibrary.gameFrom(record, null, null).title) } + @Test fun theCatalogLogoIsKeptInTheCacheAndHandedToTheInstall() { + val record = JSONObject().put("appName", "Fig").put("namespace", "ns").put("catalogItemId", "cat") + val fresh = EpicLibrary.gameFrom(record, JSONObject().put("logo", "https://e/logo.png"), null) + assertEquals("https://e/logo.png", fresh.artLogo) + assertEquals("https://e/logo.png", EpicLibrary.gameFrom(record, JSONObject().put("title", "Fig"), fresh).artLogo) + assertEquals(listOf(fresh), EpicLibrary.fromCacheJson(EpicLibrary.toCacheJson(listOf(fresh)))) + assertEquals("https://e/logo.png", EpicLibrary.toCatalogItem(app, fresh).logoUrl) + val plain = EpicGame("Old", "ns", "c", "Old") + assertFalse(JSONArray(EpicLibrary.toCacheJson(listOf(plain))).getJSONObject(0).has("artLogo")) + assertEquals(null, EpicLibrary.toCatalogItem(app, plain).logoUrl) + } + @Test fun signOutForgetsOnlyTheLibrary() { EpicPrefs.get(app).edit().putString(EpicLibrary.KEY_CACHE, "[]").putLong(EpicLibrary.KEY_SYNCED_AT, 1L) .putString("cloud_template_Fig", "{AppData}/x").commit() diff --git a/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxSignInMessagesTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxSignInMessagesTest.kt new file mode 100644 index 0000000000..7726ca42fe --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxSignInMessagesTest.kt @@ -0,0 +1,33 @@ +package com.droiddeck.launcher.stores.xbox + +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertTrue +import org.junit.Test + +@org.junit.runner.RunWith(org.robolectric.RobolectricTestRunner::class) +@org.robolectric.annotation.Config(sdk = [33], application = android.app.Application::class) +class XboxSignInMessagesTest { + @Test fun ownCheckMessagesAreShownAndOtherTextIsNot() { + assertEquals("the Xbox helper stopped with exit code 3", XboxLoginActivity.failure(IllegalStateException("the Xbox helper stopped with exit code 3"))) + assertEquals("IllegalStateException", XboxLoginActivity.failure(IllegalStateException("Check failed."))) + assertEquals("JSONException", XboxLoginActivity.failure(org.json.JSONException("token=secret-value"))) + assertEquals("IllegalArgumentException", XboxLoginActivity.failure(IllegalArgumentException("secret-value"))) + } + + @Test fun gamertagMustBeShortPrintableText() { + assertTrue(XboxGamertag.valid("Some Gamertag")) + assertFalse(XboxGamertag.valid("")) + assertFalse(XboxGamertag.valid("a\nb")) + assertFalse(XboxGamertag.valid("x".repeat(65))) + } + + @Test fun gamertagRefreshIsOncePerAccountGeneration() { + val first = "account-generation-one-${System.nanoTime()}" + val second = "account-generation-two-${System.nanoTime()}" + assertTrue(XboxGamertag.shouldTryRefresh(first)) + assertFalse(XboxGamertag.shouldTryRefresh(first)) + assertTrue(XboxGamertag.shouldTryRefresh(second)) + assertFalse(XboxGamertag.shouldTryRefresh(second)) + } +} diff --git a/docs/releases/0.6.0.md b/docs/releases/0.6.0.md new file mode 100644 index 0000000000..c14bda97c3 --- /dev/null +++ b/docs/releases/0.6.0.md @@ -0,0 +1,172 @@ +# DroidDeck 0.6.0 + +

Join the DroidDeck Discord

+ + + +> **DroidDeck is 100% open source. No ads. No telemetry. No source withheld.** +> +> DroidDeck is a community project in the truest sense. Because all of its code is public, the people who use it can read it, fix it and improve it, and in 0.6.0 you all sure did: +> +> **153 pull requests · 23 contributors · 10 first-timers · 73% of the pull requests came from the community.** +> +> Thank you to everyone who sent code, translations, device testing and bug reports. Here’s everything we did together for this release: + +### Features + + +The Epic library switching from cards to the capsule view, the Xbox library, an itch.io store search, then an installed game's page with its Play button. Account names are blurred + +- Added experimental **Xbox and PC Game Pass** as a store. Sign in with your Microsoft account to see your owned and Game Pass games, then download them with pause and resume, update, verify and manage add-on content. Games launch through Proton or FEX from the Games tab or straight from Steam. Search results open with their artwork and details, and Game Pass titles you have not installed yet can be installed from their page. (@xXJSONDeruloXx, @moronigranja, [#1156](https://github.com/Droid-Deck/DroidDeck/pull/1156), [#1164](https://github.com/Droid-Deck/DroidDeck/pull/1164), [#1170](https://github.com/Droid-Deck/DroidDeck/pull/1170), [#1193](https://github.com/Droid-Deck/DroidDeck/pull/1193), [#1279](https://github.com/Droid-Deck/DroidDeck/pull/1279)) +- Added an **itch.io** store. Sign in with your itch.io API key to see your library, then search the store or browse the newest, on-sale, free and top-rated shelves. DRM-free Windows builds install and launch through Steam like games from the other stores. (@kingokksa, [#1064](https://github.com/Droid-Deck/DroidDeck/pull/1064)) +- **Redesigned store pages.** Each store has **Library** and **Store** tabs, and the library lists installed games first. A new **capsule view** shows portrait DVD-case art in every store. LB and RB switch between stores, and installed games get a **Play** button on their page. You can reorder and hide store tabs in the stores settings, and stores you are not signed in to are dimmed. (@xXJSONDeruloXx, @kingokksa, [#1116](https://github.com/Droid-Deck/DroidDeck/pull/1116), [#1117](https://github.com/Droid-Deck/DroidDeck/pull/1117), [#1121](https://github.com/Droid-Deck/DroidDeck/pull/1121), [#1125](https://github.com/Droid-Deck/DroidDeck/pull/1125), [#1236](https://github.com/Droid-Deck/DroidDeck/pull/1236)) + + +Setting Touch to Gestures, going through the one-, two- and three-finger tabs and the searchable action picker, turning on Show recognized gesture, then two-finger drags moving through the Steam library and a pinch zoom, each gesture named at the top + +- Added configurable **touchscreen gestures**: taps, double taps, holds, one-, two- and three-finger drags and pinch zoom. Each one can be mapped to an action from a searchable list, with defaults and per-game overrides. (@Nightwalker743, @kingokksa, [#940](https://github.com/Droid-Deck/DroidDeck/pull/940), [#1214](https://github.com/Droid-Deck/DroidDeck/pull/1214)) +- **Steam Remote Play from DroidDeck** now streams video as well as audio and input. The picture is captured through PipeWire, as on SteamOS, and encoded by the phone's hardware encoder. On a Thor that takes 7.3–8.0 ms per frame, down from 50–90 ms with software encoding. Touch on the client can tap and drag, and games are heard on the stream. (@xXJSONDeruloXx, [#1139](https://github.com/Droid-Deck/DroidDeck/pull/1139)) + + + Remote Play encode time per frame on an AYN Thor: 50 to 90 ms with software x264, 7.3 to 8.0 ms with the hardware encoder. + + +Opening SteamDeckRepo, filtering to Steam Deck and Most liked, installing Handheld History by KnightMD and pressing Use, then starting Steam with the new boot movie. Waits are cut + +- **Boot movies from SteamDeckRepo.** Search SteamDeckRepo, filter by device and browse the Trending, Most downloaded, Most liked and Newest tabs, then install a movie and use it. Installed movies are listed with covers. Imported movies go into Steam's own movie folder, and the sound has volume and length sliders. (@FX192, [#1036](https://github.com/Droid-Deck/DroidDeck/pull/1036), [#1229](https://github.com/Droid-Deck/DroidDeck/pull/1229)) + + +In Valheim's intro, turning on the battery temperature and the frame-time graph, picking the Amber color and raising the opacity, then a close-up of the HUD over the game + +- The **performance HUD** can show a colored frame-time graph and the battery temperature. Each part can be shown or hidden, and its colors and opacity can be changed. (@0x1Nawaf, [#1256](https://github.com/Droid-Deck/DroidDeck/pull/1256)) + + +Choosing the Gradient theme, dragging the primary color around the wheel, typing a hex code for the secondary color, then the Games and Steam tabs in the new colors + +- Added a custom **Gradient theme**, with primary and secondary colors chosen from a color wheel, sliders or a hex code, and a **light app icon** option. (@FX192, @xXJSONDeruloXx, [#1309](https://github.com/Droid-Deck/DroidDeck/pull/1309), [#1104](https://github.com/Droid-Deck/DroidDeck/pull/1104)) +- **SteamVR controller types.** Without VR controllers, the gamepad can act as Valve Index controllers (the default), Meta Quest 3 Touch Plus, HTC Vive wands, or a regular gamepad. The sticks move you in the game by default, and pressing both sticks switches them to moving the hands. The type can be changed while SteamVR runs. With glasses, the phone becomes a control panel with Recenter, the SteamVR menu, the keyboard, brightness and battery. Flat games started from VR open as a SteamVR panel. (@xXJSONDeruloXx, [#1268](https://github.com/Droid-Deck/DroidDeck/pull/1268)) +- Added **Rokid Max and Air** glasses, with 3DoF head tracking, SBS modes, 120 Hz on the Max and brightness control, and experimental head tracking for **VITURE Pro 2** without the vendor SDK. (@xXJSONDeruloXx, @informalTechCode, @kingokksa, [#1266](https://github.com/Droid-Deck/DroidDeck/pull/1266), [#1115](https://github.com/Droid-Deck/DroidDeck/pull/1115)) +- **Easy Anti-Cheat games with an offline mode** start without the anti-cheat bootstrapper. This is on by default and can be turned off per game. Online modes that need Easy Anti-Cheat stay unavailable. (@xXJSONDeruloXx, [#1039](https://github.com/Droid-Deck/DroidDeck/pull/1039)) +- The **built-in controller can be turned off** (Steam settings > Controller > None), so a connected controller becomes player 1 for games that only read the first pad. (@kingokksa, [#1207](https://github.com/Droid-Deck/DroidDeck/pull/1207), [#1304](https://github.com/Droid-Deck/DroidDeck/pull/1304)) +- On foldables, the **unfolded controls can stay while a controller is connected**, for players who use a telescopic controller and still want the trackpads and back buttons. (@ovurrsl, [#996](https://github.com/Droid-Deck/DroidDeck/pull/996)) +- The component manager offers **nightly DXVK, VKD3D-Proton and FEX builds** from DroidDeck-Components, with a **Stable | Nightly** switch on each row. (@The412Banner, [#1284](https://github.com/Droid-Deck/DroidDeck/pull/1284)) +- When a game started from the Games tab closes, DroidDeck **returns you to where you launched it** instead of leaving you in Big Picture. (@The412Banner, [#395](https://github.com/Droid-Deck/DroidDeck/pull/395)) +- **Decky Loader** installs from the upstream SteamDeckHomebrew release, has a Stable or Prerelease update channel, and shows Decky's own third-party warning before a plugin ZIP is installed. (@xXJSONDeruloXx, [#1090](https://github.com/Droid-Deck/DroidDeck/pull/1090), [#1263](https://github.com/Droid-Deck/DroidDeck/pull/1263), [#1264](https://github.com/Droid-Deck/DroidDeck/pull/1264)) +- **Desktop mode can be uninstalled** from beside Open desktop, including a desktop install that was interrupted. Games, Steam, added apps and settings are kept. (@xXJSONDeruloXx, [#1311](https://github.com/Droid-Deck/DroidDeck/pull/1311)) +- **GOG and Epic installs can use your language.** The install dialog has a **Game language** choice, which follows the app's language by default, and the stores settings can pin a default. GOG games no longer download only their English files. (@LooLL, [#1199](https://github.com/Droid-Deck/DroidDeck/pull/1199)) +- Games can be **uninstalled or removed from their page in the Games tab**. Store games use their store's uninstaller. Steam games delete their install but keep their saves and Proton prefix. Added games only lose their shortcut, so their files stay. (@kingokksa, [#1190](https://github.com/Droid-Deck/DroidDeck/pull/1190)) + +### Improvements + +- **Performance** + - **Faster games and session starts on Adreno.** Games now use Turnip's tile rendering while the Steam interface keeps system memory. In PEAK on an Adreno 840 tablet, the frame rate rose 11.7% and frames slower than 25 ms dropped by 26%. Steam is ready 35.9% sooner after a session starts (5.57 s to 3.57 s). (@maxjivi05, [#1188](https://github.com/Droid-Deck/DroidDeck/pull/1188)) + + + PEAK on an Adreno 840 tablet: 46.8 fps before and 52.3 fps in 0.6.0 (+11.7%). Frames shown for longer than 25 ms fall from 12.90% to 9.53%. Steam is ready 5.57 s after session start before and 3.57 s in 0.6.0 (-35.9%). + - **Faster game launches.** Steam's install-script step is skipped once it has finished for a game. In testing, Moonlighter went from 10.5 s to 7.7 s from Play to the game window. FEX's file lookups skip proot, so Graveyard Keeper reaches its first scene 0.57 s sooner with 48% fewer proot stops. (@maxjivi05, [#1273](https://github.com/Droid-Deck/DroidDeck/pull/1273), [#1283](https://github.com/Droid-Deck/DroidDeck/pull/1283)) + - **Games on an SD card library load far faster.** proot's fast path now names files and follows links inside a library the same way proot does, instead of handing every lookup back to proot. In testing, Red Dead Redemption 2's Story mode went from still loading after 16 minutes to the opening scene in about 2 minutes 10 seconds. (@maxjivi05, [#1331](https://github.com/Droid-Deck/DroidDeck/pull/1331)) + - **Less overhead from the performance overlay.** gamescope's CPU use dropped from about 12.9% to 7.7% of a core with the overlay hidden, and a 60 fps game on a 120 Hz panel no longer gets extra composites while the overlay is shown. Wine's network queries also cost less. (@maxjivi05, [#1272](https://github.com/Droid-Deck/DroidDeck/pull/1272), [#1274](https://github.com/Droid-Deck/DroidDeck/pull/1274), [#1275](https://github.com/Droid-Deck/DroidDeck/pull/1275)) + + + Moonlighter from Play to game window: 10.5 s before, 7.7 s in 0.6.0. Graveyard Keeper to its first scene: 9.70 s before, 9.13 s in 0.6.0. Red Dead Redemption 2 Story mode from an SD card library: still loading after 16 minutes before (a lower bound), about 2 minutes 10 seconds in 0.6.0. gamescope CPU with Moonlighter at 120 fps: 12.85% of a core before and 7.65% in 0.6.0 with the overlay hidden, 19.05% and 10.35% with it visible. + - The **Steam client responds sooner**: it paces itself to the panel's real refresh rate, and its interface sounds no longer queue about 112 ms of audio. The DirectAudio sink is now built from @The412Banner's [DirectAudio](https://github.com/The412Banner/directaudio) source. (@maxjivi05, [#1094](https://github.com/Droid-Deck/DroidDeck/pull/1094)) + + + Steam client on a REDMAGIC Astra: per-run median press-to-response 41.0 to 41.2 ms before and 28.5 to 33.0 ms in 0.6.0. The interface frame interval falls from 10.8 ms (about 92 fps) to 8.3 ms (120 fps), and the interface sound queue from 105 to 120 ms to 28 to 45 ms. + - The **GOG tab opens in seconds**, because the whole library comes from one listing instead of a request per game. (@kingokksa, [#786](https://github.com/Droid-Deck/DroidDeck/pull/786)) +- **Reduced the APK size** from 124.4 MB to 66.4 MB. (@xXJSONDeruloXx, [#1198](https://github.com/Droid-Deck/DroidDeck/pull/1198), [#1204](https://github.com/Droid-Deck/DroidDeck/pull/1204), [#1265](https://github.com/Droid-Deck/DroidDeck/pull/1265)) +- **Better battery life while a session is suspended.** The device can now really sleep: every guest thread stops and the audio stream is stopped. Before, a Thor did not suspend once in 13 minutes. Steam downloads keep running with the Manual policy, including downloads to SD-card libraries, and a switched-off Steam Controller no longer wakes Bluetooth all night. (@xXJSONDeruloXx, @Detinator10, [#1220](https://github.com/Droid-Deck/DroidDeck/pull/1220), [#1262](https://github.com/Droid-Deck/DroidDeck/pull/1262), [#1312](https://github.com/Droid-Deck/DroidDeck/pull/1312)) +- **zRAM is always on** where supported, and a session is paged out to zRAM before it is suspended, so Android is less likely to close it overnight. In testing, Bulletstorm's resident memory went from 1,886 MB to 318 MB while suspended, with the rest moved to zRAM. The zRAM setting has been removed. (@xXJSONDeruloXx, [#1317](https://github.com/Droid-Deck/DroidDeck/pull/1317)) + + + On an AYN Thor, guest threads still running while suspended: Steam 59 of 72 and gamescope 8 of 15 before, none in 0.6.0. Bulletstorm's resident memory while suspended falls from 1,886 MB to 318 MB, with 1,570 MB moved to zRAM. +- Sessions on an **external display or DeX** keep running while the phone's screen is off. (@maxjivi05, @xXJSONDeruloXx, [#1211](https://github.com/Droid-Deck/DroidDeck/pull/1211), [#1320](https://github.com/Droid-Deck/DroidDeck/pull/1320)) +- **Game cores** now apply to games started with **Linux x86 (FEX)** too. (@coffeemeist3r, [#1294](https://github.com/Droid-Deck/DroidDeck/pull/1294)) +- **GPU drivers:** Auto's picks come from a manifest in Drivers-CI, so a default can change without an app update. The Snapdragon SM8975 is recognized and Adreno 850 support is marked experimental. A trial driver that crashes at startup now rolls back automatically. (@xXJSONDeruloXx, @Danbro007, @ovurrsl, [#977](https://github.com/Droid-Deck/DroidDeck/pull/977), [#1249](https://github.com/Droid-Deck/DroidDeck/pull/1249), [#1031](https://github.com/Droid-Deck/DroidDeck/pull/1031)) +- The KDE desktop is updated to **KWin 6.8.0**. (@xXJSONDeruloXx, [#1328](https://github.com/Droid-Deck/DroidDeck/pull/1328), [#1330](https://github.com/Droid-Deck/DroidDeck/pull/1330)) +- New sessions default to **landscape**, and the Deck controls open on **both trackpads**. (@xXJSONDeruloXx, [#1287](https://github.com/Droid-Deck/DroidDeck/pull/1287), [#1295](https://github.com/Droid-Deck/DroidDeck/pull/1295)) +- **Accessibility:** buttons, tiles and list rows are announced as buttons by screen readers, the Electric theme's buttons meet WCAG contrast, and section headings are capitalized correctly in the app's language. (@ovurrsl, [#891](https://github.com/Droid-Deck/DroidDeck/pull/891), [#1149](https://github.com/Droid-Deck/DroidDeck/pull/1149), [#1145](https://github.com/Droid-Deck/DroidDeck/pull/1145), [#1148](https://github.com/Droid-Deck/DroidDeck/pull/1148)) +- **Translations:** Turkish covers every new screen, every language has the plural forms it needs, and English left in the translations is translated. New features in this release ship in all 32 languages. The KDE desktop's translations are now built as per-language packs, ready for a translated desktop. (@ovurrsl, @maxjivi05, @kingokksa, [#989](https://github.com/Droid-Deck/DroidDeck/pull/989), [#1102](https://github.com/Droid-Deck/DroidDeck/pull/1102), [#942](https://github.com/Droid-Deck/DroidDeck/pull/942)) +- **Building and testing DroidDeck yourself** is easier: local builds find Java 17 installed with mise, reuse add-on packs a CI build installed, and `tools/device-smoke.sh` checks a build on a real device over plain adb. Session logs time each setup step to the millisecond. (@ugreg, @xXJSONDeruloXx, @ovurrsl, @maxjivi05, [#1231](https://github.com/Droid-Deck/DroidDeck/pull/1231), [#1265](https://github.com/Droid-Deck/DroidDeck/pull/1265), [#911](https://github.com/Droid-Deck/DroidDeck/pull/911), [#993](https://github.com/Droid-Deck/DroidDeck/pull/993), [#1091](https://github.com/Droid-Deck/DroidDeck/pull/1091), [#1151](https://github.com/Droid-Deck/DroidDeck/pull/1151)) + +### Fixed + +- Fixed **Ubisoft games** stopping with "Error at hooking API" (for example Immortals Fenyx Rising), and other programs that patch their own code under FEX. (@maxjivi05, [#1163](https://github.com/Droid-Deck/DroidDeck/pull/1163)) +- Fixed **Steam going back to sleep** right after a long-paused session resumed. (@maxjivi05, [#1162](https://github.com/Droid-Deck/DroidDeck/pull/1162)) +- Fixed **controllers in Rewired (Unity) games** such as Drova and Graveyard Keeper, and in **Factorio**'s ARM64 build. (@Delete228, @maxjivi05, [#1195](https://github.com/Droid-Deck/DroidDeck/pull/1195), [#1222](https://github.com/Droid-Deck/DroidDeck/pull/1222), [#1227](https://github.com/Droid-Deck/DroidDeck/pull/1227)) +- Fixed **Linux games under FEX**: games such as Stardew Valley start again, have sound, find OpenSSL 3 and reach FEXServer. CJK text shows in x86 apps such as the Epic Games Launcher, and clearing a game's compatibility tool in Steam keeps its Linux build. x86 Proton runs in the Steam runtime it requires. (@maxjivi05, @xXJSONDeruloXx, [#1100](https://github.com/Droid-Deck/DroidDeck/pull/1100), [#1166](https://github.com/Droid-Deck/DroidDeck/pull/1166), [#1167](https://github.com/Droid-Deck/DroidDeck/pull/1167), [#1213](https://github.com/Droid-Deck/DroidDeck/pull/1213), [#1168](https://github.com/Droid-Deck/DroidDeck/pull/1168), [#1250](https://github.com/Droid-Deck/DroidDeck/pull/1250), [#1034](https://github.com/Droid-Deck/DroidDeck/pull/1034)) +- Fixed the **x86-64 Steam client** staying on a blank screen, asking for the password again and listing games twice. (@maxjivi05, [#1096](https://github.com/Droid-Deck/DroidDeck/pull/1096)) +- Fixed **garbled Chinese, Japanese and Korean text** in Steam's interface. (@zooluis, @xXJSONDeruloXx, [#1319](https://github.com/Droid-Deck/DroidDeck/pull/1319)) +- Fixed **flicker and green flashes on Samsung One UI devices with a Snapdragon 8 Gen 2** (Galaxy S23 series, Tab S9). (@xXJSONDeruloXx, [#1128](https://github.com/Droid-Deck/DroidDeck/pull/1128)) +- Fixed the **GPU load reading 0%** in the performance overlay on Adreno phones. (@angelrenefm, @xXJSONDeruloXx, [#1326](https://github.com/Droid-Deck/DroidDeck/pull/1326), [#1327](https://github.com/Droid-Deck/DroidDeck/pull/1327)) +- Fixed gamescope running out of file handles in long sessions with lots of touch input. (@asdf17128, [#1189](https://github.com/Droid-Deck/DroidDeck/pull/1189)) +- Fixed **GOG games missing their registry entries**, such as Fallout: New Vegas saying it is not installed, and the "already installed" markers of Windows redistributables never reaching the user registry. (@maxjivi05, @kaosjammo, [#1159](https://github.com/Droid-Deck/DroidDeck/pull/1159), [#1286](https://github.com/Droid-Deck/DroidDeck/pull/1286)) +- Fixed a store game's **first launch missing its cloud saves**, and manual cloud-save Upload and Download reporting success when nothing was synced. (@maxjivi05, @ovurrsl, [#1215](https://github.com/Droid-Deck/DroidDeck/pull/1215), [#1068](https://github.com/Droid-Deck/DroidDeck/pull/1068)) +- Fixed the **on-screen pad covering Steam's keyboard** and DroidDeck's PC keyboard. (@maxjivi05, @ovurrsl, [#1217](https://github.com/Droid-Deck/DroidDeck/pull/1217), [#956](https://github.com/Droid-Deck/DroidDeck/pull/956), [#1221](https://github.com/Droid-Deck/DroidDeck/pull/1221)) +- Fixed **Steam touch layouts**: third-party and added games load their own layout, layouts of non-Steam shortcuts such as the Epic Games Launcher can be edited and saved, and held controls stay pressed across action-set and layer changes. Labels with quotes no longer break the config. (@kingokksa, @maxjivi05, @ovurrsl, [#1058](https://github.com/Droid-Deck/DroidDeck/pull/1058), [#1171](https://github.com/Droid-Deck/DroidDeck/pull/1171), [#1143](https://github.com/Droid-Deck/DroidDeck/pull/1143), [#1017](https://github.com/Droid-Deck/DroidDeck/pull/1017)) +- Fixed touch input: long-press right-click in Direct touch, the saved touch mode coming back when Steam Touch is turned off, and the touchpad cursor jumping after a two-finger scroll. (@xXJSONDeruloXx, @ovurrsl, [#677](https://github.com/Droid-Deck/DroidDeck/pull/677), [#1142](https://github.com/Droid-Deck/DroidDeck/pull/1142)) +- Fixed controller input: moving a stick no longer releases a held D-pad direction or trigger, Xiaomi HyperOS's virtual input device no longer takes player 1, and back-to-back reports to a Bluetooth Steam Controller are no longer dropped. (@ovurrsl, [#1060](https://github.com/Droid-Deck/DroidDeck/pull/1060), [#954](https://github.com/Droid-Deck/DroidDeck/pull/954), [#1032](https://github.com/Droid-Deck/DroidDeck/pull/1032)) +- Fixed Steam's **"Steam Controller detected!" tour** opening at every start, and the emulated Steam Controller looking out of date to Steam. (@xXJSONDeruloXx, [#1321](https://github.com/Droid-Deck/DroidDeck/pull/1321), [#1323](https://github.com/Droid-Deck/DroidDeck/pull/1323)) +- Fixed **SteamVR starting in a normal Steam session** after a VR session had been used. (@xXJSONDeruloXx, [#1137](https://github.com/Droid-Deck/DroidDeck/pull/1137)) +- Fixed **adding games from an SD card**, both a whole games folder and a single EXE, and adding a game whose folder sits inside another added game's folder. (@The412Banner, @maxjivi05, [#1153](https://github.com/Droid-Deck/DroidDeck/pull/1153), [#1173](https://github.com/Droid-Deck/DroidDeck/pull/1173), [#1155](https://github.com/Droid-Deck/DroidDeck/pull/1155)) +- Fixed the games-folder scan hiding games such as Reach, Breach, Crashday and Observer, and Unreal Engine games being named "BootstrapPackagedGame". (@ovurrsl, @charan-rathore, [#1023](https://github.com/Droid-Deck/DroidDeck/pull/1023), [#1020](https://github.com/Droid-Deck/DroidDeck/pull/1020)) +- Added games start sooner on large Steam libraries, and game files keep the full game name. (@ovurrsl, @maxjivi05, [#994](https://github.com/Droid-Deck/DroidDeck/pull/994), [#1230](https://github.com/Droid-Deck/DroidDeck/pull/1230)) +- Fixed a game's **Components** button opening the default profile instead of the game's own. (@jmarti326, [#1146](https://github.com/Droid-Deck/DroidDeck/pull/1146)) +- Fixed **desktop apps and emulators**: RPCS3 opens from the emulator rail, RetroArch fills the screen, Chromium browsers start, browsers added as non-Steam games show their window, Flatpak apps open in the renamed app variants, user apps open at the Desktop's resolution, and programs that need an executable stack start. Apps started from the front end show their own cursor, and Steam shortcuts are kept out of the desktop's controls. (@maxjivi05, @Delete228, @xXJSONDeruloXx, [#1191](https://github.com/Droid-Deck/DroidDeck/pull/1191), [#1194](https://github.com/Droid-Deck/DroidDeck/pull/1194), [#1280](https://github.com/Droid-Deck/DroidDeck/pull/1280), [#1243](https://github.com/Droid-Deck/DroidDeck/pull/1243), [#1192](https://github.com/Droid-Deck/DroidDeck/pull/1192), [#1172](https://github.com/Droid-Deck/DroidDeck/pull/1172), [#1208](https://github.com/Droid-Deck/DroidDeck/pull/1208), [#1154](https://github.com/Droid-Deck/DroidDeck/pull/1154), [#1318](https://github.com/Droid-Deck/DroidDeck/pull/1318)) +- Fixed **store sign-in**: GOG lets you sign in with a different account, and one failing image or script no longer replaces the Epic sign-in page with an SSL error. (@maxjivi05, [#1235](https://github.com/Droid-Deck/DroidDeck/pull/1235), [#1238](https://github.com/Droid-Deck/DroidDeck/pull/1238)) +- Fixed the **file manager**: copy and move keep symbolic links, Cancel really stops a paste, a double tap no longer starts two pastes, selection follows the search filter, and a slow folder no longer replaces the one you moved to. (@ovurrsl, [#1027](https://github.com/Droid-Deck/DroidDeck/pull/1027), [#1029](https://github.com/Droid-Deck/DroidDeck/pull/1029), [#1025](https://github.com/Droid-Deck/DroidDeck/pull/1025), [#1021](https://github.com/Droid-Deck/DroidDeck/pull/1021), [#1028](https://github.com/Droid-Deck/DroidDeck/pull/1028)) +- Fixed an interrupted desktop or package install breaking the Linux runtime, which used to need an app reinstall. (@xXJSONDeruloXx, [#1078](https://github.com/Droid-Deck/DroidDeck/pull/1078)) +- A failed Steam client download now says your network or VPN may be blocking Steam and offers Retry, instead of silently ending the session. (@ovurrsl, [#997](https://github.com/Droid-Deck/DroidDeck/pull/997)) +- Fixed **in-app updates on Android 9 and 10**. (@ovurrsl, [#1066](https://github.com/Droid-Deck/DroidDeck/pull/1066)) +- Fixed crashes with a full disk while fetching cover art and with an empty App ID in the game environment editor. (@ovurrsl, [#1030](https://github.com/Droid-Deck/DroidDeck/pull/1030), [#1014](https://github.com/Droid-Deck/DroidDeck/pull/1014)) +- Fixed DirectAudio setup changing a game's audio choice during Steam's path queries and install scripts. (@xXJSONDeruloXx, [#1044](https://github.com/Droid-Deck/DroidDeck/pull/1044), [#1046](https://github.com/Droid-Deck/DroidDeck/pull/1046)) +- Hidden and private Steam games no longer show on the Steam home art wall. (@xXJSONDeruloXx, [#1097](https://github.com/Droid-Deck/DroidDeck/pull/1097)) +- Storage asks before bulk-removing unused components, and store search no longer reopens the keyboard when you scroll back up. (@ovurrsl, [#1140](https://github.com/Droid-Deck/DroidDeck/pull/1140), [#1141](https://github.com/Droid-Deck/DroidDeck/pull/1141)) +- Moving a mouse no longer redraws the whole session overlay. (@maxjivi05, [#1253](https://github.com/Droid-Deck/DroidDeck/pull/1253)) + +### Community + +DroidDeck is built in the open by the people who use it. These are everyone whose code is in 0.6.0: + +| Contributor | Pull requests | +|---|---| +| @xXJSONDeruloXx | 48: Xbox and Game Pass, store redesign, Remote Play, add-on packs, SteamVR controller types, Rokid glasses, suspend and zRAM, Decky, KWin 6.8 and more | +| @maxjivi05 | 41: performance, FEX and Linux games, Steam client, Ubisoft and GOG fixes, Rewired pads, desktop apps and emulators | +| @ovurrsl | 33: file manager, controller and touch fixes, security, accessibility, Turkish, cloud saves, device smoke tests | +| @kingokksa | 10: itch.io store, uninstall from Games, store tab order, controller off, GOG speed-up, Steam touch layouts | +| @The412Banner | 3: return to launcher, SD-card games folders, nightly components (and the DirectAudio sink) | +| @FX192 | 3: SteamDeckRepo boot movies, Gradient theme | +| @Nightwalker743 | [#940](https://github.com/Droid-Deck/DroidDeck/pull/940): touchscreen gestures | +| @0x1Nawaf | [#1256](https://github.com/Droid-Deck/DroidDeck/pull/1256): performance HUD graph and options | +| @LooLL | [#1199](https://github.com/Droid-Deck/DroidDeck/pull/1199): game language for GOG and Epic | +| @moronigranja | [#1279](https://github.com/Droid-Deck/DroidDeck/pull/1279): Xbox search results and Game Pass installs | +| @informalTechCode | [#1115](https://github.com/Droid-Deck/DroidDeck/pull/1115): VITURE Pro 2 head tracking | +| @Delete228 | [#1195](https://github.com/Droid-Deck/DroidDeck/pull/1195), [#1318](https://github.com/Droid-Deck/DroidDeck/pull/1318): Factorio controller input, second-screen controls in the desktop | +| @Danbro007 | [#1249](https://github.com/Droid-Deck/DroidDeck/pull/1249): SM8975 and Adreno 850 detection | +| @coffeemeist3r | [#1294](https://github.com/Droid-Deck/DroidDeck/pull/1294): Game cores for FEX games | +| @angelrenefm | [#1326](https://github.com/Droid-Deck/DroidDeck/pull/1326): GPU load in the overlay | +| @asdf17128 | [#1189](https://github.com/Droid-Deck/DroidDeck/pull/1189): gamescope cursor buffer leak | +| @kaosjammo | [#1286](https://github.com/Droid-Deck/DroidDeck/pull/1286): Windows redistributable registry markers | +| @jmarti326 | [#1146](https://github.com/Droid-Deck/DroidDeck/pull/1146): Components opens the game's profile | +| @charan-rathore | [#1020](https://github.com/Droid-Deck/DroidDeck/pull/1020): Unreal Engine game names | +| @wallentx | [#1063](https://github.com/Droid-Deck/DroidDeck/pull/1063): readable library names in logs | +| @ugreg | [#1231](https://github.com/Droid-Deck/DroidDeck/pull/1231): Java 17 through mise for local builds | +| @zooluis | [#1319](https://github.com/Droid-Deck/DroidDeck/pull/1319): CJK fonts in Steam | +| @Detinator10 | [#1220](https://github.com/Droid-Deck/DroidDeck/pull/1220): full session freeze for sleep | + + + +### New contributors + +- @Nightwalker743 made their first contribution in [#940](https://github.com/Droid-Deck/DroidDeck/pull/940). +- @charan-rathore made their first contribution in [#1020](https://github.com/Droid-Deck/DroidDeck/pull/1020). +- @Delete228 made their first contribution in [#1195](https://github.com/Droid-Deck/DroidDeck/pull/1195). +- @LooLL made their first contribution in [#1199](https://github.com/Droid-Deck/DroidDeck/pull/1199). +- @Detinator10 made their first contribution in [#1220](https://github.com/Droid-Deck/DroidDeck/pull/1220). +- @ugreg made their first contribution in [#1231](https://github.com/Droid-Deck/DroidDeck/pull/1231). +- @Danbro007 made their first contribution in [#1249](https://github.com/Droid-Deck/DroidDeck/pull/1249). +- @moronigranja made their first contribution in [#1279](https://github.com/Droid-Deck/DroidDeck/pull/1279). +- @coffeemeist3r made their first contribution in [#1294](https://github.com/Droid-Deck/DroidDeck/pull/1294). +- @zooluis made their first contribution in [#1319](https://github.com/Droid-Deck/DroidDeck/pull/1319). + +[Full changelog](https://github.com/Droid-Deck/DroidDeck/compare/0.5.0...0.6.0) diff --git a/docs/releases/media/0.6.0/adreno-peak-and-steam-start.png b/docs/releases/media/0.6.0/adreno-peak-and-steam-start.png new file mode 100644 index 0000000000..89de2c6ee2 Binary files /dev/null and b/docs/releases/media/0.6.0/adreno-peak-and-steam-start.png differ diff --git a/docs/releases/media/0.6.0/boot-movies.gif b/docs/releases/media/0.6.0/boot-movies.gif new file mode 100644 index 0000000000..da773d55be Binary files /dev/null and b/docs/releases/media/0.6.0/boot-movies.gif differ diff --git a/docs/releases/media/0.6.0/gradient-theme.gif b/docs/releases/media/0.6.0/gradient-theme.gif new file mode 100644 index 0000000000..5d0f975522 Binary files /dev/null and b/docs/releases/media/0.6.0/gradient-theme.gif differ diff --git a/docs/releases/media/0.6.0/performance-hud.gif b/docs/releases/media/0.6.0/performance-hud.gif new file mode 100644 index 0000000000..0ee90601cf Binary files /dev/null and b/docs/releases/media/0.6.0/performance-hud.gif differ diff --git a/docs/releases/media/0.6.0/remote-play-encode.png b/docs/releases/media/0.6.0/remote-play-encode.png new file mode 100644 index 0000000000..8088bbf2e7 Binary files /dev/null and b/docs/releases/media/0.6.0/remote-play-encode.png differ diff --git a/docs/releases/media/0.6.0/speed-launch-load-overlay.png b/docs/releases/media/0.6.0/speed-launch-load-overlay.png new file mode 100644 index 0000000000..9936c139e1 Binary files /dev/null and b/docs/releases/media/0.6.0/speed-launch-load-overlay.png differ diff --git a/docs/releases/media/0.6.0/steam-client-responsiveness.png b/docs/releases/media/0.6.0/steam-client-responsiveness.png new file mode 100644 index 0000000000..a31314d2f4 Binary files /dev/null and b/docs/releases/media/0.6.0/steam-client-responsiveness.png differ diff --git a/docs/releases/media/0.6.0/stores-capsules.gif b/docs/releases/media/0.6.0/stores-capsules.gif new file mode 100644 index 0000000000..4c5726b2d6 Binary files /dev/null and b/docs/releases/media/0.6.0/stores-capsules.gif differ diff --git a/docs/releases/media/0.6.0/suspend-sleep-and-memory.png b/docs/releases/media/0.6.0/suspend-sleep-and-memory.png new file mode 100644 index 0000000000..b1d42ea092 Binary files /dev/null and b/docs/releases/media/0.6.0/suspend-sleep-and-memory.png differ diff --git a/docs/releases/media/0.6.0/touch-gestures.gif b/docs/releases/media/0.6.0/touch-gestures.gif new file mode 100644 index 0000000000..dedfce85f9 Binary files /dev/null and b/docs/releases/media/0.6.0/touch-gestures.gif differ diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-pipewire b/tools/linuxfs/overlay/usr/local/bin/droiddeck-pipewire index 11ed41fb23..2677599bf0 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-pipewire +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-pipewire @@ -21,6 +21,30 @@ unpack() { { rm -rf "$dir.new"; echo "droiddeck-pipewire: could not unpack $bundle" >&2; return 1; } } +access_config() { + mkdir -p "$dir/share/pipewire/pipewire.conf.d" "$dir/share/wireplumber/wireplumber.conf.d" || return 1 + cat > "$dir/share/pipewire/pipewire.conf.d/droiddeck-access.conf" <<'EOF' || return 1 +context.properties = { + module.access = false +} +context.modules = [ + { name = libpipewire-module-access + args = { + access.socket = { pipewire-0 = "unrestricted", pipewire-0-manager = "unrestricted" } + } + } +] +EOF + cat > "$dir/share/wireplumber/wireplumber.conf.d/droiddeck-access.conf" <<'EOF' || return 1 +access.rules = [ + { + matches = [ { pipewire.access = "unrestricted" } ] + actions = { update-props = { default_permissions = "all" } } + } +] +EOF +} + stop() { for pid in $(cat "$state/pids" 2>/dev/null); do kill "$pid" 2>/dev/null; done rm -f "$state/pids" @@ -32,6 +56,7 @@ env) ;; start) unpack || exit 1 + access_config || { echo "droiddeck-pipewire: could not write the access settings" >&2; exit 1; } stop mkdir -p "$state" eval "$(client_env)" diff --git a/tools/linuxfs/preload/netif.c b/tools/linuxfs/preload/netif.c index 91ce93a067..1782d0f0d1 100644 --- a/tools/linuxfs/preload/netif.c +++ b/tools/linuxfs/preload/netif.c @@ -409,6 +409,8 @@ int bl_drm_gem_close(int fd, unsigned long request, void *arg, int *rc) __attrib int bl_venc_ioctl(int fd, unsigned long request, void *arg, int *rc) __attribute__((visibility("hidden"))); int bl_winebus_rumble_ioctl(int (*real)(int, unsigned long, void *), int fd, unsigned long request, void *arg, void *caller, int *rc) __attribute__((visibility("hidden"))); +int bl_writewatch_ioctl(int (*real)(int, unsigned long, void *), int fd, unsigned long request, void *arg, + int *rc) __attribute__((visibility("hidden"))); int ioctl(int fd, unsigned long request, ...) { typedef int (*ioctl_fn)(int, unsigned long, void *); @@ -424,6 +426,7 @@ int ioctl(int fd, unsigned long request, ...) { if (bl_drm_gem_close(fd, request, arg, &rc)) return rc; if (real == NULL) real = (ioctl_fn) dlsym(RTLD_NEXT, "ioctl"); if (bl_winebus_rumble_ioctl(real, fd, request, arg, __builtin_return_address(0), &rc)) return rc; + if (bl_writewatch_ioctl(real, fd, request, arg, &rc)) return rc; if (!bl_kgsl_poll(real, fd, request, arg, &rc)) rc = quest_kgsl_ioctl(real, fd, request, arg); bl_kgsl_chip_id_fixup(request, arg, rc); if (arg == NULL || !is_link_query(request)) return rc; diff --git a/tools/linuxfs/preload/robust.c b/tools/linuxfs/preload/robust.c index 81bf5d8cc2..e156e82c54 100644 --- a/tools/linuxfs/preload/robust.c +++ b/tools/linuxfs/preload/robust.c @@ -329,6 +329,8 @@ static int execveat_is_execve(const long *args) { return path[0] == '/' || (int)args[0] == AT_FDCWD; } +int bl_writewatch_syscall(long number, const long *args, long (*real)(long, ...), long *rc) __attribute__((visibility("hidden"))); + long syscall(long number, ...) { va_list ap; long args[6]; @@ -354,6 +356,9 @@ long syscall(long number, ...) { if (!real_syscall) { real_syscall = (long (*)(long, ...)) dlsym(RTLD_NEXT, "syscall"); } + if (bl_writewatch_syscall(number, args, real_syscall, &handled)) { + return handled; + } if (number == SYS_openat2) { if (!__atomic_load_n(&openat2_missing, __ATOMIC_RELAXED)) { long fd = real_syscall(number, args[0], args[1], args[2], args[3]); diff --git a/tools/linuxfs/preload/writewatch.c b/tools/linuxfs/preload/writewatch.c new file mode 100644 index 0000000000..b804e3f39c --- /dev/null +++ b/tools/linuxfs/preload/writewatch.c @@ -0,0 +1,113 @@ +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include + +#define WINE_ARM64_USERFAULTFD 374 +#define PM_UFFD_WP (1ULL << 57) +#define PM_SWAP (1ULL << 62) +#define PM_PRESENT (1ULL << 63) + +#if defined(PAGEMAP_SCAN) && defined(UFFD_USER_MODE_ONLY) +static int ww_uffd = -1; +static int scan_blocked; +#endif + +__attribute__((visibility("hidden"))) int bl_writewatch_syscall(long number, const long *args, long (*real)(long, ...), long *rc) { +#if defined(__aarch64__) && defined(PAGEMAP_SCAN) && defined(UFFD_USER_MODE_ONLY) + if (number != WINE_ARM64_USERFAULTFD || (args[0] & ~(long)(O_CLOEXEC | O_NONBLOCK | UFFD_USER_MODE_ONLY))) return 0; + *rc = real(SYS_userfaultfd, args[0]); + if (*rc >= 0) __atomic_store_n(&ww_uffd, (int)*rc, __ATOMIC_RELEASE); + return 1; +#else + (void)number; + (void)args; + (void)real; + (void)rc; + return 0; +#endif +} + +#if defined(PAGEMAP_SCAN) && defined(UFFD_USER_MODE_ONLY) +static int protect(int uffd, uint64_t start, uint64_t end) { + if (start == end) return 0; + struct uffdio_writeprotect wp = { .range = { start, end - start }, .mode = UFFDIO_WRITEPROTECT_MODE_WP }; + return ioctl(uffd, UFFDIO_WRITEPROTECT, &wp); +} + +static long emulate_scan(int fd, int uffd, struct pm_scan_arg *a) { + uint64_t page = (uint64_t)getpagesize(); + if (a->size < sizeof(*a) || (a->flags & ~(uint64_t)PM_SCAN_WP_MATCHING) || a->category_inverted || a->category_anyof_mask + || a->category_mask != PAGE_IS_WRITTEN || (a->return_mask & ~(uint64_t)PAGE_IS_WRITTEN) || a->end < a->start + || ((a->start | a->end) & (page - 1)) || (a->vec_len && !a->vec)) { + errno = EINVAL; + return -1; + } + struct page_region *vec = (struct page_region *)(uintptr_t)a->vec; + uint64_t regions = 0, pages = 0, addr = a->start, wp_start = 0, wp_end = 0; + uint64_t entries[512]; + int wp = (a->flags & PM_SCAN_WP_MATCHING) != 0; + while (addr < a->end) { + uint64_t want = (a->end - addr) / page; + if (want > 512) want = 512; + ssize_t got = pread(fd, entries, want * sizeof(entries[0]), (off_t)(addr / page * sizeof(entries[0]))); + if (got < 0) return -1; + if (got == 0) break; + for (uint64_t i = 0; i < (uint64_t)got / sizeof(entries[0]); i++, addr += page) { + uint64_t e = entries[i]; + if (!(e & (PM_PRESENT | PM_SWAP)) || (e & PM_UFFD_WP)) continue; + if (a->max_pages && pages >= a->max_pages) goto done; + if (a->vec_len) { + if (regions && vec[regions - 1].end == addr) { + vec[regions - 1].end += page; + } else { + if (regions == a->vec_len) goto done; + vec[regions].start = addr; + vec[regions].end = addr + page; + vec[regions].categories = PAGE_IS_WRITTEN & a->return_mask; + regions++; + } + } + pages++; + if (!wp) continue; + if (wp_end != addr) { + if (protect(uffd, wp_start, wp_end) < 0) return -1; + wp_start = addr; + } + wp_end = addr + page; + } + } +done: + if (wp && protect(uffd, wp_start, wp_end) < 0) return -1; + a->walk_end = addr < a->end ? addr : a->end; + return (long)regions; +} +#endif + +__attribute__((visibility("hidden"))) int bl_writewatch_ioctl(int (*real)(int, unsigned long, void *), int fd, unsigned long request, + void *arg, int *rc) { +#if defined(PAGEMAP_SCAN) && defined(UFFD_USER_MODE_ONLY) + if (request != PAGEMAP_SCAN) return 0; + int uffd = __atomic_load_n(&ww_uffd, __ATOMIC_ACQUIRE); + if (uffd < 0) return 0; + if (!__atomic_load_n(&scan_blocked, __ATOMIC_RELAXED)) { + *rc = real(fd, request, arg); + if (*rc >= 0 || errno != EACCES) return 1; + __atomic_store_n(&scan_blocked, 1, __ATOMIC_RELAXED); + } + *rc = (int)emulate_scan(fd, uffd, (struct pm_scan_arg *)arg); + return 1; +#else + (void)real; + (void)fd; + (void)request; + (void)arg; + (void)rc; + return 0; +#endif +} diff --git a/tools/proot/fastpath/fastpath.c b/tools/proot/fastpath/fastpath.c index 5056ec41ea..811b0057c8 100644 --- a/tools/proot/fastpath/fastpath.c +++ b/tools/proot/fastpath/fastpath.c @@ -337,34 +337,73 @@ static int to_guest(const char *h, char *g, size_t size) { return 0; } -static int guest_text(const char *h, char *g) { - int in = h[0] == '/' && under(h, root, rootlen); - for (int i = 0; h[0] == '/' && !in && i < nbinds; i++) { - int live = held(&binds[i]); - if (live < 0) return -1; - in = live && under(h, binds[i].host, binds[i].hlen); +static int host_order[MAX_BINDS + 1], norder, ordered; + +static int contains(const char *a, const char *b) { + size_t la = strlen(a); + return strlen(b) > la && under(b, a, la); +} + +static const char *side_of(int i, int host) { + return host ? (i < 0 ? root : binds[i].host) : (i < 0 ? "/" : binds[i].guest); +} + +static int insort(int *list, int m, int i, int host) { + const char *p = side_of(i, host); + int prev = -1; + for (int j = 0; j < m; j++) { + const char *q = side_of(list[j], host); + if (!strcmp(p, q) && !host) { + list[j] = i; + return m; + } + if (!strcmp(p, q) || contains(p, q)) prev = j; } - if (in) return to_guest(h, g, PATH_MAX); - memcpy(g, h, strlen(h) + 1); + memmove(list + prev + 2, list + prev + 1, (m - prev - 1) * sizeof *list); + list[prev + 1] = i; + return m + 1; +} + +static int order_binds(void) { + if (__atomic_load_n(&ordered, __ATOMIC_ACQUIRE)) return 0; + for (int i = 0; i < nbinds; i++) + if (held(&binds[i]) < 0) return -1; + if (pthread_mutex_trylock(&bind_lock) != 0) return -1; + if (!ordered) { + int pending[MAX_BINDS + 1], m = 1; + pending[0] = -1; + for (int i = 0; i < nbinds; i++) + if (!binds[i].dropped) m = insort(pending, m, i, 0); + norder = 0; + for (int j = m - 1; j >= 0; j--) norder = insort(host_order, norder, pending[j], 1); + __atomic_store_n(&ordered, 1, __ATOMIC_RELEASE); + } + pthread_mutex_unlock(&bind_lock); return 0; } static int host_bind(const char *h) { - int found = -1; - for (int i = 0; i < nbinds; i++) { - int live = held(&binds[i]); - if (live < 0) return -2; - if (!live || !under(h, binds[i].host, binds[i].hlen)) continue; - if (found < 0 || binds[i].hlen > binds[found].hlen) found = i; - else if (binds[i].hlen == binds[found].hlen && strcmp(binds[i].guest, binds[found].guest) != 0) found = -3; - } - return found == -3 ? -2 : found; + if (order_binds() < 0) return -2; + for (int j = 0; j < norder; j++) + if (host_order[j] >= 0 && under(h, binds[host_order[j]].host, binds[host_order[j]].hlen)) return host_order[j]; + return -1; +} + +static int guest_text(const char *h, char *g) { + if (h[0] == '/' && under(h, root, rootlen)) return to_guest(h, g, PATH_MAX); + int i = h[0] == '/' ? host_bind(h) : -1; + if (i == -2) return -1; + if (i >= 0) + return snprintf(g, PATH_MAX, "%s%s", binds[i].guest, h + binds[i].hlen) >= PATH_MAX || reserved(g) ? -1 : 0; + memcpy(g, h, strlen(h) + 1); + return 0; } static long detranslated(char *text, const char *at) { if (text[0] != '/') return 0; if (!under(at, root, rootlen) && !under(text, root, rootlen)) { int own = host_bind(at), to = host_bind(text); + if (to == -1) return 0; if (own == -2 || to == -2) return FP_SLOW; if (own >= 0 && to >= 0 && strcmp(binds[own].host, binds[to].host) == 0) { const struct bind *bd = &binds[to]; @@ -635,8 +674,9 @@ static long resolve_in(const char *base, const char *path, int follow, struct re char norm[PATH_MAX]; size_t o = 0; int dotdot = 0; - size_t plen = strlen(path); - int trailing = plen > 1 && path[plen - 1] == '/'; + size_t plen = strlen(path), end = plen; + while (end > 1 && path[end - 1] == '/') end--; + int trailing = (plen > 1 && path[plen - 1] == '/') || (end > 0 && path[end - 1] == '.' && (end == 1 || path[end - 2] == '/')); for (int part = base ? 0 : 1; part < 2; part++) { for (const char *c = part ? path : base; *c;) { while (*c == '/') c++; diff --git a/tools/tests/test_fastpath_bind_names.py b/tools/tests/test_fastpath_bind_names.py new file mode 100644 index 0000000000..2e8a8b11f2 --- /dev/null +++ b/tools/tests/test_fastpath_bind_names.py @@ -0,0 +1,139 @@ +import os +from pathlib import Path +import shutil +import subprocess +import tempfile +import unittest + +FASTPATH = Path(__file__).resolve().parents[1] / "proot/fastpath/fastpath.c" + +PROGRAM = r""" +#include "FASTPATH" + +static long host_sys(long nr, long a, long b, long c, long d, long e, long f) { + long r = syscall(nr, a, b, c, d, e, f); + return r < 0 ? -errno : r; +} + +int main(int argc, char **argv) { + static char hosts[MAX_BINDS][PATH_MAX], guests[MAX_BINDS][512]; + fp_sys = host_sys; + snprintf(root, sizeof root, "%s", argv[1]); + rootlen = strlen(root); + int i = 2; + for (; i + 1 < argc && strcmp(argv[i], "--"); i += 2) { + struct bind *bd = &binds[nbinds]; + bd->host = hosts[nbinds]; + bd->guest = guests[nbinds]; + snprintf(bd->host, PATH_MAX, "%s", argv[i]); + snprintf(bd->guest, sizeof guests[0], "%s", argv[i + 1]); + bd->hlen = strlen(bd->host); + bd->glen = strlen(bd->guest); + nbinds++; + } + pthread_once(&init_once, fp_init); + fp_on = 1; + for (i++; i < argc; i++) { + char text[PATH_MAX]; + if (!strcmp(argv[i], "name")) { + if (guest_text(argv[++i], text) < 0) strcpy(text, "SLOW"); + puts(text); + } else if (!strcmp(argv[i], "link")) { + snprintf(text, sizeof text, "%s", argv[i + 2]); + if (detranslated(text, argv[i + 1]) == FP_SLOW) strcpy(text, "SLOW"); + i += 2; + puts(text); + } else if (!strcmp(argv[i], "lstat")) { + struct stat st; + long r = fstatat(AT_FDCWD, argv[++i], &st, AT_SYMLINK_NOFOLLOW); + puts(r < 0 ? "error" : S_ISDIR(st.st_mode) ? "dir" : S_ISLNK(st.st_mode) ? "link" : "other"); + } + } + return 0; +} +""" + + +class FastPathBindNamesTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + if shutil.which("gcc") is None: + raise unittest.SkipTest("gcc is not available") + cls.work = Path(tempfile.mkdtemp()) + source = cls.work / "names.c" + source.write_text(PROGRAM.replace("FASTPATH", str(FASTPATH))) + cls.program = cls.work / "names" + subprocess.run(["gcc", "-O1", "-w", "-pthread", "-o", str(cls.program), str(source), "-ldl"], check=True) + t = cls.work / "tree" + for d in ["root/etc", "root/mnt", "root/opt", "root/d/real", "lib/common/game", "fonts", "a", "b"]: + (t / d).mkdir(parents=True, exist_ok=True) + for f in ["root/etc/x", "lib/f", "lib/common/game/f", "fonts/f", "a/f", "b/f"]: + (t / f).touch() + os.symlink(t / "lib/f", t / "lib/l2") + os.symlink(t / "lib/common", t / "lib/l") + os.symlink("real", t / "root/d/link") + cls.tree = t + cls.binds = [ + (t / "lib", "/mnt/droiddeck-sd"), + (t / "lib", "/mnt/bannerlator-sd"), + (t / "lib", "/mnt/DroidDeck-SD"), + (t / "lib/common", "/opt/common"), + (t / "fonts", "/usr/share/fonts/android"), + (t / "a", "/opt/g"), + (t / "b", "/opt/g"), + (t / "fonts", "/mnt/x"), + ] + + @classmethod + def tearDownClass(cls): + shutil.rmtree(cls.work, ignore_errors=True) + + def ask(self, *queries): + argv = [str(self.program), str(self.tree / "root")] + for host, guest in self.binds: + argv += [str(host), guest] + argv.append("--") + for q in queries: + argv += [str(x) for x in q] + out = subprocess.run(argv, capture_output=True, text=True, timeout=20, check=True).stdout + return out.splitlines() + + def test_a_host_file_takes_the_name_proot_gives_it(self): + t = self.tree + self.assertEqual(self.ask( + ("name", t / "lib/f"), + ("name", t / "lib/common/game/f"), + ("name", t / "fonts/f"), + ("name", t / "b/f"), + ("name", t / "a/f"), + ("name", t / "root/etc/x"), + ), [ + "/mnt/droiddeck-sd/f", + "/opt/common/game/f", + "/usr/share/fonts/android/f", + "/opt/g/f", + str(t / "a/f"), + "/etc/x", + ]) + + def test_a_link_inside_a_library_reads_back_like_proot(self): + t = self.tree + self.assertEqual(self.ask( + ("link", t / "lib/l2", t / "lib/f"), + ("link", t / "lib/l", t / "lib/common"), + ), [ + "/mnt/droiddeck-sd/f", + str(t / "lib/common"), + ]) + + def test_a_final_dot_follows_the_link(self): + self.assertEqual(self.ask( + ("lstat", "/d/link"), + ("lstat", "/d/link/."), + ("lstat", "/d/link/./"), + ("lstat", "/d/link/"), + ), ["link", "dir", "dir", "dir"]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_fsync_preload.py b/tools/tests/test_fsync_preload.py index c2242f4945..63007f3734 100644 --- a/tools/tests/test_fsync_preload.py +++ b/tools/tests/test_fsync_preload.py @@ -319,7 +319,7 @@ class FsyncPreloadTest(unittest.TestCase): source = base / "fsync-test.c" source.write_text(PROGRAM) subprocess.run(["cc", "-O2", "-Wall", "-fPIC", "-shared", "-pthread", "-o", str(cls.lib), - str(PRELOAD / "fsync.c"), str(PRELOAD / "robust.c"), str(PRELOAD / "noexec.c"), "-ldl"], check=True) + str(PRELOAD / "fsync.c"), str(PRELOAD / "robust.c"), str(PRELOAD / "noexec.c"), str(PRELOAD / "writewatch.c"), "-ldl"], check=True) subprocess.run(["cc", "-O2", "-Wall", "-pthread", "-o", str(cls.exe), str(source)], check=True) @classmethod diff --git a/tools/tests/test_noexec_preload.py b/tools/tests/test_noexec_preload.py index 0e563ec49a..20a437d4cb 100644 --- a/tools/tests/test_noexec_preload.py +++ b/tools/tests/test_noexec_preload.py @@ -43,7 +43,7 @@ class NoexecPreloadTest(unittest.TestCase): cls.tmp = Path(tempfile.mkdtemp()) cls.lib = cls.tmp / "libnoexec.so" subprocess.run(["cc", "-O2", "-Wall", "-Werror", "-fPIC", "-shared", "-pthread", "-DNOEXEC_TEST", "-o", str(cls.lib), - str(PRELOAD / "noexec.c"), str(PRELOAD / "fsync.c"), str(PRELOAD / "robust.c"), "-ldl"], check=True) + str(PRELOAD / "noexec.c"), str(PRELOAD / "fsync.c"), str(PRELOAD / "robust.c"), str(PRELOAD / "writewatch.c"), "-ldl"], check=True) source = cls.tmp / "program.c" source.write_text(PROGRAM) for name in ("FEX", "game"): diff --git a/tools/tests/test_openat2_preload.py b/tools/tests/test_openat2_preload.py index a30aa74dda..eb27bcc7eb 100644 --- a/tools/tests/test_openat2_preload.py +++ b/tools/tests/test_openat2_preload.py @@ -230,7 +230,7 @@ class Openat2PreloadTest(unittest.TestCase): cls.tmp = Path(tempfile.mkdtemp()) cls.lib = cls.tmp / "libopenat2.so" subprocess.run(["cc", "-O2", "-Wall", "-Werror", "-fPIC", "-shared", "-pthread", "-o", str(cls.lib), - str(PRELOAD / "robust.c"), str(PRELOAD / "fsync.c"), str(PRELOAD / "noexec.c"), "-ldl"], check=True) + str(PRELOAD / "robust.c"), str(PRELOAD / "fsync.c"), str(PRELOAD / "noexec.c"), str(PRELOAD / "writewatch.c"), "-ldl"], check=True) source = cls.tmp / "openat2.c" source.write_text(PROGRAM) subprocess.run(["cc", "-O2", "-Wall", "-Werror", "-o", str(cls.tmp / "openat2"), str(source), "-ldl"], check=True) diff --git a/tools/tests/test_pipewire_helper.py b/tools/tests/test_pipewire_helper.py index e8abd59fcc..8e0c2343b3 100644 --- a/tools/tests/test_pipewire_helper.py +++ b/tools/tests/test_pipewire_helper.py @@ -74,6 +74,36 @@ class PipeWireHelperTest(unittest.TestCase): self.assertIn('did not open', result.stderr) self.assertFalse((self.runtime / 'droiddeck-pipewire/pids').exists()) + def test_clients_get_full_access_without_the_flatpak_check(self): + self.pack('python3 -c "import socket,sys; s=socket.socket(socket.AF_UNIX); s.bind(sys.argv[1]); ' + 'import time; time.sleep(30)" "$XDG_RUNTIME_DIR/pipewire-0"') + for _ in range(2): + result = self.run_helper('start') + self.assertEqual(result.returncode, 0, result.stderr) + daemon = (self.dir / 'share/pipewire/pipewire.conf.d/droiddeck-access.conf').read_text() + self.assertIn('module.access = false', daemon) + self.assertIn('name = libpipewire-module-access', daemon) + self.assertIn('access.socket = { pipewire-0 = "unrestricted", pipewire-0-manager = "unrestricted" }', + daemon) + self.assertNotIn('access.legacy', daemon) + manager = (self.dir / 'share/wireplumber/wireplumber.conf.d/droiddeck-access.conf').read_text() + self.assertIn('matches = [ { pipewire.access = "unrestricted" } ]', manager) + self.assertIn('default_permissions = "all"', manager) + + def test_start_fails_cleanly_when_the_access_settings_cannot_be_written(self): + self.pack('exec sleep 30') + self.run_helper('start') + self.run_helper('stop') + conf = self.dir / 'share/pipewire/pipewire.conf.d' + for child in conf.iterdir(): + child.unlink() + conf.rmdir() + conf.write_text('') + result = self.run_helper('start') + self.assertNotEqual(result.returncode, 0) + self.assertIn('could not write the access settings', result.stderr) + self.assertFalse((self.runtime / 'droiddeck-pipewire/pids').exists()) + def test_unchanged_bundle_is_not_unpacked_again(self): self.pack('exec sleep 30') self.run_helper('start') diff --git a/tools/tests/test_vrclient_loader.py b/tools/tests/test_vrclient_loader.py index f468269925..fa1a778bf4 100644 --- a/tools/tests/test_vrclient_loader.py +++ b/tools/tests/test_vrclient_loader.py @@ -32,6 +32,7 @@ int probe(void) { #include #include int bl_fsync_syscall(long n, const long *a, long *r) { (void)n; (void)a; (void)r; return 0; } +int bl_writewatch_syscall(long n, const long *a, long (*real)(long, ...), long *r) { (void)n; (void)a; (void)real; (void)r; return 0; } #include """ + '"' + robust.as_posix() + '"' + r""" int main(int argc, char **argv) { assert(argc == 3); diff --git a/tools/tests/test_writewatch_preload.py b/tools/tests/test_writewatch_preload.py new file mode 100644 index 0000000000..38f2967557 --- /dev/null +++ b/tools/tests/test_writewatch_preload.py @@ -0,0 +1,119 @@ +from pathlib import Path +import shutil +import subprocess +import tempfile +import unittest + +PRELOAD = Path(__file__).resolve().parents[1] / "linuxfs/preload" + +PROGRAM = r""" +#include "WRITEWATCH" +#include +#include +#include +#include + +#define PAGES 96 + +static int uffd, pagemap; +static uint64_t page; + +static char *region(void) { + char *m = mmap(NULL, PAGES * page, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0); + madvise(m, PAGES * page, MADV_NOHUGEPAGE); + struct uffdio_register reg = { .range = { (uintptr_t)m, PAGES * page }, .mode = UFFDIO_REGISTER_MODE_WP }; + if (m == MAP_FAILED || ioctl(uffd, UFFDIO_REGISTER, ®)) exit(3); + protect(uffd, (uintptr_t)m, (uintptr_t)m + PAGES * page); + return m; +} + +static long scan(char *m, int emulated, uint64_t flags, uint64_t vec_len, uint64_t max_pages, uint64_t from, uint64_t to, + struct page_region *vec, uint64_t *walk_end) { + struct pm_scan_arg a = { .size = sizeof a, .flags = flags, .start = (uintptr_t)m + from * page, .end = (uintptr_t)m + to * page, + .vec = vec_len ? (uintptr_t)vec : 0, .vec_len = vec_len, .max_pages = max_pages, + .category_mask = PAGE_IS_WRITTEN, .return_mask = PAGE_IS_WRITTEN }; + long n = emulated ? emulate_scan(pagemap, uffd, &a) : ioctl(pagemap, PAGEMAP_SCAN, &a); + *walk_end = (a.walk_end - (uintptr_t)m) / page; + return n; +} + +int main(int argc, char **argv) { + page = (uint64_t)getpagesize(); + uffd = syscall(SYS_userfaultfd, O_CLOEXEC | O_NONBLOCK | UFFD_USER_MODE_ONLY); + struct uffdio_api api = { .api = UFFD_API, .features = UFFD_FEATURE_WP_ASYNC | UFFD_FEATURE_WP_UNPOPULATED }; + pagemap = open("/proc/self/pagemap", O_RDONLY | O_CLOEXEC); + if (uffd < 0 || ioctl(uffd, UFFDIO_API, &api) || pagemap < 0) { puts("unsupported"); return 0; } + char *kernel = region(), *ours = region(); + struct page_region probe[1]; + uint64_t end; + if (scan(kernel, 0, 0, 1, 0, 0, PAGES, probe, &end) < 0) { puts("unsupported"); return 0; } + srand(atoi(argv[1])); + int rounds = atoi(argv[2]), differing = 0; + for (int r = 0; r < rounds; r++) { + int writes = rand() % 24; + for (int w = 0; w < writes; w++) { + int p = rand() % PAGES; + if (rand() % 4 == 0) { + volatile char x = kernel[p * page] + ours[p * page]; + (void)x; + continue; + } + kernel[p * page + rand() % page] = (char)r; + ours[p * page + rand() % page] = (char)r; + } + uint64_t flags = rand() % 2 ? PM_SCAN_WP_MATCHING : 0; + uint64_t vec_len = rand() % 3 == 0 ? 0 : 1 + rand() % 5; + uint64_t max_pages = rand() % 3 == 0 ? 1 + rand() % 8 : 0; + if (!vec_len) flags = PM_SCAN_WP_MATCHING, max_pages = 0; + uint64_t from = rand() % PAGES, to = from + rand() % (PAGES - from + 1); + struct page_region kv[8], ov[8]; + uint64_t kend, oend; + long kn = scan(kernel, 0, flags, vec_len, max_pages, from, to, kv, &kend); + long on = scan(ours, 1, flags, vec_len, max_pages, from, to, ov, &oend); + int same = kn == on && (kn < 0 || kend == oend); + for (long i = 0; same && i < kn; i++) + same = kv[i].start - (uintptr_t)kernel == ov[i].start - (uintptr_t)ours + && kv[i].end - (uintptr_t)kernel == ov[i].end - (uintptr_t)ours && kv[i].categories == ov[i].categories; + struct page_region kall[PAGES], oall[PAGES]; + long ka = scan(kernel, 0, 0, PAGES, 0, 0, PAGES, kall, &kend), oa = scan(ours, 1, 0, PAGES, 0, 0, PAGES, oall, &oend); + same = same && ka == oa; + for (long i = 0; same && i < ka; i++) + same = kall[i].start - (uintptr_t)kernel == oall[i].start - (uintptr_t)ours && kall[i].end - (uintptr_t)kernel == oall[i].end - (uintptr_t)ours; + if (!same) { + differing++; + printf("round %d flags %llu vec %llu max %llu range %llu-%llu: kernel %ld end %llu, ours %ld end %llu\n", r, + (unsigned long long)flags, (unsigned long long)vec_len, (unsigned long long)max_pages, (unsigned long long)from, + (unsigned long long)to, kn, (unsigned long long)kend, on, (unsigned long long)oend); + } + } + printf("rounds %d differing %d\n", rounds, differing); + return 0; +} +""" + + +class WriteWatchPreloadTest(unittest.TestCase): + @classmethod + def setUpClass(cls): + if shutil.which("gcc") is None: + raise unittest.SkipTest("gcc is not available") + cls.work = Path(tempfile.mkdtemp()) + source = cls.work / "writewatch.c" + source.write_text(PROGRAM.replace("WRITEWATCH", str(PRELOAD / "writewatch.c"))) + cls.program = cls.work / "writewatch" + subprocess.run(["gcc", "-O1", "-Wall", "-o", str(cls.program), str(source)], check=True) + + @classmethod + def tearDownClass(cls): + shutil.rmtree(cls.work, ignore_errors=True) + + def test_a_scan_android_refuses_answers_like_the_kernel_one(self): + for seed in range(4): + out = subprocess.run([str(self.program), str(seed), "400"], capture_output=True, text=True, timeout=60).stdout + if out.strip() == "unsupported": + self.skipTest("this kernel has no asynchronous userfaultfd write protection") + self.assertTrue(out.rstrip().endswith("differing 0"), out) + + +if __name__ == "__main__": + unittest.main()