2 * libuci - Library for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License version 2.1
7 * as published by the Free Software Foundation
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 * This file contains misc utility functions and wrappers to standard
17 * functions, which throw exceptions upon failure.
19 #include <sys/types.h>
28 #define LINEBUF_MAX 4096
30 __plugin void *uci_malloc(struct uci_context *ctx, size_t size)
36 UCI_THROW(ctx, UCI_ERR_MEM);
42 __plugin void *uci_realloc(struct uci_context *ctx, void *ptr, size_t size)
44 ptr = realloc(ptr, size);
46 UCI_THROW(ctx, UCI_ERR_MEM);
51 __plugin char *uci_strdup(struct uci_context *ctx, const char *str)
57 UCI_THROW(ctx, UCI_ERR_MEM);
62 /* Based on an efficient hash function published by D. J. Bernstein */
63 static unsigned int djbhash(unsigned int hash, char *str)
65 int len = strlen(str);
72 for(i = 0; i < len; i++) {
73 hash = ((hash << 5) + hash) + str[i];
75 return (hash & 0x7FFFFFFF);
79 * validate strings for names and types, reject special characters
80 * for names, only alphanum and _ is allowed (shell compatibility)
81 * for types, we allow more characters
83 __plugin bool uci_validate_str(const char *str, bool name)
90 if (!isalnum(c) && c != '_') {
91 if (name || (c < 33) || (c > 126))
99 static inline bool uci_validate_name(const char *str)
101 return uci_validate_str(str, true);
104 static void uci_alloc_parse_context(struct uci_context *ctx)
106 ctx->pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
109 int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value)
114 UCI_ASSERT(ctx, str && package && section && option);
116 last = strchr(str, '=');
122 *package = strsep(&str, ".");
123 if (!*package || !uci_validate_name(*package))
126 *section = strsep(&str, ".");
130 *option = strsep(&str, ".");
144 if (*section && *section[0] && !uci_validate_name(*section))
146 if (*option && !uci_validate_name(*option))
152 UCI_THROW(ctx, UCI_ERR_PARSE);
159 static void uci_parse_error(struct uci_context *ctx, char *pos, char *reason)
161 struct uci_parse_context *pctx = ctx->pctx;
163 pctx->reason = reason;
164 pctx->byte = pos - pctx->buf;
165 UCI_THROW(ctx, UCI_ERR_PARSE);
170 * Fetch a new line from the input stream and resize buffer if necessary
172 static void uci_getln(struct uci_context *ctx, int offset)
174 struct uci_parse_context *pctx = ctx->pctx;
178 if (pctx->buf == NULL) {
179 pctx->buf = uci_malloc(ctx, LINEBUF);
180 pctx->bufsz = LINEBUF;
188 p = fgets(p, pctx->bufsz - ofs, pctx->file);
193 if (pctx->buf[ofs - 1] == '\n') {
195 pctx->buf[ofs - 1] = 0;
199 if (pctx->bufsz > LINEBUF_MAX/2)
200 uci_parse_error(ctx, p, "line too long");
203 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
208 * parse a character escaped by '\'
209 * returns true if the escaped character is to be parsed
210 * returns false if the escaped character is to be ignored
212 static inline bool parse_backslash(struct uci_context *ctx, char **str)
217 /* undecoded backslash at the end of line, fetch the next line */
220 uci_getln(ctx, *str - ctx->pctx->buf);
224 /* FIXME: decode escaped char, necessary? */
229 * move the string pointer forward until a non-whitespace character or
232 static void skip_whitespace(struct uci_context *ctx, char **str)
235 while (**str && isspace(**str))
239 if (!parse_backslash(ctx, str))
244 static inline void addc(char **dest, char **src)
252 * parse a double quoted string argument from the command line
254 static void parse_double_quote(struct uci_context *ctx, char **str, char **target)
258 /* skip quote character */
261 while ((c = **str)) {
268 if (!parse_backslash(ctx, str))
276 uci_parse_error(ctx, *str, "unterminated \"");
280 * parse a single quoted string argument from the command line
282 static void parse_single_quote(struct uci_context *ctx, char **str, char **target)
285 /* skip quote character */
288 while ((c = **str)) {
298 uci_parse_error(ctx, *str, "unterminated '");
302 * parse a string from the command line and detect the quoting style
304 static void parse_str(struct uci_context *ctx, char **str, char **target)
309 parse_single_quote(ctx, str, target);
312 parse_double_quote(ctx, str, target);
320 if (!parse_backslash(ctx, str))
327 } while (**str && !isspace(**str));
331 * if the string was unquoted and we've stopped at a whitespace
332 * character, skip to the next one, because the whitespace will
333 * be overwritten by a null byte here
338 /* terminate the parsed string */
343 * extract the next argument from the command line
345 static char *next_arg(struct uci_context *ctx, char **str, bool required, bool name)
351 skip_whitespace(ctx, str);
352 parse_str(ctx, str, &ptr);
355 uci_parse_error(ctx, *str, "insufficient arguments");
359 if (name && !uci_validate_name(val))
360 uci_parse_error(ctx, val, "invalid character in field");
366 int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result)
369 UCI_ASSERT(ctx, str != NULL);
370 UCI_ASSERT(ctx, result != NULL);
373 if (ctx->pctx->file != stream) {
377 uci_alloc_parse_context(ctx);
378 ctx->pctx->file = stream;
382 *str = ctx->pctx->buf;
385 *result = next_arg(ctx, str, false, false);
392 * open a stream and go to the right position
394 * note: when opening for write and seeking to the beginning of
395 * the stream, truncate the file
397 static FILE *uci_open_stream(struct uci_context *ctx, const char *filename, int pos, bool write, bool create)
402 int mode = (write ? O_RDWR : O_RDONLY);
407 if (!write && ((stat(filename, &statbuf) < 0) ||
408 ((statbuf.st_mode & S_IFMT) != S_IFREG))) {
409 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
412 fd = open(filename, mode, UCI_FILEMODE);
416 if (flock(fd, (write ? LOCK_EX : LOCK_SH)) < 0)
419 ret = lseek(fd, 0, pos);
424 file = fdopen(fd, (write ? "w+" : "r"));
429 UCI_THROW(ctx, UCI_ERR_IO);
434 static void uci_close_stream(FILE *stream)