Convenient Application Routines. More...

#include "asterisk.h"
#include <sys/stat.h>
#include <regex.h>
#include <sys/file.h>
#include <signal.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <dirent.h>
#include "asterisk/paths.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/file.h"
#include "asterisk/app.h"
#include "asterisk/dsp.h"
#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/indications.h"
#include "asterisk/linkedlists.h"
#include "asterisk/threadstorage.h"
#include "asterisk/test.h"
#include "asterisk/module.h"

Include dependency graph for app.c:

Go to the source code of this file.

Data Structures
struct	groups
struct	linear_state
struct	path_lock
struct	path_lock_list
struct	zombie
struct	zombies
Defines
#define	AST_MAX_FORMATS 10
#define	FMT "%30Lf%9s"
#define	RES_EXIT (1 << 17)
#define	RES_REPEAT (1 << 18)
#define	RES_RESTART ((1 << 19) \| RES_REPEAT)
#define	RES_UPONE (1 << 16)
Functions
unsigned int	__ast_app_separate_args (char buf, char delim, int remove_chars, char *array, int arraylen)
	Separate a string into arguments in an array.
static int	__ast_play_and_record (struct ast_channel chan, const char playfile, const char recordfile, int maxtime, const char fmt, int duration, int sound_duration, int beep, int silencethreshold, int maxsilence, const char path, int prepend, const char acceptdtmf, const char *canceldtmf, int skip_confirmation_sound)
int	ast_app_copy_recording_to_vm (struct ast_vm_recording_data *vm_rec_data)
	param[in] vm_rec_data Contains data needed to make the recording. retval 0 voicemail successfully created from recording. retval -1 Failure
int	ast_app_dtget (struct ast_channel chan, const char context, char *collect, size_t size, int maxlen, int timeout)
	This function presents a dialtone and reads an extension into 'collect' which must be a pointer to a pre-initialized array of char having a size of 'size' suitable for writing to. It will collect no more than the smaller of 'maxlen' or 'size' minus the original strlen() of collect digits.
int	ast_app_exec_macro (struct ast_channel autoservice_chan, struct ast_channel macro_chan, const char *macro_args)
	Run a macro on a channel, placing an optional second channel into autoservice.
int	ast_app_exec_sub (struct ast_channel autoservice_chan, struct ast_channel sub_chan, const char *sub_args, int ignore_hangup)
	Run a subroutine on a channel, placing an optional second channel into autoservice.
const char *	ast_app_expand_sub_args (struct ast_channel chan, const char args)
	Add missing context/exten to subroutine argument string.
enum ast_getdata_result	ast_app_getdata (struct ast_channel c, const char prompt, char *s, int maxlen, int timeout)
	ast_app_getdata
int	ast_app_getdata_full (struct ast_channel c, const char prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
	Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions.
int	ast_app_group_discard (struct ast_channel *chan)
	Discard all group counting for a channel.
int	ast_app_group_get_count (const char group, const char category)
	Get the current channel count of the specified group and category.
struct ast_group_info *	ast_app_group_list_head (void)
	Get the head of the group count list.
int	ast_app_group_list_rdlock (void)
	Read Lock the group count list.
int	ast_app_group_list_unlock (void)
	Unlock the group count list.
int	ast_app_group_list_wrlock (void)
	Write Lock the group count list.
int	ast_app_group_match_get_count (const char groupmatch, const char category)
	Get the current channel count of all groups that match the specified pattern and category.
int	ast_app_group_set_channel (struct ast_channel chan, const char data)
	Set the group for a channel, splitting the provided data into group and category, if specified.
int	ast_app_group_split_group (const char data, char group, int group_max, char *category, int category_max)
	Split a group string into group and category, returning a default category if none is provided.
int	ast_app_group_update (struct ast_channel old, struct ast_channel new)
	Update all group counting for a channel to a new one.
int	ast_app_has_voicemail (const char mailbox, const char folder)
	Determine if a given mailbox has any voicemail If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the number of messages in the "Urgent" folder.
int	ast_app_inboxcount (const char mailbox, int newmsgs, int *oldmsgs)
	Determine number of new/old messages in a mailbox.
int	ast_app_inboxcount2 (const char mailbox, int urgentmsgs, int newmsgs, int oldmsgs)
	Determine number of urgent/new/old messages in a mailbox.
int	ast_app_messagecount (const char context, const char mailbox, const char *folder)
	Check number of messages in a given context, mailbox, and folder.
void	ast_app_options2str64 (const struct ast_app_option options, struct ast_flags64 flags, char *buf, size_t len)
	Given a list of options array, return an option string based on passed flags.
int	ast_app_parse_options (const struct ast_app_option options, struct ast_flags flags, char *args, char optstr)
	Parses a string containing application options and sets flags/arguments.
int	ast_app_parse_options64 (const struct ast_app_option options, struct ast_flags64 flags, char *args, char optstr)
	Parses a string containing application options and sets flags/arguments.
int	ast_app_parse_timelen (const char timestr, int result, enum ast_timelen unit)
	Common routine to parse time lengths, with optional time unit specifier.
int	ast_app_run_macro (struct ast_channel autoservice_chan, struct ast_channel macro_chan, const char macro_name, const char macro_args)
	Run a macro on a channel, placing an optional second channel into autoservice.
int	ast_app_run_sub (struct ast_channel autoservice_chan, struct ast_channel sub_chan, const char sub_location, const char sub_args, int ignore_hangup)
	Run a subroutine on a channel, placing an optional second channel into autoservice.
int	ast_app_sayname (struct ast_channel chan, const char mailbox, const char *context)
	Given a mailbox and context, play that mailbox owner's name to the channel specified.
unsigned int	ast_app_separate_args (char buf, char delim, char *array, int arraylen)
void	ast_close_fds_above_n (int n)
	Common routine for child processes, to close all fds prior to exec(2)
int	ast_control_streamfile (struct ast_channel chan, const char file, const char fwd, const char rev, const char stop, const char suspend, const char restart, int skipms, long offsetms)
	Stream a file with fast forward, pause, reverse, restart.
int	ast_control_streamfile_w_cb (struct ast_channel chan, const char file, const char fwd, const char rev, const char stop, const char suspend, const char restart, int skipms, long offsetms, ast_waitstream_fr_cb cb)
	Stream a file with fast forward, pause, reverse, restart.
int	ast_dtmf_stream (struct ast_channel chan, struct ast_channel peer, const char *digits, int between, unsigned int duration)
	Send DTMF to a channel.
int	ast_get_encoded_char (const char stream, char result, size_t *consumed)
	Decode an encoded control or extended ASCII character.
char *	ast_get_encoded_str (const char stream, char result, size_t result_size)
	Decode a stream of encoded control or extended ASCII characters.
void	ast_install_stack_functions (const struct ast_app_stack_funcs *funcs)
	Set stack application function callbacks.
void	ast_install_vm_functions (int(has_voicemail_func)(const char mailbox, const char folder), int(inboxcount_func)(const char mailbox, int newmsgs, int oldmsgs), int(inboxcount2_func)(const char mailbox, int urgentmsgs, int newmsgs, int oldmsgs), int(messagecount_func)(const char context, const char mailbox, const char folder), int(sayname_func)(struct ast_channel chan, const char mailbox, const char context), int(copy_recording_to_vm_func)(struct ast_vm_recording_data vm_rec_data), const char vm_index_to_foldername_func(int id), struct ast_vm_mailbox_snapshot (vm_mailbox_snapshot_create_func)(const char mailbox, const char context, const char folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD), struct ast_vm_mailbox_snapshot (vm_mailbox_snapshot_destroy_func)(struct ast_vm_mailbox_snapshot mailbox_snapshot), int(vm_msg_move_func)(const char mailbox, const char context, size_t num_msgs, const char oldfolder, const char old_msg_ids[], const char newfolder), int(vm_msg_remove_func)(const char mailbox, const char context, size_t num_msgs, const char folder, const char msgs[]), int(vm_msg_forward_func)(const char from_mailbox, const char from_context, const char from_folder, const char to_mailbox, const char to_context, const char to_folder, size_t num_msgs, const char msg_ids[], int delete_old), int(vm_msg_play_func)(struct ast_channel chan, const char mailbox, const char context, const char folder, const char msg_num, ast_vm_msg_play_cb cb))
	Set voicemail function callbacks.
int	ast_ivr_menu_run (struct ast_channel chan, struct ast_ivr_menu menu, void *cbdata)
	Runs an IVR menu.
static int	ast_ivr_menu_run_internal (struct ast_channel chan, struct ast_ivr_menu menu, void *cbdata)
int	ast_linear_stream (struct ast_channel chan, const char filename, int fd, int allowoverride)
	Stream a filename (or file descriptor) as a generator.
enum AST_LOCK_RESULT	ast_lock_path (const char *path)
	Lock a filesystem path.
static enum AST_LOCK_RESULT	ast_lock_path_flock (const char *path)
static enum AST_LOCK_RESULT	ast_lock_path_lockfile (const char *path)
int	ast_play_and_prepend (struct ast_channel chan, char playfile, char recordfile, int maxtime, char fmt, int duration, int sound_duration, int beep, int silencethreshold, int maxsilence)
	Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings This function will not play a success message due to post-recording control in the application this was added for.
int	ast_play_and_record (struct ast_channel chan, const char playfile, const char recordfile, int maxtime, const char fmt, int duration, int sound_duration, int silencethreshold, int maxsilence, const char *path)
	Record a file based on input from a channel. Use default accept and cancel DTMF. This function will play "auth-thankyou" upon successful recording.
int	ast_play_and_record_full (struct ast_channel chan, const char playfile, const char recordfile, int maxtime, const char fmt, int duration, int sound_duration, int silencethreshold, int maxsilence, const char path, const char acceptdtmf, const char *canceldtmf)
	Record a file based on input from a channel This function will play "auth-thankyou" upon successful recording.
int	ast_play_and_wait (struct ast_channel chan, const char fn)
	Play a stream and wait for a digit, returning the digit that was pressed.
char *	ast_read_textfile (const char *filename)
	Read a file into asterisk.
int	ast_record_review (struct ast_channel chan, const char playfile, const char recordfile, int maxtime, const char fmt, int duration, const char path)
	Allow to record message and have a review option.
int	ast_safe_fork (int stop_reaper)
	Common routine to safely fork without a chance of a signal handler firing badly in the child.
void	ast_safe_fork_cleanup (void)
	Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
void	ast_set_lock_type (enum AST_LOCK_TYPE type)
	Set the type of locks used by ast_lock_path()
int	ast_str_get_encoded_str (struct ast_str *str, int maxlen, const char stream)
	Decode a stream of encoded control or extended ASCII characters.
	AST_THREADSTORAGE_PUBLIC (ast_str_thread_global_buf)
void	ast_uninstall_vm_functions (void)
int	ast_unlock_path (const char *path)
	Unlock a path.
static int	ast_unlock_path_flock (const char *path)
static int	ast_unlock_path_lockfile (const char *path)
const char *	ast_vm_index_to_foldername (int id)
	Return name of folder, given an id.
struct ast_vm_mailbox_snapshot *	ast_vm_mailbox_snapshot_create (const char mailbox, const char context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
struct ast_vm_mailbox_snapshot *	ast_vm_mailbox_snapshot_destroy (struct ast_vm_mailbox_snapshot *mailbox_snapshot)
int	ast_vm_msg_forward (const char from_mailbox, const char from_context, const char from_folder, const char to_mailbox, const char to_context, const char to_folder, size_t num_msgs, const char *msg_ids[], int delete_old)
	forward a message from one mailbox to another.
int	ast_vm_msg_move (const char mailbox, const char context, size_t num_msgs, const char oldfolder, const char old_msg_ids[], const char *newfolder)
	Move messages from one folder to another.
int	ast_vm_msg_play (struct ast_channel chan, const char mailbox, const char context, const char folder, const char *msg_num, ast_vm_msg_play_cb cb)
	Play a voicemail msg back on a channel.
int	ast_vm_msg_remove (const char mailbox, const char context, size_t num_msgs, const char folder, const char msgs[])
	Remove/delete messages from a mailbox folder.
static int	control_streamfile (struct ast_channel chan, const char file, const char fwd, const char rev, const char stop, const char suspend, const char restart, int skipms, long offsetms, ast_waitstream_fr_cb cb)
static int	ivr_dispatch (struct ast_channel chan, struct ast_ivr_option option, char exten, void cbdata)
static void *	linear_alloc (struct ast_channel chan, void params)
static int	linear_generator (struct ast_channel chan, void data, int len, int samples)
static void	linear_release (struct ast_channel chan, void params)
static int	option_exists (struct ast_ivr_menu menu, char option)
static int	option_matchmore (struct ast_ivr_menu menu, char option)
static int	parse_options (const struct ast_app_option options, void _flags, char *args, char optstr, int flaglen)
static void	path_lock_destroy (struct path_lock *obj)
static int	read_newoption (struct ast_channel chan, struct ast_ivr_menu menu, char *exten, int maxexten)
static void *	shaun_of_the_dead (void *data)
Variables
static struct ast_app_stack_funcs *	app_stack_callbacks
static int(*	ast_copy_recording_to_vm_func )(struct ast_vm_recording_data *vm_rec_data) = NULL
static int(*	ast_has_voicemail_func )(const char mailbox, const char folder) = NULL
static int(*	ast_inboxcount2_func )(const char mailbox, int urgentmsgs, int newmsgs, int oldmsgs) = NULL
static int(*	ast_inboxcount_func )(const char mailbox, int newmsgs, int *oldmsgs) = NULL
static enum AST_LOCK_TYPE	ast_lock_type = AST_LOCK_TYPE_LOCKFILE
static int(*	ast_messagecount_func )(const char context, const char mailbox, const char *folder) = NULL
static int(*	ast_sayname_func )(struct ast_channel chan, const char mailbox, const char *context) = NULL
static const char (	ast_vm_index_to_foldername_func )(int id) = NULL
static struct ast_vm_mailbox_snapshot (	ast_vm_mailbox_snapshot_create_func )(const char mailbox, const char context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD) = NULL
static struct ast_vm_mailbox_snapshot (	ast_vm_mailbox_snapshot_destroy_func )(struct ast_vm_mailbox_snapshot *mailbox_snapshot) = NULL
static int(*	ast_vm_msg_forward_func )(const char from_mailbox, const char from_context, const char from_folder, const char to_mailbox, const char to_context, const char to_folder, size_t num_msgs, const char *msg_ids[], int delete_old) = NULL
static int(*	ast_vm_msg_move_func )(const char mailbox, const char context, size_t num_msgs, const char oldfolder, const char old_msg_ids[], const char *newfolder) = NULL
static int(*	ast_vm_msg_play_func )(struct ast_channel chan, const char mailbox, const char context, const char folder, const char *msg_num, ast_vm_msg_play_cb cb) = NULL
static int(*	ast_vm_msg_remove_func )(const char mailbox, const char context, size_t num_msgs, const char folder, const char msgs[]) = NULL
static const char	default_acceptdtmf [] = "#"
static const char	default_canceldtmf [] = ""
static int	global_maxsilence = 0
static int	global_silence_threshold = 128
static struct groups	groups
static struct ast_generator	linearstream
static struct path_lock_list	path_lock_list
static pthread_t	shaun_of_the_dead_thread = AST_PTHREADT_NULL
static struct zombies	zombies

Detailed Description

Convenient Application Routines.

Author:: Mark Spencer <markster@digium.com>

Definition in file app.c.

Define Documentation

#define AST_MAX_FORMATS 10

Definition at line 102 of file app.c.

Referenced by __ast_play_and_record().

#define FMT "%30Lf%9s"

Referenced by ast_app_parse_timelen().

#define RES_EXIT (1 << 17)

Definition at line 2035 of file app.c.

Referenced by ast_ivr_menu_run_internal(), and ivr_dispatch().

#define RES_REPEAT (1 << 18)

Definition at line 2036 of file app.c.

Referenced by ast_ivr_menu_run_internal(), and ivr_dispatch().

#define RES_RESTART ((1 << 19) | RES_REPEAT)

Definition at line 2037 of file app.c.

Referenced by ast_ivr_menu_run_internal(), and ivr_dispatch().

#define RES_UPONE (1 << 16)

Definition at line 2034 of file app.c.

Referenced by ast_ivr_menu_run_internal(), and ivr_dispatch().

Function Documentation

unsigned int __ast_app_separate_args	(	char *	buf,
		char	delim,
		int	remove_chars,
		char **	array,
		int	arraylen
	)

Separate a string into arguments in an array.

Parameters:

buf	The string to be parsed (this must be a writable copy, as it will be modified)
delim	The character to be used to delimit arguments
remove_chars	Remove backslashes and quote characters, while parsing
array	An array of 'char *' to be filled in with pointers to the found arguments
arraylen	The number of elements in the array (i.e. the number of arguments you will accept)

Note: if there are more arguments in the string than the array will hold, the last element of the array will contain the remaining arguments, not separated.

The array will be completely zeroed by this function before it populates any entries.

Returns:: The number of arguments found, or zero if the function arguments are not valid.

Definition at line 1644 of file app.c.

References paren, and quote().

Referenced by ast_app_separate_args().

{
   int argc;
   char *scan, *wasdelim = NULL;
   int paren = 0, quote = 0, bracket = 0;

   if (!array || !arraylen) {
      return 0;
   }

   memset(array, 0, arraylen * sizeof(*array));

   if (!buf) {
      return 0;
   }

   scan = buf;

   for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
      array[argc] = scan;
      for (; *scan; scan++) {
         if (*scan == '(') {
            paren++;
         } else if (*scan == ')') {
            if (paren) {
               paren--;
            }
         } else if (*scan == '[') {
            bracket++;
         } else if (*scan == ']') {
            if (bracket) {
               bracket--;
            }
         } else if (*scan == '"' && delim != '"') {
            quote = quote ? 0 : 1;
            if (remove_chars) {
               /* Remove quote character from argument */
               memmove(scan, scan + 1, strlen(scan));
               scan--;
            }
         } else if (*scan == '\\') {
            if (remove_chars) {
               /* Literal character, don't parse */
               memmove(scan, scan + 1, strlen(scan));
            } else {
               scan++;
            }
         } else if ((*scan == delim) && !paren && !quote && !bracket) {
            wasdelim = scan;
            *scan++ = '\0';
            break;
         }
      }
   }

   /* If the last character in the original string was the delimiter, then
    * there is one additional argument. */
   if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
      array[argc++] = scan;
   }

   return argc;
}

