src/shared/shell.c

// SPDX-License-Identifier: LGPL-2.1-or-later
/*
 *
 *  BlueZ - Bluetooth protocol stack for Linux
 *
 *  Copyright (C) 2017  Intel Corporation. All rights reserved.
 *  Copyright 2024 NXP
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#define _GNU_SOURCE
#include <stdio.h>
#include <errno.h>
#include <syslog.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <signal.h>
#include <sys/signalfd.h>
#include <wordexp.h>
#include <getopt.h>
#include <fcntl.h>

#include <readline/readline.h>
#include <readline/history.h>

#include "src/shared/mainloop.h"
#include "src/shared/timeout.h"
#include "src/shared/io.h"
#include "src/shared/util.h"
#include "src/shared/queue.h"
#include "src/shared/shell.h"
#include "src/shared/log.h"

#define CMD_LENGTH	48
#define print_text(color, fmt, args...) \
		printf(color fmt COLOR_OFF "\n", ## args)
#define print_menu(cmd, args, desc) \
		printf(COLOR_HIGHLIGHT "%s %-*s " COLOR_OFF "%s\n", \
			cmd, (int)(CMD_LENGTH - strlen(cmd)), args, desc)
#define print_submenu(cmd, desc) \
		printf(COLOR_BLUE "%s %-*s " COLOR_OFF "%s\n", \
			cmd, (int)(CMD_LENGTH - strlen(cmd)), "", desc)

struct bt_shell_env {
	char *name;
	void *value;
};

static char *cmplt = "help";

struct bt_shell_prompt_input {
	char *str;
	bt_shell_prompt_input_func func;
	void *user_data;
};

struct input {
	struct io *io;
	FILE *f;
};

typedef enum {
	MODE_INTERACTIVE = 0,
	MODE_NON_INTERACTIVE= 1
} mode_type_t;

static struct {
	bool init;
	char *name;
	char history[256];
	int argc;
	char **argv;
	mode_type_t mode;
	bool zsh;
	bool monitor;
	int timeout;
	int init_fd;
	struct queue *inputs;

	char *line;
	struct queue *queue;

	bool saved_prompt;
	bt_shell_prompt_input_func saved_func;
	void *saved_user_data;

	struct queue *prompts;

	const struct bt_shell_menu *menu;
	const struct bt_shell_menu *main;
	struct queue *submenus;
	const struct bt_shell_menu_entry *exec;

	struct queue *envs;
} data;

static void shell_print_menu(void);
static void shell_print_menu_zsh_complete(void);

static void cmd_version(int argc, char *argv[])
{
	bt_shell_printf("Version %s\n", VERSION);

	return bt_shell_noninteractive_quit(EXIT_SUCCESS);
}

static void cmd_quit(int argc, char *argv[])
{
	mainloop_quit();
}

static void print_cmds(void)
{
	const struct bt_shell_menu_entry *entry;
	const struct queue_entry *submenu;

	if (!data.menu)
		return;

	printf("Commands:\n");

	for (entry = data.menu->entries; entry->cmd; entry++) {
		printf("\t%s%s\t%s\n", entry->cmd,
			strlen(entry->cmd) < 8 ? "\t" : "", entry->desc);
	}

	for (submenu = queue_get_entries(data.submenus); submenu;
					submenu = submenu->next) {
		struct bt_shell_menu *menu = submenu->data;

		printf("\n\t%s.:\n", menu->name);

		for (entry = menu->entries; entry->cmd; entry++) {
			printf("\t\t%s%s\t%s\n", entry->cmd,
				strlen(entry->cmd) < 8 ? "\t" : "",
				entry->desc);
		}
	}
}

static void cmd_help(int argc, char *argv[])
{
	if (argv[0] == cmplt)
		print_cmds();
	else
		shell_print_menu();

	return bt_shell_noninteractive_quit(EXIT_SUCCESS);
}

static const struct bt_shell_menu *find_menu(const char *name, size_t len,
							int *index)
{
	const struct queue_entry *entry;
	int i;

	for (i = 0, entry = queue_get_entries(data.submenus); entry;
						entry = entry->next, i++) {
		struct bt_shell_menu *menu = entry->data;

		if (index) {
			if (i < *index)
				continue;
			(*index)++;
		}

		if (!strncmp(menu->name, name, len))
			return menu;
	}

	return NULL;
}

static char *menu_generator(const char *text, int state)
{
	static unsigned int len;
	static struct queue_entry *entry;

	if (!state) {
		len = strlen(text);
		entry = (void *) queue_get_entries(data.submenus);
	}

	for (; entry; entry = entry->next) {
		struct bt_shell_menu *menu = entry->data;

		if (!strncmp(menu->name, text, len)) {
			entry = entry->next;
			return strdup(menu->name);
		}
	}

	return NULL;
}

static void cmd_menu(int argc, char *argv[])
{
	const struct bt_shell_menu *menu;

	if (argc < 2 || !strlen(argv[1])) {
		bt_shell_printf("Missing name argument\n");
		return bt_shell_noninteractive_quit(EXIT_FAILURE);
	}

	menu = find_menu(argv[1], strlen(argv[1]), NULL);
	if (!menu) {
		bt_shell_printf("Unable find menu with name: %s\n", argv[1]);
		return bt_shell_noninteractive_quit(EXIT_FAILURE);
	}

	bt_shell_set_menu(menu);

	shell_print_menu();

	return bt_shell_noninteractive_quit(EXIT_SUCCESS);
}

static bool cmd_menu_exists(const struct bt_shell_menu *menu)
{
	/* Skip menu command if not on main menu or if there are no
	 * submenus.
	 */
	if (menu != data.main || queue_isempty(data.submenus))
		return false;

	return true;
}

