Mon Aug 31 12:30:14 2015

Asterisk developer's documentation


app.h File Reference

Application convenience functions, designed to give consistent look and feel to Asterisk apps. More...

#include "asterisk/strings.h"
#include "asterisk/threadstorage.h"

Go to the source code of this file.

Data Structures

struct  ast_app_option
 A structure to hold the description of an application 'option'. More...
struct  ast_app_stack_funcs
 Stack applications callback functions. More...
struct  ast_ivr_menu
struct  ast_ivr_option

Defines

#define AST_APP_ARG(name)   char *name
 Define an application argument.
#define AST_APP_OPTION(option, flagno)   [option] = { .flag = flagno }
 Declares an application option that does not accept an argument.
#define AST_APP_OPTION_ARG(option, flagno, argno)   [option] = { .flag = flagno, .arg_index = argno + 1 }
 Declares an application option that accepts an argument.
#define AST_APP_OPTIONS(holder, options...)   static const struct ast_app_option holder[128] = options
 Declares an array of options for an application.
#define ast_app_separate_args(a, b, c, d)   __ast_app_separate_args(a,b,1,c,d)
#define AST_DECLARE_APP_ARGS(name, arglist)   AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
 Declare a structure to hold an application's arguments.
#define AST_DEFINE_APP_ARGS_TYPE(type, arglist)
 Define a structure type to hold an application's arguments.
#define AST_IVR_DECLARE_MENU(holder, title, flags, foo...)
#define AST_IVR_FLAG_AUTORESTART   (1 << 0)
#define AST_NONSTANDARD_APP_ARGS(args, parse, sep)   args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
 Performs the 'nonstandard' argument separation process for an application.
#define AST_NONSTANDARD_RAW_ARGS(args, parse, sep)   args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
#define AST_STANDARD_APP_ARGS(args, parse)   args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
 Performs the 'standard' argument separation process for an application.
#define AST_STANDARD_RAW_ARGS(args, parse)   args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
#define BEGIN_OPTIONS   {
#define END_OPTIONS   }

Typedefs

typedef int(* ast_ivr_callback )(struct ast_channel *chan, char *option, void *cbdata)
 Callback function for IVR.

Enumerations

enum  ast_getdata_result {
  AST_GETDATA_FAILED = -1, AST_GETDATA_COMPLETE = 0, AST_GETDATA_TIMEOUT = 1, AST_GETDATA_INTERRUPTED = 2,
  AST_GETDATA_EMPTY_END_TERMINATED = 3
}
enum  ast_ivr_action {
  AST_ACTION_UPONE, AST_ACTION_EXIT, AST_ACTION_CALLBACK, AST_ACTION_PLAYBACK,
  AST_ACTION_BACKGROUND, AST_ACTION_PLAYLIST, AST_ACTION_MENU, AST_ACTION_REPEAT,
  AST_ACTION_RESTART, AST_ACTION_TRANSFER, AST_ACTION_WAITOPTION, AST_ACTION_NOOP,
  AST_ACTION_BACKLIST
}
enum  AST_LOCK_RESULT { AST_LOCK_SUCCESS = 0, AST_LOCK_TIMEOUT = -1, AST_LOCK_PATH_NOT_FOUND = -2, AST_LOCK_FAILURE = -3 }
enum  AST_LOCK_TYPE { AST_LOCK_TYPE_LOCKFILE = 0, AST_LOCK_TYPE_FLOCK = 1 }
 

Type of locking to use in ast_lock_path / ast_unlock_path.

More...
enum  ast_timelen { TIMELEN_HOURS, TIMELEN_MINUTES, TIMELEN_SECONDS, TIMELEN_MILLISECONDS }

Functions

unsigned int __ast_app_separate_args (char *buf, char delim, int remove_chars, char **array, int arraylen)
 Separate a string into arguments in an array.
int ast_app_dtget (struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout)
 Present a dialtone and collect a certain length extension.
int ast_app_exec_macro (struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args)
 Run a macro on a channel, placing an optional second channel into autoservice.
int ast_app_exec_sub (struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup)
 Run a subroutine on a channel, placing an optional second channel into autoservice.
const char * ast_app_expand_sub_args (struct ast_channel *chan, const char *args)
 Add missing context/exten to subroutine argument string.
int ast_app_getdata (struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout)
 Plays a stream and gets DTMF data from a channel.
int ast_app_getdata_full (struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
 Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions.
int ast_app_group_discard (struct ast_channel *chan)
 Discard all group counting for a channel.
int ast_app_group_get_count (const char *group, const char *category)
 Get the current channel count of the specified group and category.
struct ast_group_infoast_app_group_list_head (void)
 Get the head of the group count list.
int ast_app_group_list_rdlock (void)
 Read Lock the group count list.
int ast_app_group_list_unlock (void)
 Unlock the group count list.
int ast_app_group_list_wrlock (void)
 Write Lock the group count list.
int ast_app_group_match_get_count (const char *groupmatch, const char *category)
 Get the current channel count of all groups that match the specified pattern and category.
int ast_app_group_set_channel (struct ast_channel *chan, const char *data)
 Set the group for a channel, splitting the provided data into group and category, if specified.
int ast_app_group_split_group (const char *data, char *group, int group_max, char *category, int category_max)
 Split a group string into group and category, returning a default category if none is provided.
int ast_app_group_update (struct ast_channel *oldchan, struct ast_channel *newchan)
 Update all group counting for a channel to a new one.
int ast_app_has_voicemail (const char *mailbox, const char *folder)
 Determine if a given mailbox has any voicemail If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the number of messages in the "Urgent" folder.
int ast_app_inboxcount (const char *mailbox, int *newmsgs, int *oldmsgs)
 Determine number of new/old messages in a mailbox.
int ast_app_inboxcount2 (const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs)
 Determine number of urgent/new/old messages in a mailbox.
int ast_app_messagecount (const char *context, const char *mailbox, const char *folder)
 Check number of messages in a given context, mailbox, and folder.
void ast_app_options2str64 (const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len)
 Given a list of options array, return an option string based on passed flags.
int ast_app_parse_options (const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
 Parses a string containing application options and sets flags/arguments.
int ast_app_parse_options64 (const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
 Parses a string containing application options and sets flags/arguments.
int ast_app_parse_timelen (const char *timestr, int *result, enum ast_timelen defunit)
 Common routine to parse time lengths, with optional time unit specifier.
int ast_app_run_macro (struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_name, const char *macro_args)
 Run a macro on a channel, placing an optional second channel into autoservice.
int ast_app_run_sub (struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup)
 Run a subroutine on a channel, placing an optional second channel into autoservice.
int ast_app_sayname (struct ast_channel *chan, const char *mailbox, const char *context)
 Given a mailbox and context, play that mailbox owner's name to the channel specified.
void ast_close_fds_above_n (int n)
 Common routine for child processes, to close all fds prior to exec(2).
int ast_control_streamfile (struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms)
 Stream a file with fast forward, pause, reverse, restart.
int ast_dtmf_stream (struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration)
 Send DTMF to a channel.
int ast_get_encoded_char (const char *stream, char *result, size_t *consumed)
 Decode an encoded control or extended ASCII character.
char * ast_get_encoded_str (const char *stream, char *result, size_t result_len)
 Decode a stream of encoded control or extended ASCII characters.
void ast_install_stack_functions (const struct ast_app_stack_funcs *funcs)
 Set stack application function callbacks.
void ast_install_vm_functions (int(*has_voicemail_func)(const char *mailbox, const char *folder), int(*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs), int(*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs), int(*messagecount_func)(const char *context, const char *mailbox, const char *folder), int(*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context))
 Set voicemail function callbacks.
int ast_ivr_menu_run (struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata)
 Runs an IVR menu.
int ast_linear_stream (struct ast_channel *chan, const char *filename, int fd, int allowoverride)
 Stream a filename (or file descriptor) as a generator.
enum AST_LOCK_RESULT ast_lock_path (const char *path)
 Lock a filesystem path.
int ast_play_and_prepend (struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms)
 Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings This function will not play a success message due to post-recording control in the application this was added for.
int ast_play_and_record (struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path)
 Record a file based on input from a channel. Use default accept and cancel DTMF. This function will play "auth-thankyou" upon successful recording.
int ast_play_and_record_full (struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf)
 Record a file based on input from a channel This function will play "auth-thankyou" upon successful recording.
int ast_play_and_wait (struct ast_channel *chan, const char *fn)
 Play a stream and wait for a digit, returning the digit that was pressed.
char * ast_read_textfile (const char *file)
 Read a file into asterisk.
int ast_record_review (struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path)
 Allow to record message and have a review option.
void ast_replace_sigchld (void)
 Replace the SIGCHLD handler.
int ast_safe_fork (int stop_reaper)
 Common routine to safely fork without a chance of a signal handler firing badly in the child.
void ast_safe_fork_cleanup (void)
 Common routine to cleanup after fork'ed process is complete (if reaping was stopped).
int ast_safe_system (const char *s)
 Safely spawn an external program while closing file descriptors.
void ast_set_lock_type (enum AST_LOCK_TYPE type)
 Set the type of locks used by ast_lock_path().
int ast_str_get_encoded_str (struct ast_str **str, int maxlen, const char *stream)
 Decode a stream of encoded control or extended ASCII characters.
 AST_THREADSTORAGE_EXTERNAL (ast_str_thread_global_buf)
void ast_uninstall_vm_functions (void)
int ast_unlock_path (const char *path)
 Unlock a path.
void ast_unreplace_sigchld (void)
 Restore the SIGCHLD handler.

Detailed Description

Application convenience functions, designed to give consistent look and feel to Asterisk apps.

Definition in file app.h.


Define Documentation

#define AST_APP_ARG ( name   )     char *name

Define an application argument.

Parameters:
name The name of the argument

Definition at line 555 of file app.h.

Referenced by acf_curl_helper(), acf_if(), acf_isexten_exec(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_mailbox_exists(), acf_meetme_info(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_transaction_read(), acf_transaction_write(), acf_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), aelsub_exec(), aes_helper(), agi_exec_full(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), ast_eivr_senddtmf(), ast_queue_log(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), build_profile(), calendar_query_exec(), calendar_query_result_exec(), calendar_write_exec(), callerid_read(), cdr_read(), cdr_write(), celgenuserevent_exec(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), cli_odbc_read(), cli_odbc_write(), conf_exec(), confbridge_exec(), config_function_read(), controlplayback_exec(), count_exec(), create_addr(), cut_internal(), determine_starting_point(), dial_exec_full(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enable_jack_hook(), enum_query_read(), enum_result_read(), execif_exec(), extenspy_exec(), festival_exec(), file_count_line(), file_read(), file_write(), filter(), find_conf(), find_realtime_gw(), find_table_cb(), forkcdr_exec(), func_header_read(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldnum_helper(), function_fieldqty_helper(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), function_txtcidname(), gosub_exec(), gosubif_exec(), hash_read(), hash_write(), hint_read(), iconv_read(), import_helper(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), listfilter(), load_values_config(), log_exec(), login_exec(), man_do_variable_value(), math(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), parkandannounce_exec(), parked_call_exec(), pbx_builtin_answer(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), peek_read(), pickupchan_exec(), play_moh_exec(), playback_exec(), pp_each_extension_helper(), pp_each_user_helper(), pqm_exec(), privacy_exec(), process_applicationmap_line(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), queue_function_queuememberpaused(), queue_function_queuememberstatus(), rcvfax_exec(), read_exec(), readexten_exec(), realtimefield_read(), receivefax_exec(), record_exec(), reg_source_db(), regex(), reload_single_member(), replace(), retrydial_exec(), rqm_exec(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), senddtmf_exec(), sendfax_exec(), sendurl_exec(), shared_read(), shared_write(), shift_pop(), sip_acf_channel_read(), sip_parse_register_line(), sip_request_call(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), srv_result_read(), stackpeek_read(), start_moh_exec(), start_monitor_exec(), transfer_exec(), unshift_push(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_check_password_shell(), vm_exec(), vm_execmain(), volume_write(), and zapateller_exec().

#define AST_APP_OPTION ( option,
flagno   )     [option] = { .flag = flagno }

Declares an application option that does not accept an argument.

Parameters:
option The single character representing the option
flagno The flag index to be set if this option is present
See also:
AST_APP_OPTIONS, ast_app_parse_options

Definition at line 721 of file app.h.

#define AST_APP_OPTION_ARG ( option,
flagno,
argno   )     [option] = { .flag = flagno, .arg_index = argno + 1 }

Declares an application option that accepts an argument.

Parameters:
option The single character representing the option
flagno The flag index to be set if this option is present
argno The index into the argument array where the argument should be placed
See also:
AST_APP_OPTIONS, ast_app_parse_options

Definition at line 732 of file app.h.

#define AST_APP_OPTIONS ( holder,
options...   )     static const struct ast_app_option holder[128] = options

Declares an array of options for an application.

Parameters:
holder The name of the array to be created
options The actual options to be placed into the array
See also:
ast_app_parse_options

This macro declares a 'static const' array of struct ast_option elements to hold the list of available options for an application. Each option must be declared using either the AST_APP_OPTION() or AST_APP_OPTION_ARG() macros.

Example usage:

  enum my_app_option_flags {
        OPT_JUMP = (1 << 0),
        OPT_BLAH = (1 << 1),
        OPT_BLORT = (1 << 2),
  };

  enum my_app_option_args {
        OPT_ARG_BLAH = 0,
        OPT_ARG_BLORT,
        !! this entry tells how many possible arguments there are,
           and must be the last entry in the list
        OPT_ARG_ARRAY_SIZE,
  };

  AST_APP_OPTIONS(my_app_options, {
        AST_APP_OPTION('j', OPT_JUMP),
        AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
        AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
  });

  static int my_app_exec(struct ast_channel *chan, void *data)
  {
   char *options;
   struct ast_flags opts = { 0, };
   char *opt_args[OPT_ARG_ARRAY_SIZE];

   ... do any argument parsing here ...

   if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
      return -1;
   }
  }

Definition at line 712 of file app.h.

#define ast_app_separate_args ( a,
b,
c,
 )     __ast_app_separate_args(a,b,1,c,d)
#define AST_DECLARE_APP_ARGS ( name,
arglist   )     AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }

Declare a structure to hold an application's arguments.

Parameters:
name The name of the structure
arglist The list of arguments, defined using AST_APP_ARG

This macro declares a structure intended to be used in a call to ast_app_separate_args(). The structure includes all the arguments specified, plus an argv array that overlays them and an argc argument counter. The arguments must be declared using AST_APP_ARG, and they will all be character pointers (strings).

Note:
The structure is not initialized, as the call to ast_app_separate_args() will perform that function before parsing the arguments.

Definition at line 572 of file app.h.

Referenced by acf_curl_helper(), acf_if(), acf_isexten_exec(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_mailbox_exists(), acf_meetme_info(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_transaction_read(), acf_transaction_write(), acf_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), aelsub_exec(), aes_helper(), agi_exec_full(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), ast_eivr_senddtmf(), ast_queue_log(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), build_profile(), calendar_query_exec(), calendar_query_result_exec(), calendar_write_exec(), callerid_read(), cdr_read(), cdr_write(), celgenuserevent_exec(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), cli_odbc_read(), cli_odbc_write(), conf_exec(), confbridge_exec(), config_function_read(), controlplayback_exec(), count_exec(), create_addr(), cut_internal(), determine_starting_point(), dial_exec_full(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enable_jack_hook(), enum_query_read(), enum_result_read(), execif_exec(), extenspy_exec(), festival_exec(), file_count_line(), file_read(), file_write(), filter(), find_conf(), find_realtime_gw(), find_table_cb(), forkcdr_exec(), func_header_read(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldnum_helper(), function_fieldqty_helper(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), function_txtcidname(), gosub_exec(), gosubif_exec(), hash_read(), hash_write(), hint_read(), iconv_read(), import_helper(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), listfilter(), load_values_config(), log_exec(), login_exec(), man_do_variable_value(), math(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), parkandannounce_exec(), parked_call_exec(), pbx_builtin_answer(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), peek_read(), pickupchan_exec(), play_moh_exec(), playback_exec(), pp_each_extension_helper(), pp_each_user_helper(), pqm_exec(), privacy_exec(), process_applicationmap_line(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), queue_function_queuememberpaused(), queue_function_queuememberstatus(), rcvfax_exec(), read_exec(), readexten_exec(), realtimefield_read(), receivefax_exec(), record_exec(), reg_source_db(), regex(), reload_single_member(), replace(), retrydial_exec(), rqm_exec(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), senddtmf_exec(), sendfax_exec(), sendurl_exec(), shared_read(), shared_write(), shift_pop(), sip_acf_channel_read(), sip_parse_register_line(), sip_request_call(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), srv_result_read(), stackpeek_read(), start_moh_exec(), start_monitor_exec(), transfer_exec(), unshift_push(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_check_password_shell(), vm_exec(), vm_execmain(), volume_write(), and zapateller_exec().

#define AST_DEFINE_APP_ARGS_TYPE ( type,
arglist   ) 
Value:
struct type { \
      unsigned int argc; \
      char *argv[0]; \
      arglist \
   }

Define a structure type to hold an application's arguments.

Parameters:
type The name of the structure type
arglist The list of arguments, defined using AST_APP_ARG

This macro defines a structure type intended to be used in a call to ast_app_separate_args(). The structure includes all the arguments specified, plus an argv array that overlays them and an argc argument counter. The arguments must be declared using AST_APP_ARG, and they will all be character pointers (strings).

Note:
This defines a structure type, but does not declare an instance of the structure. That must be done separately.

Definition at line 588 of file app.h.

#define AST_IVR_DECLARE_MENU ( holder,
title,
flags,
foo...   ) 
Value:
static struct ast_ivr_option __options_##holder[] = foo;\
   static struct ast_ivr_menu holder = { title, flags, __options_##holder }

Definition at line 83 of file app.h.

#define AST_IVR_FLAG_AUTORESTART   (1 << 0)

Definition at line 81 of file app.h.

#define AST_NONSTANDARD_APP_ARGS ( args,
parse,
sep   )     args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))

Performs the 'nonstandard' argument separation process for an application.

Parameters:
args An argument structure defined using AST_DECLARE_APP_ARGS
parse A modifiable buffer containing the input to be parsed
sep A nonstandard separator character

This function will separate the input string using the nonstandard argument separator character and fill in the provided structure, including the argc argument counter field.

Definition at line 619 of file app.h.

Referenced by acf_if(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_mailbox_exists(), aji_status_exec(), ast_queue_log(), build_profile(), callerid_read(), callerid_write(), connectedline_read(), connectedline_write(), determine_starting_point(), dialgroup_write(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), misdn_call(), misdn_request(), oss_call(), oss_request(), pbx_builtin_setvar_multiple(), record_exec(), redirecting_read(), redirecting_write(), regex(), sip_request_call(), and vm_check_password_shell().

#define AST_NONSTANDARD_RAW_ARGS ( args,
parse,
sep   )     args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))

Definition at line 621 of file app.h.

Referenced by create_addr(), execif_exec(), gosubif_exec(), reg_source_db(), and sip_parse_register_line().

#define AST_STANDARD_APP_ARGS ( args,
parse   )     args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))

Performs the 'standard' argument separation process for an application.

Parameters:
args An argument structure defined using AST_DECLARE_APP_ARGS
parse A modifiable buffer containing the input to be parsed

This function will separate the input string using the standard argument separator character ',' and fill in the provided structure, including the argc argument counter field.

Definition at line 604 of file app.h.

Referenced by acf_curl_helper(), acf_isexten_exec(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_meetme_info(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_transaction_read(), acf_transaction_write(), acf_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), aes_helper(), agi_exec_full(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), ast_eivr_senddtmf(), ast_masq_park_call_exten(), ast_park_call_exten(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), build_profile(), calendar_query_exec(), calendar_query_result_exec(), calendar_write_exec(), callerid_read(), callerid_write(), cdr_read(), cdr_write(), celgenuserevent_exec(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), cli_odbc_read(), cli_odbc_write(), conf_exec(), confbridge_exec(), config_function_read(), connectedline_write(), controlplayback_exec(), count_exec(), cut_internal(), dial_exec_full(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enable_jack_hook(), enum_query_read(), enum_result_read(), execif_exec(), extenspy_exec(), festival_exec(), file_count_line(), file_read(), file_write(), find_conf(), find_realtime_gw(), find_table_cb(), forkcdr_exec(), func_header_read(), function_enum(), function_fieldnum_helper(), function_fieldqty_helper(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), function_txtcidname(), hash_read(), hash_write(), hint_read(), iconv_read(), import_helper(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), listfilter(), log_exec(), login_exec(), man_do_variable_value(), math(), misdn_check_l2l1(), misdn_facility_exec(), mixmonitor_exec(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), page_exec(), park_call_exec(), parkandannounce_exec(), parked_call_exec(), pbx_builtin_answer(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), pickupchan_exec(), play_moh_exec(), playback_exec(), pp_each_extension_helper(), pp_each_user_helper(), pqm_exec(), privacy_exec(), process_applicationmap_line(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), queue_function_queuememberpaused(), queue_function_queuememberstatus(), rcvfax_exec(), read_exec(), readexten_exec(), realtimefield_read(), receivefax_exec(), record_exec(), redirecting_write(), reload_single_member(), replace(), retrydial_exec(), rqm_exec(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), senddtmf_exec(), sendfax_exec(), sendurl_exec(), shared_read(), shared_write(), shift_pop(), sip_acf_channel_read(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), srv_result_read(), stackpeek_read(), start_moh_exec(), start_monitor_exec(), transfer_exec(), unshift_push(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), volume_write(), xfer_park_call_helper(), and zapateller_exec().

#define AST_STANDARD_RAW_ARGS ( args,
parse   )     args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))

Definition at line 606 of file app.h.

Referenced by aelsub_exec(), filter(), gosub_exec(), load_values_config(), and peek_read().

#define BEGIN_OPTIONS   {

Definition at line 662 of file app.h.

#define END_OPTIONS   }

Definition at line 663 of file app.h.


Typedef Documentation

typedef int(* ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata)

Callback function for IVR.

Returns:
returns 0 on completion, -1 on hangup or digit if interrupted

Definition at line 42 of file app.h.


Enumeration Type Documentation

Enumerator:
AST_GETDATA_FAILED 
AST_GETDATA_COMPLETE 
AST_GETDATA_TIMEOUT 
AST_GETDATA_INTERRUPTED 
AST_GETDATA_EMPTY_END_TERMINATED 

indicates a user terminated empty string rather than an empty string resulting from a timeout or other factors

Definition at line 477 of file app.h.

00477                         {
00478    AST_GETDATA_FAILED = -1,
00479    AST_GETDATA_COMPLETE = 0,
00480    AST_GETDATA_TIMEOUT = 1,
00481    AST_GETDATA_INTERRUPTED = 2,
00482    /*! indicates a user terminated empty string rather than an empty string resulting 
00483     * from a timeout or other factors */
00484    AST_GETDATA_EMPTY_END_TERMINATED = 3,
00485 };

Enumerator:
AST_ACTION_UPONE 

adata is unused

AST_ACTION_EXIT 

adata is the return value for ast_ivr_menu_run if channel was not hungup

AST_ACTION_CALLBACK 

