When checking for an encoded character, make sure the string isn't blank, first.
[asterisk/asterisk.git] / main / app.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Convenient Application Routines
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #ifdef HAVE_SYS_STAT_H
31 #include <sys/stat.h>
32 #endif
33 #include <regex.h>
34 #include <sys/file.h> /* added this to allow to compile, sorry! */
35 #include <signal.h>
36
37 #include "asterisk/paths.h"     /* use ast_config_AST_DATA_DIR */
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/file.h"
41 #include "asterisk/app.h"
42 #include "asterisk/dsp.h"
43 #include "asterisk/utils.h"
44 #include "asterisk/lock.h"
45 #include "asterisk/indications.h"
46 #include "asterisk/linkedlists.h"
47
48 #define MAX_OTHER_FORMATS 10
49
50 static AST_RWLIST_HEAD_STATIC(groups, ast_group_info);
51
52 /*!
53  * \brief This function presents a dialtone and reads an extension into 'collect' 
54  * which must be a pointer to a **pre-initialized** array of char having a 
55  * size of 'size' suitable for writing to.  It will collect no more than the smaller 
56  * of 'maxlen' or 'size' minus the original strlen() of collect digits.
57  * \param chan struct.
58  * \param context 
59  * \param collect 
60  * \param size 
61  * \param maxlen
62  * \param timeout timeout in seconds
63  *
64  * \return 0 if extension does not exist, 1 if extension exists
65 */
66 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout) 
67 {
68         struct ind_tone_zone_sound *ts;
69         int res = 0, x = 0;
70
71         if (maxlen > size)
72                 maxlen = size;
73         
74         if (!timeout && chan->pbx)
75                 timeout = chan->pbx->dtimeoutms / 1000.0;
76         else if (!timeout)
77                 timeout = 5;
78
79         if ((ts = ast_get_indication_tone(chan->zone, "dial")) && ts->data[0])
80                 res = ast_playtones_start(chan, 0, ts->data, 0);
81         else 
82                 ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
83         
84         for (x = strlen(collect); x < maxlen; ) {
85                 res = ast_waitfordigit(chan, timeout);
86                 if (!ast_ignore_pattern(context, collect))
87                         ast_playtones_stop(chan);
88                 if (res < 1)
89                         break;
90                 if (res == '#')
91                         break;
92                 collect[x++] = res;
93                 if (!ast_matchmore_extension(chan, context, collect, 1, chan->cid.cid_num))
94                         break;
95         }
96
97         if (res >= 0)
98                 res = ast_exists_extension(chan, context, collect, 1, chan->cid.cid_num) ? 1 : 0;
99
100         return res;
101 }
102
103 /*!
104  * \brief ast_app_getdata
105  * \param c The channel to read from
106  * \param prompt The file to stream to the channel
107  * \param s The string to read in to.  Must be at least the size of your length
108  * \param maxlen How many digits to read (maximum)
109  * \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for 
110  *      "ludicrous time" (essentially never times out) */
111 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout)
112 {
113         int res = 0, to, fto;
114         char *front, *filename;
115
116         /* XXX Merge with full version? XXX */
117         
118         if (maxlen)
119                 s[0] = '\0';
120
121         if (!prompt)
122                 prompt = "";
123
124         filename = ast_strdupa(prompt);
125         while ((front = strsep(&filename, "&"))) {
126                 if (!ast_strlen_zero(front)) {
127                         res = ast_streamfile(c, front, c->language);
128                         if (res)
129                                 continue;
130                 }
131                 if (ast_strlen_zero(filename)) {
132                         /* set timeouts for the last prompt */
133                         fto = c->pbx ? c->pbx->rtimeoutms : 6000;
134                         to = c->pbx ? c->pbx->dtimeoutms : 2000;
135
136                         if (timeout > 0) 
137                                 fto = to = timeout;
138                         if (timeout < 0) 
139                                 fto = to = 1000000000;
140                 } else {
141                         /* there is more than one prompt, so
142                            get rid of the long timeout between 
143                            prompts, and make it 50ms */
144                         fto = 50;
145                         to = c->pbx ? c->pbx->dtimeoutms : 2000;
146                 }
147                 res = ast_readstring(c, s, maxlen, to, fto, "#");
148                 if (!ast_strlen_zero(s))
149                         return res;
150         }
151         
152         return res;
153 }
154
155 /* The lock type used by ast_lock_path() / ast_unlock_path() */
156 static enum AST_LOCK_TYPE ast_lock_type = AST_LOCK_TYPE_LOCKFILE;
157
158 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
159 {
160         int res, to = 2000, fto = 6000;
161
162         if (!ast_strlen_zero(prompt)) {
163                 res = ast_streamfile(c, prompt, c->language);
164                 if (res < 0)
165                         return res;
166         }
167         
168         if (timeout > 0) 
169                 fto = to = timeout;
170         if (timeout < 0) 
171                 fto = to = 1000000000;
172
173         res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
174
175         return res;
176 }
177
178 static int (*ast_has_voicemail_func)(const char *mailbox, const char *folder) = NULL;
179 static int (*ast_inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs) = NULL;
180 static int (*ast_inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs) = NULL;
181 static int (*ast_sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context) = NULL;
182 static int (*ast_messagecount_func)(const char *context, const char *mailbox, const char *folder) = NULL;
183
184 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
185                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
186                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
187                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
188                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context))
189 {
190         ast_has_voicemail_func = has_voicemail_func;
191         ast_inboxcount_func = inboxcount_func;
192         ast_inboxcount2_func = inboxcount2_func;
193         ast_messagecount_func = messagecount_func;
194         ast_sayname_func = sayname_func;
195 }
196
197 void ast_uninstall_vm_functions(void)
198 {
199         ast_has_voicemail_func = NULL;
200         ast_inboxcount_func = NULL;
201         ast_inboxcount2_func = NULL;
202         ast_messagecount_func = NULL;
203         ast_sayname_func = NULL;
204 }
205
206 int ast_app_has_voicemail(const char *mailbox, const char *folder)
207 {
208         static int warned = 0;
209         if (ast_has_voicemail_func)
210                 return ast_has_voicemail_func(mailbox, folder);
211
212         if (!warned) {
213                 ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
214                 warned++;
215         }
216         return 0;
217 }
218
219
220 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs)
221 {
222         static int warned = 0;
223         if (newmsgs) {
224                 *newmsgs = 0;
225         }
226         if (oldmsgs) {
227                 *oldmsgs = 0;
228         }
229         if (ast_inboxcount_func) {
230                 return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
231         }
232
233         if (!warned) {
234                 warned++;
235                 ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
236         }
237
238         return 0;
239 }
240
241 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs)
242 {
243         static int warned = 0;
244         if (newmsgs) {
245                 *newmsgs = 0;
246         }
247         if (oldmsgs) {
248                 *oldmsgs = 0;
249         }
250         if (urgentmsgs) {
251                 *urgentmsgs = 0;
252         }
253         if (ast_inboxcount_func) {
254                 return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
255         }
256
257         if (!warned) {
258                 warned++;
259                 ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
260         }
261
262         return 0;
263 }
264
265 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context)
266 {
267         if (ast_sayname_func)
268                 return ast_sayname_func(chan, mailbox, context);
269         return -1;
270 }
271
272 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder)
273 {
274         static int warned = 0;
275         if (ast_messagecount_func)
276                 return ast_messagecount_func(context, mailbox, folder);
277
278         if (!warned) {
279                 warned++;
280                 ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
281         }
282
283         return 0;
284 }
285
286 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration) 
287 {
288         const char *ptr;
289         int res = 0;
290         struct ast_silence_generator *silgen = NULL;
291
292         if (!between)
293                 between = 100;
294
295         if (peer)
296                 res = ast_autoservice_start(peer);
297
298         if (!res)
299                 res = ast_waitfor(chan, 100);
300
301         /* ast_waitfor will return the number of remaining ms on success */
302         if (res < 0) {
303                 if (peer) {
304                         ast_autoservice_stop(peer);
305                 }
306                 return res;
307         }
308
309         if (ast_opt_transmit_silence) {
310                 silgen = ast_channel_start_silence_generator(chan);
311         }
312
313         for (ptr = digits; *ptr; ptr++) {
314                 if (*ptr == 'w') {
315                         /* 'w' -- wait half a second */
316                         if ((res = ast_safe_sleep(chan, 500)))
317                                 break;
318                 } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
319                         /* Character represents valid DTMF */
320                         if (*ptr == 'f' || *ptr == 'F') {
321                                 /* ignore return values if not supported by channel */
322                                 ast_indicate(chan, AST_CONTROL_FLASH);
323                         } else
324                                 ast_senddigit(chan, *ptr, duration);
325                         /* pause between digits */
326                         if ((res = ast_safe_sleep(chan, between)))
327                                 break;
328                 } else
329                         ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
330         }
331
332         if (peer) {
333                 /* Stop autoservice on the peer channel, but don't overwrite any error condition 
334                    that has occurred previously while acting on the primary channel */
335                 if (ast_autoservice_stop(peer) && !res)
336                         res = -1;
337         }
338
339         if (silgen) {
340                 ast_channel_stop_silence_generator(chan, silgen);
341         }
342
343         return res;
344 }
345
346 struct linear_state {
347         int fd;
348         int autoclose;
349         int allowoverride;
350         int origwfmt;
351 };
352
353 static void linear_release(struct ast_channel *chan, void *params)
354 {
355         struct linear_state *ls = params;
356         
357         if (ls->origwfmt && ast_set_write_format(chan, ls->origwfmt))
358                 ast_log(LOG_WARNING, "Unable to restore channel '%s' to format '%d'\n", chan->name, ls->origwfmt);
359
360         if (ls->autoclose)
361                 close(ls->fd);
362
363         ast_free(params);
364 }
365
366 static int linear_generator(struct ast_channel *chan, void *data, int len, int samples)
367 {
368         short buf[2048 + AST_FRIENDLY_OFFSET / 2];
369         struct linear_state *ls = data;
370         struct ast_frame f = {
371                 .frametype = AST_FRAME_VOICE,
372                 .subclass = AST_FORMAT_SLINEAR,
373                 .data.ptr = buf + AST_FRIENDLY_OFFSET / 2,
374                 .offset = AST_FRIENDLY_OFFSET,
375         };
376         int res;
377
378         len = samples * 2;
379         if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
380                 ast_log(LOG_WARNING, "Can't generate %d bytes of data!\n" , len);
381                 len = sizeof(buf) - AST_FRIENDLY_OFFSET;
382         }
383         res = read(ls->fd, buf + AST_FRIENDLY_OFFSET/2, len);
384         if (res > 0) {
385                 f.datalen = res;
386                 f.samples = res / 2;
387                 ast_write(chan, &f);
388                 if (res == len)
389                         return 0;
390         }
391         return -1;
392 }
393
394 static void *linear_alloc(struct ast_channel *chan, void *params)
395 {
396         struct linear_state *ls = params;
397
398         if (!params)
399                 return NULL;
400
401         /* In this case, params is already malloc'd */
402         if (ls->allowoverride)
403                 ast_set_flag(chan, AST_FLAG_WRITE_INT);
404         else
405                 ast_clear_flag(chan, AST_FLAG_WRITE_INT);
406
407         ls->origwfmt = chan->writeformat;
408
409         if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
410                 ast_log(LOG_WARNING, "Unable to set '%s' to linear format (write)\n", chan->name);
411                 ast_free(ls);
412                 ls = params = NULL;
413         }
414
415         return params;
416 }
417
418 static struct ast_generator linearstream = 
419 {
420         alloc: linear_alloc,
421         release: linear_release,
422         generate: linear_generator,
423 };
424
425 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride)
426 {
427         struct linear_state *lin;
428         char tmpf[256];
429         int res = -1;
430         int autoclose = 0;
431         if (fd < 0) {
432                 if (ast_strlen_zero(filename))
433                         return -1;
434                 autoclose = 1;
435                 if (filename[0] == '/') 
436                         ast_copy_string(tmpf, filename, sizeof(tmpf));
437                 else
438                         snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
439                 if ((fd = open(tmpf, O_RDONLY)) < 0) {
440                         ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
441                         return -1;
442                 }
443         }
444         if ((lin = ast_calloc(1, sizeof(*lin)))) {
445                 lin->fd = fd;
446                 lin->allowoverride = allowoverride;
447                 lin->autoclose = autoclose;
448                 res = ast_activate_generator(chan, &linearstream, lin);
449         }
450         return res;
451 }
452
453 int ast_control_streamfile(struct ast_channel *chan, const char *file,
454                            const char *fwd, const char *rev,
455                            const char *stop, const char *suspend,
456                            const char *restart, int skipms, long *offsetms) 
457 {
458         char *breaks = NULL;
459         char *end = NULL;
460         int blen = 2;
461         int res;
462         long pause_restart_point = 0;
463         long offset = 0;
464
465         if (offsetms) 
466                 offset = *offsetms * 8; /* XXX Assumes 8kHz */
467
468         if (stop)
469                 blen += strlen(stop);
470         if (suspend)
471                 blen += strlen(suspend);
472         if (restart)
473                 blen += strlen(restart);
474
475         if (blen > 2) {
476                 breaks = alloca(blen + 1);
477                 breaks[0] = '\0';
478                 if (stop)
479                         strcat(breaks, stop);
480                 if (suspend)
481                         strcat(breaks, suspend);
482                 if (restart)
483                         strcat(breaks, restart);
484         }
485         if (chan->_state != AST_STATE_UP)
486                 res = ast_answer(chan);
487
488         if (file) {
489                 if ((end = strchr(file, ':'))) {
490                         if (!strcasecmp(end, ":end")) {
491                                 *end = '\0';
492                                 end++;
493                         }
494                 }
495         }
496
497         for (;;) {
498                 ast_stopstream(chan);
499                 res = ast_streamfile(chan, file, chan->language);
500                 if (!res) {
501                         if (pause_restart_point) {
502                                 ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
503                                 pause_restart_point = 0;
504                         }
505                         else if (end || offset < 0) {
506                                 if (offset == -8) 
507                                         offset = 0;
508                                 ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
509
510                                 ast_seekstream(chan->stream, offset, SEEK_END);
511                                 end = NULL;
512                                 offset = 0;
513                         } else if (offset) {
514                                 ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
515                                 ast_seekstream(chan->stream, offset, SEEK_SET);
516                                 offset = 0;
517                         };
518                         res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
519                 }
520
521                 if (res < 1)
522                         break;
523
524                 /* We go at next loop if we got the restart char */
525                 if (restart && strchr(restart, res)) {
526                         ast_debug(1, "we'll restart the stream here at next loop\n");
527                         pause_restart_point = 0;
528                         continue;
529                 }
530
531                 if (suspend && strchr(suspend, res)) {
532                         pause_restart_point = ast_tellstream(chan->stream);
533                         for (;;) {
534                                 ast_stopstream(chan);
535                                 res = ast_waitfordigit(chan, 1000);
536                                 if (!res)
537                                         continue;
538                                 else if (res == -1 || strchr(suspend, res) || (stop && strchr(stop, res)))
539                                         break;
540                         }
541                         if (res == *suspend) {
542                                 res = 0;
543                                 continue;
544                         }
545                 }
546
547                 if (res == -1)
548                         break;
549
550                 /* if we get one of our stop chars, return it to the calling function */
551                 if (stop && strchr(stop, res))
552                         break;
553         }
554
555         if (pause_restart_point) {
556                 offset = pause_restart_point;
557         } else {
558                 if (chan->stream) {
559                         offset = ast_tellstream(chan->stream);
560                 } else {
561                         offset = -8;  /* indicate end of file */
562                 }
563         }
564
565         if (offsetms) 
566                 *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
567
568         /* If we are returning a digit cast it as char */
569         if (res > 0 || chan->stream)
570                 res = (char)res;
571
572         ast_stopstream(chan);
573
574         return res;
575 }
576
577 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
578 {
579         int d = 0;
580
581         if ((d = ast_streamfile(chan, fn, chan->language)))
582                 return d;
583
584         d = ast_waitstream(chan, AST_DIGIT_ANY);
585
586         ast_stopstream(chan);
587
588         return d;
589 }
590
591 static int global_silence_threshold = 128;
592 static int global_maxsilence = 0;
593
594 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
595  * \param chan Channel to playback to/record from.
596  * \param playfile Filename of sound to play before recording begins.
597  * \param recordfile Filename to record to.
598  * \param maxtime Maximum length of recording (in milliseconds).
599  * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
600  * \param duration Where to store actual length of the recorded message (in milliseconds).
601  * \param beep Whether to play a beep before starting to record.
602  * \param silencethreshold 
603  * \param maxsilence Length of silence that will end a recording (in milliseconds).
604  * \param path Optional filesystem path to unlock.
605  * \param prepend If true, prepend the recorded audio to an existing file.
606  * \param acceptdtmf DTMF digits that will end the recording.
607  * \param canceldtmf DTMF digits that will cancel the recording.
608  */
609
610 static int __ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int beep, int silencethreshold, int maxsilence, const char *path, int prepend, const char *acceptdtmf, const char *canceldtmf)
611 {
612         int d = 0;
613         char *fmts;
614         char comment[256];
615         int x, fmtcnt = 1, res = -1, outmsg = 0;
616         struct ast_filestream *others[MAX_OTHER_FORMATS];
617         char *sfmt[MAX_OTHER_FORMATS];
618         char *stringp = NULL;
619         time_t start, end;
620         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
621         int totalsilence = 0;
622         int rfmt = 0;
623         struct ast_silence_generator *silgen = NULL;
624         char prependfile[80];
625
626         if (silencethreshold < 0)
627                 silencethreshold = global_silence_threshold;
628
629         if (maxsilence < 0)
630                 maxsilence = global_maxsilence;
631
632         /* barf if no pointer passed to store duration in */
633         if (!duration) {
634                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
635                 return -1;
636         }
637
638         ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
639         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, chan->name);
640
641         if (playfile || beep) {
642                 if (!beep)
643                         d = ast_play_and_wait(chan, playfile);
644                 if (d > -1)
645                         d = ast_stream_and_wait(chan, "beep", "");
646                 if (d < 0)
647                         return -1;
648         }
649
650         if (prepend) {
651                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));  
652                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
653         }
654
655         fmts = ast_strdupa(fmt);
656
657         stringp = fmts;
658         strsep(&stringp, "|");
659         ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
660         sfmt[0] = ast_strdupa(fmts);
661
662         while ((fmt = strsep(&stringp, "|"))) {
663                 if (fmtcnt > MAX_OTHER_FORMATS - 1) {
664                         ast_log(LOG_WARNING, "Please increase MAX_OTHER_FORMATS in app.c\n");
665                         break;
666                 }
667                 sfmt[fmtcnt++] = ast_strdupa(fmt);
668         }
669
670         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
671         for (x = 0; x < fmtcnt; x++) {
672                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, AST_FILE_MODE);
673                 ast_verb(3, "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
674
675                 if (!others[x])
676                         break;
677         }
678
679         if (path)
680                 ast_unlock_path(path);
681
682         if (maxsilence > 0) {
683                 sildet = ast_dsp_new(); /* Create the silence detector */
684                 if (!sildet) {
685                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
686                         return -1;
687                 }
688                 ast_dsp_set_threshold(sildet, silencethreshold);
689                 rfmt = chan->readformat;
690                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
691                 if (res < 0) {
692                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
693                         ast_dsp_free(sildet);
694                         return -1;
695                 }
696         }
697
698         if (!prepend) {
699                 /* Request a video update */
700                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
701
702                 if (ast_opt_transmit_silence)
703                         silgen = ast_channel_start_silence_generator(chan);
704         }
705
706         if (x == fmtcnt) {
707                 /* Loop forever, writing the packets we read to the writer(s), until
708                    we read a digit or get a hangup */
709                 struct ast_frame *f;
710                 for (;;) {
711                         res = ast_waitfor(chan, 2000);
712                         if (!res) {
713                                 ast_debug(1, "One waitfor failed, trying another\n");
714                                 /* Try one more time in case of masq */
715                                 res = ast_waitfor(chan, 2000);
716                                 if (!res) {
717                                         ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
718                                         res = -1;
719                                 }
720                         }
721
722                         if (res < 0) {
723                                 f = NULL;
724                                 break;
725                         }
726                         f = ast_read(chan);
727                         if (!f)
728                                 break;
729                         if (f->frametype == AST_FRAME_VOICE) {
730                                 /* write each format */
731                                 for (x = 0; x < fmtcnt; x++) {
732                                         if (prepend && !others[x])
733                                                 break;
734                                         res = ast_writestream(others[x], f);
735                                 }
736
737                                 /* Silence Detection */
738                                 if (maxsilence > 0) {
739                                         int dspsilence = 0;
740                                         ast_dsp_silence(sildet, f, &dspsilence);
741                                         if (dspsilence)
742                                                 totalsilence = dspsilence;
743                                         else
744                                                 totalsilence = 0;
745
746                                         if (totalsilence > maxsilence) {
747                                                 /* Ended happily with silence */
748                                                 ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", totalsilence/1000);
749                                                 res = 'S';
750                                                 outmsg = 2;
751                                                 break;
752                                         }
753                                 }
754                                 /* Exit on any error */
755                                 if (res) {
756                                         ast_log(LOG_WARNING, "Error writing frame\n");
757                                         break;
758                                 }
759                         } else if (f->frametype == AST_FRAME_VIDEO) {
760                                 /* Write only once */
761                                 ast_writestream(others[0], f);
762                         } else if (f->frametype == AST_FRAME_DTMF) {
763                                 if (prepend) {
764                                 /* stop recording with any digit */
765                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass);
766                                         res = 't';
767                                         outmsg = 2;
768                                         break;
769                                 }
770                                 if (strchr(acceptdtmf, f->subclass)) {
771                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass);
772                                         res = f->subclass;
773                                         outmsg = 2;
774                                         break;
775                                 }
776                                 if (strchr(canceldtmf, f->subclass)) {
777                                         ast_verb(3, "User cancelled message by pressing %c\n", f->subclass);
778                                         res = f->subclass;
779                                         outmsg = 0;
780                                         break;
781                                 }
782                         }
783                         if (maxtime) {
784                                 end = time(NULL);
785                                 if (maxtime < (end - start)) {
786                                         ast_verb(3, "Took too long, cutting it short...\n");
787                                         res = 't';
788                                         outmsg = 2;
789                                         break;
790                                 }
791                         }
792                         ast_frfree(f);
793                 }
794                 if (!f) {
795                         ast_verb(3, "User hung up\n");
796                         res = -1;
797                         outmsg = 1;
798                 } else {
799                         ast_frfree(f);
800                 }
801         } else {
802                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
803         }
804
805         if (!prepend) {
806                 if (silgen)
807                         ast_channel_stop_silence_generator(chan, silgen);
808         }
809
810         /*!\note
811          * Instead of asking how much time passed (end - start), calculate the number
812          * of seconds of audio which actually went into the file.  This fixes a
813          * problem where audio is stopped up on the network and never gets to us.
814          *
815          * Note that we still want to use the number of seconds passed for the max
816          * message, otherwise we could get a situation where this stream is never
817          * closed (which would create a resource leak).
818          */
819         *duration = others[0] ? ast_tellstream(others[0]) / 8000 : 0;
820
821         if (!prepend) {
822                 for (x = 0; x < fmtcnt; x++) {
823                         if (!others[x])
824                                 break;
825                         /*!\note
826                          * If we ended with silence, trim all but the first 200ms of silence
827                          * off the recording.  However, if we ended with '#', we don't want
828                          * to trim ANY part of the recording.
829                          */
830                         if (res > 0 && totalsilence)
831                                 ast_stream_rewind(others[x], totalsilence - 200);
832                         ast_truncstream(others[x]);
833                         ast_closestream(others[x]);
834                 }
835         }
836
837         if (prepend && outmsg) {
838                 struct ast_filestream *realfiles[MAX_OTHER_FORMATS];
839                 struct ast_frame *fr;
840
841                 for (x = 0; x < fmtcnt; x++) {
842                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
843                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
844                         if (!others[x] || !realfiles[x])
845                                 break;
846                         /*!\note Same logic as above. */
847                         if (totalsilence)
848                                 ast_stream_rewind(others[x], totalsilence - 200);
849                         ast_truncstream(others[x]);
850                         /* add the original file too */
851                         while ((fr = ast_readframe(realfiles[x]))) {
852                                 ast_writestream(others[x], fr);
853                                 ast_frfree(fr);
854                         }
855                         ast_closestream(others[x]);
856                         ast_closestream(realfiles[x]);
857                         ast_filerename(prependfile, recordfile, sfmt[x]);
858                         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
859                         ast_filedelete(prependfile, sfmt[x]);
860                 }
861         }
862         if (rfmt && ast_set_read_format(chan, rfmt)) {
863                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
864         }
865         if (outmsg == 2) {
866                 ast_stream_and_wait(chan, "auth-thankyou", "");
867         }
868         if (sildet)
869                 ast_dsp_free(sildet);
870         return res;
871 }
872
873 static char default_acceptdtmf[] = "#";
874 static char default_canceldtmf[] = "";
875
876 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int silencethreshold, int maxsilence, const char *path, const char *acceptdtmf, const char *canceldtmf)
877 {
878         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, S_OR(acceptdtmf, default_acceptdtmf), S_OR(canceldtmf, default_canceldtmf));
879 }
880
881 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int silencethreshold, int maxsilence, const char *path)
882 {
883         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
884 }
885
886 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime, char *fmt, int *duration, int beep, int silencethreshold, int maxsilence)
887 {
888         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
889 }
890
891 /* Channel group core functions */
892
893 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
894 {
895         int res = 0;
896         char tmp[256];
897         char *grp = NULL, *cat = NULL;
898
899         if (!ast_strlen_zero(data)) {
900                 ast_copy_string(tmp, data, sizeof(tmp));
901                 grp = tmp;
902                 cat = strchr(tmp, '@');
903                 if (cat) {
904                         *cat = '\0';
905                         cat++;
906                 }
907         }
908
909         if (!ast_strlen_zero(grp))
910                 ast_copy_string(group, grp, group_max);
911         else
912                 *group = '\0';
913
914         if (!ast_strlen_zero(cat))
915                 ast_copy_string(category, cat, category_max);
916
917         return res;
918 }
919
920 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
921 {
922         int res = 0;
923         char group[80] = "", category[80] = "";
924         struct ast_group_info *gi = NULL;
925         size_t len = 0;
926         
927         if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category)))
928                 return -1;
929         
930         /* Calculate memory we will need if this is new */
931         len = sizeof(*gi) + strlen(group) + 1;
932         if (!ast_strlen_zero(category))
933                 len += strlen(category) + 1;
934         
935         AST_RWLIST_WRLOCK(&groups);
936         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
937                 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
938                         AST_RWLIST_REMOVE_CURRENT(list);
939                         free(gi);
940                         break;
941                 }
942         }
943         AST_RWLIST_TRAVERSE_SAFE_END;
944
945         if (ast_strlen_zero(group)) {
946                 /* Enable unsetting the group */
947         } else if ((gi = calloc(1, len))) {
948                 gi->chan = chan;
949                 gi->group = (char *) gi + sizeof(*gi);
950                 strcpy(gi->group, group);
951                 if (!ast_strlen_zero(category)) {
952                         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
953                         strcpy(gi->category, category);
954                 }
955                 AST_RWLIST_INSERT_TAIL(&groups, gi, list);
956         } else {
957                 res = -1;
958         }
959         
960         AST_RWLIST_UNLOCK(&groups);
961         
962         return res;
963 }
964
965 int ast_app_group_get_count(const char *group, const char *category)
966 {
967         struct ast_group_info *gi = NULL;
968         int count = 0;
969
970         if (ast_strlen_zero(group))
971                 return 0;
972         
973         AST_RWLIST_RDLOCK(&groups);
974         AST_RWLIST_TRAVERSE(&groups, gi, list) {
975                 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
976                         count++;
977         }
978         AST_RWLIST_UNLOCK(&groups);
979
980         return count;
981 }
982
983 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
984 {
985         struct ast_group_info *gi = NULL;
986         regex_t regexbuf;
987         int count = 0;
988
989         if (ast_strlen_zero(groupmatch))
990                 return 0;
991
992         /* if regex compilation fails, return zero matches */
993         if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
994                 return 0;
995
996         AST_RWLIST_RDLOCK(&groups);
997         AST_RWLIST_TRAVERSE(&groups, gi, list) {
998                 if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
999                         count++;
1000         }
1001         AST_RWLIST_UNLOCK(&groups);
1002
1003         regfree(&regexbuf);
1004
1005         return count;
1006 }
1007
1008 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
1009 {
1010         struct ast_group_info *gi = NULL;
1011
1012         AST_RWLIST_WRLOCK(&groups);
1013         AST_RWLIST_TRAVERSE(&groups, gi, list) {
1014                 if (gi->chan == old)
1015                         gi->chan = new;
1016         }
1017         AST_RWLIST_UNLOCK(&groups);
1018
1019         return 0;
1020 }
1021
1022 int ast_app_group_discard(struct ast_channel *chan)
1023 {
1024         struct ast_group_info *gi = NULL;
1025         
1026         AST_RWLIST_WRLOCK(&groups);
1027         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
1028                 if (gi->chan == chan) {
1029                         AST_RWLIST_REMOVE_CURRENT(list);
1030                         ast_free(gi);
1031                 }
1032         }
1033         AST_RWLIST_TRAVERSE_SAFE_END;
1034         AST_RWLIST_UNLOCK(&groups);
1035         
1036         return 0;
1037 }
1038
1039 int ast_app_group_list_wrlock(void)
1040 {
1041         return AST_RWLIST_WRLOCK(&groups);
1042 }
1043
1044 int ast_app_group_list_rdlock(void)
1045 {
1046         return AST_RWLIST_RDLOCK(&groups);
1047 }
1048
1049 struct ast_group_info *ast_app_group_list_head(void)
1050 {
1051         return AST_RWLIST_FIRST(&groups);
1052 }
1053
1054 int ast_app_group_list_unlock(void)
1055 {
1056         return AST_RWLIST_UNLOCK(&groups);
1057 }
1058
1059 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
1060 {
1061         int argc;
1062         char *scan, *wasdelim = NULL;
1063         int paren = 0, quote = 0;
1064
1065         if (!buf || !array || !arraylen)
1066                 return 0;
1067
1068         memset(array, 0, arraylen * sizeof(*array));
1069
1070         scan = buf;
1071
1072         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1073                 array[argc] = scan;
1074                 for (; *scan; scan++) {
1075                         if (*scan == '(')
1076                                 paren++;
1077                         else if (*scan == ')') {
1078                                 if (paren)
1079                                         paren--;
1080                         } else if (*scan == '"' && delim != '"') {
1081                                 quote = quote ? 0 : 1;
1082                                 /* Remove quote character from argument */
1083                                 memmove(scan, scan + 1, strlen(scan));
1084                                 scan--;
1085                         } else if (*scan == '\\') {
1086                                 /* Literal character, don't parse */
1087                                 memmove(scan, scan + 1, strlen(scan));
1088                         } else if ((*scan == delim) && !paren && !quote) {
1089                                 wasdelim = scan;
1090                                 *scan++ = '\0';
1091                                 break;
1092                         }
1093                 }
1094         }
1095
1096         /* If the last character in the original string was the delimiter, then
1097          * there is one additional argument. */
1098         if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
1099                 array[argc++] = scan;
1100         }
1101
1102         return argc;
1103 }
1104
1105 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1106 {
1107         char *s;
1108         char *fs;
1109         int res;
1110         int fd;
1111         int lp = strlen(path);
1112         time_t start;
1113
1114         s = alloca(lp + 10); 
1115         fs = alloca(lp + 20);
1116
1117         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
1118         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
1119         if (fd < 0) {
1120                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
1121                 return AST_LOCK_PATH_NOT_FOUND;
1122         }
1123         close(fd);
1124
1125         snprintf(s, strlen(path) + 9, "%s/.lock", path);
1126         start = time(NULL);
1127         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
1128                 usleep(1);
1129
1130         unlink(fs);
1131
1132         if (res) {
1133                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
1134                 return AST_LOCK_TIMEOUT;
1135         } else {
1136                 ast_debug(1, "Locked path '%s'\n", path);
1137                 return AST_LOCK_SUCCESS;
1138         }
1139 }
1140
1141 static int ast_unlock_path_lockfile(const char *path)
1142 {
1143         char *s;
1144         int res;
1145
1146         s = alloca(strlen(path) + 10);
1147
1148         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
1149
1150         if ((res = unlink(s)))
1151                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
1152         else {
1153                 ast_debug(1, "Unlocked path '%s'\n", path);
1154         }
1155
1156         return res;
1157 }
1158
1159 struct path_lock {
1160         AST_LIST_ENTRY(path_lock) le;
1161         int fd;
1162         char *path;
1163 };
1164
1165 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
1166
1167 static void path_lock_destroy(struct path_lock *obj)
1168 {
1169         if (obj->fd >= 0)
1170                 close(obj->fd);
1171         if (obj->path)
1172                 free(obj->path);
1173         free(obj);
1174 }
1175
1176 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
1177 {
1178         char *fs;
1179         int res;
1180         int fd;
1181         time_t start;
1182         struct path_lock *pl;
1183         struct stat st, ost;
1184
1185         fs = alloca(strlen(path) + 20);
1186
1187         snprintf(fs, strlen(path) + 19, "%s/lock", path);
1188         if (lstat(fs, &st) == 0) {
1189                 if ((st.st_mode & S_IFMT) == S_IFLNK) {
1190                         ast_log(LOG_WARNING, "Unable to create lock file "
1191                                         "'%s': it's already a symbolic link\n",
1192                                         fs);
1193                         return AST_LOCK_FAILURE;
1194                 }
1195                 if (st.st_nlink > 1) {
1196                         ast_log(LOG_WARNING, "Unable to create lock file "
1197                                         "'%s': %u hard links exist\n",
1198                                         fs, (unsigned int) st.st_nlink);
1199                         return AST_LOCK_FAILURE;
1200                 }
1201         }
1202         fd = open(fs, O_WRONLY | O_CREAT, 0600);
1203         if (fd < 0) {
1204                 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
1205                                 fs, strerror(errno));
1206                 return AST_LOCK_PATH_NOT_FOUND;
1207         }
1208         pl = ast_calloc(1, sizeof(*pl));
1209         if (!pl) {
1210                 /* We don't unlink the lock file here, on the possibility that
1211                  * someone else created it - better to leave a little mess
1212                  * than create a big one by destroying someone else's lock
1213                  * and causing something to be corrupted.
1214                  */
1215                 close(fd);
1216                 return AST_LOCK_FAILURE;
1217         }
1218         pl->fd = fd;
1219         pl->path = strdup(path);
1220
1221         time(&start);
1222         while ((
1223                 #ifdef SOLARIS
1224                 (res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd, F_GETFL) | O_NONBLOCK)) < 0) &&
1225                 #else
1226                 (res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
1227                 #endif
1228                         (errno == EWOULDBLOCK) && 
1229                         (time(NULL) - start < 5))
1230                 usleep(1000);
1231         if (res) {
1232                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
1233                                 path, strerror(errno));
1234                 /* No unlinking of lock done, since we tried and failed to
1235                  * flock() it.
1236                  */
1237                 path_lock_destroy(pl);
1238                 return AST_LOCK_TIMEOUT;
1239         }
1240
1241         /* Check for the race where the file is recreated or deleted out from
1242          * underneath us.
1243          */
1244         if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
1245                         st.st_dev != ost.st_dev &&
1246                         st.st_ino != ost.st_ino) {
1247                 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
1248                                 "file changed underneath us\n", fs);
1249                 path_lock_destroy(pl);
1250                 return AST_LOCK_FAILURE;
1251         }
1252
1253         /* Success: file created, flocked, and is the one we started with */
1254         AST_LIST_LOCK(&path_lock_list);
1255         AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
1256         AST_LIST_UNLOCK(&path_lock_list);
1257
1258         ast_debug(1, "Locked path '%s'\n", path);
1259
1260         return AST_LOCK_SUCCESS;
1261 }
1262
1263 static int ast_unlock_path_flock(const char *path)
1264 {
1265         char *s;
1266         struct path_lock *p;
1267
1268         s = alloca(strlen(path) + 20);
1269
1270         AST_LIST_LOCK(&path_lock_list);
1271         AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
1272                 if (!strcmp(p->path, path)) {
1273                         AST_LIST_REMOVE_CURRENT(le);
1274                         break;
1275                 }
1276         }
1277         AST_LIST_TRAVERSE_SAFE_END;
1278         AST_LIST_UNLOCK(&path_lock_list);
1279
1280         if (p) {
1281                 snprintf(s, strlen(path) + 19, "%s/lock", path);
1282                 unlink(s);
1283                 path_lock_destroy(p);
1284                 ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
1285         } else
1286                 ast_log(LOG_DEBUG, "Failed to unlock path '%s': "
1287                                 "lock not found\n", path);
1288
1289         return 0;
1290 }
1291
1292 void ast_set_lock_type(enum AST_LOCK_TYPE type)
1293 {
1294         ast_lock_type = type;
1295 }
1296
1297 enum AST_LOCK_RESULT ast_lock_path(const char *path)
1298 {
1299         enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
1300
1301         switch (ast_lock_type) {
1302         case AST_LOCK_TYPE_LOCKFILE:
1303                 r = ast_lock_path_lockfile(path);
1304                 break;
1305         case AST_LOCK_TYPE_FLOCK:
1306                 r = ast_lock_path_flock(path);
1307                 break;
1308         }
1309
1310         return r;
1311 }
1312
1313 int ast_unlock_path(const char *path)
1314 {
1315         int r = 0;
1316
1317         switch (ast_lock_type) {
1318         case AST_LOCK_TYPE_LOCKFILE:
1319                 r = ast_unlock_path_lockfile(path);
1320                 break;
1321         case AST_LOCK_TYPE_FLOCK:
1322                 r = ast_unlock_path_flock(path);
1323                 break;
1324         }
1325
1326         return r;
1327 }
1328
1329 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path) 
1330 {
1331         int silencethreshold; 
1332         int maxsilence = 0;
1333         int res = 0;
1334         int cmd = 0;
1335         int max_attempts = 3;
1336         int attempts = 0;
1337         int recorded = 0;
1338         int message_exists = 0;
1339         /* Note that urgent and private are for flagging messages as such in the future */
1340
1341         /* barf if no pointer passed to store duration in */
1342         if (!duration) {
1343                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
1344                 return -1;
1345         }
1346
1347         cmd = '3';       /* Want to start by recording */
1348
1349         silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
1350
1351         while ((cmd >= 0) && (cmd != 't')) {
1352                 switch (cmd) {
1353                 case '1':
1354                         if (!message_exists) {
1355                                 /* In this case, 1 is to record a message */
1356                                 cmd = '3';
1357                                 break;
1358                         } else {
1359                                 ast_stream_and_wait(chan, "vm-msgsaved", "");
1360                                 cmd = 't';
1361                                 return res;
1362                         }
1363                 case '2':
1364                         /* Review */
1365                         ast_verb(3, "Reviewing the recording\n");
1366                         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
1367                         break;
1368                 case '3':
1369                         message_exists = 0;
1370                         /* Record */
1371                         if (recorded == 1)
1372                                 ast_verb(3, "Re-recording\n");
1373                         else    
1374                                 ast_verb(3, "Recording\n");
1375                         recorded = 1;
1376                         cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
1377                         if (cmd == -1) {
1378                         /* User has hung up, no options to give */
1379                                 return cmd;
1380                         }
1381                         if (cmd == '0') {
1382                                 break;
1383                         } else if (cmd == '*') {
1384                                 break;
1385                         } 
1386                         else {
1387                                 /* If all is well, a message exists */
1388                                 message_exists = 1;
1389                                 cmd = 0;
1390                         }
1391                         break;
1392                 case '4':
1393                 case '5':
1394                 case '6':
1395                 case '7':
1396                 case '8':
1397                 case '9':
1398                 case '*':
1399                 case '#':
1400                         cmd = ast_play_and_wait(chan, "vm-sorry");
1401                         break;
1402                 default:
1403                         if (message_exists) {
1404                                 cmd = ast_play_and_wait(chan, "vm-review");
1405                         }
1406                         else {
1407                                 cmd = ast_play_and_wait(chan, "vm-torerecord");
1408                                 if (!cmd)
1409                                         cmd = ast_waitfordigit(chan, 600);
1410                         }
1411                         
1412                         if (!cmd)
1413                                 cmd = ast_waitfordigit(chan, 6000);
1414                         if (!cmd) {
1415                                 attempts++;
1416                         }
1417                         if (attempts > max_attempts) {
1418                                 cmd = 't';
1419                         }
1420                 }
1421         }
1422         if (cmd == 't')
1423                 cmd = 0;
1424         return cmd;
1425 }
1426
1427 #define RES_UPONE (1 << 16)
1428 #define RES_EXIT  (1 << 17)
1429 #define RES_REPEAT (1 << 18)
1430 #define RES_RESTART ((1 << 19) | RES_REPEAT)
1431
1432 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
1433
1434 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
1435 {
1436         int res;
1437         int (*ivr_func)(struct ast_channel *, void *);
1438         char *c;
1439         char *n;
1440         
1441         switch (option->action) {
1442         case AST_ACTION_UPONE:
1443                 return RES_UPONE;
1444         case AST_ACTION_EXIT:
1445                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
1446         case AST_ACTION_REPEAT:
1447                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
1448         case AST_ACTION_RESTART:
1449                 return RES_RESTART ;
1450         case AST_ACTION_NOOP:
1451                 return 0;
1452         case AST_ACTION_BACKGROUND:
1453                 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
1454                 if (res < 0) {
1455                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1456                         res = 0;
1457                 }
1458                 return res;
1459         case AST_ACTION_PLAYBACK:
1460                 res = ast_stream_and_wait(chan, (char *)option->adata, "");
1461                 if (res < 0) {
1462                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1463                         res = 0;
1464                 }
1465                 return res;
1466         case AST_ACTION_MENU:
1467                 res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata);
1468                 /* Do not pass entry errors back up, treat as though it was an "UPONE" */
1469                 if (res == -2)
1470                         res = 0;
1471                 return res;
1472         case AST_ACTION_WAITOPTION:
1473                 res = ast_waitfordigit(chan, chan->pbx ? chan->pbx->rtimeoutms : 10000);
1474                 if (!res)
1475                         return 't';
1476                 return res;
1477         case AST_ACTION_CALLBACK:
1478                 ivr_func = option->adata;
1479                 res = ivr_func(chan, cbdata);
1480                 return res;
1481         case AST_ACTION_TRANSFER:
1482                 res = ast_parseable_goto(chan, option->adata);
1483                 return 0;
1484         case AST_ACTION_PLAYLIST:
1485         case AST_ACTION_BACKLIST:
1486                 res = 0;
1487                 c = ast_strdupa(option->adata);
1488                 while ((n = strsep(&c, ";"))) {
1489                         if ((res = ast_stream_and_wait(chan, n,
1490                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : "")))
1491                                 break;
1492                 }
1493                 ast_stopstream(chan);
1494                 return res;
1495         default:
1496                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
1497                 return 0;
1498         };
1499         return -1;
1500 }
1501
1502 static int option_exists(struct ast_ivr_menu *menu, char *option)
1503 {
1504         int x;
1505         for (x = 0; menu->options[x].option; x++)
1506                 if (!strcasecmp(menu->options[x].option, option))
1507                         return x;
1508         return -1;
1509 }
1510
1511 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
1512 {
1513         int x;
1514         for (x = 0; menu->options[x].option; x++)
1515                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) && 
1516                                 (menu->options[x].option[strlen(option)]))
1517                         return x;
1518         return -1;
1519 }
1520
1521 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
1522 {
1523         int res = 0;
1524         int ms;
1525         while (option_matchmore(menu, exten)) {
1526                 ms = chan->pbx ? chan->pbx->dtimeoutms : 5000;
1527                 if (strlen(exten) >= maxexten - 1) 
1528                         break;
1529                 res = ast_waitfordigit(chan, ms);
1530                 if (res < 1)
1531                         break;
1532                 exten[strlen(exten) + 1] = '\0';
1533                 exten[strlen(exten)] = res;
1534         }
1535         return res > 0 ? 0 : res;
1536 }
1537
1538 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1539 {
1540         /* Execute an IVR menu structure */
1541         int res = 0;
1542         int pos = 0;
1543         int retries = 0;
1544         char exten[AST_MAX_EXTENSION] = "s";
1545         if (option_exists(menu, "s") < 0) {
1546                 strcpy(exten, "g");
1547                 if (option_exists(menu, "g") < 0) {
1548                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
1549                         return -1;
1550                 }
1551         }
1552         while (!res) {
1553                 while (menu->options[pos].option) {
1554                         if (!strcasecmp(menu->options[pos].option, exten)) {
1555                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
1556                                 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
1557                                 if (res < 0)
1558                                         break;
1559                                 else if (res & RES_UPONE)
1560                                         return 0;
1561                                 else if (res & RES_EXIT)
1562                                         return res;
1563                                 else if (res & RES_REPEAT) {
1564                                         int maxretries = res & 0xffff;
1565                                         if ((res & RES_RESTART) == RES_RESTART) {
1566                                                 retries = 0;
1567                                         } else
1568                                                 retries++;
1569                                         if (!maxretries)
1570                                                 maxretries = 3;
1571                                         if ((maxretries > 0) && (retries >= maxretries)) {
1572                                                 ast_debug(1, "Max retries %d exceeded\n", maxretries);
1573                                                 return -2;
1574                                         } else {
1575                                                 if (option_exists(menu, "g") > -1) 
1576                                                         strcpy(exten, "g");
1577                                                 else if (option_exists(menu, "s") > -1)
1578                                                         strcpy(exten, "s");
1579                                         }
1580                                         pos = 0;
1581                                         continue;
1582                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
1583                                         ast_debug(1, "Got start of extension, %c\n", res);
1584                                         exten[1] = '\0';
1585                                         exten[0] = res;
1586                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten))))
1587                                                 break;
1588                                         if (option_exists(menu, exten) < 0) {
1589                                                 if (option_exists(menu, "i")) {
1590                                                         ast_debug(1, "Invalid extension entered, going to 'i'!\n");
1591                                                         strcpy(exten, "i");
1592                                                         pos = 0;
1593                                                         continue;
1594                                                 } else {
1595                                                         ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
1596                                                         res = -2;
1597                                                         break;
1598                                                 }
1599                                         } else {
1600                                                 ast_debug(1, "New existing extension: %s\n", exten);
1601                                                 pos = 0;
1602                                                 continue;
1603                                         }
1604                                 }
1605                         }
1606                         pos++;
1607                 }
1608                 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
1609                 pos = 0;
1610                 if (!strcasecmp(exten, "s"))
1611                         strcpy(exten, "g");
1612                 else
1613                         break;
1614         }
1615         return res;
1616 }
1617
1618 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1619 {
1620         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
1621         /* Hide internal coding */
1622         return res > 0 ? 0 : res;
1623 }
1624         
1625 char *ast_read_textfile(const char *filename)
1626 {
1627         int fd, count = 0, res;
1628         char *output = NULL;
1629         struct stat filesize;
1630
1631         if (stat(filename, &filesize) == -1) {
1632                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
1633                 return NULL;
1634         }
1635
1636         count = filesize.st_size + 1;
1637
1638         if ((fd = open(filename, O_RDONLY)) < 0) {
1639                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
1640                 return NULL;
1641         }
1642
1643         if ((output = ast_malloc(count))) {
1644                 res = read(fd, output, count - 1);
1645                 if (res == count - 1) {
1646                         output[res] = '\0';
1647                 } else {
1648                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
1649                         ast_free(output);
1650                         output = NULL;
1651                 }
1652         }
1653
1654         close(fd);
1655
1656         return output;
1657 }
1658
1659 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
1660 {
1661         char *s, *arg;
1662         int curarg, res = 0;
1663         unsigned int argloc;
1664
1665         ast_clear_flag(flags, AST_FLAGS_ALL);
1666
1667         if (!optstr)
1668                 return 0;
1669
1670         s = optstr;
1671         while (*s) {
1672                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1673                 argloc = options[curarg].arg_index;
1674                 if (*s == '(') {
1675                         /* Has argument */
1676                         arg = ++s;
1677                         if ((s = strchr(s, ')'))) {
1678                                 if (argloc)
1679                                         args[argloc - 1] = arg;
1680                                 *s++ = '\0';
1681                         } else {
1682                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1683                                 res = -1;
1684                                 break;
1685                         }
1686                 } else if (argloc) {
1687                         args[argloc - 1] = "";
1688                 }
1689                 ast_set_flag(flags, options[curarg].flag);
1690         }
1691
1692         return res;
1693 }
1694
1695 /* the following function will probably only be used in app_dial, until app_dial is reorganized to
1696    better handle the large number of options it provides. After it is, you need to get rid of this variant 
1697    -- unless, of course, someone else digs up some use for large flag fields. */
1698
1699 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
1700 {
1701         char *s, *arg;
1702         int curarg, res = 0;
1703         unsigned int argloc;
1704
1705         flags->flags = 0;
1706         
1707         if (!optstr)
1708                 return 0;
1709
1710         s = optstr;
1711         while (*s) {
1712                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1713                 ast_set_flag64(flags, options[curarg].flag);
1714                 argloc = options[curarg].arg_index;
1715                 if (*s == '(') {
1716                         /* Has argument */
1717                         arg = ++s;
1718                         if ((s = strchr(s, ')'))) {
1719                                 if (argloc)
1720                                         args[argloc - 1] = arg;
1721                                 *s++ = '\0';
1722                         } else {
1723                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1724                                 res = -1;
1725                                 break;
1726                         }
1727                 } else if (argloc) {
1728                         args[argloc - 1] = NULL;
1729                 }
1730         }
1731
1732         return res;
1733 }
1734
1735 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len)
1736 {
1737         unsigned int i, found = 0;
1738         for (i = 32; i < 128 && found < len; i++) {
1739                 if (ast_test_flag64(flags, options[i].flag)) {
1740                         buf[found++] = i;
1741                 }
1742         }
1743         buf[found] = '\0';
1744 }
1745
1746 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed)
1747 {
1748         int i;
1749         *consumed = 1;
1750         *result = 0;
1751         if (ast_strlen_zero(stream)) {
1752                 *consumed = 0;
1753                 return -1;
1754         }
1755
1756         if (*stream == '\\') {
1757                 *consumed = 2;
1758                 switch (*(stream + 1)) {
1759                 case 'n':
1760                         *result = '\n';
1761                         break;
1762                 case 'r':
1763                         *result = '\r';
1764                         break;
1765                 case 't':
1766                         *result = '\t';
1767                         break;
1768                 case 'x':
1769                         /* Hexadecimal */
1770                         if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
1771                                 *consumed = 3;
1772                                 if (*(stream + 2) <= '9')
1773                                         *result = *(stream + 2) - '0';
1774                                 else if (*(stream + 2) <= 'F')
1775                                         *result = *(stream + 2) - 'A' + 10;
1776                                 else
1777                                         *result = *(stream + 2) - 'a' + 10;
1778                         } else {
1779                                 ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
1780                                 return -1;
1781                         }
1782
1783                         if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
1784                                 *consumed = 4;
1785                                 *result <<= 4;
1786                                 if (*(stream + 3) <= '9')
1787                                         *result += *(stream + 3) - '0';
1788                                 else if (*(stream + 3) <= 'F')
1789                                         *result += *(stream + 3) - 'A' + 10;
1790                                 else
1791                                         *result += *(stream + 3) - 'a' + 10;
1792                         }
1793                         break;
1794                 case '0':
1795                         /* Octal */
1796                         *consumed = 2;
1797                         for (i = 2; ; i++) {
1798                                 if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
1799                                         (*consumed)++;
1800                                         ast_debug(5, "result was %d, ", *result);
1801                                         *result <<= 3;
1802                                         *result += *(stream + i) - '0';
1803                                         ast_debug(5, "is now %d\n", *result);
1804                                 } else
1805                                         break;
1806                         }
1807                         break;
1808                 default:
1809                         *result = *(stream + 1);
1810                 }
1811         } else {
1812                 *result = *stream;
1813                 *consumed = 1;
1814         }
1815         return 0;
1816 }
1817
1818 void ast_close_fds_above_n(int n)
1819 {
1820         int x, null;
1821         null = open("/dev/null", O_RDONLY);
1822         for (x = n + 1; x <= (null >= 8192 ? null : 8192); x++) {
1823                 if (x != null) {
1824                         /* Side effect of dup2 is that it closes any existing fd without error.
1825                          * This prevents valgrind and other debugging tools from sending up
1826                          * false error reports. */
1827                         dup2(null, x);
1828                         close(x);
1829                 }
1830         }
1831         close(null);
1832 }
1833
1834 int ast_safe_fork(int stop_reaper)
1835 {
1836         sigset_t signal_set, old_set;
1837         int pid;
1838
1839         /* Don't let the default signal handler for children reap our status */
1840         if (stop_reaper) {
1841                 ast_replace_sigchld();
1842         }
1843
1844         sigfillset(&signal_set);
1845         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
1846
1847         pid = fork();
1848
1849         if (pid != 0) {
1850                 /* Fork failed or parent */
1851                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
1852                 return pid;
1853         } else {
1854                 /* Child */
1855
1856                 /* Before we unblock our signals, return our trapped signals back to the defaults */
1857                 signal(SIGHUP, SIG_DFL);
1858                 signal(SIGCHLD, SIG_DFL);
1859                 signal(SIGINT, SIG_DFL);
1860                 signal(SIGURG, SIG_DFL);
1861                 signal(SIGTERM, SIG_DFL);
1862                 signal(SIGPIPE, SIG_DFL);
1863                 signal(SIGXFSZ, SIG_DFL);
1864
1865                 /* unblock important signal handlers */
1866                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
1867                         ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
1868                         _exit(1);
1869                 }
1870
1871                 return pid;
1872         }
1873 }
1874
1875 void ast_safe_fork_cleanup(void)
1876 {
1877         ast_unreplace_sigchld();
1878 }
1879