Asterisk.org: Developer Documentation (28 Oct 2009)

Wed Oct 28 15:47:47 2009

## 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 extern 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 extern 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 extern int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
    00101
    00102 /*! Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#' */
    00103 int ast_app_getvoice(struct ast_channel *c, char *dest, char *dstfmt, char *prompt, int silence, int maxsec);
    00104
    00105 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
    00106                int (*messagecount_func)(const char *mailbox, int *newmsgs, int *oldmsgs));
    00107
    00108 void ast_uninstall_vm_functions(void);
    00109
    00110 /*! Determine if a given mailbox has any voicemail */
    00111 int ast_app_has_voicemail(const char *mailbox, const char *folder);
    00112
    00113 /*! Determine number of new/old messages in a mailbox */
    00114 int ast_app_messagecount(const char *mailbox, int *newmsgs, int *oldmsgs);
    00115
    00116 /*! Safely spawn an external program while closing file descriptors
    00117    \note This replaces the \b system call in all Asterisk modules
    00118 */
    00119 extern int ast_safe_system(const char *s);
    00120
    00121 /*! Send DTMF to chan (optionally entertain peer)   */
    00122 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, char *digits, int between);
    00123
    00124 /*! Stream a filename (or file descriptor) as a generator. */
    00125 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
    00126
    00127 /*! Stream a file with fast forward, pause, reverse, restart. */
    00128 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);
    00129
    00130 /*! Play a stream and wait for a digit, returning the digit that was pressed */
    00131 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
    00132
    00133 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);
    00134
    00135 /*! 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
    00136  \n
    00137  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.
    00138      calls ast_unlock_path() on 'path' if passed */
    00139 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);
    00140
    00141 /*! Record a message and prepend the message to the given record file after
    00142     playing the optional playfile (or a beep), storing the duration in
    00143     'duration' and with a maximum
    00144 \n
    00145   permitted silence time in milliseconds of 'maxsilence' under
    00146   'silencethreshold' or use '-1' for either or both parameters for defaults. */
    00147 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);
    00148
    00149 enum AST_LOCK_RESULT {
    00150    AST_LOCK_SUCCESS = 0,
    00151    AST_LOCK_TIMEOUT = -1,
    00152    AST_LOCK_PATH_NOT_FOUND = -2,
    00153    AST_LOCK_FAILURE = -3,
    00154 };
    00155
    00156 /*!
    00157  * \brief Lock a filesystem path.
    00158  * \param path the path to be locked
    00159  * \return one of \ref AST_LOCK_RESULT values
    00160  */
    00161 enum AST_LOCK_RESULT ast_lock_path(const char *path);
    00162
    00163 /*! Unlock a path */
    00164 int ast_unlock_path(const char *path);
    00165
    00166 /*! Read a file into asterisk*/
    00167 char *ast_read_textfile(const char *file);
    00168
    00169 struct ast_group_info {
    00170    struct ast_channel *chan;
    00171    char *category;
    00172    char *group;
    00173    AST_LIST_ENTRY(ast_group_info) list;
    00174 };
    00175
    00176 /*! Split a group string into group and category, returning a default category if none is provided. */
    00177 int ast_app_group_split_group(char *data, char *group, int group_max, char *category, int category_max);
    00178
    00179 /*! Set the group for a channel, splitting the provided data into group and category, if specified. */
    00180 int ast_app_group_set_channel(struct ast_channel *chan, char *data);
    00181
    00182 /*! Get the current channel count of the specified group and category. */
    00183 int ast_app_group_get_count(char *group, char *category);
    00184
    00185 /*! Get the current channel count of all groups that match the specified pattern and category. */
    00186 int ast_app_group_match_get_count(char *groupmatch, char *category);
    00187
    00188 /*! Discard all group counting for a channel */
    00189 int ast_app_group_discard(struct ast_channel *chan);
    00190
    00191 /*! Update all group counting for a channel to a new one */
    00192 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
    00193
    00194 /*! Lock the group count list */
    00195 int ast_app_group_list_lock(void);
    00196
    00197 /*! Get the head of the group count list */
    00198 struct ast_group_info *ast_app_group_list_head(void);
    00199
    00200 /*! Unlock the group count list */
    00201 int ast_app_group_list_unlock(void);
    00202
    00203 /*!
    00204   \brief Define an application argument
    00205   \param name The name of the argument
    00206 */
    00207 #define AST_APP_ARG(name) char *name
    00208
    00209 /*!
    00210   \brief Declare a structure to hold the application's arguments.
    00211   \param name The name of the structure
    00212   \param arglist The list of arguments, defined using AST_APP_ARG
    00213
    00214   This macro defines a structure intended to be used in a call
    00215   to ast_app_separate_args(). The structure includes all the
    00216   arguments specified, plus an argv array that overlays them and an
    00217   argc argument counter. The arguments must be declared using AST_APP_ARG,
    00218   and they will all be character pointers (strings).
    00219
    00220   \note The structure is <b>not</b> initialized, as the call to
    00221   ast_app_separate_args() will perform that function before parsing
    00222   the arguments.
    00223  */
    00224 #define AST_DECLARE_APP_ARGS(name, arglist) \
    00225    struct { \
    00226       unsigned int argc; \
    00227       char *argv[0]; \
    00228       arglist \
    00229    } name
    00230
    00231 /*!
    00232   \brief Performs the 'standard' argument separation process for an application.
    00233   \param args An argument structure defined using AST_DECLARE_APP_ARGS
    00234   \param parse A modifiable buffer containing the input to be parsed
    00235
    00236   This function will separate the input string using the standard argument
    00237   separator character '|' and fill in the provided structure, including
    00238   the argc argument counter field.
    00239  */
    00240 #define AST_STANDARD_APP_ARGS(args, parse) \
    00241    args.argc = ast_app_separate_args(parse, '|', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
    00242
    00243 /*!
    00244   \brief Separate a string into arguments in an array
    00245   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
    00246   \param delim The character to be used to delimit arguments
    00247   \param array An array of 'char *' to be filled in with pointers to the found arguments
    00248   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
    00249
    00250   Note: if there are more arguments in the string than the array will hold, the last element of
    00251   the array will contain the remaining arguments, not separated.
    00252
    00253   The array will be completely zeroed by this function before it populates any entries.
    00254
    00255   \return The number of arguments found, or zero if the function arguments are not valid.
    00256 */
    00257 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
    00258
    00259 /*!
    00260   \brief A structure to hold the description of an application 'option'.
    00261
    00262   Application 'options' are single-character flags that can be supplied
    00263   to the application to affect its behavior; they can also optionally
    00264   accept arguments enclosed in parenthesis.
    00265
    00266   These structures are used by the ast_app_parse_options function, uses
    00267   this data to fill in a flags structure (to indicate which options were
    00268   supplied) and array of argument pointers (for those options that had
    00269   arguments supplied).
    00270  */
    00271 struct ast_app_option {
    00272    /*! \brief The flag bit that represents this option. */
    00273    unsigned int flag;
    00274    /*! \brief The index of the entry in the arguments array
    00275      that should be used for this option's argument. */
    00276    unsigned int arg_index;
    00277 };
    00278
    00279 /*!
    00280   \brief Declares an array of options for an application.
    00281   \param holder The name of the array to be created
    00282   \param options The actual options to be placed into the array
    00283   \sa ast_app_parse_options
    00284
    00285   This macro declares a 'static const' array of \c struct \c ast_option
    00286   elements to hold the list of available options for an application.
    00287   Each option must be declared using either the AST_APP_OPTION()
    00288   or AST_APP_OPTION_ARG() macros.
    00289
    00290   Example usage:
    00291   \code
    00292   enum {
    00293         OPT_JUMP = (1 << 0),
    00294         OPT_BLAH = (1 << 1),
    00295         OPT_BLORT = (1 << 2),
    00296   } my_app_option_flags;
    00297
    00298   enum {
    00299         OPT_ARG_BLAH = 0,
    00300         OPT_ARG_BLORT,
    00301         !! this entry tells how many possible arguments there are,
    00302            and must be the last entry in the list
    00303         OPT_ARG_ARRAY_SIZE,
    00304   } my_app_option_args;
    00305
    00306   AST_APP_OPTIONS(my_app_options, {
    00307         AST_APP_OPTION('j', OPT_JUMP),
    00308         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
    00309         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
    00310   });
    00311
    00312   static int my_app_exec(struct ast_channel *chan, void *data)
    00313   {
    00314    char *options;
    00315    struct ast_flags opts = { 0, };
    00316    char *opt_args[OPT_ARG_ARRAY_SIZE];
    00317
    00318    ... do any argument parsing here ...
    00319
    00320    if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
    00321       LOCAL_USER_REMOVE(u);
    00322       return -1;
    00323    }
    00324   }
    00325   \endcode
    00326  */
    00327 #define AST_APP_OPTIONS(holder, options...) \
    00328    static const struct ast_app_option holder[128] = options
    00329
    00330 /*!
    00331   \brief Declares an application option that does not accept an argument.
    00332   \param option The single character representing the option
    00333   \param flagno The flag index to be set if this option is present
    00334   \sa AST_APP_OPTIONS, ast_app_parse_options
    00335  */
    00336 #define AST_APP_OPTION(option, flagno) \
    00337    [option] = { .flag = flagno }
    00338
    00339 /*!
    00340   \brief Declares an application option that accepts an argument.
    00341   \param option The single character representing the option
    00342   \param flagno The flag index to be set if this option is present
    00343   \param argno The index into the argument array where the argument should
    00344   be placed
    00345   \sa AST_APP_OPTIONS, ast_app_parse_options
    00346  */
    00347 #define AST_APP_OPTION_ARG(option, flagno, argno) \
    00348    [option] = { .flag = flagno, .arg_index = argno + 1 }
    00349
    00350 /*!
    00351   \brief Parses a string containing application options and sets flags/arguments.
    00352   \param options The array of possible options declared with AST_APP_OPTIONS
    00353   \param flags The flag structure to have option flags set
    00354   \param args The array of argument pointers to hold arguments found
    00355   \param optstr The string containing the options to be parsed
    00356   \return zero for success, non-zero if an error occurs
    00357   \sa AST_APP_OPTIONS
    00358  */
    00359 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
    00360
    00361 /*! \brief Present a dialtone and collect a certain length extension.
    00362     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
    00363 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
    00364 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
    00365
    00366 /*! Allow to record message and have a review option */
    00367 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
    00368
    00369 #if defined(__cplusplus) || defined(c_plusplus)
    00370 }
    00371 #endif
    00372
    00373 #endif /* _ASTERISK_APP_H */