Asterisk - The Open Source Telephony Project  GIT-master-1f78ee9
Data Structures | Macros | Functions | Variables
cdr_custom.c File Reference

Custom Comma Separated Value CDR records. More...

#include "asterisk.h"
#include <time.h>
#include "asterisk/paths.h"
#include "asterisk/channel.h"
#include "asterisk/cdr.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/threadstorage.h"
#include "asterisk/strings.h"

Go to the source code of this file.

Data Structures

struct  cdr_custom_config
 
struct  sinks
 

Macros

#define CONFIG   "cdr_custom.conf"
 
#define CUSTOM_LOG_DIR   "/cdr_custom"
 

Functions

static void __init_custom_buf (void)
 
static void __reg_module (void)
 
static void __unreg_module (void)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static int custom_log (struct ast_cdr *cdr)
 
static void free_config (void)
 
static int load_config (void)
 
static enum ast_module_load_result load_module (void)
 
static int reload (void)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Customizable Comma Separated Values CDR Backend" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_threadstorage custom_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_custom_buf , .custom_init = NULL , }
 
static const char name [] = "cdr-custom"
 
static struct sinks sinks = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 

Detailed Description

Custom Comma Separated Value CDR records.

Author
Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Logs in LOG_DIR/cdr_custom

Definition in file cdr_custom.c.

Macro Definition Documentation

◆ CONFIG

#define CONFIG   "cdr_custom.conf"

Definition at line 62 of file cdr_custom.c.

Referenced by load_config().

◆ CUSTOM_LOG_DIR

#define CUSTOM_LOG_DIR   "/cdr_custom"

Definition at line 61 of file cdr_custom.c.

Function Documentation

◆ __init_custom_buf()

static void __init_custom_buf ( void  )
static

Definition at line 64 of file cdr_custom.c.

68 {

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 235 of file cdr_custom.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 235 of file cdr_custom.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 235 of file cdr_custom.c.

◆ custom_log()

static int custom_log ( struct ast_cdr cdr)
static

Definition at line 129 of file cdr_custom.c.

References ast_cdr_dup(), ast_channel_cdr_set(), ast_channel_unref, ast_dummy_channel_alloc, AST_LIST_TRAVERSE, ast_log, ast_mutex_lock, ast_mutex_unlock, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_str_buffer(), ast_str_substitute_variables(), ast_str_thread_get(), config, custom_buf, dummy(), errno, cdr_custom_config::filename, cdr_custom_config::format, cdr_custom_config::lock, LOG_ERROR, out, and str.

Referenced by load_module(), and unload_module().

130 {
131  struct ast_channel *dummy;
132  struct ast_str *str;
133  struct cdr_custom_config *config;
134 
135  /* Batching saves memory management here. Otherwise, it's the same as doing an allocation and free each time. */
136  if (!(str = ast_str_thread_get(&custom_buf, 16))) {
137  return -1;
138  }
139 
140  dummy = ast_dummy_channel_alloc();
141  if (!dummy) {
142  ast_log(LOG_ERROR, "Unable to allocate channel for variable subsitution.\n");
143  return -1;
144  }
145 
146  /* We need to dup here since the cdr actually belongs to the other channel,
147  so when we release this channel we don't want the CDR getting cleaned
148  up prematurely. */
149  ast_channel_cdr_set(dummy, ast_cdr_dup(cdr));
150 
152 
153  AST_LIST_TRAVERSE(&sinks, config, list) {
154  FILE *out;
155 
156  ast_str_substitute_variables(&str, 0, dummy, config->format);
157 
158  /* Even though we have a lock on the list, we could be being chased by
159  another thread and this lock ensures that we won't step on anyone's
160  toes. Once each CDR backend gets it's own thread, this lock can be
161  removed. */
162  ast_mutex_lock(&config->lock);
163 
164  /* Because of the absolutely unconditional need for the
165  highest reliability possible in writing billing records,
166  we open write and close the log file each time */
167  if ((out = fopen(config->filename, "a"))) {
168  fputs(ast_str_buffer(str), out);
169  fflush(out); /* be particularly anal here */
170  fclose(out);
171  } else {
172  ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", config->filename, strerror(errno));
173  }
174 
175  ast_mutex_unlock(&config->lock);
176  }
177 
179 
180  ast_channel_unref(dummy);
181 
182  return 0;
183 }
Main Channel structure associated with a channel.
const ast_string_field filename
Definition: cdr_custom.c:72
char * config
Definition: conf2ael.c:66
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2873
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:714
static void dummy(char *unused,...)
Definition: chan_unistim.c:220
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
struct ast_cdr * ast_cdr_dup(struct ast_cdr *cdr)
Duplicate a public CDR.
Definition: cdr.c:2998
void ast_str_substitute_variables(struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, const char *templ)
const ast_string_field format
Definition: cdr_custom.c:72
#define ast_mutex_lock(a)
Definition: lock.h:187
const char * str
Definition: app_jack.c:147
static struct ast_threadstorage custom_buf
Definition: cdr_custom.c:64
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
ast_mutex_t lock
Definition: cdr_custom.c:73
#define ast_log
Definition: astobj2.c:42
void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value)
#define ast_dummy_channel_alloc()
Create a fake channel structure.
Definition: channel.h:1266
#define LOG_ERROR
Definition: logger.h:285
The descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field ...
Definition: strings.h:584
int errno
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
FILE * out
Definition: utils/frame.c:33
struct ast_str * ast_str_thread_get(struct ast_threadstorage *ts, size_t init_len)
Retrieve a thread locally stored dynamic string.
Definition: strings.h:861
#define ast_mutex_unlock(a)
Definition: lock.h:188

