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/ldb/include/ldb.h"
  33
  34 static struct ldb_wrap *ldb_list;
  35 static struct tdb_wrap *tdb_list;
  36
  37 /*
  38   this is used to catch debug messages from ldb
  39 */
  40 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  41                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
  42
  43 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  44                            const char *fmt, va_list ap)
  45 {
  46         char *s = NULL;
  47         if (DEBUGLEVEL < 4 && level > LDB_DEBUG_WARNING) {
  48                 return;
  49         }
  50         vasprintf(&s, fmt, ap);
  51         if (!s) return;
  52         DEBUG(level, ("ldb: %s\n", s));
  53         free(s);
  54 }
  55
  56
  57 /* destroy the last connection to a ldb */
  58 static int ldb_wrap_destructor(void *ctx)
  59 {
  60         struct ldb_wrap *w = ctx;
  61         ldb_close(w->ldb);
  62         DLIST_REMOVE(ldb_list, w);
  63         return 0;
  64 }
  65
  66 /*
  67   wrapped connection to a ldb database
  68   to close just talloc_free() the ldb_wrap pointer
  69  */
  70 struct ldb_wrap *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
  71                                   const char *url,
  72                                   unsigned int flags,
  73                                   const char *options[])
  74 {
  75         struct ldb_wrap *w;
  76
  77         for (w=ldb_list;w;w=w->next) {
  78                 if (strcmp(url, w->url) == 0) {
  79                         return talloc_reference(mem_ctx, w);
  80                 }
  81         }
  82
  83         w = talloc_p(mem_ctx, struct ldb_wrap);
  84         if (w == NULL) {
  85                 return NULL;
  86         }
  87
  88         w->url = talloc_strdup(w, url);
  89
  90         w->ldb = ldb_connect(url, flags, options);
  91         if (w->ldb == NULL) {
  92                 talloc_free(w);
  93                 return NULL;
  94         }
  95
  96         talloc_set_destructor(w, ldb_wrap_destructor);
  97         ldb_set_debug(w->ldb, ldb_wrap_debug, NULL);
  98
  99         DLIST_ADD(ldb_list, w);
 100
 101         return w;
 102 }
 103
 104
 105 /*
 106  Log tdb messages via DEBUG().
 107 */
 108 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 109                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 110
 111 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 112                          const char *format, ...)
 113 {
 114         va_list ap;
 115         char *ptr = NULL;
 116
 117         va_start(ap, format);
 118         vasprintf(&ptr, format, ap);
 119         va_end(ap);
 120
 121         if (ptr != NULL) {
 122                 DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
 123                 free(ptr);
 124         }
 125 }
 126
 127
 128 /* destroy the last connection to a tdb */
 129 static int tdb_wrap_destructor(void *ctx)
 130 {
 131         struct tdb_wrap *w = ctx;
 132         tdb_close(w->tdb);
 133         DLIST_REMOVE(tdb_list, w);
 134         return 0;
 135 }
 136
 137 /*
 138   wrapped connection to a tdb database
 139   to close just talloc_free() the tdb_wrap pointer
 140  */
 141 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 142                                const char *name, int hash_size, int tdb_flags,
 143                                int open_flags, mode_t mode)
 144 {
 145         struct tdb_wrap *w;
 146
 147         for (w=tdb_list;w;w=w->next) {
 148                 if (strcmp(name, w->name) == 0) {
 149                         return talloc_reference(mem_ctx, w);
 150                 }
 151         }
 152
 153         w = talloc_p(mem_ctx, struct tdb_wrap);
 154         if (w == NULL) {
 155                 return NULL;
 156         }
 157
 158         w->name = talloc_strdup(w, name);
 159
 160         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 161                              open_flags, mode, tdb_wrap_log, NULL);
 162         if (w->tdb == NULL) {
 163                 talloc_free(w);
 164                 return NULL;
 165         }
 166
 167         talloc_set_destructor(w, tdb_wrap_destructor);
 168
 169         DLIST_ADD(tdb_list, w);
 170
 171         return w;
 172 }