Tue Nov 4 13:20:23 2008

Asterisk developer's documentation


app.h File Reference

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

Go to the source code of this file.

Data Structures

struct  ast_app_option
 A structure to hold the description of an application 'option'. More...
struct  ast_group_info
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_DECLARE_APP_ARGS(name, arglist)
 Declare a structure to hold the 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, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
 Performs the 'nonstandard' argument separation process for an application.
#define AST_STANDARD_APP_ARGS(args, parse)   args.argc = ast_app_separate_args(parse, '|', args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
 Performs the 'standard' argument separation process for an application.
#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_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 }

Functions

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, char *prompt, char *s, int maxlen, int timeout)
 Plays a stream and gets DTMF data from a channel.
int ast_app_getdata_full (struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
 Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions.
int ast_app_group_discard (struct ast_channel *chan)
int ast_app_group_get_count (const char *group, const char *category)
ast_group_infoast_app_group_list_head (void)
int ast_app_group_list_lock (void)
int ast_app_group_list_unlock (void)
int ast_app_group_match_get_count (const char *groupmatch, const char *category)
int ast_app_group_set_channel (struct ast_channel *chan, const char *data)
int ast_app_group_split_group (const char *data, char *group, int group_max, char *category, int category_max)
int ast_app_group_update (struct ast_channel *oldchan, struct ast_channel *newchan)
int ast_app_has_voicemail (const char *mailbox, const char *folder)
int ast_app_inboxcount (const char *mailbox, int *newmsgs, int *oldmsgs)
int ast_app_messagecount (const char *context, const char *mailbox, const char *folder)
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.
unsigned int ast_app_separate_args (char *buf, char delim, char **array, int arraylen)
 Separate a string into arguments in an array.
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)
int ast_dtmf_stream (struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between)
 Send DTMF to a channel.
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(*messagecount_func)(const char *context, const char *mailbox, const char *folder))
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)
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)
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)
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)
char * ast_read_textfile (const char *file)
int ast_record_review (struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path)
void ast_replace_sigchld (void)
 Replace the SIGCHLD handler.
int ast_safe_system (const char *s)
void ast_uninstall_vm_functions (void)
int ast_unlock_path (const char *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 244 of file app.h.

Referenced by __login_exec(), acf_channel_read(), acf_curl_exec(), acf_if(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_vmcount_exec(), add_agent(), admin_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), cdr_read(), cdr_write(), chanavail_exec(), checkmd5(), conf_exec(), count_exec(), cut_internal(), dictate_exec(), directory_exec(), disa_exec(), filter(), find_conf(), forkcdr_exec(), func_header_read(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldqty(), function_realtime_read(), function_realtime_write(), hasvoicemail_exec(), isAnsweringMachine(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), pbx_builtin_background(), pbx_builtin_saydate(), pbx_builtin_saytime(), pbx_builtin_waitexten(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), read_exec(), record_exec(), regex(), reload_queues(), rqm_exec(), sayunixtime_exec(), sendimage_exec(), sendtext_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), transfer_exec(), upqm_exec(), userevent_exec(), vm_box_exists(), vm_exec(), and vm_execmain().

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

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

Declares an array of options for an application.

Parameters:
holder The name of the array to be created
options The actual options to be placed into the array
See also:
ast_app_parse_options
This macro declares a 'static const' array of struct ast_option elements to hold the list of available options for an application. Each option must be declared using either the AST_APP_OPTION() or AST_APP_OPTION_ARG() macros.

Example usage:

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

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

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

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

   ... do any argument parsing here ...

   if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
      LOCAL_USER_REMOVE(u);
      return -1;
   }
  }

Definition at line 380 of file app.h.

#define AST_DECLARE_APP_ARGS ( name,
arglist   ) 

Value:

struct { \
      unsigned int argc; \
      char *argv[0]; \
      arglist \
   } name
Declare a structure to hold the application's arguments.

Parameters:
name The name of the structure
arglist The list of arguments, defined using AST_APP_ARG
This macro defines 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 261 of file app.h.

Referenced by __login_exec(), acf_channel_read(), acf_curl_exec(), acf_if(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_vmcount_exec(), add_agent(), admin_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), cdr_read(), cdr_write(), chanavail_exec(), checkmd5(), conf_exec(), count_exec(), cut_internal(), dictate_exec(), directory_exec(), disa_exec(), filter(), find_conf(), forkcdr_exec(), func_header_read(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldqty(), function_realtime_read(), function_realtime_write(), hasvoicemail_exec(), isAnsweringMachine(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), pbx_builtin_background(), pbx_builtin_saydate(), pbx_builtin_saytime(), pbx_builtin_waitexten(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), read_exec(), record_exec(), regex(), reload_queues(), rqm_exec(), sayunixtime_exec(), sendimage_exec(), sendtext_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), transfer_exec(), upqm_exec(), userevent_exec(), vm_box_exists(), vm_exec(), and vm_execmain().

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

