githubmirror/nvme-cli

plugin.c
296 строк7 KB
Daniel Wagner
nvme: add support for global options before command
31 май 2026, 18:12
31 май 2026, 18:123917035
// SPDX-License-Identifier: GPL-2.0-or-later
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

#include <libnvme.h>

#include "nvme.h"
#include "plugin.h"
#include "util/argconfig.h"
#include "util/cleanup.h"

static int version_cmd(struct plugin *plugin)
{
	struct program *prog = plugin->parent;

	if (plugin->name) {
		printf("%s %s version %s (git %s)\n",
			prog->name, plugin->name, plugin->version, GIT_VERSION);
	} else {
		printf("%s version %s (git %s)\n",
		       prog->name, prog->version, GIT_VERSION);
	}
	printf("libnvme version %s (git %s)\n",
		libnvme_get_version(LIBNVME_VERSION_PROJECT),
		libnvme_get_version(LIBNVME_VERSION_GIT));
	return 0;
}

static int help(int argc, char **argv, struct plugin *plugin)
{
	char man[0x100];
	struct program *prog = plugin->parent;
	char *str = argv[1];
	int i;

	if (argc == 1) {
		general_help(plugin, NULL);
		return 0;
	}

	for (i = 0; plugin->commands[i]; i++) {
		struct command *command = plugin->commands[i];

		if (strcmp(str, command->name))
			if (!command->alias ||
			    (command->alias && strcmp(str, command->alias)))
				continue;

		if (plugin->name)
			snprintf(man, sizeof(man), "%s-%s-%s", prog->name,
				plugin->name, command->name);
		else
			snprintf(man, sizeof(man), "%s-%s", prog->name, command->name);
		if (execlp("man", "man", man, (char *)NULL))
			perror(argv[1]);
	}

	general_help(plugin, str);

	return 0;
}

static void usage_cmd(struct plugin *plugin)
{
	struct program *prog = plugin->parent;

	if (plugin->name)
		printf("usage: %s %s %s\n", prog->name, plugin->name, prog->usage);
	else
		printf("usage: %s %s\n", prog->name, prog->usage);
}

void general_help(struct plugin *plugin, char *str)
{
	struct program *prog = plugin->parent;
	struct plugin *extension;
	unsigned int i = 0;
	unsigned int padding = 15;
	unsigned int curr_length = 0;

	printf("%s-%s\n", prog->name, prog->version);

	usage_cmd(plugin);

	printf("\n");
	print_word_wrapped(prog->desc, 0, 0, stdout);
	printf("\n");

	if (plugin->desc) {
		printf("\n");
		print_word_wrapped(plugin->desc, 0, 0, stdout);
		printf("\n");
	}

	printf("\nThe following are all implemented sub-commands:\n");
	if (str)
		printf("Note: Only sub-commands including %s\n", str);

	/*
	 * iterate through all commands to get maximum length
	 * Still need to handle the case of ultra long strings, help messages, etc
	 */
	for (; plugin->commands[i]; i++) {
		curr_length = 2 + strlen(plugin->commands[i]->name);
		if (padding < curr_length)
			padding = curr_length;
	}

	i = 0;
	for (; plugin->commands[i]; i++) {
		if (!str || strstr(plugin->commands[i]->name, str))
			printf("  %-*s %s\n", padding, plugin->commands[i]->name,
			       plugin->commands[i]->help);
	}

	if (!str || strstr("version", str))
		printf("  %-*s %s\n", padding, "version", "Shows the program version");
	if (!str || strstr("help", str))
		printf("  %-*s %s\n", padding, "help", "Display this help");
	printf("\n");

	if (plugin->name)
		printf("See '%s %s help <command>' for more information on a specific command\n",
			prog->name, plugin->name);
	else
		printf("See '%s help <command>' for more information on a specific command\n",
			prog->name);

	/*
	 * The first plugin is the built-in. If we're not showing help for the
	 * built-in, don't show the program's other extensions
	 */
	if (plugin->name)
		return;

	extension = prog->extensions->next;
	if (!extension)
		return;

	printf("\nThe following are all installed plugin extensions:\n");
	if (str)
		printf("Note: Only extensions including %s\n", str);

	while (extension) {
		if (!str || strstr(extension->name, str))
			printf("  %-*s %s\n", 15, extension->name, extension->desc);
		extension = extension->next;
	}
	printf("\nSee '%s <plugin> help' for more information on a plugin\n",
			prog->name);
}

