add some macros to simplify application argument parsing
[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 /* Callback function for IVR, returns 0 on completion, -1 on hangup or digit if
33    interrupted */
34 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
35
36 typedef enum {
37         AST_ACTION_UPONE,               /* adata is unused */
38         AST_ACTION_EXIT,                /* adata is the return value for ast_ivr_menu_run if channel was not hungup */
39         AST_ACTION_CALLBACK,    /* adata is an ast_ivr_callback */
40         AST_ACTION_PLAYBACK,    /* adata is file to play */
41         AST_ACTION_BACKGROUND,  /* adata is file to play */
42         AST_ACTION_PLAYLIST,    /* adata is list of files, separated by ; to play */
43         AST_ACTION_MENU,                /* adata is a pointer to an ast_ivr_menu */
44         AST_ACTION_REPEAT,              /* adata is max # of repeats, cast to a pointer */
45         AST_ACTION_RESTART,             /* adata is like repeat, but resets repeats to 0 */
46         AST_ACTION_TRANSFER,    /* adata is a string with exten[@context] */
47         AST_ACTION_WAITOPTION,  /* adata is a timeout, or 0 for defaults */
48         AST_ACTION_NOOP,                /* adata is unused */
49         AST_ACTION_BACKLIST,    /* adata is list of files separated by ; allows interruption */
50 } ast_ivr_action;
51
52 struct ast_ivr_option {
53         char *option;
54         ast_ivr_action action;
55         void *adata;    
56 };
57
58 /* 
59     Special "options" are: 
60    "s" - "start here (one time greeting)"
61    "g" - "greeting/instructions"
62    "t" - "timeout"
63    "h" - "hangup"
64    "i" - "invalid selection"
65
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 struct ast_option {
77         unsigned int flag;
78         int arg_index;
79 };
80
81 extern int ast_parseoptions(const struct ast_option *options, struct ast_flags *flags, char **args, char *optstr);
82
83 #define AST_DECLARE_OPTIONS(holder,args...) \
84         static struct ast_option holder[128] = args
85
86 #define AST_IVR_DECLARE_MENU(holder,title,flags,foo...) \
87         static struct ast_ivr_option __options_##holder[] = foo;\
88         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
89         
90
91 /*! Runs an IVR menu, returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
92 extern int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
93
94 /*! Plays a stream and gets DTMF data from a channel */
95 /*!
96  * \param c Which channel one is interacting with
97  * \param prompt File to pass to ast_streamfile (the one that you wish to play)
98  * \param s The location where the DTMF data will be stored
99  * \param maxlen Max Length of the data
100  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
101  *
102  *  This function was designed for application programmers for situations where they need 
103  *  to play a message and then get some DTMF data in response to the message.  If a digit 
104  *  is pressed during playback, it will immediately break out of the message and continue
105  *  execution of your code.
106  */
107 extern int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout);
108
109 /* Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
110 extern int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
111
112 /*! Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#' */
113 int ast_app_getvoice(struct ast_channel *c, char *dest, char *dstfmt, char *prompt, int silence, int maxsec);
114
115 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
116                               int (*messagecount_func)(const char *mailbox, int *newmsgs, int *oldmsgs));
117   
118 void ast_uninstall_vm_functions(void);
119
120 /*! Determine if a given mailbox has any voicemail */
121 int ast_app_has_voicemail(const char *mailbox, const char *folder);
122
123 /*! Determine number of new/old messages in a mailbox */
124 int ast_app_messagecount(const char *mailbox, int *newmsgs, int *oldmsgs);
125
126 /*! Safely spawn an external program while closingn file descriptors */
127 extern int ast_safe_system(const char *s);
128
129 /*! Send DTMF to chan (optionally entertain peer)   */
130 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, char *digits, int between);
131
132 /*! Stream a filename (or file descriptor) as a generator. */
133 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
134
135 /*! Stream a file with fast forward, pause, reverse, restart. */
136 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);
137
138 /*! Play a stream and wait for a digit, returning the digit that was pressed */
139 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
140
141 /*! 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 */
142 /*   permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
143      calls ast_unlock_path() on 'path' if passed */
144 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);
145
146 /*! Record a message and prepend the message to the given record file after playing the optional playfile (or a beep), storing the duration in 'duration' and with a maximum */
147 /*   permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. */
148 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);
149
150 enum AST_LOCK_RESULT {
151         AST_LOCK_SUCCESS = 0,
152         AST_LOCK_TIMEOUT = -1,
153         AST_LOCK_PATH_NOT_FOUND = -2,
154         AST_LOCK_FAILURE = -3,
155 };
156
157 /*
158  * \brief Lock a filesystem path.
159  * \param path the path to be locked
160  * \return one of AST_LOCK_RESULT values
161  */
162 enum AST_LOCK_RESULT ast_lock_path(const char *path);
163
164 /* Unlock a path */
165 int ast_unlock_path(const char *path);
166
167 /*Read a file into asterisk*/
168 char *ast_read_textfile(const char *file);
169
170 #define GROUP_CATEGORY_PREFIX "GROUP"
171
172 /*! Split a group string into group and category, returning a default category if none is provided. */
173 int ast_app_group_split_group(char *data, char *group, int group_max, char *category, int category_max);
174
175 /*! Set the group for a channel, splitting the provided data into group and category, if specified. */
176 int ast_app_group_set_channel(struct ast_channel *chan, char *data);
177
178 /*! Get the current channel count of the specified group and category. */
179 int ast_app_group_get_count(char *group, char *category);
180
181 /*! Get the current channel count of all groups that match the specified pattern and category. */
182 int ast_app_group_match_get_count(char *groupmatch, char *category);
183
184 /*!
185   \brief Define an application argument
186   \param name The name of the argument
187 */
188 #define AST_APP_ARG(name) char *name
189
190 /*!
191   \brief Declare a structure to hold the application's arguments.
192   \param name The name of the structure
193   \param arglist The list of arguments, defined using AST_APP_ARG
194
195   This macro defines a structure intended to be used in a call
196   to ast_separate_app_args(). The structure includes all the
197   arguments specified, plus an argv array that overlays them and an
198   argc argument counter. The arguments must be declared using AST_APP_ARG,
199   and they will all be character pointers (strings).
200
201   Note: The structure is <b>not</b> initialized, as the call to
202   ast_separate_app_args() will perform that function before parsing
203   the arguments.
204  */
205 #define AST_DECLARE_APP_ARGS(name, arglist) \
206         struct { \
207                 int argc; \
208                 char *argv[0]; \
209                 arglist \
210         } name;
211
212 /*!
213   \brief Performs the 'standard' argument separation process for an application.
214   \param args An argument structure defined using AST_DECLARE_APP_ARGS
215   \param parse A modifiable buffer containing the input to be parsed
216
217   This function will separate the input string using the standard argument
218   separator character '|' and fill in the provided structure, including
219   the argc argument counter field.
220  */
221 #define AST_STANDARD_APP_ARGS(args, parse) \
222         args.argc = ast_separate_app_args(parse, '|', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
223         
224 /*!
225   \brief Separate a string into arguments in an array
226   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
227   \param delim The character to be used to delimit arguments
228   \param array An array of 'char *' to be filled in with pointers to the found arguments
229   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
230
231   Note: if there are more arguments in the string than the array will hold, the last element of
232   the array will contain the remaining arguments, not separated.
233
234   The array will be completely zeroed by this function before it populates any entries.
235
236   \return The number of arguments found, or zero if the function arguments are not valid.
237 */
238 int ast_separate_app_args(char *buf, char delim, char **array, int arraylen);
239
240 /*! Present a dialtone and collect a certain length extension.  Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
241 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
242
243 /*! Allow to record message and have a review option */
244 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
245
246 #if defined(__cplusplus) || defined(c_plusplus)
247 }
248 #endif
249
250 #endif /* _ASTERISK_APP_H */