source/lib/ldb/modules/rdn_name.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Bartlet 2005
   5    Copyright (C) Simo Sorce     2006
   6
   7      ** NOTE! The following LGPL license applies to the ldb
   8      ** library. This does NOT imply that all of Samba is released
   9      ** under the LGPL
  10
  11    This library is free software; you can redistribute it and/or
  12    modify it under the terms of the GNU Lesser General Public
  13    License as published by the Free Software Foundation; either
  14    version 2 of the License, or (at your option) any later version.
  15
  16    This library is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19    Lesser General Public License for more details.
  20
  21    You should have received a copy of the GNU Lesser General Public
  22    License along with this library; if not, write to the Free Software
  23    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24 */
  25
  26 /*
  27  *  Name: rdb_name
  28  *
  29  *  Component: ldb rdn name module
  30  *
  31  *  Description: keep a consistent name attribute on objects manpulations
  32  *
  33  *  Author: Andrew Bartlet
  34  *
  35  *  Modifications:
  36  *    - made the module async
  37  *      Simo Sorce Mar 2006
  38  */
  39
  40 #include "includes.h"
  41 #include "ldb/include/includes.h"
  42
  43 static struct ldb_message_element *rdn_name_find_attribute(const struct ldb_message *msg, const char *name)
  44 {
  45         int i;
  46
  47         for (i = 0; i < msg->num_elements; i++) {
  48                 if (ldb_attr_cmp(name, msg->elements[i].name) == 0) {
  49                         return &msg->elements[i];
  50                 }
  51         }
  52
  53         return NULL;
  54 }
  55
  56 static int rdn_name_add(struct ldb_module *module, struct ldb_request *req)
  57 {
  58         struct ldb_request *down_req;
  59         struct ldb_message *msg;
  60         struct ldb_message_element *attribute;
  61         const char *rdn_name;
  62         struct ldb_val rdn_val;
  63         int i, ret;
  64
  65         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_add_record\n");
  66
  67         /* do not manipulate our control entries */
  68         if (ldb_dn_is_special(req->op.add.message->dn)) {
  69                 return ldb_next_request(module, req);
  70         }
  71
  72         down_req = talloc(req, struct ldb_request);
  73         if (down_req == NULL) {
  74                 return LDB_ERR_OPERATIONS_ERROR;
  75         }
  76
  77         *down_req = *req;
  78
  79         down_req->op.add.message = msg = ldb_msg_copy_shallow(down_req, req->op.add.message);
  80         if (msg == NULL) {
  81                 return LDB_ERR_OPERATIONS_ERROR;
  82         }
  83
  84         rdn_name = ldb_dn_get_rdn_name(msg->dn);
  85         if (rdn_name == NULL) {
  86                 talloc_free(down_req);
  87                 return LDB_ERR_OPERATIONS_ERROR;
  88         }
  89
  90         rdn_val = ldb_val_dup(msg, ldb_dn_get_rdn_val(msg->dn));
  91
  92         /* Perhaps someone above us tried to set this? */
  93         if ((attribute = rdn_name_find_attribute(msg, "name")) != NULL ) {
  94                 attribute->num_values = 0;
  95         }
  96
  97         if (ldb_msg_add_value(msg, "name", &rdn_val, NULL) != 0) {
  98                 talloc_free(down_req);
  99                 return LDB_ERR_OPERATIONS_ERROR;
 100         }
 101
 102         attribute = rdn_name_find_attribute(msg, rdn_name);
 103
 104         if (!attribute) {
 105                 if (ldb_msg_add_value(msg, rdn_name, &rdn_val, NULL) != 0) {
 106                         talloc_free(down_req);
 107                         return LDB_ERR_OPERATIONS_ERROR;
 108                 }
 109         } else {
 110                 const struct ldb_attrib_handler *handler = ldb_attrib_handler(module->ldb, rdn_name);
 111
 112                 for (i = 0; i < attribute->num_values; i++) {
 113                         if (handler->comparison_fn(module->ldb, msg, &rdn_val, &attribute->values[i]) == 0) {
 114                                 /* overwrite so it matches in case */
 115                                 attribute->values[i] = rdn_val;
 116                                 break;
 117                         }
 118                 }
 119                 if (i == attribute->num_values) {
 120                         ldb_debug_set(module->ldb, LDB_DEBUG_FATAL,
 121                                       "RDN mismatch on %s: %s (%s)",
 122                                       ldb_dn_linearize(msg, msg->dn), rdn_name, rdn_val.data);
 123                         talloc_free(down_req);
 124                         return LDB_ERR_OPERATIONS_ERROR;
 125                 }
 126         }
 127
 128         /* go on with the call chain */
 129         ret = ldb_next_request(module, down_req);
 130
 131         /* do not free down_req as the call results may be linked to it,
 132          * it will be freed when the upper level request get freed */
 133         if (ret == LDB_SUCCESS) {
 134                 req->handle = down_req->handle;
 135         }
 136
 137         return ret;
 138 }
 139
 140 struct rename_context {
 141
 142         enum {RENAME_RENAME, RENAME_MODIFY} step;
 143         struct ldb_request *orig_req;
 144         struct ldb_request *down_req;
 145         struct ldb_request *mod_req;
 146 };
 147
 148 static int rdn_name_rename(struct ldb_module *module, struct ldb_request *req)
 149 {
 150         struct ldb_handle *h;
 151         struct rename_context *ac;
 152
 153         ldb_debug(module->ldb, LDB_DEBUG_TRACE, "rdn_name_rename\n");
 154
 155         /* do not manipulate our control entries */
 156         if (ldb_dn_is_special(req->op.rename.newdn)) {
 157                 return ldb_next_request(module, req);
 158         }
 159
 160         h = talloc_zero(req, struct ldb_handle);
 161         if (h == NULL) {
 162                 return LDB_ERR_OPERATIONS_ERROR;
 163         }
 164
 165         h->module = module;
 166
 167         ac = talloc_zero(h, struct rename_context);
 168         if (ac == NULL) {
 169                 return LDB_ERR_OPERATIONS_ERROR;
 170         }
 171
 172         h->private_data = (void *)ac;
 173
 174         h->state = LDB_ASYNC_INIT;
 175         h->status = LDB_SUCCESS;
 176
 177         ac->orig_req = req;
 178         ac->down_req = talloc(req, struct ldb_request);
 179         if (ac->down_req == NULL) {
 180                 return LDB_ERR_OPERATIONS_ERROR;
 181         }
 182
 183         *(ac->down_req) = *req;
 184
 185         ac->step = RENAME_RENAME;
 186
 187         req->handle = h;
 188
 189         /* rename first, modify "name" if rename is ok */
 190         return ldb_next_request(module, ac->down_req);
 191 }
 192
 193 static int rdn_name_rename_do_mod(struct ldb_handle *h) {
 194
 195         struct rename_context *ac;
 196         const char *rdn_name;
 197         struct ldb_val rdn_val;
 198         struct ldb_message *msg;
 199
 200         ac = talloc_get_type(h->private_data, struct rename_context);
 201
 202         ac->mod_req = talloc_zero(ac, struct ldb_request);
 203
 204         ac->mod_req->operation = LDB_MODIFY;
 205         ac->mod_req->op.mod.message = msg = ldb_msg_new(ac->mod_req);
 206         if (msg == NULL) {
 207                 return LDB_ERR_OPERATIONS_ERROR;
 208         }
 209
 210         msg->dn = ldb_dn_copy(msg, ac->orig_req->op.rename.newdn);
 211         if (msg->dn == NULL) {
 212                 return LDB_ERR_OPERATIONS_ERROR;
 213         }
 214
 215         rdn_name = ldb_dn_get_rdn_name(ac->orig_req->op.rename.newdn);
 216         if (rdn_name == NULL) {
 217                 return LDB_ERR_OPERATIONS_ERROR;
 218         }
 219
 220         rdn_val = ldb_val_dup(msg, ldb_dn_get_rdn_val(ac->orig_req->op.rename.newdn));
 221
 222         if (ldb_msg_add_empty(msg, rdn_name, LDB_FLAG_MOD_REPLACE, NULL) != 0) {
 223                 return LDB_ERR_OPERATIONS_ERROR;
 224         }
 225         if (ldb_msg_add_value(msg, rdn_name, &rdn_val, NULL) != 0) {
 226                 return LDB_ERR_OPERATIONS_ERROR;
 227         }
 228         if (ldb_msg_add_empty(msg, "name", LDB_FLAG_MOD_REPLACE, NULL) != 0) {
 229                 return LDB_ERR_OPERATIONS_ERROR;
 230         }
 231         if (ldb_msg_add_value(msg, "name", &rdn_val, NULL) != 0) {
 232                 return LDB_ERR_OPERATIONS_ERROR;
 233         }
 234
 235         ldb_set_timeout_from_prev_req(h->module->ldb, ac->orig_req, ac->mod_req);
 236
 237         ac->step = RENAME_MODIFY;
 238
 239         /* do the mod call */
 240         return ldb_request(h->module->ldb, ac->mod_req);
 241 }
 242
 243 static int rename_wait(struct ldb_handle *handle)
 244 {
 245         struct rename_context *ac;
 246         int ret;
 247
 248         if (!handle || !handle->private_data) {
 249                 return LDB_ERR_OPERATIONS_ERROR;
 250         }
 251
 252         if (handle->state == LDB_ASYNC_DONE) {
 253                 return handle->status;
 254         }
 255
 256         handle->state = LDB_ASYNC_PENDING;
 257         handle->status = LDB_SUCCESS;
 258
 259         ac = talloc_get_type(handle->private_data, struct rename_context);
 260
 261         switch(ac->step) {
 262         case RENAME_RENAME:
 263                 ret = ldb_wait(ac->down_req->handle, LDB_WAIT_NONE);
 264                 if (ret != LDB_SUCCESS) {
 265                         handle->status = ret;
 266                         goto done;
 267                 }
 268                 if (ac->down_req->handle->status != LDB_SUCCESS) {
 269                         handle->status = ac->down_req->handle->status;
 270                         goto done;
 271                 }
 272
 273                 if (ac->down_req->handle->state != LDB_ASYNC_DONE) {
 274                         return LDB_SUCCESS;
 275                 }
 276
 277                 /* rename operation done */
 278                 return rdn_name_rename_do_mod(handle);
 279
 280         case RENAME_MODIFY:
 281                 ret = ldb_wait(ac->mod_req->handle, LDB_WAIT_NONE);
 282                 if (ret != LDB_SUCCESS) {
 283                         handle->status = ret;
 284                         goto done;
 285                 }
 286                 if (ac->mod_req->handle->status != LDB_SUCCESS) {
 287                         handle->status = ac->mod_req->handle->status;
 288                         goto done;
 289                 }
 290
 291                 if (ac->mod_req->handle->state != LDB_ASYNC_DONE) {
 292                         return LDB_SUCCESS;
 293                 }
 294
 295                 break;
 296
 297         default:
 298                 ret = LDB_ERR_OPERATIONS_ERROR;
 299                 goto done;
 300         }
 301
 302         ret = LDB_SUCCESS;
 303
 304 done:
 305         handle->state = LDB_ASYNC_DONE;
 306         return ret;
 307 }
 308
 309 static int rename_wait_all(struct ldb_handle *handle) {
 310
 311         int ret;
 312
 313         while (handle->state != LDB_ASYNC_DONE) {
 314                 ret = rename_wait(handle);
 315                 if (ret != LDB_SUCCESS) {
 316                         return ret;
 317                 }
 318         }
 319
 320         return handle->status;
 321 }
 322
 323 static int rdn_name_wait(struct ldb_handle *handle, enum ldb_wait_type type)
 324 {
 325         if (type == LDB_WAIT_ALL) {
 326                 return rename_wait_all(handle);
 327         } else {
 328                 return rename_wait(handle);
 329         }
 330 }
 331
 332 static const struct ldb_module_ops rdn_name_ops = {
 333         .name              = "rdn_name",
 334         .add               = rdn_name_add,
 335         .rename            = rdn_name_rename,
 336         .wait              = rdn_name_wait
 337 };
 338
 339
 340 int ldb_rdn_name_init(void)
 341 {
 342         return ldb_register_module(&rdn_name_ops);
 343 }