tools/helpers/arguments.py

   1 # Copyright 2021 Oliver Smith
   2 # SPDX-License-Identifier: GPL-3.0-or-later
   3 import argparse
   4
   5 try:
   6     import argcomplete
   7 except ImportError:
   8     argcomplete = False
   9
  10 import tools.config
  11
  12 """ This file is about parsing command line arguments passed to waydroid, as
  13     well as generating the help pages (waydroid -h). All this is done with
  14     Python's argparse. The parsed arguments get extended and finally stored in
  15     the "args" variable, which is prominently passed to most functions all
  16     over the waydroid code base.
  17
  18     See tools/helpers/args.py for more information about the args variable. """
  19
  20 def arguments_init(subparser):
  21     ret = subparser.add_parser("init", help="set up waydroid specific"
  22                                " configs and install images")
  23     ret.add_argument("-i", "--images_path",
  24                         help="custom path to waydroid images (default in"
  25                              " /var/lib/waydroid/images)")
  26     ret.add_argument("-f", "--force", action="store_true",
  27                      help="re-initialize configs and images")
  28     ret.add_argument("-c", "--system_channel",
  29                      help="custom system channel (options: OTA channel URL; default is Official OTA server)")
  30     ret.add_argument("-v", "--vendor_channel",
  31                      help="custom vendor channel (options: OTA channel URL; default is Official OTA server)")
  32     ret.add_argument("-r", "--rom_type",
  33                      help="rom type (options: \"lineage\", \"bliss\" or OTA channel URL; default is LineageOS)")
  34     ret.add_argument("-s", "--system_type",
  35                      help="system type (options: VANILLA, FOSS or GAPPS; default is VANILLA)")
  36     return ret
  37
  38 def arguments_status(subparser):
  39     ret = subparser.add_parser("status",
  40                                help="quick check for the waydroid")
  41     return ret
  42
  43 def arguments_upgrade(subparser):
  44     ret = subparser.add_parser("upgrade", help="upgrade images")
  45     ret.add_argument("-o", "--offline", action="store_true",
  46                      help="just for updating configs")
  47     return ret
  48
  49 def arguments_log(subparser):
  50     ret = subparser.add_parser("log", help="follow the waydroid logfile")
  51     ret.add_argument("-n", "--lines", default="60",
  52                      help="count of initial output lines")
  53     ret.add_argument("-c", "--clear", help="clear the log",
  54                      action="store_true", dest="clear_log")
  55     return ret
  56
  57 def arguments_session(subparser):
  58     ret = subparser.add_parser("session", help="session controller")
  59     sub = ret.add_subparsers(title="subaction", dest="subaction")
  60     sub.add_parser("start", help="start session")
  61     sub.add_parser("stop", help="start session")
  62     return ret
  63
  64 def arguments_container(subparser):
  65     ret = subparser.add_parser("container", help="container controller")
  66     sub = ret.add_subparsers(title="subaction", dest="subaction")
  67     sub.add_parser("start", help="start container")
  68     sub.add_parser("stop", help="stop container")
  69     sub.add_parser("restart", help="restart container")
  70     sub.add_parser("freeze", help="freeze container")
  71     sub.add_parser("unfreeze", help="unfreeze container")
  72     return ret
  73
  74 def arguments_app(subparser):
  75     ret = subparser.add_parser("app", help="applications controller")
  76     sub = ret.add_subparsers(title="subaction", dest="subaction")
  77     install = sub.add_parser(
  78         "install", help="push a single package to the container and install it")
  79     install.add_argument('PACKAGE', help="path to apk file")
  80     remove = sub.add_parser(
  81         "remove", help="remove single app package from the container")
  82     remove.add_argument('PACKAGE', help="package name of app to remove")
  83     launch = sub.add_parser("launch", help="start single application")
  84     launch.add_argument('PACKAGE', help="package name of app to launch")
  85     intent = sub.add_parser("intent", help="start single application")
  86     intent.add_argument('ACTION', help="action name")
  87     intent.add_argument('URI', help="data uri")
  88     sub.add_parser("list", help="list installed applications")
  89     return ret
  90
  91 def arguments_prop(subparser):
  92     ret = subparser.add_parser("prop", help="android properties controller")
  93     sub = ret.add_subparsers(title="subaction", dest="subaction")
  94     get = sub.add_parser(
  95         "get", help="get value of property from container")
  96     get.add_argument('key', help="key of the property to get")
  97     set = sub.add_parser(
  98         "set", help="set value to property on container")
  99     set.add_argument('key', help="key of the property to set")
 100     set.add_argument('value', help="value of the property to set")
 101     return ret
 102
 103 def arguments_fullUI(subparser):
 104     ret = subparser.add_parser("show-full-ui", help="show android full screen in window")
 105     return ret
 106
 107 def arguments_shell(subparser):
 108     ret = subparser.add_parser("shell", help="run remote shell command")
 109     ret.add_argument('COMMAND', nargs='?', help="command to run")
 110     return ret
 111
 112 def arguments_logcat(subparser):
 113     ret = subparser.add_parser("logcat", help="show android logcat")
 114     return ret
 115
 116 def arguments():
 117     parser = argparse.ArgumentParser(prog="waydroid")
 118
 119     # Other
 120     parser.add_argument("-V", "--version", action="version",
 121                         version=tools.config.version)
 122
 123     # Logging
 124     parser.add_argument("-l", "--log", dest="log", default=None,
 125                         help="path to log file")
 126     parser.add_argument("--details-to-stdout", dest="details_to_stdout",
 127                         help="print details (e.g. build output) to stdout,"
 128                              " instead of writing to the log",
 129                         action="store_true")
 130     parser.add_argument("-v", "--verbose", dest="verbose",
 131                         action="store_true", help="write even more to the"
 132                         " logfiles (this may reduce performance)")
 133     parser.add_argument("-q", "--quiet", dest="quiet", action="store_true",
 134                         help="do not output any log messages")
 135     parser.add_argument("-w", "--wait", dest="wait_for_init", action="store_true",
 136                         help="wait for init before running")
 137
 138     # Actions
 139     sub = parser.add_subparsers(title="action", dest="action")
 140
 141     arguments_status(sub)
 142     arguments_log(sub)
 143     arguments_init(sub)
 144     arguments_upgrade(sub)
 145     arguments_session(sub)
 146     arguments_container(sub)
 147     arguments_app(sub)
 148     arguments_prop(sub)
 149     arguments_fullUI(sub)
 150     arguments_shell(sub)
 151     arguments_logcat(sub)
 152
 153     if argcomplete:
 154         argcomplete.autocomplete(parser, always_complete_options="long")
 155
 156     # Parse and extend arguments (also backup unmodified result from argparse)
 157     args = parser.parse_args()
 158     return args