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 "ldap_pvt.h"
  31 #include "proto-sql.h"
  32
  33 #define MAX_ATTR_LEN 16384
  34
  35 typedef struct backsql_conn {
  36         int             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
  51         rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
  52                         SQL_MAX_MESSAGE_LENGTH - 1, &len );
  53         for ( ; BACKSQL_SUCCESS( rc ); ) {
  54                 Debug( LDAP_DEBUG_TRACE, "Native error code: %d\n",
  55                                 (int)iSqlCode, 0, 0 );
  56                 Debug( LDAP_DEBUG_TRACE, "SQL engine state: %s\n",
  57                                 state, 0, 0 );
  58                 Debug( LDAP_DEBUG_TRACE, "Message: %s\n", msg, 0, 0 );
  59                 rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
  60                                 SQL_MAX_MESSAGE_LENGTH - 1, &len );
  61         }
  62 }
  63
  64 RETCODE
  65 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
  66 {
  67         RETCODE         rc;
  68         char            drv_name[ 30 ];
  69         SWORD           len;
  70
  71         rc = SQLAllocStmt( dbh, sth );
  72         if ( rc != SQL_SUCCESS ) {
  73                 return rc;
  74         }
  75
  76 #ifdef BACKSQL_TRACE
  77         Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
  78 #endif /* BACKSQL_TRACE */
  79
  80         SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
  81
  82 #ifdef BACKSQL_TRACE
  83         Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
  84                         drv_name, 0, 0 );
  85 #endif /* BACKSQL_TRACE */
  86
  87         ldap_pvt_str2upper( drv_name );
  88         if ( !strncmp( drv_name, "SQLSRV32.DLL", sizeof( drv_name ) ) ) {
  89                 /*
  90                  * stupid default result set in MS SQL Server
  91                  * does not support multiple active statements
  92                  * on the same connection -- so we are trying
  93                  * to make it not to use default result set...
  94                  */
  95                 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
  96                         "enabling MS SQL Server default result "
  97                         "set workaround\n", 0, 0, 0 );
  98                 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
  99                                 SQL_CONCUR_ROWVER );
 100                 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
 101                         Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
 102                                 "SQLSetStmtOption(SQL_CONCURRENCY,"
 103                                 "SQL_CONCUR_ROWVER) failed:\n",
 104                                 0, 0, 0 );
 105                         backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
 106                 }
 107         }
 108
 109         if ( timeout > 0 ) {
 110                 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
 111                         "setting query timeout to %d sec.\n",
 112                         timeout, 0, 0 );
 113                 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
 114                 if ( rc != SQL_SUCCESS ) {
 115                         backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, 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         } 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 *si )
 275 {
 276         RETCODE         rc;
 277
 278         Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
 279         rc = SQLAllocEnv( &si->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         }
 286         Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()\n", 0, 0, 0 );
 287         return SQL_SUCCESS;
 288 }
 289
 290 int
 291 backsql_free_db_env( backsql_info *si )
 292 {
 293         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
 294
 295 #ifdef BACKSQL_TRACE
 296         Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
 297                         0, 0, 0 );
 298 #endif /* BACKSQL_TRACE */
 299
 300         /*
 301          * stop, if frontend waits for all threads to shutdown
 302          * before calling this -- then what are we going to delete??
 303          * everything is already deleted...
 304          */
 305         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
 306         return SQL_SUCCESS;
 307 }
 308
 309 static int
 310 backsql_open_db_conn( backsql_info *si, int ldap_cid, backsql_db_conn **pdbc )
 311 {
 312         /* TimesTen */
 313         char                    DBMSName[ 32 ];
 314         backsql_db_conn         *dbc;
 315         int                     rc;
 316
 317         assert( pdbc );
 318         *pdbc = NULL;
 319
 320         Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
 321         dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
 322         dbc->ldap_cid = ldap_cid;
 323         rc = SQLAllocConnect( si->db_env, &dbc->dbh );
 324         if ( !BACKSQL_SUCCESS( rc ) ) {
 325                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 326                         "SQLAllocConnect() failed:\n", 0, 0, 0 );
 327                 backsql_PrintErrors( si->db_env, SQL_NULL_HDBC,
 328                                 SQL_NULL_HENV, rc );
 329                 return LDAP_UNAVAILABLE;
 330         }
 331
 332         rc = SQLConnect( dbc->dbh, si->dbname, SQL_NTS, si->dbuser,
 333                         SQL_NTS, si->dbpasswd, SQL_NTS );
 334         if ( rc != SQL_SUCCESS ) {
 335                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 336                         "SQLConnect() to database \"%s\" as user \"%s\" "
 337                         "%s:\n", si->dbname, si->dbuser,
 338                         rc == SQL_SUCCESS_WITH_INFO ?
 339                         "succeeded with info" : "failed" );
 340                 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
 341                 if ( rc != SQL_SUCCESS_WITH_INFO ) {
 342                         return LDAP_UNAVAILABLE;
 343                 }
 344         }
 345
 346         /*
 347          * TimesTen : Turn off autocommit.  We must explicitly
 348          * commit any transactions.
 349          */
 350         SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
 351
 352         /*
 353          * See if this connection is to TimesTen.  If it is,
 354          * remember that fact for later use.
 355          */
 356         /* Assume until proven otherwise */
 357         si->bsql_flags &= ~BSQLF_USE_REVERSE_DN;
 358         DBMSName[ 0 ] = '\0';
 359         rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
 360                         sizeof( DBMSName ), NULL );
 361         if ( rc == SQL_SUCCESS ) {
 362                 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
 363                                 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
 364                         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 365                                 "TimesTen database!\n", 0, 0, 0 );
 366                         si->bsql_flags |= BSQLF_USE_REVERSE_DN;
 367                 }
 368         } else {
 369                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 370                         "SQLGetInfo() failed:\n", 0, 0, 0 );
 371                 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
 372                 return rc;
 373         }
 374         /* end TimesTen */
 375
 376         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
 377                 "connected, adding to tree\n", 0, 0, 0 );
 378         ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
 379         if ( avl_insert( &si->db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
 380                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 381                         "duplicate connection ID\n", 0, 0, 0 );
 382                 return LDAP_OTHER;
 383         }
 384         ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
 385         Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
 386
 387         *pdbc = dbc;
 388
 389         return LDAP_SUCCESS;
 390 }
 391
 392 int
 393 backsql_free_db_conn( Operation *op )
 394 {
 395         backsql_info            *si = (backsql_info *)op->o_bd->be_private;
 396         backsql_db_conn         tmp, *conn;
 397
 398         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
 399         tmp.ldap_cid = op->o_connid;
 400         ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
 401         conn = avl_delete( &si->db_conns, &tmp, backsql_cmp_connid );
 402         ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
 403
 404         /*
 405          * we have one thread per connection, as I understand -- so we can
 406          * get this out of critical section
 407          */
 408         if ( conn != NULL ) {
 409                 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
 410                         "closing db connection\n", 0, 0, 0 );
 411                 backsql_close_db_conn( conn );
 412         }
 413         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
 414         return SQL_SUCCESS;
 415 }
 416
 417 int
 418 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
 419 {
 420         backsql_info            *si = (backsql_info *)op->o_bd->be_private;
 421         backsql_db_conn         *dbc;
 422         backsql_db_conn         tmp;
 423         int                     rc = LDAP_SUCCESS;
 424
 425         Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
 426
 427         assert( dbh );
 428         *dbh = SQL_NULL_HDBC;
 429
 430         tmp.ldap_cid = op->o_connid;
 431
 432         /*
 433          * we have one thread per connection, as I understand --
 434          * so we do not need locking here
 435          */
 436         dbc = avl_find( si->db_conns, &tmp, backsql_cmp_connid );
 437         if ( !dbc ) {
 438                 rc = backsql_open_db_conn( si, op->o_connid, &dbc );
 439                 if ( rc != LDAP_SUCCESS) {
 440                         Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 441                                 "could not get connection handle "
 442                                 "-- returning NULL\n", 0, 0, 0 );
 443                         return rc;
 444                 }
 445         }
 446
 447         ldap_pvt_thread_mutex_lock( &si->schema_mutex );
 448         if ( !BACKSQL_SCHEMA_LOADED( si ) ) {
 449                 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
 450                         "first call -- reading schema map\n", 0, 0, 0 );
 451                 rc = backsql_load_schema_map( si, dbc->dbh );
 452                 if ( rc != LDAP_SUCCESS ) {
 453                         ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
 454                         backsql_free_db_conn( op );
 455                         return rc;
 456                 }
 457         }
 458         ldap_pvt_thread_mutex_unlock( &si->schema_mutex );
 459
 460         *dbh = dbc->dbh;
 461
 462         Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );
 463
 464         return LDAP_SUCCESS;
 465 }
 466
 467 #endif /* SLAPD_SQL */
 468