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