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