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