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