Wed Oct 28 11:50:55 2009

Asterisk developer's documentation


cdr.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2006, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Call Detail Record API 
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  * 
00025  * \note Includes code and algorithms from the Zapata library.
00026  *
00027  * \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
00028  * through our fingers somehow.  If someone allocates a CDR, it must be completely handled normally
00029  * or a WARNING shall be logged, so that we can best keep track of any escape condition where the CDR
00030  * isn't properly generated and posted.
00031  */
00032 
00033 
00034 #include "asterisk.h"
00035 
00036 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 211569 $")
00037 
00038 #include <signal.h>
00039 
00040 #include "asterisk/lock.h"
00041 #include "asterisk/channel.h"
00042 #include "asterisk/cdr.h"
00043 #include "asterisk/callerid.h"
00044 #include "asterisk/manager.h"
00045 #include "asterisk/causes.h"
00046 #include "asterisk/linkedlists.h"
00047 #include "asterisk/utils.h"
00048 #include "asterisk/sched.h"
00049 #include "asterisk/config.h"
00050 #include "asterisk/cli.h"
00051 #include "asterisk/stringfields.h"
00052 
00053 /*! Default AMA flag for billing records (CDR's) */
00054 int ast_default_amaflags = AST_CDR_DOCUMENTATION;
00055 char ast_default_accountcode[AST_MAX_ACCOUNT_CODE];
00056 
00057 struct ast_cdr_beitem {
00058    char name[20];
00059    char desc[80];
00060    ast_cdrbe be;
00061    AST_RWLIST_ENTRY(ast_cdr_beitem) list;
00062 };
00063 
00064 static AST_RWLIST_HEAD_STATIC(be_list, ast_cdr_beitem);
00065 
00066 struct ast_cdr_batch_item {
00067    struct ast_cdr *cdr;
00068    struct ast_cdr_batch_item *next;
00069 };
00070 
00071 static struct ast_cdr_batch {
00072    int size;
00073    struct ast_cdr_batch_item *head;
00074    struct ast_cdr_batch_item *tail;
00075 } *batch = NULL;
00076 
00077 static struct sched_context *sched;
00078 static int cdr_sched = -1;
00079 static pthread_t cdr_thread = AST_PTHREADT_NULL;
00080 
00081 #define BATCH_SIZE_DEFAULT 100
00082 #define BATCH_TIME_DEFAULT 300
00083 #define BATCH_SCHEDULER_ONLY_DEFAULT 0
00084 #define BATCH_SAFE_SHUTDOWN_DEFAULT 1
00085 
00086 static int enabled;     /*! Is the CDR subsystem enabled ? */
00087 static int unanswered;
00088 static int batchmode;
00089 static int batchsize;
00090 static int batchtime;
00091 static int batchscheduleronly;
00092 static int batchsafeshutdown;
00093 
00094 AST_MUTEX_DEFINE_STATIC(cdr_batch_lock);
00095 
00096 /* these are used to wake up the CDR thread when there's work to do */
00097 AST_MUTEX_DEFINE_STATIC(cdr_pending_lock);
00098 static ast_cond_t cdr_pending_cond;
00099 
00100 int check_cdr_enabled()
00101 {
00102    return enabled;
00103 }
00104 
00105 /*! Register a CDR driver. Each registered CDR driver generates a CDR 
00106    \return 0 on success, -1 on failure 
00107 */
00108 int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
00109 {
00110    struct ast_cdr_beitem *i = NULL;
00111 
00112    if (!name)
00113       return -1;
00114 
00115    if (!be) {
00116       ast_log(LOG_WARNING, "CDR engine '%s' lacks backend\n", name);
00117       return -1;
00118    }
00119 
00120    AST_RWLIST_WRLOCK(&be_list);
00121    AST_RWLIST_TRAVERSE(&be_list, i, list) {
00122       if (!strcasecmp(name, i->name)) {
00123          ast_log(LOG_WARNING, "Already have a CDR backend called '%s'\n", name);
00124          AST_RWLIST_UNLOCK(&be_list);
00125          return -1;
00126       }
00127    }
00128 
00129    if (!(i = ast_calloc(1, sizeof(*i))))  
00130       return -1;
00131 
00132    i->be = be;
00133    ast_copy_string(i->name, name, sizeof(i->name));
00134    ast_copy_string(i->desc, desc, sizeof(i->desc));
00135 
00136    AST_RWLIST_INSERT_HEAD(&be_list, i, list);
00137    AST_RWLIST_UNLOCK(&be_list);
00138 
00139    return 0;
00140 }
00141 
00142 /*! unregister a CDR driver */
00143 void ast_cdr_unregister(const char *name)
00144 {
00145    struct ast_cdr_beitem *i = NULL;
00146 
00147    AST_RWLIST_WRLOCK(&be_list);
00148    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&be_list, i, list) {
00149       if (!strcasecmp(name, i->name)) {
00150          AST_RWLIST_REMOVE_CURRENT(list);
00151          ast_verb(2, "Unregistered '%s' CDR backend\n", name);
00152          ast_free(i);
00153          break;
00154       }
00155    }
00156    AST_RWLIST_TRAVERSE_SAFE_END;
00157    AST_RWLIST_UNLOCK(&be_list);
00158 }
00159 
00160 int ast_cdr_isset_unanswered(void)
00161 {
00162    return unanswered;
00163 }
00164 
00165 /*! Duplicate a CDR record 
00166    \returns Pointer to new CDR record
00167 */
00168 struct ast_cdr *ast_cdr_dup(struct ast_cdr *cdr) 
00169 {
00170    struct ast_cdr *newcdr;
00171    
00172    if (!cdr) /* don't die if we get a null cdr pointer */
00173       return NULL;
00174    newcdr = ast_cdr_alloc();
00175    if (!newcdr)
00176       return NULL;
00177 
00178    memcpy(newcdr, cdr, sizeof(*newcdr));
00179    /* The varshead is unusable, volatile even, after the memcpy so we take care of that here */
00180    memset(&newcdr->varshead, 0, sizeof(newcdr->varshead));
00181    ast_cdr_copy_vars(newcdr, cdr);
00182    newcdr->next = NULL;
00183 
00184    return newcdr;
00185 }
00186 
00187 static const char *ast_cdr_getvar_internal(struct ast_cdr *cdr, const char *name, int recur) 
00188 {
00189    if (ast_strlen_zero(name))
00190       return NULL;
00191 
00192    for (; cdr; cdr = recur ? cdr->next : NULL) {
00193       struct ast_var_t *variables;
00194       struct varshead *headp = &cdr->varshead;
00195       AST_LIST_TRAVERSE(headp, variables, entries) {
00196          if (!strcasecmp(name, ast_var_name(variables)))
00197             return ast_var_value(variables);
00198       }
00199    }
00200 
00201    return NULL;
00202 }
00203 
00204 static void cdr_get_tv(struct timeval when, const char *fmt, char *buf, int bufsize)
00205 {
00206    if (fmt == NULL) {   /* raw mode */
00207       snprintf(buf, bufsize, "%ld.%06ld", (long)when.tv_sec, (long)when.tv_usec);
00208    } else {
00209       if (when.tv_sec) {
00210          struct ast_tm tm;
00211          
00212          ast_localtime(&when, &tm, NULL);
00213          ast_strftime(buf, bufsize, fmt, &tm);
00214       }
00215    }
00216 }
00217 
00218 /*! CDR channel variable retrieval */
00219 void ast_cdr_getvar(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int recur, int raw) 
00220 {
00221    const char *fmt = "%Y-%m-%d %T";
00222    const char *varbuf;
00223 
00224    if (!cdr)  /* don't die if the cdr is null */
00225       return;
00226 
00227    *ret = NULL;
00228    /* special vars (the ones from the struct ast_cdr when requested by name) 
00229       I'd almost say we should convert all the stringed vals to vars */
00230 
00231    if (!strcasecmp(name, "clid"))
00232       ast_copy_string(workspace, cdr->clid, workspacelen);
00233    else if (!strcasecmp(name, "src"))
00234       ast_copy_string(workspace, cdr->src, workspacelen);
00235    else if (!strcasecmp(name, "dst"))
00236       ast_copy_string(workspace, cdr->dst, workspacelen);
00237    else if (!strcasecmp(name, "dcontext"))
00238       ast_copy_string(workspace, cdr->dcontext, workspacelen);
00239    else if (!strcasecmp(name, "channel"))
00240       ast_copy_string(workspace, cdr->channel, workspacelen);
00241    else if (!strcasecmp(name, "dstchannel"))
00242       ast_copy_string(workspace, cdr->dstchannel, workspacelen);
00243    else if (!strcasecmp(name, "lastapp"))
00244       ast_copy_string(workspace, cdr->lastapp, workspacelen);
00245    else if (!strcasecmp(name, "lastdata"))
00246       ast_copy_string(workspace, cdr->lastdata, workspacelen);
00247    else if (!strcasecmp(name, "start"))
00248       cdr_get_tv(cdr->start, raw ? NULL : fmt, workspace, workspacelen);
00249    else if (!strcasecmp(name, "answer"))
00250       cdr_get_tv(cdr->answer, raw ? NULL : fmt, workspace, workspacelen);
00251    else if (!strcasecmp(name, "end"))
00252       cdr_get_tv(cdr->end, raw ? NULL : fmt, workspace, workspacelen);
00253    else if (!strcasecmp(name, "duration"))
00254       snprintf(workspace, workspacelen, "%ld", cdr->duration ? cdr->duration : (long)ast_tvdiff_ms(ast_tvnow(), cdr->start) / 1000);
00255    else if (!strcasecmp(name, "billsec"))
00256       snprintf(workspace, workspacelen, "%ld", cdr->billsec || cdr->answer.tv_sec == 0 ? cdr->billsec : (long)ast_tvdiff_ms(ast_tvnow(), cdr->answer) / 1000);
00257    else if (!strcasecmp(name, "disposition")) {
00258       if (raw) {
00259          snprintf(workspace, workspacelen, "%ld", cdr->disposition);
00260       } else {
00261          ast_copy_string(workspace, ast_cdr_disp2str(cdr->disposition), workspacelen);
00262       }
00263    } else if (!strcasecmp(name, "amaflags")) {
00264       if (raw) {
00265          snprintf(workspace, workspacelen, "%ld", cdr->amaflags);
00266       } else {
00267          ast_copy_string(workspace, ast_cdr_flags2str(cdr->amaflags), workspacelen);
00268       }
00269    } else if (!strcasecmp(name, "accountcode"))
00270       ast_copy_string(workspace, cdr->accountcode, workspacelen);
00271    else if (!strcasecmp(name, "uniqueid"))
00272       ast_copy_string(workspace, cdr->uniqueid, workspacelen);
00273    else if (!strcasecmp(name, "userfield"))
00274       ast_copy_string(workspace, cdr->userfield, workspacelen);
00275    else if ((varbuf = ast_cdr_getvar_internal(cdr, name, recur)))
00276       ast_copy_string(workspace, varbuf, workspacelen);
00277    else
00278       workspace[0] = '\0';
00279 
00280    if (!ast_strlen_zero(workspace))
00281       *ret = workspace;
00282 }
00283 
00284 /* readonly cdr variables */
00285 static   const char *cdr_readonly_vars[] = { "clid", "src", "dst", "dcontext", "channel", "dstchannel",
00286                 "lastapp", "lastdata", "start", "answer", "end", "duration",
00287                 "billsec", "disposition", "amaflags", "accountcode", "uniqueid",
00288                 "userfield", NULL };
00289 /*! Set a CDR channel variable 
00290    \note You can't set the CDR variables that belong to the actual CDR record, like "billsec".
00291 */
00292 int ast_cdr_setvar(struct ast_cdr *cdr, const char *name, const char *value, int recur) 
00293 {
00294    struct ast_var_t *newvariable;
00295    struct varshead *headp;
00296    int x;
00297    
00298    if (!cdr)  /* don't die if the cdr is null */
00299       return -1;
00300    
00301    for (x = 0; cdr_readonly_vars[x]; x++) {
00302       if (!strcasecmp(name, cdr_readonly_vars[x])) {
00303          ast_log(LOG_ERROR, "Attempt to set the '%s' read-only variable!.\n", name);
00304          return -1;
00305       }
00306    }
00307 
00308    if (!cdr) {
00309       ast_log(LOG_ERROR, "Attempt to set a variable on a nonexistent CDR record.\n");
00310       return -1;
00311    }
00312 
00313    for (; cdr; cdr = recur ? cdr->next : NULL) {
00314       if (ast_test_flag(cdr, AST_CDR_FLAG_DONT_TOUCH) && ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00315          continue;
00316       headp = &cdr->varshead;
00317       AST_LIST_TRAVERSE_SAFE_BEGIN(headp, newvariable, entries) {
00318          if (!strcasecmp(ast_var_name(newvariable), name)) {
00319             /* there is already such a variable, delete it */
00320             AST_LIST_REMOVE_CURRENT(entries);
00321             ast_var_delete(newvariable);
00322             break;
00323          }
00324       }
00325       AST_LIST_TRAVERSE_SAFE_END;
00326       
00327       if (value) {
00328          newvariable = ast_var_assign(name, value);
00329          AST_LIST_INSERT_HEAD(headp, newvariable, entries);
00330       }
00331    }
00332 
00333    return 0;
00334 }
00335 
00336 int ast_cdr_copy_vars(struct ast_cdr *to_cdr, struct ast_cdr *from_cdr)
00337 {
00338    struct ast_var_t *variables, *newvariable = NULL;
00339    struct varshead *headpa, *headpb;
00340    const char *var, *val;
00341    int x = 0;
00342 
00343    if (!to_cdr || !from_cdr) /* don't die if one of the pointers is null */
00344       return 0;
00345 
00346    headpa = &from_cdr->varshead;
00347    headpb = &to_cdr->varshead;
00348 
00349    AST_LIST_TRAVERSE(headpa,variables,entries) {
00350       if (variables &&
00351           (var = ast_var_name(variables)) && (val = ast_var_value(variables)) &&
00352           !ast_strlen_zero(var) && !ast_strlen_zero(val)) {
00353          newvariable = ast_var_assign(var, val);
00354          AST_LIST_INSERT_HEAD(headpb, newvariable, entries);
00355          x++;
00356       }
00357    }
00358 
00359    return x;
00360 }
00361 
00362 int ast_cdr_serialize_variables(struct ast_cdr *cdr, struct ast_str **buf, char delim, char sep, int recur) 
00363 {
00364    struct ast_var_t *variables;
00365    const char *var, *val;
00366    char *tmp;
00367    char workspace[256];
00368    int total = 0, x = 0, i;
00369 
00370    (*buf)->used = 0;
00371    (*buf)->str[0] = '\0';
00372 
00373    for (; cdr; cdr = recur ? cdr->next : NULL) {
00374       if (++x > 1)
00375          ast_str_append(buf, 0, "\n");
00376 
00377       AST_LIST_TRAVERSE(&cdr->varshead, variables, entries) {
00378          if (variables &&
00379              (var = ast_var_name(variables)) && (val = ast_var_value(variables)) &&
00380              !ast_strlen_zero(var) && !ast_strlen_zero(val)) {
00381             if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, var, delim, val, sep) < 0) {
00382                ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
00383                break;
00384             } else
00385                total++;
00386          } else 
00387             break;
00388       }
00389 
00390       for (i = 0; cdr_readonly_vars[i]; i++) {
00391          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 */
00392          ast_cdr_getvar(cdr, cdr_readonly_vars[i], &tmp, workspace, sizeof(workspace), 0, 0);
00393          if (!tmp)
00394             continue;
00395          
00396          if (ast_str_append(buf, 0, "level %d: %s%c%s%c", x, cdr_readonly_vars[i], delim, tmp, sep) < 0) {
00397             ast_log(LOG_ERROR, "Data Buffer Size Exceeded!\n");
00398             break;
00399          } else
00400             total++;
00401       }
00402    }
00403 
00404    return total;
00405 }
00406 
00407 
00408 void ast_cdr_free_vars(struct ast_cdr *cdr, int recur)
00409 {
00410 
00411    /* clear variables */
00412    for (; cdr; cdr = recur ? cdr->next : NULL) {
00413       struct ast_var_t *vardata;
00414       struct varshead *headp = &cdr->varshead;
00415       while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
00416          ast_var_delete(vardata);
00417    }
00418 }
00419 
00420 /*! \brief  print a warning if cdr already posted */
00421 static void check_post(struct ast_cdr *cdr)
00422 {
00423    if (!cdr)
00424       return;
00425    if (ast_test_flag(cdr, AST_CDR_FLAG_POSTED))
00426       ast_log(LOG_NOTICE, "CDR on channel '%s' already posted\n", S_OR(cdr->channel, "<unknown>"));
00427 }
00428 
00429 void ast_cdr_free(struct ast_cdr *cdr)
00430 {
00431 
00432    while (cdr) {
00433       struct ast_cdr *next = cdr->next;
00434 
00435       ast_cdr_free_vars(cdr, 0);
00436       ast_free(cdr);
00437       cdr = next;
00438    }
00439 }
00440 
00441 /*! \brief the same as a cdr_free call, only with no checks; just get rid of it */
00442 void ast_cdr_discard(struct ast_cdr *cdr)
00443 {
00444    while (cdr) {
00445       struct ast_cdr *next = cdr->next;
00446 
00447       ast_cdr_free_vars(cdr, 0);
00448       ast_free(cdr);
00449       cdr = next;
00450    }
00451 }
00452 
00453 struct ast_cdr *ast_cdr_alloc(void)
00454 {
00455    struct ast_cdr *x;
00456    x = ast_calloc(1, sizeof(*x));
00457    if (!x)
00458       ast_log(LOG_ERROR,"Allocation Failure for a CDR!\n");
00459    return x;
00460 }
00461 
00462 static void cdr_merge_vars(struct ast_cdr *to, struct ast_cdr *from)
00463 {
00464    struct ast_var_t *variablesfrom,*variablesto;
00465    struct varshead *headpfrom = &to->varshead;
00466    struct varshead *headpto = &from->varshead;
00467    AST_LIST_TRAVERSE_SAFE_BEGIN(headpfrom, variablesfrom, entries) {
00468       /* for every var in from, stick it in to */
00469       const char *fromvarname, *fromvarval;
00470       const char *tovarname = NULL, *tovarval = NULL;
00471       fromvarname = ast_var_name(variablesfrom);
00472       fromvarval = ast_var_value(variablesfrom);
00473       tovarname = 0;
00474 
00475       /* now, quick see if that var is in the 'to' cdr already */
00476       AST_LIST_TRAVERSE(headpto, variablesto, entries) {
00477 
00478          /* now, quick see if that var is in the 'to' cdr already */
00479          if ( strcasecmp(fromvarname, ast_var_name(variablesto)) == 0 ) {
00480             tovarname = ast_var_name(variablesto);
00481             tovarval = ast_var_value(variablesto);
00482             break;
00483          }
00484       }
00485       if (tovarname && strcasecmp(fromvarval,tovarval) != 0) {  /* this message here to see how irritating the userbase finds it */
00486          ast_log(LOG_NOTICE, "Merging CDR's: variable %s value %s dropped in favor of value %s\n", tovarname, fromvarval, tovarval);
00487          continue;
00488       } else if (tovarname && strcasecmp(fromvarval,tovarval) == 0) /* if they are the same, the job is done */
00489          continue;
00490 
00491       /* rip this var out of the from cdr, and stick it in the to cdr */
00492       AST_LIST_MOVE_CURRENT(headpto, entries);
00493    }
00494    AST_LIST_TRAVERSE_SAFE_END;
00495 }
00496 
00497 void ast_cdr_merge(struct ast_cdr *to, struct ast_cdr *from)
00498 {
00499    struct ast_cdr *zcdr;
00500    struct ast_cdr *lto = NULL;
00501    struct ast_cdr *lfrom = NULL;
00502    int discard_from = 0;
00503    
00504    if (!to || !from)
00505       return;
00506 
00507    /* don't merge into locked CDR's -- it's bad business */
00508    if (ast_test_flag(to, AST_CDR_FLAG_LOCKED)) {
00509       zcdr = to; /* safety valve? */
00510       while (to->next) {
00511          lto = to;
00512          to = to->next;
00513       }
00514       
00515       if (ast_test_flag(to, AST_CDR_FLAG_LOCKED)) {
00516          ast_log(LOG_WARNING, "Merging into locked CDR... no choice.");
00517          to = zcdr; /* safety-- if all there are is locked CDR's, then.... ?? */
00518          lto = NULL;
00519       }
00520    }
00521 
00522    if (ast_test_flag(from, AST_CDR_FLAG_LOCKED)) {
00523       struct ast_cdr *llfrom = NULL;
00524       discard_from = 1;
00525       if (lto) {
00526          /* insert the from stuff after lto */
00527          lto->next = from;
00528          lfrom = from;
00529          while (lfrom && lfrom->next) {
00530             if (!lfrom->next->next)
00531                llfrom = lfrom;
00532             lfrom = lfrom->next; 
00533          }
00534          /* rip off the last entry and put a copy of the to at the end */
00535          llfrom->next = to;
00536          from = lfrom;
00537       } else {
00538          /* save copy of the current *to cdr */
00539          struct ast_cdr tcdr;
00540          memcpy(&tcdr, to, sizeof(tcdr));
00541          /* copy in the locked from cdr */
00542          memcpy(to, from, sizeof(*to));
00543          lfrom = from;
00544          while (lfrom && lfrom->next) {
00545             if (!lfrom->next->next)
00546                llfrom = lfrom;
00547             lfrom = lfrom->next; 
00548          }
00549          from->next = NULL;
00550          /* rip off the last entry and put a copy of the to at the end */
00551          if (llfrom == from)
00552             to = to->next = ast_cdr_dup(&tcdr);
00553          else
00554             to = llfrom->next = ast_cdr_dup(&tcdr);
00555          from = lfrom;
00556       }
00557    }
00558    
00559    if (!ast_tvzero(from->start)) {
00560       if (!ast_tvzero(to->start)) {
00561          if (ast_tvcmp(to->start, from->start) > 0 ) {
00562             to->start = from->start; /* use the earliest time */
00563             from->start = ast_tv(0,0); /* we actively "steal" these values */
00564          }
00565          /* else nothing to do */
00566       } else {
00567          to->start = from->start;
00568          from->start = ast_tv(0,0); /* we actively "steal" these values */
00569       }
00570    }
00571    if (!ast_tvzero(from->answer)) {
00572       if (!ast_tvzero(to->answer)) {
00573          if (ast_tvcmp(to->answer, from->answer) > 0 ) {
00574             to->answer = from->answer; /* use the earliest time */
00575             from->answer = ast_tv(0,0); /* we actively "steal" these values */
00576          }
00577          /* we got the earliest answer time, so we'll settle for that? */
00578       } else {
00579          to->answer = from->answer;
00580          from->answer = ast_tv(0,0); /* we actively "steal" these values */
00581       }
00582    }
00583    if (!ast_tvzero(from->end)) {
00584       if (!ast_tvzero(to->end)) {
00585          if (ast_tvcmp(to->end, from->end) < 0 ) {
00586             to->end = from->end; /* use the latest time */
00587             from->end = ast_tv(0,0); /* we actively "steal" these values */
00588             to->duration = to->end.tv_sec - to->start.tv_sec;  /* don't forget to update the duration, billsec, when we set end */
00589             to->billsec = ast_tvzero(to->answer) ? 0 : to->end.tv_sec - to->answer.tv_sec;
00590          }
00591          /* else, nothing to do */
00592       } else {
00593          to->end = from->end;
00594          from->end = ast_tv(0,0); /* we actively "steal" these values */
00595          to->duration = to->end.tv_sec - to->start.tv_sec;
00596          to->billsec = ast_tvzero(to->answer) ? 0 : to->end.tv_sec - to->answer.tv_sec;
00597       }
00598    }
00599    if (to->disposition < from->disposition) {
00600       to->disposition = from->disposition;
00601       from->disposition = AST_CDR_NOANSWER;
00602    }
00603    if (ast_strlen_zero(to->lastapp) && !ast_strlen_zero(from->lastapp)) {
00604       ast_copy_string(to->lastapp, from->lastapp, sizeof(to->lastapp));
00605       from->lastapp[0] = 0; /* theft */
00606    }
00607    if (ast_strlen_zero(to->lastdata) && !ast_strlen_zero(from->lastdata)) {
00608       ast_copy_string(to->lastdata, from->lastdata, sizeof(to->lastdata));
00609       from->lastdata[0] = 0; /* theft */
00610    }
00611    if (ast_strlen_zero(to->dcontext) && !ast_strlen_zero(from->dcontext)) {
00612       ast_copy_string(to->dcontext, from->dcontext, sizeof(to->dcontext));
00613       from->dcontext[0] = 0; /* theft */
00614    }
00615    if (ast_strlen_zero(to->dstchannel) && !ast_strlen_zero(from->dstchannel)) {
00616       ast_copy_string(to->dstchannel, from->dstchannel, sizeof(to->dstchannel));
00617       from->dstchannel[0] = 0; /* theft */
00618    }
00619    if (!ast_strlen_zero(from->channel) && (ast_strlen_zero(to->channel) || !strncasecmp(from->channel, "Agent/", 6))) {
00620       ast_copy_string(to->channel, from->channel, sizeof(to->channel));
00621       from->channel[0] = 0; /* theft */
00622    }
00623    if (ast_strlen_zero(to->src) && !ast_strlen_zero(from->src)) {
00624       ast_copy_string(to->src, from->src, sizeof(to->src));
00625       from->src[0] = 0; /* theft */
00626    }
00627    if (ast_strlen_zero(to->clid) && !ast_strlen_zero(from->clid)) {
00628       ast_copy_string(to->clid, from->clid, sizeof(to->clid));
00629       from->clid[0] = 0; /* theft */
00630    }
00631    if (ast_strlen_zero(to->dst) && !ast_strlen_zero(from->dst)) {
00632       ast_copy_string(to->dst, from->dst, sizeof(to->dst));
00633       from->dst[0] = 0; /* theft */
00634    }
00635    if (!to->amaflags)
00636       to->amaflags = AST_CDR_DOCUMENTATION;
00637    if (!from->amaflags)
00638       from->amaflags = AST_CDR_DOCUMENTATION; /* make sure both amaflags are set to something (DOC is default) */
00639    if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (to->amaflags == AST_CDR_DOCUMENTATION && from->amaflags != AST_CDR_DOCUMENTATION)) {
00640       to->amaflags = from->amaflags;
00641    }
00642    if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (ast_strlen_zero(to->accountcode) && !ast_strlen_zero(from->accountcode))) {
00643       ast_copy_string(to->accountcode, from->accountcode, sizeof(to->accountcode));
00644    }
00645    if (ast_test_flag(from, AST_CDR_FLAG_LOCKED) || (ast_strlen_zero(to->userfield) && !ast_strlen_zero(from->userfield))) {
00646       ast_copy_string(to->userfield, from->userfield, sizeof(to->userfield));
00647    }
00648    /* flags, varsead, ? */
00649    cdr_merge_vars(from, to);
00650 
00651    if (ast_test_flag(from, AST_CDR_FLAG_KEEP_VARS))
00652       ast_set_flag(to, AST_CDR_FLAG_KEEP_VARS);
00653    if (ast_test_flag(from, AST_CDR_FLAG_POSTED))
00654       ast_set_flag(to, AST_CDR_FLAG_POSTED);
00655    if (ast_test_flag(from, AST_CDR_FLAG_LOCKED))
00656       ast_set_flag(to, AST_CDR_FLAG_LOCKED);
00657    if (ast_test_flag(from, AST_CDR_FLAG_CHILD))
00658       ast_set_flag(to, AST_CDR_FLAG_CHILD);
00659    if (ast_test_flag(from, AST_CDR_FLAG_POST_DISABLED))
00660       ast_set_flag(to, AST_CDR_FLAG_POST_DISABLED);
00661 
00662    /* last, but not least, we need to merge any forked CDRs to the 'to' cdr */
00663    while (from->next) {
00664       /* just rip 'em off the 'from' and insert them on the 'to' */
00665       zcdr = from->next;
00666       from->next = zcdr->next;
00667       zcdr->next = NULL;
00668       /* zcdr is now ripped from the current list; */
00669       ast_cdr_append(to, zcdr);
00670    }
00671    if (discard_from)
00672       ast_cdr_discard(from);
00673 }
00674 
00675 void ast_cdr_start(struct ast_cdr *cdr)
00676 {
00677    char *chan; 
00678 
00679    for (; cdr; cdr = cdr->next) {
00680       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00681          chan = S_OR(cdr->channel, "<unknown>");
00682          check_post(cdr);
00683          cdr->start = ast_tvnow();
00684       }
00685    }
00686 }
00687 
00688 void ast_cdr_answer(struct ast_cdr *cdr)
00689 {
00690 
00691    for (; cdr; cdr = cdr->next) {
00692       if (ast_test_flag(cdr, AST_CDR_FLAG_ANSLOCKED)) 
00693          continue;
00694       if (ast_test_flag(cdr, AST_CDR_FLAG_DONT_TOUCH) && ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00695          continue;
00696       check_post(cdr);
00697       if (cdr->disposition < AST_CDR_ANSWERED)
00698          cdr->disposition = AST_CDR_ANSWERED;
00699       if (ast_tvzero(cdr->answer))
00700          cdr->answer = ast_tvnow();
00701    }
00702 }
00703 
00704 void ast_cdr_busy(struct ast_cdr *cdr)
00705 {
00706 
00707    for (; cdr; cdr = cdr->next) {
00708       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00709          check_post(cdr);
00710          if (cdr->disposition < AST_CDR_BUSY)
00711             cdr->disposition = AST_CDR_BUSY;
00712       }
00713    }
00714 }
00715 
00716 void ast_cdr_failed(struct ast_cdr *cdr)
00717 {
00718    for (; cdr; cdr = cdr->next) {
00719       check_post(cdr);
00720       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00721          check_post(cdr);
00722          if (cdr->disposition < AST_CDR_FAILED)
00723             cdr->disposition = AST_CDR_FAILED;
00724       }
00725    }
00726 }
00727 
00728 void ast_cdr_noanswer(struct ast_cdr *cdr)
00729 {
00730    char *chan; 
00731 
00732    while (cdr) {
00733       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00734          chan = !ast_strlen_zero(cdr->channel) ? cdr->channel : "<unknown>";
00735          if (ast_test_flag(cdr, AST_CDR_FLAG_POSTED))
00736             ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan);
00737          if (cdr->disposition < AST_CDR_NOANSWER)
00738             cdr->disposition = AST_CDR_NOANSWER;
00739       }
00740       cdr = cdr->next;
00741    }
00742 }
00743 
00744 /* everywhere ast_cdr_disposition is called, it will call ast_cdr_failed() 
00745    if ast_cdr_disposition returns a non-zero value */
00746 
00747 int ast_cdr_disposition(struct ast_cdr *cdr, int cause)
00748 {
00749    int res = 0;
00750 
00751    for (; cdr; cdr = cdr->next) {
00752       switch (cause) {  /* handle all the non failure, busy cases, return 0 not to set disposition,
00753                      return -1 to set disposition to FAILED */
00754       case AST_CAUSE_BUSY:
00755          ast_cdr_busy(cdr);
00756          break;
00757       case AST_CAUSE_NO_ANSWER:
00758          ast_cdr_noanswer(cdr);
00759          break;
00760       case AST_CAUSE_NORMAL:
00761          break;
00762       default:
00763          res = -1;
00764       }
00765    }
00766    return res;
00767 }
00768 
00769 void ast_cdr_setdestchan(struct ast_cdr *cdr, const char *chann)
00770 {
00771    for (; cdr; cdr = cdr->next) {
00772       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00773          check_post(cdr);
00774          ast_copy_string(cdr->dstchannel, chann, sizeof(cdr->dstchannel));
00775       }
00776    }
00777 }
00778 
00779 void ast_cdr_setapp(struct ast_cdr *cdr, char *app, char *data)
00780 {
00781 
00782    for (; cdr; cdr = cdr->next) {
00783       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00784          check_post(cdr);
00785          ast_copy_string(cdr->lastapp, S_OR(app, ""), sizeof(cdr->lastapp));
00786          ast_copy_string(cdr->lastdata, S_OR(data, ""), sizeof(cdr->lastdata));
00787       }
00788    }
00789 }
00790 
00791 void ast_cdr_setanswer(struct ast_cdr *cdr, struct timeval t)
00792 {
00793 
00794    for (; cdr; cdr = cdr->next) {
00795       if (ast_test_flag(cdr, AST_CDR_FLAG_ANSLOCKED))
00796          continue;
00797       if (ast_test_flag(cdr, AST_CDR_FLAG_DONT_TOUCH) && ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00798          continue;
00799       check_post(cdr);
00800       cdr->answer = t;
00801    }
00802 }
00803 
00804 void ast_cdr_setdisposition(struct ast_cdr *cdr, long int disposition)
00805 {
00806 
00807    for (; cdr; cdr = cdr->next) {
00808       if (ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00809          continue;
00810       check_post(cdr);
00811       cdr->disposition = disposition;
00812    }
00813 }
00814 
00815 /* set cid info for one record */
00816 static void set_one_cid(struct ast_cdr *cdr, struct ast_channel *c)
00817 {
00818    /* Grab source from ANI or normal Caller*ID */
00819    const char *num = S_OR(c->cid.cid_ani, c->cid.cid_num);
00820    if (!cdr)
00821       return;
00822    if (!ast_strlen_zero(c->cid.cid_name)) {
00823       if (!ast_strlen_zero(num)) /* both name and number */
00824          snprintf(cdr->clid, sizeof(cdr->clid), "\"%s\" <%s>", c->cid.cid_name, num);
00825       else           /* only name */
00826          ast_copy_string(cdr->clid, c->cid.cid_name, sizeof(cdr->clid));
00827    } else if (!ast_strlen_zero(num)) { /* only number */
00828       ast_copy_string(cdr->clid, num, sizeof(cdr->clid));
00829    } else {          /* nothing known */
00830       cdr->clid[0] = '\0';
00831    }
00832    ast_copy_string(cdr->src, S_OR(num, ""), sizeof(cdr->src));
00833 
00834 }
00835 int ast_cdr_setcid(struct ast_cdr *cdr, struct ast_channel *c)
00836 {
00837    for (; cdr; cdr = cdr->next) {
00838       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00839          set_one_cid(cdr, c);
00840    }
00841    return 0;
00842 }
00843 
00844 int ast_cdr_init(struct ast_cdr *cdr, struct ast_channel *c)
00845 {
00846    char *chan;
00847 
00848    for ( ; cdr ; cdr = cdr->next) {
00849       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00850          chan = S_OR(cdr->channel, "<unknown>");
00851          ast_copy_string(cdr->channel, c->name, sizeof(cdr->channel));
00852          set_one_cid(cdr, c);
00853 
00854          cdr->disposition = (c->_state == AST_STATE_UP) ?  AST_CDR_ANSWERED : AST_CDR_NOANSWER;
00855          cdr->amaflags = c->amaflags ? c->amaflags :  ast_default_amaflags;
00856          ast_copy_string(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode));
00857          /* Destination information */
00858          ast_copy_string(cdr->dst, S_OR(c->macroexten,c->exten), sizeof(cdr->dst));
00859          ast_copy_string(cdr->dcontext, S_OR(c->macrocontext,c->context), sizeof(cdr->dcontext));
00860          /* Unique call identifier */
00861          ast_copy_string(cdr->uniqueid, c->uniqueid, sizeof(cdr->uniqueid));
00862       }
00863    }
00864    return 0;
00865 }
00866 
00867 /* Three routines were "fixed" via 10668, and later shown that 
00868    users were depending on this behavior. ast_cdr_end,
00869    ast_cdr_setvar and ast_cdr_answer are the three routines.
00870    While most of the other routines would not touch 
00871    LOCKED cdr's, these three routines were designed to
00872    operate on locked CDR's as a matter of course.
00873    I now appreciate how this plays with the ForkCDR app,
00874    which forms these cdr chains in the first place. 
00875    cdr_end is pretty key: all cdrs created are closed
00876    together. They only vary by start time. Arithmetically,
00877    users can calculate the subintervals they wish to track. */
00878 
00879 void ast_cdr_end(struct ast_cdr *cdr)
00880 {
00881    for ( ; cdr ; cdr = cdr->next) {
00882       if (ast_test_flag(cdr, AST_CDR_FLAG_DONT_TOUCH) && ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00883          continue;
00884       check_post(cdr);
00885       if (ast_tvzero(cdr->end))
00886          cdr->end = ast_tvnow();
00887       if (ast_tvzero(cdr->start)) {
00888          ast_log(LOG_WARNING, "CDR on channel '%s' has not started\n", S_OR(cdr->channel, "<unknown>"));
00889          cdr->disposition = AST_CDR_FAILED;
00890       } else
00891          cdr->duration = cdr->end.tv_sec - cdr->start.tv_sec;
00892       if (ast_tvzero(cdr->answer)) {
00893          if (cdr->disposition == AST_CDR_ANSWERED) {
00894             ast_log(LOG_WARNING, "CDR on channel '%s' has no answer time but is 'ANSWERED'\n", S_OR(cdr->channel, "<unknown>"));
00895             cdr->disposition = AST_CDR_FAILED;
00896          }
00897       } else
00898          cdr->billsec = cdr->end.tv_sec - cdr->answer.tv_sec;
00899    }
00900 }
00901 
00902 char *ast_cdr_disp2str(int disposition)
00903 {
00904    switch (disposition) {
00905    case AST_CDR_NULL:
00906       return "NO ANSWER"; /* by default, for backward compatibility */
00907    case AST_CDR_NOANSWER:
00908       return "NO ANSWER";
00909    case AST_CDR_FAILED:
00910       return "FAILED";     
00911    case AST_CDR_BUSY:
00912       return "BUSY";    
00913    case AST_CDR_ANSWERED:
00914       return "ANSWERED";
00915    }
00916    return "UNKNOWN";
00917 }
00918 
00919 /*! Converts AMA flag to printable string */
00920 char *ast_cdr_flags2str(int flag)
00921 {
00922    switch (flag) {
00923    case AST_CDR_OMIT:
00924       return "OMIT";
00925    case AST_CDR_BILLING:
00926       return "BILLING";
00927    case AST_CDR_DOCUMENTATION:
00928       return "DOCUMENTATION";
00929    }
00930    return "Unknown";
00931 }
00932 
00933 int ast_cdr_setaccount(struct ast_channel *chan, const char *account)
00934 {
00935    struct ast_cdr *cdr = chan->cdr;
00936    char buf[BUFSIZ/2] = "";
00937    if (!ast_strlen_zero(chan->accountcode))
00938       ast_copy_string(buf, chan->accountcode, sizeof(buf));
00939 
00940    ast_string_field_set(chan, accountcode, account);
00941    for ( ; cdr ; cdr = cdr->next) {
00942       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00943          ast_copy_string(cdr->accountcode, chan->accountcode, sizeof(cdr->accountcode));
00944       }
00945    }
00946 
00947    /* Signal change of account code to manager */
00948    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);
00949    return 0;
00950 }
00951 
00952 int ast_cdr_setamaflags(struct ast_channel *chan, const char *flag)
00953 {
00954    struct ast_cdr *cdr;
00955    int newflag = ast_cdr_amaflags2int(flag);
00956    if (newflag) {
00957       for (cdr = chan->cdr; cdr; cdr = cdr->next) {
00958          if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00959             cdr->amaflags = newflag;
00960          }
00961       }
00962    }
00963 
00964    return 0;
00965 }
00966 
00967 int ast_cdr_setuserfield(struct ast_channel *chan, const char *userfield)
00968 {
00969    struct ast_cdr *cdr = chan->cdr;
00970 
00971    for ( ; cdr ; cdr = cdr->next) {
00972       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) 
00973          ast_copy_string(cdr->userfield, userfield, sizeof(cdr->userfield));
00974    }
00975 
00976    return 0;
00977 }
00978 
00979 int ast_cdr_appenduserfield(struct ast_channel *chan, const char *userfield)
00980 {
00981    struct ast_cdr *cdr = chan->cdr;
00982 
00983    for ( ; cdr ; cdr = cdr->next) {
00984       int len = strlen(cdr->userfield);
00985 
00986       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED))
00987          ast_copy_string(cdr->userfield + len, userfield, sizeof(cdr->userfield) - len);
00988    }
00989 
00990    return 0;
00991 }
00992 
00993 int ast_cdr_update(struct ast_channel *c)
00994 {
00995    struct ast_cdr *cdr = c->cdr;
00996 
00997    for ( ; cdr ; cdr = cdr->next) {
00998       if (!ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
00999          set_one_cid(cdr, c);
01000 
01001          /* Copy account code et-al */ 
01002          ast_copy_string(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode));
01003          
01004          /* Destination information */ /* XXX privilege macro* ? */
01005          ast_copy_string(cdr->dst, S_OR(c->macroexten, c->exten), sizeof(cdr->dst));
01006          ast_copy_string(cdr->dcontext, S_OR(c->macrocontext, c->context), sizeof(cdr->dcontext));
01007       }
01008    }
01009 
01010    return 0;
01011 }
01012 
01013 int ast_cdr_amaflags2int(const char *flag)
01014 {
01015    if (!strcasecmp(flag, "default"))
01016       return 0;
01017    if (!strcasecmp(flag, "omit"))
01018       return AST_CDR_OMIT;
01019    if (!strcasecmp(flag, "billing"))
01020       return AST_CDR_BILLING;
01021    if (!strcasecmp(flag, "documentation"))
01022       return AST_CDR_DOCUMENTATION;
01023    return -1;
01024 }
01025 
01026 static void post_cdr(struct ast_cdr *cdr)
01027 {
01028    char *chan;
01029    struct ast_cdr_beitem *i;
01030 
01031    for ( ; cdr ; cdr = cdr->next) {
01032       if (!unanswered && cdr->disposition < AST_CDR_ANSWERED && (ast_strlen_zero(cdr->channel) || ast_strlen_zero(cdr->dstchannel))) {
01033          /* For people, who don't want to see unanswered single-channel events */
01034          ast_set_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
01035          continue;
01036       }
01037 
01038       /* don't post CDRs that are for dialed channels unless those
01039        * channels were originated from asterisk (pbx_spool, manager,
01040        * cli) */
01041       if (ast_test_flag(cdr, AST_CDR_FLAG_DIALED) && !ast_test_flag(cdr, AST_CDR_FLAG_ORIGINATED)) {
01042          ast_set_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
01043          continue;
01044       }
01045 
01046       chan = S_OR(cdr->channel, "<unknown>");
01047       check_post(cdr);
01048       ast_set_flag(cdr, AST_CDR_FLAG_POSTED);
01049       if (ast_test_flag(cdr, AST_CDR_FLAG_POST_DISABLED))
01050          continue;
01051       AST_RWLIST_RDLOCK(&be_list);
01052       AST_RWLIST_TRAVERSE(&be_list, i, list) {
01053          i->be(cdr);
01054       }
01055       AST_RWLIST_UNLOCK(&be_list);
01056    }
01057 }
01058 
01059 void ast_cdr_reset(struct ast_cdr *cdr, struct ast_flags *_flags)
01060 {
01061    struct ast_cdr *duplicate;
01062    struct ast_flags flags = { 0 };
01063 
01064    if (_flags)
01065       ast_copy_flags(&flags, _flags, AST_FLAGS_ALL);
01066 
01067    for ( ; cdr ; cdr = cdr->next) {
01068       /* Detach if post is requested */
01069       if (ast_test_flag(&flags, AST_CDR_FLAG_LOCKED) || !ast_test_flag(cdr, AST_CDR_FLAG_LOCKED)) {
01070          if (ast_test_flag(&flags, AST_CDR_FLAG_POSTED)) {
01071             ast_cdr_end(cdr);
01072             if ((duplicate = ast_cdr_dup(cdr))) {
01073                ast_cdr_detach(duplicate);
01074             }
01075             ast_set_flag(cdr, AST_CDR_FLAG_POSTED);
01076          }
01077 
01078          /* enable CDR only */
01079          if (ast_test_flag(&flags, AST_CDR_FLAG_POST_ENABLE)) {
01080             ast_clear_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
01081             continue;
01082          }
01083 
01084          /* clear variables */
01085          if (!ast_test_flag(&flags, AST_CDR_FLAG_KEEP_VARS)) {
01086             ast_cdr_free_vars(cdr, 0);
01087          }
01088 
01089          /* Reset to initial state */
01090          ast_clear_flag(cdr, AST_FLAGS_ALL); 
01091          memset(&cdr->start, 0, sizeof(cdr->start));
01092          memset(&cdr->end, 0, sizeof(cdr->end));
01093          memset(&cdr->answer, 0, sizeof(cdr->answer));
01094          cdr->billsec = 0;
01095          cdr->duration = 0;
01096          ast_cdr_start(cdr);
01097          cdr->disposition = AST_CDR_NOANSWER;
01098       }
01099    }
01100 }
01101 
01102 void ast_cdr_specialized_reset(struct ast_cdr *cdr, struct ast_flags *_flags)
01103 {
01104    struct ast_flags flags = { 0 };
01105 
01106    if (_flags)
01107       ast_copy_flags(&flags, _flags, AST_FLAGS_ALL);
01108    
01109    /* Reset to initial state */
01110    if (ast_test_flag(cdr, AST_CDR_FLAG_POST_DISABLED)) { /* But do NOT lose the NoCDR() setting */
01111       ast_clear_flag(cdr, AST_FLAGS_ALL); 
01112       ast_set_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
01113    } else {
01114       ast_clear_flag(cdr, AST_FLAGS_ALL); 
01115    }
01116    
01117    memset(&cdr->start, 0, sizeof(cdr->start));
01118    memset(&cdr->end, 0, sizeof(cdr->end));
01119    memset(&cdr->answer, 0, sizeof(cdr->answer));
01120    cdr->billsec = 0;
01121    cdr->duration = 0;
01122    ast_cdr_start(cdr);
01123    cdr->disposition = AST_CDR_NULL;
01124 }
01125 
01126 struct ast_cdr *ast_cdr_append(struct ast_cdr *cdr, struct ast_cdr *newcdr) 
01127 {
01128    struct ast_cdr *ret;
01129 
01130    if (cdr) {
01131       ret = cdr;
01132 
01133       while (cdr->next)
01134          cdr = cdr->next;
01135       cdr->next = newcdr;
01136    } else {
01137       ret = newcdr;
01138    }
01139 
01140    return ret;
01141 }
01142 
01143 /*! \note Don't call without cdr_batch_lock */
01144 static void reset_batch(void)
01145 {
01146    batch->size = 0;
01147    batch->head = NULL;
01148    batch->tail = NULL;
01149 }
01150 
01151 /*! \note Don't call without cdr_batch_lock */
01152 static int init_batch(void)
01153 {
01154    /* This is the single meta-batch used to keep track of all CDRs during the entire life of the program */
01155    if (!(batch = ast_malloc(sizeof(*batch))))
01156       return -1;
01157 
01158    reset_batch();
01159 
01160    return 0;
01161 }
01162 
01163 static void *do_batch_backend_process(void *data)
01164 {
01165    struct ast_cdr_batch_item *processeditem;
01166    struct ast_cdr_batch_item *batchitem = data;
01167 
01168    /* Push each CDR into storage mechanism(s) and free all the memory */
01169    while (batchitem) {
01170       post_cdr(batchitem->cdr);
01171       ast_cdr_free(batchitem->cdr);
01172       processeditem = batchitem;
01173       batchitem = batchitem->next;
01174       ast_free(processeditem);
01175    }
01176 
01177    return NULL;
01178 }
01179 
01180 void ast_cdr_submit_batch(int do_shutdown)
01181 {
01182    struct ast_cdr_batch_item *oldbatchitems = NULL;
01183    pthread_t batch_post_thread = AST_PTHREADT_NULL;
01184 
01185    /* if there's no batch, or no CDRs in the batch, then there's nothing to do */
01186    if (!batch || !batch->head)
01187       return;
01188 
01189    /* move the old CDRs aside, and prepare a new CDR batch */
01190    ast_mutex_lock(&cdr_batch_lock);
01191    oldbatchitems = batch->head;
01192    reset_batch();
01193    ast_mutex_unlock(&cdr_batch_lock);
01194 
01195    /* if configured, spawn a new thread to post these CDRs,
01196       also try to save as much as possible if we are shutting down safely */
01197    if (batchscheduleronly || do_shutdown) {
01198       ast_debug(1, "CDR single-threaded batch processing begins now\n");
01199       do_batch_backend_process(oldbatchitems);
01200    } else {
01201       if (ast_pthread_create_detached_background(&batch_post_thread, NULL, do_batch_backend_process, oldbatchitems)) {
01202          ast_log(LOG_WARNING, "CDR processing thread could not detach, now trying in this thread\n");
01203          do_batch_backend_process(oldbatchitems);
01204       } else {
01205          ast_debug(1, "CDR multi-threaded batch processing begins now\n");
01206       }
01207    }
01208 }
01209 
01210 static int submit_scheduled_batch(const void *data)
01211 {
01212    ast_cdr_submit_batch(0);
01213    /* manually reschedule from this point in time */
01214    cdr_sched = ast_sched_add(sched, batchtime * 1000, submit_scheduled_batch, NULL);
01215    /* returning zero so the scheduler does not automatically reschedule */
01216    return 0;
01217 }
01218 
01219 static void submit_unscheduled_batch(void)
01220 {
01221    /* this is okay since we are not being called from within the scheduler */
01222    AST_SCHED_DEL(sched, cdr_sched);
01223    /* schedule the submission to occur ASAP (1 ms) */
01224    cdr_sched = ast_sched_add(sched, 1, submit_scheduled_batch, NULL);
01225    /* signal the do_cdr thread to wakeup early and do some work (that lazy thread ;) */
01226    ast_mutex_lock(&cdr_pending_lock);
01227    ast_cond_signal(&cdr_pending_cond);
01228    ast_mutex_unlock(&cdr_pending_lock);
01229 }
01230 
01231 void ast_cdr_detach(struct ast_cdr *cdr)
01232 {
01233    struct ast_cdr_batch_item *newtail;
01234    int curr;
01235 
01236    if (!cdr)
01237       return;
01238 
01239    /* maybe they disabled CDR stuff completely, so just drop it */
01240    if (!enabled) {
01241       ast_debug(1, "Dropping CDR !\n");
01242       ast_set_flag(cdr, AST_CDR_FLAG_POST_DISABLED);
01243       ast_cdr_free(cdr);
01244       return;
01245    }
01246 
01247    /* post stuff immediately if we are not in batch mode, this is legacy behaviour */
01248    if (!batchmode) {
01249       post_cdr(cdr);
01250       ast_cdr_free(cdr);
01251       return;
01252    }
01253 
01254    /* otherwise, each CDR gets put into a batch list (at the end) */
01255    ast_debug(1, "CDR detaching from this thread\n");
01256 
01257    /* we'll need a new tail for every CDR */
01258    if (!(newtail = ast_calloc(1, sizeof(*newtail)))) {
01259       post_cdr(cdr);
01260       ast_cdr_free(cdr);
01261       return;
01262    }
01263 
01264    /* don't traverse a whole list (just keep track of the tail) */
01265    ast_mutex_lock(&cdr_batch_lock);
01266    if (!batch)
01267       init_batch();
01268    if (!batch->head) {
01269       /* new batch is empty, so point the head at the new tail */
01270       batch->head = newtail;
01271    } else {
01272       /* already got a batch with something in it, so just append a new tail */
01273       batch->tail->next = newtail;
01274    }
01275    newtail->cdr = cdr;
01276    batch->tail = newtail;
01277    curr = batch->size++;
01278    ast_mutex_unlock(&cdr_batch_lock);
01279 
01280    /* if we have enough stuff to post, then do it */
01281    if (curr >= (batchsize - 1))
01282       submit_unscheduled_batch();
01283 }
01284 
01285 static void *do_cdr(void *data)
01286 {
01287    struct timespec timeout;
01288    int schedms;
01289    int numevents = 0;
01290 
01291    for (;;) {
01292       struct timeval now;
01293       schedms = ast_sched_wait(sched);
01294       /* this shouldn't happen, but provide a 1 second default just in case */
01295       if (schedms <= 0)
01296          schedms = 1000;
01297       now = ast_tvadd(ast_tvnow(), ast_samp2tv(schedms, 1000));
01298       timeout.tv_sec = now.tv_sec;
01299       timeout.tv_nsec = now.tv_usec * 1000;
01300       /* prevent stuff from clobbering cdr_pending_cond, then wait on signals sent to it until the timeout expires */
01301       ast_mutex_lock(&cdr_pending_lock);
01302       ast_cond_timedwait(&cdr_pending_cond, &cdr_pending_lock, &timeout);
01303       numevents = ast_sched_runq(sched);
01304       ast_mutex_unlock(&cdr_pending_lock);
01305       ast_debug(2, "Processed %d scheduled CDR batches from the run queue\n", numevents);
01306    }
01307 
01308    return NULL;
01309 }
01310 
01311 static char *handle_cli_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01312 {
01313    struct ast_cdr_beitem *beitem=NULL;
01314    int cnt=0;
01315    long nextbatchtime=0;
01316 
01317    switch (cmd) {
01318    case CLI_INIT:
01319       e->command = "cdr show status";
01320       e->usage = 
01321          "Usage: cdr show status\n"
01322          "  Displays the Call Detail Record engine system status.\n";
01323       return NULL;
01324    case CLI_GENERATE:
01325       return NULL;
01326    }
01327 
01328    if (a->argc > 3)
01329       return CLI_SHOWUSAGE;
01330 
01331    ast_cli(a->fd, "\n");
01332    ast_cli(a->fd, "Call Detail Record (CDR) settings\n");
01333    ast_cli(a->fd, "----------------------------------\n");
01334    ast_cli(a->fd, "  Logging:                    %s\n", enabled ? "Enabled" : "Disabled");
01335    ast_cli(a->fd, "  Mode:                       %s\n", batchmode ? "Batch" : "Simple");
01336    if (enabled) {
01337       ast_cli(a->fd, "  Log unanswered calls:       %s\n\n", unanswered ? "Yes" : "No");
01338       if (batchmode) {
01339          ast_cli(a->fd, "* Batch Mode Settings\n");
01340          ast_cli(a->fd, "  -------------------\n");
01341          if (batch)
01342             cnt = batch->size;
01343          if (cdr_sched > -1)
01344             nextbatchtime = ast_sched_when(sched, cdr_sched);
01345          ast_cli(a->fd, "  Safe shutdown:              %s\n", batchsafeshutdown ? "Enabled" : "Disabled");
01346          ast_cli(a->fd, "  Threading model:            %s\n", batchscheduleronly ? "Scheduler only" : "Scheduler plus separate threads");
01347          ast_cli(a->fd, "  Current batch size:         %d record%s\n", cnt, ESS(cnt));
01348          ast_cli(a->fd, "  Maximum batch size:         %d record%s\n", batchsize, ESS(batchsize));
01349          ast_cli(a->fd, "  Maximum batch time:         %d second%s\n", batchtime, ESS(batchtime));
01350          ast_cli(a->fd, "  Next batch processing time: %ld second%s\n\n", nextbatchtime, ESS(nextbatchtime));
01351       }
01352       ast_cli(a->fd, "* Registered Backends\n");
01353       ast_cli(a->fd, "  -------------------\n");
01354       AST_RWLIST_RDLOCK(&be_list);
01355       if (AST_RWLIST_EMPTY(&be_list)) {
01356          ast_cli(a->fd, "    (none)\n");
01357       } else {
01358          AST_RWLIST_TRAVERSE(&be_list, beitem, list) {
01359             ast_cli(a->fd, "    %s\n", beitem->name);
01360          }
01361       }
01362       AST_RWLIST_UNLOCK(&be_list);
01363       ast_cli(a->fd, "\n");
01364    }
01365 
01366    return CLI_SUCCESS;
01367 }
01368 
01369 static char *handle_cli_status_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01370 {
01371    char *res = handle_cli_status(e, cmd, a);
01372    if (cmd == CLI_INIT)
01373       e->command = "cdr status";
01374    return res;
01375 }
01376 
01377 static char *handle_cli_submit(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
01378 {
01379    switch (cmd) {
01380    case CLI_INIT:
01381       e->command = "cdr submit";
01382       e->usage = 
01383          "Usage: cdr submit\n"
01384          "       Posts all pending batched CDR data to the configured CDR backend engine modules.\n";
01385       return NULL;
01386    case CLI_GENERATE:
01387       return NULL;
01388    }
01389    if (a->argc > 2)
01390       return CLI_SHOWUSAGE;
01391 
01392    submit_unscheduled_batch();
01393    ast_cli(a->fd, "Submitted CDRs to backend engines for processing.  This may take a while.\n");
01394 
01395    return CLI_SUCCESS;
01396 }
01397 
01398 static struct ast_cli_entry cli_submit = AST_CLI_DEFINE(handle_cli_submit, "Posts all pending batched CDR data");
01399 static struct ast_cli_entry cli_status_deprecated = AST_CLI_DEFINE(handle_cli_status_deprecated, "Display the CDR status");
01400 static struct ast_cli_entry cli_status = AST_CLI_DEFINE(handle_cli_status, "Display the CDR status", .deprecate_cmd = &cli_status_deprecated);
01401 
01402 static int do_reload(int reload)
01403 {
01404    struct ast_config *config;
01405    const char *enabled_value;
01406    const char *unanswered_value;
01407    const char *batched_value;
01408    const char *scheduleronly_value;
01409    const char *batchsafeshutdown_value;
01410    const char *size_value;
01411    const char *time_value;
01412    const char *end_before_h_value;
01413    int cfg_size;
01414    int cfg_time;
01415    int was_enabled;
01416    int was_batchmode;
01417    int res=0;
01418    struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
01419 
01420    if ((config = ast_config_load2("cdr.conf", "cdr", config_flags)) == CONFIG_STATUS_FILEUNCHANGED)
01421       return 0;
01422 
01423    ast_mutex_lock(&cdr_batch_lock);
01424 
01425    batchsize = BATCH_SIZE_DEFAULT;
01426    batchtime = BATCH_TIME_DEFAULT;
01427    batchscheduleronly = BATCH_SCHEDULER_ONLY_DEFAULT;
01428    batchsafeshutdown = BATCH_SAFE_SHUTDOWN_DEFAULT;
01429    was_enabled = enabled;
01430    was_batchmode = batchmode;
01431    enabled = 1;
01432    batchmode = 0;
01433 
01434    /* don't run the next scheduled CDR posting while reloading */
01435    AST_SCHED_DEL(sched, cdr_sched);
01436 
01437    if (config) {
01438       if ((enabled_value = ast_variable_retrieve(config, "general", "enable"))) {
01439          enabled = ast_true(enabled_value);
01440       }
01441       if ((unanswered_value = ast_variable_retrieve(config, "general", "unanswered"))) {
01442          unanswered = ast_true(unanswered_value);
01443       }
01444       if ((batched_value = ast_variable_retrieve(config, "general", "batch"))) {
01445          batchmode = ast_true(batched_value);
01446       }
01447       if ((scheduleronly_value = ast_variable_retrieve(config, "general", "scheduleronly"))) {
01448          batchscheduleronly = ast_true(scheduleronly_value);
01449       }
01450       if ((batchsafeshutdown_value = ast_variable_retrieve(config, "general", "safeshutdown"))) {
01451          batchsafeshutdown = ast_true(batchsafeshutdown_value);
01452       }
01453       if ((size_value = ast_variable_retrieve(config, "general", "size"))) {
01454          if (sscanf(size_value, "%30d", &cfg_size) < 1)
01455             ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", size_value);
01456          else if (cfg_size < 0)
01457             ast_log(LOG_WARNING, "Invalid maximum batch size '%d' specified, using default\n", cfg_size);
01458          else
01459             batchsize = cfg_size;
01460       }
01461       if ((time_value = ast_variable_retrieve(config, "general", "time"))) {
01462          if (sscanf(time_value, "%30d", &cfg_time) < 1)
01463             ast_log(LOG_WARNING, "Unable to convert '%s' to a numeric value.\n", time_value);
01464          else if (cfg_time < 0)
01465             ast_log(LOG_WARNING, "Invalid maximum batch time '%d' specified, using default\n", cfg_time);
01466          else
01467             batchtime = cfg_time;
01468       }
01469       if ((end_before_h_value = ast_variable_retrieve(config, "general", "endbeforehexten")))
01470          ast_set2_flag(&ast_options, ast_true(end_before_h_value), AST_OPT_FLAG_END_CDR_BEFORE_H_EXTEN);
01471    }
01472 
01473    if (enabled && !batchmode) {
01474       ast_log(LOG_NOTICE, "CDR simple logging enabled.\n");
01475    } else if (enabled && batchmode) {
01476       cdr_sched = ast_sched_add(sched, batchtime * 1000, submit_scheduled_batch, NULL);
01477       ast_log(LOG_NOTICE, "CDR batch mode logging enabled, first of either size %d or time %d seconds.\n", batchsize, batchtime);
01478    } else {
01479       ast_log(LOG_NOTICE, "CDR logging disabled, data will be lost.\n");
01480    }
01481 
01482    /* if this reload enabled the CDR batch mode, create the background thread
01483       if it does not exist */
01484    if (enabled && batchmode && (!was_enabled || !was_batchmode) && (cdr_thread == AST_PTHREADT_NULL)) {
01485       ast_cond_init(&cdr_pending_cond, NULL);
01486       if (ast_pthread_create_background(&cdr_thread, NULL, do_cdr, NULL) < 0) {
01487          ast_log(LOG_ERROR, "Unable to start CDR thread.\n");
01488          AST_SCHED_DEL(sched, cdr_sched);
01489       } else {
01490          ast_cli_register(&cli_submit);
01491          ast_register_atexit(ast_cdr_engine_term);
01492          res = 0;
01493       }
01494    /* if this reload disabled the CDR and/or batch mode and there is a background thread,
01495       kill it */
01496    } else if (((!enabled && was_enabled) || (!batchmode && was_batchmode)) && (cdr_thread != AST_PTHREADT_NULL)) {
01497       /* wake up the thread so it will exit */
01498       pthread_cancel(cdr_thread);
01499       pthread_kill(cdr_thread, SIGURG);
01500       pthread_join(cdr_thread, NULL);
01501       cdr_thread = AST_PTHREADT_NULL;
01502       ast_cond_destroy(&cdr_pending_cond);
01503       ast_cli_unregister(&cli_submit);
01504       ast_unregister_atexit(ast_cdr_engine_term);
01505       res = 0;
01506       /* if leaving batch mode, then post the CDRs in the batch,
01507          and don't reschedule, since we are stopping CDR logging */
01508       if (!batchmode && was_batchmode) {
01509          ast_cdr_engine_term();
01510       }
01511    } else {
01512       res = 0;
01513    }
01514 
01515    ast_mutex_unlock(&cdr_batch_lock);
01516    ast_config_destroy(config);
01517    manager_event(EVENT_FLAG_SYSTEM, "Reload", "Module: CDR\r\nMessage: CDR subsystem reload requested\r\n");
01518 
01519    return res;
01520 }
01521 
01522 int ast_cdr_engine_init(void)
01523 {
01524    int res;
01525 
01526    sched = sched_context_create();
01527    if (!sched) {
01528       ast_log(LOG_ERROR, "Unable to create schedule context.\n");
01529       return -1;
01530    }
01531 
01532    ast_cli_register(&cli_status);
01533 
01534    res = do_reload(0);
01535    if (res) {
01536       ast_mutex_lock(&cdr_batch_lock);
01537       res = init_batch();
01538       ast_mutex_unlock(&cdr_batch_lock);
01539    }
01540 
01541    return res;
01542 }
01543 
01544 /* \note This actually gets called a couple of times at shutdown.  Once, before we start
01545    hanging up channels, and then again, after the channel hangup timeout expires */
01546 void ast_cdr_engine_term(void)
01547 {
01548    ast_cdr_submit_batch(batchsafeshutdown);
01549 }
01550 
01551 int ast_cdr_engine_reload(void)
01552 {
01553    return do_reload(1);
01554 }
01555 

Generated on Wed Oct 28 11:50:56 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6