2009-06-26 15:28:53 +00:00
|
|
|
/*
|
|
|
|
* Asterisk -- An open source telephony toolkit.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2009, Digium, Inc.
|
|
|
|
*
|
|
|
|
* Steve Murphy <murf@digium.com>
|
|
|
|
* much borrowed from cdr code (cdr_custom.c), author Mark Spencer
|
|
|
|
*
|
|
|
|
* See http://www.asterisk.org for more information about
|
|
|
|
* the Asterisk project. Please do not directly contact
|
|
|
|
* any of the maintainers of this project for assistance;
|
|
|
|
* the project provides a web site, mailing lists and IRC
|
|
|
|
* channels for your use.
|
|
|
|
*
|
|
|
|
* This program is free software, distributed under the terms of
|
|
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
|
|
* at the top of the source tree.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*! \file
|
|
|
|
*
|
|
|
|
* \brief Custom Comma Separated Value CEL records.
|
|
|
|
*
|
|
|
|
* \author Steve Murphy <murf@digium.com>
|
|
|
|
*
|
|
|
|
* \arg See also \ref AstCEL
|
|
|
|
*
|
|
|
|
* Logs in LOG_DIR/cel_custom
|
|
|
|
* \ingroup cel_drivers
|
|
|
|
*/
|
|
|
|
|
2011-07-14 20:28:54 +00:00
|
|
|
/*** MODULEINFO
|
|
|
|
<support_level>core</support_level>
|
|
|
|
***/
|
|
|
|
|
2009-06-26 15:28:53 +00:00
|
|
|
#include "asterisk.h"
|
|
|
|
|
git migration: Refactor the ASTERISK_FILE_VERSION macro
Git does not support the ability to replace a token with a version
string during check-in. While it does have support for replacing a
token on clone, this is somewhat sub-optimal: the token is replaced
with the object hash, which is not particularly easy for human
consumption. What's more, in practice, the source file version was often
not terribly useful. Generally, when triaging bugs, the overall version
of Asterisk is far more useful than an individual SVN version of a file. As a
result, this patch removes Asterisk's support for showing source file
versions.
Specifically, it does the following:
* Rename ASTERISK_FILE_VERSION macro to ASTERISK_REGISTER_FILE, and
remove passing the version in with the macro. Other facilities
than 'core show file version' make use of the file names, such as
setting a debug level only on a specific file. As such, the act of
registering source files with the Asterisk core still has use. The
macro rename now reflects the new macro purpose.
* main/asterisk:
- Refactor the file_version structure to reflect that it no longer
tracks a version field.
- Remove the "core show file version" CLI command. Without the file
version, it is no longer useful.
- Remove the ast_file_version_find function. The file version is no
longer tracked.
- Rename ast_register_file_version/ast_unregister_file_version to
ast_register_file/ast_unregister_file, respectively.
* main/manager: Remove value from the Version key of the ModuleCheck
Action. The actual key itself has not been removed, as doing so would
absolutely constitute a backwards incompatible change. However, since
the file version is no longer tracked, there is no need to attempt to
include it in the Version key.
* UPGRADE: Add notes for:
- Modification to the ModuleCheck AMI Action
- Removal of the "core show file version" CLI command
Change-Id: I6cf0ff280e1668bf4957dc21f32a5ff43444a40e
2015-04-12 02:38:22 +00:00
|
|
|
ASTERISK_REGISTER_FILE()
|
2009-06-26 15:28:53 +00:00
|
|
|
|
|
|
|
#include "asterisk/paths.h"
|
|
|
|
#include "asterisk/channel.h"
|
|
|
|
#include "asterisk/cel.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"
|
|
|
|
|
|
|
|
#define CUSTOM_LOG_DIR "/cel_custom"
|
|
|
|
#define CONFIG "cel_custom.conf"
|
|
|
|
|
|
|
|
AST_THREADSTORAGE(custom_buf);
|
|
|
|
|
|
|
|
static const char name[] = "cel-custom";
|
|
|
|
|
|
|
|
struct cel_config {
|
|
|
|
AST_DECLARE_STRING_FIELDS(
|
|
|
|
AST_STRING_FIELD(filename);
|
|
|
|
AST_STRING_FIELD(format);
|
|
|
|
);
|
|
|
|
ast_mutex_t lock;
|
|
|
|
AST_RWLIST_ENTRY(cel_config) list;
|
|
|
|
};
|
|
|
|
|
2013-08-17 14:46:44 +00:00
|
|
|
#define CUSTOM_BACKEND_NAME "CEL Custom CSV Logging"
|
2009-06-26 15:28:53 +00:00
|
|
|
|
|
|
|
static AST_RWLIST_HEAD_STATIC(sinks, cel_config);
|
|
|
|
|
|
|
|
static void free_config(void)
|
|
|
|
{
|
|
|
|
struct cel_config *sink;
|
|
|
|
while ((sink = AST_RWLIST_REMOVE_HEAD(&sinks, list))) {
|
|
|
|
ast_mutex_destroy(&sink->lock);
|
|
|
|
ast_free(sink);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static int load_config(void)
|
|
|
|
{
|
|
|
|
struct ast_config *cfg;
|
|
|
|
struct ast_variable *var;
|
|
|
|
struct ast_flags config_flags = { 0 };
|
2013-09-03 14:29:52 +00:00
|
|
|
int mappings = 0;
|
2009-06-26 15:28:53 +00:00
|
|
|
int res = 0;
|
|
|
|
|
|
|
|
cfg = ast_config_load(CONFIG, config_flags);
|
|
|
|
if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to load " CONFIG ". Not logging CEL to custom CSVs.\n");
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
2013-09-03 14:29:52 +00:00
|
|
|
if (!(var = ast_variable_browse(cfg, "mappings"))) {
|
|
|
|
ast_log(LOG_NOTICE, "No mappings found in " CONFIG ". Not logging CEL to custom CSVs.\n");
|
|
|
|
}
|
|
|
|
|
2009-06-26 15:28:53 +00:00
|
|
|
while (var) {
|
|
|
|
if (!ast_strlen_zero(var->name) && !ast_strlen_zero(var->value)) {
|
|
|
|
struct cel_config *sink = ast_calloc_with_stringfields(1, struct cel_config, 1024);
|
|
|
|
|
|
|
|
if (!sink) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to allocate memory for configuration settings.\n");
|
|
|
|
res = -2;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
ast_string_field_build(sink, format, "%s\n", var->value);
|
|
|
|
ast_string_field_build(sink, filename, "%s/%s/%s", ast_config_AST_LOG_DIR, name, var->name);
|
|
|
|
ast_mutex_init(&sink->lock);
|
|
|
|
|
2013-09-03 14:29:52 +00:00
|
|
|
ast_verb(3, "Added CEL CSV mapping for '%s'.\n", sink->filename);
|
|
|
|
mappings += 1;
|
2009-06-26 15:28:53 +00:00
|
|
|
AST_RWLIST_INSERT_TAIL(&sinks, sink, list);
|
|
|
|
} else {
|
|
|
|
ast_log(LOG_NOTICE, "Mapping must have both a filename and a format at line %d\n", var->lineno);
|
|
|
|
}
|
|
|
|
var = var->next;
|
|
|
|
}
|
|
|
|
ast_config_destroy(cfg);
|
|
|
|
|
2013-09-03 14:29:52 +00:00
|
|
|
ast_verb(1, "Added CEL CSV mapping for %d files.\n", mappings);
|
|
|
|
|
2009-06-26 15:28:53 +00:00
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2013-08-17 14:46:44 +00:00
|
|
|
static void custom_log(struct ast_event *event)
|
2009-06-26 15:28:53 +00:00
|
|
|
{
|
|
|
|
struct ast_channel *dummy;
|
|
|
|
struct ast_str *str;
|
|
|
|
struct cel_config *config;
|
|
|
|
|
|
|
|
/* Batching saves memory management here. Otherwise, it's the same as doing an allocation and free each time. */
|
|
|
|
if (!(str = ast_str_thread_get(&custom_buf, 16))) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
dummy = ast_cel_fabricate_channel_from_event(event);
|
|
|
|
if (!dummy) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to fabricate channel from CEL event.\n");
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
AST_RWLIST_RDLOCK(&sinks);
|
|
|
|
|
|
|
|
AST_LIST_TRAVERSE(&sinks, config, list) {
|
|
|
|
FILE *out;
|
|
|
|
|
|
|
|
ast_str_substitute_variables(&str, 0, dummy, config->format);
|
|
|
|
|
|
|
|
/* Even though we have a lock on the list, we could be being chased by
|
|
|
|
another thread and this lock ensures that we won't step on anyone's
|
|
|
|
toes. Once each CEL backend gets it's own thread, this lock can be
|
|
|
|
removed. */
|
|
|
|
ast_mutex_lock(&config->lock);
|
|
|
|
|
|
|
|
/* 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 */
|
|
|
|
if ((out = fopen(config->filename, "a"))) {
|
|
|
|
fputs(ast_str_buffer(str), out);
|
|
|
|
fflush(out); /* be particularly anal here */
|
|
|
|
fclose(out);
|
|
|
|
} else {
|
|
|
|
ast_log(LOG_ERROR, "Unable to re-open master file %s : %s\n", config->filename, strerror(errno));
|
|
|
|
}
|
|
|
|
|
|
|
|
ast_mutex_unlock(&config->lock);
|
|
|
|
}
|
|
|
|
|
|
|
|
AST_RWLIST_UNLOCK(&sinks);
|
|
|
|
|
2011-09-26 19:40:12 +00:00
|
|
|
ast_channel_unref(dummy);
|
2009-06-26 15:28:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int unload_module(void)
|
|
|
|
{
|
|
|
|
|
|
|
|
if (AST_RWLIST_WRLOCK(&sinks)) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to lock sink list. Unload failed.\n");
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
free_config();
|
|
|
|
AST_RWLIST_UNLOCK(&sinks);
|
2013-08-17 14:46:44 +00:00
|
|
|
ast_cel_backend_unregister(CUSTOM_BACKEND_NAME);
|
2009-06-26 15:28:53 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static enum ast_module_load_result load_module(void)
|
|
|
|
{
|
|
|
|
if (AST_RWLIST_WRLOCK(&sinks)) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
|
|
|
|
return AST_MODULE_LOAD_FAILURE;
|
|
|
|
}
|
|
|
|
|
|
|
|
load_config();
|
|
|
|
AST_RWLIST_UNLOCK(&sinks);
|
|
|
|
|
2013-08-17 14:46:44 +00:00
|
|
|
if (ast_cel_backend_register(CUSTOM_BACKEND_NAME, custom_log)) {
|
|
|
|
return AST_MODULE_LOAD_FAILURE;
|
|
|
|
}
|
2009-06-26 15:28:53 +00:00
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int reload(void)
|
|
|
|
{
|
|
|
|
if (AST_RWLIST_WRLOCK(&sinks)) {
|
|
|
|
ast_log(LOG_ERROR, "Unable to lock sink list. Load failed.\n");
|
|
|
|
return AST_MODULE_LOAD_FAILURE;
|
|
|
|
}
|
|
|
|
|
|
|
|
free_config();
|
|
|
|
load_config();
|
|
|
|
AST_RWLIST_UNLOCK(&sinks);
|
|
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
|
|
}
|
|
|
|
|
2010-07-20 19:35:02 +00:00
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Customizable Comma Separated Values CEL Backend",
|
2014-07-25 16:47:17 +00:00
|
|
|
.support_level = AST_MODULE_SUPPORT_CORE,
|
2009-06-26 15:28:53 +00:00
|
|
|
.load = load_module,
|
|
|
|
.unload = unload_module,
|
|
|
|
.reload = reload,
|
2010-07-20 19:35:02 +00:00
|
|
|
.load_pri = AST_MODPRI_CDR_DRIVER,
|
2015-05-06 00:49:04 +00:00
|
|
|
);
|
2009-06-26 15:28:53 +00:00
|
|
|
|