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