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 int dbwrap_fallback_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  32                           TDB_DATA key, TDB_DATA *data)
  33 {
  34         struct db_record *rec;
  35
  36         if (!(rec = db->fetch_locked(db, mem_ctx, key))) {
  37                 return -1;
  38         }
  39
  40         data->dsize = rec->value.dsize;
  41         data->dptr = talloc_move(mem_ctx, &rec->value.dptr);
  42         TALLOC_FREE(rec);
  43         return 0;
  44 }
  45
  46 /*
  47  * Fall back using fetch if no genuine exists operation is provided
  48  */
  49
  50 static int dbwrap_fallback_exists(struct db_context *db, TDB_DATA key)
  51 {
  52         int res = dbwrap_parse_record(db, key, NULL, NULL);
  53         return  ( res == -1) ? 0 : 1;
  54 }
  55
  56 /*
  57  * Fall back using fetch if no genuine parse operation is provided
  58  */
  59
  60 int dbwrap_fallback_parse_record(struct db_context *db, TDB_DATA key,
  61                                  int (*parser)(TDB_DATA key,
  62                                                TDB_DATA data,
  63                                                void *private_data),
  64                                  void *private_data)
  65 {
  66         TDB_DATA data;
  67         int res;
  68
  69         res = db->fetch(db, talloc_tos(), key, &data);
  70         if (res != 0) {
  71                 return -1;
  72         }
  73
  74         res = parser(key, data, private_data);
  75         TALLOC_FREE(data.dptr);
  76         return res;
  77 }
  78
  79
  80 static int delete_record(struct db_record *rec, void *data)
  81 {
  82         NTSTATUS status = rec->delete_rec(rec);
  83         return NT_STATUS_IS_OK(status) ? 0 : -1;
  84 }
  85
  86 /*
  87  * Fallback wipe ipmlementation using traverse and delete if no genuine
  88  * wipe operation is provided
  89  */
  90 int dbwrap_fallback_wipe(struct db_context *db)
  91 {
  92         NTSTATUS status = dbwrap_trans_traverse(db, &delete_record, NULL);
  93         return NT_STATUS_IS_OK(status) ? 0 : -1;
  94 }
  95
  96
  97 /*
  98  * Wrapper functions for the backend methods
  99  */
 100
 101 TDB_DATA dbwrap_record_get_key(const struct db_record *rec)
 102 {
 103         return rec->key;
 104 }
 105
 106 TDB_DATA dbwrap_record_get_value(const struct db_record *rec)
 107 {
 108         return rec->value;
 109 }
 110
 111 void *dbwrap_record_get_private_data(const struct db_record *rec)
 112 {
 113         return rec->private_data;
 114 }
 115
 116 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags)
 117 {
 118         return rec->store(rec, data, flags);
 119 }
 120
 121 NTSTATUS dbwrap_record_delete(struct db_record *rec)
 122 {
 123         return rec->delete_rec(rec);
 124 }
 125
 126 TDB_DATA dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
 127                       TDB_DATA key)
 128 {
 129         TDB_DATA result;
 130
 131         if (db->fetch(db, mem_ctx, key, &result) != 0) {
 132                 return make_tdb_data(NULL, 0);
 133         }
 134
 135         return result;
 136 }
 137
 138 bool dbwrap_exists(struct db_context *db, TDB_DATA key)
 139 {
 140         int result;
 141         if (db->exists != NULL) {
 142                 result = db->exists(db, key);
 143         } else {
 144                 result = dbwrap_fallback_exists(db,key);
 145         }
 146         return (result == 1);
 147 }
 148
 149 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
 150                       TDB_DATA data, int flags)
 151 {
 152         struct db_record *rec;
 153         NTSTATUS status;
 154
 155         rec = db->fetch_locked(db, talloc_tos(), key);
 156         if (rec == NULL) {
 157                 return NT_STATUS_NO_MEMORY;
 158         }
 159
 160         status = rec->store(rec, data, flags);
 161         TALLOC_FREE(rec);
 162         return status;
 163 }
 164
 165 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key)
 166 {
 167         struct db_record *rec;
 168         NTSTATUS status;
 169
 170         rec = db->fetch_locked(db, talloc_tos(), key);
 171         if (rec == NULL) {
 172                 return NT_STATUS_NO_MEMORY;
 173         }
 174         status = rec->delete_rec(rec);
 175         TALLOC_FREE(rec);
 176         return status;
 177 }
 178
 179 NTSTATUS dbwrap_traverse(struct db_context *db,
 180                          int (*f)(struct db_record*, void*),
 181                          void *private_data,
 182                          int *count)
 183 {
 184         int ret = db->traverse(db, f, private_data);
 185
 186         if (ret < 0) {
 187                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 188         }
 189
 190         if (count != NULL) {
 191                 *count = ret;
 192         }
 193
 194         return NT_STATUS_OK;
 195 }
 196
 197 NTSTATUS dbwrap_traverse_read(struct db_context *db,
 198                               int (*f)(struct db_record*, void*),
 199                               void *private_data,
 200                               int *count)
 201 {
 202         int ret = db->traverse_read(db, f, private_data);
 203
 204         if (ret < 0) {
 205                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 206         }
 207
 208         if (count != NULL) {
 209                 *count = ret;
 210         }
 211
 212         return NT_STATUS_OK;
 213 }
 214
 215 static int dbwrap_null_parser(TDB_DATA key, TDB_DATA val, void* data)
 216 {
 217         return 0;
 218 }
 219
 220 int dbwrap_parse_record(struct db_context *db, TDB_DATA key,
 221                         int (*parser)(TDB_DATA key, TDB_DATA data,
 222                                       void *private_data),
 223                         void *private_data)
 224 {
 225         if (parser == NULL) {
 226                 parser = dbwrap_null_parser;
 227         }
 228
 229         if (db->parse_record) {
 230                 return db->parse_record(db, key, parser, private_data);
 231         } else {
 232                 return dbwrap_fallback_parse_record(db, key, parser, private_data);
 233         }
 234 }
 235
 236 int dbwrap_wipe(struct db_context *db)
 237 {
 238         return db->wipe(db);
 239 }
 240
 241 int dbwrap_get_seqnum(struct db_context *db)
 242 {
 243         return db->get_seqnum(db);
 244 }
 245
 246 int dbwrap_get_flags(struct db_context *db)
 247 {
 248         return db->get_flags(db);
 249 }
 250
 251 int dbwrap_transaction_start(struct db_context *db)
 252 {
 253         return db->transaction_start(db);
 254 }
 255
 256 int dbwrap_transaction_commit(struct db_context *db)
 257 {
 258         return db->transaction_commit(db);
 259 }
 260
 261 int dbwrap_transaction_cancel(struct db_context *db)
 262 {
 263         return db->transaction_cancel(db);
 264 }