Mon Nov 24 15:34:22 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)
void ast_app_options2str (const struct ast_app_option *options, struct ast_flags *flags, char *buf, size_t len)
 Given a list of options array, return an option string based on passed flags.
int ast_app_parse_options (const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
 Parses a string containing application options and sets flags/arguments.
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, ind_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 ind_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(), 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 927 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().

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

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

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

struct ast_group_info* ast_app_group_list_head ( void   ) 

Get the head of the group count list

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

00950 {
00951    return AST_LIST_FIRST(&groups);
00952 }

int ast_app_group_list_lock ( void   ) 

Lock the group count list

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

00945 {
00946    return AST_LIST_LOCK(&groups);
00947 }

int ast_app_group_list_unlock ( void   ) 

Unlock the group count list

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

00955 {
00956    return AST_LIST_UNLOCK(&groups);
00957 }

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

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

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

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

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

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

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

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

Referenced by ast_do_masquerade().

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

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 }

void ast_app_options2str ( const struct ast_app_option options,
struct ast_flags flags,
char *  buf,
size_t  len 
)

Given a list of options array, return an option string based on passed flags.

Parameters:
options The array of possible options declared with AST_APP_OPTIONS
flags The flags of the options that you wish to populate the buffer with
buf The buffer to fill with the string of options
len The maximum length of buf

Definition at line 1398 of file app.c.

References ast_test_flag.

Referenced by set_dial_features().

01399 {
01400    unsigned int i, found = 0;
01401 
01402    for (i = 32; i < 128 && found < len;i++) {
01403       if (ast_test_flag(flags, options[i].flag)) {
01404          buf[found++] = i;
01405       }
01406    }
01407    buf[found] = '\0';
01408 }

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

01411 {
01412    char *s;
01413    int curarg;
01414    unsigned int argloc;
01415    char *arg;
01416    int res = 0;
01417 
01418    ast_clear_flag(flags, AST_FLAGS_ALL);
01419 
01420    if (!optstr)
01421       return 0;
01422 
01423    s = optstr;
01424    while (*s) {
01425       curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
01426       argloc = options[curarg].arg_index;
01427       if (*s == '(') {
01428          /* Has argument */
01429          arg = ++s;
01430          if ((s = strchr(s, ')'))) {
01431             if (argloc)
01432                args[argloc - 1] = arg;
01433             *s++ = '\0';
01434          } else {
01435             ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
01436             res = -1;
01437             break;
01438          }
01439       } else if (argloc) {
01440          args[argloc - 1] = "";
01441       }
01442       ast_set_flag(flags, options[curarg].flag);
01443    }
01444 
01445    return res;
01446 }

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

