A lot of doxygen updates
[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 struct ast_flags64;
27
28 #if defined(__cplusplus) || defined(c_plusplus)
29 extern "C" {
30 #endif
31
32 /* IVR stuff */
33
34 /*! \brief Callback function for IVR
35     \return returns 0 on completion, -1 on hangup or digit if interrupted 
36   */
37 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
38
39 typedef enum {
40         AST_ACTION_UPONE,       /*!< adata is unused */
41         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
42         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
43         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
44         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
45         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
46         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
47         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
48         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
49         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
50         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
51         AST_ACTION_NOOP,        /*!< adata is unused */
52         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
53 } ast_ivr_action;
54
55 /*! 
56     Special "options" are: 
57    \arg "s" - "start here (one time greeting)"
58    \arg "g" - "greeting/instructions"
59    \arg "t" - "timeout"
60    \arg "h" - "hangup"
61    \arg "i" - "invalid selection"
62
63 */
64 struct ast_ivr_option {
65         char *option;
66         ast_ivr_action action;
67         void *adata;    
68 };
69
70 struct ast_ivr_menu {
71         char *title;            /*!< Title of menu */
72         unsigned int flags;     /*!< Flags */
73         struct ast_ivr_option *options; /*!< All options */
74 };
75
76 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
77
78 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
79         static struct ast_ivr_option __options_##holder[] = foo;\
80         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
81         
82
83 /*!     \brief Runs an IVR menu 
84         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
85 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
86
87 /*! \brief Plays a stream and gets DTMF data from a channel 
88  * \param c Which channel one is interacting with
89  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
90  *        It is also valid for this to be multiple files concatenated by "&".
91  *        For example, "file1&file2&file3".
92  * \param s The location where the DTMF data will be stored
93  * \param maxlen Max Length of the data
94  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
95  *
96  *  This function was designed for application programmers for situations where they need 
97  *  to play a message and then get some DTMF data in response to the message.  If a digit 
98  *  is pressed during playback, it will immediately break out of the message and continue
99  *  execution of your code.
100  */
101 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
102
103 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
104 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
105
106 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
107                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
108                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder));
109   
110 void ast_uninstall_vm_functions(void);
111
112 /*! \brief Determine if a given mailbox has any voicemail */
113 int ast_app_has_voicemail(const char *mailbox, const char *folder);
114
115 /*! \brief Determine number of new/old messages in a mailbox */
116 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
117
118 /*! \brief Determine number of messages in a given mailbox and folder */
119 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
120
121 /*! \brief Safely spawn an external program while closing file descriptors 
122         \note This replaces the \b system call in all Asterisk modules
123 */
124 int ast_safe_system(const char *s);
125
126 /*!
127  * \brief Replace the SIGCHLD handler
128  *
129  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
130  * processes from forking elsewhere in Asterisk.  However, if you want to
131  * wait*() on the process to retrieve information about it's exit status,
132  * then this signal handler needs to be temporarily replaced.
133  *
134  * Code that executes this function *must* call ast_unreplace_sigchld()
135  * after it is finished doing the wait*().
136  */
137 void ast_replace_sigchld(void);
138
139 /*!
140  * \brief Restore the SIGCHLD handler
141  *
142  * This function is called after a call to ast_replace_sigchld.  It restores
143  * the SIGCHLD handler that cleans up any zombie processes.
144  */
145 void ast_unreplace_sigchld(void);
146
147 /*!
148   \brief Send DTMF to a channel
149
150   \param chan    The channel that will receive the DTMF frames
151   \param peer    (optional) Peer channel that will be autoserviced while the
152                  primary channel is receiving DTMF
153   \param digits  This is a string of characters representing the DTMF digits
154                  to be sent to the channel.  Valid characters are
155                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
156                  'F', if you want to Flash the channel (if supported by the
157                  channel), or 'w' to add a 500 millisecond pause to the DTMF
158                  sequence.
159   \param between This is the number of milliseconds to wait in between each
160                  DTMF digit.  If zero milliseconds is specified, then the
161                  default value of 100 will be used.
162   \param duration This is the duration that each DTMF digit should have.
163 */
164 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
165
166 /*! \brief Stream a filename (or file descriptor) as a generator. */
167 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
168
169 /*! 
170  * \brief Stream a file with fast forward, pause, reverse, restart. 
171  * \param chan 
172  * \param file filename
173  * \param fwd, rev, stop, pause, restart, skipms, offsetms 
174  *
175  * Before calling this function, set this to be the number 
176  * of ms to start from the beginning of the file.  When the function
177  * returns, it will be the number of ms from the beginning where the
178  * playback stopped.  Pass NULL if you don't care.
179  */
180 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);
181
182 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
183 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
184
185 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 silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
186
187 /*! \brief Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum 
188  \n
189  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
190      calls ast_unlock_path() on 'path' if passed */
191 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path);
192
193 /*! \brief Record a message and prepend the message to the given record file after 
194     playing the optional playfile (or a beep), storing the duration in 
195     'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 
196     'silencethreshold' or use '-1' for either or both parameters for defaults. */
197 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int beep, int silencethreshold, int maxsilence_ms);
198
199 enum AST_LOCK_RESULT {
200         AST_LOCK_SUCCESS = 0,
201         AST_LOCK_TIMEOUT = -1,
202         AST_LOCK_PATH_NOT_FOUND = -2,
203         AST_LOCK_FAILURE = -3,
204 };
205
206 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
207 enum AST_LOCK_TYPE {
208         AST_LOCK_TYPE_LOCKFILE = 0,
209         AST_LOCK_TYPE_FLOCK = 1,
210 };
211
212 /*!
213  * \brief Set the type of locks used by ast_lock_path()
214  * \param type the locking type to use
215  */
216 void ast_set_lock_type(enum AST_LOCK_TYPE type);
217
218 /*!
219  * \brief Lock a filesystem path.
220  * \param path the path to be locked
221  * \return one of \ref AST_LOCK_RESULT values
222  */
223 enum AST_LOCK_RESULT ast_lock_path(const char *path);
224
225 /*! \brief Unlock a path */
226 int ast_unlock_path(const char *path);
227
228 /*! \brief Read a file into asterisk*/
229 char *ast_read_textfile(const char *file);
230
231 struct ast_group_info;
232
233 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
234 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
235
236 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
237 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
238
239 /*! \brief Get the current channel count of the specified group and category. */
240 int ast_app_group_get_count(const char *group, const char *category);
241
242 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
243 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
244
245 /*! \brief Discard all group counting for a channel */
246 int ast_app_group_discard(struct ast_channel *chan);
247
248 /*! \brief Update all group counting for a channel to a new one */
249 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
250
251 /*! \brief Write Lock the group count list */
252 int ast_app_group_list_wrlock(void);
253
254 /*! \brief Read Lock the group count list */
255 int ast_app_group_list_rdlock(void);
256
257 /*! \brief Get the head of the group count list */
258 struct ast_group_info *ast_app_group_list_head(void);
259
260 /*! \brief Unlock the group count list */
261 int ast_app_group_list_unlock(void);
262
263 /*!
264   \brief Define an application argument
265   \param name The name of the argument
266 */
267 #define AST_APP_ARG(name) char *name
268
269 /*!
270   \brief Declare a structure to hold the application's arguments.
271   \param name The name of the structure
272   \param arglist The list of arguments, defined using AST_APP_ARG
273
274   This macro defines a structure intended to be used in a call
275   to ast_app_separate_args(). The structure includes all the
276   arguments specified, plus an argv array that overlays them and an
277   argc argument counter. The arguments must be declared using AST_APP_ARG,
278   and they will all be character pointers (strings).
279
280   \note The structure is <b>not</b> initialized, as the call to
281   ast_app_separate_args() will perform that function before parsing
282   the arguments.
283  */
284 #define AST_DECLARE_APP_ARGS(name, arglist) \
285         struct { \
286                 unsigned int argc; \
287                 char *argv[0]; \
288                 arglist \
289         } name
290
291 /*!
292   \brief Performs the 'standard' argument separation process for an application.
293   \param args An argument structure defined using AST_DECLARE_APP_ARGS
294   \param parse A modifiable buffer containing the input to be parsed
295
296   This function will separate the input string using the standard argument
297   separator character '|' and fill in the provided structure, including
298   the argc argument counter field.
299  */
300 #define AST_STANDARD_APP_ARGS(args, parse) \
301         args.argc = ast_app_separate_args(parse, ',', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
302         
303 /*!
304   \brief Performs the 'nonstandard' argument separation process for an application.
305   \param args An argument structure defined using AST_DECLARE_APP_ARGS
306   \param parse A modifiable buffer containing the input to be parsed
307   \param sep A nonstandard separator character
308
309   This function will separate the input string using the nonstandard argument
310   separator character and fill in the provided structure, including
311   the argc argument counter field.
312  */
313 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
314         args.argc = ast_app_separate_args(parse, sep, args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
315         
316 /*!
317   \brief Separate a string into arguments in an array
318   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
319   \param delim The character to be used to delimit arguments
320   \param array An array of 'char *' to be filled in with pointers to the found arguments
321   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
322
323   Note: if there are more arguments in the string than the array will hold, the last element of
324   the array will contain the remaining arguments, not separated.
325
326   The array will be completely zeroed by this function before it populates any entries.
327
328   \return The number of arguments found, or zero if the function arguments are not valid.
329 */
330 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
331
332 /*!
333   \brief A structure to hold the description of an application 'option'.
334
335   Application 'options' are single-character flags that can be supplied
336   to the application to affect its behavior; they can also optionally
337   accept arguments enclosed in parenthesis.
338
339   These structures are used by the ast_app_parse_options function, uses
340   this data to fill in a flags structure (to indicate which options were
341   supplied) and array of argument pointers (for those options that had
342   arguments supplied).
343  */
344 struct ast_app_option {
345         /*! \brief The flag bit that represents this option. */
346         uint64_t flag;
347         /*! \brief The index of the entry in the arguments array
348           that should be used for this option's argument. */
349         unsigned int arg_index;
350 };
351
352 #define BEGIN_OPTIONS {
353 #define END_OPTIONS }
354
355 /*!
356   \brief Declares an array of options for an application.
357   \param holder The name of the array to be created
358   \param options The actual options to be placed into the array
359   \sa ast_app_parse_options
360
361   This macro declares a 'static const' array of \c struct \c ast_option
362   elements to hold the list of available options for an application.
363   Each option must be declared using either the AST_APP_OPTION()
364   or AST_APP_OPTION_ARG() macros.
365
366   Example usage:
367   \code
368   enum {
369         OPT_JUMP = (1 << 0),
370         OPT_BLAH = (1 << 1),
371         OPT_BLORT = (1 << 2),
372   } my_app_option_flags;
373
374   enum {
375         OPT_ARG_BLAH = 0,
376         OPT_ARG_BLORT,
377         !! this entry tells how many possible arguments there are,
378            and must be the last entry in the list
379         OPT_ARG_ARRAY_SIZE,
380   } my_app_option_args;
381
382   AST_APP_OPTIONS(my_app_options, {
383         AST_APP_OPTION('j', OPT_JUMP),
384         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
385         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
386   });
387
388   static int my_app_exec(struct ast_channel *chan, void *data)
389   {
390         char *options;
391         struct ast_flags opts = { 0, };
392         char *opt_args[OPT_ARG_ARRAY_SIZE];
393
394         ... do any argument parsing here ...
395
396         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
397                 LOCAL_USER_REMOVE(u);
398                 return -1;
399         }
400   }
401   \endcode
402  */
403 #define AST_APP_OPTIONS(holder, options...) \
404         static const struct ast_app_option holder[128] = options
405
406 /*!
407   \brief Declares an application option that does not accept an argument.
408   \param option The single character representing the option
409   \param flagno The flag index to be set if this option is present
410   \sa AST_APP_OPTIONS, ast_app_parse_options
411  */
412 #define AST_APP_OPTION(option, flagno) \
413         [option] = { .flag = flagno }
414
415 /*!
416   \brief Declares an application option that accepts an argument.
417   \param option The single character representing the option
418   \param flagno The flag index to be set if this option is present
419   \param argno The index into the argument array where the argument should
420   be placed
421   \sa AST_APP_OPTIONS, ast_app_parse_options
422  */
423 #define AST_APP_OPTION_ARG(option, flagno, argno) \
424         [option] = { .flag = flagno, .arg_index = argno + 1 }
425
426 /*!
427   \brief Parses a string containing application options and sets flags/arguments.
428   \param options The array of possible options declared with AST_APP_OPTIONS
429   \param flags The flag structure to have option flags set
430   \param args The array of argument pointers to hold arguments found
431   \param optstr The string containing the options to be parsed
432   \return zero for success, non-zero if an error occurs
433   \sa AST_APP_OPTIONS
434  */
435 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
436
437         /*!
438   \brief Parses a string containing application options and sets flags/arguments.
439   \param options The array of possible options declared with AST_APP_OPTIONS
440   \param flags The 64-bit flag structure to have option flags set
441   \param args The array of argument pointers to hold arguments found
442   \param optstr The string containing the options to be parsed
443   \return zero for success, non-zero if an error occurs
444   \sa AST_APP_OPTIONS
445  */
446 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
447
448 /*! \brief Present a dialtone and collect a certain length extension. 
449     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 
450 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
451 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
452
453 /*! \brief Allow to record message and have a review option */
454 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
455
456 /*! \brief Decode an encoded control or extended ASCII character */
457 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
458
459 #if defined(__cplusplus) || defined(c_plusplus)
460 }
461 #endif
462
463 #endif /* _ASTERISK_APP_H */