Merged revisions 65200 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / cdr.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  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Call Detail Record API 
21  */
22
23 #ifndef _ASTERISK_CDR_H
24 #define _ASTERISK_CDR_H
25
26 #include <sys/time.h>
27 #define AST_CDR_FLAG_KEEP_VARS                  (1 << 0)
28 #define AST_CDR_FLAG_POSTED                     (1 << 1)
29 #define AST_CDR_FLAG_LOCKED                     (1 << 2)
30 #define AST_CDR_FLAG_CHILD                      (1 << 3)
31 #define AST_CDR_FLAG_POST_DISABLED              (1 << 4)
32
33 #define AST_CDR_NULL                0
34 #define AST_CDR_FAILED                          (1 << 0)
35 #define AST_CDR_BUSY                            (1 << 1)
36 #define AST_CDR_NOANSWER                        (1 << 2)
37 #define AST_CDR_ANSWERED                        (1 << 3)
38
39 /*! AMA Flags */
40 #define AST_CDR_OMIT                            (1)
41 #define AST_CDR_BILLING                         (2)
42 #define AST_CDR_DOCUMENTATION                   (3)
43
44 #define AST_MAX_USER_FIELD                      256
45 #define AST_MAX_ACCOUNT_CODE                    20
46
47 /* Include channel.h after relevant declarations it will need */
48 #include "asterisk/channel.h"
49 #include "asterisk/utils.h"
50
51 /*! Responsible for call detail data */
52 struct ast_cdr {
53         /*! Caller*ID with text */
54         char clid[AST_MAX_EXTENSION];
55         /*! Caller*ID number */
56         char src[AST_MAX_EXTENSION];            
57         /*! Destination extension */
58         char dst[AST_MAX_EXTENSION];            
59         /*! Destination context */
60         char dcontext[AST_MAX_EXTENSION];       
61         
62         char channel[AST_MAX_EXTENSION];
63         /*! Destination channel if appropriate */
64         char dstchannel[AST_MAX_EXTENSION];     
65         /*! Last application if appropriate */
66         char lastapp[AST_MAX_EXTENSION];        
67         /*! Last application data */
68         char lastdata[AST_MAX_EXTENSION];       
69         
70         struct timeval start;
71         
72         struct timeval answer;
73         
74         struct timeval end;
75         /*! Total time in system, in seconds */
76         long int duration;                              
77         /*! Total time call is up, in seconds */
78         long int billsec;                               
79         /*! What happened to the call */
80         long int disposition;                   
81         /*! What flags to use */
82         long int amaflags;                              
83         /*! What account number to use */
84         char accountcode[AST_MAX_ACCOUNT_CODE];                 
85         /*! flags */
86         unsigned int flags;                             
87         /* Unique Channel Identifier */
88         char uniqueid[32];
89         /* User field */
90         char userfield[AST_MAX_USER_FIELD];
91
92         /* A linked list for variables */
93         struct varshead varshead;
94
95         struct ast_cdr *next;
96 };
97
98 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
99 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
100 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur);
101 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
102 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
103
104 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
105
106 /*! \brief Return TRUE if CDR subsystem is enabled */
107 int check_cdr_enabled(void);
108
109 /*! \brief Allocate a CDR record 
110  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
111  */
112 struct ast_cdr *ast_cdr_alloc(void);
113
114 /*! \brief Duplicate a record 
115  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
116  */
117 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
118
119 /*! \brief Free a CDR record 
120  * \param cdr ast_cdr structure to free
121  * Returns nothing
122  */
123 void ast_cdr_free(struct ast_cdr *cdr);
124
125 /*! \brief Discard and free a CDR record 
126  * \param cdr ast_cdr structure to free
127  * Returns nothing  -- same as free, but no checks or complaints
128  */
129 void ast_cdr_discard(struct ast_cdr *cdr);
130
131 /*! \brief Initialize based on a channel
132  * \param cdr Call Detail Record to use for channel
133  * \param chan Channel to bind CDR with
134  * Initializes a CDR and associates it with a particular channel
135  * Return is negligible.  (returns 0 by default)
136  */
137 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
138
139 /*! Initialize based on a channel */
140 /*! 
141  * \param cdr Call Detail Record to use for channel
142  * \param chan Channel to bind CDR with
143  * Initializes a CDR and associates it with a particular channel
144  * Return is negligible.  (returns 0 by default)
145  */
146 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
147
148 /*! Register a CDR handling engine */
149 /*!
150  * \param name name associated with the particular CDR handler
151  * \param desc description of the CDR handler
152  * \param be function pointer to a CDR handler
153  * Used to register a Call Detail Record handler.
154  * Returns -1 on error, 0 on success.
155  */
156 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
157
158 /*! Unregister a CDR handling engine */
159 /*!
160  * \param name name of CDR handler to unregister
161  * Unregisters a CDR by it's name
162  */
163 void ast_cdr_unregister(const char *name);
164
165 /*! Start a call */
166 /*!
167  * \param cdr the cdr you wish to associate with the call
168  * Starts all CDR stuff necessary for monitoring a call
169  * Returns nothing
170  */
171 void ast_cdr_start(struct ast_cdr *cdr);
172
173 /*! Answer a call */
174 /*!
175  * \param cdr the cdr you wish to associate with the call
176  * Starts all CDR stuff necessary for doing CDR when answering a call
177  * NULL argument is just fine.
178  */
179 void ast_cdr_answer(struct ast_cdr *cdr);
180
181 /*! A call wasn't answered */
182 /*!
183  * \param cdr the cdr you wish to associate with the call
184  * Marks the channel disposition as "NO ANSWER"
185  */
186 extern void ast_cdr_noanswer(struct ast_cdr *cdr);
187
188 /*! Busy a call */
189 /*!
190  * \param cdr the cdr you wish to associate with the call
191  * Returns nothing
192  */
193 void ast_cdr_busy(struct ast_cdr *cdr);
194
195 /*! Fail a call */
196 /*!
197  * \param cdr the cdr you wish to associate with the call
198  * Returns nothing
199  */
200 void ast_cdr_failed(struct ast_cdr *cdr);
201
202 /*! Save the result of the call based on the AST_CAUSE_* */
203 /*!
204  * \param cdr the cdr you wish to associate with the call
205  * Returns nothing
206  * \param cause the AST_CAUSE_*
207  */
208 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
209         
210 /*! End a call */
211 /*!
212  * \param cdr the cdr you have associated the call with
213  * Registers the end of call time in the cdr structure.
214  * Returns nothing
215  */
216 void ast_cdr_end(struct ast_cdr *cdr);
217
218 /*! Detaches the detail record for posting (and freeing) either now or at a
219  * later time in bulk with other records during batch mode operation */
220 /*! 
221  * \param cdr Which CDR to detach from the channel thread
222  * Prevents the channel thread from blocking on the CDR handling
223  * Returns nothing
224  */
225 void ast_cdr_detach(struct ast_cdr *cdr);
226
227 /*! Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines */
228 /*!
229  * \param shutdown Whether or not we are shutting down
230  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
231  * Returns nothing
232  */
233 void ast_cdr_submit_batch(int shutdown);
234
235 /*! Set the destination channel, if there was one */
236 /*!
237  * \param cdr Which cdr it's applied to
238  * \param chan Channel to which dest will be
239  * Sets the destination channel the CDR is applied to
240  * Returns nothing
241  */
242 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
243
244 /*! Set the last executed application */
245 /*!
246  * \param cdr which cdr to act upon
247  * \param app the name of the app you wish to change it to
248  * \param data the data you want in the data field of app you set it to
249  * Changes the value of the last executed app
250  * Returns nothing
251  */
252 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
253
254 /*! Convert a string to a detail record AMA flag */
255 /*!
256  * \param flag string form of flag
257  * Converts the string form of the flag to the binary form.
258  * Returns the binary form of the flag
259  */
260 int ast_cdr_amaflags2int(const char *flag);
261
262 /*! Disposition to a string */
263 /*!
264  * \param disposition input binary form
265  * Converts the binary form of a disposition to string form.
266  * Returns a pointer to the string form
267  */
268 char *ast_cdr_disp2str(int disposition);
269
270 /*! Reset the detail record, optionally posting it first */
271 /*!
272  * \param cdr which cdr to act upon
273  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
274  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
275  */
276 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
277
278 /*! Flags to a string */
279 /*!
280  * \param flags binary flag
281  * Converts binary flags to string flags
282  * Returns string with flag name
283  */
284 char *ast_cdr_flags2str(int flags);
285
286 /*! Move the non-null data from the "from" cdr to the "to" cdr
287  * \param to   the cdr to get the goodies
288  * \param from the cdr to give the goodies
289  */
290 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
291
292 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
293 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
294
295
296 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
297 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
298
299
300 /* Update CDR on a channel */
301 int ast_cdr_update(struct ast_channel *chan);
302
303
304 extern int ast_default_amaflags;
305
306 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
307
308 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
309
310 /*! Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
311 int ast_cdr_engine_reload(void);
312
313 /*! Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
314 int ast_cdr_engine_init(void);
315
316 /*! Submit any remaining CDRs and prepare for shutdown */
317 void ast_cdr_engine_term(void);
318
319 #endif /* _ASTERISK_CDR_H */