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