Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:02:06 2007

Asterisk developer's documentation :: Codename Pineapple

---

AMI functions

Data Structures
struct	ast_manager_user
	user descriptor, as read from the config file. More...
struct	eventqent
struct	fast_originate_helper
struct	mansession
struct	permalias
Defines
#define	ASTMAN_APPEND_BUF_INITSIZE   256
#define	MANAGER_EVENT_BUF_INITSIZE   256
#define	MSG_MOREDATA   ((char *)astman_send_response)
	send a response with an optional message, and terminate it with an empty line. m is used only to grab the 'ActionID' field.
#define	NEW_EVENT(m)   (AST_LIST_NEXT(m->last_ev, eq_next))
Functions
int	__manager_event (int category, const char *event, const char *file, int line, const char *func, const char *fmt,...)
	manager_event: Send AMI event to client
static int	action_challenge (struct mansession *s, const struct message *m)
static int	action_command (struct mansession *s, const struct message *m)
	Manager command "command" - execute CLI command.
static int	action_events (struct mansession *s, const struct message *m)
static int	action_extensionstate (struct mansession *s, const struct message *m)
static int	action_getconfig (struct mansession *s, const struct message *m)
static int	action_getvar (struct mansession *s, const struct message *m)
static int	action_hangup (struct mansession *s, const struct message *m)
static int	action_listcommands (struct mansession *s, const struct message *m)
static int	action_login (struct mansession *s, const struct message *m)
static int	action_logoff (struct mansession *s, const struct message *m)
static int	action_mailboxcount (struct mansession *s, const struct message *m)
static int	action_mailboxstatus (struct mansession *s, const struct message *m)
static int	action_originate (struct mansession *s, const struct message *m)
static int	action_ping (struct mansession *s, const struct message *m)
static int	action_redirect (struct mansession *s, const struct message *m)
	action_redirect: The redirect manager command
static int	action_sendtext (struct mansession *s, const struct message *m)
static int	action_setvar (struct mansession *s, const struct message *m)
static int	action_status (struct mansession *s, const struct message *m)
	Manager "status" command to show channels.
static int	action_timeout (struct mansession *s, const struct message *m)
static int	action_updateconfig (struct mansession *s, const struct message *m)
static int	action_userevent (struct mansession *s, const struct message *m)
static int	action_waitevent (struct mansession *s, const struct message *m)
static int	append_event (const char *str, int category)
static int	ast_instring (const char *bigstr, const char *smallstr, const char delim)
static	AST_LIST_HEAD_STATIC (users, ast_manager_user)
	list of users found in the config file
static	AST_LIST_HEAD_STATIC (sessions, mansession)
static	AST_LIST_HEAD_STATIC (all_events, eventqent)
int	ast_manager_register2 (const char *action, int auth, int(*func)(struct mansession *s, const struct message *m), const char *synopsis, const char *description)
	register a new command with manager, including online help. This is the preferred way to register a manager command
void	ast_manager_register_hook (struct manager_custom_hook *hook)
	Add a custom hook to be called when an event is fired.
static int	ast_manager_register_struct (struct manager_action *act)
int	ast_manager_unregister (char *action)
void	ast_manager_unregister_hook (struct manager_custom_hook *hook)
	Delete a custom hook to be called when an event is fired.
static	AST_RWLIST_HEAD_STATIC (manager_hooks, manager_custom_hook)
	AST_RWLOCK_DEFINE_STATIC (actionlock)
	AST_THREADSTORAGE (manager_event_buf)
	AST_THREADSTORAGE (astman_append_buf)