adata is an ast_ivr_callback

AST_ACTION_PLAYBACK 

adata is file to play

AST_ACTION_BACKGROUND 

adata is file to play

AST_ACTION_PLAYLIST 

adata is list of files, separated by ; to play

AST_ACTION_MENU 

adata is a pointer to an ast_ivr_menu

AST_ACTION_REPEAT 

adata is max # of repeats, cast to a pointer

AST_ACTION_RESTART 

adata is like repeat, but resets repeats to 0

AST_ACTION_TRANSFER 

adata is a string with exten

[@context]
AST_ACTION_WAITOPTION 

adata is a timeout, or 0 for defaults

AST_ACTION_NOOP 

adata is unused

AST_ACTION_BACKLIST 

adata is list of files separated by ; allows interruption

Definition at line 44 of file app.h.

00044              {
00045    AST_ACTION_UPONE, /*!< adata is unused */
00046    AST_ACTION_EXIT,  /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
00047    AST_ACTION_CALLBACK, /*!< adata is an ast_ivr_callback */
00048    AST_ACTION_PLAYBACK, /*!< adata is file to play */
00049    AST_ACTION_BACKGROUND,  /*!< adata is file to play */
00050    AST_ACTION_PLAYLIST, /*!< adata is list of files, separated by ; to play */
00051    AST_ACTION_MENU,  /*!< adata is a pointer to an ast_ivr_menu */
00052    AST_ACTION_REPEAT,   /*!< adata is max # of repeats, cast to a pointer */
00053    AST_ACTION_RESTART,  /*!< adata is like repeat, but resets repeats to 0 */
00054    AST_ACTION_TRANSFER, /*!< adata is a string with exten\verbatim[@context]\endverbatim */
00055    AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
00056    AST_ACTION_NOOP,  /*!< adata is unused */
00057    AST_ACTION_BACKLIST, /*!< adata is list of files separated by ; allows interruption */
00058 } ast_ivr_action;

Enumerator:
AST_LOCK_SUCCESS 
AST_LOCK_TIMEOUT 
AST_LOCK_PATH_NOT_FOUND 
AST_LOCK_FAILURE 

Definition at line 487 of file app.h.

00487                      {
00488    AST_LOCK_SUCCESS = 0,
00489    AST_LOCK_TIMEOUT = -1,
00490    AST_LOCK_PATH_NOT_FOUND = -2,
00491    AST_LOCK_FAILURE = -3,
00492 };

Type of locking to use in ast_lock_path / ast_unlock_path.

Enumerator:
AST_LOCK_TYPE_LOCKFILE 
AST_LOCK_TYPE_FLOCK 

Definition at line 495 of file app.h.

00495                    {
00496    AST_LOCK_TYPE_LOCKFILE = 0,
00497    AST_LOCK_TYPE_FLOCK = 1,
00498 };

Enumerator:
TIMELEN_HOURS 
TIMELEN_MINUTES 
TIMELEN_SECONDS 
TIMELEN_MILLISECONDS 

Definition at line 87 of file app.h.

00087                  {
00088    TIMELEN_HOURS,
00089    TIMELEN_MINUTES,
00090    TIMELEN_SECONDS,
00091    TIMELEN_MILLISECONDS,
00092 };


Function Documentation

unsigned int __ast_app_separate_args ( char *  buf,
char  delim,
int  remove_chars,
char **  array,
int  arraylen 
)

Separate a string into arguments in an array.

Parameters:
buf The string to be parsed (this must be a writable copy, as it will be modified)
delim The character to be used to delimit arguments
remove_chars Remove backslashes and quote characters, while parsing
array An array of 'char *' to be filled in with pointers to the found arguments
arraylen The number of elements in the array (i.e. the number of arguments you will accept)

Note: if there are more arguments in the string than the array will hold, the last element of the array will contain the remaining arguments, not separated.

The array will be completely zeroed by this function before it populates any entries.

Returns:
The number of arguments found, or zero if the function arguments are not valid.

Definition at line 1388 of file app.c.

References paren, and quote().

Referenced by ast_app_separate_args().

01389 {
01390    int argc;
01391    char *scan, *wasdelim = NULL;
01392    int paren = 0, quote = 0, bracket = 0;
01393 
01394    if (!array || !arraylen) {
01395       return 0;
01396    }
01397 
01398    memset(array, 0, arraylen * sizeof(*array));
01399 
01400    if (!buf) {
01401       return 0;
01402    }
01403 
01404    scan = buf;
01405 
01406    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
01407       array[argc] = scan;
01408       for (; *scan; scan++) {
01409          if (*scan == '(') {
01410             paren++;
01411          } else if (*scan == ')') {
01412             if (paren) {
01413                paren--;
01414             }
01415          } else if (*scan == '[') {
01416             bracket++;
01417          } else if (*scan == ']') {
01418             if (bracket) {
01419                bracket--;
01420             }
01421          } else if (*scan == '"' && delim != '"') {
01422             quote = quote ? 0 : 1;
01423             if (remove_chars) {
01424                /* Remove quote character from argument */
01425                memmove(scan, scan + 1, strlen(scan));
01426                scan--;
01427             }
01428          } else if (*scan == '\\') {
01429             if (remove_chars) {
01430                /* Literal character, don't parse */
01431                memmove(scan, scan + 1, strlen(scan));
01432             } else {
01433                scan++;
01434             }
01435          } else if ((*scan == delim) && !paren && !quote && !bracket) {
01436             wasdelim = scan;
01437             *scan++ = '\0';
01438             break;
01439          }
01440       }
01441    }
01442 
01443    /* If the last character in the original string was the delimiter, then
01444     * there is one additional argument. */
01445    if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
01446       array[argc++] = scan;
01447    }
01448 
01449    return argc;
01450 }

int ast_app_dtget ( struct ast_channel chan,
const char *  context,
char *  collect,
size_t  size,
int  maxlen,
int  timeout 
)

Present a dialtone and collect a certain length extension.

Returns:
Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
Note:
Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly

Present a dialtone and collect a certain length extension.

Parameters:
chan struct.
context 
collect 
size 
maxlen 
timeout timeout in milliseconds
Returns:
0 if extension does not exist, 1 if extension exists

Definition at line 120 of file app.c.

References ast_exists_extension(), ast_get_indication_tone(), ast_ignore_pattern(), ast_log(), ast_matchmore_extension(), ast_playtones_start(), ast_playtones_stop(), ast_tone_zone_sound_unref(), ast_waitfordigit(), ast_channel::caller, ast_tone_zone_sound::data, ast_pbx::dtimeoutms, ast_party_caller::id, LOG_NOTICE, ast_party_id::number, ast_channel::pbx, S_COR, ast_party_number::str, ast_party_number::valid, and ast_channel::zone.

Referenced by builtin_atxfer(), builtin_blindtransfer(), and grab_transfer().

00121 {
00122    struct ast_tone_zone_sound *ts;
00123    int res = 0, x = 0;
00124 
00125    if (maxlen > size) {
00126       maxlen = size;
00127    }
00128 
00129    if (!timeout) {
00130       if (chan->pbx && chan->pbx->dtimeoutms) {
00131          timeout = chan->pbx->dtimeoutms;
00132       } else {
00133          timeout = 5000;
00134       }
00135    }
00136 
00137    if ((ts = ast_get_indication_tone(chan->zone, "dial"))) {
00138       res = ast_playtones_start(chan, 0, ts->data, 0);
00139       ts = ast_tone_zone_sound_unref(ts);
00140    } else {
00141       ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
00142    }
00143 
00144    for (x = strlen(collect); x < maxlen; ) {
00145       res = ast_waitfordigit(chan, timeout);
00146       if (!ast_ignore_pattern(context, collect)) {
00147          ast_playtones_stop(chan);
00148       }
00149       if (res < 1) {
00150          break;
00151       }
00152       if (res == '#') {
00153          break;
00154       }
00155       collect[x++] = res;
00156       if (!ast_matchmore_extension(chan, context, collect, 1,
00157          S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
00158          break;
00159       }
00160    }
00161 
00162    if (res >= 0) {
00163       res = ast_exists_extension(chan, context, collect, 1,
00164          S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL)) ? 1 : 0;
00165    }
00166 
00167    return res;
00168 }

int ast_app_exec_macro ( struct ast_channel autoservice_chan,
struct ast_channel macro_chan,
const char *  macro_args 
)

Run a macro on a channel, placing an optional second channel into autoservice.

Since:
1.8.30.0
11.0

This is a shorthand method that makes it very easy to run a macro on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:
Absolutely _NO_ channel locks should be held before calling this function.
Parameters:
autoservice_chan A channel to place into autoservice while the macro is run
macro_chan Channel to execute macro on.
macro_args Macro application argument string.
Return values:
0 success
-1 on error

Definition at line 254 of file app.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_debug, ast_log(), ast_channel::context, ast_channel::exten, LOG_WARNING, pbx_exec(), pbx_findapp(), and ast_channel::priority.

Referenced by ast_app_run_macro(), and feature_exec_app().

00255 {
00256    struct ast_app *macro_app;
00257    int res;
00258 
00259    macro_app = pbx_findapp("Macro");
00260    if (!macro_app) {
00261       ast_log(LOG_WARNING,
00262          "Cannot run 'Macro(%s)'.  The application is not available.\n", macro_args);
00263       return -1;
00264    }
00265    if (autoservice_chan) {
00266       ast_autoservice_start(autoservice_chan);
00267    }
00268 
00269    ast_debug(4, "%s Original location: %s,%s,%d\n", macro_chan->name,
00270       macro_chan->context, macro_chan->exten, macro_chan->priority);
00271 
00272    res = pbx_exec(macro_chan, macro_app, macro_args);
00273    ast_debug(4, "Macro exited with status %d\n", res);
00274 
00275    /*
00276     * Assume anything negative from Macro is an error.
00277     * Anything else is success.
00278     */
00279    if (res < 0) {
00280       res = -1;
00281    } else {
00282       res = 0;
00283    }
00284 
00285    ast_debug(4, "%s Ending location: %s,%s,%d\n", macro_chan->name,
00286       macro_chan->context, macro_chan->exten, macro_chan->priority);
00287 
00288    if (autoservice_chan) {
00289       ast_autoservice_stop(autoservice_chan);
00290    }
00291    return res;
00292 }

int ast_app_exec_sub ( struct ast_channel autoservice_chan,
struct ast_channel sub_chan,
const char *  sub_args,
int  ignore_hangup 
)

Run a subroutine on a channel, placing an optional second channel into autoservice.

Since:
1.8.30.0
11

This is a shorthand method that makes it very easy to run a subroutine on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:
Absolutely _NO_ channel locks should be held before calling this function.
Parameters:
autoservice_chan A channel to place into autoservice while the subroutine is run
sub_chan Channel to execute subroutine on.
sub_args Gosub application argument string.
ignore_hangup TRUE if a hangup does not stop execution of the routine.
Return values:
0 success
-1 on error

Definition at line 343 of file app.c.

References app_stack_callbacks, ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_module_ref(), ast_module_unref(), LOG_WARNING, ast_app_stack_funcs::module, and ast_app_stack_funcs::run_sub.

Referenced by ast_app_run_sub(), and feature_exec_app().

00344 {
00345    const struct ast_app_stack_funcs *funcs;
00346    int res;
00347 
00348    funcs = app_stack_callbacks;
00349    if (!funcs || !funcs->run_sub) {
00350       ast_log(LOG_WARNING,
00351          "Cannot run 'Gosub(%s)'.  The app_stack module is not available.\n",
00352          sub_args);
00353       return -1;
00354    }
00355    ast_module_ref(funcs->module);
00356 
00357    if (autoservice_chan) {
00358       ast_autoservice_start(autoservice_chan);
00359    }
00360 
00361    res = funcs->run_sub(sub_chan, sub_args, ignore_hangup);
00362    ast_module_unref(funcs->module);
00363 
00364    if (autoservice_chan) {
00365       ast_autoservice_stop(autoservice_chan);
00366    }
00367    return res;
00368 }

