2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2005 The OpenLDAP Foundation.
5 * Portions Copyright 1999 Dmitry Kovalev.
6 * Portions Copyright 2002 Pierangelo Masarati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Dmitry Kovalev for inclusion
19 * by OpenLDAP Software. Additional significant contributors include
20 * Pierangelo Masarati.
26 #include <sys/types.h>
27 #include "ac/string.h"
30 #include "proto-sql.h"
36 static char *controls[] = {
38 LDAP_CONTROL_MANAGEDSAIT,
39 #if 0 /* needs improvements */
42 #ifdef LDAP_CONTROL_X_TREE_DELETE
43 LDAP_CONTROL_X_TREE_DELETE,
44 #endif /* LDAP_CONTROL_X_TREE_DELETE */
48 bi->bi_controls = controls;
52 SLAP_BFLAG_INCREMENT |
56 Debug( LDAP_DEBUG_TRACE,"==>sql_back_initialize()\n", 0, 0, 0 );
58 bi->bi_db_init = backsql_db_init;
59 bi->bi_db_config = backsql_db_config;
60 bi->bi_db_open = backsql_db_open;
61 bi->bi_db_close = backsql_db_close;
62 bi->bi_db_destroy = backsql_db_destroy;
64 bi->bi_op_abandon = 0;
65 bi->bi_op_compare = backsql_compare;
66 bi->bi_op_bind = backsql_bind;
68 bi->bi_op_search = backsql_search;
69 bi->bi_op_modify = backsql_modify;
70 bi->bi_op_modrdn = backsql_modrdn;
71 bi->bi_op_add = backsql_add;
72 bi->bi_op_delete = backsql_delete;
74 bi->bi_chk_referrals = 0;
75 bi->bi_operational = backsql_operational;
76 bi->bi_entry_get_rw = backsql_entry_get;
78 bi->bi_connection_init = 0;
79 bi->bi_connection_destroy = backsql_connection_destroy;
81 Debug( LDAP_DEBUG_TRACE,"<==sql_back_initialize()\n", 0, 0, 0 );
89 Debug( LDAP_DEBUG_TRACE, "==>backsql_destroy()\n", 0, 0, 0 );
90 Debug( LDAP_DEBUG_TRACE, "<==backsql_destroy()\n", 0, 0, 0 );
100 Debug( LDAP_DEBUG_TRACE, "==>backsql_db_init()\n", 0, 0, 0 );
101 bi = (backsql_info *)ch_calloc( 1, sizeof( backsql_info ) );
102 memset( bi, '\0', sizeof( backsql_info ) );
103 ldap_pvt_thread_mutex_init( &bi->sql_dbconn_mutex );
104 ldap_pvt_thread_mutex_init( &bi->sql_schema_mutex );
105 backsql_init_db_env( bi );
108 Debug( LDAP_DEBUG_TRACE, "<==backsql_db_init()\n", 0, 0, 0 );
116 backsql_info *bi = (backsql_info*)bd->be_private;
118 Debug( LDAP_DEBUG_TRACE, "==>backsql_db_destroy()\n", 0, 0, 0 );
119 ldap_pvt_thread_mutex_lock( &bi->sql_dbconn_mutex );
120 backsql_free_db_env( bi );
121 ldap_pvt_thread_mutex_unlock( &bi->sql_dbconn_mutex );
122 ldap_pvt_thread_mutex_destroy( &bi->sql_dbconn_mutex );
123 ldap_pvt_thread_mutex_lock( &bi->sql_schema_mutex );
124 backsql_destroy_schema_map( bi );
125 ldap_pvt_thread_mutex_unlock( &bi->sql_schema_mutex );
126 ldap_pvt_thread_mutex_destroy( &bi->sql_schema_mutex );
127 free( bi->sql_dbname );
128 free( bi->sql_dbuser );
129 if ( bi->sql_dbpasswd ) {
130 free( bi->sql_dbpasswd );
132 if ( bi->sql_dbhost ) {
133 free( bi->sql_dbhost );
135 if ( bi->sql_upper_func.bv_val ) {
136 free( bi->sql_upper_func.bv_val );
137 free( bi->sql_upper_func_open.bv_val );
138 free( bi->sql_upper_func_close.bv_val );
141 free( bi->sql_subtree_cond.bv_val );
142 free( bi->sql_oc_query );
143 free( bi->sql_at_query );
144 free( bi->sql_insentry_stmt );
145 free( bi->sql_delentry_stmt );
146 free( bi->sql_renentry_stmt );
147 free( bi->sql_delobjclasses_stmt );
149 if ( bi->sql_anlist ) {
152 for ( i = 0; !BER_BVISNULL( &bi->sql_anlist[i].an_name ); i++ )
154 ch_free( bi->sql_anlist[i].an_name.bv_val );
156 ch_free( bi->sql_anlist );
159 if ( bi->sql_baseObject ) {
160 entry_free( bi->sql_baseObject );
165 Debug( LDAP_DEBUG_TRACE, "<==backsql_db_destroy()\n", 0, 0, 0 );
173 backsql_info *bi = (backsql_info*)bd->be_private;
174 SQLHDBC dbh = SQL_NULL_HDBC;
175 struct berbuf bb = BB_NULL;
177 char opbuf[ OPERATION_BUFFER_SIZE ];
178 Operation* op = (Operation *)opbuf;
180 Debug( LDAP_DEBUG_TRACE, "==>backsql_db_open(): "
181 "testing RDBMS connection\n", 0, 0, 0 );
182 if ( bi->sql_dbname == NULL ) {
183 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
184 "datasource name not specified "
185 "(use \"dbname\" directive in slapd.conf)\n", 0, 0, 0 );
189 if ( bi->sql_concat_func == NULL ) {
190 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
191 "concat func not specified (use \"concat_pattern\" "
192 "directive in slapd.conf)\n", 0, 0, 0 );
194 if ( backsql_split_pattern( backsql_def_concat_func,
195 &bi->sql_concat_func, 2 ) ) {
196 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
197 "unable to parse pattern \"%s\"",
198 backsql_def_concat_func, 0, 0 );
204 * Prepare cast string as required
206 if ( bi->sql_upper_func.bv_val ) {
209 if ( BACKSQL_UPPER_NEEDS_CAST( bi ) ) {
210 snprintf( buf, sizeof( buf ),
211 "%s(cast (" /* ? as varchar(%d))) */ ,
212 bi->sql_upper_func.bv_val );
213 ber_str2bv( buf, 0, 1, &bi->sql_upper_func_open );
215 snprintf( buf, sizeof( buf ),
216 /* (cast(? */ " as varchar(%d)))",
217 BACKSQL_MAX_DN_LEN );
218 ber_str2bv( buf, 0, 1, &bi->sql_upper_func_close );
221 snprintf( buf, sizeof( buf ), "%s(" /* ?) */ ,
222 bi->sql_upper_func.bv_val );
223 ber_str2bv( buf, 0, 1, &bi->sql_upper_func_open );
225 ber_str2bv( /* (? */ ")", 0, 1, &bi->sql_upper_func_close );
229 /* normalize filter values only if necessary */
230 bi->sql_caseIgnoreMatch = mr_find( "caseIgnoreMatch" );
231 assert( bi->sql_caseIgnoreMatch );
233 bi->sql_telephoneNumberMatch = mr_find( "telephoneNumberMatch" );
234 assert( bi->sql_telephoneNumberMatch );
236 if ( bi->sql_dbuser == NULL ) {
237 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
238 "user name not specified "
239 "(use \"dbuser\" directive in slapd.conf)\n", 0, 0, 0 );
243 if ( bi->sql_subtree_cond.bv_val == NULL ) {
245 * Prepare concat function for subtree search condition
247 struct berval concat;
248 struct berval values[] = {
253 struct berbuf bb = BB_NULL;
255 if ( backsql_prepare_pattern( bi->sql_concat_func, values,
257 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
258 "unable to prepare CONCAT pattern", 0, 0, 0 );
262 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
263 "subtree search SQL condition not specified "
264 "(use \"subtree_cond\" directive in slapd.conf)\n",
267 if ( bi->sql_upper_func.bv_val ) {
270 * UPPER(ldap_entries.dn) LIKE UPPER(CONCAT('%',?))
273 backsql_strfcat( &bb, "blbbb",
275 (ber_len_t)STRLENOF( "(ldap_entries.dn) LIKE " ),
276 "(ldap_entries.dn) LIKE ",
277 &bi->sql_upper_func_open,
279 &bi->sql_upper_func_close );
284 * ldap_entries.dn LIKE CONCAT('%',?)
287 backsql_strfcat( &bb, "lb",
288 (ber_len_t)STRLENOF( "ldap_entries.dn LIKE " ),
289 "ldap_entries.dn LIKE ",
293 bi->sql_subtree_cond = bb.bb_val;
295 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
296 "setting \"%s\" as default\n",
297 bi->sql_subtree_cond.bv_val, 0, 0 );
300 if ( bi->sql_children_cond.bv_val == NULL ) {
301 struct berbuf bb = BB_NULL;
303 if ( bi->sql_upper_func.bv_val ) {
306 * UPPER(ldap_entries.dn) LIKE UPPER(CONCAT('%,',?))
309 backsql_strfcat( &bb, "blbl",
311 (ber_len_t)STRLENOF( "(ldap_entries.dn)=" ),
312 "(ldap_entries.dn)=",
314 (ber_len_t)STRLENOF( "(?)" ), "(?)" );
319 * ldap_entries.dn LIKE CONCAT('%,',?)
322 backsql_strfcat( &bb, "l",
323 (ber_len_t)STRLENOF( "ldap_entries.dn=?" ),
324 "ldap_entries.dn=?");
327 bi->sql_children_cond = bb.bb_val;
329 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
330 "setting \"%s\" as default\n",
331 bi->sql_children_cond.bv_val, 0, 0 );
334 if ( bi->sql_oc_query == NULL ) {
335 if ( BACKSQL_CREATE_NEEDS_SELECT( bi ) ) {
337 ch_strdup( backsql_def_needs_select_oc_query );
340 bi->sql_oc_query = ch_strdup( backsql_def_oc_query );
343 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
344 "objectclass mapping SQL statement not specified "
345 "(use \"oc_query\" directive in slapd.conf)\n",
347 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
348 "setting \"%s\" by default\n", bi->sql_oc_query, 0, 0 );
351 if ( bi->sql_at_query == NULL ) {
352 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
353 "attribute mapping SQL statement not specified "
354 "(use \"at_query\" directive in slapd.conf)\n",
356 Debug(LDAP_DEBUG_TRACE, "backsql_db_open(): "
357 "setting \"%s\" by default\n",
358 backsql_def_at_query, 0, 0 );
359 bi->sql_at_query = ch_strdup( backsql_def_at_query );
362 if ( bi->sql_insentry_stmt == NULL ) {
363 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
364 "entry insertion SQL statement not specified "
365 "(use \"insentry_stmt\" directive in slapd.conf)\n",
367 Debug(LDAP_DEBUG_TRACE, "backsql_db_open(): "
368 "setting \"%s\" by default\n",
369 backsql_def_insentry_stmt, 0, 0 );
370 bi->sql_insentry_stmt = ch_strdup( backsql_def_insentry_stmt );
373 if ( bi->sql_delentry_stmt == NULL ) {
374 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
375 "entry deletion SQL statement not specified "
376 "(use \"delentry_stmt\" directive in slapd.conf)\n",
378 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
379 "setting \"%s\" by default\n",
380 backsql_def_delentry_stmt, 0, 0 );
381 bi->sql_delentry_stmt = ch_strdup( backsql_def_delentry_stmt );
384 if ( bi->sql_renentry_stmt == NULL ) {
385 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
386 "entry deletion SQL statement not specified "
387 "(use \"renentry_stmt\" directive in slapd.conf)\n",
389 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
390 "setting \"%s\" by default\n",
391 backsql_def_renentry_stmt, 0, 0 );
392 bi->sql_renentry_stmt = ch_strdup( backsql_def_renentry_stmt );
395 if ( bi->sql_delobjclasses_stmt == NULL ) {
396 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
397 "objclasses deletion SQL statement not specified "
398 "(use \"delobjclasses_stmt\" directive in slapd.conf)\n",
400 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
401 "setting \"%s\" by default\n",
402 backsql_def_delobjclasses_stmt, 0, 0 );
403 bi->sql_delobjclasses_stmt = ch_strdup( backsql_def_delobjclasses_stmt );
406 op->o_hdr = (Opheader *)&op[ 1 ];
407 op->o_connid = (unsigned long)(-1);
409 if ( backsql_get_db_conn( op, &dbh ) != LDAP_SUCCESS ) {
410 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
411 "connection failed, exiting\n", 0, 0, 0 );
416 * Prepare ID selection query
418 if ( bi->sql_id_query == NULL ) {
419 /* no custom id_query provided */
420 if ( bi->sql_upper_func.bv_val == NULL ) {
421 backsql_strcat( &bb, backsql_id_query, "dn=?", NULL );
424 if ( BACKSQL_HAS_LDAPINFO_DN_RU( bi ) ) {
425 backsql_strcat( &bb, backsql_id_query,
428 if ( BACKSQL_USE_REVERSE_DN( bi ) ) {
429 backsql_strfcat( &bb, "sbl",
432 (ber_len_t)STRLENOF( "(dn)=?" ), "(dn)=?" );
434 backsql_strfcat( &bb, "sblbcb",
437 (ber_len_t)STRLENOF( "(dn)=" ), "(dn)=",
438 &bi->sql_upper_func_open,
440 &bi->sql_upper_func_close );
444 bi->sql_id_query = bb.bb_val.bv_val;
448 * Prepare children ID selection query
450 bi->sql_has_children_query = NULL;
452 bb.bb_val.bv_val = NULL;
453 bb.bb_val.bv_len = 0;
455 backsql_strfcat( &bb, "sb",
456 "SELECT COUNT(distinct subordinates.id) "
457 "FROM ldap_entries,ldap_entries " BACKSQL_ALIASING "subordinates "
458 "WHERE subordinates.parent=ldap_entries.id AND ",
459 &bi->sql_children_cond );
460 bi->sql_has_children_query = bb.bb_val.bv_val;
462 backsql_free_db_conn( op );
463 if ( !BACKSQL_SCHEMA_LOADED( bi ) ) {
464 Debug( LDAP_DEBUG_TRACE, "backsql_db_open(): "
465 "test failed, schema map not loaded - exiting\n",
470 /* should never happen! */
471 assert( bd->be_nsuffix != NULL );
473 if ( BER_BVISNULL( &bd->be_nsuffix[ 1 ] ) ) {
474 /* enable if only one suffix is defined */
475 bi->sql_flags |= BSQLF_USE_SUBTREE_SHORTCUT;
478 Debug( LDAP_DEBUG_TRACE, "<==backsql_db_open(): "
479 "test succeeded, schema map loaded\n", 0, 0, 0 );
487 Debug( LDAP_DEBUG_TRACE, "==>backsql_db_close()\n", 0, 0, 0 );
488 Debug( LDAP_DEBUG_TRACE, "<==backsql_db_close()\n", 0, 0, 0 );
493 backsql_connection_destroy( Backend *bd, Connection *c )
495 char opbuf[ OPERATION_BUFFER_SIZE ];
496 Operation* op = (Operation *)opbuf;
498 op->o_hdr = (Opheader *)&op[ 1 ];
499 op->o_connid = c->c_connid;
502 Debug( LDAP_DEBUG_TRACE, "==>backsql_connection_destroy()\n", 0, 0, 0 );
503 backsql_free_db_conn( op );
504 Debug( LDAP_DEBUG_TRACE, "<==backsql_connection_destroy()\n", 0, 0, 0 );
509 #if SLAPD_SQL == SLAPD_MOD_DYNAMIC
511 /* conditionally define the init_module() function */
512 SLAP_BACKEND_INIT_MODULE( sql )
514 #endif /* SLAPD_SQL == SLAPD_MOD_DYNAMIC */