remove a number of #include <fcntl.h> which are either
[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                 if (end == start)
747                         end = time(NULL);
748         } else {
749                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
750         }
751
752         if (!prepend) {
753                 if (silgen)
754                         ast_channel_stop_silence_generator(chan, silgen);
755         }
756         *duration = end - start;
757
758         if (!prepend) {
759                 for (x = 0; x < fmtcnt; x++) {
760                         if (!others[x])
761                                 break;
762                         /*!\note
763                          * If we ended with silence, trim all but the first 200ms of silence
764                          * off the recording.  However, if we ended with '#', we don't want
765                          * to trim ANY part of the recording.
766                          */
767                         if (res > 0 && totalsilence)
768                                 ast_stream_rewind(others[x], totalsilence - 200);
769                         ast_truncstream(others[x]);
770                         ast_closestream(others[x]);
771                 }
772         }
773
774         if (prepend && outmsg) {
775                 struct ast_filestream *realfiles[MAX_OTHER_FORMATS];
776                 struct ast_frame *fr;
777
778                 for (x = 0; x < fmtcnt; x++) {
779                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
780                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
781                         if (!others[x] || !realfiles[x])
782                                 break;
783                         /*!\note Same logic as above. */
784                         if (totalsilence)
785                                 ast_stream_rewind(others[x], totalsilence - 200);
786                         ast_truncstream(others[x]);
787                         /* add the original file too */
788                         while ((fr = ast_readframe(realfiles[x]))) {
789                                 ast_writestream(others[x], fr);
790                                 ast_frfree(fr);
791                         }
792                         ast_closestream(others[x]);
793                         ast_closestream(realfiles[x]);
794                         ast_filerename(prependfile, recordfile, sfmt[x]);
795                         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
796                         ast_filedelete(prependfile, sfmt[x]);
797                 }
798         }
799         if (rfmt && ast_set_read_format(chan, rfmt)) {
800                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
801         }
802         if (outmsg == 2) {
803                 ast_stream_and_wait(chan, "auth-thankyou", "");
804         }
805         if (sildet)
806                 ast_dsp_free(sildet);
807         return res;
808 }
809
810 static char default_acceptdtmf[] = "#";
811 static char default_canceldtmf[] = "";
812
813 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)
814 {
815         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));
816 }
817
818 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)
819 {
820         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
821 }
822
823 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)
824 {
825         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
826 }
827
828 /* Channel group core functions */
829
830 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
831 {
832         int res = 0;
833         char tmp[256];
834         char *grp = NULL, *cat = NULL;
835
836         if (!ast_strlen_zero(data)) {
837                 ast_copy_string(tmp, data, sizeof(tmp));
838                 grp = tmp;
839                 cat = strchr(tmp, '@');
840                 if (cat) {
841                         *cat = '\0';
842                         cat++;
843                 }
844         }
845
846         if (!ast_strlen_zero(grp))
847                 ast_copy_string(group, grp, group_max);
848         else
849                 *group = '\0';
850
851         if (!ast_strlen_zero(cat))
852                 ast_copy_string(category, cat, category_max);
853
854         return res;
855 }
856
857 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
858 {
859         int res = 0;
860         char group[80] = "", category[80] = "";
861         struct ast_group_info *gi = NULL;
862         size_t len = 0;
863         
864         if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category)))
865                 return -1;
866         
867         /* Calculate memory we will need if this is new */
868         len = sizeof(*gi) + strlen(group) + 1;
869         if (!ast_strlen_zero(category))
870                 len += strlen(category) + 1;
871         
872         AST_RWLIST_WRLOCK(&groups);
873         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
874                 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
875                         AST_RWLIST_REMOVE_CURRENT(list);
876                         free(gi);
877                         break;
878                 }
879         }
880         AST_RWLIST_TRAVERSE_SAFE_END;
881
882         if (ast_strlen_zero(group)) {
883                 /* Enable unsetting the group */
884         } else if ((gi = calloc(1, len))) {
885                 gi->chan = chan;
886                 gi->group = (char *) gi + sizeof(*gi);
887                 strcpy(gi->group, group);
888                 if (!ast_strlen_zero(category)) {
889                         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
890                         strcpy(gi->category, category);
891                 }
892                 AST_RWLIST_INSERT_TAIL(&groups, gi, list);
893         } else {
894                 res = -1;
895         }
896         
897         AST_RWLIST_UNLOCK(&groups);
898         
899         return res;
900 }
901
902 int ast_app_group_get_count(const char *group, const char *category)
903 {
904         struct ast_group_info *gi = NULL;
905         int count = 0;
906
907         if (ast_strlen_zero(group))
908                 return 0;
909         
910         AST_RWLIST_RDLOCK(&groups);
911         AST_RWLIST_TRAVERSE(&groups, gi, list) {
912                 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
913                         count++;
914         }
915         AST_RWLIST_UNLOCK(&groups);
916
917         return count;
918 }
919
920 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
921 {
922         struct ast_group_info *gi = NULL;
923         regex_t regexbuf;
924         int count = 0;
925
926         if (ast_strlen_zero(groupmatch))
927                 return 0;
928
929         /* if regex compilation fails, return zero matches */
930         if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
931                 return 0;
932
933         AST_RWLIST_RDLOCK(&groups);
934         AST_RWLIST_TRAVERSE(&groups, gi, list) {
935                 if (!regexec(&regexbuf, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category))))
936                         count++;
937         }
938         AST_RWLIST_UNLOCK(&groups);
939
940         regfree(&regexbuf);
941
942         return count;
943 }
944
945 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
946 {
947         struct ast_group_info *gi = NULL;
948
949         AST_RWLIST_WRLOCK(&groups);
950         AST_RWLIST_TRAVERSE(&groups, gi, list) {
951                 if (gi->chan == old)
952                         gi->chan = new;
953         }
954         AST_RWLIST_UNLOCK(&groups);
955
956         return 0;
957 }
958
959 int ast_app_group_discard(struct ast_channel *chan)
960 {
961         struct ast_group_info *gi = NULL;
962         
963         AST_RWLIST_WRLOCK(&groups);
964         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, list) {
965                 if (gi->chan == chan) {
966                         AST_RWLIST_REMOVE_CURRENT(list);
967                         ast_free(gi);
968                 }
969         }
970         AST_RWLIST_TRAVERSE_SAFE_END;
971         AST_RWLIST_UNLOCK(&groups);
972         
973         return 0;
974 }
975
976 int ast_app_group_list_wrlock(void)
977 {
978         return AST_RWLIST_WRLOCK(&groups);
979 }
980
981 int ast_app_group_list_rdlock(void)
982 {
983         return AST_RWLIST_RDLOCK(&groups);
984 }
985
986 struct ast_group_info *ast_app_group_list_head(void)
987 {
988         return AST_RWLIST_FIRST(&groups);
989 }
990
991 int ast_app_group_list_unlock(void)
992 {
993         return AST_RWLIST_UNLOCK(&groups);
994 }
995
996 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
997 {
998         int argc;
999         char *scan;
1000         int paren = 0, quote = 0;
1001
1002         if (!buf || !array || !arraylen)
1003                 return 0;
1004
1005         memset(array, 0, arraylen * sizeof(*array));
1006
1007         scan = buf;
1008
1009         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1010                 array[argc] = scan;
1011                 for (; *scan; scan++) {
1012                         if (*scan == '(')
1013                                 paren++;
1014                         else if (*scan == ')') {
1015                                 if (paren)
1016                                         paren--;
1017                         } else if (*scan == '"' && delim != '"') {
1018                                 quote = quote ? 0 : 1;
1019                                 /* Remove quote character from argument */
1020                                 memmove(scan, scan + 1, strlen(scan));
1021                                 scan--;
1022                         } else if (*scan == '\\') {
1023                                 /* Literal character, don't parse */
1024                                 memmove(scan, scan + 1, strlen(scan));
1025                         } else if ((*scan == delim) && !paren && !quote) {
1026                                 *scan++ = '\0';
1027                                 break;
1028                         }
1029                 }
1030         }
1031
1032         if (*scan)
1033                 array[argc++] = scan;
1034
1035         return argc;
1036 }
1037
1038 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1039 {
1040         char *s;
1041         char *fs;
1042         int res;
1043         int fd;
1044         int lp = strlen(path);
1045         time_t start;
1046
1047         s = alloca(lp + 10); 
1048         fs = alloca(lp + 20);
1049
1050         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
1051         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
1052         if (fd < 0) {
1053                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
1054                 return AST_LOCK_PATH_NOT_FOUND;
1055         }
1056         close(fd);
1057
1058         snprintf(s, strlen(path) + 9, "%s/.lock", path);
1059         start = time(NULL);
1060         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
1061                 usleep(1);
1062
1063         unlink(fs);
1064
1065         if (res) {
1066                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
1067                 return AST_LOCK_TIMEOUT;
1068         } else {
1069                 ast_debug(1, "Locked path '%s'\n", path);
1070                 return AST_LOCK_SUCCESS;
1071         }
1072 }
1073
1074 static int ast_unlock_path_lockfile(const char *path)
1075 {
1076         char *s;
1077         int res;
1078
1079         s = alloca(strlen(path) + 10);
1080
1081         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
1082
1083         if ((res = unlink(s)))
1084                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
1085         else {
1086                 ast_debug(1, "Unlocked path '%s'\n", path);
1087         }
1088
1089         return res;
1090 }
1091
1092 struct path_lock {
1093         AST_LIST_ENTRY(path_lock) le;
1094         int fd;
1095         char *path;
1096 };
1097
1098 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
1099
1100 static void path_lock_destroy(struct path_lock *obj)
1101 {
1102         if (obj->fd >= 0)
1103                 close(obj->fd);
1104         if (obj->path)
1105                 free(obj->path);
1106         free(obj);
1107 }
1108
1109 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
1110 {
1111         char *fs;
1112         int res;
1113         int fd;
1114         time_t start;
1115         struct path_lock *pl;
1116         struct stat st, ost;
1117
1118         fs = alloca(strlen(path) + 20);
1119
1120         snprintf(fs, strlen(path) + 19, "%s/lock", path);
1121         if (lstat(fs, &st) == 0) {
1122                 if ((st.st_mode & S_IFMT) == S_IFLNK) {
1123                         ast_log(LOG_WARNING, "Unable to create lock file "
1124                                         "'%s': it's already a symbolic link\n",
1125                                         fs);
1126                         return AST_LOCK_FAILURE;
1127                 }
1128                 if (st.st_nlink > 1) {
1129                         ast_log(LOG_WARNING, "Unable to create lock file "
1130                                         "'%s': %u hard links exist\n",
1131                                         fs, (unsigned int) st.st_nlink);
1132                         return AST_LOCK_FAILURE;
1133                 }
1134         }
1135         fd = open(fs, O_WRONLY | O_CREAT, 0600);
1136         if (fd < 0) {
1137                 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
1138                                 fs, strerror(errno));
1139                 return AST_LOCK_PATH_NOT_FOUND;
1140         }
1141         pl = ast_calloc(1, sizeof(*pl));
1142         if (!pl) {
1143                 /* We don't unlink the lock file here, on the possibility that
1144                  * someone else created it - better to leave a little mess
1145                  * than create a big one by destroying someone else's lock
1146                  * and causing something to be corrupted.
1147                  */
1148                 close(fd);
1149                 return AST_LOCK_FAILURE;
1150         }
1151         pl->fd = fd;
1152         pl->path = strdup(path);
1153
1154         time(&start);
1155         while ((
1156                 #ifdef SOLARIS
1157                 (res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd,F_GETFL)|O_NONBLOCK)) < 0) &&
1158                 #else
1159                 (res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
1160                 #endif
1161                         (errno == EWOULDBLOCK) && 
1162                         (time(NULL) - start < 5))
1163                 usleep(1000);
1164         if (res) {
1165                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
1166                                 path, strerror(errno));
1167                 /* No unlinking of lock done, since we tried and failed to
1168                  * flock() it.
1169                  */
1170                 path_lock_destroy(pl);
1171                 return AST_LOCK_TIMEOUT;
1172         }
1173
1174         /* Check for the race where the file is recreated or deleted out from
1175          * underneath us.
1176          */
1177         if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
1178                         st.st_dev != ost.st_dev &&
1179                         st.st_ino != ost.st_ino) {
1180                 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
1181                                 "file changed underneath us\n", fs);
1182                 path_lock_destroy(pl);
1183                 return AST_LOCK_FAILURE;
1184         }
1185
1186         /* Success: file created, flocked, and is the one we started with */
1187         AST_LIST_LOCK(&path_lock_list);
1188         AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
1189         AST_LIST_UNLOCK(&path_lock_list);
1190
1191         ast_debug(1, "Locked path '%s'\n", path);
1192
1193         return AST_LOCK_SUCCESS;
1194 }
1195
1196 static int ast_unlock_path_flock(const char *path)
1197 {
1198         char *s;
1199         struct path_lock *p;
1200
1201         s = alloca(strlen(path) + 20);
1202
1203         AST_LIST_LOCK(&path_lock_list);
1204         AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
1205                 if (!strcmp(p->path, path)) {
1206                         AST_LIST_REMOVE_CURRENT(le);
1207                         break;
1208                 }
1209         }
1210         AST_LIST_TRAVERSE_SAFE_END;
1211         AST_LIST_UNLOCK(&path_lock_list);
1212
1213         if (p) {
1214                 snprintf(s, strlen(path) + 19, "%s/lock", path);
1215                 unlink(s);
1216                 path_lock_destroy(p);
1217                 ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
1218         } else
1219                 ast_log(LOG_DEBUG, "Failed to unlock path '%s': "
1220                                 "lock not found\n", path);
1221
1222         return 0;
1223 }
1224
1225 void ast_set_lock_type(enum AST_LOCK_TYPE type)
1226 {
1227         ast_lock_type = type;
1228 }
1229
1230 enum AST_LOCK_RESULT ast_lock_path(const char *path)
1231 {
1232         enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
1233
1234         switch (ast_lock_type) {
1235         case AST_LOCK_TYPE_LOCKFILE:
1236                 r = ast_lock_path_lockfile(path);
1237                 break;
1238         case AST_LOCK_TYPE_FLOCK:
1239                 r = ast_lock_path_flock(path);
1240                 break;
1241         }
1242
1243         return r;
1244 }
1245
1246 int ast_unlock_path(const char *path)
1247 {
1248         int r = 0;
1249
1250         switch (ast_lock_type) {
1251         case AST_LOCK_TYPE_LOCKFILE:
1252                 r = ast_unlock_path_lockfile(path);
1253                 break;
1254         case AST_LOCK_TYPE_FLOCK:
1255                 r = ast_unlock_path_flock(path);
1256                 break;
1257         }
1258
1259         return r;
1260 }
1261
1262 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path) 
1263 {
1264         int silencethreshold = 128; 
1265         int maxsilence = 0;
1266         int res = 0;
1267         int cmd = 0;
1268         int max_attempts = 3;
1269         int attempts = 0;
1270         int recorded = 0;
1271         int message_exists = 0;
1272         /* Note that urgent and private are for flagging messages as such in the future */
1273
1274         /* barf if no pointer passed to store duration in */
1275         if (!duration) {
1276                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
1277                 return -1;
1278         }
1279
1280         cmd = '3';       /* Want to start by recording */
1281
1282         while ((cmd >= 0) && (cmd != 't')) {
1283                 switch (cmd) {
1284                 case '1':
1285                         if (!message_exists) {
1286                                 /* In this case, 1 is to record a message */
1287                                 cmd = '3';
1288                                 break;
1289                         } else {
1290                                 ast_stream_and_wait(chan, "vm-msgsaved", "");
1291                                 cmd = 't';
1292                                 return res;
1293                         }
1294                 case '2':
1295                         /* Review */
1296                         ast_verb(3, "Reviewing the recording\n");
1297                         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
1298                         break;
1299                 case '3':
1300                         message_exists = 0;
1301                         /* Record */
1302                         if (recorded == 1)
1303                                 ast_verb(3, "Re-recording\n");
1304                         else    
1305                                 ast_verb(3, "Recording\n");
1306                         recorded = 1;
1307                         cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
1308                         if (cmd == -1) {
1309                         /* User has hung up, no options to give */
1310                                 return cmd;
1311                         }
1312                         if (cmd == '0') {
1313                                 break;
1314                         } else if (cmd == '*') {
1315                                 break;
1316                         } 
1317                         else {
1318                                 /* If all is well, a message exists */
1319                                 message_exists = 1;
1320                                 cmd = 0;
1321                         }
1322                         break;
1323                 case '4':
1324                 case '5':
1325                 case '6':
1326                 case '7':
1327                 case '8':
1328                 case '9':
1329                 case '*':
1330                 case '#':
1331                         cmd = ast_play_and_wait(chan, "vm-sorry");
1332                         break;
1333                 default:
1334                         if (message_exists) {
1335                                 cmd = ast_play_and_wait(chan, "vm-review");
1336                         }
1337                         else {
1338                                 cmd = ast_play_and_wait(chan, "vm-torerecord");
1339                                 if (!cmd)
1340                                         cmd = ast_waitfordigit(chan, 600);
1341                         }
1342                         
1343                         if (!cmd)
1344                                 cmd = ast_waitfordigit(chan, 6000);
1345                         if (!cmd) {
1346                                 attempts++;
1347                         }
1348                         if (attempts > max_attempts) {
1349                                 cmd = 't';
1350                         }
1351                 }
1352         }
1353         if (cmd == 't')
1354                 cmd = 0;
1355         return cmd;
1356 }
1357
1358 #define RES_UPONE (1 << 16)
1359 #define RES_EXIT  (1 << 17)
1360 #define RES_REPEAT (1 << 18)
1361 #define RES_RESTART ((1 << 19) | RES_REPEAT)
1362
1363 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
1364
1365 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
1366 {
1367         int res;
1368         int (*ivr_func)(struct ast_channel *, void *);
1369         char *c;
1370         char *n;
1371         
1372         switch (option->action) {
1373         case AST_ACTION_UPONE:
1374                 return RES_UPONE;
1375         case AST_ACTION_EXIT:
1376                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
1377         case AST_ACTION_REPEAT:
1378                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
1379         case AST_ACTION_RESTART:
1380                 return RES_RESTART ;
1381         case AST_ACTION_NOOP:
1382                 return 0;
1383         case AST_ACTION_BACKGROUND:
1384                 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
1385                 if (res < 0) {
1386                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1387                         res = 0;
1388                 }
1389                 return res;
1390         case AST_ACTION_PLAYBACK:
1391                 res = ast_stream_and_wait(chan, (char *)option->adata, "");
1392                 if (res < 0) {
1393                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1394                         res = 0;
1395                 }
1396                 return res;
1397         case AST_ACTION_MENU:
1398                 res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata);
1399                 /* Do not pass entry errors back up, treat as though it was an "UPONE" */
1400                 if (res == -2)
1401                         res = 0;
1402                 return res;
1403         case AST_ACTION_WAITOPTION:
1404                 res = ast_waitfordigit(chan, 1000 * (chan->pbx ? chan->pbx->rtimeout : 10));
1405                 if (!res)
1406                         return 't';
1407                 return res;
1408         case AST_ACTION_CALLBACK:
1409                 ivr_func = option->adata;
1410                 res = ivr_func(chan, cbdata);
1411                 return res;
1412         case AST_ACTION_TRANSFER:
1413                 res = ast_parseable_goto(chan, option->adata);
1414                 return 0;
1415         case AST_ACTION_PLAYLIST:
1416         case AST_ACTION_BACKLIST:
1417                 res = 0;
1418                 c = ast_strdupa(option->adata);
1419                 while ((n = strsep(&c, ";"))) {
1420                         if ((res = ast_stream_and_wait(chan, n,
1421                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : "")))
1422                                 break;
1423                 }
1424                 ast_stopstream(chan);
1425                 return res;
1426         default:
1427                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
1428                 return 0;
1429         };
1430         return -1;
1431 }
1432
1433 static int option_exists(struct ast_ivr_menu *menu, char *option)
1434 {
1435         int x;
1436         for (x = 0; menu->options[x].option; x++)
1437                 if (!strcasecmp(menu->options[x].option, option))
1438                         return x;
1439         return -1;
1440 }
1441
1442 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
1443 {
1444         int x;
1445         for (x = 0; menu->options[x].option; x++)
1446                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) && 
1447                                 (menu->options[x].option[strlen(option)]))
1448                         return x;
1449         return -1;
1450 }
1451
1452 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
1453 {
1454         int res=0;
1455         int ms;
1456         while (option_matchmore(menu, exten)) {
1457                 ms = chan->pbx ? chan->pbx->dtimeout : 5000;
1458                 if (strlen(exten) >= maxexten - 1) 
1459                         break;
1460                 res = ast_waitfordigit(chan, ms);
1461                 if (res < 1)
1462                         break;
1463                 exten[strlen(exten) + 1] = '\0';
1464                 exten[strlen(exten)] = res;
1465         }
1466         return res > 0 ? 0 : res;
1467 }
1468
1469 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1470 {
1471         /* Execute an IVR menu structure */
1472         int res=0;
1473         int pos = 0;
1474         int retries = 0;
1475         char exten[AST_MAX_EXTENSION] = "s";
1476         if (option_exists(menu, "s") < 0) {
1477                 strcpy(exten, "g");
1478                 if (option_exists(menu, "g") < 0) {
1479                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
1480                         return -1;
1481                 }
1482         }
1483         while (!res) {
1484                 while (menu->options[pos].option) {
1485                         if (!strcasecmp(menu->options[pos].option, exten)) {
1486                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
1487                                 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
1488                                 if (res < 0)
1489                                         break;
1490                                 else if (res & RES_UPONE)
1491                                         return 0;
1492                                 else if (res & RES_EXIT)
1493                                         return res;
1494                                 else if (res & RES_REPEAT) {
1495                                         int maxretries = res & 0xffff;
1496                                         if ((res & RES_RESTART) == RES_RESTART) {
1497                                                 retries = 0;
1498                                         } else
1499                                                 retries++;
1500                                         if (!maxretries)
1501                                                 maxretries = 3;
1502                                         if ((maxretries > 0) && (retries >= maxretries)) {
1503                                                 ast_debug(1, "Max retries %d exceeded\n", maxretries);
1504                                                 return -2;
1505                                         } else {
1506                                                 if (option_exists(menu, "g") > -1) 
1507                                                         strcpy(exten, "g");
1508                                                 else if (option_exists(menu, "s") > -1)
1509                                                         strcpy(exten, "s");
1510                                         }
1511                                         pos = 0;
1512                                         continue;
1513                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
1514                                         ast_debug(1, "Got start of extension, %c\n", res);
1515                                         exten[1] = '\0';
1516                                         exten[0] = res;
1517                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten))))
1518                                                 break;
1519                                         if (option_exists(menu, exten) < 0) {
1520                                                 if (option_exists(menu, "i")) {
1521                                                         ast_debug(1, "Invalid extension entered, going to 'i'!\n");
1522                                                         strcpy(exten, "i");
1523                                                         pos = 0;
1524                                                         continue;
1525                                                 } else {
1526                                                         ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
1527                                                         res = -2;
1528                                                         break;
1529                                                 }
1530                                         } else {
1531                                                 ast_debug(1, "New existing extension: %s\n", exten);
1532                                                 pos = 0;
1533                                                 continue;
1534                                         }
1535                                 }
1536                         }
1537                         pos++;
1538                 }
1539                 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
1540                 pos = 0;
1541                 if (!strcasecmp(exten, "s"))
1542                         strcpy(exten, "g");
1543                 else
1544                         break;
1545         }
1546         return res;
1547 }
1548
1549 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1550 {
1551         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
1552         /* Hide internal coding */
1553         return res > 0 ? 0 : res;
1554 }
1555         
1556 char *ast_read_textfile(const char *filename)
1557 {
1558         int fd, count = 0, res;
1559         char *output = NULL;
1560         struct stat filesize;
1561
1562         if (stat(filename, &filesize) == -1) {
1563                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
1564                 return NULL;
1565         }
1566
1567         count = filesize.st_size + 1;
1568
1569         if ((fd = open(filename, O_RDONLY)) < 0) {
1570                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
1571                 return NULL;
1572         }
1573
1574         if ((output = ast_malloc(count))) {
1575                 res = read(fd, output, count - 1);
1576                 if (res == count - 1) {
1577                         output[res] = '\0';
1578                 } else {
1579                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
1580                         ast_free(output);
1581                         output = NULL;
1582                 }
1583         }
1584
1585         close(fd);
1586
1587         return output;
1588 }
1589
1590 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
1591 {
1592         char *s, *arg;
1593         int curarg, res = 0;
1594         unsigned int argloc;
1595
1596         ast_clear_flag(flags, AST_FLAGS_ALL);
1597
1598         if (!optstr)
1599                 return 0;
1600
1601         s = optstr;
1602         while (*s) {
1603                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1604                 ast_set_flag(flags, options[curarg].flag);
1605                 argloc = options[curarg].arg_index;
1606                 if (*s == '(') {
1607                         /* Has argument */
1608                         arg = ++s;
1609                         if ((s = strchr(s, ')'))) {
1610                                 if (argloc)
1611                                         args[argloc - 1] = arg;
1612                                 *s++ = '\0';
1613                         } else {
1614                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1615                                 res = -1;
1616                                 break;
1617                         }
1618                 } else if (argloc) {
1619                         args[argloc - 1] = NULL;
1620                 }
1621         }
1622
1623         return res;
1624 }
1625
1626 /* the following function will probably only be used in app_dial, until app_dial is reorganized to
1627    better handle the large number of options it provides. After it is, you need to get rid of this variant 
1628    -- unless, of course, someone else digs up some use for large flag fields. */
1629
1630 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
1631 {
1632         char *s, *arg;
1633         int curarg, res = 0;
1634         unsigned int argloc;
1635
1636         flags->flags = 0;
1637         
1638         if (!optstr)
1639                 return 0;
1640
1641         s = optstr;
1642         while (*s) {
1643                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1644                 ast_set_flag64(flags, options[curarg].flag);
1645                 argloc = options[curarg].arg_index;
1646                 if (*s == '(') {
1647                         /* Has argument */
1648                         arg = ++s;
1649                         if ((s = strchr(s, ')'))) {
1650                                 if (argloc)
1651                                         args[argloc - 1] = arg;
1652                                 *s++ = '\0';
1653                         } else {
1654                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1655                                 res = -1;
1656                                 break;
1657                         }
1658                 } else if (argloc) {
1659                         args[argloc - 1] = NULL;
1660                 }
1661         }
1662
1663         return res;
1664 }
1665
1666 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed)
1667 {
1668         int i;
1669         *consumed = 1;
1670         *result = 0;
1671         if (*stream == '\\') {
1672                 *consumed = 2;
1673                 switch (*(stream + 1)) {
1674                 case 'n':
1675                         *result = '\n';
1676                         break;
1677                 case 'r':
1678                         *result = '\r';
1679                         break;
1680                 case 't':
1681                         *result = '\t';
1682                         break;
1683                 case 'x':
1684                         /* Hexadecimal */
1685                         if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
1686                                 *consumed = 3;
1687                                 if (*(stream + 2) <= '9')
1688                                         *result = *(stream + 2) - '0';
1689                                 else if (*(stream + 2) <= 'F')
1690                                         *result = *(stream + 2) - 'A' + 10;
1691                                 else
1692                                         *result = *(stream + 2) - 'a' + 10;
1693                         } else {
1694                                 ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
1695                                 return -1;
1696                         }
1697
1698                         if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
1699                                 *consumed = 4;
1700                                 *result <<= 4;
1701                                 if (*(stream + 3) <= '9')
1702                                         *result += *(stream + 3) - '0';
1703                                 else if (*(stream + 3) <= 'F')
1704                                         *result += *(stream + 3) - 'A' + 10;
1705                                 else
1706                                         *result += *(stream + 3) - 'a' + 10;
1707                         }
1708                         break;
1709                 case '0':
1710                         /* Octal */
1711                         *consumed = 2;
1712                         for (i = 2; ; i++) {
1713                                 if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
1714                                         (*consumed)++;
1715                                         ast_debug(5, "result was %d, ", *result);
1716                                         *result <<= 3;
1717                                         *result += *(stream + i) - '0';
1718                                         ast_debug(5, "is now %d\n", *result);
1719                                 } else
1720                                         break;
1721                         }
1722                         break;
1723                 default:
1724                         *result = *(stream + 1);
1725                 }
1726         } else {
1727                 *result = *stream;
1728                 *consumed = 1;
1729         }
1730         return 0;
1731 }
1732