Wed Aug 18 22:33:57 2010

Asterisk developer's documentation


app.h File Reference

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

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

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, 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.
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_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.
int ast_get_encoded_str (const char *stream, char *result, size_t result_size)
 Decode a string which may contain multiple 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 beep, int silencethreshold, int maxsilence_ms)
 Record a message and prepend the message to the given record file after playing the optional playfile (or a beep), storing the duration in 'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.
int ast_play_and_record (struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path)
 Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum
permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. calls ast_unlock_path() on 'path' if passed.
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 silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf)
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.
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 333 of file app.h.

Referenced by acf_channel_read(), acf_curl_exec(), acf_if(), acf_import(), acf_isexten_exec(), 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_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), agi_exec_full(), aji_send_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), build_profile(), cdr_read(), cdr_write(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), conf_exec(), config_function_read(), 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_read(), filter(), find_conf(), 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_fieldqty(), 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(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), jack_exec(), load_values_config(), log_exec(), login_exec(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), park_call_exec(), parkandannounce_exec(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), play_moh_exec(), playback_exec(), pp_each_extension_exec(), pp_each_user_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), rcvfax_exec(), read_exec(), readexten_exec(), record_exec(), regex(), reload_queues(), retrydial_exec(), rqm_exec(), sayunixtime_exec(), senddtmf_exec(), sendtext_exec(), sendurl_exec(), shared_read(), shared_write(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), start_moh_exec(), start_monitor_exec(), transfer_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_check_password_shell(), vm_exec(), vm_execmain(), 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 499 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 510 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 {
        OPT_JUMP = (1 << 0),
        OPT_BLAH = (1 << 1),
        OPT_BLORT = (1 << 2),
  } my_app_option_flags;

  enum {
        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,
  } my_app_option_args;

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

#define ast_app_separate_args ( a,
b,
c,
 )     __ast_app_separate_args(a,b,1,c,d)

Definition at line 418 of file app.h.

Referenced by common_exec(), minivm_accmess_exec(), minivm_greet_exec(), minivm_notify_exec(), minivm_record_exec(), and process_echocancel().

#define AST_DECLARE_APP_ARGS ( name,
arglist   )     AST_DEFINE_APP_ARGS_TYPE(, arglist) name

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

Referenced by acf_channel_read(), acf_curl_exec(), acf_if(), acf_import(), acf_isexten_exec(), 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_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), agi_exec_full(), aji_send_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), build_profile(), cdr_read(), cdr_write(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), conf_exec(), config_function_read(), 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_read(), filter(), find_conf(), 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_fieldqty(), 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(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), jack_exec(), load_values_config(), log_exec(), login_exec(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), park_call_exec(), parkandannounce_exec(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), play_moh_exec(), playback_exec(), pp_each_extension_exec(), pp_each_user_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), rcvfax_exec(), read_exec(), readexten_exec(), record_exec(), regex(), reload_queues(), retrydial_exec(), rqm_exec(), sayunixtime_exec(), senddtmf_exec(), sendtext_exec(), sendurl_exec(), shared_read(), shared_write(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), start_moh_exec(), start_monitor_exec(), transfer_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_check_password_shell(), vm_exec(), vm_execmain(), 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 366 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 78 of file app.h.

#define AST_IVR_FLAG_AUTORESTART   (1 << 0)

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

Referenced by acf_if(), acf_jabberstatus_read(), acf_mailbox_exists(), aji_status_exec(), build_profile(), dialgroup_write(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), oss_call(), oss_request(), pbx_builtin_setvar_multiple(), record_exec(), regex(), 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 399 of file app.h.

Referenced by execif_exec(), and gosubif_exec().

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

Referenced by acf_channel_read(), acf_curl_exec(), acf_import(), acf_isexten_exec(), acf_jabberstatus_read(), acf_meetme_info(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_version_exec(), acf_vmcount_exec(), action_status(), add_agent(), admin_exec(), agi_exec_full(), aji_send_exec(), aji_status_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), cdr_read(), cdr_write(), chanavail_exec(), channel_admin_exec(), chanspy_exec(), conf_exec(), config_function_read(), 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_read(), find_conf(), find_table_cb(), func_header_read(), function_enum(), function_fieldqty(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), function_txtcidname(), hash_read(), hash_write(), hint_read(), iconv_read(), init_acf_query(), isAnsweringMachine(), isexten_function_read(), log_exec(), login_exec(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), park_call_exec(), parkandannounce_exec(), pbx_builtin_background(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), play_moh_exec(), playback_exec(), pp_each_extension_exec(), pp_each_user_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), rcvfax_exec(), read_exec(), readexten_exec(), record_exec(), reload_queues(), retrydial_exec(), rqm_exec(), sayunixtime_exec(), senddtmf_exec(), sendtext_exec(), sendurl_exec(), shared_read(), shared_write(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), start_moh_exec(), start_monitor_exec(), transfer_exec(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), 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 384 of file app.h.

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

#define BEGIN_OPTIONS   {

Definition at line 440 of file app.h.

#define END_OPTIONS   }

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


Enumeration Type Documentation

enum ast_getdata_result

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

