Mon Jun 27 16:50:57 2011

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
 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.
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 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.
 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 365 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(), 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(), astman_get_variables(), 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(), dahdi_accept_r2_call_exec(), dahdi_send_callrerouting_facility_exec(), 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_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(), math(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), my_pri_make_cc_dialstring(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_call_exec(), parkandannounce_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(), 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(), sig_pri_call(), sig_pri_extract_called_num_subaddr(), 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(), 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(), 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 531 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 542 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 522 of file app.h.

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

Definition at line 450 of file app.h.

Referenced by common_exec(), minivm_accmess_exec(), minivm_greet_exec(), minivm_mwi_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 382 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(), 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(), astman_get_variables(), 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(), dahdi_accept_r2_call_exec(), dahdi_send_callrerouting_facility_exec(), 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_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(), math(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), my_pri_make_cc_dialstring(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_call_exec(), parkandannounce_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(), 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(), sig_pri_call(), sig_pri_extract_called_num_subaddr(), 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(), 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(), 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 398 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 429 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(), my_pri_make_cc_dialstring(), oss_call(), oss_request(), pbx_builtin_setvar_multiple(), record_exec(), redirecting_read(), redirecting_write(), regex(), sig_pri_call(), sig_pri_extract_called_num_subaddr(), 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 431 of file app.h.

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

#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 414 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(), astman_get_variables(), asyncgoto_exec(), auth_exec(), background_detect_exec(), bridge_exec(), 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(), conf_exec(), confbridge_exec(), config_function_read(), connectedline_write(), controlplayback_exec(), count_exec(), cut_internal(), dahdi_send_callrerouting_facility_exec(), 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_table_cb(), 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(), 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(), 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(), 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(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), softhangup_exec(), speech_background(), speech_load(), srv_result_read(), start_moh_exec(), start_monitor_exec(), transfer_exec(), unshift_push(), 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 416 of file app.h.

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

#define BEGIN_OPTIONS   {

Definition at line 472 of file app.h.

#define END_OPTIONS   }

Definition at line 473 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

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

00287                         {
00288    AST_GETDATA_FAILED = -1,
00289    AST_GETDATA_COMPLETE = 0,
00290    AST_GETDATA_TIMEOUT = 1,
00291    AST_GETDATA_INTERRUPTED = 2,
00292    /*! indicates a user terminated empty string rather than an empty string resulting 
00293     * from a timeout or other factors */
00294    AST_GETDATA_EMPTY_END_TERMINATED = 3,
00295 };

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

enum AST_LOCK_RESULT

Enumerator:
AST_LOCK_SUCCESS 
AST_LOCK_TIMEOUT 
AST_LOCK_PATH_NOT_FOUND 
AST_LOCK_FAILURE 

Definition at line 297 of file app.h.

00297                      {
00298    AST_LOCK_SUCCESS = 0,
00299    AST_LOCK_TIMEOUT = -1,
00300    AST_LOCK_PATH_NOT_FOUND = -2,
00301    AST_LOCK_FAILURE = -3,
00302 };

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

00305                    {
00306    AST_LOCK_TYPE_LOCKFILE = 0,
00307    AST_LOCK_TYPE_FLOCK = 1,
00308 };

enum ast_timelen

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

References paren, and quote().

Referenced by ast_app_separate_args().

01232 {
01233    int argc;
01234    char *scan, *wasdelim = NULL;
01235    int paren = 0, quote = 0, bracket = 0;
01236 
01237    if (!array || !arraylen) {
01238       return 0;
01239    }
01240 
01241    memset(array, 0, arraylen * sizeof(*array));
01242 
01243    if (!buf) {
01244       return 0;
01245    }
01246 
01247    scan = buf;
01248 
01249    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
01250       array[argc] = scan;
01251       for (; *scan; scan++) {
01252          if (*scan == '(') {
01253             paren++;
01254          } else if (*scan == ')') {
01255             if (paren) {
01256                paren--;
01257             }
01258          } else if (*scan == '[') {
01259             bracket++;
01260          } else if (*scan == ']') {
01261             if (bracket) {
01262                bracket--;
01263             }
01264          } else if (*scan == '"' && delim != '"') {
01265             quote = quote ? 0 : 1;
01266             if (remove_chars) {
01267                /* Remove quote character from argument */
01268                memmove(scan, scan + 1, strlen(scan));
01269                scan--;
01270             }
01271          } else if (*scan == '\\') {
01272             if (remove_chars) {
01273                /* Literal character, don't parse */
01274                memmove(scan, scan + 1, strlen(scan));
01275             } else {
01276                scan++;
01277             }
01278          } else if ((*scan == delim) && !paren && !quote && !bracket) {
01279             wasdelim = scan;
01280             *scan++ = '\0';
01281             break;
01282          }
01283       }
01284    }
01285 
01286    /* If the last character in the original string was the delimiter, then
01287     * there is one additional argument. */
01288    if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
01289       array[argc++] = scan;
01290    }
01291 
01292    return argc;
01293 }

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

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

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

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

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

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

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

