Doxygen Updates - Title update
[asterisk/asterisk.git] / cdr / cdr_radius.c
index e79fc01..92ec8a4 100644 (file)
  * at the top of the source tree.
  */
 
-/*! \file
- *
+/*!
+ * \file
  * \brief RADIUS CDR Support
+ *
  * \author Philippe Sultan
- * \extref FreeRadius http://www.freeradius.org/
- * 
+ * The Radius Client Library
+ *     http://developer.berlios.de/projects/radiusclient-ng/
+ *
  * \arg See also \ref AstCDR
  * \ingroup cdr_drivers
  */
 
+/*! \li \ref cdr_radius.c uses the configuration file \ref cdr.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
 /*** MODULEINFO
        <depend>radius</depend>
+       <support_level>extended</support_level>
  ***/
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Rev$")
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
-#include <errno.h>
-#include <unistd.h>
-#include <time.h>
-#include <sys/types.h>
 #include <radiusclient-ng.h>
 
 #include "asterisk/channel.h"
 #include "asterisk/cdr.h"
 #include "asterisk/module.h"
-#include "asterisk/logger.h"
 #include "asterisk/utils.h"
-#include "asterisk/options.h"
 
 /*! ISO 8601 standard format */
 #define DATE_FORMAT "%Y-%m-%d %T %z"
@@ -85,9 +83,9 @@ enum {
        RADIUS_FLAG_LOGUSERFIELD = (1 << 2)
 };
 
-static char *desc = "RADIUS CDR Backend";
-static char *name = "radius";
-static char *cdr_config = "cdr.conf";
+static const char desc[] = "RADIUS CDR Backend";
+static const char name[] = "radius";
+static const char cdr_config[] = "cdr.conf";
 
 static char radiuscfg[PATH_MAX] = "/etc/radiusclient-ng/radiusclient.conf";
 
