libuci.c

   1 /*
   2  * libuci - Library for the Unified Configuration Interface
   3  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   4  *
   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
   8  *
   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.
  13  */
  14
  15 /*
  16  * This file contains some common code for the uci library
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <sys/types.h>
  21 #include <stdbool.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <stdio.h>
  25 #include "uci.h"
  26
  27 static const char *uci_confdir = UCI_CONFDIR;
  28 static const char *uci_savedir = UCI_SAVEDIR;
  29
  30 static const char *uci_errstr[] = {
  31         [UCI_OK] =            "Success",
  32         [UCI_ERR_MEM] =       "Out of memory",
  33         [UCI_ERR_INVAL] =     "Invalid argument",
  34         [UCI_ERR_NOTFOUND] =  "Entry not found",
  35         [UCI_ERR_IO] =        "I/O error",
  36         [UCI_ERR_PARSE] =     "Parse error",
  37         [UCI_ERR_DUPLICATE] = "Duplicate entry",
  38         [UCI_ERR_UNKNOWN] =   "Unknown error",
  39 };
  40
  41 static void uci_cleanup(struct uci_context *ctx);
  42
  43 #include "uci_internal.h"
  44 #include "util.c"
  45 #include "list.c"
  46 #include "history.c"
  47 #include "file.c"
  48
  49 /* exported functions */
  50 struct uci_context *uci_alloc_context(void)
  51 {
  52         struct uci_context *ctx;
  53
  54         ctx = (struct uci_context *) malloc(sizeof(struct uci_context));
  55         memset(ctx, 0, sizeof(struct uci_context));
  56         uci_list_init(&ctx->root);
  57         uci_list_init(&ctx->history_path);
  58         uci_list_init(&ctx->backends);
  59         ctx->flags = UCI_FLAG_STRICT | UCI_FLAG_SAVED_HISTORY;
  60
  61         ctx->confdir = (char *) uci_confdir;
  62         ctx->savedir = (char *) uci_savedir;
  63
  64         uci_list_add(&ctx->backends, &uci_file_backend.e.list);
  65         ctx->backend = &uci_file_backend;
  66
  67         return ctx;
  68 }
  69
  70 void uci_free_context(struct uci_context *ctx)
  71 {
  72         struct uci_element *e, *tmp;
  73
  74         if (ctx->confdir != uci_confdir)
  75                 free(ctx->confdir);
  76         if (ctx->savedir != uci_savedir)
  77                 free(ctx->savedir);
  78
  79         uci_cleanup(ctx);
  80         UCI_TRAP_SAVE(ctx, ignore);
  81         uci_foreach_element_safe(&ctx->root, tmp, e) {
  82                 struct uci_package *p = uci_to_package(e);
  83                 uci_free_package(&p);
  84         }
  85         uci_foreach_element_safe(&ctx->history_path, tmp, e) {
  86                 uci_free_element(e);
  87         }
  88         free(ctx);
  89         UCI_TRAP_RESTORE(ctx);
  90
  91 ignore:
  92         return;
  93 }
  94
  95 int uci_set_confdir(struct uci_context *ctx, const char *dir)
  96 {
  97         char *cdir;
  98
  99         UCI_HANDLE_ERR(ctx);
 100         UCI_ASSERT(ctx, dir != NULL);
 101
 102         cdir = uci_strdup(ctx, dir);
 103         if (ctx->confdir != uci_confdir)
 104                 free(ctx->confdir);
 105         ctx->confdir = cdir;
 106         return 0;
 107 }
 108
 109 static void uci_cleanup(struct uci_context *ctx)
 110 {
 111         struct uci_parse_context *pctx;
 112
 113         if (ctx->buf) {
 114                 free(ctx->buf);
 115                 ctx->buf = NULL;
 116                 ctx->bufsz = 0;
 117         }
 118
 119         pctx = ctx->pctx;
 120         if (!pctx)
 121                 return;
 122
 123         ctx->pctx = NULL;
 124         if (pctx->package)
 125                 uci_free_package(&pctx->package);
 126
 127         if (pctx->buf)
 128                 free(pctx->buf);
 129
 130         free(pctx);
 131 }
 132
 133 void uci_perror(struct uci_context *ctx, const char *prefix)
 134 {
 135         int err;
 136
 137         if (!ctx)
 138                 err = UCI_ERR_INVAL;
 139         else
 140                 err = ctx->err;
 141
 142         if ((err < 0) || (err >= UCI_ERR_LAST))
 143                 err = UCI_ERR_UNKNOWN;
 144
 145         if (prefix)
 146                 fprintf(stderr, "%s: ", prefix);
 147         if (ctx->func)
 148                 fprintf(stderr, "%s: ", ctx->func);
 149
 150         switch (err) {
 151         case UCI_ERR_PARSE:
 152                 if (ctx->pctx) {
 153                         fprintf(stderr, "%s (%s) at line %d, byte %d\n", uci_errstr[err], (ctx->pctx->reason ? ctx->pctx->reason : "unknown"), ctx->pctx->line, ctx->pctx->byte);
 154                         break;
 155                 }
 156                 /* fall through */
 157         default:
 158                 fprintf(stderr, "%s\n", uci_errstr[err]);
 159                 break;
 160         }
 161 }
 162
 163 int uci_list_configs(struct uci_context *ctx, char ***list)
 164 {
 165         UCI_HANDLE_ERR(ctx);
 166         UCI_ASSERT(ctx, list != NULL);
 167         UCI_ASSERT(ctx, ctx->backend && ctx->backend->list_configs);
 168         *list = ctx->backend->list_configs(ctx);
 169         return 0;
 170 }
 171
 172 int uci_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)
 173 {
 174         struct uci_package *p;
 175         UCI_HANDLE_ERR(ctx);
 176         UCI_ASSERT(ctx, package != NULL);
 177         p = *package;
 178         UCI_ASSERT(ctx, p != NULL);
 179         UCI_ASSERT(ctx, p->backend && p->backend->commit);
 180         p->backend->commit(ctx, package, overwrite);
 181         return 0;
 182 }
 183
 184 int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package)
 185 {
 186         struct uci_package *p;
 187         UCI_HANDLE_ERR(ctx);
 188         UCI_ASSERT(ctx, ctx->backend && ctx->backend->load);
 189         p = ctx->backend->load(ctx, name);
 190         if (package)
 191                 *package = p;
 192
 193         return 0;
 194 }
 195
 196 #ifdef UCI_PLUGIN_SUPPORT
 197
 198 __plugin int uci_add_backend(struct uci_context *ctx, struct uci_backend *b)
 199 {
 200         struct uci_element *e;
 201         UCI_HANDLE_ERR(ctx);
 202
 203         e = uci_lookup_list(&ctx->backends, b->e.name);
 204         if (e)
 205                 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
 206
 207         e = uci_malloc(ctx, sizeof(struct uci_backend));
 208         memcpy(e, b, sizeof(struct uci_backend));
 209
 210         uci_list_add(&ctx->backends, &e->list);
 211         return 0;
 212 }
 213
 214 __plugin int uci_del_backend(struct uci_context *ctx, struct uci_backend *b)
 215 {
 216         struct uci_element *e, *tmp;
 217
 218         UCI_HANDLE_ERR(ctx);
 219
 220         e = uci_lookup_list(&ctx->backends, b->e.name);
 221         if (!e || uci_to_backend(e)->ptr != b->ptr)
 222                 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 223         b = uci_to_backend(e);
 224
 225         if (ctx->backend && ctx->backend->ptr == b->ptr)
 226                 ctx->backend = &uci_file_backend;
 227
 228         uci_foreach_element_safe(&ctx->root, tmp, e) {
 229                 struct uci_package *p = uci_to_package(e);
 230
 231                 if (!p->backend)
 232                         continue;
 233
 234                 if (p->backend->ptr == b->ptr)
 235                         UCI_INTERNAL(uci_unload, ctx, p);
 236         }
 237
 238         uci_list_del(&b->e.list);
 239         free(b);
 240
 241         return 0;
 242 }
 243
 244 #endif
 245
 246 int uci_set_backend(struct uci_context *ctx, const char *name)
 247 {
 248         struct uci_element *e;
 249
 250         UCI_HANDLE_ERR(ctx);
 251         UCI_ASSERT(ctx, name != NULL);
 252         e = uci_lookup_list(&ctx->backends, name);
 253         if (!e)
 254                 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 255         ctx->backend = uci_to_backend(e);
 256         return 0;
 257 }