◆ free_config()

static void free_config ( void  )
static

Definition at line 79 of file cdr_custom.c.

References ast_free, ast_mutex_destroy, AST_RWLIST_REMOVE_HEAD, ast_string_field_free_memory, and cdr_custom_config::lock.

Referenced by reload(), and unload_module().

80 {
81  struct cdr_custom_config *sink;
82 
83  while ((sink = AST_RWLIST_REMOVE_HEAD(&sinks, list))) {
84  ast_mutex_destroy(&sink->lock);
86  ast_free(sink);
87  }
88 }
ast_mutex_t lock
Definition: cdr_custom.c:73
#define ast_free(a)
Definition: astmm.h:182
#define AST_RWLIST_REMOVE_HEAD
Definition: linkedlists.h:843
#define ast_mutex_destroy(a)
Definition: lock.h:186
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:368

◆ load_config()

static int load_config ( void  )
static

Definition at line 90 of file cdr_custom.c.

References ast_calloc_with_stringfields, ast_config_AST_LOG_DIR, ast_config_destroy(), ast_config_load, ast_log, ast_mutex_init, AST_RWLIST_INSERT_TAIL, ast_string_field_build, ast_strlen_zero, ast_variable_browse(), CONFIG, CONFIG_STATUS_FILEINVALID, cdr_custom_config::filename, cdr_custom_config::format, ast_variable::lineno, cdr_custom_config::lock, LOG_ERROR, LOG_NOTICE, name, ast_variable::name, ast_variable::next, ast_variable::value, and var.

Referenced by load_module(), and reload().

91 {
92  struct ast_config *cfg;
93  struct ast_variable *var;
94  struct ast_flags config_flags = { 0 };
95  int res = 0;
96 
97  cfg = ast_config_load(CONFIG, config_flags);
98  if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
99  ast_log(LOG_ERROR, "Unable to load " CONFIG ". Not logging custom CSV CDRs.\n");
100  return -1;
101  }
102 
103  var = ast_variable_browse(cfg, "mappings");
104  while (var) {
105  if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
106  struct cdr_custom_config *sink = ast_calloc_with_stringfields(1, struct cdr_custom_config, 1024);
107 
108  if (!sink) {
109  ast_log(LOG_ERROR, "Unable to allocate memory for configuration settings.\n");
110  res = -2;
111  break;
112  }
113 
114  ast_string_field_build(sink, format, "%s\n", var->value);
116  ast_mutex_init(&sink->lock);
117 
118  AST_RWLIST_INSERT_TAIL(&sinks, sink, list);
119  } else {
120  ast_log(LOG_NOTICE, "Mapping must have both a filename and a format at line %d\n", var->lineno);
121  }
122  var = var->next;
123  }
124  ast_config_destroy(cfg);
125 
126  return res;
127 }
struct ast_variable * next
const ast_string_field filename
Definition: cdr_custom.c:72
#define CONFIG
Definition: cdr_custom.c:62
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition: extconf.c:1216
#define CONFIG_STATUS_FILEINVALID
Structure for variables, used for configurations and for channel variables.
#define var
Definition: ast_expr2f.c:614
#define ast_calloc_with_stringfields(n, type, size)
Allocate a structure with embedded stringfields in a single allocation.
Definition: stringfields.h:426
ast_mutex_t lock
Definition: cdr_custom.c:73
#define ast_log
Definition: astobj2.c:42
static const char name[]
Definition: cdr_custom.c:66
#define ast_config_load(filename, flags)
Load a config file.
void ast_config_destroy(struct ast_config *config)
Destroys a config.
Definition: extconf.c:1290
#define LOG_ERROR
Definition: logger.h:285
#define LOG_NOTICE
Definition: logger.h:263
const char * ast_config_AST_LOG_DIR
Definition: options.c:156
#define ast_strlen_zero(a)
Definition: muted.c:73
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
Definition: stringfields.h:550
Structure used to handle boolean flags.
Definition: utils.h:199
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:740
#define ast_mutex_init(pmutex)
Definition: lock.h:184
static snd_pcm_format_t format
Definition: chan_alsa.c:102

