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