00255                         {
00256    AST_GETDATA_FAILED = -1,
00257    AST_GETDATA_COMPLETE = 0,
00258    AST_GETDATA_TIMEOUT = 1,
00259    AST_GETDATA_INTERRUPTED = 2,
00260    /*! indicates a user terminated empty string rather than an empty string resulting 
00261     * from a timeout or other factors */
00262    AST_GETDATA_EMPTY_END_TERMINATED = 3,
00263 };

enum ast_ivr_action

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

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

enum AST_LOCK_RESULT

Enumerator:
AST_LOCK_SUCCESS 
AST_LOCK_TIMEOUT 
AST_LOCK_PATH_NOT_FOUND 
AST_LOCK_FAILURE 

Definition at line 265 of file app.h.

00265                      {
00266    AST_LOCK_SUCCESS = 0,
00267    AST_LOCK_TIMEOUT = -1,
00268    AST_LOCK_PATH_NOT_FOUND = -2,
00269    AST_LOCK_FAILURE = -3,
00270 };

enum AST_LOCK_TYPE

Type of locking to use in ast_lock_path / ast_unlock_path.

Enumerator:
AST_LOCK_TYPE_LOCKFILE 
AST_LOCK_TYPE_FLOCK 

Definition at line 273 of file app.h.

00273                    {
00274    AST_LOCK_TYPE_LOCKFILE = 0,
00275    AST_LOCK_TYPE_FLOCK = 1,
00276 };


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

References quote().

Referenced by ast_app_separate_args().

01083 {
01084    int argc;
01085    char *scan, *wasdelim = NULL;
01086    int paren = 0, quote = 0;
01087 
01088    if (!buf || !array || !arraylen)
01089       return 0;
01090 
01091    memset(array, 0, arraylen * sizeof(*array));
01092 
01093    scan = buf;
01094 
01095    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
01096       array[argc] = scan;
01097       for (; *scan; scan++) {
01098          if (*scan == '(')
01099             paren++;
01100          else if (*scan == ')') {
01101             if (paren)
01102                paren--;
01103          } else if (*scan == '"' && delim != '"') {
01104             quote = quote ? 0 : 1;
01105             if (remove_chars) {
01106                /* Remove quote character from argument */
01107                memmove(scan, scan + 1, strlen(scan));
01108                scan--;
01109             }
01110          } else if (*scan == '\\') {
01111             if (remove_chars) {
01112                /* Literal character, don't parse */
01113                memmove(scan, scan + 1, strlen(scan));
01114             } else {
01115                scan++;
01116             }
01117          } else if ((*scan == delim) && !paren && !quote) {
01118             wasdelim = scan;
01119             *scan++ = '\0';
01120             break;
01121          }
01122       }
01123    }
01124 
01125    /* If the last character in the original string was the delimiter, then
01126     * there is one additional argument. */
01127    if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
01128       array[argc++] = scan;
01129    }
01130 
01131    return argc;
01132 }

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.

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

Definition at line 69 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_waitfordigit(), chan, ast_channel::cid, ast_callerid::cid_num, tone_zone_sound::data, ast_pbx::dtimeoutms, LOG_NOTICE, ast_channel::pbx, and ast_channel::zone.

Referenced by builtin_atxfer(), and builtin_blindtransfer().

00070 {
00071    struct tone_zone_sound *ts;
00072    int res = 0, x = 0;
00073 
00074    if (maxlen > size)
00075       maxlen = size;
00076    
00077    if (!timeout && chan->pbx)
00078       timeout = chan->pbx->dtimeoutms / 1000.0;
00079    else if (!timeout)
00080       timeout = 5;
00081 
00082    if ((ts = ast_get_indication_tone(chan->zone, "dial")) && ts->data[0])
00083       res = ast_playtones_start(chan, 0, ts->data, 0);
00084    else 
00085       ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
00086    
00087    for (x = strlen(collect); x < maxlen; ) {
00088       res = ast_waitfordigit(chan, timeout);
00089       if (!ast_ignore_pattern(context, collect))
00090          ast_playtones_stop(chan);
00091       if (res < 1)
00092          break;
00093       if (res == '#')
00094          break;
00095       collect[x++] = res;
00096       if (!ast_matchmore_extension(chan, context, collect, 1, chan->cid.cid_num))
00097          break;
00098    }
00099 
00100    if (res >= 0)
00101       res = ast_exists_extension(chan, context, collect, 1, chan->cid.cid_num) ? 1 : 0;
00102 
00103    return res;
00104 }

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

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

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

00115 {
00116    int res = 0, to, fto;
00117    char *front, *filename;
00118 
00119    /* XXX Merge with full version? XXX */
00120    
00121    if (maxlen)
00122       s[0] = '\0';
00123 
00124    if (!prompt)
00125       prompt = "";
00126 
00127    filename = ast_strdupa(prompt);
00128    while ((front = strsep(&filename, "&"))) {
00129       if (!ast_strlen_zero(front)) {
00130          res = ast_streamfile(c, front, c->language);
00131          if (res)
00132             continue;
00133       }
00134       if (ast_strlen_zero(filename)) {
00135          /* set timeouts for the last prompt */
00136          fto = c->pbx ? c->pbx->rtimeoutms : 6000;
00137          to = c->pbx ? c->pbx->dtimeoutms : 2000;
00138 
00139          if (timeout > 0) 
00140             fto = to = timeout;
00141          if (timeout < 0) 
00142             fto = to = 1000000000;
00143       } else {
00144          /* there is more than one prompt, so
00145             get rid of the long timeout between 
00146             prompts, and make it 50ms */
00147          fto = 50;
00148          to = c->pbx ? c->pbx->dtimeoutms : 2000;
00149       }
00150       res = ast_readstring(c, s, maxlen, to, fto, "#");
00151       if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
00152          return res;
00153       }
00154       if (!ast_strlen_zero(s)) {
00155          return res;
00156       }
00157    }
00158 
00159    return res;
00160 }