static void cmd_back(int argc, char *argv[])
{
	if (data.menu == data.main) {
		bt_shell_printf("Already on main menu\n");
		return;
	}

	bt_shell_set_menu(data.main);

	shell_print_menu();
}

static bool cmd_back_exists(const struct bt_shell_menu *menu)
{
	/* Skip back command if on main menu */
	if (menu == data.main)
		return false;

	return true;
}

static void cmd_export(int argc, char *argv[])
{
	const struct queue_entry *entry;

	for (entry = queue_get_entries(data.envs); entry; entry = entry->next) {
		struct bt_shell_env *env = entry->data;

		print_text(COLOR_HIGHLIGHT, "%s=%p", env->name, env->value);
	}
}

static int bt_shell_queue_exec(char *line)
{
	/* Ignore comments */
	if (line[0] == '#')
		return 0;

	/* Queue if already executing */
	if (data.line) {
		/* Check if prompt is being held then release using the line */
		if (!bt_shell_release_prompt(line)) {
			bt_shell_printf("%s\n", line);
			return 0;
		}

		queue_push_tail(data.queue, strdup(line));
		return 0;
	}

	bt_shell_printf("%s\n", line);
	data.line = strdup(line);

	return bt_shell_exec(line);
}

static bool bt_shell_input_line(struct input *input)
{
	int fd;
	char *line = NULL;
	size_t len = 0;
	ssize_t nread;

	fd = io_get_fd(input->io);

	if (fd < 0) {
		printf("io_get_fd() returned %d\n", fd);
		return false;
	}

	if (fd == STDIN_FILENO) {
		rl_callback_read_char();
		return true;
	}

	if (!input->f) {
		input->f = fdopen(fd, "r");
		if (!input->f) {
			printf("fdopen: %s (%d)\n", strerror(errno), errno);
			return false;
		}
	}

	nread = getline(&line, &len, input->f);
	if (nread > 0) {
		int err;

		if (line[nread - 1] == '\n')
			line[nread - 1] = '\0';

		err = bt_shell_queue_exec(line);
		if (err < 0)
			printf("%s: %s (%d)\n", line, strerror(-err), -err);
	} else if (input->f) {
		fclose(input->f);
		input->f = NULL;
	}

	free(line);

	return input->f ? true : false;
}

static bool input_read(struct io *io, void *user_data)
{
	return bt_shell_input_line(user_data);
}

static bool input_hup(struct io *io, void *user_data)
{
	if (queue_remove(data.inputs, user_data)) {
		if (!queue_isempty(data.inputs))
			return false;
	}

	mainloop_quit();

	return false;
}

static struct input *input_new(int fd)
{
	struct input *input;
	struct io *io;

	io = io_new(fd);
	if (!io)
		return NULL;

	input = new0(struct input, 1);
	input->io = io;

	queue_push_tail(data.inputs, input);

	return input;
}

static bool bt_shell_input_attach(int fd)
{
	struct input *input;
	struct queue *queue;

	input = input_new(fd);
	if (!input)
		return false;

	/* Save executing queue so input lines can be placed in the correct
	 * order.
	 */
	queue = data.queue;
	data.queue = queue_new();

	while (bt_shell_input_line(input));

	/* Push existing input lines back into the executing queue */
	while (!queue_isempty(queue))
		queue_push_tail(data.queue, queue_pop_head(queue));

	queue_destroy(queue, free);

	return true;
}

static void cmd_script(int argc, char *argv[])
{
	int fd;

	fd = open(argv[1], O_RDONLY);
	if (fd < 0) {
		printf("Unable to open %s: %s (%d)\n", argv[1],
						strerror(errno), errno);
		bt_shell_noninteractive_quit(EXIT_FAILURE);
		return;
	}

	printf("Running script %s...\n", argv[1]);

	if (!bt_shell_input_attach(fd))
		return bt_shell_noninteractive_quit(EXIT_FAILURE);

	return bt_shell_noninteractive_quit(EXIT_SUCCESS);
}

static const struct bt_shell_menu default_menu = {
	.entries = {
	{ "back",         NULL,       cmd_back, "Return to main menu", NULL,
							NULL, cmd_back_exists },
	{ "menu",         "<name>",   cmd_menu, "Select submenu",
							menu_generator, NULL,
							cmd_menu_exists},
	{ "version",      NULL,       cmd_version, "Display version" },
	{ "quit",         NULL,       cmd_quit, "Quit program" },
	{ "exit",         NULL,       cmd_quit, "Quit program" },
	{ "help",         NULL,       cmd_help,
					"Display help about this program" },
	{ "export",       NULL,       cmd_export,
						"Print environment variables" },
	{ "script",       "<filename>", cmd_script, "Run script" },
	{} },
};

