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