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