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