Referenced by handle_getdata().

00224 {
00225    int res, to = 2000, fto = 6000;
00226 
00227    if (!ast_strlen_zero(prompt)) {
00228       res = ast_streamfile(c, prompt, c->language);
00229       if (res < 0) {
00230          return res;
00231       }
00232    }
00233 
00234    if (timeout > 0) {
00235       fto = to = timeout;
00236    }
00237    if (timeout < 0) {
00238       fto = to = 1000000000;
00239    }
00240 
00241    res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
00242 
00243    return res;
00244 }

int ast_app_group_discard ( struct ast_channel chan  ) 

Discard all group counting for a channel.

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

01192 {
01193    struct ast_group_info *gi = NULL;
01194 
01195    AST_RWLIST_WRLOCK(&groups);
01196    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01197       if (gi->chan == chan) {
01198          AST_RWLIST_REMOVE_CURRENT(group_list);
01199          ast_free(gi);
01200       }
01201    }
01202    AST_RWLIST_TRAVERSE_SAFE_END;
01203    AST_RWLIST_UNLOCK(&groups);
01204 
01205    return 0;
01206 }

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

01114 {
01115    struct ast_group_info *gi = NULL;
01116    int count = 0;
01117 
01118    if (ast_strlen_zero(group)) {
01119       return 0;
01120    }
01121 
01122    AST_RWLIST_RDLOCK(&groups);
01123    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01124       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01125          count++;
01126       }
01127    }
01128    AST_RWLIST_UNLOCK(&groups);
01129 
01130    return count;
01131 }

struct ast_group_info* ast_app_group_list_head ( void   ) 

Get the head of the group count list.

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

01219 {
01220    return AST_RWLIST_FIRST(&groups);
01221 }

int ast_app_group_list_rdlock ( void   ) 

Read Lock the group count list.

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

01214 {
01215    return AST_RWLIST_RDLOCK(&groups);
01216 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list.

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

01224 {
01225    return AST_RWLIST_UNLOCK(&groups);
01226 }

int ast_app_group_list_wrlock ( void   ) 

Write Lock the group count list.

Definition at line 1208 of file app.c.

References AST_RWLIST_WRLOCK.

01209 {
01210    return AST_RWLIST_WRLOCK(&groups);
01211 }

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 1133 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, ast_group_info::group_list, LOG_ERROR, and LOG_NOTICE.

Referenced by group_match_count_function_read().

01134 {
01135    struct ast_group_info *gi = NULL;
01136    regex_t regexbuf_group;
01137    regex_t regexbuf_category;
01138    int count = 0;
01139 
01140    if (ast_strlen_zero(groupmatch)) {
01141       ast_log(LOG_NOTICE, "groupmatch empty\n");
01142       return 0;
01143    }
01144 
01145    /* if regex compilation fails, return zero matches */
01146    if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
01147       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
01148       return 0;
01149    }
01150 
01151    if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
01152       ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
01153       return 0;
01154    }
01155 
01156    AST_RWLIST_RDLOCK(&groups);
01157    AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
01158       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)))) {
01159          count++;
01160       }
01161    }
01162    AST_RWLIST_UNLOCK(&groups);
01163 
01164    regfree(&regexbuf_group);
01165    if (!ast_strlen_zero(category)) {
01166       regfree(&regexbuf_category);
01167    }
01168 
01169    return count;
01170 }

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 1066 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, ast_group_info::group_list, and len().

Referenced by dial_exec_full(), and group_function_write().

