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