documentation: Standardize examples
[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     \retval 0 on completion.
46     \retval -1 on hangup or digit if interrupted.
47   */
48 typedef int (ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
49
50 typedef enum {
51         AST_ACTION_UPONE,       /*!< adata is unused */
52         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
53         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
54         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
55         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
56         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
57         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
58         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
59         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
60         AST_ACTION_TRANSFER,    /*!< adata is a string with exten[\@context] */
61         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
62         AST_ACTION_NOOP,        /*!< adata is unused */
63         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
64 } ast_ivr_action;
65
66 /*!
67     Special "options" are:
68    \arg "s" - "start here (one time greeting)"
69    \arg "g" - "greeting/instructions"
70    \arg "t" - "timeout"
71    \arg "h" - "hangup"
72    \arg "i" - "invalid selection"
73
74 */
75 struct ast_ivr_option {
76         char *option;
77         ast_ivr_action action;
78         void *adata;
79 };
80
81 struct ast_ivr_menu {
82         char *title;            /*!< Title of menu */
83         unsigned int flags;     /*!< Flags */
84         struct ast_ivr_option *options; /*!< All options */
85 };
86
87 /*!
88  * \brief Structure used for ast_copy_recording_to_vm in order to cleanly supply
89  * data needed for making the recording from the recorded file.
90  */
91 struct ast_vm_recording_data {
92         AST_DECLARE_STRING_FIELDS(
93                 AST_STRING_FIELD(context);
94                 AST_STRING_FIELD(mailbox);
95                 AST_STRING_FIELD(folder);
96                 AST_STRING_FIELD(recording_file);
97                 AST_STRING_FIELD(recording_ext);
98
99                 AST_STRING_FIELD(call_context);
100                 AST_STRING_FIELD(call_macrocontext);
101                 AST_STRING_FIELD(call_extension);
102                 AST_STRING_FIELD(call_callerchan);
103                 AST_STRING_FIELD(call_callerid);
104                 );
105         int call_priority;
106 };
107
108 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
109
110 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
111         static struct ast_ivr_option __options_##holder[] = foo;\
112         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
113
114 enum ast_timelen {
115         TIMELEN_HOURS,
116         TIMELEN_MINUTES,
117         TIMELEN_SECONDS,
118         TIMELEN_MILLISECONDS,
119 };
120
121 /*!     \brief Runs an IVR menu
122         \retval 0 on successful completion.
123         \retval -1 on hangup.
124         \retval -2 on user error in menu.
125 */
126 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
127
128 /*! \brief Plays a stream and gets DTMF data from a channel
129  * \param c Which channel one is interacting with
130  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
131  *        It is also valid for this to be multiple files concatenated by "&".
132  *        For example, "file1&file2&file3".
133  * \param s The location where the DTMF data will be stored
134  * \param maxlen Max Length of the data
135  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
136  *
137  *  This function was designed for application programmers for situations where they need
138  *  to play a message and then get some DTMF data in response to the message.  If a digit
139  *  is pressed during playback, it will immediately break out of the message and continue
140  *  execution of your code.
141  */
142 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
143
144 /*! \brief Plays a stream and gets DTMF data from a channel
145  * \param c Which channel one is interacting with
146  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
147  *        It is also valid for this to be multiple files concatenated by "&".
148  *        For example, "file1&file2&file3".
149  * \param s The location where the DTMF data will be stored
150  * \param maxlen Max Length of the data
151  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
152  * \param terminator A string of characters that may be used as terminators to end input. If NULL, "#" will be used.
153  *
154  *  This function was designed for application programmers for situations where they need
155  *  to play a message and then get some DTMF data in response to the message.  If a digit
156  *  is pressed during playback, it will immediately break out of the message and continue
157  *  execution of your code.
158  */
159 int ast_app_getdata_terminator(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, char *terminator);
160
161 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
162 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
163
164 /*!
165  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
166  * \since 11.0
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_args Macro application argument string.
179  *
180  * \retval 0 success
181  * \retval -1 on error
182  */
183 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args);
184
185 /*!
186  * \since 1.8
187  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
188  *
189  * \details
190  * This is a shorthand method that makes it very easy to run a
191  * macro on any given channel.  It is perfectly reasonable to
192  * supply a NULL autoservice_chan here in case there is no
193  * channel to place into autoservice.
194  *
195  * \note Absolutely _NO_ channel locks should be held before calling this function.
196  *
197  * \param autoservice_chan A channel to place into autoservice while the macro is run
198  * \param macro_chan Channel to execute macro on.
199  * \param macro_name The name of the macro to run.
200  * \param macro_args The arguments to pass to the macro.
201  *
202  * \retval 0 success
203  * \retval -1 on error
204  */
205 int ast_app_run_macro(struct ast_channel *autoservice_chan,
206         struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
207
208 /*!
209  * \brief Stack applications callback functions.
210  */
211 struct ast_app_stack_funcs {
212         /*!
213          * Module reference pointer so the module will stick around
214          * while a callback is active.
215          */
216         void *module;
217
218         /*!
219          * \brief Callback for the routine to run a subroutine on a channel.
220          *
221          * \note Absolutely _NO_ channel locks should be held before calling this function.
222          *
223          * \param chan Channel to execute subroutine on.
224          * \param args Gosub application argument string.
225          * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
226          *
227          * \retval 0 success
228          * \retval -1 on error
229          */
230         int (*run_sub)(struct ast_channel *chan, const char *args, int ignore_hangup);
231
232         /*!
233          * \brief Add missing context/exten to Gosub application argument string.
234          *
235          * \param chan Channel to obtain context/exten.
236          * \param args Gosub application argument string.
237          *
238          * \details
239          * Fills in the optional context and exten from the given channel.
240          *
241          * \return New-args Gosub argument string on success.  Must be freed.
242          * \retval NULL on error.
243          */
244         const char *(*expand_sub_args)(struct ast_channel *chan, const char *args);
245
246         /* Add new API calls to the end here. */
247 };
248
249 /*!
250  * \since 11
251  * \brief Set stack application function callbacks
252  * \param funcs Stack applications callback functions.
253  */
254 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs);
255
256 /*!
257  * \brief Add missing context/exten to subroutine argument string.
258  *
259  * \param chan Channel to obtain context/exten.
260  * \param args Gosub application argument string.
261  *
262  * \details
263  * Fills in the optional context and exten from the given channel.
264  *
265  * \return New-args Gosub argument string on success.  Must be freed.
266  * \retval NULL on error.
267  */
268 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args);
269
270 /*!
271  * \since 11
272  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
273  *
274  * \details
275  * This is a shorthand method that makes it very easy to run a
276  * subroutine on any given channel.  It is perfectly reasonable
277  * to supply a NULL autoservice_chan here in case there is no
278  * channel to place into autoservice.
279  *
280  * \note Absolutely _NO_ channel locks should be held before calling this function.
281  *
282  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
283  * \param sub_chan Channel to execute subroutine on.
284  * \param sub_args Gosub application argument string.
285  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
286  *
287  * \retval 0 success
288  * \retval -1 on error
289  */
290 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup);
291
292 /*!
293  * \since 11
294  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
295  *
296  * \details
297  * This is a shorthand method that makes it very easy to run a
298  * subroutine on any given channel.  It is perfectly reasonable
299  * to supply a NULL autoservice_chan here in case there is no
300  * channel to place into autoservice.
301  *
302  * \note Absolutely _NO_ channel locks should be held before calling this function.
303  *
304  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
305  * \param sub_chan Channel to execute subroutine on.
306  * \param sub_location The location of the subroutine to run.
307  * \param sub_args The arguments to pass to the subroutine.
308  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
309  *
310  * \retval 0 success
311  * \retval -1 on error
312  */
313 int ast_app_run_sub(struct ast_channel *autoservice_chan,
314         struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup);
315
316 enum ast_vm_snapshot_sort_val {
317         AST_VM_SNAPSHOT_SORT_BY_ID = 0,
318         AST_VM_SNAPSHOT_SORT_BY_TIME,
319 };
320
321 struct ast_vm_msg_snapshot {
322         AST_DECLARE_STRING_FIELDS(
323                 AST_STRING_FIELD(msg_id);
324                 AST_STRING_FIELD(callerid);
325                 AST_STRING_FIELD(callerchan);
326                 AST_STRING_FIELD(exten);
327                 AST_STRING_FIELD(origdate);
328                 AST_STRING_FIELD(origtime);
329                 AST_STRING_FIELD(duration);
330                 AST_STRING_FIELD(folder_name);
331                 AST_STRING_FIELD(flag);
332         );
333         unsigned int msg_number;
334
335         AST_LIST_ENTRY(ast_vm_msg_snapshot) msg;
336 };
337
338 struct ast_vm_mailbox_snapshot {
339         int total_msg_num;
340         int folders;
341         /* Things are not quite as they seem here.  This points to an allocated array of lists. */
342         AST_LIST_HEAD_NOLOCK(, ast_vm_msg_snapshot) *snapshots;
343 };
344
345 /*!
346  * \brief Voicemail playback callback function definition
347  *
348  * \param chan Channel to play the file back on.
349  * \param playfile Location of file on disk
350  * \param duration of file in seconds. This will be zero if msg is very short or
351  * has an unknown duration.
352  */
353 typedef void (ast_vm_msg_play_cb)(struct ast_channel *chan, const char *playfile, int duration);
354
355 /*!
356  * \brief Determines if the given folder has messages.
357  *
358  * \param mailboxes Comma or & delimited list of mailboxes (user\@context).
359  *          If no context is found, uses 'default' for the context.
360  * \param folder The folder to look in.  Default is INBOX if not provided.
361  *
362  * \retval 1 if the folder has one or more messages.
363  * \retval 0 otherwise.
364  */
365 typedef int (ast_has_voicemail_fn)(const char *mailboxes, const char *folder);
366
367 /*!
368  * \brief Gets the number of messages that exist for the mailbox list.
369  *
370  * \param mailboxes Comma or space delimited list of mailboxes (user\@context).
371  *          If no context is found, uses 'default' for the context.
372  * \param newmsgs Where to put the count of new messages. (Can be NULL)
373  * \param oldmsgs Where to put the count of old messages. (Can be NULL)
374  *
375  * \details
376  * Simultaneously determines the count of new + urgent and old
377  * messages.  The total messages would then be the sum of these.
378  *
379  * \retval 0 on success
380  * \retval -1 on failure
381  */
382 typedef int (ast_inboxcount_fn)(const char *mailboxes, int *newmsgs, int *oldmsgs);
383
384 /*!
385  * \brief Gets the number of messages that exist for the mailbox list.
386  *
387  * \param mailboxes Comma or space delimited list of mailboxes (user\@context).
388  *          If no context is found, uses 'default' for the context.
389  * \param urgentmsgs Where to put the count of urgent messages. (Can be NULL)
390  * \param newmsgs Where to put the count of new messages. (Can be NULL)
391  * \param oldmsgs Where to put the count of old messages. (Can be NULL)
392  *
393  * \details
394  * Simultaneously determines the count of new, old, and urgent
395  * messages.  The total messages would then be the sum of these
396  * three.
397  *
398  * \retval 0 on success
399  * \retval -1 on failure
400  */
401 typedef int (ast_inboxcount2_fn)(const char *mailboxes, int *urgentmsgs, int *newmsgs, int *oldmsgs);
402
403 /*!
404  * \brief Gets the number of messages that exist in a mailbox folder.
405  *
406  * \param mailbox_id The mailbox name.
407  * \param folder The folder to look in.  Default is INBOX if not provided.
408  *
409  * \note If requesting INBOX then the returned count is INBOX + Urgent.
410  *
411  * \return The number of messages in the mailbox folder (zero or more).
412  */
413 typedef int (ast_messagecount_fn)(const char *mailbox_id, const char *folder);
414
415 /*!
416  * \brief Play a recorded user name for the mailbox to the specified channel.
417  *
418  * \param chan Where to play the recorded name file.
419  * \param mailbox_id The mailbox name.
420  *
421  * \retval 0 Name played without interruption
422  * \return dtmf ASCII value of the DTMF which interrupted playback.
423  * \retval -1 Unable to locate mailbox or hangup occurred.
424  */
425 typedef int (ast_sayname_fn)(struct ast_channel *chan, const char *mailbox_id);
426
427 /*!
428  * \brief Creates a voicemail based on a specified file to a mailbox.
429  *
430  * \param vm_rec_data A record containing filename and voicemail txt info.
431  *
432  * \retval 0 on success
433  * \retval -1 on failure
434  */
435 typedef int (ast_copy_recording_to_vm_fn)(struct ast_vm_recording_data *vm_rec_data);
436
437 /*!
438  * \brief Convert the mailbox folder id to a folder name.
439  *
440  * \param id Mailbox folder id to convert.
441  *
442  * \deprecated Nothing calls it and nothing ever should.
443  *
444  * \return The folder name associated with the id.
445  */
446 typedef const char *(ast_vm_index_to_foldername_fn)(int id);
447
448 /*!
449  * \brief Create a snapshot of a mailbox which contains information about every msg.
450  *
451  * \param user The user part of user\@context.
452  * \param context The context part of user\@context.  Must be explicit.
453  * \param folder When not NULL only msgs from the specified folder will be included.
454  * \param descending list the msgs in descending order rather than ascending order.
455  * \param sort_val What to sort in the snapshot.
456  * \param combine_INBOX_and_OLD When this argument is set, The OLD folder will be represented
457  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
458  *        OLD and INBOX messages in sorted order merged together.
459  *
460  * \note Only used by voicemail unit tests.
461  *
462  * \return snapshot on success
463  * \retval NULL on failure
464  */
465 typedef struct ast_vm_mailbox_snapshot *(ast_vm_mailbox_snapshot_create_fn)(const char *user,
466         const char *context, const char *folder, int descending,
467         enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD);
468
469 /*!
470  * \brief destroy a snapshot
471  *
472  * \param mailbox_snapshot The snapshot to destroy.
473  *
474  * \note Only used by voicemail unit tests.
475  *
476  * \retval NULL
477  */
478 typedef struct ast_vm_mailbox_snapshot *(ast_vm_mailbox_snapshot_destroy_fn)(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
479
480 /*!
481  * \brief Move messages from one folder to another
482  *
483  * \param mailbox The mailbox to which the folders belong
484  * \param context The voicemail context for the mailbox
485  * \param num_msgs The number of messages to move
486  * \param oldfolder The folder from where messages should be moved
487  * \param old_msg_ids The message IDs of the messages to move
488  * \param newfolder The folder to which messages should be moved
489  *    new folder. This array must be num_msgs sized.
490  *
491  * \note Only used by voicemail unit tests.
492  *
493  * \retval -1 Failure
494  * \retval 0 Success
495  */
496 typedef int (ast_vm_msg_move_fn)(const char *mailbox, const char *context, size_t num_msgs,
497         const char *oldfolder, const char *old_msg_ids[], const char *newfolder);
498
499 /*!
500  * \brief Remove/delete messages from a mailbox folder.
501  *
502  * \param mailbox The mailbox from which to delete messages
503  * \param context The voicemail context for the mailbox
504  * \param num_msgs The number of messages to delete
505  * \param folder The folder from which to remove messages
506  * \param msgs The message IDs of the messages to delete
507  *
508  * \note Only used by voicemail unit tests.
509  *
510  * \retval -1 Failure
511  * \retval 0 Success
512  */
513 typedef int (ast_vm_msg_remove_fn)(const char *mailbox, const char *context, size_t num_msgs,
514         const char *folder, const char *msgs[]);
515
516 /*!
517  * \brief forward a message from one mailbox to another.
518  *
519  * \brief from_mailbox The original mailbox the message is being forwarded from
520  * \brief from_context The voicemail context of the from_mailbox
521  * \brief from_folder The folder from which the message is being forwarded
522  * \brief to_mailbox The mailbox to forward the message to
523  * \brief to_context The voicemail context of the to_mailbox
524  * \brief to_folder The folder to which the message is being forwarded
525  * \brief num_msgs The number of messages being forwarded
526  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
527  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
528  * Otherwise, the messages will remain in the from_mailbox.
529  *
530  * \note Only used by voicemail unit tests.
531  *
532  * \retval -1 Failure
533  * \retval 0 Success
534  */
535 typedef int (ast_vm_msg_forward_fn)(const char *from_mailbox, const char *from_context,
536         const char *from_folder, const char *to_mailbox, const char *to_context,
537         const char *to_folder, size_t num_msgs, const char *msg_ids[], int delete_old);
538
539 /*!
540  * \brief Play a voicemail msg back on a channel.
541  *
542  * \param chan
543  * \param mailbox msg is in.
544  * \param context of mailbox.
545  * \param folder voicemail folder to look in.
546  * \param msg_num message number in the voicemailbox to playback to the channel.
547  * \param cb
548  *
549  * \note Only used by voicemail unit tests.
550  *
551  * \retval 0 success
552  * \retval -1 failure
553  */
554 typedef int (ast_vm_msg_play_fn)(struct ast_channel *chan, const char *mailbox,
555         const char *context, const char *folder, const char *msg_num, ast_vm_msg_play_cb *cb);
556
557 #define VM_MODULE_VERSION 2
558
559 /*! \brief Voicemail function table definition. */
560 struct ast_vm_functions {
561         /*!
562          * \brief The version of this function table.
563          *
564          * \note If the ABI for this table changes, the module version
565          * (\ref VM_MODULE_VERSION) should be incremented.
566          */
567         unsigned int module_version;
568         /*! \brief The name of the module that provides the voicemail functionality */
569         const char *module_name;
570         /*! \brief The module for the voicemail provider */
571         struct ast_module *module;
572
573         ast_has_voicemail_fn *has_voicemail;
574         ast_inboxcount_fn *inboxcount;
575         ast_inboxcount2_fn *inboxcount2;
576         ast_messagecount_fn *messagecount;
577         ast_copy_recording_to_vm_fn *copy_recording_to_vm;
578         ast_vm_index_to_foldername_fn *index_to_foldername;
579         ast_vm_mailbox_snapshot_create_fn *mailbox_snapshot_create;
580         ast_vm_mailbox_snapshot_destroy_fn *mailbox_snapshot_destroy;
581         ast_vm_msg_move_fn *msg_move;
582         ast_vm_msg_remove_fn *msg_remove;
583         ast_vm_msg_forward_fn *msg_forward;
584         ast_vm_msg_play_fn *msg_play;
585 };
586
587 /*!
588  * \brief Determine if a voicemail provider is registered.
589  * \since 12.0.0
590  *
591  * \retval 0 if no provider registered.
592  * \retval 1 if a provider is registered.
593  */
594 int ast_vm_is_registered(void);
595
596 /*!
597  * \brief Set voicemail function callbacks
598  *
599  * \param vm_table Voicemail function table to install.
600  * \param module Pointer to the module implementing the interface
601  *
602  * \retval 0 on success.
603  * \retval -1 on error.
604  * \retval AST_MODULE_LOAD_DECLINE if there's already another provider registered.
605  */
606 int __ast_vm_register(const struct ast_vm_functions *vm_table, struct ast_module *module);
607
608 /*! \brief See \ref __ast_vm_register() */
609 #define ast_vm_register(vm_table) __ast_vm_register(vm_table, AST_MODULE_SELF)
610
611 /*!
612  * \brief Unregister the specified voicemail provider
613  *
614  * \param module_name The module name of the provider to unregister
615  */
616 void ast_vm_unregister(const char *module_name);
617
618 #ifdef TEST_FRAMEWORK
619 /*!
620  * \brief Swap out existing voicemail functions with a temporary set of functions for use with unit tests
621  *
622  * \param vm_table function table to use for testing
623  *
624  * \note ast_vm_test_swap_table_out should be called to restore the original set before testing concludes
625  */
626 void ast_vm_test_swap_table_in(const struct ast_vm_functions *vm_table);
627
628 /*!
629  * \brief Used after ast_vm_test_swap_table_in to restore the original set of voicemail functions
630  */
631 void ast_vm_test_swap_table_out(void);
632 #endif
633
634 #define VM_GREETER_MODULE_VERSION 1
635
636 /*! \brief Voicemail greeter function table definition. */
637 struct ast_vm_greeter_functions {
638         /*!
639          * \brief The version of this function table.
640          *
641          * \note If the ABI for this table changes, the module version
642          * (\ref VM_GREETER_MODULE_VERSION) should be incremented.
643          */
644         unsigned int module_version;
645         /*! \brief The name of the module that provides the voicemail greeter functionality */
646         const char *module_name;
647         /*! \brief The module for the voicemail greeter provider */
648         struct ast_module *module;
649
650         ast_sayname_fn *sayname;
651 };
652
653 /*!
654  * \brief Determine if a voicemail greeter provider is registered.
655  * \since 13.0.0
656  *
657  * \retval 0 if no provider registered.
658  * \retval 1 if a provider is registered.
659  */
660 int ast_vm_greeter_is_registered(void);
661
662 /*!
663  * \brief Set voicemail greeter function callbacks
664  * \since 13.0.0
665  *
666  * \param vm_table Voicemail greeter function table to install.
667  * \param module Pointer to the module implementing the interface
668  *
669  * \retval 0 on success.
670  * \retval -1 on error.
671  * \retval AST_MODULE_LOAD_DECLINE if there's already another greeter registered.
672  */
673 int __ast_vm_greeter_register(const struct ast_vm_greeter_functions *vm_table, struct ast_module *module);
674
675 /*! \brief See \ref __ast_vm_greeter_register() */
676 #define ast_vm_greeter_register(vm_table) __ast_vm_greeter_register(vm_table, AST_MODULE_SELF)
677
678 /*!
679  * \brief Unregister the specified voicemail greeter provider
680  * \since 13.0.0
681  *
682  * \param module_name The module name of the provider to unregister
683  */
684 void ast_vm_greeter_unregister(const char *module_name);
685
686 #ifdef TEST_FRAMEWORK
687 typedef int (ast_vm_test_create_user_fn)(const char *context, const char *user);
688 typedef int (ast_vm_test_destroy_user_fn)(const char *context, const char *user);
689
690 void ast_install_vm_test_functions(ast_vm_test_create_user_fn *vm_test_create_user_func,
691         ast_vm_test_destroy_user_fn *vm_test_destroy_user_func);
692
693 void ast_uninstall_vm_test_functions(void);
694 #endif
695
696 /*!
697  * \brief
698  * param[in] vm_rec_data Contains data needed to make the recording.
699  * retval 0 voicemail successfully created from recording.
700  * retval -1 Failure
701  */
702 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data);
703
704 /*!
705  * \brief Determine if a given mailbox has any voicemail
706  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
707  * number of messages in the "Urgent" folder.
708  * \retval 1 Mailbox has voicemail
709  * \retval 0 No new voicemail in specified mailbox
710  * \retval -1 Failure
711  * \since 1.0
712  */
713 int ast_app_has_voicemail(const char *mailboxes, const char *folder);
714
715 /*!
716  * \brief Determine number of new/old messages in a mailbox
717  * \since 1.0
718  * \param[in] mailboxes Mailbox specification in the format
719  *      /code
720  *       mbox[\@context][&mbox2[\@context2]][...]
721  *      /code
722  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
723  * \param[out] oldmsgs Number of messages in the "Old" folder.
724  * \retval 0 Success
725  * \retval -1 Failure
726  */
727 int ast_app_inboxcount(const char *mailboxes, int *newmsgs, int *oldmsgs);
728
729 /*!
730  * \brief Determine number of urgent/new/old messages in a mailbox
731  * \param[in] mailboxes the mailbox context to use
732  * \param[out] urgentmsgs the urgent message count
733  * \param[out] newmsgs the new message count
734  * \param[out] oldmsgs the old message count
735  * \retval 0 for success
736  * \retval negative upon error
737  * \since 1.6.1
738  */
739 int ast_app_inboxcount2(const char *mailboxes, int *urgentmsgs, int *newmsgs, int *oldmsgs);
740
741 /*!
742  * \brief Play a recorded user name for the mailbox to the specified channel.
743  *
744  * \param chan Where to play the recorded name file.
745  * \param mailbox_id The mailbox name.
746  *
747  * \retval 0 Name played without interruption
748  * \retval dtmf ASCII value of the DTMF which interrupted playback.
749  * \retval -1 Unable to locate mailbox or hangup occurred.
750  */
751 int ast_app_sayname(struct ast_channel *chan, const char *mailbox_id);
752
753 /*!
754  * \brief Get the number of messages in a given mailbox folder
755  *
756  * \param[in] mailbox_id Mailbox name
757  * \param[in] folder The folder to look in.  Default is INBOX if not provided.
758  *
759  * \note If requesting INBOX then the returned count is INBOX + Urgent.
760  *
761  * \return The number of messages in the mailbox folder (zero or more).
762  */
763 int ast_app_messagecount(const char *mailbox_id, const char *folder);
764
765 /*!
766  * \brief Return name of folder, given an id
767  * \param[in] id Folder id
768  * \return Name of folder
769  */
770 const char *ast_vm_index_to_foldername(int id);
771
772 /*!
773  * \brief Create a snapshot of a mailbox which contains information about every msg.
774  *
775  * \param mailbox the mailbox to look for
776  * \param context the context to look for the mailbox in
777  * \param folder OPTIONAL.  When not NULL only msgs from the specified folder will be included.
778  * \param descending list the msgs in descending order rather than ascending order.
779  * \param sort_val What to sort in the snapshot.
780  * \param combine_INBOX_and_OLD When this argument is set, The OLD folder will be represented
781  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
782  *        OLD and INBOX messages in sorted order merged together.
783  *
784  * \return snapshot on success
785  * \retval NULL on failure
786  */
787 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
788         const char *context,
789         const char *folder,
790         int descending,
791         enum ast_vm_snapshot_sort_val sort_val,
792         int combine_INBOX_and_OLD);
793
794 /*!
795  * \brief destroy a snapshot
796  *
797  * \param mailbox_snapshot The snapshot to destroy.
798  * \retval NULL
799  */
800 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
801
802 /*!
803  * \brief Move messages from one folder to another
804  *
805  * \param mailbox The mailbox to which the folders belong
806  * \param context The voicemail context for the mailbox
807  * \param num_msgs The number of messages to move
808  * \param oldfolder The folder from where messages should be moved
809  * \param old_msg_ids The message IDs of the messages to move
810  * \param newfolder The folder to which messages should be moved
811  * new folder. This array must be num_msgs sized.
812  *
813  * \retval -1 Failure
814  * \retval 0 Success
815  */
816 int ast_vm_msg_move(const char *mailbox,
817         const char *context,
818         size_t num_msgs,
819         const char *oldfolder,
820         const char *old_msg_ids[],
821         const char *newfolder);
822
823 /*!
824  * \brief Remove/delete messages from a mailbox folder.
825  *
826  * \param mailbox The mailbox from which to delete messages
827  * \param context The voicemail context for the mailbox
828  * \param num_msgs The number of messages to delete
829  * \param folder The folder from which to remove messages
830  * \param msgs The message IDs of the messages to delete
831  *
832  * \retval -1 Failure
833  * \retval 0 Success
834  */
835 int ast_vm_msg_remove(const char *mailbox,
836         const char *context,
837         size_t num_msgs,
838         const char *folder,
839         const char *msgs[]);
840
841 /*!
842  * \brief forward a message from one mailbox to another.
843  *
844  * \brief from_mailbox The original mailbox the message is being forwarded from
845  * \brief from_context The voicemail context of the from_mailbox
846  * \brief from_folder The folder from which the message is being forwarded
847  * \brief to_mailbox The mailbox to forward the message to
848  * \brief to_context The voicemail context of the to_mailbox
849  * \brief to_folder The folder to which the message is being forwarded
850  * \brief num_msgs The number of messages being forwarded
851  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
852  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
853  * Otherwise, the messages will remain in the from_mailbox.
854  *
855  * \retval -1 Failure
856  * \retval 0 Success
857  */
858 int ast_vm_msg_forward(const char *from_mailbox,
859         const char *from_context,
860         const char *from_folder,
861         const char *to_mailbox,
862         const char *to_context,
863         const char *to_folder,
864         size_t num_msgs,
865         const char *msg_ids[],
866         int delete_old);
867
868 /*!
869  * \brief Play a voicemail msg back on a channel.
870  *
871  * \param chan
872  * \param mailbox msg is in.
873  * \param context of mailbox.
874  * \param folder voicemail folder to look in.
875  * \param msg_num message number in the voicemailbox to playback to the channel.
876  * \param cb
877  *
878  * \retval 0 success
879  * \retval -1 failure
880  */
881 int ast_vm_msg_play(struct ast_channel *chan,
882         const char *mailbox,
883         const char *context,
884         const char *folder,
885         const char *msg_num,
886         ast_vm_msg_play_cb *cb);
887
888 #ifdef TEST_FRAMEWORK
889 int ast_vm_test_destroy_user(const char *context, const char *mailbox);
890 int ast_vm_test_create_user(const char *context, const char *mailbox);
891 #endif
892
893 /*!
894  * \brief Safely spawn an external program while closing file descriptors
895  *
896  * \note This replaces the \b execvp call in all Asterisk modules
897  *
898  * \param dualfork Non-zero to simulate running the program in the
899  * background by forking twice.  The option provides similar
900  * functionality to the '&' in the OS shell command "cmd &".  The
901  * option allows Asterisk to run a reaper loop to watch the first fork
902  * which immediately exits after spaning the second fork.  The actual
903  * program is run in the second fork.
904  * \param file execvp(file, argv) file parameter
905  * \param argv execvp(file, argv) argv parameter
906  */
907 int ast_safe_execvp(int dualfork, const char *file, char *const argv[]);
908
909 /*!
910  * \brief Safely spawn an OS shell command while closing file descriptors
911  *
912  * \note This replaces the \b system call in all Asterisk modules
913  *
914  * \param s - OS shell command string to execute.
915  *
916  * \warning Command injection can happen using this call if the passed
917  * in string is created using untrusted data from an external source.
918  * It is best not to use untrusted data.  However, the caller could
919  * filter out dangerous characters to avoid command injection.
920  */
921 int ast_safe_system(const char *s);
922
923 /*!
924  * \brief Replace the SIGCHLD handler
925  *
926  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
927  * processes from forking elsewhere in Asterisk.  However, if you want to
928  * wait*() on the process to retrieve information about it's exit status,
929  * then this signal handler needs to be temporarily replaced.
930  *
931  * Code that executes this function *must* call ast_unreplace_sigchld()
932  * after it is finished doing the wait*().
933  */
934 void ast_replace_sigchld(void);
935
936 /*!
937  * \brief Restore the SIGCHLD handler
938  *
939  * This function is called after a call to ast_replace_sigchld.  It restores
940  * the SIGCHLD handler that cleans up any zombie processes.
941  */
942 void ast_unreplace_sigchld(void);
943
944 /*!
945  * \brief Send a string of DTMF digits to a channel
946  *
947  * \param chan    The channel that will receive the DTMF frames
948  * \param peer    (optional) Peer channel that will be autoserviced while the
949  *                primary channel is receiving DTMF
950  * \param digits  This is a string of characters representing the DTMF digits
951  *                to be sent to the channel.  Valid characters are
952  *                "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
953  *                'F', if you want to Flash the channel (if supported by the
954  *                channel), or 'w' to add a 500 millisecond pause to the DTMF
955  *                sequence.
956  * \param between This is the number of milliseconds to wait in between each
957  *                DTMF digit.  If zero milliseconds is specified, then the
958  *                default value of 100 will be used.
959  * \param duration This is the duration that each DTMF digit should have.
960  *
961  * \pre This must only be called by the channel's media handler thread.
962  *
963  * \retval 0 on success.
964  * \retval -1 on failure or a channel hung up.
965  */
966 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
967
968 /*!
969  * \brief Send a string of DTMF digits to a channel from an external thread.
970  *
971  * \param chan    The channel that will receive the DTMF frames
972  * \param digits  This is a string of characters representing the DTMF digits
973  *                to be sent to the channel.  Valid characters are
974  *                "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
975  *                'F', if you want to Flash the channel (if supported by the
976  *                channel), or 'w' to add a 500 millisecond pause to the DTMF
977  *                sequence.
978  * \param between This is the number of milliseconds to wait in between each
979  *                DTMF digit.  If zero milliseconds is specified, then the
980  *                default value of 100 will be used.
981  * \param duration This is the duration that each DTMF digit should have.
982  *
983  * \pre This must only be called by threads that are not the channel's
984  * media handler thread.
985  */
986 void ast_dtmf_stream_external(struct ast_channel *chan, const char *digits, int between, unsigned int duration);
987
988 /*! \brief Stream a filename (or file descriptor) as a generator. */
989 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
990
991 /*!
992  * \brief Stream a file with fast forward, pause, reverse, restart.
993  * \param chan Channel
994  * \param file File to play.
995  * \param fwd, rev, stop, pause, restart DTMF keys for media control
996  * \param skipms Number of milliseconds to skip for fwd/rev.
997  * \param offsetms Number of milliseconds to skip when starting the media.
998  *
999  * Before calling this function, set this to be the number
1000  * of ms to start from the beginning of the file.  When the function
1001  * returns, it will be the number of ms from the beginning where the
1002  * playback stopped.  Pass NULL if you don't care.
1003  *
1004  * \retval 0 on success
1005  * \retval Non-zero on failure
1006  */
1007 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);
1008
1009 /*!
1010  * \brief Version of ast_control_streamfile() which allows the language of the
1011  * media file to be specified.
1012  *
1013  * \retval 0 on success
1014  * \retval Non-zero on failure
1015  */
1016 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
1017         const char *fwd, const char *rev, const char *stop, const char *suspend,
1018         const char *restart, int skipms, const char *lang, long *offsetms);
1019
1020 /*!
1021  * \brief Controls playback of a tone
1022  *
1023  * \retval 0 on success
1024  * \retval Non-zero on failure
1025  */
1026 int ast_control_tone(struct ast_channel *chan, const char *tone);
1027
1028 /*!
1029  * \brief Stream a file with fast forward, pause, reverse, restart.
1030  * \param chan
1031  * \param file filename
1032  * \param fwd, rev, stop, pause, restart, skipms, offsetms
1033  * \param cb waitstream callback to invoke when fastforward or rewind occurs.
1034  *
1035  * Before calling this function, set this to be the number
1036  * of ms to start from the beginning of the file.  When the function
1037  * returns, it will be the number of ms from the beginning where the
1038  * playback stopped.  Pass NULL if you don't care.
1039  */
1040 int ast_control_streamfile_w_cb(struct ast_channel *chan,
1041         const char *file,
1042         const char *fwd,
1043         const char *rev,
1044         const char *stop,
1045         const char *pause,
1046         const char *restart,
1047         int skipms,
1048         long *offsetms,
1049         ast_waitstream_fr_cb cb);
1050
1051 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
1052 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
1053
1054 /*!
1055  * Possible actions to take if a recording already exists
1056  * \since 12
1057  */
1058 enum ast_record_if_exists {
1059         /*! Return an Error State for IF_Exists */
1060         AST_RECORD_IF_EXISTS_ERROR = -1,
1061         /*! Fail the recording. */
1062         AST_RECORD_IF_EXISTS_FAIL,
1063         /*! Overwrite the existing recording. */
1064         AST_RECORD_IF_EXISTS_OVERWRITE,
1065         /*! Append to the existing recording. */
1066         AST_RECORD_IF_EXISTS_APPEND,
1067 };
1068
1069 /*!
1070  * \brief Record a file based on input from a channel
1071  *        This function will play "auth-thankyou" upon successful recording if
1072  *        skip_confirmation_sound is false.
1073  *
1074  * \param chan the channel being recorded
1075  * \param playfile Filename of sound to play before recording begins. A beep is also played when playfile completes, before the recording begins.
1076  * \param recordfile Filename to save the recording
1077  * \param maxtime_sec Longest possible message length in seconds
1078  * \param fmt string containing all formats to be recorded delimited by '|'
1079  * \param duration pointer to integer for storing length of the recording
1080  * \param beep If true, play a beep before recording begins (and doesn't play \a playfile)
1081  * \param sound_duration pointer to integer for storing length of the recording minus all silence
1082  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
1083  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
1084  * \param path Optional filesystem path to unlock
1085  * \param acceptdtmf Character of DTMF to end and accept the recording
1086  * \param canceldtmf Character of DTMF to end and cancel the recording
1087  * \param skip_confirmation_sound If true, don't play auth-thankyou at end. Nice for custom recording prompts in apps.
1088  * \param if_exists Action to take if recording already exists.
1089  *
1090  * \retval -1 failure or hangup
1091  * \retval 'S' Recording ended from silence timeout
1092  * \retval 't' Recording ended from the message exceeding the maximum duration
1093  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
1094  */
1095 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);
1096
1097 /*!
1098  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
1099  *        This function will play "auth-thankyou" upon successful recording.
1100  *
1101  * \param chan the channel being recorded
1102  * \param playfile Filename of sound to play before recording begins
1103  * \param recordfile Filename to save the recording
1104  * \param maxtime_sec Longest possible message length in seconds
1105  * \param fmt string containing all formats to be recorded delimited by '|'
1106  * \param duration pointer to integer for storing length of the recording
1107  * \param sound_duration pointer to integer for storing length of the recording minus all silence
1108  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
1109  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
1110  * \param path Optional filesystem path to unlock
1111  *
1112  * \retval -1 failure or hangup
1113  * \retval 'S' Recording ended from silence timeout
1114  * \retval 't' Recording ended from the message exceeding the maximum duration
1115  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
1116  */
1117 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);
1118
1119 /*!
1120  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
1121  *        This function will not play a success message due to post-recording control in the application this was added for.
1122  *
1123  * \param chan the channel being recorded
1124  * \param playfile Filename of sound to play before recording begins
1125  * \param recordfile Filename to save the recording
1126  * \param maxtime_sec Longest possible message length in seconds
1127  * \param fmt string containing all formats to be recorded delimited by '|'
1128  * \param duration pointer to integer for storing length of the recording
1129  * \param sound_duration pointer to integer for storing length of the recording minus all silence
1130  * \param beep whether to play a beep to prompt the recording
1131  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
1132  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
1133  *
1134  * \retval -1 failure or hangup
1135  * \retval 'S' Recording ended from silence timeout
1136  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
1137  */
1138 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);
1139
1140 enum ast_getdata_result {
1141         AST_GETDATA_FAILED = -1,
1142         AST_GETDATA_COMPLETE = 0,
1143         AST_GETDATA_TIMEOUT = 1,
1144         AST_GETDATA_INTERRUPTED = 2,
1145         /*! indicates a user terminated empty string rather than an empty string resulting
1146          * from a timeout or other factors */
1147         AST_GETDATA_EMPTY_END_TERMINATED = 3,
1148 };
1149
1150 enum AST_LOCK_RESULT {
1151         AST_LOCK_SUCCESS = 0,
1152         AST_LOCK_TIMEOUT = -1,
1153         AST_LOCK_PATH_NOT_FOUND = -2,
1154         AST_LOCK_FAILURE = -3,
1155 };
1156
1157 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
1158 enum AST_LOCK_TYPE {
1159         AST_LOCK_TYPE_LOCKFILE = 0,
1160         AST_LOCK_TYPE_FLOCK = 1,
1161 };
1162
1163 /*!
1164  * \brief Set the type of locks used by ast_lock_path()
1165  * \param type the locking type to use
1166  */
1167 void ast_set_lock_type(enum AST_LOCK_TYPE type);
1168
1169 /*!
1170  * \brief Lock a filesystem path.
1171  * \param path the path to be locked
1172  * \return one of \ref AST_LOCK_RESULT values
1173  */
1174 enum AST_LOCK_RESULT ast_lock_path(const char *path);
1175
1176 /*! \brief Unlock a path */
1177 int ast_unlock_path(const char *path);
1178
1179 /*! \brief Read a file into asterisk*/
1180 char *ast_read_textfile(const char *file);
1181
1182 struct ast_group_info;
1183
1184 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
1185 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
1186
1187 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
1188 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
1189
1190 /*! \brief Get the current channel count of the specified group and category. */
1191 int ast_app_group_get_count(const char *group, const char *category);
1192
1193 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
1194 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
1195
1196 /*! \brief Discard all group counting for a channel */
1197 int ast_app_group_discard(struct ast_channel *chan);
1198
1199 /*! \brief Update all group counting for a channel to a new one */
1200 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
1201
1202 /*! \brief Write Lock the group count list */
1203 int ast_app_group_list_wrlock(void);
1204
1205 /*! \brief Read Lock the group count list */
1206 int ast_app_group_list_rdlock(void);
1207
1208 /*! \brief Get the head of the group count list */
1209 struct ast_group_info *ast_app_group_list_head(void);
1210
1211 /*! \brief Unlock the group count list */
1212 int ast_app_group_list_unlock(void);
1213
1214 /*!
1215   \brief Define an application argument
1216   \param name The name of the argument
1217 */
1218 #define AST_APP_ARG(name) char *name
1219
1220 /*!
1221   \brief Declare a structure to hold an application's arguments.
1222   \param name The name of the structure
1223   \param arglist The list of arguments, defined using AST_APP_ARG
1224
1225   This macro declares a structure intended to be used in a call
1226   to ast_app_separate_args(). The structure includes all the
1227   arguments specified, plus an argv array that overlays them and an
1228   argc argument counter. The arguments must be declared using AST_APP_ARG,
1229   and they will all be character pointers (strings).
1230
1231   \note The structure is <b>not</b> initialized, as the call to
1232   ast_app_separate_args() will perform that function before parsing
1233   the arguments.
1234  */
1235 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(argtype_##name, arglist) name = { 0, }
1236
1237 /*!
1238   \brief Define a structure type to hold an application's arguments.
1239   \param type The name of the structure type
1240   \param arglist The list of arguments, defined using AST_APP_ARG
1241
1242   This macro defines a structure type intended to be used in a call
1243   to ast_app_separate_args(). The structure includes all the
1244   arguments specified, plus an argv array that overlays them and an
1245   argc argument counter. The arguments must be declared using AST_APP_ARG,
1246   and they will all be character pointers (strings).
1247
1248   \note This defines a structure type, but does not declare an instance
1249   of the structure. That must be done separately.
1250  */
1251
1252 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
1253         struct __subtype_##type { arglist }; \
1254         struct type { \
1255                 unsigned int argc; \
1256                 union { \
1257                         char *argv[sizeof(struct __subtype_##type) / sizeof(char*)]; \
1258                         struct { arglist }; \
1259                 }; \
1260         }
1261
1262 /*!
1263   \brief Performs the 'standard' argument separation process for an application.
1264   \param args An argument structure defined using AST_DECLARE_APP_ARGS
1265   \param parse A modifiable buffer containing the input to be parsed
1266
1267   This function will separate the input string using the standard argument
1268   separator character ',' and fill in the provided structure, including
1269   the argc argument counter field.
1270  */
1271 #define AST_STANDARD_APP_ARGS(args, parse) \
1272         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1273 #define AST_STANDARD_RAW_ARGS(args, parse) \
1274         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1275
1276 /*!
1277   \brief Performs the 'nonstandard' argument separation process for an application.
1278   \param args An argument structure defined using AST_DECLARE_APP_ARGS
1279   \param parse A modifiable buffer containing the input to be parsed
1280   \param sep A nonstandard separator character
1281
1282   This function will separate the input string using the nonstandard argument
1283   separator character and fill in the provided structure, including
1284   the argc argument counter field.
1285  */
1286 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
1287         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1288 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
1289         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
1290
1291 /*!
1292   \brief Separate a string into arguments in an array
1293   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
1294   \param delim The character to be used to delimit arguments
1295   \param remove_chars Remove backslashes and quote characters, while parsing
1296   \param array An array of 'char *' to be filled in with pointers to the found arguments
1297   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
1298
1299   Note: if there are more arguments in the string than the array will hold, the last element of
1300   the array will contain the remaining arguments, not separated.
1301
1302   The array will be completely zeroed by this function before it populates any entries.
1303
1304   \return The number of arguments found, or zero if the function arguments are not valid.
1305 */
1306 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
1307 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
1308
1309 /*!
1310   \brief A structure to hold the description of an application 'option'.
1311
1312   Application 'options' are single-character flags that can be supplied
1313   to the application to affect its behavior; they can also optionally
1314   accept arguments enclosed in parenthesis.
1315
1316   These structures are used by the ast_app_parse_options function, uses
1317   this data to fill in a flags structure (to indicate which options were
1318   supplied) and array of argument pointers (for those options that had
1319   arguments supplied).
1320  */
1321 struct ast_app_option {
1322         /*! \brief The flag bit that represents this option. */
1323         uint64_t flag;
1324         /*! \brief The index of the entry in the arguments array
1325           that should be used for this option's argument. */
1326         unsigned int arg_index;
1327 };
1328
1329 #define BEGIN_OPTIONS {
1330 #define END_OPTIONS }
1331
1332 /*!
1333   \brief Declares an array of options for an application.
1334   \param holder The name of the array to be created
1335   \param options The actual options to be placed into the array
1336   \sa ast_app_parse_options
1337
1338   This macro declares a 'static const' array of \c struct \c ast_option
1339   elements to hold the list of available options for an application.
1340   Each option must be declared using either the AST_APP_OPTION()
1341   or AST_APP_OPTION_ARG() macros.
1342
1343   Example usage:
1344   \code
1345   enum my_app_option_flags {
1346         OPT_JUMP = (1 << 0),
1347         OPT_BLAH = (1 << 1),
1348         OPT_BLORT = (1 << 2),
1349   };
1350
1351   enum my_app_option_args {
1352         OPT_ARG_BLAH = 0,
1353         OPT_ARG_BLORT,
1354         !! this entry tells how many possible arguments there are,
1355            and must be the last entry in the list
1356         OPT_ARG_ARRAY_SIZE,
1357   };
1358
1359   AST_APP_OPTIONS(my_app_options, {
1360         AST_APP_OPTION('j', OPT_JUMP),
1361         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
1362         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
1363   });
1364
1365   static int my_app_exec(struct ast_channel *chan, void *data)
1366   {
1367         char *options;
1368         struct ast_flags opts = { 0, };
1369         char *opt_args[OPT_ARG_ARRAY_SIZE];
1370
1371         ... do any argument parsing here ...
1372
1373         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
1374                 return -1;
1375         }
1376   }
1377   \endcode
1378  */
1379 #define AST_APP_OPTIONS(holder, options...) \
1380         static const struct ast_app_option holder[128] = options
1381
1382 /*!
1383   \brief Declares an application option that does not accept an argument.
1384   \param option The single character representing the option
1385   \param flagno The flag index to be set if this option is present
1386   \sa AST_APP_OPTIONS, ast_app_parse_options
1387  */
1388 #define AST_APP_OPTION(option, flagno) \
1389         [option] = { .flag = flagno }
1390
1391 /*!
1392   \brief Declares an application option that accepts an argument.
1393   \param option The single character representing the option
1394   \param flagno The flag index to be set if this option is present
1395   \param argno The index into the argument array where the argument should
1396   be placed
1397   \sa AST_APP_OPTIONS, ast_app_parse_options
1398  */
1399 #define AST_APP_OPTION_ARG(option, flagno, argno) \
1400         [option] = { .flag = flagno, .arg_index = argno + 1 }
1401
1402 /*!
1403   \brief Parses a string containing application options and sets flags/arguments.
1404   \param options The array of possible options declared with AST_APP_OPTIONS
1405   \param flags The flag structure to have option flags set
1406   \param args The array of argument pointers to hold arguments found
1407   \param optstr The string containing the options to be parsed
1408   \retval zero for success
1409   \retval non-zero if an error occurs
1410   \sa AST_APP_OPTIONS
1411  */
1412 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
1413
1414         /*!
1415   \brief Parses a string containing application options and sets flags/arguments.
1416   \param options The array of possible options declared with AST_APP_OPTIONS
1417   \param flags The 64-bit flag structure to have option flags set
1418   \param args The array of argument pointers to hold arguments found
1419   \param optstr The string containing the options to be parsed
1420   \retval zero for success
1421   \retval non-zero if an error occurs
1422   \sa AST_APP_OPTIONS
1423  */
1424 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
1425
1426 /*! \brief Given a list of options array, return an option string based on passed flags
1427         \param options The array of possible options declared with AST_APP_OPTIONS
1428         \param flags The flags of the options that you wish to populate the buffer with
1429         \param buf The buffer to fill with the string of options
1430         \param len The maximum length of buf
1431 */
1432 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
1433
1434 /*! \brief Present a dialtone and collect a certain length extension.
1435     \retval 1 if extension exists
1436     \retval 0 if extension does not exist
1437     \retval -1 on hangup
1438 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
1439 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
1440
1441 /*! \brief Allow to record message and have a review option */
1442 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
1443
1444 /*!
1445  * \brief Decode an encoded control or extended ASCII character
1446  * \param[in] stream String to decode
1447  * \param[out] result Decoded character
1448  * \param[out] consumed Number of characters used in stream to encode the character
1449  * \retval -1 Stream is of zero length
1450  * \retval 0 Success
1451  */
1452 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
1453
1454 /*!
1455  * \brief Decode a stream of encoded control or extended ASCII characters
1456  * \param[in] stream Encoded string
1457  * \param[out] result Decoded string
1458  * \param[in] result_len Maximum size of the result buffer
1459  * \return A pointer to the result string
1460  */
1461 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
1462
1463 /*! \brief Decode a stream of encoded control or extended ASCII characters */
1464 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
1465
1466 /*!
1467  * \brief Common routine for child processes, to close all fds prior to exec(2)
1468  * \param[in] n starting file descriptor number for closing all higher file descriptors
1469  * \since 1.6.1
1470  */
1471 void ast_close_fds_above_n(int n);
1472
1473 /*!
1474  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
1475  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
1476  * \since 1.6.1
1477  */
1478 int ast_safe_fork(int stop_reaper);
1479
1480 /*!
1481  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
1482  * \since 1.6.1
1483  */
1484 void ast_safe_fork_cleanup(void);
1485
1486 /*!
1487  * \brief Common routine to parse time lengths, with optional time unit specifier
1488  * \param[in] timestr String to parse
1489  * \param[in] defunit Default unit type
1490  * \param[out] result Resulting value, specified in milliseconds
1491  * \retval 0 Success
1492  * \retval -1 Failure
1493  * \since 1.8
1494  */
1495 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
1496
1497 /*!
1498  * \brief Get the \ref stasis topic for queue messages
1499  * \return The topic structure for queue messages
1500  * \retval NULL if it has not been allocated
1501  * \since 12
1502  */
1503 struct stasis_topic *ast_queue_topic_all(void);
1504
1505 /*!
1506  * \brief Get the \ref stasis topic for queue messages for a particular queue name
1507  * \param queuename The name for which to get the topic
1508  * \return The topic structure for queue messages for a given name
1509  * \retval NULL if it failed to be found or allocated
1510  * \since 12
1511  */
1512 struct stasis_topic *ast_queue_topic(const char *queuename);
1513 /*! @} */
1514
1515 /*!
1516  * \brief Initialize the application core
1517  * \retval 0 Success
1518  * \retval -1 Failure
1519  * \since 12
1520  */
1521 int app_init(void);
1522
1523 #if defined(__cplusplus) || defined(c_plusplus)
1524 }
1525 #endif
1526
1527 #endif /* _ASTERISK_APP_H */