@@ -95,118 +93,113 @@ static struct ast_flags global_flags = { RADIUS_FLAG_USEGMTIME | RADIUS_FLAG_LOG
 
 static rc_handle *rh = NULL;
 
-static int build_radius_record(VALUE_PAIR **send, struct ast_cdr *cdr)
+static int build_radius_record(VALUE_PAIR **tosend, struct ast_cdr *cdr)
 {
        int recordtype = PW_STATUS_STOP;
-       struct tm tm;
+       struct ast_tm tm;
        char timestr[128];
        char *tmp;
 
-       if (!rc_avpair_add(rh, send, PW_ACCT_STATUS_TYPE, &recordtype, 0, 0))
+       if (!rc_avpair_add(rh, tosend, PW_ACCT_STATUS_TYPE, &recordtype, 0, 0))
                return -1;
 
        /* Account code */
-       if (!rc_avpair_add(rh, send, PW_AST_ACCT_CODE, &cdr->accountcode, strlen(cdr->accountcode), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_ACCT_CODE, &cdr->accountcode, strlen(cdr->accountcode), VENDOR_CODE))
                return -1;
 
        /* Source */
-       if (!rc_avpair_add(rh, send, PW_AST_SRC, &cdr->src, strlen(cdr->src), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_SRC, &cdr->src, strlen(cdr->src), VENDOR_CODE))
                return -1;
 
        /* Destination */
-       if (!rc_avpair_add(rh, send, PW_AST_DST, &cdr->dst, strlen(cdr->dst), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_DST, &cdr->dst, strlen(cdr->dst), VENDOR_CODE))
                return -1;
 
        /* Destination context */
-       if (!rc_avpair_add(rh, send, PW_AST_DST_CTX, &cdr->dcontext, strlen(cdr->dcontext), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_DST_CTX, &cdr->dcontext, strlen(cdr->dcontext), VENDOR_CODE))
                return -1;
 
        /* Caller ID */
-       if (!rc_avpair_add(rh, send, PW_AST_CLID, &cdr->clid, strlen(cdr->clid), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_CLID, &cdr->clid, strlen(cdr->clid), VENDOR_CODE))
                return -1;
 
        /* Channel */
-       if (!rc_avpair_add(rh, send, PW_AST_CHAN, &cdr->channel, strlen(cdr->channel), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_CHAN, &cdr->channel, strlen(cdr->channel), VENDOR_CODE))
                return -1;
 
        /* Destination Channel */
-       if (!rc_avpair_add(rh, send, PW_AST_DST_CHAN, &cdr->dstchannel, strlen(cdr->dstchannel), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_DST_CHAN, &cdr->dstchannel, strlen(cdr->dstchannel), VENDOR_CODE))
                return -1;
 
        /* Last Application */
-       if (!rc_avpair_add(rh, send, PW_AST_LAST_APP, &cdr->lastapp, strlen(cdr->lastapp), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_LAST_APP, &cdr->lastapp, strlen(cdr->lastapp), VENDOR_CODE))
                return -1;
 
        /* Last Data */
-       if (!rc_avpair_add(rh, send, PW_AST_LAST_DATA, &cdr->lastdata, strlen(cdr->lastdata), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_LAST_DATA, &cdr->lastdata, strlen(cdr->lastdata), VENDOR_CODE))
                return -1;
 
 
        /* Start Time */
-       if (ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME))
-               gmtime_r(&(cdr->start.tv_sec), &tm);
-       else
-               localtime_r(&(cdr->start.tv_sec), &tm);
-       strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
-       if (!rc_avpair_add(rh, send, PW_AST_START_TIME, timestr, strlen(timestr), VENDOR_CODE))
+       ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
+               ast_localtime(&cdr->start, &tm,
+                       ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
+       if (!rc_avpair_add(rh, tosend, PW_AST_START_TIME, timestr, strlen(timestr), VENDOR_CODE))
                return -1;
 
        /* Answer Time */
-       if (ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME))
-               gmtime_r(&(cdr->answer.tv_sec), &tm);
-       else
-               localtime_r(&(cdr->answer.tv_sec), &tm);
-       strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
-       if (!rc_avpair_add(rh, send, PW_AST_ANSWER_TIME, timestr, strlen(timestr), VENDOR_CODE))
+       ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
+               ast_localtime(&cdr->answer, &tm,
+                       ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
+       if (!rc_avpair_add(rh, tosend, PW_AST_ANSWER_TIME, timestr, strlen(timestr), VENDOR_CODE))
                return -1;
 
        /* End Time */
-       if (ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME))
-               gmtime_r(&(cdr->end.tv_sec), &tm);
-       else
-               localtime_r(&(cdr->end.tv_sec), &tm);
-       strftime(timestr, sizeof(timestr), DATE_FORMAT, &tm);
-       if (!rc_avpair_add(rh, send, PW_AST_END_TIME, timestr, strlen(timestr), VENDOR_CODE))
+       ast_strftime(timestr, sizeof(timestr), DATE_FORMAT,
+               ast_localtime(&cdr->end, &tm,
+                       ast_test_flag(&global_flags, RADIUS_FLAG_USEGMTIME) ? "GMT" : NULL));
+       if (!rc_avpair_add(rh, tosend, PW_AST_END_TIME, timestr, strlen(timestr), VENDOR_CODE))
                return -1;
 
-       /* Duration */ 
-       if (!rc_avpair_add(rh, send, PW_AST_DURATION, &cdr->duration, 0, VENDOR_CODE))
+       /* Duration */
+       if (!rc_avpair_add(rh, tosend, PW_AST_DURATION, &cdr->duration, 0, VENDOR_CODE))
                return -1;
 
        /* Billable seconds */
-       if (!rc_avpair_add(rh, send, PW_AST_BILL_SEC, &cdr->billsec, 0, VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_BILL_SEC, &cdr->billsec, 0, VENDOR_CODE))
                return -1;
 
        /* Disposition */
        tmp = ast_cdr_disp2str(cdr->disposition);
-       if (!rc_avpair_add(rh, send, PW_AST_DISPOSITION, tmp, strlen(tmp), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_DISPOSITION, tmp, strlen(tmp), VENDOR_CODE))
                return -1;
 
        /* AMA Flags */
        tmp = ast_cdr_flags2str(cdr->amaflags);
-       if (!rc_avpair_add(rh, send, PW_AST_AMA_FLAGS, tmp, strlen(tmp), VENDOR_CODE))
+       if (!rc_avpair_add(rh, tosend, PW_AST_AMA_FLAGS, tmp, strlen(tmp), VENDOR_CODE))
                return -1;
 
        if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUNIQUEID)) {
                /* Unique ID */
-               if (!rc_avpair_add(rh, send, PW_AST_UNIQUE_ID, &cdr->uniqueid, strlen(cdr->uniqueid), VENDOR_CODE))
+               if (!rc_avpair_add(rh, tosend, PW_AST_UNIQUE_ID, &cdr->uniqueid, strlen(cdr->uniqueid), VENDOR_CODE))
                        return -1;
        }
 
        if (ast_test_flag(&global_flags, RADIUS_FLAG_LOGUSERFIELD)) {
                /* append the user field */
-               if (!rc_avpair_add(rh, send, PW_AST_USER_FIELD, &cdr->userfield, strlen(cdr->userfield), VENDOR_CODE))
+               if (!rc_avpair_add(rh, tosend, PW_AST_USER_FIELD, &cdr->userfield, strlen(cdr->userfield), VENDOR_CODE))
                        return -1;
        }
 
        /* Setting Acct-Session-Id & User-Name attributes for proper generation
-          of Acct-Unique-Session-Id on server side */ 
+        * of Acct-Unique-Session-Id on server side 
+        */
        /* Channel */
