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_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
 102                       TDB_DATA key)
 103 {
 104         TDB_DATA result;
 105
 106         if (db->fetch(db, mem_ctx, key, &result) != 0) {
 107                 return make_tdb_data(NULL, 0);
 108         }
 109
 110         return result;
 111 }
 112
 113 bool dbwrap_exists(struct db_context *db, TDB_DATA key)
 114 {
 115         int result;
 116         if (db->exists != NULL) {
 117                 result = db->exists(db, key);
 118         } else {
 119                 result = dbwrap_fallback_exists(db,key);
 120         }
 121         return (result == 1);
 122 }
 123
 124 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
 125                       TDB_DATA data, int flags)
 126 {
 127         struct db_record *rec;
 128         NTSTATUS status;
 129
 130         rec = db->fetch_locked(db, talloc_tos(), key);
 131         if (rec == NULL) {
 132                 return NT_STATUS_NO_MEMORY;
 133         }
 134
 135         status = rec->store(rec, data, flags);
 136         TALLOC_FREE(rec);
 137         return status;
 138 }
 139
 140 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key)
 141 {
 142         struct db_record *rec;
 143         NTSTATUS status;
 144
 145         rec = db->fetch_locked(db, talloc_tos(), key);
 146         if (rec == NULL) {
 147                 return NT_STATUS_NO_MEMORY;
 148         }
 149         status = rec->delete_rec(rec);
 150         TALLOC_FREE(rec);
 151         return status;
 152 }
 153
 154 NTSTATUS dbwrap_traverse(struct db_context *db,
 155                          int (*f)(struct db_record*, void*),
 156                          void *private_data,
 157                          int *count)
 158 {
 159         int ret = db->traverse(db, f, private_data);
 160
 161         if (ret < 0) {
 162                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 163         }
 164
 165         if (count != NULL) {
 166                 *count = ret;
 167         }
 168
 169         return NT_STATUS_OK;
 170 }
 171
 172 NTSTATUS dbwrap_traverse_read(struct db_context *db,
 173                               int (*f)(struct db_record*, void*),
 174                               void *private_data,
 175                               int *count)
 176 {
 177         int ret = db->traverse_read(db, f, private_data);
 178
 179         if (ret < 0) {
 180                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 181         }
 182
 183         if (count != NULL) {
 184                 *count = ret;
 185         }
 186
 187         return NT_STATUS_OK;
 188 }
 189
 190 static int dbwrap_null_parser(TDB_DATA key, TDB_DATA val, void* data)
 191 {
 192         return 0;
 193 }
 194
 195 int dbwrap_parse_record(struct db_context *db, TDB_DATA key,
 196                         int (*parser)(TDB_DATA key, TDB_DATA data,
 197                                       void *private_data),
 198                         void *private_data)
 199 {
 200         if (parser == NULL) {
 201                 parser = dbwrap_null_parser;
 202         }
 203
 204         if (db->parse_record) {
 205                 return db->parse_record(db, key, parser, private_data);
 206         } else {
 207                 return dbwrap_fallback_parse_record(db, key, parser, private_data);
 208         }
 209 }
 210
 211 int dbwrap_wipe(struct db_context *db)
 212 {
 213         return db->wipe(db);
 214 }
 215
 216 int dbwrap_get_flags(struct db_context *db)
 217 {
 218         return db->get_flags(db);
 219 }
 220
 221 int dbwrap_transaction_start(struct db_context *db)
 222 {
 223         return db->transaction_start(db);
 224 }
 225
 226 int dbwrap_transaction_commit(struct db_context *db)
 227 {
 228         return db->transaction_commit(db);
 229 }
 230
 231 int dbwrap_transaction_cancel(struct db_context *db)
 232 {
 233         return db->transaction_cancel(db);
 234 }