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