Standard Command Line Interface. More...

#include "asterisk/linkedlists.h"
#include "asterisk/strings.h"

Include dependency graph for cli.h:

Data Structures
struct	ast_cli_args

struct	ast_cli_entry
	descriptor for a cli entry. More...

Macros
#define	ast_cli_command(fd, s) ast_cli_command_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, s)

#define	ast_cli_command_multiple(fd, size, s) ast_cli_command_multiple_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, size, s)

#define	AST_CLI_COMPLETE_EOF "_EOF_"

#define	AST_CLI_DEFINE(fn, txt, ...) { .handler = fn, .summary = txt, ## __VA_ARGS__ }

#define	AST_CLI_ONOFF(x) (x) ? "On" : "Off"
	return On or Off depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point). More...

#define	ast_cli_register(e) __ast_cli_register(e, AST_MODULE_SELF)
	Registers a command or an array of commands. More...

#define	ast_cli_register_multiple(e, len) __ast_cli_register_multiple(e, len, AST_MODULE_SELF)
	Register multiple commands. More...

#define	AST_CLI_YESNO(x) AST_YESNO(x)
	Return Yes or No depending on the argument. More...

#define	AST_MAX_ARGS 64

#define	AST_MAX_CMD_LEN 16

#define	CLI_FAILURE (char *)RESULT_FAILURE

#define	CLI_NO_PERMS -1

#define	CLI_SHOWUSAGE (char *)RESULT_SHOWUSAGE

#define	CLI_SUCCESS (char *)RESULT_SUCCESS

#define	ESS(x) ((x) == 1 ? "" : "s")

#define	RESULT_FAILURE 2

#define	RESULT_SHOWUSAGE 1

#define	RESULT_SUCCESS 0

Enumerations
enum	ast_cli_command { CLI_INIT = -2 , CLI_GENERATE = -3 , CLI_HANDLER = -4 }
	calling arguments for new-style handlers. More...

Functions
int	__ast_cli_register (struct ast_cli_entry e, struct ast_module mod)

int	__ast_cli_register_multiple (struct ast_cli_entry e, int len, struct ast_module mod)

void	ast_cli (int fd, const char *fmt,...)

int	ast_cli_allow_at_shutdown (struct ast_cli_entry *e)
	Allow a CLI command to be executed while Asterisk is shutting down. More...

int	ast_cli_command_full (int uid, int gid, int fd, const char *s)
	Interprets a command Interpret a command s, sending output to fd if uid:gid has permissions to run this command. uid = CLI_NO_PERMS to avoid checking user permissions gid = CLI_NO_PERMS to avoid checking group permissions. More...

int	ast_cli_command_multiple_full (int uid, int gid, int fd, size_t size, const char *s)
	Executes multiple CLI commands Interpret strings separated by NULL and execute each one, sending output to fd if uid has permissions, uid = CLI_NO_PERMS to avoid checking users permissions. gid = CLI_NO_PERMS to avoid checking group permissions. More...

char *	ast_cli_complete (const char word, const char const choices[], int pos)

int	ast_cli_completion_add (char *value)
	Add a result to a request for completion options. More...

char **	ast_cli_completion_matches (const char , const char )
	Generates a NULL-terminated array of strings that 1) begin with the string in the second parameter, and 2) are valid in a command after the string in the first parameter. More...

struct ast_vector_string *	ast_cli_completion_vector (const char text, const char word)
	Generates a vector of strings for CLI completion. More...

char *	ast_cli_generator (const char , const char , int)
	Readline madness Useful for readline, that's about it. More...

void	ast_cli_print_timestr_fromseconds (int fd, int seconds, const char *prefix)
	Print on cli a duration in seconds in format s year(s), s week(s), s day(s), s hour(s), s second(s) More...

int	ast_cli_unregister (struct ast_cli_entry *e)
	Unregisters a command or an array of commands. More...

int	ast_cli_unregister_multiple (struct ast_cli_entry *e, int len)
	Unregister multiple commands. More...

char *	ast_complete_channels (const char line, const char word, int pos, int state, int rpos)
	Command completion for the list of active channels. More...

Detailed Description

Standard Command Line Interface.

Definition in file cli.h.

Macro Definition Documentation

◆ ast_cli_command

#define ast_cli_command	(	fd,
		s
	)	ast_cli_command_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, s)