#define AST_IVR_FLAG_AUTORESTART   (1 << 0)

Definition at line 74 of file app.h.

#define AST_NONSTANDARD_APP_ARGS ( args,
parse,
sep   )     args.argc = ast_app_separate_args(parse, sep, 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 290 of file app.h.

Referenced by acf_if(), acf_odbc_write(), add_agent(), array(), find_conf(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), record_exec(), regex(), and reload_queues().

#define AST_STANDARD_APP_ARGS ( args,
parse   )     args.argc = ast_app_separate_args(parse, '|', 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 277 of file app.h.

Referenced by __login_exec(), acf_channel_read(), acf_curl_exec(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_sprintf(), acf_strftime(), acf_strptime(), acf_vmcount_exec(), admin_exec(), app_exec(), aqm_exec(), array(), astman_get_variables(), asyncgoto_exec(), auth_exec(), cdr_read(), cdr_write(), chanavail_exec(), checkmd5(), conf_exec(), count_exec(), cut_internal(), dictate_exec(), directory_exec(), disa_exec(), filter(), func_header_read(), function_enum(), function_fieldqty(), function_realtime_read(), function_realtime_write(), hasvoicemail_exec(), isAnsweringMachine(), math(), misdn_check_l2l1(), mixmonitor_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), pbx_builtin_background(), pbx_builtin_saydate(), pbx_builtin_saytime(), pbx_builtin_waitexten(), playback_exec(), pqm_exec(), privacy_exec(), ql_exec(), queue_exec(), read_exec(), rqm_exec(), sayunixtime_exec(), sendimage_exec(), sendtext_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), transfer_exec(), upqm_exec(), userevent_exec(), vm_box_exists(), vm_exec(), and vm_execmain().

#define BEGIN_OPTIONS   {

Definition at line 329 of file app.h.

#define END_OPTIONS   }

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


Enumeration Type Documentation

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[]
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 37 of file app.h.

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

00186                      {
00187    AST_LOCK_SUCCESS = 0,
00188    AST_LOCK_TIMEOUT = -1,
00189    AST_LOCK_PATH_NOT_FOUND = -2,
00190    AST_LOCK_FAILURE = -3,
00191 };


Function Documentation

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

Present a dialtone and collect a certain length extension.

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

Definition at line 65 of file app.c.

References ast_exists_extension(), ast_get_indication_tone(), ast_ignore_pattern(), ast_log(), ast_matchmore_extension(), ast_playtones_start(), ast_playtones_stop(), ast_waitfordigit(), ast_channel::cid, ast_callerid::cid_num, tone_zone_sound::data, ast_pbx::dtimeout, LOG_NOTICE, ast_channel::pbx, and ast_channel::zone.

Referenced by builtin_blindtransfer(), and do_atxfer().

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

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

References ast_readstring(), ast_streamfile(), ast_pbx::dtimeout, ast_channel::pbx, and ast_pbx::rtimeout.

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

00108 {
00109    int res,to,fto;
00110    /* XXX Merge with full version? XXX */
00111    if (maxlen)
00112       s[0] = '\0';
00113    if (prompt) {
00114       res = ast_streamfile(c, prompt, c->language);
00115       if (res < 0)
00116          return res;
00117    }
00118    fto = c->pbx ? c->pbx->rtimeout * 1000 : 6000;
00119    to = c->pbx ? c->pbx->dtimeout * 1000 : 2000;
00120 
00121    if (timeout > 0) 
00122       fto = to = timeout;
00123    if (timeout < 0) 
00124       fto = to = 1000000000;
00125    res = ast_readstring(c, s, maxlen, to, fto, "#");
00126    return res;
00127 }

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

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

Definition at line 130 of file app.c.

References ast_readstring_full(), and ast_streamfile().

Referenced by handle_getdata().

00131 {
00132    int res, to, fto;
00133    if (prompt) {
00134       res = ast_streamfile(c, prompt, c->language);
00135       if (res < 0)
00136          return res;
00137    }
00138    fto = 6000;
00139    to = 2000;
00140    if (timeout > 0) 
00141       fto = to = timeout;
00142    if (timeout < 0) 
00143       fto = to = 1000000000;
00144    res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
00145    return res;
00146 }

