Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:01:28 2007

Asterisk developer's documentation :: Codename Pineapple

---

cli.c File Reference

---

Detailed Description

Standard Command Line Interface.

Author:

Mark Spencer <markster@digium.com>

Definition in file cli.c.

#include "asterisk.h"
#include <unistd.h>
#include <stdlib.h>
#include <sys/signal.h>
#include <stdio.h>
#include <signal.h>
#include <string.h>
#include <ctype.h>
#include <regex.h>
#include "asterisk/logger.h"
#include "asterisk/options.h"
#include "asterisk/cli.h"
#include "asterisk/linkedlists.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/channel.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/lock.h"
#include "editline/readline/readline.h"
#include "asterisk/threadstorage.h"

Include dependency graph for cli.c:

Go to the source code of this file.

Data Structures
struct	cli_iterator
Defines
#define	AST_CLI_INITLEN   256
	Initial buffer size for resulting strings in ast_cli().
#define	CONCISE_FORMAT_STRING   "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"
#define	DAY   (HOUR*24)
#define	FORMAT_STRING   "%-25s %-20s %-20s\n"
#define	FORMAT_STRING   "%-20.20s %-20.20s %-7.7s %-30.30s\n"
#define	FORMAT_STRING2   "%-20.20s %-20.20s %-7.7s %-30.30s\n"
#define	HOUR   (MINUTE*60)
#define	MINUTE   (SECOND*60)
#define	MODLIST_FORMAT   "%-30s %-40.40s %-10d\n"
#define	MODLIST_FORMAT2   "%-30s %-40.40s %-10s\n"
#define	NEEDCOMMA(x)   ((x)? ",": "")
#define	SECOND   (1)
#define	VERBOSE_FORMAT_STRING   "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
#define	VERBOSE_FORMAT_STRING2   "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"
#define	WEEK   (DAY*7)
#define	YEAR   (DAY*365)
Functions
static char *	__ast_cli_generator (const char *text, const char *word, int state, int lock)
static int	__ast_cli_register (struct ast_cli_entry *e, struct ast_cli_entry *ed)
static int	__ast_cli_unregister (struct ast_cli_entry *e, struct ast_cli_entry *ed)
void	ast_builtins_init (void)
	initialize the _full_cmd string in * each of the builtins.
void	ast_cli (int fd, char *fmt,...)
int	ast_cli_command (int fd, const char *s)
	Interprets a command Interpret a command s, sending output to fd Returns 0 on succes, -1 on failure.
char *	ast_cli_complete (const char *word, char *const choices[], int state)
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.
char *	ast_cli_generator (const char *text, const char *word, int state)
	Readline madness Useful for readline, that's about it Returns 0 on success, -1 on failure.
int	ast_cli_generatornummatches (const char *text, const char *word)
	Return the number of unique matches for the generator.
int	ast_cli_register (struct ast_cli_entry *e)
	Registers a command or an array of commands.
void	ast_cli_register_multiple (struct ast_cli_entry *e, int len)
	Register multiple commands.
int	ast_cli_unregister (struct ast_cli_entry *e)
	Unregisters a command or an array of commands.
void	ast_cli_unregister_multiple (struct ast_cli_entry *e, int len)
	Unregister multiple commands.
char *	ast_complete_channels (const char *line, const char *word, int pos, int state, int rpos)
	Command completion for the list of active channels.
static	AST_LIST_HEAD_STATIC (helpers, ast_cli_entry)
	AST_MUTEX_DEFINE_STATIC (climodentrylock)
	AST_THREADSTORAGE (ast_cli_buf)
static struct ast_cli_entry *	cli_next (struct cli_iterator *i)
static char *	complete_ch_3 (const char *line, const char *word, int pos, int state)
static char *	complete_ch_4 (const char *line, const char *word, int pos, int state)
static char *	complete_fn (const char *word, int state)
static char *	find_best (char *argv[])
static struct ast_cli_entry *	find_cli (char *const cmds[], int match_type)
	locate a cli command in the 'helpers' list (which must be locked). exact has 3 values: 0 returns if the search key is equal or longer than the entry. note that trailing optional arguments are skipped. -1 true if the mismatch is on the last word XXX not true! 1 true only on complete, exact match.
