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