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