adb-pref.py

#! /usr/bin/env python3
# -*- coding: utf-8 -*-

"""
This script generates Android Debug Bridge (ADB) commands that change the preferences in a Kõnele instance
via GetPutPreferenceActivity.
Kõnele must be connected to ADB and for "is_url" preferences also connected to the internet.

Usage:

- Enable developer options on the device and connect to the device via adb.
  See: https://developer.android.com/studio/command-line/adb.html
  For Wear, see: https://developer.android.com/training/wearables/apps/debugging.html
- (Optional) Switch on the Kõnele developer option "Run GetPutPreference without confirmation" to suppress the
  confirmation dialog.
- The input to this script is a list of YAML preference definitions.
- The output of this script should be piped into "sh".
  The progress is printed on the console and shown as "toasts" on the device.

Usage:

    adb-pref.py prefs_developer.yml prefs_user_guide_rewrites.yml prefs_private.yml | sh
    adb-pref.py prefs_private.yml | fgrep "#r" | sh

"""

import sys
import argparse
import re
import yaml

# TODO: support "-s 10.0.0.11:40742 shell" if "adb: more than one device/emulator"
# where the addr:port is read from a commandline argument.
DEFAULT_ADB_COMMAND = "shell"
# DEFAULT_ADB_COMMAND = 'exec-out'

DEFAULT_PREF_DISABLE_CONFIRMATION = {"key": "keyGetPutPrefSkipUi", "val": True}

# Escape for sh.
# TODO: incomplete + should escape for adb as well (e.g. the comma)
RE_SUB_ESCAPE_ESA = [
    (";", "\\;"),
    ("#", "\\#"),
]

RE_SUB_ESCAPE_S = [
    (r"\n", r"\\n"),
    (r"\t", r"\\t"),
    (" ", "\\ "),
]


def apply_sub(rewriter, text):
    """Applies the given sequence of regex replacements to the given text."""
    for x, y in rewriter:
        text = re.sub(x, y, text)
    return text


def get_args():
    """Get command line arguments"""
    parser = argparse.ArgumentParser(
        description="Converts a YAML list of preferences to ADB calls that set these preferences using GetPutPreferenceActivity."
    )
    parser.add_argument(
        "fns", metavar="FILE", type=str, nargs="*", help="preference file"
    )
    parser.add_argument(
        "--disable-confirmation", action="store_true", dest="disable_confirmation"
    )
    parser.add_argument("-v", "--version", action="version", version="%(prog)s v0.1.0")
    return parser.parse_args()


def create_adb(pref):
    """Return the preference as an ADB call"""

    def escape_esa(text):
        return apply_sub(RE_SUB_ESCAPE_ESA, text)

    def escape_s(text):
        return apply_sub(RE_SUB_ESCAPE_S, text)

    key = escape_s(pref["key"])
    val = pref.get("val")
    if val is None:
        val_str = "--esn val"
    elif isinstance(val, list):
        val_str = '--esa val "{}"'.format(",".join(escape_esa(text) for text in val))
    elif isinstance(val, bool):
        val_str = "--ez val {}".format(val)
    elif isinstance(val, int):
        val_str = "--ei val {}".format(val)
    else:
        val_str = "-e val '{}'".format(escape_s(val))
        if pref.get("is_url"):
            val_str += " --ez is_url true"
    return f'adb {DEFAULT_ADB_COMMAND} am start -n ee.ioc.phon.android.speak/.activity.GetPutPreferenceActivity -e key "{key}" {val_str}'


def process(prefs):
    """Output preferences as ADB calls"""
    for pref in prefs:
        print(create_adb(pref))


def main():
    """Main"""
    args = get_args()
    if args.disable_confirmation:
        print(create_adb(DEFAULT_PREF_DISABLE_CONFIRMATION))
    for fn in args.fns:
        with open(fn, "r") as stream:
            try:
                prefs = yaml.safe_load(stream)
                process(prefs)
            except yaml.YAMLError as exc:
                print(exc, file=sys.stderr)


if __name__ == "__main__":
    main()