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