static void shell_print_help(void)
{
	print_text(COLOR_HIGHLIGHT,
		"\n"
		"Use \"help\" for a list of available commands in a menu.\n"
		"Use \"menu <submenu>\" if you want to enter any submenu.\n"
		"Use \"back\" if you want to return to menu main.");
}

static void shell_print_menu(void)
{
	const struct bt_shell_menu_entry *entry;
	const struct queue_entry *submenu;

	if (!data.menu)
		return;

	if (data.zsh) {
		shell_print_menu_zsh_complete();
		return;
	}

	print_text(COLOR_HIGHLIGHT, "Menu %s:", data.menu->name);
	print_text(COLOR_HIGHLIGHT, "Available commands:");
	print_text(COLOR_HIGHLIGHT, "-------------------");

	if (data.menu == data.main) {
		for (submenu = queue_get_entries(data.submenus); submenu;
						submenu = submenu->next) {
			struct bt_shell_menu *menu = submenu->data;

			print_submenu(menu->name, menu->desc ? menu->desc :
								"Submenu");
		}
	}

	for (entry = data.menu->entries; entry->cmd; entry++) {
		print_menu(entry->cmd, entry->arg ? : "", entry->desc ? : "");
	}

	for (entry = default_menu.entries; entry->cmd; entry++) {
		if (entry->exists && !entry->exists(data.menu))
			continue;

		print_menu(entry->cmd, entry->arg ? : "", entry->desc ? : "");
	}
}

static void shell_print_menu_zsh_complete(void)
{
	const struct bt_shell_menu_entry *entry;

	for (entry = data.menu->entries; entry->cmd; entry++)
		printf("%s:%s\n", entry->cmd, entry->desc ? : "");

	for (entry = default_menu.entries; entry->cmd; entry++) {
		if (entry->exists && !entry->exists(data.menu))
			continue;

		printf("%s:%s\n", entry->cmd, entry->desc ? : "");
	}
}

static int parse_args(char *arg, wordexp_t *w, char *del, int flags)
{
	char *str;

	str = strdelimit(arg, del, '"');

	if (wordexp(str, w, flags)) {
		free(str);
		return -EINVAL;
	}

	/* If argument ends with ... set we_offs bypass strict checks */
	if (w->we_wordc && !strsuffix(w->we_wordv[w->we_wordc -1], "..."))
		w->we_offs = 1;

	free(str);

	return 0;
}

static int cmd_exec(const struct bt_shell_menu_entry *entry,
					int argc, char *argv[])
{
	wordexp_t w;
	size_t len;
	char *man, *opt;
	const char *man2, *opt2;
	int flags = WRDE_NOCMD;
	bool optargs = false;

	if (argc == 2 && (!memcmp(argv[1], "help", 4) ||
				!memcmp(argv[1], "--help", 6))) {
		printf("%s\n", entry->desc);
		printf(COLOR_HIGHLIGHT "Usage:" COLOR_OFF "\n");
		printf("\t %s %-*s\n", entry->cmd,
				(int)(CMD_LENGTH - strlen(entry->cmd)),
					!entry->arg ? "" : entry->arg);
		return 0;
	}

	if (!entry->arg || entry->arg[0] == '\0') {
		if (argc > 1) {
			print_text(COLOR_HIGHLIGHT, "Too many arguments");
			return -EINVAL;
		}
		goto exec;
	}

	/* Find last mandatory arguments */
	man2 = strrchr(entry->arg, '>');
	if (!man2) {
		opt = strdup(entry->arg);
		goto optional;
	}

	len = man2 - entry->arg;
	if (entry->arg[0] == '<')
		man = strndup(entry->arg, len + 1);
	else {
		/* Find where mandatory arguments start */
		opt2 = strrchr(entry->arg, '<');
		/* Skip if mandatory arguments are not in the right format */
		if (!opt2 || opt2 > man2) {
			opt = strdup(entry->arg);
			goto optional;
		}
		man = strndup(opt2, man2 - opt2 + 1);
		optargs = true;
	}

	if (parse_args(man, &w, "<>", flags) < 0) {
		print_text(COLOR_HIGHLIGHT,
			"Unable to parse mandatory command arguments: %s", man );
		free(man);
		return -EINVAL;
	}

	free(man);

	/* Check if there are enough arguments */
	if ((unsigned) argc - 1 < w.we_wordc) {
		print_text(COLOR_HIGHLIGHT, "Missing %s argument",
						w.we_wordv[argc - 1]);
		goto fail;
	}

	flags |= WRDE_APPEND;
	opt = strdup(entry->arg + len + 1);

optional:
	if (parse_args(opt, &w, "[]", flags) < 0) {
		print_text(COLOR_HIGHLIGHT,
			"Unable to parse optional command arguments: %s", opt);
		free(opt);
		return -EINVAL;
	}

	free(opt);

	/* Check if there are too many arguments */
	if (!optargs && ((unsigned int) argc - 1 > w.we_wordc && !w.we_offs)) {
		print_text(COLOR_HIGHLIGHT, "Too many arguments: %d > %zu",
					argc - 1, w.we_wordc);
		goto fail;
	}

	w.we_offs = 0;
	wordfree(&w);

exec:
	data.exec = entry;

	if (entry->func)
		entry->func(argc, argv);

	data.exec = NULL;

	return 0;

fail:
	w.we_offs = 0;
	wordfree(&w);
	return -EINVAL;
}

