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