r23796: main COPYING file for samba4, plus some formatting varients
[samba.git] / 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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 /*
23   the stupidity of the unix fcntl locking design forces us to never
24   allow a database file to be opened twice in the same process. These
25   wrappers provide convenient access to a tdb or ldb, taking advantage
26   of talloc destructors to ensure that only a single open is done
27 */
28
29 #include "includes.h"
30 #include "lib/util/dlinklist.h"
31 #include "lib/events/events.h"
32 #include "lib/tdb/include/tdb.h"
33 #include "lib/ldb/include/ldb.h"
34 #include "lib/ldb/include/ldb_errors.h"
35 #include "lib/ldb/samba/ldif_handlers.h"
36 #include "db_wrap.h"
37 #include "dsdb/samdb/samdb.h"
38
39 static struct tdb_wrap *tdb_list;
40
41 /*
42   this is used to catch debug messages from ldb
43 */
44 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
45                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
46
47 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
48                            const char *fmt, va_list ap)
49 {
50         char *s = NULL;
51         if (DEBUGLEVEL < 4 && level > LDB_DEBUG_WARNING) {
52                 return;
53         }
54         if (DEBUGLEVEL < 2 && level > LDB_DEBUG_ERROR) {
55                 return;
56         }
57         vasprintf(&s, fmt, ap);
58         if (!s) return;
59         DEBUG(level, ("ldb: %s\n", s));
60         free(s);
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 /* check for memory leaks on the ldb context */
69 static int ldb_wrap_destructor(struct ldb_context *ldb)
70 {
71         size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
72         if (startup_blocks &&
73             talloc_total_blocks(ldb) > *startup_blocks + 100) {
74                 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
75                          (char *)ldb_get_opaque(ldb, "wrap_url"), 
76                          (unsigned long)talloc_total_blocks(ldb), 
77                          (unsigned long)*startup_blocks,
78                          (unsigned long)talloc_total_size(ldb)));
79 #if 0
80                 talloc_report_full(ldb, stdout);
81 #endif
82         }
83         return 0;
84 }                                
85
86 /*
87   wrapped connection to a ldb database
88   to close just talloc_free() the returned ldb_context
89
90   TODO:  We need an error_string parameter
91  */
92 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
93                                      const char *url,
94                                      struct auth_session_info *session_info,
95                                      struct cli_credentials *credentials,
96                                      unsigned int flags,
97                                      const char *options[])
98 {
99         struct ldb_context *ldb;
100         int ret;
101         struct event_context *ev;
102         char *real_url = NULL;
103         size_t *startup_blocks;
104
105         ldb = ldb_init(mem_ctx);
106         if (ldb == NULL) {
107                 return NULL;
108         }
109
110         /* we want to use the existing event context if possible. This
111            relies on the fact that in smbd, everything is a child of
112            the main event_context */
113         ev = event_context_find(ldb);
114
115         if (ldb_set_opaque(ldb, "EventContext", ev)) {
116                 talloc_free(ldb);
117                 return NULL;
118         }
119
120         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
121                 talloc_free(ldb);
122                 return NULL;
123         }
124
125         if (ldb_set_opaque(ldb, "credentials", credentials)) {
126                 talloc_free(ldb);
127                 return NULL;
128         }
129         
130         if (strcmp(lp_sam_url(), url) == 0) {
131                 dsdb_set_global_schema(ldb);
132         }
133
134         ret = ldb_register_samba_handlers(ldb);
135         if (ret == -1) {
136                 talloc_free(ldb);
137                 return NULL;
138         }
139
140         real_url = private_path(ldb, url);
141         if (real_url == NULL) {
142                 talloc_free(ldb);
143                 return NULL;
144         }
145
146         /* allow admins to force non-sync ldb for all databases */
147         if (lp_parm_bool(-1, "ldb", "nosync", False)) {
148                 flags |= LDB_FLG_NOSYNC;
149         }
150
151         /* we usually want Samba databases to be private. If we later
152            find we need one public, we will need to add a parameter to
153            ldb_wrap_connect() */
154         ldb_set_create_perms(ldb, 0600);
155         
156         ret = ldb_connect(ldb, real_url, flags, options);
157         if (ret != LDB_SUCCESS) {
158                 talloc_free(ldb);
159                 return NULL;
160         }
161
162         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
163
164         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
165
166         /* setup for leak detection */
167         ldb_set_opaque(ldb, "wrap_url", real_url);
168         startup_blocks = talloc(ldb, size_t);
169         *startup_blocks = talloc_total_blocks(ldb);
170         ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
171         
172         talloc_set_destructor(ldb, ldb_wrap_destructor);
173
174         return ldb;
175 }
176
177
178 /*
179  Log tdb messages via DEBUG().
180 */
181 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, 
182                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
183
184 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, 
185                          const char *format, ...)
186 {
187         va_list ap;
188         char *ptr = NULL;
189         int debug_level;
190
191         va_start(ap, format);
192         vasprintf(&ptr, format, ap);
193         va_end(ap);
194         
195         switch (level) {
196         case TDB_DEBUG_FATAL:
197                 debug_level = 0;
198                 break;
199         case TDB_DEBUG_ERROR:
200                 debug_level = 1;
201                 break;
202         case TDB_DEBUG_WARNING:
203                 debug_level = 2;
204                 break;
205         case TDB_DEBUG_TRACE:
206                 debug_level = 5;
207                 break;
208         default:
209                 debug_level = 0;
210         }               
211
212         if (ptr != NULL) {
213                 const char *name = tdb_name(tdb);
214                 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
215                 free(ptr);
216         }
217 }
218
219
220 /* destroy the last connection to a tdb */
221 static int tdb_wrap_destructor(struct tdb_wrap *w)
222 {
223         tdb_close(w->tdb);
224         DLIST_REMOVE(tdb_list, w);
225         return 0;
226 }                                
227
228 /*
229   wrapped connection to a tdb database
230   to close just talloc_free() the tdb_wrap pointer
231  */
232 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
233                                const char *name, int hash_size, int tdb_flags,
234                                int open_flags, mode_t mode)
235 {
236         struct tdb_wrap *w;
237         struct tdb_logging_context log_ctx;
238         log_ctx.log_fn = tdb_wrap_log;
239
240         for (w=tdb_list;w;w=w->next) {
241                 if (strcmp(name, w->name) == 0) {
242                         return talloc_reference(mem_ctx, w);
243                 }
244         }
245
246         w = talloc(mem_ctx, struct tdb_wrap);
247         if (w == NULL) {
248                 return NULL;
249         }
250
251         w->name = talloc_strdup(w, name);
252
253         w->tdb = tdb_open_ex(name, hash_size, tdb_flags, 
254                              open_flags, mode, &log_ctx, NULL);
255         if (w->tdb == NULL) {
256                 talloc_free(w);
257                 return NULL;
258         }
259
260         talloc_set_destructor(w, tdb_wrap_destructor);
261
262         DLIST_ADD(tdb_list, w);
263
264         return w;
265 }