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