Merged revisions 321926 via svnmerge from
[asterisk/asterisk.git] / cel / cel_custom.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Steve Murphy <murf@digium.com>
7  * much borrowed from cdr code (cdr_custom.c), author Mark Spencer
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Custom Comma Separated Value CEL records.
23  *
24  * \author Steve Murphy <murf@digium.com>
25  *
26  * \arg See also \ref AstCEL
27  *
28  * Logs in LOG_DIR/cel_custom
29  * \ingroup cel_drivers
30  */
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/paths.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/cel.h"
39 #include "asterisk/module.h"
40 #include "asterisk/config.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/threadstorage.h"
45 #include "asterisk/strings.h"
46
47 #define CUSTOM_LOG_DIR "/cel_custom"
48 #define CONFIG         "cel_custom.conf"
49
50 AST_THREADSTORAGE(custom_buf);
51
52 static const char name[] = "cel-custom";
53
54 struct cel_config {
55         AST_DECLARE_STRING_FIELDS(
56                 AST_STRING_FIELD(filename);
57                 AST_STRING_FIELD(format);
58         );
59         ast_mutex_t lock;
60         AST_RWLIST_ENTRY(cel_config) list;
61 };
62
63 static struct ast_event_sub *event_sub = NULL;
64
65 static AST_RWLIST_HEAD_STATIC(sinks, cel_config);
66
67 static void free_config(void)
68 {
69         struct cel_config *sink;
70         while ((sink = AST_RWLIST_REMOVE_HEAD(&sinks, list))) {
71                 ast_mutex_destroy(&sink->lock);
72                 ast_free(sink);
73         }
74 }
75
76 static int load_config(void)
77 {
78         struct ast_config *cfg;
79         struct ast_variable *var;
80         struct ast_flags config_flags = { 0 };
81         int res = 0;
82
83         cfg = ast_config_load(CONFIG, config_flags);
84         if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
85                 ast_log(LOG_ERROR, "Unable to load " CONFIG ". Not logging CEL to custom CSVs.\n");
86                 return -1;
87         }
88
89         var = ast_variable_browse(cfg, "mappings");
90         while (var) {
91                 if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
92                         struct cel_config *sink = ast_calloc_with_stringfields(1, struct cel_config, 1024);
93
94                         if (!sink) {
95                                 ast_log(LOG_ERROR, "Unable to allocate memory for configuration settings.\n");
96                                 res = -2;
97                                 break;
98                         }
99
100                         ast_string_field_build(sink, format, "%s\n", var->value);
101                         ast_string_field_build(sink, filename, "%s/%s/%s", ast_config_AST_LOG_DIR, name, var->name);
102                         ast_mutex_init(&sink->lock);
103
104                         AST_RWLIST_INSERT_TAIL(&sinks, sink, list);
105                 } else {
106                         ast_log(LOG_NOTICE, "Mapping must have both a filename and a format at line %d\n", var->lineno);
107                 }
108                 var = var->next;
109         }
110         ast_config_destroy(cfg);
111
112         return res;
113 }
114
115 static void custom_log(const struct ast_event *event, void *userdata)
116 {
117         struct ast_channel *dummy;
118         struct ast_str *str;
119         struct cel_config *config;
120
121         /* Batching saves memory management here.  Otherwise, it's the same as doing an allocation and free each time. */
122         if (!(str = ast_str_thread_get(&custom_buf, 16))) {
123                 return;
124         }
125
126         dummy = ast_cel_fabricate_channel_from_event(event);
127
128         if (!dummy) {
129                 ast_log(LOG_ERROR, "Unable to fabricate channel from CEL event.\n");
130                 return;
131         }
132
133         AST_RWLIST_RDLOCK(&sinks);
134
135         AST_LIST_TRAVERSE(&sinks, config, list) {
136                 FILE *out;
137
138                 ast_str_substitute_variables(&str, 0, dummy, config->format);
139
140                 /* Even though we have a lock on the list, we could be being chased by
141                    another thread and this lock ensures that we won't step on anyone's
142                    toes.  Once each CEL backend gets it's own thread, this lock can be
143                    removed. */
144                 ast_mutex_lock(&config->lock);
145
146                 /* Because of the absolutely unconditional need for the
147                    highest reliability possible in writing billing records,
148                    we open write and close the log file each time */
149                 if ((out = fopen(config->filename, "a"))) {
150                         fputs(ast_str_buffer(str), out);
151                         fflush(out); /* be particularly anal here */
152                         fclose(out);
153                 } else {
154                         ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", config->filename, strerror(errno));
155                 }
156
157                 ast_mutex_unlock(&config->lock);
158         }
159
160         AST_RWLIST_UNLOCK(&sinks);
161
162         ast_channel_release(dummy);
163 }
164
165 static int unload_module(void)
166 {
167         if (event_sub) {
168                 event_sub = ast_event_unsubscribe(event_sub);
169         }
170
171         if (AST_RWLIST_WRLOCK(&sinks)) {
172                 event_sub = ast_event_subscribe(AST_EVENT_CEL, custom_log, "CEL Custom CSV Logging",
173                         NULL, AST_EVENT_IE_END);
174                 ast_log(LOG_ERROR, "Unable to lock sink list.  Unload failed.\n");
175                 return -1;
176         }
177
178         free_config();
179         AST_RWLIST_UNLOCK(&sinks);
180         return 0;
181 }
182
183 static enum ast_module_load_result load_module(void)
184 {
185         if (AST_RWLIST_WRLOCK(&sinks)) {
186                 ast_log(LOG_ERROR, "Unable to lock sink list.  Load failed.\n");
187                 return AST_MODULE_LOAD_FAILURE;
188         }
189
190         load_config();
191         AST_RWLIST_UNLOCK(&sinks);
192
193         event_sub = ast_event_subscribe(AST_EVENT_CEL, custom_log, "CEL Custom CSV Logging",
194                 NULL, AST_EVENT_IE_END);
195         return AST_MODULE_LOAD_SUCCESS;
196 }
197
198 static int reload(void)
199 {
200         if (AST_RWLIST_WRLOCK(&sinks)) {
201                 ast_log(LOG_ERROR, "Unable to lock sink list.  Load failed.\n");
202                 return AST_MODULE_LOAD_FAILURE;
203         }
204
205         free_config();
206         load_config();
207         AST_RWLIST_UNLOCK(&sinks);
208         return AST_MODULE_LOAD_SUCCESS;
209 }
210
211 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Customizable Comma Separated Values CEL Backend",
212         .load = load_module,
213         .unload = unload_module,
214         .reload = reload,
215         .load_pri = AST_MODPRI_CDR_DRIVER,
216         );
217