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