loggers.c File Reference

Common log entrypoint from the cdr/cel modules. More...

#include "cdrel.h"
#include "asterisk/pbx.h"
#include "asterisk/vector.h"

Include dependency graph for loggers.c:

Go to the source code of this file.

Typedefs
typedef int(*	cdrel_logger_cb) (struct cdrel_config *config, void *data)

Functions
	AST_THREADSTORAGE_CUSTOM_SCOPE (custom_buf, NULL, ast_free_ptr, static)
int	cdrel_logger (struct cdrel_configs *configs, void *data)
	Log a record. The module's logging_cb must call this.
static void	free_value (void *data)
static void	free_value_vector (void *data)
static int	log_advanced_record (struct cdrel_config *config, void *data)
static int	log_legacy_database_record (struct cdrel_config *config, void *data)
static int	log_legacy_dsv_record (struct cdrel_config *config, void *data)

Variables
static const cdrel_logger_cb	logger_callbacks [cdrel_backend_type_end][cdrel_config_type_end]

Detailed Description

Common log entrypoint from the cdr/cel modules.

Author

George Joseph gjose.nosp@m.ph@s.nosp@m.angom.nosp@m.a.co.nosp@m.m

Definition in file loggers.c.

Typedef Documentation

cdrel_logger_cb

typedef int(* cdrel_logger_cb) (struct cdrel_config *config, void *data)

Definition at line 236 of file loggers.c.

Function Documentation

AST_THREADSTORAGE_CUSTOM_SCOPE()

AST_THREADSTORAGE_CUSTOM_SCOPE	(	custom_buf	,
		NULL	,
		ast_free_ptr	,
		static
	)

cdrel_logger()

int cdrel_logger	(	struct cdrel_configs *	configs,
		void *	data
	)

Log a record. The module's logging_cb must call this.

Warning

This function MUST be called with the module's config_lock held for reading to prevent reloads from happening while we're logging.

Parameters

configs	A pointer to the VECTOR of config objects returned by cdrel_load_module.
data	A pointer to an ast_cdr or ast_event object to log.

Return values

0	Success.
-1	Failure.

Definition at line 270 of file loggers.c.

{
    struct ast_channel *dummy = NULL;
    int ix = 0;
    int skip_legacy = 0;
    int res = 0;
 
    for(ix = 0; ix < AST_VECTOR_SIZE(configs); ix++) {
        struct cdrel_config *config = AST_VECTOR_GET(configs, ix);
        void *chan_or_data = NULL;
 
        if (config->config_type == cdrel_config_legacy) {
            if (skip_legacy) {
                continue;
            }
            if (!dummy) {
                dummy = config->dummy_channel_alloc(config, data);
                if (!dummy) {
                    ast_log(LOG_ERROR, "Unable to fabricate channel from CEL event for '%s'\n",
                        config->output_filename);
                    skip_legacy = 1;
                    res--;
                    continue;
                }
            }
            chan_or_data = dummy;
        } else {
            chan_or_data = data;
        }
        res += logger_callbacks[config->backend_type][config->config_type](config, chan_or_data);
    }
 
    if (dummy) {
        ast_channel_unref(dummy);
    }
    return res;
}

References ast_channel_unref, ast_log, AST_VECTOR_GET, AST_VECTOR_SIZE, cdrel_config_legacy, config, dummy(), LOG_ERROR, logger_callbacks, and NULL.

Referenced by custom_log(), custom_log(), custom_log(), and custom_log().

free_value()

static void free_value ( void *  data )

static

Definition at line 45 of file loggers.c.

{
    struct cdrel_value *val = data;
    if (val->data_type == cdrel_type_string) {
        ast_free(val->values.string);
        val->values.string = NULL;
    }
    ast_free(val);
}

References ast_free, cdrel_type_string, and NULL.

Referenced by free_value_vector().

free_value_vector()

static void free_value_vector ( void *  data )

static

Definition at line 61 of file loggers.c.

{
    struct cdrel_values *values = data;
    AST_VECTOR_RESET(values, free_value);
    AST_VECTOR_PTR_FREE(values);
}

References AST_VECTOR_PTR_FREE, AST_VECTOR_RESET, and free_value().

Referenced by log_advanced_record(), and log_legacy_database_record().

log_advanced_record()

static int log_advanced_record ( struct cdrel_config *  config, void *  data  )

static

Definition at line 174 of file loggers.c.

