Fri Sep 25 19:28:16 2009

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) - sizeof(args.argc)) / 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) - sizeof(args.argc)) / 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)
struct 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 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(), 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_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(), 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) - sizeof(args.argc)) / 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) - sizeof(args.argc)) / sizeof(args.argv[0]))

#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

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;

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_atxfer(), and builtin_blindtransfer().

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 Which channel one is interacting with
prompt File to pass to ast_streamfile (the one that you wish to play)
s The location where the DTMF data will be stored
maxlen Max Length of the data
timeout Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out.
This function was designed for application programmers for situations where they need to play a message and then get some DTMF data in response to the message. If a digit is pressed during playback, it will immediately break out of the message and continue execution of your code.

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

00915 {
00916    struct ast_group_info *gi = NULL;
00917    
00918    AST_LIST_LOCK(&groups);
00919    AST_LIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
00920       if (gi->chan == chan) {
00921          AST_LIST_REMOVE_CURRENT(&groups, list);
00922          free(gi);
00923       }
00924    }
00925         AST_LIST_TRAVERSE_SAFE_END
00926    AST_LIST_UNLOCK(&groups);
00927    
00928    return 0;
00929 }

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

00858 {
00859    struct ast_group_info *gi = NULL;
00860    int count = 0;
00861 
00862    if (ast_strlen_zero(group))
00863       return 0;
00864    
00865    AST_LIST_LOCK(&groups);
00866    AST_LIST_TRAVERSE(&groups, gi, list) {
00867       if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
00868          count++;
00869    }
00870    AST_LIST_UNLOCK(&groups);
00871 
00872    return count;
00873 }

struct ast_group_info* ast_app_group_list_head ( void   )  [read]

Get the head of the group count list

Definition at line 936 of file app.c.

References AST_LIST_FIRST.

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

00937 {
00938    return AST_LIST_FIRST(&groups);
00939 }

int ast_app_group_list_lock ( void   ) 

Lock the group count list

Definition at line 931 of file app.c.

References AST_LIST_LOCK.

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

00932 {
00933    return AST_LIST_LOCK(&groups);
00934 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list

Definition at line 941 of file app.c.

References AST_LIST_UNLOCK.

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

00942 {
00943    return AST_LIST_UNLOCK(&groups);
00944 }

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

00876 {
00877    struct ast_group_info *gi = NULL;
00878    regex_t regexbuf;
00879    int count = 0;
00880 
00881    if (ast_strlen_zero(groupmatch))
00882       return 0;
00883 
00884    /* if regex compilation fails, return zero matches */
00885    if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
00886       return 0;
00887 
00888    AST_LIST_LOCK(&groups);
00889    AST_LIST_TRAVERSE(&groups, gi, list) {
00890       if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
00891          count++;
00892    }
00893    AST_LIST_UNLOCK(&groups);
00894 
00895    regfree(&regexbuf);
00896 
00897    return count;
00898 }

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

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

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

00786 {
00787    int res=0;
00788    char tmp[256];
00789    char *grp=NULL, *cat=NULL;
00790 
00791    if (!ast_strlen_zero(data)) {
00792       ast_copy_string(tmp, data, sizeof(tmp));
00793       grp = tmp;
00794       cat = strchr(tmp, '@');
00795       if (cat) {
00796          *cat = '\0';
00797          cat++;
00798       }
00799    }
00800 
00801    if (!ast_strlen_zero(grp))
00802       ast_copy_string(group, grp, group_max);
00803    else
00804       *group = '\0';
00805 
00806    if (!ast_strlen_zero(cat))
00807       ast_copy_string(category, cat, category_max);
00808 
00809    return res;
00810 }

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

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

Referenced by ast_do_masquerade().

00901 {
00902    struct ast_group_info *gi = NULL;
00903 
00904    AST_LIST_LOCK(&groups);
00905    AST_LIST_TRAVERSE(&groups, gi, list) {
00906       if (gi->chan == old)
00907          gi->chan = new;
00908    }
00909    AST_LIST_UNLOCK(&groups);
00910 
00911    return 0;
00912 }

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(), do_monitor(), has_voicemail(), notify_new_message(), play_dialtone(), 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 1381 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(), chanspychan_exec(), conf_exec(), extenspy_exec(), mixmonitor_exec(), page_exec(), pbx_builtin_background(), pbx_builtin_resetcdr(), pbx_builtin_waitexten(), read_exec(), vm_exec(), and vm_execmain().

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

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

References quote().

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

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

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

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

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

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

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01344 {
01345    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01346    /* Hide internal coding */
01347    return res > 0 ? 0 : res;
01348 }

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

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

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

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

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

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

References __ast_play_and_record().

Referenced by vm_forwardoptions().

00779 {
00780    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
00781 }

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

References __ast_play_and_record().

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

00774 {
00775    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
00776 }

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

References __ast_play_and_record(), and S_OR.

Referenced by play_record_review().

00769 {
00770    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));
00771 }

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

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk

