Fix a build warning with stasis messages.
[asterisk/asterisk.git] / include / asterisk / app.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  * \brief Application convenience functions, designed to give consistent
20  *        look and feel to Asterisk apps.
21  */
22
23 #ifndef _ASTERISK_APP_H
24 #define _ASTERISK_APP_H
25
26 #include "asterisk/stringfields.h"
27 #include "asterisk/strings.h"
28 #include "asterisk/threadstorage.h"
29 #include "asterisk/file.h"
30 #include "asterisk/linkedlists.h"
31 #include "asterisk/utils.h"
32 #include "asterisk/stasis.h"
33
34 struct ast_flags64;
35
36 #if defined(__cplusplus) || defined(c_plusplus)
37 extern "C" {
38 #endif
39
40 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf);
41
42 /* IVR stuff */
43
44 /*! \brief Callback function for IVR
45     \return returns 0 on completion, -1 on hangup or digit if interrupted
46   */
47 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
48
49 typedef enum {
50         AST_ACTION_UPONE,       /*!< adata is unused */
51         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
52         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
53         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
54         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
55         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
56         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
57         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
58         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
59         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
60         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
61         AST_ACTION_NOOP,        /*!< adata is unused */
62         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
63 } ast_ivr_action;
64
65 /*!
66     Special "options" are:
67    \arg "s" - "start here (one time greeting)"
68    \arg "g" - "greeting/instructions"
69    \arg "t" - "timeout"
70    \arg "h" - "hangup"
71    \arg "i" - "invalid selection"
72
73 */
74 struct ast_ivr_option {
75         char *option;
76         ast_ivr_action action;
77         void *adata;
78 };
79
80 struct ast_ivr_menu {
81         char *title;            /*!< Title of menu */
82         unsigned int flags;     /*!< Flags */
83         struct ast_ivr_option *options; /*!< All options */
84 };
85  
86 /*!
87  * \brief Structure used for ast_copy_recording_to_vm in order to cleanly supply
88  * data needed for making the recording from the recorded file.
89  */
90 struct ast_vm_recording_data {
91         AST_DECLARE_STRING_FIELDS(
92                 AST_STRING_FIELD(context);
93                 AST_STRING_FIELD(mailbox);
94                 AST_STRING_FIELD(folder);
95                 AST_STRING_FIELD(recording_file);
96                 AST_STRING_FIELD(recording_ext);
97
98                 AST_STRING_FIELD(call_context);
99                 AST_STRING_FIELD(call_macrocontext);
100                 AST_STRING_FIELD(call_extension);
101                 AST_STRING_FIELD(call_callerchan);
102                 AST_STRING_FIELD(call_callerid);
103                 );
104         int call_priority;
105 };
106
107 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
108
109 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
110         static struct ast_ivr_option __options_##holder[] = foo;\
111         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
112
113 enum ast_timelen {
114         TIMELEN_HOURS,
115         TIMELEN_MINUTES,
116         TIMELEN_SECONDS,
117         TIMELEN_MILLISECONDS,
118 };
119
120 /*!     \brief Runs an IVR menu
121         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
122 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
123
124 /*! \brief Plays a stream and gets DTMF data from a channel
125  * \param c Which channel one is interacting with
126  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
127  *        It is also valid for this to be multiple files concatenated by "&".
128  *        For example, "file1&file2&file3".
129  * \param s The location where the DTMF data will be stored
130  * \param maxlen Max Length of the data
131  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
132  *
133  *  This function was designed for application programmers for situations where they need
134  *  to play a message and then get some DTMF data in response to the message.  If a digit
135  *  is pressed during playback, it will immediately break out of the message and continue
136  *  execution of your code.
137  */
138 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
139
140 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
141 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
142
143 /*!
144  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
145  * \since 11.0
146  *
147  * \details
148  * This is a shorthand method that makes it very easy to run a
149  * macro on any given channel.  It is perfectly reasonable to
150  * supply a NULL autoservice_chan here in case there is no
151  * channel to place into autoservice.
152  *
153  * \note Absolutely _NO_ channel locks should be held before calling this function.
154  *
155  * \param autoservice_chan A channel to place into autoservice while the macro is run
156  * \param macro_chan Channel to execute macro on.
157  * \param macro_args Macro application argument string.
158  *
159  * \retval 0 success
160  * \retval -1 on error
161  */
162 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args);
163
164 /*!
165  * \since 1.8
166  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
167  *
168  * \details
169  * This is a shorthand method that makes it very easy to run a
170  * macro on any given channel.  It is perfectly reasonable to
171  * supply a NULL autoservice_chan here in case there is no
172  * channel to place into autoservice.
173  *
174  * \note Absolutely _NO_ channel locks should be held before calling this function.
175  *
176  * \param autoservice_chan A channel to place into autoservice while the macro is run
177  * \param macro_chan Channel to execute macro on.
178  * \param macro_name The name of the macro to run.
179  * \param macro_args The arguments to pass to the macro.
180  *
181  * \retval 0 success
182  * \retval -1 on error
183  */
184 int ast_app_run_macro(struct ast_channel *autoservice_chan,
185         struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
186
187 /*!
188  * \brief Stack applications callback functions.
189  */
190 struct ast_app_stack_funcs {
191         /*!
192          * Module reference pointer so the module will stick around
193          * while a callback is active.
194          */
195         void *module;
196
197         /*!
198          * \brief Callback for the routine to run a subroutine on a channel.
199          *
200          * \note Absolutely _NO_ channel locks should be held before calling this function.
201          *
202          * \param chan Channel to execute subroutine on.
203          * \param args Gosub application argument string.
204          * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
205          *
206          * \retval 0 success
207          * \retval -1 on error
208          */
209         int (*run_sub)(struct ast_channel *chan, const char *args, int ignore_hangup);
210
211         /*!
212          * \brief Add missing context/exten to Gosub application argument string.
213          *
214          * \param chan Channel to obtain context/exten.
215          * \param args Gosub application argument string.
216          *
217          * \details
218          * Fills in the optional context and exten from the given channel.
219          *
220          * \retval New-args Gosub argument string on success.  Must be freed.
221          * \retval NULL on error.
222          */
223         const char *(*expand_sub_args)(struct ast_channel *chan, const char *args);
224
225         /* Add new API calls to the end here. */
226 };
227
228 /*!
229  * \since 11
230  * \brief Set stack application function callbacks
231  * \param funcs Stack applications callback functions.
232  */
233 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs);
234
235 /*!
236  * \brief Add missing context/exten to subroutine argument string.
237  *
238  * \param chan Channel to obtain context/exten.
239  * \param args Gosub application argument string.
240  *
241  * \details
242  * Fills in the optional context and exten from the given channel.
243  *
244  * \retval New-args Gosub argument string on success.  Must be freed.
245  * \retval NULL on error.
246  */
247 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args);
248
249 /*!
250  * \since 11
251  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
252  *
253  * \details
254  * This is a shorthand method that makes it very easy to run a
255  * subroutine on any given channel.  It is perfectly reasonable
256  * to supply a NULL autoservice_chan here in case there is no
257  * channel to place into autoservice.
258  *
259  * \note Absolutely _NO_ channel locks should be held before calling this function.
260  *
261  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
262  * \param sub_chan Channel to execute subroutine on.
263  * \param sub_args Gosub application argument string.
264  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
265  *
266  * \retval 0 success
267  * \retval -1 on error
268  */
269 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup);
270
271 /*!
272  * \since 11
273  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
274  *
275  * \details
276  * This is a shorthand method that makes it very easy to run a
277  * subroutine on any given channel.  It is perfectly reasonable
278  * to supply a NULL autoservice_chan here in case there is no
279  * channel to place into autoservice.
280  *
281  * \note Absolutely _NO_ channel locks should be held before calling this function.
282  *
283  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
284  * \param sub_chan Channel to execute subroutine on.
285  * \param sub_location The location of the subroutine to run.
286  * \param sub_args The arguments to pass to the subroutine.
287  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
288  *
289  * \retval 0 success
290  * \retval -1 on error
291  */
292 int ast_app_run_sub(struct ast_channel *autoservice_chan,
293         struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup);
294
295 enum ast_vm_snapshot_sort_val {
296         AST_VM_SNAPSHOT_SORT_BY_ID = 0,
297         AST_VM_SNAPSHOT_SORT_BY_TIME,
298 };
299
300 struct ast_vm_msg_snapshot {
301         AST_DECLARE_STRING_FIELDS(
302                 AST_STRING_FIELD(msg_id);
303                 AST_STRING_FIELD(callerid);
304                 AST_STRING_FIELD(callerchan);
305                 AST_STRING_FIELD(exten);
306                 AST_STRING_FIELD(origdate);
307                 AST_STRING_FIELD(origtime);
308                 AST_STRING_FIELD(duration);
309                 AST_STRING_FIELD(folder_name);
310                 AST_STRING_FIELD(flag);
311         );
312         unsigned int msg_number;
313
314         AST_LIST_ENTRY(ast_vm_msg_snapshot) msg;
315 };
316
317 struct ast_vm_mailbox_snapshot {
318         int total_msg_num;
319         int folders;
320         /* Things are not quite as they seem here.  This points to an allocated array of lists. */
321         AST_LIST_HEAD_NOLOCK(, ast_vm_msg_snapshot) *snapshots;
322 };
323
324 /*!
325  * \brief Voicemail playback callback function definition
326  *
327  * \param channel to play the file back on.
328  * \param location of file on disk
329  * \param duration of file in seconds. This will be zero if msg is very short or
330  * has an unknown duration.
331  */
332 typedef void (ast_vm_msg_play_cb)(struct ast_channel *chan, const char *playfile, int duration);
333
334 /*!
335  * \brief Set voicemail function callbacks
336  *
337  * \param copy_recording_to_vm_func, vm_index_to_foldername, vm_mailbox_snapshot_create
338  * \param vm_mailbox_snapshot_destroy, vm_msg_move, vm_msg_remove, vm_msg_forward, vm_msg_play
339  * \param[in] has_voicemail_func set function pointer
340  * \param[in] inboxcount_func set function pointer
341  * \param[in] inboxcount2_func set function pointer
342  * \param[in] messagecount_func set function pointer
343  * \param[in] sayname_func set function pointer
344  * \version 1.6.1 Added inboxcount2_func, sayname_func
345  */
346 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
347                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
348                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
349                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
350                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context),
351                               int (*copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data),
352                               const char *vm_index_to_foldername(int id),
353                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_create)(const char *mailbox,
354                                 const char *context,
355                                 const char *folder,
356                                 int descending,
357                                 enum ast_vm_snapshot_sort_val sort_val,
358                                 int combine_INBOX_and_OLD),
359                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_destroy)(struct ast_vm_mailbox_snapshot *mailbox_snapshot),
360                               int (*vm_msg_move)(const char *mailbox,
361                                 const char *context,
362                                 size_t num_msgs,
363                                 const char *oldfolder,
364                                 const char *old_msg_ids[],
365                                 const char *newfolder),
366                               int (*vm_msg_remove)(const char *mailbox,
367                                 const char *context,
368                                 size_t num_msgs,
369                                 const char *folder,
370                                 const char *msgs[]),
371                               int (*vm_msg_forward)(const char *from_mailbox,
372                                 const char *from_context,
373                                 const char *from_folder,
374                                 const char *to_mailbox,
375                                 const char *to_context,
376                                 const char *to_folder,
377                                 size_t num_msgs,
378                                 const char *msg_ids[],
379                                 int delete_old),
380                               int (*vm_msg_play)(struct ast_channel *chan,
381                                 const char *mailbox,
382                                 const char *context,
383                                 const char *folder,
384                                 const char *msg_num,
385                                 ast_vm_msg_play_cb cb));
386
387
388 void ast_uninstall_vm_functions(void);
389
390 #ifdef TEST_FRAMEWORK
391 void ast_install_vm_test_functions(int (*vm_test_destroy_user)(const char *context, const char *mailbox),
392                                    int (*vm_test_create_user)(const char *context, const char *mailbox));
393
394 void ast_uninstall_vm_test_functions(void);
395 #endif
396
397 /*!
398  * \brief
399  * param[in] vm_rec_data Contains data needed to make the recording.
400  * retval 0 voicemail successfully created from recording.
401  * retval -1 Failure
402  */
403 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data);
404
405 /*!
406  * \brief Determine if a given mailbox has any voicemail
407  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
408  * number of messages in the "Urgent" folder.
409  * \retval 1 Mailbox has voicemail
410  * \retval 0 No new voicemail in specified mailbox
411  * \retval -1 Failure
412  * \since 1.0
413  */
414 int ast_app_has_voicemail(const char *mailbox, const char *folder);
415
416 /*!
417  * \brief Determine number of new/old messages in a mailbox
418  * \since 1.0
419  * \param[in] mailbox Mailbox specification in the format
420  *      /code
421  *       mbox[\@context][&mbox2[\@context2]][...]
422  *      /code
423  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
424  * \param[out] oldmsgs Number of messages in the "Old" folder.
425  * \retval 0 Success
426  * \retval -1 Failure
427  */
428 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
429
430 /*!
431  * \brief Determine number of urgent/new/old messages in a mailbox
432  * \param[in] mailbox the mailbox context to use
433  * \param[out] urgentmsgs the urgent message count
434  * \param[out] newmsgs the new message count
435  * \param[out] oldmsgs the old message count
436  * \return Returns 0 for success, negative upon error
437  * \since 1.6.1
438  */
439 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
440
441 /*!
442  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
443  * \param[in] chan Channel on which to play the name
444  * \param[in] mailbox Mailbox number from which to retrieve the recording
445  * \param[in] context Mailbox context from which to locate the mailbox number
446  * \retval 0 Name played without interruption
447  * \retval dtmf ASCII value of the DTMF which interrupted playback.
448  * \retval -1 Unable to locate mailbox or hangup occurred.
449  * \since 1.6.1
450  */
451 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
452
453 /*!
454  * \brief Check number of messages in a given context, mailbox, and folder
455  * \since 1.4
456  * \param[in] context Mailbox context
457  * \param[in] mailbox Mailbox number
458  * \param[in] folder Mailbox folder
459  * \return Number of messages in the given context, mailbox, and folder.  If folder is NULL, folder "INBOX" is assumed.  If folder is "INBOX", includes number of messages in the "Urgent" folder.
460  */
461 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
462
463 /*!
464  * \brief Return name of folder, given an id
465  * \param[in] id Folder id
466  * \return Name of folder
467  */
468 const char *ast_vm_index_to_foldername(int id);
469
470 /*
471  * \brief Create a snapshot of a mailbox which contains information about every msg.
472  *
473  * \param mailbox, the mailbox to look for
474  * \param context, the context to look for the mailbox in
475  * \param folder, OPTIONAL.  When not NULL only msgs from the specified folder will be included.
476  * \param desending, list the msgs in descending order rather than ascending order.
477  * \param combine_INBOX_and_OLD, When this argument is set, The OLD folder will be represented
478  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
479  *        OLD and INBOX messages in sorted order merged together.
480  *
481  * \retval snapshot on success
482  * \retval NULL on failure
483  */
484 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
485         const char *context,
486         const char *folder,
487         int descending,
488         enum ast_vm_snapshot_sort_val sort_val,
489         int combine_INBOX_and_OLD);
490
491 /*
492  * \brief destroy a snapshot
493  *
494  * \param mailbox_snapshot The snapshot to destroy.
495  * \retval NULL
496  */
497 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
498
499 /*!
500  * \brief Move messages from one folder to another
501  *
502  * \param mailbox The mailbox to which the folders belong
503  * \param context The voicemail context for the mailbox
504  * \param num_msgs The number of messages to move
505  * \param oldfolder The folder from where messages should be moved
506  * \param old_msg_ids The message IDs of the messages to move
507  * \param newfolder The folder to which messages should be moved
508  * new folder. This array must be num_msgs sized.
509  *
510  * \retval -1 Failure
511  * \retval 0 Success
512  */
513 int ast_vm_msg_move(const char *mailbox,
514         const char *context,
515         size_t num_msgs,
516         const char *oldfolder,
517         const char *old_msg_ids[],
518         const char *newfolder);
519
520 /*!
521  * \brief Remove/delete messages from a mailbox folder.
522  *
523  * \param mailbox The mailbox from which to delete messages
524  * \param context The voicemail context for the mailbox
525  * \param num_msgs The number of messages to delete
526  * \param folder The folder from which to remove messages
527  * \param msgs The message IDs of the messages to delete
528  *
529  * \retval -1 Failure
530  * \retval 0 Success
531  */
532 int ast_vm_msg_remove(const char *mailbox,
533         const char *context,
534         size_t num_msgs,
535         const char *folder,
536         const char *msgs[]);
537
538 /*!
539  * \brief forward a message from one mailbox to another.
540  *
541  * \brief from_mailbox The original mailbox the message is being forwarded from
542  * \brief from_context The voicemail context of the from_mailbox
543  * \brief from_folder The folder from which the message is being forwarded
544  * \brief to_mailbox The mailbox to forward the message to
545  * \brief to_context The voicemail context of the to_mailbox
546  * \brief to_folder The folder to which the message is being forwarded
547  * \brief num_msgs The number of messages being forwarded
548  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
549  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
550  * Otherwise, the messages will remain in the from_mailbox.
551  *
552  * \retval -1 Failure
553  * \retval 0 Success
554  */
555 int ast_vm_msg_forward(const char *from_mailbox,
556         const char *from_context,
557         const char *from_folder,
558         const char *to_mailbox,
559         const char *to_context,
560         const char *to_folder,
561         size_t num_msgs,
562         const char *msg_ids[],
563         int delete_old);
564
565 /*!
566  * \brief Play a voicemail msg back on a channel.
567  *
568  * \param chan
569  * \param mailbox msg is in.
570  * \param context of mailbox.
571  * \param folder voicemail folder to look in.
572  * \param msg_num message number in the voicemailbox to playback to the channel.
573  * \param cb
574  *
575  * \retval 0 success
576  * \retval -1 failure
577  */
578 int ast_vm_msg_play(struct ast_channel *chan,
579         const char *mailbox,
580         const char *context,
581         const char *folder,
582         const char *msg_num,
583         ast_vm_msg_play_cb cb);
584
585 #ifdef TEST_FRAMEWORK
586 int ast_vm_test_destroy_user(const char *context, const char *mailbox);
587 int ast_vm_test_create_user(const char *context, const char *mailbox);
588 #endif
589
590 /*! \brief Safely spawn an external program while closing file descriptors
591         \note This replaces the \b system call in all Asterisk modules
592 */
593 int ast_safe_system(const char *s);
594
595 /*!
596  * \brief Replace the SIGCHLD handler
597  *
598  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
599  * processes from forking elsewhere in Asterisk.  However, if you want to
600  * wait*() on the process to retrieve information about it's exit status,
601  * then this signal handler needs to be temporarily replaced.
602  *
603  * Code that executes this function *must* call ast_unreplace_sigchld()
604  * after it is finished doing the wait*().
605  */
606 void ast_replace_sigchld(void);
607
608 /*!
609  * \brief Restore the SIGCHLD handler
610  *
611  * This function is called after a call to ast_replace_sigchld.  It restores
612  * the SIGCHLD handler that cleans up any zombie processes.
613  */
614 void ast_unreplace_sigchld(void);
615
616 /*!
617   \brief Send DTMF to a channel
618
619   \param chan    The channel that will receive the DTMF frames
620   \param peer    (optional) Peer channel that will be autoserviced while the
621                  primary channel is receiving DTMF
622   \param digits  This is a string of characters representing the DTMF digits
623                  to be sent to the channel.  Valid characters are
624                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
625                  'F', if you want to Flash the channel (if supported by the
626                  channel), or 'w' to add a 500 millisecond pause to the DTMF
627                  sequence.
628   \param between This is the number of milliseconds to wait in between each
629                  DTMF digit.  If zero milliseconds is specified, then the
630                  default value of 100 will be used.
631   \param duration This is the duration that each DTMF digit should have.
632 */
633 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
634
635 /*! \brief Stream a filename (or file descriptor) as a generator. */
636 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
637
638 /*!
639  * \brief Stream a file with fast forward, pause, reverse, restart.
640  * \param chan Channel
641  * \param file File to play.
642  * \param fwd, rev, stop, pause, restart DTMF keys for media control
643  * \param skipms Number of milliseconds to skip for fwd/rev.
644  * \param offsetms Number of milliseconds to skip when starting the media.
645  *
646  * Before calling this function, set this to be the number
647  * of ms to start from the beginning of the file.  When the function
648  * returns, it will be the number of ms from the beginning where the
649  * playback stopped.  Pass NULL if you don't care.
650  *
651  * \retval 0 on success
652  * \retval Non-zero on failure
653  */
654 int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms);
655
656 /*!
657  * \brief Version of ast_control_streamfile() which allows the language of the
658  * media file to be specified.
659  *
660  * \retval 0 on success
661  * \retval Non-zero on failure
662  */
663 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
664         const char *fwd, const char *rev, const char *stop, const char *suspend,
665         const char *restart, int skipms, const char *lang, long *offsetms);
666
667 /*!
668  * \brief Stream a file with fast forward, pause, reverse, restart.
669  * \param chan
670  * \param file filename
671  * \param fwd, rev, stop, pause, restart, skipms, offsetms
672  * \param cb waitstream callback to invoke when fastforward or rewind occurrs.
673  *
674  * Before calling this function, set this to be the number
675  * of ms to start from the beginning of the file.  When the function
676  * returns, it will be the number of ms from the beginning where the
677  * playback stopped.  Pass NULL if you don't care.
678  */
679 int ast_control_streamfile_w_cb(struct ast_channel *chan,
680         const char *file,
681         const char *fwd,
682         const char *rev,
683         const char *stop,
684         const char *pause,
685         const char *restart,
686         int skipms,
687         long *offsetms,
688         ast_waitstream_fr_cb cb);
689
690 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
691 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
692
693 /*!
694  * \brief Record a file based on input from a channel
695  *        This function will play "auth-thankyou" upon successful recording.
696  *
697  * \param chan the channel being recorded
698  * \param playfile Filename of sound to play before recording begins
699  * \param recordfile Filename to save the recording
700  * \param maxtime_sec Longest possible message length in seconds
701  * \param fmt string containing all formats to be recorded delimited by '|'
702  * \param duration pointer to integer for storing length of the recording
703  * \param sound_duration pointer to integer for storing length of the recording minus all silence
704  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
705  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
706  * \param path Optional filesystem path to unlock
707  * \param acceptdtmf Character of DTMF to end and accept the recording
708  * \param canceldtmf Character of DTMF to end and cancel the recording
709  *
710  * \retval -1 failure or hangup
711  * \retval 'S' Recording ended from silence timeout
712  * \retval 't' Recording ended from the message exceeding the maximum duration
713  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
714  */
715 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
716
717 /*!
718  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
719  *        This function will play "auth-thankyou" upon successful recording.
720  *
721  * \param chan the channel being recorded
722  * \param playfile Filename of sound to play before recording begins
723  * \param recordfile Filename to save the recording
724  * \param maxtime_sec Longest possible message length in seconds
725  * \param fmt string containing all formats to be recorded delimited by '|'
726  * \param duration pointer to integer for storing length of the recording
727  * \param sound_duration pointer to integer for storing length of the recording minus all silence
728  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
729  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
730  * \param path Optional filesystem path to unlock
731  *
732  * \retval -1 failure or hangup
733  * \retval 'S' Recording ended from silence timeout
734  * \retval 't' Recording ended from the message exceeding the maximum duration
735  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
736  */
737 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path);
738
739 /*!
740  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
741  *        This function will not play a success message due to post-recording control in the application this was added for.
742  *
743  * \param chan the channel being recorded
744  * \param playfile Filename of sound to play before recording begins
745  * \param recordfile Filename to save the recording
746  * \param maxtime_sec Longest possible message length in seconds
747  * \param fmt string containing all formats to be recorded delimited by '|'
748  * \param duration pointer to integer for storing length of the recording
749  * \param sound_duration pointer to integer for storing length of the recording minus all silence
750  * \param beep whether to play a beep to prompt the recording
751  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
752  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
753  *
754  * \retval -1 failure or hangup
755  * \retval 'S' Recording ended from silence timeout
756  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
757  */
758 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms);
759
760 enum ast_getdata_result {
761         AST_GETDATA_FAILED = -1,
762         AST_GETDATA_COMPLETE = 0,
763         AST_GETDATA_TIMEOUT = 1,
764         AST_GETDATA_INTERRUPTED = 2,
765         /*! indicates a user terminated empty string rather than an empty string resulting 
766          * from a timeout or other factors */
767         AST_GETDATA_EMPTY_END_TERMINATED = 3,
768 };
769
770 enum AST_LOCK_RESULT {
771         AST_LOCK_SUCCESS = 0,
772         AST_LOCK_TIMEOUT = -1,
773         AST_LOCK_PATH_NOT_FOUND = -2,
774         AST_LOCK_FAILURE = -3,
775 };
776
777 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
778 enum AST_LOCK_TYPE {
779         AST_LOCK_TYPE_LOCKFILE = 0,
780         AST_LOCK_TYPE_FLOCK = 1,
781 };
782
783 /*!
784  * \brief Set the type of locks used by ast_lock_path()
785  * \param type the locking type to use
786  */
787 void ast_set_lock_type(enum AST_LOCK_TYPE type);
788
789 /*!
790  * \brief Lock a filesystem path.
791  * \param path the path to be locked
792  * \return one of \ref AST_LOCK_RESULT values
793  */
794 enum AST_LOCK_RESULT ast_lock_path(const char *path);
795
796 /*! \brief Unlock a path */
797 int ast_unlock_path(const char *path);
798
799 /*! \brief Read a file into asterisk*/
800 char *ast_read_textfile(const char *file);
801
802 struct ast_group_info;
803
804 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
805 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
806
807 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
808 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
809
810 /*! \brief Get the current channel count of the specified group and category. */
811 int ast_app_group_get_count(const char *group, const char *category);
812
813 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
814 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
815
816 /*! \brief Discard all group counting for a channel */
817 int ast_app_group_discard(struct ast_channel *chan);
818
819 /*! \brief Update all group counting for a channel to a new one */
820 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
821
822 /*! \brief Write Lock the group count list */
823 int ast_app_group_list_wrlock(void);
824
825 /*! \brief Read Lock the group count list */
826 int ast_app_group_list_rdlock(void);
827
828 /*! \brief Get the head of the group count list */
829 struct ast_group_info *ast_app_group_list_head(void);
830
831 /*! \brief Unlock the group count list */
832 int ast_app_group_list_unlock(void);
833
834 /*!
835   \brief Define an application argument
836   \param name The name of the argument
837 */
838 #define AST_APP_ARG(name) char *name
839
840 /*!
841   \brief Declare a structure to hold an application's arguments.
842   \param name The name of the structure
843   \param arglist The list of arguments, defined using AST_APP_ARG
844
845   This macro declares a structure intended to be used in a call
846   to ast_app_separate_args(). The structure includes all the
847   arguments specified, plus an argv array that overlays them and an
848   argc argument counter. The arguments must be declared using AST_APP_ARG,
849   and they will all be character pointers (strings).
850
851   \note The structure is <b>not</b> initialized, as the call to
852   ast_app_separate_args() will perform that function before parsing
853   the arguments.
854  */
855 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
856
857 /*!
858   \brief Define a structure type to hold an application's arguments.
859   \param type The name of the structure type
860   \param arglist The list of arguments, defined using AST_APP_ARG
861
862   This macro defines a structure type intended to be used in a call
863   to ast_app_separate_args(). The structure includes all the
864   arguments specified, plus an argv array that overlays them and an
865   argc argument counter. The arguments must be declared using AST_APP_ARG,
866   and they will all be character pointers (strings).
867
868   \note This defines a structure type, but does not declare an instance
869   of the structure. That must be done separately.
870  */
871 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
872         struct type { \
873                 unsigned int argc; \
874                 char *argv[0]; \
875                 arglist \
876         }
877
878 /*!
879   \brief Performs the 'standard' argument separation process for an application.
880   \param args An argument structure defined using AST_DECLARE_APP_ARGS
881   \param parse A modifiable buffer containing the input to be parsed
882
883   This function will separate the input string using the standard argument
884   separator character ',' and fill in the provided structure, including
885   the argc argument counter field.
886  */
887 #define AST_STANDARD_APP_ARGS(args, parse) \
888         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
889 #define AST_STANDARD_RAW_ARGS(args, parse) \
890         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
891
892 /*!
893   \brief Performs the 'nonstandard' argument separation process for an application.
894   \param args An argument structure defined using AST_DECLARE_APP_ARGS
895   \param parse A modifiable buffer containing the input to be parsed
896   \param sep A nonstandard separator character
897
898   This function will separate the input string using the nonstandard argument
899   separator character and fill in the provided structure, including
900   the argc argument counter field.
901  */
902 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
903         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
904 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
905         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
906
907 /*!
908   \brief Separate a string into arguments in an array
909   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
910   \param delim The character to be used to delimit arguments
911   \param remove_chars Remove backslashes and quote characters, while parsing
912   \param array An array of 'char *' to be filled in with pointers to the found arguments
913   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
914
915   Note: if there are more arguments in the string than the array will hold, the last element of
916   the array will contain the remaining arguments, not separated.
917
918   The array will be completely zeroed by this function before it populates any entries.
919
920   \return The number of arguments found, or zero if the function arguments are not valid.
921 */
922 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
923 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
924
925 /*!
926   \brief A structure to hold the description of an application 'option'.
927
928   Application 'options' are single-character flags that can be supplied
929   to the application to affect its behavior; they can also optionally
930   accept arguments enclosed in parenthesis.
931
932   These structures are used by the ast_app_parse_options function, uses
933   this data to fill in a flags structure (to indicate which options were
934   supplied) and array of argument pointers (for those options that had
935   arguments supplied).
936  */
937 struct ast_app_option {
938         /*! \brief The flag bit that represents this option. */
939         uint64_t flag;
940         /*! \brief The index of the entry in the arguments array
941           that should be used for this option's argument. */
942         unsigned int arg_index;
943 };
944
945 #define BEGIN_OPTIONS {
946 #define END_OPTIONS }
947
948 /*!
949   \brief Declares an array of options for an application.
950   \param holder The name of the array to be created
951   \param options The actual options to be placed into the array
952   \sa ast_app_parse_options
953
954   This macro declares a 'static const' array of \c struct \c ast_option
955   elements to hold the list of available options for an application.
956   Each option must be declared using either the AST_APP_OPTION()
957   or AST_APP_OPTION_ARG() macros.
958
959   Example usage:
960   \code
961   enum my_app_option_flags {
962         OPT_JUMP = (1 << 0),
963         OPT_BLAH = (1 << 1),
964         OPT_BLORT = (1 << 2),
965   };
966
967   enum my_app_option_args {
968         OPT_ARG_BLAH = 0,
969         OPT_ARG_BLORT,
970         !! this entry tells how many possible arguments there are,
971            and must be the last entry in the list
972         OPT_ARG_ARRAY_SIZE,
973   };
974
975   AST_APP_OPTIONS(my_app_options, {
976         AST_APP_OPTION('j', OPT_JUMP),
977         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
978         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
979   });
980
981   static int my_app_exec(struct ast_channel *chan, void *data)
982   {
983         char *options;
984         struct ast_flags opts = { 0, };
985         char *opt_args[OPT_ARG_ARRAY_SIZE];
986
987         ... do any argument parsing here ...
988
989         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
990                 return -1;
991         }
992   }
993   \endcode
994  */
995 #define AST_APP_OPTIONS(holder, options...) \
996         static const struct ast_app_option holder[128] = options
997
998 /*!
999   \brief Declares an application option that does not accept an argument.
1000   \param option The single character representing the option
1001   \param flagno The flag index to be set if this option is present
1002   \sa AST_APP_OPTIONS, ast_app_parse_options
1003  */
1004 #define AST_APP_OPTION(option, flagno) \
1005         [option] = { .flag = flagno }
1006
1007 /*!
1008   \brief Declares an application option that accepts an argument.
1009   \param option The single character representing the option
1010   \param flagno The flag index to be set if this option is present
1011   \param argno The index into the argument array where the argument should
1012   be placed
1013   \sa AST_APP_OPTIONS, ast_app_parse_options
1014  */
1015 #define AST_APP_OPTION_ARG(option, flagno, argno) \
1016         [option] = { .flag = flagno, .arg_index = argno + 1 }
1017
1018 /*!
1019   \brief Parses a string containing application options and sets flags/arguments.
1020   \param options The array of possible options declared with AST_APP_OPTIONS
1021   \param flags The flag structure to have option flags set
1022   \param args The array of argument pointers to hold arguments found
1023   \param optstr The string containing the options to be parsed
1024   \return zero for success, non-zero if an error occurs
1025   \sa AST_APP_OPTIONS
1026  */
1027 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
1028
1029         /*!
1030   \brief Parses a string containing application options and sets flags/arguments.
1031   \param options The array of possible options declared with AST_APP_OPTIONS
1032   \param flags The 64-bit flag structure to have option flags set
1033   \param args The array of argument pointers to hold arguments found
1034   \param optstr The string containing the options to be parsed
1035   \return zero for success, non-zero if an error occurs
1036   \sa AST_APP_OPTIONS
1037  */
1038 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
1039
1040 /*! \brief Given a list of options array, return an option string based on passed flags
1041         \param options The array of possible options declared with AST_APP_OPTIONS
1042         \param flags The flags of the options that you wish to populate the buffer with
1043         \param buf The buffer to fill with the string of options
1044         \param len The maximum length of buf
1045 */
1046 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
1047
1048 /*! \brief Present a dialtone and collect a certain length extension.
1049     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
1050 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
1051 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
1052
1053 /*! \brief Allow to record message and have a review option */
1054 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
1055
1056 /*!\brief Decode an encoded control or extended ASCII character 
1057  * \param[in] stream String to decode
1058  * \param[out] result Decoded character
1059  * \param[out] consumed Number of characters used in stream to encode the character
1060  * \retval -1 Stream is of zero length
1061  * \retval 0 Success
1062  */
1063 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
1064
1065 /*!\brief Decode a stream of encoded control or extended ASCII characters
1066  * \param[in] stream Encoded string
1067  * \param[out] result Decoded string
1068  * \param[in] result_len Maximum size of the result buffer
1069  * \return A pointer to the result string
1070  */
1071 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
1072
1073 /*! \brief Decode a stream of encoded control or extended ASCII characters */
1074 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
1075
1076 /*!
1077  * \brief Common routine for child processes, to close all fds prior to exec(2)
1078  * \param[in] n starting file descriptor number for closing all higher file descriptors
1079  * \since 1.6.1
1080  */
1081 void ast_close_fds_above_n(int n);
1082
1083 /*!
1084  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
1085  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
1086  * \since 1.6.1
1087  */
1088 int ast_safe_fork(int stop_reaper);
1089
1090 /*!
1091  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
1092  * \since 1.6.1
1093  */
1094 void ast_safe_fork_cleanup(void);
1095
1096 /*!
1097  * \brief Common routine to parse time lengths, with optional time unit specifier
1098  * \param[in] timestr String to parse
1099  * \param[in] defunit Default unit type
1100  * \param[out] result Resulting value, specified in milliseconds
1101  * \retval 0 Success
1102  * \retval -1 Failure
1103  * \since 1.8
1104  */
1105 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
1106
1107 /*!
1108  * \since 12
1109  * \brief Publish a MWI state update via stasis
1110  * \param[in] mailbox The number identifying this mailbox
1111  * \param[in] context The context this mailbox resides in
1112  * \param[in] new_msgs The number of new messages in this mailbox
1113  * \param[in] old_msgs The number of old messages in this mailbox
1114  * \retval 0 Success
1115  * \retval -1 Failure
1116  * \since 12
1117  */
1118 #define ast_publish_mwi_state(mailbox, context, new_msgs, old_msgs) \
1119         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, NULL, NULL)
1120
1121 /*!
1122  * \since 12
1123  * \brief Publish a MWI state update associated with some channel
1124  * \param[in] mailbox The number identifying this mailbox
1125  * \param[in] context The context this mailbox resides in
1126  * \param[in] new_msgs The number of new messages in this mailbox
1127  * \param[in] old_msgs The number of old messages in this mailbox
1128  * \param[in] channel_id A unique identifier for a channel associated with this
1129  * change in mailbox state
1130  * \retval 0 Success
1131  * \retval -1 Failure
1132  * \since 12
1133  */
1134 #define ast_publish_mwi_state_channel(mailbox, context, new_msgs, old_msgs, channel_id) \
1135         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, channel_id, NULL)
1136
1137 /*!
1138  * \since 12
1139  * \brief Publish a MWI state update via stasis with all parameters
1140  * \param[in] mailbox The number identifying this mailbox
1141  * \param[in] context The context this mailbox resides in
1142  * \param[in] new_msgs The number of new messages in this mailbox
1143  * \param[in] old_msgs The number of old messages in this mailbox
1144  * \param[in] channel_id A unique identifier for a channel associated with this
1145  * \param[in] eid The EID of the server that originally published the message
1146  * \retval 0 Success
1147  * \retval -1 Failure
1148  * \since 12
1149  */
1150 int ast_publish_mwi_state_full(
1151                         const char *mailbox,
1152                         const char *context,
1153                         int new_msgs,
1154                         int old_msgs,
1155                         const char *channel_id,
1156                         struct ast_eid *eid);
1157
1158 /*! \addtogroup StasisTopicsAndMessages
1159  * @{
1160  */
1161
1162 /*!
1163  * \brief The structure that contains MWI state
1164  * \since 12
1165  */
1166 struct ast_mwi_state {
1167         AST_DECLARE_STRING_FIELDS(
1168                 AST_STRING_FIELD(uniqueid);  /*!< Unique identifier for this mailbox/context */
1169                 AST_STRING_FIELD(mailbox);   /*!< Mailbox for this event */
1170                 AST_STRING_FIELD(context);   /*!< Context that this mailbox belongs to */
1171         );
1172         int new_msgs;                    /*!< The current number of new messages for this mailbox */
1173         int old_msgs;                    /*!< The current number of old messages for this mailbox */
1174         /*! If applicable, a snapshot of the channel that caused this MWI change */
1175         struct ast_channel_snapshot *snapshot;
1176         struct ast_eid eid;              /*!< The EID of the server where this message originated */
1177 };
1178
1179 /*!
1180  * \brief Object that represents an MWI update with some additional application
1181  * defined data
1182  */
1183 struct ast_mwi_blob {
1184         struct ast_mwi_state *mwi_state;    /*!< MWI state */
1185         struct ast_json *blob;              /*!< JSON blob of data */
1186 };
1187
1188 /*!
1189  * \since 12
1190  * \brief Create a \ref ast_mwi_state object
1191  *
1192  * \retval \ref ast_mwi_state object on success
1193  * \retval NULL on error
1194  */
1195 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context);
1196
1197 /*!
1198  * \since 12
1199  * \brief Creates a \ref ast_mwi_blob message.
1200  *
1201  * The \a blob JSON object requires a \c "type" field describing the blob. It
1202  * should also be treated as immutable and not modified after it is put into the
1203  * message.
1204  *
1205  * \param mwi_state MWI state associated with the update
1206  * \param message_type The type of message to create
1207  * \param blob JSON object representing the data.
1208  * \return \ref ast_mwi_blob message.
1209  * \return \c NULL on error
1210  */
1211 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
1212                                            struct stasis_message_type *message_type,
1213                                            struct ast_json *blob);
1214
1215 /*!
1216  * \brief Get the \ref stasis topic for MWI messages
1217  * \retval The topic structure for MWI messages
1218  * \retval NULL if it has not been allocated
1219  * \since 12
1220  */
1221 struct stasis_topic *ast_mwi_topic_all(void);
1222
1223 /*!
1224  * \brief Get the \ref stasis topic for MWI messages on a unique ID
1225  * \param uniqueid The unique id for which to get the topic
1226  * \retval The topic structure for MWI messages for a given uniqueid
1227  * \retval NULL if it failed to be found or allocated
1228  * \since 12
1229  */
1230 struct stasis_topic *ast_mwi_topic(const char *uniqueid);
1231
1232 /*!
1233  * \brief Get the \ref stasis caching topic for MWI messages
1234  * \retval The caching topic structure for MWI messages
1235  * \retval NULL if it has not been allocated
1236  * \since 12
1237  */
1238 struct stasis_caching_topic *ast_mwi_topic_cached(void);
1239
1240 /*!
1241  * \brief Get the \ref stasis message type for MWI messages
1242  * \retval The message type structure for MWI messages
1243  * \retval NULL on error
1244  * \since 12
1245  */
1246 struct stasis_message_type *ast_mwi_state_type(void);
1247
1248 /*!
1249  * \brief Get the \ref stasis message type for voicemail application specific messages
1250  *
1251  * This message type exists for those messages a voicemail application may wish to send
1252  * that have no logical relationship with other voicemail applications. Voicemail apps
1253  * that use this message type must pass a \ref ast_mwi_blob. Any extraneous information
1254  * in the JSON blob must be packed as key/value pair tuples of strings.
1255  *
1256  * At least one key/value tuple must have a key value of "Event".
1257  *
1258  * \retval The \ref stasis_message_type for voicemail application specific messages
1259  * \retval NULL on error
1260  * \since 12
1261  */
1262 struct stasis_message_type *ast_mwi_vm_app_type(void);
1263
1264 /*! @} */
1265
1266 /*!
1267  * \brief Initialize the application core
1268  * \retval 0 Success
1269  * \retval -1 Failure
1270  * \since 12
1271  */
1272 int app_init(void);
1273
1274 #define AST_MAX_MAILBOX_UNIQUEID (AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2)
1275 #if defined(__cplusplus) || defined(c_plusplus)
1276 }
1277 #endif
1278
1279 #endif /* _ASTERISK_APP_H */