◆ load_module()

static enum ast_module_load_result load_module ( void  )
static

Definition at line 202 of file cdr_custom.c.

References ast_cdr_register(), ast_log, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, custom_log(), ast_module_info::description, load_config(), LOG_ERROR, and name.

Referenced by reload().

203 {
204  if (AST_RWLIST_WRLOCK(&sinks)) {
205  ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
207  }
208 
209  load_config();
213 }
const char * description
Definition: module.h:352
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:51
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
static int custom_log(struct ast_cdr *cdr)
Definition: cdr_custom.c:129
#define ast_log
Definition: astobj2.c:42
static const char name[]
Definition: cdr_custom.c:66
int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
Register a CDR handling engine.
Definition: cdr.c:2943
#define LOG_ERROR
Definition: logger.h:285
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
static int load_config(void)
Definition: cdr_custom.c:90

◆ reload()

static int reload ( void  )
static

Definition at line 215 of file cdr_custom.c.

References ast_log, AST_MODFLAG_LOAD_ORDER, AST_MODPRI_CDR_DRIVER, AST_MODULE_INFO(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, AST_MODULE_SUPPORT_CORE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ASTERISK_GPL_KEY, free_config(), load_config(), load_module(), LOG_ERROR, and unload_module().

216 {
217  if (AST_RWLIST_WRLOCK(&sinks)) {
218  ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
220  }
221 
222  free_config();
223  load_config();
226 }
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:51
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
#define ast_log
Definition: astobj2.c:42
#define LOG_ERROR
Definition: logger.h:285
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
static void free_config(void)
Definition: cdr_custom.c:79
static int load_config(void)
Definition: cdr_custom.c:90

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 185 of file cdr_custom.c.

References ast_cdr_register(), ast_cdr_unregister(), ast_log, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, custom_log(), ast_module_info::description, free_config(), LOG_ERROR, and name.

Referenced by reload().

186 {
187  if (ast_cdr_unregister(name)) {
188  return -1;
189  }
190 
191  if (AST_RWLIST_WRLOCK(&sinks)) {
193  ast_log(LOG_ERROR, "Unable to lock sink list. Unload failed.\n");
194  return -1;
195  }
196 
197  free_config();
199  return 0;
200 }
const char * description
Definition: module.h:352
int ast_cdr_unregister(const char *name)
Unregister a CDR handling engine.
Definition: cdr.c:2988
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:51
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
static int custom_log(struct ast_cdr *cdr)
Definition: cdr_custom.c:129
#define ast_log
Definition: astobj2.c:42
static const char name[]
Definition: cdr_custom.c:66
int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
Register a CDR handling engine.
Definition: cdr.c:2943
#define LOG_ERROR
Definition: logger.h:285
static void free_config(void)
Definition: cdr_custom.c:79

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Customizable Comma Separated Values CDR Backend" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }
static

Definition at line 235 of file cdr_custom.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 235 of file cdr_custom.c.

◆ custom_buf

struct ast_threadstorage custom_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_custom_buf , .custom_init = NULL , }
static

Definition at line 64 of file cdr_custom.c.

Referenced by custom_log().

◆ name

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

Definition at line 66 of file cdr_custom.c.

Referenced by load_config(), load_module(), and unload_module().

◆ sinks

struct sinks sinks = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static