Definition at line 232 of file cli.h.

◆ ast_cli_command_multiple

#define ast_cli_command_multiple	(	fd,
		size,
		s
	)	ast_cli_command_multiple_full(CLI_NO_PERMS, CLI_NO_PERMS, fd, size, s)

Definition at line 248 of file cli.h.

◆ AST_CLI_COMPLETE_EOF

#define AST_CLI_COMPLETE_EOF "_EOF_"

Definition at line 52 of file cli.h.

◆ AST_CLI_DEFINE

#define AST_CLI_DEFINE	(	fn,
		txt,
		...
	)	{ .handler = fn, .summary = txt, ## __VA_ARGS__ }

Examples: app_skel.c.

Definition at line 197 of file cli.h.

◆ AST_CLI_ONOFF

#define AST_CLI_ONOFF ( x ) (x) ? "On" : "Off"

return On or Off depending on the argument. This is used in many places in CLI command, having a function to generate this helps maintaining a consistent output (and possibly emitting the output in other languages, at some point).

Definition at line 78 of file cli.h.

◆ ast_cli_register

#define ast_cli_register ( e ) __ast_cli_register(e, AST_MODULE_SELF)

Registers a command or an array of commands.

Parameters

e	which cli entry to register. Register your own command

Return values

0	on success
-1	on failure

Definition at line 256 of file cli.h.

◆ ast_cli_register_multiple

#define ast_cli_register_multiple	(	e,
		len
	)	__ast_cli_register_multiple(e, len, AST_MODULE_SELF)

Register multiple commands.

Parameters

e	pointer to first cli entry to register
len	number of entries to register

Examples: app_skel.c.

Definition at line 265 of file cli.h.

◆ AST_CLI_YESNO

#define AST_CLI_YESNO ( x ) AST_YESNO(x)

Return Yes or No depending on the argument.

Note that this should probably still be used for CLI commands instead of AST_YESNO(), in the off chance we someday want to translate the CLI.

Parameters

x	Boolean value

Returns: "Yes" if x is true (non-zero); "No" if x is false (zero)

Examples: app_skel.c.

Definition at line 71 of file cli.h.

◆ AST_MAX_ARGS

#define AST_MAX_ARGS 64

Definition at line 50 of file cli.h.

◆ AST_MAX_CMD_LEN

#define AST_MAX_CMD_LEN 16

Definition at line 48 of file cli.h.

◆ CLI_FAILURE

#define CLI_FAILURE (char *)RESULT_FAILURE

Definition at line 46 of file cli.h.

◆ CLI_NO_PERMS

#define CLI_NO_PERMS -1

Definition at line 38 of file cli.h.

◆ CLI_SHOWUSAGE

#define CLI_SHOWUSAGE (char *)RESULT_SHOWUSAGE

Definition at line 45 of file cli.h.

◆ CLI_SUCCESS

#define CLI_SUCCESS (char *)RESULT_SUCCESS

Examples: app_skel.c.

Definition at line 44 of file cli.h.

◆ ESS

#define ESS ( x ) ((x) == 1 ? "" : "s")

In many cases we need to print singular or plural words depending on a count. This macro helps us e.g. printf("we have %d object%s", n, ESS(n));

Definition at line 59 of file cli.h.

◆ RESULT_FAILURE

#define RESULT_FAILURE 2

Definition at line 42 of file cli.h.

◆ RESULT_SHOWUSAGE

#define RESULT_SHOWUSAGE 1

Definition at line 41 of file cli.h.

◆ RESULT_SUCCESS

#define RESULT_SUCCESS 0

Definition at line 40 of file cli.h.

Enumeration Type Documentation

◆ ast_cli_command

enum ast_cli_command

calling arguments for new-style handlers.

CLI command API

Enumerator
CLI_INIT
CLI_GENERATE
CLI_HANDLER

Definition at line 151 of file cli.h.

                     {
    CLI_INIT = -2,      /* return the usage string */
    CLI_GENERATE = -3,  /* behave as 'generator', remap argv to struct ast_cli_args */
    CLI_HANDLER = -4,   /* run the normal handler */
};

Function Documentation

◆ __ast_cli_register()

int __ast_cli_register	(	struct ast_cli_entry *	e,
		struct ast_module *	mod
	)

Definition at line 2431 of file main/cli.c.

