Tue Aug 20 16:34:41 2013

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_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_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 *const macro_name, const char *const macro_args)
 Run a macro on a channel, placing a 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_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 418 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(), 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 584 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 595 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 575 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 435 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(), 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 451 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 482 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 484 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 467 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(), 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 469 of file app.h.

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

#define BEGIN_OPTIONS   {

Definition at line 525 of file app.h.

#define END_OPTIONS   }

Definition at line 526 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 340 of file app.h.

00340                         {
00341    AST_GETDATA_FAILED = -1,
00342    AST_GETDATA_COMPLETE = 0,
00343    AST_GETDATA_TIMEOUT = 1,
00344    AST_GETDATA_INTERRUPTED = 2,
00345    /*! indicates a user terminated empty string rather than an empty string resulting 
00346     * from a timeout or other factors */
00347    AST_GETDATA_EMPTY_END_TERMINATED = 3,
00348 };

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 350 of file app.h.

00350                      {
00351    AST_LOCK_SUCCESS = 0,
00352    AST_LOCK_TIMEOUT = -1,
00353    AST_LOCK_PATH_NOT_FOUND = -2,
00354    AST_LOCK_FAILURE = -3,
00355 };

Type of locking to use in ast_lock_path / ast_unlock_path.

Enumerator:
AST_LOCK_TYPE_LOCKFILE 
AST_LOCK_TYPE_FLOCK 

Definition at line 358 of file app.h.

00358                    {
00359    AST_LOCK_TYPE_LOCKFILE = 0,
00360    AST_LOCK_TYPE_FLOCK = 1,
00361 };

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 1261 of file app.c.

References paren, and quote().

Referenced by ast_app_separate_args().

01262 {
01263    int argc;
01264    char *scan, *wasdelim = NULL;
01265    int paren = 0, quote = 0, bracket = 0;
01266 
01267    if (!array || !arraylen) {
01268       return 0;
01269    }
01270 
01271    memset(array, 0, arraylen * sizeof(*array));
01272 
01273    if (!buf) {
01274       return 0;
01275    }
01276 
01277    scan = buf;
01278 
01279    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
01280       array[argc] = scan;
01281       for (; *scan; scan++) {
01282          if (*scan == '(') {
01283             paren++;
01284          } else if (*scan == ')') {
01285             if (paren) {
01286                paren--;
01287             }
01288          } else if (*scan == '[') {
01289             bracket++;
01290          } else if (*scan == ']') {
01291             if (bracket) {
01292                bracket--;
01293             }
01294          } else if (*scan == '"' && delim != '"') {
01295             quote = quote ? 0 : 1;
01296             if (remove_chars) {
01297                /* Remove quote character from argument */
01298                memmove(scan, scan + 1, strlen(scan));
01299                scan--;
01300             }
01301          } else if (*scan == '\\') {
01302             if (remove_chars) {
01303                /* Literal character, don't parse */
01304                memmove(scan, scan + 1, strlen(scan));
01305             } else {
01306                scan++;
01307             }
01308          } else if ((*scan == delim) && !paren && !quote && !bracket) {
01309             wasdelim = scan;
01310             *scan++ = '\0';
01311             break;
01312          }
01313       }
01314    }
01315 
01316    /* If the last character in the original string was the delimiter, then
01317     * there is one additional argument. */
01318    if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
01319       array[argc++] = scan;
01320    }
01321 
01322    return argc;
01323 }

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

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

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

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

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 230 of file app.c.

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

Referenced by handle_getdata().

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

int ast_app_group_discard ( struct ast_channel chan  ) 

Discard all group counting for a channel.

Definition at line 1221 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().

01222 {
01223    struct ast_group_info *gi = NULL;
01224 
01225    AST_RWLIST_WRLOCK(&groups);
01226    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01227       if (gi->chan == chan) {
01228          AST_RWLIST_REMOVE_CURRENT(group_list);
01229          ast_free(gi);
01230       }
01231    }
01232    AST_RWLIST_TRAVERSE_SAFE_END;
01233    AST_RWLIST_UNLOCK(&groups);
01234 
01235    return 0;
01236 }

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

01143 {
01144    struct ast_group_info *gi = NULL;
01145    int count = 0;
01146 
01147    if (ast_strlen_zero(group)) {
01148       return 0;
01149    }
01150 
01151    AST_RWLIST_RDLOCK(&groups);
01152    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01153       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01154          count++;
01155       }
01156    }
01157    AST_RWLIST_UNLOCK(&groups);
01158 
01159    return count;
01160 }

