Merged revisions 235635 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 #define AST_CDR_FLAG_ORIGINATED         (1 << 12)
43 /*@} */
44
45 /*! \name CDR Flags - Disposition */
46 /*@{ */
47 #define AST_CDR_NOANSWER                        0
48 #define AST_CDR_NULL                (1 << 0)
49 #define AST_CDR_FAILED                          (1 << 1)
50 #define AST_CDR_BUSY                            (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         /*! Account number of the last person we talked to */
103         char peeraccount[AST_MAX_ACCOUNT_CODE];
104         /*! flags */
105         unsigned int flags;
106         /*! Unique Channel Identifier
107          * 150 = 127 (max systemname) + "-" + 10 (epoch timestamp) + "." + 10 (monotonically incrementing integer) + NULL */
108         char uniqueid[150];
109         /* Linked group Identifier */
110         char linkedid[32];
111         /*! User field */
112         char userfield[AST_MAX_USER_FIELD];
113         /*! Sequence field */
114         int sequence;
115
116         /*! A linked list for variables */
117         struct varshead varshead;
118
119         struct ast_cdr *next;
120 };
121
122 int ast_cdr_isset_unanswered(void);
123 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
124 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
125 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur);
126 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
127 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
128
129 /*!
130  * \brief CDR backend callback
131  * \warning CDR backends should NOT attempt to access the channel associated
132  * with a CDR record.  This channel is not guaranteed to exist when the CDR
133  * backend is invoked.
134  */
135 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
136
137 /*! \brief Return TRUE if CDR subsystem is enabled */
138 int check_cdr_enabled(void);
139
140 /*! 
141  * \brief Allocate a CDR record 
142  * \retval a malloc'd ast_cdr structure
143  * \retval NULL on error (malloc failure)
144  */
145 struct ast_cdr *ast_cdr_alloc(void);
146
147 /*! 
148  * \brief Duplicate a record and increment the sequence number.
149  * \param cdr the record to duplicate
150  * \retval a malloc'd ast_cdr structure, 
151  * \retval NULL on error (malloc failure)
152  * \see ast_cdr_dup()
153  * \see ast_cdr_dup_unique_swap()
154  */
155 struct ast_cdr *ast_cdr_dup_unique(struct ast_cdr *cdr);
156
157 /*! 
158  * \brief Duplicate a record and increment the sequence number of the old
159  * record.
160  * \param cdr the record to duplicate
161  * \retval a malloc'd ast_cdr structure, 
162  * \retval NULL on error (malloc failure)
163  * \note This version increments the original CDR's sequence number rather than
164  * the duplicate's sequence number. The effect is as if the original CDR's
165  * sequence number was swapped with the duplicate's sequence number.
166  *
167  * \see ast_cdr_dup()
168  * \see ast_cdr_dup_unique()
169  */
170 struct ast_cdr *ast_cdr_dup_unique_swap(struct ast_cdr *cdr);
171
172 /*! 
173  * \brief Duplicate a record 
174  * \param cdr the record to duplicate
175  * \retval a malloc'd ast_cdr structure, 
176  * \retval NULL on error (malloc failure)
177  * \see ast_cdr_dup_unique()
178  * \see ast_cdr_dup_unique_swap()
179  */
180 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
181
182 /*! 
183  * \brief Free a CDR record 
184  * \param cdr ast_cdr structure to free
185  * Returns nothing
186  */
187 void ast_cdr_free(struct ast_cdr *cdr);
188
189 /*! 
190  * \brief Discard and free a CDR record 
191  * \param cdr ast_cdr structure to free
192  * Returns nothing  -- same as free, but no checks or complaints
193  */
194 void ast_cdr_discard(struct ast_cdr *cdr);
195
196 /*! 
197  * \brief Initialize based on a channel
198  * \param cdr Call Detail Record to use for channel
199  * \param chan Channel to bind CDR with
200  * Initializes a CDR and associates it with a particular channel
201  * \return 0 by default
202  */
203 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
204
205 /*! 
206  * \brief Initialize based on a channel 
207  * \param cdr Call Detail Record to use for channel
208  * \param chan Channel to bind CDR with
209  * Initializes a CDR and associates it with a particular channel
210  * \return 0 by default
211  */
212 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
213
214 /*! 
215  * \brief Register a CDR handling engine 
216  * \param name name associated with the particular CDR handler
217  * \param desc description of the CDR handler
218  * \param be function pointer to a CDR handler
219  * Used to register a Call Detail Record handler.
220  * \retval 0 on success.
221  * \retval -1 on error
222  */
223 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
224
225 /*! 
226  * \brief Unregister a CDR handling engine 
227  * \param name name of CDR handler to unregister
228  * Unregisters a CDR by it's name
229  */
230 void ast_cdr_unregister(const char *name);
231
232 /*! 
233  * \brief Start a call 
234  * \param cdr the cdr you wish to associate with the call
235  * Starts all CDR stuff necessary for monitoring a call
236  * Returns nothing
237  */
238 void ast_cdr_start(struct ast_cdr *cdr);
239
240 /*! \brief Answer a call 
241  * \param cdr the cdr you wish to associate with the call
242  * Starts all CDR stuff necessary for doing CDR when answering a call
243  * \note NULL argument is just fine.
244  */
245 void ast_cdr_answer(struct ast_cdr *cdr);
246
247 /*! 
248  * \brief A call wasn't answered 
249  * \param cdr the cdr you wish to associate with the call
250  * Marks the channel disposition as "NO ANSWER"
251  * Will skip CDR's in chain with ANS_LOCK bit set. (see
252  * forkCDR() application.
253  */
254 extern void ast_cdr_noanswer(struct ast_cdr *cdr);
255
256 /*! 
257  * \brief Busy a call 
258  * \param cdr the cdr you wish to associate with the call
259  * Marks the channel disposition as "BUSY"
260  * Will skip CDR's in chain with ANS_LOCK bit set. (see
261  * forkCDR() application.
262  * Returns nothing
263  */
264 void ast_cdr_busy(struct ast_cdr *cdr);
265
266 /*! 
267  * \brief Fail a call 
268  * \param cdr the cdr you wish to associate with the call
269  * Marks the channel disposition as "FAILED"
270  * Will skip CDR's in chain with ANS_LOCK bit set. (see
271  * forkCDR() application.
272  * Returns nothing
273  */
274 void ast_cdr_failed(struct ast_cdr *cdr);
275
276 /*! 
277  * \brief Save the result of the call based on the AST_CAUSE_*
278  * \param cdr the cdr you wish to associate with the call
279  * \param cause the AST_CAUSE_*
280  * Returns nothing
281  */
282 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
283         
284 /*! 
285  * \brief End a call
286  * \param cdr the cdr you have associated the call with
287  * Registers the end of call time in the cdr structure.
288  * Returns nothing
289  */
290 void ast_cdr_end(struct ast_cdr *cdr);
291
292 /*! 
293  * \brief Detaches the detail record for posting (and freeing) either now or at a
294  * later time in bulk with other records during batch mode operation.
295  * \param cdr Which CDR to detach from the channel thread
296  * Prevents the channel thread from blocking on the CDR handling
297  * Returns nothing
298  */
299 void ast_cdr_detach(struct ast_cdr *cdr);
300
301 /*! 
302  * \brief Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines 
303  * \param shutdown Whether or not we are shutting down
304  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
305  * Returns nothing
306  */
307 void ast_cdr_submit_batch(int shutdown);
308
309 /*! 
310  * \brief Set the destination channel, if there was one 
311  * \param cdr Which cdr it's applied to
312  * \param chan Channel to which dest will be
313  * Sets the destination channel the CDR is applied to
314  * Returns nothing
315  */
316 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
317
318 /*! 
319  * \brief Set the last executed application 
320  * \param cdr which cdr to act upon
321  * \param app the name of the app you wish to change it to
322  * \param data the data you want in the data field of app you set it to
323  * Changes the value of the last executed app
324  * Returns nothing
325  */
326 void ast_cdr_setapp(struct ast_cdr *cdr, const char *app, const char *data);
327
328 /*!
329  * \brief Set the answer time for a call
330  * \param cdr the cdr you wish to associate with the call
331  * \param t the answer time
332  * Starts all CDR stuff necessary for doing CDR when answering a call
333  * NULL argument is just fine.
334  */
335 void ast_cdr_setanswer(struct ast_cdr *cdr, struct timeval t);
336
337 /*!
338  * \brief Set the disposition for a call
339  * \param cdr the cdr you wish to associate with the call
340  * \param disposition the new disposition
341  * Set the disposition on a call.
342  * NULL argument is just fine.
343  */
344 void ast_cdr_setdisposition(struct ast_cdr *cdr, long int disposition);
345
346 /*! 
347  * \brief Convert a string to a detail record AMA flag 
348  * \param flag string form of flag
349  * Converts the string form of the flag to the binary form.
350  * \return the binary form of the flag
351  */
352 int ast_cdr_amaflags2int(const char *flag);
353
354 /*! 
355  * \brief Disposition to a string 
356  * \param disposition input binary form
357  * Converts the binary form of a disposition to string form.
358  * \return a pointer to the string form
359  */
360 char *ast_cdr_disp2str(int disposition);
361
362 /*! 
363  * \brief Reset the detail record, optionally posting it first 
364  * \param cdr which cdr to act upon
365  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
366  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
367  */
368 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
369
370 /*! Reset the detail record times, flags */
371 /*!
372  * \param cdr which cdr to act upon
373  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
374  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
375  */
376 void ast_cdr_specialized_reset(struct ast_cdr *cdr, struct ast_flags *flags);
377
378 /*! Flags to a string */
379 /*!
380  * \param flags binary flag
381  * Converts binary flags to string flags
382  * Returns string with flag name
383  */
384 char *ast_cdr_flags2str(int flags);
385
386 /*! 
387  * \brief Move the non-null data from the "from" cdr to the "to" cdr
388  * \param to the cdr to get the goodies
389  * \param from the cdr to give the goodies
390  */
391 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
392
393 /*! \brief Set account code, will generate AMI event */
394 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
395
396 /*! \brief Set the peer account */
397 int ast_cdr_setpeeraccount(struct ast_channel *chan, const char *account);
398
399 /*! \brief Set AMA flags for channel */
400 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
401
402 /*! \brief Set CDR user field for channel (stored in CDR) */
403 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
404 /*! \brief Append to CDR user field for channel (stored in CDR) */
405 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
406
407
408 /*! Update CDR on a channel */
409 int ast_cdr_update(struct ast_channel *chan);
410
411
412 extern int ast_default_amaflags;
413
414 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
415
416 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
417
418 /*! \brief Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
419 int ast_cdr_engine_reload(void);
420
421 /*! \brief Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
422 int ast_cdr_engine_init(void);
423
424 /*! Submit any remaining CDRs and prepare for shutdown */
425 void ast_cdr_engine_term(void);
426
427 #endif /* _ASTERISK_CDR_H */