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