2 * sql_mysql.c SQL Module
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2000 The FreeRADIUS server project
21 * Copyright 2000 Mike Machado <mike@innercite.com>
22 * Copyright 2000 Alan DeKok <aland@ox.org>
34 #ifdef HAVE_MYSQL_MYSQL_H
35 #include <mysql/errmsg.h>
36 #include <mysql/mysql.h>
46 typedef struct rlm_sql_mysql_sock {
53 /*************************************************************************
55 * Function: sql_create_socket
57 * Purpose: Establish connection to the db
59 *************************************************************************/
60 static int sql_init_socket(SQLSOCK *sqlsocket, SQL_CONFIG *config)
62 rlm_sql_mysql_sock *mysql_sock;
64 if (!sqlsocket->conn) {
65 sqlsocket->conn = (rlm_sql_mysql_sock *)rad_malloc(sizeof(rlm_sql_mysql_sock));
66 if (!sqlsocket->conn) {
70 mysql_sock = sqlsocket->conn;
71 memset(mysql_sock, 0, sizeof(*mysql_sock));
73 radlog(L_INFO, "rlm_sql_mysql: Starting connect to MySQL server for #%d",
76 mysql_init(&(mysql_sock->conn));
77 mysql_options(&(mysql_sock->conn), MYSQL_READ_DEFAULT_GROUP, "freeradius");
78 if (!(mysql_sock->sock = mysql_real_connect(&(mysql_sock->conn),
83 atoi(config->sql_port),
85 CLIENT_FOUND_ROWS))) {
86 radlog(L_ERR, "rlm_sql_mysql: Couldn't connect socket to MySQL server %s@%s:%s", config->sql_login, config->sql_server, config->sql_db);
87 radlog(L_ERR, "rlm_sql_mysql: Mysql error '%s'", mysql_error(&mysql_sock->conn));
88 mysql_sock->sock = NULL;
97 /*************************************************************************
99 * Function: sql_destroy_socket
101 * Purpose: Free socket and any private connection data
103 *************************************************************************/
104 static int sql_destroy_socket(SQLSOCK *sqlsocket, SQL_CONFIG *config)
106 free(sqlsocket->conn);
107 sqlsocket->conn = NULL;
113 /*************************************************************************
115 * Function: sql_check_error
117 * Purpose: check the error to see if the server is down
119 *************************************************************************/
120 static int sql_check_error(int error)
123 case CR_SERVER_GONE_ERROR:
126 radlog(L_DBG, "rlm_sql_mysql: MYSQL check_error: %d, returning SQL_DOWN", error);
132 case CR_OUT_OF_MEMORY:
133 case CR_COMMANDS_OUT_OF_SYNC:
134 case CR_UNKNOWN_ERROR:
136 radlog(L_DBG, "rlm_sql_mysql: MYSQL check_error: %d received", error);
143 /*************************************************************************
145 * Function: sql_query
147 * Purpose: Issue a query to the database
149 *************************************************************************/
150 static int sql_query(SQLSOCK * sqlsocket, SQL_CONFIG *config, char *querystr)
152 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
154 if (config->sqltrace)
155 radlog(L_DBG,"rlm_sql_mysql: query: %s", querystr);
156 if (mysql_sock->sock == NULL) {
157 radlog(L_ERR, "rlm_sql_mysql: Socket not connected");
161 mysql_query(mysql_sock->sock, querystr);
162 return sql_check_error(mysql_errno(mysql_sock->sock));
166 /*************************************************************************
168 * Function: sql_store_result
170 * Purpose: database specific store_result function. Returns a result
173 *************************************************************************/
174 static int sql_store_result(SQLSOCK * sqlsocket, SQL_CONFIG *config)
176 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
178 if (mysql_sock->sock == NULL) {
179 radlog(L_ERR, "rlm_sql_mysql: Socket not connected");
182 if (!(mysql_sock->result = mysql_store_result(mysql_sock->sock))) {
183 radlog(L_ERR, "rlm_sql_mysql: MYSQL Error: Cannot get result");
184 radlog(L_ERR, "rlm_sql_mysql: MYSQL Error: %s",
185 mysql_error(mysql_sock->sock));
186 return sql_check_error(mysql_errno(mysql_sock->sock));
192 /*************************************************************************
194 * Function: sql_num_fields
196 * Purpose: database specific num_fields function. Returns number
197 * of columns from query
199 *************************************************************************/
200 static int sql_num_fields(SQLSOCK * sqlsocket, SQL_CONFIG *config)
203 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
205 #if MYSQL_VERSION_ID >= 32224
206 if (!(num = mysql_field_count(mysql_sock->sock))) {
208 if (!(num = mysql_num_fields(mysql_sock->sock))) {
210 radlog(L_ERR, "rlm_sql_mysql: MYSQL Error: No Fields");
211 radlog(L_ERR, "rlm_sql_mysql: MYSQL error: %s",
212 mysql_error(mysql_sock->sock));
218 /*************************************************************************
220 * Function: sql_select_query
222 * Purpose: Issue a select query to the database
224 *************************************************************************/
225 static int sql_select_query(SQLSOCK *sqlsocket, SQL_CONFIG *config,
230 ret = sql_query(sqlsocket, config, querystr);
233 ret = sql_store_result(sqlsocket, config);
238 /* Why? Per http://www.mysql.com/doc/n/o/node_591.html,
239 * this cannot return an error. Perhaps just to complain if no
242 sql_num_fields(sqlsocket, config);
248 /*************************************************************************
250 * Function: sql_num_rows
252 * Purpose: database specific num_rows. Returns number of rows in
255 *************************************************************************/
256 static int sql_num_rows(SQLSOCK * sqlsocket, SQL_CONFIG *config)
258 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
260 if (mysql_sock->result)
261 return mysql_num_rows(mysql_sock->result);
267 /*************************************************************************
269 * Function: sql_fetch_row
271 * Purpose: database specific fetch_row. Returns a SQL_ROW struct
272 * with all the data for the query in 'sqlsocket->row'. Returns
273 * 0 on success, -1 on failure, SQL_DOWN if database is down.
275 *************************************************************************/
276 static int sql_fetch_row(SQLSOCK * sqlsocket, SQL_CONFIG *config)
278 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
281 * Check pointer before de-referencing it.
283 if (!mysql_sock->result) {
287 sqlsocket->row = mysql_fetch_row(mysql_sock->result);
289 if (sqlsocket->row == NULL) {
290 return sql_check_error(mysql_errno(mysql_sock->sock));
296 /*************************************************************************
298 * Function: sql_free_result
300 * Purpose: database specific free_result. Frees memory allocated
303 *************************************************************************/
304 static int sql_free_result(SQLSOCK * sqlsocket, SQL_CONFIG *config)
306 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
308 if (mysql_sock->result) {
309 mysql_free_result(mysql_sock->result);
310 mysql_sock->result = NULL;
318 /*************************************************************************
320 * Function: sql_error
322 * Purpose: database specific error. Returns error associated with
325 *************************************************************************/
326 static char *sql_error(SQLSOCK * sqlsocket, SQL_CONFIG *config)
328 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
330 if (mysql_sock == NULL || mysql_sock->sock == NULL) {
331 return "rlm_sql_mysql: no connection to db";
333 return mysql_error(mysql_sock->sock);
337 /*************************************************************************
339 * Function: sql_close
341 * Purpose: database specific close. Closes an open database
344 *************************************************************************/
345 static int sql_close(SQLSOCK * sqlsocket, SQL_CONFIG *config)
347 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
349 if (mysql_sock && mysql_sock->sock){
350 mysql_close(mysql_sock->sock);
351 mysql_sock->sock = NULL;
358 /*************************************************************************
360 * Function: sql_finish_query
362 * Purpose: End the query, such as freeing memory
364 *************************************************************************/
365 static int sql_finish_query(SQLSOCK * sqlsocket, SQL_CONFIG *config)
372 /*************************************************************************
374 * Function: sql_finish_select_query
376 * Purpose: End the select query, such as freeing memory or result
378 *************************************************************************/
379 static int sql_finish_select_query(SQLSOCK * sqlsocket, SQL_CONFIG *config)
381 sql_free_result(sqlsocket, config);
387 /*************************************************************************
389 * Function: sql_affected_rows
391 * Purpose: End the select query, such as freeing memory or result
393 *************************************************************************/
394 static int sql_affected_rows(SQLSOCK * sqlsocket, SQL_CONFIG *config)
396 rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
398 return mysql_affected_rows(mysql_sock->sock);
402 /* Exported to rlm_sql */
403 rlm_sql_module_t rlm_sql_mysql = {
417 sql_finish_select_query,