source3/lib/dbwrap/dbwrap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Database interface wrapper
   4    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2006
   5
   6    Major code contributions from Aleksey Fedoseev (fedoseev@ru.ibm.com)
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "dbwrap/dbwrap.h"
  24 #include "dbwrap/dbwrap_private.h"
  25 #include "util_tdb.h"
  26
  27 /*
  28  * Fall back using fetch_locked if no genuine fetch operation is provided
  29  */
  30
  31 static NTSTATUS dbwrap_fallback_fetch(struct db_context *db,
  32                                       TALLOC_CTX *mem_ctx,
  33                                       TDB_DATA key, TDB_DATA *data)
  34 {
  35         struct db_record *rec;
  36
  37         rec = dbwrap_fetch_locked(db, mem_ctx, key);
  38         if (rec == NULL) {
  39                 return NT_STATUS_UNSUCCESSFUL;
  40         }
  41
  42         data->dsize = rec->value.dsize;
  43         data->dptr = talloc_move(mem_ctx, &rec->value.dptr);
  44         TALLOC_FREE(rec);
  45         return NT_STATUS_OK;
  46 }
  47
  48 /*
  49  * Fall back using fetch if no genuine exists operation is provided
  50  */
  51
  52 static int dbwrap_fallback_exists(struct db_context *db, TDB_DATA key)
  53 {
  54         NTSTATUS status = dbwrap_parse_record(db, key, NULL, NULL);
  55         return NT_STATUS_IS_OK(status) ? 1 : 0;
  56 }
  57
  58 /*
  59  * Fall back using fetch if no genuine parse operation is provided
  60  */
  61
  62 static NTSTATUS dbwrap_fallback_parse_record(struct db_context *db, TDB_DATA key,
  63                                              void (*parser)(TDB_DATA key,
  64                                                             TDB_DATA data,
  65                                                             void *private_data),
  66                                              void *private_data)
  67 {
  68         struct db_record *rec;
  69         TDB_DATA data;
  70
  71         rec = dbwrap_fetch_locked(db, talloc_tos(), key);
  72         if (rec == NULL) {
  73                 return NT_STATUS_NOT_FOUND;
  74         }
  75         data = dbwrap_record_get_value(rec);
  76
  77         data.dptr = talloc_memdup(talloc_tos(), data.dptr, data.dsize);
  78         TALLOC_FREE(rec);
  79         if (data.dptr == NULL) {
  80                 return NT_STATUS_NO_MEMORY;
  81         }
  82
  83         parser(key, data, private_data);
  84
  85         TALLOC_FREE(data.dptr);
  86         return NT_STATUS_OK;
  87 }
  88
  89
  90 static int delete_record(struct db_record *rec, void *data)
  91 {
  92         NTSTATUS status = dbwrap_record_delete(rec);
  93         return NT_STATUS_IS_OK(status) ? 0 : -1;
  94 }
  95
  96 /*
  97  * Fallback wipe implementation using traverse and delete if no genuine
  98  * wipe operation is provided
  99  */
 100 static int dbwrap_fallback_wipe(struct db_context *db)
 101 {
 102         NTSTATUS status = dbwrap_trans_traverse(db, delete_record, NULL);
 103         return NT_STATUS_IS_OK(status) ? 0 : -1;
 104 }
 105
 106
 107 /*
 108  * Wrapper functions for the backend methods
 109  */
 110
 111 TDB_DATA dbwrap_record_get_key(const struct db_record *rec)
 112 {
 113         return rec->key;
 114 }
 115
 116 TDB_DATA dbwrap_record_get_value(const struct db_record *rec)
 117 {
 118         return rec->value;
 119 }
 120
 121 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags)
 122 {
 123         return rec->store(rec, data, flags);
 124 }
 125
 126 NTSTATUS dbwrap_record_delete(struct db_record *rec)
 127 {
 128         return rec->delete_rec(rec);
 129 }
 130
 131 struct db_record *dbwrap_fetch_locked(struct db_context *db,
 132                                       TALLOC_CTX *mem_ctx,
 133                                       TDB_DATA key)
 134 {
 135         return db->fetch_locked(db, mem_ctx, key);
 136 }
 137
 138 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
 139                       TDB_DATA key, TDB_DATA *value)
 140 {
 141         if (value == NULL) {
 142                 return NT_STATUS_INVALID_PARAMETER;
 143         }
 144         if (db->fetch == NULL) {
 145                 return dbwrap_fallback_fetch(db, mem_ctx, key, value);
 146         }
 147         return db->fetch(db, mem_ctx, key, value);
 148 }
 149
 150 bool dbwrap_exists(struct db_context *db, TDB_DATA key)
 151 {
 152         int result;
 153         if (db->exists != NULL) {
 154                 result = db->exists(db, key);
 155         } else {
 156                 result = dbwrap_fallback_exists(db,key);
 157         }
 158         return (result == 1);
 159 }
 160
 161 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
 162                       TDB_DATA data, int flags)
 163 {
 164         struct db_record *rec;
 165         NTSTATUS status;
 166
 167         rec = dbwrap_fetch_locked(db, talloc_tos(), key);
 168         if (rec == NULL) {
 169                 return NT_STATUS_NO_MEMORY;
 170         }
 171
 172         status = dbwrap_record_store(rec, data, flags);
 173         TALLOC_FREE(rec);
 174         return status;
 175 }
 176
 177 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key)
 178 {
 179         struct db_record *rec;
 180         NTSTATUS status;
 181
 182         rec = dbwrap_fetch_locked(db, talloc_tos(), key);
 183         if (rec == NULL) {
 184                 return NT_STATUS_NO_MEMORY;
 185         }
 186         status = dbwrap_record_delete(rec);
 187         TALLOC_FREE(rec);
 188         return status;
 189 }
 190
 191 NTSTATUS dbwrap_traverse(struct db_context *db,
 192                          int (*f)(struct db_record*, void*),
 193                          void *private_data,
 194                          int *count)
 195 {
 196         int ret = db->traverse(db, f, private_data);
 197
 198         if (ret < 0) {
 199                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 200         }
 201
 202         if (count != NULL) {
 203                 *count = ret;
 204         }
 205
 206         return NT_STATUS_OK;
 207 }
 208
 209 NTSTATUS dbwrap_traverse_read(struct db_context *db,
 210                               int (*f)(struct db_record*, void*),
 211                               void *private_data,
 212                               int *count)
 213 {
 214         int ret = db->traverse_read(db, f, private_data);
 215
 216         if (ret < 0) {
 217                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 218         }
 219
 220         if (count != NULL) {
 221                 *count = ret;
 222         }
 223
 224         return NT_STATUS_OK;
 225 }
 226
 227 static void dbwrap_null_parser(TDB_DATA key, TDB_DATA val, void* data)
 228 {
 229         return;
 230 }
 231
 232 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
 233                              void (*parser)(TDB_DATA key, TDB_DATA data,
 234                                             void *private_data),
 235                              void *private_data)
 236 {
 237         if (parser == NULL) {
 238                 parser = dbwrap_null_parser;
 239         }
 240
 241         if (db->parse_record == NULL) {
 242                 return dbwrap_fallback_parse_record(db, key, parser,
 243                                                     private_data);
 244         }
 245         return db->parse_record(db, key, parser, private_data);
 246 }
 247
 248 int dbwrap_wipe(struct db_context *db)
 249 {
 250         if (db->wipe == NULL) {
 251                 return dbwrap_fallback_wipe(db);
 252         }
 253         return db->wipe(db);
 254 }
 255
 256 int dbwrap_get_seqnum(struct db_context *db)
 257 {
 258         return db->get_seqnum(db);
 259 }
 260
 261 int dbwrap_get_flags(struct db_context *db)
 262 {
 263         return db->get_flags(db);
 264 }
 265
 266 int dbwrap_transaction_start(struct db_context *db)
 267 {
 268         return db->transaction_start(db);
 269 }
 270
 271 int dbwrap_transaction_commit(struct db_context *db)
 272 {
 273         return db->transaction_commit(db);
 274 }
 275
 276 int dbwrap_transaction_cancel(struct db_context *db)
 277 {
 278         return db->transaction_cancel(db);
 279 }