int ast_app_getdata_full ( struct ast_channel c,
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 165 of file app.c.

References ast_readstring_full(), ast_streamfile(), ast_strlen_zero(), and ast_channel::language.

Referenced by handle_getdata().

00166 {
00167    int res, to = 2000, fto = 6000;
00168 
00169    if (!ast_strlen_zero(prompt)) {
00170       res = ast_streamfile(c, prompt, c->language);
00171       if (res < 0)
00172          return res;
00173    }
00174    
00175    if (timeout > 0) 
00176       fto = to = timeout;
00177    if (timeout < 0) 
00178       fto = to = 1000000000;
00179 
00180    res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
00181 
00182    return res;
00183 }

int ast_app_group_discard ( struct ast_channel chan  ) 

Discard all group counting for a channel.

Definition at line 1042 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, chan, ast_group_info::chan, and ast_group_info::group_list.

Referenced by ast_channel_free().

01043 {
01044    struct ast_group_info *gi = NULL;
01045    
01046    AST_RWLIST_WRLOCK(&groups);
01047    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01048       if (gi->chan == chan) {
01049          AST_RWLIST_REMOVE_CURRENT(group_list);
01050          ast_free(gi);
01051       }
01052    }
01053    AST_RWLIST_TRAVERSE_SAFE_END;
01054    AST_RWLIST_UNLOCK(&groups);
01055    
01056    return 0;
01057 }

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

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

Referenced by group_count_function_read().

00981 {
00982    struct ast_group_info *gi = NULL;
00983    int count = 0;
00984 
00985    if (ast_strlen_zero(group))
00986       return 0;
00987    
00988    AST_RWLIST_RDLOCK(&groups);
00989    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
00990       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
00991          count++;
00992    }
00993    AST_RWLIST_UNLOCK(&groups);
00994 
00995    return count;
00996 }

struct ast_group_info* ast_app_group_list_head ( void   ) 

Get the head of the group count list.

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

01070 {
01071    return AST_RWLIST_FIRST(&groups);
01072 }

int ast_app_group_list_rdlock ( void   ) 

Read Lock the group count list.

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

01065 {
01066    return AST_RWLIST_RDLOCK(&groups);
01067 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list.

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

01075 {
01076    return AST_RWLIST_UNLOCK(&groups);
01077 }

int ast_app_group_list_wrlock ( void   ) 

Write Lock the group count list.

Definition at line 1059 of file app.c.

References AST_RWLIST_WRLOCK.

01060 {
01061    return AST_RWLIST_WRLOCK(&groups);
01062 }

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

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

Referenced by group_match_count_function_read().

00999 {
01000    struct ast_group_info *gi = NULL;
01001    regex_t regexbuf;
01002    int count = 0;
01003 
01004    if (ast_strlen_zero(groupmatch))
01005       return 0;
01006 
01007    /* if regex compilation fails, return zero matches */
01008    if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
01009       return 0;
01010 
01011    AST_RWLIST_RDLOCK(&groups);
01012    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01013       if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
01014          count++;
01015    }
01016    AST_RWLIST_UNLOCK(&groups);
01017 
01018    regfree(&regexbuf);
01019 
01020    return count;
01021 }

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 935 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, chan, ast_group_info::chan, free, ast_group_info::group, ast_group_info::group_list, and len().

Referenced by dial_exec_full(), and group_function_write().

00936 {
00937    int res = 0;
00938    char group[80] = "", category[80] = "";
00939    struct ast_group_info *gi = NULL;
00940    size_t len = 0;
00941    
00942    if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category)))
00943       return -1;
00944    
00945    /* Calculate memory we will need if this is new */
00946    len = sizeof(*gi) + strlen(group) + 1;
00947    if (!ast_strlen_zero(category))
00948       len += strlen(category) + 1;
00949    
00950    AST_RWLIST_WRLOCK(&groups);
00951    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
00952       if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
00953          AST_RWLIST_REMOVE_CURRENT(group_list);
00954          free(gi);
00955          break;
00956       }
00957    }
00958    AST_RWLIST_TRAVERSE_SAFE_END;
00959 
00960    if (ast_strlen_zero(group)) {
00961       /* Enable unsetting the group */
00962    } else if ((gi = calloc(1, len))) {
00963       gi->chan = chan;
00964       gi->group = (char *) gi + sizeof(*gi);
00965       strcpy(gi->group, group);
00966       if (!ast_strlen_zero(category)) {
00967          gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
00968          strcpy(gi->category, category);
00969       }
00970       AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
00971    } else {
00972       res = -1;
00973    }
00974    
00975    AST_RWLIST_UNLOCK(&groups);
00976    
00977    return res;
00978 }

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

