cli: enhance "uci show" command on nonexistent sections and options.
[project/uci.git] / cli.c
1 /*
2 * cli - Command Line Interface for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2
7 * as published by the Free Software Foundation
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 */
14 #include <strings.h>
15 #include <string.h>
16 #include <stdlib.h>
17 #include <unistd.h>
18 #include "uci.h"
19
20 #define MAX_ARGS 4 /* max command line arguments for batch mode */
21
22 static const char *delimiter = " ";
23 static const char *appname;
24 static enum {
25 CLI_FLAG_MERGE = (1 << 0),
26 CLI_FLAG_QUIET = (1 << 1),
27 CLI_FLAG_NOCOMMIT = (1 << 2),
28 CLI_FLAG_BATCH = (1 << 3),
29 CLI_FLAG_SHOW_EXT = (1 << 4),
30 } flags;
31
32 static FILE *input;
33
34 static struct uci_context *ctx;
35 enum {
36 /* section cmds */
37 CMD_GET,
38 CMD_SET,
39 CMD_ADD_LIST,
40 CMD_DEL_LIST,
41 CMD_DEL,
42 CMD_RENAME,
43 CMD_REVERT,
44 CMD_REORDER,
45 /* package cmds */
46 CMD_SHOW,
47 CMD_CHANGES,
48 CMD_EXPORT,
49 CMD_COMMIT,
50 /* other cmds */
51 CMD_ADD,
52 CMD_IMPORT,
53 CMD_HELP,
54 };
55
56 struct uci_type_list {
57 unsigned int idx;
58 const char *name;
59 struct uci_type_list *next;
60 };
61
62 static struct uci_type_list *type_list = NULL;
63 static char *typestr = NULL;
64 static const char *cur_section_ref = NULL;
65
66 static int uci_cmd(int argc, char **argv);
67
68 static void
69 uci_reset_typelist(void)
70 {
71 struct uci_type_list *type;
72 while (type_list != NULL) {
73 type = type_list;
74 type_list = type_list->next;
75 free(type);
76 }
77 if (typestr) {
78 free(typestr);
79 typestr = NULL;
80 }
81 cur_section_ref = NULL;
82 }
83
84 static char *
85 uci_lookup_section_ref(struct uci_section *s)
86 {
87 struct uci_type_list *ti = type_list;
88 int maxlen;
89
90 if (!s->anonymous || !(flags & CLI_FLAG_SHOW_EXT))
91 return s->e.name;
92
93 /* look up in section type list */
94 while (ti) {
95 if (strcmp(ti->name, s->type) == 0)
96 break;
97 ti = ti->next;
98 }
99 if (!ti) {
100 ti = malloc(sizeof(struct uci_type_list));
101 if (!ti)
102 return NULL;
103 memset(ti, 0, sizeof(struct uci_type_list));
104 ti->next = type_list;
105 type_list = ti;
106 ti->name = s->type;
107 }
108
109 maxlen = strlen(s->type) + 1 + 2 + 10;
110 if (!typestr) {
111 typestr = malloc(maxlen);
112 } else {
113 typestr = realloc(typestr, maxlen);
114 }
115
116 if (typestr)
117 sprintf(typestr, "@%s[%d]", ti->name, ti->idx);
118
119 ti->idx++;
120
121 return typestr;
122 }
123
124 static void uci_usage(void)
125 {
126 fprintf(stderr,
127 "Usage: %s [<options>] <command> [<arguments>]\n\n"
128 "Commands:\n"
129 "\tbatch\n"
130 "\texport [<config>]\n"
131 "\timport [<config>]\n"
132 "\tchanges [<config>]\n"
133 "\tcommit [<config>]\n"
134 "\tadd <config> <section-type>\n"
135 "\tadd_list <config>.<section>.<option>=<string>\n"
136 "\tdel_list <config>.<section>.<option>=<string>\n"
137 "\tshow [<config>[.<section>[.<option>]]]\n"
138 "\tget <config>.<section>[.<option>]\n"
139 "\tset <config>.<section>[.<option>]=<value>\n"
140 "\tdelete <config>[.<section>[[.<option>][=<id>]]]\n"
141 "\trename <config>.<section>[.<option>]=<name>\n"
142 "\trevert <config>[.<section>[.<option>]]\n"
143 "\treorder <config>.<section>=<position>\n"
144 "\n"
145 "Options:\n"
146 "\t-c <path> set the search path for config files (default: /etc/config)\n"
147 "\t-d <str> set the delimiter for list values in uci show\n"
148 "\t-f <file> use <file> as input instead of stdin\n"
149 "\t-m when importing, merge data into an existing package\n"
150 "\t-n name unnamed sections on export (default)\n"
151 "\t-N don't name unnamed sections\n"
152 "\t-p <path> add a search path for config change files\n"
153 "\t-P <path> add a search path for config change files and use as default\n"
154 "\t-q quiet mode (don't print error messages)\n"
155 "\t-s force strict mode (stop on parser errors, default)\n"
156 "\t-S disable strict mode\n"
157 "\t-X do not use extended syntax on 'show'\n"
158 "\n",
159 appname
160 );
161 }
162
163 static void cli_perror(void)
164 {
165 if (flags & CLI_FLAG_QUIET)
166 return;
167
168 uci_perror(ctx, appname);
169 }
170
171 static void uci_print_value(FILE *f, const char *v)
172 {
173 fprintf(f, "'");
174 while (*v) {
175 if (*v != '\'')
176 fputc(*v, f);
177 else
178 fprintf(f, "'\\''");
179 v++;
180 }
181 fprintf(f, "'");
182 }
183
184 static void uci_show_value(struct uci_option *o, bool quote)
185 {
186 struct uci_element *e;
187 bool sep = false;
188 char *space;
189
190 switch(o->type) {
191 case UCI_TYPE_STRING:
192 if (quote)
193 uci_print_value(stdout, o->v.string);
194 else
195 printf("%s", o->v.string);
196 printf("\n");
197 break;
198 case UCI_TYPE_LIST:
199 uci_foreach_element(&o->v.list, e) {
200 printf("%s", (sep ? delimiter : ""));
201 space = strpbrk(e->name, " \t\r\n");
202 if (!space && !quote)
203 printf("%s", e->name);
204 else
205 uci_print_value(stdout, e->name);
206 sep = true;
207 }
208 printf("\n");
209 break;
210 default:
211 printf("<unknown>\n");
212 break;
213 }
214 }
215
216 static void uci_show_option(struct uci_option *o, bool quote)
217 {
218 printf("%s.%s.%s=",
219 o->section->package->e.name,
220 (cur_section_ref ? cur_section_ref : o->section->e.name),
221 o->e.name);
222 uci_show_value(o, quote);
223 }
224
225 static void uci_show_section(struct uci_section *s)
226 {
227 struct uci_element *e;
228 const char *cname;
229 const char *sname;
230
231 cname = s->package->e.name;
232 sname = (cur_section_ref ? cur_section_ref : s->e.name);
233 printf("%s.%s=%s\n", cname, sname, s->type);
234 uci_foreach_element(&s->options, e) {
235 uci_show_option(uci_to_option(e), true);
236 }
237 }
238
239 static void uci_show_package(struct uci_package *p)
240 {
241 struct uci_element *e;
242
243 uci_reset_typelist();
244 uci_foreach_element( &p->sections, e) {
245 struct uci_section *s = uci_to_section(e);
246 cur_section_ref = uci_lookup_section_ref(s);
247 uci_show_section(s);
248 }
249 uci_reset_typelist();
250 }
251
252 static void uci_show_changes(struct uci_package *p)
253 {
254 struct uci_element *e;
255
256 uci_foreach_element(&p->saved_delta, e) {
257 struct uci_delta *h = uci_to_delta(e);
258 char *prefix = "";
259 char *op = "=";
260
261 switch(h->cmd) {
262 case UCI_CMD_REMOVE:
263 prefix = "-";
264 break;
265 case UCI_CMD_LIST_ADD:
266 op = "+=";
267 break;
268 case UCI_CMD_LIST_DEL:
269 op = "-=";
270 break;
271 default:
272 break;
273 }
274 printf("%s%s.%s", prefix, p->e.name, h->section);
275 if (e->name)
276 printf(".%s", e->name);
277 if (h->cmd != UCI_CMD_REMOVE) {
278 printf("%s", op);
279 uci_print_value(stdout, h->value);
280 }
281 printf("\n");
282 }
283 }
284
285 static int package_cmd(int cmd, char *tuple)
286 {
287 struct uci_element *e = NULL;
288 struct uci_ptr ptr;
289 int ret = 1;
290
291 if (uci_lookup_ptr(ctx, &ptr, tuple, true) != UCI_OK) {
292 cli_perror();
293 return 1;
294 }
295
296 e = ptr.last;
297 switch(cmd) {
298 case CMD_CHANGES:
299 uci_show_changes(ptr.p);
300 break;
301 case CMD_COMMIT:
302 if (flags & CLI_FLAG_NOCOMMIT) {
303 ret = 0;
304 goto out;
305 }
306 if (uci_commit(ctx, &ptr.p, false) != UCI_OK) {
307 cli_perror();
308 }
309 break;
310 case CMD_EXPORT:
311 uci_export(ctx, stdout, ptr.p, true);
312 break;
313 case CMD_SHOW:
314 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
315 ctx->err = UCI_ERR_NOTFOUND;
316 cli_perror();
317 goto out;
318 }
319 switch(e->type) {
320 case UCI_TYPE_PACKAGE:
321 uci_show_package(ptr.p);
322 break;
323 case UCI_TYPE_SECTION:
324 uci_show_section(ptr.s);
325 break;
326 case UCI_TYPE_OPTION:
327 uci_show_option(ptr.o, true);
328 break;
329 default:
330 /* should not happen */
331 goto out;
332 }
333 break;
334 }
335
336 out:
337 if (ptr.p)
338 uci_unload(ctx, ptr.p);
339 return ret;
340 }
341
342 static int uci_do_import(int argc, char **argv)
343 {
344 struct uci_package *package = NULL;
345 char *name = NULL;
346 int ret = UCI_OK;
347 bool merge = false;
348
349 if (argc > 2)
350 return 255;
351
352 if (argc == 2)
353 name = argv[1];
354 else if (flags & CLI_FLAG_MERGE)
355 /* need a package to merge */
356 return 255;
357
358 if (flags & CLI_FLAG_MERGE) {
359 if (uci_load(ctx, name, &package) != UCI_OK)
360 package = NULL;
361 else
362 merge = true;
363 }
364 ret = uci_import(ctx, input, name, &package, (name != NULL));
365 if (ret == UCI_OK) {
366 if (merge) {
367 ret = uci_save(ctx, package);
368 } else {
369 struct uci_element *e;
370 /* loop through all config sections and overwrite existing data */
371 uci_foreach_element(&ctx->root, e) {
372 struct uci_package *p = uci_to_package(e);
373 ret = uci_commit(ctx, &p, true);
374 }
375 }
376 }
377
378 if (ret != UCI_OK) {
379 cli_perror();
380 return 1;
381 }
382
383 return 0;
384 }
385
386 static int uci_do_package_cmd(int cmd, int argc, char **argv)
387 {
388 char **configs = NULL;
389 char **p;
390 int ret = 1;
391
392 if (argc > 2)
393 return 255;
394
395 if (argc == 2)
396 return package_cmd(cmd, argv[1]);
397
398 if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs) {
399 cli_perror();
400 goto out;
401 }
402
403 for (p = configs; *p; p++) {
404 package_cmd(cmd, *p);
405 }
406
407 ret = 0;
408 out:
409 free(configs);
410 return ret;
411 }
412
413 static int uci_do_add(int argc, char **argv)
414 {
415 struct uci_package *p = NULL;
416 struct uci_section *s = NULL;
417 int ret;
418
419 if (argc != 3)
420 return 255;
421
422 ret = uci_load(ctx, argv[1], &p);
423 if (ret != UCI_OK)
424 goto done;
425
426 ret = uci_add_section(ctx, p, argv[2], &s);
427 if (ret != UCI_OK)
428 goto done;
429
430 ret = uci_save(ctx, p);
431
432 done:
433 if (ret != UCI_OK)
434 cli_perror();
435 else if (s)
436 fprintf(stdout, "%s\n", s->e.name);
437
438 return ret;
439 }
440
441 static int uci_do_section_cmd(int cmd, int argc, char **argv)
442 {
443 struct uci_element *e;
444 struct uci_ptr ptr;
445 int ret = UCI_OK;
446 int dummy;
447
448 if (argc != 2)
449 return 255;
450
451 if (uci_lookup_ptr(ctx, &ptr, argv[1], true) != UCI_OK) {
452 cli_perror();
453 return 1;
454 }
455
456 if (ptr.value && (cmd != CMD_SET) && (cmd != CMD_DEL) &&
457 (cmd != CMD_ADD_LIST) && (cmd != CMD_DEL_LIST) &&
458 (cmd != CMD_RENAME) && (cmd != CMD_REORDER))
459 return 1;
460
461 e = ptr.last;
462 switch(cmd) {
463 case CMD_GET:
464 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
465 ctx->err = UCI_ERR_NOTFOUND;
466 cli_perror();
467 return 1;
468 }
469 switch(e->type) {
470 case UCI_TYPE_SECTION:
471 printf("%s\n", ptr.s->type);
472 break;
473 case UCI_TYPE_OPTION:
474 uci_show_value(ptr.o, false);
475 break;
476 default:
477 break;
478 }
479 /* throw the value to stdout */
480 break;
481 case CMD_RENAME:
482 ret = uci_rename(ctx, &ptr);
483 break;
484 case CMD_REVERT:
485 ret = uci_revert(ctx, &ptr);
486 break;
487 case CMD_SET:
488 ret = uci_set(ctx, &ptr);
489 break;
490 case CMD_ADD_LIST:
491 ret = uci_add_list(ctx, &ptr);
492 break;
493 case CMD_DEL_LIST:
494 ret = uci_del_list(ctx, &ptr);
495 break;
496 case CMD_REORDER:
497 if (!ptr.s || !ptr.value) {
498 ctx->err = UCI_ERR_NOTFOUND;
499 cli_perror();
500 return 1;
501 }
502 ret = uci_reorder_section(ctx, ptr.s, strtoul(ptr.value, NULL, 10));
503 break;
504 case CMD_DEL:
505 if (ptr.value && !sscanf(ptr.value, "%d", &dummy))
506 return 1;
507 ret = uci_delete(ctx, &ptr);
508 break;
509 }
510
511 /* no save necessary for get */
512 if ((cmd == CMD_GET) || (cmd == CMD_REVERT))
513 return 0;
514
515 /* save changes, but don't commit them yet */
516 if (ret == UCI_OK)
517 ret = uci_save(ctx, ptr.p);
518
519 if (ret != UCI_OK) {
520 cli_perror();
521 return 1;
522 }
523
524 return 0;
525 }
526
527 static int uci_batch_cmd(void)
528 {
529 char *argv[MAX_ARGS + 2];
530 char *str = NULL;
531 int ret = 0;
532 int i, j;
533
534 for(i = 0; i <= MAX_ARGS; i++) {
535 if (i == MAX_ARGS) {
536 fprintf(stderr, "Too many arguments\n");
537 return 1;
538 }
539 argv[i] = NULL;
540 if ((ret = uci_parse_argument(ctx, input, &str, &argv[i])) != UCI_OK) {
541 cli_perror();
542 i = 0;
543 break;
544 }
545 if (!argv[i][0])
546 break;
547 argv[i] = strdup(argv[i]);
548 if (!argv[i]) {
549 perror("uci");
550 return 1;
551 }
552 }
553 argv[i] = NULL;
554
555 if (i > 0) {
556 if (!strcasecmp(argv[0], "exit"))
557 return 254;
558 ret = uci_cmd(i, argv);
559 } else
560 return 0;
561
562 for (j = 0; j < i; j++) {
563 free(argv[j]);
564 }
565
566 return ret;
567 }
568
569 static int uci_batch(void)
570 {
571 int ret = 0;
572
573 flags |= CLI_FLAG_BATCH;
574 while (!feof(input)) {
575 struct uci_element *e, *tmp;
576
577 ret = uci_batch_cmd();
578 if (ret == 254)
579 return 0;
580 else if (ret == 255)
581 fprintf(stderr, "Unknown command\n");
582
583 /* clean up */
584 uci_foreach_element_safe(&ctx->root, tmp, e) {
585 uci_unload(ctx, uci_to_package(e));
586 }
587 }
588 flags &= ~CLI_FLAG_BATCH;
589
590 return 0;
591 }
592
593 static int uci_cmd(int argc, char **argv)
594 {
595 int cmd = 0;
596
597 if (!strcasecmp(argv[0], "batch") && !(flags & CLI_FLAG_BATCH))
598 return uci_batch();
599 else if (!strcasecmp(argv[0], "show"))
600 cmd = CMD_SHOW;
601 else if (!strcasecmp(argv[0], "changes"))
602 cmd = CMD_CHANGES;
603 else if (!strcasecmp(argv[0], "export"))
604 cmd = CMD_EXPORT;
605 else if (!strcasecmp(argv[0], "commit"))
606 cmd = CMD_COMMIT;
607 else if (!strcasecmp(argv[0], "get"))
608 cmd = CMD_GET;
609 else if (!strcasecmp(argv[0], "set"))
610 cmd = CMD_SET;
611 else if (!strcasecmp(argv[0], "ren") ||
612 !strcasecmp(argv[0], "rename"))
613 cmd = CMD_RENAME;
614 else if (!strcasecmp(argv[0], "revert"))
615 cmd = CMD_REVERT;
616 else if (!strcasecmp(argv[0], "reorder"))
617 cmd = CMD_REORDER;
618 else if (!strcasecmp(argv[0], "del") ||
619 !strcasecmp(argv[0], "delete"))
620 cmd = CMD_DEL;
621 else if (!strcasecmp(argv[0], "import"))
622 cmd = CMD_IMPORT;
623 else if (!strcasecmp(argv[0], "help"))
624 cmd = CMD_HELP;
625 else if (!strcasecmp(argv[0], "add"))
626 cmd = CMD_ADD;
627 else if (!strcasecmp(argv[0], "add_list"))
628 cmd = CMD_ADD_LIST;
629 else if (!strcasecmp(argv[0], "del_list"))
630 cmd = CMD_DEL_LIST;
631 else
632 cmd = -1;
633
634 switch(cmd) {
635 case CMD_ADD_LIST:
636 case CMD_DEL_LIST:
637 case CMD_GET:
638 case CMD_SET:
639 case CMD_DEL:
640 case CMD_RENAME:
641 case CMD_REVERT:
642 case CMD_REORDER:
643 return uci_do_section_cmd(cmd, argc, argv);
644 case CMD_SHOW:
645 case CMD_EXPORT:
646 case CMD_COMMIT:
647 case CMD_CHANGES:
648 return uci_do_package_cmd(cmd, argc, argv);
649 case CMD_IMPORT:
650 return uci_do_import(argc, argv);
651 case CMD_ADD:
652 return uci_do_add(argc, argv);
653 case CMD_HELP:
654 uci_usage();
655 return 0;
656 default:
657 return 255;
658 }
659 }
660
661 int main(int argc, char **argv)
662 {
663 int ret;
664 int c;
665
666 flags = CLI_FLAG_SHOW_EXT;
667 appname = argv[0];
668 input = stdin;
669 ctx = uci_alloc_context();
670 if (!ctx) {
671 fprintf(stderr, "Out of memory\n");
672 return 1;
673 }
674
675 while((c = getopt(argc, argv, "c:d:f:LmnNp:P:sSqX")) != -1) {
676 switch(c) {
677 case 'c':
678 uci_set_confdir(ctx, optarg);
679 break;
680 case 'd':
681 delimiter = optarg;
682 break;
683 case 'f':
684 if (input != stdin) {
685 perror("uci");
686 return 1;
687 }
688
689 input = fopen(optarg, "r");
690 if (!input) {
691 perror("uci");
692 return 1;
693 }
694 break;
695 case 'm':
696 flags |= CLI_FLAG_MERGE;
697 break;
698 case 's':
699 ctx->flags |= UCI_FLAG_STRICT;
700 break;
701 case 'S':
702 ctx->flags &= ~UCI_FLAG_STRICT;
703 ctx->flags |= UCI_FLAG_PERROR;
704 break;
705 case 'n':
706 ctx->flags |= UCI_FLAG_EXPORT_NAME;
707 break;
708 case 'N':
709 ctx->flags &= ~UCI_FLAG_EXPORT_NAME;
710 break;
711 case 'p':
712 uci_add_delta_path(ctx, optarg);
713 break;
714 case 'P':
715 uci_add_delta_path(ctx, ctx->savedir);
716 uci_set_savedir(ctx, optarg);
717 flags |= CLI_FLAG_NOCOMMIT;
718 break;
719 case 'q':
720 flags |= CLI_FLAG_QUIET;
721 break;
722 case 'X':
723 flags &= ~CLI_FLAG_SHOW_EXT;
724 break;
725 default:
726 uci_usage();
727 return 0;
728 }
729 }
730 if (optind > 1)
731 argv[optind - 1] = argv[0];
732 argv += optind - 1;
733 argc -= optind - 1;
734
735 if (argc < 2) {
736 uci_usage();
737 return 0;
738 }
739
740 ret = uci_cmd(argc - 1, argv + 1);
741 if (input != stdin)
742 fclose(input);
743
744 if (ret == 255)
745 uci_usage();
746
747 uci_free_context(ctx);
748
749 return ret;
750 }