2 * cli - Command Line Interface for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
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
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.
20 #define MAX_ARGS 4 /* max command line arguments for batch mode */
22 static const char *delimiter = " ";
23 static const char *appname;
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 CLI_FLAG_NOPLUGINS= (1 << 5),
35 static struct uci_context *ctx;
56 struct uci_type_list {
59 struct uci_type_list *next;
62 static struct uci_type_list *type_list = NULL;
63 static char *typestr = NULL;
64 static const char *cur_section_ref = NULL;
66 static int uci_cmd(int argc, char **argv);
69 uci_reset_typelist(void)
71 struct uci_type_list *type;
72 while (type_list != NULL) {
74 type_list = type_list->next;
81 cur_section_ref = NULL;
85 uci_lookup_section_ref(struct uci_section *s)
87 struct uci_type_list *ti = type_list;
90 if (!s->anonymous || !(flags & CLI_FLAG_SHOW_EXT))
93 /* look up in section type list */
95 if (strcmp(ti->name, s->type) == 0)
100 ti = malloc(sizeof(struct uci_type_list));
103 memset(ti, 0, sizeof(struct uci_type_list));
104 ti->next = type_list;
109 maxlen = strlen(s->type) + 1 + 2 + 10;
111 typestr = malloc(maxlen);
113 typestr = realloc(typestr, maxlen);
117 sprintf(typestr, "@%s[%d]", ti->name, ti->idx);
124 static void uci_usage(void)
127 "Usage: %s [<options>] <command> [<arguments>]\n\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 "\tshow [<config>[.<section>[.<option>]]]\n"
137 "\tget <config>.<section>[.<option>]\n"
138 "\tset <config>.<section>[.<option>]=<value>\n"
139 "\tdelete <config>[.<section[.<option>]]\n"
140 "\trename <config>.<section>[.<option>]=<name>\n"
141 "\trevert <config>[.<section>[.<option>]]\n"
142 "\treorder <config>.<section>=<position>\n"
145 "\t-c <path> set the search path for config files (default: /etc/config)\n"
146 "\t-d <str> set the delimiter for list values in uci show\n"
147 "\t-f <file> use <file> as input instead of stdin\n"
148 "\t-L do not load any plugins\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"
163 static void cli_perror(void)
165 if (flags & CLI_FLAG_QUIET)
168 uci_perror(ctx, appname);
171 static void uci_show_value(struct uci_option *o)
173 struct uci_element *e;
177 case UCI_TYPE_STRING:
178 printf("%s\n", o->v.string);
181 uci_foreach_element(&o->v.list, e) {
182 printf("%s%s", (sep ? delimiter : ""), e->name);
188 printf("<unknown>\n");
193 static void uci_show_option(struct uci_option *o)
196 o->section->package->e.name,
197 (cur_section_ref ? cur_section_ref : o->section->e.name),
202 static void uci_show_section(struct uci_section *s)
204 struct uci_element *e;
208 cname = s->package->e.name;
209 sname = (cur_section_ref ? cur_section_ref : s->e.name);
210 printf("%s.%s=%s\n", cname, sname, s->type);
211 uci_foreach_element(&s->options, e) {
212 uci_show_option(uci_to_option(e));
216 static void uci_show_package(struct uci_package *p)
218 struct uci_element *e;
220 uci_reset_typelist();
221 uci_foreach_element( &p->sections, e) {
222 struct uci_section *s = uci_to_section(e);
223 cur_section_ref = uci_lookup_section_ref(s);
226 uci_reset_typelist();
229 static void uci_show_changes(struct uci_package *p)
231 struct uci_element *e;
233 uci_foreach_element(&p->saved_delta, e) {
234 struct uci_delta *h = uci_to_delta(e);
242 case UCI_CMD_LIST_ADD:
248 printf("%s%s.%s", prefix, p->e.name, h->section);
250 printf(".%s", e->name);
251 if (h->cmd != UCI_CMD_REMOVE)
252 printf("%s%s", op, h->value);
257 static int package_cmd(int cmd, char *tuple)
259 struct uci_element *e = NULL;
262 if (uci_lookup_ptr(ctx, &ptr, tuple, true) != UCI_OK) {
270 uci_show_changes(ptr.p);
273 if (flags & CLI_FLAG_NOCOMMIT)
275 if (uci_commit(ctx, &ptr.p, false) != UCI_OK)
279 uci_export(ctx, stdout, ptr.p, true);
282 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
283 ctx->err = UCI_ERR_NOTFOUND;
288 case UCI_TYPE_PACKAGE:
289 uci_show_package(ptr.p);
291 case UCI_TYPE_SECTION:
292 uci_show_section(ptr.s);
294 case UCI_TYPE_OPTION:
295 uci_show_option(ptr.o);
298 /* should not happen */
304 uci_unload(ctx, ptr.p);
308 static int uci_do_import(int argc, char **argv)
310 struct uci_package *package = NULL;
320 else if (flags & CLI_FLAG_MERGE)
321 /* need a package to merge */
324 if (flags & CLI_FLAG_MERGE) {
325 if (uci_load(ctx, name, &package) != UCI_OK)
330 ret = uci_import(ctx, input, name, &package, (name != NULL));
333 ret = uci_save(ctx, package);
335 struct uci_element *e;
336 /* loop through all config sections and overwrite existing data */
337 uci_foreach_element(&ctx->root, e) {
338 struct uci_package *p = uci_to_package(e);
339 ret = uci_commit(ctx, &p, true);
352 static int uci_do_package_cmd(int cmd, int argc, char **argv)
354 char **configs = NULL;
361 return package_cmd(cmd, argv[1]);
363 if ((uci_list_configs(ctx, &configs) != UCI_OK) || !configs) {
368 for (p = configs; *p; p++) {
369 package_cmd(cmd, *p);
375 static int uci_do_add(int argc, char **argv)
377 struct uci_package *p = NULL;
378 struct uci_section *s = NULL;
384 ret = uci_load(ctx, argv[1], &p);
388 ret = uci_add_section(ctx, p, argv[2], &s);
392 ret = uci_save(ctx, p);
398 fprintf(stdout, "%s\n", s->e.name);
403 static int uci_do_section_cmd(int cmd, int argc, char **argv)
405 struct uci_element *e;
412 if (uci_lookup_ptr(ctx, &ptr, argv[1], true) != UCI_OK) {
417 if (ptr.value && (cmd != CMD_SET) && (cmd != CMD_ADD_LIST) && (cmd != CMD_RENAME) && (cmd != CMD_REORDER))
423 if (!(ptr.flags & UCI_LOOKUP_COMPLETE)) {
424 ctx->err = UCI_ERR_NOTFOUND;
429 case UCI_TYPE_SECTION:
430 printf("%s\n", ptr.s->type);
432 case UCI_TYPE_OPTION:
433 uci_show_value(ptr.o);
438 /* throw the value to stdout */
441 ret = uci_rename(ctx, &ptr);
444 ret = uci_revert(ctx, &ptr);
447 ret = uci_set(ctx, &ptr);
450 ret = uci_add_list(ctx, &ptr);
453 if (!ptr.s || !ptr.value) {
454 ctx->err = UCI_ERR_NOTFOUND;
458 ret = uci_reorder_section(ctx, ptr.s, strtoul(ptr.value, NULL, 10));
461 ret = uci_delete(ctx, &ptr);
465 /* no save necessary for get */
466 if ((cmd == CMD_GET) || (cmd == CMD_REVERT))
469 /* save changes, but don't commit them yet */
471 ret = uci_save(ctx, ptr.p);
481 static int uci_batch_cmd(void)
483 char *argv[MAX_ARGS + 2];
488 for(i = 0; i <= MAX_ARGS; i++) {
490 fprintf(stderr, "Too many arguments\n");
494 if ((ret = uci_parse_argument(ctx, input, &str, &argv[i])) != UCI_OK) {
501 argv[i] = strdup(argv[i]);
510 if (!strcasecmp(argv[0], "exit"))
512 ret = uci_cmd(i, argv);
516 for (j = 0; j < i; j++) {
524 static int uci_batch(void)
528 flags |= CLI_FLAG_BATCH;
529 while (!feof(input)) {
530 struct uci_element *e, *tmp;
532 ret = uci_batch_cmd();
536 fprintf(stderr, "Unknown command\n");
539 uci_foreach_element_safe(&ctx->root, tmp, e) {
540 uci_unload(ctx, uci_to_package(e));
543 flags &= ~CLI_FLAG_BATCH;
548 static int uci_cmd(int argc, char **argv)
552 if (!strcasecmp(argv[0], "batch") && !(flags & CLI_FLAG_BATCH))
554 else if (!strcasecmp(argv[0], "show"))
556 else if (!strcasecmp(argv[0], "changes"))
558 else if (!strcasecmp(argv[0], "export"))
560 else if (!strcasecmp(argv[0], "commit"))
562 else if (!strcasecmp(argv[0], "get"))
564 else if (!strcasecmp(argv[0], "set"))
566 else if (!strcasecmp(argv[0], "ren") ||
567 !strcasecmp(argv[0], "rename"))
569 else if (!strcasecmp(argv[0], "revert"))
571 else if (!strcasecmp(argv[0], "reorder"))
573 else if (!strcasecmp(argv[0], "del") ||
574 !strcasecmp(argv[0], "delete"))
576 else if (!strcasecmp(argv[0], "import"))
578 else if (!strcasecmp(argv[0], "help"))
580 else if (!strcasecmp(argv[0], "add"))
582 else if (!strcasecmp(argv[0], "add_list"))
595 return uci_do_section_cmd(cmd, argc, argv);
600 return uci_do_package_cmd(cmd, argc, argv);
602 return uci_do_import(argc, argv);
604 return uci_do_add(argc, argv);
613 int main(int argc, char **argv)
618 flags = CLI_FLAG_SHOW_EXT;
621 ctx = uci_alloc_context();
623 fprintf(stderr, "Out of memory\n");
627 while((c = getopt(argc, argv, "c:d:f:LmnNp:P:sSqX")) != -1) {
630 uci_set_confdir(ctx, optarg);
636 if (input != stdin) {
641 input = fopen(optarg, "r");
648 flags |= CLI_FLAG_NOPLUGINS;
651 flags |= CLI_FLAG_MERGE;
654 ctx->flags |= UCI_FLAG_STRICT;
657 ctx->flags &= ~UCI_FLAG_STRICT;
658 ctx->flags |= UCI_FLAG_PERROR;
661 ctx->flags |= UCI_FLAG_EXPORT_NAME;
664 ctx->flags &= ~UCI_FLAG_EXPORT_NAME;
667 uci_add_delta_path(ctx, optarg);
670 uci_add_delta_path(ctx, ctx->savedir);
671 uci_set_savedir(ctx, optarg);
672 flags |= CLI_FLAG_NOCOMMIT;
675 flags |= CLI_FLAG_QUIET;
678 flags &= ~CLI_FLAG_SHOW_EXT;
686 argv[optind - 1] = argv[0];
695 if (!(flags & CLI_FLAG_NOPLUGINS))
696 uci_load_plugins(ctx, NULL);
698 ret = uci_cmd(argc - 1, argv + 1);
705 uci_free_context(ctx);