cdr_beanstalkd.c File Reference

Asterisk Beanstalkd CDR records. More...

#include "asterisk.h"
#include <time.h>
#include <stdio.h>
#include "beanstalk.h"
#include "asterisk/channel.h"
#include "asterisk/cdr.h"
#include "asterisk/module.h"
#include "asterisk/utils.h"
#include "asterisk/manager.h"
#include "asterisk/config.h"
#include "asterisk/pbx.h"
#include "asterisk/json.h"

Include dependency graph for cdr_beanstalkd.c:

Go to the source code of this file.

Macros
#define	BEANSTALK_JOB_DELAY   0
#define	BEANSTALK_JOB_PRIORITY   99
#define	BEANSTALK_JOB_SIZE   4096
#define	BEANSTALK_JOB_TTR   60
#define	CONF_FILE   "cdr_beanstalkd.conf"
#define	DATE_FORMAT   "%Y-%m-%d %T"
#define	DEFAULT_BEANSTALK_HOST   "127.0.0.1"
#define	DEFAULT_BEANSTALK_PORT   11300
#define	DEFAULT_BEANSTALK_TUBE   "asterisk-cdr"

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	beanstalk_put (struct ast_cdr *cdr)
static int	load_config (int reload)
static int	load_module (void)
static int	reload (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk Beanstalkd CDR Backend" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }
static const struct ast_module_info *	ast_module_info = &__mod_info
static char *	bs_host
static int	bs_port
static char *	bs_tube
static ast_rwlock_t	config_lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} }
static int	enablecdr = 0
static const char	name [] = "cdr_beanstalkd"
static int	priority

Detailed Description

Asterisk Beanstalkd CDR records.

This module requires the beanstalk-client library, avaialble from https://github.com/deepfryed/beanstalk-client

See also

• CDR - Call Data Records and billing

Definition in file cdr_beanstalkd.c.

Macro Definition Documentation

BEANSTALK_JOB_DELAY

#define BEANSTALK_JOB_DELAY   0

Definition at line 65 of file cdr_beanstalkd.c.

BEANSTALK_JOB_PRIORITY

#define BEANSTALK_JOB_PRIORITY   99

Definition at line 63 of file cdr_beanstalkd.c.

BEANSTALK_JOB_SIZE

#define BEANSTALK_JOB_SIZE   4096

Definition at line 62 of file cdr_beanstalkd.c.

BEANSTALK_JOB_TTR

#define BEANSTALK_JOB_TTR   60

Definition at line 64 of file cdr_beanstalkd.c.

CONF_FILE

#define CONF_FILE   "cdr_beanstalkd.conf"

Definition at line 61 of file cdr_beanstalkd.c.

DATE_FORMAT

#define DATE_FORMAT   "%Y-%m-%d %T"

Definition at line 60 of file cdr_beanstalkd.c.

DEFAULT_BEANSTALK_HOST

#define DEFAULT_BEANSTALK_HOST   "127.0.0.1"

Definition at line 66 of file cdr_beanstalkd.c.

DEFAULT_BEANSTALK_PORT

#define DEFAULT_BEANSTALK_PORT   11300

Definition at line 67 of file cdr_beanstalkd.c.

DEFAULT_BEANSTALK_TUBE

#define DEFAULT_BEANSTALK_TUBE   "asterisk-cdr"

Definition at line 68 of file cdr_beanstalkd.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 270 of file cdr_beanstalkd.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 270 of file cdr_beanstalkd.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 270 of file cdr_beanstalkd.c.

beanstalk_put()

static int beanstalk_put ( struct ast_cdr *  cdr )

static