01067 {
01068    int res = 0;
01069    char group[80] = "", category[80] = "";
01070    struct ast_group_info *gi = NULL;
01071    size_t len = 0;
01072 
01073    if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
01074       return -1;
01075    }
01076 
01077    /* Calculate memory we will need if this is new */
01078    len = sizeof(*gi) + strlen(group) + 1;
01079    if (!ast_strlen_zero(category)) {
01080       len += strlen(category) + 1;
01081    }
01082 
01083    AST_RWLIST_WRLOCK(&groups);
01084    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01085       if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
01086          AST_RWLIST_REMOVE_CURRENT(group_list);
01087          free(gi);
01088          break;
01089       }
01090    }
01091    AST_RWLIST_TRAVERSE_SAFE_END;
01092 
01093    if (ast_strlen_zero(group)) {
01094       /* Enable unsetting the group */
01095    } else if ((gi = calloc(1, len))) {
01096       gi->chan = chan;
01097       gi->group = (char *) gi + sizeof(*gi);
01098       strcpy(gi->group, group);
01099       if (!ast_strlen_zero(category)) {
01100          gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
01101          strcpy(gi->category, category);
01102       }
01103       AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
01104    } else {
01105       res = -1;
01106    }
01107 
01108    AST_RWLIST_UNLOCK(&groups);
01109 
01110    return res;
01111 }

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

01040 {
01041    int res = 0;
01042    char tmp[256];
01043    char *grp = NULL, *cat = NULL;
01044 
01045    if (!ast_strlen_zero(data)) {
01046       ast_copy_string(tmp, data, sizeof(tmp));
01047       grp = tmp;
01048       if ((cat = strchr(tmp, '@'))) {
01049          *cat++ = '\0';
01050       }
01051    }
01052 
01053    if (!ast_strlen_zero(grp)) {
01054       ast_copy_string(group, grp, group_max);
01055    } else {
01056       *group = '\0';
01057    }
01058 
01059    if (!ast_strlen_zero(cat)) {
01060       ast_copy_string(category, cat, category_max);
01061    }
01062 
01063    return res;
01064 }

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

01173 {
01174    struct ast_group_info *gi = NULL;
01175 
01176    AST_RWLIST_WRLOCK(&groups);
01177    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
01178       if (gi->chan == old) {
01179          gi->chan = new;
01180       } else if (gi->chan == new) {
01181          AST_RWLIST_REMOVE_CURRENT(group_list);
01182          ast_free(gi);
01183       }
01184    }
01185    AST_RWLIST_TRAVERSE_SAFE_END;
01186    AST_RWLIST_UNLOCK(&groups);
01187 
01188    return 0;
01189 }

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

00297 {
00298    static int warned = 0;
00299    if (ast_has_voicemail_func) {
00300       return ast_has_voicemail_func(mailbox, folder);
00301    }
00302 
00303    if (warned++ % 10 == 0) {
00304       ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
00305    }
00306    return 0;
00307 }

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

References ast_inboxcount_func, and ast_verb.

Referenced by sip_send_mwi_to_peer(), and update_registry().

00311 {
00312    static int warned = 0;
00313    if (newmsgs) {
00314       *newmsgs = 0;
00315    }
00316    if (oldmsgs) {
00317       *oldmsgs = 0;
00318    }
00319    if (ast_inboxcount_func) {
00320       return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
00321    }
00322 
00323    if (warned++ % 10 == 0) {
00324       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00325    }
00326 
00327    return 0;
00328 }

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

References ast_inboxcount2_func, ast_inboxcount_func, and ast_verb.

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

00331 {
00332    static int warned = 0;
00333    if (newmsgs) {
00334       *newmsgs = 0;
00335    }
00336    if (oldmsgs) {
00337       *oldmsgs = 0;
00338    }
00339    if (urgentmsgs) {
00340       *urgentmsgs = 0;
00341    }
00342    if (ast_inboxcount_func) {
00343       return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
00344    }
00345 
00346    if (warned++ % 10 == 0) {
00347       ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00348    }
00349 
00350    return 0;
00351 }

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

References ast_messagecount_func, and ast_verb.

Referenced by acf_vmcount_exec().

00362 {
00363    static int warned = 0;
00364    if (ast_messagecount_func) {
00365       return ast_messagecount_func(context, mailbox, folder);
00366    }
00367 
00368    if (!warned) {
00369       warned++;
00370       ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
00371    }
00372 
00373    return 0;
00374 }

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

References ast_test_flag64, and ast_flags64::flags.

