fc763d5f0d032ddae2bd719d6279d2e0551dc320
[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 */
161 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between);
162
163 /*! Stream a filename (or file descriptor) as a generator. */
164 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
165
166 /*! 
167  * \brief Stream a file with fast forward, pause, reverse, restart. 
168  * \param offsetms Before calling this function, set this to be the number 
169  *        of ms to start from the beginning of the file.  When the function
170  *        returns, it will be the number of ms from the beginning where the
171  *        playback stopped.  Pass NULL if you don't care.
172  */
173 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);
174
175 /*! Play a stream and wait for a digit, returning the digit that was pressed */
176 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
177
178 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);
179
180 /*! 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 
181  \n
182  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
183      calls ast_unlock_path() on 'path' if passed */
184 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);
185
186 /*! Record a message and prepend the message to the given record file after 
187     playing the optional playfile (or a beep), storing the duration in 
188     'duration' and with a maximum  
189 \n
190   permitted silence time in milliseconds of 'maxsilence' under 
191   'silencethreshold' or use '-1' for either or both parameters for defaults. */
192 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);
193
194 enum AST_LOCK_RESULT {
195         AST_LOCK_SUCCESS = 0,
196         AST_LOCK_TIMEOUT = -1,
197         AST_LOCK_PATH_NOT_FOUND = -2,
198         AST_LOCK_FAILURE = -3,
199 };
200
201 /*!
202  * \brief Lock a filesystem path.
203  * \param path the path to be locked
204  * \return one of \ref AST_LOCK_RESULT values
205  */
206 enum AST_LOCK_RESULT ast_lock_path(const char *path);
207
208 /*! Unlock a path */
209 int ast_unlock_path(const char *path);
210
211 /*! Read a file into asterisk*/
212 char *ast_read_textfile(const char *file);
213
214 struct ast_group_info {
215         struct ast_channel *chan;
216         char *category;
217         char *group;
218         AST_LIST_ENTRY(ast_group_info) list;
219 };
220
221 /*! Split a group string into group and category, returning a default category if none is provided. */
222 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
223
224 /*! Set the group for a channel, splitting the provided data into group and category, if specified. */
225 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
226
227 /*! Get the current channel count of the specified group and category. */
228 int ast_app_group_get_count(const char *group, const char *category);
229
230 /*! Get the current channel count of all groups that match the specified pattern and category. */
231 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
232
233 /*! Discard all group counting for a channel */
234 int ast_app_group_discard(struct ast_channel *chan);
235
236 /*! Update all group counting for a channel to a new one */
237 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
238
239 /*! Write Lock the group count list */
240 int ast_app_group_list_wrlock(void);
241
242 /*! Read Lock the group count list */
243 int ast_app_group_list_rdlock(void);
244
245 /*! Get the head of the group count list */
246 struct ast_group_info *ast_app_group_list_head(void);
247
248 /*! Unlock the group count list */
249 int ast_app_group_list_unlock(void);
250
251 /*!
252   \brief Define an application argument
253   \param name The name of the argument
254 */
255 #define AST_APP_ARG(name) char *name
256
257 /*!
258   \brief Declare a structure to hold the application's arguments.
259   \param name The name of the structure
260   \param arglist The list of arguments, defined using AST_APP_ARG
261
262   This macro defines a structure intended to be used in a call
263   to ast_app_separate_args(). The structure includes all the
264   arguments specified, plus an argv array that overlays them and an
265   argc argument counter. The arguments must be declared using AST_APP_ARG,
266   and they will all be character pointers (strings).
267
268   \note The structure is <b>not</b> initialized, as the call to
269   ast_app_separate_args() will perform that function before parsing
270   the arguments.
271  */
272 #define AST_DECLARE_APP_ARGS(name, arglist) \
273         struct { \
274                 unsigned int argc; \
275                 char *argv[0]; \
276                 arglist \
277         } name
278
279 /*!
280   \brief Performs the 'standard' argument separation process for an application.
281   \param args An argument structure defined using AST_DECLARE_APP_ARGS
282   \param parse A modifiable buffer containing the input to be parsed
283
284   This function will separate the input string using the standard argument
285   separator character '|' and fill in the provided structure, including
286   the argc argument counter field.
287  */
288 #define AST_STANDARD_APP_ARGS(args, parse) \
289         args.argc = ast_app_separate_args(parse, '|', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
290         
291 /*!
292   \brief Performs the 'nonstandard' 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   \param sep A nonstandard separator character
296
297   This function will separate the input string using the nonstandard argument
298   separator character and fill in the provided structure, including
299   the argc argument counter field.
300  */
301 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
302         args.argc = ast_app_separate_args(parse, sep, args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
303         
304 /*!
305   \brief Separate a string into arguments in an array
306   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
307   \param delim The character to be used to delimit arguments
308   \param array An array of 'char *' to be filled in with pointers to the found arguments
309   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
310
311   Note: if there are more arguments in the string than the array will hold, the last element of
312   the array will contain the remaining arguments, not separated.
313
314   The array will be completely zeroed by this function before it populates any entries.
315
316   \return The number of arguments found, or zero if the function arguments are not valid.
317 */
318 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
319
320 /*!
321   \brief A structure to hold the description of an application 'option'.
322
323   Application 'options' are single-character flags that can be supplied
324   to the application to affect its behavior; they can also optionally
325   accept arguments enclosed in parenthesis.
326
327   These structures are used by the ast_app_parse_options function, uses
328   this data to fill in a flags structure (to indicate which options were
329   supplied) and array of argument pointers (for those options that had
330   arguments supplied).
331  */
332 struct ast_app_option {
333         /*! \brief The flag bit that represents this option. */
334         unsigned int flag;
335         /*! \brief The index of the entry in the arguments array
336           that should be used for this option's argument. */
337         unsigned int arg_index;
338 };
339
340 #define BEGIN_OPTIONS {
341 #define END_OPTIONS }
342
343 /*!
344   \brief Declares an array of options for an application.
345   \param holder The name of the array to be created
346   \param options The actual options to be placed into the array
347   \sa ast_app_parse_options
348
349   This macro declares a 'static const' array of \c struct \c ast_option
350   elements to hold the list of available options for an application.
351   Each option must be declared using either the AST_APP_OPTION()
352   or AST_APP_OPTION_ARG() macros.
353
354   Example usage:
355   \code
356   enum {
357         OPT_JUMP = (1 << 0),
358         OPT_BLAH = (1 << 1),
359         OPT_BLORT = (1 << 2),
360   } my_app_option_flags;
361
362   enum {
363         OPT_ARG_BLAH = 0,
364         OPT_ARG_BLORT,
365         !! this entry tells how many possible arguments there are,
366            and must be the last entry in the list
367         OPT_ARG_ARRAY_SIZE,
368   } my_app_option_args;
369
370   AST_APP_OPTIONS(my_app_options, {
371         AST_APP_OPTION('j', OPT_JUMP),
372         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
373         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
374   });
375
376   static int my_app_exec(struct ast_channel *chan, void *data)
377   {
378         char *options;
379         struct ast_flags opts = { 0, };
380         char *opt_args[OPT_ARG_ARRAY_SIZE];
381
382         ... do any argument parsing here ...
383
384         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
385                 LOCAL_USER_REMOVE(u);
386                 return -1;
387         }
388   }
389   \endcode
390  */
391 #define AST_APP_OPTIONS(holder, options...) \
392         static const struct ast_app_option holder[128] = options
393
394 /*!
395   \brief Declares an application option that does not accept an argument.
396   \param option The single character representing the option
397   \param flagno The flag index to be set if this option is present
398   \sa AST_APP_OPTIONS, ast_app_parse_options
399  */
400 #define AST_APP_OPTION(option, flagno) \
401         [option] = { .flag = flagno }
402
403 /*!
404   \brief Declares an application option that accepts an argument.
405   \param option The single character representing the option
406   \param flagno The flag index to be set if this option is present
407   \param argno The index into the argument array where the argument should
408   be placed
409   \sa AST_APP_OPTIONS, ast_app_parse_options
410  */
411 #define AST_APP_OPTION_ARG(option, flagno, argno) \
412         [option] = { .flag = flagno, .arg_index = argno + 1 }
413
414 /*!
415   \brief Parses a string containing application options and sets flags/arguments.
416   \param options The array of possible options declared with AST_APP_OPTIONS
417   \param flags The flag structure to have option flags set
418   \param args The array of argument pointers to hold arguments found
419   \param optstr The string containing the options to be parsed
420   \return zero for success, non-zero if an error occurs
421   \sa AST_APP_OPTIONS
422  */
423 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
424
425 /*! \brief Present a dialtone and collect a certain length extension. 
426     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 
427 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
428 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
429
430 /*! Allow to record message and have a review option */
431 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
432
433 #if defined(__cplusplus) || defined(c_plusplus)
434 }
435 #endif
436
437 #endif /* _ASTERISK_APP_H */