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 wrappers to standard functions, which
17 * throw exceptions upon failure.
19 #include <sys/types.h>
28 #define LINEBUF_MAX 4096
30 static void *uci_malloc(struct uci_context
*ctx
, size_t size
)
36 UCI_THROW(ctx
, UCI_ERR_MEM
);
42 static 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 static char *uci_strdup(struct uci_context
*ctx
, const char *str
)
57 UCI_THROW(ctx
, UCI_ERR_MEM
);
63 * validate strings for names and types, reject special characters
64 * for names, only alphanum and _ is allowed (shell compatibility)
65 * for types, we allow more characters
67 static bool uci_validate_str(const char *str
, bool name
)
74 if (!isalnum(c
) && c
!= '_') {
75 if (name
|| (c
< 33) || (c
> 126))
83 static inline bool uci_validate_name(const char *str
)
85 return uci_validate_str(str
, true);
88 static void uci_alloc_parse_context(struct uci_context
*ctx
)
90 ctx
->pctx
= (struct uci_parse_context
*) uci_malloc(ctx
, sizeof(struct uci_parse_context
));
93 int uci_parse_tuple(struct uci_context
*ctx
, char *str
, char **package
, char **section
, char **option
, char **value
)
98 UCI_ASSERT(ctx
, str
&& package
&& section
&& option
);
100 *package
= strtok(str
, ".");
101 if (!*package
|| !uci_validate_name(*package
))
105 *section
= strtok(NULL
, ".");
110 *option
= strtok(NULL
, ".");
117 last
= strchr(last
, '=');
129 if (*section
&& !uci_validate_name(*section
))
131 if (*option
&& !uci_validate_name(*option
))
137 UCI_THROW(ctx
, UCI_ERR_PARSE
);
144 static void uci_parse_error(struct uci_context
*ctx
, char *pos
, char *reason
)
146 struct uci_parse_context
*pctx
= ctx
->pctx
;
148 pctx
->reason
= reason
;
149 if ((pos
< pctx
->buf
) || (pos
> pctx
->buf
+ pctx
->bufsz
))
152 pctx
->byte
= pos
- pctx
->buf
;
153 UCI_THROW(ctx
, UCI_ERR_PARSE
);
158 * Fetch a new line from the input stream and resize buffer if necessary
160 static void uci_getln(struct uci_context
*ctx
, int offset
)
162 struct uci_parse_context
*pctx
= ctx
->pctx
;
166 if (pctx
->buf
== NULL
) {
167 pctx
->buf
= uci_malloc(ctx
, LINEBUF
);
168 pctx
->bufsz
= LINEBUF
;
176 p
= fgets(p
, pctx
->bufsz
- ofs
, pctx
->file
);
181 if (pctx
->buf
[ofs
- 1] == '\n') {
183 pctx
->buf
[ofs
- 1] = 0;
187 if (pctx
->bufsz
> LINEBUF_MAX
/2)
188 uci_parse_error(ctx
, p
, "line too long");
191 pctx
->buf
= uci_realloc(ctx
, pctx
->buf
, pctx
->bufsz
);
196 * parse a character escaped by '\'
197 * returns true if the escaped character is to be parsed
198 * returns false if the escaped character is to be ignored
200 static inline bool parse_backslash(struct uci_context
*ctx
, char **str
)
205 /* undecoded backslash at the end of line, fetch the next line */
208 uci_getln(ctx
, *str
- ctx
->pctx
->buf
);
212 /* FIXME: decode escaped char, necessary? */
217 * move the string pointer forward until a non-whitespace character or
220 static void skip_whitespace(struct uci_context
*ctx
, char **str
)
223 while (**str
&& isspace(**str
))
227 if (!parse_backslash(ctx
, str
))
232 static inline void addc(char **dest
, char **src
)
240 * parse a double quoted string argument from the command line
242 static void parse_double_quote(struct uci_context
*ctx
, char **str
, char **target
)
246 /* skip quote character */
249 while ((c
= **str
)) {
256 if (!parse_backslash(ctx
, str
))
264 uci_parse_error(ctx
, *str
, "unterminated \"");
268 * parse a single quoted string argument from the command line
270 static void parse_single_quote(struct uci_context
*ctx
, char **str
, char **target
)
273 /* skip quote character */
276 while ((c
= **str
)) {
286 uci_parse_error(ctx
, *str
, "unterminated '");
290 * parse a string from the command line and detect the quoting style
292 static void parse_str(struct uci_context
*ctx
, char **str
, char **target
)
297 parse_single_quote(ctx
, str
, target
);
300 parse_double_quote(ctx
, str
, target
);
308 if (!parse_backslash(ctx
, str
))
315 } while (**str
&& !isspace(**str
));
319 * if the string was unquoted and we've stopped at a whitespace
320 * character, skip to the next one, because the whitespace will
321 * be overwritten by a null byte here
326 /* terminate the parsed string */
331 * extract the next argument from the command line
333 static char *next_arg(struct uci_context
*ctx
, char **str
, bool required
, bool name
)
339 skip_whitespace(ctx
, str
);
340 parse_str(ctx
, str
, &ptr
);
343 uci_parse_error(ctx
, *str
, "insufficient arguments");
347 if (name
&& !uci_validate_name(val
))
348 uci_parse_error(ctx
, val
, "invalid character in field");
354 int uci_parse_argument(struct uci_context
*ctx
, char **str
, char **result
)
357 UCI_ASSERT(ctx
, (str
!= NULL
) && (*str
!= NULL
));
358 UCI_ASSERT(ctx
, result
!= NULL
);
360 *result
= next_arg(ctx
, str
, false, false);
366 * open a stream and go to the right position
368 * note: when opening for write and seeking to the beginning of
369 * the stream, truncate the file
371 static FILE *uci_open_stream(struct uci_context
*ctx
, const char *filename
, int pos
, bool write
, bool create
)
376 int mode
= (write
? O_RDWR
: O_RDONLY
);
381 if (!write
&& ((stat(filename
, &statbuf
) < 0) ||
382 ((statbuf
.st_mode
& S_IFMT
) != S_IFREG
))) {
383 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
386 fd
= open(filename
, mode
, UCI_FILEMODE
);
390 if (flock(fd
, (write
? LOCK_EX
: LOCK_SH
)) < 0)
393 ret
= lseek(fd
, 0, pos
);
398 file
= fdopen(fd
, (write
? "w+" : "r"));
403 UCI_THROW(ctx
, UCI_ERR_IO
);
408 static void uci_close_stream(FILE *stream
)