cdr/cdr_manager.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 2004 - 2005
   5  *
   6  * See http://www.asterisk.org for more information about
   7  * the Asterisk project. Please do not directly contact
   8  * any of the maintainers of this project for assistance;
   9  * the project provides a web site, mailing lists and IRC
  10  * channels for your use.
  11  *
  12  * This program is free software, distributed under the terms of
  13  * the GNU General Public License Version 2. See the LICENSE file
  14  * at the top of the source tree.
  15  */
  16
  17 /*! \file
  18  *
  19  * \brief Asterisk Call Manager CDR records.
  20  *
  21  * See also
  22  * \arg \ref AstCDR
  23  * \arg \ref AstAMI
  24  * \arg \ref Config_ami
  25  * \ingroup cdr_drivers
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include <time.h>
  33
  34 #include "asterisk/channel.h"
  35 #include "asterisk/cdr.h"
  36 #include "asterisk/module.h"
  37 #include "asterisk/utils.h"
  38 #include "asterisk/manager.h"
  39 #include "asterisk/config.h"
  40 #include "asterisk/pbx.h"
  41
  42 #define DATE_FORMAT     "%Y-%m-%d %T"
  43 #define CONF_FILE       "cdr_manager.conf"
  44 #define CUSTOM_FIELDS_BUF_SIZE 1024
  45
  46 static char *name = "cdr_manager";
  47
  48 static int enablecdr = 0;
  49
  50 /*!
  51  * XXX
  52  * \bug The handling of this variable is not thread-safe.  Crashes are possible on reload.
  53  */
  54 static struct ast_str *customfields;
  55
  56 static int manager_log(struct ast_cdr *cdr);
  57
  58 static int load_config(int reload)
  59 {
  60         char *cat = NULL;
  61         struct ast_config *cfg;
  62         struct ast_variable *v;
  63         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
  64         int newenablecdr = 0;
  65
  66         cfg = ast_config_load(CONF_FILE, config_flags);
  67         if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
  68                 return 0;
  69         }
  70
  71         if (cfg == CONFIG_STATUS_FILEINVALID) {
  72                 ast_log(LOG_ERROR, "Config file '%s' could not be parsed\n", CONF_FILE);
  73                 return -1;
  74         }
  75
  76         if (reload && customfields) {
  77                 ast_free(customfields);
  78         }
  79         customfields = NULL;
  80
  81         if (!cfg) {
  82                 /* Standard configuration */
  83                 ast_log(LOG_WARNING, "Failed to load configuration file. Module not activated.\n");
  84                 if (enablecdr)
  85                         ast_cdr_unregister(name);
  86                 enablecdr = 0;
  87                 return -1;
  88         }
  89
  90         while ( (cat = ast_category_browse(cfg, cat)) ) {
  91                 if (!strcasecmp(cat, "general")) {
  92                         v = ast_variable_browse(cfg, cat);
  93                         while (v) {
  94                                 if (!strcasecmp(v->name, "enabled"))
  95                                         newenablecdr = ast_true(v->value);
  96
  97                                 v = v->next;
  98                         }
  99                 } else if (!strcasecmp(cat, "mappings")) {
 100                         customfields = ast_str_create(CUSTOM_FIELDS_BUF_SIZE);
 101                         v = ast_variable_browse(cfg, cat);
 102                         while (v) {
 103                                 if (customfields && !ast_strlen_zero(v->name) && !ast_strlen_zero(v->value)) {
 104                                         if ((ast_str_strlen(customfields) + strlen(v->value) + strlen(v->name) + 14) < ast_str_size(customfields)) {
 105                                                 ast_str_append(&customfields, -1, "%s: ${CDR(%s)}\r\n", v->value, v->name);
 106                                                 ast_log(LOG_NOTICE, "Added mapping %s: ${CDR(%s)}\n", v->value, v->name);
 107                                         } else {
 108                                                 ast_log(LOG_WARNING, "No more buffer space to add other custom fields\n");
 109                                                 break;
 110                                         }
 111
 112                                 }
 113                                 v = v->next;
 114                         }
 115                 }
 116         }
 117
 118         ast_config_destroy(cfg);
 119
 120         if (enablecdr && !newenablecdr)
 121                 ast_cdr_unregister(name);
 122         else if (!enablecdr && newenablecdr)
 123                 ast_cdr_register(name, "Asterisk Manager Interface CDR Backend", manager_log);
 124         enablecdr = newenablecdr;
 125
 126         return 0;
 127 }
 128
 129 static int manager_log(struct ast_cdr *cdr)
 130 {
 131         struct ast_tm timeresult;
 132         char strStartTime[80] = "";
 133         char strAnswerTime[80] = "";
 134         char strEndTime[80] = "";
 135         char buf[CUSTOM_FIELDS_BUF_SIZE];
 136
 137         if (!enablecdr)
 138                 return 0;
 139
 140         ast_localtime(&cdr->start, &timeresult, NULL);
 141         ast_strftime(strStartTime, sizeof(strStartTime), DATE_FORMAT, &timeresult);
 142
 143         if (cdr->answer.tv_sec) {
 144                 ast_localtime(&cdr->answer, &timeresult, NULL);
 145                 ast_strftime(strAnswerTime, sizeof(strAnswerTime), DATE_FORMAT, &timeresult);
 146         }
 147
 148         ast_localtime(&cdr->end, &timeresult, NULL);
 149         ast_strftime(strEndTime, sizeof(strEndTime), DATE_FORMAT, &timeresult);
 150
 151         buf[0] = 0;
 152         /* Custom fields handling */
 153         if (customfields != NULL && ast_str_strlen(customfields)) {
 154                 struct ast_channel *dummy = ast_channel_alloc(0, 0, "", "", "", "", "", 0, "Substitution/%p", cdr);
 155                 if (!dummy) {
 156                         ast_log(LOG_ERROR, "Unable to allocate channel for variable substitution.\n");
 157                         return 0;
 158                 }
 159                 dummy->cdr = ast_cdr_dup(cdr);
 160                 pbx_substitute_variables_helper(dummy, ast_str_buffer(customfields), buf, sizeof(buf) - 1);
 161                 ast_channel_release(dummy);
 162         }
 163
 164         manager_event(EVENT_FLAG_CDR, "Cdr",
 165             "AccountCode: %s\r\n"
 166             "Source: %s\r\n"
 167             "Destination: %s\r\n"
 168             "DestinationContext: %s\r\n"
 169             "CallerID: %s\r\n"
 170             "Channel: %s\r\n"
 171             "DestinationChannel: %s\r\n"
 172             "LastApplication: %s\r\n"
 173             "LastData: %s\r\n"
 174             "StartTime: %s\r\n"
 175             "AnswerTime: %s\r\n"
 176             "EndTime: %s\r\n"
 177             "Duration: %ld\r\n"
 178             "BillableSeconds: %ld\r\n"
 179             "Disposition: %s\r\n"
 180             "AMAFlags: %s\r\n"
 181             "UniqueID: %s\r\n"
 182             "UserField: %s\r\n"
 183             "%s",
 184             cdr->accountcode, cdr->src, cdr->dst, cdr->dcontext, cdr->clid, cdr->channel,
 185             cdr->dstchannel, cdr->lastapp, cdr->lastdata, strStartTime, strAnswerTime, strEndTime,
 186             cdr->duration, cdr->billsec, ast_cdr_disp2str(cdr->disposition),
 187             ast_cdr_flags2str(cdr->amaflags), cdr->uniqueid, cdr->userfield,buf);
 188
 189         return 0;
 190 }
 191
 192 static int unload_module(void)
 193 {
 194         ast_cdr_unregister(name);
 195         if (customfields)
 196                 ast_free(customfields);
 197
 198         return 0;
 199 }
 200
 201 static int load_module(void)
 202 {
 203         if (load_config(0)) {
 204                 return AST_MODULE_LOAD_DECLINE;
 205         }
 206
 207         return AST_MODULE_LOAD_SUCCESS;
 208 }
 209
 210 static int reload(void)
 211 {
 212         return load_config(1);
 213 }
 214
 215 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Asterisk Manager Interface CDR Backend",
 216                 .load = load_module,
 217                 .unload = unload_module,
 218                 .reload = reload,
 219                );