/* SPDX-License-Identifier: LGPL-2.1-or-later */
-#include <getopt.h>
#include <locale.h>
#include <stdio.h>
#include "build.h"
#include "discover-image.h"
#include "env-util.h"
+#include "format-table.h"
#include "hexdecoct.h"
#include "import-common.h"
#include "import-util.h"
#include "log.h"
#include "main-func.h"
#include "oci-util.h"
+#include "options.h"
#include "parse-argument.h"
#include "parse-util.h"
#include "path-util.h"
sd_event_exit(event, ABS(error));
}
-static int verb_pull_tar(int argc, char *argv[], uintptr_t _data, void *userdata) {
+VERB(verb_tar, "tar", "URL [NAME]", 2, 3, 0, "Download a TAR image");
+static int verb_tar(int argc, char *argv[], uintptr_t _data, void *userdata) {
_cleanup_free_ char *ll = NULL, *normalized = NULL;
_cleanup_(sd_event_unrefp) sd_event *event = NULL;
_cleanup_(tar_pull_unrefp) TarPull *pull = NULL;
sd_event_exit(event, ABS(error));
}
-static int verb_pull_raw(int argc, char *argv[], uintptr_t _data, void *userdata) {
+VERB(verb_raw, "raw", "URL [NAME]", 2, 3, 0, "Download a RAW image");
+static int verb_raw(int argc, char *argv[], uintptr_t _data, void *userdata) {
_cleanup_free_ char *ll = NULL, *normalized = NULL;
_cleanup_(sd_event_unrefp) sd_event *event = NULL;
_cleanup_(raw_pull_unrefp) RawPull *pull = NULL;
sd_event_exit(event, ABS(error));
}
-static int verb_pull_oci(int argc, char *argv[], uintptr_t _data, void *userdata) {
+VERB(verb_oci, "oci", "REF [NAME]", 2, 3, 0, "Download an OCI image");
+static int verb_oci(int argc, char *argv[], uintptr_t _data, void *userdata) {
int r;
const char *ref = argv[1];
}
static int help(void) {
- printf("%1$s [OPTIONS...] {COMMAND} ...\n"
- "\n%4$sDownload disk images.%5$s\n"
- "\n%2$sCommands:%3$s\n"
- " tar URL [NAME] Download a TAR image\n"
- " raw URL [NAME] Download a RAW image\n"
- " oci REF [NAME] Download an OCI image\n"
- "\n%2$sOptions:%3$s\n"
- " -h --help Show this help\n"
- " --version Show package version\n"
- " --force Force creation of image\n"
- " --verify=MODE Verify downloaded image, one of: 'no',\n"
- " 'checksum', 'signature' or literal SHA256 hash\n"
- " --settings=BOOL Download settings file with image\n"
- " --roothash=BOOL Download root hash file with image\n"
- " --roothash-signature=BOOL\n"
- " Download root hash signature file with image\n"
- " --verity=BOOL Download verity file with image\n"
- " --image-root=PATH Image root directory\n"
- " --read-only Create a read-only image\n"
- " --direct Download directly to specified file\n"
- " --btrfs-subvol=BOOL Controls whether to create a btrfs subvolume\n"
- " instead of a directory\n"
- " --btrfs-quota=BOOL Controls whether to set up quota for btrfs\n"
- " subvolume\n"
- " --convert-qcow2=BOOL Controls whether to convert QCOW2 images to\n"
- " regular disk images\n"
- " --sync=BOOL Controls whether to sync() before completing\n"
- " --offset=BYTES Offset to seek to in destination\n"
- " --size-max=BYTES Maximum number of bytes to write to destination\n"
- " --class=CLASS Select image class (machine, sysext, confext,\n"
- " portable)\n"
- " --keep-download=BOOL Keep a copy pristine copy of the downloaded file\n"
- " around\n"
- " --system Operate in per-system mode\n"
- " --user Operate in per-user mode\n",
+ _cleanup_(table_unrefp) Table *options = NULL, *verbs = NULL;
+ int r;
+
+ r = verbs_get_help_table(&verbs);
+ if (r < 0)
+ return r;
+
+ r = option_parser_get_help_table(&options);
+ if (r < 0)
+ return r;
+
+ (void) table_sync_column_widths(0, verbs, options);
+
+ printf("%s [OPTIONS...] {COMMAND} ...\n\n"
+ "%sDownload disk images.%s\n"
+ "\n%sCommands:%s\n",
program_invocation_short_name,
- ansi_underline(),
- ansi_normal(),
ansi_highlight(),
+ ansi_normal(),
+ ansi_underline(),
ansi_normal());
+ r = table_print_or_warn(verbs);
+ if (r < 0)
+ return r;
+
+ printf("\n%sOptions:%s\n",
+ ansi_underline(),
+ ansi_normal());
+
+ r = table_print_or_warn(options);
+ if (r < 0)
+ return r;
+
return 0;
}
-static int verb_help(int argc, char *argv[], uintptr_t _data, void *userdata) {
- return help();
-}
+VERB_COMMON_HELP_HIDDEN(help);
-static int parse_argv(int argc, char *argv[]) {
- enum {
- ARG_VERSION = 0x100,
- ARG_FORCE,
- ARG_IMAGE_ROOT,
- ARG_VERIFY,
- ARG_SETTINGS,
- ARG_ROOTHASH,
- ARG_ROOTHASH_SIGNATURE,
- ARG_VERITY,
- ARG_READ_ONLY,
- ARG_DIRECT,
- ARG_BTRFS_SUBVOL,
- ARG_BTRFS_QUOTA,
- ARG_CONVERT_QCOW2,
- ARG_SYNC,
- ARG_OFFSET,
- ARG_SIZE_MAX,
- ARG_CLASS,
- ARG_KEEP_DOWNLOAD,
- ARG_SYSTEM,
- ARG_USER,
- };
-
- static const struct option options[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, ARG_VERSION },
- { "force", no_argument, NULL, ARG_FORCE },
- { "image-root", required_argument, NULL, ARG_IMAGE_ROOT },
- { "verify", required_argument, NULL, ARG_VERIFY },
- { "settings", required_argument, NULL, ARG_SETTINGS },
- { "roothash", required_argument, NULL, ARG_ROOTHASH },
- { "roothash-signature", required_argument, NULL, ARG_ROOTHASH_SIGNATURE },
- { "verity", required_argument, NULL, ARG_VERITY },
- { "read-only", no_argument, NULL, ARG_READ_ONLY },
- { "direct", no_argument, NULL, ARG_DIRECT },
- { "btrfs-subvol", required_argument, NULL, ARG_BTRFS_SUBVOL },
- { "btrfs-quota", required_argument, NULL, ARG_BTRFS_QUOTA },
- { "convert-qcow2", required_argument, NULL, ARG_CONVERT_QCOW2 },
- { "sync", required_argument, NULL, ARG_SYNC },
- { "offset", required_argument, NULL, ARG_OFFSET },
- { "size-max", required_argument, NULL, ARG_SIZE_MAX },
- { "class", required_argument, NULL, ARG_CLASS },
- { "keep-download", required_argument, NULL, ARG_KEEP_DOWNLOAD },
- { "system", no_argument, NULL, ARG_SYSTEM },
- { "user", no_argument, NULL, ARG_USER },
- {}
- };
-
- int c, r;
+static int parse_argv(int argc, char *argv[], char ***ret_args) {
+ int r;
bool auto_settings = true, auto_keep_download = true;
assert(argc >= 0);
assert(argv);
- while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0)
+ OptionParser state = { argc, argv };
+ const char *arg;
+ FOREACH_OPTION(&state, c, &arg, /* on_error= */ return c)
switch (c) {
- case 'h':
+ OPTION_COMMON_HELP:
return help();
- case ARG_VERSION:
+ OPTION_COMMON_VERSION:
return version();
- case ARG_FORCE:
+ OPTION_LONG("force", NULL, "Force creation of image"):
arg_import_flags |= IMPORT_FORCE;
break;
- case ARG_IMAGE_ROOT:
- r = parse_path_argument(optarg, /* suppress_root= */ false, &arg_image_root);
+ OPTION_LONG("image-root", "PATH", "Image root directory"):
+ r = parse_path_argument(arg, /* suppress_root= */ false, &arg_image_root);
if (r < 0)
return r;
-
break;
- case ARG_VERIFY: {
+ OPTION_LONG("verify", "MODE",
+ "Verify downloaded image, one of: 'no', 'checksum', 'signature' or literal SHA256 hash"): {
ImportVerify v;
- v = import_verify_from_string(optarg);
+ v = import_verify_from_string(arg);
if (v < 0) {
_cleanup_free_ void *h = NULL;
size_t n;
/* If this is not a valid verification mode, maybe it's a literally specified
* SHA256 hash? We can handle that too... */
- r = unhexmem(optarg, &h, &n);
+ r = unhexmem(arg, &h, &n);
if (r < 0 || n == 0)
return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
- "Invalid verification setting: %s", optarg);
+ "Invalid verification setting: %s", arg);
if (n != 32)
return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
"64 hex character SHA256 hash required when specifying explicit checksum, %zu specified", n * 2);
break;
}
- case ARG_SETTINGS:
- r = parse_boolean_argument("--settings=", optarg, NULL);
+ OPTION_LONG("settings", "BOOL", "Download settings file with image"):
+ r = parse_boolean_argument("--settings=", arg, NULL);
if (r < 0)
return r;
auto_settings = false;
break;
- case ARG_ROOTHASH:
- r = parse_boolean_argument("--roothash=", optarg, NULL);
+ OPTION_LONG("roothash", "BOOL", "Download root hash file with image"):
+ r = parse_boolean_argument("--roothash=", arg, NULL);
if (r < 0)
return r;
SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, false);
break;
- case ARG_ROOTHASH_SIGNATURE:
- r = parse_boolean_argument("--roothash-signature=", optarg, NULL);
+ OPTION_LONG("roothash-signature", "BOOL",
+ "Download root hash signature file with image"):
+ r = parse_boolean_argument("--roothash-signature=", arg, NULL);
if (r < 0)
return r;
SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, r);
break;
- case ARG_VERITY:
- r = parse_boolean_argument("--verity=", optarg, NULL);
+ OPTION_LONG("verity", "BOOL", "Download verity file with image"):
+ r = parse_boolean_argument("--verity=", arg, NULL);
if (r < 0)
return r;
SET_FLAG(arg_import_flags, IMPORT_PULL_VERITY, r);
break;
- case ARG_READ_ONLY:
+ OPTION_LONG("read-only", NULL, "Create a read-only image"):
arg_import_flags |= IMPORT_READ_ONLY;
break;
- case ARG_DIRECT:
+ OPTION_LONG("direct", NULL, "Download directly to specified file"):
arg_import_flags |= IMPORT_DIRECT;
arg_import_flags &= ~(IMPORT_PULL_SETTINGS|IMPORT_PULL_ROOTHASH|IMPORT_PULL_ROOTHASH_SIGNATURE|IMPORT_PULL_VERITY);
break;
- case ARG_BTRFS_SUBVOL:
- r = parse_boolean_argument("--btrfs-subvol=", optarg, NULL);
+ OPTION_LONG("btrfs-subvol", "BOOL",
+ "Controls whether to create a btrfs subvolume instead of a directory"):
+ r = parse_boolean_argument("--btrfs-subvol=", arg, NULL);
if (r < 0)
return r;
-
SET_FLAG(arg_import_flags, IMPORT_BTRFS_SUBVOL, r);
break;
- case ARG_BTRFS_QUOTA:
- r = parse_boolean_argument("--btrfs-quota=", optarg, NULL);
+ OPTION_LONG("btrfs-quota", "BOOL",
+ "Controls whether to set up quota for btrfs subvolume"):
+ r = parse_boolean_argument("--btrfs-quota=", arg, NULL);
if (r < 0)
return r;
-
SET_FLAG(arg_import_flags, IMPORT_BTRFS_QUOTA, r);
break;
- case ARG_CONVERT_QCOW2:
- r = parse_boolean_argument("--convert-qcow2=", optarg, NULL);
+ OPTION_LONG("convert-qcow2", "BOOL",
+ "Controls whether to convert QCOW2 images to regular disk images"):
+ r = parse_boolean_argument("--convert-qcow2=", arg, NULL);
if (r < 0)
return r;
-
SET_FLAG(arg_import_flags, IMPORT_CONVERT_QCOW2, r);
break;
- case ARG_SYNC:
- r = parse_boolean_argument("--sync=", optarg, NULL);
+ OPTION_LONG("sync", "BOOL", "Controls whether to sync() before completing"):
+ r = parse_boolean_argument("--sync=", arg, NULL);
if (r < 0)
return r;
-
SET_FLAG(arg_import_flags, IMPORT_SYNC, r);
break;
- case ARG_OFFSET: {
+ OPTION_LONG("offset", "BYTES", "Offset to seek to in destination"): {
uint64_t u;
- r = safe_atou64(optarg, &u);
+ r = safe_atou64(arg, &u);
if (r < 0)
- return log_error_errno(r, "Failed to parse --offset= argument: %s", optarg);
+ return log_error_errno(r, "Failed to parse --offset= argument: %s", arg);
if (!FILE_SIZE_VALID(u))
- return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --offset= switch too large: %s", optarg);
+ return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --offset= switch too large: %s", arg);
arg_offset = u;
break;
}
- case ARG_SIZE_MAX: {
+ OPTION_LONG("size-max", "BYTES", "Maximum number of bytes to write to destination"): {
uint64_t u;
- r = parse_size(optarg, 1024, &u);
+ r = parse_size(arg, 1024, &u);
if (r < 0)
- return log_error_errno(r, "Failed to parse --size-max= argument: %s", optarg);
+ return log_error_errno(r, "Failed to parse --size-max= argument: %s", arg);
if (!FILE_SIZE_VALID(u))
- return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --size-max= switch too large: %s", optarg);
+ return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --size-max= switch too large: %s", arg);
arg_size_max = u;
break;
}
- case ARG_CLASS:
- arg_class = image_class_from_string(optarg);
+ OPTION_LONG("class", "CLASS",
+ "Select image class (machine, sysext, confext, portable)"):
+ arg_class = image_class_from_string(arg);
if (arg_class < 0)
- return log_error_errno(arg_class, "Failed to parse --class= argument: %s", optarg);
-
+ return log_error_errno(arg_class, "Failed to parse --class= argument: %s", arg);
break;
- case ARG_KEEP_DOWNLOAD:
- r = parse_boolean(optarg);
+ OPTION_LONG("keep-download", "BOOL",
+ "Keep a pristine copy of the downloaded file around"):
+ r = parse_boolean(arg);
if (r < 0)
- return log_error_errno(r, "Failed to parse --keep-download= argument: %s", optarg);
+ return log_error_errno(r, "Failed to parse --keep-download= argument: %s", arg);
SET_FLAG(arg_import_flags, IMPORT_PULL_KEEP_DOWNLOAD, r);
auto_keep_download = false;
break;
- case ARG_SYSTEM:
+ OPTION_LONG("system", NULL, "Operate in per-system mode"):
arg_runtime_scope = RUNTIME_SCOPE_SYSTEM;
break;
- case ARG_USER:
+ OPTION_LONG("user", NULL, "Operate in per-user mode"):
arg_runtime_scope = RUNTIME_SCOPE_USER;
break;
-
- case '?':
- return -EINVAL;
-
- default:
- assert_not_reached();
}
/* Make sure offset+size is still in the valid range if both set */
if (arg_runtime_scope == RUNTIME_SCOPE_USER)
arg_import_flags |= IMPORT_FOREIGN_UID;
+ *ret_args = option_parser_get_args(&state);
return 1;
}
log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_SYNC: %m");
}
-static int pull_main(int argc, char *argv[]) {
- static const Verb verbs[] = {
- { "help", VERB_ANY, VERB_ANY, 0, verb_help },
- { "tar", 2, 3, 0, verb_pull_tar },
- { "raw", 2, 3, 0, verb_pull_raw },
- { "oci", 2, 3, 0, verb_pull_oci },
- {}
- };
-
- return dispatch_verb(argc, argv, verbs, NULL);
-}
-
static int run(int argc, char *argv[]) {
int r;
parse_env();
- r = parse_argv(argc, argv);
+ char **args = NULL;
+ r = parse_argv(argc, argv, &args);
if (r <= 0)
return r;
(void) ignore_signals(SIGPIPE);
- return pull_main(argc, argv);
+ return dispatch_verb_with_args(args, NULL);
}
DEFINE_MAIN_FUNCTION(run);