const char* ast_app_expand_sub_args ( struct ast_channel chan,
const char *  args 
)

Add missing context/exten to subroutine argument string.

Since:
1.8.30.0
Parameters:
chan Channel to obtain context/exten.
args Gosub application argument string.

Fills in the optional context and exten from the given channel.

Return values:
New-args Gosub argument string on success. Must be freed.
NULL on error.

Definition at line 324 of file app.c.

References app_stack_callbacks, ast_log(), ast_module_ref(), ast_module_unref(), ast_app_stack_funcs::expand_sub_args, LOG_WARNING, and ast_app_stack_funcs::module.

00325 {
00326    const struct ast_app_stack_funcs *funcs;
00327    const char *new_args;
00328 
00329    funcs = app_stack_callbacks;
00330    if (!funcs || !funcs->expand_sub_args) {
00331       ast_log(LOG_WARNING,
00332          "Cannot expand 'Gosub(%s)' arguments.  The app_stack module is not available.\n",
00333          args);
00334       return NULL;
00335    }
00336    ast_module_ref(funcs->module);
00337 
00338    new_args = funcs->expand_sub_args(chan, args);
00339    ast_module_unref(funcs->module);
00340    return new_args;
00341 }

int ast_app_getdata ( struct ast_channel c,
const char *  prompt,
char *  s,
int  maxlen,
int  timeout 
)

Plays a stream and gets DTMF data from a channel.

Parameters:
c Which channel one is interacting with
prompt File to pass to ast_streamfile (the one that you wish to play). It is also valid for this to be multiple files concatenated by "&". For example, "file1&file2&file3".
s The location where the DTMF data will be stored
maxlen Max Length of the data
timeout Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out.

This function was designed for application programmers for situations where they need to play a message and then get some DTMF data in response to the message. If a digit is pressed during playback, it will immediately break out of the message and continue execution of your code.

Plays a stream and gets DTMF data from a channel.

Parameters:
c The channel to read from
prompt The file to stream to the channel
s The string to read in to. Must be at least the size of your length
maxlen How many digits to read (maximum)
timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for "ludicrous time" (essentially never times out)

Definition at line 178 of file app.c.

References AST_GETDATA_EMPTY_END_TERMINATED, ast_readstring(), ast_strdupa, ast_streamfile(), ast_strlen_zero(), ast_pbx::dtimeoutms, ast_channel::pbx, and ast_pbx::rtimeoutms.

Referenced by auth_exec(), conf_exec(), dictate_exec(), find_conf(), login_exec(), read_exec(), testclient_exec(), testserver_exec(), and vm_exec().

00179 {
00180    int res = 0, to, fto;
00181    char *front, *filename;
00182 
00183    /* XXX Merge with full version? XXX */
00184 
00185    if (maxlen)
00186       s[0] = '\0';
00187 
00188    if (!prompt)
00189       prompt = "";
00190 
00191    filename = ast_strdupa(prompt);
00192    while ((front = strsep(&filename, "&"))) {
00193       if (!ast_strlen_zero(front)) {
00194          res = ast_streamfile(c, front, c->language);
00195          if (res)
00196             continue;
00197       }
00198       if (ast_strlen_zero(filename)) {
00199          /* set timeouts for the last prompt */
00200          fto = c->pbx ? c->pbx->rtimeoutms : 6000;
00201          to = c->pbx ? c->pbx->dtimeoutms : 2000;
00202 
00203          if (timeout > 0) {
00204             fto = to = timeout;
00205          }
00206          if (timeout < 0) {
00207             fto = to = 1000000000;
00208          }
00209       } else {
00210          /* there is more than one prompt, so
00211           * get rid of the long timeout between
00212           * prompts, and make it 50ms */
00213          fto = 50;
00214          to = c->pbx ? c->pbx->dtimeoutms : 2000;
00215       }
00216       res = ast_readstring(c, s, maxlen, to, fto, "#");
00217       if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
00218          return res;
00219       }
00220       if (!ast_strlen_zero(s)) {
00221          return res;
00222       }
00223    }
00224 
00225    return res;
00226 }

int ast_app_getdata_full ( struct ast_channel c,
const char *  prompt,
char *  s,
int  maxlen,
int  timeout,
int  audiofd,
int  ctrlfd 
)

Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions.

Definition at line 231 of file app.c.

References ast_readstring_full(), ast_streamfile(), and ast_strlen_zero().

Referenced by handle_getdata().

00232 {
00233    int res, to = 2000, fto = 6000;
00234 
00235    if (!ast_strlen_zero(prompt)) {
00236       res = ast_streamfile(c, prompt, c->language);
00237       if (res < 0) {
00238          return res;
00239       }
00240    }
00241 
00242    if (timeout > 0) {
00243       fto = to = timeout;
00244    }
00245    if (timeout < 0) {
00246       fto = to = 1000000000;
00247    }
00248 
00249    res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
00250 
00251    return res;
00252 }

int ast_app_group_discard ( struct ast_channel chan  ) 

Discard all group counting for a channel.

Definition at line 1348 of file app.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_group_info::chan.

Referenced by ast_channel_destructor().

01349 {
01350    struct ast_group_info *gi = NULL;
01351 
01352    AST_RWLIST_WRLOCK(&groups);
01353    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01354       if (gi->chan == chan) {
01355          AST_RWLIST_REMOVE_CURRENT(group_list);
01356          ast_free(gi);
01357       }
01358    }
01359    AST_RWLIST_TRAVERSE_SAFE_END;
01360    AST_RWLIST_UNLOCK(&groups);
01361 
01362    return 0;
01363 }

int ast_app_group_get_count ( const char *  group,
const char *  category 
)

Get the current channel count of the specified group and category.

Definition at line 1269 of file app.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strlen_zero(), ast_group_info::category, and ast_group_info::group.

Referenced by group_count_function_read().

01270 {
01271    struct ast_group_info *gi = NULL;
01272    int count = 0;
01273 
01274    if (ast_strlen_zero(group)) {
01275       return 0;
01276    }
01277 
01278    AST_RWLIST_RDLOCK(&groups);
01279    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01280       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01281          count++;
01282       }
01283    }
01284    AST_RWLIST_UNLOCK(&groups);
01285 
01286    return count;
01287 }

struct ast_group_info* ast_app_group_list_head ( void   )  [read]

Get the head of the group count list.

Definition at line 1375 of file app.c.

References AST_RWLIST_FIRST.

Referenced by group_count_function_read(), group_function_read(), group_list_function_read(), and group_show_channels().

01376 {
01377    return AST_RWLIST_FIRST(&groups);
01378 }

int ast_app_group_list_rdlock ( void   ) 

Read Lock the group count list.

Definition at line 1370 of file app.c.

References AST_RWLIST_RDLOCK.

Referenced by group_count_function_read(), group_function_read(), group_list_function_read(), and group_show_channels().

01371 {
01372    return AST_RWLIST_RDLOCK(&groups);
01373 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list.

Definition at line 1380 of file app.c.

References AST_RWLIST_UNLOCK.

Referenced by group_count_function_read(), group_function_read(), group_list_function_read(), and group_show_channels().

01381 {
01382    return AST_RWLIST_UNLOCK(&groups);
01383 }

int ast_app_group_list_wrlock ( void   ) 

Write Lock the group count list.

Definition at line 1365 of file app.c.

References AST_RWLIST_WRLOCK.

01366 {
01367    return AST_RWLIST_WRLOCK(&groups);
01368 }

int ast_app_group_match_get_count ( const char *  groupmatch,
const char *  category 
)

Get the current channel count of all groups that match the specified pattern and category.

Definition at line 1289 of file app.c.

References ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strlen_zero(), ast_group_info::category, ast_group_info::group, LOG_ERROR, and LOG_NOTICE.

Referenced by group_match_count_function_read().

01290 {
01291    struct ast_group_info *gi = NULL;
01292    regex_t regexbuf_group;
01293    regex_t regexbuf_category;
01294    int count = 0;
01295 
01296    if (ast_strlen_zero(groupmatch)) {
01297       ast_log(LOG_NOTICE, "groupmatch empty\n");
01298       return 0;
01299    }
01300 
01301    /* if regex compilation fails, return zero matches */
01302    if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
01303       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
01304       return 0;
01305    }
01306 
01307    if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
01308       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
01309       regfree(&regexbuf_group);
01310       return 0;
01311    }
01312 
01313    AST_RWLIST_RDLOCK(&groups);
01314    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01315       if (!regexec(&regexbuf_group, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !regexec(&regexbuf_category, gi->category, 0, NULL, 0)))) {
01316          count++;
01317       }
01318    }
01319    AST_RWLIST_UNLOCK(&groups);
01320 
01321    regfree(&regexbuf_group);
01322    if (!ast_strlen_zero(category)) {
01323       regfree(&regexbuf_category);
01324    }
01325 
01326    return count;
01327 }

int ast_app_group_set_channel ( struct ast_channel chan,
const char *  data 
)

Set the group for a channel, splitting the provided data into group and category, if specified.

Definition at line 1222 of file app.c.

References ast_app_group_split_group(), AST_RWLIST_INSERT_TAIL, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), calloc, ast_group_info::category, ast_group_info::chan, free, ast_group_info::group, and len().

Referenced by dial_exec_full(), and group_function_write().

01223 {
01224    int res = 0;
01225    char group[80] = "", category[80] = "";
01226    struct ast_group_info *gi = NULL;
01227    size_t len = 0;
01228 
01229    if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
01230       return -1;
01231    }
01232 
01233    /* Calculate memory we will need if this is new */
01234    len = sizeof(*gi) + strlen(group) + 1;
01235    if (!ast_strlen_zero(category)) {
01236       len += strlen(category) + 1;
01237    }
01238 
01239    AST_RWLIST_WRLOCK(&groups);
01240    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01241       if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01242          AST_RWLIST_REMOVE_CURRENT(group_list);
01243          free(gi);
01244          break;
01245       }
01246    }
01247    AST_RWLIST_TRAVERSE_SAFE_END;
01248 
01249    if (ast_strlen_zero(group)) {
01250       /* Enable unsetting the group */
01251    } else if ((gi = calloc(1, len))) {
01252       gi->chan = chan;
01253       gi->group = (char *) gi + sizeof(*gi);
01254       strcpy(gi->group, group);
01255       if (!ast_strlen_zero(category)) {
01256          gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
01257          strcpy(gi->category, category);
01258       }
01259       AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
01260    } else {
01261       res = -1;
01262    }
01263 
01264    AST_RWLIST_UNLOCK(&groups);
01265 
01266    return res;
01267 }

int ast_app_group_split_group ( const char *  data,
char *  group,
int  group_max,
char *  category,
int  category_max 
)

Split a group string into group and category, returning a default category if none is provided.

Definition at line 1195 of file app.c.

References ast_copy_string(), and ast_strlen_zero().

Referenced by ast_app_group_set_channel(), group_count_function_read(), and group_match_count_function_read().

01196 {
01197    int res = 0;
01198    char tmp[256];
01199    char *grp = NULL, *cat = NULL;
01200 
01201    if (!ast_strlen_zero(data)) {
01202       ast_copy_string(tmp, data, sizeof(tmp));
01203       grp = tmp;
01204       if ((cat = strchr(tmp, '@'))) {
01205          *cat++ = '\0';
01206       }
01207    }
01208 
01209    if (!ast_strlen_zero(grp)) {
01210       ast_copy_string(group, grp, group_max);
01211    } else {
01212       *group = '\0';
01213    }
01214 
01215    if (!ast_strlen_zero(cat)) {
01216       ast_copy_string(category, cat, category_max);
01217    }
01218 
01219    return res;
01220 }

