e6fbe96ffe64b2093ff79ce0cf44b798d8843ca7
[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, char *buf, size_t size, 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 Allocate a CDR record 
106  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
107  */
108 struct ast_cdr *ast_cdr_alloc(void);
109
110 /*! \brief Duplicate a record 
111  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
112  */
113 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
114
115 /*! \brief Free a CDR record 
116  * \param cdr ast_cdr structure to free
117  * Returns nothing important
118  */
119 void ast_cdr_free(struct ast_cdr *cdr);
120
121 /*! \brief Initialize based on a channel
122  * \param cdr Call Detail Record to use for channel
123  * \param chan Channel to bind CDR with
124  * Initializes a CDR and associates it with a particular channel
125  * Return is negligible.  (returns 0 by default)
126  */
127 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
128
129 /*! Initialize based on a channel */
130 /*! 
131  * \param cdr Call Detail Record to use for channel
132  * \param chan Channel to bind CDR with
133  * Initializes a CDR and associates it with a particular channel
134  * Return is negligible.  (returns 0 by default)
135  */
136 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
137
138 /*! Register a CDR handling engine */
139 /*!
140  * \param name name associated with the particular CDR handler
141  * \param desc description of the CDR handler
142  * \param be function pointer to a CDR handler
143  * Used to register a Call Detail Record handler.
144  * Returns -1 on error, 0 on success.
145  */
146 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
147
148 /*! Unregister a CDR handling engine */
149 /*!
150  * \param name name of CDR handler to unregister
151  * Unregisters a CDR by it's name
152  */
153 void ast_cdr_unregister(const char *name);
154
155 /*! Start a call */
156 /*!
157  * \param cdr the cdr you wish to associate with the call
158  * Starts all CDR stuff necessary for monitoring a call
159  * Returns nothing important
160  */
161 void ast_cdr_start(struct ast_cdr *cdr);
162
163 /*! Answer a call */
164 /*!
165  * \param cdr the cdr you wish to associate with the call
166  * Starts all CDR stuff necessary for doing CDR when answering a call
167  * NULL argument is just fine.
168  */
169 void ast_cdr_answer(struct ast_cdr *cdr);
170
171 /*! Busy a call */
172 /*!
173  * \param cdr the cdr you wish to associate with the call
174  * Returns nothing important
175  */
176 void ast_cdr_busy(struct ast_cdr *cdr);
177
178 /*! Fail a call */
179 /*!
180  * \param cdr the cdr you wish to associate with the call
181  * Returns nothing important
182  */
183 void ast_cdr_failed(struct ast_cdr *cdr);
184
185 /*! Save the result of the call based on the AST_CAUSE_* */
186 /*!
187  * \param cdr the cdr you wish to associate with the call
188  * Returns nothing important
189  * \param cause the AST_CAUSE_*
190  */
191 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
192         
193 /*! End a call */
194 /*!
195  * \param cdr the cdr you have associated the call with
196  * Registers the end of call time in the cdr structure.
197  * Returns nothing important
198  */
199 void ast_cdr_end(struct ast_cdr *cdr);
200
201 /*! Detaches the detail record for posting (and freeing) either now or at a
202  * later time in bulk with other records during batch mode operation */
203 /*! 
204  * \param cdr Which CDR to detach from the channel thread
205  * Prevents the channel thread from blocking on the CDR handling
206  * Returns nothing
207  */
208 void ast_cdr_detach(struct ast_cdr *cdr);
209
210 /*! Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines */
211 /*!
212  * \param shutdown Whether or not we are shutting down
213  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
214  * Returns nothing
215  */
216 void ast_cdr_submit_batch(int shutdown);
217
218 /*! Set the destination channel, if there was one */
219 /*!
220  * \param cdr Which cdr it's applied to
221  * \param chan Channel to which dest will be
222  * Sets the destination channel the CDR is applied to
223  * Returns nothing
224  */
225 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
226
227 /*! Set the last executed application */
228 /*!
229  * \param cdr which cdr to act upon
230  * \param app the name of the app you wish to change it to
231  * \param data the data you want in the data field of app you set it to
232  * Changes the value of the last executed app
233  * Returns nothing
234  */
235 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
236
237 /*! Convert a string to a detail record AMA flag */
238 /*!
239  * \param flag string form of flag
240  * Converts the string form of the flag to the binary form.
241  * Returns the binary form of the flag
242  */
243 int ast_cdr_amaflags2int(const char *flag);
244
245 /*! Disposition to a string */
246 /*!
247  * \param disposition input binary form
248  * Converts the binary form of a disposition to string form.
249  * Returns a pointer to the string form
250  */
251 char *ast_cdr_disp2str(int disposition);
252
253 /*! Reset the detail record, optionally posting it first */
254 /*!
255  * \param cdr which cdr to act upon
256  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
257  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
258  */
259 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
260
261 /*! Flags to a string */
262 /*!
263  * \param flags binary flag
264  * Converts binary flags to string flags
265  * Returns string with flag name
266  */
267 char *ast_cdr_flags2str(int flags);
268
269 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
270 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
271
272
273 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
274 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
275
276
277 /* Update CDR on a channel */
278 int ast_cdr_update(struct ast_channel *chan);
279
280
281 extern int ast_default_amaflags;
282
283 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
284
285 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
286
287 /*! Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
288 int ast_cdr_engine_reload(void);
289
290 /*! Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
291 int ast_cdr_engine_init(void);
292
293 /*! Submit any remaining CDRs and prepare for shutdown */
294 void ast_cdr_engine_term(void);
295
296 #endif /* _ASTERISK_CDR_H */