static int __ast_play_and_record	(	struct ast_channel *	chan,
		const char *	playfile,
		const char *	recordfile,
		int	maxtime,
		const char *	fmt,
		int *	duration,
		int *	sound_duration,
		int	beep,
		int	silencethreshold,
		int	maxsilence,
		const char *	path,
		int	prepend,
		const char *	acceptdtmf,
		const char *	canceldtmf,
		int	skip_confirmation_sound
	)		`[static]`

Optionally play a sound file or a beep, then record audio and video from the channel.

Parameters:

chan	Channel to playback to/record from.
playfile	Filename of sound to play before recording begins.
recordfile	Filename to record to.
maxtime	Maximum length of recording (in seconds).
fmt	Format(s) to record message in. Multiple formats may be specified by separating them with a '\|'.
duration	Where to store actual length of the recorded message (in milliseconds).
sound_duration	Where to store the length of the recorded message (in milliseconds), minus any silence
beep	Whether to play a beep before starting to record.
silencethreshold
maxsilence	Length of silence that will end a recording (in milliseconds).
path	Optional filesystem path to unlock.
prepend	If true, prepend the recorded audio to an existing file and follow prepend mode recording rules
acceptdtmf	DTMF digits that will end the recording.
canceldtmf	DTMF digits that will cancel the recording.
skip_confirmation_sound	If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.

Return values:

-1	failure or hangup
'S'	Recording ended from silence timeout
't'	Recording ended from the message exceeding the maximum duration, or via DTMF in prepend mode
dtmfchar	Recording ended via the return value's DTMF character for either cancel or accept.

Note:: Instead of asking how much time passed (end - start), calculate the number of seconds of audio which actually went into the file. This fixes a problem where audio is stopped up on the network and never gets to us.

Note that we still want to use the number of seconds passed for the max message, otherwise we could get a situation where this stream is never closed (which would create a resource leak).

Note:: If we ended with silence, trim all but the first 200ms of silence off the recording. However, if we ended with '#', we don't want to trim ANY part of the recording.; Same logic as above.

Definition at line 1126 of file app.c.

References ast_channel_name(), ast_channel_readformat(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_closestream(), AST_CONTROL_VIDUPDATE, ast_copy_string(), ast_debug, ast_dsp_free(), ast_dsp_new(), ast_dsp_set_threshold(), ast_dsp_silence(), ast_filedelete(), ast_filerename(), ast_format_clear(), ast_format_copy(), AST_FORMAT_SLINEAR, AST_FRAME_DTMF, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_getformatname(), ast_indicate(), ast_log(), AST_MAX_FORMATS, ast_opt_transmit_silence, ast_play_and_wait(), ast_read(), ast_readfile(), ast_readframe(), ast_set_read_format(), ast_set_read_format_by_id(), ast_stream_and_wait(), ast_stream_rewind(), ast_tellstream(), ast_truncstream(), ast_unlock_path(), ast_verb, ast_waitfor(), ast_writefile(), ast_writestream(), comment, f, ast_frame::frametype, global_maxsilence, global_silence_threshold, ast_format::id, ast_frame_subclass::integer, LOG_WARNING, ast_frame::subclass, and ast_dsp::totalsilence.

Referenced by ast_play_and_prepend(), ast_play_and_record(), and ast_play_and_record_full().

{
   int d = 0;
   char *fmts;
   char comment[256];
   int x, fmtcnt = 1, res = -1, outmsg = 0;
   struct ast_filestream *others[AST_MAX_FORMATS];
   char *sfmt[AST_MAX_FORMATS];
   char *stringp = NULL;
   time_t start, end;
   struct ast_dsp *sildet = NULL;   /* silence detector dsp */
   int totalsilence = 0;
   int dspsilence = 0;
   int olddspsilence = 0;
   struct ast_format rfmt;
   struct ast_silence_generator *silgen = NULL;
   char prependfile[PATH_MAX];

   ast_format_clear(&rfmt);
   if (silencethreshold < 0) {
      silencethreshold = global_silence_threshold;
   }

   if (maxsilence < 0) {
      maxsilence = global_maxsilence;
   }

   /* barf if no pointer passed to store duration in */
   if (!duration) {
      ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
      return -1;
   }

   ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
   snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, ast_channel_name(chan));

   if (playfile || beep) {
      if (!beep) {
         d = ast_play_and_wait(chan, playfile);
      }
      if (d > -1) {
         d = ast_stream_and_wait(chan, "beep", "");
      }
      if (d < 0) {
         return -1;
      }
   }

   if (prepend) {
      ast_copy_string(prependfile, recordfile, sizeof(prependfile));
      strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
   }

   fmts = ast_strdupa(fmt);

   stringp = fmts;
   strsep(&stringp, "|");
   ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
   sfmt[0] = ast_strdupa(fmts);

   while ((fmt = strsep(&stringp, "|"))) {
      if (fmtcnt > AST_MAX_FORMATS - 1) {
         ast_log(LOG_WARNING, "Please increase AST_MAX_FORMATS in file.h\n");
         break;
      }
      sfmt[fmtcnt++] = ast_strdupa(fmt);
   }

   end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
   for (x = 0; x < fmtcnt; x++) {
      others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, AST_FILE_MODE);
      ast_verb(3, "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);

      if (!others[x]) {
         break;
      }
   }

   if (path) {
      ast_unlock_path(path);
   }

   if (maxsilence > 0) {
      sildet = ast_dsp_new(); /* Create the silence detector */
      if (!sildet) {
         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
         return -1;
      }
      ast_dsp_set_threshold(sildet, silencethreshold);
      ast_format_copy(&rfmt, ast_channel_readformat(chan));
      res = ast_set_read_format_by_id(chan, AST_FORMAT_SLINEAR);
      if (res < 0) {
         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
         ast_dsp_free(sildet);
         return -1;
      }
   }

   if (!prepend) {
      /* Request a video update */
      ast_indicate(chan, AST_CONTROL_VIDUPDATE);

      if (ast_opt_transmit_silence) {
         silgen = ast_channel_start_silence_generator(chan);
      }
   }

   if (x == fmtcnt) {
      /* Loop forever, writing the packets we read to the writer(s), until
         we read a digit or get a hangup */
      struct ast_frame *f;
      for (;;) {
         if (!(res = ast_waitfor(chan, 2000))) {
            ast_debug(1, "One waitfor failed, trying another\n");
            /* Try one more time in case of masq */
            if (!(res = ast_waitfor(chan, 2000))) {
               ast_log(LOG_WARNING, "No audio available on %s??\n", ast_channel_name(chan));
               res = -1;
            }
         }

         if (res < 0) {
            f = NULL;
            break;
         }
         if (!(f = ast_read(chan))) {
            break;
         }
         if (f->frametype == AST_FRAME_VOICE) {
            /* write each format */
            for (x = 0; x < fmtcnt; x++) {
               if (prepend && !others[x]) {
                  break;
               }
               res = ast_writestream(others[x], f);
            }

            /* Silence Detection */
            if (maxsilence > 0) {
               dspsilence = 0;
               ast_dsp_silence(sildet, f, &dspsilence);
               if (olddspsilence > dspsilence) {
                  totalsilence += olddspsilence;
               }
               olddspsilence = dspsilence;

               if (dspsilence > maxsilence) {
                  /* Ended happily with silence */
                  ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", dspsilence/1000);
                  res = 'S';
                  outmsg = 2;
                  break;
               }
            }
            /* Exit on any error */
            if (res) {
               ast_log(LOG_WARNING, "Error writing frame\n");
               break;
            }
         } else if (f->frametype == AST_FRAME_VIDEO) {
            /* Write only once */
            ast_writestream(others[0], f);
         } else if (f->frametype == AST_FRAME_DTMF) {
            if (prepend) {
            /* stop recording with any digit */
               ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
               res = 't';
               outmsg = 2;
               break;
            }
            if (strchr(acceptdtmf, f->subclass.integer)) {
               ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
               res = f->subclass.integer;
               outmsg = 2;
               break;
            }
            if (strchr(canceldtmf, f->subclass.integer)) {
               ast_verb(3, "User cancelled message by pressing %c\n", f->subclass.integer);
               res = f->subclass.integer;
               outmsg = 0;
               break;
            }
         }
         if (maxtime) {
            end = time(NULL);
            if (maxtime < (end - start)) {
               ast_verb(3, "Took too long, cutting it short...\n");
               res = 't';
               outmsg = 2;
               break;
            }
         }
         ast_frfree(f);
      }
      if (!f) {
         ast_verb(3, "User hung up\n");
         res = -1;
         outmsg = 1;
      } else {
         ast_frfree(f);
      }
   } else {
      ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
   }

   if (!prepend) {
      if (silgen) {
         ast_channel_stop_silence_generator(chan, silgen);
      }
   }

   /*!\note
    * Instead of asking how much time passed (end - start), calculate the number
    * of seconds of audio which actually went into the file.  This fixes a
    * problem where audio is stopped up on the network and never gets to us.
    *
    * Note that we still want to use the number of seconds passed for the max
    * message, otherwise we could get a situation where this stream is never
    * closed (which would create a resource leak).
    */
   *duration = others[0] ? ast_tellstream(others[0]) / 8000 : 0;
   if (sound_duration) {
      *sound_duration = *duration;
   }

   if (!prepend) {
      /* Reduce duration by a total silence amount */
      if (olddspsilence <= dspsilence) {
         totalsilence += dspsilence;
      }

      if (sound_duration) {
         if (totalsilence > 0) {
            *sound_duration -= (totalsilence - 200) / 1000;
         }
         if (*sound_duration < 0) {
            *sound_duration = 0;
         }
      }

      if (dspsilence > 0) {
         *duration -= (dspsilence - 200) / 1000;
      }

      if (*duration < 0) {
         *duration = 0;
      }

      for (x = 0; x < fmtcnt; x++) {
         if (!others[x]) {
            break;
         }
         /*!\note
          * If we ended with silence, trim all but the first 200ms of silence
          * off the recording.  However, if we ended with '#', we don't want
          * to trim ANY part of the recording.
          */
         if (res > 0 && dspsilence) {
            /* rewind only the trailing silence */
            ast_stream_rewind(others[x], dspsilence - 200);
         }
         ast_truncstream(others[x]);
         ast_closestream(others[x]);
      }
   }

   if (prepend && outmsg) {
      struct ast_filestream *realfiles[AST_MAX_FORMATS];
      struct ast_frame *fr;

      for (x = 0; x < fmtcnt; x++) {
         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
         if (!others[x] || !realfiles[x]) {
            break;
         }
         /*!\note Same logic as above. */
         if (dspsilence) {
            ast_stream_rewind(others[x], dspsilence - 200);
         }
         ast_truncstream(others[x]);
         /* add the original file too */
         while ((fr = ast_readframe(realfiles[x]))) {
            ast_writestream(others[x], fr);
            ast_frfree(fr);
         }
         ast_closestream(others[x]);
         ast_closestream(realfiles[x]);
         ast_filerename(prependfile, recordfile, sfmt[x]);
         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
         ast_filedelete(prependfile, sfmt[x]);
      }
   }
   if (rfmt.id && ast_set_read_format(chan, &rfmt)) {
      ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(&rfmt), ast_channel_name(chan));
   }
   if ((outmsg == 2) && (!skip_confirmation_sound)) {
      ast_stream_and_wait(chan, "auth-thankyou", "");
   }
   if (sildet) {
      ast_dsp_free(sildet);
   }
   return res;
}