int ast_app_group_discard ( struct ast_channel chan  ) 

Discard all group counting for a channel

Definition at line 923 of file app.c.

References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_group_info::chan, and free.

Referenced by ast_channel_free().

00924 {
00925    struct ast_group_info *gi = NULL;
00926    
00927    AST_LIST_LOCK(&groups);
00928    AST_LIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
00929       if (gi->chan == chan) {
00930          AST_LIST_REMOVE_CURRENT(&groups, list);
00931          free(gi);
00932       }
00933    }
00934         AST_LIST_TRAVERSE_SAFE_END
00935    AST_LIST_UNLOCK(&groups);
00936    
00937    return 0;
00938 }

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

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero(), ast_group_info::category, and ast_group_info::group.

Referenced by group_count_function_read().

00867 {
00868    struct ast_group_info *gi = NULL;
00869    int count = 0;
00870 
00871    if (ast_strlen_zero(group))
00872       return 0;
00873    
00874    AST_LIST_LOCK(&groups);
00875    AST_LIST_TRAVERSE(&groups, gi, list) {
00876       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
00877          count++;
00878    }
00879    AST_LIST_UNLOCK(&groups);
00880 
00881    return count;
00882 }

struct ast_group_info* ast_app_group_list_head ( void   ) 

Get the head of the group count list

Definition at line 945 of file app.c.

References AST_LIST_FIRST.

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

00946 {
00947    return AST_LIST_FIRST(&groups);
00948 }

int ast_app_group_list_lock ( void   ) 

Lock the group count list

Definition at line 940 of file app.c.

References AST_LIST_LOCK.

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

00941 {
00942    return AST_LIST_LOCK(&groups);
00943 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list

Definition at line 950 of file app.c.

References AST_LIST_UNLOCK.

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

00951 {
00952    return AST_LIST_UNLOCK(&groups);
00953 }

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

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero(), ast_group_info::category, and ast_group_info::group.

Referenced by group_match_count_function_read().

00885 {
00886    struct ast_group_info *gi = NULL;
00887    regex_t regexbuf;
00888    int count = 0;
00889 
00890    if (ast_strlen_zero(groupmatch))
00891       return 0;
00892 
00893    /* if regex compilation fails, return zero matches */
00894    if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
00895       return 0;
00896 
00897    AST_LIST_LOCK(&groups);
00898    AST_LIST_TRAVERSE(&groups, gi, list) {
00899       if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
00900          count++;
00901    }
00902    AST_LIST_UNLOCK(&groups);
00903 
00904    regfree(&regexbuf);
00905 
00906    return count;
00907 }

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

References ast_app_group_split_group(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_strlen_zero(), calloc, ast_group_info::category, ast_group_info::chan, free, ast_group_info::group, group, and len.

Referenced by group_function_write().

00822 {
00823    int res = 0;
00824    char group[80] = "", category[80] = "";
00825    struct ast_group_info *gi = NULL;
00826    size_t len = 0;
00827    
00828    if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category)))
00829       return -1;
00830    
00831    /* Calculate memory we will need if this is new */
00832    len = sizeof(*gi) + strlen(group) + 1;
00833    if (!ast_strlen_zero(category))
00834       len += strlen(category) + 1;
00835    
00836    AST_LIST_LOCK(&groups);
00837    AST_LIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
00838       if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
00839          AST_LIST_REMOVE_CURRENT(&groups, list);
00840          free(gi);
00841          break;
00842       }
00843    }
00844    AST_LIST_TRAVERSE_SAFE_END
00845 
00846    if (ast_strlen_zero(group)) {
00847       /* Enable unsetting the group */
00848    } else if ((gi = calloc(1, len))) {
00849       gi->chan = chan;
00850       gi->group = (char *) gi + sizeof(*gi);
00851       strcpy(gi->group, group);
00852       if (!ast_strlen_zero(category)) {
00853          gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
00854          strcpy(gi->category, category);
00855       }
00856       AST_LIST_INSERT_TAIL(&groups, gi, list);
00857    } else {
00858       res = -1;
00859    }
00860    
00861    AST_LIST_UNLOCK(&groups);
00862    
00863    return res;
00864 }

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

References ast_strlen_zero().

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