00909 {
00910    int res = 0;
00911    char tmp[256];
00912    char *grp = NULL, *cat = NULL;
00913 
00914    if (!ast_strlen_zero(data)) {
00915       ast_copy_string(tmp, data, sizeof(tmp));
00916       grp = tmp;
00917       cat = strchr(tmp, '@');
00918       if (cat) {
00919          *cat = '\0';
00920          cat++;
00921       }
00922    }
00923 
00924    if (!ast_strlen_zero(grp))
00925       ast_copy_string(group, grp, group_max);
00926    else
00927       *group = '\0';
00928 
00929    if (!ast_strlen_zero(cat))
00930       ast_copy_string(category, cat, category_max);
00931 
00932    return res;
00933 }

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 1023 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, ast_group_info::chan, and ast_group_info::group_list.

Referenced by ast_do_masquerade(), and check_bridge().

01024 {
01025    struct ast_group_info *gi = NULL;
01026 
01027    AST_RWLIST_WRLOCK(&groups);
01028    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01029       if (gi->chan == old) {
01030          gi->chan = new;
01031       } else if (gi->chan == new) {
01032          AST_RWLIST_REMOVE_CURRENT(group_list);
01033          ast_free(gi);
01034       }
01035    }
01036    AST_RWLIST_TRAVERSE_SAFE_END;
01037    AST_RWLIST_UNLOCK(&groups);
01038 
01039    return 0;
01040 }

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 213 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(), and unistim_send_mwi_to_peer().

00214 {
00215    static int warned = 0;
00216    if (ast_has_voicemail_func)
00217       return ast_has_voicemail_func(mailbox, folder);
00218 
00219    if (!warned) {
00220       ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
00221       warned++;
00222    }
00223    return 0;
00224 }

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

References ast_inboxcount_func, and ast_verb.

Referenced by sip_send_mwi_to_peer(), and update_registry().

00228 {
00229    static int warned = 0;
00230    if (newmsgs) {
00231       *newmsgs = 0;
00232    }
00233    if (oldmsgs) {
00234       *oldmsgs = 0;
00235    }
00236    if (ast_inboxcount_func) {
00237       return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
00238    }
00239 
00240    if (!warned) {
00241       warned++;
00242       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00243    }
00244 
00245    return 0;
00246 }

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

References ast_inboxcount2_func, ast_inboxcount_func, and ast_verb.

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

00249 {
00250    static int warned = 0;
00251    if (newmsgs) {
00252       *newmsgs = 0;
00253    }
00254    if (oldmsgs) {
00255       *oldmsgs = 0;
00256    }
00257    if (urgentmsgs) {
00258       *urgentmsgs = 0;
00259    }
00260    if (ast_inboxcount_func) {
00261       return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
00262    }
00263 
00264    if (!warned) {
00265       warned++;
00266       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00267    }
00268 
00269    return 0;
00270 }

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

References ast_messagecount_func, and ast_verb.

Referenced by acf_vmcount_exec().

00280 {
00281    static int warned = 0;
00282    if (ast_messagecount_func)
00283       return ast_messagecount_func(context, mailbox, folder);
00284 
00285    if (!warned) {
00286       warned++;
00287       ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
00288    }
00289 
00290    return 0;
00291 }

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

References ast_test_flag64, and ast_flags64::flags.

01783 {
01784    unsigned int i, found = 0;
01785    for (i = 32; i < 128 && found < len; i++) {
01786       if (ast_test_flag64(flags, options[i].flag)) {
01787          buf[found++] = i;
01788       }
01789    }
01790    buf[found] = '\0';
01791 }

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

References ast_flags64::flags, and parse_options().

