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