static int menu_exec(const struct bt_shell_menu *menu,
					int argc, char *argv[])
{
	const struct bt_shell_menu_entry *entry = menu->entries;

	for (; entry->cmd; entry++) {
		if (strcmp(argv[0], entry->cmd))
			continue;

		/* Skip menu command if not on main menu */
		if (data.menu != data.main && !strcmp(entry->cmd, "menu"))
			continue;

		/* Skip back command if on main menu */
		if (data.menu == data.main && !strcmp(entry->cmd, "back"))
			continue;

		if (data.mode == MODE_NON_INTERACTIVE && menu->pre_run)
			menu->pre_run(menu);

		return cmd_exec(entry, argc, argv);
	}

	return -ENOENT;
}

static int submenu_exec(int argc, char *argv[])
{
	char *name;
	int len, tlen;
	const struct bt_shell_menu *submenu;

	if (data.menu != data.main)
		return -ENOENT;

	name = strchr(argv[0], '.');
	if (!name)
		return -ENOENT;

	tlen = strlen(argv[0]);
	len = name - argv[0];
	name[0] = '\0';

	submenu = find_menu(argv[0], strlen(argv[0]), NULL);
	if (!submenu)
		return -ENOENT;

	/* Replace submenu.command with command */
	memmove(argv[0], argv[0] + len + 1, tlen - len - 1);
	memset(argv[0] + tlen - len - 1, 0, len + 1);

	return menu_exec(submenu, argc, argv);
}

static int shell_exec(int argc, char *argv[])
{
	int err;

	if (!data.menu || !argv[0])
		return -EINVAL;

	if (!argsisutf8(argc, argv))
		return -EINVAL;

	err  = menu_exec(&default_menu, argc, argv);
	if (err == -ENOENT) {
		err  = menu_exec(data.menu, argc, argv);
		if (err == -ENOENT) {
			err = submenu_exec(argc, argv);
			if (err == -ENOENT) {
				print_text(COLOR_HIGHLIGHT,
					"Invalid command in menu %s: %s",
					data.menu->name , argv[0]);
				shell_print_help();
			}
		}
	}

	return err;
}

void bt_shell_printf(const char *fmt, ...)
{
	va_list args;
	bool save_input;
	char *saved_line;
	int saved_point;

	if (queue_isempty(data.inputs))
		return;

	if (data.mode == MODE_NON_INTERACTIVE) {
		va_start(args, fmt);
		vprintf(fmt, args);
		va_end(args);
		return;
	}

	save_input = !RL_ISSTATE(RL_STATE_DONE);

	if (save_input) {
		saved_point = rl_point;
		saved_line = rl_copy_text(0, rl_end);
		if (!data.saved_prompt)
			rl_save_prompt();
		rl_clear_visible_line();
		rl_reset_line_state();
	}

	va_start(args, fmt);
	vprintf(fmt, args);
	va_end(args);

	if (data.monitor) {
		va_start(args, fmt);
		bt_log_vprintf(0xffff, data.name, LOG_INFO, fmt, args);
		va_end(args);
	}

	if (save_input) {
		if (!data.saved_prompt)
			rl_restore_prompt();
		rl_replace_line(saved_line, 0);
		rl_point = saved_point;
		rl_redisplay();
		free(saved_line);
	}
}

void bt_shell_echo(const char *fmt, ...)
{
	va_list args;
	char *str;
	int ret;

	va_start(args, fmt);
	ret = vasprintf(&str, fmt, args);
	va_end(args);

	if (ret < 0)
		return;

	rl_save_prompt();
	bt_shell_set_prompt(str, COLOR_HIGHLIGHT);
	rl_restore_prompt();
}

static void print_string(const char *str, void *user_data)
{
	bt_shell_printf("%s\n", str);
}

void bt_shell_hexdump(const unsigned char *buf, size_t len)
{
	util_hexdump(' ', buf, len, print_string, NULL);
}

void bt_shell_usage(void)
{
	if (!data.exec)
		return;

	bt_shell_printf("Usage: %s %s\n", data.exec->cmd,
					data.exec->arg ? data.exec->arg : "");
}

static void bt_shell_dequeue_exec(void)
{
	int err;

	if (!data.line)
		return;

	free(data.line);
	data.line = NULL;

	data.line = queue_pop_head(data.queue);
	if (!data.line)
		return;

	bt_shell_printf("%s\n", data.line);

	if (!bt_shell_release_prompt(data.line)) {
		/* If a prompt was released with this line,
		 * try to release all the other prompts,
		 * if any are left. Otherwise, the next
		 * line will be executed on
		 * bt_shell_noninteractive_quit.
		 */
		if (data.saved_prompt)
			bt_shell_dequeue_exec();

		return;
	}

	err = bt_shell_exec(data.line);
	if (err)
		bt_shell_dequeue_exec();
}

static void prompt_input(const char *str, bt_shell_prompt_input_func func,
							void *user_data)
{
	data.saved_prompt = true;
	data.saved_func = func;
	data.saved_user_data = user_data;

	rl_save_prompt();
	bt_shell_set_prompt(str, COLOR_HIGHLIGHT);
}

void bt_shell_prompt_input(const char *label, const char *msg,
			bt_shell_prompt_input_func func, void *user_data)
{
	char *str;

	if (!data.init || data.mode == MODE_NON_INTERACTIVE)
		return;

	if (data.saved_prompt) {
		struct bt_shell_prompt_input *prompt;

		prompt = new0(struct bt_shell_prompt_input, 1);

		if (asprintf(&str, COLOR_HIGHLIGHT "[%s] %s " COLOR_OFF, label,
								msg) < 0) {
			free(prompt);
			return;
		}

		prompt->func = func;
		prompt->user_data = user_data;

		queue_push_tail(data.prompts, prompt);
		free(str);

		return;
	}

	if (asprintf(&str, COLOR_HIGHLIGHT "[%s] %s " COLOR_OFF, label,
								msg) < 0)
		return;

	prompt_input(str, func, user_data);

	free(str);

	if (data.line && !queue_isempty(data.queue))
		/* If a prompt was set to receive input and
		 * data is already available, try to execute
		 * the line and release the prompt.
		 */
		bt_shell_dequeue_exec();
}

static void prompt_free(void *data)
{
	struct bt_shell_prompt_input *prompt = data;

	free(prompt->str);
	free(prompt);
}

int bt_shell_release_prompt(const char *input)
{
	struct bt_shell_prompt_input *prompt;
	bt_shell_prompt_input_func func;
	void *user_data;

	if (!data.saved_prompt)
		return -1;

	data.saved_prompt = false;

	rl_restore_prompt();

	func = data.saved_func;
	user_data = data.saved_user_data;

	prompt = queue_pop_head(data.prompts);
	if (prompt)
		data.saved_prompt = true;

	data.saved_func = NULL;
	data.saved_user_data = NULL;

	func(input, user_data);

	if (prompt) {
		prompt_input(prompt->str, prompt->func, prompt->user_data);
		prompt_free(prompt);
	}

	return 0;
}

static void rl_handler(char *input)
{
	if (!input) {
		rl_insert_text("quit");
		rl_redisplay();
		rl_crlf();
		mainloop_quit();
		return;
	}

	/* Ignore empty/comment lines */
	if (!strlen(input) || input[0] == '#')
		goto done;

	if (!bt_shell_release_prompt(input))
		goto done;

	bt_shell_exec(input);

done:
	free(input);
}

static char *find_cmd(const char *text,
			const struct bt_shell_menu_entry *entry, int *index)
{
	const struct bt_shell_menu_entry *tmp;
	int len;

	len = strlen(text);

	while ((tmp = &entry[*index])) {
		(*index)++;

		if (!tmp->cmd)
			break;

		if (tmp->exists && !tmp->exists(data.menu))
			continue;

		if (!strncmp(tmp->cmd, text, len))
			return strdup(tmp->cmd);
	}

	return NULL;
}

static char *cmd_generator(const char *text, int state)
{
	static int index;
	static bool default_menu_enabled, menu_enabled, submenu_enabled;
	static const struct bt_shell_menu *menu;
	char *cmd;
	const char *cmd2;

	if (!state) {
		index = 0;
		menu = NULL;
		default_menu_enabled = true;
		submenu_enabled = false;
	}

	if (default_menu_enabled) {
		cmd = find_cmd(text, default_menu.entries, &index);
		if (cmd) {
			return cmd;
		} else {
			index = 0;
			menu = data.menu;
			default_menu_enabled = false;

			if (data.main == data.menu)
				menu_enabled = true;
		}
	}

	if (menu_enabled) {
		menu = find_menu(text, strlen(text), &index);
		if (menu)
			return strdup(menu->name);

		index = 0;
		menu = data.menu;
		menu_enabled = false;
	}

	if (!submenu_enabled) {
		cmd = find_cmd(text, menu->entries, &index);
		if (cmd || menu != data.main)
			return cmd;

		cmd2 = strrchr(text, '.');
		if (!cmd2)
			return NULL;

		menu = find_menu(text, cmd2 - text, NULL);
		if (!menu)
			return NULL;

		index = 0;
		submenu_enabled = true;
	}

	cmd = find_cmd(text + strlen(menu->name) + 1, menu->entries, &index);
	if (cmd) {
		int err;
		char *tmp;

		err = asprintf(&tmp, "%s.%s", menu->name, cmd);

		free(cmd);

		if (err < 0)
			return NULL;

		cmd = tmp;
	}

	return cmd;
}

static wordexp_t args;

static char *arg_generator(const char *text, int state)
{
	static unsigned int index, len;
	const char *arg;

	if (!state) {
		index = 0;
		len = strlen(text);
	}

	while (index < args.we_wordc) {
		arg = args.we_wordv[index];
		index++;

		if (!strncmp(arg, text, len))
			return strdup(arg);
	}

	return NULL;
}

