d19f6a8ad228c979ecc21aaa2d4c38e7aff737c5
[asterisk/asterisk.git] / main / cdr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, 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 /*! \file
20  *
21  * \brief Call Detail Record API 
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \note Includes code and algorithms from the Zapata library.
26  *
27  * \note We do a lot of checking here in the CDR code to try to be sure we don't ever let a CDR slip
28  * through our fingers somehow.  If someone allocates a CDR, it must be completely handled normally
29  * or a WARNING shall be logged, so that we can best keep track of any escape condition where the CDR
30  * isn't properly generated and posted.
31  */
32
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include <unistd.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <stdio.h>
42 #include <signal.h>
43
44 #include "asterisk/lock.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/cdr.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/callerid.h"
49 #include "asterisk/causes.h"
50 #include "asterisk/options.h"
51 #include "asterisk/linkedlists.h"
52 #include "asterisk/utils.h"
53 #include "asterisk/sched.h"
54 #include "asterisk/config.h"
55 #include "asterisk/cli.h"
56 #include "asterisk/stringfields.h"
57
58 /*! Default AMA flag for billing records (CDR's) */
59 int ast_default_amaflags = AST_CDR_DOCUMENTATION;
60 char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
61
62 struct ast_cdr_beitem {
63         char name[20];
64         char desc[80];
65         ast_cdrbe be;
66         AST_RWLIST_ENTRY(ast_cdr_beitem) list;
67 };
68
69 static AST_RWLIST_HEAD_STATIC(be_list, ast_cdr_beitem);
70
71 struct ast_cdr_batch_item {
72         struct ast_cdr *cdr;
73         struct ast_cdr_batch_item *next;
74 };
75
76 static struct ast_cdr_batch {
77         int size;
78         struct ast_cdr_batch_item *head;
79         struct ast_cdr_batch_item *tail;
80 } *batch = NULL;
81
82 static struct sched_context *sched;
83 static int cdr_sched = -1;
84 static pthread_t cdr_thread = AST_PTHREADT_NULL;
85
86 #define BATCH_SIZE_DEFAULT 100
87 #define BATCH_TIME_DEFAULT 300
88 #define BATCH_SCHEDULER_ONLY_DEFAULT 0
89 #define BATCH_SAFE_SHUTDOWN_DEFAULT 1
90
91 static int enabled;             /*! Is the CDR subsystem enabled ? */
92 static int batchmode;
93 static int batchsize;
94 static int batchtime;
95 static int batchscheduleronly;
96 static int batchsafeshutdown;
97
98 AST_MUTEX_DEFINE_STATIC(cdr_batch_lock);
99
100 /* these are used to wake up the CDR thread when there's work to do */
101 AST_MUTEX_DEFINE_STATIC(cdr_pending_lock);
102 static ast_cond_t cdr_pending_cond;
103
104 int check_cdr_enabled()
105 {
106         return enabled;
107 }
108
109 /*! Register a CDR driver. Each registered CDR driver generates a CDR 
110         \return 0 on success, -1 on failure 
111 */
112 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
113 {
114         struct ast_cdr_beitem *i = NULL;
115
116         if (!name)
117                 return -1;
118
119         if (!be) {
120                 ast_log(LOG_WARNING, "CDR engine '%s' lacks backend\n", name);
121                 return -1;
122         }
123
124         AST_RWLIST_WRLOCK(&be_list);
125         AST_RWLIST_TRAVERSE(&be_list, i, list) {
126                 if (!strcasecmp(name, i->name)) {
127                         ast_log(LOG_WARNING, "Already have a CDR backend called '%s'\n", name);
128                         AST_RWLIST_UNLOCK(&be_list);
129                         return -1;
130                 }
131         }
132
133         if (!(i = ast_calloc(1, sizeof(*i))))   
134                 return -1;
135
136         i->be = be;
137         ast_copy_string(i->name, name, sizeof(i->name));
138         ast_copy_string(i->desc, desc, sizeof(i->desc));
139
140         AST_RWLIST_INSERT_HEAD(&be_list, i, list);
141         AST_RWLIST_UNLOCK(&be_list);
142
143         return 0;
144 }
145
146 /*! unregister a CDR driver */
147 void ast_cdr_unregister(const char *name)
148 {
149         struct ast_cdr_beitem *i = NULL;
150
151         AST_RWLIST_WRLOCK(&be_list);
152         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&be_list, i, list) {
153                 if (!strcasecmp(name, i->name)) {
154                         AST_RWLIST_REMOVE_CURRENT(&be_list, list);
155                         if (option_verbose > 1)
156                                 ast_verbose(VERBOSE_PREFIX_2 "Unregistered '%s' CDR backend\n", name);
157                         ast_free(i);
158                         break;
159                 }
160         }
161         AST_RWLIST_TRAVERSE_SAFE_END;
162         AST_RWLIST_UNLOCK(&be_list);
163 }
164
165 /*! Duplicate a CDR record 
166         \returns Pointer to new CDR record
167 */
168 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr) 
169 {
170         struct ast_cdr *newcdr;
171         
172         if (!cdr) /* don't die if we get a null cdr pointer */
173                 return NULL;
174         newcdr = ast_cdr_alloc();
175         if (!newcdr)
176                 return NULL;
177
178         memcpy(newcdr, cdr, sizeof(*newcdr));
179         /* The varshead is unusable, volatile even, after the memcpy so we take care of that here */
180         memset(&newcdr->varshead, 0, sizeof(newcdr->varshead));
181         ast_cdr_copy_vars(newcdr, cdr);
182         newcdr->next = NULL;
183
184         return newcdr;
185 }
186
187 static const char *ast_cdr_getvar_internal(struct ast_cdr *cdr, const char *name, int recur) 
188 {
189         if (ast_strlen_zero(name))
190                 return NULL;
191
192         for (; cdr; cdr = recur ? cdr->next : NULL) {
193                 struct ast_var_t *variables;
194                 struct varshead *headp = &cdr->varshead;
195                 AST_LIST_TRAVERSE(headp, variables, entries) {
196                         if (!strcasecmp(name, ast_var_name(variables)))
197                                 return ast_var_value(variables);
198                 }
199         }
200
201         return NULL;
202 }
203
204 static void cdr_get_tv(struct timeval tv, const char *fmt, char *buf, int bufsize)
205 {
206         if (fmt == NULL) {      /* raw mode */
207                 snprintf(buf, bufsize, "%ld.%06ld", (long)tv.tv_sec, (long)tv.tv_usec);
208         } else {  
209                 time_t t = tv.tv_sec;
210                 if (t) {
211                         struct tm tm;
212
213                         ast_localtime(&t, &tm, NULL);
214                         strftime(buf, bufsize, fmt, &tm);
215                 }
216         }
217 }
218
219 /*! CDR channel variable retrieval */
220 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw) 
221 {
222         const char *fmt = "%Y-%m-%d %T";
223         const char *varbuf;
224
225         if (!cdr)  /* don't die if the cdr is null */
226                 return;
227
228         *ret = NULL;
229         /* special vars (the ones from the struct ast_cdr when requested by name) 
230            I'd almost say we should convert all the stringed vals to vars */
231
232         if (!strcasecmp(name, "clid"))
233                 ast_copy_string(workspace, cdr->clid, workspacelen);
234         else if (!strcasecmp(name, "src"))
235                 ast_copy_string(workspace, cdr->src, workspacelen);
236         else if (!strcasecmp(name, "dst"))
237                 ast_copy_string(workspace, cdr->dst, workspacelen);
238         else if (!strcasecmp(name, "dcontext"))
239                 ast_copy_string(workspace, cdr->dcontext, workspacelen);
240         else if (!strcasecmp(name, "channel"))
241                 ast_copy_string(workspace, cdr->channel, workspacelen);
242         else if (!strcasecmp(name, "dstchannel"))
243                 ast_copy_string(workspace, cdr->dstchannel, workspacelen);
244         else if (!strcasecmp(name, "lastapp"))
245                 ast_copy_string(workspace, cdr->lastapp, workspacelen);
246         else if (!strcasecmp(name, "lastdata"))
247                 ast_copy_string(workspace, cdr->lastdata, workspacelen);
248         else if (!strcasecmp(name, "start"))
249                 cdr_get_tv(cdr->start, raw ? NULL : fmt, workspace, workspacelen);
250         else if (!strcasecmp(name, "answer"))
251                 cdr_get_tv(cdr->answer, raw ? NULL : fmt, workspace, workspacelen);
252         else if (!strcasecmp(name, "end"))
253                 cdr_get_tv(cdr->end, raw ? NULL : fmt, workspace, workspacelen);
254         else if (!strcasecmp(name, "duration"))
255                 snprintf(workspace, workspacelen, "%ld", cdr->duration);
256         else if (!strcasecmp(name, "billsec"))
257                 snprintf(workspace, workspacelen, "%ld", cdr->billsec);
258         else if (!strcasecmp(name, "disposition")) {
259                 if (raw) {
260                         snprintf(workspace, workspacelen, "%ld", cdr->disposition);
261                 } else {
262                         ast_copy_string(workspace, ast_cdr_disp2str(cdr->disposition), workspacelen);
263                 }
264         } else if (!strcasecmp(name, "amaflags")) {
265                 if (raw) {
266                         snprintf(workspace, workspacelen, "%ld", cdr->amaflags);
267                 } else {
268                         ast_copy_string(workspace, ast_cdr_flags2str(cdr->amaflags), workspacelen);
269                 }
270         } else if (!strcasecmp(name, "accountcode"))
271                 ast_copy_string(workspace, cdr->accountcode, workspacelen);
272         else if (!strcasecmp(name, "uniqueid"))
273                 ast_copy_string(workspace, cdr->uniqueid, workspacelen);
274         else if (!strcasecmp(name, "userfield"))
275                 ast_copy_string(workspace, cdr->userfield, workspacelen);
276         else if ((varbuf = ast_cdr_getvar_internal(cdr, name, recur)))
277                 ast_copy_string(workspace, varbuf, workspacelen);
278         else
279                 workspace[0] = '\0';
280
281         if (!ast_strlen_zero(workspace))
282                 *ret = workspace;
283 }
284
285 /* readonly cdr variables */
286 static  const char *cdr_readonly_vars[] = { "clid", "src", "dst", "dcontext", "channel", "dstchannel",
287                                     "lastapp", "lastdata", "start", "answer", "end", "duration",
288                                     "billsec", "disposition", "amaflags", "accountcode", "uniqueid",
289                                     "userfield", NULL };
290 /*! Set a CDR channel variable 
291         \note You can't set the CDR variables that belong to the actual CDR record, like "billsec".
292 */
293 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur) 
294 {
295         struct ast_var_t *newvariable;
296         struct varshead *headp;
297         int x;
298         
299         if (!cdr)  /* don't die if the cdr is null */
300                 return -1;
301         
302         for (x = 0; cdr_readonly_vars[x]; x++) {
303                 if (!strcasecmp(name, cdr_readonly_vars[x])) {
304                         ast_log(LOG_ERROR, "Attempt to set the '%s' read-only variable!.\n", name);
305                         return -1;
306                 }
307         }
308
309         if (!cdr) {
310                 ast_log(LOG_ERROR, "Attempt to set a variable on a nonexistent CDR record.\n");
311                 return -1;
312         }
313
314         for (; cdr; cdr = recur ? cdr->next : NULL) {
315                 headp = &cdr->varshead;
316                 AST_LIST_TRAVERSE_SAFE_BEGIN(headp, newvariable, entries) {
317                         if (!strcasecmp(ast_var_name(newvariable), name)) {
318                                 /* there is already such a variable, delete it */
319                                 AST_LIST_REMOVE_CURRENT(headp, entries);
320                                 ast_var_delete(newvariable);
321                                 break;
322                         }
323                 }
324                 AST_LIST_TRAVERSE_SAFE_END;
325
326                 if (value) {
327                         newvariable = ast_var_assign(name, value);
328                         AST_LIST_INSERT_HEAD(headp, newvariable, entries);
329                 }
330         }
331
332         return 0;
333 }
334
335 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr)
336 {
337         struct ast_var_t *variables, *newvariable = NULL;
338         struct varshead *headpa, *headpb;
339         const char *var, *val;
340         int x = 0;
341
342         if (!to_cdr || !from_cdr) /* don't die if one of the pointers is null */
343                 return 0;
344
345         headpa = &from_cdr->varshead;
346         headpb = &to_cdr->varshead;
347
348         AST_LIST_TRAVERSE(headpa,variables,entries) {
349                 if (variables &&
350                     (var = ast_var_name(variables)) && (val = ast_var_value(variables)) &&
351                     !ast_strlen_zero(var) && !ast_strlen_zero(val)) {
352                         newvariable = ast_var_assign(var, val);
353                         AST_LIST_INSERT_HEAD(headpb, newvariable, entries);
354                         x++;
355                 }
356         }
357
358         return x;
359 }
360
361 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur) 
362 {
363         struct ast_var_t *variables;
364         const char *var, *val;
365         char *tmp;
366         char workspace[256];
367         int total = 0, x = 0, i;
368
369         (*buf)->used = 0;
370         (*buf)->str[0] = '\0';
371
372         for (; cdr; cdr = recur ? cdr->next : NULL) {
373                 if (++x > 1)
374                         ast_str_append(buf, 0, "\n");
375
376                 AST_LIST_TRAVERSE(&cdr->varshead, variables, entries) {
377                         if (variables &&
378                             (var = ast_var_name(variables)) && (val = ast_var_value(variables)) &&
379                             !ast_strlen_zero(var) && !ast_strlen_zero(val)) {
380                                 if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, var, delim, val, sep) < 0) {
381                                         ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
382                                         break;
383                                 } else
384                                         total++;
385                         } else 
386                                 break;
387                 }
388
389                 for (i = 0; cdr_readonly_vars[i]; i++) {
390                         ast_cdr_getvar(cdr, cdr_readonly_vars[i], &tmp, workspace, sizeof(workspace), 0, 0);
391                         if (!tmp)
392                                 continue;
393                         
394                         if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, cdr_readonly_vars[i], delim, tmp, sep) < 0) {
395                                 ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
396                                 break;
397                         } else
398                                 total++;
399                 }
400         }
401
402         return total;
403 }
404
405
406 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur)
407 {
408
409         /* clear variables */
410         for (; cdr; cdr = recur ? cdr->next : NULL) {
411                 struct ast_var_t *vardata;
412                 struct varshead *headp = &cdr->varshead;
413                 while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
414                         ast_var_delete(vardata);
415         }
416 }
417
418 /*! \brief  print a warning if cdr already posted */
419 static void check_post(struct ast_cdr *cdr)
420 {
421         if (!cdr)
422                 return;
423         if (ast_test_flag(cdr, AST_CDR_FLAG_POSTED))
424                 ast_log(LOG_NOTICE, "CDR on channel '%s' already posted\n", S_OR(cdr->channel, "<unknown>"));
425 }
426
427 void ast_cdr_free(struct ast_cdr *cdr)
428 {
429
430         while (cdr) {
431                 struct ast_cdr *next = cdr->next;
432                 char *chan = S_OR(cdr->channel, "<unknown>");
433                 if (!ast_test_flag(cdr, AST_CDR_FLAG_POSTED) && !ast_test_flag(cdr, AST_CDR_FLAG_POST_DISABLED))
434                         ast_log(LOG_NOTICE, "CDR on channel '%s' not posted\n", chan);
435                 if (ast_tvzero(cdr->end))
436                         ast_log(LOG_NOTICE, "CDR on channel '%s' lacks end\n", chan);
437                 if (ast_tvzero(cdr->start))
438                         ast_log(LOG_NOTICE, "CDR on channel '%s' lacks start\n", chan);
439
440                 ast_cdr_free_vars(cdr, 0);
441                 ast_free(cdr);
442                 cdr = next;
443         }
444 }
445
446 /*! \brief the same as a cdr_free call, only with no checks; just get rid of it */
447 void ast_cdr_discard(struct ast_cdr *cdr)
448 {
449         while (cdr) {
450                 struct ast_cdr *next = cdr->next;
451
452                 ast_cdr_free_vars(cdr, 0);
453                 ast_free(cdr);
454                 cdr = next;
455         }
456 }
457
458 struct ast_cdr *ast_cdr_alloc(void)
459 {
460         struct ast_cdr *x;
461         x = ast_calloc(1, sizeof(*x));
462         if (!x)
463                 ast_log(LOG_ERROR,"Allocation Failure for a CDR!\n");
464         return x;
465 }
466
467 static void cdr_merge_vars(struct ast_cdr *to, struct ast_cdr *from)
468 {
469         struct ast_var_t *variablesfrom,*variablesto;
470         struct varshead *headpfrom = &to->varshead;
471         struct varshead *headpto = &from->varshead;
472         AST_LIST_TRAVERSE_SAFE_BEGIN(headpfrom, variablesfrom, entries) {
473                 /* for every var in from, stick it in to */
474                 const char *fromvarname, *fromvarval;
475                 const char *tovarname = NULL, *tovarval = NULL;
476                 fromvarname = ast_var_name(variablesfrom);
477                 fromvarval = ast_var_value(variablesfrom);
478                 tovarname = 0;
479
480                 /* now, quick see if that var is in the 'to' cdr already */
481                 AST_LIST_TRAVERSE(headpto, variablesto, entries) {
482
483                         /* now, quick see if that var is in the 'to' cdr already */
484                         if ( strcasecmp(fromvarname, ast_var_name(variablesto)) == 0 ) {
485                                 tovarname = ast_var_name(variablesto);
486                                 tovarval = ast_var_value(variablesto);
487                                 break;
488                         }
489                 }
490                 if (tovarname && strcasecmp(fromvarval,tovarval) != 0) {  /* this message here to see how irritating the userbase finds it */
491                         ast_log(LOG_NOTICE, "Merging CDR's: variable %s value %s dropped in favor of value %s\n", tovarname, fromvarval, tovarval);
492                         continue;
493                 } else if (tovarname && strcasecmp(fromvarval,tovarval) == 0) /* if they are the same, the job is done */
494                         continue;
495
496                 /*rip this var out of the from cdr, and stick it in the to cdr */
497                 AST_LIST_REMOVE_CURRENT(headpfrom, entries);
498                 AST_LIST_INSERT_HEAD(headpto, variablesfrom, entries);
499         }
500         AST_LIST_TRAVERSE_SAFE_END;
501 }
502
503 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from)
504 {
505         struct ast_cdr *tcdr;
506         
507         if (!to || !from)
508                 return;
509         
510         if (!ast_tvzero(from->start)) {
511                 if (!ast_tvzero(to->start)) {
512                         if (ast_tvcmp(to->start, from->start) > 0 ) {
513                                 to->start = from->start; /* use the earliest time */
514                                 from->start = ast_tv(0,0); /* we actively "steal" these values */
515                         }
516                         /* else nothing to do */
517                 } else {
518                         to->start = from->start;
519                         from->start = ast_tv(0,0); /* we actively "steal" these values */
520                 }
521         }
522         if (!ast_tvzero(from->answer)) {
523                 if (!ast_tvzero(to->answer)) {
524                         if (ast_tvcmp(to->answer, from->answer) > 0 ) {
525                                 to->answer = from->answer; /* use the earliest time */
526                                 from->answer = ast_tv(0,0); /* we actively "steal" these values */
527                         }
528                         /* we got the earliest answer time, so we'll settle for that? */
529                 } else {
530                         to->answer = from->answer;
531                         from->answer = ast_tv(0,0); /* we actively "steal" these values */
532                 }
533         }
534         if (!ast_tvzero(from->end)) {
535                 if (!ast_tvzero(to->end)) {
536                         if (ast_tvcmp(to->end, from->end) < 0 ) {
537                                 to->end = from->end; /* use the latest time */
538                                 from->end = ast_tv(0,0); /* we actively "steal" these values */
539                                 to->duration = to->end.tv_sec - to->start.tv_sec;  /* don't forget to update the duration, billsec, when we set end */
540                                 to->billsec = ast_tvzero(to->answer) ? 0 : to->end.tv_sec - to->answer.tv_sec;
541                         }
542                         /* else, nothing to do */
543                 } else {
544                         to->end = from->end;
545                         from->end = ast_tv(0,0); /* we actively "steal" these values */
546                         to->duration = to->end.tv_sec - to->start.tv_sec;
547                         to->billsec = ast_tvzero(to->answer) ? 0 : to->end.tv_sec - to->answer.tv_sec;
548                 }
549         }
550         if (to->disposition < from->disposition) {
551                 to->disposition = from->disposition;
552                 from->disposition = AST_CDR_NOANSWER;
553         }
554         if (ast_strlen_zero(to->lastapp) && !ast_strlen_zero(from->lastapp)) {
555                 ast_copy_string(to->lastapp, from->lastapp, sizeof(to->lastapp));
556                 from->lastapp[0] = 0; /* theft */
557         }
558         if (ast_strlen_zero(to->lastdata) && !ast_strlen_zero(from->lastdata)) {
559                 ast_copy_string(to->lastdata, from->lastdata, sizeof(to->lastdata));
560                 from->lastdata[0] = 0; /* theft */
561         }
562         if (ast_strlen_zero(to->dcontext) && !ast_strlen_zero(from->dcontext)) {
563                 ast_copy_string(to->dcontext, from->dcontext, sizeof(to->dcontext));
564                 from->dcontext[0] = 0; /* theft */
565         }
566         if (ast_strlen_zero(to->dstchannel) && !ast_strlen_zero(from->dstchannel)) {
567                 ast_copy_string(to->dstchannel, from->dstchannel, sizeof(to->dstchannel));
568                 from->dstchannel[0] = 0; /* theft */
569         }
570         if (ast_strlen_zero(to->channel) && !ast_strlen_zero(from->channel)) {
571                 ast_copy_string(to->channel, from->channel, sizeof(to->channel));
572                 from->channel[0] = 0; /* theft */
573         }
574         if (ast_strlen_zero(to->src) && !ast_strlen_zero(from->src)) {
575                 ast_copy_string(to->src, from->src, sizeof(to->src));
576                 from->src[0] = 0; /* theft */
577         }
578         if (ast_strlen_zero(to->dst) && !ast_strlen_zero(from->dst)) {
579                 ast_copy_string(to->dst, from->dst, sizeof(to->dst));
580                 from->dst[0] = 0; /* theft */
581         }
582         if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (!to->amaflags && from->amaflags)) {
583                 to->amaflags = from->amaflags;
584                 from->amaflags = 0; /* theft */
585         }
586         if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (ast_strlen_zero(to->accountcode) && !ast_strlen_zero(from->accountcode))) {
587                 ast_copy_string(to->accountcode, from->accountcode, sizeof(to->accountcode));
588                 from->accountcode[0] = 0; /* theft */
589         }
590         if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (ast_strlen_zero(to->userfield) && !ast_strlen_zero(from->userfield))) {
591                 ast_copy_string(to->userfield, from->userfield, sizeof(to->userfield));
592                 from->userfield[0] = 0; /* theft */
593         }
594         /* flags, varsead, ? */
595         cdr_merge_vars(from, to);
596
597         if (ast_test_flag(from, AST_CDR_FLAG_KEEP_VARS))
598                 ast_set_flag(to, AST_CDR_FLAG_KEEP_VARS);
599         if (ast_test_flag(from, AST_CDR_FLAG_POSTED))
600                 ast_set_flag(to, AST_CDR_FLAG_POSTED);
601         if (ast_test_flag(from, AST_CDR_FLAG_LOCKED))
602                 ast_set_flag(to, AST_CDR_FLAG_LOCKED);
603         if (ast_test_flag(from, AST_CDR_FLAG_CHILD))
604                 ast_set_flag(to, AST_CDR_FLAG_CHILD);
605         if (ast_test_flag(from, AST_CDR_FLAG_POST_DISABLED))
606                 ast_set_flag(to, AST_CDR_FLAG_POST_DISABLED);
607
608         /* last, but not least, we need to merge any forked CDRs to the 'to' cdr */
609         while (from->next) {
610                 /* just rip 'em off the 'from' and insert them on the 'to' */
611                 tcdr = from->next;
612                 from->next = tcdr->next;
613                 tcdr->next = NULL;
614                 /* tcdr is now ripped from the current list; */
615                 ast_cdr_append(to, tcdr);
616         }
617 }
618
619 void ast_cdr_start(struct ast_cdr *cdr)
620 {
621         char *chan; 
622
623         for (; cdr; cdr = cdr->next) {
624                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
625                         chan = S_OR(cdr->channel, "<unknown>");
626                         check_post(cdr);
627                         cdr->start = ast_tvnow();
628                 }
629         }
630 }
631
632 void ast_cdr_answer(struct ast_cdr *cdr)
633 {
634
635         for (; cdr; cdr = cdr->next) {
636                 check_post(cdr);
637                 if (cdr->disposition < AST_CDR_ANSWERED)
638                         cdr->disposition = AST_CDR_ANSWERED;
639                 if (ast_tvzero(cdr->answer))
640                         cdr->answer = ast_tvnow();
641         }
642 }
643
644 void ast_cdr_busy(struct ast_cdr *cdr)
645 {
646
647         for (; cdr; cdr = cdr->next) {
648                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
649                         check_post(cdr);
650                         if (cdr->disposition < AST_CDR_BUSY)
651                                 cdr->disposition = AST_CDR_BUSY;
652                 }
653         }
654 }
655
656 void ast_cdr_failed(struct ast_cdr *cdr)
657 {
658         for (; cdr; cdr = cdr->next) {
659                 check_post(cdr);
660                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
661                         if (cdr->disposition < AST_CDR_FAILED)
662                                 cdr->disposition = AST_CDR_FAILED;
663                 }
664         }
665 }
666
667 void ast_cdr_noanswer(struct ast_cdr *cdr)
668 {
669         char *chan; 
670
671         while (cdr) {
672                 chan = !ast_strlen_zero(cdr->channel) ? cdr->channel : "<unknown>";
673                 if (ast_test_flag(cdr, AST_CDR_FLAG_POSTED))
674                         ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan);
675                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
676                         if (cdr->disposition < AST_CDR_NOANSWER)
677                                 cdr->disposition = AST_CDR_NOANSWER;
678                 }
679                 cdr = cdr->next;
680         }
681 }
682
683 int ast_cdr_disposition(struct ast_cdr *cdr, int cause)
684 {
685         int res = 0;
686
687         for (; cdr; cdr = cdr->next) {
688                 switch (cause) {
689                 case AST_CAUSE_BUSY:
690                         ast_cdr_busy(cdr);
691                         break;
692                 case AST_CAUSE_FAILURE:
693                         ast_cdr_failed(cdr);
694                         break;
695                 case AST_CAUSE_NORMAL:
696                         break;
697                 case AST_CAUSE_NOTDEFINED:
698                         res = -1;
699                         break;
700                 default:
701                         res = -1;
702                         ast_log(LOG_WARNING, "Cause not handled\n");
703                 }
704         }
705         return res;
706 }
707
708 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chann)
709 {
710         for (; cdr; cdr = cdr->next) {
711                 check_post(cdr);
712                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
713                         ast_copy_string(cdr->dstchannel, chann, sizeof(cdr->dstchannel));
714         }
715 }
716
717 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data)
718 {
719
720         for (; cdr; cdr = cdr->next) {
721                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
722                         check_post(cdr);
723                         if (!app)
724                                 app = "";
725                         ast_copy_string(cdr->lastapp, app, sizeof(cdr->lastapp));
726                         if (!data)
727                                 data = "";
728                         ast_copy_string(cdr->lastdata, data, sizeof(cdr->lastdata));
729                 }
730         }
731 }
732
733 /* set cid info for one record */
734 static void set_one_cid(struct ast_cdr *cdr, struct ast_channel *c)
735 {
736         /* Grab source from ANI or normal Caller*ID */
737         const char *num = S_OR(c->cid.cid_ani, c->cid.cid_num);
738         if (!cdr)
739                 return;
740         if (!ast_strlen_zero(c->cid.cid_name)) {
741                 if (!ast_strlen_zero(num))      /* both name and number */
742                         snprintf(cdr->clid, sizeof(cdr->clid), "\"%s\" <%s>", c->cid.cid_name, num);
743                 else                            /* only name */
744                         ast_copy_string(cdr->clid, c->cid.cid_name, sizeof(cdr->clid));
745         } else if (!ast_strlen_zero(num)) {     /* only number */
746                 ast_copy_string(cdr->clid, num, sizeof(cdr->clid));
747         } else {                                /* nothing known */
748                 cdr->clid[0] = '\0';
749         }
750         ast_copy_string(cdr->src, S_OR(num, ""), sizeof(cdr->src));
751
752 }
753 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *c)
754 {
755         for (; cdr; cdr = cdr->next) {
756                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
757                         set_one_cid(cdr, c);
758         }
759         return 0;
760 }
761
762 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *c)
763 {
764         char *chan;
765
766         for ( ; cdr ; cdr = cdr->next) {
767                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
768                         chan = S_OR(cdr->channel, "<unknown>");
769                         if (!ast_strlen_zero(cdr->channel)) 
770                                 ast_log(LOG_WARNING, "CDR already initialized on '%s'\n", chan); 
771                         ast_copy_string(cdr->channel, c->name, sizeof(cdr->channel));
772                         set_one_cid(cdr, c);
773
774                         cdr->disposition = (c->_state == AST_STATE_UP) ?  AST_CDR_ANSWERED : AST_CDR_NULL;
775                         cdr->amaflags = c->amaflags ? c->amaflags :  ast_default_amaflags;
776                         ast_copy_string(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode));
777                         /* Destination information */
778                         ast_copy_string(cdr->dst, S_OR(c->macroexten,c->exten), sizeof(cdr->dst));
779                         ast_copy_string(cdr->dcontext, S_OR(c->macrocontext,c->context), sizeof(cdr->dcontext));
780                         /* Unique call identifier */
781                         ast_copy_string(cdr->uniqueid, c->uniqueid, sizeof(cdr->uniqueid));
782                 }
783         }
784         return 0;
785 }
786
787 void ast_cdr_end(struct ast_cdr *cdr)
788 {
789         for ( ; cdr ; cdr = cdr->next) {
790                 check_post(cdr);
791                 if (ast_tvzero(cdr->end))
792                         cdr->end = ast_tvnow();
793                 if (ast_tvzero(cdr->start)) {
794                         ast_log(LOG_WARNING, "CDR on channel '%s' has not started\n", S_OR(cdr->channel, "<unknown>"));
795                         cdr->disposition = AST_CDR_FAILED;
796                 } else
797                         cdr->duration = cdr->end.tv_sec - cdr->start.tv_sec;
798                 cdr->billsec = ast_tvzero(cdr->answer) ? 0 : cdr->end.tv_sec - cdr->answer.tv_sec;
799         }
800 }
801
802 char *ast_cdr_disp2str(int disposition)
803 {
804         switch (disposition) {
805         case AST_CDR_NULL:
806                 return "NO ANSWER"; /* by default, for backward compatibility */
807         case AST_CDR_NOANSWER:
808                 return "NO ANSWER";
809         case AST_CDR_FAILED:
810                 return "FAILED";                
811         case AST_CDR_BUSY:
812                 return "BUSY";          
813         case AST_CDR_ANSWERED:
814                 return "ANSWERED";
815         }
816         return "UNKNOWN";
817 }
818
819 /*! Converts AMA flag to printable string */
820 char *ast_cdr_flags2str(int flag)
821 {
822         switch (flag) {
823         case AST_CDR_OMIT:
824                 return "OMIT";
825         case AST_CDR_BILLING:
826                 return "BILLING";
827         case AST_CDR_DOCUMENTATION:
828                 return "DOCUMENTATION";
829         }
830         return "Unknown";
831 }
832
833 int ast_cdr_setaccount(struct ast_channel *chan, const char *account)
834 {
835         struct ast_cdr *cdr = chan->cdr;
836
837         ast_string_field_set(chan, accountcode, account);
838         for ( ; cdr ; cdr = cdr->next) {
839                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
840                         ast_copy_string(cdr->accountcode, chan->accountcode, sizeof(cdr->accountcode));
841                 }
842         }
843         return 0;
844 }
845
846 int ast_cdr_setamaflags(struct ast_channel *chan, const char *flag)
847 {
848         struct ast_cdr *cdr;
849         int newflag = ast_cdr_amaflags2int(flag);
850         if (newflag) {
851                 for (cdr = chan->cdr; cdr; cdr = cdr->next)
852                         cdr->amaflags = newflag;
853         }
854
855         return 0;
856 }
857
858 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield)
859 {
860         struct ast_cdr *cdr = chan->cdr;
861
862         for ( ; cdr ; cdr = cdr->next) {
863                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) 
864                         ast_copy_string(cdr->userfield, userfield, sizeof(cdr->userfield));
865         }
866
867         return 0;
868 }
869
870 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield)
871 {
872         struct ast_cdr *cdr = chan->cdr;
873
874         for ( ; cdr ; cdr = cdr->next) {
875                 int len = strlen(cdr->userfield);
876
877                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
878                         ast_copy_string(cdr->userfield + len, userfield, sizeof(cdr->userfield) - len);
879         }
880
881         return 0;
882 }
883
884 int ast_cdr_update(struct ast_channel *c)
885 {
886         struct ast_cdr *cdr = c->cdr;
887
888         for ( ; cdr ; cdr = cdr->next) {
889                 if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
890                         set_one_cid(cdr, c);
891
892                         /* Copy account code et-al */   
893                         ast_copy_string(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode));
894                         
895                         /* Destination information */ /* XXX privilege macro* ? */
896                         ast_copy_string(cdr->dst, S_OR(c->macroexten, c->exten), sizeof(cdr->dst));
897                         ast_copy_string(cdr->dcontext, S_OR(c->macrocontext, c->context), sizeof(cdr->dcontext));
898                 }
899         }
900
901         return 0;
902 }
903
904 int ast_cdr_amaflags2int(const char *flag)
905 {
906         if (!strcasecmp(flag, "default"))
907                 return 0;
908         if (!strcasecmp(flag, "omit"))
909                 return AST_CDR_OMIT;
910         if (!strcasecmp(flag, "billing"))
911                 return AST_CDR_BILLING;
912         if (!strcasecmp(flag, "documentation"))
913                 return AST_CDR_DOCUMENTATION;
914         return -1;
915 }
916
917 static void post_cdr(struct ast_cdr *cdr)
918 {
919         char *chan;
920         struct ast_cdr_beitem *i;
921
922         for ( ; cdr ; cdr = cdr->next) {
923                 chan = S_OR(cdr->channel, "<unknown>");
924                 check_post(cdr);
925                 if (ast_tvzero(cdr->end))
926                         ast_log(LOG_WARNING, "CDR on channel '%s' lacks end\n", chan);
927                 if (ast_tvzero(cdr->start))
928                         ast_log(LOG_WARNING, "CDR on channel '%s' lacks start\n", chan);
929                 ast_set_flag(cdr, AST_CDR_FLAG_POSTED);
930                 if (ast_test_flag(cdr, AST_CDR_FLAG_POST_DISABLED))
931                         continue;
932                 AST_RWLIST_RDLOCK(&be_list);
933                 AST_RWLIST_TRAVERSE(&be_list, i, list) {
934                         i->be(cdr);
935                 }
936                 AST_RWLIST_UNLOCK(&be_list);
937         }
938 }
939
940 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *_flags)
941 {
942         struct ast_cdr *dup;
943         struct ast_flags flags = { 0 };
944
945         if (_flags)
946                 ast_copy_flags(&flags, _flags, AST_FLAGS_ALL);
947
948         for ( ; cdr ; cdr = cdr->next) {
949                 /* Detach if post is requested */
950                 if (ast_test_flag(&flags, AST_CDR_FLAG_LOCKED) || !ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
951                         if (ast_test_flag(&flags, AST_CDR_FLAG_POSTED)) {
952                                 ast_cdr_end(cdr);
953                                 if ((dup = ast_cdr_dup(cdr))) {
954                                         ast_cdr_detach(dup);
955                                 }
956                                 ast_set_flag(cdr, AST_CDR_FLAG_POSTED);
957                         }
958
959                         /* clear variables */
960                         if (!ast_test_flag(&flags, AST_CDR_FLAG_KEEP_VARS)) {
961                                 ast_cdr_free_vars(cdr, 0);
962                         }
963
964                         /* Reset to initial state */
965                         ast_clear_flag(cdr, AST_FLAGS_ALL);     
966                         memset(&cdr->start, 0, sizeof(cdr->start));
967                         memset(&cdr->end, 0, sizeof(cdr->end));
968                         memset(&cdr->answer, 0, sizeof(cdr->answer));
969                         cdr->billsec = 0;
970                         cdr->duration = 0;
971                         ast_cdr_start(cdr);
972                         cdr->disposition = AST_CDR_NULL;
973                 }
974         }
975 }
976
977 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr) 
978 {
979         struct ast_cdr *ret;
980
981         if (cdr) {
982                 ret = cdr;
983
984                 while (cdr->next)
985                         cdr = cdr->next;
986                 cdr->next = newcdr;
987         } else {
988                 ret = newcdr;
989         }
990
991         return ret;
992 }
993
994 /*! \note Don't call without cdr_batch_lock */
995 static void reset_batch(void)
996 {
997         batch->size = 0;
998         batch->head = NULL;
999         batch->tail = NULL;
1000 }
1001
1002 /*! \note Don't call without cdr_batch_lock */
1003 static int init_batch(void)
1004 {
1005         /* This is the single meta-batch used to keep track of all CDRs during the entire life of the program */
1006         if (!(batch = ast_malloc(sizeof(*batch))))
1007                 return -1;
1008
1009         reset_batch();
1010
1011         return 0;
1012 }
1013
1014 static void *do_batch_backend_process(void *data)
1015 {
1016         struct ast_cdr_batch_item *processeditem;
1017         struct ast_cdr_batch_item *batchitem = data;
1018
1019         /* Push each CDR into storage mechanism(s) and free all the memory */
1020         while (batchitem) {
1021                 post_cdr(batchitem->cdr);
1022                 ast_cdr_free(batchitem->cdr);
1023                 processeditem = batchitem;
1024                 batchitem = batchitem->next;
1025                 ast_free(processeditem);
1026         }
1027
1028         return NULL;
1029 }
1030
1031 void ast_cdr_submit_batch(int shutdown)
1032 {
1033         struct ast_cdr_batch_item *oldbatchitems = NULL;
1034         pthread_t batch_post_thread = AST_PTHREADT_NULL;
1035
1036         /* if there's no batch, or no CDRs in the batch, then there's nothing to do */
1037         if (!batch || !batch->head)
1038                 return;
1039
1040         /* move the old CDRs aside, and prepare a new CDR batch */
1041         ast_mutex_lock(&cdr_batch_lock);
1042         oldbatchitems = batch->head;
1043         reset_batch();
1044         ast_mutex_unlock(&cdr_batch_lock);
1045
1046         /* if configured, spawn a new thread to post these CDRs,
1047            also try to save as much as possible if we are shutting down safely */
1048         if (batchscheduleronly || shutdown) {
1049                 ast_debug(1, "CDR single-threaded batch processing begins now\n");
1050                 do_batch_backend_process(oldbatchitems);
1051         } else {
1052                 if (ast_pthread_create_detached_background(&batch_post_thread, NULL, do_batch_backend_process, oldbatchitems)) {
1053                         ast_log(LOG_WARNING, "CDR processing thread could not detach, now trying in this thread\n");
1054                         do_batch_backend_process(oldbatchitems);
1055                 } else {
1056                         ast_debug(1, "CDR multi-threaded batch processing begins now\n");
1057                 }
1058         }
1059 }
1060
1061 static int submit_scheduled_batch(void *data)
1062 {
1063         ast_cdr_submit_batch(0);
1064         /* manually reschedule from this point in time */
1065         cdr_sched = ast_sched_add(sched, batchtime * 1000, submit_scheduled_batch, NULL);
1066         /* returning zero so the scheduler does not automatically reschedule */
1067         return 0;
1068 }
1069
1070 static void submit_unscheduled_batch(void)
1071 {
1072         /* this is okay since we are not being called from within the scheduler */
1073         if (cdr_sched > -1)
1074                 ast_sched_del(sched, cdr_sched);
1075         /* schedule the submission to occur ASAP (1 ms) */
1076         cdr_sched = ast_sched_add(sched, 1, submit_scheduled_batch, NULL);
1077         /* signal the do_cdr thread to wakeup early and do some work (that lazy thread ;) */
1078         ast_mutex_lock(&cdr_pending_lock);
1079         ast_cond_signal(&cdr_pending_cond);
1080         ast_mutex_unlock(&cdr_pending_lock);
1081 }
1082
1083 void ast_cdr_detach(struct ast_cdr *cdr)
1084 {
1085         struct ast_cdr_batch_item *newtail;
1086         int curr;
1087
1088         if (!cdr)
1089                 return;
1090
1091         /* maybe they disabled CDR stuff completely, so just drop it */
1092         if (!enabled) {
1093                 ast_debug(1, "Dropping CDR !\n");
1094                 ast_set_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
1095                 ast_cdr_free(cdr);
1096                 return;
1097         }
1098
1099         /* post stuff immediately if we are not in batch mode, this is legacy behaviour */
1100         if (!batchmode) {
1101                 post_cdr(cdr);
1102                 ast_cdr_free(cdr);
1103                 return;
1104         }
1105
1106         /* otherwise, each CDR gets put into a batch list (at the end) */
1107         ast_debug(1, "CDR detaching from this thread\n");
1108
1109         /* we'll need a new tail for every CDR */
1110         if (!(newtail = ast_calloc(1, sizeof(*newtail)))) {
1111                 post_cdr(cdr);
1112                 ast_cdr_free(cdr);
1113                 return;
1114         }
1115
1116         /* don't traverse a whole list (just keep track of the tail) */
1117         ast_mutex_lock(&cdr_batch_lock);
1118         if (!batch)
1119                 init_batch();
1120         if (!batch->head) {
1121                 /* new batch is empty, so point the head at the new tail */
1122                 batch->head = newtail;
1123         } else {
1124                 /* already got a batch with something in it, so just append a new tail */
1125                 batch->tail->next = newtail;
1126         }
1127         newtail->cdr = cdr;
1128         batch->tail = newtail;
1129         curr = batch->size++;
1130         ast_mutex_unlock(&cdr_batch_lock);
1131
1132         /* if we have enough stuff to post, then do it */
1133         if (curr >= (batchsize - 1))
1134                 submit_unscheduled_batch();
1135 }
1136
1137 static void *do_cdr(void *data)
1138 {
1139         struct timespec timeout;
1140         int schedms;
1141         int numevents = 0;
1142
1143         for (;;) {
1144                 struct timeval now;
1145                 schedms = ast_sched_wait(sched);
1146                 /* this shouldn't happen, but provide a 1 second default just in case */
1147                 if (schedms <= 0)
1148                         schedms = 1000;
1149                 now = ast_tvadd(ast_tvnow(), ast_samp2tv(schedms, 1000));
1150                 timeout.tv_sec = now.tv_sec;
1151                 timeout.tv_nsec = now.tv_usec * 1000;
1152                 /* prevent stuff from clobbering cdr_pending_cond, then wait on signals sent to it until the timeout expires */
1153                 ast_mutex_lock(&cdr_pending_lock);
1154                 ast_cond_timedwait(&cdr_pending_cond, &cdr_pending_lock, &timeout);
1155                 numevents = ast_sched_runq(sched);
1156                 ast_mutex_unlock(&cdr_pending_lock);
1157                 ast_debug(2, "Processed %d scheduled CDR batches from the run queue\n", numevents);
1158         }
1159
1160         return NULL;
1161 }
1162
1163 static int handle_cli_status(int fd, int argc, char *argv[])
1164 {
1165         struct ast_cdr_beitem *beitem=NULL;
1166         int cnt=0;
1167         long nextbatchtime=0;
1168
1169         if (argc > 2)
1170                 return RESULT_SHOWUSAGE;
1171
1172         ast_cli(fd, "CDR logging: %s\n", enabled ? "enabled" : "disabled");
1173         ast_cli(fd, "CDR mode: %s\n", batchmode ? "batch" : "simple");
1174         if (enabled) {
1175                 if (batchmode) {
1176                         if (batch)
1177                                 cnt = batch->size;
1178                         if (cdr_sched > -1)
1179                                 nextbatchtime = ast_sched_when(sched, cdr_sched);
1180                         ast_cli(fd, "CDR safe shut down: %s\n", batchsafeshutdown ? "enabled" : "disabled");
1181                         ast_cli(fd, "CDR batch threading model: %s\n", batchscheduleronly ? "scheduler only" : "scheduler plus separate threads");
1182                         ast_cli(fd, "CDR current batch size: %d record%s\n", cnt, ESS(cnt));
1183                         ast_cli(fd, "CDR maximum batch size: %d record%s\n", batchsize, ESS(batchsize));
1184                         ast_cli(fd, "CDR maximum batch time: %d second%s\n", batchtime, ESS(batchtime));
1185                         ast_cli(fd, "CDR next scheduled batch processing time: %ld second%s\n", nextbatchtime, ESS(nextbatchtime));
1186                 }
1187                 AST_RWLIST_RDLOCK(&be_list);
1188                 AST_RWLIST_TRAVERSE(&be_list, beitem, list) {
1189                         ast_cli(fd, "CDR registered backend: %s\n", beitem->name);
1190                 }
1191                 AST_RWLIST_UNLOCK(&be_list);
1192         }
1193
1194         return 0;
1195 }
1196
1197 static int handle_cli_submit(int fd, int argc, char *argv[])
1198 {
1199         if (argc > 2)
1200                 return RESULT_SHOWUSAGE;
1201
1202         submit_unscheduled_batch();
1203         ast_cli(fd, "Submitted CDRs to backend engines for processing.  This may take a while.\n");
1204
1205         return 0;
1206 }
1207
1208 static struct ast_cli_entry cli_submit = {
1209         { "cdr", "submit", NULL },
1210         handle_cli_submit, "Posts all pending batched CDR data",
1211         "Usage: cdr submit\n"
1212         "       Posts all pending batched CDR data to the configured CDR backend engine modules.\n"
1213 };
1214
1215 static struct ast_cli_entry cli_status = {
1216         { "cdr", "status", NULL },
1217         handle_cli_status, "Display the CDR status",
1218         "Usage: cdr status\n"
1219         "       Displays the Call Detail Record engine system status.\n"
1220 };
1221
1222 static int do_reload(void)
1223 {
1224         struct ast_config *config;
1225         const char *enabled_value;
1226         const char *batched_value;
1227         const char *scheduleronly_value;
1228         const char *batchsafeshutdown_value;
1229         const char *size_value;
1230         const char *time_value;
1231         const char *end_before_h_value;
1232         int cfg_size;
1233         int cfg_time;
1234         int was_enabled;
1235         int was_batchmode;
1236         int res=0;
1237
1238         ast_mutex_lock(&cdr_batch_lock);
1239
1240         batchsize = BATCH_SIZE_DEFAULT;
1241         batchtime = BATCH_TIME_DEFAULT;
1242         batchscheduleronly = BATCH_SCHEDULER_ONLY_DEFAULT;
1243         batchsafeshutdown = BATCH_SAFE_SHUTDOWN_DEFAULT;
1244         was_enabled = enabled;
1245         was_batchmode = batchmode;
1246         enabled = 1;
1247         batchmode = 0;
1248
1249         /* don't run the next scheduled CDR posting while reloading */
1250         if (cdr_sched > -1)
1251                 ast_sched_del(sched, cdr_sched);
1252
1253         if ((config = ast_config_load("cdr.conf"))) {
1254                 if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
1255                         enabled = ast_true(enabled_value);
1256                 }
1257                 if ((batched_value = ast_variable_retrieve(config, "general", "batch"))) {
1258                         batchmode = ast_true(batched_value);
1259                 }
1260                 if ((scheduleronly_value = ast_variable_retrieve(config, "general", "scheduleronly"))) {
1261                         batchscheduleronly = ast_true(scheduleronly_value);
1262                 }
1263                 if ((batchsafeshutdown_value = ast_variable_retrieve(config, "general", "safeshutdown"))) {
1264                         batchsafeshutdown = ast_true(batchsafeshutdown_value);
1265                 }
1266                 if ((size_value = ast_variable_retrieve(config, "general", "size"))) {
1267                         if (sscanf(size_value, "%d", &cfg_size) < 1)
1268                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", size_value);
1269                         else if (size_value < 0)
1270                                 ast_log(LOG_WARNING, "Invalid maximum batch size '%d' specified, using default\n", cfg_size);
1271                         else
1272                                 batchsize = cfg_size;
1273                 }
1274                 if ((time_value = ast_variable_retrieve(config, "general", "time"))) {
1275                         if (sscanf(time_value, "%d", &cfg_time) < 1)
1276                                 ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", time_value);
1277                         else if (time_value < 0)
1278                                 ast_log(LOG_WARNING, "Invalid maximum batch time '%d' specified, using default\n", cfg_time);
1279                         else
1280                                 batchtime = cfg_time;
1281                 }
1282                 if ((end_before_h_value = ast_variable_retrieve(config, "general", "endbeforehexten")))
1283                         ast_set2_flag(&ast_options, ast_true(end_before_h_value), AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN);
1284         }
1285
1286         if (enabled && !batchmode) {
1287                 ast_log(LOG_NOTICE, "CDR simple logging enabled.\n");
1288         } else if (enabled && batchmode) {
1289                 cdr_sched = ast_sched_add(sched, batchtime * 1000, submit_scheduled_batch, NULL);
1290                 ast_log(LOG_NOTICE, "CDR batch mode logging enabled, first of either size %d or time %d seconds.\n", batchsize, batchtime);
1291         } else {
1292                 ast_log(LOG_NOTICE, "CDR logging disabled, data will be lost.\n");
1293         }
1294
1295         /* if this reload enabled the CDR batch mode, create the background thread
1296            if it does not exist */
1297         if (enabled && batchmode && (!was_enabled || !was_batchmode) && (cdr_thread == AST_PTHREADT_NULL)) {
1298                 ast_cond_init(&cdr_pending_cond, NULL);
1299                 if (ast_pthread_create_background(&cdr_thread, NULL, do_cdr, NULL) < 0) {
1300                         ast_log(LOG_ERROR, "Unable to start CDR thread.\n");
1301                         ast_sched_del(sched, cdr_sched);
1302                 } else {
1303                         ast_cli_register(&cli_submit);
1304                         ast_register_atexit(ast_cdr_engine_term);
1305                         res = 0;
1306                 }
1307         /* if this reload disabled the CDR and/or batch mode and there is a background thread,
1308            kill it */
1309         } else if (((!enabled && was_enabled) || (!batchmode && was_batchmode)) && (cdr_thread != AST_PTHREADT_NULL)) {
1310                 /* wake up the thread so it will exit */
1311                 pthread_cancel(cdr_thread);
1312                 pthread_kill(cdr_thread, SIGURG);
1313                 pthread_join(cdr_thread, NULL);
1314                 cdr_thread = AST_PTHREADT_NULL;
1315                 ast_cond_destroy(&cdr_pending_cond);
1316                 ast_cli_unregister(&cli_submit);
1317                 ast_unregister_atexit(ast_cdr_engine_term);
1318                 res = 0;
1319                 /* if leaving batch mode, then post the CDRs in the batch,
1320                    and don't reschedule, since we are stopping CDR logging */
1321                 if (!batchmode && was_batchmode) {
1322                         ast_cdr_engine_term();
1323                 }
1324         } else {
1325                 res = 0;
1326         }
1327
1328         ast_mutex_unlock(&cdr_batch_lock);
1329         ast_config_destroy(config);
1330
1331         return res;
1332 }
1333
1334 int ast_cdr_engine_init(void)
1335 {
1336         int res;
1337
1338         sched = sched_context_create();
1339         if (!sched) {
1340                 ast_log(LOG_ERROR, "Unable to create schedule context.\n");
1341                 return -1;
1342         }
1343
1344         ast_cli_register(&cli_status);
1345
1346         res = do_reload();
1347         if (res) {
1348                 ast_mutex_lock(&cdr_batch_lock);
1349                 res = init_batch();
1350                 ast_mutex_unlock(&cdr_batch_lock);
1351         }
1352
1353         return res;
1354 }
1355
1356 /* \note This actually gets called a couple of times at shutdown.  Once, before we start
1357    hanging up channels, and then again, after the channel hangup timeout expires */
1358 void ast_cdr_engine_term(void)
1359 {
1360         ast_cdr_submit_batch(batchsafeshutdown);
1361 }
1362
1363 int ast_cdr_engine_reload(void)
1364 {
1365         return do_reload();
1366 }
1367