Add option for logging congested calls as CONGESTION instead of NO_ANSWER in CDR
[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 /*!
20  * \file
21  * \brief Call Detail Record API
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 #ifndef _ASTERISK_CDR_H
27 #define _ASTERISK_CDR_H
28
29 #include <sys/time.h>
30
31 #include "asterisk/data.h"
32
33 /*!
34  * \brief CDR Flags
35  */
36 enum {
37         AST_CDR_FLAG_KEEP_VARS     = (1 << 0),
38         AST_CDR_FLAG_POSTED        = (1 << 1),
39         AST_CDR_FLAG_LOCKED        = (1 << 2),
40         AST_CDR_FLAG_CHILD         = (1 << 3),
41         AST_CDR_FLAG_POST_DISABLED = (1 << 4),
42         AST_CDR_FLAG_BRIDGED       = (1 << 5),
43         AST_CDR_FLAG_MAIN          = (1 << 6),
44         AST_CDR_FLAG_ENABLE        = (1 << 7),
45         AST_CDR_FLAG_ANSLOCKED     = (1 << 8),
46         AST_CDR_FLAG_DONT_TOUCH    = (1 << 9),
47         AST_CDR_FLAG_POST_ENABLE   = (1 << 10),
48         AST_CDR_FLAG_DIALED        = (1 << 11),
49         AST_CDR_FLAG_ORIGINATED    = (1 << 12),
50 };
51
52 /*!
53  * \brief CDR Flags - Disposition
54  */
55 enum {
56         AST_CDR_NOANSWER = 0,
57         AST_CDR_NULL     = (1 << 0),
58         AST_CDR_FAILED   = (1 << 1),
59         AST_CDR_BUSY     = (1 << 2),
60         AST_CDR_ANSWERED = (1 << 3),
61         AST_CDR_CONGESTION = (1 << 4),
62 };
63
64 /*!
65  * \brief CDR AMA Flags
66  */
67 enum {
68         AST_CDR_OMIT          = 1,
69         AST_CDR_BILLING       = 2,
70         AST_CDR_DOCUMENTATION = 3,
71 };
72
73 #define AST_MAX_USER_FIELD     256
74 #define AST_MAX_ACCOUNT_CODE   20
75
76 /* Include channel.h after relevant declarations it will need */
77 #include "asterisk/channel.h"
78 #include "asterisk/utils.h"
79
80 /*!
81  * \brief Responsible for call detail data
82  */
83 struct ast_cdr {
84         /*! Caller*ID with text */
85         char clid[AST_MAX_EXTENSION];
86         /*! Caller*ID number */
87         char src[AST_MAX_EXTENSION];
88         /*! Destination extension */
89         char dst[AST_MAX_EXTENSION];
90         /*! Destination context */
91         char dcontext[AST_MAX_EXTENSION];
92
93         char channel[AST_MAX_EXTENSION];
94         /*! Destination channel if appropriate */
95         char dstchannel[AST_MAX_EXTENSION];
96         /*! Last application if appropriate */
97         char lastapp[AST_MAX_EXTENSION];
98         /*! Last application data */
99         char lastdata[AST_MAX_EXTENSION];
100
101         struct timeval start;
102
103         struct timeval answer;
104
105         struct timeval end;
106         /*! Total time in system, in seconds */
107         long int duration;
108         /*! Total time call is up, in seconds */
109         long int billsec;
110         /*! What happened to the call */
111         long int disposition;
112         /*! What flags to use */
113         long int amaflags;
114         /*! What account number to use */
115         char accountcode[AST_MAX_ACCOUNT_CODE];
116         /*! Account number of the last person we talked to */
117         char peeraccount[AST_MAX_ACCOUNT_CODE];
118         /*! flags */
119         unsigned int flags;
120         /*! Unique Channel Identifier
121          * 150 = 127 (max systemname) + "-" + 10 (epoch timestamp) + "." + 10 (monotonically incrementing integer) + NULL */
122         char uniqueid[150];
123         /* Linked group Identifier */
124         char linkedid[32];
125         /*! User field */
126         char userfield[AST_MAX_USER_FIELD];
127         /*! Sequence field */
128         int sequence;
129
130         /*! A linked list for variables */
131         struct varshead varshead;
132
133         struct ast_cdr *next;
134 };
135
136 int ast_cdr_isset_unanswered(void);
137 int ast_cdr_isset_congestion(void);
138 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw);
139 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur);
140 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur);
141 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur);
142 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr);
143
144 /*!
145  * \brief CDR backend callback
146  * \warning CDR backends should NOT attempt to access the channel associated
147  * with a CDR record.  This channel is not guaranteed to exist when the CDR
148  * backend is invoked.
149  */
150 typedef int (*ast_cdrbe)(struct ast_cdr *cdr);
151
152 /*! \brief Return TRUE if CDR subsystem is enabled */
153 int check_cdr_enabled(void);
154
155 /*!
156  * \brief Allocate a CDR record
157  * \retval a malloc'd ast_cdr structure
158  * \retval NULL on error (malloc failure)
159  */
160 struct ast_cdr *ast_cdr_alloc(void);
161
162 /*!
163  * \brief Duplicate a record and increment the sequence number.
164  * \param cdr the record to duplicate
165  * \retval a malloc'd ast_cdr structure,
166  * \retval NULL on error (malloc failure)
167  * \see ast_cdr_dup()
168  * \see ast_cdr_dup_unique_swap()
169  */
170 struct ast_cdr *ast_cdr_dup_unique(struct ast_cdr *cdr);
171
172 /*!
173  * \brief Duplicate a record and increment the sequence number of the old
174  * record.
175  * \param cdr the record to duplicate
176  * \retval a malloc'd ast_cdr structure,
177  * \retval NULL on error (malloc failure)
178  * \note This version increments the original CDR's sequence number rather than
179  * the duplicate's sequence number. The effect is as if the original CDR's
180  * sequence number was swapped with the duplicate's sequence number.
181  *
182  * \see ast_cdr_dup()
183  * \see ast_cdr_dup_unique()
184  */
185 struct ast_cdr *ast_cdr_dup_unique_swap(struct ast_cdr *cdr);
186
187 /*!
188  * \brief Duplicate a record
189  * \param cdr the record to duplicate
190  * \retval a malloc'd ast_cdr structure,
191  * \retval NULL on error (malloc failure)
192  * \see ast_cdr_dup_unique()
193  * \see ast_cdr_dup_unique_swap()
194  */
195 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr);
196
197 /*!
198  * \brief Free a CDR record
199  * \param cdr ast_cdr structure to free
200  * Returns nothing
201  */
202 void ast_cdr_free(struct ast_cdr *cdr);
203
204 /*!
205  * \brief Discard and free a CDR record
206  * \param cdr ast_cdr structure to free
207  * Returns nothing  -- same as free, but no checks or complaints
208  */
209 void ast_cdr_discard(struct ast_cdr *cdr);
210
211 /*!
212  * \brief Initialize based on a channel
213  * \param cdr Call Detail Record to use for channel
214  * \param chan Channel to bind CDR with
215  * Initializes a CDR and associates it with a particular channel
216  * \return 0 by default
217  */
218 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *chan);
219
220 /*!
221  * \brief Initialize based on a channel
222  * \param cdr Call Detail Record to use for channel
223  * \param chan Channel to bind CDR with
224  * Initializes a CDR and associates it with a particular channel
225  * \return 0 by default
226  */
227 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *chan);
228
229 /*!
230  * \brief Register a CDR handling engine
231  * \param name name associated with the particular CDR handler
232  * \param desc description of the CDR handler
233  * \param be function pointer to a CDR handler
234  * Used to register a Call Detail Record handler.
235  * \retval 0 on success.
236  * \retval -1 on error
237  */
238 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be);
239
240 /*!
241  * \brief Unregister a CDR handling engine
242  * \param name name of CDR handler to unregister
243  * Unregisters a CDR by it's name
244  */
245 void ast_cdr_unregister(const char *name);
246
247 /*!
248  * \brief Start a call
249  * \param cdr the cdr you wish to associate with the call
250  * Starts all CDR stuff necessary for monitoring a call
251  * Returns nothing
252  */
253 void ast_cdr_start(struct ast_cdr *cdr);
254
255 /*! \brief Answer a call
256  * \param cdr the cdr you wish to associate with the call
257  * Starts all CDR stuff necessary for doing CDR when answering a call
258  * \note NULL argument is just fine.
259  */
260 void ast_cdr_answer(struct ast_cdr *cdr);
261
262 /*!
263  * \brief A call wasn't answered
264  * \param cdr the cdr you wish to associate with the call
265  * Marks the channel disposition as "NO ANSWER"
266  * Will skip CDR's in chain with ANS_LOCK bit set. (see
267  * forkCDR() application.
268  */
269 extern void ast_cdr_noanswer(struct ast_cdr *cdr);
270
271 /*!
272  * \brief A call was set to congestion
273  * \param cdr the cdr you wish to associate with the call
274  * Markst he channel disposition as "CONGESTION"
275  * Will skip CDR's in chain with ANS_LOCK bit set. (see
276  * forkCDR() application
277  */
278 extern void ast_cdr_congestion(struct ast_cdr *cdr);
279
280 /*!
281  * \brief Busy a call
282  * \param cdr the cdr you wish to associate with the call
283  * Marks the channel disposition as "BUSY"
284  * Will skip CDR's in chain with ANS_LOCK bit set. (see
285  * forkCDR() application.
286  * Returns nothing
287  */
288 void ast_cdr_busy(struct ast_cdr *cdr);
289
290 /*!
291  * \brief Fail a call
292  * \param cdr the cdr you wish to associate with the call
293  * Marks the channel disposition as "FAILED"
294  * Will skip CDR's in chain with ANS_LOCK bit set. (see
295  * forkCDR() application.
296  * Returns nothing
297  */
298 void ast_cdr_failed(struct ast_cdr *cdr);
299
300 /*!
301  * \brief Save the result of the call based on the AST_CAUSE_*
302  * \param cdr the cdr you wish to associate with the call
303  * \param cause the AST_CAUSE_*
304  * Returns nothing
305  */
306 int ast_cdr_disposition(struct ast_cdr *cdr, int cause);
307
308 /*!
309  * \brief End a call
310  * \param cdr the cdr you have associated the call with
311  * Registers the end of call time in the cdr structure.
312  * Returns nothing
313  */
314 void ast_cdr_end(struct ast_cdr *cdr);
315
316 /*!
317  * \brief Detaches the detail record for posting (and freeing) either now or at a
318  * later time in bulk with other records during batch mode operation.
319  * \param cdr Which CDR to detach from the channel thread
320  * Prevents the channel thread from blocking on the CDR handling
321  * Returns nothing
322  */
323 void ast_cdr_detach(struct ast_cdr *cdr);
324
325 /*!
326  * \brief Spawns (possibly) a new thread to submit a batch of CDRs to the backend engines
327  * \param shutdown Whether or not we are shutting down
328  * Blocks the asterisk shutdown procedures until the CDR data is submitted.
329  * Returns nothing
330  */
331 void ast_cdr_submit_batch(int shutdown);
332
333 /*!
334  * \brief Set the destination channel, if there was one
335  * \param cdr Which cdr it's applied to
336  * \param chan Channel to which dest will be
337  * Sets the destination channel the CDR is applied to
338  * Returns nothing
339  */
340 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chan);
341
342 /*!
343  * \brief Set the last executed application
344  * \param cdr which cdr to act upon
345  * \param app the name of the app you wish to change it to
346  * \param data the data you want in the data field of app you set it to
347  * Changes the value of the last executed app
348  * Returns nothing
349  */
350 void ast_cdr_setapp(struct ast_cdr *cdr, const char *app, const char *data);
351
352 /*!
353  * \brief Set the answer time for a call
354  * \param cdr the cdr you wish to associate with the call
355  * \param t the answer time
356  * Starts all CDR stuff necessary for doing CDR when answering a call
357  * NULL argument is just fine.
358  */
359 void ast_cdr_setanswer(struct ast_cdr *cdr, struct timeval t);
360
361 /*!
362  * \brief Set the disposition for a call
363  * \param cdr the cdr you wish to associate with the call
364  * \param disposition the new disposition
365  * Set the disposition on a call.
366  * NULL argument is just fine.
367  */
368 void ast_cdr_setdisposition(struct ast_cdr *cdr, long int disposition);
369
370 /*!
371  * \brief Convert a string to a detail record AMA flag
372  * \param flag string form of flag
373  * Converts the string form of the flag to the binary form.
374  * \return the binary form of the flag
375  */
376 int ast_cdr_amaflags2int(const char *flag);
377
378 /*!
379  * \brief Disposition to a string
380  * \param disposition input binary form
381  * Converts the binary form of a disposition to string form.
382  * \return a pointer to the string form
383  */
384 char *ast_cdr_disp2str(int disposition);
385
386 /*!
387  * \brief Reset the detail record, optionally posting it first
388  * \param cdr which cdr to act upon
389  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
390  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
391  */
392 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *flags);
393
394 /*! Reset the detail record times, flags */
395 /*!
396  * \param cdr which cdr to act upon
397  * \param flags |AST_CDR_FLAG_POSTED whether or not to post the cdr first before resetting it
398  *              |AST_CDR_FLAG_LOCKED whether or not to reset locked CDR's
399  */
400 void ast_cdr_specialized_reset(struct ast_cdr *cdr, struct ast_flags *flags);
401
402 /*! Flags to a string */
403 /*!
404  * \param flags binary flag
405  * Converts binary flags to string flags
406  * Returns string with flag name
407  */
408 char *ast_cdr_flags2str(int flags);
409
410 /*!
411  * \brief Move the non-null data from the "from" cdr to the "to" cdr
412  * \param to the cdr to get the goodies
413  * \param from the cdr to give the goodies
414  */
415 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from);
416
417 /*! \brief Set account code, will generate AMI event */
418 int ast_cdr_setaccount(struct ast_channel *chan, const char *account);
419
420 /*! \brief Set the peer account */
421 int ast_cdr_setpeeraccount(struct ast_channel *chan, const char *account);
422
423 /*! \brief Set AMA flags for channel */
424 int ast_cdr_setamaflags(struct ast_channel *chan, const char *amaflags);
425
426 /*! \brief Set CDR user field for channel (stored in CDR) */
427 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield);
428 /*! \brief Append to CDR user field for channel (stored in CDR) */
429 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield);
430
431
432 /*! Update CDR on a channel */
433 int ast_cdr_update(struct ast_channel *chan);
434
435
436 extern int ast_default_amaflags;
437
438 extern char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
439
440 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr);
441
442 /*! \brief Reload the configuration file cdr.conf and start/stop CDR scheduling thread */
443 int ast_cdr_engine_reload(void);
444
445 /*! \brief Load the configuration file cdr.conf and possibly start the CDR scheduling thread */
446 int ast_cdr_engine_init(void);
447
448 /*! Submit any remaining CDRs and prepare for shutdown */
449 void ast_cdr_engine_term(void);
450
451 /*!
452  * \brief
453  * \param[in] tree Where to insert the cdr.
454  * \param[in] cdr The cdr structure to insert in 'tree'.
455  * \param[in] recur Go throw all the cdr levels.
456  * \retval <0 on error.
457  * \retval 0 on success.
458  */
459 int ast_cdr_data_add_structure(struct ast_data *tree, struct ast_cdr *cdr, int recur);
460
461 #endif /* _ASTERISK_CDR_H */