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