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
  27 #include "slap.h"
  28 #include "../back-ldap/back-ldap.h"
  29 #include "back-meta.h"
  30
  31 /*
  32  * The meta-directory has one suffix, called <suffix>.
  33  * It handles a pool of target servers, each with a branch suffix
  34  * of the form <branch X>,<suffix>
  35  *
  36  * When the meta-directory receives a request with a dn that belongs
  37  * to a branch, the corresponding target is invoked. When the dn
  38  * does not belong to a specific branch, all the targets that
  39  * are compatible with the dn are selected as candidates, and
  40  * the request is spawned to all the candidate targets
  41  *
  42  * A request is characterized by a dn. The following cases are handled:
  43  *      - the dn is the suffix: <dn> == <suffix>,
  44  *              all the targets are candidates (search ...)
  45  *      - the dn is a branch suffix: <dn> == <branch X>,<suffix>, or
  46  *      - the dn is a subtree of a branch suffix:
  47  *              <dn> == <rdn>,<branch X>,<suffix>,
  48  *              the target is the only candidate.
  49  *
  50  * A possible extension will include the handling of multiple suffixes
  51  */
  52
  53 static int
  54 meta_back_is_candidate_unique(
  55                 struct metainfo         *li,
  56                 struct berval           *ndn
  57 );
  58
  59 /*
  60  * returns 1 if suffix is candidate for dn, otherwise 0
  61  *
  62  * Note: this function should never be called if dn is the <suffix>.
  63  */
  64 int
  65 meta_back_is_candidate(
  66                 struct berval   *nsuffix,
  67                 struct berval   *ndn,
  68                 int             scope
  69 )
  70 {
  71         if ( dnIsSuffix( ndn, nsuffix ) ) {
  72                 return META_CANDIDATE;
  73         }
  74
  75         if ( scope == LDAP_SCOPE_SUBTREE && dnIsSuffix( nsuffix, ndn ) ) {
  76                 /*
  77                  * suffix longer than dn, but common part matches
  78                  */
  79                 return META_CANDIDATE;
  80         }
  81
  82         return META_NOT_CANDIDATE;
  83 }
  84
  85 /*
  86  * meta_back_is_candidate_unique
  87  *
  88  * checks whether a candidate is unique
  89  * Note: dn MUST be normalized
  90  */
  91 static int
  92 meta_back_is_candidate_unique(
  93                 struct metainfo         *li,
  94                 struct berval           *ndn
  95 )
  96 {
  97         switch ( meta_back_select_unique_candidate( li, ndn ) ) {
  98         case META_TARGET_MULTIPLE:
  99         case META_TARGET_NONE:
 100                 return 0;
 101         }
 102
 103         return 1;
 104 }
 105
 106 /*
 107  * meta_back_select_unique_candidate
 108  *
 109  * returns the index of the candidate in case it is unique, otherwise -1
 110  * Note: dn MUST be normalized.
 111  * Note: if defined, the default candidate is returned in case of no match.
 112  */
 113 int
 114 meta_back_select_unique_candidate(
 115                 struct metainfo         *li,
 116                 struct berval           *ndn
 117 )
 118 {
 119         int     i, candidate = META_TARGET_NONE;
 120
 121         for ( i = 0; i < li->mi_ntargets; ++i ) {
 122                 if ( meta_back_is_candidate( &li->mi_targets[ i ]->mt_nsuffix, ndn, LDAP_SCOPE_BASE ) )
 123                 {
 124                         if ( candidate == META_TARGET_NONE ) {
 125                                 candidate = i;
 126
 127                         } else {
 128                                 return META_TARGET_MULTIPLE;
 129                         }
 130                 }
 131         }
 132
 133         return candidate;
 134 }
 135
 136 /*
 137  * meta_clear_unused_candidates
 138  *
 139  * clears all candidates except candidate
 140  */
 141 int
 142 meta_clear_unused_candidates(
 143                 Operation               *op,
 144                 struct metaconn         *lc,
 145                 int                     candidate
 146 )
 147 {
 148         struct metainfo *li = ( struct metainfo * )op->o_bd->be_private;
 149         int             i;
 150         SlapReply       *candidates = meta_back_candidates_get( op );
 151
 152         for ( i = 0; i < li->mi_ntargets; ++i ) {
 153                 if ( i == candidate ) {
 154                         continue;
 155                 }
 156                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 157         }
 158
 159         return 0;
 160 }
 161
 162 /*
 163  * meta_clear_one_candidate
 164  *
 165  * clears the selected candidate
 166  */
 167 int
 168 meta_clear_one_candidate(
 169                 struct metasingleconn   *lsc
 170 )
 171 {
 172         if ( lsc->msc_ld ) {
 173                 ldap_unbind_ext_s( lsc->msc_ld, NULL, NULL );
 174                 lsc->msc_ld = NULL;
 175         }
 176
 177         if ( !BER_BVISNULL( &lsc->msc_bound_ndn ) ) {
 178                 ber_memfree( lsc->msc_bound_ndn.bv_val );
 179                 BER_BVZERO( &lsc->msc_bound_ndn );
 180         }
 181
 182         if ( !BER_BVISNULL( &lsc->msc_cred ) ) {
 183                 ber_memfree( lsc->msc_cred.bv_val );
 184                 BER_BVZERO( &lsc->msc_cred );
 185         }
 186
 187         return 0;
 188 }
 189