Keep ast_app_inboxcount API compatible with 1.6.0.
[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 (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
109                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
110                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context));
111
112 void ast_uninstall_vm_functions(void);
113
114 /*! \brief Determine if a given mailbox has any voicemail */
115 int ast_app_has_voicemail(const char *mailbox, const char *folder);
116
117 /*! \brief Determine number of new/old messages in a mailbox */
118 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
119
120 /*! \brief Determine number of urgent/new/old messages in a mailbox */
121 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
122
123 /*! Given a mailbox and context, play that mailbox owner's name to the channel specified */
124 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
125
126 /*! \brief Determine number of messages in a given mailbox and folder */
127 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
128
129 /*! \brief Safely spawn an external program while closing file descriptors 
130         \note This replaces the \b system call in all Asterisk modules
131 */
132 int ast_safe_system(const char *s);
133
134 /*!
135  * \brief Replace the SIGCHLD handler
136  *
137  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
138  * processes from forking elsewhere in Asterisk.  However, if you want to
139  * wait*() on the process to retrieve information about it's exit status,
140  * then this signal handler needs to be temporarily replaced.
141  *
142  * Code that executes this function *must* call ast_unreplace_sigchld()
143  * after it is finished doing the wait*().
144  */
145 void ast_replace_sigchld(void);
146
147 /*!
148  * \brief Restore the SIGCHLD handler
149  *
150  * This function is called after a call to ast_replace_sigchld.  It restores
151  * the SIGCHLD handler that cleans up any zombie processes.
152  */
153 void ast_unreplace_sigchld(void);
154
155 /*!
156   \brief Send DTMF to a channel
157
158   \param chan    The channel that will receive the DTMF frames
159   \param peer    (optional) Peer channel that will be autoserviced while the
160                  primary channel is receiving DTMF
161   \param digits  This is a string of characters representing the DTMF digits
162                  to be sent to the channel.  Valid characters are
163                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
164                  'F', if you want to Flash the channel (if supported by the
165                  channel), or 'w' to add a 500 millisecond pause to the DTMF
166                  sequence.
167   \param between This is the number of milliseconds to wait in between each
168                  DTMF digit.  If zero milliseconds is specified, then the
169                  default value of 100 will be used.
170   \param duration This is the duration that each DTMF digit should have.
171 */
172 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
173
174 /*! \brief Stream a filename (or file descriptor) as a generator. */
175 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
176
177 /*! 
178  * \brief Stream a file with fast forward, pause, reverse, restart. 
179  * \param chan 
180  * \param file filename
181  * \param fwd, rev, stop, pause, restart, skipms, offsetms 
182  *
183  * Before calling this function, set this to be the number 
184  * of ms to start from the beginning of the file.  When the function
185  * returns, it will be the number of ms from the beginning where the
186  * playback stopped.  Pass NULL if you don't care.
187  */
188 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);
189
190 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
191 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
192
193 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);
194
195 /*! \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 
196  \n
197  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
198      calls ast_unlock_path() on 'path' if passed */
199 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);
200
201 /*! \brief Record a message and prepend the message to the given record file after 
202     playing the optional playfile (or a beep), storing the duration in 
203     'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 
204     'silencethreshold' or use '-1' for either or both parameters for defaults. */
205 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);
206
207 enum AST_LOCK_RESULT {
208         AST_LOCK_SUCCESS = 0,
209         AST_LOCK_TIMEOUT = -1,
210         AST_LOCK_PATH_NOT_FOUND = -2,
211         AST_LOCK_FAILURE = -3,
212 };
213
214 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
215 enum AST_LOCK_TYPE {
216         AST_LOCK_TYPE_LOCKFILE = 0,
217         AST_LOCK_TYPE_FLOCK = 1,
218 };
219
220 /*!
221  * \brief Set the type of locks used by ast_lock_path()
222  * \param type the locking type to use
223  */
224 void ast_set_lock_type(enum AST_LOCK_TYPE type);
225
226 /*!
227  * \brief Lock a filesystem path.
228  * \param path the path to be locked
229  * \return one of \ref AST_LOCK_RESULT values
230  */
231 enum AST_LOCK_RESULT ast_lock_path(const char *path);
232
233 /*! \brief Unlock a path */
234 int ast_unlock_path(const char *path);
235
236 /*! \brief Read a file into asterisk*/
237 char *ast_read_textfile(const char *file);
238
239 struct ast_group_info;
240
241 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
242 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
243
244 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
245 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
246
247 /*! \brief Get the current channel count of the specified group and category. */
248 int ast_app_group_get_count(const char *group, const char *category);
249
250 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
251 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
252
253 /*! \brief Discard all group counting for a channel */
254 int ast_app_group_discard(struct ast_channel *chan);
255
256 /*! \brief Update all group counting for a channel to a new one */
257 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
258
259 /*! \brief Write Lock the group count list */
260 int ast_app_group_list_wrlock(void);
261
262 /*! \brief Read Lock the group count list */
263 int ast_app_group_list_rdlock(void);
264
265 /*! \brief Get the head of the group count list */
266 struct ast_group_info *ast_app_group_list_head(void);
267
268 /*! \brief Unlock the group count list */
269 int ast_app_group_list_unlock(void);
270
271 /*!
272   \brief Define an application argument
273   \param name The name of the argument
274 */
275 #define AST_APP_ARG(name) char *name
276
277 /*!
278   \brief Declare a structure to hold an application's arguments.
279   \param name The name of the structure
280   \param arglist The list of arguments, defined using AST_APP_ARG
281
282   This macro declares a structure intended to be used in a call
283   to ast_app_separate_args(). The structure includes all the
284   arguments specified, plus an argv array that overlays them and an
285   argc argument counter. The arguments must be declared using AST_APP_ARG,
286   and they will all be character pointers (strings).
287
288   \note The structure is <b>not</b> initialized, as the call to
289   ast_app_separate_args() will perform that function before parsing
290   the arguments.
291  */
292 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name
293
294 /*!
295   \brief Define a structure type to hold an application's arguments.
296   \param type The name of the structure type
297   \param arglist The list of arguments, defined using AST_APP_ARG
298
299   This macro defines a structure type intended to be used in a call
300   to ast_app_separate_args(). The structure includes all the
301   arguments specified, plus an argv array that overlays them and an
302   argc argument counter. The arguments must be declared using AST_APP_ARG,
303   and they will all be character pointers (strings).
304
305   \note This defines a structure type, but does not declare an instance
306   of the structure. That must be done separately.
307  */
308 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
309         struct type { \
310                 unsigned int argc; \
311                 char *argv[0]; \
312                 arglist \
313         }
314
315 /*!
316   \brief Performs the 'standard' argument separation process for an application.
317   \param args An argument structure defined using AST_DECLARE_APP_ARGS
318   \param parse A modifiable buffer containing the input to be parsed
319
320   This function will separate the input string using the standard argument
321   separator character ',' and fill in the provided structure, including
322   the argc argument counter field.
323  */
324 #define AST_STANDARD_APP_ARGS(args, parse) \
325         args.argc = ast_app_separate_args(parse, ',', args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
326         
327 /*!
328   \brief Performs the 'nonstandard' argument separation process for an application.
329   \param args An argument structure defined using AST_DECLARE_APP_ARGS
330   \param parse A modifiable buffer containing the input to be parsed
331   \param sep A nonstandard separator character
332
333   This function will separate the input string using the nonstandard argument
334   separator character and fill in the provided structure, including
335   the argc argument counter field.
336  */
337 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
338         args.argc = ast_app_separate_args(parse, sep, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
339         
340 /*!
341   \brief Separate a string into arguments in an array
342   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
343   \param delim The character to be used to delimit arguments
344   \param array An array of 'char *' to be filled in with pointers to the found arguments
345   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
346
347   Note: if there are more arguments in the string than the array will hold, the last element of
348   the array will contain the remaining arguments, not separated.
349
350   The array will be completely zeroed by this function before it populates any entries.
351
352   \return The number of arguments found, or zero if the function arguments are not valid.
353 */
354 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
355
356 /*!
357   \brief A structure to hold the description of an application 'option'.
358
359   Application 'options' are single-character flags that can be supplied
360   to the application to affect its behavior; they can also optionally
361   accept arguments enclosed in parenthesis.
362
363   These structures are used by the ast_app_parse_options function, uses
364   this data to fill in a flags structure (to indicate which options were
365   supplied) and array of argument pointers (for those options that had
366   arguments supplied).
367  */
368 struct ast_app_option {
369         /*! \brief The flag bit that represents this option. */
370         uint64_t flag;
371         /*! \brief The index of the entry in the arguments array
372           that should be used for this option's argument. */
373         unsigned int arg_index;
374 };
375
376 #define BEGIN_OPTIONS {
377 #define END_OPTIONS }
378
379 /*!
380   \brief Declares an array of options for an application.
381   \param holder The name of the array to be created
382   \param options The actual options to be placed into the array
383   \sa ast_app_parse_options
384
385   This macro declares a 'static const' array of \c struct \c ast_option
386   elements to hold the list of available options for an application.
387   Each option must be declared using either the AST_APP_OPTION()
388   or AST_APP_OPTION_ARG() macros.
389
390   Example usage:
391   \code
392   enum {
393         OPT_JUMP = (1 << 0),
394         OPT_BLAH = (1 << 1),
395         OPT_BLORT = (1 << 2),
396   } my_app_option_flags;
397
398   enum {
399         OPT_ARG_BLAH = 0,
400         OPT_ARG_BLORT,
401         !! this entry tells how many possible arguments there are,
402            and must be the last entry in the list
403         OPT_ARG_ARRAY_SIZE,
404   } my_app_option_args;
405
406   AST_APP_OPTIONS(my_app_options, {
407         AST_APP_OPTION('j', OPT_JUMP),
408         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
409         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
410   });
411
412   static int my_app_exec(struct ast_channel *chan, void *data)
413   {
414         char *options;
415         struct ast_flags opts = { 0, };
416         char *opt_args[OPT_ARG_ARRAY_SIZE];
417
418         ... do any argument parsing here ...
419
420         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
421                 ast_module_user_remove(u);
422                 return -1;
423         }
424   }
425   \endcode
426  */
427 #define AST_APP_OPTIONS(holder, options...) \
428         static const struct ast_app_option holder[128] = options
429
430 /*!
431   \brief Declares an application option that does not accept an argument.
432   \param option The single character representing the option
433   \param flagno The flag index to be set if this option is present
434   \sa AST_APP_OPTIONS, ast_app_parse_options
435  */
436 #define AST_APP_OPTION(option, flagno) \
437         [option] = { .flag = flagno }
438
439 /*!
440   \brief Declares an application option that accepts an argument.
441   \param option The single character representing the option
442   \param flagno The flag index to be set if this option is present
443   \param argno The index into the argument array where the argument should
444   be placed
445   \sa AST_APP_OPTIONS, ast_app_parse_options
446  */
447 #define AST_APP_OPTION_ARG(option, flagno, argno) \
448         [option] = { .flag = flagno, .arg_index = argno + 1 }
449
450 /*!
451   \brief Parses a string containing application options and sets flags/arguments.
452   \param options The array of possible options declared with AST_APP_OPTIONS
453   \param flags The flag structure to have option flags set
454   \param args The array of argument pointers to hold arguments found
455   \param optstr The string containing the options to be parsed
456   \return zero for success, non-zero if an error occurs
457   \sa AST_APP_OPTIONS
458  */
459 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
460
461         /*!
462   \brief Parses a string containing application options and sets flags/arguments.
463   \param options The array of possible options declared with AST_APP_OPTIONS
464   \param flags The 64-bit flag structure to have option flags set
465   \param args The array of argument pointers to hold arguments found
466   \param optstr The string containing the options to be parsed
467   \return zero for success, non-zero if an error occurs
468   \sa AST_APP_OPTIONS
469  */
470 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
471
472 /*! \brief Given a list of options array, return an option string based on passed flags
473         \param options The array of possible options declared with AST_APP_OPTIONS
474         \param flags The flags of the options that you wish to populate the buffer with
475         \param buf The buffer to fill with the string of options
476         \param len The maximum length of buf
477 */
478 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
479
480 /*! \brief Present a dialtone and collect a certain length extension.
481     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
482 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
483 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
484
485 /*! \brief Allow to record message and have a review option */
486 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
487
488 /*! \brief Decode an encoded control or extended ASCII character */
489 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
490
491 /*! \brief Common routine for child processes, to close all fds prior to exec(2) */
492 void ast_close_fds_above_n(int n);
493
494 /*! \brief Common routine to safely fork without a chance of a signal handler firing badly in the child */
495 int ast_safe_fork(int stop_reaper);
496
497 /*! \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped) */
498 void ast_safe_fork_cleanup(void);
499
500 #if defined(__cplusplus) || defined(c_plusplus)
501 }
502 #endif
503
504 #endif /* _ASTERISK_APP_H */