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