Whitespace changes only
[asterisk/asterisk.git] / app.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Convenient Application Routines
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <sys/time.h>
34 #include <signal.h>
35 #include <errno.h>
36 #include <unistd.h>
37 #include <dirent.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <regex.h>
41
42 #include "asterisk/channel.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/file.h"
45 #include "asterisk/app.h"
46 #include "asterisk/dsp.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/options.h"
49 #include "asterisk/utils.h"
50 #include "asterisk/lock.h"
51 #include "asterisk/indications.h"
52
53 #define MAX_OTHER_FORMATS 10
54
55
56 /* !
57 This function presents a dialtone and reads an extension into 'collect' 
58 which must be a pointer to a **pre-initialized** array of char having a 
59 size of 'size' suitable for writing to.  It will collect no more than the smaller 
60 of 'maxlen' or 'size' minus the original strlen() of collect digits.
61 \return 0 if extension does not exist, 1 if extension exists
62 */
63 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout) 
64 {
65         struct tone_zone_sound *ts;
66         int res=0, x=0;
67
68         if (maxlen > size)
69                 maxlen = size;
70         
71         if (!timeout && chan->pbx)
72                 timeout = chan->pbx->dtimeout;
73         else if (!timeout)
74                 timeout = 5;
75         
76         ts = ast_get_indication_tone(chan->zone,"dial");
77         if (ts && ts->data[0])
78                 res = ast_playtones_start(chan, 0, ts->data, 0);
79         else 
80                 ast_log(LOG_NOTICE,"Huh....? no dial for indications?\n");
81         
82         for (x = strlen(collect); x < maxlen; ) {
83                 res = ast_waitfordigit(chan, timeout);
84                 if (!ast_ignore_pattern(context, collect))
85                         ast_playtones_stop(chan);
86                 if (res < 1)
87                         break;
88                 collect[x++] = res;
89                 if (!ast_matchmore_extension(chan, context, collect, 1, chan->cid.cid_num)) {
90                         if (collect[x-1] == '#') {
91                                 /* Not a valid extension, ending in #, assume the # was to finish dialing */
92                                 collect[x-1] = '\0';
93                         }
94                         break;
95                 }
96         }
97         if (res >= 0)
98                 res = ast_exists_extension(chan, context, collect, 1, chan->cid.cid_num) ? 1 : 0;
99         return res;
100 }
101
102 /*! \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for 
103    "ludicrous time" (essentially never times out) */
104 int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout)
105 {
106         int res,to,fto;
107         /* XXX Merge with full version? XXX */
108         if (maxlen)
109                 s[0] = '\0';
110         if (prompt) {
111                 res = ast_streamfile(c, prompt, c->language);
112                 if (res < 0)
113                         return res;
114         }
115         fto = c->pbx ? c->pbx->rtimeout * 1000 : 6000;
116         to = c->pbx ? c->pbx->dtimeout * 1000 : 2000;
117
118         if (timeout > 0) 
119                 fto = to = timeout;
120         if (timeout < 0) 
121                 fto = to = 1000000000;
122         res = ast_readstring(c, s, maxlen, to, fto, "#");
123         return res;
124 }
125
126
127 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
128 {
129         int res, to, fto;
130         if (prompt) {
131                 res = ast_streamfile(c, prompt, c->language);
132                 if (res < 0)
133                         return res;
134         }
135         fto = 6000;
136         to = 2000;
137         if (timeout > 0) 
138                 fto = to = timeout;
139         if (timeout < 0) 
140                 fto = to = 1000000000;
141         res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
142         return res;
143 }
144
145 static int (*ast_has_voicemail_func)(const char *mailbox, const char *folder) = NULL;
146 static int (*ast_inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs) = NULL;
147 static int (*ast_messagecount_func)(const char *context, const char *mailbox, const char *folder) = NULL;
148
149 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
150                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
151                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder))
152 {
153         ast_has_voicemail_func = has_voicemail_func;
154         ast_inboxcount_func = inboxcount_func;
155         ast_messagecount_func = messagecount_func;
156 }
157
158 void ast_uninstall_vm_functions(void)
159 {
160         ast_has_voicemail_func = NULL;
161         ast_inboxcount_func = NULL;
162         ast_messagecount_func = NULL;
163 }
164
165 int ast_app_has_voicemail(const char *mailbox, const char *folder)
166 {
167         static int warned = 0;
168         if (ast_has_voicemail_func)
169                 return ast_has_voicemail_func(mailbox, folder);
170
171         if ((option_verbose > 2) && !warned) {
172                 ast_verbose(VERBOSE_PREFIX_3 "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
173                 warned++;
174         }
175         return 0;
176 }
177
178
179 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs)
180 {
181         static int warned = 0;
182         if (newmsgs)
183                 *newmsgs = 0;
184         if (oldmsgs)
185                 *oldmsgs = 0;
186         if (ast_inboxcount_func)
187                 return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
188
189         if (!warned && (option_verbose > 2)) {
190                 warned++;
191                 ast_verbose(VERBOSE_PREFIX_3 "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
192         }
193
194         return 0;
195 }
196
197 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder)
198 {
199         static int warned = 0;
200         if (ast_messagecount_func)
201                 return ast_messagecount_func(context, mailbox, folder);
202
203         if (!warned && (option_verbose > 2)) {
204                 warned++;
205                 ast_verbose(VERBOSE_PREFIX_3 "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
206         }
207
208         return 0;
209 }
210
211 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between) 
212 {
213         const char *ptr;
214         int res = 0;
215         struct ast_frame f = {
216                 .frametype = AST_FRAME_DTMF,
217                 .src = "ast_dtmf_stream"
218         };
219
220         if (!between)
221                 between = 100;
222
223         if (peer)
224                 res = ast_autoservice_start(peer);
225
226         if (!res)
227                 res = ast_waitfor(chan, 100);
228
229         /* ast_waitfor will return the number of remaining ms on success */
230         if (res < 0)
231                 return res;
232
233         for (ptr = digits; *ptr; ptr++) {
234                 if (*ptr == 'w') {
235                         /* 'w' -- wait half a second */
236                         if ((res = ast_safe_sleep(chan, 500)))
237                                 break;
238                 } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
239                         /* Character represents valid DTMF */
240                         if (*ptr == 'f' || *ptr == 'F') {
241                                 /* ignore return values if not supported by channel */
242                                 ast_indicate(chan, AST_CONTROL_FLASH);
243                         } else {
244                                 f.subclass = *ptr;
245                                 if ((res = ast_write(chan, &f)))
246                                         break;
247                         }
248                         /* pause between digits */
249                         if ((res = ast_safe_sleep(chan, between)))
250                                 break;
251                 } else
252                         ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n",*ptr);
253         }
254
255         if (peer) {
256                 /* Stop autoservice on the peer channel, but don't overwrite any error condition 
257                    that has occurred previously while acting on the primary channel */
258                 if (ast_autoservice_stop(peer) && !res)
259                         res = -1;
260         }
261
262         return res;
263 }
264
265 struct linear_state {
266         int fd;
267         int autoclose;
268         int allowoverride;
269         int origwfmt;
270 };
271
272 static void linear_release(struct ast_channel *chan, void *params)
273 {
274         struct linear_state *ls = params;
275         if (ls->origwfmt && ast_set_write_format(chan, ls->origwfmt)) {
276                 ast_log(LOG_WARNING, "Unable to restore channel '%s' to format '%d'\n", chan->name, ls->origwfmt);
277         }
278         if (ls->autoclose)
279                 close(ls->fd);
280         free(params);
281 }
282
283 static int linear_generator(struct ast_channel *chan, void *data, int len, int samples)
284 {
285         struct ast_frame f;
286         short buf[2048 + AST_FRIENDLY_OFFSET / 2];
287         struct linear_state *ls = data;
288         int res;
289         len = samples * 2;
290         if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
291                 ast_log(LOG_WARNING, "Can't generate %d bytes of data!\n" ,len);
292                 len = sizeof(buf) - AST_FRIENDLY_OFFSET;
293         }
294         memset(&f, 0, sizeof(f));
295         res = read(ls->fd, buf + AST_FRIENDLY_OFFSET/2, len);
296         if (res > 0) {
297                 f.frametype = AST_FRAME_VOICE;
298                 f.subclass = AST_FORMAT_SLINEAR;
299                 f.data = buf + AST_FRIENDLY_OFFSET/2;
300                 f.datalen = res;
301                 f.samples = res / 2;
302                 f.offset = AST_FRIENDLY_OFFSET;
303                 ast_write(chan, &f);
304                 if (res == len)
305                         return 0;
306         }
307         return -1;
308 }
309
310 static void *linear_alloc(struct ast_channel *chan, void *params)
311 {
312         struct linear_state *ls;
313         /* In this case, params is already malloc'd */
314         if (params) {
315                 ls = params;
316                 if (ls->allowoverride)
317                         ast_set_flag(chan, AST_FLAG_WRITE_INT);
318                 else
319                         ast_clear_flag(chan, AST_FLAG_WRITE_INT);
320                 ls->origwfmt = chan->writeformat;
321                 if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
322                         ast_log(LOG_WARNING, "Unable to set '%s' to linear format (write)\n", chan->name);
323                         free(ls);
324                         ls = params = NULL;
325                 }
326         }
327         return params;
328 }
329
330 static struct ast_generator linearstream = 
331 {
332         alloc: linear_alloc,
333         release: linear_release,
334         generate: linear_generator,
335 };
336
337 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride)
338 {
339         struct linear_state *lin;
340         char tmpf[256];
341         int res = -1;
342         int autoclose = 0;
343         if (fd < 0) {
344                 if (ast_strlen_zero(filename))
345                         return -1;
346                 autoclose = 1;
347                 if (filename[0] == '/') 
348                         ast_copy_string(tmpf, filename, sizeof(tmpf));
349                 else
350                         snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", (char *)ast_config_AST_DATA_DIR, "sounds", filename);
351                 fd = open(tmpf, O_RDONLY);
352                 if (fd < 0){
353                         ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
354                         return -1;
355                 }
356         }
357         if ((lin = ast_calloc(1, sizeof(*lin)))) {
358                 lin->fd = fd;
359                 lin->allowoverride = allowoverride;
360                 lin->autoclose = autoclose;
361                 res = ast_activate_generator(chan, &linearstream, lin);
362         }
363         return res;
364 }
365
366 int ast_control_streamfile(struct ast_channel *chan, const char *file,
367                            const char *fwd, const char *rev,
368                            const char *stop, const char *pause,
369                            const char *restart, int skipms) 
370 {
371         char *breaks = NULL;
372         char *end = NULL;
373         int blen = 2;
374         int res;
375         long pause_restart_point = 0;
376
377         if (stop)
378                 blen += strlen(stop);
379         if (pause)
380                 blen += strlen(pause);
381         if (restart)
382                 blen += strlen(restart);
383
384         if (blen > 2) {
385                 breaks = alloca(blen + 1);
386                 breaks[0] = '\0';
387                 if (stop)
388                         strcat(breaks, stop);
389                 if (pause)
390                         strcat(breaks, pause);
391                 if (restart)
392                         strcat(breaks, restart);
393         }
394         if (chan->_state != AST_STATE_UP)
395                 res = ast_answer(chan);
396
397         if (file) {
398                 if ((end = strchr(file,':'))) {
399                         if (!strcasecmp(end, ":end")) {
400                                 *end = '\0';
401                                 end++;
402                         }
403                 }
404         }
405
406         for (;;) {
407                 ast_stopstream(chan);
408                 res = ast_streamfile(chan, file, chan->language);
409                 if (!res) {
410                         if (pause_restart_point) {
411                                 ast_seekstream(chan->stream, pause_restart_point, SEEK_SET);
412                                 pause_restart_point = 0;
413                         }
414                         else if (end) {
415                                 ast_seekstream(chan->stream, 0, SEEK_END);
416                                 end = NULL;
417                         };
418                         res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
419                 }
420
421                 if (res < 1)
422                         break;
423
424                 /* We go at next loop if we got the restart char */
425                 if (restart && strchr(restart, res)) {
426                         ast_log(LOG_DEBUG, "we'll restart the stream here at next loop\n");
427                         pause_restart_point = 0;
428                         continue;
429                 }
430
431                 if (pause && strchr(pause, res)) {
432                         pause_restart_point = ast_tellstream(chan->stream);
433                         for (;;) {
434                                 ast_stopstream(chan);
435                                 res = ast_waitfordigit(chan, 1000);
436                                 if (!res)
437                                         continue;
438                                 else if (res == -1 || strchr(pause, res) || (stop && strchr(stop, res)))
439                                         break;
440                         }
441                         if (res == *pause) {
442                                 res = 0;
443                                 continue;
444                         }
445                 }
446
447                 if (res == -1)
448                         break;
449
450                 /* if we get one of our stop chars, return it to the calling function */
451                 if (stop && strchr(stop, res))
452                         break;
453         }
454
455         ast_stopstream(chan);
456
457         return res;
458 }
459
460 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
461 {
462         int d;
463         d = ast_streamfile(chan, fn, chan->language);
464         if (d)
465                 return d;
466         d = ast_waitstream(chan, AST_DIGIT_ANY);
467         ast_stopstream(chan);
468         return d;
469 }
470
471 static int global_silence_threshold = 128;
472 static int global_maxsilence = 0;
473
474 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
475  * @param chan Channel to playback to/record from.
476  * @param playfile Filename of sound to play before recording begins.
477  * @param recordfile Filename to record to.
478  * @param maxtime Maximum length of recording (in milliseconds).
479  * @param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
480  * @param duration Where to store actual length of the recorded message (in milliseconds).
481  * @param beep Whether to play a beep before starting to record.
482  * @param silencethreshold 
483  * @param maxsilence Length of silence that will end a recording (in milliseconds).
484  * @param path Optional filesystem path to unlock.
485  * @param prepend If true, prepend the recorded audio to an existing file.
486  * @param acceptdtmf DTMF digits that will end the recording.
487  * @param canceldtmf DTMF digits that will cancel the recording.
488  */
489
490 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)
491 {
492         int d = 0;
493         char *fmts;
494         char comment[256];
495         int x, fmtcnt = 1, res = -1, outmsg = 0;
496         struct ast_filestream *others[MAX_OTHER_FORMATS];
497         char *sfmt[MAX_OTHER_FORMATS];
498         char *stringp = NULL;
499         time_t start, end;
500         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
501         int totalsilence = 0;
502         int rfmt = 0;
503         struct ast_silence_generator *silgen = NULL;
504         char prependfile[80];
505
506         if (silencethreshold < 0)
507                 silencethreshold = global_silence_threshold;
508
509         if (maxsilence < 0)
510                 maxsilence = global_maxsilence;
511
512         /* barf if no pointer passed to store duration in */
513         if (duration == NULL) {
514                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
515                 return -1;
516         }
517
518         ast_log(LOG_DEBUG,"play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
519         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, chan->name);
520
521         if (playfile || beep) {
522                 if (!beep)
523                         d = ast_play_and_wait(chan, playfile);
524                 if (d > -1)
525                         d = ast_stream_and_wait(chan, "beep", chan->language, "");
526                 if (d < 0)
527                         return -1;
528         }
529
530         if (prepend) {
531                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));  
532                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
533         }
534
535         fmts = ast_strdupa(fmt);
536
537         stringp = fmts;
538         strsep(&stringp, "|");
539         ast_log(LOG_DEBUG, "Recording Formats: sfmts=%s\n", fmts);
540         sfmt[0] = ast_strdupa(fmts);
541
542         while ((fmt = strsep(&stringp, "|"))) {
543                 if (fmtcnt > MAX_OTHER_FORMATS - 1) {
544                         ast_log(LOG_WARNING, "Please increase MAX_OTHER_FORMATS in app.c\n");
545                         break;
546                 }
547                 sfmt[fmtcnt++] = ast_strdupa(fmt);
548         }
549
550         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
551         for (x = 0; x < fmtcnt; x++) {
552                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, 0700);
553                 if (option_verbose > 2)
554                         ast_verbose(VERBOSE_PREFIX_3 "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
555
556                 if (!others[x])
557                         break;
558         }
559
560         if (path)
561                 ast_unlock_path(path);
562
563         if (maxsilence > 0) {
564                 sildet = ast_dsp_new(); /* Create the silence detector */
565                 if (!sildet) {
566                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
567                         return -1;
568                 }
569                 ast_dsp_set_threshold(sildet, silencethreshold);
570                 rfmt = chan->readformat;
571                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
572                 if (res < 0) {
573                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
574                         ast_dsp_free(sildet);
575                         return -1;
576                 }
577         }
578
579         if (!prepend) {
580                 /* Request a video update */
581                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
582
583                 if (ast_opt_transmit_silence)
584                         silgen = ast_channel_start_silence_generator(chan);
585         }
586
587         if (x == fmtcnt) {
588                 /* Loop forever, writing the packets we read to the writer(s), until
589                    we read a digit or get a hangup */
590                 struct ast_frame *f;
591                 for (;;) {
592                         res = ast_waitfor(chan, 2000);
593                         if (!res) {
594                                 ast_log(LOG_DEBUG, "One waitfor failed, trying another\n");
595                                 /* Try one more time in case of masq */
596                                 res = ast_waitfor(chan, 2000);
597                                 if (!res) {
598                                         ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
599                                         res = -1;
600                                 }
601                         }
602
603                         if (res < 0) {
604                                 f = NULL;
605                                 break;
606                         }
607                         f = ast_read(chan);
608                         if (!f)
609                                 break;
610                         if (f->frametype == AST_FRAME_VOICE) {
611                                 /* write each format */
612                                 for (x = 0; x < fmtcnt; x++) {
613                                         if (prepend && !others[x])
614                                                 break;
615                                         res = ast_writestream(others[x], f);
616                                 }
617
618                                 /* Silence Detection */
619                                 if (maxsilence > 0) {
620                                         int dspsilence = 0;
621                                         ast_dsp_silence(sildet, f, &dspsilence);
622                                         if (dspsilence)
623                                                 totalsilence = dspsilence;
624                                         else
625                                                 totalsilence = 0;
626
627                                         if (totalsilence > maxsilence) {
628                                                 /* Ended happily with silence */
629                                                 if (option_verbose > 2)
630                                                         ast_verbose( VERBOSE_PREFIX_3 "Recording automatically stopped after a silence of %d seconds\n", totalsilence/1000);
631                                                 res = 'S';
632                                                 outmsg = 2;
633                                                 break;
634                                         }
635                                 }
636                                 /* Exit on any error */
637                                 if (res) {
638                                         ast_log(LOG_WARNING, "Error writing frame\n");
639                                         break;
640                                 }
641                         } else if (f->frametype == AST_FRAME_VIDEO) {
642                                 /* Write only once */
643                                 ast_writestream(others[0], f);
644                         } else if (f->frametype == AST_FRAME_DTMF) {
645                                 if (prepend) {
646                                 /* stop recording with any digit */
647                                         if (option_verbose > 2) 
648                                                 ast_verbose(VERBOSE_PREFIX_3 "User ended message by pressing %c\n", f->subclass);
649                                         res = 't';
650                                         outmsg = 2;
651                                         break;
652                                 }
653                                 if (strchr(acceptdtmf, f->subclass)) {
654                                         if (option_verbose > 2)
655                                                 ast_verbose(VERBOSE_PREFIX_3 "User ended message by pressing %c\n", f->subclass);
656                                         res = f->subclass;
657                                         outmsg = 2;
658                                         break;
659                                 }
660                                 if (strchr(canceldtmf, f->subclass)) {
661                                         if (option_verbose > 2)
662                                                 ast_verbose(VERBOSE_PREFIX_3 "User cancelled message by pressing %c\n", f->subclass);
663                                         res = f->subclass;
664                                         outmsg = 0;
665                                         break;
666                                 }
667                         }
668                         if (maxtime) {
669                                 end = time(NULL);
670                                 if (maxtime < (end - start)) {
671                                         if (option_verbose > 2)
672                                                 ast_verbose(VERBOSE_PREFIX_3 "Took too long, cutting it short...\n");
673                                         res = 't';
674                                         outmsg = 2;
675                                         break;
676                                 }
677                         }
678                         ast_frfree(f);
679                 }
680                 if (!f) {
681                         if (option_verbose > 2)
682                                 ast_verbose(VERBOSE_PREFIX_3 "User hung up\n");
683                         res = -1;
684                         outmsg = 1;
685                 } else {
686                         ast_frfree(f);
687                 }
688                 if (end == start)
689                         end = time(NULL);
690         } else {
691                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
692         }
693
694         if (!prepend) {
695                 if (silgen)
696                         ast_channel_stop_silence_generator(chan, silgen);
697         }
698         *duration = end - start;
699
700         if (!prepend) {
701                 for (x = 0; x < fmtcnt; x++) {
702                         if (!others[x])
703                                 break;
704                         if (res > 0)
705                                 ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
706                         ast_truncstream(others[x]);
707                         ast_closestream(others[x]);
708                 }
709         }
710
711         if (prepend && outmsg) {
712                 struct ast_filestream *realfiles[MAX_OTHER_FORMATS];
713                 struct ast_frame *fr;
714
715                 for (x = 0; x < fmtcnt; x++) {
716                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
717                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
718                         if (!others[x] || !realfiles[x])
719                                 break;
720                         ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
721                         ast_truncstream(others[x]);
722                         /* add the original file too */
723                         while ((fr = ast_readframe(realfiles[x]))) {
724                                 ast_writestream(others[x], fr);
725                                 ast_frfree(fr);
726                         }
727                         ast_closestream(others[x]);
728                         ast_closestream(realfiles[x]);
729                         ast_filerename(prependfile, recordfile, sfmt[x]);
730                         if (option_verbose > 3)
731                                 ast_verbose(VERBOSE_PREFIX_4 "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
732                         ast_filedelete(prependfile, sfmt[x]);
733                 }
734         }
735         if (rfmt && ast_set_read_format(chan, rfmt)) {
736                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
737         }
738         if (outmsg == 2) {
739                 ast_stream_and_wait(chan, "auth-thankyou", chan->language, "");
740         }
741         if (sildet)
742                 ast_dsp_free(sildet);
743         return res;
744 }
745
746 static char default_acceptdtmf[] = "#";
747 static char default_canceldtmf[] = "";
748
749 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)
750 {
751         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));
752 }
753
754 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)
755 {
756         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
757 }
758
759 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)
760 {
761         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
762 }
763
764 /* Channel group core functions */
765
766 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
767 {
768         int res=0;
769         char tmp[256];
770         char *grp=NULL, *cat=NULL;
771
772         if (!ast_strlen_zero(data)) {
773                 ast_copy_string(tmp, data, sizeof(tmp));
774                 grp = tmp;
775                 cat = strchr(tmp, '@');
776                 if (cat) {
777                         *cat = '\0';
778                         cat++;
779                 }
780         }
781
782         if (!ast_strlen_zero(grp))
783                 ast_copy_string(group, grp, group_max);
784         else
785                 res = -1;
786
787         if (cat)
788                 snprintf(category, category_max, "%s_%s", GROUP_CATEGORY_PREFIX, cat);
789         else
790                 ast_copy_string(category, GROUP_CATEGORY_PREFIX, category_max);
791
792         return res;
793 }
794
795 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
796 {
797         int res=0;
798         char group[80] = "";
799         char category[80] = "";
800
801         if (!ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
802                 pbx_builtin_setvar_helper(chan, category, group);
803         } else
804                 res = -1;
805
806         return res;
807 }
808
809 int ast_app_group_get_count(const char *group, const char *category)
810 {
811         struct ast_channel *chan;
812         int count = 0;
813         const char *test;
814         char cat[80];
815         const char *s;
816
817         if (ast_strlen_zero(group))
818                 return 0;
819
820         s = S_OR(category, GROUP_CATEGORY_PREFIX);
821         ast_copy_string(cat, s, sizeof(cat));
822
823         chan = NULL;
824         while ((chan = ast_channel_walk_locked(chan)) != NULL) {
825                 test = pbx_builtin_getvar_helper(chan, cat);
826                 if (test && !strcasecmp(test, group))
827                         count++;
828                 ast_channel_unlock(chan);
829         }
830
831         return count;
832 }
833
834 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
835 {
836         regex_t regexbuf;
837         struct ast_channel *chan;
838         int count = 0;
839         const char *test;
840         char cat[80];
841         const char *s;
842
843         if (ast_strlen_zero(groupmatch))
844                 return 0;
845
846         /* if regex compilation fails, return zero matches */
847         if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
848                 return 0;
849
850         s = S_OR(category, GROUP_CATEGORY_PREFIX);
851         ast_copy_string(cat, s, sizeof(cat));
852
853         chan = NULL;
854         while ((chan = ast_channel_walk_locked(chan)) != NULL) {
855                 test = pbx_builtin_getvar_helper(chan, cat);
856                 if (test && !regexec(&regexbuf, test, 0, NULL, 0))
857                         count++;
858                 ast_channel_unlock(chan);
859         }
860
861         regfree(&regexbuf);
862
863         return count;
864 }
865
866 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
867 {
868         int argc;
869         char *scan;
870         int paren = 0, quote = 0;
871
872         if (!buf || !array || !arraylen)
873                 return 0;
874
875         memset(array, 0, arraylen * sizeof(*array));
876
877         scan = buf;
878
879         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
880                 array[argc] = scan;
881                 for (; *scan; scan++) {
882                         if (*scan == '(')
883                                 paren++;
884                         else if (*scan == ')') {
885                                 if (paren)
886                                         paren--;
887                         } else if (*scan == '"') {
888                                 quote = quote ? 0 : 1;
889                                 /* Remove quote character from argument */
890                                 memmove(scan, scan + 1, strlen(scan));
891                                 scan--;
892                         } else if (*scan == '\\') {
893                                 /* Literal character, don't parse */
894                                 memmove(scan, scan + 1, strlen(scan));
895                         } else if ((*scan == delim) && !paren && !quote) {
896                                 *scan++ = '\0';
897                                 break;
898                         }
899                 }
900         }
901
902         if (*scan)
903                 array[argc++] = scan;
904
905         return argc;
906 }
907
908 enum AST_LOCK_RESULT ast_lock_path(const char *path)
909 {
910         char *s;
911         char *fs;
912         int res;
913         int fd;
914         int lp = strlen(path);
915         time_t start;
916
917         if (!(s = alloca(lp + 10)) || !(fs = alloca(lp + 20))) {
918                 ast_log(LOG_WARNING, "Out of memory!\n");
919                 return AST_LOCK_FAILURE;
920         }
921
922         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
923         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, 0600);
924         if (fd < 0) {
925                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
926                 return AST_LOCK_PATH_NOT_FOUND;
927         }
928         close(fd);
929
930         snprintf(s, strlen(path) + 9, "%s/.lock", path);
931         start = time(NULL);
932         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
933                 usleep(1);
934         if (res) {
935                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
936                 return AST_LOCK_TIMEOUT;
937         } else {
938                 unlink(fs);
939                 ast_log(LOG_DEBUG, "Locked path '%s'\n", path);
940                 return AST_LOCK_SUCCESS;
941         }
942 }
943
944 int ast_unlock_path(const char *path)
945 {
946         char *s;
947         if (!(s = alloca(strlen(path) + 10)))
948                 return -1;
949         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
950         ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
951         return unlink(s);
952 }
953
954 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path) 
955 {
956         int silencethreshold = 128; 
957         int maxsilence=0;
958         int res = 0;
959         int cmd = 0;
960         int max_attempts = 3;
961         int attempts = 0;
962         int recorded = 0;
963         int message_exists = 0;
964         /* Note that urgent and private are for flagging messages as such in the future */
965
966         /* barf if no pointer passed to store duration in */
967         if (duration == NULL) {
968                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
969                 return -1;
970         }
971
972         cmd = '3';       /* Want to start by recording */
973
974         while ((cmd >= 0) && (cmd != 't')) {
975                 switch (cmd) {
976                 case '1':
977                         if (!message_exists) {
978                                 /* In this case, 1 is to record a message */
979                                 cmd = '3';
980                                 break;
981                         } else {
982                                 ast_stream_and_wait(chan, "vm-msgsaved", chan->language, "");
983                                 cmd = 't';
984                                 return res;
985                         }
986                 case '2':
987                         /* Review */
988                         ast_verbose(VERBOSE_PREFIX_3 "Reviewing the recording\n");
989                         cmd = ast_stream_and_wait(chan, recordfile, chan->language, AST_DIGIT_ANY);
990                         break;
991                 case '3':
992                         message_exists = 0;
993                         /* Record */
994                         if (recorded == 1)
995                                 ast_verbose(VERBOSE_PREFIX_3 "Re-recording\n");
996                         else    
997                                 ast_verbose(VERBOSE_PREFIX_3 "Recording\n");
998                         recorded = 1;
999                         cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
1000                         if (cmd == -1) {
1001                         /* User has hung up, no options to give */
1002                                 return cmd;
1003                         }
1004                         if (cmd == '0') {
1005                                 break;
1006                         } else if (cmd == '*') {
1007                                 break;
1008                         } 
1009                         else {
1010                                 /* If all is well, a message exists */
1011                                 message_exists = 1;
1012                                 cmd = 0;
1013                         }
1014                         break;
1015                 case '4':
1016                 case '5':
1017                 case '6':
1018                 case '7':
1019                 case '8':
1020                 case '9':
1021                 case '*':
1022                 case '#':
1023                         cmd = ast_play_and_wait(chan, "vm-sorry");
1024                         break;
1025                 default:
1026                         if (message_exists) {
1027                                 cmd = ast_play_and_wait(chan, "vm-review");
1028                         }
1029                         else {
1030                                 cmd = ast_play_and_wait(chan, "vm-torerecord");
1031                                 if (!cmd)
1032                                         cmd = ast_waitfordigit(chan, 600);
1033                         }
1034                         
1035                         if (!cmd)
1036                                 cmd = ast_waitfordigit(chan, 6000);
1037                         if (!cmd) {
1038                                 attempts++;
1039                         }
1040                         if (attempts > max_attempts) {
1041                                 cmd = 't';
1042                         }
1043                 }
1044         }
1045         if (cmd == 't')
1046                 cmd = 0;
1047         return cmd;
1048 }
1049
1050 #define RES_UPONE (1 << 16)
1051 #define RES_EXIT  (1 << 17)
1052 #define RES_REPEAT (1 << 18)
1053 #define RES_RESTART ((1 << 19) | RES_REPEAT)
1054
1055 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
1056
1057 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
1058 {
1059         int res;
1060         int (*ivr_func)(struct ast_channel *, void *);
1061         char *c;
1062         char *n;
1063         
1064         switch(option->action) {
1065         case AST_ACTION_UPONE:
1066                 return RES_UPONE;
1067         case AST_ACTION_EXIT:
1068                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
1069         case AST_ACTION_REPEAT:
1070                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
1071         case AST_ACTION_RESTART:
1072                 return RES_RESTART ;
1073         case AST_ACTION_NOOP:
1074                 return 0;
1075         case AST_ACTION_BACKGROUND:
1076                 res = ast_stream_and_wait(chan, (char *)option->adata, chan->language, AST_DIGIT_ANY);
1077                 if (res < 0) {
1078                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1079                         res = 0;
1080                 }
1081                 return res;
1082         case AST_ACTION_PLAYBACK:
1083                 res = ast_stream_and_wait(chan, (char *)option->adata, chan->language, "");
1084                 if (res < 0) {
1085                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1086                         res = 0;
1087                 }
1088                 return res;
1089         case AST_ACTION_MENU:
1090                 res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata);
1091                 /* Do not pass entry errors back up, treaat ast though ti was an "UPONE" */
1092                 if (res == -2)
1093                         res = 0;
1094                 return res;
1095         case AST_ACTION_WAITOPTION:
1096                 res = ast_waitfordigit(chan, 1000 * (chan->pbx ? chan->pbx->rtimeout : 10));
1097                 if (!res)
1098                         return 't';
1099                 return res;
1100         case AST_ACTION_CALLBACK:
1101                 ivr_func = option->adata;
1102                 res = ivr_func(chan, cbdata);
1103                 return res;
1104         case AST_ACTION_TRANSFER:
1105                 res = ast_parseable_goto(chan, option->adata);
1106                 return 0;
1107         case AST_ACTION_PLAYLIST:
1108         case AST_ACTION_BACKLIST:
1109                 res = 0;
1110                 c = ast_strdupa(option->adata);
1111                 while ((n = strsep(&c, ";"))) {
1112                         if ((res = ast_stream_and_wait(chan, n, chan->language,
1113                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : "")))
1114                                 break;
1115                 }
1116                 ast_stopstream(chan);
1117                 return res;
1118         default:
1119                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
1120                 return 0;
1121         };
1122         return -1;
1123 }
1124
1125 static int option_exists(struct ast_ivr_menu *menu, char *option)
1126 {
1127         int x;
1128         for (x = 0; menu->options[x].option; x++)
1129                 if (!strcasecmp(menu->options[x].option, option))
1130                         return x;
1131         return -1;
1132 }
1133
1134 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
1135 {
1136         int x;
1137         for (x = 0; menu->options[x].option; x++)
1138                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) && 
1139                                 (menu->options[x].option[strlen(option)]))
1140                         return x;
1141         return -1;
1142 }
1143
1144 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
1145 {
1146         int res=0;
1147         int ms;
1148         while (option_matchmore(menu, exten)) {
1149                 ms = chan->pbx ? chan->pbx->dtimeout : 5000;
1150                 if (strlen(exten) >= maxexten - 1) 
1151                         break;
1152                 res = ast_waitfordigit(chan, ms);
1153                 if (res < 1)
1154                         break;
1155                 exten[strlen(exten) + 1] = '\0';
1156                 exten[strlen(exten)] = res;
1157         }
1158         return res > 0 ? 0 : res;
1159 }
1160
1161 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1162 {
1163         /* Execute an IVR menu structure */
1164         int res=0;
1165         int pos = 0;
1166         int retries = 0;
1167         char exten[AST_MAX_EXTENSION] = "s";
1168         if (option_exists(menu, "s") < 0) {
1169                 strcpy(exten, "g");
1170                 if (option_exists(menu, "g") < 0) {
1171                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
1172                         return -1;
1173                 }
1174         }
1175         while(!res) {
1176                 while(menu->options[pos].option) {
1177                         if (!strcasecmp(menu->options[pos].option, exten)) {
1178                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
1179                                 ast_log(LOG_DEBUG, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
1180                                 if (res < 0)
1181                                         break;
1182                                 else if (res & RES_UPONE)
1183                                         return 0;
1184                                 else if (res & RES_EXIT)
1185                                         return res;
1186                                 else if (res & RES_REPEAT) {
1187                                         int maxretries = res & 0xffff;
1188                                         if ((res & RES_RESTART) == RES_RESTART) {
1189                                                 retries = 0;
1190                                         } else
1191                                                 retries++;
1192                                         if (!maxretries)
1193                                                 maxretries = 3;
1194                                         if ((maxretries > 0) && (retries >= maxretries)) {
1195                                                 ast_log(LOG_DEBUG, "Max retries %d exceeded\n", maxretries);
1196                                                 return -2;
1197                                         } else {
1198                                                 if (option_exists(menu, "g") > -1) 
1199                                                         strcpy(exten, "g");
1200                                                 else if (option_exists(menu, "s") > -1)
1201                                                         strcpy(exten, "s");
1202                                         }
1203                                         pos = 0;
1204                                         continue;
1205                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
1206                                         ast_log(LOG_DEBUG, "Got start of extension, %c\n", res);
1207                                         exten[1] = '\0';
1208                                         exten[0] = res;
1209                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten))))
1210                                                 break;
1211                                         if (option_exists(menu, exten) < 0) {
1212                                                 if (option_exists(menu, "i")) {
1213                                                         ast_log(LOG_DEBUG, "Invalid extension entered, going to 'i'!\n");
1214                                                         strcpy(exten, "i");
1215                                                         pos = 0;
1216                                                         continue;
1217                                                 } else {
1218                                                         ast_log(LOG_DEBUG, "Aborting on invalid entry, with no 'i' option!\n");
1219                                                         res = -2;
1220                                                         break;
1221                                                 }
1222                                         } else {
1223                                                 ast_log(LOG_DEBUG, "New existing extension: %s\n", exten);
1224                                                 pos = 0;
1225                                                 continue;
1226                                         }
1227                                 }
1228                         }
1229                         pos++;
1230                 }
1231                 ast_log(LOG_DEBUG, "Stopping option '%s', res is %d\n", exten, res);
1232                 pos = 0;
1233                 if (!strcasecmp(exten, "s"))
1234                         strcpy(exten, "g");
1235                 else
1236                         break;
1237         }
1238         return res;
1239 }
1240
1241 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1242 {
1243         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
1244         /* Hide internal coding */
1245         return res > 0 ? 0 : res;
1246 }
1247         
1248 char *ast_read_textfile(const char *filename)
1249 {
1250         int fd;
1251         char *output = NULL;
1252         struct stat filesize;
1253         int count = 0;
1254         int res;
1255         if (stat(filename, &filesize) == -1) {
1256                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
1257                 return NULL;
1258         }
1259         count = filesize.st_size + 1;
1260         fd = open(filename, O_RDONLY);
1261         if (fd < 0) {
1262                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
1263                 return NULL;
1264         }
1265         if ((output = ast_malloc(count))) {
1266                 res = read(fd, output, count - 1);
1267                 if (res == count - 1) {
1268                         output[res] = '\0';
1269                 } else {
1270                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
1271                         free(output);
1272                         output = NULL;
1273                 }
1274         }
1275         close(fd);
1276         return output;
1277 }
1278
1279 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
1280 {
1281         char *s;
1282         int curarg;
1283         unsigned int argloc;
1284         char *arg;
1285         int res = 0;
1286
1287         ast_clear_flag(flags, AST_FLAGS_ALL);
1288
1289         if (!optstr)
1290                 return 0;
1291
1292         s = optstr;
1293         while (*s) {
1294                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1295                 ast_set_flag(flags, options[curarg].flag);
1296                 argloc = options[curarg].arg_index;
1297                 if (*s == '(') {
1298                         /* Has argument */
1299                         arg = ++s;
1300                         s = strchr(s, ')');
1301                         if (*s) {
1302                                 if (argloc)
1303                                         args[argloc - 1] = arg;
1304                                 *s++ = '\0';
1305                         } else {
1306                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1307                                 res = -1;
1308                         }
1309                 } else if (argloc) {
1310                         args[argloc - 1] = NULL;
1311                 }
1312         }
1313
1314         return res;
1315 }
1316