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