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