cdr.c File Reference

#include <asterisk/lock.h>
#include <asterisk/channel.h>
#include <asterisk/cdr.h>
#include <asterisk/logger.h>
#include <asterisk/callerid.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <pthread.h>

Go to the source code of this file.

Data Structures
struct	ast_cdr_beitem
Functions
int	ast_cdr_register (char *name, char *desc, ast_cdrbe be)
	Register a CDR handling engine.
void	ast_cdr_unregister (char *name)
	Unregister a CDR handling engine.
void	ast_cdr_free (struct ast_cdr *cdr)
	Free a record.
ast_cdr *	ast_cdr_alloc (void)
	Allocate a record.
void	ast_cdr_start (struct ast_cdr *cdr)
	Start a call.
void	ast_cdr_answer (struct ast_cdr *cdr)
	Answer a call.
void	ast_cdr_busy (struct ast_cdr *cdr)
	Busy a call.
void	ast_cdr_setdestchan (struct ast_cdr *cdr, char *chann)
	Set the destination channel, if there was one.
void	ast_cdr_setapp (struct ast_cdr *cdr, char *app, char *data)
	Set the last executed application.
int	ast_cdr_setcid (struct ast_cdr *cdr, struct ast_channel *c)
	Initialize based on a channel.
int	ast_cdr_init (struct ast_cdr *cdr, struct ast_channel *c)
	Initialize based on a channel.
void	ast_cdr_end (struct ast_cdr *cdr)
	End a call.
char *	ast_cdr_disp2str (int disposition)
	Disposition to a string.
char *	ast_cdr_flags2str (int flag)
	Flags to a string.
int	ast_cdr_setaccount (struct ast_channel *chan, char *account)
int	ast_cdr_update (struct ast_channel *c)
int	ast_cdr_amaflags2int (char *flag)
	Convert a string to a detail record AMA flag.
void	ast_cdr_post (struct ast_cdr *cdr)
	Post the detail record.
void	ast_cdr_reset (struct ast_cdr *cdr, int post)
	Reset the detail record, optionally posting it first.
Variables
int	ast_default_amaflags = AST_CDR_DOCUMENTATION
char	ast_default_accountcode [20] = ""

---

Function Documentation

struct ast_cdr* ast_cdr_alloc (  void   )

Allocate a record. Returns a malloc'd ast_cdr structure, returns NULL on error (malloc failure) Definition at line 116 of file cdr.c. References malloc. Referenced by ast_pbx_run(). { struct ast_cdr *cdr; cdr = malloc(sizeof(struct ast_cdr)); if (cdr) { memset(cdr, 0, sizeof(struct ast_cdr)); } return cdr; }

int ast_cdr_amaflags2int (  char *  flag  )

Convert a string to a detail record AMA flag. Parameters: flag  string form of flag Converts the string form of the flag to the binary form. Returns the binary form of the flag Definition at line 339 of file cdr.c. References AST_CDR_BILLING, AST_CDR_DOCUMENTATION, and AST_CDR_OMIT. { if (!strcasecmp(flag, "default")) return 0; if (!strcasecmp(flag, "omit")) return AST_CDR_OMIT; if (!strcasecmp(flag, "billing")) return AST_CDR_BILLING; if (!strcasecmp(flag, "documentation")) return AST_CDR_DOCUMENTATION; return -1; }

void ast_cdr_answer (  struct ast_cdr *  cdr  )

Answer a call. Parameters: cdr  the cdr you wish to associate with the call Starts all CDR stuff necessary for doing CDR when answering a call Definition at line 139 of file cdr.c. References ast_cdr::answer, AST_CDR_ANSWERED, ast_log(), ast_cdr::channel, ast_cdr::disposition, LOG_WARNING, and ast_cdr::posted. Referenced by ast_answer(), and ast_read(). { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (cdr->disposition < AST_CDR_ANSWERED) cdr->disposition = AST_CDR_ANSWERED; if (!cdr->answer.tv_sec && !cdr->answer.tv_usec) { gettimeofday(&cdr->answer, NULL); } } }

void ast_cdr_busy (  struct ast_cdr *  cdr  )

Busy a call. Parameters: cdr  the cdr you wish to associate with the call Returns nothing important Definition at line 154 of file cdr.c. References AST_CDR_BUSY, ast_log(), ast_cdr::channel, ast_cdr::disposition, LOG_WARNING, and ast_cdr::posted. { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (cdr->disposition < AST_CDR_BUSY) cdr->disposition = AST_CDR_BUSY; } }

char* ast_cdr_disp2str (  int  disposition  )