{
    struct ast_cli_entry *cur;
    int i, lf, ret = -1;
 
    struct ast_cli_args a;  /* fake argument */
    char **dst = (char **)e->cmda;  /* need to cast as the entry is readonly */
    char *s;
 
    AST_RWLIST_WRLOCK(&helpers);
 
    if (cli_is_registered(e)) {
        ast_log(LOG_WARNING, "Command '%s' already registered (the same ast_cli_entry)\n",
            S_OR(e->_full_cmd, e->command));
        ret = 0;  /* report success */
        goto done;
    }
 
    memset(&a, '\0', sizeof(a));
 
    e->module = module;
    /* No module reference needed here, the module called us. */
    e->handler(e, CLI_INIT, &a);
 
    /* XXX check that usage and command are filled up */
    s = ast_skip_blanks(e->command);
    s = e->command = ast_strdup(s);
    for (i=0; !ast_strlen_zero(s) && i < AST_MAX_CMD_LEN-1; i++) {
        *dst++ = s; /* store string */
        s = ast_skip_nonblanks(s);
        if (*s == '\0') /* we are done */
            break;
        *s++ = '\0';
        s = ast_skip_blanks(s);
    }
    *dst++ = NULL;
 
    if (find_cli(e->cmda, 1)) {
        ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n",
            S_OR(e->_full_cmd, e->command));
        goto done;
    }
    if (set_full_cmd(e)) {
        ast_log(LOG_WARNING, "Error registering CLI Command '%s'\n",
            S_OR(e->_full_cmd, e->command));
        goto done;
    }
 
    lf = e->cmdlen;
    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&helpers, cur, list) {
        int len = cur->cmdlen;
        if (lf < len)
            len = lf;
        if (strncasecmp(e->_full_cmd, cur->_full_cmd, len) < 0) {
            AST_RWLIST_INSERT_BEFORE_CURRENT(e, list);
            break;
        }
    }
    AST_RWLIST_TRAVERSE_SAFE_END;
 
    if (!cur)
        AST_RWLIST_INSERT_TAIL(&helpers, e, list);
    ret = 0;    /* success */
 
done:
    AST_RWLIST_UNLOCK(&helpers);
    if (ret) {
        ast_free(e->command);
        e->command = NULL;
    }
 
    return ret;
}

References ast_cli_entry::_full_cmd, a, ast_free, ast_log, AST_MAX_CMD_LEN, AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_skip_blanks(), ast_skip_nonblanks(), ast_strdup, ast_strlen_zero(), CLI_INIT, cli_is_registered(), ast_cli_entry::cmda, ast_cli_entry::cmdlen, ast_cli_entry::command, done, find_cli(), ast_cli_entry::handler, len(), LOG_WARNING, ast_cli_entry::module, NULL, S_OR, and set_full_cmd().

Referenced by __ast_cli_register_multiple().

◆ __ast_cli_register_multiple()

int __ast_cli_register_multiple	(	struct ast_cli_entry *	e,
		int	len,
		struct ast_module *	mod
	)

Definition at line 2508 of file main/cli.c.

{
    int i, res = 0;
 
    for (i = 0; i < len; i++) {
        res |= __ast_cli_register(e + i, module);
    }
 
    return res;
}

References __ast_cli_register(), and len().

◆ ast_cli()

void ast_cli	(	int	fd,
		const char *	fmt,
			...
	)

Examples: app_skel.c.

Definition at line 6 of file clicompat.c.

7{

8}

References ast_carefulwrite(), ast_cli_buf, AST_CLI_INITLEN, AST_DYNSTR_BUILD_FAILED, ast_str_buffer(), ast_str_set_va(), ast_str_strlen(), ast_str_thread_get(), and buf.

◆ ast_cli_allow_at_shutdown()

int ast_cli_allow_at_shutdown ( struct ast_cli_entry * e )

Allow a CLI command to be executed while Asterisk is shutting down.

CLI commands by defeault are disabled when Asterisk is shutting down. This is to ensure the safety of the shutdown since CLI commands may attempt to access resources that have been freed as a result of the shutdown.

If a CLI command should be allowed at shutdown, then the best way to enable this is to call ast_cli_allow_at_shutdown during the CLI_INIT state of the CLI handler.

Definition at line 3037 of file main/cli.c.

