Voicemail: Remove mailbox identifier format (box@context) assumptions in the system.
[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 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
1074 {
1075         int d = 0;
1076
1077         ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", fn, ast_channel_name(chan));
1078         if ((d = ast_streamfile(chan, fn, ast_channel_language(chan)))) {
1079                 return d;
1080         }
1081
1082         d = ast_waitstream(chan, AST_DIGIT_ANY);
1083
1084         ast_stopstream(chan);
1085
1086         return d;
1087 }
1088
1089 /*!
1090  * \brief Construct a silence frame of the same duration as \a orig.
1091  *
1092  * The \a orig frame must be \ref AST_FORMAT_SLINEAR.
1093  *
1094  * \param orig Frame as basis for silence to generate.
1095  * \return New frame of silence; free with ast_frfree().
1096  * \return \c NULL on error.
1097  */
1098 static struct ast_frame *make_silence(const struct ast_frame *orig)
1099 {
1100         struct ast_frame *silence;
1101         size_t size;
1102         size_t datalen;
1103         size_t samples = 0;
1104         struct ast_frame *next;
1105
1106         if (!orig) {
1107                 return NULL;
1108         }
1109
1110         if (orig->subclass.format.id != AST_FORMAT_SLINEAR) {
1111                 ast_log(LOG_WARNING, "Attempting to silence non-slin frame\n");
1112                 return NULL;
1113         }
1114
1115         for (next = AST_LIST_NEXT(orig, frame_list);
1116                  orig;
1117                  orig = next, next = orig ? AST_LIST_NEXT(orig, frame_list) : NULL) {
1118                 samples += orig->samples;
1119         }
1120
1121         ast_verb(4, "Silencing %zd samples\n", samples);
1122
1123
1124         datalen = sizeof(short) * samples;
1125         size = sizeof(*silence) + datalen;
1126         silence = ast_calloc(1, size);
1127         if (!silence) {
1128                 return NULL;
1129         }
1130
1131         silence->mallocd = AST_MALLOCD_HDR;
1132         silence->frametype = AST_FRAME_VOICE;
1133         silence->data.ptr = (void *)(silence + 1);
1134         silence->samples = samples;
1135         silence->datalen = datalen;
1136
1137         ast_format_set(&silence->subclass.format, AST_FORMAT_SLINEAR, 0);
1138
1139         return silence;
1140 }
1141
1142 /*!
1143  * \brief Sets a channel's read format to \ref AST_FORMAT_SLINEAR, recording
1144  * its original format.
1145  *
1146  * \param chan Channel to modify.
1147  * \param[out] orig_format Output variable to store channel's original read
1148  *                         format.
1149  * \return 0 on success.
1150  * \return -1 on error.
1151  */
1152 static int set_read_to_slin(struct ast_channel *chan, struct ast_format *orig_format)
1153 {
1154         if (!chan || !orig_format) {
1155                 return -1;
1156         }
1157         ast_format_copy(orig_format, ast_channel_readformat(chan));
1158         return ast_set_read_format_by_id(chan, AST_FORMAT_SLINEAR);
1159 }
1160
1161 static int global_silence_threshold = 128;
1162 static int global_maxsilence = 0;
1163
1164 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
1165  * \param chan Channel to playback to/record from.
1166  * \param playfile Filename of sound to play before recording begins.
1167  * \param recordfile Filename to record to.
1168  * \param maxtime Maximum length of recording (in seconds).
1169  * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
1170  * \param duration Where to store actual length of the recorded message (in milliseconds).
1171  * \param sound_duration Where to store the length of the recorded message (in milliseconds), minus any silence
1172  * \param beep Whether to play a beep before starting to record.
1173  * \param silencethreshold
1174  * \param maxsilence Length of silence that will end a recording (in milliseconds).
1175  * \param path Optional filesystem path to unlock.
1176  * \param prepend If true, prepend the recorded audio to an existing file and follow prepend mode recording rules
1177  * \param acceptdtmf DTMF digits that will end the recording.
1178  * \param canceldtmf DTMF digits that will cancel the recording.
1179  * \param skip_confirmation_sound If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.
1180  *
1181  * \retval -1 failure or hangup
1182  * \retval 'S' Recording ended from silence timeout
1183  * \retval 't' Recording ended from the message exceeding the maximum duration, or via DTMF in prepend mode
1184  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
1185  */
1186 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)
1187 {
1188         int d = 0;
1189         char *fmts;
1190         char comment[256];
1191         int x, fmtcnt = 1, res = -1, outmsg = 0;
1192         struct ast_filestream *others[AST_MAX_FORMATS];
1193         char *sfmt[AST_MAX_FORMATS];
1194         char *stringp = NULL;
1195         time_t start, end;
1196         struct ast_dsp *sildet = NULL;   /* silence detector dsp */
1197         int totalsilence = 0;
1198         int dspsilence = 0;
1199         int olddspsilence = 0;
1200         struct ast_format rfmt;
1201         struct ast_silence_generator *silgen = NULL;
1202         char prependfile[PATH_MAX];
1203         int ioflags;    /* IO flags for writing output file */
1204
1205         ioflags = O_CREAT|O_WRONLY;
1206
1207         switch (if_exists) {
1208         case AST_RECORD_IF_EXISTS_FAIL:
1209                 ioflags |= O_EXCL;
1210                 break;
1211         case AST_RECORD_IF_EXISTS_OVERWRITE:
1212                 ioflags |= O_TRUNC;
1213                 break;
1214         case AST_RECORD_IF_EXISTS_APPEND:
1215                 ioflags |= O_APPEND;
1216                 break;
1217         }
1218
1219         ast_format_clear(&rfmt);
1220         if (silencethreshold < 0) {
1221                 silencethreshold = global_silence_threshold;
1222         }
1223
1224         if (maxsilence < 0) {
1225                 maxsilence = global_maxsilence;
1226         }
1227
1228         /* barf if no pointer passed to store duration in */
1229         if (!duration) {
1230                 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
1231                 return -1;
1232         }
1233
1234         ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
1235         snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, ast_channel_name(chan));
1236
1237         if (playfile || beep) {
1238                 if (!beep) {
1239                         d = ast_play_and_wait(chan, playfile);
1240                 }
1241                 if (d > -1) {
1242                         d = ast_stream_and_wait(chan, "beep", "");
1243                 }
1244                 if (d < 0) {
1245                         return -1;
1246                 }
1247         }
1248
1249         if (prepend) {
1250                 ast_copy_string(prependfile, recordfile, sizeof(prependfile));
1251                 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
1252         }
1253
1254         fmts = ast_strdupa(fmt);
1255
1256         stringp = fmts;
1257         strsep(&stringp, "|");
1258         ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
1259         sfmt[0] = ast_strdupa(fmts);
1260
1261         while ((fmt = strsep(&stringp, "|"))) {
1262                 if (fmtcnt > AST_MAX_FORMATS - 1) {
1263                         ast_log(LOG_WARNING, "Please increase AST_MAX_FORMATS in file.h\n");
1264                         break;
1265                 }
1266                 sfmt[fmtcnt++] = ast_strdupa(fmt);
1267         }
1268
1269         end = start = time(NULL);  /* pre-initialize end to be same as start in case we never get into loop */
1270         for (x = 0; x < fmtcnt; x++) {
1271                 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, ioflags, 0, AST_FILE_MODE);
1272                 ast_verb(3, "x=%d, open writing:  %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
1273
1274                 if (!others[x]) {
1275                         break;
1276                 }
1277         }
1278
1279         if (path) {
1280                 ast_unlock_path(path);
1281         }
1282
1283         if (maxsilence > 0) {
1284                 sildet = ast_dsp_new(); /* Create the silence detector */
1285                 if (!sildet) {
1286                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
1287                         return -1;
1288                 }
1289                 ast_dsp_set_threshold(sildet, silencethreshold);
1290                 res = set_read_to_slin(chan, &rfmt);
1291                 if (res < 0) {
1292                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1293                         ast_dsp_free(sildet);
1294                         return -1;
1295                 }
1296         }
1297
1298         if (!prepend) {
1299                 /* Request a video update */
1300                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
1301
1302                 if (ast_opt_transmit_silence) {
1303                         silgen = ast_channel_start_silence_generator(chan);
1304                 }
1305         }
1306
1307         if (x == fmtcnt) {
1308                 /* Loop, writing the packets we read to the writer(s), until
1309                  * we have reason to stop. */
1310                 struct ast_frame *f;
1311                 int paused = 0;
1312                 int muted = 0;
1313                 time_t pause_start = 0;
1314                 int paused_secs = 0;
1315                 int pausedsilence = 0;
1316
1317                 for (;;) {
1318                         if (!(res = ast_waitfor(chan, 2000))) {
1319                                 ast_debug(1, "One waitfor failed, trying another\n");
1320                                 /* Try one more time in case of masq */
1321                                 if (!(res = ast_waitfor(chan, 2000))) {
1322                                         ast_log(LOG_WARNING, "No audio available on %s??\n", ast_channel_name(chan));
1323                                         res = -1;
1324                                 }
1325                         }
1326
1327                         if (res < 0) {
1328                                 f = NULL;
1329                                 break;
1330                         }
1331                         if (!(f = ast_read(chan))) {
1332                                 break;
1333                         }
1334                         if (f->frametype == AST_FRAME_VOICE) {
1335                                 /* write each format */
1336                                 if (paused) {
1337                                         /* It's all good */
1338                                         res = 0;
1339                                 } else {
1340                                         RAII_VAR(struct ast_frame *, silence, NULL, ast_frame_dtor);
1341                                         struct ast_frame *orig = f;
1342
1343                                         if (muted) {
1344                                                 silence = make_silence(orig);
1345                                                 if (!silence) {
1346                                                         ast_log(LOG_WARNING,
1347                                                                 "Error creating silence\n");
1348                                                         break;
1349                                                 }
1350                                                 f = silence;
1351                                         }
1352                                         for (x = 0; x < fmtcnt; x++) {
1353                                                 if (prepend && !others[x]) {
1354                                                         break;
1355                                                 }
1356                                                 res = ast_writestream(others[x], f);
1357                                         }
1358                                         f = orig;
1359                                 }
1360
1361                                 /* Silence Detection */
1362                                 if (maxsilence > 0) {
1363                                         dspsilence = 0;
1364                                         ast_dsp_silence(sildet, f, &dspsilence);
1365                                         if (olddspsilence > dspsilence) {
1366                                                 totalsilence += olddspsilence;
1367                                         }
1368                                         olddspsilence = dspsilence;
1369
1370                                         if (paused) {
1371                                                 /* record how much silence there was while we are paused */
1372                                                 pausedsilence = dspsilence;
1373                                         } else if (dspsilence > pausedsilence) {
1374                                                 /* ignore the paused silence */
1375                                                 dspsilence -= pausedsilence;
1376                                         } else {
1377                                                 /* dspsilence has reset, reset pausedsilence */
1378                                                 pausedsilence = 0;
1379                                         }
1380
1381                                         if (dspsilence > maxsilence) {
1382                                                 /* Ended happily with silence */
1383                                                 ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", dspsilence/1000);
1384                                                 res = 'S';
1385                                                 outmsg = 2;
1386                                                 break;
1387                                         }
1388                                 }
1389                                 /* Exit on any error */
1390                                 if (res) {
1391                                         ast_log(LOG_WARNING, "Error writing frame\n");
1392                                         break;
1393                                 }
1394                         } else if (f->frametype == AST_FRAME_VIDEO) {
1395                                 /* Write only once */
1396                                 ast_writestream(others[0], f);
1397                         } else if (f->frametype == AST_FRAME_DTMF) {
1398                                 if (prepend) {
1399                                 /* stop recording with any digit */
1400                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1401                                         res = 't';
1402                                         outmsg = 2;
1403                                         break;
1404                                 }
1405                                 if (strchr(acceptdtmf, f->subclass.integer)) {
1406                                         ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1407                                         res = f->subclass.integer;
1408                                         outmsg = 2;
1409                                         break;
1410                                 }
1411                                 if (strchr(canceldtmf, f->subclass.integer)) {
1412                                         ast_verb(3, "User canceled message by pressing %c\n", f->subclass.integer);
1413                                         res = f->subclass.integer;
1414                                         outmsg = 0;
1415                                         break;
1416                                 }
1417                         } else if (f->frametype == AST_FRAME_CONTROL) {
1418                                 if (f->subclass.integer == AST_CONTROL_RECORD_CANCEL) {
1419                                         ast_verb(3, "Message canceled by control\n");
1420                                         outmsg = 0; /* cancels the recording */
1421                                         res = 0;
1422                                         break;
1423                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_STOP) {
1424                                         ast_verb(3, "Message ended by control\n");
1425                                         res = 0;
1426                                         break;
1427                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_SUSPEND) {
1428                                         paused = !paused;
1429                                         ast_verb(3, "Message %spaused by control\n",
1430                                                 paused ? "" : "un");
1431                                         if (paused) {
1432                                                 pause_start = time(NULL);
1433                                         } else {
1434                                                 paused_secs += time(NULL) - pause_start;
1435                                         }
1436                                 } else if (f->subclass.integer == AST_CONTROL_RECORD_MUTE) {
1437                                         muted = !muted;
1438                                         ast_verb(3, "Message %smuted by control\n",
1439                                                 muted ? "" : "un");
1440                                         /* We can only silence slin frames, so
1441                                          * set the mode, if we haven't already
1442                                          * for sildet
1443                                          */
1444                                         if (muted && !rfmt.id) {
1445                                                 ast_verb(3, "Setting read format to linear mode\n");
1446                                                 res = set_read_to_slin(chan, &rfmt);
1447                                                 if (res < 0) {
1448                                                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1449                                                         break;
1450                                                 }
1451                                         }
1452                                 }
1453                         }
1454                         if (maxtime && !paused) {
1455                                 end = time(NULL);
1456                                 if (maxtime < (end - start - paused_secs)) {
1457                                         ast_verb(3, "Took too long, cutting it short...\n");
1458                                         res = 't';
1459                                         outmsg = 2;
1460                                         break;
1461                                 }
1462                         }
1463                         ast_frfree(f);
1464                 }
1465                 if (!f) {
1466                         ast_verb(3, "User hung up\n");
1467                         res = -1;
1468                         outmsg = 1;
1469                 } else {
1470                         ast_frfree(f);
1471                 }
1472         } else {
1473                 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
1474         }
1475
1476         if (!prepend) {
1477                 if (silgen) {
1478                         ast_channel_stop_silence_generator(chan, silgen);
1479                 }
1480         }
1481
1482         /*!\note
1483          * Instead of asking how much time passed (end - start), calculate the number
1484          * of seconds of audio which actually went into the file.  This fixes a
1485          * problem where audio is stopped up on the network and never gets to us.
1486          *
1487          * Note that we still want to use the number of seconds passed for the max
1488          * message, otherwise we could get a situation where this stream is never
1489          * closed (which would create a resource leak).
1490          */
1491         *duration = others[0] ? ast_tellstream(others[0]) / 8000 : 0;
1492         if (sound_duration) {
1493                 *sound_duration = *duration;
1494         }
1495
1496         if (!prepend) {
1497                 /* Reduce duration by a total silence amount */
1498                 if (olddspsilence <= dspsilence) {
1499                         totalsilence += dspsilence;
1500                 }
1501
1502                 if (sound_duration) {
1503                         if (totalsilence > 0) {
1504                                 *sound_duration -= (totalsilence - 200) / 1000;
1505                         }
1506                         if (*sound_duration < 0) {
1507                                 *sound_duration = 0;
1508                         }
1509                 }
1510
1511                 if (dspsilence > 0) {
1512                         *duration -= (dspsilence - 200) / 1000;
1513                 }
1514
1515                 if (*duration < 0) {
1516                         *duration = 0;
1517                 }
1518
1519                 for (x = 0; x < fmtcnt; x++) {
1520                         if (!others[x]) {
1521                                 break;
1522                         }
1523                         /*!\note
1524                          * If we ended with silence, trim all but the first 200ms of silence
1525                          * off the recording.  However, if we ended with '#', we don't want
1526                          * to trim ANY part of the recording.
1527                          */
1528                         if (res > 0 && dspsilence) {
1529                                 /* rewind only the trailing silence */
1530                                 ast_stream_rewind(others[x], dspsilence - 200);
1531                         }
1532                         ast_truncstream(others[x]);
1533                         ast_closestream(others[x]);
1534                 }
1535         }
1536
1537         if (prepend && outmsg) {
1538                 struct ast_filestream *realfiles[AST_MAX_FORMATS];
1539                 struct ast_frame *fr;
1540
1541                 for (x = 0; x < fmtcnt; x++) {
1542                         snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
1543                         realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
1544                         if (!others[x] || !realfiles[x]) {
1545                                 break;
1546                         }
1547                         /*!\note Same logic as above. */
1548                         if (dspsilence) {
1549                                 ast_stream_rewind(others[x], dspsilence - 200);
1550                         }
1551                         ast_truncstream(others[x]);
1552                         /* add the original file too */
1553                         while ((fr = ast_readframe(realfiles[x]))) {
1554                                 ast_writestream(others[x], fr);
1555                                 ast_frfree(fr);
1556                         }
1557                         ast_closestream(others[x]);
1558                         ast_closestream(realfiles[x]);
1559                         ast_filerename(prependfile, recordfile, sfmt[x]);
1560                         ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
1561                         ast_filedelete(prependfile, sfmt[x]);
1562                 }
1563         }
1564         if (rfmt.id && ast_set_read_format(chan, &rfmt)) {
1565                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(&rfmt), ast_channel_name(chan));
1566         }
1567         if ((outmsg == 2) && (!skip_confirmation_sound)) {
1568                 ast_stream_and_wait(chan, "auth-thankyou", "");
1569         }
1570         if (sildet) {
1571                 ast_dsp_free(sildet);
1572         }
1573         return res;
1574 }
1575
1576 static const char default_acceptdtmf[] = "#";
1577 static const char default_canceldtmf[] = "";
1578
1579 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)
1580 {
1581         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);
1582 }
1583
1584 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)
1585 {
1586         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);
1587 }
1588
1589 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)
1590 {
1591         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);
1592 }
1593
1594 /* Channel group core functions */
1595
1596 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
1597 {
1598         int res = 0;
1599         char tmp[256];
1600         char *grp = NULL, *cat = NULL;
1601
1602         if (!ast_strlen_zero(data)) {
1603                 ast_copy_string(tmp, data, sizeof(tmp));
1604                 grp = tmp;
1605                 if ((cat = strchr(tmp, '@'))) {
1606                         *cat++ = '\0';
1607                 }
1608         }
1609
1610         if (!ast_strlen_zero(grp)) {
1611                 ast_copy_string(group, grp, group_max);
1612         } else {
1613                 *group = '\0';
1614         }
1615
1616         if (!ast_strlen_zero(cat)) {
1617                 ast_copy_string(category, cat, category_max);
1618         }
1619
1620         return res;
1621 }
1622
1623 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
1624 {
1625         int res = 0;
1626         char group[80] = "", category[80] = "";
1627         struct ast_group_info *gi = NULL;
1628         size_t len = 0;
1629
1630         if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
1631                 return -1;
1632         }
1633
1634         /* Calculate memory we will need if this is new */
1635         len = sizeof(*gi) + strlen(group) + 1;
1636         if (!ast_strlen_zero(category)) {
1637                 len += strlen(category) + 1;
1638         }
1639
1640         AST_RWLIST_WRLOCK(&groups);
1641         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1642                 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1643                         AST_RWLIST_REMOVE_CURRENT(group_list);
1644                         free(gi);
1645                         break;
1646                 }
1647         }
1648         AST_RWLIST_TRAVERSE_SAFE_END;
1649
1650         if (ast_strlen_zero(group)) {
1651                 /* Enable unsetting the group */
1652         } else if ((gi = calloc(1, len))) {
1653                 gi->chan = chan;
1654                 gi->group = (char *) gi + sizeof(*gi);
1655                 strcpy(gi->group, group);
1656                 if (!ast_strlen_zero(category)) {
1657                         gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
1658                         strcpy(gi->category, category);
1659                 }
1660                 AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
1661         } else {
1662                 res = -1;
1663         }
1664
1665         AST_RWLIST_UNLOCK(&groups);
1666
1667         return res;
1668 }
1669
1670 int ast_app_group_get_count(const char *group, const char *category)
1671 {
1672         struct ast_group_info *gi = NULL;
1673         int count = 0;
1674
1675         if (ast_strlen_zero(group)) {
1676                 return 0;
1677         }
1678
1679         AST_RWLIST_RDLOCK(&groups);
1680         AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1681                 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1682                         count++;
1683                 }
1684         }
1685         AST_RWLIST_UNLOCK(&groups);
1686
1687         return count;
1688 }
1689
1690 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
1691 {
1692         struct ast_group_info *gi = NULL;
1693         regex_t regexbuf_group;
1694         regex_t regexbuf_category;
1695         int count = 0;
1696
1697         if (ast_strlen_zero(groupmatch)) {
1698                 ast_log(LOG_NOTICE, "groupmatch empty\n");
1699                 return 0;
1700         }
1701
1702         /* if regex compilation fails, return zero matches */
1703         if (regcomp(&regexbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
1704                 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
1705                 return 0;
1706         }
1707
1708         if (!ast_strlen_zero(category) && regcomp(&regexbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
1709                 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
1710                 regfree(&regexbuf_group);
1711                 return 0;
1712         }
1713
1714         AST_RWLIST_RDLOCK(&groups);
1715         AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1716                 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)))) {
1717                         count++;
1718                 }
1719         }
1720         AST_RWLIST_UNLOCK(&groups);
1721
1722         regfree(&regexbuf_group);
1723         if (!ast_strlen_zero(category)) {
1724                 regfree(&regexbuf_category);
1725         }
1726
1727         return count;
1728 }
1729
1730 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
1731 {
1732         struct ast_group_info *gi = NULL;
1733
1734         AST_RWLIST_WRLOCK(&groups);
1735         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1736                 if (gi->chan == old) {
1737                         gi->chan = new;
1738                 } else if (gi->chan == new) {
1739                         AST_RWLIST_REMOVE_CURRENT(group_list);
1740                         ast_free(gi);
1741                 }
1742         }
1743         AST_RWLIST_TRAVERSE_SAFE_END;
1744         AST_RWLIST_UNLOCK(&groups);
1745
1746         return 0;
1747 }
1748
1749 int ast_app_group_discard(struct ast_channel *chan)
1750 {
1751         struct ast_group_info *gi = NULL;
1752
1753         AST_RWLIST_WRLOCK(&groups);
1754         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1755                 if (gi->chan == chan) {
1756                         AST_RWLIST_REMOVE_CURRENT(group_list);
1757                         ast_free(gi);
1758                 }
1759         }
1760         AST_RWLIST_TRAVERSE_SAFE_END;
1761         AST_RWLIST_UNLOCK(&groups);
1762
1763         return 0;
1764 }
1765
1766 int ast_app_group_list_wrlock(void)
1767 {
1768         return AST_RWLIST_WRLOCK(&groups);
1769 }
1770
1771 int ast_app_group_list_rdlock(void)
1772 {
1773         return AST_RWLIST_RDLOCK(&groups);
1774 }
1775
1776 struct ast_group_info *ast_app_group_list_head(void)
1777 {
1778         return AST_RWLIST_FIRST(&groups);
1779 }
1780
1781 int ast_app_group_list_unlock(void)
1782 {
1783         return AST_RWLIST_UNLOCK(&groups);
1784 }
1785
1786 #undef ast_app_separate_args
1787 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
1788
1789 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen)
1790 {
1791         int argc;
1792         char *scan, *wasdelim = NULL;
1793         int paren = 0, quote = 0, bracket = 0;
1794
1795         if (!array || !arraylen) {
1796                 return 0;
1797         }
1798
1799         memset(array, 0, arraylen * sizeof(*array));
1800
1801         if (!buf) {
1802                 return 0;
1803         }
1804
1805         scan = buf;
1806
1807         for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1808                 array[argc] = scan;
1809                 for (; *scan; scan++) {
1810                         if (*scan == '(') {
1811                                 paren++;
1812                         } else if (*scan == ')') {
1813                                 if (paren) {
1814                                         paren--;
1815                                 }
1816                         } else if (*scan == '[') {
1817                                 bracket++;
1818                         } else if (*scan == ']') {
1819                                 if (bracket) {
1820                                         bracket--;
1821                                 }
1822                         } else if (*scan == '"' && delim != '"') {
1823                                 quote = quote ? 0 : 1;
1824                                 if (remove_chars) {
1825                                         /* Remove quote character from argument */
1826                                         memmove(scan, scan + 1, strlen(scan));
1827                                         scan--;
1828                                 }
1829                         } else if (*scan == '\\') {
1830                                 if (remove_chars) {
1831                                         /* Literal character, don't parse */
1832                                         memmove(scan, scan + 1, strlen(scan));
1833                                 } else {
1834                                         scan++;
1835                                 }
1836                         } else if ((*scan == delim) && !paren && !quote && !bracket) {
1837                                 wasdelim = scan;
1838                                 *scan++ = '\0';
1839                                 break;
1840                         }
1841                 }
1842         }
1843
1844         /* If the last character in the original string was the delimiter, then
1845          * there is one additional argument. */
1846         if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
1847                 array[argc++] = scan;
1848         }
1849
1850         return argc;
1851 }
1852
1853 /* ABI compatible function */
1854 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
1855 {
1856         return __ast_app_separate_args(buf, delim, 1, array, arraylen);
1857 }
1858
1859 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1860 {
1861         char *s;
1862         char *fs;
1863         int res;
1864         int fd;
1865         int lp = strlen(path);
1866         time_t start;
1867
1868         s = ast_alloca(lp + 10);
1869         fs = ast_alloca(lp + 20);
1870
1871         snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
1872         fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
1873         if (fd < 0) {
1874                 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
1875                 return AST_LOCK_PATH_NOT_FOUND;
1876         }
1877         close(fd);
1878
1879         snprintf(s, strlen(path) + 9, "%s/.lock", path);
1880         start = time(NULL);
1881         while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5)) {
1882                 sched_yield();
1883         }
1884
1885         unlink(fs);
1886
1887         if (res) {
1888                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
1889                 return AST_LOCK_TIMEOUT;
1890         } else {
1891                 ast_debug(1, "Locked path '%s'\n", path);
1892                 return AST_LOCK_SUCCESS;
1893         }
1894 }
1895
1896 static int ast_unlock_path_lockfile(const char *path)
1897 {
1898         char *s;
1899         int res;
1900
1901         s = ast_alloca(strlen(path) + 10);
1902
1903         snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
1904
1905         if ((res = unlink(s))) {
1906                 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
1907         } else {
1908                 ast_debug(1, "Unlocked path '%s'\n", path);
1909         }
1910
1911         return res;
1912 }
1913
1914 struct path_lock {
1915         AST_LIST_ENTRY(path_lock) le;
1916         int fd;
1917         char *path;
1918 };
1919
1920 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
1921
1922 static void path_lock_destroy(struct path_lock *obj)
1923 {
1924         if (obj->fd >= 0) {
1925                 close(obj->fd);
1926         }
1927         if (obj->path) {
1928                 free(obj->path);
1929         }
1930         free(obj);
1931 }
1932
1933 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
1934 {
1935         char *fs;
1936         int res;
1937         int fd;
1938         time_t start;
1939         struct path_lock *pl;
1940         struct stat st, ost;
1941
1942         fs = ast_alloca(strlen(path) + 20);
1943
1944         snprintf(fs, strlen(path) + 19, "%s/lock", path);
1945         if (lstat(fs, &st) == 0) {
1946                 if ((st.st_mode & S_IFMT) == S_IFLNK) {
1947                         ast_log(LOG_WARNING, "Unable to create lock file "
1948                                         "'%s': it's already a symbolic link\n",
1949                                         fs);
1950                         return AST_LOCK_FAILURE;
1951                 }
1952                 if (st.st_nlink > 1) {
1953                         ast_log(LOG_WARNING, "Unable to create lock file "
1954                                         "'%s': %u hard links exist\n",
1955                                         fs, (unsigned int) st.st_nlink);
1956                         return AST_LOCK_FAILURE;
1957                 }
1958         }
1959         if ((fd = open(fs, O_WRONLY | O_CREAT, 0600)) < 0) {
1960                 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
1961                                 fs, strerror(errno));
1962                 return AST_LOCK_PATH_NOT_FOUND;
1963         }
1964         if (!(pl = ast_calloc(1, sizeof(*pl)))) {
1965                 /* We don't unlink the lock file here, on the possibility that
1966                  * someone else created it - better to leave a little mess
1967                  * than create a big one by destroying someone else's lock
1968                  * and causing something to be corrupted.
1969                  */
1970                 close(fd);
1971                 return AST_LOCK_FAILURE;
1972         }
1973         pl->fd = fd;
1974         pl->path = strdup(path);
1975
1976         time(&start);
1977         while (
1978                 #ifdef SOLARIS
1979                 ((res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd, F_GETFL) | O_NONBLOCK)) < 0) &&
1980                 #else
1981                 ((res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
1982                 #endif
1983                         (errno == EWOULDBLOCK) &&
1984                         (time(NULL) - start < 5))
1985                 usleep(1000);
1986         if (res) {
1987                 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
1988                                 path, strerror(errno));
1989                 /* No unlinking of lock done, since we tried and failed to
1990                  * flock() it.
1991                  */
1992                 path_lock_destroy(pl);
1993                 return AST_LOCK_TIMEOUT;
1994         }
1995
1996         /* Check for the race where the file is recreated or deleted out from
1997          * underneath us.
1998          */
1999         if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
2000                         st.st_dev != ost.st_dev &&
2001                         st.st_ino != ost.st_ino) {
2002                 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
2003                                 "file changed underneath us\n", fs);
2004                 path_lock_destroy(pl);
2005                 return AST_LOCK_FAILURE;
2006         }
2007
2008         /* Success: file created, flocked, and is the one we started with */
2009         AST_LIST_LOCK(&path_lock_list);
2010         AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
2011         AST_LIST_UNLOCK(&path_lock_list);
2012
2013         ast_debug(1, "Locked path '%s'\n", path);
2014
2015         return AST_LOCK_SUCCESS;
2016 }
2017
2018 static int ast_unlock_path_flock(const char *path)
2019 {
2020         char *s;
2021         struct path_lock *p;
2022
2023         s = ast_alloca(strlen(path) + 20);
2024
2025         AST_LIST_LOCK(&path_lock_list);
2026         AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
2027                 if (!strcmp(p->path, path)) {
2028                         AST_LIST_REMOVE_CURRENT(le);
2029                         break;
2030                 }
2031         }
2032         AST_LIST_TRAVERSE_SAFE_END;
2033         AST_LIST_UNLOCK(&path_lock_list);
2034
2035         if (p) {
2036                 snprintf(s, strlen(path) + 19, "%s/lock", path);
2037                 unlink(s);
2038                 path_lock_destroy(p);
2039                 ast_debug(1, "Unlocked path '%s'\n", path);
2040         } else {
2041                 ast_debug(1, "Failed to unlock path '%s': "
2042                                 "lock not found\n", path);
2043         }
2044
2045         return 0;
2046 }
2047
2048 void ast_set_lock_type(enum AST_LOCK_TYPE type)
2049 {
2050         ast_lock_type = type;
2051 }
2052
2053 enum AST_LOCK_RESULT ast_lock_path(const char *path)
2054 {
2055         enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
2056
2057         switch (ast_lock_type) {
2058         case AST_LOCK_TYPE_LOCKFILE:
2059                 r = ast_lock_path_lockfile(path);
2060                 break;
2061         case AST_LOCK_TYPE_FLOCK:
2062                 r = ast_lock_path_flock(path);
2063                 break;
2064         }
2065
2066         return r;
2067 }
2068
2069 int ast_unlock_path(const char *path)
2070 {
2071         int r = 0;
2072
2073         switch (ast_lock_type) {
2074         case AST_LOCK_TYPE_LOCKFILE:
2075                 r = ast_unlock_path_lockfile(path);
2076                 break;
2077         case AST_LOCK_TYPE_FLOCK:
2078                 r = ast_unlock_path_flock(path);
2079                 break;
2080         }
2081
2082         return r;
2083 }
2084
2085 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path)
2086 {
2087         int silencethreshold;
2088         int maxsilence = 0;
2089         int res = 0;
2090         int cmd = 0;
2091         int max_attempts = 3;
2092         int attempts = 0;
2093         int recorded = 0;
2094         int message_exists = 0;
2095         /* Note that urgent and private are for flagging messages as such in the future */
2096
2097         /* barf if no pointer passed to store duration in */
2098         if (!duration) {
2099                 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
2100                 return -1;
2101         }
2102
2103         cmd = '3';       /* Want to start by recording */
2104
2105         silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
2106
2107         while ((cmd >= 0) && (cmd != 't')) {
2108                 switch (cmd) {
2109                 case '1':
2110                         if (!message_exists) {
2111                                 /* In this case, 1 is to record a message */
2112                                 cmd = '3';
2113                                 break;
2114                         } else {
2115                                 ast_stream_and_wait(chan, "vm-msgsaved", "");
2116                                 cmd = 't';
2117                                 return res;
2118                         }
2119                 case '2':
2120                         /* Review */
2121                         ast_verb(3, "Reviewing the recording\n");
2122                         cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
2123                         break;
2124                 case '3':
2125                         message_exists = 0;
2126                         /* Record */
2127                         ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
2128                         recorded = 1;
2129                         if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
2130                                 /* User has hung up, no options to give */
2131                                 return cmd;
2132                         }
2133                         if (cmd == '0') {
2134                                 break;
2135                         } else if (cmd == '*') {
2136                                 break;
2137                         } else {
2138                                 /* If all is well, a message exists */
2139                                 message_exists = 1;
2140                                 cmd = 0;
2141                         }
2142                         break;
2143                 case '4':
2144                 case '5':
2145                 case '6':
2146                 case '7':
2147                 case '8':
2148                 case '9':
2149                 case '*':
2150                 case '#':
2151                         cmd = ast_play_and_wait(chan, "vm-sorry");
2152                         break;
2153                 default:
2154                         if (message_exists) {
2155                                 cmd = ast_play_and_wait(chan, "vm-review");
2156                         } else {
2157                                 if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
2158                                         cmd = ast_waitfordigit(chan, 600);
2159                                 }
2160                         }
2161
2162                         if (!cmd) {
2163                                 cmd = ast_waitfordigit(chan, 6000);
2164                         }
2165                         if (!cmd) {
2166                                 attempts++;
2167                         }
2168                         if (attempts > max_attempts) {
2169                                 cmd = 't';
2170                         }
2171                 }
2172         }
2173         if (cmd == 't') {
2174                 cmd = 0;
2175         }
2176         return cmd;
2177 }
2178
2179 #define RES_UPONE (1 << 16)
2180 #define RES_EXIT  (1 << 17)
2181 #define RES_REPEAT (1 << 18)
2182 #define RES_RESTART ((1 << 19) | RES_REPEAT)
2183
2184 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
2185
2186 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
2187 {
2188         int res;
2189         int (*ivr_func)(struct ast_channel *, void *);
2190         char *c;
2191         char *n;
2192
2193         switch (option->action) {
2194         case AST_ACTION_UPONE:
2195                 return RES_UPONE;
2196         case AST_ACTION_EXIT:
2197                 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
2198         case AST_ACTION_REPEAT:
2199                 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
2200         case AST_ACTION_RESTART:
2201                 return RES_RESTART ;
2202         case AST_ACTION_NOOP:
2203                 return 0;
2204         case AST_ACTION_BACKGROUND:
2205                 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
2206                 if (res < 0) {
2207                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2208                         res = 0;
2209                 }
2210                 return res;
2211         case AST_ACTION_PLAYBACK:
2212                 res = ast_stream_and_wait(chan, (char *)option->adata, "");
2213                 if (res < 0) {
2214                         ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2215                         res = 0;
2216                 }
2217                 return res;
2218         case AST_ACTION_MENU:
2219                 if ((res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata)) == -2) {
2220                         /* Do not pass entry errors back up, treat as though it was an "UPONE" */
2221                         res = 0;
2222                 }
2223                 return res;
2224         case AST_ACTION_WAITOPTION:
2225                 if (!(res = ast_waitfordigit(chan, ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 10000))) {
2226                         return 't';
2227                 }
2228                 return res;
2229         case AST_ACTION_CALLBACK:
2230                 ivr_func = option->adata;
2231                 res = ivr_func(chan, cbdata);
2232                 return res;
2233         case AST_ACTION_TRANSFER:
2234                 res = ast_parseable_goto(chan, option->adata);
2235                 return 0;
2236         case AST_ACTION_PLAYLIST:
2237         case AST_ACTION_BACKLIST:
2238                 res = 0;
2239                 c = ast_strdupa(option->adata);
2240                 while ((n = strsep(&c, ";"))) {
2241                         if ((res = ast_stream_and_wait(chan, n,
2242                                         (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : ""))) {
2243                                 break;
2244                         }
2245                 }
2246                 ast_stopstream(chan);
2247                 return res;
2248         default:
2249                 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
2250                 return 0;
2251         }
2252         return -1;
2253 }
2254
2255 static int option_exists(struct ast_ivr_menu *menu, char *option)
2256 {
2257         int x;
2258         for (x = 0; menu->options[x].option; x++) {
2259                 if (!strcasecmp(menu->options[x].option, option)) {
2260                         return x;
2261                 }
2262         }
2263         return -1;
2264 }
2265
2266 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
2267 {
2268         int x;
2269         for (x = 0; menu->options[x].option; x++) {
2270                 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) &&
2271                                 (menu->options[x].option[strlen(option)])) {
2272                         return x;
2273                 }
2274         }
2275         return -1;
2276 }
2277
2278 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
2279 {
2280         int res = 0;
2281         int ms;
2282         while (option_matchmore(menu, exten)) {
2283                 ms = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->dtimeoutms : 5000;
2284                 if (strlen(exten) >= maxexten - 1) {
2285                         break;
2286                 }
2287                 if ((res = ast_waitfordigit(chan, ms)) < 1) {
2288                         break;
2289                 }
2290                 exten[strlen(exten) + 1] = '\0';
2291                 exten[strlen(exten)] = res;
2292         }
2293         return res > 0 ? 0 : res;
2294 }
2295
2296 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2297 {
2298         /* Execute an IVR menu structure */
2299         int res = 0;
2300         int pos = 0;
2301         int retries = 0;
2302         char exten[AST_MAX_EXTENSION] = "s";
2303         if (option_exists(menu, "s") < 0) {
2304                 strcpy(exten, "g");
2305                 if (option_exists(menu, "g") < 0) {
2306                         ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
2307                         return -1;
2308                 }
2309         }
2310         while (!res) {
2311                 while (menu->options[pos].option) {
2312                         if (!strcasecmp(menu->options[pos].option, exten)) {
2313                                 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
2314                                 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
2315                                 if (res < 0) {
2316                                         break;
2317                                 } else if (res & RES_UPONE) {
2318                                         return 0;
2319                                 } else if (res & RES_EXIT) {
2320                                         return res;
2321                                 } else if (res & RES_REPEAT) {
2322                                         int maxretries = res & 0xffff;
2323                                         if ((res & RES_RESTART) == RES_RESTART) {
2324                                                 retries = 0;
2325                                         } else {
2326                                                 retries++;
2327                                         }
2328                                         if (!maxretries) {
2329                                                 maxretries = 3;
2330                                         }
2331                                         if ((maxretries > 0) && (retries >= maxretries)) {
2332                                                 ast_debug(1, "Max retries %d exceeded\n", maxretries);
2333                                                 return -2;
2334                                         } else {
2335                                                 if (option_exists(menu, "g") > -1) {
2336                                                         strcpy(exten, "g");
2337                                                 } else if (option_exists(menu, "s") > -1) {
2338                                                         strcpy(exten, "s");
2339                                                 }
2340                                         }
2341                                         pos = 0;
2342                                         continue;
2343                                 } else if (res && strchr(AST_DIGIT_ANY, res)) {
2344                                         ast_debug(1, "Got start of extension, %c\n", res);
2345                                         exten[1] = '\0';
2346                                         exten[0] = res;
2347                                         if ((res = read_newoption(chan, menu, exten, sizeof(exten)))) {
2348                                                 break;
2349                                         }
2350                                         if (option_exists(menu, exten) < 0) {
2351                                                 if (option_exists(menu, "i")) {
2352                                                         ast_debug(1, "Invalid extension entered, going to 'i'!\n");
2353                                                         strcpy(exten, "i");
2354                                                         pos = 0;
2355                                                         continue;
2356                                                 } else {
2357                                                         ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
2358                                                         res = -2;
2359                                                         break;
2360                                                 }
2361                                         } else {
2362                                                 ast_debug(1, "New existing extension: %s\n", exten);
2363                                                 pos = 0;
2364                                                 continue;
2365                                         }
2366                                 }
2367                         }
2368                         pos++;
2369                 }
2370                 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
2371                 pos = 0;
2372                 if (!strcasecmp(exten, "s")) {
2373                         strcpy(exten, "g");
2374                 } else {
2375                         break;
2376                 }
2377         }
2378         return res;
2379 }
2380
2381 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2382 {
2383         int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
2384         /* Hide internal coding */
2385         return res > 0 ? 0 : res;
2386 }
2387
2388 char *ast_read_textfile(const char *filename)
2389 {
2390         int fd, count = 0, res;
2391         char *output = NULL;
2392         struct stat filesize;
2393
2394         if (stat(filename, &filesize) == -1) {
2395                 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
2396                 return NULL;
2397         }
2398
2399         count = filesize.st_size + 1;
2400
2401         if ((fd = open(filename, O_RDONLY)) < 0) {
2402                 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
2403                 return NULL;
2404         }
2405
2406         if ((output = ast_malloc(count))) {
2407                 res = read(fd, output, count - 1);
2408                 if (res == count - 1) {
2409                         output[res] = '\0';
2410                 } else {
2411                         ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
2412                         ast_free(output);
2413                         output = NULL;
2414                 }
2415         }
2416
2417         close(fd);
2418
2419         return output;
2420 }
2421
2422 static int parse_options(const struct ast_app_option *options, void *_flags, char **args, char *optstr, int flaglen)
2423 {
2424         char *s, *arg;
2425         int curarg, res = 0;
2426         unsigned int argloc;
2427         struct ast_flags *flags = _flags;
2428         struct ast_flags64 *flags64 = _flags;
2429
2430         if (flaglen == 32) {
2431                 ast_clear_flag(flags, AST_FLAGS_ALL);
2432         } else {
2433                 flags64->flags = 0;
2434         }
2435
2436         if (!optstr) {
2437                 return 0;
2438         }
2439
2440         s = optstr;
2441         while (*s) {
2442                 curarg = *s++ & 0x7f;   /* the array (in app.h) has 128 entries */
2443                 argloc = options[curarg].arg_index;
2444                 if (*s == '(') {
2445                         int paren = 1, quote = 0;
2446                         int parsequotes = (s[1] == '"') ? 1 : 0;
2447
2448                         /* Has argument */
2449                         arg = ++s;
2450                         for (; *s; s++) {
2451                                 if (*s == '(' && !quote) {
2452                                         paren++;
2453                                 } else if (*s == ')' && !quote) {
2454                                         /* Count parentheses, unless they're within quotes (or backslashed, below) */
2455                                         paren--;
2456                                 } else if (*s == '"' && parsequotes) {
2457                                         /* Leave embedded quotes alone, unless they are the first character */
2458                                         quote = quote ? 0 : 1;
2459                                         ast_copy_string(s, s + 1, INT_MAX);
2460                                         s--;
2461                                 } else if (*s == '\\') {
2462                                         if (!quote) {
2463                                                 /* If a backslash is found outside of quotes, remove it */
2464                                                 ast_copy_string(s, s + 1, INT_MAX);
2465                                         } else if (quote && s[1] == '"') {
2466                                                 /* Backslash for a quote character within quotes, remove the backslash */
2467                                                 ast_copy_string(s, s + 1, INT_MAX);
2468                                         } else {
2469                                                 /* Backslash within quotes, keep both characters */
2470                                                 s++;
2471                                         }
2472                                 }
2473
2474                                 if (paren == 0) {
2475                                         break;
2476                                 }
2477                         }
2478                         /* This will find the closing paren we found above, or none, if the string ended before we found one. */
2479                         if ((s = strchr(s, ')'))) {
2480                                 if (argloc) {
2481                                         args[argloc - 1] = arg;
2482                                 }
2483                                 *s++ = '\0';
2484                         } else {
2485                                 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
2486                                 res = -1;
2487                                 break;
2488                         }
2489                 } else if (argloc) {
2490                         args[argloc - 1] = "";
2491                 }
2492                 if (flaglen == 32) {
2493                         ast_set_flag(flags, options[curarg].flag);
2494                 } else {
2495                         ast_set_flag64(flags64, options[curarg].flag);
2496                 }
2497         }
2498
2499         return res;
2500 }
2501
2502 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
2503 {
2504         return parse_options(options, flags, args, optstr, 32);
2505 }
2506
2507 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
2508 {
2509         return parse_options(options, flags, args, optstr, 64);
2510 }
2511
2512 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len)
2513 {
2514         unsigned int i, found = 0;
2515         for (i = 32; i < 128 && found < len; i++) {
2516                 if (ast_test_flag64(flags, options[i].flag)) {
2517                         buf[found++] = i;
2518                 }
2519         }
2520         buf[found] = '\0';
2521 }
2522
2523 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed)
2524 {
2525         int i;
2526         *consumed = 1;
2527         *result = 0;
2528         if (ast_strlen_zero(stream)) {
2529                 *consumed = 0;
2530                 return -1;
2531         }
2532
2533         if (*stream == '\\') {
2534                 *consumed = 2;
2535                 switch (*(stream + 1)) {
2536                 case 'n':
2537                         *result = '\n';
2538                         break;
2539                 case 'r':
2540                         *result = '\r';
2541                         break;
2542                 case 't':
2543                         *result = '\t';
2544                         break;
2545                 case 'x':
2546                         /* Hexadecimal */
2547                         if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
2548                                 *consumed = 3;
2549                                 if (*(stream + 2) <= '9') {
2550                                         *result = *(stream + 2) - '0';
2551                                 } else if (*(stream + 2) <= 'F') {
2552                                         *result = *(stream + 2) - 'A' + 10;
2553                                 } else {
2554                                         *result = *(stream + 2) - 'a' + 10;
2555                                 }
2556                         } else {
2557                                 ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
2558                                 return -1;
2559                         }
2560
2561                         if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
2562                                 *consumed = 4;
2563                                 *result <<= 4;
2564                                 if (*(stream + 3) <= '9') {
2565                                         *result += *(stream + 3) - '0';
2566                                 } else if (*(stream + 3) <= 'F') {
2567                                         *result += *(stream + 3) - 'A' + 10;
2568                                 } else {
2569                                         *result += *(stream + 3) - 'a' + 10;
2570                                 }
2571                         }
2572                         break;
2573                 case '0':
2574                         /* Octal */
2575                         *consumed = 2;
2576                         for (i = 2; ; i++) {
2577                                 if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
2578                                         (*consumed)++;
2579                                         ast_debug(5, "result was %d, ", *result);
2580                                         *result <<= 3;
2581                                         *result += *(stream + i) - '0';
2582                                         ast_debug(5, "is now %d\n", *result);
2583                                 } else {
2584                                         break;
2585                                 }
2586                         }
2587                         break;
2588                 default:
2589                         *result = *(stream + 1);
2590                 }
2591         } else {
2592                 *result = *stream;
2593                 *consumed = 1;
2594         }
2595         return 0;
2596 }
2597
2598 char *ast_get_encoded_str(const char *stream, char *result, size_t result_size)
2599 {
2600         char *cur = result;
2601         size_t consumed;
2602
2603         while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
2604                 cur++;
2605                 stream += consumed;
2606         }
2607         *cur = '\0';
2608         return result;
2609 }
2610
2611 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream)
2612 {
2613         char next, *buf;
2614         size_t offset = 0;
2615         size_t consumed;
2616
2617         if (strchr(stream, '\\')) {
2618                 while (!ast_get_encoded_char(stream, &next, &consumed)) {
2619                         if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
2620                                 ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
2621                         }
2622                         if (offset + 2 > ast_str_size(*str)) {
2623                                 break;
2624                         }
2625                         buf = ast_str_buffer(*str);
2626                         buf[offset++] = next;
2627                         stream += consumed;
2628                 }
2629                 buf = ast_str_buffer(*str);
2630                 buf[offset++] = '\0';
2631                 ast_str_update(*str);
2632         } else {
2633                 ast_str_set(str, maxlen, "%s", stream);
2634         }
2635         return 0;
2636 }
2637
2638 void ast_close_fds_above_n(int n)
2639 {
2640         closefrom(n + 1);
2641 }
2642
2643 int ast_safe_fork(int stop_reaper)
2644 {
2645         sigset_t signal_set, old_set;
2646         int pid;
2647
2648         /* Don't let the default signal handler for children reap our status */
2649         if (stop_reaper) {
2650                 ast_replace_sigchld();
2651         }
2652
2653         sigfillset(&signal_set);
2654         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
2655
2656         pid = fork();
2657
2658         if (pid != 0) {
2659                 /* Fork failed or parent */
2660                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
2661                 if (!stop_reaper && pid > 0) {
2662                         struct zombie *cur = ast_calloc(1, sizeof(*cur));
2663                         if (cur) {
2664                                 cur->pid = pid;
2665                                 AST_LIST_LOCK(&zombies);
2666                                 AST_LIST_INSERT_TAIL(&zombies, cur, list);
2667                                 AST_LIST_UNLOCK(&zombies);
2668                                 if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
2669                                         if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
2670                                                 ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
2671                                                 shaun_of_the_dead_thread = AST_PTHREADT_NULL;
2672                                         }
2673                                 }
2674                         }
2675                 }
2676                 return pid;
2677         } else {
2678                 /* Child */
2679 #ifdef HAVE_CAP
2680                 cap_t cap = cap_from_text("cap_net_admin-eip");
2681
2682                 if (cap_set_proc(cap)) {
2683                         ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
2684                 }
2685                 cap_free(cap);
2686 #endif
2687
2688                 /* Before we unblock our signals, return our trapped signals back to the defaults */
2689                 signal(SIGHUP, SIG_DFL);
2690                 signal(SIGCHLD, SIG_DFL);
2691                 signal(SIGINT, SIG_DFL);
2692                 signal(SIGURG, SIG_DFL);
2693                 signal(SIGTERM, SIG_DFL);
2694                 signal(SIGPIPE, SIG_DFL);
2695                 signal(SIGXFSZ, SIG_DFL);
2696
2697                 /* unblock important signal handlers */
2698                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
2699                         ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
2700                         _exit(1);
2701                 }
2702
2703                 return pid;
2704         }
2705 }
2706
2707 void ast_safe_fork_cleanup(void)
2708 {
2709         ast_unreplace_sigchld();
2710 }
2711
2712 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen unit)
2713 {
2714         int res;
2715         char u[10];
2716 #ifdef HAVE_LONG_DOUBLE_WIDER
2717         long double amount;
2718         #define FMT "%30Lf%9s"
2719 #else
2720         double amount;
2721         #define FMT "%30lf%9s"
2722 #endif
2723         if (!timestr) {
2724                 return -1;
2725         }
2726
2727         res = sscanf(timestr, FMT, &amount, u);
2728
2729         if (res == 0 || res == EOF) {
2730 #undef FMT
2731                 return -1;
2732         } else if (res == 2) {
2733                 switch (u[0]) {
2734                 case 'h':
2735                 case 'H':
2736                         unit = TIMELEN_HOURS;
2737                         break;
2738                 case 's':
2739                 case 'S':
2740                         unit = TIMELEN_SECONDS;
2741                         break;
2742                 case 'm':
2743                 case 'M':
2744                         if (toupper(u[1]) == 'S') {
2745                                 unit = TIMELEN_MILLISECONDS;
2746                         } else if (u[1] == '\0') {
2747                                 unit = TIMELEN_MINUTES;
2748                         }
2749                         break;
2750                 }
2751         }
2752
2753         switch (unit) {
2754         case TIMELEN_HOURS:
2755                 amount *= 60;
2756                 /* fall-through */
2757         case TIMELEN_MINUTES:
2758                 amount *= 60;
2759                 /* fall-through */
2760         case TIMELEN_SECONDS:
2761                 amount *= 1000;
2762                 /* fall-through */
2763         case TIMELEN_MILLISECONDS:
2764                 ;
2765         }
2766         *result = amount > INT_MAX ? INT_MAX : (int) amount;
2767         return 0;
2768 }
2769
2770
2771
2772 static void mwi_state_dtor(void *obj)
2773 {
2774         struct ast_mwi_state *mwi_state = obj;
2775         ast_string_field_free_memory(mwi_state);
2776         ao2_cleanup(mwi_state->snapshot);
2777         mwi_state->snapshot = NULL;
2778 }
2779
2780 struct stasis_topic *ast_mwi_topic_all(void)
2781 {
2782         return mwi_topic_all;
2783 }
2784
2785 struct stasis_cache *ast_mwi_state_cache(void)
2786 {
2787         return mwi_state_cache;
2788 }
2789
2790 struct stasis_topic *ast_mwi_topic_cached(void)
2791 {
2792         return stasis_caching_get_topic(mwi_topic_cached);
2793 }
2794
2795 struct stasis_topic *ast_mwi_topic(const char *uniqueid)
2796 {
2797         return stasis_topic_pool_get_topic(mwi_topic_pool, uniqueid);
2798 }
2799
2800 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context)
2801 {
2802         RAII_VAR(struct ast_mwi_state *, mwi_state, NULL, ao2_cleanup);
2803
2804         ast_assert(!ast_strlen_zero(mailbox));
2805
2806         mwi_state = ao2_alloc(sizeof(*mwi_state), mwi_state_dtor);
2807         if (!mwi_state) {
2808                 return NULL;
2809         }
2810
2811         if (ast_string_field_init(mwi_state, 256)) {
2812                 return NULL;
2813         }
2814         if (!ast_strlen_zero(context)) {
2815                 ast_string_field_build(mwi_state, uniqueid, "%s@%s", mailbox, context);
2816         } else {
2817                 ast_string_field_set(mwi_state, uniqueid, mailbox);
2818         }
2819
2820         ao2_ref(mwi_state, +1);
2821         return mwi_state;
2822 }
2823
2824
2825 int ast_publish_mwi_state_full(
2826                         const char *mailbox,
2827                         const char *context,
2828                         int new_msgs,
2829                         int old_msgs,
2830                         const char *channel_id,
2831                         struct ast_eid *eid)
2832 {
2833         RAII_VAR(struct ast_mwi_state *, mwi_state, NULL, ao2_cleanup);
2834         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
2835         struct stasis_topic *mailbox_specific_topic;
2836
2837         mwi_state = ast_mwi_create(mailbox, context);
2838         if (!mwi_state) {
2839                 return -1;
2840         }
2841
2842         mwi_state->new_msgs = new_msgs;
2843         mwi_state->old_msgs = old_msgs;
2844
2845         if (!ast_strlen_zero(channel_id)) {
2846                 RAII_VAR(struct stasis_message *, chan_message,
2847                         stasis_cache_get(ast_channel_cache(),
2848                                         ast_channel_snapshot_type(),
2849                                         channel_id),
2850                         ao2_cleanup);
2851                 if (chan_message) {
2852                         mwi_state->snapshot = stasis_message_data(chan_message);
2853                         ao2_ref(mwi_state->snapshot, +1);
2854                 }
2855         }
2856
2857         if (eid) {
2858                 mwi_state->eid = *eid;
2859         } else {
2860                 ast_set_default_eid(&mwi_state->eid);
2861         }
2862
2863         message = stasis_message_create(ast_mwi_state_type(), mwi_state);
2864
2865         mailbox_specific_topic = ast_mwi_topic(mwi_state->uniqueid);
2866         if (!mailbox_specific_topic) {
2867                 return -1;
2868         }
2869
2870         stasis_publish(mailbox_specific_topic, message);
2871
2872         return 0;
2873 }
2874
2875 static const char *mwi_state_get_id(struct stasis_message *message)
2876 {
2877         if (ast_mwi_state_type() == stasis_message_type(message)) {
2878                 struct ast_mwi_state *mwi_state = stasis_message_data(message);
2879                 return mwi_state->uniqueid;
2880         } else if (stasis_subscription_change_type() == stasis_message_type(message)) {
2881                 struct stasis_subscription_change *change = stasis_message_data(message);
2882                 return change->uniqueid;
2883         }
2884
2885         return NULL;
2886 }
2887
2888 static void mwi_blob_dtor(void *obj)
2889 {
2890         struct ast_mwi_blob *mwi_blob = obj;
2891
2892         ao2_cleanup(mwi_blob->mwi_state);
2893         ast_json_unref(mwi_blob->blob);
2894 }
2895
2896 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
2897                                                struct stasis_message_type *message_type,
2898                                                struct ast_json *blob)
2899 {
2900         RAII_VAR(struct ast_mwi_blob *, obj, NULL, ao2_cleanup);
2901         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2902
2903         ast_assert(blob != NULL);
2904
2905         obj = ao2_alloc(sizeof(*obj), mwi_blob_dtor);
2906         if (!obj) {
2907                 return NULL;
2908         }
2909
2910         obj->mwi_state = mwi_state;
2911         ao2_ref(obj->mwi_state, +1);
2912         obj->blob = ast_json_ref(blob);
2913
2914         msg = stasis_message_create(message_type, obj);
2915         if (!msg) {
2916                 return NULL;
2917         }
2918
2919         ao2_ref(msg, +1);
2920         return msg;
2921 }
2922
2923 struct stasis_topic *ast_queue_topic_all(void)
2924 {
2925         return queue_topic_all;
2926 }
2927
2928 struct stasis_topic *ast_queue_topic(const char *queuename)
2929 {
2930         return stasis_topic_pool_get_topic(queue_topic_pool, queuename);
2931 }
2932
2933 static void app_cleanup(void)
2934 {
2935         ao2_cleanup(queue_topic_pool);
2936         queue_topic_pool = NULL;
2937         ao2_cleanup(queue_topic_all);
2938         queue_topic_all = NULL;
2939         ao2_cleanup(mwi_topic_pool);
2940         mwi_topic_pool = NULL;
2941         ao2_cleanup(mwi_topic_all);
2942         mwi_topic_all = NULL;
2943         ao2_cleanup(mwi_state_cache);
2944         mwi_state_cache = NULL;
2945         mwi_topic_cached = stasis_caching_unsubscribe_and_join(mwi_topic_cached);
2946         STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_state_type);
2947         STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_vm_app_type);
2948 }
2949
2950 int app_init(void)
2951 {
2952         ast_register_cleanup(app_cleanup);
2953
2954         if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_state_type) != 0) {
2955                 return -1;
2956         }
2957         if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_vm_app_type) != 0) {
2958                 return -1;
2959         }
2960         mwi_topic_all = stasis_topic_create("stasis_mwi_topic");
2961         if (!mwi_topic_all) {
2962                 return -1;
2963         }
2964         mwi_state_cache = stasis_cache_create(mwi_state_get_id);
2965         if (!mwi_state_cache) {
2966                 return -1;
2967         }
2968         mwi_topic_cached = stasis_caching_topic_create(mwi_topic_all, mwi_state_cache);
2969         if (!mwi_topic_cached) {
2970                 return -1;
2971         }
2972         mwi_topic_pool = stasis_topic_pool_create(mwi_topic_all);
2973         if (!mwi_topic_pool) {
2974                 return -1;
2975         }
2976         queue_topic_all = stasis_topic_create("stasis_queue_topic");
2977         if (!queue_topic_all) {
2978                 return -1;
2979         }
2980         queue_topic_pool = stasis_topic_pool_create(queue_topic_all);
2981         if (!queue_topic_pool) {
2982                 return -1;
2983         }
2984         return 0;
2985 }
2986