static int	group_show_channels (int fd, int argc, char *argv[])
static char *	handle_chanlist (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_commandcomplete (int fd, int argc, char *argv[])
static int	handle_commandmatchesarray (int fd, int argc, char *argv[])
static int	handle_commandnummatches (int fd, int argc, char *argv[])
static char *	handle_core_set_debug_channel (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_debugchan_deprecated (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_help (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_load (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_load_deprecated (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_logger_mute (int fd, int argc, char *argv[])
static char *	handle_modlist (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_nodebugchan_deprecated (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_reload (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_reload_deprecated (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_showchan (int fd, int argc, char *argv[])
static char *	handle_showuptime (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	handle_softhangup (int fd, int argc, char *argv[])
static char *	handle_unload (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_unload_deprecated (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_verbose (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	help1 (int fd, char *match[], int locked)
	helper for final part of handle_help. if locked = 0 it's just "help_workhorse", otherwise assume the list is already locked and print an error message if not found.
static char *	is_prefix (const char *word, const char *token, int pos, int *actual)
	if word is a valid prefix for token, returns the pos-th match as a malloced string, or NULL otherwise. Always tell in *actual how many matches we got.
static int	modlist_modentry (const char *module, const char *description, int usecnt, const char *like)
static int	more_words (char *const *dst)
	returns true if there are more words to match
static char *	parse_args (const char *s, int *argc, char *argv[], int max, int *trailingwhitespace)
static void	print_uptimestr (int fd, time_t timeval, const char *prefix, int printsec)
static int	set_full_cmd (struct ast_cli_entry *e)
static int	word_match (const char *cmd, const char *cli_word)
Variables
static struct ast_cli_entry	builtins []
static struct ast_cli_entry	cli_cli []
static struct ast_cli_entry	cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel")
static struct ast_cli_entry	cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module")
static struct ast_cli_entry	cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name")
static struct ast_cli_entry	cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name")
static const char	cli_rsvd [] = "[]{}|*%"
static int	climodentryfd = -1
static const char	commandcomplete_help []
static const char	commandmatchesarray_help []
static const char	commandnummatches_help []
static const char	group_show_channels_help []
static const char	logger_mute_help []
static const char	showchan_help []
static const char	softhangup_help []

---

Define Documentation

#define AST_CLI_INITLEN   256

Initial buffer size for resulting strings in ast_cli(). Definition at line 55 of file cli.c. Referenced by ast_cli().

#define CONCISE_FORMAT_STRING   "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n"

Referenced by handle_chanlist().

#define DAY   (HOUR*24)

Referenced by print_uptimestr().

#define FORMAT_STRING   "%-25s %-20s %-20s\n"

#define FORMAT_STRING   "%-20.20s %-20.20s %-7.7s %-30.30s\n"

Referenced by group_show_channels(), and handle_chanlist().

#define FORMAT_STRING2   "%-20.20s %-20.20s %-7.7s %-30.30s\n"

Referenced by handle_chanlist().

#define HOUR   (MINUTE*60)

Referenced by print_uptimestr().

#define MINUTE   (SECOND*60)

Referenced by print_uptimestr().

#define MODLIST_FORMAT   "%-30s %-40.40s %-10d\n"

Definition at line 314 of file cli.c. Referenced by modlist_modentry().

#define MODLIST_FORMAT2   "%-30s %-40.40s %-10s\n"

Definition at line 315 of file cli.c. Referenced by handle_modlist().

#define NEEDCOMMA (  x   )     ((x)? ",": "")

Referenced by print_uptimestr().

#define SECOND   (1)

#define VERBOSE_FORMAT_STRING   "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"

Referenced by handle_chanlist().

#define VERBOSE_FORMAT_STRING2   "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n"

Referenced by handle_chanlist().

#define WEEK   (DAY*7)

Referenced by print_uptimestr().

#define YEAR   (DAY*365)

Referenced by print_uptimestr().

---

Function Documentation

static char * __ast_cli_generator (  const char *  text, const char *  word, int  state, int  lock )  [static]

Definition at line 1596 of file cli.c. References ast_join(), AST_LIST_LOCK, AST_MAX_ARGS, ast_strlen_zero(), cli_next(), ast_cli_entry::cmda, free, cli_iterator::helpers, is_prefix(), more_words(), parse_args(), and word_match(). Referenced by ast_cli_generator(), handle_commandcomplete(), and handle_help(). { char *argv[AST_MAX_ARGS]; struct ast_cli_entry *e; struct cli_iterator i = { NULL, NULL }; int x = 0, argindex, matchlen; int matchnum=0; char *ret = NULL; char matchstr[80] = ""; int tws = 0; /* Split the argument into an array of words */ char *dup = parse_args(text, &x, argv, sizeof(argv) / sizeof(argv[0]), &tws); if (!dup) /* malloc error */ return NULL; /* Compute the index of the last argument (could be an empty string) */ argindex = (!ast_strlen_zero(word) && x>0) ? x-1 : x; /* rebuild the command, ignore terminating white space and flatten space */ ast_join(matchstr, sizeof(matchstr)-1, argv); matchlen = strlen(matchstr); if (tws) { strcat(matchstr, " "); /* XXX */ if (matchlen) matchlen++; } if (lock) AST_LIST_LOCK(&helpers); while ( (e = cli_next(&i)) ) { /* XXX repeated code */ int src = 0, dst = 0, n = 0; /* * Try to match words, up to and excluding the last word, which * is either a blank or something that we want to extend. */ for (;src < argindex; dst++, src += n) { n = word_match(argv[src], e->cmda[dst]); if (n < 0) break; } if (src != argindex && more_words(e->cmda + dst)) /* not a match */ continue; ret = is_prefix(argv[src], e->cmda[dst], state - matchnum, &n); matchnum += n; /* this many matches here */ if (ret) { /* * argv[src] is a valid prefix of the next word in this * command. If this is also the correct entry, return it. */ if (matchnum > state) break; free(ret); ret = NULL; } else if (ast_strlen_zero(e->cmda[dst])) { /* * This entry is a prefix of the command string entered * (only one entry in the list should have this property). * Run the generator if one is available. In any case we are done. */ if (e->generator) ret = e->generator(matchstr, word, argindex, state - matchnum); else if (e->new_handler) { /* new style command */ struct ast_cli_args a = { .line = matchstr, .word = word, .pos = argindex, .n = state - matchnum }; ret = e->new_handler(e, CLI_GENERATE, &a); } if (ret) break; } } if (lock) AST_LIST_UNLOCK(&helpers); free(dup); return ret; }

static int __ast_cli_register (  struct ast_cli_entry *  e, struct ast_cli_entry *  ed )  [static]

Definition at line 1266 of file cli.c. References AST_MAX_CMD_LEN, ast_strdup, ast_strlen_zero(), CLI_INIT, ast_cli_entry::cmda, ast_cli_entry::command, ast_cli_entry::handler, ast_cli_entry::new_handler, and s. Referenced by ast_cli_register(). { struct ast_cli_entry *cur; int i, lf, ret = -1; if (e->handler == NULL) { /* new style entry, run the handler to init fields */ struct ast_cli_args a; /* fake argument */ char **dst = (char **)e->cmda; /* need to cast as the entry is readonly */ char *s; bzero (&a, sizeof(a)); e->new_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 (set_full_cmd(e)) goto done; AST_LIST_LOCK(&helpers); if (find_cli(e->cmda, 1)) { ast_log(LOG_WARNING, "Command '%s' already registered (or something close enough)\n", e->_full_cmd); free(e->_full_cmd); e->_full_cmd = NULL; goto done; } if (!ed) { e->deprecated = 0; } else { e->deprecated = 1; e->summary = ed->summary; e->usage = ed->usage; /* XXX If command A deprecates command B, and command B deprecates command C... Do we want to show command A or command B when telling the user to use new syntax? This currently would show command A. To show command B, you just need to always use ed->_full_cmd. */ e->_deprecated_by = S_OR(ed->_deprecated_by, ed->_full_cmd); } lf = e->cmdlen; AST_LIST_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_LIST_INSERT_BEFORE_CURRENT(&helpers, e, list); break; } } AST_LIST_TRAVERSE_SAFE_END; if (!cur) AST_LIST_INSERT_TAIL(&helpers, e, list); ret = 0; /* success */ done: AST_LIST_UNLOCK(&helpers); if (e->deprecate_cmd) { /* This command deprecates another command. Register that one also. */ __ast_cli_register(e->deprecate_cmd, e); } return ret; }

static int __ast_cli_unregister (  struct ast_cli_entry *  e, struct ast_cli_entry *  ed )  [static]

Definition at line 1242 of file cli.c. References ast_cli_entry::_full_cmd, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, ast_log(), ast_cli_entry::cmda, ast_cli_entry::command, ast_cli_entry::deprecate_cmd, free, cli_iterator::helpers, ast_cli_entry::inuse, LOG_WARNING, ast_cli_entry::new_handler, and ast_cli_entry::usage. Referenced by ast_cli_unregister(). { if (e->deprecate_cmd) { __ast_cli_unregister(e->deprecate_cmd, e); } if (e->inuse) { ast_log(LOG_WARNING, "Can't remove command that is in use\n"); } else { AST_LIST_LOCK(&helpers); AST_LIST_REMOVE(&helpers, e, list); AST_LIST_UNLOCK(&helpers); free(e->_full_cmd); e->_full_cmd = NULL; if (e->new_handler) { /* this is a new-style entry. Reset fields and free memory. */ bzero((char **)(e->cmda), sizeof(e->cmda)); free(e->command); e->command = NULL; e->usage = NULL; } } return 0; }

void ast_builtins_init (  void   )

initialize the _full_cmd string in * each of the builtins. Provided by cli.c Definition at line 1046 of file cli.c. References ast_cli_register_multiple(), builtins, cli_cli, ast_cli_entry::cmda, and set_full_cmd(). { struct ast_cli_entry *e; for (e = builtins; e->cmda[0] != NULL; e++) set_full_cmd(e); ast_cli_register_multiple(cli_cli, sizeof(cli_cli) / sizeof(struct ast_cli_entry)); }

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

Definition at line 57 of file cli.c. References ast_carefulwrite(), AST_CLI_INITLEN, ast_str_set_va, and ast_str::str. Referenced by __iax2_show_peers(), __sip_show_channels(), _sip_show_device(), _sip_show_devices(), _sip_show_peer(), _sip_show_peers(), agent_logoff_cmd(), agents_show(), agents_show_online(), agi_do_debug(), agi_no_debug(), aji_do_reload(), aji_show_clients(), aji_test(), ast_cli_command(), ast_console_toggle_mute(), cli_audio_convert(), cli_files_show(), cli_realtime_load(), cli_realtime_update(), config_command(), console_active(), console_answer(), console_autoanswer(), console_dial(), console_flash(), console_hangup(), console_sendtext(), console_transfer(), database_del(), database_deltree(), database_get(), database_put(), database_show(), database_showkey(), do_boost(), dundi_do_debug(), dundi_do_lookup(), dundi_do_precache(), dundi_do_query(), dundi_do_store_history(), dundi_no_debug(), dundi_no_store_history(), dundi_show_entityid(), dundi_show_mappings(), dundi_show_peer(), dundi_show_peers(), dundi_show_precache(), dundi_show_requests(), dundi_show_trans(), features_show(), group_show_channels(), gtalk_show_channels(), h323_do_debug(), h323_do_trace(), h323_no_debug(), h323_no_trace(), handle_agidumphtml(), handle_chanlist(), handle_cli_status(), handle_cli_submit(), handle_commandcomplete(), handle_commandnummatches(), handle_context_add_extension(), handle_context_add_ignorepat(), handle_context_add_include(), handle_context_remove_extension(), handle_context_remove_ignorepat(), handle_context_remove_include(), handle_core_set_debug_channel(), handle_help(), handle_load(), handle_logger_reload(), handle_logger_rotate(), handle_logger_show_channels(), handle_mandebug(), handle_modlist(), handle_parkedcalls(), handle_reload(), handle_restart_when_convenient(), handle_save_dialplan(), handle_set_global(), handle_show_application(), handle_show_applications(), handle_show_dialplan(), handle_show_function(), handle_show_functions(), handle_show_globals(), handle_show_hints(), handle_show_http(), handle_show_indications(), handle_show_switches(), handle_show_threads(), handle_show_version_files(), handle_showagi(), handle_showchan(), handle_showfeatures(), handle_showmanager(), handle_showmanagers(), handle_showmancmd(), handle_showmancmds(), handle_showmanconn(), handle_showmaneventq(), handle_shutdown_when_convenient(), handle_softhangup(), handle_unload(), handle_verbose(), handle_version(), help1(), help_workhorse(), iax2_do_debug(), iax2_do_jb_debug(), iax2_do_trunk_debug(), iax2_no_debug(), iax2_no_jb_debug(), iax2_no_trunk_debug(), iax2_prov_cmd(), iax2_prune_realtime(), iax2_set_mtu(), iax2_show_cache(), iax2_show_channels(), iax2_show_firmware(), iax2_show_netstats(), iax2_show_peer(), iax2_show_registry(), iax2_show_stats(), iax2_show_threads(), iax2_show_users(), iax_show_provisioning(), locals_show(), mgcp_audit_endpoint(), mgcp_do_debug(), mgcp_no_debug(), mgcp_show_endpoints(), misdn_reload(), misdn_send_cd(), misdn_send_digit(), misdn_send_display(), misdn_set_debug(), misdn_show_cls(), misdn_show_config(), misdn_show_port(), misdn_show_ports_stats(), misdn_show_stacks(), misdn_toggle_echocancel(), modlist_modentry(), moh_classes_show(), moh_cli(), odbc_show_command(), orig_app(), orig_exten(), print_bc_info(), print_codec_to_cli(), print_group(), print_uptimestr(), realtime_pgsql_status(), rtcp_do_debug(), rtcp_do_debug_ip(), rtcp_do_stats(), rtcp_no_debug(), rtcp_no_stats(), rtp_do_debug(), rtp_do_debug_ip(), rtp_no_debug(), show_channeltype(), show_channeltypes(), show_codec_n(), show_codecs(), show_config_description(), show_dialplan_helper(), show_file_formats(), show_image_formats(), show_keys(), show_license(), show_translation(), show_warranty(), sip_do_debug(), sip_do_debug_device(), sip_do_debug_ip(), sip_do_debug_peer(), sip_do_history(), sip_listconfighelper(), sip_listconfigs(), sip_no_debug(), sip_no_history(), sip_notify(), sip_options_print(), sip_show_channel(), sip_show_domains(), sip_show_history(), sip_show_inuse(), sip_show_objects(), sip_show_registry(), sip_show_settings(), sip_show_user(), sip_show_users(), skinny_do_debug(), skinny_no_debug(), skinny_show_devices(), skinny_show_lines(), stun_do_debug(), stun_no_debug(), udptl_do_debug(), udptl_do_debug_ip(), udptl_nodebug(), and zap_show_status(). { int res; struct ast_str *buf; va_list ap; if (!(buf = ast_str_thread_get(&ast_cli_buf, AST_CLI_INITLEN))) return; va_start(ap, fmt); res = ast_str_set_va(&buf, 0, fmt, ap); va_end(ap); if (res != AST_DYNSTR_BUILD_FAILED) ast_carefulwrite(fd, buf->str, strlen(buf->str), 100); }

int ast_cli_command (  int  fd, const char *  s )

Interprets a command Interpret a command s, sending output to fd Returns 0 on succes, -1 on failure. Definition at line 1682 of file cli.c. References ast_cli_entry::_deprecated_by, ast_cli_entry::_full_cmd, ast_cli(), AST_LIST_LOCK, AST_LIST_UNLOCK, AST_MAX_ARGS, CLI_HANDLER, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::deprecated, ast_cli_args::fd, find_best(), find_cli(), free, ast_cli_entry::handler, ast_cli_entry::inuse, ast_cli_entry::new_handler, parse_args(), RESULT_FAILURE, RESULT_SHOWUSAGE, RESULT_SUCCESS, S_OR, and ast_cli_entry::usage. Referenced by action_command(), cli_activate(), consolehandler(), and exit_completely(). { char *args[AST_MAX_ARGS + 1]; struct ast_cli_entry *e; int x; int res; char *dup = parse_args(s, &x, args + 1, AST_MAX_ARGS, NULL); if (dup == NULL) return -1; if (x < 1) /* We need at least one entry, otherwise ignore */ goto done; AST_LIST_LOCK(&helpers); e = find_cli(args + 1, 0); if (e) ast_atomic_fetchadd_int(&e->inuse, 1); AST_LIST_UNLOCK(&helpers); if (e == NULL) { ast_cli(fd, "No such command '%s' (type 'help' for help)\n", find_best(args + 1)); 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 (!e->new_handler) /* old style */ res = e->handler(fd, x, args + 1); else { struct ast_cli_args a = { .fd = fd, .argc = x, .argv = args+1 }; char *retval = e->new_handler(e, CLI_HANDLER, &a); if (retval == CLI_SUCCESS) res = RESULT_SUCCESS; else if (retval == CLI_SHOWUSAGE) res = RESULT_SHOWUSAGE; else res = RESULT_FAILURE; } switch (res) { case RESULT_SHOWUSAGE: ast_cli(fd, "%s", S_OR(e->usage, "Invalid usage, but no usage information available.\n")); break; case RESULT_FAILURE: ast_cli(fd, "Command '%s' failed.\n", s); /* FALLTHROUGH */ default: AST_LIST_LOCK(&helpers); if (e->deprecated == 1) { ast_cli(fd, "The '%s' command is deprecated and will be removed in a future release. Please use '%s' instead.\n", e->_full_cmd, e->_deprecated_by); e->deprecated = 2; } AST_LIST_UNLOCK(&helpers); break; } ast_atomic_fetchadd_int(&e->inuse, -1); done: free(dup); return 0; }

char* ast_cli_complete (  const char *  word, 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 char *choices = { "one", "two", "three", NULL }; if (pos == 2) return ast_cli_complete(word, choices, n); else return NULL; } Definition at line 858 of file cli.c. References ast_strdup, ast_strlen_zero(), and len. Referenced by complete_orig(), and complete_show_applications(). { 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) return ast_strdup(choices[i]); } return NULL; }

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. 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, followe by a NULL. All strings and the array itself are malloc'ed and must be freed by the caller. Definition at line 1535 of file cli.c. References ast_cli_generator(), and ast_realloc. Referenced by cli_complete(), and handle_commandmatchesarray(). { char **match_list = NULL, *retstr, *prevstr; size_t match_list_len, max_equal, which, i; int matches = 0; /* leave entry 0 free for the longest common substring */ match_list_len = 1; while ((retstr = ast_cli_generator(text, word, matches)) != NULL) { if (matches + 1 >= match_list_len) { match_list_len <<= 1; if (!(match_list = ast_realloc(match_list, match_list_len * sizeof(*match_list)))) return NULL; } match_list[++matches] = retstr; } if (!match_list) return match_list; /* NULL */ /* Find the longest substring that is common to all results * (it is a candidate for completion), and store a copy in entry 0. */ prevstr = match_list[1]; max_equal = strlen(prevstr); for (which = 2; which <= matches; which++) { for (i = 0; i < max_equal && toupper(prevstr[i]) == toupper(match_list[which][i]); i++) continue; max_equal = i; } if (!(retstr = ast_malloc(max_equal + 1))) return NULL; ast_copy_string(retstr, match_list[1], max_equal + 1); match_list[0] = retstr; /* ensure that the array is NULL terminated */ if (matches + 1 >= match_list_len) { if (!(match_list = ast_realloc(match_list, (match_list_len + 1) * sizeof(*match_list)))) return NULL; } match_list[matches + 1] = NULL; return match_list; }

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

Readline madness Useful for readline, that's about it Returns 0 on success, -1 on failure. Definition at line 1677 of file cli.c. References __ast_cli_generator(). Referenced by ast_cli_completion_matches(), and ast_cli_generatornummatches(). { return __ast_cli_generator(text, word, state, 1); }

int ast_cli_generatornummatches (  const char *  text, const char *  word )

Return the number of unique matches for the generator. Definition at line 1518 of file cli.c. References ast_cli_generator(), and free. Referenced by handle_commandnummatches(). { int matches = 0, i = 0; char *buf = NULL, *oldbuf = NULL; while ((buf = ast_cli_generator(text, word, i++))) { if (!oldbuf || strcmp(buf,oldbuf)) matches++; if (oldbuf) free(oldbuf); oldbuf = buf; } if (oldbuf) free(oldbuf); return matches; }

int ast_cli_register (  struct ast_cli_entry *  e  )

Registers a command or an array of commands. Parameters: e  which cli entry to register Register your own command Returns 0 on success, -1 on failure Definition at line 1349 of file cli.c. References __ast_cli_register(). Referenced by ast_cdr_engine_init(), ast_cli_register_multiple(), dnsmgr_init(), do_reload(), and load_module(). { return __ast_cli_register(e, NULL); }

void ast_cli_register_multiple (  struct ast_cli_entry *  e, int  len )

Register multiple commands. Parameters: e  pointer to first cli entry to register len  number of entries to register Definition at line 1357 of file cli.c. References ast_cli_register(). Referenced by __ast_register_translator(), ast_builtins_init(), ast_channels_init(), ast_file_init(), ast_http_init(), ast_image_init(), ast_rtp_init(), ast_udptl_init(), astdb_init(), crypto_init(), iax_provision_init(), init_framer(), init_logger(), init_manager(), load_module(), load_pbx(), register_config_cli(), and sip_cli_and_manager_commands_register(). { int i; for (i = 0; i < len; i++) ast_cli_register(e + i); }

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 1343 of file cli.c. References __ast_cli_unregister(). Referenced by ast_cli_unregister_multiple(), do_reload(), load_module(), and unload_module(). { return __ast_cli_unregister(e, NULL); }

void 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 Definition at line 1365 of file cli.c. References ast_cli_unregister(). Referenced by __unload_module(), iax_provision_unload(), load_module(), sip_cli_and_manager_commands_unregister(), and unload_module(). { int i; for (i = 0; i < len; i++) ast_cli_unregister(e + i); }

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 870 of file cli.c. References ast_channel_unlock, ast_channel_walk_locked(), and ast_strdup. Referenced by complete_ch_3(), complete_ch_4(), and handle_core_set_debug_channel(). { struct ast_channel *c = NULL; int which = 0; int wordlen; char notfound = '\0'; char *ret = &notfound; /* so NULL can break the loop */ if (pos != rpos) return NULL; wordlen = strlen(word); while (ret == &notfound && (c = ast_channel_walk_locked(c))) { if (!strncasecmp(word, c->name, wordlen) && ++which > state) ret = ast_strdup(c->name); ast_channel_unlock(c); } return ret == &notfound ? NULL : ret; }

static AST_LIST_HEAD_STATIC (  helpers  , ast_cli_entry  )  [static]

AST_MUTEX_DEFINE_STATIC (  climodentrylock   )

AST_THREADSTORAGE (  ast_cli_buf   )

static struct ast_cli_entry* cli_next (  struct cli_iterator *  i  )  [static]

Definition at line 1070 of file cli.c. References ast_cli_entry::_full_cmd, AST_LIST_FIRST, AST_LIST_NEXT, builtins, cli_iterator::builtins, ast_cli_entry::cmda, and cli_iterator::helpers. Referenced by __ast_cli_generator(), find_cli(), and help1(). { struct ast_cli_entry *e; if (i->builtins == NULL && i->helpers == NULL) { /* initialize */ i->builtins = builtins; i->helpers = AST_LIST_FIRST(&helpers); } e = i->builtins; /* temporary */ if (!e->cmda[0] || (i->helpers && strcmp(i->helpers->_full_cmd, e->_full_cmd) < 0)) { /* Use helpers */ e = i->helpers; if (e) i->helpers = AST_LIST_NEXT(e, list); } else { /* use builtin. e is already set */ (i->builtins)++; /* move to next */ } return e; }

static char* complete_ch_3 (  const char *  line, const char *  word, int  pos, int  state )  [static]

Definition at line 891 of file cli.c. References ast_complete_channels(). { return ast_complete_channels(line, word, pos, state, 2); }

static char* complete_ch_4 (  const char *  line, const char *  word, int  pos, int  state )  [static]

Definition at line 896 of file cli.c. References ast_complete_channels(). { return ast_complete_channels(line, word, pos, state, 3); }

static char* complete_fn (  const char *  word, int  state )  [static]

Definition at line 92 of file cli.c. References ast_config_AST_MODULE_DIR, and strdup. Referenced by handle_load(). { char *c; char filename[256]; if (word[0] == '/') ast_copy_string(filename, word, sizeof(filename)); else snprintf(filename, sizeof(filename), "%s/%s", ast_config_AST_MODULE_DIR, word); /* XXX the following function is not reentrant, so we better not use it */ c = filename_completion_function(filename, state); if (c && word[0] != '/') c += (strlen(ast_config_AST_MODULE_DIR) + 1); return c ? strdup(c) : c; }

static char* find_best (  char *  argv[]  )  [static]

Definition at line 1223 of file cli.c. References AST_LIST_LOCK, AST_MAX_CMD_LEN, find_cli(), and cli_iterator::helpers. Referenced by ast_cli_command(). { static char cmdline[80]; int x; /* See how close we get, then print the candidate */ char *myargv[AST_MAX_CMD_LEN]; for (x=0;x<AST_MAX_CMD_LEN;x++) myargv[x]=NULL; AST_LIST_LOCK(&helpers); for (x=0;argv[x];x++) { myargv[x] = argv[x]; if (!find_cli(myargv, -1)) break; } AST_LIST_UNLOCK(&helpers); ast_join(cmdline, sizeof(cmdline), myargv); return cmdline; }

static struct ast_cli_entry* find_cli (  char *const   cmds[], int  match_type )  [static]

locate a cli command in the 'helpers' list (which must be locked). exact has 3 values: 0 returns if the search key is equal or longer than the entry. note that trailing optional arguments are skipped. -1 true if the mismatch is on the last word XXX not true! 1 true only on complete, exact match. The search compares word by word taking care of regexps in e->cmda Definition at line 1179 of file cli.c. References ast_strlen_zero(), cli_next(), and word_match(). Referenced by ast_cli_command(), find_best(), and handle_help(). { int matchlen = -1; /* length of longest match so far */ struct ast_cli_entry *cand = NULL, *e=NULL; struct cli_iterator i = { NULL, NULL}; while ( (e = cli_next(&i)) ) { /* word-by word regexp comparison */ char * const *src = cmds; char * const *dst = e->cmda; int n = 0; for (;; dst++, src += n) { n = word_match(*src, *dst); if (n < 0) break; } if (ast_strlen_zero(*dst) || ((*dst)[0] == '[' && ast_strlen_zero(dst[1]))) { /* no more words in 'e' */ if (ast_strlen_zero(*src)) /* exact match, cannot do better */ break; /* Here, cmds has more words than the entry 'e' */ if (match_type != 0) /* but we look for almost exact match... */ continue; /* so we skip this one. */ /* otherwise we like it (case 0) */ } else { /* still words in 'e' */ if (ast_strlen_zero(*src)) continue; /* cmds is shorter than 'e', not good */ /* Here we have leftover words in cmds and 'e', * but there is a mismatch. We only accept this one if match_type == -1 * and this is the last word for both. */ if (match_type != -1 || !ast_strlen_zero(src[1]) || !ast_strlen_zero(dst[1])) /* not the one we look for */ continue; /* good, we are in case match_type == -1 and mismatch on last word */ } if (src - cmds > matchlen) { /* remember the candidate */ matchlen = src - cmds; cand = e; } } return e ? e : cand; }

static int group_show_channels (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 901 of file cli.c. References ast_channel_unlock, ast_channel_walk_locked(), ast_cli(), AST_LIST_TRAVERSE, ast_var_name(), ast_var_value(), ESS, FORMAT_STRING, GROUP_CATEGORY_PREFIX, RESULT_SHOWUSAGE, RESULT_SUCCESS, and ast_channel::varshead. { #define FORMAT_STRING "%-25s %-20s %-20s\n" struct ast_channel *c = NULL; int numchans = 0; struct ast_var_t *current; struct varshead *headp; regex_t regexbuf; int havepattern = 0; if (argc < 3 || argc > 4) return RESULT_SHOWUSAGE; if (argc == 4) { if (regcomp(&regexbuf, argv[3], REG_EXTENDED | REG_NOSUB)) return RESULT_SHOWUSAGE; havepattern = 1; } ast_cli(fd, FORMAT_STRING, "Channel", "Group", "Category"); while ( (c = ast_channel_walk_locked(c)) != NULL) { headp=&c->varshead; AST_LIST_TRAVERSE(headp,current,entries) { if (!strncmp(ast_var_name(current), GROUP_CATEGORY_PREFIX "_", strlen(GROUP_CATEGORY_PREFIX) + 1)) { if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) { ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), (ast_var_name(current) + strlen(GROUP_CATEGORY_PREFIX) + 1)); numchans++; } } else if (!strcmp(ast_var_name(current), GROUP_CATEGORY_PREFIX)) { if (!havepattern || !regexec(&regexbuf, ast_var_value(current), 0, NULL, 0)) { ast_cli(fd, FORMAT_STRING, c->name, ast_var_value(current), "(default)"); numchans++; } } } numchans++; ast_channel_unlock(c); } if (havepattern) regfree(&regexbuf); ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans)); return RESULT_SUCCESS; #undef FORMAT_STRING }

static char* handle_chanlist (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 452 of file cli.c. References ast_channel::_state, ast_channel::amaflags, ast_channel::appl, ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_active_calls(), ast_bridged_channel(), ast_channel_unlock, ast_channel_walk_locked(), ast_cli(), ast_state2str(), ast_strlen_zero(), ast_channel::cdr, ast_channel::cid, ast_callerid::cid_num, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, CONCISE_FORMAT_STRING, ast_channel::context, ast_channel::data, ESS, ast_channel::exten, ast_cli_args::fd, FORMAT_STRING, FORMAT_STRING2, option_maxcalls, ast_channel::priority, S_OR, ast_cdr::start, ast_cli_entry::usage, VERBOSE_FORMAT_STRING, and VERBOSE_FORMAT_STRING2. { #define FORMAT_STRING "%-20.20s %-20.20s %-7.7s %-30.30s\n" #define FORMAT_STRING2 "%-20.20s %-20.20s %-7.7s %-30.30s\n" #define CONCISE_FORMAT_STRING "%s!%s!%s!%d!%s!%s!%s!%s!%s!%d!%s!%s\n" #define VERBOSE_FORMAT_STRING "%-20.20s %-20.20s %-16.16s %4d %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n" #define VERBOSE_FORMAT_STRING2 "%-20.20s %-20.20s %-16.16s %-4.4s %-7.7s %-12.12s %-25.25s %-15.15s %8.8s %-11.11s %-20.20s\n" struct ast_channel *c = NULL; int numchans = 0, concise = 0, verbose = 0, count = 0; int fd, argc; char **argv; switch (cmd) { case CLI_INIT: e->command = "core show channels [concise|verbose|count]"; e->usage = "Usage: core show channels [concise|verbose|count]\n" " Lists currently defined channels and some information about them. If\n" " 'concise' is specified, the format is abridged and in a more easily\n" " machine parsable format. If 'verbose' is specified, the output includes\n" " more and longer fields. If 'count' is specified only the channel and call\n" " count is output.\n"; return NULL; case CLI_GENERATE: return NULL; } fd = a->fd; argc = a->argc; argv = a->argv; if (a->argc == e->args) { if (!strcasecmp(argv[e->args-1],"concise")) concise = 1; else if (!strcasecmp(argv[e->args-1],"verbose")) verbose = 1; else if (!strcasecmp(argv[e->args-1],"count")) count = 1; else return CLI_SHOWUSAGE; } else if (a->argc != e->args - 1) return CLI_SHOWUSAGE; if (!count) { if (!concise && !verbose) ast_cli(fd, FORMAT_STRING2, "Channel", "Location", "State", "Application(Data)"); else if (verbose) ast_cli(fd, VERBOSE_FORMAT_STRING2, "Channel", "Context", "Extension", "Priority", "State", "Application", "Data", "CallerID", "Duration", "Accountcode", "BridgedTo"); } while ((c = ast_channel_walk_locked(c)) != NULL) { struct ast_channel *bc = ast_bridged_channel(c); char durbuf[10] = "-"; if (!count) { if ((concise || verbose) && c->cdr && !ast_tvzero(c->cdr->start)) { int duration = (int)(ast_tvdiff_ms(ast_tvnow(), c->cdr->start) / 1000); if (verbose) { int durh = duration / 3600; int durm = (duration % 3600) / 60; int durs = duration % 60; snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs); } else { snprintf(durbuf, sizeof(durbuf), "%d", duration); } } if (concise) { ast_cli(fd, CONCISE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state), c->appl ? c->appl : "(None)", S_OR(c->data, ""), /* XXX different from verbose ? */ S_OR(c->cid.cid_num, ""), S_OR(c->accountcode, ""), c->amaflags, durbuf, bc ? bc->name : "(None)"); } else if (verbose) { ast_cli(fd, VERBOSE_FORMAT_STRING, c->name, c->context, c->exten, c->priority, ast_state2str(c->_state), c->appl ? c->appl : "(None)", c->data ? S_OR(c->data, "(Empty)" ): "(None)", S_OR(c->cid.cid_num, ""), durbuf, S_OR(c->accountcode, ""), bc ? bc->name : "(None)"); } else { char locbuf[40] = "(None)"; char appdata[40] = "(None)"; if (!ast_strlen_zero(c->context) && !ast_strlen_zero(c->exten)) snprintf(locbuf, sizeof(locbuf), "%s@%s:%d", c->exten, c->context, c->priority); if (c->appl) snprintf(appdata, sizeof(appdata), "%s(%s)", c->appl, S_OR(c->data, "")); ast_cli(fd, FORMAT_STRING, c->name, locbuf, ast_state2str(c->_state), appdata); } } numchans++; ast_channel_unlock(c); } if (!concise) { ast_cli(fd, "%d active channel%s\n", numchans, ESS(numchans)); if (option_maxcalls) ast_cli(fd, "%d of %d max active call%s (%5.2f%% of capacity)\n", ast_active_calls(), option_maxcalls, ESS(ast_active_calls()), ((double)ast_active_calls() / (double)option_maxcalls) * 100.0); else ast_cli(fd, "%d active call%s\n", ast_active_calls(), ESS(ast_active_calls())); } return CLI_SUCCESS; #undef FORMAT_STRING #undef FORMAT_STRING2 #undef CONCISE_FORMAT_STRING #undef VERBOSE_FORMAT_STRING #undef VERBOSE_FORMAT_STRING2 }

static int handle_commandcomplete (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 662 of file cli.c. References __ast_cli_generator(), ast_cli(), free, RESULT_SHOWUSAGE, and RESULT_SUCCESS. { char *buf; if (argc != 5) return RESULT_SHOWUSAGE; buf = __ast_cli_generator(argv[2], argv[3], atoi(argv[4]), 0); if (buf) { ast_cli(fd, buf); free(buf); } else ast_cli(fd, "NULL\n"); return RESULT_SUCCESS; }

static int handle_commandmatchesarray (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 605 of file cli.c. References ast_cli_completion_matches(), ast_malloc, ast_realloc, free, len, RESULT_FAILURE, and RESULT_SHOWUSAGE. { char *buf, *obuf; int buflen = 2048; int len = 0; char **matches; int x, matchlen; if (argc != 4) return RESULT_SHOWUSAGE; if (!(buf = ast_malloc(buflen))) return RESULT_FAILURE; buf[len] = '\0'; matches = ast_cli_completion_matches(argv[2], argv[3]); if (matches) { for (x=0; matches[x]; x++) { matchlen = strlen(matches[x]) + 1; if (len + matchlen >= buflen) { buflen += matchlen * 3; obuf = buf; if (!(buf = ast_realloc(obuf, buflen))) /* Memory allocation failure... Just free old buffer and be done */ free(obuf); } if (buf) len += sprintf( buf + len, "%s ", matches[x]); free(matches[x]); matches[x] = NULL; } free(matches); } if (buf) { ast_cli(fd, "%s%s",buf, AST_CLI_COMPLETE_EOF); free(buf); } else ast_cli(fd, "NULL\n"); return RESULT_SUCCESS; }

static int handle_commandnummatches (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 648 of file cli.c. References ast_cli(), ast_cli_generatornummatches(), RESULT_SHOWUSAGE, and RESULT_SUCCESS. { int matches = 0; if (argc != 4) return RESULT_SHOWUSAGE; matches = ast_cli_generatornummatches(argv[2], argv[3]); ast_cli(fd, "%d", matches); return RESULT_SUCCESS; }

static char* handle_core_set_debug_channel (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 677 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_channel_unlock, ast_channel_walk_locked(), ast_cli(), ast_complete_channels(), ast_get_channel_by_name_locked(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, DEBUGCHAN_FLAG, ast_cli_args::fd, ast_channel::fin, ast_channel::fout, global_fin, global_fout, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, RESULT_SUCCESS, strdup, ast_cli_entry::usage, and ast_cli_args::word. Referenced by handle_debugchan_deprecated(), and handle_nodebugchan_deprecated(). { struct ast_channel *c = NULL; int is_all, is_off = 0; switch (cmd) { case CLI_INIT: e->command = "core set debug channel"; e->usage = "Usage: core set debug channel <all|channel> [off]\n" " 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 ? strdup("all") : ast_complete_channels(a->line, a->word, a->pos, a->n - 1, e->args); } /* 'core set debug channel {all|chan_id}' */ if (a->argc == e->args + 2) { if (!strcasecmp(a->argv[e->args + 1], "off")) is_off = 1; else return CLI_SHOWUSAGE; } else if (a->argc != e->args + 1) return CLI_SHOWUSAGE; is_all = !strcasecmp("all", a->argv[e->args]); if (is_all) { if (is_off) { global_fin &= ~DEBUGCHAN_FLAG; global_fout &= ~DEBUGCHAN_FLAG; } else { global_fin |= DEBUGCHAN_FLAG; global_fout |= DEBUGCHAN_FLAG; } c = ast_channel_walk_locked(NULL); } else { c = ast_get_channel_by_name_locked(a->argv[e->args]); if (c == NULL) ast_cli(a->fd, "No such channel %s\n", a->argv[e->args]); } while (c) { if (!(c->fin & DEBUGCHAN_FLAG) || !(c->fout & DEBUGCHAN_FLAG)) { if (is_off) { c->fin &= ~DEBUGCHAN_FLAG; c->fout &= ~DEBUGCHAN_FLAG; } else { c->fin |= DEBUGCHAN_FLAG; c->fout |= DEBUGCHAN_FLAG; } ast_cli(a->fd, "Debugging %s on channel %s\n", is_off ? "disabled" : "enabled", c->name); } ast_channel_unlock(c); if (!is_all) break; c = ast_channel_walk_locked(c); } ast_cli(a->fd, "Debugging on new channels is %s\n", is_off ? "disabled" : "enabled"); return RESULT_SUCCESS; }

static char* handle_debugchan_deprecated (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 740 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, CLI_HANDLER, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, and handle_core_set_debug_channel(). { char *res; if (cmd == CLI_HANDLER && a->argc != e->args + 1) return CLI_SHOWUSAGE; res = handle_core_set_debug_channel(e, cmd, a); if (cmd == CLI_INIT) e->command = "debug channel"; return res; }

static char * handle_help (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 1412 of file cli.c. References __ast_cli_generator(), ast_cli_args::argc, ast_cli_args::argv, ast_cli(), ast_join(), AST_LIST_LOCK, AST_LIST_UNLOCK, CLI_GENERATE, CLI_INIT, ast_cli_entry::command, ast_cli_args::fd, find_cli(), help1(), ast_cli_args::line, ast_cli_args::n, RESULT_SUCCESS, ast_cli_entry::usage, and ast_cli_args::word. { char fullcmd[80]; struct ast_cli_entry *my_e; if (cmd == CLI_INIT) { e->command = "help"; e->usage = "Usage: help [topic]\n" " When called with a topic as an argument, displays usage\n" " information on the given command. If called without a\n" " topic, it provides a list of commands.\n"; return NULL; } else if (cmd == CLI_GENERATE) { /* skip first 4 or 5 chars, "help " */ int l = strlen(a->line); if (l > 5) l = 5; /* XXX watch out, should stop to the non-generator parts */ return __ast_cli_generator(a->line + l, a->word, a->n, 0); } if (a->argc == 1) return help1(a->fd, NULL, 0); AST_LIST_LOCK(&helpers); my_e = find_cli(a->argv + 1, 1); /* try exact match first */ if (!my_e) return help1(a->fd, a->argv + 1, 1 /* locked */); if (my_e->usage) ast_cli(a->fd, "%s", my_e->usage); else { ast_join(fullcmd, sizeof(fullcmd), a->argv+1); ast_cli(a->fd, "No help text available for '%s'.\n", fullcmd); } AST_LIST_UNLOCK(&helpers); return RESULT_SUCCESS; }

static char* handle_load (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 111 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_cli(), ast_load_resource(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_fn(), ast_cli_args::fd, ast_cli_args::n, ast_cli_args::pos, ast_cli_entry::usage, and ast_cli_args::word. Referenced by handle_load_deprecated(). { /* "module load <mod>" */ switch (cmd) { case CLI_INIT: e->command = "module load"; e->usage = "Usage: module load <module name>\n" " Loads the specified module into Asterisk.\n"; return NULL; case CLI_GENERATE: if (a->pos != e->args) return NULL; return complete_fn(a->word, a->n); } if (a->argc != e->args + 1) return CLI_SHOWUSAGE; if (ast_load_resource(a->argv[e->args])) { ast_cli(a->fd, "Unable to load module %s\n", a->argv[e->args]); return CLI_FAILURE; } return CLI_SUCCESS; }

static char* handle_load_deprecated (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 136 of file cli.c. References CLI_INIT, ast_cli_entry::command, and handle_load(). { char *res = handle_load(e, cmd, a); if (cmd == CLI_INIT) e->command = "load"; return res; }

static int handle_logger_mute (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 251 of file cli.c. References ast_console_toggle_mute(), RESULT_SHOWUSAGE, and RESULT_SUCCESS. { if (argc != 2) return RESULT_SHOWUSAGE; ast_console_toggle_mute(fd); return RESULT_SUCCESS; }

static char* handle_modlist (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 413 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_cli(), ast_module_helper(), ast_mutex_lock(), ast_mutex_unlock(), ast_update_module_list(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, climodentryfd, ast_cli_entry::command, ast_cli_args::fd, ast_cli_args::line, MODLIST_FORMAT2, modlist_modentry(), ast_cli_args::n, ast_cli_args::pos, RESULT_SUCCESS, ast_cli_entry::usage, and ast_cli_args::word. { char *like; switch (cmd) { case CLI_INIT: e->command = "module show [like]"; e->usage = "Usage: module show [like keyword]\n" " Shows Asterisk modules currently in use, and usage statistics.\n"; return NULL; case CLI_GENERATE: if (a->pos == e->args) return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0); else return NULL; } /* all the above return, so we proceed with the handler. * we are guaranteed to have argc >= e->args */ if (a->argc == e->args - 1) like = ""; else if (a->argc == e->args + 1 && !strcasecmp(a->argv[e->args-1], "like") ) like = a->argv[e->args]; else return CLI_SHOWUSAGE; ast_mutex_lock(&climodentrylock); climodentryfd = a->fd; /* global, protected by climodentrylock */ ast_cli(a->fd, MODLIST_FORMAT2, "Module", "Description", "Use Count"); ast_cli(a->fd,"%d modules loaded\n", ast_update_module_list(modlist_modentry, like)); climodentryfd = -1; ast_mutex_unlock(&climodentrylock); return RESULT_SUCCESS; }

static char* handle_nodebugchan_deprecated (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 752 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, CLI_HANDLER, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, and handle_core_set_debug_channel(). { char *res; if (cmd == CLI_HANDLER) { if (a->argc != e->args + 1) return CLI_SHOWUSAGE; /* pretend we have an extra "off" at the end. We can do this as the array * is NULL terminated so we overwrite that entry. */ a->argv[e->args+1] = "off"; a->argc++; } res = handle_core_set_debug_channel(e, cmd, a); if (cmd == CLI_INIT) e->command = "no debug channel"; return res; }

static char* handle_reload (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 144 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_cli(), ast_module_helper(), ast_module_reload(), CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, ast_cli_entry::usage, and ast_cli_args::word. Referenced by handle_reload_deprecated(). { int x; switch (cmd) { case CLI_INIT: e->command = "module reload"; e->usage = "Usage: module reload [module ...]\n" " Reloads configuration files for all listed modules which support\n" " reloading, or for all supported modules if none are listed.\n"; return NULL; case CLI_GENERATE: return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 1); } if (a->argc == e->args) { ast_module_reload(NULL); return CLI_SUCCESS; } for (x = e->args; x < a->argc; x++) { int res = ast_module_reload(a->argv[x]); /* XXX reload has multiple error returns, including -1 on error and 2 on success */ switch (res) { case 0: ast_cli(a->fd, "No such module '%s'\n", a->argv[x]); break; case 1: ast_cli(a->fd, "Module '%s' does not support reload\n", a->argv[x]); break; } } return CLI_SUCCESS; }

static char* handle_reload_deprecated (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 179 of file cli.c. References CLI_INIT, ast_cli_entry::command, handle_reload(), and s. { char *s = handle_reload(e, cmd, a); if (cmd == CLI_INIT) /* override command name */ e->command = "reload"; return s; }

static int handle_showchan (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 770 of file cli.c. References ast_channel::_bridge, ast_channel::_state, ast_bridged_channel(), ast_cdr_serialize_variables(), ast_channel_unlock, ast_cli(), AST_FLAG_BLOCKING, ast_get_channel_by_name_locked(), ast_getformatname_multiple(), ast_state2str(), ast_str_alloca, ast_test_flag, ast_channel::cdr, ast_channel::cid, ast_callerid::cid_dnid, ast_callerid::cid_name, ast_callerid::cid_num, DEBUGCHAN_FLAG, ast_channel::fds, ast_channel::fin, ast_channel::fout, name, ast_channel::nativeformats, pbx_builtin_serialize_variables(), ast_channel::readformat, ast_channel::readtrans, RESULT_SHOWUSAGE, RESULT_SUCCESS, ast_channel::rings, S_OR, ast_cdr::start, ast_str::str, ast_channel::tech, ast_channel_tech::type, ast_channel::whentohangup, ast_channel::writeformat, and ast_channel::writetrans. { struct ast_channel *c=NULL; struct timeval now; struct ast_str *out = ast_str_alloca(2048); char cdrtime[256]; char nf[256], wf[256], rf[256]; long elapsed_seconds=0; int hour=0, min=0, sec=0; if (argc != 4) return RESULT_SHOWUSAGE; now = ast_tvnow(); c = ast_get_channel_by_name_locked(argv[3]); if (!c) { ast_cli(fd, "%s is not a known channel\n", argv[3]); return RESULT_SUCCESS; } if (c->cdr) { elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec; hour = elapsed_seconds / 3600; min = (elapsed_seconds % 3600) / 60; sec = elapsed_seconds % 60; snprintf(cdrtime, sizeof(cdrtime), "%dh%dm%ds", hour, min, sec); } else strcpy(cdrtime, "N/A"); ast_cli(fd, " -- General --\n" " Name: %s\n" " Type: %s\n" " UniqueID: %s\n" " Caller ID: %s\n" " Caller ID Name: %s\n" " DNID Digits: %s\n" " State: %s (%d)\n" " Rings: %d\n" " NativeFormats: %s\n" " WriteFormat: %s\n" " ReadFormat: %s\n" " WriteTranscode: %s\n" " ReadTranscode: %s\n" "1st File Descriptor: %d\n" " Frames in: %d%s\n" " Frames out: %d%s\n" " Time to Hangup: %ld\n" " Elapsed Time: %s\n" " Direct Bridge: %s\n" "Indirect Bridge: %s\n" " -- PBX --\n" " Context: %s\n" " Extension: %s\n" " Priority: %d\n" " Call Group: %llu\n" " Pickup Group: %llu\n" " Application: %s\n" " Data: %s\n" " Blocking in: %s\n", c->name, c->tech->type, c->uniqueid, S_OR(c->cid.cid_num, "(N/A)"), S_OR(c->cid.cid_name, "(N/A)"), S_OR(c->cid.cid_dnid, "(N/A)"), ast_state2str(c->_state), c->_state, c->rings, ast_getformatname_multiple(nf, sizeof(nf), c->nativeformats), ast_getformatname_multiple(wf, sizeof(wf), c->writeformat), ast_getformatname_multiple(rf, sizeof(rf), c->readformat), c->writetrans ? "Yes" : "No", c->readtrans ? "Yes" : "No", c->fds[0], c->fin & ~DEBUGCHAN_FLAG, (c->fin & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "", c->fout & ~DEBUGCHAN_FLAG, (c->fout & DEBUGCHAN_FLAG) ? " (DEBUGGED)" : "", (long)c->whentohangup, cdrtime, c->_bridge ? c->_bridge->name : "<none>", ast_bridged_channel(c) ? ast_bridged_channel(c)->name : "<none>", c->context, c->exten, c->priority, c->callgroup, c->pickupgroup, ( c->appl ? c->appl : "(N/A)" ), ( c-> data ? S_OR(c->data, "(Empty)") : "(None)"), (ast_test_flag(c, AST_FLAG_BLOCKING) ? c->blockproc : "(Not Blocking)")); if (pbx_builtin_serialize_variables(c, &out)) ast_cli(fd," Variables:\n%s\n", out->str); if (c->cdr && ast_cdr_serialize_variables(c->cdr, &out, '=', '\n', 1)) ast_cli(fd," CDR Variables:\n%s\n", out->str); ast_channel_unlock(c); return RESULT_SUCCESS; }

static char* handle_showuptime (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 381 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_lastreloadtime, ast_startuptime, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ast_cli_args::fd, ast_cli_args::n, ast_cli_args::pos, print_uptimestr(), and ast_cli_entry::usage. { time_t curtime; int printsec; switch (cmd) { case CLI_INIT: e->command = "core show uptime"; e->usage = "Usage: core show uptime [seconds]\n" " Shows Asterisk uptime information.\n" " The seconds word returns the uptime in seconds only.\n"; return NULL; case CLI_GENERATE: return (a->pos > e->args || a->n > 0) ? NULL : "seconds"; } /* regular handler */ if (a->argc == e->args+1 && !strcasecmp(a->argv[e->args],"seconds")) printsec = 1; else if (a->argc == e->args) printsec = 0; else return CLI_SHOWUSAGE; curtime = time(NULL); if (ast_startuptime) print_uptimestr(a->fd, curtime - ast_startuptime, "System uptime", printsec); if (ast_lastreloadtime) print_uptimestr(a->fd, curtime - ast_lastreloadtime, "Last reload", printsec); return CLI_SUCCESS; }

static int handle_softhangup (  int  fd, int  argc, char *  argv[] )  [static]

Definition at line 588 of file cli.c. References ast_channel_unlock, ast_cli(), ast_get_channel_by_name_locked(), ast_softhangup(), AST_SOFTHANGUP_EXPLICIT, RESULT_SHOWUSAGE, and RESULT_SUCCESS. { struct ast_channel *c=NULL; if (argc != 3) return RESULT_SHOWUSAGE; c = ast_get_channel_by_name_locked(argv[2]); if (c) { ast_cli(fd, "Requested Hangup on channel '%s'\n", c->name); ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT); ast_channel_unlock(c); } else ast_cli(fd, "%s is not a known channel\n", argv[2]); return RESULT_SUCCESS; }

static char* handle_unload (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 259 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_cli(), AST_FORCE_FIRM, AST_FORCE_HARD, AST_FORCE_SOFT, ast_module_helper(), ast_unload_resource(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, ast_cli_entry::command, ast_cli_args::fd, ast_cli_args::line, ast_cli_args::n, ast_cli_args::pos, s, ast_cli_entry::usage, and ast_cli_args::word. Referenced by handle_unload_deprecated(). { /* "module unload mod_1 [mod_2 .. mod_N]" */ int x; int force = AST_FORCE_SOFT; char *s; switch (cmd) { case CLI_INIT: e->command = "module unload"; e->usage = "Usage: module unload [-f|-h] <module_1> [<module_2> ... ]\n" " Unloads the specified module from Asterisk. The -f\n" " option causes the module to be unloaded even if it is\n" " in use (may cause a crash) and the -h module causes the\n" " module to be unloaded even if the module says it cannot, \n" " which almost always will cause a crash.\n"; return NULL; case CLI_GENERATE: return ast_module_helper(a->line, a->word, a->pos, a->n, a->pos, 0); } if (a->argc < e->args + 1) return CLI_SHOWUSAGE; x = e->args; /* first argument */ s = a->argv[x]; if (s[0] == '-') { if (s[1] == 'f') force = AST_FORCE_FIRM; else if (s[1] == 'h') force = AST_FORCE_HARD; else return CLI_SHOWUSAGE; if (a->argc < e->args + 2) /* need at least one module name */ return CLI_SHOWUSAGE; x++; /* skip this argument */ } for (; x < a->argc; x++) { if (ast_unload_resource(a->argv[x], force)) { ast_cli(a->fd, "Unable to unload resource %s\n", a->argv[x]); return CLI_FAILURE; } } return CLI_SUCCESS; }

static char* handle_unload_deprecated (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 306 of file cli.c. References CLI_INIT, ast_cli_entry::command, and handle_unload(). { char *res = handle_unload(e, cmd, a); if (cmd == CLI_INIT) e->command = "unload"; /* XXX override */ return res; }

static char* handle_verbose (  struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a )  [static]

Definition at line 187 of file cli.c. References ast_cli_args::argc, ast_cli_entry::args, ast_cli_args::argv, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ast_cli_args::fd, option_debug, option_verbose, and ast_cli_entry::usage. { int oldval = option_verbose; int newlevel; int atleast = 0; int fd = a->fd; int argc = a->argc; char **argv = a->argv; int *dst; char *what; switch (cmd) { case CLI_INIT: e->command = "core set {debug|verbose} [off|atleast]"; e->usage = "Usage: core set {debug|verbose} [atleast] <level>\n" " core set {debug|verbose} off\n" " Sets level of debug or verbose messages to be displayed.\n" " 0 or off means no messages should be displayed.\n" " Equivalent to -d[d[...]] or -v[v[v...]] on startup\n"; return NULL; case CLI_GENERATE: return NULL; } /* all the above return, so we proceed with the handler. * we are guaranteed to be called with argc >= e->args; */ if (argc < e->args) return CLI_SHOWUSAGE; if (!strcasecmp(argv[e->args - 2], "debug")) { dst = &option_debug; what = "Core debug"; } else { dst = &option_verbose; what = "Verbosity"; } if (argc == e->args && !strcasecmp(argv[e->args - 1], "off")) { newlevel = 0; goto done; } if (!strcasecmp(argv[e->args-1], "atleast")) atleast = 1; if (argc != e->args + atleast) return CLI_SHOWUSAGE; if (sscanf(argv[e->args + atleast - 1], "%d", &newlevel) != 1) return CLI_SHOWUSAGE; done: if (!atleast || newlevel > *dst) *dst = newlevel; if (oldval > 0 && *dst == 0) ast_cli(fd, "%s is now OFF\n", what); else if (*dst > 0) { if (oldval == *dst) ast_cli(fd, "%s is at least %d\n", what, *dst); else ast_cli(fd, "%s was %d and is now %d\n", what, oldval, *dst); } return CLI_SUCCESS; }

static char* help1 (  int  fd, char *  match[], int  locked )  [static]

helper for final part of handle_help. if locked = 0 it's just "help_workhorse", otherwise assume the list is already locked and print an error message if not found. Definition at line 1379 of file cli.c. References ast_cli_entry::_full_cmd, ast_cli(), ast_join(), AST_LIST_LOCK, AST_LIST_UNLOCK, cli_next(), CLI_SUCCESS, ast_cli_entry::deprecated, cli_iterator::helpers, S_OR, and ast_cli_entry::summary. Referenced by handle_help(). { char matchstr[80] = ""; struct ast_cli_entry *e; int len = 0; int found = 0; struct cli_iterator i = { NULL, NULL}; if (match) { ast_join(matchstr, sizeof(matchstr), match); len = strlen(matchstr); } if (!locked) AST_LIST_LOCK(&helpers); while ( (e = cli_next(&i)) ) { /* Hide commands that start with '_' */ if (e->_full_cmd[0] == '_') continue; /* Hide commands that are marked as deprecated. */ if (e->deprecated) continue; if (match && strncasecmp(matchstr, e->_full_cmd, len)) continue; ast_cli(fd, "%30.30s %s\n", e->_full_cmd, S_OR(e->summary, "<no description available>")); found++; } if (!locked) AST_LIST_UNLOCK(&helpers); if (!locked && !found && matchstr[0]) ast_cli(fd, "No such command '%s'.\n", matchstr); return CLI_SUCCESS; }

static char* is_prefix (  const char *  word, const char *  token, int  pos, int *  actual )  [static]

if word is a valid prefix for token, returns the pos-th match as a malloced string, or NULL otherwise. Always tell in *actual how many matches we got. Definition at line 1132 of file cli.c. References ast_strdupa, ast_strlen_zero(), cli_rsvd, s, strdup, and strsep(). Referenced by __ast_cli_generator(). { int lw; char *s, *t1; *actual = 0; if (ast_strlen_zero(token)) return NULL; if (ast_strlen_zero(word)) word = ""; /* dummy */ lw = strlen(word); if (strcspn(word, cli_rsvd) != lw) return NULL; /* no match if word has reserved chars */ if (strchr(cli_rsvd, token[0]) == NULL) { /* regular match */ if (strncasecmp(token, word, lw)) /* no match */ return NULL; *actual = 1; return (pos != 0) ? NULL : strdup(token); } /* now handle regexp match */ /* Wildcard always matches, so we never do is_prefix on them */ t1 = ast_strdupa(token + 1); /* copy, skipping first char */ while (pos >= 0 && (s = strsep(&t1, cli_rsvd)) && *s) { if (*s == '%') /* wildcard */ continue; if (strncasecmp(s, word, lw)) /* no match */ continue; (*actual)++; if (pos-- == 0) return strdup(s); } return NULL; }

static int modlist_modentry (  const char *  module, const char *  description, int  usecnt, const char *  like )  [static]

Definition at line 320 of file cli.c. References ast_cli(), climodentryfd, MODLIST_FORMAT, and strcasestr(). Referenced by handle_modlist(). { /* Comparing the like with the module */ if (strcasestr(module, like) ) { ast_cli(climodentryfd, MODLIST_FORMAT, module, description, usecnt); return 1; } return 0; }

static int more_words (  char *const *  dst  )  [static]

returns true if there are more words to match Definition at line 1583 of file cli.c. Referenced by __ast_cli_generator(). { int i; for (i = 0; dst[i]; i++) { if (dst[i][0] != '[') return -1; } return 0; }

static char* parse_args (  const char *  s, int *  argc, char *  argv[], int  max, int *  trailingwhitespace )  [static]

Definition at line 1452 of file cli.c. References ast_log(), ast_strdup, and LOG_WARNING. Referenced by __ast_cli_generator(), agi_handle_command(), and ast_cli_command(). { char *dup, *cur; int x = 0; int quoted = 0; int escaped = 0; int whitespace = 1; int dummy = 0; if (trailingwhitespace == NULL) trailingwhitespace = &dummy; *trailingwhitespace = 0; if (s == NULL) /* invalid, though! */ return NULL; /* make a copy to store the parsed string */ if (!(dup = ast_strdup(s))) return NULL; cur = dup; /* scan the original string copying into cur when needed */ for (; *s ; s++) { if (x >= max - 1) { ast_log(LOG_WARNING, "Too many arguments, truncating at %s\n", s); break; } if (*s == '"' && !escaped) { quoted = !quoted; if (quoted && whitespace) { /* start a quoted string from previous whitespace: new argument */ argv[x++] = cur; whitespace = 0; } } else if ((*s == ' ' || *s == '\t') && !(quoted || escaped)) { /* If we are not already in whitespace, and not in a quoted string or processing an escape sequence, and just entered whitespace, then finalize the previous argument and remember that we are in whitespace */ if (!whitespace) { *cur++ = '\0'; whitespace = 1; } } else if (*s == '\\' && !escaped) { escaped = 1; } else { if (whitespace) { /* we leave whitespace, and are not quoted. So it's a new argument */ argv[x++] = cur; whitespace = 0; } *cur++ = *s; escaped = 0; } } /* Null terminate */ *cur++ = '\0'; /* XXX put a NULL in the last argument, because some functions that take * the array may want a null-terminated array. * argc still reflects the number of non-NULL entries. */ argv[x] = NULL; *argc = x; *trailingwhitespace = whitespace; return dup; }

static void print_uptimestr (  int  fd, time_t  timeval, const char *  prefix, int  printsec )  [static]

Definition at line 330 of file cli.c. References ast_cli(), ast_str_alloca, ast_str_append(), DAY, ESS, HOUR, MINUTE, NEEDCOMMA, ast_str::str, ast_str::used, WEEK, and YEAR. Referenced by handle_showuptime(). { int x; /* the main part - years, weeks, etc. */ struct ast_str *out; #define SECOND (1) #define MINUTE (SECOND*60) #define HOUR (MINUTE*60) #define DAY (HOUR*24) #define WEEK (DAY*7) #define YEAR (DAY*365) #define NEEDCOMMA(x) ((x)? ",": "") /* define if we need a comma */ if (timeval < 0) /* invalid, nothing to show */ return; if (printsec) { /* plain seconds output */ ast_cli(fd, "%s: %lu\n", prefix, (u_long)timeval); return; } out = ast_str_alloca(256); if (timeval > YEAR) { x = (timeval / YEAR); timeval -= (x * YEAR); ast_str_append(&out, 0, "%d year%s%s ", x, ESS(x),NEEDCOMMA(timeval)); } if (timeval > WEEK) { x = (timeval / WEEK); timeval -= (x * WEEK); ast_str_append(&out, 0, "%d week%s%s ", x, ESS(x),NEEDCOMMA(timeval)); } if (timeval > DAY) { x = (timeval / DAY); timeval -= (x * DAY); ast_str_append(&out, 0, "%d day%s%s ", x, ESS(x),NEEDCOMMA(timeval)); } if (timeval > HOUR) { x = (timeval / HOUR); timeval -= (x * HOUR); ast_str_append(&out, 0, "%d hour%s%s ", x, ESS(x),NEEDCOMMA(timeval)); } if (timeval > MINUTE) { x = (timeval / MINUTE); timeval -= (x * MINUTE); ast_str_append(&out, 0, "%d minute%s%s ", x, ESS(x),NEEDCOMMA(timeval)); } x = timeval; if (x > 0 || out->used == 0) /* if there is nothing, print 0 seconds */ ast_str_append(&out, 0, "%d second%s ", x, ESS(x)); ast_cli(fd, "%s: %s\n", prefix, out->str); }

static int set_full_cmd (  struct ast_cli_entry *  e  )  [static]

initialize the _full_cmd string and related parameters, return 0 on success, -1 on error. Definition at line 1027 of file cli.c. References ast_cli_entry::_full_cmd, ast_cli_entry::args, ast_join(), ast_log(), cli_rsvd, ast_cli_entry::cmda, ast_cli_entry::cmdlen, LOG_WARNING, and strdup. Referenced by ast_builtins_init(). { int i; char buf[80]; ast_join(buf, sizeof(buf), e->cmda); e->_full_cmd = strdup(buf); if (!e->_full_cmd) { ast_log(LOG_WARNING, "-- cannot allocate <%s>\n", buf); return -1; } e->cmdlen = strcspn(e->_full_cmd, cli_rsvd); for (i = 0; e->cmda[i]; i++) ; e->args = i; return 0; }

static int word_match (  const char *  cmd, const char *  cli_word )  [static]

match a word in the CLI entry. returns -1 on mismatch, 0 on match of an optional word, 1 on match of a full word. The pattern can be any_word match for equal [foo|bar|baz] optionally, one of these words {foo|bar|baz} exactly, one of these words % any word Definition at line 1103 of file cli.c. References ast_strlen_zero(), cli_rsvd, and strcasestr(). Referenced by __ast_cli_generator(), and find_cli(). { int l; char *pos; if (ast_strlen_zero(cmd) || ast_strlen_zero(cli_word)) return -1; if (!strchr(cli_rsvd, cli_word[0])) /* normal match */ return (strcasecmp(cmd, cli_word) == 0) ? 1 : -1; /* regexp match, takes [foo|bar] or {foo|bar} */ l = strlen(cmd); /* wildcard match - will extend in the future */ if (l > 0 && cli_word[0] == '%') { return 1; /* wildcard */ } pos = strcasestr(cli_word, cmd); if (pos == NULL) /* not found, say ok if optional */ return cli_word[0] == '[' ? 0 : -1; if (pos == cli_word) /* no valid match at the beginning */ return -1; if (strchr(cli_rsvd, pos[-1]) && strchr(cli_rsvd, pos[l])) return 1; /* valid match */ return -1; /* not found */ }

---

Variable Documentation

struct ast_cli_entry builtins[] [static]

Definition at line 954 of file cli.c. Referenced by ast_builtins_init(), cli_next(), and load_pbx().

struct ast_cli_entry cli_cli[] [static]

Definition at line 978 of file cli.c. Referenced by ast_builtins_init().

struct ast_cli_entry cli_debug_channel_deprecated = NEW_CLI(handle_debugchan_deprecated, "Enable debugging on channel") [static]

Definition at line 971 of file cli.c.

struct ast_cli_entry cli_module_load_deprecated = NEW_CLI(handle_load_deprecated, "Load a module") [static]

Definition at line 972 of file cli.c.

struct ast_cli_entry cli_module_reload_deprecated = NEW_CLI(handle_reload_deprecated, "reload modules by name") [static]

Definition at line 973 of file cli.c.

struct ast_cli_entry cli_module_unload_deprecated = NEW_CLI(handle_unload_deprecated, "unload modules by name") [static]

Definition at line 974 of file cli.c.

const char cli_rsvd[] = "[]{}|*%" [static]

Some regexp characters in cli arguments are reserved and used as separators. Definition at line 1021 of file cli.c. Referenced by is_prefix(), set_full_cmd(), and word_match().

int climodentryfd = -1 [static]

Definition at line 318 of file cli.c. Referenced by handle_modlist(), and modlist_modentry().

const char commandcomplete_help[] [static]

Initial value: "Usage: _command complete \"<line>\" text state\n" " This function is used internally to help with command completion and should.\n" " never be called by the user directly.\n" Definition at line 573 of file cli.c.

const char commandmatchesarray_help[] [static]

Initial value: "Usage: _command matchesarray \"<line>\" text \n" " This function is used internally to help with command completion and should.\n" " never be called by the user directly.\n" Definition at line 583 of file cli.c.

const char commandnummatches_help[] [static]

Initial value: "Usage: _command nummatches \"<line>\" text \n" " This function is used internally to help with command completion and should.\n" " never be called by the user directly.\n" Definition at line 578 of file cli.c.

const char group_show_channels_help[] [static]

Initial value: "Usage: group show channels [pattern]\n" " Lists all currently active channels with channel group(s) specified.\n" " Optional regular expression pattern is matched to group names for each\n" " channel.\n" Definition at line 86 of file cli.c.

const char logger_mute_help[] [static]

Initial value: "Usage: logger mute\n" " Disables logging output to the current console, making it possible to\n" " gather information without being disturbed by scrolling lines.\n" Definition at line 76 of file cli.c.

const char showchan_help[] [static]

Initial value: "Usage: core show channel <channel>\n" " Shows lots of information about the specified channel.\n" Definition at line 569 of file cli.c.

const char softhangup_help[] [static]

Initial value: "Usage: soft hangup <channel>\n" " Request that a channel be hung up. The hangup takes effect\n" " the next time the driver reads or writes from the channel\n" Definition at line 81 of file cli.c.

---

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen