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
 159                 if (h->cmd == UCI_CMD_REMOVE)
 160                         printf("-");
 161                 printf("%s.%s", p->e.name, h->section);
 162                 if (e->name)
 163                         printf(".%s", e->name);
 164                 if (h->cmd != UCI_CMD_REMOVE)
 165                         printf("=%s", h->value);
 166                 printf("\n");
 167         }
 168 }
 169
 170 static int package_cmd(int cmd, char *tuple)
 171 {
 172         struct uci_package *p;
 173         struct uci_section *s;
 174         struct uci_element *e = NULL;
 175
 176         if (uci_lookup_ext(ctx, &e, tuple) != UCI_OK) {
 177                 cli_perror();
 178                 return 1;
 179         }
 180         switch(e->type) {
 181         case UCI_TYPE_PACKAGE:
 182                 p = uci_to_package(e);
 183                 break;
 184         case UCI_TYPE_SECTION:
 185                 s = uci_to_section(e);
 186                 p = s->package;
 187                 break;
 188         case UCI_TYPE_OPTION:
 189                 s = uci_to_option(e)->section;
 190                 p = s->package;
 191                 break;
 192         default:
 193                 return 0;
 194         }
 195
 196         switch(cmd) {
 197         case CMD_CHANGES:
 198                 uci_show_changes(p);
 199                 break;
 200         case CMD_COMMIT:
 201                 if (flags & CLI_FLAG_NOCOMMIT)
 202                         return 0;
 203                 if (uci_commit(ctx, &p, false) != UCI_OK)
 204                         cli_perror();
 205                 break;
 206         case CMD_EXPORT:
 207                 uci_export(ctx, stdout, p, true);
 208                 break;
 209         case CMD_SHOW:
 210                 switch(e->type) {
 211                         case UCI_TYPE_PACKAGE:
 212                                 uci_show_package(p);
 213                                 break;
 214                         case UCI_TYPE_SECTION:
 215                                 uci_show_section(uci_to_section(e));
 216                                 break;
 217                         case UCI_TYPE_OPTION:
 218                                 uci_show_option(uci_to_option(e));
 219                                 break;
 220                         default:
 221                                 /* should not happen */
 222                                 return 1;
 223                 }
 224                 break;
 225         }
 226
 227         uci_unload(ctx, p);
 228         return 0;
 229 }
 230
 231 static int uci_do_import(int argc, char **argv)
 232 {
 233         struct uci_package *package = NULL;
 234         char *name = NULL;
 235         int ret = UCI_OK;
 236         bool merge = false;
 237
 238         if (argc > 2)
 239                 return 255;
 240
 241         if (argc == 2)
 242                 name = argv[1];
 243         else if (flags & CLI_FLAG_MERGE)
 244                 /* need a package to merge */
 245                 return 255;
 246
 247         if (flags & CLI_FLAG_MERGE) {
 248                 if (uci_load(ctx, name, &package) != UCI_OK)
 249                         package = NULL;
 250                 else
 251                         merge = true;
 252         }
 253         ret = uci_import(ctx, input, name, &package, (name != NULL));
 254         if (ret == UCI_OK) {
 255                 if (merge) {
 256                         ret = uci_save(ctx, package);
 257                 } else {
 258                         struct uci_element *e;
 259                         /* loop through all config sections and overwrite existing data */
 260                         uci_foreach_element(&ctx->root, e) {
 261                                 struct uci_package *p = uci_to_package(e);
 262                                 ret = uci_commit(ctx, &p, true);
 263                         }
 264                 }
 265         }
 266
 267         if (ret != UCI_OK) {
 268                 cli_perror();
 269                 return 1;
 270         }
 271
 272         return 0;
 273 }
 274
 275 static int uci_do_package_cmd(int cmd, int argc, char **argv)
 276 {
 277         char **configs = NULL;
 278         char **p;
 279
 280         if (argc > 2)
 281                 return 255;
 282
 283         if (argc == 2)
 284                 return package_cmd(cmd, argv[1]);
 285
 286         if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs) {
 287                 cli_perror();
 288                 return 1;
 289         }
 290
 291         for (p = configs; *p; p++) {
 292                 package_cmd(cmd, *p);
 293         }
 294
 295         return 0;
 296 }
 297
 298 static int uci_do_add(int argc, char **argv)
 299 {
 300         struct uci_package *p = NULL;
 301         struct uci_section *s = NULL;
 302         int ret;
 303
 304         if (argc != 3)
 305                 return 255;
 306
 307         ret = uci_load(ctx, argv[1], &p);
 308         if (ret != UCI_OK)
 309                 goto done;
 310
 311         ret = uci_add_section(ctx, p, argv[2], &s);
 312         if (ret != UCI_OK)
 313                 goto done;
 314
 315         ret = uci_save(ctx, p);
 316
 317 done:
 318         if (ret != UCI_OK)
 319                 cli_perror();
 320         else if (s)
 321                 fprintf(stdout, "%s\n", s->e.name);
 322
 323         return ret;
 324 }
 325
 326 static int uci_do_section_cmd(int cmd, int argc, char **argv)
 327 {
 328         struct uci_package *p = NULL;
 329         struct uci_section *s = NULL;
 330         struct uci_element *e = NULL;
 331         struct uci_option *o = NULL;
 332         char *package = NULL;
 333         char *section = NULL;
 334         char *option = NULL;
 335         char *value = NULL;
 336         int ret = UCI_OK;
 337         char *str;
 338
 339         if (argc != 2)
 340                 return 255;
 341
 342         value = strchr(argv[1], '=');
 343         if (value) {
 344                 *value = 0;
 345                 value++;
 346                 if (!uci_validate_text(value))
 347                         return 1;
 348         }
 349
 350         str = strdup(argv[1]);
 351         if (!str)
 352                 return 1;
 353
 354         if (value && (cmd != CMD_SET) && (cmd != CMD_ADD_LIST) && (cmd != CMD_RENAME))
 355                 return 1;
 356
 357         if (uci_parse_tuple(ctx, str, &package, &section, &option, NULL) != UCI_OK) {
 358                 cli_perror();
 359                 return 1;
 360         }
 361         sprintf(argv[1], "%s.%s", package, section);
 362         free(str);
 363
 364         if (uci_lookup_ext(ctx, &e, argv[1]) != UCI_OK) {
 365                 cli_perror();
 366                 return 1;
 367         }
 368
 369         switch(e->type) {
 370         case UCI_TYPE_PACKAGE:
 371                 p = uci_to_package(e);
 372                 break;
 373         case UCI_TYPE_SECTION:
 374                 s = uci_to_section(e);
 375                 break;
 376         case UCI_TYPE_OPTION:
 377                 option = e->name;
 378                 s = uci_to_option(e)->section;
 379                 break;
 380         default:
 381                 return 1;
 382         }
 383         if (s) {
 384                 section = s->e.name;
 385                 p = s->package;
 386         }
 387
 388         switch(cmd) {
 389         case CMD_GET:
 390                 switch(e->type) {
 391                 case UCI_TYPE_SECTION:
 392                         printf("%s\n", s->type);
 393                         break;
 394                 case UCI_TYPE_OPTION:
 395                         o = uci_to_option(e);
 396                         uci_show_value(o);
 397                         break;
 398                 default:
 399                         break;
 400                 }
 401                 /* throw the value to stdout */
 402                 break;
 403         case CMD_RENAME:
 404                 ret = uci_rename(ctx, p, section, option, value);
 405                 break;
 406         case CMD_REVERT:
 407                 ret = uci_revert(ctx, &p, section, option);
 408                 break;
 409         case CMD_SET:
 410                 ret = uci_set(ctx, p, section, option, value, NULL);
 411                 break;
 412         case CMD_ADD_LIST:
 413                 ret = uci_add_list(ctx, p, section, option, value, NULL);
 414                 break;
 415         case CMD_DEL:
 416                 ret = uci_delete(ctx, p, section, option);
 417                 break;
 418         }
 419
 420         /* no save necessary for get */
 421         if ((cmd == CMD_GET) || (cmd == CMD_REVERT))
 422                 return 0;
 423
 424         /* save changes, but don't commit them yet */
 425         if (ret == UCI_OK)
 426                 ret = uci_save(ctx, p);
 427
 428         if (ret != UCI_OK) {
 429                 cli_perror();
 430                 return 1;
 431         }
 432
 433         return 0;
 434 }
 435
 436 static int uci_batch_cmd(void)
 437 {
 438         char *argv[MAX_ARGS];
 439         char *str = NULL;
 440         int ret = 0;
 441         int i, j;
 442
 443         for(i = 0; i <= MAX_ARGS; i++) {
 444                 if (i == MAX_ARGS) {
 445                         fprintf(stderr, "Too many arguments\n");
 446                         return 1;
 447                 }
 448                 argv[i] = NULL;
 449                 if ((ret = uci_parse_argument(ctx, input, &str, &argv[i])) != UCI_OK) {
 450                         cli_perror();
 451                         i = 0;
 452                         break;
 453                 }
 454                 if (!argv[i][0])
 455                         break;
 456                 argv[i] = strdup(argv[i]);
 457                 if (!argv[i]) {
 458                         perror("uci");
 459                         return 1;
 460                 }
 461         }
 462         argv[i] = NULL;
 463
 464         if (i > 0) {
 465                 if (!strcasecmp(argv[0], "exit"))
 466                         return 254;
 467                 ret = uci_cmd(i, argv);
 468         } else
 469                 return 0;
 470
 471         for (j = 0; j < i; j++) {
 472                 if (argv[j])
 473                         free(argv[j]);
 474         }
 475
 476         return ret;
 477 }
 478
 479 static int uci_batch(void)
 480 {
 481         int ret = 0;
 482
 483         while (!feof(input)) {
 484                 struct uci_element *e, *tmp;
 485
 486                 ret = uci_batch_cmd();
 487                 if (ret == 254)
 488                         return 0;
 489                 else if (ret == 255)
 490                         fprintf(stderr, "Unknown command\n");
 491
 492                 /* clean up */
 493                 uci_foreach_element_safe(&ctx->root, tmp, e) {
 494                         uci_unload(ctx, uci_to_package(e));
 495                 }
 496         }
 497         return 0;
 498 }
 499
 500 static int uci_cmd(int argc, char **argv)
 501 {
 502         int cmd = 0;
 503
 504         if (!strcasecmp(argv[0], "batch") && !(flags & CLI_FLAG_BATCH))
 505                 return uci_batch();
 506         else if (!strcasecmp(argv[0], "show"))
 507                 cmd = CMD_SHOW;
 508         else if (!strcasecmp(argv[0], "changes"))
 509                 cmd = CMD_CHANGES;
 510         else if (!strcasecmp(argv[0], "export"))
 511                 cmd = CMD_EXPORT;
 512         else if (!strcasecmp(argv[0], "commit"))
 513                 cmd = CMD_COMMIT;
 514         else if (!strcasecmp(argv[0], "get"))
 515                 cmd = CMD_GET;
 516         else if (!strcasecmp(argv[0], "set"))
 517                 cmd = CMD_SET;
 518         else if (!strcasecmp(argv[0], "ren") ||
 519                  !strcasecmp(argv[0], "rename"))
 520                 cmd = CMD_RENAME;
 521         else if (!strcasecmp(argv[0], "revert"))
 522                 cmd = CMD_REVERT;
 523         else if (!strcasecmp(argv[0], "del"))
 524                 cmd = CMD_DEL;
 525         else if (!strcasecmp(argv[0], "import"))
 526                 cmd = CMD_IMPORT;
 527         else if (!strcasecmp(argv[0], "help"))
 528                 cmd = CMD_HELP;
 529         else if (!strcasecmp(argv[0], "add"))
 530                 cmd = CMD_ADD;
 531         else if (!strcasecmp(argv[0], "add_list"))
 532                 cmd = CMD_ADD_LIST;
 533         else
 534                 cmd = -1;
 535
 536         switch(cmd) {
 537                 case CMD_ADD_LIST:
 538                 case CMD_GET:
 539                 case CMD_SET:
 540                 case CMD_DEL:
 541                 case CMD_RENAME:
 542                 case CMD_REVERT:
 543                         return uci_do_section_cmd(cmd, argc, argv);
 544                 case CMD_SHOW:
 545                 case CMD_EXPORT:
 546                 case CMD_COMMIT:
 547                 case CMD_CHANGES:
 548                         return uci_do_package_cmd(cmd, argc, argv);
 549                 case CMD_IMPORT:
 550                         return uci_do_import(argc, argv);
 551                 case CMD_ADD:
 552                         return uci_do_add(argc, argv);
 553                 case CMD_HELP:
 554                         uci_usage();
 555                         return 0;
 556                 default:
 557                         return 255;
 558         }
 559 }
 560
 561 int main(int argc, char **argv)
 562 {
 563         int ret;
 564         int c;
 565
 566         appname = argv[0];
 567         input = stdin;
 568         ctx = uci_alloc_context();
 569         if (!ctx) {
 570                 fprintf(stderr, "Out of memory\n");
 571                 return 1;
 572         }
 573
 574         while((c = getopt(argc, argv, "c:d:f:mnNp:P:sSq")) != -1) {
 575                 switch(c) {
 576                         case 'c':
 577                                 uci_set_confdir(ctx, optarg);
 578                                 break;
 579                         case 'd':
 580                                 delimiter = optarg;
 581                                 break;
 582                         case 'f':
 583                                 input = fopen(optarg, "r");
 584                                 if (!input) {
 585                                         perror("uci");
 586                                         return 1;
 587                                 }
 588                                 break;
 589                         case 'm':
 590                                 flags |= CLI_FLAG_MERGE;
 591                                 break;
 592                         case 's':
 593                                 ctx->flags |= UCI_FLAG_STRICT;
 594                                 break;
 595                         case 'S':
 596                                 ctx->flags &= ~UCI_FLAG_STRICT;
 597                                 ctx->flags |= UCI_FLAG_PERROR;
 598                                 break;
 599                         case 'n':
 600                                 ctx->flags |= UCI_FLAG_EXPORT_NAME;
 601                                 break;
 602                         case 'N':
 603                                 ctx->flags &= ~UCI_FLAG_EXPORT_NAME;
 604                                 break;
 605                         case 'p':
 606                                 uci_add_history_path(ctx, optarg);
 607                                 break;
 608                         case 'P':
 609                                 uci_add_history_path(ctx, ctx->savedir);
 610                                 uci_set_savedir(ctx, optarg);
 611                                 flags |= CLI_FLAG_NOCOMMIT;
 612                                 break;
 613                         case 'q':
 614                                 flags |= CLI_FLAG_QUIET;
 615                                 break;
 616                         default:
 617                                 uci_usage();
 618                                 return 0;
 619                 }
 620         }
 621         if (optind > 1)
 622                 argv[optind - 1] = argv[0];
 623         argv += optind - 1;
 624         argc -= optind - 1;
 625
 626         if (argc < 2) {
 627                 uci_usage();
 628                 return 0;
 629         }
 630         ret = uci_cmd(argc - 1, argv + 1);
 631         if (input != stdin)
 632                 fclose(input);
 633         if (ret == 255) {
 634                 uci_usage();
 635                 return 0;
 636         }
 637
 638         uci_free_context(ctx);
 639
 640         return ret;
 641 }