cdr_custom.c File Reference

Custom Comma Separated Value CDR records. More...

#include <sys/types.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <stdlib.h>
#include <unistd.h>
#include <time.h>
#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/cdr.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/pbx.h"
#include "asterisk/logger.h"
#include "asterisk/utils.h"

Include dependency graph for cdr_custom.c:

Go to the source code of this file.

Defines
#define	CUSTOM_LOG_DIR   "/cdr_custom"
#define	DATE_FORMAT   "%Y-%m-%d %T"
Functions
	AST_MUTEX_DEFINE_STATIC (lock)
static int	custom_log (struct ast_cdr *cdr)
char *	description (void)
	Provides a description of the module.
char *	key ()
	Returns the ASTERISK_GPL_KEY.
static int	load_config (int reload)
int	load_module (void)
	Initialize the module.
int	reload (void)
	Reload stuff.
int	unload_module (void)
	Cleanup all module structures, sockets, etc.
int	usecount (void)
	Provides a usecount.
Variables
static char *	desc = "Customizable Comma Separated Values CDR Backend"
static char	format [1024] = ""
static char	master [AST_CONFIG_MAX_PATH]
static FILE *	mf = NULL
static char *	name = "cdr-custom"

---

Detailed Description

Custom Comma Separated Value CDR records.

• See also CDR - Call Data Records and billing

Logs in LOG_DIR/cdr_custom

Definition in file cdr_custom.c.

---

Define Documentation

#define CUSTOM_LOG_DIR   "/cdr_custom"

Definition at line 52 of file cdr_custom.c.

#define DATE_FORMAT   "%Y-%m-%d %T"

Definition at line 54 of file cdr_custom.c.

---

Function Documentation

AST_MUTEX_DEFINE_STATIC

(

lock

)

static int custom_log

(

struct ast_cdr *

cdr

)

[static]

Definition at line 108 of file cdr_custom.c.

References ast_log(), ast_strlen_zero(), ast_channel::cdr, LOG_ERROR, and pbx_substitute_variables_helper().

Referenced by load_module().

{
   /* Make sure we have a big enough buf */
   char buf[2048];
   struct ast_channel dummy;

   /* Abort if no master file is specified */
   if (ast_strlen_zero(master))
      return 0;

   memset(buf, 0 , sizeof(buf));
   /* Quite possibly the first use of a static struct ast_channel, we need it so the var funcs will work */
   memset(&dummy, 0, sizeof(dummy));
   dummy.cdr = cdr;
   pbx_substitute_variables_helper(&dummy, format, buf, sizeof(buf) - 1);

   /* because of the absolutely unconditional need for the
      highest reliability possible in writing billing records,
      we open write and close the log file each time */
   mf = fopen(master, "a");
   if (!mf) {
      ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", master, strerror(errno));
   }
   if (mf) {
      fputs(buf, mf);
      fflush(mf); /* be particularly anal here */
      fclose(mf);
      mf = NULL;
   }
   return 0;
}

char* description

(

void

)

Provides a description of the module.

Returns:

a short description of your module

Definition at line 140 of file cdr_custom.c.

{
   return desc;
}

char* key

(

void

)

Returns the ASTERISK_GPL_KEY.

This returns the ASTERISK_GPL_KEY, signifiying that you agree to the terms of the GPL stated in the ASTERISK_GPL_KEY. Your module will not load if it does not return the EXACT message:

 char *key(void) {
         return ASTERISK_GPL_KEY;
 }

Returns:

ASTERISK_GPL_KEY

Definition at line 177 of file cdr_custom.c.

References ASTERISK_GPL_KEY.

{
   return ASTERISK_GPL_KEY;
}

static int load_config

(

int

reload

)

[static]

Definition at line 67 of file cdr_custom.c.

References ast_config_AST_LOG_DIR, ast_config_destroy(), ast_config_load(), ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_strlen_zero(), ast_variable_browse(), cfg, ast_variable::lineno, lock, LOG_NOTICE, LOG_WARNING, ast_variable::name, ast_variable::next, ast_variable::value, and var.

