voicemail: Simplify callback pointer declarations and add doxygen.
[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 chan Channel to play the file back on.
328  * \param playfile 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 Determines if the given folder has messages.
336  *
337  * \param mailbox The @ delimited string for user@context. If no context is found, uses 'default' for the context.
338  * \param folder The folder to look in.  Default is INBOX if not provided.
339  *
340  * \retval 1 if the folder has one or more messages.
341  * \retval 0 otherwise.
342  */
343 typedef int (ast_has_voicemail_fn)(const char *mailbox, const char *folder);
344
345 /*!
346  * \brief Gets the number of messages that exist for the mailbox list.
347  *
348  * \param mailbox Comma or space deliminated list of mailboxes (user@context).
349  * \param newmsgs Where to put the count of new messages. (Can be NULL)
350  * \param oldmsgs Where to put the count of old messages. (Can be NULL)
351  *
352  * \details
353  * Simultaneously determines the count of new + urgent and old
354  * messages.  The total messages would then be the sum of these.
355  *
356  * \retval 0 on success
357  * \retval -1 on failure
358  */
359 typedef int (ast_inboxcount_fn)(const char *mailbox, int *newmsgs, int *oldmsgs);
360
361 /*!
362  * \brief Gets the number of messages that exist for the mailbox list.
363  *
364  * \param mailbox Comma or space deliminated list of mailboxes (user@context).
365  * \param urgentmsgs Where to put the count of urgent messages. (Can be NULL)
366  * \param newmsgs Where to put the count of new messages. (Can be NULL)
367  * \param oldmsgs Where to put the count of old messages. (Can be NULL)
368  *
369  * \details
370  * Simultaneously determines the count of new, old, and urgent
371  * messages.  The total messages would then be the sum of these
372  * three.
373  *
374  * \retval 0 on success
375  * \retval -1 on failure
376  */
377 typedef int (ast_inboxcount2_fn)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
378
379 /*!
380  * \brief Gets the number of messages that exist in a mailbox folder.
381  *
382  * \param context The context part of user@context.  Uses 'default' if not provided.
383  * \param mailbox The user part of user@context.
384  * \param folder The folder to look in.  Default is INBOX if not provided.
385  *
386  * \note If requesting INBOX then the returned count is INBOX +
387  * Urgent.
388  *
389  * \return The number of messages in this mailbox folder (zero or more).
390  */
391 typedef int (ast_messagecount_fn)(const char *context, const char *mailbox, const char *folder);
392
393 /*!
394  * \brief Play a recorded user name for the mailbox.
395  *
396  * \param chan Where to play the recorded name file.
397  * \param mailbox The user part of user@context.
398  * \param context The context part of user@context.  Must be explicit.
399  *
400  * \retval 0 Name played without interruption
401  * \retval dtmf ASCII value of the DTMF which interrupted playback
402  * \retval -1 on failure
403  */
404 typedef int (ast_sayname_fn)(struct ast_channel *chan, const char *mailbox, const char *context);
405
406 /*!
407  * \brief Creates a voicemail based on a specified file to a mailbox.
408  *
409  * \param vm_rec_data A record containing filename and voicemail txt info.
410  *
411  * \retval 0 on success
412  * \retval -1 on failure
413  */
414 typedef int (ast_copy_recording_to_vm_fn)(struct ast_vm_recording_data *vm_rec_data);
415
416 /*!
417  * \brief Convert the mailbox folder id to a folder name.
418  *
419  * \param id Mailbox folder id to convert.
420  *
421  * \deprecated Nothing calls it and nothing ever should.
422  *
423  * \return The folder name associated with the id.
424  */
425 typedef const char *(ast_vm_index_to_foldername_fn)(int id);
426
427 /*!
428  * \brief Create a snapshot of a mailbox which contains information about every msg.
429  *
430  * \param mailbox The user part of user@context.
431  * \param context The context part of user@context.  Must be explicit.
432  * \param folder When not NULL only msgs from the specified folder will be included.
433  * \param desending list the msgs in descending order rather than ascending order.
434  * \param sort_val What to sort in the snapshot.
435  * \param combine_INBOX_and_OLD When this argument is set, The OLD folder will be represented
436  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
437  *        OLD and INBOX messages in sorted order merged together.
438  *
439  * \note Only used by voicemail unit tests.
440  *
441  * \retval snapshot on success
442  * \retval NULL on failure
443  */
444 typedef struct ast_vm_mailbox_snapshot *(ast_vm_mailbox_snapshot_create_fn)(const char *mailbox,
445         const char *context, const char *folder, int descending,
446         enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD);
447
448 /*!
449  * \brief destroy a snapshot
450  *
451  * \param mailbox_snapshot The snapshot to destroy.
452  *
453  * \note Only used by voicemail unit tests.
454  *
455  * \retval NULL
456  */
457 typedef struct ast_vm_mailbox_snapshot *(ast_vm_mailbox_snapshot_destroy_fn)(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
458
459 /*!
460  * \brief Move messages from one folder to another
461  *
462  * \param mailbox The mailbox to which the folders belong
463  * \param context The voicemail context for the mailbox
464  * \param num_msgs The number of messages to move
465  * \param oldfolder The folder from where messages should be moved
466  * \param old_msg_ids The message IDs of the messages to move
467  * \param newfolder The folder to which messages should be moved
468  *    new folder. This array must be num_msgs sized.
469  *
470  * \note Only used by voicemail unit tests.
471  *
472  * \retval -1 Failure
473  * \retval 0 Success
474  */
475 typedef int (ast_vm_msg_move_fn)(const char *mailbox, const char *context, size_t num_msgs,
476         const char *oldfolder, const char *old_msg_ids[], const char *newfolder);
477
478 /*!
479  * \brief Remove/delete messages from a mailbox folder.
480  *
481  * \param mailbox The mailbox from which to delete messages
482  * \param context The voicemail context for the mailbox
483  * \param num_msgs The number of messages to delete
484  * \param folder The folder from which to remove messages
485  * \param msgs The message IDs of the messages to delete
486  *
487  * \note Only used by voicemail unit tests.
488  *
489  * \retval -1 Failure
490  * \retval 0 Success
491  */
492 typedef int (ast_vm_msg_remove_fn)(const char *mailbox, const char *context, size_t num_msgs,
493         const char *folder, const char *msgs[]);
494
495 /*!
496  * \brief forward a message from one mailbox to another.
497  *
498  * \brief from_mailbox The original mailbox the message is being forwarded from
499  * \brief from_context The voicemail context of the from_mailbox
500  * \brief from_folder The folder from which the message is being forwarded
501  * \brief to_mailbox The mailbox to forward the message to
502  * \brief to_context The voicemail context of the to_mailbox
503  * \brief to_folder The folder to which the message is being forwarded
504  * \brief num_msgs The number of messages being forwarded
505  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
506  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
507  * Otherwise, the messages will remain in the from_mailbox.
508  *
509  * \note Only used by voicemail unit tests.
510  *
511  * \retval -1 Failure
512  * \retval 0 Success
513  */
514 typedef int (ast_vm_msg_forward_fn)(const char *from_mailbox, const char *from_context,
515         const char *from_folder, const char *to_mailbox, const char *to_context,
516         const char *to_folder, size_t num_msgs, const char *msg_ids[], int delete_old);
517
518 /*!
519  * \brief Play a voicemail msg back on a channel.
520  *
521  * \param chan
522  * \param mailbox msg is in.
523  * \param context of mailbox.
524  * \param folder voicemail folder to look in.
525  * \param msg_num message number in the voicemailbox to playback to the channel.
526  * \param cb
527  *
528  * \note Only used by voicemail unit tests.
529  *
530  * \retval 0 success
531  * \retval -1 failure
532  */
533 typedef int (ast_vm_msg_play_fn)(struct ast_channel *chan, const char *mailbox,
534         const char *context, const char *folder, const char *msg_num, ast_vm_msg_play_cb *cb);
535
536 /*!
537  * \brief Set voicemail function callbacks
538  *
539  * \param has_voicemail_func set function pointer
540  * \param inboxcount_func set function pointer
541  * \param inboxcount2_func set function pointer
542  * \param messagecount_func set function pointer
543  * \param sayname_func set function pointer
544  * \param copy_recording_to_vm_func set function pointer
545  * \param vm_index_to_foldername_func set function pointer
546  * \param vm_mailbox_snapshot_create_func set function pointer
547  * \param vm_mailbox_snapshot_destroy_func set function pointer
548  * \param vm_msg_move_func set function pointer
549  * \param vm_msg_remove_func set function pointer
550  * \param vm_msg_forward_func set function pointer
551  * \param vm_msg_play_func set function pointer
552  *
553  * \version 1.6.1 Added inboxcount2_func, sayname_func
554  */
555 void ast_install_vm_functions(ast_has_voicemail_fn *has_voicemail_func,
556         ast_inboxcount_fn *inboxcount_func,
557         ast_inboxcount2_fn *inboxcount2_func,
558         ast_messagecount_fn *messagecount_func,
559         ast_sayname_fn *sayname_func,
560         ast_copy_recording_to_vm_fn *copy_recording_to_vm_func,
561         ast_vm_index_to_foldername_fn *vm_index_to_foldername_func,
562         ast_vm_mailbox_snapshot_create_fn *vm_mailbox_snapshot_create_func,
563         ast_vm_mailbox_snapshot_destroy_fn *vm_mailbox_snapshot_destroy_func,
564         ast_vm_msg_move_fn *vm_msg_move_func,
565         ast_vm_msg_remove_fn *vm_msg_remove_func,
566         ast_vm_msg_forward_fn *vm_msg_forward_func,
567         ast_vm_msg_play_fn *vm_msg_play_func);
568
569
570 void ast_uninstall_vm_functions(void);
571
572 #ifdef TEST_FRAMEWORK
573 typedef int (ast_vm_test_create_user_fn)(const char *context, const char *mailbox);
574 typedef int (ast_vm_test_destroy_user_fn)(const char *context, const char *mailbox);
575
576 void ast_install_vm_test_functions(ast_vm_test_create_user_fn *vm_test_create_user_func,
577         ast_vm_test_destroy_user_fn *vm_test_destroy_user_func);
578
579 void ast_uninstall_vm_test_functions(void);
580 #endif
581
582 /*!
583  * \brief
584  * param[in] vm_rec_data Contains data needed to make the recording.
585  * retval 0 voicemail successfully created from recording.
586  * retval -1 Failure
587  */
588 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data);
589
590 /*!
591  * \brief Determine if a given mailbox has any voicemail
592  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
593  * number of messages in the "Urgent" folder.
594  * \retval 1 Mailbox has voicemail
595  * \retval 0 No new voicemail in specified mailbox
596  * \retval -1 Failure
597  * \since 1.0
598  */
599 int ast_app_has_voicemail(const char *mailbox, const char *folder);
600
601 /*!
602  * \brief Determine number of new/old messages in a mailbox
603  * \since 1.0
604  * \param[in] mailbox Mailbox specification in the format
605  *      /code
606  *       mbox[\@context][&mbox2[\@context2]][...]
607  *      /code
608  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
609  * \param[out] oldmsgs Number of messages in the "Old" folder.
610  * \retval 0 Success
611  * \retval -1 Failure
612  */
613 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
614
615 /*!
616  * \brief Determine number of urgent/new/old messages in a mailbox
617  * \param[in] mailbox the mailbox context to use
618  * \param[out] urgentmsgs the urgent message count
619  * \param[out] newmsgs the new message count
620  * \param[out] oldmsgs the old message count
621  * \return Returns 0 for success, negative upon error
622  * \since 1.6.1
623  */
624 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
625
626 /*!
627  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
628  * \param[in] chan Channel on which to play the name
629  * \param[in] mailbox Mailbox number from which to retrieve the recording
630  * \param[in] context Mailbox context from which to locate the mailbox number
631  * \retval 0 Name played without interruption
632  * \retval dtmf ASCII value of the DTMF which interrupted playback.
633  * \retval -1 Unable to locate mailbox or hangup occurred.
634  * \since 1.6.1
635  */
636 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
637
638 /*!
639  * \brief Check number of messages in a given context, mailbox, and folder
640  * \since 1.4
641  * \param[in] context Mailbox context
642  * \param[in] mailbox Mailbox number
643  * \param[in] folder Mailbox folder
644  * \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.
645  */
646 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
647
648 /*!
649  * \brief Return name of folder, given an id
650  * \param[in] id Folder id
651  * \return Name of folder
652  */
653 const char *ast_vm_index_to_foldername(int id);
654
655 /*!
656  * \brief Create a snapshot of a mailbox which contains information about every msg.
657  *
658  * \param mailbox, the mailbox to look for
659  * \param context, the context to look for the mailbox in
660  * \param folder, OPTIONAL.  When not NULL only msgs from the specified folder will be included.
661  * \param desending, list the msgs in descending order rather than ascending order.
662  * \param combine_INBOX_and_OLD, When this argument is set, The OLD folder will be represented
663  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
664  *        OLD and INBOX messages in sorted order merged together.
665  *
666  * \retval snapshot on success
667  * \retval NULL on failure
668  */
669 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
670         const char *context,
671         const char *folder,
672         int descending,
673         enum ast_vm_snapshot_sort_val sort_val,
674         int combine_INBOX_and_OLD);
675
676 /*!
677  * \brief destroy a snapshot
678  *
679  * \param mailbox_snapshot The snapshot to destroy.
680  * \retval NULL
681  */
682 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
683
684 /*!
685  * \brief Move messages from one folder to another
686  *
687  * \param mailbox The mailbox to which the folders belong
688  * \param context The voicemail context for the mailbox
689  * \param num_msgs The number of messages to move
690  * \param oldfolder The folder from where messages should be moved
691  * \param old_msg_ids The message IDs of the messages to move
692  * \param newfolder The folder to which messages should be moved
693  * new folder. This array must be num_msgs sized.
694  *
695  * \retval -1 Failure
696  * \retval 0 Success
697  */
698 int ast_vm_msg_move(const char *mailbox,
699         const char *context,
700         size_t num_msgs,
701         const char *oldfolder,
702         const char *old_msg_ids[],
703         const char *newfolder);
704
705 /*!
706  * \brief Remove/delete messages from a mailbox folder.
707  *
708  * \param mailbox The mailbox from which to delete messages
709  * \param context The voicemail context for the mailbox
710  * \param num_msgs The number of messages to delete
711  * \param folder The folder from which to remove messages
712  * \param msgs The message IDs of the messages to delete
713  *
714  * \retval -1 Failure
715  * \retval 0 Success
716  */
717 int ast_vm_msg_remove(const char *mailbox,
718         const char *context,
719         size_t num_msgs,
720         const char *folder,
721         const char *msgs[]);
722
723 /*!
724  * \brief forward a message from one mailbox to another.
725  *
726  * \brief from_mailbox The original mailbox the message is being forwarded from
727  * \brief from_context The voicemail context of the from_mailbox
728  * \brief from_folder The folder from which the message is being forwarded
729  * \brief to_mailbox The mailbox to forward the message to
730  * \brief to_context The voicemail context of the to_mailbox
731  * \brief to_folder The folder to which the message is being forwarded
732  * \brief num_msgs The number of messages being forwarded
733  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
734  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
735  * Otherwise, the messages will remain in the from_mailbox.
736  *
737  * \retval -1 Failure
738  * \retval 0 Success
739  */
740 int ast_vm_msg_forward(const char *from_mailbox,
741         const char *from_context,
742         const char *from_folder,
743         const char *to_mailbox,
744         const char *to_context,
745         const char *to_folder,
746         size_t num_msgs,
747         const char *msg_ids[],
748         int delete_old);
749
750 /*!
751  * \brief Play a voicemail msg back on a channel.
752  *
753  * \param chan
754  * \param mailbox msg is in.
755  * \param context of mailbox.
756  * \param folder voicemail folder to look in.
757  * \param msg_num message number in the voicemailbox to playback to the channel.
758  * \param cb
759  *
760  * \retval 0 success
761  * \retval -1 failure
762  */
763 int ast_vm_msg_play(struct ast_channel *chan,
764         const char *mailbox,
765         const char *context,
766         const char *folder,
767         const char *msg_num,
768         ast_vm_msg_play_cb *cb);
769
770 #ifdef TEST_FRAMEWORK
771 int ast_vm_test_destroy_user(const char *context, const char *mailbox);
772 int ast_vm_test_create_user(const char *context, const char *mailbox);
773 #endif
774
775 /*! \brief Safely spawn an external program while closing file descriptors
776         \note This replaces the \b system call in all Asterisk modules
777 */
778 int ast_safe_system(const char *s);
779
780 /*!
781  * \brief Replace the SIGCHLD handler
782  *
783  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
784  * processes from forking elsewhere in Asterisk.  However, if you want to
785  * wait*() on the process to retrieve information about it's exit status,
786  * then this signal handler needs to be temporarily replaced.
787  *
788  * Code that executes this function *must* call ast_unreplace_sigchld()
789  * after it is finished doing the wait*().
790  */
791 void ast_replace_sigchld(void);
792
793 /*!
794  * \brief Restore the SIGCHLD handler
795  *
796  * This function is called after a call to ast_replace_sigchld.  It restores
797  * the SIGCHLD handler that cleans up any zombie processes.
798  */
799 void ast_unreplace_sigchld(void);
800
801 /*!
802   \brief Send DTMF to a channel
803
804   \param chan    The channel that will receive the DTMF frames
805   \param peer    (optional) Peer channel that will be autoserviced while the
806                  primary channel is receiving DTMF
807   \param digits  This is a string of characters representing the DTMF digits
808                  to be sent to the channel.  Valid characters are
809                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
810                  'F', if you want to Flash the channel (if supported by the
811                  channel), or 'w' to add a 500 millisecond pause to the DTMF
812                  sequence.
813   \param between This is the number of milliseconds to wait in between each
814                  DTMF digit.  If zero milliseconds is specified, then the
815                  default value of 100 will be used.
816   \param duration This is the duration that each DTMF digit should have.
817 */
818 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
819
820 /*! \brief Stream a filename (or file descriptor) as a generator. */
821 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
822
823 /*!
824  * \brief Stream a file with fast forward, pause, reverse, restart.
825  * \param chan Channel
826  * \param file File to play.
827  * \param fwd, rev, stop, pause, restart DTMF keys for media control
828  * \param skipms Number of milliseconds to skip for fwd/rev.
829  * \param offsetms Number of milliseconds to skip when starting the media.
830  *
831  * Before calling this function, set this to be the number
832  * of ms to start from the beginning of the file.  When the function
833  * returns, it will be the number of ms from the beginning where the
834  * playback stopped.  Pass NULL if you don't care.
835  *
836  * \retval 0 on success
837  * \retval Non-zero on failure
838  */
839 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);
840
841 /*!
842  * \brief Version of ast_control_streamfile() which allows the language of the
843  * media file to be specified.
844  *
845  * \retval 0 on success
846  * \retval Non-zero on failure
847  */
848 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
849         const char *fwd, const char *rev, const char *stop, const char *suspend,
850         const char *restart, int skipms, const char *lang, long *offsetms);
851
852 /*!
853  * \brief Stream a file with fast forward, pause, reverse, restart.
854  * \param chan
855  * \param file filename
856  * \param fwd, rev, stop, pause, restart, skipms, offsetms
857  * \param cb waitstream callback to invoke when fastforward or rewind occurrs.
858  *
859  * Before calling this function, set this to be the number
860  * of ms to start from the beginning of the file.  When the function
861  * returns, it will be the number of ms from the beginning where the
862  * playback stopped.  Pass NULL if you don't care.
863  */
864 int ast_control_streamfile_w_cb(struct ast_channel *chan,
865         const char *file,
866         const char *fwd,
867         const char *rev,
868         const char *stop,
869         const char *pause,
870         const char *restart,
871         int skipms,
872         long *offsetms,
873         ast_waitstream_fr_cb cb);
874
875 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
876 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
877
878 /*!
879  * Possible actions to take if a recording already exists
880  * \since 12
881  */
882 enum ast_record_if_exists {
883         /*! Fail the recording. */
884         AST_RECORD_IF_EXISTS_FAIL,
885         /*! Overwrite the existing recording. */
886         AST_RECORD_IF_EXISTS_OVERWRITE,
887         /*! Append to the existing recording. */
888         AST_RECORD_IF_EXISTS_APPEND,
889 };
890
891 /*!
892  * \brief Record a file based on input from a channel
893  *        This function will play "auth-thankyou" upon successful recording if
894  *        skip_confirmation_sound is false.
895  *
896  * \param chan the channel being recorded
897  * \param playfile Filename of sound to play before recording begins. A beep is also played when playfile completes, before the recording begins.
898  * \param recordfile Filename to save the recording
899  * \param maxtime_sec Longest possible message length in seconds
900  * \param fmt string containing all formats to be recorded delimited by '|'
901  * \param duration pointer to integer for storing length of the recording
902  * \param beep If true, play a beep before recording begins (and doesn't play \a playfile)
903  * \param sound_duration pointer to integer for storing length of the recording minus all silence
904  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
905  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
906  * \param path Optional filesystem path to unlock
907  * \param acceptdtmf Character of DTMF to end and accept the recording
908  * \param canceldtmf Character of DTMF to end and cancel the recording
909  * \param skip_confirmation_sound If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.
910  * \param if_exists Action to take if recording already exists.
911  *
912  * \retval -1 failure or hangup
913  * \retval 'S' Recording ended from silence timeout
914  * \retval 't' Recording ended from the message exceeding the maximum duration
915  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
916  */
917 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 beep, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf, int skip_confirmation_sound, enum ast_record_if_exists if_exists);
918
919 /*!
920  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
921  *        This function will play "auth-thankyou" upon successful recording.
922  *
923  * \param chan the channel being recorded
924  * \param playfile Filename of sound to play before recording begins
925  * \param recordfile Filename to save the recording
926  * \param maxtime_sec Longest possible message length in seconds
927  * \param fmt string containing all formats to be recorded delimited by '|'
928  * \param duration pointer to integer for storing length of the recording
929  * \param sound_duration pointer to integer for storing length of the recording minus all silence
930  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
931  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
932  * \param path Optional filesystem path to unlock
933  *
934  * \retval -1 failure or hangup
935  * \retval 'S' Recording ended from silence timeout
936  * \retval 't' Recording ended from the message exceeding the maximum duration
937  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
938  */
939 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);
940
941 /*!
942  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
943  *        This function will not play a success message due to post-recording control in the application this was added for.
944  *
945  * \param chan the channel being recorded
946  * \param playfile Filename of sound to play before recording begins
947  * \param recordfile Filename to save the recording
948  * \param maxtime_sec Longest possible message length in seconds
949  * \param fmt string containing all formats to be recorded delimited by '|'
950  * \param duration pointer to integer for storing length of the recording
951  * \param sound_duration pointer to integer for storing length of the recording minus all silence
952  * \param beep whether to play a beep to prompt the recording
953  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
954  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
955  *
956  * \retval -1 failure or hangup
957  * \retval 'S' Recording ended from silence timeout
958  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
959  */
960 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);
961
962 enum ast_getdata_result {
963         AST_GETDATA_FAILED = -1,
964         AST_GETDATA_COMPLETE = 0,
965         AST_GETDATA_TIMEOUT = 1,
966         AST_GETDATA_INTERRUPTED = 2,
967         /*! indicates a user terminated empty string rather than an empty string resulting
968          * from a timeout or other factors */
969         AST_GETDATA_EMPTY_END_TERMINATED = 3,
970 };
971
972 enum AST_LOCK_RESULT {
973         AST_LOCK_SUCCESS = 0,
974         AST_LOCK_TIMEOUT = -1,
975         AST_LOCK_PATH_NOT_FOUND = -2,
976         AST_LOCK_FAILURE = -3,
977 };
978
979 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
980 enum AST_LOCK_TYPE {
981         AST_LOCK_TYPE_LOCKFILE = 0,
982         AST_LOCK_TYPE_FLOCK = 1,
983 };
984
985 /*!
986  * \brief Set the type of locks used by ast_lock_path()
987  * \param type the locking type to use
988  */
989 void ast_set_lock_type(enum AST_LOCK_TYPE type);
990
991 /*!
992  * \brief Lock a filesystem path.
993  * \param path the path to be locked
994  * \return one of \ref AST_LOCK_RESULT values
995  */
996 enum AST_LOCK_RESULT ast_lock_path(const char *path);
997
998 /*! \brief Unlock a path */
999 int ast_unlock_path(const char *path);
1000
1001 /*! \brief Read a file into asterisk*/
1002 char *ast_read_textfile(const char *file);
1003
1004 struct ast_group_info;
1005
1006 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
1007 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
1008
1009 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
1010 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
1011
1012 /*! \brief Get the current channel count of the specified group and category. */
1013 int ast_app_group_get_count(const char *group, const char *category);
1014
1015 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
1016 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
1017
1018 /*! \brief Discard all group counting for a channel */
1019 int ast_app_group_discard(struct ast_channel *chan);
1020
1021 /*! \brief Update all group counting for a channel to a new one */
1022 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
1023
1024 /*! \brief Write Lock the group count list */
1025 int ast_app_group_list_wrlock(void);
1026
1027 /*! \brief Read Lock the group count list */
1028 int ast_app_group_list_rdlock(void);
1029
1030 /*! \brief Get the head of the group count list */
1031 struct ast_group_info *ast_app_group_list_head(void);
1032
1033 /*! \brief Unlock the group count list */
1034 int ast_app_group_list_unlock(void);
1035
1036 /*!
1037   \brief Define an application argument
1038   \param name The name of the argument
1039 */
1040 #define AST_APP_ARG(name) char *name
1041
1042 /*!
1043   \brief Declare a structure to hold an application's arguments.
1044   \param name The name of the structure
1045   \param arglist The list of arguments, defined using AST_APP_ARG
1046
1047   This macro declares a structure intended to be used in a call
1048   to ast_app_separate_args(). The structure includes all the
1049   arguments specified, plus an argv array that overlays them and an
1050   argc argument counter. The arguments must be declared using AST_APP_ARG,
1051   and they will all be character pointers (strings).
1052
1053   \note The structure is <b>not</b> initialized, as the call to
1054   ast_app_separate_args() will perform that function before parsing
1055   the arguments.
1056  */
1057 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
1058
1059 /*!
1060   \brief Define a structure type to hold an application's arguments.
1061   \param type The name of the structure type
1062   \param arglist The list of arguments, defined using AST_APP_ARG
1063
1064   This macro defines a structure type intended to be used in a call
1065   to ast_app_separate_args(). The structure includes all the
1066   arguments specified, plus an argv array that overlays them and an
1067   argc argument counter. The arguments must be declared using AST_APP_ARG,
1068   and they will all be character pointers (strings).
1069
1070   \note This defines a structure type, but does not declare an instance
1071   of the structure. That must be done separately.
1072  */
1073 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
1074         struct type { \
1075                 unsigned int argc; \
1076                 char *argv[0]; \
1077                 arglist \
1078         }
1079
1080 /*!
1081   \brief Performs the 'standard' argument separation process for an application.
1082   \param args An argument structure defined using AST_DECLARE_APP_ARGS
1083   \param parse A modifiable buffer containing the input to be parsed
1084
1085   This function will separate the input string using the standard argument
1086   separator character ',' and fill in the provided structure, including
1087   the argc argument counter field.
1088  */
1089 #define AST_STANDARD_APP_ARGS(args, parse) \
1090         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1091 #define AST_STANDARD_RAW_ARGS(args, parse) \
1092         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1093
1094 /*!
1095   \brief Performs the 'nonstandard' argument separation process for an application.
1096   \param args An argument structure defined using AST_DECLARE_APP_ARGS
1097   \param parse A modifiable buffer containing the input to be parsed
1098   \param sep A nonstandard separator character
1099
1100   This function will separate the input string using the nonstandard argument
1101   separator character and fill in the provided structure, including
1102   the argc argument counter field.
1103  */
1104 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
1105         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1106 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
1107         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1108
1109 /*!
1110   \brief Separate a string into arguments in an array
1111   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
1112   \param delim The character to be used to delimit arguments
1113   \param remove_chars Remove backslashes and quote characters, while parsing
1114   \param array An array of 'char *' to be filled in with pointers to the found arguments
1115   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
1116
1117   Note: if there are more arguments in the string than the array will hold, the last element of
1118   the array will contain the remaining arguments, not separated.
1119
1120   The array will be completely zeroed by this function before it populates any entries.
1121
1122   \return The number of arguments found, or zero if the function arguments are not valid.
1123 */
1124 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
1125 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
1126
1127 /*!
1128   \brief A structure to hold the description of an application 'option'.
1129
1130   Application 'options' are single-character flags that can be supplied
1131   to the application to affect its behavior; they can also optionally
1132   accept arguments enclosed in parenthesis.
1133
1134   These structures are used by the ast_app_parse_options function, uses
1135   this data to fill in a flags structure (to indicate which options were
1136   supplied) and array of argument pointers (for those options that had
1137   arguments supplied).
1138  */
1139 struct ast_app_option {
1140         /*! \brief The flag bit that represents this option. */
1141         uint64_t flag;
1142         /*! \brief The index of the entry in the arguments array
1143           that should be used for this option's argument. */
1144         unsigned int arg_index;
1145 };
1146
1147 #define BEGIN_OPTIONS {
1148 #define END_OPTIONS }
1149
1150 /*!
1151   \brief Declares an array of options for an application.
1152   \param holder The name of the array to be created
1153   \param options The actual options to be placed into the array
1154   \sa ast_app_parse_options
1155
1156   This macro declares a 'static const' array of \c struct \c ast_option
1157   elements to hold the list of available options for an application.
1158   Each option must be declared using either the AST_APP_OPTION()
1159   or AST_APP_OPTION_ARG() macros.
1160
1161   Example usage:
1162   \code
1163   enum my_app_option_flags {
1164         OPT_JUMP = (1 << 0),
1165         OPT_BLAH = (1 << 1),
1166         OPT_BLORT = (1 << 2),
1167   };
1168
1169   enum my_app_option_args {
1170         OPT_ARG_BLAH = 0,
1171         OPT_ARG_BLORT,
1172         !! this entry tells how many possible arguments there are,
1173            and must be the last entry in the list
1174         OPT_ARG_ARRAY_SIZE,
1175   };
1176
1177   AST_APP_OPTIONS(my_app_options, {
1178         AST_APP_OPTION('j', OPT_JUMP),
1179         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
1180         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
1181   });
1182
1183   static int my_app_exec(struct ast_channel *chan, void *data)
1184   {
1185         char *options;
1186         struct ast_flags opts = { 0, };
1187         char *opt_args[OPT_ARG_ARRAY_SIZE];
1188
1189         ... do any argument parsing here ...
1190
1191         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
1192                 return -1;
1193         }
1194   }
1195   \endcode
1196  */
1197 #define AST_APP_OPTIONS(holder, options...) \
1198         static const struct ast_app_option holder[128] = options
1199
1200 /*!
1201   \brief Declares an application option that does not accept an argument.
1202   \param option The single character representing the option
1203   \param flagno The flag index to be set if this option is present
1204   \sa AST_APP_OPTIONS, ast_app_parse_options
1205  */
1206 #define AST_APP_OPTION(option, flagno) \
1207         [option] = { .flag = flagno }
1208
1209 /*!
1210   \brief Declares an application option that accepts an argument.
1211   \param option The single character representing the option
1212   \param flagno The flag index to be set if this option is present
1213   \param argno The index into the argument array where the argument should
1214   be placed
1215   \sa AST_APP_OPTIONS, ast_app_parse_options
1216  */
1217 #define AST_APP_OPTION_ARG(option, flagno, argno) \
1218         [option] = { .flag = flagno, .arg_index = argno + 1 }
1219
1220 /*!
1221   \brief Parses a string containing application options and sets flags/arguments.
1222   \param options The array of possible options declared with AST_APP_OPTIONS
1223   \param flags The flag structure to have option flags set
1224   \param args The array of argument pointers to hold arguments found
1225   \param optstr The string containing the options to be parsed
1226   \return zero for success, non-zero if an error occurs
1227   \sa AST_APP_OPTIONS
1228  */
1229 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
1230
1231         /*!
1232   \brief Parses a string containing application options and sets flags/arguments.
1233   \param options The array of possible options declared with AST_APP_OPTIONS
1234   \param flags The 64-bit flag structure to have option flags set
1235   \param args The array of argument pointers to hold arguments found
1236   \param optstr The string containing the options to be parsed
1237   \return zero for success, non-zero if an error occurs
1238   \sa AST_APP_OPTIONS
1239  */
1240 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
1241
1242 /*! \brief Given a list of options array, return an option string based on passed flags
1243         \param options The array of possible options declared with AST_APP_OPTIONS
1244         \param flags The flags of the options that you wish to populate the buffer with
1245         \param buf The buffer to fill with the string of options
1246         \param len The maximum length of buf
1247 */
1248 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
1249
1250 /*! \brief Present a dialtone and collect a certain length extension.
1251     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
1252 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
1253 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
1254
1255 /*! \brief Allow to record message and have a review option */
1256 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
1257
1258 /*!
1259  * \brief Decode an encoded control or extended ASCII character
1260  * \param[in] stream String to decode
1261  * \param[out] result Decoded character
1262  * \param[out] consumed Number of characters used in stream to encode the character
1263  * \retval -1 Stream is of zero length
1264  * \retval 0 Success
1265  */
1266 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
1267
1268 /*!
1269  * \brief Decode a stream of encoded control or extended ASCII characters
1270  * \param[in] stream Encoded string
1271  * \param[out] result Decoded string
1272  * \param[in] result_len Maximum size of the result buffer
1273  * \return A pointer to the result string
1274  */
1275 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
1276
1277 /*! \brief Decode a stream of encoded control or extended ASCII characters */
1278 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
1279
1280 /*!
1281  * \brief Common routine for child processes, to close all fds prior to exec(2)
1282  * \param[in] n starting file descriptor number for closing all higher file descriptors
1283  * \since 1.6.1
1284  */
1285 void ast_close_fds_above_n(int n);
1286
1287 /*!
1288  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
1289  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
1290  * \since 1.6.1
1291  */
1292 int ast_safe_fork(int stop_reaper);
1293
1294 /*!
1295  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
1296  * \since 1.6.1
1297  */
1298 void ast_safe_fork_cleanup(void);
1299
1300 /*!
1301  * \brief Common routine to parse time lengths, with optional time unit specifier
1302  * \param[in] timestr String to parse
1303  * \param[in] defunit Default unit type
1304  * \param[out] result Resulting value, specified in milliseconds
1305  * \retval 0 Success
1306  * \retval -1 Failure
1307  * \since 1.8
1308  */
1309 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
1310
1311 /*!
1312  * \since 12
1313  * \brief Publish a MWI state update via stasis
1314  * \param[in] mailbox The number identifying this mailbox
1315  * \param[in] context The context this mailbox resides in
1316  * \param[in] new_msgs The number of new messages in this mailbox
1317  * \param[in] old_msgs The number of old messages in this mailbox
1318  * \retval 0 Success
1319  * \retval -1 Failure
1320  * \since 12
1321  */
1322 #define ast_publish_mwi_state(mailbox, context, new_msgs, old_msgs) \
1323         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, NULL, NULL)
1324
1325 /*!
1326  * \since 12
1327  * \brief Publish a MWI state update associated with some channel
1328  * \param[in] mailbox The number identifying this mailbox
1329  * \param[in] context The context this mailbox resides in
1330  * \param[in] new_msgs The number of new messages in this mailbox
1331  * \param[in] old_msgs The number of old messages in this mailbox
1332  * \param[in] channel_id A unique identifier for a channel associated with this
1333  * change in mailbox state
1334  * \retval 0 Success
1335  * \retval -1 Failure
1336  * \since 12
1337  */
1338 #define ast_publish_mwi_state_channel(mailbox, context, new_msgs, old_msgs, channel_id) \
1339         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, channel_id, NULL)
1340
1341 /*!
1342  * \since 12
1343  * \brief Publish a MWI state update via stasis with all parameters
1344  * \param[in] mailbox The number identifying this mailbox
1345  * \param[in] context The context this mailbox resides in
1346  * \param[in] new_msgs The number of new messages in this mailbox
1347  * \param[in] old_msgs The number of old messages in this mailbox
1348  * \param[in] channel_id A unique identifier for a channel associated with this
1349  * \param[in] eid The EID of the server that originally published the message
1350  * \retval 0 Success
1351  * \retval -1 Failure
1352  * \since 12
1353  */
1354 int ast_publish_mwi_state_full(
1355                         const char *mailbox,
1356                         const char *context,
1357                         int new_msgs,
1358                         int old_msgs,
1359                         const char *channel_id,
1360                         struct ast_eid *eid);
1361
1362 /*! \addtogroup StasisTopicsAndMessages
1363  * @{
1364  */
1365
1366 /*!
1367  * \brief The structure that contains MWI state
1368  * \since 12
1369  */
1370 struct ast_mwi_state {
1371         AST_DECLARE_STRING_FIELDS(
1372                 AST_STRING_FIELD(uniqueid);  /*!< Unique identifier for this mailbox/context */
1373                 AST_STRING_FIELD(mailbox);   /*!< Mailbox for this event */
1374                 AST_STRING_FIELD(context);   /*!< Context that this mailbox belongs to */
1375         );
1376         int new_msgs;                    /*!< The current number of new messages for this mailbox */
1377         int old_msgs;                    /*!< The current number of old messages for this mailbox */
1378         /*! If applicable, a snapshot of the channel that caused this MWI change */
1379         struct ast_channel_snapshot *snapshot;
1380         struct ast_eid eid;              /*!< The EID of the server where this message originated */
1381 };
1382
1383 /*!
1384  * \brief Object that represents an MWI update with some additional application
1385  * defined data
1386  */
1387 struct ast_mwi_blob {
1388         struct ast_mwi_state *mwi_state;    /*!< MWI state */
1389         struct ast_json *blob;              /*!< JSON blob of data */
1390 };
1391
1392 /*!
1393  * \since 12
1394  * \brief Create a \ref ast_mwi_state object
1395  *
1396  * \retval \ref ast_mwi_state object on success
1397  * \retval NULL on error
1398  */
1399 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context);
1400
1401 /*!
1402  * \since 12
1403  * \brief Creates a \ref ast_mwi_blob message.
1404  *
1405  * The \a blob JSON object requires a \c "type" field describing the blob. It
1406  * should also be treated as immutable and not modified after it is put into the
1407  * message.
1408  *
1409  * \param mwi_state MWI state associated with the update
1410  * \param message_type The type of message to create
1411  * \param blob JSON object representing the data.
1412  * \return \ref ast_mwi_blob message.
1413  * \return \c NULL on error
1414  */
1415 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
1416                                            struct stasis_message_type *message_type,
1417                                            struct ast_json *blob);
1418
1419 /*!
1420  * \brief Get the \ref stasis topic for MWI messages
1421  * \retval The topic structure for MWI messages
1422  * \retval NULL if it has not been allocated
1423  * \since 12
1424  */
1425 struct stasis_topic *ast_mwi_topic_all(void);
1426
1427 /*!
1428  * \brief Get the \ref stasis topic for MWI messages on a unique ID
1429  * \param uniqueid The unique id for which to get the topic
1430  * \retval The topic structure for MWI messages for a given uniqueid
1431  * \retval NULL if it failed to be found or allocated
1432  * \since 12
1433  */
1434 struct stasis_topic *ast_mwi_topic(const char *uniqueid);
1435
1436 /*!
1437  * \brief Get the \ref stasis caching topic for MWI messages
1438  * \retval The caching topic structure for MWI messages
1439  * \retval NULL if it has not been allocated
1440  * \since 12
1441  */
1442 struct stasis_topic *ast_mwi_topic_cached(void);
1443
1444 /*!
1445  * \brief Backend cache for ast_mwi_topic_cached().
1446  * \retval Cache of \ref ast_mwi_state.
1447  */
1448 struct stasis_cache *ast_mwi_state_cache(void);
1449
1450 /*!
1451  * \brief Get the \ref stasis message type for MWI messages
1452  * \retval The message type structure for MWI messages
1453  * \retval NULL on error
1454  * \since 12
1455  */
1456 struct stasis_message_type *ast_mwi_state_type(void);
1457
1458 /*!
1459  * \brief Get the \ref stasis message type for voicemail application specific messages
1460  *
1461  * This message type exists for those messages a voicemail application may wish to send
1462  * that have no logical relationship with other voicemail applications. Voicemail apps
1463  * that use this message type must pass a \ref ast_mwi_blob. Any extraneous information
1464  * in the JSON blob must be packed as key/value pair tuples of strings.
1465  *
1466  * At least one key/value tuple must have a key value of "Event".
1467  *
1468  * \retval The \ref stasis_message_type for voicemail application specific messages
1469  * \retval NULL on error
1470  * \since 12
1471  */
1472 struct stasis_message_type *ast_mwi_vm_app_type(void);
1473
1474 /*!
1475  * \brief Get the \ref stasis topic for queue messages
1476  * \retval The topic structure for queue messages
1477  * \retval NULL if it has not been allocated
1478  * \since 12
1479  */
1480 struct stasis_topic *ast_queue_topic_all(void);
1481
1482 /*!
1483  * \brief Get the \ref stasis topic for queue messages for a particular queue name
1484  * \param queuename The name for which to get the topic
1485  * \retval The topic structure for queue messages for a given name
1486  * \retval NULL if it failed to be found or allocated
1487  * \since 12
1488  */
1489 struct stasis_topic *ast_queue_topic(const char *queuename);
1490 /*! @} */
1491
1492 /*!
1493  * \brief Initialize the application core
1494  * \retval 0 Success
1495  * \retval -1 Failure
1496  * \since 12
1497  */
1498 int app_init(void);
1499
1500 #define AST_MAX_MAILBOX_UNIQUEID (AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2)
1501 #if defined(__cplusplus) || defined(c_plusplus)
1502 }
1503 #endif
1504
1505 #endif /* _ASTERISK_APP_H */