Wed Mar 4 19:58:45 2009

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  sessions
struct  users
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)
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)
void astman_append (struct mansession *s, const char *fmt,...)
static void astman_append_buf_init (void)
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 void manager_event_buf_init (void)
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 ast_rwlock_t actionlock = PTHREAD_RWLOCK_INITIALIZER
static int asock = -1
static struct ast_threadstorage astman_append_buf = { .once = PTHREAD_ONCE_INIT , .key_init = astman_append_buf_init , }
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
static struct ast_threadstorage manager_event_buf = { .once = PTHREAD_ONCE_INIT , .key_init = manager_event_buf_init , }
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 2838 of file manager.c.

02838      {
02839    FORMAT_RAW,
02840    FORMAT_HTML,
02841    FORMAT_XML,
02842 };


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 2800 of file manager.c.

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

02801 {
02802    int result = 0;
02803    struct mansession *s;
02804 
02805    AST_LIST_LOCK(&sessions);
02806    AST_LIST_TRAVERSE(&sessions, s, list) {
02807       ast_mutex_lock(&s->__lock);
02808       if ((s->managerid == ident) && (s->readperm & perm)) {
02809          result = 1;
02810          ast_mutex_unlock(&s->__lock);
02811          break;
02812       }
02813       ast_mutex_unlock(&s->__lock);
02814    }
02815    AST_LIST_UNLOCK(&sessions);
02816    return result;
02817 }

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 2819 of file manager.c.

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

02820 {
02821    int result = 0;
02822    struct mansession *s;
02823 
02824    AST_LIST_LOCK(&sessions);
02825    AST_LIST_TRAVERSE(&sessions, s, list) {
02826       ast_mutex_lock(&s->__lock);
02827       if ((s->managerid == ident) && (s->writeperm & perm)) {
02828          result = 1;
02829          ast_mutex_unlock(&s->__lock);
02830          break;
02831       }
02832       ast_mutex_unlock(&s->__lock);
02833    }
02834    AST_LIST_UNLOCK(&sessions);
02835    return result;
02836 }

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

END Doxygen group

Definition at line 2782 of file manager.c.

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

02783 {
02784    struct mansession *s;
02785 
02786    AST_LIST_LOCK(&sessions);
02787    AST_LIST_TRAVERSE(&sessions, s, list) {
02788       ast_mutex_lock(&s->__lock);
02789       if (s->sessiontimeout && (s->managerid == ident) && !s->needdestroy) {
02790          s->inuse++;
02791          break;
02792       }
02793       ast_mutex_unlock(&s->__lock);
02794    }
02795    AST_LIST_UNLOCK(&sessions);
02796 
02797    return s;
02798 }

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 2845 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().

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

int init_manager ( void   ) 

Called by Asterisk initialization

Definition at line 3038 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_copy_string(), 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, var, webmanager_enabled, and ast_manager_user::write.

Referenced by main(), and reload_manager().

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

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 2999 of file manager.c.

References FORMAT_HTML, and generic_http_callback().

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

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 3004 of file manager.c.

References FORMAT_XML, and generic_http_callback().

03005 {
03006    return generic_http_callback(FORMAT_XML, requestor, uri, params, status, title, contentlength);
03007 }

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 3009 of file manager.c.

References FORMAT_RAW, and generic_http_callback().

03010 {
03011    return generic_http_callback(FORMAT_RAW, requestor, uri, params, status, title, contentlength);
03012 }

int reload_manager ( void   ) 

Definition at line 3329 of file manager.c.

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

03330 {
03331    manager_event(EVENT_FLAG_SYSTEM, "Reload", "Message: Reload Requested\r\n");
03332    return init_manager();
03333 }


Variable Documentation

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

Definition at line 2843 of file manager.c.

struct ast_http_uri manageruri

Definition at line 3021 of file manager.c.

struct ast_http_uri managerxmluri

Definition at line 3028 of file manager.c.

struct ast_http_uri rawmanuri

Definition at line 3014 of file manager.c.

int registered = 0 [static]

Definition at line 3035 of file manager.c.

int webregged = 0 [static]

Definition at line 3036 of file manager.c.

char* words[AST_MAX_CMD_LEN]

Definition at line 140 of file manager.c.

Referenced by check_blacklist(), and fix_complete_args().


Generated on Wed Mar 4 19:58:45 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7