{
    int res;
 
    ast_rwlock_wrlock(&shutdown_commands_lock);
    res = AST_VECTOR_APPEND(&shutdown_commands, e);
    ast_rwlock_unlock(&shutdown_commands_lock);
 
    return res;
}

References ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_APPEND, shutdown_commands, and shutdown_commands_lock.

Referenced by handle_abort_shutdown(), handle_restart_gracefully(), handle_restart_now(), handle_restart_when_convenient(), handle_stop_gracefully(), handle_stop_now(), and handle_stop_when_convenient().

◆ ast_cli_command_full()

int ast_cli_command_full	(	int	uid,
		int	gid,
		int	fd,
		const char *	s
	)

Interprets a command Interpret a command s, sending output to fd if uid:gid has permissions to run this command. uid = CLI_NO_PERMS to avoid checking user permissions gid = CLI_NO_PERMS to avoid checking group permissions.

Parameters

uid	User ID that is trying to run the command.
gid	Group ID that is trying to run the command.
fd	pipe
s	incoming string

Return values

0	on success
-1	on failure

Definition at line 2950 of file main/cli.c.

{
    const char *args[AST_MAX_ARGS + 1];
    struct ast_cli_entry *e = NULL;
    int x;
    char *duplicate = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL);
    char tmp[AST_MAX_ARGS + 1];
    char *retval = CLI_FAILURE;
    struct ast_cli_args a = {
        .fd = fd, .argc = x, .argv = args+1 };
 
    if (duplicate == NULL)
        return RESULT_FAILURE;
 
    if (x < 1)  /* We need at least one entry, otherwise ignore */
        goto done;
 
    AST_RWLIST_RDLOCK(&helpers);
    e = find_cli(args + 1, 0);
    if (e)
        ast_atomic_fetchadd_int(&e->inuse, 1);
    AST_RWLIST_UNLOCK(&helpers);
    if (e == NULL) {
        ast_cli(fd, "No such command '%s' (type 'core show help %s' for other possible commands)\n", s, find_best(args + 1));
        goto done;
    }
 
    if (ast_shutting_down() && !allowed_on_shutdown(e)) {
        ast_cli(fd, "Command '%s' cannot be run during shutdown\n", s);
        goto done;
    }
 
    ast_join(tmp, sizeof(tmp), args + 1);
    /* Check if the user has rights to run this command. */
    if (!cli_has_permissions(uid, gid, tmp)) {
        ast_cli(fd, "You don't have permissions to run '%s' command\n", tmp);
        goto done;
    }
 
    /*
     * Within the handler, argv[-1] contains a pointer to the ast_cli_entry.
     * Remember that the array returned by parse_args is NULL-terminated.
     */
    args[0] = (char *)e;
 
    /* If the command is in a module it must be running. */
    if (!e->module || ast_module_running_ref(e->module)) {
        retval = e->handler(e, CLI_HANDLER, &a);
        ast_module_unref(e->module);
    }
 
    if (retval == CLI_SHOWUSAGE) {
        ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n"));
    } else if (retval == CLI_FAILURE) {
        ast_cli(fd, "Command '%s' failed.\n", s);
    }
 
done:
    if (e) {
        ast_atomic_fetchadd_int(&e->inuse, -1);
    }
    ast_free(duplicate);
    return retval == CLI_SUCCESS ? RESULT_SUCCESS : RESULT_FAILURE;
}

References a, allowed_on_shutdown(), args, ast_atomic_fetchadd_int(), ast_cli(), ast_free, ast_join, AST_MAX_ARGS, ast_module_running_ref, ast_module_unref, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_shutting_down(), CLI_FAILURE, CLI_HANDLER, cli_has_permissions(), CLI_SHOWUSAGE, CLI_SUCCESS, done, ast_cli_args::fd, find_best(), find_cli(), ast_cli_entry::handler, ast_cli_entry::inuse, ast_cli_entry::module, NULL, parse_args(), RESULT_FAILURE, RESULT_SUCCESS, S_OR, and ast_cli_entry::usage.

Referenced by ast_cli_command_multiple_full().

◆ ast_cli_command_multiple_full()

int ast_cli_command_multiple_full	(	int	uid,
		int	gid,
		int	fd,
		size_t	size,
		const char *	s
	)

