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