int ast_app_group_update ( struct ast_channel oldchan,
struct ast_channel newchan 
)

Update all group counting for a channel to a new one.

Definition at line 1329 of file app.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_group_info::chan.

Referenced by ast_do_masquerade(), and check_bridge().

01330 {
01331    struct ast_group_info *gi = NULL;
01332 
01333    AST_RWLIST_WRLOCK(&groups);
01334    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01335       if (gi->chan == old) {
01336          gi->chan = new;
01337       } else if (gi->chan == new) {
01338          AST_RWLIST_REMOVE_CURRENT(group_list);
01339          ast_free(gi);
01340       }
01341    }
01342    AST_RWLIST_TRAVERSE_SAFE_END;
01343    AST_RWLIST_UNLOCK(&groups);
01344 
01345    return 0;
01346 }

int ast_app_has_voicemail ( const char *  mailbox,
const char *  folder 
)

Determine if a given mailbox has any voicemail If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the number of messages in the "Urgent" folder.

Return values:
1 Mailbox has voicemail
0 No new voicemail in specified mailbox
-1 Failure
Since:
1.0

Definition at line 421 of file app.c.

References ast_has_voicemail_func, and ast_verb.

Referenced by action_mailboxstatus(), has_voicemail(), notify_new_message(), play_dialtone(), poll_mailbox(), run_externnotify(), skinny_register(), and unistim_send_mwi_to_peer().

00422 {
00423    static int warned = 0;
00424    if (ast_has_voicemail_func) {
00425       return ast_has_voicemail_func(mailbox, folder);
00426    }
00427 
00428    if (warned++ % 10 == 0) {
00429       ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
00430    }
00431    return 0;
00432 }

int ast_app_inboxcount ( const char *  mailbox,
int *  newmsgs,
int *  oldmsgs 
)

Determine number of new/old messages in a mailbox.

Since:
1.0
Parameters:
[in] mailbox Mailbox specification in the format mbox[][&mbox2[]][...]
[out] newmsgs Number of messages in the "INBOX" folder. Includes number of messages in the "Urgent" folder, if any.
[out] oldmsgs Number of messages in the "Old" folder.
Return values:
0 Success
-1 Failure

Definition at line 435 of file app.c.

References ast_inboxcount_func, and ast_verb.

Referenced by sip_send_mwi_to_peer(), and update_registry().

00436 {
00437    static int warned = 0;
00438    if (newmsgs) {
00439       *newmsgs = 0;
00440    }
00441    if (oldmsgs) {
00442       *oldmsgs = 0;
00443    }
00444    if (ast_inboxcount_func) {
00445       return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
00446    }
00447 
00448    if (warned++ % 10 == 0) {
00449       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00450    }
00451 
00452    return 0;
00453 }

int ast_app_inboxcount2 ( const char *  mailbox,
int *  urgentmsgs,
int *  newmsgs,
int *  oldmsgs 
)

Determine number of urgent/new/old messages in a mailbox.

Parameters:
[in] mailbox the mailbox context to use
[out] urgentmsgs the urgent message count
[out] newmsgs the new message count
[out] oldmsgs the old message count
Returns:
Returns 0 for success, negative upon error
Since:
1.6.1

Definition at line 455 of file app.c.

References ast_inboxcount2_func, and ast_verb.

Referenced by action_mailboxcount(), notify_new_message(), and vm_execmain().

00456 {
00457    static int warned = 0;
00458    if (newmsgs) {
00459       *newmsgs = 0;
00460    }
00461    if (oldmsgs) {
00462       *oldmsgs = 0;
00463    }
00464    if (urgentmsgs) {
00465       *urgentmsgs = 0;
00466    }
00467    if (ast_inboxcount2_func) {
00468       return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
00469    }
00470 
00471    if (warned++ % 10 == 0) {
00472       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00473    }
00474 
00475    return 0;
00476 }

int ast_app_messagecount ( const char *  context,
const char *  mailbox,
const char *  folder 
)

Check number of messages in a given context, mailbox, and folder.

Since:
1.4
Parameters:
[in] context Mailbox context
[in] mailbox Mailbox number
[in] folder Mailbox folder
Returns:
Number of messages in the given context, mailbox, and folder. If folder is NULL, folder "INBOX" is assumed. If folder is "INBOX", includes number of messages in the "Urgent" folder.

Definition at line 486 of file app.c.

References ast_messagecount_func, and ast_verb.

Referenced by acf_vmcount_exec().

00487 {
00488    static int warned = 0;
00489    if (ast_messagecount_func) {
00490       return ast_messagecount_func(context, mailbox, folder);
00491    }
00492 
00493    if (!warned) {
00494       warned++;
00495       ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
00496    }
00497 
00498    return 0;
00499 }

void ast_app_options2str64 ( const struct ast_app_option options,
struct ast_flags64 flags,
char *  buf,
size_t  len 
)

Given a list of options array, return an option string based on passed flags.

Parameters:
options The array of possible options declared with AST_APP_OPTIONS
flags The flags of the options that you wish to populate the buffer with
buf The buffer to fill with the string of options
len The maximum length of buf

Definition at line 2111 of file app.c.

References ast_test_flag64.

02112 {
02113    unsigned int i, found = 0;
02114    for (i = 32; i < 128 && found < len; i++) {
02115       if (ast_test_flag64(flags, options[i].flag)) {
02116          buf[found++] = i;
02117       }
02118    }
02119    buf[found] = '\0';
02120 }

int ast_app_parse_options ( const struct ast_app_option options,
struct ast_flags flags,
char **  args,
char *  optstr 
)

Parses a string containing application options and sets flags/arguments.

Parameters:
options The array of possible options declared with AST_APP_OPTIONS
flags The flag structure to have option flags set
args The array of argument pointers to hold arguments found
optstr The string containing the options to be parsed
Returns:
zero for success, non-zero if an error occurs
See also:
AST_APP_OPTIONS

Definition at line 2101 of file app.c.

References parse_options().