01955 {
01956    unsigned int i, found = 0;
01957    for (i = 32; i < 128 && found < len; i++) {
01958       if (ast_test_flag64(flags, options[i].flag)) {
01959          buf[found++] = i;
01960       }
01961    }
01962    buf[found] = '\0';
01963 }

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 1944 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(), confbridge_exec(), connectedline_write(), 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(), realtime_common(), receivefax_exec(), record_exec(), redirecting_write(), sendfax_exec(), sendurl_exec(), sig_pri_call(), sla_trunk_exec(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_background(), vm_exec(), and vm_execmain().

01945 {
01946    return parse_options(options, flags, args, optstr, 32);
01947 }

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

References ast_flags64::flags, and parse_options().

Referenced by conf_exec(), and dial_exec_full().

01950 {
01951    return parse_options(options, flags, args, optstr, 64);
01952 }

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

02155 {
02156    int res;
02157    char u[10];
02158 #ifdef HAVE_LONG_DOUBLE_WIDER
02159    long double amount;
02160    #define FMT "%30Lf%9s"
02161 #else
02162    double amount;
02163    #define FMT "%30lf%9s"
02164 #endif
02165    if (!timestr) {
02166       return -1;
02167    }
02168 
02169    if ((res = sscanf(timestr, FMT, &amount, u)) == 0) {
02170 #undef FMT
02171       return -1;
02172    } else if (res == 2) {
02173       switch (u[0]) {
02174       case 'h':
02175       case 'H':
02176          unit = TIMELEN_HOURS;
02177          break;
02178       case 's':
02179       case 'S':
02180          unit = TIMELEN_SECONDS;
02181          break;
02182       case 'm':
02183       case 'M':
02184          if (toupper(u[1]) == 'S') {
02185             unit = TIMELEN_MILLISECONDS;
02186          } else if (u[1] == '\0') {
02187             unit = TIMELEN_MINUTES;
02188          }
02189          break;
02190       }
02191    }
02192 
02193    switch (unit) {
02194    case TIMELEN_HOURS:
02195       amount *= 60;
02196       /* fall-through */
02197    case TIMELEN_MINUTES:
02198       amount *= 60;
02199       /* fall-through */
02200    case TIMELEN_SECONDS:
02201       amount *= 1000;
02202       /* fall-through */
02203    case TIMELEN_MILLISECONDS:
02204       ;
02205    }
02206    *result = amount > INT_MAX ? INT_MAX : (int) amount;
02207    return 0;
02208 }

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

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

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

References ast_sayname_func.

Referenced by common_exec(), and play_mailbox_owner().

00354 {
00355    if (ast_sayname_func) {
00356       return ast_sayname_func(chan, mailbox, context);
00357    }
00358    return -1;
00359 }

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

References closefrom().

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

02081 {
02082    closefrom(n + 1);
02083 }

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 558 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(), ast_channel::language, and ast_channel::stream.

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

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

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 376 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(), senddtmf_exec(), testclient_exec(), and testserver_exec().

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

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

01966 {
01967    int i;
01968    *consumed = 1;
01969    *result = 0;
01970    if (ast_strlen_zero(stream)) {
01971       *consumed = 0;
01972       return -1;
01973    }
01974 
01975    if (*stream == '\\') {
01976       *consumed = 2;
01977       switch (*(stream + 1)) {
01978       case 'n':
01979          *result = '\n';
01980          break;
01981       case 'r':
01982          *result = '\r';
01983          break;
01984       case 't':
01985          *result = '\t';
01986          break;
01987       case 'x':
01988          /* Hexadecimal */
01989          if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
01990             *consumed = 3;
01991             if (*(stream + 2) <= '9') {
01992                *result = *(stream + 2) - '0';
01993             } else if (*(stream + 2) <= 'F') {
01994                *result = *(stream + 2) - 'A' + 10;
01995             } else {
01996                *result = *(stream + 2) - 'a' + 10;
01997             }
01998          } else {
01999             ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
02000             return -1;
02001          }
02002 
02003          if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
02004             *consumed = 4;
02005             *result <<= 4;
02006             if (*(stream + 3) <= '9') {
02007                *result += *(stream + 3) - '0';
02008             } else if (*(stream + 3) <= 'F') {
02009                *result += *(stream + 3) - 'A' + 10;
02010             } else {
02011                *result += *(stream + 3) - 'a' + 10;
02012             }
02013          }
02014          break;
02015       case '0':
02016          /* Octal */
02017          *consumed = 2;
02018          for (i = 2; ; i++) {
02019             if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
02020                (*consumed)++;
02021                ast_debug(5, "result was %d, ", *result);
02022                *result <<= 3;
02023                *result += *(stream + i) - '0';
02024                ast_debug(5, "is now %d\n", *result);
02025             } else {
02026                break;
02027             }
02028          }
02029          break;
02030       default:
02031          *result = *(stream + 1);
02032       }
02033    } else {
02034       *result = *stream;
02035       *consumed = 1;
02036    }
02037    return 0;
02038 }

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

