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),
34 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 "\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"
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"
163 static void cli_perror(void)
165 if (flags
& CLI_FLAG_QUIET
)
168 uci_perror(ctx
, appname
);
171 static void uci_print_value(FILE *f
, const char *v
)
184 static void uci_show_value(struct uci_option
*o
, bool quote
)
186 struct uci_element
*e
;
191 case UCI_TYPE_STRING
:
193 uci_print_value(stdout
, o
->v
.string
);
195 printf("%s", o
->v
.string
);
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
);
205 uci_print_value(stdout
, e
->name
);
211 printf("<unknown>\n");
216 static void uci_show_option(struct uci_option
*o
, bool quote
)
219 o
->section
->package
->e
.name
,
220 (cur_section_ref
? cur_section_ref
: o
->section
->e
.name
),
222 uci_show_value(o
, quote
);
225 static void uci_show_section(struct uci_section
*s
)
227 struct uci_element
*e
;
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);
239 static void uci_show_package(struct uci_package
*p
)
241 struct uci_element
*e
;
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
);
249 uci_reset_typelist();
252 static void uci_show_changes(struct uci_package
*p
)
254 struct uci_element
*e
;
256 uci_foreach_element(&p
->saved_delta
, e
) {
257 struct uci_delta
*h
= uci_to_delta(e
);
265 case UCI_CMD_LIST_ADD
:
268 case UCI_CMD_LIST_DEL
:
274 printf("%s%s.%s", prefix
, p
->e
.name
, h
->section
);
276 printf(".%s", e
->name
);
277 if (h
->cmd
!= UCI_CMD_REMOVE
) {
279 uci_print_value(stdout
, h
->value
);
285 static int package_cmd(int cmd
, char *tuple
)
287 struct uci_element
*e
= NULL
;
291 if (uci_lookup_ptr(ctx
, &ptr
, tuple
, true) != UCI_OK
) {
299 uci_show_changes(ptr
.p
);
302 if (flags
& CLI_FLAG_NOCOMMIT
) {
306 if (uci_commit(ctx
, &ptr
.p
, false) != UCI_OK
) {
311 uci_export(ctx
, stdout
, ptr
.p
, true);
314 if (!(ptr
.flags
& UCI_LOOKUP_COMPLETE
)) {
315 ctx
->err
= UCI_ERR_NOTFOUND
;
320 case UCI_TYPE_PACKAGE
:
321 uci_show_package(ptr
.p
);
323 case UCI_TYPE_SECTION
:
324 uci_show_section(ptr
.s
);
326 case UCI_TYPE_OPTION
:
327 uci_show_option(ptr
.o
, true);
330 /* should not happen */
338 uci_unload(ctx
, ptr
.p
);
342 static int uci_do_import(int argc
, char **argv
)
344 struct uci_package
*package
= NULL
;
354 else if (flags
& CLI_FLAG_MERGE
)
355 /* need a package to merge */
358 if (flags
& CLI_FLAG_MERGE
) {
359 if (uci_load(ctx
, name
, &package
) != UCI_OK
)
364 ret
= uci_import(ctx
, input
, name
, &package
, (name
!= NULL
));
367 ret
= uci_save(ctx
, package
);
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);
386 static int uci_do_package_cmd(int cmd
, int argc
, char **argv
)
388 char **configs
= NULL
;
396 return package_cmd(cmd
, argv
[1]);
398 if ((uci_list_configs(ctx
, &configs
) != UCI_OK
) || !configs
) {
403 for (p
= configs
; *p
; p
++) {
404 package_cmd(cmd
, *p
);
413 static int uci_do_add(int argc
, char **argv
)
415 struct uci_package
*p
= NULL
;
416 struct uci_section
*s
= NULL
;
422 ret
= uci_load(ctx
, argv
[1], &p
);
426 ret
= uci_add_section(ctx
, p
, argv
[2], &s
);
430 ret
= uci_save(ctx
, p
);
436 fprintf(stdout
, "%s\n", s
->e
.name
);
441 static int uci_do_section_cmd(int cmd
, int argc
, char **argv
)
443 struct uci_element
*e
;
451 if (uci_lookup_ptr(ctx
, &ptr
, argv
[1], true) != UCI_OK
) {
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
))
464 if (!(ptr
.flags
& UCI_LOOKUP_COMPLETE
)) {
465 ctx
->err
= UCI_ERR_NOTFOUND
;
470 case UCI_TYPE_SECTION
:
471 printf("%s\n", ptr
.s
->type
);
473 case UCI_TYPE_OPTION
:
474 uci_show_value(ptr
.o
, false);
479 /* throw the value to stdout */
482 ret
= uci_rename(ctx
, &ptr
);
485 ret
= uci_revert(ctx
, &ptr
);
488 ret
= uci_set(ctx
, &ptr
);
491 ret
= uci_add_list(ctx
, &ptr
);
494 ret
= uci_del_list(ctx
, &ptr
);
497 if (!ptr
.s
|| !ptr
.value
) {
498 ctx
->err
= UCI_ERR_NOTFOUND
;
502 ret
= uci_reorder_section(ctx
, ptr
.s
, strtoul(ptr
.value
, NULL
, 10));
505 if (ptr
.value
&& !sscanf(ptr
.value
, "%d", &dummy
))
507 ret
= uci_delete(ctx
, &ptr
);
511 /* no save necessary for get */
512 if ((cmd
== CMD_GET
) || (cmd
== CMD_REVERT
))
515 /* save changes, but don't commit them yet */
517 ret
= uci_save(ctx
, ptr
.p
);
527 static int uci_batch_cmd(void)
529 char *argv
[MAX_ARGS
+ 2];
534 for(i
= 0; i
<= MAX_ARGS
; i
++) {
536 fprintf(stderr
, "Too many arguments\n");
540 if ((ret
= uci_parse_argument(ctx
, input
, &str
, &argv
[i
])) != UCI_OK
) {
547 argv
[i
] = strdup(argv
[i
]);
556 if (!strcasecmp(argv
[0], "exit"))
558 ret
= uci_cmd(i
, argv
);
562 for (j
= 0; j
< i
; j
++) {
569 static int uci_batch(void)
573 flags
|= CLI_FLAG_BATCH
;
574 while (!feof(input
)) {
575 struct uci_element
*e
, *tmp
;
577 ret
= uci_batch_cmd();
581 fprintf(stderr
, "Unknown command\n");
584 uci_foreach_element_safe(&ctx
->root
, tmp
, e
) {
585 uci_unload(ctx
, uci_to_package(e
));
588 flags
&= ~CLI_FLAG_BATCH
;
593 static int uci_cmd(int argc
, char **argv
)
597 if (!strcasecmp(argv
[0], "batch") && !(flags
& CLI_FLAG_BATCH
))
599 else if (!strcasecmp(argv
[0], "show"))
601 else if (!strcasecmp(argv
[0], "changes"))
603 else if (!strcasecmp(argv
[0], "export"))
605 else if (!strcasecmp(argv
[0], "commit"))
607 else if (!strcasecmp(argv
[0], "get"))
609 else if (!strcasecmp(argv
[0], "set"))
611 else if (!strcasecmp(argv
[0], "ren") ||
612 !strcasecmp(argv
[0], "rename"))
614 else if (!strcasecmp(argv
[0], "revert"))
616 else if (!strcasecmp(argv
[0], "reorder"))
618 else if (!strcasecmp(argv
[0], "del") ||
619 !strcasecmp(argv
[0], "delete"))
621 else if (!strcasecmp(argv
[0], "import"))
623 else if (!strcasecmp(argv
[0], "help"))
625 else if (!strcasecmp(argv
[0], "add"))
627 else if (!strcasecmp(argv
[0], "add_list"))
629 else if (!strcasecmp(argv
[0], "del_list"))
643 return uci_do_section_cmd(cmd
, argc
, argv
);
648 return uci_do_package_cmd(cmd
, argc
, argv
);
650 return uci_do_import(argc
, argv
);
652 return uci_do_add(argc
, argv
);
661 int main(int argc
, char **argv
)
666 flags
= CLI_FLAG_SHOW_EXT
;
669 ctx
= uci_alloc_context();
671 fprintf(stderr
, "Out of memory\n");
675 while((c
= getopt(argc
, argv
, "c:d:f:LmnNp:P:sSqX")) != -1) {
678 uci_set_confdir(ctx
, optarg
);
684 if (input
!= stdin
) {
689 input
= fopen(optarg
, "r");
696 flags
|= CLI_FLAG_MERGE
;
699 ctx
->flags
|= UCI_FLAG_STRICT
;
702 ctx
->flags
&= ~UCI_FLAG_STRICT
;
703 ctx
->flags
|= UCI_FLAG_PERROR
;
706 ctx
->flags
|= UCI_FLAG_EXPORT_NAME
;
709 ctx
->flags
&= ~UCI_FLAG_EXPORT_NAME
;
712 uci_add_delta_path(ctx
, optarg
);
715 uci_add_delta_path(ctx
, ctx
->savedir
);
716 uci_set_savedir(ctx
, optarg
);
717 flags
|= CLI_FLAG_NOCOMMIT
;
720 flags
|= CLI_FLAG_QUIET
;
723 flags
&= ~CLI_FLAG_SHOW_EXT
;
731 argv
[optind
- 1] = argv
[0];
740 ret
= uci_cmd(argc
- 1, argv
+ 1);
747 uci_free_context(ctx
);