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"
32 uint32_t current_share
;
40 struct txt_private_data
{
41 struct txt_cache
*cache
;
46 /**********************************************************************
50 **********************************************************************/
53 * a convenience helper to cast the private data structure
55 static struct txt_private_data
*pd(struct smbconf_ctx
*ctx
)
57 return (struct txt_private_data
*)(ctx
->data
);
60 static bool smbconf_txt_do_section(const char *section
, void *private_data
)
64 struct txt_private_data
*tpd
= (struct txt_private_data
*)private_data
;
65 struct txt_cache
*cache
= tpd
->cache
;
67 if (smbconf_find_in_array(section
, cache
->share_names
,
68 cache
->num_shares
, &idx
))
70 cache
->current_share
= idx
;
74 werr
= smbconf_add_string_to_array(cache
, &(cache
->share_names
),
75 cache
->num_shares
, section
);
76 if (!W_ERROR_IS_OK(werr
)) {
79 cache
->current_share
= cache
->num_shares
;
82 cache
->param_names
= TALLOC_REALLOC_ARRAY(cache
,
86 if (cache
->param_names
== NULL
) {
89 cache
->param_names
[cache
->current_share
] = NULL
;
91 cache
->param_values
= TALLOC_REALLOC_ARRAY(cache
,
95 if (cache
->param_values
== NULL
) {
98 cache
->param_values
[cache
->current_share
] = NULL
;
100 cache
->num_params
= TALLOC_REALLOC_ARRAY(cache
,
104 if (cache
->num_params
== NULL
) {
107 cache
->num_params
[cache
->current_share
] = 0;
112 static bool smbconf_txt_do_parameter(const char *param_name
,
113 const char *param_value
,
117 char **param_names
, **param_values
;
120 struct txt_private_data
*tpd
= (struct txt_private_data
*)private_data
;
121 struct txt_cache
*cache
= tpd
->cache
;
123 if (cache
->num_shares
== 0) {
125 * not in any share yet,
126 * initialize the "empty" section (NULL):
127 * parameters without a previous [section] are stored here.
129 if (!smbconf_txt_do_section(NULL
, private_data
)) {
134 param_names
= cache
->param_names
[cache
->current_share
];
135 param_values
= cache
->param_values
[cache
->current_share
];
136 num_params
= cache
->num_params
[cache
->current_share
];
138 if (!(tpd
->verbatim
) &&
139 smbconf_find_in_array(param_name
, param_names
, num_params
, &idx
))
141 TALLOC_FREE(param_values
[idx
]);
142 param_values
[idx
] = talloc_strdup(cache
, param_value
);
143 if (param_values
[idx
] == NULL
) {
148 werr
= smbconf_add_string_to_array(cache
,
149 &(cache
->param_names
[cache
->current_share
]),
150 num_params
, param_name
);
151 if (!W_ERROR_IS_OK(werr
)) {
154 werr
= smbconf_add_string_to_array(cache
,
155 &(cache
->param_values
[cache
->current_share
]),
156 num_params
, param_value
);
157 cache
->num_params
[cache
->current_share
]++;
158 return W_ERROR_IS_OK(werr
);
161 static void smbconf_txt_flush_cache(struct smbconf_ctx
*ctx
)
163 TALLOC_FREE(pd(ctx
)->cache
);
166 static WERROR
smbconf_txt_init_cache(struct smbconf_ctx
*ctx
)
168 if (pd(ctx
)->cache
!= NULL
) {
169 smbconf_txt_flush_cache(ctx
);
172 pd(ctx
)->cache
= TALLOC_ZERO_P(pd(ctx
), struct txt_cache
);
174 if (pd(ctx
)->cache
== NULL
) {
181 static WERROR
smbconf_txt_load_file(struct smbconf_ctx
*ctx
)
186 if (!file_exist(ctx
->path
, NULL
)) {
190 new_csn
= (uint64_t)file_modtime(ctx
->path
);
191 if (new_csn
== pd(ctx
)->csn
) {
195 werr
= smbconf_txt_init_cache(ctx
);
196 if (!W_ERROR_IS_OK(werr
)) {
200 if (!pm_process(ctx
->path
, smbconf_txt_do_section
,
201 smbconf_txt_do_parameter
, pd(ctx
)))
203 return WERR_CAN_NOT_COMPLETE
;
206 pd(ctx
)->csn
= new_csn
;
212 /**********************************************************************
214 * smbconf operations: text backend implementations
216 **********************************************************************/
219 * initialize the text based smbconf backend
221 static WERROR
smbconf_txt_init(struct smbconf_ctx
*ctx
, const char *path
)
224 path
= get_dyn_CONFIGFILE();
226 ctx
->path
= talloc_strdup(ctx
, path
);
227 if (ctx
->path
== NULL
) {
231 ctx
->data
= TALLOC_ZERO_P(ctx
, struct txt_private_data
);
232 if (ctx
->data
== NULL
) {
236 pd(ctx
)->verbatim
= true;
241 static int smbconf_txt_shutdown(struct smbconf_ctx
*ctx
)
243 return ctx
->ops
->close_conf(ctx
);
246 static WERROR
smbconf_txt_open(struct smbconf_ctx
*ctx
)
248 return smbconf_txt_load_file(ctx
);
251 static int smbconf_txt_close(struct smbconf_ctx
*ctx
)
253 smbconf_txt_flush_cache(ctx
);
258 * Get the change sequence number of the given service/parameter.
259 * service and parameter strings may be NULL.
261 static void smbconf_txt_get_csn(struct smbconf_ctx
*ctx
,
262 struct smbconf_csn
*csn
,
263 const char *service
, const char *param
)
269 csn
->csn
= (uint64_t)file_modtime(ctx
->path
);
273 * Drop the whole configuration (restarting empty)
275 static WERROR
smbconf_txt_drop(struct smbconf_ctx
*ctx
)
277 return WERR_NOT_SUPPORTED
;
281 * get the list of share names defined in the configuration.
283 static WERROR
smbconf_txt_get_share_names(struct smbconf_ctx
*ctx
,
285 uint32_t *num_shares
,
289 uint32_t added_count
= 0;
290 TALLOC_CTX
*tmp_ctx
= NULL
;
291 WERROR werr
= WERR_OK
;
292 char **tmp_share_names
= NULL
;
294 if ((num_shares
== NULL
) || (share_names
== NULL
)) {
295 werr
= WERR_INVALID_PARAM
;
299 werr
= smbconf_txt_load_file(ctx
);
300 if (!W_ERROR_IS_OK(werr
)) {
304 tmp_ctx
= talloc_stackframe();
305 if (tmp_ctx
== NULL
) {
310 /* make sure "global" is always listed first,
311 * possibly after NULL section */
313 if (smbconf_share_exists(ctx
, NULL
)) {
314 werr
= smbconf_add_string_to_array(tmp_ctx
, &tmp_share_names
,
316 if (!W_ERROR_IS_OK(werr
)) {
322 if (smbconf_share_exists(ctx
, GLOBAL_NAME
)) {
323 werr
= smbconf_add_string_to_array(tmp_ctx
, &tmp_share_names
,
324 added_count
, GLOBAL_NAME
);
325 if (!W_ERROR_IS_OK(werr
)) {
331 for (count
= 0; count
< pd(ctx
)->cache
->num_shares
; count
++) {
332 if (strequal(pd(ctx
)->cache
->share_names
[count
], GLOBAL_NAME
) ||
333 (pd(ctx
)->cache
->share_names
[count
] == NULL
))
338 werr
= smbconf_add_string_to_array(tmp_ctx
, &tmp_share_names
,
340 pd(ctx
)->cache
->share_names
[count
]);
341 if (!W_ERROR_IS_OK(werr
)) {
347 *num_shares
= added_count
;
348 if (added_count
> 0) {
349 *share_names
= talloc_move(mem_ctx
, &tmp_share_names
);
355 TALLOC_FREE(tmp_ctx
);
360 * check if a share/service of a given name exists
362 static bool smbconf_txt_share_exists(struct smbconf_ctx
*ctx
,
363 const char *servicename
)
367 werr
= smbconf_txt_load_file(ctx
);
368 if (!W_ERROR_IS_OK(werr
)) {
372 return smbconf_find_in_array(servicename
,
373 pd(ctx
)->cache
->share_names
,
374 pd(ctx
)->cache
->num_shares
, NULL
);
378 * Add a service if it does not already exist
380 static WERROR
smbconf_txt_create_share(struct smbconf_ctx
*ctx
,
381 const char *servicename
)
383 return WERR_NOT_SUPPORTED
;
387 * get a definition of a share (service) from configuration.
389 static WERROR
smbconf_txt_get_share(struct smbconf_ctx
*ctx
,
391 const char *servicename
,
392 struct smbconf_service
**service
)
395 uint32_t sidx
, count
;
397 TALLOC_CTX
*tmp_ctx
= NULL
;
398 struct smbconf_service
*tmp_service
= NULL
;
400 werr
= smbconf_txt_load_file(ctx
);
401 if (!W_ERROR_IS_OK(werr
)) {
405 found
= smbconf_find_in_array(servicename
,
406 pd(ctx
)->cache
->share_names
,
407 pd(ctx
)->cache
->num_shares
,
410 return WERR_NO_SUCH_SERVICE
;
413 tmp_ctx
= talloc_stackframe();
414 if (tmp_ctx
== NULL
) {
419 tmp_service
= TALLOC_ZERO_P(tmp_ctx
, struct smbconf_service
);
420 if (tmp_service
== NULL
) {
425 if (servicename
!= NULL
) {
426 tmp_service
->name
= talloc_strdup(tmp_service
, servicename
);
427 if (tmp_service
->name
== NULL
) {
433 for (count
= 0; count
< pd(ctx
)->cache
->num_params
[sidx
]; count
++) {
434 werr
= smbconf_add_string_to_array(tmp_service
,
435 &(tmp_service
->param_names
),
437 pd(ctx
)->cache
->param_names
[sidx
][count
]);
438 if (!W_ERROR_IS_OK(werr
)) {
441 werr
= smbconf_add_string_to_array(tmp_service
,
442 &(tmp_service
->param_values
),
444 pd(ctx
)->cache
->param_values
[sidx
][count
]);
445 if (!W_ERROR_IS_OK(werr
)) {
450 tmp_service
->num_params
= count
;
452 *service
= talloc_move(mem_ctx
, &tmp_service
);
458 TALLOC_FREE(tmp_ctx
);
463 * delete a service from configuration
465 static WERROR
smbconf_txt_delete_share(struct smbconf_ctx
*ctx
,
466 const char *servicename
)
468 return WERR_NOT_SUPPORTED
;
472 * set a configuration parameter to the value provided.
474 static WERROR
smbconf_txt_set_parameter(struct smbconf_ctx
*ctx
,
479 return WERR_NOT_SUPPORTED
;
483 * get the value of a configuration parameter as a string
485 static WERROR
smbconf_txt_get_parameter(struct smbconf_ctx
*ctx
,
493 uint32_t share_index
, param_index
;
495 werr
= smbconf_txt_load_file(ctx
);
496 if (!W_ERROR_IS_OK(werr
)) {
500 found
= smbconf_find_in_array(service
,
501 pd(ctx
)->cache
->share_names
,
502 pd(ctx
)->cache
->num_shares
,
505 return WERR_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 WERR_INVALID_PARAM
;
516 *valstr
= talloc_strdup(mem_ctx
,
517 pd(ctx
)->cache
->param_values
[share_index
][param_index
]);
519 if (*valstr
== NULL
) {
527 * delete a parameter from configuration
529 static WERROR
smbconf_txt_delete_parameter(struct smbconf_ctx
*ctx
,
533 return WERR_NOT_SUPPORTED
;
536 static WERROR
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 werr
= smbconf_txt_load_file(ctx
);
550 if (!W_ERROR_IS_OK(werr
)) {
554 found
= smbconf_find_in_array(service
,
555 pd(ctx
)->cache
->share_names
,
556 pd(ctx
)->cache
->num_shares
,
559 return WERR_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 werr
= smbconf_add_string_to_array(tmp_ctx
,
571 pd(ctx
)->cache
->param_values
[sidx
][count
]);
572 if (!W_ERROR_IS_OK(werr
)) {
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 WERROR
smbconf_txt_set_includes(struct smbconf_ctx
*ctx
,
599 uint32_t num_includes
,
600 const char **includes
)
602 return WERR_NOT_SUPPORTED
;
605 static WERROR
smbconf_txt_delete_includes(struct smbconf_ctx
*ctx
,
608 return WERR_NOT_SUPPORTED
;
612 static struct smbconf_ops smbconf_ops_txt
= {
613 .init
= smbconf_txt_init
,
614 .shutdown
= smbconf_txt_shutdown
,
615 .open_conf
= smbconf_txt_open
,
616 .close_conf
= smbconf_txt_close
,
617 .get_csn
= smbconf_txt_get_csn
,
618 .drop
= smbconf_txt_drop
,
619 .get_share_names
= smbconf_txt_get_share_names
,
620 .share_exists
= smbconf_txt_share_exists
,
621 .create_share
= smbconf_txt_create_share
,
622 .get_share
= smbconf_txt_get_share
,
623 .delete_share
= smbconf_txt_delete_share
,
624 .set_parameter
= smbconf_txt_set_parameter
,
625 .get_parameter
= smbconf_txt_get_parameter
,
626 .delete_parameter
= smbconf_txt_delete_parameter
,
627 .get_includes
= smbconf_txt_get_includes
,
628 .set_includes
= smbconf_txt_set_includes
,
629 .delete_includes
= smbconf_txt_delete_includes
,
634 * initialize the smbconf text backend
635 * the only function that is exported from this module
637 WERROR
smbconf_init_txt(TALLOC_CTX
*mem_ctx
,
638 struct smbconf_ctx
**conf_ctx
,
643 werr
= smbconf_init_internal(mem_ctx
, conf_ctx
, path
, &smbconf_ops_txt
);
644 if (!W_ERROR_IS_OK(werr
)) {
648 return smbconf_txt_load_file(*conf_ctx
);