Use defined AST_MAX_ACCOUNT_CODE (bug #4350)
[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 _CDR_H
18 #define _CDR_H
19
20 #include "asterisk/channel.h"
21 #include <sys/time.h>
22 #define AST_CDR_FLAG_KEEP_VARS          (1 << 0)
23 #define AST_CDR_FLAG_POSTED                     (1 << 1)
24 #define AST_CDR_FLAG_LOCKED                     (1 << 2)
25 #define AST_CDR_FLAG_CHILD                      (1 << 3)
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 struct ast_channel;
41 AST_LIST_HEAD(varshead,ast_var_t);
42
43 /*! Responsible for call detail data */
44 struct ast_cdr {
45         /*! Caller*ID with text */
46         char clid[AST_MAX_EXTENSION];
47         /*! Caller*ID number */
48         char src[AST_MAX_EXTENSION];            
49         /*! Destination extension */
50         char dst[AST_MAX_EXTENSION];            
51         /*! Destination context */
52         char dcontext[AST_MAX_EXTENSION];       
53         
54         char channel[AST_MAX_EXTENSION];
55         /*! Destination channel if appropriate */
56         char dstchannel[AST_MAX_EXTENSION];     
57         /*! Last application if appropriate */
58         char lastapp[AST_MAX_EXTENSION];        
59         /*! Last application data */
60         char lastdata[AST_MAX_EXTENSION];       
61         
62         struct timeval start;
63         
64         struct timeval answer;
65         
66         struct timeval end;
67         /*! Total time in system, in seconds */
68         int duration;                           
69         /*! Total time call is up, in seconds */
70         int billsec;                            
71         /*! What happened to the call */
72         int disposition;                        
73         /*! What flags to use */
74         int amaflags;                           
75         /*! What account number to use */
76         char accountcode[AST_MAX_ACCOUNT_CODE];                 
77         /*! flags */
78         unsigned int flags;                             
79         /* Unique Channel Identifier */
80         char uniqueid[32];
81         /* User field */
82         char userfield[AST_MAX_USER_FIELD];
83
84         /* A linked list for variables */
85         struct varshead varshead;
86
87         struct ast_cdr *next;
88 };
89
90 extern void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur);
91 extern int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
92 extern int ast_cdr_serialize_variables(struct ast_cdr *cdr, char *buf, size_t size, char delim, char sep, int recur);
93 extern void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
94 extern int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
95
96 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
97
98 /*! Allocate a record */
99 /*! 
100  * Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure)
101  */
102 extern struct ast_cdr *ast_cdr_alloc(void);
103
104 /*! Free a record */
105 /* \param cdr ast_cdr structure to free
106  * Returns nothing important
107  */
108 extern void ast_cdr_free(struct ast_cdr *cdr);
109
110 /*! Initialize based on a channel */
111 /*! 
112  * \param cdr Call Detail Record to use for channel
113  * \param chan Channel to bind CDR with
114  * Initializes a CDR and associates it with a particular channel
115  * Return is negligible.  (returns 0 by default)
116  */
117 extern int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
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_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
127
128 /*! Register a CDR handling engine */
129 /*!
130  * \param name name associated with the particular CDR handler
131  * \param desc description of the CDR handler
132  * \param be function pointer to a CDR handler
133  * Used to register a Call Detail Record handler.
134  * Returns -1 on error, 0 on success.
135  */
136 extern int ast_cdr_register(char *name, char *desc, ast_cdrbe be);
137
138 /*! Unregister a CDR handling engine */
139 /*!
140  * \param name name of CDR handler to unregister
141  * Unregisters a CDR by it's name
142  */
143 extern void ast_cdr_unregister(char *name);
144
145 /*! Start a call */
146 /*!
147  * \param cdr the cdr you wish to associate with the call
148  * Starts all CDR stuff necessary for monitoring a call
149  * Returns nothing important
150  */
151 extern void ast_cdr_start(struct ast_cdr *cdr);
152
153 /*! Answer a call */
154 /*!
155  * \param cdr the cdr you wish to associate with the call
156  * Starts all CDR stuff necessary for doing CDR when answering a call
157  */
158 extern void ast_cdr_answer(struct ast_cdr *cdr);
159
160 /*! Busy a call */
161 /*!
162  * \param cdr the cdr you wish to associate with the call
163  * Returns nothing important
164  */
165 extern void ast_cdr_busy(struct ast_cdr *cdr);
166
167 /*! Fail a call */
168 /*!
169  * \param cdr the cdr you wish to associate with the call
170  * Returns nothing important
171  */
172 extern void ast_cdr_failed(struct ast_cdr *cdr);
173
174 /*! Save the result of the call based on the AST_CAUSE_* */
175 /*!
176  * \param cdr the cdr you wish to associate with the call
177  * Returns nothing important
178  * \param cause the AST_CAUSE_*
179  */
180 extern int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
181         
182 /*! End a call */
183 /*!
184  * \param cdr the cdr you have associated the call with
185  * Registers the end of call time in the cdr structure.
186  * Returns nothing important
187  */
188 extern void ast_cdr_end(struct ast_cdr *cdr);
189
190 /*! Post the detail record */
191 /*! 
192  * \param cdr Which cdr to post
193  * Actually outputs the CDR record to the CDR plugins installed
194  * Returns nothing
195  */
196 extern void ast_cdr_post(struct ast_cdr *cdr);
197
198 /*! Set the destination channel, if there was one */
199 /*!
200  * \param cdr Which cdr it's applied to
201  * Sets the destination channel the CDR is applied to
202  * Returns nothing
203  */
204 extern void ast_cdr_setdestchan(struct ast_cdr *cdr, char *chan);
205
206 /*! Set the last executed application */
207 /*!
208  * \param cdr which cdr to act upon
209  * \param app the name of the app you wish to change it to
210  * \param data the data you want in the data field of app you set it to
211  * Changes the value of the last executed app
212  * Returns nothing
213  */
214 extern void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data);
215
216 /*! Convert a string to a detail record AMA flag */
217 /*!
218  * \param flag string form of flag
219  * Converts the string form of the flag to the binary form.
220  * Returns the binary form of the flag
221  */
222 extern int ast_cdr_amaflags2int(const char *flag);
223
224 /*! Disposition to a string */
225 /*!
226  * \param flag input binary form
227  * Converts the binary form of a disposition to string form.
228  * Returns a pointer to the string form
229  */
230 extern char *ast_cdr_disp2str(int disposition);
231
232 /*! Reset the detail record, optionally posting it first */
233 /*!
234  * \param cdr which cdr to act upon
235  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
236  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
237  */
238 extern void ast_cdr_reset(struct ast_cdr *cdr, int flags);
239
240 /*! Flags to a string */
241 /*!
242  * \param flags binary flag
243  * Converts binary flags to string flags
244  * Returns string with flag name
245  */
246 extern char *ast_cdr_flags2str(int flags);
247
248 extern int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
249 extern int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
250
251
252 extern int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
253 extern int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
254
255
256 /* Update CDR on a channel */
257 extern int ast_cdr_update(struct ast_channel *chan);
258
259
260 extern int ast_default_amaflags;
261
262 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
263
264 extern struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
265
266 #endif /* _CDR_H */