struct ast_group_info* ast_app_group_list_head ( void   )  [read]

Get the head of the group count list.

Definition at line 1248 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().

01249 {
01250    return AST_RWLIST_FIRST(&groups);
01251 }

int ast_app_group_list_rdlock ( void   ) 

Read Lock the group count list.

Definition at line 1243 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().

01244 {
01245    return AST_RWLIST_RDLOCK(&groups);
01246 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list.

Definition at line 1253 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().

01254 {
01255    return AST_RWLIST_UNLOCK(&groups);
01256 }

int ast_app_group_list_wrlock ( void   ) 

Write Lock the group count list.

Definition at line 1238 of file app.c.

References AST_RWLIST_WRLOCK.

01239 {
01240    return AST_RWLIST_WRLOCK(&groups);
01241 }

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

01163 {
01164    struct ast_group_info *gi = NULL;
01165    regex_t regexbuf_group;
01166    regex_t regexbuf_category;
01167    int count = 0;
01168 
01169    if (ast_strlen_zero(groupmatch)) {
01170       ast_log(LOG_NOTICE, "groupmatch empty\n");
01171       return 0;
01172    }
01173 
01174    /* if regex compilation fails, return zero matches */
01175    if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
01176       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
01177       return 0;
01178    }
01179 
01180    if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
01181       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
01182       regfree(&regexbuf_group);
01183       return 0;
01184    }
01185 
01186    AST_RWLIST_RDLOCK(&groups);
01187    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01188       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)))) {
01189          count++;
01190       }
01191    }
01192    AST_RWLIST_UNLOCK(&groups);
01193 
01194    regfree(&regexbuf_group);
01195    if (!ast_strlen_zero(category)) {
01196       regfree(&regexbuf_category);
01197    }
01198 
01199    return count;
01200 }

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

01096 {
01097    int res = 0;
01098    char group[80] = "", category[80] = "";
01099    struct ast_group_info *gi = NULL;
01100    size_t len = 0;
01101 
01102    if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
01103       return -1;
01104    }
01105 
01106    /* Calculate memory we will need if this is new */
01107    len = sizeof(*gi) + strlen(group) + 1;
01108    if (!ast_strlen_zero(category)) {
01109       len += strlen(category) + 1;
01110    }
01111 
01112    AST_RWLIST_WRLOCK(&groups);
01113    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01114       if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01115          AST_RWLIST_REMOVE_CURRENT(group_list);
01116          free(gi);
01117          break;
01118       }
01119    }
01120    AST_RWLIST_TRAVERSE_SAFE_END;
01121 
01122    if (ast_strlen_zero(group)) {
01123       /* Enable unsetting the group */
01124    } else if ((gi = calloc(1, len))) {
01125       gi->chan = chan;
01126       gi->group = (char *) gi + sizeof(*gi);
01127       strcpy(gi->group, group);
01128       if (!ast_strlen_zero(category)) {
01129          gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
01130          strcpy(gi->category, category);
01131       }
01132       AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
01133    } else {
01134       res = -1;
01135    }
01136 
01137    AST_RWLIST_UNLOCK(&groups);
01138 
01139    return res;
01140 }

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

01069 {
01070    int res = 0;
01071    char tmp[256];
01072    char *grp = NULL, *cat = NULL;
01073 
01074    if (!ast_strlen_zero(data)) {
01075       ast_copy_string(tmp, data, sizeof(tmp));
01076       grp = tmp;
01077       if ((cat = strchr(tmp, '@'))) {
01078          *cat++ = '\0';
01079       }
01080    }
01081 
01082    if (!ast_strlen_zero(grp)) {
01083       ast_copy_string(group, grp, group_max);
01084    } else {
01085       *group = '\0';
01086    }
01087 
01088    if (!ast_strlen_zero(cat)) {
01089       ast_copy_string(category, cat, category_max);
01090    }
01091 
01092    return res;
01093 }

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

