2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2007 The OpenLDAP Foundation.
5 * Portions Copyright 1999 Dmitry Kovalev.
6 * Portions Copyright 2002 Pierangelo Masarati.
7 * Portions Copyright 2004 Mark Adamson.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted only as authorized by the OpenLDAP
14 * A copy of this license is available in the file LICENSE in the
15 * top-level directory of the distribution or, alternatively, at
16 * <http://www.OpenLDAP.org/license.html>.
19 * This work was initially developed by Dmitry Kovalev for inclusion
20 * by OpenLDAP Software. Additional significant contributors include
21 * Pierangelo Masarati and Mark Adamson.
27 #include "ac/string.h"
28 #include <sys/types.h>
31 #include "proto-sql.h"
33 #define MAX_ATTR_LEN 16384
35 typedef struct backsql_db_conn {
36 unsigned long ldap_cid;
41 backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc )
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 */
48 Debug( LDAP_DEBUG_TRACE, "Return code: %d\n", rc, 0, 0 );
50 for ( ; rc = SQLError( henv, hdbc, sth, state, &iSqlCode, msg,
51 SQL_MAX_MESSAGE_LENGTH - 1, &len ), BACKSQL_SUCCESS( rc ); )
53 Debug( LDAP_DEBUG_TRACE,
54 " nativeErrCode=%d SQLengineState=%s msg=\"%s\"\n",
55 (int)iSqlCode, state, msg );
60 backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char *query, int timeout )
64 rc = SQLAllocStmt( dbh, sth );
65 if ( rc != SQL_SUCCESS ) {
70 Debug( LDAP_DEBUG_TRACE, "==>backsql_Prepare()\n", 0, 0, 0 );
71 #endif /* BACKSQL_TRACE */
73 #ifdef BACKSQL_MSSQL_WORKAROUND
78 SQLGetInfo( dbh, SQL_DRIVER_NAME, drv_name, sizeof( drv_name ), &len );
81 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): driver name=\"%s\"\n",
83 #endif /* BACKSQL_TRACE */
85 ldap_pvt_str2upper( drv_name );
86 if ( !strncmp( drv_name, "SQLSRV32.DLL", STRLENOF( "SQLSRV32.DLL" ) ) ) {
88 * stupid default result set in MS SQL Server
89 * does not support multiple active statements
90 * on the same connection -- so we are trying
91 * to make it not to use default result set...
93 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
94 "enabling MS SQL Server default result "
95 "set workaround\n", 0, 0, 0 );
96 rc = SQLSetStmtOption( *sth, SQL_CONCURRENCY,
98 if ( rc != SQL_SUCCESS && rc != SQL_SUCCESS_WITH_INFO ) {
99 Debug( LDAP_DEBUG_TRACE, "backsql_Prepare(): "
100 "SQLSetStmtOption(SQL_CONCURRENCY,"
101 "SQL_CONCUR_ROWVER) failed:\n",
103 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
104 SQLFreeStmt( *sth, SQL_DROP );
109 #endif /* BACKSQL_MSSQL_WORKAROUND */
112 Debug( LDAP_DEBUG_TRACE, "_SQLprepare(): "
113 "setting query timeout to %d sec.\n",
115 rc = SQLSetStmtOption( *sth, SQL_QUERY_TIMEOUT, timeout );
116 if ( rc != SQL_SUCCESS ) {
117 backsql_PrintErrors( SQL_NULL_HENV, dbh, *sth, rc );
118 SQLFreeStmt( *sth, SQL_DROP );
124 Debug( LDAP_DEBUG_TRACE, "<==backsql_Prepare() calling SQLPrepare()\n",
126 #endif /* BACKSQL_TRACE */
128 return SQLPrepare( *sth, (SQLCHAR *)query, SQL_NTS );
132 backsql_BindRowAsStrings_x( SQLHSTMT sth, BACKSQL_ROW_NTS *row, void *ctx )
141 Debug( LDAP_DEBUG_TRACE, "==> backsql_BindRowAsStrings()\n", 0, 0, 0 );
142 #endif /* BACKSQL_TRACE */
144 rc = SQLNumResultCols( sth, &row->ncols );
145 if ( rc != SQL_SUCCESS ) {
147 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings(): "
148 "SQLNumResultCols() failed:\n", 0, 0, 0 );
149 #endif /* BACKSQL_TRACE */
151 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC, sth, rc );
154 SQLCHAR colname[ 64 ];
155 SQLSMALLINT name_len, col_type, col_scale, col_null;
160 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
161 "ncols=%d\n", (int)row->ncols, 0, 0 );
162 #endif /* BACKSQL_TRACE */
164 row->col_names = (BerVarray)ber_memcalloc_x( row->ncols + 1,
165 sizeof( struct berval ), ctx );
166 if ( row->col_names == NULL ) {
170 row->col_prec = (UDWORD *)ber_memcalloc_x( row->ncols,
171 sizeof( UDWORD ), ctx );
172 if ( row->col_prec == NULL ) {
176 row->col_type = (SQLSMALLINT *)ber_memcalloc_x( row->ncols,
177 sizeof( SQLSMALLINT ), ctx );
178 if ( row->col_type == NULL ) {
182 row->cols = (char **)ber_memcalloc_x( row->ncols + 1,
183 sizeof( char * ), ctx );
184 if ( row->cols == NULL ) {
188 row->value_len = (SQLINTEGER *)ber_memcalloc_x( row->ncols,
189 sizeof( SQLINTEGER ), ctx );
190 if ( row->value_len == NULL ) {
196 ber_memfree_x( row->col_names, ctx );
197 row->col_names = NULL;
198 ber_memfree_x( row->col_prec, ctx );
199 row->col_prec = NULL;
200 ber_memfree_x( row->col_type, ctx );
201 row->col_type = NULL;
202 ber_memfree_x( row->cols, ctx );
204 ber_memfree_x( row->value_len, ctx );
205 row->value_len = NULL;
207 Debug( LDAP_DEBUG_ANY, "backsql_BindRowAsStrings: "
208 "out of memory\n", 0, 0, 0 );
210 return LDAP_NO_MEMORY;
213 for ( i = 0; i < row->ncols; i++ ) {
214 SQLSMALLINT TargetType;
216 rc = SQLDescribeCol( sth, (SQLSMALLINT)(i + 1), &colname[ 0 ],
217 (SQLUINTEGER)( sizeof( colname ) - 1 ),
218 &name_len, &col_type,
219 &col_prec, &col_scale, &col_null );
220 /* FIXME: test rc? */
222 ber_str2bv_x( (char *)colname, 0, 1,
223 &row->col_names[ i ], ctx );
225 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
226 "col_name=%s, col_prec[%d]=%d\n",
227 colname, (int)(i + 1), (int)col_prec );
228 #endif /* BACKSQL_TRACE */
229 if ( col_type != SQL_CHAR && col_type != SQL_VARCHAR )
231 col_prec = MAX_ATTR_LEN;
234 row->cols[ i ] = (char *)ber_memcalloc_x( col_prec + 1,
235 sizeof( char ), ctx );
236 row->col_prec[ i ] = col_prec;
237 row->col_type[ i ] = col_type;
240 * ITS#3386, ITS#3113 - 20070308
241 * Note: there are many differences between various DPMS and ODBC
242 * Systems; some support SQL_C_BLOB, SQL_C_BLOB_LOCATOR. YMMV:
243 * This has only been tested on Linux/MySQL/UnixODBC
244 * For BINARY-type Fields (BLOB, etc), read the data as BINARY
246 if ( BACKSQL_IS_BINARY( col_type ) ) {
248 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
249 "col_name=%s, col_type[%d]=%d: reading binary data\n",
250 colname, (int)(i + 1), (int)col_type);
251 #endif /* BACKSQL_TRACE */
252 TargetType = SQL_C_BINARY;
255 /* Otherwise read it as Character data */
257 Debug( LDAP_DEBUG_TRACE, "backsql_BindRowAsStrings: "
258 "col_name=%s, col_type[%d]=%d: reading character data\n",
259 colname, (int)(i + 1), (int)col_type);
260 #endif /* BACKSQL_TRACE */
261 TargetType = SQL_C_CHAR;
264 rc = SQLBindCol( sth, (SQLUSMALLINT)(i + 1),
266 (SQLPOINTER)row->cols[ i ],
268 &row->value_len[ i ] );
270 /* FIXME: test rc? */
273 BER_BVZERO( &row->col_names[ i ] );
274 row->cols[ i ] = NULL;
278 Debug( LDAP_DEBUG_TRACE, "<== backsql_BindRowAsStrings()\n", 0, 0, 0 );
279 #endif /* BACKSQL_TRACE */
285 backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row )
287 return backsql_BindRowAsStrings_x( sth, row, NULL );
291 backsql_FreeRow_x( BACKSQL_ROW_NTS *row, void *ctx )
293 if ( row->cols == NULL ) {
297 ber_bvarray_free_x( row->col_names, ctx );
298 ber_memfree_x( row->col_prec, ctx );
299 ber_memfree_x( row->col_type, ctx );
300 ber_memvfree_x( (void **)row->cols, ctx );
301 ber_memfree_x( row->value_len, ctx );
308 backsql_FreeRow( BACKSQL_ROW_NTS *row )
310 return backsql_FreeRow_x( row, NULL );
314 backsql_cmp_connid( const void *v_c1, const void *v_c2 )
316 const backsql_db_conn *c1 = v_c1, *c2 = v_c2;
317 if ( c1->ldap_cid > c2->ldap_cid ) {
321 if ( c1->ldap_cid < c2->ldap_cid ) {
329 backsql_close_db_conn( void *v_conn )
331 backsql_db_conn *conn = (backsql_db_conn *)v_conn;
332 unsigned long cid = conn->ldap_cid;
334 Debug( LDAP_DEBUG_TRACE, "==>backsql_close_db_conn(%lu)\n",
338 * Default transact is SQL_ROLLBACK; commit is required only
339 * by write operations, and it is explicitly performed after
340 * each atomic operation succeeds.
344 SQLTransact( SQL_NULL_HENV, conn->dbh, SQL_ROLLBACK );
345 SQLDisconnect( conn->dbh );
346 SQLFreeConnect( conn->dbh );
349 Debug( LDAP_DEBUG_TRACE, "<==backsql_close_db_conn(%lu)\n",
354 backsql_conn_destroy(
357 avl_free( bi->sql_db_conns, backsql_close_db_conn );
363 backsql_init_db_env( backsql_info *bi )
366 int ret = SQL_SUCCESS;
368 Debug( LDAP_DEBUG_TRACE, "==>backsql_init_db_env()\n", 0, 0, 0 );
370 rc = SQLAllocEnv( &bi->sql_db_env );
371 if ( rc != SQL_SUCCESS ) {
372 Debug( LDAP_DEBUG_TRACE, "init_db_env: SQLAllocEnv failed:\n",
374 backsql_PrintErrors( SQL_NULL_HENV, SQL_NULL_HDBC,
379 Debug( LDAP_DEBUG_TRACE, "<==backsql_init_db_env()=%d\n", ret, 0, 0 );
385 backsql_free_db_env( backsql_info *bi )
387 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_env()\n", 0, 0, 0 );
389 (void)SQLFreeEnv( bi->sql_db_env );
390 bi->sql_db_env = SQL_NULL_HENV;
393 * stop, if frontend waits for all threads to shutdown
394 * before calling this -- then what are we going to delete??
395 * everything is already deleted...
397 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_env()\n", 0, 0, 0 );
403 backsql_open_db_conn( backsql_info *bi, unsigned long ldap_cid, backsql_db_conn **pdbc )
407 backsql_db_conn *dbc;
410 assert( pdbc != NULL );
413 Debug( LDAP_DEBUG_TRACE, "==>backsql_open_db_conn(%lu)\n",
416 dbc = (backsql_db_conn *)ch_calloc( 1, sizeof( backsql_db_conn ) );
417 dbc->ldap_cid = ldap_cid;
418 rc = SQLAllocConnect( bi->sql_db_env, &dbc->dbh );
419 if ( !BACKSQL_SUCCESS( rc ) ) {
420 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
421 "SQLAllocConnect() failed:\n", ldap_cid, 0, 0 );
422 backsql_PrintErrors( bi->sql_db_env, SQL_NULL_HDBC,
424 return LDAP_UNAVAILABLE;
427 rc = SQLConnect( dbc->dbh,
428 (SQLCHAR*)bi->sql_dbname, SQL_NTS,
429 (SQLCHAR*)bi->sql_dbuser, SQL_NTS,
430 (SQLCHAR*)bi->sql_dbpasswd, SQL_NTS );
431 if ( rc != SQL_SUCCESS ) {
432 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
433 "SQLConnect() to database \"%s\" %s.\n",
434 ldap_cid, bi->sql_dbname,
435 rc == SQL_SUCCESS_WITH_INFO ?
436 "succeeded with info" : "failed" );
437 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
438 if ( rc != SQL_SUCCESS_WITH_INFO ) {
439 return LDAP_UNAVAILABLE;
444 * TimesTen : Turn off autocommit. We must explicitly
445 * commit any transactions.
447 SQLSetConnectOption( dbc->dbh, SQL_AUTOCOMMIT, SQL_AUTOCOMMIT_OFF );
450 * See if this connection is to TimesTen. If it is,
451 * remember that fact for later use.
453 /* Assume until proven otherwise */
454 bi->sql_flags &= ~BSQLF_USE_REVERSE_DN;
455 DBMSName[ 0 ] = '\0';
456 rc = SQLGetInfo( dbc->dbh, SQL_DBMS_NAME, (PTR)&DBMSName,
457 sizeof( DBMSName ), NULL );
458 if ( rc == SQL_SUCCESS ) {
459 if ( strcmp( DBMSName, "TimesTen" ) == 0 ||
460 strcmp( DBMSName, "Front-Tier" ) == 0 ) {
461 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
462 "TimesTen database!\n", ldap_cid, 0, 0 );
463 bi->sql_flags |= BSQLF_USE_REVERSE_DN;
466 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
467 "SQLGetInfo() failed.\n", ldap_cid, 0, 0 );
468 backsql_PrintErrors( bi->sql_db_env, dbc->dbh, SQL_NULL_HENV, rc );
473 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
474 "connected, adding to tree.\n", ldap_cid, 0, 0 );
475 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
476 if ( avl_insert( &bi->sql_db_conns, dbc, backsql_cmp_connid, avl_dup_error ) ) {
477 Debug( LDAP_DEBUG_TRACE, "backsql_open_db_conn(%lu): "
478 "duplicate connection ID.\n", ldap_cid, 0, 0 );
481 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
482 Debug( LDAP_DEBUG_TRACE, "<==backsql_open_db_conn(%lu)\n", ldap_cid, 0, 0 );
490 backsql_free_db_conn( Operation *op )
492 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
493 backsql_db_conn tmp = { 0 },
496 Debug( LDAP_DEBUG_TRACE, "==>backsql_free_db_conn()\n", 0, 0, 0 );
497 tmp.ldap_cid = op->o_connid;
498 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
499 conn = avl_delete( &bi->sql_db_conns, &tmp, backsql_cmp_connid );
500 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
503 * we have one thread per connection, as I understand -- so we can
504 * get this out of critical section
506 if ( conn != NULL ) {
507 Debug( LDAP_DEBUG_TRACE, "backsql_free_db_conn(): "
508 "closing db connection %lu (%p)\n",
509 op->o_connid, (void *)conn, 0 );
510 backsql_close_db_conn( (void *)conn );
513 Debug( LDAP_DEBUG_TRACE, "<==backsql_free_db_conn()\n", 0, 0, 0 );
515 return conn ? SQL_SUCCESS : SQL_ERROR;
519 backsql_get_db_conn( Operation *op, SQLHDBC *dbh )
521 backsql_info *bi = (backsql_info *)op->o_bd->be_private;
522 backsql_db_conn *dbc,
524 int rc = LDAP_SUCCESS;
526 Debug( LDAP_DEBUG_TRACE, "==>backsql_get_db_conn()\n", 0, 0, 0 );
528 assert( dbh != NULL );
529 *dbh = SQL_NULL_HDBC;
531 tmp.ldap_cid = op->o_connid;
534 * we have one thread per connection, as I understand --
535 * so we do not need locking here
537 dbc = avl_find( bi->sql_db_conns, &tmp, backsql_cmp_connid );
539 rc = backsql_open_db_conn( bi, op->o_connid, &dbc );
540 if ( rc != LDAP_SUCCESS) {
541 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
542 "could not get connection handle "
543 "-- returning NULL\n", 0, 0, 0 );
548 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
549 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
550 Debug( LDAP_DEBUG_TRACE, "backsql_get_db_conn(): "
551 "first call -- reading schema map\n", 0, 0, 0 );
552 rc = backsql_load_schema_map( bi, dbc->dbh );
553 if ( rc != LDAP_SUCCESS ) {
554 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
555 backsql_free_db_conn( op );
559 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
563 Debug( LDAP_DEBUG_TRACE, "<==backsql_get_db_conn()\n", 0, 0, 0 );