00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * See http://www.asterisk.org for more information about 00008 * the Asterisk project. Please do not directly contact 00009 * any of the maintainers of this project for assistance; 00010 * the project provides a web site, mailing lists and IRC 00011 * channels for your use. 00012 * 00013 * This program is free software, distributed under the terms of 00014 * the GNU General Public License Version 2. See the LICENSE file 00015 * at the top of the source tree. 00016 */ 00017 00018 /*! \file 00019 * \brief Application convenience functions, designed to give consistent 00020 * look and feel to Asterisk apps. 00021 */ 00022 00023 #ifndef _ASTERISK_APP_H 00024 #define _ASTERISK_APP_H 00025 00026 struct ast_flags64; 00027 00028 #if defined(__cplusplus) || defined(c_plusplus) 00029 extern "C" { 00030 #endif 00031 00032 /* IVR stuff */ 00033 00034 /*! \brief Callback function for IVR 00035 \return returns 0 on completion, -1 on hangup or digit if interrupted 00036 */ 00037 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata); 00038 00039 typedef enum { 00040 AST_ACTION_UPONE, /*!< adata is unused */ 00041 AST_ACTION_EXIT, /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */ 00042 AST_ACTION_CALLBACK, /*!< adata is an ast_ivr_callback */ 00043 AST_ACTION_PLAYBACK, /*!< adata is file to play */ 00044 AST_ACTION_BACKGROUND, /*!< adata is file to play */ 00045 AST_ACTION_PLAYLIST, /*!< adata is list of files, separated by ; to play */ 00046 AST_ACTION_MENU, /*!< adata is a pointer to an ast_ivr_menu */ 00047 AST_ACTION_REPEAT, /*!< adata is max # of repeats, cast to a pointer */ 00048 AST_ACTION_RESTART, /*!< adata is like repeat, but resets repeats to 0 */ 00049 AST_ACTION_TRANSFER, /*!< adata is a string with exten\verbatim[@context]\endverbatim */ 00050 AST_ACTION_WAITOPTION, /*!< adata is a timeout, or 0 for defaults */ 00051 AST_ACTION_NOOP, /*!< adata is unused */ 00052 AST_ACTION_BACKLIST, /*!< adata is list of files separated by ; allows interruption */ 00053 } ast_ivr_action; 00054 00055 /*! 00056 Special "options" are: 00057 \arg "s" - "start here (one time greeting)" 00058 \arg "g" - "greeting/instructions" 00059 \arg "t" - "timeout" 00060 \arg "h" - "hangup" 00061 \arg "i" - "invalid selection" 00062 00063 */ 00064 struct ast_ivr_option { 00065 char *option; 00066 ast_ivr_action action; 00067 void *adata; 00068 }; 00069 00070 struct ast_ivr_menu { 00071 char *title; /*!< Title of menu */ 00072 unsigned int flags; /*!< Flags */ 00073 struct ast_ivr_option *options; /*!< All options */ 00074 }; 00075 00076 #define AST_IVR_FLAG_AUTORESTART (1 << 0) 00077 00078 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \ 00079 static struct ast_ivr_option __options_##holder[] = foo;\ 00080 static struct ast_ivr_menu holder = { title, flags, __options_##holder } 00081 00082 00083 /*! \brief Runs an IVR menu 00084 \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */ 00085 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata); 00086 00087 /*! \brief Plays a stream and gets DTMF data from a channel 00088 * \param c Which channel one is interacting with 00089 * \param prompt File to pass to ast_streamfile (the one that you wish to play). 00090 * It is also valid for this to be multiple files concatenated by "&". 00091 * For example, "file1&file2&file3". 00092 * \param s The location where the DTMF data will be stored 00093 * \param maxlen Max Length of the data 00094 * \param timeout Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out. 00095 * 00096 * This function was designed for application programmers for situations where they need 00097 * to play a message and then get some DTMF data in response to the message. If a digit 00098 * is pressed during playback, it will immediately break out of the message and continue 00099 * execution of your code. 00100 */ 00101 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout); 00102 00103 /*! \brief Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions */ 00104 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd); 00105 00106 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder), 00107 int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs), 00108 int (*messagecount_func)(const char *context, const char *mailbox, const char *folder)); 00109 00110 void ast_uninstall_vm_functions(void); 00111 00112 /*! \brief Determine if a given mailbox has any voicemail */ 00113 int ast_app_has_voicemail(const char *mailbox, const char *folder); 00114 00115 /*! \brief Determine number of new/old messages in a mailbox */ 00116 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs); 00117 00118 /*! \brief Determine number of messages in a given mailbox and folder */ 00119 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder); 00120 00121 /*! \brief Safely spawn an external program while closing file descriptors 00122 \note This replaces the \b system call in all Asterisk modules 00123 */ 00124 int ast_safe_system(const char *s); 00125 00126 /*! 00127 * \brief Replace the SIGCHLD handler 00128 * 00129 * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie 00130 * processes from forking elsewhere in Asterisk. However, if you want to 00131 * wait*() on the process to retrieve information about it's exit status, 00132 * then this signal handler needs to be temporarily replaced. 00133 * 00134 * Code that executes this function *must* call ast_unreplace_sigchld() 00135 * after it is finished doing the wait*(). 00136 */ 00137 void ast_replace_sigchld(void); 00138 00139 /*! 00140 * \brief Restore the SIGCHLD handler 00141 * 00142 * This function is called after a call to ast_replace_sigchld. It restores 00143 * the SIGCHLD handler that cleans up any zombie processes. 00144 */ 00145 void ast_unreplace_sigchld(void); 00146 00147 /*! 00148 \brief Send DTMF to a channel 00149 00150 \param chan The channel that will receive the DTMF frames 00151 \param peer (optional) Peer channel that will be autoserviced while the 00152 primary channel is receiving DTMF 00153 \param digits This is a string of characters representing the DTMF digits 00154 to be sent to the channel. Valid characters are 00155 "0123456789*#abcdABCD". Note: You can pass arguments 'f' or 00156 'F', if you want to Flash the channel (if supported by the 00157 channel), or 'w' to add a 500 millisecond pause to the DTMF 00158 sequence. 00159 \param between This is the number of milliseconds to wait in between each 00160 DTMF digit. If zero milliseconds is specified, then the 00161 default value of 100 will be used. 00162 \param duration This is the duration that each DTMF digit should have. 00163 */ 00164 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration); 00165 00166 /*! \brief Stream a filename (or file descriptor) as a generator. */ 00167 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride); 00168 00169 /*! 00170 * \brief Stream a file with fast forward, pause, reverse, restart. 00171 * \param chan 00172 * \param file filename 00173 * \param fwd, rev, stop, pause, restart, skipms, offsetms 00174 * 00175 * Before calling this function, set this to be the number 00176 * of ms to start from the beginning of the file. When the function 00177 * returns, it will be the number of ms from the beginning where the 00178 * playback stopped. Pass NULL if you don't care. 00179 */ 00180 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); 00181 00182 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */ 00183 int ast_play_and_wait(struct ast_channel *chan, const char *fn); 00184 00185 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); 00186 00187 /*! \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 00188 \n 00189 permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 00190 calls ast_unlock_path() on 'path' if passed */ 00191 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); 00192 00193 /*! \brief Record a message and prepend the message to the given record file after 00194 playing the optional playfile (or a beep), storing the duration in 00195 'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 00196 'silencethreshold' or use '-1' for either or both parameters for defaults. */ 00197 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); 00198 00199 enum ast_getdata_result { 00200 AST_GETDATA_FAILED = -1, 00201 AST_GETDATA_COMPLETE = 0, 00202 AST_GETDATA_TIMEOUT = 1, 00203 AST_GETDATA_INTERRUPTED = 2, 00204 /*! indicates a user terminated empty string rather than an empty string resulting 00205 * from a timeout or other factors */ 00206 AST_GETDATA_EMPTY_END_TERMINATED = 3, 00207 }; 00208 00209 enum AST_LOCK_RESULT { 00210 AST_LOCK_SUCCESS = 0, 00211 AST_LOCK_TIMEOUT = -1, 00212 AST_LOCK_PATH_NOT_FOUND = -2, 00213 AST_LOCK_FAILURE = -3, 00214 }; 00215 00216 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */ 00217 enum AST_LOCK_TYPE { 00218 AST_LOCK_TYPE_LOCKFILE = 0, 00219 AST_LOCK_TYPE_FLOCK = 1, 00220 }; 00221 00222 /*! 00223 * \brief Set the type of locks used by ast_lock_path() 00224 * \param type the locking type to use 00225 */ 00226 void ast_set_lock_type(enum AST_LOCK_TYPE type); 00227 00228 /*! 00229 * \brief Lock a filesystem path. 00230 * \param path the path to be locked 00231 * \return one of \ref AST_LOCK_RESULT values 00232 */ 00233 enum AST_LOCK_RESULT ast_lock_path(const char *path); 00234 00235 /*! \brief Unlock a path */ 00236 int ast_unlock_path(const char *path); 00237 00238 /*! \brief Read a file into asterisk*/ 00239 char *ast_read_textfile(const char *file); 00240 00241 struct ast_group_info; 00242 00243 /*! \brief Split a group string into group and category, returning a default category if none is provided. */ 00244 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max); 00245 00246 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */ 00247 int ast_app_group_set_channel(struct ast_channel *chan, const char *data); 00248 00249 /*! \brief Get the current channel count of the specified group and category. */ 00250 int ast_app_group_get_count(const char *group, const char *category); 00251 00252 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */ 00253 int ast_app_group_match_get_count(const char *groupmatch, const char *category); 00254 00255 /*! \brief Discard all group counting for a channel */ 00256 int ast_app_group_discard(struct ast_channel *chan); 00257 00258 /*! \brief Update all group counting for a channel to a new one */ 00259 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan); 00260 00261 /*! \brief Write Lock the group count list */ 00262 int ast_app_group_list_wrlock(void); 00263 00264 /*! \brief Read Lock the group count list */ 00265 int ast_app_group_list_rdlock(void); 00266 00267 /*! \brief Get the head of the group count list */ 00268 struct ast_group_info *ast_app_group_list_head(void); 00269 00270 /*! \brief Unlock the group count list */ 00271 int ast_app_group_list_unlock(void); 00272 00273 /*! 00274 \brief Define an application argument 00275 \param name The name of the argument 00276 */ 00277 #define AST_APP_ARG(name) char *name 00278 00279 /*! 00280 \brief Declare a structure to hold an application's arguments. 00281 \param name The name of the structure 00282 \param arglist The list of arguments, defined using AST_APP_ARG 00283 00284 This macro declares a structure intended to be used in a call 00285 to ast_app_separate_args(). The structure includes all the 00286 arguments specified, plus an argv array that overlays them and an 00287 argc argument counter. The arguments must be declared using AST_APP_ARG, 00288 and they will all be character pointers (strings). 00289 00290 \note The structure is <b>not</b> initialized, as the call to 00291 ast_app_separate_args() will perform that function before parsing 00292 the arguments. 00293 */ 00294 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name 00295 00296 /*! 00297 \brief Define a structure type to hold an application's arguments. 00298 \param type The name of the structure type 00299 \param arglist The list of arguments, defined using AST_APP_ARG 00300 00301 This macro defines a structure type intended to be used in a call 00302 to ast_app_separate_args(). The structure includes all the 00303 arguments specified, plus an argv array that overlays them and an 00304 argc argument counter. The arguments must be declared using AST_APP_ARG, 00305 and they will all be character pointers (strings). 00306 00307 \note This defines a structure type, but does not declare an instance 00308 of the structure. That must be done separately. 00309 */ 00310 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \ 00311 struct type { \ 00312 unsigned int argc; \ 00313 char *argv[0]; \ 00314 arglist \ 00315 } 00316 00317 /*! 00318 \brief Performs the 'standard' argument separation process for an application. 00319 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00320 \param parse A modifiable buffer containing the input to be parsed 00321 00322 This function will separate the input string using the standard argument 00323 separator character ',' and fill in the provided structure, including 00324 the argc argument counter field. 00325 */ 00326 #define AST_STANDARD_APP_ARGS(args, parse) \ 00327 args.argc = ast_app_separate_args(parse, ',', args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00328 00329 /*! 00330 \brief Performs the 'nonstandard' argument separation process for an application. 00331 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00332 \param parse A modifiable buffer containing the input to be parsed 00333 \param sep A nonstandard separator character 00334 00335 This function will separate the input string using the nonstandard argument 00336 separator character and fill in the provided structure, including 00337 the argc argument counter field. 00338 */ 00339 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \ 00340 args.argc = ast_app_separate_args(parse, sep, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00341 00342 /*! 00343 \brief Separate a string into arguments in an array 00344 \param buf The string to be parsed (this must be a writable copy, as it will be modified) 00345 \param delim The character to be used to delimit arguments 00346 \param array An array of 'char *' to be filled in with pointers to the found arguments 00347 \param arraylen The number of elements in the array (i.e. the number of arguments you will accept) 00348 00349 Note: if there are more arguments in the string than the array will hold, the last element of 00350 the array will contain the remaining arguments, not separated. 00351 00352 The array will be completely zeroed by this function before it populates any entries. 00353 00354 \return The number of arguments found, or zero if the function arguments are not valid. 00355 */ 00356 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen); 00357 00358 /*! 00359 \brief A structure to hold the description of an application 'option'. 00360 00361 Application 'options' are single-character flags that can be supplied 00362 to the application to affect its behavior; they can also optionally 00363 accept arguments enclosed in parenthesis. 00364 00365 These structures are used by the ast_app_parse_options function, uses 00366 this data to fill in a flags structure (to indicate which options were 00367 supplied) and array of argument pointers (for those options that had 00368 arguments supplied). 00369 */ 00370 struct ast_app_option { 00371 /*! \brief The flag bit that represents this option. */ 00372 uint64_t flag; 00373 /*! \brief The index of the entry in the arguments array 00374 that should be used for this option's argument. */ 00375 unsigned int arg_index; 00376 }; 00377 00378 #define BEGIN_OPTIONS { 00379 #define END_OPTIONS } 00380 00381 /*! 00382 \brief Declares an array of options for an application. 00383 \param holder The name of the array to be created 00384 \param options The actual options to be placed into the array 00385 \sa ast_app_parse_options 00386 00387 This macro declares a 'static const' array of \c struct \c ast_option 00388 elements to hold the list of available options for an application. 00389 Each option must be declared using either the AST_APP_OPTION() 00390 or AST_APP_OPTION_ARG() macros. 00391 00392 Example usage: 00393 \code 00394 enum { 00395 OPT_JUMP = (1 << 0), 00396 OPT_BLAH = (1 << 1), 00397 OPT_BLORT = (1 << 2), 00398 } my_app_option_flags; 00399 00400 enum { 00401 OPT_ARG_BLAH = 0, 00402 OPT_ARG_BLORT, 00403 !! this entry tells how many possible arguments there are, 00404 and must be the last entry in the list 00405 OPT_ARG_ARRAY_SIZE, 00406 } my_app_option_args; 00407 00408 AST_APP_OPTIONS(my_app_options, { 00409 AST_APP_OPTION('j', OPT_JUMP), 00410 AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH), 00411 AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT), 00412 }); 00413 00414 static int my_app_exec(struct ast_channel *chan, void *data) 00415 { 00416 char *options; 00417 struct ast_flags opts = { 0, }; 00418 char *opt_args[OPT_ARG_ARRAY_SIZE]; 00419 00420 ... do any argument parsing here ... 00421 00422 if (ast_parseoptions(my_app_options, &opts, opt_args, options)) { 00423 ast_module_user_remove(u); 00424 return -1; 00425 } 00426 } 00427 \endcode 00428 */ 00429 #define AST_APP_OPTIONS(holder, options...) \ 00430 static const struct ast_app_option holder[128] = options 00431 00432 /*! 00433 \brief Declares an application option that does not accept an argument. 00434 \param option The single character representing the option 00435 \param flagno The flag index to be set if this option is present 00436 \sa AST_APP_OPTIONS, ast_app_parse_options 00437 */ 00438 #define AST_APP_OPTION(option, flagno) \ 00439 [option] = { .flag = flagno } 00440 00441 /*! 00442 \brief Declares an application option that accepts an argument. 00443 \param option The single character representing the option 00444 \param flagno The flag index to be set if this option is present 00445 \param argno The index into the argument array where the argument should 00446 be placed 00447 \sa AST_APP_OPTIONS, ast_app_parse_options 00448 */ 00449 #define AST_APP_OPTION_ARG(option, flagno, argno) \ 00450 [option] = { .flag = flagno, .arg_index = argno + 1 } 00451 00452 /*! 00453 \brief Parses a string containing application options and sets flags/arguments. 00454 \param options The array of possible options declared with AST_APP_OPTIONS 00455 \param flags The flag structure to have option flags set 00456 \param args The array of argument pointers to hold arguments found 00457 \param optstr The string containing the options to be parsed 00458 \return zero for success, non-zero if an error occurs 00459 \sa AST_APP_OPTIONS 00460 */ 00461 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr); 00462 00463 /*! 00464 \brief Parses a string containing application options and sets flags/arguments. 00465 \param options The array of possible options declared with AST_APP_OPTIONS 00466 \param flags The 64-bit flag structure to have option flags set 00467 \param args The array of argument pointers to hold arguments found 00468 \param optstr The string containing the options to be parsed 00469 \return zero for success, non-zero if an error occurs 00470 \sa AST_APP_OPTIONS 00471 */ 00472 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr); 00473 00474 /*! \brief Given a list of options array, return an option string based on passed flags 00475 \param options The array of possible options declared with AST_APP_OPTIONS 00476 \param flags The flags of the options that you wish to populate the buffer with 00477 \param buf The buffer to fill with the string of options 00478 \param len The maximum length of buf 00479 */ 00480 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len); 00481 00482 /*! \brief Present a dialtone and collect a certain length extension. 00483 \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 00484 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */ 00485 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout); 00486 00487 /*! \brief Allow to record message and have a review option */ 00488 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path); 00489 00490 /*! \brief Decode an encoded control or extended ASCII character */ 00491 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed); 00492 00493 /*! \brief Decode a string which may contain multiple encoded control or extended ASCII characters */ 00494 int ast_get_encoded_str(const char *stream, char *result, size_t result_size); 00495 00496 /*! \brief Decode a stream of encoded control or extended ASCII characters */ 00497 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream); 00498 00499 #if defined(__cplusplus) || defined(c_plusplus) 00500 } 00501 #endif 00502 00503 #endif /* _ASTERISK_APP_H */