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