bug #8076 check option_debug before printing to debug channel.
[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                         if (option_debug)
420                                 ast_log(LOG_DEBUG, "we'll restart the stream here at next loop\n");
421                         pause_restart_point = 0;
422                         continue;
423                 }
424
425                 if (pause && strchr(pause, res)) {
426                         pause_restart_point = ast_tellstream(chan->stream);
427                         for (;;) {
428                                 ast_stopstream(chan);
429                                 res = ast_waitfordigit(chan, 1000);
430                                 if (!res)
431                                         continue;
432                                 else if (res == -1 || strchr(pause, res) || (stop && strchr(stop, res)))
433                                         break;
434                         }
435                         if (res == *pause) {
436                                 res = 0;
437                                 continue;
438                         }
439                 }
440
441                 if (res == -1)
442                         break;
443
444                 /* if we get one of our stop chars, return it to the calling function */
445                 if (stop && strchr(stop, res))
446                         break;
447         }
448
449         ast_stopstream(chan);
450
451         return res;
452 }
453
454 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
455 {
456         int d;
457         d = ast_streamfile(chan, fn, chan->language);
458         if (d)
459                 return d;
460         d = ast_waitstream(chan, AST_DIGIT_ANY);
461         ast_stopstream(chan);
462         return d;
463 }
464
465 static int global_silence_threshold = 128;
466 static int global_maxsilence = 0;
467
468 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
469  * @param chan Channel to playback to/record from.
470  * @param playfile Filename of sound to play before recording begins.
471  * @param recordfile Filename to record to.
472  * @param maxtime Maximum length of recording (in milliseconds).
473  * @param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
474  * @param duration Where to store actual length of the recorded message (in milliseconds).
475  * @param beep Whether to play a beep before starting to record.
476  * @param silencethreshold 
477  * @param maxsilence Length of silence that will end a recording (in milliseconds).
478  * @param path Optional filesystem path to unlock.
479  * @param prepend If true, prepend the recorded audio to an existing file.
480  * @param acceptdtmf DTMF digits that will end the recording.
481  * @param canceldtmf DTMF digits that will cancel the recording.
482  */
483
484 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)
485 {
486         int d = 0;
487         char *fmts;
488         char comment[256];
489         int x, fmtcnt = 1, res = -1, outmsg = 0;
490         struct ast_filestream *others[MAX_OTHER_FORMATS];
491         char *sfmt[MAX_OTHER_FORMATS];
492         char *stringp = NULL;
493         time_t start, end;
494         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
495         int totalsilence = 0;
496         int rfmt = 0;
497         struct ast_silence_generator *silgen = NULL;
498         char prependfile[80];
499
500         if (silencethreshold < 0)
501                 silencethreshold = global_silence_threshold;
502
503         if (maxsilence < 0)
504                 maxsilence = global_maxsilence;
505
506         /* barf if no pointer passed to store duration in */
507         if (duration == NULL) {
508                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
509                 return -1;
510         }
511
512         if (option_debug)
513                 ast_log(LOG_DEBUG,"play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
514         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, chan->name);
515
516         if (playfile || beep) {
517                 if (!beep)
518                         d = ast_play_and_wait(chan, playfile);
519                 if (d > -1)
520                         d = ast_stream_and_wait(chan, "beep", chan->language, "");
521                 if (d < 0)
522                         return -1;
523         }
524
525         if (prepend) {
526                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));  
527                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
528         }
529
530         fmts = ast_strdupa(fmt);
531
532         stringp = fmts;
533         strsep(&stringp, "|");
534         if (option_debug)
535                 ast_log(LOG_DEBUG, "Recording Formats: sfmts=%s\n", fmts);
536         sfmt[0] = ast_strdupa(fmts);
537
538         while ((fmt = strsep(&stringp, "|"))) {
539                 if (fmtcnt > MAX_OTHER_FORMATS - 1) {
540                         ast_log(LOG_WARNING, "Please increase MAX_OTHER_FORMATS in app.c\n");
541                         break;
542                 }
543                 sfmt[fmtcnt++] = ast_strdupa(fmt);
544         }
545
546         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
547         for (x = 0; x < fmtcnt; x++) {
548                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, 0700);
549                 if (option_verbose > 2)
550                         ast_verbose(VERBOSE_PREFIX_3 "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
551
552                 if (!others[x])
553                         break;
554         }
555
556         if (path)
557                 ast_unlock_path(path);
558
559         if (maxsilence > 0) {
560                 sildet = ast_dsp_new(); /* Create the silence detector */
561                 if (!sildet) {
562                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
563                         return -1;
564                 }
565                 ast_dsp_set_threshold(sildet, silencethreshold);
566                 rfmt = chan->readformat;
567                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
568                 if (res < 0) {
569                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
570                         ast_dsp_free(sildet);
571                         return -1;
572                 }
573         }
574
575         if (!prepend) {
576                 /* Request a video update */
577                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
578
579                 if (ast_opt_transmit_silence)
580                         silgen = ast_channel_start_silence_generator(chan);
581         }
582
583         if (x == fmtcnt) {
584                 /* Loop forever, writing the packets we read to the writer(s), until
585                    we read a digit or get a hangup */
586                 struct ast_frame *f;
587                 for (;;) {
588                         res = ast_waitfor(chan, 2000);
589                         if (!res) {
590                                 if (option_debug)
591                                         ast_log(LOG_DEBUG, "One waitfor failed, trying another\n");
592                                 /* Try one more time in case of masq */
593                                 res = ast_waitfor(chan, 2000);
594                                 if (!res) {
595                                         ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
596                                         res = -1;
597                                 }
598                         }
599
600                         if (res < 0) {
601                                 f = NULL;
602                                 break;
603                         }
604                         f = ast_read(chan);
605                         if (!f)
606                                 break;
607                         if (f->frametype == AST_FRAME_VOICE) {
608                                 /* write each format */
609                                 for (x = 0; x < fmtcnt; x++) {
610                                         if (prepend && !others[x])
611                                                 break;
612                                         res = ast_writestream(others[x], f);
613                                 }
614
615                                 /* Silence Detection */
616                                 if (maxsilence > 0) {
617                                         int dspsilence = 0;
618                                         ast_dsp_silence(sildet, f, &dspsilence);
619                                         if (dspsilence)
620                                                 totalsilence = dspsilence;
621                                         else
622                                                 totalsilence = 0;
623
624                                         if (totalsilence > maxsilence) {
625                                                 /* Ended happily with silence */
626                                                 if (option_verbose > 2)
627                                                         ast_verbose( VERBOSE_PREFIX_3 "Recording automatically stopped after a silence of %d seconds\n", totalsilence/1000);
628                                                 res = 'S';
629                                                 outmsg = 2;
630                                                 break;
631                                         }
632                                 }
633                                 /* Exit on any error */
634                                 if (res) {
635                                         ast_log(LOG_WARNING, "Error writing frame\n");
636                                         break;
637                                 }
638                         } else if (f->frametype == AST_FRAME_VIDEO) {
639                                 /* Write only once */
640                                 ast_writestream(others[0], f);
641                         } else if (f->frametype == AST_FRAME_DTMF) {
642                                 if (prepend) {
643                                 /* stop recording with any digit */
644                                         if (option_verbose > 2) 
645                                                 ast_verbose(VERBOSE_PREFIX_3 "User ended message by pressing %c\n", f->subclass);
646                                         res = 't';
647                                         outmsg = 2;
648                                         break;
649                                 }
650                                 if (strchr(acceptdtmf, f->subclass)) {
651                                         if (option_verbose > 2)
652                                                 ast_verbose(VERBOSE_PREFIX_3 "User ended message by pressing %c\n", f->subclass);
653                                         res = f->subclass;
654                                         outmsg = 2;
655                                         break;
656                                 }
657                                 if (strchr(canceldtmf, f->subclass)) {
658                                         if (option_verbose > 2)
659                                                 ast_verbose(VERBOSE_PREFIX_3 "User cancelled message by pressing %c\n", f->subclass);
660                                         res = f->subclass;
661                                         outmsg = 0;
662                                         break;
663                                 }
664                         }
665                         if (maxtime) {
666                                 end = time(NULL);
667                                 if (maxtime < (end - start)) {
668                                         if (option_verbose > 2)
669                                                 ast_verbose(VERBOSE_PREFIX_3 "Took too long, cutting it short...\n");
670                                         res = 't';
671                                         outmsg = 2;
672                                         break;
673                                 }
674                         }
675                         ast_frfree(f);
676                 }
677                 if (!f) {
678                         if (option_verbose > 2)
679                                 ast_verbose(VERBOSE_PREFIX_3 "User hung up\n");
680                         res = -1;
681                         outmsg = 1;
682                 } else {
683                         ast_frfree(f);
684                 }
685                 if (end == start)
686                         end = time(NULL);
687         } else {
688                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
689         }
690
691         if (!prepend) {
692                 if (silgen)
693                         ast_channel_stop_silence_generator(chan, silgen);
694         }
695         *duration = end - start;
696
697         if (!prepend) {
698                 for (x = 0; x < fmtcnt; x++) {
699                         if (!others[x])
700                                 break;
701                         if (res > 0)
702                                 ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
703                         ast_truncstream(others[x]);
704                         ast_closestream(others[x]);
705                 }
706         }
707
708         if (prepend && outmsg) {
709                 struct ast_filestream *realfiles[MAX_OTHER_FORMATS];
710                 struct ast_frame *fr;
711
712                 for (x = 0; x < fmtcnt; x++) {
713                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
714                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
715                         if (!others[x] || !realfiles[x])
716                                 break;
717                         ast_stream_rewind(others[x], totalsilence ? totalsilence - 200 : 200);
718                         ast_truncstream(others[x]);
719                         /* add the original file too */
720                         while ((fr = ast_readframe(realfiles[x]))) {
721                                 ast_writestream(others[x], fr);
722                                 ast_frfree(fr);
723                         }
724                         ast_closestream(others[x]);
725                         ast_closestream(realfiles[x]);
726                         ast_filerename(prependfile, recordfile, sfmt[x]);
727                         if (option_verbose > 3)
728                                 ast_verbose(VERBOSE_PREFIX_4 "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
729                         ast_filedelete(prependfile, sfmt[x]);
730                 }
731         }
732         if (rfmt && ast_set_read_format(chan, rfmt)) {
733                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
734         }
735         if (outmsg == 2) {
736                 ast_stream_and_wait(chan, "auth-thankyou", chan->language, "");
737         }
738         if (sildet)
739                 ast_dsp_free(sildet);
740         return res;
741 }
742
743 static char default_acceptdtmf[] = "#";
744 static char default_canceldtmf[] = "";
745
746 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)
747 {
748         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));
749 }
750
751 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)
752 {
753         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf);
754 }
755
756 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)
757 {
758         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf);
759 }
760
761 /* Channel group core functions */
762
763 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
764 {
765         int res=0;
766         char tmp[256];
767         char *grp=NULL, *cat=NULL;
768
769         if (!ast_strlen_zero(data)) {
770                 ast_copy_string(tmp, data, sizeof(tmp));
771                 grp = tmp;
772                 cat = strchr(tmp, '@');
773                 if (cat) {
774                         *cat = '\0';
775                         cat++;
776                 }
777         }
778
779         if (!ast_strlen_zero(grp))
780                 ast_copy_string(group, grp, group_max);
781         else
782                 res = -1;
783
784         if (cat)
785                 snprintf(category, category_max, "%s_%s", GROUP_CATEGORY_PREFIX, cat);
786         else
787                 ast_copy_string(category, GROUP_CATEGORY_PREFIX, category_max);
788
789         return res;
790 }
791
792 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
793 {
794         int res=0;
795         char group[80] = "";
796         char category[80] = "";
797
798         if (!ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
799                 pbx_builtin_setvar_helper(chan, category, group);
800         } else
801                 res = -1;
802
803         return res;
804 }
805
806 int ast_app_group_get_count(const char *group, const char *category)
807 {
808         struct ast_channel *chan;
809         int count = 0;
810         const char *test;
811         char cat[80];
812         const char *s;
813
814         if (ast_strlen_zero(group))
815                 return 0;
816
817         s = S_OR(category, GROUP_CATEGORY_PREFIX);
818         ast_copy_string(cat, s, sizeof(cat));
819
820         chan = NULL;
821         while ((chan = ast_channel_walk_locked(chan)) != NULL) {
822                 test = pbx_builtin_getvar_helper(chan, cat);
823                 if (test && !strcasecmp(test, group))
824                         count++;
825                 ast_channel_unlock(chan);
826         }
827
828         return count;
829 }
830
831 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
832 {
833         regex_t regexbuf;
834         struct ast_channel *chan;
835         int count = 0;
836         const char *test;
837         char cat[80];
838         const char *s;
839
840         if (ast_strlen_zero(groupmatch))
841                 return 0;
842
843         /* if regex compilation fails, return zero matches */
844         if (regcomp(&regexbuf, groupmatch, REG_EXTENDED | REG_NOSUB))
845                 return 0;
846
847         s = S_OR(category, GROUP_CATEGORY_PREFIX);
848         ast_copy_string(cat, s, sizeof(cat));
849
850         chan = NULL;
851         while ((chan = ast_channel_walk_locked(chan)) != NULL) {
852                 test = pbx_builtin_getvar_helper(chan, cat);
853                 if (test && !regexec(&regexbuf, test, 0, NULL, 0))
854                         count++;
855                 ast_channel_unlock(chan);
856         }
857
858         regfree(&regexbuf);
859
860         return count;
861 }
862
863 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
864 {
865         int argc;
866         char *scan;
867         int paren = 0, quote = 0;
868
869         if (!buf || !array || !arraylen)
870                 return 0;
871
872         memset(array, 0, arraylen * sizeof(*array));
873
874         scan = buf;
875
876         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
877                 array[argc] = scan;
878                 for (; *scan; scan++) {
879                         if (*scan == '(')
880                                 paren++;
881                         else if (*scan == ')') {
882                                 if (paren)
883                                         paren--;
884                         } else if (*scan == '"' && delim != '"') {
885                                 quote = quote ? 0 : 1;
886                                 /* Remove quote character from argument */
887                                 memmove(scan, scan + 1, strlen(scan));
888                                 scan--;
889                         } else if (*scan == '\\') {
890                                 /* Literal character, don't parse */
891                                 memmove(scan, scan + 1, strlen(scan));
892                         } else if ((*scan == delim) && !paren && !quote) {
893                                 *scan++ = '\0';
894                                 break;
895                         }
896                 }
897         }
898
899         if (*scan)
900                 array[argc++] = scan;
901
902         return argc;
903 }
904
905 enum AST_LOCK_RESULT ast_lock_path(const char *path)
906 {
907         char *s;
908         char *fs;
909         int res;
910         int fd;
911         int lp = strlen(path);
912         time_t start;
913
914         if (!(s = alloca(lp + 10)) || !(fs = alloca(lp + 20))) {
915                 ast_log(LOG_WARNING, "Out of memory!\n");
916                 return AST_LOCK_FAILURE;
917         }
918
919         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
920         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, 0600);
921         if (fd < 0) {
922                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
923                 return AST_LOCK_PATH_NOT_FOUND;
924         }
925         close(fd);
926
927         snprintf(s, strlen(path) + 9, "%s/.lock", path);
928         start = time(NULL);
929         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5))
930                 usleep(1);
931
932         unlink(fs);
933
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                 if (option_debug)
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         int res;
948
949         if (!(s = alloca(strlen(path) + 10))) {
950                 ast_log(LOG_WARNING, "Out of memory!\n");
951                 return -1;
952         }
953
954         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
955
956         if ((res = unlink(s)))
957                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
958         else {
959                 if (option_debug)
960                         ast_log(LOG_DEBUG, "Unlocked path '%s'\n", path);
961         }
962
963         return res;
964 }
965
966 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path) 
967 {
968         int silencethreshold = 128; 
969         int maxsilence=0;
970         int res = 0;
971         int cmd = 0;
972         int max_attempts = 3;
973         int attempts = 0;
974         int recorded = 0;
975         int message_exists = 0;
976         /* Note that urgent and private are for flagging messages as such in the future */
977
978         /* barf if no pointer passed to store duration in */
979         if (duration == NULL) {
980                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
981                 return -1;
982         }
983
984         cmd = '3';       /* Want to start by recording */
985
986         while ((cmd >= 0) && (cmd != 't')) {
987                 switch (cmd) {
988                 case '1':
989                         if (!message_exists) {
990                                 /* In this case, 1 is to record a message */
991                                 cmd = '3';
992                                 break;
993                         } else {
994                                 ast_stream_and_wait(chan, "vm-msgsaved", chan->language, "");
995                                 cmd = 't';
996                                 return res;
997                         }
998                 case '2':
999                         /* Review */
1000                         ast_verbose(VERBOSE_PREFIX_3 "Reviewing the recording\n");
1001                         cmd = ast_stream_and_wait(chan, recordfile, chan->language, AST_DIGIT_ANY);
1002                         break;
1003                 case '3':
1004                         message_exists = 0;
1005                         /* Record */
1006                         if (recorded == 1)
1007                                 ast_verbose(VERBOSE_PREFIX_3 "Re-recording\n");
1008                         else    
1009                                 ast_verbose(VERBOSE_PREFIX_3 "Recording\n");
1010                         recorded = 1;
1011                         cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, silencethreshold, maxsilence, path);
1012                         if (cmd == -1) {
1013                         /* User has hung up, no options to give */
1014                                 return cmd;
1015                         }
1016                         if (cmd == '0') {
1017                                 break;
1018                         } else if (cmd == '*') {
1019                                 break;
1020                         } 
1021                         else {
1022                                 /* If all is well, a message exists */
1023                                 message_exists = 1;
1024                                 cmd = 0;
1025                         }
1026                         break;
1027                 case '4':
1028                 case '5':
1029                 case '6':
1030                 case '7':
1031                 case '8':
1032                 case '9':
1033                 case '*':
1034                 case '#':
1035                         cmd = ast_play_and_wait(chan, "vm-sorry");
1036                         break;
1037                 default:
1038                         if (message_exists) {
1039                                 cmd = ast_play_and_wait(chan, "vm-review");
1040                         }
1041                         else {
1042                                 cmd = ast_play_and_wait(chan, "vm-torerecord");
1043                                 if (!cmd)
1044                                         cmd = ast_waitfordigit(chan, 600);
1045                         }
1046                         
1047                         if (!cmd)
1048                                 cmd = ast_waitfordigit(chan, 6000);
1049                         if (!cmd) {
1050                                 attempts++;
1051                         }
1052                         if (attempts > max_attempts) {
1053                                 cmd = 't';
1054                         }
1055                 }
1056         }
1057         if (cmd == 't')
1058                 cmd = 0;
1059         return cmd;
1060 }
1061
1062 #define RES_UPONE (1 << 16)
1063 #define RES_EXIT  (1 << 17)
1064 #define RES_REPEAT (1 << 18)
1065 #define RES_RESTART ((1 << 19) | RES_REPEAT)
1066
1067 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
1068
1069 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
1070 {
1071         int res;
1072         int (*ivr_func)(struct ast_channel *, void *);
1073         char *c;
1074         char *n;
1075         
1076         switch(option->action) {
1077         case AST_ACTION_UPONE:
1078                 return RES_UPONE;
1079         case AST_ACTION_EXIT:
1080                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
1081         case AST_ACTION_REPEAT:
1082                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
1083         case AST_ACTION_RESTART:
1084                 return RES_RESTART ;
1085         case AST_ACTION_NOOP:
1086                 return 0;
1087         case AST_ACTION_BACKGROUND:
1088                 res = ast_stream_and_wait(chan, (char *)option->adata, chan->language, AST_DIGIT_ANY);
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_PLAYBACK:
1095                 res = ast_stream_and_wait(chan, (char *)option->adata, chan->language, "");
1096                 if (res < 0) {
1097                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
1098                         res = 0;
1099                 }
1100                 return res;
1101         case AST_ACTION_MENU:
1102                 res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata);
1103                 /* Do not pass entry errors back up, treaat ast though ti was an "UPONE" */
1104                 if (res == -2)
1105                         res = 0;
1106                 return res;
1107         case AST_ACTION_WAITOPTION:
1108                 res = ast_waitfordigit(chan, 1000 * (chan->pbx ? chan->pbx->rtimeout : 10));
1109                 if (!res)
1110                         return 't';
1111                 return res;
1112         case AST_ACTION_CALLBACK:
1113                 ivr_func = option->adata;
1114                 res = ivr_func(chan, cbdata);
1115                 return res;
1116         case AST_ACTION_TRANSFER:
1117                 res = ast_parseable_goto(chan, option->adata);
1118                 return 0;
1119         case AST_ACTION_PLAYLIST:
1120         case AST_ACTION_BACKLIST:
1121                 res = 0;
1122                 c = ast_strdupa(option->adata);
1123                 while ((n = strsep(&c, ";"))) {
1124                         if ((res = ast_stream_and_wait(chan, n, chan->language,
1125                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : "")))
1126                                 break;
1127                 }
1128                 ast_stopstream(chan);
1129                 return res;
1130         default:
1131                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
1132                 return 0;
1133         };
1134         return -1;
1135 }
1136
1137 static int option_exists(struct ast_ivr_menu *menu, char *option)
1138 {
1139         int x;
1140         for (x = 0; menu->options[x].option; x++)
1141                 if (!strcasecmp(menu->options[x].option, option))
1142                         return x;
1143         return -1;
1144 }
1145
1146 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
1147 {
1148         int x;
1149         for (x = 0; menu->options[x].option; x++)
1150                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) && 
1151                                 (menu->options[x].option[strlen(option)]))
1152                         return x;
1153         return -1;
1154 }
1155
1156 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
1157 {
1158         int res=0;
1159         int ms;
1160         while (option_matchmore(menu, exten)) {
1161                 ms = chan->pbx ? chan->pbx->dtimeout : 5000;
1162                 if (strlen(exten) >= maxexten - 1) 
1163                         break;
1164                 res = ast_waitfordigit(chan, ms);
1165                 if (res < 1)
1166                         break;
1167                 exten[strlen(exten) + 1] = '\0';
1168                 exten[strlen(exten)] = res;
1169         }
1170         return res > 0 ? 0 : res;
1171 }
1172
1173 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1174 {
1175         /* Execute an IVR menu structure */
1176         int res=0;
1177         int pos = 0;
1178         int retries = 0;
1179         char exten[AST_MAX_EXTENSION] = "s";
1180         if (option_exists(menu, "s") < 0) {
1181                 strcpy(exten, "g");
1182                 if (option_exists(menu, "g") < 0) {
1183                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
1184                         return -1;
1185                 }
1186         }
1187         while(!res) {
1188                 while(menu->options[pos].option) {
1189                         if (!strcasecmp(menu->options[pos].option, exten)) {
1190                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
1191                                 if (option_debug)
1192                                         ast_log(LOG_DEBUG, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
1193                                 if (res < 0)
1194                                         break;
1195                                 else if (res & RES_UPONE)
1196                                         return 0;
1197                                 else if (res & RES_EXIT)
1198                                         return res;
1199                                 else if (res & RES_REPEAT) {
1200                                         int maxretries = res & 0xffff;
1201                                         if ((res & RES_RESTART) == RES_RESTART) {
1202                                                 retries = 0;
1203                                         } else
1204                                                 retries++;
1205                                         if (!maxretries)
1206                                                 maxretries = 3;
1207                                         if ((maxretries > 0) && (retries >= maxretries)) {
1208                                                 if (option_debug)
1209                                                         ast_log(LOG_DEBUG, "Max retries %d exceeded\n", maxretries);
1210                                                 return -2;
1211                                         } else {
1212                                                 if (option_exists(menu, "g") > -1) 
1213                                                         strcpy(exten, "g");
1214                                                 else if (option_exists(menu, "s") > -1)
1215                                                         strcpy(exten, "s");
1216                                         }
1217                                         pos = 0;
1218                                         continue;
1219                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
1220                                         if (option_debug)
1221                                                 ast_log(LOG_DEBUG, "Got start of extension, %c\n", res);
1222                                         exten[1] = '\0';
1223                                         exten[0] = res;
1224                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten))))
1225                                                 break;
1226                                         if (option_exists(menu, exten) < 0) {
1227                                                 if (option_exists(menu, "i")) {
1228                                                         if (option_debug)
1229                                                                 ast_log(LOG_DEBUG, "Invalid extension entered, going to 'i'!\n");
1230                                                         strcpy(exten, "i");
1231                                                         pos = 0;
1232                                                         continue;
1233                                                 } else {
1234                                                         if (option_debug)
1235                                                                 ast_log(LOG_DEBUG, "Aborting on invalid entry, with no 'i' option!\n");
1236                                                         res = -2;
1237                                                         break;
1238                                                 }
1239                                         } else {
1240                                                 if (option_debug)
1241                                                         ast_log(LOG_DEBUG, "New existing extension: %s\n", exten);
1242                                                 pos = 0;
1243                                                 continue;
1244                                         }
1245                                 }
1246                         }
1247                         pos++;
1248                 }
1249                 if (option_debug)
1250                         ast_log(LOG_DEBUG, "Stopping option '%s', res is %d\n", exten, res);
1251                 pos = 0;
1252                 if (!strcasecmp(exten, "s"))
1253                         strcpy(exten, "g");
1254                 else
1255                         break;
1256         }
1257         return res;
1258 }
1259
1260 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
1261 {
1262         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
1263         /* Hide internal coding */
1264         return res > 0 ? 0 : res;
1265 }
1266         
1267 char *ast_read_textfile(const char *filename)
1268 {
1269         int fd;
1270         char *output = NULL;
1271         struct stat filesize;
1272         int count = 0;
1273         int res;
1274         if (stat(filename, &filesize) == -1) {
1275                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
1276                 return NULL;
1277         }
1278         count = filesize.st_size + 1;
1279         fd = open(filename, O_RDONLY);
1280         if (fd < 0) {
1281                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
1282                 return NULL;
1283         }
1284         if ((output = ast_malloc(count))) {
1285                 res = read(fd, output, count - 1);
1286                 if (res == count - 1) {
1287                         output[res] = '\0';
1288                 } else {
1289                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
1290                         free(output);
1291                         output = NULL;
1292                 }
1293         }
1294         close(fd);
1295         return output;
1296 }
1297
1298 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
1299 {
1300         char *s;
1301         int curarg;
1302         unsigned int argloc;
1303         char *arg;
1304         int res = 0;
1305
1306         ast_clear_flag(flags, AST_FLAGS_ALL);
1307
1308         if (!optstr)
1309                 return 0;
1310
1311         s = optstr;
1312         while (*s) {
1313                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
1314                 ast_set_flag(flags, options[curarg].flag);
1315                 argloc = options[curarg].arg_index;
1316                 if (*s == '(') {
1317                         /* Has argument */
1318                         arg = ++s;
1319                         s = strchr(s, ')');
1320                         if (*s) {
1321                                 if (argloc)
1322                                         args[argloc - 1] = arg;
1323                                 *s++ = '\0';
1324                         } else {
1325                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
1326                                 res = -1;
1327                         }
1328                 } else if (argloc) {
1329                         args[argloc - 1] = NULL;
1330                 }
1331         }
1332
1333         return res;
1334 }
1335