01203 {
01204    struct ast_group_info *gi = NULL;
01205 
01206    AST_RWLIST_WRLOCK(&groups);
01207    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01208       if (gi->chan == old) {
01209          gi->chan = new;
01210       } else if (gi->chan == new) {
01211          AST_RWLIST_REMOVE_CURRENT(group_list);
01212          ast_free(gi);
01213       }
01214    }
01215    AST_RWLIST_TRAVERSE_SAFE_END;
01216    AST_RWLIST_UNLOCK(&groups);
01217 
01218    return 0;
01219 }

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

00304 {
00305    static int warned = 0;
00306    if (ast_has_voicemail_func) {
00307       return ast_has_voicemail_func(mailbox, folder);
00308    }
00309 
00310    if (warned++ % 10 == 0) {
00311       ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
00312    }
00313    return 0;
00314 }

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 317 of file app.c.

References ast_inboxcount_func, and ast_verb.

Referenced by sip_send_mwi_to_peer(), and update_registry().

00318 {
00319    static int warned = 0;
00320    if (newmsgs) {
00321       *newmsgs = 0;
00322    }
00323    if (oldmsgs) {
00324       *oldmsgs = 0;
00325    }
00326    if (ast_inboxcount_func) {
00327       return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
00328    }
00329 
00330    if (warned++ % 10 == 0) {
00331       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00332    }
00333 
00334    return 0;
00335 }

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 337 of file app.c.

References ast_inboxcount2_func, and ast_verb.

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

00338 {
00339    static int warned = 0;
00340    if (newmsgs) {
00341       *newmsgs = 0;
00342    }
00343    if (oldmsgs) {
00344       *oldmsgs = 0;
00345    }
00346    if (urgentmsgs) {
00347       *urgentmsgs = 0;
00348    }
00349    if (ast_inboxcount2_func) {
00350       return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
00351    }
00352 
00353    if (warned++ % 10 == 0) {
00354       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00355    }
00356 
00357    return 0;
00358 }

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 368 of file app.c.

References ast_messagecount_func, and ast_verb.

Referenced by acf_vmcount_exec().

00369 {
00370    static int warned = 0;
00371    if (ast_messagecount_func) {
00372       return ast_messagecount_func(context, mailbox, folder);
00373    }
00374 
00375    if (!warned) {
00376       warned++;
00377       ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
00378    }
00379 
00380    return 0;
00381 }

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 1984 of file app.c.

References ast_test_flag64.

01985 {
01986    unsigned int i, found = 0;
01987    for (i = 32; i < 128 && found < len; i++) {
01988       if (ast_test_flag64(flags, options[i].flag)) {
01989          buf[found++] = i;
01990       }
01991    }
01992    buf[found] = '\0';
01993 }

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

01975 {
01976    return parse_options(options, flags, args, optstr, 32);
01977 }

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 1979 of file app.c.

References parse_options().

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

01980 {
01981    return parse_options(options, flags, args, optstr, 64);
01982 }

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

02185 {
02186    int res;
02187    char u[10];
02188 #ifdef HAVE_LONG_DOUBLE_WIDER
02189    long double amount;
02190    #define FMT "%30Lf%9s"
02191 #else
02192    double amount;
02193    #define FMT "%30lf%9s"
02194 #endif
02195    if (!timestr) {
02196       return -1;
02197    }
02198 
02199    if ((res = sscanf(timestr, FMT, &amount, u)) == 0) {
02200 #undef FMT
02201       return -1;
02202    } else if (res == 2) {
02203       switch (u[0]) {
02204       case 'h':
02205       case 'H':
02206          unit = TIMELEN_HOURS;
02207          break;
02208       case 's':
02209       case 'S':
02210          unit = TIMELEN_SECONDS;
02211          break;
02212       case 'm':
02213       case 'M':
02214          if (toupper(u[1]) == 'S') {
02215             unit = TIMELEN_MILLISECONDS;
02216          } else if (u[1] == '\0') {
02217             unit = TIMELEN_MINUTES;
02218          }
02219          break;
02220       }
02221    }
02222 
02223    switch (unit) {
02224    case TIMELEN_HOURS:
02225       amount *= 60;
02226       /* fall-through */
02227    case TIMELEN_MINUTES:
02228       amount *= 60;
02229       /* fall-through */
02230    case TIMELEN_SECONDS:
02231       amount *= 1000;
02232       /* fall-through */
02233    case TIMELEN_MILLISECONDS:
02234       ;
02235    }
02236    *result = amount > INT_MAX ? INT_MAX : (int) amount;
02237    return 0;
02238 }

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

