xref: /netbsd-src/external/bsd/openldap/dist/servers/slapd/back-sql/schema-map.c (revision d11b170b9000ada93db553723522a63d5deac310)
1 /*	$NetBSD: schema-map.c,v 1.1.1.4 2014/05/28 09:58:51 tron Exp $	*/
2 
3 /* $OpenLDAP$ */
4 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5  *
6  * Copyright 1999-2014 The OpenLDAP Foundation.
7  * Portions Copyright 1999 Dmitry Kovalev.
8  * Portions Copyright 2002 Pierangelo Masarati.
9  * Portions Copyright 2004 Mark Adamson.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted only as authorized by the OpenLDAP
14  * Public License.
15  *
16  * A copy of this license is available in the file LICENSE in the
17  * top-level directory of the distribution or, alternatively, at
18  * <http://www.OpenLDAP.org/license.html>.
19  */
20 /* ACKNOWLEDGEMENTS:
21  * This work was initially developed by Dmitry Kovalev for inclusion
22  * by OpenLDAP Software.  Additional significant contributors include
23  * Pierangelo Masarati and Mark Adamson.
24  */
25 
26 #include "portable.h"
27 
28 #include <stdio.h>
29 #include <sys/types.h>
30 #include "ac/string.h"
31 
32 #include "lutil.h"
33 #include "slap.h"
34 #include "proto-sql.h"
35 
36 #define BACKSQL_DUPLICATE	(-1)
37 
38 /* NOTE: by default, cannot just compare pointers because
39  * objectClass/attributeType order would be machine-dependent
40  * (and tests would fail!); however, if you don't want to run
41  * tests, or see attributeTypes written in the same order
42  * they are defined, define */
43 /* #undef BACKSQL_USE_PTR_CMP */
44 
45 /*
46  * Uses the pointer to the ObjectClass structure
47  */
48 static int
49 backsql_cmp_oc( const void *v_m1, const void *v_m2 )
50 {
51 	const backsql_oc_map_rec	*m1 = v_m1,
52 					*m2 = v_m2;
53 
54 #ifdef BACKSQL_USE_PTR_CMP
55 	return SLAP_PTRCMP( m1->bom_oc, m2->bom_oc );
56 #else /* ! BACKSQL_USE_PTR_CMP */
57 	return ber_bvcmp( &m1->bom_oc->soc_cname, &m2->bom_oc->soc_cname );
58 #endif /* ! BACKSQL_USE_PTR_CMP */
59 }
60 
61 static int
62 backsql_cmp_oc_id( const void *v_m1, const void *v_m2 )
63 {
64 	const backsql_oc_map_rec	*m1 = v_m1,
65 					*m2 = v_m2;
66 
67 	return ( m1->bom_id < m2->bom_id ? -1 : ( m1->bom_id > m2->bom_id ? 1 : 0 ) );
68 }
69 
70 /*
71  * Uses the pointer to the AttributeDescription structure
72  */
73 static int
74 backsql_cmp_attr( const void *v_m1, const void *v_m2 )
75 {
76 	const backsql_at_map_rec	*m1 = v_m1,
77 					*m2 = v_m2;
78 
79 	if ( slap_ad_is_binary( m1->bam_ad ) || slap_ad_is_binary( m2->bam_ad ) ) {
80 #ifdef BACKSQL_USE_PTR_CMP
81 		return SLAP_PTRCMP( m1->bam_ad->ad_type, m2->bam_ad->ad_type );
82 #else /* ! BACKSQL_USE_PTR_CMP */
83 		return ber_bvcmp( &m1->bam_ad->ad_type->sat_cname, &m2->bam_ad->ad_type->sat_cname );
84 #endif /* ! BACKSQL_USE_PTR_CMP */
85 	}
86 
87 #ifdef BACKSQL_USE_PTR_CMP
88 	return SLAP_PTRCMP( m1->bam_ad, m2->bam_ad );
89 #else /* ! BACKSQL_USE_PTR_CMP */
90 	return ber_bvcmp( &m1->bam_ad->ad_cname, &m2->bam_ad->ad_cname );
91 #endif /* ! BACKSQL_USE_PTR_CMP */
92 }
93 
94 int
95 backsql_dup_attr( void *v_m1, void *v_m2 )
96 {
97 	backsql_at_map_rec		*m1 = v_m1,
98 					*m2 = v_m2;
99 
100 	if ( slap_ad_is_binary( m1->bam_ad ) || slap_ad_is_binary( m2->bam_ad ) ) {
101 #ifdef BACKSQL_USE_PTR_CMP
102 		assert( m1->bam_ad->ad_type == m2->bam_ad->ad_type );
103 #else /* ! BACKSQL_USE_PTR_CMP */
104 		assert( ber_bvcmp( &m1->bam_ad->ad_type->sat_cname, &m2->bam_ad->ad_type->sat_cname ) == 0 );
105 #endif /* ! BACKSQL_USE_PTR_CMP */
106 
107 	} else {
108 #ifdef BACKSQL_USE_PTR_CMP
109 		assert( m1->bam_ad == m2->bam_ad );
110 #else /* ! BACKSQL_USE_PTR_CMP */
111 		assert( ber_bvcmp( &m1->bam_ad->ad_cname, &m2->bam_ad->ad_cname ) == 0 );
112 #endif /* ! BACKSQL_USE_PTR_CMP */
113 	}
114 
115 	/* duplicate definitions of attributeTypes are appended;
116 	 * this allows to define multiple rules for the same
117 	 * attributeType.  Use with care! */
118 	for ( ; m1->bam_next ; m1 = m1->bam_next );
119 
120 	m1->bam_next = m2;
121 	m2->bam_next = NULL;
122 
123 	return BACKSQL_DUPLICATE;
124 }
125 
126 static int
127 backsql_make_attr_query(
128 	backsql_info		*bi,
129 	backsql_oc_map_rec 	*oc_map,
130 	backsql_at_map_rec 	*at_map )
131 {
132 	struct berbuf	bb = BB_NULL;
133 
134 	backsql_strfcat_x( &bb, NULL, "lblbbbblblbcbl",
135 			(ber_len_t)STRLENOF( "SELECT " ), "SELECT ",
136 			&at_map->bam_sel_expr,
137 			(ber_len_t)STRLENOF( " " ), " ",
138 			&bi->sql_aliasing,
139 			&bi->sql_aliasing_quote,
140 			&at_map->bam_ad->ad_cname,
141 			&bi->sql_aliasing_quote,
142 			(ber_len_t)STRLENOF( " FROM " ), " FROM ",
143 			&at_map->bam_from_tbls,
144 			(ber_len_t)STRLENOF( " WHERE " ), " WHERE ",
145 			&oc_map->bom_keytbl,
146 			'.',
147 			&oc_map->bom_keycol,
148 			(ber_len_t)STRLENOF( "=?" ), "=?" );
149 
150 	if ( !BER_BVISNULL( &at_map->bam_join_where ) ) {
151 		backsql_strfcat_x( &bb, NULL, "lb",
152 				(ber_len_t)STRLENOF( " AND " ), " AND ",
153 				&at_map->bam_join_where );
154 	}
155 
156 	backsql_strfcat_x( &bb, NULL, "lbbb",
157 			(ber_len_t)STRLENOF( " ORDER BY " ), " ORDER BY ",
158 			&bi->sql_aliasing_quote,
159 			&at_map->bam_ad->ad_cname,
160 			&bi->sql_aliasing_quote );
161 
162 	at_map->bam_query = bb.bb_val.bv_val;
163 
164 #ifdef BACKSQL_COUNTQUERY
165 	/* Query to count how many rows will be returned.
166 
167 	SELECT COUNT(*) FROM <from_tbls> WHERE <keytbl>.<keycol>=?
168 		[ AND <join_where> ]
169 
170 	 */
171 	BER_BVZERO( &bb.bb_val );
172 	bb.bb_len = 0;
173 	backsql_strfcat_x( &bb, NULL, "lblbcbl",
174 			(ber_len_t)STRLENOF( "SELECT COUNT(*) FROM " ),
175 				"SELECT COUNT(*) FROM ",
176 			&at_map->bam_from_tbls,
177 			(ber_len_t)STRLENOF( " WHERE " ), " WHERE ",
178 			&oc_map->bom_keytbl,
179 			'.',
180 			&oc_map->bom_keycol,
181 			(ber_len_t)STRLENOF( "=?" ), "=?" );
182 
183 	if ( !BER_BVISNULL( &at_map->bam_join_where ) ) {
184 		backsql_strfcat_x( &bb, NULL, "lb",
185 				(ber_len_t)STRLENOF( " AND " ), " AND ",
186 				&at_map->bam_join_where );
187 	}
188 
189 	at_map->bam_countquery = bb.bb_val.bv_val;
190 #endif /* BACKSQL_COUNTQUERY */
191 
192 	return 0;
193 }
194 
195 static int
196 backsql_add_sysmaps( backsql_info *bi, backsql_oc_map_rec *oc_map )
197 {
198 	backsql_at_map_rec	*at_map;
199 	char			s[LDAP_PVT_INTTYPE_CHARS(long)];
200 	struct berval		sbv;
201 	struct berbuf		bb;
202 
203 	sbv.bv_val = s;
204 	sbv.bv_len = snprintf( s, sizeof( s ), BACKSQL_IDNUMFMT, oc_map->bom_id );
205 
206 	/* extra objectClasses */
207 	at_map = (backsql_at_map_rec *)ch_calloc(1,
208 			sizeof( backsql_at_map_rec ) );
209 	at_map->bam_ad = slap_schema.si_ad_objectClass;
210 	at_map->bam_true_ad = slap_schema.si_ad_objectClass;
211 	ber_str2bv( "ldap_entry_objclasses.oc_name", 0, 1,
212 			&at_map->bam_sel_expr );
213 	ber_str2bv( "ldap_entry_objclasses,ldap_entries", 0, 1,
214 			&at_map->bam_from_tbls );
215 
216 	bb.bb_len = at_map->bam_from_tbls.bv_len + 1;
217 	bb.bb_val = at_map->bam_from_tbls;
218 	backsql_merge_from_clause( bi, &bb, &oc_map->bom_keytbl );
219 	at_map->bam_from_tbls = bb.bb_val;
220 
221 	BER_BVZERO( &bb.bb_val );
222 	bb.bb_len = 0;
223 	backsql_strfcat_x( &bb, NULL, "lbcblb",
224 			(ber_len_t)STRLENOF( "ldap_entries.id=ldap_entry_objclasses.entry_id AND ldap_entries.keyval=" ),
225 				"ldap_entries.id=ldap_entry_objclasses.entry_id AND ldap_entries.keyval=",
226 			&oc_map->bom_keytbl,
227 			'.',
228 			&oc_map->bom_keycol,
229 			(ber_len_t)STRLENOF( " and ldap_entries.oc_map_id=" ),
230 				" and ldap_entries.oc_map_id=",
231 			&sbv );
232 	at_map->bam_join_where = bb.bb_val;
233 
234 	at_map->bam_oc = oc_map->bom_oc;
235 
236 	at_map->bam_add_proc = NULL;
237 	{
238 		char	tmp[STRLENOF("INSERT INTO ldap_entry_objclasses "
239 			"(entry_id,oc_name) VALUES "
240 			"((SELECT id FROM ldap_entries "
241 			"WHERE oc_map_id= "
242 			"AND keyval=?),?)") + LDAP_PVT_INTTYPE_CHARS(unsigned long)];
243 		snprintf( tmp, sizeof(tmp),
244 			"INSERT INTO ldap_entry_objclasses "
245 			"(entry_id,oc_name) VALUES "
246 			"((SELECT id FROM ldap_entries "
247 			"WHERE oc_map_id=" BACKSQL_IDNUMFMT " "
248 			"AND keyval=?),?)", oc_map->bom_id );
249 		at_map->bam_add_proc = ch_strdup( tmp );
250 	}
251 
252 	at_map->bam_delete_proc = NULL;
253 	{
254 		char	tmp[STRLENOF("DELETE FROM ldap_entry_objclasses "
255 			"WHERE entry_id=(SELECT id FROM ldap_entries "
256 			"WHERE oc_map_id= "
257 			"AND keyval=?) AND oc_name=?") + LDAP_PVT_INTTYPE_CHARS(unsigned long)];
258 		snprintf( tmp, sizeof(tmp),
259 			"DELETE FROM ldap_entry_objclasses "
260 			"WHERE entry_id=(SELECT id FROM ldap_entries "
261 			"WHERE oc_map_id=" BACKSQL_IDNUMFMT " "
262 			"AND keyval=?) AND oc_name=?",
263 			oc_map->bom_id );
264 		at_map->bam_delete_proc = ch_strdup( tmp );
265 	}
266 
267 	at_map->bam_param_order = 0;
268 	at_map->bam_expect_return = 0;
269 	at_map->bam_next = NULL;
270 
271 	backsql_make_attr_query( bi, oc_map, at_map );
272 	if ( avl_insert( &oc_map->bom_attrs, at_map, backsql_cmp_attr, backsql_dup_attr ) == BACKSQL_DUPLICATE ) {
273 		Debug( LDAP_DEBUG_TRACE, "backsql_add_sysmaps(): "
274 				"duplicate attribute \"%s\" in objectClass \"%s\" map\n",
275 				at_map->bam_ad->ad_cname.bv_val,
276 				oc_map->bom_oc->soc_cname.bv_val, 0 );
277 	}
278 
279 	/* FIXME: we need to correct the objectClass join_where
280 	 * after the attribute query is built */
281 	ch_free( at_map->bam_join_where.bv_val );
282 	BER_BVZERO( &bb.bb_val );
283 	bb.bb_len = 0;
284 	backsql_strfcat_x( &bb, NULL, "lbcblb",
285 			(ber_len_t)STRLENOF( /* "ldap_entries.id=ldap_entry_objclasses.entry_id AND " */ "ldap_entries.keyval=" ),
286 				/* "ldap_entries.id=ldap_entry_objclasses.entry_id AND " */ "ldap_entries.keyval=",
287 			&oc_map->bom_keytbl,
288 			'.',
289 			&oc_map->bom_keycol,
290 			(ber_len_t)STRLENOF( " AND ldap_entries.oc_map_id=" ),
291 				" AND ldap_entries.oc_map_id=",
292 			&sbv );
293 	at_map->bam_join_where = bb.bb_val;
294 
295 	return 1;
296 }
297 
298 struct backsql_attr_schema_info {
299 	backsql_info	*bas_bi;
300 	SQLHDBC		bas_dbh;
301 	SQLHSTMT	bas_sth;
302 	backsql_key_t	*bas_oc_id;
303 	int		bas_rc;
304 };
305 
306 static int
307 backsql_oc_get_attr_mapping( void *v_oc, void *v_bas )
308 {
309 	RETCODE				rc;
310 	BACKSQL_ROW_NTS			at_row;
311 	backsql_oc_map_rec		*oc_map = (backsql_oc_map_rec *)v_oc;
312 	backsql_at_map_rec		*at_map;
313 	struct backsql_attr_schema_info	*bas = (struct backsql_attr_schema_info *)v_bas;
314 
315 	/* bas->bas_oc_id has been bound to bas->bas_sth */
316 	*bas->bas_oc_id = oc_map->bom_id;
317 
318 	Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
319 		"executing at_query\n"
320 		"    \"%s\"\n"
321 		"    for objectClass \"%s\"\n"
322 		"    with param oc_id=" BACKSQL_IDNUMFMT "\n",
323 		bas->bas_bi->sql_at_query,
324 		BACKSQL_OC_NAME( oc_map ),
325 		*bas->bas_oc_id );
326 
327 	rc = SQLExecute( bas->bas_sth );
328 	if ( rc != SQL_SUCCESS ) {
329 		Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
330 			"error executing at_query\n"
331 			"    \"%s\"\n"
332 			"    for objectClass \"%s\"\n"
333 			"    with param oc_id=" BACKSQL_IDNUMFMT "\n",
334 			bas->bas_bi->sql_at_query,
335 			BACKSQL_OC_NAME( oc_map ),
336 			*bas->bas_oc_id );
337 		backsql_PrintErrors( bas->bas_bi->sql_db_env,
338 				bas->bas_dbh, bas->bas_sth, rc );
339 		bas->bas_rc = LDAP_OTHER;
340 		return BACKSQL_AVL_STOP;
341 	}
342 
343 	backsql_BindRowAsStrings( bas->bas_sth, &at_row );
344 	for ( ; rc = SQLFetch( bas->bas_sth ), BACKSQL_SUCCESS( rc ); ) {
345 		const char	*text = NULL;
346 		struct berval	bv;
347 		struct berbuf	bb = BB_NULL;
348 		AttributeDescription *ad = NULL;
349 
350 		{
351 			struct {
352 				int idx;
353 				char *name;
354 			} required[] = {
355 				{ 0, "name" },
356 				{ 1, "sel_expr" },
357 				{ 2, "from" },
358 				{ -1, NULL },
359 			};
360 			int i;
361 
362 			for ( i = 0; required[ i ].name != NULL; i++ ) {
363 				if ( at_row.value_len[ i ] <= 0 ) {
364 					Debug( LDAP_DEBUG_ANY,
365 						"backsql_oc_get_attr_mapping(): "
366 						"required column #%d \"%s\" is empty\n",
367 						required[ i ].idx, required[ i ].name, 0 );
368 					bas->bas_rc = LDAP_OTHER;
369 					return BACKSQL_AVL_STOP;
370 				}
371 			}
372 		}
373 
374 		{
375 			char		buf[ SLAP_TEXT_BUFLEN ];
376 
377 			snprintf( buf, sizeof( buf ),
378 				"attributeType: "
379 				"name=\"%s\" "
380 				"sel_expr=\"%s\" "
381 				"from=\"%s\" "
382 				"join_where=\"%s\" "
383 				"add_proc=\"%s\" "
384 				"delete_proc=\"%s\" "
385 				"sel_expr_u=\"%s\"",
386 				at_row.cols[ 0 ],
387 				at_row.cols[ 1 ],
388 				at_row.cols[ 2 ],
389 				at_row.cols[ 3 ] ? at_row.cols[ 3 ] : "",
390 				at_row.cols[ 4 ] ? at_row.cols[ 4 ] : "",
391 				at_row.cols[ 5 ] ? at_row.cols[ 5 ] : "",
392 				at_row.cols[ 8 ] ? at_row.cols[ 8 ] : "");
393 			Debug( LDAP_DEBUG_TRACE, "%s\n", buf, 0, 0 );
394 		}
395 
396 		rc = slap_str2ad( at_row.cols[ 0 ], &ad, &text );
397 		if ( rc != LDAP_SUCCESS ) {
398 			Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
399 				"attribute \"%s\" for objectClass \"%s\" "
400 				"is not defined in schema: %s\n",
401 				at_row.cols[ 0 ],
402 				BACKSQL_OC_NAME( oc_map ), text );
403 			bas->bas_rc = LDAP_CONSTRAINT_VIOLATION;
404 			return BACKSQL_AVL_STOP;
405 		}
406 		at_map = (backsql_at_map_rec *)ch_calloc( 1,
407 				sizeof( backsql_at_map_rec ) );
408 		at_map->bam_ad = ad;
409 		at_map->bam_true_ad = ad;
410 		if ( slap_syntax_is_binary( ad->ad_type->sat_syntax )
411 			&& !slap_ad_is_binary( ad ) )
412 		{
413 			char		buf[ SLAP_TEXT_BUFLEN ];
414 			struct berval	bv;
415 			const char	*text = NULL;
416 
417 			bv.bv_val = buf;
418 			bv.bv_len = snprintf( buf, sizeof( buf ), "%s;binary",
419 				ad->ad_cname.bv_val );
420 			at_map->bam_true_ad = NULL;
421 			bas->bas_rc = slap_bv2ad( &bv, &at_map->bam_true_ad, &text );
422 			if ( bas->bas_rc != LDAP_SUCCESS ) {
423 				Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
424 					"unable to fetch attribute \"%s\": %s (%d)\n",
425 					buf, text, rc );
426 				return BACKSQL_AVL_STOP;
427 			}
428 		}
429 
430 		ber_str2bv( at_row.cols[ 1 ], 0, 1, &at_map->bam_sel_expr );
431 		if ( at_row.value_len[ 8 ] <= 0 ) {
432 			BER_BVZERO( &at_map->bam_sel_expr_u );
433 
434 		} else {
435 			ber_str2bv( at_row.cols[ 8 ], 0, 1,
436 					&at_map->bam_sel_expr_u );
437 		}
438 
439 		ber_str2bv( at_row.cols[ 2 ], 0, 0, &bv );
440 		backsql_merge_from_clause( bas->bas_bi, &bb, &bv );
441 		at_map->bam_from_tbls = bb.bb_val;
442 		if ( at_row.value_len[ 3 ] <= 0 ) {
443 			BER_BVZERO( &at_map->bam_join_where );
444 
445 		} else {
446 			ber_str2bv( at_row.cols[ 3 ], 0, 1,
447 					&at_map->bam_join_where );
448 		}
449 		at_map->bam_add_proc = NULL;
450 		if ( at_row.value_len[ 4 ] > 0 ) {
451 			at_map->bam_add_proc = ch_strdup( at_row.cols[ 4 ] );
452 		}
453 		at_map->bam_delete_proc = NULL;
454 		if ( at_row.value_len[ 5 ] > 0 ) {
455 			at_map->bam_delete_proc = ch_strdup( at_row.cols[ 5 ] );
456 		}
457 		if ( lutil_atoix( &at_map->bam_param_order, at_row.cols[ 6 ], 0 ) != 0 ) {
458 			/* error */
459 		}
460 		if ( lutil_atoix( &at_map->bam_expect_return, at_row.cols[ 7 ], 0 ) != 0 ) {
461 			/* error */
462 		}
463 		backsql_make_attr_query( bas->bas_bi, oc_map, at_map );
464 		Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
465 			"preconstructed query \"%s\"\n",
466 			at_map->bam_query, 0, 0 );
467 		at_map->bam_next = NULL;
468 		if ( avl_insert( &oc_map->bom_attrs, at_map, backsql_cmp_attr, backsql_dup_attr ) == BACKSQL_DUPLICATE ) {
469 			Debug( LDAP_DEBUG_TRACE, "backsql_oc_get_attr_mapping(): "
470 					"duplicate attribute \"%s\" "
471 					"in objectClass \"%s\" map\n",
472 					at_map->bam_ad->ad_cname.bv_val,
473 					oc_map->bom_oc->soc_cname.bv_val, 0 );
474 		}
475 
476 		if ( !BER_BVISNULL( &bas->bas_bi->sql_upper_func ) &&
477 				BER_BVISNULL( &at_map->bam_sel_expr_u ) )
478 		{
479 			struct berbuf	bb = BB_NULL;
480 
481 			backsql_strfcat_x( &bb, NULL, "bcbc",
482 					&bas->bas_bi->sql_upper_func,
483 					'(' /* ) */ ,
484 					&at_map->bam_sel_expr,
485 					/* ( */ ')' );
486 			at_map->bam_sel_expr_u = bb.bb_val;
487 		}
488 	}
489 	backsql_FreeRow( &at_row );
490 	SQLFreeStmt( bas->bas_sth, SQL_CLOSE );
491 
492 	Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(\"%s\"): "
493 		"autoadding 'objectClass' and 'ref' mappings\n",
494 		BACKSQL_OC_NAME( oc_map ), 0, 0 );
495 
496 	(void)backsql_add_sysmaps( bas->bas_bi, oc_map );
497 
498 	return BACKSQL_AVL_CONTINUE;
499 }
500 
501 
502 int
503 backsql_load_schema_map( backsql_info *bi, SQLHDBC dbh )
504 {
505 	SQLHSTMT 			sth = SQL_NULL_HSTMT;
506 	RETCODE				rc;
507 	BACKSQL_ROW_NTS			oc_row;
508 	backsql_key_t			oc_id;
509 	backsql_oc_map_rec		*oc_map;
510 	struct backsql_attr_schema_info	bas;
511 
512 	int				delete_proc_idx = 5;
513 	int				create_hint_idx = delete_proc_idx + 2;
514 
515 	Debug( LDAP_DEBUG_TRACE, "==>backsql_load_schema_map()\n", 0, 0, 0 );
516 
517 	/*
518 	 * TimesTen : See if the ldap_entries.dn_ru field exists in the schema
519 	 */
520 	if ( !BACKSQL_DONTCHECK_LDAPINFO_DN_RU( bi ) ) {
521 		rc = backsql_Prepare( dbh, &sth,
522 				backsql_check_dn_ru_query, 0 );
523 		if ( rc == SQL_SUCCESS ) {
524 			/* Yes, the field exists */
525 			bi->sql_flags |= BSQLF_HAS_LDAPINFO_DN_RU;
526    			Debug( LDAP_DEBUG_TRACE, "ldapinfo.dn_ru field exists "
527 				"in the schema\n", 0, 0, 0 );
528 		} else {
529 			/* No such field exists */
530 			bi->sql_flags &= ~BSQLF_HAS_LDAPINFO_DN_RU;
531 		}
532 
533 		SQLFreeStmt( sth, SQL_DROP );
534 	}
535 
536 	Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): oc_query \"%s\"\n",
537 			bi->sql_oc_query, 0, 0 );
538 
539 	rc = backsql_Prepare( dbh, &sth, bi->sql_oc_query, 0 );
540 	if ( rc != SQL_SUCCESS ) {
541 		Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
542 			"error preparing oc_query: \"%s\"\n",
543 			bi->sql_oc_query, 0, 0 );
544 		backsql_PrintErrors( bi->sql_db_env, dbh, sth, rc );
545 		return LDAP_OTHER;
546 	}
547 
548 	rc = SQLExecute( sth );
549 	if ( rc != SQL_SUCCESS ) {
550 		Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
551 			"error executing oc_query: \n", 0, 0, 0 );
552 		backsql_PrintErrors( bi->sql_db_env, dbh, sth, rc );
553 		return LDAP_OTHER;
554 	}
555 
556 	backsql_BindRowAsStrings( sth, &oc_row );
557 	rc = SQLFetch( sth );
558 
559 	if ( BACKSQL_CREATE_NEEDS_SELECT( bi ) ) {
560 		delete_proc_idx++;
561 		create_hint_idx++;
562 	}
563 
564 	for ( ; BACKSQL_SUCCESS( rc ); rc = SQLFetch( sth ) ) {
565 		{
566 			struct {
567 				int idx;
568 				char *name;
569 			} required[] = {
570 				{ 0, "id" },
571 				{ 1, "name" },
572 				{ 2, "keytbl" },
573 				{ 3, "keycol" },
574 				{ -1, "expect_return" },
575 				{ -1, NULL },
576 			};
577 			int i;
578 
579 			required[4].idx = delete_proc_idx + 1;
580 
581 			for ( i = 0; required[ i ].name != NULL; i++ ) {
582 				if ( oc_row.value_len[ required[ i ].idx ] <= 0 ) {
583 					Debug( LDAP_DEBUG_ANY,
584 						"backsql_load_schema_map(): "
585 						"required column #%d \"%s\" is empty\n",
586 						required[ i ].idx, required[ i ].name, 0 );
587 					return LDAP_OTHER;
588 				}
589 			}
590 		}
591 
592 		{
593 			char		buf[ SLAP_TEXT_BUFLEN ];
594 
595 			snprintf( buf, sizeof( buf ),
596 				"objectClass: "
597 				"id=\"%s\" "
598 				"name=\"%s\" "
599 				"keytbl=\"%s\" "
600 				"keycol=\"%s\" "
601 				"create_proc=\"%s\" "
602 				"create_keyval=\"%s\" "
603 				"delete_proc=\"%s\" "
604 				"expect_return=\"%s\""
605 				"create_hint=\"%s\" ",
606 				oc_row.cols[ 0 ],
607 				oc_row.cols[ 1 ],
608 				oc_row.cols[ 2 ],
609 				oc_row.cols[ 3 ],
610 				oc_row.cols[ 4 ] ? oc_row.cols[ 4 ] : "",
611 				( BACKSQL_CREATE_NEEDS_SELECT( bi ) && oc_row.cols[ 5 ] ) ? oc_row.cols[ 5 ] : "",
612 				oc_row.cols[ delete_proc_idx ] ? oc_row.cols[ delete_proc_idx ] : "",
613 				oc_row.cols[ delete_proc_idx + 1 ],
614 				( ( oc_row.ncols > create_hint_idx ) && oc_row.cols[ create_hint_idx ] ) ? oc_row.cols[ create_hint_idx ] : "" );
615 			Debug( LDAP_DEBUG_TRACE, "%s\n", buf, 0, 0 );
616 		}
617 
618 		oc_map = (backsql_oc_map_rec *)ch_calloc( 1,
619 				sizeof( backsql_oc_map_rec ) );
620 
621 		if ( BACKSQL_STR2ID( &oc_map->bom_id, oc_row.cols[ 0 ], 0 ) != 0 ) {
622 			Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
623 				"unable to parse id=\"%s\"\n",
624 				oc_row.cols[ 0 ], 0, 0 );
625 			return LDAP_OTHER;
626 		}
627 
628 		oc_map->bom_oc = oc_find( oc_row.cols[ 1 ] );
629 		if ( oc_map->bom_oc == NULL ) {
630 			Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
631 				"objectClass \"%s\" is not defined in schema\n",
632 				oc_row.cols[ 1 ], 0, 0 );
633 			return LDAP_OTHER;	/* undefined objectClass ? */
634 		}
635 
636 		ber_str2bv( oc_row.cols[ 2 ], 0, 1, &oc_map->bom_keytbl );
637 		ber_str2bv( oc_row.cols[ 3 ], 0, 1, &oc_map->bom_keycol );
638 		oc_map->bom_create_proc = ( oc_row.value_len[ 4 ] <= 0 ) ? NULL
639 			: ch_strdup( oc_row.cols[ 4 ] );
640 
641 		if ( BACKSQL_CREATE_NEEDS_SELECT( bi ) ) {
642 			oc_map->bom_create_keyval = ( oc_row.value_len[ 5 ] <= 0 )
643 				? NULL : ch_strdup( oc_row.cols[ 5 ] );
644 		}
645 		oc_map->bom_delete_proc = ( oc_row.value_len[ delete_proc_idx ] <= 0 ) ? NULL
646 			: ch_strdup( oc_row.cols[ delete_proc_idx ] );
647 		if ( lutil_atoix( &oc_map->bom_expect_return, oc_row.cols[ delete_proc_idx + 1 ], 0 ) != 0 ) {
648 			Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
649 				"unable to parse expect_return=\"%s\" for objectClass \"%s\"\n",
650 				oc_row.cols[ delete_proc_idx + 1 ], oc_row.cols[ 1 ], 0 );
651 			return LDAP_OTHER;
652 		}
653 
654 		if ( ( oc_row.ncols > create_hint_idx ) &&
655 				( oc_row.value_len[ create_hint_idx ] > 0 ) )
656 		{
657 			const char	*text;
658 
659 			oc_map->bom_create_hint = NULL;
660 			rc = slap_str2ad( oc_row.cols[ create_hint_idx ],
661 					&oc_map->bom_create_hint, &text );
662 			if ( rc != SQL_SUCCESS ) {
663 				Debug( LDAP_DEBUG_TRACE, "load_schema_map(): "
664 						"error matching "
665 						"AttributeDescription %s "
666 						"in create_hint: %s (%d)\n",
667 						oc_row.cols[ create_hint_idx ],
668 						text, rc );
669 				backsql_PrintErrors( bi->sql_db_env, dbh,
670 						sth, rc );
671 				return LDAP_OTHER;
672 			}
673 		}
674 
675 		/*
676 		 * FIXME: first attempt to check for offending
677 		 * instructions in {create|delete}_proc
678 		 */
679 
680 		oc_map->bom_attrs = NULL;
681 		if ( avl_insert( &bi->sql_oc_by_oc, oc_map, backsql_cmp_oc, avl_dup_error ) == -1 ) {
682 			Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
683 					"duplicate objectClass \"%s\" in objectClass map\n",
684 					oc_map->bom_oc->soc_cname.bv_val, 0, 0 );
685 			return LDAP_OTHER;
686 		}
687 		if ( avl_insert( &bi->sql_oc_by_id, oc_map, backsql_cmp_oc_id, avl_dup_error ) == -1 ) {
688 			Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
689 					"duplicate objectClass \"%s\" in objectClass by ID map\n",
690 					oc_map->bom_oc->soc_cname.bv_val, 0, 0 );
691 			return LDAP_OTHER;
692 		}
693 		oc_id = oc_map->bom_id;
694 		Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
695 			"objectClass \"%s\":\n    keytbl=\"%s\" keycol=\"%s\"\n",
696 			BACKSQL_OC_NAME( oc_map ),
697 			oc_map->bom_keytbl.bv_val, oc_map->bom_keycol.bv_val );
698 		if ( oc_map->bom_create_proc ) {
699 			Debug( LDAP_DEBUG_TRACE, "    create_proc=\"%s\"\n",
700 				oc_map->bom_create_proc, 0, 0 );
701 		}
702 		if ( oc_map->bom_create_keyval ) {
703 			Debug( LDAP_DEBUG_TRACE, "    create_keyval=\"%s\"\n",
704 				oc_map->bom_create_keyval, 0, 0 );
705 		}
706 		if ( oc_map->bom_create_hint ) {
707 			Debug( LDAP_DEBUG_TRACE, "    create_hint=\"%s\"\n",
708 				oc_map->bom_create_hint->ad_cname.bv_val,
709 				0, 0 );
710 		}
711 		if ( oc_map->bom_delete_proc ) {
712 			Debug( LDAP_DEBUG_TRACE, "    delete_proc=\"%s\"\n",
713 				oc_map->bom_delete_proc, 0, 0 );
714 		}
715 		Debug( LDAP_DEBUG_TRACE, "    expect_return: "
716 			"add=%d, del=%d; attributes:\n",
717 			BACKSQL_IS_ADD( oc_map->bom_expect_return ),
718 			BACKSQL_IS_DEL( oc_map->bom_expect_return ), 0 );
719 	}
720 
721 	backsql_FreeRow( &oc_row );
722 	SQLFreeStmt( sth, SQL_DROP );
723 
724 	/* prepare for attribute fetching */
725 	Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): at_query \"%s\"\n",
726 			bi->sql_at_query, 0, 0 );
727 
728 	rc = backsql_Prepare( dbh, &sth, bi->sql_at_query, 0 );
729 	if ( rc != SQL_SUCCESS ) {
730 		Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
731 			"error preparing at_query: \"%s\"\n",
732 			bi->sql_at_query, 0, 0 );
733 		backsql_PrintErrors( bi->sql_db_env, dbh, sth, rc );
734 		return LDAP_OTHER;
735 	}
736 
737 	rc = backsql_BindParamNumID( sth, 1, SQL_PARAM_INPUT, &oc_id );
738 	if ( rc != SQL_SUCCESS ) {
739 		Debug( LDAP_DEBUG_TRACE, "backsql_load_schema_map(): "
740 			"error binding param \"oc_id\" for at_query\n", 0, 0, 0 );
741 		backsql_PrintErrors( bi->sql_db_env, dbh, sth, rc );
742 		SQLFreeStmt( sth, SQL_DROP );
743 		return LDAP_OTHER;
744 	}
745 
746 	bas.bas_bi = bi;
747 	bas.bas_dbh = dbh;
748 	bas.bas_sth = sth;
749 	bas.bas_oc_id = &oc_id;
750 	bas.bas_rc = LDAP_SUCCESS;
751 
752 	(void)avl_apply( bi->sql_oc_by_oc, backsql_oc_get_attr_mapping,
753 			&bas, BACKSQL_AVL_STOP, AVL_INORDER );
754 
755 	SQLFreeStmt( sth, SQL_DROP );
756 
757 	bi->sql_flags |= BSQLF_SCHEMA_LOADED;
758 
759 	Debug( LDAP_DEBUG_TRACE, "<==backsql_load_schema_map()\n", 0, 0, 0 );
760 
761 	return bas.bas_rc;
762 }
763 
764 backsql_oc_map_rec *
765 backsql_oc2oc( backsql_info *bi, ObjectClass *oc )
766 {
767 	backsql_oc_map_rec	tmp, *res;
768 
769 #ifdef BACKSQL_TRACE
770 	Debug( LDAP_DEBUG_TRACE, "==>backsql_oc2oc(): "
771 		"searching for objectclass with name=\"%s\"\n",
772 		oc->soc_cname.bv_val, 0, 0 );
773 #endif /* BACKSQL_TRACE */
774 
775 	tmp.bom_oc = oc;
776 	res = (backsql_oc_map_rec *)avl_find( bi->sql_oc_by_oc, &tmp, backsql_cmp_oc );
777 #ifdef BACKSQL_TRACE
778 	if ( res != NULL ) {
779 		Debug( LDAP_DEBUG_TRACE, "<==backsql_oc2oc(): "
780 			"found name=\"%s\", id=%d\n",
781 			BACKSQL_OC_NAME( res ), res->bom_id, 0 );
782 	} else {
783 		Debug( LDAP_DEBUG_TRACE, "<==backsql_oc2oc(): "
784 			"not found\n", 0, 0, 0 );
785 	}
786 #endif /* BACKSQL_TRACE */
787 
788 	return res;
789 }
790 
791 backsql_oc_map_rec *
792 backsql_name2oc( backsql_info *bi, struct berval *oc_name )
793 {
794 	backsql_oc_map_rec	tmp, *res;
795 
796 #ifdef BACKSQL_TRACE
797 	Debug( LDAP_DEBUG_TRACE, "==>oc_with_name(): "
798 		"searching for objectclass with name=\"%s\"\n",
799 		oc_name->bv_val, 0, 0 );
800 #endif /* BACKSQL_TRACE */
801 
802 	tmp.bom_oc = oc_bvfind( oc_name );
803 	if ( tmp.bom_oc == NULL ) {
804 		return NULL;
805 	}
806 
807 	res = (backsql_oc_map_rec *)avl_find( bi->sql_oc_by_oc, &tmp, backsql_cmp_oc );
808 #ifdef BACKSQL_TRACE
809 	if ( res != NULL ) {
810 		Debug( LDAP_DEBUG_TRACE, "<==oc_with_name(): "
811 			"found name=\"%s\", id=%d\n",
812 			BACKSQL_OC_NAME( res ), res->bom_id, 0 );
813 	} else {
814 		Debug( LDAP_DEBUG_TRACE, "<==oc_with_name(): "
815 			"not found\n", 0, 0, 0 );
816 	}
817 #endif /* BACKSQL_TRACE */
818 
819 	return res;
820 }
821 
822 backsql_oc_map_rec *
823 backsql_id2oc( backsql_info *bi, unsigned long id )
824 {
825 	backsql_oc_map_rec	tmp, *res;
826 
827 #ifdef BACKSQL_TRACE
828 	Debug( LDAP_DEBUG_TRACE, "==>oc_with_id(): "
829 		"searching for objectclass with id=%lu\n", id, 0, 0 );
830 #endif /* BACKSQL_TRACE */
831 
832 	tmp.bom_id = id;
833 	res = (backsql_oc_map_rec *)avl_find( bi->sql_oc_by_id, &tmp,
834 			backsql_cmp_oc_id );
835 
836 #ifdef BACKSQL_TRACE
837 	if ( res != NULL ) {
838 		Debug( LDAP_DEBUG_TRACE, "<==oc_with_id(): "
839 			"found name=\"%s\", id=%lu\n",
840 			BACKSQL_OC_NAME( res ), res->bom_id, 0 );
841 	} else {
842 		Debug( LDAP_DEBUG_TRACE, "<==oc_with_id(): "
843 			"id=%lu not found\n", res->bom_id, 0, 0 );
844 	}
845 #endif /* BACKSQL_TRACE */
846 
847 	return res;
848 }
849 
850 backsql_at_map_rec *
851 backsql_ad2at( backsql_oc_map_rec* objclass, AttributeDescription *ad )
852 {
853 	backsql_at_map_rec	tmp = { 0 }, *res;
854 
855 #ifdef BACKSQL_TRACE
856 	Debug( LDAP_DEBUG_TRACE, "==>backsql_ad2at(): "
857 		"searching for attribute \"%s\" for objectclass \"%s\"\n",
858 		ad->ad_cname.bv_val, BACKSQL_OC_NAME( objclass ), 0 );
859 #endif /* BACKSQL_TRACE */
860 
861 	tmp.bam_ad = ad;
862 	res = (backsql_at_map_rec *)avl_find( objclass->bom_attrs, &tmp,
863 			backsql_cmp_attr );
864 
865 #ifdef BACKSQL_TRACE
866 	if ( res != NULL ) {
867 		Debug( LDAP_DEBUG_TRACE, "<==backsql_ad2at(): "
868 			"found name=\"%s\", sel_expr=\"%s\"\n",
869 			res->bam_ad->ad_cname.bv_val,
870 			res->bam_sel_expr.bv_val, 0 );
871 	} else {
872 		Debug( LDAP_DEBUG_TRACE, "<==backsql_ad2at(): "
873 			"not found\n", 0, 0, 0 );
874 	}
875 #endif /* BACKSQL_TRACE */
876 
877 	return res;
878 }
879 
880 /* attributeType inheritance */
881 struct supad2at_t {
882 	backsql_at_map_rec	**ret;
883 	AttributeDescription	*ad;
884 	unsigned		n;
885 };
886 
887 #define SUPAD2AT_STOP	(-1)
888 
889 static int
890 supad2at_f( void *v_at, void *v_arg )
891 {
892 	backsql_at_map_rec	*at = (backsql_at_map_rec *)v_at;
893 	struct supad2at_t	*va = (struct supad2at_t *)v_arg;
894 
895 	if ( is_at_subtype( at->bam_ad->ad_type, va->ad->ad_type ) ) {
896 		backsql_at_map_rec	**ret = NULL;
897 		unsigned		i;
898 
899 		/* if already listed, holler! (should never happen) */
900 		if ( va->ret ) {
901 			for ( i = 0; i < va->n; i++ ) {
902 				if ( va->ret[ i ]->bam_ad == at->bam_ad ) {
903 					break;
904 				}
905 			}
906 
907 			if ( i < va->n ) {
908 				return 0;
909 			}
910 		}
911 
912 		ret = ch_realloc( va->ret,
913 				sizeof( backsql_at_map_rec * ) * ( va->n + 2 ) );
914 		if ( ret == NULL ) {
915 			ch_free( va->ret );
916 			va->ret = NULL;
917 			va->n = 0;
918 			return SUPAD2AT_STOP;
919 		}
920 
921 		ret[ va->n ] = at;
922 		va->n++;
923 		ret[ va->n ] = NULL;
924 		va->ret = ret;
925 	}
926 
927 	return 0;
928 }
929 
930 /*
931  * stores in *pret a NULL terminated array of pointers
932  * to backsql_at_map_rec whose attributeType is supad->ad_type
933  * or derived from it
934  */
935 int
936 backsql_supad2at( backsql_oc_map_rec *objclass, AttributeDescription *supad,
937 		backsql_at_map_rec ***pret )
938 {
939 	struct supad2at_t	va = { 0 };
940 	int			rc;
941 
942 	assert( objclass != NULL );
943 	assert( supad != NULL );
944 	assert( pret != NULL );
945 
946 	*pret = NULL;
947 
948 	va.ad = supad;
949 
950 	rc = avl_apply( objclass->bom_attrs, supad2at_f, &va,
951 			SUPAD2AT_STOP, AVL_INORDER );
952 	if ( rc == SUPAD2AT_STOP ) {
953 		return -1;
954 	}
955 
956 	*pret = va.ret;
957 
958 	return 0;
959 }
960 
961 static void
962 backsql_free_attr( void *v_at )
963 {
964 	backsql_at_map_rec	*at = v_at;
965 
966 	Debug( LDAP_DEBUG_TRACE, "==>free_attr(): \"%s\"\n",
967 			at->bam_ad->ad_cname.bv_val, 0, 0 );
968 	ch_free( at->bam_sel_expr.bv_val );
969 	if ( !BER_BVISNULL( &at->bam_from_tbls ) ) {
970 		ch_free( at->bam_from_tbls.bv_val );
971 	}
972 	if ( !BER_BVISNULL( &at->bam_join_where ) ) {
973 		ch_free( at->bam_join_where.bv_val );
974 	}
975 	if ( at->bam_add_proc != NULL ) {
976 		ch_free( at->bam_add_proc );
977 	}
978 	if ( at->bam_delete_proc != NULL ) {
979 		ch_free( at->bam_delete_proc );
980 	}
981 	if ( at->bam_query != NULL ) {
982 		ch_free( at->bam_query );
983 	}
984 
985 #ifdef BACKSQL_COUNTQUERY
986 	if ( at->bam_countquery != NULL ) {
987 		ch_free( at->bam_countquery );
988 	}
989 #endif /* BACKSQL_COUNTQUERY */
990 
991 	/* TimesTen */
992 	if ( !BER_BVISNULL( &at->bam_sel_expr_u ) ) {
993 		ch_free( at->bam_sel_expr_u.bv_val );
994 	}
995 
996 	if ( at->bam_next ) {
997 		backsql_free_attr( at->bam_next );
998 	}
999 
1000 	ch_free( at );
1001 
1002 	Debug( LDAP_DEBUG_TRACE, "<==free_attr()\n", 0, 0, 0 );
1003 }
1004 
1005 static void
1006 backsql_free_oc( void *v_oc )
1007 {
1008 	backsql_oc_map_rec	*oc = v_oc;
1009 
1010 	Debug( LDAP_DEBUG_TRACE, "==>free_oc(): \"%s\"\n",
1011 			BACKSQL_OC_NAME( oc ), 0, 0 );
1012 	avl_free( oc->bom_attrs, backsql_free_attr );
1013 	ch_free( oc->bom_keytbl.bv_val );
1014 	ch_free( oc->bom_keycol.bv_val );
1015 	if ( oc->bom_create_proc != NULL ) {
1016 		ch_free( oc->bom_create_proc );
1017 	}
1018 	if ( oc->bom_create_keyval != NULL ) {
1019 		ch_free( oc->bom_create_keyval );
1020 	}
1021 	if ( oc->bom_delete_proc != NULL ) {
1022 		ch_free( oc->bom_delete_proc );
1023 	}
1024 	ch_free( oc );
1025 
1026 	Debug( LDAP_DEBUG_TRACE, "<==free_oc()\n", 0, 0, 0 );
1027 }
1028 
1029 int
1030 backsql_destroy_schema_map( backsql_info *bi )
1031 {
1032 	Debug( LDAP_DEBUG_TRACE, "==>destroy_schema_map()\n", 0, 0, 0 );
1033 	avl_free( bi->sql_oc_by_oc, 0 );
1034 	avl_free( bi->sql_oc_by_id, backsql_free_oc );
1035 	Debug( LDAP_DEBUG_TRACE, "<==destroy_schema_map()\n", 0, 0, 0 );
1036 	return 0;
1037 }
1038 
1039