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