void	astman_append (struct mansession *s, const char *fmt,...)
const char *	astman_get_header (const struct message *m, char *var)
ast_variable *	astman_get_variables (const struct message *m)
void	astman_send_ack (struct mansession *s, const struct message *m, char *msg)
void	astman_send_error (struct mansession *s, const struct message *m, char *error)
void	astman_send_listack (struct mansession *s, const struct message *m, char *msg, char *listflag)
void	astman_send_response (struct mansession *s, const struct message *m, char *resp, char *msg)
static void	astman_send_response_full (struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
static void	astman_start_ack (struct mansession *s, const struct message *m)
static int	authenticate (struct mansession *s, const struct message *m)
static char *	authority_to_str (int authority, struct ast_str **res)
	Convert authority code to a list of options.
static char *	complete_show_mancmd (const char *line, const char *word, int pos, int state)
static void	destroy_session (struct mansession *s)
static int	do_message (struct mansession *s)
static void *	fast_originate (void *data)
static void	free_session (struct mansession *s)
static int	get_input (struct mansession *s, char *output)
static struct ast_manager_user *	get_manager_by_name_locked (const char *name)
static int	get_perm (const char *instr)
static struct eventqent *	grab_last (void)
	Event list management functions. We assume that the event list always has at least one element, and the delete code will not remove the last entry even if the.
static int	handle_mandebug (int fd, int argc, char *argv[])
static int	handle_showmanager (int fd, int argc, char *argv[])
static int	handle_showmanagers (int fd, int argc, char *argv[])
static int	handle_showmancmd (int fd, int argc, char *argv[])
static int	handle_showmancmds (int fd, int argc, char *argv[])
	CLI command manager list commands.
static int	handle_showmanconn (int fd, int argc, char *argv[])
	CLI command manager list connected.
static int	handle_showmaneventq (int fd, int argc, char *argv[])
	CLI command manager list eventq.
static void	handle_updates (struct mansession *s, const struct message *m, struct ast_config *cfg)
static int	manager_state_cb (char *context, char *exten, int state, void *data)
static int	process_events (struct mansession *s)
static int	process_message (struct mansession *s, const struct message *m)
static void	purge_events (void)
static void	purge_sessions (int n_max)
	remove at most n_max stale session from the list.
static void	ref_event (struct eventqent *e)
static int	send_string (struct mansession *s, char *string)
static void *	session_do (void *data)
	The body of the individual manager session. Call get_input() to read one line at a time (or be woken up on new events), collect the lines in a message until found an empty line, and execute the request. In any case, deliver events asynchronously through process_events() (called from here if no line is available, or at the end of process_message(). ).
static int	set_eventmask (struct mansession *s, const char *eventmask)
	Rather than braindead on,off this now can also accept a specific int mask value or a ',' delim list of mask strings (the same as manager.conf) -anthm.
static int	strings_to_mask (const char *string)
static struct eventqent *	unref_event (struct eventqent *e)
Variables
static int	block_sockets
static struct ast_cli_entry	cli_manager []
static int	displayconnects = 1
static struct manager_action *	first_action
	list of actions registered
static int	httptimeout = 60
static int	manager_debug
static char	mandescr_command []
static char	mandescr_events []
static char	mandescr_extensionstate []
static char	mandescr_getconfig []
static char	mandescr_getvar []
static char	mandescr_hangup []
static char	mandescr_listcommands []
static char	mandescr_logoff []
static char	mandescr_mailboxcount []
static char	mandescr_mailboxstatus []
	Help text for manager command mailboxstatus.
static char	mandescr_originate []
static char	mandescr_ping []
	Manager PING.
static char	mandescr_redirect []
static char	mandescr_sendtext []
static char	mandescr_setvar []
static char	mandescr_timeout []
static char	mandescr_updateconfig []
static char	mandescr_userevent []
static char	mandescr_waitevent []
	Manager WAITEVENT.
static int	num_sessions
static struct permalias	perms []
static char	showmanager_help []
static char	showmanagers_help []
static char	showmancmd_help []
static char	showmancmds_help []
static char	showmanconn_help []
static char	showmaneventq_help []
static int	timestampevents

---

Define Documentation

#define ASTMAN_APPEND_BUF_INITSIZE   256

Definition at line 756 of file manager.c. Referenced by astman_append().

#define MANAGER_EVENT_BUF_INITSIZE   256

Definition at line 2318 of file manager.c. Referenced by __manager_event().

#define MSG_MOREDATA   ((char *)astman_send_response)

send a response with an optional message, and terminate it with an empty line. m is used only to grab the 'ActionID' field. Use the explicit constant MSG_MOREDATA to remove the empty line. XXX MSG_MOREDATA should go to a header file. Definition at line 795 of file manager.c. Referenced by astman_send_response_full(), and astman_start_ack().

#define NEW_EVENT (  m   )     (AST_LIST_NEXT(m->last_ev, eq_next))

Definition at line 151 of file manager.c. Referenced by action_waitevent(), and process_events().

---

Function Documentation

int __manager_event (  int  category, const char *  event, const char *  file, int  line, const char *  func, const char *  fmt,   ... )

manager_event: Send AMI event to client Definition at line 2321 of file manager.c. References append_event(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), AST_PTHREADT_NULL, AST_RWLIST_EMPTY, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_str_alloca, ast_str_append(), ast_str_append_va, authority_to_str(), manager_custom_hook::helper, manager_debug, MANAGER_EVENT_BUF_INITSIZE, num_sessions, s, seq, sessions, ast_str::str, and timestampevents. { struct mansession *s; struct manager_custom_hook *hook; struct ast_str *auth = ast_str_alloca(80); const char *cat_str; va_list ap; struct timeval now; struct ast_str *buf; /* Abort if there aren't any manager sessions */ if (!num_sessions) return 0; if (!(buf = ast_str_thread_get(&manager_event_buf, MANAGER_EVENT_BUF_INITSIZE))) return -1; cat_str = authority_to_str(category, &auth); ast_str_set(&buf, 0, "Event: %s\r\nPrivilege: %s\r\n", event, cat_str); if (timestampevents) { now = ast_tvnow(); ast_str_append(&buf, 0, "Timestamp: %ld.%06lu\r\n", now.tv_sec, (unsigned long) now.tv_usec); } if (manager_debug) { static int seq; ast_str_append(&buf, 0, "SequenceNumber: %d\r\n", ast_atomic_fetchadd_int(&seq, 1)); ast_str_append(&buf, 0, "File: %s\r\nLine: %d\r\nFunc: %s\r\n", file, line, func); } va_start(ap, fmt); ast_str_append_va(&buf, 0, fmt, ap); va_end(ap); ast_str_append(&buf, 0, "\r\n"); append_event(buf->str, category); /* Wake up any sleeping sessions */ AST_LIST_LOCK(&sessions); AST_LIST_TRAVERSE(&sessions, s, list) { ast_mutex_lock(&s->__lock); if (s->waiting_thread != AST_PTHREADT_NULL) pthread_kill(s->waiting_thread, SIGURG); ast_mutex_unlock(&s->__lock); } AST_LIST_UNLOCK(&sessions); AST_RWLIST_RDLOCK(&manager_hooks); if (!AST_RWLIST_EMPTY(&manager_hooks)) { AST_RWLIST_TRAVERSE(&manager_hooks, hook, list) { hook->helper(category, event, buf->str); } } AST_RWLIST_UNLOCK(&manager_hooks); return 0; }

static int action_challenge (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1326 of file manager.c. References ast_mutex_lock(), ast_mutex_unlock(), ast_random(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), and s. Referenced by init_manager(). { const char *authtype = astman_get_header(m, "AuthType"); if (!strcasecmp(authtype, "MD5")) { if (ast_strlen_zero(s->challenge)) snprintf(s->challenge, sizeof(s->challenge), "%ld", ast_random()); ast_mutex_lock(&s->__lock); astman_start_ack(s, m); astman_append(s, "Challenge: %s\r\n\r\n", s->challenge); ast_mutex_unlock(&s->__lock); } else { astman_send_error(s, m, "Must specify AuthType"); } return 0; }

static int action_command (  struct mansession *  s, const struct message *  m )  [static]

Manager command "command" - execute CLI command. Definition at line 1653 of file manager.c. References ast_cli_command(), ast_strlen_zero(), astman_append(), astman_get_header(), and s. Referenced by init_manager(). { const char *cmd = astman_get_header(m, "Command"); const char *id = astman_get_header(m, "ActionID"); char *buf; char template[] = "/tmp/ast-ami-XXXXXX"; /* template for temporary file */ int fd = mkstemp(template); off_t l; astman_append(s, "Response: Follows\r\nPrivilege: Command\r\n"); if (!ast_strlen_zero(id)) astman_append(s, "ActionID: %s\r\n", id); /* FIXME: Wedge a ActionID response in here, waiting for later changes */ ast_cli_command(fd, cmd); /* XXX need to change this to use a FILE * */ l = lseek(fd, 0, SEEK_END); /* how many chars available */ buf = alloca(l+1); lseek(fd, 0, SEEK_SET); read(fd, buf, l); buf[l] = '\0'; close(fd); unlink(template); astman_append(s, buf); astman_append(s, "--END COMMAND--\r\n\r\n"); return 0; }

static int action_events (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1284 of file manager.c. References astman_get_header(), astman_send_response(), s, and set_eventmask(). Referenced by init_manager(). { const char *mask = astman_get_header(m, "EventMask"); int res; res = set_eventmask(s, mask); if (res > 0) astman_send_response(s, m, "Events On", NULL); else if (res == 0) astman_send_response(s, m, "Events Off", NULL); return 0; }

static int action_extensionstate (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1935 of file manager.c. References ast_extension_state(), ast_get_hint(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), context, exten, and s. Referenced by init_manager(). { const char *exten = astman_get_header(m, "Exten"); const char *context = astman_get_header(m, "Context"); char hint[256] = ""; int status; if (ast_strlen_zero(exten)) { astman_send_error(s, m, "Extension not specified"); return 0; } if (ast_strlen_zero(context)) context = "default"; status = ast_extension_state(NULL, context, exten); ast_get_hint(hint, sizeof(hint) - 1, NULL, 0, NULL, context, exten); astman_start_ack(s, m); astman_append(s, "Message: Extension Status\r\n" "Exten: %s\r\n" "Context: %s\r\n" "Hint: %s\r\n" "Status: %d\r\n\r\n", exten, context, hint, status); return 0; }

static int action_getconfig (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1019 of file manager.c. References ast_category_browse(), ast_config_destroy(), ast_config_load_with_comments(), ast_strlen_zero(), ast_variable_browse(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), lineno, ast_variable::name, ast_variable::next, s, and ast_variable::value. Referenced by init_manager(). { struct ast_config *cfg; const char *fn = astman_get_header(m, "Filename"); int catcount = 0; int lineno = 0; char *category=NULL; struct ast_variable *v; if (ast_strlen_zero(fn)) { astman_send_error(s, m, "Filename not specified"); return 0; } if (!(cfg = ast_config_load_with_comments(fn))) { astman_send_error(s, m, "Config file not found"); return 0; } astman_start_ack(s, m); while ((category = ast_category_browse(cfg, category))) { lineno = 0; astman_append(s, "Category-%06d: %s\r\n", catcount, category); for (v = ast_variable_browse(cfg, category); v; v = v->next) astman_append(s, "Line-%06d-%06d: %s=%s\r\n", catcount, lineno++, v->name, v->value); catcount++; } ast_config_destroy(cfg); astman_append(s, "\r\n"); return 0; }

static int action_getvar (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1416 of file manager.c. References ast_channel_unlock, ast_func_read(), ast_get_channel_by_name_locked(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), name, pbx_retrieve_variable(), and s. Referenced by init_manager(). { struct ast_channel *c = NULL; const char *name = astman_get_header(m, "Channel"); const char *varname = astman_get_header(m, "Variable"); char *varval; char workspace[1024]; if (ast_strlen_zero(varname)) { astman_send_error(s, m, "No variable specified"); return 0; } if (!ast_strlen_zero(name)) { c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } } if (varname[strlen(varname) - 1] == ')') { ast_func_read(c, (char *) varname, workspace, sizeof(workspace)); } else { pbx_retrieve_variable(c, varname, &varval, workspace, sizeof(workspace), NULL); } if (c) ast_channel_unlock(c); astman_start_ack(s, m); astman_append(s, "Variable: %s\r\nValue: %s\r\n\r\n", varname, varval); return 0; }

static int action_hangup (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1348 of file manager.c. References ast_channel_unlock, ast_get_channel_by_name_locked(), ast_softhangup(), AST_SOFTHANGUP_EXPLICIT, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), name, and s. Referenced by init_manager(). { struct ast_channel *c = NULL; const char *name = astman_get_header(m, "Channel"); if (ast_strlen_zero(name)) { astman_send_error(s, m, "No channel specified"); return 0; } c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } ast_softhangup(c, AST_SOFTHANGUP_EXPLICIT); ast_channel_unlock(c); astman_send_ack(s, m, "Channel Hungup"); return 0; }

static int action_listcommands (  struct mansession *  s, const struct message *  m )  [static]

Note: The actionlock is read-locked by the caller of this function Definition at line 1260 of file manager.c. References manager_action::action, ast_str_alloca, astman_append(), astman_start_ack(), manager_action::authority, authority_to_str(), first_action, manager_action::next, s, and manager_action::synopsis. Referenced by init_manager(). { struct manager_action *cur; struct ast_str *temp = ast_str_alloca(BUFSIZ); /* XXX very large ? */ astman_start_ack(s, m); for (cur = first_action; cur; cur = cur->next) { /* Walk the list of actions */ if ((s->writeperm & cur->authority) == cur->authority) astman_append(s, "%s: %s (Priv: %s)\r\n", cur->action, cur->synopsis, authority_to_str(cur->authority, &temp)); } astman_append(s, "\r\n"); return 0; }

static int action_login (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1308 of file manager.c. References ast_inet_ntoa(), ast_log(), ast_verbose(), astman_send_ack(), astman_send_error(), authenticate(), displayconnects, LOG_EVENT, option_verbose, s, and VERBOSE_PREFIX_2. Referenced by init_manager(). { if (authenticate(s, m)) { sleep(1); astman_send_error(s, m, "Authentication failed"); return -1; } s->authenticated = 1; if (option_verbose > 1) { if (displayconnects) { ast_verbose(VERBOSE_PREFIX_2 "%sManager '%s' logged on from %s\n", (s->managerid ? "HTTP " : ""), s->username, ast_inet_ntoa(s->sin.sin_addr)); } } ast_log(LOG_EVENT, "%sManager '%s' logged on from %s\n", (s->managerid ? "HTTP " : ""), s->username, ast_inet_ntoa(s->sin.sin_addr)); astman_send_ack(s, m, "Authentication accepted"); return 0; }

static int action_logoff (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1302 of file manager.c. References astman_send_response(), and s. Referenced by init_manager(). { astman_send_response(s, m, "Goodbye", "Thanks for all the fish."); return -1; }

static int action_mailboxcount (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1904 of file manager.c. References ast_app_inboxcount(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), mailbox, and s. Referenced by init_manager(). { const char *mailbox = astman_get_header(m, "Mailbox"); int newmsgs = 0, oldmsgs = 0; if (ast_strlen_zero(mailbox)) { astman_send_error(s, m, "Mailbox not specified"); return 0; } ast_app_inboxcount(mailbox, &newmsgs, &oldmsgs); astman_start_ack(s, m); astman_append(s, "Message: Mailbox Message Count\r\n" "Mailbox: %s\r\n" "NewMessages: %d\r\n" "OldMessages: %d\r\n" "\r\n", mailbox, newmsgs, oldmsgs); return 0; }

static int action_mailboxstatus (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1876 of file manager.c. References ast_app_has_voicemail(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), mailbox, and s. Referenced by init_manager(). { const char *mailbox = astman_get_header(m, "Mailbox"); int ret; if (ast_strlen_zero(mailbox)) { astman_send_error(s, m, "Mailbox not specified"); return 0; } ret = ast_app_has_voicemail(mailbox, NULL); astman_start_ack(s, m); astman_append(s, "Message: Mailbox Status\r\n" "Mailbox: %s\r\n" "Waiting: %d\r\n\r\n", mailbox, ret); return 0; }

static int action_originate (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1758 of file manager.c. References app, ast_callerid_parse(), ast_calloc, ast_findlabel_extension(), AST_FORMAT_SLINEAR, ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pthread_create, ast_shrink_phone_number(), ast_strlen_zero(), ast_true(), astman_get_header(), astman_get_variables(), astman_send_ack(), astman_send_error(), context, ast_channel::data, exten, fast_originate(), name, ast_channel::priority, s, and ast_channel::tech. Referenced by init_manager(). { const char *name = astman_get_header(m, "Channel"); const char *exten = astman_get_header(m, "Exten"); const char *context = astman_get_header(m, "Context"); const char *priority = astman_get_header(m, "Priority"); const char *timeout = astman_get_header(m, "Timeout"); const char *callerid = astman_get_header(m, "CallerID"); const char *account = astman_get_header(m, "Account"); const char *app = astman_get_header(m, "Application"); const char *appdata = astman_get_header(m, "Data"); const char *async = astman_get_header(m, "Async"); const char *id = astman_get_header(m, "ActionID"); struct ast_variable *vars = astman_get_variables(m); char *tech, *data; char *l = NULL, *n = NULL; int pi = 0; int res; int to = 30000; int reason = 0; char tmp[256]; char tmp2[256]; pthread_t th; pthread_attr_t attr; if (!name) { astman_send_error(s, m, "Channel not specified"); return 0; } if (!ast_strlen_zero(priority) && (sscanf(priority, "%d", &pi) != 1)) { if ((pi = ast_findlabel_extension(NULL, context, exten, priority, NULL)) < 1) { astman_send_error(s, m, "Invalid priority\n"); return 0; } } if (!ast_strlen_zero(timeout) && (sscanf(timeout, "%d", &to) != 1)) { astman_send_error(s, m, "Invalid timeout\n"); return 0; } ast_copy_string(tmp, name, sizeof(tmp)); tech = tmp; data = strchr(tmp, '/'); if (!data) { astman_send_error(s, m, "Invalid channel\n"); return 0; } *data++ = '\0'; ast_copy_string(tmp2, callerid, sizeof(tmp2)); ast_callerid_parse(tmp2, &n, &l); if (n) { if (ast_strlen_zero(n)) n = NULL; } if (l) { ast_shrink_phone_number(l); if (ast_strlen_zero(l)) l = NULL; } if (ast_true(async)) { struct fast_originate_helper *fast = ast_calloc(1, sizeof(*fast)); if (!fast) { res = -1; } else { if (!ast_strlen_zero(id)) snprintf(fast->idtext, sizeof(fast->idtext), "ActionID: %s\r\n", id); ast_copy_string(fast->tech, tech, sizeof(fast->tech)); ast_copy_string(fast->data, data, sizeof(fast->data)); ast_copy_string(fast->app, app, sizeof(fast->app)); ast_copy_string(fast->appdata, appdata, sizeof(fast->appdata)); if (l) ast_copy_string(fast->cid_num, l, sizeof(fast->cid_num)); if (n) ast_copy_string(fast->cid_name, n, sizeof(fast->cid_name)); fast->vars = vars; ast_copy_string(fast->context, context, sizeof(fast->context)); ast_copy_string(fast->exten, exten, sizeof(fast->exten)); ast_copy_string(fast->account, account, sizeof(fast->account)); fast->timeout = to; fast->priority = pi; pthread_attr_init(&attr); pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED); if (ast_pthread_create(&th, &attr, fast_originate, fast)) { res = -1; } else { res = 0; } pthread_attr_destroy(&attr); } } else if (!ast_strlen_zero(app)) { res = ast_pbx_outgoing_app(tech, AST_FORMAT_SLINEAR, data, to, app, appdata, &reason, 1, l, n, vars, account, NULL); } else { if (exten && context && pi) res = ast_pbx_outgoing_exten(tech, AST_FORMAT_SLINEAR, data, to, context, exten, pi, &reason, 1, l, n, vars, account, NULL); else { astman_send_error(s, m, "Originate with 'Exten' requires 'Context' and 'Priority'"); return 0; } } if (!res) astman_send_ack(s, m, "Originate successfully queued"); else astman_send_error(s, m, "Originate failed"); return 0; }

static int action_ping (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1007 of file manager.c. References astman_send_response(), and s. Referenced by init_manager(). { astman_send_response(s, m, "Pong", NULL); return 0; }

static int action_redirect (  struct mansession *  s, const struct message *  m )  [static]

action_redirect: The redirect manager command Definition at line 1593 of file manager.c. References ast_async_goto(), ast_channel_unlock, ast_findlabel_extension(), ast_get_channel_by_name_locked(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), context, exten, name, ast_channel::priority, and s. Referenced by init_manager(). { const char *name = astman_get_header(m, "Channel"); const char *name2 = astman_get_header(m, "ExtraChannel"); const char *exten = astman_get_header(m, "Exten"); const char *context = astman_get_header(m, "Context"); const char *priority = astman_get_header(m, "Priority"); struct ast_channel *chan, *chan2 = NULL; int pi = 0; int res; if (ast_strlen_zero(name)) { astman_send_error(s, m, "Channel not specified"); return 0; } if (!ast_strlen_zero(priority) && (sscanf(priority, "%d", &pi) != 1)) { if ((pi = ast_findlabel_extension(NULL, context, exten, priority, NULL)) < 1) { astman_send_error(s, m, "Invalid priority\n"); return 0; } } /* XXX watch out, possible deadlock - we are trying to get two channels!!! */ chan = ast_get_channel_by_name_locked(name); if (!chan) { char buf[BUFSIZ]; snprintf(buf, sizeof(buf), "Channel does not exist: %s", name); astman_send_error(s, m, buf); return 0; } if (!ast_strlen_zero(name2)) chan2 = ast_get_channel_by_name_locked(name2); res = ast_async_goto(chan, context, exten, pi); if (!res) { if (!ast_strlen_zero(name2)) { if (chan2) res = ast_async_goto(chan2, context, exten, pi); else res = -1; if (!res) astman_send_ack(s, m, "Dual Redirect successful"); else astman_send_error(s, m, "Secondary redirect failed"); } else astman_send_ack(s, m, "Redirect successful"); } else astman_send_error(s, m, "Redirect failed"); if (chan) ast_channel_unlock(chan); if (chan2) ast_channel_unlock(chan2); return 0; }

static int action_sendtext (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1548 of file manager.c. References ast_get_channel_by_name_locked(), ast_mutex_unlock(), ast_sendtext(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), ast_channel::lock, name, and s. Referenced by init_manager(). { struct ast_channel *c = NULL; const char *name = astman_get_header(m, "Channel"); const char *textmsg = astman_get_header(m, "Message"); int res = 0; if (ast_strlen_zero(name)) { astman_send_error(s, m, "No channel specified"); return 0; } if (ast_strlen_zero(textmsg)) { astman_send_error(s, m, "No Message specified"); return 0; } c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } res = ast_sendtext(c, textmsg); ast_mutex_unlock(&c->lock); if (res > 0) astman_send_ack(s, m, "Success"); else astman_send_error(s, m, "Failure"); return res; }

static int action_setvar (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1374 of file manager.c. References ast_channel_unlock, ast_get_channel_by_name_locked(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), name, pbx_builtin_setvar_helper(), and s. Referenced by init_manager(). { struct ast_channel *c = NULL; const char *name = astman_get_header(m, "Channel"); const char *varname = astman_get_header(m, "Variable"); const char *varval = astman_get_header(m, "Value"); if (ast_strlen_zero(varname)) { astman_send_error(s, m, "No variable specified"); return 0; } if (ast_strlen_zero(varval)) { astman_send_error(s, m, "No value specified"); return 0; } if (!ast_strlen_zero(name)) { c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } } pbx_builtin_setvar_helper(c, varname, varval); if (c) ast_channel_unlock(c); astman_send_ack(s, m, "Variable Set"); return 0; }

static int action_status (  struct mansession *  s, const struct message *  m )  [static]

Manager "status" command to show channels. Definition at line 1454 of file manager.c. References ast_channel::_bridge, ast_channel::_state, ast_channel_unlock, ast_channel_walk_locked(), ast_get_channel_by_name_locked(), ast_state2str(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_ack(), astman_send_error(), ast_channel::cdr, ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, ast_channel::context, ast_channel::exten, name, ast_channel::pbx, ast_channel::priority, s, S_OR, and ast_cdr::start. Referenced by init_manager(). { const char *name = astman_get_header(m,"Channel"); struct ast_channel *c; char bridge[256]; struct timeval now = ast_tvnow(); long elapsed_seconds = 0; int all = ast_strlen_zero(name); /* set if we want all channels */ const char *id = astman_get_header(m,"ActionID"); char idText[256] = ""; if (!ast_strlen_zero(id)) snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id); astman_send_ack(s, m, "Channel status will follow"); if (all) c = ast_channel_walk_locked(NULL); else { c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } } /* if we look by name, we break after the first iteration */ while (c) { if (c->_bridge) snprintf(bridge, sizeof(bridge), "Link: %s\r\n", c->_bridge->name); else bridge[0] = '\0'; if (c->pbx) { if (c->cdr) { elapsed_seconds = now.tv_sec - c->cdr->start.tv_sec; } astman_append(s, "Event: Status\r\n" "Privilege: Call\r\n" "Channel: %s\r\n" "CallerIDNum: %s\r\n" "CallerIDName: %s\r\n" "Account: %s\r\n" "State: %s\r\n" "Context: %s\r\n" "Extension: %s\r\n" "Priority: %d\r\n" "Seconds: %ld\r\n" "%s" "Uniqueid: %s\r\n" "%s" "\r\n", c->name, S_OR(c->cid.cid_num, "<unknown>"), S_OR(c->cid.cid_name, "<unknown>"), c->accountcode, ast_state2str(c->_state), c->context, c->exten, c->priority, (long)elapsed_seconds, bridge, c->uniqueid, idText); } else { astman_append(s, "Event: Status\r\n" "Privilege: Call\r\n" "Channel: %s\r\n" "CallerIDNum: %s\r\n" "CallerIDName: %s\r\n" "Account: %s\r\n" "State: %s\r\n" "%s" "Uniqueid: %s\r\n" "%s" "\r\n", c->name, S_OR(c->cid.cid_num, "<unknown>"), S_OR(c->cid.cid_name, "<unknown>"), c->accountcode, ast_state2str(c->_state), bridge, c->uniqueid, idText); } ast_channel_unlock(c); if (!all) break; c = ast_channel_walk_locked(c); } astman_append(s, "Event: StatusComplete\r\n" "%s" "\r\n",idText); return 0; }

static int action_timeout (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1966 of file manager.c. References ast_channel_setwhentohangup(), ast_channel_unlock, ast_get_channel_by_name_locked(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), name, and s. Referenced by init_manager(). { struct ast_channel *c; const char *name = astman_get_header(m, "Channel"); int timeout = atoi(astman_get_header(m, "Timeout")); if (ast_strlen_zero(name)) { astman_send_error(s, m, "No channel specified"); return 0; } if (!timeout) { astman_send_error(s, m, "No timeout specified"); return 0; } c = ast_get_channel_by_name_locked(name); if (!c) { astman_send_error(s, m, "No such channel"); return 0; } ast_channel_setwhentohangup(c, timeout); ast_channel_unlock(c); astman_send_ack(s, m, "Timeout Set"); return 0; }

static int action_updateconfig (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1119 of file manager.c. References ast_config_destroy(), ast_config_load_with_comments(), ast_module_reload(), ast_strlen_zero(), ast_true(), astman_get_header(), astman_send_ack(), astman_send_error(), config_text_file_save(), handle_updates(), and s. Referenced by init_manager(). { struct ast_config *cfg; const char *sfn = astman_get_header(m, "SrcFilename"); const char *dfn = astman_get_header(m, "DstFilename"); int res; const char *rld = astman_get_header(m, "Reload"); if (ast_strlen_zero(sfn) || ast_strlen_zero(dfn)) { astman_send_error(s, m, "Filename not specified"); return 0; } if (!(cfg = ast_config_load_with_comments(sfn))) { astman_send_error(s, m, "Config file not found"); return 0; } handle_updates(s, m, cfg); res = config_text_file_save(dfn, cfg, "Manager"); ast_config_destroy(cfg); if (res) { astman_send_error(s, m, "Save of config failed"); return 0; } astman_send_ack(s, m, NULL); if (!ast_strlen_zero(rld)) { if (ast_true(rld)) rld = NULL; ast_module_reload(rld); } return 0; }

static int action_userevent (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 2026 of file manager.c. References astman_get_header(), event, message::hdrcount, and message::headers. Referenced by init_manager(). { const char *event = astman_get_header(m, "UserEvent"); char body[2048] = ""; int x, bodylen = 0; for (x = 0; x < m->hdrcount; x++) { if (strncasecmp("UserEvent:", m->headers[x], strlen("UserEvent:"))) { ast_copy_string(body + bodylen, m->headers[x], sizeof(body) - bodylen - 3); bodylen += strlen(m->headers[x]); ast_copy_string(body + bodylen, "\r\n", 3); bodylen += 2; } } manager_event(EVENT_FLAG_USER, "UserEvent", "UserEvent: %s\r\n%s", event, body); return 0; }

static int action_waitevent (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 1159 of file manager.c. References ast_log(), ast_mutex_lock(), ast_mutex_unlock(), AST_PTHREADT_NULL, ast_strlen_zero(), ast_wait_for_input(), astman_get_header(), LOG_DEBUG, NEW_EVENT, option_debug, and s. Referenced by init_manager(). { const char *timeouts = astman_get_header(m, "Timeout"); int timeout = -1; int x; int needexit = 0; const char *id = astman_get_header(m,"ActionID"); char idText[256] = ""; if (!ast_strlen_zero(id)) snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id); if (!ast_strlen_zero(timeouts)) { sscanf(timeouts, "%i", &timeout); if (timeout < -1) timeout = -1; /* XXX maybe put an upper bound, or prevent the use of 0 ? */ } ast_mutex_lock(&s->__lock); if (s->waiting_thread != AST_PTHREADT_NULL) pthread_kill(s->waiting_thread, SIGURG); if (s->managerid) { /* AMI-over-HTTP session */ /* * Make sure the timeout is within the expire time of the session, * as the client will likely abort the request if it does not see * data coming after some amount of time. */ time_t now = time(NULL); int max = s->sessiontimeout - now - 10; if (max < 0) /* We are already late. Strange but possible. */ max = 0; if (timeout < 0 || timeout > max) timeout = max; if (!s->send_events) /* make sure we record events */ s->send_events = -1; } ast_mutex_unlock(&s->__lock); /* XXX should this go inside the lock ? */ s->waiting_thread = pthread_self(); /* let new events wake up this thread */ if (option_debug) ast_log(LOG_DEBUG, "Starting waiting for an event!\n"); for (x=0; x < timeout || timeout < 0; x++) { ast_mutex_lock(&s->__lock); if (NEW_EVENT(s)) needexit = 1; /* We can have multiple HTTP session point to the same mansession entry. * The way we deal with it is not very nice: newcomers kick out the previous * HTTP session. XXX this needs to be improved. */ if (s->waiting_thread != pthread_self()) needexit = 1; if (s->needdestroy) needexit = 1; ast_mutex_unlock(&s->__lock); if (needexit) break; if (s->managerid == 0) { /* AMI session */ if (ast_wait_for_input(s->fd, 1000)) break; } else { /* HTTP session */ sleep(1); } } if (option_debug) ast_log(LOG_DEBUG, "Finished waiting for an event!\n"); ast_mutex_lock(&s->__lock); if (s->waiting_thread == pthread_self()) { struct eventqent *eqe; astman_send_response(s, m, "Success", "Waiting for Event completed."); while ( (eqe = NEW_EVENT(s)) ) { ref_event(eqe); if (((s->readperm & eqe->category) == eqe->category) && ((s->send_events & eqe->category) == eqe->category)) { astman_append(s, "%s", eqe->eventdata); } s->last_ev = unref_event(s->last_ev); } astman_append(s, "Event: WaitEventComplete\r\n" "%s" "\r\n", idText); s->waiting_thread = AST_PTHREADT_NULL; } else { if (option_debug) ast_log(LOG_DEBUG, "Abandoning event request!\n"); } ast_mutex_unlock(&s->__lock); return 0; }

static int append_event (  const char *  str, int  category )  [static]

Definition at line 2294 of file manager.c. References AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_NEXT, AST_LIST_UNLOCK, ast_malloc, and seq. Referenced by __manager_event(), and init_manager(). { struct eventqent *tmp = ast_malloc(sizeof(*tmp) + strlen(str)); static int seq; /* sequence number */ if (!tmp) return -1; /* need to init all fields, because ast_malloc() does not */ tmp->usecount = 0; tmp->category = category; tmp->seq = ast_atomic_fetchadd_int(&seq, 1); AST_LIST_NEXT(tmp, eq_next) = NULL; strcpy(tmp->eventdata, str); AST_LIST_LOCK(&all_events); AST_LIST_INSERT_TAIL(&all_events, tmp, eq_next); AST_LIST_UNLOCK(&all_events); return 0; }

static int ast_instring (  const char *  bigstr, const char *  smallstr, const char  delim )  [static]

Tells you if smallstr exists inside bigstr which is delim by delim and uses no buf or stringsep ast_instring("this|that|more","this",'|') == 1; feel free to move this to app.c -anthm Definition at line 323 of file manager.c. Referenced by get_perm(). { const char *val = bigstr, *next; do { if ((next = strchr(val, delim))) { if (!strncmp(val, smallstr, (next - val))) return 1; else continue; } else return !strcmp(smallstr, val); } while (*(val = (next + 1))); return 0; }

static AST_LIST_HEAD_STATIC (  users  , ast_manager_user  )  [static]

list of users found in the config file

static AST_LIST_HEAD_STATIC (  sessions  , mansession  )  [static]

static AST_LIST_HEAD_STATIC (  all_events  , eventqent  )  [static]

int ast_manager_register2 (  const char *  action, int  authority, int(*)(struct mansession *s, const struct message *m)  func, const char *  synopsis, const char *  description )

register a new command with manager, including online help. This is the preferred way to register a manager command Parameters: action  Name of the requested Action: authority  Required authority for this command func  Function to call for this command synopsis  Help text (one line, up to 30 chars) for CLI manager show commands description  Help text, several lines Definition at line 2449 of file manager.c. References ast_malloc, and ast_manager_register_struct(). Referenced by init_manager(), load_module(), and sip_cli_and_manager_commands_register(). { struct manager_action *cur; cur = ast_malloc(sizeof(*cur)); if (!cur) return -1; cur->action = action; cur->authority = auth; cur->func = func; cur->synopsis = synopsis; cur->description = description; cur->next = NULL; ast_manager_register_struct(cur); return 0; }

void ast_manager_register_hook (  struct manager_custom_hook *  hook  )

Add a custom hook to be called when an event is fired. Parameters: hook  struct manager_custom_hook object to add Definition at line 182 of file manager.c. References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK. { AST_RWLIST_WRLOCK(&manager_hooks); AST_RWLIST_INSERT_TAIL(&manager_hooks, hook, list); AST_RWLIST_UNLOCK(&manager_hooks); return; }

static int ast_manager_register_struct (  struct manager_action *  act  )  [static]

Definition at line 2419 of file manager.c. References manager_action::action, ast_log(), ast_rwlock_unlock(), ast_rwlock_wrlock(), first_action, LOG_WARNING, and manager_action::next. Referenced by ast_manager_register2(). { struct manager_action *cur, *prev = NULL; int ret; ast_rwlock_wrlock(&actionlock); for (cur = first_action; cur; prev = cur, cur = cur->next) { ret = strcasecmp(cur->action, act->action); if (ret == 0) { ast_log(LOG_WARNING, "Manager: Action '%s' already registered\n", act->action); ast_rwlock_unlock(&actionlock); return -1; } if (ret > 0) /* Insert these alphabetically */ break; } if (prev) prev->next = act; else first_action = act; act->next = cur; if (option_verbose > 1) ast_verbose(VERBOSE_PREFIX_2 "Manager registered action %s\n", act->action); ast_rwlock_unlock(&actionlock); return 0; }

int ast_manager_unregister (  char *  action  )

Parameters: action  Name of registred Action: Definition at line 2391 of file manager.c. References ast_rwlock_wrlock(), ast_verbose(), first_action, free, manager_action::next, and option_verbose. Referenced by __unload_module(), sip_cli_and_manager_commands_unregister(), and unload_module(). { struct manager_action *cur, *prev; ast_rwlock_wrlock(&actionlock); for (cur = first_action, prev = NULL; cur; prev = cur, cur = cur->next) { if (!strcasecmp(action, cur->action)) { if (prev) prev->next = cur->next; else first_action = cur->next; free(cur); if (option_verbose > 1) ast_verbose(VERBOSE_PREFIX_2 "Manager unregistered action %s\n", action); break; } } ast_rwlock_unlock(&actionlock); return 0; }

void ast_manager_unregister_hook (  struct manager_custom_hook *  hook  )

Delete a custom hook to be called when an event is fired. Parameters: hook  struct manager_custom_hook object to delete Definition at line 191 of file manager.c. References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK. { AST_RWLIST_WRLOCK(&manager_hooks); AST_RWLIST_REMOVE(&manager_hooks, hook, list); AST_RWLIST_UNLOCK(&manager_hooks); return; }

static AST_RWLIST_HEAD_STATIC (  manager_hooks  , manager_custom_hook  )  [static]

AST_RWLOCK_DEFINE_STATIC (  actionlock   )

AST_THREADSTORAGE (  manager_event_buf   )

AST_THREADSTORAGE (  astman_append_buf   )

void astman_append (  struct mansession *  s, const char *  fmt,   ... )

utility functions for creating AMI replies Definition at line 761 of file manager.c. References ast_str_set_va, ast_verbose(), ASTMAN_APPEND_BUF_INITSIZE, s, send_string(), and ast_str::str. Referenced by __iax2_show_peers(), _sip_show_device(), _sip_show_devices(), _sip_show_peer(), _sip_show_peers(), action_agents(), action_challenge(), action_command(), action_extensionstate(), action_getconfig(), action_getvar(), action_listcommands(), action_mailboxcount(), action_mailboxstatus(), action_status(), action_zapshowchannels(), astman_send_response_full(), manager_dbget(), manager_iax2_show_netstats(), manager_iax2_show_peers(), manager_jabber_send(), manager_parking_status(), manager_show_dialplan_helper(), manager_sip_show_device(), manager_sip_show_devices(), manager_sip_show_peer(), manager_sip_show_peers(), and session_do(). { va_list ap; struct ast_str *buf; if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) return; va_start(ap, fmt); ast_str_set_va(&buf, 0, fmt, ap); va_end(ap); if (s->f != NULL) send_string(s, buf->str); else ast_verbose("fd == -1 in astman_append, should not happen\n"); }

const char* astman_get_header (  const struct message *  m, char *  var )

Get header from mananger transaction Definition at line 672 of file manager.c. References message::hdrcount, and message::headers. Referenced by _sip_show_devices(), _sip_show_peers(), action_agent_logoff(), action_agents(), action_challenge(), action_command(), action_events(), action_extensionstate(), action_getconfig(), action_getvar(), action_hangup(), action_mailboxcount(), action_mailboxstatus(), action_originate(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), action_userevent(), action_waitevent(), action_zapdialoffhook(), action_zapdndoff(), action_zapdndon(), action_zapshowchannels(), astman_send_response_full(), authenticate(), change_monitor_action(), do_pause_or_unpause(), handle_updates(), manager_dbdel(), manager_dbdeltree(), manager_dbget(), manager_dbput(), manager_iax2_show_peers(), manager_jabber_send(), manager_park(), manager_parking_status(), manager_show_dialplan(), manager_sip_show_device(), manager_sip_show_devices(), manager_sip_show_peer(), manager_sip_show_peers(), process_message(), start_monitor_action(), and stop_monitor_action(). { int x, l = strlen(var); for (x = 0; x < m->hdrcount; x++) { const char *h = m->headers[x]; if (!strncasecmp(var, h, l) && h[l] == ':' && h[l+1] == ' ') return h + l + 2; } return ""; }

struct ast_variable* astman_get_variables (  const struct message *  m  )

Get a linked list of the Variable: headers Definition at line 685 of file manager.c. References AST_APP_ARG, AST_DECLARE_APP_ARGS, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_variable_new(), message::hdrcount, message::headers, parse(), strsep(), and var. Referenced by action_originate(). { int varlen, x, y; struct ast_variable *head = NULL, *cur; AST_DECLARE_APP_ARGS(args, AST_APP_ARG(vars)[32]; ); varlen = strlen("Variable: "); for (x = 0; x < m->hdrcount; x++) { char *parse, *var, *val; if (strncasecmp("Variable: ", m->headers[x], varlen)) continue; parse = ast_strdupa(m->headers[x] + varlen); AST_STANDARD_APP_ARGS(args, parse); if (!args.argc) continue; for (y = 0; y < args.argc; y++) { if (!args.vars[y]) continue; var = val = ast_strdupa(args.vars[y]); strsep(&val, "="); if (!val || ast_strlen_zero(var)) continue; cur = ast_variable_new(var, val); cur->next = head; head = cur; } } return head; }

void astman_send_ack (  struct mansession *  s, const struct message *  m, char *  msg )

Definition at line 823 of file manager.c. References astman_send_response_full(), and s. Referenced by action_agent_logoff(), action_agents(), action_hangup(), action_login(), action_originate(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), action_zapdndoff(), action_zapdndon(), action_zaprestart(), action_zapshowchannels(), change_monitor_action(), do_pause_or_unpause(), manager_dbdel(), manager_dbdeltree(), manager_dbget(), manager_dbput(), manager_jabber_send(), manager_park(), manager_parking_status(), manager_sip_show_devices(), start_monitor_action(), and stop_monitor_action(). { astman_send_response_full(s, m, "Success", msg, NULL); }

void astman_send_error (  struct mansession *  s, const struct message *  m, char *  error )

Send error in manager transaction Definition at line 818 of file manager.c. References astman_send_response_full(), and s. Referenced by _sip_show_device(), _sip_show_peer(), action_agent_logoff(), action_challenge(), action_extensionstate(), action_getconfig(), action_getvar(), action_hangup(), action_login(), action_mailboxcount(), action_mailboxstatus(), action_originate(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), action_zapdialoffhook(), action_zapdndoff(), action_zapdndon(), action_zaprestart(), change_monitor_action(), do_pause_or_unpause(), manager_dbdel(), manager_dbdeltree(), manager_dbget(), manager_dbput(), manager_jabber_send(), manager_park(), manager_show_dialplan(), manager_show_dialplan_helper(), manager_sip_show_device(), manager_sip_show_peer(), process_message(), start_monitor_action(), and stop_monitor_action(). { astman_send_response_full(s, m, "Error", error, NULL); }

void astman_send_listack (  struct mansession *  s, const struct message *  m, char *  msg, char *  listflag )

Definition at line 833 of file manager.c. References astman_send_response_full(), and s. Referenced by manager_dpsendack(), and manager_sip_show_peers(). { astman_send_response_full(s, m, "Success", msg, listflag); }

void astman_send_response (  struct mansession *  s, const struct message *  m, char *  resp, char *  msg )

Definition at line 813 of file manager.c. References astman_send_response_full(), and s. Referenced by action_events(), action_logoff(), and action_ping(). { astman_send_response_full(s, m, resp, msg, NULL); }

static void astman_send_response_full (  struct mansession *  s, const struct message *  m, char *  resp, char *  msg, char *  listflag )  [static]

Definition at line 796 of file manager.c. References ast_strlen_zero(), astman_append(), astman_get_header(), MSG_MOREDATA, and s. Referenced by astman_send_ack(), astman_send_error(), astman_send_listack(), astman_send_response(), and astman_start_ack(). { const char *id = astman_get_header(m,"ActionID"); astman_append(s, "Response: %s\r\n", resp); if (!ast_strlen_zero(id)) astman_append(s, "ActionID: %s\r\n", id); if (listflag) astman_append(s, "Eventlist: %s\r\n", listflag); /* Start, complete, cancelled */ if (msg == MSG_MOREDATA) return; else if (msg) astman_append(s, "Message: %s\r\n\r\n", msg); else astman_append(s, "\r\n"); }

static void astman_start_ack (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 828 of file manager.c. References astman_send_response_full(), MSG_MOREDATA, and s. Referenced by action_challenge(), action_extensionstate(), action_getconfig(), action_getvar(), action_listcommands(), action_mailboxcount(), and action_mailboxstatus(). { astman_send_response_full(s, m, "Success", MSG_MOREDATA, NULL); }

static int authenticate (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 862 of file manager.c. References ast_append_ha(), ast_category_browse(), ast_config_load(), ast_log(), ast_strdupa, ast_strlen_zero(), ast_variable_browse(), astman_get_header(), error(), get_perm(), ast_variable::lineno, LOG_WARNING, ast_variable::name, ast_variable::next, s, and ast_variable::value. Referenced by action_login(), authenticate_reply(), and registry_rerequest(). { const char *user = astman_get_header(m, "Username"); int error = -1; struct ast_ha *ha = NULL; char *password = NULL; int readperm = 0, writeperm = 0; if (ast_strlen_zero(user)) /* missing username */ return -1; { /* * XXX there should be no need to scan the config file again here, * suffices to call get_manager_by_name_locked() to fetch * the user's entry. */ struct ast_config *cfg = ast_config_load("manager.conf"); char *cat = NULL; struct ast_variable *v; if (!cfg) return -1; while ( (cat = ast_category_browse(cfg, cat)) ) { /* "general" is not a valid user */ if (strcasecmp(cat, user) || !strcasecmp(cat, "general")) continue; /* collect parameters for the user's entry */ for (v = ast_variable_browse(cfg, cat); v; v = v->next) { if (!strcasecmp(v->name, "secret")) password = ast_strdupa(v->value); else if (!strcasecmp(v->name, "read")) readperm = get_perm(v->value); else if (!strcasecmp(v->name, "write")) writeperm = get_perm(v->value); else if (!strcasecmp(v->name, "permit") || !strcasecmp(v->name, "deny")) { ha = ast_append_ha(v->name, v->value, ha, NULL); } else if (!strcasecmp(v->name, "writetimeout")) { int val = atoi(v->value); if (val < 100) ast_log(LOG_WARNING, "Invalid writetimeout value '%s' at line %d\n", v->value, v->lineno); else s->writetimeout = val; } } break; } ast_config_destroy(cfg); if (!cat) { /* Didn't find the user in manager.conf, check users.conf */ int hasmanager = 0; cfg = ast_config_load("users.conf"); if (!cfg) return -1; while ( (cat = ast_category_browse(cfg, cat)) ) { if (!strcasecmp(cat, user) && strcasecmp(cat, "general")) break; } if (!cat) { ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_inet_ntoa(s->sin.sin_addr), user); ast_config_destroy(cfg); return -1; } /* collect parameters for the user's entry from users.conf */ for (v = ast_variable_browse(cfg, cat); v; v = v->next) { if (!strcasecmp(v->name, "secret")) password = ast_strdupa(v->value); else if (!strcasecmp(v->name, "read")) readperm = get_perm(v->value); else if (!strcasecmp(v->name, "write")) writeperm = get_perm(v->value); else if (!strcasecmp(v->name, "permit") || !strcasecmp(v->name, "deny")) { ha = ast_append_ha(v->name, v->value, ha, NULL); } else if (!strcasecmp(v->name, "writetimeout")) { int val = atoi(v->value); if (val < 100) ast_log(LOG_WARNING, "Invalid writetimeout value '%s' at line %d\n", v->value, v->lineno); else s->writetimeout = val; } else if (!strcasecmp(v->name, "hasmanager")) { hasmanager = ast_true(v->value); } } ast_config_destroy(cfg); if (!hasmanager) { ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_inet_ntoa(s->sin.sin_addr), user); return -1; } } } if (ha) { int good = ast_apply_ha(ha, &(s->sin)); ast_free_ha(ha); if (!good) { ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_inet_ntoa(s->sin.sin_addr), user); return -1; } } if (!strcasecmp(astman_get_header(m, "AuthType"), "MD5")) { const char *key = astman_get_header(m, "Key"); if (!ast_strlen_zero(key) && !ast_strlen_zero(s->challenge)) { int x; int len = 0; char md5key[256] = ""; struct MD5Context md5; unsigned char digest[16]; MD5Init(&md5); MD5Update(&md5, (unsigned char *) s->challenge, strlen(s->challenge)); MD5Update(&md5, (unsigned char *) password, strlen(password)); MD5Final(digest, &md5); for (x=0; x<16; x++) len += sprintf(md5key + len, "%2.2x", digest[x]); if (!strcmp(md5key, key)) error = 0; } } else if (password) { const char *pass = astman_get_header(m, "Secret"); if (!strcmp(password, pass)) error = 0; } if (error) { ast_log(LOG_NOTICE, "%s failed to authenticate as '%s'\n", ast_inet_ntoa(s->sin.sin_addr), user); return -1; } ast_copy_string(s->username, user, sizeof(s->username)); s->readperm = readperm; s->writeperm = writeperm; set_eventmask(s, astman_get_header(m, "Events")); return 0; }

static char* authority_to_str (  int  authority, struct ast_str **  res )  [static]

Convert authority code to a list of options. Definition at line 299 of file manager.c. References ast_str_append(), and perms. Referenced by __manager_event(), action_listcommands(), handle_showmancmd(), and handle_showmancmds(). { int i; char *sep = ""; (*res)->used = 0; for (i = 0; i < (sizeof(perms) / sizeof(perms[0])) - 1; i++) { if (authority & perms[i].num) { ast_str_append(res, 0, "%s%s", sep, perms[i].label); sep = ","; } } if ((*res)->used == 0) /* replace empty string with something sensible */ ast_str_append(res, 0, "<none>"); return (*res)->str; }

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

Definition at line 382 of file manager.c. References manager_action::action, ast_rwlock_rdlock(), ast_strdup, first_action, and manager_action::next. { struct manager_action *cur; int l = strlen(word), which = 0; char *ret = NULL; ast_rwlock_rdlock(&actionlock); for (cur = first_action; cur; cur = cur->next) { /* Walk the list of actions */ if (!strncasecmp(word, cur->action, l) && ++which > state) { ret = ast_strdup(cur->action); break; /* make sure we exit even if ast_strdup() returns NULL */ } } ast_rwlock_unlock(&actionlock); return ret; }

static void destroy_session (  struct mansession *  s  )  [static]

Definition at line 662 of file manager.c. References AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, free_session(), s, and sessions. Referenced by accept_thread(). { AST_LIST_LOCK(&sessions); AST_LIST_REMOVE(&sessions, s, list); AST_LIST_UNLOCK(&sessions); ast_atomic_fetchadd_int(&num_sessions, -1); free_session(s); }

static int do_message (  struct mansession *  s  )  [static]

Definition at line 2174 of file manager.c. References AST_MAX_MANHEADERS, ast_strdupa, ast_strlen_zero(), get_input(), message::hdrcount, message::headers, process_events(), process_message(), and s. Referenced by session_do(). { struct message m = { 0 }; char header_buf[sizeof(s->inbuf)] = { '\0' }; int res; for (;;) { /* Check if any events are pending and do them if needed */ if (process_events(s)) return -1; res = get_input(s, header_buf); if (res == 0) { continue; } else if (res > 0) { if (ast_strlen_zero(header_buf)) return process_message(s, &m) ? -1 : 0; else if (m.hdrcount < (AST_MAX_MANHEADERS - 1)) m.headers[m.hdrcount++] = ast_strdupa(header_buf); } else { return res; } } }

static void* fast_originate (  void *  data  )  [static]

Definition at line 1696 of file manager.c. References fast_originate_helper::account, fast_originate_helper::app, fast_originate_helper::appdata, AST_CHANNEL_NAME, ast_channel_unlock, AST_FORMAT_SLINEAR, ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_strlen_zero(), fast_originate_helper::cid_name, fast_originate_helper::cid_num, fast_originate_helper::context, fast_originate_helper::data, EVENT_FLAG_CALL, fast_originate_helper::exten, free, fast_originate_helper::idtext, manager_event, fast_originate_helper::priority, S_OR, fast_originate_helper::tech, fast_originate_helper::timeout, and fast_originate_helper::vars. Referenced by action_originate(). { struct fast_originate_helper *in = data; int res; int reason = 0; struct ast_channel *chan = NULL; char requested_channel[AST_CHANNEL_NAME]; if (!ast_strlen_zero(in->app)) { res = ast_pbx_outgoing_app(in->tech, AST_FORMAT_SLINEAR, in->data, in->timeout, in->app, in->appdata, &reason, 1, S_OR(in->cid_num, NULL), S_OR(in->cid_name, NULL), in->vars, in->account, &chan); } else { res = ast_pbx_outgoing_exten(in->tech, AST_FORMAT_SLINEAR, in->data, in->timeout, in->context, in->exten, in->priority, &reason, 1, S_OR(in->cid_num, NULL), S_OR(in->cid_name, NULL), in->vars, in->account, &chan); } if (!chan) snprintf(requested_channel, AST_CHANNEL_NAME, "%s/%s", in->tech, in->data); /* Tell the manager what happened with the channel */ manager_event(EVENT_FLAG_CALL, "OriginateResponse", "%s" "Response: %s\r\n" "Channel: %s\r\n" "Context: %s\r\n" "Exten: %s\r\n" "Reason: %d\r\n" "Uniqueid: %s\r\n" "CallerIDNum: %s\r\n" "CallerIDName: %s\r\n", in->idtext, res ? "Failure" : "Success", chan ? chan->name : requested_channel, in->context, in->exten, reason, chan ? chan->uniqueid : "<null>", S_OR(in->cid_num, "<unknown>"), S_OR(in->cid_name, "<unknown>") ); /* Locked by ast_pbx_outgoing_exten or ast_pbx_outgoing_app */ if (chan) ast_channel_unlock(chan); free(in); return NULL; }

static void free_session (  struct mansession *  s  )  [static]

Definition at line 652 of file manager.c. References ast_mutex_destroy(), free, s, and unref_event(). Referenced by destroy_session(), and purge_sessions(). { struct eventqent *eqe = s->last_ev; if (s->f != NULL) fclose(s->f); ast_mutex_destroy(&s->__lock); free(s); unref_event(eqe); }

static int get_input (  struct mansession *  s, char *  output )  [static]

Read one full line (including crlf) from the manager socket. is the only valid terminator for the line. (Note that, later, '' will be considered as the end-of-line marker, so everything between the '' and the ' ' will not be used). Also note that we assume output to have at least "maxlen" space. Definition at line 2109 of file manager.c. References s. Referenced by do_message(), and skinny_session(). { int res, x; int maxlen = sizeof(s->inbuf) - 1; char *src = s->inbuf; /* * Look for \r\n within the buffer. If found, copy to the output * buffer and return, trimming the \r\n (not used afterwards). */ for (x = 0; x < s->inlen; x++) { int cr; /* set if we have \r */ if (src[x] == '\r' && x+1 < s->inlen && src[x+1] == '\n') cr = 2; /* Found. Update length to include \r\n */ else if (src[x] == '\n') cr = 1; /* also accept \n only */ else continue; memmove(output, src, x); /*... but trim \r\n */ output[x] = '\0'; /* terminate the string */ x += cr; /* number of bytes used */ s->inlen -= x; /* remaining size */ memmove(src, src + x, s->inlen); /* remove used bytes */ return 1; } if (s->inlen >= maxlen) { /* no crlf found, and buffer full - sorry, too long for us */ ast_log(LOG_WARNING, "Dumping long line with no return from %s: %s\n", ast_inet_ntoa(s->sin.sin_addr), src); s->inlen = 0; } res = 0; while (res == 0) { /* XXX do we really need this locking ? */ ast_mutex_lock(&s->__lock); s->waiting_thread = pthread_self(); ast_mutex_unlock(&s->__lock); res = ast_wait_for_input(s->fd, -1); /* return 0 on timeout ? */ ast_mutex_lock(&s->__lock); s->waiting_thread = AST_PTHREADT_NULL; ast_mutex_unlock(&s->__lock); } if (res < 0) { /* If we get a signal from some other thread (typically because * there are new events queued), return 0 to notify the caller. */ if (errno == EINTR) return 0; ast_log(LOG_WARNING, "poll() returned error: %s\n", strerror(errno)); return -1; } ast_mutex_lock(&s->__lock); res = fread(src + s->inlen, 1, maxlen - s->inlen, s->f); if (res < 1) res = -1; /* error return */ else { s->inlen += res; src[s->inlen] = '\0'; res = 0; } ast_mutex_unlock(&s->__lock); return res; }

static struct ast_manager_user* get_manager_by_name_locked (  const char *  name  )  [static]

lookup an entry in the list of registered users. must be called with the list lock held. Definition at line 404 of file manager.c. References AST_LIST_TRAVERSE, and ast_manager_user::username. Referenced by handle_showmanager(). { struct ast_manager_user *user = NULL; AST_LIST_TRAVERSE(&users, user, list) if (!strcasecmp(user->username, name)) break; return user; }

static int get_perm (  const char *  instr  )  [static]

Definition at line 340 of file manager.c. References ast_instring(), and perms. Referenced by authenticate(). { int x = 0, ret = 0; if (!instr) return 0; for (x = 0; x < (sizeof(perms) / sizeof(perms[0])); x++) { if (ast_instring(instr, perms[x].label, ',')) ret |= perms[x].num; } return ret; }

static struct eventqent* grab_last (  void   )  [static]

Event list management functions. We assume that the event list always has at least one element, and the delete code will not remove the last entry even if the. Grab a reference to the last event, update usecount as needed. Can handle a NULL pointer. Definition at line 246 of file manager.c. References AST_LIST_LAST, AST_LIST_LOCK, AST_LIST_UNLOCK, and eventqent::usecount. Referenced by session_do(). { struct eventqent *ret; AST_LIST_LOCK(&all_events); ret = AST_LIST_LAST(&all_events); /* the list is never empty now, but may become so when * we optimize it in the future, so be prepared. */ if (ret) ast_atomic_fetchadd_int(&ret->usecount, 1); AST_LIST_UNLOCK(&all_events); return ret; }

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

Definition at line 438 of file manager.c. References ast_cli(), RESULT_SHOWUSAGE, and RESULT_SUCCESS. { if (argc == 2) ast_cli(fd, "manager debug is %s\n", manager_debug? "on" : "off"); else if (argc == 3) { if (!strcasecmp(argv[2], "on")) manager_debug = 1; else if (!strcasecmp(argv[2], "off")) manager_debug = 0; else return RESULT_SHOWUSAGE; } return RESULT_SUCCESS; }

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

Definition at line 453 of file manager.c. References ast_cli(), AST_LIST_LOCK, AST_LIST_UNLOCK, ast_manager_user::deny, ast_manager_user::displayconnects, get_manager_by_name_locked(), ast_manager_user::permit, ast_manager_user::read, RESULT_SHOWUSAGE, RESULT_SUCCESS, ast_manager_user::secret, ast_manager_user::username, and ast_manager_user::write. { struct ast_manager_user *user = NULL; if (argc != 4) return RESULT_SHOWUSAGE; AST_LIST_LOCK(&users); if (!(user = get_manager_by_name_locked(argv[3]))) { ast_cli(fd, "There is no manager called %s\n", argv[3]); AST_LIST_UNLOCK(&users); return -1; } ast_cli(fd,"\n"); ast_cli(fd, " username: %s\n" " secret: %s\n" " deny: %s\n" " permit: %s\n" " read: %s\n" " write: %s\n" "displayconnects: %s\n", (user->username ? user->username : "(N/A)"), (user->secret ? user->secret : "(N/A)"), (user->deny ? user->deny : "(N/A)"), (user->permit ? user->permit : "(N/A)"), (user->read ? user->read : "(N/A)"), (user->write ? user->write : "(N/A)"), (user->displayconnects ? "yes" : "no")); AST_LIST_UNLOCK(&users); return RESULT_SUCCESS; }

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

Definition at line 491 of file manager.c. References ast_cli(), AST_LIST_EMPTY, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, RESULT_SHOWUSAGE, RESULT_SUCCESS, and ast_manager_user::username. { struct ast_manager_user *user = NULL; int count_amu = 0; if (argc != 3) return RESULT_SHOWUSAGE; AST_LIST_LOCK(&users); /* If there are no users, print out something along those lines */ if (AST_LIST_EMPTY(&users)) { ast_cli(fd, "There are no manager users.\n"); AST_LIST_UNLOCK(&users); return RESULT_SUCCESS; } ast_cli(fd, "\nusername\n--------\n"); AST_LIST_TRAVERSE(&users, user, list) { ast_cli(fd, "%s\n", user->username); count_amu++; } AST_LIST_UNLOCK(&users); ast_cli(fd,"-------------------\n"); ast_cli(fd,"%d manager users configured.\n", count_amu); return RESULT_SUCCESS; }

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

Note: The actionlock is read-locked by the caller of this function Definition at line 415 of file manager.c. References manager_action::action, ast_cli(), ast_str_alloca, manager_action::authority, authority_to_str(), manager_action::description, first_action, manager_action::next, RESULT_SHOWUSAGE, S_OR, and manager_action::synopsis. { struct manager_action *cur; struct ast_str *authority = ast_str_alloca(80); int num; if (argc != 4) return RESULT_SHOWUSAGE; for (cur = first_action; cur; cur = cur->next) { /* Walk the list of actions */ for (num = 3; num < argc; num++) { if (!strcasecmp(cur->action, argv[num])) { ast_cli(fd, "Action: %s\nSynopsis: %s\nPrivilege: %s\n%s\n", cur->action, cur->synopsis, authority_to_str(cur->authority, &authority), S_OR(cur->description, "") ); } } } return RESULT_SUCCESS; }

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

CLI command manager list commands. Definition at line 525 of file manager.c. References manager_action::action, ast_cli(), ast_rwlock_rdlock(), ast_rwlock_unlock(), ast_str_alloca, manager_action::authority, authority_to_str(), first_action, format, manager_action::next, RESULT_SUCCESS, and manager_action::synopsis. { struct manager_action *cur; struct ast_str *authority = ast_str_alloca(80); char *format = " %-15.15s %-15.15s %-55.55s\n"; ast_cli(fd, format, "Action", "Privilege", "Synopsis"); ast_cli(fd, format, "------", "---------", "--------"); ast_rwlock_rdlock(&actionlock); for (cur = first_action; cur; cur = cur->next) /* Walk the list of actions */ ast_cli(fd, format, cur->action, authority_to_str(cur->authority, &authority), cur->synopsis); ast_rwlock_unlock(&actionlock); return RESULT_SUCCESS; }

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

CLI command manager list connected. Definition at line 543 of file manager.c. References ast_cli(), ast_inet_ntoa(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, format, RESULT_SUCCESS, s, and sessions. { struct mansession *s; char *format = " %-15.15s %-15.15s\n"; ast_cli(fd, format, "Username", "IP Address"); AST_LIST_LOCK(&sessions); AST_LIST_TRAVERSE(&sessions, s, list) ast_cli(fd, format,s->username, ast_inet_ntoa(s->sin.sin_addr)); AST_LIST_UNLOCK(&sessions); return RESULT_SUCCESS; }

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

CLI command manager list eventq. Definition at line 560 of file manager.c. References ast_cli(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, RESULT_SUCCESS, and s. { struct eventqent *s; AST_LIST_LOCK(&all_events); AST_LIST_TRAVERSE(&all_events, s, eq_next) { ast_cli(fd, "Usecount: %d\n",s->usecount); ast_cli(fd, "Category: %d\n", s->category); ast_cli(fd, "Event:\n%s", s->eventdata); } AST_LIST_UNLOCK(&all_events); return RESULT_SUCCESS; }

static void handle_updates (  struct mansession *  s, const struct message *  m, struct ast_config *  cfg )  [static]

Definition at line 1051 of file manager.c. References ast_category_append(), ast_category_delete(), ast_category_get(), ast_category_new(), ast_category_rename(), ast_strlen_zero(), ast_variable_append(), ast_variable_delete(), ast_variable_new(), ast_variable_update(), astman_get_header(), match(), ast_variable::object, ast_variable::value, and var. Referenced by action_updateconfig(). { int x; char hdr[40]; const char *action, *cat, *var, *value, *match; struct ast_category *category; struct ast_variable *v; for (x=0;x<100000;x++) { snprintf(hdr, sizeof(hdr), "Action-%06d", x); action = astman_get_header(m, hdr); if (ast_strlen_zero(action)) break; snprintf(hdr, sizeof(hdr), "Cat-%06d", x); cat = astman_get_header(m, hdr); snprintf(hdr, sizeof(hdr), "Var-%06d", x); var = astman_get_header(m, hdr); snprintf(hdr, sizeof(hdr), "Value-%06d", x); value = astman_get_header(m, hdr); snprintf(hdr, sizeof(hdr), "Match-%06d", x); match = astman_get_header(m, hdr); if (!strcasecmp(action, "newcat")) { if (!ast_strlen_zero(cat)) { category = ast_category_new(cat); if (category) { ast_category_append(cfg, category); } } } else if (!strcasecmp(action, "renamecat")) { if (!ast_strlen_zero(cat) && !ast_strlen_zero(value)) { category = ast_category_get(cfg, cat); if (category) ast_category_rename(category, value); } } else if (!strcasecmp(action, "delcat")) { if (!ast_strlen_zero(cat)) ast_category_delete(cfg, cat); } else if (!strcasecmp(action, "update")) { if (!ast_strlen_zero(cat) && !ast_strlen_zero(var) && (category = ast_category_get(cfg, cat))) ast_variable_update(category, var, value, match); } else if (!strcasecmp(action, "delete")) { if (!ast_strlen_zero(cat) && !ast_strlen_zero(var) && (category = ast_category_get(cfg, cat))) ast_variable_delete(category, var, match); } else if (!strcasecmp(action, "append")) { if (!ast_strlen_zero(cat) && !ast_strlen_zero(var) && (category = ast_category_get(cfg, cat)) && (v = ast_variable_new(var, value))){ if (match && !strcasecmp(match, "object")) v->object = 1; ast_variable_append(category, v); } } } }

static int manager_state_cb (  char *  context, char *  exten, int  state, void *  data )  [static]

Definition at line 2412 of file manager.c. References EVENT_FLAG_CALL, and manager_event. Referenced by init_manager(). { /* Notify managers of change */ manager_event(EVENT_FLAG_CALL, "ExtensionStatus", "Exten: %s\r\nContext: %s\r\nStatus: %d\r\n", exten, context, state); return 0; }

static int process_events (  struct mansession *  s  )  [static]

Send any applicable events to the client listening on this socket. Wait only for a finite time on each event, and drop all events whether they are successfully sent or not. Definition at line 1996 of file manager.c. References ast_mutex_lock(), ast_mutex_unlock(), NEW_EVENT, ref_event(), s, send_string(), and unref_event(). Referenced by do_message(). { int ret = 0; ast_mutex_lock(&s->__lock); if (s->f != NULL) { struct eventqent *eqe; while ( (eqe = NEW_EVENT(s)) ) { ref_event(eqe); if (!ret && s->authenticated && (s->readperm & eqe->category) == eqe->category && (s->send_events & eqe->category) == eqe->category) { if (send_string(s, eqe->eventdata) < 0) ret = -1; /* don't send more */ } s->last_ev = unref_event(s->last_ev); } } ast_mutex_unlock(&s->__lock); return ret; }

static int process_message (  struct mansession *  s, const struct message *  m )  [static]

Definition at line 2057 of file manager.c. References manager_action::action, ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_rwlock_rdlock(), ast_strlen_zero(), astman_get_header(), astman_send_error(), manager_action::authority, first_action, manager_action::func, LOG_DEBUG, manager_action::next, option_debug, and s. Referenced by do_message(). { char action[80] = ""; int ret = 0; struct manager_action *tmp; ast_copy_string(action, astman_get_header(m, "Action"), sizeof(action)); if (option_debug) ast_log(LOG_DEBUG, "Manager received command '%s'\n", action); if (ast_strlen_zero(action)) { astman_send_error(s, m, "Missing action in request"); return 0; } if (!s->authenticated && strcasecmp(action, "Login") && strcasecmp(action, "Logoff") && strcasecmp(action, "Challenge")) { ast_mutex_lock(&s->__lock); astman_send_error(s, m, "Permission denied"); ast_mutex_unlock(&s->__lock); return 0; } ast_rwlock_rdlock(&actionlock); for (tmp = first_action ; tmp; tmp = tmp->next) { if (strcasecmp(action, tmp->action)) continue; if ((s->writeperm & tmp->authority) == tmp->authority) { if (tmp->func(s, m)) { /* error */ return -1; } } else astman_send_error(s, m, "Permission denied"); break; } ast_rwlock_unlock(&actionlock); if (!tmp) { ast_mutex_lock(&s->__lock); astman_send_error(s, m, "Invalid/unknown command. Use Action: ListCommands to show available commands."); ast_mutex_unlock(&s->__lock); } if (ret) return ret; /* Once done with our message, deliver any pending events */ return process_events(s); }

static void purge_events (  void   )  [static]

Purge unused events. Remove elements from the head as long as their usecount is 0 and there is a next element. Definition at line 265 of file manager.c. References AST_LIST_FIRST, AST_LIST_LOCK, AST_LIST_NEXT, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, free, and eventqent::usecount. Referenced by purge_old_stuff(). { struct eventqent *ev; AST_LIST_LOCK(&all_events); while ( (ev = AST_LIST_FIRST(&all_events)) && ev->usecount == 0 && AST_LIST_NEXT(ev, eq_next)) { AST_LIST_REMOVE_HEAD(&all_events, eq_next); free(ev); } AST_LIST_UNLOCK(&all_events); }

static void purge_sessions (  int  n_max  )  [static]

remove at most n_max stale session from the list. Definition at line 2267 of file manager.c. References ast_inet_ntoa(), AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_verbose(), free_session(), num_sessions, option_verbose, s, and sessions. Referenced by purge_old_stuff(). { struct mansession *s; time_t now = time(NULL); AST_LIST_LOCK(&sessions); AST_LIST_TRAVERSE_SAFE_BEGIN(&sessions, s, list) { if (s->sessiontimeout && (now > s->sessiontimeout) && !s->inuse) { AST_LIST_REMOVE_CURRENT(&sessions, list); ast_atomic_fetchadd_int(&num_sessions, -1); if (s->authenticated && (option_verbose > 1) && displayconnects) { ast_verbose(VERBOSE_PREFIX_2 "HTTP Manager '%s' timed out from %s\n", s->username, ast_inet_ntoa(s->sin.sin_addr)); } free_session(s); /* XXX outside ? */ if (--n_max <= 0) break; } } AST_LIST_TRAVERSE_SAFE_END AST_LIST_UNLOCK(&sessions); }

static void ref_event (  struct eventqent *  e  )  [static]

Definition at line 644 of file manager.c. References eventqent::usecount. Referenced by process_events(). { ast_atomic_fetchadd_int(&e->usecount, 1); }

static int send_string (  struct mansession *  s, char *  string )  [static]

helper function to send a string to the socket. Return -1 on error (e.g. buffer full). Definition at line 726 of file manager.c. References pollfd::fd, len, poll(), POLLOUT, and s. Referenced by astman_append(), and process_events(). { int len = strlen(string); /* residual length */ char *src = string; struct timeval start = ast_tvnow(); int n = 0; for (;;) { int elapsed; struct pollfd fd; n = fwrite(src, 1, len, s->f); /* try to write the string, non blocking */ if (n == len /* ok */ || n < 0 /* error */) break; len -= n; /* skip already written data */ src += n; fd.fd = s->fd; fd.events = POLLOUT; n = -1; /* error marker */ elapsed = ast_tvdiff_ms(ast_tvnow(), start); if (elapsed > s->writetimeout) break; if (poll(&fd, 1, s->writetimeout - elapsed) < 1) break; } fflush(s->f); return n < 0 ? -1 : 0; }

static void* session_do (  void *  data  )  [static]

The body of the individual manager session. Call get_input() to read one line at a time (or be woken up on new events), collect the lines in a message until found an empty line, and execute the request. In any case, deliver events asynchronously through process_events() (called from here if no line is available, or at the end of process_message(). ). Definition at line 2206 of file manager.c. References ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_mutex_init(), AST_PTHREADT_NULL, astman_append(), block_sockets, do_message(), server_instance::f, server_instance::fd, grab_last(), num_sessions, server_instance::requestor, s, and sessions. { struct server_instance *ser = data; struct mansession *s = ast_calloc(1, sizeof(*s)); int flags; int res; if (s == NULL) goto done; s->writetimeout = 100; s->waiting_thread = AST_PTHREADT_NULL; flags = fcntl(ser->fd, F_GETFL); if (!block_sockets) /* make sure socket is non-blocking */ flags |= O_NONBLOCK; else flags &= ~O_NONBLOCK; fcntl(ser->fd, F_SETFL, flags); ast_mutex_init(&s->__lock); s->send_events = -1; /* these fields duplicate those in the 'ser' structure */ s->fd = ser->fd; s->f = ser->f; s->sin = ser->requestor; ast_atomic_fetchadd_int(&num_sessions, 1); AST_LIST_LOCK(&sessions); AST_LIST_INSERT_HEAD(&sessions, s, list); AST_LIST_UNLOCK(&sessions); /* Hook to the tail of the event queue */ s->last_ev = grab_last(); s->f = ser->f; astman_append(s, "Asterisk Call Manager/1.0\r\n"); /* welcome prompt */ for (;;) { if ((res = do_message(s)) < 0) break; } /* session is over, explain why and terminate */ if (s->authenticated) { if (option_verbose > 1) { if (displayconnects) ast_verbose(VERBOSE_PREFIX_2 "Manager '%s' logged off from %s\n", s->username, ast_inet_ntoa(s->sin.sin_addr)); } ast_log(LOG_EVENT, "Manager '%s' logged off from %s\n", s->username, ast_inet_ntoa(s->sin.sin_addr)); } else { if (option_verbose > 1) { if (displayconnects) ast_verbose(VERBOSE_PREFIX_2 "Connect attempt from '%s' unable to authenticate\n", ast_inet_ntoa(s->sin.sin_addr)); } ast_log(LOG_EVENT, "Failed attempt from %s\n", ast_inet_ntoa(s->sin.sin_addr)); } destroy_session(s); done: free(ser); return NULL; }

static int set_eventmask (  struct mansession *  s, const char *  eventmask )  [static]

Rather than braindead on,off this now can also accept a specific int mask value or a ',' delim list of mask strings (the same as manager.conf) -anthm. Definition at line 843 of file manager.c. References ast_mutex_lock(), ast_mutex_unlock(), s, and strings_to_mask(). Referenced by action_events(). { int maskint = strings_to_mask(eventmask); ast_mutex_lock(&s->__lock); if (maskint >= 0) s->send_events = maskint; ast_mutex_unlock(&s->__lock); return maskint; }

static int strings_to_mask (  const char *  string  )  [static]

A number returns itself, false returns 0, true returns all flags, other strings return the flags that are set. Definition at line 359 of file manager.c. References ast_false(), ast_strlen_zero(), ast_true(), and perms. Referenced by set_eventmask(). { const char *p; if (ast_strlen_zero(string)) return -1; for (p = string; *p; p++) if (*p < '0' || *p > '9') break; if (!p) /* all digits */ return atoi(string); if (ast_false(string)) return 0; if (ast_true(string)) { /* all permissions */ int x, ret = 0; for (x=0; x<sizeof(perms) / sizeof(perms[0]); x++) ret |= perms[x].num; return ret; } return get_perm(string); }

static struct eventqent* unref_event (  struct eventqent *  e  )  [static]

Definition at line 638 of file manager.c. References AST_LIST_NEXT, and eventqent::usecount. Referenced by free_session(), and process_events(). { ast_atomic_fetchadd_int(&e->usecount, -1); return AST_LIST_NEXT(e, eq_next); }

---

Variable Documentation

int block_sockets [static]

Definition at line 113 of file manager.c. Referenced by session_do().

struct ast_cli_entry cli_manager[] [static]

Definition at line 602 of file manager.c. Referenced by init_manager().

int displayconnects = 1 [static]

Definition at line 109 of file manager.c. Referenced by action_login().

struct manager_action* first_action [static]

list of actions registered Definition at line 176 of file manager.c. Referenced by action_listcommands(), ast_manager_register_struct(), ast_manager_unregister(), complete_show_mancmd(), handle_showmancmd(), handle_showmancmds(), and process_message().

int httptimeout = 60 [static]

Definition at line 111 of file manager.c.

int manager_debug [static]

enable some debugging code in the manager Definition at line 116 of file manager.c. Referenced by __manager_event().

char mandescr_command[] [static]

Initial value: "Description: Run a CLI command.\n" "Variables: (Names marked with * are required)\n" " *Command: Asterisk CLI command to run\n" " ActionID: Optional Action id for message matching.\n" Definition at line 1646 of file manager.c. Referenced by init_manager().

char mandescr_events[] [static]

Definition at line 1276 of file manager.c. Referenced by init_manager().

char mandescr_extensionstate[] [static]

Definition at line 1924 of file manager.c. Referenced by init_manager().

char mandescr_getconfig[] [static]

Initial value: "Description: A 'GetConfig' action will dump the contents of a configuration\n" "file by category and contents.\n" "Variables:\n" " Filename: Configuration filename (e.g. foo.conf)\n" Definition at line 1013 of file manager.c. Referenced by init_manager().

char mandescr_getvar[] [static]

Definition at line 1409 of file manager.c. Referenced by init_manager().

char mandescr_hangup[] [static]

Initial value: "Description: Hangup a channel\n" "Variables: \n" " Channel: The channel name to be hungup\n" Definition at line 1343 of file manager.c. Referenced by init_manager().

char mandescr_listcommands[] [static]

Initial value: "Description: Returns the action name and synopsis for every\n" " action that is available to the user\n" "Variables: NONE\n" Definition at line 1254 of file manager.c. Referenced by init_manager().

char mandescr_logoff[] [static]

Initial value: "Description: Logoff this manager session\n" "Variables: NONE\n" Definition at line 1298 of file manager.c. Referenced by init_manager().

char mandescr_mailboxcount[] [static]

Definition at line 1893 of file manager.c. Referenced by init_manager().

char mandescr_mailboxstatus[] [static]

Help text for manager command mailboxstatus. Definition at line 1865 of file manager.c. Referenced by init_manager().

char mandescr_originate[] [static]

Definition at line 1742 of file manager.c. Referenced by init_manager().

char mandescr_ping[] [static]

Initial value: "Description: A 'Ping' action will ellicit a 'Pong' response. Used to keep the\n" " manager connection open.\n" "Variables: NONE\n" Manager PING. Definition at line 1002 of file manager.c. Referenced by init_manager().

char mandescr_redirect[] [static]

Definition at line 1582 of file manager.c. Referenced by init_manager().

char mandescr_sendtext[] [static]

Definition at line 1541 of file manager.c. Referenced by init_manager().

char mandescr_setvar[] [static]

Definition at line 1367 of file manager.c. Referenced by init_manager().

char mandescr_timeout[] [static]

Definition at line 1959 of file manager.c. Referenced by init_manager().

char mandescr_updateconfig[] [static]

Definition at line 1106 of file manager.c. Referenced by init_manager().

char mandescr_userevent[] [static]

Definition at line 2019 of file manager.c. Referenced by init_manager().

char mandescr_waitevent[] [static]

Manager WAITEVENT. Definition at line 1152 of file manager.c. Referenced by init_manager().

int num_sessions [static]

Definition at line 114 of file manager.c. Referenced by __manager_event(), purge_sessions(), and session_do().

struct permalias perms[] [static]

helper functions to convert back and forth between string and numeric representation of set of flags Referenced by authority_to_str(), get_perm(), and strings_to_mask().

char showmanager_help[] [static]

Initial value: " Usage: manager show user <user>\n" " Display all information related to the manager user specified.\n" Definition at line 598 of file manager.c.

char showmanagers_help[] [static]

Initial value: "Usage: manager show users\n" " Prints a listing of all managers that are currently configured on that\n" " system.\n" Definition at line 593 of file manager.c.

char showmancmd_help[] [static]

Initial value: "Usage: manager show command <actionname>\n" " Shows the detailed description for a specific Asterisk manager interface command.\n" Definition at line 575 of file manager.c.

char showmancmds_help[] [static]

Initial value: "Usage: manager show commands\n" " Prints a listing of all the available Asterisk manager interface commands.\n" Definition at line 579 of file manager.c.

char showmanconn_help[] [static]

Initial value: "Usage: manager show connected\n" " Prints a listing of the users that are currently connected to the\n" "Asterisk manager interface.\n" Definition at line 583 of file manager.c.

char showmaneventq_help[] [static]

Initial value: "Usage: manager show eventq\n" " Prints a listing of all events pending in the Asterisk manger\n" "event queue.\n" Definition at line 588 of file manager.c.

int timestampevents [static]

Definition at line 110 of file manager.c. Referenced by __manager_event().

---

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