Executes multiple CLI commands Interpret strings separated by NULL and execute each one, sending output to fd if uid has permissions, uid = CLI_NO_PERMS to avoid checking users permissions. gid = CLI_NO_PERMS to avoid checking group permissions.

Parameters

uid	User ID that is trying to run the command.
gid	Group ID that is trying to run the command.
fd	pipe
size	is the total size of the string
s	incoming string

Returns: number of commands executed

Definition at line 3015 of file main/cli.c.

{
    char cmd[512];
    int x, y = 0, count = 0;
 
    for (x = 0; x < size; x++) {
        cmd[y] = s[x];
        y++;
        if (s[x] == '\0') {
            ast_cli_command_full(uid, gid, fd, cmd);
            y = 0;
            count++;
        }
    }
    return count;
}

References ast_cli_command_full(), and ast_cli_args::fd.

Referenced by netconsole().

◆ ast_cli_complete()

char * ast_cli_complete	(	const char *	word,
		const char *const	choices[],
		int	pos
	)

Helper function to generate cli entries from a NULL-terminated array. Returns the n-th matching entry from the array, or NULL if not found. Can be used to implement generate() for static entries as below (in this example we complete the word in position 2):

char *my_generate(const char *line, const char *word, int pos, int n)
{
    static const char * const choices[] = { "one", "two", "three", NULL };
if (pos == 2)
      return ast_cli_complete(word, choices, n);
else
  return NULL;
}

Definition at line 1823 of file main/cli.c.

{
    int i, which = 0, len;
    len = ast_strlen_zero(word) ? 0 : strlen(word);
 
    for (i = 0; choices[i]; i++) {
        if ((!len || !strncasecmp(word, choices[i], len)) && ++which > state) {
            if (state != -1) {
                return ast_strdup(choices[i]);
            }
 
            if (ast_cli_completion_add(ast_strdup(choices[i]))) {
                return NULL;
            }
        }
    }
    return NULL;
}

References ast_cli_completion_add(), ast_strdup, ast_strlen_zero(), len(), and NULL.

Referenced by cli_odbc_read(), cli_odbc_write(), handle_bridge_kick_channel(), handle_cli_core_show_translation(), handle_cli_devstate_change(), handle_cli_iax2_prune_realtime(), handle_cli_presencestate_change(), handle_core_set_debug_channel(), handle_orig(), handle_refresh(), handle_showcalls(), handle_softhangup(), pjsip_set_logger(), and sorcery_memory_cache_stale().

◆ ast_cli_completion_add()

int ast_cli_completion_add ( char * value )

Add a result to a request for completion options.

Parameters

value A completion option text.

Return values

0	Success
-1	Failure

This is an alternative to returning individual values from CLI_GENERATE. Instead of repeatedly being asked for the next match and having to start over, you can call this function repeatedly from your own stateful loop. When all matches have been added you can return NULL from the CLI_GENERATE function.

Note: This function always eventually results in calling ast_free on value.

Definition at line 2737 of file main/cli.c.

{
    return cli_completion_vector_add(ast_threadstorage_get_ptr(&completion_storage), value);
}

References ast_threadstorage_get_ptr(), cli_completion_vector_add(), and value.

Referenced by aeap_tab_complete_name(), ari_set_debug(), ast_cli_complete(), ast_complete_applications(), ast_complete_channels(), category_complete(), cli_complete_endpoint(), cli_complete_show(), cli_complete_uri(), complete_app(), complete_bridge_live_search(), complete_bridge_participant(), complete_bridge_technology(), complete_channeltypes(), complete_config_module(), complete_config_option(), complete_config_type(), complete_core_id(), complete_country(), complete_indications(), complete_session(), complete_show_sorcery_object(), complete_sorcery_object(), complete_trans_path_choice(), config_object_tab_complete_name(), handle_cli_config_reload(), handle_cli_sound_show(), handle_debug_category(), handle_manager_show_event(), handle_show_named_acl_cmd(), handle_showmanager(), handle_showmancmd(), module_load_helper_on_file(), topic_complete_name(), and tps_taskprocessor_tab_complete().

◆ ast_cli_completion_matches()

char ** ast_cli_completion_matches	(	const char *	text,
		const char *	word
	)

Generates a NULL-terminated array of strings that 1) begin with the string in the second parameter, and 2) are valid in a command after the string in the first parameter.

