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