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