cli.c

   1 /*
   2  * cli - Command Line Interface 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 General Public License version 2
   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 #include <strings.h>
  15 #include <string.h>
  16 #include <stdlib.h>
  17 #include <unistd.h>
  18 #include "uci.h"
  19
  20 #define MAX_ARGS        4 /* max command line arguments for batch mode */
  21
  22 static const char *delimiter = " ";
  23 static const char *appname;
  24 static enum {
  25         CLI_FLAG_MERGE =    (1 << 0),
  26         CLI_FLAG_QUIET =    (1 << 1),
  27         CLI_FLAG_NOCOMMIT = (1 << 2),
  28         CLI_FLAG_BATCH =    (1 << 3),
  29         CLI_FLAG_SHOW_EXT = (1 << 4),
  30         CLI_FLAG_NOPLUGINS= (1 << 5),
  31 } flags;
  32
  33 static FILE *input;
  34
  35 static struct uci_context *ctx;
  36 enum {
  37         /* section cmds */
  38         CMD_GET,
  39         CMD_SET,
  40         CMD_ADD_LIST,
  41         CMD_DEL,
  42         CMD_RENAME,
  43         CMD_REVERT,
  44         CMD_REORDER,
  45         /* package cmds */
  46         CMD_SHOW,
  47         CMD_CHANGES,
  48         CMD_EXPORT,
  49         CMD_COMMIT,
  50         /* other cmds */
  51         CMD_ADD,
  52         CMD_IMPORT,
  53         CMD_HELP,
  54 };
  55
  56 struct uci_type_list {
  57         unsigned int idx;
  58         const char *name;
  59         struct uci_type_list *next;
  60 };
  61
  62 static struct uci_type_list *type_list = NULL;
  63 static char *typestr = NULL;
  64 static const char *cur_section_ref = NULL;
  65
  66 static int uci_cmd(int argc, char **argv);
  67
  68 static void
  69 uci_reset_typelist(void)
  70 {
  71         struct uci_type_list *type;
  72         while (type_list != NULL) {
  73                         type = type_list;
  74                         type_list = type_list->next;
  75                         free(type);
  76         }
  77         if (typestr) {
  78                 free(typestr);
  79                 typestr = NULL;
  80         }
  81         cur_section_ref = NULL;
  82 }
  83
  84 static char *
  85 uci_lookup_section_ref(struct uci_section *s)
  86 {
  87         struct uci_type_list *ti = type_list;
  88         int maxlen;
  89
  90         if (!s->anonymous || !(flags & CLI_FLAG_SHOW_EXT))
  91                 return s->e.name;
  92
  93         /* look up in section type list */
  94         while (ti) {
  95                 if (strcmp(ti->name, s->type) == 0)
  96                         break;
  97                 ti = ti->next;
  98         }
  99         if (!ti) {
 100                 ti = malloc(sizeof(struct uci_type_list));
 101                 if (!ti)
 102                         return NULL;
 103                 memset(ti, 0, sizeof(struct uci_type_list));
 104                 ti->next = type_list;
 105                 type_list = ti;
 106                 ti->name = s->type;
 107         }
 108
 109         maxlen = strlen(s->type) + 1 + 2 + 10;
 110         if (!typestr) {
 111                 typestr = malloc(maxlen);
 112         } else {
 113                 typestr = realloc(typestr, maxlen);
 114         }
 115
 116         if (typestr)
 117                 sprintf(typestr, "@%s[%d]", ti->name, ti->idx);
 118
 119         ti->idx++;
 120
 121         return typestr;
 122 }
 123
 124 static void uci_usage(void)
 125 {
 126         fprintf(stderr,
 127                 "Usage: %s [<options>] <command> [<arguments>]\n\n"
 128                 "Commands:\n"
 129                 "\tbatch\n"
 130                 "\texport     [<config>]\n"
 131                 "\timport     [<config>]\n"
 132                 "\tchanges    [<config>]\n"
 133                 "\tcommit     [<config>]\n"
 134                 "\tadd        <config> <section-type>\n"
 135                 "\tadd_list   <config>.<section>.<option>=<string>\n"
 136                 "\tshow       [<config>[.<section>[.<option>]]]\n"
 137                 "\tget        <config>.<section>[.<option>]\n"
 138                 "\tset        <config>.<section>[.<option>]=<value>\n"
 139                 "\tdelete     <config>[.<section[.<option>]]\n"
 140                 "\trename     <config>.<section>[.<option>]=<name>\n"
 141                 "\trevert     <config>[.<section>[.<option>]]\n"
 142                 "\treorder    <config>.<section>=<position>\n"
 143                 "\n"
 144                 "Options:\n"
 145                 "\t-c <path>  set the search path for config files (default: /etc/config)\n"
 146                 "\t-d <str>   set the delimiter for list values in uci show\n"
 147                 "\t-f <file>  use <file> as input instead of stdin\n"
 148                 "\t-L         do not load any plugins\n"
 149                 "\t-m         when importing, merge data into an existing package\n"
 150                 "\t-n         name unnamed sections on export (default)\n"
 151                 "\t-N         don't name unnamed sections\n"
 152                 "\t-p <path>  add a search path for config change files\n"
 153                 "\t-P <path>  add a search path for config change files and use as default\n"
 154                 "\t-q         quiet mode (don't print error messages)\n"
 155                 "\t-s         force strict mode (stop on parser errors, default)\n"
 156                 "\t-S         disable strict mode\n"
 157                 "\t-X         do not use extended syntax on 'show'\n"
 158                 "\n",
 159                 appname
 160         );
 161 }
 162
 163 static void cli_perror(void)
 164 {
 165         if (flags & CLI_FLAG_QUIET)
 166                 return;
 167
 168         uci_perror(ctx, appname);
 169 }
 170
 171 static void uci_show_value(struct uci_option *o)
 172 {
 173         struct uci_element *e;
 174         bool sep = false;
 175
 176         switch(o->type) {
 177         case UCI_TYPE_STRING:
 178                 printf("%s\n", o->v.string);
 179                 break;
 180         case UCI_TYPE_LIST:
 181                 uci_foreach_element(&o->v.list, e) {
 182                         printf("%s%s", (sep ? delimiter : ""), e->name);
 183                         sep = true;
 184                 }
 185                 printf("\n");
 186                 break;
 187         default:
 188                 printf("<unknown>\n");
 189                 break;
 190         }
 191 }
 192
 193 static void uci_show_option(struct uci_option *o)
 194 {
 195         printf("%s.%s.%s=",
 196                 o->section->package->e.name,
 197                 (cur_section_ref ? cur_section_ref : o->section->e.name),
 198                 o->e.name);
 199         uci_show_value(o);
 200 }
 201
 202 static void uci_show_section(struct uci_section *s)
 203 {
 204         struct uci_element *e;
 205         const char *cname;
 206         const char *sname;
 207
 208         cname = s->package->e.name;
 209         sname = (cur_section_ref ? cur_section_ref : s->e.name);
 210         printf("%s.%s=%s\n", cname, sname, s->type);
 211         uci_foreach_element(&s->options, e) {
 212                 uci_show_option(uci_to_option(e));
 213         }
 214 }
 215
 216 static void uci_show_package(struct uci_package *p)
 217 {
 218         struct uci_element *e;
 219
 220         uci_reset_typelist();
 221         uci_foreach_element( &p->sections, e) {
 222                 struct uci_section *s = uci_to_section(e);
 223                 cur_section_ref = uci_lookup_section_ref(s);
 224                 uci_show_section(s);
 225         }
 226         uci_reset_typelist();
 227 }
 228
 229 static void uci_show_changes(struct uci_package *p)
 230 {
 231         struct uci_element *e;
 232
 233         uci_foreach_element(&p->saved_delta, e) {
 234                 struct uci_delta *h = uci_to_delta(e);
 235                 char *prefix = "";
 236                 char *op = "=";
 237
 238                 switch(h->cmd) {
 239                 case UCI_CMD_REMOVE:
 240                         prefix = "-";
 241                         break;
 242                 case UCI_CMD_LIST_ADD:
 243                         op = "+=";
 244                         break;
 245                 default:
 246                         break;
 247                 }
 248                 printf("%s%s.%s", prefix, p->e.name, h->section);
 249                 if (e->name)
 250                         printf(".%s", e->name);
 251                 if (h->cmd != UCI_CMD_REMOVE)
 252                         printf("%s%s", op, h->value);
 253                 printf("\n");
 254         }
 255 }
 256
 257 static int package_cmd(int cmd, char *tuple)
 258 {
 259         struct uci_element *e = NULL;
 260         struct uci_ptr ptr;
 261         int ret = 0;
 262
 263         if (uci_lookup_ptr(ctx, &ptr, tuple, true) != UCI_OK) {
 264                 cli_perror();
 265                 return 1;
 266         }
 267
 268         e = ptr.last;
 269         switch(cmd) {
 270         case CMD_CHANGES:
 271                 uci_show_changes(ptr.p);
 272                 break;
 273         case CMD_COMMIT:
 274                 if (flags & CLI_FLAG_NOCOMMIT)
 275                         return 0;
 276                 if (uci_commit(ctx, &ptr.p, false) != UCI_OK) {
 277                         cli_perror();
 278                         ret = 1;
 279                 }
 280                 break;
 281         case CMD_EXPORT:
 282                 uci_export(ctx, stdout, ptr.p, true);
 283                 break;
 284         case CMD_SHOW:
 285                 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
 286                         ctx->err = UCI_ERR_NOTFOUND;
 287                         cli_perror();
 288                         ret = 1;
 289                 }
 290                 switch(e->type) {
 291                         case UCI_TYPE_PACKAGE:
 292                                 uci_show_package(ptr.p);
 293                                 break;
 294                         case UCI_TYPE_SECTION:
 295                                 uci_show_section(ptr.s);
 296                                 break;
 297                         case UCI_TYPE_OPTION:
 298                                 uci_show_option(ptr.o);
 299                                 break;
 300                         default:
 301                                 /* should not happen */
 302                                 return 1;
 303                 }
 304                 break;
 305         }
 306
 307         if (ptr.p)
 308                 uci_unload(ctx, ptr.p);
 309         return ret;
 310 }
 311
 312 static int uci_do_import(int argc, char **argv)
 313 {
 314         struct uci_package *package = NULL;
 315         char *name = NULL;
 316         int ret = UCI_OK;
 317         bool merge = false;
 318
 319         if (argc > 2)
 320                 return 255;
 321
 322         if (argc == 2)
 323                 name = argv[1];
 324         else if (flags & CLI_FLAG_MERGE)
 325                 /* need a package to merge */
 326                 return 255;
 327
 328         if (flags & CLI_FLAG_MERGE) {
 329                 if (uci_load(ctx, name, &package) != UCI_OK)
 330                         package = NULL;
 331                 else
 332                         merge = true;
 333         }
 334         ret = uci_import(ctx, input, name, &package, (name != NULL));
 335         if (ret == UCI_OK) {
 336                 if (merge) {
 337                         ret = uci_save(ctx, package);
 338                 } else {
 339                         struct uci_element *e;
 340                         /* loop through all config sections and overwrite existing data */
 341                         uci_foreach_element(&ctx->root, e) {
 342                                 struct uci_package *p = uci_to_package(e);
 343                                 ret = uci_commit(ctx, &p, true);
 344                         }
 345                 }
 346         }
 347
 348         if (ret != UCI_OK) {
 349                 cli_perror();
 350                 return 1;
 351         }
 352
 353         return 0;
 354 }
 355
 356 static int uci_do_package_cmd(int cmd, int argc, char **argv)
 357 {
 358         char **configs = NULL;
 359         char **p;
 360
 361         if (argc > 2)
 362                 return 255;
 363
 364         if (argc == 2)
 365                 return package_cmd(cmd, argv[1]);
 366
 367         if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs) {
 368                 cli_perror();
 369                 return 1;
 370         }
 371
 372         for (p = configs; *p; p++) {
 373                 package_cmd(cmd, *p);
 374         }
 375
 376         return 0;
 377 }
 378
 379 static int uci_do_add(int argc, char **argv)
 380 {
 381         struct uci_package *p = NULL;
 382         struct uci_section *s = NULL;
 383         int ret;
 384
 385         if (argc != 3)
 386                 return 255;
 387
 388         ret = uci_load(ctx, argv[1], &p);
 389         if (ret != UCI_OK)
 390                 goto done;
 391
 392         ret = uci_add_section(ctx, p, argv[2], &s);
 393         if (ret != UCI_OK)
 394                 goto done;
 395
 396         ret = uci_save(ctx, p);
 397
 398 done:
 399         if (ret != UCI_OK)
 400                 cli_perror();
 401         else if (s)
 402                 fprintf(stdout, "%s\n", s->e.name);
 403
 404         return ret;
 405 }
 406
 407 static int uci_do_section_cmd(int cmd, int argc, char **argv)
 408 {
 409         struct uci_element *e;
 410         struct uci_ptr ptr;
 411         int ret = UCI_OK;
 412
 413         if (argc != 2)
 414                 return 255;
 415
 416         if (uci_lookup_ptr(ctx, &ptr, argv[1], true) != UCI_OK) {
 417                 cli_perror();
 418                 return 1;
 419         }
 420
 421         if (ptr.value && (cmd != CMD_SET) && (cmd != CMD_ADD_LIST) && (cmd != CMD_RENAME) && (cmd != CMD_REORDER))
 422                 return 1;
 423
 424         e = ptr.last;
 425         switch(cmd) {
 426         case CMD_GET:
 427                 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
 428                         ctx->err = UCI_ERR_NOTFOUND;
 429                         cli_perror();
 430                         return 1;
 431                 }
 432                 switch(e->type) {
 433                 case UCI_TYPE_SECTION:
 434                         printf("%s\n", ptr.s->type);
 435                         break;
 436                 case UCI_TYPE_OPTION:
 437                         uci_show_value(ptr.o);
 438                         break;
 439                 default:
 440                         break;
 441                 }
 442                 /* throw the value to stdout */
 443                 break;
 444         case CMD_RENAME:
 445                 ret = uci_rename(ctx, &ptr);
 446                 break;
 447         case CMD_REVERT:
 448                 ret = uci_revert(ctx, &ptr);
 449                 break;
 450         case CMD_SET:
 451                 ret = uci_set(ctx, &ptr);
 452                 break;
 453         case CMD_ADD_LIST:
 454                 ret = uci_add_list(ctx, &ptr);
 455                 break;
 456         case CMD_REORDER:
 457                 if (!ptr.s || !ptr.value) {
 458                         ctx->err = UCI_ERR_NOTFOUND;
 459                         cli_perror();
 460                         return 1;
 461                 }
 462                 ret = uci_reorder_section(ctx, ptr.s, strtoul(ptr.value, NULL, 10));
 463                 break;
 464         case CMD_DEL:
 465                 ret = uci_delete(ctx, &ptr);
 466                 break;
 467         }
 468
 469         /* no save necessary for get */
 470         if ((cmd == CMD_GET) || (cmd == CMD_REVERT))
 471                 return 0;
 472
 473         /* save changes, but don't commit them yet */
 474         if (ret == UCI_OK)
 475                 ret = uci_save(ctx, ptr.p);
 476
 477         if (ret != UCI_OK) {
 478                 cli_perror();
 479                 return 1;
 480         }
 481
 482         return 0;
 483 }
 484
 485 static int uci_batch_cmd(void)
 486 {
 487         char *argv[MAX_ARGS + 2];
 488         char *str = NULL;
 489         int ret = 0;
 490         int i, j;
 491
 492         for(i = 0; i <= MAX_ARGS; i++) {
 493                 if (i == MAX_ARGS) {
 494                         fprintf(stderr, "Too many arguments\n");
 495                         return 1;
 496                 }
 497                 argv[i] = NULL;
 498                 if ((ret = uci_parse_argument(ctx, input, &str, &argv[i])) != UCI_OK) {
 499                         cli_perror();
 500                         i = 0;
 501                         break;
 502                 }
 503                 if (!argv[i][0])
 504                         break;
 505                 argv[i] = strdup(argv[i]);
 506                 if (!argv[i]) {
 507                         perror("uci");
 508                         return 1;
 509                 }
 510         }
 511         argv[i] = NULL;
 512
 513         if (i > 0) {
 514                 if (!strcasecmp(argv[0], "exit"))
 515                         return 254;
 516                 ret = uci_cmd(i, argv);
 517         } else
 518                 return 0;
 519
 520         for (j = 0; j < i; j++) {
 521                 if (argv[j])
 522                         free(argv[j]);
 523         }
 524
 525         return ret;
 526 }
 527
 528 static int uci_batch(void)
 529 {
 530         int ret = 0;
 531
 532         flags |= CLI_FLAG_BATCH;
 533         while (!feof(input)) {
 534                 struct uci_element *e, *tmp;
 535
 536                 ret = uci_batch_cmd();
 537                 if (ret == 254)
 538                         return 0;
 539                 else if (ret == 255)
 540                         fprintf(stderr, "Unknown command\n");
 541
 542                 /* clean up */
 543                 uci_foreach_element_safe(&ctx->root, tmp, e) {
 544                         uci_unload(ctx, uci_to_package(e));
 545                 }
 546         }
 547         flags &= ~CLI_FLAG_BATCH;
 548
 549         return 0;
 550 }
 551
 552 static int uci_cmd(int argc, char **argv)
 553 {
 554         int cmd = 0;
 555
 556         if (!strcasecmp(argv[0], "batch") && !(flags & CLI_FLAG_BATCH))
 557                 return uci_batch();
 558         else if (!strcasecmp(argv[0], "show"))
 559                 cmd = CMD_SHOW;
 560         else if (!strcasecmp(argv[0], "changes"))
 561                 cmd = CMD_CHANGES;
 562         else if (!strcasecmp(argv[0], "export"))
 563                 cmd = CMD_EXPORT;
 564         else if (!strcasecmp(argv[0], "commit"))
 565                 cmd = CMD_COMMIT;
 566         else if (!strcasecmp(argv[0], "get"))
 567                 cmd = CMD_GET;
 568         else if (!strcasecmp(argv[0], "set"))
 569                 cmd = CMD_SET;
 570         else if (!strcasecmp(argv[0], "ren") ||
 571                  !strcasecmp(argv[0], "rename"))
 572                 cmd = CMD_RENAME;
 573         else if (!strcasecmp(argv[0], "revert"))
 574                 cmd = CMD_REVERT;
 575         else if (!strcasecmp(argv[0], "reorder"))
 576                 cmd = CMD_REORDER;
 577         else if (!strcasecmp(argv[0], "del") ||
 578                  !strcasecmp(argv[0], "delete"))
 579                 cmd = CMD_DEL;
 580         else if (!strcasecmp(argv[0], "import"))
 581                 cmd = CMD_IMPORT;
 582         else if (!strcasecmp(argv[0], "help"))
 583                 cmd = CMD_HELP;
 584         else if (!strcasecmp(argv[0], "add"))
 585                 cmd = CMD_ADD;
 586         else if (!strcasecmp(argv[0], "add_list"))
 587                 cmd = CMD_ADD_LIST;
 588         else
 589                 cmd = -1;
 590
 591         switch(cmd) {
 592                 case CMD_ADD_LIST:
 593                 case CMD_GET:
 594                 case CMD_SET:
 595                 case CMD_DEL:
 596                 case CMD_RENAME:
 597                 case CMD_REVERT:
 598                 case CMD_REORDER:
 599                         return uci_do_section_cmd(cmd, argc, argv);
 600                 case CMD_SHOW:
 601                 case CMD_EXPORT:
 602                 case CMD_COMMIT:
 603                 case CMD_CHANGES:
 604                         return uci_do_package_cmd(cmd, argc, argv);
 605                 case CMD_IMPORT:
 606                         return uci_do_import(argc, argv);
 607                 case CMD_ADD:
 608                         return uci_do_add(argc, argv);
 609                 case CMD_HELP:
 610                         uci_usage();
 611                         return 0;
 612                 default:
 613                         return 255;
 614         }
 615 }
 616
 617 int main(int argc, char **argv)
 618 {
 619         int ret;
 620         int c;
 621
 622         flags = CLI_FLAG_SHOW_EXT;
 623         appname = argv[0];
 624         input = stdin;
 625         ctx = uci_alloc_context();
 626         if (!ctx) {
 627                 fprintf(stderr, "Out of memory\n");
 628                 return 1;
 629         }
 630
 631         while((c = getopt(argc, argv, "c:d:f:LmnNp:P:sSqX")) != -1) {
 632                 switch(c) {
 633                         case 'c':
 634                                 uci_set_confdir(ctx, optarg);
 635                                 break;
 636                         case 'd':
 637                                 delimiter = optarg;
 638                                 break;
 639                         case 'f':
 640                                 if (input != stdin) {
 641                                         perror("uci");
 642                                         return 1;
 643                                 }
 644
 645                                 input = fopen(optarg, "r");
 646                                 if (!input) {
 647                                         perror("uci");
 648                                         return 1;
 649                                 }
 650                                 break;
 651                         case 'L':
 652                                 flags |= CLI_FLAG_NOPLUGINS;
 653                                 break;
 654                         case 'm':
 655                                 flags |= CLI_FLAG_MERGE;
 656                                 break;
 657                         case 's':
 658                                 ctx->flags |= UCI_FLAG_STRICT;
 659                                 break;
 660                         case 'S':
 661                                 ctx->flags &= ~UCI_FLAG_STRICT;
 662                                 ctx->flags |= UCI_FLAG_PERROR;
 663                                 break;
 664                         case 'n':
 665                                 ctx->flags |= UCI_FLAG_EXPORT_NAME;
 666                                 break;
 667                         case 'N':
 668                                 ctx->flags &= ~UCI_FLAG_EXPORT_NAME;
 669                                 break;
 670                         case 'p':
 671                                 uci_add_delta_path(ctx, optarg);
 672                                 break;
 673                         case 'P':
 674                                 uci_add_delta_path(ctx, ctx->savedir);
 675                                 uci_set_savedir(ctx, optarg);
 676                                 flags |= CLI_FLAG_NOCOMMIT;
 677                                 break;
 678                         case 'q':
 679                                 flags |= CLI_FLAG_QUIET;
 680                                 break;
 681                         case 'X':
 682                                 flags &= ~CLI_FLAG_SHOW_EXT;
 683                                 break;
 684                         default:
 685                                 uci_usage();
 686                                 return 0;
 687                 }
 688         }
 689         if (optind > 1)
 690                 argv[optind - 1] = argv[0];
 691         argv += optind - 1;
 692         argc -= optind - 1;
 693
 694         if (argc < 2) {
 695                 uci_usage();
 696                 return 0;
 697         }
 698
 699         if (!(flags & CLI_FLAG_NOPLUGINS))
 700                 uci_load_plugins(ctx, NULL);
 701
 702         ret = uci_cmd(argc - 1, argv + 1);
 703         if (input != stdin)
 704                 fclose(input);
 705
 706         if (ret == 255)
 707                 uci_usage();
 708
 709         uci_free_context(ctx);
 710
 711         return ret;
 712 }