Mon Nov 24 15:34:45 2008

Asterisk developer's documentation


manager.c File Reference

The Asterisk Management Interface - AMI. More...

#include "asterisk.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <sys/time.h>
#include <sys/types.h>
#include <netdb.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <signal.h>
#include <errno.h>
#include <unistd.h>
#include "asterisk/version.h"
#include "asterisk/channel.h"
#include "asterisk/file.h"
#include "asterisk/manager.h"
#include "asterisk/config.h"
#include "asterisk/callerid.h"
#include "asterisk/lock.h"
#include "asterisk/logger.h"
#include "asterisk/options.h"
#include "asterisk/cli.h"
#include "asterisk/app.h"
#include "asterisk/pbx.h"
#include "asterisk/md5.h"
#include "asterisk/acl.h"
#include "asterisk/utils.h"
#include "asterisk/http.h"
#include "asterisk/threadstorage.h"
#include "asterisk/linkedlists.h"
#include "asterisk/term.h"
#include "asterisk/astobj2.h"

Go to the source code of this file.

Data Structures

struct  ast_manager_user
struct  eventqent
struct  fast_originate_helper
struct  mansession
struct  permalias
struct  variable_count

Defines

#define ASTMAN_APPEND_BUF_INITSIZE   256
#define MANAGER_EVENT_BUF_INITSIZE   256
#define MAX_BLACKLIST_CMD_LEN   2

Enumerations

enum  { FORMAT_RAW, FORMAT_HTML, FORMAT_XML }

Functions

static void * accept_thread (void *ignore)
static int action_atxfer (struct mansession *s, const struct message *m)
static int action_command (struct mansession *s, const struct message *m)
 action_command: Manager command "command" - execute CLI command
static int action_coresettings (struct mansession *s, const struct message *m)
 Show PBX core settings information.
static int action_corestatus (struct mansession *s, const struct message *m)
 Show PBX core status information.
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_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_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 struct ast_manager_userast_get_manager_by_name_locked (const char *name)
static int ast_instring (const char *bigstr, const char *smallstr, char delim)
static int ast_is_number (const char *string)
static AST_LIST_HEAD_STATIC (users, ast_manager_user)
static AST_LIST_HEAD_STATIC (sessions, mansession)
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
static int ast_manager_register_struct (struct manager_action *act)
int ast_manager_unregister (char *action)
 AST_RWLOCK_DEFINE_STATIC (actionlock)
 AST_THREADSTORAGE (astman_append_buf, astman_append_buf_init)
 AST_THREADSTORAGE (manager_event_buf, manager_event_buf_init)
void astman_append (struct mansession *s, const char *fmt,...)
const char * astman_get_header (const struct message *m, char *var)
ast_variableastman_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_response (struct mansession *s, const struct message *m, char *resp, char *msg)
int astman_verify_session_readpermissions (uint32_t ident, int perm)
 Verify a session's read permissions against a permission mask.
int astman_verify_session_writepermissions (uint32_t ident, int perm)
 Verify a session's write permissions against a permission mask.
static int authenticate (struct mansession *s, const struct message *m)
static char * authority_to_str (int authority, char *res, int reslen)
 Convert authority code to string with serveral options.
static int check_blacklist (const char *cmd)
int check_manager_enabled ()
 Check if AMI is enabled.
int check_webmanager_enabled ()
 Check if AMI/HTTP is enabled.
static char * complete_show_mancmd (const char *line, const char *word, int pos, int state)
static int compress_char (char c)
static void destroy_session (struct mansession *s)
static int do_message (struct mansession *s)
static void * fast_originate (void *data)
static struct mansessionfind_session (uint32_t ident)
static void free_session (struct mansession *s)
static char * generic_http_callback (int format, struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength)
static int get_input (struct mansession *s, char *output)
static int get_perm (const char *instr)
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 Should change to "manager show commands".
static int handle_showmanconn (int fd, int argc, char *argv[])
 CLI command show manager connected.
static int handle_showmaneventq (int fd, int argc, char *argv[])
 CLI command show manager eventq.
static void handle_updates (struct mansession *s, const struct message *m, struct ast_config *cfg)
static char * html_translate (char *in)
int init_manager (void)
int manager_event (int category, const char *event, const char *fmt,...)
 manager_event: Send AMI event to client