int ast_app_copy_recording_to_vm ( struct ast_vm_recording_data * vm_rec_data )

param[in] vm_rec_data Contains data needed to make the recording. retval 0 voicemail successfully created from recording. retval -1 Failure

Definition at line 547 of file app.c.

References ast_copy_recording_to_vm_func, ast_verb, ast_vm_recording_data::context, ast_vm_recording_data::mailbox, ast_vm_recording_data::recording_ext, and ast_vm_recording_data::recording_file.

Referenced by copy_to_voicemail().

{
   static int warned = 0;

   if (ast_copy_recording_to_vm_func) {
      return ast_copy_recording_to_vm_func(vm_rec_data);
   }

   if (warned++ % 10 == 0) {
      ast_verb(3, "copy recording to voicemail called to copy %s.%s to %s@%s, but voicemail not loaded.\n",
         vm_rec_data->recording_file, vm_rec_data->recording_ext,
         vm_rec_data->mailbox, vm_rec_data->context);
   }

   return -1;
}

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

This function presents a dialtone and reads an extension into 'collect' which must be a pointer to a **pre-initialized** array of char having a size of 'size' suitable for writing to. It will collect no more than the smaller of 'maxlen' or 'size' minus the original strlen() of collect digits.

Present a dialtone and collect a certain length extension.

Parameters:

chan	struct.
context
collect
size
maxlen
timeout	timeout in milliseconds

Returns:: 0 if extension does not exist, 1 if extension exists

Definition at line 120 of file app.c.

References ast_channel_caller(), ast_channel_pbx(), ast_channel_zone(), ast_exists_extension(), ast_get_indication_tone(), ast_ignore_pattern(), ast_log(), ast_matchmore_extension(), ast_playtones_start(), ast_playtones_stop(), ast_tone_zone_sound_unref(), ast_waitfordigit(), ast_tone_zone_sound::data, ast_pbx::dtimeoutms, LOG_NOTICE, and S_COR.

Referenced by builtin_atxfer(), builtin_blindtransfer(), and grab_transfer().

{
   struct ast_tone_zone_sound *ts;
   int res = 0, x = 0;

   if (maxlen > size) {
      maxlen = size;
   }

   if (!timeout) {
      if (ast_channel_pbx(chan) && ast_channel_pbx(chan)->dtimeoutms) {
         timeout = ast_channel_pbx(chan)->dtimeoutms;
      } else {
         timeout = 5000;
      }
   }

   if ((ts = ast_get_indication_tone(ast_channel_zone(chan), "dial"))) {
      res = ast_playtones_start(chan, 0, ts->data, 0);
      ts = ast_tone_zone_sound_unref(ts);
   } else {
      ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
   }

   for (x = strlen(collect); x < maxlen; ) {
      res = ast_waitfordigit(chan, timeout);
      if (!ast_ignore_pattern(context, collect)) {
         ast_playtones_stop(chan);
      }
      if (res < 1) {
         break;
      }
      if (res == '#') {
         break;
      }
      collect[x++] = res;
      if (!ast_matchmore_extension(chan, context, collect, 1,
         S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
         break;
      }
   }

   if (res >= 0) {
      res = ast_exists_extension(chan, context, collect, 1,
         S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL)) ? 1 : 0;
   }

   return res;
}

int ast_app_exec_macro	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	macro_chan,
		const char *	macro_args
	)

Run a macro on a channel, placing an optional second channel into autoservice.

Since:: 11.0

This is a shorthand method that makes it very easy to run a macro on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:: Absolutely _NO_ channel locks should be held before calling this function.

Parameters:

autoservice_chan	A channel to place into autoservice while the macro is run
macro_chan	Channel to execute macro on.
macro_args	Macro application argument string.

Return values:

0	success
-1	on error

Definition at line 255 of file app.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_channel_context(), ast_channel_exten(), ast_channel_name(), ast_channel_priority(), ast_debug, ast_log(), LOG_WARNING, pbx_exec(), and pbx_findapp().

Referenced by ast_app_run_macro(), dial_exec_full(), generic_recall(), and try_calling().

{
   struct ast_app *macro_app;
   int res;

   macro_app = pbx_findapp("Macro");
   if (!macro_app) {
      ast_log(LOG_WARNING,
         "Cannot run 'Macro(%s)'.  The application is not available.\n", macro_args);
      return -1;
   }
   if (autoservice_chan) {
      ast_autoservice_start(autoservice_chan);
   }

   ast_debug(4, "%s Original location: %s,%s,%d\n", ast_channel_name(macro_chan),
      ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
      ast_channel_priority(macro_chan));

   res = pbx_exec(macro_chan, macro_app, macro_args);
   ast_debug(4, "Macro exited with status %d\n", res);

   /*
    * Assume anything negative from Macro is an error.
    * Anything else is success.
    */
   if (res < 0) {
      res = -1;
   } else {
      res = 0;
   }

   ast_debug(4, "%s Ending location: %s,%s,%d\n", ast_channel_name(macro_chan),
      ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
      ast_channel_priority(macro_chan));

   if (autoservice_chan) {
      ast_autoservice_stop(autoservice_chan);
   }
   return res;
}

int ast_app_exec_sub	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	sub_chan,
		const char *	sub_args,
		int	ignore_hangup
	)

Run a subroutine on a channel, placing an optional second channel into autoservice.

Since:: 11

This is a shorthand method that makes it very easy to run a subroutine on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:: Absolutely _NO_ channel locks should be held before calling this function.

Parameters:

autoservice_chan	A channel to place into autoservice while the subroutine is run
sub_chan	Channel to execute subroutine on.
sub_args	Gosub application argument string.
ignore_hangup	TRUE if a hangup does not stop execution of the routine.

Return values:

0	success
-1	on error

Definition at line 346 of file app.c.

References app_stack_callbacks, ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_module_ref(), ast_module_unref(), LOG_WARNING, ast_app_stack_funcs::module, and ast_app_stack_funcs::run_sub.

Referenced by app_exec(), ast_app_run_sub(), ast_pbx_hangup_handler_run(), ast_pre_call(), dial_exec_full(), generic_recall(), and try_calling().

{
   const struct ast_app_stack_funcs *funcs;
   int res;

   funcs = app_stack_callbacks;
   if (!funcs || !funcs->run_sub) {
      ast_log(LOG_WARNING,
         "Cannot run 'Gosub(%s)'.  The app_stack module is not available.\n",
         sub_args);
      return -1;
   }
   ast_module_ref(funcs->module);

   if (autoservice_chan) {
      ast_autoservice_start(autoservice_chan);
   }

   res = funcs->run_sub(sub_chan, sub_args, ignore_hangup);
   ast_module_unref(funcs->module);

   if (autoservice_chan) {
      ast_autoservice_stop(autoservice_chan);
   }
   return res;
}

const char* ast_app_expand_sub_args	(	struct ast_channel *	chan,
		const char *	args
	)

Add missing context/exten to subroutine argument string.

Parameters:

chan	Channel to obtain context/exten.
args	Gosub application argument string.

Fills in the optional context and exten from the given channel.

Return values:

New-args	Gosub argument string on success. Must be freed.
NULL	on error.

Definition at line 327 of file app.c.

References app_stack_callbacks, ast_log(), ast_module_ref(), ast_module_unref(), ast_app_stack_funcs::expand_sub_args, LOG_WARNING, and ast_app_stack_funcs::module.

Referenced by app_exec(), ast_pbx_hangup_handler_push(), and dial_exec_full().

{
   const struct ast_app_stack_funcs *funcs;
   const char *new_args;

   funcs = app_stack_callbacks;
   if (!funcs || !funcs->expand_sub_args) {
      ast_log(LOG_WARNING,
         "Cannot expand 'Gosub(%s)' arguments.  The app_stack module is not available.\n",
         args);
      return NULL;
   }
   ast_module_ref(funcs->module);

   new_args = funcs->expand_sub_args(chan, args);
   ast_module_unref(funcs->module);
   return new_args;
}

enum ast_getdata_result ast_app_getdata	(	struct ast_channel *	c,
		const char *	prompt,
		char *	s,
		int	maxlen,
		int	timeout
	)

ast_app_getdata

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

References ast_channel_language(), ast_channel_name(), ast_channel_pbx(), AST_GETDATA_EMPTY_END_TERMINATED, ast_readstring(), ast_streamfile(), ast_strlen_zero(), ast_test_suite_event_notify, ast_pbx::dtimeoutms, and ast_pbx::rtimeoutms.

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

{
   int res = 0, to, fto;
   char *front, *filename;

   /* XXX Merge with full version? XXX */

   if (maxlen)
      s[0] = '\0';

   if (!prompt)
      prompt = "";

   filename = ast_strdupa(prompt);
   while ((front = strsep(&filename, "&"))) {
      ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", front, ast_channel_name(c));
      if (!ast_strlen_zero(front)) {
         res = ast_streamfile(c, front, ast_channel_language(c));
         if (res)
            continue;
      }
      if (ast_strlen_zero(filename)) {
         /* set timeouts for the last prompt */
         fto = ast_channel_pbx(c) ? ast_channel_pbx(c)->rtimeoutms : 6000;
         to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;

         if (timeout > 0) {
            fto = to = timeout;
         }
         if (timeout < 0) {
            fto = to = 1000000000;
         }
      } else {
         /* there is more than one prompt, so
          * get rid of the long timeout between
          * prompts, and make it 50ms */
         fto = 50;
         to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;
      }
      res = ast_readstring(c, s, maxlen, to, fto, "#");
      if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
         return res;
      }
      if (!ast_strlen_zero(s)) {
         return res;
      }
   }

   return res;
}

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

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

Definition at line 232 of file app.c.

References ast_channel_language(), ast_readstring_full(), ast_streamfile(), and ast_strlen_zero().

Referenced by handle_getdata().

{
   int res, to = 2000, fto = 6000;

   if (!ast_strlen_zero(prompt)) {
      res = ast_streamfile(c, prompt, ast_channel_language(c));
      if (res < 0) {
         return res;
      }
   }

   if (timeout > 0) {
      fto = to = timeout;
   }
   if (timeout < 0) {
      fto = to = 1000000000;
   }

   res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);

   return res;
}

int ast_app_group_discard ( struct ast_channel * chan )

Discard all group counting for a channel.

Definition at line 1604 of file app.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_group_info::chan, and ast_group_info::group_list.

Referenced by ast_channel_destructor().

{
   struct ast_group_info *gi = NULL;

   AST_RWLIST_WRLOCK(&groups);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
      if (gi->chan == chan) {
         AST_RWLIST_REMOVE_CURRENT(group_list);
         ast_free(gi);
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   AST_RWLIST_UNLOCK(&groups);

   return 0;
}

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

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

Referenced by group_count_function_read().

{
   struct ast_group_info *gi = NULL;
   int count = 0;

   if (ast_strlen_zero(group)) {
      return 0;
   }

   AST_RWLIST_RDLOCK(&groups);
   AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
      if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
         count++;
      }
   }
   AST_RWLIST_UNLOCK(&groups);

   return count;
}

struct ast_group_info* ast_app_group_list_head ( void ) [read]

Get the head of the group count list.

Definition at line 1631 of file app.c.

References AST_RWLIST_FIRST.

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

{
   return AST_RWLIST_FIRST(&groups);
}

int ast_app_group_list_rdlock ( void )

Read Lock the group count list.

Definition at line 1626 of file app.c.

References AST_RWLIST_RDLOCK.

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

{
   return AST_RWLIST_RDLOCK(&groups);
}

int ast_app_group_list_unlock ( void )

Unlock the group count list.

Definition at line 1636 of file app.c.

References AST_RWLIST_UNLOCK.

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

{
   return AST_RWLIST_UNLOCK(&groups);
}

int ast_app_group_list_wrlock ( void )

Write Lock the group count list.

Definition at line 1621 of file app.c.

References AST_RWLIST_WRLOCK.

{
   return AST_RWLIST_WRLOCK(&groups);
}

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

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

