minor spelling fixes in a comment
[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         ast_stopstream(chan);
522
523         return res;
524 }
525
526 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
527 {
528         int d = 0;
529
530         if ((d = ast_streamfile(chan, fn, chan->language)))
531                 return d;
532
533         d = ast_waitstream(chan, AST_DIGIT_ANY);
534
535         ast_stopstream(chan);
536
537         return d;
538 }
539
540 static int global_silence_threshold = 128;
541 static int global_maxsilence = 0;
542
543 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
544  * \param chan Channel to playback to/record from.
545  * \param playfile Filename of sound to play before recording begins.
546  * \param recordfile Filename to record to.
547  * \param maxtime Maximum length of recording (in milliseconds).
548  * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
549  * \param duration Where to store actual length of the recorded message (in milliseconds).
550  * \param beep Whether to play a beep before starting to record.
551  * \param silencethreshold 
552  * \param maxsilence Length of silence that will end a recording (in milliseconds).
553  * \param path Optional filesystem path to unlock.
554  * \param prepend If true, prepend the recorded audio to an existing file.
555  * \param acceptdtmf DTMF digits that will end the recording.
556  * \param canceldtmf DTMF digits that will cancel the recording.
557  */
558
559 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)
560 {
561         int d = 0;
562         char *fmts;
563         char comment[256];
564         int x, fmtcnt = 1, res = -1, outmsg = 0;
565         struct ast_filestream *others[MAX_OTHER_FORMATS];
566         char *sfmt[MAX_OTHER_FORMATS];
567         char *stringp = NULL;
568         time_t start, end;
569         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
570         int totalsilence = 0;
571         int rfmt = 0;
572         struct ast_silence_generator *silgen = NULL;
573         char prependfile[80];
574
575         if (silencethreshold < 0)
576                 silencethreshold = global_silence_threshold;
577
578         if (maxsilence < 0)
579                 maxsilence = global_maxsilence;
580
581         /* barf if no pointer passed to store duration in */
582         if (!duration) {
583                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
584                 return -1;
585         }
586
587         ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
588         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, chan->name);
589
590         if (playfile || beep) {
591                 if (!beep)
592                         d = ast_play_and_wait(chan, playfile);
593                 if (d > -1)
594                         d = ast_stream_and_wait(chan, "beep", "");
595                 if (d < 0)
596                         return -1;
597         }
598
599         if (prepend) {
600                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));  
601                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
602         }
603
604         fmts = ast_strdupa(fmt);
605
606         stringp = fmts;
607         strsep(&stringp, "|");
608         ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
609         sfmt[0] = ast_strdupa(fmts);
610
611         while ((fmt = strsep(&stringp, "|"))) {
612                 if (fmtcnt > MAX_OTHER_FORMATS - 1) {
613                         ast_log(LOG_WARNING, "Please increase MAX_OTHER_FORMATS in app.c\n");
614                         break;
615                 }
616                 sfmt[fmtcnt++] = ast_strdupa(fmt);
617         }
618
619         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
620         for (x = 0; x < fmtcnt; x++) {
621                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, AST_FILE_MODE);
622                 ast_verb(3, "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
623
624                 if (!others[x])
625                         break;
626         }
627
628         if (path)
629                 ast_unlock_path(path);
630
631         if (maxsilence > 0) {
632                 sildet = ast_dsp_new(); /* Create the silence detector */
633                 if (!sildet) {
634                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
635                         return -1;
636                 }
637                 ast_dsp_set_threshold(sildet, silencethreshold);
638                 rfmt = chan->readformat;
639                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
640                 if (res < 0) {
641                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
642                         ast_dsp_free(sildet);
643                         return -1;
644                 }
645         }
646
647         if (!prepend) {
648                 /* Request a video update */
649                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
650
651                 if (ast_opt_transmit_silence)
652                         silgen = ast_channel_start_silence_generator(chan);
653         }
654
655         if (x == fmtcnt) {
656                 /* Loop forever, writing the packets we read to the writer(s), until
657                    we read a digit or get a hangup */
658                 struct ast_frame *f;
659                 for (;;) {
660                         res = ast_waitfor(chan, 2000);
661                         if (!res) {
662                                 ast_debug(1, "One waitfor failed, trying another\n");
663                                 /* Try one more time in case of masq */
664                                 res = ast_waitfor(chan, 2000);
665                                 if (!res) {
666                                         ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
667                                         res = -1;
668                                 }
669                         }
670
671                         if (res < 0) {
672                                 f = NULL;
673                                 break;
674                         }
675                         f = ast_read(chan);
676                         if (!f)
677                                 break;
678                         if (f->frametype == AST_FRAME_VOICE) {
679                                 /* write each format */
680                                 for (x = 0; x < fmtcnt; x++) {
681                                         if (prepend && !others[x])
682                                                 break;
683                                         res = ast_writestream(others[x], f);
684                                 }
685
686                                 /* Silence Detection */
687                                 if (maxsilence > 0) {
688                                         int dspsilence = 0;
689                                         ast_dsp_silence(sildet, f, &dspsilence);
690                                         if (dspsilence)
691                                                 totalsilence = dspsilence;
692                                         else
693                                                 totalsilence = 0;
694
695                                         if (totalsilence > maxsilence) {
696                                                 /* Ended happily with silence */
697                                                 ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", totalsilence/1000);
698                                                 res = 'S';
699                                                 outmsg = 2;
700                                                 break;
701                                         }
702                                 }
703                                 /* Exit on any error */
704                                 if (res) {
705                                         ast_log(LOG_WARNING, "Error writing frame\n");
706                                         break;
707                                 }
708                         } else if (f->frametype == AST_FRAME_VIDEO) {
709                                 /* Write only once */
710                                 ast_writestream(others[0], f);
711                         } else if (f->frametype == AST_FRAME_DTMF) {
712                                 if (prepend) {
713                                 /* stop recording with any digit */
714                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass);
715                                         res = 't';
716                                         outmsg = 2;
717                                         break;
718                                 }
719                                 if (strchr(acceptdtmf, f->subclass)) {
720                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass);
721                                         res = f->subclass;
722                                         outmsg = 2;
723                                         break;
724                                 }
725                                 if (strchr(canceldtmf, f->subclass)) {
726                                         ast_verb(3, "User cancelled message by pressing %c\n", f->subclass);
727                                         res = f->subclass;
728                                         outmsg = 0;
729                                         break;
730                                 }
731                         }
732                         if (maxtime) {
733                                 end = time(NULL);
734                                 if (maxtime < (end - start)) {
735                                         ast_verb(3, "Took too long, cutting it short...\n");
736                                         res = 't';
737                                         outmsg = 2;
738                                         break;
739                                 }
740                         }
741                         ast_frfree(f);
742                 }
743                 if (!f) {
744                         ast_verb(3, "User hung up\n");
745                         res = -1;
746                         outmsg = 1;
747                 } else {
748                         ast_frfree(f);
749                 }
750                 if (end == start)
751                         end = time(NULL);
752         } else {
753                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
754         }
755
756         if (!prepend) {
757                 if (silgen)
758                         ast_channel_stop_silence_generator(chan, silgen);
759         }
760         *duration = end - start;
761
762         if (!prepend) {
763                 for (x = 0; x < fmtcnt; x++) {
764                         if (!others[x])
765                                 break;
766                         if (res > 0)
767                                 ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
768                         ast_truncstream(others[x]);
769                         ast_closestream(others[x]);
770                 }
771         }
772
773         if (prepend && outmsg) {
774                 struct ast_filestream *realfiles[MAX_OTHER_FORMATS];
775                 struct ast_frame *fr;
776
777                 for (x = 0; x < fmtcnt; x++) {
778                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
779                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
780                         if (!others[x] || !realfiles[x])
781                                 break;
782                         ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
783                         ast_truncstream(others[x]);
784                         /* add the original file too */
785                         while ((fr = ast_readframe(realfiles[x]))) {
786                                 ast_writestream(others[x], fr);
787                                 ast_frfree(fr);
788                         }
789                         ast_closestream(others[x]);
790                         ast_closestream(realfiles[x]);
791                         ast_filerename(prependfile, recordfile, sfmt[x]);
792                         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
793                         ast_filedelete(prependfile, sfmt[x]);
794                 }
795         }
796         if (rfmt && ast_set_read_format(chan, rfmt)) {
797                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
798         }
799         if (outmsg == 2) {
800                 ast_stream_and_wait(chan, "auth-thankyou", "");
801         }
802         if (sildet)
803                 ast_dsp_free(sildet);
804         return res;
805 }
806
807 static char default_acceptdtmf[] = "#";
808 static char default_canceldtmf[] = "";
809
810 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)
811 {
812         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));
813 }
814
815 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)
816 {
817         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
818 }
819
820 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)
821 {
822         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
823 }
824
825 /* Channel group core functions */
826
827 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
828 {
829         int res = 0;
830         char tmp[256];
831         char *grp = NULL, *cat = NULL;
832
833         if (!ast_strlen_zero(data)) {
834                 ast_copy_string(tmp, data, sizeof(tmp));
835                 grp = tmp;
836                 cat = strchr(tmp, '@');
837                 if (cat) {
838                         *cat = '\0';
839                         cat++;
840                 }
841         }
842
843         if (!ast_strlen_zero(grp))
844                 ast_copy_string(group, grp, group_max);
845         else
846                 res = -1;
847
848         if (!ast_strlen_zero(cat))
849                 ast_copy_string(category, cat, category_max);
850
851         return res;
852 }
853
854 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
855 {
856         int res = 0;
857         char group[80] = "", category[80] = "";
858         struct ast_group_info *gi = NULL;
859         size_t len = 0;
860         
861         if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category)))
862                 return -1;
863         
864         /* Calculate memory we will need if this is new */
865         len = sizeof(*gi) + strlen(group) + 1;
866         if (!ast_strlen_zero(category))
867                 len += strlen(category) + 1;
868         
869         AST_RWLIST_WRLOCK(&groups);
870         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
871                 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
872                         AST_RWLIST_REMOVE_CURRENT(&groups, list);
873                         free(gi);
874                         break;
875                 }
876         }
877         AST_RWLIST_TRAVERSE_SAFE_END
878
879         if ((gi = calloc(1, len))) {
880                 gi->chan = chan;
881                 gi->group = (char *) gi + sizeof(*gi);
882                 strcpy(gi->group, group);
883                 if (!ast_strlen_zero(category)) {
884                         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
885                         strcpy(gi->category, category);
886                 }
887                 AST_RWLIST_INSERT_TAIL(&groups, gi, list);
888         } else {
889                 res = -1;
890         }
891         
892         AST_RWLIST_UNLOCK(&groups);
893         
894         return res;
895 }
896
897 int ast_app_group_get_count(const char *group, const char *category)
898 {
899         struct ast_group_info *gi = NULL;
900         int count = 0;
901
902         if (ast_strlen_zero(group))
903                 return 0;
904         
905         AST_RWLIST_RDLOCK(&groups);
906         AST_RWLIST_TRAVERSE(&groups, gi, list) {
907                 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
908                         count++;
909         }
910         AST_RWLIST_UNLOCK(&groups);
911
912         return count;
913 }
914
915 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
916 {
917         struct ast_group_info *gi = NULL;
918         regex_t regexbuf;
919         int count = 0;
920
921         if (ast_strlen_zero(groupmatch))
922                 return 0;
923
924         /* if regex compilation fails, return zero matches */
925         if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
926                 return 0;
927
928         AST_RWLIST_RDLOCK(&groups);
929         AST_RWLIST_TRAVERSE(&groups, gi, list) {
930                 if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
931                         count++;
932         }
933         AST_RWLIST_UNLOCK(&groups);
934
935         regfree(&regexbuf);
936
937         return count;
938 }
939
940 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
941 {
942         struct ast_group_info *gi = NULL;
943
944         AST_RWLIST_WRLOCK(&groups);
945         AST_RWLIST_TRAVERSE(&groups, gi, list) {
946                 if (gi->chan == old)
947                         gi->chan = new;
948         }
949         AST_RWLIST_UNLOCK(&groups);
950
951         return 0;
952 }
953
954 int ast_app_group_discard(struct ast_channel *chan)
955 {
956         struct ast_group_info *gi = NULL;
957         
958         AST_RWLIST_WRLOCK(&groups);
959         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
960                 if (gi->chan == chan) {
961                         AST_RWLIST_REMOVE_CURRENT(&groups, list);
962                         ast_free(gi);
963                 }
964         }
965         AST_RWLIST_TRAVERSE_SAFE_END
966         AST_RWLIST_UNLOCK(&groups);
967         
968         return 0;
969 }
970
971 int ast_app_group_list_wrlock(void)
972 {
973         return AST_RWLIST_WRLOCK(&groups);
974 }
975
976 int ast_app_group_list_rdlock(void)
977 {
978         return AST_RWLIST_RDLOCK(&groups);
979 }
980
981 struct ast_group_info *ast_app_group_list_head(void)
982 {
983         return AST_RWLIST_FIRST(&groups);
984 }
985
986 int ast_app_group_list_unlock(void)
987 {
988         return AST_RWLIST_UNLOCK(&groups);
989 }
990
991 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
992 {
993         int argc;
994         char *scan;
995         int paren = 0, quote = 0;
996
997         if (!buf || !array || !arraylen)
998                 return 0;
999
1000         memset(array, 0, arraylen * sizeof(*array));
1001
1002         scan = buf;
1003
1004         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1005                 array[argc] = scan;
1006                 for (; *scan; scan++) {
1007                         if (*scan == '(')
1008                                 paren++;
1009                         else if (*scan == ')') {
1010                                 if (paren)
1011                                         paren--;
1012                         } else if (*scan == '"' && delim != '"') {
1013                                 quote = quote ? 0 : 1;
1014                                 /* Remove quote character from argument */
1015                                 memmove(scan, scan + 1, strlen(scan));
1016                                 scan--;
1017                         } else if (*scan == '\\') {
1018                                 /* Literal character, don't parse */
1019                                 memmove(scan, scan + 1, strlen(scan));
1020                         } else if ((*scan == delim) && !paren && !quote) {
1021                                 *scan++ = '\0';
1022                                 break;
1023                         }
1024                 }
1025         }
1026
1027         if (*scan)
1028                 array[argc++] = scan;
1029
1030         return argc;
1031 }
1032
1033 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1034 {
1035         char *s;
1036         char *fs;
1037         int res;
1038         int fd;
1039         int lp = strlen(path);
1040         time_t start;
1041
1042         s = alloca(lp + 10); 
1043         fs = alloca(lp + 20);
1044
1045         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
1046         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
1047         if (fd < 0) {
1048                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
1049                 return AST_LOCK_PATH_NOT_FOUND;
1050         }
1051         close(fd);
1052
1053         snprintf(s, strlen(path) + 9, "%s/.lock", path);
1054         start = time(NULL);
1055         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
1056                 usleep(1);
1057
1058         unlink(fs);
1059
1060         if (res) {
1061                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
1062                 return AST_LOCK_TIMEOUT;
1063         } else {
1064                 ast_debug(1, "Locked path '%s'\n", path);
1065                 return AST_LOCK_SUCCESS;
1066         }
1067 }
1068
1069 static int ast_unlock_path_lockfile(const char *path)
1070 {
1071         char *s;
1072         int res;
1073
1074         s = alloca(strlen(path) + 10);
1075
1076         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
1077
1078         if ((res = unlink(s)))
1079                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
1080         else {
1081                 ast_debug(1, "Unlocked path '%s'\n", path);
1082         }
1083
1084         return res;
1085 }
1086
1087 struct path_lock {
1088         AST_LIST_ENTRY(path_lock) le;
1089         int fd;
1090         char *path;
1091 };
1092
1093 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
1094
1095 static void path_lock_destroy(struct path_lock *obj)
1096 {
1097         if (obj->fd >= 0)
1098                 close(obj->fd);
1099         if (obj->path)
1100                 free(obj->path);
1101         free(obj);
1102 }
1103
1104 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
1105 {
1106         char *fs;
1107         int res;
1108         int fd;
1109         time_t start;
1110         struct path_lock *pl;
1111         struct stat st, ost;
1112
1113         fs = alloca(strlen(path) + 20);
1114
1115         snprintf(fs, strlen(path) + 19, "%s/lock", path);
1116         if (lstat(fs, &st) == 0) {
1117                 if ((st.st_mode & S_IFMT) == S_IFLNK) {
1118                         ast_log(LOG_WARNING, "Unable to create lock file "
1119                                         "'%s': it's already a symbolic link\n",
1120                                         fs);
1121                         return AST_LOCK_FAILURE;
1122                 }
1123                 if (st.st_nlink > 1) {
1124                         ast_log(LOG_WARNING, "Unable to create lock file "
1125                                         "'%s': %u hard links exist\n",
1126                                         fs, (unsigned int) st.st_nlink);
1127                         return AST_LOCK_FAILURE;
1128                 }
1129         }
1130         fd = open(fs, O_WRONLY | O_CREAT, 0600);
1131         if (fd < 0) {
1132                 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
1133                                 fs, strerror(errno));
1134                 return AST_LOCK_PATH_NOT_FOUND;
1135         }
1136         pl = ast_calloc(1, sizeof(*pl));
1137         if (!pl) {
1138                 /* We don't unlink the lock file here, on the possibility that
1139                  * someone else created it - better to leave a little mess
1140                  * than create a big one by destroying someone else's lock
1141                  * and causing something to be corrupted.
1142                  */
1143                 close(fd);
1144                 return AST_LOCK_FAILURE;
1145         }
1146         pl->fd = fd;
1147         pl->path = strdup(path);
1148
1149         time(&start);
1150         while ((
1151                 #ifdef SOLARIS
1152                 (res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd,F_GETFL)|O_NONBLOCK)) < 0) &&
1153                 #else
1154                 (res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
1155                 #endif
1156                         (errno == EWOULDBLOCK) && 
1157                         (time(NULL) - start < 5))
1158                 usleep(1000);
1159         if (res) {
1160                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
1161                                 path, strerror(errno));
1162                 /* No unlinking of lock done, since we tried and failed to
1163                  * flock() it.
1164                  */
1165                 path_lock_destroy(pl);
1166                 return AST_LOCK_TIMEOUT;
1167         }
1168
1169         /* Check for the race where the file is recreated or deleted out from
1170          * underneath us.
1171          */
1172         if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
1173                         st.st_dev != ost.st_dev &&
1174                         st.st_ino != ost.st_ino) {
1175                 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
1176                                 "file changed underneath us\n", fs);
1177                 path_lock_destroy(pl);
1178                 return AST_LOCK_FAILURE;
1179         }
1180
1181         /* Success: file created, flocked, and is the one we started with */
1182         AST_LIST_LOCK(&path_lock_list);
1183         AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
1184         AST_LIST_UNLOCK(&path_lock_list);
1185
1186         ast_debug(1, "Locked path '%s'\n", path);
1187
1188         return AST_LOCK_SUCCESS;
1189 }
1190
1191 static int ast_unlock_path_flock(const char *path)
1192 {
1193         char *s;
1194         struct path_lock *p;
1195
1196         s = alloca(strlen(path) + 20);
1197
1198         AST_LIST_LOCK(&path_lock_list);
1199         AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
1200                 if (!strcmp(p->path, path)) {
1201                         AST_LIST_REMOVE_CURRENT(&path_lock_list, le);
1202                         break;
1203                 }
1204         }
1205         AST_LIST_TRAVERSE_SAFE_END;
1206         AST_LIST_UNLOCK(&path_lock_list);
1207
1208         if (p) {
1209                 snprintf(s, strlen(path) + 19, "%s/lock", path);
1210                 unlink(s);
1211                 path_lock_destroy(p);
1212                 ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
1213         } else
1214                 ast_log(LOG_DEBUG, "Failed to unlock path '%s': "
1215                                 "lock not found\n", path);
1216
1217         return 0;
1218 }
1219
1220 void ast_set_lock_type(enum AST_LOCK_TYPE type)
1221 {
1222         ast_lock_type = type;
1223 }
1224
1225 enum AST_LOCK_RESULT ast_lock_path(const char *path)
1226 {
1227         enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
1228
1229         switch (ast_lock_type) {
1230         case AST_LOCK_TYPE_LOCKFILE:
1231                 r = ast_lock_path_lockfile(path);
1232                 break;
1233         case AST_LOCK_TYPE_FLOCK:
1234                 r = ast_lock_path_flock(path);
1235                 break;
1236         }
1237
1238         return r;
1239 }
1240
1241 int ast_unlock_path(const char *path)
1242 {
1243         int r = 0;
1244
1245         switch (ast_lock_type) {
1246         case AST_LOCK_TYPE_LOCKFILE:
1247                 r = ast_unlock_path_lockfile(path);
1248                 break;
1249         case AST_LOCK_TYPE_FLOCK:
1250                 r = ast_unlock_path_flock(path);
1251                 break;
1252         }
1253
1254         return r;
1255 }
1256
1257 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path) 
1258 {
1259         int silencethreshold = 128; 
1260         int maxsilence = 0;
1261         int res = 0;
1262         int cmd = 0;
1263         int max_attempts = 3;
1264         int attempts = 0;
1265         int recorded = 0;
1266         int message_exists = 0;
1267         /* Note that urgent and private are for flagging messages as such in the future */
1268
1269         /* barf if no pointer passed to store duration in */
1270         if (!duration) {
1271                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
1272                 return -1;
1273         }
1274
1275         cmd = '3';       /* Want to start by recording */
1276
1277         while ((cmd >= 0) && (cmd != 't')) {
1278                 switch (cmd) {
1279                 case '1':
1280                         if (!message_exists) {
1281                                 /* In this case, 1 is to record a message */
1282                                 cmd = '3';
1283                                 break;
1284                         } else {
1285                                 ast_stream_and_wait(chan, "vm-msgsaved", "");
1286                                 cmd = 't';
1287                                 return res;
1288                         }
1289                 case '2':
1290                         /* Review */
1291                         ast_verb(3, "Reviewing the recording\n");
1292                         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
1293                         break;
1294                 case '3':
1295                         message_exists = 0;
1296                         /* Record */
1297                         if (recorded == 1)
1298                                 ast_verb(3, "Re-recording\n");
1299                         else    
1300                                 ast_verb(3, "Recording\n");
1301                         recorded = 1;
1302                         cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
1303                         if (cmd == -1) {
1304                         /* User has hung up, no options to give */
1305                                 return cmd;
1306                         }
1307                         if (cmd == '0') {
1308                                 break;
1309                         } else if (cmd == '*') {
1310                                 break;
1311                         } 
1312                         else {
1313                                 /* If all is well, a message exists */
1314                                 message_exists = 1;
1315                                 cmd = 0;
1316                         }
1317                         break;
1318                 case '4':
1319                 case '5':
1320                 case '6':
1321                 case '7':
1322                 case '8':
1323                 case '9':
1324                 case '*':
1325                 case '#':
1326                         cmd = ast_play_and_wait(chan, "vm-sorry");
1327                         break;
1328                 default:
1329                         if (message_exists) {
1330                                 cmd = ast_play_and_wait(chan, "vm-review");
1331                         }
1332                         else {
1333                                 cmd = ast_play_and_wait(chan, "vm-torerecord");
1334                                 if (!cmd)
1335                                         cmd = ast_waitfordigit(chan, 600);
1336                         }
1337                         
1338                         if (!cmd)
1339                                 cmd = ast_waitfordigit(chan, 6000);
1340                         if (!cmd) {
1341                                 attempts++;
1342                         }
1343                         if (attempts > max_attempts) {
1344                                 cmd = 't';
1345                         }
1346                 }
1347         }
1348         if (cmd == 't')
1349                 cmd = 0;
1350         return cmd;
1351 }
1352
1353 #define RES_UPONE (1 << 16)
1354 #define RES_EXIT  (1 << 17)
1355 #define RES_REPEAT (1 << 18)
1356 #define RES_RESTART ((1 << 19) | RES_REPEAT)
1357
1358 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
1359
1360 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
1361 {
1362         int res;
1363         int (*ivr_func)(struct ast_channel *, void *);
1364         char *c;
1365         char *n;
1366         
1367         switch (option->action) {
1368         case AST_ACTION_UPONE:
1369                 return RES_UPONE;
1370         case AST_ACTION_EXIT:
1371                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
1372         case AST_ACTION_REPEAT:
1373                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
1374         case AST_ACTION_RESTART:
1375                 return RES_RESTART ;
1376         case AST_ACTION_NOOP:
1377                 return 0;
1378         case AST_ACTION_BACKGROUND:
1379                 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
1380                 if (res < 0) {
1381                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1382                         res = 0;
1383                 }
1384                 return res;
1385         case AST_ACTION_PLAYBACK:
1386                 res = ast_stream_and_wait(chan, (char *)option->adata, "");
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_MENU:
1393                 res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata);
1394                 /* Do not pass entry errors back up, treat as though it was an "UPONE" */
1395                 if (res == -2)
1396                         res = 0;
1397                 return res;
1398         case AST_ACTION_WAITOPTION:
1399                 res = ast_waitfordigit(chan, 1000 * (chan->pbx ? chan->pbx->rtimeout : 10));
1400                 if (!res)
1401                         return 't';
1402                 return res;
1403         case AST_ACTION_CALLBACK:
1404                 ivr_func = option->adata;
1405                 res = ivr_func(chan, cbdata);
1406                 return res;
1407         case AST_ACTION_TRANSFER:
1408                 res = ast_parseable_goto(chan, option->adata);
1409                 return 0;
1410         case AST_ACTION_PLAYLIST:
1411         case AST_ACTION_BACKLIST:
1412                 res = 0;
1413                 c = ast_strdupa(option->adata);
1414                 while ((n = strsep(&c, ";"))) {
1415                         if ((res = ast_stream_and_wait(chan, n,
1416                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : "")))
1417                                 break;
1418                 }
1419                 ast_stopstream(chan);
1420                 return res;
1421         default:
1422                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
1423                 return 0;
1424         };
1425         return -1;
1426 }
1427
1428 static int option_exists(struct ast_ivr_menu *menu, char *option)
1429 {
1430         int x;
1431         for (x = 0; menu->options[x].option; x++)
1432                 if (!strcasecmp(menu->options[x].option, option))
1433                         return x;
1434         return -1;
1435 }
1436
1437 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
1438 {
1439         int x;
1440         for (x = 0; menu->options[x].option; x++)
1441                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) && 
1442                                 (menu->options[x].option[strlen(option)]))
1443                         return x;
1444         return -1;
1445 }
1446
1447 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
1448 {
1449         int res=0;
1450         int ms;
1451         while (option_matchmore(menu, exten)) {
1452                 ms = chan->pbx ? chan->pbx->dtimeout : 5000;
1453                 if (strlen(exten) >= maxexten - 1) 
1454                         break;
1455                 res = ast_waitfordigit(chan, ms);
1456                 if (res < 1)
1457                         break;
1458                 exten[strlen(exten) + 1] = '\0';
1459                 exten[strlen(exten)] = res;
1460         }
1461         return res > 0 ? 0 : res;
1462 }
1463
1464 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1465 {
1466         /* Execute an IVR menu structure */
1467         int res=0;
1468         int pos = 0;
1469         int retries = 0;
1470         char exten[AST_MAX_EXTENSION] = "s";
1471         if (option_exists(menu, "s") < 0) {
1472                 strcpy(exten, "g");
1473                 if (option_exists(menu, "g") < 0) {
1474                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
1475                         return -1;
1476                 }
1477         }
1478         while (!res) {
1479                 while (menu->options[pos].option) {
1480                         if (!strcasecmp(menu->options[pos].option, exten)) {
1481                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
1482                                 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
1483                                 if (res < 0)
1484                                         break;
1485                                 else if (res & RES_UPONE)
1486                                         return 0;
1487                                 else if (res & RES_EXIT)
1488                                         return res;
1489                                 else if (res & RES_REPEAT) {
1490                                         int maxretries = res & 0xffff;
1491                                         if ((res & RES_RESTART) == RES_RESTART) {
1492                                                 retries = 0;
1493                                         } else
1494                                                 retries++;
1495                                         if (!maxretries)
1496                                                 maxretries = 3;
1497                                         if ((maxretries > 0) && (retries >= maxretries)) {
1498                                                 ast_debug(1, "Max retries %d exceeded\n", maxretries);
1499                                                 return -2;
1500                                         } else {
1501                                                 if (option_exists(menu, "g") > -1) 
1502                                                         strcpy(exten, "g");
1503                                                 else if (option_exists(menu, "s") > -1)
1504                                                         strcpy(exten, "s");
1505                                         }
1506                                         pos = 0;
1507                                         continue;
1508                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
1509                                         ast_debug(1, "Got start of extension, %c\n", res);
1510                                         exten[1] = '\0';
1511                                         exten[0] = res;
1512                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten))))
1513                                                 break;
1514                                         if (option_exists(menu, exten) < 0) {
1515                                                 if (option_exists(menu, "i")) {
1516                                                         ast_debug(1, "Invalid extension entered, going to 'i'!\n");
1517                                                         strcpy(exten, "i");
1518                                                         pos = 0;
1519                                                         continue;
1520                                                 } else {
1521                                                         ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
1522                                                         res = -2;
1523                                                         break;
1524                                                 }
1525                                         } else {
1526                                                 ast_debug(1, "New existing extension: %s\n", exten);
1527                                                 pos = 0;
1528                                                 continue;
1529                                         }
1530                                 }
1531                         }
1532                         pos++;
1533                 }
1534                 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
1535                 pos = 0;
1536                 if (!strcasecmp(exten, "s"))
1537                         strcpy(exten, "g");
1538                 else
1539                         break;
1540         }
1541         return res;
1542 }
1543
1544 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1545 {
1546         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
1547         /* Hide internal coding */
1548         return res > 0 ? 0 : res;
1549 }
1550         
1551 char *ast_read_textfile(const char *filename)
1552 {
1553         int fd, count = 0, res;
1554         char *output = NULL;
1555         struct stat filesize;
1556
1557         if (stat(filename, &filesize) == -1) {
1558                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
1559                 return NULL;
1560         }
1561
1562         count = filesize.st_size + 1;
1563
1564         if ((fd = open(filename, O_RDONLY)) < 0) {
1565                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
1566                 return NULL;
1567         }
1568
1569         if ((output = ast_malloc(count))) {
1570                 res = read(fd, output, count - 1);
1571                 if (res == count - 1) {
1572                         output[res] = '\0';
1573                 } else {
1574                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
1575                         ast_free(output);
1576                         output = NULL;
1577                 }
1578         }
1579
1580         close(fd);
1581
1582         return output;
1583 }
1584
1585 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
1586 {
1587         char *s, *arg;
1588         int curarg, res = 0;
1589         unsigned int argloc;
1590
1591         ast_clear_flag(flags, AST_FLAGS_ALL);
1592
1593         if (!optstr)
1594                 return 0;
1595
1596         s = optstr;
1597         while (*s) {
1598                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1599                 ast_set_flag(flags, options[curarg].flag);
1600                 argloc = options[curarg].arg_index;
1601                 if (*s == '(') {
1602                         /* Has argument */
1603                         arg = ++s;
1604                         if ((s = strchr(s, ')'))) {
1605                                 if (argloc)
1606                                         args[argloc - 1] = arg;
1607                                 *s++ = '\0';
1608                         } else {
1609                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1610                                 res = -1;
1611                                 break;
1612                         }
1613                 } else if (argloc) {
1614                         args[argloc - 1] = NULL;
1615                 }
1616         }
1617
1618         return res;
1619 }
1620
1621 /* the following function will probably only be used in app_dial, until app_dial is reorganized to
1622    better handle the large number of options it provides. After it is, you need to get rid of this variant 
1623    -- unless, of course, someone else digs up some use for large flag fields. */
1624
1625 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
1626 {
1627         char *s, *arg;
1628         int curarg, res = 0;
1629         unsigned int argloc;
1630
1631         flags->flags = 0;
1632         
1633         if (!optstr)
1634                 return 0;
1635
1636         s = optstr;
1637         while (*s) {
1638                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1639                 ast_set_flag64(flags, options[curarg].flag);
1640                 argloc = options[curarg].arg_index;
1641                 if (*s == '(') {
1642                         /* Has argument */
1643                         arg = ++s;
1644                         if ((s = strchr(s, ')'))) {
1645                                 if (argloc)
1646                                         args[argloc - 1] = arg;
1647                                 *s++ = '\0';
1648                         } else {
1649                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1650                                 res = -1;
1651                                 break;
1652                         }
1653                 } else if (argloc) {
1654                         args[argloc - 1] = NULL;
1655                 }
1656         }
1657
1658         return res;
1659 }
1660