static char * manager_http_callback (struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength)
static int manager_state_cb (char *context, char *exten, int state, void *data)
static char * mxml_http_callback (struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength)
static int process_events (struct mansession *s)
static int process_message (struct mansession *s, const struct message *m)
static char * rawman_http_callback (struct sockaddr_in *requestor, const char *uri, struct ast_variable *params, int *status, char **title, int *contentlength)
int reload_manager (void)
static void * session_do (void *data)
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 void unuse_eventqent (struct eventqent *e)
static int variable_count_cmp_fn (void *obj, void *vstr, int flags)
static int variable_count_hash_fn (const void *vvc, const int flags)
static void xml_copy_escape (char **dst, size_t *maxlen, const char *src, int lower)
static char * xml_translate (char *in, struct ast_variable *vars)

Variables

static int asock = -1
static int block_sockets
static struct ast_cli_entry cli_manager []
static struct ast_cli_entry cli_show_manager_command_deprecated
static struct ast_cli_entry cli_show_manager_commands_deprecated
static struct ast_cli_entry cli_show_manager_connected_deprecated
static struct ast_cli_entry cli_show_manager_eventq_deprecated
struct {
   char *   words [AST_MAX_CMD_LEN]
command_blacklist []
static char * contenttype [] = { "plain", "html", "xml" }
static int displayconnects = 1
static struct manager_actionfirst_action
static int httptimeout = 60
static int manager_enabled = 0
ast_http_uri manageruri
ast_http_uri managerxmluri
static char mandescr_atxfer []
static char mandescr_command []
static char mandescr_coresettings []
static char mandescr_corestatus []
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_setvar []
static char mandescr_timeout []
static char mandescr_updateconfig []
static char mandescr_userevent []
static char mandescr_waitevent []
 Manager WAITEVENT.
eventqentmaster_eventq = NULL
static int num_sessions
static struct permalias perms []
static int portno = DEFAULT_MANAGER_PORT
ast_http_uri rawmanuri
static int registered = 0
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 pthread_t t
static int timestampevents
static int webmanager_enabled = 0
static int webregged = 0


Detailed Description

The Asterisk Management Interface - AMI.

Author:
Mark Spencer <markster@digium.com>
Channel Management and more

manager.conf

Definition in file manager.c.


Enumeration Type Documentation

anonymous enum

Enumerator:
FORMAT_RAW 
FORMAT_HTML 
FORMAT_XML 

Definition at line 2827 of file manager.c.

02827      {
02828    FORMAT_RAW,
02829    FORMAT_HTML,
02830    FORMAT_XML,
02831 };


Function Documentation

int astman_verify_session_readpermissions ( uint32_t  ident,
int  perm 
)

Verify a session's read permissions against a permission mask.

Parameters:
ident session identity
perm permission mask to verify
Returns:
1 if the session has the permission mask capabilities, otherwise 0

Definition at line 2789 of file manager.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), s, and sessions.

02790 {
02791    int result = 0;
02792    struct mansession *s;
02793 
02794    AST_LIST_LOCK(&sessions);
02795    AST_LIST_TRAVERSE(&sessions, s, list) {
02796       ast_mutex_lock(&s->__lock);
02797       if ((s->managerid == ident) && (s->readperm & perm)) {
02798          result = 1;
02799          ast_mutex_unlock(&s->__lock);
02800          break;
02801       }
02802       ast_mutex_unlock(&s->__lock);
02803    }
02804    AST_LIST_UNLOCK(&sessions);
02805    return result;
02806 }

int astman_verify_session_writepermissions ( uint32_t  ident,
int  perm 
)

Verify a session's write permissions against a permission mask.

Parameters:
ident session identity
perm permission mask to verify
Returns:
1 if the session has the permission mask capabilities, otherwise 0

Definition at line 2808 of file manager.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), s, and sessions.

02809 {
02810    int result = 0;
02811    struct mansession *s;
02812 
02813    AST_LIST_LOCK(&sessions);
02814    AST_LIST_TRAVERSE(&sessions, s, list) {
02815       ast_mutex_lock(&s->__lock);
02816       if ((s->managerid == ident) && (s->writeperm & perm)) {
02817          result = 1;
02818          ast_mutex_unlock(&s->__lock);
02819          break;
02820       }
02821       ast_mutex_unlock(&s->__lock);
02822    }
02823    AST_LIST_UNLOCK(&sessions);
02824    return result;
02825 }

