summaryrefslogtreecommitdiff
path: root/source3/lib/smbconf/smbconf_txt_simple.c
blob: 0f1388ce30a00ff429742d6d13933f0c81f11d3a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
/*
 *  Unix SMB/CIFS implementation.
 *  libsmbconf - Samba configuration library, simple text backend
 *  Copyright (C) Michael Adam 2008
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

/*
 * This is a sample implementation of a libsmbconf text backend
 * using the params.c parser.
 *
 * It is read only.
 * Don't expect brilliant performance, since it is not hashing the lists.
 */

#include "includes.h"
#include "smbconf_private.h"

struct txt_cache {
	uint32_t current_share;
	uint32_t num_shares;
	char **share_names;
	uint32_t *num_params;
	char ***param_names;
	char ***param_values;
};

struct txt_private_data {
	struct txt_cache *cache;
	uint64_t csn;
};

/**********************************************************************
 *
 * helper functions
 *
 **********************************************************************/

/**
 * a convenience helper to cast the private data structure
 */
static struct txt_private_data *pd(struct smbconf_ctx *ctx)
{
	return (struct txt_private_data *)(ctx->data);
}

static bool smbconf_txt_find_in_array(const char *string, char **list,
				      uint32_t num_entries, uint32_t *entry)
{
	uint32_t i;

	if ((string == NULL) || (list == NULL)) {
		return false;
	}

	for (i = 0; i < num_entries; i++) {
		if (strequal(string, list[i])) {
			if (entry != NULL) {
				*entry = i;
			}
			return true;
		}
	}

	return false;
}

static bool smbconf_txt_do_section(const char *section, void *private_data)
{
	WERROR werr;
	uint32_t idx;
	struct txt_private_data *data = (struct txt_private_data *)private_data;

	if (smbconf_txt_find_in_array(section, data->cache.share_names,
				      data->cache.num_shares, &idx))
	{
		data->cache.current_share = idx;
		return true;
	}

	werr = smbconf_add_string_to_array(data, &(data->cache.share_names),
					   data->cache.num_shares, section);
	if (!W_ERROR_IS_OK(werr)) {
		return false;
	}
	data->cache.current_share = data->cache.num_shares;
	data->cache.num_shares++;

	data->cache.param_names = TALLOC_REALLOC_ARRAY(data,
						       data->cache.param_names,
						       char **,
						       data->cache.num_shares);
	if (data->cache.param_names == NULL) {
		return false;
	}
	data->cache.param_names[data->cache.current_share] = NULL;

	data->cache.param_values = TALLOC_REALLOC_ARRAY(data,
						data->cache.param_values,
						char **,
						data->cache.num_shares);
	if (data->cache.param_values == NULL) {
		return false;
	}
	data->cache.param_values[data->cache.current_share] = NULL;

	data->cache.num_params = TALLOC_REALLOC_ARRAY(data,
						      data->cache.num_params,
						      uint32_t,
						      data->cache.num_shares);
	if (data->cache.num_params == NULL) {
		return false;
	}
	data->cache.num_params[data->cache.current_share] = 0;

	return true;
}

static bool smbconf_txt_do_parameter(const char *param_name,
				     const char *param_value,
				     void *private_data)
{
	WERROR werr;
	char **param_names, **param_values;
	uint32_t num_params;
	uint32_t idx;
	struct txt_private_data *data = (struct txt_private_data *)private_data;

	if (data->cache.num_shares == 0) {
		/* not in any share ... */
		return false;
	}

	param_names  = data->cache.param_names[data->cache.current_share];
	param_values = data->cache.param_values[data->cache.current_share];
	num_params   = data->cache.num_params[data->cache.current_share];

	if (smbconf_txt_find_in_array(param_name, param_names, num_params,
				      &idx))
	{
		TALLOC_FREE(param_values[idx]);
		param_values[idx] = talloc_strdup(data, param_value);
		if (param_values[idx] == NULL) {
			return false;
		}
		return true;
	}
	werr = smbconf_add_string_to_array(data,
			&(data->cache.param_names[data->cache.current_share]),
			num_params, param_name);
	if (!W_ERROR_IS_OK(werr)) {
		return false;
	}
	werr = smbconf_add_string_to_array(data,
			&(data->cache.param_values[data->cache.current_share]),
			num_params, param_value);
	data->cache.num_params[data->cache.current_share]++;
	return W_ERROR_IS_OK(werr);
}

static void smbconf_txt_flush_cache(struct smbconf_ctx *ctx)
{
	TALLOC_FREE(pd(ctx)->cache);
}

static WERROR smbconf_txt_init_cache(struct smbconf_ctx *ctx)
{
	if (pd(ctx)->cache != NULL) {
		smbconf_txt_flush_cache(ctx);
	}

	pd(ctx)->cache = TALLOC_ZERO_P(pd(ctx), struct txt_cache);

	if (pd(ctx)->cache == NULL) {
		return WERR_NOMEM;
	}

	return WERR_OK;
}