References ast_get_encoded_char().

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

02041 {
02042    char *cur = result;
02043    size_t consumed;
02044 
02045    while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
02046       cur++;
02047       stream += consumed;
02048    }
02049    *cur = '\0';
02050    return result;
02051 }

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

00279 {
00280    ast_has_voicemail_func = has_voicemail_func;
00281    ast_inboxcount_func = inboxcount_func;
00282    ast_inboxcount2_func = inboxcount2_func;
00283    ast_messagecount_func = messagecount_func;
00284    ast_sayname_func = sayname_func;
00285 }

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

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01824 {
01825    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01826    /* Hide internal coding */
01827    return res > 0 ? 0 : res;
01828 }

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 528 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, errno, linearstream, and LOG_WARNING.

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

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 1495 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 ast_module_reload(), and vm_lock_path().

01496 {
01497    enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
01498 
01499    switch (ast_lock_type) {
01500    case AST_LOCK_TYPE_LOCKFILE:
01501       r = ast_lock_path_lockfile(path);
01502       break;
01503    case AST_LOCK_TYPE_FLOCK:
01504       r = ast_lock_path_flock(path);
01505       break;
01506    }
01507 
01508    return r;
01509 }

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

References __ast_play_and_record().

Referenced by vm_forwardoptions().

01033 {
01034    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
01035 }

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

References __ast_play_and_record().

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

01028 {
01029    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
01030 }

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

References __ast_play_and_record(), and S_OR.

Referenced by play_record_review().

01023 {
01024    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));
01025 }

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

References AST_DIGIT_ANY, ast_stopstream(), ast_streamfile(), ast_waitstream(), 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(), 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().

00697 {
00698    int d = 0;
00699 
00700    if ((d = ast_streamfile(chan, fn, chan->language))) {
00701       return d;
00702    }
00703 
00704    d = ast_waitstream(chan, AST_DIGIT_ANY);
00705 
00706    ast_stopstream(chan);
00707 
00708    return d;
00709 }

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk.

Definition at line 1830 of file app.c.

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

Referenced by readfile_exec().

01831 {
01832    int fd, count = 0, res;
01833    char *output = NULL;
01834    struct stat filesize;
01835 
01836    if (stat(filename, &filesize) == -1) {
01837       ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
01838       return NULL;
01839    }
01840 
01841    count = filesize.st_size + 1;
01842 
01843    if ((fd = open(filename, O_RDONLY)) < 0) {
01844       ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
01845       return NULL;
01846    }
01847 
01848    if ((output = ast_malloc(count))) {
01849       res = read(fd, output, count - 1);
01850       if (res == count - 1) {
01851          output[res] = '\0';
01852       } else {
01853          ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
01854          ast_free(output);
01855          output = NULL;
01856       }
01857    }
01858 
01859    close(fd);
01860 
01861    return output;
01862 }

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