static struct mansession* find_session ( uint32_t  ident  )  [static]

END Doxygen group

Definition at line 2771 of file manager.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_mutex_lock(), ast_mutex_unlock(), s, and sessions.

02772 {
02773    struct mansession *s;
02774 
02775    AST_LIST_LOCK(&sessions);
02776    AST_LIST_TRAVERSE(&sessions, s, list) {
02777       ast_mutex_lock(&s->__lock);
02778       if (s->sessiontimeout && (s->managerid == ident) && !s->needdestroy) {
02779          s->inuse++;
02780          break;
02781       }
02782       ast_mutex_unlock(&s->__lock);
02783    }
02784    AST_LIST_UNLOCK(&sessions);
02785 
02786    return s;
02787 }

static char* generic_http_callback ( int  format,
struct sockaddr_in *  requestor,
const char *  uri,
struct ast_variable params,
int *  status,
char **  title,
int *  contentlength 
) [static]

Definition at line 2834 of file manager.c.

References len, ast_variable::name, ast_variable::next, s, and ast_variable::value.

Referenced by manager_http_callback(), mxml_http_callback(), and rawman_http_callback().

02835 {
02836    struct mansession *s = NULL;
02837    uint32_t ident = 0;
02838    char workspace[512];
02839    char cookie[128];
02840    size_t len = sizeof(workspace);
02841    int blastaway = 0;
02842    char *c = workspace;
02843    char *retval = NULL;
02844    struct ast_variable *v;
02845 
02846    for (v = params; v; v = v->next) {
02847       if (!strcasecmp(v->name, "mansession_id")) {
02848          sscanf(v->value, "%x", &ident);
02849          break;
02850       }
02851    }
02852    
02853    if (!(s = find_session(ident))) {
02854       /* Create new session */
02855       if (!(s = ast_calloc(1, sizeof(*s)))) {
02856          *status = 500;
02857          goto generic_callback_out;
02858       }
02859       memcpy(&s->sin, requestor, sizeof(s->sin));
02860       s->fd = -1;
02861       s->waiting_thread = AST_PTHREADT_NULL;
02862       s->send_events = 0;
02863       ast_mutex_init(&s->__lock);
02864       ast_mutex_lock(&s->__lock);
02865       s->inuse = 1;
02866       /*!\note There is approximately a 1 in 1.8E19 chance that the following
02867        * calculation will produce 0, which is an invalid ID, but due to the
02868        * properties of the rand() function (and the constantcy of s), that
02869        * won't happen twice in a row.
02870        */
02871       while ((s->managerid = rand() ^ (unsigned long) s) == 0);
02872       AST_LIST_LOCK(&sessions);
02873       AST_LIST_INSERT_HEAD(&sessions, s, list);
02874       /* Hook into the last spot in the event queue */
02875       s->eventq = master_eventq;
02876       while (s->eventq->next)
02877          s->eventq = s->eventq->next;
02878       ast_atomic_fetchadd_int(&s->eventq->usecount, 1);
02879       ast_atomic_fetchadd_int(&num_sessions, 1);
02880       AST_LIST_UNLOCK(&sessions);
02881    }
02882 
02883    /* Reset HTTP timeout.  If we're not yet authenticated, keep it extremely short */
02884    time(&s->sessiontimeout);
02885    if (!s->authenticated && (httptimeout > 5))
02886       s->sessiontimeout += 5;
02887    else
02888       s->sessiontimeout += httptimeout;
02889    ast_mutex_unlock(&s->__lock);
02890    
02891    if (s) {
02892       struct message m = { 0 };
02893       char tmp[80];
02894       unsigned int x;
02895       size_t hdrlen;
02896 
02897       for (x = 0, v = params; v && (x < AST_MAX_MANHEADERS); x++, v = v->next) {
02898          hdrlen = strlen(v->name) + strlen(v->value) + 3;
02899          m.headers[m.hdrcount] = alloca(hdrlen);
02900          snprintf((char *) m.headers[m.hdrcount], hdrlen, "%s: %s", v->name, v->value);
02901          m.hdrcount = x + 1;
02902       }
02903 
02904       if (process_message(s, &m)) {
02905          if (s->authenticated) {
02906             if (option_verbose > 1) {
02907                if (displayconnects) 
02908                   ast_verbose(VERBOSE_PREFIX_2 "HTTP Manager '%s' logged off from %s\n", s->username, ast_inet_ntoa(s->sin.sin_addr));    
02909             }
02910             ast_log(LOG_EVENT, "HTTP Manager '%s' logged off from %s\n", s->username, ast_inet_ntoa(s->sin.sin_addr));
02911          } else {
02912             if (option_verbose > 1) {
02913                if (displayconnects)
02914                   ast_verbose(VERBOSE_PREFIX_2 "HTTP Connect attempt from '%s' unable to authenticate\n", ast_inet_ntoa(s->sin.sin_addr));
02915             }
02916             ast_log(LOG_EVENT, "HTTP Failed attempt from %s\n", ast_inet_ntoa(s->sin.sin_addr));
02917          }
02918          s->needdestroy = 1;
02919       }
02920       ast_build_string(&c, &len, "Content-type: text/%s\r\n", contenttype[format]);
02921       sprintf(tmp, "%08x", s->managerid);
02922       ast_build_string(&c, &len, "%s\r\n", ast_http_setcookie("mansession_id", tmp, httptimeout, cookie, sizeof(cookie)));
02923       if (format == FORMAT_HTML)
02924          ast_build_string(&c, &len, "<title>Asterisk&trade; Manager Interface</title>");
02925       if (format == FORMAT_XML) {
02926          ast_build_string(&c, &len, "<ajax-response>\n");
02927       } else if (format == FORMAT_HTML) {
02928          ast_build_string(&c, &len, "<body bgcolor=\"#ffffff\"><table align=center bgcolor=\"#f1f1f1\" width=\"500\">\r\n");
02929          ast_build_string(&c, &len, "<tr><td colspan=\"2\" bgcolor=\"#f1f1ff\"><h1>&nbsp;&nbsp;Manager Tester</h1></td></tr>\r\n");
02930       }
02931       ast_mutex_lock(&s->__lock);
02932       if (s->outputstr) {
02933          char *tmp;
02934          if (format == FORMAT_XML)
02935             tmp = xml_translate(s->outputstr->str, params);
02936          else if (format == FORMAT_HTML)
02937             tmp = html_translate(s->outputstr->str);
02938          else
02939             tmp = s->outputstr->str;
02940          if (tmp) {
02941             retval = malloc(strlen(workspace) + strlen(tmp) + 128);
02942             if (retval) {
02943                strcpy(retval, workspace);
02944                strcpy(retval + strlen(retval), tmp);
02945                c = retval + strlen(retval);
02946                len = 120;
02947             }
02948          }
02949          if (tmp != s->outputstr->str)
02950             free(tmp);
02951          free(s->outputstr);
02952          s->outputstr = NULL;
02953       }
02954       ast_mutex_unlock(&s->__lock);
02955       /* Still okay because c would safely be pointing to workspace even
02956          if retval failed to allocate above */
02957       if (format == FORMAT_XML) {
02958          ast_build_string(&c, &len, "</ajax-response>\n");
02959       } else if (format == FORMAT_HTML)
02960          ast_build_string(&c, &len, "</table></body>\r\n");
02961    } else {
02962       *status = 500;
02963       *title = strdup("Server Error");
02964    }
02965    ast_mutex_lock(&s->__lock);
02966    if (s->needdestroy) {
02967       if (s->inuse == 1) {
02968          ast_log(LOG_DEBUG, "Need destroy, doing it now!\n");
02969          blastaway = 1;
02970       } else {
02971          ast_log(LOG_DEBUG, "Need destroy, but can't do it yet!\n");
02972          if (s->waiting_thread != AST_PTHREADT_NULL)
02973             pthread_kill(s->waiting_thread, SIGURG);
02974          s->inuse--;
02975       }
02976    } else
02977       s->inuse--;
02978    ast_mutex_unlock(&s->__lock);
02979    
02980    if (blastaway)
02981       destroy_session(s);
02982 generic_callback_out:
02983    if (*status != 200)
02984       return ast_http_error(500, "Server Error", NULL, "Internal Server Error (out of memory)\n"); 
02985    return retval;
02986 }

