"""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|list|launch PKG|stop PKG|remove PKG|probe PKG} """ import glob, json, os, re, shlex, subprocess, sys, threading, time, zipfile, zlib 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') 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: p = subprocess.run(['ssh', *SSH_OPTS, FRAME, cmd], input=input, capture_output=True, 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: return ssh('python3 - ' + ' '.join(shlex.quote(a) for a in args), input=f.read(), 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 aapt2(): found = sorted(glob.glob(os.path.expanduser('~/.homebrew/share/android-commandlinetools/build-tools/*/aapt2')) + glob.glob('/opt/homebrew/share/android-commandlinetools/build-tools/*/aapt2') + glob.glob(os.path.expanduser('~/Library/Android/sdk/build-tools/*/aapt2'))) return found[-1] if found else None def apk_info(path): """Package, label, version, native ABIs and the best PNG icon inside the APK.""" tool = aapt2() if not tool: raise FrameError('aapt2 not found: brew install --cask android-commandlinetools, then ' 'sdkmanager "build-tools;36.0.0"') out = subprocess.run([tool, 'dump', 'badging', path], capture_output=True, text=True).stdout m = re.search(r"package: name='([^']+)'.*?versionName='([^']*)'", out) if not m: raise FrameError(f'not a readable APK: {os.path.basename(path)}') label = re.search(r"application-label(?:-en(?:-US)?)?:'([^']*)'", out) or \ re.search(r"application: label='([^']*)'", out) icons = re.findall(r"application-icon-(\d+):'([^']+)'", out) abis = re.search(r"native-code: (.*)", out) sdk = re.search(r"(?:minSdkVersion|sdkVersion):'(\d+)'", out) info = {'package': m[1], 'version': m[2], 'label': (label[1] if label else '') or m[1], 'abis': re.findall(r"'([^']+)'", abis[1]) if abis else [], 'min_sdk': int(sdk[1]) if sdk else None, 'icon_png': None} try: z = zipfile.ZipFile(path) except (zipfile.BadZipFile, OSError) as e: raise FrameError(f'not a readable APK: {e}') with z: names = set(z.namelist()) for _, icon in sorted(icons, key=lambda d: -int(d[0])): if icon.endswith('.png') and icon in names: info['icon_png'] = z.read(icon) break else: # adaptive icons are XML; fall back to the largest launcher PNG pngs = sorted((n for n in names if n.endswith('.png') and 'ic_launcher' in n and 'foreground' not in n), key=lambda n: z.getinfo(n).file_size) if pngs: info['icon_png'] = z.read(pngs[-1]) return info 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 _rsync(src, dest, *extra, timeout=600): try: subprocess.run(['rsync', '-a', *extra, '-e', 'ssh ' + ' '.join(SSH_OPTS), src, f'{FRAME}:{dest}'], check=True, capture_output=True, text=True, timeout=timeout) except subprocess.TimeoutExpired: raise FrameError(f'copying {os.path.basename(src)} to the Frame timed out') except subprocess.CalledProcessError as e: raise FrameError(f'copying {os.path.basename(src)} to the Frame failed: {(e.stderr or "").strip()[-300:]}') 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)) def install(apk_path, flatscreen=True, name=None, source=None, icon_png=None): 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}') with _install_lock: return _install(apk_path, info, pkg, flatscreen, name, source) def _install(apk_path, info, pkg, flatscreen, name, source): iid = instance_id(pkg) d = f'{APPS_DIR}/{pkg}' existing = read_meta(pkg) ok = False try: ssh(f'mkdir -p {d}') _rsync(apk_path, f'{d}/app.apk.part') _rsync(LAUNCHER, f'{d}/launch.sh', '--chmod=u+x', timeout=120) icon = '' if info['icon_png']: ssh(f'cat > {d}/icon.png', input=info['icon_png']) icon = f'$HOME/{d}/icon.png' 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}', icon.replace('$HOME', home)) 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})') meta = {'package': pkg, 'label': name or info['label'], 'version': info['version'], 'instance': iid, 'shortcut': shortcut, 'game_id': game_id(shortcut), 'flatscreen': flatscreen, 'installed': time.strftime('%Y-%m-%dT%H:%M:%S'), 'source': source or os.path.basename(apk_path)} _write_meta(d, meta) ok = True return meta finally: 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 _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 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) 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): m = _meta_or_fail(pkg) stop(pkg) if m['shortcut']: try: shortcut_tool('remove', str(int(m['shortcut']))) except FrameError: pass # already gone from Steam 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 main(): cmd, *args = sys.argv[1:] or ['help'] try: if cmd == 'install': r = install(args[0], flatscreen='--vr' not in args) elif cmd == 'list': r = list_apps() 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 as e: sys.exit(f'error: {e}') print(json.dumps(r, indent=1)) if __name__ == '__main__': main()