create string only if it's needed
[freeradius.git] / src / modules / rlm_sqlcounter / rlm_sqlcounter.c
index 20cabb3..8d43e73 100644 (file)
@@ -1,7 +1,8 @@
 /*
  *   This program is is free software; you can redistribute it and/or modify
- *   it under the terms of the GNU General Public License, version 2 if the
- *   License as published by the Free Software Foundation.
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 2 of the License, or (at
+ *   your option) any later version.
  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -29,7 +30,7 @@ RCSID("$Id$")
 
 #include <ctype.h>
 
-#define MAX_QUERY_LEN 1024
+#define MAX_QUERY_LEN 2048
 
 /*
  *     Note: When your counter spans more than 1 period (ie 3 months
@@ -88,7 +89,7 @@ static const CONF_PARSER module_config[] = {
        { "sql_module_instance", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_REQUIRED, rlm_sqlcounter_t, sqlmod_inst), NULL },
 
        { "key", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_ATTRIBUTE, rlm_sqlcounter_t, key_name), NULL },
-       { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_REQUIRED, rlm_sqlcounter_t, query), NULL },
+       { "query", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_XLAT | PW_TYPE_REQUIRED, rlm_sqlcounter_t, query), NULL },
        { "reset", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_REQUIRED, rlm_sqlcounter_t, reset), NULL },
 
        { "counter-name", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sqlcounter_t, counter_name), NULL },
@@ -99,11 +100,10 @@ static const CONF_PARSER module_config[] = {
 
        { "reply-name", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_DEPRECATED, rlm_sqlcounter_t, reply_name), NULL },
        { "reply_name", FR_CONF_OFFSET(PW_TYPE_STRING | PW_TYPE_ATTRIBUTE, rlm_sqlcounter_t, reply_name), "Session-Timeout" },
-
-       { NULL, -1, 0, NULL, NULL }
+       CONF_PARSER_TERMINATOR
 };
 
-static int find_next_reset(rlm_sqlcounter_t *inst, time_t timeval)
+static int find_next_reset(rlm_sqlcounter_t *inst, REQUEST *request, time_t timeval)
 {
        int ret = 0;
        size_t len;
@@ -113,28 +113,33 @@ static int find_next_reset(rlm_sqlcounter_t *inst, time_t timeval)
        char sCurrentTime[40], sNextTime[40];
 
        tm = localtime_r(&timeval, &s_tm);
-       len = strftime(sCurrentTime, sizeof(sCurrentTime), "%Y-%m-%d %H:%M:%S", tm);
-       if (len == 0) *sCurrentTime = '\0';
        tm->tm_sec = tm->tm_min = 0;
 
        rad_assert(inst->reset != NULL);
 
+       /*
+        *      Reset every N hours, days, weeks, months.
+        */
        if (isdigit((int) inst->reset[0])){
                len = strlen(inst->reset);
-               if (len == 0)
-                       return -1;
+               if (len == 0) return -1;
+
                last = inst->reset[len - 1];
-               if (!isalpha((int) last))
+               if (!isalpha((int) last)) {
                        last = 'd';
+               }
+
                num = atoi(inst->reset);
                DEBUG("rlm_sqlcounter: num=%d, last=%c",num,last);
        }