00795 {
00796    int res=0;
00797    char tmp[256];
00798    char *grp=NULL, *cat=NULL;
00799 
00800    if (!ast_strlen_zero(data)) {
00801       ast_copy_string(tmp, data, sizeof(tmp));
00802       grp = tmp;
00803       cat = strchr(tmp, '@');
00804       if (cat) {
00805          *cat = '\0';
00806          cat++;
00807       }
00808    }
00809 
00810    if (!ast_strlen_zero(grp))
00811       ast_copy_string(group, grp, group_max);
00812    else
00813       *group = '\0';
00814 
00815    if (!ast_strlen_zero(cat))
00816       ast_copy_string(category, cat, category_max);
00817 
00818    return res;
00819 }

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

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, and ast_group_info::chan.

Referenced by ast_do_masquerade().

00910 {
00911    struct ast_group_info *gi = NULL;
00912 
00913    AST_LIST_LOCK(&groups);
00914    AST_LIST_TRAVERSE(&groups, gi, list) {
00915       if (gi->chan == old)
00916          gi->chan = new;
00917    }
00918    AST_LIST_UNLOCK(&groups);
00919 
00920    return 0;
00921 }

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

Determine if a given mailbox has any voicemail

Definition at line 168 of file app.c.

References ast_has_voicemail_func, ast_verbose(), option_verbose, and VERBOSE_PREFIX_3.

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

