git.sur5r.net Git - openldap/blob - servers/slapd/back-sql/sql-wrap.c

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