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         int ret;
  85         struct event_context *ev;
  86         char *real_url = NULL;
  87
  88         for (w = ldb_list; w; w = w->next) {
  89                 if (strcmp(url, w->url) == 0) {
  90                         return talloc_reference(mem_ctx, w->ldb);
  91                 }
  92         }
  93
  94         ldb = ldb_init(talloc_autofree_context());
  95         if (ldb == NULL) {
  96                 return NULL;
  97         }
  98
  99         /* we want to use the existing event context if possible. This
 100            relies on the fact that in smbd, everything is a child of
 101            the main event_context */
 102         ev = talloc_find_parent_bytype(mem_ctx, struct event_context);
 103         if (ev) {
 104                 ldb_set_opaque(ldb, "EventContext", ev);
 105         } else {
 106                 DEBUG(0,("WARNING: event_context not found\n"));
 107                 talloc_show_parents(mem_ctx, stdout);
 108         }
 109
 110         ret = ldb_register_samba_handlers(ldb);
 111         if (ret == -1) {
 112                 talloc_free(ldb);
 113                 return NULL;
 114         }
 115
 116         real_url = private_path(ldb, url);
 117         if (real_url == NULL) {
 118                 talloc_free(ldb);
 119                 return NULL;
 120         }
 121
 122         ret = ldb_connect(ldb, real_url, flags, options);
 123         if (ret == -1) {
 124                 talloc_free(ldb);
 125                 return NULL;
 126         }
 127
 128         talloc_free(real_url);
 129
 130         w = talloc(ldb, struct ldb_wrap);
 131         if (w == NULL) {
 132                 talloc_free(ldb);
 133                 return NULL;
 134         }
 135
 136         w->ldb = ldb;
 137         w->url = talloc_strdup(w, url);
 138
 139         talloc_set_destructor(w, ldb_wrap_destructor);
 140         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 141
 142         DLIST_ADD(ldb_list, w);
 143
 144         return ldb;
 145 }
 146
 147
 148 /*
 149  Log tdb messages via DEBUG().
 150 */
 151 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 152                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 153
 154 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 155                          const char *format, ...)
 156 {
 157         va_list ap;
 158         char *ptr = NULL;
 159
 160         va_start(ap, format);
 161         vasprintf(&ptr, format, ap);
 162         va_end(ap);
 163
 164         if (ptr != NULL) {
 165                 DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
 166                 free(ptr);
 167         }
 168 }
 169
 170
 171 /* destroy the last connection to a tdb */
 172 static int tdb_wrap_destructor(void *ctx)
 173 {
 174         struct tdb_wrap *w = ctx;
 175         tdb_close(w->tdb);
 176         DLIST_REMOVE(tdb_list, w);
 177         return 0;
 178 }
 179
 180 /*
 181   wrapped connection to a tdb database
 182   to close just talloc_free() the tdb_wrap pointer
 183  */
 184 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 185                                const char *name, int hash_size, int tdb_flags,
 186                                int open_flags, mode_t mode)
 187 {
 188         struct tdb_wrap *w;
 189
 190         for (w=tdb_list;w;w=w->next) {
 191                 if (strcmp(name, w->name) == 0) {
 192                         return talloc_reference(mem_ctx, w);
 193                 }
 194         }
 195
 196         w = talloc(mem_ctx, struct tdb_wrap);
 197         if (w == NULL) {
 198                 return NULL;
 199         }
 200
 201         w->name = talloc_strdup(w, name);
 202
 203         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 204                              open_flags, mode, tdb_wrap_log, NULL);
 205         if (w->tdb == NULL) {
 206                 talloc_free(w);
 207                 return NULL;
 208         }
 209
 210         talloc_set_destructor(w, tdb_wrap_destructor);
 211
 212         DLIST_ADD(tdb_list, w);
 213
 214         return w;
 215 }