Referenced by app_exec(), auth_exec(), bridge_exec(), cdr_read(), cdr_write(), chanspy_exec(), conf_exec(), controlplayback_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundifunc_read(), extenspy_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(), record_exec(), sendurl_exec(), sla_trunk_exec(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_background(), vm_exec(), and vm_execmain().

01773 {
01774    return parse_options(options, flags, args, optstr, 32);
01775 }

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

References ast_flags64::flags, and parse_options().

Referenced by dial_exec_full().

01778 {
01779    return parse_options(options, flags, args, optstr, 64);
01780 }

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

References ast_sayname_func, and chan.

Referenced by common_exec(), and play_mailbox_owner().

00273 {
00274    if (ast_sayname_func)
00275       return ast_sayname_func(chan, mailbox, context);
00276    return -1;
00277 }

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

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

01906 {
01907    int x, null;
01908    null = open("/dev/null", O_RDONLY);
01909    for (x = n + 1; x <= (null >= 8192 ? null : 8192); x++) {
01910       if (x != null) {
01911          /* Side effect of dup2 is that it closes any existing fd without error.
01912           * This prevents valgrind and other debugging tools from sending up
01913           * false error reports. */
01914          dup2(null, x);
01915          close(x);
01916       }
01917    }
01918    close(null);
01919 }

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

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

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

00464 {
00465    char *breaks = NULL;
00466    char *end = NULL;
00467    int blen = 2;
00468    int res;
00469    long pause_restart_point = 0;
00470    long offset = 0;
00471 
00472    if (offsetms) 
00473       offset = *offsetms * 8; /* XXX Assumes 8kHz */
00474 
00475    if (stop)
00476       blen += strlen(stop);
00477    if (suspend)
00478       blen += strlen(suspend);
00479    if (restart)
00480       blen += strlen(restart);
00481 
00482    if (blen > 2) {
00483       breaks = alloca(blen + 1);
00484       breaks[0] = '\0';
00485       if (stop)
00486          strcat(breaks, stop);
00487       if (suspend)
00488          strcat(breaks, suspend);
00489       if (restart)
00490          strcat(breaks, restart);
00491    }
00492    if (chan->_state != AST_STATE_UP)
00493       res = ast_answer(chan);
00494 
00495    if (file) {
00496       if ((end = strchr(file, ':'))) {
00497          if (!strcasecmp(end, ":end")) {
00498             *end = '\0';
00499             end++;
00500          }
00501       }
00502    }
00503 
00504    for (;;) {
00505       ast_stopstream(chan);
00506       res = ast_streamfile(chan, file, chan->language);
00507       if (!res) {
00508          if (pause_restart_point) {
00509             ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
00510             pause_restart_point = 0;
00511          }
00512          else if (end || offset < 0) {
00513             if (offset == -8) 
00514                offset = 0;
00515             ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
00516 
00517             ast_seekstream(chan->stream, offset, SEEK_END);
00518             end = NULL;
00519             offset = 0;
00520          } else if (offset) {
00521             ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
00522             ast_seekstream(chan->stream, offset, SEEK_SET);
00523             offset = 0;
00524          };
00525          res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
00526       }
00527 
00528       if (res < 1)
00529          break;
00530 
00531       /* We go at next loop if we got the restart char */
00532       if (restart && strchr(restart, res)) {
00533          ast_debug(1, "we'll restart the stream here at next loop\n");
00534          pause_restart_point = 0;
00535          continue;
00536       }
00537 
00538       if (suspend && strchr(suspend, res)) {
00539          pause_restart_point = ast_tellstream(chan->stream);
00540          for (;;) {
00541             ast_stopstream(chan);
00542             res = ast_waitfordigit(chan, 1000);
00543             if (!res)
00544                continue;
00545             else if (res == -1 || strchr(suspend, res) || (stop && strchr(stop, res)))
00546                break;
00547          }
00548          if (res == *suspend) {
00549             res = 0;
00550             continue;
00551          }
00552       }
00553 
00554       if (res == -1)
00555          break;
00556 
00557       /* if we get one of our stop chars, return it to the calling function */
00558       if (stop && strchr(stop, res))
00559          break;
00560    }
00561 
00562    if (pause_restart_point) {
00563       offset = pause_restart_point;
00564    } else {
00565       if (chan->stream) {
00566          offset = ast_tellstream(chan->stream);
00567       } else {
00568          offset = -8;  /* indicate end of file */
00569       }
00570    }
00571 
00572    if (offsetms) 
00573       *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
00574 
00575    /* If we are returning a digit cast it as char */
00576    if (res > 0 || chan->stream)
00577       res = (char)res;
00578 
00579    ast_stopstream(chan);
00580 
00581    return res;
00582 }

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 293 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(), chan, and LOG_WARNING.

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

00294 {
00295    const char *ptr;
00296    int res = 0;
00297    struct ast_silence_generator *silgen = NULL;
00298 
00299    if (!between)
00300       between = 100;
00301 
00302    if (peer)
00303       res = ast_autoservice_start(peer);
00304 
00305    if (!res)
00306       res = ast_waitfor(chan, 100);
00307 
00308    /* ast_waitfor will return the number of remaining ms on success */
00309    if (res < 0) {
00310       if (peer) {
00311          ast_autoservice_stop(peer);
00312       }
00313       return res;
00314    }
00315 
00316    if (ast_opt_transmit_silence) {
00317       silgen = ast_channel_start_silence_generator(chan);
00318    }
00319 
00320    for (ptr = digits; *ptr; ptr++) {
00321       if (*ptr == 'w') {
00322          /* 'w' -- wait half a second */
00323          if ((res = ast_safe_sleep(chan, 500)))
00324             break;
00325       } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
00326          /* Character represents valid DTMF */
00327          if (*ptr == 'f' || *ptr == 'F') {
00328             /* ignore return values if not supported by channel */
00329             ast_indicate(chan, AST_CONTROL_FLASH);
00330          } else
00331             ast_senddigit(chan, *ptr, duration);
00332          /* pause between digits */
00333          if ((res = ast_safe_sleep(chan, between)))
00334             break;
00335       } else
00336          ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
00337    }
00338 
00339    if (peer) {
00340       /* Stop autoservice on the peer channel, but don't overwrite any error condition 
00341          that has occurred previously while acting on the primary channel */
00342       if (ast_autoservice_stop(peer) && !res)
00343          res = -1;
00344    }
00345 
00346    if (silgen) {
00347       ast_channel_stop_silence_generator(chan, silgen);
00348    }
00349 
00350    return res;
00351 }

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

Decode an encoded control or extended ASCII character.

