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         metainfo_t      *mi,
  56         struct berval   *ndn );
  57
  58 /*
  59  * returns 1 if suffix is candidate for dn, otherwise 0
  60  *
  61  * Note: this function should never be called if dn is the <suffix>.
  62  */
  63 int
  64 meta_back_is_candidate(
  65         struct berval   *nsuffix,
  66         struct berval   *ndn,
  67         int             scope )
  68 {
  69         if ( dnIsSuffix( ndn, nsuffix ) ) {
  70                 return META_CANDIDATE;
  71         }
  72
  73         if ( scope == LDAP_SCOPE_SUBTREE && dnIsSuffix( nsuffix, ndn ) ) {
  74                 /*
  75                  * suffix longer than dn, but common part matches
  76                  */
  77                 return META_CANDIDATE;
  78         }
  79
  80         return META_NOT_CANDIDATE;
  81 }
  82
  83 /*
  84  * meta_back_is_candidate_unique
  85  *
  86  * checks whether a candidate is unique
  87  * Note: dn MUST be normalized
  88  */
  89 static int
  90 meta_back_is_candidate_unique(
  91         metainfo_t      *mi,
  92         struct berval   *ndn )
  93 {
  94         switch ( meta_back_select_unique_candidate( mi, ndn ) ) {
  95         case META_TARGET_MULTIPLE:
  96         case META_TARGET_NONE:
  97                 return 0;
  98         }
  99
 100         return 1;
 101 }
 102
 103 /*
 104  * meta_back_select_unique_candidate
 105  *
 106  * returns the index of the candidate in case it is unique, otherwise -1
 107  * Note: dn MUST be normalized.
 108  * Note: if defined, the default candidate is returned in case of no match.
 109  */
 110 int
 111 meta_back_select_unique_candidate(
 112         metainfo_t      *mi,
 113         struct berval   *ndn )
 114 {
 115         int     i, candidate = META_TARGET_NONE;
 116
 117         for ( i = 0; i < mi->mi_ntargets; ++i ) {
 118                 if ( meta_back_is_candidate( &mi->mi_targets[ i ].mt_nsuffix, ndn, LDAP_SCOPE_BASE ) )
 119                 {
 120                         if ( candidate == META_TARGET_NONE ) {
 121                                 candidate = i;
 122
 123                         } else {
 124                                 return META_TARGET_MULTIPLE;
 125                         }
 126                 }
 127         }
 128
 129         return candidate;
 130 }
 131
 132 /*
 133  * meta_clear_unused_candidates
 134  *
 135  * clears all candidates except candidate
 136  */
 137 int
 138 meta_clear_unused_candidates(
 139         Operation       *op,
 140         int             candidate )
 141 {
 142         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 143         int             i;
 144         SlapReply       *candidates = meta_back_candidates_get( op );
 145
 146         for ( i = 0; i < mi->mi_ntargets; ++i ) {
 147                 if ( i == candidate ) {
 148                         continue;
 149                 }
 150                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 151         }
 152
 153         return 0;
 154 }
 155
 156 /*
 157  * meta_clear_one_candidate
 158  *
 159  * clears the selected candidate
 160  */
 161 int
 162 meta_clear_one_candidate(
 163         metasingleconn_t        *msc )
 164 {
 165         if ( msc->msc_ld ) {
 166                 ldap_unbind_ext_s( msc->msc_ld, NULL, NULL );
 167                 msc->msc_ld = NULL;
 168         }
 169
 170         if ( !BER_BVISNULL( &msc->msc_bound_ndn ) ) {
 171                 ber_memfree( msc->msc_bound_ndn.bv_val );
 172                 BER_BVZERO( &msc->msc_bound_ndn );
 173         }
 174
 175         if ( !BER_BVISNULL( &msc->msc_cred ) ) {
 176                 ber_memfree( msc->msc_cred.bv_val );
 177                 BER_BVZERO( &msc->msc_cred );
 178         }
 179
 180         return 0;
 181 }
 182