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_db_conn {
  36         unsigned long   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
 149         } else {
 150 #ifdef BACKSQL_TRACE
 151                 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 152                         "ncols=%d\n", (int)row->ncols, 0, 0 );
 153 #endif /* BACKSQL_TRACE */
 154
 155                 row->col_names = (BerVarray)ch_calloc( row->ncols + 1,
 156                                 sizeof( struct berval ) );
 157                 row->cols = (char **)ch_calloc( row->ncols + 1,
 158                                 sizeof( char * ) );
 159                 row->col_prec = (UDWORD *)ch_calloc( row->ncols,
 160                                 sizeof( UDWORD ) );
 161                 row->value_len = (SQLINTEGER *)ch_calloc( row->ncols,
 162                                 sizeof( SQLINTEGER ) );
 163                 for ( i = 1; i <= row->ncols; i++ ) {
 164                         rc = SQLDescribeCol( sth, (SQLSMALLINT)i, &colname[ 0 ],
 165                                         (SQLUINTEGER)( sizeof( colname ) - 1 ),
 166                                         &name_len, &col_type,
 167                                         &col_prec, &col_scale, &col_null );
 168                         ber_str2bv( colname, 0, 1, &row->col_names[ i - 1 ] );
 169 #ifdef BACKSQL_TRACE
 170                         Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
 171                                 "col_name=%s, col_prec[%d]=%d\n",
 172                                 colname, (int)i, (int)col_prec );
 173 #endif /* BACKSQL_TRACE */
 174                         if ( col_type == SQL_LONGVARCHAR
 175                                         || col_type == SQL_LONGVARBINARY) {
 176 #if 0
 177                                 row->cols[ i - 1 ] = NULL;
 178                                 row->col_prec[ i - 1 ] = -1;
 179
 180                                 /*
 181                                  * such fields must be handled
 182                                  * in some other way since they return 2G
 183                                  * as their precision (at least it does so
 184                                  * with MS SQL Server w/native driver)
 185                                  * for now, we just set fixed precision
 186                                  * for such fields - dirty hack, but...
 187                                  * no time to deal with SQLGetData()
 188                                  */
 189 #endif
 190                                 col_prec = MAX_ATTR_LEN;
 191                                 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
 192                                 row->col_prec[ i - 1 ] = col_prec;
 193                                 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
 194                                                 SQL_C_CHAR,
 195                                                 (SQLPOINTER)row->cols[ i - 1 ],
 196                                                 col_prec + 1,
 197                                                 &row->value_len[ i - 1 ] );
 198                         } else {
 199                                 row->cols[ i - 1 ] = (char *)ch_calloc( col_prec + 1, sizeof( char ) );
 200                                 row->col_prec[ i - 1 ] = col_prec;
 201                                 rc = SQLBindCol( sth, (SQLUSMALLINT)i,
 202                                                 SQL_C_CHAR,
 203                                                 (SQLPOINTER)row->cols[ i - 1 ],
 204                                                 col_prec + 1,
 205                                                 &row->value_len[ i - 1 ] );
 206                         }
 207                 }
 208
 209                 row->col_names[ i - 1 ].bv_val = NULL;
 210                 row->col_names[ i - 1 ].bv_len = 0;
 211                 row->cols[ i - 1 ] = NULL;
 212         }
 213
 214 #ifdef BACKSQL_TRACE
 215         Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
 216 #endif /* BACKSQL_TRACE */
 217
 218         return rc;
 219 }
 220
 221 RETCODE
 222 backsql_FreeRow( BACKSQL_ROW_NTS *row )
 223 {
 224         if ( row->cols == NULL ) {
 225                 return SQL_ERROR;
 226         }
 227
 228         ber_bvarray_free( row->col_names );
 229         ldap_charray_free( row->cols );
 230         free( row->col_prec );
 231         free( row->value_len );
 232
 233         return SQL_SUCCESS;
 234 }
 235
 236 static int
 237 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
 238 {
 239         const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
 240         if ( c1->ldap_cid > c2->ldap_cid ) {
 241                 return 1;
 242         }
 243
 244         if ( c1->ldap_cid < c2->ldap_cid ) {
 245                 return -1;
 246         }
 247
 248         return 0;
 249 }
 250
 251 static int
 252 backsql_close_db_conn( backsql_db_conn *conn )
 253 {
 254         Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn()\n", 0, 0, 0 );
 255
 256         /*
 257          * Default transact is SQL_ROLLBACK; commit is required only
 258          * by write operations, and it is explicitly performed after
 259          * each atomic operation succeeds.
 260          */
 261
 262         /* TimesTen */
 263         SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
 264         SQLDisconnect( conn->dbh );
 265         SQLFreeConnect( conn->dbh );
 266         Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn()\n", 0, 0, 0 );
 267         return 1;
 268 }
 269
 270 int
 271 backsql_init_db_env( backsql_info *si )
 272 {
 273         RETCODE         rc;
 274         int             ret = SQL_SUCCESS;
 275
 276         Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
 277         rc = SQLAllocEnv( &si->db_env );
 278         if ( rc != SQL_SUCCESS ) {
 279                 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
 280                                 0, 0, 0 );
 281                 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
 282                                 SQL_NULL_HENV, rc );
 283                 ret = SQL_ERROR;
 284         }
 285         Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
 286         return ret;
 287 }
 288
 289 int
 290 backsql_free_db_env( backsql_info *si )
 291 {
 292         Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
 293
 294 #ifdef BACKSQL_TRACE
 295         Debug( LDAP_DEBUG_TRACE, "free_db_env(): delete AVL tree here!!!\n",
 296                         0, 0, 0 );
 297 #endif /* BACKSQL_TRACE */
 298
 299         /*
 300          * stop, if frontend waits for all threads to shutdown
 301          * before calling this -- then what are we going to delete??
 302          * everything is already deleted...
 303          */
 304         Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
 305         return SQL_SUCCESS;
 306 }
 307
 308 static int
 309 backsql_open_db_conn( backsql_info *si, unsigned long ldap_cid, backsql_db_conn **pdbc )
 310 {
 311         /* TimesTen */
 312         char                    DBMSName[ 32 ];
 313         backsql_db_conn         *dbc;
 314         int                     rc;
 315
 316         assert( pdbc );
 317         *pdbc = NULL;
 318
 319         Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn()\n", 0, 0, 0 );
 320         dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
 321         dbc->ldap_cid = ldap_cid;
 322         rc = SQLAllocConnect( si->db_env, &dbc->dbh );
 323         if ( !BACKSQL_SUCCESS( rc ) ) {
 324                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 325                         "SQLAllocConnect() failed:\n", 0, 0, 0 );
 326                 backsql_PrintErrors( si->db_env, SQL_NULL_HDBC,
 327                                 SQL_NULL_HENV, rc );
 328                 return LDAP_UNAVAILABLE;
 329         }
 330
 331         rc = SQLConnect( dbc->dbh,
 332                         (SQLCHAR*)si->dbname, SQL_NTS,
 333                         (SQLCHAR*)si->dbuser, SQL_NTS,
 334                         (SQLCHAR*)si->dbpasswd, SQL_NTS );
 335         if ( rc != SQL_SUCCESS ) {
 336                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 337                         "SQLConnect() to database \"%s\" as user \"%s\" "
 338                         "%s:\n", si->dbname, si->dbuser,
 339                         rc == SQL_SUCCESS_WITH_INFO ?
 340                         "succeeded with info" : "failed" );
 341                 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
 342                 if ( rc != SQL_SUCCESS_WITH_INFO ) {
 343                         return LDAP_UNAVAILABLE;
 344                 }
 345         }
 346
 347         /*
 348          * TimesTen : Turn off autocommit.  We must explicitly
 349          * commit any transactions.
 350          */
 351         SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
 352
 353         /*
 354          * See if this connection is to TimesTen.  If it is,
 355          * remember that fact for later use.
 356          */
 357         /* Assume until proven otherwise */
 358         si->bsql_flags &= ~BSQLF_USE_REVERSE_DN;
 359         DBMSName[ 0 ] = '\0';
 360         rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
 361                         sizeof( DBMSName ), NULL );
 362         if ( rc == SQL_SUCCESS ) {
 363                 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
 364                                 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
 365                         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 366                                 "TimesTen database!\n", 0, 0, 0 );
 367                         si->bsql_flags |= BSQLF_USE_REVERSE_DN;
 368                 }
 369         } else {
 370                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 371                         "SQLGetInfo() failed:\n", 0, 0, 0 );
 372                 backsql_PrintErrors( si->db_env, dbc->dbh, SQL_NULL_HENV, rc );
 373                 return rc;
 374         }
 375         /* end TimesTen */
 376
 377         Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(): "
 378                 "connected, adding to tree\n", 0, 0, 0 );
 379         ldap_pvt_thread_mutex_lock( &si->dbconn_mutex );
 380         if ( avl_insert( &si->db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
 381                 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn: "
 382                         "duplicate connection ID\n", 0, 0, 0 );
 383                 return LDAP_OTHER;
 384         }
 385         ldap_pvt_thread_mutex_unlock( &si->dbconn_mutex );
 386         Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn()\n", 0, 0, 0 );
 387
 388         *pdbc = dbc;
 389
 390         return LDAP_SUCCESS;
 391 }
 392
 393 int
 394 backsql_free_db_conn( Operation *op )
 395 {
 396         backsql_info            *si = (backsql_info *)op->o_bd->be_private;
 397         backsql_db_conn         tmp = { 0 },
 398                                 *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                                 tmp = { 0 };
 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