-       if (!rc_avpair_add(rh, send, PW_USER_NAME, &cdr->channel, strlen(cdr->channel), 0))
+       if (!rc_avpair_add(rh, tosend, PW_USER_NAME, &cdr->channel, strlen(cdr->channel), 0))
                return -1;
 
        /* Unique ID */
-       if (!rc_avpair_add(rh, send, PW_ACCT_SESSION_ID, &cdr->uniqueid, strlen(cdr->uniqueid), 0))
+       if (!rc_avpair_add(rh, tosend, PW_ACCT_SESSION_ID, &cdr->uniqueid, strlen(cdr->uniqueid), 0))
                return -1;
 
        return 0;
@@ -215,17 +208,22 @@ static int build_radius_record(VALUE_PAIR **send, struct ast_cdr *cdr)
 static int radius_log(struct ast_cdr *cdr)
 {
        int result = ERROR_RC;
-       VALUE_PAIR *send = NULL;
+       VALUE_PAIR *tosend = NULL;
 
-       if (build_radius_record(&send, cdr)) {
-               if (option_debug)
-                       ast_log(LOG_DEBUG, "Unable to create RADIUS record. CDR not recorded!\n");
-               return result;
+       if (build_radius_record(&tosend, cdr)) {
+               ast_debug(1, "Unable to create RADIUS record. CDR not recorded!\n");
+               goto return_cleanup;
        }
-       
-       result = rc_acct(rh, 0, send);
-       if (result != OK_RC)
+
+       result = rc_acct(rh, 0, tosend);
+       if (result != OK_RC) {
                ast_log(LOG_ERROR, "Failed to record Radius CDR record!\n");
+       }
+
+return_cleanup:
+       if (tosend) {
+               rc_avpair_free(tosend);
+       }
 
        return result;
 }
@@ -233,40 +231,66 @@ static int radius_log(struct ast_cdr *cdr)
 static int unload_module(void)
 {
        ast_cdr_unregister(name);
+       if (rh) {
+               rc_destroy(rh);
+               rh = NULL;
+       }
        return 0;
 }
 
 static int load_module(void)
 {
        struct ast_config *cfg;
+       struct ast_flags config_flags = { 0 };
        const char *tmp;
 
-       if ((cfg = ast_config_load(cdr_config))) {
+       if ((cfg = ast_config_load(cdr_config, config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
                ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "usegmtime")), RADIUS_FLAG_USEGMTIME);
                ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguniqueid")), RADIUS_FLAG_LOGUNIQUEID);
                ast_set2_flag(&global_flags, ast_true(ast_variable_retrieve(cfg, "radius", "loguserfield")), RADIUS_FLAG_LOGUSERFIELD);
                if ((tmp = ast_variable_retrieve(cfg, "radius", "radiuscfg")))
                        ast_copy_string(radiuscfg, tmp, sizeof(radiuscfg));
                ast_config_destroy(cfg);
-       } else 
+       } else
                return AST_MODULE_LOAD_DECLINE;
-       
-       /* start logging */
-       rc_openlog("asterisk");
+
+       /*
+        * start logging
+        *
+        * NOTE: Yes this causes a slight memory leak if the module is
+        * unloaded.  However, it is better than a crash if cdr_radius
+        * and cel_radius are both loaded.
+        */
+       tmp = ast_strdup("asterisk");
+       if (tmp) {
+               rc_openlog((char *) tmp);
+       }
 
        /* read radiusclient-ng config file */
        if (!(rh = rc_read_config(radiuscfg))) {
                ast_log(LOG_NOTICE, "Cannot load radiusclient-ng configuration file %s.\n", radiuscfg);
-               return -1;
+               return AST_MODULE_LOAD_DECLINE;
        }
 
        /* read radiusclient-ng dictionaries */
        if (rc_read_dictionary(rh, rc_conf_str(rh, "dictionary"))) {
                ast_log(LOG_NOTICE, "Cannot load radiusclient-ng dictionary file.\n");
-               return -1;
+               rc_destroy(rh);
+               rh = NULL;
+               return AST_MODULE_LOAD_DECLINE;
+       }
+
+       if (ast_cdr_register(name, desc, radius_log)) {
+               rc_destroy(rh);
+               rh = NULL;
+               return AST_MODULE_LOAD_DECLINE;
+       } else {
+               return AST_MODULE_LOAD_SUCCESS;
        }
-       
-       return ast_cdr_register(name, desc, radius_log);
 }
 
-AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "RADIUS CDR Backend");
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "RADIUS CDR Backend",
+               .load = load_module,
+               .unload = unload_module,
+               .load_pri = AST_MODPRI_CDR_DRIVER,
+       );