Definition at line 1793 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(), and function_fieldqty().

01794 {
01795    int i;
01796    *consumed = 1;
01797    *result = 0;
01798    if (ast_strlen_zero(stream)) {
01799       *consumed = 0;
01800       return -1;
01801    }
01802 
01803    if (*stream == '\\') {
01804       *consumed = 2;
01805       switch (*(stream + 1)) {
01806       case 'n':
01807          *result = '\n';
01808          break;
01809       case 'r':
01810          *result = '\r';
01811          break;
01812       case 't':
01813          *result = '\t';
01814          break;
01815       case 'x':
01816          /* Hexadecimal */
01817          if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
01818             *consumed = 3;
01819             if (*(stream + 2) <= '9')
01820                *result = *(stream + 2) - '0';
01821             else if (*(stream + 2) <= 'F')
01822                *result = *(stream + 2) - 'A' + 10;
01823             else
01824                *result = *(stream + 2) - 'a' + 10;
01825          } else {
01826             ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
01827             return -1;
01828          }
01829 
01830          if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
01831             *consumed = 4;
01832             *result <<= 4;
01833             if (*(stream + 3) <= '9')
01834                *result += *(stream + 3) - '0';
01835             else if (*(stream + 3) <= 'F')
01836                *result += *(stream + 3) - 'A' + 10;
01837             else
01838                *result += *(stream + 3) - 'a' + 10;
01839          }
01840          break;
01841       case '0':
01842          /* Octal */
01843          *consumed = 2;
01844          for (i = 2; ; i++) {
01845             if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
01846                (*consumed)++;
01847                ast_debug(5, "result was %d, ", *result);
01848                *result <<= 3;
01849                *result += *(stream + i) - '0';
01850                ast_debug(5, "is now %d\n", *result);
01851             } else
01852                break;
01853          }
01854          break;
01855       default:
01856          *result = *(stream + 1);
01857       }
01858    } else {
01859       *result = *stream;
01860       *consumed = 1;
01861    }
01862    return 0;
01863 }

int ast_get_encoded_str ( const char *  stream,
char *  result,
size_t  result_size 
)

Decode a string which may contain multiple encoded control or extended ASCII characters.

Definition at line 1865 of file app.c.

References ast_get_encoded_char().

Referenced by sip_addheader().

01866 {
01867    char *cur = result;
01868    size_t consumed;
01869 
01870    while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
01871       cur++;
01872       stream += consumed;
01873    }
01874    *cur = '\0';
01875    return 0;
01876 }

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] 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 191 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().

00196 {
00197    ast_has_voicemail_func = has_voicemail_func;
00198    ast_inboxcount_func = inboxcount_func;
00199    ast_inboxcount2_func = inboxcount2_func;
00200    ast_messagecount_func = messagecount_func;
00201    ast_sayname_func = sayname_func;
00202 }

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

References ast_ivr_menu_run_internal(), and chan.

Referenced by skel_exec().

01654 {
01655    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01656    /* Hide internal coding */
01657    return res > 0 ? 0 : res;
01658 }

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

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

00433 {
00434    struct linear_state *lin;
00435    char tmpf[256];
00436    int res = -1;
00437    int autoclose = 0;
00438    if (fd < 0) {
00439       if (ast_strlen_zero(filename))
00440          return -1;
00441       autoclose = 1;
00442       if (filename[0] == '/') 
00443          ast_copy_string(tmpf, filename, sizeof(tmpf));
00444       else
00445          snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
00446       if ((fd = open(tmpf, O_RDONLY)) < 0) {
00447          ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
00448          return -1;
00449       }
00450    }
00451    if ((lin = ast_calloc(1, sizeof(*lin)))) {
00452       lin->fd = fd;
00453       lin->allowoverride = allowoverride;
00454       lin->autoclose = autoclose;
00455       res = ast_activate_generator(chan, &linearstream, lin);
00456    }
00457    return res;
00458 }

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

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

Referenced by vm_lock_path().

01333 {
01334    enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
01335 
01336    switch (ast_lock_type) {
01337    case AST_LOCK_TYPE_LOCKFILE:
01338       r = ast_lock_path_lockfile(path);
01339       break;
01340    case AST_LOCK_TYPE_FLOCK:
01341       r = ast_lock_path_flock(path);
01342       break;
01343    }
01344 
01345    return r;
01346 }

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

Record a message and prepend the message to the given record file after playing the optional playfile (or a beep), storing the duration in 'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.

Definition at line 901 of file app.c.

References __ast_play_and_record(), and chan.

Referenced by vm_forwardoptions().

00902 {
00903    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
00904 }

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

Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum
permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. calls ast_unlock_path() on 'path' if passed.

Definition at line 896 of file app.c.

References __ast_play_and_record(), and chan.

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

00897 {
00898    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
00899 }

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  silencethreshold,
int  maxsilence_ms,
const char *  path,
const char *  acceptdtmf,
const char *  canceldtmf 
)

Definition at line 891 of file app.c.

References __ast_play_and_record(), chan, and S_OR.

Referenced by play_record_review().

00892 {
00893    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, S_OR(acceptdtmf, default_acceptdtmf), S_OR(canceldtmf, default_canceldtmf));
00894 }

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

