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