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/events/events.h"
  33 #include "lib/tdb/include/tdb.h"
  34 #include "lib/ldb/include/ldb.h"
  35 #include "db_wrap.h"
  36
  37 static struct tdb_wrap *tdb_list;
  38
  39 /*
  40   this is used to catch debug messages from ldb
  41 */
  42 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  43                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
  44
  45 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  46                            const char *fmt, va_list ap)
  47 {
  48         char *s = NULL;
  49         if (DEBUGLEVEL < 4 && level > LDB_DEBUG_WARNING) {
  50                 return;
  51         }
  52         vasprintf(&s, fmt, ap);
  53         if (!s) return;
  54         DEBUG(level, ("ldb: %s\n", s));
  55         free(s);
  56 }
  57
  58 int wrap_caseless_cmp(void *context, const char *s1, const char *s2)
  59 {
  60         return strcasecmp_m(s1, s2);
  61 }
  62
  63 char *wrap_casefold(void *context, void *mem_ctx, const char *s)
  64 {
  65         return strupper_talloc(mem_ctx, s);
  66 }
  67
  68 /*
  69   wrapped connection to a ldb database
  70   to close just talloc_free() the returned ldb_context
  71  */
  72 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
  73                                      const char *url,
  74                                      struct auth_session_info *session_info,
  75                                      struct cli_credentials *credentials,
  76                                      unsigned int flags,
  77                                      const char *options[])
  78 {
  79         struct ldb_context *ldb;
  80         int ret;
  81         struct event_context *ev;
  82         char *real_url = NULL;
  83
  84         ldb = ldb_init(mem_ctx);
  85         if (ldb == NULL) {
  86                 return NULL;
  87         }
  88
  89         /* we want to use the existing event context if possible. This
  90            relies on the fact that in smbd, everything is a child of
  91            the main event_context */
  92         ev = event_context_find(ldb);
  93
  94         if (ldb_set_opaque(ldb, "EventContext", ev)) {
  95                 talloc_free(ldb);
  96                 return NULL;
  97         }
  98
  99         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
 100                 talloc_free(ldb);
 101                 return NULL;
 102         }
 103
 104         if (ldb_set_opaque(ldb, "credentials", credentials)) {
 105                 talloc_free(ldb);
 106                 return NULL;
 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         /* allow admins to force non-sync ldb for all databases */
 122         if (lp_parm_bool(-1, "ldb", "nosync", False)) {
 123                 flags |= LDB_FLG_NOSYNC;
 124         }
 125
 126         ret = ldb_connect(ldb, real_url, flags, options);
 127         if (ret == -1) {
 128                 talloc_free(ldb);
 129                 return NULL;
 130         }
 131
 132         talloc_free(real_url);
 133
 134         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 135
 136         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 137
 138         return ldb;
 139 }
 140
 141
 142 /*
 143  Log tdb messages via DEBUG().
 144 */
 145 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 146                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 147
 148 static void tdb_wrap_log(TDB_CONTEXT *tdb, int level,
 149                          const char *format, ...)
 150 {
 151         va_list ap;
 152         char *ptr = NULL;
 153
 154         va_start(ap, format);
 155         vasprintf(&ptr, format, ap);
 156         va_end(ap);
 157
 158         if (ptr != NULL) {
 159                 const char *name = tdb_name(tdb);
 160                 DEBUG(level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
 161                 free(ptr);
 162         }
 163 }
 164
 165
 166 /* destroy the last connection to a tdb */
 167 static int tdb_wrap_destructor(void *ctx)
 168 {
 169         struct tdb_wrap *w = ctx;
 170         tdb_close(w->tdb);
 171         DLIST_REMOVE(tdb_list, w);
 172         return 0;
 173 }
 174
 175 /*
 176   wrapped connection to a tdb database
 177   to close just talloc_free() the tdb_wrap pointer
 178  */
 179 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 180                                const char *name, int hash_size, int tdb_flags,
 181                                int open_flags, mode_t mode)
 182 {
 183         struct tdb_wrap *w;
 184
 185         for (w=tdb_list;w;w=w->next) {
 186                 if (strcmp(name, w->name) == 0) {
 187                         return talloc_reference(mem_ctx, w);
 188                 }
 189         }
 190
 191         w = talloc(mem_ctx, struct tdb_wrap);
 192         if (w == NULL) {
 193                 return NULL;
 194         }
 195
 196         w->name = talloc_strdup(w, name);
 197
 198         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 199                              open_flags, mode, tdb_wrap_log, NULL);
 200         if (w->tdb == NULL) {
 201                 talloc_free(w);
 202                 return NULL;
 203         }
 204
 205         talloc_set_destructor(w, tdb_wrap_destructor);
 206
 207         DLIST_ADD(tdb_list, w);
 208
 209         return w;
 210 }