pidl/python: Add explicit casts, fixes warnings about casts when enabled.
[kai/samba-autobuild/.git] / source3 / lib / smbconf / smbconf.c
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  libsmbconf - Samba configuration library
4  *  Copyright (C) Michael Adam 2007-2008
5  *  Copyright (C) Guenther Deschner 2007
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 3 of the License, or
10  *  (at your option) any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include "includes.h"
22 #include "smbconf_private.h"
23
24 /**********************************************************************
25  *
26  * internal helper functions
27  *
28  **********************************************************************/
29
30 static WERROR smbconf_global_check(struct smbconf_ctx *ctx)
31 {
32         if (!smbconf_share_exists(ctx, GLOBAL_NAME)) {
33                 return smbconf_create_share(ctx, GLOBAL_NAME);
34         }
35         return WERR_OK;
36 }
37
38
39 /**********************************************************************
40  *
41  * The actual libsmbconf API functions that are exported.
42  *
43  **********************************************************************/
44
45 /**
46  * Tell whether the backend requires messaging to be set up
47  * for the backend to work correctly.
48  */
49 bool smbconf_backend_requires_messaging(struct smbconf_ctx *ctx)
50 {
51         return ctx->ops->requires_messaging(ctx);
52 }
53
54 /**
55  * Tell whether the source is writeable.
56  */
57 bool smbconf_is_writeable(struct smbconf_ctx *ctx)
58 {
59         return ctx->ops->is_writeable(ctx);
60 }
61
62 /**
63  * utitlity function:
64  * check whether a config source is writeable,
65  * given only the name of the config source.
66  */
67 bool smbconf_is_writeable_bystring(const char *configsource)
68 {
69         struct smbconf_ctx *conf_ctx;
70         WERROR err;
71         bool ret;
72         TALLOC_CTX *mem_ctx = talloc_stackframe;
73
74         err = smbconf_init_reg(mem_ctx, &conf_ctx, configsource);
75         if (!W_ERROR_IS_OK(err)) {
76                       ret = false;
77                       goto done;
78         }
79
80         ret = smbconf_is_writeable(conf_ctx);
81
82 done:
83         smbconf_shutdown(conf_ctx);
84         TALLOC_FREE(mem_ctx);
85         return ret;
86 }
87
88 /**
89  * Close the configuration.
90  */
91 void smbconf_shutdown(struct smbconf_ctx *ctx)
92 {
93         TALLOC_FREE(ctx);
94 }
95
96 /**
97  * Detect changes in the configuration.
98  * The given csn struct is filled with the current csn.
99  * smbconf_changed() can also be used for initial retrieval
100  * of the csn.
101  */
102 bool smbconf_changed(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
103                      const char *service, const char *param)
104 {
105         struct smbconf_csn old_csn;
106
107         if (csn == NULL) {
108                 return false;
109         }
110
111         old_csn = *csn;
112
113         ctx->ops->get_csn(ctx, csn, service, param);
114         return (csn->csn != old_csn.csn);
115 }
116
117 /**
118  * Drop the whole configuration (restarting empty).
119  */
120 WERROR smbconf_drop(struct smbconf_ctx *ctx)
121 {
122         return ctx->ops->drop(ctx);
123 }
124
125 /**
126  * Get the whole configuration as lists of strings with counts:
127  *
128  *  num_shares   : number of shares
129  *  share_names  : list of length num_shares of share names
130  *  num_params   : list of length num_shares of parameter counts for each share
131  *  param_names  : list of lists of parameter names for each share
132  *  param_values : list of lists of parameter values for each share
133  */
134 WERROR smbconf_get_config(struct smbconf_ctx *ctx,
135                           TALLOC_CTX *mem_ctx,
136                           uint32_t *num_shares,
137                           struct smbconf_service ***services)
138 {
139         WERROR werr = WERR_OK;
140         TALLOC_CTX *tmp_ctx = NULL;
141         uint32_t tmp_num_shares;
142         char **tmp_share_names;
143         struct smbconf_service **tmp_services;
144         uint32_t count;
145
146         if ((num_shares == NULL) || (services == NULL)) {
147                 werr = WERR_INVALID_PARAM;
148                 goto done;
149         }
150
151         tmp_ctx = talloc_stackframe();
152
153         werr = smbconf_get_share_names(ctx, tmp_ctx, &tmp_num_shares,
154                                        &tmp_share_names);
155         if (!W_ERROR_IS_OK(werr)) {
156                 goto done;
157         }
158
159         tmp_services = TALLOC_ARRAY(tmp_ctx, struct smbconf_service *,
160                                     tmp_num_shares);
161
162         if (tmp_services == NULL) {
163                 werr = WERR_NOMEM;
164                 goto done;
165         }
166
167         for (count = 0; count < tmp_num_shares; count++) {
168                 werr = smbconf_get_share(ctx, tmp_services,
169                                          tmp_share_names[count],
170                                          &tmp_services[count]);
171                 if (!W_ERROR_IS_OK(werr)) {
172                         goto done;
173                 }
174         }
175
176         werr = WERR_OK;
177
178         *num_shares = tmp_num_shares;
179         if (tmp_num_shares > 0) {
180                 *services = talloc_move(mem_ctx, &tmp_services);
181         } else {
182                 *services = NULL;
183         }
184
185 done:
186         TALLOC_FREE(tmp_ctx);
187         return werr;
188 }
189
190 /**
191  * get the list of share names defined in the configuration.
192  */
193 WERROR smbconf_get_share_names(struct smbconf_ctx *ctx,
194                                TALLOC_CTX *mem_ctx,
195                                uint32_t *num_shares,
196                                char ***share_names)
197 {
198         return ctx->ops->get_share_names(ctx, mem_ctx, num_shares,
199                                          share_names);
200 }
201
202 /**
203  * check if a share/service of a given name exists
204  */
205 bool smbconf_share_exists(struct smbconf_ctx *ctx,
206                           const char *servicename)
207 {
208         return ctx->ops->share_exists(ctx, servicename);
209 }
210
211 /**
212  * Add a service if it does not already exist.
213  */
214 WERROR smbconf_create_share(struct smbconf_ctx *ctx,
215                             const char *servicename)
216 {
217         if ((servicename != NULL) && smbconf_share_exists(ctx, servicename)) {
218                 return WERR_FILE_EXISTS;
219         }
220
221         return ctx->ops->create_share(ctx, servicename);
222 }
223
224 /**
225  * get a definition of a share (service) from configuration.
226  */
227 WERROR smbconf_get_share(struct smbconf_ctx *ctx,
228                          TALLOC_CTX *mem_ctx,
229                          const char *servicename,
230                          struct smbconf_service **service)
231 {
232         if (!smbconf_share_exists(ctx, servicename)) {
233                 return WERR_NO_SUCH_SERVICE;
234         }
235
236         return ctx->ops->get_share(ctx, mem_ctx, servicename, service);
237 }
238
239 /**
240  * delete a service from configuration
241  */
242 WERROR smbconf_delete_share(struct smbconf_ctx *ctx, const char *servicename)
243 {
244         if (!smbconf_share_exists(ctx, servicename)) {
245                 return WERR_NO_SUCH_SERVICE;
246         }
247
248         return ctx->ops->delete_share(ctx, servicename);
249 }
250
251 /**
252  * set a configuration parameter to the value provided.
253  */
254 WERROR smbconf_set_parameter(struct smbconf_ctx *ctx,
255                              const char *service,
256                              const char *param,
257                              const char *valstr)
258 {
259         if (!smbconf_share_exists(ctx, service)) {
260                 return WERR_NO_SUCH_SERVICE;
261         }
262
263         return ctx->ops->set_parameter(ctx, service, param, valstr);
264 }
265
266 /**
267  * Set a global parameter
268  * (i.e. a parameter in the [global] service).
269  *
270  * This also creates [global] when it does not exist.
271  */
272 WERROR smbconf_set_global_parameter(struct smbconf_ctx *ctx,
273                                     const char *param, const char *val)
274 {
275         WERROR werr;
276
277         werr = smbconf_global_check(ctx);
278         if (W_ERROR_IS_OK(werr)) {
279                 werr = smbconf_set_parameter(ctx, GLOBAL_NAME, param, val);
280         }
281
282         return werr;
283 }
284
285 /**
286  * get the value of a configuration parameter as a string
287  */
288 WERROR smbconf_get_parameter(struct smbconf_ctx *ctx,
289                              TALLOC_CTX *mem_ctx,
290                              const char *service,
291                              const char *param,
292                              char **valstr)
293 {
294         if (valstr == NULL) {
295                 return WERR_INVALID_PARAM;
296         }
297
298         if (!smbconf_share_exists(ctx, service)) {
299                 return WERR_NO_SUCH_SERVICE;
300         }
301
302         return ctx->ops->get_parameter(ctx, mem_ctx, service, param, valstr);
303 }
304
305 /**
306  * Get the value of a global parameter.
307  *
308  * Create [global] if it does not exist.
309  */
310 WERROR smbconf_get_global_parameter(struct smbconf_ctx *ctx,
311                                     TALLOC_CTX *mem_ctx,
312                                     const char *param,
313                                     char **valstr)
314 {
315         WERROR werr;
316
317         werr = smbconf_global_check(ctx);
318         if (W_ERROR_IS_OK(werr)) {
319                 werr = smbconf_get_parameter(ctx, mem_ctx, GLOBAL_NAME, param,
320                                              valstr);
321         }
322
323         return werr;
324 }
325
326 /**
327  * delete a parameter from configuration
328  */
329 WERROR smbconf_delete_parameter(struct smbconf_ctx *ctx,
330                                 const char *service, const char *param)
331 {
332         if (!smbconf_share_exists(ctx, service)) {
333                 return WERR_NO_SUCH_SERVICE;
334         }
335
336         return ctx->ops->delete_parameter(ctx, service, param);
337 }
338
339 /**
340  * Delete a global parameter.
341  *
342  * Create [global] if it does not exist.
343  */
344 WERROR smbconf_delete_global_parameter(struct smbconf_ctx *ctx,
345                                        const char *param)
346 {
347         WERROR werr;
348
349         werr = smbconf_global_check(ctx);
350         if (W_ERROR_IS_OK(werr)) {
351                 werr = smbconf_delete_parameter(ctx, GLOBAL_NAME, param);
352         }
353
354         return werr;
355 }
356
357 WERROR smbconf_get_includes(struct smbconf_ctx *ctx,
358                             TALLOC_CTX *mem_ctx,
359                             const char *service,
360                             uint32_t *num_includes, char ***includes)
361 {
362         if (!smbconf_share_exists(ctx, service)) {
363                 return WERR_NO_SUCH_SERVICE;
364         }
365
366         return ctx->ops->get_includes(ctx, mem_ctx, service, num_includes,
367                                       includes);
368 }
369
370 WERROR smbconf_get_global_includes(struct smbconf_ctx *ctx,
371                                    TALLOC_CTX *mem_ctx,
372                                    uint32_t *num_includes, char ***includes)
373 {
374         WERROR werr;
375
376         werr = smbconf_global_check(ctx);
377         if (W_ERROR_IS_OK(werr)) {
378                 werr = smbconf_get_includes(ctx, mem_ctx, GLOBAL_NAME,
379                                             num_includes, includes);
380         }
381
382         return werr;
383 }
384
385 WERROR smbconf_set_includes(struct smbconf_ctx *ctx,
386                             const char *service,
387                             uint32_t num_includes, const char **includes)
388 {
389         if (!smbconf_share_exists(ctx, service)) {
390                 return WERR_NO_SUCH_SERVICE;
391         }
392
393         return ctx->ops->set_includes(ctx, service, num_includes, includes);
394 }
395
396 WERROR smbconf_set_global_includes(struct smbconf_ctx *ctx,
397                                    uint32_t num_includes,
398                                    const char **includes)
399 {
400         WERROR werr;
401
402         werr = smbconf_global_check(ctx);
403         if (W_ERROR_IS_OK(werr)) {
404                 werr = smbconf_set_includes(ctx, GLOBAL_NAME,
405                                             num_includes, includes);
406         }
407
408         return werr;
409 }
410
411
412 WERROR smbconf_delete_includes(struct smbconf_ctx *ctx, const char *service)
413 {
414         if (!smbconf_share_exists(ctx, service)) {
415                 return WERR_NO_SUCH_SERVICE;
416         }
417
418         return ctx->ops->delete_includes(ctx, service);
419 }
420
421 WERROR smbconf_delete_global_includes(struct smbconf_ctx *ctx)
422 {
423         WERROR werr;
424
425         werr = smbconf_global_check(ctx);
426         if (W_ERROR_IS_OK(werr)) {
427                 werr = smbconf_delete_includes(ctx, GLOBAL_NAME);
428         }
429
430         return werr;
431 }