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