00169 {
00170    static int warned = 0;
00171    if (ast_has_voicemail_func)
00172       return ast_has_voicemail_func(mailbox, folder);
00173 
00174    if ((option_verbose > 2) && !warned) {
00175       ast_verbose(VERBOSE_PREFIX_3 "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
00176       warned++;
00177    }
00178    return 0;
00179 }

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

Determine number of new/old messages in a mailbox

Definition at line 182 of file app.c.

References ast_inboxcount_func, ast_verbose(), option_verbose, and VERBOSE_PREFIX_3.

Referenced by action_mailboxcount(), notify_new_message(), sip_send_mwi_to_peer(), and update_registry().

00183 {
00184    static int warned = 0;
00185    if (newmsgs)
00186       *newmsgs = 0;
00187    if (oldmsgs)
00188       *oldmsgs = 0;
00189    if (ast_inboxcount_func)
00190       return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
00191 
00192    if (!warned && (option_verbose > 2)) {
00193       warned++;
00194       ast_verbose(VERBOSE_PREFIX_3 "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
00195    }
00196 
00197    return 0;
00198 }

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

Determine number of messages in a given mailbox and folder

Definition at line 200 of file app.c.

References ast_messagecount_func, ast_verbose(), option_verbose, and VERBOSE_PREFIX_3.

Referenced by acf_vmcount_exec(), and hasvoicemail_exec().

00201 {
00202    static int warned = 0;
00203    if (ast_messagecount_func)
00204       return ast_messagecount_func(context, mailbox, folder);
00205 
00206    if (!warned && (option_verbose > 2)) {
00207       warned++;
00208       ast_verbose(VERBOSE_PREFIX_3 "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
00209    }
00210 
00211    return 0;
00212 }

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

References ast_app_option::arg_index, ast_clear_flag, AST_FLAGS_ALL, ast_log(), ast_set_flag, LOG_WARNING, and s.

Referenced by app_exec(), auth_exec(), cdr_read(), cdr_write(), chanspy_exec(), conf_exec(), extenspy_exec(), mixmonitor_exec(), page_exec(), pbx_builtin_background(), pbx_builtin_resetcdr(), pbx_builtin_waitexten(), read_exec(), smdi_msg_retrieve_read(), vm_exec(), and vm_execmain().

01391 {
01392    char *s;
01393    int curarg;
01394    unsigned int argloc;
01395    char *arg;
01396    int res = 0;
01397 
01398    ast_clear_flag(flags, AST_FLAGS_ALL);
01399 
01400    if (!optstr)
01401       return 0;
01402 
01403    s = optstr;
01404    while (*s) {
01405       curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
01406       argloc = options[curarg].arg_index;
01407       if (*s == '(') {
01408          /* Has argument */
01409          arg = ++s;
01410          if ((s = strchr(s, ')'))) {
01411             if (argloc)
01412                args[argloc - 1] = arg;
01413             *s++ = '\0';
01414          } else {
01415             ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
01416             res = -1;
01417             break;
01418          }
01419       } else if (argloc) {
01420          args[argloc - 1] = "";
01421       }
01422       ast_set_flag(flags, options[curarg].flag);
01423    }
01424 
01425    return res;
01426 }

unsigned int ast_app_separate_args ( char *  buf,
char  delim,
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
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 955 of file app.c.

References quote().

Referenced by app_exec(), chanspy_exec(), common_exec(), controlplayback_exec(), extenspy_exec(), pbx_builtin_setvar(), speech_background(), and speech_load().

00956 {
00957    int argc;
00958    char *scan;
00959    int paren = 0, quote = 0;
00960 
00961    if (!buf || !array || !arraylen)
00962       return 0;
00963 
00964    memset(array, 0, arraylen * sizeof(*array));
00965 
00966    scan = buf;
00967 
00968    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
00969       array[argc] = scan;
00970       for (; *scan; scan++) {
00971          if (*scan == '(')
00972             paren++;
00973          else if (*scan == ')') {
00974             if (paren)
00975                paren--;
00976          } else if (*scan == '"' && delim != '"') {
00977             quote = quote ? 0 : 1;
00978             /* Remove quote character from argument */
00979             memmove(scan, scan + 1, strlen(scan));
00980             scan--;
00981          } else if (*scan == '\\') {
00982             /* Literal character, don't parse */
00983             memmove(scan, scan + 1, strlen(scan));
00984          } else if ((*scan == delim) && !paren && !quote) {
00985             *scan++ = '\0';
00986             break;
00987          }
00988       }
00989    }
00990 
00991    if (*scan)
00992       array[argc++] = scan;
00993 
00994    return argc;
00995 }

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 
)

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

Definition at line 371 of file app.c.

References ast_channel::_state, ast_answer(), ast_log(), ast_seekstream(), AST_STATE_UP, ast_stopstream(), ast_streamfile(), ast_tellstream(), ast_waitfordigit(), ast_waitstream_fr(), LOG_DEBUG, option_debug, and ast_channel::stream.

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

00375 {
00376    char *breaks = NULL;
00377    char *end = NULL;
00378    int blen = 2;
00379    int res;
00380    long pause_restart_point = 0;
00381 
00382    if (stop)
00383       blen += strlen(stop);
00384    if (pause)
00385       blen += strlen(pause);
00386    if (restart)
00387       blen += strlen(restart);
00388 
00389    if (blen > 2) {
00390       breaks = alloca(blen + 1);
00391       breaks[0] = '\0';
00392       if (stop)
00393          strcat(breaks, stop);
00394       if (pause)
00395          strcat(breaks, pause);
00396       if (restart)
00397          strcat(breaks, restart);
00398    }
00399    if (chan->_state != AST_STATE_UP)
00400       res = ast_answer(chan);
00401 
00402    if (file) {
00403       if ((end = strchr(file,':'))) {
00404          if (!strcasecmp(end, ":end")) {
00405             *end = '\0';
00406             end++;
00407          }
00408       }
00409    }
00410 
00411    for (;;) {
00412       ast_stopstream(chan);
00413       res = ast_streamfile(chan, file, chan->language);
00414       if (!res) {
00415          if (pause_restart_point) {
00416             ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
00417             pause_restart_point = 0;
00418          }
00419          else if (end) {
00420             ast_seekstream(chan->stream, 0, SEEK_END);
00421             end = NULL;
00422          };
00423          res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
00424       }
00425 
00426       if (res < 1)
00427          break;
00428 
00429       /* We go at next loop if we got the restart char */
00430       if (restart && strchr(restart, res)) {
00431          if (option_debug)
00432             ast_log(LOG_DEBUG, "we'll restart the stream here at next loop\n");
00433          pause_restart_point = 0;
00434          continue;
00435       }
00436 
00437       if (pause && strchr(pause, res)) {
00438          pause_restart_point = ast_tellstream(chan->stream);
00439          for (;;) {
00440             ast_stopstream(chan);
00441             res = ast_waitfordigit(chan, 1000);
00442             if (!res)
00443                continue;
00444             else if (res == -1 || strchr(pause, res) || (stop && strchr(stop, res)))
00445                break;
00446          }
00447          if (res == *pause) {
00448             res = 0;
00449             continue;
00450          }
00451       }
00452 
00453       if (res == -1)
00454          break;
00455 
00456       /* if we get one of our stop chars, return it to the calling function */
00457       if (stop && strchr(stop, res))
00458          break;
00459    }
00460 
00461    /* If we are returning a digit cast it as char */
00462    if (res > 0 || chan->stream)
00463       res = (char)res;
00464 
00465    ast_stopstream(chan);
00466 
00467    return res;
00468 }

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

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.

Definition at line 214 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(), misdn_send_digit(), senddtmf_exec(), testclient_exec(), and testserver_exec().

00215 {
00216    const char *ptr;
00217    int res = 0;
00218    struct ast_silence_generator *silgen = NULL;
00219 
00220    if (!between)
00221       between = 100;
00222 
00223    if (peer)
00224       res = ast_autoservice_start(peer);
00225 
00226    if (!res)
00227       res = ast_waitfor(chan, 100);
00228 
00229    /* ast_waitfor will return the number of remaining ms on success */
00230    if (res < 0)
00231       return res;
00232 
00233    if (ast_opt_transmit_silence) {
00234       silgen = ast_channel_start_silence_generator(chan);
00235    }
00236 
00237    for (ptr = digits; *ptr; ptr++) {
00238       if (*ptr == 'w') {
00239          /* 'w' -- wait half a second */
00240          if ((res = ast_safe_sleep(chan, 500)))
00241             break;
00242       } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
00243          /* Character represents valid DTMF */
00244          if (*ptr == 'f' || *ptr == 'F') {
00245             /* ignore return values if not supported by channel */
00246             ast_indicate(chan, AST_CONTROL_FLASH);
00247          } else
00248             ast_senddigit(chan, *ptr);
00249          /* pause between digits */
00250          if ((res = ast_safe_sleep(chan, between)))
00251             break;
00252       } else
00253          ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n",*ptr);
00254    }
00255 
00256    if (peer) {
00257       /* Stop autoservice on the peer channel, but don't overwrite any error condition 
00258          that has occurred previously while acting on the primary channel */
00259       if (ast_autoservice_stop(peer) && !res)
00260          res = -1;
00261    }
00262 
00263    if (silgen) {
00264       ast_channel_stop_silence_generator(chan, silgen);
00265    }
00266 
00267    return res;
00268 }

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 *context, const char *mailbox, const char *folder)  messagecount_func 
)

