git.sur5r.net Git - openldap/blob - servers/slapd/back-meta/candidates.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2005 The OpenLDAP Foundation.
   5  * Portions Copyright 2001-2003 Pierangelo Masarati.
   6  * Portions Copyright 1999-2003 Howard Chu.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  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>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by the Howard Chu for inclusion
  19  * in OpenLDAP Software and subsequently enhanced by Pierangelo
  20  * Masarati.
  21  */
  22
  23 #include "portable.h"
  24
  25 #include <stdio.h>
  26 #include "ac/string.h"
  27
  28 #include "slap.h"
  29 #include "../back-ldap/back-ldap.h"
  30 #include "back-meta.h"
  31
  32 /*
  33  * The meta-directory has one suffix, called <suffix>.
  34  * It handles a pool of target servers, each with a branch suffix
  35  * of the form <branch X>,<suffix>
  36  *
  37  * When the meta-directory receives a request with a dn that belongs
  38  * to a branch, the corresponding target is invoked. When the dn
  39  * does not belong to a specific branch, all the targets that
  40  * are compatible with the dn are selected as candidates, and
  41  * the request is spawned to all the candidate targets
  42  *
  43  * A request is characterized by a dn. The following cases are handled:
  44  *      - the dn is the suffix: <dn> == <suffix>,
  45  *              all the targets are candidates (search ...)
  46  *      - the dn is a branch suffix: <dn> == <branch X>,<suffix>, or
  47  *      - the dn is a subtree of a branch suffix:
  48  *              <dn> == <rdn>,<branch X>,<suffix>,
  49  *              the target is the only candidate.
  50  *
  51  * A possible extension will include the handling of multiple suffixes
  52  */
  53
  54
  55 /*
  56  * returns 1 if suffix is candidate for dn, otherwise 0
  57  *
  58  * Note: this function should never be called if dn is the <suffix>.
  59  */
  60 int
  61 meta_back_is_candidate(
  62         struct berval   *nsuffix,
  63         int             suffixscope,
  64         struct berval   *ndn,
  65         int             scope )
  66 {
  67         if ( dnIsSuffix( ndn, nsuffix ) ) {
  68                 switch ( suffixscope ) {
  69                 case LDAP_SCOPE_SUBTREE:
  70                 default:
  71                         return META_CANDIDATE;
  72
  73                 case LDAP_SCOPE_SUBORDINATE:
  74                         if ( ndn->bv_len > nsuffix->bv_len ) {
  75                                 return META_CANDIDATE;
  76                         }
  77                         break;
  78
  79                 /* nearly useless; not allowed by config */
  80                 case LDAP_SCOPE_ONELEVEL:
  81                         if ( ndn->bv_len > nsuffix->bv_len ) {
  82                                 struct berval   rdn = *ndn;
  83
  84                                 rdn.bv_len -= nsuffix->bv_len
  85                                         + STRLENOF( "," );
  86                                 if ( dnIsOneLevelRDN( &rdn ) ) {
  87                                         return META_CANDIDATE;
  88                                 }
  89                         }
  90                         break;
  91
  92                 /* nearly useless; not allowed by config */
  93                 case LDAP_SCOPE_BASE:
  94                         if ( ndn->bv_len == nsuffix->bv_len ) {
  95                                 return META_CANDIDATE;
  96                         }
  97                         break;
  98                 }
  99
 100                 return META_NOT_CANDIDATE;
 101         }
 102
 103         if ( scope == LDAP_SCOPE_SUBTREE && dnIsSuffix( nsuffix, ndn ) ) {
 104                 /*
 105                  * suffix longer than dn, but common part matches
 106                  */
 107                 return META_CANDIDATE;
 108         }
 109
 110         return META_NOT_CANDIDATE;
 111 }
 112
 113 /*
 114  * meta_back_select_unique_candidate
 115  *
 116  * returns the index of the candidate in case it is unique, otherwise
 117  * META_TARGET_NONE if none matches, or
 118  * META_TARGET_MULTIPLE if more than one matches
 119  * Note: ndn MUST be normalized.
 120  */
 121 int
 122 meta_back_select_unique_candidate(
 123         metainfo_t      *mi,
 124         struct berval   *ndn )
 125 {
 126         int     i, candidate = META_TARGET_NONE;
 127
 128         for ( i = 0; i < mi->mi_ntargets; ++i ) {
 129                 if ( meta_back_is_candidate( &mi->mi_targets[ i ].mt_nsuffix,
 130                                 mi->mi_targets[ i ].mt_scope,
 131                                 ndn, LDAP_SCOPE_BASE ) )
 132                 {
 133                         if ( candidate == META_TARGET_NONE ) {
 134                                 candidate = i;
 135
 136                         } else {
 137                                 return META_TARGET_MULTIPLE;
 138                         }
 139                 }
 140         }
 141
 142         return candidate;
 143 }
 144
 145 /*
 146  * meta_clear_unused_candidates
 147  *
 148  * clears all candidates except candidate
 149  */
 150 int
 151 meta_clear_unused_candidates(
 152         Operation       *op,
 153         int             candidate )
 154 {
 155         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 156         int             i;
 157         SlapReply       *candidates = meta_back_candidates_get( op );
 158
 159         for ( i = 0; i < mi->mi_ntargets; ++i ) {
 160                 if ( i == candidate ) {
 161                         continue;
 162                 }
 163                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 164         }
 165
 166         return 0;
 167 }
 168
 169 /*
 170  * meta_clear_one_candidate
 171  *
 172  * clears the selected candidate
 173  */
 174 int
 175 meta_clear_one_candidate(
 176         metasingleconn_t        *msc )
 177 {
 178         if ( msc->msc_ld ) {
 179                 ldap_unbind_ext( msc->msc_ld, NULL, NULL );
 180                 msc->msc_ld = NULL;
 181         }
 182
 183         if ( !BER_BVISNULL( &msc->msc_bound_ndn ) ) {
 184                 ber_memfree_x( msc->msc_bound_ndn.bv_val, NULL );
 185                 BER_BVZERO( &msc->msc_bound_ndn );
 186         }
 187
 188         if ( !BER_BVISNULL( &msc->msc_cred ) ) {
 189                 memset( msc->msc_cred.bv_val, 0, msc->msc_cred.bv_len );
 190                 ber_memfree_x( msc->msc_cred.bv_val, NULL );
 191                 BER_BVZERO( &msc->msc_cred );
 192         }
 193
 194         return 0;
 195 }
 196