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