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