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