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