The first entry (offset 0) of the result is the longest common substring in the results, useful to extend the string that has been completed. Subsequent entries are all possible values, followed by a NULL. All strings and the array itself are malloc'ed and must be freed by the caller.

Warning: This function cannot be called recursively so it will always fail if called from a CLI_GENERATE callback.

Definition at line 2681 of file main/cli.c.

{
    struct ast_vector_string *vec = ast_cli_completion_vector(text, word);
    char **match_list;
 
    if (!vec) {
        return NULL;
    }
 
    if (AST_VECTOR_APPEND(vec, NULL)) {
        /* We failed to NULL terminate the elements */
        AST_VECTOR_CALLBACK_VOID(vec, ast_free);
        AST_VECTOR_PTR_FREE(vec);
 
        return NULL;
    }
 
    match_list = AST_VECTOR_STEAL_ELEMENTS(vec);
    AST_VECTOR_PTR_FREE(vec);
 
    return match_list;
}

References ast_cli_completion_vector(), ast_free, AST_VECTOR_APPEND, AST_VECTOR_CALLBACK_VOID, AST_VECTOR_PTR_FREE, AST_VECTOR_STEAL_ELEMENTS, NULL, and text.

Referenced by handle_commandmatchesarray().

◆ ast_cli_completion_vector()

struct ast_vector_string * ast_cli_completion_vector	(	const char *	text,
		const char *	word
	)

Generates a vector of strings for CLI completion.

Parameters

text	Complete input being matched.
word	Current word being matched

The results contain strings that both: 1) Begin with the string in word. 2) Are valid in a command after the string in text.

The first entry (offset 0) of the result is the longest common substring in the results, useful to extend the string that has been completed. Subsequent entries are all possible values.

Note: All strings and the vector itself are malloc'ed and must be freed by the caller.; The vector is sorted and does not contain any duplicates.

Warning: This function cannot be called recursively so it will always fail if called from a CLI_GENERATE callback.

Definition at line 2742 of file main/cli.c.

{
    char *retstr, *prevstr;
    size_t max_equal;
    size_t which = 0;
    struct ast_vector_string *vec = ast_calloc(1, sizeof(*vec));
 
    /* Recursion into this function is a coding error. */
    ast_assert(!ast_threadstorage_get_ptr(&completion_storage));
 
    if (!vec) {
        return NULL;
    }
 
    if (ast_threadstorage_set_ptr(&completion_storage, vec)) {
        ast_log(LOG_ERROR, "Failed to initialize threadstorage for completion.\n");
        ast_free(vec);
 
        return NULL;
    }
 
    while ((retstr = ast_cli_generator(text, word, which)) != NULL) {
        if (cli_completion_vector_add(vec, retstr)) {
            ast_threadstorage_set_ptr(&completion_storage, NULL);
 
            goto vector_cleanup;
        }
 
        ++which;
    }
 
    ast_threadstorage_set_ptr(&completion_storage, NULL);
 
    if (!AST_VECTOR_SIZE(vec)) {
        AST_VECTOR_PTR_FREE(vec);
 
        return NULL;
    }
 
    prevstr = AST_VECTOR_GET(vec, 0);
    max_equal = strlen(prevstr);
    which = 1;
 
    /* Find the longest substring that is common to all results
     * (it is a candidate for completion), and store a copy in entry 0.
     */
    while (which < AST_VECTOR_SIZE(vec)) {
        size_t i = 0;
 
        retstr = AST_VECTOR_GET(vec, which);
        /* Check for and remove duplicate strings. */
        if (!strcasecmp(prevstr, retstr)) {
            AST_VECTOR_REMOVE(vec, which, 1);
            ast_free(retstr);
 
            continue;
        }
 
        while (i < max_equal && toupper(prevstr[i]) == toupper(retstr[i])) {
            i++;
        }
 
        max_equal = i;
        prevstr = retstr;
        ++which;
    }
 
    /* Insert longest match to position 0. */
    retstr = ast_strndup(AST_VECTOR_GET(vec, 0), max_equal);
    if (!retstr || AST_VECTOR_INSERT_AT(vec, 0, retstr)) {
        ast_free(retstr);
 
        goto vector_cleanup;
    }
 
    return vec;
 
vector_cleanup:
    AST_VECTOR_CALLBACK_VOID(vec, ast_free);
    AST_VECTOR_PTR_FREE(vec);
 
    return NULL;
}