Definition at line 152 of file app.c.

References ast_has_voicemail_func, ast_inboxcount_func, and ast_messagecount_func.

Referenced by load_module().

00155 {
00156    ast_has_voicemail_func = has_voicemail_func;
00157    ast_inboxcount_func = inboxcount_func;
00158    ast_messagecount_func = messagecount_func;
00159 }

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

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01353 {
01354    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01355    /* Hide internal coding */
01356    return res > 0 ? 0 : res;
01357 }

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

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

00343 {
00344    struct linear_state *lin;
00345    char tmpf[256];
00346    int res = -1;
00347    int autoclose = 0;
00348    if (fd < 0) {
00349       if (ast_strlen_zero(filename))
00350          return -1;
00351       autoclose = 1;
00352       if (filename[0] == '/') 
00353          ast_copy_string(tmpf, filename, sizeof(tmpf));
00354       else
00355          snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", (char *)ast_config_AST_DATA_DIR, "sounds", filename);
00356       fd = open(tmpf, O_RDONLY);
00357       if (fd < 0){
00358          ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
00359          return -1;
00360       }
00361    }
00362    if ((lin = ast_calloc(1, sizeof(*lin)))) {
00363       lin->fd = fd;
00364       lin->allowoverride = allowoverride;
00365       lin->autoclose = autoclose;
00366       res = ast_activate_generator(chan, &linearstream, lin);
00367    }
00368    return res;
00369 }

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

References AST_LOCK_FAILURE, AST_LOCK_PATH_NOT_FOUND, AST_LOCK_SUCCESS, AST_LOCK_TIMEOUT, ast_log(), ast_random(), errno, LOG_DEBUG, LOG_ERROR, LOG_WARNING, option_debug, and s.

Referenced by vm_lock_path().

00998 {
00999    char *s;
01000    char *fs;
01001    int res;
01002    int fd;
01003    int lp = strlen(path);
01004    time_t start;
01005 
01006    if (!(s = alloca(lp + 10)) || !(fs = alloca(lp + 20))) {
01007       ast_log(LOG_WARNING, "Out of memory!\n");
01008       return AST_LOCK_FAILURE;
01009    }
01010 
01011    snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
01012    fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, 0600);
01013    if (fd < 0) {
01014       ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
01015       return AST_LOCK_PATH_NOT_FOUND;
01016    }
01017    close(fd);
01018 
01019    snprintf(s, strlen(path) + 9, "%s/.lock", path);
01020    start = time(NULL);
01021    while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
01022       usleep(1);
01023 
01024    unlink(fs);
01025 
01026    if (res) {
01027       ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
01028       return AST_LOCK_TIMEOUT;
01029    } else {
01030       if (option_debug)
01031          ast_log(LOG_DEBUG, "Locked path '%s'\n", path);
01032       return AST_LOCK_SUCCESS;
01033    }
01034 }

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

References __ast_play_and_record().

Referenced by vm_forwardoptions().

00788 {
00789    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
00790 }

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

References __ast_play_and_record().

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

00783 {
00784    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
00785 }

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

References __ast_play_and_record(), and S_OR.