Run a macro on a channel, placing a 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. It is very important that the autoservice_chan parameter is not locked prior to calling ast_app_run_macro. A deadlock could result, otherwise.
Parameters:
autoservice_chan A channel to place into autoservice while the macro is run
macro_chan The channel to run the 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 failure

Definition at line 253 of file app.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_strlen_zero(), LOG_WARNING, pbx_exec(), pbx_findapp(), and S_OR.

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

00254 {
00255    struct ast_app *macro_app;
00256    int res;
00257    char buf[1024];
00258 
00259    macro_app = pbx_findapp("Macro");
00260    if (!macro_app) {
00261       ast_log(LOG_WARNING, "Cannot run macro '%s' because the 'Macro' application in not available\n", macro_name);
00262       return -1;
00263    }
00264    snprintf(buf, sizeof(buf), "%s%s%s", macro_name, ast_strlen_zero(macro_args) ? "" : ",", S_OR(macro_args, ""));
00265    if (autoservice_chan) {
00266       ast_autoservice_start(autoservice_chan);
00267    }
00268    res = pbx_exec(macro_chan, macro_app, buf);
00269    if (autoservice_chan) {
00270       ast_autoservice_stop(autoservice_chan);
00271    }
00272    return res;
00273 }

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 360 of file app.c.

References ast_sayname_func.

Referenced by common_exec(), and play_mailbox_owner().

00361 {
00362    if (ast_sayname_func) {
00363       return ast_sayname_func(chan, mailbox, context);
00364    }
00365    return -1;
00366 }

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

02111 {
02112    closefrom(n + 1);
02113 }

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

00569 {
00570    char *breaks = NULL;
00571    char *end = NULL;
00572    int blen = 2;
00573    int res;
00574    long pause_restart_point = 0;
00575    long offset = 0;
00576 
00577    if (!file) {
00578       return -1;
00579    }
00580    if (offsetms) {
00581       offset = *offsetms * 8; /* XXX Assumes 8kHz */
00582    }
00583 
00584    if (stop) {
00585       blen += strlen(stop);
00586    }
00587    if (suspend) {
00588       blen += strlen(suspend);
00589    }
00590    if (restart) {
00591       blen += strlen(restart);
00592    }
00593 
00594    if (blen > 2) {
00595       breaks = ast_alloca(blen + 1);
00596       breaks[0] = '\0';
00597       if (stop) {
00598          strcat(breaks, stop);
00599       }
00600       if (suspend) {
00601          strcat(breaks, suspend);
00602       }
00603       if (restart) {
00604          strcat(breaks, restart);
00605       }
00606    }
00607    if (chan->_state != AST_STATE_UP) {
00608       res = ast_answer(chan);
00609    }
00610 
00611    if ((end = strchr(file, ':'))) {
00612       if (!strcasecmp(end, ":end")) {
00613          *end = '\0';
00614          end++;
00615       }
00616    }
00617 
00618    for (;;) {
00619       ast_stopstream(chan);
00620       res = ast_streamfile(chan, file, chan->language);
00621       if (!res) {
00622          if (pause_restart_point) {
00623             ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
00624             pause_restart_point = 0;
00625          }
00626          else if (end || offset < 0) {
00627             if (offset == -8) {
00628                offset = 0;
00629             }
00630             ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
00631 
00632             ast_seekstream(chan->stream, offset, SEEK_END);
00633             end = NULL;
00634             offset = 0;
00635          } else if (offset) {
00636             ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
00637             ast_seekstream(chan->stream, offset, SEEK_SET);
00638             offset = 0;
00639          }
00640          res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
00641       }
00642 
00643       if (res < 1) {
00644          break;
00645       }
00646 
00647       /* We go at next loop if we got the restart char */
00648       if (restart && strchr(restart, res)) {
00649          ast_debug(1, "we'll restart the stream here at next loop\n");
00650          pause_restart_point = 0;
00651          continue;
00652       }
00653 
00654       if (suspend && strchr(suspend, res)) {
00655          pause_restart_point = ast_tellstream(chan->stream);
00656          for (;;) {
00657             ast_stopstream(chan);
00658             if (!(res = ast_waitfordigit(chan, 1000))) {
00659                continue;
00660             } else if (res == -1 || strchr(suspend, res) || (stop && strchr(stop, res))) {
00661                break;
00662             }
00663          }
00664          if (res == *suspend) {
00665             res = 0;
00666             continue;
00667          }
00668       }
00669 
00670       if (res == -1) {
00671          break;
00672       }
00673 
00674       /* if we get one of our stop chars, return it to the calling function */
00675       if (stop && strchr(stop, res)) {
00676          break;
00677       }
00678    }
00679 
00680    if (pause_restart_point) {
00681       offset = pause_restart_point;
00682    } else {
00683       if (chan->stream) {
00684          offset = ast_tellstream(chan->stream);
00685       } else {
00686          offset = -8;  /* indicate end of file */
00687       }
00688    }
00689 
00690    if (offsetms) {
00691       *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
00692    }
00693 
00694    /* If we are returning a digit cast it as char */
00695    if (res > 0 || chan->stream) {
00696       res = (char)res;
00697    }
00698 
00699    ast_stopstream(chan);
00700 
00701    return res;
00702 }

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