static char **args_completion(const struct bt_shell_menu_entry *entry, int argc,
							const char *text)
{
	char **matches = NULL;
	char *str;
	int index;

	index = text[0] == '\0' ? argc - 1 : argc - 2;
	if (index < 0)
		return NULL;

	if (!entry->arg)
		goto end;

	str = strdup(entry->arg);

	if (parse_args(str, &args, "<>[]", WRDE_NOCMD))
		goto done;

	/* Check if argument is valid */
	if ((unsigned) index > args.we_wordc - 1)
		goto done;

	/* Check if there are multiple values */
	if (!strrchr(entry->arg, '/'))
		goto done;

	free(str);

	/* Split values separated by / */
	str = strdelimit(args.we_wordv[index], "/", ' ');

	args.we_offs = 0;
	wordfree(&args);

	if (wordexp(str, &args, WRDE_NOCMD))
		goto done;

	rl_completion_display_matches_hook = NULL;
	matches = rl_completion_matches(text, arg_generator);

done:
	free(str);
end:
	if (!matches && text[0] == '\0')
		bt_shell_printf("Usage: %s %s\n", entry->cmd,
					entry->arg ? entry->arg : "");

	args.we_offs = 0;
	wordfree(&args);
	return matches;
}

static char **menu_completion(const struct bt_shell_menu_entry *entry,
				const char *text, int argc, char *input_cmd)
{
	char **matches = NULL;

	if (argc == 0)
		return NULL;

	for (; entry->cmd; entry++) {
		if (strcmp(entry->cmd, input_cmd))
			continue;

		if (!entry->gen) {
			matches = args_completion(entry, argc, text);
			break;
		}

		rl_completion_display_matches_hook = entry->disp;
		matches = rl_completion_matches(text, entry->gen);
		break;
	}

	return matches;
}

static char **submenu_completion(const char *text, int argc, char *input_cmd)
{
	const struct bt_shell_menu *menu;
	char *cmd;

	if (data.main != data.menu)
		return NULL;

	if (!input_cmd)
		return NULL;

	cmd = strrchr(input_cmd, '.');
	if (!cmd)
		return NULL;

	menu = find_menu(input_cmd, cmd - input_cmd, NULL);
	if (!menu)
		return NULL;

	return menu_completion(menu->entries, text, argc,
				input_cmd + strlen(menu->name) + 1);
}

static char **shell_completion(const char *text, int start, int end)
{
	char **matches = NULL;

	rl_attempted_completion_over = 1;

	if (!data.menu)
		return NULL;

	if (start > 0) {
		wordexp_t w;

		if (wordexp(rl_line_buffer, &w, WRDE_NOCMD))
			return NULL;

		matches = menu_completion(default_menu.entries, text,
						w.we_wordc, w.we_wordv[0]);
		if (!matches) {
			matches = menu_completion(data.menu->entries, text,
							w.we_wordc,
							w.we_wordv[0]);
			if (!matches)
				matches = submenu_completion(text, w.we_wordc,
								w.we_wordv[0]);
		}

		wordfree(&w);
	} else {
		rl_completion_display_matches_hook = NULL;
		matches = rl_completion_matches(text, cmd_generator);
	}

	return matches;
}

static void signal_callback(int signum, void *user_data)
{
	static bool terminated = false;

	switch (signum) {
	case SIGINT:
		if (!queue_isempty(data.inputs) &&
				data.mode == MODE_INTERACTIVE) {
			rl_replace_line("", 0);
			rl_crlf();
			rl_on_new_line();
			rl_redisplay();
			return;
		}

		/*
		 * If input was not yet setup up that means signal was received
		 * while daemon was not yet running. Since user is not able
		 * to terminate client by CTRL-D or typing exit treat this as
		 * exit and fall through.
		 */

		/* fall through */
	case SIGTERM:
		if (!terminated) {
			if (data.mode == MODE_INTERACTIVE) {
				rl_replace_line("", 0);
				rl_crlf();
			}
			mainloop_quit();
		}

		terminated = true;
		break;
	}
}

static void rl_init_history(void)
{
	const char *name;
	char *dir;

	memset(data.history, 0, sizeof(data.history));

	name = strrchr(data.name, '/');
	if (!name)
		name = data.name;
	else
		name++;

	dir = getenv("XDG_CACHE_HOME");
	if (dir) {
		snprintf(data.history, sizeof(data.history), "%s/.%s_history",
							dir, name);
		goto done;
	}

	dir = getenv("HOME");
	if (dir) {
		snprintf(data.history, sizeof(data.history),
				"%s/.cache/.%s_history", dir, name);
		goto done;
	}

	dir = getenv("PWD");
	if (dir) {
		snprintf(data.history, sizeof(data.history), "%s/.%s_history",
							dir, name);
		goto done;
	}

	return;

done:
	read_history(data.history);
	using_history();
	bt_shell_set_env("HISTORY", data.history);
}

static void rl_init(void)
{
	if (data.mode == MODE_NON_INTERACTIVE)
		return;

	/* Allow conditional parsing of the ~/.inputrc file. */
	rl_readline_name = data.name;

	rl_attempted_completion_function = shell_completion;

	rl_erase_empty_line = 1;
	rl_callback_handler_install(NULL, rl_handler);

	rl_init_history();
}

static const struct option main_options[] = {
	{ "version",	no_argument, 0, 'v' },
	{ "help",	no_argument, 0, 'h' },
	{ "init-script", required_argument, 0, 's' },
	{ "timeout",	required_argument, 0, 't' },
	{ "monitor",	no_argument, 0, 'm' },
	{ "zsh-complete",	no_argument, 0, 'z' },
};

