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