Disposition to a string. Parameters: flag  input binary form Converts the binary form of a disposition to string form. Returns a pointer to the string form Definition at line 273 of file cdr.c. References AST_CDR_ANSWERED, AST_CDR_BUSY, and AST_CDR_NOANSWER. { switch (disposition) { case AST_CDR_NOANSWER: return "NO ANSWER"; case AST_CDR_BUSY: return "BUSY"; case AST_CDR_ANSWERED: return "ANSWERED"; default: return "UNKNOWN"; } }

void ast_cdr_end (  struct ast_cdr *  cdr  )

End a call. Parameters: cdr  the cdr you have associated the call with Registers the end of call time in the cdr structure. Returns nothing important Definition at line 259 of file cdr.c. References ast_log(), ast_cdr::channel, ast_cdr::end, LOG_WARNING, ast_cdr::posted, and ast_cdr::start. Referenced by ast_cdr_reset(), ast_hangup(), and ast_read(). { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (!cdr->start.tv_sec && !cdr->start.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' has not started\n", chan); if (!cdr->end.tv_sec && !cdr->end.tv_usec) gettimeofday(&cdr->end, NULL); } }

char* ast_cdr_flags2str (  int  flags  )

Flags to a string. Parameters: flags  binary flag Converts binary flags to string flags Returns string with flag name Definition at line 287 of file cdr.c. References AST_CDR_BILLING, AST_CDR_DOCUMENTATION, and AST_CDR_OMIT. { switch(flag) { case AST_CDR_OMIT: return "OMIT"; case AST_CDR_BILLING: return "BILLING"; case AST_CDR_DOCUMENTATION: return "DOCUMENTATION"; } return "Unknown"; }

void ast_cdr_free (  struct ast_cdr *  cdr  )

Free a record. Definition at line 101 of file cdr.c. References ast_log(), ast_cdr::channel, ast_cdr::end, free, LOG_WARNING, ast_cdr::posted, and ast_cdr::start. Referenced by ast_hangup(). { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (!cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' not posted\n", chan); if (!cdr->end.tv_sec && !cdr->end.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' lacks end\n", chan); if (!cdr->start.tv_sec && !cdr->start.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' lacks start\n", chan); free(cdr); } }

int ast_cdr_init (  struct ast_cdr *  cdr, struct ast_channel *  chan )

Initialize based on a channel. Parameters: cdr  Call Detail Record to use for channel chan  Channel to bind CDR with Initializes a CDR and associates it with a particular channel Return is negligible. (returns 0 by default) Definition at line 216 of file cdr.c. References ast_channel::_state, ast_cdr::accountcode, ast_channel::accountcode, ast_channel::amaflags, ast_cdr::amaflags, ast_channel::ani, ast_callerid_parse(), AST_CDR_ANSWERED, AST_CDR_NOANSWER, ast_default_amaflags, ast_log(), AST_MAX_EXTENSION, ast_shrink_phone_number(), AST_STATE_UP, ast_channel::callerid, ast_cdr::channel, ast_cdr::clid, ast_channel::context, ast_cdr::dcontext, ast_cdr::disposition, ast_cdr::dst, ast_channel::exten, LOG_WARNING, ast_channel::name, ast_cdr::src, ast_cdr::uniqueid, and ast_channel::uniqueid. Referenced by ast_pbx_run(). { char *chan; char *num, *name; char tmp[AST_MAX_EXTENSION] = ""; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (strlen(cdr->channel)) ast_log(LOG_WARNING, "CDR already initialized on '%s'\n", chan); strncpy(cdr->channel, c->name, sizeof(cdr->channel) - 1); /* Grab source from ANI or normal Caller*ID */ if (c->ani) strncpy(tmp, c->ani, sizeof(tmp) - 1); else if (c->callerid) strncpy(tmp, c->callerid, sizeof(tmp) - 1); if (c->callerid) strncpy(cdr->clid, c->callerid, sizeof(cdr->clid) - 1); name = NULL; num = NULL; ast_callerid_parse(tmp, &name, &num); if (num) { ast_shrink_phone_number(num); strncpy(cdr->src, num, sizeof(cdr->src) - 1); } if (c->_state == AST_STATE_UP) cdr->disposition = AST_CDR_ANSWERED; else cdr->disposition = AST_CDR_NOANSWER; if (c->amaflags) cdr->amaflags = c->amaflags; else cdr->amaflags = ast_default_amaflags; strncpy(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode) - 1); /* Destination information */ strncpy(cdr->dst, c->exten, sizeof(cdr->dst) - 1); strncpy(cdr->dcontext, c->context, sizeof(cdr->dcontext) - 1); /* Unique call identifier */ strncpy(cdr->uniqueid, c->uniqueid, sizeof(cdr->uniqueid) - 1); } return 0; }

void ast_cdr_post (  struct ast_cdr *  cdr  )