int handle_plugin(int argc, char **argv, struct plugin *plugin)
{
	char use[0x100];
	struct plugin *extension;
	struct program *prog = plugin->parent;
	struct command **cmd = plugin->commands;
	struct command *cr = NULL;
	bool opt_help = false, opt_version = false;
	bool cr_valid = false;
	char *str;
	int err;

	if (!argc) {
		general_help(plugin, NULL);
		return 0;
	}

	/*
	 * look for global options before the sub command parser and
	 * pre-fill the global nvme_args variable.
	 */
	NVME_ARGS(global_opts,
		OPT_FLAG("help",     'h', &opt_help,     "show help text"),
		OPT_FLAG("version",  'V', &opt_version,  "show version"));
	err = argconfig_parse_global(argc, argv, global_opts);
	if (err) {
		general_help(plugin, NULL);
		return err;
	}

	argc -= optind;
	argv += optind;

	if (opt_help) {
		__cleanup_free char **help_argv = NULL;
		__cleanup_free char *help_name = NULL;

		if (argc <= 0) {
			general_help(plugin, NULL);
			return 0;
		}

		help_argv = malloc((argc + 1) * sizeof(*help_argv));
		if (!help_argv)
			return -ENOMEM;

		help_name = strdup("help");
		if (!help_name)
			return -ENOMEM;

		help_argv[0] = help_name;
		memcpy(&help_argv[1], argv, argc * sizeof(*argv));
		return help(argc + 1, help_argv, plugin);
	}

	if (opt_version)
		return version_cmd(plugin);

	if (!argc) {
		general_help(plugin, NULL);
		return 0;
	}

	str = argv[0];

	if (!plugin->name)
		snprintf(use, sizeof(use), "%s %s <device> [OPTIONS]", prog->name, str);
	else
		snprintf(use, sizeof(use), "%s %s %s <device> [OPTIONS]", prog->name, plugin->name, str);
	argconfig_append_usage(use);

	if (!strcmp(str, "help"))
		return help(argc, argv, plugin);
	if (!strcmp(str, "version"))
		return version_cmd(plugin);

	while (*cmd) {
		if (!strcmp(str, (*cmd)->name) ||
		    ((*cmd)->alias && !strcmp(str, (*cmd)->alias)))
			return (*cmd)->fn(argc, argv, *cmd, plugin);
		if (!strncmp(str, (*cmd)->name, strlen(str))) {
			if (cr) {
				cr_valid = false;
			} else {
				cr = *cmd;
				cr_valid = true;
			}
		}
		cmd++;
	}

	if (cr && cr_valid) {
		snprintf(use, sizeof(use), "%s %s <device> [OPTIONS]", prog->name, cr->name);
		argconfig_append_usage(use);
		return cr->fn(argc, argv, cr, plugin);
	}

	/* Check extensions only if this is running the built-in plugin */
	if (plugin->name) {
		printf("ERROR: Invalid sub-command '%s' for plugin %s\n", str, plugin->name);
		return -ENOTTY;
	}

	extension = plugin->next;
	while (extension) {
		if (!strcmp(str, extension->name))
			return handle_plugin(argc, argv, extension);
		extension = extension->next;
	}

	/*
	 * If the command is executed with the extension name and
	 * command together ("plugin-command"), run the plug in
	 */
	extension = plugin->next;
	while (extension) {
		if (!strncmp(str, extension->name, strlen(extension->name))) {
			__cleanup_free char **sub_argv = NULL;
			__cleanup_free char *name_copy = NULL;

			sub_argv = malloc((argc + 1) * sizeof(*sub_argv));
			if (!sub_argv)
				return -ENOMEM;

			argv[0] += strlen(extension->name);
			while (*argv[0] == '-')
				argv[0]++;

			name_copy = strdup(extension->name);
			if (!name_copy)
				return -ENOMEM;

			sub_argv[0] = name_copy;
			memcpy(&sub_argv[1], argv, argc * sizeof(*argv));

			return handle_plugin(argc + 1, sub_argv, extension);
		}
		extension = extension->next;
	}
	printf("ERROR: Invalid sub-command '%s'\n", str);
	return -ENOTTY;
}