References ast_assert, ast_calloc, ast_cli_generator(), ast_free, ast_log, ast_strndup, ast_threadstorage_get_ptr(), ast_threadstorage_set_ptr(), AST_VECTOR_CALLBACK_VOID, AST_VECTOR_GET, AST_VECTOR_INSERT_AT, AST_VECTOR_PTR_FREE, AST_VECTOR_REMOVE, AST_VECTOR_SIZE, cli_completion_vector_add(), LOG_ERROR, NULL, and text.

Referenced by ast_cli_completion_matches(), AST_TEST_DEFINE(), and cli_complete().

◆ ast_cli_generator()

char * ast_cli_generator	(	const char *	text,
		const char *	word,
		int	state
	)

Readline madness Useful for readline, that's about it.

Return values

0	on success
-1	on failure

Only call this function to proxy the CLI generator to another.

Definition at line 2928 of file main/cli.c.

{
    return __ast_cli_generator(text, word, state, 1);
}

References __ast_cli_generator(), and text.

Referenced by ast_cli_completion_vector(), cli_alias_passthrough(), and handle_cli_check_permissions().

◆ ast_cli_print_timestr_fromseconds()

void ast_cli_print_timestr_fromseconds	(	int	fd,
		int	seconds,
		const char *	prefix
	)

Print on cli a duration in seconds in format s year(s), s week(s), s day(s), s hour(s), s second(s)

Since: 13.8

Parameters

fd	fd to print by ast_cli
seconds	The time (in seconds) to print
prefix	A Prefix string to add before of duration formatted

Definition at line 3032 of file main/cli.c.

{
    print_uptimestr(fd, ast_tv(seconds, 0), prefix, 0);
}

References ast_tv(), ast_cli_args::fd, prefix, and print_uptimestr().

Referenced by handle_cdr_pgsql_status(), handle_cli_realtime_pgsql_status(), and realtime_ldap_status().

◆ ast_cli_unregister()

int ast_cli_unregister ( struct ast_cli_entry * e )

Unregisters a command or an array of commands.

Parameters

e	which cli entry to unregister Unregister your own command. You must pass a completed ast_cli_entry structure

Returns: 0

Definition at line 2408 of file main/cli.c.

{
    if (e->inuse) {
        ast_log(LOG_WARNING, "Can't remove command that is in use\n");
    } else {
        AST_RWLIST_WRLOCK(&helpers);
        AST_RWLIST_REMOVE(&helpers, e, list);
        AST_RWLIST_UNLOCK(&helpers);
        remove_shutdown_command(e);
        ast_free(e->_full_cmd);
        e->_full_cmd = NULL;
        if (e->handler) {
            /* this is a new-style entry. Reset fields and free memory. */
            char *cmda = (char *) e->cmda;
            memset(cmda, '\0', sizeof(e->cmda));
            ast_free(e->command);
            e->command = NULL;
            e->usage = NULL;
        }
    }
    return 0;
}

References ast_cli_entry::_full_cmd, ast_free, ast_log, AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_cli_entry::cmda, ast_cli_entry::command, ast_cli_entry::handler, ast_cli_entry::inuse, ast_cli_entry::list, LOG_WARNING, NULL, remove_shutdown_command(), and ast_cli_entry::usage.

Referenced by aco_deinit(), alias_unregister_cb(), ast_cli_unregister_multiple(), unload_module(), and xmldoc_unload_documentation().

◆ ast_cli_unregister_multiple()

int ast_cli_unregister_multiple	(	struct ast_cli_entry *	e,
		int	len
	)

Unregister multiple commands.

Parameters

e	pointer to first cli entry to unregister
len	number of entries to unregister

Examples: app_skel.c.

Definition at line 30 of file clicompat.c.

{
    return 0;
}

References ast_cli_unregister(), and len().

