]> git.sur5r.net Git - openldap/blob - servers/slapd/back-sql/search.c
Updated for schemas.
[openldap] / servers / slapd / back-sql / search.c
1 /*
2  *       Copyright 1999, Dmitry Kovalev <mit@openldap.org>, All rights reserved.
3  *
4  *       Redistribution and use in source and binary forms are permitted only
5  *       as authorized by the OpenLDAP Public License.  A copy of this
6  *       license is available at http://www.OpenLDAP.org/license.html or
7  *       in file LICENSE in the top-level directory of the distribution.
8  */
9
10 #include "portable.h"
11
12 #ifdef SLAPD_SQL
13
14 #include <stdio.h>
15 #include <sys/types.h>
16 #include <string.h>
17 #include "slap.h"
18 #include "back-sql.h"
19 #include "sql-wrap.h"
20 #include "schema-map.h"
21 #include "entry-id.h"
22 #include "util.h"
23
24 int backsql_attrlist_add(backsql_srch_info *bsi,char *at_name)
25 {
26  char **p=bsi->attrs;
27  int n_attrs=0;
28
29  if (bsi->attrs==NULL)
30   return 1;
31
32  while(*p)
33  {
34   Debug(LDAP_DEBUG_TRACE,"==>backsql_attrlist_add(): attribute '%s' is in list\n",*p,0,0);
35   if (!strcasecmp(*p,at_name))
36    return 1;
37   n_attrs++;
38   p++;
39  }
40  Debug(LDAP_DEBUG_TRACE,"==>backsql_attrlist_add(): adding '%s' to list\n",at_name,0,0);
41  bsi->attrs=(char**)ch_realloc(bsi->attrs,(n_attrs+2)*sizeof(char*));
42  bsi->attrs[n_attrs]=ch_strdup(at_name);
43  bsi->attrs[n_attrs+1]=NULL;
44  return 1;
45 }
46
47 void backsql_init_search(backsql_srch_info *bsi,backsql_info *bi,char *nbase,int scope,
48                                                  int slimit,int tlimit,time_t stoptime,Filter *filter,
49                                                  SQLHDBC dbh,BackendDB *be,Connection *conn,Operation *op,char **attrs)
50 {
51  char **p;
52  bsi->base_dn=nbase;
53  bsi->scope=scope;
54  bsi->slimit=slimit;
55  bsi->tlimit=tlimit;
56  bsi->filter=filter;
57  bsi->dbh=dbh;
58  bsi->be=be;
59  bsi->conn=conn;
60  bsi->op=op;
61  if (attrs!=NULL)
62  {
63   bsi->attrs=(char**)ch_calloc(1,sizeof(char*));
64   bsi->attrs[0]=NULL;
65   for(p=attrs;*p!=NULL;p++)
66    backsql_attrlist_add(bsi,*p);
67  }
68  else
69   bsi->attrs=attrs;
70  bsi->abandon=0;
71  bsi->id_list=NULL;
72  bsi->stoptime=stoptime;
73  bsi->bi=bi;
74  bsi->sel=NULL; bsi->from=NULL; bsi->join_where=NULL; bsi->flt_where=NULL;
75  bsi->sel_len=0; bsi->from_len=0; bsi->jwhere_len=0; bsi->fwhere_len=0;
76 }
77
78 int backsql_process_filter_list(backsql_srch_info *bsi,Filter *f,int op)
79 {
80  char *sub_clause=NULL;
81  int len=0,res;
82
83  bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",NULL);
84  while(1)
85  {
86   res=backsql_process_filter(bsi,f);
87   
88   f=f->f_next;
89   if (f==NULL)
90    break;
91
92   switch (op)
93   {
94    case LDAP_FILTER_AND:
95                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len," AND ",NULL);
96                         break;
97    case LDAP_FILTER_OR:
98                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len," OR ",NULL);
99                         break;
100   }
101  }
102
103  
104  bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,")",NULL);
105  return 1;
106 }
107
108 int backsql_process_sub_filter(backsql_srch_info *bsi,Filter *f)
109 {
110  int i;
111
112  backsql_at_map_rec *at=backsql_at_with_name(bsi->oc,f->f_sub_type);
113
114  bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",NULL);
115
116  if (bsi->bi->upper_func)
117  {
118   bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,
119           bsi->bi->upper_func,"(",at->sel_expr,")",
120                                 " LIKE '",NULL);
121  }
122  else
123  {
124   bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,at->sel_expr,
125                                 " LIKE '",NULL);
126  }
127  if (f->f_sub_initial!=NULL)
128  {
129   bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,f->f_sub_initial->bv_val,NULL);
130  }
131
132  bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"%",NULL);
133
134  if (f->f_sub_any!=NULL)
135   for(i=0;f->f_sub_any[i]!=NULL;i++)
136   {
137    //Debug(LDAP_DEBUG_TRACE,"==>backsql_process_sub_filter(): sub_any='%s'\n",f->f_sub_any[i]->bv_val,0,0);
138    bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,f->f_sub_any[i]->bv_val,"%",NULL);
139   }
140
141  if (f->f_sub_final!=NULL)
142   bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,f->f_sub_final->bv_val,NULL);
143
144  bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"')",NULL);
145  
146  return 1;
147 }
148
149 int backsql_process_filter(backsql_srch_info *bsi,Filter *f)
150 {
151  backsql_at_map_rec *at;
152  backsql_at_map_rec oc_attr={"objectClass","","",NULL,NULL,NULL,NULL};
153  char *at_name=NULL;
154  int done=0,len=0;
155
156  Debug(LDAP_DEBUG_TRACE,"==>backsql_process_filter()\n",0,0,0);
157  switch(f->f_choice)
158  {
159   case LDAP_FILTER_OR:
160                         backsql_process_filter_list(bsi,f->f_or,LDAP_FILTER_OR);
161                         done=1;
162                         break;
163   case LDAP_FILTER_AND:
164                         backsql_process_filter_list(bsi,f->f_and,LDAP_FILTER_AND);
165                         done=1;
166                         break;
167   case LDAP_FILTER_NOT:
168                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"NOT (",NULL);
169                         backsql_process_filter(bsi,f->f_not);
170                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,")",NULL);
171                         done=1;
172                         break;
173   case LDAP_FILTER_PRESENT:
174                         at_name=f->f_type;
175                         break;
176   default:
177                         at_name=f->f_avtype;
178                         break;
179  }
180  
181  if (done)
182   goto done;
183
184  if (strcasecmp(at_name,"objectclass"))
185   at=backsql_at_with_name(bsi->oc,at_name);
186  else
187  {
188   at=&oc_attr;
189   at->sel_expr=backsql_strcat(at->sel_expr,&len,"'",bsi->oc->name,"'",NULL);
190  }
191  if (at==NULL)
192  {
193   Debug(LDAP_DEBUG_TRACE,"backsql_process_filter(): attribute '%s' is not defined for objectclass '%s'\n",
194                       at_name,bsi->oc->name,0);
195   bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len," 1=0 ",NULL);
196   return -1;
197  }
198                         
199  backsql_merge_from_clause(&bsi->from,&bsi->from_len,at->from_tbls);
200  //need to add this attribute to list of attrs to load, so that we could do test_filter() later
201  backsql_attrlist_add(bsi,at_name);
202
203  if (at->join_where != NULL && strstr(bsi->join_where,at->join_where)==NULL)
204   bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len," AND ",at->join_where,NULL);
205
206  //if (at!=&oc_attr)
207  // bsi->sel=backsql_strcat(bsi->sel,&bsi->sel_len,",",at->sel_expr," AS ",at->name,NULL);
208
209  switch(f->f_choice)
210  {
211   case LDAP_FILTER_EQUALITY:
212                         //maybe we should check type of at->sel_expr here somehow,
213                         //to know whether upper_func is applicable, but for now
214                         //upper_func stuff is made for Oracle, where UPPER is
215                         //safely applicable to NUMBER etc.
216                         if (bsi->bi->upper_func)
217                          bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",
218                                         bsi->bi->upper_func,"(",at->sel_expr,")='",
219                                                                                         f->f_avvalue.bv_val,"')",NULL);
220                         else
221                          bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",at->sel_expr,"='",
222                                                                                         f->f_avvalue.bv_val,"')",NULL);
223                         break;
224   case LDAP_FILTER_GE:
225                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",at->sel_expr,">=",
226                                                                                                                         f->f_avvalue.bv_val,")",NULL);
227                         break;
228   case LDAP_FILTER_LE:
229                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"(",at->sel_expr,"<=",
230                                                                                                                         f->f_avvalue.bv_val,")",NULL);
231                         break;
232   case LDAP_FILTER_PRESENT:
233                         bsi->flt_where=backsql_strcat(bsi->flt_where,&bsi->fwhere_len,"NOT (",at->sel_expr,
234                                                 " IS NULL)",NULL);
235                         break;
236   case LDAP_FILTER_SUBSTRINGS:
237                         backsql_process_sub_filter(bsi,f);
238                         break;
239  }
240
241 done:
242  if (oc_attr.sel_expr!=NULL)
243   free(oc_attr.sel_expr);
244  Debug(LDAP_DEBUG_TRACE,"<==backsql_process_filter()\n",0,0,0);
245  return 1;
246 }
247
248 char* backsql_srch_query(backsql_srch_info *bsi)
249 {
250  char *query=NULL;
251  int q_len=0;
252
253  Debug(LDAP_DEBUG_TRACE,"==>backsql_srch_query()\n",0,0,0);
254  bsi->sel=NULL;
255  bsi->from=NULL;
256  bsi->join_where=NULL;
257  bsi->flt_where=NULL;
258  bsi->sel_len=bsi->from_len=bsi->jwhere_len=bsi->fwhere_len=0;
259
260  bsi->sel=backsql_strcat(bsi->sel,&bsi->sel_len,
261                                 "SELECT ldap_entries.id,",bsi->oc->keytbl,".",bsi->oc->keycol,
262                                 ", '",bsi->oc->name,"' AS objectClass",
263                                 ", ldap_entries.dn AS dn",
264                                 NULL);
265  bsi->from=backsql_strcat(bsi->from,&bsi->from_len," FROM ldap_entries,",bsi->oc->keytbl,NULL);
266  bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len," WHERE ",
267          bsi->oc->keytbl,".",bsi->oc->keycol,"=ldap_entries.keyval AND ",
268          "ldap_entries.objclass=? AND ",NULL);
269
270  switch(bsi->scope)
271  {
272   case LDAP_SCOPE_BASE:
273         if (bsi->bi->upper_func)
274                  {
275                   bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len,
276                          bsi->bi->upper_func,"(","ldap_entries.dn)=(?)",NULL);
277                  }
278                 else
279                  {
280                   bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len,
281                                 "ldap_entries.dn=?",NULL);
282                  }
283                 break;
284   case LDAP_SCOPE_ONELEVEL:
285                 bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len,
286                                 "ldap_entries.parent=?",NULL);
287                 break;
288   case LDAP_SCOPE_SUBTREE:
289                 bsi->join_where=backsql_strcat(bsi->join_where,&bsi->jwhere_len,
290                                 bsi->bi->subtree_cond,NULL);
291                 break;
292  }
293  if (backsql_process_filter(bsi,bsi->filter))
294   query=backsql_strcat(query,&q_len,bsi->sel,bsi->from,bsi->join_where," AND ",bsi->flt_where,NULL);
295
296  
297  free(bsi->sel);
298  free(bsi->from);
299  free(bsi->join_where);
300  free(bsi->flt_where);
301  bsi->sel_len=bsi->from_len=bsi->jwhere_len=bsi->fwhere_len=0;
302  Debug(LDAP_DEBUG_TRACE,"<==backsql_srch_query()\n",0,0,0);
303  return query;
304 }
305
306 int backsql_oc_get_candidates(backsql_oc_map_rec *oc,backsql_srch_info *bsi)
307 {
308  char *query=NULL;
309  SQLHSTMT sth;
310  RETCODE rc;
311  backsql_entryID base_id,*res,*c_id;
312  //Entry *e;
313  BACKSQL_ROW_NTS row;
314  //int i;
315  
316  Debug(LDAP_DEBUG_TRACE,"==>backsql_oc_get_candidates(): oc='%s'\n",oc->name,0,0);
317  bsi->oc=oc;
318  query=backsql_srch_query(bsi);
319  if (query==NULL)
320  {
321   Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): could not construct query for objectclass\n",0,0,0);
322   return 1;
323  }
324
325  Debug(LDAP_DEBUG_TRACE,"Constructed query: %s\n",query,0,0);
326  if ((rc=backsql_Prepare(bsi->dbh,&sth,query,0)) != SQL_SUCCESS)
327   {
328    Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): error preparing query\n",0,0,0);
329    backsql_PrintErrors(bsi->bi->db_env,bsi->dbh,sth,rc);
330    free(query);
331    return 1;
332   }
333  free(query);
334
335  if (backsql_BindParamID(sth,1,&bsi->oc->id) != SQL_SUCCESS)
336  {
337   Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): error binding objectclass id parameter\n",0,0,0);
338   return 1;
339  }
340  switch(bsi->scope)
341  {
342   case LDAP_SCOPE_BASE:
343   case LDAP_SCOPE_SUBTREE:
344                 if ((rc=backsql_BindParamStr(sth,2,bsi->base_dn,BACKSQL_MAX_DN_LEN)) != SQL_SUCCESS)
345                 {
346          Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): error binding base_dn parameter\n",0,0,0);
347                  backsql_PrintErrors(bsi->bi->db_env,bsi->dbh,sth,rc);
348          return 1;
349                 }
350                 break;
351   case LDAP_SCOPE_ONELEVEL:
352                 res=backsql_dn2id(bsi->bi,&base_id,bsi->dbh,bsi->base_dn);
353                 if (res==NULL)
354                 {
355                  Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): could not retrieve base_dn id - no such entry\n",0,0,0);
356                  bsi->status=LDAP_NO_SUCH_OBJECT;
357                  return 0;
358                 }
359                 if (backsql_BindParamID(sth,2,&base_id.id) != SQL_SUCCESS)
360                 {
361                  Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): error binding base id parameter\n",0,0,0);
362                  free(base_id.dn);
363                  return 1;
364                 }               
365                 free(base_id.dn);
366                 break;
367  }
368  
369  if ((rc=SQLExecute(sth)) != SQL_SUCCESS && rc!= SQL_SUCCESS_WITH_INFO)
370   {
371    Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): error executing query\n",0,0,0);
372    backsql_PrintErrors(bsi->bi->db_env,bsi->dbh,sth,rc);
373    SQLFreeStmt(sth,SQL_DROP);
374    return 1;
375   }
376
377  backsql_BindRowAsStrings(sth,&row);
378  while ((rc=SQLFetch(sth)) == SQL_SUCCESS || rc==SQL_SUCCESS_WITH_INFO)
379   {
380    /*
381    e=(Entry*)ch_calloc(1,sizeof(Entry)); 
382    for (i=1;i<row.ncols;i++)
383     {
384      if (row.is_null[i]>0)
385       {
386        backsql_entry_addattr(e,row.col_names[i],row.cols[i],row.col_prec[i]);
387 //       Debug(LDAP_DEBUG_TRACE,"prec=%d\n",(int)row.col_prec[i],0,0);
388       }
389     // else
390     //  Debug(LDAP_DEBUG_TRACE,"NULL value in this row for attribute '%s'\n",row.col_names[i],0,0);
391     }
392    */
393
394    c_id=(backsql_entryID*)ch_calloc(1,sizeof(backsql_entryID));
395    c_id->id=atoi(row.cols[0]);
396    c_id->keyval=atoi(row.cols[1]);
397    c_id->oc_id=bsi->oc->id;
398    c_id->dn=ch_strdup(row.cols[3]);
399    c_id->next=bsi->id_list;
400    bsi->id_list=c_id;
401    Debug(LDAP_DEBUG_TRACE,"backsql_oc_get_candidates(): added entry id=%d, keyval=%d dn='%s'\n",
402                 c_id->id,c_id->keyval,row.cols[3]);
403   }
404  backsql_FreeRow(&row);
405  SQLFreeStmt(sth,SQL_DROP);
406  Debug(LDAP_DEBUG_TRACE,"<==backsql_oc_get_candidates()\n",0,0,0);
407  return 1;
408 }
409
410 int backsql_search(BackendDB *be,Connection *conn,Operation *op,
411         const char *base, const char *nbase, int scope,int deref,int slimit,int tlimit,
412         Filter *filter, const char *filterstr,char **attrs,int attrsonly)
413 {
414  backsql_info *bi=(backsql_info*)be->be_private;
415  SQLHDBC dbh;
416  int sres;
417  int nentries;
418  Entry entry,*res;
419  int manageDSAit = get_manageDSAit( op );
420  struct berval **v2refs = NULL;
421  time_t stoptime;
422  backsql_srch_info srch_info;
423  backsql_entryID *eid=NULL;
424
425  Debug(LDAP_DEBUG_TRACE,"==>backsql_search(): base='%s', filter='%s', scope=%d,",
426                      nbase,filterstr,scope);
427  Debug(LDAP_DEBUG_TRACE," deref=%d, attrsonly=%d, attributes to load: %s\n",
428          deref,attrsonly,attrs==NULL?"all":"custom list");
429  dbh=backsql_get_db_conn(be,conn);
430
431  if (!dbh)
432  {
433   Debug(LDAP_DEBUG_TRACE,"backsql_search(): could not get connection handle - exiting\n",0,0,0);
434   send_ldap_result(conn,op,LDAP_OTHER,"","SQL-backend error",NULL,NULL);
435   return 1;
436  }
437  
438  if (tlimit == 0 && be_isroot(be,op->o_dn))
439   {
440    tlimit = -1; /* allow root to set no limit */
441   } 
442  else
443   {
444    tlimit = (tlimit > be->be_timelimit || tlimit < 1) ?
445                     be->be_timelimit : tlimit;
446    stoptime = op->o_time + tlimit;
447   }
448   
449  if (slimit == 0 && be_isroot(be,op->o_dn))
450   {
451    slimit = -1; /* allow root to set no limit */
452   }
453  else
454   {
455    slimit = (slimit > be->be_sizelimit || slimit < 1) ?
456                     be->be_sizelimit : slimit;
457   }
458
459  backsql_init_search(&srch_info,bi,(char*)nbase,scope,slimit,tlimit,stoptime,filter,dbh,
460                  be,conn,op,attrs);
461
462  //for each objectclass we try to construct query which gets IDs
463  //of entries matching LDAP query filter and scope (or at least candidates),
464  //and get the IDs
465  avl_apply(bi->oc_by_name,(AVL_APPLY)backsql_oc_get_candidates,&srch_info,0,AVL_INORDER);
466              
467  nentries=0;
468  //now we load candidate entries (only those attrubutes mentioned in attrs and filter),
469  //test it against full filter and then send to client
470  for(eid=srch_info.id_list;eid!=NULL;eid=eid->next)
471   {
472    /* check for abandon */
473    ldap_pvt_thread_mutex_lock(&op->o_abandonmutex);
474    if (op->o_abandon)
475     {
476      ldap_pvt_thread_mutex_unlock(&op->o_abandonmutex);
477      break;
478     }
479    ldap_pvt_thread_mutex_unlock(&op->o_abandonmutex);
480
481    /* check time limit */
482    if ( tlimit != -1 && slap_get_time() > stoptime)
483     {
484          send_search_result( conn, op, LDAP_TIMELIMIT_EXCEEDED,
485                                 NULL, NULL, v2refs, NULL, nentries );
486      
487      break;
488     }
489      
490    Debug(LDAP_DEBUG_TRACE,"backsql_search(): loading data for entry id=%d, oc_id=%d, keyval=%d\n",
491                eid->id,eid->oc_id,eid->keyval);
492    
493    res=backsql_id2entry(&srch_info,&entry,eid);
494    if (res==NULL)
495     {
496      Debug(LDAP_DEBUG_TRACE,"backsql_search(): error in backsql_id2entry() - skipping entry\n",0,0,0);
497      continue;
498     }
499
500    if ( !manageDSAit && scope != LDAP_SCOPE_BASE &&
501                         is_entry_referral( &entry ) )
502     {
503      struct berval **refs = get_entry_referrals(be,conn,op,&entry);
504
505      send_search_reference( be, conn, op, &entry, refs, scope, NULL, &v2refs );
506      ber_bvecfree( refs );
507      continue;
508     }
509
510   // if (test_filter(be,conn,op,&entry,filter)==0)
511     {
512      if ((sres=send_search_entry(be,conn,op,&entry,attrs,attrsonly,NULL))==-1)
513       {
514        Debug(LDAP_DEBUG_TRACE,"backsql_search(): connection lost\n",0,0,0);
515        break;
516       }
517      nentries+=!sres;                                   
518     }
519   }
520
521  for(eid=srch_info.id_list;eid!=NULL;eid=backsql_free_entryID(eid));
522
523  charray_free(srch_info.attrs);
524
525  if (nentries>0)
526   send_search_result( conn, op,
527                 v2refs == NULL ? LDAP_SUCCESS : LDAP_REFERRAL,
528                 NULL, NULL, v2refs, NULL, nentries );
529  else
530   send_ldap_result(conn,op,LDAP_NO_SUCH_OBJECT,NULL,NULL,NULL,0);
531  
532  Debug(LDAP_DEBUG_TRACE,"<==backsql_search()\n",0,0,0);
533  return 0;
534 }
535
536 #endif /* SLAPD_SQL */