Referenced by play_record_review().

00778 {
00779    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));
00780 }

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

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

Referenced by __ast_play_and_record(), advanced_options(), ast_record_review(), dialout(), forward_message(), get_folder(), get_folder2(), leave_voicemail(), play_message_category(), play_message_duration(), play_record_review(), vm_authenticate(), vm_browse_messages_en(), vm_browse_messages_latin(), vm_execmain(), vm_forwardoptions(), vm_instructions(), vm_intro(), vm_intro_cz(), vm_intro_de(), vm_intro_en(), vm_intro_es(), vm_intro_fr(), vm_intro_gr(), vm_intro_it(), vm_intro_nl(), vm_intro_no(), vm_intro_pl(), vm_intro_pt(), vm_intro_pt_BR(), vm_intro_ru(), vm_intro_se(), vm_intro_ua(), 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().

00471 {
00472    int d;
00473    d = ast_streamfile(chan, fn, chan->language);
00474    if (d)
00475       return d;
00476    d = ast_waitstream(chan, AST_DIGIT_ANY);
00477    ast_stopstream(chan);
00478    return d;
00479 }

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk

Definition at line 1359 of file app.c.

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

Referenced by readfile_exec().

01360 {
01361    int fd;
01362    char *output = NULL;
01363    struct stat filesize;
01364    int count = 0;
01365    int res;
01366    if (stat(filename, &filesize) == -1) {
01367       ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
01368       return NULL;
01369    }
01370    count = filesize.st_size + 1;
01371    fd = open(filename, O_RDONLY);
01372    if (fd < 0) {
01373       ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
01374       return NULL;
01375    }
01376    if ((output = ast_malloc(count))) {
01377       res = read(fd, output, count - 1);
01378       if (res == count - 1) {
01379          output[res] = '\0';
01380       } else {
01381          ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
01382          free(output);
01383          output = NULL;
01384       }
01385    }
01386    close(fd);
01387    return output;
01388 }

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

References AST_DIGIT_ANY, ast_log(), ast_play_and_record(), ast_play_and_wait(), ast_stream_and_wait(), ast_verbose(), ast_waitfordigit(), ast_group_info::chan, LOG_WARNING, maxsilence, silencethreshold, and VERBOSE_PREFIX_3.

Referenced by conf_run().

01059 {
01060    int silencethreshold = 128; 
01061    int maxsilence=0;
01062    int res = 0;
01063    int cmd = 0;
01064    int max_attempts = 3;
01065    int attempts = 0;
01066    int recorded = 0;
01067    int message_exists = 0;
01068    /* Note that urgent and private are for flagging messages as such in the future */
01069 
01070    /* barf if no pointer passed to store duration in */
01071    if (duration == NULL) {
01072       ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
01073       return -1;
01074    }
01075 
01076    cmd = '3';   /* Want to start by recording */
01077 
01078    while ((cmd >= 0) && (cmd != 't')) {
01079       switch (cmd) {
01080       case '1':
01081          if (!message_exists) {
01082             /* In this case, 1 is to record a message */
01083             cmd = '3';
01084             break;
01085          } else {
01086             ast_stream_and_wait(chan, "vm-msgsaved", chan->language, "");
01087             cmd = 't';
01088             return res;
01089          }
01090       case '2':
01091          /* Review */
01092          ast_verbose(VERBOSE_PREFIX_3 "Reviewing the recording\n");
01093          cmd = ast_stream_and_wait(chan, recordfile, chan->language, AST_DIGIT_ANY);
01094          break;
01095       case '3':
01096          message_exists = 0;
01097          /* Record */
01098          if (recorded == 1)
01099             ast_verbose(VERBOSE_PREFIX_3 "Re-recording\n");
01100          else  
01101             ast_verbose(VERBOSE_PREFIX_3 "Recording\n");
01102          recorded = 1;
01103          cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
01104          if (cmd == -1) {
01105          /* User has hung up, no options to give */
01106             return cmd;
01107          }
01108          if (cmd == '0') {
01109             break;
01110          } else if (cmd == '*') {
01111             break;
01112          } 
01113          else {
01114             /* If all is well, a message exists */
01115             message_exists = 1;
01116             cmd = 0;
01117          }
01118          break;
01119       case '4':
01120       case '5':
01121       case '6':
01122       case '7':
01123       case '8':
01124       case '9':
01125       case '*':
01126       case '#':
01127          cmd = ast_play_and_wait(chan, "vm-sorry");
01128          break;
01129       default:
01130          if (message_exists) {
01131             cmd = ast_play_and_wait(chan, "vm-review");
01132          }
01133          else {
01134             cmd = ast_play_and_wait(chan, "vm-torerecord");
01135             if (!cmd)
01136                cmd = ast_waitfordigit(chan, 600);
01137          }
01138          
01139          if (!cmd)
01140             cmd = ast_waitfordigit(chan, 6000);
01141          if (!cmd) {
01142             attempts++;
01143          }
01144          if (attempts > max_attempts) {
01145             cmd = 't';
01146          }
01147       }
01148    }
01149    if (cmd == 't')
01150       cmd = 0;
01151    return cmd;
01152 }

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

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