00384 {
00385    const char *ptr;
00386    int res = 0;
00387    struct ast_silence_generator *silgen = NULL;
00388 
00389    if (!between) {
00390       between = 100;
00391    }
00392 
00393    if (peer) {
00394       res = ast_autoservice_start(peer);
00395    }
00396 
00397    if (!res) {
00398       res = ast_waitfor(chan, 100);
00399    }
00400 
00401    /* ast_waitfor will return the number of remaining ms on success */
00402    if (res < 0) {
00403       if (peer) {
00404          ast_autoservice_stop(peer);
00405       }
00406       return res;
00407    }
00408 
00409    if (ast_opt_transmit_silence) {
00410       silgen = ast_channel_start_silence_generator(chan);
00411    }
00412 
00413    for (ptr = digits; *ptr; ptr++) {
00414       if (*ptr == 'w') {
00415          /* 'w' -- wait half a second */
00416          if ((res = ast_safe_sleep(chan, 500))) {
00417             break;
00418          }
00419       } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
00420          /* Character represents valid DTMF */
00421          if (*ptr == 'f' || *ptr == 'F') {
00422             /* ignore return values if not supported by channel */
00423             ast_indicate(chan, AST_CONTROL_FLASH);
00424          } else {
00425             ast_senddigit(chan, *ptr, duration);
00426          }
00427          /* pause between digits */
00428          if ((res = ast_safe_sleep(chan, between))) {
00429             break;
00430          }
00431       } else {
00432          ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
00433       }
00434    }
00435 
00436    if (peer) {
00437       /* Stop autoservice on the peer channel, but don't overwrite any error condition
00438          that has occurred previously while acting on the primary channel */
00439       if (ast_autoservice_stop(peer) && !res) {
00440          res = -1;
00441       }
00442    }
00443 
00444    if (silgen) {
00445       ast_channel_stop_silence_generator(chan, silgen);
00446    }
00447 
00448    return res;
00449 }

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

01996 {
01997    int i;
01998    *consumed = 1;
01999    *result = 0;
02000    if (ast_strlen_zero(stream)) {
02001       *consumed = 0;
02002       return -1;
02003    }
02004 
02005    if (*stream == '\\') {
02006       *consumed = 2;
02007       switch (*(stream + 1)) {
02008       case 'n':
02009          *result = '\n';
02010          break;
02011       case 'r':
02012          *result = '\r';
02013          break;
02014       case 't':
02015          *result = '\t';
02016          break;
02017       case 'x':
02018          /* Hexadecimal */
02019          if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
02020             *consumed = 3;
02021             if (*(stream + 2) <= '9') {
02022                *result = *(stream + 2) - '0';
02023             } else if (*(stream + 2) <= 'F') {
02024                *result = *(stream + 2) - 'A' + 10;
02025             } else {
02026                *result = *(stream + 2) - 'a' + 10;
02027             }
02028          } else {
02029             ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
02030             return -1;
02031          }
02032 
02033          if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
02034             *consumed = 4;
02035             *result <<= 4;
02036             if (*(stream + 3) <= '9') {
02037                *result += *(stream + 3) - '0';
02038             } else if (*(stream + 3) <= 'F') {
02039                *result += *(stream + 3) - 'A' + 10;
02040             } else {
02041                *result += *(stream + 3) - 'a' + 10;
02042             }
02043          }
02044          break;
02045       case '0':
02046          /* Octal */
02047          *consumed = 2;
02048          for (i = 2; ; i++) {
02049             if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
02050                (*consumed)++;
02051                ast_debug(5, "result was %d, ", *result);
02052                *result <<= 3;
02053                *result += *(stream + i) - '0';
02054                ast_debug(5, "is now %d\n", *result);
02055             } else {
02056                break;
02057             }
02058          }
02059          break;
02060       default:
02061          *result = *(stream + 1);
02062       }
02063    } else {
02064       *result = *stream;
02065       *consumed = 1;
02066    }
02067    return 0;
02068 }

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 2070 of file app.c.