Definition at line 162 of file cdr_beanstalkd.c.

                                              {
    struct ast_tm timeresult;
    char strAnswerTime[80] = "";
    char strStartTime[80];
    char strEndTime[80];
    char *cdr_buffer;
    int bs_id;
    int bs_socket;
    struct ast_json *t_cdr_json;
 
    if (!enablecdr) {
        return 0;
    }
 
    ast_rwlock_rdlock(&config_lock);
    bs_socket = bs_connect(bs_host, bs_port);
 
    if (bs_use(bs_socket, bs_tube) != BS_STATUS_OK) {
        ast_log(LOG_ERROR, "Connection to Beanstalk tube %s @ %s:%d had failed", bs_tube, bs_host, bs_port);
        ast_rwlock_unlock(&config_lock);
        return 0;
    }
 
    ast_localtime(&cdr->start, &timeresult, NULL);
    ast_strftime(strStartTime, sizeof(strStartTime), DATE_FORMAT, &timeresult);
 
    if (cdr->answer.tv_sec) {
        ast_localtime(&cdr->answer, &timeresult, NULL);
        ast_strftime(strAnswerTime, sizeof(strAnswerTime), DATE_FORMAT, &timeresult);
    }
 
    ast_localtime(&cdr->end, &timeresult, NULL);
    ast_strftime(strEndTime, sizeof(strEndTime), DATE_FORMAT, &timeresult);
 
    ast_rwlock_unlock(&config_lock);
 
    t_cdr_json = ast_json_pack("{s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:s, s:i, s:i, s:s, s:s, s:s, s:s}",
                               "AccountCode", S_OR(cdr->accountcode, ""),
                               "Source", S_OR(cdr->src, ""),
                               "Destination", S_OR(cdr->dst, ""),
                               "DestinationContext", S_OR(cdr->dcontext, ""),
                               "CallerID", S_OR(cdr->clid, ""),
                               "Channel", S_OR(cdr->channel, ""),
                               "DestinationChannel", S_OR(cdr->dstchannel, ""),
                               "LastApplication", S_OR(cdr->lastapp, ""),
                               "LastData", S_OR(cdr->lastdata, ""),
                               "StartTime", S_OR(strStartTime, ""),
                               "AnswerTime", S_OR(strAnswerTime, ""),
                               "EndTime", S_OR(strEndTime, ""),
                               "Duration", cdr->duration,
                               "Billsec", cdr->billsec,
                               "Disposition", S_OR(ast_cdr_disp2str(cdr->disposition), ""),
                               "AMAFlags", S_OR(ast_channel_amaflags2string(cdr->amaflags), ""),
                               "UniqueID", S_OR(cdr->uniqueid, ""),
                               "UserField", S_OR(cdr->userfield, ""));
 
    cdr_buffer = ast_json_dump_string(t_cdr_json);
 
    ast_json_unref(t_cdr_json);
 
    bs_id = bs_put(bs_socket, priority, BEANSTALK_JOB_DELAY, BEANSTALK_JOB_TTR, cdr_buffer, strlen(cdr_buffer));
 
    if (bs_id > 0) {
        ast_log(LOG_DEBUG, "Successfully created job %d with %s\n", bs_id, cdr_buffer);
    } else {
        ast_log(LOG_ERROR, "CDR job creation failed for %s\n", cdr_buffer);
    }
 
    bs_disconnect(bs_socket);
    ast_json_free(cdr_buffer);
    return 0;
}

References ast_cdr::accountcode, ast_cdr::amaflags, ast_cdr::answer, ast_cdr_disp2str(), ast_channel_amaflags2string(), ast_json_dump_string, ast_json_free(), ast_json_pack(), ast_json_unref(), ast_localtime(), ast_log, ast_rwlock_rdlock, ast_rwlock_unlock, ast_strftime(), BEANSTALK_JOB_DELAY, BEANSTALK_JOB_TTR, ast_cdr::billsec, bs_host, bs_port, bs_tube, ast_cdr::channel, ast_cdr::clid, config_lock, DATE_FORMAT, ast_cdr::dcontext, ast_cdr::disposition, ast_cdr::dst, ast_cdr::dstchannel, ast_cdr::duration, enablecdr, ast_cdr::end, ast_cdr::lastapp, ast_cdr::lastdata, LOG_DEBUG, LOG_ERROR, NULL, priority, S_OR, ast_cdr::src, ast_cdr::start, ast_cdr::uniqueid, and ast_cdr::userfield.

Referenced by load_module().

load_config()

static int load_config ( int  reload )

static

