git.sur5r.net Git - openldap/blob - servers/slapd/backover.c

   1 /* backover.c - backend overlay routines */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2003-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 /* Functions to overlay other modules over a backend. */
  18
  19 #include "portable.h"
  20
  21 #include <stdio.h>
  22
  23 #include <ac/string.h>
  24 #include <ac/socket.h>
  25
  26 #define SLAPD_TOOLS
  27 #include "slap.h"
  28
  29 static slap_overinst *overlays;
  30
  31 enum db_which { db_open = 0, db_close, db_destroy };
  32
  33 static int
  34 over_db_func(
  35         BackendDB *be,
  36         enum db_which which
  37 )
  38 {
  39         slap_overinfo *oi = be->bd_info->bi_private;
  40         slap_overinst *on = oi->oi_list;
  41         BackendInfo *bi_orig = be->bd_info;
  42         BI_db_open **func;
  43         int rc = 0;
  44
  45         func = &oi->oi_orig->bi_db_open;
  46         if ( func[which] ) {
  47                 be->bd_info = oi->oi_orig;
  48                 rc = func[which]( be );
  49         }
  50
  51         for (; on && rc == 0; on=on->on_next) {
  52                 be->bd_info = &on->on_bi;
  53                 func = &on->on_bi.bi_db_open;
  54                 if (func[which]) {
  55                         rc = func[which]( be );
  56                 }
  57         }
  58         be->bd_info = bi_orig;
  59         return rc;
  60 }
  61
  62 static int
  63 over_db_config(
  64         BackendDB *be,
  65         const char *fname,
  66         int lineno,
  67         int argc,
  68         char **argv
  69 )
  70 {
  71         slap_overinfo *oi = be->bd_info->bi_private;
  72         slap_overinst *on = oi->oi_list;
  73         BackendInfo *bi_orig = be->bd_info;
  74         int rc = 0;
  75
  76         if ( oi->oi_orig->bi_db_config ) {
  77                 be->bd_info = oi->oi_orig;
  78                 rc = oi->oi_orig->bi_db_config( be, fname, lineno,
  79                         argc, argv );
  80                 be->bd_info = (BackendInfo *)oi;
  81                 if ( rc != SLAP_CONF_UNKNOWN ) return rc;
  82         }
  83
  84         for (; on; on=on->on_next) {
  85                 if (on->on_bi.bi_db_config) {
  86                         be->bd_info = &on->on_bi;
  87                         rc = on->on_bi.bi_db_config( be, fname, lineno,
  88                                 argc, argv );
  89                         if ( rc != SLAP_CONF_UNKNOWN ) break;
  90                 }
  91         }
  92         be->bd_info = bi_orig;
  93         return rc;
  94 }
  95
  96 static int
  97 over_db_open(
  98         BackendDB *be
  99 )
 100 {
 101         return over_db_func( be, db_open );
 102 }
 103
 104 static int
 105 over_db_close(
 106         BackendDB *be
 107 )
 108 {
 109         return over_db_func( be, db_close );
 110 }
 111
 112 static int
 113 over_db_destroy(
 114         BackendDB *be
 115 )
 116 {
 117         slap_overinfo *oi = be->bd_info->bi_private;
 118         slap_overinst *on = oi->oi_list, *next;
 119         int rc;
 120
 121         rc = over_db_func( be, db_destroy );
 122
 123         for (next = on->on_next; on; on=next) {
 124                 next = on->on_next;
 125                 free( on );
 126         }
 127         free( oi );
 128         return rc;
 129 }
 130
 131 static int
 132 over_back_response ( Operation *op, SlapReply *rs )
 133 {
 134         slap_overinfo *oi = op->o_callback->sc_private;
 135         slap_overinst *on = oi->oi_list;
 136         int rc = SLAP_CB_CONTINUE;
 137         BackendDB *be = op->o_bd, db = *op->o_bd;
 138
 139         op->o_bd = &db;
 140         for (; on; on=on->on_next ) {
 141                 if ( on->on_response ) {
 142                         db.bd_info = (BackendInfo *)on;
 143                         rc = on->on_response( op, rs );
 144                         if ( rc != SLAP_CB_CONTINUE ) break;
 145                 }
 146         }
 147         op->o_bd = be;
 148         return rc;
 149 }
 150
 151 enum op_which {
 152         op_bind = 0,
 153         op_unbind,
 154         op_search,
 155         op_compare,
 156         op_modify,
 157         op_modrdn,
 158         op_add,
 159         op_delete,
 160         op_abandon,
 161         op_cancel,
 162         op_extended,
 163         op_aux_chk_referrals,
 164         op_last
 165 };
 166
 167 /*
 168  * default return code in case of missing backend function
 169  * and overlay stack returning SLAP_CB_CONTINUE
 170  */
 171 static int op_rc[] = {
 172         LDAP_UNWILLING_TO_PERFORM,      /* bind */
 173         LDAP_UNWILLING_TO_PERFORM,      /* unbind */
 174         LDAP_UNWILLING_TO_PERFORM,      /* search */
 175         LDAP_UNWILLING_TO_PERFORM,      /* compare */
 176         LDAP_UNWILLING_TO_PERFORM,      /* modify */
 177         LDAP_UNWILLING_TO_PERFORM,      /* modrdn */
 178         LDAP_UNWILLING_TO_PERFORM,      /* add */
 179         LDAP_UNWILLING_TO_PERFORM,      /* delete */
 180         LDAP_UNWILLING_TO_PERFORM,      /* abandon */
 181         LDAP_UNWILLING_TO_PERFORM,      /* cancel */
 182         LDAP_UNWILLING_TO_PERFORM,      /* extended */
 183         LDAP_SUCCESS                    /* aux_chk_referrals */
 184 };
 185
 186 static int
 187 over_op_func(
 188         Operation *op,
 189         SlapReply *rs,
 190         enum op_which which
 191 )
 192 {
 193         slap_overinfo *oi = op->o_bd->bd_info->bi_private;
 194         slap_overinst *on = oi->oi_list;
 195         BI_op_bind **func;
 196         BackendDB *be = op->o_bd, db = *op->o_bd;
 197         slap_callback cb = {NULL, over_back_response, NULL, NULL};
 198         int rc = SLAP_CB_CONTINUE;
 199
 200         op->o_bd = &db;
 201         cb.sc_next = op->o_callback;
 202         cb.sc_private = oi;
 203         op->o_callback = &cb;
 204
 205         for (; on; on=on->on_next ) {
 206                 func = &on->on_bi.bi_op_bind;
 207                 if ( func[which] ) {
 208                         db.bd_info = (BackendInfo *)on;
 209                         rc = func[which]( op, rs );
 210                         if ( rc != SLAP_CB_CONTINUE ) break;
 211                 }
 212         }
 213
 214         func = &oi->oi_orig->bi_op_bind;
 215         if ( func[which] && rc == SLAP_CB_CONTINUE ) {
 216                 db.bd_info = oi->oi_orig;
 217                 rc = func[which]( op, rs );
 218         }
 219         /* should not fall thru this far without anything happening... */
 220         if ( rc == SLAP_CB_CONTINUE ) {
 221                 rc = op_rc[ which ];
 222         }
 223
 224         /* The underlying backend didn't handle the request, make sure
 225          * overlay cleanup is processed.
 226          */
 227         if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
 228                 slap_callback *sc_next;
 229                 for ( ; op->o_callback && op->o_callback != cb.sc_next;
 230                         op->o_callback = sc_next ) {
 231                         sc_next = op->o_callback->sc_next;
 232                         if ( op->o_callback->sc_cleanup ) {
 233                                 op->o_callback->sc_cleanup( op, rs );
 234                         }
 235                 }
 236         }
 237         op->o_bd = be;
 238         op->o_callback = cb.sc_next;
 239         return rc;
 240 }
 241
 242 static int
 243 over_op_bind( Operation *op, SlapReply *rs )
 244 {
 245         return over_op_func( op, rs, op_bind );
 246 }
 247
 248 static int
 249 over_op_unbind( Operation *op, SlapReply *rs )
 250 {
 251         return over_op_func( op, rs, op_unbind );
 252 }
 253
 254 static int
 255 over_op_search( Operation *op, SlapReply *rs )
 256 {
 257         return over_op_func( op, rs, op_search );
 258 }
 259
 260 static int
 261 over_op_compare( Operation *op, SlapReply *rs )
 262 {
 263         return over_op_func( op, rs, op_compare );
 264 }
 265
 266 static int
 267 over_op_modify( Operation *op, SlapReply *rs )
 268 {
 269         return over_op_func( op, rs, op_modify );
 270 }
 271
 272 static int
 273 over_op_modrdn( Operation *op, SlapReply *rs )
 274 {
 275         return over_op_func( op, rs, op_modrdn );
 276 }
 277
 278 static int
 279 over_op_add( Operation *op, SlapReply *rs )
 280 {
 281         return over_op_func( op, rs, op_add );
 282 }
 283
 284 static int
 285 over_op_delete( Operation *op, SlapReply *rs )
 286 {
 287         return over_op_func( op, rs, op_delete );
 288 }
 289
 290 static int
 291 over_op_abandon( Operation *op, SlapReply *rs )
 292 {
 293         return over_op_func( op, rs, op_abandon );
 294 }
 295
 296 static int
 297 over_op_cancel( Operation *op, SlapReply *rs )
 298 {
 299         return over_op_func( op, rs, op_cancel );
 300 }
 301
 302 static int
 303 over_op_extended( Operation *op, SlapReply *rs )
 304 {
 305         return over_op_func( op, rs, op_extended );
 306 }
 307
 308 static int
 309 over_chk_referrals( Operation *op, SlapReply *rs )
 310 {
 311         return over_op_func( op, rs, op_aux_chk_referrals );
 312 }
 313
 314 int
 315 overlay_register(
 316         slap_overinst *on
 317 )
 318 {
 319         on->on_next = overlays;
 320         overlays = on;
 321         return 0;
 322 }
 323
 324 slap_overinst *
 325 overlay_next(
 326         slap_overinst *on
 327 )
 328 {
 329         if ( on == NULL ) {
 330                 return overlays;
 331         }
 332
 333         return on->on_next;
 334 }
 335
 336 static const char overtype[] = "over";
 337
 338 /* add an overlay to a particular backend. */
 339 int
 340 overlay_config( BackendDB *be, const char *ov )
 341 {
 342         slap_overinst *on = NULL, *on2 = NULL, *prev = NULL;
 343         slap_overinfo *oi = NULL;
 344         BackendInfo *bi = NULL;
 345
 346         for ( on = overlays; on; on=on->on_next ) {
 347                 if (!strcmp( ov, on->on_bi.bi_type ) )
 348                         break;
 349         }
 350         if (!on) {
 351                 Debug( LDAP_DEBUG_ANY, "overlay %s not found\n", ov, 0, 0 );
 352                 return 1;
 353         }
 354
 355         /* If this is the first overlay on this backend, set up the
 356          * overlay info structure
 357          */
 358         if ( be->bd_info->bi_type != overtype ) {
 359                 oi = ch_malloc( sizeof(slap_overinfo) );
 360                 oi->oi_orig = be->bd_info;
 361                 oi->oi_bi = *be->bd_info;
 362
 363                 /* Save a pointer to ourself in bi_private.
 364                  * This allows us to keep working in conjunction
 365                  * with backglue...
 366                  */
 367                 oi->oi_bi.bi_private = oi;
 368                 oi->oi_list = NULL;
 369                 bi = (BackendInfo *)oi;
 370
 371                 bi->bi_type = (char *)overtype;
 372
 373                 bi->bi_db_config = over_db_config;
 374                 bi->bi_db_open = over_db_open;
 375                 bi->bi_db_close = over_db_close;
 376                 bi->bi_db_destroy = over_db_destroy;
 377
 378                 bi->bi_op_bind = over_op_bind;
 379                 bi->bi_op_unbind = over_op_unbind;
 380                 bi->bi_op_search = over_op_search;
 381                 bi->bi_op_compare = over_op_compare;
 382                 bi->bi_op_modify = over_op_modify;
 383                 bi->bi_op_modrdn = over_op_modrdn;
 384                 bi->bi_op_add = over_op_add;
 385                 bi->bi_op_delete = over_op_delete;
 386                 bi->bi_op_abandon = over_op_abandon;
 387                 bi->bi_op_cancel = over_op_cancel;
 388
 389                 bi->bi_extended = over_op_extended;
 390
 391                 /*
 392                  * this is fine because it has the same
 393                  * args of the operations; we need to rework
 394                  * all the hooks to share the same args
 395                  * of the operations...
 396                  */
 397                 bi->bi_chk_referrals = over_chk_referrals;
 398
 399                 be->bd_info = bi;
 400
 401         } else {
 402                 oi = be->bd_info->bi_private;
 403         }
 404
 405         /* Insert new overlay on head of list. Overlays are executed
 406          * in reverse of config order...
 407          */
 408         on2 = ch_calloc( 1, sizeof(slap_overinst) );
 409         *on2 = *on;
 410         on2->on_info = oi;
 411         on2->on_next = oi->oi_list;
 412         oi->oi_list = on2;
 413
 414         /* Any initialization needed? */
 415         if ( on->on_bi.bi_db_init ) {
 416                 be->bd_info = (BackendInfo *)on2;
 417                 on2->on_bi.bi_db_init( be );
 418                 be->bd_info = (BackendInfo *)oi;
 419         }
 420
 421         return 0;
 422 }
 423