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