Referenced by __unload_module(), aoc_shutdown(), ari_cli_unregister(), as_config_unload(), ast_res_pjsip_cleanup_options_handling(), ast_res_pjsip_destroy_configuration(), ast_sip_destroy_cli(), ast_sip_destroy_distributor(), ast_sip_destroy_scheduler(), ast_sip_destroy_sorcery_auth(), ast_sip_destroy_sorcery_location(), ast_sip_destroy_sorcery_transport(), ast_sip_destroy_transport_events(), astdb_atexit(), astobj2_cleanup(), bridge_cleanup(), cdr_engine_shutdown(), channels_shutdown(), cli_channels_shutdown(), cli_shutdown(), cli_unload_cb(), close_logger(), codec_shutdown(), common_config_unload(), conf_destroy_config(), config_shutdown(), file_shutdown(), geoloc_config_unload(), geoloc_gml_unload(), iax_provision_unload(), image_shutdown(), load_module(), local_shutdown(), main_atexit(), manager_shutdown(), media_cache_shutdown(), pjsip_channel_cli_unregister(), profile_unload(), sorcery_cleanup(), stasis_cleanup(), stun_shutdown(), timing_shutdown(), tn_config_unload(), tps_shutdown(), translate_shutdown(), unload_features_config(), unload_module(), unload_parking_ui(), unload_pbx(), unload_pbx_app(), unload_pbx_functions_cli(), unload_pbx_hangup_handler(), unload_pbx_switch(), unload_pbx_variables(), utils_shutdown(), and vs_config_unload().

◆ ast_complete_channels()

char * ast_complete_channels	(	const char *	line,
		const char *	word,
		int	pos,
		int	state,
		int	rpos
	)

Command completion for the list of active channels.

This can be called from a CLI command completion function that wants to complete from the list of active channels. 'rpos' is the required position in the command. This function will return NULL immediately if 'rpos' is not the same as the current position, 'pos'.

Definition at line 1842 of file main/cli.c.

{
    int wordlen = strlen(word), which = 0;
    struct ao2_container *cached_channels;
    char *ret = NULL;
    struct ao2_iterator iter;
    struct ast_channel_snapshot *snapshot;
 
    if (pos != rpos) {
        return NULL;
    }
 
    cached_channels = ast_channel_cache_all();
 
    iter = ao2_iterator_init(cached_channels, 0);
    for (; (snapshot = ao2_iterator_next(&iter)); ao2_ref(snapshot, -1)) {
        if (!strncasecmp(word, snapshot->base->name, wordlen) && (++which > state)) {
            if (state != -1) {
                ret = ast_strdup(snapshot->base->name);
                ao2_ref(snapshot, -1);
                break;
            }
 
            if (ast_cli_completion_add(ast_strdup(snapshot->base->name))) {
                ao2_ref(snapshot, -1);
                break;
            }
        }
    }
    ao2_iterator_destroy(&iter);
    ao2_ref(cached_channels, -1);
 
    return ret;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_channel_cache_all(), ast_cli_completion_add(), ast_strdup, ast_channel_snapshot::base, ast_channel_snapshot_base::name, NULL, and state.

Referenced by cli_complete_notify(), handle_cli_agi_add_cmd(), handle_cli_mixmonitor(), handle_core_set_debug_channel(), handle_dump_frames(), handle_redirect(), handle_remb_set(), handle_set_chanvar(), handle_show_chanvar(), handle_show_hangup_channel(), handle_showchan(), and handle_softhangup().

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ast_cli_command

◆ ast_cli_command_multiple

◆ AST_CLI_COMPLETE_EOF

◆ AST_CLI_DEFINE

◆ AST_CLI_ONOFF

◆ ast_cli_register

◆ ast_cli_register_multiple

◆ AST_CLI_YESNO

◆ AST_MAX_ARGS

◆ AST_MAX_CMD_LEN

◆ CLI_FAILURE

◆ CLI_NO_PERMS

◆ CLI_SHOWUSAGE

◆ CLI_SUCCESS

◆ ESS

◆ RESULT_FAILURE

◆ RESULT_SHOWUSAGE

◆ RESULT_SUCCESS

Enumeration Type Documentation

◆ ast_cli_command

Function Documentation

◆ __ast_cli_register()

◆ __ast_cli_register_multiple()

◆ ast_cli()

◆ ast_cli_allow_at_shutdown()

◆ ast_cli_command_full()

◆ ast_cli_command_multiple_full()

◆ ast_cli_complete()

◆ ast_cli_completion_add()

◆ ast_cli_completion_matches()

◆ ast_cli_completion_vector()

◆ ast_cli_generator()

◆ ast_cli_print_timestr_fromseconds()

◆ ast_cli_unregister()

◆ ast_cli_unregister_multiple()

◆ ast_complete_channels()