static WERROR smbconf_txt_load_file(struct smbconf_ctx *ctx)
{
	WERROR werr;
	uint64_t new_csn = (uint64_t)file_modtime(ctx->path);

	if (new_csn == pd(ctx)->csn) {
		return WERR_OK;
	}

	werr = smbconf_txt_init_cache(ctx);
	if (!W_ERROR_IS_OK(werr)) {
		return werr;
	}

	if (!pm_process(ctx->path, smbconf_txt_do_section,
		 	smbconf_txt_do_parameter, pd(ctx)))
	{
		return WERR_CAN_NOT_COMPLETE;
	}

	pd(ctx)->csn = new_csn;

	return WERR_OK;
}


/**********************************************************************
 *
 * smbconf operations: simple text implementations
 *
 **********************************************************************/

/**
 * initialize the text based smbconf backend
 */
static WERROR smbconf_txt_init(struct smbconf_ctx *ctx, const char *path)
{
	if (path == NULL) {
		path = get_dyn_CONFIGFILE();
	}
	ctx->path = talloc_strdup(ctx, path);
	if (ctx->path == NULL) {
		return WERR_NOMEM;
	}

	ctx->data = TALLOC_ZERO_P(ctx, struct txt_private_data);

	return smbconf_txt_load_file(ctx);
}

static int smbconf_txt_shutdown(struct smbconf_ctx *ctx)
{
	return ctx->ops->close_conf(ctx);
}

static WERROR smbconf_txt_open(struct smbconf_ctx *ctx)
{
	return smbconf_txt_load_file(ctx);
}

static int smbconf_txt_close(struct smbconf_ctx *ctx)
{
	smbconf_txt_flush_cache(ctx);
	return 0;
}

/**
 * Get the change sequence number of the given service/parameter.
 * service and parameter strings may be NULL.
 */
static void smbconf_txt_get_csn(struct smbconf_ctx *ctx,
				struct smbconf_csn *csn,
				const char *service, const char *param)
{
	if (csn == NULL) {
		return;
	}

	csn->csn = (uint64_t)file_modtime(ctx->path);
}

/**
 * Drop the whole configuration (restarting empty)
 */
static WERROR smbconf_txt_drop(struct smbconf_ctx *ctx)
{
	return WERR_NOT_SUPPORTED;
}

/**
 * get the list of share names defined in the configuration.
 */
static WERROR smbconf_txt_get_share_names(struct smbconf_ctx *ctx,
					  TALLOC_CTX *mem_ctx,
					  uint32_t *num_shares,
					  char ***share_names)
{
	uint32_t count;
	uint32_t added_count = 0;
	TALLOC_CTX *tmp_ctx = NULL;
	WERROR werr = WERR_OK;
	char **tmp_share_names = NULL;

	if ((num_shares == NULL) || (share_names == NULL)) {
		werr = WERR_INVALID_PARAM;
		goto done;
	}

	werr = smbconf_txt_load_file(ctx);
	if (!W_ERROR_IS_OK(werr)) {
		return werr;
	}

	tmp_ctx = talloc_stackframe();
	if (tmp_ctx == NULL) {
		werr = WERR_NOMEM;
		goto done;
	}

	/* make sure "global" is always listed first */
	if (smbconf_share_exists(ctx, GLOBAL_NAME)) {
		werr = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
						   0, GLOBAL_NAME);
		if (!W_ERROR_IS_OK(werr)) {
			goto done;
		}
		added_count++;
	}

	for (count = 0; count < pd(ctx)->cache->num_shares; count++) {
		if (strequal(pd(ctx)->cache->share_names[count], GLOBAL_NAME)) {
			continue;
		}

		werr = smbconf_add_string_to_array(tmp_ctx, &tmp_share_names,
					added_count,
					pd(ctx)->cache->share_names[count]);
		if (!W_ERROR_IS_OK(werr)) {
			goto done;
		}
		added_count++;
	}

	*num_shares = added_count;
	if (added_count > 0) {
		*share_names = talloc_move(mem_ctx, &tmp_share_names);
	} else {
		*share_names = NULL;
	}

done:
	TALLOC_FREE(tmp_ctx);
	return werr;
}

/**
 * check if a share/service of a given name exists
 */
static bool smbconf_txt_share_exists(struct smbconf_ctx *ctx,
				     const char *servicename)
{
	WERROR werr;

	werr = smbconf_txt_load_file(ctx);
	if (!W_ERROR_IS_OK(werr)) {
		return false;
	}

	return smbconf_txt_find_in_array(servicename,
					 pd(ctx)->cache->share_names,
					 pd(ctx)->cache->num_shares, NULL);
}

/**
 * Add a service if it does not already exist
 */
static WERROR smbconf_txt_create_share(struct smbconf_ctx *ctx,
				       const char *servicename)
{
	return WERR_NOT_SUPPORTED;
}

/**
 * get a definition of a share (service) from configuration.
 */
