src/modules/rlm_sql/drivers/rlm_sql_mysql/sql_mysql.c

   1 /*
   2  * sql_mysql.c          SQL Module
   3  *
   4  * Version:     $Id$
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Copyright 2000  The FreeRADIUS server project
  21  * Copyright 2000  Mike Machado <mike@innercite.com>
  22  * Copyright 2000  Alan DeKok <aland@ox.org>
  23  */
  24
  25 #include <stdio.h>
  26 #include <sys/stat.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include        "radiusd.h"
  31
  32 #include "config.h"
  33
  34 #ifdef HAVE_MYSQL_MYSQL_H
  35 #include <mysql/errmsg.h>
  36 #include <mysql/mysql.h>
  37 #else
  38 #ifdef HAVE_MYSQL_H
  39 #include <errmsg.h>
  40 #include <mysql.h>
  41 #endif
  42 #endif
  43
  44 #include        "rlm_sql.h"
  45
  46 typedef struct rlm_sql_mysql_sock {
  47         MYSQL conn;
  48         MYSQL *sock;
  49         MYSQL_RES *result;
  50         SQL_ROW row;
  51 } rlm_sql_mysql_sock;
  52
  53 /*************************************************************************
  54  *
  55  *      Function: sql_create_socket
  56  *
  57  *      Purpose: Establish connection to the db
  58  *
  59  *************************************************************************/
  60 static int sql_init_socket(SQLSOCK *sqlsocket, SQL_CONFIG *config)
  61 {
  62         rlm_sql_mysql_sock *mysql_sock;
  63
  64         if (!sqlsocket->conn) {
  65                 sqlsocket->conn = (rlm_sql_mysql_sock *)rad_malloc(sizeof(rlm_sql_mysql_sock));
  66                 if (!sqlsocket->conn) {
  67                         return -1;
  68                 }
  69         }
  70         mysql_sock = sqlsocket->conn;
  71         memset(mysql_sock, 0, sizeof(*mysql_sock));
  72
  73         radlog(L_INFO, "rlm_sql_mysql: Starting connect to MySQL server for #%d",
  74                         sqlsocket->id);
  75
  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),
  79                                                     config->sql_server,
  80                                                     config->sql_login,
  81                                                     config->sql_password,
  82                                                     config->sql_db,
  83                                                     atoi(config->sql_port),
  84                                                     NULL,
  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;
  89                 return -1;
  90         }
  91
  92
  93         return 0;
  94 }
  95
  96
  97 /*************************************************************************
  98  *
  99  *      Function: sql_destroy_socket
 100  *
 101  *      Purpose: Free socket and any private connection data
 102  *
 103  *************************************************************************/
 104 static int sql_destroy_socket(SQLSOCK *sqlsocket, SQL_CONFIG *config)
 105 {
 106         free(sqlsocket->conn);
 107         sqlsocket->conn = NULL;
 108
 109         return 0;
 110 }
 111
 112
 113 /*************************************************************************
 114  *
 115  *      Function: sql_check_error
 116  *
 117  *      Purpose: check the error to see if the server is down
 118  *
 119  *************************************************************************/
 120 static int sql_check_error(int error)
 121 {
 122         switch(error) {
 123         case CR_SERVER_GONE_ERROR:
 124         case CR_SERVER_LOST:
 125         case -1:
 126                 radlog(L_DBG, "rlm_sql_mysql: MYSQL check_error: %d, returning SQL_DOWN", error);
 127                 return SQL_DOWN;
 128                 break;
 129         case 0:
 130                 return 0;
 131                 break;
 132         case CR_OUT_OF_MEMORY:
 133         case CR_COMMANDS_OUT_OF_SYNC:
 134         case CR_UNKNOWN_ERROR:
 135         default:
 136                 radlog(L_DBG, "rlm_sql_mysql: MYSQL check_error: %d received", error);
 137                 return -1;
 138                 break;
 139         }
 140 }
 141
 142
 143 /*************************************************************************
 144  *
 145  *      Function: sql_query
 146  *
 147  *      Purpose: Issue a query to the database
 148  *
 149  *************************************************************************/
 150 static int sql_query(SQLSOCK * sqlsocket, SQL_CONFIG *config, char *querystr)
 151 {
 152         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 153
 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");
 158                 return SQL_DOWN;
 159         }
 160
 161         mysql_query(mysql_sock->sock, querystr);
 162         return sql_check_error(mysql_errno(mysql_sock->sock));
 163 }
 164
 165
 166 /*************************************************************************
 167  *
 168  *      Function: sql_store_result
 169  *
 170  *      Purpose: database specific store_result function. Returns a result
 171  *               set for the query.
 172  *
 173  *************************************************************************/
 174 static int sql_store_result(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 175 {
 176         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 177
 178         if (mysql_sock->sock == NULL) {
 179                 radlog(L_ERR, "rlm_sql_mysql: Socket not connected");
 180                 return SQL_DOWN;
 181         }
 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));
 187         }
 188         return 0;
 189 }
 190
 191
 192 /*************************************************************************
 193  *
 194  *      Function: sql_num_fields
 195  *
 196  *      Purpose: database specific num_fields function. Returns number
 197  *               of columns from query
 198  *
 199  *************************************************************************/
 200 static int sql_num_fields(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 201 {
 202         int     num = 0;
 203         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 204
 205 #if MYSQL_VERSION_ID >= 32224
 206         if (!(num = mysql_field_count(mysql_sock->sock))) {
 207 #else
 208         if (!(num = mysql_num_fields(mysql_sock->sock))) {
 209 #endif
 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));
 213         }
 214         return num;
 215 }
 216
 217
 218 /*************************************************************************
 219  *
 220  *      Function: sql_select_query
 221  *
 222  *      Purpose: Issue a select query to the database
 223  *
 224  *************************************************************************/
 225 static int sql_select_query(SQLSOCK *sqlsocket, SQL_CONFIG *config,
 226                             char *querystr)
 227 {
 228         int ret;
 229
 230         ret = sql_query(sqlsocket, config, querystr);
 231         if(ret)
 232                 return ret;
 233         ret = sql_store_result(sqlsocket, config);
 234         if (ret) {
 235                 return ret;
 236         }
 237
 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
 240          * fields are found?
 241          */
 242         sql_num_fields(sqlsocket, config);
 243
 244         return ret;
 245 }
 246
 247
 248 /*************************************************************************
 249  *
 250  *      Function: sql_num_rows
 251  *
 252  *      Purpose: database specific num_rows. Returns number of rows in
 253  *               query
 254  *
 255  *************************************************************************/
 256 static int sql_num_rows(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 257 {
 258         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 259
 260         if (mysql_sock->result)
 261                 return mysql_num_rows(mysql_sock->result);
 262
 263         return 0;
 264 }
 265
 266
 267 /*************************************************************************
 268  *
 269  *      Function: sql_fetch_row
 270  *
 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.
 274  *
 275  *************************************************************************/
 276 static int sql_fetch_row(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 277 {
 278         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 279
 280         /*
 281          *  Check pointer before de-referencing it.
 282          */
 283         if (!mysql_sock->result) {
 284                 return SQL_DOWN;
 285         }
 286
 287         sqlsocket->row = mysql_fetch_row(mysql_sock->result);
 288
 289         if (sqlsocket->row == NULL) {
 290                 return sql_check_error(mysql_errno(mysql_sock->sock));
 291         }
 292         return 0;
 293 }
 294
 295
 296 /*************************************************************************
 297  *
 298  *      Function: sql_free_result
 299  *
 300  *      Purpose: database specific free_result. Frees memory allocated
 301  *               for a result set
 302  *
 303  *************************************************************************/
 304 static int sql_free_result(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 305 {
 306         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 307
 308         if (mysql_sock->result) {
 309                 mysql_free_result(mysql_sock->result);
 310                 mysql_sock->result = NULL;
 311         }
 312
 313         return 0;
 314 }
 315
 316
 317
 318 /*************************************************************************
 319  *
 320  *      Function: sql_error
 321  *
 322  *      Purpose: database specific error. Returns error associated with
 323  *               connection
 324  *
 325  *************************************************************************/
 326 static char *sql_error(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 327 {
 328         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 329
 330         if (mysql_sock == NULL || mysql_sock->sock == NULL) {
 331                 return "rlm_sql_mysql: no connection to db";
 332         }
 333         return mysql_error(mysql_sock->sock);
 334 }
 335
 336
 337 /*************************************************************************
 338  *
 339  *      Function: sql_close
 340  *
 341  *      Purpose: database specific close. Closes an open database
 342  *               connection
 343  *
 344  *************************************************************************/
 345 static int sql_close(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 346 {
 347         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 348
 349         if (mysql_sock && mysql_sock->sock){
 350                 mysql_close(mysql_sock->sock);
 351                 mysql_sock->sock = NULL;
 352         }
 353
 354         return 0;
 355 }
 356
 357
 358 /*************************************************************************
 359  *
 360  *      Function: sql_finish_query
 361  *
 362  *      Purpose: End the query, such as freeing memory
 363  *
 364  *************************************************************************/
 365 static int sql_finish_query(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 366 {
 367         return 0;
 368 }
 369
 370
 371
 372 /*************************************************************************
 373  *
 374  *      Function: sql_finish_select_query
 375  *
 376  *      Purpose: End the select query, such as freeing memory or result
 377  *
 378  *************************************************************************/
 379 static int sql_finish_select_query(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 380 {
 381         sql_free_result(sqlsocket, config);
 382
 383         return 0;
 384 }
 385
 386
 387 /*************************************************************************
 388  *
 389  *      Function: sql_affected_rows
 390  *
 391  *      Purpose: End the select query, such as freeing memory or result
 392  *
 393  *************************************************************************/
 394 static int sql_affected_rows(SQLSOCK * sqlsocket, SQL_CONFIG *config)
 395 {
 396         rlm_sql_mysql_sock *mysql_sock = sqlsocket->conn;
 397
 398         return mysql_affected_rows(mysql_sock->sock);
 399 }
 400
 401
 402 /* Exported to rlm_sql */
 403 rlm_sql_module_t rlm_sql_mysql = {
 404         "rlm_sql_mysql",
 405         sql_init_socket,
 406         sql_destroy_socket,
 407         sql_query,
 408         sql_select_query,
 409         sql_store_result,
 410         sql_num_fields,
 411         sql_num_rows,
 412         sql_fetch_row,
 413         sql_free_result,
 414         sql_error,
 415         sql_close,
 416         sql_finish_query,
 417         sql_finish_select_query,
 418         sql_affected_rows
 419 };