uci_history -> uci_delta
[project/uci.git] / history.c
diff --git a/history.c b/history.c
deleted file mode 100644 (file)
index 649ead1..0000000
--- a/history.c
+++ /dev/null
@@ -1,483 +0,0 @@
-/*
- * libuci - Library for the Unified Configuration Interface
- * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 2.1
- * as published by the Free Software Foundation
- *
- * 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.
- */
-
-/*
- * This file contains the code for handling uci config history files
- */
-
-#define _GNU_SOURCE
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <sys/file.h>
-#include <stdbool.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <stdio.h>
-#include <ctype.h>
-
-/* record a change that was done to a package */
-void
-uci_add_history(struct uci_context *ctx, struct uci_list *list, int cmd, const char *section, const char *option, const char *value)
-{
-       struct uci_history *h;
-       int size = strlen(section) + 1;
-       char *ptr;
-
-       if (value)
-               size += strlen(value) + 1;
-
-       h = uci_alloc_element(ctx, history, option, size);
-       ptr = uci_dataptr(h);
-       h->cmd = cmd;
-       h->section = strcpy(ptr, section);
-       if (value) {
-               ptr += strlen(ptr) + 1;
-               h->value = strcpy(ptr, value);
-       }
-       uci_list_add(list, &h->e.list);
-}
-
-void
-uci_free_history(struct uci_history *h)
-{
-       if (!h)
-               return;
-       if ((h->section != NULL) &&
-               (h->section != uci_dataptr(h))) {
-               free(h->section);
-               free(h->value);
-       }
-       uci_free_element(&h->e);
-}
-
-
-int uci_set_savedir(struct uci_context *ctx, const char *dir)
-{
-       char *sdir;
-
-       UCI_HANDLE_ERR(ctx);
-       UCI_ASSERT(ctx, dir != NULL);
-
-       sdir = uci_strdup(ctx, dir);
-       if (ctx->savedir != uci_savedir)
-               free(ctx->savedir);
-       ctx->savedir = sdir;
-       return 0;
-}
-
-int uci_add_history_path(struct uci_context *ctx, const char *dir)
-{
-       struct uci_element *e;
-
-       UCI_HANDLE_ERR(ctx);
-       UCI_ASSERT(ctx, dir != NULL);
-       e = uci_alloc_generic(ctx, UCI_TYPE_PATH, dir, sizeof(struct uci_element));
-       uci_list_add(&ctx->history_path, &e->list);
-
-       return 0;
-}
-
-static inline int uci_parse_history_tuple(struct uci_context *ctx, char **buf, struct uci_ptr *ptr)
-{
-       int c = UCI_CMD_CHANGE;
-
-       switch(**buf) {
-       case '^':
-               c = UCI_CMD_REORDER;
-               break;
-       case '-':
-               c = UCI_CMD_REMOVE;
-               break;
-       case '@':
-               c = UCI_CMD_RENAME;
-               break;
-       case '+':
-               /* UCI_CMD_ADD is used for anonymous sections or list values */
-               c = UCI_CMD_ADD;
-               break;
-       case '|':
-               c = UCI_CMD_LIST_ADD;
-               break;
-       }
-
-       if (c != UCI_CMD_CHANGE)
-               *buf += 1;
-
-       UCI_INTERNAL(uci_parse_ptr, ctx, ptr, *buf);
-
-       if (!ptr->section)
-               goto error;
-       if (ptr->flags & UCI_LOOKUP_EXTENDED)
-               goto error;
-
-       switch(c) {
-       case UCI_CMD_REORDER:
-               if (!ptr->value || ptr->option)
-                       goto error;
-               break;
-       case UCI_CMD_RENAME:
-               if (!ptr->value || !uci_validate_name(ptr->value))
-                       goto error;
-               break;
-       case UCI_CMD_LIST_ADD:
-               if (!ptr->option)
-                       goto error;
-       }
-
-       return c;
-
-error:
-       UCI_THROW(ctx, UCI_ERR_INVAL);
-       return 0;
-}
-
-static void uci_parse_history_line(struct uci_context *ctx, struct uci_package *p, char *buf)
-{
-       struct uci_element *e = NULL;
-       struct uci_ptr ptr;
-       int cmd;
-
-       cmd = uci_parse_history_tuple(ctx, &buf, &ptr);
-       if (strcmp(ptr.package, p->e.name) != 0)
-               goto error;
-
-       if (ctx->flags & UCI_FLAG_SAVED_HISTORY)
-               uci_add_history(ctx, &p->saved_history, cmd, ptr.section, ptr.option, ptr.value);
-
-       switch(cmd) {
-       case UCI_CMD_REORDER:
-               expand_ptr(ctx, &ptr, true);
-               if (!ptr.s)
-                       UCI_THROW(ctx, UCI_ERR_NOTFOUND);
-               UCI_INTERNAL(uci_reorder_section, ctx, ptr.s, strtoul(ptr.value, NULL, 10));
-               break;
-       case UCI_CMD_RENAME:
-               UCI_INTERNAL(uci_rename, ctx, &ptr);
-               break;
-       case UCI_CMD_REMOVE:
-               UCI_INTERNAL(uci_delete, ctx, &ptr);
-               break;
-       case UCI_CMD_LIST_ADD:
-               UCI_INTERNAL(uci_add_list, ctx, &ptr);
-               break;
-       case UCI_CMD_ADD:
-       case UCI_CMD_CHANGE:
-               UCI_INTERNAL(uci_set, ctx, &ptr);
-               e = ptr.last;
-               if (!ptr.option && e && (cmd == UCI_CMD_ADD))
-                       uci_to_section(e)->anonymous = true;
-               break;
-       }
-       return;
-error:
-       UCI_THROW(ctx, UCI_ERR_PARSE);
-}
-
-/* returns the number of changes that were successfully parsed */
-static int uci_parse_history(struct uci_context *ctx, FILE *stream, struct uci_package *p)
-{
-       struct uci_parse_context *pctx;
-       int changes = 0;
-
-       /* make sure no memory from previous parse attempts is leaked */
-       uci_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);
-               changes++;
-error:
-               continue;
-       }
-
-       /* no error happened, we can get rid of the parser context now */
-       uci_cleanup(ctx);
-       return changes;
-}
-
-/* returns the number of changes that were successfully parsed */
-static int uci_load_history_file(struct uci_context *ctx, struct uci_package *p, char *filename, FILE **f, bool flush)
-{
-       FILE *stream = NULL;
-       int changes = 0;
-
-       UCI_TRAP_SAVE(ctx, done);
-       stream = uci_open_stream(ctx, filename, SEEK_SET, flush, false);
-       if (p)
-               changes = uci_parse_history(ctx, stream, p);
-       UCI_TRAP_RESTORE(ctx);
-done:
-       if (f)
-               *f = stream;
-       else if (stream)
-               uci_close_stream(stream);
-       return changes;
-}
-
-/* returns the number of changes that were successfully parsed */
-__private int uci_load_history(struct uci_context *ctx, struct uci_package *p, bool flush)
-{
-       struct uci_element *e;
-       char *filename = NULL;
-       FILE *f = NULL;
-       int changes = 0;
-
-       if (!p->has_history)
-               return 0;
-
-       uci_foreach_element(&ctx->history_path, e) {
-               if ((asprintf(&filename, "%s/%s", e->name, p->e.name) < 0) || !filename)
-                       UCI_THROW(ctx, UCI_ERR_MEM);
-
-               uci_load_history_file(ctx, p, filename, NULL, false);
-               free(filename);
-       }
-
-       if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
-               UCI_THROW(ctx, UCI_ERR_MEM);
-
-       changes = uci_load_history_file(ctx, p, filename, &f, flush);
-       if (flush && f && (changes > 0)) {
-               rewind(f);
-               if (ftruncate(fileno(f), 0) < 0) {
-                       uci_close_stream(f);
-                       UCI_THROW(ctx, UCI_ERR_IO);
-               }
-       }
-       if (filename)
-               free(filename);
-       uci_close_stream(f);
-       ctx->err = 0;
-       return changes;
-}
-
-static void uci_filter_history(struct uci_context *ctx, const char *name, const char *section, const char *option)
-{
-       struct uci_parse_context *pctx;
-       struct uci_element *e, *tmp;
-       struct uci_list list;
-       char *filename = NULL;
-       struct uci_ptr ptr;
-       FILE *f = NULL;
-
-       uci_list_init(&list);
-       uci_alloc_parse_context(ctx);
-       pctx = ctx->pctx;
-
-       if ((asprintf(&filename, "%s/%s", ctx->savedir, name) < 0) || !filename)
-               UCI_THROW(ctx, UCI_ERR_MEM);
-
-       UCI_TRAP_SAVE(ctx, done);
-       f = uci_open_stream(ctx, filename, SEEK_SET, true, false);
-       pctx->file = f;
-       while (!feof(f)) {
-               struct uci_element *e;
-               char *buf;
-
-               uci_getln(ctx, 0);
-               buf = pctx->buf;
-               if (!buf[0])
-                       continue;
-
-               /* NB: need to allocate the element before the call to 
-                * uci_parse_history_tuple, otherwise the original string 
-                * gets modified before it is saved */
-               e = uci_alloc_generic(ctx, UCI_TYPE_HISTORY, pctx->buf, sizeof(struct uci_element));
-               uci_list_add(&list, &e->list);
-
-               uci_parse_history_tuple(ctx, &buf, &ptr);
-               if (section) {
-                       if (!ptr.section || (strcmp(section, ptr.section) != 0))
-                               continue;
-               }
-               if (option) {
-                       if (!ptr.option || (strcmp(option, ptr.option) != 0))
-                               continue;
-               }
-               /* match, drop this element again */
-               uci_free_element(e);
-       }
-
-       /* rebuild the history file */
-       rewind(f);
-       if (ftruncate(fileno(f), 0) < 0)
-               UCI_THROW(ctx, UCI_ERR_IO);
-       uci_foreach_element_safe(&list, tmp, e) {
-               fprintf(f, "%s\n", e->name);
-               uci_free_element(e);
-       }
-       UCI_TRAP_RESTORE(ctx);
-
-done:
-       if (filename)
-               free(filename);
-       uci_close_stream(pctx->file);
-       uci_foreach_element_safe(&list, tmp, e) {
-               uci_free_element(e);
-       }
-       uci_cleanup(ctx);
-}
-
-int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr)
-{
-       char *package = NULL;
-       char *section = NULL;
-       char *option = NULL;
-
-       UCI_HANDLE_ERR(ctx);
-       expand_ptr(ctx, ptr, false);
-       UCI_ASSERT(ctx, ptr->p->has_history);
-
-       /* 
-        * - flush unwritten changes
-        * - save the package name
-        * - unload the package
-        * - filter the history
-        * - reload the package
-        */
-       UCI_TRAP_SAVE(ctx, error);
-       UCI_INTERNAL(uci_save, ctx, ptr->p);
-
-       /* NB: need to clone package, section and option names, 
-        * as they may get freed on uci_free_package() */
-       package = uci_strdup(ctx, ptr->p->e.name);
-       if (ptr->section)
-               section = uci_strdup(ctx, ptr->section);
-       if (ptr->option)
-               option = uci_strdup(ctx, ptr->option);
-
-       uci_free_package(&ptr->p);
-       uci_filter_history(ctx, package, section, option);
-
-       UCI_INTERNAL(uci_load, ctx, package, &ptr->p);
-       UCI_TRAP_RESTORE(ctx);
-       ctx->err = 0;
-
-error:
-       if (package)
-               free(package);
-       if (section)
-               free(section);
-       if (option)
-               free(option);
-       if (ctx->err)
-               UCI_THROW(ctx, ctx->err);
-       return 0;
-}
-
-int uci_save(struct uci_context *ctx, struct uci_package *p)
-{
-       FILE *f = NULL;
-       char *filename = NULL;
-       struct uci_element *e, *tmp;
-       struct stat statbuf;
-
-       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->has_history)
-               return uci_commit(ctx, &p, false);
-
-       if (uci_list_empty(&p->history))
-               return 0;
-
-       if (stat(ctx->savedir, &statbuf) < 0)
-               mkdir(ctx->savedir, UCI_DIRMODE);
-       else if ((statbuf.st_mode & S_IFMT) != S_IFDIR)
-               UCI_THROW(ctx, UCI_ERR_IO);
-
-       if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
-               UCI_THROW(ctx, UCI_ERR_MEM);
-
-       uci_foreach_element(&ctx->hooks, tmp) {
-               struct uci_hook *hook = uci_to_hook(tmp);
-
-               if (!hook->ops->set)
-                       continue;
-
-               uci_foreach_element(&p->history, e) {
-                       hook->ops->set(hook->ops, p, uci_to_history(e));
-               }
-       }
-
-       ctx->err = 0;
-       UCI_TRAP_SAVE(ctx, done);
-       f = uci_open_stream(ctx, filename, SEEK_END, true, true);
-       UCI_TRAP_RESTORE(ctx);
-
-       uci_foreach_element_safe(&p->history, tmp, e) {
-               struct uci_history *h = uci_to_history(e);
-               char *prefix = "";
-
-               switch(h->cmd) {
-               case UCI_CMD_REMOVE:
-                       prefix = "-";
-                       break;
-               case UCI_CMD_RENAME:
-                       prefix = "@";
-                       break;
-               case UCI_CMD_ADD:
-                       prefix = "+";
-                       break;
-               case UCI_CMD_REORDER:
-                       prefix = "^";
-                       break;
-               case UCI_CMD_LIST_ADD:
-                       prefix = "|";
-                       break;
-               default:
-                       break;
-               }
-
-               fprintf(f, "%s%s.%s", prefix, 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:
-       uci_close_stream(f);
-       if (filename)
-               free(filename);
-       if (ctx->err)
-               UCI_THROW(ctx, ctx->err);
-
-       return 0;
-}
-
-