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