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