blob: f237cdfceb9fe604651bafdf85667771fe5c01e7 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file parser_xml.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
4 * @brief XML data parser for libyang
5 *
6 * Copyright (c) 2019 CESNET, z.s.p.o.
7 *
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
Michal Vasko69730152020-10-09 16:30:07 +020015#include <assert.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020016#include <stdint.h>
17#include <stdlib.h>
18#include <string.h>
19
Radek Krejci535ea9f2020-05-29 16:01:05 +020020#include "common.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020021#include "context.h"
Radek Krejci77114102021-03-10 15:21:57 +010022#include "dict.h"
Michal Vaskoafac7822020-10-20 14:22:26 +020023#include "in_internal.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020024#include "log.h"
Radek Krejci7931b192020-06-25 17:05:03 +020025#include "parser_data.h"
26#include "parser_internal.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020027#include "set.h"
Radek Krejci77114102021-03-10 15:21:57 +010028#include "tree.h"
Radek Krejci47fab892020-11-05 17:02:41 +010029#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020030#include "tree_data_internal.h"
31#include "tree_schema.h"
Radek Krejci77114102021-03-10 15:21:57 +010032#include "tree_schema_internal.h"
Michal Vaskocde73ac2019-11-14 16:10:27 +010033#include "validation.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020034#include "xml.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020035
36/**
Michal Vaskob36053d2020-03-26 15:49:30 +010037 * @brief Internal context for XML YANG data parser.
Radek Krejci1798aae2020-07-14 13:26:06 +020038 *
Radek Krejci4f2e3e52021-03-30 14:20:28 +020039 * Note that the structure maps to the ::lyd_ctx which is common for all the data parsers
Radek Krejcie7b95092019-05-15 11:03:07 +020040 */
41struct lyd_xml_ctx {
Radek Krejcif16e2542021-02-17 15:39:23 +010042 const struct lysc_ext_instance *ext; /**< extension instance possibly changing document root context of the data being parsed */
Michal Vaskoe0665742021-02-11 11:08:44 +010043 uint32_t parse_opts; /**< various @ref dataparseroptions. */
44 uint32_t val_opts; /**< various @ref datavalidationoptions. */
Radek Krejci1798aae2020-07-14 13:26:06 +020045 uint32_t int_opts; /**< internal data parser options */
46 uint32_t path_len; /**< used bytes in the path buffer */
47 char path[LYD_PARSER_BUFSIZE]; /**< buffer for the generated path */
Michal Vaskoc43c8ab2021-03-05 13:32:44 +010048 struct ly_set node_when; /**< set of nodes with "when" conditions */
Radek Krejci4f2e3e52021-03-30 14:20:28 +020049 struct ly_set node_exts; /**< set of nodes and extensions connected with a plugin providing own validation callback */
Michal Vasko49c39d82020-11-06 17:20:27 +010050 struct ly_set node_types; /**< set of nodes validated with LY_EINCOMPLETE result */
51 struct ly_set meta_types; /**< set of metadata validated with LY_EINCOMPLETE result */
Radek Krejci1798aae2020-07-14 13:26:06 +020052 struct lyd_node *op_node; /**< if an RPC/action/notification is being parsed, store the pointer to it */
Radek Krejcie7b95092019-05-15 11:03:07 +020053
Radek Krejci1798aae2020-07-14 13:26:06 +020054 /* callbacks */
55 lyd_ctx_free_clb free; /* destructor */
Radek Krejci1798aae2020-07-14 13:26:06 +020056
57 struct lyxml_ctx *xmlctx; /**< XML context */
Radek Krejcie7b95092019-05-15 11:03:07 +020058};
59
Radek Krejci1798aae2020-07-14 13:26:06 +020060void
61lyd_xml_ctx_free(struct lyd_ctx *lydctx)
62{
63 struct lyd_xml_ctx *ctx = (struct lyd_xml_ctx *)lydctx;
64
65 lyd_ctx_free(lydctx);
66 lyxml_ctx_free(ctx->xmlctx);
67 free(ctx);
68}
69
Radek Krejcie7b95092019-05-15 11:03:07 +020070static LY_ERR
Michal Vaskofeca4fb2020-10-05 08:58:40 +020071lydxml_metadata(struct lyd_xml_ctx *lydctx, struct lyd_meta **meta)
Radek Krejcie7b95092019-05-15 11:03:07 +020072{
aPiecek1c4da362021-04-29 14:26:34 +020073 LY_ERR ret = LY_SUCCESS;
Radek Krejci28681fa2019-09-06 13:08:45 +020074 const struct lyxml_ns *ns;
75 struct lys_module *mod;
Michal Vaskob36053d2020-03-26 15:49:30 +010076 const char *name;
77 size_t name_len;
Radek Krejci1798aae2020-07-14 13:26:06 +020078 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
Radek Krejci28681fa2019-09-06 13:08:45 +020079
Michal Vaskob36053d2020-03-26 15:49:30 +010080 *meta = NULL;
Radek Krejci28681fa2019-09-06 13:08:45 +020081
Michal Vaskob36053d2020-03-26 15:49:30 +010082 while (xmlctx->status == LYXML_ATTRIBUTE) {
83 if (!xmlctx->prefix_len) {
Radek Krejci28681fa2019-09-06 13:08:45 +020084 /* in XML, all attributes must be prefixed
85 * TODO exception for NETCONF filters which are supposed to map to the ietf-netconf without prefix */
Michal Vaskoe0665742021-02-11 11:08:44 +010086 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
aPiecek1c4da362021-04-29 14:26:34 +020087 ret = LY_EVALID;
Radek Krejci2efc45b2020-12-22 16:25:44 +010088 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Missing mandatory prefix for XML metadata \"%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +010089 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskob36053d2020-03-26 15:49:30 +010090 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +020091 }
Michal Vaskob36053d2020-03-26 15:49:30 +010092
Radek Krejci28681fa2019-09-06 13:08:45 +020093skip_attr:
Michal Vaskob36053d2020-03-26 15:49:30 +010094 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
95 assert(xmlctx->status == LYXML_ATTR_CONTENT);
96 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejci28681fa2019-09-06 13:08:45 +020097 continue;
98 }
99
100 /* get namespace of the attribute to find its annotation definition */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200101 ns = lyxml_ns_get(&xmlctx->ns, xmlctx->prefix, xmlctx->prefix_len);
Radek Krejci28681fa2019-09-06 13:08:45 +0200102 if (!ns) {
aPiecek1c4da362021-04-29 14:26:34 +0200103 ret = LY_ENOTFOUND;
Michal Vasko52927e22020-03-16 17:26:14 +0100104 /* unknown namespace, XML error */
Radek Krejci422afb12021-03-04 16:38:16 +0100105 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)xmlctx->prefix_len, xmlctx->prefix);
Radek Krejci28681fa2019-09-06 13:08:45 +0200106 goto cleanup;
107 }
Michal Vasko52927e22020-03-16 17:26:14 +0100108 mod = ly_ctx_get_module_implemented_ns(xmlctx->ctx, ns->uri);
Radek Krejci28681fa2019-09-06 13:08:45 +0200109 if (!mod) {
110 /* module is not implemented or not present in the schema */
Michal Vaskoe0665742021-02-11 11:08:44 +0100111 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
aPiecek1c4da362021-04-29 14:26:34 +0200112 ret = LY_ENOTFOUND;
Radek Krejci2efc45b2020-12-22 16:25:44 +0100113 LOGVAL(xmlctx->ctx, LYVE_REFERENCE,
Michal Vasko69730152020-10-09 16:30:07 +0200114 "Unknown (or not implemented) YANG module with namespace \"%s\" for metadata \"%.*s%s%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100115 ns->uri, (int)xmlctx->prefix_len, xmlctx->prefix, xmlctx->prefix_len ? ":" : "",
116 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskob36053d2020-03-26 15:49:30 +0100117 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +0200118 }
119 goto skip_attr;
120 }
121
Michal Vasko60ea6352020-06-29 13:39:39 +0200122 /* remember meta name and get its content */
Michal Vaskob36053d2020-03-26 15:49:30 +0100123 name = xmlctx->name;
124 name_len = xmlctx->name_len;
125 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
126 assert(xmlctx->status == LYXML_ATTR_CONTENT);
127
128 /* create metadata */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200129 ret = lyd_parser_create_meta((struct lyd_ctx *)lydctx, NULL, meta, mod, name, name_len, xmlctx->value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200130 xmlctx->value_len, &xmlctx->dynamic, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA);
Radek Krejci1798aae2020-07-14 13:26:06 +0200131 LY_CHECK_GOTO(ret, cleanup);
Michal Vaskob36053d2020-03-26 15:49:30 +0100132
133 /* next attribute */
134 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejcie7b95092019-05-15 11:03:07 +0200135 }
Michal Vasko52927e22020-03-16 17:26:14 +0100136
Radek Krejcie7b95092019-05-15 11:03:07 +0200137cleanup:
Michal Vaskob36053d2020-03-26 15:49:30 +0100138 if (ret) {
Michal Vasko3a41dff2020-07-15 14:30:28 +0200139 lyd_free_meta_siblings(*meta);
Michal Vaskob36053d2020-03-26 15:49:30 +0100140 *meta = NULL;
Radek Krejci38d85362019-09-05 16:26:38 +0200141 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200142 return ret;
143}
144
Michal Vasko52927e22020-03-16 17:26:14 +0100145static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200146lydxml_attrs(struct lyxml_ctx *xmlctx, struct lyd_attr **attr)
Michal Vasko52927e22020-03-16 17:26:14 +0100147{
148 LY_ERR ret = LY_SUCCESS;
149 const struct lyxml_ns *ns;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100150 void *val_prefix_data;
Radek Krejci8df109d2021-04-23 12:19:08 +0200151 LY_VALUE_FORMAT format;
Radek Krejci1798aae2020-07-14 13:26:06 +0200152 struct lyd_attr *attr2;
Michal Vaskob36053d2020-03-26 15:49:30 +0100153 const char *name, *prefix;
154 size_t name_len, prefix_len;
Michal Vasko52927e22020-03-16 17:26:14 +0100155
156 assert(attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100157 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100158
Michal Vaskob36053d2020-03-26 15:49:30 +0100159 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vasko52927e22020-03-16 17:26:14 +0100160 ns = NULL;
Michal Vaskob36053d2020-03-26 15:49:30 +0100161 if (xmlctx->prefix_len) {
Michal Vasko52927e22020-03-16 17:26:14 +0100162 /* get namespace of the attribute */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200163 ns = lyxml_ns_get(&xmlctx->ns, xmlctx->prefix, xmlctx->prefix_len);
Michal Vasko52927e22020-03-16 17:26:14 +0100164 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +0100165 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)xmlctx->prefix_len, xmlctx->prefix);
Michal Vasko52927e22020-03-16 17:26:14 +0100166 ret = LY_EVALID;
167 goto cleanup;
168 }
169 }
170
171 if (*attr) {
172 attr2 = *attr;
173 } else {
174 attr2 = NULL;
175 }
176
Michal Vaskob36053d2020-03-26 15:49:30 +0100177 /* remember attr prefix, name, and get its content */
178 prefix = xmlctx->prefix;
179 prefix_len = xmlctx->prefix_len;
180 name = xmlctx->name;
181 name_len = xmlctx->name_len;
182 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
183 assert(xmlctx->status == LYXML_ATTR_CONTENT);
184
Michal Vasko52927e22020-03-16 17:26:14 +0100185 /* get value prefixes */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100186 val_prefix_data = NULL;
Radek Krejci8df109d2021-04-23 12:19:08 +0200187 LY_CHECK_GOTO(ret = ly_store_prefix_data(xmlctx->ctx, xmlctx->value, xmlctx->value_len, LY_VALUE_XML,
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100188 &xmlctx->ns, &format, &val_prefix_data), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100189
190 /* attr2 is always changed to the created attribute */
Michal Vasko501af032020-11-11 20:27:44 +0100191 ret = lyd_create_attr(NULL, &attr2, xmlctx->ctx, name, name_len, prefix, prefix_len, ns ? ns->uri : NULL,
192 ns ? strlen(ns->uri) : 0, xmlctx->value, xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100193 LY_CHECK_GOTO(ret, cleanup);
194
195 if (!*attr) {
196 *attr = attr2;
197 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100198
199 /* next attribute */
200 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100201 }
202
203cleanup:
Michal Vaskob36053d2020-03-26 15:49:30 +0100204 if (ret) {
Radek Krejci011e4aa2020-09-04 15:22:31 +0200205 lyd_free_attr_siblings(xmlctx->ctx, *attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100206 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100207 }
Michal Vasko52927e22020-03-16 17:26:14 +0100208 return ret;
209}
210
Michal Vasko44685da2020-03-17 15:38:06 +0100211static LY_ERR
Michal Vaskob36053d2020-03-26 15:49:30 +0100212lydxml_check_list(struct lyxml_ctx *xmlctx, const struct lysc_node *list)
Michal Vasko44685da2020-03-17 15:38:06 +0100213{
Michal Vaskob36053d2020-03-26 15:49:30 +0100214 LY_ERR ret = LY_SUCCESS, r;
215 enum LYXML_PARSER_STATUS next;
Michal Vasko44685da2020-03-17 15:38:06 +0100216 struct ly_set key_set = {0};
217 const struct lysc_node *snode;
Michal Vaskob36053d2020-03-26 15:49:30 +0100218 uint32_t i, parents_count;
Michal Vasko44685da2020-03-17 15:38:06 +0100219
220 assert(list && (list->nodetype == LYS_LIST));
221
222 /* get all keys into a set (keys do not have if-features or anything) */
223 snode = NULL;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100224 while ((snode = lys_getnext(snode, list, NULL, 0)) && (snode->flags & LYS_KEY)) {
Radek Krejci3d92e442020-10-12 12:48:13 +0200225 ret = ly_set_add(&key_set, (void *)snode, 1, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200226 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100227 }
228
Michal Vasko12d809c2021-03-03 16:34:32 +0100229 /* remember parent count */
230 parents_count = xmlctx->elements.count;
231
Michal Vaskob36053d2020-03-26 15:49:30 +0100232 while (xmlctx->status == LYXML_ELEMENT) {
Michal Vasko44685da2020-03-17 15:38:06 +0100233 /* find key definition */
234 for (i = 0; i < key_set.count; ++i) {
235 snode = (const struct lysc_node *)key_set.objs[i];
Michal Vaskob36053d2020-03-26 15:49:30 +0100236 if (!ly_strncmp(snode->name, xmlctx->name, xmlctx->name_len)) {
Michal Vasko44685da2020-03-17 15:38:06 +0100237 break;
238 }
239 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100240 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100241
242 /* skip attributes */
243 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100244 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
245 assert(xmlctx->status == LYXML_ATTR_CONTENT);
246 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100247 }
248
Michal Vaskob36053d2020-03-26 15:49:30 +0100249 assert(xmlctx->status == LYXML_ELEM_CONTENT);
250 if (i < key_set.count) {
251 /* validate the value */
Radek Krejci8df109d2021-04-23 12:19:08 +0200252 r = lys_value_validate(NULL, snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns);
Michal Vaskob36053d2020-03-26 15:49:30 +0100253 if (!r) {
254 /* key with a valid value, remove from the set */
255 ly_set_rm_index(&key_set, i, NULL);
Michal Vasko44685da2020-03-17 15:38:06 +0100256 }
257 }
258
Michal Vaskob36053d2020-03-26 15:49:30 +0100259 /* parser next */
260 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100261
Michal Vaskob36053d2020-03-26 15:49:30 +0100262 /* skip any children, resursively */
Michal Vasko12d809c2021-03-03 16:34:32 +0100263 while (xmlctx->status == LYXML_ELEMENT) {
264 while (parents_count < xmlctx->elements.count) {
265 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
266 }
267 assert(xmlctx->status == LYXML_ELEM_CLOSE);
Michal Vaskob36053d2020-03-26 15:49:30 +0100268 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
269 }
270
271 /* parser next, but do not parse closing element of the list because it would remove its namespaces */
272 assert(xmlctx->status == LYXML_ELEM_CLOSE);
273 LY_CHECK_GOTO(ret = lyxml_ctx_peek(xmlctx, &next), cleanup);
274 if (next != LYXML_ELEM_CLOSE) {
275 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
276 }
Michal Vasko44685da2020-03-17 15:38:06 +0100277 }
278
279 if (key_set.count) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100280 /* some keys are missing/did not validate */
Michal Vasko44685da2020-03-17 15:38:06 +0100281 ret = LY_ENOT;
Michal Vasko44685da2020-03-17 15:38:06 +0100282 }
283
284cleanup:
285 ly_set_erase(&key_set, NULL);
286 return ret;
287}
288
Michal Vasko1bf09392020-03-27 12:38:10 +0100289static LY_ERR
290lydxml_data_skip(struct lyxml_ctx *xmlctx)
291{
292 uint32_t parents_count;
293
294 /* remember current number of parents */
295 parents_count = xmlctx->elements.count;
296
297 /* skip after the content */
298 while (xmlctx->status != LYXML_ELEM_CONTENT) {
299 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
300 }
301 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
302
303 /* skip all children elements, recursively, if any */
304 while (parents_count < xmlctx->elements.count) {
305 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
306 }
307
308 /* close element */
309 assert(xmlctx->status == LYXML_ELEM_CLOSE);
310 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
311
312 return LY_SUCCESS;
313}
314
315static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200316lydxml_data_check_opaq(struct lyd_xml_ctx *lydctx, const struct lysc_node **snode)
Michal Vasko1bf09392020-03-27 12:38:10 +0100317{
318 LY_ERR ret = LY_SUCCESS;
319 enum LYXML_PARSER_STATUS prev_status;
Michal Vasko63f3d842020-07-08 10:10:14 +0200320 const char *prev_current, *pname, *pprefix;
Michal Vasko1bf09392020-03-27 12:38:10 +0100321 size_t pprefix_len, pname_len;
322 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
323
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100324 if (!(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
325 /* only checks specific to opaque nodes */
326 return LY_SUCCESS;
327 }
328
329 if ((*snode)->nodetype & (LYD_NODE_TERM | LYS_LIST)) {
Michal Vasko1bf09392020-03-27 12:38:10 +0100330 /* backup parser */
331 prev_status = xmlctx->status;
332 pprefix = xmlctx->prefix;
333 pprefix_len = xmlctx->prefix_len;
334 pname = xmlctx->name;
335 pname_len = xmlctx->name_len;
Michal Vasko63f3d842020-07-08 10:10:14 +0200336 prev_current = xmlctx->in->current;
Michal Vasko1bf09392020-03-27 12:38:10 +0100337 if ((xmlctx->status == LYXML_ELEM_CONTENT) && xmlctx->dynamic) {
338 /* it was backed up, do not free */
339 xmlctx->dynamic = 0;
340 }
341
342 /* skip attributes */
343 while (xmlctx->status == LYXML_ATTRIBUTE) {
344 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
345 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
346 }
347
348 if ((*snode)->nodetype & LYD_NODE_TERM) {
349 /* value may not be valid in which case we parse it as an opaque node */
Radek Krejci8df109d2021-04-23 12:19:08 +0200350 if (lys_value_validate(NULL, *snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns)) {
Michal Vasko1bf09392020-03-27 12:38:10 +0100351 *snode = NULL;
352 }
353 } else {
354 /* skip content */
355 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
356
357 if (lydxml_check_list(xmlctx, *snode)) {
358 /* invalid list, parse as opaque if it missing/has invalid some keys */
359 *snode = NULL;
360 }
361 }
362
363restore:
364 /* restore parser */
365 if (xmlctx->dynamic) {
366 free((char *)xmlctx->value);
367 }
368 xmlctx->status = prev_status;
369 xmlctx->prefix = pprefix;
370 xmlctx->prefix_len = pprefix_len;
371 xmlctx->name = pname;
372 xmlctx->name_len = pname_len;
Michal Vasko63f3d842020-07-08 10:10:14 +0200373 xmlctx->in->current = prev_current;
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100374 } else if ((*snode)->nodetype & LYD_NODE_INNER) {
375 /* if there is a non-WS value, it cannot be parsed as an inner node */
376 assert(xmlctx->status == LYXML_ELEM_CONTENT);
377 if (!xmlctx->ws_only) {
378 *snode = NULL;
379 }
380
Michal Vasko1bf09392020-03-27 12:38:10 +0100381 }
382
383 return ret;
384}
385
Radek Krejcie7b95092019-05-15 11:03:07 +0200386/**
Michal Vaskoa5da3292020-08-12 13:10:50 +0200387 * @brief Parse XML subtree.
Radek Krejcie7b95092019-05-15 11:03:07 +0200388 *
Michal Vaskob36053d2020-03-26 15:49:30 +0100389 * @param[in] lydctx XML YANG data parser context.
Michal Vaskoe0665742021-02-11 11:08:44 +0100390 * @param[in,out] parent Parent node where the children are inserted. NULL in case of parsing top-level elements.
391 * @param[in,out] first_p Pointer to the first (@p parent or top-level) child. In case there were already some siblings,
392 * this may point to a previously existing node.
393 * @param[in,out] parsed Optional set to add all the parsed siblings into.
Michal Vasko9b368d32020-02-14 13:53:31 +0100394 * @return LY_ERR value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200395 */
396static LY_ERR
Michal Vaskoe0665742021-02-11 11:08:44 +0100397lydxml_subtree_r(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, struct lyd_node **first_p, struct ly_set *parsed)
Radek Krejcie7b95092019-05-15 11:03:07 +0200398{
Michal Vaskob36053d2020-03-26 15:49:30 +0100399 LY_ERR ret = LY_SUCCESS;
Michal Vasko27c4dce2021-03-04 15:50:50 +0100400 const char *prefix, *name, *val;
Michal Vasko1bf09392020-03-27 12:38:10 +0100401 size_t prefix_len, name_len;
Michal Vaskob36053d2020-03-26 15:49:30 +0100402 struct lyxml_ctx *xmlctx;
403 const struct ly_ctx *ctx;
Radek Krejcie7b95092019-05-15 11:03:07 +0200404 const struct lyxml_ns *ns;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200405 struct lyd_meta *meta = NULL;
406 struct lyd_attr *attr = NULL;
Radek Krejcie7b95092019-05-15 11:03:07 +0200407 const struct lysc_node *snode;
408 struct lys_module *mod;
Michal Vasko1bf09392020-03-27 12:38:10 +0100409 uint32_t prev_opts;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200410 struct lyd_node *node = NULL, *anchor;
Michal Vaskofc2cd072021-02-24 13:17:17 +0100411 void *val_prefix_data = NULL;
Radek Krejci8df109d2021-04-23 12:19:08 +0200412 LY_VALUE_FORMAT format;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200413 uint32_t getnext_opts;
Radek Krejcie7b95092019-05-15 11:03:07 +0200414
Michal Vaskoe0665742021-02-11 11:08:44 +0100415 assert(parent || first_p);
416
Michal Vaskob36053d2020-03-26 15:49:30 +0100417 xmlctx = lydctx->xmlctx;
418 ctx = xmlctx->ctx;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100419 getnext_opts = lydctx->int_opts & LYD_INTOPT_REPLY ? LYS_GETNEXT_OUTPUT : 0;
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100420
Michal Vaskoa5da3292020-08-12 13:10:50 +0200421 assert(xmlctx->status == LYXML_ELEMENT);
Radek Krejci1f05b6a2019-07-18 16:15:06 +0200422
Michal Vaskoa5da3292020-08-12 13:10:50 +0200423 /* remember element prefix and name */
424 prefix = xmlctx->prefix;
425 prefix_len = xmlctx->prefix_len;
426 name = xmlctx->name;
427 name_len = xmlctx->name_len;
428
429 /* get the element module */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200430 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200431 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +0100432 LOGVAL(ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200433 ret = LY_EVALID;
434 goto error;
435 }
436 mod = ly_ctx_get_module_implemented_ns(ctx, ns->uri);
437 if (!mod) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100438 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100439 LOGVAL(ctx, LYVE_REFERENCE, "No module with namespace \"%s\" in the context.", ns->uri);
Michal Vasko90932a92020-02-12 14:33:03 +0100440 ret = LY_EVALID;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200441 goto error;
Radek Krejcie7b95092019-05-15 11:03:07 +0200442 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100443 if (!(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
Michal Vaskoa5da3292020-08-12 13:10:50 +0200444 /* skip element with children */
445 LY_CHECK_GOTO(ret = lydxml_data_skip(xmlctx), error);
446 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200447 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200448 }
449
Michal Vaskoa5da3292020-08-12 13:10:50 +0200450 /* parser next */
451 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
Michal Vasko90932a92020-02-12 14:33:03 +0100452
Michal Vaskoa5da3292020-08-12 13:10:50 +0200453 /* get the schema node */
454 snode = NULL;
455 if (mod && (!parent || parent->schema)) {
Radek Krejcif16e2542021-02-17 15:39:23 +0100456 if (!parent && lydctx->ext) {
Radek Krejciba05eab2021-03-10 13:19:29 +0100457 snode = lysc_ext_find_node(lydctx->ext, mod, name, name_len, 0, getnext_opts);
Radek Krejcif16e2542021-02-17 15:39:23 +0100458 } else {
459 snode = lys_find_child(parent ? parent->schema : NULL, mod, name, name_len, 0, getnext_opts);
460 }
Michal Vaskoa5da3292020-08-12 13:10:50 +0200461 if (!snode) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100462 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
463 if (parent) {
Radek Krejci422afb12021-03-04 16:38:16 +0100464 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found as a child of \"%s\" node.",
465 (int)name_len, name, parent->schema->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100466 } else if (lydctx->ext) {
467 if (lydctx->ext->argument) {
Radek Krejci422afb12021-03-04 16:38:16 +0100468 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" %s extension instance.",
469 (int)name_len, name, lydctx->ext->argument, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100470 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100471 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the %s extension instance.",
472 (int)name_len, name, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100473 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100474 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100475 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" module.",
476 (int)name_len, name, mod->name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100477 }
Michal Vaskoa5da3292020-08-12 13:10:50 +0200478 ret = LY_EVALID;
479 goto error;
Michal Vaskoe0665742021-02-11 11:08:44 +0100480 } else if (!(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
Michal Vaskoa5da3292020-08-12 13:10:50 +0200481 /* skip element with children */
482 LY_CHECK_GOTO(ret = lydxml_data_skip(xmlctx), error);
483 return LY_SUCCESS;
484 }
485 } else {
486 /* check that schema node is valid and can be used */
487 LY_CHECK_GOTO(ret = lyd_parser_check_schema((struct lyd_ctx *)lydctx, snode), error);
488 LY_CHECK_GOTO(ret = lydxml_data_check_opaq(lydctx, &snode), error);
489 }
490 }
491
492 /* create metadata/attributes */
493 if (xmlctx->status == LYXML_ATTRIBUTE) {
494 if (snode) {
Michal Vaskofeca4fb2020-10-05 08:58:40 +0200495 ret = lydxml_metadata(lydctx, &meta);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200496 LY_CHECK_GOTO(ret, error);
497 } else {
Michal Vaskoe0665742021-02-11 11:08:44 +0100498 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200499 ret = lydxml_attrs(xmlctx, &attr);
500 LY_CHECK_GOTO(ret, error);
501 }
502 }
503
504 assert(xmlctx->status == LYXML_ELEM_CONTENT);
505 if (!snode) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100506 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200507
508 if (xmlctx->ws_only) {
509 /* ignore WS-only value */
Radek IÅ¡a017270d2021-02-16 10:26:15 +0100510 if (xmlctx->dynamic) {
511 free((char *) xmlctx->value);
512 }
513 xmlctx->dynamic = 0;
514 xmlctx->value = "";
Michal Vaskoa5da3292020-08-12 13:10:50 +0200515 xmlctx->value_len = 0;
Radek Krejci8df109d2021-04-23 12:19:08 +0200516 format = LY_VALUE_XML;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200517 } else {
518 /* get value prefixes */
Radek Krejci8df109d2021-04-23 12:19:08 +0200519 ret = ly_store_prefix_data(xmlctx->ctx, xmlctx->value, xmlctx->value_len, LY_VALUE_XML,
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100520 &xmlctx->ns, &format, &val_prefix_data);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200521 LY_CHECK_GOTO(ret, error);
522 }
523
524 /* create node */
Michal Vasko501af032020-11-11 20:27:44 +0100525 ret = lyd_create_opaq(ctx, name, name_len, prefix, prefix_len, ns->uri, strlen(ns->uri), xmlctx->value,
526 xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data, LYD_HINT_DATA, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200527 LY_CHECK_GOTO(ret, error);
528
529 /* parser next */
530 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
531
532 /* process children */
533 while (xmlctx->status == LYXML_ELEMENT) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100534 ret = lydxml_subtree_r(lydctx, node, lyd_node_child_p(node), NULL);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200535 LY_CHECK_GOTO(ret, error);
536 }
537 } else if (snode->nodetype & LYD_NODE_TERM) {
538 /* create node */
Michal Vasko22df3f02020-08-24 13:29:22 +0200539 LY_CHECK_GOTO(ret = lyd_parser_create_term((struct lyd_ctx *)lydctx, snode, xmlctx->value, xmlctx->value_len,
Radek Krejci8df109d2021-04-23 12:19:08 +0200540 &xmlctx->dynamic, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA, &node), error);
Radek Krejciddace2c2021-01-08 11:30:56 +0100541 LOG_LOCSET(snode, node, NULL, NULL);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200542
543 if (parent && (node->schema->flags & LYS_KEY)) {
544 /* check the key order, the anchor must never be a key */
Michal Vaskoe0665742021-02-11 11:08:44 +0100545 anchor = lyd_insert_get_next_anchor(lyd_child(parent), node);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200546 if (anchor && (anchor->schema->flags & LYS_KEY)) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100547 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100548 LOGVAL(ctx, LYVE_DATA, "Invalid position of the key \"%s\" in a list.", node->schema->name);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200549 ret = LY_EVALID;
550 goto error;
551 } else {
552 LOGWRN(ctx, "Invalid position of the key \"%s\" in a list.", node->schema->name);
553 }
554 }
555 }
556
557 /* parser next */
558 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
559
560 /* no children expected */
561 if (xmlctx->status == LYXML_ELEMENT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100562 LOGVAL(ctx, LYVE_SYNTAX, "Child element \"%.*s\" inside a terminal node \"%s\" found.",
Radek Krejci422afb12021-03-04 16:38:16 +0100563 (int)xmlctx->name_len, xmlctx->name, snode->name);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200564 ret = LY_EVALID;
565 goto error;
566 }
567 } else if (snode->nodetype & LYD_NODE_INNER) {
568 if (!xmlctx->ws_only) {
569 /* value in inner node */
Radek Krejci2efc45b2020-12-22 16:25:44 +0100570 LOGVAL(ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an inner node \"%s\" found.",
Radek Krejci422afb12021-03-04 16:38:16 +0100571 (int)xmlctx->value_len, xmlctx->value, snode->name);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200572 ret = LY_EVALID;
573 goto error;
574 }
575
576 /* create node */
577 ret = lyd_create_inner(snode, &node);
578 LY_CHECK_GOTO(ret, error);
579
Radek Krejciddace2c2021-01-08 11:30:56 +0100580 LOG_LOCSET(snode, node, NULL, NULL);
Radek Krejci2efc45b2020-12-22 16:25:44 +0100581
Michal Vaskoa5da3292020-08-12 13:10:50 +0200582 /* parser next */
583 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
584
585 /* process children */
586 while (xmlctx->status == LYXML_ELEMENT) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100587 ret = lydxml_subtree_r(lydctx, node, lyd_node_child_p(node), NULL);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200588 LY_CHECK_GOTO(ret, error);
589 }
590
591 if (snode->nodetype == LYS_LIST) {
592 /* check all keys exist */
593 LY_CHECK_GOTO(ret = lyd_parse_check_keys(node), error);
594 }
595
Michal Vaskoe0665742021-02-11 11:08:44 +0100596 if (!(lydctx->parse_opts & LYD_PARSE_ONLY)) {
Michal Vaskoa5da3292020-08-12 13:10:50 +0200597 /* new node validation, autodelete CANNOT occur, all nodes are new */
Michal Vaskoe0665742021-02-11 11:08:44 +0100598 ret = lyd_validate_new(lyd_node_child_p(node), snode, NULL, NULL);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200599 LY_CHECK_GOTO(ret, error);
600
601 /* add any missing default children */
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200602 ret = lyd_new_implicit_r(node, lyd_node_child_p(node), NULL, NULL, &lydctx->node_when, &lydctx->node_exts,
603 &lydctx->node_types, (lydctx->val_opts & LYD_VALIDATE_NO_STATE) ? LYD_IMPLICIT_NO_STATE : 0, NULL);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200604 LY_CHECK_GOTO(ret, error);
605 }
606
607 if (snode->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)) {
608 /* rememeber the RPC/action/notification */
609 lydctx->op_node = node;
610 }
611 } else if (snode->nodetype & LYD_NODE_ANY) {
Michal Vasko27c4dce2021-03-04 15:50:50 +0100612 if ((snode->nodetype == LYS_ANYDATA) && !xmlctx->ws_only) {
613 /* value in anydata node, we expect a tree */
614 LOGVAL(ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an anydata node \"%s\" found.",
Radek Krejci422afb12021-03-04 16:38:16 +0100615 (int)xmlctx->value_len < 20 ? xmlctx->value_len : 20, xmlctx->value, snode->name);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200616 ret = LY_EVALID;
617 goto error;
618 }
619
Michal Vasko27c4dce2021-03-04 15:50:50 +0100620 if (!xmlctx->ws_only) {
621 /* use an arbitrary text value for anyxml */
622 lydict_insert(xmlctx->ctx, xmlctx->value, xmlctx->value_len, &val);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200623
Michal Vasko27c4dce2021-03-04 15:50:50 +0100624 /* parser next */
625 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
626
627 /* create node */
628 ret = lyd_create_any(snode, val, LYD_ANYDATA_STRING, 1, &node);
629 LY_CHECK_GOTO(ret, error);
630 } else {
631 /* parser next */
632 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
633
634 /* parse any data tree with correct options */
635 prev_opts = lydctx->parse_opts;
636 lydctx->parse_opts &= ~LYD_PARSE_STRICT;
637 lydctx->parse_opts |= LYD_PARSE_OPAQ;
638 anchor = NULL;
639 while (xmlctx->status == LYXML_ELEMENT) {
640 ret = lydxml_subtree_r(lydctx, NULL, &anchor, NULL);
641 LY_CHECK_ERR_GOTO(ret, lydctx->parse_opts = prev_opts, error);
642 }
643 lydctx->parse_opts = prev_opts;
644
645 /* create node */
646 ret = lyd_create_any(snode, anchor, LYD_ANYDATA_DATATREE, 1, &node);
647 LY_CHECK_GOTO(ret, error);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200648 }
Michal Vaskoa5da3292020-08-12 13:10:50 +0200649 }
650 assert(node);
651
652 /* add/correct flags */
653 if (snode) {
Radek Krejci4f2e3e52021-03-30 14:20:28 +0200654 lyd_parse_set_data_flags(node, &lydctx->node_when, &lydctx->node_exts, &meta, lydctx->parse_opts);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200655 }
656
657 /* parser next */
658 assert(xmlctx->status == LYXML_ELEM_CLOSE);
659 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), error);
660
661 /* add metadata/attributes */
662 if (snode) {
Michal Vasko871a0252020-11-11 18:35:24 +0100663 lyd_insert_meta(node, meta, 0);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200664 } else {
665 lyd_insert_attr(node, attr);
666 }
667
668 /* insert, keep first pointer correct */
Michal Vaskoe0665742021-02-11 11:08:44 +0100669 lyd_insert_node(parent, first_p, node);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200670 while (!parent && (*first_p)->prev->next) {
671 *first_p = (*first_p)->prev;
672 }
673
Michal Vaskoe0665742021-02-11 11:08:44 +0100674 /* rememeber a successfully parsed node */
675 if (parsed) {
676 ly_set_add(parsed, node, 1, NULL);
677 }
678
Radek Krejciddace2c2021-01-08 11:30:56 +0100679 LOG_LOCBACK(node ? 1 : 0, node ? 1 : 0, 0, 0);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200680 return LY_SUCCESS;
681
682error:
Radek Krejciddace2c2021-01-08 11:30:56 +0100683 LOG_LOCBACK(node ? 1 : 0, node ? 1 : 0, 0, 0);
Michal Vasko3a41dff2020-07-15 14:30:28 +0200684 lyd_free_meta_siblings(meta);
Radek Krejci011e4aa2020-09-04 15:22:31 +0200685 lyd_free_attr_siblings(ctx, attr);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200686 lyd_free_tree(node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200687 return ret;
688}
689
Michal Vaskoe0665742021-02-11 11:08:44 +0100690/**
691 * @brief Parse a specific XML element into an opaque node.
692 *
693 * @param[in] xmlctx XML parser context.
694 * @param[in] name Name of the element.
695 * @param[in] uri URI of the element.
696 * @param[in] value Whether a value is expected in the element.
697 * @param[out] evnp Parsed envelope (opaque node).
698 * @return LY_SUCCESS on success.
699 * @return LY_ENOT if the specified element did not match.
700 * @return LY_ERR value on error.
701 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100702static LY_ERR
Michal Vaskoe0665742021-02-11 11:08:44 +0100703lydxml_envelope(struct lyxml_ctx *xmlctx, const char *name, const char *uri, ly_bool value, struct lyd_node **envp)
Michal Vasko1bf09392020-03-27 12:38:10 +0100704{
Michal Vaskoe0665742021-02-11 11:08:44 +0100705 LY_ERR rc = LY_SUCCESS;
706 const struct lyxml_ns *ns;
Radek Krejci1798aae2020-07-14 13:26:06 +0200707 struct lyd_attr *attr = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +0100708 const char *prefix;
709 size_t prefix_len;
710
Michal Vasko1bf09392020-03-27 12:38:10 +0100711 assert(xmlctx->status == LYXML_ELEMENT);
712 if (ly_strncmp(name, xmlctx->name, xmlctx->name_len)) {
713 /* not the expected element */
Michal Vaskoe0665742021-02-11 11:08:44 +0100714 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100715 }
716
717 prefix = xmlctx->prefix;
718 prefix_len = xmlctx->prefix_len;
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200719 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa8edff02020-03-27 14:47:01 +0100720 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +0100721 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +0100722 return LY_EVALID;
723 } else if (strcmp(ns->uri, uri)) {
724 /* different namespace */
725 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100726 }
727
728 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
729
730 /* create attributes */
731 if (xmlctx->status == LYXML_ATTRIBUTE) {
732 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
733 }
734
Michal Vaskoe0665742021-02-11 11:08:44 +0100735 assert(xmlctx->status == LYXML_ELEM_CONTENT);
736 if (!value && !xmlctx->ws_only) {
737 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected value \"%.*s\" in the \"%s\" element.",
Radek Krejci422afb12021-03-04 16:38:16 +0100738 (int)xmlctx->value_len, xmlctx->value, name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100739 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100740 goto cleanup;
Michal Vaskoe0665742021-02-11 11:08:44 +0100741 }
Michal Vaskoa8edff02020-03-27 14:47:01 +0100742
743 /* create node */
Michal Vaskoe0665742021-02-11 11:08:44 +0100744 rc = lyd_create_opaq(xmlctx->ctx, name, strlen(name), prefix, prefix_len, uri, strlen(uri), xmlctx->value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200745 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +0100746 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +0100747
748 /* assign atributes */
Michal Vaskoe0665742021-02-11 11:08:44 +0100749 ((struct lyd_node_opaq *)(*envp))->attr = attr;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100750 attr = NULL;
751
Michal Vaskoe0665742021-02-11 11:08:44 +0100752 /* parser next element */
753 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +0100754
Michal Vaskoe0665742021-02-11 11:08:44 +0100755cleanup:
756 lyd_free_attr_siblings(xmlctx->ctx, attr);
757 if (rc) {
758 lyd_free_tree(*envp);
759 *envp = NULL;
760 }
761 return rc;
762}
763
764/**
765 * @brief Parse all expected non-data XML elements of a NETCONF rpc message.
766 *
767 * @param[in] xmlctx XML parser context.
768 * @param[out] evnp Parsed envelope(s) (opaque node).
769 * @param[out] int_opts Internal options for parsing the rest of YANG data.
770 * @param[out] close_elem Number of parsed opened elements that need to be closed.
771 * @return LY_SUCCESS on success.
772 * @return LY_ERR value on error.
773 */
774static LY_ERR
775lydxml_env_netconf_rpc(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
776{
777 LY_ERR rc = LY_SUCCESS, r;
778 struct lyd_node *child;
779
780 assert(envp && !*envp);
781
782 /* parse "rpc" */
783 r = lydxml_envelope(xmlctx, "rpc", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +0100784 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
785
786 /* parse "action", if any */
787 r = lydxml_envelope(xmlctx, "action", "urn:ietf:params:xml:ns:yang:1", 0, &child);
788 if (r == LY_SUCCESS) {
789 /* insert */
790 lyd_insert_node(*envp, NULL, child);
791
792 /* NETCONF action */
793 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_ACTION;
794 *close_elem = 2;
795 } else if (r == LY_ENOT) {
796 /* NETCONF RPC */
797 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_RPC;
798 *close_elem = 1;
799 } else {
800 rc = r;
801 goto cleanup;
802 }
803
804cleanup:
805 if (rc) {
806 lyd_free_tree(*envp);
807 *envp = NULL;
808 }
809 return rc;
810}
811
812/**
813 * @brief Parse all expected non-data XML elements of a NETCONF notification message.
814 *
815 * @param[in] xmlctx XML parser context.
816 * @param[out] evnp Parsed envelope(s) (opaque node).
817 * @param[out] int_opts Internal options for parsing the rest of YANG data.
818 * @param[out] close_elem Number of parsed opened elements that need to be closed.
819 * @return LY_SUCCESS on success.
820 * @return LY_ERR value on error.
821 */
822static LY_ERR
823lydxml_env_netconf_notif(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
824{
825 LY_ERR rc = LY_SUCCESS, r;
826 struct lyd_node *child;
827
828 assert(envp && !*envp);
829
830 /* parse "notification" */
831 r = lydxml_envelope(xmlctx, "notification", "urn:ietf:params:xml:ns:netconf:notification:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +0100832 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
833
834 /* parse "eventTime" */
835 r = lydxml_envelope(xmlctx, "eventTime", "urn:ietf:params:xml:ns:netconf:notification:1.0", 1, &child);
836 if (r == LY_ENOT) {
Radek Krejci422afb12021-03-04 16:38:16 +0100837 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unexpected element \"%.*s\" instead of \"eventTime\".",
838 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100839 r = LY_EVALID;
840 }
841 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
842
843 /* insert */
844 lyd_insert_node(*envp, NULL, child);
845
846 /* validate value */
847 /* TODO validate child->value as yang:date-and-time */
848
849 /* finish child parsing */
Michal Vaskoa8edff02020-03-27 14:47:01 +0100850 if (xmlctx->status != LYXML_ELEM_CLOSE) {
851 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoe0665742021-02-11 11:08:44 +0100852 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"eventTime\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100853 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100854 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100855 goto cleanup;
856 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100857 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
858
859 /* NETCONF notification */
860 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_NOTIF;
861 *close_elem = 1;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100862
863cleanup:
Michal Vaskoe0665742021-02-11 11:08:44 +0100864 if (rc) {
Michal Vaskoa8edff02020-03-27 14:47:01 +0100865 lyd_free_tree(*envp);
Michal Vaskoe0665742021-02-11 11:08:44 +0100866 *envp = NULL;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100867 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100868 return rc;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100869}
Michal Vasko79135ae2020-12-16 10:08:35 +0100870
Michal Vaskoe0665742021-02-11 11:08:44 +0100871/**
872 * @brief Parse an XML element as an opaque node subtree.
873 *
874 * @param[in] xmlctx XML parser context.
875 * @param[in] parent Parent to append nodes to.
876 * @return LY_ERR value.
877 */
878static LY_ERR
879lydxml_opaq_r(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
Michal Vaskoa8edff02020-03-27 14:47:01 +0100880{
Michal Vaskoe0665742021-02-11 11:08:44 +0100881 LY_ERR rc = LY_SUCCESS;
882 const struct lyxml_ns *ns;
883 struct lyd_attr *attr = NULL;
884 struct lyd_node *child = NULL;
885 const char *name, *prefix;
886 size_t name_len, prefix_len;
Michal Vaskoa8edff02020-03-27 14:47:01 +0100887
Michal Vaskoe0665742021-02-11 11:08:44 +0100888 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoa8edff02020-03-27 14:47:01 +0100889
Michal Vaskoe0665742021-02-11 11:08:44 +0100890 name = xmlctx->name;
891 name_len = xmlctx->name_len;
892 prefix = xmlctx->prefix;
893 prefix_len = xmlctx->prefix_len;
894 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
895 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +0100896 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +0100897 return LY_EVALID;
898 }
Michal Vaskoa8edff02020-03-27 14:47:01 +0100899
Michal Vaskoe0665742021-02-11 11:08:44 +0100900 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
Michal Vaskoa8edff02020-03-27 14:47:01 +0100901
Michal Vaskoe0665742021-02-11 11:08:44 +0100902 /* create attributes */
903 if (xmlctx->status == LYXML_ATTRIBUTE) {
904 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
905 }
906
907 /* create node */
908 assert(xmlctx->status == LYXML_ELEM_CONTENT);
909 rc = lyd_create_opaq(xmlctx->ctx, name, name_len, prefix, prefix_len, ns->uri, strlen(ns->uri), xmlctx->value,
Radek Krejci8df109d2021-04-23 12:19:08 +0200910 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, &child);
Michal Vaskoe0665742021-02-11 11:08:44 +0100911 LY_CHECK_GOTO(rc, cleanup);
912
913 /* assign atributes */
914 ((struct lyd_node_opaq *)child)->attr = attr;
915 attr = NULL;
916
917 /* parser next element */
918 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
919
920 /* parse all the descendants */
921 while (xmlctx->status == LYXML_ELEMENT) {
922 rc = lydxml_opaq_r(xmlctx, child);
923 LY_CHECK_GOTO(rc, cleanup);
924 }
925
926 /* insert */
927 lyd_insert_node(parent, NULL, child);
928
929cleanup:
930 lyd_free_attr_siblings(xmlctx->ctx, attr);
931 if (rc) {
932 lyd_free_tree(child);
933 }
934 return rc;
935}
936
937/**
938 * @brief Parse all expected non-data XML elements of the error-info element in NETCONF rpc-reply message.
939 *
940 * @param[in] xmlctx XML parser context.
941 * @param[in] parent Parent to append nodes to.
942 * @return LY_ERR value.
943 */
944static LY_ERR
945lydxml_env_netconf_rpc_reply_error_info(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
946{
947 LY_ERR r;
948 struct lyd_node *child, *iter;
949 const struct lyxml_ns *ns;
950 ly_bool no_dup;
951
952 /* there must be some child */
953 if (xmlctx->status == LYXML_ELEM_CLOSE) {
954 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"error-info\".");
955 return LY_EVALID;
956 }
957
958 while (xmlctx->status == LYXML_ELEMENT) {
959 child = NULL;
960
961 /*
962 * session-id
963 */
964 r = lydxml_envelope(xmlctx, "session-id", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
965 if (r == LY_SUCCESS) {
966 no_dup = 1;
967 goto check_child;
968 } else if (r != LY_ENOT) {
969 goto error;
970 }
971
972 /*
973 * bad-attribute
974 */
975 r = lydxml_envelope(xmlctx, "bad-attribute", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
976 if (r == LY_SUCCESS) {
977 no_dup = 1;
978 goto check_child;
979 } else if (r != LY_ENOT) {
980 goto error;
981 }
982
983 /*
984 * bad-element
985 */
986 r = lydxml_envelope(xmlctx, "bad-element", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
987 if (r == LY_SUCCESS) {
988 no_dup = 1;
989 goto check_child;
990 } else if (r != LY_ENOT) {
991 goto error;
992 }
993
994 /*
995 * bad-namespace
996 */
997 r = lydxml_envelope(xmlctx, "bad-namespace", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
998 if (r == LY_SUCCESS) {
999 no_dup = 1;
1000 goto check_child;
1001 } else if (r != LY_ENOT) {
1002 goto error;
1003 }
1004
1005 if (r == LY_ENOT) {
1006 assert(xmlctx->status == LYXML_ELEMENT);
1007
1008 /* learn namespace */
1009 ns = lyxml_ns_get(&xmlctx->ns, xmlctx->prefix, xmlctx->prefix_len);
1010 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +01001011 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)xmlctx->prefix_len, xmlctx->prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +01001012 r = LY_EVALID;
1013 goto error;
1014 } else if (!strcmp(ns->uri, "urn:ietf:params:xml:ns:netconf:base:1.0")) {
1015 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"error-info\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001016 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001017 r = LY_EVALID;
1018 goto error;
1019 }
1020
1021 /* custom elements */
1022 r = lydxml_opaq_r(xmlctx, parent);
1023 LY_CHECK_GOTO(r, error);
1024
1025 no_dup = 0;
1026 }
1027
1028check_child:
1029 /* check for duplicates */
1030 if (no_dup) {
1031 LY_LIST_FOR(lyd_child(parent), iter) {
1032 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1033 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1034 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"error-info\".",
1035 ((struct lyd_node_opaq *)child)->name.name);
1036 r = LY_EVALID;
1037 goto error;
1038 }
1039 }
1040 }
1041
1042 /* finish child parsing */
1043 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1044 assert(xmlctx->status == LYXML_ELEMENT);
1045 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"error-info\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001046 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001047 r = LY_EVALID;
1048 goto error;
1049 }
1050 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1051
1052 /* insert */
1053 lyd_insert_node(parent, NULL, child);
1054 }
1055
1056 return LY_SUCCESS;
1057
1058error:
1059 lyd_free_tree(child);
1060 return r;
1061}
1062
1063/**
1064 * @brief Parse all expected non-data XML elements of the rpc-error element in NETCONF rpc-reply message.
1065 *
1066 * @param[in] xmlctx XML parser context.
1067 * @param[in] parent Parent to append nodes to.
1068 * @return LY_ERR value.
1069 */
1070static LY_ERR
1071lydxml_env_netconf_rpc_reply_error(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
1072{
1073 LY_ERR r;
1074 struct lyd_node *child, *iter;
1075 const char *val;
1076 ly_bool no_dup;
1077
1078 /* there must be some child */
1079 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1080 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-error\".");
1081 return LY_EVALID;
1082 }
1083
1084 while (xmlctx->status == LYXML_ELEMENT) {
1085 child = NULL;
1086
1087 /*
1088 * error-type
1089 */
1090 r = lydxml_envelope(xmlctx, "error-type", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1091 if (r == LY_SUCCESS) {
1092 val = ((struct lyd_node_opaq *)child)->value;
1093 if (strcmp(val, "transport") && strcmp(val, "rpc") && strcmp(val, "protocol") && strcmp(val, "application")) {
1094 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1095 ((struct lyd_node_opaq *)child)->name.name);
1096 r = LY_EVALID;
1097 goto error;
1098 }
1099
1100 no_dup = 1;
1101 goto check_child;
1102 } else if (r != LY_ENOT) {
1103 goto error;
1104 }
1105
1106 /*
1107 * error-tag
1108 */
1109 r = lydxml_envelope(xmlctx, "error-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1110 if (r == LY_SUCCESS) {
1111 val = ((struct lyd_node_opaq *)child)->value;
1112 if (strcmp(val, "in-use") && strcmp(val, "invalid-value") && strcmp(val, "too-big") &&
1113 strcmp(val, "missing-attribute") && strcmp(val, "bad-attribute") &&
1114 strcmp(val, "unknown-attribute") && strcmp(val, "missing-element") && strcmp(val, "bad-element") &&
1115 strcmp(val, "unknown-element") && strcmp(val, "unknown-namespace") && strcmp(val, "access-denied") &&
1116 strcmp(val, "lock-denied") && strcmp(val, "resource-denied") && strcmp(val, "rollback-failed") &&
1117 strcmp(val, "data-exists") && strcmp(val, "data-missing") && strcmp(val, "operation-not-supported") &&
1118 strcmp(val, "operation-failed") && strcmp(val, "malformed-message")) {
1119 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1120 ((struct lyd_node_opaq *)child)->name.name);
1121 r = LY_EVALID;
1122 goto error;
1123 }
1124
1125 no_dup = 1;
1126 goto check_child;
1127 } else if (r != LY_ENOT) {
1128 goto error;
1129 }
1130
1131 /*
1132 * error-severity
1133 */
1134 r = lydxml_envelope(xmlctx, "error-severity", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1135 if (r == LY_SUCCESS) {
1136 val = ((struct lyd_node_opaq *)child)->value;
1137 if (strcmp(val, "error") && strcmp(val, "warning")) {
1138 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1139 ((struct lyd_node_opaq *)child)->name.name);
1140 r = LY_EVALID;
1141 goto error;
1142 }
1143
1144 no_dup = 1;
1145 goto check_child;
1146 } else if (r != LY_ENOT) {
1147 goto error;
1148 }
1149
1150 /*
1151 * error-app-tag
1152 */
1153 r = lydxml_envelope(xmlctx, "error-app-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1154 if (r == LY_SUCCESS) {
1155 no_dup = 1;
1156 goto check_child;
1157 } else if (r != LY_ENOT) {
1158 goto error;
1159 }
1160
1161 /*
1162 * error-path
1163 */
1164 r = lydxml_envelope(xmlctx, "error-path", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1165 if (r == LY_SUCCESS) {
1166 no_dup = 1;
1167 goto check_child;
1168 } else if (r != LY_ENOT) {
1169 goto error;
1170 }
1171
1172 /*
1173 * error-message
1174 */
1175 r = lydxml_envelope(xmlctx, "error-message", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1176 if (r == LY_SUCCESS) {
1177 no_dup = 1;
1178 goto check_child;
1179 } else if (r != LY_ENOT) {
1180 goto error;
1181 }
1182
1183 /* error-info */
1184 r = lydxml_envelope(xmlctx, "error-info", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1185 if (r == LY_SUCCESS) {
1186 /* parse all the descendants */
1187 LY_CHECK_GOTO(r = lydxml_env_netconf_rpc_reply_error_info(xmlctx, child), error);
1188
1189 no_dup = 0;
1190 goto check_child;
1191 } else if (r != LY_ENOT) {
1192 goto error;
1193 }
1194
1195 if (r == LY_ENOT) {
1196 assert(xmlctx->status == LYXML_ELEMENT);
1197 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001198 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001199 r = LY_EVALID;
1200 goto error;
1201 }
1202
1203check_child:
1204 /* check for duplicates */
1205 if (no_dup) {
1206 LY_LIST_FOR(lyd_child(parent), iter) {
1207 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1208 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1209 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"rpc-error\".",
1210 ((struct lyd_node_opaq *)child)->name.name);
1211 r = LY_EVALID;
1212 goto error;
1213 }
1214 }
1215 }
1216
1217 /* finish child parsing */
1218 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1219 assert(xmlctx->status == LYXML_ELEMENT);
1220 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001221 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001222 r = LY_EVALID;
1223 goto error;
1224 }
1225 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1226
1227 /* insert */
1228 lyd_insert_node(parent, NULL, child);
1229 }
1230
1231 return LY_SUCCESS;
1232
1233error:
1234 lyd_free_tree(child);
1235 return r;
1236}
1237
1238/**
1239 * @brief Parse all expected non-data XML elements of a NETCONF rpc-reply message.
1240 *
1241 * @param[in] xmlctx XML parser context.
1242 * @param[out] evnp Parsed envelope(s) (opaque node).
1243 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1244 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1245 * @return LY_SUCCESS on success.
1246 * @return LY_ERR value on error.
1247 */
1248static LY_ERR
1249lydxml_env_netconf_reply(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1250{
1251 LY_ERR rc = LY_SUCCESS, r;
1252 struct lyd_node *child = NULL;
1253 const char *parsed_elem = NULL;
1254
1255 assert(envp && !*envp);
1256
1257 /* parse "rpc-reply" */
1258 r = lydxml_envelope(xmlctx, "rpc-reply", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001259 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1260
1261 /* there must be some child */
1262 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1263 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-reply\".");
1264 rc = LY_EVALID;
Michal Vaskocf770e22020-08-12 13:21:43 +02001265 goto cleanup;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001266 }
1267
Michal Vaskoe0665742021-02-11 11:08:44 +01001268 /* try to parse "ok" */
1269 r = lydxml_envelope(xmlctx, "ok", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1270 if (r == LY_SUCCESS) {
1271 /* insert */
1272 lyd_insert_node(*envp, NULL, child);
1273
1274 /* finish child parsing */
1275 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1276 assert(xmlctx->status == LYXML_ELEMENT);
1277 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"ok\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001278 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001279 rc = LY_EVALID;
1280 goto cleanup;
1281 }
1282 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1283
1284 /* success */
1285 parsed_elem = "ok";
1286 goto finish;
1287 } else if (r != LY_ENOT) {
1288 rc = r;
1289 goto cleanup;
Michal Vasko2552ea32020-12-08 15:32:34 +01001290 }
1291
Michal Vaskoe0665742021-02-11 11:08:44 +01001292 /* try to parse all "rpc-error" elements */
1293 while (xmlctx->status == LYXML_ELEMENT) {
1294 r = lydxml_envelope(xmlctx, "rpc-error", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1295 if (r == LY_ENOT) {
1296 break;
1297 } else if (r) {
1298 rc = r;
1299 goto cleanup;
1300 }
1301
1302 /* insert */
1303 lyd_insert_node(*envp, NULL, child);
1304
1305 /* parse all children of "rpc-error" */
1306 LY_CHECK_GOTO(rc = lydxml_env_netconf_rpc_reply_error(xmlctx, child), cleanup);
1307
1308 /* finish child parsing */
1309 assert(xmlctx->status == LYXML_ELEM_CLOSE);
1310 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1311
1312 parsed_elem = "rpc-error";
Michal Vasko2552ea32020-12-08 15:32:34 +01001313 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001314
1315finish:
1316 if (parsed_elem) {
1317 /* NETCONF rpc-reply with no data */
1318 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1319 assert(xmlctx->status == LYXML_ELEMENT);
1320 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected sibling element \"%.*s\" of \"%s\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001321 (int)xmlctx->name_len, xmlctx->name, parsed_elem);
Michal Vaskoe0665742021-02-11 11:08:44 +01001322 rc = LY_EVALID;
1323 goto cleanup;
1324 }
1325 }
1326
1327 /* NETCONF rpc-reply */
1328 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_REPLY;
1329 *close_elem = 1;
1330
1331cleanup:
1332 if (rc) {
1333 lyd_free_tree(*envp);
1334 *envp = NULL;
1335 }
1336 return rc;
1337}
1338
Michal Vasko2552ea32020-12-08 15:32:34 +01001339LY_ERR
Radek Krejcif16e2542021-02-17 15:39:23 +01001340lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
1341 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
1342 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p)
Michal Vasko2552ea32020-12-08 15:32:34 +01001343{
Michal Vaskoe0665742021-02-11 11:08:44 +01001344 LY_ERR rc = LY_SUCCESS;
1345 struct lyd_xml_ctx *lydctx;
1346 uint32_t i, int_opts, close_elem = 0;
1347 ly_bool parsed_data_nodes = 0;
Michal Vasko2552ea32020-12-08 15:32:34 +01001348
Michal Vaskoe0665742021-02-11 11:08:44 +01001349 assert(ctx && in && lydctx_p);
1350 assert(!(parse_opts & ~LYD_PARSE_OPTS_MASK));
1351 assert(!(val_opts & ~LYD_VALIDATE_OPTS_MASK));
Michal Vasko2552ea32020-12-08 15:32:34 +01001352
Michal Vaskoe0665742021-02-11 11:08:44 +01001353 /* init context */
1354 lydctx = calloc(1, sizeof *lydctx);
1355 LY_CHECK_ERR_RET(!lydctx, LOGMEM(ctx), LY_EMEM);
1356 LY_CHECK_GOTO(rc = lyxml_ctx_new(ctx, in, &lydctx->xmlctx), cleanup);
1357 lydctx->parse_opts = parse_opts;
1358 lydctx->val_opts = val_opts;
1359 lydctx->free = lyd_xml_ctx_free;
Radek Krejcif16e2542021-02-17 15:39:23 +01001360 lydctx->ext = ext;
Michal Vasko2552ea32020-12-08 15:32:34 +01001361
Michal Vaskoe0665742021-02-11 11:08:44 +01001362 switch (data_type) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001363 case LYD_TYPE_DATA_YANG:
Michal Vaskoe0665742021-02-11 11:08:44 +01001364 int_opts = LYD_INTOPT_WITH_SIBLINGS;
1365 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001366 case LYD_TYPE_RPC_YANG:
Michal Vaskoe0665742021-02-11 11:08:44 +01001367 int_opts = LYD_INTOPT_RPC | LYD_INTOPT_ACTION | LYD_INTOPT_NO_SIBLINGS;
1368 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001369 case LYD_TYPE_NOTIF_YANG:
Michal Vaskoe0665742021-02-11 11:08:44 +01001370 int_opts = LYD_INTOPT_NOTIF | LYD_INTOPT_NO_SIBLINGS;
1371 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001372 case LYD_TYPE_REPLY_YANG:
Michal Vaskoe0665742021-02-11 11:08:44 +01001373 int_opts = LYD_INTOPT_REPLY | LYD_INTOPT_NO_SIBLINGS;
1374 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001375 case LYD_TYPE_RPC_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001376 assert(!parent);
1377 LY_CHECK_GOTO(rc = lydxml_env_netconf_rpc(lydctx->xmlctx, envp, &int_opts, &close_elem), cleanup);
1378 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001379 case LYD_TYPE_NOTIF_NETCONF:
1380 assert(!parent);
1381 LY_CHECK_GOTO(rc = lydxml_env_netconf_notif(lydctx->xmlctx, envp, &int_opts, &close_elem), cleanup);
1382 break;
1383 case LYD_TYPE_REPLY_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001384 assert(parent);
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001385 LY_CHECK_GOTO(rc = lydxml_env_netconf_reply(lydctx->xmlctx, envp, &int_opts, &close_elem), cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001386 break;
1387 }
1388 lydctx->int_opts = int_opts;
1389
1390 /* find the operation node if it exists already */
1391 LY_CHECK_GOTO(rc = lyd_parser_find_operation(parent, int_opts, &lydctx->op_node), cleanup);
1392
1393 /* parse XML data */
1394 while (lydctx->xmlctx->status == LYXML_ELEMENT) {
1395 LY_CHECK_GOTO(rc = lydxml_subtree_r(lydctx, parent, first_p, parsed), cleanup);
1396 parsed_data_nodes = 1;
1397
1398 if (!(int_opts & LYD_INTOPT_WITH_SIBLINGS)) {
1399 break;
1400 }
Michal Vasko2552ea32020-12-08 15:32:34 +01001401 }
1402
Michal Vaskoe0665742021-02-11 11:08:44 +01001403 /* close all opened elements */
1404 for (i = 0; i < close_elem; ++i) {
1405 if (lydctx->xmlctx->status != LYXML_ELEM_CLOSE) {
1406 assert(lydctx->xmlctx->status == LYXML_ELEMENT);
Radek Krejci422afb12021-03-04 16:38:16 +01001407 LOGVAL(lydctx->xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\".",
1408 (int)lydctx->xmlctx->name_len, lydctx->xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001409 rc = LY_EVALID;
1410 goto cleanup;
1411 }
1412
1413 LY_CHECK_GOTO(rc = lyxml_ctx_next(lydctx->xmlctx), cleanup);
Michal Vasko4189c0f2020-08-13 09:05:22 +02001414 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001415
1416 /* check final state */
1417 if ((int_opts & LYD_INTOPT_NO_SIBLINGS) && (lydctx->xmlctx->status == LYXML_ELEMENT)) {
1418 LOGVAL(ctx, LYVE_SYNTAX, "Unexpected sibling node.");
1419 rc = LY_EVALID;
1420 goto cleanup;
1421 }
1422 if ((int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_NOTIF | LYD_INTOPT_REPLY)) && !lydctx->op_node) {
1423 LOGVAL(ctx, LYVE_DATA, "Missing the operation node.");
1424 rc = LY_EVALID;
1425 goto cleanup;
1426 }
1427
1428 if (!parsed_data_nodes) {
1429 /* no data nodes were parsed */
1430 lydctx->op_node = NULL;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001431 }
1432
1433cleanup:
Michal Vaskoe0665742021-02-11 11:08:44 +01001434 /* there should be no unres stored if validation should be skipped */
1435 assert(!(parse_opts & LYD_PARSE_ONLY) || (!lydctx->node_types.count && !lydctx->meta_types.count &&
Radek Krejci4f2e3e52021-03-30 14:20:28 +02001436 !lydctx->node_when.count && !lydctx->node_exts.count));
Michal Vaskoe0665742021-02-11 11:08:44 +01001437
1438 if (rc) {
1439 lyd_xml_ctx_free((struct lyd_ctx *)lydctx);
1440 } else {
1441 *lydctx_p = (struct lyd_ctx *)lydctx;
1442
1443 /* the XML context is no more needed, freeing it also stops logging line numbers which would be confusing now */
1444 lyxml_ctx_free(lydctx->xmlctx);
1445 lydctx->xmlctx = NULL;
Michal Vasko1ce933a2020-03-30 12:38:22 +02001446 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001447 return rc;
Michal Vasko1ce933a2020-03-30 12:38:22 +02001448}