+
        if (strcmp(inst->reset, "hourly") == 0 || last == 'h') {
                /*
                 *  Round up to the next nearest hour.
                 */
                tm->tm_hour += num;
                inst->reset_time = mktime(tm);
+
        } else if (strcmp(inst->reset, "daily") == 0 || last == 'd') {
                /*
                 *  Round up to the next nearest day.
@@ -142,6 +147,7 @@ static int find_next_reset(rlm_sqlcounter_t *inst, time_t timeval)
                tm->tm_hour = 0;
                tm->tm_mday += num;
                inst->reset_time = mktime(tm);
+
        } else if (strcmp(inst->reset, "weekly") == 0 || last == 'w') {
                /*
                 *  Round up to the next nearest week.
@@ -149,21 +155,29 @@ static int find_next_reset(rlm_sqlcounter_t *inst, time_t timeval)
                tm->tm_hour = 0;
                tm->tm_mday += (7 - tm->tm_wday) +(7*(num-1));
                inst->reset_time = mktime(tm);
+
        } else if (strcmp(inst->reset, "monthly") == 0 || last == 'm') {
                tm->tm_hour = 0;
                tm->tm_mday = 1;
                tm->tm_mon += num;
                inst->reset_time = mktime(tm);
+
        } else if (strcmp(inst->reset, "never") == 0) {
                inst->reset_time = 0;
+
        } else {
                return -1;
        }
 
+       if (!request || (rad_debug_lvl < 2)) return ret;
+
+       len = strftime(sCurrentTime, sizeof(sCurrentTime), "%Y-%m-%d %H:%M:%S", tm);
+       if (len == 0) *sCurrentTime = '\0';
+
        len = strftime(sNextTime, sizeof(sNextTime),"%Y-%m-%d %H:%M:%S",tm);
        if (len == 0) *sNextTime = '\0';
-       DEBUG2("rlm_sqlcounter: Current Time: %" PRId64 " [%s], Next reset %" PRId64 " [%s]",
-              (int64_t) timeval, sCurrentTime, (int64_t) inst->reset_time, sNextTime);
+       RDEBUG2("rlm_sqlcounter: Current Time: %" PRId64 " [%s], Next reset %" PRId64 " [%s]",
+               (int64_t) timeval, sCurrentTime, (int64_t) inst->reset_time, sNextTime);
 
        return ret;
 }
@@ -205,6 +219,7 @@ static int find_prev_reset(rlm_sqlcounter_t *inst, time_t timeval)
                 */
                tm->tm_hour -= num - 1;
                inst->last_reset = mktime(tm);
+
        } else if (strcmp(inst->reset, "daily") == 0 || last == 'd') {
                /*
                 *  Round down to the prev nearest day.
@@ -212,20 +227,24 @@ static int find_prev_reset(rlm_sqlcounter_t *inst, time_t timeval)
                tm->tm_hour = 0;
                tm->tm_mday -= num - 1;
                inst->last_reset = mktime(tm);
+
        } else if (strcmp(inst->reset, "weekly") == 0 || last == 'w') {
                /*
                 *  Round down to the prev nearest week.
                 */
                tm->tm_hour = 0;
-               tm->tm_mday -= (7 - tm->tm_wday) +(7*(num-1));
+               tm->tm_mday -= tm->tm_wday +(7*(num-1));
                inst->last_reset = mktime(tm);
+
        } else if (strcmp(inst->reset, "monthly") == 0 || last == 'm') {
                tm->tm_hour = 0;
                tm->tm_mday = 1;
                tm->tm_mon -= num - 1;
                inst->last_reset = mktime(tm);
+
        } else if (strcmp(inst->reset, "never") == 0) {
                inst->reset_time = 0;
+
        } else {
                return -1;
        }
