X-Git-Url: https://git.archive.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=file.c;h=662c97f5b003024fde65f12bea538fdb14e401f2;hp=9a2e353fe92e77a65893d3536e6c52eab623ca14;hb=bdb2bbfbe937312463763bd5ce35a7f857238081;hpb=d2c85b2804aaa22e539e266b5ed4cf958d6ceb35 diff --git a/file.c b/file.c index 9a2e353..662c97f 100644 --- a/file.c +++ b/file.c @@ -93,12 +93,10 @@ static void uci_file_cleanup(struct uci_context *ctx) ctx->pctx = NULL; if (pctx->package) - uci_free_package(pctx->package); + uci_free_package(&pctx->package); if (pctx->buf) free(pctx->buf); - if (pctx->file) - fclose(pctx->file); free(pctx); } @@ -238,7 +236,7 @@ done: /* * extract the next argument from the command line */ -static char *next_arg(struct uci_context *ctx, char **str, bool required) +static char *next_arg(struct uci_context *ctx, char **str, bool required, bool name) { char *val; char *ptr; @@ -246,9 +244,16 @@ static char *next_arg(struct uci_context *ctx, char **str, bool required) val = ptr = *str; skip_whitespace(ctx, str); parse_str(ctx, str, &ptr); - if (required && !*val) - uci_parse_error(ctx, *str, "insufficient arguments"); + if (!*val) { + if (required) + uci_parse_error(ctx, *str, "insufficient arguments"); + goto done; + } + + if (name && !uci_validate_name(val)) + uci_parse_error(ctx, val, "invalid character in field"); +done: return val; } @@ -260,7 +265,7 @@ static void assert_eol(struct uci_context *ctx, char **str) { char *tmp; - tmp = next_arg(ctx, str, false); + tmp = next_arg(ctx, str, false, false); if (tmp && *tmp) uci_parse_error(ctx, *str, "too many arguments"); } @@ -309,7 +314,7 @@ static void uci_parse_package(struct uci_context *ctx, char **str, bool single) /* command string null-terminated by strtok */ *str += strlen(*str) + 1; - name = next_arg(ctx, str, true); + name = next_arg(ctx, str, true, true); assert_eol(ctx, str); if (single) return; @@ -318,14 +323,61 @@ static void uci_parse_package(struct uci_context *ctx, char **str, bool single) uci_switch_config(ctx); } +/* Based on an efficient hash function published by D. J. Bernstein */ +static unsigned int djbhash(unsigned int hash, char *str) +{ + int len = strlen(str); + int i; + + /* initial value */ + if (hash == ~0) + hash = 5381; + + for(i = 0; i < len; i++) { + hash = ((hash << 5) + hash) + str[i]; + } + return (hash & 0x7FFFFFFF); +} + +/* fix up an unnamed section */ +static void uci_fixup_section(struct uci_context *ctx, struct uci_section *s) +{ + unsigned int hash = ~0; + struct uci_element *e; + char buf[16]; + + if (!s || s->e.name) + return; + + /* + * Generate a name for unnamed sections. This is used as reference + * when locating or updating the section from apps/scripts. + * To make multiple concurrent versions somewhat safe for updating, + * the name is generated from a hash of its type and name/value + * pairs of its option, and it is prefixed by a counter value. + * If the order of the unnamed sections changes for some reason, + * updates to them will be rejected. + */ + hash = djbhash(hash, s->type); + uci_foreach_element(&s->options, e) { + hash = djbhash(hash, e->name); + hash = djbhash(hash, uci_to_option(e)->value); + } + sprintf(buf, "cfg%02x%04x", ++s->package->n_section, hash % (1 << 16)); + s->e.name = uci_strdup(ctx, buf); +} + /* * parse the 'config' uci command (open a section) */ static void uci_parse_config(struct uci_context *ctx, char **str) { + struct uci_parse_context *pctx = ctx->pctx; + struct uci_section *s; char *name = NULL; char *type = NULL; + uci_fixup_section(ctx, ctx->pctx->section); if (!ctx->pctx->package) { if (!ctx->pctx->name) uci_parse_error(ctx, *str, "attempting to import a file without a package name"); @@ -336,10 +388,14 @@ static void uci_parse_config(struct uci_context *ctx, char **str) /* command string null-terminated by strtok */ *str += strlen(*str) + 1; - type = next_arg(ctx, str, true); - name = next_arg(ctx, str, false); + type = next_arg(ctx, str, true, true); + name = next_arg(ctx, str, false, true); assert_eol(ctx, str); - ctx->pctx->section = uci_alloc_section(ctx->pctx->package, type, name); + + if (pctx->merge) + UCI_INTERNAL(uci_set, ctx, pctx->package, name, NULL, type); + else + pctx->section = uci_alloc_section(pctx->package, type, name); } /* @@ -347,19 +403,24 @@ static void uci_parse_config(struct uci_context *ctx, char **str) */ static void uci_parse_option(struct uci_context *ctx, char **str) { + struct uci_parse_context *pctx = ctx->pctx; char *name = NULL; char *value = NULL; - if (!ctx->pctx->section) + if (!pctx->section) uci_parse_error(ctx, *str, "option command found before the first section"); /* command string null-terminated by strtok */ *str += strlen(*str) + 1; - name = next_arg(ctx, str, true); - value = next_arg(ctx, str, true); + name = next_arg(ctx, str, true, true); + value = next_arg(ctx, str, true, false); assert_eol(ctx, str); - uci_alloc_option(ctx->pctx->section, name, value); + + if (pctx->merge) + UCI_INTERNAL(uci_set, ctx, pctx->package, pctx->section->e.name, name, value); + else + uci_alloc_option(pctx->section, name, value); } @@ -453,7 +514,9 @@ static void uci_export_package(struct uci_package *p, FILE *stream, bool header) uci_foreach_element(&p->sections, s) { struct uci_section *sec = uci_to_section(s); fprintf(stream, "\nconfig '%s'", uci_escape(ctx, sec->type)); - fprintf(stream, " '%s'\n", uci_escape(ctx, sec->e.name)); + if (!sec->anonymous) + fprintf(stream, " '%s'", uci_escape(ctx, sec->e.name)); + fprintf(stream, "\n"); uci_foreach_element(&sec->options, o) { struct uci_option *opt = uci_to_option(o); fprintf(stream, "\toption '%s'", uci_escape(ctx, opt->e.name)); @@ -470,21 +533,21 @@ int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *packag UCI_HANDLE_ERR(ctx); UCI_ASSERT(ctx, stream != NULL); - if (package) { + if (package) uci_export_package(package, stream, header); - goto done; + else { + uci_foreach_element(&ctx->root, e) { + uci_export_package(uci_to_package(e), stream, header); + } } - uci_foreach_element(&ctx->root, e) { - uci_export_package(uci_to_package(e), stream, header); - } -done: return 0; } int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single) { struct uci_parse_context *pctx; + UCI_HANDLE_ERR(ctx); /* make sure no memory from previous parse attempts is leaked */ uci_file_cleanup(ctx); @@ -492,6 +555,10 @@ int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct u pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context)); ctx->pctx = pctx; pctx->file = stream; + if (*package && single) { + pctx->package = *package; + pctx->merge = true; + } /* * If 'name' was supplied, assume that the supplied stream does not contain @@ -503,10 +570,20 @@ int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct u while (!feof(pctx->file)) { uci_getln(ctx, 0); + UCI_TRAP_SAVE(ctx, error); if (pctx->buf[0]) uci_parse_line(ctx, single); + UCI_TRAP_RESTORE(ctx); + continue; +error: + if (ctx->flags & UCI_FLAG_PERROR) + uci_perror(ctx, NULL); + if ((ctx->errno != UCI_ERR_PARSE) || + (ctx->flags & UCI_FLAG_STRICT)) + UCI_THROW(ctx, ctx->errno); } + uci_fixup_section(ctx, ctx->pctx->section); if (package) *package = pctx->package; @@ -519,103 +596,318 @@ int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct u return 0; } -int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package) +/* + * open a stream and go to the right position + * + * note: when opening for write and seeking to the beginning of + * the stream, truncate the file + */ +static FILE *uci_open_stream(struct uci_context *ctx, const char *filename, int pos, bool write, bool create) { struct stat statbuf; + FILE *file = NULL; + int fd, ret; + int mode = (write ? O_RDWR : O_RDONLY); + + if (create) + mode |= O_CREAT; + + if (!write && ((stat(filename, &statbuf) < 0) || + ((statbuf.st_mode & S_IFMT) != S_IFREG))) { + UCI_THROW(ctx, UCI_ERR_NOTFOUND); + } + + fd = open(filename, mode, UCI_FILEMODE); + if (fd <= 0) + goto error; + + if (flock(fd, (write ? LOCK_EX : LOCK_SH)) < 0) + goto error; + + ret = lseek(fd, 0, pos); + + if (ret < 0) + goto error; + + file = fdopen(fd, (write ? "w+" : "r")); + if (file) + goto done; + +error: + UCI_THROW(ctx, UCI_ERR_IO); +done: + return file; +} + +static void uci_close_stream(FILE *stream) +{ + int fd; + + if (!stream) + return; + + fd = fileno(stream); + flock(fd, LOCK_UN); + fclose(stream); +} + +static void uci_parse_history_line(struct uci_context *ctx, struct uci_package *p, char *buf) +{ + bool delete = false; + bool rename = false; + char *package = NULL; + char *section = NULL; + char *option = NULL; + char *value = NULL; + + if (buf[0] == '-') { + delete = true; + buf++; + } else if (buf[0] == '@') { + rename = true; + buf++; + } + + UCI_INTERNAL(uci_parse_tuple, ctx, buf, &package, §ion, &option, &value); + if (!package || !section || (!delete && !value)) + goto error; + if (strcmp(package, p->e.name) != 0) + goto error; + if (!uci_validate_name(section)) + goto error; + if (option && !uci_validate_name(option)) + goto error; + + if (rename) + UCI_INTERNAL(uci_rename, ctx, p, section, option, value); + else if (delete) + UCI_INTERNAL(uci_delete, ctx, p, section, option); + else + UCI_INTERNAL(uci_set, ctx, p, section, option, value); + + return; +error: + UCI_THROW(ctx, UCI_ERR_PARSE); +} + +static void uci_parse_history(struct uci_context *ctx, FILE *stream, struct uci_package *p) +{ + struct uci_parse_context *pctx; + + /* make sure no memory from previous parse attempts is leaked */ + uci_file_cleanup(ctx); + + pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context)); + ctx->pctx = pctx; + pctx->file = stream; + + while (!feof(pctx->file)) { + uci_getln(ctx, 0); + if (!pctx->buf[0]) + continue; + + /* + * ignore parse errors in single lines, we want to preserve as much + * history as possible + */ + UCI_TRAP_SAVE(ctx, error); + uci_parse_history_line(ctx, p, pctx->buf); + UCI_TRAP_RESTORE(ctx); +error: + continue; + } + + /* no error happened, we can get rid of the parser context now */ + uci_file_cleanup(ctx); +} + +static void uci_load_history(struct uci_context *ctx, struct uci_package *p, bool flush) +{ + char *filename = NULL; + FILE *f = NULL; + + if (!p->confdir) + return; + if ((asprintf(&filename, "%s/%s", UCI_SAVEDIR, p->e.name) < 0) || !filename) + UCI_THROW(ctx, UCI_ERR_MEM); + + UCI_TRAP_SAVE(ctx, done); + f = uci_open_stream(ctx, filename, SEEK_SET, flush, false); + uci_parse_history(ctx, f, p); + UCI_TRAP_RESTORE(ctx); + +done: + if (flush && f) { + rewind(f); + ftruncate(fileno(f), 0); + } + if (filename) + free(filename); + uci_close_stream(f); + ctx->errno = 0; +} + + +int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package) +{ char *filename; bool confdir; - FILE *file; - int fd; + FILE *file = NULL; UCI_HANDLE_ERR(ctx); UCI_ASSERT(ctx, name != NULL); switch (name[0]) { case '.': + /* relative path outside of /etc/config */ if (name[1] != '/') UCI_THROW(ctx, UCI_ERR_NOTFOUND); /* fall through */ case '/': - /* absolute/relative path outside of /etc/config */ + /* absolute path outside of /etc/config */ filename = uci_strdup(ctx, name); name = strrchr(name, '/') + 1; confdir = false; break; default: + /* config in /etc/config */ + if (strchr(name, '/')) + UCI_THROW(ctx, UCI_ERR_INVAL); filename = uci_malloc(ctx, strlen(name) + sizeof(UCI_CONFDIR) + 2); sprintf(filename, UCI_CONFDIR "/%s", name); confdir = true; break; } - if ((stat(filename, &statbuf) < 0) || - ((statbuf.st_mode & S_IFMT) != S_IFREG)) { - UCI_THROW(ctx, UCI_ERR_NOTFOUND); + file = uci_open_stream(ctx, filename, SEEK_SET, false, false); + ctx->errno = 0; + UCI_TRAP_SAVE(ctx, done); + UCI_INTERNAL(uci_import, ctx, file, name, package, true); + UCI_TRAP_RESTORE(ctx); + + if (*package) { + (*package)->path = filename; + (*package)->confdir = confdir; + uci_load_history(ctx, *package, false); } - fd = open(filename, O_RDONLY); - if (fd <= 0) - UCI_THROW(ctx, UCI_ERR_IO); +done: + uci_close_stream(file); + return ctx->errno; +} + +int uci_save(struct uci_context *ctx, struct uci_package *p) +{ + FILE *f = NULL; + char *filename = NULL; + struct uci_element *e, *tmp; + + UCI_HANDLE_ERR(ctx); + UCI_ASSERT(ctx, p != NULL); + + /* + * if the config file was outside of the /etc/config path, + * don't save the history to a file, update the real file + * directly. + * does not modify the uci_package pointer + */ + if (!p->confdir) + return uci_commit(ctx, &p); - if (flock(fd, LOCK_SH) < 0) - UCI_THROW(ctx, UCI_ERR_IO); + if (uci_list_empty(&p->history)) + return 0; - file = fdopen(fd, "r"); - if (!file) - UCI_THROW(ctx, UCI_ERR_IO); + if ((asprintf(&filename, "%s/%s", UCI_SAVEDIR, p->e.name) < 0) || !filename) + UCI_THROW(ctx, UCI_ERR_MEM); ctx->errno = 0; UCI_TRAP_SAVE(ctx, done); - uci_import(ctx, file, name, package, true); + f = uci_open_stream(ctx, filename, SEEK_END, true, true); UCI_TRAP_RESTORE(ctx); - if (*package) { - (*package)->path = filename; - (*package)->confdir = confdir; + uci_foreach_element_safe(&p->history, tmp, e) { + struct uci_history *h = uci_to_history(e); + + if (h->cmd == UCI_CMD_REMOVE) + fprintf(f, "-"); + else if (h->cmd == UCI_CMD_RENAME) + fprintf(f, "@"); + + fprintf(f, "%s.%s", p->e.name, h->section); + if (e->name) + fprintf(f, ".%s", e->name); + + if (h->cmd == UCI_CMD_REMOVE) + fprintf(f, "\n"); + else + fprintf(f, "=%s\n", h->value); + uci_free_history(h); } done: - flock(fd, LOCK_UN); - fclose(file); - return ctx->errno; + uci_close_stream(f); + if (filename) + free(filename); + if (ctx->errno) + UCI_THROW(ctx, ctx->errno); + + return 0; } -int uci_commit(struct uci_context *ctx, struct uci_package *p) +int uci_commit(struct uci_context *ctx, struct uci_package **package) { + struct uci_package *p; FILE *f = NULL; - int fd = 0; - int err = UCI_ERR_IO; + char *name = NULL; + char *path = NULL; UCI_HANDLE_ERR(ctx); + UCI_ASSERT(ctx, package != NULL); + p = *package; + UCI_ASSERT(ctx, p != NULL); UCI_ASSERT(ctx, p->path != NULL); - fd = open(p->path, O_RDWR); - if (fd < 0) - goto done; + /* open the config file for writing now, so that it is locked */ + f = uci_open_stream(ctx, p->path, SEEK_SET, true, true); - if (flock(fd, LOCK_EX) < 0) - goto done; + /* flush unsaved changes and reload from history file */ + UCI_TRAP_SAVE(ctx, done); + if (p->confdir) { + name = uci_strdup(ctx, p->e.name); + path = uci_strdup(ctx, p->path); + if (!uci_list_empty(&p->history)) + UCI_INTERNAL(uci_save, ctx, p); + uci_free_package(&p); + uci_file_cleanup(ctx); + UCI_INTERNAL(uci_import, ctx, f, name, &p, true); + + p->path = path; + p->confdir = true; + *package = p; + + /* freed together with the uci_package */ + path = NULL; + + /* check for updated history, just in case */ + uci_load_history(ctx, p, true); + } - ftruncate(fd, 0); - f = fdopen(fd, "w"); - if (!f) - goto done; + rewind(f); + ftruncate(fileno(f), 0); - UCI_TRAP_SAVE(ctx, done); uci_export(ctx, f, p, false); UCI_TRAP_RESTORE(ctx); done: - if (f) - fclose(f); - else if (fd > 0) - close(fd); - + if (name) + free(name); + if (path) + free(path); + uci_close_stream(f); if (ctx->errno) UCI_THROW(ctx, ctx->errno); - if (err) - UCI_THROW(ctx, UCI_ERR_IO); + return 0; } @@ -637,15 +929,17 @@ static inline char *get_filename(char *path) return p; } -char **uci_list_configs(struct uci_context *ctx) +int uci_list_configs(struct uci_context *ctx, char ***list) { char **configs; glob_t globbuf; int size, i; char *buf; + UCI_HANDLE_ERR(ctx); + if (glob(UCI_CONFDIR "/*", GLOB_MARK, NULL, &globbuf) != 0) - return NULL; + UCI_THROW(ctx, UCI_ERR_NOTFOUND); size = sizeof(char *) * (globbuf.gl_pathc + 1); for(i = 0; i < globbuf.gl_pathc; i++) { @@ -658,11 +952,7 @@ char **uci_list_configs(struct uci_context *ctx) size += strlen(p) + 1; } - configs = malloc(size); - if (!configs) - return NULL; - - memset(configs, 0, size); + configs = uci_malloc(ctx, size); buf = (char *) &configs[globbuf.gl_pathc + 1]; for(i = 0; i < globbuf.gl_pathc; i++) { char *p; @@ -675,7 +965,8 @@ char **uci_list_configs(struct uci_context *ctx) strcpy(buf, p); buf += strlen(buf) + 1; } - return configs; -} + *list = configs; + return 0; +}