source4/lib/db_wrap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    database wrap functions
   5
   6    Copyright (C) Andrew Tridgell 2004
   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 2 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, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 /*
  24   the stupidity of the unix fcntl locking design forces us to never
  25   allow a database file to be opened twice in the same process. These
  26   wrappers provide convenient access to a tdb or ldb, taking advantage
  27   of talloc destructors to ensure that only a single open is done
  28 */
  29
  30 #include "includes.h"
  31 #include "dlinklist.h"
  32 #include "lib/tdb/include/tdb.h"
  33 #include "lib/ldb/include/ldb.h"
  34 #include "db_wrap.h"
  35
  36 struct ldb_wrap {
  37         struct ldb_context *ldb;
  38
  39         const char *url;
  40         struct ldb_wrap *next, *prev;
  41 };
  42
  43 static struct ldb_wrap *ldb_list;
  44 static struct tdb_wrap *tdb_list;
  45
  46 /*
  47   this is used to catch debug messages from ldb
  48 */
  49 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  50                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
  51
  52 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  53                            const char *fmt, va_list ap)
  54 {
  55         char *s = NULL;
  56         if (DEBUGLEVEL < 4 && level > LDB_DEBUG_WARNING) {
  57                 return;
  58         }
  59         vasprintf(&s, fmt, ap);
  60         if (!s) return;
  61         DEBUG(level, ("ldb: %s\n", s));
  62         free(s);
  63 }
  64
  65 /* destroy the last connection to a ldb */
  66 static int ldb_wrap_destructor(void *ctx)
  67 {
  68         struct ldb_wrap *w = ctx;
  69         DLIST_REMOVE(ldb_list, w);
  70         return 0;
  71 }
  72
  73 /*
  74   wrapped connection to a ldb database
  75   to close just talloc_free() the returned ldb_context
  76  */
  77 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
  78                                   const char *url,
  79                                   unsigned int flags,
  80                                   const char *options[])
  81 {
  82         struct ldb_context *ldb;
  83         struct ldb_wrap *w;
  84
  85         for (w = ldb_list; w; w = w->next) {
  86                 if (strcmp(url, w->url) == 0) {
  87                         return talloc_reference(mem_ctx, w->ldb);
  88                 }
  89         }
  90
  91         ldb = ldb_connect(url, flags, options);
  92         if (ldb == NULL) {
  93                 return NULL;
  94         }
  95
  96         w = talloc(ldb, struct ldb_wrap);
  97         if (w == NULL) {
  98                 talloc_free(ldb);
  99                 return NULL;
 100         }
 101
 102         w->ldb = ldb;
 103         w->url = talloc_strdup(w, url);
 104
 105         talloc_set_destructor(w, ldb_wrap_destructor);
 106         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 107
 108         DLIST_ADD(ldb_list, w);
 109
 110         return ldb;
 111 }
 112
 113
 114 /*
 115  Log tdb messages via DEBUG().
 116 */
 117 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 118                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 119
 120 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 121                          const char *format, ...)
 122 {
 123         va_list ap;
 124         char *ptr = NULL;
 125
 126         va_start(ap, format);
 127         vasprintf(&ptr, format, ap);
 128         va_end(ap);
 129
 130         if (ptr != NULL) {
 131                 DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
 132                 free(ptr);
 133         }
 134 }
 135
 136
 137 /* destroy the last connection to a tdb */
 138 static int tdb_wrap_destructor(void *ctx)
 139 {
 140         struct tdb_wrap *w = ctx;
 141         tdb_close(w->tdb);
 142         DLIST_REMOVE(tdb_list, w);
 143         return 0;
 144 }
 145
 146 /*
 147   wrapped connection to a tdb database
 148   to close just talloc_free() the tdb_wrap pointer
 149  */
 150 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 151                                const char *name, int hash_size, int tdb_flags,
 152                                int open_flags, mode_t mode)
 153 {
 154         struct tdb_wrap *w;
 155
 156         for (w=tdb_list;w;w=w->next) {
 157                 if (strcmp(name, w->name) == 0) {
 158                         return talloc_reference(mem_ctx, w);
 159                 }
 160         }
 161
 162         w = talloc(mem_ctx, struct tdb_wrap);
 163         if (w == NULL) {
 164                 return NULL;
 165         }
 166
 167         w->name = talloc_strdup(w, name);
 168
 169         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 170                              open_flags, mode, tdb_wrap_log, NULL);
 171         if (w->tdb == NULL) {
 172                 talloc_free(w);
 173                 return NULL;
 174         }
 175
 176         talloc_set_destructor(w, tdb_wrap_destructor);
 177
 178         DLIST_ADD(tdb_list, w);
 179
 180         return w;
 181 }