Asterisk - The Open Source Telephony Project GIT-master-0bf3178
cdr_custom.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 1999 - 2009, Digium, Inc.
5 *
6 * Mark Spencer <markster@digium.com>
7 *
8 * Includes code and algorithms from the Zapata library.
9 *
10 * See http://www.asterisk.org for more information about
11 * the Asterisk project. Please do not directly contact
12 * any of the maintainers of this project for assistance;
13 * the project provides a web site, mailing lists and IRC
14 * channels for your use.
15 *
16 * This program is free software, distributed under the terms of
17 * the GNU General Public License Version 2. See the LICENSE file
18 * at the top of the source tree.
19 */
20
21/*!
22 * \file
23 * \brief Custom Comma Separated Value CDR records.
24 *
25 * \author Mark Spencer <markster@digium.com>
26 *
27 * \arg See also \ref AstCDR
28 *
29 * Logs in LOG_DIR/cdr_custom
30 * \ingroup cdr_drivers
31 */
32
33/*! \li \ref cdr_custom.c uses the configuration file \ref cdr_custom.conf
34 * \addtogroup configuration_file Configuration Files
35 */
36
37/*!
38 * \page cdr_custom.conf cdr_custom.conf
39 * \verbinclude cdr_custom.conf.sample
40 */
41
42/*** MODULEINFO
43 <support_level>core</support_level>
44 ***/
45
46#include "asterisk.h"
47
48#include <time.h>
49
50#include "asterisk/paths.h" /* use ast_config_AST_LOG_DIR */
51#include "asterisk/channel.h"
52#include "asterisk/cdr.h"
53#include "asterisk/module.h"
54#include "asterisk/config.h"
55#include "asterisk/pbx.h"
56#include "asterisk/utils.h"
57#include "asterisk/lock.h"
59#include "asterisk/strings.h"
60
61#define CONFIG "cdr_custom.conf"
62
64
65static const char name[] = "cdr-custom";
66
71 );
74};
75
77
78static void free_config(void)
79{
80 struct cdr_custom_config *sink;
81
82 while ((sink = AST_RWLIST_REMOVE_HEAD(&sinks, list))) {
83 ast_mutex_destroy(&sink->lock);
85 ast_free(sink);
86 }
87}
88
89static int load_config(void)
90{
91 struct ast_config *cfg;
92 struct ast_variable *var;
93 struct ast_flags config_flags = { 0 };
94 int res = 0;
95
96 cfg = ast_config_load(CONFIG, config_flags);
97 if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
98 ast_log(LOG_ERROR, "Unable to load " CONFIG ". Not logging custom CSV CDRs.\n");
99 return -1;
100 }
101
102 var = ast_variable_browse(cfg, "mappings");
103 while (var) {
104 if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
106
107 if (!sink) {
108 ast_log(LOG_ERROR, "Unable to allocate memory for configuration settings.\n");
109 res = -2;
110 break;
111 }
112
113 ast_string_field_build(sink, format, "%s\n", var->value);
114 if (var->name[0] == '/') {
115 ast_string_field_build(sink, filename, "%s", var->name);
116 } else {
118 }
119 ast_mutex_init(&sink->lock);
120
121 AST_RWLIST_INSERT_TAIL(&sinks, sink, list);
122 } else {
123 ast_log(LOG_NOTICE, "Mapping must have both a filename and a format at line %d\n", var->lineno);
124 }
125 var = var->next;
126 }
128
129 return res;
130}
131
132static int custom_log(struct ast_cdr *cdr)
133{
134 struct ast_channel *dummy;
135 struct ast_str *str;
137
138 /* Batching saves memory management here. Otherwise, it's the same as doing an allocation and free each time. */
139 if (!(str = ast_str_thread_get(&custom_buf, 16))) {
140 return -1;
141 }
142
144 if (!dummy) {
145 ast_log(LOG_ERROR, "Unable to allocate channel for variable subsitution.\n");
146 return -1;
147 }
148
149 /* We need to dup here since the cdr actually belongs to the other channel,
150 so when we release this channel we don't want the CDR getting cleaned
151 up prematurely. */
153
155
157 FILE *out;
158
160
161 /* Even though we have a lock on the list, we could be being chased by
162 another thread and this lock ensures that we won't step on anyone's
163 toes. Once each CDR backend gets it's own thread, this lock can be
164 removed. */
165 ast_mutex_lock(&config->lock);
166
167 /* Because of the absolutely unconditional need for the
168 highest reliability possible in writing billing records,
169 we open write and close the log file each time */
170 if ((out = fopen(config->filename, "a"))) {
171 fputs(ast_str_buffer(str), out);
172 fflush(out); /* be particularly anal here */
173 fclose(out);
174 } else {
175 ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", config->filename, strerror(errno));
176 }
177
178 ast_mutex_unlock(&config->lock);
179 }
180
182
184
185 return 0;
186}
187
188static int unload_module(void)
189{
191 return -1;
192 }
193
194 if (AST_RWLIST_WRLOCK(&sinks)) {
196 ast_log(LOG_ERROR, "Unable to lock sink list. Unload failed.\n");
197 return -1;
198 }
199
200 free_config();
202 return 0;
203}
204
206{
207 if (AST_RWLIST_WRLOCK(&sinks)) {
208 ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
210 }
211
212 load_config();
216}
217
218static int reload(void)
219{
220 if (AST_RWLIST_WRLOCK(&sinks)) {
221 ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
223 }
224
225 free_config();
226 load_config();
229}
230
231AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Customizable Comma Separated Values CDR Backend",
232 .support_level = AST_MODULE_SUPPORT_CORE,
233 .load = load_module,
234 .unload = unload_module,
235 .reload = reload,
236 .load_pri = AST_MODPRI_CDR_DRIVER,
237 .requires = "cdr",
const char * str
Definition: app_jack.c:147
#define var
Definition: ast_expr2f.c:605
Asterisk main include file. File version handling, generic pbx functions.
#define ast_free(a)
Definition: astmm.h:180
#define ast_log
Definition: astobj2.c:42
Call Detail Record API.
int ast_cdr_unregister(const char *name)
Unregister a CDR handling engine.
Definition: cdr.c:3054
int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
Register a CDR handling engine.
Definition: cdr.c:3009
struct ast_cdr * ast_cdr_dup(struct ast_cdr *cdr)
Duplicate a public CDR.
Definition: cdr.c:3064
static const char name[]
Definition: cdr_custom.c:65
static struct ast_threadstorage custom_buf
Definition: cdr_custom.c:63
#define CONFIG
Definition: cdr_custom.c:61
static enum ast_module_load_result load_module(void)
Definition: cdr_custom.c:205
static void free_config(void)
Definition: cdr_custom.c:78
static int custom_log(struct ast_cdr *cdr)
Definition: cdr_custom.c:132
static int unload_module(void)
Definition: cdr_custom.c:188
static int reload(void)
Definition: cdr_custom.c:218
static int load_config(void)
Definition: cdr_custom.c:89
static const char config[]
Definition: chan_ooh323.c:111
static void dummy(char *unused,...)
Definition: chan_unistim.c:220
General Asterisk PBX channel definitions.
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:3004
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:1328
Configuration File Parser.
#define ast_config_load(filename, flags)
Load a config file.
#define CONFIG_STATUS_FILEINVALID
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition: extconf.c:1289
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition: extconf.c:1215
#define LOG_ERROR
#define LOG_NOTICE
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
#define AST_RWLIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a read/write list of specified type, statically initialized.
Definition: linkedlists.h:333
#define AST_RWLIST_REMOVE_HEAD
Definition: linkedlists.h:844
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:741
#define AST_RWLIST_ENTRY
Definition: linkedlists.h:415
Asterisk locking-related definitions:
#define ast_mutex_init(pmutex)
Definition: lock.h:186
#define ast_mutex_unlock(a)
Definition: lock.h:190
#define ast_mutex_destroy(a)
Definition: lock.h:188
#define ast_mutex_lock(a)
Definition: lock.h:189
int errno
Asterisk module definitions.
@ AST_MODFLAG_LOAD_ORDER
Definition: module.h:331
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition: module.h:557
@ AST_MODPRI_CDR_DRIVER
Definition: module.h:345
@ AST_MODULE_SUPPORT_CORE
Definition: module.h:121
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
ast_module_load_result
Definition: module.h:68
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
Asterisk file paths, configured in asterisk.conf.
const char * ast_config_AST_LOG_DIR
Definition: options.c:159
Core PBX routines and definitions.
void ast_str_substitute_variables(struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, const char *templ)
#define AST_DECLARE_STRING_FIELDS(field_list)
Declare the fields needed in a structure.
Definition: stringfields.h:341
#define ast_calloc_with_stringfields(n, type, size)
Allocate a structure with embedded stringfields in a single allocation.
Definition: stringfields.h:432
#define AST_STRING_FIELD(name)
Declare a string field.
Definition: stringfields.h:303
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
Definition: stringfields.h:555
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:374
String manipulation functions.
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
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:909
Responsible for call detail data.
Definition: cdr.h:279
Main Channel structure associated with a channel.
Structure used to handle boolean flags.
Definition: utils.h:199
const char * description
Definition: module.h:366
Structure for mutex and tracking information.
Definition: lock.h:135
Support for dynamic strings.
Definition: strings.h:623
Structure for variables, used for configurations and for channel variables.
const ast_string_field filename
Definition: cdr_custom.c:71
const ast_string_field format
Definition: cdr_custom.c:71
ast_mutex_t lock
Definition: cdr_custom.c:72
Definitions to aid in the use of thread local storage.
#define AST_THREADSTORAGE(name)
Define a thread storage variable.
Definition: threadstorage.h:86
Time-related functions and macros.
FILE * out
Definition: utils/frame.c:33
Utility functions.