1 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3 * Copyright 1999-2005 The OpenLDAP Foundation.
4 * Portions Copyright 1999 Dmitry Kovalev.
5 * Portions Copyright 2002 Pierangelo Mararati.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
17 * This work was initially developed by Dmitry Kovalev for inclusion
18 * by OpenLDAP Software. Additional significant contributors include
23 * The following changes have been addressed:
26 * - re-styled code for better readability
27 * - upgraded backend API to reflect recent changes
28 * - LDAP schema is checked when loading SQL/LDAP mapping
29 * - AttributeDescription/ObjectClass pointers used for more efficient
31 * - bervals used where string length is required often
32 * - atomized write operations by committing at the end of each operation
33 * and defaulting connection closure to rollback
34 * - added LDAP access control to write operations
35 * - fully implemented modrdn (with rdn attrs change, deleteoldrdn,
36 * access check, parent/children check and more)
37 * - added parent access control, children control to delete operation
38 * - added structuralObjectClass operational attribute check and
39 * value return on search
40 * - added hasSubordinate operational attribute on demand
41 * - search limits are appropriately enforced
42 * - function backsql_strcat() has been made more efficient
43 * - concat function has been made configurable by means of a pattern
44 * - added config switches:
45 * - fail_if_no_mapping write operations fail if there is no mapping
46 * - has_ldapinfo_dn_ru overrides autodetect
47 * - concat_pattern a string containing two '?' is used
48 * (note that "?||?" should be more portable
49 * than builtin function "CONCAT(?,?)")
50 * - strcast_func cast of string constants in "SELECT DISTINCT
51 * statements (needed by PostgreSQL)
52 * - upper_needs_cast cast the argument of upper when required
53 * (basically when building dn substring queries)
54 * - added noop control
55 * - added values return filter control
56 * - hasSubordinate can be used in search filters (with limitations)
57 * - eliminated oc->name; use oc->oc->soc_cname instead
60 * - add security checks for SQL statements that can be injected (?)
61 * - re-test with previously supported RDBMs
62 * - replace dn_ru and so with normalized dn (no need for upper() and so
64 * - implement a backsql_normalize() function to replace the upper()
66 * - note that subtree deletion, subtree renaming and so could be easily
67 * implemented (rollback and consistency checks are available :)
68 * - implement "lastmod" and other operational stuff (ldap_entries table ?)
69 * - check how to allow multiple operations with one statement, to remove
70 * BACKSQL_REALLOC_STMT from modify.c (a more recent unixODBC lib?)
77 #include "sql-types.h"
82 int backsql_modify_delete_all_values(
86 backsql_entryID *e_id,
87 backsql_at_map_rec *at );
89 int backsql_modify_internal(
93 backsql_oc_map_rec *oc,
94 backsql_entryID *e_id,
95 Modifications *modlist );
100 int backsql_api_config( backsql_info *si, const char *name );
101 int backsql_api_register( backsql_api *ba );
102 int backsql_api_dn2odbc( Operation *op, SlapReply *rs, struct berval *dn );
103 int backsql_api_odbc2dn( Operation *op, SlapReply *rs, struct berval *dn );
109 /* stores in *id the ID in table ldap_entries corresponding to DN, if any */
110 int backsql_dn2id( backsql_info *bi, backsql_entryID *id,
111 SQLHDBC dbh, struct berval *dn );
113 /* stores in *nchildren the count of children for an entry */
114 int backsql_count_children( backsql_info *bi, SQLHDBC dbh,
115 struct berval *dn, unsigned long *nchildren );
117 /* returns LDAP_COMPARE_TRUE/LDAP_COMPARE_FALSE if the entry corresponding
118 * to DN has/has not children */
119 int backsql_has_children( backsql_info *bi, SQLHDBC dbh, struct berval *dn );
121 /* frees *id and returns next in list */
122 backsql_entryID *backsql_free_entryID( backsql_entryID *id, int freeit );
124 /* turns an ID into an entry */
125 int backsql_id2entry( backsql_srch_info *bsi, backsql_entryID *id );
131 int backsql_load_schema_map( backsql_info *si, SQLHDBC dbh );
133 backsql_oc_map_rec *backsql_oc2oc( backsql_info *si, ObjectClass *oc );
135 backsql_oc_map_rec *backsql_id2oc( backsql_info *si, unsigned long id );
137 backsql_oc_map_rec * backsql_name2oc( backsql_info *si,
138 struct berval *oc_name );
140 backsql_at_map_rec *backsql_ad2at( backsql_oc_map_rec *objclass,
141 AttributeDescription *ad );
143 int backsql_supad2at( backsql_oc_map_rec *objclass,
144 AttributeDescription *supad, backsql_at_map_rec ***pret );
146 int backsql_destroy_schema_map( backsql_info *si );
152 void backsql_init_search( backsql_srch_info *bsi,
153 struct berval *nbase, int scope, int slimit, int tlimit,
154 time_t stoptime, Filter *filter, SQLHDBC dbh,
155 Operation *op, SlapReply *rs, AttributeName *attrs );
161 RETCODE backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, char* query, int timeout );
163 #define backsql_BindParamStr( sth, par_ind, str, maxlen ) \
164 SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
166 SQL_C_CHAR, SQL_VARCHAR, \
167 (SQLUINTEGER)(maxlen), 0, (SQLPOINTER)(str), \
168 (SQLUINTEGER)(maxlen), NULL )
170 #define backsql_BindParamID( sth, par_ind, id ) \
171 SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
172 SQL_PARAM_INPUT, SQL_C_ULONG, SQL_INTEGER, \
173 0, 0, (SQLPOINTER)(id), 0, (SQLINTEGER*)NULL )
175 RETCODE backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row );
177 RETCODE backsql_FreeRow( BACKSQL_ROW_NTS *row );
179 void backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc );
181 int backsql_init_db_env( backsql_info *si );
183 int backsql_free_db_env( backsql_info *si );
185 int backsql_get_db_conn( Operation *op, SQLHDBC *dbh );
187 int backsql_free_db_conn( Operation *op );
194 backsql_def_oc_query[],
195 backsql_def_needs_select_oc_query[],
196 backsql_def_at_query[],
197 backsql_def_delentry_query[],
198 backsql_def_insentry_query[],
199 backsql_def_delobjclasses_query[],
200 backsql_def_delreferrals_query[],
201 backsql_def_subtree_cond[],
202 backsql_def_upper_subtree_cond[],
204 backsql_def_concat_func[];
206 backsql_check_dn_ru_query[];
208 struct berbuf * backsql_strcat( struct berbuf *dest, ... );
209 struct berbuf * backsql_strfcat( struct berbuf *dest, const char *fmt, ... );
211 int backsql_entry_addattr( Entry *e, struct berval *at_name,
212 struct berval *at_val, void *memctx );
214 int backsql_merge_from_clause( struct berbuf *dest_from,
215 struct berval *src_from );
217 int backsql_split_pattern( const char *pattern, BerVarray *split_pattern,
220 int backsql_prepare_pattern( BerVarray split_pattern, BerVarray values,
221 struct berval *res );
223 #endif /* PROTO_SQL_H */