Referenced by app_exec(), auth_exec(), bridge_exec(), cdr_read(), cdr_write(), chanspy_exec(), confbridge_exec(), connectedline_write(), controlplayback_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundifunc_read(), extenspy_exec(), forkcdr_exec(), handle_options(), hint_read(), minivm_accmess_exec(), minivm_greet_exec(), minivm_record_exec(), mixmonitor_exec(), page_exec(), park_call_exec(), pbx_builtin_background(), pbx_builtin_resetcdr(), pbx_builtin_waitexten(), read_exec(), readexten_exec(), realtime_common(), receivefax_exec(), record_exec(), redirecting_write(), sendfax_exec(), sendurl_exec(), sla_trunk_exec(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_background(), vm_exec(), vm_execmain(), and volume_write().

02102 {
02103    return parse_options(options, flags, args, optstr, 32);
02104 }

int ast_app_parse_options64 ( const struct ast_app_option options,
struct ast_flags64 flags,
char **  args,
char *  optstr 
)

Parses a string containing application options and sets flags/arguments.

Parameters:
options The array of possible options declared with AST_APP_OPTIONS
flags The 64-bit flag structure to have option flags set
args The array of argument pointers to hold arguments found
optstr The string containing the options to be parsed
Returns:
zero for success, non-zero if an error occurs
See also:
AST_APP_OPTIONS

Definition at line 2106 of file app.c.

References parse_options().

Referenced by conf_exec(), dial_exec_full(), and find_conf_realtime().

02107 {
02108    return parse_options(options, flags, args, optstr, 64);
02109 }

int ast_app_parse_timelen ( const char *  timestr,
int *  result,
enum ast_timelen  defunit 
)

Common routine to parse time lengths, with optional time unit specifier.

Parameters:
[in] timestr String to parse
[in] defunit Default unit type
[out] result Resulting value, specified in milliseconds
Return values:
0 Success
-1 Failure
Since:
1.8

Definition at line 2311 of file app.c.

References FMT, TIMELEN_HOURS, TIMELEN_MILLISECONDS, TIMELEN_MINUTES, and TIMELEN_SECONDS.

Referenced by ast_eivr_senddtmf(), pbx_builtin_wait(), pbx_builtin_waitexten(), and senddtmf_exec().

02312 {
02313    int res;
02314    char u[10];
02315 #ifdef HAVE_LONG_DOUBLE_WIDER
02316    long double amount;
02317    #define FMT "%30Lf%9s"
02318 #else
02319    double amount;
02320    #define FMT "%30lf%9s"
02321 #endif
02322    if (!timestr) {
02323       return -1;
02324    }
02325 
02326    res = sscanf(timestr, FMT, &amount, u);
02327 
02328    if (res == 0 || res == EOF) {
02329 #undef FMT
02330       return -1;
02331    } else if (res == 2) {
02332       switch (u[0]) {
02333       case 'h':
02334       case 'H':
02335          unit = TIMELEN_HOURS;
02336          break;
02337       case 's':
02338       case 'S':
02339          unit = TIMELEN_SECONDS;
02340          break;
02341       case 'm':
02342       case 'M':
02343          if (toupper(u[1]) == 'S') {
02344             unit = TIMELEN_MILLISECONDS;
02345          } else if (u[1] == '\0') {
02346             unit = TIMELEN_MINUTES;
02347          }
02348          break;
02349       }
02350    }
02351 
02352    switch (unit) {
02353    case TIMELEN_HOURS:
02354       amount *= 60;
02355       /* fall-through */
02356    case TIMELEN_MINUTES:
02357       amount *= 60;
02358       /* fall-through */
02359    case TIMELEN_SECONDS:
02360       amount *= 1000;
02361       /* fall-through */
02362    case TIMELEN_MILLISECONDS:
02363       ;
02364    }
02365    *result = amount > INT_MAX ? INT_MAX : (int) amount;
02366    return 0;
02367 }

int ast_app_run_macro ( struct ast_channel autoservice_chan,
struct ast_channel macro_chan,
const char *  macro_name,
const char *  macro_args 
)

Run a macro on a channel, placing an optional second channel into autoservice.

Since:
1.8

This is a shorthand method that makes it very easy to run a macro on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:
Absolutely _NO_ channel locks should be held before calling this function.
Parameters:
autoservice_chan A channel to place into autoservice while the macro is run
macro_chan Channel to execute macro on.
macro_name The name of the macro to run.
macro_args The arguments to pass to the macro.
Return values:
0 success
-1 on error

Definition at line 294 of file app.c.

References ast_app_exec_macro(), ast_free, ast_malloc, and ast_strlen_zero().

Referenced by ast_channel_connected_line_macro(), ast_channel_redirecting_macro(), and generic_recall().

00295 {
00296    int res;
00297    char *args_str;
00298    size_t args_len;
00299 
00300    if (ast_strlen_zero(macro_args)) {
00301       return ast_app_exec_macro(autoservice_chan, macro_chan, macro_name);
00302    }
00303 
00304    /* Create the Macro application argument string. */
00305    args_len = strlen(macro_name) + strlen(macro_args) + 2;
00306    args_str = ast_malloc(args_len);
00307    if (!args_str) {
00308       return -1;
00309    }
00310    snprintf(args_str, args_len, "%s,%s", macro_name, macro_args);
00311 
00312    res = ast_app_exec_macro(autoservice_chan, macro_chan, args_str);
00313    ast_free(args_str);
00314    return res;
00315 }

int ast_app_run_sub ( struct ast_channel autoservice_chan,
struct ast_channel sub_chan,
const char *  sub_location,
const char *  sub_args,
int  ignore_hangup 
)

Run a subroutine on a channel, placing an optional second channel into autoservice.

Since:
1.8.30.0
11

This is a shorthand method that makes it very easy to run a subroutine on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:
Absolutely _NO_ channel locks should be held before calling this function.
Parameters:
autoservice_chan A channel to place into autoservice while the subroutine is run
sub_chan Channel to execute subroutine on.
sub_location The location of the subroutine to run.
sub_args The arguments to pass to the subroutine.
ignore_hangup TRUE if a hangup does not stop execution of the routine.
Return values:
0 success
-1 on error

Definition at line 370 of file app.c.

References ast_app_exec_sub(), ast_free, ast_malloc, and ast_strlen_zero().

00371 {
00372    int res;
00373    char *args_str;
00374    size_t args_len;
00375 
00376    if (ast_strlen_zero(sub_args)) {
00377       return ast_app_exec_sub(autoservice_chan, sub_chan, sub_location, ignore_hangup);
00378    }
00379 
00380    /* Create the Gosub application argument string. */
00381    args_len = strlen(sub_location) + strlen(sub_args) + 3;
00382    args_str = ast_malloc(args_len);
00383    if (!args_str) {
00384       return -1;
00385    }
00386    snprintf(args_str, args_len, "%s(%s)", sub_location, sub_args);
00387 
00388    res = ast_app_exec_sub(autoservice_chan, sub_chan, args_str, ignore_hangup);
00389    ast_free(args_str);
00390    return res;
00391 }

int ast_app_sayname ( struct ast_channel chan,
const char *  mailbox,
const char *  context 
)

Given a mailbox and context, play that mailbox owner's name to the channel specified.

Parameters:
[in] chan Channel on which to play the name
[in] mailbox Mailbox number from which to retrieve the recording
[in] context Mailbox context from which to locate the mailbox number
Return values:
0 Name played without interruption
dtmf ASCII value of the DTMF which interrupted playback.
-1 Unable to locate mailbox or hangup occurred.
Since:
1.6.1

Definition at line 478 of file app.c.

References ast_sayname_func.

Referenced by common_exec(), and play_mailbox_owner().

00479 {
00480    if (ast_sayname_func) {
00481       return ast_sayname_func(chan, mailbox, context);
00482    }
00483    return -1;
00484 }

void ast_close_fds_above_n ( int  n  ) 

Common routine for child processes, to close all fds prior to exec(2).

Parameters:
[in] n starting file descriptor number for closing all higher file descriptors
Since:
1.6.1

Definition at line 2237 of file app.c.

References closefrom().

Referenced by app_exec(), ast_safe_system(), icesencode(), launch_script(), main(), mp3play(), NBScatplay(), send_waveform_to_fd(), spawn_mp3(), spawn_ras(), and vm_check_password_shell().

02238 {
02239    closefrom(n + 1);
02240 }

int ast_control_streamfile ( struct ast_channel chan,
const char *  file,
const char *  fwd,
const char *  rev,
const char *  stop,
const char *  pause,
const char *  restart,
int  skipms,
long *  offsetms 
)

Stream a file with fast forward, pause, reverse, restart.

Parameters:
chan 
file filename
fwd,rev,stop,pause,restart,skipms,offsetms Before calling this function, set this to be the number of ms to start from the beginning of the file. When the function returns, it will be the number of ms from the beginning where the playback stopped. Pass NULL if you don't care.

Definition at line 683 of file app.c.

References ast_channel::_state, ast_alloca, ast_answer(), ast_debug, ast_seekstream(), AST_STATE_UP, ast_stopstream(), ast_streamfile(), ast_tellstream(), ast_verb, ast_waitfordigit(), ast_waitstream_fr(), and ast_channel::stream.

Referenced by controlplayback_exec(), handle_controlstreamfile(), and wait_file().

00687 {
00688    char *breaks = NULL;
00689    char *end = NULL;
00690    int blen = 2;
00691    int res;
00692    long pause_restart_point = 0;
00693    long offset = 0;
00694 
00695    if (!file) {
00696       return -1;
00697    }
00698    if (offsetms) {
00699       offset = *offsetms * 8; /* XXX Assumes 8kHz */
00700    }
00701 
00702    if (stop) {
00703       blen += strlen(stop);
00704    }
00705    if (suspend) {
00706       blen += strlen(suspend);
00707    }
00708    if (restart) {
00709       blen += strlen(restart);
00710    }
00711 
00712    if (blen > 2) {
00713       breaks = ast_alloca(blen + 1);
00714       breaks[0] = '\0';
00715       if (stop) {
00716          strcat(breaks, stop);
00717       }
00718       if (suspend) {
00719          strcat(breaks, suspend);
00720       }
00721       if (restart) {
00722          strcat(breaks, restart);
00723       }
00724    }
00725    if (chan->_state != AST_STATE_UP) {
00726       res = ast_answer(chan);
00727    }
00728 
00729    if ((end = strchr(file, ':'))) {
00730       if (!strcasecmp(end, ":end")) {
00731          *end = '\0';
00732          end++;
00733       }
00734    }
00735 
00736    for (;;) {
00737       ast_stopstream(chan);
00738       res = ast_streamfile(chan, file, chan->language);
00739       if (!res) {
00740          if (pause_restart_point) {
00741             ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
00742             pause_restart_point = 0;
00743          }
00744          else if (end || offset < 0) {
00745             if (offset == -8) {
00746                offset = 0;
00747             }
00748             ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
00749 
00750             ast_seekstream(chan->stream, offset, SEEK_END);
00751             end = NULL;
00752             offset = 0;
00753          } else if (offset) {
00754             ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
00755             ast_seekstream(chan->stream, offset, SEEK_SET);
00756             offset = 0;
00757          }
00758          res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
00759       }
00760 
00761       if (res < 1) {
00762          break;
00763       }
00764 
00765       /* We go at next loop if we got the restart char */
00766       if (restart && strchr(restart, res)) {
00767          ast_debug(1, "we'll restart the stream here at next loop\n");
00768          pause_restart_point = 0;
00769          continue;
00770       }
00771 
00772       if (suspend && strchr(suspend, res)) {
00773          pause_restart_point = ast_tellstream(chan->stream);
00774          for (;;) {
00775             ast_stopstream(chan);
00776             if (!(res = ast_waitfordigit(chan, 1000))) {
00777                continue;
00778             } else if (res == -1 || strchr(suspend, res) || (stop && strchr(stop, res))) {
00779                break;
00780             }
00781          }
00782          if (res == *suspend) {
00783             res = 0;
00784             continue;
00785          }
00786       }
00787 
00788       if (res == -1) {
00789          break;
00790       }
00791 
00792       /* if we get one of our stop chars, return it to the calling function */
00793       if (stop && strchr(stop, res)) {
00794          break;
00795       }
00796    }
00797 
00798    if (pause_restart_point) {
00799       offset = pause_restart_point;
00800    } else {
00801       if (chan->stream) {
00802          offset = ast_tellstream(chan->stream);
00803       } else {
00804          offset = -8;  /* indicate end of file */
00805       }
00806    }
00807 
00808    if (offsetms) {
00809       *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
00810    }
00811 
00812    /* If we are returning a digit cast it as char */
00813    if (res > 0 || chan->stream) {
00814       res = (char)res;
00815    }
00816 
00817    ast_stopstream(chan);
00818 
00819    return res;
00820 }

int ast_dtmf_stream ( struct ast_channel chan,
struct ast_channel peer,
const char *  digits,
int  between,
unsigned int  duration 
)

Send DTMF to a channel.

Parameters:
chan The channel that will receive the DTMF frames
peer (optional) Peer channel that will be autoserviced while the primary channel is receiving DTMF
digits This is a string of characters representing the DTMF digits to be sent to the channel. Valid characters are "0123456789*#abcdABCD". Note: You can pass arguments 'f' or 'F', if you want to Flash the channel (if supported by the channel), or 'w' to add a 500 millisecond pause to the DTMF sequence.
between This is the number of milliseconds to wait in between each DTMF digit. If zero milliseconds is specified, then the default value of 100 will be used.
duration This is the duration that each DTMF digit should have.

Definition at line 501 of file app.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), AST_CONTROL_FLASH, ast_indicate(), ast_log(), ast_opt_transmit_silence, ast_safe_sleep(), ast_senddigit(), ast_waitfor(), and LOG_WARNING.

Referenced by ast_bridge_call(), ast_eivr_senddtmf(), bridge_channel_dtmf_stream(), dial_exec_full(), handle_cli_misdn_send_digit(), senddtmf_exec(), testclient_exec(), testserver_exec(), and wait_for_answer().

00502 {
00503    const char *ptr;
00504    int res = 0;
00505    struct ast_silence_generator *silgen = NULL;
00506 
00507    if (!between) {
00508       between = 100;
00509    }
00510 
00511    if (peer) {
00512       res = ast_autoservice_start(peer);
00513    }
00514 
00515    if (!res) {
00516       res = ast_waitfor(chan, 100);
00517    }
00518 
00519    /* ast_waitfor will return the number of remaining ms on success */
00520    if (res < 0) {
00521       if (peer) {
00522          ast_autoservice_stop(peer);
00523       }
00524       return res;
00525    }
00526 
00527    if (ast_opt_transmit_silence) {
00528       silgen = ast_channel_start_silence_generator(chan);
00529    }
00530 
00531    for (ptr = digits; *ptr; ptr++) {
00532       if (*ptr == 'w') {
00533          /* 'w' -- wait half a second */
00534          if ((res = ast_safe_sleep(chan, 500))) {
00535             break;
00536          }
00537       } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
00538          /* Character represents valid DTMF */
00539          if (*ptr == 'f' || *ptr == 'F') {
00540             /* ignore return values if not supported by channel */
00541             ast_indicate(chan, AST_CONTROL_FLASH);
00542          } else {
00543             ast_senddigit(chan, *ptr, duration);
00544          }
00545          /* pause between digits */
00546          if ((res = ast_safe_sleep(chan, between))) {
00547             break;
00548          }
00549       } else {
00550          ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
00551       }
00552    }
00553 
00554    if (peer) {
00555       /* Stop autoservice on the peer channel, but don't overwrite any error condition
00556          that has occurred previously while acting on the primary channel */
00557       if (ast_autoservice_stop(peer) && !res) {
00558          res = -1;
00559       }
00560    }
00561 
00562    if (silgen) {
00563       ast_channel_stop_silence_generator(chan, silgen);
00564    }
00565 
00566    return res;
00567 }

int ast_get_encoded_char ( const char *  stream,
char *  result,
size_t *  consumed 
)

Decode an encoded control or extended ASCII character.

Parameters:
[in] stream String to decode
[out] result Decoded character
[out] consumed Number of characters used in stream to encode the character
Return values:
-1 Stream is of zero length
0 Success

Definition at line 2122 of file app.c.

References ast_debug, ast_log(), ast_strlen_zero(), and LOG_ERROR.

Referenced by ast_get_encoded_str(), ast_str_get_encoded_str(), cut_internal(), filter(), function_fieldnum_helper(), function_fieldqty_helper(), replace(), shift_pop(), and unshift_push().