References ast_get_encoded_char().

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

02071 {
02072    char *cur = result;
02073    size_t consumed;
02074 
02075    while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
02076       cur++;
02077       stream += consumed;
02078    }
02079    *cur = '\0';
02080    return result;
02081 }

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

00286 {
00287    ast_has_voicemail_func = has_voicemail_func;
00288    ast_inboxcount_func = inboxcount_func;
00289    ast_inboxcount2_func = inboxcount2_func;
00290    ast_messagecount_func = messagecount_func;
00291    ast_sayname_func = sayname_func;
00292 }

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 1853 of file app.c.

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01854 {
01855    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01856    /* Hide internal coding */
01857    return res > 0 ? 0 : res;
01858 }

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 535 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.

00536 {
00537    struct linear_state *lin;
00538    char tmpf[256];
00539    int res = -1;
00540    int autoclose = 0;
00541    if (fd < 0) {
00542       if (ast_strlen_zero(filename)) {
00543          return -1;
00544       }
00545       autoclose = 1;
00546       if (filename[0] == '/') {
00547          ast_copy_string(tmpf, filename, sizeof(tmpf));
00548       } else {
00549          snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
00550       }
00551       if ((fd = open(tmpf, O_RDONLY)) < 0) {
00552          ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
00553          return -1;
00554       }
00555    }
00556    if ((lin = ast_calloc(1, sizeof(*lin)))) {
00557       lin->fd = fd;
00558       lin->allowoverride = allowoverride;
00559       lin->autoclose = autoclose;
00560       res = ast_activate_generator(chan, &linearstream, lin);
00561    }
00562    return res;
00563 }

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

01526 {
01527    enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
01528 
01529    switch (ast_lock_type) {
01530    case AST_LOCK_TYPE_LOCKFILE:
01531       r = ast_lock_path_lockfile(path);
01532       break;
01533    case AST_LOCK_TYPE_FLOCK:
01534       r = ast_lock_path_flock(path);
01535       break;
01536    }
01537 
01538    return r;
01539 }

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 1061 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, and default_canceldtmf.

Referenced by vm_forwardoptions().

01062 {
01063    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf, 1);
01064 }

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

01057 {
01058    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf, 0);
01059 }

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 1051 of file app.c.

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

Referenced by play_record_review().

01052 {
01053    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);
01054 }

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.

Definition at line 704 of file app.c.

References AST_DIGIT_ANY, ast_stopstream(), ast_streamfile(), ast_test_suite_event_notify, and ast_waitstream().

Referenced by __ast_play_and_record(), advanced_options(), ast_record_review(), ast_say_counted_adjective(), ast_say_counted_noun(), dialout(), forward_message(), get_folder(), get_folder2(), leave_voicemail(), minivm_greet_exec(), play_message_category(), play_message_duration(), play_record_review(), vm_authenticate(), vm_browse_messages_en(), vm_browse_messages_es(), vm_browse_messages_gr(), vm_browse_messages_he(), vm_browse_messages_it(), vm_browse_messages_pt(), vm_browse_messages_vi(), vm_browse_messages_zh(), vm_exec(), vm_execmain(), vm_forwardoptions(), vm_instructions_en(), vm_instructions_zh(), vm_intro(), vm_intro_cs(), vm_intro_de(), vm_intro_en(), vm_intro_es(), vm_intro_fr(), vm_intro_gr(), vm_intro_he(), vm_intro_it(), vm_intro_multilang(), vm_intro_nl(), vm_intro_no(), vm_intro_pl(), vm_intro_pt(), vm_intro_pt_BR(), vm_intro_se(), vm_intro_vi(), vm_intro_zh(), vm_newuser(), vm_options(), vm_play_folder_name(), vm_play_folder_name_gr(), vm_play_folder_name_pl(), vm_play_folder_name_ua(), vm_tempgreeting(), and vmauthenticate().