References AST_DIGIT_ANY, ast_stopstream(), ast_streamfile(), ast_waitstream(), chan, and ast_channel::language.

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_zh(), 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_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().

00585 {
00586    int d = 0;
00587 
00588    if ((d = ast_streamfile(chan, fn, chan->language)))
00589       return d;
00590 
00591    d = ast_waitstream(chan, AST_DIGIT_ANY);
00592 
00593    ast_stopstream(chan);
00594 
00595    return d;
00596 }

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk.

Definition at line 1660 of file app.c.

References ast_free, ast_log(), ast_malloc, errno, path_lock::fd, and LOG_WARNING.

Referenced by file_read(), and readfile_exec().

01661 {
01662    int fd, count = 0, res;
01663    char *output = NULL;
01664    struct stat filesize;
01665 
01666    if (stat(filename, &filesize) == -1) {
01667       ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
01668       return NULL;
01669    }
01670 
01671    count = filesize.st_size + 1;
01672 
01673    if ((fd = open(filename, O_RDONLY)) < 0) {
01674       ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
01675       return NULL;
01676    }
01677 
01678    if ((output = ast_malloc(count))) {
01679       res = read(fd, output, count - 1);
01680       if (res == count - 1) {
01681          output[res] = '\0';
01682       } else {
01683          ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
01684          ast_free(output);
01685          output = NULL;
01686       }
01687    }
01688 
01689    close(fd);
01690 
01691    return output;
01692 }

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 1364 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(), chan, LOG_WARNING, maxsilence, silencethreshold, and THRESHOLD_SILENCE.

Referenced by conf_run().

01365 {
01366    int silencethreshold; 
01367    int maxsilence = 0;
01368    int res = 0;
01369    int cmd = 0;
01370    int max_attempts = 3;
01371    int attempts = 0;
01372    int recorded = 0;
01373    int message_exists = 0;
01374    /* Note that urgent and private are for flagging messages as such in the future */
01375 
01376    /* barf if no pointer passed to store duration in */
01377    if (!duration) {
01378       ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
01379       return -1;
01380    }
01381 
01382    cmd = '3';   /* Want to start by recording */
01383 
01384    silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
01385 
01386    while ((cmd >= 0) && (cmd != 't')) {
01387       switch (cmd) {
01388       case '1':
01389          if (!message_exists) {
01390             /* In this case, 1 is to record a message */
01391             cmd = '3';
01392             break;
01393          } else {
01394             ast_stream_and_wait(chan, "vm-msgsaved", "");
01395             cmd = 't';
01396             return res;
01397          }
01398       case '2':
01399          /* Review */
01400          ast_verb(3, "Reviewing the recording\n");
01401          cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
01402          break;
01403       case '3':
01404          message_exists = 0;
01405          /* Record */
01406          if (recorded == 1)
01407             ast_verb(3, "Re-recording\n");
01408          else  
01409             ast_verb(3, "Recording\n");
01410          recorded = 1;
01411          cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
01412          if (cmd == -1) {
01413          /* User has hung up, no options to give */
01414             return cmd;
01415          }
01416          if (cmd == '0') {
01417             break;
01418          } else if (cmd == '*') {
01419             break;
01420          } 
01421          else {
01422             /* If all is well, a message exists */
01423             message_exists = 1;
01424             cmd = 0;
01425          }
01426          break;
01427       case '4':
01428       case '5':
01429       case '6':
01430       case '7':
01431       case '8':
01432       case '9':
01433       case '*':
01434       case '#':
01435          cmd = ast_play_and_wait(chan, "vm-sorry");
01436          break;
01437       default:
01438          if (message_exists) {
01439             cmd = ast_play_and_wait(chan, "vm-review");
01440          }
01441          else {
01442             cmd = ast_play_and_wait(chan, "vm-torerecord");
01443             if (!cmd)
01444                cmd = ast_waitfordigit(chan, 600);
01445          }
01446          
01447          if (!cmd)
01448             cmd = ast_waitfordigit(chan, 6000);
01449          if (!cmd) {
01450             attempts++;
01451          }
01452          if (attempts > max_attempts) {
01453             cmd = 't';
01454          }
01455       }
01456    }
01457    if (cmd == 't')
01458       cmd = 0;
01459    return cmd;
01460 }

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

00832 {
00833    unsigned int level;
00834 
00835    ast_mutex_lock(&safe_system_lock);
00836    level = safe_system_level++;
00837 
00838    /* only replace the handler if it has not already been done */
00839    if (level == 0)
00840       safe_system_prev_handler = signal(SIGCHLD, null_sig_handler);
00841 
00842    ast_mutex_unlock(&safe_system_lock);
00843 }

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

References ast_log(), ast_replace_sigchld(), errno, and LOG_WARNING.

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

