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