blob: 80a13ed5bdc115a4852366fd226d59a3125d54a8 [file] [log] [blame]
Radek Krejcied5acc52019-04-25 15:57:04 +02001/**
2 * @file main_ni.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief libyang's yanglint tool - noninteractive code
5 *
Radek Krejcie9f13b12020-11-09 17:42:04 +01006 * Copyright (c) 2020 CESNET, z.s.p.o.
Radek Krejcied5acc52019-04-25 15:57:04 +02007 *
8 * This source code is licensed under BSD 3-Clause License (the "License").
9 * You may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * https://opensource.org/licenses/BSD-3-Clause
13 */
14
Radek Krejci535ea9f2020-05-29 16:01:05 +020015#define _GNU_SOURCE
Radek Krejcied5acc52019-04-25 15:57:04 +020016
Radek Krejcie9f13b12020-11-09 17:42:04 +010017#include <errno.h>
18#include <getopt.h>
Radek Krejci47fab892020-11-05 17:02:41 +010019#include <stdint.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020020#include <stdio.h>
21#include <stdlib.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020022#include <string.h>
Radek Krejci47fab892020-11-05 17:02:41 +010023#include <strings.h>
Radek Krejcie9f13b12020-11-09 17:42:04 +010024#include <sys/stat.h>
Radek Krejcied5acc52019-04-25 15:57:04 +020025
Radek Krejcied5acc52019-04-25 15:57:04 +020026#include "libyang.h"
27
Radek Krejcie9f13b12020-11-09 17:42:04 +010028#include "common.h"
aPiecek8f0b7882021-05-21 10:18:36 +020029#include "out.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020030#include "tools/config.h"
31
Radek Krejcie9f13b12020-11-09 17:42:04 +010032/**
33 * @brief Context structure to hold and pass variables in a structured form.
34 */
35struct context {
36 /* libyang context for the run */
37 struct ly_ctx *ctx;
Radek Krejci535ea9f2020-05-29 16:01:05 +020038
Radek Krejcie9f13b12020-11-09 17:42:04 +010039 /* prepared output (--output option or stdout by default) */
40 struct ly_out *out;
Radek Krejci535ea9f2020-05-29 16:01:05 +020041
Radek Krejcie9f13b12020-11-09 17:42:04 +010042 struct ly_set searchpaths;
Radek Krejcied5acc52019-04-25 15:57:04 +020043
Radek Krejcie9f13b12020-11-09 17:42:04 +010044 /* options flags */
45 uint8_t list; /* -l option to print list of schemas */
Radek Krejcied5acc52019-04-25 15:57:04 +020046
aPiecek2cfeeae2021-04-21 13:17:34 +020047 /* line length for 'tree' format */
48 size_t line_length; /* --tree-line-length */
49
Radek Krejcie9f13b12020-11-09 17:42:04 +010050 /*
51 * schema
52 */
53 /* set schema modules' features via --feature option (struct schema_features *) */
54 struct ly_set schema_features;
55
56 /* set of loaded schema modules (struct lys_module *) */
57 struct ly_set schema_modules;
58
59 /* options to parse and print schema modules */
60 uint32_t schema_parse_options;
61 uint32_t schema_print_options;
62
63 /* specification of printing schema node subtree, option --schema-node */
64 const char *schema_node_path;
65 const struct lysc_node *schema_node;
66
67 /* value of --format in case of schema format */
68 LYS_OUTFORMAT schema_out_format;
69
70 /*
71 * data
72 */
73 /* various options based on --type option */
Michal Vaskoe0665742021-02-11 11:08:44 +010074 enum lyd_type data_type;
Radek Krejcie9f13b12020-11-09 17:42:04 +010075 uint32_t data_parse_options;
76 uint32_t data_validate_options;
77 uint32_t data_print_options;
78
79 /* flag for --merge option */
80 uint8_t data_merge;
81
82 /* value of --format in case of data format */
83 LYD_FORMAT data_out_format;
84
85 /* input data files (struct cmdline_file *) */
86 struct ly_set data_inputs;
87
Radek Krejcie9f13b12020-11-09 17:42:04 +010088 /* storage for --operational */
89 struct cmdline_file data_operational;
90};
91
92static void
93erase_context(struct context *c)
94{
95 /* data */
96 ly_set_erase(&c->data_inputs, free_cmdline_file);
Radek Krejcie9f13b12020-11-09 17:42:04 +010097 ly_in_free(c->data_operational.in, 1);
98
99 /* schema */
100 ly_set_erase(&c->schema_features, free_features);
101 ly_set_erase(&c->schema_modules, NULL);
102
103 /* context */
104 ly_set_erase(&c->searchpaths, NULL);
105
106 ly_out_free(c->out, NULL, 0);
Radek Krejci90ed21e2021-04-12 14:47:46 +0200107 ly_ctx_destroy(c->ctx);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100108}
109
110static void
111version(void)
112{
113 printf("yanglint %s\n", PROJECT_VERSION);
114}
115
116static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200117help(int shortout)
118{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100119
120 printf("Usage:\n"
121 " yanglint [Options] [-f { yang | yin | info}] <schema>...\n"
122 " Validates the YANG module in <schema>, and all its dependencies.\n\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100123 " yanglint [Options] [-f { xml | json }] <schema>... <file> ...\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100124 " Validates the YANG modeled data in <file> according to the <schema>.\n\n"
125 " yanglint\n"
126 " Starts interactive mode with more features.\n\n");
Radek Krejcied5acc52019-04-25 15:57:04 +0200127
128 if (shortout) {
129 return;
130 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100131 printf("Options:\n"
132 " -h, --help Show this help message and exit.\n"
133 " -v, --version Show version number and exit.\n"
134 " -V, --verbose Show verbose messages, can be used multiple times to\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200135 " increase verbosity.\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100136
Michal Vaskoc40548b2021-09-30 13:05:47 +0200137 printf(" -f FORMAT, --format=FORMAT\n"
138 " Convert input into FORMAT. Supported formats: \n"
139 " yang, yin, tree and info for schemas,\n"
140 " xml, json for data.\n\n");
141
142 printf(" -p PATH, --path=PATH\n"
143 " Search path for schema (YANG/YIN) modules. The option can be\n"
144 " used multiple times. The current working directory and the\n"
145 " path of the module being added is used implicitly.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100146
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200147 printf(" -D, --disable-searchdir\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100148 " Do not implicitly search in current working directory for\n"
149 " schema modules. If specified a second time, do not even\n"
150 " search in the module directory (all modules must be \n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200151 " explicitly specified).\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100152
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200153 printf(" -F FEATURES, --features=FEATURES\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100154 " Features to support, default all.\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200155 " <modname>:[<feature>,]*\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100156
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200157 printf(" -i, --makeimplemented\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100158 " Make the imported modules \"referenced\" from any loaded\n"
159 " module also implemented. If specified a second time, all the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200160 " modules are set implemented.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100161
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200162 printf(" -P PATH, --schema-node=PATH\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100163 " Print only the specified subtree of the schema.\n"
164 " The PATH is the XPath subset mentioned in documentation as\n"
165 " the Path format. The option can be combined with --single-node\n"
166 " option to print information only about the specified node.\n"
167 " -q, --single-node\n"
168 " Supplement to the --schema-node option to print information\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200169 " only about a single node specified as PATH argument.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100170
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200171 printf(" -n, --not-strict\n"
Michal Vasko667ce6b2021-01-25 15:00:27 +0100172 " Do not require strict data parsing (silently skip unknown data),\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200173 " has no effect for schemas.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100174
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200175 printf(" -e, --present Validate only with the schema modules whose data actually\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100176 " exist in the provided input data files. Takes effect only\n"
177 " with the 'data' or 'config' TYPEs. Used to avoid requiring\n"
178 " mandatory nodes from modules which data are not present in the\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200179 " provided input data files.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100180
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200181 printf(" -t TYPE, --type=TYPE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100182 " Specify data tree type in the input data file(s):\n"
183 " data - Complete datastore with status data (default type).\n"
184 " config - Configuration datastore (without status data).\n"
185 " get - Result of the NETCONF <get> operation.\n"
186 " getconfig - Result of the NETCONF <get-config> operation.\n"
187 " edit - Content of the NETCONF <edit-config> operation.\n"
188 " rpc - Content of the NETCONF <rpc> message, defined as YANG's\n"
189 " RPC/Action input statement.\n"
Radek Krejci6784a4e2020-12-09 14:23:05 +0100190 " reply - Reply to the RPC/Action. Note that the reply data are\n"
191 " expected inside a container representing the original\n"
192 " RPC/Action. This is necessary to identify appropriate\n"
193 " data definitions in the schema module.\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100194 " notif - Notification instance (content of the <notification>\n"
Michal Vaskoc40548b2021-09-30 13:05:47 +0200195 " element without <eventTime>).\n\n");
196
197 printf(" -d MODE, --default=MODE\n"
198 " Print data with default values, according to the MODE\n"
199 " (to print attributes, ietf-netconf-with-defaults model\n"
200 " must be loaded):\n"
201 " all - Add missing default nodes.\n"
202 " all-tagged - Add missing default nodes and mark all the default\n"
203 " nodes with the attribute.\n"
204 " trim - Remove all nodes with a default value.\n"
205 " implicit-tagged - Add missing nodes and mark them with the attribute.\n\n");
206
207 printf(" -l, --list Print info about the loaded schemas.\n"
208 " (i - imported module, I - implemented module)\n"
209 " In case the -f option with data encoding is specified,\n"
210 " the list is printed as ietf-yang-library data.\n\n");
211
212 printf(" -L LINE_LENGTH, --tree-line-length=LINE_LENGTH\n"
213 " The limit of the maximum line length on which the 'tree'\n"
214 " format will try to be printed.\n\n");
215
216 printf(" -o OUTFILE, --output=OUTFILE\n"
217 " Write the output to OUTFILE instead of stdout.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100218
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200219 printf(" -O FILE, --operational=FILE\n"
Radek Krejcie9f13b12020-11-09 17:42:04 +0100220 " Provide optional data to extend validation of the 'rpc',\n"
221 " 'reply' or 'notif' TYPEs. The FILE is supposed to contain\n"
222 " the :running configuration datastore and state data\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200223 " (operational datastore) referenced from the RPC/Notification.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100224
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200225 printf(" -m, --merge Merge input data files into a single tree and validate at\n"
226 " once.The option has effect only for 'data' and 'config' TYPEs.\n\n");
Radek Krejcie9f13b12020-11-09 17:42:04 +0100227
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200228 printf(" -y, --yang-library\n"
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100229 " Load and implement internal \"ietf-yang-library\" YANG module.\n"
230 " Note that this module includes definitions of mandatory state\n"
Michal Vasko22e0f3a2021-09-22 12:19:23 +0200231 " data that can result in unexpected data validation errors.\n\n");
Michal Vaskoc40548b2021-09-30 13:05:47 +0200232
233#ifndef NDEBUG
234 printf(" -G GROUPS, --debug=GROUPS\n"
235 " Enable printing of specific debugging message group\n"
236 " (nothing will be printed unless verbosity is set to debug):\n"
237 " <group>[,<group>]* (dict, xpath)\n\n");
238#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200239}
240
Radek Krejcie9f13b12020-11-09 17:42:04 +0100241static void
Radek Krejcied5acc52019-04-25 15:57:04 +0200242libyang_verbclb(LY_LOG_LEVEL level, const char *msg, const char *path)
243{
244 char *levstr;
245
Radek Krejcie9f13b12020-11-09 17:42:04 +0100246 switch (level) {
247 case LY_LLERR:
248 levstr = "err :";
249 break;
250 case LY_LLWRN:
251 levstr = "warn:";
252 break;
253 case LY_LLVRB:
254 levstr = "verb:";
255 break;
256 default:
257 levstr = "dbg :";
258 break;
259 }
260 if (path) {
261 fprintf(stderr, "libyang %s %s (%s)\n", levstr, msg, path);
262 } else {
263 fprintf(stderr, "libyang %s %s\n", levstr, msg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200264 }
265}
266
Radek Krejcie9f13b12020-11-09 17:42:04 +0100267static int
268fill_context_inputs(int argc, char *argv[], struct context *c)
269{
Radek Krejcif53b0d52020-12-03 11:29:24 +0100270 struct ly_in *in;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100271
272 /* process the operational content if any */
273 if (c->data_operational.path) {
274 if (get_input(c->data_operational.path, NULL, &c->data_operational.format, &c->data_operational.in)) {
275 return -1;
276 }
277 }
278
279 for (int i = 0; i < argc - optind; i++) {
280 LYS_INFORMAT format_schema = LYS_IN_UNKNOWN;
281 LYD_FORMAT format_data = LYD_UNKNOWN;
Radek Krejcif53b0d52020-12-03 11:29:24 +0100282 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100283
284 if (get_input(argv[optind + i], &format_schema, &format_data, &in)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100285 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100286 }
287
288 if (format_schema) {
289 LY_ERR ret;
290 uint8_t path_unset = 1; /* flag to unset the path from the searchpaths list (if not already present) */
291 char *dir, *module;
292 const char *fall = "*";
293 const char **features = &fall;
Michal Vasko4de7d072021-07-09 09:13:18 +0200294 struct lys_module *mod;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100295
296 if (parse_schema_path(argv[optind + i], &dir, &module)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100297 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100298 }
299
300 /* add temporarily also the path of the module itself */
301 if (ly_ctx_set_searchdir(c->ctx, dir) == LY_EEXIST) {
302 path_unset = 0;
303 }
304
305 /* get features list for this module */
306 get_features(&c->schema_features, module, &features);
307
308 /* temporary cleanup */
309 free(dir);
310 free(module);
311
312 ret = lys_parse(c->ctx, in, format_schema, features, &mod);
313 ly_ctx_unset_searchdir_last(c->ctx, path_unset);
Radek Krejcif53b0d52020-12-03 11:29:24 +0100314 ly_in_free(in, 1);
315 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100316 if (ret) {
317 YLMSG_E("Processing schema module from %s failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100318 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100319 }
320
321 if (c->schema_out_format) {
322 /* modules will be printed */
323 if (ly_set_add(&c->schema_modules, (void *)mod, 1, NULL)) {
324 YLMSG_E("Storing parsed schema module (%s) for print failed.\n", argv[optind + i]);
Radek Krejcif2afd672020-11-26 12:29:23 +0100325 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100326 }
327 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100328 } else if (format_data) {
Radek Krejci6784a4e2020-12-09 14:23:05 +0100329 if (!fill_cmdline_file(&c->data_inputs, in, argv[optind + i], format_data)) {
Radek Krejcif2afd672020-11-26 12:29:23 +0100330 goto error;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100331 }
Radek Krejcif53b0d52020-12-03 11:29:24 +0100332 in = NULL;
Radek Krejci3329b652020-12-05 23:54:07 +0100333 } else {
334 ly_in_free(in, 1);
335 in = NULL;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100336 }
337 }
338
Radek Krejcie9f13b12020-11-09 17:42:04 +0100339 return 0;
Radek Krejcif2afd672020-11-26 12:29:23 +0100340
341error:
342 ly_in_free(in, 1);
343 return -1;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100344}
345
346/**
347 * @brief Process command line options and store the settings into the context.
348 *
349 * return -1 in case of error;
350 * return 0 in case of success and ready to process
351 * return 1 in case of success, but expect to exit.
Radek Krejcied5acc52019-04-25 15:57:04 +0200352 */
353static int
Radek Krejcie9f13b12020-11-09 17:42:04 +0100354fill_context(int argc, char *argv[], struct context *c)
Radek Krejcied5acc52019-04-25 15:57:04 +0200355{
Radek Krejcie9f13b12020-11-09 17:42:04 +0100356 int ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200357
Radek Krejcie9f13b12020-11-09 17:42:04 +0100358 int opt, opt_index;
Radek Krejcied5acc52019-04-25 15:57:04 +0200359 struct option options[] = {
Radek Krejcied5acc52019-04-25 15:57:04 +0200360 {"help", no_argument, NULL, 'h'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200361 {"version", no_argument, NULL, 'v'},
362 {"verbose", no_argument, NULL, 'V'},
363 {"format", required_argument, NULL, 'f'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100364 {"path", required_argument, NULL, 'p'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200365 {"disable-searchdir", no_argument, NULL, 'D'},
366 {"features", required_argument, NULL, 'F'},
367 {"makeimplemented", no_argument, NULL, 'i'},
Radek Krejcie9f13b12020-11-09 17:42:04 +0100368 {"schema-node", required_argument, NULL, 'P'},
Radek Krejcie1f6d5a2019-11-17 14:03:04 +0800369 {"single-node", no_argument, NULL, 'q'},
Michal Vasko667ce6b2021-01-25 15:00:27 +0100370 {"not-strict", no_argument, NULL, 'n'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200371 {"present", no_argument, NULL, 'e'},
Radek Krejcied5acc52019-04-25 15:57:04 +0200372 {"type", required_argument, NULL, 't'},
Michal Vaskoc40548b2021-09-30 13:05:47 +0200373 {"default", required_argument, NULL, 'd'},
374 {"list", no_argument, NULL, 'l'},
375 {"tree-line-length", required_argument, NULL, 'L'},
376 {"output", required_argument, NULL, 'o'},
377 {"operational", required_argument, NULL, 'O'},
378 {"merge", no_argument, NULL, 'm'},
379 {"yang-library", no_argument, NULL, 'y'},
380#ifndef NDEBUG
381 {"debug", required_argument, NULL, 'G'},
382#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200383 {NULL, 0, NULL, 0}
384 };
Radek Krejcied5acc52019-04-25 15:57:04 +0200385
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100386 uint16_t options_ctx = YL_DEFAULT_CTX_OPTIONS;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100387 uint8_t data_type_set = 0;
388
Michal Vasko667ce6b2021-01-25 15:00:27 +0100389 c->data_parse_options = YL_DEFAULT_DATA_PARSE_OPTIONS;
aPiecek2cfeeae2021-04-21 13:17:34 +0200390 c->line_length = 0;
Michal Vasko667ce6b2021-01-25 15:00:27 +0100391
Radek Krejcied5acc52019-04-25 15:57:04 +0200392#ifndef NDEBUG
Michal Vaskoc40548b2021-09-30 13:05:47 +0200393 while ((opt = getopt_long(argc, argv, "hvVf:p:DF:iP:qnet:d:lL:o:Omy", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200394#else
Michal Vaskoc40548b2021-09-30 13:05:47 +0200395 while ((opt = getopt_long(argc, argv, "hvVf:p:DF:iP:qnet:d:lL:o:OmyG:", options, &opt_index)) != -1) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200396#endif
Radek Krejcied5acc52019-04-25 15:57:04 +0200397 switch (opt) {
Michal Vaskoc40548b2021-09-30 13:05:47 +0200398 case 'h': /* --help */
399 help(0);
400 return 1;
401
402 case 'v': /* --version */
403 version();
404 return 1;
405
406 case 'V': { /* --verbose */
407 LY_LOG_LEVEL verbosity = ly_log_level(LY_LLERR);
408 ly_log_level(verbosity);
409
410 if (verbosity < LY_LLDBG) {
411 ly_log_level(verbosity + 1);
Radek Krejcied5acc52019-04-25 15:57:04 +0200412 }
413 break;
Michal Vaskoc40548b2021-09-30 13:05:47 +0200414 } /* case 'V' */
Radek Krejcie9f13b12020-11-09 17:42:04 +0100415
416 case 'f': /* --format */
417 if (!strcasecmp(optarg, "yang")) {
418 c->schema_out_format = LYS_OUT_YANG;
419 c->data_out_format = 0;
420 } else if (!strcasecmp(optarg, "yin")) {
421 c->schema_out_format = LYS_OUT_YIN;
422 c->data_out_format = 0;
423 } else if (!strcasecmp(optarg, "info")) {
424 c->schema_out_format = LYS_OUT_YANG_COMPILED;
425 c->data_out_format = 0;
426 } else if (!strcasecmp(optarg, "tree")) {
427 c->schema_out_format = LYS_OUT_TREE;
428 c->data_out_format = 0;
429 } else if (!strcasecmp(optarg, "xml")) {
430 c->schema_out_format = 0;
431 c->data_out_format = LYD_XML;
432 } else if (!strcasecmp(optarg, "json")) {
433 c->schema_out_format = 0;
434 c->data_out_format = LYD_JSON;
Radek Krejcied5acc52019-04-25 15:57:04 +0200435 } else {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100436 YLMSG_E("Unknown output format %s\n", optarg);
Radek Krejcied5acc52019-04-25 15:57:04 +0200437 help(1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100438 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200439 }
440 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100441
Michal Vaskoc40548b2021-09-30 13:05:47 +0200442 case 'p': { /* --path */
443 struct stat st;
444
445 if (stat(optarg, &st) == -1) {
446 YLMSG_E("Unable to use search path (%s) - %s.\n", optarg, strerror(errno));
447 return -1;
448 }
449 if (!S_ISDIR(st.st_mode)) {
450 YLMSG_E("Provided search path is not a directory.\n");
451 return -1;
452 }
453
454 if (ly_set_add(&c->searchpaths, optarg, 0, NULL)) {
455 YLMSG_E("Storing searchpath failed.\n");
456 return -1;
457 }
458
459 break;
460 } /* case 'p' */
461
462 case 'D': /* --disable-search */
463 if (options_ctx & LY_CTX_DISABLE_SEARCHDIRS) {
464 YLMSG_W("The -D option specified too many times.\n");
465 }
466 if (options_ctx & LY_CTX_DISABLE_SEARCHDIR_CWD) {
467 options_ctx &= ~LY_CTX_DISABLE_SEARCHDIR_CWD;
468 options_ctx |= LY_CTX_DISABLE_SEARCHDIRS;
469 } else {
470 options_ctx |= LY_CTX_DISABLE_SEARCHDIR_CWD;
471 }
472 break;
473
474 case 'F': /* --features */
475 if (parse_features(optarg, &c->schema_features)) {
476 return -1;
477 }
478 break;
479
480 case 'i': /* --makeimplemented */
481 if (options_ctx & LY_CTX_REF_IMPLEMENTED) {
482 options_ctx &= ~LY_CTX_REF_IMPLEMENTED;
483 options_ctx |= LY_CTX_ALL_IMPLEMENTED;
484 } else {
485 options_ctx |= LY_CTX_REF_IMPLEMENTED;
486 }
487 break;
488
Radek Krejcie9f13b12020-11-09 17:42:04 +0100489 case 'P': /* --schema-node */
490 c->schema_node_path = optarg;
Radek Krejcied5acc52019-04-25 15:57:04 +0200491 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100492
493 case 'q': /* --single-node */
494 c->schema_print_options |= LYS_PRINT_NO_SUBSTMT;
495 break;
496
Michal Vasko667ce6b2021-01-25 15:00:27 +0100497 case 'n': /* --not-strict */
498 c->data_parse_options &= ~LYD_PARSE_STRICT;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100499 break;
500
501 case 'e': /* --present */
502 c->data_validate_options |= LYD_VALIDATE_PRESENT;
503 break;
504
505 case 't': /* --type */
506 if (data_type_set) {
507 YLMSG_E("The data type (-t) cannot be set multiple times.\n");
508 return -1;
509 }
510
511 if (!strcasecmp(optarg, "config")) {
512 c->data_parse_options |= LYD_PARSE_NO_STATE;
Michal Vaskof6bda332021-02-01 08:59:03 +0100513 c->data_validate_options |= LYD_VALIDATE_NO_STATE;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100514 } else if (!strcasecmp(optarg, "get")) {
515 c->data_parse_options |= LYD_PARSE_ONLY;
516 } else if (!strcasecmp(optarg, "getconfig") || !strcasecmp(optarg, "get-config")) {
517 c->data_parse_options |= LYD_PARSE_ONLY | LYD_PARSE_NO_STATE;
518 } else if (!strcasecmp(optarg, "edit")) {
519 c->data_parse_options |= LYD_PARSE_ONLY;
520 } else if (!strcasecmp(optarg, "rpc") || !strcasecmp(optarg, "action")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100521 c->data_type = LYD_TYPE_RPC_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100522 } else if (!strcasecmp(optarg, "reply") || !strcasecmp(optarg, "rpcreply")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100523 c->data_type = LYD_TYPE_REPLY_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100524 } else if (!strcasecmp(optarg, "notif") || !strcasecmp(optarg, "notification")) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +0100525 c->data_type = LYD_TYPE_NOTIF_YANG;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100526 } else if (!strcasecmp(optarg, "data")) {
527 /* default option */
528 } else {
529 YLMSG_E("Unknown data tree type %s\n", optarg);
530 help(1);
531 return -1;
532 }
533
534 data_type_set = 1;
535 break;
536
Michal Vaskoc40548b2021-09-30 13:05:47 +0200537 case 'd': /* --default */
538 if (!strcasecmp(optarg, "all")) {
539 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL;
540 } else if (!strcasecmp(optarg, "all-tagged")) {
541 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_ALL_TAG;
542 } else if (!strcasecmp(optarg, "trim")) {
543 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_TRIM;
544 } else if (!strcasecmp(optarg, "implicit-tagged")) {
545 c->data_print_options = (c->data_print_options & ~LYD_PRINT_WD_MASK) | LYD_PRINT_WD_IMPL_TAG;
546 } else {
547 YLMSG_E("Unknown default mode %s\n", optarg);
548 help(1);
549 return -1;
550 }
551 break;
552
553 case 'l': /* --list */
554 c->list = 1;
555 break;
556
557 case 'L': /* --tree-line-length */
558 c->line_length = atoi(optarg);
559 break;
560
561 case 'o': /* --output */
562 if (c->out) {
563 YLMSG_E("Only a single output can be specified.\n");
564 return -1;
565 } else {
566 if (ly_out_new_filepath(optarg, &c->out)) {
567 YLMSG_E("Unable open output file %s (%s)\n", optarg, strerror(errno));
568 return -1;
569 }
570 }
571 break;
572
Radek Krejcie9f13b12020-11-09 17:42:04 +0100573 case 'O': /* --operational */
574 if (c->data_operational.path) {
575 YLMSG_E("The operational datastore (-O) cannot be set multiple times.\n");
576 return -1;
577 }
578 c->data_operational.path = optarg;
579 break;
580
Radek Krejcie9f13b12020-11-09 17:42:04 +0100581 case 'm': /* --merge */
582 c->data_merge = 1;
583 break;
584
Michal Vaskoc431a0a2021-01-25 14:31:58 +0100585 case 'y': /* --yang-library */
586 options_ctx &= ~LY_CTX_NO_YANGLIBRARY;
587 break;
588
Radek Krejcied5acc52019-04-25 15:57:04 +0200589#ifndef NDEBUG
Radek Krejcie9f13b12020-11-09 17:42:04 +0100590 case 'G': { /* --debug */
591 uint32_t dbg_groups = 0;
592 const char *ptr = optarg;
593
Radek Krejcied5acc52019-04-25 15:57:04 +0200594 while (ptr[0]) {
Radek Krejcif13b87b2020-12-01 22:02:17 +0100595 if (!strncasecmp(ptr, "dict", sizeof "dict" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100596 dbg_groups |= LY_LDGDICT;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100597 ptr += sizeof "dict" - 1;
598 } else if (!strncasecmp(ptr, "xpath", sizeof "xpath" - 1)) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100599 dbg_groups |= LY_LDGXPATH;
Radek Krejcif13b87b2020-12-01 22:02:17 +0100600 ptr += sizeof "xpath" - 1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200601 }
602
603 if (ptr[0]) {
604 if (ptr[0] != ',') {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100605 YLMSG_E("Unknown debug group string \"%s\"\n", optarg);
606 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200607 }
608 ++ptr;
609 }
610 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100611 ly_log_dbg_groups(dbg_groups);
Radek Krejcied5acc52019-04-25 15:57:04 +0200612 break;
Radek Krejcie9f13b12020-11-09 17:42:04 +0100613 } /* case 'G' */
Radek Krejcied5acc52019-04-25 15:57:04 +0200614#endif
Radek Krejcie9f13b12020-11-09 17:42:04 +0100615 } /* switch */
616 }
617
618 /* libyang context */
619 if (ly_ctx_new(NULL, options_ctx, &c->ctx)) {
620 YLMSG_E("Unable to create libyang context.\n");
621 return -1;
622 }
623 for (uint32_t u = 0; u < c->searchpaths.count; ++u) {
624 ly_ctx_set_searchdir(c->ctx, c->searchpaths.objs[u]);
625 }
626
627 /* additional checks for the options combinations */
628 if (!c->list && (optind >= argc)) {
629 help(1);
630 YLMSG_E("Missing <schema> to process.\n");
631 return 1;
632 }
633
634 if (c->data_merge) {
635 if (c->data_type || (c->data_parse_options & LYD_PARSE_ONLY)) {
636 /* switch off the option, incompatible input data type */
637 c->data_merge = 0;
638 } else {
639 /* postpone validation after the merge of all the input data */
640 c->data_parse_options |= LYD_PARSE_ONLY;
Radek Krejcied5acc52019-04-25 15:57:04 +0200641 }
642 }
643
Radek Krejcie9f13b12020-11-09 17:42:04 +0100644 if (c->data_operational.path && !c->data_type) {
645 YLMSG_E("Operational datastore takes effect only with RPCs/Actions/Replies/Notifications input data types.\n");
646 c->data_operational.path = NULL;
Radek Krejcied5acc52019-04-25 15:57:04 +0200647 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100648
aPiecek2cfeeae2021-04-21 13:17:34 +0200649 if ((c->schema_out_format != LYS_OUT_TREE) && c->line_length) {
650 YLMSG_E("--tree-line-length take effect only in case of the tree output format.\n");
651 }
652
Radek Krejcie9f13b12020-11-09 17:42:04 +0100653 /* default output stream */
654 if (!c->out) {
655 if (ly_out_new_file(stdout, &c->out)) {
656 YLMSG_E("Unable to set stdout as output.\n");
657 return -1;
Radek Krejcied5acc52019-04-25 15:57:04 +0200658 }
659 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100660
aPiecek7ac66d52021-05-20 07:54:07 +0200661 if (c->schema_out_format == LYS_OUT_TREE) {
662 /* print tree from lysc_nodes */
663 ly_ctx_set_options(c->ctx, LY_CTX_SET_PRIV_PARSED);
664 }
665
Radek Krejcie9f13b12020-11-09 17:42:04 +0100666 /* process input files provided as standalone command line arguments,
667 * schema modules are parsed and inserted into the context,
668 * data files are just checked and prepared into internal structures for further processing */
669 ret = fill_context_inputs(argc, argv, c);
670 if (ret) {
671 return ret;
672 }
673
674 /* the second batch of checks */
675 if (c->schema_print_options && !c->schema_out_format) {
676 YLMSG_W("Schema printer options specified, but the schema output format is missing.\n");
677 }
678 if (c->schema_parse_options && !c->schema_modules.count) {
679 YLMSG_W("Schema parser options specified, but no schema input file provided.\n");
680 }
681 if (c->data_print_options && !c->data_out_format) {
682 YLMSG_W("data printer options specified, but the data output format is missing.\n");
683 }
Michal Vasko667ce6b2021-01-25 15:00:27 +0100684 if (((c->data_parse_options != YL_DEFAULT_DATA_PARSE_OPTIONS) || c->data_type) && !c->data_inputs.count) {
Radek Krejcie9f13b12020-11-09 17:42:04 +0100685 YLMSG_W("Data parser options specified, but no data input file provided.\n");
686 }
687
688 if (c->schema_node_path) {
689 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 0);
690 if (!c->schema_node) {
691 c->schema_node = lys_find_path(c->ctx, NULL, c->schema_node_path, 1);
692
693 if (!c->schema_node) {
694 YLMSG_E("Invalid schema path.\n");
695 return -1;
696 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200697 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200698 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100699
Radek Krejcie9f13b12020-11-09 17:42:04 +0100700 return 0;
701}
702
703int
704main_ni(int argc, char *argv[])
705{
706 int ret = EXIT_SUCCESS, r;
707 struct context c = {0};
Radek Krejcied5acc52019-04-25 15:57:04 +0200708
709 /* set callback for printing libyang messages */
710 ly_set_log_clb(libyang_verbclb, 1);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100711
712 r = fill_context(argc, argv, &c);
713 if (r < 0) {
714 ret = EXIT_FAILURE;
Radek Krejcied5acc52019-04-25 15:57:04 +0200715 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100716 if (r) {
Radek Krejcied5acc52019-04-25 15:57:04 +0200717 goto cleanup;
718 }
719
Radek Krejcie9f13b12020-11-09 17:42:04 +0100720 /* do the required job - parse, validate, print */
721
722 if (c.list) {
723 /* print the list of schemas */
724 print_list(c.out, c.ctx, c.data_out_format);
Radek Krejci047d64e2020-12-03 12:57:10 +0100725 } else {
726 if (c.schema_out_format) {
727 if (c.schema_node) {
728 ret = lys_print_node(c.out, c.schema_node, c.schema_out_format, 0, c.schema_print_options);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100729 if (ret) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100730 YLMSG_E("Unable to print schema node %s.\n", c.schema_node_path);
Radek Krejcie9f13b12020-11-09 17:42:04 +0100731 goto cleanup;
732 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100733 } else {
734 for (uint32_t u = 0; u < c.schema_modules.count; ++u) {
aPiecek2cfeeae2021-04-21 13:17:34 +0200735 ret = lys_print_module(c.out, (struct lys_module *)c.schema_modules.objs[u], c.schema_out_format,
736 c.line_length, c.schema_print_options);
aPiecek8f0b7882021-05-21 10:18:36 +0200737 /* for YANG Tree Diagrams printing it's more readable to print a blank line between modules. */
738 if ((c.schema_out_format == LYS_OUT_TREE) && (u + 1 < c.schema_modules.count)) {
739 ly_print(c.out, "\n");
740 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100741 if (ret) {
742 YLMSG_E("Unable to print module %s.\n", ((struct lys_module *)c.schema_modules.objs[u])->name);
743 goto cleanup;
744 }
745 }
Radek Krejcie9f13b12020-11-09 17:42:04 +0100746 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200747 }
Radek Krejci047d64e2020-12-03 12:57:10 +0100748
749 /* do the data validation despite the schema was printed */
750 if (c.data_inputs.size) {
751 if (process_data(c.ctx, c.data_type, c.data_merge, c.data_out_format, c.out,
752 c.data_parse_options, c.data_validate_options, c.data_print_options,
Radek Krejci6784a4e2020-12-09 14:23:05 +0100753 &c.data_operational, &c.data_inputs, NULL)) {
Radek Krejci047d64e2020-12-03 12:57:10 +0100754 goto cleanup;
755 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200756 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200757 }
Radek Krejcied5acc52019-04-25 15:57:04 +0200758
759cleanup:
Radek Krejcie9f13b12020-11-09 17:42:04 +0100760 /* cleanup */
761 erase_context(&c);
Radek Krejcied5acc52019-04-25 15:57:04 +0200762
Radek Krejcied5acc52019-04-25 15:57:04 +0200763 return ret;
764}