static void usage(int argc, char **argv, const struct bt_shell_opt *opt)
{
	unsigned int i;

	printf("%s ver %s\n", data.name, VERSION);
	printf("Usage:\n"
		"\t%s [--options] [commands]\n", data.name);

	printf("Options:\n");

	for (i = 0; opt && opt->options[i].name; i++)
		printf("\t--%s \t%s\n", opt->options[i].name, opt->help[i]);

	printf("\t--monitor \tEnable monitor output\n"
		"\t--timeout \tTimeout in seconds for non-interactive mode\n"
		"\t--version \tDisplay version\n"
		"\t--init-script \tInit script file\n"
		"\t--help \t\tDisplay help\n");
}

void bt_shell_init(int argc, char **argv, const struct bt_shell_opt *opt)
{
	int c, index = -1;
	struct option options[256];
	char optstr[256];
	size_t offset;
	char *endptr = NULL;

	offset = sizeof(main_options) / sizeof(struct option);

	memcpy(options, main_options, sizeof(struct option) * offset);

	if (opt) {
		memcpy(options + offset, opt->options,
				sizeof(struct option) * opt->optno);
		snprintf(optstr, sizeof(optstr), "+mhvs:t:%s", opt->optstr);
	} else
		snprintf(optstr, sizeof(optstr), "+mhvs:t:");

	data.name = strrchr(argv[0], '/');
	if (!data.name)
		data.name = strdup(argv[0]);
	else
		data.name = strdup(++data.name);

	data.init_fd = -1;

	while ((c = getopt_long(argc, argv, optstr, options, &index)) != -1) {
		switch (c) {
		case 'v':
			printf("%s: %s\n", data.name, VERSION);
			exit(EXIT_SUCCESS);
			return;
		case 'h':
			usage(argc, argv, opt);
			data.argc = 1;
			data.argv = &cmplt;
			data.mode = MODE_NON_INTERACTIVE;
			goto done;
		case 's':
			if (optarg && data.init_fd < 0) {
				data.init_fd = open(optarg, O_RDONLY);
				if (data.init_fd < 0)
					printf("Unable to open %s: %s (%d)\n",
						optarg, strerror(errno), errno);
			}
			break;
		case 't':
			if (optarg)
				data.timeout = strtol(optarg, &endptr, 0);

			if (!endptr || *endptr != '\0')
				printf("Unable to parse timeout\n");
			break;
		case 'z':
			data.zsh = 1;
			break;
		case 'm':
			data.monitor = true;
			if (bt_log_open() < 0) {
				data.monitor = false;
				printf("Unable to open logging channel\n");
			}
			break;
		default:
			if (index < 0) {
				for (index = 0; options[index].val; index++) {
					if (c == options[index].val)
						break;
				}
			}

			if (opt && index >= 0 && (size_t)index >= offset) {
				if (c != opt->options[index - offset].val) {
					usage(argc, argv, opt);
					exit(EXIT_SUCCESS);
					return;
				}

				*opt->optarg[index - offset] = optarg ? : "";
			}
		}

		index = -1;
	}

	bt_shell_set_env("SHELL", data.name);

	data.argc = argc - optind;
	data.argv = argv + optind;
	optind = 0;
	data.mode = (data.argc > 0) ? MODE_NON_INTERACTIVE : MODE_INTERACTIVE;

done:
	if (data.mode == MODE_NON_INTERACTIVE)
		bt_shell_set_env("NON_INTERACTIVE", &data.mode);

	mainloop_init();

	/* Always set stdout as line buffered */
	setlinebuf(stdout);
	rl_init();

	data.init = true;
	data.inputs = queue_new();
	data.queue = queue_new();
	data.prompts = queue_new();
}

static void rl_cleanup(void)
{
	if (data.mode == MODE_NON_INTERACTIVE)
		return;

	if (data.history[0] != '\0')
		write_history(data.history);

	rl_message("%s", "");
	rl_callback_handler_remove();
}

static void env_destroy(void *data)
{
	struct bt_shell_env *env = data;

	free(env->name);
	free(env);
}

int bt_shell_run(void)
{
	int status;
	const struct queue_entry *submenu;

	/* Check if on non-interactive mode skip pre-run since that is on-demand
	 * by shell_exec() only for the menu in use.
	 */
	if (data.mode == MODE_NON_INTERACTIVE)
		goto done;

	if (data.menu && data.menu->pre_run)
		data.menu->pre_run(data.menu);

	for (submenu = queue_get_entries(data.submenus); submenu;
	     submenu = submenu->next) {
		struct bt_shell_menu *menu = submenu->data;

		if (menu->pre_run != NULL)
			menu->pre_run(menu);
	}

done:
	status = mainloop_run_with_signal(signal_callback, NULL);

	bt_shell_cleanup();

	return status;
}