{
    int ix = 0;
    int res = 0;
    size_t field_count = AST_VECTOR_SIZE(&config->fields);
    RAII_VAR(struct cdrel_values *, values, ast_calloc(1, sizeof(*values)), free_value_vector);
 
    if (!values) {
        return -1;
    }
 
    res = AST_VECTOR_INIT(values, field_count);
    if (res != 0) {
        return -1;
    }
 
    for (ix = 0; ix < AST_VECTOR_SIZE(&config->fields); ix++) {
        struct cdrel_field *field = AST_VECTOR_GET(&config->fields, ix);
        struct cdrel_value input_value = { 0, };
        struct cdrel_value *output_value = ast_calloc(1, sizeof(*output_value));
 
        if (!output_value) {
            return -1;
        }
        output_value->mallocd = 1;
 
        /*
         * Get a field from a CDR structure or CEL event into an cdrel_value.
         */
        res = cdrel_field_getters[config->record_type][field->input_data_type](data, config, field, &input_value);
        if (res != 0) {
            ast_free(output_value);
            return -1;
        }
 
        /*
         * Set the output data type to the type we want to see in the output.
         */
        output_value->data_type = field->output_data_type;
 
        /*
         * Now call the formatter based on the INPUT data type.
         */
        res = cdrel_field_formatters[input_value.data_type](config, field, &input_value, output_value);
        if (res != 0) {
            ast_free(output_value);
            return -1;
        }
 
        res = AST_VECTOR_APPEND(values, output_value);
        if (res != 0) {
            ast_free(output_value);
            return -1;
        }
    }
    return cdrel_backend_writers[config->format_type](config, values);
}

References ast_calloc, ast_free, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, cdrel_backend_writers, cdrel_field_formatters, cdrel_field_getters, config, cdrel_value::data_type, free_value_vector(), cdrel_field::input_data_type, cdrel_value::mallocd, cdrel_field::output_data_type, RAII_VAR, and cdrel_value::values.

log_legacy_database_record()

static int log_legacy_database_record ( struct cdrel_config *  config, void *  data  )

static

Definition at line 111 of file loggers.c.

{
    struct ast_channel *dummy = data;
    int ix = 0;
    int res = 0;
    char subst_buf[2048];
    size_t field_count = AST_VECTOR_SIZE(&config->fields);
    RAII_VAR(struct cdrel_values *, values, ast_calloc(1, sizeof(*values)), free_value_vector);
 
    if (!values) {
        return -1;
    }
 
    res = AST_VECTOR_INIT(values, field_count);
    if (res != 0) {
        return -1;
    }
 
    if (config->db == NULL) {
        return -1;
    }
 
    for (ix = 0; ix < AST_VECTOR_SIZE(&config->fields); ix++) {
        struct cdrel_field *field = AST_VECTOR_GET(&config->fields, ix);
        struct cdrel_value *output_value = ast_calloc(1, sizeof(*output_value));
 
        if (!output_value) {
            return -1;
        }
        output_value->mallocd = 1;
 
        pbx_substitute_variables_helper(dummy, field->data, subst_buf, sizeof(subst_buf) - 1);
        output_value->data_type = cdrel_type_string;
 
        output_value->field_name = field->name;
        output_value->values.string = ast_strdup(ast_strip_quoted(subst_buf,  "'\"", "'\""));
        if (!output_value->values.string) {
            return -1;
        }
 
        res = AST_VECTOR_APPEND(values, output_value);
        if (res != 0) {
            ast_free(output_value);
            return -1;
        }
    }
 
    return write_record_to_database(config, values);
}

References ast_calloc, ast_free, ast_strdup, ast_strip_quoted(), AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_INIT, AST_VECTOR_SIZE, cdrel_type_string, config, ast_channel::data, cdrel_field::data, cdrel_value::data_type, dummy(), cdrel_value::field_name, free_value_vector(), cdrel_value::mallocd, cdrel_field::name, NULL, pbx_substitute_variables_helper(), RAII_VAR, cdrel_value::string, cdrel_value::values, and write_record_to_database().

log_legacy_dsv_record()

static int log_legacy_dsv_record ( struct cdrel_config *  config, void *  data  )

static

Definition at line 82 of file loggers.c.

{
    struct ast_channel *dummy = data;
    struct ast_str *str;
 
    if (!(str = ast_str_thread_get(&custom_buf, 1024))) {
        return -1;
    }
    ast_str_reset(str);
 
    ast_str_substitute_variables(&str, 0, dummy, config->template);
 
    return write_record_to_file(config, str);
}

References ast_str_reset(), ast_str_substitute_variables(), ast_str_thread_get(), config, ast_channel::data, dummy(), str, and write_record_to_file().

Variable Documentation

logger_callbacks

const cdrel_logger_cb logger_callbacks[cdrel_backend_type_end][cdrel_config_type_end]

static

Definition at line 238 of file loggers.c.

                                                                                               {
    [cdrel_backend_text] = {
        [cdrel_config_legacy] = log_legacy_dsv_record,
        [cdrel_config_advanced] = log_advanced_record
    },
    [cdrel_backend_db] = {
        [cdrel_config_legacy] = log_legacy_database_record,
        [cdrel_config_advanced] = log_advanced_record
    },
};

Referenced by cdrel_logger().