"""Android apps on the Frame, each in its own persistent Lepton instance. Every APK gets ~/Applications/Android// on the Frame with app.apk, launch.sh (frame/android/lepton-app.sh), instance.id, meta.json and, for 2D apps, the lepton-show-flatscreen marker; plus a non-Steam shortcut, so it shows in the Steam library and gets its own SteamVR panel. Nothing goes through Lepton Development, which wipes its apps on exit. See docs/apks.md. Python stdlib only. CLI: python3 ui/frame_android.py install APK [--vr|--flat] [--no-xr-compat] | info APK | versions APK-or-PKG install-obb PKG OBB [OBB ...] | backup-data PKG ARCHIVE | restore-data PKG ARCHIVE refresh-art PKG|--all | patch SRC DST [--add NAME=PATH ...] | list | launch PKG | stop PKG | remove PKG | probe PKG """ import base64, json, os, re, shlex, shutil, struct, subprocess, sys, threading, time, zlib import frame_apk import frame_artwork import frame_host import tempfile import zipfile from frame_apk_vr import add_launcher_category from frame_apk_sign import repack ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) FRAME = os.environ.get('FRAME_ALIAS', 'frame') APPS_DIR = 'Applications/Android' # relative to the Frame's $HOME COMPAT = '.local/share/Steam/steamapps/compatdata' SHADERS = '.local/share/Steam/steamapps/shadercache' LAUNCHER = os.path.join(ROOT, 'frame', 'android', 'lepton-app.sh') SHORTCUTS = os.path.join(ROOT, 'frame', 'android', 'steam_shortcuts.py') # OpenXR API layer that lets OpenXR 1.1 apps run on SteamVR's 1.0-only Android # runtime (frame/openxr-compat, docs/vr-apks.md). Injected into VR APKs. XR_COMPAT = os.path.join(ROOT, 'frame', 'openxr-compat') XR_COMPAT_FILES = { 'assets/openxr/1/api_layers/implicit.d/XrApiLayer_FRAME_compat.json': 'XrApiLayer_FRAME_compat.json', 'lib/arm64-v8a/libXrApiLayer_FRAME_compat.so': 'prebuilt/arm64-v8a/libXrApiLayer_FRAME_compat.so', } PKG_RE = re.compile(r'^[A-Za-z][\w]*(\.[A-Za-z_][\w]*)+$') SSH_OPTS = ['-o', 'BatchMode=yes', '-o', 'ConnectTimeout=8'] class FrameError(RuntimeError): pass def ssh(cmd, input=None, timeout=120): try: # No inherited stdin (see server.ssh): Windows' ssh.exe would wait on it. feed = {'input': input} if input is not None else {'stdin': subprocess.DEVNULL} p = subprocess.run(['ssh', *SSH_OPTS, FRAME, cmd], capture_output=True, **feed, timeout=timeout, text=isinstance(input, str) or input is None) except subprocess.TimeoutExpired: raise FrameError(f'timed out talking to {FRAME}') if p.returncode != 0: raise FrameError((p.stderr or p.stdout or f'ssh exited {p.returncode}').strip()[-600:]) return p.stdout def shortcut_tool(*args, timeout=60): with open(SHORTCUTS) as f: script = f.read() if args and args[0] == 'render': with open(os.path.join(ROOT, 'frame/android/library_artwork.js')) as f: script = 'ART_RENDERER = ' + repr(f.read()) + '\n' + script return ssh('python3 - ' + ' '.join(shlex.quote(a) for a in args), input=script, timeout=timeout).strip() def instance_id(pkg): # Stable per package, well above real Steam app ids, below 2^32. T3 Code's # hand-picked 2873873873 sits outside this range. return 2800000000 + zlib.crc32(pkg.encode()) % 70000000 def game_id(shortcut_appid): return (int(shortcut_appid) << 32) | 0x02000000 def apk_info(path): """Package, label, version, native ABIs and the best PNG icon inside the APK.""" try: return frame_apk.apk_info(path) except frame_apk.ApkError as e: raise FrameError(f'{os.path.basename(path)}: {e}') def xr_compat_files(apk_path): """The layer's files to add, or {} if the APK has no OpenXR loader or already has the layer.""" with zipfile.ZipFile(apk_path) as z: names = set(z.namelist()) if 'lib/arm64-v8a/libopenxr_loader.so' not in names or names & set(XR_COMPAT_FILES): return {} add = {} for entry, rel in XR_COMPAT_FILES.items(): try: with open(os.path.join(XR_COMPAT, rel), 'rb') as f: add[entry] = f.read() except OSError: raise FrameError("the OpenXR compatibility layer isn't built; run frame/openxr-compat/build.sh") return add def check_installable(info): if info['min_sdk'] and info['min_sdk'] > 30: raise FrameError(f"{info['label']} needs Android API {info['min_sdk']}; Lepton is Android 11 (API 30)") if info['abis'] and 'arm64-v8a' not in info['abis']: raise FrameError(f"{info['label']} has no arm64-v8a build ({', '.join(info['abis'])}); Lepton is 64-bit ARM only") _install_lock = threading.Lock() # installs are rare; one at a time avoids every race def _copy(src, dest, executable=False, timeout=600): """Copy a local file to the Frame: rsync where installed (not on Windows), else scp.""" name = os.path.basename(src) rsync = None if frame_host.WINDOWS else shutil.which('rsync') # see server.push_file if rsync: cmd = ['rsync', '-a', *(['--chmod=u+x'] if executable else []), '-e', shlex.join(['ssh', *SSH_OPTS]), src, f'{FRAME}:{dest}'] else: cmd = ['scp', *SSH_OPTS, src, f'{FRAME}:{dest}'] try: subprocess.run(cmd, check=True, capture_output=True, stdin=subprocess.DEVNULL, text=True, timeout=timeout) except subprocess.TimeoutExpired: raise FrameError(f'copying {name} to the Frame timed out') except subprocess.CalledProcessError as e: raise FrameError(f'copying {name} to the Frame failed: {(e.stderr or "").strip()[-300:]}') if executable and not rsync: ssh(f'chmod u+x {shlex.quote(dest)}') def _shortcut_ids(): try: return {int(x['appid']) for x in json.loads(shortcut_tool('list'))} except (ValueError, TypeError, KeyError) as e: raise FrameError(f'could not read the Steam shortcut list: {e}') def _write_meta(d, meta): # Write then rename, so a dropped connection can't leave torn JSON behind. ssh(f'cat > {d}/meta.json.tmp && mv {d}/meta.json.tmp {d}/meta.json', input=json.dumps(meta, indent=1)) # Called after every install, worked or not, as fn(info, meta, error, seconds): # info is None if the APK couldn't be read, meta None and error set if it failed. install_hooks = [] def install(apk_path, flatscreen=None, name=None, source=None, icon_png=None, xr_compat=None, artwork=None): start, info = time.time(), None try: info = apk_info(apk_path) if icon_png: info['icon_png'] = icon_png check_installable(info) pkg = info['package'] if not PKG_RE.match(pkg): raise FrameError(f'unexpected package name {pkg!r}') if flatscreen is None: flatscreen = not info['vr'] # VR apps get the OpenXR compatibility layer unless told otherwise; it only # changes calls SteamVR would otherwise reject. add = xr_compat_files(apk_path) if (info['vr'] if xr_compat is None else xr_compat) else {} with _install_lock: if add or info['repairable']: with tempfile.TemporaryDirectory(prefix='frame-vr-') as tmp: patched = os.path.join(tmp, 'app.apk') info['patched'] = patch(apk_path, patched, add)['patched'] info['launchable'] = True meta = _install(patched, info, pkg, flatscreen, name, source or os.path.basename(apk_path), artwork) else: meta = _install(apk_path, info, pkg, flatscreen, name, source, artwork) except FrameError as e: _after_install(info, None, e, start) raise _after_install(info, meta, None, start) return meta def _after_install(info, meta, error, start): for hook in install_hooks: try: hook(info, meta, error, time.time() - start) except Exception: pass # reporting must never change an install's outcome def _install(apk_path, info, pkg, flatscreen, name, source, artwork=None): try: images, art_warnings = frame_artwork.prepare(name or info['label'], info.get('icon_png'), artwork) except (ValueError, OSError) as e: raise FrameError(f'could not prepare artwork: {e}') from e iid = instance_id(pkg) d = f'{APPS_DIR}/{pkg}' existing = read_meta(pkg) ok, created = False, None try: ssh(f'mkdir -p {d}') _copy(apk_path, f'{d}/app.apk.part') _copy(LAUNCHER, f'{d}/launch.sh', executable=True, timeout=120) marker = f'touch {d}/lepton-show-flatscreen' if flatscreen else f'rm -f {d}/lepton-show-flatscreen' ssh(f'mv {d}/app.apk.part {d}/app.apk && echo {iid} > {d}/instance.id && {marker}') home = ssh('echo $HOME').strip() shortcut = _int((existing or {}).get('shortcut')) if not shortcut or shortcut not in _shortcut_ids(): reply = shortcut_tool('add', name or info['label'], f'{home}/{d}/launch.sh', f'{home}/{d}', '') shortcut = _int(reply.strip().splitlines()[-1] if reply.strip() else None) if not shortcut: raise FrameError(f'Steam did not return a shortcut id (got {reply[:80]!r})') created = shortcut presentation = apply_library(shortcut, name or info['label'], d, images, vr=not flatscreen, home=home, exe=f'{home}/{d}/launch.sh', start_dir=f'{home}/{d}', details={'package': pkg, 'version': info['version'], 'source': source or os.path.basename(apk_path)}) presentation['warnings'] = art_warnings + presentation.get('warnings', []) meta = {'package': pkg, 'label': name or info['label'], 'version': info['version'], 'instance': iid, 'shortcut': shortcut, 'game_id': game_id(shortcut), 'vr': info.get('vr', False), 'vr_issues': info.get('vr_issues', []), 'launchable': info.get('launchable', False), 'patched': info.get('patched', []), 'flatscreen': flatscreen, 'installed': time.strftime('%Y-%m-%dT%H:%M:%S'), 'source': source or os.path.basename(apk_path), 'library_warnings': presentation.get('warnings', []), 'artwork': presentation.get('artwork', {}), 'library_version': 2} _write_meta(d, meta) ok = True return meta finally: if not ok and created: try: shortcut_tool('remove', str(created)) except FrameError: pass if not ok and not existing: # A first install that failed part-way: don't leave an orphan folder behind. try: ssh(f'rm -rf {d}', timeout=30) except FrameError: pass def apply_library(shortcut, label, directory, images, vr=None, home=None, exe='', start_dir='', details=None, category='Android', fill_only=False): """Mandatory for every sideload: render all five slots before reporting success. vr None leaves Steam's VR flag as it is (devkit titles declare their own). fill_only (automatic backfill) sets only slots Steam has no art for, and never the name, exe or flags.""" home = home or ssh('echo $HOME').strip() d = directory ssh(f'mkdir -p {shlex.quote(d)}/artwork') paths = {} for slot, (ext, data) in images.items(): path = f'{d}/artwork/source-{slot}.{ext}' ssh(f'cat > {shlex.quote(path)}', input=data) paths[slot] = f'{home}/{path}' if not path.startswith('/') else path manifest = {'label': label, 'images': paths} plan = f'{d}/artwork/input.json' ssh(f'cat > {shlex.quote(plan)}', input=json.dumps(manifest)) absolute = f'{home}/{plan}' if not plan.startswith('/') else plan # The Frame retries once with generated art, each attempt allowed 75 s. rendered = json.loads(shortcut_tool('render', absolute, timeout=200)) art = rendered['paths'] if set(art) != set(frame_artwork.SLOTS): raise FrameError('Steam artwork renderer did not produce every slot') result = json.loads(shortcut_tool('configure', str(shortcut), label, exe, start_dir, art['icon'], '' if vr is None else '1' if vr else '0', json.dumps(art), json.dumps({'category': category, 'details': details or {}, 'fill_only': fill_only}), timeout=120)) result['warnings'] = rendered.get('warnings', []) + result.get('warnings', []) result['artwork'] = art if category == 'Android': ssh(f'cat > {shlex.quote(d)}/shortcut.id', input=str(int(shortcut))) return result def cached_art_script(d): """Frame-side Python that loads the source images kept beside d's last render into `cached`.""" return f"""import base64, json, os cached = {{}} directory = os.path.realpath({d!r}) try: with open(os.path.join(directory, 'artwork/input.json')) as f: plan = json.load(f) for slot, path in plan.get('images', {{}}).items(): if os.path.commonpath([os.path.realpath(path), directory]) != directory: continue with open(path, 'rb') as f: data = f.read(12 * 1024 * 1024 + 1) if len(data) <= 12 * 1024 * 1024: cached[slot] = base64.b64encode(data).decode() except (OSError, ValueError, TypeError, AttributeError): pass """ def art_missing(m): """True when a Frame Control install has no complete Steam artwork on record.""" return set((m or {}).get('artwork') or {}) != set(frame_artwork.SLOTS) def refresh_art(pkg=None, artwork=None, fill_only=False): """Refresh existing APK library entries without reinstalling or stopping them. fill_only: the automatic backfill; it only fills empty Steam slots (see apply_library).""" if pkg is None: results = [] for app in list_apps(): try: results.append(refresh_art(app['package'], artwork, fill_only)) except Exception as e: # one app's failure must not stop the others results.append({'package': app['package'], 'label': app.get('label'), 'error': str(e) or type(e).__name__}) return results with _install_lock: # shared with install and remove: a removed app is never recreated m = _meta_or_fail(pkg) d = f'{APPS_DIR}/{pkg}' # Parse the APK on the Frame, transferring only its icon/label, not the APK. modules = {} for module in ('frame_apk', 'frame_apk_vr'): with open(os.path.join(ROOT, 'ui', module + '.py')) as f: modules[module] = f.read() script = 'import sys, types, json, base64\n' for module, source in modules.items(): script += f'm = types.ModuleType({module!r}); sys.modules[{module!r}] = m; exec({source!r}, m.__dict__)\n' script += f"info = sys.modules['frame_apk'].apk_info({(d + '/app.apk')!r})\n" script += "info['icon_png'] = base64.b64encode(info.get('icon_png') or b'').decode()\n" script += cached_art_script(d) + "info['artwork'] = cached\nprint(json.dumps(info))\n" info = json.loads(ssh('python3 -', input=script)) icon = base64.b64decode(info['icon_png']) cached = {k: base64.b64decode(v) for k, v in info.get('artwork', {}).items()} images, warnings = frame_artwork.prepare(m['label'], icon, artwork if artwork is not None else cached) home = ssh('echo $HOME').strip() created = False if not m['shortcut'] or m['shortcut'] not in _shortcut_ids(): m['shortcut'] = _int(shortcut_tool('add', m['label'], f'{home}/{d}/launch.sh', f'{home}/{d}')) if not m['shortcut']: raise FrameError('Steam did not create the missing shortcut') m['game_id'] = game_id(m['shortcut']) created = True try: result = apply_library(m['shortcut'], m['label'], d, images, vr=not m.get('flatscreen', True), home=home, exe=f'{home}/{d}/launch.sh', start_dir=f'{home}/{d}', details=m, fill_only=fill_only and not created) except Exception: if created: try: shortcut_tool('remove', str(m['shortcut'])) except FrameError: pass # keep the render error, not the cleanup's raise m.update(artwork=result.get('artwork', {}), library_version=2, art_pending=False) m['library_warnings'] = warnings + result.get('warnings', []) m['artwork_refreshed'] = time.strftime('%Y-%m-%dT%H:%M:%S') _write_meta(d, m) return m def _int(v): try: n = int(v) return n if n > 0 else None except (TypeError, ValueError): return None def read_meta(pkg): try: m = json.loads(ssh(f'cat {APPS_DIR}/{pkg}/meta.json 2>/dev/null || true') or 'null') except (ValueError, FrameError): return None return _clean_meta(m) def _clean_meta(m): """A usable meta dict with integer ids, or None if it's missing what we need.""" if not isinstance(m, dict) or not PKG_RE.match(str(m.get('package', ''))): return None iid, shortcut = _int(m.get('instance')), _int(m.get('shortcut')) if not iid: return None m.update(instance=iid, shortcut=shortcut, game_id=game_id(shortcut) if shortcut else None, label=str(m.get('label') or m['package']), version=str(m.get('version') or '')) return m def running_instances(): """Lepton container name -> adb port, for the instances that are running now.""" out = ssh('podman ps --format "{{.Names}} {{.Labels.adb_port}}" 2>/dev/null || true') return dict(line.split()[:2] for line in out.splitlines() if len(line.split()) >= 2) def list_apps(): out = ssh(f'for f in {APPS_DIR}/*/meta.json; do [ -f "$f" ] && cat "$f" && echo; echo "@@"; done 2>/dev/null || true') running = running_instances() apps = [] for chunk in out.split('@@'): chunk = chunk.strip() if not chunk: continue try: m = _clean_meta(json.loads(chunk)) except ValueError: continue if m: m['running'] = f"lepton-steamlaunch-{m['instance']}" in running m['art_missing'] = art_missing(m) apps.append(m) return sorted(apps, key=lambda m: m['label'].lower()) def _meta_or_fail(pkg): if not PKG_RE.match(pkg or ''): raise FrameError(f'bad package name {pkg!r}') m = read_meta(pkg) if not m: raise FrameError(f'{pkg} is not installed') return m def launch(pkg): m = _meta_or_fail(pkg) if not m['game_id']: raise FrameError(f"{m['label']} has no Steam shortcut; reinstall it") ssh(f"steam steam://rungameid/{int(m['game_id'])} >/dev/null 2>&1 &") return m def stop(pkg): m = _meta_or_fail(pkg) if m['shortcut']: try: shortcut_tool('stop', str(int(m['shortcut']))) except FrameError: pass # Steam unavailable: the container stop also ends its waiting launcher. ssh(f"podman stop -t 5 lepton-steamlaunch-{int(m['instance'])} >/dev/null 2>&1 || true", timeout=60) return m def remove(pkg, keep_data=False): with _install_lock: # never while an install or artwork refresh of any app is writing return _remove(pkg, keep_data) def _remove(pkg, keep_data): m = _meta_or_fail(pkg) stop(pkg) if m['shortcut']: # Best effort: Steam may not be running, and the files must still go. try: result = json.loads(shortcut_tool('remove', str(int(m['shortcut']))) or '{}') m['library_warnings'] = result.get('warnings', []) except (FrameError, ValueError, AttributeError) as e: m['library_warnings'] = [f'Steam shortcut not removed: {e}'] iid = int(m['instance']) extra = '' if keep_data else f' {COMPAT}/{iid} {SHADERS}/{iid}' ssh(f'rm -rf {APPS_DIR}/{pkg}{extra}') return m def probe(pkg, wait=20): """Launch the app's instance and report whether it stays up (for compat reports).""" m = _meta_or_fail(pkg) ctr = f"lepton-steamlaunch-{int(m['instance'])}" launch(pkg) t0 = time.time() while time.time() - t0 < 90 and ctr not in running_instances(): time.sleep(3) if ctr not in running_instances(): return {'package': pkg, 'version': m['version'], 'result': 'instance_failed', 'detail': 'Lepton instance did not start within 90 s'} # Android boots inside the container; then give the app time to crash, or not. time.sleep(wait) sh = f'podman exec {ctr} /system/bin/sh -c' alive = ssh(f"{sh} 'pidof {pkg}' 2>/dev/null || true").strip() crash = ssh(f"{sh} 'logcat -d -b crash' 2>/dev/null | tail -n 60 || true") reason = next((l.split('AndroidRuntime: ', 1)[1] for l in crash.splitlines() if 'AndroidRuntime: ' in l and ('Exception' in l or 'Error' in l)), '') if not reason and 'Fatal signal' in crash: reason = next(l[l.find('Fatal signal'):] for l in crash.splitlines() if 'Fatal signal' in l) if 'ClipboardManager' in reason: reason = 'no clipboard service: ' + reason return {'package': pkg, 'version': m['version'], 'result': 'runs' if alive else 'crashes', 'detail': reason[:300], 'seconds': wait, 'container_up': ctr in running_instances()} def patch(src, dst, add=None): try: info = apk_info(src) with zipfile.ZipFile(src) as z: original = frame_apk._read(z, 'AndroidManifest.xml', frame_apk.MAX_MANIFEST) manifest = add_launcher_category(original) if info['repairable'] else original if not info['launchable'] and not info['repairable']: raise FrameError('APK has no MAIN/LAUNCHER activity that Frame Control can patch') repack(src, dst, replace={'AndroidManifest.xml': manifest}, add=add) result = apk_info(dst) result.pop('icon_png', None) result['patched'] = (['launcher'] if manifest != original else []) + \ (['openxr-compat'] if add and set(XR_COMPAT_FILES) <= set(add) else []) return result except (OSError, ValueError, IndexError, struct.error, zipfile.BadZipFile, frame_apk.ApkError) as e: raise FrameError(str(e)) from e def install_obb(pkg, paths): import frame_android_data return frame_android_data.install_obb(pkg, paths) def backup_data(pkg, destination): import frame_android_data return frame_android_data.backup_data(pkg, destination) def restore_data(pkg, archive): import frame_android_data return frame_android_data.restore_data(pkg, archive) def main(): cmd, *args = sys.argv[1:] or ['help'] try: if cmd in ('info', 'versions'): import frame_apk_versions if cmd == 'info': info = apk_info(args[0]) print(frame_apk_versions.describe(info)) fix = '; Frame Control adds the LAUNCHER entry Lepton needs' if info.get('repairable') else '' if info.get('vr') or fix: print(('VR app' if info.get('vr') else 'Android app') + fix) for note in info.get('vr_issues', []): print(note) return info = apk_info(args[0]) if os.path.isfile(args[0]) or args[0].lower().endswith('.apk') else None r = frame_apk_versions.alternatives( info['package'] if info else args[0], info.get('version_code') if info else None) elif cmd == 'install': r = install(args[0], flatscreen=False if '--vr' in args else True if '--flat' in args else None, xr_compat=False if '--no-xr-compat' in args else None) elif cmd == 'refresh-art': if len(args) != 1: raise FrameError('usage: refresh-art PACKAGE or refresh-art --all') r = refresh_art(None if args[0] == '--all' else args[0]) if isinstance(r, list) and any('error' in item for item in r): print(json.dumps(r, indent=1)) raise SystemExit(1) elif cmd == 'patch': import argparse parser = argparse.ArgumentParser(description='Patch and v2-sign an APK locally') parser.add_argument('src') parser.add_argument('dst') parser.add_argument('--add', action='append', default=[], metavar='NAME=PATH') opts = parser.parse_args(args) additions = {} for item in opts.add: if '=' not in item: raise FrameError('--add requires NAME=PATH') entry, path = item.split('=', 1) with open(path, 'rb') as f: additions[entry] = f.read() r = patch(opts.src, opts.dst, additions) elif cmd == 'install-obb': if len(args) < 2: raise FrameError('install-obb requires PACKAGE OBB [OBB ...]') r = install_obb(args[0], args[1:]) elif cmd in ('backup-data', 'restore-data'): if len(args) != 2: raise FrameError(cmd + ' requires PACKAGE ARCHIVE.tar.gz') r = (backup_data if cmd == 'backup-data' else restore_data)(*args) elif cmd == 'list': r = list_apps() if any(a['art_missing'] for a in r): print('Some apps have no Steam artwork: python3 ui/frame_android.py refresh-art --all', file=sys.stderr) elif cmd in ('launch', 'stop', 'probe'): r = globals()[cmd](args[0]) elif cmd == 'remove': r = remove(args[0], keep_data='--keep-data' in args) else: sys.exit(__doc__) except (FrameError, OSError) as e: sys.exit(f'error: {e}') print(json.dumps(r, indent=1)) if __name__ == '__main__': main()