{
   struct ast_config *cfg;
   struct ast_variable *var;
   int res = -1;

   strcpy(format, "");
   strcpy(master, "");
   ast_mutex_lock(&lock);
   if((cfg = ast_config_load("cdr_custom.conf"))) {
      var = ast_variable_browse(cfg, "mappings");
      while(var) {
         if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
            if (strlen(var->value) > (sizeof(format) - 2))
               ast_log(LOG_WARNING, "Format string too long, will be truncated, at line %d\n", var->lineno);
            strncpy(format, var->value, sizeof(format) - 2);
            strcat(format,"\n");
            snprintf(master, sizeof(master),"%s/%s/%s", ast_config_AST_LOG_DIR, name, var->name);
            if (var->next) {
               ast_log(LOG_NOTICE, "Sorry, only one mapping is supported at this time, mapping '%s' will be ignored at line %d.\n", var->next->name, var->next->lineno); 
               break;
            }
         } else
            ast_log(LOG_NOTICE, "Mapping must have both filename and format at line %d\n", var->lineno);
         var = var->next;
      }
      ast_config_destroy(cfg);
      res = 0;
   } else {
      if (reload)
         ast_log(LOG_WARNING, "Failed to reload configuration file.\n");
      else
         ast_log(LOG_WARNING, "Failed to load configuration file. Module not activated.\n");
   }
   ast_mutex_unlock(&lock);
   
   return res;
}

int load_module

(

void

)

Initialize the module.

This function is called at module load time. Put all code in here that needs to set up your module's hardware, software, registrations, etc.

Returns:

This function should return 0 on success and non-zero on failure. If the module is not loaded successfully, Asterisk will call its unload_module() function.

Initialize the Agents module. This function is being called by Asterisk when loading the module. Among other thing it registers applications, cli commands and reads the cofiguration file.

Returns:

int Always 0.

TE STUFF END

Definition at line 153 of file cdr_custom.c.

References ast_cdr_register(), ast_log(), custom_log(), load_config(), and LOG_ERROR.

{
   int res = 0;

   if (!load_config(0)) {
      res = ast_cdr_register(name, desc, custom_log);
      if (res)
         ast_log(LOG_ERROR, "Unable to register custom CDR handling\n");
      if (mf)
         fclose(mf);
   }
   return res;
}

int reload

(

void

)

Reload stuff.

This function is where any reload routines take place. Re-read config files, change signalling, whatever is appropriate on a reload.

Returns:

The return value is not used.

Definition at line 167 of file cdr_custom.c.

References load_config().

{
   return load_config(1);
}

int unload_module

(

void

)

Cleanup all module structures, sockets, etc.

This is called at exit. Any registrations and memory allocations need to be unregistered and free'd here. Nothing else will do these for you (until exit).

Returns:

Zero on success, or non-zero on error.

Definition at line 145 of file cdr_custom.c.

References ast_cdr_unregister().

{
   if (mf)
      fclose(mf);
   ast_cdr_unregister(name);
   return 0;
}

int usecount

(

void

)

Provides a usecount.

This function will be called by various parts of asterisk. Basically, all it has to do is to return a usecount when called. You will need to maintain your usecount within the module somewhere. The usecount should be how many channels provided by this module are in use.

Returns:

The module's usecount.

Definition at line 172 of file cdr_custom.c.

{
   return 0;
}

---

Variable Documentation

char* desc = "Customizable Comma Separated Values CDR Backend" [static]

Definition at line 58 of file cdr_custom.c.

char format[1024] = "" [static]

Definition at line 65 of file cdr_custom.c.

char master[AST_CONFIG_MAX_PATH] [static]

Definition at line 64 of file cdr_custom.c.

Referenced by __unload_module(), mutedlevel(), and zt_bridge().

FILE* mf = NULL [static]

Definition at line 62 of file cdr_custom.c.

char* name = "cdr-custom" [static]

Definition at line 60 of file cdr_custom.c.