00960 {
00961    int argc;
00962    char *scan, *wasdelim = NULL;
00963    int paren = 0, quote = 0;
00964 
00965    if (!buf || !array || !arraylen)
00966       return 0;
00967 
00968    memset(array, 0, arraylen * sizeof(*array));
00969 
00970    scan = buf;
00971 
00972    for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
00973       array[argc] = scan;
00974       for (; *scan; scan++) {
00975          if (*scan == '(')
00976             paren++;
00977          else if (*scan == ')') {
00978             if (paren)
00979                paren--;
00980          } else if (*scan == '"' && delim != '"') {
00981             quote = quote ? 0 : 1;
00982             /* Remove quote character from argument */
00983             memmove(scan, scan + 1, strlen(scan));
00984             scan--;
00985          } else if (*scan == '\\') {
00986             /* Literal character, don't parse */
00987             memmove(scan, scan + 1, strlen(scan));
00988          } else if ((*scan == delim) && !paren && !quote) {
00989             wasdelim = scan;
00990             *scan++ = '\0';
00991             break;
00992          }
00993       }
00994    }
00995 
00996    /* If the last character in the original string was the delimiter, then
00997     * there is one additional argument. */
00998    if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
00999       array[argc++] = scan;
01000    }
01001 
01002    return argc;
01003 }

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

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

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       if (peer) {
00232          ast_autoservice_stop(peer);
00233       }
00234       return res;
00235    }
00236 
00237    if (ast_opt_transmit_silence) {
00238       silgen = ast_channel_start_silence_generator(chan);
00239    }
00240 
00241    for (ptr = digits; *ptr; ptr++) {
00242       if (*ptr == 'w') {
00243          /* 'w' -- wait half a second */
00244          if ((res = ast_safe_sleep(chan, 500)))
00245             break;
00246       } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
00247          /* Character represents valid DTMF */
00248          if (*ptr == 'f' || *ptr == 'F') {
00249             /* ignore return values if not supported by channel */
00250             ast_indicate(chan, AST_CONTROL_FLASH);
00251          } else
00252             ast_senddigit(chan, *ptr);
00253          /* pause between digits */
00254          if ((res = ast_safe_sleep(chan, between)))
00255             break;
00256       } else
00257          ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n",*ptr);
00258    }
00259 
00260    if (peer) {
00261       /* Stop autoservice on the peer channel, but don't overwrite any error condition 
00262          that has occurred previously while acting on the primary channel */
00263       if (ast_autoservice_stop(peer) && !res)
00264          res = -1;
00265    }
00266 
00267    if (silgen) {
00268       ast_channel_stop_silence_generator(chan, silgen);
00269    }
00270 
00271    return res;
00272 }

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

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

01361 {
01362    int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
01363    /* Hide internal coding */
01364    return res > 0 ? 0 : res;
01365 }

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

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

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

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

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

References __ast_play_and_record().

Referenced by vm_forwardoptions().

00792 {
00793    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
00794 }

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

References __ast_play_and_record().

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

00787 {
00788    return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
00789 }

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

References __ast_play_and_record(), and S_OR.

Referenced by play_record_review().

00782 {
00783    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));
00784 }

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

00475 {
00476    int d;
00477    d = ast_streamfile(chan, fn, chan->language);
00478    if (d)
00479       return d;
00480    d = ast_waitstream(chan, AST_DIGIT_ANY);
00481    ast_stopstream(chan);
00482    return d;
00483 }

char* ast_read_textfile ( const char *  file  ) 

Read a file into asterisk

Definition at line 1367 of file app.c.

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

Referenced by readfile_exec().

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

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

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

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

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

Referenced by agi_exec_full(), and ast_safe_system().

00878 {
00879    unsigned int level;
00880 
00881    ast_mutex_lock(&safe_system_lock);
00882    level = safe_system_level++;
00883 
00884    /* only replace the handler if it has not already been done */
00885    if (level == 0)
00886       safe_system_prev_handler = signal(SIGCHLD, null_sig_handler);
00887 
00888    ast_mutex_unlock(&safe_system_lock);
00889 }

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

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

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

01045 {
01046    char *s;
01047    int res;
01048 
01049    if (!(s = alloca(strlen(path) + 10))) {
01050       ast_log(LOG_WARNING, "Out of memory!\n");
01051       return -1;
01052    }
01053 
01054    snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
01055 
01056    if ((res = unlink(s)))
01057       ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
01058    else {
01059       if (option_debug)
01060          ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
01061    }
01062 
01063    return res;
01064 }

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

References ast_mutex_lock(), and ast_mutex_unlock().

Referenced by agi_exec_full(), and ast_safe_system().

00892 {
00893    unsigned int level;
00894 
00895    ast_mutex_lock(&safe_system_lock);
00896    level = --safe_system_level;
00897 
00898    /* only restore the handler if we are the last one */
00899    if (level == 0)
00900       signal(SIGCHLD, safe_system_prev_handler);
00901 
00902    ast_mutex_unlock(&safe_system_lock);
00903 }


Generated on Mon Nov 24 15:34:22 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7