00705 {
00706    int d = 0;
00707 
00708    ast_test_suite_event_notify("PLAYBACK", "Message: %s", fn);
00709    if ((d = ast_streamfile(chan, fn, chan->language))) {
00710       return d;
00711    }
00712 
00713    d = ast_waitstream(chan, AST_DIGIT_ANY);
00714 
00715    ast_stopstream(chan);
00716 
00717    return d;
00718 }

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk.

Definition at line 1860 of file app.c.

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

Referenced by readfile_exec().

01861 {
01862    int fd, count = 0, res;
01863    char *output = NULL;
01864    struct stat filesize;
01865 
01866    if (stat(filename, &filesize) == -1) {
01867       ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
01868       return NULL;
01869    }
01870 
01871    count = filesize.st_size + 1;
01872 
01873    if ((fd = open(filename, O_RDONLY)) < 0) {
01874       ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
01875       return NULL;
01876    }
01877 
01878    if ((output = ast_malloc(count))) {
01879       res = read(fd, output, count - 1);
01880       if (res == count - 1) {
01881          output[res] = '\0';
01882       } else {
01883          ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
01884          ast_free(output);
01885          output = NULL;
01886       }
01887    }
01888 
01889    close(fd);
01890 
01891    return output;
01892 }

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

01558 {
01559    int silencethreshold;
01560    int maxsilence = 0;
01561    int res = 0;
01562    int cmd = 0;
01563    int max_attempts = 3;
01564    int attempts = 0;
01565    int recorded = 0;
01566    int message_exists = 0;
01567    /* Note that urgent and private are for flagging messages as such in the future */
01568 
01569    /* barf if no pointer passed to store duration in */
01570    if (!duration) {
01571       ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
01572       return -1;
01573    }
01574 
01575    cmd = '3';   /* Want to start by recording */
01576 
01577    silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
01578 
01579    while ((cmd >= 0) && (cmd != 't')) {
01580       switch (cmd) {
01581       case '1':
01582          if (!message_exists) {
01583             /* In this case, 1 is to record a message */
01584             cmd = '3';
01585             break;
01586          } else {
01587             ast_stream_and_wait(chan, "vm-msgsaved", "");
01588             cmd = 't';
01589             return res;
01590          }
01591       case '2':
01592          /* Review */
01593          ast_verb(3, "Reviewing the recording\n");
01594          cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
01595          break;
01596       case '3':
01597          message_exists = 0;
01598          /* Record */
01599          ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
01600          recorded = 1;
01601          if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
01602             /* User has hung up, no options to give */
01603             return cmd;
01604          }
01605          if (cmd == '0') {
01606             break;
01607          } else if (cmd == '*') {
01608             break;
01609          } else {
01610             /* If all is well, a message exists */
01611             message_exists = 1;
01612             cmd = 0;
01613          }
01614          break;
01615       case '4':
01616       case '5':
01617       case '6':
01618       case '7':
01619       case '8':
01620       case '9':
01621       case '*':
01622       case '#':
01623          cmd = ast_play_and_wait(chan, "vm-sorry");
01624          break;
01625       default:
01626          if (message_exists) {
01627             cmd = ast_play_and_wait(chan, "vm-review");
01628          } else {
01629             if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
01630                cmd = ast_waitfordigit(chan, 600);
01631             }
01632          }
01633 
01634          if (!cmd) {
01635             cmd = ast_waitfordigit(chan, 6000);
01636          }
01637          if (!cmd) {
01638             attempts++;
01639          }
01640          if (attempts > max_attempts) {
01641             cmd = 't';
01642          }
01643       }
01644    }
01645    if (cmd == 't') {
01646       cmd = 0;
01647    }
01648    return cmd;
01649 }

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

01034 {
01035    unsigned int level;
01036 
01037    ast_mutex_lock(&safe_system_lock);
01038    level = safe_system_level++;
01039 
01040    /* only replace the handler if it has not already been done */
01041    if (level == 0) {
01042       sigaction(SIGCHLD, &null_sig_handler, &safe_system_prev_handler);
01043    }
01044 
01045    ast_mutex_unlock(&safe_system_lock);
01046 }

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