@@ -250,43 +269,80 @@ static int find_prev_reset(rlm_sqlcounter_t *inst, time_t timeval)
 
 static size_t sqlcounter_expand(char *out, int outlen, char const *fmt, rlm_sqlcounter_t *inst)
 {
-       int c, freespace;
+       int freespace;
        char const *p;
        char *q;
        char tmpdt[40]; /* For temporary storing of dates */
 
        q = out;
-       for (p = fmt; *p ; p++) {
+       p = fmt;
+       while (*p) {
                /* Calculate freespace in output */
                freespace = outlen - (q - out);
                if (freespace <= 1) {
                        return -1;
                }
-               c = *p;
-               if (c != '%') {
-                       *q++ = *p;
+
+               /*
+                *      Non-% get copied as-is.
+                */
+               if (*p != '%') {
+                       *q++ = *p++;
                        continue;
                }
-               if (*++p == '\0') break;
-               if (c == '%') switch(*p) {
+               p++;
+               if (!*p) {      /* % and then EOS --> % */
+                       *q++ = '%';
+                       break;
+               }
+
+               if (freespace <= 2) return -1;
+
+               /*
+                *      We need TWO %% in a row before we do our expansions.
+                *      If we only get one, just copy the %s as-is.
+                */
+               if (*p != '%') {
+                       *q++ = '%';
+                       *q++ = *p++;
+                       continue;
+               }
+               p++;
+               if (!*p) {
+                       *q++ = '%';
+                       *q++ = '%';
+                       break;
+               }
+
+               if (freespace <= 3) return -1;
+
+               switch (*p) {
                        case 'b': /* last_reset */
                                snprintf(tmpdt, sizeof(tmpdt), "%" PRId64, (int64_t) inst->last_reset);
                                strlcpy(q, tmpdt, freespace);
                                q += strlen(q);
+                               p++;
                                break;
                        case 'e': /* reset_time */
                                snprintf(tmpdt, sizeof(tmpdt), "%" PRId64, (int64_t) inst->reset_time);
                                strlcpy(q, tmpdt, freespace);
                                q += strlen(q);
+                               p++;
                                break;
                        case 'k': /* Key Name */
                                WARN("Please replace '%%k' with '${key}'");
                                strlcpy(q, inst->key_name, freespace);
                                q += strlen(q);
+                               p++;
                                break;
+
+                               /*
+                                *      %%s gets copied over as-is.
+                                */
                        default:
                                *q++ = '%';
-                               *q++ = *p;
+                               *q++ = '%';
+                               *q++ = *p++;
                                break;
                }
        }
@@ -345,6 +401,51 @@ static int sqlcounter_cmp(void *instance, REQUEST *request, UNUSED VALUE_PAIR *r
        return 0;
 }
 
+static int mod_bootstrap(CONF_SECTION *conf, void *instance)
+{
+       rlm_sqlcounter_t *inst = instance;
+       DICT_ATTR const *da;
+       ATTR_FLAGS flags;
+
+       memset(&flags, 0, sizeof(flags));
+       flags.compare = 1;      /* ugly hack */
+       da = dict_attrbyname(inst->counter_name);
+       if (da && (da->type != PW_TYPE_INTEGER64)) {
+               cf_log_err_cs(conf, "Counter attribute %s MUST be integer64", inst->counter_name);
+               return -1;
+       }
+
+       if (!da && (dict_addattr(inst->counter_name, -1, 0, PW_TYPE_INTEGER64, flags) < 0)) {
+               cf_log_err_cs(conf, "Failed to create counter attribute %s: %s", inst->counter_name, fr_strerror());
+               return -1;
+       }
+
+       /*
+        *  Register the counter comparison operation.
+        */
+       if (paircompare_register_byname(inst->counter_name, NULL, true, sqlcounter_cmp, inst) < 0) {
+               cf_log_err_cs(conf, "Failed registering counter attribute %s: %s", inst->counter_name, fr_strerror());
+               return -1;
+       }
+
+       inst->dict_attr = dict_attrbyname(inst->counter_name);
+       if (!inst->dict_attr) {
+               cf_log_err_cs(conf, "Failed to find counter attribute %s", inst->counter_name);
+               return -1;
+       }
+
+       /*
+        *  Create a new attribute for the check item.
+        */
+       flags.compare = 0;
+       if ((dict_addattr(inst->limit_name, -1, 0, PW_TYPE_INTEGER64, flags) < 0) ||
+           !dict_attrbyname(inst->limit_name)) {
+               cf_log_err_cs(conf, "Failed to create check attribute %s: %s", inst->limit_name, fr_strerror());
+               return -1;
+       }
+
+       return 0;
+}
 
 /*
  *     Do any per-module initialization that is separate to each
@@ -360,7 +461,6 @@ static int mod_instantiate(CONF_SECTION *conf, void *instance)
 {
        rlm_sqlcounter_t *inst = instance;
        DICT_ATTR const *da;
-       ATTR_FLAGS flags;
        time_t now;
 
        rad_assert(inst->query && *inst->query);
@@ -379,34 +479,10 @@ static int mod_instantiate(CONF_SECTION *conf, void *instance)
        }
        inst->reply_attr = da;
 
-       /*
-        *  Create a new attribute for the counter.
-        */
-       rad_assert(inst->counter_name && *inst->counter_name);
-       memset(&flags, 0, sizeof(flags));
-       dict_addattr(inst->counter_name, -1, 0, PW_TYPE_INTEGER64, flags);
-       da = dict_attrbyname(inst->counter_name);
-       if (!da) {
-               cf_log_err_cs(conf, "Failed to create counter attribute %s", inst->counter_name);
-               return -1;
-       }
-       inst->dict_attr = da;
-
-       /*
-        *  Create a new attribute for the check item.
-        */
-       rad_assert(inst->limit_name && *inst->limit_name);
-       dict_addattr(inst->limit_name, -1, 0, PW_TYPE_INTEGER64, flags);
-       da = dict_attrbyname(inst->limit_name);
-       if (!da) {
-               cf_log_err_cs(conf, "Failed to create check attribute %s", inst->limit_name);
-               return -1;
-       }
-
        now = time(NULL);
        inst->reset_time = 0;
 
-       if (find_next_reset(inst,now) == -1) {
+       if (find_next_reset(inst, NULL, now) < 0) {
                cf_log_err_cs(conf, "Invalid reset '%s'", inst->reset);
                return -1;
        }
@@ -421,11 +497,6 @@ static int mod_instantiate(CONF_SECTION *conf, void *instance)
                return -1;
        }
 
-       /*
-        *  Register the counter comparison operation.
-        */
-       paircompare_register(inst->dict_attr, NULL, true, sqlcounter_cmp, inst);
-
        return 0;
 }
 
@@ -459,7 +530,7 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
                 *      Re-set the next time and prev_time for this counters range
                 */
                inst->last_reset = inst->reset_time;
-               find_next_reset(inst,request->timestamp);
+               find_next_reset(inst, request, request->timestamp);
        }
 
        /*
@@ -469,10 +540,10 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
        if ((inst->key_attr->vendor == 0) && (inst->key_attr->attr == PW_USER_NAME)) {
                key_vp = request->username;
        } else {
-               key_vp = pairfind(request->packet->vps, inst->key_attr->attr, inst->key_attr->vendor, TAG_ANY);
+               key_vp = fr_pair_find_by_da(request->packet->vps, inst->key_attr, TAG_ANY);
        }
        if (!key_vp) {
-               RWDEBUG2("Couldn't find key attribute 'request:%s'", inst->key_attr->name);
+               RWDEBUG2("Couldn't find key attribute, request:%s, doing nothing...", inst->key_attr->name);
                return rcode;
        }
 
@@ -483,9 +554,10 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
                return rcode;
        }
 
-       limit = pairfind(request->config_items, da->attr, da->vendor, TAG_ANY);
+       limit = fr_pair_find_by_da(request->config, da, TAG_ANY);
        if (limit == NULL) {
-               RWDEBUG2("Couldn't find control attribute 'control:%s'", inst->limit_name);
+               /* Yes this really is 'check' as distinct from control */
+               RWDEBUG2("Couldn't find check attribute, control:%s, doing nothing...", inst->limit_name);
                return rcode;
        }
 
@@ -522,17 +594,17 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
        if (limit->vp_integer64 <= counter) {
                /* User is denied access, send back a reply message */
                snprintf(msg, sizeof(msg), "Your maximum %s usage time has been reached", inst->reset);
-               pairmake_reply("Reply-Message", msg, T_OP_EQ);
+               pair_make_reply("Reply-Message", msg, T_OP_EQ);
 
                REDEBUG2("Maximum %s usage time reached", inst->reset);
-               REDEBUG2("Rejecting user, control:%s value (%" PRIu64 ") is less than counter value (%" PRIu64 ")",
+               REDEBUG2("Rejecting user, &control:%s value (%" PRIu64 ") is less than counter value (%" PRIu64 ")",
                         inst->limit_name, limit->vp_integer64, counter);
 
                return RLM_MODULE_REJECT;
        }
 
        res = limit->vp_integer64 - counter;
-       RDEBUG2("Allowing user, control:%s value (%" PRIu64 ") is greater than counter value (%" PRIu64 ")",
+       RDEBUG2("Allowing user, &control:%s value (%" PRIu64 ") is greater than counter value (%" PRIu64 ")",
                inst->limit_name, limit->vp_integer64, counter);
        /*
         *      We are assuming that simultaneous-use=1. But
@@ -547,29 +619,32 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
         *      again.  Do this only for Session-Timeout.
         */
        if (((inst->reply_attr->vendor == 0) && (inst->reply_attr->attr == PW_SESSION_TIMEOUT)) &&
-           inst->reset_time && ((int) res >= (inst->reset_time - request->timestamp))) {
-               res = (inst->reset_time - request->timestamp);
-               res += limit->vp_integer;
+           inst->reset_time && (res >= (uint64_t)(inst->reset_time - request->timestamp))) {
+               uint64_t to_reset = inst->reset_time - request->timestamp;
+
+               RDEBUG2("Time remaining (%" PRIu64 "s) is greater than time to reset (%" PRIu64 "s).  "
+                       "Adding %" PRIu64 "s to reply value", to_reset, res, to_reset);
+               res = to_reset + limit->vp_integer;
        }
 
        /*
         *      Limit the reply attribute to the minimum of the existing value, or this new one.
         */
-       reply_item = pairfind(request->reply->vps, inst->reply_attr->attr, inst->reply_attr->vendor, TAG_ANY);
+       reply_item = fr_pair_find_by_da(request->reply->vps, inst->reply_attr, TAG_ANY);
        if (reply_item) {
                if (reply_item->vp_integer64 <= res) {
-                       RDEBUG2("Leaving existing reply:%s value of %" PRIu64, inst->reply_attr->name,
+                       RDEBUG2("Leaving existing &reply:%s value of %" PRIu64, inst->reply_attr->name,
                                reply_item->vp_integer64);
 
                        return RLM_MODULE_OK;
                }
        } else {
-               reply_item = radius_paircreate(request->reply, &request->reply->vps, inst->reply_attr->attr,
+               reply_item = radius_pair_create(request->reply, &request->reply->vps, inst->reply_attr->attr,
                                               inst->reply_attr->vendor);
        }
        reply_item->vp_integer64 = res;
 
-       RDEBUG2("Setting reply:%s value to %" PRIu64, inst->reply_name, reply_item->vp_integer64);
+       RDEBUG2("Setting &reply:%s value to %" PRIu64, inst->reply_name, reply_item->vp_integer64);
 
        return RLM_MODULE_OK;
 }
@@ -583,23 +658,17 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
  *     The server will then take care of ensuring that the module
  *     is single-threaded.
  */
+extern module_t rlm_sqlcounter;
 module_t rlm_sqlcounter = {
-       RLM_MODULE_INIT,
-       "rlm_sqlcounter",
-       RLM_TYPE_THREAD_SAFE,           /* type */
-       sizeof(rlm_sqlcounter_t),
-       module_config,
-       mod_instantiate,                /* instantiation */
-       NULL,                           /* detach */
-       {
-               NULL,                   /* authentication */
-               mod_authorize,          /* authorization */
-               NULL,                   /* preaccounting */
-               NULL,                   /* accounting */
-               NULL,                   /* checksimul */
-               NULL,                   /* pre-proxy */
-               NULL,                   /* post-proxy */
-               NULL                    /* post-auth */
+       .magic          = RLM_MODULE_INIT,
+       .name           = "sqlcounter",
+       .type           = RLM_TYPE_THREAD_SAFE,
+       .inst_size      = sizeof(rlm_sqlcounter_t),
+       .config         = module_config,
+       .bootstrap      = mod_bootstrap,
+       .instantiate    = mod_instantiate,
+       .methods = {
+               [MOD_AUTHORIZE]         = mod_authorize
        },
 };