2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2005, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Convenient Application Routines
23 * \author Mark Spencer <markster@digium.com>
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
33 <support_level>core</support_level>
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40 #ifdef HAVE_SYS_STAT_H
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) */
53 #include <sys/capability.h>
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"
74 #define MWI_TOPIC_BUCKETS 57
76 AST_THREADSTORAGE_PUBLIC(ast_str_thread_global_buf);
78 static pthread_t shaun_of_the_dead_thread = AST_PTHREADT_NULL;
82 AST_LIST_ENTRY(zombie) list;
85 static AST_LIST_HEAD_STATIC(zombies, zombie);
88 * @{ \brief Define \ref stasis topic objects for MWI
90 static struct stasis_topic *mwi_topic_all;
91 static struct stasis_caching_topic *mwi_topic_cached;
92 static struct stasis_topic_pool *mwi_topic_pool;
96 * @{ \brief Define \ref stasis message types for MWI
98 STASIS_MESSAGE_TYPE_DEFN(ast_mwi_state_type);
99 STASIS_MESSAGE_TYPE_DEFN(ast_mwi_vm_app_type);
104 static void *shaun_of_the_dead(void *data)
109 if (!AST_LIST_EMPTY(&zombies)) {
110 /* Don't allow cancellation while we have a lock. */
111 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
112 AST_LIST_LOCK(&zombies);
113 AST_LIST_TRAVERSE_SAFE_BEGIN(&zombies, cur, list) {
114 if (waitpid(cur->pid, &status, WNOHANG) != 0) {
115 AST_LIST_REMOVE_CURRENT(list);
119 AST_LIST_TRAVERSE_SAFE_END
120 AST_LIST_UNLOCK(&zombies);
121 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
123 pthread_testcancel();
124 /* Wait for 60 seconds, without engaging in a busy loop. */
125 ast_poll(NULL, 0, AST_LIST_FIRST(&zombies) ? 5000 : 60000);
131 #define AST_MAX_FORMATS 10
133 static AST_RWLIST_HEAD_STATIC(groups, ast_group_info);
136 * \brief This function presents a dialtone and reads an extension into 'collect'
137 * which must be a pointer to a **pre-initialized** array of char having a
138 * size of 'size' suitable for writing to. It will collect no more than the smaller
139 * of 'maxlen' or 'size' minus the original strlen() of collect digits.
140 * \param chan struct.
145 * \param timeout timeout in milliseconds
147 * \return 0 if extension does not exist, 1 if extension exists
149 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout)
151 struct ast_tone_zone_sound *ts;
159 if (ast_channel_pbx(chan) && ast_channel_pbx(chan)->dtimeoutms) {
160 timeout = ast_channel_pbx(chan)->dtimeoutms;
166 if ((ts = ast_get_indication_tone(ast_channel_zone(chan), "dial"))) {
167 res = ast_playtones_start(chan, 0, ts->data, 0);
168 ts = ast_tone_zone_sound_unref(ts);
170 ast_log(LOG_NOTICE, "Huh....? no dial for indications?\n");
173 for (x = strlen(collect); x < maxlen; ) {
174 res = ast_waitfordigit(chan, timeout);
175 if (!ast_ignore_pattern(context, collect)) {
176 ast_playtones_stop(chan);
185 if (!ast_matchmore_extension(chan, context, collect, 1,
186 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
192 res = ast_exists_extension(chan, context, collect, 1,
193 S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL)) ? 1 : 0;
200 * \brief ast_app_getdata
201 * \param c The channel to read from
202 * \param prompt The file to stream to the channel
203 * \param s The string to read in to. Must be at least the size of your length
204 * \param maxlen How many digits to read (maximum)
205 * \param timeout set timeout to 0 for "standard" timeouts. Set timeout to -1 for
206 * "ludicrous time" (essentially never times out) */
207 enum ast_getdata_result ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout)
209 int res = 0, to, fto;
210 char *front, *filename;
212 /* XXX Merge with full version? XXX */
220 filename = ast_strdupa(prompt);
221 while ((front = strsep(&filename, "&"))) {
222 ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", front, ast_channel_name(c));
223 if (!ast_strlen_zero(front)) {
224 res = ast_streamfile(c, front, ast_channel_language(c));
228 if (ast_strlen_zero(filename)) {
229 /* set timeouts for the last prompt */
230 fto = ast_channel_pbx(c) ? ast_channel_pbx(c)->rtimeoutms : 6000;
231 to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;
237 fto = to = 1000000000;
240 /* there is more than one prompt, so
241 * get rid of the long timeout between
242 * prompts, and make it 50ms */
244 to = ast_channel_pbx(c) ? ast_channel_pbx(c)->dtimeoutms : 2000;
246 res = ast_readstring(c, s, maxlen, to, fto, "#");
247 if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
250 if (!ast_strlen_zero(s)) {
258 /* The lock type used by ast_lock_path() / ast_unlock_path() */
259 static enum AST_LOCK_TYPE ast_lock_type = AST_LOCK_TYPE_LOCKFILE;
261 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
263 int res, to = 2000, fto = 6000;
265 if (!ast_strlen_zero(prompt)) {
266 res = ast_streamfile(c, prompt, ast_channel_language(c));
276 fto = to = 1000000000;
279 res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd);
284 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args)
286 struct ast_app *macro_app;
289 macro_app = pbx_findapp("Macro");
292 "Cannot run 'Macro(%s)'. The application is not available.\n", macro_args);
295 if (autoservice_chan) {
296 ast_autoservice_start(autoservice_chan);
299 ast_debug(4, "%s Original location: %s,%s,%d\n", ast_channel_name(macro_chan),
300 ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
301 ast_channel_priority(macro_chan));
303 res = pbx_exec(macro_chan, macro_app, macro_args);
304 ast_debug(4, "Macro exited with status %d\n", res);
307 * Assume anything negative from Macro is an error.
308 * Anything else is success.
316 ast_debug(4, "%s Ending location: %s,%s,%d\n", ast_channel_name(macro_chan),
317 ast_channel_context(macro_chan), ast_channel_exten(macro_chan),
318 ast_channel_priority(macro_chan));
320 if (autoservice_chan) {
321 ast_autoservice_stop(autoservice_chan);
326 int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_name, const char *macro_args)
332 if (ast_strlen_zero(macro_args)) {
333 return ast_app_exec_macro(autoservice_chan, macro_chan, macro_name);
336 /* Create the Macro application argument string. */
337 args_len = strlen(macro_name) + strlen(macro_args) + 2;
338 args_str = ast_malloc(args_len);
342 snprintf(args_str, args_len, "%s,%s", macro_name, macro_args);
344 res = ast_app_exec_macro(autoservice_chan, macro_chan, args_str);
349 static const struct ast_app_stack_funcs *app_stack_callbacks;
351 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs)
353 app_stack_callbacks = funcs;
356 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args)
358 const struct ast_app_stack_funcs *funcs;
359 const char *new_args;
361 funcs = app_stack_callbacks;
362 if (!funcs || !funcs->expand_sub_args) {
364 "Cannot expand 'Gosub(%s)' arguments. The app_stack module is not available.\n",
368 ast_module_ref(funcs->module);
370 new_args = funcs->expand_sub_args(chan, args);
371 ast_module_unref(funcs->module);
375 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup)
377 const struct ast_app_stack_funcs *funcs;
380 funcs = app_stack_callbacks;
381 if (!funcs || !funcs->run_sub) {
383 "Cannot run 'Gosub(%s)'. The app_stack module is not available.\n",
387 ast_module_ref(funcs->module);
389 if (autoservice_chan) {
390 ast_autoservice_start(autoservice_chan);
393 res = funcs->run_sub(sub_chan, sub_args, ignore_hangup);
394 ast_module_unref(funcs->module);
396 if (autoservice_chan) {
397 ast_autoservice_stop(autoservice_chan);
402 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)
408 if (ast_strlen_zero(sub_args)) {
409 return ast_app_exec_sub(autoservice_chan, sub_chan, sub_location, ignore_hangup);
412 /* Create the Gosub application argument string. */
413 args_len = strlen(sub_location) + strlen(sub_args) + 3;
414 args_str = ast_malloc(args_len);
418 snprintf(args_str, args_len, "%s(%s)", sub_location, sub_args);
420 res = ast_app_exec_sub(autoservice_chan, sub_chan, args_str, ignore_hangup);
425 static int (*ast_has_voicemail_func)(const char *mailbox, const char *folder) = NULL;
426 static int (*ast_inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs) = NULL;
427 static int (*ast_inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs) = NULL;
428 static int (*ast_sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context) = NULL;
429 static int (*ast_messagecount_func)(const char *context, const char *mailbox, const char *folder) = NULL;
430 static int (*ast_copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data) = NULL;
431 static const char *(*ast_vm_index_to_foldername_func)(int id) = NULL;
432 static struct ast_vm_mailbox_snapshot *(*ast_vm_mailbox_snapshot_create_func)(const char *mailbox,
436 enum ast_vm_snapshot_sort_val sort_val,
437 int combine_INBOX_and_OLD) = NULL;
438 static struct ast_vm_mailbox_snapshot *(*ast_vm_mailbox_snapshot_destroy_func)(struct ast_vm_mailbox_snapshot *mailbox_snapshot) = NULL;
439 static int (*ast_vm_msg_move_func)(const char *mailbox,
442 const char *oldfolder,
443 const char *old_msg_ids[],
444 const char *newfolder) = NULL;
445 static int (*ast_vm_msg_remove_func)(const char *mailbox,
449 const char *msgs[]) = NULL;
450 static int (*ast_vm_msg_forward_func)(const char *from_mailbox,
451 const char *from_context,
452 const char *from_folder,
453 const char *to_mailbox,
454 const char *to_context,
455 const char *to_folder,
457 const char *msg_ids[],
458 int delete_old) = NULL;
459 static int (*ast_vm_msg_play_func)(struct ast_channel *chan,
464 ast_vm_msg_play_cb cb) = NULL;
466 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
467 int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
468 int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
469 int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
470 int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context),
471 int (*copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data),
472 const char *vm_index_to_foldername_func(int id),
473 struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_create_func)(const char *mailbox,
477 enum ast_vm_snapshot_sort_val sort_val,
478 int combine_INBOX_and_OLD),
479 struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_destroy_func)(struct ast_vm_mailbox_snapshot *mailbox_snapshot),
480 int (*vm_msg_move_func)(const char *mailbox,
483 const char *oldfolder,
484 const char *old_msg_ids[],
485 const char *newfolder),
486 int (*vm_msg_remove_func)(const char *mailbox,
491 int (*vm_msg_forward_func)(const char *from_mailbox,
492 const char *from_context,
493 const char *from_folder,
494 const char *to_mailbox,
495 const char *to_context,
496 const char *to_folder,
498 const char *msg_ids[],
500 int (*vm_msg_play_func)(struct ast_channel *chan,
505 ast_vm_msg_play_cb cb))
507 ast_has_voicemail_func = has_voicemail_func;
508 ast_inboxcount_func = inboxcount_func;
509 ast_inboxcount2_func = inboxcount2_func;
510 ast_messagecount_func = messagecount_func;
511 ast_sayname_func = sayname_func;
512 ast_copy_recording_to_vm_func = copy_recording_to_vm_func;
513 ast_vm_index_to_foldername_func = vm_index_to_foldername_func;
514 ast_vm_mailbox_snapshot_create_func = vm_mailbox_snapshot_create_func;
515 ast_vm_mailbox_snapshot_destroy_func = vm_mailbox_snapshot_destroy_func;
516 ast_vm_msg_move_func = vm_msg_move_func;
517 ast_vm_msg_remove_func = vm_msg_remove_func;
518 ast_vm_msg_forward_func = vm_msg_forward_func;
519 ast_vm_msg_play_func = vm_msg_play_func;
522 void ast_uninstall_vm_functions(void)
524 ast_has_voicemail_func = NULL;
525 ast_inboxcount_func = NULL;
526 ast_inboxcount2_func = NULL;
527 ast_messagecount_func = NULL;
528 ast_sayname_func = NULL;
529 ast_copy_recording_to_vm_func = NULL;
530 ast_vm_index_to_foldername_func = NULL;
531 ast_vm_mailbox_snapshot_create_func = NULL;
532 ast_vm_mailbox_snapshot_destroy_func = NULL;
533 ast_vm_msg_move_func = NULL;
534 ast_vm_msg_remove_func = NULL;
535 ast_vm_msg_forward_func = NULL;
536 ast_vm_msg_play_func = NULL;
539 #ifdef TEST_FRAMEWORK
540 int (*ast_vm_test_create_user_func)(const char *context, const char *mailbox) = NULL;
541 int (*ast_vm_test_destroy_user_func)(const char *context, const char *mailbox) = NULL;
543 void ast_install_vm_test_functions(int (*vm_test_create_user_func)(const char *context, const char *mailbox),
544 int (*vm_test_destroy_user_func)(const char *context, const char *mailbox))
546 ast_vm_test_create_user_func = vm_test_create_user_func;
547 ast_vm_test_destroy_user_func = vm_test_destroy_user_func;
550 void ast_uninstall_vm_test_functions(void)
552 ast_vm_test_create_user_func = NULL;
553 ast_vm_test_destroy_user_func = NULL;
557 int ast_app_has_voicemail(const char *mailbox, const char *folder)
559 static int warned = 0;
560 if (ast_has_voicemail_func) {
561 return ast_has_voicemail_func(mailbox, folder);
564 if (warned++ % 10 == 0) {
565 ast_verb(3, "Message check requested for mailbox %s/folder %s but voicemail not loaded.\n", mailbox, folder ? folder : "INBOX");
572 * \brief Function used as a callback for ast_copy_recording_to_vm when a real one isn't installed.
573 * \param vm_rec_data Stores crucial information about the voicemail that will basically just be used
574 * to figure out what the name of the recipient was supposed to be
576 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data)
578 static int warned = 0;
580 if (ast_copy_recording_to_vm_func) {
581 return ast_copy_recording_to_vm_func(vm_rec_data);
584 if (warned++ % 10 == 0) {
585 ast_verb(3, "copy recording to voicemail called to copy %s.%s to %s@%s, but voicemail not loaded.\n",
586 vm_rec_data->recording_file, vm_rec_data->recording_ext,
587 vm_rec_data->mailbox, vm_rec_data->context);
593 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs)
595 static int warned = 0;
602 if (ast_inboxcount_func) {
603 return ast_inboxcount_func(mailbox, newmsgs, oldmsgs);
606 if (warned++ % 10 == 0) {
607 ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
613 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs)
615 static int warned = 0;
625 if (ast_inboxcount2_func) {
626 return ast_inboxcount2_func(mailbox, urgentmsgs, newmsgs, oldmsgs);
629 if (warned++ % 10 == 0) {
630 ast_verb(3, "Message count requested for mailbox %s but voicemail not loaded.\n", mailbox);
636 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context)
638 if (ast_sayname_func) {
639 return ast_sayname_func(chan, mailbox, context);
644 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder)
646 static int warned = 0;
647 if (ast_messagecount_func) {
648 return ast_messagecount_func(context, mailbox, folder);
653 ast_verb(3, "Message count requested for mailbox %s@%s/%s but voicemail not loaded.\n", mailbox, context, folder);
659 const char *ast_vm_index_to_foldername(int id)
661 if (ast_vm_index_to_foldername_func) {
662 return ast_vm_index_to_foldername_func(id);
667 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
671 enum ast_vm_snapshot_sort_val sort_val,
672 int combine_INBOX_and_OLD)
674 if (ast_vm_mailbox_snapshot_create_func) {
675 return ast_vm_mailbox_snapshot_create_func(mailbox, context, folder, descending, sort_val, combine_INBOX_and_OLD);
680 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot)
682 if (ast_vm_mailbox_snapshot_destroy_func) {
683 return ast_vm_mailbox_snapshot_destroy_func(mailbox_snapshot);
688 int ast_vm_msg_move(const char *mailbox,
691 const char *oldfolder,
692 const char *old_msg_ids[],
693 const char *newfolder)
695 if (ast_vm_msg_move_func) {
696 return ast_vm_msg_move_func(mailbox, context, num_msgs, oldfolder, old_msg_ids, newfolder);
701 int ast_vm_msg_remove(const char *mailbox,
707 if (ast_vm_msg_remove_func) {
708 return ast_vm_msg_remove_func(mailbox, context, num_msgs, folder, msgs);
713 int ast_vm_msg_forward(const char *from_mailbox,
714 const char *from_context,
715 const char *from_folder,
716 const char *to_mailbox,
717 const char *to_context,
718 const char *to_folder,
720 const char *msg_ids[],
723 if (ast_vm_msg_forward_func) {
724 return ast_vm_msg_forward_func(from_mailbox, from_context, from_folder, to_mailbox, to_context, to_folder, num_msgs, msg_ids, delete_old);
729 int ast_vm_msg_play(struct ast_channel *chan,
734 ast_vm_msg_play_cb cb)
736 if (ast_vm_msg_play_func) {
737 return ast_vm_msg_play_func(chan, mailbox, context, folder, msg_num, cb);
742 #ifdef TEST_FRAMEWORK
743 int ast_vm_test_create_user(const char *context, const char *mailbox)
745 if (ast_vm_test_create_user_func) {
746 return ast_vm_test_create_user_func(context, mailbox);
751 int ast_vm_test_destroy_user(const char *context, const char *mailbox)
753 if (ast_vm_test_destroy_user_func) {
754 return ast_vm_test_destroy_user_func(context, mailbox);
760 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration)
764 struct ast_silence_generator *silgen = NULL;
770 if (peer && ast_autoservice_start(peer)) {
774 /* Need a quiet time before sending digits. */
775 if (ast_opt_transmit_silence) {
776 silgen = ast_channel_start_silence_generator(chan);
778 res = ast_safe_sleep(chan, 100);
780 goto dtmf_stream_cleanup;
783 for (ptr = digits; *ptr; ptr++) {
785 /* 'w' -- wait half a second */
786 if ((res = ast_safe_sleep(chan, 500))) {
789 } else if (*ptr == 'W') {
790 /* 'W' -- wait a second */
791 if ((res = ast_safe_sleep(chan, 1000))) {
794 } else if (strchr("0123456789*#abcdfABCDF", *ptr)) {
795 if (*ptr == 'f' || *ptr == 'F') {
796 /* ignore return values if not supported by channel */
797 ast_indicate(chan, AST_CONTROL_FLASH);
799 /* Character represents valid DTMF */
800 ast_senddigit(chan, *ptr, duration);
802 /* pause between digits */
803 if ((res = ast_safe_sleep(chan, between))) {
807 ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n", *ptr);
813 ast_channel_stop_silence_generator(chan, silgen);
815 if (peer && ast_autoservice_stop(peer)) {
822 struct linear_state {
826 struct ast_format origwfmt;
829 static void linear_release(struct ast_channel *chan, void *params)
831 struct linear_state *ls = params;
833 if (ls->origwfmt.id && ast_set_write_format(chan, &ls->origwfmt)) {
834 ast_log(LOG_WARNING, "Unable to restore channel '%s' to format '%d'\n", ast_channel_name(chan), ls->origwfmt.id);
844 static int linear_generator(struct ast_channel *chan, void *data, int len, int samples)
846 short buf[2048 + AST_FRIENDLY_OFFSET / 2];
847 struct linear_state *ls = data;
848 struct ast_frame f = {
849 .frametype = AST_FRAME_VOICE,
850 .data.ptr = buf + AST_FRIENDLY_OFFSET / 2,
851 .offset = AST_FRIENDLY_OFFSET,
855 ast_format_set(&f.subclass.format, AST_FORMAT_SLINEAR, 0);
858 if (len > sizeof(buf) - AST_FRIENDLY_OFFSET) {
859 ast_log(LOG_WARNING, "Can't generate %d bytes of data!\n" , len);
860 len = sizeof(buf) - AST_FRIENDLY_OFFSET;
862 res = read(ls->fd, buf + AST_FRIENDLY_OFFSET/2, len);
874 static void *linear_alloc(struct ast_channel *chan, void *params)
876 struct linear_state *ls = params;
882 /* In this case, params is already malloc'd */
883 if (ls->allowoverride) {
884 ast_set_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
886 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT);
889 ast_format_copy(&ls->origwfmt, ast_channel_writeformat(chan));
891 if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR)) {
892 ast_log(LOG_WARNING, "Unable to set '%s' to linear format (write)\n", ast_channel_name(chan));
900 static struct ast_generator linearstream =
902 .alloc = linear_alloc,
903 .release = linear_release,
904 .generate = linear_generator,
907 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride)
909 struct linear_state *lin;
914 if (ast_strlen_zero(filename)) {
918 if (filename[0] == '/') {
919 ast_copy_string(tmpf, filename, sizeof(tmpf));
921 snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", ast_config_AST_DATA_DIR, "sounds", filename);
923 if ((fd = open(tmpf, O_RDONLY)) < 0) {
924 ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno));
928 if ((lin = ast_calloc(1, sizeof(*lin)))) {
930 lin->allowoverride = allowoverride;
931 lin->autoclose = autoclose;
932 res = ast_activate_generator(chan, &linearstream, lin);
937 static int control_streamfile(struct ast_channel *chan,
947 ast_waitstream_fr_cb cb)
953 long pause_restart_point = 0;
960 offset = *offsetms * 8; /* XXX Assumes 8kHz */
963 lang = ast_channel_language(chan);
967 blen += strlen(stop);
970 blen += strlen(suspend);
973 blen += strlen(restart);
977 breaks = ast_alloca(blen + 1);
980 strcat(breaks, stop);
983 strcat(breaks, suspend);
986 strcat(breaks, restart);
989 if (ast_channel_state(chan) != AST_STATE_UP) {
990 res = ast_answer(chan);
993 if ((end = strchr(file, ':'))) {
994 if (!strcasecmp(end, ":end")) {
1001 ast_stopstream(chan);
1002 res = ast_streamfile(chan, file, lang);
1004 if (pause_restart_point) {
1005 ast_seekstream(ast_channel_stream(chan), pause_restart_point, SEEK_SET);
1006 pause_restart_point = 0;
1008 else if (end || offset < 0) {
1012 ast_verb(3, "ControlPlayback seek to offset %ld from end\n", offset);
1014 ast_seekstream(ast_channel_stream(chan), offset, SEEK_END);
1017 } else if (offset) {
1018 ast_verb(3, "ControlPlayback seek to offset %ld\n", offset);
1019 ast_seekstream(ast_channel_stream(chan), offset, SEEK_SET);
1023 res = ast_waitstream_fr_w_cb(chan, breaks, fwd, rev, skipms, cb);
1025 res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms);
1033 /* We go at next loop if we got the restart char */
1034 if ((restart && strchr(restart, res)) || res == AST_CONTROL_STREAM_RESTART) {
1035 ast_debug(1, "we'll restart the stream here at next loop\n");
1036 pause_restart_point = 0;
1037 ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1039 ast_channel_name(chan),
1044 if ((suspend && strchr(suspend, res)) || res == AST_CONTROL_STREAM_SUSPEND) {
1045 pause_restart_point = ast_tellstream(ast_channel_stream(chan));
1046 ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1048 ast_channel_name(chan),
1051 ast_stopstream(chan);
1052 if (!(res = ast_waitfordigit(chan, 1000))) {
1054 } else if (res == -1 || (suspend && strchr(suspend, res)) || (stop && strchr(stop, res))
1055 || res == AST_CONTROL_STREAM_SUSPEND || res == AST_CONTROL_STREAM_STOP) {
1059 if ((suspend && (res == *suspend)) || res == AST_CONTROL_STREAM_SUSPEND) {
1061 ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1063 ast_channel_name(chan),
1073 /* if we get one of our stop chars, return it to the calling function */
1074 if ((stop && strchr(stop, res)) || res == AST_CONTROL_STREAM_STOP) {
1075 ast_test_suite_event_notify("PLAYBACK","Channel: %s\r\n"
1077 ast_channel_name(chan),
1083 if (pause_restart_point) {
1084 offset = pause_restart_point;
1086 if (ast_channel_stream(chan)) {
1087 offset = ast_tellstream(ast_channel_stream(chan));
1089 offset = -8; /* indicate end of file */
1094 *offsetms = offset / 8; /* samples --> ms ... XXX Assumes 8 kHz */
1097 ast_stopstream(chan);
1102 int ast_control_streamfile_w_cb(struct ast_channel *chan,
1107 const char *suspend,
1108 const char *restart,
1111 ast_waitstream_fr_cb cb)
1113 return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, NULL, cb);
1116 int ast_control_streamfile(struct ast_channel *chan, const char *file,
1117 const char *fwd, const char *rev,
1118 const char *stop, const char *suspend,
1119 const char *restart, int skipms, long *offsetms)
1121 return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, NULL, NULL);
1124 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
1125 const char *fwd, const char *rev, const char *stop, const char *suspend,
1126 const char *restart, int skipms, const char *lang, long *offsetms)
1128 return control_streamfile(chan, file, fwd, rev, stop, suspend, restart, skipms, offsetms, lang, NULL);
1131 int ast_play_and_wait(struct ast_channel *chan, const char *fn)
1135 ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", fn, ast_channel_name(chan));
1136 if ((d = ast_streamfile(chan, fn, ast_channel_language(chan)))) {
1140 d = ast_waitstream(chan, AST_DIGIT_ANY);
1142 ast_stopstream(chan);
1147 static int global_silence_threshold = 128;
1148 static int global_maxsilence = 0;
1150 /*! Optionally play a sound file or a beep, then record audio and video from the channel.
1151 * \param chan Channel to playback to/record from.
1152 * \param playfile Filename of sound to play before recording begins.
1153 * \param recordfile Filename to record to.
1154 * \param maxtime Maximum length of recording (in seconds).
1155 * \param fmt Format(s) to record message in. Multiple formats may be specified by separating them with a '|'.
1156 * \param duration Where to store actual length of the recorded message (in milliseconds).
1157 * \param sound_duration Where to store the length of the recorded message (in milliseconds), minus any silence
1158 * \param beep Whether to play a beep before starting to record.
1159 * \param silencethreshold
1160 * \param maxsilence Length of silence that will end a recording (in milliseconds).
1161 * \param path Optional filesystem path to unlock.
1162 * \param prepend If true, prepend the recorded audio to an existing file and follow prepend mode recording rules
1163 * \param acceptdtmf DTMF digits that will end the recording.
1164 * \param canceldtmf DTMF digits that will cancel the recording.
1165 * \param skip_confirmation_sound If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.
1167 * \retval -1 failure or hangup
1168 * \retval 'S' Recording ended from silence timeout
1169 * \retval 't' Recording ended from the message exceeding the maximum duration, or via DTMF in prepend mode
1170 * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
1172 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)
1177 int x, fmtcnt = 1, res = -1, outmsg = 0;
1178 struct ast_filestream *others[AST_MAX_FORMATS];
1179 char *sfmt[AST_MAX_FORMATS];
1180 char *stringp = NULL;
1182 struct ast_dsp *sildet = NULL; /* silence detector dsp */
1183 int totalsilence = 0;
1185 int olddspsilence = 0;
1186 struct ast_format rfmt;
1187 struct ast_silence_generator *silgen = NULL;
1188 char prependfile[PATH_MAX];
1190 ast_format_clear(&rfmt);
1191 if (silencethreshold < 0) {
1192 silencethreshold = global_silence_threshold;
1195 if (maxsilence < 0) {
1196 maxsilence = global_maxsilence;
1199 /* barf if no pointer passed to store duration in */
1201 ast_log(LOG_WARNING, "Error play_and_record called without duration pointer\n");
1205 ast_debug(1, "play_and_record: %s, %s, '%s'\n", playfile ? playfile : "<None>", recordfile, fmt);
1206 snprintf(comment, sizeof(comment), "Playing %s, Recording to: %s on %s\n", playfile ? playfile : "<None>", recordfile, ast_channel_name(chan));
1208 if (playfile || beep) {
1210 d = ast_play_and_wait(chan, playfile);
1213 d = ast_stream_and_wait(chan, "beep", "");
1221 ast_copy_string(prependfile, recordfile, sizeof(prependfile));
1222 strncat(prependfile, "-prepend", sizeof(prependfile) - strlen(prependfile) - 1);
1225 fmts = ast_strdupa(fmt);
1228 strsep(&stringp, "|");
1229 ast_debug(1, "Recording Formats: sfmts=%s\n", fmts);
1230 sfmt[0] = ast_strdupa(fmts);
1232 while ((fmt = strsep(&stringp, "|"))) {
1233 if (fmtcnt > AST_MAX_FORMATS - 1) {
1234 ast_log(LOG_WARNING, "Please increase AST_MAX_FORMATS in file.h\n");
1237 sfmt[fmtcnt++] = ast_strdupa(fmt);
1240 end = start = time(NULL); /* pre-initialize end to be same as start in case we never get into loop */
1241 for (x = 0; x < fmtcnt; x++) {
1242 others[x] = ast_writefile(prepend ? prependfile : recordfile, sfmt[x], comment, O_TRUNC, 0, AST_FILE_MODE);
1243 ast_verb(3, "x=%d, open writing: %s format: %s, %p\n", x, prepend ? prependfile : recordfile, sfmt[x], others[x]);
1251 ast_unlock_path(path);
1254 if (maxsilence > 0) {
1255 sildet = ast_dsp_new(); /* Create the silence detector */
1257 ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
1260 ast_dsp_set_threshold(sildet, silencethreshold);
1261 ast_format_copy(&rfmt, ast_channel_readformat(chan));
1262 res = ast_set_read_format_by_id(chan, AST_FORMAT_SLINEAR);
1264 ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1265 ast_dsp_free(sildet);
1271 /* Request a video update */
1272 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
1274 if (ast_opt_transmit_silence) {
1275 silgen = ast_channel_start_silence_generator(chan);
1280 /* Loop forever, writing the packets we read to the writer(s), until
1281 we read a digit or get a hangup */
1282 struct ast_frame *f;
1284 if (!(res = ast_waitfor(chan, 2000))) {
1285 ast_debug(1, "One waitfor failed, trying another\n");
1286 /* Try one more time in case of masq */
1287 if (!(res = ast_waitfor(chan, 2000))) {
1288 ast_log(LOG_WARNING, "No audio available on %s??\n", ast_channel_name(chan));
1297 if (!(f = ast_read(chan))) {
1300 if (f->frametype == AST_FRAME_VOICE) {
1301 /* write each format */
1302 for (x = 0; x < fmtcnt; x++) {
1303 if (prepend && !others[x]) {
1306 res = ast_writestream(others[x], f);
1309 /* Silence Detection */
1310 if (maxsilence > 0) {
1312 ast_dsp_silence(sildet, f, &dspsilence);
1313 if (olddspsilence > dspsilence) {
1314 totalsilence += olddspsilence;
1316 olddspsilence = dspsilence;
1318 if (dspsilence > maxsilence) {
1319 /* Ended happily with silence */
1320 ast_verb(3, "Recording automatically stopped after a silence of %d seconds\n", dspsilence/1000);
1326 /* Exit on any error */
1328 ast_log(LOG_WARNING, "Error writing frame\n");
1331 } else if (f->frametype == AST_FRAME_VIDEO) {
1332 /* Write only once */
1333 ast_writestream(others[0], f);
1334 } else if (f->frametype == AST_FRAME_DTMF) {
1336 /* stop recording with any digit */
1337 ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1342 if (strchr(acceptdtmf, f->subclass.integer)) {
1343 ast_verb(3, "User ended message by pressing %c\n", f->subclass.integer);
1344 res = f->subclass.integer;
1348 if (strchr(canceldtmf, f->subclass.integer)) {
1349 ast_verb(3, "User cancelled message by pressing %c\n", f->subclass.integer);
1350 res = f->subclass.integer;
1357 if (maxtime < (end - start)) {
1358 ast_verb(3, "Took too long, cutting it short...\n");
1367 ast_verb(3, "User hung up\n");
1374 ast_log(LOG_WARNING, "Error creating writestream '%s', format '%s'\n", recordfile, sfmt[x]);
1379 ast_channel_stop_silence_generator(chan, silgen);
1384 * Instead of asking how much time passed (end - start), calculate the number
1385 * of seconds of audio which actually went into the file. This fixes a
1386 * problem where audio is stopped up on the network and never gets to us.
1388 * Note that we still want to use the number of seconds passed for the max
1389 * message, otherwise we could get a situation where this stream is never
1390 * closed (which would create a resource leak).
1392 *duration = others[0] ? ast_tellstream(others[0]) / 8000 : 0;
1393 if (sound_duration) {
1394 *sound_duration = *duration;
1398 /* Reduce duration by a total silence amount */
1399 if (olddspsilence <= dspsilence) {
1400 totalsilence += dspsilence;
1403 if (sound_duration) {
1404 if (totalsilence > 0) {
1405 *sound_duration -= (totalsilence - 200) / 1000;
1407 if (*sound_duration < 0) {
1408 *sound_duration = 0;
1412 if (dspsilence > 0) {
1413 *duration -= (dspsilence - 200) / 1000;
1416 if (*duration < 0) {
1420 for (x = 0; x < fmtcnt; x++) {
1425 * If we ended with silence, trim all but the first 200ms of silence
1426 * off the recording. However, if we ended with '#', we don't want
1427 * to trim ANY part of the recording.
1429 if (res > 0 && dspsilence) {
1430 /* rewind only the trailing silence */
1431 ast_stream_rewind(others[x], dspsilence - 200);
1433 ast_truncstream(others[x]);
1434 ast_closestream(others[x]);
1438 if (prepend && outmsg) {
1439 struct ast_filestream *realfiles[AST_MAX_FORMATS];
1440 struct ast_frame *fr;
1442 for (x = 0; x < fmtcnt; x++) {
1443 snprintf(comment, sizeof(comment), "Opening the real file %s.%s\n", recordfile, sfmt[x]);
1444 realfiles[x] = ast_readfile(recordfile, sfmt[x], comment, O_RDONLY, 0, 0);
1445 if (!others[x] || !realfiles[x]) {
1448 /*!\note Same logic as above. */
1450 ast_stream_rewind(others[x], dspsilence - 200);
1452 ast_truncstream(others[x]);
1453 /* add the original file too */
1454 while ((fr = ast_readframe(realfiles[x]))) {
1455 ast_writestream(others[x], fr);
1458 ast_closestream(others[x]);
1459 ast_closestream(realfiles[x]);
1460 ast_filerename(prependfile, recordfile, sfmt[x]);
1461 ast_verb(4, "Recording Format: sfmts=%s, prependfile %s, recordfile %s\n", sfmt[x], prependfile, recordfile);
1462 ast_filedelete(prependfile, sfmt[x]);
1465 if (rfmt.id && ast_set_read_format(chan, &rfmt)) {
1466 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(&rfmt), ast_channel_name(chan));
1468 if ((outmsg == 2) && (!skip_confirmation_sound)) {
1469 ast_stream_and_wait(chan, "auth-thankyou", "");
1472 ast_dsp_free(sildet);
1477 static const char default_acceptdtmf[] = "#";
1478 static const char default_canceldtmf[] = "";
1480 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 silencethreshold, int maxsilence, const char *path, const char *acceptdtmf, const char *canceldtmf)
1482 return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, S_OR(acceptdtmf, default_acceptdtmf), S_OR(canceldtmf, default_canceldtmf), 0);
1485 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)
1487 return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, 0, silencethreshold, maxsilence, path, 0, default_acceptdtmf, default_canceldtmf, 0);
1490 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)
1492 return __ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, sound_duration, beep, silencethreshold, maxsilence, NULL, 1, default_acceptdtmf, default_canceldtmf, 1);
1495 /* Channel group core functions */
1497 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max)
1501 char *grp = NULL, *cat = NULL;
1503 if (!ast_strlen_zero(data)) {
1504 ast_copy_string(tmp, data, sizeof(tmp));
1506 if ((cat = strchr(tmp, '@'))) {
1511 if (!ast_strlen_zero(grp)) {
1512 ast_copy_string(group, grp, group_max);
1517 if (!ast_strlen_zero(cat)) {
1518 ast_copy_string(category, cat, category_max);
1524 int ast_app_group_set_channel(struct ast_channel *chan, const char *data)
1527 char group[80] = "", category[80] = "";
1528 struct ast_group_info *gi = NULL;
1531 if (ast_app_group_split_group(data, group, sizeof(group), category, sizeof(category))) {
1535 /* Calculate memory we will need if this is new */
1536 len = sizeof(*gi) + strlen(group) + 1;
1537 if (!ast_strlen_zero(category)) {
1538 len += strlen(category) + 1;
1541 AST_RWLIST_WRLOCK(&groups);
1542 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1543 if ((gi->chan == chan) && ((ast_strlen_zero(category) && ast_strlen_zero(gi->category)) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1544 AST_RWLIST_REMOVE_CURRENT(group_list);
1549 AST_RWLIST_TRAVERSE_SAFE_END;
1551 if (ast_strlen_zero(group)) {
1552 /* Enable unsetting the group */
1553 } else if ((gi = calloc(1, len))) {
1555 gi->group = (char *) gi + sizeof(*gi);
1556 strcpy(gi->group, group);
1557 if (!ast_strlen_zero(category)) {
1558 gi->category = (char *) gi + sizeof(*gi) + strlen(group) + 1;
1559 strcpy(gi->category, category);
1561 AST_RWLIST_INSERT_TAIL(&groups, gi, group_list);
1566 AST_RWLIST_UNLOCK(&groups);
1571 int ast_app_group_get_count(const char *group, const char *category)
1573 struct ast_group_info *gi = NULL;
1576 if (ast_strlen_zero(group)) {
1580 AST_RWLIST_RDLOCK(&groups);
1581 AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1582 if (!strcasecmp(gi->group, group) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !strcasecmp(gi->category, category)))) {
1586 AST_RWLIST_UNLOCK(&groups);
1591 int ast_app_group_match_get_count(const char *groupmatch, const char *category)
1593 struct ast_group_info *gi = NULL;
1594 regex_t regexbuf_group;
1595 regex_t regexbuf_category;
1598 if (ast_strlen_zero(groupmatch)) {
1599 ast_log(LOG_NOTICE, "groupmatch empty\n");
1603 /* if regex compilation fails, return zero matches */
1604 if (regcomp(®exbuf_group, groupmatch, REG_EXTENDED | REG_NOSUB)) {
1605 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", groupmatch);
1609 if (!ast_strlen_zero(category) && regcomp(®exbuf_category, category, REG_EXTENDED | REG_NOSUB)) {
1610 ast_log(LOG_ERROR, "Regex compile failed on: %s\n", category);
1611 regfree(®exbuf_group);
1615 AST_RWLIST_RDLOCK(&groups);
1616 AST_RWLIST_TRAVERSE(&groups, gi, group_list) {
1617 if (!regexec(®exbuf_group, gi->group, 0, NULL, 0) && (ast_strlen_zero(category) || (!ast_strlen_zero(gi->category) && !regexec(®exbuf_category, gi->category, 0, NULL, 0)))) {
1621 AST_RWLIST_UNLOCK(&groups);
1623 regfree(®exbuf_group);
1624 if (!ast_strlen_zero(category)) {
1625 regfree(®exbuf_category);
1631 int ast_app_group_update(struct ast_channel *old, struct ast_channel *new)
1633 struct ast_group_info *gi = NULL;
1635 AST_RWLIST_WRLOCK(&groups);
1636 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1637 if (gi->chan == old) {
1639 } else if (gi->chan == new) {
1640 AST_RWLIST_REMOVE_CURRENT(group_list);
1644 AST_RWLIST_TRAVERSE_SAFE_END;
1645 AST_RWLIST_UNLOCK(&groups);
1650 int ast_app_group_discard(struct ast_channel *chan)
1652 struct ast_group_info *gi = NULL;
1654 AST_RWLIST_WRLOCK(&groups);
1655 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&groups, gi, group_list) {
1656 if (gi->chan == chan) {
1657 AST_RWLIST_REMOVE_CURRENT(group_list);
1661 AST_RWLIST_TRAVERSE_SAFE_END;
1662 AST_RWLIST_UNLOCK(&groups);
1667 int ast_app_group_list_wrlock(void)
1669 return AST_RWLIST_WRLOCK(&groups);
1672 int ast_app_group_list_rdlock(void)
1674 return AST_RWLIST_RDLOCK(&groups);
1677 struct ast_group_info *ast_app_group_list_head(void)
1679 return AST_RWLIST_FIRST(&groups);
1682 int ast_app_group_list_unlock(void)
1684 return AST_RWLIST_UNLOCK(&groups);
1687 #undef ast_app_separate_args
1688 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
1690 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen)
1693 char *scan, *wasdelim = NULL;
1694 int paren = 0, quote = 0, bracket = 0;
1696 if (!array || !arraylen) {
1700 memset(array, 0, arraylen * sizeof(*array));
1708 for (argc = 0; *scan && (argc < arraylen - 1); argc++) {
1710 for (; *scan; scan++) {
1713 } else if (*scan == ')') {
1717 } else if (*scan == '[') {
1719 } else if (*scan == ']') {
1723 } else if (*scan == '"' && delim != '"') {
1724 quote = quote ? 0 : 1;
1726 /* Remove quote character from argument */
1727 memmove(scan, scan + 1, strlen(scan));
1730 } else if (*scan == '\\') {
1732 /* Literal character, don't parse */
1733 memmove(scan, scan + 1, strlen(scan));
1737 } else if ((*scan == delim) && !paren && !quote && !bracket) {
1745 /* If the last character in the original string was the delimiter, then
1746 * there is one additional argument. */
1747 if (*scan || (scan > buf && (scan - 1) == wasdelim)) {
1748 array[argc++] = scan;
1754 /* ABI compatible function */
1755 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen)
1757 return __ast_app_separate_args(buf, delim, 1, array, arraylen);
1760 static enum AST_LOCK_RESULT ast_lock_path_lockfile(const char *path)
1766 int lp = strlen(path);
1769 s = ast_alloca(lp + 10);
1770 fs = ast_alloca(lp + 20);
1772 snprintf(fs, strlen(path) + 19, "%s/.lock-%08lx", path, ast_random());
1773 fd = open(fs, O_WRONLY | O_CREAT | O_EXCL, AST_FILE_MODE);
1775 ast_log(LOG_ERROR, "Unable to create lock file '%s': %s\n", path, strerror(errno));
1776 return AST_LOCK_PATH_NOT_FOUND;
1780 snprintf(s, strlen(path) + 9, "%s/.lock", path);
1782 while (((res = link(fs, s)) < 0) && (errno == EEXIST) && (time(NULL) - start < 5)) {
1789 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n", path, strerror(errno));
1790 return AST_LOCK_TIMEOUT;
1792 ast_debug(1, "Locked path '%s'\n", path);
1793 return AST_LOCK_SUCCESS;
1797 static int ast_unlock_path_lockfile(const char *path)
1802 s = ast_alloca(strlen(path) + 10);
1804 snprintf(s, strlen(path) + 9, "%s/%s", path, ".lock");
1806 if ((res = unlink(s))) {
1807 ast_log(LOG_ERROR, "Could not unlock path '%s': %s\n", path, strerror(errno));
1809 ast_debug(1, "Unlocked path '%s'\n", path);
1816 AST_LIST_ENTRY(path_lock) le;
1821 static AST_LIST_HEAD_STATIC(path_lock_list, path_lock);
1823 static void path_lock_destroy(struct path_lock *obj)
1834 static enum AST_LOCK_RESULT ast_lock_path_flock(const char *path)
1840 struct path_lock *pl;
1841 struct stat st, ost;
1843 fs = ast_alloca(strlen(path) + 20);
1845 snprintf(fs, strlen(path) + 19, "%s/lock", path);
1846 if (lstat(fs, &st) == 0) {
1847 if ((st.st_mode & S_IFMT) == S_IFLNK) {
1848 ast_log(LOG_WARNING, "Unable to create lock file "
1849 "'%s': it's already a symbolic link\n",
1851 return AST_LOCK_FAILURE;
1853 if (st.st_nlink > 1) {
1854 ast_log(LOG_WARNING, "Unable to create lock file "
1855 "'%s': %u hard links exist\n",
1856 fs, (unsigned int) st.st_nlink);
1857 return AST_LOCK_FAILURE;
1860 if ((fd = open(fs, O_WRONLY | O_CREAT, 0600)) < 0) {
1861 ast_log(LOG_WARNING, "Unable to create lock file '%s': %s\n",
1862 fs, strerror(errno));
1863 return AST_LOCK_PATH_NOT_FOUND;
1865 if (!(pl = ast_calloc(1, sizeof(*pl)))) {
1866 /* We don't unlink the lock file here, on the possibility that
1867 * someone else created it - better to leave a little mess
1868 * than create a big one by destroying someone else's lock
1869 * and causing something to be corrupted.
1872 return AST_LOCK_FAILURE;
1875 pl->path = strdup(path);
1880 ((res = fcntl(pl->fd, F_SETLK, fcntl(pl->fd, F_GETFL) | O_NONBLOCK)) < 0) &&
1882 ((res = flock(pl->fd, LOCK_EX | LOCK_NB)) < 0) &&
1884 (errno == EWOULDBLOCK) &&
1885 (time(NULL) - start < 5))
1888 ast_log(LOG_WARNING, "Failed to lock path '%s': %s\n",
1889 path, strerror(errno));
1890 /* No unlinking of lock done, since we tried and failed to
1893 path_lock_destroy(pl);
1894 return AST_LOCK_TIMEOUT;
1897 /* Check for the race where the file is recreated or deleted out from
1900 if (lstat(fs, &st) != 0 && fstat(pl->fd, &ost) != 0 &&
1901 st.st_dev != ost.st_dev &&
1902 st.st_ino != ost.st_ino) {
1903 ast_log(LOG_WARNING, "Unable to create lock file '%s': "
1904 "file changed underneath us\n", fs);
1905 path_lock_destroy(pl);
1906 return AST_LOCK_FAILURE;
1909 /* Success: file created, flocked, and is the one we started with */
1910 AST_LIST_LOCK(&path_lock_list);
1911 AST_LIST_INSERT_TAIL(&path_lock_list, pl, le);
1912 AST_LIST_UNLOCK(&path_lock_list);
1914 ast_debug(1, "Locked path '%s'\n", path);
1916 return AST_LOCK_SUCCESS;
1919 static int ast_unlock_path_flock(const char *path)
1922 struct path_lock *p;
1924 s = ast_alloca(strlen(path) + 20);
1926 AST_LIST_LOCK(&path_lock_list);
1927 AST_LIST_TRAVERSE_SAFE_BEGIN(&path_lock_list, p, le) {
1928 if (!strcmp(p->path, path)) {
1929 AST_LIST_REMOVE_CURRENT(le);
1933 AST_LIST_TRAVERSE_SAFE_END;
1934 AST_LIST_UNLOCK(&path_lock_list);
1937 snprintf(s, strlen(path) + 19, "%s/lock", path);
1939 path_lock_destroy(p);
1940 ast_debug(1, "Unlocked path '%s'\n", path);
1942 ast_debug(1, "Failed to unlock path '%s': "
1943 "lock not found\n", path);
1949 void ast_set_lock_type(enum AST_LOCK_TYPE type)
1951 ast_lock_type = type;
1954 enum AST_LOCK_RESULT ast_lock_path(const char *path)
1956 enum AST_LOCK_RESULT r = AST_LOCK_FAILURE;
1958 switch (ast_lock_type) {
1959 case AST_LOCK_TYPE_LOCKFILE:
1960 r = ast_lock_path_lockfile(path);
1962 case AST_LOCK_TYPE_FLOCK:
1963 r = ast_lock_path_flock(path);
1970 int ast_unlock_path(const char *path)
1974 switch (ast_lock_type) {
1975 case AST_LOCK_TYPE_LOCKFILE:
1976 r = ast_unlock_path_lockfile(path);
1978 case AST_LOCK_TYPE_FLOCK:
1979 r = ast_unlock_path_flock(path);
1986 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path)
1988 int silencethreshold;
1992 int max_attempts = 3;
1995 int message_exists = 0;
1996 /* Note that urgent and private are for flagging messages as such in the future */
1998 /* barf if no pointer passed to store duration in */
2000 ast_log(LOG_WARNING, "Error ast_record_review called without duration pointer\n");
2004 cmd = '3'; /* Want to start by recording */
2006 silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
2008 while ((cmd >= 0) && (cmd != 't')) {
2011 if (!message_exists) {
2012 /* In this case, 1 is to record a message */
2016 ast_stream_and_wait(chan, "vm-msgsaved", "");
2022 ast_verb(3, "Reviewing the recording\n");
2023 cmd = ast_stream_and_wait(chan, recordfile, AST_DIGIT_ANY);
2028 ast_verb(3, "R%secording\n", recorded == 1 ? "e-r" : "");
2030 if ((cmd = ast_play_and_record(chan, playfile, recordfile, maxtime, fmt, duration, NULL, silencethreshold, maxsilence, path)) == -1) {
2031 /* User has hung up, no options to give */
2036 } else if (cmd == '*') {
2039 /* If all is well, a message exists */
2052 cmd = ast_play_and_wait(chan, "vm-sorry");
2055 if (message_exists) {
2056 cmd = ast_play_and_wait(chan, "vm-review");
2058 if (!(cmd = ast_play_and_wait(chan, "vm-torerecord"))) {
2059 cmd = ast_waitfordigit(chan, 600);
2064 cmd = ast_waitfordigit(chan, 6000);
2069 if (attempts > max_attempts) {
2080 #define RES_UPONE (1 << 16)
2081 #define RES_EXIT (1 << 17)
2082 #define RES_REPEAT (1 << 18)
2083 #define RES_RESTART ((1 << 19) | RES_REPEAT)
2085 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata);
2087 static int ivr_dispatch(struct ast_channel *chan, struct ast_ivr_option *option, char *exten, void *cbdata)
2090 int (*ivr_func)(struct ast_channel *, void *);
2094 switch (option->action) {
2095 case AST_ACTION_UPONE:
2097 case AST_ACTION_EXIT:
2098 return RES_EXIT | (((unsigned long)(option->adata)) & 0xffff);
2099 case AST_ACTION_REPEAT:
2100 return RES_REPEAT | (((unsigned long)(option->adata)) & 0xffff);
2101 case AST_ACTION_RESTART:
2102 return RES_RESTART ;
2103 case AST_ACTION_NOOP:
2105 case AST_ACTION_BACKGROUND:
2106 res = ast_stream_and_wait(chan, (char *)option->adata, AST_DIGIT_ANY);
2108 ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2112 case AST_ACTION_PLAYBACK:
2113 res = ast_stream_and_wait(chan, (char *)option->adata, "");
2115 ast_log(LOG_NOTICE, "Unable to find file '%s'!\n", (char *)option->adata);
2119 case AST_ACTION_MENU:
2120 if ((res = ast_ivr_menu_run_internal(chan, (struct ast_ivr_menu *)option->adata, cbdata)) == -2) {
2121 /* Do not pass entry errors back up, treat as though it was an "UPONE" */
2125 case AST_ACTION_WAITOPTION:
2126 if (!(res = ast_waitfordigit(chan, ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 10000))) {
2130 case AST_ACTION_CALLBACK:
2131 ivr_func = option->adata;
2132 res = ivr_func(chan, cbdata);
2134 case AST_ACTION_TRANSFER:
2135 res = ast_parseable_goto(chan, option->adata);
2137 case AST_ACTION_PLAYLIST:
2138 case AST_ACTION_BACKLIST:
2140 c = ast_strdupa(option->adata);
2141 while ((n = strsep(&c, ";"))) {
2142 if ((res = ast_stream_and_wait(chan, n,
2143 (option->action == AST_ACTION_BACKLIST) ? AST_DIGIT_ANY : ""))) {
2147 ast_stopstream(chan);
2150 ast_log(LOG_NOTICE, "Unknown dispatch function %d, ignoring!\n", option->action);
2156 static int option_exists(struct ast_ivr_menu *menu, char *option)
2159 for (x = 0; menu->options[x].option; x++) {
2160 if (!strcasecmp(menu->options[x].option, option)) {
2167 static int option_matchmore(struct ast_ivr_menu *menu, char *option)
2170 for (x = 0; menu->options[x].option; x++) {
2171 if ((!strncasecmp(menu->options[x].option, option, strlen(option))) &&
2172 (menu->options[x].option[strlen(option)])) {
2179 static int read_newoption(struct ast_channel *chan, struct ast_ivr_menu *menu, char *exten, int maxexten)
2183 while (option_matchmore(menu, exten)) {
2184 ms = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->dtimeoutms : 5000;
2185 if (strlen(exten) >= maxexten - 1) {
2188 if ((res = ast_waitfordigit(chan, ms)) < 1) {
2191 exten[strlen(exten) + 1] = '\0';
2192 exten[strlen(exten)] = res;
2194 return res > 0 ? 0 : res;
2197 static int ast_ivr_menu_run_internal(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2199 /* Execute an IVR menu structure */
2203 char exten[AST_MAX_EXTENSION] = "s";
2204 if (option_exists(menu, "s") < 0) {
2206 if (option_exists(menu, "g") < 0) {
2207 ast_log(LOG_WARNING, "No 's' nor 'g' extension in menu '%s'!\n", menu->title);
2212 while (menu->options[pos].option) {
2213 if (!strcasecmp(menu->options[pos].option, exten)) {
2214 res = ivr_dispatch(chan, menu->options + pos, exten, cbdata);
2215 ast_debug(1, "IVR Dispatch of '%s' (pos %d) yields %d\n", exten, pos, res);
2218 } else if (res & RES_UPONE) {
2220 } else if (res & RES_EXIT) {
2222 } else if (res & RES_REPEAT) {
2223 int maxretries = res & 0xffff;
2224 if ((res & RES_RESTART) == RES_RESTART) {
2232 if ((maxretries > 0) && (retries >= maxretries)) {
2233 ast_debug(1, "Max retries %d exceeded\n", maxretries);
2236 if (option_exists(menu, "g") > -1) {
2238 } else if (option_exists(menu, "s") > -1) {
2244 } else if (res && strchr(AST_DIGIT_ANY, res)) {
2245 ast_debug(1, "Got start of extension, %c\n", res);
2248 if ((res = read_newoption(chan, menu, exten, sizeof(exten)))) {
2251 if (option_exists(menu, exten) < 0) {
2252 if (option_exists(menu, "i")) {
2253 ast_debug(1, "Invalid extension entered, going to 'i'!\n");
2258 ast_debug(1, "Aborting on invalid entry, with no 'i' option!\n");
2263 ast_debug(1, "New existing extension: %s\n", exten);
2271 ast_debug(1, "Stopping option '%s', res is %d\n", exten, res);
2273 if (!strcasecmp(exten, "s")) {
2282 int ast_ivr_menu_run(struct ast_channel *chan, struct ast_ivr_menu *menu, void *cbdata)
2284 int res = ast_ivr_menu_run_internal(chan, menu, cbdata);
2285 /* Hide internal coding */
2286 return res > 0 ? 0 : res;
2289 char *ast_read_textfile(const char *filename)
2291 int fd, count = 0, res;
2292 char *output = NULL;
2293 struct stat filesize;
2295 if (stat(filename, &filesize) == -1) {
2296 ast_log(LOG_WARNING, "Error can't stat %s\n", filename);
2300 count = filesize.st_size + 1;
2302 if ((fd = open(filename, O_RDONLY)) < 0) {
2303 ast_log(LOG_WARNING, "Cannot open file '%s' for reading: %s\n", filename, strerror(errno));
2307 if ((output = ast_malloc(count))) {
2308 res = read(fd, output, count - 1);
2309 if (res == count - 1) {
2312 ast_log(LOG_WARNING, "Short read of %s (%d of %d): %s\n", filename, res, count - 1, strerror(errno));
2323 static int parse_options(const struct ast_app_option *options, void *_flags, char **args, char *optstr, int flaglen)
2326 int curarg, res = 0;
2327 unsigned int argloc;
2328 struct ast_flags *flags = _flags;
2329 struct ast_flags64 *flags64 = _flags;
2331 if (flaglen == 32) {
2332 ast_clear_flag(flags, AST_FLAGS_ALL);
2343 curarg = *s++ & 0x7f; /* the array (in app.h) has 128 entries */
2344 argloc = options[curarg].arg_index;
2346 int paren = 1, quote = 0;
2347 int parsequotes = (s[1] == '"') ? 1 : 0;
2352 if (*s == '(' && !quote) {
2354 } else if (*s == ')' && !quote) {
2355 /* Count parentheses, unless they're within quotes (or backslashed, below) */
2357 } else if (*s == '"' && parsequotes) {
2358 /* Leave embedded quotes alone, unless they are the first character */
2359 quote = quote ? 0 : 1;
2360 ast_copy_string(s, s + 1, INT_MAX);
2362 } else if (*s == '\\') {
2364 /* If a backslash is found outside of quotes, remove it */
2365 ast_copy_string(s, s + 1, INT_MAX);
2366 } else if (quote && s[1] == '"') {
2367 /* Backslash for a quote character within quotes, remove the backslash */
2368 ast_copy_string(s, s + 1, INT_MAX);
2370 /* Backslash within quotes, keep both characters */
2379 /* This will find the closing paren we found above, or none, if the string ended before we found one. */
2380 if ((s = strchr(s, ')'))) {
2382 args[argloc - 1] = arg;
2386 ast_log(LOG_WARNING, "Missing closing parenthesis for argument '%c' in string '%s'\n", curarg, arg);
2390 } else if (argloc) {
2391 args[argloc - 1] = "";
2393 if (flaglen == 32) {
2394 ast_set_flag(flags, options[curarg].flag);
2396 ast_set_flag64(flags64, options[curarg].flag);
2403 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
2405 return parse_options(options, flags, args, optstr, 32);
2408 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr)
2410 return parse_options(options, flags, args, optstr, 64);
2413 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len)
2415 unsigned int i, found = 0;
2416 for (i = 32; i < 128 && found < len; i++) {
2417 if (ast_test_flag64(flags, options[i].flag)) {
2424 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed)
2429 if (ast_strlen_zero(stream)) {
2434 if (*stream == '\\') {
2436 switch (*(stream + 1)) {
2448 if (strchr("0123456789ABCDEFabcdef", *(stream + 2)) && *(stream + 2) != '\0') {
2450 if (*(stream + 2) <= '9') {
2451 *result = *(stream + 2) - '0';
2452 } else if (*(stream + 2) <= 'F') {
2453 *result = *(stream + 2) - 'A' + 10;
2455 *result = *(stream + 2) - 'a' + 10;
2458 ast_log(LOG_ERROR, "Illegal character '%c' in hexadecimal string\n", *(stream + 2));
2462 if (strchr("0123456789ABCDEFabcdef", *(stream + 3)) && *(stream + 3) != '\0') {
2465 if (*(stream + 3) <= '9') {
2466 *result += *(stream + 3) - '0';
2467 } else if (*(stream + 3) <= 'F') {
2468 *result += *(stream + 3) - 'A' + 10;
2470 *result += *(stream + 3) - 'a' + 10;
2477 for (i = 2; ; i++) {
2478 if (strchr("01234567", *(stream + i)) && *(stream + i) != '\0') {
2480 ast_debug(5, "result was %d, ", *result);
2482 *result += *(stream + i) - '0';
2483 ast_debug(5, "is now %d\n", *result);
2490 *result = *(stream + 1);
2499 char *ast_get_encoded_str(const char *stream, char *result, size_t result_size)
2504 while (cur < result + result_size - 1 && !ast_get_encoded_char(stream, cur, &consumed)) {
2512 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream)
2518 if (strchr(stream, '\\')) {
2519 while (!ast_get_encoded_char(stream, &next, &consumed)) {
2520 if (offset + 2 > ast_str_size(*str) && maxlen > -1) {
2521 ast_str_make_space(str, maxlen > 0 ? maxlen : (ast_str_size(*str) + 48) * 2 - 48);
2523 if (offset + 2 > ast_str_size(*str)) {
2526 buf = ast_str_buffer(*str);
2527 buf[offset++] = next;
2530 buf = ast_str_buffer(*str);
2531 buf[offset++] = '\0';
2532 ast_str_update(*str);
2534 ast_str_set(str, maxlen, "%s", stream);
2539 void ast_close_fds_above_n(int n)
2544 int ast_safe_fork(int stop_reaper)
2546 sigset_t signal_set, old_set;
2549 /* Don't let the default signal handler for children reap our status */
2551 ast_replace_sigchld();
2554 sigfillset(&signal_set);
2555 pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
2560 /* Fork failed or parent */
2561 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
2562 if (!stop_reaper && pid > 0) {
2563 struct zombie *cur = ast_calloc(1, sizeof(*cur));
2566 AST_LIST_LOCK(&zombies);
2567 AST_LIST_INSERT_TAIL(&zombies, cur, list);
2568 AST_LIST_UNLOCK(&zombies);
2569 if (shaun_of_the_dead_thread == AST_PTHREADT_NULL) {
2570 if (ast_pthread_create_background(&shaun_of_the_dead_thread, NULL, shaun_of_the_dead, NULL)) {
2571 ast_log(LOG_ERROR, "Shaun of the Dead wants to kill zombies, but can't?!!\n");
2572 shaun_of_the_dead_thread = AST_PTHREADT_NULL;
2581 cap_t cap = cap_from_text("cap_net_admin-eip");
2583 if (cap_set_proc(cap)) {
2584 ast_log(LOG_WARNING, "Unable to remove capabilities.\n");
2589 /* Before we unblock our signals, return our trapped signals back to the defaults */
2590 signal(SIGHUP, SIG_DFL);
2591 signal(SIGCHLD, SIG_DFL);
2592 signal(SIGINT, SIG_DFL);
2593 signal(SIGURG, SIG_DFL);
2594 signal(SIGTERM, SIG_DFL);
2595 signal(SIGPIPE, SIG_DFL);
2596 signal(SIGXFSZ, SIG_DFL);
2598 /* unblock important signal handlers */
2599 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
2600 ast_log(LOG_WARNING, "unable to unblock signals: %s\n", strerror(errno));
2608 void ast_safe_fork_cleanup(void)
2610 ast_unreplace_sigchld();
2613 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen unit)
2617 #ifdef HAVE_LONG_DOUBLE_WIDER
2619 #define FMT "%30Lf%9s"
2622 #define FMT "%30lf%9s"
2628 if ((res = sscanf(timestr, FMT, &amount, u)) == 0) {
2631 } else if (res == 2) {
2635 unit = TIMELEN_HOURS;
2639 unit = TIMELEN_SECONDS;
2643 if (toupper(u[1]) == 'S') {
2644 unit = TIMELEN_MILLISECONDS;
2645 } else if (u[1] == '\0') {
2646 unit = TIMELEN_MINUTES;
2656 case TIMELEN_MINUTES:
2659 case TIMELEN_SECONDS:
2662 case TIMELEN_MILLISECONDS:
2665 *result = amount > INT_MAX ? INT_MAX : (int) amount;
2671 static void mwi_state_dtor(void *obj)
2673 struct ast_mwi_state *mwi_state = obj;
2674 ast_string_field_free_memory(mwi_state);
2675 ao2_cleanup(mwi_state->snapshot);
2676 mwi_state->snapshot = NULL;
2679 struct stasis_topic *ast_mwi_topic_all(void)
2681 return mwi_topic_all;
2684 struct stasis_caching_topic *ast_mwi_topic_cached(void)
2686 return mwi_topic_cached;
2689 struct stasis_topic *ast_mwi_topic(const char *uniqueid)
2691 return stasis_topic_pool_get_topic(mwi_topic_pool, uniqueid);
2694 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context)
2696 RAII_VAR(struct ast_mwi_state *, mwi_state, NULL, ao2_cleanup);
2697 struct ast_str *uniqueid = ast_str_alloca(AST_MAX_MAILBOX_UNIQUEID);
2699 ast_assert(!ast_strlen_zero(mailbox));
2700 ast_assert(!ast_strlen_zero(context));
2702 mwi_state = ao2_alloc(sizeof(*mwi_state), mwi_state_dtor);
2707 if (ast_string_field_init(mwi_state, 256)) {
2710 ast_str_set(&uniqueid, 0, "%s@%s", mailbox, context);
2711 ast_string_field_set(mwi_state, uniqueid, ast_str_buffer(uniqueid));
2712 ast_string_field_set(mwi_state, mailbox, mailbox);
2713 ast_string_field_set(mwi_state, context, context);
2715 ao2_ref(mwi_state, +1);
2720 int ast_publish_mwi_state_full(
2721 const char *mailbox,
2722 const char *context,
2725 const char *channel_id,
2726 struct ast_eid *eid)
2728 RAII_VAR(struct ast_mwi_state *, mwi_state, NULL, ao2_cleanup);
2729 RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
2730 struct ast_str *uniqueid = ast_str_alloca(AST_MAX_MAILBOX_UNIQUEID);
2731 struct stasis_topic *mailbox_specific_topic;
2733 mwi_state = ast_mwi_create(mailbox, context);
2738 mwi_state->new_msgs = new_msgs;
2739 mwi_state->old_msgs = old_msgs;
2741 if (!ast_strlen_zero(channel_id)) {
2742 RAII_VAR(struct stasis_message *, chan_message,
2743 stasis_cache_get(ast_channel_topic_all_cached(),
2744 ast_channel_snapshot_type(),
2748 mwi_state->snapshot = stasis_message_data(chan_message);
2749 ao2_ref(mwi_state->snapshot, +1);
2754 mwi_state->eid = *eid;
2756 ast_set_default_eid(&mwi_state->eid);
2759 message = stasis_message_create(ast_mwi_state_type(), mwi_state);
2761 mailbox_specific_topic = ast_mwi_topic(ast_str_buffer(uniqueid));
2762 if (!mailbox_specific_topic) {
2766 stasis_publish(mailbox_specific_topic, message);
2771 static const char *mwi_state_get_id(struct stasis_message *message)
2773 if (ast_mwi_state_type() == stasis_message_type(message)) {
2774 struct ast_mwi_state *mwi_state = stasis_message_data(message);
2775 return mwi_state->uniqueid;
2776 } else if (stasis_subscription_change_type() == stasis_message_type(message)) {
2777 struct stasis_subscription_change *change = stasis_message_data(message);
2778 return change->uniqueid;
2784 static void mwi_blob_dtor(void *obj)
2786 struct ast_mwi_blob *mwi_blob = obj;
2788 ao2_cleanup(mwi_blob->mwi_state);
2789 ast_json_unref(mwi_blob->blob);
2792 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
2793 struct stasis_message_type *message_type,
2794 struct ast_json *blob)
2796 RAII_VAR(struct ast_mwi_blob *, obj, NULL, ao2_cleanup);
2797 RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
2799 ast_assert(blob != NULL);
2801 obj = ao2_alloc(sizeof(*obj), mwi_blob_dtor);
2806 obj->mwi_state = mwi_state;
2807 ao2_ref(obj->mwi_state, +1);
2808 obj->blob = ast_json_ref(blob);
2810 msg = stasis_message_create(message_type, obj);
2819 static void app_cleanup(void)
2821 ao2_cleanup(mwi_topic_all);
2822 mwi_topic_all = NULL;
2823 mwi_topic_cached = stasis_caching_unsubscribe_and_join(mwi_topic_cached);
2824 STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_state_type);
2825 STASIS_MESSAGE_TYPE_CLEANUP(ast_mwi_vm_app_type);
2826 ao2_cleanup(mwi_topic_pool);
2827 mwi_topic_pool = NULL;
2832 ast_register_cleanup(app_cleanup);
2834 if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_state_type) != 0) {
2837 if (STASIS_MESSAGE_TYPE_INIT(ast_mwi_vm_app_type) != 0) {
2840 mwi_topic_all = stasis_topic_create("stasis_mwi_topic");
2841 if (!mwi_topic_all) {
2844 mwi_topic_cached = stasis_caching_topic_create(mwi_topic_all, mwi_state_get_id);
2845 if (!mwi_topic_cached) {
2848 mwi_topic_pool = stasis_topic_pool_create(mwi_topic_all);
2849 if (!mwi_topic_pool) {