02116 {
02117    sigset_t signal_set, old_set;
02118    int pid;
02119 
02120    /* Don't let the default signal handler for children reap our status */
02121    if (stop_reaper) {
02122       ast_replace_sigchld();
02123    }
02124 
02125    sigfillset(&signal_set);
02126    pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
02127 
02128    pid = fork();
02129 
02130    if (pid != 0) {
02131       /* Fork failed or parent */
02132       pthread_sigmask(SIG_SETMASK, &old_set, NULL);
02133       if (!stop_reaper && pid > 0) {
02134          struct zombie *cur = ast_calloc(1, sizeof(*cur));
02135          if (cur) {
02136             cur->pid = pid;
02137             AST_LIST_LOCK(&zombies);
02138             AST_LIST_INSERT_TAIL(&zombies, cur, list);
02139             AST_LIST_UNLOCK(&zombies);
02140             if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
02141                if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
02142                   ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
02143                   shaun_of_the_dead_thread = AST_PTHREADT_NULL;
02144                }
02145             }
02146          }
02147       }
02148       return pid;
02149    } else {
02150       /* Child */
02151 #ifdef HAVE_CAP
02152       cap_t cap = cap_from_text("cap_net_admin-eip");
02153 
02154       if (cap_set_proc(cap)) {
02155          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
02156       }
02157       cap_free(cap);
02158 #endif
02159 
02160       /* Before we unblock our signals, return our trapped signals back to the defaults */
02161       signal(SIGHUP, SIG_DFL);
02162       signal(SIGCHLD, SIG_DFL);
02163       signal(SIGINT, SIG_DFL);
02164       signal(SIGURG, SIG_DFL);
02165       signal(SIGTERM, SIG_DFL);
02166       signal(SIGPIPE, SIG_DFL);
02167       signal(SIGXFSZ, SIG_DFL);
02168 
02169       /* unblock important signal handlers */
02170       if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
02171          ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
02172          _exit(1);
02173       }
02174 
02175       return pid;
02176    }
02177 }

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 2179 of file app.c.

References ast_unreplace_sigchld().

Referenced by agi_exec_full(), and run_ras().

02180 {
02181    ast_unreplace_sigchld();
02182 }

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

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

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 1520 of file app.c.

References ast_lock_type.

Referenced by ast_readconfig().

01521 {
01522    ast_lock_type = type;
01523 }

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

02084 {
02085    char next, *buf;
02086    size_t offset = 0;
02087    size_t consumed;
02088 
02089    if (strchr(stream, '\\')) {
02090       while (!ast_get_encoded_char(stream, &next, &consumed)) {
02091          if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
02092             ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
02093          }
02094          if (offset + 2 > ast_str_size(*str)) {
02095             break;
02096          }
02097          buf = ast_str_buffer(*str);
02098          buf[offset++] = next;
02099          stream += consumed;
02100       }
02101       buf = ast_str_buffer(*str);
02102       buf[offset++] = '\0';
02103       ast_str_update(*str);
02104    } else {
02105       ast_str_set(str, maxlen, "%s", stream);
02106    }
02107    return 0;
02108 }

AST_THREADSTORAGE_EXTERNAL ( ast_str_thread_global_buf   ) 
void ast_uninstall_vm_functions ( void   ) 

Definition at line 294 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().

00295 {
00296    ast_has_voicemail_func = NULL;
00297    ast_inboxcount_func = NULL;
00298    ast_inboxcount2_func = NULL;
00299    ast_messagecount_func = NULL;
00300    ast_sayname_func = NULL;
00301 }

int ast_unlock_path ( const char *  path  ) 

Unlock a path.

Definition at line 1541 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().

01542 {
01543    int r = 0;
01544 
01545    switch (ast_lock_type) {
01546    case AST_LOCK_TYPE_LOCKFILE:
01547       r = ast_unlock_path_lockfile(path);
01548       break;
01549    case AST_LOCK_TYPE_FLOCK:
01550       r = ast_unlock_path_flock(path);
01551       break;
01552    }
01553 
01554    return r;
01555 }

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

01049 {
01050    unsigned int level;
01051 
01052    ast_mutex_lock(&safe_system_lock);
01053    level = --safe_system_level;
01054 
01055    /* only restore the handler if we are the last one */
01056    if (level == 0) {
01057       sigaction(SIGCHLD, &safe_system_prev_handler, NULL);
01058    }
01059 
01060    ast_mutex_unlock(&safe_system_lock);
01061 }


Generated on 20 Aug 2013 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1