Definition at line 82 of file cdr_beanstalkd.c.

                                   {
    char *cat = NULL;
    struct ast_config *cfg;
    struct ast_variable *v;
    struct ast_flags config_flags = {reload ? CONFIG_FLAG_FILEUNCHANGED : 0};
    int newenablecdr = 0;
 
    cfg = ast_config_load(CONF_FILE, config_flags);
    if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
        return 0;
    }
 
    if (cfg == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_ERROR, "Config file '%s' could not be parsed\n", CONF_FILE);
        return -1;
    }
 
    if (!cfg) {
        /* Standard configuration */
        ast_log(LOG_WARNING, "Failed to load configuration file. Module not activated.\n");
        if (enablecdr) {
            ast_cdr_backend_suspend(name);
        }
        enablecdr = 0;
        return -1;
    }
 
    if (reload) {
        ast_rwlock_wrlock(&config_lock);
        ast_free(bs_host);
        ast_free(bs_tube);
    }
 
    /* Bootstrap the default configuration */
    bs_host = ast_strdup(DEFAULT_BEANSTALK_HOST);
    bs_port = DEFAULT_BEANSTALK_PORT;
    bs_tube = ast_strdup(DEFAULT_BEANSTALK_TUBE);
    priority = BEANSTALK_JOB_PRIORITY;
 
    while ((cat = ast_category_browse(cfg, cat))) {
        if (!strcasecmp(cat, "general")) {
            v = ast_variable_browse(cfg, cat);
            while (v) {
 
                if (!strcasecmp(v->name, "enabled")) {
                    newenablecdr = ast_true(v->value);
                } else if (!strcasecmp(v->name, "host")) {
                    ast_free(bs_host);
                    bs_host = ast_strdup(v->value);
                } else if (!strcasecmp(v->name, "port")) {
                    bs_port = atoi(v->value);
                } else if (!strcasecmp(v->name, "tube")) {
                    ast_free(bs_tube);
                    bs_tube = ast_strdup(v->value);
                } else if (!strcasecmp(v->name, "priority")) {
                    priority = atoi(v->value);
                }
                v = v->next;
 
            }
        }
    }
 
    if (reload) {
        ast_rwlock_unlock(&config_lock);
    }
 
    ast_config_destroy(cfg);
 
    if (!newenablecdr) {
        ast_cdr_backend_suspend(name);
    } else if (newenablecdr) {
        ast_cdr_backend_unsuspend(name);
        ast_log(LOG_NOTICE, "Added beanstalkd server %s at port %d with tube %s", bs_host, bs_port, bs_tube);
    }
    enablecdr = newenablecdr;
 
    return 0;
}

References ast_category_browse(), ast_cdr_backend_suspend(), ast_cdr_backend_unsuspend(), ast_config_destroy(), ast_config_load, ast_free, ast_log, ast_rwlock_unlock, ast_rwlock_wrlock, ast_strdup, ast_true(), ast_variable_browse(), BEANSTALK_JOB_PRIORITY, bs_host, bs_port, bs_tube, CONF_FILE, CONFIG_FLAG_FILEUNCHANGED, config_lock, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, DEFAULT_BEANSTALK_HOST, DEFAULT_BEANSTALK_PORT, DEFAULT_BEANSTALK_TUBE, enablecdr, LOG_ERROR, LOG_NOTICE, LOG_WARNING, name, ast_variable::name, ast_variable::next, NULL, priority, reload(), and ast_variable::value.

Referenced by load_module(), and reload().

load_module()

static int load_module ( void  )

static