int bt_shell_exec(const char *input)
{
	HIST_ENTRY *last;
	wordexp_t w;
	int err;

	if (!input)
		return 0;

	last = history_get(history_length + history_base - 1);
	/* append only if input is different from previous command */
	if (!last || strcmp(input, last->line))
		add_history(input);

	if (data.monitor)
		bt_log_printf(0xffff, data.name, LOG_INFO, "%s", input);

	err = wordexp(input, &w, WRDE_NOCMD);
	switch (err) {
	case WRDE_BADCHAR:
		return -EBADMSG;
	case WRDE_BADVAL:
	case WRDE_SYNTAX:
		return -EINVAL;
	case WRDE_NOSPACE:
		return -ENOMEM;
	case WRDE_CMDSUB:
		if (wordexp(input, &w, 0))
			return -ENOEXEC;
		break;
	};

	if (w.we_wordc == 0) {
		wordfree(&w);
		return -ENOEXEC;
	}

	err = shell_exec(w.we_wordc, w.we_wordv);

	wordfree(&w);

	return err;
}

static void input_destroy(void *data)
{
	struct input *input = data;

	if (input->f)
		fclose(input->f);

	io_destroy(input->io);
	free(input);
}

void bt_shell_cleanup(void)
{
	bt_shell_release_prompt("");
	bt_shell_detach();

	if (data.envs) {
		queue_destroy(data.envs, env_destroy);
		data.envs = NULL;
	}

	if (data.monitor)
		bt_log_close();

	rl_cleanup();

	queue_destroy(data.inputs, input_destroy);
	data.inputs = NULL;
	queue_destroy(data.queue, free);
	data.queue = NULL;
	queue_destroy(data.prompts, prompt_free);
	data.prompts = NULL;

	data.init = false;
	free(data.name);
}

void bt_shell_quit(int status)
{
	if (status == EXIT_SUCCESS)
		mainloop_exit_success();
	else
		mainloop_exit_failure();
}

void bt_shell_noninteractive_quit(int status)
{
	if (data.mode == MODE_INTERACTIVE || data.timeout) {
		bt_shell_dequeue_exec();
		return;
	}

	/* Ignore EINPROGRESS as it is meant for commands that need to stay
	 * running.
	 */
	if (status == -EINPROGRESS)
		return;

	bt_shell_quit(status);
}

bool bt_shell_set_menu(const struct bt_shell_menu *menu)
{
	if (!menu)
		return false;

	data.menu = menu;

	if (!data.main)
		data.main = menu;

	return true;
}

bool bt_shell_add_submenu(const struct bt_shell_menu *menu)
{
	if (!menu)
		return false;

	if (!data.main)
		return bt_shell_set_menu(menu);

	if (!data.submenus)
		data.submenus = queue_new();

	queue_push_tail(data.submenus, (void *) menu);

	return true;
}

void bt_shell_set_prompt(const char *string, const char *color)
{
	char *prompt;

	if (!data.init || data.mode == MODE_NON_INTERACTIVE)
		return;

	/* Envelope color within RL_PROMPT_START_IGNORE (\001) and
	 * RL_PROMPT_END_IGNORE (\002) so readline can properly calculate the
	 * prompt length.
	 */
	if (!color || asprintf(&prompt, "\001%s\002%s\001%s\002", color, string,
				COLOR_OFF) < 0) {
		rl_set_prompt(string);
	} else {
		rl_set_prompt(prompt);
		free(prompt);
	}

	rl_redisplay();
}

static bool shell_quit(void *data)
{
	mainloop_quit();

	return false;
}

bool bt_shell_attach(int fd)
{
	struct input *input;

	input = input_new(fd);
	if (!input)
		return false;

	if (data.mode == MODE_INTERACTIVE) {
		io_set_read_handler(input->io, input_read, input, NULL);
		io_set_disconnect_handler(input->io, input_hup, input, NULL);

		if (data.init_fd >= 0) {
			int fd = data.init_fd;

			data.init_fd = -1;
			if (!bt_shell_attach(fd))
				return false;
		}
	} else {
		if (shell_exec(data.argc, data.argv) < 0) {
			bt_shell_noninteractive_quit(EXIT_FAILURE);
			return true;
		}

		if (data.timeout)
			timeout_add(data.timeout * 1000, shell_quit, NULL,
								NULL);
	}

	return true;
}

bool bt_shell_detach(void)
{
	if (queue_isempty(data.inputs))
		return false;

	queue_remove_all(data.inputs, NULL, NULL, input_destroy);

	return true;
}

static bool match_env(const void *data, const void *user_data)
{
	const struct bt_shell_env *env = data;
	const char *name = user_data;

	return !strcmp(env->name, name);
}

void bt_shell_set_env(const char *name, void *value)
{
	struct bt_shell_env *env;

	if (!data.envs) {
		if (!value)
			return;
		data.envs = queue_new();
		goto done;
	}

	env = queue_remove_if(data.envs, match_env, (void *) name);
	if (env)
		env_destroy(env);

	/* Don't create an env if value is not set */
	if (!value)
		return;

done:
	env = new0(struct bt_shell_env, 1);
	env->name = strdup(name);
	env->value = value;

	queue_push_tail(data.envs, env);
}

void *bt_shell_get_env(const char *name)
{
	const struct bt_shell_env *env;

	if (!data.envs)
		return NULL;

	env = queue_find(data.envs, match_env, name);
	if (!env)
		return NULL;

	return env->value;
}

int bt_shell_get_timeout(void)
{
	return data.timeout;
}

void bt_shell_handle_non_interactive_help(void)
{
	if (!data.mode)
		return;
	if (data.argv[0] != cmplt)
		return;
	print_cmds();
	exit(EXIT_SUCCESS);
}