port fix from branch_1_1
[freeradius.git] / src / modules / rlm_sql / sql.c
index 2ac5aed..c0f713a 100644 (file)
  *
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
- *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  *
- * Copyright 2001  The FreeRADIUS server project
+ * Copyright 2001,2006  The FreeRADIUS server project
  * Copyright 2000  Mike Machado <mike@innercite.com>
  * Copyright 2000  Alan DeKok <aland@ox.org>
  * Copyright 2001  Chad Miller <cmiller@surfsouth.com>
  */
 
+#include <freeradius-devel/ident.h>
+RCSID("$Id$")
+
+#include       <freeradius-devel/autoconf.h>
 
 #include       <sys/types.h>
 #include       <sys/socket.h>
 #include       <errno.h>
 #include       <sys/wait.h>
 
-#if HAVE_PTHREAD_H
-#include       <pthread.h>
-#endif
-
-#include       "radiusd.h"
-#include       "conffile.h"
+#include       <freeradius-devel/radiusd.h>
 #include       "rlm_sql.h"
 
+#ifdef HAVE_PTHREAD_H
+#endif
+
 
 /*
  * Connect to a server.  If error, set this socket's state to be
  */
 static int connect_single_socket(SQLSOCK *sqlsocket, SQL_INST *inst)
 {
+       int rcode;
        radlog(L_DBG, "rlm_sql (%s): Attempting to connect %s #%d",
               inst->config->xlat_name, inst->module->name, sqlsocket->id);
 
-       if ((inst->module->sql_init_socket)(sqlsocket, inst->config) < 0) {
-               radlog(L_CONS | L_ERR, "rlm_sql (%s): Failed to connect DB handle #%d", inst->config->xlat_name, sqlsocket->id);
-               inst->connect_after = time(NULL) + inst->config->connect_failure_retry_delay;
-               sqlsocket->state = sockunconnected;
-               return(-1);
-       } else {
+       rcode = (inst->module->sql_init_socket)(sqlsocket, inst->config);
+       if (rcode == 0) {
                radlog(L_DBG, "rlm_sql (%s): Connected new DB handle, #%d",
                       inst->config->xlat_name, sqlsocket->id);
                sqlsocket->state = sockconnected;
                return(0);
        }
+
+       /*
+        *  Error, or SQL_DOWN.
+        */
+       radlog(L_CONS | L_ERR, "rlm_sql (%s): Failed to connect DB handle #%d", inst->config->xlat_name, sqlsocket->id);
+       inst->connect_after = time(NULL) + inst->config->connect_failure_retry_delay;
+       sqlsocket->state = sockunconnected;
+       return(-1);
 }
 
 
@@ -90,57 +97,54 @@ static int connect_single_socket(SQLSOCK *sqlsocket, SQL_INST *inst)
 int sql_init_socketpool(SQL_INST * inst)
 {
        int i, rcode;
+       int success = 0;
        SQLSOCK *sqlsocket;
 
        inst->connect_after = 0;
-       inst->used = 0;
        inst->sqlpool = NULL;
-       inst->socknr = 0;
 
        for (i = 0; i < inst->config->num_sql_socks; i++) {
                radlog(L_DBG, "rlm_sql (%s): starting %d",
                       inst->config->xlat_name, i);
 
-               sqlsocket = rad_malloc(sizeof(SQLSOCK));
+               sqlsocket = rad_malloc(sizeof(*sqlsocket));
                if (sqlsocket == NULL) {
                        return -1;
                }
+               memset(sqlsocket, 0, sizeof(*sqlsocket));
                sqlsocket->conn = NULL;
                sqlsocket->id = i;
                sqlsocket->state = sockunconnected;
 
-#if HAVE_PTHREAD_H
-               rcode = pthread_cond_init(&sqlsocket->cond,NULL);
-               if (rcode != 0) {
-                       radlog(L_ERR, "rlm_sql: Failed to init cond: %s",
-                              strerror(errno));
-                       return 0;
-               }
-               
-               rcode = pthread_mutex_init(&sqlsocket->lock,NULL);
+#ifdef HAVE_PTHREAD_H
+               rcode = pthread_mutex_init(&sqlsocket->mutex,NULL);
                if (rcode != 0) {
                        radlog(L_ERR, "rlm_sql: Failed to init lock: %s",
                               strerror(errno));
                        return 0;
                }
-#else
-               sqlsocket->in_use = SQLSOCK_UNLOCKED;
 #endif
 
                if (time(NULL) > inst->connect_after) {
-                       /* this sets the sqlsocket->state, and possibly sets inst->connect_after */
-                       /* FIXME! check return code */
-                       connect_single_socket(sqlsocket, inst);
+                       /*
+                        *      This sets the sqlsocket->state, and
+                        *      possibly also inst->connect_after
+                        */
+                       if (connect_single_socket(sqlsocket, inst) == 0) {
+                               success = 1;
+                       }
                }
 
                /* Add this socket to the list of sockets */
                sqlsocket->next = inst->sqlpool;
                inst->sqlpool = sqlsocket;
        }
+       inst->last_used = NULL;
 
-#if HAVE_PTHREAD_H
-       pthread_mutex_init(&inst->mutex, NULL);
-#endif
+       if (!success) {
+               radlog(L_DBG, "rlm_sql (%s): Failed to connect to any SQL server.",
+                      inst->config->xlat_name);
+       }
 
        return 1;
 }
@@ -155,13 +159,14 @@ int sql_init_socketpool(SQL_INST * inst)
 void sql_poolfree(SQL_INST * inst)
 {
        SQLSOCK *cur;
+       SQLSOCK *next;
 
-       for (cur = inst->sqlpool; cur; cur = cur->next) {
+       for (cur = inst->sqlpool; cur; cur = next) {
+               next = cur->next;
                sql_close_socket(inst, cur);
        }
-#if HAVE_PTHREAD_H
-       pthread_mutex_destroy(&inst->mutex);
-#endif
+
+       inst->sqlpool = NULL;
 }
 
 
@@ -176,10 +181,14 @@ int sql_close_socket(SQL_INST *inst, SQLSOCK * sqlsocket)
 {
        radlog(L_DBG, "rlm_sql (%s): Closing sqlsocket %d",
               inst->config->xlat_name, sqlsocket->id);
-       (inst->module->sql_close)(sqlsocket, inst->config);
-#if HAVE_PTHREAD_H
-       pthread_mutex_destroy(&sqlsocket->lock);
-       pthread_cond_destroy(&sqlsocket->cond);
+       if (sqlsocket->state == sockconnected) {
+               (inst->module->sql_close)(sqlsocket, inst->config);
+       }
+       if (inst->module->sql_destroy_socket) {
+               (inst->module->sql_destroy_socket)(sqlsocket, inst->config);
+       }
+#ifdef HAVE_PTHREAD_H
+       pthread_mutex_destroy(&sqlsocket->mutex);
 #endif
        free(sqlsocket);
        return 1;
@@ -190,36 +199,35 @@ int sql_close_socket(SQL_INST *inst, SQLSOCK * sqlsocket)
  *
  *     Function: sql_get_socket
  *
- *     Purpose: Return a SQL sqlsocket from the connection pool           
+ *     Purpose: Return a SQL sqlsocket from the connection pool
  *
  *************************************************************************/
 SQLSOCK * sql_get_socket(SQL_INST * inst)
 {
-       SQLSOCK *cur;
+       SQLSOCK *cur, *start;
        int tried_to_connect = 0;
        int unconnected = 0;
 
        /*
-        * Rotating the socket so that all get used and none get closed due to
-        * inactivity from the SQL server ( such as mySQL ).
+        *      Start at the last place we left off.
         */
-#if HAVE_PTHREAD_H
-       pthread_mutex_lock(&inst->mutex);
-#endif
+       start = inst->last_used;
+       if (!start) start = inst->sqlpool;
 
-       if(inst->socknr == 0) {
-               inst->socknr = inst->config->num_sql_socks;
-       }
-       inst->socknr--;
-       cur = inst->sqlpool;
-       while (inst->socknr != cur->id) {
-               cur = cur->next;
-       }
-#if HAVE_PTHREAD_H
-       pthread_mutex_unlock(&inst->mutex);
-#endif
+       cur = start;
 
        while (cur) {
+#ifdef HAVE_PTHREAD_H
+               /*
+                *      If this socket is in use by another thread,
+                *      skip it, and try another socket.
+                *
+                *      If it isn't used, then grab it ourselves.
+                */
+               if (pthread_mutex_trylock(&cur->mutex) != 0) {
+                       goto next;
+               } /* else we now have the lock */
+#endif
 
                /*
                 *      If we happen upon an unconnected socket, and
@@ -237,30 +245,36 @@ SQLSOCK * sql_get_socket(SQL_INST * inst)
                if (cur->state == sockunconnected) {
                        radlog(L_DBG, "rlm_sql (%s): Ignoring unconnected handle %d..", inst->config->xlat_name, cur->id);
                        unconnected++;
-               } else {
-                       /* should be connected, grab it */
-#if HAVE_PTHREAD_H
-               pthread_mutex_lock(&cur->lock);
-               if (pthread_cond_wait(&cur->cond,&cur->lock) != 0) {
-                       pthread_mutex_unlock(&cur->lock);
-               } else {
-                       pthread_mutex_unlock(&cur->lock);
-#else
-                       if (cur->in_use == SQLSOCK_UNLOCKED) {
+#ifdef HAVE_PTHREAD_H
+                       pthread_mutex_unlock(&cur->mutex);
 #endif
-                               (inst->used)++;
-#ifndef HAVE_PTHREAD_H
-                               cur->in_use = SQLSOCK_LOCKED;
-#endif
-                               radlog(L_DBG, "rlm_sql (%s): Reserving sql socket id: %d", inst->config->xlat_name, cur->id);
-                               if (unconnected != 0 || tried_to_connect != 0) {
-                                       radlog(L_INFO, "rlm_sql (%s): got socket %d after skipping %d unconnected handles, tried to reconnect %d though", inst->config->xlat_name, cur->id, unconnected, tried_to_connect);
-                               }
-                               return cur;
-                       }
+                       goto next;
                }
 
+               /* should be connected, grab it */
+               radlog(L_DBG, "rlm_sql (%s): Reserving sql socket id: %d", inst->config->xlat_name, cur->id);
+
+               if (unconnected != 0 || tried_to_connect != 0) {
+                       radlog(L_INFO, "rlm_sql (%s): got socket %d after skipping %d unconnected handles, tried to reconnect %d though", inst->config->xlat_name, cur->id, unconnected, tried_to_connect);
+               }
+
+               /*
+                *      The socket is returned in the locked
+                *      state.
+                *
+                *      We also remember where we left off,
+                *      so that the next search can start from
+                *      here.
+                *
+                *      Note that multiple threads MAY over-write
+                *      the 'inst->last_used' variable.  This is OK,
+                *      as it's a pointer only used for reading.
+                */
+               inst->last_used = cur->next;
+               return cur;
+
                /* move along the list */
+       next:
                cur = cur->next;
 
                /*
@@ -274,11 +288,9 @@ SQLSOCK * sql_get_socket(SQL_INST * inst)
                }
 
                /*
-                *      we should check that after going back to the
-                *      start of the list, remember to stop at the
-                *      socket that we started at.
+                *      If we're at the socket we started
                 */
-               if (cur->id == inst->socknr) {
+               if (cur == start) {
                        break;
                }
        }
@@ -292,16 +304,13 @@ SQLSOCK * sql_get_socket(SQL_INST * inst)
  *
  *     Function: sql_release_socket
  *
- *     Purpose: Frees a SQL sqlsocket back to the connection pool           
+ *     Purpose: Frees a SQL sqlsocket back to the connection pool
  *
  *************************************************************************/
 int sql_release_socket(SQL_INST * inst, SQLSOCK * sqlsocket)
 {
-       (inst->used)--;
-#if HAVE_PTHREAD_H
-       pthread_cond_signal(&sqlsocket->cond);
-#else
-       sqlsocket->in_use = SQLSOCK_UNLOCKED;
+#ifdef HAVE_PTHREAD_H
+       pthread_mutex_unlock(&sqlsocket->mutex);
 #endif
 
        radlog(L_DBG, "rlm_sql (%s): Released sql socket id: %d",
@@ -318,47 +327,95 @@ int sql_release_socket(SQL_INST * inst, SQLSOCK * sqlsocket)
  *     Purpose: Read entries from the database and fill VALUE_PAIR structures
  *
  *************************************************************************/
-int sql_userparse(VALUE_PAIR ** first_pair, SQL_ROW row, int querymode)
+int sql_userparse(VALUE_PAIR ** first_pair, SQL_ROW row)
 {
-       DICT_ATTR *attr;
-       VALUE_PAIR *pair, *check;
-       char *ptr;
-       char buf[128];
-       int pairmode = T_EOL;
-
-       if ((attr = dict_attrbyname(row[2])) == (DICT_ATTR *) NULL) {
-               radlog(L_ERR | L_CONS, "rlm_sql: unknown attribute %s",
-                      row[2]);
-               return (-1);
+       VALUE_PAIR *pair;
+       char *ptr, *value;
+       char buf[MAX_STRING_LEN];
+       char do_xlat = 0;
+       LRAD_TOKEN token, operator = T_EOL;
+
+       /*
+        *      Verify the 'Attribute' field
+        */
+       if (row[2] == NULL || row[2][0] == '\0') {
+               radlog(L_ERR, "rlm_sql: The 'Attribute' field is empty or NULL, skipping the entire row.");
+               return -1;
        }
 
-       if (row[4] != NULL && strlen(row[4]) > 0) {
+       /*
+        *      Verify the 'op' field
+        */
+       if (row[4] != NULL && row[4][0] != '\0') {
                ptr = row[4];
-               pairmode = gettoken(&ptr, buf, sizeof(buf));
-       } else {
+               operator = gettoken(&ptr, buf, sizeof(buf));
+       }
+       if (operator <= T_EOL) {
                /*
-                *  'op' fields of NULL are a plague, and a bane on the
-                *  existence of mankind.
+                *  Complain about empty or invalid 'op' field
                 */
+               operator = T_OP_CMP_EQ;
                radlog(L_ERR, "rlm_sql: The 'op' field for attribute '%s = %s' is NULL, or non-existent.", row[2], row[3]);
                radlog(L_ERR, "rlm_sql: You MUST FIX THIS if you want the configuration to behave as you expect.");
        }
-       if (pairmode <= T_EOL) pairmode = T_OP_CMP_EQ;
 
        /*
-        * If attribute is already there, skip it because we checked usercheck first 
-        * and we want user settings to over ride group settings 
+        *      The 'Value' field may be empty or NULL
         */
-       if (pairmode != T_OP_ADD && (check = pairfind(*first_pair, attr->attr)) != NULL &&
-#ifdef ASCEND_BINARY
-                       attr->type != PW_TYPE_ABINARY &&
-#endif
-                       querymode == PW_VP_GROUPDATA)
-               return 0;
+       value = row[3];
+       /*
+        *      If we have a new-style quoted string, where the
+        *      *entire* string is quoted, do xlat's.
+        */
+       if (row[3] != NULL &&
+          ((row[3][0] == '\'') || (row[3][0] == '`') || (row[3][0] == '"')) &&
+          (row[3][0] == row[3][strlen(row[3])-1])) {
+
+               token = gettoken(&value, buf, sizeof(buf));
+               switch (token) {
+                       /*
+                        *      Take the unquoted string.
+                        */
+               case T_SINGLE_QUOTED_STRING:
+               case T_DOUBLE_QUOTED_STRING:
+                       value = buf;
+                       break;
 
-       pair = pairmake(row[2], row[3], pairmode);
-       pairadd(first_pair, pair);
+                       /*
+                        *      Mark the pair to be allocated later.
+                        */
+               case T_BACK_QUOTED_STRING:
+                       value = NULL;
+                       do_xlat = 1;
+                       break;
 
+                       /*
+                        *      Keep the original string.
+                        */
+               default:
+                       value = row[3];
+                       break;
+               }
+       }
+
+       /*
+        *      Create the pair
+        */
+       pair = pairmake(row[2], value, operator);
+       if (pair == NULL) {
+               radlog(L_ERR, "rlm_sql: Failed to create the pair: %s", librad_errstr);
+               return -1;
+       }
+       if (do_xlat) {
+               pair->flags.do_xlat = 1;
+               strlcpy(pair->vp_strvalue, buf, sizeof(pair->vp_strvalue));
+               pair->length = 0;
+       }
+
+       /*
+        *      Add the pair into the packet
+        */
+       pairadd(first_pair, pair);
        return 0;
 }
 
@@ -374,11 +431,17 @@ int rlm_sql_fetch_row(SQLSOCK *sqlsocket, SQL_INST *inst)
 {
        int ret;
 
-       ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
+       if (sqlsocket->conn) {
+               ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
+       } else {
+               ret = SQL_DOWN;
+       }
 
        if (ret == SQL_DOWN) {
-               /* close the socket that failed */
-               (inst->module->sql_close)(sqlsocket, inst->config);
+               /* close the socket that failed, but only if it was open */
+               if (sqlsocket->conn) {
+                       (inst->module->sql_close)(sqlsocket, inst->config);
+               }
 
                /* reconnect the socket */
                if (connect_single_socket(sqlsocket, inst) < 0) {
@@ -421,7 +484,9 @@ int rlm_sql_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
 
        if (ret == SQL_DOWN) {
                /* close the socket that failed */
-               (inst->module->sql_close)(sqlsocket, inst->config);
+               if (sqlsocket->state == sockconnected) {
+                       (inst->module->sql_close)(sqlsocket, inst->config);
+               }
 
                /* reconnect the socket */
                if (connect_single_socket(sqlsocket, inst) < 0) {
@@ -464,7 +529,9 @@ int rlm_sql_select_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
 
        if (ret == SQL_DOWN) {
                /* close the socket that failed */
-               (inst->module->sql_close)(sqlsocket, inst->config);
+               if (sqlsocket->state == sockconnected) {
+                       (inst->module->sql_close)(sqlsocket, inst->config);
+               }
 
                /* reconnect the socket */
                if (connect_single_socket(sqlsocket, inst) < 0) {
@@ -493,7 +560,7 @@ int rlm_sql_select_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
  *     Purpose: Get any group check or reply pairs
  *
  *************************************************************************/
-int sql_getvpdata(SQL_INST * inst, SQLSOCK * sqlsocket, VALUE_PAIR **pair, char *query, int mode)
+int sql_getvpdata(SQL_INST * inst, SQLSOCK * sqlsocket, VALUE_PAIR **pair, char *query)
 {
        SQL_ROW row;
        int     rows = 0;
@@ -513,7 +580,7 @@ int sql_getvpdata(SQL_INST * inst, SQLSOCK * sqlsocket, VALUE_PAIR **pair, char
                row = sqlsocket->row;
                if (!row)
                        break;
-               if (sql_userparse(pair, row, mode) != 0) {
+               if (sql_userparse(pair, row) != 0) {
                        radlog(L_ERR | L_CONS, "rlm_sql (%s): Error getting data from database", inst->config->xlat_name);
                        (inst->module->sql_finish_select_query)(sqlsocket, inst->config);
                        return -1;
@@ -545,7 +612,7 @@ void query_log(REQUEST *request, SQL_INST *inst, char *querystr)
                               buffer);
                } else {
                        int fd = fileno(sqlfile);
-                       
+
                        rad_lockfd(fd, MAX_QUERY_LEN);
                        fputs(querystr, sqlfile);
                        fputs(";\n", sqlfile);