Referenced by group_match_count_function_read().

{
   struct ast_group_info *gi = NULL;
   regex_t regexbuf_group;
   regex_t regexbuf_category;
   int count = 0;

   if (ast_strlen_zero(groupmatch)) {
      ast_log(LOG_NOTICE, "groupmatch empty\n");
      return 0;
   }

   /* if regex compilation fails, return zero matches */
   if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
      ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
      return 0;
   }

   if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
      ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
      regfree(&regexbuf_group);
      return 0;
   }

   AST_RWLIST_RDLOCK(&groups);
   AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
      if (!regexec(&regexbuf_group, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !regexec(&regexbuf_category, gi->category, 0, NULL, 0)))) {
         count++;
      }
   }
   AST_RWLIST_UNLOCK(&groups);

   regfree(&regexbuf_group);
   if (!ast_strlen_zero(category)) {
      regfree(&regexbuf_category);
   }

   return count;
}

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

References ast_app_group_split_group(), AST_RWLIST_INSERT_TAIL, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), calloc, ast_group_info::category, ast_group_info::chan, free, ast_group_info::group, ast_group_info::group_list, and len().

Referenced by dial_exec_full(), and group_function_write().

{
   int res = 0;
   char group[80] = "", category[80] = "";
   struct ast_group_info *gi = NULL;
   size_t len = 0;

   if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
      return -1;
   }

   /* Calculate memory we will need if this is new */
   len = sizeof(*gi) + strlen(group) + 1;
   if (!ast_strlen_zero(category)) {
      len += strlen(category) + 1;
   }

   AST_RWLIST_WRLOCK(&groups);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
      if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
         AST_RWLIST_REMOVE_CURRENT(group_list);
         free(gi);
         break;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;

   if (ast_strlen_zero(group)) {
      /* Enable unsetting the group */
   } else if ((gi = calloc(1, len))) {
      gi->chan = chan;
      gi->group = (char *) gi + sizeof(*gi);
      strcpy(gi->group, group);
      if (!ast_strlen_zero(category)) {
         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
         strcpy(gi->category, category);
      }
      AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
   } else {
      res = -1;
   }

   AST_RWLIST_UNLOCK(&groups);

   return res;
}

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

References ast_copy_string(), and ast_strlen_zero().

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

{
   int res = 0;
   char tmp[256];
   char *grp = NULL, *cat = NULL;

   if (!ast_strlen_zero(data)) {
      ast_copy_string(tmp, data, sizeof(tmp));
      grp = tmp;
      if ((cat = strchr(tmp, '@'))) {
         *cat++ = '\0';
      }
   }

   if (!ast_strlen_zero(grp)) {
      ast_copy_string(group, grp, group_max);
   } else {
      *group = '\0';
   }

   if (!ast_strlen_zero(cat)) {
      ast_copy_string(category, cat, category_max);
   }

   return res;
}

int ast_app_group_update	(	struct ast_channel *	old,
		struct ast_channel *	new
	)

Update all group counting for a channel to a new one.

Definition at line 1585 of file app.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_group_info::chan, and ast_group_info::group_list.

Referenced by ast_do_masquerade(), and check_bridge().

{
   struct ast_group_info *gi = NULL;

   AST_RWLIST_WRLOCK(&groups);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
      if (gi->chan == old) {
         gi->chan = new;
      } else if (gi->chan == new) {
         AST_RWLIST_REMOVE_CURRENT(group_list);
         ast_free(gi);
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   AST_RWLIST_UNLOCK(&groups);

   return 0;
}

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

Determine if a given mailbox has any voicemail If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the number of messages in the "Urgent" folder.

Return values:

1	Mailbox has voicemail
0	No new voicemail in specified mailbox
-1	Failure

Since:: 1.0

Definition at line 528 of file app.c.

References ast_has_voicemail_func, and ast_verb.

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

{
   static int warned = 0;
   if (ast_has_voicemail_func) {
      return ast_has_voicemail_func(mailbox, folder);
   }

   if (warned++ % 10 == 0) {
      ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
   }
   return 0;
}

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

Determine number of new/old messages in a mailbox.

Since:: 1.0

Parameters:

[in]	mailbox	Mailbox specification in the format mbox[][&mbox2[]][...]
[out]	newmsgs	Number of messages in the "INBOX" folder. Includes number of messages in the "Urgent" folder, if any.
[out]	oldmsgs	Number of messages in the "Old" folder.

Return values:

0	Success
-1	Failure

Definition at line 564 of file app.c.

References ast_inboxcount_func, and ast_verb.

Referenced by sip_send_mwi_to_peer(), and update_registry().

{
   static int warned = 0;
   if (newmsgs) {
      *newmsgs = 0;
   }
   if (oldmsgs) {
      *oldmsgs = 0;
   }
   if (ast_inboxcount_func) {
      return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
   }

   if (warned++ % 10 == 0) {
      ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
   }

   return 0;
}

int ast_app_inboxcount2	(	const char *	mailbox,
		int *	urgentmsgs,
		int *	newmsgs,
		int *	oldmsgs
	)

Determine number of urgent/new/old messages in a mailbox.

Parameters:

[in]	mailbox	the mailbox context to use
[out]	urgentmsgs	the urgent message count
[out]	newmsgs	the new message count
[out]	oldmsgs	the old message count

Returns:: Returns 0 for success, negative upon error

Since:: 1.6.1

Definition at line 584 of file app.c.

References ast_inboxcount2_func, and ast_verb.

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

{
   static int warned = 0;
   if (newmsgs) {
      *newmsgs = 0;
   }
   if (oldmsgs) {
      *oldmsgs = 0;
   }
   if (urgentmsgs) {
      *urgentmsgs = 0;
   }
   if (ast_inboxcount2_func) {
      return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
   }

   if (warned++ % 10 == 0) {
      ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
   }

   return 0;
}

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

Check number of messages in a given context, mailbox, and folder.

Since:: 1.4

Parameters:

[in]	context	Mailbox context
[in]	mailbox	Mailbox number
[in]	folder	Mailbox folder

Returns:: Number of messages in the given context, mailbox, and folder. If folder is NULL, folder "INBOX" is assumed. If folder is "INBOX", includes number of messages in the "Urgent" folder.

Definition at line 615 of file app.c.

References ast_messagecount_func, and ast_verb.

Referenced by acf_vmcount_exec().

{
   static int warned = 0;
   if (ast_messagecount_func) {
      return ast_messagecount_func(context, mailbox, folder);
   }

   if (!warned) {
      warned++;
      ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
   }

   return 0;
}

void ast_app_options2str64	(	const struct ast_app_option *	options,
		struct ast_flags64 *	flags,
		char *	buf,
		size_t	len
	)

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

Parameters:

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

Definition at line 2367 of file app.c.

References ast_test_flag64, and len().

{
   unsigned int i, found = 0;
   for (i = 32; i < 128 && found < len; i++) {
      if (ast_test_flag64(flags, options[i].flag)) {
         buf[found++] = i;
      }
   }
   buf[found] = '\0';
}

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

References parse_options().

Referenced by app_exec(), auth_exec(), bridge_exec(), cdr_read(), cdr_write(), chanspy_exec(), connectedline_write(), controlplayback_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundifunc_read(), extenspy_exec(), forkcdr_exec(), handle_options(), hint_read(), manager_mixmonitor(), minivm_accmess_exec(), minivm_greet_exec(), minivm_record_exec(), mixmonitor_exec(), page_exec(), park_call_exec(), pbx_builtin_background(), pbx_builtin_resetcdr(), pbx_builtin_waitexten(), queue_exec(), read_exec(), readexten_exec(), realtime_common(), receivefax_exec(), record_exec(), redirecting_write(), sendfax_exec(), sendurl_exec(), sig_pri_call(), sla_trunk_exec(), smdi_msg_retrieve_read(), sms_exec(), softhangup_exec(), speech_background(), vm_exec(), vm_execmain(), and volume_write().

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

int ast_app_parse_options64	(	const struct ast_app_option *	options,
		struct ast_flags64 *	flags,
		char **	args,
		char *	optstr
	)

Parses a string containing application options and sets flags/arguments.

Parameters:

options	The array of possible options declared with AST_APP_OPTIONS
flags	The 64-bit flag structure to have option flags set
args	The array of argument pointers to hold arguments found
optstr	The string containing the options to be parsed

Returns:: zero for success, non-zero if an error occurs

See also:: AST_APP_OPTIONS

Definition at line 2362 of file app.c.

References parse_options().

Referenced by conf_exec(), dial_exec_full(), find_conf_realtime(), and sayunixtime_exec().

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

int ast_app_parse_timelen	(	const char *	timestr,
		int *	result,
		enum ast_timelen	defunit
	)

Common routine to parse time lengths, with optional time unit specifier.

Parameters:

[in]	timestr	String to parse
[in]	defunit	Default unit type
[out]	result	Resulting value, specified in milliseconds

Return values:

0	Success
-1	Failure

Since:: 1.8

Definition at line 2567 of file app.c.

References FMT, TIMELEN_HOURS, TIMELEN_MILLISECONDS, TIMELEN_MINUTES, and TIMELEN_SECONDS.

Referenced by ast_eivr_senddtmf(), new_realtime_sqlite3_db(), pbx_builtin_wait(), pbx_builtin_waitexten(), and senddtmf_exec().

{
   int res;
   char u[10];
#ifdef HAVE_LONG_DOUBLE_WIDER
   long double amount;
   #define FMT "%30Lf%9s"
#else
   double amount;
   #define FMT "%30lf%9s"
#endif
   if (!timestr) {
      return -1;
   }

   res = sscanf(timestr, FMT, &amount, u);

   if (res == 0 || res == EOF) {
#undef FMT
      return -1;
   } else if (res == 2) {
      switch (u[0]) {
      case 'h':
      case 'H':
         unit = TIMELEN_HOURS;
         break;
      case 's':
      case 'S':
         unit = TIMELEN_SECONDS;
         break;
      case 'm':
      case 'M':
         if (toupper(u[1]) == 'S') {
            unit = TIMELEN_MILLISECONDS;
         } else if (u[1] == '\0') {
            unit = TIMELEN_MINUTES;
         }
         break;
      }
   }

   switch (unit) {
   case TIMELEN_HOURS:
      amount *= 60;
      /* fall-through */
   case TIMELEN_MINUTES:
      amount *= 60;
      /* fall-through */
   case TIMELEN_SECONDS:
      amount *= 1000;
      /* fall-through */
   case TIMELEN_MILLISECONDS:
      ;
   }
   *result = amount > INT_MAX ? INT_MAX : (int) amount;
   return 0;
}

int ast_app_run_macro	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	macro_chan,
		const char *	macro_name,
		const char *	macro_args
	)

Run a macro on a channel, placing an optional second channel into autoservice.

Since:: 1.8

This is a shorthand method that makes it very easy to run a macro on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:: Absolutely _NO_ channel locks should be held before calling this function.

Parameters:

autoservice_chan	A channel to place into autoservice while the macro is run
macro_chan	Channel to execute macro on.
macro_name	The name of the macro to run.
macro_args	The arguments to pass to the macro.

Return values:

0	success
-1	on error

Definition at line 297 of file app.c.

References ast_app_exec_macro(), ast_free, ast_malloc, and ast_strlen_zero().

Referenced by ast_channel_connected_line_macro(), and ast_channel_redirecting_macro().

{
   int res;
   char *args_str;
   size_t args_len;

   if (ast_strlen_zero(macro_args)) {
      return ast_app_exec_macro(autoservice_chan, macro_chan, macro_name);
   }

   /* Create the Macro application argument string. */
   args_len = strlen(macro_name) + strlen(macro_args) + 2;
   args_str = ast_malloc(args_len);
   if (!args_str) {
      return -1;
   }
   snprintf(args_str, args_len, "%s,%s", macro_name, macro_args);

   res = ast_app_exec_macro(autoservice_chan, macro_chan, args_str);
   ast_free(args_str);
   return res;
}

int ast_app_run_sub	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	sub_chan,
		const char *	sub_location,
		const char *	sub_args,
		int	ignore_hangup
	)

Run a subroutine on a channel, placing an optional second channel into autoservice.

Since:: 11

This is a shorthand method that makes it very easy to run a subroutine on any given channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case there is no channel to place into autoservice.

Note:: Absolutely _NO_ channel locks should be held before calling this function.

Parameters:

autoservice_chan	A channel to place into autoservice while the subroutine is run
sub_chan	Channel to execute subroutine on.
sub_location	The location of the subroutine to run.
sub_args	The arguments to pass to the subroutine.
ignore_hangup	TRUE if a hangup does not stop execution of the routine.

Return values:

0	success
-1	on error

Definition at line 373 of file app.c.

References ast_app_exec_sub(), ast_free, ast_malloc, and ast_strlen_zero().

Referenced by ast_channel_connected_line_sub(), and ast_channel_redirecting_sub().

{
   int res;
   char *args_str;
   size_t args_len;

   if (ast_strlen_zero(sub_args)) {
      return ast_app_exec_sub(autoservice_chan, sub_chan, sub_location, ignore_hangup);
   }

   /* Create the Gosub application argument string. */
   args_len = strlen(sub_location) + strlen(sub_args) + 3;
   args_str = ast_malloc(args_len);
   if (!args_str) {
      return -1;
   }
   snprintf(args_str, args_len, "%s(%s)", sub_location, sub_args);

   res = ast_app_exec_sub(autoservice_chan, sub_chan, args_str, ignore_hangup);
   ast_free(args_str);
   return res;
}

int ast_app_sayname	(	struct ast_channel *	chan,
		const char *	mailbox,
		const char *	context
	)

Given a mailbox and context, play that mailbox owner's name to the channel specified.

Parameters:

[in]	chan	Channel on which to play the name
[in]	mailbox	Mailbox number from which to retrieve the recording
[in]	context	Mailbox context from which to locate the mailbox number

Return values:

0	Name played without interruption
dtmf	ASCII value of the DTMF which interrupted playback.
-1	Unable to locate mailbox or hangup occurred.

Since:: 1.6.1

Definition at line 607 of file app.c.

References ast_sayname_func.

Referenced by common_exec(), and play_mailbox_owner().

{
   if (ast_sayname_func) {
      return ast_sayname_func(chan, mailbox, context);
   }
   return -1;
}

unsigned int ast_app_separate_args	(	char *	buf,
		char	delim,
		char **	array,
		int	arraylen
	)

Definition at line 1709 of file app.c.

References __ast_app_separate_args().

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

{
   return __ast_app_separate_args(buf, delim, 1, array, arraylen);
}

void ast_close_fds_above_n ( int n )

Common routine for child processes, to close all fds prior to exec(2)

Parameters:

[in] n starting file descriptor number for closing all higher file descriptors

Since:: 1.6.1

Definition at line 2493 of file app.c.

References closefrom().

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

{
   closefrom(n + 1);
}

int ast_control_streamfile	(	struct ast_channel *	chan,
		const char *	file,
		const char *	fwd,
		const char *	rev,
		const char *	stop,
		const char *	pause,
		const char *	restart,
		int	skipms,
		long *	offsetms
	)

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

Parameters:

chan
file	filename
fwd,rev,stop,pause,restart,skipms,offsetms	Before calling this function, set this to be the number of ms to start from the beginning of the file. When the function returns, it will be the number of ms from the beginning where the playback stopped. Pass NULL if you don't care.

Definition at line 1077 of file app.c.

References control_streamfile().

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

{
   return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, NULL);
}

int ast_control_streamfile_w_cb	(	struct ast_channel *	chan,
		const char *	file,
		const char *	fwd,
		const char *	rev,
		const char *	stop,
		const char *	pause,
		const char *	restart,
		int	skipms,
		long *	offsetms,
		ast_waitstream_fr_cb	cb
	)

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

Parameters:

chan
file	filename
fwd,rev,stop,pause,restart,skipms,offsetms
waitstream	callback to invoke when fastforward or rewind occurrs.

Before calling this function, set this to be the number of ms to start from the beginning of the file. When the function returns, it will be the number of ms from the beginning where the playback stopped. Pass NULL if you don't care.

Definition at line 1063 of file app.c.

References control_streamfile().

{
   return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, cb);
}

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

Send DTMF to a channel.

Parameters:

chan	The channel that will receive the DTMF frames
peer	(optional) Peer channel that will be autoserviced while the primary channel is receiving DTMF
digits	This is a string of characters representing the DTMF digits to be sent to the channel. Valid characters are "0123456789*#abcdABCD". Note: You can pass arguments 'f' or 'F', if you want to Flash the channel (if supported by the channel), or 'w' to add a 500 millisecond pause to the DTMF sequence.
between	This is the number of milliseconds to wait in between each DTMF digit. If zero milliseconds is specified, then the default value of 100 will be used.
duration	This is the duration that each DTMF digit should have.

Definition at line 731 of file app.c.

References ast_autoservice_start(), ast_autoservice_stop(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), AST_CONTROL_FLASH, ast_indicate(), ast_log(), ast_opt_transmit_silence, ast_safe_sleep(), ast_senddigit(), ast_waitfor(), and LOG_WARNING.

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

{
   const char *ptr;
   int res = 0;
   struct ast_silence_generator *silgen = NULL;

   if (!between) {
      between = 100;
   }

   if (peer) {
      res = ast_autoservice_start(peer);
   }

   if (!res) {
      res = ast_waitfor(chan, 100);
   }

   /* ast_waitfor will return the number of remaining ms on success */
   if (res < 0) {
      if (peer) {
         ast_autoservice_stop(peer);
      }
      return res;
   }

   if (ast_opt_transmit_silence) {
      silgen = ast_channel_start_silence_generator(chan);
   }

   for (ptr = digits; *ptr; ptr++) {
      if (*ptr == 'w') {
         /* 'w' -- wait half a second */
         if ((res = ast_safe_sleep(chan, 500))) {
            break;
         }
      } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
         /* Character represents valid DTMF */
         if (*ptr == 'f' || *ptr == 'F') {
            /* ignore return values if not supported by channel */
            ast_indicate(chan, AST_CONTROL_FLASH);
         } else {
            ast_senddigit(chan, *ptr, duration);
         }
         /* pause between digits */
         if ((res = ast_safe_sleep(chan, between))) {
            break;
         }
      } else {
         ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
      }
   }

   if (peer) {
      /* Stop autoservice on the peer channel, but don't overwrite any error condition
         that has occurred previously while acting on the primary channel */
      if (ast_autoservice_stop(peer) && !res) {
         res = -1;
      }
   }

   if (silgen) {
      ast_channel_stop_silence_generator(chan, silgen);
   }

   return res;
}

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

Decode an encoded control or extended ASCII character.

Parameters:

[in]	stream	String to decode
[out]	result	Decoded character
[out]	consumed	Number of characters used in stream to encode the character

Return values:

-1	Stream is of zero length
0	Success

Definition at line 2378 of file app.c.

References ast_debug, ast_log(), ast_strlen_zero(), and LOG_ERROR.

Referenced by ast_get_encoded_str(), ast_str_get_encoded_str(), cut_internal(), filter(), function_fieldnum_helper(), function_fieldqty_helper(), replace(), shift_pop(), and unshift_push().

{
   int i;
   *consumed = 1;
   *result = 0;
   if (ast_strlen_zero(stream)) {
      *consumed = 0;
      return -1;
   }

   if (*stream == '\\') {
      *consumed = 2;
      switch (*(stream + 1)) {
      case 'n':
         *result = '\n';
         break;
      case 'r':
         *result = '\r';
         break;
      case 't':
         *result = '\t';
         break;
      case 'x':
         /* Hexadecimal */
         if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
            *consumed = 3;
            if (*(stream + 2) <= '9') {
               *result = *(stream + 2) - '0';
            } else if (*(stream + 2) <= 'F') {
               *result = *(stream + 2) - 'A' + 10;
            } else {
               *result = *(stream + 2) - 'a' + 10;
            }
         } else {
            ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
            return -1;
         }

         if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
            *consumed = 4;
            *result <<= 4;
            if (*(stream + 3) <= '9') {
               *result += *(stream + 3) - '0';
            } else if (*(stream + 3) <= 'F') {
               *result += *(stream + 3) - 'A' + 10;
            } else {
               *result += *(stream + 3) - 'a' + 10;
            }
         }
         break;
      case '0':
         /* Octal */
         *consumed = 2;
         for (i = 2; ; i++) {
            if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
               (*consumed)++;
               ast_debug(5, "result was %d, ", *result);
               *result <<= 3;
               *result += *(stream + i) - '0';
               ast_debug(5, "is now %d\n", *result);
            } else {
               break;
            }
         }
         break;
      default:
         *result = *(stream + 1);
      }
   } else {
      *result = *stream;
      *consumed = 1;
   }
   return 0;
}

char* ast_get_encoded_str	(	const char *	stream,
		char *	result,
		size_t	result_len
	)

Decode a stream of encoded control or extended ASCII characters.

Parameters:

[in]	stream	Encoded string
[out]	result	Decoded string
[in]	result_len	Maximum size of the result buffer

Returns:: A pointer to the result string

Definition at line 2453 of file app.c.

References ast_get_encoded_char().

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

{
   char *cur = result;
   size_t consumed;

   while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
      cur++;
      stream += consumed;
   }
   *cur = '\0';
   return result;
}

void ast_install_stack_functions ( const struct ast_app_stack_funcs * funcs )

Set stack application function callbacks.

Since:: 11

Parameters:

funcs Stack applications callback functions.

Definition at line 322 of file app.c.

References app_stack_callbacks.

Referenced by load_module(), and unload_module().

{
   app_stack_callbacks = funcs;
}

void ast_install_vm_functions	(	int()(const char mailbox, const char *folder)	has_voicemail_func,
		int()(const char mailbox, int newmsgs, int oldmsgs)	inboxcount_func,
		int()(const char mailbox, int urgentmsgs, int newmsgs, int *oldmsgs)	inboxcount2_func,
		int()(const char context, const char mailbox, const char folder)	messagecount_func,
		int()(struct ast_channel chan, const char mailbox, const char context)	sayname_func,
		int()(struct ast_vm_recording_data vm_rec_data)	copy_recording_to_vm_func,
		const char *	vm_index_to_foldernameint id,
		struct ast_vm_mailbox_snapshot ()(const char mailbox, const char context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)	vm_mailbox_snapshot_create,
		struct ast_vm_mailbox_snapshot ()(struct ast_vm_mailbox_snapshot *mailbox_snapshot)	vm_mailbox_snapshot_destroy,
		int()(const char mailbox, const char context, size_t num_msgs, const char oldfolder, const char old_msg_ids[], const char newfolder)	vm_msg_move,
		int()(const char mailbox, const char context, size_t num_msgs, const char folder, const char *msgs[])	vm_msg_remove,
		int()(const char from_mailbox, const char from_context, const char from_folder, const char to_mailbox, const char to_context, const char to_folder, size_t num_msgs, const char msg_ids[], int delete_old)	vm_msg_forward,
		int()(struct ast_channel chan, const char mailbox, const char context, const char folder, const char msg_num, ast_vm_msg_play_cb cb)	vm_msg_play
	)

Set voicemail function callbacks.

Parameters:

[in]	has_voicemail_func	set function pointer
[in]	inboxcount_func	set function pointer
[in]	inboxcount2_func	set function pointer
[in]	messagecount_func	set function pointer
[in]	sayname_func	set function pointer

Version:: 1.6.1 Added inboxcount2_func, sayname_func

Definition at line 437 of file app.c.

References ast_copy_recording_to_vm_func, ast_has_voicemail_func, ast_inboxcount2_func, ast_inboxcount_func, ast_messagecount_func, ast_sayname_func, ast_vm_index_to_foldername_func, ast_vm_mailbox_snapshot_create_func, ast_vm_mailbox_snapshot_destroy_func, ast_vm_msg_forward_func, ast_vm_msg_move_func, ast_vm_msg_play_func, and ast_vm_msg_remove_func.

Referenced by load_module().

{
   ast_has_voicemail_func = has_voicemail_func;
   ast_inboxcount_func = inboxcount_func;
   ast_inboxcount2_func = inboxcount2_func;
   ast_messagecount_func = messagecount_func;
   ast_sayname_func = sayname_func;
   ast_copy_recording_to_vm_func = copy_recording_to_vm_func;
   ast_vm_index_to_foldername_func = vm_index_to_foldername_func;
   ast_vm_mailbox_snapshot_create_func = vm_mailbox_snapshot_create_func;
   ast_vm_mailbox_snapshot_destroy_func = vm_mailbox_snapshot_destroy_func;
   ast_vm_msg_move_func = vm_msg_move_func;
   ast_vm_msg_remove_func = vm_msg_remove_func;
   ast_vm_msg_forward_func = vm_msg_forward_func;
   ast_vm_msg_play_func = vm_msg_play_func;
}

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

References ast_ivr_menu_run_internal().

Referenced by skel_exec().

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

static int ast_ivr_menu_run_internal	(	struct ast_channel *	chan,
		struct ast_ivr_menu *	menu,
		void *	cbdata
	)		`[static]`

Definition at line 2151 of file app.c.

References ast_debug, AST_DIGIT_ANY, ast_log(), AST_MAX_EXTENSION, exten, ivr_dispatch(), LOG_WARNING, maxretries, ast_ivr_option::option, option_exists(), ast_ivr_menu::options, read_newoption(), RES_EXIT, RES_REPEAT, RES_RESTART, RES_UPONE, and ast_ivr_menu::title.

Referenced by ast_ivr_menu_run(), and ivr_dispatch().

{
   /* Execute an IVR menu structure */
   int res = 0;
   int pos = 0;
   int retries = 0;
   char exten[AST_MAX_EXTENSION] = "s";
   if (option_exists(menu, "s") < 0) {
      strcpy(exten, "g");
      if (option_exists(menu, "g") < 0) {
         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
         return -1;
      }
   }
   while (!res) {
      while (menu->options[pos].option) {
         if (!strcasecmp(menu->options[pos].option, exten)) {
            res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
            ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
            if (res < 0) {
               break;
            } else if (res & RES_UPONE) {
               return 0;
            } else if (res & RES_EXIT) {
               return res;
            } else if (res & RES_REPEAT) {
               int maxretries = res & 0xffff;
               if ((res & RES_RESTART) == RES_RESTART) {
                  retries = 0;
               } else {
                  retries++;
               }
               if (!maxretries) {
                  maxretries = 3;
               }
               if ((maxretries > 0) && (retries >= maxretries)) {
                  ast_debug(1, "Max retries %d exceeded\n", maxretries);
                  return -2;
               } else {
                  if (option_exists(menu, "g") > -1) {
                     strcpy(exten, "g");
                  } else if (option_exists(menu, "s") > -1) {
                     strcpy(exten, "s");
                  }
               }
               pos = 0;
               continue;
            } else if (res && strchr(AST_DIGIT_ANY, res)) {
               ast_debug(1, "Got start of extension, %c\n", res);
               exten[1] = '\0';
               exten[0] = res;
               if ((res = read_newoption(chan, menu, exten, sizeof(exten)))) {
                  break;
               }
               if (option_exists(menu, exten) < 0) {
                  if (option_exists(menu, "i")) {
                     ast_debug(1, "Invalid extension entered, going to 'i'!\n");
                     strcpy(exten, "i");
                     pos = 0;
                     continue;
                  } else {
                     ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
                     res = -2;
                     break;
                  }
               } else {
                  ast_debug(1, "New existing extension: %s\n", exten);
                  pos = 0;
                  continue;
               }
            }
         }
         pos++;
      }
      ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
      pos = 0;
      if (!strcasecmp(exten, "s")) {
         strcpy(exten, "g");
      } else {
         break;
      }
   }
   return res;
}

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

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