int init_manager ( void   ) 

Called by Asterisk initialization

Definition at line 3027 of file manager.c.

References action_atxfer(), action_command(), action_coresettings(), action_corestatus(), action_events(), action_extensionstate(), action_getconfig(), action_getvar(), action_hangup(), action_listcommands(), action_logoff(), action_mailboxcount(), action_mailboxstatus(), action_originate(), action_ping(), action_redirect(), action_setvar(), action_status(), action_timeout(), action_updateconfig(), action_userevent(), action_waitevent(), append_event(), asock, ast_calloc, ast_category_browse(), ast_cli_register_multiple(), ast_config_load(), ast_extension_state_add(), ast_get_manager_by_name_locked(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, ast_log(), ast_manager_register, ast_manager_register2(), ast_strdup, ast_true(), ast_variable_browse(), ast_variable_retrieve(), block_sockets, cli_manager, DEFAULT_MANAGER_PORT, ast_manager_user::deny, displayconnects, ast_manager_user::displayconnects, EVENT_FLAG_CALL, EVENT_FLAG_COMMAND, EVENT_FLAG_CONFIG, EVENT_FLAG_SYSTEM, EVENT_FLAG_USER, ast_channel::flags, free, ast_manager_user::keep, LOG_DEBUG, LOG_WARNING, manager_enabled, manager_state_cb(), ast_manager_user::permit, portno, ast_manager_user::read, ast_manager_user::secret, timestampevents, users, var, webmanager_enabled, and ast_manager_user::write.

Referenced by main(), and reload_manager().

03028 {
03029    struct ast_config *cfg = NULL, *ucfg = NULL;
03030    const char *val;
03031    char *cat = NULL;
03032    int oldportno = portno;
03033    static struct sockaddr_in ba;
03034    int x = 1;
03035    int flags;
03036    int newhttptimeout = 60;
03037    struct ast_manager_user *user = NULL;
03038 
03039    if (!registered) {
03040       /* Register default actions */
03041       ast_manager_register2("Ping", 0, action_ping, "Keepalive command", mandescr_ping);
03042       ast_manager_register2("Events", 0, action_events, "Control Event Flow", mandescr_events);
03043       ast_manager_register2("Logoff", 0, action_logoff, "Logoff Manager", mandescr_logoff);
03044       ast_manager_register2("Hangup", EVENT_FLAG_CALL, action_hangup, "Hangup Channel", mandescr_hangup);
03045       ast_manager_register("Status", EVENT_FLAG_CALL, action_status, "Lists channel status" );
03046       ast_manager_register2("Setvar", EVENT_FLAG_CALL, action_setvar, "Set Channel Variable", mandescr_setvar );
03047       ast_manager_register2("Getvar", EVENT_FLAG_CALL, action_getvar, "Gets a Channel Variable", mandescr_getvar );
03048       ast_manager_register2("GetConfig", EVENT_FLAG_CONFIG, action_getconfig, "Retrieve configuration", mandescr_getconfig);
03049       ast_manager_register2("UpdateConfig", EVENT_FLAG_CONFIG, action_updateconfig, "Update basic configuration", mandescr_updateconfig);
03050       ast_manager_register2("Redirect", EVENT_FLAG_CALL, action_redirect, "Redirect (transfer) a call", mandescr_redirect );
03051       ast_manager_register2("Atxfer", EVENT_FLAG_CALL, action_atxfer, "Attended transfer", mandescr_atxfer );
03052       ast_manager_register2("Originate", EVENT_FLAG_CALL, action_originate, "Originate Call", mandescr_originate);
03053       ast_manager_register2("Command", EVENT_FLAG_COMMAND, action_command, "Execute Asterisk CLI Command", mandescr_command );
03054       ast_manager_register2("ExtensionState", EVENT_FLAG_CALL, action_extensionstate, "Check Extension Status", mandescr_extensionstate );
03055       ast_manager_register2("AbsoluteTimeout", EVENT_FLAG_CALL, action_timeout, "Set Absolute Timeout", mandescr_timeout );
03056       ast_manager_register2("MailboxStatus", EVENT_FLAG_CALL, action_mailboxstatus, "Check Mailbox", mandescr_mailboxstatus );
03057       ast_manager_register2("MailboxCount", EVENT_FLAG_CALL, action_mailboxcount, "Check Mailbox Message Count", mandescr_mailboxcount );
03058       ast_manager_register2("ListCommands", 0, action_listcommands, "List available manager commands", mandescr_listcommands);
03059       ast_manager_register2("UserEvent", EVENT_FLAG_USER, action_userevent, "Send an arbitrary event", mandescr_userevent);
03060       ast_manager_register2("CoreSettings", EVENT_FLAG_SYSTEM, action_coresettings, "Show PBX core settings (version etc)", mandescr_coresettings);
03061       ast_manager_register2("CoreStatus", EVENT_FLAG_SYSTEM, action_corestatus, "Show PBX core status variables", mandescr_corestatus);
03062       ast_manager_register2("WaitEvent", 0, action_waitevent, "Wait for an event to occur", mandescr_waitevent);
03063 
03064       ast_cli_register_multiple(cli_manager, sizeof(cli_manager) / sizeof(struct ast_cli_entry));
03065       ast_extension_state_add(NULL, NULL, manager_state_cb, NULL);
03066       registered = 1;
03067       /* Append placeholder event so master_eventq never runs dry */
03068       append_event("Event: Placeholder\r\n\r\n", 0);
03069    }
03070    portno = DEFAULT_MANAGER_PORT;
03071    displayconnects = 1;
03072    cfg = ast_config_load("manager.conf");
03073    if (!cfg) {
03074       ast_log(LOG_NOTICE, "Unable to open management configuration manager.conf.  Call management disabled.\n");
03075       return 0;
03076    }
03077    if ((val = ast_variable_retrieve(cfg, "general", "enabled"))) {
03078       manager_enabled = ast_true(val);
03079    }
03080    if ((val = ast_variable_retrieve(cfg, "general", "block-sockets"))) {
03081       block_sockets = ast_true(val);
03082    }
03083    if((val = ast_variable_retrieve(cfg, "general", "webenabled"))) {
03084       webmanager_enabled = ast_true(val);
03085    }
03086    if ((val = ast_variable_retrieve(cfg, "general", "port"))) {
03087       if (sscanf(val, "%d", &portno) != 1) {
03088          ast_log(LOG_WARNING, "Invalid port number '%s'\n", val);
03089          portno = DEFAULT_MANAGER_PORT;
03090       }
03091    }
03092    if ((val = ast_variable_retrieve(cfg, "general", "displayconnects"))) {
03093       displayconnects = ast_true(val);
03094    }
03095    if ((val = ast_variable_retrieve(cfg, "general", "timestampevents"))) {
03096       timestampevents = ast_true(val);
03097    }
03098    if ((val = ast_variable_retrieve(cfg, "general", "httptimeout"))) {
03099       newhttptimeout = atoi(val);
03100    }
03101 
03102    memset(&ba, 0, sizeof(ba));
03103    ba.sin_family = AF_INET;
03104    ba.sin_port = htons(portno);
03105 
03106    if ((val = ast_variable_retrieve(cfg, "general", "bindaddr"))) {
03107       if (!inet_aton(val, &ba.sin_addr)) { 
03108          ast_log(LOG_WARNING, "Invalid address '%s' specified, using 0.0.0.0\n", val);
03109          memset(&ba.sin_addr, 0, sizeof(ba.sin_addr));
03110       }
03111    }
03112    
03113 
03114    if ((asock > -1) && ((portno != oldportno) || !manager_enabled)) {
03115 #if 0
03116       /* Can't be done yet */
03117       close(asock);
03118       asock = -1;
03119 #else
03120       ast_log(LOG_WARNING, "Unable to change management port / enabled\n");
03121 #endif
03122    }
03123 
03124    AST_LIST_LOCK(&users);
03125 
03126    if ((ucfg = ast_config_load("users.conf"))) {
03127       while ((cat = ast_category_browse(ucfg, cat))) {
03128          int hasmanager = 0;
03129          struct ast_variable *var = NULL;
03130 
03131          if (!strcasecmp(cat, "general")) {
03132             continue;
03133          }
03134 
03135          if (!(hasmanager = ast_true(ast_variable_retrieve(ucfg, cat, "hasmanager")))) {
03136             continue;
03137          }
03138 
03139          /* Look for an existing entry, if none found - create one and add it to the list */
03140          if (!(user = ast_get_manager_by_name_locked(cat))) {
03141             if (!(user = ast_calloc(1, sizeof(*user)))) {
03142                break;
03143             }
03144             /* Copy name over */
03145             ast_copy_string(user->username, cat, sizeof(user->username));
03146             /* Insert into list */
03147             AST_LIST_INSERT_TAIL(&users, user, list);
03148          }
03149 
03150          /* Make sure we keep this user and don't destroy it during cleanup */
03151          user->keep = 1;
03152 
03153          for (var = ast_variable_browse(ucfg, cat); var; var = var->next) {
03154             if (!strcasecmp(var->name, "secret")) {
03155                if (user->secret) {
03156                   free(user->secret);
03157                }
03158                user->secret = ast_strdup(var->value);
03159             } else if (!strcasecmp(var->name, "deny") ) {
03160                if (user->deny) {
03161                   free(user->deny);
03162                }
03163                user->deny = ast_strdup(var->value);
03164             } else if (!strcasecmp(var->name, "permit") ) {
03165                if (user->permit) {
03166                   free(user->permit);
03167                }
03168                user->permit = ast_strdup(var->value);
03169             } else if (!strcasecmp(var->name, "read") ) {
03170                if (user->read) {
03171                   free(user->read);
03172                }
03173                user->read = ast_strdup(var->value);
03174             } else if (!strcasecmp(var->name, "write") ) {
03175                if (user->write) {
03176                   free(user->write);
03177                }
03178                user->write = ast_strdup(var->value);
03179             } else if (!strcasecmp(var->name, "displayconnects") ) {
03180                user->displayconnects = ast_true(var->value);
03181             } else if (!strcasecmp(var->name, "hasmanager")) {
03182                /* already handled */
03183             } else {
03184                ast_log(LOG_DEBUG, "%s is an unknown option (to the manager module).\n", var->name);
03185             }
03186          }
03187       }
03188       ast_config_destroy(ucfg);
03189    }
03190 
03191    while ((cat = ast_category_browse(cfg, cat))) {
03192       struct ast_variable *var = NULL;
03193 
03194       if (!strcasecmp(cat, "general"))
03195          continue;
03196 
03197       /* Look for an existing entry, if none found - create one and add it to the list */
03198       if (!(user = ast_get_manager_by_name_locked(cat))) {
03199          if (!(user = ast_calloc(1, sizeof(*user))))
03200             break;
03201          /* Copy name over */
03202          ast_copy_string(user->username, cat, sizeof(user->username));
03203          /* Insert into list */
03204          AST_LIST_INSERT_TAIL(&users, user, list);
03205       }
03206 
03207       /* Make sure we keep this user and don't destroy it during cleanup */
03208       user->keep = 1;
03209 
03210       var = ast_variable_browse(cfg, cat);
03211       while (var) {
03212          if (!strcasecmp(var->name, "secret")) {
03213             if (user->secret)
03214                free(user->secret);
03215             user->secret = ast_strdup(var->value);
03216          } else if (!strcasecmp(var->name, "deny") ) {
03217             if (user->deny)
03218                free(user->deny);
03219             user->deny = ast_strdup(var->value);
03220          } else if (!strcasecmp(var->name, "permit") ) {
03221             if (user->permit)
03222                free(user->permit);
03223             user->permit = ast_strdup(var->value);
03224          }  else if (!strcasecmp(var->name, "read") ) {
03225             if (user->read)
03226                free(user->read);
03227             user->read = ast_strdup(var->value);
03228          }  else if (!strcasecmp(var->name, "write") ) {
03229             if (user->write)
03230                free(user->write);
03231             user->write = ast_strdup(var->value);
03232          }  else if (!strcasecmp(var->name, "displayconnects") )
03233             user->displayconnects = ast_true(var->value);
03234          else
03235             ast_log(LOG_DEBUG, "%s is an unknown option.\n", var->name);
03236          var = var->next;
03237       }
03238    }
03239 
03240    /* Perform cleanup - essentially prune out old users that no longer exist */
03241    AST_LIST_TRAVERSE_SAFE_BEGIN(&users, user, list) {
03242       if (user->keep) {
03243          user->keep = 0;
03244          continue;
03245       }
03246       /* We do not need to keep this user so take them out of the list */
03247       AST_LIST_REMOVE_CURRENT(&users, list);
03248       /* Free their memory now */
03249       if (user->secret)
03250          free(user->secret);
03251       if (user->deny)
03252          free(user->deny);
03253       if (user->permit)
03254          free(user->permit);
03255       if (user->read)
03256          free(user->read);
03257       if (user->write)
03258          free(user->write);
03259       free(user);
03260    }
03261    AST_LIST_TRAVERSE_SAFE_END
03262 
03263    AST_LIST_UNLOCK(&users);
03264 
03265    ast_config_destroy(cfg);
03266    
03267    if (webmanager_enabled && manager_enabled) {
03268       if (!webregged) {
03269          ast_http_uri_link(&rawmanuri);
03270          ast_http_uri_link(&manageruri);
03271          ast_http_uri_link(&managerxmluri);
03272          webregged = 1;
03273       }
03274    } else {
03275       if (webregged) {
03276          ast_http_uri_unlink(&rawmanuri);
03277          ast_http_uri_unlink(&manageruri);
03278          ast_http_uri_unlink(&managerxmluri);
03279          webregged = 0;
03280       }
03281    }
03282 
03283    if (newhttptimeout > 0)
03284       httptimeout = newhttptimeout;
03285 
03286    /* If not enabled, do nothing */
03287    if (!manager_enabled)
03288       return 0;
03289 
03290    if (asock < 0) {
03291       asock = socket(AF_INET, SOCK_STREAM, 0);
03292       if (asock < 0) {
03293          ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno));
03294          return -1;
03295       }
03296       setsockopt(asock, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
03297       if (bind(asock, (struct sockaddr *)&ba, sizeof(ba))) {
03298          ast_log(LOG_WARNING, "Unable to bind socket: %s\n", strerror(errno));
03299          close(asock);
03300          asock = -1;
03301          return -1;
03302       }
03303       if (listen(asock, 2)) {
03304          ast_log(LOG_WARNING, "Unable to listen on socket: %s\n", strerror(errno));
03305          close(asock);
03306          asock = -1;
03307          return -1;
03308       }
03309       flags = fcntl(asock, F_GETFL);
03310       fcntl(asock, F_SETFL, flags | O_NONBLOCK);
03311       if (option_verbose)
03312          ast_verbose("Asterisk Management interface listening on port %d\n", portno);
03313       ast_pthread_create_background(&t, NULL, accept_thread, NULL);
03314    }
03315    return 0;
03316 }