01922 {
01923    sigset_t signal_set, old_set;
01924    int pid;
01925 
01926    /* Don't let the default signal handler for children reap our status */
01927    if (stop_reaper) {
01928       ast_replace_sigchld();
01929    }
01930 
01931    sigfillset(&signal_set);
01932    pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
01933 
01934    pid = fork();
01935 
01936    if (pid != 0) {
01937       /* Fork failed or parent */
01938       pthread_sigmask(SIG_SETMASK, &old_set, NULL);
01939       return pid;
01940    } else {
01941       /* Child */
01942 #ifdef HAVE_CAP
01943       cap_t cap = cap_from_text("cap_net_admin-eip");
01944 
01945       if (cap_set_proc(cap)) {
01946          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
01947       }
01948       cap_free(cap);
01949 #endif
01950 
01951       /* Before we unblock our signals, return our trapped signals back to the defaults */
01952       signal(SIGHUP, SIG_DFL);
01953       signal(SIGCHLD, SIG_DFL);
01954       signal(SIGINT, SIG_DFL);
01955       signal(SIGURG, SIG_DFL);
01956       signal(SIGTERM, SIG_DFL);
01957       signal(SIGPIPE, SIG_DFL);
01958       signal(SIGXFSZ, SIG_DFL);
01959 
01960       /* unblock important signal handlers */
01961       if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
01962          ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
01963          _exit(1);
01964       }
01965 
01966       return pid;
01967    }
01968 }

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

References ast_unreplace_sigchld().

Referenced by agi_exec_full(), and run_ras().

01971 {
01972    ast_unreplace_sigchld();
01973 }

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 859 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(), filestream_destructor(), mixmonitor_thread(), notify_message(), process_text_line(), remoteconsolehandler(), rotate_file(), run_externnotify(), sendmail(), sendpage(), system_exec_helper(), and vm_change_password_shell().

00860 {
00861    pid_t pid;
00862    int res;
00863    struct rusage rusage;
00864    int status;
00865 
00866 #if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
00867    ast_replace_sigchld();
00868 
00869 #ifdef HAVE_WORKING_FORK
00870    pid = fork();
00871 #else
00872    pid = vfork();
00873 #endif   
00874 
00875    if (pid == 0) {
00876 #ifdef HAVE_CAP
00877       cap_t cap = cap_from_text("cap_net_admin-eip");
00878 
00879       if (cap_set_proc(cap)) {
00880          /* Careful with order! Logging cannot happen after we close FDs */
00881          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
00882       }
00883       cap_free(cap);
00884 #endif
00885 #ifdef HAVE_WORKING_FORK
00886       if (ast_opt_high_priority)
00887          ast_set_priority(0);
00888       /* Close file descriptors and launch system command */
00889       ast_close_fds_above_n(STDERR_FILENO);
00890 #endif
00891       execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
00892       _exit(1);
00893    } else if (pid > 0) {
00894       for (;;) {
00895          res = wait4(pid, &status, 0, &rusage);
00896          if (res > -1) {
00897             res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
00898             break;
00899          } else if (errno != EINTR) 
00900             break;
00901       }
00902    } else {
00903       ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
00904       res = -1;
00905    }
00906 
00907    ast_unreplace_sigchld();
00908 #else /* !defined(HAVE_WORKING_FORK) && !defined(HAVE_WORKING_VFORK) */
00909    res = -1;
00910 #endif
00911 
00912    return res;
00913 }

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

01328 {
01329    ast_lock_type = type;
01330 }

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 1878 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, buf, path_lock::next, and str.

Referenced by system_exec_helper().

01879 {
01880    char next, *buf;
01881    size_t offset = 0;
01882    size_t consumed;
01883 
01884    if (strchr(stream, '\\')) {
01885       while (!ast_get_encoded_char(stream, &next, &consumed)) {
01886          if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
01887             ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
01888          }
01889          if (offset + 2 > ast_str_size(*str)) {
01890             break;
01891          }
01892          buf = ast_str_buffer(*str);
01893          buf[offset++] = next;
01894          stream += consumed;
01895       }
01896       buf = ast_str_buffer(*str);
01897       buf[offset++] = '\0';
01898       ast_str_update(*str);
01899    } else {
01900       ast_str_set(str, maxlen, "%s", stream);
01901    }
01902    return 0;
01903 }

void ast_uninstall_vm_functions ( void   ) 

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

00205 {
00206    ast_has_voicemail_func = NULL;
00207    ast_inboxcount_func = NULL;
00208    ast_inboxcount2_func = NULL;
00209    ast_messagecount_func = NULL;
00210    ast_sayname_func = NULL;
00211 }

int ast_unlock_path ( const char *  path  ) 

Unlock a path.

Definition at line 1348 of file app.c.

References 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(), copy_message(), count_messages(), leave_voicemail(), open_mailbox(), and save_to_folder().

01349 {
01350    int r = 0;
01351 
01352    switch (ast_lock_type) {
01353    case AST_LOCK_TYPE_LOCKFILE:
01354       r = ast_unlock_path_lockfile(path);
01355       break;
01356    case AST_LOCK_TYPE_FLOCK:
01357       r = ast_unlock_path_flock(path);
01358       break;
01359    }
01360 
01361    return r;
01362 }

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

00846 {
00847    unsigned int level;
00848 
00849    ast_mutex_lock(&safe_system_lock);
00850    level = --safe_system_level;
00851 
00852    /* only restore the handler if we are the last one */
00853    if (level == 0)
00854       signal(SIGCHLD, safe_system_prev_handler);
00855 
00856    ast_mutex_unlock(&safe_system_lock);
00857 }


Generated on Wed Aug 18 22:33:57 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7