Asterisk - The Open Source Telephony Project GIT-master-80b953f
Loading...
Searching...
No Matches
Data Structures | Macros | Enumerations | Functions | Variables
AMI functions

Data Structures

struct  actions
 list of actions registered More...
 
struct  all_events
 
struct  ast_manager_user
 user descriptor, as read from the config file. More...
 
struct  event_filter_entry
 
struct  eventqent
 
struct  fast_originate_helper
 helper function for originate More...
 
struct  manager_hooks
 list of hooks registered More...
 
struct  mansession
 In case you didn't read that giant block of text above the mansession_session struct, the mansession is named this solely to keep the API the same in Asterisk. This structure really represents data that is different from Manager action to Manager action. The mansession_session pointer contained within points to session-specific data. More...
 
struct  mansession_session
 
struct  originate_permissions_entry
 
struct  permalias
 
struct  users
 list of users found in the config file More...
 

Macros

#define any_manager_listeners(sessions)    ((sessions && ao2_container_count(sessions)) || !AST_RWLIST_EMPTY(&manager_hooks))
 
#define ASTMAN_APPEND_BUF_INITSIZE   256
 initial allocated size for the astman_append_buf and astman_send_*_va
 
#define DEFAULT_REALM   "asterisk"
 
#define EVENT_FLAG_SHUTDOWN   -1
 Fake event class used to end sessions at shutdown.
 
#define GET_HEADER_FIRST_MATCH   0
 
#define GET_HEADER_LAST_MATCH   1
 
#define GET_HEADER_SKIP_EMPTY   2
 
#define MANAGER_EVENT_BUF_INITSIZE   256
 
#define manager_event_sessions(sessions, category, event, contents, ...)    __manager_event_sessions(sessions, category, event, 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
 
#define MAX_AUTH_PERM_STRING   150
 
#define MAX_BLACKLIST_CMD_LEN   2
 Descriptor for a manager session, either on the AMI socket or over HTTP.
 
#define MAX_VARS   128
 
#define MGR_SHOW_TERMINAL_WIDTH   80
 
#define MSG_MOREDATA   ((char *)astman_send_response)
 

Enumerations

enum  add_filter_result { FILTER_SUCCESS = 0 , FILTER_ALLOC_FAILED , FILTER_COMPILE_FAIL , FILTER_FORMAT_ERROR }
 
enum  error_type {
  UNKNOWN_ACTION = 1 , UNKNOWN_CATEGORY , UNSPECIFIED_CATEGORY , UNSPECIFIED_ARGUMENT ,
  FAILURE_ALLOCATION , FAILURE_NEWCAT , FAILURE_DELCAT , FAILURE_EMPTYCAT ,
  FAILURE_UPDATE , FAILURE_DELETE , FAILURE_APPEND , FAILURE_TEMPLATE
}
 
enum  event_filter_match_type {
  FILTER_MATCH_REGEX = 0 , FILTER_MATCH_EXACT , FILTER_MATCH_STARTS_WITH , FILTER_MATCH_ENDS_WITH ,
  FILTER_MATCH_CONTAINS , FILTER_MATCH_NONE
}
 
enum  mansession_message_parsing { MESSAGE_OKAY , MESSAGE_LINE_TOO_LONG }
 

Functions

int __ast_manager_event_multichan (int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt,...)
 
static const char * __astman_get_header (const struct message *m, char *var, int mode)
 Return a matching header value.
 
static int __manager_event_sessions (struct ao2_container *sessions, int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt,...)
 
static int __manager_event_sessions_va (struct ao2_container *sessions, int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt, va_list ap)
 
static void acl_change_stasis_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void acl_change_stasis_subscribe (void)
 
static void acl_change_stasis_unsubscribe (void)
 
static struct ast_aoc_decodedaction_aoc_de_message (struct mansession *s, const struct message *m)
 
static struct ast_aoc_decodedaction_aoc_s_message (struct mansession *s, const struct message *m)
 
static int action_aoc_s_submessage (struct mansession *s, const struct message *m, struct ast_aoc_decoded *decoded)
 
static int action_aocmessage (struct mansession *s, const struct message *m)
 
static int action_atxfer (struct mansession *s, const struct message *m)
 
static int action_blind_transfer (struct mansession *s, const struct message *m)
 
static int action_cancel_atxfer (struct mansession *s, const struct message *m)
 
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_coresettings (struct mansession *s, const struct message *m)
 Show PBX core settings information.
 
static int action_coreshowchannelmap (struct mansession *s, const struct message *m)
 Manager command "CoreShowChannelMap" - Lists all channels connected to the specified channel.
 
static int action_coreshowchannels (struct mansession *s, const struct message *m)
 Manager command "CoreShowChannels" - List currently defined channels and some information about them.
 
static int action_corestatus (struct mansession *s, const struct message *m)
 Show PBX core status information.
 
static int action_createconfig (struct mansession *s, const struct message *m)
 
static void action_destroy (void *obj)
 
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_filter (struct mansession *s, const struct message *m)
 Manager command to add an event filter to a manager session.
 
static struct manager_actionaction_find (const char *name)
 
static int action_getconfig (struct mansession *s, const struct message *m)
 
static int action_getconfigjson (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_listcategories (struct mansession *s, const struct message *m)
 
static int action_listcommands (struct mansession *s, const struct message *m)
 
static int action_loggerrotate (struct mansession *s, const struct message *m)
 Manager command "LoggerRotate" - reloads and rotates the logger in the same manner as the CLI command 'logger rotate'.
 
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_presencestate (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_reload (struct mansession *s, const struct message *m)
 Send a reload event.
 
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 struct eventqentadvance_event (struct eventqent *e)
 
static AO2_GLOBAL_OBJ_STATIC (event_docs)
 A container of event documentation nodes.
 
static AO2_GLOBAL_OBJ_STATIC (mgr_sessions)
 
static int aocmessage_get_unit_entry (const struct message *m, struct ast_aoc_unit_entry *entry, unsigned int entry_num)
 
static int app_match (const char *app, const char *data, const char *search)
 
static int appdata_match (const char *app, const char *data, const char *search)
 
static void append_channel_vars (struct ast_str **pbuf, struct ast_channel *chan)
 
static int append_event (const char *str, int event_name_hash, int category)
 events are appended to a queue from where they can be dispatched to clients.
 
int ast_hook_send_action (struct manager_custom_hook *hook, const char *msg)
 access for hooks to send action messages to ami
 
static int ast_instring (const char *bigstr, const char *smallstr, const char delim)
 
int ast_manager_check_enabled (void)
 Check if AMI is enabled.
 
struct stasis_message_routerast_manager_get_message_router (void)
 Get the stasis_message_router for AMI.
 
struct stasis_topicast_manager_get_topic (void)
 Get the Stasis Message Bus API topic for AMI.
 
int ast_manager_hangup_helper (struct mansession *s, const struct message *m, manager_hangup_handler_t hangup_handler, manager_hangup_cause_validator_t cause_validator)
 A manager helper function that hangs up a channel using a supplied channel type specific hangup function and cause code validator.
 
void ast_manager_publish_event (const char *type, int class_type, struct ast_json *obj)
 Publish an event to AMI.
 
int ast_manager_register2 (const char *action, int auth, int(*func)(struct mansession *s, const struct message *m), struct ast_module *module, 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)
 
struct ast_strast_manager_str_from_json_object (struct ast_json *blob, key_exclusion_cb exclusion_cb)
 Convert a JSON object into an AMI compatible string.
 
int ast_manager_unregister (const char *action)
 support functions to register/unregister AMI action handlers,
 
void ast_manager_unregister_hook (struct manager_custom_hook *hook)
 Delete a custom hook to be called when an event is fired.
 
 AST_THREADSTORAGE_CUSTOM_SCOPE (astman_append_buf, NULL, ast_free_ptr, static)
 thread local buffer for astman_append
 
 AST_THREADSTORAGE_CUSTOM_SCOPE (manager_event_buf, NULL, ast_free_ptr, static)
 
 AST_THREADSTORAGE_CUSTOM_SCOPE (userevent_buf, NULL, ast_free_ptr, static)
 
int ast_webmanager_check_enabled (void)
 Check if AMI/HTTP is enabled.
 
void astman_append (struct mansession *s, const char *fmt,...)
 
static void astman_append_headers (struct message *m, const struct ast_variable *params)
 Append additional headers into the message structure from params.
 
static void astman_append_json (struct mansession *s, const char *str)
 
static void astman_flush (struct mansession *s, struct ast_str *buf)
 
static void astman_free_headers (struct message *m)
 Free headers inside message structure, but not the message structure itself.
 
const char * astman_get_header (const struct message *m, char *var)
 Return the first matching variable from an array.
 
struct ast_variableastman_get_variables (const struct message *m)
 Get a linked list of the Variable: headers.
 
struct ast_variableastman_get_variables_order (const struct message *m, enum variable_orders order)
 Get a linked list of the Variable: headers with order specified.
 
void astman_live_dangerously (int new_live_dangerously)
 Enable/disable the inclusion of 'dangerous' configurations outside of the ast_config_AST_CONFIG_DIR.
 
void astman_send_ack (struct mansession *s, const struct message *m, char *msg)
 Send ack in manager transaction.
 
void astman_send_error (struct mansession *s, const struct message *m, char *error)
 Send error in manager transaction.
 
void astman_send_error_va (struct mansession *s, const struct message *m, const char *fmt,...)
 Send error in manager transaction (with va_args support)
 
static void astman_send_list_complete (struct mansession *s, const struct message *m, const char *event_name, int count)
 
void astman_send_list_complete_end (struct mansession *s)
 End the list complete event.
 
void astman_send_list_complete_start (struct mansession *s, const struct message *m, const char *event_name, int count)
 Start the list complete event.
 
static struct ast_strastman_send_list_complete_start_common (struct mansession *s, const struct message *m, const char *event_name, int count)
 
void astman_send_listack (struct mansession *s, const struct message *m, char *msg, char *listflag)
 Send ack in manager transaction to begin a list.
 
void astman_send_response (struct mansession *s, const struct message *m, char *resp, char *msg)
 Send response in manager transaction.
 
static void astman_send_response_full (struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
 send a response with an optional message, and terminate it with an empty line. m is used only to grab the 'ActionID' field.
 
static void astman_start_ack (struct mansession *s, const struct message *m)
 
static int async_goto_with_discard_bridge_after (struct ast_channel *chan, const char *context, const char *exten, int priority)
 
static int authenticate (struct mansession *s, const struct message *m)
 
static const char * authority_to_str (int authority, struct ast_str **res)
 Convert authority code to a list of options. Note that the EVENT_FLAG_ALL authority will always be returned.
 
static struct mansession_sessionbuild_mansession (const struct ast_sockaddr *addr)
 Allocate manager session structure and add it to the list of sessions.
 
static int check_blacklist (const char *cmd)
 
static int check_manager_session_inuse (const char *name)
 
static int coreshowchannelmap_add_connected_channels (struct ao2_container *channel_map, struct ast_channel_snapshot *channel_snapshot, struct ast_bridge_snapshot *bridge_snapshot)
 Recursive function to get all channels in a bridge. Follow local channels as well.
 
static int coreshowchannelmap_add_to_map (struct ao2_container *c, const char *s)
 Helper function to add a channel name to the vector.
 
static void destroy_fast_originate_helper (struct fast_originate_helper *doomed)
 
static int do_message (struct mansession *s)
 
static void event_filter_destructor (void *obj)
 
static void * fast_originate (void *data)
 
static int file_in_modules_dir (const char *filename)
 Check if the given file path is in the modules dir or not.
 
static int filter_cmp_fn (void *obj, void *arg, void *data, int flags)
 
static int function_capable_string_allowed_with_auths (const char *evaluating, int writepermlist)
 Checks to see if a string which can be used to evaluate functions should be rejected.
 
static void generate_status (struct mansession *s, struct ast_channel *chan, char **vars, int varc, int all_variables, char *id_text, int *count)
 
static int get_input (struct mansession *s, char *output)
 
static struct ast_manager_userget_manager_by_name_locked (const char *name)
 
static int get_perm (const char *instr)
 
static struct eventqentgrab_last (void)
 
static char * handle_kickmanconn (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager kick session.
 
static char * handle_manager_reload (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager reload.
 
static char * handle_mandebug (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static void handle_parse_error (struct mansession *s, struct message *m, char *error)
 
static char * handle_showmanager (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmanagers (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmancmd (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmancmds (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list commands.
 
static char * handle_showmanconn (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list connected.
 
static char * handle_showmaneventq (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list eventq.
 
static enum error_type handle_updates (struct mansession *s, const struct message *m, struct ast_config *cfg, const char *dfn)
 helper function for action_updateconfig
 
static int is_originate_app_permitted (const char *app, const char *data, int permission)
 
static int is_restricted_file (const char *filename)
 Check if a file is restricted or not.
 
static void json_escape (char *out, const char *in)
 
static void log_action (const struct message *m, const char *action)
 
static struct ast_variableman_do_variable_value (struct ast_variable *head, const char *hdr_val)
 
static enum add_filter_result manager_add_filter (const char *criteria, const char *filter_pattern, struct ao2_container *includefilters, struct ao2_container *excludefilters)
 Add an event filter to a manager session.
 
static void manager_default_msg_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int manager_displayconnects (struct mansession_session *session)
 Get displayconnects config option.
 
static void manager_generic_msg_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void manager_json_array_with_key (struct ast_json *obj, const char *key, size_t index, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_obj_with_key (struct ast_json *obj, const char *key, const char *parent_key, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_to_ast_str (struct ast_json *obj, const char *key, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_value_str_append (struct ast_json *value, const char *key, struct ast_str **res)
 
static int manager_modulecheck (struct mansession *s, const struct message *m)
 Manager function to check if module is loaded.
 
static int manager_moduleload (struct mansession *s, const struct message *m)
 
static int manager_state_cb (const char *context, const char *exten, struct ast_state_cb_info *info, void *data)
 
static int mansession_cmp_fn (void *obj, void *arg, int flags)
 
static enum ast_transport mansession_get_transport (const struct mansession *s)
 
static void mansession_lock (struct mansession *s)
 Lock the 'mansession' structure.
 
static void mansession_unlock (struct mansession *s)
 Unlock the 'mansession' structure.
 
static int match_eventdata (struct event_filter_entry *entry, const char *eventdata)
 Test eventdata against a filter entry.
 
static void print_event_instance (struct ast_cli_args *a, struct ast_xml_doc_item *instance)
 
static int process_events (struct mansession *s)
 
static int process_message (struct mansession *s, const struct message *m)
 Process an AMI message, performing desired action. Return 0 on success, -1 on error that require the session to be destroyed.
 
static void purge_events (void)
 
static int purge_sessions (int n_max)
 remove at most n_max stale session from the list.
 
static int queue_match (const char *app, const char *data, const char *search)
 
static int queue_read_action_payload (struct ast_channel *chan, const unsigned char *payload, size_t payload_size, enum ast_frame_read_action action)
 Queue a given read action containing a payload onto a channel.
 
static int queue_sendtext (struct ast_channel *chan, const char *body)
 Queue a read action to send a text message.
 
static int queue_sendtext_data (struct ast_channel *chan, const char *body, const char *content_type)
 Queue a read action to send a text data message.
 
static int reload_module (void)
 
static void report_auth_success (const struct mansession *s)
 
static void report_failed_acl (const struct mansession *s, const char *username)
 
static void report_failed_challenge_response (const struct mansession *s, const char *response, const char *expected_response)
 
static void report_inval_password (const struct mansession *s, const char *username)
 
static void report_invalid_user (const struct mansession *s, const char *username)
 
static void report_req_bad_format (const struct mansession *s, const char *action)
 
static void report_req_not_allowed (const struct mansession *s, const char *action)
 
static void report_session_limit (const struct mansession *s)
 
static int send_string (struct mansession *s, char *string)
 
static void session_destroy (struct mansession_session *s)
 
static void session_destructor (void *obj)
 
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 should_send_event (struct ao2_container *includefilters, struct ao2_container *excludefilters, struct eventqent *eqe)
 
static int strings_to_mask (const char *string)
 
static struct mansession_sessionunref_mansession (struct mansession_session *s)
 Unreference manager session object. If no more references, then go ahead and delete it.
 
static const char * user_authority_to_str (int authority, struct ast_str **res)
 Convert authority code to a list of options for a user. This will only display those authority codes that have an explicit match on authority.
 

Variables

static struct stasis_subscriptionacl_change_sub
 
static struct actions actions = AST_RWLIST_HEAD_INIT_VALUE
 
static struct all_events all_events = AST_RWLIST_HEAD_INIT_VALUE
 
static int allowmultiplelogin = 1
 
static int authlimit
 
static int authtimeout
 
static int broken_events_action = 0
 
struct { 
 
   const char *   words [AST_MAX_CMD_LEN
 
command_blacklist [] 
 
static int displayconnects = 1
 
static char global_realm [MAXHOSTNAMELEN]
 
static int httptimeout = 60
 
static int live_dangerously
 Set to true (non-zero) to globally allow all dangerous AMI actions to run.
 
static char * manager_channelvars
 
static int manager_debug = 0
 
static char * manager_disabledevents
 
static int manager_enabled = 0
 
static struct manager_hooks manager_hooks = AST_RWLIST_HEAD_INIT_VALUE
 
static struct stasis_topicmanager_topic
 A stasis_topic that all topics AMI cares about will be forwarded to.
 
static char * match_type_names []
 
static struct originate_permissions_entry originate_app_permissions []
 
static const struct permalias perms []
 
static struct stasis_forwardrtp_topic_forwarder
 The stasis_subscription for forwarding the RTP topic to the AMI topic.
 
static struct stasis_forwardsecurity_topic_forwarder
 The stasis_subscription for forwarding the Security topic to the AMI topic.
 
static struct stasis_message_routerstasis_router
 The stasis_message_router for all Stasis Message Bus API messages.
 
static int subscribed = 0
 
static int timestampevents
 
static int unauth_sessions = 0
 
static struct users users = AST_RWLIST_HEAD_INIT_VALUE
 
static int webmanager_enabled = 0
 
 STASIS_MESSAGE_TYPE_DEFN (ast_manager_get_generic_type)
 Define AMI message types.
 

Detailed Description

Macro Definition Documentation

◆ any_manager_listeners

#define any_manager_listeners (   sessions)     ((sessions && ao2_container_count(sessions)) || !AST_RWLIST_EMPTY(&manager_hooks))

Definition at line 565 of file manager.c.

◆ ASTMAN_APPEND_BUF_INITSIZE

#define ASTMAN_APPEND_BUF_INITSIZE   256

initial allocated size for the astman_append_buf and astman_send_*_va

Definition at line 1895 of file manager.c.

◆ DEFAULT_REALM

#define DEFAULT_REALM   "asterisk"

Definition at line 175 of file manager.c.

◆ EVENT_FLAG_SHUTDOWN

#define EVENT_FLAG_SHUTDOWN   -1

Fake event class used to end sessions at shutdown.

Definition at line 208 of file manager.c.

◆ GET_HEADER_FIRST_MATCH

#define GET_HEADER_FIRST_MATCH   0

Definition at line 1595 of file manager.c.

◆ GET_HEADER_LAST_MATCH

#define GET_HEADER_LAST_MATCH   1

Definition at line 1596 of file manager.c.

◆ GET_HEADER_SKIP_EMPTY

#define GET_HEADER_SKIP_EMPTY   2

Definition at line 1597 of file manager.c.

◆ MANAGER_EVENT_BUF_INITSIZE

#define MANAGER_EVENT_BUF_INITSIZE   256

Definition at line 7545 of file manager.c.

◆ manager_event_sessions

#define manager_event_sessions (   sessions,
  category,
  event,
  contents,
  ... 
)     __manager_event_sessions(sessions, category, event, 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)

Definition at line 562 of file manager.c.

◆ MAX_AUTH_PERM_STRING

#define MAX_AUTH_PERM_STRING   150

Maximum string length of the AMI authority permission string buildable from perms[].

Definition at line 774 of file manager.c.

◆ MAX_BLACKLIST_CMD_LEN

#define MAX_BLACKLIST_CMD_LEN   2

Descriptor for a manager session, either on the AMI socket or over HTTP.

Note
AMI session have managerid == 0; the entry is created upon a connect, and destroyed with the socket. HTTP sessions have managerid != 0, the value is used as a search key to lookup sessions (using the mansession_id cookie, or nonce key from Digest Authentication http header).

Definition at line 220 of file manager.c.

◆ MAX_VARS

#define MAX_VARS   128

Definition at line 205 of file manager.c.

◆ MGR_SHOW_TERMINAL_WIDTH

#define MGR_SHOW_TERMINAL_WIDTH   80

Definition at line 203 of file manager.c.

◆ MSG_MOREDATA

#define MSG_MOREDATA   ((char *)astman_send_response)
Note
NOTE: XXX this comment is unclear and possibly wrong. Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER hold the session lock or be running in an action callback (in which case s->session->busy will be non-zero). In either of these cases, there is no need to lock-protect the session's fd, since no other output will be sent (events will be queued), and no input will be read until either the current action finishes or get_input() obtains the session lock.
Todo:
XXX MSG_MOREDATA should go to a header file.

Definition at line 1943 of file manager.c.

Enumeration Type Documentation

◆ add_filter_result

Enumerator
FILTER_SUCCESS 
FILTER_ALLOC_FAILED 
FILTER_COMPILE_FAIL 
FILTER_FORMAT_ERROR 

Definition at line 123 of file manager.c.

123 {
124 FILTER_SUCCESS = 0,
128};
@ FILTER_SUCCESS
Definition manager.c:124
@ FILTER_FORMAT_ERROR
Definition manager.c:127
@ FILTER_COMPILE_FAIL
Definition manager.c:126
@ FILTER_ALLOC_FAILED
Definition manager.c:125

◆ error_type

enum error_type

Doxygen group

Enumerator
UNKNOWN_ACTION 
UNKNOWN_CATEGORY 
UNSPECIFIED_CATEGORY 
UNSPECIFIED_ARGUMENT 
FAILURE_ALLOCATION 
FAILURE_NEWCAT 
FAILURE_DELCAT 
FAILURE_EMPTYCAT 
FAILURE_UPDATE 
FAILURE_DELETE 
FAILURE_APPEND 
FAILURE_TEMPLATE 

Definition at line 108 of file manager.c.

108 {
109 UNKNOWN_ACTION = 1,
121};
@ FAILURE_EMPTYCAT
Definition manager.c:116
@ FAILURE_UPDATE
Definition manager.c:117
@ FAILURE_NEWCAT
Definition manager.c:114
@ FAILURE_DELETE
Definition manager.c:118
@ FAILURE_APPEND
Definition manager.c:119
@ UNKNOWN_CATEGORY
Definition manager.c:110
@ FAILURE_DELCAT
Definition manager.c:115
@ FAILURE_ALLOCATION
Definition manager.c:113
@ FAILURE_TEMPLATE
Definition manager.c:120
@ UNSPECIFIED_CATEGORY
Definition manager.c:111
@ UNSPECIFIED_ARGUMENT
Definition manager.c:112
@ UNKNOWN_ACTION
Definition manager.c:109

◆ event_filter_match_type

Enumerator
FILTER_MATCH_REGEX 
FILTER_MATCH_EXACT 
FILTER_MATCH_STARTS_WITH 
FILTER_MATCH_ENDS_WITH 
FILTER_MATCH_CONTAINS 
FILTER_MATCH_NONE 

Definition at line 385 of file manager.c.

385 {
392};
@ FILTER_MATCH_ENDS_WITH
Definition manager.c:389
@ FILTER_MATCH_CONTAINS
Definition manager.c:390
@ FILTER_MATCH_STARTS_WITH
Definition manager.c:388
@ FILTER_MATCH_REGEX
Definition manager.c:386
@ FILTER_MATCH_NONE
Definition manager.c:391
@ FILTER_MATCH_EXACT
Definition manager.c:387

◆ mansession_message_parsing

Enumerator
MESSAGE_OKAY 
MESSAGE_LINE_TOO_LONG 

Definition at line 313 of file manager.c.

313 {
316};
@ MESSAGE_OKAY
Definition manager.c:314
@ MESSAGE_LINE_TOO_LONG
Definition manager.c:315

Function Documentation

◆ __ast_manager_event_multichan()

int __ast_manager_event_multichan ( int  category,
const char *  event,
int  chancount,
struct ast_channel **  chans,
const char *  file,
int  line,
const char *  func,
const char *  contents,
  ... 
)

External routines may send asterisk manager events this way

Parameters
categoryEvent category, matches manager authorization
eventEvent name
chancountNumber of channels in chans parameter
chansA pointer to an array of channels involved in the event
file,line,func
contentsFormat string describing event
...
Since
1.8

Definition at line 7679 of file manager.c.

7682{
7683 struct ao2_container *sessions = ao2_global_obj_ref(mgr_sessions);
7684 va_list ap;
7685 int res;
7686
7688 /* Nobody is listening */
7690 return 0;
7691 }
7692
7693 va_start(ap, fmt);
7695 file, line, func, fmt, ap);
7696 va_end(ap);
7698 return res;
7699}
#define ao2_cleanup(obj)
Definition astobj2.h:1934
#define ao2_global_obj_ref(holder)
Get a reference to the object stored in the global holder.
Definition astobj2.h:918
static struct unistimsession * sessions
static int chancount
Definition channel.c:97
#define any_manager_listeners(sessions)
Definition manager.c:565
static int __manager_event_sessions_va(struct ao2_container *sessions, int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt, va_list ap)
Definition manager.c:7547
Generic container type.
Definition astman.c:88

References __manager_event_sessions_va(), any_manager_listeners, ao2_cleanup, ao2_global_obj_ref, chancount, ast_category::file, and sessions.

◆ __astman_get_header()

static const char * __astman_get_header ( const struct message m,
char *  var,
int  mode 
)
static

Return a matching header value.

Generic function to return either the first or the last matching header from a list of variables, possibly skipping empty strings.

Note
At the moment there is only one use of this function in this file, so we make it static.
Never returns NULL.

Definition at line 1612 of file manager.c.

1613{
1614 int x, l = strlen(var);
1615 const char *result = "";
1616
1617 if (!m) {
1618 return result;
1619 }
1620
1621 for (x = 0; x < m->hdrcount; x++) {
1622 const char *h = m->headers[x];
1623 if (!strncasecmp(var, h, l) && h[l] == ':') {
1624 const char *value = h + l + 1;
1625 value = ast_skip_blanks(value); /* ignore leading spaces in the value */
1626 /* found a potential candidate */
1627 if ((mode & GET_HEADER_SKIP_EMPTY) && ast_strlen_zero(value)) {
1628 continue; /* not interesting */
1629 }
1630 if (mode & GET_HEADER_LAST_MATCH) {
1631 result = value; /* record the last match so far */
1632 } else {
1633 return value;
1634 }
1635 }
1636 }
1637
1638 return result;
1639}
#define var
Definition ast_expr2f.c:605
static PGresult * result
Definition cel_pgsql.c:84
#define GET_HEADER_LAST_MATCH
Definition manager.c:1596
#define GET_HEADER_SKIP_EMPTY
Definition manager.c:1597
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
char *attribute_pure ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition strings.h:161
unsigned int hdrcount
Definition manager.h:150
const char * headers[AST_MAX_MANHEADERS]
Definition manager.h:151
int value
Definition syslog.c:37

References ast_skip_blanks(), ast_strlen_zero(), GET_HEADER_LAST_MATCH, GET_HEADER_SKIP_EMPTY, message::hdrcount, message::headers, result, value, and var.

Referenced by action_aoc_s_submessage(), astman_get_header(), and process_message().

◆ __manager_event_sessions()

static int __manager_event_sessions ( struct ao2_container sessions,
int  category,
const char *  event,
int  chancount,
struct ast_channel **  chans,
const char *  file,
int  line,
const char *  func,
const char *  fmt,
  ... 
)
static

Definition at line 7657 of file manager.c.

7668{
7669 va_list ap;
7670 int res;
7671
7672 va_start(ap, fmt);
7674 chancount, chans, file, line, func, fmt, ap);
7675 va_end(ap);
7676 return res;
7677}

References __manager_event_sessions_va(), chancount, ast_category::file, and sessions.

◆ __manager_event_sessions_va()

static int __manager_event_sessions_va ( struct ao2_container sessions,
int  category,
const char *  event,
int  chancount,
struct ast_channel **  chans,
const char *  file,
int  line,
const char *  func,
const char *  fmt,
va_list  ap 
)
static

Definition at line 7547 of file manager.c.

7558{
7560 const char *cat_str;
7561 struct timeval now;
7562 struct ast_str *buf;
7563 int i;
7564 int event_name_hash;
7565
7568 ast_debug(3, "AMI Event '%s' is globally disabled, skipping\n", event);
7569 /* Event is globally disabled */
7570 return -1;
7571 }
7572 }
7573
7574 buf = ast_str_thread_get(&manager_event_buf, MANAGER_EVENT_BUF_INITSIZE);
7575 if (!buf) {
7576 return -1;
7577 }
7578
7579 cat_str = authority_to_str(category, &auth);
7580 ast_str_set(&buf, 0,
7581 "Event: %s\r\n"
7582 "Privilege: %s\r\n",
7583 event, cat_str);
7584
7585 if (timestampevents) {
7586 now = ast_tvnow();
7587 ast_str_append(&buf, 0,
7588 "Timestamp: %ld.%06lu\r\n",
7589 (long)now.tv_sec, (unsigned long) now.tv_usec);
7590 }
7591 if (manager_debug) {
7592 static int seq;
7593
7594 ast_str_append(&buf, 0,
7595 "SequenceNumber: %d\r\n",
7597 ast_str_append(&buf, 0,
7598 "File: %s\r\n"
7599 "Line: %d\r\n"
7600 "Func: %s\r\n",
7601 file, line, func);
7602 }
7604 ast_str_append(&buf, 0,
7605 "SystemName: %s\r\n",
7607 }
7608
7609 ast_str_append_va(&buf, 0, fmt, ap);
7610 for (i = 0; i < chancount; i++) {
7612 }
7613
7614 ast_str_append(&buf, 0, "\r\n");
7615
7616 event_name_hash = ast_str_hash(event);
7617
7618 append_event(ast_str_buffer(buf), event_name_hash, category);
7619
7620 /* Wake up any sleeping sessions */
7621 if (sessions) {
7622 struct ao2_iterator iter;
7624
7625 iter = ao2_iterator_init(sessions, 0);
7626 while ((session = ao2_iterator_next(&iter))) {
7627 ast_mutex_lock(&session->notify_lock);
7628 if (session->waiting_thread != AST_PTHREADT_NULL) {
7629 pthread_kill(session->waiting_thread, SIGURG);
7630 } else {
7631 /* We have an event to process, but the mansession is
7632 * not waiting for it. We still need to indicate that there
7633 * is an event waiting so that get_input processes the pending
7634 * event instead of polling.
7635 */
7636 session->pending_event = 1;
7637 }
7638 ast_mutex_unlock(&session->notify_lock);
7640 }
7641 ao2_iterator_destroy(&iter);
7642 }
7643
7644 if (category != EVENT_FLAG_SHUTDOWN && !AST_RWLIST_EMPTY(&manager_hooks)) {
7645 struct manager_custom_hook *hook;
7646
7649 hook->helper(category, event, ast_str_buffer(buf));
7650 }
7652 }
7653
7654 return 0;
7655}
static volatile unsigned int seq
Definition app_sms.c:126
static struct ast_mansession session
#define ao2_iterator_next(iter)
Definition astobj2.h:1911
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
char buf[BUFSIZE]
Definition eagi_proxy.c:66
static int append_event(const char *str, int event_name_hash, int category)
events are appended to a queue from where they can be dispatched to clients.
Definition manager.c:7502
static int manager_debug
Definition manager.c:169
static void append_channel_vars(struct ast_str **pbuf, struct ast_channel *chan)
Definition manager.c:7527
static struct mansession_session * unref_mansession(struct mansession_session *s)
Unreference manager session object. If no more references, then go ahead and delete it.
Definition manager.c:914
static const char * authority_to_str(int authority, struct ast_str **res)
Convert authority code to a list of options. Note that the EVENT_FLAG_ALL authority will always be re...
Definition manager.c:815
#define MAX_AUTH_PERM_STRING
Definition manager.c:774
static int timestampevents
Definition manager.c:163
#define EVENT_FLAG_SHUTDOWN
Fake event class used to end sessions at shutdown.
Definition manager.c:208
#define MANAGER_EVENT_BUF_INITSIZE
Definition manager.c:7545
static char * manager_disabledevents
Definition manager.c:173
#define ast_debug(level,...)
Log a DEBUG message.
#define AST_RWLIST_EMPTY
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
#define AST_RWLIST_TRAVERSE
#define AST_PTHREADT_NULL
Definition lock.h:73
#define ast_mutex_unlock(a)
Definition lock.h:197
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition lock.h:764
#define ast_mutex_lock(a)
Definition lock.h:196
const char * ast_config_AST_SYSTEM_NAME
Definition options.c:171
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition strings.h:1139
static force_inline int attribute_pure ast_str_hash(const char *str)
Compute a hash value on a string.
Definition strings.h:1259
#define ast_str_alloca(init_len)
Definition strings.h:848
int ast_in_delimited_string(const char *needle, const char *haystack, char delim)
Check if there is an exact match for 'needle' between delimiters in 'haystack'.
Definition strings.c:466
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition strings.h:1113
int ast_str_append_va(struct ast_str **buf, ssize_t max_len, const char *fmt, va_list ap)
Append to a dynamic string using a va_list.
Definition strings.h:1048
char *attribute_pure ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition strings.h:761
struct ast_str * ast_str_thread_get(struct ast_threadstorage *ts, size_t init_len)
Retrieve a thread locally stored dynamic string.
Definition strings.h:909
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition astobj2.h:1821
Support for dynamic strings.
Definition strings.h:623
struct manager_custom_hook::@248 list
manager_hook_t helper
Definition manager.h:117
list of hooks registered
Definition manager.c:366
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition time.h:159

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, append_channel_vars(), append_event(), ast_atomic_fetchadd_int(), ast_config_AST_SYSTEM_NAME, ast_debug, ast_in_delimited_string(), 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(), ast_str_buffer(), ast_str_hash(), ast_str_set(), ast_str_thread_get(), ast_strlen_zero(), ast_tvnow(), authority_to_str(), buf, chancount, EVENT_FLAG_SHUTDOWN, ast_category::file, manager_custom_hook::helper, manager_debug, manager_disabledevents, MANAGER_EVENT_BUF_INITSIZE, MAX_AUTH_PERM_STRING, seq, session, sessions, timestampevents, and unref_mansession().

Referenced by __ast_manager_event_multichan(), and __manager_event_sessions().

◆ acl_change_stasis_cb()

static void acl_change_stasis_cb ( void *  data,
struct stasis_subscription sub,
struct stasis_message message 
)
static

Definition at line 10074 of file manager.c.

10076{
10078 return;
10079 }
10080
10081 /* For now, this is going to be performed simply and just execute a forced reload. */
10082 ast_log(LOG_NOTICE, "Reloading manager in response to ACL change event.\n");
10083 __init_manager(1, 1);
10084}
struct stasis_message_type * ast_named_acl_change_type(void)
a stasis_message_type for changes against a named ACL or the set of all named ACLs
#define ast_log
Definition astobj2.c:42
#define LOG_NOTICE
static int __init_manager(int reload, int by_external_config)
Definition manager.c:9671

References __init_manager(), ast_log, ast_named_acl_change_type(), and LOG_NOTICE.

Referenced by acl_change_stasis_subscribe().

◆ acl_change_stasis_subscribe()

static void acl_change_stasis_subscribe ( void  )
static

Definition at line 231 of file manager.c.

232{
233 if (!acl_change_sub) {
238 }
239}
static struct stasis_subscription * acl_change_sub
Definition manager.c:179
static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition manager.c:10074
#define NULL
Definition resample.c:96
struct stasis_topic * ast_security_topic(void)
A stasis_topic which publishes messages for security related issues.
@ STASIS_SUBSCRIPTION_FILTER_SELECTIVE
Definition stasis.h:297
int stasis_subscription_accept_message_type(struct stasis_subscription *subscription, const struct stasis_message_type *type)
Indicate to a subscription that we are interested in a message type.
Definition stasis.c:1090
int stasis_subscription_set_filter(struct stasis_subscription *subscription, enum stasis_subscription_message_filter filter)
Set the message type filtering level on a subscription.
Definition stasis.c:1144
#define stasis_subscribe(topic, callback, data)
Definition stasis.h:649

References acl_change_stasis_cb(), acl_change_sub, ast_named_acl_change_type(), ast_security_topic(), NULL, stasis_subscribe, stasis_subscription_accept_message_type(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, and stasis_subscription_set_filter().

Referenced by __init_manager().

◆ acl_change_stasis_unsubscribe()

static void acl_change_stasis_unsubscribe ( void  )
static

Definition at line 241 of file manager.c.

242{
244}
struct stasis_subscription * stasis_unsubscribe_and_join(struct stasis_subscription *subscription)
Cancel a subscription, blocking until the last message is processed.
Definition stasis.c:1201

References acl_change_sub, and stasis_unsubscribe_and_join().

Referenced by __init_manager(), and manager_shutdown().

◆ action_aoc_de_message()

static struct ast_aoc_decoded * action_aoc_de_message ( struct mansession s,
const struct message m 
)
static

Definition at line 4502 of file manager.c.

4503{
4504 const char *msgtype = astman_get_header(m, "MsgType");
4505 const char *chargetype = astman_get_header(m, "ChargeType");
4506 const char *currencyname = astman_get_header(m, "CurrencyName");
4507 const char *currencyamount = astman_get_header(m, "CurrencyAmount");
4508 const char *mult = astman_get_header(m, "CurrencyMultiplier");
4509 const char *totaltype = astman_get_header(m, "TotalType");
4510 const char *aocbillingid = astman_get_header(m, "AOCBillingId");
4511 const char *association_id= astman_get_header(m, "ChargingAssociationId");
4512 const char *association_num = astman_get_header(m, "ChargingAssociationNumber");
4513 const char *association_plan = astman_get_header(m, "ChargingAssociationPlan");
4514
4515 enum ast_aoc_type _msgtype;
4516 enum ast_aoc_charge_type _chargetype;
4518 enum ast_aoc_total_type _totaltype = AST_AOC_TOTAL;
4519 enum ast_aoc_billing_id _billingid = AST_AOC_BILLING_NA;
4520 unsigned int _currencyamount = 0;
4521 int _association_id = 0;
4522 unsigned int _association_plan = 0;
4523
4524 struct ast_aoc_decoded *decoded = NULL;
4525
4526 if (ast_strlen_zero(chargetype)) {
4527 astman_send_error(s, m, "ChargeType not specified");
4528 goto aocmessage_cleanup;
4529 }
4530
4531 _msgtype = strcasecmp(msgtype, "d") ? AST_AOC_E : AST_AOC_D;
4532
4533 if (!strcasecmp(chargetype, "NA")) {
4534 _chargetype = AST_AOC_CHARGE_NA;
4535 } else if (!strcasecmp(chargetype, "Free")) {
4536 _chargetype = AST_AOC_CHARGE_FREE;
4537 } else if (!strcasecmp(chargetype, "Currency")) {
4538 _chargetype = AST_AOC_CHARGE_CURRENCY;
4539 } else if (!strcasecmp(chargetype, "Unit")) {
4540 _chargetype = AST_AOC_CHARGE_UNIT;
4541 } else {
4542 astman_send_error(s, m, "Invalid ChargeType");
4543 goto aocmessage_cleanup;
4544 }
4545
4546 if (_chargetype == AST_AOC_CHARGE_CURRENCY) {
4547
4548 if (ast_strlen_zero(currencyamount) || (sscanf(currencyamount, "%30u", &_currencyamount) != 1)) {
4549 astman_send_error(s, m, "Invalid CurrencyAmount, CurrencyAmount is a required when ChargeType is Currency");
4550 goto aocmessage_cleanup;
4551 }
4552
4553 if (ast_strlen_zero(mult)) {
4554 astman_send_error(s, m, "ChargeMultiplier unspecified, ChargeMultiplier is required when ChargeType is Currency.");
4555 goto aocmessage_cleanup;
4556 } else if (!strcasecmp(mult, "onethousandth")) {
4558 } else if (!strcasecmp(mult, "onehundredth")) {
4560 } else if (!strcasecmp(mult, "onetenth")) {
4561 _mult = AST_AOC_MULT_ONETENTH;
4562 } else if (!strcasecmp(mult, "one")) {
4563 _mult = AST_AOC_MULT_ONE;
4564 } else if (!strcasecmp(mult, "ten")) {
4565 _mult = AST_AOC_MULT_TEN;
4566 } else if (!strcasecmp(mult, "hundred")) {
4567 _mult = AST_AOC_MULT_HUNDRED;
4568 } else if (!strcasecmp(mult, "thousand")) {
4569 _mult = AST_AOC_MULT_THOUSAND;
4570 } else {
4571 astman_send_error(s, m, "Invalid ChargeMultiplier");
4572 goto aocmessage_cleanup;
4573 }
4574 }
4575
4576 /* create decoded object and start setting values */
4577 if (!(decoded = ast_aoc_create(_msgtype, _chargetype, 0))) {
4578 astman_send_error(s, m, "Message Creation Failed");
4579 goto aocmessage_cleanup;
4580 }
4581
4582 if (_msgtype == AST_AOC_D) {
4583 if (!ast_strlen_zero(totaltype) && !strcasecmp(totaltype, "subtotal")) {
4584 _totaltype = AST_AOC_SUBTOTAL;
4585 }
4586
4587 if (ast_strlen_zero(aocbillingid)) {
4588 /* ignore this is optional */
4589 } else if (!strcasecmp(aocbillingid, "Normal")) {
4590 _billingid = AST_AOC_BILLING_NORMAL;
4591 } else if (!strcasecmp(aocbillingid, "ReverseCharge")) {
4592 _billingid = AST_AOC_BILLING_REVERSE_CHARGE;
4593 } else if (!strcasecmp(aocbillingid, "CreditCard")) {
4594 _billingid = AST_AOC_BILLING_CREDIT_CARD;
4595 } else {
4596 astman_send_error(s, m, "Invalid AOC-D AOCBillingId");
4597 goto aocmessage_cleanup;
4598 }
4599 } else {
4600 if (ast_strlen_zero(aocbillingid)) {
4601 /* ignore this is optional */
4602 } else if (!strcasecmp(aocbillingid, "Normal")) {
4603 _billingid = AST_AOC_BILLING_NORMAL;
4604 } else if (!strcasecmp(aocbillingid, "ReverseCharge")) {
4605 _billingid = AST_AOC_BILLING_REVERSE_CHARGE;
4606 } else if (!strcasecmp(aocbillingid, "CreditCard")) {
4607 _billingid = AST_AOC_BILLING_CREDIT_CARD;
4608 } else if (!strcasecmp(aocbillingid, "CallFwdUnconditional")) {
4610 } else if (!strcasecmp(aocbillingid, "CallFwdBusy")) {
4611 _billingid = AST_AOC_BILLING_CALL_FWD_BUSY;
4612 } else if (!strcasecmp(aocbillingid, "CallFwdNoReply")) {
4614 } else if (!strcasecmp(aocbillingid, "CallDeflection")) {
4616 } else if (!strcasecmp(aocbillingid, "CallTransfer")) {
4617 _billingid = AST_AOC_BILLING_CALL_TRANSFER;
4618 } else {
4619 astman_send_error(s, m, "Invalid AOC-E AOCBillingId");
4620 goto aocmessage_cleanup;
4621 }
4622
4623 if (!ast_strlen_zero(association_id) && (sscanf(association_id, "%30d", &_association_id) != 1)) {
4624 astman_send_error(s, m, "Invalid ChargingAssociationId");
4625 goto aocmessage_cleanup;
4626 }
4627 if (!ast_strlen_zero(association_plan) && (sscanf(association_plan, "%30u", &_association_plan) != 1)) {
4628 astman_send_error(s, m, "Invalid ChargingAssociationPlan");
4629 goto aocmessage_cleanup;
4630 }
4631
4632 if (_association_id) {
4633 ast_aoc_set_association_id(decoded, _association_id);
4634 } else if (!ast_strlen_zero(association_num)) {
4635 ast_aoc_set_association_number(decoded, association_num, _association_plan);
4636 }
4637 }
4638
4639 if (_chargetype == AST_AOC_CHARGE_CURRENCY) {
4640 ast_aoc_set_currency_info(decoded, _currencyamount, _mult, ast_strlen_zero(currencyname) ? NULL : currencyname);
4641 } else if (_chargetype == AST_AOC_CHARGE_UNIT) {
4642 struct ast_aoc_unit_entry entry;
4643 int i;
4644
4645 /* multiple unit entries are possible, lets get them all */
4646 for (i = 0; i < 32; i++) {
4647 if (aocmessage_get_unit_entry(m, &entry, i)) {
4648 break; /* that's the end then */
4649 }
4650
4651 ast_aoc_add_unit_entry(decoded, entry.valid_amount, entry.amount, entry.valid_type, entry.type);
4652 }
4653
4654 /* at least one unit entry is required */
4655 if (!i) {
4656 astman_send_error(s, m, "Invalid UnitAmount(0), At least one valid unit entry is required when ChargeType is set to Unit");
4657 goto aocmessage_cleanup;
4658 }
4659
4660 }
4661
4662 ast_aoc_set_billing_id(decoded, _billingid);
4663 ast_aoc_set_total_type(decoded, _totaltype);
4664
4665 return decoded;
4666
4667aocmessage_cleanup:
4668
4669 ast_aoc_destroy_decoded(decoded);
4670 return NULL;
4671}
ast_aoc_charge_type
Definition aoc.h:69
@ AST_AOC_CHARGE_CURRENCY
Definition aoc.h:72
@ AST_AOC_CHARGE_FREE
Definition aoc.h:71
@ AST_AOC_CHARGE_UNIT
Definition aoc.h:73
@ AST_AOC_CHARGE_NA
Definition aoc.h:70
ast_aoc_currency_multiplier
Defines the currency multiplier for an aoc message.
Definition aoc.h:34
@ AST_AOC_MULT_TEN
Definition aoc.h:39
@ AST_AOC_MULT_ONEHUNDREDTH
Definition aoc.h:36
@ AST_AOC_MULT_HUNDRED
Definition aoc.h:40
@ AST_AOC_MULT_ONETENTH
Definition aoc.h:37
@ AST_AOC_MULT_ONETHOUSANDTH
Definition aoc.h:35
@ AST_AOC_MULT_THOUSAND
Definition aoc.h:41
@ AST_AOC_MULT_ONE
Definition aoc.h:38
struct ast_aoc_decoded * ast_aoc_create(const enum ast_aoc_type msg_type, const enum ast_aoc_charge_type charge_type, const enum ast_aoc_request requests)
creates a ast_aoc_decode object of a specific message type
Definition aoc.c:285
void * ast_aoc_destroy_decoded(struct ast_aoc_decoded *decoded)
free an ast_aoc_decoded object
Definition aoc.c:316
int ast_aoc_set_association_number(struct ast_aoc_decoded *decoded, const char *num, uint8_t plan)
set the charging association number for an AOC-E message
Definition aoc.c:1065
int ast_aoc_add_unit_entry(struct ast_aoc_decoded *decoded, const unsigned int amount_is_present, const unsigned int amount, const unsigned int type_is_present, const unsigned int type)
Adds a unit entry into the list of units.
Definition aoc.c:986
ast_aoc_billing_id
Defines the billing id options for an aoc message.
Definition aoc.h:49
@ AST_AOC_BILLING_CALL_FWD_BUSY
Definition aoc.h:55
@ AST_AOC_BILLING_CALL_FWD_NO_REPLY
Definition aoc.h:56
@ AST_AOC_BILLING_NORMAL
Definition aoc.h:51
@ AST_AOC_BILLING_CALL_DEFLECTION
Definition aoc.h:57
@ AST_AOC_BILLING_CREDIT_CARD
Definition aoc.h:53
@ AST_AOC_BILLING_CALL_TRANSFER
Definition aoc.h:58
@ AST_AOC_BILLING_CALL_FWD_UNCONDITIONAL
Definition aoc.h:54
@ AST_AOC_BILLING_REVERSE_CHARGE
Definition aoc.h:52
@ AST_AOC_BILLING_NA
Definition aoc.h:50
int ast_aoc_set_billing_id(struct ast_aoc_decoded *decoded, const enum ast_aoc_billing_id id)
set the billing id for a AOC-D or AST_AOC_E message
Definition aoc.c:1033
int ast_aoc_set_currency_info(struct ast_aoc_decoded *decoded, const unsigned int amount, const enum ast_aoc_currency_multiplier multiplier, const char *name)
Sets the currency values for a AOC-D or AOC-E message.
Definition aoc.c:928
int ast_aoc_set_association_id(struct ast_aoc_decoded *decoded, const int id)
set the charging association id for an AST_AOC_E message
Definition aoc.c:1049
int ast_aoc_set_total_type(struct ast_aoc_decoded *decoded, const enum ast_aoc_total_type type)
Sets the type of total for a AOC-D message.
Definition aoc.c:916
ast_aoc_type
Definition aoc.h:62
@ AST_AOC_D
Definition aoc.h:65
@ AST_AOC_E
Definition aoc.h:66
ast_aoc_total_type
Definition aoc.h:82
@ AST_AOC_TOTAL
Definition aoc.h:83
@ AST_AOC_SUBTOTAL
Definition aoc.h:84
void astman_send_error(struct mansession *s, const struct message *m, char *error)
Send error in manager transaction.
Definition manager.c:1988
const char * astman_get_header(const struct message *m, char *var)
Return the first matching variable from an array.
Definition manager.c:1649
static int aocmessage_get_unit_entry(const struct message *m, struct ast_aoc_unit_entry *entry, unsigned int entry_num)
Definition manager.c:4477
Definition aoc.h:178

References ast_aoc_unit_entry::amount, aocmessage_get_unit_entry(), ast_aoc_add_unit_entry(), AST_AOC_BILLING_CALL_DEFLECTION, AST_AOC_BILLING_CALL_FWD_BUSY, AST_AOC_BILLING_CALL_FWD_NO_REPLY, AST_AOC_BILLING_CALL_FWD_UNCONDITIONAL, AST_AOC_BILLING_CALL_TRANSFER, AST_AOC_BILLING_CREDIT_CARD, AST_AOC_BILLING_NA, AST_AOC_BILLING_NORMAL, AST_AOC_BILLING_REVERSE_CHARGE, AST_AOC_CHARGE_CURRENCY, AST_AOC_CHARGE_FREE, AST_AOC_CHARGE_NA, AST_AOC_CHARGE_UNIT, ast_aoc_create(), AST_AOC_D, ast_aoc_destroy_decoded(), AST_AOC_E, AST_AOC_MULT_HUNDRED, AST_AOC_MULT_ONE, AST_AOC_MULT_ONEHUNDREDTH, AST_AOC_MULT_ONETENTH, AST_AOC_MULT_ONETHOUSANDTH, AST_AOC_MULT_TEN, AST_AOC_MULT_THOUSAND, ast_aoc_set_association_id(), ast_aoc_set_association_number(), ast_aoc_set_billing_id(), ast_aoc_set_currency_info(), ast_aoc_set_total_type(), AST_AOC_SUBTOTAL, AST_AOC_TOTAL, ast_strlen_zero(), astman_get_header(), astman_send_error(), NULL, ast_aoc_unit_entry::type, ast_aoc_unit_entry::valid_amount, and ast_aoc_unit_entry::valid_type.

Referenced by action_aocmessage().

◆ action_aoc_s_message()

static struct ast_aoc_decoded * action_aoc_s_message ( struct mansession s,
const struct message m 
)
static

Definition at line 4897 of file manager.c.

4899{
4900 struct ast_aoc_decoded *decoded = NULL;
4901 int hdrlen;
4902 int x;
4903 static const char hdr[] = "ChargedItem:";
4904 struct message sm = { 0 };
4905 int rates = 0;
4906
4907 if (!(decoded = ast_aoc_create(AST_AOC_S, 0, 0))) {
4908 astman_send_error(s, m, "Message Creation Failed");
4909 goto aocmessage_cleanup;
4910 }
4911
4912 hdrlen = strlen(hdr);
4913 for (x = 0; x < m->hdrcount; x++) {
4914 if (strncasecmp(hdr, m->headers[x], hdrlen) == 0) {
4915 if (rates > ast_aoc_s_get_count(decoded)) {
4916 if (action_aoc_s_submessage(s, &sm, decoded) == -1) {
4917 goto aocmessage_cleanup;
4918 }
4919 }
4920 ++rates;
4921 }
4922
4923 sm.headers[sm.hdrcount] = m->headers[x];
4924 ++sm.hdrcount;
4925 }
4926 if (rates > ast_aoc_s_get_count(decoded)) {
4927 if (action_aoc_s_submessage(s, &sm, decoded) == -1) {
4928 goto aocmessage_cleanup;
4929 }
4930 }
4931
4932 return decoded;
4933
4934aocmessage_cleanup:
4935
4936 ast_aoc_destroy_decoded(decoded);
4937 return NULL;
4938}
@ AST_AOC_S
Definition aoc.h:64
unsigned int ast_aoc_s_get_count(struct ast_aoc_decoded *decoded)
get the number rates associated with an AOC-S message
Definition aoc.c:765
static int action_aoc_s_submessage(struct mansession *s, const struct message *m, struct ast_aoc_decoded *decoded)
Definition manager.c:4673

References action_aoc_s_submessage(), ast_aoc_create(), ast_aoc_destroy_decoded(), AST_AOC_S, ast_aoc_s_get_count(), astman_send_error(), message::hdrcount, message::headers, and NULL.

Referenced by action_aocmessage().

◆ action_aoc_s_submessage()

static int action_aoc_s_submessage ( struct mansession s,
const struct message m,
struct ast_aoc_decoded decoded 
)
static

Definition at line 4673 of file manager.c.

4675{
4676 const char *chargeditem = __astman_get_header(m, "ChargedItem", GET_HEADER_LAST_MATCH);
4677 const char *ratetype = __astman_get_header(m, "RateType", GET_HEADER_LAST_MATCH);
4678 const char *currencyname = __astman_get_header(m, "CurrencyName", GET_HEADER_LAST_MATCH);
4679 const char *currencyamount = __astman_get_header(m, "CurrencyAmount", GET_HEADER_LAST_MATCH);
4680 const char *mult = __astman_get_header(m, "CurrencyMultiplier", GET_HEADER_LAST_MATCH);
4681 const char *time = __astman_get_header(m, "Time", GET_HEADER_LAST_MATCH);
4682 const char *timescale = __astman_get_header(m, "TimeScale", GET_HEADER_LAST_MATCH);
4683 const char *granularity = __astman_get_header(m, "Granularity", GET_HEADER_LAST_MATCH);
4684 const char *granularitytimescale = __astman_get_header(m, "GranularityTimeScale", GET_HEADER_LAST_MATCH);
4685 const char *chargingtype = __astman_get_header(m, "ChargingType", GET_HEADER_LAST_MATCH);
4686 const char *volumeunit = __astman_get_header(m, "VolumeUnit", GET_HEADER_LAST_MATCH);
4687 const char *code = __astman_get_header(m, "Code", GET_HEADER_LAST_MATCH);
4688
4689 enum ast_aoc_s_charged_item _chargeditem;
4690 enum ast_aoc_s_rate_type _ratetype;
4692 unsigned int _currencyamount = 0;
4693 unsigned int _code;
4694 unsigned int _time = 0;
4695 enum ast_aoc_time_scale _scale = 0;
4696 unsigned int _granularity = 0;
4697 enum ast_aoc_time_scale _granularity_time_scale = AST_AOC_TIME_SCALE_MINUTE;
4698 int _step = 0;
4699 enum ast_aoc_volume_unit _volumeunit = 0;
4700
4701 if (ast_strlen_zero(chargeditem)) {
4702 astman_send_error(s, m, "ChargedItem not specified");
4703 goto aocmessage_cleanup;
4704 }
4705
4706 if (ast_strlen_zero(ratetype)) {
4707 astman_send_error(s, m, "RateType not specified");
4708 goto aocmessage_cleanup;
4709 }
4710
4711 if (!strcasecmp(chargeditem, "NA")) {
4712 _chargeditem = AST_AOC_CHARGED_ITEM_NA;
4713 } else if (!strcasecmp(chargeditem, "SpecialArrangement")) {
4715 } else if (!strcasecmp(chargeditem, "BasicCommunication")) {
4717 } else if (!strcasecmp(chargeditem, "CallAttempt")) {
4718 _chargeditem = AST_AOC_CHARGED_ITEM_CALL_ATTEMPT;
4719 } else if (!strcasecmp(chargeditem, "CallSetup")) {
4720 _chargeditem = AST_AOC_CHARGED_ITEM_CALL_SETUP;
4721 } else if (!strcasecmp(chargeditem, "UserUserInfo")) {
4723 } else if (!strcasecmp(chargeditem, "SupplementaryService")) {
4725 } else {
4726 astman_send_error(s, m, "Invalid ChargedItem");
4727 goto aocmessage_cleanup;
4728 }
4729
4730 if (!strcasecmp(ratetype, "NA")) {
4731 _ratetype = AST_AOC_RATE_TYPE_NA;
4732 } else if (!strcasecmp(ratetype, "Free")) {
4733 _ratetype = AST_AOC_RATE_TYPE_FREE;
4734 } else if (!strcasecmp(ratetype, "FreeFromBeginning")) {
4736 } else if (!strcasecmp(ratetype, "Duration")) {
4737 _ratetype = AST_AOC_RATE_TYPE_DURATION;
4738 } else if (!strcasecmp(ratetype, "Flat")) {
4739 _ratetype = AST_AOC_RATE_TYPE_FLAT;
4740 } else if (!strcasecmp(ratetype, "Volume")) {
4741 _ratetype = AST_AOC_RATE_TYPE_VOLUME;
4742 } else if (!strcasecmp(ratetype, "SpecialCode")) {
4744 } else {
4745 astman_send_error(s, m, "Invalid RateType");
4746 goto aocmessage_cleanup;
4747 }
4748
4749 if (_ratetype > AST_AOC_RATE_TYPE_FREE_FROM_BEGINNING) {
4750 if (ast_strlen_zero(currencyamount) || (sscanf(currencyamount, "%30u",
4751 &_currencyamount) != 1)) {
4752 astman_send_error(s, m, "Invalid CurrencyAmount, CurrencyAmount is a required when RateType is non-free");
4753 goto aocmessage_cleanup;
4754 }
4755
4756 if (ast_strlen_zero(mult)) {
4757 astman_send_error(s, m, "ChargeMultiplier unspecified, ChargeMultiplier is required when ChargeType is Currency.");
4758 goto aocmessage_cleanup;
4759 } else if (!strcasecmp(mult, "onethousandth")) {
4761 } else if (!strcasecmp(mult, "onehundredth")) {
4763 } else if (!strcasecmp(mult, "onetenth")) {
4764 _mult = AST_AOC_MULT_ONETENTH;
4765 } else if (!strcasecmp(mult, "one")) {
4766 _mult = AST_AOC_MULT_ONE;
4767 } else if (!strcasecmp(mult, "ten")) {
4768 _mult = AST_AOC_MULT_TEN;
4769 } else if (!strcasecmp(mult, "hundred")) {
4770 _mult = AST_AOC_MULT_HUNDRED;
4771 } else if (!strcasecmp(mult, "thousand")) {
4772 _mult = AST_AOC_MULT_THOUSAND;
4773 } else {
4774 astman_send_error(s, m, "Invalid ChargeMultiplier");
4775 goto aocmessage_cleanup;
4776 }
4777 }
4778
4779 if (_ratetype == AST_AOC_RATE_TYPE_DURATION) {
4780 if (ast_strlen_zero(timescale)) {
4781 astman_send_error(s, m, "TimeScale unspecified, TimeScale is required when RateType is Duration.");
4782 goto aocmessage_cleanup;
4783 } else if (!strcasecmp(timescale, "onehundredthsecond")) {
4785 } else if (!strcasecmp(timescale, "onetenthsecond")) {
4787 } else if (!strcasecmp(timescale, "second")) {
4789 } else if (!strcasecmp(timescale, "tenseconds")) {
4791 } else if (!strcasecmp(timescale, "minute")) {
4793 } else if (!strcasecmp(timescale, "hour")) {
4794 _scale = AST_AOC_TIME_SCALE_HOUR;
4795 } else if (!strcasecmp(timescale, "day")) {
4796 _scale = AST_AOC_TIME_SCALE_DAY;
4797 } else {
4798 astman_send_error(s, m, "Invalid TimeScale");
4799 goto aocmessage_cleanup;
4800 }
4801
4802 if (ast_strlen_zero(time) || (sscanf(time, "%30u", &_time) != 1)) {
4803 astman_send_error(s, m, "Invalid Time, Time is a required when RateType is Duration");
4804 goto aocmessage_cleanup;
4805 }
4806
4807 if (!ast_strlen_zero(granularity)) {
4808 if ((sscanf(time, "%30u", &_granularity) != 1)) {
4809 astman_send_error(s, m, "Invalid Granularity");
4810 goto aocmessage_cleanup;
4811 }
4812
4813 if (ast_strlen_zero(granularitytimescale)) {
4814 astman_send_error(s, m, "Invalid GranularityTimeScale, GranularityTimeScale is a required when Granularity is specified");
4815 } else if (!strcasecmp(granularitytimescale, "onehundredthsecond")) {
4816 _granularity_time_scale = AST_AOC_TIME_SCALE_HUNDREDTH_SECOND;
4817 } else if (!strcasecmp(granularitytimescale, "onetenthsecond")) {
4818 _granularity_time_scale = AST_AOC_TIME_SCALE_TENTH_SECOND;
4819 } else if (!strcasecmp(granularitytimescale, "second")) {
4820 _granularity_time_scale = AST_AOC_TIME_SCALE_SECOND;
4821 } else if (!strcasecmp(granularitytimescale, "tenseconds")) {
4822 _granularity_time_scale = AST_AOC_TIME_SCALE_TEN_SECOND;
4823 } else if (!strcasecmp(granularitytimescale, "minute")) {
4824 _granularity_time_scale = AST_AOC_TIME_SCALE_MINUTE;
4825 } else if (!strcasecmp(granularitytimescale, "hour")) {
4826 _granularity_time_scale = AST_AOC_TIME_SCALE_HOUR;
4827 } else if (!strcasecmp(granularitytimescale, "day")) {
4828 _granularity_time_scale = AST_AOC_TIME_SCALE_DAY;
4829 } else {
4830 astman_send_error(s, m, "Invalid GranularityTimeScale");
4831 goto aocmessage_cleanup;
4832 }
4833 }
4834
4835 if (ast_strlen_zero(chargingtype) || strcasecmp(chargingtype, "continuouscharging") == 0) {
4836 _step = 0;
4837 } else if (strcasecmp(chargingtype, "stepfunction") == 0 ) {
4838 _step = 1;
4839 } else {
4840 astman_send_error(s, m, "Invalid ChargingType");
4841 goto aocmessage_cleanup;
4842 }
4843 }
4844
4845 if (_ratetype == AST_AOC_RATE_TYPE_VOLUME) {
4846 if (ast_strlen_zero(volumeunit)) {
4847 astman_send_error(s, m, "VolumeUnit unspecified, VolumeUnit is required when RateType is Volume.");
4848 goto aocmessage_cleanup;
4849 } else if (!strcasecmp(timescale, "octet")) {
4850 _volumeunit = AST_AOC_VOLUME_UNIT_OCTET;
4851 } else if (!strcasecmp(timescale, "segment")) {
4852 _volumeunit = AST_AOC_VOLUME_UNIT_SEGMENT;
4853 } else if (!strcasecmp(timescale, "message")) {
4854 _volumeunit = AST_AOC_VOLUME_UNIT_MESSAGE;
4855 }else {
4856 astman_send_error(s, m, "Invalid VolumeUnit");
4857 goto aocmessage_cleanup;
4858 }
4859 }
4860
4862 || _ratetype == AST_AOC_RATE_TYPE_SPECIAL_CODE) {
4863 if (ast_strlen_zero(code) || (sscanf(code, "%30u", &_code) != 1)) {
4864 astman_send_error(s, m, "Invalid Code, Code is a required when ChargedItem is SpecialArrangement and when RateType is SpecialCode");
4865 goto aocmessage_cleanup;
4866 }
4867 }
4868
4869 if (_chargeditem == AST_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT) {
4870 ast_aoc_s_add_special_arrangement(decoded, _code);
4871 } else if (_ratetype == AST_AOC_RATE_TYPE_DURATION) {
4872 ast_aoc_s_add_rate_duration(decoded, _chargeditem, _currencyamount, _mult,
4873 currencyname, _time, _scale, _granularity, _granularity_time_scale, _step);
4874 } else if (_ratetype == AST_AOC_RATE_TYPE_FLAT) {
4875 ast_aoc_s_add_rate_flat(decoded, _chargeditem, _currencyamount, _mult,
4876 currencyname);
4877 } else if (_ratetype == AST_AOC_RATE_TYPE_VOLUME) {
4878 ast_aoc_s_add_rate_volume(decoded, _chargeditem, _volumeunit, _currencyamount,
4879 _mult, currencyname);
4880 } else if (_ratetype == AST_AOC_RATE_TYPE_SPECIAL_CODE) {
4881 ast_aoc_s_add_rate_special_charge_code(decoded, _chargeditem, _code);
4882 } else if (_ratetype == AST_AOC_RATE_TYPE_FREE) {
4883 ast_aoc_s_add_rate_free(decoded, _chargeditem, 0);
4884 } else if (_ratetype == AST_AOC_RATE_TYPE_FREE_FROM_BEGINNING) {
4885 ast_aoc_s_add_rate_free(decoded, _chargeditem, 1);
4886 } else if (_ratetype == AST_AOC_RATE_TYPE_NA) {
4887 ast_aoc_s_add_rate_na(decoded, _chargeditem);
4888 }
4889
4890 return 0;
4891
4892aocmessage_cleanup:
4893
4894 return -1;
4895}
int ast_aoc_s_add_rate_duration(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item, unsigned int amount, enum ast_aoc_currency_multiplier multiplier, const char *currency_name, unsigned long time, enum ast_aoc_time_scale time_scale, unsigned long granularity_time, enum ast_aoc_time_scale granularity_time_scale, int step_function)
Add AOC-S duration rate entry.
Definition aoc.c:779
ast_aoc_s_charged_item
Definition aoc.h:145
@ AST_AOC_CHARGED_ITEM_BASIC_COMMUNICATION
Definition aoc.h:148
@ AST_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT
Definition aoc.h:147
@ AST_AOC_CHARGED_ITEM_NA
Definition aoc.h:146
@ AST_AOC_CHARGED_ITEM_USER_USER_INFO
Definition aoc.h:151
@ AST_AOC_CHARGED_ITEM_CALL_SETUP
Definition aoc.h:150
@ AST_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE
Definition aoc.h:152
@ AST_AOC_CHARGED_ITEM_CALL_ATTEMPT
Definition aoc.h:149
ast_aoc_time_scale
Definition aoc.h:87
@ AST_AOC_TIME_SCALE_TEN_SECOND
Definition aoc.h:91
@ AST_AOC_TIME_SCALE_DAY
Definition aoc.h:94
@ AST_AOC_TIME_SCALE_TENTH_SECOND
Definition aoc.h:89
@ AST_AOC_TIME_SCALE_MINUTE
Definition aoc.h:92
@ AST_AOC_TIME_SCALE_SECOND
Definition aoc.h:90
@ AST_AOC_TIME_SCALE_HOUR
Definition aoc.h:93
@ AST_AOC_TIME_SCALE_HUNDREDTH_SECOND
Definition aoc.h:88
ast_aoc_volume_unit
Definition aoc.h:125
@ AST_AOC_VOLUME_UNIT_OCTET
Definition aoc.h:126
@ AST_AOC_VOLUME_UNIT_SEGMENT
Definition aoc.h:127
@ AST_AOC_VOLUME_UNIT_MESSAGE
Definition aoc.h:128
int ast_aoc_s_add_rate_special_charge_code(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item, unsigned int code)
Add AOC-S special rate entry.
Definition aoc.c:853
int ast_aoc_s_add_rate_free(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item, int from_beginning)
Add AOC-S indicating charge item is free.
Definition aoc.c:866
int ast_aoc_s_add_special_arrangement(struct ast_aoc_decoded *decoded, unsigned int code)
Add AOC-S special arrangement entry.
Definition aoc.c:889
int ast_aoc_s_add_rate_flat(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item, unsigned int amount, enum ast_aoc_currency_multiplier multiplier, const char *currency_name)
Add AOC-S flat rate entry.
Definition aoc.c:810
int ast_aoc_s_add_rate_volume(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item, enum ast_aoc_volume_unit volume_unit, unsigned int amount, enum ast_aoc_currency_multiplier multiplier, const char *currency_name)
Add AOC-S volume rate entry.
Definition aoc.c:831
int ast_aoc_s_add_rate_na(struct ast_aoc_decoded *decoded, enum ast_aoc_s_charged_item charged_item)
Add AOC-S entry indicating charge item is not available.
Definition aoc.c:878
ast_aoc_s_rate_type
Definition aoc.h:155
@ AST_AOC_RATE_TYPE_VOLUME
Definition aoc.h:161
@ AST_AOC_RATE_TYPE_FREE_FROM_BEGINNING
Definition aoc.h:158
@ AST_AOC_RATE_TYPE_SPECIAL_CODE
Definition aoc.h:162
@ AST_AOC_RATE_TYPE_NA
Definition aoc.h:156
@ AST_AOC_RATE_TYPE_DURATION
Definition aoc.h:159
@ AST_AOC_RATE_TYPE_FLAT
Definition aoc.h:160
@ AST_AOC_RATE_TYPE_FREE
Definition aoc.h:157
static const char * __astman_get_header(const struct message *m, char *var, int mode)
Return a matching header value.
Definition manager.c:1612

References __astman_get_header(), AST_AOC_CHARGED_ITEM_BASIC_COMMUNICATION, AST_AOC_CHARGED_ITEM_CALL_ATTEMPT, AST_AOC_CHARGED_ITEM_CALL_SETUP, AST_AOC_CHARGED_ITEM_NA, AST_AOC_CHARGED_ITEM_SPECIAL_ARRANGEMENT, AST_AOC_CHARGED_ITEM_SUPPLEMENTARY_SERVICE, AST_AOC_CHARGED_ITEM_USER_USER_INFO, AST_AOC_MULT_HUNDRED, AST_AOC_MULT_ONE, AST_AOC_MULT_ONEHUNDREDTH, AST_AOC_MULT_ONETENTH, AST_AOC_MULT_ONETHOUSANDTH, AST_AOC_MULT_TEN, AST_AOC_MULT_THOUSAND, AST_AOC_RATE_TYPE_DURATION, AST_AOC_RATE_TYPE_FLAT, AST_AOC_RATE_TYPE_FREE, AST_AOC_RATE_TYPE_FREE_FROM_BEGINNING, AST_AOC_RATE_TYPE_NA, AST_AOC_RATE_TYPE_SPECIAL_CODE, AST_AOC_RATE_TYPE_VOLUME, ast_aoc_s_add_rate_duration(), ast_aoc_s_add_rate_flat(), ast_aoc_s_add_rate_free(), ast_aoc_s_add_rate_na(), ast_aoc_s_add_rate_special_charge_code(), ast_aoc_s_add_rate_volume(), ast_aoc_s_add_special_arrangement(), AST_AOC_TIME_SCALE_DAY, AST_AOC_TIME_SCALE_HOUR, AST_AOC_TIME_SCALE_HUNDREDTH_SECOND, AST_AOC_TIME_SCALE_MINUTE, AST_AOC_TIME_SCALE_SECOND, AST_AOC_TIME_SCALE_TEN_SECOND, AST_AOC_TIME_SCALE_TENTH_SECOND, AST_AOC_VOLUME_UNIT_MESSAGE, AST_AOC_VOLUME_UNIT_OCTET, AST_AOC_VOLUME_UNIT_SEGMENT, ast_strlen_zero(), astman_send_error(), and GET_HEADER_LAST_MATCH.

Referenced by action_aoc_s_message().

◆ action_aocmessage()

static int action_aocmessage ( struct mansession s,
const struct message m 
)
static

Definition at line 4940 of file manager.c.

4941{
4942 const char *msgtype = astman_get_header(m, "MsgType");
4943 const char *channel = astman_get_header(m, "Channel");
4944 const char *pchannel = astman_get_header(m, "ChannelPrefix");
4945
4946 struct ast_channel *chan = NULL;
4947
4948 struct ast_aoc_decoded *decoded = NULL;
4949 struct ast_aoc_encoded *encoded = NULL;
4950 size_t encoded_size = 0;
4951
4952 if (ast_strlen_zero(channel) && ast_strlen_zero(pchannel)) {
4953 astman_send_error(s, m, "Channel and PartialChannel are not specified. Specify at least one of these.");
4954 goto aocmessage_cleanup;
4955 }
4956
4957 if (!(chan = ast_channel_get_by_name(channel)) && !ast_strlen_zero(pchannel)) {
4958 chan = ast_channel_get_by_name_prefix(pchannel, strlen(pchannel));
4959 }
4960
4961 if (!chan) {
4962 astman_send_error(s, m, "No such channel");
4963 goto aocmessage_cleanup;
4964 }
4965
4966 if (strcasecmp(msgtype, "d") == 0 || strcasecmp(msgtype, "e") == 0) {
4967 decoded = action_aoc_de_message(s, m);
4968 }
4969 else if (strcasecmp(msgtype, "s") == 0) {
4970 decoded = action_aoc_s_message(s, m);
4971 }
4972 else {
4973 astman_send_error(s, m, "Invalid MsgType");
4974 goto aocmessage_cleanup;
4975 }
4976
4977 if (!decoded) {
4978 goto aocmessage_cleanup;
4979 }
4980
4981 if ((encoded = ast_aoc_encode(decoded, &encoded_size, chan))
4982 && !ast_indicate_data(chan, AST_CONTROL_AOC, encoded, encoded_size)) {
4983 astman_send_ack(s, m, "AOC Message successfully queued on channel");
4984 } else {
4985 astman_send_error(s, m, "Error encoding AOC message, could not queue onto channel");
4986 }
4987
4988aocmessage_cleanup:
4989
4990 ast_aoc_destroy_decoded(decoded);
4991 ast_aoc_destroy_encoded(encoded);
4992
4993 if (chan) {
4994 chan = ast_channel_unref(chan);
4995 }
4996 return 0;
4997}
void * ast_aoc_destroy_encoded(struct ast_aoc_encoded *encoded)
free an ast_aoc_encoded object
Definition aoc.c:322
struct ast_aoc_encoded * ast_aoc_encode(struct ast_aoc_decoded *decoded, size_t *out_size, struct ast_channel *chan)
encodes a decoded aoc structure so it can be passed on the wire
Definition aoc.c:659
struct ast_channel * ast_channel_get_by_name_prefix(const char *name, size_t name_len)
Find a channel by a name prefix.
Definition channel.c:1400
struct ast_channel * ast_channel_get_by_name(const char *search)
Find a channel by name or uniqueid.
Definition channel.c:1417
int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen)
Indicates condition of channel, with payload.
Definition channel.c:4688
#define ast_channel_unref(c)
Decrease channel reference count.
Definition channel.h:3018
void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
Send ack in manager transaction.
Definition manager.c:2020
static struct ast_aoc_decoded * action_aoc_s_message(struct mansession *s, const struct message *m)
Definition manager.c:4897
static struct ast_aoc_decoded * action_aoc_de_message(struct mansession *s, const struct message *m)
Definition manager.c:4502
Main Channel structure associated with a channel.

References action_aoc_de_message(), action_aoc_s_message(), ast_aoc_destroy_decoded(), ast_aoc_destroy_encoded(), ast_aoc_encode(), ast_channel_get_by_name(), ast_channel_get_by_name_prefix(), ast_channel_unref, AST_CONTROL_AOC, ast_indicate_data(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), and NULL.

Referenced by __init_manager().

◆ action_atxfer()

static int action_atxfer ( struct mansession s,
const struct message m 
)
static

Definition at line 4150 of file manager.c.

4151{
4152 const char *name = astman_get_header(m, "Channel");
4153 const char *exten = astman_get_header(m, "Exten");
4154 const char *context = astman_get_header(m, "Context");
4155 struct ast_channel *chan = NULL;
4156 char feature_code[AST_FEATURE_MAX_LEN];
4157 const char *digit;
4158
4159 if (ast_strlen_zero(name)) {
4160 astman_send_error(s, m, "No channel specified");
4161 return 0;
4162 }
4163 if (ast_strlen_zero(exten)) {
4164 astman_send_error(s, m, "No extension specified");
4165 return 0;
4166 }
4167
4168 if (!(chan = ast_channel_get_by_name(name))) {
4169 astman_send_error(s, m, "Channel specified does not exist");
4170 return 0;
4171 }
4172
4173 ast_channel_lock(chan);
4174 if (ast_get_builtin_feature(chan, "atxfer", feature_code, sizeof(feature_code)) ||
4175 ast_strlen_zero(feature_code)) {
4176 ast_channel_unlock(chan);
4177 astman_send_error(s, m, "No attended transfer feature code found");
4178 ast_channel_unref(chan);
4179 return 0;
4180 }
4181 ast_channel_unlock(chan);
4182
4183 if (!ast_strlen_zero(context)) {
4184 pbx_builtin_setvar_helper(chan, "TRANSFER_CONTEXT", context);
4185 }
4186
4187 for (digit = feature_code; *digit; ++digit) {
4188 struct ast_frame f = { AST_FRAME_DTMF, .subclass.integer = *digit };
4189 ast_queue_frame(chan, &f);
4190 }
4191
4192 for (digit = exten; *digit; ++digit) {
4193 struct ast_frame f = { AST_FRAME_DTMF, .subclass.integer = *digit };
4194 ast_queue_frame(chan, &f);
4195 }
4196
4197 chan = ast_channel_unref(chan);
4198
4199 astman_send_ack(s, m, "Atxfer successfully queued");
4200
4201 return 0;
4202}
char digit
#define ast_channel_lock(chan)
Definition channel.h:2982
int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f)
Queue one or more frames to a channel's frame queue.
Definition channel.c:1171
#define ast_channel_unlock(chan)
Definition channel.h:2983
static const char name[]
Definition format_mp3.c:68
#define AST_FEATURE_MAX_LEN
int ast_get_builtin_feature(struct ast_channel *chan, const char *feature, char *buf, size_t len)
Get the DTMF code for a builtin feature.
#define AST_FRAME_DTMF
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name.
char exten[AST_MAX_EXTENSION]
char context[AST_MAX_CONTEXT]
Data structure associated with a single frame of data.
struct ast_frame_subclass subclass

References ast_channel_get_by_name(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, AST_FEATURE_MAX_LEN, AST_FRAME_DTMF, ast_get_builtin_feature(), ast_queue_frame(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), digit, ast_frame_subclass::integer, name, NULL, pbx_builtin_setvar_helper(), and ast_frame::subclass.

Referenced by __init_manager().

◆ action_blind_transfer()

static int action_blind_transfer ( struct mansession s,
const struct message m 
)
static

Definition at line 4104 of file manager.c.

4105{
4106 const char *name = astman_get_header(m, "Channel");
4107 const char *exten = astman_get_header(m, "Exten");
4108 const char *context = astman_get_header(m, "Context");
4109 struct ast_channel *chan;
4110
4111 if (ast_strlen_zero(name)) {
4112 astman_send_error(s, m, "No channel specified");
4113 return 0;
4114 }
4115
4116 if (ast_strlen_zero(exten)) {
4117 astman_send_error(s, m, "No extension specified");
4118 return 0;
4119 }
4120
4122 if (!chan) {
4123 astman_send_error(s, m, "Channel specified does not exist");
4124 return 0;
4125 }
4126
4127 if (ast_strlen_zero(context)) {
4129 }
4130
4131 switch (ast_bridge_transfer_blind(1, chan, exten, context, NULL, NULL)) {
4133 astman_send_error(s, m, "Transfer not permitted");
4134 break;
4136 astman_send_error(s, m, "Transfer invalid");
4137 break;
4139 astman_send_error(s, m, "Transfer failed");
4140 break;
4142 astman_send_ack(s, m, "Transfer succeeded");
4143 break;
4144 }
4145
4146 ast_channel_unref(chan);
4147 return 0;
4148}
enum ast_transfer_result ast_bridge_transfer_blind(int is_external, struct ast_channel *transferer, const char *exten, const char *context, transfer_channel_cb new_channel_cb, void *user_data)
Blind transfer target to the extension and context provided.
Definition bridge.c:4504
@ AST_BRIDGE_TRANSFER_NOT_PERMITTED
Definition bridge.h:1106
@ AST_BRIDGE_TRANSFER_SUCCESS
Definition bridge.h:1104
@ AST_BRIDGE_TRANSFER_INVALID
Definition bridge.h:1108
@ AST_BRIDGE_TRANSFER_FAIL
Definition bridge.h:1110
const char * ast_channel_context(const struct ast_channel *chan)

References ast_bridge_transfer_blind(), AST_BRIDGE_TRANSFER_FAIL, AST_BRIDGE_TRANSFER_INVALID, AST_BRIDGE_TRANSFER_NOT_PERMITTED, AST_BRIDGE_TRANSFER_SUCCESS, ast_channel_context(), ast_channel_get_by_name(), ast_channel_unref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), name, and NULL.

Referenced by __init_manager().

◆ action_cancel_atxfer()

static int action_cancel_atxfer ( struct mansession s,
const struct message m 
)
static

Definition at line 4204 of file manager.c.

4205{
4206 const char *name = astman_get_header(m, "Channel");
4207 struct ast_channel *chan = NULL;
4208 char *feature_code;
4209 const char *digit;
4210
4211 if (ast_strlen_zero(name)) {
4212 astman_send_error(s, m, "No channel specified");
4213 return 0;
4214 }
4215
4216 if (!(chan = ast_channel_get_by_name(name))) {
4217 astman_send_error(s, m, "Channel specified does not exist");
4218 return 0;
4219 }
4220
4221 ast_channel_lock(chan);
4222 feature_code = ast_get_chan_features_atxferabort(chan);
4223 ast_channel_unlock(chan);
4224
4225 if (!feature_code) {
4226 astman_send_error(s, m, "No disconnect feature code found");
4227 ast_channel_unref(chan);
4228 return 0;
4229 }
4230
4231 for (digit = feature_code; *digit; ++digit) {
4232 struct ast_frame f = { AST_FRAME_DTMF, .subclass.integer = *digit };
4233 ast_queue_frame(chan, &f);
4234 }
4235 ast_free(feature_code);
4236
4237 chan = ast_channel_unref(chan);
4238
4239 astman_send_ack(s, m, "CancelAtxfer successfully queued");
4240
4241 return 0;
4242}
#define ast_free(a)
Definition astmm.h:180
char * ast_get_chan_features_atxferabort(struct ast_channel *chan)
Get the transfer configuration option atxferabort.

References ast_channel_get_by_name(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, AST_FRAME_DTMF, ast_free, ast_get_chan_features_atxferabort(), ast_queue_frame(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), digit, ast_frame_subclass::integer, name, NULL, and ast_frame::subclass.

Referenced by __init_manager().

◆ action_challenge()

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

Definition at line 3409 of file manager.c.

3410{
3411 const char *authtype = astman_get_header(m, "AuthType");
3412
3413 if (!strcasecmp(authtype, "MD5")) {
3415 snprintf(s->session->challenge, sizeof(s->session->challenge), "%ld", ast_random());
3416 }
3417 mansession_lock(s);
3418 astman_start_ack(s, m);
3419 astman_append(s, "Challenge: %s\r\n\r\n", s->session->challenge);
3421 } else {
3422 astman_send_error(s, m, "Must specify AuthType");
3423 }
3424 return 0;
3425}
static void mansession_unlock(struct mansession *s)
Unlock the 'mansession' structure.
Definition manager.c:2086
static void mansession_lock(struct mansession *s)
Lock the 'mansession' structure.
Definition manager.c:2080
static void astman_start_ack(struct mansession *s, const struct message *m)
Definition manager.c:2025
void astman_append(struct mansession *s, const char *fmt,...)
Definition manager.c:1909
char challenge[10]
Definition manager.c:290
struct mansession_session * session
Definition manager.c:324
long int ast_random(void)
Definition utils.c:2346

References ast_random(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), mansession_session::challenge, mansession_lock(), mansession_unlock(), and mansession::session.

Referenced by __init_manager().

◆ action_command()

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

Manager command "command" - execute CLI command.

Definition at line 4281 of file manager.c.

4282{
4283 const char *cmd = astman_get_header(m, "Command");
4284 char *buf = NULL, *final_buf = NULL, *delim, *output;
4285 char template[] = "/tmp/ast-ami-XXXXXX"; /* template for temporary file */
4286 int fd, ret;
4287 off_t len;
4288
4289 if (ast_strlen_zero(cmd)) {
4290 astman_send_error(s, m, "No command provided");
4291 return 0;
4292 }
4293
4294 if (check_blacklist(cmd)) {
4295 astman_send_error(s, m, "Command blacklisted");
4296 return 0;
4297 }
4298
4299 if ((fd = mkstemp(template)) < 0) {
4300 astman_send_error_va(s, m, "Failed to create temporary file: %s", strerror(errno));
4301 return 0;
4302 }
4303
4304 ret = ast_cli_command(fd, cmd);
4305 astman_send_response_full(s, m, ret == RESULT_SUCCESS ? "Success" : "Error", MSG_MOREDATA, NULL);
4306
4307 /* Determine number of characters available */
4308 if ((len = lseek(fd, 0, SEEK_END)) < 0) {
4309 astman_append(s, "Message: Failed to determine number of characters: %s\r\n", strerror(errno));
4310 goto action_command_cleanup;
4311 }
4312
4313 /* This has a potential to overflow the stack. Hence, use the heap. */
4314 buf = ast_malloc(len + 1);
4315 final_buf = ast_malloc(len + 1);
4316
4317 if (!buf || !final_buf) {
4318 astman_append(s, "Message: Memory allocation failure\r\n");
4319 goto action_command_cleanup;
4320 }
4321
4322 if (lseek(fd, 0, SEEK_SET) < 0) {
4323 astman_append(s, "Message: Failed to set position on temporary file: %s\r\n", strerror(errno));
4324 goto action_command_cleanup;
4325 }
4326
4327 if (read(fd, buf, len) < 0) {
4328 astman_append(s, "Message: Failed to read from temporary file: %s\r\n", strerror(errno));
4329 goto action_command_cleanup;
4330 }
4331
4332 buf[len] = '\0';
4333 term_strip(final_buf, buf, len);
4334 final_buf[len] = '\0';
4335
4336 /* Trim trailing newline */
4337 if (len && final_buf[len - 1] == '\n') {
4338 final_buf[len - 1] = '\0';
4339 }
4340
4341 astman_append(s, "Message: Command output follows\r\n");
4342
4343 delim = final_buf;
4344 while ((output = strsep(&delim, "\n"))) {
4345 astman_append(s, "Output: %s\r\n", output);
4346 }
4347
4348action_command_cleanup:
4349 astman_append(s, "\r\n");
4350
4351 close(fd);
4352 unlink(template);
4353
4354 ast_free(buf);
4355 ast_free(final_buf);
4356
4357 return 0;
4358}
char * strsep(char **str, const char *delims)
#define ast_malloc(len)
A wrapper for malloc()
Definition astmm.h:191
#define RESULT_SUCCESS
Definition cli.h:40
#define ast_cli_command(fd, s)
Definition cli.h:232
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
void astman_send_error_va(struct mansession *s, const struct message *m, const char *fmt,...)
Send error in manager transaction (with va_args support)
Definition manager.c:1993
static void astman_send_response_full(struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
send a response with an optional message, and terminate it with an empty line. m is used only to grab...
Definition manager.c:1952
static int check_blacklist(const char *cmd)
Definition manager.c:4245
#define MSG_MOREDATA
Definition manager.c:1943
int errno
char * term_strip(char *outbuf, const char *inbuf, int maxout)
Remove colorings from a specified string.
Definition term.c:362

References ast_cli_command, ast_free, ast_malloc, ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_send_error_va(), astman_send_response_full(), buf, check_blacklist(), errno, len(), MSG_MOREDATA, NULL, RESULT_SUCCESS, strsep(), and term_strip().

Referenced by __init_manager().

◆ action_coresettings()

static int action_coresettings ( struct mansession s,
const struct message m 
)
static

Show PBX core settings information.

Definition at line 6468 of file manager.c.

6469{
6470 const char *actionid = astman_get_header(m, "ActionID");
6471 char idText[150];
6472
6473 if (!ast_strlen_zero(actionid)) {
6474 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", actionid);
6475 } else {
6476 idText[0] = '\0';
6477 }
6478
6479 astman_append(s, "Response: Success\r\n"
6480 "%s"
6481 "AMIversion: %s\r\n"
6482 "AsteriskVersion: %s\r\n"
6483 "SystemName: %s\r\n"
6484 "CoreMaxCalls: %d\r\n"
6485 "CoreMaxLoadAvg: %f\r\n"
6486 "CoreRunUser: %s\r\n"
6487 "CoreRunGroup: %s\r\n"
6488 "CoreMaxFilehandles: %d\r\n"
6489 "CoreRealTimeEnabled: %s\r\n"
6490 "CoreCDRenabled: %s\r\n"
6491 "CoreHTTPenabled: %s\r\n"
6492 "SoundsSearchCustomDir: %s\r\n"
6493 "\r\n",
6494 idText,
6507 );
6508 return 0;
6509}
const char * ast_get_version(void)
Retrieve the Asterisk version string.
int ast_cdr_is_enabled(void)
Return TRUE if CDR subsystem is enabled.
Definition cdr.c:2994
#define AST_CLI_YESNO(x)
Return Yes or No depending on the argument.
Definition cli.h:71
int ast_webmanager_check_enabled(void)
Check if AMI/HTTP is enabled.
Definition manager.c:685
int ast_option_maxfiles
Definition options.c:82
int ast_option_maxcalls
Definition options.c:80
double ast_option_maxload
Definition options.c:78
int ast_realtime_enabled(void)
Check if there's any realtime engines loaded.
#define AMI_VERSION
Definition manager.h:57
#define ast_opt_sounds_search_custom
Definition options.h:148
const char * ast_config_AST_RUN_GROUP
Definition options.c:170
const char * ast_config_AST_RUN_USER
Definition options.c:169

References AMI_VERSION, ast_cdr_is_enabled(), AST_CLI_YESNO, ast_config_AST_RUN_GROUP, ast_config_AST_RUN_USER, ast_config_AST_SYSTEM_NAME, ast_get_version(), ast_opt_sounds_search_custom, ast_option_maxcalls, ast_option_maxfiles, ast_option_maxload, ast_realtime_enabled(), ast_strlen_zero(), ast_webmanager_check_enabled(), astman_append(), and astman_get_header().

Referenced by __init_manager().

◆ action_coreshowchannelmap()

static int action_coreshowchannelmap ( struct mansession s,
const struct message m 
)
static

Manager command "CoreShowChannelMap" - Lists all channels connected to the specified channel.

Definition at line 6754 of file manager.c.

6755{
6756 const char *actionid = astman_get_header(m, "ActionID");
6757 const char *channel_name = astman_get_header(m, "Channel");
6758 char *current_channel_name;
6759 char id_text[256];
6760 int total = 0;
6761 struct ao2_container *channel_map;
6762 struct ao2_iterator i;
6763 RAII_VAR(struct ast_bridge_snapshot *, bridge_snapshot, NULL, ao2_cleanup);
6764 RAII_VAR(struct ast_channel_snapshot *, channel_snapshot, NULL, ao2_cleanup);
6765
6766 if (!ast_strlen_zero(actionid)) {
6767 snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", actionid);
6768 } else {
6769 id_text[0] = '\0';
6770 }
6771
6772 if (ast_strlen_zero(channel_name)) {
6773 astman_send_error(s, m, "CoreShowChannelMap requires a channel.\n");
6774 return 0;
6775 }
6776
6777 channel_snapshot = ast_channel_snapshot_get_latest_by_name(channel_name);
6778 if (!channel_snapshot) {
6779 astman_send_error(s, m, "Could not get channel snapshot\n");
6780 return 0;
6781 }
6782
6783 if (ast_strlen_zero(channel_snapshot->bridge->id)) {
6784 astman_send_listack(s, m, "Channel map will follow", "start");
6785 astman_send_list_complete_start(s, m, "CoreShowChannelMapComplete", 0);
6787 return 0;
6788 }
6789
6790 bridge_snapshot = ast_bridge_get_snapshot_by_uniqueid(channel_snapshot->bridge->id);
6791 if (!bridge_snapshot) {
6792 astman_send_listack(s, m, "Channel map will follow", "start");
6793 astman_send_list_complete_start(s, m, "CoreShowChannelMapComplete", 0);
6795 return 0;
6796 }
6797
6799 if (!channel_map) {
6800 astman_send_error(s, m, "Could not create channel map\n");
6801 return 0;
6802 }
6803
6804 astman_send_listack(s, m, "Channel map will follow", "start");
6805
6806 if (coreshowchannelmap_add_connected_channels(channel_map, channel_snapshot, bridge_snapshot)) {
6807 astman_send_error(s, m, "Could not complete channel map\n");
6808 ao2_ref(channel_map, -1);
6809 return 0;
6810 }
6811
6812 i = ao2_iterator_init(channel_map, 0);
6813 while ((current_channel_name = ao2_iterator_next(&i))) {
6814 astman_append(s,
6815 "Event: CoreShowChannelMap\r\n"
6816 "%s"
6817 "Channel: %s\r\n"
6818 "ConnectedChannel: %s\r\n\r\n",
6819 id_text,
6820 channel_name,
6821 current_channel_name);
6822 total++;
6823 }
6825
6826 ao2_ref(channel_map, -1);
6827 astman_send_list_complete_start(s, m, "CoreShowChannelMapComplete", total);
6829
6830 return 0;
6831}
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition astobj2.h:367
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
@ AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT
Reject duplicate objects in container.
Definition astobj2.h:1201
void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
Send ack in manager transaction to begin a list.
Definition manager.c:2030
void astman_send_list_complete_start(struct mansession *s, const struct message *m, const char *event_name, int count)
Start the list complete event.
Definition manager.c:2066
static int coreshowchannelmap_add_connected_channels(struct ao2_container *channel_map, struct ast_channel_snapshot *channel_snapshot, struct ast_bridge_snapshot *bridge_snapshot)
Recursive function to get all channels in a bridge. Follow local channels as well.
Definition manager.c:6670
void astman_send_list_complete_end(struct mansession *s)
End the list complete event.
Definition manager.c:2074
struct ast_channel_snapshot * ast_channel_snapshot_get_latest_by_name(const char *name)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object,...
static int total
Definition res_adsi.c:970
struct ast_bridge_snapshot * ast_bridge_get_snapshot_by_uniqueid(const char *bridge_id)
Returns the current snapshot for the bridge.
struct ao2_container * ast_str_container_alloc_options(enum ao2_alloc_opts opts, int buckets)
Allocates a hash container for bare strings.
Definition strings.c:200
Structure that contains a snapshot of information about a bridge.
Definition bridge.h:318
Structure representing a snapshot of channel state.
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_cleanup, AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_bridge_get_snapshot_by_uniqueid(), ast_channel_snapshot_get_latest_by_name(), ast_str_container_alloc_options(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), coreshowchannelmap_add_connected_channels(), NULL, RAII_VAR, and total.

Referenced by __init_manager().

◆ action_coreshowchannels()

static int action_coreshowchannels ( struct mansession s,
const struct message m 
)
static

Manager command "CoreShowChannels" - List currently defined channels and some information about them.

Definition at line 6586 of file manager.c.

6587{
6588 const char *actionid = astman_get_header(m, "ActionID");
6589 char idText[256];
6590 int numchans = 0;
6591 struct ao2_container *channels;
6592 struct ao2_iterator it_chans;
6593 struct ast_channel_snapshot *cs;
6594
6595 if (!ast_strlen_zero(actionid)) {
6596 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", actionid);
6597 } else {
6598 idText[0] = '\0';
6599 }
6600
6602
6603 astman_send_listack(s, m, "Channels will follow", "start");
6604
6605 it_chans = ao2_iterator_init(channels, 0);
6606 for (; (cs = ao2_iterator_next(&it_chans)); ao2_ref(cs, -1)) {
6608 char durbuf[16] = "";
6609
6610 if (!built) {
6611 continue;
6612 }
6613
6614 if (!ast_tvzero(cs->base->creationtime)) {
6615 int duration, durh, durm, durs;
6616
6617 duration = (int)(ast_tvdiff_ms(ast_tvnow(), cs->base->creationtime) / 1000);
6618 durh = duration / 3600;
6619 durm = (duration % 3600) / 60;
6620 durs = duration % 60;
6621 snprintf(durbuf, sizeof(durbuf), "%02d:%02d:%02d", durh, durm, durs);
6622 }
6623
6624 astman_append(s,
6625 "Event: CoreShowChannel\r\n"
6626 "%s"
6627 "%s"
6628 "Application: %s\r\n"
6629 "ApplicationData: %s\r\n"
6630 "Duration: %s\r\n"
6631 "BridgeId: %s\r\n"
6632 "\r\n",
6633 idText,
6634 ast_str_buffer(built),
6635 cs->dialplan->appl,
6636 cs->dialplan->data,
6637 durbuf,
6638 cs->bridge->id);
6639
6640 numchans++;
6641
6642 ast_free(built);
6643 }
6644 ao2_iterator_destroy(&it_chans);
6645
6646 astman_send_list_complete(s, m, "CoreShowChannelsComplete", numchans);
6647
6648 ao2_ref(channels, -1);
6649 return 0;
6650}
static struct channel_usage channels
static void astman_send_list_complete(struct mansession *s, const struct message *m, const char *event_name, int count)
Definition manager.c:2057
struct ao2_container * ast_channel_cache_by_name(void)
Secondary channel cache, indexed by name.
struct ast_str * ast_manager_build_channel_state_string_prefix(const struct ast_channel_snapshot *snapshot, const char *prefix)
Generate the AMI message body from a channel snapshot.
const ast_string_field data
const ast_string_field appl
struct ast_channel_snapshot_dialplan * dialplan
struct ast_channel_snapshot_bridge * bridge
struct ast_channel_snapshot_base * base
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition time.h:117
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition time.h:107

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_channel_snapshot_dialplan::appl, ast_channel_cache_by_name(), ast_free, ast_manager_build_channel_state_string_prefix(), ast_str_buffer(), ast_strlen_zero(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), astman_append(), astman_get_header(), astman_send_list_complete(), astman_send_listack(), ast_channel_snapshot::base, ast_channel_snapshot::bridge, channels, ast_channel_snapshot_base::creationtime, ast_channel_snapshot_dialplan::data, ast_channel_snapshot::dialplan, and ast_channel_snapshot_bridge::id.

Referenced by __init_manager().

◆ action_corestatus()

static int action_corestatus ( struct mansession s,
const struct message m 
)
static

Show PBX core status information.

Definition at line 6512 of file manager.c.

6513{
6514 const char *actionid = astman_get_header(m, "ActionID");
6515 char idText[150];
6516 char startuptime[150], startupdate[150];
6517 char reloadtime[150], reloaddate[150];
6518 struct ast_tm tm;
6519
6520 if (!ast_strlen_zero(actionid)) {
6521 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", actionid);
6522 } else {
6523 idText[0] = '\0';
6524 }
6525
6527 ast_strftime(startuptime, sizeof(startuptime), "%H:%M:%S", &tm);
6528 ast_strftime(startupdate, sizeof(startupdate), "%Y-%m-%d", &tm);
6530 ast_strftime(reloadtime, sizeof(reloadtime), "%H:%M:%S", &tm);
6531 ast_strftime(reloaddate, sizeof(reloaddate), "%Y-%m-%d", &tm);
6532
6533 astman_append(s, "Response: Success\r\n"
6534 "%s"
6535 "CoreStartupDate: %s\r\n"
6536 "CoreStartupTime: %s\r\n"
6537 "CoreReloadDate: %s\r\n"
6538 "CoreReloadTime: %s\r\n"
6539 "CoreCurrentCalls: %d\r\n"
6540 "CoreProcessedCalls: %d\r\n"
6541 "\r\n",
6542 idText,
6543 startupdate,
6544 startuptime,
6545 reloaddate,
6546 reloadtime,
6549 );
6550 return 0;
6551}
int ast_active_channels(void)
returns number of active/allocated channels
Definition channel.c:500
struct ast_tm * ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone)
Timezone-independent version of localtime_r(3).
Definition localtime.c:1739
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm)
Special version of strftime(3) that handles fractions of a second. Takes the same arguments as strfti...
Definition localtime.c:2524
struct timeval ast_lastreloadtime
Definition asterisk.c:345
struct timeval ast_startuptime
Definition asterisk.c:344
int ast_processed_calls(void)
Retrieve the total number of calls processed through the PBX since last restart.
Definition pbx.c:4801

References ast_active_channels(), ast_lastreloadtime, ast_localtime(), ast_processed_calls(), ast_startuptime, ast_strftime(), ast_strlen_zero(), astman_append(), astman_get_header(), and NULL.

Referenced by __init_manager().

◆ action_createconfig()

static int action_createconfig ( struct mansession s,
const struct message m 
)
static

Definition at line 3099 of file manager.c.

3100{
3101 int fd;
3102 const char *fn = astman_get_header(m, "Filename");
3103 char *stripped_filename;
3104 RAII_VAR(char *, filepath, NULL, ast_free);
3105 RAII_VAR(char *, real_dir, NULL, ast_std_free);
3106 RAII_VAR(char *, real_path, NULL, ast_free);
3107 char *filename;
3108
3109 if (ast_strlen_zero(fn)) {
3110 astman_send_error(s, m, "Filename not specified");
3111 return 0;
3112 }
3113
3114 stripped_filename = ast_strip(ast_strdupa(fn));
3115
3116 /* If the file name is relative, prepend ast_config_AST_CONFIG_DIR */
3117 if (stripped_filename[0] != '/') {
3118 if (ast_asprintf(&filepath, "%s/%s", ast_config_AST_CONFIG_DIR, stripped_filename) == -1) {
3119 return -1;
3120 }
3121 } else {
3122 filepath = ast_strdup(stripped_filename);
3123 }
3124
3125 /*
3126 * We can't call is_restricted_file() here because it uses realpath() and...
3127 *
3128 * realpath() and other functions that canonicalize paths won't work with
3129 * a filename that doesn't exist, so we need to separate the directory
3130 * from the filename and canonicalize the directory first. We have to do
3131 * the separation manually because dirname() and basename() aren't all
3132 * that friendly to multi-threaded programs and there are different
3133 * versions of basename for glibc and POSIX.
3134 */
3135
3136 filename = strrchr(filepath, '/');
3137 if (!filename) {
3138 astman_send_error(s, m, "Filename is invalid");
3139 return 0;
3140 }
3141 *filename = '\0';
3142 filename++;
3143
3144 /* filepath just has the directory now so canonicalize it. */
3145 real_dir = realpath(filepath, NULL);
3146 if (ast_strlen_zero(real_dir)) {
3147 astman_send_error(s, m, strerror(errno));
3148 return 0;
3149 }
3150
3151 /* Check if the directory is restricted. */
3153 astman_send_error(s, m, "File requires escalated privileges");
3154 return 0;
3155 }
3156
3157 /* Create the final file path. */
3158 if (ast_asprintf(&real_path, "%s/%s", real_dir, filename) == -1) {
3159 astman_send_error(s, m, strerror(errno));
3160 return -1;
3161 }
3162
3163 if ((fd = open(real_path, O_CREAT | O_EXCL, AST_FILE_MODE)) != -1) {
3164 close(fd);
3165 astman_send_ack(s, m, "New configuration file created successfully");
3166 } else {
3167 astman_send_error(s, m, strerror(errno));
3168 }
3169
3170 return 0;
3171}
#define AST_FILE_MODE
Definition asterisk.h:32
void ast_std_free(void *ptr)
Definition astmm.c:1734
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition astmm.h:267
static int live_dangerously
Set to true (non-zero) to globally allow all dangerous AMI actions to run.
Definition manager.c:196
const char * ast_config_AST_CONFIG_DIR
Definition options.c:152
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition strings.h:97
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition strings.h:223

References ast_asprintf, ast_begins_with(), ast_config_AST_CONFIG_DIR, AST_FILE_MODE, ast_free, ast_std_free(), ast_strdup, ast_strdupa, ast_strip(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), errno, live_dangerously, NULL, and RAII_VAR.

Referenced by __init_manager().

◆ action_destroy()

static void action_destroy ( void *  obj)
static

Definition at line 7816 of file manager.c.

7817{
7818 struct manager_action *doomed = obj;
7819
7820 if (doomed->synopsis) {
7821 /* The string fields were initialized. */
7823 }
7824 ao2_cleanup(doomed->final_response);
7825 ao2_cleanup(doomed->list_responses);
7826}
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
struct ast_xml_doc_item * final_response
Definition manager.h:167
const ast_string_field synopsis
Definition manager.h:163
struct ast_xml_doc_item * list_responses
Definition manager.h:165

References ao2_cleanup, ast_string_field_free_memory, manager_action::final_response, manager_action::list_responses, and manager_action::synopsis.

Referenced by ast_manager_register2().

◆ action_events()

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

Definition at line 3310 of file manager.c.

3311{
3312 const char *mask = astman_get_header(m, "EventMask");
3313 int res, x;
3314 const char *id = astman_get_header(m, "ActionID");
3315 char id_text[256];
3316
3317 if (!ast_strlen_zero(id)) {
3318 snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", id);
3319 } else {
3320 id_text[0] = '\0';
3321 }
3322
3323 res = set_eventmask(s, mask);
3325 /* if this option is set we should not return a response on
3326 * error, or when all events are set */
3327
3328 if (res > 0) {
3329 for (x = 0; x < ARRAY_LEN(perms); x++) {
3330 if (!strcasecmp(perms[x].label, "all") && res == perms[x].num) {
3331 return 0;
3332 }
3333 }
3334 astman_append(s, "Response: Success\r\n%s"
3335 "Events: On\r\n\r\n", id_text);
3336 } else if (res == 0)
3337 astman_append(s, "Response: Success\r\n%s"
3338 "Events: Off\r\n\r\n", id_text);
3339 return 0;
3340 }
3341
3342 if (res > 0)
3343 astman_append(s, "Response: Success\r\n%s"
3344 "Events: On\r\n\r\n", id_text);
3345 else if (res == 0)
3346 astman_append(s, "Response: Success\r\n%s"
3347 "Events: Off\r\n\r\n", id_text);
3348 else
3349 astman_send_error(s, m, "Invalid event mask");
3350
3351 return 0;
3352}
static int broken_events_action
Definition manager.c:165
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 ',...
Definition manager.c:2095
static const struct permalias perms[]
int num
Definition manager.c:747
#define ARRAY_LEN(a)
Definition utils.h:706

References ARRAY_LEN, ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), broken_events_action, permalias::num, perms, and set_eventmask().

Referenced by __init_manager().

◆ action_extensionstate()

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

Definition at line 5466 of file manager.c.

5467{
5468 const char *exten = astman_get_header(m, "Exten");
5469 const char *context = astman_get_header(m, "Context");
5470 char hint[256];
5471 int status;
5472
5473 if (ast_strlen_zero(exten)) {
5474 astman_send_error(s, m, "Extension not specified");
5475 return 0;
5476 }
5477 if (ast_strlen_zero(context)) {
5478 context = "default";
5479 }
5480 status = ast_extension_state(NULL, context, exten);
5481 hint[0] = '\0';
5482 ast_get_hint(hint, sizeof(hint), NULL, 0, NULL, context, exten);
5483 astman_start_ack(s, m);
5484 astman_append(s, "Message: Extension Status\r\n"
5485 "Exten: %s\r\n"
5486 "Context: %s\r\n"
5487 "Hint: %s\r\n"
5488 "Status: %d\r\n"
5489 "StatusText: %s\r\n"
5490 "\r\n",
5491 exten, context, hint, status,
5493 return 0;
5494}
jack_status_t status
Definition app_jack.c:149
const char * ast_extension_state2str(int extension_state)
Return string representation of the state of an extension.
Definition pbx.c:3162
int ast_get_hint(char *hint, int hintsize, char *name, int namesize, struct ast_channel *c, const char *context, const char *exten)
If an extension hint exists, return non-zero.
Definition pbx.c:4173
int ast_extension_state(struct ast_channel *c, const char *context, const char *exten)
Uses hint and devicestate callback to get the state of an extension.
Definition pbx.c:3206

References ast_extension_state(), ast_extension_state2str(), ast_get_hint(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), NULL, and status.

Referenced by __init_manager().

◆ action_filter()

static int action_filter ( struct mansession s,
const struct message m 
)
static

Manager command to add an event filter to a manager session.

See also
For more details look at manager_add_filter

Definition at line 5691 of file manager.c.

5692{
5693 const char *match_criteria = astman_get_header(m, "MatchCriteria");
5694 const char *filter = astman_get_header(m, "Filter");
5695 const char *operation = astman_get_header(m, "Operation");
5696 int res;
5697
5698 if (!strcasecmp(operation, "Add")) {
5699 char *criteria;
5700 int have_match = !ast_strlen_zero(match_criteria);
5701
5702 /* Create an eventfilter expression.
5703 * eventfilter[(match_criteria)]
5704 */
5705 res = ast_asprintf(&criteria, "eventfilter%s%s%s",
5706 S_COR(have_match, "(", ""), S_OR(match_criteria, ""),
5707 S_COR(have_match, ")", ""));
5708 if (res <= 0) {
5709 astman_send_error(s, m, "Internal Error. Failed to allocate storage for filter type");
5710 return 0;
5711 }
5712
5714 ast_free(criteria);
5715 if (res != FILTER_SUCCESS) {
5716 if (res == FILTER_ALLOC_FAILED) {
5717 astman_send_error(s, m, "Internal Error. Failed to allocate regex for filter");
5718 return 0;
5719 } else if (res == FILTER_COMPILE_FAIL) {
5720 astman_send_error(s, m,
5721 "Filter did not compile. Check the syntax of the filter given.");
5722 return 0;
5723 } else if (res == FILTER_FORMAT_ERROR) {
5724 astman_send_error(s, m,
5725 "Filter was formatted incorrectly. Check the syntax of the filter given.");
5726 return 0;
5727 } else {
5728 astman_send_error(s, m, "Internal Error. Failed adding filter.");
5729 return 0;
5730 }
5731 }
5732
5733 astman_send_ack(s, m, "Success");
5734 return 0;
5735 }
5736
5737 astman_send_error(s, m, "Unknown operation");
5738 return 0;
5739}
static int filter(struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
static enum add_filter_result manager_add_filter(const char *criteria, const char *filter_pattern, struct ao2_container *includefilters, struct ao2_container *excludefilters)
Add an event filter to a manager session.
Definition manager.c:5758
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition strings.h:87
struct ao2_container * excludefilters
Definition manager.c:297
struct ao2_container * includefilters
Definition manager.c:296

References ast_asprintf, ast_free, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), mansession_session::excludefilters, filter(), FILTER_ALLOC_FAILED, FILTER_COMPILE_FAIL, FILTER_FORMAT_ERROR, FILTER_SUCCESS, mansession_session::includefilters, manager_add_filter(), S_COR, S_OR, and mansession::session.

Referenced by __init_manager().

◆ action_find()

static struct manager_action * action_find ( const char *  name)
static

Definition at line 434 of file manager.c.

435{
436 struct manager_action *act;
437
440 if (!strcasecmp(name, act->action)) {
441 ao2_t_ref(act, +1, "found action object");
442 break;
443 }
444 }
446
447 return act;
448}
#define ao2_t_ref(o, delta, tag)
Definition astobj2.h:460
list of actions registered
Definition manager.c:363
struct manager_action::@249 list
const char * action
Definition manager.h:156

References manager_action::action, ao2_t_ref, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, manager_action::list, and name.

Referenced by ast_hook_send_action(), and process_message().

◆ action_getconfig()

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

Definition at line 2503 of file manager.c.

2504{
2505 struct ast_config *cfg;
2506 const char *fn = astman_get_header(m, "Filename");
2507 const char *category = astman_get_header(m, "Category");
2508 const char *filter = astman_get_header(m, "Filter");
2509 const char *category_name;
2510 int catcount = 0;
2511 int lineno = 0;
2512 int ret = 0;
2513 struct ast_category *cur_category = NULL;
2514 struct ast_variable *v;
2515 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2516
2517 if (ast_strlen_zero(fn)) {
2518 astman_send_error(s, m, "Filename not specified");
2519 return 0;
2520 }
2521
2522 ret = is_restricted_file(fn);
2523 if (ret == 1) {
2524 astman_send_error(s, m, "File requires escalated privileges");
2525 return 0;
2526 } else if (ret == -1) {
2527 astman_send_error(s, m, "Config file not found");
2528 return 0;
2529 }
2530
2531 cfg = ast_config_load2(fn, "manager", config_flags);
2532 if (cfg == CONFIG_STATUS_FILEMISSING) {
2533 astman_send_error(s, m, "Config file not found");
2534 return 0;
2535 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2536 astman_send_error(s, m, "Config file has invalid format");
2537 return 0;
2538 }
2539
2540 astman_start_ack(s, m);
2541 while ((cur_category = ast_category_browse_filtered(cfg, category, cur_category, filter))) {
2542 struct ast_str *templates;
2543
2544 category_name = ast_category_get_name(cur_category);
2545 lineno = 0;
2546 astman_append(s, "Category-%06d: %s\r\n", catcount, category_name);
2547
2548 if (ast_category_is_template(cur_category)) {
2549 astman_append(s, "IsTemplate-%06d: %d\r\n", catcount, 1);
2550 }
2551
2552 if ((templates = ast_category_get_templates(cur_category))
2553 && ast_str_strlen(templates) > 0) {
2554 astman_append(s, "Templates-%06d: %s\r\n", catcount, ast_str_buffer(templates));
2556 }
2557
2558 for (v = ast_category_first(cur_category); v; v = v->next) {
2559 astman_append(s, "Line-%06d-%06d: %s=%s\r\n", catcount, lineno++, v->name, v->value);
2560 }
2561
2562 catcount++;
2563 }
2564
2565 if (!ast_strlen_zero(category) && catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2566 astman_append(s, "No categories found\r\n");
2567 }
2568
2569 ast_config_destroy(cfg);
2570 astman_append(s, "\r\n");
2571
2572 return 0;
2573}
static int is_restricted_file(const char *filename)
Check if a file is restricted or not.
Definition manager.c:2470
const char * ast_category_get_name(const struct ast_category *category)
Return the name of the category.
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
#define CONFIG_STATUS_FILEMISSING
struct ast_str * ast_category_get_templates(const struct ast_category *category)
Return the template names this category inherits from.
@ CONFIG_FLAG_NOCACHE
@ CONFIG_FLAG_WITHCOMMENTS
#define CONFIG_STATUS_FILEINVALID
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition extconf.c:1287
int ast_category_is_template(const struct ast_category *category)
Check if category is a template.
struct ast_variable * ast_category_first(struct ast_category *cat)
given a pointer to a category, return the root variable.
struct ast_category * ast_category_browse_filtered(struct ast_config *config, const char *category_name, struct ast_category *prev, const char *filter)
Browse categories with filters.
size_t attribute_pure ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition strings.h:730
Structure used to handle boolean flags.
Definition utils.h:220
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next

References ast_category_browse_filtered(), ast_category_first(), ast_category_get_name(), ast_category_get_templates(), ast_category_is_template(), ast_config_destroy(), ast_config_load2(), ast_free, ast_str_buffer(), ast_str_strlen(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), CONFIG_FLAG_NOCACHE, CONFIG_FLAG_WITHCOMMENTS, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEMISSING, filter(), is_restricted_file(), ast_variable::name, ast_variable::next, NULL, and ast_variable::value.

Referenced by __init_manager().

◆ action_getconfigjson()

static int action_getconfigjson ( struct mansession s,
const struct message m 
)
static

Definition at line 2651 of file manager.c.

2652{
2653 struct ast_config *cfg;
2654 const char *fn = astman_get_header(m, "Filename");
2655 const char *filter = astman_get_header(m, "Filter");
2656 const char *category = astman_get_header(m, "Category");
2657 struct ast_category *cur_category = NULL;
2658 const char *category_name;
2659 struct ast_variable *v;
2660 int comma1 = 0;
2661 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2662
2663 if (ast_strlen_zero(fn)) {
2664 astman_send_error(s, m, "Filename not specified");
2665 return 0;
2666 }
2667
2668 if (is_restricted_file(fn)) {
2669 astman_send_error(s, m, "File requires escalated privileges");
2670 return 0;
2671 }
2672
2673 if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2674 astman_send_error(s, m, "Config file not found");
2675 return 0;
2676 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2677 astman_send_error(s, m, "Config file has invalid format");
2678 return 0;
2679 }
2680
2681 astman_start_ack(s, m);
2682 astman_append(s, "JSON: {");
2683 while ((cur_category = ast_category_browse_filtered(cfg, category, cur_category, filter))) {
2684 int comma2 = 0;
2685 struct ast_str *templates;
2686
2687 category_name = ast_category_get_name(cur_category);
2688 astman_append(s, "%s\"", comma1 ? "," : "");
2689 astman_append_json(s, category_name);
2690 astman_append(s, "\":{");
2691 comma1 = 1;
2692
2693 if (ast_category_is_template(cur_category)) {
2694 astman_append(s, "\"istemplate\":1");
2695 comma2 = 1;
2696 }
2697
2698 if ((templates = ast_category_get_templates(cur_category))
2699 && ast_str_strlen(templates) > 0) {
2700 astman_append(s, "%s", comma2 ? "," : "");
2701 astman_append(s, "\"templates\":\"%s\"", ast_str_buffer(templates));
2703 comma2 = 1;
2704 }
2705
2706 for (v = ast_category_first(cur_category); v; v = v->next) {
2707 astman_append(s, "%s\"", comma2 ? "," : "");
2708 astman_append_json(s, v->name);
2709 astman_append(s, "\":\"");
2711 astman_append(s, "\"");
2712 comma2 = 1;
2713 }
2714
2715 astman_append(s, "}");
2716 }
2717 astman_append(s, "}\r\n\r\n");
2718
2719 ast_config_destroy(cfg);
2720
2721 return 0;
2722}
static void astman_append_json(struct mansession *s, const char *str)
Definition manager.c:2642

References ast_category_browse_filtered(), ast_category_first(), ast_category_get_name(), ast_category_get_templates(), ast_category_is_template(), ast_config_destroy(), ast_config_load2(), ast_free, ast_str_buffer(), ast_str_strlen(), ast_strlen_zero(), astman_append(), astman_append_json(), astman_get_header(), astman_send_error(), astman_start_ack(), CONFIG_FLAG_NOCACHE, CONFIG_FLAG_WITHCOMMENTS, CONFIG_STATUS_FILEINVALID, filter(), is_restricted_file(), ast_variable::name, ast_variable::next, NULL, and ast_variable::value.

Referenced by __init_manager().

◆ action_getvar()

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

Definition at line 3587 of file manager.c.

3588{
3589 struct ast_channel *c = NULL;
3590 const char *name = astman_get_header(m, "Channel");
3591 const char *varname = astman_get_header(m, "Variable");
3592 char *varval;
3593 char workspace[1024];
3594
3595 if (ast_strlen_zero(varname)) {
3596 astman_send_error(s, m, "No variable specified");
3597 return 0;
3598 }
3599
3600 /* We don't want users with insufficient permissions using certain functions. */
3602 astman_send_error(s, m, "GetVar Access Forbidden: Variable");
3603 return 0;
3604 }
3605
3606 if (!ast_strlen_zero(name)) {
3607 if (!(c = ast_channel_get_by_name(name))) {
3608 astman_send_error(s, m, "No such channel");
3609 return 0;
3610 }
3611 }
3612
3613 workspace[0] = '\0';
3614 if (varname[strlen(varname) - 1] == ')') {
3615 if (!c) {
3617 if (c) {
3618 ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3619 } else
3620 ast_log(LOG_ERROR, "Unable to allocate bogus channel for variable substitution. Function results may be blank.\n");
3621 } else {
3622 ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3623 }
3624 varval = workspace;
3625 } else {
3626 pbx_retrieve_variable(c, varname, &varval, workspace, sizeof(workspace), NULL);
3627 }
3628
3629 if (c) {
3631 }
3632
3633 astman_start_ack(s, m);
3634 astman_append(s, "Variable: %s\r\nValue: %s\r\n\r\n", varname, S_OR(varval, ""));
3635
3636 return 0;
3637}
#define ast_dummy_channel_alloc()
Create a fake channel structure.
Definition channel.h:1328
static int function_capable_string_allowed_with_auths(const char *evaluating, int writepermlist)
Checks to see if a string which can be used to evaluate functions should be rejected.
Definition manager.c:777
#define LOG_ERROR
int ast_func_read(struct ast_channel *chan, const char *function, char *workspace, size_t len)
executes a read operation on a function
void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
Retrieve the value of a builtin variable or variable from the channel variable stack.
static struct test_val c

References ast_channel_get_by_name(), ast_channel_unref, ast_dummy_channel_alloc, ast_func_read(), ast_log, ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), c, function_capable_string_allowed_with_auths(), LOG_ERROR, name, NULL, pbx_retrieve_variable(), S_OR, mansession::session, and mansession_session::writeperm.

Referenced by __init_manager().

◆ action_hangup()

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

Definition at line 3548 of file manager.c.

3549{
3550 return ast_manager_hangup_helper(s, m,
3552}
void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode)
Lock the given channel, then request softhangup on the channel with the given causecode.
Definition channel.c:469
int ast_manager_hangup_helper(struct mansession *s, const struct message *m, manager_hangup_handler_t hangup_handler, manager_hangup_cause_validator_t cause_validator)
A manager helper function that hangs up a channel using a supplied channel type specific hangup funct...
Definition manager.c:3427

References ast_channel_softhangup_withcause_locked(), ast_manager_hangup_helper(), and NULL.

Referenced by __init_manager().

◆ action_listcategories()

static int action_listcategories ( struct mansession s,
const struct message m 
)
static

Definition at line 2575 of file manager.c.

2576{
2577 struct ast_config *cfg;
2578 const char *fn = astman_get_header(m, "Filename");
2579 const char *match = astman_get_header(m, "Match");
2580 struct ast_category *category = NULL;
2581 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2582 int catcount = 0;
2583 int ret = 0;
2584
2585 if (ast_strlen_zero(fn)) {
2586 astman_send_error(s, m, "Filename not specified");
2587 return 0;
2588 }
2589
2590 ret = is_restricted_file(fn);
2591 if (ret == 1) {
2592 astman_send_error(s, m, "File requires escalated privileges");
2593 return 0;
2594 } else if (ret == -1) {
2595 astman_send_error(s, m, "Config file not found");
2596 return 0;
2597 }
2598
2599 if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2600 astman_send_error(s, m, "Config file not found");
2601 return 0;
2602 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2603 astman_send_error(s, m, "Config file has invalid format");
2604 return 0;
2605 }
2606
2607 astman_start_ack(s, m);
2608 while ((category = ast_category_browse_filtered(cfg, NULL, category, match))) {
2609 astman_append(s, "Category-%06d: %s\r\n", catcount, ast_category_get_name(category));
2610 catcount++;
2611 }
2612
2613 if (catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2614 astman_append(s, "Error: no categories found\r\n");
2615 }
2616
2617 ast_config_destroy(cfg);
2618 astman_append(s, "\r\n");
2619
2620 return 0;
2621}
static int match(struct ast_sockaddr *addr, unsigned short callno, unsigned short dcallno, const struct chan_iax2_pvt *cur, int check_dcallno)
Definition chan_iax2.c:2388

References ast_category_browse_filtered(), ast_category_get_name(), ast_config_destroy(), ast_config_load2(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), CONFIG_FLAG_NOCACHE, CONFIG_FLAG_WITHCOMMENTS, CONFIG_STATUS_FILEINVALID, is_restricted_file(), match(), and NULL.

Referenced by __init_manager().

◆ action_listcommands()

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

Definition at line 3291 of file manager.c.

3292{
3293 struct manager_action *cur;
3295
3296 astman_start_ack(s, m);
3298 AST_RWLIST_TRAVERSE(&actions, cur, list) {
3299 if ((s->session->writeperm & cur->authority) || cur->authority == 0) {
3300 astman_append(s, "%s: %s (Priv: %s)\r\n",
3301 cur->action, cur->synopsis, authority_to_str(cur->authority, &temp));
3302 }
3303 }
3305 astman_append(s, "\r\n");
3306
3307 return 0;
3308}

References manager_action::action, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_str_alloca, astman_append(), astman_start_ack(), manager_action::authority, authority_to_str(), MAX_AUTH_PERM_STRING, mansession::session, manager_action::synopsis, and mansession_session::writeperm.

Referenced by __init_manager().

◆ action_loggerrotate()

static int action_loggerrotate ( struct mansession s,
const struct message m 
)
static

Manager command "LoggerRotate" - reloads and rotates the logger in the same manner as the CLI command 'logger rotate'.

Definition at line 6835 of file manager.c.

6836{
6837 if (ast_logger_rotate()) {
6838 astman_send_error(s, m, "Failed to reload the logger and rotate log files");
6839 return 0;
6840 }
6841
6842 astman_send_ack(s, m, "Reloaded the logger and rotated log files");
6843 return 0;
6844}
int ast_logger_rotate(void)
Reload logger while rotating log files.
Definition logger.c:1307

References ast_logger_rotate(), astman_send_ack(), and astman_send_error().

Referenced by __init_manager().

◆ action_login()

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

Definition at line 3360 of file manager.c.

3361{
3362
3363 /* still authenticated - don't process again */
3364 if (s->session->authenticated) {
3365 astman_send_ack(s, m, "Already authenticated");
3366 return 0;
3367 }
3368
3369 if (authenticate(s, m)) {
3370 sleep(1);
3371 astman_send_error(s, m, "Authentication failed");
3372 return -1;
3373 }
3374 s->session->authenticated = 1;
3377 ast_verb(2, "%sManager '%s' logged on from %s\n", (s->session->managerid ? "HTTP " : ""), s->session->username, ast_sockaddr_stringify_addr(&s->session->addr));
3378 }
3379 astman_send_ack(s, m, "Authentication accepted");
3382 && ast_fully_booted) {
3384 const char *cat_str = authority_to_str(EVENT_FLAG_SYSTEM, &auth);
3385 long uptime = 0;
3386 long lastreloaded = 0;
3387 struct timeval tmp;
3388 struct timeval curtime = ast_tvnow();
3389
3390 if (ast_startuptime.tv_sec) {
3391 tmp = ast_tvsub(curtime, ast_startuptime);
3392 uptime = tmp.tv_sec;
3393 }
3394
3395 if (ast_lastreloadtime.tv_sec) {
3396 tmp = ast_tvsub(curtime, ast_lastreloadtime);
3397 lastreloaded = tmp.tv_sec;
3398 }
3399
3400 astman_append(s, "Event: FullyBooted\r\n"
3401 "Privilege: %s\r\n"
3402 "Uptime: %ld\r\n"
3403 "LastReload: %ld\r\n"
3404 "Status: Fully Booted\r\n\r\n", cat_str, uptime, lastreloaded);
3405 }
3406 return 0;
3407}
static int manager_displayconnects(struct mansession_session *session)
Get displayconnects config option.
Definition manager.c:1059
static int unauth_sessions
Definition manager.c:178
static int authenticate(struct mansession *s, const struct message *m)
Definition manager.c:2334
#define ast_verb(level,...)
#define EVENT_FLAG_SYSTEM
Definition manager.h:75
static char * ast_sockaddr_stringify_addr(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() to return an address only.
Definition netsock2.h:286
#define ast_fully_booted
Definition options.h:127
uint32_t managerid
Definition manager.c:285
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition extconf.c:2295

References mansession_session::addr, ast_atomic_fetchadd_int(), ast_fully_booted, ast_lastreloadtime, ast_sockaddr_stringify_addr(), ast_startuptime, ast_str_alloca, ast_tvnow(), ast_tvsub(), ast_verb, astman_append(), astman_send_ack(), astman_send_error(), authenticate(), mansession_session::authenticated, authority_to_str(), EVENT_FLAG_SYSTEM, manager_displayconnects(), mansession_session::managerid, MAX_AUTH_PERM_STRING, mansession_session::readperm, mansession_session::send_events, mansession::session, unauth_sessions, and mansession_session::username.

Referenced by __init_manager().

◆ action_logoff()

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

Definition at line 3354 of file manager.c.

3355{
3356 astman_send_response(s, m, "Goodbye", "Thanks for all the fish.");
3357 return -1;
3358}
void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg)
Send response in manager transaction.
Definition manager.c:1983

References astman_send_response().

Referenced by __init_manager().

◆ action_mailboxcount()

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

Definition at line 5445 of file manager.c.

5446{
5447 const char *mailbox = astman_get_header(m, "Mailbox");
5448 int newmsgs = 0, oldmsgs = 0, urgentmsgs = 0;;
5449
5450 if (ast_strlen_zero(mailbox)) {
5451 astman_send_error(s, m, "Mailbox not specified");
5452 return 0;
5453 }
5454 ast_app_inboxcount2(mailbox, &urgentmsgs, &newmsgs, &oldmsgs);
5455 astman_start_ack(s, m);
5456 astman_append(s, "Message: Mailbox Message Count\r\n"
5457 "Mailbox: %s\r\n"
5458 "UrgMessages: %d\r\n"
5459 "NewMessages: %d\r\n"
5460 "OldMessages: %d\r\n"
5461 "\r\n",
5462 mailbox, urgentmsgs, newmsgs, oldmsgs);
5463 return 0;
5464}
int ast_app_inboxcount2(const char *mailboxes, int *urgentmsgs, int *newmsgs, int *oldmsgs)
Determine number of urgent/new/old messages in a mailbox.
Definition main/app.c:619

References ast_app_inboxcount2(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), and astman_start_ack().

Referenced by __init_manager().

◆ action_mailboxstatus()

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

Definition at line 5428 of file manager.c.

5429{
5430 const char *mailbox = astman_get_header(m, "Mailbox");
5431 int ret;
5432
5433 if (ast_strlen_zero(mailbox)) {
5434 astman_send_error(s, m, "Mailbox not specified");
5435 return 0;
5436 }
5437 ret = ast_app_has_voicemail(mailbox, NULL);
5438 astman_start_ack(s, m);
5439 astman_append(s, "Message: Mailbox Status\r\n"
5440 "Mailbox: %s\r\n"
5441 "Waiting: %d\r\n\r\n", mailbox, ret);
5442 return 0;
5443}
int ast_app_has_voicemail(const char *mailboxes, const char *folder)
Determine if a given mailbox has any voicemail If folder is NULL, defaults to "INBOX"....
Definition main/app.c:582

References ast_app_has_voicemail(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_start_ack(), and NULL.

Referenced by __init_manager().

◆ action_originate()

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

Definition at line 5233 of file manager.c.

5234{
5235 const char *name = astman_get_header(m, "Channel");
5236 const char *exten = astman_get_header(m, "Exten");
5237 const char *context = astman_get_header(m, "Context");
5238 const char *priority = astman_get_header(m, "Priority");
5239 const char *timeout = astman_get_header(m, "Timeout");
5240 const char *callerid = astman_get_header(m, "CallerID");
5241 const char *account = astman_get_header(m, "Account");
5242 const char *app = astman_get_header(m, "Application");
5243 const char *appdata = astman_get_header(m, "Data");
5244 const char *async = astman_get_header(m, "Async");
5245 const char *id = astman_get_header(m, "ActionID");
5246 const char *codecs = astman_get_header(m, "Codecs");
5247 const char *early_media = astman_get_header(m, "Earlymedia");
5248 struct ast_assigned_ids assignedids = {
5249 .uniqueid = astman_get_header(m, "ChannelId"),
5250 .uniqueid2 = astman_get_header(m, "OtherChannelId"),
5251 };
5252 const char *gosub = astman_get_header(m, "PreDialGoSub");
5253
5254 struct ast_variable *vars = NULL;
5255 char *tech, *data;
5256 char *l = NULL, *n = NULL;
5257 int pi = 0;
5258 int res;
5259 int to = 30000;
5260 int reason = 0;
5261 char tmp[256];
5262 char tmp2[256];
5264 pthread_t th;
5265 int bridge_early = 0;
5266
5267 if (!cap) {
5268 astman_send_error(s, m, "Internal Error. Memory allocation failure.");
5269 return 0;
5270 }
5272
5273 if ((assignedids.uniqueid && AST_MAX_PUBLIC_UNIQUEID < strlen(assignedids.uniqueid))
5274 || (assignedids.uniqueid2 && AST_MAX_PUBLIC_UNIQUEID < strlen(assignedids.uniqueid2))) {
5275 astman_send_error_va(s, m, "Uniqueid length exceeds maximum of %d\n",
5277 res = 0;
5278 goto fast_orig_cleanup;
5279 }
5280
5281 if (ast_strlen_zero(name)) {
5282 astman_send_error(s, m, "Channel not specified");
5283 res = 0;
5284 goto fast_orig_cleanup;
5285 }
5286 if (!ast_strlen_zero(priority) && (sscanf(priority, "%30d", &pi) != 1)) {
5287 if ((pi = ast_findlabel_extension(NULL, context, exten, priority, NULL)) < 1) {
5288 astman_send_error(s, m, "Invalid priority");
5289 res = 0;
5290 goto fast_orig_cleanup;
5291 }
5292 }
5293 if (!ast_strlen_zero(timeout) && (sscanf(timeout, "%30d", &to) != 1)) {
5294 astman_send_error(s, m, "Invalid timeout");
5295 res = 0;
5296 goto fast_orig_cleanup;
5297 }
5298 ast_copy_string(tmp, name, sizeof(tmp));
5299 tech = tmp;
5300 data = strchr(tmp, '/');
5301 if (!data) {
5302 astman_send_error(s, m, "Invalid channel");
5303 res = 0;
5304 goto fast_orig_cleanup;
5305 }
5306 *data++ = '\0';
5307 ast_copy_string(tmp2, callerid, sizeof(tmp2));
5308 ast_callerid_parse(tmp2, &n, &l);
5309 if (n) {
5310 if (ast_strlen_zero(n)) {
5311 n = NULL;
5312 }
5313 }
5314 if (l) {
5316 if (ast_strlen_zero(l)) {
5317 l = NULL;
5318 }
5319 }
5320 if (!ast_strlen_zero(codecs)) {
5323 }
5324
5325 if (!ast_strlen_zero(app) && s->session) {
5326 if (!is_originate_app_permitted(app, appdata, s->session->writeperm)) {
5327 astman_send_error(s, m, "Originate Access Forbidden: app or data blacklisted");
5328 res = 0;
5329 goto fast_orig_cleanup;
5330 }
5331 }
5332
5333 /* Check early if the extension exists. If not, we need to bail out here. */
5334 if (exten && context && pi) {
5335 if (! ast_exists_extension(NULL, context, exten, pi, l)) {
5336 /* The extension does not exist. */
5337 astman_send_error(s, m, "Extension does not exist.");
5338 res = 0;
5339 goto fast_orig_cleanup;
5340 }
5341 }
5342
5343 /* Allocate requested channel variables */
5344 vars = astman_get_variables(m);
5345 if (s->session && s->session->chanvars) {
5346 struct ast_variable *v, *old;
5347 old = vars;
5348 vars = NULL;
5349
5350 /* The variables in the AMI originate action are appended at the end of the list, to override any user variables that apply */
5351
5353 if (old) {
5354 for (v = vars; v->next; v = v->next );
5355 v->next = old; /* Append originate variables at end of list */
5356 }
5357 }
5358
5359 /* For originate async - we can bridge in early media stage */
5360 bridge_early = ast_true(early_media);
5361
5362 if (ast_true(async)) {
5363 struct fast_originate_helper *fast;
5364
5365 fast = ast_calloc(1, sizeof(*fast));
5366 if (!fast || ast_string_field_init(fast, 252)) {
5367 ast_free(fast);
5369 res = -1;
5370 } else {
5371 if (!ast_strlen_zero(id)) {
5372 ast_string_field_build(fast, idtext, "ActionID: %s\r\n", id);
5373 }
5378 ast_string_field_set(fast, cid_num, l);
5383 ast_string_field_set(fast, channelid, assignedids.uniqueid);
5384 ast_string_field_set(fast, otherchannelid, assignedids.uniqueid2);
5385 fast->vars = vars;
5386 fast->cap = cap;
5387 cap = NULL; /* transferred originate helper the capabilities structure. It is now responsible for freeing it. */
5388 fast->timeout = to;
5389 fast->early_media = bridge_early;
5390 fast->priority = pi;
5393 res = -1;
5394 } else {
5395 res = 0;
5396 }
5397 }
5398 } else if (!ast_strlen_zero(app)) {
5399 res = ast_pbx_outgoing_app(tech, cap, data, to, app, appdata, &reason,
5401 assignedids.uniqueid ? &assignedids : NULL);
5403 } else {
5404 if (exten && context && pi) {
5406 context, exten, pi, &reason, AST_OUTGOING_WAIT,
5407 l, n, vars, account, NULL, bridge_early,
5408 assignedids.uniqueid ? &assignedids : NULL , gosub);
5410 } else {
5411 astman_send_error(s, m, "Originate with 'Exten' requires 'Context' and 'Priority'");
5413 res = 0;
5414 goto fast_orig_cleanup;
5415 }
5416 }
5417 if (!res) {
5418 astman_send_ack(s, m, "Originate successfully queued");
5419 } else {
5420 astman_send_error(s, m, "Originate failed");
5421 }
5422
5423fast_orig_cleanup:
5425 return 0;
5426}
static const char app[]
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
int ast_callerid_parse(char *instr, char **name, char **location)
Destructively parse inbuf into name and location (or number)
Definition callerid.c:1162
void ast_shrink_phone_number(char *n)
Shrink a phone number in place to just digits (more accurately it just removes ()'s,...
Definition callerid.c:1101
static int priority
#define AST_MAX_PUBLIC_UNIQUEID
Definition channel.h:147
static struct ao2_container * codecs
Registered codecs.
Definition codec.c:48
@ AST_MEDIA_TYPE_UNKNOWN
Definition codec.h:31
struct ast_format * ast_format_slin
Built-in cached signed linear 8kHz format.
int ast_format_cap_update_by_allow_disallow(struct ast_format_cap *cap, const char *list, int allowing)
Parse an "allow" or "deny" list and modify a format capabilities structure accordingly.
Definition format_cap.c:320
void ast_format_cap_remove_by_type(struct ast_format_cap *cap, enum ast_media_type type)
Remove all formats matching a specific format type.
Definition format_cap.c:523
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition format_cap.h:38
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition format_cap.h:99
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition format_cap.h:49
static int is_originate_app_permitted(const char *app, const char *data, int permission)
Definition manager.c:5127
static void destroy_fast_originate_helper(struct fast_originate_helper *doomed)
Definition manager.c:4389
struct ast_variable * astman_get_variables(const struct message *m)
Get a linked list of the Variable: headers.
Definition manager.c:1735
static void * fast_originate(void *data)
Definition manager.c:4397
struct ast_variable * ast_variables_dup(struct ast_variable *var)
Duplicate variable list.
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition extconf.c:1260
int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
Find the priority of an extension that has the specified label.
Definition pbx.c:4216
int ast_pbx_outgoing_exten_predial(const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *context, const char *exten, int priority, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, int early_media, const struct ast_assigned_ids *assignedids, const char *predial_callee)
Definition pbx.c:7970
@ AST_OUTGOING_WAIT
Definition pbx.h:1145
int ast_pbx_outgoing_app(const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *app, const char *appdata, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, const struct ast_assigned_ids *assignedids)
Synchronously or asynchronously make an outbound call and execute an application on the channel.
Definition pbx.c:8024
int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
Determine whether an extension exists.
Definition pbx.c:4211
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition utils.c:2233
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425
Structure to pass both assignedid values to channel drivers.
Definition channel.h:606
const char * uniqueid2
Definition channel.h:608
const char * uniqueid
Definition channel.h:607
Format capabilities structure, holds formats + preference order + etc.
Definition format_cap.c:54
helper function for originate
Definition manager.c:4361
const ast_string_field appdata
Definition manager.c:4379
struct ast_variable * vars
Definition manager.c:4381
const ast_string_field cid_num
Definition manager.c:4379
const ast_string_field account
Definition manager.c:4379
const ast_string_field tech
Definition manager.c:4379
const ast_string_field data
Definition manager.c:4379
const ast_string_field context
Definition manager.c:4379
const ast_string_field channelid
Definition manager.c:4379
const ast_string_field otherchannelid
Definition manager.c:4379
struct ast_format_cap * cap
Definition manager.c:4363
const ast_string_field exten
Definition manager.c:4379
const ast_string_field idtext
Definition manager.c:4379
const ast_string_field cid_name
Definition manager.c:4379
struct ast_variable * chanvars
Definition manager.c:298
#define ast_pthread_create_detached(a, b, c, d)
Definition utils.h:628

References ao2_cleanup, app, ast_callerid_parse(), ast_calloc, ast_copy_string(), ast_exists_extension(), ast_findlabel_extension(), ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_remove_by_type(), ast_format_cap_update_by_allow_disallow(), ast_format_slin, ast_free, AST_MAX_PUBLIC_UNIQUEID, AST_MEDIA_TYPE_UNKNOWN, AST_OUTGOING_WAIT, ast_pbx_outgoing_app(), ast_pbx_outgoing_exten_predial(), ast_pthread_create_detached, ast_shrink_phone_number(), ast_string_field_build, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), ast_true(), ast_variables_destroy(), ast_variables_dup(), astman_get_header(), astman_get_variables(), astman_send_ack(), astman_send_error(), astman_send_error_va(), fast_originate_helper::cap, mansession_session::chanvars, codecs, destroy_fast_originate_helper(), fast_originate_helper::early_media, fast_originate(), is_originate_app_permitted(), name, ast_variable::next, NULL, priority, fast_originate_helper::priority, mansession::session, fast_originate_helper::timeout, ast_assigned_ids::uniqueid, ast_assigned_ids::uniqueid2, fast_originate_helper::vars, and mansession_session::writeperm.

Referenced by __init_manager().

◆ action_ping()

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

Definition at line 2431 of file manager.c.

2432{
2433 const char *actionid = astman_get_header(m, "ActionID");
2434 struct timeval now = ast_tvnow();
2435
2436 astman_append(s, "Response: Success\r\n");
2437 if (!ast_strlen_zero(actionid)){
2438 astman_append(s, "ActionID: %s\r\n", actionid);
2439 }
2441 s,
2442 "Ping: Pong\r\n"
2443 "Timestamp: %ld.%06lu\r\n"
2444 "\r\n",
2445 (long) now.tv_sec, (unsigned long) now.tv_usec);
2446 return 0;
2447}

References ast_strlen_zero(), ast_tvnow(), astman_append(), and astman_get_header().

Referenced by __init_manager().

◆ action_presencestate()

static int action_presencestate ( struct mansession s,
const struct message m 
)
static

Definition at line 5496 of file manager.c.

5497{
5498 const char *provider = astman_get_header(m, "Provider");
5500 char *subtype;
5501 char *message;
5502
5504 astman_send_error(s, m, "No provider specified");
5505 return 0;
5506 }
5507
5509 if (state == AST_PRESENCE_INVALID) {
5510 astman_send_error_va(s, m, "Invalid provider %s or provider in invalid state", provider);
5511 return 0;
5512 }
5513
5514 astman_start_ack(s, m);
5515 astman_append(s, "Message: Presence State\r\n"
5516 "State: %s\r\n", ast_presence_state2str(state));
5517
5518 if (!ast_strlen_zero(subtype)) {
5519 astman_append(s, "Subtype: %s\r\n", subtype);
5520 }
5521
5522 if (!ast_strlen_zero(message)) {
5523 /* XXX The Message header here is deprecated as it
5524 * duplicates the action response header 'Message'.
5525 * Remove it in the next major revision of AMI.
5526 */
5527 astman_append(s, "Message: %s\r\n"
5528 "PresenceMessage: %s\r\n",
5529 message, message);
5530 }
5531 astman_append(s, "\r\n");
5532
5533 ast_free(subtype);
5535
5536 return 0;
5537}
static struct prometheus_metrics_provider provider
Definition bridges.c:201
ast_presence_state
@ AST_PRESENCE_INVALID
const char * ast_presence_state2str(enum ast_presence_state state)
Convert presence state to text string for output.

References ast_free, AST_PRESENCE_INVALID, ast_presence_state2str(), ast_strlen_zero(), astman_append(), astman_get_header(), astman_send_error(), astman_send_error_va(), astman_start_ack(), and provider.

Referenced by __init_manager().

◆ action_redirect()

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

action_redirect: The redirect manager command

Definition at line 3959 of file manager.c.

3960{
3961 char buf[256];
3962 const char *name = astman_get_header(m, "Channel");
3963 const char *name2 = astman_get_header(m, "ExtraChannel");
3964 const char *exten = astman_get_header(m, "Exten");
3965 const char *exten2 = astman_get_header(m, "ExtraExten");
3966 const char *context = astman_get_header(m, "Context");
3967 const char *context2 = astman_get_header(m, "ExtraContext");
3968 const char *priority = astman_get_header(m, "Priority");
3969 const char *priority2 = astman_get_header(m, "ExtraPriority");
3970 struct ast_channel *chan;
3971 struct ast_channel *chan2;
3972 int pi = 0;
3973 int pi2 = 0;
3974 int res;
3975 int chan1_wait = 0;
3976 int chan2_wait = 0;
3977
3978 if (ast_strlen_zero(name)) {
3979 astman_send_error(s, m, "Channel not specified");
3980 return 0;
3981 }
3982
3983 if (ast_strlen_zero(context)) {
3984 astman_send_error(s, m, "Context not specified");
3985 return 0;
3986 }
3987 if (ast_strlen_zero(exten)) {
3988 astman_send_error(s, m, "Exten not specified");
3989 return 0;
3990 }
3992 astman_send_error(s, m, "Priority not specified");
3993 return 0;
3994 }
3995 if (sscanf(priority, "%30d", &pi) != 1) {
3997 }
3998 if (pi < 1) {
3999 astman_send_error(s, m, "Priority is invalid");
4000 return 0;
4001 }
4002
4003 if (!ast_strlen_zero(name2) && !ast_strlen_zero(context2)) {
4004 /* We have an ExtraChannel and an ExtraContext */
4005 if (ast_strlen_zero(exten2)) {
4006 astman_send_error(s, m, "ExtraExten not specified");
4007 return 0;
4008 }
4009 if (ast_strlen_zero(priority2)) {
4010 astman_send_error(s, m, "ExtraPriority not specified");
4011 return 0;
4012 }
4013 if (sscanf(priority2, "%30d", &pi2) != 1) {
4014 pi2 = ast_findlabel_extension(NULL, context2, exten2, priority2, NULL);
4015 }
4016 if (pi2 < 1) {
4017 astman_send_error(s, m, "ExtraPriority is invalid");
4018 return 0;
4019 }
4020 }
4021
4023 if (!chan) {
4024 snprintf(buf, sizeof(buf), "Channel does not exist: %s", name);
4025 astman_send_error(s, m, buf);
4026 return 0;
4027 }
4028 if (ast_check_hangup_locked(chan)) {
4029 astman_send_error(s, m, "Redirect failed, channel not up.");
4030 chan = ast_channel_unref(chan);
4031 return 0;
4032 }
4033
4034 if (ast_strlen_zero(name2)) {
4035 /* Single channel redirect in progress. */
4037 if (!res) {
4038 astman_send_ack(s, m, "Redirect successful");
4039 } else {
4040 astman_send_error(s, m, "Redirect failed");
4041 }
4042 chan = ast_channel_unref(chan);
4043 return 0;
4044 }
4045
4046 chan2 = ast_channel_get_by_name(name2);
4047 if (!chan2) {
4048 snprintf(buf, sizeof(buf), "ExtraChannel does not exist: %s", name2);
4049 astman_send_error(s, m, buf);
4050 chan = ast_channel_unref(chan);
4051 return 0;
4052 }
4053 if (ast_check_hangup_locked(chan2)) {
4054 astman_send_error(s, m, "Redirect failed, extra channel not up.");
4055 chan2 = ast_channel_unref(chan2);
4056 chan = ast_channel_unref(chan);
4057 return 0;
4058 }
4059
4060 /* Dual channel redirect in progress. */
4061 ast_channel_lock(chan);
4062 if (ast_channel_is_bridged(chan)) {
4064 chan1_wait = 1;
4065 }
4066 ast_channel_unlock(chan);
4067
4068 ast_channel_lock(chan2);
4069 if (ast_channel_is_bridged(chan2)) {
4071 chan2_wait = 1;
4072 }
4073 ast_channel_unlock(chan2);
4074
4076 if (!res) {
4077 if (!ast_strlen_zero(context2)) {
4078 res = async_goto_with_discard_bridge_after(chan2, context2, exten2, pi2);
4079 } else {
4081 }
4082 if (!res) {
4083 astman_send_ack(s, m, "Dual Redirect successful");
4084 } else {
4085 astman_send_error(s, m, "Secondary redirect failed");
4086 }
4087 } else {
4088 astman_send_error(s, m, "Redirect failed");
4089 }
4090
4091 /* Release the bridge wait. */
4092 if (chan1_wait) {
4094 }
4095 if (chan2_wait) {
4097 }
4098
4099 chan2 = ast_channel_unref(chan2);
4100 chan = ast_channel_unref(chan);
4101 return 0;
4102}
void ast_channel_clear_flag(struct ast_channel *chan, unsigned int flag)
Clear a flag on a channel.
Definition channel.c:11122
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int ast_check_hangup_locked(struct ast_channel *chan)
Definition channel.c:460
int ast_channel_is_bridged(const struct ast_channel *chan)
Determine if a channel is in a bridge.
Definition channel.c:10633
@ AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT
Definition channel.h:1055
static int async_goto_with_discard_bridge_after(struct ast_channel *chan, const char *context, const char *exten, int priority)
Definition manager.c:3952
#define ast_set_flag(p, flag)
Definition utils.h:71

References ast_channel_clear_flag(), ast_channel_flags(), ast_channel_get_by_name(), ast_channel_is_bridged(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, ast_check_hangup_locked(), ast_findlabel_extension(), AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT, ast_set_flag, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), async_goto_with_discard_bridge_after(), buf, name, NULL, and priority.

Referenced by __init_manager().

◆ action_reload()

static int action_reload ( struct mansession s,
const struct message m 
)
static

Send a reload event.

Definition at line 6554 of file manager.c.

6555{
6556 const char *module = astman_get_header(m, "Module");
6558
6559 switch (res) {
6561 astman_send_error(s, m, "No such module");
6562 break;
6564 astman_send_error(s, m, "Module does not support reload");
6565 break;
6567 astman_send_error(s, m, "An unknown error occurred");
6568 break;
6570 astman_send_error(s, m, "A reload is in progress");
6571 break;
6573 astman_send_error(s, m, "Module not initialized");
6574 break;
6577 /* Treat a queued request as success */
6578 astman_send_ack(s, m, "Module Reloaded");
6579 break;
6580 }
6581 return 0;
6582}
ast_module_reload_result
Possible return types for ast_module_reload.
Definition module.h:109
@ AST_MODULE_RELOAD_IN_PROGRESS
Definition module.h:114
@ AST_MODULE_RELOAD_QUEUED
Definition module.h:111
@ AST_MODULE_RELOAD_SUCCESS
Definition module.h:110
@ AST_MODULE_RELOAD_ERROR
Definition module.h:113
@ AST_MODULE_RELOAD_NOT_IMPLEMENTED
Definition module.h:116
@ AST_MODULE_RELOAD_NOT_FOUND
Definition module.h:112
@ AST_MODULE_RELOAD_UNINITIALIZED
Definition module.h:115
enum ast_module_reload_result ast_module_reload(const char *name)
Reload asterisk modules.
Definition loader.c:1730

References ast_module_reload(), AST_MODULE_RELOAD_ERROR, AST_MODULE_RELOAD_IN_PROGRESS, AST_MODULE_RELOAD_NOT_FOUND, AST_MODULE_RELOAD_NOT_IMPLEMENTED, AST_MODULE_RELOAD_QUEUED, AST_MODULE_RELOAD_SUCCESS, AST_MODULE_RELOAD_UNINITIALIZED, astman_send_ack(), astman_send_error(), NULL, and S_OR.

Referenced by __init_manager().

◆ action_sendtext()

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

Definition at line 3910 of file manager.c.

3911{
3912 struct ast_channel *c;
3913 const char *name = astman_get_header(m, "Channel");
3914 const char *textmsg = astman_get_header(m, "Message");
3915 const char *content_type = astman_get_header(m, "Content-Type");
3916 int res;
3917
3918 if (ast_strlen_zero(name)) {
3919 astman_send_error(s, m, "No channel specified");
3920 return 0;
3921 }
3922
3923 if (ast_strlen_zero(textmsg)) {
3924 astman_send_error(s, m, "No Message specified");
3925 return 0;
3926 }
3927
3929 if (!c) {
3930 astman_send_error(s, m, "No such channel");
3931 return 0;
3932 }
3933
3934 /*
3935 * If the "extra" data is not available, then send using "string" only.
3936 * Doing such maintains backward compatibilities.
3937 */
3938 res = ast_strlen_zero(content_type) ? queue_sendtext(c, textmsg) :
3939 queue_sendtext_data(c, textmsg, content_type);
3940
3942
3943 if (res >= 0) {
3944 astman_send_ack(s, m, "Success");
3945 } else {
3946 astman_send_error(s, m, "Failure");
3947 }
3948
3949 return 0;
3950}
static int queue_sendtext_data(struct ast_channel *chan, const char *body, const char *content_type)
Queue a read action to send a text data message.
Definition manager.c:3891
static int queue_sendtext(struct ast_channel *chan, const char *body)
Queue a read action to send a text message.
Definition manager.c:3875

References ast_channel_get_by_name(), ast_channel_unref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), c, name, queue_sendtext(), and queue_sendtext_data().

Referenced by __init_manager().

◆ action_setvar()

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

Definition at line 3554 of file manager.c.

3555{
3556 struct ast_channel *c = NULL;
3557 const char *name = astman_get_header(m, "Channel");
3558 const char *varname = astman_get_header(m, "Variable");
3559 const char *varval = astman_get_header(m, "Value");
3560 int res = 0;
3561
3562 if (ast_strlen_zero(varname)) {
3563 astman_send_error(s, m, "No variable specified");
3564 return 0;
3565 }
3566
3567 if (!ast_strlen_zero(name)) {
3568 if (!(c = ast_channel_get_by_name(name))) {
3569 astman_send_error(s, m, "No such channel");
3570 return 0;
3571 }
3572 }
3573
3574 res = pbx_builtin_setvar_helper(c, varname, S_OR(varval, ""));
3575
3576 if (c) {
3578 }
3579 if (res == 0) {
3580 astman_send_ack(s, m, "Variable Set");
3581 } else {
3582 astman_send_error(s, m, "Variable not set");
3583 }
3584 return 0;
3585}

References ast_channel_get_by_name(), ast_channel_unref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), c, name, NULL, pbx_builtin_setvar_helper(), and S_OR.

Referenced by __init_manager().

◆ action_status()

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

Manager "status" command to show channels.

Definition at line 3754 of file manager.c.

3755{
3756 const char *name = astman_get_header(m, "Channel");
3757 const char *chan_variables = astman_get_header(m, "Variables");
3758 const char *all_chan_variables = astman_get_header(m, "AllVariables");
3759 int all_variables = 0;
3760 const char *id = astman_get_header(m, "ActionID");
3761 char *variables = ast_strdupa(S_OR(chan_variables, ""));
3762 struct ast_channel *chan;
3763 int channels = 0;
3764 int all = ast_strlen_zero(name); /* set if we want all channels */
3765 char id_text[256];
3766 struct ast_channel_iterator *it_chans = NULL;
3768 AST_APP_ARG(name)[100];
3769 );
3770
3771 if (!ast_strlen_zero(all_chan_variables)) {
3772 all_variables = ast_true(all_chan_variables);
3773 }
3774
3776 astman_send_error(s, m, "Status Access Forbidden: Variables");
3777 return 0;
3778 }
3779
3780 if (all) {
3781 if (!(it_chans = ast_channel_iterator_all_new())) {
3782 astman_send_error(s, m, "Memory Allocation Failure");
3783 return 1;
3784 }
3785 chan = ast_channel_iterator_next(it_chans);
3786 } else {
3788 if (!chan) {
3789 astman_send_error(s, m, "No such channel");
3790 return 0;
3791 }
3792 }
3793
3794 astman_send_listack(s, m, "Channel status will follow", "start");
3795
3796 if (!ast_strlen_zero(id)) {
3797 snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", id);
3798 } else {
3799 id_text[0] = '\0';
3800 }
3801
3802 if (!ast_strlen_zero(chan_variables)) {
3803 AST_STANDARD_APP_ARGS(vars, variables);
3804 }
3805
3806 /* if we look by name, we break after the first iteration */
3807 for (; chan; all ? chan = ast_channel_iterator_next(it_chans) : 0) {
3808 ast_channel_lock(chan);
3809
3810 generate_status(s, chan, vars.name, vars.argc, all_variables, id_text, &channels);
3811
3812 ast_channel_unlock(chan);
3813 chan = ast_channel_unref(chan);
3814 }
3815
3816 if (it_chans) {
3818 }
3819
3820 astman_send_list_complete_start(s, m, "StatusComplete", channels);
3821 astman_append(s, "Items: %d\r\n", channels);
3823
3824 return 0;
3825}
struct ast_channel_iterator * ast_channel_iterator_destroy(struct ast_channel_iterator *i)
Destroy a channel iterator.
Definition channel.c:1349
struct ast_channel * ast_channel_iterator_next(struct ast_channel_iterator *i)
Get the next channel for a channel iterator.
Definition channel.c:1388
struct ast_channel_iterator * ast_channel_iterator_all_new(void)
Create a new channel iterator.
Definition channel.c:1380
static void generate_status(struct mansession *s, struct ast_channel *chan, char **vars, int varc, int all_variables, char *id_text, int *count)
Definition manager.c:3639
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.

References AST_APP_ARG, ast_channel_get_by_name(), ast_channel_iterator_all_new(), ast_channel_iterator_destroy(), ast_channel_iterator_next(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, AST_DECLARE_APP_ARGS, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_true(), astman_append(), astman_get_header(), astman_send_error(), astman_send_list_complete_end(), astman_send_list_complete_start(), astman_send_listack(), channels, function_capable_string_allowed_with_auths(), generate_status(), name, NULL, S_OR, mansession::session, and mansession_session::writeperm.

Referenced by __init_manager().

◆ action_timeout()

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

Definition at line 5539 of file manager.c.

5540{
5541 struct ast_channel *c;
5542 const char *name = astman_get_header(m, "Channel");
5543 double timeout = atof(astman_get_header(m, "Timeout"));
5544 struct timeval when = { timeout, 0 };
5545
5546 if (ast_strlen_zero(name)) {
5547 astman_send_error(s, m, "No channel specified");
5548 return 0;
5549 }
5550
5551 if (!timeout || timeout < 0) {
5552 astman_send_error(s, m, "No timeout specified");
5553 return 0;
5554 }
5555
5556 if (!(c = ast_channel_get_by_name(name))) {
5557 astman_send_error(s, m, "No such channel");
5558 return 0;
5559 }
5560
5561 when.tv_usec = (timeout - when.tv_sec) * 1000000.0;
5562
5567
5568 astman_send_ack(s, m, "Timeout Set");
5569
5570 return 0;
5571}
void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset)
Set when to hang a channel up.
Definition channel.c:511

References ast_channel_get_by_name(), ast_channel_lock, ast_channel_setwhentohangup_tv(), ast_channel_unlock, ast_channel_unref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), c, and name.

Referenced by __init_manager().

◆ action_updateconfig()

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

Definition at line 3008 of file manager.c.

3009{
3010 struct ast_config *cfg;
3011 const char *sfn = astman_get_header(m, "SrcFilename");
3012 const char *dfn = astman_get_header(m, "DstFilename");
3013 int res;
3014 const char *rld = astman_get_header(m, "Reload");
3015 int preserve_effective_context = CONFIG_SAVE_FLAG_PRESERVE_EFFECTIVE_CONTEXT;
3016 const char *preserve_effective_context_string = astman_get_header(m, "PreserveEffectiveContext");
3017 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
3018 enum error_type result;
3019
3020 if (ast_strlen_zero(sfn) || ast_strlen_zero(dfn)) {
3021 astman_send_error(s, m, "Filename not specified");
3022 return 0;
3023 }
3024 if (is_restricted_file(sfn) || is_restricted_file(dfn)) {
3025 astman_send_error(s, m, "File requires escalated privileges");
3026 return 0;
3027 }
3028 if (!(cfg = ast_config_load2(sfn, "manager", config_flags))) {
3029 astman_send_error(s, m, "Config file not found");
3030 return 0;
3031 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
3032 astman_send_error(s, m, "Config file has invalid format");
3033 return 0;
3034 }
3035 result = handle_updates(s, m, cfg, dfn);
3036 if (!result) {
3037 ast_include_rename(cfg, sfn, dfn); /* change the include references from dfn to sfn, so things match up */
3038 if (!ast_strlen_zero(preserve_effective_context_string) && !ast_true(preserve_effective_context_string)) {
3039 preserve_effective_context = CONFIG_SAVE_FLAG_NONE;
3040 }
3041 res = ast_config_text_file_save2(dfn, cfg, "Manager", preserve_effective_context);
3042 ast_config_destroy(cfg);
3043 if (res) {
3044 astman_send_error(s, m, "Save of config failed");
3045 return 0;
3046 }
3047 astman_send_ack(s, m, NULL);
3048 if (!ast_strlen_zero(rld)) {
3049 if (ast_true(rld)) {
3050 ast_module_reload(NULL); /* Reload everything */
3051 } else if (!ast_false(rld)) {
3052 ast_module_reload(rld); /* Reload the specific module */
3053 }
3054 }
3055 } else {
3056 ast_config_destroy(cfg);
3057 switch(result) {
3058 case UNKNOWN_ACTION:
3059 astman_send_error(s, m, "Unknown action command");
3060 break;
3061 case UNKNOWN_CATEGORY:
3062 astman_send_error(s, m, "Given category does not exist");
3063 break;
3065 astman_send_error(s, m, "Category not specified");
3066 break;
3068 astman_send_error(s, m, "Problem with category, value, or line (if required)");
3069 break;
3070 case FAILURE_ALLOCATION:
3071 astman_send_error(s, m, "Memory allocation failure, this should not happen");
3072 break;
3073 case FAILURE_NEWCAT:
3074 astman_send_error(s, m, "Create category did not complete successfully");
3075 break;
3076 case FAILURE_DELCAT:
3077 astman_send_error(s, m, "Delete category did not complete successfully");
3078 break;
3079 case FAILURE_EMPTYCAT:
3080 astman_send_error(s, m, "Empty category did not complete successfully");
3081 break;
3082 case FAILURE_UPDATE:
3083 astman_send_error(s, m, "Update did not complete successfully");
3084 break;
3085 case FAILURE_DELETE:
3086 astman_send_error(s, m, "Delete did not complete successfully");
3087 break;
3088 case FAILURE_APPEND:
3089 astman_send_error(s, m, "Append did not complete successfully");
3090 break;
3091 case FAILURE_TEMPLATE:
3092 astman_send_error(s, m, "Template category not found");
3093 break;
3094 }
3095 }
3096 return 0;
3097}
static enum error_type handle_updates(struct mansession *s, const struct message *m, struct ast_config *cfg, const char *dfn)
helper function for action_updateconfig
Definition manager.c:2725
error_type
Definition manager.c:108
void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file)
int ast_config_text_file_save2(const char *filename, const struct ast_config *cfg, const char *generator, uint32_t flags)
Save a config text file.
@ CONFIG_SAVE_FLAG_NONE
@ CONFIG_SAVE_FLAG_PRESERVE_EFFECTIVE_CONTEXT
int attribute_pure ast_false(const char *val)
Make sure something is false. Determine if a string containing a boolean value is "false"....
Definition utils.c:2250

References ast_config_destroy(), ast_config_load2(), ast_config_text_file_save2(), ast_false(), ast_include_rename(), ast_module_reload(), ast_strlen_zero(), ast_true(), astman_get_header(), astman_send_ack(), astman_send_error(), CONFIG_FLAG_NOCACHE, CONFIG_FLAG_WITHCOMMENTS, CONFIG_SAVE_FLAG_NONE, CONFIG_SAVE_FLAG_PRESERVE_EFFECTIVE_CONTEXT, CONFIG_STATUS_FILEINVALID, FAILURE_ALLOCATION, FAILURE_APPEND, FAILURE_DELCAT, FAILURE_DELETE, FAILURE_EMPTYCAT, FAILURE_NEWCAT, FAILURE_TEMPLATE, FAILURE_UPDATE, handle_updates(), is_restricted_file(), NULL, result, UNKNOWN_ACTION, UNKNOWN_CATEGORY, UNSPECIFIED_ARGUMENT, and UNSPECIFIED_CATEGORY.

Referenced by __init_manager().

◆ action_userevent()

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

Definition at line 6447 of file manager.c.

6448{
6449 const char *event = astman_get_header(m, "UserEvent");
6450 struct ast_str *body = ast_str_thread_get(&userevent_buf, 16);
6451 int x;
6452
6453 ast_str_reset(body);
6454
6455 for (x = 0; x < m->hdrcount; x++) {
6456 if (strncasecmp("UserEvent:", m->headers[x], strlen("UserEvent:")) &&
6457 strncasecmp("Action:", m->headers[x], strlen("Action:"))) {
6458 ast_str_append(&body, 0, "%s\r\n", m->headers[x]);
6459 }
6460 }
6461
6462 astman_send_ack(s, m, "Event Sent");
6463 manager_event(EVENT_FLAG_USER, "UserEvent", "UserEvent: %s\r\n%s", event, ast_str_buffer(body));
6464 return 0;
6465}
#define manager_event(category, event, contents,...)
External routines may send asterisk manager events this way.
Definition manager.h:255
#define EVENT_FLAG_USER
Definition manager.h:81
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition strings.h:693

References ast_str_append(), ast_str_buffer(), ast_str_reset(), ast_str_thread_get(), astman_get_header(), astman_send_ack(), EVENT_FLAG_USER, message::hdrcount, message::headers, and manager_event.

Referenced by __init_manager().

◆ action_waitevent()

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

Definition at line 3173 of file manager.c.

3174{
3175 const char *timeouts = astman_get_header(m, "Timeout");
3176 int timeout = -1;
3177 int x;
3178 int needexit = 0;
3179 const char *id = astman_get_header(m, "ActionID");
3180 char idText[256];
3181
3182 if (!ast_strlen_zero(id)) {
3183 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3184 } else {
3185 idText[0] = '\0';
3186 }
3187
3188 if (!ast_strlen_zero(timeouts)) {
3189 sscanf(timeouts, "%30i", &timeout);
3190 if (timeout < -1) {
3191 timeout = -1;
3192 }
3193 /* XXX maybe put an upper bound, or prevent the use of 0 ? */
3194 }
3195
3198 pthread_kill(s->session->waiting_thread, SIGURG);
3199 }
3201
3202 ao2_lock(s->session);
3203
3204 if (s->session->managerid) { /* AMI-over-HTTP session */
3205 /*
3206 * Make sure the timeout is within the expire time of the session,
3207 * as the client will likely abort the request if it does not see
3208 * data coming after some amount of time.
3209 */
3210 time_t now = time(NULL);
3211 int max = s->session->sessiontimeout - now - 10;
3212
3213 if (max < 0) { /* We are already late. Strange but possible. */
3214 max = 0;
3215 }
3216 if (timeout < 0 || timeout > max) {
3217 timeout = max;
3218 }
3219 if (!s->session->send_events) { /* make sure we record events */
3220 s->session->send_events = -1;
3221 }
3222 }
3223 ao2_unlock(s->session);
3224
3226 s->session->waiting_thread = pthread_self(); /* let new events wake up this thread */
3228 ast_debug(1, "Starting waiting for an event!\n");
3229
3230 for (x = 0; x < timeout || timeout < 0; x++) {
3231 ao2_lock(s->session);
3232 if (AST_RWLIST_NEXT(s->session->last_ev, eq_next)) {
3233 needexit = 1;
3234 }
3235 if (s->session->needdestroy) {
3236 needexit = 1;
3237 }
3238 ao2_unlock(s->session);
3239 /* We can have multiple HTTP session point to the same mansession entry.
3240 * The way we deal with it is not very nice: newcomers kick out the previous
3241 * HTTP session. XXX this needs to be improved.
3242 */
3244 if (s->session->waiting_thread != pthread_self()) {
3245 needexit = 1;
3246 }
3248 if (needexit) {
3249 break;
3250 }
3251 if (s->session->managerid == 0) { /* AMI session */
3253 break;
3254 }
3255 } else { /* HTTP session */
3256 sleep(1);
3257 }
3258 }
3259 ast_debug(1, "Finished waiting for an event!\n");
3260
3262 if (s->session->waiting_thread == pthread_self()) {
3263 struct eventqent *eqe = s->session->last_ev;
3264
3267
3268 ao2_lock(s->session);
3269 astman_send_response(s, m, "Success", "Waiting for Event completed.");
3270 while ((eqe = advance_event(eqe))) {
3271 if (((s->session->readperm & eqe->category) == eqe->category)
3272 && ((s->session->send_events & eqe->category) == eqe->category)
3274 astman_append(s, "%s", eqe->eventdata);
3275 }
3276 s->session->last_ev = eqe;
3277 }
3278 astman_append(s,
3279 "Event: WaitEventComplete\r\n"
3280 "%s"
3281 "\r\n", idText);
3282 ao2_unlock(s->session);
3283 } else {
3285 ast_debug(1, "Abandoning event request!\n");
3286 }
3287
3288 return 0;
3289}
#define ao2_unlock(a)
Definition astobj2.h:729
#define ao2_lock(a)
Definition astobj2.h:717
#define max(a, b)
Definition f2c.h:198
static struct eventqent * advance_event(struct eventqent *e)
Definition manager.c:1582
static int should_send_event(struct ao2_container *includefilters, struct ao2_container *excludefilters, struct eventqent *eqe)
Definition manager.c:5654
int ast_iostream_get_fd(struct ast_iostream *stream)
Get an iostream's file descriptor.
Definition iostream.c:85
#define AST_RWLIST_NEXT
int category
Definition manager.c:151
char eventdata[1]
Definition manager.c:156
ast_mutex_t notify_lock
Definition manager.c:308
pthread_t waiting_thread
Definition manager.c:284
struct ast_iostream * stream
Definition manager.c:281
struct eventqent * last_ev
Definition manager.c:300
time_t sessiontimeout
Definition manager.c:288
int ast_wait_for_input(int fd, int ms)
Definition utils.c:1732

References advance_event(), ao2_lock, ao2_unlock, ast_debug, ast_iostream_get_fd(), ast_mutex_lock, ast_mutex_unlock, AST_PTHREADT_NULL, AST_RWLIST_NEXT, ast_strlen_zero(), ast_wait_for_input(), astman_append(), astman_get_header(), astman_send_response(), eventqent::category, eventqent::eventdata, mansession_session::excludefilters, mansession_session::includefilters, mansession_session::last_ev, mansession_session::managerid, max, mansession_session::needdestroy, mansession_session::notify_lock, NULL, mansession_session::readperm, mansession_session::send_events, mansession::session, mansession_session::sessiontimeout, should_send_event(), mansession_session::stream, and mansession_session::waiting_thread.

Referenced by __init_manager().

◆ advance_event()

static struct eventqent * advance_event ( struct eventqent e)
static

Definition at line 1582 of file manager.c.

1583{
1584 struct eventqent *next;
1585
1587 if ((next = AST_RWLIST_NEXT(e, eq_next))) {
1590 }
1592 return next;
1593}
struct eventqent::@397 eq_next
int usecount
Definition manager.c:150
struct eventqent * next
Definition manager.c:155

References ast_atomic_fetchadd_int(), AST_RWLIST_NEXT, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, eventqent::eq_next, eventqent::next, and eventqent::usecount.

Referenced by action_waitevent(), and process_events().

◆ AO2_GLOBAL_OBJ_STATIC() [1/2]

static AO2_GLOBAL_OBJ_STATIC ( event_docs  )
static

A container of event documentation nodes.

◆ AO2_GLOBAL_OBJ_STATIC() [2/2]

static AO2_GLOBAL_OBJ_STATIC ( mgr_sessions  )
static

Active manager connection sessions container.

◆ aocmessage_get_unit_entry()

static int aocmessage_get_unit_entry ( const struct message m,
struct ast_aoc_unit_entry entry,
unsigned int  entry_num 
)
static

Definition at line 4477 of file manager.c.

4478{
4479 const char *unitamount;
4480 const char *unittype;
4481 struct ast_str *str = ast_str_alloca(32);
4482
4483 memset(entry, 0, sizeof(*entry));
4484
4485 ast_str_set(&str, 0, "UnitAmount(%u)", entry_num);
4486 unitamount = astman_get_header(m, ast_str_buffer(str));
4487
4488 ast_str_set(&str, 0, "UnitType(%u)", entry_num);
4489 unittype = astman_get_header(m, ast_str_buffer(str));
4490
4491 if (!ast_strlen_zero(unitamount) && (sscanf(unitamount, "%30u", &entry->amount) == 1)) {
4492 entry->valid_amount = 1;
4493 }
4494
4495 if (!ast_strlen_zero(unittype) && sscanf(unittype, "%30u", &entry->type) == 1) {
4496 entry->valid_type = 1;
4497 }
4498
4499 return 0;
4500}
const char * str
Definition app_jack.c:150
unsigned int amount
Definition aoc.h:180
unsigned int type
Definition aoc.h:182
char valid_type
Definition aoc.h:181
char valid_amount
Definition aoc.h:179

References ast_aoc_unit_entry::amount, ast_str_alloca, ast_str_buffer(), ast_str_set(), ast_strlen_zero(), astman_get_header(), str, ast_aoc_unit_entry::type, ast_aoc_unit_entry::valid_amount, and ast_aoc_unit_entry::valid_type.

Referenced by action_aoc_de_message().

◆ app_match()

static int app_match ( const char *  app,
const char *  data,
const char *  search 
)
static

Definition at line 5015 of file manager.c.

5016{
5017 /*
5018 * We use strcasestr so we don't have to trim any blanks
5019 * from the front or back of the string.
5020 */
5021 return !!(strcasestr(app, search));
5022}
char * strcasestr(const char *, const char *)

References app, and strcasestr().

◆ appdata_match()

static int appdata_match ( const char *  app,
const char *  data,
const char *  search 
)
static

Definition at line 5034 of file manager.c.

5035{
5036 if (ast_strlen_zero(data)) {
5037 return 0;
5038 }
5039 return !!(strstr(data, search));
5040}

References ast_strlen_zero().

◆ append_channel_vars()

static void append_channel_vars ( struct ast_str **  pbuf,
struct ast_channel chan 
)
static

Definition at line 7527 of file manager.c.

7528{
7529 struct varshead *vars;
7530 struct ast_var_t *var;
7531
7532 vars = ast_channel_get_manager_vars(chan);
7533 if (!vars) {
7534 return;
7535 }
7536
7537 AST_LIST_TRAVERSE(vars, var, entries) {
7538 ast_str_append(pbuf, 0, "ChanVariable(%s): %s=%s\r\n", ast_channel_name(chan), var->name, var->value);
7539 }
7540 ao2_ref(vars, -1);
7541}
struct varshead * ast_channel_get_manager_vars(struct ast_channel *chan)
Gets the variables for a given channel, as specified by ast_channel_set_manager_vars().
Definition channel.c:8008
const char * ast_channel_name(const struct ast_channel *chan)
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
struct ast_var_t::@220 entries

References ao2_ref, ast_channel_get_manager_vars(), ast_channel_name(), AST_LIST_TRAVERSE, ast_str_append(), and var.

Referenced by __manager_event_sessions_va().

◆ append_event()

static int append_event ( const char *  str,
int  event_name_hash,
int  category 
)
static

events are appended to a queue from where they can be dispatched to clients.

Definition at line 7502 of file manager.c.

7503{
7504 struct eventqent *tmp = ast_malloc(sizeof(*tmp) + strlen(str));
7505 static int seq; /* sequence number */
7506
7507 if (!tmp) {
7508 return -1;
7509 }
7510
7511 /* need to init all fields, because ast_malloc() does not */
7512 tmp->usecount = 0;
7513 tmp->category = category;
7514 tmp->seq = ast_atomic_fetchadd_int(&seq, 1);
7515 tmp->tv = ast_tvnow();
7518 strcpy(tmp->eventdata, str);
7519
7523
7524 return 0;
7525}
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
#define AST_RWLIST_INSERT_TAIL
unsigned int seq
Definition manager.c:152
struct timeval tv
Definition manager.c:153
int event_name_hash
Definition manager.c:154

References ast_atomic_fetchadd_int(), ast_malloc, AST_RWLIST_INSERT_TAIL, AST_RWLIST_NEXT, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_tvnow(), eventqent::category, eventqent::event_name_hash, eventqent::eventdata, NULL, seq, eventqent::seq, str, eventqent::tv, and eventqent::usecount.

Referenced by __init_manager(), and __manager_event_sessions_va().

◆ ast_hook_send_action()

int ast_hook_send_action ( struct manager_custom_hook hook,
const char *  msg 
)

access for hooks to send action messages to ami

Registered hooks can call this function to invoke actions and they will receive responses through registered callback.

Definition at line 1766 of file manager.c.

1767{
1768 const char *action;
1769 int ret = 0;
1770 struct manager_action *act_found;
1771 struct mansession s = {.session = NULL, };
1772 struct message m = { 0 };
1773 char *dup_str;
1774 char *src;
1775 int x = 0;
1776 int curlen;
1777
1778 if (hook == NULL) {
1779 return -1;
1780 }
1781
1782 /* Create our own copy of the AMI action msg string. */
1783 src = dup_str = ast_strdup(msg);
1784 if (!dup_str) {
1785 return -1;
1786 }
1787
1788 /* convert msg string to message struct */
1789 curlen = strlen(src);
1790 for (x = 0; x < curlen; x++) {
1791 int cr; /* set if we have \r */
1792 if (src[x] == '\r' && x+1 < curlen && src[x+1] == '\n')
1793 cr = 2; /* Found. Update length to include \r\n */
1794 else if (src[x] == '\n')
1795 cr = 1; /* also accept \n only */
1796 else
1797 continue;
1798 /* don't keep empty lines */
1799 if (x && m.hdrcount < ARRAY_LEN(m.headers)) {
1800 /* ... but trim \r\n and terminate the header string */
1801 src[x] = '\0';
1802 m.headers[m.hdrcount++] = src;
1803 }
1804 x += cr;
1805 curlen -= x; /* remaining size */
1806 src += x; /* update pointer */
1807 x = -1; /* reset loop */
1808 }
1809
1810 action = astman_get_header(&m, "Action");
1811
1812 do {
1813 if (!strcasecmp(action, "login")) {
1814 break;
1815 }
1816
1817 act_found = action_find(action);
1818 if (!act_found) {
1819 break;
1820 }
1821
1822 /*
1823 * we have to simulate a session for this action request
1824 * to be able to pass it down for processing
1825 * This is necessary to meet the previous design of manager.c
1826 */
1827 s.hook = hook;
1828
1829 ret = -1;
1830 ao2_lock(act_found);
1831 if (act_found->registered && act_found->func) {
1832 struct ast_module *mod_ref = ast_module_running_ref(act_found->module);
1833
1834 ao2_unlock(act_found);
1835 /* If the action is in a module it must be running. */
1836 if (!act_found->module || mod_ref) {
1837 ret = act_found->func(&s, &m);
1838 ast_module_unref(mod_ref);
1839 }
1840 } else {
1841 ao2_unlock(act_found);
1842 }
1843 ao2_t_ref(act_found, -1, "done with found action object");
1844 } while (0);
1845
1846 ast_free(dup_str);
1847 return ret;
1848}
static struct manager_action * action_find(const char *name)
Definition manager.c:434
#define ast_module_unref(mod)
Release a reference to the module.
Definition module.h:483
#define ast_module_running_ref(mod)
Hold a reference to the module if it is running.
Definition module.h:469
int(* func)(struct mansession *s, const struct message *m)
Definition manager.h:171
unsigned int registered
TRUE if the AMI action is registered and the callback can be called.
Definition manager.h:183
In case you didn't read that giant block of text above the mansession_session struct,...
Definition manager.c:323
struct manager_custom_hook * hook
Definition manager.c:329

References action_find(), ao2_lock, ao2_t_ref, ao2_unlock, ARRAY_LEN, ast_free, ast_module_running_ref, ast_module_unref, ast_strdup, astman_get_header(), manager_action::func, message::hdrcount, message::headers, mansession::hook, NULL, manager_action::registered, and mansession::session.

Referenced by hook_send().

◆ ast_instring()

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

844{
845 const char *val = bigstr, *next;
846
847 do {
848 if ((next = strchr(val, delim))) {
849 if (!strncmp(val, smallstr, (next - val))) {
850 return 1;
851 } else {
852 continue;
853 }
854 } else {
855 return !strcmp(smallstr, val);
856 }
857 } while (*(val = (next + 1)));
858
859 return 0;
860}

Referenced by get_perm().

◆ ast_manager_check_enabled()

int ast_manager_check_enabled ( void  )

Check if AMI is enabled.

Definition at line 680 of file manager.c.

681{
682 return manager_enabled;
683}
static int manager_enabled
Definition manager.c:166

References manager_enabled.

Referenced by handle_show_settings().

◆ ast_manager_get_message_router()

struct stasis_message_router * ast_manager_get_message_router ( void  )

Get the stasis_message_router for AMI.

Since
12
Returns
The stasis_message_router for AMI
Return values
NULLon error

Definition at line 455 of file manager.c.

456{
457 return stasis_router;
458}
static struct stasis_message_router * stasis_router
The stasis_message_router for all Stasis Message Bus API messages.
Definition manager.c:185

References stasis_router.

Referenced by manager_bridging_init(), manager_channels_init(), manager_mwi_init(), and manager_system_init().

◆ ast_manager_get_topic()

struct stasis_topic * ast_manager_get_topic ( void  )

Get the Stasis Message Bus API topic for AMI.

Since
12
Returns
The Stasis Message Bus API topic for AMI
Return values
NULLon error

Definition at line 450 of file manager.c.

451{
452 return manager_topic;
453}
static struct stasis_topic * manager_topic
A stasis_topic that all topics AMI cares about will be forwarded to.
Definition manager.c:182

References manager_topic.

Referenced by aoc_publish_blob(), ast_manager_publish_event(), endpoint_state_cb(), load_module(), load_module(), load_module(), load_module(), load_module(), manager_bridging_init(), manager_channels_init(), manager_mwi_init(), manager_system_init(), publish_load_message_type(), queue_publish_member_blob(), and stasis_app_user_event().

◆ ast_manager_hangup_helper()

int ast_manager_hangup_helper ( struct mansession s,
const struct message m,
manager_hangup_handler_t  handler,
manager_hangup_cause_validator_t  cause_validator 
)

A manager helper function that hangs up a channel using a supplied channel type specific hangup function and cause code validator.

This function handles the lookup of channel(s) and the AMI interaction but uses the supplied callbacks to actually perform the hangup. It can be used to implement a custom AMI 'Hangup' action without having to duplicate all the code in the standard Hangup action.

Parameters
sSession
mMessage
handlerFunction that actually performs the hangup
cause_validatorFunction that validates the cause code
Return values
0on success.
non-zeroon error.

Definition at line 3427 of file manager.c.

3430{
3431 struct ast_channel *c = NULL;
3432 int causecode = 0; /* all values <= 0 mean 'do not set hangupcause in channel' */
3433 const char *id = astman_get_header(m, "ActionID");
3434 const char *name_or_regex = astman_get_header(m, "Channel");
3435 const char *cause = astman_get_header(m, "Cause");
3436 char idText[256];
3437 regex_t regexbuf;
3438 struct ast_channel_iterator *iter = NULL;
3439 struct ast_str *regex_string;
3440 int channels_matched = 0;
3441
3442 if (ast_strlen_zero(name_or_regex)) {
3443 astman_send_error(s, m, "No channel specified");
3444 return 0;
3445 }
3446
3447 if (!ast_strlen_zero(id)) {
3448 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3449 } else {
3450 idText[0] = '\0';
3451 }
3452
3453 if (cause_validator) {
3454 causecode = cause_validator(name_or_regex, cause);
3455 } else if (!ast_strlen_zero(cause)) {
3456 char *endptr;
3457 causecode = strtol(cause, &endptr, 10);
3458 if (causecode < 0 || causecode > 127 || *endptr != '\0') {
3459 ast_log(LOG_NOTICE, "Invalid 'Cause: %s' in manager action Hangup\n", cause);
3460 /* keep going, better to hangup without cause than to not hang up at all */
3461 causecode = 0; /* do not set channel's hangupcause */
3462 }
3463 }
3464
3465 /************************************************/
3466 /* Regular explicit match channel byname hangup */
3467
3468 if (name_or_regex[0] != '/') {
3469 if (!(c = ast_channel_get_by_name(name_or_regex))) {
3470 ast_log(LOG_NOTICE, "Request to hangup non-existent channel: %s\n",
3471 name_or_regex);
3472 astman_send_error(s, m, "No such channel");
3473 return 0;
3474 }
3475
3476 ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3477 (s->session->managerid ? "HTTP " : ""),
3478 s->session->username,
3481
3482 hangup_handler(c, causecode);
3484
3485 astman_send_ack(s, m, "Channel Hungup");
3486
3487 return 0;
3488 }
3489
3490 /***********************************************/
3491 /* find and hangup any channels matching regex */
3492
3493 regex_string = ast_str_create(strlen(name_or_regex));
3494 if (!regex_string) {
3495 astman_send_error(s, m, "Memory Allocation Failure");
3496 return 0;
3497 }
3498
3499 /* Make "/regex/" into "regex" */
3500 if (ast_regex_string_to_regex_pattern(name_or_regex, &regex_string) != 0) {
3501 astman_send_error(s, m, "Regex format invalid, Channel param should be /regex/");
3502 ast_free(regex_string);
3503 return 0;
3504 }
3505
3506 /* if regex compilation fails, hangup fails */
3507 if (regcomp(&regexbuf, ast_str_buffer(regex_string), REG_EXTENDED | REG_NOSUB)) {
3508 astman_send_error_va(s, m, "Regex compile failed on: %s", name_or_regex);
3509 ast_free(regex_string);
3510 return 0;
3511 }
3512
3513 astman_send_listack(s, m, "Channels hung up will follow", "start");
3514
3516 if (iter) {
3517 for (; (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
3518 if (regexec(&regexbuf, ast_channel_name(c), 0, NULL, 0)) {
3519 continue;
3520 }
3521
3522 ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3523 (s->session->managerid ? "HTTP " : ""),
3524 s->session->username,
3527
3528 hangup_handler(c, causecode);
3529 channels_matched++;
3530
3531 astman_append(s,
3532 "Event: ChannelHungup\r\n"
3533 "Channel: %s\r\n"
3534 "%s"
3535 "\r\n", ast_channel_name(c), idText);
3536 }
3538 }
3539
3540 regfree(&regexbuf);
3541 ast_free(regex_string);
3542
3543 astman_send_list_complete(s, m, "ChannelsHungupListComplete", channels_matched);
3544
3545 return 0;
3546}
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition strings.h:659
int ast_regex_string_to_regex_pattern(const char *regex_string, struct ast_str **regex_pattern)
Given a string regex_string in the form of "/regex/", convert it into the form of "regex".
Definition utils.c:2213

References mansession_session::addr, ast_channel_get_by_name(), ast_channel_iterator_all_new(), ast_channel_iterator_destroy(), ast_channel_iterator_next(), ast_channel_name(), ast_channel_unref, ast_free, ast_log, ast_regex_string_to_regex_pattern(), ast_sockaddr_stringify_addr(), ast_str_buffer(), ast_str_create, ast_strlen_zero(), ast_verb, astman_append(), astman_get_header(), astman_send_ack(), astman_send_error(), astman_send_error_va(), astman_send_list_complete(), astman_send_listack(), c, LOG_NOTICE, mansession_session::managerid, NULL, mansession::session, and mansession_session::username.

Referenced by action_hangup(), and pjsip_action_hangup().

◆ ast_manager_publish_event()

void ast_manager_publish_event ( const char *  type,
int  class_type,
struct ast_json obj 
)

Publish an event to AMI.

Since
12
Parameters
typeThe type of AMI event to publish
class_typeThe class on which to publish the event
objThe event data to be published.

Publishes a message to the Stasis Message Bus API message bus solely for the consumption of AMI. The message will be of the type provided by ast_manager_get_generic_type, and will be published to the topic provided by ast_manager_get_topic. As such, the JSON must be constructed as defined by the ast_manager_get_generic_type message.

Definition at line 634 of file manager.c.

635{
636 RAII_VAR(struct ast_json *, event_info, NULL, ast_json_unref);
637 RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
639
640 if (!obj || !ast_manager_get_generic_type()) {
641 return;
642 }
643
644 ast_json_ref(obj);
645 event_info = ast_json_pack("{s: s, s: i, s: o}",
646 "type", type,
647 "class_type", class_type,
648 "event", obj);
649 if (!event_info) {
650 return;
651 }
652
653 payload = ast_json_payload_create(event_info);
654 if (!payload) {
655 return;
656 }
658 if (!message) {
659 return;
660 }
662}
static const char type[]
struct stasis_topic * ast_manager_get_topic(void)
Get the Stasis Message Bus API topic for AMI.
Definition manager.c:450
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition json.c:73
struct ast_json_payload * ast_json_payload_create(struct ast_json *json)
Create an ao2 object to pass json blobs as data payloads for stasis.
Definition json.c:756
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition json.c:612
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition json.c:67
struct stasis_message_type * ast_manager_get_generic_type(void)
Get the stasis_message_type for generic messages.
struct stasis_message * stasis_message_create(struct stasis_message_type *type, void *data)
Create a new message.
void stasis_publish(struct stasis_topic *topic, struct stasis_message *message)
Publish a message to a topic's subscribers.
Definition stasis.c:1578
Abstract JSON element (object, array, string, int, ...).

References ao2_cleanup, ast_json_pack(), ast_json_payload_create(), ast_json_ref(), ast_json_unref(), ast_manager_get_generic_type(), ast_manager_get_topic(), NULL, RAII_VAR, stasis_message_create(), stasis_publish(), and type.

Referenced by analog_publish_channel_alarm_clear(), analog_publish_dnd_state(), publish_channel_alarm(), publish_channel_alarm_clear(), publish_dnd_state(), publish_fully_booted(), publish_span_alarm(), publish_span_alarm_clear(), really_quit(), and reset_user_pw().

◆ ast_manager_register2()

int ast_manager_register2 ( const char *  action,
int  auth,
int(*)(struct mansession *s, const struct message *m)  func,
struct ast_module module,
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

Register a manager command with the manager interface.

Definition at line 7830 of file manager.c.

7831{
7832 struct manager_action *cur;
7833
7834 cur = ao2_t_alloc(sizeof(*cur), action_destroy, action);
7835 if (!cur) {
7836 return -1;
7837 }
7838 if (ast_string_field_init(cur, 128)) {
7839 ao2_t_ref(cur, -1, "action object creation failed");
7840 return -1;
7841 }
7842
7843 if (ast_string_field_init_extended(cur, since)) {
7844 ao2_t_ref(cur, -1, "action object creation failed");
7845 return -1;
7846 }
7847
7848 if (ast_string_field_init_extended(cur, provided_by)) {
7849 ao2_t_ref(cur, -1, "action object creation failed");
7850 return -1;
7851 }
7852
7853 cur->action = action;
7854 cur->authority = auth;
7855 cur->func = func;
7856 cur->module = module;
7857#ifdef AST_XML_DOCS
7859 char *tmpxml;
7860
7861 tmpxml = ast_xmldoc_build_since("manager", action, NULL);
7862 ast_string_field_set(cur, since, tmpxml);
7863 ast_free(tmpxml);
7864
7865 tmpxml = ast_xmldoc_build_synopsis("manager", action, NULL);
7866 ast_string_field_set(cur, synopsis, tmpxml);
7867 ast_free(tmpxml);
7868
7869 tmpxml = ast_xmldoc_build_provided_by("manager", action, NULL);
7870 ast_string_field_set(cur, provided_by, tmpxml);
7871 ast_free(tmpxml);
7872
7873 tmpxml = ast_xmldoc_build_syntax("manager", action, NULL);
7874 ast_string_field_set(cur, syntax, tmpxml);
7875 ast_free(tmpxml);
7876
7877 tmpxml = ast_xmldoc_build_description("manager", action, NULL);
7878 ast_string_field_set(cur, description, tmpxml);
7879 ast_free(tmpxml);
7880
7881 tmpxml = ast_xmldoc_build_seealso("manager", action, NULL);
7882 ast_string_field_set(cur, seealso, tmpxml);
7883 ast_free(tmpxml);
7884
7885 tmpxml = ast_xmldoc_build_arguments("manager", action, NULL);
7886 ast_string_field_set(cur, arguments, tmpxml);
7887 ast_free(tmpxml);
7888
7891
7892 cur->docsrc = AST_XML_DOC;
7893 } else
7894#endif
7895 {
7898#ifdef AST_XML_DOCS
7899 cur->docsrc = AST_STATIC_DOC;
7900#endif
7901 }
7902 if (ast_manager_register_struct(cur)) {
7903 ao2_t_ref(cur, -1, "action object registration failed");
7904 return -1;
7905 }
7906
7907 ao2_t_ref(cur, -1, "action object registration successful");
7908 return 0;
7909}
#define ao2_t_alloc(data_size, destructor_fn, debug_msg)
Definition astobj2.h:407
static char * synopsis
Definition func_enum.c:166
static int ast_manager_register_struct(struct manager_action *act)
Definition manager.c:7775
static void action_destroy(void *obj)
Definition manager.c:7816
#define ast_string_field_init_extended(x, field)
Initialize an extended string field.
struct ast_module *enum ast_doc_src docsrc
Definition manager.h:174
const ast_string_field description
Definition manager.h:163
const ast_string_field seealso
Definition manager.h:163
const ast_string_field syntax
Definition manager.h:163
const ast_string_field arguments
Definition manager.h:163
struct ast_xml_doc_item * ast_xmldoc_build_list_responses(const char *type, const char *name, const char *module)
Generate the [list responses] tag based on type of node ('application', 'function' or 'agi') and name...
Definition xmldoc.c:2648
char * ast_xmldoc_build_description(const char *type, const char *name, const char *module)
Generate description documentation from XML.
Definition xmldoc.c:2418
char * ast_xmldoc_build_syntax(const char *type, const char *name, const char *module)
Get the syntax for a specified application or function.
Definition xmldoc.c:1252
char * ast_xmldoc_build_arguments(const char *type, const char *name, const char *module)
Generate the [arguments] tag based on type of node ('application', 'function' or 'agi') and name.
Definition xmldoc.c:2231
char * ast_xmldoc_build_synopsis(const char *type, const char *name, const char *module)
Generate synopsis documentation from XML.
Definition xmldoc.c:2395
char * ast_xmldoc_build_since(const char *type, const char *name, const char *module)
Parse the <since> node content.
Definition xmldoc.c:1792
@ AST_XML_DOC
Definition xmldoc.h:31
@ AST_STATIC_DOC
Definition xmldoc.h:32
char * ast_xmldoc_build_seealso(const char *type, const char *name, const char *module)
Parse the <see-also> node content.
Definition xmldoc.c:1707
char * ast_xmldoc_build_provided_by(const char *type, const char *name, const char *module)
Generate provided-by documentation from XML.
Definition xmldoc.c:1844
struct ast_xml_doc_item * ast_xmldoc_build_final_response(const char *type, const char *name, const char *module)
Generate the [final response] tag based on type of node ('application', 'function' or 'agi') and name...
Definition xmldoc.c:2718

References manager_action::action, action_destroy(), ao2_t_alloc, ao2_t_ref, ast_free, ast_manager_register_struct(), AST_STATIC_DOC, ast_string_field_init, ast_string_field_init_extended, ast_string_field_set, ast_strlen_zero(), AST_XML_DOC, ast_xmldoc_build_arguments(), ast_xmldoc_build_description(), ast_xmldoc_build_final_response(), ast_xmldoc_build_list_responses(), ast_xmldoc_build_provided_by(), ast_xmldoc_build_seealso(), ast_xmldoc_build_since(), ast_xmldoc_build_synopsis(), ast_xmldoc_build_syntax(), manager_action::authority, manager_action::docsrc, manager_action::final_response, manager_action::func, manager_action::list_responses, NULL, and synopsis.

◆ ast_manager_register_hook()

void ast_manager_register_hook ( struct manager_custom_hook hook)

Add a custom hook to be called when an event is fired.

Add a custom hook to be called when an event is fired

Parameters
hookstruct manager_custom_hook object to add

Definition at line 665 of file manager.c.

References AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by create_test_dialplan(), and register_hook().

◆ ast_manager_register_struct()

static int ast_manager_register_struct ( struct manager_action act)
static

Definition at line 7775 of file manager.c.

7776{
7777 struct manager_action *cur, *prev = NULL;
7778
7781 int ret;
7782
7783 ret = strcasecmp(cur->action, act->action);
7784 if (ret == 0) {
7785 ast_log(LOG_WARNING, "Manager: Action '%s' already registered\n", act->action);
7787 return -1;
7788 }
7789 if (ret > 0) { /* Insert these alphabetically */
7790 break;
7791 }
7792 prev = cur;
7793 }
7794
7795 ao2_t_ref(act, +1, "action object added to list");
7796 act->registered = 1;
7797 if (prev) {
7798 AST_RWLIST_INSERT_AFTER(&actions, prev, act, list);
7799 } else {
7801 }
7802
7803 ast_verb(5, "Manager registered action %s\n", act->action);
7804
7806
7807 return 0;
7808}
#define LOG_WARNING
#define AST_RWLIST_INSERT_AFTER
#define AST_RWLIST_INSERT_HEAD

References manager_action::action, ao2_t_ref, ast_log, AST_RWLIST_INSERT_AFTER, AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, LOG_WARNING, NULL, ast_category::prev, and manager_action::registered.

Referenced by ast_manager_register2().

◆ ast_manager_str_from_json_object()

struct ast_str * ast_manager_str_from_json_object ( struct ast_json blob,
key_exclusion_cb  exclusion_cb 
)

Convert a JSON object into an AMI compatible string.

Since
12
Parameters
blobThe JSON blob containing key/value pairs to convert
exclusion_cbA key_exclusion_cb pointer to a function that will exclude keys from the final AMI string
Returns
A malloc'd ast_str object. Callers of this function should free the returned ast_str object
Return values
NULLon error

Definition at line 551 of file manager.c.

552{
553 struct ast_str *res = ast_str_create(1024);
554
555 if (!ast_json_is_null(blob)) {
556 manager_json_to_ast_str(blob, NULL, &res, exclusion_cb);
557 }
558
559 return res;
560}
static void manager_json_to_ast_str(struct ast_json *obj, const char *key, struct ast_str **res, key_exclusion_cb exclusion_cb)
Definition manager.c:510
int ast_json_is_null(const struct ast_json *value)
Check if value is JSON null.
Definition json.c:273

References ast_json_is_null(), ast_str_create, manager_json_to_ast_str(), and NULL.

Referenced by agi_channel_to_ami(), aoc_to_ami(), manager_generic_msg_cb(), multi_user_event_to_ami(), mwi_app_event_cb(), queue_channel_to_ami(), queue_member_to_ami(), and queue_multi_channel_to_ami().

◆ ast_manager_unregister()

int ast_manager_unregister ( const char *  action)

support functions to register/unregister AMI action handlers,

Unregister a registered manager command.

Definition at line 7704 of file manager.c.

7705{
7706 struct manager_action *cur;
7707
7710 if (!strcasecmp(action, cur->action)) {
7712 break;
7713 }
7714 }
7717
7718 if (cur) {
7719 /*
7720 * We have removed the action object from the container so we
7721 * are no longer in a hurry.
7722 */
7723 ao2_lock(cur);
7724 cur->registered = 0;
7725 ao2_unlock(cur);
7726
7727 ao2_t_ref(cur, -1, "action object removed from list");
7728 ast_verb(5, "Manager unregistered action %s\n", action);
7729 }
7730
7731 return 0;
7732}
#define AST_RWLIST_REMOVE_CURRENT
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
#define AST_RWLIST_TRAVERSE_SAFE_END

References manager_action::action, ao2_lock, ao2_t_ref, ao2_unlock, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, and manager_action::registered.

Referenced by __unload_module(), __unload_module(), ast_res_pjsip_cleanup_options_handling(), ast_res_pjsip_destroy_configuration(), ast_sip_destroy_sorcery_auth(), ast_sip_destroy_sorcery_location(), astdb_atexit(), bridge_cleanup(), load_module(), load_module(), local_shutdown(), manager_bridging_cleanup(), manager_shutdown(), message_shutdown(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_parking_manager(), and unload_pbx().

◆ ast_manager_unregister_hook()

void ast_manager_unregister_hook ( struct manager_custom_hook hook)

Delete a custom hook to be called when an event is fired.

Delete a custom hook to be called when an event is fired

Parameters
hookstruct manager_custom_hook object to delete

Definition at line 673 of file manager.c.

674{
676 AST_RWLIST_REMOVE(&manager_hooks, hook, list);
678}
#define AST_RWLIST_REMOVE

References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by register_hook(), unload_module(), unload_module(), and unregister_hook().

◆ AST_THREADSTORAGE_CUSTOM_SCOPE() [1/3]

AST_THREADSTORAGE_CUSTOM_SCOPE ( astman_append_buf  ,
NULL  ,
ast_free_ptr  ,
static   
)

thread local buffer for astman_append

Note
This can not be defined within the astman_append() function because it declares a couple of functions that get used to initialize the thread local storage key.

◆ AST_THREADSTORAGE_CUSTOM_SCOPE() [2/3]

AST_THREADSTORAGE_CUSTOM_SCOPE ( manager_event_buf  ,
NULL  ,
ast_free_ptr  ,
static   
)

◆ AST_THREADSTORAGE_CUSTOM_SCOPE() [3/3]

AST_THREADSTORAGE_CUSTOM_SCOPE ( userevent_buf  ,
NULL  ,
ast_free_ptr  ,
static   
)

◆ ast_webmanager_check_enabled()

int ast_webmanager_check_enabled ( void  )

Check if AMI/HTTP is enabled.

Definition at line 685 of file manager.c.

686{
688}
static int webmanager_enabled
Definition manager.c:168

References manager_enabled, and webmanager_enabled.

Referenced by action_coresettings(), and handle_show_settings().

◆ astman_append()

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

utility functions for creating AMI replies

Definition at line 1909 of file manager.c.

1910{
1911 int res;
1912 va_list ap;
1913 struct ast_str *buf;
1914
1915 if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
1916 return;
1917 }
1918
1919 va_start(ap, fmt);
1920 res = ast_str_set_va(&buf, 0, fmt, ap);
1921 va_end(ap);
1922 if (res == AST_DYNSTR_BUILD_FAILED) {
1923 return;
1924 }
1925
1926 if (s->hook || (s->tcptls_session != NULL && s->tcptls_session->stream != NULL)) {
1928 } else {
1929 ast_verbose("No connection stream in astman_append, should not happen\n");
1930 }
1931}
#define ASTMAN_APPEND_BUF_INITSIZE
initial allocated size for the astman_append_buf and astman_send_*_va
Definition manager.c:1895
static int send_string(struct mansession *s, char *string)
Definition manager.c:1854
#define ast_verbose(...)
int ast_str_set_va(struct ast_str **buf, ssize_t max_len, const char *fmt, va_list ap)
Set a dynamic string from a va_list.
Definition strings.h:1030
@ AST_DYNSTR_BUILD_FAILED
Definition strings.h:943
struct ast_iostream * stream
Definition tcptls.h:162
struct ast_tcptls_session_instance * tcptls_session
Definition manager.c:326

References AST_DYNSTR_BUILD_FAILED, ast_str_buffer(), ast_str_set_va(), ast_str_thread_get(), ast_verbose, ASTMAN_APPEND_BUF_INITSIZE, buf, mansession::hook, NULL, send_string(), ast_iostream::start, ast_tcptls_session_instance::stream, and mansession::tcptls_session.

Referenced by _iax2_show_peers_one(), action_agents(), action_challenge(), action_command(), action_confbridgelist_item(), action_confbridgelistrooms(), action_coresettings(), action_coreshowchannelmap(), action_coreshowchannels(), action_corestatus(), action_dahdishowchannels(), action_dahdishowstatus(), action_devicestatelist(), action_events(), action_extensionstate(), action_extensionstatelist(), action_getconfig(), action_getconfigjson(), action_getvar(), action_listcategories(), action_listcommands(), action_login(), action_mailboxcount(), action_mailboxstatus(), action_meetmelist(), action_meetmelistrooms(), action_ping(), action_presencestate(), action_presencestatelist(), action_status(), action_waitevent(), ami_outbound_registration_task(), ami_registrations_aor(), ami_show_outbound_registrations(), ami_subscription_detail(), append_vmbox_info_astman(), append_vmu_info_astman(), ast_cli_netstats(), ast_manager_hangup_helper(), ast_sip_format_contact_ami(), astman_append_json(), astman_send_list_complete_end(), do_print(), format_ami_aor_handler(), format_ami_aorlist_handler(), format_ami_auth_handler(), format_ami_authlist_handler(), format_ami_contactlist_handler(), format_ami_endpoint(), format_ami_endpoint_transport(), format_ami_endpoints(), format_ami_resource_lists(), generate_status(), manager_append_event_parking_lot_data_cb(), manager_bridge_info(), manager_bridge_tech_list(), manager_db_tree_get(), manager_dbget(), manager_fax_sessions(), manager_fax_sessions_entry(), manager_fax_stats(), manager_iax2_show_netstats(), manager_iax2_show_registry(), manager_jabber_send(), manager_mixmonitor(), manager_modulecheck(), manager_mute_mixmonitor(), manager_mutestream(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queue_rule_show(), manager_queues_status(), manager_queues_summary(), manager_show_dialplan(), manager_show_dialplan_helper(), manager_stop_mixmonitor(), mwi_mailbox_get(), send_bridge_info_item_cb(), send_bridge_list_item_cb(), send_identify_ami_event(), session_do(), and spandsp_manager_fax_session().

◆ astman_append_headers()

static void astman_append_headers ( struct message m,
const struct ast_variable params 
)
static

Append additional headers into the message structure from params.

Note
You likely want to initialize m->hdrcount to 0 before calling this.

Definition at line 1659 of file manager.c.

1660{
1661 const struct ast_variable *v;
1662
1663 for (v = params; v && m->hdrcount < ARRAY_LEN(m->headers); v = v->next) {
1664 if (ast_asprintf((char**)&m->headers[m->hdrcount], "%s: %s", v->name, v->value) > -1) {
1665 ++m->hdrcount;
1666 }
1667 }
1668}

References ARRAY_LEN, ast_asprintf, message::hdrcount, message::headers, ast_variable::name, ast_variable::next, and ast_variable::value.

Referenced by auth_http_callback(), and generic_http_callback().

◆ astman_append_json()

static void astman_append_json ( struct mansession s,
const char *  str 
)
static

Definition at line 2642 of file manager.c.

2643{
2644 char *buf;
2645
2646 buf = ast_alloca(2 * strlen(str) + 1);
2648 astman_append(s, "%s", buf);
2649}
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition astmm.h:288
static void json_escape(char *out, const char *in)
Definition manager.c:2624

References ast_alloca, astman_append(), buf, json_escape(), and str.

Referenced by action_getconfigjson().

◆ astman_flush()

static void astman_flush ( struct mansession s,
struct ast_str buf 
)
static

Definition at line 1897 of file manager.c.

1898{
1899 if (s->hook || (s->tcptls_session && s->tcptls_session->stream)) {
1901 } else {
1902 ast_verbose("No connection stream in astman_append, should not happen\n");
1903 }
1904}

References ast_str_buffer(), ast_verbose, buf, mansession::hook, send_string(), ast_tcptls_session_instance::stream, and mansession::tcptls_session.

Referenced by astman_send_list_complete(), astman_send_list_complete_start(), and astman_send_response_full().

◆ astman_free_headers()

static void astman_free_headers ( struct message m)
static

Free headers inside message structure, but not the message structure itself.

Definition at line 1673 of file manager.c.

1674{
1675 while (m->hdrcount) {
1676 --m->hdrcount;
1677 ast_free((void *) m->headers[m->hdrcount]);
1678 m->headers[m->hdrcount] = NULL;
1679 }
1680}

References ast_free, message::hdrcount, message::headers, and NULL.

Referenced by auth_http_callback(), do_message(), and generic_http_callback().

◆ astman_get_header()

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

Return the first matching variable from an array.

Get header from manager transaction.

Note
This is the legacy function and is implemented in therms of __astman_get_header().
Never returns NULL.

Definition at line 1649 of file manager.c.

1650{
1652}
#define GET_HEADER_FIRST_MATCH
Definition manager.c:1595

References __astman_get_header(), GET_HEADER_FIRST_MATCH, and var.

Referenced by action_add_agi_cmd(), action_agent_logoff(), action_agents(), action_aoc_de_message(), action_aocmessage(), action_atxfer(), action_blind_transfer(), action_bridge(), action_cancel_atxfer(), action_challenge(), action_command(), action_confbridgekick(), action_confbridgelist(), action_confbridgelistrooms(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), action_coresettings(), action_coreshowchannelmap(), action_coreshowchannels(), action_corestatus(), action_createconfig(), action_dahdidialoffhook(), action_dahdidndoff(), action_dahdidndon(), action_dahdishowchannels(), action_dahdishowstatus(), action_devicestatelist(), action_events(), action_extensionstate(), action_extensionstatelist(), action_filter(), action_getconfig(), action_getconfigjson(), action_getvar(), action_listcategories(), action_lock_unlock_helper(), action_mailboxcount(), action_mailboxstatus(), action_meetmelist(), action_meetmelistrooms(), action_messagesend(), action_mute_unmute_helper(), action_originate(), action_ping(), action_presencestate(), action_presencestatelist(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), action_userevent(), action_waitevent(), ami_register(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoint(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_registration_contact_statuses(), ami_show_registrations(), ami_show_resource_lists(), ami_show_subscriptions_inbound(), ami_show_subscriptions_outbound(), ami_sip_qualify(), ami_unregister(), aocmessage_get_unit_entry(), ast_hook_send_action(), ast_manager_hangup_helper(), astman_send_list_complete_start_common(), astman_send_response_full(), authenticate(), controlplayback_manager(), handle_manager_bridge_tech_suspend(), handle_updates(), manager_add_queue_member(), manager_bridge_destroy(), manager_bridge_info(), manager_bridge_kick(), manager_bridge_tech_list(), manager_bridges_list(), manager_change_priority_caller_on_queue(), manager_db_tree_get(), manager_dbdel(), manager_dbdeltree(), manager_dbget(), manager_dbput(), manager_dialplan_extension_add(), manager_dialplan_extension_remove(), manager_fax_session(), manager_fax_sessions(), manager_fax_stats(), manager_get_mailbox_summary(), manager_iax2_show_peer_list(), manager_iax2_show_peers(), manager_iax2_show_registry(), manager_jabber_send(), manager_list_voicemail_users(), manager_match_mailbox(), manager_mixmonitor(), manager_modulecheck(), manager_moduleload(), manager_mute_mixmonitor(), manager_mutestream(), manager_notify(), manager_notify_endpoint(), manager_notify_uri(), manager_optimize_away(), manager_park(), manager_parking_lot_list(), manager_parking_status(), manager_pause_queue_member(), manager_play_dtmf(), manager_play_mf(), manager_queue_log_custom(), manager_queue_member_penalty(), manager_queue_member_ringinuse(), manager_queue_reload(), manager_queue_reset(), manager_queue_rule_show(), manager_queues_status(), manager_queues_summary(), manager_remove_queue_member(), manager_request_withdraw_caller_from_queue(), manager_send_flash(), manager_show_dialplan(), manager_status_voicemail_user(), manager_stop_mixmonitor(), manager_voicemail_forward(), manager_voicemail_move(), manager_voicemail_remove(), meetmemute(), mwi_mailbox_delete(), mwi_mailbox_get(), mwi_mailbox_update(), process_message(), sorcery_memory_cache_ami_expire(), sorcery_memory_cache_ami_expire_object(), sorcery_memory_cache_ami_populate(), sorcery_memory_cache_ami_stale(), and sorcery_memory_cache_ami_stale_object().

◆ astman_get_variables()

struct ast_variable * astman_get_variables ( const struct message m)

Get a linked list of the Variable: headers.

Note
Order of variables is reversed from the order they are specified in the manager message

Definition at line 1735 of file manager.c.

1736{
1738}
struct ast_variable * astman_get_variables_order(const struct message *m, enum variable_orders order)
Get a linked list of the Variable: headers with order specified.
Definition manager.c:1740
@ ORDER_REVERSE
Definition manager.h:291

References astman_get_variables_order(), and ORDER_REVERSE.

Referenced by action_originate().

◆ astman_get_variables_order()

struct ast_variable * astman_get_variables_order ( const struct message m,
enum variable_orders  order 
)

Get a linked list of the Variable: headers with order specified.

Definition at line 1740 of file manager.c.

1742{
1743 int varlen;
1744 int x;
1745 struct ast_variable *head = NULL;
1746
1747 static const char var_hdr[] = "Variable:";
1748
1749 /* Process all "Variable:" headers. */
1750 varlen = strlen(var_hdr);
1751 for (x = 0; x < m->hdrcount; x++) {
1752 if (strncasecmp(var_hdr, m->headers[x], varlen)) {
1753 continue;
1754 }
1755 head = man_do_variable_value(head, m->headers[x] + varlen);
1756 }
1757
1758 if (order == ORDER_NATURAL) {
1759 head = ast_variables_reverse(head);
1760 }
1761
1762 return head;
1763}
integer order
Definition analys.c:66
static struct ast_variable * man_do_variable_value(struct ast_variable *head, const char *hdr_val)
Definition manager.c:1691
struct ast_variable * ast_variables_reverse(struct ast_variable *var)
Reverse a variable list.
@ ORDER_NATURAL
Definition manager.h:290

References ast_variables_reverse(), message::hdrcount, message::headers, man_do_variable_value(), NULL, order, and ORDER_NATURAL.

Referenced by action_messagesend(), astman_get_variables(), manager_notify_channel(), manager_notify_endpoint(), and manager_notify_uri().

◆ astman_live_dangerously()

void astman_live_dangerously ( int  new_live_dangerously)

Enable/disable the inclusion of 'dangerous' configurations outside of the ast_config_AST_CONFIG_DIR.

This function can globally enable/disable the loading of configuration files outside of ast_config_AST_CONFIG_DIR.

Parameters
new_live_dangerouslyIf true, enable the access of files outside ast_config_AST_CONFIG_DIR from astman.

Definition at line 2449 of file manager.c.

2450{
2451 if (new_live_dangerously && !live_dangerously)
2452 {
2453 ast_log(LOG_WARNING, "Manager Configuration load protection disabled.\n");
2454 }
2455
2456 if (!new_live_dangerously && live_dangerously)
2457 {
2458 ast_log(LOG_NOTICE, "Manager Configuration load protection enabled.\n");
2459 }
2460 live_dangerously = new_live_dangerously;
2461}

References ast_log, live_dangerously, LOG_NOTICE, and LOG_WARNING.

Referenced by load_asterisk_conf().

◆ astman_send_ack()

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

Send ack in manager transaction.

Definition at line 2020 of file manager.c.

2021{
2022 astman_send_response_full(s, m, "Success", msg, NULL);
2023}

References astman_send_response_full(), and NULL.

Referenced by action_add_agi_cmd(), action_agent_logoff(), action_aocmessage(), action_atxfer(), action_blind_transfer(), action_bridge(), action_cancel_atxfer(), action_confbridgekick(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), action_createconfig(), action_dahdidialoffhook(), action_dahdidndoff(), action_dahdidndon(), action_dahdirestart(), action_filter(), action_lock_unlock_helper(), action_loggerrotate(), action_login(), action_messagesend(), action_mute_unmute_helper(), action_originate(), action_redirect(), action_reload(), action_sendtext(), action_setvar(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), action_userevent(), ami_register(), ami_sip_qualify(), ami_unregister(), ast_manager_hangup_helper(), controlplayback_manager(), handle_manager_bridge_tech_suspend(), manager_add_queue_member(), manager_bridge_destroy(), manager_bridge_kick(), manager_change_priority_caller_on_queue(), manager_dbdel(), manager_dbdeltree(), manager_dbput(), manager_dialplan_extension_add(), manager_dialplan_extension_remove(), manager_fax_session(), manager_fax_stats(), manager_get_mailbox_summary(), manager_jabber_send(), manager_list_voicemail_users(), manager_moduleload(), manager_optimize_away(), manager_park_bridged(), manager_park_unbridged(), manager_pause_queue_member(), manager_play_dtmf(), manager_play_mf(), manager_queue_log_custom(), manager_queue_member_penalty(), manager_queue_member_ringinuse(), manager_queue_reload(), manager_queue_reset(), manager_remove_queue_member(), manager_request_withdraw_caller_from_queue(), manager_send_flash(), manager_send_response(), manager_status_voicemail_user(), manager_voicemail_forward(), manager_voicemail_move(), manager_voicemail_refresh(), manager_voicemail_remove(), meetmemute(), mwi_mailbox_delete(), mwi_mailbox_update(), sorcery_memory_cache_ami_expire(), sorcery_memory_cache_ami_expire_object(), sorcery_memory_cache_ami_populate(), sorcery_memory_cache_ami_stale(), and sorcery_memory_cache_ami_stale_object().

◆ astman_send_error()

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

Send error in manager transaction.

Definition at line 1988 of file manager.c.

1989{
1990 astman_send_response_full(s, m, "Error", error, NULL);
1991}

References astman_send_response_full(), error(), and NULL.

Referenced by action_add_agi_cmd(), action_agent_logoff(), action_aoc_de_message(), action_aoc_s_message(), action_aoc_s_submessage(), action_aocmessage(), action_atxfer(), action_blind_transfer(), action_bridge(), action_cancel_atxfer(), action_challenge(), action_command(), action_confbridgekick(), action_confbridgelist(), action_confbridgelistrooms(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), action_coreshowchannelmap(), action_createconfig(), action_dahdidialoffhook(), action_dahdidndoff(), action_dahdidndon(), action_dahdirestart(), action_dahdishowstatus(), action_devicestatelist(), action_events(), action_extensionstate(), action_extensionstatelist(), action_filter(), action_getconfig(), action_getconfigjson(), action_getvar(), action_listcategories(), action_lock_unlock_helper(), action_loggerrotate(), action_login(), action_mailboxcount(), action_mailboxstatus(), action_meetmelist(), action_meetmelistrooms(), action_messagesend(), action_mute_unmute_helper(), action_originate(), action_presencestate(), action_presencestatelist(), action_redirect(), action_reload(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_transfer(), action_transferhangup(), action_updateconfig(), ami_register(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_resource_lists(), ami_sip_qualify(), ami_unregister(), ast_manager_hangup_helper(), controlplayback_manager(), do_message(), handle_manager_bridge_tech_suspend(), handle_parse_error(), manager_add_queue_member(), manager_bridge_destroy(), manager_bridge_info(), manager_bridge_kick(), manager_bridge_tech_list(), manager_bridges_list(), manager_change_priority_caller_on_queue(), manager_db_tree_get(), manager_dbdel(), manager_dbdeltree(), manager_dbget(), manager_dbput(), manager_dialplan_extension_add(), manager_dialplan_extension_remove(), manager_fax_session(), manager_get_mailbox_summary(), manager_jabber_send(), manager_mixmonitor(), manager_modulecheck(), manager_moduleload(), manager_mute_mixmonitor(), manager_mutestream(), manager_notify(), manager_optimize_away(), manager_park(), manager_park_bridged(), manager_park_unbridged(), manager_parking_lot_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_pause_queue_member(), manager_play_dtmf(), manager_play_mf(), manager_queue_log_custom(), manager_queue_member_penalty(), manager_queue_member_ringinuse(), manager_queue_reload(), manager_queue_reset(), manager_remove_queue_member(), manager_request_withdraw_caller_from_queue(), manager_send_flash(), manager_send_response(), manager_show_dialplan(), manager_show_dialplan_helper(), manager_status_voicemail_user(), manager_stop_mixmonitor(), manager_voicemail_forward(), manager_voicemail_move(), manager_voicemail_remove(), meetmemute(), mwi_mailbox_delete(), mwi_mailbox_get(), mwi_mailbox_update(), process_message(), sorcery_memory_cache_ami_expire(), sorcery_memory_cache_ami_expire_object(), sorcery_memory_cache_ami_populate(), sorcery_memory_cache_ami_stale(), and sorcery_memory_cache_ami_stale_object().

◆ astman_send_error_va()

void astman_send_error_va ( struct mansession s,
const struct message m,
const char *  fmt,
  ... 
)

Send error in manager transaction (with va_args support)

Definition at line 1993 of file manager.c.

1994{
1995 int res;
1996 va_list ap;
1997 struct ast_str *buf;
1998 char *msg;
1999
2000 if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2001 return;
2002 }
2003
2004 va_start(ap, fmt);
2005 res = ast_str_set_va(&buf, 0, fmt, ap);
2006 va_end(ap);
2007 if (res == AST_DYNSTR_BUILD_FAILED) {
2008 return;
2009 }
2010
2011 /* astman_append will use the same underlying buffer, so copy the message out
2012 * before sending the response */
2013 msg = ast_str_buffer(buf);
2014 if (msg) {
2015 msg = ast_strdupa(msg);
2016 }
2017 astman_send_response_full(s, m, "Error", msg, NULL);
2018}

References AST_DYNSTR_BUILD_FAILED, ast_str_buffer(), ast_str_set_va(), ast_str_thread_get(), ast_strdupa, ASTMAN_APPEND_BUF_INITSIZE, astman_send_response_full(), buf, and NULL.

Referenced by action_command(), action_originate(), action_presencestate(), ami_show_endpoint(), ast_manager_hangup_helper(), ast_sip_create_ami_event(), format_ami_endpoint_transport(), manager_notify_endpoint(), manager_notify_uri(), manager_send_response(), mwi_mailbox_delete(), mwi_mailbox_get(), and mwi_mailbox_update().

◆ astman_send_list_complete()

static void astman_send_list_complete ( struct mansession s,
const struct message m,
const char *  event_name,
int  count 
)
static

Definition at line 2057 of file manager.c.

2058{
2059 struct ast_str *buf = astman_send_list_complete_start_common(s, m, event_name, count);
2060 if (buf) {
2061 ast_str_append(&buf, 0, "\r\n");
2062 astman_flush(s, buf);
2063 }
2064}
static void astman_flush(struct mansession *s, struct ast_str *buf)
Definition manager.c:1897
static struct ast_str * astman_send_list_complete_start_common(struct mansession *s, const struct message *m, const char *event_name, int count)
Definition manager.c:2035

References ast_str_append(), astman_flush(), astman_send_list_complete_start_common(), and buf.

Referenced by action_coreshowchannels(), and ast_manager_hangup_helper().

◆ astman_send_list_complete_end()

void astman_send_list_complete_end ( struct mansession s)

End the list complete event.

Since
13.2.0
Parameters
s- AMI session control struct.
Note
You need to call astman_send_list_complete_start() to start the AMI list completion event.
Between calling astman_send_list_complete_start() and astman_send_list_complete_end() you can add additonal headers using astman_append().

Definition at line 2074 of file manager.c.

2075{
2076 astman_append(s, "\r\n");
2077}

References astman_append().

Referenced by action_agents(), action_confbridgelist(), action_confbridgelistrooms(), action_coreshowchannelmap(), action_dahdishowchannels(), action_dahdishowstatus(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_meetmelistrooms(), action_presencestatelist(), action_status(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoint(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_registration_contact_statuses(), ami_show_registrations(), ami_show_resource_lists(), ami_show_subscriptions_inbound(), ami_show_subscriptions_outbound(), append_vmbox_info_astman(), manager_bridge_info(), manager_bridge_tech_list(), manager_bridges_list(), manager_db_tree_get(), manager_dbget(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_iax2_show_peers(), manager_iax2_show_registry(), manager_list_voicemail_users(), manager_parking_lot_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), manager_show_dialplan(), manager_status_voicemail_user(), and mwi_mailbox_get().

◆ astman_send_list_complete_start()

void astman_send_list_complete_start ( struct mansession s,
const struct message m,
const char *  event_name,
int  count 
)

Start the list complete event.

Since
13.2.0
Parameters
s- AMI session control struct.
m- AMI action request that started the list.
event_name- AMI list complete event name.
count- Number of items in the list.
Note
You need to call astman_send_list_complete_end() to end the AMI list completion event.
Between calling astman_send_list_complete_start() and astman_send_list_complete_end() you can add additonal headers using astman_append().

Definition at line 2066 of file manager.c.

2067{
2068 struct ast_str *buf = astman_send_list_complete_start_common(s, m, event_name, count);
2069 if (buf) {
2070 astman_flush(s, buf);
2071 }
2072}

References astman_flush(), astman_send_list_complete_start_common(), and buf.

Referenced by action_agents(), action_confbridgelist(), action_confbridgelistrooms(), action_coreshowchannelmap(), action_dahdishowchannels(), action_dahdishowstatus(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_meetmelistrooms(), action_presencestatelist(), action_status(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoint(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_registration_contact_statuses(), ami_show_registrations(), ami_show_resource_lists(), ami_show_subscriptions_inbound(), ami_show_subscriptions_outbound(), append_vmbox_info_astman(), manager_bridge_info(), manager_bridge_tech_list(), manager_bridges_list(), manager_db_tree_get(), manager_dbget(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_iax2_show_peers(), manager_iax2_show_registry(), manager_list_voicemail_users(), manager_parking_lot_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), manager_show_dialplan(), manager_status_voicemail_user(), and mwi_mailbox_get().

◆ astman_send_list_complete_start_common()

static struct ast_str * astman_send_list_complete_start_common ( struct mansession s,
const struct message m,
const char *  event_name,
int  count 
)
static

Definition at line 2035 of file manager.c.

2036{
2037 const char *id = astman_get_header(m, "ActionID");
2038 struct ast_str *buf;
2039
2040 buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE);
2041 if (!buf) {
2042 return NULL;
2043 }
2044
2045 ast_str_set(&buf, 0, "Event: %s\r\n", event_name);
2046 if (!ast_strlen_zero(id)) {
2047 ast_str_append(&buf, 0, "ActionID: %s\r\n", id);
2048 }
2049 ast_str_append(&buf, 0,
2050 "EventList: Complete\r\n"
2051 "ListItems: %d\r\n",
2052 count);
2053
2054 return buf;
2055}

References ast_str_append(), ast_str_set(), ast_str_thread_get(), ast_strlen_zero(), ASTMAN_APPEND_BUF_INITSIZE, astman_get_header(), buf, and NULL.

Referenced by astman_send_list_complete(), and astman_send_list_complete_start().

◆ astman_send_listack()

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

Send ack in manager transaction to begin a list.

Parameters
s- AMI session control struct.
m- AMI action request that started the list.
msg- Message contents describing the list to follow.
listflag- Should always be set to "start".
Note
You need to call astman_send_list_complete_start() and astman_send_list_complete_end() to send the AMI list completion event.

Definition at line 2030 of file manager.c.

2031{
2032 astman_send_response_full(s, m, "Success", msg, listflag);
2033}

References astman_send_response_full().

Referenced by action_agents(), action_confbridgelist(), action_confbridgelistrooms(), action_coreshowchannelmap(), action_coreshowchannels(), action_dahdishowchannels(), action_dahdishowstatus(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_meetmelistrooms(), action_presencestatelist(), action_status(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoint(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_registration_contact_statuses(), ami_show_registrations(), ami_show_resource_lists(), ami_show_subscriptions_inbound(), ami_show_subscriptions_outbound(), append_vmbox_info_astman(), ast_manager_hangup_helper(), manager_bridge_info(), manager_bridge_tech_list(), manager_bridges_list(), manager_db_tree_get(), manager_dbget(), manager_dpsendack(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_iax2_show_peers(), manager_iax2_show_registry(), manager_list_voicemail_users(), manager_parking_lot_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), manager_status_voicemail_user(), and mwi_mailbox_get().

◆ astman_send_response()

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

Send response in manager transaction.

Definition at line 1983 of file manager.c.

1984{
1985 astman_send_response_full(s, m, resp, msg, NULL);
1986}

References astman_send_response_full(), and NULL.

Referenced by action_logoff(), and action_waitevent().

◆ astman_send_response_full()

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

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

1953{
1954 const char *id = astman_get_header(m, "ActionID");
1955 struct ast_str *buf;
1956
1957 buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE);
1958 if (!buf) {
1959 return;
1960 }
1961
1962 ast_str_set(&buf, 0, "Response: %s\r\n", resp);
1963
1964 if (!ast_strlen_zero(id)) {
1965 ast_str_append(&buf, 0, "ActionID: %s\r\n", id);
1966 }
1967
1968 if (listflag) {
1969 /* Start, complete, cancelled */
1970 ast_str_append(&buf, 0, "EventList: %s\r\n", listflag);
1971 }
1972
1973 if (msg != MSG_MOREDATA) {
1974 if (msg) {
1975 ast_str_append(&buf, 0, "Message: %s\r\n", msg);
1976 }
1977 ast_str_append(&buf, 0, "\r\n");
1978 }
1979
1980 astman_flush(s, buf);
1981}

References ast_str_append(), ast_str_set(), ast_str_thread_get(), ast_strlen_zero(), ASTMAN_APPEND_BUF_INITSIZE, astman_flush(), astman_get_header(), buf, and MSG_MOREDATA.

Referenced by action_command(), astman_send_ack(), astman_send_error(), astman_send_error_va(), astman_send_listack(), astman_send_response(), and astman_start_ack().

◆ astman_start_ack()

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

◆ async_goto_with_discard_bridge_after()

static int async_goto_with_discard_bridge_after ( struct ast_channel chan,
const char *  context,
const char *  exten,
int  priority 
)
static

Definition at line 3952 of file manager.c.

3953{
3955 return ast_async_goto(chan, context, exten, priority);
3956}
void ast_bridge_discard_after_goto(struct ast_channel *chan)
Discard channel after bridge goto location.
int ast_async_goto(struct ast_channel *chan, const char *context, const char *exten, int priority)
Set the channel to next execute the specified dialplan location.
Definition pbx.c:7013

References ast_async_goto(), ast_bridge_discard_after_goto(), and priority.

Referenced by action_redirect().

◆ authenticate()

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

Definition at line 2334 of file manager.c.

2335{
2336 const char *username = astman_get_header(m, "Username");
2337 const char *password = astman_get_header(m, "Secret");
2338 int error = -1;
2339 struct ast_manager_user *user = NULL;
2340 regex_t *regex_filter;
2341 struct ao2_iterator filter_iter;
2342
2343 if (ast_strlen_zero(username)) { /* missing username */
2344 return -1;
2345 }
2346
2347 /* locate user in locked state */
2349
2350 if (!(user = get_manager_by_name_locked(username))) {
2351 report_invalid_user(s, username);
2352 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2353 } else if (user->acl && (ast_apply_acl(user->acl, &s->session->addr, "Manager User ACL: ") == AST_SENSE_DENY)) {
2354 report_failed_acl(s, username);
2355 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2356 } else if (!strcasecmp(astman_get_header(m, "AuthType"), "MD5")) {
2357 const char *key = astman_get_header(m, "Key");
2358 if (!ast_strlen_zero(key) && !ast_strlen_zero(s->session->challenge) && user->secret) {
2359 int x;
2360 int len = 0;
2361 char md5key[256] = "";
2362 struct MD5Context md5;
2363 unsigned char digest[16];
2364
2365 MD5Init(&md5);
2366 MD5Update(&md5, (unsigned char *) s->session->challenge, strlen(s->session->challenge));
2367 MD5Update(&md5, (unsigned char *) user->secret, strlen(user->secret));
2368 MD5Final(digest, &md5);
2369 for (x = 0; x < 16; x++)
2370 len += sprintf(md5key + len, "%02hhx", digest[x]);
2371 if (!strcmp(md5key, key)) {
2372 error = 0;
2373 } else {
2374 report_failed_challenge_response(s, key, md5key);
2375 }
2376 } else {
2377 ast_debug(1, "MD5 authentication is not possible. challenge: '%s'\n",
2378 S_OR(s->session->challenge, ""));
2379 }
2380 } else if (user->secret) {
2381 if (!strcmp(password, user->secret)) {
2382 error = 0;
2383 } else {
2384 report_inval_password(s, username);
2385 }
2386 }
2387
2388 if (error) {
2389 ast_log(LOG_NOTICE, "%s failed to authenticate as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2391 return -1;
2392 }
2393
2394 /* auth complete */
2395
2396 /* All of the user parameters are copied to the session so that in the event
2397 * of a reload and a configuration change, the session parameters are not
2398 * changed. */
2399 ast_copy_string(s->session->username, username, sizeof(s->session->username));
2400 s->session->readperm = user->readperm;
2401 s->session->writeperm = user->writeperm;
2402 s->session->writetimeout = user->writetimeout;
2403 if (user->chanvars) {
2404 s->session->chanvars = ast_variables_dup(user->chanvars);
2405 }
2406
2407 filter_iter = ao2_iterator_init(user->includefilters, 0);
2408 while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2409 ao2_t_link(s->session->includefilters, regex_filter, "add include user filter to session");
2410 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2411 }
2412 ao2_iterator_destroy(&filter_iter);
2413
2414 filter_iter = ao2_iterator_init(user->excludefilters, 0);
2415 while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2416 ao2_t_link(s->session->excludefilters, regex_filter, "add exclude user filter to session");
2417 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2418 }
2419 ao2_iterator_destroy(&filter_iter);
2420
2421 s->session->sessionstart = time(NULL);
2423 set_eventmask(s, astman_get_header(m, "Events"));
2424
2426
2428 return 0;
2429}
enum ast_acl_sense ast_apply_acl(struct ast_acl_list *acl_list, const struct ast_sockaddr *addr, const char *purpose)
Apply a set of rules to a given IP address.
Definition acl.c:799
@ AST_SENSE_DENY
Definition acl.h:37
#define ao2_t_link(container, obj, tag)
Definition astobj2.h:1534
static int md5(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
Definition func_md5.c:55
static struct ast_manager_user * get_manager_by_name_locked(const char *name)
Definition manager.c:1042
static void report_invalid_user(const struct mansession *s, const char *username)
Definition manager.c:2114
static void report_failed_acl(const struct mansession *s, const char *username)
Definition manager.c:2139
static void report_failed_challenge_response(const struct mansession *s, const char *response, const char *expected_response)
Definition manager.c:2272
static void report_inval_password(const struct mansession *s, const char *username)
Definition manager.c:2164
static void report_auth_success(const struct mansession *s)
Definition manager.c:2189
void MD5Update(struct MD5Context *context, unsigned char const *buf, unsigned len)
Definition md5.c:72
void MD5Init(struct MD5Context *context)
Definition md5.c:57
void MD5Final(unsigned char digest[MD5_DIGEST_LENGTH], struct MD5Context *context)
Definition md5.c:120
user descriptor, as read from the config file.
Definition manager.c:342
struct ast_sockaddr addr
Definition manager.c:280
struct timeval sessionstart_tv
Definition manager.c:287
char username[80]
Definition manager.c:289
time_t sessionstart
Definition manager.c:286
structure to hold users read from phoneprov_users.conf
list of users found in the config file
int error(const char *format,...)

References mansession_session::addr, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_t_link, ao2_t_ref, ast_apply_acl(), ast_copy_string(), ast_debug, ast_log, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, AST_SENSE_DENY, ast_sockaddr_stringify_addr(), ast_strlen_zero(), ast_tvnow(), ast_variables_dup(), astman_get_header(), mansession_session::challenge, mansession_session::chanvars, error(), mansession_session::excludefilters, get_manager_by_name_locked(), mansession_session::includefilters, len(), LOG_NOTICE, md5(), MD5Final(), MD5Init(), MD5Update(), NULL, mansession_session::readperm, report_auth_success(), report_failed_acl(), report_failed_challenge_response(), report_inval_password(), report_invalid_user(), S_OR, mansession::session, mansession_session::sessionstart, mansession_session::sessionstart_tv, set_eventmask(), mansession_session::username, mansession_session::writeperm, and mansession_session::writetimeout.

Referenced by action_login().

◆ authority_to_str()

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

Convert authority code to a list of options. Note that the EVENT_FLAG_ALL authority will always be returned.

Definition at line 815 of file manager.c.

816{
817 int i;
818 char *sep = "";
819
820 ast_str_reset(*res);
821 if (authority != EVENT_FLAG_SHUTDOWN) {
822 for (i = 0; i < ARRAY_LEN(perms) - 1; i++) {
823 if (authority & perms[i].num) {
824 ast_str_append(res, 0, "%s%s", sep, perms[i].label);
825 sep = ",";
826 }
827 }
828 }
829
830 if (ast_str_strlen(*res) == 0) {
831 /* replace empty string with something sensible */
832 ast_str_append(res, 0, "<none>");
833 }
834
835 return ast_str_buffer(*res);
836}

References ARRAY_LEN, ast_str_append(), ast_str_buffer(), ast_str_reset(), ast_str_strlen(), EVENT_FLAG_SHUTDOWN, and perms.

Referenced by __manager_event_sessions_va(), action_listcommands(), action_login(), and handle_showmancmd().

◆ build_mansession()

static struct mansession_session * build_mansession ( const struct ast_sockaddr addr)
static

Allocate manager session structure and add it to the list of sessions.

Definition at line 966 of file manager.c.

967{
968 struct ao2_container *sessions;
969 struct mansession_session *newsession;
970
971 newsession = ao2_alloc(sizeof(*newsession), session_destructor);
972 if (!newsession) {
973 return NULL;
974 }
975
978 if (!newsession->includefilters || !newsession->excludefilters) {
979 ao2_ref(newsession, -1);
980 return NULL;
981 }
982
983 newsession->waiting_thread = AST_PTHREADT_NULL;
984 newsession->writetimeout = 100;
985 newsession->send_events = -1;
986 ast_sockaddr_copy(&newsession->addr, addr);
987
988 ast_mutex_init(&newsession->notify_lock);
989
990 sessions = ao2_global_obj_ref(mgr_sessions);
991 if (sessions) {
992 ao2_link(sessions, newsession);
993 ao2_ref(sessions, -1);
994 }
995
996 return newsession;
997}
#define ao2_link(container, obj)
Add an object to a container.
Definition astobj2.h:1532
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition astobj2.h:363
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Allocate and initialize a list container.
Definition astobj2.h:1327
#define ao2_alloc(data_size, destructor_fn)
Definition astobj2.h:409
static void session_destructor(void *obj)
Definition manager.c:935
#define ast_mutex_init(pmutex)
Definition lock.h:193
static void ast_sockaddr_copy(struct ast_sockaddr *dst, const struct ast_sockaddr *src)
Copies the data from one ast_sockaddr to another.
Definition netsock2.h:167

References mansession_session::addr, ao2_alloc, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_list, ao2_global_obj_ref, ao2_link, ao2_ref, ast_mutex_init, AST_PTHREADT_NULL, ast_sockaddr_copy(), mansession_session::excludefilters, mansession_session::includefilters, mansession_session::notify_lock, NULL, mansession_session::send_events, session_destructor(), sessions, mansession_session::waiting_thread, and mansession_session::writetimeout.

Referenced by auth_http_callback(), generic_http_callback(), and session_do().

◆ check_blacklist()

static int check_blacklist ( const char *  cmd)
static

Definition at line 4245 of file manager.c.

4246{
4247 char *cmd_copy, *cur_cmd;
4248 char *cmd_words[AST_MAX_CMD_LEN] = { NULL, };
4249 int i;
4250
4251 cmd_copy = ast_strdupa(cmd);
4252 for (i = 0; i < MAX_BLACKLIST_CMD_LEN && (cur_cmd = strsep(&cmd_copy, " ")); i++) {
4253 cur_cmd = ast_strip(cur_cmd);
4254 if (ast_strlen_zero(cur_cmd)) {
4255 i--;
4256 continue;
4257 }
4258
4259 cmd_words[i] = cur_cmd;
4260 }
4261
4262 for (i = 0; i < ARRAY_LEN(command_blacklist); i++) {
4263 int j, match = 1;
4264
4265 for (j = 0; command_blacklist[i].words[j]; j++) {
4266 if (ast_strlen_zero(cmd_words[j]) || strcasecmp(cmd_words[j], command_blacklist[i].words[j])) {
4267 match = 0;
4268 break;
4269 }
4270 }
4271
4272 if (match) {
4273 return 1;
4274 }
4275 }
4276
4277 return 0;
4278}
#define AST_MAX_CMD_LEN
Definition cli.h:48
#define MAX_BLACKLIST_CMD_LEN
Descriptor for a manager session, either on the AMI socket or over HTTP.
Definition manager.c:220
static const struct @396 command_blacklist[]
const char * words[AST_MAX_CMD_LEN]
Definition manager.c:222

References ARRAY_LEN, AST_MAX_CMD_LEN, ast_strdupa, ast_strip(), ast_strlen_zero(), command_blacklist, match(), MAX_BLACKLIST_CMD_LEN, NULL, strsep(), and words.

Referenced by action_command().

◆ check_manager_session_inuse()

static int check_manager_session_inuse ( const char *  name)
static

Definition at line 1019 of file manager.c.

1020{
1021 struct ao2_container *sessions;
1023 int inuse = 0;
1024
1025 sessions = ao2_global_obj_ref(mgr_sessions);
1026 if (sessions) {
1027 session = ao2_find(sessions, (char *) name, 0);
1028 ao2_ref(sessions, -1);
1029 if (session) {
1031 inuse = 1;
1032 }
1033 }
1034 return inuse;
1035}
#define ao2_find(container, arg, flags)
Definition astobj2.h:1736

References ao2_find, ao2_global_obj_ref, ao2_ref, mansession_session::inuse, name, session, sessions, and unref_mansession().

Referenced by process_message().

◆ coreshowchannelmap_add_connected_channels()

static int coreshowchannelmap_add_connected_channels ( struct ao2_container channel_map,
struct ast_channel_snapshot channel_snapshot,
struct ast_bridge_snapshot bridge_snapshot 
)
static

Recursive function to get all channels in a bridge. Follow local channels as well.

Definition at line 6670 of file manager.c.

6672{
6673 int res = 0;
6674 struct ao2_iterator iter;
6675 char *current_channel_uid;
6676
6677 iter = ao2_iterator_init(bridge_snapshot->channels, 0);
6678 while ((current_channel_uid = ao2_iterator_next(&iter))) {
6679 struct ast_channel_snapshot *current_channel_snapshot;
6680 int add_channel_res;
6681
6682 /* Don't add the original channel to the list - it's either already in there,
6683 * or it's the channel we want the map for */
6684 if (!strcmp(current_channel_uid, channel_snapshot->base->uniqueid)) {
6685 ao2_ref(current_channel_uid, -1);
6686 continue;
6687 }
6688
6689 current_channel_snapshot = ast_channel_snapshot_get_latest(current_channel_uid);
6690 if (!current_channel_snapshot) {
6691 ast_debug(5, "Unable to get channel snapshot\n");
6692 ao2_ref(current_channel_uid, -1);
6693 continue;
6694 }
6695
6696 add_channel_res = coreshowchannelmap_add_to_map(channel_map, current_channel_snapshot->base->name);
6697 if (add_channel_res) {
6698 res = 1;
6699 ao2_ref(current_channel_snapshot, -1);
6700 ao2_ref(current_channel_uid, -1);
6701 break;
6702 }
6703
6704 /* If this is a local channel that we haven't seen yet, let's go ahead and find out what else is connected to it */
6705 if (ast_begins_with(current_channel_snapshot->base->name, "Local")) {
6706 struct ast_channel_snapshot *other_local_snapshot;
6707 struct ast_bridge_snapshot *other_bridge_snapshot;
6708 int size = strlen(current_channel_snapshot->base->name);
6709 char other_local[size + 1];
6710
6711 /* Don't copy the trailing number - set it to 1 or 2, whichever one it currently is not */
6712 ast_copy_string(other_local, current_channel_snapshot->base->name, size);
6713 other_local[size - 1] = ast_ends_with(current_channel_snapshot->base->name, "1") ? '2' : '1';
6714 other_local[size] = '\0';
6715
6716 other_local_snapshot = ast_channel_snapshot_get_latest_by_name(other_local);
6717 if (!other_local_snapshot) {
6718 ast_debug(5, "Unable to get other local channel snapshot\n");
6719 ao2_ref(current_channel_snapshot, -1);
6720 ao2_ref(current_channel_uid, -1);
6721 continue;
6722 }
6723
6724 if (coreshowchannelmap_add_to_map(channel_map, other_local_snapshot->base->name)) {
6725 res = 1;
6726 ao2_ref(current_channel_snapshot, -1);
6727 ao2_ref(current_channel_uid, -1);
6728 ao2_ref(other_local_snapshot, -1);
6729 break;
6730 }
6731
6732 other_bridge_snapshot = ast_bridge_get_snapshot_by_uniqueid(other_local_snapshot->bridge->id);
6733 if (other_bridge_snapshot) {
6734 res = coreshowchannelmap_add_connected_channels(channel_map, other_local_snapshot, other_bridge_snapshot);
6735 }
6736
6737 ao2_ref(current_channel_snapshot, -1);
6738 ao2_ref(current_channel_uid, -1);
6739 ao2_ref(other_local_snapshot, -1);
6740 ao2_ref(other_bridge_snapshot, -1);
6741
6742 if (res) {
6743 break;
6744 }
6745 }
6746 }
6747 ao2_iterator_destroy(&iter);
6748
6749 return res;
6750}
static int coreshowchannelmap_add_to_map(struct ao2_container *c, const char *s)
Helper function to add a channel name to the vector.
Definition manager.c:6653
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object,...
static int force_inline attribute_pure ast_ends_with(const char *str, const char *suffix)
Checks whether a string ends with another.
Definition strings.h:116
struct ao2_container * channels
Definition bridge.h:335
const ast_string_field uniqueid
const ast_string_field name

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_begins_with(), ast_bridge_get_snapshot_by_uniqueid(), ast_channel_snapshot_get_latest(), ast_channel_snapshot_get_latest_by_name(), ast_copy_string(), ast_debug, ast_ends_with(), ast_channel_snapshot::base, ast_channel_snapshot::bridge, ast_bridge_snapshot::channels, coreshowchannelmap_add_connected_channels(), coreshowchannelmap_add_to_map(), ast_channel_snapshot_bridge::id, ast_channel_snapshot_base::name, and ast_channel_snapshot_base::uniqueid.

Referenced by action_coreshowchannelmap(), and coreshowchannelmap_add_connected_channels().

◆ coreshowchannelmap_add_to_map()

static int coreshowchannelmap_add_to_map ( struct ao2_container c,
const char *  s 
)
static

Helper function to add a channel name to the vector.

Definition at line 6653 of file manager.c.

6654{
6655 char *str;
6656
6657 str = ast_strdup(s);
6658 if (!str) {
6659 ast_log(LOG_ERROR, "Unable to append channel to channel map\n");
6660 return 1;
6661 }
6662
6663 /* If this is a duplicate, it will be ignored */
6665
6666 return 0;
6667}
int ast_str_container_add(struct ao2_container *str_container, const char *add)
Adds a string to a string container allocated by ast_str_container_alloc.
Definition strings.c:205

References ast_log, ast_str_container_add(), ast_strdup, c, LOG_ERROR, and str.

Referenced by coreshowchannelmap_add_connected_channels().

◆ destroy_fast_originate_helper()

static void destroy_fast_originate_helper ( struct fast_originate_helper doomed)
static

◆ do_message()

static int do_message ( struct mansession s)
static

Definition at line 7281 of file manager.c.

7282{
7283 struct message m = { 0 };
7284 char header_buf[sizeof(s->session->inbuf)] = { '\0' };
7285 int res;
7286 int hdr_loss;
7287 time_t now;
7288
7289 hdr_loss = 0;
7290 for (;;) {
7291 /* Check if any events are pending and do them if needed */
7292 if (process_events(s)) {
7293 res = -1;
7294 break;
7295 }
7296 res = get_input(s, header_buf);
7297 if (res == 0) {
7298 /* No input line received. */
7299 if (!s->session->authenticated) {
7300 if (time(&now) == -1) {
7301 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
7302 res = -1;
7303 break;
7304 }
7305
7306 if (now - s->session->authstart > authtimeout) {
7307 if (displayconnects) {
7308 ast_verb(2, "Client from %s, failed to authenticate in %d seconds\n", ast_sockaddr_stringify_addr(&s->session->addr), authtimeout);
7309 }
7310 res = -1;
7311 break;
7312 }
7313 }
7314 continue;
7315 } else if (res > 0) {
7316 /* Input line received. */
7317 if (ast_strlen_zero(header_buf)) {
7318 if (hdr_loss) {
7319 mansession_lock(s);
7320 astman_send_error(s, &m, "Too many lines in message or allocation failure");
7322 res = 0;
7323 } else {
7324 switch (s->parsing) {
7325 case MESSAGE_OKAY:
7326 res = process_message(s, &m) ? -1 : 0;
7327 break;
7329 handle_parse_error(s, &m, "Failed to parse message: line too long");
7330 res = 0;
7331 break;
7332 }
7333 }
7334 break;
7335 } else if (m.hdrcount < ARRAY_LEN(m.headers)) {
7336 m.headers[m.hdrcount] = ast_strdup(header_buf);
7337 if (!m.headers[m.hdrcount]) {
7338 /* Allocation failure. */
7339 hdr_loss = 1;
7340 } else {
7341 ++m.hdrcount;
7342 }
7343 } else {
7344 /* Too many lines in message. */
7345 hdr_loss = 1;
7346 }
7347 } else {
7348 /* Input error. */
7349 break;
7350 }
7351 }
7352
7354
7355 return res;
7356}
static int process_message(struct mansession *s, const struct message *m)
Process an AMI message, performing desired action. Return 0 on success, -1 on error that require the ...
Definition manager.c:7032
static void astman_free_headers(struct message *m)
Free headers inside message structure, but not the message structure itself.
Definition manager.c:1673
static int displayconnects
Definition manager.c:161
static int get_input(struct mansession *s, char *output)
Definition manager.c:7160
static void handle_parse_error(struct mansession *s, struct message *m, char *error)
Definition manager.c:7264
static int process_events(struct mansession *s)
Definition manager.c:6419
static int authtimeout
Definition manager.c:170
char inbuf[1025]
Definition manager.c:294
enum mansession_message_parsing parsing
Definition manager.c:327

References mansession_session::addr, ARRAY_LEN, ast_log, ast_sockaddr_stringify_addr(), ast_strdup, ast_strlen_zero(), ast_verb, astman_free_headers(), astman_send_error(), mansession_session::authenticated, mansession_session::authstart, authtimeout, displayconnects, errno, get_input(), handle_parse_error(), message::hdrcount, message::headers, mansession_session::inbuf, LOG_ERROR, mansession_lock(), mansession_unlock(), MESSAGE_LINE_TOO_LONG, MESSAGE_OKAY, mansession::parsing, process_events(), process_message(), and mansession::session.

Referenced by session_do().

◆ event_filter_destructor()

static void event_filter_destructor ( void *  obj)
static

Definition at line 923 of file manager.c.

924{
925 struct event_filter_entry *entry = obj;
926 if (entry->regex_filter) {
927 regfree(entry->regex_filter);
928 ast_free(entry->regex_filter);
929 }
930 ast_free(entry->event_name);
931 ast_free(entry->header_name);
932 ast_free(entry->string_filter);
933}
Definition manager.c:403
char * string_filter
Definition manager.c:406
char * event_name
Definition manager.c:407
regex_t * regex_filter
Definition manager.c:405
char * header_name
Definition manager.c:409

References ast_free, event_filter_entry::event_name, event_filter_entry::header_name, event_filter_entry::regex_filter, and event_filter_entry::string_filter.

Referenced by manager_add_filter().

◆ fast_originate()

static void * fast_originate ( void *  data)
static

Definition at line 4397 of file manager.c.

4398{
4399 struct fast_originate_helper *in = data;
4400 int res;
4401 int reason = 0;
4402 struct ast_channel *chan = NULL, *chans[1];
4403 char requested_channel[AST_CHANNEL_NAME];
4404 struct ast_assigned_ids assignedids = {
4405 .uniqueid = in->channelid,
4406 .uniqueid2 = in->otherchannelid
4407 };
4408
4409 if (!ast_strlen_zero(in->app)) {
4410 res = ast_pbx_outgoing_app(in->tech, in->cap, in->data,
4411 in->timeout, in->app, in->appdata, &reason,
4413 S_OR(in->cid_num, NULL),
4414 S_OR(in->cid_name, NULL),
4415 in->vars, in->account, &chan, &assignedids);
4416 } else {
4417 res = ast_pbx_outgoing_exten(in->tech, in->cap, in->data,
4418 in->timeout, in->context, in->exten, in->priority, &reason,
4420 S_OR(in->cid_num, NULL),
4421 S_OR(in->cid_name, NULL),
4422 in->vars, in->account, &chan, in->early_media, &assignedids);
4423 }
4424
4425 if (!chan) {
4426 snprintf(requested_channel, AST_CHANNEL_NAME, "%s/%s", in->tech, in->data);
4427 }
4428 /* Tell the manager what happened with the channel */
4429 chans[0] = chan;
4430 if (!ast_strlen_zero(in->app)) {
4431 ast_manager_event_multichan(EVENT_FLAG_CALL, "OriginateResponse", chan ? 1 : 0, chans,
4432 "%s"
4433 "Response: %s\r\n"
4434 "Channel: %s\r\n"
4435 "Application: %s\r\n"
4436 "Data: %s\r\n"
4437 "Reason: %d\r\n"
4438 "Uniqueid: %s\r\n"
4439 "CallerIDNum: %s\r\n"
4440 "CallerIDName: %s\r\n",
4441 in->idtext, res ? "Failure" : "Success",
4442 chan ? ast_channel_name(chan) : requested_channel,
4443 in->app, in->appdata, reason,
4444 chan ? ast_channel_uniqueid(chan) : S_OR(in->channelid, "<unknown>"),
4445 S_OR(in->cid_num, "<unknown>"),
4446 S_OR(in->cid_name, "<unknown>")
4447 );
4448 } else {
4449 ast_manager_event_multichan(EVENT_FLAG_CALL, "OriginateResponse", chan ? 1 : 0, chans,
4450 "%s"
4451 "Response: %s\r\n"
4452 "Channel: %s\r\n"
4453 "Context: %s\r\n"
4454 "Exten: %s\r\n"
4455 "Reason: %d\r\n"
4456 "Uniqueid: %s\r\n"
4457 "CallerIDNum: %s\r\n"
4458 "CallerIDName: %s\r\n",
4459 in->idtext, res ? "Failure" : "Success",
4460 chan ? ast_channel_name(chan) : requested_channel,
4461 in->context, in->exten, reason,
4462 chan ? ast_channel_uniqueid(chan) : S_OR(in->channelid, "<unknown>"),
4463 S_OR(in->cid_num, "<unknown>"),
4464 S_OR(in->cid_name, "<unknown>")
4465 );
4466 }
4467
4468 /* Locked and ref'd by ast_pbx_outgoing_exten or ast_pbx_outgoing_app */
4469 if (chan) {
4470 ast_channel_unlock(chan);
4471 ast_channel_unref(chan);
4472 }
4474 return NULL;
4475}
const char * ast_channel_uniqueid(const struct ast_channel *chan)
#define AST_CHANNEL_NAME
Definition channel.h:173
#define ast_manager_event_multichan(category, event, nchans, chans, contents,...)
Definition manager.h:262
#define EVENT_FLAG_CALL
Definition manager.h:76
int ast_pbx_outgoing_exten(const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *context, const char *exten, int priority, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, int early_media, const struct ast_assigned_ids *assignedids)
Synchronously or asynchronously make an outbound call and send it to a particular extension.
Definition pbx.c:7960
FILE * in
Definition utils/frame.c:33

References AST_CHANNEL_NAME, ast_channel_name(), ast_channel_uniqueid(), ast_channel_unlock, ast_channel_unref, ast_manager_event_multichan, AST_OUTGOING_WAIT, ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_strlen_zero(), destroy_fast_originate_helper(), EVENT_FLAG_CALL, in, NULL, S_OR, and ast_assigned_ids::uniqueid.

Referenced by action_originate().

◆ file_in_modules_dir()

static int file_in_modules_dir ( const char *  filename)
static

Check if the given file path is in the modules dir or not.

Note
When the module is being loaded / reloaded / unloaded, the modules dir is automatically prepended
Returns
1 if inside modules dir
0 if outside modules dir
-1 on failure

Definition at line 6886 of file manager.c.

6887{
6888 char *stripped_filename;
6889 RAII_VAR(char *, path, NULL, ast_free);
6890 RAII_VAR(char *, real_path, NULL, ast_free);
6891
6892 /* Don't bother checking */
6893 if (live_dangerously) {
6894 return 1;
6895 }
6896
6897 stripped_filename = ast_strip(ast_strdupa(filename));
6898
6899 /* Always prepend the modules dir since that is what the code does for ModuleLoad */
6900 if (ast_asprintf(&path, "%s/%s", ast_config_AST_MODULE_DIR, stripped_filename) == -1) {
6901 return -1;
6902 }
6903
6904 real_path = realpath(path, NULL);
6905 if (!real_path) {
6906 return -1;
6907 }
6908
6909 return ast_begins_with(real_path, ast_config_AST_MODULE_DIR);
6910}
const char * ast_config_AST_MODULE_DIR
Definition options.c:154

References ast_asprintf, ast_begins_with(), ast_config_AST_MODULE_DIR, ast_free, ast_strdupa, ast_strip(), live_dangerously, NULL, and RAII_VAR.

Referenced by manager_moduleload().

◆ filter_cmp_fn()

static int filter_cmp_fn ( void *  obj,
void *  arg,
void *  data,
int  flags 
)
static

Definition at line 5601 of file manager.c.

5602{
5603 struct eventqent *eqe = arg;
5604 struct event_filter_entry *filter_entry = obj;
5605 char *line_buffer_start = NULL;
5606 char *line_buffer = NULL;
5607 char *line = NULL;
5608 int match = 0;
5609 int *result = data;
5610
5611 if (filter_entry->event_name_hash) {
5612 if (eqe->event_name_hash != filter_entry->event_name_hash) {
5613 goto done;
5614 }
5615 }
5616
5617 /* We're looking at the entire event data */
5618 if (!filter_entry->header_name) {
5619 match = match_eventdata(filter_entry, eqe->eventdata);
5620 goto done;
5621 }
5622
5623 /* We're looking at a specific header */
5624 line_buffer_start = ast_strdup(eqe->eventdata);
5625 line_buffer = line_buffer_start;
5626 if (!line_buffer_start) {
5627 goto done;
5628 }
5629
5630 while ((line = ast_read_line_from_buffer(&line_buffer))) {
5631 if (ast_begins_with(line, filter_entry->header_name)) {
5632 line += strlen(filter_entry->header_name);
5633 line = ast_skip_blanks(line);
5634 if (ast_strlen_zero(line)) {
5635 continue;
5636 }
5637 match = match_eventdata(filter_entry, line);
5638 if (match) {
5639 ast_free(line_buffer_start);
5640 line_buffer_start = NULL;
5641 break;
5642 }
5643 }
5644 }
5645
5646 ast_free(line_buffer_start);
5647
5648done:
5649
5650 *result = match;
5651 return match ? CMP_MATCH | CMP_STOP : 0;
5652}
@ CMP_MATCH
Definition astobj2.h:1027
@ CMP_STOP
Definition astobj2.h:1028
static int match_eventdata(struct event_filter_entry *entry, const char *eventdata)
Test eventdata against a filter entry.
Definition manager.c:5581
char * ast_read_line_from_buffer(char **buffer)
Read lines from a string buffer.
Definition strings.c:385
unsigned int event_name_hash
Definition manager.c:408
int done

References ast_begins_with(), ast_free, ast_read_line_from_buffer(), ast_skip_blanks(), ast_strdup, ast_strlen_zero(), CMP_MATCH, CMP_STOP, done, eventqent::event_name_hash, event_filter_entry::event_name_hash, eventqent::eventdata, event_filter_entry::header_name, match(), match_eventdata(), NULL, and result.

Referenced by should_send_event().

◆ function_capable_string_allowed_with_auths()

static int function_capable_string_allowed_with_auths ( const char *  evaluating,
int  writepermlist 
)
static

Checks to see if a string which can be used to evaluate functions should be rejected.

Definition at line 777 of file manager.c.

778{
779 if (!(writepermlist & EVENT_FLAG_SYSTEM)
780 && (
781 strstr(evaluating, "SHELL") || /* NoOp(${SHELL(rm -rf /)}) */
782 strstr(evaluating, "EVAL") /* NoOp(${EVAL(${some_var_containing_SHELL})}) */
783 )) {
784 return 0;
785 }
786 return 1;
787}

References EVENT_FLAG_SYSTEM.

Referenced by action_getvar(), and action_status().

◆ generate_status()

static void generate_status ( struct mansession s,
struct ast_channel chan,
char **  vars,
int  varc,
int  all_variables,
char *  id_text,
int *  count 
)
static

Definition at line 3639 of file manager.c.

3640{
3641 struct timeval now;
3642 long elapsed_seconds;
3643 struct ast_bridge *bridge;
3644 RAII_VAR(struct ast_str *, variable_str, NULL, ast_free);
3645 struct ast_str *write_transpath = ast_str_alloca(256);
3646 struct ast_str *read_transpath = ast_str_alloca(256);
3647 struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
3648 struct ast_party_id effective_id;
3649 int i;
3650 RAII_VAR(struct ast_channel_snapshot *, snapshot,
3652 ao2_cleanup);
3653 RAII_VAR(struct ast_str *, snapshot_str, NULL, ast_free);
3654
3655 if (!snapshot) {
3656 return;
3657 }
3658
3659 snapshot_str = ast_manager_build_channel_state_string(snapshot);
3660 if (!snapshot_str) {
3661 return;
3662 }
3663
3664 if (all_variables) {
3665 variable_str = ast_str_create(2048);
3666 } else {
3667 variable_str = ast_str_create(1024);
3668 }
3669 if (!variable_str) {
3670 return;
3671 }
3672
3673 now = ast_tvnow();
3674 elapsed_seconds = ast_tvdiff_sec(now, ast_channel_creationtime(chan));
3675
3676 /* Even if all_variables has been specified, explicitly requested variables
3677 * may be global variables or dialplan functions */
3678 for (i = 0; i < varc; i++) {
3679 char valbuf[512], *ret = NULL;
3680
3681 if (vars[i][strlen(vars[i]) - 1] == ')') {
3682 if (ast_func_read(chan, vars[i], valbuf, sizeof(valbuf)) < 0) {
3683 valbuf[0] = '\0';
3684 }
3685 ret = valbuf;
3686 } else {
3687 pbx_retrieve_variable(chan, vars[i], &ret, valbuf, sizeof(valbuf), NULL);
3688 }
3689
3690 ast_str_append(&variable_str, 0, "Variable: %s=%s\r\n", vars[i], ret);
3691 }
3692
3693 /* Walk all channel variables and add them */
3694 if (all_variables) {
3695 struct ast_var_t *variables;
3696
3698 ast_str_append(&variable_str, 0, "Variable: %s=%s\r\n",
3699 ast_var_name(variables), ast_var_value(variables));
3700 }
3701 }
3702
3703 bridge = ast_channel_get_bridge(chan);
3704 effective_id = ast_channel_connected_effective_id(chan);
3705
3706 astman_append(s,
3707 "Event: Status\r\n"
3708 "Privilege: Call\r\n"
3709 "%s"
3710 "Type: %s\r\n"
3711 "DNID: %s\r\n"
3712 "EffectiveConnectedLineNum: %s\r\n"
3713 "EffectiveConnectedLineName: %s\r\n"
3714 "TimeToHangup: %ld\r\n"
3715 "BridgeID: %s\r\n"
3716 "Application: %s\r\n"
3717 "Data: %s\r\n"
3718 "Nativeformats: %s\r\n"
3719 "Readformat: %s\r\n"
3720 "Readtrans: %s\r\n"
3721 "Writeformat: %s\r\n"
3722 "Writetrans: %s\r\n"
3723 "Callgroup: %llu\r\n"
3724 "Pickupgroup: %llu\r\n"
3725 "Seconds: %ld\r\n"
3726 "%s"
3727 "%s"
3728 "\r\n",
3729 ast_str_buffer(snapshot_str),
3730 ast_channel_tech(chan)->type,
3731 S_OR(ast_channel_dialed(chan)->number.str, ""),
3732 S_COR(effective_id.number.valid, effective_id.number.str, "<unknown>"),
3733 S_COR(effective_id.name.valid, effective_id.name.str, "<unknown>"),
3734 (long)ast_channel_whentohangup(chan)->tv_sec,
3735 bridge ? bridge->uniqueid : "",
3736 ast_channel_appl(chan),
3737 ast_channel_data(chan),
3740 ast_translate_path_to_str(ast_channel_readtrans(chan), &read_transpath),
3742 ast_translate_path_to_str(ast_channel_writetrans(chan), &write_transpath),
3745 (long)elapsed_seconds,
3746 ast_str_buffer(variable_str),
3747 id_text);
3748 ++*count;
3749
3750 ao2_cleanup(bridge);
3751}
const char * ast_channel_data(const struct ast_channel *chan)
struct varshead * ast_channel_varshead(struct ast_channel *chan)
struct ast_trans_pvt * ast_channel_readtrans(const struct ast_channel *chan)
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
struct ast_trans_pvt * ast_channel_writetrans(const struct ast_channel *chan)
ast_group_t ast_channel_pickupgroup(const struct ast_channel *chan)
const char * ast_channel_appl(const struct ast_channel *chan)
struct timeval ast_channel_creationtime(struct ast_channel *chan)
struct ast_bridge * ast_channel_get_bridge(const struct ast_channel *chan)
Get the bridge associated with a channel.
Definition channel.c:10622
struct ast_party_dialed * ast_channel_dialed(struct ast_channel *chan)
struct timeval * ast_channel_whentohangup(struct ast_channel *chan)
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)
ast_group_t ast_channel_callgroup(const struct ast_channel *chan)
struct ast_party_id ast_channel_connected_effective_id(struct ast_channel *chan)
struct ast_format * ast_channel_readformat(struct ast_channel *chan)
const char * ast_var_name(const struct ast_var_t *var)
Definition chanvars.c:60
const char * ast_var_value(const struct ast_var_t *var)
Definition chanvars.c:80
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition format.c:334
#define AST_FORMAT_CAP_NAMES_LEN
Definition format_cap.h:324
const char * ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf)
Get the names of codecs of a set of formats.
Definition format_cap.c:734
struct ast_str * ast_manager_build_channel_state_string(const struct ast_channel_snapshot *snapshot)
Generate the AMI message body from a channel snapshot.
Structure that contains information about a bridge.
Definition bridge.h:353
const ast_string_field uniqueid
Definition bridge.h:405
Structure to describe a channel "technology", ie a channel driver See for examples:
Definition channel.h:648
Information needed to identify an endpoint in a call.
Definition channel.h:340
Number structure.
int64_t ast_tvdiff_sec(struct timeval end, struct timeval start)
Computes the difference (in seconds) between two struct timeval instances.
Definition time.h:73
const char * ast_translate_path_to_str(struct ast_trans_pvt *t, struct ast_str **str)
Puts a string representation of the translation path into outbuf.
Definition translate.c:930

References ao2_cleanup, ast_channel_appl(), ast_channel_callgroup(), ast_channel_connected_effective_id(), ast_channel_creationtime(), ast_channel_data(), ast_channel_dialed(), ast_channel_get_bridge(), ast_channel_nativeformats(), ast_channel_pickupgroup(), ast_channel_readformat(), ast_channel_readtrans(), ast_channel_snapshot_get_latest(), ast_channel_uniqueid(), ast_channel_varshead(), ast_channel_whentohangup(), ast_channel_writeformat(), ast_channel_writetrans(), ast_format_cap_get_names(), AST_FORMAT_CAP_NAMES_LEN, ast_format_get_name(), ast_free, ast_func_read(), AST_LIST_TRAVERSE, ast_manager_build_channel_state_string(), ast_str_alloca, ast_str_append(), ast_str_buffer(), ast_str_create, ast_translate_path_to_str(), ast_tvdiff_sec(), ast_tvnow(), ast_var_name(), ast_var_value(), astman_append(), ast_party_id::name, NULL, ast_party_id::number, pbx_retrieve_variable(), RAII_VAR, S_COR, S_OR, ast_party_name::str, ast_party_number::str, type, ast_bridge::uniqueid, ast_party_name::valid, and ast_party_number::valid.

Referenced by action_status().

◆ get_input()

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

Read one full line (including crlf) from the manager socket.

Note
* \r\n is the only valid terminator for the line.
* (Note that, later, '\0' will be considered as the end-of-line marker,
* so everything between the '\0' and the '\r\n' will not be used).
* Also note that we assume output to have at least "maxlen" space.
* 

Definition at line 7160 of file manager.c.

7161{
7162 int res, x;
7163 int maxlen = sizeof(s->session->inbuf) - 1;
7164 char *src = s->session->inbuf;
7165 int timeout = -1;
7166 time_t now;
7167
7168 /*
7169 * Look for \r\n within the buffer. If found, copy to the output
7170 * buffer and return, trimming the \r\n (not used afterwards).
7171 */
7172 for (x = 0; x < s->session->inlen; x++) {
7173 int cr; /* set if we have \r */
7174 if (src[x] == '\r' && x+1 < s->session->inlen && src[x + 1] == '\n') {
7175 cr = 2; /* Found. Update length to include \r\n */
7176 } else if (src[x] == '\n') {
7177 cr = 1; /* also accept \n only */
7178 } else {
7179 continue;
7180 }
7181 memmove(output, src, x); /*... but trim \r\n */
7182 output[x] = '\0'; /* terminate the string */
7183 x += cr; /* number of bytes used */
7184 s->session->inlen -= x; /* remaining size */
7185 memmove(src, src + x, s->session->inlen); /* remove used bytes */
7186 return 1;
7187 }
7188 if (s->session->inlen >= maxlen) {
7189 /* no crlf found, and buffer full - sorry, too long for us
7190 * keep the last character in case we are in the middle of a CRLF. */
7191 ast_log(LOG_WARNING, "Discarding message from %s. Line too long: %.25s...\n", ast_sockaddr_stringify_addr(&s->session->addr), src);
7192 src[0] = src[s->session->inlen - 1];
7193 s->session->inlen = 1;
7195 }
7196 res = 0;
7197 while (res == 0) {
7198 /* calculate a timeout if we are not authenticated */
7199 if (!s->session->authenticated) {
7200 if(time(&now) == -1) {
7201 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
7202 return -1;
7203 }
7204
7205 timeout = (authtimeout - (now - s->session->authstart)) * 1000;
7206 if (timeout < 0) {
7207 /* we have timed out */
7208 return 0;
7209 }
7210 }
7211
7213 if (s->session->pending_event) {
7214 s->session->pending_event = 0;
7216 return 0;
7217 }
7218 s->session->waiting_thread = pthread_self();
7220
7222
7226 }
7227 if (res < 0) {
7228 if (s->session->kicked) {
7229 ast_debug(1, "Manager session has been kicked\n");
7230 return -1;
7231 }
7232 /* If we get a signal from some other thread (typically because
7233 * there are new events queued), return 0 to notify the caller.
7234 */
7235 if (errno == EINTR || errno == EAGAIN) {
7236 return 0;
7237 }
7238 ast_log(LOG_WARNING, "poll() returned error: %s\n", strerror(errno));
7239 return -1;
7240 }
7241
7242 ao2_lock(s->session);
7243 res = ast_iostream_read(s->session->stream, src + s->session->inlen, maxlen - s->session->inlen);
7244 if (res < 1) {
7245 res = -1; /* error return */
7246 } else {
7247 s->session->inlen += res;
7248 src[s->session->inlen] = '\0';
7249 res = 0;
7250 }
7251 ao2_unlock(s->session);
7252 return res;
7253}
ssize_t ast_iostream_read(struct ast_iostream *stream, void *buffer, size_t count)
Read data from an iostream.
Definition iostream.c:284
unsigned int kicked
Definition manager.c:307

References mansession_session::addr, ao2_lock, ao2_unlock, ast_debug, ast_iostream_get_fd(), ast_iostream_read(), ast_log, ast_mutex_lock, ast_mutex_unlock, AST_PTHREADT_NULL, ast_sockaddr_stringify_addr(), ast_wait_for_input(), mansession_session::authenticated, mansession_session::authstart, authtimeout, errno, mansession_session::inbuf, mansession_session::inlen, mansession_session::kicked, LOG_ERROR, LOG_WARNING, MESSAGE_LINE_TOO_LONG, mansession_session::notify_lock, mansession::parsing, mansession_session::pending_event, mansession::session, mansession_session::stream, and mansession_session::waiting_thread.

Referenced by do_message().

◆ get_manager_by_name_locked()

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

1043{
1044 struct ast_manager_user *user = NULL;
1045
1047 if (!strcasecmp(user->username, name)) {
1048 break;
1049 }
1050 }
1051
1052 return user;
1053}
struct ast_manager_user::@399 list

References AST_RWLIST_TRAVERSE, ast_manager_user::list, name, and NULL.

Referenced by __init_manager(), auth_http_callback(), authenticate(), function_amiclient(), handle_showmanager(), manager_displayconnects(), and process_message().

◆ get_perm()

static int get_perm ( const char *  instr)
static

Definition at line 862 of file manager.c.

863{
864 int x = 0, ret = 0;
865
866 if (!instr) {
867 return 0;
868 }
869
870 for (x = 0; x < ARRAY_LEN(perms); x++) {
871 if (ast_instring(instr, perms[x].label, ',')) {
872 ret |= perms[x].num;
873 }
874 }
875
876 return ret;
877}
static int ast_instring(const char *bigstr, const char *smallstr, const char delim)
Definition manager.c:843

References ARRAY_LEN, ast_instring(), permalias::num, and perms.

Referenced by __init_manager(), and strings_to_mask().

◆ grab_last()

static struct eventqent * grab_last ( void  )
static

Grab a reference to the last event, update usecount as needed. Can handle a NULL pointer.

Definition at line 694 of file manager.c.

695{
696 struct eventqent *ret;
697
700 /* the list is never empty now, but may become so when
701 * we optimize it in the future, so be prepared.
702 */
703 if (ret) {
705 }
707 return ret;
708}
#define AST_RWLIST_LAST

References ast_atomic_fetchadd_int(), AST_RWLIST_LAST, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and eventqent::usecount.

Referenced by auth_http_callback(), generic_http_callback(), and session_do().

◆ handle_kickmanconn()

static char * handle_kickmanconn ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager kick session.

Definition at line 1414 of file manager.c.

1415{
1416 struct ao2_container *sessions;
1418 struct ao2_iterator i;
1419 int fd = -1;
1420 int found = 0;
1421
1422 switch (cmd) {
1423 case CLI_INIT:
1424 e->command = "manager kick session";
1425 e->usage =
1426 "Usage: manager kick session <file descriptor>\n"
1427 " Kick an active Asterisk Manager Interface session\n";
1428 return NULL;
1429 case CLI_GENERATE:
1430 return NULL;
1431 }
1432
1433 if (a->argc != 4) {
1434 return CLI_SHOWUSAGE;
1435 }
1436
1437 fd = atoi(a->argv[3]);
1438 if (fd <= 0) { /* STDOUT won't be a valid AMI fd either */
1439 ast_cli(a->fd, "Invalid AMI file descriptor: %s\n", a->argv[3]);
1440 return CLI_FAILURE;
1441 }
1442
1443 sessions = ao2_global_obj_ref(mgr_sessions);
1444 if (sessions) {
1446 ao2_ref(sessions, -1);
1447 while ((session = ao2_iterator_next(&i))) {
1449 if (session->stream) {
1450 if (ast_iostream_get_fd(session->stream) == fd) {
1451 if (session->kicked) {
1452 ast_cli(a->fd, "Manager session using file descriptor %d has already been kicked\n", fd);
1455 break;
1456 }
1457 fd = ast_iostream_get_fd(session->stream);
1458 found = fd;
1459 ast_cli(a->fd, "Kicking manager session connected using file descriptor %d\n", fd);
1460 ast_mutex_lock(&session->notify_lock);
1461 session->kicked = 1;
1462 if (session->waiting_thread != AST_PTHREADT_NULL) {
1463 pthread_kill(session->waiting_thread, SIGURG);
1464 }
1465 ast_mutex_unlock(&session->notify_lock);
1468 break;
1469 }
1470 }
1473 }
1475 }
1476
1477 if (!found) {
1478 ast_cli(a->fd, "No manager session found using file descriptor %d\n", fd);
1479 }
1480 return CLI_SUCCESS;
1481}
#define CLI_SHOWUSAGE
Definition cli.h:45
#define CLI_SUCCESS
Definition cli.h:44
void ast_cli(int fd, const char *fmt,...)
Definition clicompat.c:6
@ CLI_INIT
Definition cli.h:152
@ CLI_GENERATE
Definition cli.h:153
#define CLI_FAILURE
Definition cli.h:46
char * command
Definition cli.h:186
const char * usage
Definition cli.h:177
static struct test_val a

References a, ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_cli(), ast_iostream_get_fd(), ast_mutex_lock, ast_mutex_unlock, AST_PTHREADT_NULL, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, session, sessions, unref_mansession(), and ast_cli_entry::usage.

◆ handle_manager_reload()

static char * handle_manager_reload ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager reload.

Definition at line 1563 of file manager.c.

1564{
1565 switch (cmd) {
1566 case CLI_INIT:
1567 e->command = "manager reload";
1568 e->usage =
1569 "Usage: manager reload\n"
1570 " Reloads the manager configuration.\n";
1571 return NULL;
1572 case CLI_GENERATE:
1573 return NULL;
1574 }
1575 if (a->argc > 2) {
1576 return CLI_SHOWUSAGE;
1577 }
1578 reload_module();
1579 return CLI_SUCCESS;
1580}
static int reload_module(void)
Definition manager.c:10104

References a, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, reload_module(), and ast_cli_entry::usage.

◆ handle_mandebug()

static char * handle_mandebug ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 1231 of file manager.c.

1232{
1233 switch (cmd) {
1234 case CLI_INIT:
1235 e->command = "manager set debug [on|off]";
1236 e->usage = "Usage: manager set debug [on|off]\n Show, enable, disable debugging of the manager code.\n";
1237 return NULL;
1238 case CLI_GENERATE:
1239 return NULL;
1240 }
1241
1242 if (a->argc == 3) {
1243 ast_cli(a->fd, "manager debug is %s\n", manager_debug? "on" : "off");
1244 } else if (a->argc == 4) {
1245 if (!strcasecmp(a->argv[3], "on")) {
1246 manager_debug = 1;
1247 } else if (!strcasecmp(a->argv[3], "off")) {
1248 manager_debug = 0;
1249 } else {
1250 return CLI_SHOWUSAGE;
1251 }
1252 }
1253 return CLI_SUCCESS;
1254}

References a, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, manager_debug, NULL, and ast_cli_entry::usage.

◆ handle_parse_error()

static void handle_parse_error ( struct mansession s,
struct message m,
char *  error 
)
static

Definition at line 7264 of file manager.c.

7265{
7266 mansession_lock(s);
7267 astman_send_error(s, m, error);
7268 s->parsing = MESSAGE_OKAY;
7270}

References astman_send_error(), error(), mansession_lock(), mansession_unlock(), MESSAGE_OKAY, and mansession::parsing.

Referenced by do_message().

◆ handle_showmanager()

static char * handle_showmanager ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 1256 of file manager.c.

1257{
1258 struct ast_manager_user *user = NULL;
1259 int l;
1260 struct ast_str *rauthority = ast_str_alloca(MAX_AUTH_PERM_STRING);
1261 struct ast_str *wauthority = ast_str_alloca(MAX_AUTH_PERM_STRING);
1262 struct ast_variable *v;
1263
1264 switch (cmd) {
1265 case CLI_INIT:
1266 e->command = "manager show user";
1267 e->usage =
1268 " Usage: manager show user <user>\n"
1269 " Display all information related to the manager user specified.\n";
1270 return NULL;
1271 case CLI_GENERATE:
1272 l = strlen(a->word);
1273 if (a->pos != 3) {
1274 return NULL;
1275 }
1277 AST_RWLIST_TRAVERSE(&users, user, list) {
1278 if (!strncasecmp(a->word, user->username, l)) {
1279 if (ast_cli_completion_add(ast_strdup(user->username))) {
1280 break;
1281 }
1282 }
1283 }
1285 return NULL;
1286 }
1287
1288 if (a->argc != 4) {
1289 return CLI_SHOWUSAGE;
1290 }
1291
1293
1294 if (!(user = get_manager_by_name_locked(a->argv[3]))) {
1295 ast_cli(a->fd, "There is no manager called %s\n", a->argv[3]);
1297 return CLI_SUCCESS;
1298 }
1299
1300 ast_cli(a->fd, "\n");
1301 ast_cli(a->fd,
1302 " username: %s\n"
1303 " secret: %s\n"
1304 " ACL: %s\n"
1305 " read perm: %s\n"
1306 " write perm: %s\n"
1307 " displayconnects: %s\n"
1308 "allowmultiplelogin: %s\n",
1309 S_OR(user->username, "(N/A)"),
1310 (user->secret ? "<Set>" : "(N/A)"),
1311 ((user->acl && !ast_acl_list_is_empty(user->acl)) ? "yes" : "no"),
1312 user_authority_to_str(user->readperm, &rauthority),
1313 user_authority_to_str(user->writeperm, &wauthority),
1314 (user->displayconnects ? "yes" : "no"),
1315 (user->allowmultiplelogin ? "yes" : "no"));
1316 ast_cli(a->fd, " Variables: \n");
1317 for (v = user->chanvars ; v ; v = v->next) {
1318 ast_cli(a->fd, " %s = %s\n", v->name, v->value);
1319 }
1320 if (!ast_acl_list_is_empty(user->acl)) {
1321 ast_acl_output(a->fd, user->acl, NULL);
1322 }
1323
1325
1326 return CLI_SUCCESS;
1327}
void ast_acl_output(int fd, struct ast_acl_list *acl, const char *prefix)
output an ACL to the provided fd
Definition acl.c:1115
int ast_acl_list_is_empty(struct ast_acl_list *acl_list)
Determines if an ACL is empty or if it contains entries.
Definition acl.c:540
int ast_cli_completion_add(char *value)
Add a result to a request for completion options.
Definition main/cli.c:2845
static const char * user_authority_to_str(int authority, struct ast_str **res)
Convert authority code to a list of options for a user. This will only display those authority codes ...
Definition manager.c:791
static int allowmultiplelogin
Definition manager.c:162

References a, ast_acl_list_is_empty(), ast_acl_output(), ast_cli(), ast_cli_completion_add(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_str_alloca, ast_strdup, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, get_manager_by_name_locked(), MAX_AUTH_PERM_STRING, ast_variable::name, ast_variable::next, NULL, S_OR, ast_cli_entry::usage, user_authority_to_str(), and ast_variable::value.

◆ handle_showmanagers()

static char * handle_showmanagers ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 1329 of file manager.c.

1330{
1331 struct ast_manager_user *user = NULL;
1332 int count_amu = 0;
1333 switch (cmd) {
1334 case CLI_INIT:
1335 e->command = "manager show users";
1336 e->usage =
1337 "Usage: manager show users\n"
1338 " Prints a listing of all managers that are currently configured on that\n"
1339 " system.\n";
1340 return NULL;
1341 case CLI_GENERATE:
1342 return NULL;
1343 }
1344 if (a->argc != 3) {
1345 return CLI_SHOWUSAGE;
1346 }
1347
1349
1350 /* If there are no users, print out something along those lines */
1351 if (AST_RWLIST_EMPTY(&users)) {
1352 ast_cli(a->fd, "There are no manager users.\n");
1354 return CLI_SUCCESS;
1355 }
1356
1357 ast_cli(a->fd, "\nusername\n--------\n");
1358
1360 ast_cli(a->fd, "%s\n", user->username);
1361 count_amu++;
1362 }
1363
1365
1366 ast_cli(a->fd,"-------------------\n"
1367 "%d manager users configured.\n", count_amu);
1368 return CLI_SUCCESS;
1369}

References a, ast_cli(), AST_RWLIST_EMPTY, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ast_manager_user::list, NULL, and ast_cli_entry::usage.

◆ handle_showmancmd()

static char * handle_showmancmd ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 1077 of file manager.c.

1078{
1079 struct manager_action *cur;
1080 struct ast_str *authority;
1081 int num;
1082 int l;
1083 const char *auth_str;
1084
1085 switch (cmd) {
1086 case CLI_INIT:
1087 e->command = "manager show command";
1088 e->usage =
1089 "Usage: manager show command <actionname> [<actionname> [<actionname> [...]]]\n"
1090 " Shows the detailed description for a specific Asterisk manager interface command.\n";
1091 return NULL;
1092 case CLI_GENERATE:
1093 l = strlen(a->word);
1095 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1096 if (!strncasecmp(a->word, cur->action, l)) {
1098 break;
1099 }
1100 }
1101 }
1103 return NULL;
1104 }
1105 if (a->argc < 4) {
1106 return CLI_SHOWUSAGE;
1107 }
1108
1110
1112 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1113 for (num = 3; num < a->argc; num++) {
1114 if (!strcasecmp(cur->action, a->argv[num])) {
1115 auth_str = authority_to_str(cur->authority, &authority);
1116
1117#ifdef AST_XML_DOCS
1118 if (cur->docsrc == AST_XML_DOC) {
1119 char *synopsis = ast_xmldoc_printable(S_OR(cur->synopsis, "Not available"), 1);
1120 char *provided_by = ast_xmldoc_printable(S_OR(cur->provided_by, "Not available"), 1);
1121 char *since = ast_xmldoc_printable(S_OR(cur->since, "Not available"), 1);
1122 char *description = ast_xmldoc_printable(S_OR(cur->description, "Not available"), 1);
1123 char *syntax = ast_xmldoc_printable(S_OR(cur->syntax, "Not available"), 1);
1124 char *arguments = ast_xmldoc_printable(S_OR(cur->arguments, "Not available"), 1);
1125 char *privilege = ast_xmldoc_printable(S_OR(auth_str, "Not available"), 1);
1126 char *seealso = ast_xmldoc_printable(S_OR(cur->seealso, "Not available"), 1);
1127 char *responses = ast_xmldoc_printable("None", 1);
1128
1129 if (!synopsis || !provided_by || !since || !description || !syntax || !arguments
1130 || !privilege || !seealso || !responses) {
1132 ast_free(provided_by);
1133 ast_free(since);
1134 ast_free(description);
1135 ast_free(syntax);
1136 ast_free(arguments);
1137 ast_free(privilege);
1138 ast_free(seealso);
1139 ast_free(responses);
1140 ast_cli(a->fd, "Allocation failure.\n");
1142
1143 return CLI_FAILURE;
1144 }
1145
1146 ast_cli(a->fd, "\n"
1147 "%s -= Info about Manager Command '%s' =- %s\n\n"
1148 COLORIZE_FMT "\n"
1149 "%s\n\n"
1150 COLORIZE_FMT "\n"
1151 "%s\n\n"
1152 COLORIZE_FMT "\n"
1153 "%s\n\n"
1154 COLORIZE_FMT "\n"
1155 "%s\n\n"
1156 COLORIZE_FMT "\n"
1157 "%s\n\n"
1158 COLORIZE_FMT "\n"
1159 "%s\n\n"
1160 COLORIZE_FMT "\n"
1161 "%s\n\n"
1162 COLORIZE_FMT "\n"
1163 "%s\n\n"
1164 COLORIZE_FMT "\n",
1166 COLORIZE(COLOR_MAGENTA, 0, "[Synopsis]"), synopsis,
1167 COLORIZE(COLOR_MAGENTA, 0, "[Provided By]"), provided_by,
1168 COLORIZE(COLOR_MAGENTA, 0, "[Since]"), since,
1169 COLORIZE(COLOR_MAGENTA, 0, "[Description]"), description,
1170 COLORIZE(COLOR_MAGENTA, 0, "[Syntax]"), syntax,
1171 COLORIZE(COLOR_MAGENTA, 0, "[Arguments]"), arguments,
1172 COLORIZE(COLOR_MAGENTA, 0, "[Privilege]"), privilege,
1173 COLORIZE(COLOR_MAGENTA, 0, "[See Also]"), seealso,
1174 COLORIZE(COLOR_MAGENTA, 0, "[List Responses]")
1175 );
1176
1177 if (!cur->list_responses) {
1178 ast_cli(a->fd, "%s\n\n", responses);
1179 } else {
1180 struct ast_xml_doc_item *temp;
1181 for (temp = cur->list_responses; temp; temp = AST_LIST_NEXT(temp, next)) {
1182 ast_cli(a->fd, "Event: %s\n", temp->name);
1183 print_event_instance(a, temp);
1184 }
1185 }
1186 ast_cli(a->fd,
1187 COLORIZE_FMT "\n",
1188 COLORIZE(COLOR_MAGENTA, 0, "[End List Responses]")
1189 );
1190
1191 ast_cli(a->fd, "\n"
1192 COLORIZE_FMT "\n",
1193 COLORIZE(COLOR_MAGENTA, 0, "[Final Response]")
1194 );
1195 if (!cur->final_response) {
1196 ast_cli(a->fd, "%s\n\n", responses);
1197 } else {
1198 ast_cli(a->fd, "Event: %s\n", cur->final_response->name);
1200 }
1201 ast_cli(a->fd,
1202 COLORIZE_FMT "\n",
1203 COLORIZE(COLOR_MAGENTA, 0, "[End Final Response]")
1204 );
1205
1208 ast_free(since);
1212 ast_free(privilege);
1214 ast_free(responses);
1215 } else
1216#endif
1217 {
1218 ast_cli(a->fd, "Action: %s\nSynopsis: %s\nPrivilege: %s\n%s\n",
1219 cur->action, cur->synopsis,
1220 auth_str,
1221 S_OR(cur->description, ""));
1222 }
1223 }
1224 }
1225 }
1227
1228 return CLI_SUCCESS;
1229}
static void print_event_instance(struct ast_cli_args *a, struct ast_xml_doc_item *instance)
Definition manager.c:9286
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Struct that contains the XML documentation for a particular item. Note that this is an ao2 ref counte...
Definition xmldoc.h:56
struct ast_str * syntax
Definition xmldoc.h:58
struct ast_str * provided_by
Definition xmldoc.h:84
struct ast_xml_doc_item * next
Definition xmldoc.h:80
struct ast_str * arguments
Definition xmldoc.h:62
struct ast_str * since
Definition xmldoc.h:82
struct ast_str * description
Definition xmldoc.h:66
const ast_string_field name
Definition xmldoc.h:74
struct ast_str * seealso
Definition xmldoc.h:60
const char * ast_term_reset(void)
Returns the terminal reset code.
Definition term.c:357
#define COLOR_MAGENTA
Definition term.h:60
const char * ast_term_color(int fgcolor, int bgcolor)
Return a color sequence string.
Definition term.c:341
#define COLORIZE(fg, bg, str)
Definition term.h:72
#define COLORIZE_FMT
Shortcut macros for coloring a set of text.
Definition term.h:71
char * ast_xmldoc_printable(const char *bwinput, int withcolors)
Colorize and put delimiters (instead of tags) to the xmldoc output.
Definition xmldoc.c:241

References a, manager_action::action, manager_action::arguments, ast_xml_doc_item::arguments, ast_cli(), ast_cli_completion_add(), ast_free, AST_LIST_NEXT, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_str_alloca, ast_strdup, ast_term_color(), ast_term_reset(), AST_XML_DOC, ast_xmldoc_printable(), manager_action::authority, authority_to_str(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, COLOR_MAGENTA, COLORIZE, COLORIZE_FMT, ast_cli_entry::command, manager_action::description, ast_xml_doc_item::description, manager_action::docsrc, manager_action::final_response, manager_action::list_responses, MAX_AUTH_PERM_STRING, ast_xml_doc_item::name, ast_xml_doc_item::next, NULL, print_event_instance(), ast_xml_doc_item::provided_by, S_OR, manager_action::seealso, ast_xml_doc_item::seealso, ast_xml_doc_item::since, synopsis, manager_action::synopsis, manager_action::syntax, ast_xml_doc_item::syntax, and ast_cli_entry::usage.

◆ handle_showmancmds()

static char * handle_showmancmds ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager list commands.

Definition at line 1372 of file manager.c.

1373{
1374 struct manager_action *cur;
1375 int name_len = 1;
1376 int space_remaining;
1377#define HSMC_FORMAT " %-*.*s %-.*s\n"
1378 switch (cmd) {
1379 case CLI_INIT:
1380 e->command = "manager show commands";
1381 e->usage =
1382 "Usage: manager show commands\n"
1383 " Prints a listing of all the available Asterisk manager interface commands.\n";
1384 return NULL;
1385 case CLI_GENERATE:
1386 return NULL;
1387 }
1388
1391 int incoming_len = strlen(cur->action);
1392 if (incoming_len > name_len) {
1393 name_len = incoming_len;
1394 }
1395 }
1396
1397 space_remaining = MGR_SHOW_TERMINAL_WIDTH - name_len - 4;
1398 if (space_remaining < 0) {
1399 space_remaining = 0;
1400 }
1401
1402 ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, "Action", space_remaining, "Synopsis");
1403 ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, "------", space_remaining, "--------");
1404
1406 ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, cur->action, space_remaining, cur->synopsis);
1407 }
1409
1410 return CLI_SUCCESS;
1411}
#define MGR_SHOW_TERMINAL_WIDTH
Definition manager.c:203
#define HSMC_FORMAT

References a, manager_action::action, ast_cli(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, HSMC_FORMAT, manager_action::list, MGR_SHOW_TERMINAL_WIDTH, NULL, manager_action::synopsis, and ast_cli_entry::usage.

◆ handle_showmanconn()

static char * handle_showmanconn ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager list connected.

Definition at line 1484 of file manager.c.

1485{
1486 struct ao2_container *sessions;
1488 time_t now = time(NULL);
1489#define HSMCONN_FORMAT1 " %-15.15s %-55.55s %-10.10s %-10.10s %-8.8s %-8.8s %-10.10s %-10.10s\n"
1490#define HSMCONN_FORMAT2 " %-15.15s %-55.55s %-10d %-10d %-8d %-8d %-10.10d %-10.10d\n"
1491 int count = 0;
1492 struct ao2_iterator i;
1493
1494 switch (cmd) {
1495 case CLI_INIT:
1496 e->command = "manager show connected";
1497 e->usage =
1498 "Usage: manager show connected\n"
1499 " Prints a listing of the users that are currently connected to the\n"
1500 "Asterisk manager interface.\n";
1501 return NULL;
1502 case CLI_GENERATE:
1503 return NULL;
1504 }
1505
1506 ast_cli(a->fd, HSMCONN_FORMAT1, "Username", "IP Address", "Start", "Elapsed", "FileDes", "HttpCnt", "ReadPerms", "WritePerms");
1507
1508 sessions = ao2_global_obj_ref(mgr_sessions);
1509 if (sessions) {
1511 ao2_ref(sessions, -1);
1512 while ((session = ao2_iterator_next(&i))) {
1514 ast_cli(a->fd, HSMCONN_FORMAT2, session->username,
1516 (int) (session->sessionstart),
1517 (int) (now - session->sessionstart),
1518 session->stream ? ast_iostream_get_fd(session->stream) : -1,
1519 session->inuse,
1520 session->readperm,
1521 session->writeperm);
1522 count++;
1525 }
1527 }
1528 ast_cli(a->fd, "%d users connected.\n", count);
1529
1530 return CLI_SUCCESS;
1531}
#define HSMCONN_FORMAT1
#define HSMCONN_FORMAT2

References a, ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_cli(), ast_iostream_get_fd(), ast_sockaddr_stringify_addr(), CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, HSMCONN_FORMAT1, HSMCONN_FORMAT2, NULL, session, sessions, unref_mansession(), and ast_cli_entry::usage.

◆ handle_showmaneventq()

static char * handle_showmaneventq ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager list eventq.

Definition at line 1535 of file manager.c.

1536{
1537 struct eventqent *s;
1538 switch (cmd) {
1539 case CLI_INIT:
1540 e->command = "manager show eventq";
1541 e->usage =
1542 "Usage: manager show eventq\n"
1543 " Prints a listing of all events pending in the Asterisk manger\n"
1544 "event queue.\n";
1545 return NULL;
1546 case CLI_GENERATE:
1547 return NULL;
1548 }
1551 ast_cli(a->fd, "Usecount: %d\n", s->usecount);
1552 ast_cli(a->fd, "Category: %d\n", s->category);
1553 ast_cli(a->fd, "Event:\n%s", s->eventdata);
1554 }
1556
1557 return CLI_SUCCESS;
1558}

References a, ast_cli(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, eventqent::category, CLI_GENERATE, CLI_INIT, CLI_SUCCESS, ast_cli_entry::command, eventqent::eq_next, eventqent::eventdata, NULL, ast_cli_entry::usage, and eventqent::usecount.

◆ handle_updates()

static enum error_type handle_updates ( struct mansession s,
const struct message m,
struct ast_config cfg,
const char *  dfn 
)
static

helper function for action_updateconfig

Definition at line 2725 of file manager.c.

2726{
2727 int x;
2728 char hdr[40];
2729 const char *action, *cat, *var, *value, *match, *line, *options;
2730 struct ast_variable *v;
2731 struct ast_str *str1 = ast_str_create(16), *str2 = ast_str_create(16);
2732 enum error_type result = 0;
2733
2734 for (x = 0; x < 100000; x++) { /* 100000 = the max number of allowed updates + 1 */
2735 unsigned int object = 0;
2736 char *dupoptions;
2737 int allowdups = 0;
2738 int istemplate = 0;
2739 int ignoreerror = 0;
2740 RAII_VAR(char *, inherit, NULL, ast_free);
2741 RAII_VAR(char *, catfilter, NULL, ast_free);
2742 char *token;
2743 int foundvar = 0;
2744 int foundcat = 0;
2745 struct ast_category *category = NULL;
2746
2747 snprintf(hdr, sizeof(hdr), "Action-%06d", x);
2748 action = astman_get_header(m, hdr);
2749 if (ast_strlen_zero(action)) /* breaks the for loop if no action header */
2750 break; /* this could cause problems if actions come in misnumbered */
2751
2752 snprintf(hdr, sizeof(hdr), "Cat-%06d", x);
2753 cat = astman_get_header(m, hdr);
2754 if (ast_strlen_zero(cat)) { /* every action needs a category */
2756 break;
2757 }
2758
2759 snprintf(hdr, sizeof(hdr), "Var-%06d", x);
2760 var = astman_get_header(m, hdr);
2761
2762 snprintf(hdr, sizeof(hdr), "Value-%06d", x);
2763 value = astman_get_header(m, hdr);
2764
2765 if (!ast_strlen_zero(value) && *value == '>') {
2766 object = 1;
2767 value++;
2768 }
2769
2770 snprintf(hdr, sizeof(hdr), "Match-%06d", x);
2771 match = astman_get_header(m, hdr);
2772
2773 snprintf(hdr, sizeof(hdr), "Line-%06d", x);
2774 line = astman_get_header(m, hdr);
2775
2776 snprintf(hdr, sizeof(hdr), "Options-%06d", x);
2777 options = astman_get_header(m, hdr);
2778 if (!ast_strlen_zero(options)) {
2779 char copy[strlen(options) + 1];
2780 strcpy(copy, options); /* safe */
2781 dupoptions = copy;
2782 while ((token = ast_strsep(&dupoptions, ',', AST_STRSEP_STRIP))) {
2783 if (!strcasecmp("allowdups", token)) {
2784 allowdups = 1;
2785 continue;
2786 }
2787 if (!strcasecmp("template", token)) {
2788 istemplate = 1;
2789 continue;
2790 }
2791 if (!strcasecmp("ignoreerror", token)) {
2792 ignoreerror = 1;
2793 continue;
2794 }
2795 if (ast_begins_with(token, "inherit")) {
2796 char *c = ast_strsep(&token, '=', AST_STRSEP_STRIP);
2797 c = ast_strsep(&token, '=', AST_STRSEP_STRIP);
2798 if (c) {
2799 inherit = ast_strdup(c);
2800 }
2801 continue;
2802 }
2803 if (ast_begins_with(token, "catfilter")) {
2804 char *c = ast_strsep(&token, '=', AST_STRSEP_STRIP);
2805 c = ast_strsep(&token, '=', AST_STRSEP_STRIP);
2806 if (c) {
2807 catfilter = ast_strdup(c);
2808 }
2809 continue;
2810 }
2811 }
2812 }
2813
2814 if (!strcasecmp(action, "newcat")) {
2815 struct ast_category *template;
2816 char *tmpl_name = NULL;
2817
2818 if (!allowdups) {
2819 if (ast_category_get(cfg, cat, "TEMPLATES=include")) {
2820 if (ignoreerror) {
2821 continue;
2822 } else {
2823 result = FAILURE_NEWCAT; /* already exist */
2824 break;
2825 }
2826 }
2827 }
2828
2829 if (istemplate) {
2830 category = ast_category_new_template(cat, dfn, -1);
2831 } else {
2832 category = ast_category_new(cat, dfn, -1);
2833 }
2834
2835 if (!category) {
2837 break;
2838 }
2839
2840 if (inherit) {
2841 while ((tmpl_name = ast_strsep(&inherit, ',', AST_STRSEP_STRIP))) {
2842 if ((template = ast_category_get(cfg, tmpl_name, "TEMPLATES=restrict"))) {
2843 if (ast_category_inherit(category, template)) {
2845 break;
2846 }
2847 } else {
2848 ast_category_destroy(category);
2849 category = NULL;
2850 result = FAILURE_TEMPLATE; /* template not found */
2851 break;
2852 }
2853 }
2854 }
2855
2856 if (category != NULL) {
2857 if (ast_strlen_zero(match)) {
2858 ast_category_append(cfg, category);
2859 } else {
2860 if (ast_category_insert(cfg, category, match)) {
2861 ast_category_destroy(category);
2863 break;
2864 }
2865 }
2866 }
2867 } else if (!strcasecmp(action, "renamecat")) {
2868 if (ast_strlen_zero(value)) {
2870 break;
2871 }
2872
2873 foundcat = 0;
2874 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2875 ast_category_rename(category, value);
2876 foundcat = 1;
2877 }
2878
2879 if (!foundcat) {
2881 break;
2882 }
2883 } else if (!strcasecmp(action, "delcat")) {
2884 foundcat = 0;
2885 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2886 category = ast_category_delete(cfg, category);
2887 foundcat = 1;
2888 }
2889
2890 if (!foundcat && !ignoreerror) {
2892 break;
2893 }
2894 } else if (!strcasecmp(action, "emptycat")) {
2895 foundcat = 0;
2896 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2897 ast_category_empty(category);
2898 foundcat = 1;
2899 }
2900
2901 if (!foundcat) {
2903 break;
2904 }
2905 } else if (!strcasecmp(action, "update")) {
2906 if (ast_strlen_zero(var)) {
2908 break;
2909 }
2910
2911 foundcat = 0;
2912 foundvar = 0;
2913 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2914 if (!ast_variable_update(category, var, value, match, object)) {
2915 foundvar = 1;
2916 }
2917 foundcat = 1;
2918 }
2919
2920 if (!foundcat) {
2922 break;
2923 }
2924
2925 if (!foundvar) {
2927 break;
2928 }
2929 } else if (!strcasecmp(action, "delete")) {
2930 if ((ast_strlen_zero(var) && ast_strlen_zero(line))) {
2932 break;
2933 }
2934
2935 foundcat = 0;
2936 foundvar = 0;
2937 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2938 if (!ast_variable_delete(category, var, match, line)) {
2939 foundvar = 1;
2940 }
2941 foundcat = 1;
2942 }
2943
2944 if (!foundcat) {
2946 break;
2947 }
2948
2949 if (!foundvar && !ignoreerror) {
2951 break;
2952 }
2953 } else if (!strcasecmp(action, "append")) {
2954 if (ast_strlen_zero(var)) {
2956 break;
2957 }
2958
2959 foundcat = 0;
2960 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2961 if (!(v = ast_variable_new(var, value, dfn))) {
2963 break;
2964 }
2965 if (object || (match && !strcasecmp(match, "object"))) {
2966 v->object = 1;
2967 }
2968 ast_variable_append(category, v);
2969 foundcat = 1;
2970 }
2971
2972 if (!foundcat) {
2974 break;
2975 }
2976 } else if (!strcasecmp(action, "insert")) {
2977 if (ast_strlen_zero(var) || ast_strlen_zero(line)) {
2979 break;
2980 }
2981
2982 foundcat = 0;
2983 while ((category = ast_category_browse_filtered(cfg, cat, category, catfilter))) {
2984 if (!(v = ast_variable_new(var, value, dfn))) {
2986 break;
2987 }
2988 ast_variable_insert(category, v, line);
2989 foundcat = 1;
2990 }
2991
2992 if (!foundcat) {
2994 break;
2995 }
2996 }
2997 else {
2998 ast_log(LOG_WARNING, "Action-%06d: %s not handled\n", x, action);
3000 break;
3001 }
3002 }
3003 ast_free(str1);
3004 ast_free(str2);
3005 return result;
3006}
static int copy(char *infile, char *outfile)
Utility function to copy a file.
int ast_category_inherit(struct ast_category *existing, const struct ast_category *base)
Applies base (template) to category.
struct ast_category * ast_category_new_template(const char *name, const char *in_file, int lineno)
Create a category making it a template.
struct ast_category * ast_category_delete(struct ast_config *cfg, struct ast_category *cat)
Delete a category.
void ast_category_rename(struct ast_category *cat, const char *name)
int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line)
int ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match)
Inserts new category.
void ast_category_append(struct ast_config *config, struct ast_category *category)
Appends a category to a config.
Definition extconf.c:2831
void ast_variable_append(struct ast_category *category, struct ast_variable *variable)
Definition extconf.c:1175
int ast_variable_update(struct ast_category *category, const char *variable, const char *value, const char *match, unsigned int object)
Update variable value within a config.
struct ast_category * ast_category_new(const char *name, const char *in_file, int lineno)
Create a category.
Definition extconf.c:2786
#define ast_variable_new(name, value, filename)
void ast_category_destroy(struct ast_category *cat)
Definition extconf.c:2843
int ast_category_empty(struct ast_category *category)
Removes and destroys all variables in a category.
void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line)
struct ast_category * ast_category_get(const struct ast_config *config, const char *category_name, const char *filter)
Retrieve a category if it exists.
@ AST_STRSEP_STRIP
Definition strings.h:255
char * ast_strsep(char **s, const char sep, uint32_t flags)
Act like strsep but ignore separators inside quotes.
Definition utils.c:1869
static struct test_options options

References ast_begins_with(), ast_category_append(), ast_category_browse_filtered(), ast_category_delete(), ast_category_destroy(), ast_category_empty(), ast_category_get(), ast_category_inherit(), ast_category_insert(), ast_category_new(), ast_category_new_template(), ast_category_rename(), ast_free, ast_log, ast_str_create, ast_strdup, ast_strlen_zero(), ast_strsep(), AST_STRSEP_STRIP, ast_variable_append(), ast_variable_delete(), ast_variable_insert(), ast_variable_new, ast_variable_update(), astman_get_header(), c, copy(), FAILURE_ALLOCATION, FAILURE_NEWCAT, FAILURE_TEMPLATE, FAILURE_UPDATE, LOG_WARNING, match(), NULL, ast_variable::object, options, RAII_VAR, result, UNKNOWN_ACTION, UNKNOWN_CATEGORY, UNSPECIFIED_ARGUMENT, UNSPECIFIED_CATEGORY, value, and var.

Referenced by action_updateconfig().

◆ is_originate_app_permitted()

static int is_originate_app_permitted ( const char *  app,
const char *  data,
int  permission 
)
static

Definition at line 5127 of file manager.c.

5129{
5130 int i;
5131
5132 for (i = 0; originate_app_permissions[i].search; i++) {
5133 if (originate_app_permissions[i].searchfn(app, data, originate_app_permissions[i].search)) {
5135 }
5136 }
5137
5138 return 1;
5139}
static struct originate_permissions_entry originate_app_permissions[]
Definition manager.c:5091
int permission
Definition manager.c:5001
const char * search
Definition manager.c:5000

References app, originate_app_permissions, originate_permissions_entry::permission, and originate_permissions_entry::search.

Referenced by action_originate().

◆ is_restricted_file()

static int is_restricted_file ( const char *  filename)
static

Check if a file is restricted or not.

Returns
0 on success
1 on restricted file
-1 on failure

Definition at line 2470 of file manager.c.

2471{
2472 char *stripped_filename;
2473 RAII_VAR(char *, path, NULL, ast_free);
2474 RAII_VAR(char *, real_path, NULL, ast_std_free);
2475
2476 if (live_dangerously) {
2477 return 0;
2478 }
2479
2480 stripped_filename = ast_strip(ast_strdupa(filename));
2481
2482 /* If the file path starts with '/', don't prepend ast_config_AST_CONFIG_DIR */
2483 if (stripped_filename[0] == '/') {
2484 real_path = realpath(stripped_filename, NULL);
2485 } else {
2486 if (ast_asprintf(&path, "%s/%s", ast_config_AST_CONFIG_DIR, stripped_filename) == -1) {
2487 return -1;
2488 }
2489 real_path = realpath(path, NULL);
2490 }
2491
2492 if (!real_path) {
2493 return -1;
2494 }
2495
2496 if (!ast_begins_with(real_path, ast_config_AST_CONFIG_DIR)) {
2497 return 1;
2498 }
2499
2500 return 0;
2501}

References ast_asprintf, ast_begins_with(), ast_config_AST_CONFIG_DIR, ast_free, ast_std_free(), ast_strdupa, ast_strip(), live_dangerously, NULL, and RAII_VAR.

Referenced by action_getconfig(), action_getconfigjson(), action_listcategories(), and action_updateconfig().

◆ json_escape()

static void json_escape ( char *  out,
const char *  in 
)
static

The amount of space in out must be at least ( 2 * strlen(in) + 1 )

Definition at line 2624 of file manager.c.

2625{
2626 for (; *in; in++) {
2627 if (*in == '\\' || *in == '\"') {
2628 *out++ = '\\';
2629 }
2630 *out++ = *in;
2631 }
2632 *out = '\0';
2633}
FILE * out
Definition utils/frame.c:33

References in, and out.

Referenced by astman_append_json().

◆ log_action()

static void log_action ( const struct message m,
const char *  action 
)
static

Definition at line 6993 of file manager.c.

6994{
6995 struct ast_str *buf;
6996 int x;
6997
6998 if (!manager_debug) {
6999 return;
7000 }
7001
7002 buf = ast_str_create(256);
7003 if (!buf) {
7004 return;
7005 }
7006
7007 for (x = 0; x < m->hdrcount; ++x) {
7008 if (!strncasecmp(m->headers[x], "Secret", 6)) {
7009 ast_str_append(&buf, 0, "Secret: <redacted from logging>\n");
7010 } else {
7011 ast_str_append(&buf, 0, "%s\n", m->headers[x]);
7012 }
7013 }
7014
7015 ast_verbose("<--- Examining AMI action: -->\n%s\n", ast_str_buffer(buf));
7016 ast_free(buf);
7017}

References ast_free, ast_str_append(), ast_str_buffer(), ast_str_create, ast_verbose, buf, message::hdrcount, message::headers, and manager_debug.

Referenced by process_message().

◆ man_do_variable_value()

static struct ast_variable * man_do_variable_value ( struct ast_variable head,
const char *  hdr_val 
)
static

Definition at line 1691 of file manager.c.

1692{
1693 char *parse;
1695 AST_APP_ARG(vars)[64];
1696 );
1697
1698 hdr_val = ast_skip_blanks(hdr_val); /* ignore leading spaces in the value */
1699 parse = ast_strdupa(hdr_val);
1700
1701 /* Break the header value string into name=val pair items. */
1703 if (args.argc) {
1704 int y;
1705
1706 /* Process each name=val pair item. */
1707 for (y = 0; y < args.argc; y++) {
1708 struct ast_variable *cur;
1709 char *var;
1710 char *val;
1711
1712 if (!args.vars[y]) {
1713 continue;
1714 }
1715 var = val = args.vars[y];
1716 strsep(&val, "=");
1717
1718 /* XXX We may wish to trim whitespace from the strings. */
1719 if (!val || ast_strlen_zero(var)) {
1720 continue;
1721 }
1722
1723 /* Create new variable list node and prepend it to the list. */
1724 cur = ast_variable_new(var, val, "");
1725 if (cur) {
1726 cur->next = head;
1727 head = cur;
1728 }
1729 }
1730 }
1731
1732 return head;
1733}
static struct @521 args

References args, AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_skip_blanks(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_variable_new, ast_variable::next, strsep(), and var.

Referenced by astman_get_variables_order().

◆ manager_add_filter()

static enum add_filter_result manager_add_filter ( const char *  criteria,
const char *  filter_pattern,
struct ao2_container includefilters,
struct ao2_container excludefilters 
)
static

Add an event filter to a manager session.

Parameters
criteriaSee examples in manager.conf.sample
filter_patternFilter pattern
includefilters,excludefilters
Returns
FILTER_ALLOC_FAILED Memory allocation failure
FILTER_COMPILE_FAIL If the filter did not compile
FILTER_FORMAT_ERROR If the criteria weren't formatted correctly
FILTER_SUCCESS Success

Examples: See examples in manager.conf.sample

Definition at line 5758 of file manager.c.

5761{
5762 RAII_VAR(struct event_filter_entry *, filter_entry,
5763 ao2_t_alloc(sizeof(*filter_entry), event_filter_destructor, "event_filter allocation"),
5764 ao2_cleanup);
5765 const char *options_start = NULL;
5766 SCOPE_ENTER(3, "manager_add_filter(%s, %s, %p, %p)", criteria, filter_pattern, includefilters, excludefilters);
5767
5768 if (!filter_entry) {
5769 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_ALLOC_FAILED, LOG_WARNING, "Unable to allocate filter_entry");
5770 }
5771
5772 /*
5773 * At a minimum, criteria must be "eventfilter" but may contain additional
5774 * constraints.
5775 */
5776 if (ast_strlen_zero(criteria)) {
5778 }
5779
5780 /*
5781 * filter_pattern could be empty but it should never be NULL.
5782 */
5783 if (!filter_pattern) {
5784 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "Filter pattern was NULL");
5785 }
5786
5787 /*
5788 * For a legacy filter, if the first character of filter_pattern is
5789 * '!' then it's an exclude filter. It's also accepted as an alternative
5790 * to specifying "action(exclude)" for an advanced filter. If
5791 * "action" is specified however, it will take precedence.
5792 */
5793 if (filter_pattern[0] == '!') {
5794 filter_entry->is_excludefilter = 1;
5795 filter_pattern++;
5796 }
5797
5798 /*
5799 * This is the default
5800 */
5801 filter_entry->match_type = FILTER_MATCH_REGEX;
5802
5803 /*
5804 * If the criteria has a '(' in it, then it's an advanced filter.
5805 */
5806 options_start = strstr(criteria, "(");
5807
5808 /*
5809 * If it's a legacy filter, there MUST be a filter pattern.
5810 */
5811 if (!options_start && ast_strlen_zero(filter_pattern)) {
5813 "'%s = %s': Legacy filter with no filter pattern specified\n",
5814 criteria, filter_pattern);
5815 }
5816
5817 if (options_start) {
5818 /*
5819 * This is an advanced filter
5820 */
5821 char *temp = ast_strdupa(options_start + 1); /* skip over the leading '(' */
5822 char *saveptr = NULL;
5823 char *option = NULL;
5824 enum found_options {
5825 action_found = (1 << 0),
5826 name_found = (1 << 1),
5827 header_found = (1 << 2),
5828 method_found = (1 << 3),
5829 };
5830 enum found_options options_found = 0;
5831
5832 filter_entry->match_type = FILTER_MATCH_NONE;
5833
5834 ast_strip(temp);
5835 if (ast_strlen_zero(temp) || !ast_ends_with(temp, ")")) {
5837 "'%s = %s': Filter options not formatted correctly\n",
5838 criteria, filter_pattern);
5839 }
5840
5841 /*
5842 * These can actually be in any order...
5843 * action(include|exclude),name(<event_name>),header(<header_name>),method(<match_method>)
5844 * At least one of action, name, or header is required.
5845 */
5846 while ((option = strtok_r(temp, " ,)", &saveptr))) {
5847 if (!strncmp(option, "action", 6)) {
5848 char *method = strstr(option, "(");
5849 if (ast_strlen_zero(method)) {
5850 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'action' parameter not formatted correctly\n",
5851 criteria, filter_pattern);
5852 }
5853 method++;
5855 if (!strcmp(method, "include")) {
5856 filter_entry->is_excludefilter = 0;
5857 } else if (!strcmp(method, "exclude")) {
5858 filter_entry->is_excludefilter = 1;
5859 } else {
5860 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'action' option '%s' is unknown\n",
5861 criteria, filter_pattern, method);
5862 }
5863 options_found |= action_found;
5864 } else if (!strncmp(option, "name", 4)) {
5865 char *event_name = strstr(option, "(");
5866 event_name++;
5867 ast_strip(event_name);
5868 if (ast_strlen_zero(event_name)) {
5869 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'name' parameter not formatted correctly\n",
5870 criteria, filter_pattern);
5871 }
5872 filter_entry->event_name = ast_strdup(event_name);
5873 filter_entry->event_name_hash = ast_str_hash(event_name);
5874 options_found |= name_found;
5875 } else if (!strncmp(option, "header", 6)) {
5876 char *header_name = strstr(option, "(");
5877 header_name++;
5878 ast_strip(header_name);
5879 if (ast_strlen_zero(header_name)) {
5880 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'header' parameter not formatted correctly\n",
5881 criteria, filter_pattern);
5882 }
5883 if (!ast_ends_with(header_name, ":")) {
5884 filter_entry->header_name = ast_malloc(strlen(header_name) + 2);
5885 if (!filter_entry->header_name) {
5886 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_ALLOC_FAILED, LOG_ERROR, "Unable to allocate memory for header_name");
5887 }
5888 sprintf(filter_entry->header_name, "%s:", header_name); /* Safe */
5889 } else {
5890 filter_entry->header_name = ast_strdup(header_name);
5891 }
5892 options_found |= header_found;
5893 } else if (!strncmp(option, "method", 6)) {
5894 char *method = strstr(option, "(");
5895 method++;
5897 if (ast_strlen_zero(method)) {
5898 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'method' parameter not formatted correctly\n",
5899 criteria, filter_pattern);
5900 }
5901 if (!strcmp(method, "regex")) {
5902 filter_entry->match_type = FILTER_MATCH_REGEX;
5903 } else if (!strcmp(method, "exact")) {
5904 filter_entry->match_type = FILTER_MATCH_EXACT;
5905 } else if (!strcmp(method, "starts_with")) {
5906 filter_entry->match_type = FILTER_MATCH_STARTS_WITH;
5907 } else if (!strcmp(method, "ends_with")) {
5908 filter_entry->match_type = FILTER_MATCH_ENDS_WITH;
5909 } else if (!strcmp(method, "contains")) {
5910 filter_entry->match_type = FILTER_MATCH_CONTAINS;
5911 } else if (!strcmp(method, "none")) {
5912 filter_entry->match_type = FILTER_MATCH_NONE;
5913 } else {
5914 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': 'method' option '%s' is unknown\n",
5915 criteria, filter_pattern, method);
5916 }
5917 options_found |= method_found;
5918 } else {
5919 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_FORMAT_ERROR, LOG_WARNING, "'%s = %s': Filter option '%s' is unknown\n",
5920 criteria, filter_pattern, option);
5921 }
5922 temp = NULL;
5923 }
5924 if (!options_found) {
5926 "'%s = %s': No action, name, header, or method option found\n",
5927 criteria, filter_pattern);
5928 }
5929 if (ast_strlen_zero(filter_pattern) && filter_entry->match_type != FILTER_MATCH_NONE) {
5931 "'%s = %s': method can't be '%s' with no filter pattern\n",
5932 criteria, filter_pattern, match_type_names[filter_entry->match_type]);
5933 }
5934 if (!ast_strlen_zero(filter_pattern) && filter_entry->match_type == FILTER_MATCH_NONE) {
5936 "'%s = %s': method can't be 'none' with a filter pattern\n",
5937 criteria, filter_pattern);
5938 }
5939 if (!(options_found & name_found) && !(options_found & header_found) &&
5940 filter_entry->match_type == FILTER_MATCH_NONE) {
5942 "'%s = %s': No name or header option found and no filter pattern\n",
5943 criteria, filter_pattern);
5944 }
5945 }
5946
5947 if (!ast_strlen_zero(filter_pattern)) {
5948 if (filter_entry->match_type == FILTER_MATCH_REGEX) {
5949 filter_entry->regex_filter = ast_calloc(1, sizeof(regex_t));
5950 if (!filter_entry->regex_filter) {
5951 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_ALLOC_FAILED, LOG_ERROR, "Unable to allocate memory for regex_filter");
5952 }
5953 if (regcomp(filter_entry->regex_filter, filter_pattern, REG_EXTENDED | REG_NOSUB)) {
5954 SCOPE_EXIT_LOG_RTN_VALUE(FILTER_COMPILE_FAIL, LOG_WARNING, "Unable to compile regex filter for '%s'", filter_pattern);
5955 }
5956 } else {
5957 filter_entry->string_filter = ast_strdup(filter_pattern);
5958 }
5959 }
5960
5961 ast_debug(2, "Event filter:\n"
5962 "conf entry: %s = %s\n"
5963 "event_name: %s (hash: %d)\n"
5964 "test_header: %s\n"
5965 "match_type: %s\n"
5966 "regex_filter: %p\n"
5967 "string filter: %s\n"
5968 "is excludefilter: %d\n",
5969 criteria, filter_pattern,
5970 S_OR(filter_entry->event_name, "<not used>"),
5971 filter_entry->event_name_hash,
5972 S_OR(filter_entry->header_name, "<not used>"),
5973 match_type_names[filter_entry->match_type],
5974 filter_entry->regex_filter,
5975 filter_entry->string_filter,
5976 filter_entry->is_excludefilter);
5977
5978 if (filter_entry->is_excludefilter) {
5979 ao2_t_link(excludefilters, filter_entry, "link new filter into exclude user container");
5980 } else {
5981 ao2_t_link(includefilters, filter_entry, "link new filter into include user container");
5982 }
5983
5984 SCOPE_EXIT_RTN_VALUE(FILTER_SUCCESS, "Filter added successfully");
5985}
static char * match_type_names[]
Definition manager.c:394
static void event_filter_destructor(void *obj)
Definition manager.c:923
#define SCOPE_EXIT_RTN_VALUE(__return_value,...)
#define SCOPE_EXIT_LOG_RTN_VALUE(__value, __log_level,...)
#define SCOPE_ENTER(level,...)
const char * method
Definition res_pjsip.c:1273

References ao2_cleanup, ao2_t_alloc, ao2_t_link, ast_calloc, ast_debug, ast_ends_with(), ast_malloc, ast_str_hash(), ast_strdup, ast_strdupa, ast_strip(), ast_strlen_zero(), event_filter_destructor(), FILTER_ALLOC_FAILED, FILTER_COMPILE_FAIL, FILTER_FORMAT_ERROR, FILTER_MATCH_CONTAINS, FILTER_MATCH_ENDS_WITH, FILTER_MATCH_EXACT, FILTER_MATCH_NONE, FILTER_MATCH_REGEX, FILTER_MATCH_STARTS_WITH, FILTER_SUCCESS, LOG_ERROR, LOG_WARNING, match_type_names, method, NULL, RAII_VAR, S_OR, SCOPE_ENTER, SCOPE_EXIT_LOG_RTN_VALUE, and SCOPE_EXIT_RTN_VALUE.

Referenced by __init_manager(), and action_filter().

◆ manager_default_msg_cb()

static void manager_default_msg_cb ( void *  data,
struct stasis_subscription sub,
struct stasis_message message 
)
static

Definition at line 568 of file manager.c.

570{
571 struct ao2_container *sessions;
572 struct ast_manager_event_blob *ev;
573
575 /* Not an AMI message; disregard */
576 return;
577 }
578
579 sessions = ao2_global_obj_ref(mgr_sessions);
581 /* Nobody is listening */
583 return;
584 }
585
587 if (!ev) {
588 /* Conversion failure */
590 return;
591 }
592
594 "%s", ev->extra_fields);
595 ao2_ref(ev, -1);
597}
#define manager_event_sessions(sessions, category, event, contents,...)
Definition manager.c:562
struct ast_manager_event_blob * stasis_message_to_ami(struct stasis_message *msg)
Build the AMI representation of the message.
int stasis_message_can_be_ami(struct stasis_message *msg)
Determine if the given message can be converted to AMI.
Struct containing info for an AMI event to send out.
Definition manager.h:504
const ast_string_field extra_fields
Definition manager.h:509
const char * manager_event
Definition manager.h:506

References any_manager_listeners, ao2_cleanup, ao2_global_obj_ref, ao2_ref, ast_manager_event_blob::event_flags, ast_manager_event_blob::extra_fields, ast_manager_event_blob::manager_event, manager_event_sessions, sessions, stasis_message_can_be_ami(), and stasis_message_to_ami().

Referenced by manager_subscriptions_init().

◆ manager_displayconnects()

static int manager_displayconnects ( struct mansession_session session)
static

Get displayconnects config option.

Parameters
sessionmanager session to get parameter from.
Returns
displayconnects config option value.

Definition at line 1059 of file manager.c.

1060{
1061 struct ast_manager_user *user = NULL;
1062 int ret = 0;
1063
1065 if ((user = get_manager_by_name_locked(session->username))) {
1066 ret = user->displayconnects;
1067 }
1069
1070 return ret;
1071}

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, get_manager_by_name_locked(), NULL, and session.

Referenced by action_login(), generic_http_callback(), purge_sessions(), and session_do().

◆ manager_generic_msg_cb()

static void manager_generic_msg_cb ( void *  data,
struct stasis_subscription sub,
struct stasis_message message 
)
static

Definition at line 599 of file manager.c.

601{
602 struct ast_json_payload *payload;
603 int class_type;
604 const char *type;
605 struct ast_json *event;
606 struct ast_str *event_buffer;
607 struct ao2_container *sessions;
608
609 sessions = ao2_global_obj_ref(mgr_sessions);
611 /* Nobody is listening */
613 return;
614 }
615
616 payload = stasis_message_data(message);
617 class_type = ast_json_integer_get(ast_json_object_get(payload->json, "class_type"));
619 event = ast_json_object_get(payload->json, "event");
620
622 if (!event_buffer) {
623 ast_log(AST_LOG_WARNING, "Error while creating payload for event %s\n", type);
625 return;
626 }
627
629 "%s", ast_str_buffer(event_buffer));
630 ast_free(event_buffer);
632}
struct ast_str * ast_manager_str_from_json_object(struct ast_json *blob, key_exclusion_cb exclusion_cb)
Convert a JSON object into an AMI compatible string.
Definition manager.c:551
#define AST_LOG_WARNING
const char * ast_json_string_get(const struct ast_json *string)
Get the value of a JSON string.
Definition json.c:283
struct ast_json * ast_json_object_get(struct ast_json *object, const char *key)
Get a field from a JSON object.
Definition json.c:407
intmax_t ast_json_integer_get(const struct ast_json *integer)
Get the value from a JSON integer.
Definition json.c:332
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
struct ast_json * json
Definition json.h:1083

References any_manager_listeners, ao2_cleanup, ao2_global_obj_ref, ast_free, ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_log, AST_LOG_WARNING, ast_manager_str_from_json_object(), ast_str_buffer(), ast_json_payload::json, manager_event_sessions, NULL, sessions, stasis_message_data(), and type.

Referenced by manager_subscriptions_init().

◆ manager_json_array_with_key()

static void manager_json_array_with_key ( struct ast_json obj,
const char *  key,
size_t  index,
struct ast_str **  res,
key_exclusion_cb  exclusion_cb 
)
static

Definition at line 485 of file manager.c.

488{
489 struct ast_str *key_str = ast_str_alloca(64);
490 ast_str_set(&key_str, 0, "%s(%zu)", key, index);
492 res, exclusion_cb);
493}

References ast_str_alloca, ast_str_buffer(), ast_str_set(), and manager_json_to_ast_str().

Referenced by manager_json_to_ast_str().

◆ manager_json_obj_with_key()

static void manager_json_obj_with_key ( struct ast_json obj,
const char *  key,
const char *  parent_key,
struct ast_str **  res,
key_exclusion_cb  exclusion_cb 
)
static

Definition at line 495 of file manager.c.

498{
499 if (parent_key) {
500 struct ast_str *key_str = ast_str_alloca(64);
501 ast_str_set(&key_str, 0, "%s/%s", parent_key, key);
503 res, exclusion_cb);
504 return;
505 }
506
507 manager_json_to_ast_str(obj, key, res, exclusion_cb);
508}

References ast_str_alloca, ast_str_buffer(), ast_str_set(), and manager_json_to_ast_str().

Referenced by manager_json_to_ast_str().

◆ manager_json_to_ast_str()

void manager_json_to_ast_str ( struct ast_json obj,
const char *  key,
struct ast_str **  res,
key_exclusion_cb  exclusion_cb 
)
static

Definition at line 510 of file manager.c.

512{
513 struct ast_json_iter *i;
514
515 /* If obj or res is not given, just return */
516 if (!obj || !res) {
517 return;
518 }
519
520 if (!*res && !(*res = ast_str_create(1024))) {
521 return;
522 }
523
524 if (exclusion_cb && key && exclusion_cb(key)) {
525 return;
526 }
527
528 if (ast_json_typeof(obj) != AST_JSON_OBJECT &&
530 manager_json_value_str_append(obj, key, res);
531 return;
532 }
533
534 if (ast_json_typeof(obj) == AST_JSON_ARRAY) {
535 size_t j;
536 for (j = 0; j < ast_json_array_size(obj); ++j) {
538 key, j, res, exclusion_cb);
539 }
540 return;
541 }
542
543 for (i = ast_json_object_iter(obj); i;
544 i = ast_json_object_iter_next(obj, i)) {
547 key, res, exclusion_cb);
548 }
549}
static void manager_json_array_with_key(struct ast_json *obj, const char *key, size_t index, struct ast_str **res, key_exclusion_cb exclusion_cb)
Definition manager.c:485
static void manager_json_value_str_append(struct ast_json *value, const char *key, struct ast_str **res)
Definition manager.c:460
static void manager_json_obj_with_key(struct ast_json *obj, const char *key, const char *parent_key, struct ast_str **res, key_exclusion_cb exclusion_cb)
Definition manager.c:495
struct ast_json * ast_json_object_iter_value(struct ast_json_iter *iter)
Get the value from an iterator.
Definition json.c:455
enum ast_json_type ast_json_typeof(const struct ast_json *value)
Get the type of value.
Definition json.c:78
struct ast_json_iter * ast_json_object_iter_next(struct ast_json *object, struct ast_json_iter *iter)
Get the next iterator.
Definition json.c:447
struct ast_json * ast_json_array_get(const struct ast_json *array, size_t index)
Get an element from an array.
Definition json.c:370
struct ast_json_iter * ast_json_object_iter(struct ast_json *object)
Get an iterator pointing to the first field in a JSON object.
Definition json.c:439
@ AST_JSON_ARRAY
Definition json.h:165
@ AST_JSON_OBJECT
Definition json.h:164
const char * ast_json_object_iter_key(struct ast_json_iter *iter)
Get the key from an iterator.
Definition json.c:451
size_t ast_json_array_size(const struct ast_json *array)
Get the size of a JSON array.
Definition json.c:366
Iterator for JSON object key/values.

References AST_JSON_ARRAY, ast_json_array_get(), ast_json_array_size(), AST_JSON_OBJECT, ast_json_object_iter(), ast_json_object_iter_key(), ast_json_object_iter_next(), ast_json_object_iter_value(), ast_json_typeof(), ast_str_create, manager_json_array_with_key(), manager_json_obj_with_key(), and manager_json_value_str_append().

Referenced by ast_manager_str_from_json_object(), manager_json_array_with_key(), and manager_json_obj_with_key().

◆ manager_json_value_str_append()

static void manager_json_value_str_append ( struct ast_json value,
const char *  key,
struct ast_str **  res 
)
static

Definition at line 460 of file manager.c.

462{
463 switch (ast_json_typeof(value)) {
464 case AST_JSON_STRING:
465 ast_str_append(res, 0, "%s: %s\r\n", key, ast_json_string_get(value));
466 break;
467 case AST_JSON_INTEGER:
468 ast_str_append(res, 0, "%s: %jd\r\n", key, ast_json_integer_get(value));
469 break;
470 case AST_JSON_TRUE:
471 ast_str_append(res, 0, "%s: True\r\n", key);
472 break;
473 case AST_JSON_FALSE:
474 ast_str_append(res, 0, "%s: False\r\n", key);
475 break;
476 default:
477 ast_str_append(res, 0, "%s: \r\n", key);
478 break;
479 }
480}
@ AST_JSON_STRING
Definition json.h:166
@ AST_JSON_FALSE
Definition json.h:170
@ AST_JSON_INTEGER
Definition json.h:167
@ AST_JSON_TRUE
Definition json.h:169

References AST_JSON_FALSE, AST_JSON_INTEGER, ast_json_integer_get(), AST_JSON_STRING, ast_json_string_get(), AST_JSON_TRUE, ast_json_typeof(), ast_str_append(), and value.

Referenced by manager_json_to_ast_str().

◆ manager_modulecheck()

static int manager_modulecheck ( struct mansession s,
const struct message m 
)
static

Manager function to check if module is loaded.

Definition at line 6847 of file manager.c.

6848{
6849 const char *module = astman_get_header(m, "Module");
6850 const char *id = astman_get_header(m, "ActionID");
6851
6852 ast_debug(1, "**** ModuleCheck .so file %s\n", module);
6853 if (!ast_module_check(module)) {
6854 astman_send_error(s, m, "Module not loaded");
6855 return 0;
6856 }
6857
6858 astman_append(s, "Response: Success\r\n");
6859
6860 if (!ast_strlen_zero(id)) {
6861 astman_append(s, "ActionID: %s\r\n", id);
6862 }
6863
6864#if !defined(LOW_MEMORY)
6865 /* When we switched from subversion to git we lost the ability to
6866 * retrieve the 'ASTERISK_FILE_VERSION' from that file, but we retain
6867 * the response header here for backwards compatibility. */
6868 astman_append(s, "Version: \r\n");
6869#endif
6870
6871 astman_append(s, "\r\n");
6872
6873 return 0;
6874}
int ast_module_check(const char *name)
Check if module with the name given is loaded.
Definition loader.c:2832

References ast_debug, ast_module_check(), ast_strlen_zero(), astman_append(), astman_get_header(), and astman_send_error().

Referenced by __init_manager().

◆ manager_moduleload()

static int manager_moduleload ( struct mansession s,
const struct message m 
)
static

Definition at line 6912 of file manager.c.

6913{
6914 int res;
6915 const char *module = astman_get_header(m, "Module");
6916 const char *loadtype = astman_get_header(m, "LoadType");
6917 const char *recursive = astman_get_header(m, "Recursive");
6918
6919 if (!loadtype || strlen(loadtype) == 0) {
6920 astman_send_error(s, m, "Incomplete ModuleLoad action.");
6921 }
6922 if ((!module || strlen(module) == 0) && strcasecmp(loadtype, "reload") != 0) {
6923 astman_send_error(s, m, "Need module name");
6924 }
6925
6926 res = file_in_modules_dir(module);
6927 if (res == 0) {
6928 astman_send_error(s, m, "Module must be in the configured modules directory.");
6929 return 0;
6930 } else if (res == -1) {
6931 astman_send_error(s, m, "Module not found.");
6932 return 0;
6933 }
6934
6935 if (!strcasecmp(loadtype, "load")) {
6936 res = ast_load_resource(module);
6937 if (res) {
6938 astman_send_error(s, m, "Could not load module.");
6939 } else {
6940 astman_send_ack(s, m, "Module loaded.");
6941 }
6942 } else if (!strcasecmp(loadtype, "unload")) {
6943 res = ast_unload_resource(module, AST_FORCE_SOFT);
6944 if (res) {
6945 astman_send_error(s, m, "Could not unload module.");
6946 } else {
6947 astman_send_ack(s, m, "Module unloaded.");
6948 }
6949 } else if (!strcasecmp(loadtype, "refresh")) {
6950 res = ast_refresh_resource(module, AST_FORCE_SOFT, !ast_strlen_zero(recursive) && ast_true(recursive));
6951 if (res) {
6952 astman_send_error(s, m, "Could not refresh module.");
6953 } else {
6954 astman_send_ack(s, m, "Module unloaded and loaded.");
6955 }
6956 } else if (!strcasecmp(loadtype, "reload")) {
6957 /* TODO: Unify the ack/error messages here with action_reload */
6958 if (!ast_strlen_zero(module)) {
6959 enum ast_module_reload_result reload_res = ast_module_reload(module);
6960
6961 switch (reload_res) {
6963 astman_send_error(s, m, "No such module.");
6964 break;
6966 astman_send_error(s, m, "Module does not support reload action.");
6967 break;
6969 astman_send_error(s, m, "An unknown error occurred");
6970 break;
6972 astman_send_error(s, m, "A reload is in progress");
6973 break;
6975 astman_send_error(s, m, "Module not initialized");
6976 break;
6979 /* Treat a queued request as success */
6980 astman_send_ack(s, m, "Module reloaded.");
6981 break;
6982 }
6983 } else {
6984 ast_module_reload(NULL); /* Reload all modules */
6985 astman_send_ack(s, m, "All modules reloaded");
6986 }
6987 } else {
6988 astman_send_error(s, m, "Incomplete ModuleLoad action.");
6989 }
6990 return 0;
6991}
static int file_in_modules_dir(const char *filename)
Check if the given file path is in the modules dir or not.
Definition manager.c:6886
int ast_unload_resource(const char *resource_name, enum ast_module_unload_mode)
Unload a module.
Definition loader.c:1457
enum ast_module_load_result ast_load_resource(const char *resource_name)
Load a module.
Definition loader.c:1987
int ast_refresh_resource(const char *resource_name, enum ast_module_unload_mode force, int recursive)
Unload and load a module again.
Definition loader.c:1416
@ AST_FORCE_SOFT
Definition module.h:62

References AST_FORCE_SOFT, ast_load_resource(), ast_module_reload(), AST_MODULE_RELOAD_ERROR, AST_MODULE_RELOAD_IN_PROGRESS, AST_MODULE_RELOAD_NOT_FOUND, AST_MODULE_RELOAD_NOT_IMPLEMENTED, AST_MODULE_RELOAD_QUEUED, AST_MODULE_RELOAD_SUCCESS, AST_MODULE_RELOAD_UNINITIALIZED, ast_refresh_resource(), ast_strlen_zero(), ast_true(), ast_unload_resource(), astman_get_header(), astman_send_ack(), astman_send_error(), file_in_modules_dir(), and NULL.

Referenced by __init_manager().

◆ manager_state_cb()

static int manager_state_cb ( const char *  context,
const char *  exten,
struct ast_state_cb_info info,
void *  data 
)
static

Definition at line 7734 of file manager.c.

7735{
7736 /* Notify managers of change */
7737 char hint[512];
7738
7739 hint[0] = '\0';
7740 ast_get_hint(hint, sizeof(hint), NULL, 0, NULL, context, exten);
7741
7742 switch(info->reason) {
7744 manager_event(EVENT_FLAG_CALL, "ExtensionStatus",
7745 "Exten: %s\r\n"
7746 "Context: %s\r\n"
7747 "Hint: %s\r\n"
7748 "Status: %d\r\n"
7749 "StatusText: %s\r\n",
7750 exten,
7751 context,
7752 hint,
7753 info->exten_state,
7754 ast_extension_state2str(info->exten_state));
7755 break;
7757 manager_event(EVENT_FLAG_CALL, "PresenceStatus",
7758 "Exten: %s\r\n"
7759 "Context: %s\r\n"
7760 "Hint: %s\r\n"
7761 "Status: %s\r\n"
7762 "Subtype: %s\r\n"
7763 "Message: %s\r\n",
7764 exten,
7765 context,
7766 hint,
7767 ast_presence_state2str(info->presence_state),
7768 info->presence_subtype,
7769 info->presence_message);
7770 break;
7771 }
7772 return 0;
7773}
@ AST_HINT_UPDATE_DEVICE
Definition pbx.h:91
@ AST_HINT_UPDATE_PRESENCE
Definition pbx.h:93

References ast_extension_state2str(), ast_get_hint(), AST_HINT_UPDATE_DEVICE, AST_HINT_UPDATE_PRESENCE, ast_presence_state2str(), EVENT_FLAG_CALL, manager_event, and NULL.

Referenced by __init_manager().

◆ mansession_cmp_fn()

static int mansession_cmp_fn ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 999 of file manager.c.

1000{
1001 struct mansession_session *s = obj;
1002 char *str = arg;
1003 return !strcasecmp(s->username, str) ? CMP_MATCH : 0;
1004}

References CMP_MATCH, str, and mansession_session::username.

Referenced by __init_manager().

◆ mansession_get_transport()

static enum ast_transport mansession_get_transport ( const struct mansession s)
static

◆ mansession_lock()

static void mansession_lock ( struct mansession s)
static

Lock the 'mansession' structure.

Definition at line 2080 of file manager.c.

2081{
2082 ast_mutex_lock(&s->lock);
2083}
ast_mutex_t lock
Definition manager.c:330

References ast_mutex_lock, and mansession::lock.

Referenced by action_challenge(), do_message(), handle_parse_error(), and process_message().

◆ mansession_unlock()

static void mansession_unlock ( struct mansession s)
static

Unlock the 'mansession' structure.

Definition at line 2086 of file manager.c.

2087{
2089}

References ast_mutex_unlock, and mansession::lock.

Referenced by action_challenge(), do_message(), handle_parse_error(), and process_message().

◆ match_eventdata()

static int match_eventdata ( struct event_filter_entry entry,
const char *  eventdata 
)
static

Test eventdata against a filter entry.

Parameters
entryThe event_filter entry to match with
eventdataThe data to match against
Return values
0if no match
1if match

Definition at line 5581 of file manager.c.

5582{
5583 switch(entry->match_type) {
5584 case FILTER_MATCH_REGEX:
5585 return regexec(entry->regex_filter, eventdata, 0, NULL, 0) == 0;
5587 return ast_begins_with(eventdata, entry->string_filter);
5589 return ast_ends_with(eventdata, entry->string_filter);
5591 return strstr(eventdata, entry->string_filter) != NULL;
5592 case FILTER_MATCH_EXACT:
5593 return strcmp(eventdata, entry->string_filter) == 0;
5594 case FILTER_MATCH_NONE:
5595 return 1;
5596 }
5597
5598 return 0;
5599}
enum event_filter_match_type match_type
Definition manager.c:404

References ast_begins_with(), ast_ends_with(), FILTER_MATCH_CONTAINS, FILTER_MATCH_ENDS_WITH, FILTER_MATCH_EXACT, FILTER_MATCH_NONE, FILTER_MATCH_REGEX, FILTER_MATCH_STARTS_WITH, event_filter_entry::match_type, NULL, event_filter_entry::regex_filter, and event_filter_entry::string_filter.

Referenced by filter_cmp_fn().

◆ print_event_instance()

static void print_event_instance ( struct ast_cli_args a,
struct ast_xml_doc_item instance 
)
static

Definition at line 9286 of file manager.c.

9287{
9288 char *since, *syntax, *provided_by, *description, *synopsis, *seealso, *arguments;
9289
9290 synopsis = ast_xmldoc_printable(AS_OR(instance->synopsis, "Not available"), 1);
9291 provided_by = ast_xmldoc_printable(AS_OR(instance->provided_by, "Not available"), 1);
9292 since = ast_xmldoc_printable(AS_OR(instance->since, "Not available"), 1);
9293 description = ast_xmldoc_printable(AS_OR(instance->description, "Not available"), 1);
9294 syntax = ast_xmldoc_printable(AS_OR(instance->syntax, "Not available"), 1);
9295 arguments = ast_xmldoc_printable(AS_OR(instance->arguments, "Not available"), 1);
9296 seealso = ast_xmldoc_printable(AS_OR(instance->seealso, "Not available"), 1);
9297
9298 if (!synopsis || !provided_by || !since || !description || !syntax || !arguments || !seealso) {
9299 ast_cli(a->fd, "Error: Memory allocation failed\n");
9300 goto free_docs;
9301 }
9302
9303 ast_cli(a->fd, "\n"
9304 "%s -= Info about Manager Event '%s' =- %s\n\n"
9305 COLORIZE_FMT "\n"
9306 "%s\n\n"
9307 COLORIZE_FMT "\n"
9308 "%s\n\n"
9309 COLORIZE_FMT "\n"
9310 "%s\n\n"
9311 COLORIZE_FMT "\n"
9312 "%s\n\n"
9313 COLORIZE_FMT "\n"
9314 "%s\n\n"
9315 COLORIZE_FMT "\n"
9316 "%s\n\n"
9317 COLORIZE_FMT "\n"
9318 "%s\n\n",
9320 COLORIZE(COLOR_MAGENTA, 0, "[Synopsis]"), synopsis,
9321 COLORIZE(COLOR_MAGENTA, 0, "[Provided By]"), provided_by,
9322 COLORIZE(COLOR_MAGENTA, 0, "[Since]"), since,
9323 COLORIZE(COLOR_MAGENTA, 0, "[Description]"), description,
9324 COLORIZE(COLOR_MAGENTA, 0, "[Syntax]"), syntax,
9325 COLORIZE(COLOR_MAGENTA, 0, "[Arguments]"), arguments,
9326 COLORIZE(COLOR_MAGENTA, 0, "[See Also]"), seealso
9327 );
9328
9329free_docs:
9331 ast_free(since);
9332 ast_free(description);
9333 ast_free(syntax);
9334 ast_free(arguments);
9335 ast_free(seealso);
9336}
#define AS_OR(a, b)
Definition strings.h:49
struct ast_str * synopsis
Definition xmldoc.h:64

References a, ast_xml_doc_item::arguments, AS_OR, ast_cli(), ast_free, ast_term_color(), ast_term_reset(), ast_xmldoc_printable(), COLOR_MAGENTA, COLORIZE, COLORIZE_FMT, ast_xml_doc_item::description, ast_xml_doc_item::name, ast_xml_doc_item::provided_by, ast_xml_doc_item::seealso, ast_xml_doc_item::since, synopsis, ast_xml_doc_item::synopsis, and ast_xml_doc_item::syntax.

Referenced by handle_manager_show_event(), and handle_showmancmd().

◆ process_events()

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

6420{
6421 int ret = 0;
6422
6423 ao2_lock(s->session);
6424 if (s->session->stream != NULL) {
6425 struct eventqent *eqe = s->session->last_ev;
6426
6427 while ((eqe = advance_event(eqe))) {
6428 if (eqe->category == EVENT_FLAG_SHUTDOWN) {
6429 ast_debug(3, "Received CloseSession event\n");
6430 ret = -1;
6431 }
6432 if (!ret && s->session->authenticated &&
6433 (s->session->readperm & eqe->category) == eqe->category &&
6434 (s->session->send_events & eqe->category) == eqe->category) {
6436 if (send_string(s, eqe->eventdata) < 0 || s->write_error)
6437 ret = -1; /* don't send more */
6438 }
6439 }
6440 s->session->last_ev = eqe;
6441 }
6442 }
6443 ao2_unlock(s->session);
6444 return ret;
6445}
unsigned int write_error
Definition manager.c:328

References advance_event(), ao2_lock, ao2_unlock, ast_debug, mansession_session::authenticated, eventqent::category, EVENT_FLAG_SHUTDOWN, eventqent::eventdata, mansession_session::excludefilters, mansession_session::includefilters, mansession_session::last_ev, NULL, mansession_session::readperm, mansession_session::send_events, send_string(), mansession::session, should_send_event(), mansession_session::stream, and mansession::write_error.

Referenced by do_message(), and process_message().

◆ process_message()

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

Process an AMI message, performing desired action. Return 0 on success, -1 on error that require the session to be destroyed.

Definition at line 7032 of file manager.c.

7033{
7034 int ret = 0;
7035 struct manager_action *act_found;
7036 struct ast_manager_user *user = NULL;
7037 const char *username;
7038 const char *action;
7039
7040 action = __astman_get_header(m, "Action", GET_HEADER_SKIP_EMPTY);
7041 if (ast_strlen_zero(action)) {
7042 report_req_bad_format(s, "NONE");
7043 mansession_lock(s);
7044 astman_send_error(s, m, "Missing action in request");
7046 return 0;
7047 }
7048
7049 log_action(m, action);
7050
7051 if (ast_shutting_down()) {
7052 ast_log(LOG_ERROR, "Unable to process manager action '%s'. Asterisk is shutting down.\n", action);
7053 mansession_lock(s);
7054 astman_send_error(s, m, "Asterisk is shutting down");
7056 return 0;
7057 }
7058
7059 if (!s->session->authenticated
7060 && strcasecmp(action, "Login")
7061 && strcasecmp(action, "Logoff")
7062 && strcasecmp(action, "Challenge")) {
7063 if (!s->session->authenticated) {
7064 report_req_not_allowed(s, action);
7065 }
7066 mansession_lock(s);
7067 astman_send_error(s, m, "Permission denied");
7069 return 0;
7070 }
7071
7072 if (!s->session->authenticated
7073 && (!strcasecmp(action, "Login")
7074 || !strcasecmp(action, "Challenge"))) {
7075 username = astman_get_header(m, "Username");
7076
7080 if (user && !user->allowmultiplelogin) {
7083 sleep(1);
7084 mansession_lock(s);
7085 astman_send_error(s, m, "Login Already In Use");
7087 return -1;
7088 }
7090 }
7091 }
7092
7093 act_found = action_find(action);
7094 if (act_found) {
7095 /* Found the requested AMI action. */
7096 int acted = 0;
7097
7098 if ((s->session->writeperm & act_found->authority)
7099 || act_found->authority == 0) {
7100 /* We have the authority to execute the action. */
7101 ret = -1;
7102 ao2_lock(act_found);
7103 if (act_found->registered && act_found->func) {
7104 struct ast_module *mod_ref = ast_module_running_ref(act_found->module);
7105
7106 ao2_unlock(act_found);
7107 if (mod_ref || !act_found->module) {
7108 ast_debug(1, "Running action '%s'\n", act_found->action);
7109 ret = act_found->func(s, m);
7110 acted = 1;
7111 ast_module_unref(mod_ref);
7112 }
7113 } else {
7114 ao2_unlock(act_found);
7115 }
7116 }
7117 if (!acted) {
7118 /*
7119 * We did not execute the action because access was denied, it
7120 * was no longer registered, or no action was really registered.
7121 * Complain about it and leave.
7122 */
7123 report_req_not_allowed(s, action);
7124 mansession_lock(s);
7125 astman_send_error(s, m, "Permission denied");
7127 }
7128 ao2_t_ref(act_found, -1, "done with found action object");
7129 } else {
7130 char buf[512];
7131
7132 report_req_bad_format(s, action);
7133 snprintf(buf, sizeof(buf), "Invalid/unknown command: %s. Use Action: ListCommands to show available commands.", action);
7134 mansession_lock(s);
7135 astman_send_error(s, m, buf);
7137 }
7138 if (ret) {
7139 return ret;
7140 }
7141 /* Once done with our message, deliver any pending events unless the
7142 requester doesn't want them as part of this response.
7143 */
7144 if (ast_strlen_zero(astman_get_header(m, "SuppressEvents"))) {
7145 return process_events(s);
7146 } else {
7147 return ret;
7148 }
7149}
int ast_shutting_down(void)
Definition asterisk.c:1889
static void log_action(const struct message *m, const char *action)
Definition manager.c:6993
static int check_manager_session_inuse(const char *name)
Definition manager.c:1019
static void report_req_not_allowed(const struct mansession *s, const char *action)
Definition manager.c:2214
static void report_session_limit(const struct mansession *s)
Definition manager.c:2302
static void report_req_bad_format(const struct mansession *s, const char *action)
Definition manager.c:2243
char username[80]
Definition manager.c:343

References __astman_get_header(), manager_action::action, action_find(), ao2_lock, ao2_t_ref, ao2_unlock, ast_debug, ast_log, ast_module_running_ref, ast_module_unref, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_shutting_down(), ast_strlen_zero(), astman_get_header(), astman_send_error(), mansession_session::authenticated, manager_action::authority, buf, check_manager_session_inuse(), manager_action::func, GET_HEADER_SKIP_EMPTY, get_manager_by_name_locked(), log_action(), LOG_ERROR, mansession_lock(), mansession_unlock(), NULL, process_events(), manager_action::registered, report_req_bad_format(), report_req_not_allowed(), report_session_limit(), mansession::session, and mansession_session::writeperm.

Referenced by auth_http_callback(), do_message(), and generic_http_callback().

◆ purge_events()

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

715{
716 struct eventqent *ev;
717 struct timeval now = ast_tvnow();
718
720 while ( (ev = AST_RWLIST_FIRST(&all_events)) &&
721 ev->usecount == 0 && AST_RWLIST_NEXT(ev, eq_next)) {
723 ast_free(ev);
724 }
725
727 /* Never release the last event */
728 if (!AST_RWLIST_NEXT(ev, eq_next)) {
729 break;
730 }
731
732 /* 2.5 times whatever the HTTP timeout is (maximum 2.5 hours) is the maximum time that we will definitely cache an event */
733 if (ev->usecount == 0 && ast_tvdiff_sec(now, ev->tv) > (httptimeout > 3600 ? 3600 : httptimeout) * 2.5) {
735 ast_free(ev);
736 }
737 }
740}
static int httptimeout
Definition manager.c:164
#define AST_RWLIST_REMOVE_HEAD
#define AST_RWLIST_FIRST

References ast_free, AST_RWLIST_FIRST, AST_RWLIST_NEXT, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_REMOVE_HEAD, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_tvdiff_sec(), ast_tvnow(), httptimeout, eventqent::tv, and eventqent::usecount.

Referenced by purge_old_stuff().

◆ purge_sessions()

static int purge_sessions ( int  n_max)
static

remove at most n_max stale session from the list.

Definition at line 7460 of file manager.c.

7461{
7462 struct ao2_container *sessions;
7464 time_t now = time(NULL);
7465 struct ao2_iterator i;
7466 int purged = 0;
7467
7468 sessions = ao2_global_obj_ref(mgr_sessions);
7469 if (!sessions) {
7470 return 0;
7471 }
7473 ao2_ref(sessions, -1);
7474
7475 /* The order of operations is significant */
7476 while (n_max > 0 && (session = ao2_iterator_next(&i))) {
7478 if (session->sessiontimeout && (now > session->sessiontimeout) && !session->inuse) {
7479 if (session->authenticated
7480 && VERBOSITY_ATLEAST(2)
7482 ast_verb(2, "HTTP Manager '%s' timed out from %s\n",
7483 session->username, ast_sockaddr_stringify_addr(&session->addr));
7484 }
7487 n_max--;
7488 purged++;
7489 } else {
7492 }
7493 }
7495 return purged;
7496}
static void session_destroy(struct mansession_session *s)
Definition manager.c:1006
#define VERBOSITY_ATLEAST(level)

References ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_sockaddr_stringify_addr(), ast_verb, manager_displayconnects(), NULL, session, session_destroy(), sessions, unref_mansession(), and VERBOSITY_ATLEAST.

Referenced by purge_old_stuff().

◆ queue_match()

static int queue_match ( const char *  app,
const char *  data,
const char *  search 
)
static

Definition at line 5054 of file manager.c.

5055{
5056 char *parse;
5058 AST_APP_ARG(queuename);
5061 AST_APP_ARG(announceoverride);
5062 AST_APP_ARG(queuetimeoutstr);
5063 AST_APP_ARG(agi);
5064 AST_APP_ARG(gosub);
5066 AST_APP_ARG(position);
5067 );
5068
5069 if (!strcasestr(app, "queue") || ast_strlen_zero(data)) {
5070 return 0;
5071 }
5072
5073 parse = ast_strdupa(data);
5075
5076 /*
5077 * The Queue application is fine unless the AGI parameter is set.
5078 * If it is, we need to check the user's permissions.
5079 */
5080 return !ast_strlen_zero(args.agi);
5081}
static char url[512]

References app, args, AST_APP_ARG, AST_DECLARE_APP_ARGS, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), options, strcasestr(), and url.

◆ queue_read_action_payload()

static int queue_read_action_payload ( struct ast_channel chan,
const unsigned char *  payload,
size_t  payload_size,
enum ast_frame_read_action  action 
)
static

Queue a given read action containing a payload onto a channel.

This queues a READ_ACTION control frame that contains a given "payload", or data to be triggered and handled on the channel's read side. This ensures the "action" is handled by the channel's media reading thread.

Parameters
chanThe channel to queue the action on
payloadThe read action's payload
payload_sizeThe size of the given payload
actionThe type of read action to queue
Return values
-1on error
0on success

Definition at line 3842 of file manager.c.

3844{
3846 size_t obj_size;
3847 int res;
3848
3849 obj_size = payload_size + sizeof(*obj);
3850
3851 obj = ast_malloc(obj_size);
3852 if (!obj) {
3853 return -1;
3854 }
3855
3856 obj->action = action;
3858 memcpy(obj->payload, payload, payload_size);
3859
3860 res = ast_queue_control_data(chan, AST_CONTROL_READ_ACTION, obj, obj_size);
3861
3862 ast_free(obj);
3863 return res;
3864}
int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control, const void *data, size_t datalen)
Queue a control frame with payload.
Definition channel.c:1296
@ AST_CONTROL_READ_ACTION

References ast_control_read_action_payload::action, AST_CONTROL_READ_ACTION, ast_free, ast_malloc, ast_queue_control_data(), ast_control_read_action_payload::payload, and ast_control_read_action_payload::payload_size.

Referenced by queue_sendtext(), and queue_sendtext_data().

◆ queue_sendtext()

static int queue_sendtext ( struct ast_channel chan,
const char *  body 
)
static

Queue a read action to send a text message.

Parameters
chanThe channel to queue the action on
bodyThe body of the message
Return values
-1on error
0on success

Definition at line 3875 of file manager.c.

3876{
3877 return queue_read_action_payload(chan, (const unsigned char *)body,
3878 strlen(body) + 1, AST_FRAME_READ_ACTION_SEND_TEXT);
3879}
static int queue_read_action_payload(struct ast_channel *chan, const unsigned char *payload, size_t payload_size, enum ast_frame_read_action action)
Queue a given read action containing a payload onto a channel.
Definition manager.c:3842
@ AST_FRAME_READ_ACTION_SEND_TEXT

References AST_FRAME_READ_ACTION_SEND_TEXT, and queue_read_action_payload().

Referenced by action_sendtext().

◆ queue_sendtext_data()

static int queue_sendtext_data ( struct ast_channel chan,
const char *  body,
const char *  content_type 
)
static

Queue a read action to send a text data message.

Parameters
chanThe channel to queue the action on
bodyThe body of the message
content_typeThe message's content type
Return values
-1on error
0on success

Definition at line 3891 of file manager.c.

3893{
3894 int res;
3895 struct ast_msg_data *obj;
3896
3898 NULL, NULL, content_type, body);
3899 if (!obj) {
3900 return -1;
3901 }
3902
3903 res = queue_read_action_payload(chan, (const unsigned char *)obj,
3905
3906 ast_free(obj);
3907 return res;
3908}
struct ast_msg_data * ast_msg_data_alloc2(enum ast_msg_data_source_type source_type, const char *to, const char *from, const char *content_type, const char *body)
Allocates an ast_msg_data structure.
size_t ast_msg_data_get_length(struct ast_msg_data *msg)
Get length of the structure.
@ AST_MSG_DATA_SOURCE_TYPE_UNKNOWN
Definition message.h:447
@ AST_FRAME_READ_ACTION_SEND_TEXT_DATA
Structure used to transport a message through the frame core.

References AST_FRAME_READ_ACTION_SEND_TEXT_DATA, ast_free, ast_msg_data_alloc2(), ast_msg_data_get_length(), AST_MSG_DATA_SOURCE_TYPE_UNKNOWN, NULL, and queue_read_action_payload().

Referenced by action_sendtext().

◆ reload_module()

static int reload_module ( void  )
static

Definition at line 10104 of file manager.c.

10105{
10107}
@ AST_MODULE_LOAD_FAILURE
Module could not be loaded properly.
Definition module.h:102
@ AST_MODULE_LOAD_SUCCESS
Definition module.h:70

References __init_manager(), AST_MODULE_LOAD_FAILURE, and AST_MODULE_LOAD_SUCCESS.

Referenced by handle_manager_reload().

◆ report_auth_success()

static void report_auth_success ( const struct mansession s)
static

Definition at line 2189 of file manager.c.

2190{
2191 char session_id[32];
2192 struct ast_security_event_successful_auth successful_auth = {
2195 .common.service = "AMI",
2196 .common.account_id = s->session->username,
2197 .common.session_tv = &s->session->sessionstart_tv,
2198 .common.local_addr = {
2199 .addr = &s->tcptls_session->parent->local_address,
2200 .transport = mansession_get_transport(s),
2201 },
2202 .common.remote_addr = {
2203 .addr = &s->session->addr,
2204 .transport = mansession_get_transport(s),
2205 },
2206 .common.session_id = session_id,
2207 };
2208
2209 snprintf(session_id, sizeof(session_id), "%p", s->session);
2210
2211 ast_security_event_report(AST_SEC_EVT(&successful_auth));
2212}
static enum ast_transport mansession_get_transport(const struct mansession *s)
Definition manager.c:2108
int ast_security_event_report(const struct ast_security_event_common *sec)
Report a security event.
@ AST_SECURITY_EVENT_SUCCESSFUL_AUTH
FYI FWIW, Successful authentication has occurred.
#define AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION
Event descriptor version.
#define AST_SEC_EVT(e)
enum ast_security_event_type event_type
The security event sub-type.
struct ast_security_event_common common
Common security event descriptor elements.
struct ast_sockaddr local_address
Definition tcptls.h:131

References mansession_session::addr, AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_SUCCESSFUL_AUTH, AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION, ast_security_event_successful_auth::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, mansession::session, mansession_session::sessionstart_tv, mansession::tcptls_session, and mansession_session::username.

Referenced by authenticate().

◆ report_failed_acl()

static void report_failed_acl ( const struct mansession s,
const char *  username 
)
static

Definition at line 2139 of file manager.c.

2140{
2141 char session_id[32];
2142 struct ast_security_event_failed_acl failed_acl_event = {
2144 .common.version = AST_SECURITY_EVENT_FAILED_ACL_VERSION,
2145 .common.service = "AMI",
2146 .common.account_id = username,
2147 .common.session_tv = &s->session->sessionstart_tv,
2148 .common.local_addr = {
2149 .addr = &s->tcptls_session->parent->local_address,
2150 .transport = mansession_get_transport(s),
2151 },
2152 .common.remote_addr = {
2153 .addr = &s->session->addr,
2154 .transport = mansession_get_transport(s),
2155 },
2156 .common.session_id = session_id,
2157 };
2158
2159 snprintf(session_id, sizeof(session_id), "%p", s->session);
2160
2161 ast_security_event_report(AST_SEC_EVT(&failed_acl_event));
2162}
#define AST_SECURITY_EVENT_FAILED_ACL_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_FAILED_ACL
Failed ACL.
Checking against an IP access control list failed.
struct ast_security_event_common common
Common security event descriptor elements.

References mansession_session::addr, AST_SEC_EVT, AST_SECURITY_EVENT_FAILED_ACL, AST_SECURITY_EVENT_FAILED_ACL_VERSION, ast_security_event_report(), ast_security_event_failed_acl::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, mansession::session, mansession_session::sessionstart_tv, and mansession::tcptls_session.

Referenced by authenticate().

◆ report_failed_challenge_response()

static void report_failed_challenge_response ( const struct mansession s,
const char *  response,
const char *  expected_response 
)
static

Definition at line 2272 of file manager.c.

2274{
2275 char session_id[32];
2276 struct ast_security_event_chal_resp_failed chal_resp_failed = {
2279 .common.service = "AMI",
2280 .common.account_id = s->session->username,
2281 .common.session_tv = &s->session->sessionstart_tv,
2282 .common.local_addr = {
2283 .addr = &s->tcptls_session->parent->local_address,
2284 .transport = mansession_get_transport(s),
2285 },
2286 .common.remote_addr = {
2287 .addr = &s->session->addr,
2288 .transport = mansession_get_transport(s),
2289 },
2290 .common.session_id = session_id,
2291
2292 .challenge = s->session->challenge,
2293 .response = response,
2294 .expected_response = expected_response,
2295 };
2296
2297 snprintf(session_id, sizeof(session_id), "%p", s->session);
2298
2299 ast_security_event_report(AST_SEC_EVT(&chal_resp_failed));
2300}
#define AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_CHAL_RESP_FAILED
An attempt at challenge/response authentication failed.
An attempt at challenge/response auth failed.
const char * response
Response received.
struct ast_security_event_common common
Common security event descriptor elements.
const char * expected_response
Response expected to be received.

References mansession_session::addr, AST_SEC_EVT, AST_SECURITY_EVENT_CHAL_RESP_FAILED, AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION, ast_security_event_report(), mansession_session::challenge, ast_security_event_chal_resp_failed::common, ast_security_event_common::event_type, ast_security_event_chal_resp_failed::expected_response, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, ast_security_event_chal_resp_failed::response, mansession::session, mansession_session::sessionstart_tv, mansession::tcptls_session, and mansession_session::username.

Referenced by authenticate().

◆ report_inval_password()

static void report_inval_password ( const struct mansession s,
const char *  username 
)
static

Definition at line 2164 of file manager.c.

2165{
2166 char session_id[32];
2167 struct ast_security_event_inval_password inval_password = {
2170 .common.service = "AMI",
2171 .common.account_id = username,
2172 .common.session_tv = &s->session->sessionstart_tv,
2173 .common.local_addr = {
2174 .addr = &s->tcptls_session->parent->local_address,
2175 .transport = mansession_get_transport(s),
2176 },
2177 .common.remote_addr = {
2178 .addr = &s->session->addr,
2179 .transport = mansession_get_transport(s),
2180 },
2181 .common.session_id = session_id,
2182 };
2183
2184 snprintf(session_id, sizeof(session_id), "%p", s->session);
2185
2186 ast_security_event_report(AST_SEC_EVT(&inval_password));
2187}
#define AST_SECURITY_EVENT_INVAL_PASSWORD_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_INVAL_PASSWORD
An attempt at basic password authentication failed.
An attempt at basic password auth failed.
struct ast_security_event_common common
Common security event descriptor elements.

References mansession_session::addr, AST_SEC_EVT, AST_SECURITY_EVENT_INVAL_PASSWORD, AST_SECURITY_EVENT_INVAL_PASSWORD_VERSION, ast_security_event_report(), ast_security_event_inval_password::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, mansession::session, mansession_session::sessionstart_tv, and mansession::tcptls_session.

Referenced by authenticate().

◆ report_invalid_user()

static void report_invalid_user ( const struct mansession s,
const char *  username 
)
static

Definition at line 2114 of file manager.c.

2115{
2116 char session_id[32];
2117 struct ast_security_event_inval_acct_id inval_acct_id = {
2120 .common.service = "AMI",
2121 .common.account_id = username,
2122 .common.session_tv = &s->session->sessionstart_tv,
2123 .common.local_addr = {
2124 .addr = &s->tcptls_session->parent->local_address,
2125 .transport = mansession_get_transport(s),
2126 },
2127 .common.remote_addr = {
2128 .addr = &s->session->addr,
2129 .transport = mansession_get_transport(s),
2130 },
2131 .common.session_id = session_id,
2132 };
2133
2134 snprintf(session_id, sizeof(session_id), "%p", s);
2135
2136 ast_security_event_report(AST_SEC_EVT(&inval_acct_id));
2137}
#define AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_INVAL_ACCT_ID
Invalid Account ID.
Invalid account ID specified (invalid username, for example)
struct ast_security_event_common common
Common security event descriptor elements.

References mansession_session::addr, AST_SEC_EVT, AST_SECURITY_EVENT_INVAL_ACCT_ID, AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION, ast_security_event_report(), ast_security_event_inval_acct_id::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, mansession::session, mansession_session::sessionstart_tv, and mansession::tcptls_session.

Referenced by authenticate().

◆ report_req_bad_format()

static void report_req_bad_format ( const struct mansession s,
const char *  action 
)
static

Definition at line 2243 of file manager.c.

2244{
2245 char session_id[32];
2246 char request_type[64];
2247 struct ast_security_event_req_bad_format req_bad_format = {
2250 .common.service = "AMI",
2251 .common.account_id = s->session->username,
2252 .common.session_tv = &s->session->sessionstart_tv,
2253 .common.local_addr = {
2254 .addr = &s->tcptls_session->parent->local_address,
2255 .transport = mansession_get_transport(s),
2256 },
2257 .common.remote_addr = {
2258 .addr = &s->session->addr,
2259 .transport = mansession_get_transport(s),
2260 },
2261 .common.session_id = session_id,
2262
2263 .request_type = request_type,
2264 };
2265
2266 snprintf(session_id, sizeof(session_id), "%p", s->session);
2267 snprintf(request_type, sizeof(request_type), "Action: %s", action);
2268
2269 ast_security_event_report(AST_SEC_EVT(&req_bad_format));
2270}
#define AST_SECURITY_EVENT_REQ_BAD_FORMAT_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_REQ_BAD_FORMAT
Request received with bad formatting.
Invalid formatting of request.
struct ast_security_event_common common
Common security event descriptor elements.
const char * request_type
Request type that was made.

References mansession_session::addr, AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_REQ_BAD_FORMAT, AST_SECURITY_EVENT_REQ_BAD_FORMAT_VERSION, ast_security_event_req_bad_format::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, ast_security_event_req_not_allowed::request_type, ast_security_event_req_bad_format::request_type, mansession::session, mansession_session::sessionstart_tv, mansession::tcptls_session, and mansession_session::username.

Referenced by process_message().

◆ report_req_not_allowed()

static void report_req_not_allowed ( const struct mansession s,
const char *  action 
)
static

Definition at line 2214 of file manager.c.

2215{
2216 char session_id[32];
2217 char request_type[64];
2218 struct ast_security_event_req_not_allowed req_not_allowed = {
2221 .common.service = "AMI",
2222 .common.account_id = s->session->username,
2223 .common.session_tv = &s->session->sessionstart_tv,
2224 .common.local_addr = {
2225 .addr = &s->tcptls_session->parent->local_address,
2226 .transport = mansession_get_transport(s),
2227 },
2228 .common.remote_addr = {
2229 .addr = &s->session->addr,
2230 .transport = mansession_get_transport(s),
2231 },
2232 .common.session_id = session_id,
2233
2234 .request_type = request_type,
2235 };
2236
2237 snprintf(session_id, sizeof(session_id), "%p", s->session);
2238 snprintf(request_type, sizeof(request_type), "Action: %s", action);
2239
2240 ast_security_event_report(AST_SEC_EVT(&req_not_allowed));
2241}
#define AST_SECURITY_EVENT_REQ_NOT_ALLOWED_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_REQ_NOT_ALLOWED
A request was made that is not allowed.
Request denied because it's not allowed.
struct ast_security_event_common common
Common security event descriptor elements.
const char * request_type
Request type that was made.

References mansession_session::addr, AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_REQ_NOT_ALLOWED, AST_SECURITY_EVENT_REQ_NOT_ALLOWED_VERSION, ast_security_event_req_not_allowed::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, ast_security_event_req_not_allowed::request_type, mansession::session, mansession_session::sessionstart_tv, mansession::tcptls_session, and mansession_session::username.

Referenced by process_message().

◆ report_session_limit()

static void report_session_limit ( const struct mansession s)
static

Definition at line 2302 of file manager.c.

2303{
2304 char session_id[32];
2308 .common.service = "AMI",
2309 .common.account_id = s->session->username,
2310 .common.session_tv = &s->session->sessionstart_tv,
2311 .common.local_addr = {
2312 .addr = &s->tcptls_session->parent->local_address,
2313 .transport = mansession_get_transport(s),
2314 },
2315 .common.remote_addr = {
2316 .addr = &s->session->addr,
2317 .transport = mansession_get_transport(s),
2318 },
2319 .common.session_id = session_id,
2320 };
2321
2322 snprintf(session_id, sizeof(session_id), "%p", s->session);
2323
2325}
static int session_limit
Definition http.c:107
#define AST_SECURITY_EVENT_SESSION_LIMIT_VERSION
Event descriptor version.
@ AST_SECURITY_EVENT_SESSION_LIMIT
Session limit reached.
Request denied because of a session limit.
struct ast_security_event_common common
Common security event descriptor elements.

References mansession_session::addr, AST_SEC_EVT, ast_security_event_report(), AST_SECURITY_EVENT_SESSION_LIMIT, AST_SECURITY_EVENT_SESSION_LIMIT_VERSION, ast_security_event_session_limit::common, ast_security_event_common::event_type, ast_tcptls_session_args::local_address, mansession_get_transport(), ast_tcptls_session_instance::parent, mansession::session, session_limit, mansession_session::sessionstart_tv, mansession::tcptls_session, and mansession_session::username.

Referenced by process_message().

◆ send_string()

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

1855{
1856 struct ast_iostream *stream;
1857 int len, res;
1858
1859 /* It's a result from one of the hook's action invocation */
1860 if (s->hook) {
1861 /*
1862 * to send responses, we're using the same function
1863 * as for receiving events. We call the event "HookResponse"
1864 */
1865 s->hook->helper(EVENT_FLAG_HOOKRESPONSE, "HookResponse", string);
1866 return 0;
1867 }
1868
1869 stream = s->stream ? s->stream : s->session->stream;
1870
1871 len = strlen(string);
1873 res = ast_iostream_write(stream, string, len);
1875
1876 if (res < len) {
1877 s->write_error = 1;
1878 }
1879
1880 return res;
1881}
void ast_iostream_set_timeout_inactivity(struct ast_iostream *stream, int timeout)
Set the iostream inactivity timeout timer.
Definition iostream.c:122
ssize_t ast_iostream_write(struct ast_iostream *stream, const void *buffer, size_t count)
Write data to an iostream.
Definition iostream.c:385
void ast_iostream_set_timeout_disable(struct ast_iostream *stream)
Disable the iostream timeout timer.
Definition iostream.c:114
#define EVENT_FLAG_HOOKRESPONSE
Definition manager.h:89
struct timeval start
Definition iostream.c:41
struct ast_iostream * stream
Definition manager.c:325

References ast_iostream_set_timeout_disable(), ast_iostream_set_timeout_inactivity(), ast_iostream_write(), EVENT_FLAG_HOOKRESPONSE, manager_custom_hook::helper, mansession::hook, len(), mansession::session, ast_iostream::start, mansession_session::stream, mansession::stream, mansession::write_error, and mansession_session::writetimeout.

Referenced by astman_append(), astman_flush(), and process_events().

◆ session_destroy()

static void session_destroy ( struct mansession_session s)
static

Definition at line 1006 of file manager.c.

1007{
1008 struct ao2_container *sessions;
1009
1010 sessions = ao2_global_obj_ref(mgr_sessions);
1011 if (sessions) {
1012 ao2_unlink(sessions, s);
1013 ao2_ref(sessions, -1);
1014 }
1016}
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition astobj2.h:1578

References ao2_global_obj_ref, ao2_ref, ao2_unlink, sessions, and unref_mansession().

Referenced by auth_http_callback(), generic_http_callback(), purge_sessions(), and session_do().

◆ session_destructor()

static void session_destructor ( void *  obj)
static

Definition at line 935 of file manager.c.

936{
937 struct mansession_session *session = obj;
938 struct eventqent *eqe = session->last_ev;
939 struct ast_datastore *datastore;
940
941 /* Get rid of each of the data stores on the session */
942 while ((datastore = AST_LIST_REMOVE_HEAD(&session->datastores, entry))) {
943 /* Free the data store */
944 ast_datastore_free(datastore);
945 }
946
947 if (eqe) {
949 }
950 if (session->chanvars) {
952 }
953
954 if (session->includefilters) {
955 ao2_t_ref(session->includefilters, -1, "decrement ref for include container, should be last one");
956 }
957
958 if (session->excludefilters) {
959 ao2_t_ref(session->excludefilters, -1, "decrement ref for exclude container, should be last one");
960 }
961
962 ast_mutex_destroy(&session->notify_lock);
963}
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition datastore.c:68
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
#define ast_mutex_destroy(a)
Definition lock.h:195
Structure for a data store object.
Definition datastore.h:64
struct ast_datastore::@223 entry

References ao2_t_ref, ast_atomic_fetchadd_int(), ast_datastore_free(), AST_LIST_REMOVE_HEAD, ast_mutex_destroy, ast_variables_destroy(), ast_datastore::entry, session, and eventqent::usecount.

Referenced by build_mansession().

◆ session_do()

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

7367{
7368 struct ast_tcptls_session_instance *ser = data;
7370 struct mansession s = {
7371 .tcptls_session = data,
7372 };
7373 int res;
7374 int arg = 1;
7375 struct ast_sockaddr ser_remote_address_tmp;
7376
7379 goto done;
7380 }
7381
7382 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
7383 session = build_mansession(&ser_remote_address_tmp);
7384
7385 if (session == NULL) {
7387 goto done;
7388 }
7389
7390 /* here we set TCP_NODELAY on the socket to disable Nagle's algorithm.
7391 * This is necessary to prevent delays (caused by buffering) as we
7392 * write to the socket in bits and pieces. */
7393 if (setsockopt(ast_iostream_get_fd(ser->stream), IPPROTO_TCP, TCP_NODELAY, (char *) &arg, sizeof(arg)) < 0) {
7394 ast_log(LOG_WARNING, "Failed to set TCP_NODELAY on manager connection: %s\n", strerror(errno));
7395 }
7397
7399 /* Hook to the tail of the event queue */
7400 session->last_ev = grab_last();
7401
7402 ast_mutex_init(&s.lock);
7403
7404 /* these fields duplicate those in the 'ser' structure */
7405 session->stream = s.stream = ser->stream;
7406 ast_sockaddr_copy(&session->addr, &ser_remote_address_tmp);
7407 s.session = session;
7408
7409 AST_LIST_HEAD_INIT_NOLOCK(&session->datastores);
7410
7411 if(time(&session->authstart) == -1) {
7412 ast_log(LOG_ERROR, "error executing time(): %s; disconnecting client\n", strerror(errno));
7416 goto done;
7417 }
7419
7420 /*
7421 * We cannot let the stream exclusively wait for data to arrive.
7422 * We have to wake up the task to send async events.
7423 */
7425
7427 ast_tvnow(), authtimeout * 1000);
7428
7429 astman_append(&s, "Asterisk Call Manager/%s\r\n", AMI_VERSION); /* welcome prompt */
7430 for (;;) {
7431 if ((res = do_message(&s)) < 0 || s.write_error || session->kicked) {
7432 break;
7433 }
7434 if (session->authenticated) {
7436 }
7437 }
7438 /* session is over, explain why and terminate */
7439 if (session->authenticated) {
7441 ast_verb(2, "Manager '%s' %s from %s\n", session->username, session->kicked ? "kicked" : "logged off", ast_sockaddr_stringify_addr(&session->addr));
7442 }
7443 } else {
7445 if (displayconnects) {
7446 ast_verb(2, "Connect attempt from '%s' unable to authenticate\n", ast_sockaddr_stringify_addr(&session->addr));
7447 }
7448 }
7449
7451
7453done:
7454 ao2_ref(ser, -1);
7455 ser = NULL;
7456 return NULL;
7457}
static struct mansession_session * build_mansession(const struct ast_sockaddr *addr)
Allocate manager session structure and add it to the list of sessions.
Definition manager.c:966
static int do_message(struct mansession *s)
Definition manager.c:7281
static struct eventqent * grab_last(void)
Definition manager.c:694
static int authlimit
Definition manager.c:171
void ast_iostream_set_exclusive_input(struct ast_iostream *stream, int exclusive_input)
Set the iostream if it can exclusively depend upon the set timeouts.
Definition iostream.c:149
void ast_iostream_set_timeout_sequence(struct ast_iostream *stream, struct timeval start, int timeout)
Set the iostream I/O sequence timeout timer.
Definition iostream.c:140
void ast_iostream_nonblock(struct ast_iostream *stream)
Make an iostream non-blocking.
Definition iostream.c:104
#define AST_LIST_HEAD_INIT_NOLOCK(head)
Initializes a list head structure.
Socket address structure.
Definition netsock2.h:97
describes a server instance
Definition tcptls.h:151
struct ast_sockaddr remote_address
Definition tcptls.h:153

References AMI_VERSION, ao2_lock, ao2_ref, ao2_unlock, ast_atomic_fetchadd_int(), ast_iostream_get_fd(), ast_iostream_nonblock(), ast_iostream_set_exclusive_input(), ast_iostream_set_timeout_disable(), ast_iostream_set_timeout_sequence(), AST_LIST_HEAD_INIT_NOLOCK, ast_log, ast_mutex_destroy, ast_mutex_init, ast_sockaddr_copy(), ast_sockaddr_stringify_addr(), ast_tvnow(), ast_verb, astman_append(), authlimit, authtimeout, build_mansession(), displayconnects, do_message(), done, errno, grab_last(), mansession::lock, LOG_ERROR, LOG_WARNING, manager_displayconnects(), NULL, ast_tcptls_session_instance::remote_address, mansession::session, session, session_destroy(), ast_tcptls_session_instance::stream, mansession::stream, mansession::tcptls_session, unauth_sessions, and mansession::write_error.

◆ set_eventmask()

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

2096{
2097 int maskint = strings_to_mask(eventmask);
2098
2099 ao2_lock(s->session);
2100 if (maskint >= 0) {
2101 s->session->send_events = maskint;
2102 }
2103 ao2_unlock(s->session);
2104
2105 return maskint;
2106}
static int strings_to_mask(const char *string)
Definition manager.c:883

References ao2_lock, ao2_unlock, mansession_session::send_events, mansession::session, and strings_to_mask().

Referenced by action_events(), and authenticate().

◆ should_send_event()

static int should_send_event ( struct ao2_container includefilters,
struct ao2_container excludefilters,
struct eventqent eqe 
)
static

Definition at line 5654 of file manager.c.

5656{
5657 int result = 0;
5658
5659 if (manager_debug) {
5660 ast_verbose("<-- Examining AMI event (%u): -->\n%s\n", eqe->event_name_hash, eqe->eventdata);
5661 } else {
5662 ast_debug(4, "Examining AMI event (%u):\n%s\n", eqe->event_name_hash, eqe->eventdata);
5663 }
5664 if (!ao2_container_count(includefilters) && !ao2_container_count(excludefilters)) {
5665 return 1; /* no filtering means match all */
5666 } else if (ao2_container_count(includefilters) && !ao2_container_count(excludefilters)) {
5667 /* include filters only: implied exclude all filter processed first, then include filters */
5668 ao2_t_callback_data(includefilters, OBJ_NODATA, filter_cmp_fn, eqe, &result, "find filter in includefilters container");
5669 return result;
5670 } else if (!ao2_container_count(includefilters) && ao2_container_count(excludefilters)) {
5671 /* exclude filters only: implied include all filter processed first, then exclude filters */
5672 ao2_t_callback_data(excludefilters, OBJ_NODATA, filter_cmp_fn, eqe, &result, "find filter in excludefilters container");
5673 return !result;
5674 } else {
5675 /* include and exclude filters: implied exclude all filter processed first, then include filters, and lastly exclude filters */
5676 ao2_t_callback_data(includefilters, OBJ_NODATA, filter_cmp_fn, eqe, &result, "find filter in session filter container");
5677 if (result) {
5678 result = 0;
5679 ao2_t_callback_data(excludefilters, OBJ_NODATA, filter_cmp_fn, eqe, &result, "find filter in session filter container");
5680 return !result;
5681 }
5682 }
5683
5684 return result;
5685}
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
#define ao2_t_callback_data(container, flags, cb_fn, arg, data, tag)
ao2_callback_data() is a generic function that applies cb_fn() to all objects in a container....
Definition astobj2.h:1721
@ OBJ_NODATA
Definition astobj2.h:1044
static int filter_cmp_fn(void *obj, void *arg, void *data, int flags)
Definition manager.c:5601

References ao2_container_count(), ao2_t_callback_data, ast_debug, ast_verbose, eventqent::event_name_hash, eventqent::eventdata, filter_cmp_fn(), manager_debug, OBJ_NODATA, and result.

Referenced by action_waitevent(), and process_events().

◆ STASIS_MESSAGE_TYPE_DEFN()

STASIS_MESSAGE_TYPE_DEFN ( ast_manager_get_generic_type  )

Define AMI message types.

◆ strings_to_mask()

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

884{
885 const char *p;
886
887 if (ast_strlen_zero(string)) {
888 return -1;
889 }
890
891 for (p = string; *p; p++) {
892 if (*p < '0' || *p > '9') {
893 break;
894 }
895 }
896 if (!*p) { /* all digits */
897 return atoi(string);
898 }
899 if (ast_false(string)) {
900 return 0;
901 }
902 if (ast_true(string)) { /* all permissions */
903 int x, ret = 0;
904 for (x = 0; x < ARRAY_LEN(perms); x++) {
905 ret |= perms[x].num;
906 }
907 return ret;
908 }
909 return get_perm(string);
910}
static int get_perm(const char *instr)
Definition manager.c:862

References ARRAY_LEN, ast_false(), ast_strlen_zero(), ast_true(), get_perm(), permalias::num, and perms.

Referenced by set_eventmask().

◆ unref_mansession()

static struct mansession_session * unref_mansession ( struct mansession_session s)
static

Unreference manager session object. If no more references, then go ahead and delete it.

Definition at line 914 of file manager.c.

915{
916 int refcount = ao2_ref(s, -1);
917 if (manager_debug) {
918 ast_debug(1, "Mansession: %p refcount now %d\n", s, refcount - 1);
919 }
920 return NULL;
921}

References ao2_ref, ast_debug, manager_debug, and NULL.

Referenced by __manager_event_sessions_va(), astman_is_authed(), astman_verify_session_readpermissions(), astman_verify_session_writepermissions(), check_manager_session_inuse(), find_session(), find_session_by_nonce(), generic_http_callback(), handle_kickmanconn(), handle_showmanconn(), purge_sessions(), and session_destroy().

◆ user_authority_to_str()

static const char * user_authority_to_str ( int  authority,
struct ast_str **  res 
)
static

Convert authority code to a list of options for a user. This will only display those authority codes that have an explicit match on authority.

Definition at line 791 of file manager.c.

792{
793 int i;
794 char *sep = "";
795
796 ast_str_reset(*res);
797 for (i = 0; i < ARRAY_LEN(perms) - 1; i++) {
798 if ((authority & perms[i].num) == perms[i].num) {
799 ast_str_append(res, 0, "%s%s", sep, perms[i].label);
800 sep = ",";
801 }
802 }
803
804 if (ast_str_strlen(*res) == 0) {
805 /* replace empty string with something sensible */
806 ast_str_append(res, 0, "<none>");
807 }
808
809 return ast_str_buffer(*res);
810}

References ARRAY_LEN, ast_str_append(), ast_str_buffer(), ast_str_reset(), ast_str_strlen(), permalias::num, and perms.

Referenced by handle_showmanager().

Variable Documentation

◆ acl_change_sub

struct stasis_subscription* acl_change_sub
static

Definition at line 179 of file manager.c.

Referenced by acl_change_stasis_subscribe(), and acl_change_stasis_unsubscribe().

◆ actions

◆ all_events

◆ allowmultiplelogin

int allowmultiplelogin = 1
static

Definition at line 162 of file manager.c.

Referenced by __init_manager(), and handle_manager_show_settings().

◆ authlimit

int authlimit
static

Definition at line 171 of file manager.c.

Referenced by __init_manager(), manager_set_defaults(), and session_do().

◆ authtimeout

int authtimeout
static

Definition at line 170 of file manager.c.

Referenced by __init_manager(), do_message(), get_input(), manager_set_defaults(), and session_do().

◆ broken_events_action

int broken_events_action = 0
static

Definition at line 165 of file manager.c.

Referenced by __init_manager(), action_events(), and manager_set_defaults().

◆ [struct]

const struct { ... } command_blacklist[]
Initial value:
= {
{{ "module", "load", NULL }},
{{ "module", "unload", NULL }},
{{ "restart", "gracefully", NULL }},
}

Referenced by check_blacklist().

◆ displayconnects

int displayconnects = 1
static

◆ global_realm

char global_realm[MAXHOSTNAMELEN]
static

Default realm

Definition at line 176 of file manager.c.

Referenced by __init_manager(), auth_http_callback(), and manager_set_defaults().

◆ httptimeout

int httptimeout = 60
static

◆ live_dangerously

int live_dangerously
static

Set to true (non-zero) to globally allow all dangerous AMI actions to run.

Definition at line 196 of file manager.c.

Referenced by action_createconfig(), astman_live_dangerously(), file_in_modules_dir(), is_restricted_file(), and load_asterisk_conf().

◆ manager_channelvars

char* manager_channelvars
static

Definition at line 172 of file manager.c.

Referenced by handle_manager_show_settings(), load_channelvars(), and manager_shutdown().

◆ manager_debug

int manager_debug = 0
static

◆ manager_disabledevents

char* manager_disabledevents
static

◆ manager_enabled

int manager_enabled = 0
static

◆ manager_hooks

◆ manager_topic

struct stasis_topic* manager_topic
static

◆ match_type_names

char* match_type_names[]
static

Definition at line 394 of file manager.c.

394 {
395 [FILTER_MATCH_REGEX] = "regex",
396 [FILTER_MATCH_EXACT] = "exact",
397 [FILTER_MATCH_STARTS_WITH] = "starts_with",
398 [FILTER_MATCH_ENDS_WITH] = "ends_with",
399 [FILTER_MATCH_CONTAINS] = "contains",
400 [FILTER_MATCH_NONE] = "none",
401};

Referenced by manager_add_filter().

◆ originate_app_permissions

struct originate_permissions_entry originate_app_permissions[]
static

Definition at line 5091 of file manager.c.

5091 {
5092 /*
5093 * The app_match function checks if the search string is
5094 * anywhere in the app parameter. The check is case-insensitive.
5095 */
5096 { "agi", EVENT_FLAG_SYSTEM, app_match },
5097 { "dbdeltree", EVENT_FLAG_SYSTEM, app_match },
5098 { "exec", EVENT_FLAG_SYSTEM, app_match },
5099 { "externalivr", EVENT_FLAG_SYSTEM, app_match },
5100 { "mixmonitor", EVENT_FLAG_SYSTEM, app_match },
5101 { "originate", EVENT_FLAG_SYSTEM, app_match },
5102 { "reload", EVENT_FLAG_SYSTEM, app_match },
5103 { "system", EVENT_FLAG_SYSTEM, app_match },
5104 /*
5105 * Since the queue_match function specifically checks
5106 * for the presence of the AGI parameter, we'll allow
5107 * the call if the user has either the AGI or SYSTEM
5108 * permission.
5109 */
5111 /*
5112 * The appdata_match function checks if the search string is
5113 * anywhere in the appdata parameter. Unlike app_match,
5114 * the check is case-sensitive. These are generally
5115 * dialplan functions.
5116 */
5117 { "CURL", EVENT_FLAG_SYSTEM, appdata_match },
5119 { "EVAL", EVENT_FLAG_SYSTEM, appdata_match },
5120 { "FILE", EVENT_FLAG_SYSTEM, appdata_match },
5121 { "ODBC", EVENT_FLAG_SYSTEM, appdata_match },
5122 { "REALTIME", EVENT_FLAG_SYSTEM, appdata_match },
5123 { "SHELL", EVENT_FLAG_SYSTEM, appdata_match },
5124 { NULL, 0 },
5125};
static int app_match(const char *app, const char *data, const char *search)
Definition manager.c:5015
static int queue_match(const char *app, const char *data, const char *search)
Definition manager.c:5054
static int appdata_match(const char *app, const char *data, const char *search)
Definition manager.c:5034
#define EVENT_FLAG_AGI
Definition manager.h:88

Referenced by is_originate_app_permitted().

◆ perms

const struct permalias perms[]
static

◆ rtp_topic_forwarder

struct stasis_forward* rtp_topic_forwarder
static

The stasis_subscription for forwarding the RTP topic to the AMI topic.

Definition at line 188 of file manager.c.

Referenced by manager_shutdown(), and manager_subscriptions_init().

◆ security_topic_forwarder

struct stasis_forward* security_topic_forwarder
static

The stasis_subscription for forwarding the Security topic to the AMI topic.

Definition at line 191 of file manager.c.

Referenced by manager_shutdown(), and manager_subscriptions_init().

◆ stasis_router

struct stasis_message_router* stasis_router
static

◆ subscribed

int subscribed = 0
static

◆ timestampevents

int timestampevents
static

◆ unauth_sessions

int unauth_sessions = 0
static

Definition at line 178 of file manager.c.

Referenced by action_login(), and session_do().

◆ users

◆ webmanager_enabled

int webmanager_enabled = 0
static

◆ words

const char* words[AST_MAX_CMD_LEN]

Definition at line 222 of file manager.c.