Definition at line 865 of file asterisk.c.

References ast_mutex_lock(), ast_mutex_unlock(), and null_sig_handler().

Referenced by agi_exec_full(), and ast_safe_system().

00866 {
00867    unsigned int level;
00868 
00869    ast_mutex_lock(&safe_system_lock);
00870    level = safe_system_level++;
00871 
00872    /* only replace the handler if it has not already been done */
00873    if (level == 0)
00874       safe_system_prev_handler = signal(SIGCHLD, null_sig_handler);
00875 
00876    ast_mutex_unlock(&safe_system_lock);
00877 }

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

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

Referenced by alarmreceiver_exec(), ast_closestream(), ast_monitor_change_fname(), ast_monitor_start(), ast_monitor_stop(), consolehandler(), make_email_file(), mixmonitor_thread(), process_text_line(), remoteconsolehandler(), run_externnotify(), sendmail(), sendpage(), system_exec_helper(), and vm_change_password_shell().

00894 {
00895    pid_t pid;
00896 #ifdef HAVE_WORKING_FORK
00897    int x;
00898 #endif
00899    int res;
00900    struct rusage rusage;
00901    int status;
00902 
00903 #if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
00904    ast_replace_sigchld();
00905 
00906 #ifdef HAVE_WORKING_FORK
00907    pid = fork();
00908 #else
00909    pid = vfork();
00910 #endif   
00911 
00912    if (pid == 0) {
00913 #ifdef HAVE_WORKING_FORK
00914       if (ast_opt_high_priority)
00915          ast_set_priority(0);
00916       /* Close file descriptors and launch system command */
00917       for (x = STDERR_FILENO + 1; x < 4096; x++)
00918          close(x);
00919 #endif
00920       execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
00921       _exit(1);
00922    } else if (pid > 0) {
00923       for(;;) {
00924          res = wait4(pid, &status, 0, &rusage);
00925          if (res > -1) {
00926             res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
00927             break;
00928          } else if (errno != EINTR) 
00929             break;
00930       }
00931    } else {
00932       ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
00933       res = -1;
00934    }
00935 
00936    ast_unreplace_sigchld();
00937 #else
00938    res = -1;
00939 #endif
00940 
00941    return res;
00942 }

void ast_uninstall_vm_functions ( void   ) 

Definition at line 161 of file app.c.

References ast_has_voicemail_func, ast_inboxcount_func, and ast_messagecount_func.

Referenced by unload_module().

00162 {
00163    ast_has_voicemail_func = NULL;
00164    ast_inboxcount_func = NULL;
00165    ast_messagecount_func = NULL;
00166 }

int ast_unlock_path ( const char *  path  ) 

Unlock a path

Definition at line 1036 of file app.c.

References ast_log(), errno, LOG_DEBUG, LOG_ERROR, LOG_WARNING, option_debug, and s.

Referenced by __ast_play_and_record(), copy_message(), count_messages(), last_message_index(), leave_voicemail(), resequence_mailbox(), and save_to_folder().

01037 {
01038    char *s;
01039    int res;
01040 
01041    if (!(s = alloca(strlen(path) + 10))) {
01042       ast_log(LOG_WARNING, "Out of memory!\n");
01043       return -1;
01044    }
01045 
01046    snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
01047 
01048    if ((res = unlink(s)))
01049       ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
01050    else {
01051       if (option_debug)
01052          ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
01053    }
01054 
01055    return res;
01056 }

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

References ast_mutex_lock(), and ast_mutex_unlock().

Referenced by agi_exec_full(), and ast_safe_system().

00880 {
00881    unsigned int level;
00882 
00883    ast_mutex_lock(&safe_system_lock);
00884    level = --safe_system_level;
00885 
00886    /* only restore the handler if we are the last one */
00887    if (level == 0)
00888       signal(SIGCHLD, safe_system_prev_handler);
00889 
00890    ast_mutex_unlock(&safe_system_lock);
00891 }


Generated on Tue Nov 4 13:20:23 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7