Post the detail record. Parameters: cdr  Which cdr to post Actually outputs the CDR record to the CDR plugins installed Returns nothing Definition at line 352 of file cdr.c. References ast_cdr::answer, ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_cdr::billsec, ast_cdr::channel, ast_cdr::duration, ast_cdr::end, LOG_WARNING, ast_cdr::posted, and ast_cdr::start. Referenced by ast_cdr_reset(), and ast_hangup(). { char *chan; struct ast_cdr_beitem *i; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (!cdr->end.tv_sec && !cdr->end.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' lacks end\n", chan); if (!cdr->start.tv_sec && !cdr->start.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' lacks start\n", chan); cdr->duration = cdr->end.tv_sec - cdr->start.tv_sec + (cdr->end.tv_usec - cdr->start.tv_usec) / 1000000; if (cdr->answer.tv_sec || cdr->answer.tv_usec) { cdr->billsec = cdr->end.tv_sec - cdr->answer.tv_sec + (cdr->end.tv_usec - cdr->answer.tv_usec) / 1000000; } else cdr->billsec = 0; cdr->posted = 1; ast_mutex_lock(&cdrlock); i = bes; while(i) { i->be(cdr); i = i->next; } ast_mutex_unlock(&cdrlock); } }

int ast_cdr_register (  char *  name, char *  desc, ast_cdrbe  be )

Register a CDR handling engine. Parameters: name  name associated with the particular CDR handler desc  description of the CDR handler be  function pointer to a CDR handler Used to register a Call Detail Record handler. Returns -1 on error, 0 on success. Definition at line 46 of file cdr.c. References ast_cdrbe, ast_log(), ast_mutex_lock, ast_mutex_unlock, LOG_WARNING, and malloc. { struct ast_cdr_beitem *i; if (!name) return -1; if (!be) { ast_log(LOG_WARNING, "CDR engine '%s' lacks backend\n", name); return -1; } ast_mutex_lock(&cdrlock); i = bes; while(i) { if (!strcasecmp(name, i->name)) break; i = i->next; } ast_mutex_unlock(&cdrlock); if (i) { ast_log(LOG_WARNING, "Already have a CDR backend called '%s'\n", name); return -1; } i = malloc(sizeof(struct ast_cdr_beitem)); if (!i) return -1; memset(i, 0, sizeof(struct ast_cdr_beitem)); strncpy(i->name, name, sizeof(i->name) - 1); strncpy(i->desc, desc, sizeof(i->desc) - 1); i->be = be; ast_mutex_lock(&cdrlock); i->next = bes; bes = i; ast_mutex_unlock(&cdrlock); return 0; }

void ast_cdr_reset (  struct ast_cdr *  cdr, int  post )

Reset the detail record, optionally posting it first. Parameters: cdr  which cdr to act upon post  whether or not to post the cdr first before resetting it Definition at line 380 of file cdr.c. References ast_cdr::answer, ast_cdr_end(), AST_CDR_NOANSWER, ast_cdr_post(), ast_cdr_start(), ast_cdr::billsec, ast_cdr::disposition, ast_cdr::duration, ast_cdr::end, ast_cdr::posted, and ast_cdr::start. { /* Post if requested */ if (post) { ast_cdr_end(cdr); ast_cdr_post(cdr); } /* Reset to initial state */ cdr->posted = 0; memset(&cdr->start, 0, sizeof(cdr->start)); memset(&cdr->end, 0, sizeof(cdr->end)); memset(&cdr->answer, 0, sizeof(cdr->answer)); cdr->billsec = 0; cdr->duration = 0; ast_cdr_start(cdr); cdr->disposition = AST_CDR_NOANSWER; }

int ast_cdr_setaccount (  struct ast_channel *  chan, char *  account )

Definition at line 300 of file cdr.c. References ast_channel::accountcode, and ast_channel::cdr. { struct ast_cdr *cdr = chan->cdr; strncpy(chan->accountcode, account, sizeof(chan->accountcode) - 1); if (cdr) strncpy(cdr->accountcode, chan->accountcode, sizeof(cdr->accountcode) - 1); return 0; }

void ast_cdr_setapp (  struct ast_cdr *  cdr, char *  app, char *  data )

Set the last executed application. Parameters: cdr  which cdr to act upon app  the name of the app you wish to change it to data  the data you want in the data field of app you set it to Changes the value of the last executed app Returns nothing Definition at line 177 of file cdr.c. References ast_log(), ast_cdr::channel, ast_cdr::lastapp, ast_cdr::lastdata, LOG_WARNING, and ast_cdr::posted. Referenced by pbx_exec(). { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (!app) app = ""; strncpy(cdr->lastapp, app, sizeof(cdr->lastapp) - 1); if (!data) data = ""; strncpy(cdr->lastdata, data, sizeof(cdr->lastdata) - 1); } }

int ast_cdr_setcid (  struct ast_cdr *  cdr, struct ast_channel *  chan )

Initialize based on a channel. Parameters: cdr  Call Detail Record to use for channel chan  Channel to bind CDR with Initializes a CDR and associates it with a particular channel Return is negligible. (returns 0 by default) Definition at line 193 of file cdr.c. References ast_channel::ani, ast_callerid_parse(), AST_MAX_EXTENSION, ast_shrink_phone_number(), ast_channel::callerid, ast_cdr::clid, and ast_cdr::src. Referenced by ast_set_callerid(). { char tmp[AST_MAX_EXTENSION] = ""; char *num, *name; if (cdr) { /* Grab source from ANI or normal Caller*ID */ if (c->ani) strncpy(tmp, c->ani, sizeof(tmp) - 1); else if (c->callerid) strncpy(tmp, c->callerid, sizeof(tmp) - 1); if (c->callerid) strncpy(cdr->clid, c->callerid, sizeof(cdr->clid) - 1); name = NULL; num = NULL; ast_callerid_parse(tmp, &name, &num); if (num) { ast_shrink_phone_number(num); strncpy(cdr->src, num, sizeof(cdr->src) - 1); } } return 0; }

void ast_cdr_setdestchan (  struct ast_cdr *  cdr, char *  chan )

Set the destination channel, if there was one. Parameters: cdr  Which cdr it's applied to Sets the destination channel the CDR is applied to Returns nothing Definition at line 166 of file cdr.c. References ast_log(), ast_cdr::channel, ast_cdr::dstchannel, LOG_WARNING, and ast_cdr::posted. { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); strncpy(cdr->dstchannel, chann, sizeof(cdr->dstchannel) - 1); } }

void ast_cdr_start (  struct ast_cdr *  cdr  )

Start a call. Parameters: cdr  the cdr you wish to associate with the call Starts all CDR stuff necessary for monitoring a call Returns nothing important Definition at line 126 of file cdr.c. References ast_log(), ast_cdr::channel, LOG_WARNING, ast_cdr::posted, and ast_cdr::start. Referenced by ast_cdr_reset(), and ast_pbx_run(). { char *chan; if (cdr) { chan = strlen(cdr->channel) ? cdr->channel : "<unknown>"; if (cdr->posted) ast_log(LOG_WARNING, "CDR on channel '%s' already posted\n", chan); if (cdr->start.tv_sec || cdr->start.tv_usec) ast_log(LOG_WARNING, "CDR on channel '%s' already started\n", chan); gettimeofday(&cdr->start, NULL); } }

void ast_cdr_unregister (  char *  name  )

Unregister a CDR handling engine. Parameters: name  name of CDR handler to unregister Unregisters a CDR by it's name Definition at line 81 of file cdr.c. References ast_mutex_lock, ast_mutex_unlock, and free. { struct ast_cdr_beitem *i, *prev = NULL; ast_mutex_lock(&cdrlock); i = bes; while(i) { if (!strcasecmp(name, i->name)) { if (prev) prev->next = i->next; else bes = i->next; break; } i = i->next; } ast_mutex_unlock(&cdrlock); if (i) free(i); }

int ast_cdr_update (  struct ast_channel *  c  )

Definition at line 310 of file cdr.c. References ast_channel::accountcode, ast_channel::ani, ast_callerid_parse(), AST_MAX_EXTENSION, ast_shrink_phone_number(), ast_channel::callerid, ast_channel::cdr, ast_channel::context, and ast_channel::exten. Referenced by ast_pbx_run(). { struct ast_cdr *cdr = c->cdr; char *name, *num; char tmp[AST_MAX_EXTENSION] = ""; /* Grab source from ANI or normal Caller*ID */ if (c->ani) strncpy(tmp, c->ani, sizeof(tmp) - 1); else if (c->callerid) strncpy(tmp, c->callerid, sizeof(tmp) - 1); if (c->callerid) strncpy(cdr->clid, c->callerid, sizeof(cdr->clid) - 1); else strcpy(cdr->clid, ""); name = NULL; num = NULL; ast_callerid_parse(tmp, &name, &num); if (num) { ast_shrink_phone_number(num); strncpy(cdr->src, num, sizeof(cdr->src) - 1); } /* Copy account code et-al */ strncpy(cdr->accountcode, c->accountcode, sizeof(cdr->accountcode) - 1); /* Destination information */ strncpy(cdr->dst, c->exten, sizeof(cdr->dst) - 1); strncpy(cdr->dcontext, c->context, sizeof(cdr->dcontext) - 1); return 0; }

---

Variable Documentation

char ast_default_accountcode[20] = ""

Definition at line 28 of file cdr.c. Referenced by ast_channel_alloc().

int ast_default_amaflags = AST_CDR_DOCUMENTATION

Definition at line 27 of file cdr.c. Referenced by ast_cdr_init(), and ast_channel_alloc().

---