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

   1 /* backover.c - backend overlay routines */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 2003 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 /*
   9  * Functions to overlay other modules over a backend.
  10  *
  11  *  -- Howard Chu
  12  */
  13
  14 #include "portable.h"
  15
  16 #include <stdio.h>
  17
  18 #include <ac/string.h>
  19 #include <ac/socket.h>
  20
  21 #define SLAPD_TOOLS
  22 #include "slap.h"
  23
  24 static slap_overinst *overlays;
  25
  26 enum db_which { db_open = 0, db_close, db_destroy };
  27
  28 static int
  29 over_db_func(
  30         BackendDB *be,
  31         enum db_which which
  32 )
  33 {
  34         slap_overinfo *oi = (slap_overinfo *) be->bd_info;
  35         slap_overinst *on = oi->oi_list;
  36         BackendDB bd;
  37         BI_db_open **func;
  38         int rc = 0;
  39
  40         func = &oi->oi_bd.bd_info->bi_db_open;
  41         if ( func[which] ) {
  42                 rc = func[which]( &oi->oi_bd );
  43                 if ( rc ) return rc;
  44         }
  45
  46         bd = *be;
  47         for (; on; on=on->on_next) {
  48                 bd.bd_info = &on->on_bi;
  49                 func = &on->on_bi.bi_db_open;
  50                 if (func[which]) {
  51                         rc = func[which]( &bd );
  52                         if ( rc ) break;
  53                 }
  54         }
  55         return rc;
  56 }
  57
  58 static int
  59 over_db_config(
  60         BackendDB *be,
  61         const char *fname,
  62         int lineno,
  63         int argc,
  64         char **argv
  65 )
  66 {
  67         slap_overinfo *oi = (slap_overinfo *) be->bd_info;
  68         slap_overinst *on = oi->oi_list;
  69         BackendDB bd;
  70         int rc = 0;
  71
  72         if ( oi->oi_bd.bd_info->bi_db_config ) {
  73                 rc = oi->oi_bd.bd_info->bi_db_config( &oi->oi_bd, fname, lineno,
  74                         argc, argv );
  75                 if ( rc ) return rc;
  76         }
  77
  78         bd = *be;
  79         for (; on; on=on->on_next) {
  80                 bd.bd_info = &on->on_bi;
  81                 if (on->on_bi.bi_db_config) {
  82                         rc = on->on_bi.bi_db_config( &bd, fname, lineno,
  83                                 argc, argv );
  84                         if ( rc ) break;
  85                 }
  86         }
  87         return rc;
  88 }
  89
  90 static int
  91 over_db_open(
  92         BackendDB *be
  93 )
  94 {
  95         return over_db_func( be, db_open );
  96 }
  97
  98 static int
  99 over_db_close(
 100         BackendDB *be
 101 )
 102 {
 103         return over_db_func( be, db_close );
 104 }
 105
 106 static int
 107 over_db_destroy(
 108         BackendDB *be
 109 )
 110 {
 111         slap_overinfo *oi = (slap_overinfo *) be->bd_info;
 112         slap_overinst *on = oi->oi_list, *next;
 113         int rc;
 114
 115         rc = over_db_func( be, db_destroy );
 116
 117         for (next = on->on_next; on; on=next) {
 118                 next = on->on_next;
 119                 free( on );
 120         }
 121         free( oi );
 122         return rc;
 123 }
 124
 125 static int
 126 over_back_response ( Operation *op, SlapReply *rs )
 127 {
 128         slap_overinfo *oi = (slap_overinfo *) op->o_bd->bd_info;
 129         slap_overinst *on = oi->oi_list;
 130         int rc = SLAP_CB_CONTINUE;
 131         BackendDB *be = op->o_bd, db = *op->o_bd;
 132         slap_callback *sc = op->o_callback->sc_private;
 133
 134         op->o_bd = &db;
 135         for (; on; on=on->on_next ) {
 136                 if ( on->on_response ) {
 137                         db.bd_info = (BackendInfo *)on;
 138                         rc = on->on_response( op, rs );
 139                         if ( ! (rc & SLAP_CB_CONTINUE) ) break;
 140                 }
 141         }
 142         op->o_callback = sc;
 143         if ( sc && (rc & SLAP_CB_CONTINUE) ) {
 144                 rc = sc->sc_response( op, rs );
 145         }
 146         op->o_bd = be;
 147         rc &= ~SLAP_CB_CONTINUE;
 148         return rc;
 149 }
 150
 151 enum op_which { op_bind = 0, op_unbind, op_search, op_compare,
 152         op_modify, op_modrdn, op_add, op_delete, op_abandon,
 153         op_cancel, op_extended };
 154
 155 static int
 156 over_op_func(
 157         Operation *op,
 158         SlapReply *rs,
 159         enum op_which which
 160 )
 161 {
 162         slap_overinfo *oi = (slap_overinfo *) op->o_bd->bd_info;
 163         slap_overinst *on = oi->oi_list;
 164         BI_op_bind **func;
 165         BackendDB *be = op->o_bd, db = *op->o_bd;
 166         slap_callback cb = {over_back_response, NULL};
 167         int rc = 0;
 168
 169         op->o_bd = &db;
 170         cb.sc_private = op->o_callback;
 171         op->o_callback = &cb;
 172
 173         for (; on; on=on->on_next ) {
 174                 func = &on->on_bi.bi_op_bind;
 175                 if ( func[which] ) {
 176                         db.bd_info = (BackendInfo *)on;
 177                         rc = func[which]( op, rs );
 178                         if ( rc ) break;
 179                 }
 180         }
 181
 182         func = &oi->oi_bd.bd_info->bi_op_bind;
 183         if ( func[which] ) {
 184                 rc = func[which]( op, rs );
 185         }
 186
 187         op->o_bd = be;
 188         return rc;
 189 }
 190
 191 static int
 192 over_op_bind( Operation *op, SlapReply *rs )
 193 {
 194         return over_op_func( op, rs, op_bind );
 195 }
 196
 197 static int
 198 over_op_unbind( Operation *op, SlapReply *rs )
 199 {
 200         return over_op_func( op, rs, op_unbind );
 201 }
 202
 203 static int
 204 over_op_search( Operation *op, SlapReply *rs )
 205 {
 206         return over_op_func( op, rs, op_search );
 207 }
 208
 209 static int
 210 over_op_compare( Operation *op, SlapReply *rs )
 211 {
 212         return over_op_func( op, rs, op_compare );
 213 }
 214
 215 static int
 216 over_op_modify( Operation *op, SlapReply *rs )
 217 {
 218         return over_op_func( op, rs, op_modify );
 219 }
 220
 221 static int
 222 over_op_modrdn( Operation *op, SlapReply *rs )
 223 {
 224         return over_op_func( op, rs, op_modrdn );
 225 }
 226
 227 static int
 228 over_op_add( Operation *op, SlapReply *rs )
 229 {
 230         return over_op_func( op, rs, op_add );
 231 }
 232
 233 static int
 234 over_op_delete( Operation *op, SlapReply *rs )
 235 {
 236         return over_op_func( op, rs, op_delete );
 237 }
 238
 239 static int
 240 over_op_abandon( Operation *op, SlapReply *rs )
 241 {
 242         return over_op_func( op, rs, op_abandon );
 243 }
 244
 245 static int
 246 over_op_cancel( Operation *op, SlapReply *rs )
 247 {
 248         return over_op_func( op, rs, op_cancel );
 249 }
 250
 251 static int
 252 over_op_extended( Operation *op, SlapReply *rs )
 253 {
 254         return over_op_func( op, rs, op_extended );
 255 }
 256
 257 int
 258 overlay_register(
 259         slap_overinst *on
 260 )
 261 {
 262         on->on_next = overlays;
 263         overlays = on;
 264         return 0;
 265 }
 266
 267 static const char overtype[] = "over";
 268
 269 /* add an overlay to a particular backend. */
 270 int
 271 overlay_config( BackendDB *be, const char *ov )
 272 {
 273         slap_overinst *on, *on2, *prev;
 274         slap_overinfo *oi;
 275         BackendInfo *bi;
 276
 277         for ( on = overlays; on; on=on->on_next ) {
 278                 if (!strcmp( ov, on->on_bi.bi_type ) )
 279                         break;
 280         }
 281         if (!on) {
 282                 Debug( LDAP_DEBUG_ANY, "overlay %s not found\n", ov, 0, 0 );
 283                 return 1;
 284         }
 285
 286         /* If this is the first overlay on this backend, set up the
 287          * overlay info structure
 288          */
 289         if ( be->bd_info->bi_type != overtype ) {
 290                 oi = ch_malloc( sizeof(slap_overinfo) );
 291                 oi->oi_bd = *be;
 292                 oi->oi_bi = *be->bd_info;
 293                 oi->oi_list = NULL;
 294                 bi = (BackendInfo *)oi;
 295
 296                 bi->bi_type = (char *)overtype;
 297
 298                 bi->bi_db_config = over_db_config;
 299                 bi->bi_db_open = over_db_open;
 300                 bi->bi_db_close = over_db_close;
 301                 bi->bi_db_destroy = over_db_destroy;
 302
 303                 bi->bi_op_bind = over_op_bind;
 304                 bi->bi_op_unbind = over_op_unbind;
 305                 bi->bi_op_search = over_op_search;
 306                 bi->bi_op_compare = over_op_compare;
 307                 bi->bi_op_modify = over_op_modify;
 308                 bi->bi_op_modrdn = over_op_modrdn;
 309                 bi->bi_op_add = over_op_add;
 310                 bi->bi_op_delete = over_op_delete;
 311                 bi->bi_op_abandon = over_op_abandon;
 312                 bi->bi_op_cancel = over_op_cancel;
 313                 bi->bi_extended = over_op_extended;
 314
 315                 be->bd_info = bi;
 316         }
 317
 318         /* Walk to the end of the list of overlays, add the new
 319          * one onto the end
 320          */
 321         oi = (slap_overinfo *) be->bd_info;
 322         for ( prev=NULL, on2 = oi->oi_list; on2; prev=on2, on2=on2->on_next );
 323         on2 = ch_malloc( sizeof(slap_overinst) );
 324         if ( !prev ) {
 325                 oi->oi_list = on2;
 326         } else {
 327                 prev->on_next = on2;
 328         }
 329         *on2 = *on;
 330
 331         /* Any initialization needed? */
 332         if ( on->on_bi.bi_db_init ) {
 333                 be->bd_info = (BackendInfo *)on2;
 334                 on2->on_bi.bi_db_init( be );
 335                 be->bd_info = (BackendInfo *)oi;
 336         }
 337
 338         return 0;
 339 }
 340