static char* manager_http_callback ( struct sockaddr_in *  requestor,
const char *  uri,
struct ast_variable params,
int *  status,
char **  title,
int *  contentlength 
) [static]

Definition at line 2988 of file manager.c.

References FORMAT_HTML, and generic_http_callback().

02989 {
02990    return generic_http_callback(FORMAT_HTML, requestor, uri, params, status, title, contentlength);
02991 }

static char* mxml_http_callback ( struct sockaddr_in *  requestor,
const char *  uri,
struct ast_variable params,
int *  status,
char **  title,
int *  contentlength 
) [static]

Definition at line 2993 of file manager.c.

References FORMAT_XML, and generic_http_callback().

02994 {
02995    return generic_http_callback(FORMAT_XML, requestor, uri, params, status, title, contentlength);
02996 }

static char* rawman_http_callback ( struct sockaddr_in *  requestor,
const char *  uri,
struct ast_variable params,
int *  status,
char **  title,
int *  contentlength 
) [static]

Definition at line 2998 of file manager.c.

References FORMAT_RAW, and generic_http_callback().

02999 {
03000    return generic_http_callback(FORMAT_RAW, requestor, uri, params, status, title, contentlength);
03001 }

int reload_manager ( void   ) 

Definition at line 3318 of file manager.c.

References EVENT_FLAG_SYSTEM, init_manager(), and manager_event().

03319 {
03320    manager_event(EVENT_FLAG_SYSTEM, "Reload", "Message: Reload Requested\r\n");
03321    return init_manager();
03322 }


Variable Documentation

char* contenttype[] = { "plain", "html", "xml" } [static]

Definition at line 2832 of file manager.c.

struct ast_http_uri manageruri

Definition at line 3010 of file manager.c.

struct ast_http_uri managerxmluri

Definition at line 3017 of file manager.c.

struct ast_http_uri rawmanuri

Definition at line 3003 of file manager.c.

int registered = 0 [static]

Definition at line 3024 of file manager.c.

int webregged = 0 [static]

Definition at line 3025 of file manager.c.

char* words[AST_MAX_CMD_LEN]

Definition at line 139 of file manager.c.

Referenced by check_blacklist(), and fix_complete_args().


Generated on Mon Nov 24 15:34:45 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7