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