01528 {
01529    int silencethreshold;
01530    int maxsilence = 0;
01531    int res = 0;
01532    int cmd = 0;
01533    int max_attempts = 3;
01534    int attempts = 0;
01535    int recorded = 0;
01536    int message_exists = 0;
01537    /* Note that urgent and private are for flagging messages as such in the future */
01538 
01539    /* barf if no pointer passed to store duration in */
01540    if (!duration) {
01541       ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
01542       return -1;
01543    }
01544 
01545    cmd = '3';   /* Want to start by recording */
01546 
01547    silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
01548 
01549    while ((cmd >= 0) && (cmd != 't')) {
01550       switch (cmd) {
01551       case '1':
01552          if (!message_exists) {
01553             /* In this case, 1 is to record a message */
01554             cmd = '3';
01555             break;
01556          } else {
01557             ast_stream_and_wait(chan, "vm-msgsaved", "");
01558             cmd = 't';
01559             return res;
01560          }
01561       case '2':
01562          /* Review */
01563          ast_verb(3, "Reviewing the recording\n");
01564          cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
01565          break;
01566       case '3':
01567          message_exists = 0;
01568          /* Record */
01569          ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
01570          recorded = 1;
01571          if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path)) == -1) {
01572             /* User has hung up, no options to give */
01573             return cmd;
01574          }
01575          if (cmd == '0') {
01576             break;
01577          } else if (cmd == '*') {
01578             break;
01579          } else {
01580             /* If all is well, a message exists */
01581             message_exists = 1;
01582             cmd = 0;
01583          }
01584          break;
01585       case '4':
01586       case '5':
01587       case '6':
01588       case '7':
01589       case '8':
01590       case '9':
01591       case '*':
01592       case '#':
01593          cmd = ast_play_and_wait(chan, "vm-sorry");
01594          break;
01595       default:
01596          if (message_exists) {
01597             cmd = ast_play_and_wait(chan, "vm-review");
01598          } else {
01599             if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
01600                cmd = ast_waitfordigit(chan, 600);
01601             }
01602          }
01603 
01604          if (!cmd) {
01605             cmd = ast_waitfordigit(chan, 6000);
01606          }
01607          if (!cmd) {
01608             attempts++;
01609          }
01610          if (attempts > max_attempts) {
01611             cmd = 't';
01612          }
01613       }
01614    }
01615    if (cmd == 't') {
01616       cmd = 0;
01617    }
01618    return cmd;
01619 }

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 1000 of file asterisk.c.

References ast_mutex_lock, ast_mutex_unlock, safe_system_level, and safe_system_lock.

Referenced by ast_safe_fork(), and ast_safe_system().

01001 {
01002    unsigned int level;
01003 
01004    ast_mutex_lock(&safe_system_lock);
01005    level = safe_system_level++;
01006 
01007    /* only replace the handler if it has not already been done */
01008    if (level == 0) {
01009       sigaction(SIGCHLD, &null_sig_handler, &safe_system_prev_handler);
01010    }
01011 
01012    ast_mutex_unlock(&safe_system_lock);
01013 }

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 2085 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, and shaun_of_the_dead().

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

02086 {
02087    sigset_t signal_set, old_set;
02088    int pid;
02089 
02090    /* Don't let the default signal handler for children reap our status */
02091    if (stop_reaper) {
02092       ast_replace_sigchld();
02093    }
02094 
02095    sigfillset(&signal_set);
02096    pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
02097 
02098    pid = fork();
02099 
02100    if (pid != 0) {
02101       /* Fork failed or parent */
02102       pthread_sigmask(SIG_SETMASK, &old_set, NULL);
02103       if (!stop_reaper && pid > 0) {
02104          struct zombie *cur = ast_calloc(1, sizeof(*cur));
02105          if (cur) {
02106             cur->pid = pid;
02107             AST_LIST_LOCK(&zombies);
02108             AST_LIST_INSERT_TAIL(&zombies, cur, list);
02109             AST_LIST_UNLOCK(&zombies);
02110             if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
02111                if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
02112                   ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
02113                   shaun_of_the_dead_thread = AST_PTHREADT_NULL;
02114                }
02115             }
02116          }
02117       }
02118       return pid;
02119    } else {
02120       /* Child */
02121 #ifdef HAVE_CAP
02122       cap_t cap = cap_from_text("cap_net_admin-eip");
02123 
02124       if (cap_set_proc(cap)) {
02125          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
02126       }
02127       cap_free(cap);
02128 #endif
02129 
02130       /* Before we unblock our signals, return our trapped signals back to the defaults */
02131       signal(SIGHUP, SIG_DFL);
02132       signal(SIGCHLD, SIG_DFL);
02133       signal(SIGINT, SIG_DFL);
02134       signal(SIGURG, SIG_DFL);
02135       signal(SIGTERM, SIG_DFL);
02136       signal(SIGPIPE, SIG_DFL);
02137       signal(SIGXFSZ, SIG_DFL);
02138 
02139       /* unblock important signal handlers */
02140       if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
02141          ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
02142          _exit(1);
02143       }
02144 
02145       return pid;
02146    }
02147 }

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

