mirror of
https://git.undefined-dev.fr/Blendman974/faceclaw.git
synced 2026-11-19 21:03:09 +00:00
iOS porting: EvenHub app compatibility first pass
This commit is contained in:
1 parent
79b6c276f8
commit
44bd1d8a2d
24 files changed
+843
-24
No files matched your search
@@ -0,0 +1,53 @@
|
||||
# iOS config transfer
|
||||
|
||||
Requires Xcode, Python 3, a development build with `FaceclawConfigPort`, and an
|
||||
unlocked/trusted iPhone. Both commands restart Faceclaw, briefly interrupting its
|
||||
Bluetooth and Terminal sessions.
|
||||
|
||||
```sh
|
||||
scripts/pull_config_ios.sh # faceclaw_settings.ios.json
|
||||
scripts/push_config_ios.sh # import the edited file
|
||||
scripts/pull_config_ios.sh -f /tmp/settings.json --device IPHONE_UDID
|
||||
scripts/push_config_ios.sh faceclaw_settings.xml # Android pull_config.sh output
|
||||
```
|
||||
|
||||
Use `--device` / `-d` or set `IOS_DEVICE` when more than one device is connected.
|
||||
Without either, the script selects the only device with an active Xcode tunnel.
|
||||
For the simulator, add `--simulator` (defaults to `booted`; `--device` selects one).
|
||||
|
||||
The JSON format preserves setting types:
|
||||
|
||||
```json
|
||||
{
|
||||
"schema": 1,
|
||||
"settings": {
|
||||
"terminal.connections": "[]",
|
||||
"terminal.autoReconnect": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Pull accepts an `.xml` output filename to write Android shared-preferences XML.
|
||||
Push detects JSON or XML by content and supports strings, booleans and numbers.
|
||||
Malformed input, unsupported values and files over 2 MiB fail before restarting
|
||||
the app. Push **merges supplied keys**, preserving omitted settings (including
|
||||
phone-specific pairing). To clear a value, supply its empty/default value.
|
||||
|
||||
Transfers use `devicectl` app-container access. The app consumes a uniquely
|
||||
identified request at bootstrap, before loading settings getters and workers;
|
||||
it applies imports through NSUserDefaults rather than overwriting a plist that
|
||||
cfprefsd could restore from cache. Each successful push first saves the previous
|
||||
preferences to `Library/FaceclawConfigPort/previous.plist`. Replies are checked
|
||||
against the request ID, so a stale export cannot appear to confirm an import.
|
||||
|
||||
Exports may contain API keys and Terminal tokens. Scripts do not print values,
|
||||
write local exports with mode 600, and remove their private temporary directory
|
||||
on exit. Default export filenames are gitignored. Device request/reply/backup
|
||||
files stay in the private Library directory, outside Files/Finder Documents.
|
||||
|
||||
Terminal's configured `g2mirror://` scheme uses plain WebSockets; `g2mirrors://`
|
||||
uses TLS. The iOS build declares local networking and an explicit ATS exception
|
||||
for the current development server `100.68.94.67`. On iOS 17+, another literal IP
|
||||
requires its own build-time `NSExceptionDomains` entry, or a TLS endpoint. The
|
||||
exception does not disable TLS certificate verification. See Apple's
|
||||
[IP exception rules](https://developer.apple.com/documentation/bundleresources/information-property-list/nsapptransportsecurity/nsexceptiondomains).
|
||||
@@ -0,0 +1,197 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Transfer Faceclaw preferences using Xcode's supported app-container APIs."""
|
||||
import argparse
|
||||
import json
|
||||
import math
|
||||
import os
|
||||
from pathlib import Path
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import time
|
||||
import uuid
|
||||
import xml.etree.ElementTree as ET
|
||||
|
||||
BUNDLE = 'com.faceclaw.app'
|
||||
REMOTE = 'Library/FaceclawConfigPort'
|
||||
LIMIT = 2 * 1024 * 1024
|
||||
|
||||
|
||||
def validate(settings):
|
||||
if not isinstance(settings, dict) or len(settings) > 4096:
|
||||
raise ValueError('Expected a settings object with at most 4096 entries')
|
||||
for key, value in settings.items():
|
||||
if not isinstance(key, str) or not key or len(key) > 512:
|
||||
raise ValueError('Invalid setting name')
|
||||
if type(value) not in (str, bool, int, float) or isinstance(value, float) and not math.isfinite(value):
|
||||
raise ValueError('Settings must contain only strings, booleans and finite numbers')
|
||||
return settings
|
||||
|
||||
|
||||
def read_config(path):
|
||||
data = Path(path).read_bytes()
|
||||
if len(data) > LIMIT:
|
||||
raise ValueError('Config exceeds 2 MiB')
|
||||
if data.lstrip().startswith(b'<'):
|
||||
if b'<!DOCTYPE' in data.upper() or b'<!ENTITY' in data.upper():
|
||||
raise ValueError('XML declarations of document types/entities are not supported')
|
||||
root = ET.fromstring(data)
|
||||
if root.tag != 'map':
|
||||
raise ValueError('Expected Android shared-preferences <map>')
|
||||
settings = {}
|
||||
for item in root:
|
||||
key = item.get('name')
|
||||
if key in settings:
|
||||
raise ValueError('Duplicate setting name')
|
||||
if item.tag == 'string':
|
||||
value = item.text or ''
|
||||
elif item.tag == 'boolean' and item.get('value') in ('true', 'false'):
|
||||
value = item.get('value') == 'true'
|
||||
elif item.tag in ('int', 'long', 'float'):
|
||||
try:
|
||||
value = float(item.get('value', '')) if item.tag == 'float' else int(item.get('value', ''))
|
||||
except ValueError:
|
||||
raise ValueError('Invalid numeric preference value') from None
|
||||
else:
|
||||
raise ValueError('Unsupported Android preference type')
|
||||
if len(item):
|
||||
raise ValueError('Nested preference content is not supported')
|
||||
settings[key] = value
|
||||
else:
|
||||
config = json.loads(data)
|
||||
if not isinstance(config, dict) or config.get('schema') != 1:
|
||||
raise ValueError('Expected Faceclaw config with schema: 1 and a settings object')
|
||||
settings = config.get('settings')
|
||||
return validate(settings)
|
||||
|
||||
|
||||
def encode_config(settings, xml=False):
|
||||
validate(settings)
|
||||
if not xml:
|
||||
return (json.dumps({'schema': 1, 'settings': settings}, indent=2, ensure_ascii=False, allow_nan=False) + '\n').encode()
|
||||
root = ET.Element('map')
|
||||
for key, value in sorted(settings.items()):
|
||||
if isinstance(value, str):
|
||||
ET.SubElement(root, 'string', name=key).text = value
|
||||
else:
|
||||
kind = 'boolean' if isinstance(value, bool) else 'long' if isinstance(value, int) else 'float'
|
||||
ET.SubElement(root, kind, name=key, value=str(value).lower())
|
||||
ET.indent(root)
|
||||
return ET.tostring(root, encoding='utf-8', xml_declaration=True) + b'\n'
|
||||
|
||||
|
||||
def run(args, tolerate=False):
|
||||
try:
|
||||
result = subprocess.run(['xcrun', *args], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True, timeout=30)
|
||||
except subprocess.TimeoutExpired:
|
||||
if tolerate:
|
||||
return subprocess.CompletedProcess(args, 1, '', 'Xcode device command timed out')
|
||||
raise RuntimeError('Xcode device command timed out; check that the phone is connected and unlocked') from None
|
||||
if result.returncode and not tolerate:
|
||||
raise RuntimeError(result.stderr.strip() or result.stdout.strip() or 'Xcode device command failed')
|
||||
return result
|
||||
|
||||
|
||||
def atomic_write(path, data):
|
||||
path = Path(path).absolute()
|
||||
with tempfile.NamedTemporaryFile(dir=path.parent, delete=False) as output:
|
||||
temporary = Path(output.name)
|
||||
try:
|
||||
os.chmod(temporary, 0o600)
|
||||
output.write(data)
|
||||
output.flush()
|
||||
os.fsync(output.fileno())
|
||||
os.replace(temporary, path)
|
||||
finally:
|
||||
temporary.unlink(missing_ok=True)
|
||||
|
||||
|
||||
def transfer(args):
|
||||
# Parse and validate before touching the device or restarting its app.
|
||||
settings = read_config(args.file) if args.operation == 'push' else None
|
||||
with tempfile.TemporaryDirectory(prefix='faceclaw-config-') as work:
|
||||
work = Path(work)
|
||||
device = args.device or os.environ.get('IOS_DEVICE')
|
||||
if args.simulator:
|
||||
device = device or 'booted'
|
||||
container = Path(run(['simctl', 'get_app_container', device, BUNDLE, 'data']).stdout.strip())
|
||||
else:
|
||||
if not device:
|
||||
listing = work / 'devices.json'
|
||||
run(['devicectl', 'list', 'devices', '--json-output', str(listing)])
|
||||
devices = json.loads(listing.read_text())['result']['devices']
|
||||
available = [d for d in devices if d.get('connectionProperties', {}).get('tunnelState') == 'connected']
|
||||
if len(available) != 1:
|
||||
raise ValueError('Specify the iPhone with --device UDID (or IOS_DEVICE)')
|
||||
device = available[0]['identifier']
|
||||
identifier = str(uuid.uuid4())
|
||||
payload = {'id': identifier, 'operation': args.operation}
|
||||
if settings is not None:
|
||||
payload['settings'] = settings
|
||||
encoded = json.dumps(payload, ensure_ascii=False, allow_nan=False).encode()
|
||||
if len(encoded) > LIMIT:
|
||||
raise ValueError('Config request exceeds 2 MiB')
|
||||
stage = work / 'FaceclawConfigPort'
|
||||
stage.mkdir(mode=0o700)
|
||||
atomic_write(stage / 'request.json', encoded)
|
||||
if args.simulator:
|
||||
remote = container / REMOTE
|
||||
remote.mkdir(parents=True, exist_ok=True)
|
||||
atomic_write(remote / 'request.json', encoded)
|
||||
run(['simctl', 'terminate', device, BUNDLE], tolerate=True)
|
||||
run(['simctl', 'launch', device, BUNDLE])
|
||||
else:
|
||||
run(['devicectl', 'device', 'copy', 'to', '--device', device, '--domain-type', 'appDataContainer',
|
||||
'--domain-identifier', BUNDLE, '--source', str(stage), '--destination', REMOTE])
|
||||
run(['devicectl', 'device', 'process', 'launch', '--device', device, '--terminate-existing', BUNDLE])
|
||||
deadline = time.monotonic() + 25
|
||||
response = None
|
||||
while time.monotonic() < deadline:
|
||||
if args.simulator:
|
||||
response_path = remote / 'response.json'
|
||||
else:
|
||||
response_path = work / 'response.json'
|
||||
run(['devicectl', 'device', 'copy', 'from', '--device', device, '--domain-type', 'appDataContainer',
|
||||
'--domain-identifier', BUNDLE, '--source', REMOTE + '/response.json', '--destination', str(response_path)], tolerate=True)
|
||||
try:
|
||||
candidate = json.loads(response_path.read_text())
|
||||
if candidate.get('id') == identifier:
|
||||
response = candidate
|
||||
break
|
||||
except (OSError, ValueError):
|
||||
pass
|
||||
time.sleep(0.5)
|
||||
if response is None:
|
||||
raise RuntimeError('No matching config response. Unlock the phone and install a build with config-port support, then retry.')
|
||||
if not response.get('ok'):
|
||||
raise RuntimeError(response.get('message', 'Config transfer failed'))
|
||||
if args.operation == 'pull':
|
||||
settings = response['config']['settings']
|
||||
atomic_write(args.file, encode_config(settings, Path(args.file).suffix.lower() == '.xml'))
|
||||
print(f'Pulled {len(settings)} settings to {args.file} (mode 600). App restarted.')
|
||||
else:
|
||||
print(f'Pushed {response["count"]} settings; app restarted. Unspecified settings preserved; previous preferences backed up in {REMOTE}/previous.plist.')
|
||||
|
||||
|
||||
def main():
|
||||
os.umask(0o077)
|
||||
parser = argparse.ArgumentParser(description='Pull/push iOS Faceclaw config; restarts the app. Requires Xcode and an unlocked development device. Push merges supplied keys; accepts Android XML or Faceclaw JSON.')
|
||||
parser.add_argument('operation', choices=['pull', 'push'])
|
||||
parser.add_argument('path', nargs='?')
|
||||
parser.add_argument('-f', '--file')
|
||||
parser.add_argument('-d', '--device', help='iPhone UDID/name, or simulator ID with --simulator; defaults to IOS_DEVICE or the only connected device')
|
||||
parser.add_argument('--simulator', action='store_true', help='Use simctl (default device: booted)')
|
||||
args = parser.parse_args()
|
||||
if args.path and args.file:
|
||||
parser.error('Specify one file, either positional or with -f')
|
||||
args.file = args.file or args.path or 'faceclaw_settings.ios.json'
|
||||
try:
|
||||
transfer(args)
|
||||
except (OSError, ValueError, RuntimeError, ET.ParseError) as error:
|
||||
print(f'Error: {error}', file=sys.stderr)
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(main())
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
exec python3 "$(cd "$(dirname "$0")" && pwd)/ios_config.py" pull "$@"
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
exec python3 "$(cd "$(dirname "$0")" && pwd)/ios_config.py" push "$@"
|
||||
Reference in new issue
Block a user