Definition at line 246 of file cdr_beanstalkd.c.

                             {
    if (ast_cdr_register(name, "Asterisk CDR Beanstalkd Backend", beanstalk_put)) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (load_config(0)) {
        ast_cdr_unregister(name);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    return AST_MODULE_LOAD_SUCCESS;
}

References ast_cdr_register(), ast_cdr_unregister(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, beanstalk_put(), load_config(), and name.

reload()

static int reload ( void  )

static

Definition at line 259 of file cdr_beanstalkd.c.

                        {
    return load_config(1);
}

References load_config().

Referenced by load_config().

unload_module()

static int unload_module ( void  )

static

Definition at line 235 of file cdr_beanstalkd.c.

                               {
    if (ast_cdr_unregister(name)) {
        return -1;
    }
 
    ast_free(bs_host);
    ast_free(bs_tube);
 
    return 0;
}

References ast_cdr_unregister(), ast_free, bs_host, bs_tube, and name.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk Beanstalkd CDR Backend" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_EXTENDED, .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CDR_DRIVER, .requires = "cdr", }

static

Definition at line 270 of file cdr_beanstalkd.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 270 of file cdr_beanstalkd.c.

bs_host

char* bs_host

static

Definition at line 73 of file cdr_beanstalkd.c.

Referenced by beanstalk_put(), load_config(), and unload_module().

bs_port

int bs_port

static

Definition at line 74 of file cdr_beanstalkd.c.

Referenced by beanstalk_put(), and load_config().

bs_tube

char* bs_tube

static

Definition at line 75 of file cdr_beanstalkd.c.

Referenced by beanstalk_put(), load_config(), and unload_module().

config_lock

ast_rwlock_t config_lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} }

static

Definition at line 78 of file cdr_beanstalkd.c.

Referenced by beanstalk_put(), and load_config().

enablecdr

int enablecdr = 0

static

Definition at line 72 of file cdr_beanstalkd.c.

Referenced by beanstalk_put(), and load_config().

name

const char name[] = "cdr_beanstalkd"

static

Definition at line 70 of file cdr_beanstalkd.c.

Referenced by load_config(), load_module(), and unload_module().

priority

int priority

static

Definition at line 76 of file cdr_beanstalkd.c.

Referenced by __after_bridge_set_goto(), __ast_goto_if_exists(), acf_isexten_exec(), action_dialplan_exec(), action_originate(), action_redirect(), add_action_to_menu_entry(), add_extension(), ast_add_extension(), ast_add_extension2(), ast_add_extension2_lockopt(), ast_add_extension2_nolock(), ast_add_extension_nolock(), ast_async_goto(), ast_async_goto_by_name(), ast_async_goto_if_exists(), ast_bridge_set_after_go_on(), ast_bridge_set_after_goto(), ast_bridge_setup_after_goto(), ast_canmatch_extension(), ast_compile_ael2(), ast_context_remove_extension(), ast_context_remove_extension2(), ast_context_remove_extension_callerid(), ast_context_remove_extension_callerid2(), ast_exists_extension(), ast_explicit_goto(), ast_get_extension_data(), ast_goto_if_exists(), ast_json_dialplan_cep(), ast_json_dialplan_cep_app(), ast_matchmore_extension(), ast_pbx_outgoing_exten(), ast_pbx_outgoing_exten_predial(), ast_realtime_append_mapping(), ast_spawn_extension(), ast_srv_get_nth_record(), ast_syslog_priority(), ast_syslog_priority_name(), AST_TEST_DEFINE(), ast_walk_extension_priorities(), beanstalk_put(), bridge_exec(), canmatch(), change_priority_caller_on_queue(), complete_dialplan_remove_extension(), copy_plain_file(), dns_srv_alloc(), dns_srv_sort(), dundi_canmatch(), dundi_exec(), dundi_exists(), dundi_helper(), dundi_matchmore(), exec(), exists(), find_engine(), find_matching_priority(), generate_srv_record(), gosub_allocate_frame(), handle_gosub(), handle_queue_change_priority_caller(), iax2_canmatch(), iax2_exec(), iax2_exists(), iax2_matchmore(), isexten_function_read(), jingle_interpret_ice_udp_transport(), leave_voicemail(), load_config(), load_module(), localized_add_extension2(), localized_find_extension(), localized_walk_extension_priorities(), loopback_parse(), loopback_subst(), lua_find_extension(), lua_pbx_exec(), lua_update_registry(), manager_change_priority_caller_on_queue(), manager_dialplan_extension_add(), manager_dialplan_extension_remove(), matchmore(), originate_exec(), parking_add_extension(), parse_srv(), pbx_extension_helper(), pbx_find_extension(), pbx_outgoing_attempt(), pidf_generate_body_content(), raise_exception(), realtime_canmatch(), realtime_common(), realtime_exec(), realtime_exists(), realtime_matchmore(), realtime_switch_common(), setup_peer_after_bridge_goto(), srv_result_read(), stasis_app_control_continue(), and xmpp_client_set_presence().