2 * sql.c rlm_sql - FreeRADIUS SQL Module
3 * Main code directly taken from ICRADIUS
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * Copyright 2001,2006 The FreeRADIUS server project
22 * Copyright 2000 Mike Machado <mike@innercite.com>
23 * Copyright 2000 Alan DeKok <aland@ox.org>
24 * Copyright 2001 Chad Miller <cmiller@surfsouth.com>
27 #include <freeradius-devel/ident.h>
30 #include <freeradius-devel/radiusd.h>
44 * Connect to a server. If error, set this socket's state to be
45 * "sockunconnected" and set a grace period, during which we won't try
46 * connecting again (to prevent unduly lagging the server and being
47 * impolite to a DB server that may be having other issues). If
48 * successful in connecting, set state to sockconnected.
51 static int connect_single_socket(SQLSOCK *sqlsocket, SQL_INST *inst)
54 radlog(L_DBG, "rlm_sql (%s): Attempting to connect %s #%d",
55 inst->config->xlat_name, inst->module->name, sqlsocket->id);
57 rcode = (inst->module->sql_init_socket)(sqlsocket, inst->config);
59 radlog(L_DBG, "rlm_sql (%s): Connected new DB handle, #%d",
60 inst->config->xlat_name, sqlsocket->id);
61 sqlsocket->state = sockconnected;
68 radlog(L_CONS | L_ERR, "rlm_sql (%s): Failed to connect DB handle #%d", inst->config->xlat_name, sqlsocket->id);
69 inst->connect_after = time(NULL) + inst->config->connect_failure_retry_delay;
70 sqlsocket->state = sockunconnected;
75 /*************************************************************************
77 * Function: sql_init_socketpool
79 * Purpose: Connect to the sql server, if possible
81 *************************************************************************/
82 int sql_init_socketpool(SQL_INST * inst)
88 inst->connect_after = 0;
91 for (i = 0; i < inst->config->num_sql_socks; i++) {
92 radlog(L_DBG, "rlm_sql (%s): starting %d",
93 inst->config->xlat_name, i);
95 sqlsocket = rad_malloc(sizeof(*sqlsocket));
96 if (sqlsocket == NULL) {
99 memset(sqlsocket, 0, sizeof(*sqlsocket));
100 sqlsocket->conn = NULL;
102 sqlsocket->state = sockunconnected;
104 #ifdef HAVE_PTHREAD_H
105 rcode = pthread_mutex_init(&sqlsocket->mutex,NULL);
108 radlog(L_ERR, "rlm_sql: Failed to init lock: %s",
114 if (time(NULL) > inst->connect_after) {
116 * This sets the sqlsocket->state, and
117 * possibly also inst->connect_after
119 if (connect_single_socket(sqlsocket, inst) == 0) {
124 /* Add this socket to the list of sockets */
125 sqlsocket->next = inst->sqlpool;
126 inst->sqlpool = sqlsocket;
128 inst->last_used = NULL;
131 radlog(L_DBG, "rlm_sql (%s): Failed to connect to any SQL server.",
132 inst->config->xlat_name);
138 /*************************************************************************
140 * Function: sql_poolfree
142 * Purpose: Clean up and free sql pool
144 *************************************************************************/
145 void sql_poolfree(SQL_INST * inst)
150 for (cur = inst->sqlpool; cur; cur = next) {
152 sql_close_socket(inst, cur);
155 inst->sqlpool = NULL;
159 /*************************************************************************
161 * Function: sql_close_socket
163 * Purpose: Close and free a sql sqlsocket
165 *************************************************************************/
166 int sql_close_socket(SQL_INST *inst, SQLSOCK * sqlsocket)
168 radlog(L_DBG, "rlm_sql (%s): Closing sqlsocket %d",
169 inst->config->xlat_name, sqlsocket->id);
170 if (sqlsocket->state == sockconnected) {
171 (inst->module->sql_close)(sqlsocket, inst->config);
173 if (inst->module->sql_destroy_socket) {
174 (inst->module->sql_destroy_socket)(sqlsocket, inst->config);
176 #ifdef HAVE_PTHREAD_H
177 pthread_mutex_destroy(&sqlsocket->mutex);
183 static time_t last_logged_failure = 0;
186 /*************************************************************************
188 * Function: sql_get_socket
190 * Purpose: Return a SQL sqlsocket from the connection pool
192 *************************************************************************/
193 SQLSOCK * sql_get_socket(SQL_INST * inst)
195 SQLSOCK *cur, *start;
196 int tried_to_connect = 0;
201 * Start at the last place we left off.
203 start = inst->last_used;
204 if (!start) start = inst->sqlpool;
209 #ifdef HAVE_PTHREAD_H
211 * If this socket is in use by another thread,
212 * skip it, and try another socket.
214 * If it isn't used, then grab it ourselves.
216 if (pthread_mutex_trylock(&cur->mutex) != 0) {
218 } /* else we now have the lock */
222 * If we happen upon an unconnected socket, and
223 * this instance's grace period on
224 * (re)connecting has expired, then try to
225 * connect it. This should be really rare.
227 if ((cur->state == sockunconnected) && (time(NULL) > inst->connect_after)) {
228 radlog(L_INFO, "rlm_sql (%s): Trying to (re)connect unconnected handle %d..", inst->config->xlat_name, cur->id);
230 connect_single_socket(cur, inst);
233 /* if we still aren't connected, ignore this handle */
234 if (cur->state == sockunconnected) {
235 radlog(L_DBG, "rlm_sql (%s): Ignoring unconnected handle %d..", inst->config->xlat_name, cur->id);
237 #ifdef HAVE_PTHREAD_H
238 pthread_mutex_unlock(&cur->mutex);
243 /* should be connected, grab it */
244 radlog(L_DBG, "rlm_sql (%s): Reserving sql socket id: %d", inst->config->xlat_name, cur->id);
246 if (unconnected != 0 || tried_to_connect != 0) {
247 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);
251 * The socket is returned in the locked
254 * We also remember where we left off,
255 * so that the next search can start from
258 * Note that multiple threads MAY over-write
259 * the 'inst->last_used' variable. This is OK,
260 * as it's a pointer only used for reading.
262 inst->last_used = cur->next;
265 /* move along the list */
270 * Because we didnt start at the start, once we
271 * hit the end of the linklist, we should go
272 * back to the beginning and work toward the
280 * If we're at the socket we started
288 * Suppress most of the log messages. We don't want to
289 * flood the log with this message for EVERY packet.
290 * Instead, write to the log only once a second or so.
292 * This code has race conditions when threaded, but the
293 * only result is that a few more messages are logged.
296 if (now <= last_logged_failure) return NULL;
297 last_logged_failure = now;
299 /* We get here if every DB handle is unconnected and unconnectABLE */
300 radlog(L_INFO, "rlm_sql (%s): There are no DB handles to use! skipped %d, tried to connect %d", inst->config->xlat_name, unconnected, tried_to_connect);
304 /*************************************************************************
306 * Function: sql_release_socket
308 * Purpose: Frees a SQL sqlsocket back to the connection pool
310 *************************************************************************/
311 int sql_release_socket(SQL_INST * inst, SQLSOCK * sqlsocket)
313 #ifdef HAVE_PTHREAD_H
314 pthread_mutex_unlock(&sqlsocket->mutex);
317 radlog(L_DBG, "rlm_sql (%s): Released sql socket id: %d",
318 inst->config->xlat_name, sqlsocket->id);
324 /*************************************************************************
326 * Function: sql_userparse
328 * Purpose: Read entries from the database and fill VALUE_PAIR structures
330 *************************************************************************/
331 int sql_userparse(VALUE_PAIR ** first_pair, SQL_ROW row)
334 const char *ptr, *value;
335 char buf[MAX_STRING_LEN];
337 FR_TOKEN token, operator = T_EOL;
340 * Verify the 'Attribute' field
342 if (row[2] == NULL || row[2][0] == '\0') {
343 radlog(L_ERR, "rlm_sql: The 'Attribute' field is empty or NULL, skipping the entire row.");
348 * Verify the 'op' field
350 if (row[4] != NULL && row[4][0] != '\0') {
352 operator = gettoken(&ptr, buf, sizeof(buf));
354 if (operator <= T_EOL) {
356 * Complain about empty or invalid 'op' field
358 operator = T_OP_CMP_EQ;
359 radlog(L_ERR, "rlm_sql: The 'op' field for attribute '%s = %s' is NULL, or non-existent.", row[2], row[3]);
360 radlog(L_ERR, "rlm_sql: You MUST FIX THIS if you want the configuration to behave as you expect.");
364 * The 'Value' field may be empty or NULL
368 * If we have a new-style quoted string, where the
369 * *entire* string is quoted, do xlat's.
371 if (row[3] != NULL &&
372 ((row[3][0] == '\'') || (row[3][0] == '`') || (row[3][0] == '"')) &&
373 (row[3][0] == row[3][strlen(row[3])-1])) {
375 token = gettoken(&value, buf, sizeof(buf));
378 * Take the unquoted string.
380 case T_SINGLE_QUOTED_STRING:
381 case T_DOUBLE_QUOTED_STRING:
386 * Mark the pair to be allocated later.
388 case T_BACK_QUOTED_STRING:
394 * Keep the original string.
405 pair = pairmake(row[2], value, operator);
407 radlog(L_ERR, "rlm_sql: Failed to create the pair: %s", librad_errstr);
411 pair->flags.do_xlat = 1;
412 strlcpy(pair->vp_strvalue, buf, sizeof(pair->vp_strvalue));
417 * Add the pair into the packet
419 pairadd(first_pair, pair);
424 /*************************************************************************
426 * Function: rlm_sql_fetch_row
428 * Purpose: call the module's sql_fetch_row and implement re-connect
430 *************************************************************************/
431 int rlm_sql_fetch_row(SQLSOCK *sqlsocket, SQL_INST *inst)
435 if (sqlsocket->conn) {
436 ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
441 if (ret == SQL_DOWN) {
442 /* close the socket that failed, but only if it was open */
443 if (sqlsocket->conn) {
444 (inst->module->sql_close)(sqlsocket, inst->config);
447 /* reconnect the socket */
448 if (connect_single_socket(sqlsocket, inst) < 0) {
449 radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
453 /* retry the query on the newly connected socket */
454 ret = (inst->module->sql_fetch_row)(sqlsocket, inst->config);
457 radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
458 inst->config->xlat_name);
466 /*************************************************************************
468 * Function: rlm_sql_query
470 * Purpose: call the module's sql_query and implement re-connect
472 *************************************************************************/
473 int rlm_sql_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
478 * If there's no query, return an error.
480 if (!query || !*query) {
484 ret = (inst->module->sql_query)(sqlsocket, inst->config, query);
486 if (ret == SQL_DOWN) {
487 /* close the socket that failed */
488 if (sqlsocket->state == sockconnected) {
489 (inst->module->sql_close)(sqlsocket, inst->config);
492 /* reconnect the socket */
493 if (connect_single_socket(sqlsocket, inst) < 0) {
494 radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
498 /* retry the query on the newly connected socket */
499 ret = (inst->module->sql_query)(sqlsocket, inst->config, query);
502 radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
503 inst->config->xlat_name);
511 /*************************************************************************
513 * Function: rlm_sql_select_query
515 * Purpose: call the module's sql_select_query and implement re-connect
517 *************************************************************************/
518 int rlm_sql_select_query(SQLSOCK *sqlsocket, SQL_INST *inst, char *query)
523 * If there's no query, return an error.
525 if (!query || !*query) {
529 ret = (inst->module->sql_select_query)(sqlsocket, inst->config, query);
531 if (ret == SQL_DOWN) {
532 /* close the socket that failed */
533 if (sqlsocket->state == sockconnected) {
534 (inst->module->sql_close)(sqlsocket, inst->config);
537 /* reconnect the socket */
538 if (connect_single_socket(sqlsocket, inst) < 0) {
539 radlog(L_ERR, "rlm_sql (%s): reconnect failed, database down?", inst->config->xlat_name);
543 /* retry the query on the newly connected socket */
544 ret = (inst->module->sql_select_query)(sqlsocket, inst->config, query);
547 radlog(L_ERR, "rlm_sql (%s): failed after re-connect",
548 inst->config->xlat_name);
557 /*************************************************************************
559 * Function: sql_getvpdata
561 * Purpose: Get any group check or reply pairs
563 *************************************************************************/
564 int sql_getvpdata(SQL_INST * inst, SQLSOCK * sqlsocket, VALUE_PAIR **pair, char *query)
570 * If there's no query, return an error.
572 if (!query || !*query) {
576 if (rlm_sql_select_query(sqlsocket, inst, query)) {
577 radlog(L_ERR, "rlm_sql_getvpdata: database query error");
580 while (rlm_sql_fetch_row(sqlsocket, inst)==0) {
581 row = sqlsocket->row;
584 if (sql_userparse(pair, row) != 0) {
585 radlog(L_ERR | L_CONS, "rlm_sql (%s): Error getting data from database", inst->config->xlat_name);
586 (inst->module->sql_finish_select_query)(sqlsocket, inst->config);
591 (inst->module->sql_finish_select_query)(sqlsocket, inst->config);
596 void query_log(REQUEST *request, SQL_INST *inst, char *querystr)
598 FILE *sqlfile = NULL;
600 if (inst->config->sqltrace) {
603 if (!radius_xlat(buffer, sizeof(buffer),
604 inst->config->tracefile, request, NULL)) {
605 radlog(L_ERR, "rlm_sql (%s): xlat failed.",
606 inst->config->xlat_name);
610 if ((sqlfile = fopen(buffer, "a")) == (FILE *) NULL) {
611 radlog(L_ERR, "rlm_sql (%s): Couldn't open file %s",
612 inst->config->xlat_name,
615 int fd = fileno(sqlfile);
617 rad_lockfd(fd, MAX_QUERY_LEN);
618 fputs(querystr, sqlfile);
619 fputs(";\n", sqlfile);
620 fclose(sqlfile); /* and release the lock */