2 * Unix SMB/CIFS implementation.
3 * libsmbconf - Samba configuration library, text backend
4 * Copyright (C) Michael Adam 2008
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 * This is a sample implementation of a libsmbconf text backend
22 * using the params.c parser.
25 * Don't expect brilliant performance, since it is not hashing the lists.
29 #include "smbconf_private.h"
30 #include "lib/smbconf/smbconf_txt.h"
33 uint32_t current_share;
41 struct txt_private_data {
42 struct txt_cache *cache;
47 /**********************************************************************
51 **********************************************************************/
54 * a convenience helper to cast the private data structure
56 static struct txt_private_data *pd(struct smbconf_ctx *ctx)
58 return (struct txt_private_data *)(ctx->data);
61 static bool smbconf_txt_do_section(const char *section, void *private_data)
65 struct txt_private_data *tpd = (struct txt_private_data *)private_data;
66 struct txt_cache *cache = tpd->cache;
68 if (smbconf_find_in_array(section, cache->share_names,
69 cache->num_shares, &idx))
71 cache->current_share = idx;
75 err = smbconf_add_string_to_array(cache, &(cache->share_names),
76 cache->num_shares, section);
77 if (!SBC_ERROR_IS_OK(err)) {
80 cache->current_share = cache->num_shares;
83 cache->param_names = talloc_realloc(cache,
87 if (cache->param_names == NULL) {
90 cache->param_names[cache->current_share] = NULL;
92 cache->param_values = talloc_realloc(cache,
96 if (cache->param_values == NULL) {
99 cache->param_values[cache->current_share] = NULL;
101 cache->num_params = talloc_realloc(cache,
105 if (cache->num_params == NULL) {
108 cache->num_params[cache->current_share] = 0;
113 static bool smbconf_txt_do_parameter(const char *param_name,
114 const char *param_value,
118 char **param_names, **param_values;
121 struct txt_private_data *tpd = (struct txt_private_data *)private_data;
122 struct txt_cache *cache = tpd->cache;
124 if (cache->num_shares == 0) {
126 * not in any share yet,
127 * initialize the "empty" section (NULL):
128 * parameters without a previous [section] are stored here.
130 if (!smbconf_txt_do_section(NULL, private_data)) {
135 param_names = cache->param_names[cache->current_share];
136 param_values = cache->param_values[cache->current_share];
137 num_params = cache->num_params[cache->current_share];
139 if (!(tpd->verbatim) &&
140 smbconf_find_in_array(param_name, param_names, num_params, &idx))
142 talloc_free(param_values[idx]);
143 param_values[idx] = talloc_strdup(cache, param_value);
144 if (param_values[idx] == NULL) {
149 err = smbconf_add_string_to_array(cache,
150 &(cache->param_names[cache->current_share]),
151 num_params, param_name);
152 if (!SBC_ERROR_IS_OK(err)) {
155 err = smbconf_add_string_to_array(cache,
156 &(cache->param_values[cache->current_share]),
157 num_params, param_value);
158 cache->num_params[cache->current_share]++;
159 return SBC_ERROR_IS_OK(err);
162 static void smbconf_txt_flush_cache(struct smbconf_ctx *ctx)
164 talloc_free(pd(ctx)->cache);
165 pd(ctx)->cache = NULL;
168 static sbcErr smbconf_txt_init_cache(struct smbconf_ctx *ctx)
170 if (pd(ctx)->cache != NULL) {
171 smbconf_txt_flush_cache(ctx);
174 pd(ctx)->cache = talloc_zero(pd(ctx), struct txt_cache);
176 if (pd(ctx)->cache == NULL) {
177 return SBC_ERR_NOMEM;
183 static sbcErr smbconf_txt_load_file(struct smbconf_ctx *ctx)
188 if (!file_exist(ctx->path)) {
189 return SBC_ERR_BADFILE;
192 new_csn = (uint64_t)file_modtime(ctx->path);
193 if (new_csn == pd(ctx)->csn) {
197 err = smbconf_txt_init_cache(ctx);
198 if (!SBC_ERROR_IS_OK(err)) {
202 if (!pm_process(ctx->path, smbconf_txt_do_section,
203 smbconf_txt_do_parameter, pd(ctx)))
205 return SBC_ERR_CAN_NOT_COMPLETE;
208 pd(ctx)->csn = new_csn;
214 /**********************************************************************
216 * smbconf operations: text backend implementations
218 **********************************************************************/
221 * initialize the text based smbconf backend
223 static sbcErr smbconf_txt_init(struct smbconf_ctx *ctx, const char *path)
226 return SBC_ERR_BADFILE;
228 ctx->path = talloc_strdup(ctx, path);
229 if (ctx->path == NULL) {
230 return SBC_ERR_NOMEM;
233 ctx->data = talloc_zero(ctx, struct txt_private_data);
234 if (ctx->data == NULL) {
235 return SBC_ERR_NOMEM;
238 pd(ctx)->verbatim = true;
243 static int smbconf_txt_shutdown(struct smbconf_ctx *ctx)
245 return ctx->ops->close_conf(ctx);
248 static bool smbconf_txt_requires_messaging(struct smbconf_ctx *ctx)
253 static bool smbconf_txt_is_writeable(struct smbconf_ctx *ctx)
255 /* no write support in this backend yet... */
259 static sbcErr smbconf_txt_open(struct smbconf_ctx *ctx)
261 return smbconf_txt_load_file(ctx);
264 static int smbconf_txt_close(struct smbconf_ctx *ctx)
266 smbconf_txt_flush_cache(ctx);
271 * Get the change sequence number of the given service/parameter.
272 * service and parameter strings may be NULL.
274 static void smbconf_txt_get_csn(struct smbconf_ctx *ctx,
275 struct smbconf_csn *csn,
276 const char *service, const char *param)
282 csn->csn = (uint64_t)file_modtime(ctx->path);
286 * Drop the whole configuration (restarting empty)
288 static sbcErr smbconf_txt_drop(struct smbconf_ctx *ctx)
290 return SBC_ERR_NOT_SUPPORTED;
294 * get the list of share names defined in the configuration.
296 static sbcErr smbconf_txt_get_share_names(struct smbconf_ctx *ctx,
298 uint32_t *num_shares,
302 uint32_t added_count = 0;
303 TALLOC_CTX *tmp_ctx = NULL;
304 sbcErr err = SBC_ERR_OK;
305 char **tmp_share_names = NULL;
307 if ((num_shares == NULL) || (share_names == NULL)) {
308 return SBC_ERR_INVALID_PARAM;
311 err = smbconf_txt_load_file(ctx);
312 if (!SBC_ERROR_IS_OK(err)) {
316 tmp_ctx = talloc_stackframe();
318 /* make sure "global" is always listed first,
319 * possibly after NULL section */
321 if (smbconf_share_exists(ctx, NULL)) {
322 err = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
324 if (!SBC_ERROR_IS_OK(err)) {
330 if (smbconf_share_exists(ctx, GLOBAL_NAME)) {
331 err = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
332 added_count, GLOBAL_NAME);
333 if (!SBC_ERROR_IS_OK(err)) {
339 for (count = 0; count < pd(ctx)->cache->num_shares; count++) {
340 if (strequal(pd(ctx)->cache->share_names[count], GLOBAL_NAME) ||
341 (pd(ctx)->cache->share_names[count] == NULL))
346 err = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
348 pd(ctx)->cache->share_names[count]);
349 if (!SBC_ERROR_IS_OK(err)) {
355 *num_shares = added_count;
356 if (added_count > 0) {
357 *share_names = talloc_move(mem_ctx, &tmp_share_names);
363 talloc_free(tmp_ctx);
368 * check if a share/service of a given name exists
370 static bool smbconf_txt_share_exists(struct smbconf_ctx *ctx,
371 const char *servicename)
375 err = smbconf_txt_load_file(ctx);
376 if (!SBC_ERROR_IS_OK(err)) {
380 return smbconf_find_in_array(servicename,
381 pd(ctx)->cache->share_names,
382 pd(ctx)->cache->num_shares, NULL);
386 * Add a service if it does not already exist
388 static sbcErr smbconf_txt_create_share(struct smbconf_ctx *ctx,
389 const char *servicename)
391 return SBC_ERR_NOT_SUPPORTED;
395 * get a definition of a share (service) from configuration.
397 static sbcErr smbconf_txt_get_share(struct smbconf_ctx *ctx,
399 const char *servicename,
400 struct smbconf_service **service)
403 uint32_t sidx, count;
405 TALLOC_CTX *tmp_ctx = NULL;
406 struct smbconf_service *tmp_service = NULL;
408 err = smbconf_txt_load_file(ctx);
409 if (!SBC_ERROR_IS_OK(err)) {
413 found = smbconf_find_in_array(servicename,
414 pd(ctx)->cache->share_names,
415 pd(ctx)->cache->num_shares,
418 return SBC_ERR_NO_SUCH_SERVICE;
421 tmp_ctx = talloc_stackframe();
423 tmp_service = talloc_zero(tmp_ctx, struct smbconf_service);
424 if (tmp_service == NULL) {
429 if (servicename != NULL) {
430 tmp_service->name = talloc_strdup(tmp_service, servicename);
431 if (tmp_service->name == NULL) {
437 for (count = 0; count < pd(ctx)->cache->num_params[sidx]; count++) {
438 err = smbconf_add_string_to_array(tmp_service,
439 &(tmp_service->param_names),
441 pd(ctx)->cache->param_names[sidx][count]);
442 if (!SBC_ERROR_IS_OK(err)) {
445 err = smbconf_add_string_to_array(tmp_service,
446 &(tmp_service->param_values),
448 pd(ctx)->cache->param_values[sidx][count]);
449 if (!SBC_ERROR_IS_OK(err)) {
454 tmp_service->num_params = count;
455 *service = talloc_move(mem_ctx, &tmp_service);
458 talloc_free(tmp_ctx);
463 * delete a service from configuration
465 static sbcErr smbconf_txt_delete_share(struct smbconf_ctx *ctx,
466 const char *servicename)
468 return SBC_ERR_NOT_SUPPORTED;
472 * set a configuration parameter to the value provided.
474 static sbcErr smbconf_txt_set_parameter(struct smbconf_ctx *ctx,
479 return SBC_ERR_NOT_SUPPORTED;
483 * get the value of a configuration parameter as a string
485 static sbcErr smbconf_txt_get_parameter(struct smbconf_ctx *ctx,
493 uint32_t share_index, param_index;
495 err = smbconf_txt_load_file(ctx);
496 if (!SBC_ERROR_IS_OK(err)) {
500 found = smbconf_find_in_array(service,
501 pd(ctx)->cache->share_names,
502 pd(ctx)->cache->num_shares,
505 return SBC_ERR_NO_SUCH_SERVICE;
508 found = smbconf_reverse_find_in_array(param,
509 pd(ctx)->cache->param_names[share_index],
510 pd(ctx)->cache->num_params[share_index],
513 return SBC_ERR_INVALID_PARAM;
516 *valstr = talloc_strdup(mem_ctx,
517 pd(ctx)->cache->param_values[share_index][param_index]);
519 if (*valstr == NULL) {
520 return SBC_ERR_NOMEM;
527 * delete a parameter from configuration
529 static sbcErr smbconf_txt_delete_parameter(struct smbconf_ctx *ctx,
533 return SBC_ERR_NOT_SUPPORTED;
536 static sbcErr smbconf_txt_get_includes(struct smbconf_ctx *ctx,
539 uint32_t *num_includes,
544 uint32_t sidx, count;
545 TALLOC_CTX *tmp_ctx = NULL;
546 uint32_t tmp_num_includes = 0;
547 char **tmp_includes = NULL;
549 err = smbconf_txt_load_file(ctx);
550 if (!SBC_ERROR_IS_OK(err)) {
554 found = smbconf_find_in_array(service,
555 pd(ctx)->cache->share_names,
556 pd(ctx)->cache->num_shares,
559 return SBC_ERR_NO_SUCH_SERVICE;
562 tmp_ctx = talloc_stackframe();
564 for (count = 0; count < pd(ctx)->cache->num_params[sidx]; count++) {
565 if (strequal(pd(ctx)->cache->param_names[sidx][count],
568 err = smbconf_add_string_to_array(tmp_ctx,
571 pd(ctx)->cache->param_values[sidx][count]);
572 if (!SBC_ERROR_IS_OK(err)) {
579 *num_includes = tmp_num_includes;
580 if (*num_includes > 0) {
581 *includes = talloc_move(mem_ctx, &tmp_includes);
582 if (*includes == NULL) {
593 talloc_free(tmp_ctx);
597 static sbcErr smbconf_txt_set_includes(struct smbconf_ctx *ctx,
599 uint32_t num_includes,
600 const char **includes)
602 return SBC_ERR_NOT_SUPPORTED;
605 static sbcErr smbconf_txt_delete_includes(struct smbconf_ctx *ctx,
608 return SBC_ERR_NOT_SUPPORTED;
611 static sbcErr smbconf_txt_transaction_start(struct smbconf_ctx *ctx)
616 static sbcErr smbconf_txt_transaction_commit(struct smbconf_ctx *ctx)
621 static sbcErr smbconf_txt_transaction_cancel(struct smbconf_ctx *ctx)
626 static struct smbconf_ops smbconf_ops_txt = {
627 .init = smbconf_txt_init,
628 .shutdown = smbconf_txt_shutdown,
629 .requires_messaging = smbconf_txt_requires_messaging,
630 .is_writeable = smbconf_txt_is_writeable,
631 .open_conf = smbconf_txt_open,
632 .close_conf = smbconf_txt_close,
633 .get_csn = smbconf_txt_get_csn,
634 .drop = smbconf_txt_drop,
635 .get_share_names = smbconf_txt_get_share_names,
636 .share_exists = smbconf_txt_share_exists,
637 .create_share = smbconf_txt_create_share,
638 .get_share = smbconf_txt_get_share,
639 .delete_share = smbconf_txt_delete_share,
640 .set_parameter = smbconf_txt_set_parameter,
641 .get_parameter = smbconf_txt_get_parameter,
642 .delete_parameter = smbconf_txt_delete_parameter,
643 .get_includes = smbconf_txt_get_includes,
644 .set_includes = smbconf_txt_set_includes,
645 .delete_includes = smbconf_txt_delete_includes,
646 .transaction_start = smbconf_txt_transaction_start,
647 .transaction_commit = smbconf_txt_transaction_commit,
648 .transaction_cancel = smbconf_txt_transaction_cancel,
653 * initialize the smbconf text backend
654 * the only function that is exported from this module
656 sbcErr smbconf_init_txt(TALLOC_CTX *mem_ctx,
657 struct smbconf_ctx **conf_ctx,
662 err = smbconf_init_internal(mem_ctx, conf_ctx, path, &smbconf_ops_txt);
663 if (!SBC_ERROR_IS_OK(err)) {
667 return smbconf_txt_load_file(*conf_ctx);