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 } flags;
  31
  32 static FILE *input;
  33
  34 static struct uci_context *ctx;
  35 enum {
  36         /* section cmds */
  37         CMD_GET,
  38         CMD_SET,
  39         CMD_ADD_LIST,
  40         CMD_DEL_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                 "\tdel_list   <config>.<section>.<option>=<string>\n"
 137                 "\tshow       [<config>[.<section>[.<option>]]]\n"
 138                 "\tget        <config>.<section>[.<option>]\n"
 139                 "\tset        <config>.<section>[.<option>]=<value>\n"
 140                 "\tdelete     <config>[.<section>[[.<option>][=<id>]]]\n"
 141                 "\trename     <config>.<section>[.<option>]=<name>\n"
 142                 "\trevert     <config>[.<section>[.<option>]]\n"
 143                 "\treorder    <config>.<section>=<position>\n"
 144                 "\n"
 145                 "Options:\n"
 146                 "\t-c <path>  set the search path for config files (default: /etc/config)\n"
 147                 "\t-d <str>   set the delimiter for list values in uci show\n"
 148                 "\t-f <file>  use <file> as input instead of stdin\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                 case UCI_CMD_LIST_DEL:
 246                         op = "-=";
 247                         break;
 248                 default:
 249                         break;
 250                 }
 251                 printf("%s%s.%s", prefix, p->e.name, h->section);
 252                 if (e->name)
 253                         printf(".%s", e->name);
 254                 if (h->cmd != UCI_CMD_REMOVE)
 255                         printf("%s%s", op, h->value);
 256                 printf("\n");
 257         }
 258 }
 259
 260 static int package_cmd(int cmd, char *tuple)
 261 {
 262         struct uci_element *e = NULL;
 263         struct uci_ptr ptr;
 264         int ret = 0;
 265
 266         if (uci_lookup_ptr(ctx, &ptr, tuple, true) != UCI_OK) {
 267                 cli_perror();
 268                 return 1;
 269         }
 270
 271         e = ptr.last;
 272         switch(cmd) {
 273         case CMD_CHANGES:
 274                 uci_show_changes(ptr.p);
 275                 break;
 276         case CMD_COMMIT:
 277                 if (flags & CLI_FLAG_NOCOMMIT)
 278                         return 0;
 279                 if (uci_commit(ctx, &ptr.p, false) != UCI_OK) {
 280                         cli_perror();
 281                         ret = 1;
 282                 }
 283                 break;
 284         case CMD_EXPORT:
 285                 uci_export(ctx, stdout, ptr.p, true);
 286                 break;
 287         case CMD_SHOW:
 288                 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
 289                         ctx->err = UCI_ERR_NOTFOUND;
 290                         cli_perror();
 291                         ret = 1;
 292                 }
 293                 switch(e->type) {
 294                         case UCI_TYPE_PACKAGE:
 295                                 uci_show_package(ptr.p);
 296                                 break;
 297                         case UCI_TYPE_SECTION:
 298                                 uci_show_section(ptr.s);
 299                                 break;
 300                         case UCI_TYPE_OPTION:
 301                                 uci_show_option(ptr.o);
 302                                 break;
 303                         default:
 304                                 /* should not happen */
 305                                 return 1;
 306                 }
 307                 break;
 308         }
 309
 310         if (ptr.p)
 311                 uci_unload(ctx, ptr.p);
 312         return ret;
 313 }
 314
 315 static int uci_do_import(int argc, char **argv)
 316 {
 317         struct uci_package *package = NULL;
 318         char *name = NULL;
 319         int ret = UCI_OK;
 320         bool merge = false;
 321
 322         if (argc > 2)
 323                 return 255;
 324
 325         if (argc == 2)
 326                 name = argv[1];
 327         else if (flags & CLI_FLAG_MERGE)
 328                 /* need a package to merge */
 329                 return 255;
 330
 331         if (flags & CLI_FLAG_MERGE) {
 332                 if (uci_load(ctx, name, &package) != UCI_OK)
 333                         package = NULL;
 334                 else
 335                         merge = true;
 336         }
 337         ret = uci_import(ctx, input, name, &package, (name != NULL));
 338         if (ret == UCI_OK) {
 339                 if (merge) {
 340                         ret = uci_save(ctx, package);
 341                 } else {
 342                         struct uci_element *e;
 343                         /* loop through all config sections and overwrite existing data */
 344                         uci_foreach_element(&ctx->root, e) {
 345                                 struct uci_package *p = uci_to_package(e);
 346                                 ret = uci_commit(ctx, &p, true);
 347                         }
 348                 }
 349         }
 350
 351         if (ret != UCI_OK) {
 352                 cli_perror();
 353                 return 1;
 354         }
 355
 356         return 0;
 357 }
 358
 359 static int uci_do_package_cmd(int cmd, int argc, char **argv)
 360 {
 361         char **configs = NULL;
 362         char **p;
 363         int ret = 1;
 364
 365         if (argc > 2)
 366                 return 255;
 367
 368         if (argc == 2)
 369                 return package_cmd(cmd, argv[1]);
 370
 371         if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs) {
 372                 cli_perror();
 373                 goto out;
 374         }
 375
 376         for (p = configs; *p; p++) {
 377                 package_cmd(cmd, *p);
 378         }
 379
 380         ret = 0;
 381 out:
 382         free(configs);
 383         return ret;
 384 }
 385
 386 static int uci_do_add(int argc, char **argv)
 387 {
 388         struct uci_package *p = NULL;
 389         struct uci_section *s = NULL;
 390         int ret;
 391
 392         if (argc != 3)
 393                 return 255;
 394
 395         ret = uci_load(ctx, argv[1], &p);
 396         if (ret != UCI_OK)
 397                 goto done;
 398
 399         ret = uci_add_section(ctx, p, argv[2], &s);
 400         if (ret != UCI_OK)
 401                 goto done;
 402
 403         ret = uci_save(ctx, p);
 404
 405 done:
 406         if (ret != UCI_OK)
 407                 cli_perror();
 408         else if (s)
 409                 fprintf(stdout, "%s\n", s->e.name);
 410
 411         return ret;
 412 }
 413
 414 static int uci_do_section_cmd(int cmd, int argc, char **argv)
 415 {
 416         struct uci_element *e;
 417         struct uci_ptr ptr;
 418         int ret = UCI_OK;
 419         int dummy;
 420
 421         if (argc != 2)
 422                 return 255;
 423
 424         if (uci_lookup_ptr(ctx, &ptr, argv[1], true) != UCI_OK) {
 425                 cli_perror();
 426                 return 1;
 427         }
 428
 429         if (ptr.value && (cmd != CMD_SET) && (cmd != CMD_DEL) &&
 430             (cmd != CMD_ADD_LIST) && (cmd != CMD_DEL_LIST) &&
 431             (cmd != CMD_RENAME) && (cmd != CMD_REORDER))
 432                 return 1;
 433
 434         e = ptr.last;
 435         switch(cmd) {
 436         case CMD_GET:
 437                 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
 438                         ctx->err = UCI_ERR_NOTFOUND;
 439                         cli_perror();
 440                         return 1;
 441                 }
 442                 switch(e->type) {
 443                 case UCI_TYPE_SECTION:
 444                         printf("%s\n", ptr.s->type);
 445                         break;
 446                 case UCI_TYPE_OPTION:
 447                         uci_show_value(ptr.o);
 448                         break;
 449                 default:
 450                         break;
 451                 }
 452                 /* throw the value to stdout */
 453                 break;
 454         case CMD_RENAME:
 455                 ret = uci_rename(ctx, &ptr);
 456                 break;
 457         case CMD_REVERT:
 458                 ret = uci_revert(ctx, &ptr);
 459                 break;
 460         case CMD_SET:
 461                 ret = uci_set(ctx, &ptr);
 462                 break;
 463         case CMD_ADD_LIST:
 464                 ret = uci_add_list(ctx, &ptr);
 465                 break;
 466         case CMD_DEL_LIST:
 467                 ret = uci_del_list(ctx, &ptr);
 468                 break;
 469         case CMD_REORDER:
 470                 if (!ptr.s || !ptr.value) {
 471                         ctx->err = UCI_ERR_NOTFOUND;
 472                         cli_perror();
 473                         return 1;
 474                 }
 475                 ret = uci_reorder_section(ctx, ptr.s, strtoul(ptr.value, NULL, 10));
 476                 break;
 477         case CMD_DEL:
 478                 if (ptr.value && !sscanf(ptr.value, "%d", &dummy))
 479                         return 1;
 480                 ret = uci_delete(ctx, &ptr);
 481                 break;
 482         }
 483
 484         /* no save necessary for get */
 485         if ((cmd == CMD_GET) || (cmd == CMD_REVERT))
 486                 return 0;
 487
 488         /* save changes, but don't commit them yet */
 489         if (ret == UCI_OK)
 490                 ret = uci_save(ctx, ptr.p);
 491
 492         if (ret != UCI_OK) {
 493                 cli_perror();
 494                 return 1;
 495         }
 496
 497         return 0;
 498 }
 499
 500 static int uci_batch_cmd(void)
 501 {
 502         char *argv[MAX_ARGS + 2];
 503         char *str = NULL;
 504         int ret = 0;
 505         int i, j;
 506
 507         for(i = 0; i <= MAX_ARGS; i++) {
 508                 if (i == MAX_ARGS) {
 509                         fprintf(stderr, "Too many arguments\n");
 510                         return 1;
 511                 }
 512                 argv[i] = NULL;
 513                 if ((ret = uci_parse_argument(ctx, input, &str, &argv[i])) != UCI_OK) {
 514                         cli_perror();
 515                         i = 0;
 516                         break;
 517                 }
 518                 if (!argv[i][0])
 519                         break;
 520                 argv[i] = strdup(argv[i]);
 521                 if (!argv[i]) {
 522                         perror("uci");
 523                         return 1;
 524                 }
 525         }
 526         argv[i] = NULL;
 527
 528         if (i > 0) {
 529                 if (!strcasecmp(argv[0], "exit"))
 530                         return 254;
 531                 ret = uci_cmd(i, argv);
 532         } else
 533                 return 0;
 534
 535         for (j = 0; j < i; j++) {
 536                 free(argv[j]);
 537         }
 538
 539         return ret;
 540 }
 541
 542 static int uci_batch(void)
 543 {
 544         int ret = 0;
 545
 546         flags |= CLI_FLAG_BATCH;
 547         while (!feof(input)) {
 548                 struct uci_element *e, *tmp;
 549
 550                 ret = uci_batch_cmd();
 551                 if (ret == 254)
 552                         return 0;
 553                 else if (ret == 255)
 554                         fprintf(stderr, "Unknown command\n");
 555
 556                 /* clean up */
 557                 uci_foreach_element_safe(&ctx->root, tmp, e) {
 558                         uci_unload(ctx, uci_to_package(e));
 559                 }
 560         }
 561         flags &= ~CLI_FLAG_BATCH;
 562
 563         return 0;
 564 }
 565
 566 static int uci_cmd(int argc, char **argv)
 567 {
 568         int cmd = 0;
 569
 570         if (!strcasecmp(argv[0], "batch") && !(flags & CLI_FLAG_BATCH))
 571                 return uci_batch();
 572         else if (!strcasecmp(argv[0], "show"))
 573                 cmd = CMD_SHOW;
 574         else if (!strcasecmp(argv[0], "changes"))
 575                 cmd = CMD_CHANGES;
 576         else if (!strcasecmp(argv[0], "export"))
 577                 cmd = CMD_EXPORT;
 578         else if (!strcasecmp(argv[0], "commit"))
 579                 cmd = CMD_COMMIT;
 580         else if (!strcasecmp(argv[0], "get"))
 581                 cmd = CMD_GET;
 582         else if (!strcasecmp(argv[0], "set"))
 583                 cmd = CMD_SET;
 584         else if (!strcasecmp(argv[0], "ren") ||
 585                  !strcasecmp(argv[0], "rename"))
 586                 cmd = CMD_RENAME;
 587         else if (!strcasecmp(argv[0], "revert"))
 588                 cmd = CMD_REVERT;
 589         else if (!strcasecmp(argv[0], "reorder"))
 590                 cmd = CMD_REORDER;
 591         else if (!strcasecmp(argv[0], "del") ||
 592                  !strcasecmp(argv[0], "delete"))
 593                 cmd = CMD_DEL;
 594         else if (!strcasecmp(argv[0], "import"))
 595                 cmd = CMD_IMPORT;
 596         else if (!strcasecmp(argv[0], "help"))
 597                 cmd = CMD_HELP;
 598         else if (!strcasecmp(argv[0], "add"))
 599                 cmd = CMD_ADD;
 600         else if (!strcasecmp(argv[0], "add_list"))
 601                 cmd = CMD_ADD_LIST;
 602         else if (!strcasecmp(argv[0], "del_list"))
 603                 cmd = CMD_DEL_LIST;
 604         else
 605                 cmd = -1;
 606
 607         switch(cmd) {
 608                 case CMD_ADD_LIST:
 609                 case CMD_DEL_LIST:
 610                 case CMD_GET:
 611                 case CMD_SET:
 612                 case CMD_DEL:
 613                 case CMD_RENAME:
 614                 case CMD_REVERT:
 615                 case CMD_REORDER:
 616                         return uci_do_section_cmd(cmd, argc, argv);
 617                 case CMD_SHOW:
 618                 case CMD_EXPORT:
 619                 case CMD_COMMIT:
 620                 case CMD_CHANGES:
 621                         return uci_do_package_cmd(cmd, argc, argv);
 622                 case CMD_IMPORT:
 623                         return uci_do_import(argc, argv);
 624                 case CMD_ADD:
 625                         return uci_do_add(argc, argv);
 626                 case CMD_HELP:
 627                         uci_usage();
 628                         return 0;
 629                 default:
 630                         return 255;
 631         }
 632 }
 633
 634 int main(int argc, char **argv)
 635 {
 636         int ret;
 637         int c;
 638
 639         flags = CLI_FLAG_SHOW_EXT;
 640         appname = argv[0];
 641         input = stdin;
 642         ctx = uci_alloc_context();
 643         if (!ctx) {
 644                 fprintf(stderr, "Out of memory\n");
 645                 return 1;
 646         }
 647
 648         while((c = getopt(argc, argv, "c:d:f:LmnNp:P:sSqX")) != -1) {
 649                 switch(c) {
 650                         case 'c':
 651                                 uci_set_confdir(ctx, optarg);
 652                                 break;
 653                         case 'd':
 654                                 delimiter = optarg;
 655                                 break;
 656                         case 'f':
 657                                 if (input != stdin) {
 658                                         perror("uci");
 659                                         return 1;
 660                                 }
 661
 662                                 input = fopen(optarg, "r");
 663                                 if (!input) {
 664                                         perror("uci");
 665                                         return 1;
 666                                 }
 667                                 break;
 668                         case 'm':
 669                                 flags |= CLI_FLAG_MERGE;
 670                                 break;
 671                         case 's':
 672                                 ctx->flags |= UCI_FLAG_STRICT;
 673                                 break;
 674                         case 'S':
 675                                 ctx->flags &= ~UCI_FLAG_STRICT;
 676                                 ctx->flags |= UCI_FLAG_PERROR;
 677                                 break;
 678                         case 'n':
 679                                 ctx->flags |= UCI_FLAG_EXPORT_NAME;
 680                                 break;
 681                         case 'N':
 682                                 ctx->flags &= ~UCI_FLAG_EXPORT_NAME;
 683                                 break;
 684                         case 'p':
 685                                 uci_add_delta_path(ctx, optarg);
 686                                 break;
 687                         case 'P':
 688                                 uci_add_delta_path(ctx, ctx->savedir);
 689                                 uci_set_savedir(ctx, optarg);
 690                                 flags |= CLI_FLAG_NOCOMMIT;
 691                                 break;
 692                         case 'q':
 693                                 flags |= CLI_FLAG_QUIET;
 694                                 break;
 695                         case 'X':
 696                                 flags &= ~CLI_FLAG_SHOW_EXT;
 697                                 break;
 698                         default:
 699                                 uci_usage();
 700                                 return 0;
 701                 }
 702         }
 703         if (optind > 1)
 704                 argv[optind - 1] = argv[0];
 705         argv += optind - 1;
 706         argc -= optind - 1;
 707
 708         if (argc < 2) {
 709                 uci_usage();
 710                 return 0;
 711         }
 712
 713         ret = uci_cmd(argc - 1, argv + 1);
 714         if (input != stdin)
 715                 fclose(input);
 716
 717         if (ret == 255)
 718                 uci_usage();
 719
 720         uci_free_context(ctx);
 721
 722         return ret;
 723 }