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