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