Wed Jan 8 2020 09:49:42

Asterisk developer's documentation


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 /*** MODULEINFO
34  <support_level>core</support_level>
35  ***/
36 
37 #include "asterisk.h"
38 
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 337973 $")
40 
41 #include <time.h>
42 
43 #include "asterisk/paths.h" /* use ast_config_AST_LOG_DIR */
44 #include "asterisk/channel.h"
45 #include "asterisk/cdr.h"
46 #include "asterisk/module.h"
47 #include "asterisk/config.h"
48 #include "asterisk/pbx.h"
49 #include "asterisk/utils.h"
50 #include "asterisk/lock.h"
51 #include "asterisk/threadstorage.h"
52 #include "asterisk/strings.h"
53 
54 #define CUSTOM_LOG_DIR "/cdr_custom"
55 #define CONFIG "cdr_custom.conf"
56 
58 
59 static const char name[] = "cdr-custom";
60 
61 struct cdr_config {
65  );
68 };
69 
71 
72 static void free_config(void)
73 {
74  struct cdr_config *sink;
75  while ((sink = AST_RWLIST_REMOVE_HEAD(&sinks, list))) {
76  ast_mutex_destroy(&sink->lock);
77  ast_free(sink);
78  }
79 }
80 
81 static int load_config(void)
82 {
83  struct ast_config *cfg;
84  struct ast_variable *var;
85  struct ast_flags config_flags = { 0 };
86  int res = 0;
87 
88  cfg = ast_config_load(CONFIG, config_flags);
89  if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
90  ast_log(LOG_ERROR, "Unable to load " CONFIG ". Not logging custom CSV CDRs.\n");
91  return -1;
92  }
93 
94  var = ast_variable_browse(cfg, "mappings");
95  while (var) {
96  if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
97  struct cdr_config *sink = ast_calloc_with_stringfields(1, struct cdr_config, 1024);
98 
99  if (!sink) {
100  ast_log(LOG_ERROR, "Unable to allocate memory for configuration settings.\n");
101  res = -2;
102  break;
103  }
104 
105  ast_string_field_build(sink, format, "%s\n", var->value);
106  ast_string_field_build(sink, filename, "%s/%s/%s", ast_config_AST_LOG_DIR, name, var->name);
107  ast_mutex_init(&sink->lock);
108 
110  } else {
111  ast_log(LOG_NOTICE, "Mapping must have both a filename and a format at line %d\n", var->lineno);
112  }
113  var = var->next;
114  }
115  ast_config_destroy(cfg);
116 
117  return res;
118 }
119 
120 static int custom_log(struct ast_cdr *cdr)
121 {
122  struct ast_channel *dummy;
123  struct ast_str *str;
124  struct cdr_config *config;
125 
126  /* Batching saves memory management here. Otherwise, it's the same as doing an allocation and free each time. */
127  if (!(str = ast_str_thread_get(&custom_buf, 16))) {
128  return -1;
129  }
130 
131  dummy = ast_dummy_channel_alloc();
132  if (!dummy) {
133  ast_log(LOG_ERROR, "Unable to allocate channel for variable subsitution.\n");
134  return -1;
135  }
136 
137  /* We need to dup here since the cdr actually belongs to the other channel,
138  so when we release this channel we don't want the CDR getting cleaned
139  up prematurely. */
140  dummy->cdr = ast_cdr_dup(cdr);
141 
143 
144  AST_LIST_TRAVERSE(&sinks, config, list) {
145  FILE *out;
146 
147  ast_str_substitute_variables(&str, 0, dummy, config->format);
148 
149  /* Even though we have a lock on the list, we could be being chased by
150  another thread and this lock ensures that we won't step on anyone's
151  toes. Once each CDR backend gets it's own thread, this lock can be
152  removed. */
153  ast_mutex_lock(&config->lock);
154 
155  /* Because of the absolutely unconditional need for the
156  highest reliability possible in writing billing records,
157  we open write and close the log file each time */
158  if ((out = fopen(config->filename, "a"))) {
159  fputs(ast_str_buffer(str), out);
160  fflush(out); /* be particularly anal here */
161  fclose(out);
162  } else {
163  ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", config->filename, strerror(errno));
164  }
165 
166  ast_mutex_unlock(&config->lock);
167  }
168 
170 
171  ast_channel_unref(dummy);
172 
173  return 0;
174 }
175 
176 static int unload_module(void)
177 {
178  ast_cdr_unregister(name);
179 
180  if (AST_RWLIST_WRLOCK(&sinks)) {
182  ast_log(LOG_ERROR, "Unable to lock sink list. Unload failed.\n");
183  return -1;
184  }
185 
186  free_config();
188  return 0;
189 }
190 
192 {
193  if (AST_RWLIST_WRLOCK(&sinks)) {
194  ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
196  }
197 
198  load_config();
202 }
203 
204 static int reload(void)
205 {
206  if (AST_RWLIST_WRLOCK(&sinks)) {
207  ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
209  }
210 
211  free_config();
212  load_config();
215 }
216 
217 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Customizable Comma Separated Values CDR Backend",
218  .load = load_module,
219  .unload = unload_module,
220  .reload = reload,
221  .load_pri = AST_MODPRI_CDR_DRIVER,
222  );
223 
const char * description
Definition: module.h:234
#define AST_THREADSTORAGE(name)
Define a thread storage variable.
Definition: threadstorage.h:81
ast_module_load_result
Definition: module.h:60
Main Channel structure associated with a channel.
Definition: channel.h:742
Asterisk locking-related definitions:
Asterisk main include file. File version handling, generic pbx functions.
#define CONFIG
Definition: cdr_custom.c:55
static const char config[]
Definition: cdr_csv.c:57
#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:332
String manipulation functions.
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2502
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:51
const ast_string_field filename
Definition: cdr_custom.c:65
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category)
Goes through variables.
Definition: config.c:597
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:497
static void dummy(char *unused,...)
Definition: chan_unistim.c:188
int lineno
Definition: config.h:87
static int unload_module(void)
Definition: cdr_custom.c:176
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:150
Structure for variables, used for configurations and for channel variables.
Definition: config.h:75
#define var
Definition: ast_expr2f.c:606
struct ast_cdr * ast_cdr_dup(struct ast_cdr *cdr)
Duplicate a record.
Definition: cdr.c:213
void ast_str_substitute_variables(struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, const char *templ)
Definition: pbx.c:4468
Configuration File Parser.
#define ast_calloc_with_stringfields(n, type, size)
Allocate a structure with embedded stringfields in a single allocation.
Definition: stringfields.h:275
static enum ast_module_load_result load_module(void)
Definition: cdr_custom.c:191
#define AST_DECLARE_STRING_FIELDS(field_list)
Declare the fields needed in a structure.
Definition: stringfields.h:235
#define ast_mutex_lock(a)
Definition: lock.h:155
struct ast_cdr * cdr
Definition: channel.h:766
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition: module.h:374
const char * str
Definition: app_jack.c:144
Definitions to aid in the use of thread local storage.
void ast_config_destroy(struct ast_config *config)
Destroys a config.
Definition: config.c:1037
static int custom_log(struct ast_cdr *cdr)
Definition: cdr_custom.c:120
Utility functions.
static struct ast_threadstorage custom_buf
Definition: cdr_custom.c:57
Call Detail Record API.
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:77
const char * value
Definition: config.h:79
int ast_cdr_register(const char *name, const char *desc, ast_cdrbe be)
Register a CDR handling engine.
Definition: cdr.c:130
General Asterisk PBX channel definitions.
Asterisk file paths, configured in asterisk.conf.
struct cdr_config::@76 list
#define ast_config_load(filename, flags)
Load a config file.
Definition: config.h:170
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
#define AST_STRING_FIELD(name)
Declare a string field.
Definition: stringfields.h:220
const char * name
Definition: config.h:77
Core PBX routines and definitions.
Responsible for call detail data.
Definition: cdr.h:82
#define LOG_ERROR
Definition: logger.h:155
The descriptor of a dynamic string XXX storage will be optimized later if needed We use the ts field ...
Definition: strings.h:364
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
#define LOG_NOTICE
Definition: logger.h:133
const char * ast_config_AST_LOG_DIR
Definition: asterisk.c:263
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
int errno
static const char name[]
#define ast_free(a)
Definition: astmm.h:97
#define AST_RWLIST_REMOVE_HEAD
Definition: linkedlists.h:829
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
Definition: stringfields.h:367
Structure used to handle boolean flags.
Definition: utils.h:200
#define AST_RWLIST_ENTRY
Definition: linkedlists.h:414
static void free_config(void)
Definition: cdr_custom.c:72
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:726
static int load_config(void)
Definition: cdr_custom.c:81
const ast_string_field format
Definition: cdr_custom.c:65
static int reload(void)
Definition: cdr_custom.c:204
struct ast_variable * next
Definition: config.h:82
#define ast_mutex_init(pmutex)
Definition: lock.h:152
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:669
#define CONFIG_STATUS_FILEINVALID
Definition: config.h:52
#define ast_mutex_destroy(a)
Definition: lock.h:154
struct ast_channel * ast_dummy_channel_alloc(void)
Create a fake channel structure.
Definition: channel.c:1391
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:38
Asterisk module definitions.
void ast_cdr_unregister(const char *name)
Unregister a CDR handling engine.
Definition: cdr.c:165
Structure for mutex and tracking information.
Definition: lock.h:121
#define ASTERISK_FILE_VERSION(file, version)
Register/unregister a source code file with the core.
Definition: asterisk.h:180
#define ast_mutex_unlock(a)
Definition: lock.h:156
ast_mutex_t lock
Definition: cdr_custom.c:66