{
   struct linear_state *lin;
   char tmpf[256];
   int res = -1;
   int autoclose = 0;
   if (fd < 0) {
      if (ast_strlen_zero(filename)) {
         return -1;
      }
      autoclose = 1;
      if (filename[0] == '/') {
         ast_copy_string(tmpf, filename, sizeof(tmpf));
      } else {
         snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
      }
      if ((fd = open(tmpf, O_RDONLY)) < 0) {
         ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
         return -1;
      }
   }
   if ((lin = ast_calloc(1, sizeof(*lin)))) {
      lin->fd = fd;
      lin->allowoverride = allowoverride;
      lin->autoclose = autoclose;
      res = ast_activate_generator(chan, &linearstream, lin);
   }
   return res;
}

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

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

Referenced by ast_module_reload(), and vm_lock_path().

{
   enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;

   switch (ast_lock_type) {
   case AST_LOCK_TYPE_LOCKFILE:
      r = ast_lock_path_lockfile(path);
      break;
   case AST_LOCK_TYPE_FLOCK:
      r = ast_lock_path_flock(path);
      break;
   }

   return r;
}

static enum AST_LOCK_RESULT ast_lock_path_flock ( const char * path ) [static]

Definition at line 1788 of file app.c.

References ast_alloca, ast_calloc, ast_debug, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, AST_LOCK_FAILURE, AST_LOCK_PATH_NOT_FOUND, AST_LOCK_SUCCESS, AST_LOCK_TIMEOUT, ast_log(), errno, path_lock::fd, LOG_WARNING, path_lock::path, path_lock_destroy(), and strdup.

Referenced by ast_lock_path().

{
   char *fs;
   int res;
   int fd;
   time_t start;
   struct path_lock *pl;
   struct stat st, ost;

   fs = ast_alloca(strlen(path) + 20);

   snprintf(fs, strlen(path) + 19, "%s/lock", path);
   if (lstat(fs, &st) == 0) {
      if ((st.st_mode & S_IFMT) == S_IFLNK) {
         ast_log(LOG_WARNING, "Unable to create lock file "
               "'%s': it's already a symbolic link\n",
               fs);
         return AST_LOCK_FAILURE;
      }
      if (st.st_nlink > 1) {
         ast_log(LOG_WARNING, "Unable to create lock file "
               "'%s': %u hard links exist\n",
               fs, (unsigned int) st.st_nlink);
         return AST_LOCK_FAILURE;
      }
   }
   if ((fd = open(fs, O_WRONLY | O_CREAT, 0600)) < 0) {
      ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
            fs, strerror(errno));
      return AST_LOCK_PATH_NOT_FOUND;
   }
   if (!(pl = ast_calloc(1, sizeof(*pl)))) {
      /* We don't unlink the lock file here, on the possibility that
       * someone else created it - better to leave a little mess
       * than create a big one by destroying someone else's lock
       * and causing something to be corrupted.
       */
      close(fd);
      return AST_LOCK_FAILURE;
   }
   pl->fd = fd;
   pl->path = strdup(path);

   time(&start);
   while (
      #ifdef SOLARIS
      ((res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd, F_GETFL) | O_NONBLOCK)) < 0) &&
      #else
      ((res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
      #endif
         (errno == EWOULDBLOCK) &&
         (time(NULL) - start < 5))
      usleep(1000);
   if (res) {
      ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
            path, strerror(errno));
      /* No unlinking of lock done, since we tried and failed to
       * flock() it.
       */
      path_lock_destroy(pl);
      return AST_LOCK_TIMEOUT;
   }

   /* Check for the race where the file is recreated or deleted out from
    * underneath us.
    */
   if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
         st.st_dev != ost.st_dev &&
         st.st_ino != ost.st_ino) {
      ast_log(LOG_WARNING, "Unable to create lock file '%s': "
            "file changed underneath us\n", fs);
      path_lock_destroy(pl);
      return AST_LOCK_FAILURE;
   }

   /* Success: file created, flocked, and is the one we started with */
   AST_LIST_LOCK(&path_lock_list);
   AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
   AST_LIST_UNLOCK(&path_lock_list);

   ast_debug(1, "Locked path '%s'\n", path);

   return AST_LOCK_SUCCESS;
}

static enum AST_LOCK_RESULT ast_lock_path_lockfile ( const char * path ) [static]

Definition at line 1714 of file app.c.

References ast_alloca, ast_debug, AST_LOCK_PATH_NOT_FOUND, AST_LOCK_SUCCESS, AST_LOCK_TIMEOUT, ast_log(), ast_random(), errno, LOG_ERROR, and LOG_WARNING.

Referenced by ast_lock_path().

{
   char *s;
   char *fs;
   int res;
   int fd;
   int lp = strlen(path);
   time_t start;

   s = ast_alloca(lp + 10);
   fs = ast_alloca(lp + 20);

   snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
   fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
   if (fd < 0) {
      ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
      return AST_LOCK_PATH_NOT_FOUND;
   }
   close(fd);

   snprintf(s, strlen(path) + 9, "%s/.lock", path);
   start = time(NULL);
   while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5)) {
      sched_yield();
   }

   unlink(fs);

   if (res) {
      ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
      return AST_LOCK_TIMEOUT;
   } else {
      ast_debug(1, "Locked path '%s'\n", path);
      return AST_LOCK_SUCCESS;
   }
}

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

Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings This function will not play a success message due to post-recording control in the application this was added for.

Parameters:

chan	the channel being recorded
playfile	Filename of sound to play before recording begins
recordfile	Filename to save the recording
maxtime_sec	Longest possible message length in seconds
fmt	string containing all formats to be recorded delimited by '\|'
duration	pointer to integer for storing length of the recording
sound_duration	pointer to integer for storing length of the recording minus all silence
beep	whether to play a beep to prompt the recording
silencethreshold	tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms	length of time in milliseconds which will trigger a timeout from silence, -1 for default.

Return values:

-1	failure or hangup
'S'	Recording ended from silence timeout
't'	Recording either exceeded maximum duration or the call was ended via DTMF

Definition at line 1444 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, and default_canceldtmf.

Referenced by vm_forwardoptions().

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

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

Record a file based on input from a channel. Use default accept and cancel DTMF. This function will play "auth-thankyou" upon successful recording.

Parameters:

chan	the channel being recorded
playfile	Filename of sound to play before recording begins
recordfile	Filename to save the recording
maxtime_sec	Longest possible message length in seconds
fmt	string containing all formats to be recorded delimited by '\|'
duration	pointer to integer for storing length of the recording
sound_duration	pointer to integer for storing length of the recording minus all silence
silencethreshold	tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms	length of time in milliseconds which will trigger a timeout from silence, -1 for default
path	Optional filesystem path to unlock

Return values:

-1	failure or hangup
'S'	Recording ended from silence timeout
't'	Recording ended from the message exceeding the maximum duration
dtmfchar	Recording ended via the return value's DTMF character for either cancel or accept.

Definition at line 1439 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, and default_canceldtmf.

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

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

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

Record a file based on input from a channel This function will play "auth-thankyou" upon successful recording.

Parameters:

chan	the channel being recorded
playfile	Filename of sound to play before recording begins
recordfile	Filename to save the recording
maxtime_sec	Longest possible message length in seconds
fmt	string containing all formats to be recorded delimited by '\|'
duration	pointer to integer for storing length of the recording
sound_duration	pointer to integer for storing length of the recording minus all silence
silencethreshold	tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
maxsilence_ms	Length of time in milliseconds which will trigger a timeout from silence, -1 for default
path	Optional filesystem path to unlock
acceptdtmf	Character of DTMF to end and accept the recording
canceldtmf	Character of DTMF to end and cancel the recording

Return values:

-1	failure or hangup
'S'	Recording ended from silence timeout
't'	Recording ended from the message exceeding the maximum duration
dtmfchar	Recording ended via the return value's DTMF character for either cancel or accept.

Definition at line 1434 of file app.c.

References __ast_play_and_record(), default_acceptdtmf, default_canceldtmf, and S_OR.

Referenced by play_record_review().

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

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

References ast_channel_language(), ast_channel_name(), AST_DIGIT_ANY, ast_stopstream(), ast_streamfile(), ast_test_suite_event_notify, and ast_waitstream().

{
   int d = 0;

   ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", fn, ast_channel_name(chan));
   if ((d = ast_streamfile(chan, fn, ast_channel_language(chan)))) {
      return d;
   }

   d = ast_waitstream(chan, AST_DIGIT_ANY);

   ast_stopstream(chan);

   return d;
}

char* ast_read_textfile ( const char * filename )

Read a file into asterisk.

Definition at line 2243 of file app.c.

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

Referenced by readfile_exec().

{
   int fd, count = 0, res;
   char *output = NULL;
   struct stat filesize;

   if (stat(filename, &filesize) == -1) {
      ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
      return NULL;
   }

   count = filesize.st_size + 1;

   if ((fd = open(filename, O_RDONLY)) < 0) {
      ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
      return NULL;
   }

   if ((output = ast_malloc(count))) {
      res = read(fd, output, count - 1);
      if (res == count - 1) {
         output[res] = '\0';
      } else {
         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
         ast_free(output);
         output = NULL;
      }
   }

   close(fd);

   return output;
}

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

References AST_DIGIT_ANY, ast_dsp_get_threshold_from_settings(), ast_log(), ast_play_and_record(), ast_play_and_wait(), ast_stream_and_wait(), ast_verb, ast_waitfordigit(), LOG_WARNING, maxsilence, silencethreshold, and THRESHOLD_SILENCE.

Referenced by conf_run().

{
   int silencethreshold;
   int maxsilence = 0;
   int res = 0;
   int cmd = 0;
   int max_attempts = 3;
   int attempts = 0;
   int recorded = 0;
   int message_exists = 0;
   /* Note that urgent and private are for flagging messages as such in the future */

   /* barf if no pointer passed to store duration in */
   if (!duration) {
      ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
      return -1;
   }

   cmd = '3';   /* Want to start by recording */

   silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);

   while ((cmd >= 0) && (cmd != 't')) {
      switch (cmd) {
      case '1':
         if (!message_exists) {
            /* In this case, 1 is to record a message */
            cmd = '3';
            break;
         } else {
            ast_stream_and_wait(chan, "vm-msgsaved", "");
            cmd = 't';
            return res;
         }
      case '2':
         /* Review */
         ast_verb(3, "Reviewing the recording\n");
         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
         break;
      case '3':
         message_exists = 0;
         /* Record */
         ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
         recorded = 1;
         if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
            /* User has hung up, no options to give */
            return cmd;
         }
         if (cmd == '0') {
            break;
         } else if (cmd == '*') {
            break;
         } else {
            /* If all is well, a message exists */
            message_exists = 1;
            cmd = 0;
         }
         break;
      case '4':
      case '5':
      case '6':
      case '7':
      case '8':
      case '9':
      case '*':
      case '#':
         cmd = ast_play_and_wait(chan, "vm-sorry");
         break;
      default:
         if (message_exists) {
            cmd = ast_play_and_wait(chan, "vm-review");
         } else {
            if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
               cmd = ast_waitfordigit(chan, 600);
            }
         }

         if (!cmd) {
            cmd = ast_waitfordigit(chan, 6000);
         }
         if (!cmd) {
            attempts++;
         }
         if (attempts > max_attempts) {
            cmd = 't';
         }
      }
   }
   if (cmd == 't') {
      cmd = 0;
   }
   return cmd;
}

int ast_safe_fork ( int stop_reaper )

Common routine to safely fork without a chance of a signal handler firing badly in the child.

Parameters:

[in] stop_reaper flag to determine if sigchld handler is replaced or not

Since:: 1.6.1

Definition at line 2498 of file app.c.

References ast_calloc, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), ast_pthread_create_background, AST_PTHREADT_NULL, ast_replace_sigchld(), errno, zombie::list, LOG_ERROR, LOG_WARNING, zombie::pid, and shaun_of_the_dead().

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

{
   sigset_t signal_set, old_set;
   int pid;

   /* Don't let the default signal handler for children reap our status */
   if (stop_reaper) {
      ast_replace_sigchld();
   }

   sigfillset(&signal_set);
   pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);

   pid = fork();

   if (pid != 0) {
      /* Fork failed or parent */
      pthread_sigmask(SIG_SETMASK, &old_set, NULL);
      if (!stop_reaper && pid > 0) {
         struct zombie *cur = ast_calloc(1, sizeof(*cur));
         if (cur) {
            cur->pid = pid;
            AST_LIST_LOCK(&zombies);
            AST_LIST_INSERT_TAIL(&zombies, cur, list);
            AST_LIST_UNLOCK(&zombies);
            if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
               if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
                  ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
                  shaun_of_the_dead_thread = AST_PTHREADT_NULL;
               }
            }
         }
      }
      return pid;
   } else {
      /* Child */
#ifdef HAVE_CAP
      cap_t cap = cap_from_text("cap_net_admin-eip");

      if (cap_set_proc(cap)) {
         ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
      }
      cap_free(cap);
#endif

      /* Before we unblock our signals, return our trapped signals back to the defaults */
      signal(SIGHUP, SIG_DFL);
      signal(SIGCHLD, SIG_DFL);
      signal(SIGINT, SIG_DFL);
      signal(SIGURG, SIG_DFL);
      signal(SIGTERM, SIG_DFL);
      signal(SIGPIPE, SIG_DFL);
      signal(SIGXFSZ, SIG_DFL);

      /* unblock important signal handlers */
      if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
         ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
         _exit(1);
      }

      return pid;
   }
}

void ast_safe_fork_cleanup ( void )

Common routine to cleanup after fork'ed process is complete (if reaping was stopped)

Since:: 1.6.1

Definition at line 2562 of file app.c.

References ast_unreplace_sigchld().

Referenced by agi_exec_full(), and run_ras().

{
   ast_unreplace_sigchld();
}

void ast_set_lock_type ( enum AST_LOCK_TYPE type )

Set the type of locks used by ast_lock_path()

Parameters:

type	the locking type to use

Definition at line 1903 of file app.c.

References ast_lock_type, and type.

Referenced by ast_readconfig().

{
   ast_lock_type = type;
}

int ast_str_get_encoded_str	(	struct ast_str **	str,
		int	maxlen,
		const char *	stream
	)

Decode a stream of encoded control or extended ASCII characters.

Definition at line 2466 of file app.c.

References ast_get_encoded_char(), ast_str_buffer(), ast_str_make_space(), ast_str_set(), ast_str_size(), ast_str_update(), and zombie::next.

Referenced by sendtext_exec(), and system_exec_helper().

{
   char next, *buf;
   size_t offset = 0;
   size_t consumed;

   if (strchr(stream, '\\')) {
      while (!ast_get_encoded_char(stream, &next, &consumed)) {
         if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
            ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
         }
         if (offset + 2 > ast_str_size(*str)) {
            break;
         }
         buf = ast_str_buffer(*str);
         buf[offset++] = next;
         stream += consumed;
      }
      buf = ast_str_buffer(*str);
      buf[offset++] = '\0';
      ast_str_update(*str);
   } else {
      ast_str_set(str, maxlen, "%s", stream);
   }
   return 0;
}

AST_THREADSTORAGE_PUBLIC ( ast_str_thread_global_buf )

void ast_uninstall_vm_functions ( void )

Definition at line 493 of file app.c.

References ast_copy_recording_to_vm_func, ast_has_voicemail_func, ast_inboxcount2_func, ast_inboxcount_func, ast_messagecount_func, ast_sayname_func, ast_vm_index_to_foldername_func, ast_vm_mailbox_snapshot_create_func, ast_vm_mailbox_snapshot_destroy_func, ast_vm_msg_forward_func, ast_vm_msg_move_func, ast_vm_msg_play_func, and ast_vm_msg_remove_func.

Referenced by unload_module().

{
   ast_has_voicemail_func = NULL;
   ast_inboxcount_func = NULL;
   ast_inboxcount2_func = NULL;
   ast_messagecount_func = NULL;
   ast_sayname_func = NULL;
   ast_copy_recording_to_vm_func = NULL;
   ast_vm_index_to_foldername_func = NULL;
   ast_vm_mailbox_snapshot_create_func = NULL;
   ast_vm_mailbox_snapshot_destroy_func = NULL;
   ast_vm_msg_move_func = NULL;
   ast_vm_msg_remove_func = NULL;
   ast_vm_msg_forward_func = NULL;
   ast_vm_msg_play_func = NULL;
}

int ast_unlock_path ( const char * path )

Unlock a path.

Definition at line 1924 of file app.c.

References ast_lock_type, AST_LOCK_TYPE_FLOCK, AST_LOCK_TYPE_LOCKFILE, ast_unlock_path_flock(), and ast_unlock_path_lockfile().

Referenced by __ast_play_and_record(), access_counter_file(), ast_module_reload(), close_mailbox(), copy_message(), count_messages(), leave_voicemail(), msg_create_from_file(), open_mailbox(), resequence_mailbox(), and save_to_folder().

{
   int r = 0;

   switch (ast_lock_type) {
   case AST_LOCK_TYPE_LOCKFILE:
      r = ast_unlock_path_lockfile(path);
      break;
   case AST_LOCK_TYPE_FLOCK:
      r = ast_unlock_path_flock(path);
      break;
   }

   return r;
}

static int ast_unlock_path_flock ( const char * path ) [static]

Definition at line 1873 of file app.c.

References ast_alloca, ast_debug, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, path_lock::le, path_lock::path, and path_lock_destroy().

Referenced by ast_unlock_path().

{
   char *s;
   struct path_lock *p;

   s = ast_alloca(strlen(path) + 20);

   AST_LIST_LOCK(&path_lock_list);
   AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
      if (!strcmp(p->path, path)) {
         AST_LIST_REMOVE_CURRENT(le);
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&path_lock_list);

   if (p) {
      snprintf(s, strlen(path) + 19, "%s/lock", path);
      unlink(s);
      path_lock_destroy(p);
      ast_debug(1, "Unlocked path '%s'\n", path);
   } else {
      ast_debug(1, "Failed to unlock path '%s': "
            "lock not found\n", path);
   }

   return 0;
}

static int ast_unlock_path_lockfile ( const char * path ) [static]

Definition at line 1751 of file app.c.

References ast_alloca, ast_debug, ast_log(), errno, and LOG_ERROR.

Referenced by ast_unlock_path().

{
   char *s;
   int res;

   s = ast_alloca(strlen(path) + 10);

   snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");

   if ((res = unlink(s))) {
      ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
   } else {
      ast_debug(1, "Unlocked path '%s'\n", path);
   }

   return res;
}

const char* ast_vm_index_to_foldername ( int id )

Return name of folder, given an id.

Parameters:

[in] id Folder id

Returns:: Name of folder

Definition at line 630 of file app.c.

References ast_vm_index_to_foldername_func.

{
   if (ast_vm_index_to_foldername_func) {
      return ast_vm_index_to_foldername_func(id);
   }
   return NULL;
}

struct ast_vm_mailbox_snapshot* ast_vm_mailbox_snapshot_create	(	const char *	mailbox,
		const char *	context,
		const char *	folder,
		int	descending,
		enum ast_vm_snapshot_sort_val	sort_val,
		int	combine_INBOX_and_OLD
	)		`[read]`

Definition at line 638 of file app.c.

References ast_vm_mailbox_snapshot_create_func.

{
   if (ast_vm_mailbox_snapshot_create_func) {
      return ast_vm_mailbox_snapshot_create_func(mailbox, context, folder, descending, sort_val, combine_INBOX_and_OLD);
   }
   return NULL;
}

struct ast_vm_mailbox_snapshot* ast_vm_mailbox_snapshot_destroy ( struct ast_vm_mailbox_snapshot * mailbox_snapshot ) [read]

Definition at line 651 of file app.c.

References ast_vm_mailbox_snapshot_destroy_func.

{
   if (ast_vm_mailbox_snapshot_destroy_func) {
      return ast_vm_mailbox_snapshot_destroy_func(mailbox_snapshot);
   }
   return NULL;
}

int ast_vm_msg_forward	(	const char *	from_mailbox,
		const char *	from_context,
		const char *	from_folder,
		const char *	to_mailbox,
		const char *	to_context,
		const char *	to_folder,
		size_t	num_msgs,
		const char *	msg_ids[],
		int	delete_old
	)

forward a message from one mailbox to another.

from_mailbox The original mailbox the message is being forwarded from from_context The voicemail context of the from_mailbox from_folder The folder from which the message is being forwarded to_mailbox The mailbox to forward the message to to_context The voicemail context of the to_mailbox to_folder The folder to which the message is being forwarded num_msgs The number of messages being forwarded msg_ids The message IDs of the messages in from_mailbox to forward delete_old If non-zero, the forwarded messages are also deleted from from_mailbox. Otherwise, the messages will remain in the from_mailbox.

Return values:

-1	Failure
0	Success

Definition at line 684 of file app.c.

References ast_vm_msg_forward_func.

{
   if (ast_vm_msg_forward_func) {
      return ast_vm_msg_forward_func(from_mailbox, from_context, from_folder, to_mailbox, to_context, to_folder, num_msgs, msg_ids, delete_old);
   }
   return 0;
}

int ast_vm_msg_move	(	const char *	mailbox,
		const char *	context,
		size_t	num_msgs,
		const char *	oldfolder,
		const char *	old_msg_ids[],
		const char *	newfolder
	)

Move messages from one folder to another.

Parameters:

mailbox	The mailbox to which the folders belong
context	The voicemail context for the mailbox
num_msgs	The number of messages to move
oldfolder	The folder from where messages should be moved
old_msg_nums	The message IDs of the messages to move
newfolder	The folder to which messages should be moved new folder. This array must be num_msgs sized.

Return values:

-1	Failure
0	Success

Definition at line 659 of file app.c.

References ast_vm_msg_move_func.

{
   if (ast_vm_msg_move_func) {
      return ast_vm_msg_move_func(mailbox, context, num_msgs, oldfolder, old_msg_ids, newfolder);
   }
   return 0;
}

int ast_vm_msg_play	(	struct ast_channel *	chan,
		const char *	mailbox,
		const char *	context,
		const char *	folder,
		const char *	msg_num,
		ast_vm_msg_play_cb	cb
	)

Play a voicemail msg back on a channel.

Parameters:

mailbox	msg is in.
context	of mailbox.
voicemail	folder to look in.
message	number in the voicemailbox to playback to the channel.

Return values:

0	success
-1	failure

Definition at line 700 of file app.c.

References ast_vm_msg_play_func.

{
   if (ast_vm_msg_play_func) {
      return ast_vm_msg_play_func(chan, mailbox, context, folder, msg_num, cb);
   }
   return 0;
}

int ast_vm_msg_remove	(	const char *	mailbox,
		const char *	context,
		size_t	num_msgs,
		const char *	folder,
		const char *	msgs[]
	)

Remove/delete messages from a mailbox folder.

Parameters:

mailbox	The mailbox from which to delete messages
context	The voicemail context for the mailbox
num_msgs	The number of messages to delete
folder	The folder from which to remove messages
msgs	The message IDs of the messages to delete

Return values:

-1	Failure
0	Success

Definition at line 672 of file app.c.

References ast_vm_msg_remove_func.

{
   if (ast_vm_msg_remove_func) {
      return ast_vm_msg_remove_func(mailbox, context, num_msgs, folder, msgs);
   }
   return 0;
}

static int control_streamfile	(	struct ast_channel *	chan,
		const char *	file,
		const char *	fwd,
		const char *	rev,
		const char *	stop,
		const char *	suspend,
		const char *	restart,
		int	skipms,
		long *	offsetms,
		ast_waitstream_fr_cb	cb
	)		`[static]`

Definition at line 914 of file app.c.

References ast_alloca, ast_answer(), ast_channel_language(), ast_channel_stream(), ast_debug, ast_seekstream(), AST_STATE_UP, ast_stopstream(), ast_streamfile(), ast_tellstream(), ast_verb, ast_waitfordigit(), ast_waitstream_fr(), and ast_waitstream_fr_w_cb().

Referenced by ast_control_streamfile(), and ast_control_streamfile_w_cb().

{
   char *breaks = NULL;
   char *end = NULL;
   int blen = 2;
   int res;
   long pause_restart_point = 0;
   long offset = 0;

   if (!file) {
      return -1;
   }
   if (offsetms) {
      offset = *offsetms * 8; /* XXX Assumes 8kHz */
   }

   if (stop) {
      blen += strlen(stop);
   }
   if (suspend) {
      blen += strlen(suspend);
   }
   if (restart) {
      blen += strlen(restart);
   }

   if (blen > 2) {
      breaks = ast_alloca(blen + 1);
      breaks[0] = '\0';
      if (stop) {
         strcat(breaks, stop);
      }
      if (suspend) {
         strcat(breaks, suspend);
      }
      if (restart) {
         strcat(breaks, restart);
      }
   }
   if (ast_channel_state(chan) != AST_STATE_UP) {
      res = ast_answer(chan);
   }

   if ((end = strchr(file, ':'))) {
      if (!strcasecmp(end, ":end")) {
         *end = '\0';
         end++;
      }
   }

   for (;;) {
      ast_stopstream(chan);
      res = ast_streamfile(chan, file, ast_channel_language(chan));
      if (!res) {
         if (pause_restart_point) {
            ast_seekstream(ast_channel_stream(chan), pause_restart_point, SEEK_SET);
            pause_restart_point = 0;
         }
         else if (end || offset < 0) {
            if (offset == -8) {
               offset = 0;
            }
            ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);

            ast_seekstream(ast_channel_stream(chan), offset, SEEK_END);
            end = NULL;
            offset = 0;
         } else if (offset) {
            ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
            ast_seekstream(ast_channel_stream(chan), offset, SEEK_SET);
            offset = 0;
         }
         if (cb) {
            res = ast_waitstream_fr_w_cb(chan, breaks, fwd, rev, skipms, cb);
         } else {
            res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
         }
      }

      if (res < 1) {
         break;
      }

      /* We go at next loop if we got the restart char */
      if (restart && strchr(restart, res)) {
         ast_debug(1, "we'll restart the stream here at next loop\n");
         pause_restart_point = 0;
         continue;
      }

      if (suspend && strchr(suspend, res)) {
         pause_restart_point = ast_tellstream(ast_channel_stream(chan));
         for (;;) {
            ast_stopstream(chan);
            if (!(res = ast_waitfordigit(chan, 1000))) {
               continue;
            } else if (res == -1 || strchr(suspend, res) || (stop && strchr(stop, res))) {
               break;
            }
         }
         if (res == *suspend) {
            res = 0;
            continue;
         }
      }

      if (res == -1) {
         break;
      }

      /* if we get one of our stop chars, return it to the calling function */
      if (stop && strchr(stop, res)) {
         break;
      }
   }

   if (pause_restart_point) {
      offset = pause_restart_point;
   } else {
      if (ast_channel_stream(chan)) {
         offset = ast_tellstream(ast_channel_stream(chan));
      } else {
         offset = -8;  /* indicate end of file */
      }
   }

   if (offsetms) {
      *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
   }

   /* If we are returning a digit cast it as char */
   if (res > 0 || ast_channel_stream(chan)) {
      res = (char)res;
   }

   ast_stopstream(chan);

   return res;
}

static int ivr_dispatch	(	struct ast_channel *	chan,
		struct ast_ivr_option *	option,
		char *	exten,
		void *	cbdata
	)		`[static]`

Definition at line 2041 of file app.c.

