Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge "cli: Fix various CLI documentation and completion issues"

Browse Source
changes/42/4942/4
zuul 8 years ago committed by Gerrit Code Review
parent cea835e565 3f94373778
commit 182c737353
14 changed files with 118 additions and 97 deletions
Show Stats Download Patch File Download Diff File

8
apps/app_minivm.c
Unescape View File

@ -3014,11 +3014,9 @@ static char *complete_minivm_show_users(const char *line, const char *word, int
struct minivm_account *vmu;
const char *domain = "";
/* 0 - voicemail; 1 - list; 2 - accounts; 3 - for; 4 - <domain> */
/* 0 - minivm; 1 - list; 2 - accounts; 3 - for; 4 - <domain> */
if (pos > 4)
return NULL;
if (pos == 3)
return (state == 0) ? ast_strdup("for") : NULL;
wordlen = strlen(word);
AST_LIST_TRAVERSE(&minivm_accounts, vmu, list) {
if (!strncasecmp(word, vmu->domain, wordlen)) {
@ -3040,9 +3038,9 @@ static char *handle_minivm_show_users(struct ast_cli_entry *e, int cmd, struct a
switch (cmd) {
case CLI_INIT:
e->command = "minivm list accounts";
e->command = "minivm list accounts [for]";
e->usage =
"Usage: minivm list accounts\n"
"Usage: minivm list accounts [for <domain>]\n"
" Lists all mailboxes currently set up\n";
return NULL;
case CLI_GENERATE:

6
apps/app_voicemail.c
Unescape View File

@ -12745,11 +12745,9 @@ static char *complete_voicemail_show_users(const char *line, const char *word, i
struct ast_vm_user *vmu;
const char *context = "";
/* 0 - show; 1 - voicemail; 2 - users; 3 - for; 4 - <context> */
/* 0 - voicemail; 1 - show; 2 - users; 3 - for; 4 - <context> */
if (pos > 4)
return NULL;
if (pos == 3)
return (state == 0) ? ast_strdup("for") : NULL;
wordlen = strlen(word);
AST_LIST_TRAVERSE(&users, vmu, list) {
if (!strncasecmp(word, vmu->context, wordlen)) {
@ -12772,7 +12770,7 @@ static char *handle_voicemail_show_users(struct ast_cli_entry *e, int cmd, struc
switch (cmd) {
case CLI_INIT:
e->command = "voicemail show users";
e->command = "voicemail show users [for]";
e->usage =
"Usage: voicemail show users [for <context>]\n"
" Lists all mailboxes currently set up\n";

12
apps/confbridge/conf_config_parser.c
Unescape View File

@ -1371,7 +1371,7 @@ static char *handle_cli_confbridge_show_user_profiles(struct ast_cli_entry *e, i
case CLI_INIT:
e->command = "confbridge show profile users";
e->usage =
"Usage confbridge show profile users\n";
"Usage: confbridge show profile users\n";
return NULL;
case CLI_GENERATE:
return NULL;
@ -1401,7 +1401,7 @@ static char *handle_cli_confbridge_show_user_profile(struct ast_cli_entry *e, in
case CLI_INIT:
e->command = "confbridge show profile user";
e->usage =
"Usage confbridge show profile user [<profile name>]\n";
"Usage: confbridge show profile user [<profile name>]\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 4) {
@ -1522,7 +1522,7 @@ static char *handle_cli_confbridge_show_bridge_profiles(struct ast_cli_entry *e,
case CLI_INIT:
e->command = "confbridge show profile bridges";
e->usage =
"Usage confbridge show profile bridges\n";
"Usage: confbridge show profile bridges\n";
return NULL;
case CLI_GENERATE:
return NULL;
@ -1554,7 +1554,7 @@ static char *handle_cli_confbridge_show_bridge_profile(struct ast_cli_entry *e,
case CLI_INIT:
e->command = "confbridge show profile bridge";
e->usage =
"Usage confbridge show profile bridge <profile name>\n";
"Usage: confbridge show profile bridge <profile name>\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 4) {
@ -1706,7 +1706,7 @@ static char *handle_cli_confbridge_show_menus(struct ast_cli_entry *e, int cmd,
case CLI_INIT:
e->command = "confbridge show menus";
e->usage =
"Usage confbridge show profile menus\n";
"Usage: confbridge show profile menus\n";
return NULL;
case CLI_GENERATE:
return NULL;
@ -1740,7 +1740,7 @@ static char *handle_cli_confbridge_show_menu(struct ast_cli_entry *e, int cmd, s
case CLI_INIT:
e->command = "confbridge show menu";
e->usage =
"Usage confbridge show menu [<menu name>]\n";
"Usage: confbridge show menu [<menu name>]\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 3) {

20
channels/chan_alsa.c
Unescape View File

@ -637,29 +637,13 @@ static struct ast_channel *alsa_request(const char *type, struct ast_format_cap
return tmp;
}
static char *autoanswer_complete(const char *line, const char *word, int pos, int state)
{
switch (state) {
case 0:
if (!ast_strlen_zero(word) && !strncasecmp(word, "on", MIN(strlen(word), 2)))
return ast_strdup("on");
case 1:
if (!ast_strlen_zero(word) && !strncasecmp(word, "off", MIN(strlen(word), 3)))
return ast_strdup("off");
default:
return NULL;
}
return NULL;
}
static char *console_autoanswer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
char *res = CLI_SUCCESS;
switch (cmd) {
case CLI_INIT:
e->command = "console autoanswer";
e->command = "console autoanswer [on|off]";
e->usage =
"Usage: console autoanswer [on|off]\n"
" Enables or disables autoanswer feature. If used without\n"
@ -667,7 +651,7 @@ static char *console_autoanswer(struct ast_cli_entry *e, int cmd, struct ast_cli
" The default value of autoanswer is in 'alsa.conf'.\n";
return NULL;
case CLI_GENERATE:
return autoanswer_complete(a->line, a->word, a->pos, a->n);
return NULL;
}
if ((a->argc != 2) && (a->argc != 3))

27
channels/chan_sip.c
Unescape View File

@ -19587,7 +19587,7 @@ static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
switch (cmd) {
case CLI_INIT:
e->command = "sip show inuse";
e->command = "sip show inuse [all]";
e->usage =
"Usage: sip show inuse [all]\n"
" List all SIP devices usage counters and limits.\n"
@ -19777,7 +19777,7 @@ static char *sip_show_users(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
switch (cmd) {
case CLI_INIT:
e->command = "sip show users";
e->command = "sip show users [like]";
e->usage =
"Usage: sip show users [like <pattern>]\n"
" Lists all known SIP users.\n"
@ -19916,7 +19916,7 @@ static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
{
switch (cmd) {
case CLI_INIT:
e->command = "sip show peers";
e->command = "sip show peers [like]";
e->usage =
"Usage: sip show peers [like <pattern>]\n"
" Lists all known SIP peers.\n"
@ -20630,7 +20630,12 @@ static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args
" Option \"load\" forces lookup of peer in realtime storage.\n";
return NULL;
case CLI_GENERATE:
return complete_sip_show_peer(a->line, a->word, a->pos, a->n);
if (a->pos == 4) {
static const char * const completions[] = { "load", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return complete_sip_show_peer(a->line, a->word, a->pos, a->n);
}
}
return _sip_show_peer(0, a->fd, NULL, NULL, a->argc, (const char **) a->argv);
}
@ -20800,7 +20805,12 @@ static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_a
" Option \"load\" forces lookup of peer in realtime storage.\n";
return NULL;
case CLI_GENERATE:
return complete_sip_show_peer(a->line, a->word, a->pos, a->n);
if (a->pos == 4) {
static const char * const completions[] = { "load", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return complete_sip_show_peer(a->line, a->word, a->pos, a->n);
}
}
return _sip_qualify_peer(0, a->fd, NULL, NULL, a->argc, (const char **) a->argv);
}
@ -21171,7 +21181,12 @@ static char *sip_show_user(struct ast_cli_entry *e, int cmd, struct ast_cli_args
" Option \"load\" forces lookup of peer in realtime storage.\n";
return NULL;
case CLI_GENERATE:
return complete_sip_show_user(a->line, a->word, a->pos, a->n);
if (a->pos == 4) {
static const char * const completions[] = { "load", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return complete_sip_show_user(a->line, a->word, a->pos, a->n);
}
}
if (a->argc < 4)

40
channels/chan_skinny.c
Unescape View File

@ -3921,24 +3921,40 @@ static char *complete_skinny_show_device(const char *line, const char *word, int
static char *complete_skinny_reset(const char *line, const char *word, int pos, int state)
{
return (pos == 2 ? complete_skinny_devices(word, state) : NULL);
if (pos == 2) {
static const char * const completions[] = { "all", NULL };
char *ret = ast_cli_complete(word, completions, state);
if (!ret) {
ret = complete_skinny_devices(word, state - 1);
}
return ret;
} else if (pos == 3) {
static const char * const completions[] = { "restart", NULL };
return ast_cli_complete(word, completions, state);
}
return NULL;
}
static char *complete_skinny_show_line(const char *line, const char *word, int pos, int state)
{
struct skinny_device *d;
struct skinny_line *l;
int wordlen = strlen(word), which = 0;
if (pos == 3) {
struct skinny_device *d;
struct skinny_line *l;
int wordlen = strlen(word), which = 0;
if (pos != 3)
return NULL;
AST_LIST_TRAVERSE(&devices, d, list) {
AST_LIST_TRAVERSE(&d->lines, l, list) {
if (!strncasecmp(word, l->name, wordlen) && ++which > state) {
return ast_strdup(l->name);
AST_LIST_TRAVERSE(&devices, d, list) {
AST_LIST_TRAVERSE(&d->lines, l, list) {
if (!strncasecmp(word, l->name, wordlen) && ++which > state) {
return ast_strdup(l->name);
}
}
}
} else if (pos == 4) {
static const char * const completions[] = { "on", NULL };
return ast_cli_complete(word, completions, state);
} else if (pos == 5) {
return complete_skinny_devices(word, state);
}
return NULL;
@ -4580,7 +4596,7 @@ static char *handle_skinny_show_line(struct ast_cli_entry *e, int cmd, struct as
case CLI_INIT:
e->command = "skinny show line";
e->usage =
"Usage: skinny show line <Line> [ on <DeviceID|DeviceName> ]\n"
"Usage: skinny show line <Line> [on <DeviceID|DeviceName>]\n"
" List all lineinformation of a specific line known to the Skinny subsystem.\n";
return NULL;
case CLI_GENERATE:

6
funcs/func_odbc.c
Unescape View File

@ -1417,7 +1417,8 @@ static char *cli_odbc_read(struct ast_cli_entry *e, int cmd, struct ast_cli_args
AST_RWLIST_UNLOCK(&queries);
return NULL;
} else if (a->pos == 4) {
return a->n == 0 ? ast_strdup("exec") : NULL;
static const char * const completions[] = { "exec", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return NULL;
}
@ -1623,7 +1624,8 @@ static char *cli_odbc_write(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
AST_RWLIST_UNLOCK(&queries);
return NULL;
} else if (a->pos == 5) {
return a->n == 0 ? ast_strdup("exec") : NULL;
static const char * const completions[] = { "exec", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return NULL;
}

21
main/astmm.c
Unescape View File

@ -691,17 +691,12 @@ static char *handle_memory_atexit_list(struct ast_cli_entry *e, int cmd, struct
{
switch (cmd) {
case CLI_INIT:
e->command = "memory atexit list";
e->command = "memory atexit list {on|off}";
e->usage =
"Usage: memory atexit list {on|off}\n"
" Enable dumping a list of still allocated memory segments at exit.\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 3) {
const char * const options[] = { "off", "on", NULL };
return ast_cli_complete(a->word, options, a->n);
}
return NULL;
}
@ -728,7 +723,7 @@ static char *handle_memory_atexit_summary(struct ast_cli_entry *e, int cmd, stru
switch (cmd) {
case CLI_INIT:
e->command = "memory atexit summary";
e->command = "memory atexit summary {off|byline|byfunc|byfile}";
e->usage =
"Usage: memory atexit summary {off|byline|byfunc|byfile}\n"
" Summary of still allocated memory segments at exit options.\n"
@ -740,11 +735,6 @@ static char *handle_memory_atexit_summary(struct ast_cli_entry *e, int cmd, stru
" Note: byline, byfunc, and byfile are cumulative enables.\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 3) {
const char * const options[] = { "off", "byline", "byfunc", "byfile", NULL };
return ast_cli_complete(a->word, options, a->n);
}
return NULL;
}
@ -1043,7 +1033,7 @@ static char *handle_memory_backtrace(struct ast_cli_entry *e, int cmd, struct as
{
switch (cmd) {
case CLI_INIT:
e->command = "memory backtrace";
e->command = "memory backtrace {on|off}";
e->usage =
"Usage: memory backtrace {on|off}\n"
" Enable dumping an allocation backtrace with memory diagnostics.\n"
@ -1051,11 +1041,6 @@ static char *handle_memory_backtrace(struct ast_cli_entry *e, int cmd, struct as
" can be CPU intensive.\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 2) {
const char * const options[] = { "off", "on", NULL };
return ast_cli_complete(a->word, options, a->n);
}
return NULL;
}

14
main/bridge.c
Unescape View File

@ -5170,12 +5170,6 @@ static char *complete_bridge_participant(const char *bridge_name, const char *li
return NULL;
}
if (!state) {
ao2_ref(bridge, -1);
return ast_strdup("all");
}
state--;
{
SCOPED_LOCK(bridge_lock, bridge, ast_bridge_lock, ast_bridge_unlock);
@ -5197,6 +5191,8 @@ static char *complete_bridge_participant(const char *bridge_name, const char *li
static char *handle_bridge_kick_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
static const char * const completions[] = { "all", NULL };
char *complete;
struct ast_bridge *bridge;
switch (cmd) {
@ -5213,7 +5209,11 @@ static char *handle_bridge_kick_channel(struct ast_cli_entry *e, int cmd, struct
return complete_bridge_live(a->word, a->n);
}
if (a->pos == 3) {
return complete_bridge_participant(a->argv[2], a->line, a->word, a->pos, a->n);
complete = ast_cli_complete(a->word, completions, a->n);
if (!complete) {
complete = complete_bridge_participant(a->argv[2], a->line, a->word, a->pos, a->n - 1);
}
return complete;
}
return NULL;
}

9
main/ccss.c
Unescape View File

@ -4566,11 +4566,9 @@ static char *complete_core_id(const char *line, const char *word, int pos, int s
static char *handle_cc_kill(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
static const char * const option[] = { "core", "all", NULL };
switch (cmd) {
case CLI_INIT:
e->command = "cc cancel";
e->command = "cc cancel [core|all]";
e->usage =
"Usage: cc cancel can be used in two ways.\n"
" 1. 'cc cancel core [core ID]' will cancel the CC transaction with\n"
@ -4578,10 +4576,7 @@ static char *handle_cc_kill(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
" 2. 'cc cancel all' will cancel all active CC transactions.\n";
return NULL;
case CLI_GENERATE:
if (a->pos == 2) {
return ast_cli_complete(a->word, option, a->n);
}
if (a->pos == 3) {
if (a->pos == 3 && !strcasecmp(a->argv[2], "core")) {
return complete_core_id(a->line, a->word, a->pos, a->n);
}
return NULL;

33
main/cli.c
Unescape View File

@ -916,6 +916,7 @@ static char *handle_modlist(struct ast_cli_entry *e, int cmd, struct ast_cli_arg
static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
static const char * const completions[] = { "seconds", NULL };
struct timeval curtime = ast_tvnow();
int showuptime, printsec;
@ -923,7 +924,7 @@ static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_a
case CLI_INIT:
e->command = "core show calls [uptime]";
e->usage =
"Usage: core show calls [uptime] [seconds]\n"
"Usage: core show calls [uptime [seconds]]\n"
" Lists number of currently active calls and total number of calls\n"
" processed through PBX since last restart. If 'uptime' is specified\n"
" the system uptime is also displayed. If 'seconds' is specified in\n"
@ -933,7 +934,7 @@ static char *handle_showcalls(struct ast_cli_entry *e, int cmd, struct ast_cli_a
case CLI_GENERATE:
if (a->pos != e->args)
return NULL;
return a->n == 0 ? ast_strdup("seconds") : NULL;
return ast_cli_complete(a->word, completions, a->n);
}
/* regular handler */
@ -1103,7 +1104,9 @@ static char *handle_chanlist(struct ast_cli_entry *e, int cmd, struct ast_cli_ar
static char *handle_softhangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
struct ast_channel *c=NULL;
struct ast_channel *c = NULL;
static const char * const completions[] = { "all", NULL };
char *complete;
switch (cmd) {
case CLI_INIT:
@ -1116,7 +1119,14 @@ static char *handle_softhangup(struct ast_cli_entry *e, int cmd, struct ast_cli_
" will see the hangup request.\n";
return NULL;
case CLI_GENERATE:
return ast_complete_channels(a->line, a->word, a->pos, a->n, e->args);
if (a->pos != e->args) {
return NULL;
}
complete = ast_cli_complete(a->word, completions, a->n);
if (!complete) {
complete = ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
}
return complete;
}
if (a->argc != 4) {
@ -1428,6 +1438,8 @@ static int channel_set_debug(void *obj, void *arg, void *data, int flags)
static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
struct ast_channel *c = NULL;
static const char * const completions_all[] = { "all", NULL };
static const char * const completions_off[] = { "off", NULL };
struct channel_set_debug_args args = {
.fd = a->fd,
};
@ -1440,10 +1452,15 @@ static char *handle_core_set_debug_channel(struct ast_cli_entry *e, int cmd, str
" Enables/disables debugging on all or on a specific channel.\n";
return NULL;
case CLI_GENERATE:
/* XXX remember to handle the optional "off" */
if (a->pos != e->args)
return NULL;
return a->n == 0 ? ast_strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
if (a->pos == 4) {
char *complete = ast_cli_complete(a->word, completions_all, a->n);
if (!complete) {
complete = ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args);
}
return complete;
} else if (a->pos == 5) {
return ast_cli_complete(a->word, completions_off, a->n);
}
}
if (cmd == (CLI_HANDLER + 1000)) {

3
main/pbx_app.c
Unescape View File

@ -313,7 +313,6 @@ static char *handle_show_applications(struct ast_cli_entry *e, int cmd, struct a
int like = 0, describing = 0;
int total_match = 0; /* Number of matches in like clause */
int total_apps = 0; /* Number of apps registered */
static const char * const choices[] = { "like", "describing", NULL };
switch (cmd) {
case CLI_INIT:
@ -325,7 +324,7 @@ static char *handle_show_applications(struct ast_cli_entry *e, int cmd, struct a
" If 'describing', <text> will be a substring of the description\n";
return NULL;
case CLI_GENERATE:
return (a->pos != 3) ? NULL : ast_cli_complete(a->word, choices, a->n);
return NULL;
}
AST_RWLIST_RDLOCK(&apps);

2
main/pbx_hangup_handler.c
Unescape View File

@ -258,7 +258,7 @@ static char *handle_show_hangup_all(struct ast_cli_entry *e, int cmd, struct ast
" Show hangup handlers for all channels.\n";
return NULL;
case CLI_GENERATE:
return ast_complete_channels(a->line, a->word, a->pos, a->n, e->args);
return NULL;
}
if (a->argc < 4) {

14
res/res_sorcery_memory_cache.c
Unescape View File

@ -1866,6 +1866,7 @@ static char *sorcery_memory_cache_expire(struct ast_cli_entry *e, int cmd, struc
static char *sorcery_memory_cache_stale(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
struct sorcery_memory_cache *cache;
int reload = 0;
switch (cmd) {
case CLI_INIT:
@ -1881,6 +1882,9 @@ static char *sorcery_memory_cache_stale(struct ast_cli_entry *e, int cmd, struct
return sorcery_memory_cache_complete_name(a->word, a->n);
} else if (a->pos == 5) {
return sorcery_memory_cache_complete_object_name(a->argv[4], a->word, a->n);
} else if (a->pos == 6) {
static const char * const completions[] = { "reload", NULL };
return ast_cli_complete(a->word, completions, a->n);
} else {
return NULL;
}
@ -1890,6 +1894,14 @@ static char *sorcery_memory_cache_stale(struct ast_cli_entry *e, int cmd, struct
return CLI_SHOWUSAGE;
}
if (a->argc == 7) {
if (!strcasecmp(a->argv[6], "reload")) {
reload = 1;
} else {
return CLI_SHOWUSAGE;
}
}
cache = ao2_find(caches, a->argv[4], OBJ_SEARCH_KEY);
if (!cache) {
ast_cli(a->fd, "Specified sorcery memory cache '%s' does not exist\n", a->argv[4]);
@ -1910,7 +1922,7 @@ static char *sorcery_memory_cache_stale(struct ast_cli_entry *e, int cmd, struct
if (!mark_object_as_stale_in_cache(cache, a->argv[5])) {
ast_cli(a->fd, "Successfully marked object '%s' in memory cache '%s' as stale\n",
a->argv[5], a->argv[4]);
if (a->argc == 7 && ast_true(a->argv[6])) {
if (reload) {
struct sorcery_memory_cached_object *cached;
cached = ao2_find(cache->objects, a->argv[5], OBJ_SEARCH_KEY | OBJ_NOLOCK);

Write Preview
Loading…
Cancel
Save