static WERROR smbconf_txt_get_share(struct smbconf_ctx *ctx,
				    TALLOC_CTX *mem_ctx,
				    const char *servicename,
				    uint32_t *num_params,
				    char ***param_names, char ***param_values)
{
	WERROR werr;
	uint32_t sidx, count;
	bool found;
	TALLOC_CTX *tmp_ctx = NULL;
	char **tmp_param_names = NULL;
	char **tmp_param_values = NULL;

	werr = smbconf_txt_load_file(ctx);
	if (!W_ERROR_IS_OK(werr)) {
		return werr;
	}

	found = smbconf_txt_find_in_array(servicename,
					  pd(ctx)->cache->share_names,
					  pd(ctx)->cache->num_shares,
					  &sidx);
	if (!found) {
		return WERR_NO_SUCH_SERVICE;
	}

	tmp_ctx = talloc_stackframe();
	if (tmp_ctx == NULL) {
		werr = WERR_NOMEM;
		goto done;
	}

	for (count = 0; count < pd(ctx)->cache->num_params[sidx]; count++) {
		werr = smbconf_add_string_to_array(tmp_ctx,
				&tmp_param_names,
				count,
				pd(ctx)->cache->param_names[sidx][count]);
		if (!W_ERROR_IS_OK(werr)) {
			goto done;
		}
		werr = smbconf_add_string_to_array(tmp_ctx,
				&tmp_param_values,
				count,
				pd(ctx)->cache->param_values[sidx][count]);
		if (!W_ERROR_IS_OK(werr)) {
			goto done;
		}
	}

	*num_params = count;
	if (count > 0) {
		*param_names = talloc_move(mem_ctx, &tmp_param_names);
		*param_values = talloc_move(mem_ctx, &tmp_param_values);
	} else {
		*param_names = NULL;
		*param_values = NULL;
	}

done:
	TALLOC_FREE(tmp_ctx);
	return werr;
}

/**
 * delete a service from configuration
 */
static WERROR smbconf_txt_delete_share(struct smbconf_ctx *ctx,
				       const char *servicename)
{
	return WERR_NOT_SUPPORTED;
}

/**
 * set a configuration parameter to the value provided.
 */
static WERROR smbconf_txt_set_parameter(struct smbconf_ctx *ctx,
					const char *service,
					const char *param,
					const char *valstr)
{
	return WERR_NOT_SUPPORTED;
}

/**
 * get the value of a configuration parameter as a string
 */
static WERROR smbconf_txt_get_parameter(struct smbconf_ctx *ctx,
					TALLOC_CTX *mem_ctx,
					const char *service,
					const char *param,
					char **valstr)
{
	WERROR werr;
	bool found;
	uint32_t share_index, param_index;

	werr = smbconf_txt_load_file(ctx);
	if (!W_ERROR_IS_OK(werr)) {
		return werr;
	}

	found = smbconf_txt_find_in_array(service,
					  pd(ctx)->cache->share_names,
					  pd(ctx)->cache->num_shares,
					  &share_index);
	if (!found) {
		return WERR_NO_SUCH_SERVICE;
	}

	found = smbconf_txt_find_in_array(param,
				pd(ctx)->cache->param_names[share_index],
				pd(ctx)->cache->num_params[share_index],
				&param_index);
	if (!found) {
		return WERR_INVALID_PARAM;
	}

	*valstr = talloc_strdup(mem_ctx,
			pd(ctx)->cache->param_values[share_index][param_index]);

	if (*valstr == NULL) {
		return WERR_NOMEM;
	}

	return WERR_OK;
}

/**
 * delete a parameter from configuration
 */
static WERROR smbconf_txt_delete_parameter(struct smbconf_ctx *ctx,
					   const char *service,
					   const char *param)
{
	return WERR_NOT_SUPPORTED;
}

static struct smbconf_ops smbconf_ops_txt = {
	.init			= smbconf_txt_init,
	.shutdown		= smbconf_txt_shutdown,
	.open_conf		= smbconf_txt_open,
	.close_conf		= smbconf_txt_close,
	.get_csn		= smbconf_txt_get_csn,
	.drop			= smbconf_txt_drop,
	.get_share_names	= smbconf_txt_get_share_names,
	.share_exists		= smbconf_txt_share_exists,
	.create_share		= smbconf_txt_create_share,
	.get_share		= smbconf_txt_get_share,
	.delete_share		= smbconf_txt_delete_share,
	.set_parameter		= smbconf_txt_set_parameter,
	.get_parameter		= smbconf_txt_get_parameter,
	.delete_parameter	= smbconf_txt_delete_parameter
};


/**
 * initialize the smbconf text backend
 * the only function that is exported from this module
 */
WERROR smbconf_init_txt_simple(TALLOC_CTX *mem_ctx,
			       struct smbconf_ctx **conf_ctx,
			       const char *path)
{
	return smbconf_init(mem_ctx, conf_ctx, path, &smbconf_ops_txt);
}