Merged revisions 198068 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
28 /*! \name CDR Flags */
29 /*@{ */
30 #define AST_CDR_FLAG_KEEP_VARS          (1 << 0)
31 #define AST_CDR_FLAG_POSTED                     (1 << 1)
32 #define AST_CDR_FLAG_LOCKED                     (1 << 2)
33 #define AST_CDR_FLAG_CHILD                      (1 << 3)
34 #define AST_CDR_FLAG_POST_DISABLED      (1 << 4)
35 #define AST_CDR_FLAG_BRIDGED            (1 << 5)
36 #define AST_CDR_FLAG_MAIN                       (1 << 6)
37 #define AST_CDR_FLAG_ENABLE                     (1 << 7)
38 #define AST_CDR_FLAG_ANSLOCKED      (1 << 8)
39 #define AST_CDR_FLAG_DONT_TOUCH     (1 << 9)
40 #define AST_CDR_FLAG_POST_ENABLE    (1 << 10)
41 #define AST_CDR_FLAG_DIALED         (1 << 11)
42 /*@} */
43 #define AST_CDR_FLAG_ORIGINATED         (1 << 11)
44
45 /*! \name CDR Flags - Disposition */
46 /*@{ */
47 #define AST_CDR_NULL                0
48 #define AST_CDR_FAILED                          (1 << 0)
49 #define AST_CDR_BUSY                            (1 << 1)
50 #define AST_CDR_NOANSWER                        (1 << 2)
51 #define AST_CDR_ANSWERED                        (1 << 3)
52 /*@} */
53
54 /*! \name CDR AMA Flags */
55 /*@{ */
56 #define AST_CDR_OMIT                            (1)
57 #define AST_CDR_BILLING                         (2)
58 #define AST_CDR_DOCUMENTATION           (3)
59 /*@} */
60
61 #define AST_MAX_USER_FIELD                      256
62 #define AST_MAX_ACCOUNT_CODE            20
63
64 /* Include channel.h after relevant declarations it will need */
65 #include "asterisk/channel.h"
66 #include "asterisk/utils.h"
67
68 /*! \brief Responsible for call detail data */
69 struct ast_cdr {
70         /*! Caller*ID with text */
71         char clid[AST_MAX_EXTENSION];
72         /*! Caller*ID number */
73         char src[AST_MAX_EXTENSION];            
74         /*! Destination extension */
75         char dst[AST_MAX_EXTENSION];            
76         /*! Destination context */
77         char dcontext[AST_MAX_EXTENSION];       
78         
79         char channel[AST_MAX_EXTENSION];
80         /*! Destination channel if appropriate */
81         char dstchannel[AST_MAX_EXTENSION];     
82         /*! Last application if appropriate */
83         char lastapp[AST_MAX_EXTENSION];        
84         /*! Last application data */
85         char lastdata[AST_MAX_EXTENSION];       
86         
87         struct timeval start;
88         
89         struct timeval answer;
90         
91         struct timeval end;
92         /*! Total time in system, in seconds */
93         long int duration;                              
94         /*! Total time call is up, in seconds */
95         long int billsec;                               
96         /*! What happened to the call */
97         long int disposition;                   
98         /*! What flags to use */
99         long int amaflags;                              
100         /*! What account number to use */
101         char accountcode[AST_MAX_ACCOUNT_CODE];                 
102         /*! flags */
103         unsigned int flags;                             
104         /*! Unique Channel Identifier
105          * 150 = 127 (max systemname) + "-" + 10 (epoch timestamp) + "." + 10 (monotonically incrementing integer) + NULL */
106         char uniqueid[150];
107         /*! User field */
108         char userfield[AST_MAX_USER_FIELD];
109
110         /*! A linked list for variables */
111         struct varshead varshead;
112
113         struct ast_cdr *next;
114 };
115
116 int ast_cdr_isset_unanswered(void);
117 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
118 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
119 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur);
120 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
121 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
122
123 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
124
125 /*! \brief Return TRUE if CDR subsystem is enabled */
126 int check_cdr_enabled(void);
127
128 /*! 
129  * \brief Allocate a CDR record 
130  * \retval a malloc'd ast_cdr structure
131  * \retval NULL on error (malloc failure)
132  */
133 struct ast_cdr *ast_cdr_alloc(void);
134
135 /*! 
136  * \brief Duplicate a record 
137  * \retval a malloc'd ast_cdr structure, 
138  * \retval NULL on error (malloc failure)
139  */
140 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
141
142 /*! 
143  * \brief Free a CDR record 
144  * \param cdr ast_cdr structure to free
145  * Returns nothing
146  */
147 void ast_cdr_free(struct ast_cdr *cdr);
148
149 /*! 
150  * \brief Discard and free a CDR record 
151  * \param cdr ast_cdr structure to free
152  * Returns nothing  -- same as free, but no checks or complaints
153  */
154 void ast_cdr_discard(struct ast_cdr *cdr);
155
156 /*! 
157  * \brief Initialize based on a channel
158  * \param cdr Call Detail Record to use for channel
159  * \param chan Channel to bind CDR with
160  * Initializes a CDR and associates it with a particular channel
161  * \return 0 by default
162  */
163 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
164
165 /*! 
166  * \brief Initialize based on a channel 
167  * \param cdr Call Detail Record to use for channel
168  * \param chan Channel to bind CDR with
169  * Initializes a CDR and associates it with a particular channel
170  * \return 0 by default
171  */
172 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
173
174 /*! 
175  * \brief Register a CDR handling engine 
176  * \param name name associated with the particular CDR handler
177  * \param desc description of the CDR handler
178  * \param be function pointer to a CDR handler
179  * Used to register a Call Detail Record handler.
180  * \retval 0 on success.
181  * \retval -1 on error
182  */
183 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
184
185 /*! 
186  * \brief Unregister a CDR handling engine 
187  * \param name name of CDR handler to unregister
188  * Unregisters a CDR by it's name
189  */
190 void ast_cdr_unregister(const char *name);
191
192 /*! 
193  * \brief Start a call 
194  * \param cdr the cdr you wish to associate with the call
195  * Starts all CDR stuff necessary for monitoring a call
196  * Returns nothing
197  */
198 void ast_cdr_start(struct ast_cdr *cdr);
199
200 /*! \brief Answer a call 
201  * \param cdr the cdr you wish to associate with the call
202  * Starts all CDR stuff necessary for doing CDR when answering a call
203  * \note NULL argument is just fine.
204  */
205 void ast_cdr_answer(struct ast_cdr *cdr);
206
207 /*! 
208  * \brief A call wasn't answered 
209  * \param cdr the cdr you wish to associate with the call
210  * Marks the channel disposition as "NO ANSWER"
211  * Will skip CDR's in chain with ANS_LOCK bit set. (see
212  * forkCDR() application.
213  */
214 extern void ast_cdr_noanswer(struct ast_cdr *cdr);
215
216 /*! 
217  * \brief Busy a call 
218  * \param cdr the cdr you wish to associate with the call
219  * Marks the channel disposition as "BUSY"
220  * Will skip CDR's in chain with ANS_LOCK bit set. (see
221  * forkCDR() application.
222  * Returns nothing
223  */
224 void ast_cdr_busy(struct ast_cdr *cdr);
225
226 /*! 
227  * \brief Fail a call 
228  * \param cdr the cdr you wish to associate with the call
229  * Marks the channel disposition as "FAILED"
230  * Will skip CDR's in chain with ANS_LOCK bit set. (see
231  * forkCDR() application.
232  * Returns nothing
233  */
234 void ast_cdr_failed(struct ast_cdr *cdr);
235
236 /*! 
237  * \brief Save the result of the call based on the AST_CAUSE_*
238  * \param cdr the cdr you wish to associate with the call
239  * \param cause the AST_CAUSE_*
240  * Returns nothing
241  */
242 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
243         
244 /*! 
245  * \brief End a call
246  * \param cdr the cdr you have associated the call with
247  * Registers the end of call time in the cdr structure.
248  * Returns nothing
249  */
250 void ast_cdr_end(struct ast_cdr *cdr);
251
252 /*! 
253  * \brief Detaches the detail record for posting (and freeing) either now or at a
254  * later time in bulk with other records during batch mode operation.
255  * \param cdr Which CDR to detach from the channel thread
256  * Prevents the channel thread from blocking on the CDR handling
257  * Returns nothing
258  */
259 void ast_cdr_detach(struct ast_cdr *cdr);
260
261 /*! 
262  * \brief Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines 
263  * \param shutdown Whether or not we are shutting down
264  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
265  * Returns nothing
266  */
267 void ast_cdr_submit_batch(int shutdown);
268
269 /*! 
270  * \brief Set the destination channel, if there was one 
271  * \param cdr Which cdr it's applied to
272  * \param chan Channel to which dest will be
273  * Sets the destination channel the CDR is applied to
274  * Returns nothing
275  */
276 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
277
278 /*! 
279  * \brief Set the last executed application 
280  * \param cdr which cdr to act upon
281  * \param app the name of the app you wish to change it to
282  * \param data the data you want in the data field of app you set it to
283  * Changes the value of the last executed app
284  * Returns nothing
285  */
286 void ast_cdr_setapp(struct ast_cdr *cdr, const char *app, const char *data);
287
288 /*!
289  * \brief Set the answer time for a call
290  * \param cdr the cdr you wish to associate with the call
291  * \param t the answer time
292  * Starts all CDR stuff necessary for doing CDR when answering a call
293  * NULL argument is just fine.
294  */
295 void ast_cdr_setanswer(struct ast_cdr *cdr, struct timeval t);
296
297 /*!
298  * \brief Set the disposition for a call
299  * \param cdr the cdr you wish to associate with the call
300  * \param disposition the new disposition
301  * Set the disposition on a call.
302  * NULL argument is just fine.
303  */
304 void ast_cdr_setdisposition(struct ast_cdr *cdr, long int disposition);
305
306 /*! 
307  * \brief Convert a string to a detail record AMA flag 
308  * \param flag string form of flag
309  * Converts the string form of the flag to the binary form.
310  * \return the binary form of the flag
311  */
312 int ast_cdr_amaflags2int(const char *flag);
313
314 /*! 
315  * \brief Disposition to a string 
316  * \param disposition input binary form
317  * Converts the binary form of a disposition to string form.
318  * \return a pointer to the string form
319  */
320 char *ast_cdr_disp2str(int disposition);
321
322 /*! 
323  * \brief Reset the detail record, optionally posting it first 
324  * \param cdr which cdr to act upon
325  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
326  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
327  */
328 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
329
330 /*! Reset the detail record times, flags */
331 /*!
332  * \param cdr which cdr to act upon
333  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
334  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
335  */
336 void ast_cdr_specialized_reset(struct ast_cdr *cdr, struct ast_flags *flags);
337
338 /*! Flags to a string */
339 /*!
340  * \param flags binary flag
341  * Converts binary flags to string flags
342  * Returns string with flag name
343  */
344 char *ast_cdr_flags2str(int flags);
345
346 /*! 
347  * \brief Move the non-null data from the "from" cdr to the "to" cdr
348  * \param to the cdr to get the goodies
349  * \param from the cdr to give the goodies
350  */
351 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
352
353 /*! \brief Set account code, will generate AMI event */
354 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
355
356 /*! \brief Set AMA flags for channel */
357 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
358
359 /*! \brief Set CDR user field for channel (stored in CDR) */
360 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
361 /*! \brief Append to CDR user field for channel (stored in CDR) */
362 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
363
364
365 /*! Update CDR on a channel */
366 int ast_cdr_update(struct ast_channel *chan);
367
368
369 extern int ast_default_amaflags;
370
371 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
372
373 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
374
375 /*! \brief Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
376 int ast_cdr_engine_reload(void);
377
378 /*! \brief Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
379 int ast_cdr_engine_init(void);
380
381 /*! Submit any remaining CDRs and prepare for shutdown */
382 void ast_cdr_engine_term(void);
383
384 #endif /* _ASTERISK_CDR_H */