file.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 the code for parsing uci config files
  17  */
  18
  19 #include <sys/types.h>
  20 #include <sys/stat.h>
  21 #include <stdbool.h>
  22 #include <unistd.h>
  23 #include <fcntl.h>
  24 #include <stdio.h>
  25 #include <ctype.h>
  26
  27 #define LINEBUF 32
  28 #define LINEBUF_MAX     4096
  29
  30 static void uci_parse_error(struct uci_context *ctx, char *pos, char *reason)
  31 {
  32         struct uci_parse_context *pctx = ctx->pctx;
  33
  34         pctx->reason = reason;
  35         pctx->byte = pos - pctx->buf;
  36         UCI_THROW(ctx, UCI_ERR_PARSE);
  37 }
  38
  39 /*
  40  * Fetch a new line from the input stream and resize buffer if necessary
  41  */
  42 static void uci_getln(struct uci_context *ctx, int offset)
  43 {
  44         struct uci_parse_context *pctx = ctx->pctx;
  45         char *p;
  46         int ofs;
  47
  48         if (pctx->buf == NULL) {
  49                 pctx->buf = uci_malloc(ctx, LINEBUF);
  50                 pctx->bufsz = LINEBUF;
  51         }
  52
  53         ofs = offset;
  54         do {
  55                 p = &pctx->buf[ofs];
  56                 p[ofs] = 0;
  57
  58                 p = fgets(p, pctx->bufsz - ofs, pctx->file);
  59                 if (!p || !*p)
  60                         return;
  61
  62                 ofs += strlen(p);
  63                 if (pctx->buf[ofs - 1] == '\n') {
  64                         pctx->line++;
  65                         pctx->buf[ofs - 1] = 0;
  66                         return;
  67                 }
  68
  69                 if (pctx->bufsz > LINEBUF_MAX/2)
  70                         uci_parse_error(ctx, p, "line too long");
  71
  72                 pctx->bufsz *= 2;
  73                 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
  74         } while (1);
  75 }
  76
  77 /*
  78  * Clean up all extra memory used by the parser and exporter
  79  */
  80 static void uci_file_cleanup(struct uci_context *ctx)
  81 {
  82         struct uci_parse_context *pctx;
  83
  84         if (ctx->buf) {
  85                 free(ctx->buf);
  86                 ctx->buf = NULL;
  87                 ctx->bufsz = 0;
  88         }
  89
  90         pctx = ctx->pctx;
  91         if (!pctx)
  92                 return;
  93
  94         ctx->pctx = NULL;
  95         if (pctx->package)
  96                 uci_free_package(pctx->package);
  97
  98         if (pctx->buf)
  99                 free(pctx->buf);
 100         if (pctx->file)
 101                 fclose(pctx->file);
 102
 103         free(pctx);
 104 }
 105
 106 /*
 107  * parse a character escaped by '\'
 108  * returns true if the escaped character is to be parsed
 109  * returns false if the escaped character is to be ignored
 110  */
 111 static inline bool parse_backslash(struct uci_context *ctx, char **str)
 112 {
 113         /* skip backslash */
 114         *str += 1;
 115
 116         /* undecoded backslash at the end of line, fetch the next line */
 117         if (!**str) {
 118                 *str += 1;
 119                 uci_getln(ctx, *str - ctx->pctx->buf);
 120                 return false;
 121         }
 122
 123         /* FIXME: decode escaped char, necessary? */
 124         return true;
 125 }
 126
 127 /*
 128  * move the string pointer forward until a non-whitespace character or
 129  * EOL is reached
 130  */
 131 static void skip_whitespace(struct uci_context *ctx, char **str)
 132 {
 133 restart:
 134         while (**str && isspace(**str))
 135                 *str += 1;
 136
 137         if (**str == '\\') {
 138                 if (!parse_backslash(ctx, str))
 139                         goto restart;
 140         }
 141 }
 142
 143 static inline void addc(char **dest, char **src)
 144 {
 145         **dest = **src;
 146         *dest += 1;
 147         *src += 1;
 148 }
 149
 150 /*
 151  * parse a double quoted string argument from the command line
 152  */
 153 static void parse_double_quote(struct uci_context *ctx, char **str, char **target)
 154 {
 155         char c;
 156
 157         /* skip quote character */
 158         *str += 1;
 159
 160         while ((c = **str)) {
 161                 switch(c) {
 162                 case '"':
 163                         **target = 0;
 164                         *str += 1;
 165                         return;
 166                 case '\\':
 167                         if (!parse_backslash(ctx, str))
 168                                 continue;
 169                         /* fall through */
 170                 default:
 171                         addc(target, str);
 172                         break;
 173                 }
 174         }
 175         uci_parse_error(ctx, *str, "unterminated \"");
 176 }
 177
 178 /*
 179  * parse a single quoted string argument from the command line
 180  */
 181 static void parse_single_quote(struct uci_context *ctx, char **str, char **target)
 182 {
 183         char c;
 184         /* skip quote character */
 185         *str += 1;
 186
 187         while ((c = **str)) {
 188                 switch(c) {
 189                 case '\'':
 190                         **target = 0;
 191                         *str += 1;
 192                         return;
 193                 default:
 194                         addc(target, str);
 195                 }
 196         }
 197         uci_parse_error(ctx, *str, "unterminated '");
 198 }
 199
 200 /*
 201  * parse a string from the command line and detect the quoting style
 202  */
 203 static void parse_str(struct uci_context *ctx, char **str, char **target)
 204 {
 205         do {
 206                 switch(**str) {
 207                 case '\'':
 208                         parse_single_quote(ctx, str, target);
 209                         break;
 210                 case '"':
 211                         parse_double_quote(ctx, str, target);
 212                         break;
 213                 case 0:
 214                         goto done;
 215                 case '\\':
 216                         if (!parse_backslash(ctx, str))
 217                                 continue;
 218                         /* fall through */
 219                 default:
 220                         addc(target, str);
 221                         break;
 222                 }
 223         } while (**str && !isspace(**str));
 224 done:
 225
 226         /*
 227          * if the string was unquoted and we've stopped at a whitespace
 228          * character, skip to the next one, because the whitespace will
 229          * be overwritten by a null byte here
 230          */
 231         if (**str)
 232                 *str += 1;
 233
 234         /* terminate the parsed string */
 235         **target = 0;
 236 }
 237
 238 /*
 239  * extract the next argument from the command line
 240  */
 241 static char *next_arg(struct uci_context *ctx, char **str, bool required)
 242 {
 243         char *val;
 244         char *ptr;
 245
 246         val = ptr = *str;
 247         skip_whitespace(ctx, str);
 248         parse_str(ctx, str, &ptr);
 249         if (required && !*val)
 250                 uci_parse_error(ctx, *str, "insufficient arguments");
 251
 252         return val;
 253 }
 254
 255 /*
 256  * verify that the end of the line or command is reached.
 257  * throw an error if extra arguments are given on the command line
 258  */
 259 static void assert_eol(struct uci_context *ctx, char **str)
 260 {
 261         char *tmp;
 262
 263         tmp = next_arg(ctx, str, false);
 264         if (tmp && *tmp)
 265                 uci_parse_error(ctx, *str, "too many arguments");
 266 }
 267
 268 /*
 269  * switch to a different config, either triggered by uci_load, or by a
 270  * 'package <...>' statement in the import file
 271  */
 272 static void uci_switch_config(struct uci_context *ctx)
 273 {
 274         struct uci_parse_context *pctx;
 275         struct uci_element *e;
 276         const char *name;
 277
 278         pctx = ctx->pctx;
 279         name = pctx->name;
 280
 281         /* add the last config to main config file list */
 282         if (pctx->package) {
 283                 uci_list_add(&ctx->root, &pctx->package->e.list);
 284
 285                 pctx->package = NULL;
 286                 pctx->section = NULL;
 287         }
 288
 289         if (!name)
 290                 return;
 291
 292         /*
 293          * if an older config under the same name exists, unload it
 294          * ignore errors here, e.g. if the config was not found
 295          */
 296         UCI_TRAP_SAVE(ctx, ignore);
 297         e = uci_lookup_list(ctx, &ctx->root, name);
 298         if (e)
 299                 uci_unload(ctx, uci_to_package(e));
 300         UCI_TRAP_RESTORE(ctx);
 301 ignore:
 302         ctx->errno = 0;
 303
 304         pctx->package = uci_alloc_package(ctx, name);
 305 }
 306
 307 /*
 308  * parse the 'package' uci command (next config package)
 309  */
 310 static void uci_parse_package(struct uci_context *ctx, char **str, bool single)
 311 {
 312         char *name = NULL;
 313
 314         /* command string null-terminated by strtok */
 315         *str += strlen(*str) + 1;
 316
 317         name = next_arg(ctx, str, true);
 318         assert_eol(ctx, str);
 319         if (single)
 320                 return;
 321
 322         ctx->pctx->name = name;
 323         uci_switch_config(ctx);
 324 }
 325
 326 /*
 327  * parse the 'config' uci command (open a section)
 328  */
 329 static void uci_parse_config(struct uci_context *ctx, char **str)
 330 {
 331         char *name = NULL;
 332         char *type = NULL;
 333
 334         if (!ctx->pctx->package) {
 335                 if (!ctx->pctx->name)
 336                         uci_parse_error(ctx, *str, "attempting to import a file without a package name");
 337
 338                 uci_switch_config(ctx);
 339         }
 340
 341         /* command string null-terminated by strtok */
 342         *str += strlen(*str) + 1;
 343
 344         type = next_arg(ctx, str, true);
 345         name = next_arg(ctx, str, false);
 346         assert_eol(ctx, str);
 347         ctx->pctx->section = uci_alloc_section(ctx->pctx->package, type, name);
 348 }
 349
 350 /*
 351  * parse the 'option' uci command (open a value)
 352  */
 353 static void uci_parse_option(struct uci_context *ctx, char **str)
 354 {
 355         char *name = NULL;
 356         char *value = NULL;
 357
 358         if (!ctx->pctx->section)
 359                 uci_parse_error(ctx, *str, "option command found before the first section");
 360
 361         /* command string null-terminated by strtok */
 362         *str += strlen(*str) + 1;
 363
 364         name = next_arg(ctx, str, true);
 365         value = next_arg(ctx, str, true);
 366         assert_eol(ctx, str);
 367         uci_alloc_option(ctx->pctx->section, name, value);
 368 }
 369
 370
 371 /*
 372  * parse a complete input line, split up combined commands by ';'
 373  */
 374 static void uci_parse_line(struct uci_context *ctx, bool single)
 375 {
 376         struct uci_parse_context *pctx = ctx->pctx;
 377         char *word, *brk = NULL;
 378
 379         for (word = strtok_r(pctx->buf, ";", &brk);
 380                  word;
 381                  word = strtok_r(NULL, ";", &brk)) {
 382
 383                 char *pbrk = NULL;
 384                 word = strtok_r(word, " \t", &pbrk);
 385
 386                 switch(word[0]) {
 387                         case 'p':
 388                                 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
 389                                         uci_parse_package(ctx, &word, single);
 390                                 break;
 391                         case 'c':
 392                                 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
 393                                         uci_parse_config(ctx, &word);
 394                                 break;
 395                         case 'o':
 396                                 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
 397                                         uci_parse_option(ctx, &word);
 398                                 break;
 399                         default:
 400                                 uci_parse_error(ctx, word, "unterminated command");
 401                                 break;
 402                 }
 403         }
 404 }
 405
 406 /* max number of characters that escaping adds to the string */
 407 #define UCI_QUOTE_ESCAPE        "'\\''"
 408
 409 /*
 410  * escape an uci string for export
 411  */
 412 static char *uci_escape(struct uci_context *ctx, char *str)
 413 {
 414         char *s, *p;
 415         int pos = 0;
 416
 417         if (!ctx->buf) {
 418                 ctx->bufsz = LINEBUF;
 419                 ctx->buf = malloc(LINEBUF);
 420         }
 421
 422         s = str;
 423         p = strchr(str, '\'');
 424         if (!p)
 425                 return str;
 426
 427         do {
 428                 int len = p - s;
 429                 if (len > 0) {
 430                         if (p + sizeof(UCI_QUOTE_ESCAPE) - str >= ctx->bufsz) {
 431                                 ctx->bufsz *= 2;
 432                                 ctx->buf = realloc(ctx->buf, ctx->bufsz);
 433                                 if (!ctx->buf)
 434                                         UCI_THROW(ctx, UCI_ERR_MEM);
 435                         }
 436                         memcpy(&ctx->buf[pos], s, len);
 437                         pos += len;
 438                 }
 439                 strcpy(&ctx->buf[pos], UCI_QUOTE_ESCAPE);
 440                 pos += sizeof(UCI_QUOTE_ESCAPE);
 441                 s = p + 1;
 442         } while ((p = strchr(s, '\'')));
 443
 444         return ctx->buf;
 445 }
 446
 447
 448 /*
 449  * export a single config package to a file stream
 450  */
 451 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
 452 {
 453         struct uci_context *ctx = p->ctx;
 454         struct uci_element *s, *o;
 455
 456         if (header)
 457                 fprintf(stream, "package '%s'\n", uci_escape(ctx, p->e.name));
 458         uci_foreach_element(&p->sections, s) {
 459                 struct uci_section *sec = uci_to_section(s);
 460                 fprintf(stream, "\nconfig '%s'", uci_escape(ctx, sec->type));
 461                 fprintf(stream, " '%s'\n", uci_escape(ctx, sec->e.name));
 462                 uci_foreach_element(&sec->options, o) {
 463                         struct uci_option *opt = uci_to_option(o);
 464                         fprintf(stream, "\toption '%s'", uci_escape(ctx, opt->e.name));
 465                         fprintf(stream, " '%s'\n", uci_escape(ctx, opt->value));
 466                 }
 467         }
 468         fprintf(stream, "\n");
 469 }
 470
 471 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
 472 {
 473         struct uci_element *e;
 474
 475         UCI_HANDLE_ERR(ctx);
 476         UCI_ASSERT(ctx, stream != NULL);
 477
 478         if (package) {
 479                 uci_export_package(package, stream, header);
 480                 goto done;
 481         }
 482
 483         uci_foreach_element(&ctx->root, e) {
 484                 uci_export_package(uci_to_package(e), stream, header);
 485         }
 486 done:
 487         return 0;
 488 }
 489
 490 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
 491 {
 492         struct uci_parse_context *pctx;
 493
 494         /* make sure no memory from previous parse attempts is leaked */
 495         uci_file_cleanup(ctx);
 496
 497         pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
 498         ctx->pctx = pctx;
 499         pctx->file = stream;
 500
 501         /*
 502          * If 'name' was supplied, assume that the supplied stream does not contain
 503          * the appropriate 'package <name>' string to specify the config name
 504          * NB: the config file can still override the package name
 505          */
 506         if (name)
 507                 pctx->name = name;
 508
 509         while (!feof(pctx->file)) {
 510                 uci_getln(ctx, 0);
 511                 if (pctx->buf[0])
 512                         uci_parse_line(ctx, single);
 513         }
 514
 515         if (package)
 516                 *package = pctx->package;
 517
 518         pctx->name = NULL;
 519         uci_switch_config(ctx);
 520
 521         /* no error happened, we can get rid of the parser context now */
 522         uci_file_cleanup(ctx);
 523
 524         return 0;
 525 }
 526
 527 int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package)
 528 {
 529         struct stat statbuf;
 530         char *filename;
 531         bool confdir;
 532         FILE *file;
 533         int fd;
 534
 535         UCI_HANDLE_ERR(ctx);
 536         UCI_ASSERT(ctx, name != NULL);
 537
 538         switch (name[0]) {
 539         case '.':
 540                 if (name[1] != '/')
 541                         UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 542                 /* fall through */
 543         case '/':
 544                 /* absolute/relative path outside of /etc/config */
 545                 filename = uci_strdup(ctx, name);
 546                 name = strrchr(name, '/') + 1;
 547                 confdir = false;
 548                 break;
 549         default:
 550                 filename = uci_malloc(ctx, strlen(name) + sizeof(UCI_CONFDIR) + 2);
 551                 sprintf(filename, UCI_CONFDIR "/%s", name);
 552                 confdir = true;
 553                 break;
 554         }
 555
 556         if ((stat(filename, &statbuf) < 0) ||
 557                 ((statbuf.st_mode &  S_IFMT) != S_IFREG)) {
 558                 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
 559         }
 560
 561         fd = open(filename, O_RDONLY);
 562         if (fd <= 0)
 563                 UCI_THROW(ctx, UCI_ERR_IO);
 564
 565         if (flock(fd, LOCK_SH) < 0)
 566                 UCI_THROW(ctx, UCI_ERR_IO);
 567
 568         file = fdopen(fd, "r");
 569         if (!file)
 570                 UCI_THROW(ctx, UCI_ERR_IO);
 571
 572         ctx->errno = 0;
 573         UCI_TRAP_SAVE(ctx, done);
 574         uci_import(ctx, file, name, package, true);
 575         UCI_TRAP_RESTORE(ctx);
 576
 577         if (*package) {
 578                 (*package)->path = filename;
 579                 (*package)->confdir = confdir;
 580         }
 581
 582 done:
 583         flock(fd, LOCK_UN);
 584         fclose(file);
 585         return ctx->errno;
 586 }
 587
 588 int uci_commit(struct uci_context *ctx, struct uci_package *p)
 589 {
 590         FILE *f = NULL;
 591         int fd = 0;
 592         int err = UCI_ERR_IO;
 593
 594         UCI_HANDLE_ERR(ctx);
 595         UCI_ASSERT(ctx, p != NULL);
 596         UCI_ASSERT(ctx, p->path != NULL);
 597
 598         fd = open(p->path, O_RDWR);
 599         if (fd < 0)
 600                 goto done;
 601
 602         if (flock(fd, LOCK_EX) < 0)
 603                 goto done;
 604
 605         ftruncate(fd, 0);
 606         f = fdopen(fd, "w");
 607         if (!f)
 608                 goto done;
 609
 610         UCI_TRAP_SAVE(ctx, done);
 611         uci_export(ctx, f, p, false);
 612         UCI_TRAP_RESTORE(ctx);
 613
 614 done:
 615         if (f)
 616                 fclose(f);
 617         else if (fd > 0)
 618                 close(fd);
 619
 620         if (ctx->errno)
 621                 UCI_THROW(ctx, ctx->errno);
 622         if (err)
 623                 UCI_THROW(ctx, UCI_ERR_IO);
 624         return 0;
 625 }
 626
 627
 628 /*
 629  * This function returns the filename by returning the string
 630  * after the last '/' character. By checking for a non-'\0'
 631  * character afterwards, directories are ignored (glob marks
 632  * those with a trailing '/'
 633  */
 634 static inline char *get_filename(char *path)
 635 {
 636         char *p;
 637
 638         p = strrchr(path, '/');
 639         p++;
 640         if (!*p)
 641                 return NULL;
 642         return p;
 643 }
 644
 645 char **uci_list_configs(struct uci_context *ctx)
 646 {
 647         char **configs;
 648         glob_t globbuf;
 649         int size, i;
 650         char *buf;
 651
 652         if (glob(UCI_CONFDIR "/*", GLOB_MARK, NULL, &globbuf) != 0)
 653                 return NULL;
 654
 655         size = sizeof(char *) * (globbuf.gl_pathc + 1);
 656         for(i = 0; i < globbuf.gl_pathc; i++) {
 657                 char *p;
 658
 659                 p = get_filename(globbuf.gl_pathv[i]);
 660                 if (!p)
 661                         continue;
 662
 663                 size += strlen(p) + 1;
 664         }
 665
 666         configs = malloc(size);
 667         if (!configs)
 668                 return NULL;
 669
 670         memset(configs, 0, size);
 671         buf = (char *) &configs[globbuf.gl_pathc + 1];
 672         for(i = 0; i < globbuf.gl_pathc; i++) {
 673                 char *p;
 674
 675                 p = get_filename(globbuf.gl_pathv[i]);
 676                 if (!p)
 677                         continue;
 678
 679                 configs[i] = buf;
 680                 strcpy(buf, p);
 681                 buf += strlen(buf) + 1;
 682         }
 683         return configs;
 684 }
 685
 686