References ast_ivr_option::action, ast_ivr_option::adata, AST_ACTION_BACKGROUND, AST_ACTION_BACKLIST, AST_ACTION_CALLBACK, AST_ACTION_EXIT, AST_ACTION_MENU, AST_ACTION_NOOP, AST_ACTION_PLAYBACK, AST_ACTION_PLAYLIST, AST_ACTION_REPEAT, AST_ACTION_RESTART, AST_ACTION_TRANSFER, AST_ACTION_UPONE, AST_ACTION_WAITOPTION, ast_channel_pbx(), AST_DIGIT_ANY, ast_ivr_menu_run_internal(), ast_log(), ast_parseable_goto(), ast_stopstream(), ast_stream_and_wait(), ast_waitfordigit(), LOG_NOTICE, RES_EXIT, RES_REPEAT, RES_RESTART, and RES_UPONE.

Referenced by ast_ivr_menu_run_internal().

{
   int res;
   int (*ivr_func)(struct ast_channel *, void *);
   char *c;
   char *n;

   switch (option->action) {
   case AST_ACTION_UPONE:
      return RES_UPONE;
   case AST_ACTION_EXIT:
      return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
   case AST_ACTION_REPEAT:
      return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
   case AST_ACTION_RESTART:
      return RES_RESTART ;
   case AST_ACTION_NOOP:
      return 0;
   case AST_ACTION_BACKGROUND:
      res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
      if (res < 0) {
         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
         res = 0;
      }
      return res;
   case AST_ACTION_PLAYBACK:
      res = ast_stream_and_wait(chan, (char *)option->adata, "");
      if (res < 0) {
         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
         res = 0;
      }
      return res;
   case AST_ACTION_MENU:
      if ((res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata)) == -2) {
         /* Do not pass entry errors back up, treat as though it was an "UPONE" */
         res = 0;
      }
      return res;
   case AST_ACTION_WAITOPTION:
      if (!(res = ast_waitfordigit(chan, ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 10000))) {
         return 't';
      }
      return res;
   case AST_ACTION_CALLBACK:
      ivr_func = option->adata;
      res = ivr_func(chan, cbdata);
      return res;
   case AST_ACTION_TRANSFER:
      res = ast_parseable_goto(chan, option->adata);
      return 0;
   case AST_ACTION_PLAYLIST:
   case AST_ACTION_BACKLIST:
      res = 0;
      c = ast_strdupa(option->adata);
      while ((n = strsep(&c, ";"))) {
         if ((res = ast_stream_and_wait(chan, n,
               (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : ""))) {
            break;
         }
      }
      ast_stopstream(chan);
      return res;
   default:
      ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
      return 0;
   }
   return -1;
}

static void* linear_alloc	(	struct ast_channel *	chan,
		void *	params
	)		`[static]`

Definition at line 851 of file app.c.

References linear_state::allowoverride, ast_channel_flags(), ast_channel_name(), ast_channel_writeformat(), ast_clear_flag, AST_FLAG_WRITE_INT, ast_format_copy(), AST_FORMAT_SLINEAR, ast_free, ast_log(), ast_set_flag, ast_set_write_format_by_id(), LOG_WARNING, and linear_state::origwfmt.

{
   struct linear_state *ls = params;

   if (!params) {
      return NULL;
   }

   /* In this case, params is already malloc'd */
   if (ls->allowoverride) {
      ast_set_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
   } else {
      ast_clear_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
   }

   ast_format_copy(&ls->origwfmt, ast_channel_writeformat(chan));

   if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR)) {
      ast_log(LOG_WARNING, "Unable to set '%s' to linear format (write)\n", ast_channel_name(chan));
      ast_free(ls);
      ls = params = NULL;
   }

   return params;
}

static int linear_generator	(	struct ast_channel *	chan,
		void *	data,
		int	len,
		int	samples
	)		`[static]`

Definition at line 821 of file app.c.

References ast_format_set(), AST_FORMAT_SLINEAR, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), ast_write(), ast_frame::datalen, linear_state::fd, ast_frame_subclass::format, ast_frame::frametype, LOG_WARNING, ast_frame::samples, and ast_frame::subclass.

{
   short buf[2048 + AST_FRIENDLY_OFFSET / 2];
   struct linear_state *ls = data;
   struct ast_frame f = {
      .frametype = AST_FRAME_VOICE,
      .data.ptr = buf + AST_FRIENDLY_OFFSET / 2,
      .offset = AST_FRIENDLY_OFFSET,
   };
   int res;

   ast_format_set(&f.subclass.format, AST_FORMAT_SLINEAR, 0);

   len = samples * 2;
   if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
      ast_log(LOG_WARNING, "Can't generate %d bytes of data!\n" , len);
      len = sizeof(buf) - AST_FRIENDLY_OFFSET;
   }
   res = read(ls->fd, buf + AST_FRIENDLY_OFFSET/2, len);
   if (res > 0) {
      f.datalen = res;
      f.samples = res / 2;
      ast_write(chan, &f);
      if (res == len) {
         return 0;
      }
   }
   return -1;
}

static void linear_release	(	struct ast_channel *	chan,
		void *	params
	)		`[static]`

Definition at line 806 of file app.c.

References ast_channel_name(), ast_free, ast_log(), ast_set_write_format(), linear_state::autoclose, linear_state::fd, ast_format::id, LOG_WARNING, and linear_state::origwfmt.

{
   struct linear_state *ls = params;

   if (ls->origwfmt.id && ast_set_write_format(chan, &ls->origwfmt)) {
      ast_log(LOG_WARNING, "Unable to restore channel '%s' to format '%d'\n", ast_channel_name(chan), ls->origwfmt.id);
   }

   if (ls->autoclose) {
      close(ls->fd);
   }

   ast_free(params);
}

static int option_exists	(	struct ast_ivr_menu *	menu,
		char *	option
	)		`[static]`

Definition at line 2110 of file app.c.

References ast_ivr_option::option, and ast_ivr_menu::options.

Referenced by ast_ivr_menu_run_internal().

{
   int x;
   for (x = 0; menu->options[x].option; x++) {
      if (!strcasecmp(menu->options[x].option, option)) {
         return x;
      }
   }
   return -1;
}

static int option_matchmore	(	struct ast_ivr_menu *	menu,
		char *	option
	)		`[static]`

Definition at line 2121 of file app.c.

References ast_ivr_option::option, and ast_ivr_menu::options.

Referenced by read_newoption().

{
   int x;
   for (x = 0; menu->options[x].option; x++) {
      if ((!strncasecmp(menu->options[x].option, option, strlen(option))) &&
            (menu->options[x].option[strlen(option)])) {
         return x;
      }
   }
   return -1;
}

static int parse_options	(	const struct ast_app_option *	options,
		void *	_flags,
		char **	args,
		char *	optstr,
		int	flaglen
	)		`[static]`

Definition at line 2277 of file app.c.

References ast_app_option::arg_index, ast_clear_flag, ast_copy_string(), AST_FLAGS_ALL, ast_log(), ast_set_flag, ast_set_flag64, ast_flags::flags, ast_flags64::flags, LOG_WARNING, paren, and quote().

Referenced by ast_app_parse_options(), and ast_app_parse_options64().

{
   char *s, *arg;
   int curarg, res = 0;
   unsigned int argloc;
   struct ast_flags *flags = _flags;
   struct ast_flags64 *flags64 = _flags;

   if (flaglen == 32) {
      ast_clear_flag(flags, AST_FLAGS_ALL);
   } else {
      flags64->flags = 0;
   }

   if (!optstr) {
      return 0;
   }

   s = optstr;
   while (*s) {
      curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
      argloc = options[curarg].arg_index;
      if (*s == '(') {
         int paren = 1, quote = 0;
         int parsequotes = (s[1] == '"') ? 1 : 0;

         /* Has argument */
         arg = ++s;
         for (; *s; s++) {
            if (*s == '(' && !quote) {
               paren++;
            } else if (*s == ')' && !quote) {
               /* Count parentheses, unless they're within quotes (or backslashed, below) */
               paren--;
            } else if (*s == '"' && parsequotes) {
               /* Leave embedded quotes alone, unless they are the first character */
               quote = quote ? 0 : 1;
               ast_copy_string(s, s + 1, INT_MAX);
               s--;
            } else if (*s == '\\') {
               if (!quote) {
                  /* If a backslash is found outside of quotes, remove it */
                  ast_copy_string(s, s + 1, INT_MAX);
               } else if (quote && s[1] == '"') {
                  /* Backslash for a quote character within quotes, remove the backslash */
                  ast_copy_string(s, s + 1, INT_MAX);
               } else {
                  /* Backslash within quotes, keep both characters */
                  s++;
               }
            }

            if (paren == 0) {
               break;
            }
         }
         /* This will find the closing paren we found above, or none, if the string ended before we found one. */
         if ((s = strchr(s, ')'))) {
            if (argloc) {
               args[argloc - 1] = arg;
            }
            *s++ = '\0';
         } else {
            ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
            res = -1;
            break;
         }
      } else if (argloc) {
         args[argloc - 1] = "";
      }
      if (flaglen == 32) {
         ast_set_flag(flags, options[curarg].flag);
      } else {
         ast_set_flag64(flags64, options[curarg].flag);
      }
   }

   return res;
}

static void path_lock_destroy ( struct path_lock * obj ) [static]

Definition at line 1777 of file app.c.

References free.

Referenced by ast_lock_path_flock(), and ast_unlock_path_flock().

{
   if (obj->fd >= 0) {
      close(obj->fd);
   }
   if (obj->path) {
      free(obj->path);
   }
   free(obj);
}

static int read_newoption	(	struct ast_channel *	chan,
		struct ast_ivr_menu *	menu,
		char *	exten,
		int	maxexten
	)		`[static]`

Definition at line 2133 of file app.c.

References ast_channel_pbx(), ast_waitfordigit(), ast_pbx::dtimeoutms, and option_matchmore().

Referenced by ast_ivr_menu_run_internal().

{
   int res = 0;
   int ms;
   while (option_matchmore(menu, exten)) {
      ms = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->dtimeoutms : 5000;
      if (strlen(exten) >= maxexten - 1) {
         break;
      }
      if ((res = ast_waitfordigit(chan, ms)) < 1) {
         break;
      }
      exten[strlen(exten) + 1] = '\0';
      exten[strlen(exten)] = res;
   }
   return res > 0 ? 0 : res;
}

static void* shaun_of_the_dead ( void * data ) [static]

Definition at line 75 of file app.c.

References ast_free, AST_LIST_EMPTY, AST_LIST_FIRST, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_poll, zombie::pid, and status.

Referenced by ast_safe_fork().

{
   struct zombie *cur;
   int status;
   for (;;) {
      if (!AST_LIST_EMPTY(&zombies)) {
         /* Don't allow cancellation while we have a lock. */
         pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
         AST_LIST_LOCK(&zombies);
         AST_LIST_TRAVERSE_SAFE_BEGIN(&zombies, cur, list) {
            if (waitpid(cur->pid, &status, WNOHANG) != 0) {
               AST_LIST_REMOVE_CURRENT(list);
               ast_free(cur);
            }
         }
         AST_LIST_TRAVERSE_SAFE_END
         AST_LIST_UNLOCK(&zombies);
         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
      }
      pthread_testcancel();
      /* Wait for 60 seconds, without engaging in a busy loop. */
      ast_poll(NULL, 0, AST_LIST_FIRST(&zombies) ? 5000 : 60000);
   }
   return NULL;
}

Variable Documentation

struct ast_app_stack_funcs* app_stack_callbacks [static]

Definition at line 320 of file app.c.

Referenced by ast_app_exec_sub(), ast_app_expand_sub_args(), and ast_install_stack_functions().

int(* ast_copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data) = NULL [static]

Definition at line 401 of file app.c.

Referenced by ast_app_copy_recording_to_vm(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

int(* ast_has_voicemail_func)(const char *mailbox, const char *folder) = NULL [static]

Definition at line 396 of file app.c.

Referenced by ast_app_has_voicemail(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

int(* ast_inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs) = NULL [static]

Definition at line 398 of file app.c.

Referenced by ast_app_inboxcount2(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

int(* ast_inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs) = NULL [static]

Definition at line 397 of file app.c.

Referenced by ast_app_inboxcount(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

enum AST_LOCK_TYPE ast_lock_type = AST_LOCK_TYPE_LOCKFILE [static]

Definition at line 230 of file app.c.

Referenced by ast_lock_path(), ast_set_lock_type(), and ast_unlock_path().

int(* ast_messagecount_func)(const char *context, const char *mailbox, const char *folder) = NULL [static]

Definition at line 400 of file app.c.

Referenced by ast_app_messagecount(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

int(* ast_sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context) = NULL [static]

Definition at line 399 of file app.c.

Referenced by ast_app_sayname(), ast_install_vm_functions(), and ast_uninstall_vm_functions().

const char*(* ast_vm_index_to_foldername_func)(int id) = NULL [static]

Definition at line 402 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_index_to_foldername().

struct ast_vm_mailbox_snapshot*(* ast_vm_mailbox_snapshot_create_func)(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD) = NULL [static]

Definition at line 403 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_mailbox_snapshot_create().

struct ast_vm_mailbox_snapshot*(* ast_vm_mailbox_snapshot_destroy_func)(struct ast_vm_mailbox_snapshot *mailbox_snapshot) = NULL [static]

Definition at line 409 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_mailbox_snapshot_destroy().

int(* ast_vm_msg_forward_func)(const char *from_mailbox, const char *from_context, const char *from_folder, const char *to_mailbox, const char *to_context, const char *to_folder, size_t num_msgs, const char *msg_ids[], int delete_old) = NULL [static]

Definition at line 421 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_msg_forward().

int(* ast_vm_msg_move_func)(const char *mailbox, const char *context, size_t num_msgs, const char *oldfolder, const char *old_msg_ids[], const char *newfolder) = NULL [static]

Definition at line 410 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_msg_move().

int(* ast_vm_msg_play_func)(struct ast_channel *chan, const char *mailbox, const char *context, const char *folder, const char *msg_num, ast_vm_msg_play_cb cb) = NULL [static]

Definition at line 430 of file app.c.

Referenced by ast_install_vm_functions(), ast_uninstall_vm_functions(), and ast_vm_msg_play().