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