00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * 00008 * See http://www.asterisk.org for more information about 00009 * the Asterisk project. Please do not directly contact 00010 * any of the maintainers of this project for assistance; 00011 * the project provides a web site, mailing lists and IRC 00012 * channels for your use. 00013 * 00014 * This program is free software, distributed under the terms of 00015 * the GNU General Public License Version 2. See the LICENSE file 00016 * at the top of the source tree. 00017 */ 00018 00019 /*! \file 00020 * \brief Call Detail Record API 00021 */ 00022 00023 #ifndef _ASTERISK_CDR_H 00024 #define _ASTERISK_CDR_H 00025 00026 #include <sys/time.h> 00027 #define AST_CDR_FLAG_KEEP_VARS (1 << 0) 00028 #define AST_CDR_FLAG_POSTED (1 << 1) 00029 #define AST_CDR_FLAG_LOCKED (1 << 2) 00030 #define AST_CDR_FLAG_CHILD (1 << 3) 00031 #define AST_CDR_FLAG_POST_DISABLED (1 << 4) 00032 00033 #define AST_CDR_NULL 0 00034 #define AST_CDR_FAILED (1 << 0) 00035 #define AST_CDR_BUSY (1 << 1) 00036 #define AST_CDR_NOANSWER (1 << 2) 00037 #define AST_CDR_ANSWERED (1 << 3) 00038 00039 /*! AMA Flags */ 00040 #define AST_CDR_OMIT (1) 00041 #define AST_CDR_BILLING (2) 00042 #define AST_CDR_DOCUMENTATION (3) 00043 00044 #define AST_MAX_USER_FIELD 256 00045 #define AST_MAX_ACCOUNT_CODE 20 00046 00047 /* Include channel.h after relevant declarations it will need */ 00048 #include "asterisk/channel.h" 00049 #include "asterisk/utils.h" 00050 00051 /*! Responsible for call detail data */ 00052 struct ast_cdr { 00053 /*! Caller*ID with text */ 00054 char clid[AST_MAX_EXTENSION]; 00055 /*! Caller*ID number */ 00056 char src[AST_MAX_EXTENSION]; 00057 /*! Destination extension */ 00058 char dst[AST_MAX_EXTENSION]; 00059 /*! Destination context */ 00060 char dcontext[AST_MAX_EXTENSION]; 00061 00062 char channel[AST_MAX_EXTENSION]; 00063 /*! Destination channel if appropriate */ 00064 char dstchannel[AST_MAX_EXTENSION]; 00065 /*! Last application if appropriate */ 00066 char lastapp[AST_MAX_EXTENSION]; 00067 /*! Last application data */ 00068 char lastdata[AST_MAX_EXTENSION]; 00069 00070 struct timeval start; 00071 00072 struct timeval answer; 00073 00074 struct timeval end; 00075 /*! Total time in system, in seconds */ 00076 long int duration; 00077 /*! Total time call is up, in seconds */ 00078 long int billsec; 00079 /*! What happened to the call */ 00080 long int disposition; 00081 /*! What flags to use */ 00082 long int amaflags; 00083 /*! What account number to use */ 00084 char accountcode[AST_MAX_ACCOUNT_CODE]; 00085 /*! flags */ 00086 unsigned int flags; 00087 /* Unique Channel Identifier */ 00088 char uniqueid[32]; 00089 /* User field */ 00090 char userfield[AST_MAX_USER_FIELD]; 00091 00092 /* A linked list for variables */ 00093 struct varshead varshead; 00094 00095 struct ast_cdr *next; 00096 }; 00097 00098 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw); 00099 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur); 00100 int ast_cdr_serialize_variables(struct ast_cdr *cdr, char *buf, size_t size, char delim, char sep, int recur); 00101 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur); 00102 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr); 00103 int ast_cdr_log_unanswered(void); 00104 00105 typedef int (*ast_cdrbe)(struct ast_cdr *cdr); 00106 00107 /*! \brief Allocate a CDR record 00108 * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) 00109 */ 00110 struct ast_cdr *ast_cdr_alloc(void); 00111 00112 /*! \brief Duplicate a record 00113 * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) 00114 */ 00115 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr); 00116 00117 /*! \brief Free a CDR record 00118 * \param cdr ast_cdr structure to free 00119 * Returns nothing 00120 */ 00121 void ast_cdr_free(struct ast_cdr *cdr); 00122 00123 /*! \brief Discard and free a CDR record 00124 * \param cdr ast_cdr structure to free 00125 * Returns nothing -- same as free, but no checks or complaints 00126 */ 00127 void ast_cdr_discard(struct ast_cdr *cdr); 00128 00129 /*! \brief Initialize based on a channel 00130 * \param cdr Call Detail Record to use for channel 00131 * \param chan Channel to bind CDR with 00132 * Initializes a CDR and associates it with a particular channel 00133 * Return is negligible. (returns 0 by default) 00134 */ 00135 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan); 00136 00137 /*! Initialize based on a channel */ 00138 /*! 00139 * \param cdr Call Detail Record to use for channel 00140 * \param chan Channel to bind CDR with 00141 * Initializes a CDR and associates it with a particular channel 00142 * Return is negligible. (returns 0 by default) 00143 */ 00144 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan); 00145 00146 /*! Register a CDR handling engine */ 00147 /*! 00148 * \param name name associated with the particular CDR handler 00149 * \param desc description of the CDR handler 00150 * \param be function pointer to a CDR handler 00151 * Used to register a Call Detail Record handler. 00152 * Returns -1 on error, 0 on success. 00153 */ 00154 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be); 00155 00156 /*! Unregister a CDR handling engine */ 00157 /*! 00158 * \param name name of CDR handler to unregister 00159 * Unregisters a CDR by it's name 00160 */ 00161 void ast_cdr_unregister(const char *name); 00162 00163 /*! Start a call */ 00164 /*! 00165 * \param cdr the cdr you wish to associate with the call 00166 * Starts all CDR stuff necessary for monitoring a call 00167 * Returns nothing 00168 */ 00169 void ast_cdr_start(struct ast_cdr *cdr); 00170 00171 /*! Answer a call */ 00172 /*! 00173 * \param cdr the cdr you wish to associate with the call 00174 * Starts all CDR stuff necessary for doing CDR when answering a call 00175 * NULL argument is just fine. 00176 */ 00177 void ast_cdr_answer(struct ast_cdr *cdr); 00178 00179 /*! A call wasn't answered */ 00180 /*! 00181 * \param cdr the cdr you wish to associate with the call 00182 * Marks the channel disposition as "NO ANSWER" 00183 */ 00184 extern void ast_cdr_noanswer(struct ast_cdr *cdr); 00185 00186 /*! Busy a call */ 00187 /*! 00188 * \param cdr the cdr you wish to associate with the call 00189 * Returns nothing 00190 */ 00191 void ast_cdr_busy(struct ast_cdr *cdr); 00192 00193 /*! Fail a call */ 00194 /*! 00195 * \param cdr the cdr you wish to associate with the call 00196 * Returns nothing 00197 */ 00198 void ast_cdr_failed(struct ast_cdr *cdr); 00199 00200 /*! Save the result of the call based on the AST_CAUSE_* */ 00201 /*! 00202 * \param cdr the cdr you wish to associate with the call 00203 * Returns nothing 00204 * \param cause the AST_CAUSE_* 00205 */ 00206 int ast_cdr_disposition(struct ast_cdr *cdr, int cause); 00207 00208 /*! End a call */ 00209 /*! 00210 * \param cdr the cdr you have associated the call with 00211 * Registers the end of call time in the cdr structure. 00212 * Returns nothing 00213 */ 00214 void ast_cdr_end(struct ast_cdr *cdr); 00215 00216 /*! Detaches the detail record for posting (and freeing) either now or at a 00217 * later time in bulk with other records during batch mode operation */ 00218 /*! 00219 * \param cdr Which CDR to detach from the channel thread 00220 * Prevents the channel thread from blocking on the CDR handling 00221 * Returns nothing 00222 */ 00223 void ast_cdr_detach(struct ast_cdr *cdr); 00224 00225 /*! Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines */ 00226 /*! 00227 * \param shutdown Whether or not we are shutting down 00228 * Blocks the asterisk shutdown procedures until the CDR data is submitted. 00229 * Returns nothing 00230 */ 00231 void ast_cdr_submit_batch(int shutdown); 00232 00233 /*! Set the destination channel, if there was one */ 00234 /*! 00235 * \param cdr Which cdr it's applied to 00236 * \param chan Channel to which dest will be 00237 * Sets the destination channel the CDR is applied to 00238 * Returns nothing 00239 */ 00240 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan); 00241 00242 /*! Set the last executed application */ 00243 /*! 00244 * \param cdr which cdr to act upon 00245 * \param app the name of the app you wish to change it to 00246 * \param data the data you want in the data field of app you set it to 00247 * Changes the value of the last executed app 00248 * Returns nothing 00249 */ 00250 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data); 00251 00252 /*! Convert a string to a detail record AMA flag */ 00253 /*! 00254 * \param flag string form of flag 00255 * Converts the string form of the flag to the binary form. 00256 * Returns the binary form of the flag 00257 */ 00258 int ast_cdr_amaflags2int(const char *flag); 00259 00260 /*! Disposition to a string */ 00261 /*! 00262 * \param disposition input binary form 00263 * Converts the binary form of a disposition to string form. 00264 * Returns a pointer to the string form 00265 */ 00266 char *ast_cdr_disp2str(int disposition); 00267 00268 /*! Reset the detail record, optionally posting it first */ 00269 /*! 00270 * \param cdr which cdr to act upon 00271 * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it 00272 * |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's 00273 */ 00274 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags); 00275 00276 /*! Flags to a string */ 00277 /*! 00278 * \param flags binary flag 00279 * Converts binary flags to string flags 00280 * Returns string with flag name 00281 */ 00282 char *ast_cdr_flags2str(int flags); 00283 00284 /*! Move the non-null data from the "from" cdr to the "to" cdr 00285 * \param to the cdr to get the goodies 00286 * \param from the cdr to give the goodies 00287 */ 00288 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from); 00289 00290 int ast_cdr_setaccount(struct ast_channel *chan, const char *account); 00291 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags); 00292 00293 00294 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield); 00295 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield); 00296 00297 00298 /* Update CDR on a channel */ 00299 int ast_cdr_update(struct ast_channel *chan); 00300 00301 00302 extern int ast_default_amaflags; 00303 00304 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE]; 00305 00306 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr); 00307 00308 /*! Reload the configuration file cdr.conf and start/stop CDR scheduling thread */ 00309 int ast_cdr_engine_reload(void); 00310 00311 /*! Load the configuration file cdr.conf and possibly start the CDR scheduling thread */ 00312 int ast_cdr_engine_init(void); 00313 00314 /*! Submit any remaining CDRs and prepare for shutdown */ 00315 void ast_cdr_engine_term(void); 00316 00317 #endif /* _ASTERISK_CDR_H */