From a63f3b1fbc0ca8809b36fef71c0324a5728a14f1 Mon Sep 17 00:00:00 2001 From: Kurt Himebauch <136133082+xXJSONDeruloXx@users.noreply.github.com> Date: Mon, 19 Oct 2026 18:44:10 -0400 Subject: [PATCH] Add experimental Xbox and PC Game Pass store support (#1156) --- .github/workflows/build.yml | 46 +- app/build.gradle | 1 + app/src/main/AndroidManifest.xml | 4 + .../main/java/com/droiddeck/launcher/App.kt | 5 + .../launcher/session/SessionFiles.kt | 5 +- .../droiddeck/launcher/stores/CloudSaves.kt | 6 +- .../droiddeck/launcher/stores/LoginFlows.kt | 2 +- .../com/droiddeck/launcher/stores/Store.kt | 1 + .../launcher/stores/StoreAccounts.kt | 12 +- .../droiddeck/launcher/stores/StoreCatalog.kt | 6 +- .../droiddeck/launcher/stores/StoreLaunch.kt | 9 + .../launcher/stores/StoreLaunchRequests.kt | 7 + .../droiddeck/launcher/stores/StoreSizes.kt | 8 +- .../droiddeck/launcher/stores/StoresState.kt | 16 +- .../launcher/stores/download/SavedQueue.kt | 4 +- .../launcher/stores/xbox/XboxBackend.kt | 146 ++++ .../launcher/stores/xbox/XboxCatalog.kt | 107 +++ .../launcher/stores/xbox/XboxContent.kt | 105 +++ .../launcher/stores/xbox/XboxCredentials.kt | 86 +++ .../launcher/stores/xbox/XboxInstaller.kt | 104 +++ .../launcher/stores/xbox/XboxLibraryCache.kt | 57 ++ .../launcher/stores/xbox/XboxLoginActivity.kt | 182 +++++ .../launcher/stores/xbox/XboxManifest.kt | 70 ++ .../launcher/stores/xbox/XboxRuntime.kt | 46 ++ .../droiddeck/launcher/stores/xbox/Xodus.kt | 106 +++ .../com/droiddeck/launcher/ui/StoreChips.kt | 2 + .../com/droiddeck/launcher/ui/StoresDetail.kt | 23 +- .../com/droiddeck/launcher/ui/StoresPage.kt | 68 +- .../stores/StoreAccountsCipherTest.kt | 19 + .../launcher/stores/StoreLaunchTest.kt | 56 ++ .../launcher/stores/xbox/XboxCatalogTest.kt | 77 ++ .../stores/xbox/XboxLibraryCacheTest.kt | 53 ++ .../launcher/stores/xbox/XboxManifestTest.kt | 55 ++ docs/development/xbox-store.md | 106 +++ tools/build_local.sh | 7 + .../overlay/usr/local/bin/droiddeck-game-env | 14 + .../overlay/usr/local/bin/droiddeck-session | 9 +- .../overlay/usr/local/bin/droiddeck-xbox | 183 +++++ tools/release/runtime_inputs.py | 5 +- tools/tests/test_game_environment.py | 11 + tools/tests/test_steam_cold_launch.py | 27 +- tools/tests/test_xbox_launch.py | 73 ++ tools/xbox/LICENSE.LGPL-2.1 | 502 +++++++++++++ tools/xbox/LICENSE.nexus | 21 + tools/xbox/LICENSE.nghttp2 | 23 + tools/xbox/LICENSE.xodus | 674 ++++++++++++++++++ tools/xbox/README.md | 79 ++ tools/xbox/backend.lock.json | 109 +++ tools/xbox/build-local.sh | 18 + tools/xbox/build.sh | 37 + tools/xbox/droiddeck-credentials.patch | 154 ++++ tools/xbox/droiddeck-launch-view.patch | 86 +++ tools/xbox/prepare.py | 36 + tools/xbox/runtime-probe.c | 23 + tools/xbox/runtime.lock.json | 17 + tools/xbox/runtime.py | 59 ++ 56 files changed, 3720 insertions(+), 47 deletions(-) create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCatalog.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxContent.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxInstaller.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCache.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxManifest.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxRuntime.kt create mode 100644 app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt create mode 100644 app/src/test/java/com/droiddeck/launcher/stores/StoreLaunchTest.kt create mode 100644 app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxCatalogTest.kt create mode 100644 app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCacheTest.kt create mode 100644 app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxManifestTest.kt create mode 100644 docs/development/xbox-store.md create mode 100755 tools/linuxfs/overlay/usr/local/bin/droiddeck-xbox create mode 100644 tools/tests/test_xbox_launch.py create mode 100644 tools/xbox/LICENSE.LGPL-2.1 create mode 100644 tools/xbox/LICENSE.nexus create mode 100644 tools/xbox/LICENSE.nghttp2 create mode 100644 tools/xbox/LICENSE.xodus create mode 100644 tools/xbox/README.md create mode 100644 tools/xbox/backend.lock.json create mode 100755 tools/xbox/build-local.sh create mode 100755 tools/xbox/build.sh create mode 100644 tools/xbox/droiddeck-credentials.patch create mode 100644 tools/xbox/droiddeck-launch-view.patch create mode 100755 tools/xbox/prepare.py create mode 100644 tools/xbox/runtime-probe.c create mode 100644 tools/xbox/runtime.lock.json create mode 100755 tools/xbox/runtime.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 25ef8cc09c..46fca6d7c8 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -29,7 +29,46 @@ env: PRELOAD_CACHE_VERSION: v6 jobs: + xbox: + name: Xbox ARM64 backend + if: ${{ github.event_name != 'pull_request' || !github.event.pull_request.draft }} + runs-on: ubuntu-24.04-arm + timeout-minutes: 30 + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }} + - uses: actions/cache@v4 + id: xbox-cache + with: + path: | + app/src/main/assets/linuxfs/usr/local/lib/droiddeck-xbox + app/build/xbox/xodus-droiddeck-source.tar.xz + app/build/xbox/runtime/*-source.tar.xz + key: xbox-arm64-${{ hashFiles('tools/xbox/**') }} + - name: Build Xbox backend + if: steps.xbox-cache.outputs.cache-hit != 'true' + run: | + rustup toolchain install 1.99.0 --profile minimal + sudo apt-get update -qq + sudo apt-get install -y build-essential pkg-config libssl-dev protobuf-compiler cmake xz-utils + bash tools/xbox/build.sh + - uses: actions/upload-artifact@v4 + with: + name: xbox-arm64 + path: app/src/main/assets/linuxfs/usr/local/lib/droiddeck-xbox + retention-days: 14 + - uses: actions/upload-artifact@v4 + with: + name: xbox-corresponding-source + path: | + app/build/xbox/xodus-droiddeck-source.tar.xz + app/build/xbox/runtime/*-source.tar.xz + if-no-files-found: error + retention-days: 14 + build: + needs: xbox name: Build APK if: ${{ github.event_name != 'pull_request' || !github.event.pull_request.draft }} runs-on: ubuntu-24.04 @@ -184,7 +223,7 @@ jobs: uses: actions/cache@v4 with: path: app/src/main/assets/linuxfs - key: preloads-${{ env.PRELOAD_CACHE_VERSION }}-${{ hashFiles('app/src/main/cpp/fakeinput_steam.cpp', 'app/src/main/cpp/adrenotools/src/hook/kgsl.h', 'tools/quest/*', 'tools/linuxfs/preload/*.c', 'tools/linuxfs/build-x86-preloads.sh', 'tools/linuxfs/fex/*', 'tools/linuxfs/clipboard/*.c', 'tools/linuxfs/ssbs/*.c', 'tools/proot/fastpath/*.c', 'tools/linuxfs/overlay/usr/local/bin/*', 'tools/linuxfs/overlay/usr/bin/**', 'tools/linuxfs/desktop/*', 'tools/gamescope/release.env', 'tools/wlroots/release.env', 'tools/linuxfs/uruntime.env', 'tools/linuxfs/licenses/*', 'tools/mangoapp/*', 'tools/msitools/**', 'tools/comet/**', 'tools/linuxfs/debian-image.env', 'tools/vr/**') }} + key: preloads-${{ env.PRELOAD_CACHE_VERSION }}-${{ hashFiles('app/src/main/cpp/fakeinput_steam.cpp', 'app/src/main/cpp/adrenotools/src/hook/kgsl.h', 'tools/quest/*', 'tools/linuxfs/preload/*.c', 'tools/linuxfs/build-x86-preloads.sh', 'tools/linuxfs/fex/*', 'tools/linuxfs/clipboard/*.c', 'tools/linuxfs/ssbs/*.c', 'tools/proot/fastpath/*.c', 'tools/linuxfs/overlay/usr/local/bin/*', 'tools/linuxfs/overlay/usr/bin/**', 'tools/linuxfs/desktop/*', 'tools/gamescope/release.env', 'tools/wlroots/release.env', 'tools/linuxfs/uruntime.env', 'tools/linuxfs/licenses/*', 'tools/mangoapp/*', 'tools/msitools/**', 'tools/comet/**', 'tools/xbox/**', 'tools/linuxfs/debian-image.env', 'tools/vr/**') }} - name: Build libfakeinput.so and libblsession.so (glibc aarch64) if: steps.preloads.outputs.cache-hit != 'true' @@ -464,6 +503,11 @@ jobs: restore-keys: | cxx-${{ env.NDK_VERSION }}- + - uses: actions/download-artifact@v4 + with: + name: xbox-arm64 + path: app/src/main/assets/linuxfs/usr/local/lib/droiddeck-xbox + - name: Build GOG Galaxy companion if: steps.preloads.outputs.cache-hit != 'true' run: | diff --git a/app/build.gradle b/app/build.gradle index b38e1b35a9..2e269ac50e 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -318,6 +318,7 @@ dependencies { implementation 'com.termux.termux-app:terminal-view:0.118.0' implementation 'androidx.camera:camera-camera2:1.4.2' implementation 'androidx.camera:camera-lifecycle:1.4.2' + implementation 'androidx.webkit:webkit:1.12.1' implementation('com.google.mediapipe:tasks-vision:1.0.0') { exclude group: 'com.google.auto.value', module: 'auto-value' } diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index 095abb5bbf..87768b8f72 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -147,6 +147,10 @@ android:configChanges="orientation|screenSize|screenLayout|smallestScreenSize|density" android:theme="@style/AppTheme" /> + + = 28) Application.getProcessName() else (getSystemService(ACTIVITY_SERVICE) as android.app.ActivityManager) .runningAppProcesses?.firstOrNull { it.pid == android.os.Process.myPid() }?.processName + if (process == "$packageName:xboxlogin") { + if (android.os.Build.VERSION.SDK_INT >= 28) android.webkit.WebView.setDataDirectorySuffix("xbox") + return + } if (process == "$packageName:vr_recovery" || process == "$packageName:rgb_diagnostic") return CrashHandler.install(this) com.droiddeck.launcher.session.QuestExperimental.initialize(this) @@ -36,5 +40,6 @@ class App : Application() { com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.epic.EpicBackend) com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.amazon.AmazonBackend) com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.itch.ItchBackend) + com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.xbox.XboxBackend) } } diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt index 681287c868..46d84c50a8 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt @@ -66,6 +66,7 @@ object SessionFiles { "usr/local/bin/droiddeck-desktop-bookmarks" to "usr/local/bin/droiddeck-desktop-bookmarks", "usr/local/bin/droiddeck-steam-shim" to "usr/local/bin/droiddeck-steam-shim", "usr/local/bin/droiddeck-steam-shortcuts" to "usr/local/bin/droiddeck-steam-shortcuts", + "usr/local/bin/droiddeck-xbox" to "usr/local/bin/droiddeck-xbox", "usr/local/bin/droiddeck-store-launch" to "usr/local/bin/droiddeck-store-launch", "usr/local/bin/droiddeck-epic" to "usr/local/bin/droiddeck-epic", "usr/local/bin/droiddeck-epic-steam" to "usr/local/bin/droiddeck-epic-steam", @@ -133,7 +134,9 @@ object SessionFiles { "usr/local/bin/gamescope" to "usr/local/bin/gamescope", "usr/local/lib/droiddeck/uruntime" to "usr/local/lib/droiddeck/uruntime", "usr/local/share/licenses/uruntime/LICENSE" to "usr/local/share/licenses/uruntime/LICENSE", - ) + mangoapp + listOf("comet", "GalaxyCommunication.exe", "update-permissions.exe", "LICENSE", "version").map { "usr/local/lib/droiddeck-comet/$it" to "usr/local/lib/droiddeck-comet/$it" } + msitools.map { it to it } + vr + fexPreloads).filter { (asset, _) -> + ) + listOf("xodus-cli", "xodus-service", "LICENSE.xodus", "LICENSE.nexus", "LICENSE.LGPL-2.1", "LICENSE.nghttp2", "backend.lock.json", "runtime.lock.json", "version", + "windows/xgameruntime.dll", "windows/winhttp.dll", "windows/windows.web.dll", "windows/twinapi.appcore.dll", "windows/libnghttp2.dll") + .map { "usr/local/lib/droiddeck-xbox/$it" to "usr/local/lib/droiddeck-xbox/$it" } + mangoapp + listOf("comet", "GalaxyCommunication.exe", "update-permissions.exe", "LICENSE", "version").map { "usr/local/lib/droiddeck-comet/$it" to "usr/local/lib/droiddeck-comet/$it" } + msitools.map { it to it } + vr + fexPreloads).filter { (asset, _) -> val dir = asset.substringBeforeLast('/') runCatching { context.assets.list("linuxfs/$dir")?.contains(asset.substringAfterLast('/')) == true }.getOrDefault(false) } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt b/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt index 7c00981b22..669a13eee0 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt @@ -58,7 +58,7 @@ object CloudSaves { val item = sidecar.extra["catalogItemId"].orEmpty() if (ns.isEmpty() || item.isEmpty()) "" else EpicApiClient.getCustomAttribute(token, ns, item, "CloudSaveFolder") } - Store.AMAZON, Store.ITCH -> "" + Store.AMAZON, Store.ITCH, Store.XBOX -> "" } ?: return null p.edit().putString("cloud_template_$id", fetched).apply() Log.i(TAG, "cloud ${store.id} $id template ${if (fetched.isEmpty()) "none" else "found"}") @@ -96,7 +96,7 @@ object CloudSaves { val dir = when (store) { Store.GOG -> CloudSavePaths.gog(template, pfx, folder) Store.EPIC -> CloudSavePaths.epic(template, pfx, folder, EpicCredentialStore.load(context)?.accountId.orEmpty(), id) - Store.AMAZON, Store.ITCH -> null + Store.AMAZON, Store.ITCH, Store.XBOX -> null } return dir to (if (dir == null) "unresolved" else "ok") } @@ -121,7 +121,7 @@ object CloudSaves { val account = EpicCredentialStore.load(context)?.accountId.orEmpty() if (token == null || account.isEmpty()) null else EpicCloud(account, id, token) } - Store.AMAZON, Store.ITCH -> null + Store.AMAZON, Store.ITCH, Store.XBOX -> null } private fun gogScopedToken(context: Context, id: String, clientId: String): String? { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt b/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt index 43517ebfed..be1b29ed05 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt @@ -12,7 +12,7 @@ internal object LoginFlows { Store.GOG -> GogFlow(state) Store.EPIC -> epicFlow() Store.AMAZON -> amazonFlow() - Store.ITCH -> null + Store.ITCH, Store.XBOX -> null } @Volatile var epicFlow: () -> StoreLoginActivity.Flow? = { null } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/Store.kt b/app/src/main/java/com/droiddeck/launcher/stores/Store.kt index d7cc814cb7..b5e0d1fbf6 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/Store.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/Store.kt @@ -4,6 +4,7 @@ enum class Store(val id: String, val label: String, val shortLabel: String) { GOG("gog", "GOG", "GOG"), EPIC("epic", "Epic Games", "Epic"), AMAZON("amazon", "Amazon Games", "Amazon"), + XBOX("xbox", "Xbox", "Xbox"), ITCH("itch", "itch.io", "itch"); companion object { 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 6b5f301863..27bf133f18 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreAccounts.kt @@ -67,7 +67,10 @@ object StoreAccounts { fun write(context: Context, store: Store, json: JSONObject) { unavailable.remove(store) val f = credentialsFile(context, store) - if (seal(f, json) == null) put(f, json.toString()) + if (seal(f, json, retry = store == Store.XBOX) == null) { + check(store != Store.XBOX) { "Android Keystore is unavailable for Xbox credentials" } + put(f, json.toString()) + } } @Synchronized @@ -86,18 +89,19 @@ object StoreAccounts { fun signedInAs(context: Context, store: Store): String? { val json = read(context, store) ?: return if (isUnavailable(store)) store.label else null + if (store == Store.XBOX) return json.optString("username").takeIf { it.isNotBlank() } if (json.optString("access_token", "").isEmpty()) return null return json.optString("display_name", "").ifEmpty { json.optString("username", "") }.ifEmpty { store.label } } - private fun seal(f: File, json: JSONObject): File? { - if (keystoreFailed) return null + private fun seal(f: File, json: JSONObject, retry: Boolean = false): File? { + if (keystoreFailed && !retry) return null val text = json.toString() val envelope = try { CredentialCipher.seal(text, keys).also { check(CredentialCipher.open(it, keys) == text) { "check failed" } } } catch (e: Exception) { keystoreFailed = true - Log.w(TAG, "stores: keystore unavailable, credentials stay plain (${e.javaClass.simpleName})") + Log.w(TAG, "stores: keystore unavailable (${e.javaClass.simpleName})") return null } put(f, envelope.toString()) 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 049e2b926b..6f4678c7f7 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt @@ -21,7 +21,9 @@ data class CatalogItem( val sizeBytes: Long = 0L, val extra: Map = emptyMap(), val mature: Boolean = false, + val subscription: Boolean = false, ) { + val accessible: Boolean get() = owned || subscription val isDiscounted: Boolean get() = discountPercent > 0 && originalPrice.isNotBlank() val key: String get() = "${store.id}:$id" } @@ -49,7 +51,9 @@ fun installedCards(store: Store, installed: List, library: L return installed.filter { it.sidecar.store == store }.map { game -> val s = game.sidecar byId[s.id] ?: byTitle[s.title.lowercase()] - ?: CatalogItem(store, s.id, s.title, imageUrl = s.hero ?: s.cover, tallImageUrl = s.cover ?: s.hero, owned = true) + ?: CatalogItem(store, s.id, s.title, imageUrl = s.hero ?: s.cover, tallImageUrl = s.cover ?: s.hero, + owned = s.store != Store.XBOX || s.extra["access"] == "owned", + subscription = s.store == Store.XBOX && s.extra["access"] == "gamepass") }.distinctBy { it.id }.sortedBy { it.title.lowercase() } } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt index 4486df81e1..e17aac578b 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt @@ -2,6 +2,7 @@ package com.droiddeck.launcher.stores import android.content.Context import android.util.Log +import com.droiddeck.launcher.frontend.AddedGames import com.droiddeck.launcher.frontend.Library import java.io.File @@ -63,6 +64,14 @@ object StoreLaunch { private const val CODE_VAR = "DD_X" private const val CLIENT_VAR = "DD_A" + fun installedGame(context: Context, store: Store, id: String): Library.SteamGame? { + val folder = StoreInstallRoot.gameFolders(context).firstOrNull { folder -> + StoreGameSidecar.read(folder)?.let { it.store == store && it.id == id && it.isInstalled } == true + } ?: return null + val game = AddedGames.single(context, folder.path) ?: return null + return Library.addedGame(context, game) + } + fun refreshLauncher(folder: File, sidecar: StoreGameSidecar) { if (sidecar.launcher != LAUNCHER) return val file = File(folder, LAUNCHER) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt index 4005ff2b3b..909c0b7fcb 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt @@ -37,6 +37,7 @@ object StoreLaunchRequests { } fun stop() { + Thread({ com.droiddeck.launcher.stores.xbox.XboxRuntime.stop() }, "xbox-service-stop").start() synchronized(lock) { observer?.stopWatching() observer = null @@ -50,6 +51,12 @@ object StoreLaunchRequests { return } val reply = when (request.optString("op")) { + "xbox-released" -> { + com.droiddeck.launcher.stores.xbox.XboxRuntime.released(request.optString("id")) + JSONObject().put("ok", true) + } + "xbox-prepare" -> runCatching { com.droiddeck.launcher.stores.xbox.XboxRuntime.prepare(app, request.getString("id")) } + .getOrElse { JSONObject().put("ok", false).put("reason", "Xbox account service is unavailable. Sign in again and retry.") } "gog-achievements" -> runCatching { com.droiddeck.launcher.stores.gog.GogComet.prepare(app, request.optString("id")) } .getOrElse { JSONObject().put("ok", false).put("ready", false).put("reason", "service-unavailable") } "epic-code" -> { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt index 01014dbd79..b9b9354b7d 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt @@ -31,7 +31,7 @@ object StoreSizes { private fun cache(context: Context, store: Store) = caches.getOrPut(store) { SizeCache.forStore(context.applicationContext.filesDir, store) } fun request(context: Context, item: CatalogItem) { - if (!item.owned || item.sizeBytes > 0 || item.store == Store.GOG || known.containsKey(item.key)) return + if (!item.accessible || item.sizeBytes > 0 || item.store == Store.GOG || known.containsKey(item.key)) return resolve(context, item).thenAccept { bytes -> if (bytes != null) StoresState.post { known[item.key] = bytes } } @@ -39,7 +39,7 @@ object StoreSizes { fun resolve(context: Context, item: CatalogItem): CompletableFuture { val available = known[item.key] ?: item.sizeBytes.takeIf { it > 0 } - if (!item.owned || item.store == Store.GOG || item.sizeBytes > 0) return CompletableFuture.completedFuture(available) + if (!item.accessible || item.store == Store.GOG || item.sizeBytes > 0) return CompletableFuture.completedFuture(available) if (available != null) return CompletableFuture.completedFuture(available) val app = context.applicationContext val version = item.extra["version"].orEmpty() @@ -55,7 +55,7 @@ object StoreSizes { Store.EPIC -> EpicPrefs.get(app).edit().putLong("size_${item.id}", it).apply() Store.AMAZON -> AmazonPrefs.get(app).edit().putLong("size_${item.id}", it).apply() Store.ITCH -> {} - Store.GOG -> {} + Store.GOG, Store.XBOX -> {} } } }, pool).exceptionally { error -> @@ -108,7 +108,7 @@ object StoreSizes { val bytes = AmazonApiClient.getBytes(AmazonApiClient.appendPath(spec.downloadUrl, "manifest.proto"), token) ?: return 0L AmazonManifest.parse(bytes).totalInstallSize } - Store.GOG -> 0L + Store.GOG, Store.XBOX -> 0L Store.ITCH -> com.droiddeck.launcher.stores.itch.ItchLibrary.size(context, item) } } } 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 63cc4a4cf0..4aa57757c6 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoresState.kt @@ -20,6 +20,8 @@ object StoresState { private val main = Handler(Looper.getMainLooper()) val accounts = mutableStateMapOf() + var accountsLoaded by mutableStateOf(false) + private set val library = mutableStateMapOf>() @@ -84,11 +86,15 @@ object StoresState { val partial = StoreInstallRoot.unfinished(app) val version = if (StoresNative.available) StoresNative.version ?: "" else "" main.post { - accounts.clear() - found.forEach { (store, name) -> accounts[store] = name } - installed = onDisk - unfinished = partial - engine = version + androidx.compose.runtime.snapshots.Snapshot.withMutableSnapshot { + val restored = found.toMap() + accounts.keys.toList().filter { it !in restored }.forEach { accounts.remove(it) } + accounts.putAll(restored) + installed = onDisk + unfinished = partial + engine = version + accountsLoaded = true + } } } } 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 0c9fd0ccb0..5a5eae4fa0 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 @@ -78,7 +78,7 @@ object SavedQueue { put("store", i.store.id); put("id", i.id); put("title", i.title) put("image", i.imageUrl ?: ""); put("tall", i.tallImageUrl ?: "") put("tags", i.tags); put("developer", i.developer); put("description", i.description) - put("size", i.sizeBytes); put("owned", i.owned) + put("size", i.sizeBytes); put("owned", i.owned); put("subscription", i.subscription) put("extra", JSONObject(i.extra)) } @@ -89,7 +89,7 @@ object SavedQueue { id = o.getString("id"), title = o.getString("title"), imageUrl = o.optString("image").ifEmpty { null }, tallImageUrl = o.optString("tall").ifEmpty { null }, tags = o.optString("tags"), developer = o.optString("developer"), description = o.optString("description"), - owned = o.optBoolean("owned", true), sizeBytes = o.optLong("size"), + owned = o.optBoolean("owned", true), subscription = o.optBoolean("subscription"), sizeBytes = o.optLong("size"), extra = extra?.keys()?.asSequence()?.associateWith { extra.getString(it) } ?: emptyMap(), ) } 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 new file mode 100644 index 0000000000..2eaa590809 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxBackend.kt @@ -0,0 +1,146 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import android.content.Intent +import androidx.compose.runtime.getValue +import androidx.compose.runtime.setValue +import com.droiddeck.launcher.stores.* +import com.droiddeck.launcher.stores.download.DownloadEntry +import com.droiddeck.launcher.stores.download.DownloadQueue +import java.io.File + +object XboxBackend : StoreBackend { + override val store = Store.XBOX + @Volatile private var access: Map = emptyMap() + @Volatile private var generation = 0 + private var syncing: Int? = null + + override fun signIn(context: Context) { + context.startActivity(Intent(context, XboxLoginActivity::class.java).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)) + } + + @Synchronized override fun signOut(context: Context) { + generation++ + XboxCredentials.invalidate(context) + XboxLibraryCache.clear(context) + XboxRuntime.stop() + access = emptyMap() + StoresState.post { packageChoice = null; StoresState.shelves.remove(store); StoresState.found.remove(store) } + } + + @Synchronized override fun syncLibrary(context: Context, force: Boolean) { + val app = context.applicationContext + val current = generation + if (syncing == current) return + syncing = current + Thread({ + try { + val account = StoreAccounts.signedInAs(app, store) ?: error("Sign in to Xbox first.") + val market = Xodus.market() + val cached = XboxLibraryCache.read(app, account, market) + synchronized(this) { + if (current != generation) return@Thread + if (cached != null) access = cached.games.associate { it.id to it.extra.getValue("access") } + } + StoresState.post { + if (current == generation) { + if (cached != null) StoresState.library[store] = mergeItems(StoresState.library[store], cached.games) + StoresState.problems.remove(store) + if (cached == null || force) StoresState.status[store] = "Syncing Xbox library…" + else StoresState.status.remove(store) + } + } + if (cached != null && !cached.needsRefresh(force)) return@Thread + val licenses = XboxCatalog.access(Xodus.run(app, listOf("library", "--json", "--market", market)), account, market) + val games = XboxCatalog.products(licenses.keys.toList(), licenses, market).sortedBy { it.title.lowercase() } + synchronized(this) { + if (current != generation || StoreAccounts.signedInAs(app, store) != account) return@Thread + access = licenses + runCatching { XboxLibraryCache.write(app, account, market, games) } + .onFailure { StoresState.logLine("Xbox: library cache could not be saved") } + } + StoresState.post { + if (current == generation) { + StoresState.library[store] = mergeItems(StoresState.library[store], games) + StoresState.status.remove(store) + StoresState.problems.remove(store) + } + } + } catch (e: Exception) { + StoresState.post { + if (current == generation) { + StoresState.status.remove(store) + StoresState.problems[store] = e.message ?: "Xbox library could not be loaded." + } + } + } finally { + synchronized(this) { if (syncing == current) syncing = null } + } + }, "xbox-library").start() + } + + override fun loadShelves(context: Context, force: Boolean) { + val current = generation + Thread({ + runCatching { XboxCatalog.featured(access) }.onSuccess { games -> + if (current == generation) StoresState.post { StoresState.shelves[store] = StoreShelves(trending = games) } + }.onFailure { if (current == generation) StoresState.post { StoresState.problems[store] = "Microsoft Store could not be reached. Try again." } } + }, "xbox-store").start() + } + + override fun search(context: Context, query: String): List = XboxCatalog.search(query, access) + + class PackageChoice(val item: CatalogItem, val root: File, val choices: List) + var packageChoice by androidx.compose.runtime.mutableStateOf(null) + private set + + fun dismissPackages() { packageChoice = null } + fun selectPackage(context: Context, choice: org.json.JSONObject) { + val pending = packageChoice ?: return + packageChoice = null + val item = pending.item.copy(extra = pending.item.extra + ("contentId" to choice.getString("contentId"))) + com.droiddeck.launcher.stores.download.SavedQueue.remember(context, item, pending.root) + enqueue(context.applicationContext, item, pending.root) + } + + override fun install(context: Context, item: CatalogItem, root: File) { + val app = context.applicationContext + if (!item.extra["baseId"].isNullOrBlank()) { XboxContent.install(app, item); return } + if (!item.extra["contentId"].isNullOrBlank()) { enqueue(app, item, root); return } + Thread({ + try { + val plan = Xodus.run(app, listOf("resolve-package", item.id, "--json", "--market", item.extra["market"] ?: Xodus.market())) + require(plan.getInt("schema") == 1 && plan.getString("rootProductId") == item.id) + val choices = XboxCatalog.objects(plan.getJSONArray("choices")).filter { it.optBoolean("supported") && it.optString("kind") == "Game" } + check(choices.isNotEmpty()) { "This offer has no supported PC package." } + if (plan.getString("status") == "ready" && choices.size == 1) { + val selected = item.copy(extra = item.extra + ("contentId" to choices.single().getString("contentId"))) + com.droiddeck.launcher.stores.download.SavedQueue.remember(app, selected, root) + enqueue(app, selected, root) + } else StoresState.post { packageChoice = PackageChoice(item, root, choices) } + } catch (e: Exception) { + DownloadQueue.recordFailed(app, DownloadEntry(store, item.id, item.title), e.message ?: "Xbox package could not be resolved.") { install(app, item, root) } + } + }, "xbox-package").start() + } + + fun update(context: Context, game: InstalledStoreGame) { + check(!XboxRuntime.isActive(game.sidecar.id)) { "Close this Xbox game before updating it." } + val sidecar = game.sidecar + val item = CatalogItem(store, sidecar.id, sidecar.title, sidecar.hero, tallImageUrl = sidecar.cover, + owned = sidecar.extra["access"] == "owned", subscription = sidecar.extra["access"] == "gamepass", extra = sidecar.extra) + val root = game.folder.parentFile!!.parentFile!! + com.droiddeck.launcher.stores.download.SavedQueue.remember(context, item, root) + enqueue(context, item, root) + } + + private fun enqueue(context: Context, item: CatalogItem, root: File) { + val app = context.applicationContext + val folder = StoreInstallRoot.folderFor(app, store, item.id, item.title, root) + val entry = DownloadEntry(store, item.id, item.title, cover = item.imageUrl, bytesTotal = item.sizeBytes, + location = StoreInstallRoot.labelFor(app, folder)) + DownloadQueue.enqueue(app, entry) { XboxInstaller(app, item, folder) } + } + + override fun uninstall(context: Context, game: InstalledStoreGame) {} +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCatalog.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCatalog.kt new file mode 100644 index 0000000000..bb3fab4a2e --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCatalog.kt @@ -0,0 +1,107 @@ +package com.droiddeck.launcher.stores.xbox + +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreNet +import org.json.JSONArray +import org.json.JSONObject +import java.time.Instant + +internal object XboxCatalog { + private val productId = Regex("[A-Z0-9]{12}") + private val plans = setOf("CFQ7TTC0KGQ8", "CFQ7TTC0KHS0", "CFQ7TTC0P85B", "CFQ7TTC0K5DJ", "CFQ7TTC0K6L8", "CFQ7TTC10QFD") + + fun access(json: JSONObject, account: String, market: String, now: Instant = Instant.now()): Map { + require(json.getInt("schema") == 1 && json.getString("account") == account && json.getString("market") == market) + val age = java.time.Duration.between(timestamp(json.getString("checkedAt")), now).seconds + require(age in -60..299) + val array = json.getJSONArray("entitlements") + require(array.length() <= 10_000) + val rows = LinkedHashMap() + val blocked = HashSet() + for (i in 0 until array.length()) { + val row = array.optJSONObject(i) ?: continue + val id = row.optString("productId") + if (!productId.matches(id)) continue + val valid = row.opt("status") is String && row.opt("isTrial") is Boolean && row.opt("special") is Boolean && + row.opt("sharingSource") is String && runCatching { timestamp(row.getString("endDate")) }.isSuccess && + (row.isNull("satisfiedByProductId") || productId.matches(row.optString("satisfiedByProductId"))) + if (!valid || id in rows || id in blocked) { blocked.add(id); rows.remove(id) } else rows[id] = row + } + fun kind(id: String, visited: Set = emptySet()): String? { + if (id in blocked || id in visited || visited.size >= 16) return null + val row = rows[id] ?: return null + if (row.getString("status") != "Active" || row.getBoolean("isTrial") || row.getBoolean("special") || + row.getString("sharingSource") != "None" || !timestamp(row.getString("endDate")).isAfter(now)) return null + val parent = row.optString("satisfiedByProductId").takeUnless { it.isBlank() || it == "null" } + if (parent == null) return if (id in plans) null else "owned" + if (parent in blocked) return null + if (parent in plans) return "gamepass" + return kind(parent, visited + id) + } + return rows.keys.mapNotNull { id -> kind(id)?.let { id to it } }.toMap() + } + + private fun timestamp(value: String): Instant = java.time.OffsetDateTime.parse(value).toInstant() + + fun products(ids: List, access: Map = emptyMap(), market: String = Xodus.market()): List { + return rawProducts(ids, market).mapNotNull { product(it, access) } + } + + fun rawProducts(ids: List, market: String = Xodus.market()): List { + return ids.map { it.uppercase() }.filter { productId.matches(it) }.distinct().chunked(25).flatMap { batch -> + val body = get("https://displaycatalog.mp.microsoft.com/v7.0/products?bigIds=${batch.joinToString(",")}&market=$market&languages=en-us,neutral") + objects(body.optJSONArray("Products")).filter { it.optString("ProductId").uppercase() in batch } + } + } + + fun search(query: String, access: Map): List { + if (productId.matches(query.uppercase())) return products(listOf(query.uppercase()), access) + if (query.length !in 2..100) return emptyList() + val q = java.net.URLEncoder.encode(query, "UTF-8") + val body = get("https://apps.microsoft.com/api/products/search?query=$q&mediaType=games&age=all&price=all&category=all&subscription=all&gl=${Xodus.market()}&hl=en-us") + val ids = objects(body.optJSONArray("productsList")).map { it.optString("productId") }.take(60) + return products(ids, access) + } + + fun featured(access: Map): List { + val body = get("https://apps.microsoft.com/api/Reco/GetComputedProductsList?listName=TopTrending&pgNo=1&noItems=12&filteredCategories=AllProducts&mediaType=Games&gl=${Xodus.market()}&hl=en-us&exp=0") + return products(objects(body.optJSONArray("productsList")).map { it.optString("productId") }.take(24), access) + } + + internal fun product(json: JSONObject, access: Map): CatalogItem? { + val id = json.optString("ProductId").uppercase() + if (!productId.matches(id) || json.optString("ProductType") != "Game") return null + val localized = objects(json.optJSONArray("LocalizedProperties")).firstOrNull() ?: return null + val title = localized.optString("ProductTitle").takeIf { it.isNotBlank() } ?: return null + val packages = objects(json.optJSONArray("DisplaySkuAvailabilities")).flatMap { + objects(it.optJSONObject("Sku")?.optJSONObject("Properties")?.optJSONArray("Packages")) + } + val pc = packages.filter { pkg -> objects(pkg.optJSONArray("PlatformDependencies")).any { it.optString("PlatformName") == "Windows.Desktop" } } + if (pc.none { it.optString("PackageFormat").equals("MSIXVC", true) }) return null + val images = objects(localized.optJSONArray("Images")) + fun image(vararg kinds: String): String? = kinds.firstNotNullOfOrNull { purpose -> + images.firstOrNull { it.optString("ImagePurpose") == purpose }?.optString("Uri")?.let { raw -> + val url = if (raw.startsWith("//")) "https:$raw" else raw + runCatching { java.net.URI(url) }.getOrNull()?.takeIf { + it.scheme == "https" && it.host in setOf("store-images.s-microsoft.com", "store-images.microsoft.com") && it.userInfo == null && it.port == -1 + }?.toString() + } + } + val kind = access[id] + return CatalogItem(Store.XBOX, id, title, image("SuperHeroArt", "Hero", "BoxArt"), + tallImageUrl = image("TitledPoster", "Poster", "BoxArt"), + owned = kind == "owned", subscription = kind == "gamepass", + storeUrl = "https://www.xbox.com/games/store/$id", + publisher = localized.optString("PublisherName"), developer = localized.optString("DeveloperName"), + description = localized.optString("ProductDescription"), + sizeBytes = pc.maxOfOrNull { it.optLong("MaxDownloadSizeInBytes") } ?: 0L, + extra = mapOf("market" to Xodus.market(), "access" to kind.orEmpty()), + ) + } + + fun objects(array: JSONArray?): List = if (array == null) emptyList() else + (0 until array.length()).mapNotNull { array.optJSONObject(it) } + + private fun get(url: String): JSONObject = JSONObject(StoreNet.get(url) ?: error("Microsoft Store could not be reached. Try again.")) +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxContent.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxContent.kt new file mode 100644 index 0000000000..1594dee927 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxContent.kt @@ -0,0 +1,105 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.setValue +import com.droiddeck.launcher.stores.* +import org.json.JSONObject +import java.io.File + +internal object XboxContent { + data class Offer(val item: CatalogItem, val installed: Boolean) + data class Plan(val base: InstalledStoreGame, val offers: List, val error: String? = null) + var plan by mutableStateOf(null) + private set + fun dismiss() { plan = null } + + fun manage(context: Context, base: InstalledStoreGame) { + val app = context.applicationContext + Thread({ + try { + val manifest = XboxManifest.read(base.folder) + check(manifest.storeId.matches(Regex("[A-Z0-9]{12}"))) { "The package has no valid Store ID." } + val account = StoreAccounts.signedInAs(app, Store.XBOX) ?: error("Sign in to Xbox first.") + val market = base.sidecar.extra["market"] ?: Xodus.market() + val licenses = XboxCatalog.access(Xodus.run(app, listOf("library", "--json", "--market", market)), account, market) + val products = XboxCatalog.rawProducts(listOf(manifest.storeId) + manifest.related, market) + val baseProduct = products.singleOrNull { it.optString("ProductId") == manifest.storeId } + val families = packages(baseProduct).map { it.optString("PackageFamilyName") }.filter { it.startsWith(manifest.name + "_") }.toSet() + val offers = products.filter { it.optString("ProductId") in manifest.related && it.optString("ProductType") == "Durable" }.mapNotNull { product -> + val id = product.getString("ProductId") + val access = licenses[id] ?: return@mapNotNull null + val packages = packages(product).filter { it.optString("MainPackageFamilyNameForDlc") in families } + .distinctBy { it.optString("ContentId") } + if (packages.size != 1) return@mapNotNull null + val pkg = packages.single() + val cid = pkg.optString("ContentId") + if (!cid.matches(Regex("[0-9a-fA-F-]{36}"))) return@mapNotNull null + val localized = XboxCatalog.objects(product.optJSONArray("LocalizedProperties")).firstOrNull() + val item = CatalogItem(Store.XBOX, id, localized?.optString("ProductTitle")?.ifBlank { id } ?: id, + imageUrl = base.sidecar.cover, owned = access == "owned", subscription = access == "gamepass", + sizeBytes = pkg.optLong("MaxDownloadSizeInBytes"), + extra = mapOf("baseId" to base.sidecar.id, "contentId" to cid, "market" to market, "family" to pkg.getString("PackageFamilyName"))) + Offer(item, File(base.folder, ".xbox-content/$id/.droiddeck-content.json").isFile) + } + StoresState.post { plan = Plan(base, offers) } + } catch (e: Exception) { StoresState.post { plan = Plan(base, emptyList(), e.message ?: "Xbox content could not be loaded.") } } + }, "xbox-content").start() + } + + private fun packages(product: JSONObject?): List = XboxCatalog.objects(product?.optJSONArray("DisplaySkuAvailabilities")) + .filter { it.optJSONObject("Sku")?.optJSONObject("Properties")?.optBoolean("IsTrial", true) == false } + .flatMap { XboxCatalog.objects(it.optJSONObject("Sku")?.optJSONObject("Properties")?.optJSONArray("Packages")) } + .filter { pkg -> pkg.optString("PackageFormat") == "MSIXVC" && + XboxCatalog.objects(pkg.optJSONArray("PlatformDependencies")).any { it.optString("PlatformName") == "Windows.Desktop" } } + + private val parents = java.util.concurrent.ConcurrentHashMap() + fun busy(base: String): Boolean = StoresState.latestDownloads.any { it.isActive && parents[it.id] == base } + + fun install(context: Context, item: CatalogItem) { + plan = null + val base = runCatching { base(context, item) }.getOrElse { error -> + StoresState.post { StoresState.problems[Store.XBOX] = error.message ?: "The base game is not available." } + return + } + if (XboxRuntime.isActive(base.sidecar.id)) { + StoresState.post { StoresState.problems[Store.XBOX] = "Close the Xbox game before changing its content." } + return + } + parents[item.id] = base.sidecar.id + val folder = File(base.folder, ".xbox-content/${item.id}") + if (folder.canonicalPath != base.folder.canonicalPath + "/.xbox-content/${item.id}") { + StoresState.post { StoresState.problems[Store.XBOX] = "The Xbox content folder contains a link outside this game." } + return + } + com.droiddeck.launcher.stores.download.SavedQueue.remember(context, item, base.folder.parentFile!!.parentFile!!) + com.droiddeck.launcher.stores.download.DownloadQueue.enqueue(context, + com.droiddeck.launcher.stores.download.DownloadEntry(Store.XBOX, item.id, item.title, cover = item.imageUrl, bytesTotal = item.sizeBytes)) { + XboxInstaller(context.applicationContext, item, folder) + } + } + + fun base(context: Context, item: CatalogItem): InstalledStoreGame { + require(item.id.matches(Regex("[A-Z0-9]{12}"))) + val id = item.extra["baseId"] ?: error("Missing Xbox base game") + val folder = StoreInstallRoot.gameFolders(context).firstOrNull { StoreGameSidecar.read(it)?.let { s -> s.store == Store.XBOX && s.id == id && s.isInstalled } == true } + ?: error("The Xbox base game is not installed.") + return InstalledStoreGame(StoreGameSidecar.read(folder)!!, folder) + } + + fun complete(context: Context, item: CatalogItem, folder: File) { + val base = base(context, item) + val parent = XboxManifest.read(base.folder) + val content = XboxManifest.read(folder) + check(item.id in parent.related && content.storeId == item.id && content.dependency == parent.name && content.publisher == parent.publisher && item.extra["family"].orEmpty().startsWith(content.name + "_")) { + "The downloaded content does not belong to this Xbox game." + } + require(folder.canonicalPath == base.folder.canonicalPath + "/.xbox-content/${item.id}") + val marker = File(folder, ".droiddeck-content.json") + val temporary = File(folder, marker.name + ".tmp") + temporary.writeText(JSONObject().put("productId", item.id).put("parent", base.sidecar.id) + .put("contentId", item.extra["contentId"]).put("version", content.version).toString()) + check(temporary.renameTo(marker)) + } +} 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 new file mode 100644 index 0000000000..14a2a8a89c --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt @@ -0,0 +1,86 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import android.net.LocalServerSocket +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreAccounts +import org.json.JSONArray +import org.json.JSONObject +import java.io.Closeable +import java.io.InputStream +import java.util.UUID + +internal class XboxCredentials(private val app: Context) : Closeable { + val name = "droiddeck-xbox-${UUID.randomUUID()}" + private val generation = storage(app) { epoch(app) } + private val server = LocalServerSocket(name) + @Volatile private var closed = false + + init { + Thread({ + while (!closed) { + val socket = runCatching { server.accept() }.getOrNull() ?: break + socket.use { + it.soTimeout = 10_000 + val reply = runCatching { + check(it.peerCredentials.uid == android.os.Process.myUid()) + storage(app) { + check(epoch(app) == generation) + answer(JSONObject(readLine(it.inputStream.buffered(), 2_097_152))) + } + }.getOrElse { JSONObject().put("ok", false) } + runCatching { it.outputStream.write((reply.toString() + "\n").toByteArray()) } + } + } + }, "xbox-credentials").start() + } + + private fun answer(request: JSONObject): JSONObject { + val key = request.getString("key") + require(key.isNotEmpty() && key.length <= 512) + val record = StoreAccounts.read(app, Store.XBOX) + check(!StoreAccounts.isUnavailable(Store.XBOX)) + val json = record ?: JSONObject() + val slots = json.optJSONObject("slots") ?: JSONObject().also { json.put("slots", it) } + val result = JSONObject().put("ok", true) + when (request.getString("op")) { + "get" -> result.put("value", slots.opt(key) ?: JSONObject.NULL) + "set" -> { + val bytes = request.getJSONArray("value") + require(bytes.length() <= 262_144) + for (i in 0 until bytes.length()) require(bytes.getInt(i) in 0..255) + slots.put(key, bytes) + StoreAccounts.write(app, Store.XBOX, json) + } + "remove" -> { slots.remove(key); StoreAccounts.write(app, Store.XBOX, json) } + else -> error("Invalid credential operation") + } + return result + } + + override fun close() { closed = true; runCatching { server.close() } } + + companion object { + val lock = Any() + private fun epoch(app: Context): String = runCatching { java.io.File(StoreAccounts.dir(app, Store.XBOX), "generation").readText() }.getOrDefault("") + fun invalidate(app: Context) = storage(app) { + java.io.File(StoreAccounts.dir(app, Store.XBOX), "generation").writeText(UUID.randomUUID().toString()) + StoreAccounts.clear(app, Store.XBOX) + } + fun storage(app: Context, block: () -> T): T = synchronized(lock) { + java.io.RandomAccessFile(java.io.File(StoreAccounts.dir(app, Store.XBOX), "account.lock"), "rw").use { file -> + file.channel.lock().use { block() } + } + } + fun readLine(input: InputStream, limit: Int): String { + val out = java.io.ByteArrayOutputStream() + while (out.size() <= limit) { + val byte = input.read() + if (byte == 10) return out.toString("UTF-8") + if (byte < 0) throw java.io.EOFException("Xbox backend disconnected") + out.write(byte) + } + error("Xbox backend response exceeded its limit") + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxInstaller.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxInstaller.kt new file mode 100644 index 0000000000..44e9ceff33 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxInstaller.kt @@ -0,0 +1,104 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import com.droiddeck.launcher.stores.* +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.CountDownLatch +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicBoolean + +internal class XboxInstaller(private val app: Context, private val item: CatalogItem, private val folder: File) : DownloadQueue.DownloadJob { + private val cancelled = AtomicBoolean(false) + private val paused = CountDownLatch(1) + @Volatile private var child: Xodus.Child? = null + @Volatile private var delete = false + + override fun run(handle: DownloadQueue.JobHandle): String? { + if (cancelled.get()) return null + check(StoreAccounts.signedInAs(app, Store.XBOX) != null) { "Sign in to Xbox before installing." } + val market = item.extra["market"]?.takeIf { it.matches(Regex("[A-Z]{2}")) } ?: Xodus.market() + val selected = item.extra["contentId"].orEmpty() + require(selected.matches(Regex("[a-fA-F0-9-]{36}"))) { "Select a PC game package before installing." } + val content = !item.extra["baseId"].isNullOrBlank() + if (content) { + check(!XboxRuntime.isActive(item.extra["baseId"].orEmpty())) { "Close the base game before changing Xbox content." } + check(item.id in XboxManifest.read(XboxContent.base(app, item).folder).related) { "This content is not related to the base game." } + val base = XboxContent.base(app, item) + require(folder.canonicalPath == base.folder.canonicalPath + "/.xbox-content/${item.id}") + File(folder, ".droiddeck-content.json").delete() + folder.mkdirs() + } else { + check(!XboxRuntime.isActive(item.id)) { "Close this Xbox game before updating it." } + StoreInstalls.markUpdating(folder) + StoreInstalls.begin(folder, Store.XBOX, item.id, item.title, item.tallImageUrl, item.imageUrl) + } + var complete = false + var sequence = -1L + try { + val source = if (content) selected else item.id + val selection = if (content) emptyList() else listOf("--selected-content-id", selected) + Xodus.start(app, listOf("streaming", source, folder.path, "--market", market, + "--progress-json", "--control-stdin") + selection).use { process -> + child = process + val diagnostics = Xodus.diagnostics(process) + if (cancelled.get()) process.process.destroy() + process.process.inputStream.bufferedReader().useLines { lines -> lines.forEach { line -> + if (line.startsWith("NEXUS_PROGRESS ")) { + val progress = JSONObject(line.removePrefix("NEXUS_PROGRESS ")) + require(progress.getInt("schema") == 1 && progress.getLong("sequence") > sequence) + sequence = progress.getLong("sequence") + if (progress.optBoolean("paused")) paused.countDown() + when (progress.getString("phase")) { + "complete" -> complete = true + "downloading", "download", "transfer" -> handle.progress(progress.getLong("completedBytes"), progress.optLong("totalBytes")) + "finalizing", "installing" -> handle.stage(DownloadStage.INSTALL) + else -> handle.stage(DownloadStage.MANIFEST) + } + } + } } + check(process.process.waitFor(15, TimeUnit.SECONDS)) { "Xbox installer did not exit." } + diagnostics.join(2000) + if (cancelled.get()) return null + check(process.process.exitValue() == 0 && complete) { "Xbox download did not complete. Resume to retry with fresh licenses." } + } + if (content) { + XboxContent.complete(app, item, folder) + return folder.path + } + val exe = executable(folder) + StoreInstalls.complete(app, folder, StoreGameSidecar(Store.XBOX, item.id, item.title, exe, + installVersion = XboxManifest.read(folder).version, installedAt = System.currentTimeMillis(), cover = item.tallImageUrl, hero = item.imageUrl, + extra = item.extra + mapOf("contentId" to selected, "market" to market))) + return folder.path + } finally { + child = null + if (delete && !item.extra["baseId"].isNullOrBlank()) StoreInstalls.deleteTree(folder) + else if (delete) StoreInstalls.discard(app, folder, emptyList()) + } + } + + override fun cancel(deleteFiles: Boolean) { + cancelled.set(true) + delete = deleteFiles + val process = child + if (process == null) { + if (deleteFiles && !item.extra["baseId"].isNullOrBlank()) StoreInstalls.deleteTree(folder) + else if (deleteFiles) StoreInstalls.discard(app, folder, emptyList()) + return + } + Thread({ + runCatching { + process.send(JSONObject().put("schema", 1).put("command", "pause")) + paused.await(3, TimeUnit.SECONDS) + } + process.close() + }, "xbox-download-stop").start() + } + + companion object { + internal fun executable(folder: File): String = XboxManifest.executable(folder) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCache.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCache.kt new file mode 100644 index 0000000000..bf9e7ee703 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCache.kt @@ -0,0 +1,57 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import org.json.JSONArray +import org.json.JSONObject + +internal object XboxLibraryCache { + data class Snapshot(val games: List, val savedAt: Long) { + fun needsRefresh(force: Boolean, now: Long = System.currentTimeMillis()): Boolean = + force || now - savedAt !in 0 until 15 * 60 * 1000L + } + + private fun prefs(app: Context) = app.getSharedPreferences("xbox", Context.MODE_PRIVATE) + fun read(app: Context, account: String, market: String): Snapshot? = + decode(prefs(app).getString("library", null), account, market) + + fun write(app: Context, account: String, market: String, games: List) { + check(prefs(app).edit().putString("library", encode(account, market, games)).commit()) + } + + fun clear(app: Context) { prefs(app).edit().remove("library").commit() } + + internal fun encode(account: String, market: String, games: List, now: Long = System.currentTimeMillis()): String = + JSONObject().put("schema", 1).put("account", account).put("market", market).put("savedAt", now) + .put("games", JSONArray().apply { + for (game in games) put(JSONObject().put("id", game.id).put("title", game.title) + .put("image", game.imageUrl).put("poster", game.tallImageUrl).put("description", game.description) + .put("developer", game.developer).put("publisher", game.publisher).put("size", game.sizeBytes) + .put("access", if (game.subscription) "gamepass" else if (game.owned) "owned" else "none")) + }).toString() + + internal fun decode(text: String?, account: String, market: String, now: Long = System.currentTimeMillis()): Snapshot? = runCatching { + require(text != null && text.length <= 8_000_000) + val json = JSONObject(text) + require(json.getInt("schema") == 1 && json.getString("account") == account && json.getString("market") == market) + val savedAt = json.getLong("savedAt") + require(savedAt > 0 && savedAt <= now + 60_000) + val rows = json.getJSONArray("games") + require(rows.length() <= 10_000) + val games = (0 until rows.length()).map { index -> + val row = rows.getJSONObject(index) + val id = row.getString("id") + val title = row.getString("title") + val access = row.getString("access") + require(id.matches(Regex("[A-Z0-9]{12}")) && title.isNotBlank() && access in setOf("owned", "gamepass")) + CatalogItem(Store.XBOX, id, title, row.optString("image").takeIf { it.isNotEmpty() }, + tallImageUrl = row.optString("poster").takeIf { it.isNotEmpty() }, + description = row.optString("description"), developer = row.optString("developer"), publisher = row.optString("publisher"), + sizeBytes = row.optLong("size"), owned = access == "owned", subscription = access == "gamepass", + storeUrl = "https://www.xbox.com/games/store/$id", extra = mapOf("market" to market, "access" to access)) + } + require(games.map { it.id }.distinct().size == games.size) + Snapshot(games, savedAt) + }.getOrNull() +} 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 new file mode 100644 index 0000000000..2192767fcf --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxLoginActivity.kt @@ -0,0 +1,182 @@ +package com.droiddeck.launcher.stores.xbox + +import android.annotation.SuppressLint +import android.graphics.Color +import android.net.Uri +import android.os.Bundle +import android.webkit.CookieManager +import android.webkit.WebResourceRequest +import android.webkit.WebView +import android.webkit.WebViewClient +import android.widget.Button +import android.widget.LinearLayout +import android.widget.TextView +import androidx.activity.ComponentActivity +import androidx.webkit.WebViewCompat +import androidx.webkit.WebViewFeature +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreAccounts +import org.json.JSONObject +import java.util.concurrent.TimeUnit + +class XboxLoginActivity : ComponentActivity() { + private lateinit var host: LinearLayout + private lateinit var status: TextView + private var view: WebView? = null + @Volatile private var child: Xodus.Child? = null + @Volatile private var session = 0L + @Volatile private var closed = false + + @SuppressLint("SetJavaScriptEnabled") + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + host = LinearLayout(this).apply { orientation = LinearLayout.VERTICAL; setBackgroundColor(Color.BLACK) } + status = TextView(this).apply { setTextColor(Color.WHITE); text = "Preparing Microsoft sign-in…"; setPadding(24, 16, 24, 16) } + host.addView(status) + host.addView(Button(this).apply { text = getString(com.droiddeck.launcher.R.string.stores_login_close); setOnClickListener { finish() } }) + setContentView(host) + if (android.os.Build.VERSION.SDK_INT < 28 || !WebViewFeature.isFeatureSupported(WebViewFeature.WEB_MESSAGE_LISTENER) || + !WebViewFeature.isFeatureSupported(WebViewFeature.DOCUMENT_START_SCRIPT)) { + status.text = "Update Android System WebView to sign in to Xbox." + return + } + CookieManager.getInstance().removeAllCookies { begin() } + } + + private fun begin() { + if (closed) return + Thread({ + if (closed) return@Thread + try { + Xodus.start(applicationContext, listOf("--external-webview-stdio", "login")).use { process -> + child = process + if (closed) return@use + Xodus.diagnostics(process) + val timer = Thread({ + runCatching { if (!process.process.waitFor(10, TimeUnit.MINUTES)) process.process.destroy() } + }, "xbox-login-timeout").apply { start() } + var ready = false + var latest = 0L + val input = process.process.inputStream.buffered() + while (!closed) { + val line = try { XboxCredentials.readLine(input, 131_072) } catch (e: java.io.EOFException) { break } + if (!line.startsWith("NEXUS_AUTH_V1 ")) continue + val frame = JSONObject(line.removePrefix("NEXUS_AUTH_V1 ")) + when (frame.getString("type")) { + "ready" -> { + check(!ready && frame.getInt("version") == 1) + ready = true + process.send(JSONObject().put("type", "hello").put("version", 1)) + } + "open" -> { + val next = frame.getLong("session") + check(ready && next > latest && next <= 32 && trusted(frame.getString("url"))) + latest = next; session = next + runOnUiThread { if (!closed) open(frame) } + } + "close" -> { + check(frame.getLong("session") == session) + session = 0L + runOnUiThread { disposeView(); status.text = "Completing Microsoft sign-in…" } + } + "context" -> { + check(frame.getLong("session") == session) + val context = frame.getString("context") + check(context.length <= 4096) + val message = JSONObject().put("type", "callback").put("value", JSONObject() + .put("name", "CloudExperienceHost.getContext") + .put("args", org.json.JSONArray(listOf("CloudExperienceHost", "TokenBroker", "TokenBroker", "{\"PrivatePropertyBag\":1,\"PasswordlessConnect\":1,\"PreferAssociate\":1,\"ChromelessUI\":0}"))) + .put("context", context)) + val active = session + runOnUiThread { if (active == session && trusted(view?.url.orEmpty())) view?.evaluateJavascript( + "globalThis['CloudExperienceHost.Bridge.dispatchMessage'](${JSONObject.quote(message.toString())})", null) } + } + else -> error("Unsupported Xbox sign-in response") + } + } + check(process.process.waitFor(5, TimeUnit.SECONDS) && process.process.exitValue() == 0 && ready && latest > 0 && session == 0L) + timer.interrupt() + } + child = null + if (closed) return@Thread + val account = Xodus.run(applicationContext, listOf("account", "--json")) + check(account.optBoolean("stored")) + XboxCredentials.storage(this) { + val record = StoreAccounts.read(this, Store.XBOX) ?: error("Xbox credentials missing") + record.put("username", account.getString("username")) + StoreAccounts.write(this, Store.XBOX, record) + } + 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." } + } + }, "xbox-login").start() + } + + @SuppressLint("SetJavaScriptEnabled") + private fun open(frame: JSONObject) { + disposeView() + val active = frame.getLong("session") + val web = WebView(this) + view = web + web.settings.apply { + javaScriptEnabled = true; domStorageEnabled = true + allowFileAccess = false; allowContentAccess = false + mixedContentMode = android.webkit.WebSettings.MIXED_CONTENT_NEVER_ALLOW + userAgentString = "Mozilla/5.0 (Windows NT 10.0; Win64; x64; MSAppHost/3.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36 Edge/18.26100" + } + WebViewCompat.addWebMessageListener(web, "droiddeckXbox", origins) { _, message, origin, mainFrame, _ -> + val payload = message.data + if (mainFrame && trusted(origin.toString()) && trusted(web.url.orEmpty()) && active == session && payload != null && payload.toByteArray().size <= 65_536) { + runCatching { child?.send(JSONObject().put("type", "ipc").put("session", active).put("payload", payload)) } + } + } + WebViewCompat.addDocumentStartJavaScript(web, + "if(window===window.top){Object.defineProperty(globalThis.external,'notify',{value:p=>{if(typeof p==='string')droiddeckXbox.postMessage(p)},configurable:false,writable:false})}", origins) + web.webViewClient = object : WebViewClient() { + override fun shouldOverrideUrlLoading(view: WebView, request: WebResourceRequest): Boolean = !trusted(request.url.toString()) + override fun onPageFinished(view: WebView, url: String) { + if (!trusted(url)) { finish(); return } + status.text = "Microsoft sign-in" + val uri = Uri.parse(url) + if (uri.host == "login.live.com" && uri.path == "/ppsecure/post.srf") { + view.evaluateJavascript("JSON.stringify(globalThis.ServerData ?? null)") { raw -> + val payload = runCatching { org.json.JSONArray("[$raw]").getString(0) }.getOrNull() + if (active == session && payload != null && payload != "null" && payload.length <= 65_536) runCatching { + child?.send(JSONObject().put("type", "ipc").put("session", active).put("payload", payload)) + } + } + } + } + } + host.addView(web, LinearLayout.LayoutParams(-1, 0, 1f)) + val headers = frame.getJSONObject("headers") + val values = headers.keys().asSequence().associateWith { key -> + require(key in allowedHeaders) + headers.getString(key).also { value -> require(value.length <= 4096 && value.all { it in ' '..'~' }) } + } + web.loadUrl(frame.getString("url"), values) + } + + private fun disposeView() { view?.let { host.removeView(it); it.stopLoading(); it.destroy() }; view = null } + override fun onDestroy() { + closed = true + val current = child; child = null + Thread({ runCatching { current?.close() } }, "xbox-login-close").start() + disposeView() + CookieManager.getInstance().removeAllCookies(null) + android.webkit.WebStorage.getInstance().deleteAllData() + super.onDestroy() + } + + companion object { + 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") + internal fun trusted(value: String): Boolean = runCatching { + val url = java.net.URI(value) + url.scheme == "https" && url.host in hosts && url.port == -1 && url.userInfo == null + }.getOrDefault(false) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxManifest.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxManifest.kt new file mode 100644 index 0000000000..d738193ed7 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxManifest.kt @@ -0,0 +1,70 @@ +package com.droiddeck.launcher.stores.xbox + +import java.io.File +import org.xmlpull.v1.XmlPullParser + +internal object XboxManifest { + data class Info(val storeId: String, val name: String, val publisher: String, val version: String, + val dependency: String, val related: List, val executables: List) + + fun read(folder: File): Info { + val manifests = folder.listFiles().orEmpty().filter { it.name.equals("MicrosoftGame.config", true) && it.isFile } + require(manifests.size == 1) { "Missing or ambiguous MicrosoftGame.config." } + val manifest = manifests.single() + require(manifest.length() <= 1_048_576) + val parser = android.util.Xml.newPullParser().apply { setFeature(XmlPullParser.FEATURE_PROCESS_DOCDECL, false) } + val identities = ArrayList>() + val storeIds = ArrayList() + val dependencies = ArrayList() + val related = ArrayList() + val entries = ArrayList() + fun attribute(name: String) = parser.getAttributeValue(null, name).orEmpty() + var root = false + var elements = 0 + manifest.inputStream().use { input -> + parser.setInput(input, null) + while (true) { + when (parser.nextToken()) { + XmlPullParser.END_DOCUMENT -> break + XmlPullParser.DOCDECL -> error("Xbox game manifests cannot contain a DTD.") + XmlPullParser.START_TAG -> { + require(++elements <= 10_000 && parser.depth <= 64) { "Xbox game manifest is too complex." } + if (parser.depth == 1) { require(!root && parser.name == "Game"); root = true } + when (parser.name) { + "Identity" -> identities.add(listOf(attribute("Name"), attribute("Publisher"), attribute("Version"))) + "StoreId" -> storeIds.add(parser.nextText().trim()) + "MainPackageDependency" -> dependencies.add(attribute("Name")) + "RelatedProduct" -> related.add(parser.nextText().trim()) + "Executable" -> { + val path = attribute("Name").replace('\\', '/') + if (path.endsWith(".exe", true) && attribute("TargetDeviceFamily") in listOf("", "PC", "Windows.Desktop") && + !attribute("IsDevOnly").equals("true", true)) entries.add(path) + } + } + } + } + } + } + require(root && identities.size <= 1 && storeIds.size <= 1 && dependencies.size <= 1) { "Invalid Xbox game manifest." } + val ids = related.distinct() + require(ids.size <= 128 && ids.all { it.matches(Regex("[A-Z0-9]{12}")) }) + val identity = identities.singleOrNull() + return Info(storeIds.singleOrNull().orEmpty(), identity?.get(0).orEmpty(), identity?.get(1).orEmpty(), identity?.get(2).orEmpty(), + dependencies.singleOrNull().orEmpty(), ids, entries) + } + + fun executable(folder: File): String { + for (path in read(folder).executables) { + require(!path.startsWith('/') && !path.contains(':') && path.split('/').none { it == ".." || it.isEmpty() }) + var file = folder + for (part in path.split('/')) { + val matches = file.listFiles().orEmpty().filter { it.name.equals(part, true) } + require(matches.size == 1) { "Missing or ambiguous Xbox launch path." } + file = matches.single() + } + require(file.canonicalPath.startsWith(folder.canonicalPath + File.separator)) + if (file.isFile) return file.relativeTo(folder).invariantSeparatorsPath + } + error("The Xbox package has no supported PC launch executable.") + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxRuntime.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxRuntime.kt new file mode 100644 index 0000000000..be4d0611b7 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxRuntime.kt @@ -0,0 +1,46 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import com.droiddeck.launcher.session.SessionState +import com.droiddeck.launcher.stores.* +import org.json.JSONObject +import java.io.File + +internal object XboxRuntime { + private var child: Xodus.Child? = null + private var owner: String? = null + private val activeGames = HashMap() + @Synchronized fun isActive(id: String): Boolean = activeGames.getOrDefault(id, 0) > 0 + @Synchronized fun released(id: String) { + val count = activeGames.getOrDefault(id, 0) + if (count <= 1) activeGames.remove(id) else activeGames[id] = count - 1 + } + + @Synchronized fun prepare(app: Context, id: String): JSONObject { + check(!XboxContent.busy(id)) { "Wait for Xbox content downloads to finish" } + check(SessionState.running) { "No running DroidDeck session" } + check(StoreGameSidecar.find(app, Store.XBOX, id)?.isInstalled == true) { "Xbox game is not installed" } + val account = StoreAccounts.signedInAs(app, Store.XBOX) ?: error("Sign in to Xbox before playing") + val socket = File(app.filesDir, "xbox-runtime/xodus.sock") + if (child?.process?.isAlive != true || owner != account) { + stop() + socket.delete() + val service = Xodus.start(app, emptyList(), service = true) + child = service; owner = account + Xodus.diagnostics(service) + Thread({ runCatching { service.process.inputStream.use { val buffer = ByteArray(8192); while (it.read(buffer) >= 0) {} } } }, "xbox-service-output").start() + val deadline = android.os.SystemClock.elapsedRealtime() + 90_000 + while (!socket.exists() && service.process.isAlive && SessionState.running && android.os.SystemClock.elapsedRealtime() < deadline) Thread.sleep(100) + if (!socket.exists() || !service.process.isAlive || !SessionState.running) { + stop(); error("Xbox account service did not become ready. Check your sign-in and network connection.") + } + } + activeGames[id] = activeGames.getOrDefault(id, 0) + 1 + return JSONObject().put("ok", true).put("socket", socket.path).put("credentials", child!!.credentialSocket) + } + + @Synchronized fun stop() { + val process = child; child = null; owner = null; activeGames.clear() + runCatching { process?.close() } + } +} 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 new file mode 100644 index 0000000000..668ed9b3d3 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt @@ -0,0 +1,106 @@ +package com.droiddeck.launcher.stores.xbox + +import android.content.Context +import android.os.Environment +import com.droiddeck.launcher.runtime.LinuxRuntime +import com.droiddeck.launcher.session.SessionPrefs +import org.json.JSONObject +import java.io.Closeable +import java.io.File +import java.util.concurrent.TimeUnit + +internal object Xodus { + const val DIR = "/usr/local/lib/droiddeck-xbox" + fun market(): String = java.util.Locale.getDefault().country.uppercase().takeIf { it.matches(Regex("[A-Z]{2}")) } ?: "US" + + class Child(val process: Process, private val credentials: XboxCredentials) : Closeable { + val credentialSocket: String get() = credentials.name + @Synchronized fun send(frame: JSONObject) { + process.outputStream.write((frame.toString() + "\n").toByteArray()) + process.outputStream.flush() + } + override fun close() { + process.destroy() + if (!process.waitFor(2, TimeUnit.SECONDS)) process.destroyForcibly() + credentials.close() + } + } + + @Synchronized private fun stage(app: Context) { + val root = File(LinuxRuntime.rootDir(app), DIR.removePrefix("/")) + val packaged = app.assets.open("linuxfs$DIR/version").bufferedReader().use { it.readText() } + if (runCatching { File(root, "version").readText() }.getOrNull() == packaged) return + fun copy(relative: String) { + val entries = app.assets.list("linuxfs$DIR/$relative").orEmpty() + if (entries.isNotEmpty()) { entries.forEach { copy(if (relative.isEmpty()) it else "$relative/$it") }; return } + if (relative == "version") return + val file = File(root, relative) + file.parentFile?.mkdirs() + val staged = File(file.path + ".staged") + app.assets.open("linuxfs$DIR/$relative").use { input -> staged.outputStream().use { input.copyTo(it) } } + staged.setExecutable(true, false) + check(staged.renameTo(file)) + } + copy("") + File(root, "version").writeText(packaged) + } + + fun start(app: Context, args: List, service: Boolean = false): Child { + check(LinuxRuntime.isInstalled(app)) { "Install the Linux runtime before using Xbox." } + stage(app) + val binary = "$DIR/${if (service) "xodus-service" else "xodus-cli"}" + check(File(LinuxRuntime.rootDir(app), binary.removePrefix("/")).isFile) { "The Xbox backend is missing. Update the Linux runtime." } + val credentials = XboxCredentials(app) + try { + val runtime = File(app.filesDir, "xbox-runtime").apply { mkdirs() } + val command = LinuxRuntime.command(app, null, null, Environment.getExternalStorageDirectory(), listOf( + "/usr/bin/env", "HOME=/root", "XODUS_LOG=off", "RUST_LOG=off", + "XDG_RUNTIME_DIR=${runtime.path}", "DROIDDECK_XBOX_CREDENTIAL_SOCKET=${credentials.name}", binary, + ) + args) + val builder = ProcessBuilder(command).directory(LinuxRuntime.rootDir(app)) + builder.environment().apply { + remove("LD_PRELOAD"); remove("LD_AUDIT"); remove("LD_LIBRARY_PATH") + put("PROOT_LOADER", LinuxRuntime.prootLoader(app).path) + put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(app).path) + if (SessionPrefs.prootNoSeccomp(app)) put("PROOT_NO_SECCOMP", "1") + LinuxRuntime.prootLibraryPath(app).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + } + return Child(builder.start(), credentials) + } catch (e: Exception) { credentials.close(); throw e } + } + + fun run(app: Context, args: List, timeout: Long = 90): JSONObject { + start(app, args).use { child -> + val output = java.io.ByteArrayOutputStream() + var readError: Throwable? = null + val reader = Thread({ + try { + val buffer = ByteArray(8192) + child.process.inputStream.use { input -> + while (true) { + val count = input.read(buffer) + if (count < 0) break + check(output.size() + count <= 8_000_000) + output.write(buffer, 0, count) + } + } + } catch (t: Throwable) { readError = t; child.process.destroy() } + }, "xbox-result").apply { start() } + val diagnostic = diagnostics(child) + check(child.process.waitFor(timeout, TimeUnit.SECONDS)) { "Xbox request timed out. Try again." } + reader.join(3000); diagnostic.join(3000) + check(readError == null && !reader.isAlive) { "Xbox returned an invalid response." } + check(child.process.exitValue() == 0) { "Xbox request failed. Check your account and network connection." } + return JSONObject(output.toString("UTF-8")) + } + } + + fun diagnostics(child: Child): 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") + } } + } + }, "xbox-diagnostics").apply { start() } +} diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt b/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt index 8a22220177..e913dc6afc 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt @@ -29,6 +29,7 @@ internal fun sourceColours(source: String): SourceColours = when (source) { Store.GOG.id -> SourceColours(Color(0xFF3A1A3C), Color(0xFFE6A3EA), Color(0xFFC25BC8)) Store.EPIC.id -> SourceColours(Color(0xFF2A2A2A), Color(0xFFDDDDDD), Color(0xFFBDBDBD)) Store.AMAZON.id -> SourceColours(Color(0xFF3A2A0A), Color(0xFFFFC266), Color(0xFFFF9900)) + Store.XBOX.id -> SourceColours(Color(0xFF17381B), Color(0xFFC6EDC2), Color(0xFF70C850)) Store.ITCH.id -> SourceColours(Color(0xFF3A1A1E), Color(0xFFFFB3B3), Color(0xFFFF5C5C)) Library.SOURCE_STEAM -> SourceColours(Color(0xFF16293D), Color(0xFF7CC4FF), Color(0xFF1A9FFF)) FLATHUB -> SourceColours(Color(0xFF0B2E2B), Color(0xFF9FE3DD), FlathubTeal) @@ -41,6 +42,7 @@ internal fun sourceLabel(source: String): String = when (source) { Store.GOG.id -> Store.GOG.label Store.EPIC.id -> Store.EPIC.label Store.AMAZON.id -> Store.AMAZON.label + Store.XBOX.id -> Store.XBOX.label Store.ITCH.id -> Store.ITCH.label else -> stringResource(R.string.source_added) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StoresDetail.kt b/app/src/main/java/com/droiddeck/launcher/ui/StoresDetail.kt index 151a487dcb..8208cad306 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StoresDetail.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StoresDetail.kt @@ -97,7 +97,8 @@ internal fun StoreGameDetail(store: Store, key: String, s: FrontEndState, a: Fro installed != null -> stringResource(R.string.stores_eyebrow_installed) + " · " + com.droiddeck.launcher.stores.StoreInstallRoot.labelFor(ctx, installed.folder) download != null && download.location.isNotBlank() -> stringResource(R.string.stores_eyebrow_library) + " · " + download.location failedDownload != null && failedDownload.location.isNotBlank() -> stringResource(R.string.stores_eyebrow_library) + " · " + failedDownload.location - item?.owned == true -> stringResource(R.string.stores_eyebrow_library) + item?.subscription == true -> "PC Game Pass" + item?.accessible == true -> stringResource(R.string.stores_eyebrow_library) else -> stringResource(R.string.stores_eyebrow_store) } val size = (item?.sizeBytes ?: 0L).takeIf { it > 0 }?.let { " · " + formatBytes(it) } ?: "" @@ -118,12 +119,20 @@ internal fun StoreGameDetail(store: Store, key: String, s: FrontEndState, a: Fro when { installed != null -> { val gone = StoresState.uninstalling["${store.id}:$id"] - PrimaryButton(stringResource(R.string.stores_play), enabled = !s.busy && gone == null && download == null, main = true, icon = Icons.Filled.PlayArrow, modifier = leadOn) { + PrimaryButton(stringResource(R.string.stores_play), enabled = !s.busy && gone == null && download == null && (store != Store.XBOX || !com.droiddeck.launcher.stores.xbox.XboxContent.busy(id)), main = true, icon = Icons.Filled.PlayArrow, modifier = leadOn) { launchStoreGame(ctx, store, id, s, a) } ActionChip(stringResource(R.string.stores_in_steam), ok = true) + if (store == Store.XBOX) { + SecondaryButton("Update / verify", enabled = download == null && !com.droiddeck.launcher.stores.xbox.XboxRuntime.isActive(id)) { + com.droiddeck.launcher.stores.xbox.XboxBackend.update(ctx, installed) + } + SecondaryButton("Manage content", enabled = download == null) { + com.droiddeck.launcher.stores.xbox.XboxContent.manage(ctx, installed) + } + } if (gone != null) SecondaryButton(stringResource(R.string.stores_uninstalling), enabled = false, progress = gone) {} - else UninstallButton(title, installed, enabled = download == null) { + else UninstallButton(title, installed, enabled = download == null && (store != Store.XBOX || !com.droiddeck.launcher.stores.xbox.XboxContent.busy(id))) { StoresState.uninstall(ctx, installed) { StoresState.refresh(ctx); a.onLibraryChanged() } } } @@ -143,11 +152,11 @@ internal fun StoreGameDetail(store: Store, key: String, s: FrontEndState, a: Fro com.droiddeck.launcher.stores.download.DownloadQueue.clear(ctx, failedDownload.key) } } - item?.owned == true && StoresState.isUnfinished(item) -> { + item?.accessible == true && StoresState.isUnfinished(item) -> { InstallButton(stringResource(R.string.stores_resume_install), leadOn) { StoresState.requestInstall(ctx, item) } ConfirmButton(stringResource(R.string.stores_dl_clear), stringResource(R.string.stores_dl_cancel_confirm), compact = true) { StoresState.clearUnfinished(ctx, item) } } - item?.owned == true -> InstallButton( + item?.accessible == true -> InstallButton( if (item.sizeBytes > 0) stringResource(R.string.stores_install_size, formatBytes(item.sizeBytes)) else stringResource(R.string.stores_install), leadOn, ) { StoresState.requestInstall(ctx, item) } @@ -169,10 +178,10 @@ internal fun StoreGameDetail(store: Store, key: String, s: FrontEndState, a: Fro } val description = item?.let { com.droiddeck.launcher.stores.cleanStoreText(it.description) }.orEmpty() .takeUnless { it.trim().equals(title.trim(), ignoreCase = true) }.orEmpty() - val achievements = remember(store, id, item?.owned, installed) { + val achievements = remember(store, id, item?.accessible, installed) { when { StoreAchievements.forSource(store.id) == null -> null - item?.owned == true -> StoreAchievements.Game.of(item) + item?.accessible == true -> StoreAchievements.Game.of(item) installed != null -> StoreAchievements.Game.of(installed.sidecar) else -> null } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt index 3933450d4e..1feb8e2800 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt @@ -155,12 +155,41 @@ internal fun tabsFor(store: Store?): List = if (store == Store.AMAZON) T internal fun tabFor(store: Store?, tab: String): String = if (tab in tabsFor(store)) tab else "library" -private data class PaneKey(val chip: String, val tab: String, val signedIn: Boolean) +private data class PaneKey(val chip: String, val tab: String, val signedIn: Boolean, val accountsLoaded: Boolean) @OptIn(androidx.compose.ui.ExperimentalComposeUiApi::class, androidx.compose.animation.ExperimentalAnimationApi::class) @Composable internal fun StoresPage(s: FrontEndState, a: FrontEndActions, modifier: Modifier) { val ctx = LocalContext.current + com.droiddeck.launcher.stores.xbox.XboxContent.plan?.let { content -> + androidx.compose.material3.AlertDialog( + onDismissRequest = { com.droiddeck.launcher.stores.xbox.XboxContent.dismiss() }, + title = { Text("Xbox content") }, + text = { Column { + if (content.error != null) Text(content.error) + else if (content.offers.isEmpty()) Text("No licensed PC content packages are available for this game.") + content.offers.forEach { offer -> + androidx.compose.material3.TextButton(onClick = { com.droiddeck.launcher.stores.xbox.XboxContent.install(ctx, offer.item) }) { + Text(offer.item.title + if (offer.installed) " · Update / verify" else " · Install") + } + } + } }, + confirmButton = { androidx.compose.material3.TextButton(onClick = { com.droiddeck.launcher.stores.xbox.XboxContent.dismiss() }) { Text(stringResource(android.R.string.ok)) } }, + ) + } + com.droiddeck.launcher.stores.xbox.XboxBackend.packageChoice?.let { pending -> + androidx.compose.material3.AlertDialog( + onDismissRequest = { com.droiddeck.launcher.stores.xbox.XboxBackend.dismissPackages() }, + title = { Text("Choose PC content") }, + text = { Column { pending.choices.forEach { choice -> + androidx.compose.material3.TextButton(onClick = { com.droiddeck.launcher.stores.xbox.XboxBackend.selectPackage(ctx, choice) }) { + Text(choice.getString("title") + " (" + choice.getString("kind") + ")") + } + } } }, + confirmButton = {}, + dismissButton = { androidx.compose.material3.TextButton(onClick = { com.droiddeck.launcher.stores.xbox.XboxBackend.dismissPackages() }) { Text(stringResource(android.R.string.cancel)) } }, + ) + } val colors = MaterialTheme.colorScheme val narrow = LocalNarrowPane.current val padH = if (narrow) 14.dp else 22.dp @@ -175,6 +204,7 @@ internal fun StoresPage(s: FrontEndState, a: FrontEndActions, modifier: Modifier val pane = PaneKey( chip, if (store == null) "" else shownTab, store == null || (StoresState.isSignedIn(store) && StoresState.expired[store] != true), + store == null || StoresState.accountsLoaded, ) val grids = remember { HashMap() } val grid = grids.getOrPut(pane) { LazyGridState() } @@ -362,6 +392,9 @@ internal fun StoresPage(s: FrontEndState, a: FrontEndActions, modifier: Modifier when { k.chip == DOWNLOADS -> Column(Modifier.fillMaxWidth().verticalScroll(scroll).padding(top = 4.dp, bottom = 16.dp)) { StoresDownloadsPane(s, a) } st == null -> {} + !k.accountsLoaded -> Box(Modifier.fillMaxWidth().padding(top = 16.dp)) { + androidx.compose.material3.LinearProgressIndicator(Modifier.fillMaxWidth().height(3.dp)) + } !k.signedIn -> Box(Modifier.fillMaxWidth().verticalScroll(scroll).padding(top = 4.dp, bottom = 16.dp)) { SignInCard(st, viewportH - 20.dp) } else -> Storefront(st, k.tab, query, s, a, grids.getOrPut(k) { LazyGridState() }, onQuery = { query = it }, onOpen = { open(it) }, onTab = { switchTab(it) }) } @@ -541,10 +574,11 @@ private fun StoreChips( Box( Modifier.size(12.dp) .onGloballyPositioned { StoresMotion.dots[store] = it.boundsInRoot() } - .pulseRing(StoresMotion.pulses[store] ?: 0, c.dot), - ) { Box(Modifier.matchParentSize().clip(CircleShape).background(c.dot).alpha(if (signedIn) 1f else 0.35f)) } + .pulseRing(StoresMotion.pulses[store] ?: 0, c.dot) + .background(c.dot.copy(alpha = if (signedIn) 1f else 0.35f), CircleShape), + ) }, - description = store.label + if (signedIn) "" else " " + stringResource(R.string.stores_chip_signed_out), + description = store.label + if (signedIn || !StoresState.accountsLoaded) "" else " " + stringResource(R.string.stores_chip_signed_out), onFocused = onFocusChip, ) { onStore(store, rootBounds[store.id]) } } @@ -737,7 +771,7 @@ private fun Storefront( val q = query.trim().lowercase() val foundKeys = remember(found) { found.map { it.key }.toSet() } fun matches(i: CatalogItem) = q.isEmpty() || i.title.lowercase().contains(q) || i.key in foundKeys - fun shown(i: CatalogItem) = s.storesShowMature || !i.mature || i.owned + fun shown(i: CatalogItem) = s.storesShowMature || !i.mature || i.accessible fun shelf(l: List?) = l?.filter(::shown) val everything = remember(library, shelves, found) { (found + library + (shelves?.all ?: emptyList())).distinctBy { it.id } } LaunchedEffect(store, q) { StoresState.search(ctx, store, q) } @@ -788,7 +822,7 @@ private fun Storefront( CompletableFuture.allOf(*requests.map { it.second }.toTypedArray()).await() requests.forEach { (item, future) -> val bytes = future.getNow(null) ?: return@forEach - if (item.owned && item.sizeBytes <= 0) com.droiddeck.launcher.stores.StoreSizes.known[item.key] = bytes + if (item.accessible && item.sizeBytes <= 0) com.droiddeck.launcher.stores.StoreSizes.known[item.key] = bytes } resolvedSizeSortKey = candidateKeys } @@ -993,6 +1027,7 @@ internal fun storePalette(base: Palette, store: Store?): Palette { Store.GOG -> Color(0xFFC25BC8) to Color(0xFF9A3FA1) Store.EPIC -> Color(0xFFE6E6E6) to Color(0xFFBDBDBD) Store.AMAZON -> Color(0xFFFF9900) to Color(0xFFE07800) + Store.XBOX -> Color(0xFF70C850) to Color(0xFF107C10) Store.ITCH -> Color(0xFFFF5C5C) to Color(0xFFD93B3B) null -> return base } @@ -1259,7 +1294,7 @@ private fun GameCard( modifier = Modifier.fillMaxWidth() .onGloballyPositioned { c -> placed[0] = c - if (item.owned && item.sizeBytes <= 0) { + if (item.accessible && item.sizeBytes <= 0) { val b = c.boundsInWindow() if (b.bottom > -ahead && b.top < screen + ahead && b.width > 0f) com.droiddeck.launcher.stores.StoreSizes.request(ctx, item) } @@ -1352,9 +1387,9 @@ private fun CardMarker(item: CatalogItem, installed: Boolean, download: com.droi Icon(Icons.Filled.Check, stringResource(R.string.stores_installed_chip), tint = pal.good, modifier = Modifier.size(11.dp)) } download != null -> Text("${download.percent}%", fontSize = small, fontWeight = FontWeight.Bold, color = pal.signal, maxLines = 1) - item.owned && StoresState.isUnfinished(item) -> Text(stringResource(R.string.stores_resume), fontSize = small, fontWeight = FontWeight.Bold, color = pal.signal, maxLines = 1) - item.owned && compact -> Unit - item.owned -> com.droiddeck.launcher.stores.StoreSizes.size(item).takeIf { it > 0 }?.let { Text(formatBytes(it), fontSize = 11.sp, fontWeight = FontWeight.Bold, color = Color.White, maxLines = 1) } + item.accessible && StoresState.isUnfinished(item) -> Text(stringResource(R.string.stores_resume), fontSize = small, fontWeight = FontWeight.Bold, color = pal.signal, maxLines = 1) + item.accessible && compact -> Unit + item.accessible -> com.droiddeck.launcher.stores.StoreSizes.size(item).takeIf { it > 0 }?.let { Text(formatBytes(it), fontSize = 11.sp, fontWeight = FontWeight.Bold, color = Color.White, maxLines = 1) } item.isFree -> Text(stringResource(R.string.stores_free), fontSize = small, fontWeight = FontWeight.Bold, color = pal.good, maxLines = 1) item.isDiscounted -> Row(verticalAlignment = Alignment.CenterVertically, horizontalArrangement = Arrangement.spacedBy(4.dp)) { StateChip("-${item.discountPercent}%", ChipTone.DEAL, small = true) @@ -1430,9 +1465,16 @@ internal fun openUrl(ctx: android.content.Context, url: String) { internal fun launchStoreGame(ctx: android.content.Context, store: Store, id: String, s: FrontEndState, a: FrontEndActions) { val game = s.steamGames.firstOrNull { it.source == store.id && it.storeId == id } - if (game == null) { - android.widget.Toast.makeText(ctx, R.string.stores_launch_not_registered, android.widget.Toast.LENGTH_LONG).show() + if (game != null) { + com.droiddeck.launcher.stores.StoreLaunch.prepare(ctx, store, id) { a.onSteamGame(game) } return } - com.droiddeck.launcher.stores.StoreLaunch.prepare(ctx, store, id) { a.onSteamGame(game) } + val app = ctx.applicationContext + Thread({ + val installed = runCatching { com.droiddeck.launcher.stores.StoreLaunch.installedGame(app, store, id) }.getOrNull() + StoresState.post { + if (installed == null) android.widget.Toast.makeText(ctx, R.string.stores_launch_not_registered, android.widget.Toast.LENGTH_LONG).show() + else com.droiddeck.launcher.stores.StoreLaunch.prepare(ctx, store, id) { a.onSteamGame(installed) } + } + }, "store-play").start() } 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 aed81f1556..e0c657a147 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/StoreAccountsCipherTest.kt @@ -112,6 +112,25 @@ class StoreAccountsCipherTest { assertEquals(creds.toString(), StoreAccounts.read(app, Store.EPIC).toString()) } + @Test fun xboxNeverFallsBackToPlaintextWhenKeystoreFails() { + StoreAccounts.keys = broken + org.junit.Assert.assertThrows(IllegalStateException::class.java) { + StoreAccounts.write(app, Store.XBOX, JSONObject().put("username", "test@example.test").put("slots", JSONObject().put("user-tokens", "synthetic-secret"))) + } + assertFalse(file(Store.XBOX).exists()) + StoreAccounts.keys = fake + StoreAccounts.write(app, Store.XBOX, creds) + assertTrue(CredentialCipher.isEnvelope(JSONObject(file(Store.XBOX).readText()))) + } + + @Test fun xboxUsernameAndBackendSlotsAreEncryptedTogether() { + val xbox = JSONObject().put("username", "test@example.test").put("slots", JSONObject().put("user-tokens", "synthetic-secret")) + StoreAccounts.write(app, Store.XBOX, xbox) + assertFalse(file(Store.XBOX).readText().contains("synthetic-secret")) + assertFalse(file(Store.XBOX).readText().contains("test@example.test")) + assertEquals("test@example.test", StoreAccounts.signedInAs(app, Store.XBOX)) + } + @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/StoreLaunchTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/StoreLaunchTest.kt new file mode 100644 index 0000000000..898e074f6b --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/StoreLaunchTest.kt @@ -0,0 +1,56 @@ +package com.droiddeck.launcher.stores + +import android.app.Application +import com.droiddeck.launcher.frontend.AddedGames +import com.droiddeck.launcher.session.SessionPrefs +import org.junit.Assert.* +import org.junit.Test +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], application = Application::class) +class StoreLaunchTest { + private val app get() = RuntimeEnvironment.getApplication() + + private fun install(state: String = StoreGameSidecar.STATE_INSTALLED): File { + SessionPrefs.setGameStorage(app, SessionPrefs.GAME_STORAGE_OFF, "") + val folder = File(StoreInstallRoot.storeDir(StoreInstallRoot.installRoot(app), Store.XBOX), "Deep Rock Galactic") + File(folder, "FSD/Binaries/WinGDK/FSD.exe").apply { parentFile!!.mkdirs(); writeText("licensed image") } + StoreGameSidecar(Store.XBOX, "9NHFVWX1V7QJ", "Deep Rock Galactic", "FSD/Binaries/WinGDK/FSD.exe", state = state).write(folder) + return folder + } + + @Test fun aCompletedInstallCanLaunchBeforeTheFrontendLibraryRefreshes() { + val folder = install() + val game = StoreLaunch.installedGame(app, Store.XBOX, "9NHFVWX1V7QJ")!! + val added = AddedGames.single(app, folder.path)!! + assertEquals("xbox", game.source) + assertEquals("9NHFVWX1V7QJ", game.storeId) + assertEquals(folder, game.gameFiles) + assertEquals(added.gameId, game.gameId) + assertTrue(added.guestExe.endsWith("/FSD/Binaries/WinGDK/FSD.exe")) + } + + @Test fun unfinishedPackagesCannotBecomePlayableThroughTheFallback() { + for (state in listOf(StoreGameSidecar.STATE_INSTALLING, StoreGameSidecar.STATE_UPDATING)) { + install(state) + assertNull(StoreLaunch.installedGame(app, Store.XBOX, "9NHFVWX1V7QJ")) + } + } + + @Test fun anotherStoreOrProductCannotUseTheXboxInstall() { + install() + assertNull(StoreLaunch.installedGame(app, Store.GOG, "9NHFVWX1V7QJ")) + assertNull(StoreLaunch.installedGame(app, Store.XBOX, "OTHERPRODUCT")) + } + + @Test fun aMissingExecutableDoesNotBecomeALaunchTarget() { + val folder = install() + File(folder, "FSD/Binaries/WinGDK/FSD.exe").delete() + assertNull(StoreLaunch.installedGame(app, Store.XBOX, "9NHFVWX1V7QJ")) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxCatalogTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxCatalogTest.kt new file mode 100644 index 0000000000..5eb1f2e3ce --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxCatalogTest.kt @@ -0,0 +1,77 @@ +package com.droiddeck.launcher.stores.xbox + +import org.json.JSONArray +import org.json.JSONObject +import org.junit.Assert.* +import org.junit.Test +import java.time.Instant + +@org.junit.runner.RunWith(org.robolectric.RobolectricTestRunner::class) +@org.robolectric.annotation.Config(sdk = [33], application = android.app.Application::class) +class XboxCatalogTest { + private val now = Instant.parse("2026-10-19T12:00:00Z") + private val game = "9AAAAAAAAAAA" + private val parent = "9BBBBBBBBBBB" + private val plan = "CFQ7TTC0KGQ8" + private fun row(id: String, parent: String? = null) = JSONObject().put("productId", id).put("status", "Active") + .put("isTrial", false).put("special", false).put("sharingSource", "None") + .put("endDate", "2099-01-01T00:00:00Z").put("satisfiedByProductId", parent ?: JSONObject.NULL) + private fun envelope(vararg rows: JSONObject) = JSONObject().put("schema", 1).put("account", "test@example.test") + .put("market", "US").put("checkedAt", now.toString()).put("entitlements", JSONArray(rows.toList())) + private fun access(vararg rows: JSONObject) = XboxCatalog.access(envelope(*rows), "test@example.test", "US", now) + + @Test fun purchasedAndSubscriptionAccessRemainDistinct() { + assertEquals(mapOf(game to "owned", parent to "gamepass"), access(row(game), row(parent, plan))) + assertFalse(access(row(plan)).containsKey(plan)) + } + + @Test fun backendRfc3339OffsetsAndNanosecondsAreAccepted() { + val checked = "2026-10-19T19:02:38.173609086+00:00" + val response = envelope(row(game).put("endDate", "2099-01-01T01:00:00.000000001+01:00")) + .put("checkedAt", checked) + assertEquals(mapOf(game to "owned"), XboxCatalog.access(response, "test@example.test", "US", + Instant.parse("2026-10-19T19:02:39Z"))) + } + + @Test fun expiredTrialSharedAndUnknownFlagsDoNotGrantAccess() { + for ((key, value) in listOf("status" to "Expired", "isTrial" to true, "special" to true, + "sharingSource" to "Family", "endDate" to "2020-01-01T00:00:00Z")) { + assertTrue(access(row(game).put(key, value)).isEmpty()) + } + } + + @Test fun malformedAndConflictingParentsCannotGrantDependentAccess() { + assertTrue(access(row(game, parent), row(parent).put("isTrial", JSONObject.NULL)).isEmpty()) + assertTrue(access(row(game, plan), row(plan).put("endDate", "invalid")).isEmpty()) + assertTrue(access(row(game), row(game, plan)).isEmpty()) + assertTrue(access(row(game, parent), row(parent, game)).isEmpty()) + } + + @Test fun mismatchedAccountAndStaleResultsAreRejected() { + for (json in listOf(envelope(row(game)).put("account", "other@example.test"), + envelope(row(game)).put("checkedAt", "2020-01-01T00:00:00Z"))) { + assertThrows(IllegalArgumentException::class.java) { XboxCatalog.access(json, "test@example.test", "US", now) } + } + } + + @Test fun installedSubscriptionDoesNotBecomeOwnershipWithoutACachedLibrary() { + val sidecar = com.droiddeck.launcher.stores.StoreGameSidecar(com.droiddeck.launcher.stores.Store.XBOX, + game, "A game", "Game.exe", extra = mapOf("access" to "gamepass")) + val card = com.droiddeck.launcher.stores.installedCards(com.droiddeck.launcher.stores.Store.XBOX, + listOf(com.droiddeck.launcher.stores.InstalledStoreGame(sidecar, java.io.File("/synthetic-game"))), emptyList()).single() + assertFalse(card.owned); assertTrue(card.subscription) + } + + @Test fun consoleAndUwpOffersAreFilteredOut() { + fun product(platform: String, format: String) = JSONObject().put("ProductId", game).put("ProductType", "Game") + .put("LocalizedProperties", JSONArray().put(JSONObject().put("ProductTitle", "A PC game"))) + .put("DisplaySkuAvailabilities", JSONArray().put(JSONObject().put("Sku", JSONObject().put("Properties", JSONObject() + .put("Packages", JSONArray().put(JSONObject().put("PackageFormat", format).put("PlatformDependencies", + JSONArray().put(JSONObject().put("PlatformName", platform))))))))) + assertNull(XboxCatalog.product(product("Xbox.One", "MSIXVC"), mapOf(game to "owned"))) + assertNull(XboxCatalog.product(product("Windows.Desktop", "APPX"), mapOf(game to "owned"))) + val pc = XboxCatalog.product(product("Windows.Desktop", "MSIXVC"), mapOf(game to "gamepass"))!! + assertEquals(game, XboxCatalog.product(product("Windows.Desktop", "MSIXVC").put("ProductId", game.lowercase()), mapOf(game to "owned"))!!.id) + assertTrue(pc.accessible); assertTrue(pc.subscription); assertFalse(pc.owned) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCacheTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCacheTest.kt new file mode 100644 index 0000000000..8d545d20c4 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxLibraryCacheTest.kt @@ -0,0 +1,53 @@ +package com.droiddeck.launcher.stores.xbox + +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import org.junit.Assert.* +import org.junit.Test + +@org.junit.runner.RunWith(org.robolectric.RobolectricTestRunner::class) +@org.robolectric.annotation.Config(sdk = [33], application = android.app.Application::class) +class XboxLibraryCacheTest { + private val account = "test@example.test" + private val now = 1_792_440_000_000L + private fun game(id: String, subscription: Boolean) = CatalogItem(Store.XBOX, id, "A game", "https://example.test/hero", + tallImageUrl = "https://example.test/poster", description = "Description", developer = "Developer", publisher = "Publisher", + sizeBytes = 12345, owned = !subscription, subscription = subscription, storeUrl = "https://www.xbox.com/games/store/$id", + extra = mapOf("market" to "US", "access" to if (subscription) "gamepass" else "owned")) + + @Test fun restartRestoresMetadataWithoutTurningSubscriptionsIntoPurchases() { + val games = listOf(game("9AAAAAAAAAAA", false), game("9BBBBBBBBBBB", true)) + val text = XboxLibraryCache.encode(account, "US", games, now) + val cached = XboxLibraryCache.decode(text, account, "US", now)!! + assertEquals(games, cached.games) + assertFalse(cached.games[1].owned) + assertTrue(cached.games[1].subscription) + } + + @Test fun anotherAccountMarketOrInvalidEnvelopeCannotRestoreTheLibrary() { + val text = XboxLibraryCache.encode(account, "US", listOf(game("9AAAAAAAAAAA", false)), now) + assertNull(XboxLibraryCache.decode(text, "other@example.test", "US", now)) + assertNull(XboxLibraryCache.decode(text, account, "GB", now)) + assertNull(XboxLibraryCache.decode(text.replace("\"schema\":1", "\"schema\":2"), account, "US", now)) + assertNull(XboxLibraryCache.decode("invalid", account, "US", now)) + assertNull(XboxLibraryCache.decode(text, account, "US", now - 120_000)) + } + + @Test fun freshCacheAvoidsNetworkAndForceOrStalenessRequestsARefresh() { + val cached = XboxLibraryCache.Snapshot(emptyList(), now) + assertFalse(cached.needsRefresh(false, now + 899_999)) + assertTrue(cached.needsRefresh(false, now + 900_000)) + assertTrue(cached.needsRefresh(true, now)) + val old = XboxLibraryCache.decode(XboxLibraryCache.encode(account, "US", emptyList(), now), account, "US", now + 86_400_000)!! + assertTrue(old.needsRefresh(false, now + 86_400_000)) + assertTrue(old.games.isEmpty()) + } + + @Test fun clearingTheCacheRemovesThePersistedAccountLibrary() { + val app = org.robolectric.RuntimeEnvironment.getApplication() + XboxLibraryCache.write(app, account, "US", listOf(game("9AAAAAAAAAAA", false))) + assertNotNull(XboxLibraryCache.read(app, account, "US")) + XboxLibraryCache.clear(app) + assertNull(XboxLibraryCache.read(app, account, "US")) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxManifestTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxManifestTest.kt new file mode 100644 index 0000000000..99ab0a0eb6 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/xbox/XboxManifestTest.kt @@ -0,0 +1,55 @@ +package com.droiddeck.launcher.stores.xbox + +import org.junit.Assert.* +import org.junit.Rule +import org.junit.Test +import org.junit.rules.TemporaryFolder + +@org.junit.runner.RunWith(org.robolectric.RobolectricTestRunner::class) +@org.robolectric.annotation.Config(sdk = [33], application = android.app.Application::class) +class XboxManifestTest { + @get:Rule val temporary = TemporaryFolder() + @Test fun resolvesTheManifestExecutableWithWindowsLetterCasing() { + val root = temporary.newFolder() + java.io.File(root, "Bin").mkdir() + java.io.File(root, "Bin/Game.exe").writeText("encrypted") + java.io.File(root, "MicrosoftGame.Config").writeText("") + assertEquals("Bin/Game.exe", XboxInstaller.executable(root)) + } + @Test fun rejectsTraversalAndExternalEntities() { + for (xml in listOf("", + "]>&external;", + "", + "]>")) { + val root = temporary.newFolder() + java.io.File(root, "MicrosoftGame.config").writeText(xml) + assertThrows(Exception::class.java) { XboxInstaller.executable(root) } + } + } + @Test fun androidManifestParserPreservesIdentityAndSelectsTheRetailPcExecutable() { + val root = temporary.newFolder() + java.io.File(root, "Retail.exe").writeText("encrypted") + java.io.File(root, "MicrosoftGame.Config").writeText(""" + + + + + + 9AAAAAAAAAAA9BBBBBBBBBBB + """) + val info = XboxManifest.read(root) + assertEquals("9AAAAAAAAAAA", info.storeId) + assertEquals("Test.Game", info.name) + assertEquals("CN=A & B", info.publisher) + assertEquals("1.2.3.0", info.version) + assertEquals("Test.Base", info.dependency) + assertEquals(listOf("9BBBBBBBBBBB"), info.related) + assertEquals(listOf("Retail.exe"), info.executables) + assertEquals("Retail.exe", XboxManifest.executable(root)) + } + @Test fun signInBridgeRejectsUntrustedAndNonHttpsOrigins() { + assertTrue(XboxLoginActivity.trusted("https://login.live.com/ppsecure/InlineLogin.srf")) + for (url in listOf("http://login.live.com/", "https://login.live.com.evil.test/", "https://evil.test@login.live.com/", "https://login.live.com:8443/")) + assertFalse(XboxLoginActivity.trusted(url)) + } +} diff --git a/docs/development/xbox-store.md b/docs/development/xbox-store.md new file mode 100644 index 0000000000..e65ede5431 --- /dev/null +++ b/docs/development/xbox-store.md @@ -0,0 +1,106 @@ +# Xbox / PC Game Pass on Thor + +Branch: `feat/xbox-store`. This integrates PC Microsoft Store MSIXVC packages, +not Xbox console emulation or UWP/APPX packages. + +## Testing on Thor + +1. Open DroidDeck, select Stores, then Xbox and Sign in. Use the Microsoft account + that owns the game or has PC Game Pass access. An isolated Microsoft sign-in + window opens; complete its verification and return to DroidDeck. On later + starts, the saved account should restore without another sign-in prompt; + initial account loading uses a neutral progress indicator. +2. Refresh the Xbox library. Check a known owned PC game and, if applicable, a + Game Pass game. Subscription access is labeled PC Game Pass and does not + become permanent ownership. Console-only and unsupported package types are + filtered out. After the first successful sync, closing/reopening DroidDeck + should restore the saved library without waiting for Microsoft. Metadata is + scoped to account and market; on later starts, snapshots older than 15 minutes + refresh quietly in the background. Refresh checks immediately. + Downloading and launching still perform Microsoft licensing. +3. Start with a small licensed title such as LIMBO. Search `LIMBO` if needed; + the verified US Product ID is `9PNG83MDD6SH`. Install through the normal store + download queue. If an offer contains several PC base packages, choose the + intended game. A package plan is not a license: Microsoft licensing must + succeed before files can be installed. +4. Pause during transfer, resume, then repeat after closing/reopening DroidDeck. + It should retain partial files, refresh authenticated URLs and resume only + verified checkpoints. An error or cancelled process must never create an + installed/Play entry. Cancel removes a new installation's partial files. +5. Press Play as soon as installation completes, including while the main library + list is still refreshing. It should resolve the completed installation instead + of showing the "Steam picks the game up when it next starts" toast. + A launch taking over 20 seconds should not produce a duplicate Steam launch + or a "Game already running" dialog while licensing is still preparing it. + Steam/session startup uses the selected ARM64 Proton. + First launch prepares that game's prefix. Check that a window appears, the + game reaches its menu, controller buttons/axes work, and audio is audible. + Record the selected Proton, game/version, and any startup failure. +6. For a game with Xbox identity/cloud saves, check the gamertag, save something, + quit normally, wait for synchronization, then relaunch. Verify the save and, + where available, compare it on another legitimate Xbox PC installation. + In-game identity/cloud/multiplayer success is title-specific. +7. Close the game, then try Update / verify from its Xbox detail page. It uses + fresh licensed streaming and the existing download queue. Interrupted updates + remain resumable; do not judge an interrupted package as a complete install. +8. If you own related PC DLC, open Manage content. Only licensed, unambiguous + MSIXVC content associated with this game's package family is offered. Install + it, then relaunch and check that the game recognizes it. An account with no + such content should get an empty-content message. Base-game uninstall also + removes its managed content. +9. Sign out from Xbox. Installed files should remain, account library data should + clear, and Play/download licensing should require sign-in again. + +Do not uninstall DroidDeck or clear application data to troubleshoot this build. +The signed APK is installed in place to retain existing Steam and store data. + +## Evidence and limits + +Verified during development: + +- Native AArch64 CLI execution on Thor's existing Linux runtime. +- Abstract-socket credential transport with a synthetic account on Thor; this + does not establish a real Microsoft sign-in. +- Real Microsoft sign-in completed on Thor through the isolated Android host. + Its credential file is an Android Keystore AES-GCM envelope. +- Signed-in library refresh on Thor returns 13 compatible PC titles. RFC 3339 + offset timestamps from the backend are parsed by Android's offset-date parser. +- Two force-stop/reopen tests restored all 13 titles from the saved library + without a native Xbox account request. Cache tests cover account/market + isolation, explicit and stale refreshes, sign-out removal and subscription + metadata remaining distinct from purchases. +- Two further cold-start checks observed no sign-in prompt while the saved + account loaded; both restored all 13 titles and the installed launcher. +- Licensed Minecraft Launcher package download and manifest-selected executable + registration on Thor (`Minecraft.exe`, package version `2.6.2.0`). An initial + Android DOM feature failure was fixed with Android's DTD-rejecting pull parser; + retry reused the downloaded files. This launcher install does not validate + gameplay. +- Public LIMBO package resolution on Thor: a Windows.Desktop MSIXVC package. +- Native AMD64 Windows module loading through Thor's ARM64 Proton/FEX, including + the `InitializeApiImplEx2` Xbox runtime export. The original builtin markers + caused error 126; the reproducible native-marker adaptation resolves that. +- Minecraft Launcher's licensed executable was materialized by Xodus, started + through ARM64 Proton/FEX, completed its self-update, and rendered its full + Windows launcher with a Microsoft account displayed on Thor. The account + service remained running with the executable. Minecraft gameplay and in-game + Xbox services remain unverified. +- Deep Rock Galactic's GDK executable also loads through Xodus/ARM64 Proton. + Its default launch crashes in D3D12 ray-tracing pipeline creation. Disabling + ray tracing in Unreal reaches the rendered title screen on Thor; this workaround + is applied to `FSD-WinGDK-Shipping.exe`. Gameplay and online services remain + unverified. +- Account-free tests cover purchase/subscription separation, stale/wrong-account + responses, malformed parent licenses, manifest traversal/XXE rejection, + fail-closed encrypted credential writes, download checkpoint behavior, + private temporary launch views, bridge authentication, and ordinary store + launch regressions. + +Game rendering/input/audio, in-game account identity, cloud synchronization, +DLC activation and multiplayer require the account/game tests above. DLL +loading alone is not evidence of a playable game. +Native-module tests use a disposable prefix under +`/data/local/tmp/droiddeck-xbox-probe`; existing game prefixes are not used. + +Build recipes, pinned source revisions, hashes, notices and runtime architecture +are documented in [tools/xbox](../../tools/xbox/README.md). diff --git a/tools/build_local.sh b/tools/build_local.sh index c4c0e07dcf..e03c49befb 100755 --- a/tools/build_local.sh +++ b/tools/build_local.sh @@ -351,6 +351,13 @@ fi cd "${repo_root}" python3 tools/quest/build-driver.py "${NDK}" +xbox_out="${linuxfs_dir}/usr/local/lib/droiddeck-xbox" +xbox_key=$(inputs_hash "native-arm64-ubuntu24.04" tools/xbox) +if ! restore_step xbox "${xbox_key}" "${xbox_out}"; then + bash tools/xbox/build-local.sh + save_step xbox "${xbox_key}" "${xbox_out}" +fi + comet_out="${linuxfs_dir}/usr/local/lib/droiddeck-comet" comet_key=$(inputs_hash "${image_id}" tools/comet) if ! restore_step comet "${comet_key}" "${comet_out}"; then diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env index 30c8a25552..f83e93ae37 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env @@ -98,6 +98,12 @@ def godot_sentry(game): return {"WINEDLLOVERRIDES": ";".join(n + "=d" for n in sentry)}, [], "Godot: Sentry crash handler off" +@fix +def deep_rock_gdk_raytracing(game): + if game.stem == "fsd-wingdk-shipping" and not any(game.has_arg(arg) for arg in ("-raytracing", "-noraytracing")): + return {}, ["-noraytracing", "-ini:Engine:[/Script/Engine.RendererSettings]:r.RayTracing=False"], "Deep Rock Galactic GDK: ray tracing off (D3D12 pipeline creation fails on Thor)" + + @fix def arkham_city_x87(game): """Batman: Arkham City (BatmanAC.exe, also started through BmLauncher.exe beside it) leans on x87 @@ -310,6 +316,14 @@ def main(): if mic_enabled == "0": env["BANNER_AUDIO_DIRECT_MIC"] = "0" env = force_ssbs(command, env) + xbox = runpy.run_path(str(Path(__file__).with_name("droiddeck-xbox"))) + try: + xbox_result = xbox["launch"](command, env) + except (OSError, ValueError, KeyError, RuntimeError) as error: + print("droiddeck-game-env: Xbox launch could not start (%s)" % error, file=sys.stderr) + return 1 + if xbox_result is not None: + return xbox_result sync = load_sync() launch, launch_env = select_sync(command, env, sync) if launch[0] != command[0]: diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session index fdadc61ed4..1b2ae2f483 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session @@ -596,6 +596,7 @@ case $mode in steam_hold_launch() { local game=$1 shortcut= waited=0 status=0 _bl_focused() { xprop -root GAMESCOPE_FOCUSED_APP 2>/dev/null | sed -n 's/.*= *//p'; } + _bl_starting() { pgrep -f "reaper SteamLaunch AppId=$(((game >> 32) & 0xffffffff))( |$)" >/dev/null 2>&1; } _bl_hand_off() { printf '%s\n' "$game" > "$BL_LAUNCH_DIR/steam-game.tmp" && mv -f "$BL_LAUNCH_DIR/steam-game.tmp" "$BL_LAUNCH_DIR/steam-game" } @@ -610,16 +611,22 @@ case $mode in _bl_hand_off [ -n "$shortcut" ] || return 0 # Steam can drop a shortcut launch it gets before the shortcut's overview exists (large libraries). - # Hand it over again only if the game never took focus, so a launch that worked is not started twice. + # A launch can be running before it creates its first window. while [ "$(_bl_focused)" = 769 ] && [ "$waited" -lt 20 ]; do sleep 1 waited=$((waited + 1)) done [ "$(_bl_focused)" = 769 ] || return 0 + if _bl_starting; then + echo "== steam: the requested game is already starting; not launching again" + return 0 + fi echo "== steam: the game is not in front after about 20 s; waiting for the shortcut overview" /usr/local/bin/droiddeck-agent --wait-steam-shortcut-overview "$game" 45 || status=$? if [ "$status" -eq 3 ]; then echo "== steam: not a shortcut CGameID; not launching again" + elif _bl_starting; then + echo "== steam: the requested game started while waiting; not launching again" elif [ "$(_bl_focused)" = 769 ]; then echo "== steam: launching the requested game again $game (overview status $status)" _bl_hand_off diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-xbox b/tools/linuxfs/overlay/usr/local/bin/droiddeck-xbox new file mode 100755 index 0000000000..beec0a65b5 --- /dev/null +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-xbox @@ -0,0 +1,183 @@ +#!/usr/bin/python3 +"""Licensed Xbox launches through Xodus and the game's selected ARM64 Proton.""" +import hmac +import json +import os +from pathlib import Path +import runpy +import secrets +import shutil +import socket +import subprocess +import sys +import tempfile +import threading + +BIN = Path(__file__).resolve().parent +RUNTIME = Path('/usr/local/lib/droiddeck-xbox') +DLLS = ('xgameruntime.dll', 'winhttp.dll', 'windows.web.dll', 'twinapi.appcore.dll', 'libnghttp2.dll') + + +def bridge(upstream): + key = secrets.token_hex(32).encode('ascii') + server = socket.socket() + server.bind(('127.0.0.1', 0)) + server.listen(16) + clients = set() + lock = threading.Lock() + stopped = threading.Event() + + def forward(source, target): + try: + while not stopped.is_set(): + data = source.recv(65536) + if not data: + break + target.sendall(data) + except OSError: + pass + finally: + try: + target.shutdown(socket.SHUT_WR) + except OSError: + pass + + def connect(client): + remote = None + try: + client.settimeout(10) + supplied = b'' + while len(supplied) < len(key): + part = client.recv(len(key) - len(supplied)) + if not part: + return + supplied += part + if not hmac.compare_digest(supplied, key): + return + remote = socket.socket(socket.AF_UNIX) + remote.connect(upstream) + client.settimeout(None) + with lock: + clients.add(remote) + writer = threading.Thread(target=forward, args=(client, remote), daemon=True) + writer.start() + forward(remote, client) + writer.join(2) + except OSError: + pass + finally: + for sock in (client, remote): + if sock is not None: + with lock: + clients.discard(sock) + sock.close() + + def accept(): + while not stopped.is_set(): + try: + client, _ = server.accept() + except OSError: + break + with lock: + if len(clients) >= 64: + client.close() + continue + clients.add(client) + threading.Thread(target=connect, args=(client,), daemon=True).start() + + threading.Thread(target=accept, daemon=True).start() + + def close(): + stopped.set() + server.close() + with lock: + for client in clients: + try: + client.shutdown(socket.SHUT_RDWR) + except OSError: + pass + client.close() + clients.clear() + + return server.getsockname()[1], key.decode('ascii'), close + + +def wine(argv): + with open(os.environ['DROIDDECK_XBOX_COMMAND_FILE'], encoding='utf-8') as file: + command = json.load(file) + if len(command) < 3 or command[1] != 'waitforexitandrun' or len(argv) != 1: + raise ValueError('Invalid Xbox Proton invocation') + env = dict(os.environ) + env.pop('DROIDDECK_XBOX_CREDENTIAL_SOCKET', None) + env.pop('DROIDDECK_XBOX_COMMAND_FILE', None) + prefix = Path(os.environ['STEAM_COMPAT_DATA_PATH']) / 'pfx' + prefix.parent.mkdir(parents=True, exist_ok=True) + if not (prefix / 'system.reg').is_file(): + result = subprocess.run([command[0], 'run', 'cmd', '/c', 'exit', '0'], stdout=sys.stderr, env=env) + if result.returncode: + return result.returncode + system = prefix / 'drive_c/windows/system32' + system.mkdir(parents=True, exist_ok=True) + for name in DLLS: + target = system / name + if target.is_symlink(): + target.unlink() + shutil.copyfile(RUNTIME / 'windows' / name, target) + overrides = ';'.join(name[:-4] + '=n' for name in DLLS if name != 'libnghttp2.dll') + env['WINEDLLOVERRIDES'] = overrides + ';' + env.get('WINEDLLOVERRIDES', '') + return subprocess.call([*command[:2], argv[0], *command[3:]], env=env) + + +def launch(command, env): + if len(command) < 3 or command[1] != 'waitforexitandrun' or env.get('DROIDDECK_XBOX_ACTIVE') == '1': + return None + store = runpy.run_path(str(BIN / 'droiddeck-store-launch')) + found = store['find_store_game'](command[2:]) + if found is None or found[1].get('store') != 'xbox': + return None + folder, sidecar = found + for name in DLLS: + if not (RUNTIME / 'windows' / name).is_file(): + raise RuntimeError('Xbox Windows runtime is missing; update the Linux runtime') + launch_dir = env.get('BL_LAUNCH_DIR') + if not launch_dir: + raise RuntimeError('No Xbox account channel; start the game from DroidDeck') + reply = store['ask'](Path(launch_dir) / 'stores', {'op': 'xbox-prepare', 'id': sidecar['id']}, timeout=95) + if not reply or not reply.get('ok'): + raise RuntimeError('Xbox account service is unavailable; sign in again and retry') + port, key, close = bridge(reply['socket']) + try: + with tempfile.TemporaryDirectory(prefix='droiddeck-xbox-') as temporary: + context = Path(temporary) / 'command.json' + context.write_text(json.dumps(command), encoding='utf-8') + context.chmod(0o600) + owned_env = dict(env, DROIDDECK_XBOX_ACTIVE='1', DROIDDECK_XBOX_COMMAND_FILE=str(context), + DROIDDECK_XBOX_CREDENTIAL_SOCKET=reply['credentials'], + XODUS_SOCKET=reply['socket'], XODUS_BRIDGE_PORT=str(port), XODUS_BRIDGE_KEY=key, + XODUS_LOG='off', RUST_LOG='off', XODUS_SAVE_SYNC='auto' if sidecar.get('cloud', True) else 'off') + content = folder / '.xbox-content' + roots = [] + if content.is_dir(): + for entry in content.iterdir(): + try: + marker = json.loads((entry / '.droiddeck-content.json').read_text()) + if marker.get('parent') == sidecar['id'] and marker.get('productId') == entry.name and not entry.is_symlink(): + roots.append('Z:' + str(entry).replace('/', '\\')) + except (OSError, ValueError, TypeError): + pass + if roots: + owned_env['XODUS_CONTENT_ROOTS'] = ';'.join(roots) + market = sidecar.get('extra', {}).get('market', 'US') + return subprocess.call([str(RUNTIME / 'xodus-cli'), 'run', str(folder), str(BIN / 'droiddeck-xbox'), + '--exe', sidecar['exe'], '--materialize-chain', '--market', market], env=owned_env) + finally: + close() + store['ask'](Path(launch_dir) / 'stores', {'op': 'xbox-released', 'id': sidecar['id']}) + + +if __name__ == '__main__': + try: + sys.exit(wine(sys.argv[1:])) + except (OSError, ValueError, KeyError, RuntimeError): + print('droiddeck-xbox: Xbox launch failed; check your account, runtime and package.', file=sys.stderr) + sys.exit(1) diff --git a/tools/release/runtime_inputs.py b/tools/release/runtime_inputs.py index a539e46c4e..fefef3eab7 100644 --- a/tools/release/runtime_inputs.py +++ b/tools/release/runtime_inputs.py @@ -15,7 +15,7 @@ MANIFEST = Path('app/build/runtime-inputs.json') SOURCE_PATHS = ['app/build.gradle', 'app/src/main/cpp/fakeinput_steam.cpp', 'app/src/main/assets/pulseaudio.tzst', 'tools/linuxfs', 'tools/proot', 'tools/aaudio-sink', 'tools/directaudio', 'tools/gamescope/release.env', 'tools/droiddeck-esync/release.env', - 'tools/mangoapp', 'tools/msitools', 'tools/comet', 'tools/build_local.sh', + 'tools/mangoapp', 'tools/msitools', 'tools/comet', 'tools/xbox', 'tools/build_local.sh', 'tools/release/runtime_inputs.py', 'app/src/main/assets/desktop-removal', 'tools/quest', 'tools/vr/src', 'tools/vr/driver_droiddeck', 'tools/vr/layer', 'tools/vr/build.sh', 'app/src/main/cpp/waylandcomp/src/headpose_shm.h', @@ -89,6 +89,9 @@ def required(): ['mangoapp', 'libfmt.so.10', 'libspdlog.so.1.13', 'libglfw.so.3', 'libtraceevent.so.1', 'libtracefs.so.1']] paths += ['assets/linuxfs/usr/local/lib/droiddeck-comet/' + name for name in ['comet', 'GalaxyCommunication.exe', 'update-permissions.exe', 'LICENSE', 'version']] + paths += ['assets/linuxfs/usr/local/lib/droiddeck-xbox/' + name for name in + ['xodus-cli', 'xodus-service', 'version', 'backend.lock.json', 'runtime.lock.json', 'LICENSE.xodus', 'LICENSE.nexus', 'LICENSE.LGPL-2.1', 'LICENSE.nghttp2', + 'windows/xgameruntime.dll', 'windows/winhttp.dll', 'windows/windows.web.dll', 'windows/twinapi.appcore.dll', 'windows/libnghttp2.dll']] for driver in ['linux-wine11', 'linux-wine11-systhread']: paths += ['assets/directaudio/' + driver + '/' + name for name in ['aarch64-unix/winedirectaudio.so', 'aarch64-windows/winedirectaudio.drv', diff --git a/tools/tests/test_game_environment.py b/tools/tests/test_game_environment.py index 6757d46d6f..eaef4c6d01 100644 --- a/tools/tests/test_game_environment.py +++ b/tools/tests/test_game_environment.py @@ -179,6 +179,17 @@ class GameEnvironmentTest(unittest.TestCase): (other / "Other.exe").touch() self.assertEqual(MODULE["engine_fixes"](str(other / "Other.exe"), []), ({}, [], [])) + def test_deep_rock_gdk_avoids_the_raytracing_pipeline_crash(self): + game = "/game/FSD/Binaries/WinGDK/FSD-WinGDK-Shipping.exe" + env, extra, notes = MODULE["engine_fixes"](game, []) + self.assertEqual(extra, ["-noraytracing", "-ini:Engine:[/Script/Engine.RendererSettings]:r.RayTracing=False"]) + self.assertEqual(env, {}) + self.assertTrue(notes) + for choice in ("-raytracing", "-noraytracing"): + self.assertEqual(MODULE["engine_fixes"](game, [choice]), ({}, [], [])) + self.assertEqual(MODULE["engine_fixes"]("/game/FSD-Win64-Shipping.exe", []), ({}, [], [])) + self.assertEqual(MODULE["engine_fixes"]("/game/Other-WinGDK-Shipping.exe", []), ({}, [], [])) + def test_arkham_city_gets_full_x87_precision_over_the_preset(self): with tempfile.TemporaryDirectory() as tmp: city = Path(tmp) / "Batman Arkham City GOTY/Binaries/Win32" diff --git a/tools/tests/test_steam_cold_launch.py b/tools/tests/test_steam_cold_launch.py index 2c80a25467..162037eba9 100644 --- a/tools/tests/test_steam_cold_launch.py +++ b/tools/tests/test_steam_cold_launch.py @@ -1,4 +1,4 @@ -"""Requested Steam games are handed over as soon as the interface is up; a shortcut is handed over again only if it never took focus.""" +"""Retry a dropped shortcut without duplicating a launch that is still preparing its first window.""" import os from pathlib import Path import subprocess @@ -48,14 +48,21 @@ class SteamColdLaunchTest(unittest.TestCase): sleep = self.bin / "sleep" sleep.write_text("#!/bin/sh\nprintf '%s\n' \"$@\" >> \"$SLEEP_ARGS\"\n") sleep.chmod(0o755) + pgrep = self.bin / "pgrep" + pgrep.write_text( + "#!/bin/sh\n" + "printf '%s\\n' \"$@\" > \"$HOME/pgrep-args\"\n" + "n=$(cat \"$HOME/pgrep-count\" 2>/dev/null || echo 0); n=$((n + 1)); echo $n > \"$HOME/pgrep-count\"\n" + "[ \"$n\" -ge \"${RUNNING_AFTER:-999}\" ]\n") + pgrep.chmod(0o755) self.block = LAUNCH_BLOCK.replace("/usr/local/bin/droiddeck-agent", str(agent)) - def run_launch(self, target, focus="769", helper_status=0): + def run_launch(self, target, focus="769", helper_status=0, running_after=999): env = dict(os.environ, HOME=str(self.root), BL_LAUNCH_DIR=str(self.launch_dir), PATH=str(self.bin) + os.pathsep + os.environ["PATH"], AGENT_ARGS=str(self.agent_args), SLEEP_ARGS=str(self.sleep_args), AGENT_COUNT=str(self.agent_count), AGENT_STATUS=str(helper_status), - FOCUS=focus, FOCUS_COUNT=str(self.focus_count)) + FOCUS=focus, FOCUS_COUNT=str(self.focus_count), RUNNING_AFTER=str(running_after)) script = self.block + "\nprintf 'ARG:%s\n' \"$@\"\nwait\n" url = target if target.startswith("steam://") else "steam://rungameid/" + target result = subprocess.run(["bash", "-c", script, "cold-launch", url], @@ -85,6 +92,20 @@ class SteamColdLaunchTest(unittest.TestCase): self.assertEqual(2, len(self.hand_offs(result)), result.stdout) self.assertIn("overview status 1", result.stdout) + def test_a_game_still_starting_without_a_window_is_not_launched_twice(self): + result = self.run_launch(SHORTCUT, running_after=1) + self.assertEqual(1, len(self.hand_offs(result)), result.stdout) + self.assertFalse(self.agent_args.exists()) + self.assertEqual(["-f", "reaper SteamLaunch AppId=3551182975( |$)"], + (self.root / "pgrep-args").read_text().splitlines()) + self.assertIn("already starting", result.stdout) + + def test_a_game_starting_during_the_overview_wait_is_not_launched_twice(self): + result = self.run_launch(SHORTCUT, running_after=2) + self.assertEqual(1, len(self.hand_offs(result)), result.stdout) + self.assertTrue(self.agent_args.exists()) + self.assertIn("started while waiting", result.stdout) + def test_a_game_that_takes_focus_during_the_overview_wait_is_not_started_twice(self): focus = " ".join(["769"] * 23) + " 4242" result = self.run_launch(SHORTCUT, focus=focus, helper_status=0) diff --git a/tools/tests/test_xbox_launch.py b/tools/tests/test_xbox_launch.py new file mode 100644 index 0000000000..7419dd62c9 --- /dev/null +++ b/tools/tests/test_xbox_launch.py @@ -0,0 +1,73 @@ +import json +import os +from pathlib import Path +import runpy +import socket +import tempfile +import threading +import unittest +from unittest.mock import patch + +BIN = Path(__file__).resolve().parents[1] / 'linuxfs/overlay/usr/local/bin' +xbox = runpy.run_path(str(BIN / 'droiddeck-xbox')) + + +class XboxLaunchTest(unittest.TestCase): + def test_other_stores_keep_their_existing_launch(self): + with tempfile.TemporaryDirectory() as root: + folder = Path(root) + (folder / '.droiddeck-store.json').write_text(json.dumps({'store': 'gog', 'id': '1'})) + self.assertIsNone(xbox['launch'](['/proton', 'waitforexitandrun', str(folder / 'Game.exe')], {})) + + def test_bridge_authenticates_before_forwarding(self): + with tempfile.TemporaryDirectory() as root: + path = str(Path(root) / 'service.sock') + upstream = socket.socket(socket.AF_UNIX) + upstream.bind(path); upstream.listen(1); upstream.settimeout(3) + received = [] + def serve(): + connection, _ = upstream.accept() + with connection: + received.append(connection.recv(8)) + connection.sendall(b'reply') + worker = threading.Thread(target=serve); worker.start() + port, key, close = xbox['bridge'](path) + try: + with socket.create_connection(('127.0.0.1', port), timeout=2) as denied: + denied.sendall(b'x' * 64) + self.assertEqual(denied.recv(1), b'') + with socket.create_connection(('127.0.0.1', port), timeout=2) as client: + client.sendall(key[:20].encode()) + client.sendall(key[20:].encode() + b'request') + self.assertEqual(client.recv(5), b'reply') + worker.join(3) + self.assertFalse(worker.is_alive()) + self.assertEqual(received, [b'request']) + finally: + close(); upstream.close() + + def test_wine_wrapper_preserves_selected_proton_args_and_prefix_isolation(self): + with tempfile.TemporaryDirectory() as root: + root = Path(root) + prefix = root / 'compat/pfx' + prefix.mkdir(parents=True) + runtime = root / 'runtime/windows'; runtime.mkdir(parents=True) + for name in xbox['DLLS']: + (runtime / name).write_bytes(b'MZ-synthetic') + command = root / 'command.json' + command.write_text(json.dumps(['/selected/proton', 'waitforexitandrun', '/encrypted/Game.exe', '--custom', 'two words'])) + env = {'STEAM_COMPAT_DATA_PATH': str(prefix.parent), 'DROIDDECK_XBOX_COMMAND_FILE': str(command), + 'DROIDDECK_XBOX_CREDENTIAL_SOCKET': 'private-account-channel', 'XODUS_BRIDGE_KEY': 'runtime-key'} + with patch.dict(os.environ, env), patch.dict(xbox['wine'].__globals__, RUNTIME=runtime.parent), patch('subprocess.run') as initialize, patch('subprocess.call', return_value=7) as call: + initialize.return_value.returncode = 0 + self.assertEqual(xbox['wine'](['/private-view/Game.exe']), 7) + argv = call.call_args.args[0] + self.assertEqual(argv, ['/selected/proton', 'waitforexitandrun', '/private-view/Game.exe', '--custom', 'two words']) + self.assertIn('xgameruntime=n', call.call_args.kwargs['env']['WINEDLLOVERRIDES']) + self.assertEqual((prefix / 'drive_c/windows/system32/xgameruntime.dll').read_bytes(), b'MZ-synthetic') + initialize.assert_called_once() + for child in (initialize, call): + child_env = child.call_args.kwargs['env'] + self.assertNotIn('DROIDDECK_XBOX_CREDENTIAL_SOCKET', child_env) + self.assertNotIn('DROIDDECK_XBOX_COMMAND_FILE', child_env) + self.assertEqual(child_env['XODUS_BRIDGE_KEY'], 'runtime-key') diff --git a/tools/xbox/LICENSE.LGPL-2.1 b/tools/xbox/LICENSE.LGPL-2.1 new file mode 100644 index 0000000000..732811e4f1 --- /dev/null +++ b/tools/xbox/LICENSE.LGPL-2.1 @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/tools/xbox/LICENSE.nexus b/tools/xbox/LICENSE.nexus new file mode 100644 index 0000000000..6c103f8ac9 --- /dev/null +++ b/tools/xbox/LICENSE.nexus @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Xodus Nexus contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/tools/xbox/LICENSE.nghttp2 b/tools/xbox/LICENSE.nghttp2 new file mode 100644 index 0000000000..80201792ec --- /dev/null +++ b/tools/xbox/LICENSE.nghttp2 @@ -0,0 +1,23 @@ +The MIT License + +Copyright (c) 2012, 2014, 2015, 2016 Tatsuhiro Tsujikawa +Copyright (c) 2012, 2014, 2015, 2016 nghttp2 contributors + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/tools/xbox/LICENSE.xodus b/tools/xbox/LICENSE.xodus new file mode 100644 index 0000000000..f288702d2f --- /dev/null +++ b/tools/xbox/LICENSE.xodus @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/tools/xbox/README.md b/tools/xbox/README.md new file mode 100644 index 0000000000..bb4e8ec3f0 --- /dev/null +++ b/tools/xbox/README.md @@ -0,0 +1,79 @@ +# Xbox backend for DroidDeck + +DroidDeck uses the Nexus backend protocol with a native Linux AArch64 CLI and +service. It does not install the Nexus desktop launcher or x86 Linux Wine. +`backend.lock.json` pins Xodus, the Nexus commit, Rust, and the ordered patch +checksums. `runtime.lock.json` pins the Nexus Windows runtime release and each +extracted PE DLL. `prepare.py` verifies both source revisions and all Nexus patch +checksums before applying the two local transport/launch patches. + +Build on AArch64 Ubuntu 24.04 with Rust from the lock, a C/C++ compiler, OpenSSL +development headers, pkg-config, protoc, CMake, Git, Python 3 and xz: + +```sh +bash tools/xbox/build.sh +``` + +On macOS, `bash tools/xbox/build-local.sh` uses an AArch64 Ubuntu container. +`tools/build_local.sh` includes this step and caches it by recipe inputs. CI +builds the same recipe on `ubuntu-24.04-arm` and transfers the result to the APK +job. Cache hits still download that build's Xbox artifact before APK assembly. +The build runs account-free CLI, credential and streaming tests. It retains the +patched backend source archive and the checksum-verified runtime source archive +in the build cache and publishes both in CI's `xbox-corresponding-source` +artifact; distribute corresponding sources with published binaries. + +`droiddeck-credentials.patch` replaces Linux Secret Service with a bounded, +UID-checked Android abstract socket. The Android host encrypts every persistent +write using its existing Keystore cipher, verifies backend read-backs, and +rejects writes when Keystore is unavailable. No token values enter process +arguments, external storage, application logs or a plaintext credential file. +Account-generation invalidation prevents a signed-out child's later writes from +restoring credentials. Each process gets its own unguessable socket name. +The Proton initialization and game processes do not inherit the raw credential +channel or command-file environment variables. The authenticated GDK bridge +remains available to the game. Like the other stores, games share DroidDeck's +Linux environment and Android UID; this is not a sandbox against malicious games. + +Microsoft sign-in uses Nexus's private stdio protocol in an isolated Android +WebView process. Its page bridge is restricted to the allowed Microsoft/Xbox +HTTPS origins and the main frame; it has no credential-store or launcher API. +Cookies and page storage are cleared for each attempt. This protocol requires +an embedded host for CloudExperienceHost messages; opening its URL in an ordinary +Android browser does not complete it. Passkey behavior needs device testing. + +`droiddeck-launch-view.patch` materializes all licensed encrypted images, +including DLLs, in a private temporary directory. Original package files remain +encrypted, and the temporary view is removed after the Wine child exits. Wine +receives normal files with no Xodus FD-map requirement. This costs temporary +storage proportional to the encrypted images. The app keeps the account service +alive for the session; an authenticated loopback bridge carries GDK requests. +Wine's builtin PE marker makes `WINEDLLOVERRIDES=n` reject the Nexus modules. +The extractor verifies their original hashes, then changes only that 16-byte DOS +stub marker to `DroidDeck native`; code, imports and exports stay unchanged. This +lets ARM64EC Wine load the AMD64 modules through its normal native DLL path. +Only each Xbox game's prefix receives these Windows modules. Existing +Steam games and other store prefixes retain their selected runtimes. + +Cloud saves and in-game identity use the reused XGameRuntime/service interfaces; +those are game-dependent. Entitlements distinguish purchases from Game Pass +access, and the backend performs a fresh license check for downloads and launch. +The store lists PC MSIXVC games only. It does not emulate Xbox consoles or add +support for UWP/APPX packages. Update / verify refreshes an installed package through the normal licensed +streaming path. Manage content resolves manifest-related licensed PC DLC into +separate content roots and checks its parent identity after download. These +flows still require game/account validation; runtime API presence does not +establish that they work on Thor. + +Upstream contribution restrictions are respected: these are launcher, storage, +build and file-lifecycle adapters in DroidDeck, not submitted reverse-engineering +contributions to Xodus. + +Sources and licenses: + +- Xodus: https://github.com/xodus-gaming/xodus (GPL-3.0, `LICENSE.xodus`). +- Nexus patches: https://github.com/domsvoboda/xodus-nexus (MIT, `LICENSE.nexus`). +- XGameRuntime/Wine modules: the exact source archive is identified in + `runtime.lock.json` (LGPL-2.1, `LICENSE.LGPL-2.1`). +- `libnghttp2.dll`: nghttp2, MIT; its license is retained in the runtime source + archive and is packaged as `LICENSE.nghttp2`. diff --git a/tools/xbox/backend.lock.json b/tools/xbox/backend.lock.json new file mode 100644 index 0000000000..f1568f94d7 --- /dev/null +++ b/tools/xbox/backend.lock.json @@ -0,0 +1,109 @@ +{ + "schema": 1, + "version": "0.2.8", + "repository": "https://github.com/xodus-gaming/xodus.git", + "commit": "53ea781dcd073e31d7ea68e894134e9c959bff04", + "rust": "1.99.0", + "cargoLockSha256": "2259b343e00dadc263018beb7664b12e9d58a0b73bff502ad566f5f8619ce28a", + "patchId": "linux-run-v24", + "compatibility": "linux-run-v18", + "patches": [ + { + "file": "xodus-linux-run.patch", + "sha256": "68f260ec2c6e9264c47ed1a650868511f5412a756725d4000a865804f4712e8b" + }, + { + "file": "xodus-offline-mirror.patch", + "sha256": "c865fc2559c43a5b3eb2bc841035c076eae5c42a90fe488f90514384aa916986" + }, + { + "file": "xodus-account-status.patch", + "sha256": "e2a718d16957733d140891fcdd26cc8cb3db0636307e6ff6e9ffbfa41a2d393c" + }, + { + "file": "xodus-streaming-cache-flush.patch", + "sha256": "4dd7a129ab9b3aac74d46f926efe26f163741d50fe2853a07f292240ab522b05" + }, + { + "file": "xodus-launch-chain.patch", + "sha256": "22dfbfc5cec911091351bb2d648f4b16bd274aa276ee4524be738a357c8b219a" + }, + { + "file": "xodus-memfd-path.patch", + "sha256": "905cfda813f0a434a2c13fd2db973385f0311cbec5c86bc3549737a7838f49fd" + }, + { + "file": "xodus-real-launch-images.patch", + "sha256": "95fc642e3adfa50414648e40df6ee94262964f5eea0f3762a34765f56d7824b7" + }, + { + "file": "xodus-store-license.patch", + "sha256": "99a89821e15ba144126515b5e8ec70b0673caf694d9295f16cd6661564b7c579" + }, + { + "file": "xodus-store-updates.patch", + "sha256": "554e3849122c8cd3c64c7f5904ac06931a088bc8fb4c522ec2c55b972b72ea8e" + }, + { + "file": "xodus-streaming-progress.patch", + "sha256": "b5e22d8eb595502776c4d6f2a5451403647e31754fc6358bc4f338cab72642a0" + }, + { + "file": "xodus-case-insensitive-paths.patch", + "sha256": "53dbfd6f734db100fff958e4a311155cad2cb374db456f73544ad76e3799ac8d" + }, + { + "file": "xodus-account-profile.patch", + "sha256": "135166ff0cf9f95af92dad6fd1c958b6c57e939fbb5b398b5a603b730541554a" + }, + { + "file": "xodus-subscription-login.patch", + "sha256": "6c3f32c905039948b3ff95a0ceaba9b2a09a9417606653bce9b741c8bba43eb0" + }, + { + "file": "xodus-external-auth.patch", + "sha256": "0a22d5a84d328780e6f13ac07f8e1db6359ec70139ad4262e4c1ee988973e20e" + }, + { + "file": "xodus-keyring-activation.patch", + "sha256": "8c71928e0b365f4770532ef968322450f1ebab3a1199e7a10d894119c48c925e" + }, + { + "file": "xodus-package-selection.patch", + "sha256": "7507cb0535cd914d3607e7940d5e17b949d106d0b89c139b84372a1ee1732c54" + }, + { + "file": "xodus-package-metadata.patch", + "sha256": "43fccfbb2ea2a9809e7f0b3d9e2f506213e6245d3bbd4c1c631149a67bb2d661" + }, + { + "file": "xodus-license-sku.patch", + "sha256": "b7c93b6ead7120c5b2af3616e80c0dadf56326a8bc81a2526a5e1f2700f58e20" + }, + { + "file": "xodus-keyring-credentials.patch", + "sha256": "8b354f95b864ffd7eadb02f0d54eb1361bb92fde14ff8696fabfea5c43d03811" + }, + { + "file": "xodus-library-resilience.patch", + "sha256": "0136157efe8a1419f91243c496656c4d043422e126c40e4a552e769c53de3545" + }, + { + "file": "xodus-game-activity.patch", + "sha256": "89bfd422f951515dd393eb479901ff9613441c627d139918c233a19ec21f1e06" + }, + { + "file": "xodus-achievements.patch", + "sha256": "55e4b56b943f491da4c9836a5d6655417ed63ab6383576a8e0f153ec986039b0" + }, + { + "file": "xodus-session-recovery.patch", + "sha256": "fa67d768214247a5955716b9691616b45330ebda504703bf372fdda2252b0831" + }, + { + "file": "xodus-content-response.patch", + "sha256": "e9997951526cfa08e3dd8c5fc4c383bf630e7ab8992d9e211acee40fdc6422a4" + } + ], + "nexusCommit": "396e7fb8fe0e5f00d956091195c614b8a0732ab1" +} diff --git a/tools/xbox/build-local.sh b/tools/xbox/build-local.sh new file mode 100755 index 0000000000..6a3eb90ce5 --- /dev/null +++ b/tools/xbox/build-local.sh @@ -0,0 +1,18 @@ +#!/usr/bin/env bash +set -euo pipefail +repo=$(cd "$(dirname "$0")/../.." && pwd) +cache=${DROIDDECK_XBOX_CACHE:-"${HOME}/.cache/droiddeck-xbox-build"} +mkdir -p "$cache" +docker run --rm --platform linux/arm64 -v "$repo:/src" -v "$cache:/work" -w /src \ + -e CARGO_HOME=/work/cargo -e RUSTUP_HOME=/work/rustup -e XBOX_BUILD_DIR=/work/build ubuntu:24.04 bash -lc ' + set -euo pipefail + apt-get update -qq + DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends \ + build-essential pkg-config libssl-dev protobuf-compiler cmake curl git ca-certificates xz-utils python3 >/dev/null + export PATH=/work/cargo/bin:$PATH + if ! command -v rustup >/dev/null; then + version=$(python3 -c '\''import json;print(json.load(open("tools/xbox/backend.lock.json"))["rust"])'\'') + curl -fsSL https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain "$version" + fi + bash tools/xbox/build.sh +' diff --git a/tools/xbox/build.sh b/tools/xbox/build.sh new file mode 100755 index 0000000000..f5598aee19 --- /dev/null +++ b/tools/xbox/build.sh @@ -0,0 +1,37 @@ +#!/usr/bin/env bash +set -euo pipefail +repo=$(cd "$(dirname "$0")/../.." && pwd) +cache=${XBOX_BUILD_DIR:-"$repo/app/build/xbox"} +out=${1:-"$repo/app/src/main/assets/linuxfs/usr/local/lib/droiddeck-xbox"} +mkdir -p "$cache" "$out" +source_dir=$(python3 "$repo/tools/xbox/prepare.py" "$cache") +rust_version=$(python3 -c 'import json,sys;print(json.load(open(sys.argv[1]))["rust"])' "$repo/tools/xbox/backend.lock.json") +export RUSTUP_TOOLCHAIN=$rust_version +export CARGO_TARGET_DIR=${CARGO_TARGET_DIR:-"$cache/target"} +rustup target add aarch64-unknown-linux-gnu +export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER=${CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER:-aarch64-linux-gnu-gcc} +if [[ $(uname -m) = aarch64 ]]; then export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER=cc; fi +cd "$source_dir" +cargo build --locked --release --no-default-features --target aarch64-unknown-linux-gnu -p xodus-cli -p xodus-service +if [[ $(uname -m) = aarch64 ]]; then + cargo test --locked --release --no-default-features --target aarch64-unknown-linux-gnu -p xodus-cli + cargo test --locked --release --no-default-features --target aarch64-unknown-linux-gnu -p xodus credential_ + cargo test --locked --release --no-default-features --target aarch64-unknown-linux-gnu -p msixvc streaming_ +fi +for binary in xodus-cli xodus-service; do + install -m755 "$CARGO_TARGET_DIR/aarch64-unknown-linux-gnu/release/$binary" "$out/$binary" +done +python3 "$repo/tools/xbox/runtime.py" "$cache/runtime" "$out/windows" +install -m644 "$repo/tools/xbox/LICENSE.xodus" "$out/LICENSE.xodus" +install -m644 "$repo/tools/xbox/LICENSE.nexus" "$out/LICENSE.nexus" +install -m644 "$repo/tools/xbox/LICENSE.LGPL-2.1" "$out/LICENSE.LGPL-2.1" +install -m644 "$repo/tools/xbox/LICENSE.nghttp2" "$out/LICENSE.nghttp2" +cp "$repo/tools/xbox/"*.lock.json "$out/" +python3 - "$out" "$repo/tools/xbox/droiddeck-credentials.patch" <<'PY' +import hashlib,json,pathlib,sys +out=pathlib.Path(sys.argv[1]) +files={str(p.relative_to(out)):hashlib.sha256(p.read_bytes()).hexdigest() for p in out.rglob('*') if p.is_file() and p.name!='version'} +files['credentialPatch']=hashlib.sha256(pathlib.Path(sys.argv[2]).read_bytes()).hexdigest() +(out/'version').write_text(hashlib.sha256(json.dumps(files,sort_keys=True).encode()).hexdigest()+'\n') +PY +tar -cJf "$cache/xodus-droiddeck-source.tar.xz" --exclude=.git --exclude=target -C "$source_dir" . -C "$repo" tools/xbox diff --git a/tools/xbox/droiddeck-credentials.patch b/tools/xbox/droiddeck-credentials.patch new file mode 100644 index 0000000000..bf92276e3a --- /dev/null +++ b/tools/xbox/droiddeck-credentials.patch @@ -0,0 +1,154 @@ +--- a/crates/xodus/src/secrets.rs ++++ b/crates/xodus/src/secrets.rs +@@ -1,73 +1,14 @@ +-pub static SERVICE_NAME: &str = "Xodus Service"; ++use crate::tokens::{backend::KeychainBackend, store::{TokenBackend, TokenStoreError}}; + + pub fn init_secrets() -> Result<(), keyring_core::Error> { +- #[cfg(feature = "key-chain-file")] +- { +- let store = keyring_core::sample::Store::new_with_backing( +- secrets_backing_file() +- .to_str() +- .expect("Invalid secrets backing path"), +- )?; +- keyring_core::set_default_store(store); +- } +- +- #[cfg(not(feature = "key-chain-file"))] +- { +- #[cfg(target_os = "linux")] +- { +- activate_desktop_keyring(); +- keyring_core::set_default_store(dbus_secret_service_keyring_store::Store::new()?); +- } +- +- #[cfg(target_os = "macos")] +- { +- keyring_core::set_default_store(apple_native_keyring_store::keychain::Store::new()?); +- } +- +- #[cfg(not(any(target_os = "linux", target_os = "macos")))] +- { +- let store = keyring_core::sample::Store::new_with_configuration( +- &std::collections::HashMap::from([("persist", "true")]), +- )?; +- keyring_core::set_default_store(store); +- } +- } +- ++ if std::env::var_os("DROIDDECK_XBOX_CREDENTIAL_SOCKET").is_none() { return Err(keyring_core::Error::NoEntry); } + Ok(()) + } +- +-// Some KDE installations advertise ksecretd only under its compatibility +-// activation name. Respect an existing/default Secret Service provider first. +-// This starts a packaged user service, never installs or configures a keyring. +-#[cfg(all(target_os = "linux", not(feature = "key-chain-file")))] +-fn activate_desktop_keyring() { +- use dbus::blocking::Connection; +- use std::time::Duration; +- let Ok(connection) = Connection::new_session() else { return; }; +- let bus = connection.with_proxy("org.freedesktop.DBus", "/org/freedesktop/DBus", Duration::from_secs(3)); +- let Ok((owned,)): Result<(bool,), _> = bus.method_call("org.freedesktop.DBus", "NameHasOwner", ("org.freedesktop.secrets",)) else { return; }; +- if owned { return; } +- let Ok((names,)): Result<(Vec,), _> = bus.method_call("org.freedesktop.DBus", "ListActivatableNames", ()) else { return; }; +- if names.iter().any(|name| name == "org.freedesktop.secrets") { return; } +- if names.iter().any(|name| name == "org.kde.secretservicecompat") { +- // On failure, Store::new below still returns the genuine keyring error. +- let _: Result<(u32,), _> = bus.method_call("org.freedesktop.DBus", "StartServiceByName", ("org.kde.secretservicecompat", 0u32)); +- } ++pub struct Entry(String); ++pub fn get_entry(user: &str) -> Result { Ok(Entry(user.into())) } ++impl Entry { ++ pub fn get_secret(&self) -> Result, TokenStoreError> { KeychainBackend.get(&self.0)?.ok_or(TokenStoreError::NotFound) } ++ pub fn set_secret(&self, value: &[u8]) -> Result<(), TokenStoreError> { KeychainBackend.set(&self.0, value) } ++ pub fn delete_credential(&self) -> Result<(), TokenStoreError> { KeychainBackend.remove(&self.0) } + } +- +-pub fn get_entry(user: &str) -> Result { +- keyring_core::Entry::new(SERVICE_NAME, user) +-} +- +-pub fn destroy_secrets() { +- keyring_core::unset_default_store(); +-} +- +-#[cfg(feature = "key-chain-file")] +-fn secrets_backing_file() -> std::path::PathBuf { +- std::env::var_os("HOME") +- .or_else(|| std::env::var_os("USERPROFILE")) +- .map(std::path::PathBuf::from) +- .unwrap_or_else(std::env::temp_dir) +- .join(".xodus-keyring.ron") +-} ++pub fn destroy_secrets() {} +--- a/crates/xodus/src/tokens/backend/keychain.rs ++++ b/crates/xodus/src/tokens/backend/keychain.rs +@@ -1,22 +1,43 @@ + use crate::tokens::store::{TokenBackend, TokenStoreError}; ++use serde_json::{Value, json}; ++use std::io::{BufRead, Read, Write}; ++use std::os::linux::net::SocketAddrExt; ++use std::os::unix::net::{SocketAddr, UnixStream}; ++use std::time::Duration; + + pub struct KeychainBackend; + ++fn request(value: Value) -> Result { ++ let name = std::env::var("DROIDDECK_XBOX_CREDENTIAL_SOCKET") ++ .map_err(|_| std::io::Error::other("Android credential host is unavailable"))?; ++ let address = SocketAddr::from_abstract_name(name)?; ++ let mut stream = UnixStream::connect_addr(&address)?; ++ stream.set_read_timeout(Some(Duration::from_secs(10)))?; ++ stream.set_write_timeout(Some(Duration::from_secs(10)))?; ++ serde_json::to_writer(&mut stream, &value)?; ++ stream.write_all(b"\n")?; ++ let mut bytes = Vec::new(); ++ std::io::BufReader::new(stream).take(2_097_153).read_until(b'\n', &mut bytes)?; ++ if bytes.len() > 2_097_152 || bytes.last() != Some(&b'\n') { ++ return Err(std::io::Error::other("Invalid Android credential response").into()); ++ } ++ let response: Value = serde_json::from_slice(&bytes)?; ++ if response["ok"] != true { return Err(std::io::Error::other("Android credential storage unavailable").into()); } ++ Ok(response) ++} ++ + impl TokenBackend for KeychainBackend { + fn get(&self, key: &str) -> Result>, TokenStoreError> { +- let entry = crate::secrets::get_entry(key)?; +- match entry.get_secret() { +- Ok(bytes) => Ok(Some(bytes)), +- Err(keyring_core::Error::NoEntry) => Ok(None), +- Err(e) => Err(e.into()), +- } ++ let response = request(json!({"op":"get", "key":key}))?; ++ if response["value"].is_null() { return Ok(None); } ++ Ok(Some(serde_json::from_value(response["value"].clone())?)) + } +- + fn set(&self, key: &str, value: &[u8]) -> Result<(), TokenStoreError> { +- Ok(crate::secrets::get_entry(key)?.set_secret(value)?) ++ request(json!({"op":"set", "key":key, "value":value}))?; ++ Ok(()) + } +- + fn remove(&self, key: &str) -> Result<(), TokenStoreError> { +- Ok(crate::secrets::get_entry(key)?.delete_credential()?) ++ request(json!({"op":"remove", "key":key}))?; ++ Ok(()) + } + } +--- a/crates/xodus/Cargo.toml ++++ b/crates/xodus/Cargo.toml +@@ -43,8 +43,8 @@ + smbios-lib = "0.9.4" + + [target.'cfg(target_os = "linux")'.dependencies] +-dbus = "=0.9.12" +-dbus-secret-service-keyring-store = { version = "1.0.1", features = ["crypto-openssl"]} ++dbus = { version = "=0.9.12", optional = true } ++dbus-secret-service-keyring-store = { version = "1.0.1", features = ["crypto-openssl"], optional = true} + + [target.'cfg(target_os = "macos")'.dependencies] + apple-native-keyring-store = { version = "1.0.2", features = ["keychain"]} diff --git a/tools/xbox/droiddeck-launch-view.patch b/tools/xbox/droiddeck-launch-view.patch new file mode 100644 index 0000000000..ce6fa4600b --- /dev/null +++ b/tools/xbox/droiddeck-launch-view.patch @@ -0,0 +1,86 @@ +--- a/crates/xodus-cli/src/commands/run.rs ++++ b/crates/xodus-cli/src/commands/run.rs +@@ -77,6 +77,7 @@ + launch_image: &Path, + materialize_chain: bool, + ) -> (String, String) { ++ if materialize_chain { return (String::new(), String::new()); } + let source_nt = source.to_string_lossy().replace('/', "\\"); + let source_nt = source_nt.trim_end_matches('\\'); + let mirror_unix = mirror_nt_prefix.map(|prefix| prefix.replace('\\', "/")); +@@ -200,9 +201,7 @@ + let entry_path = checked_relative_path(entry_suffix)?; + let mut decrypted = HashMap::new(); + for (name, fd) in fds { +- if name.to_ascii_lowercase().ends_with(".exe") || checked_relative_path(name)? == entry_path { +- decrypted.insert(checked_relative_path(name)?, *fd); +- } ++ decrypted.insert(checked_relative_path(name)?, *fd); + } + if !decrypted.contains_key(&entry_path) { + return Err(std::io::Error::new( +@@ -222,11 +221,8 @@ + } + } + let decrypted_files: HashSet = decrypted.keys().cloned().collect(); +- let parent = source_root.parent().unwrap_or_else(|| Path::new("/tmp")); +- let mirror = Builder::new() +- .prefix(".xodus-chain-") +- .tempdir_in(parent) +- .or_else(|_| Builder::new().prefix("xodus-chain-").tempdir())?; ++ let mirror = Builder::new().prefix("droiddeck-xbox-") ++ .permissions(std::os::unix::fs::PermissionsExt::from_mode(0o700)).tempdir()?; + populate_launch_view( + source_root, + mirror.path(), +@@ -667,21 +663,15 @@ + use std::os::fd::AsRawFd; + + #[test] +- fn full_launch_view_uses_real_executables_and_preserves_encrypted_dll_maps() { ++ fn full_launch_view_needs_no_inherited_descriptor_maps() { + let entry = String::from("\\Launcher.exe"); + let child = String::from("\\Bin\\Child.ExE"); + let dll = String::from("\\Bin\\Encrypted.dll"); + let files = [(&entry, 10), (&child, 11), (&dll, 12)]; + let (nt, unix) = launch_file_maps(&files, Path::new("/package"), Some("\\view"), + &entry, 10, Path::new("/view/Launcher.exe"), true); +- assert!(nt.contains("10:\\??\\Z:\\package\\Launcher.exe")); +- assert!(unix.contains("10:/package/Launcher.exe")); +- assert!(!nt.contains("\\view\\Launcher.exe")); +- assert!(!nt.contains("\\view\\Bin\\Child.ExE")); +- assert!(!unix.contains("/view/Launcher.exe")); +- assert!(!unix.contains("/view/Bin/Child.ExE")); +- assert!(nt.contains("12:\\??\\Z:\\view\\Bin\\Encrypted.dll")); +- assert!(unix.contains("12:/view/Bin/Encrypted.dll")); ++ assert!(nt.is_empty()); ++ assert!(unix.is_empty()); + } + + #[test] +@@ -778,6 +768,25 @@ + .is_symlink()); + assert_eq!(std::fs::read(source.join("Dungeons.exe")).unwrap(), b"encrypted launcher"); + assert_eq!(std::fs::read(nested.join("Shipping.exe")).unwrap(), b"encrypted child"); ++ } ++ ++ #[test] ++ fn launch_view_materializes_encrypted_dlls_in_private_storage() { ++ let root = tempfile::tempdir().unwrap(); ++ std::fs::write(root.path().join("Game.exe"), b"encrypted").unwrap(); ++ std::fs::write(root.path().join("Secret.dll"), b"encrypted-dll").unwrap(); ++ let mut image = tempfile::tempfile().unwrap(); ++ image.write_all(&fake_pe()).unwrap(); ++ let exe = String::from("Game.exe"); ++ let dll = String::from("Secret.dll"); ++ let files = [(&exe, image.as_raw_fd()), (&dll, image.as_raw_fd())]; ++ let (view, _, count, _) = create_launch_chain_mirror(root.path(), &exe, &files).unwrap(); ++ assert_eq!(count, 2); ++ assert_eq!(std::fs::read(view.path().join("Secret.dll")).unwrap(), fake_pe()); ++ assert!(!view.path().join("Secret.dll").is_symlink()); ++ assert_eq!(std::fs::read(root.path().join("Secret.dll")).unwrap(), b"encrypted-dll"); ++ use std::os::unix::fs::PermissionsExt; ++ assert_eq!(std::fs::metadata(view.path()).unwrap().permissions().mode() & 0o077, 0); + } + + #[test] diff --git a/tools/xbox/prepare.py b/tools/xbox/prepare.py new file mode 100755 index 0000000000..ff7bb15c68 --- /dev/null +++ b/tools/xbox/prepare.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python3 +"""Reproduce the pinned Nexus source and DroidDeck credential transport.""" +import hashlib +import json +from pathlib import Path +import subprocess +import sys + +recipe = Path(__file__).resolve().parent +cache = Path(sys.argv[1]).resolve() +lock = json.loads((recipe / 'backend.lock.json').read_text()) +identity = hashlib.sha256((recipe / 'backend.lock.json').read_bytes() + (recipe / 'droiddeck-credentials.patch').read_bytes() + (recipe / 'droiddeck-launch-view.patch').read_bytes()).hexdigest() +source = cache / ('source-' + identity[:16]) +if not (source / '.prepared').is_file(): + if source.exists(): + raise RuntimeError('Incomplete Xbox source directory; inspect it before retrying: ' + str(source)) + source.mkdir(parents=True) + nexus = cache / ('nexus-' + lock['nexusCommit']) + for directory, remote, commit in ((source, lock['repository'], lock['commit']), + (nexus, 'https://github.com/domsvoboda/xodus-nexus.git', lock['nexusCommit'])): + directory.mkdir(parents=True, exist_ok=True) + if not (directory / '.git').is_dir(): + subprocess.run(['git', 'init', '-q', str(directory)], check=True) + subprocess.run(['git', '-C', str(directory), 'fetch', '-q', '--depth', '1', remote, commit], check=True) + subprocess.run(['git', '-C', str(directory), 'checkout', '-q', '--detach', 'FETCH_HEAD'], check=True) + assert subprocess.check_output(['git', '-C', str(directory), 'rev-parse', 'HEAD'], text=True).strip() == commit + assert hashlib.sha256((source / 'Cargo.lock').read_bytes()).hexdigest() == lock['cargoLockSha256'] + for patch in lock['patches']: + file = nexus / 'assets' / patch['file'] + assert hashlib.sha256(file.read_bytes()).hexdigest() == patch['sha256'] + subprocess.run(['git', '-C', str(source), 'apply', str(file)], check=True) + subprocess.run(['git', '-C', str(source), 'apply', str(recipe / 'droiddeck-credentials.patch')], check=True) + subprocess.run(['git', '-C', str(source), 'apply', str(recipe / 'droiddeck-launch-view.patch')], check=True) + (source / '.prepared').write_text(identity + '\n') +assert (source / '.prepared').read_text().strip() == identity +print(source) diff --git a/tools/xbox/runtime-probe.c b/tools/xbox/runtime-probe.c new file mode 100644 index 0000000000..ad92fc0d5e --- /dev/null +++ b/tools/xbox/runtime-probe.c @@ -0,0 +1,23 @@ +#include +#include + +int main(void) +{ + setvbuf(stdout, NULL, _IONBF, 0); + const char *modules[] = { "xgameruntime.dll", "winhttp.dll", "windows.web.dll", "twinapi.appcore.dll" }; + int failed = 0; + for (unsigned i = 0; i < sizeof(modules) / sizeof(modules[0]); i++) + { + printf("loading %s\n", modules[i]); + HMODULE module = LoadLibraryA(modules[i]); + printf("%s loaded=%u error=%lu\n", modules[i], module != NULL, module ? 0ul : GetLastError()); + if (!module) failed = 1; + if (module && i == 0) + { + FARPROC entry = GetProcAddress(module, "InitializeApiImplEx2"); + printf("InitializeApiImplEx2 present=%u\n", entry != NULL); + if (!entry) failed = 1; + } + } + return failed; +} diff --git a/tools/xbox/runtime.lock.json b/tools/xbox/runtime.lock.json new file mode 100644 index 0000000000..d8e3de855b --- /dev/null +++ b/tools/xbox/runtime.lock.json @@ -0,0 +1,17 @@ +{ + "repository": "domsvoboda/xodus-nexus", + "tag": "runtime-11.0-20261018-gf291f544", + "archive": "xodus-nexus-runtime-11.0-20261018-gf291f544-x86_64.tar.xz", + "sha512": "8e16634dc4d75ead4b7f48712624e107cfdc29a31a2da1b32624af25a6e3e8938636a6701e076a9dee08eb0c5b36b549342598313971f5fceb5de1e483c43578", + "source": { + "name": "xodus-nexus-runtime-11.0-20261018-gf291f544-source.tar.xz", + "sha256": "58b5d35d23b61f73f771b733fde43ea75096fe8b60f2ddc660949af3d8d87baf" + }, + "dlls": { + "twinapi.appcore.dll": "c203bbd707d521c68719b42a0a81db2b4838cc41be83fc76bfd87bf33e507336", + "windows.web.dll": "1a510c73ca31475b163692337d3cf37fef3381078df9729662095fc92b2e4e83", + "libnghttp2.dll": "2b171eba9296b207fe6016560e5381bc6e7405f3ad5ee5cd4add316358204ec0", + "xgameruntime.dll": "060120e0ec6bccfbab516128315a0658b11d3e316f62a917c653daf1a1dd3e05", + "winhttp.dll": "81e1da7a731d83fbd24dbe2fa2ecb8f155bd477a9f9b6f4cc3932063cc326c27" + } +} diff --git a/tools/xbox/runtime.py b/tools/xbox/runtime.py new file mode 100755 index 0000000000..cbe3589ff9 --- /dev/null +++ b/tools/xbox/runtime.py @@ -0,0 +1,59 @@ +#!/usr/bin/env python3 +"""Extract only pinned Windows GDK modules; Linux Wine stays ARM64.""" +import hashlib +import json +from pathlib import Path +import shutil +import sys +import tarfile +import urllib.request + +recipe = Path(__file__).resolve().parent +lock = json.loads((recipe / 'runtime.lock.json').read_text()) +cache = Path(sys.argv[1]); output = Path(sys.argv[2]) +cache.mkdir(parents=True, exist_ok=True) +output.mkdir(parents=True, exist_ok=True) +url = 'https://github.com/' + lock['repository'] + '/releases/download/' + lock['tag'] + '/' + +def download(name, expected, algorithm): + target = cache / name + def matches(): + if not target.is_file(): + return False + digest = hashlib.new(algorithm) + with target.open('rb') as file: + for block in iter(lambda: file.read(1024 * 1024), b''): + digest.update(block) + return digest.hexdigest() == expected + if not matches(): + part = target.with_suffix(target.suffix + '.part') + with urllib.request.urlopen(url + name, timeout=90) as response, part.open('wb') as file: + shutil.copyfileobj(response, file) + part.replace(target) + if not matches(): + raise RuntimeError('Xbox runtime checksum mismatch: ' + name) + return target + +archive = download(lock['archive'], lock['sha512'], 'sha512') +# Keep corresponding source available beside the build cache for redistribution. +source = lock['source'] +download(source['name'], source['sha256'], 'sha256') +remaining = set(lock['dlls']) +with tarfile.open(archive) as tar: + for member in tar: + name = Path(member.name).name + if '/files/lib/wine/x86_64-windows/' not in member.name or name not in remaining: + continue + if not member.isfile() or member.size > 32 * 1024 * 1024: + raise RuntimeError('Invalid Xbox Windows runtime module') + data = tar.extractfile(member).read() + if hashlib.sha256(data).hexdigest() != lock['dlls'][name] or data[:2] != b'MZ': + raise RuntimeError('Xbox Windows runtime module checksum mismatch') + # Wine rejects builtin-tagged PE files when WINEDLLOVERRIDES selects native. + # These standalone Windows modules must use the native x64 loader on ARM64EC. + if data[64:80] == b'Wine builtin DLL': + data = data[:64] + b'DroidDeck native' + data[80:] + (output / name).write_bytes(data) + remaining.remove(name) +if remaining: + raise RuntimeError('Missing Xbox runtime modules')