Definition at line 1350 of file app.c.

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

Referenced by readfile_exec().

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

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 1049 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(), LOG_WARNING, maxsilence, silencethreshold, and VERBOSE_PREFIX_3.

Referenced by conf_run().

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

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

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

Referenced by ast_safe_system().

00756 {
00757    unsigned int level;
00758 
00759    ast_mutex_lock(&safe_system_lock);
00760    level = safe_system_level++;
00761 
00762    /* only replace the handler if it has not already been done */
00763    if (level == 0)
00764       safe_system_prev_handler = signal(SIGCHLD, null_sig_handler);
00765 
00766    ast_mutex_unlock(&safe_system_lock);
00767 }

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

00784 {
00785    pid_t pid;
00786 #ifdef HAVE_WORKING_FORK
00787    int x;
00788 #endif
00789    int res;
00790    struct rusage rusage;
00791    int status;
00792 
00793 #if defined(HAVE_WORKING_FORK) || defined(HAVE_WORKING_VFORK)
00794    ast_replace_sigchld();
00795 
00796 #ifdef HAVE_WORKING_FORK
00797    pid = fork();
00798 #else
00799    pid = vfork();
00800 #endif   
00801 
00802    if (pid == 0) {
00803 #ifdef HAVE_WORKING_FORK
00804       if (ast_opt_high_priority)
00805          ast_set_priority(0);
00806       /* Close file descriptors and launch system command */
00807       for (x = STDERR_FILENO + 1; x < 4096; x++)
00808          close(x);
00809 #endif
00810       execl("/bin/sh", "/bin/sh", "-c", s, (char *) NULL);
00811       _exit(1);
00812    } else if (pid > 0) {
00813       for(;;) {
00814          res = wait4(pid, &status, 0, &rusage);
00815          if (res > -1) {
00816             res = WIFEXITED(status) ? WEXITSTATUS(status) : -1;
00817             break;
00818          } else if (errno != EINTR) 
00819             break;
00820       }
00821    } else {
00822       ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
00823       res = -1;
00824    }
00825 
00826    ast_unreplace_sigchld();
00827 #else
00828    res = -1;
00829 #endif
00830 
00831    return res;
00832 }

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

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

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

01028 {
01029    char *s;
01030    int res;
01031 
01032    if (!(s = alloca(strlen(path) + 10))) {
01033       ast_log(LOG_WARNING, "Out of memory!\n");
01034       return -1;
01035    }
01036 
01037    snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
01038 
01039    if ((res = unlink(s)))
01040       ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
01041    else {
01042       if (option_debug)
01043          ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
01044    }
01045 
01046    return res;
01047 }

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

References ast_mutex_lock(), and ast_mutex_unlock().

Referenced by agi_exec_full(), and ast_safe_system().

00770 {
00771    unsigned int level;
00772 
00773    ast_mutex_lock(&safe_system_lock);
00774    level = --safe_system_level;
00775 
00776    /* only restore the handler if we are the last one */
00777    if (level == 0)
00778       signal(SIGCHLD, safe_system_prev_handler);
00779 
00780    ast_mutex_unlock(&safe_system_lock);
00781 }


Generated on Fri Sep 25 19:28:16 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.5