References ast_unreplace_sigchld().

Referenced by agi_exec_full(), and run_ras().

02150 {
02151    ast_unreplace_sigchld();
02152 }

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

01031 {
01032    pid_t pid;
01033    int res;
01034    struct rusage rusage;
01035    int status;
01036 
01037 #if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
01038    ast_replace_sigchld();
01039 
01040 #ifdef HAVE_WORKING_FORK
01041    pid = fork();
01042 #else
01043    pid = vfork();
01044 #endif   
01045 
01046    if (pid == 0) {
01047 #ifdef HAVE_CAP
01048       cap_t cap = cap_from_text("cap_net_admin-eip");
01049 
01050       if (cap_set_proc(cap)) {
01051          /* Careful with order! Logging cannot happen after we close FDs */
01052          ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
01053       }
01054       cap_free(cap);
01055 #endif
01056 #ifdef HAVE_WORKING_FORK
01057       if (ast_opt_high_priority)
01058          ast_set_priority(0);
01059       /* Close file descriptors and launch system command */
01060       ast_close_fds_above_n(STDERR_FILENO);
01061 #endif
01062       execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
01063       _exit(1);
01064    } else if (pid > 0) {
01065       for (;;) {
01066          res = wait4(pid, &status, 0, &rusage);
01067          if (res > -1) {
01068             res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
01069             break;
01070          } else if (errno != EINTR) 
01071             break;
01072       }
01073    } else {
01074       ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
01075       res = -1;
01076    }
01077 
01078    ast_unreplace_sigchld();
01079 #else /* !defined(HAVE_WORKING_FORK) && !defined(HAVE_WORKING_VFORK) */
01080    res = -1;
01081 #endif
01082 
01083    return res;
01084 }

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

01491 {
01492    ast_lock_type = type;
01493 }

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

Referenced by sendtext_exec(), and system_exec_helper().

02054 {
02055    char next, *buf;
02056    size_t offset = 0;
02057    size_t consumed;
02058 
02059    if (strchr(stream, '\\')) {
02060       while (!ast_get_encoded_char(stream, &next, &consumed)) {
02061          if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
02062             ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
02063          }
02064          if (offset + 2 > ast_str_size(*str)) {
02065             break;
02066          }
02067          buf = ast_str_buffer(*str);
02068          buf[offset++] = next;
02069          stream += consumed;
02070       }
02071       buf = ast_str_buffer(*str);
02072       buf[offset++] = '\0';
02073       ast_str_update(*str);
02074    } else {
02075       ast_str_set(str, maxlen, "%s", stream);
02076    }
02077    return 0;
02078 }

AST_THREADSTORAGE_EXTERNAL ( ast_str_thread_global_buf   ) 

void ast_uninstall_vm_functions ( void   ) 

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

00288 {
00289    ast_has_voicemail_func = NULL;
00290    ast_inboxcount_func = NULL;
00291    ast_inboxcount2_func = NULL;
00292    ast_messagecount_func = NULL;
00293    ast_sayname_func = NULL;
00294 }

int ast_unlock_path ( const char *  path  ) 

Unlock a path.

Definition at line 1511 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(), ast_module_reload(), copy_message(), count_messages(), open_mailbox(), resequence_mailbox(), and save_to_folder().

01512 {
01513    int r = 0;
01514 
01515    switch (ast_lock_type) {
01516    case AST_LOCK_TYPE_LOCKFILE:
01517       r = ast_unlock_path_lockfile(path);
01518       break;
01519    case AST_LOCK_TYPE_FLOCK:
01520       r = ast_unlock_path_flock(path);
01521       break;
01522    }
01523 
01524    return r;
01525 }

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 1015 of file asterisk.c.

References ast_mutex_lock, ast_mutex_unlock, safe_system_level, and safe_system_lock.

Referenced by ast_safe_fork_cleanup(), and ast_safe_system().

01016 {
01017    unsigned int level;
01018 
01019    ast_mutex_lock(&safe_system_lock);
01020    level = --safe_system_level;
01021 
01022    /* only restore the handler if we are the last one */
01023    if (level == 0) {
01024       sigaction(SIGCHLD, &safe_system_prev_handler, NULL);
01025    }
01026 
01027    ast_mutex_unlock(&safe_system_lock);
01028 }


Generated on Mon Jun 27 16:50:58 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7