git.sur5r.net Git - openldap/blob - servers/slapd/back-sql/sql-wrap.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2004 The OpenLDAP Foundation.
   5  * Portions Copyright 1999 Dmitry Kovalev.
   6  * Portions Copyright 2004 Mark Adamson.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  13  * A copy of this license is available in the file LICENSE in the
  14  * top-level directory of the distribution or, alternatively, at
  15  * <http://www.OpenLDAP.org/license.html>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by Dmitry Kovalev for inclusion
  19  * by OpenLDAP Software.
  20  */
  21
  22 #include "portable.h"
  23
  24 #include <stdio.h>
  25 #include "ac/string.h"
  26 #include <sys/types.h>
  27
  28 #include "slap.h"
  29 #include "proto-sql.h"
  30
  31 #define MAX_ATTR_LEN 16384
  32
  33 typedef struct backsql_db_conn {
  34         unsigned long   ldap_cid;
  35         SQLHDBC         dbh;
  36 } backsql_db_conn;
  37
  38 void
  39 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
  40 {
  41         SQLCHAR msg[SQL_MAX_MESSAGE_LENGTH];            /* msg. buffer    */
  42         SQLCHAR state[SQL_SQLSTATE_SIZE];               /* statement buf. */
  43         SDWORD  iSqlCode;                               /* return code    */
  44         SWORD   len = SQL_MAX_MESSAGE_LENGTH - 1;       /* return length  */
  45
  46         Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
  47
  48         for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
  49                         SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); ) {
  50                 Debug( LDAP_DEBUG_TRACE,
  51                                 "   Native error code: %d\n"
  52                                 "   SQL engine state:  %s\n"
  53                                 "   Message:           %s\n",
  54                                 (int)iSqlCode, state, msg );
  55         }
  56 }
  57
  58 RETCODE
  59 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
  60 {
  61         RETCODE         rc;
  62         char            drv_name[ 30 ];
  63         SWORD           len;
  64
  65         rc = SQLAllocStmt( dbh, sth );
  66         if ( rc != SQL_SUCCESS ) {
  67                 return rc;
  68         }
  69
  70 #ifdef BACKSQL_TRACE
  71         Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
  72 #endif /* BACKSQL_TRACE */
  73
  74         SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
  75
  76 #ifdef BACKSQL_TRACE
  77         Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
  78                         drv_name, 0, 0 );
  79 #endif /* BACKSQL_TRACE */
  80
  81         ldap_pvt_str2upper( drv_name );
  82         if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
  83                 /*
  84                  * stupid default result set in MS SQL Server
  85                  * does not support multiple active statements
  86                  * on the same connection -- so we are trying
  87                  * to make it not to use default result set...
  88                  */
  89                 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
  90                         "enabling MS SQL Server default result "
  91                         "set workaround\n", 0, 0, 0 );
  92                 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
  93                                 SQL_CONCUR_ROWVER );
  94                 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
  95                         Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
  96                                 "SQLSetStmtOption(SQL_CONCURRENCY,"
  97                                 "SQL_CONCUR_ROWVER) failed:\n",
  98                                 0, 0, 0 );
  99                         backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
 100                         SQLFreeStmt( *sth, SQL_DROP );
 101                         return rc;
 102                 }
 103         }
 104
 105         if ( timeout > 0 ) {
 106                 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
 107                         "setting query timeout to %d sec.\n",
 108                         timeout, 0, 0 );
 109                 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
 110                 if ( rc != SQL_SUCCESS ) {
 111                         backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
 112                         SQLFreeStmt( *sth, SQL_DROP );
 113                         return rc;
 114                 }
 115         }
 116
 117 #ifdef BACKSQL_TRACE
 118         Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
 119                         0, 0, 0 );
 120 #endif /* BACKSQL_TRACE */
 121
 122         return SQLPrepare( *sth, query, SQL_NTS );
 123 }
 124
 125 RETCODE
 126 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
 127 {
 128         RETCODE         rc;
 129         SQLCHAR         colname[ 64 ];
 130         SQLSMALLINT     name_len, col_type, col_scale, col_null;
 131         UDWORD          col_prec;
 132         int             i;
 133
 134         if ( row == NULL ) {
 135                 return SQL_ERROR;
 136         }
 137
 138 #ifdef BACKSQL_TRACE
 139         Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
 140 #endif /* BACKSQL_TRACE */
 141
 142         rc = SQLNumResultCols( sth, &row->ncols );
 143         if ( rc != SQL_SUCCESS ) {
 144 #ifdef BACKSQL_TRACE
 145                 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
 146                         "SQLNumResultCols() failed:\n", 0, 0, 0 );
 147 #endif /* BACKSQL_TRACE */
 148
 149                 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
 150
 151         } else {
 152 #ifdef BACKSQL_TRACE
 153                 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 154                         "ncols=%d\n", (int)row->ncols, 0, 0 );
 155 #endif /* BACKSQL_TRACE */
 156
 157                 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
 158                                 sizeof( struct berval ) );
 159                 row->cols = (char **)ch_calloc( row->ncols + 1,
 160                                 sizeof( char * ) );
 161                 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
 162                                 sizeof( UDWORD ) );
 163                 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
 164                                 sizeof( SQLINTEGER ) );
 165                 for ( i = 1; i <= row->ncols; i++ ) {
 166                         rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
 167                                         (SQLUINTEGER)( sizeof( colname ) - 1 ),
 168                                         &name_len, &col_type,
 169                                         &col_prec, &col_scale, &col_null );
 170                         ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
 171 #ifdef BACKSQL_TRACE
 172                         Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 173                                 "col_name=%s, col_prec[%d]=%d\n",
 174                                 colname, (int)i, (int)col_prec );
 175 #endif /* BACKSQL_TRACE */
 176                         if ( col_type == SQL_LONGVARCHAR
 177                                         || col_type == SQL_LONGVARBINARY) {
 178 #if 0
 179                                 row->cols[ i - 1 ] = NULL;
 180                                 row->col_prec[ i - 1 ] = -1;
 181
 182                                 /*
 183                                  * such fields must be handled
 184                                  * in some other way since they return 2G
 185                                  * as their precision (at least it does so
 186                                  * with MS SQL Server w/native driver)
 187                                  * for now, we just set fixed precision
 188                                  * for such fields - dirty hack, but...
 189                                  * no time to deal with SQLGetData()
 190                                  */
 191 #endif
 192                                 col_prec = MAX_ATTR_LEN;
 193                                 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
 194                                 row->col_prec[ i - 1 ] = col_prec;
 195                                 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
 196                                                 SQL_C_CHAR,
 197                                                 (SQLPOINTER)row->cols[ i - 1 ],
 198                                                 col_prec + 1,
 199                                                 &row->value_len[ i - 1 ] );
 200                         } else {
 201                                 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
 202                                 row->col_prec[ i - 1 ] = col_prec;
 203                                 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
 204                                                 SQL_C_CHAR,
 205                                                 (SQLPOINTER)row->cols[ i - 1 ],
 206                                                 col_prec + 1,
 207                                                 &row->value_len[ i - 1 ] );
 208                         }
 209                 }
 210
 211                 row->col_names[ i - 1 ].bv_val = NULL;
 212                 row->col_names[ i - 1 ].bv_len = 0;
 213                 row->cols[ i - 1 ] = NULL;
 214         }
 215
 216 #ifdef BACKSQL_TRACE
 217         Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
 218 #endif /* BACKSQL_TRACE */
 219
 220         return rc;
 221 }
 222
 223 RETCODE
 224 backsql_FreeRow( BACKSQL_ROW_NTS *row )
 225 {
 226         if ( row->cols == NULL ) {
 227                 return SQL_ERROR;
 228         }
 229
 230         ber_bvarray_free( row->col_names );
 231         ldap_charray_free( row->cols );
 232         free( row->col_prec );
 233         free( row->value_len );
 234
 235         return SQL_SUCCESS;
 236 }
 237
 238 static int
 239 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
 240 {
 241         const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
 242         if ( c1->ldap_cid > c2->ldap_cid ) {
 243                 return 1;
 244         }
 245
 246         if ( c1->ldap_cid < c2->ldap_cid ) {
 247                 return -1;
 248         }
 249
 250         return 0;
 251 }
 252
 253 static int
 254 backsql_close_db_conn( backsql_db_conn *conn )
 255 {
 256         Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
 257
 258         /*
 259          * Default transact is SQL_ROLLBACK; commit is required only
 260          * by write operations, and it is explicitly performed after
 261          * each atomic operation succeeds.
 262          */
 263
 264         /* TimesTen */
 265         SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
 266         SQLDisconnect( conn->dbh );
 267         SQLFreeConnect( conn->dbh );
 268         Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
 269         return 1;
 270 }
 271
 272 int
 273 backsql_init_db_env( backsql_info *bi )
 274 {
 275         RETCODE         rc;
 276         int             ret = SQL_SUCCESS;
 277
 278         Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
 279         rc = SQLAllocEnv( &bi->sql_db_env );
 280         if ( rc != SQL_SUCCESS ) {
 281                 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
 282                                 0, 0, 0 );
 283                 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
 284                                 SQL_NULL_HENV, rc );
 285                 ret = SQL_ERROR;
 286         }
 287         Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
 288         return ret;
 289 }
 290
 291 int
 292 backsql_free_db_env( backsql_info *bi )
 293 {
 294         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
 295
 296 #ifdef BACKSQL_TRACE
 297         Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
 298                         0, 0, 0 );
 299 #endif /* BACKSQL_TRACE */
 300
 301         /*
 302          * stop, if frontend waits for all threads to shutdown
 303          * before calling this -- then what are we going to delete??
 304          * everything is already deleted...
 305          */
 306         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
 307         return SQL_SUCCESS;
 308 }
 309
 310 static int
 311 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
 312 {
 313         /* TimesTen */
 314         char                    DBMSName[ 32 ];
 315         backsql_db_conn         *dbc;
 316         int                     rc;
 317
 318         assert( pdbc );
 319         *pdbc = NULL;
 320
 321         Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
 322         dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
 323         dbc->ldap_cid = ldap_cid;
 324         rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
 325         if ( !BACKSQL_SUCCESS( rc ) ) {
 326                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 327                         "SQLAllocConnect() failed:\n", 0, 0, 0 );
 328                 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
 329                                 SQL_NULL_HENV, rc );
 330                 return LDAP_UNAVAILABLE;
 331         }
 332
 333         rc = SQLConnect( dbc->dbh,
 334                         (SQLCHAR*)bi->sql_dbname, SQL_NTS,
 335                         (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
 336                         (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
 337         if ( rc != SQL_SUCCESS ) {
 338                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 339                         "SQLConnect() to database \"%s\" as user \"%s\" "
 340                         "%s:\n", bi->sql_dbname, bi->sql_dbuser,
 341                         rc == SQL_SUCCESS_WITH_INFO ?
 342                         "succeeded with info" : "failed" );
 343                 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
 344                 if ( rc != SQL_SUCCESS_WITH_INFO ) {
 345                         return LDAP_UNAVAILABLE;
 346                 }
 347         }
 348
 349         /*
 350          * TimesTen : Turn off autocommit.  We must explicitly
 351          * commit any transactions.
 352          */
 353         SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
 354
 355         /*
 356          * See if this connection is to TimesTen.  If it is,
 357          * remember that fact for later use.
 358          */
 359         /* Assume until proven otherwise */
 360         bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
 361         DBMSName[ 0 ] = '\0';
 362         rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
 363                         sizeof( DBMSName ), NULL );
 364         if ( rc == SQL_SUCCESS ) {
 365                 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
 366                                 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
 367                         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 368                                 "TimesTen database!\n", 0, 0, 0 );
 369                         bi->sql_flags |= BSQLF_USE_REVERSE_DN;
 370                 }
 371         } else {
 372                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 373                         "SQLGetInfo() failed:\n", 0, 0, 0 );
 374                 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
 375                 return rc;
 376         }
 377         /* end TimesTen */
 378
 379         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
 380                 "connected, adding to tree\n", 0, 0, 0 );
 381         ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
 382         if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
 383                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 384                         "duplicate connection ID\n", 0, 0, 0 );
 385                 return LDAP_OTHER;
 386         }
 387         ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
 388         Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
 389
 390         *pdbc = dbc;
 391
 392         return LDAP_SUCCESS;
 393 }
 394
 395 int
 396 backsql_free_db_conn( Operation *op )
 397 {
 398         backsql_info            *bi = (backsql_info *)op->o_bd->be_private;
 399         backsql_db_conn         tmp = { 0 },
 400                                 *conn;
 401
 402         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
 403         tmp.ldap_cid = op->o_connid;
 404         ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
 405         conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
 406         ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
 407
 408         /*
 409          * we have one thread per connection, as I understand -- so we can
 410          * get this out of critical section
 411          */
 412         if ( conn != NULL ) {
 413                 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
 414                         "closing db connection\n", 0, 0, 0 );
 415                 backsql_close_db_conn( conn );
 416         }
 417         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
 418         return SQL_SUCCESS;
 419 }
 420
 421 int
 422 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
 423 {
 424         backsql_info            *bi = (backsql_info *)op->o_bd->be_private;
 425         backsql_db_conn         *dbc,
 426                                 tmp = { 0 };
 427         int                     rc = LDAP_SUCCESS;
 428
 429         Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
 430
 431         assert( dbh );
 432         *dbh = SQL_NULL_HDBC;
 433
 434         tmp.ldap_cid = op->o_connid;
 435
 436         /*
 437          * we have one thread per connection, as I understand --
 438          * so we do not need locking here
 439          */
 440         dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
 441         if ( !dbc ) {
 442                 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
 443                 if ( rc != LDAP_SUCCESS) {
 444                         Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 445                                 "could not get connection handle "
 446                                 "-- returning NULL\n", 0, 0, 0 );
 447                         return rc;
 448                 }
 449         }
 450
 451         ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
 452         if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
 453                 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 454                         "first call -- reading schema map\n", 0, 0, 0 );
 455                 rc = backsql_load_schema_map( bi, dbc->dbh );
 456                 if ( rc != LDAP_SUCCESS ) {
 457                         ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
 458                         backsql_free_db_conn( op );
 459                         return rc;
 460                 }
 461         }
 462         ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
 463
 464         *dbh = dbc->dbh;
 465
 466         Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
 467
 468         return LDAP_SUCCESS;
 469 }
 470