Sat Aug 6 00:39:19 2011

Asterisk developer's documentation


app.h

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

Generated on Sat Aug 6 00:39:19 2011 for Asterisk - the Open Source PBX by  doxygen 1.4.7