02123 {
02124    int i;
02125    *consumed = 1;
02126    *result = 0;
02127    if (ast_strlen_zero(stream)) {
02128       *consumed = 0;
02129       return -1;
02130    }
02131 
02132    if (*stream == '\\') {
02133       *consumed = 2;
02134       switch (*(stream + 1)) {
02135       case 'n':
02136          *result = '\n';
02137          break;
02138       case 'r':
02139          *result = '\r';
02140          break;
02141       case 't':
02142          *result = '\t';
02143          break;
02144       case 'x':
02145          /* Hexadecimal */
02146          if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
02147             *consumed = 3;
02148             if (*(stream + 2) <= '9') {
02149                *result = *(stream + 2) - '0';
02150             } else if (*(stream + 2) <= 'F') {
02151                *result = *(stream + 2) - 'A' + 10;
02152             } else {
02153                *result = *(stream + 2) - 'a' + 10;
02154             }
02155          } else {
02156             ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
02157             return -1;
02158          }
02159 
02160          if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
02161             *consumed = 4;
02162             *result <<= 4;
02163             if (*(stream + 3) <= '9') {
02164                *result += *(stream + 3) - '0';
02165             } else if (*(stream + 3) <= 'F') {
02166                *result += *(stream + 3) - 'A' + 10;
02167             } else {
02168                *result += *(stream + 3) - 'a' + 10;
02169             }
02170          }
02171          break;
02172       case '0':
02173          /* Octal */
02174          *consumed = 2;
02175          for (i = 2; ; i++) {
02176             if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
02177                (*consumed)++;
02178                ast_debug(5, "result was %d, ", *result);
02179                *result <<= 3;
02180                *result += *(stream + i) - '0';
02181                ast_debug(5, "is now %d\n", *result);
02182             } else {
02183                break;
02184             }
02185          }
02186          break;
02187       default:
02188          *result = *(stream + 1);
02189       }
02190    } else {
02191       *result = *stream;
02192       *consumed = 1;
02193    }
02194    return 0;
02195 }

char* ast_get_encoded_str ( const char *  stream,
char *  result,
size_t  result_len 
)

Decode a stream of encoded control or extended ASCII characters.

Parameters:
[in] stream Encoded string
[out] result Decoded string
[in] result_len Maximum size of the result buffer
Returns:
A pointer to the result string

Definition at line 2197 of file app.c.

References ast_get_encoded_char().

Referenced by listfilter(), mgcp_new(), replace(), sip_addheader(), and sip_new().

02198 {
02199    char *cur = result;
02200    size_t consumed;
02201 
02202    while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
02203       cur++;
02204       stream += consumed;
02205    }
02206    *cur = '\0';
02207    return result;
02208 }

void ast_install_stack_functions ( const struct ast_app_stack_funcs funcs  ) 

Set stack application function callbacks.

Since:
1.8.30.0
11
Parameters:
funcs Stack applications callback functions.

Definition at line 319 of file app.c.

References app_stack_callbacks.

Referenced by load_module(), and unload_module().

00320 {
00321    app_stack_callbacks = funcs;
00322 }

void ast_install_vm_functions ( int(*)(const char *mailbox, const char *folder)  has_voicemail_func,
int(*)(const char *mailbox, int *newmsgs, int *oldmsgs)  inboxcount_func,
int(*)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs)  inboxcount2_func,
int(*)(const char *context, const char *mailbox, const char *folder)  messagecount_func,
int(*)(struct ast_channel *chan, const char *mailbox, const char *context sayname_func 
)

Set voicemail function callbacks.

Parameters:
[in] has_voicemail_func set function pointer
[in] inboxcount2_func set function pointer
[in] sayname_func set function pointer
[in] inboxcount_func set function pointer
[in] messagecount_func set function pointer
Version:
1.6.1 Added inboxcount2_func, sayname_func

Definition at line 399 of file app.c.

References ast_has_voicemail_func, ast_inboxcount2_func, ast_inboxcount_func, ast_messagecount_func, and ast_sayname_func.

Referenced by load_module().

00404 {
00405    ast_has_voicemail_func = has_voicemail_func;
00406    ast_inboxcount_func = inboxcount_func;
00407    ast_inboxcount2_func = inboxcount2_func;
00408    ast_messagecount_func = messagecount_func;
00409    ast_sayname_func = sayname_func;
00410 }

int ast_ivr_menu_run ( struct ast_channel c,
struct ast_ivr_menu menu,
void *  cbdata 
)

Runs an IVR menu.

Returns:
returns 0 on successful completion, -1 on hangup, or -2 on user error in menu

Definition at line 1980 of file app.c.

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01981 {
01982    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01983    /* Hide internal coding */
01984    return res > 0 ? 0 : res;
01985 }

int ast_linear_stream ( struct ast_channel chan,
const char *  filename,
int  fd,
int  allowoverride 
)

Stream a filename (or file descriptor) as a generator.

Definition at line 653 of file app.c.

References linear_state::allowoverride, ast_activate_generator(), ast_calloc, ast_config_AST_DATA_DIR, ast_copy_string(), ast_log(), ast_strlen_zero(), linear_state::autoclose, errno, linear_state::fd, linearstream, and LOG_WARNING.

00654 {
00655    struct linear_state *lin;
00656    char tmpf[256];
00657    int res = -1;
00658    int autoclose = 0;
00659    if (fd < 0) {
00660       if (ast_strlen_zero(filename)) {
00661          return -1;
00662       }
00663       autoclose = 1;
00664       if (filename[0] == '/') {
00665          ast_copy_string(tmpf, filename, sizeof(tmpf));
00666       } else {
00667          snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
00668       }
00669       if ((fd = open(tmpf, O_RDONLY)) < 0) {
00670          ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
00671          return -1;
00672       }
00673    }
00674    if ((lin = ast_calloc(1, sizeof(*lin)))) {
00675       lin->fd = fd;
00676       lin->allowoverride = allowoverride;
00677       lin->autoclose = autoclose;
00678       res = ast_activate_generator(chan, &linearstream, lin);
00679    }
00680    return res;
00681 }

enum AST_LOCK_RESULT ast_lock_path ( const char *  path  ) 

Lock a filesystem path.

Parameters:
path the path to be locked
Returns:
one of AST_LOCK_RESULT values

Definition at line 1652 of file app.c.

References AST_LOCK_FAILURE, ast_lock_path_flock(), ast_lock_path_lockfile(), ast_lock_type, AST_LOCK_TYPE_FLOCK, and AST_LOCK_TYPE_LOCKFILE.

Referenced by ast_module_reload(), and vm_lock_path().

01653 {
01654    enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
01655 
01656    switch (ast_lock_type) {
01657    case AST_LOCK_TYPE_LOCKFILE:
01658       r = ast_lock_path_lockfile(path);
01659       break;
01660    case AST_LOCK_TYPE_FLOCK:
01661       r = ast_lock_path_flock(path);
01662       break;
01663    }
01664 
01665    return r;
01666 }

int ast_play_and_prepend ( struct ast_channel chan,
char *  playfile,
char *  recordfile,
int  maxtime_sec,
char *  fmt,
int *  duration,
int *  sound_duration,
int  beep,
int  silencethreshold,
int  maxsilence_ms 
)

Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings This function will not play a success message due to post-recording control in the application this was added for.

Parameters:
chan the channel being recorded
playfile Filename of sound to play before recording begins
recordfile Filename to save the recording
maxtime_sec Longest possible message length in seconds
fmt string containing all formats to be recorded delimited by '|'
duration pointer to integer for storing length of the recording
sound_duration pointer to integer for storing length of the recording minus all silence
beep whether to play a beep to prompt the recording
silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
Return values:
-1 failure or hangup
'S' Recording ended from silence timeout
't' Recording either exceeded maximum duration or the call was ended via DTMF

Definition at line 1188 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, and default_canceldtmf.

Referenced by vm_forwardoptions().

01189 {
01190    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf, 1);
01191 }

int ast_play_and_record ( struct ast_channel chan,
const char *  playfile,
const char *  recordfile,
int  maxtime_sec,
const char *  fmt,
int *  duration,
int *  sound_duration,
int  silencethreshold,
int  maxsilence_ms,
const char *  path 
)

Record a file based on input from a channel. Use default accept and cancel DTMF. This function will play "auth-thankyou" upon successful recording.

Parameters:
chan the channel being recorded
playfile Filename of sound to play before recording begins
recordfile Filename to save the recording
maxtime_sec Longest possible message length in seconds
fmt string containing all formats to be recorded delimited by '|'
duration pointer to integer for storing length of the recording
sound_duration pointer to integer for storing length of the recording minus all silence
silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
path Optional filesystem path to unlock
Return values:
-1 failure or hangup
'S' Recording ended from silence timeout
't' Recording ended from the message exceeding the maximum duration
dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.

Definition at line 1183 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, and default_canceldtmf.

Referenced by app_exec(), ast_record_review(), conf_run(), and setup_privacy_args().

01184 {
01185    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf, 0);
01186 }

int ast_play_and_record_full ( struct ast_channel chan,
const char *  playfile,
const char *  recordfile,
int  maxtime_sec,
const char *  fmt,
int *  duration,
int *  sound_duration,
int  silencethreshold,
int  maxsilence_ms,
const char *  path,
const char *  acceptdtmf,
const char *  canceldtmf 
)

Record a file based on input from a channel This function will play "auth-thankyou" upon successful recording.

Parameters:
chan the channel being recorded
playfile Filename of sound to play before recording begins
recordfile Filename to save the recording
maxtime_sec Longest possible message length in seconds
fmt string containing all formats to be recorded delimited by '|'
duration pointer to integer for storing length of the recording
sound_duration pointer to integer for storing length of the recording minus all silence
silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
path Optional filesystem path to unlock
acceptdtmf Character of DTMF to end and accept the recording
canceldtmf Character of DTMF to end and cancel the recording
Return values:
-1 failure or hangup
'S' Recording ended from silence timeout
't' Recording ended from the message exceeding the maximum duration
dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.

Definition at line 1178 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, default_canceldtmf, and S_OR.

Referenced by play_record_review().

01179 {
01180    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, S_OR(acceptdtmf, default_acceptdtmf), S_OR(canceldtmf, default_canceldtmf), 0);
01181 }

int ast_play_and_wait ( struct ast_channel chan,
const char *  fn 
)
char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk.

Definition at line 1987 of file app.c.

References ast_free, ast_log(), ast_malloc, errno, and LOG_WARNING.

Referenced by readfile_exec().

01988 {
01989    int fd, count = 0, res;
01990    char *output = NULL;
01991    struct stat filesize;
01992 
01993    if (stat(filename, &filesize) == -1) {
01994       ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
01995       return NULL;
01996    }
01997 
01998    count = filesize.st_size + 1;
01999 
02000    if ((fd = open(filename, O_RDONLY)) < 0) {
02001       ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
02002       return NULL;
02003    }
02004 
02005    if ((output = ast_malloc(count))) {
02006       res = read(fd, output, count - 1);
02007       if (res == count - 1) {
02008          output[res] = '\0';
02009       } else {
02010          ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
02011          ast_free(output);
02012          output = NULL;
02013       }
02014    }
02015 
02016    close(fd);
02017 
02018    return output;
02019 }

int ast_record_review ( struct ast_channel chan,
const char *  playfile,
const char *  recordfile,
int  maxtime,
const char *  fmt,
int *  duration,
const char *  path 
)

Allow to record message and have a review option.

Definition at line 1684 of file app.c.

References AST_DIGIT_ANY, ast_dsp_get_threshold_from_settings(), ast_log(), ast_play_and_record(), ast_play_and_wait(), ast_stream_and_wait(), ast_verb, ast_waitfordigit(), LOG_WARNING, maxsilence, silencethreshold, and THRESHOLD_SILENCE.

Referenced by conf_run().

