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