ARI: Add tones playback resource
[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 /** \example
27  * \par This is an example of how to develop an app.
28  * Application Skeleton is an example of creating an application for Asterisk.
29  * \verbinclude app_skel.c
30  */
31
32 /*** MODULEINFO
33         <support_level>core</support_level>
34  ***/
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39
40 #ifdef HAVE_SYS_STAT_H
41 #include <sys/stat.h>
42 #endif
43 #include <regex.h>          /* for regcomp(3) */
44 #include <sys/file.h>       /* for flock(2) */
45 #include <signal.h>         /* for pthread_sigmask(3) */
46 #include <stdlib.h>         /* for closefrom(3) */
47 #include <sys/types.h>
48 #include <sys/wait.h>       /* for waitpid(2) */
49 #ifndef HAVE_CLOSEFROM
50 #include <dirent.h>         /* for opendir(3)   */
51 #endif
52 #ifdef HAVE_CAP
53 #include <sys/capability.h>
54 #endif /* HAVE_CAP */
55
56 #include "asterisk/paths.h"     /* use ast_config_AST_DATA_DIR */
57 #include "asterisk/channel.h"
58 #include "asterisk/pbx.h"
59 #include "asterisk/file.h"
60 #include "asterisk/app.h"
61 #include "asterisk/dsp.h"
62 #include "asterisk/utils.h"
63 #include "asterisk/lock.h"
64 #include "asterisk/indications.h"
65 #include "asterisk/linkedlists.h"
66 #include "asterisk/threadstorage.h"
67 #include "asterisk/test.h"
68 #include "asterisk/module.h"
69 #include "asterisk/astobj2.h"
70 #include "asterisk/stasis.h"
71 #include "asterisk/stasis_channels.h"
72 #include "asterisk/json.h"
73
74 #define MWI_TOPIC_BUCKETS 57
75
76 AST_THREADSTORAGE_PUBLIC(ast_str_thread_global_buf);
77
78 static pthread_t shaun_of_the_dead_thread = AST_PTHREADT_NULL;
79
80 struct zombie {
81         pid_t pid;
82         AST_LIST_ENTRY(zombie) list;
83 };
84
85 static AST_LIST_HEAD_STATIC(zombies, zombie);
86
87 /*
88  * @{ \brief Define \ref stasis topic objects
89  */
90 static struct stasis_topic *mwi_topic_all;
91 static struct stasis_cache *mwi_state_cache;
92 static struct stasis_caching_topic *mwi_topic_cached;
93 static struct stasis_topic_pool *mwi_topic_pool;
94
95 static struct stasis_topic *queue_topic_all;
96 static struct stasis_topic_pool *queue_topic_pool;
97 /* @} */
98
99 /*
100  * @{ \brief Define \ref stasis message types for MWI
101  */
102 STASIS_MESSAGE_TYPE_DEFN(ast_mwi_state_type);
103 STASIS_MESSAGE_TYPE_DEFN(ast_mwi_vm_app_type);
104 /* @} */
105
106
107
108 static void *shaun_of_the_dead(void *data)
109 {
110         struct zombie *cur;
111         int status;
112         for (;;) {
113                 if (!AST_LIST_EMPTY(&zombies)) {
114                         /* Don't allow cancellation while we have a lock. */
115                         pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
116                         AST_LIST_LOCK(&zombies);
117                         AST_LIST_TRAVERSE_SAFE_BEGIN(&zombies, cur, list) {
118                                 if (waitpid(cur->pid, &status, WNOHANG) != 0) {
119                                         AST_LIST_REMOVE_CURRENT(list);
120                                         ast_free(cur);
121                                 }
122                         }
123                         AST_LIST_TRAVERSE_SAFE_END
124                         AST_LIST_UNLOCK(&zombies);
125                         pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
126                 }
127                 pthread_testcancel();
128                 /* Wait for 60 seconds, without engaging in a busy loop. */
129                 ast_poll(NULL, 0, AST_LIST_FIRST(&zombies) ? 5000 : 60000);
130         }
131         return NULL;
132 }
133
134
135 #define AST_MAX_FORMATS 10
136
137 static AST_RWLIST_HEAD_STATIC(groups, ast_group_info);
138
139 /*!
140  * \brief This function presents a dialtone and reads an extension into 'collect'
141  * which must be a pointer to a **pre-initialized** array of char having a
142  * size of 'size' suitable for writing to.  It will collect no more than the smaller
143  * of 'maxlen' or 'size' minus the original strlen() of collect digits.
144  * \param chan struct.
145  * \param context
146  * \param collect
147  * \param size
148  * \param maxlen
149  * \param timeout timeout in milliseconds
150  *
151  * \return 0 if extension does not exist, 1 if extension exists
152 */
153 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout)
154 {
155         struct ast_tone_zone_sound *ts;
156         int res = 0, x = 0;
157
158         if (maxlen > size) {
159                 maxlen = size;
160         }
161
162         if (!timeout) {
163                 if (ast_channel_pbx(chan) && ast_channel_pbx(chan)->dtimeoutms) {
164                         timeout = ast_channel_pbx(chan)->dtimeoutms;
165                 } else {
166                         timeout = 5000;
167                 }
168         }
169
170         if ((ts = ast_get_indication_tone(ast_channel_zone(chan), "dial"))) {
171                 res = ast_playtones_start(chan, 0, ts->data, 0);
172                 ts = ast_tone_zone_sound_unref(ts);
173         } else {
174                 ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
175         }
176
177         for (x = strlen(collect); x < maxlen; ) {
178                 res = ast_waitfordigit(chan, timeout);
179                 if (!ast_ignore_pattern(context, collect)) {
180                         ast_playtones_stop(chan);
181                 }
182                 if (res < 1) {
183                         break;
184                 }
185                 if (res == '#') {
186                         break;
187                 }
188                 collect[x++] = res;
189                 if (!ast_matchmore_extension(chan, context, collect, 1,
190                         S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
191                         break;
192                 }
193         }
194
195         if (res >= 0) {
196                 res = ast_exists_extension(chan, context, collect, 1,
197                         S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL)) ? 1 : 0;
198         }
199
200         return res;
201 }
202
203 /*!
204  * \brief ast_app_getdata
205  * \param c The channel to read from
206  * \param prompt The file to stream to the channel
207  * \param s The string to read in to.  Must be at least the size of your length
208  * \param maxlen How many digits to read (maximum)
209  * \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for
210  *      "ludicrous time" (essentially never times out) */
211 enum ast_getdata_result ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout)
212 {
213         int res = 0, to, fto;
214         char *front, *filename;
215
216         /* XXX Merge with full version? XXX */
217
218         if (maxlen)
219                 s[0] = '\0';
220
221         if (!prompt)
222                 prompt = "";
223
224         filename = ast_strdupa(prompt);
225         while ((front = strsep(&filename, "&"))) {
226                 ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", front, ast_channel_name(c));
227                 if (!ast_strlen_zero(front)) {
228                         res = ast_streamfile(c, front, ast_channel_language(c));
229                         if (res)
230                                 continue;
231                 }
232                 if (ast_strlen_zero(filename)) {
233                         /* set timeouts for the last prompt */
234                         fto = ast_channel_pbx(c) ? ast_channel_pbx(c)->rtimeoutms : 6000;
235                         to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;
236
237                         if (timeout > 0) {
238                                 fto = to = timeout;
239                         }
240                         if (timeout < 0) {
241                                 fto = to = 1000000000;
242                         }
243                 } else {
244                         /* there is more than one prompt, so
245                          * get rid of the long timeout between
246                          * prompts, and make it 50ms */
247                         fto = 50;
248                         to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;
249                 }
250                 res = ast_readstring(c, s, maxlen, to, fto, "#");
251                 if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
252                         return res;
253                 }
254                 if (!ast_strlen_zero(s)) {
255                         return res;
256                 }
257         }
258
259         return res;
260 }
261
262 /* The lock type used by ast_lock_path() / ast_unlock_path() */
263 static enum AST_LOCK_TYPE ast_lock_type = AST_LOCK_TYPE_LOCKFILE;
264
265 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
266 {
267         int res, to = 2000, fto = 6000;
268
269         if (!ast_strlen_zero(prompt)) {
270                 res = ast_streamfile(c, prompt, ast_channel_language(c));
271                 if (res < 0) {
272                         return res;
273                 }
274         }
275
276         if (timeout > 0) {
277                 fto = to = timeout;
278         }
279         if (timeout < 0) {
280                 fto = to = 1000000000;
281         }
282
283         res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
284
285         return res;
286 }
287
288 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args)
289 {
290         struct ast_app *macro_app;
291         int res;
292
293         macro_app = pbx_findapp("Macro");
294         if (!macro_app) {
295                 ast_log(LOG_WARNING,
296                         "Cannot run 'Macro(%s)'.  The application is not available.\n", macro_args);
297                 return -1;
298         }
299         if (autoservice_chan) {
300                 ast_autoservice_start(autoservice_chan);
301         }
302
303         ast_debug(4, "%s Original location: %s,%s,%d\n", ast_channel_name(macro_chan),
304                 ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
305                 ast_channel_priority(macro_chan));
306
307         res = pbx_exec(macro_chan, macro_app, macro_args);
308         ast_debug(4, "Macro exited with status %d\n", res);
309
310         /*
311          * Assume anything negative from Macro is an error.
312          * Anything else is success.
313          */
314         if (res < 0) {
315                 res = -1;
316         } else {
317                 res = 0;
318         }
319
320         ast_debug(4, "%s Ending location: %s,%s,%d\n", ast_channel_name(macro_chan),
321                 ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
322                 ast_channel_priority(macro_chan));
323
324         if (autoservice_chan) {
325                 ast_autoservice_stop(autoservice_chan);
326         }
327         return res;
328 }
329
330 int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_name, const char *macro_args)
331 {
332         int res;
333         char *args_str;
334         size_t args_len;
335
336         if (ast_strlen_zero(macro_args)) {
337                 return ast_app_exec_macro(autoservice_chan, macro_chan, macro_name);
338         }
339
340         /* Create the Macro application argument string. */
341         args_len = strlen(macro_name) + strlen(macro_args) + 2;
342         args_str = ast_malloc(args_len);
343         if (!args_str) {
344                 return -1;
345         }
346         snprintf(args_str, args_len, "%s,%s", macro_name, macro_args);
347
348         res = ast_app_exec_macro(autoservice_chan, macro_chan, args_str);
349         ast_free(args_str);
350         return res;
351 }
352
353 static const struct ast_app_stack_funcs *app_stack_callbacks;
354
355 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs)
356 {
357         app_stack_callbacks = funcs;
358 }
359
360 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args)
361 {
362         const struct ast_app_stack_funcs *funcs;
363         const char *new_args;
364
365         funcs = app_stack_callbacks;
366         if (!funcs || !funcs->expand_sub_args) {
367                 ast_log(LOG_WARNING,
368                         "Cannot expand 'Gosub(%s)' arguments.  The app_stack module is not available.\n",
369                         args);
370                 return NULL;
371         }
372         ast_module_ref(funcs->module);
373
374         new_args = funcs->expand_sub_args(chan, args);
375         ast_module_unref(funcs->module);
376         return new_args;
377 }
378
379 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup)
380 {
381         const struct ast_app_stack_funcs *funcs;
382         int res;
383
384         funcs = app_stack_callbacks;
385         if (!funcs || !funcs->run_sub) {
386                 ast_log(LOG_WARNING,
387                         "Cannot run 'Gosub(%s)'.  The app_stack module is not available.\n",
388                         sub_args);
389                 return -1;
390         }
391         ast_module_ref(funcs->module);
392
393         if (autoservice_chan) {
394                 ast_autoservice_start(autoservice_chan);
395         }
396
397         res = funcs->run_sub(sub_chan, sub_args, ignore_hangup);
398         ast_module_unref(funcs->module);
399
400         if (autoservice_chan) {
401                 ast_autoservice_stop(autoservice_chan);
402         }
403         return res;
404 }
405
406 int ast_app_run_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup)
407 {
408         int res;
409         char *args_str;
410         size_t args_len;
411
412         if (ast_strlen_zero(sub_args)) {
413                 return ast_app_exec_sub(autoservice_chan, sub_chan, sub_location, ignore_hangup);
414         }
415
416         /* Create the Gosub application argument string. */
417         args_len = strlen(sub_location) + strlen(sub_args) + 3;
418         args_str = ast_malloc(args_len);
419         if (!args_str) {
420                 return -1;
421         }
422         snprintf(args_str, args_len, "%s(%s)", sub_location, sub_args);
423
424         res = ast_app_exec_sub(autoservice_chan, sub_chan, args_str, ignore_hangup);
425         ast_free(args_str);
426         return res;
427 }
428
429 /*! \brief The container for the voicemail provider */
430 static AO2_GLOBAL_OBJ_STATIC(vm_provider);
431
432 /*! Voicemail not registered warning */
433 static int vm_warnings;
434
435 int ast_vm_is_registered(void)
436 {
437         struct ast_vm_functions *table;
438         int is_registered;
439
440         table = ao2_global_obj_ref(vm_provider);
441         is_registered = table ? 1 : 0;
442         ao2_cleanup(table);
443         return is_registered;
444 }
445
446 int __ast_vm_register(const struct ast_vm_functions *vm_table, struct ast_module *module)
447 {
448         RAII_VAR(struct ast_vm_functions *, table, NULL, ao2_cleanup);
449
450         if (!vm_table->module_name) {
451                 ast_log(LOG_ERROR, "Voicemail provider missing required information.\n");
452                 return -1;
453         }
454         if (vm_table->module_version != VM_MODULE_VERSION) {
455                 ast_log(LOG_ERROR, "Voicemail provider '%s' has incorrect version\n",
456                         vm_table->module_name);
457                 return -1;
458         }
459
460         table = ao2_global_obj_ref(vm_provider);
461         if (table) {
462                 ast_log(LOG_WARNING, "Voicemail provider already registered by %s.\n",
463                         table->module_name);
464                 return -1;
465         }
466
467         table = ao2_alloc_options(sizeof(*table), NULL, AO2_ALLOC_OPT_LOCK_NOLOCK);
468         if (!table) {
469                 return -1;
470         }
471         *table = *vm_table;
472         table->module = module;
473
474         ao2_global_obj_replace_unref(vm_provider, table);
475         return 0;
476 }
477
478 void ast_vm_unregister(const char *module_name)
479 {
480         struct ast_vm_functions *table;
481
482         table = ao2_global_obj_ref(vm_provider);
483         if (table && !strcmp(table->module_name, module_name)) {
484                 ao2_global_obj_release(vm_provider);
485         }
486         ao2_cleanup(table);
487 }
488
489 #ifdef TEST_FRAMEWORK
490 static ast_vm_test_create_user_fn *ast_vm_test_create_user_func = NULL;
491 static ast_vm_test_destroy_user_fn *ast_vm_test_destroy_user_func = NULL;
492
493 void ast_install_vm_test_functions(ast_vm_test_create_user_fn *vm_test_create_user_func,
494         ast_vm_test_destroy_user_fn *vm_test_destroy_user_func)
495 {
496         ast_vm_test_create_user_func = vm_test_create_user_func;
497         ast_vm_test_destroy_user_func = vm_test_destroy_user_func;
498 }
499
500 void ast_uninstall_vm_test_functions(void)
501 {
502         ast_vm_test_create_user_func = NULL;
503         ast_vm_test_destroy_user_func = NULL;
504 }
505 #endif
506
507 static void vm_warn_no_provider(void)
508 {
509         if (vm_warnings++ % 10 == 0) {
510                 ast_verb(3, "No voicemail provider registered.\n");
511         }
512 }
513
514 #define VM_API_CALL(res, api_call, api_parms)                                                           \
515         do {                                                                                                                                    \
516                 struct ast_vm_functions *table = ao2_global_obj_ref(vm_provider);       \
517                 if (!table) {                                                                                                           \
518                         vm_warn_no_provider();                                                                                  \
519                 } else if (table->api_call) {                                                                           \
520                         ast_module_ref(table->module);                                                                  \
521                         (res) = table->api_call api_parms;                                                              \
522                         ast_module_unref(table->module);                                                                \
523                 }                                                                                                                                       \
524                 ao2_cleanup(table);                                                                                                     \
525         } while (0)
526
527 int ast_app_has_voicemail(const char *mailboxes, const char *folder)
528 {
529         int res = 0;
530
531         VM_API_CALL(res, has_voicemail, (mailboxes, folder));
532         return res;
533 }
534
535 /*!
536  * \internal
537  * \brief Function used as a callback for ast_copy_recording_to_vm when a real one isn't installed.
538  * \param vm_rec_data Stores crucial information about the voicemail that will basically just be used
539  * to figure out what the name of the recipient was supposed to be
540  */
541 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data)
542 {
543         int res = -1;
544
545         VM_API_CALL(res, copy_recording_to_vm, (vm_rec_data));
546         return res;
547 }
548
549 int ast_app_inboxcount(const char *mailboxes, int *newmsgs, int *oldmsgs)
550 {
551         int res = 0;
552
553         if (newmsgs) {
554                 *newmsgs = 0;
555         }
556         if (oldmsgs) {
557                 *oldmsgs = 0;
558         }
559
560         VM_API_CALL(res, inboxcount, (mailboxes, newmsgs, oldmsgs));
561         return res;
562 }
563
564 int ast_app_inboxcount2(const char *mailboxes, int *urgentmsgs, int *newmsgs, int *oldmsgs)
565 {
566         int res = 0;
567
568         if (newmsgs) {
569                 *newmsgs = 0;
570         }
571         if (oldmsgs) {
572                 *oldmsgs = 0;
573         }
574         if (urgentmsgs) {
575                 *urgentmsgs = 0;
576         }
577
578         VM_API_CALL(res, inboxcount2, (mailboxes, urgentmsgs, newmsgs, oldmsgs));
579         return res;
580 }
581
582 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context)
583 {
584         int res = -1;
585
586         VM_API_CALL(res, sayname, (chan, mailbox, context));
587         return res;
588 }
589
590 int ast_app_messagecount(const char *mailbox_id, const char *folder)
591 {
592         int res = 0;
593
594         VM_API_CALL(res, messagecount, (mailbox_id, folder));
595         return res;
596 }
597
598 const char *ast_vm_index_to_foldername(int id)
599 {
600         const char *res = NULL;
601
602         VM_API_CALL(res, index_to_foldername, (id));
603         return res;
604 }
605
606 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
607         const char *context,
608         const char *folder,
609         int descending,
610         enum ast_vm_snapshot_sort_val sort_val,
611         int combine_INBOX_and_OLD)
612 {
613         struct ast_vm_mailbox_snapshot *res = NULL;
614
615         VM_API_CALL(res, mailbox_snapshot_create, (mailbox, context, folder, descending,
616                 sort_val, combine_INBOX_and_OLD));
617         return res;
618 }
619
620 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot)
621 {
622         struct ast_vm_mailbox_snapshot *res = NULL;
623
624         VM_API_CALL(res, mailbox_snapshot_destroy, (mailbox_snapshot));
625         return res;
626 }
627
628 int ast_vm_msg_move(const char *mailbox,
629         const char *context,
630         size_t num_msgs,
631         const char *oldfolder,
632         const char *old_msg_ids[],
633         const char *newfolder)
634 {
635         int res = 0;
636
637         VM_API_CALL(res, msg_move, (mailbox, context, num_msgs, oldfolder, old_msg_ids,
638                 newfolder));
639         return res;
640 }
641
642 int ast_vm_msg_remove(const char *mailbox,
643         const char *context,
644         size_t num_msgs,
645         const char *folder,
646         const char *msgs[])
647 {
648         int res = 0;
649
650         VM_API_CALL(res, msg_remove, (mailbox, context, num_msgs, folder, msgs));
651         return res;
652 }
653
654 int ast_vm_msg_forward(const char *from_mailbox,
655         const char *from_context,
656         const char *from_folder,
657         const char *to_mailbox,
658         const char *to_context,
659         const char *to_folder,
660         size_t num_msgs,
661         const char *msg_ids[],
662         int delete_old)
663 {
664         int res = 0;
665
666         VM_API_CALL(res, msg_forward, (from_mailbox, from_context, from_folder, to_mailbox,
667                 to_context, to_folder, num_msgs, msg_ids, delete_old));
668         return res;
669 }
670
671 int ast_vm_msg_play(struct ast_channel *chan,
672         const char *mailbox,
673         const char *context,
674         const char *folder,
675         const char *msg_num,
676         ast_vm_msg_play_cb *cb)
677 {
678         int res = 0;
679
680         VM_API_CALL(res, msg_play, (chan, mailbox, context, folder, msg_num, cb));
681         return res;
682 }
683
684 #ifdef TEST_FRAMEWORK
685 int ast_vm_test_create_user(const char *context, const char *mailbox)
686 {
687         if (ast_vm_test_create_user_func) {
688                 return ast_vm_test_create_user_func(context, mailbox);
689         }
690         return 0;
691 }
692
693 int ast_vm_test_destroy_user(const char *context, const char *mailbox)
694 {
695         if (ast_vm_test_destroy_user_func) {
696                 return ast_vm_test_destroy_user_func(context, mailbox);
697         }
698         return 0;
699 }
700 #endif
701
702 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration)
703 {
704         const char *ptr;
705         int res;
706         struct ast_silence_generator *silgen = NULL;
707
708         if (!between) {
709                 between = 100;
710         }
711
712         if (peer && ast_autoservice_start(peer)) {
713                 return -1;
714         }
715
716         /* Need a quiet time before sending digits. */
717         if (ast_opt_transmit_silence) {
718                 silgen = ast_channel_start_silence_generator(chan);
719         }
720         res = ast_safe_sleep(chan, 100);
721         if (res) {
722                 goto dtmf_stream_cleanup;
723         }
724
725         for (ptr = digits; *ptr; ptr++) {
726                 if (*ptr == 'w') {
727                         /* 'w' -- wait half a second */
728                         if ((res = ast_safe_sleep(chan, 500))) {
729                                 break;
730                         }
731                 } else if (*ptr == 'W') {
732                         /* 'W' -- wait a second */
733                         if ((res = ast_safe_sleep(chan, 1000))) {
734                                 break;
735                         }
736                 } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
737                         if (*ptr == 'f' || *ptr == 'F') {
738                                 /* ignore return values if not supported by channel */
739                                 ast_indicate(chan, AST_CONTROL_FLASH);
740                         } else {
741                                 /* Character represents valid DTMF */
742                                 ast_senddigit(chan, *ptr, duration);
743                         }
744                         /* pause between digits */
745                         if ((res = ast_safe_sleep(chan, between))) {
746                                 break;
747                         }
748                 } else {
749                         ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
750                 }
751         }
752
753 dtmf_stream_cleanup:
754         if (silgen) {
755                 ast_channel_stop_silence_generator(chan, silgen);
756         }
757         if (peer && ast_autoservice_stop(peer)) {
758                 res = -1;
759         }
760
761         return res;
762 }
763
764 struct linear_state {
765         int fd;
766         int autoclose;
767         int allowoverride;
768         struct ast_format origwfmt;
769 };
770
771 static void linear_release(struct ast_channel *chan, void *params)
772 {
773         struct linear_state *ls = params;
774
775         if (ls->origwfmt.id && ast_set_write_format(chan, &ls->origwfmt)) {
776                 ast_log(LOG_WARNING, "Unable to restore channel '%s' to format '%d'\n", ast_channel_name(chan), ls->origwfmt.id);
777         }
778
779         if (ls->autoclose) {
780                 close(ls->fd);
781         }
782
783         ast_free(params);
784 }
785
786 static int linear_generator(struct ast_channel *chan, void *data, int len, int samples)
787 {
788         short buf[2048 + AST_FRIENDLY_OFFSET / 2];
789         struct linear_state *ls = data;
790         struct ast_frame f = {
791                 .frametype = AST_FRAME_VOICE,
792                 .data.ptr = buf + AST_FRIENDLY_OFFSET / 2,
793                 .offset = AST_FRIENDLY_OFFSET,
794         };
795         int res;
796
797         ast_format_set(&f.subclass.format, AST_FORMAT_SLINEAR, 0);
798
799         len = samples * 2;
800         if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
801                 ast_log(LOG_WARNING, "Can't generate %d bytes of data!\n" , len);
802                 len = sizeof(buf) - AST_FRIENDLY_OFFSET;
803         }
804         res = read(ls->fd, buf + AST_FRIENDLY_OFFSET/2, len);
805         if (res > 0) {
806                 f.datalen = res;
807                 f.samples = res / 2;
808                 ast_write(chan, &f);
809                 if (res == len) {
810                         return 0;
811                 }
812         }
813         return -1;
814 }
815
816 static void *linear_alloc(struct ast_channel *chan, void *params)
817 {
818         struct linear_state *ls = params;
819
820         if (!params) {
821                 return NULL;
822         }
823
824         /* In this case, params is already malloc'd */
825         if (ls->allowoverride) {
826                 ast_set_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
827         } else {
828                 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
829         }
830
831         ast_format_copy(&ls->origwfmt, ast_channel_writeformat(chan));
832
833         if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR)) {
834                 ast_log(LOG_WARNING, "Unable to set '%s' to linear format (write)\n", ast_channel_name(chan));
835                 ast_free(ls);
836                 ls = params = NULL;
837         }
838
839         return params;
840 }
841
842 static struct ast_generator linearstream =
843 {
844         .alloc = linear_alloc,
845         .release = linear_release,
846         .generate = linear_generator,
847 };
848
849 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride)
850 {
851         struct linear_state *lin;
852         char tmpf[256];
853         int res = -1;
854         int autoclose = 0;
855         if (fd < 0) {
856                 if (ast_strlen_zero(filename)) {
857                         return -1;
858                 }
859                 autoclose = 1;
860                 if (filename[0] == '/') {
861                         ast_copy_string(tmpf, filename, sizeof(tmpf));
862                 } else {
863                         snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
864                 }
865                 if ((fd = open(tmpf, O_RDONLY)) < 0) {
866                         ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
867                         return -1;
868                 }
869         }
870         if ((lin = ast_calloc(1, sizeof(*lin)))) {
871                 lin->fd = fd;
872                 lin->allowoverride = allowoverride;
873                 lin->autoclose = autoclose;
874                 res = ast_activate_generator(chan, &linearstream, lin);
875         }
876         return res;
877 }
878
879 static int control_streamfile(struct ast_channel *chan,
880         const char *file,
881         const char *fwd,
882         const char *rev,
883         const char *stop,
884         const char *suspend,
885         const char *restart,
886         int skipms,
887         long *offsetms,
888         const char *lang,
889         ast_waitstream_fr_cb cb)
890 {
891         char *breaks = NULL;
892         char *end = NULL;
893         int blen = 2;
894         int res;
895         long pause_restart_point = 0;
896         long offset = 0;
897
898         if (!file) {
899                 return -1;
900         }
901         if (offsetms) {
902                 offset = *offsetms * 8; /* XXX Assumes 8kHz */
903         }
904         if (lang == NULL) {
905                 lang = ast_channel_language(chan);
906         }
907
908         if (stop) {
909                 blen += strlen(stop);
910         }
911         if (suspend) {
912                 blen += strlen(suspend);
913         }
914         if (restart) {
915                 blen += strlen(restart);
916         }
917
918         if (blen > 2) {
919                 breaks = ast_alloca(blen + 1);
920                 breaks[0] = '\0';
921                 if (stop) {
922                         strcat(breaks, stop);
923                 }
924                 if (suspend) {
925                         strcat(breaks, suspend);
926                 }
927                 if (restart) {
928                         strcat(breaks, restart);
929                 }
930         }
931         if (ast_channel_state(chan) != AST_STATE_UP) {
932                 res = ast_answer(chan);
933         }
934
935         if ((end = strchr(file, ':'))) {
936                 if (!strcasecmp(end, ":end")) {
937                         *end = '\0';
938                         end++;
939                 }
940         }
941
942         for (;;) {
943                 ast_stopstream(chan);
944                 res = ast_streamfile(chan, file, lang);
945                 if (!res) {
946                         if (pause_restart_point) {
947                                 ast_seekstream(ast_channel_stream(chan), pause_restart_point, SEEK_SET);
948                                 pause_restart_point = 0;
949                         }
950                         else if (end || offset < 0) {
951                                 if (offset == -8) {
952                                         offset = 0;
953                                 }
954                                 ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
955
956                                 ast_seekstream(ast_channel_stream(chan), offset, SEEK_END);
957                                 end = NULL;
958                                 offset = 0;
959                         } else if (offset) {
960                                 ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
961                                 ast_seekstream(ast_channel_stream(chan), offset, SEEK_SET);
962                                 offset = 0;
963                         }
964                         if (cb) {
965                                 res = ast_waitstream_fr_w_cb(chan, breaks, fwd, rev, skipms, cb);
966                         } else {
967                                 res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
968                         }
969                 }
970
971                 if (res < 1) {
972                         break;
973                 }
974
975                 /* We go at next loop if we got the restart char */
976                 if ((restart && strchr(restart, res)) || res == AST_CONTROL_STREAM_RESTART) {
977                         ast_debug(1, "we'll restart the stream here at next loop\n");
978                         pause_restart_point = 0;
979                         ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
980                                 "Control: %s\r\n",
981                                 ast_channel_name(chan),
982                                 "Restart");
983                         continue;
984                 }
985
986                 if ((suspend && strchr(suspend, res)) || res == AST_CONTROL_STREAM_SUSPEND) {
987                         pause_restart_point = ast_tellstream(ast_channel_stream(chan));
988                         ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
989                                 "Control: %s\r\n",
990                                 ast_channel_name(chan),
991                                 "Pause");
992                         for (;;) {
993                                 ast_stopstream(chan);
994                                 if (!(res = ast_waitfordigit(chan, 1000))) {
995                                         continue;
996                                 } else if (res == -1 || (suspend && strchr(suspend, res)) || (stop && strchr(stop, res))
997                                                 || res == AST_CONTROL_STREAM_SUSPEND || res == AST_CONTROL_STREAM_STOP) {
998                                         break;
999                                 }
1000                         }
1001                         if ((suspend && (res == *suspend)) || res == AST_CONTROL_STREAM_SUSPEND) {
1002                                 res = 0;
1003                                 ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1004                                         "Control: %s\r\n",
1005                                         ast_channel_name(chan),
1006                                         "Unpause");
1007                                 continue;
1008                         }
1009                 }
1010
1011                 if (res == -1) {
1012                         break;
1013                 }
1014
1015                 /* if we get one of our stop chars, return it to the calling function */
1016                 if ((stop && strchr(stop, res)) || res == AST_CONTROL_STREAM_STOP) {
1017                         ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1018                                 "Control: %s\r\n",
1019                                 ast_channel_name(chan),
1020                                 "Stop");
1021                         break;
1022                 }
1023         }
1024
1025         if (pause_restart_point) {
1026                 offset = pause_restart_point;
1027         } else {
1028                 if (ast_channel_stream(chan)) {
1029                         offset = ast_tellstream(ast_channel_stream(chan));
1030                 } else {
1031                         offset = -8;  /* indicate end of file */
1032                 }
1033         }
1034
1035         if (offsetms) {
1036                 *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
1037         }
1038
1039         ast_stopstream(chan);
1040
1041         return res;
1042 }
1043
1044 int ast_control_streamfile_w_cb(struct ast_channel *chan,
1045         const char *file,
1046         const char *fwd,
1047         const char *rev,
1048         const char *stop,
1049         const char *suspend,
1050         const char *restart,
1051         int skipms,
1052         long *offsetms,
1053         ast_waitstream_fr_cb cb)
1054 {
1055         return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, NULL, cb);
1056 }
1057
1058 int ast_control_streamfile(struct ast_channel *chan, const char *file,
1059                            const char *fwd, const char *rev,
1060                            const char *stop, const char *suspend,
1061                            const char *restart, int skipms, long *offsetms)
1062 {
1063         return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, NULL, NULL);
1064 }
1065
1066 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
1067         const char *fwd, const char *rev, const char *stop, const char *suspend,
1068         const char *restart, int skipms, const char *lang, long *offsetms)
1069 {
1070         return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, lang, NULL);
1071 }
1072
1073 enum control_tone_frame_response_result {
1074         CONTROL_TONE_RESPONSE_FAILED = -1,
1075         CONTROL_TONE_RESPONSE_NORMAL = 0,
1076         CONTROL_TONE_RESPONSE_FINISHED = 1,
1077 };
1078
1079 static enum control_tone_frame_response_result control_tone_frame_response(struct ast_channel *chan, struct ast_frame *fr, struct ast_tone_zone_sound *ts, const char *tone, int *paused)
1080 {
1081         switch (fr->subclass.integer) {
1082         case AST_CONTROL_STREAM_STOP:
1083                 ast_playtones_stop(chan);
1084                 return CONTROL_TONE_RESPONSE_FINISHED;
1085         case AST_CONTROL_STREAM_SUSPEND:
1086                 if (*paused) {
1087                         *paused = 0;
1088                         if (ast_playtones_start(chan, 0, ts ? ts->data : tone, 0)) {
1089                                 return CONTROL_TONE_RESPONSE_FAILED;
1090                         }
1091                 } else {
1092                         *paused = 1;
1093                         ast_playtones_stop(chan);
1094                 }
1095                 return CONTROL_TONE_RESPONSE_NORMAL;
1096         case AST_CONTROL_STREAM_RESTART:
1097                 ast_playtones_stop(chan);
1098                 if (ast_playtones_start(chan, 0, ts ? ts->data : tone, 0)) {
1099                         return CONTROL_TONE_RESPONSE_FAILED;
1100                 }
1101                 return CONTROL_TONE_RESPONSE_NORMAL;
1102         case AST_CONTROL_STREAM_REVERSE:
1103                 ast_log(LOG_NOTICE, "Media control operation 'reverse' not supported for media type 'tone'\n");
1104                 return CONTROL_TONE_RESPONSE_NORMAL;
1105         case AST_CONTROL_STREAM_FORWARD:
1106                 ast_log(LOG_NOTICE, "Media control operation 'forward' not supported for media type 'tone'\n");
1107                 return CONTROL_TONE_RESPONSE_NORMAL;
1108         case AST_CONTROL_HANGUP:
1109         case AST_CONTROL_BUSY:
1110         case AST_CONTROL_CONGESTION:
1111                 return CONTROL_TONE_RESPONSE_FINISHED;
1112         }
1113
1114         return CONTROL_TONE_RESPONSE_NORMAL;
1115 }
1116
1117 static int parse_tone_uri(char *tone_parser,
1118         const char **tone_indication,
1119         const char **tone_zone)
1120 {
1121         *tone_indication = strsep(&tone_parser, ";");
1122
1123         if (ast_strlen_zero(tone_parser)) {
1124                 /* Only the indication is included */
1125                 return 0;
1126         }
1127
1128         if (!(strncmp(tone_parser, "tonezone=", 9))) {
1129                 *tone_zone = tone_parser + 9;
1130         } else {
1131                 ast_log(LOG_ERROR, "Unexpected Tone URI component: %s\n", tone_parser);
1132                 return -1;
1133         }
1134
1135         return 0;
1136 }
1137
1138 int ast_control_tone(struct ast_channel *chan, const char *tone)
1139 {
1140         struct ast_tone_zone *zone = NULL;
1141         struct ast_tone_zone_sound *ts;
1142         int paused = 0;
1143         int res;
1144
1145         const char *tone_indication = NULL;
1146         const char *tone_zone = NULL;
1147         char *tone_uri_parser;
1148
1149         if (ast_strlen_zero(tone)) {
1150                 return -1;
1151         }
1152
1153         tone_uri_parser = ast_strdupa(tone);
1154
1155         if (parse_tone_uri(tone_uri_parser, &tone_indication, &tone_zone)) {
1156                 return -1;
1157         }
1158
1159         if (tone_zone) {
1160                 zone = ast_get_indication_zone(tone_zone);
1161         }
1162
1163         ts = ast_get_indication_tone(zone ? zone : ast_channel_zone(chan), tone_indication);
1164
1165         if (ast_playtones_start(chan, 0, ts ? ts->data : tone_indication, 0)) {
1166                 return -1;
1167         }
1168
1169         for (;;) {
1170                 struct ast_frame *fr;
1171                 int res;
1172
1173                 if (ast_waitfor(chan, -1) < 0) {
1174                         res = -1;
1175                         break;
1176                 }
1177
1178                 fr = ast_read_noaudio(chan);
1179
1180                 if (!fr) {
1181                         res = -1;
1182                         break;
1183                 }
1184
1185                 if (fr->frametype != AST_FRAME_CONTROL) {
1186                         continue;
1187                 }
1188
1189                 res = control_tone_frame_response(chan, fr, ts, tone_indication, &paused);
1190                 if (res == CONTROL_TONE_RESPONSE_FINISHED) {
1191                         res = 0;
1192                         break;
1193                 } else if (res == CONTROL_TONE_RESPONSE_FAILED) {
1194                         res = -1;
1195                         break;
1196                 }
1197         }
1198
1199         if (ts) {
1200                 ast_tone_zone_sound_unref(ts);
1201         }
1202
1203         if (zone) {
1204                 ast_tone_zone_unref(zone);
1205         }
1206
1207         return res;
1208 }
1209
1210 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
1211 {
1212         int d = 0;
1213
1214         ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", fn, ast_channel_name(chan));
1215         if ((d = ast_streamfile(chan, fn, ast_channel_language(chan)))) {
1216                 return d;
1217         }
1218
1219         d = ast_waitstream(chan, AST_DIGIT_ANY);
1220
1221         ast_stopstream(chan);
1222
1223         return d;
1224 }
1225
1226 /*!
1227  * \brief Construct a silence frame of the same duration as \a orig.
1228  *
1229  * The \a orig frame must be \ref AST_FORMAT_SLINEAR.
1230  *
1231  * \param orig Frame as basis for silence to generate.
1232  * \return New frame of silence; free with ast_frfree().
1233  * \return \c NULL on error.
1234  */
1235 static struct ast_frame *make_silence(const struct ast_frame *orig)
1236 {
1237         struct ast_frame *silence;
1238         size_t size;
1239         size_t datalen;
1240         size_t samples = 0;
1241         struct ast_frame *next;
1242
1243         if (!orig) {
1244                 return NULL;
1245         }
1246
1247         if (orig->subclass.format.id != AST_FORMAT_SLINEAR) {
1248                 ast_log(LOG_WARNING, "Attempting to silence non-slin frame\n");
1249                 return NULL;
1250         }
1251
1252         for (next = AST_LIST_NEXT(orig, frame_list);
1253                  orig;
1254                  orig = next, next = orig ? AST_LIST_NEXT(orig, frame_list) : NULL) {
1255                 samples += orig->samples;
1256         }
1257
1258         ast_verb(4, "Silencing %zd samples\n", samples);
1259
1260
1261         datalen = sizeof(short) * samples;
1262         size = sizeof(*silence) + datalen;
1263         silence = ast_calloc(1, size);
1264         if (!silence) {
1265                 return NULL;
1266         }
1267
1268         silence->mallocd = AST_MALLOCD_HDR;
1269         silence->frametype = AST_FRAME_VOICE;
1270         silence->data.ptr = (void *)(silence + 1);
1271         silence->samples = samples;
1272         silence->datalen = datalen;
1273
1274         ast_format_set(&silence->subclass.format, AST_FORMAT_SLINEAR, 0);
1275
1276         return silence;
1277 }
1278
1279 /*!
1280  * \brief Sets a channel's read format to \ref AST_FORMAT_SLINEAR, recording
1281  * its original format.
1282  *
1283  * \param chan Channel to modify.
1284  * \param[out] orig_format Output variable to store channel's original read
1285  *                         format.
1286  * \return 0 on success.
1287  * \return -1 on error.
1288  */
1289 static int set_read_to_slin(struct ast_channel *chan, struct ast_format *orig_format)
1290 {
1291         if (!chan || !orig_format) {
1292                 return -1;
1293         }
1294         ast_format_copy(orig_format, ast_channel_readformat(chan));
1295         return ast_set_read_format_by_id(chan, AST_FORMAT_SLINEAR);
1296 }
1297
1298 static int global_silence_threshold = 128;
1299 static int global_maxsilence = 0;
1300
1301 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
1302  * \param chan Channel to playback to/record from.
1303  * \param playfile Filename of sound to play before recording begins.
1304  * \param recordfile Filename to record to.
1305  * \param maxtime Maximum length of recording (in seconds).
1306  * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
1307  * \param duration Where to store actual length of the recorded message (in milliseconds).
1308  * \param sound_duration Where to store the length of the recorded message (in milliseconds), minus any silence
1309  * \param beep Whether to play a beep before starting to record.
1310  * \param silencethreshold
1311  * \param maxsilence Length of silence that will end a recording (in milliseconds).
1312  * \param path Optional filesystem path to unlock.
1313  * \param prepend If true, prepend the recorded audio to an existing file and follow prepend mode recording rules
1314  * \param acceptdtmf DTMF digits that will end the recording.
1315  * \param canceldtmf DTMF digits that will cancel the recording.
1316  * \param skip_confirmation_sound If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.
1317  *
1318  * \retval -1 failure or hangup
1319  * \retval 'S' Recording ended from silence timeout
1320  * \retval 't' Recording ended from the message exceeding the maximum duration, or via DTMF in prepend mode
1321  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
1322  */
1323 static int __ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence, const char *path, int prepend, const char *acceptdtmf, const char *canceldtmf, int skip_confirmation_sound, enum ast_record_if_exists if_exists)
1324 {
1325         int d = 0;
1326         char *fmts;
1327         char comment[256];
1328         int x, fmtcnt = 1, res = -1, outmsg = 0;
1329         struct ast_filestream *others[AST_MAX_FORMATS];
1330         char *sfmt[AST_MAX_FORMATS];
1331         char *stringp = NULL;
1332         time_t start, end;
1333         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
1334         int totalsilence = 0;
1335         int dspsilence = 0;
1336         int olddspsilence = 0;
1337         struct ast_format rfmt;
1338         struct ast_silence_generator *silgen = NULL;
1339         char prependfile[PATH_MAX];
1340         int ioflags;    /* IO flags for writing output file */
1341
1342         ioflags = O_CREAT|O_WRONLY;
1343
1344         switch (if_exists) {
1345         case AST_RECORD_IF_EXISTS_FAIL:
1346                 ioflags |= O_EXCL;
1347                 break;
1348         case AST_RECORD_IF_EXISTS_OVERWRITE:
1349                 ioflags |= O_TRUNC;
1350                 break;
1351         case AST_RECORD_IF_EXISTS_APPEND:
1352                 ioflags |= O_APPEND;
1353                 break;
1354         }
1355
1356         ast_format_clear(&rfmt);
1357         if (silencethreshold < 0) {
1358                 silencethreshold = global_silence_threshold;
1359         }
1360
1361         if (maxsilence < 0) {
1362                 maxsilence = global_maxsilence;
1363         }
1364
1365         /* barf if no pointer passed to store duration in */
1366         if (!duration) {
1367                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
1368                 return -1;
1369         }
1370
1371         ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
1372         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, ast_channel_name(chan));
1373
1374         if (playfile || beep) {
1375                 if (!beep) {
1376                         d = ast_play_and_wait(chan, playfile);
1377                 }
1378                 if (d > -1) {
1379                         d = ast_stream_and_wait(chan, "beep", "");
1380                 }
1381                 if (d < 0) {
1382                         return -1;
1383                 }
1384         }
1385
1386         if (prepend) {
1387                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));
1388                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
1389         }
1390
1391         fmts = ast_strdupa(fmt);
1392
1393         stringp = fmts;
1394         strsep(&stringp, "|");
1395         ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
1396         sfmt[0] = ast_strdupa(fmts);
1397
1398         while ((fmt = strsep(&stringp, "|"))) {
1399                 if (fmtcnt > AST_MAX_FORMATS - 1) {
1400                         ast_log(LOG_WARNING, "Please increase AST_MAX_FORMATS in file.h\n");
1401                         break;
1402                 }
1403                 sfmt[fmtcnt++] = ast_strdupa(fmt);
1404         }
1405
1406         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
1407         for (x = 0; x < fmtcnt; x++) {
1408                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, ioflags, 0, AST_FILE_MODE);
1409                 ast_verb(3, "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
1410
1411                 if (!others[x]) {
1412                         break;
1413                 }
1414         }
1415
1416         if (path) {
1417                 ast_unlock_path(path);
1418         }
1419
1420         if (maxsilence > 0) {
1421                 sildet = ast_dsp_new(); /* Create the silence detector */
1422                 if (!sildet) {
1423                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
1424                         return -1;
1425                 }
1426                 ast_dsp_set_threshold(sildet, silencethreshold);
1427                 res = set_read_to_slin(chan, &rfmt);
1428                 if (res < 0) {
1429                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1430                         ast_dsp_free(sildet);
1431                         return -1;
1432                 }
1433         }
1434
1435         if (!prepend) {
1436                 /* Request a video update */
1437                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
1438
1439                 if (ast_opt_transmit_silence) {
1440                         silgen = ast_channel_start_silence_generator(chan);
1441                 }
1442         }
1443
1444         if (x == fmtcnt) {
1445                 /* Loop, writing the packets we read to the writer(s), until
1446                  * we have reason to stop. */
1447                 struct ast_frame *f;
1448                 int paused = 0;
1449                 int muted = 0;
1450                 time_t pause_start = 0;
1451                 int paused_secs = 0;
1452                 int pausedsilence = 0;
1453
1454                 for (;;) {
1455                         if (!(res = ast_waitfor(chan, 2000))) {
1456                                 ast_debug(1, "One waitfor failed, trying another\n");
1457                                 /* Try one more time in case of masq */
1458                                 if (!(res = ast_waitfor(chan, 2000))) {
1459                                         ast_log(LOG_WARNING, "No audio available on %s??\n", ast_channel_name(chan));
1460                                         res = -1;
1461                                 }
1462                         }
1463
1464                         if (res < 0) {
1465                                 f = NULL;
1466                                 break;
1467                         }
1468                         if (!(f = ast_read(chan))) {
1469                                 break;
1470                         }
1471                         if (f->frametype == AST_FRAME_VOICE) {
1472                                 /* write each format */
1473                                 if (paused) {
1474                                         /* It's all good */
1475                                         res = 0;
1476                                 } else {
1477                                         RAII_VAR(struct ast_frame *, silence, NULL, ast_frame_dtor);
1478                                         struct ast_frame *orig = f;
1479
1480                                         if (muted) {
1481                                                 silence = make_silence(orig);
1482                                                 if (!silence) {
1483                                                         ast_log(LOG_WARNING,
1484                                                                 "Error creating silence\n");
1485                                                         break;
1486                                                 }
1487                                                 f = silence;
1488                                         }
1489                                         for (x = 0; x < fmtcnt; x++) {
1490                                                 if (prepend && !others[x]) {
1491                                                         break;
1492                                                 }
1493                                                 res = ast_writestream(others[x], f);
1494                                         }
1495                                         f = orig;
1496                                 }
1497
1498                                 /* Silence Detection */
1499                                 if (maxsilence > 0) {
1500                                         dspsilence = 0;
1501                                         ast_dsp_silence(sildet, f, &dspsilence);
1502                                         if (olddspsilence > dspsilence) {
1503                                                 totalsilence += olddspsilence;
1504                                         }
1505                                         olddspsilence = dspsilence;
1506
1507                                         if (paused) {
1508                                                 /* record how much silence there was while we are paused */
1509                                                 pausedsilence = dspsilence;
1510                                         } else if (dspsilence > pausedsilence) {
1511                                                 /* ignore the paused silence */
1512                                                 dspsilence -= pausedsilence;
1513                                         } else {
1514                                                 /* dspsilence has reset, reset pausedsilence */
1515                                                 pausedsilence = 0;
1516                                         }
1517
1518                                         if (dspsilence > maxsilence) {
1519                                                 /* Ended happily with silence */
1520                                                 ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", dspsilence/1000);
1521                                                 res = 'S';
1522                                                 outmsg = 2;
1523                                                 break;
1524                                         }
1525                                 }
1526                                 /* Exit on any error */
1527                                 if (res) {
1528                                         ast_log(LOG_WARNING, "Error writing frame\n");
1529                                         break;
1530                                 }
1531                         } else if (f->frametype == AST_FRAME_VIDEO) {
1532                                 /* Write only once */
1533                                 ast_writestream(others[0], f);
1534                         } else if (f->frametype == AST_FRAME_DTMF) {
1535                                 if (prepend) {
1536                                 /* stop recording with any digit */
1537                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1538                                         res = 't';
1539                                         outmsg = 2;
1540                                         break;
1541                                 }
1542                                 if (strchr(acceptdtmf, f->subclass.integer)) {
1543                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1544                                         res = f->subclass.integer;
1545                                         outmsg = 2;
1546                                         break;
1547                                 }
1548                                 if (strchr(canceldtmf, f->subclass.integer)) {
1549                                         ast_verb(3, "User canceled message by pressing %c\n", f->subclass.integer);
1550                                         res = f->subclass.integer;
1551                                         outmsg = 0;
1552                                         break;
1553                                 }
1554                         } else if (f->frametype == AST_FRAME_CONTROL) {
1555                                 if (f->subclass.integer == AST_CONTROL_RECORD_CANCEL) {
1556                                         ast_verb(3, "Message canceled by control\n");
1557                                         outmsg = 0; /* cancels the recording */
1558                                         res = 0;
1559                                         break;
1560                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_STOP) {
1561                                         ast_verb(3, "Message ended by control\n");
1562                                         res = 0;
1563                                         break;
1564                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_SUSPEND) {
1565                                         paused = !paused;
1566                                         ast_verb(3, "Message %spaused by control\n",
1567                                                 paused ? "" : "un");
1568                                         if (paused) {
1569                                                 pause_start = time(NULL);
1570                                         } else {
1571                                                 paused_secs += time(NULL) - pause_start;
1572                                         }
1573                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_MUTE) {
1574                                         muted = !muted;
1575                                         ast_verb(3, "Message %smuted by control\n",
1576                                                 muted ? "" : "un");
1577                                         /* We can only silence slin frames, so
1578                                          * set the mode, if we haven't already
1579                                          * for sildet
1580                                          */
1581                                         if (muted && !rfmt.id) {
1582                                                 ast_verb(3, "Setting read format to linear mode\n");
1583                                                 res = set_read_to_slin(chan, &rfmt);
1584                                                 if (res < 0) {
1585                                                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1586                                                         break;
1587                                                 }
1588                                         }
1589                                 }
1590                         }
1591                         if (maxtime && !paused) {
1592                                 end = time(NULL);
1593                                 if (maxtime < (end - start - paused_secs)) {
1594                                         ast_verb(3, "Took too long, cutting it short...\n");
1595                                         res = 't';
1596                                         outmsg = 2;
1597                                         break;
1598                                 }
1599                         }
1600                         ast_frfree(f);
1601                 }
1602                 if (!f) {
1603                         ast_verb(3, "User hung up\n");
1604                         res = -1;
1605                         outmsg = 1;
1606                 } else {
1607                         ast_frfree(f);
1608                 }
1609         } else {
1610                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
1611         }
1612
1613         if (!prepend) {
1614                 if (silgen) {
1615                         ast_channel_stop_silence_generator(chan, silgen);
1616                 }
1617         }
1618
1619         /*!\note
1620          * Instead of asking how much time passed (end - start), calculate the number
1621          * of seconds of audio which actually went into the file.  This fixes a
1622          * problem where audio is stopped up on the network and never gets to us.
1623          *
1624          * Note that we still want to use the number of seconds passed for the max
1625          * message, otherwise we could get a situation where this stream is never
1626          * closed (which would create a resource leak).
1627          */
1628         *duration = others[0] ? ast_tellstream(others[0]) / 8000 : 0;
1629         if (sound_duration) {
1630                 *sound_duration = *duration;
1631         }
1632
1633         if (!prepend) {
1634                 /* Reduce duration by a total silence amount */
1635                 if (olddspsilence <= dspsilence) {
1636                         totalsilence += dspsilence;
1637                 }
1638
1639                 if (sound_duration) {
1640                         if (totalsilence > 0) {
1641                                 *sound_duration -= (totalsilence - 200) / 1000;
1642                         }
1643                         if (*sound_duration < 0) {
1644                                 *sound_duration = 0;
1645                         }
1646                 }
1647
1648                 if (dspsilence > 0) {
1649                         *duration -= (dspsilence - 200) / 1000;
1650                 }
1651
1652                 if (*duration < 0) {
1653                         *duration = 0;
1654                 }
1655
1656                 for (x = 0; x < fmtcnt; x++) {
1657                         if (!others[x]) {
1658                                 break;
1659                         }
1660                         /*!\note
1661                          * If we ended with silence, trim all but the first 200ms of silence
1662                          * off the recording.  However, if we ended with '#', we don't want
1663                          * to trim ANY part of the recording.
1664                          */
1665                         if (res > 0 && dspsilence) {
1666                                 /* rewind only the trailing silence */
1667                                 ast_stream_rewind(others[x], dspsilence - 200);
1668                         }
1669                         ast_truncstream(others[x]);
1670                         ast_closestream(others[x]);
1671                 }
1672         }
1673
1674         if (prepend && outmsg) {
1675                 struct ast_filestream *realfiles[AST_MAX_FORMATS];
1676                 struct ast_frame *fr;
1677
1678                 for (x = 0; x < fmtcnt; x++) {
1679                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
1680                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
1681                         if (!others[x] || !realfiles[x]) {
1682                                 break;
1683                         }
1684                         /*!\note Same logic as above. */
1685                         if (dspsilence) {
1686                                 ast_stream_rewind(others[x], dspsilence - 200);
1687                         }
1688                         ast_truncstream(others[x]);
1689                         /* add the original file too */
1690                         while ((fr = ast_readframe(realfiles[x]))) {
1691                                 ast_writestream(others[x], fr);
1692                                 ast_frfree(fr);
1693                         }
1694                         ast_closestream(others[x]);
1695                         ast_closestream(realfiles[x]);
1696                         ast_filerename(prependfile, recordfile, sfmt[x]);
1697                         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
1698                         ast_filedelete(prependfile, sfmt[x]);
1699                 }
1700         }
1701         if (rfmt.id && ast_set_read_format(chan, &rfmt)) {
1702                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(&rfmt), ast_channel_name(chan));
1703         }
1704         if ((outmsg == 2) && (!skip_confirmation_sound)) {
1705                 ast_stream_and_wait(chan, "auth-thankyou", "");
1706         }
1707         if (sildet) {
1708                 ast_dsp_free(sildet);
1709         }
1710         return res;
1711 }
1712
1713 static const char default_acceptdtmf[] = "#";
1714 static const char default_canceldtmf[] = "";
1715
1716 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence, const char *path, const char *acceptdtmf, const char *canceldtmf, int skip_confirmation_sound, enum ast_record_if_exists if_exists)
1717 {
1718         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, beep, silencethreshold, maxsilence, path, 0, S_OR(acceptdtmf, default_acceptdtmf), S_OR(canceldtmf, default_canceldtmf), skip_confirmation_sound, if_exists);
1719 }
1720
1721 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence, const char *path)
1722 {
1723         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf, 0, AST_RECORD_IF_EXISTS_OVERWRITE);
1724 }
1725
1726 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence)
1727 {
1728         return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf, 1, AST_RECORD_IF_EXISTS_OVERWRITE);
1729 }
1730
1731 /* Channel group core functions */
1732
1733 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
1734 {
1735         int res = 0;
1736         char tmp[256];
1737         char *grp = NULL, *cat = NULL;
1738
1739         if (!ast_strlen_zero(data)) {
1740                 ast_copy_string(tmp, data, sizeof(tmp));
1741                 grp = tmp;
1742                 if ((cat = strchr(tmp, '@'))) {
1743                         *cat++ = '\0';
1744                 }
1745         }
1746
1747         if (!ast_strlen_zero(grp)) {
1748                 ast_copy_string(group, grp, group_max);
1749         } else {
1750                 *group = '\0';
1751         }
1752
1753         if (!ast_strlen_zero(cat)) {
1754                 ast_copy_string(category, cat, category_max);
1755         }
1756
1757         return res;
1758 }
1759
1760 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
1761 {
1762         int res = 0;
1763         char group[80] = "", category[80] = "";
1764         struct ast_group_info *gi = NULL;
1765         size_t len = 0;
1766
1767         if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
1768                 return -1;
1769         }
1770
1771         /* Calculate memory we will need if this is new */
1772         len = sizeof(*gi) + strlen(group) + 1;
1773         if (!ast_strlen_zero(category)) {
1774                 len += strlen(category) + 1;
1775         }
1776
1777         AST_RWLIST_WRLOCK(&groups);
1778         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1779                 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1780                         AST_RWLIST_REMOVE_CURRENT(group_list);
1781                         free(gi);
1782                         break;
1783                 }
1784         }
1785         AST_RWLIST_TRAVERSE_SAFE_END;
1786
1787         if (ast_strlen_zero(group)) {
1788                 /* Enable unsetting the group */
1789         } else if ((gi = calloc(1, len))) {
1790                 gi->chan = chan;
1791                 gi->group = (char *) gi + sizeof(*gi);
1792                 strcpy(gi->group, group);
1793                 if (!ast_strlen_zero(category)) {
1794                         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
1795                         strcpy(gi->category, category);
1796                 }
1797                 AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
1798         } else {
1799                 res = -1;
1800         }
1801
1802         AST_RWLIST_UNLOCK(&groups);
1803
1804         return res;
1805 }
1806
1807 int ast_app_group_get_count(const char *group, const char *category)
1808 {
1809         struct ast_group_info *gi = NULL;
1810         int count = 0;
1811
1812         if (ast_strlen_zero(group)) {
1813                 return 0;
1814         }
1815
1816         AST_RWLIST_RDLOCK(&groups);
1817         AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1818                 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1819                         count++;
1820                 }
1821         }
1822         AST_RWLIST_UNLOCK(&groups);
1823
1824         return count;
1825 }
1826
1827 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
1828 {
1829         struct ast_group_info *gi = NULL;
1830         regex_t regexbuf_group;
1831         regex_t regexbuf_category;
1832         int count = 0;
1833
1834         if (ast_strlen_zero(groupmatch)) {
1835                 ast_log(LOG_NOTICE, "groupmatch empty\n");
1836                 return 0;
1837         }
1838
1839         /* if regex compilation fails, return zero matches */
1840         if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
1841                 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
1842                 return 0;
1843         }
1844
1845         if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
1846                 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
1847                 regfree(&regexbuf_group);
1848                 return 0;
1849         }
1850
1851         AST_RWLIST_RDLOCK(&groups);
1852         AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1853                 if (!regexec(&regexbuf_group, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !regexec(&regexbuf_category, gi->category, 0, NULL, 0)))) {
1854                         count++;
1855                 }
1856         }
1857         AST_RWLIST_UNLOCK(&groups);
1858
1859         regfree(&regexbuf_group);
1860         if (!ast_strlen_zero(category)) {
1861                 regfree(&regexbuf_category);
1862         }
1863
1864         return count;
1865 }
1866
1867 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
1868 {
1869         struct ast_group_info *gi = NULL;
1870
1871         AST_RWLIST_WRLOCK(&groups);
1872         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1873                 if (gi->chan == old) {
1874                         gi->chan = new;
1875                 } else if (gi->chan == new) {
1876                         AST_RWLIST_REMOVE_CURRENT(group_list);
1877                         ast_free(gi);
1878                 }
1879         }
1880         AST_RWLIST_TRAVERSE_SAFE_END;
1881         AST_RWLIST_UNLOCK(&groups);
1882
1883         return 0;
1884 }
1885
1886 int ast_app_group_discard(struct ast_channel *chan)
1887 {
1888         struct ast_group_info *gi = NULL;
1889
1890         AST_RWLIST_WRLOCK(&groups);
1891         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1892                 if (gi->chan == chan) {
1893                         AST_RWLIST_REMOVE_CURRENT(group_list);
1894                         ast_free(gi);
1895                 }
1896         }
1897         AST_RWLIST_TRAVERSE_SAFE_END;
1898         AST_RWLIST_UNLOCK(&groups);
1899
1900         return 0;
1901 }
1902
1903 int ast_app_group_list_wrlock(void)
1904 {
1905         return AST_RWLIST_WRLOCK(&groups);
1906 }
1907
1908 int ast_app_group_list_rdlock(void)
1909 {
1910         return AST_RWLIST_RDLOCK(&groups);
1911 }
1912
1913 struct ast_group_info *ast_app_group_list_head(void)
1914 {
1915         return AST_RWLIST_FIRST(&groups);
1916 }
1917
1918 int ast_app_group_list_unlock(void)
1919 {
1920         return AST_RWLIST_UNLOCK(&groups);
1921 }
1922
1923 #undef ast_app_separate_args
1924 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
1925
1926 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen)
1927 {
1928         int argc;
1929         char *scan, *wasdelim = NULL;
1930         int paren = 0, quote = 0, bracket = 0;
1931
1932         if (!array || !arraylen) {
1933                 return 0;
1934         }
1935
1936         memset(array, 0, arraylen * sizeof(*array));
1937
1938         if (!buf) {
1939                 return 0;
1940         }
1941
1942         scan = buf;
1943
1944         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1945                 array[argc] = scan;
1946                 for (; *scan; scan++) {
1947                         if (*scan == '(') {
1948                                 paren++;
1949                         } else if (*scan == ')') {
1950                                 if (paren) {
1951                                         paren--;
1952                                 }
1953                         } else if (*scan == '[') {
1954                                 bracket++;
1955                         } else if (*scan == ']') {
1956                                 if (bracket) {
1957                                         bracket--;
1958                                 }
1959                         } else if (*scan == '"' && delim != '"') {
1960                                 quote = quote ? 0 : 1;
1961                                 if (remove_chars) {
1962                                         /* Remove quote character from argument */
1963                                         memmove(scan, scan + 1, strlen(scan));
1964                                         scan--;
1965                                 }
1966                         } else if (*scan == '\\') {
1967                                 if (remove_chars) {
1968                                         /* Literal character, don't parse */
1969                                         memmove(scan, scan + 1, strlen(scan));
1970                                 } else {
1971                                         scan++;
1972                                 }
1973                         } else if ((*scan == delim) && !paren && !quote && !bracket) {
1974                                 wasdelim = scan;
1975                                 *scan++ = '\0';
1976                                 break;
1977                         }
1978                 }
1979         }
1980
1981         /* If the last character in the original string was the delimiter, then
1982          * there is one additional argument. */
1983         if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
1984                 array[argc++] = scan;
1985         }
1986
1987         return argc;
1988 }
1989
1990 /* ABI compatible function */
1991 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
1992 {
1993         return __ast_app_separate_args(buf, delim, 1, array, arraylen);
1994 }
1995
1996 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1997 {
1998         char *s;
1999         char *fs;
2000         int res;
2001         int fd;
2002         int lp = strlen(path);
2003         time_t start;
2004
2005         s = ast_alloca(lp + 10);
2006         fs = ast_alloca(lp + 20);
2007
2008         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
2009         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
2010         if (fd < 0) {
2011                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
2012                 return AST_LOCK_PATH_NOT_FOUND;
2013         }
2014         close(fd);
2015
2016         snprintf(s, strlen(path) + 9, "%s/.lock", path);
2017         start = time(NULL);
2018         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5)) {
2019                 sched_yield();
2020         }
2021
2022         unlink(fs);
2023
2024         if (res) {
2025                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
2026                 return AST_LOCK_TIMEOUT;
2027         } else {
2028                 ast_debug(1, "Locked path '%s'\n", path);
2029                 return AST_LOCK_SUCCESS;
2030         }
2031 }
2032
2033 static int ast_unlock_path_lockfile(const char *path)
2034 {
2035         char *s;
2036         int res;
2037
2038         s = ast_alloca(strlen(path) + 10);
2039
2040         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
2041
2042         if ((res = unlink(s))) {
2043                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
2044         } else {
2045                 ast_debug(1, "Unlocked path '%s'\n", path);
2046         }
2047
2048         return res;
2049 }
2050
2051 struct path_lock {
2052         AST_LIST_ENTRY(path_lock) le;
2053         int fd;
2054         char *path;
2055 };
2056
2057 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
2058
2059 static void path_lock_destroy(struct path_lock *obj)
2060 {
2061         if (obj->fd >= 0) {
2062                 close(obj->fd);
2063         }
2064         if (obj->path) {
2065                 free(obj->path);
2066         }
2067         free(obj);
2068 }
2069
2070 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
2071 {
2072         char *fs;
2073         int res;
2074         int fd;
2075         time_t start;
2076         struct path_lock *pl;
2077         struct stat st, ost;
2078
2079         fs = ast_alloca(strlen(path) + 20);
2080
2081         snprintf(fs, strlen(path) + 19, "%s/lock", path);
2082         if (lstat(fs, &st) == 0) {
2083                 if ((st.st_mode & S_IFMT) == S_IFLNK) {
2084                         ast_log(LOG_WARNING, "Unable to create lock file "
2085                                         "'%s': it's already a symbolic link\n",
2086                                         fs);
2087                         return AST_LOCK_FAILURE;
2088                 }
2089                 if (st.st_nlink > 1) {
2090                         ast_log(LOG_WARNING, "Unable to create lock file "
2091                                         "'%s': %u hard links exist\n",
2092                                         fs, (unsigned int) st.st_nlink);
2093                         return AST_LOCK_FAILURE;
2094                 }
2095         }
2096         if ((fd = open(fs, O_WRONLY | O_CREAT, 0600)) < 0) {
2097                 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
2098                                 fs, strerror(errno));
2099                 return AST_LOCK_PATH_NOT_FOUND;
2100         }
2101         if (!(pl = ast_calloc(1, sizeof(*pl)))) {
2102                 /* We don't unlink the lock file here, on the possibility that
2103                  * someone else created it - better to leave a little mess
2104                  * than create a big one by destroying someone else's lock
2105                  * and causing something to be corrupted.
2106                  */
2107                 close(fd);
2108                 return AST_LOCK_FAILURE;
2109         }
2110         pl->fd = fd;
2111         pl->path = strdup(path);
2112
2113         time(&start);
2114         while (
2115                 #ifdef SOLARIS
2116                 ((res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd, F_GETFL) | O_NONBLOCK)) < 0) &&
2117                 #else
2118                 ((res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
2119                 #endif
2120                         (errno == EWOULDBLOCK) &&
2121                         (time(NULL) - start < 5))
2122                 usleep(1000);
2123         if (res) {
2124                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
2125                                 path, strerror(errno));
2126                 /* No unlinking of lock done, since we tried and failed to
2127                  * flock() it.
2128                  */
2129                 path_lock_destroy(pl);
2130                 return AST_LOCK_TIMEOUT;
2131         }
2132
2133         /* Check for the race where the file is recreated or deleted out from
2134          * underneath us.
2135          */
2136         if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
2137                         st.st_dev != ost.st_dev &&
2138                         st.st_ino != ost.st_ino) {
2139                 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
2140                                 "file changed underneath us\n", fs);
2141                 path_lock_destroy(pl);
2142                 return AST_LOCK_FAILURE;
2143         }
2144
2145         /* Success: file created, flocked, and is the one we started with */
2146         AST_LIST_LOCK(&path_lock_list);
2147         AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
2148         AST_LIST_UNLOCK(&path_lock_list);
2149
2150         ast_debug(1, "Locked path '%s'\n", path);
2151
2152         return AST_LOCK_SUCCESS;
2153 }
2154
2155 static int ast_unlock_path_flock(const char *path)
2156 {
2157         char *s;
2158         struct path_lock *p;
2159
2160         s = ast_alloca(strlen(path) + 20);
2161
2162         AST_LIST_LOCK(&path_lock_list);
2163         AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
2164                 if (!strcmp(p->path, path)) {
2165                         AST_LIST_REMOVE_CURRENT(le);
2166                         break;
2167                 }
2168         }
2169         AST_LIST_TRAVERSE_SAFE_END;
2170         AST_LIST_UNLOCK(&path_lock_list);
2171
2172         if (p) {
2173                 snprintf(s, strlen(path) + 19, "%s/lock", path);
2174                 unlink(s);
2175                 path_lock_destroy(p);
2176                 ast_debug(1, "Unlocked path '%s'\n", path);
2177         } else {
2178                 ast_debug(1, "Failed to unlock path '%s': "
2179                                 "lock not found\n", path);
2180         }
2181
2182         return 0;
2183 }
2184
2185 void ast_set_lock_type(enum AST_LOCK_TYPE type)
2186 {
2187         ast_lock_type = type;
2188 }
2189
2190 enum AST_LOCK_RESULT ast_lock_path(const char *path)
2191 {
2192         enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
2193
2194         switch (ast_lock_type) {
2195         case AST_LOCK_TYPE_LOCKFILE:
2196                 r = ast_lock_path_lockfile(path);
2197                 break;
2198         case AST_LOCK_TYPE_FLOCK:
2199                 r = ast_lock_path_flock(path);
2200                 break;
2201         }
2202
2203         return r;
2204 }
2205
2206 int ast_unlock_path(const char *path)
2207 {
2208         int r = 0;
2209
2210         switch (ast_lock_type) {
2211         case AST_LOCK_TYPE_LOCKFILE:
2212                 r = ast_unlock_path_lockfile(path);
2213                 break;
2214         case AST_LOCK_TYPE_FLOCK:
2215                 r = ast_unlock_path_flock(path);
2216                 break;
2217         }
2218
2219         return r;
2220 }
2221
2222 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path)
2223 {
2224         int silencethreshold;
2225         int maxsilence = 0;
2226         int res = 0;
2227         int cmd = 0;
2228         int max_attempts = 3;
2229         int attempts = 0;
2230         int recorded = 0;
2231         int message_exists = 0;
2232         /* Note that urgent and private are for flagging messages as such in the future */
2233
2234         /* barf if no pointer passed to store duration in */
2235         if (!duration) {
2236                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
2237                 return -1;
2238         }
2239
2240         cmd = '3';       /* Want to start by recording */
2241
2242         silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
2243
2244         while ((cmd >= 0) && (cmd != 't')) {
2245                 switch (cmd) {
2246                 case '1':
2247                         if (!message_exists) {
2248                                 /* In this case, 1 is to record a message */
2249                                 cmd = '3';
2250                                 break;
2251                         } else {
2252                                 ast_stream_and_wait(chan, "vm-msgsaved", "");
2253                                 cmd = 't';
2254                                 return res;
2255                         }
2256                 case '2':
2257                         /* Review */
2258                         ast_verb(3, "Reviewing the recording\n");
2259                         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
2260                         break;
2261                 case '3':
2262                         message_exists = 0;
2263                         /* Record */
2264                         ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
2265                         recorded = 1;
2266                         if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
2267                                 /* User has hung up, no options to give */
2268                                 return cmd;
2269                         }
2270                         if (cmd == '0') {
2271                                 break;
2272                         } else if (cmd == '*') {
2273                                 break;
2274                         } else {
2275                                 /* If all is well, a message exists */
2276                                 message_exists = 1;
2277                                 cmd = 0;
2278                         }
2279                         break;
2280                 case '4':
2281                 case '5':
2282                 case '6':
2283                 case '7':
2284                 case '8':
2285                 case '9':
2286                 case '*':
2287                 case '#':
2288                         cmd = ast_play_and_wait(chan, "vm-sorry");
2289                         break;
2290                 default:
2291                         if (message_exists) {
2292                                 cmd = ast_play_and_wait(chan, "vm-review");
2293                         } else {
2294                                 if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
2295                                         cmd = ast_waitfordigit(chan, 600);
2296                                 }
2297                         }
2298
2299                         if (!cmd) {
2300                                 cmd = ast_waitfordigit(chan, 6000);
2301                         }
2302                         if (!cmd) {
2303                                 attempts++;
2304                         }
2305                         if (attempts > max_attempts) {
2306                                 cmd = 't';
2307                         }
2308                 }
2309         }
2310         if (cmd == 't') {
2311                 cmd = 0;
2312         }
2313         return cmd;
2314 }
2315
2316 #define RES_UPONE (1 << 16)
2317 #define RES_EXIT  (1 << 17)
2318 #define RES_REPEAT (1 << 18)
2319 #define RES_RESTART ((1 << 19) | RES_REPEAT)
2320
2321 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
2322
2323 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
2324 {
2325         int res;
2326         int (*ivr_func)(struct ast_channel *, void *);
2327         char *c;
2328         char *n;
2329
2330         switch (option->action) {
2331         case AST_ACTION_UPONE:
2332                 return RES_UPONE;
2333         case AST_ACTION_EXIT:
2334                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
2335         case AST_ACTION_REPEAT:
2336                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
2337         case AST_ACTION_RESTART:
2338                 return RES_RESTART ;
2339         case AST_ACTION_NOOP:
2340                 return 0;
2341         case AST_ACTION_BACKGROUND:
2342                 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
2343                 if (res < 0) {
2344                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2345                         res = 0;
2346                 }
2347                 return res;
2348         case AST_ACTION_PLAYBACK:
2349                 res = ast_stream_and_wait(chan, (char *)option->adata, "");
2350                 if (res < 0) {
2351                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2352                         res = 0;
2353                 }
2354                 return res;
2355         case AST_ACTION_MENU:
2356                 if ((res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata)) == -2) {
2357                         /* Do not pass entry errors back up, treat as though it was an "UPONE" */
2358                         res = 0;
2359                 }
2360                 return res;
2361         case AST_ACTION_WAITOPTION:
2362                 if (!(res = ast_waitfordigit(chan, ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 10000))) {
2363                         return 't';
2364                 }
2365                 return res;
2366         case AST_ACTION_CALLBACK:
2367                 ivr_func = option->adata;
2368                 res = ivr_func(chan, cbdata);
2369                 return res;
2370         case AST_ACTION_TRANSFER:
2371                 res = ast_parseable_goto(chan, option->adata);
2372                 return 0;
2373         case AST_ACTION_PLAYLIST:
2374         case AST_ACTION_BACKLIST:
2375                 res = 0;
2376                 c = ast_strdupa(option->adata);
2377                 while ((n = strsep(&c, ";"))) {
2378                         if ((res = ast_stream_and_wait(chan, n,
2379                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : ""))) {
2380                                 break;
2381                         }
2382                 }
2383                 ast_stopstream(chan);
2384                 return res;
2385         default:
2386                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
2387                 return 0;
2388         }
2389         return -1;
2390 }
2391
2392 static int option_exists(struct ast_ivr_menu *menu, char *option)
2393 {
2394         int x;
2395         for (x = 0; menu->options[x].option; x++) {
2396                 if (!strcasecmp(menu->options[x].option, option)) {
2397                         return x;
2398                 }
2399         }
2400         return -1;
2401 }
2402
2403 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
2404 {
2405         int x;
2406         for (x = 0; menu->options[x].option; x++) {
2407                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) &&
2408                                 (menu->options[x].option[strlen(option)])) {
2409                         return x;
2410                 }
2411         }
2412         return -1;
2413 }
2414
2415 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
2416 {
2417         int res = 0;
2418         int ms;
2419         while (option_matchmore(menu, exten)) {
2420                 ms = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->dtimeoutms : 5000;
2421                 if (strlen(exten) >= maxexten - 1) {
2422                         break;
2423                 }
2424                 if ((res = ast_waitfordigit(chan, ms)) < 1) {
2425                         break;
2426                 }
2427                 exten[strlen(exten) + 1] = '\0';
2428                 exten[strlen(exten)] = res;
2429         }
2430         return res > 0 ? 0 : res;
2431 }
2432
2433 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2434 {
2435         /* Execute an IVR menu structure */
2436         int res = 0;
2437         int pos = 0;
2438         int retries = 0;
2439         char exten[AST_MAX_EXTENSION] = "s";
2440         if (option_exists(menu, "s") < 0) {
2441                 strcpy(exten, "g");
2442                 if (option_exists(menu, "g") < 0) {
2443                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
2444                         return -1;
2445                 }
2446         }
2447         while (!res) {
2448                 while (menu->options[pos].option) {
2449                         if (!strcasecmp(menu->options[pos].option, exten)) {
2450                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
2451                                 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
2452                                 if (res < 0) {
2453                                         break;
2454                                 } else if (res & RES_UPONE) {
2455                                         return 0;
2456                                 } else if (res & RES_EXIT) {
2457                                         return res;
2458                                 } else if (res & RES_REPEAT) {
2459                                         int maxretries = res & 0xffff;
2460                                         if ((res & RES_RESTART) == RES_RESTART) {
2461                                                 retries = 0;
2462                                         } else {
2463                                                 retries++;
2464                                         }
2465                                         if (!maxretries) {
2466                                                 maxretries = 3;
2467                                         }
2468                                         if ((maxretries > 0) && (retries >= maxretries)) {
2469                                                 ast_debug(1, "Max retries %d exceeded\n", maxretries);
2470                                                 return -2;
2471                                         } else {
2472                                                 if (option_exists(menu, "g") > -1) {
2473                                                         strcpy(exten, "g");
2474                                                 } else if (option_exists(menu, "s") > -1) {
2475                                                         strcpy(exten, "s");
2476                                                 }
2477                                         }
2478                                         pos = 0;
2479                                         continue;
2480                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
2481                                         ast_debug(1, "Got start of extension, %c\n", res);
2482                                         exten[1] = '\0';
2483                                         exten[0] = res;
2484                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten)))) {
2485                                                 break;
2486                                         }
2487                                         if (option_exists(menu, exten) < 0) {
2488                                                 if (option_exists(menu, "i")) {
2489                                                         ast_debug(1, "Invalid extension entered, going to 'i'!\n");
2490                                                         strcpy(exten, "i");
2491                                                         pos = 0;
2492                                                         continue;
2493                                                 } else {
2494                                                         ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
2495                                                         res = -2;
2496                                                         break;
2497                                                 }
2498                                         } else {
2499                                                 ast_debug(1, "New existing extension: %s\n", exten);
2500                                                 pos = 0;
2501                                                 continue;
2502                                         }
2503                                 }
2504                         }
2505                         pos++;
2506                 }
2507                 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
2508                 pos = 0;
2509                 if (!strcasecmp(exten, "s")) {
2510                         strcpy(exten, "g");
2511                 } else {
2512                         break;
2513                 }
2514         }
2515         return res;
2516 }
2517
2518 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2519 {
2520         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
2521         /* Hide internal coding */
2522         return res > 0 ? 0 : res;
2523 }
2524
2525 char *ast_read_textfile(const char *filename)
2526 {
2527         int fd, count = 0, res;
2528         char *output = NULL;
2529         struct stat filesize;
2530
2531         if (stat(filename, &filesize) == -1) {
2532                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
2533                 return NULL;
2534         }
2535
2536         count = filesize.st_size + 1;
2537
2538         if ((fd = open(filename, O_RDONLY)) < 0) {
2539                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
2540                 return NULL;
2541         }
2542
2543         if ((output = ast_malloc(count))) {
2544                 res = read(fd, output, count - 1);
2545                 if (res == count - 1) {
2546                         output[res] = '\0';
2547                 } else {
2548                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
2549                         ast_free(output);
2550                         output = NULL;
2551                 }
2552         }
2553
2554         close(fd);
2555
2556         return output;
2557 }
2558
2559 static int parse_options(const struct ast_app_option *options, void *_flags, char **args, char *optstr, int flaglen)
2560 {
2561         char *s, *arg;
2562         int curarg, res = 0;
2563         unsigned int argloc;
2564         struct ast_flags *flags = _flags;
2565         struct ast_flags64 *flags64 = _flags;
2566
2567         if (flaglen == 32) {
2568                 ast_clear_flag(flags, AST_FLAGS_ALL);
2569         } else {
2570                 flags64->flags = 0;
2571         }
2572
2573         if (!optstr) {
2574                 return 0;
2575         }
2576
2577         s = optstr;
2578         while (*s) {
2579                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
2580                 argloc = options[curarg].arg_index;
2581                 if (*s == '(') {
2582                         int paren = 1, quote = 0;
2583                         int parsequotes = (s[1] == '"') ? 1 : 0;
2584
2585                         /* Has argument */
2586                         arg = ++s;
2587                         for (; *s; s++) {
2588                                 if (*s == '(' && !quote) {
2589                                         paren++;
2590                                 } else if (*s == ')' && !quote) {
2591                                         /* Count parentheses, unless they're within quotes (or backslashed, below) */
2592                                         paren--;
2593                                 } else if (*s == '"' && parsequotes) {
2594                                         /* Leave embedded quotes alone, unless they are the first character */
2595                                         quote = quote ? 0 : 1;
2596                                         ast_copy_string(s, s + 1, INT_MAX);
2597                                         s--;
2598                                 } else if (*s == '\\') {
2599                                         if (!quote) {
2600                                                 /* If a backslash is found outside of quotes, remove it */
2601                                                 ast_copy_string(s, s + 1, INT_MAX);
2602                                         } else if (quote && s[1] == '"') {
2603                                                 /* Backslash for a quote character within quotes, remove the backslash */
2604                                                 ast_copy_string(s, s + 1, INT_MAX);
2605                                         } else {
2606                                                 /* Backslash within quotes, keep both characters */
2607                                                 s++;
2608                                         }
2609                                 }
2610
2611                                 if (paren == 0) {
2612                                         break;
2613                                 }
2614                         }
2615                         /* This will find the closing paren we found above, or none, if the string ended before we found one. */
2616                         if ((s = strchr(s, ')'))) {
2617                                 if (argloc) {
2618                                         args[argloc - 1] = arg;
2619                                 }
2620                                 *s++ = '\0';
2621                         } else {
2622                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
2623                                 res = -1;
2624                                 break;
2625                         }
2626                 } else if (argloc) {
2627                         args[argloc - 1] = "";
2628                 }
2629                 if (flaglen == 32) {
2630                         ast_set_flag(flags, options[curarg].flag);
2631                 } else {
2632                         ast_set_flag64(flags64, options[curarg].flag);
2633                 }
2634         }
2635
2636         return res;
2637 }
2638
2639 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
2640 {
2641         return parse_options(options, flags, args, optstr, 32);
2642 }
2643
2644 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
2645 {
2646         return parse_options(options, flags, args, optstr, 64);
2647 }
2648
2649 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len)
2650 {
2651         unsigned int i, found = 0;
2652         for (i = 32; i < 128 && found < len; i++) {
2653                 if (ast_test_flag64(flags, options[i].flag)) {
2654                         buf[found++] = i;
2655                 }
2656         }
2657         buf[found] = '\0';
2658 }
2659
2660 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed)
2661 {
2662         int i;
2663         *consumed = 1;
2664         *result = 0;
2665         if (ast_strlen_zero(stream)) {
2666                 *consumed = 0;
2667                 return -1;
2668         }
2669
2670         if (*stream == '\\') {
2671                 *consumed = 2;
2672                 switch (*(stream + 1)) {
2673                 case 'n':
2674                         *result = '\n';
2675                         break;
2676                 case 'r':
2677                         *result = '\r';
2678                         break;
2679                 case 't':
2680                         *result = '\t';
2681                         break;
2682                 case 'x':
2683                         /* Hexadecimal */
2684                         if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
2685                                 *consumed = 3;
2686                                 if (*(stream + 2) <= '9') {
2687                                         *result = *(stream + 2) - '0';
2688                                 } else if (*(stream + 2) <= 'F') {
2689                                         *result = *(stream + 2) - 'A' + 10;
2690                                 } else {
2691                                         *result = *(stream + 2) - 'a' + 10;
2692                                 }
2693                         } else {
2694                                 ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
2695                                 return -1;
2696                         }
2697
2698                         if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
2699                                 *consumed = 4;
2700                                 *result <<= 4;
2701                                 if (*(stream + 3) <= '9') {
2702                                         *result += *(stream + 3) - '0';
2703                                 } else if (*(stream + 3) <= 'F') {
2704                                         *result += *(stream + 3) - 'A' + 10;
2705                                 } else {
2706                                         *result += *(stream + 3) - 'a' + 10;
2707                                 }
2708                         }
2709                         break;
2710                 case '0':
2711                         /* Octal */
2712                         *consumed = 2;
2713                         for (i = 2; ; i++) {
2714                                 if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
2715                                         (*consumed)++;
2716                                         ast_debug(5, "result was %d, ", *result);
2717                                         *result <<= 3;
2718                                         *result += *(stream + i) - '0';
2719                                         ast_debug(5, "is now %d\n", *result);
2720                                 } else {
2721                                         break;
2722                                 }
2723                         }
2724                         break;
2725                 default:
2726                         *result = *(stream + 1);
2727                 }
2728         } else {
2729                 *result = *stream;
2730                 *consumed = 1;
2731         }
2732         return 0;
2733 }
2734
2735 char *ast_get_encoded_str(const char *stream, char *result, size_t result_size)
2736 {
2737         char *cur = result;
2738         size_t consumed;
2739
2740         while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
2741                 cur++;
2742                 stream += consumed;
2743         }
2744         *cur = '\0';
2745         return result;
2746 }
2747
2748 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream)
2749 {
2750         char next, *buf;
2751         size_t offset = 0;
2752         size_t consumed;
2753
2754         if (strchr(stream, '\\')) {
2755                 while (!ast_get_encoded_char(stream, &next, &consumed)) {
2756                         if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
2757                                 ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
2758                         }
2759                         if (offset + 2 > ast_str_size(*str)) {
2760                                 break;
2761                         }
2762                         buf = ast_str_buffer(*str);
2763                         buf[offset++] = next;
2764                         stream += consumed;
2765                 }
2766                 buf = ast_str_buffer(*str);
2767                 buf[offset++] = '\0';
2768                 ast_str_update(*str);
2769         } else {
2770                 ast_str_set(str, maxlen, "%s", stream);
2771         }
2772         return 0;
2773 }
2774
2775 void ast_close_fds_above_n(int n)
2776 {
2777         closefrom(n + 1);
2778 }
2779
2780 int ast_safe_fork(int stop_reaper)
2781 {
2782         sigset_t signal_set, old_set;
2783         int pid;
2784
2785         /* Don't let the default signal handler for children reap our status */
2786         if (stop_reaper) {
2787                 ast_replace_sigchld();
2788         }
2789
2790         sigfillset(&signal_set);
2791         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
2792
2793         pid = fork();
2794
2795         if (pid != 0) {
2796                 /* Fork failed or parent */
2797                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
2798                 if (!stop_reaper && pid > 0) {
2799                         struct zombie *cur = ast_calloc(1, sizeof(*cur));
2800                         if (cur) {
2801                                 cur->pid = pid;
2802                                 AST_LIST_LOCK(&zombies);
2803                                 AST_LIST_INSERT_TAIL(&zombies, cur, list);
2804                                 AST_LIST_UNLOCK(&zombies);
2805                                 if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
2806                                         if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
2807                                                 ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
2808                                                 shaun_of_the_dead_thread = AST_PTHREADT_NULL;
2809                                         }
2810                                 }
2811                         }
2812                 }
2813                 return pid;
2814         } else {
2815                 /* Child */
2816 #ifdef HAVE_CAP
2817                 cap_t cap = cap_from_text("cap_net_admin-eip");
2818
2819                 if (cap_set_proc(cap)) {
2820                         ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
2821                 }
2822                 cap_free(cap);
2823 #endif
2824
2825                 /* Before we unblock our signals, return our trapped signals back to the defaults */
2826                 signal(SIGHUP, SIG_DFL);
2827                 signal(SIGCHLD, SIG_DFL);
2828                 signal(SIGINT, SIG_DFL);
2829                 signal(SIGURG, SIG_DFL);
2830                 signal(SIGTERM, SIG_DFL);
2831                 signal(SIGPIPE, SIG_DFL);
2832                 signal(SIGXFSZ, SIG_DFL);
2833
2834                 /* unblock important signal handlers */
2835                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
2836                         ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
2837                         _exit(1);
2838                 }
2839
2840                 return pid;
2841         }
2842 }
2843
2844 void ast_safe_fork_cleanup(void)
2845 {
2846         ast_unreplace_sigchld();
2847 }
2848
2849 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen unit)
2850 {
2851         int res;
2852         char u[10];
2853 #ifdef HAVE_LONG_DOUBLE_WIDER
2854         long double amount;
2855         #define FMT "%30Lf%9s"
2856 #else
2857         double amount;
2858         #define FMT "%30lf%9s"
2859 #endif
2860         if (!timestr) {
2861                 return -1;
2862         }
2863
2864         res = sscanf(timestr, FMT, &amount, u);
2865
2866         if (res == 0 || res == EOF) {
2867 #undef FMT
2868                 return -1;
2869         } else if (res == 2) {
2870                 switch (u[0]) {
2871                 case 'h':
2872                 case 'H':
2873                         unit = TIMELEN_HOURS;
2874                         break;
2875                 case 's':
2876                 case 'S':
2877                         unit = TIMELEN_SECONDS;
2878                         break;
2879                 case 'm':
2880                 case 'M':
2881                         if (toupper(u[1]) == 'S') {
2882                                 unit = TIMELEN_MILLISECONDS;
2883                         } else if (u[1] == '\0') {
2884                                 unit = TIMELEN_MINUTES;
2885                         }
2886                         break;
2887                 }
2888         }
2889
2890         switch (unit) {
2891         case TIMELEN_HOURS:
2892                 amount *= 60;
2893                 /* fall-through */
2894         case TIMELEN_MINUTES:
2895                 amount *= 60;
2896                 /* fall-through */
2897         case TIMELEN_SECONDS:
2898                 amount *= 1000;
2899                 /* fall-through */
2900         case TIMELEN_MILLISECONDS:
2901                 ;
2902         }
2903         *result = amount > INT_MAX ? INT_MAX : (int) amount;
2904         return 0;
2905 }
2906
2907
2908
2909 static void mwi_state_dtor(void *obj)
2910 {
2911         struct ast_mwi_state *mwi_state = obj;
2912         ast_string_field_free_memory(mwi_state);
2913         ao2_cleanup(mwi_state->snapshot);
2914         mwi_state->snapshot = NULL;
2915 }
2916
2917 struct stasis_topic *ast_mwi_topic_all(void)
2918 {
2919         return mwi_topic_all;
2920 }
2921
2922 struct stasis_cache *ast_mwi_state_cache(void)
2923 {
2924         return mwi_state_cache;
2925 }
2926
2927 struct stasis_topic *ast_mwi_topic_cached(void)
2928 {
2929         return stasis_caching_get_topic(mwi_topic_cached);
2930 }
2931
2932 struct stasis_topic *ast_mwi_topic(const char *uniqueid)
2933 {
2934         return stasis_topic_pool_get_topic(mwi_topic_pool, uniqueid);
2935 }
2936
2937 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context)
2938 {
2939         RAII_VAR(struct ast_mwi_state *, mwi_state, NULL, ao2_cleanup);
2940
2941         ast_assert(!ast_strlen_zero(mailbox));
2942
2943         mwi_state = ao2_alloc(sizeof(*mwi_state), mwi_state_dtor);
2944         if (!mwi_state) {
2945                 return NULL;
2946         }
2947
2948         if (ast_string_field_init(mwi_state, 256)) {
2949                 return NULL;
2950         }
2951         if (!ast_strlen_zero(context)) {
2952                 ast_string_field_build(mwi_state, uniqueid, "%s@%s", mailbox, context);
2953         } else {
2954                 ast_string_field_set(mwi_state, uniqueid, mailbox);
2955         }
2956
2957         ao2_ref(mwi_state, +1);
2958         return mwi_state;
2959 }
2960
2961 /*!
2962  * \internal
2963  * \brief Create a MWI state snapshot message.
2964  * \since 12.2.0
2965  *
2966  * \param[in] mailbox The mailbox identifier string.
2967  * \param[in] context The context this mailbox resides in (NULL or "" if only using mailbox)
2968  * \param[in] new_msgs The number of new messages in this mailbox
2969  * \param[in] old_msgs The number of old messages in this mailbox
2970  * \param[in] channel_id A unique identifier for a channel associated with this
2971  * change in mailbox state
2972  * \param[in] eid The EID of the server that originally published the message
2973  *
2974  * \retval message on success.  Use ao2_cleanup() when done with it.
2975  * \retval NULL on error.
2976  */
2977 static struct stasis_message *mwi_state_create_message(
2978         const char *mailbox,
2979         const char *context,
2980         int new_msgs,
2981         int old_msgs,
2982         const char *channel_id,
2983         struct ast_eid *eid)
2984 {
2985         struct ast_mwi_state *mwi_state;
2986         struct stasis_message *message;
2987
2988         mwi_state = ast_mwi_create(mailbox, context);
2989         if (!mwi_state) {
2990                 return NULL;
2991         }
2992
2993         mwi_state->new_msgs = new_msgs;
2994         mwi_state->old_msgs = old_msgs;
2995
2996         if (!ast_strlen_zero(channel_id)) {
2997                 struct stasis_message *chan_message;
2998
2999                 chan_message = stasis_cache_get(ast_channel_cache(), ast_channel_snapshot_type(),
3000                         channel_id);
3001                 if (chan_message) {
3002                         mwi_state->snapshot = stasis_message_data(chan_message);
3003                         ao2_ref(mwi_state->snapshot, +1);
3004                 }
3005                 ao2_cleanup(chan_message);
3006         }
3007
3008         if (eid) {
3009                 mwi_state->eid = *eid;
3010         } else {
3011                 mwi_state->eid = ast_eid_default;
3012         }
3013
3014         /*
3015          * XXX As far as stasis is concerned, all MWI events are local.
3016          *
3017          * We may in the future want to make MWI aggregate local/remote
3018          * message counts similar to how device state aggregates state.
3019          */
3020         message = stasis_message_create_full(ast_mwi_state_type(), mwi_state, &ast_eid_default);
3021         ao2_cleanup(mwi_state);
3022         return message;
3023 }
3024
3025 int ast_publish_mwi_state_full(
3026         const char *mailbox,
3027         const char *context,
3028         int new_msgs,
3029         int old_msgs,
3030         const char *channel_id,
3031         struct ast_eid *eid)
3032 {
3033         struct ast_mwi_state *mwi_state;
3034         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
3035         struct stasis_topic *mailbox_specific_topic;
3036
3037         message = mwi_state_create_message(mailbox, context, new_msgs, old_msgs, channel_id, eid);
3038         if (!message) {
3039                 return -1;
3040         }
3041
3042         mwi_state = stasis_message_data(message);
3043         mailbox_specific_topic = ast_mwi_topic(mwi_state->uniqueid);
3044         if (!mailbox_specific_topic) {
3045                 return -1;
3046         }
3047
3048         stasis_publish(mailbox_specific_topic, message);
3049
3050         return 0;
3051 }
3052
3053 int ast_delete_mwi_state_full(const char *mailbox, const char *context, struct ast_eid *eid)
3054 {
3055         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
3056         struct stasis_message *cached_msg;
3057         struct stasis_message *clear_msg;
3058         struct ast_mwi_state *mwi_state;
3059         struct stasis_topic *mailbox_specific_topic;
3060
3061         msg = mwi_state_create_message(mailbox, context, 0, 0, NULL, eid);
3062         if (!msg) {
3063                 return -1;
3064         }
3065
3066         mwi_state = stasis_message_data(msg);
3067
3068         /*
3069          * XXX As far as stasis is concerned, all MWI events are local.
3070          *
3071          * For now, it is assumed that there is only one entity
3072          * maintaining the state of a particular mailbox.
3073          *
3074          * If we ever have multiple MWI event entities maintaining
3075          * the same mailbox that wish to delete their cached entry
3076          * we will need to do something about the race condition
3077          * potential between checking the cache and removing the
3078          * cache entry.
3079          */
3080         cached_msg = stasis_cache_get_by_eid(ast_mwi_state_cache(),
3081                 ast_mwi_state_type(), mwi_state->uniqueid, &ast_eid_default);
3082         if (!cached_msg) {
3083                 /* Nothing to clear */
3084                 return -1;
3085         }
3086         ao2_cleanup(cached_msg);
3087
3088         mailbox_specific_topic = ast_mwi_topic(mwi_state->uniqueid);
3089         if (!mailbox_specific_topic) {
3090                 return -1;
3091         }
3092
3093         clear_msg = stasis_cache_clear_create(msg);
3094         if (clear_msg) {
3095                 stasis_publish(mailbox_specific_topic, clear_msg);
3096         }
3097         ao2_cleanup(clear_msg);
3098         return 0;
3099 }
3100
3101 static const char *mwi_state_get_id(struct stasis_message *message)
3102 {
3103         if (ast_mwi_state_type() == stasis_message_type(message)) {
3104                 struct ast_mwi_state *mwi_state = stasis_message_data(message);
3105                 return mwi_state->uniqueid;
3106         } else if (stasis_subscription_change_type() == stasis_message_type(message)) {
3107                 struct stasis_subscription_change *change = stasis_message_data(message);
3108                 return change->uniqueid;
3109         }
3110
3111         return NULL;
3112 }
3113
3114 static void mwi_blob_dtor(void *obj)
3115 {
3116         struct ast_mwi_blob *mwi_blob = obj;
3117
3118         ao2_cleanup(mwi_blob->mwi_state);
3119         ast_json_unref(mwi_blob->blob);
3120 }
3121
3122 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
3123                                                struct stasis_message_type *message_type,
3124                                                struct ast_json *blob)
3125 {
3126         RAII_VAR(struct ast_mwi_blob *, obj, NULL, ao2_cleanup);
3127         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
3128
3129         ast_assert(blob != NULL);
3130
3131         obj = ao2_alloc(sizeof(*obj), mwi_blob_dtor);
3132         if (!obj) {
3133                 return NULL;
3134         }
3135
3136         obj->mwi_state = mwi_state;
3137         ao2_ref(obj->mwi_state, +1);
3138         obj->blob = ast_json_ref(blob);
3139
3140         /* This is not a normal MWI event.  Only used by the MinivmNotify app. */
3141         msg = stasis_message_create(message_type, obj);
3142         if (!msg) {
3143                 return NULL;
3144         }
3145
3146         ao2_ref(msg, +1);
3147         return msg;
3148 }
3149
3150 struct stasis_topic *ast_queue_topic_all(void)
3151 {
3152         return queue_topic_all;
3153 }
3154
3155 struct stasis_topic *ast_queue_topic(const char *queuename)
3156 {
3157         return stasis_topic_pool_get_topic(queue_topic_pool, queuename);
3158 }
3159
3160 static void app_cleanup(void)
3161 {
3162         ao2_cleanup(queue_topic_pool);
3163         queue_topic_pool = NULL;
3164         ao2_cleanup(queue_topic_all);
3165         queue_topic_all = NULL;
3166         ao2_cleanup(mwi_topic_pool);
3167         mwi_topic_pool = NULL;
3168         ao2_cleanup(mwi_topic_all);
3169         mwi_topic_all = NULL;
3170         ao2_cleanup(mwi_state_cache);
3171         mwi_state_cache = NULL;
3172         mwi_topic_cached = stasis_caching_unsubscribe_and_join(mwi_topic_cached);
3173         STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_state_type);
3174         STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_vm_app_type);
3175 }
3176
3177 int app_init(void)
3178 {
3179         ast_register_cleanup(app_cleanup);
3180
3181         if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_state_type) != 0) {
3182                 return -1;
3183         }
3184         if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_vm_app_type) != 0) {
3185                 return -1;
3186         }
3187         mwi_topic_all = stasis_topic_create("stasis_mwi_topic");
3188         if (!mwi_topic_all) {
3189                 return -1;
3190         }
3191         mwi_state_cache = stasis_cache_create(mwi_state_get_id);
3192         if (!mwi_state_cache) {
3193                 return -1;
3194         }
3195         mwi_topic_cached = stasis_caching_topic_create(mwi_topic_all, mwi_state_cache);
3196         if (!mwi_topic_cached) {
3197                 return -1;
3198         }
3199         mwi_topic_pool = stasis_topic_pool_create(mwi_topic_all);
3200         if (!mwi_topic_pool) {
3201                 return -1;
3202         }
3203         queue_topic_all = stasis_topic_create("stasis_queue_topic");
3204         if (!queue_topic_all) {
3205                 return -1;
3206         }
3207         queue_topic_pool = stasis_topic_pool_create(queue_topic_all);
3208         if (!queue_topic_pool) {
3209                 return -1;
3210         }
3211         return 0;
3212 }
3213