01685 {
01686    int silencethreshold;
01687    int maxsilence = 0;
01688    int res = 0;
01689    int cmd = 0;
01690    int max_attempts = 3;
01691    int attempts = 0;
01692    int recorded = 0;
01693    int message_exists = 0;
01694    /* Note that urgent and private are for flagging messages as such in the future */
01695 
01696    /* barf if no pointer passed to store duration in */
01697    if (!duration) {
01698       ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
01699       return -1;
01700    }
01701 
01702    cmd = '3';   /* Want to start by recording */
01703 
01704    silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
01705 
01706    while ((cmd >= 0) && (cmd != 't')) {
01707       switch (cmd) {
01708       case '1':
01709          if (!message_exists) {
01710             /* In this case, 1 is to record a message */
01711             cmd = '3';
01712             break;
01713          } else {
01714             ast_stream_and_wait(chan, "vm-msgsaved", "");
01715             cmd = 't';
01716             return res;
01717          }
01718       case '2':
01719          /* Review */
01720          ast_verb(3, "Reviewing the recording\n");
01721          cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
01722          break;
01723       case '3':
01724          message_exists = 0;
01725          /* Record */
01726          ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
01727          recorded = 1;
01728          if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
01729             /* User has hung up, no options to give */
01730             return cmd;
01731          }
01732          if (cmd == '0') {
01733             break;
01734          } else if (cmd == '*') {
01735             break;
01736          } else {
01737             /* If all is well, a message exists */
01738             message_exists = 1;
01739             cmd = 0;
01740          }
01741          break;
01742       case '4':
01743       case '5':
01744       case '6':
01745       case '7':
01746       case '8':
01747       case '9':
01748       case '*':
01749       case '#':
01750          cmd = ast_play_and_wait(chan, "vm-sorry");
01751          break;
01752       default:
01753          if (message_exists) {
01754             cmd = ast_play_and_wait(chan, "vm-review");
01755          } else {
01756             if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
01757                cmd = ast_waitfordigit(chan, 600);
01758             }
01759          }
01760 
01761          if (!cmd) {
01762             cmd = ast_waitfordigit(chan, 6000);
01763          }
01764          if (!cmd) {
01765             attempts++;
01766          }
01767          if (attempts > max_attempts) {
01768             cmd = 't';
01769          }
01770       }
01771    }
01772    if (cmd == 't') {
01773       cmd = 0;
01774    }
01775    return cmd;
01776 }

void ast_replace_sigchld ( void   ) 

Replace the SIGCHLD handler.

Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie processes from forking elsewhere in Asterisk. However, if you want to wait*() on the process to retrieve information about it's exit status, then this signal handler needs to be temporarily replaced.

Code that executes this function *must* call ast_unreplace_sigchld() after it is finished doing the wait*().

Definition at line 1047 of file asterisk.c.

References ast_mutex_lock, ast_mutex_unlock, null_sig_handler, safe_system_level, safe_system_lock, and safe_system_prev_handler.

Referenced by ast_safe_fork(), and ast_safe_system().

01048 {
01049    unsigned int level;
01050 
01051    ast_mutex_lock(&safe_system_lock);
01052    level = safe_system_level++;
01053 
01054    /* only replace the handler if it has not already been done */
01055    if (level == 0) {
01056       sigaction(SIGCHLD, &null_sig_handler, &safe_system_prev_handler);
01057    }
01058 
01059    ast_mutex_unlock(&safe_system_lock);
01060 }

int ast_safe_fork ( int  stop_reaper  ) 

Common routine to safely fork without a chance of a signal handler firing badly in the child.

Parameters:
[in] stop_reaper flag to determine if sigchld handler is replaced or not
Since:
1.6.1

Definition at line 2242 of file app.c.

References ast_calloc, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_pthread_create_background, AST_PTHREADT_NULL, ast_replace_sigchld(), errno, zombie::list, LOG_ERROR, LOG_WARNING, zombie::pid, and shaun_of_the_dead().

Referenced by app_exec(), filestream_destructor(), icesencode(), launch_script(), mp3play(), NBScatplay(), send_waveform_to_fd(), spawn_mp3(), spawn_ras(), and vm_check_password_shell().

02243 {
02244    sigset_t signal_set, old_set;
02245    int pid;
02246 
02247    /* Don't let the default signal handler for children reap our status */
02248    if (stop_reaper) {
02249       ast_replace_sigchld();
02250    }
02251 
02252    sigfillset(&signal_set);
02253    pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
02254 
02255    pid = fork();
02256 
02257    if (pid != 0) {
02258       /* Fork failed or parent */
02259       pthread_sigmask(SIG_SETMASK, &old_set, NULL);
02260       if (!stop_reaper && pid > 0) {
02261          struct zombie *cur = ast_calloc(1, sizeof(*cur));
02262          if (cur) {
02263             cur->pid = pid;
02264             AST_LIST_LOCK(&zombies);
02265             AST_LIST_INSERT_TAIL(&zombies, cur, list);
02266             AST_LIST_UNLOCK(&zombies);
02267             if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
02268                if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
02269                   ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
02270                   shaun_of_the_dead_thread = AST_PTHREADT_NULL;
02271                }
02272             }
02273          }
02274       }
02275       return pid;
02276    } else {
02277       /* Child */
02278 #ifdef HAVE_CAP
02279       cap_t cap = cap_from_text("cap_net_admin-eip");
02280 
02281       if (cap_set_proc(cap)) {
02282          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
02283       }
02284       cap_free(cap);
02285 #endif
02286 
02287       /* Before we unblock our signals, return our trapped signals back to the defaults */
02288       signal(SIGHUP, SIG_DFL);
02289       signal(SIGCHLD, SIG_DFL);
02290       signal(SIGINT, SIG_DFL);
02291       signal(SIGURG, SIG_DFL);
02292       signal(SIGTERM, SIG_DFL);
02293       signal(SIGPIPE, SIG_DFL);
02294       signal(SIGXFSZ, SIG_DFL);
02295 
02296       /* unblock important signal handlers */
02297       if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
02298          ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
02299          _exit(1);
02300       }
02301 
02302       return pid;
02303    }
02304 }

void ast_safe_fork_cleanup ( void   ) 

Common routine to cleanup after fork'ed process is complete (if reaping was stopped).

Since:
1.6.1

Definition at line 2306 of file app.c.

References ast_unreplace_sigchld().

Referenced by agi_exec_full(), and run_ras().

02307 {
02308    ast_unreplace_sigchld();
02309 }

int ast_safe_system ( const char *  s  ) 

Safely spawn an external program while closing file descriptors.

Note:
This replaces the system call in all Asterisk modules

Definition at line 1077 of file asterisk.c.

References ast_close_fds_above_n(), ast_log(), ast_opt_high_priority, ast_replace_sigchld(), ast_set_priority(), ast_unreplace_sigchld(), errno, LOG_WARNING, status, WEXITSTATUS, and WIFEXITED.

Referenced by add_email_attachment(), alarmreceiver_exec(), ast_monitor_stop(), consolehandler(), mixmonitor_thread(), notify_message(), process_text_line(), remoteconsolehandler(), rotate_file(), run_externnotify(), sendmail(), sendpage(), system_exec_helper(), and vm_change_password_shell().

01078 {
01079    pid_t pid;
01080    int res;
01081    struct rusage rusage;
01082    int status;
01083 
01084 #if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
01085    ast_replace_sigchld();
01086 
01087 #ifdef HAVE_WORKING_FORK
01088    pid = fork();
01089 #else
01090    pid = vfork();
01091 #endif
01092 
01093    if (pid == 0) {
01094 #ifdef HAVE_CAP
01095       cap_t cap = cap_from_text("cap_net_admin-eip");
01096 
01097       if (cap_set_proc(cap)) {
01098          /* Careful with order! Logging cannot happen after we close FDs */
01099          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
01100       }
01101       cap_free(cap);
01102 #endif
01103 #ifdef HAVE_WORKING_FORK
01104       if (ast_opt_high_priority)
01105          ast_set_priority(0);
01106       /* Close file descriptors and launch system command */
01107       ast_close_fds_above_n(STDERR_FILENO);
01108 #endif
01109       execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
01110       _exit(1);
01111    } else if (pid > 0) {
01112       for (;;) {
01113          res = wait4(pid, &status, 0, &rusage);
01114          if (res > -1) {
01115             res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
01116             break;
01117          } else if (errno != EINTR)
01118             break;
01119       }
01120    } else {
01121       ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
01122       res = -1;
01123    }
01124 
01125    ast_unreplace_sigchld();
01126 #else /* !defined(HAVE_WORKING_FORK) && !defined(HAVE_WORKING_VFORK) */
01127    res = -1;
01128 #endif
01129 
01130    return res;
01131 }

void ast_set_lock_type ( enum AST_LOCK_TYPE  type  ) 

Set the type of locks used by ast_lock_path().

Parameters:
type the locking type to use

Definition at line 1647 of file app.c.

References ast_lock_type.

Referenced by ast_readconfig().

01648 {
01649    ast_lock_type = type;
01650 }

int ast_str_get_encoded_str ( struct ast_str **  str,
int  maxlen,
const char *  stream 
)

Decode a stream of encoded control or extended ASCII characters.

Definition at line 2210 of file app.c.

References ast_get_encoded_char(), ast_str_buffer(), ast_str_make_space(), ast_str_set(), ast_str_size(), ast_str_update(), and zombie::next.

Referenced by sendtext_exec(), and system_exec_helper().

02211 {
02212    char next, *buf;
02213    size_t offset = 0;
02214    size_t consumed;
02215 
02216    if (strchr(stream, '\\')) {
02217       while (!ast_get_encoded_char(stream, &next, &consumed)) {
02218          if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
02219             ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
02220          }
02221          if (offset + 2 > ast_str_size(*str)) {
02222             break;
02223          }
02224          buf = ast_str_buffer(*str);
02225          buf[offset++] = next;
02226          stream += consumed;
02227       }
02228       buf = ast_str_buffer(*str);
02229       buf[offset++] = '\0';
02230       ast_str_update(*str);
02231    } else {
02232       ast_str_set(str, maxlen, "%s", stream);
02233    }
02234    return 0;
02235 }

AST_THREADSTORAGE_EXTERNAL ( ast_str_thread_global_buf   ) 
void ast_uninstall_vm_functions ( void   ) 

Definition at line 412 of file app.c.

References ast_has_voicemail_func, ast_inboxcount2_func, ast_inboxcount_func, ast_messagecount_func, and ast_sayname_func.

Referenced by unload_module().

00413 {
00414    ast_has_voicemail_func = NULL;
00415    ast_inboxcount_func = NULL;
00416    ast_inboxcount2_func = NULL;
00417    ast_messagecount_func = NULL;
00418    ast_sayname_func = NULL;
00419 }

int ast_unlock_path ( const char *  path  ) 

Unlock a path.

Definition at line 1668 of file app.c.

References ast_lock_type, AST_LOCK_TYPE_FLOCK, AST_LOCK_TYPE_LOCKFILE, ast_unlock_path_flock(), and ast_unlock_path_lockfile().

Referenced by __ast_play_and_record(), access_counter_file(), ast_module_reload(), close_mailbox(), copy_message(), count_messages(), leave_voicemail(), open_mailbox(), resequence_mailbox(), and save_to_folder().

01669 {
01670    int r = 0;
01671 
01672    switch (ast_lock_type) {
01673    case AST_LOCK_TYPE_LOCKFILE:
01674       r = ast_unlock_path_lockfile(path);
01675       break;
01676    case AST_LOCK_TYPE_FLOCK:
01677       r = ast_unlock_path_flock(path);
01678       break;
01679    }
01680 
01681    return r;
01682 }

void ast_unreplace_sigchld ( void   ) 

Restore the SIGCHLD handler.

This function is called after a call to ast_replace_sigchld. It restores the SIGCHLD handler that cleans up any zombie processes.

Definition at line 1062 of file asterisk.c.

References ast_mutex_lock, ast_mutex_unlock, safe_system_level, safe_system_lock, and safe_system_prev_handler.

Referenced by ast_safe_fork_cleanup(), and ast_safe_system().

01063 {
01064    unsigned int level;
01065 
01066    ast_mutex_lock(&safe_system_lock);
01067    level = --safe_system_level;
01068 
01069    /* only restore the handler if we are the last one */
01070    if (level == 0) {
01071       sigaction(SIGCHLD, &safe_system_prev_handler, NULL);
01072    }
01073 
01074    ast_mutex_unlock(&safe_system_lock);
01075 }


Generated on 31 Aug 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1