blob: ccbb2a9ffaa1233e8e1835d609ccb9bc8ec0de87 [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file parser_xml.c
3 * @author Radek Krejci <rkrejci@cesnet.cz>
Michal Vasko8cc3f662022-03-29 11:25:51 +02004 * @author Michal Vasko <mvasko@cesnet.cz>
Radek Krejcie7b95092019-05-15 11:03:07 +02005 * @brief XML data parser for libyang
6 *
Michal Vasko8cc3f662022-03-29 11:25:51 +02007 * Copyright (c) 2019 - 2022 CESNET, z.s.p.o.
Radek Krejcie7b95092019-05-15 11:03:07 +02008 *
9 * This source code is licensed under BSD 3-Clause License (the "License").
10 * You may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * https://opensource.org/licenses/BSD-3-Clause
14 */
15
Michal Vasko742a5b12022-02-24 16:07:27 +010016#define _GNU_SOURCE
17
Michal Vasko69730152020-10-09 16:30:07 +020018#include <assert.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020019#include <stdint.h>
20#include <stdlib.h>
21#include <string.h>
22
Radek Krejci535ea9f2020-05-29 16:01:05 +020023#include "common.h"
Michal Vasko742a5b12022-02-24 16:07:27 +010024#include "compat.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020025#include "context.h"
Radek Krejci77114102021-03-10 15:21:57 +010026#include "dict.h"
Michal Vaskoafac7822020-10-20 14:22:26 +020027#include "in_internal.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020028#include "log.h"
Radek Krejci7931b192020-06-25 17:05:03 +020029#include "parser_data.h"
30#include "parser_internal.h"
tadeas-vintrlik2aa36b42021-11-03 13:07:34 +010031#include "plugins_exts.h"
Michal Vasko51de7b72022-04-29 09:50:22 +020032#include "plugins_internal.h"
33#include "schema_compile_node.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020034#include "set.h"
Radek Krejci77114102021-03-10 15:21:57 +010035#include "tree.h"
Radek Krejci47fab892020-11-05 17:02:41 +010036#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020037#include "tree_data_internal.h"
38#include "tree_schema.h"
Radek Krejci77114102021-03-10 15:21:57 +010039#include "tree_schema_internal.h"
Michal Vaskocde73ac2019-11-14 16:10:27 +010040#include "validation.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020041#include "xml.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020042
Michal Vaskod027f382023-02-10 09:13:25 +010043static LY_ERR lydxml_subtree_r(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, struct lyd_node **first_p,
44 struct ly_set *parsed);
45
Radek Krejci1798aae2020-07-14 13:26:06 +020046void
47lyd_xml_ctx_free(struct lyd_ctx *lydctx)
48{
49 struct lyd_xml_ctx *ctx = (struct lyd_xml_ctx *)lydctx;
50
51 lyd_ctx_free(lydctx);
52 lyxml_ctx_free(ctx->xmlctx);
53 free(ctx);
54}
55
Michal Vasko45791ad2021-06-17 08:45:03 +020056/**
57 * @brief Parse and create XML metadata.
58 *
59 * @param[in] lydctx XML data parser context.
Michal Vaskoddd76592022-01-17 13:34:48 +010060 * @param[in] sparent Schema node of the parent.
Michal Vasko45791ad2021-06-17 08:45:03 +020061 * @param[out] meta List of created metadata instances.
62 * @return LY_ERR value.
63 */
Radek Krejcie7b95092019-05-15 11:03:07 +020064static LY_ERR
Michal Vaskoddd76592022-01-17 13:34:48 +010065lydxml_metadata(struct lyd_xml_ctx *lydctx, const struct lysc_node *sparent, struct lyd_meta **meta)
Radek Krejcie7b95092019-05-15 11:03:07 +020066{
aPiecek1c4da362021-04-29 14:26:34 +020067 LY_ERR ret = LY_SUCCESS;
Radek Krejci28681fa2019-09-06 13:08:45 +020068 const struct lyxml_ns *ns;
69 struct lys_module *mod;
Michal Vaskob36053d2020-03-26 15:49:30 +010070 const char *name;
71 size_t name_len;
Michal Vasko45791ad2021-06-17 08:45:03 +020072 LY_ARRAY_COUNT_TYPE u;
73 ly_bool filter_attrs = 0;
Radek Krejci1798aae2020-07-14 13:26:06 +020074 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
Radek Krejci28681fa2019-09-06 13:08:45 +020075
Michal Vaskob36053d2020-03-26 15:49:30 +010076 *meta = NULL;
Radek Krejci28681fa2019-09-06 13:08:45 +020077
Michal Vasko45791ad2021-06-17 08:45:03 +020078 /* check for NETCONF filter unqualified attributes */
Michal Vasko1b2a3f42022-12-20 09:38:28 +010079 if (!strcmp(sparent->module->name, "notifications")) {
80 /* ancient module that does not even use the extension */
81 filter_attrs = 1;
82 } else {
83 LY_ARRAY_FOR(sparent->exts, u) {
84 if (!strcmp(sparent->exts[u].def->name, "get-filter-element-attributes") &&
85 !strcmp(sparent->exts[u].def->module->name, "ietf-netconf")) {
86 filter_attrs = 1;
87 break;
88 }
Michal Vasko45791ad2021-06-17 08:45:03 +020089 }
90 }
91
Michal Vaskob36053d2020-03-26 15:49:30 +010092 while (xmlctx->status == LYXML_ATTRIBUTE) {
93 if (!xmlctx->prefix_len) {
Michal Vasko45791ad2021-06-17 08:45:03 +020094 /* in XML all attributes must be prefixed except NETCONF filter ones marked by an extension */
95 if (filter_attrs && (!ly_strncmp("type", xmlctx->name, xmlctx->name_len) ||
96 !ly_strncmp("select", xmlctx->name, xmlctx->name_len))) {
97 mod = ly_ctx_get_module_implemented(xmlctx->ctx, "ietf-netconf");
98 if (!mod) {
99 LOGVAL(xmlctx->ctx, LYVE_REFERENCE,
100 "Missing (or not implemented) YANG module \"ietf-netconf\" for special filter attributes.");
101 ret = LY_ENOTFOUND;
102 goto cleanup;
103 }
104 goto create_meta;
105 }
106
Michal Vaskoe0665742021-02-11 11:08:44 +0100107 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100108 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Missing mandatory prefix for XML metadata \"%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100109 (int)xmlctx->name_len, xmlctx->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200110 ret = LY_EVALID;
Michal Vaskob36053d2020-03-26 15:49:30 +0100111 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +0200112 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100113
Michal Vasko45791ad2021-06-17 08:45:03 +0200114 /* skip attr */
Michal Vaskob36053d2020-03-26 15:49:30 +0100115 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
116 assert(xmlctx->status == LYXML_ATTR_CONTENT);
117 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejci28681fa2019-09-06 13:08:45 +0200118 continue;
119 }
120
121 /* get namespace of the attribute to find its annotation definition */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200122 ns = lyxml_ns_get(&xmlctx->ns, xmlctx->prefix, xmlctx->prefix_len);
Radek Krejci28681fa2019-09-06 13:08:45 +0200123 if (!ns) {
Michal Vasko52927e22020-03-16 17:26:14 +0100124 /* unknown namespace, XML error */
Radek Krejci422afb12021-03-04 16:38:16 +0100125 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)xmlctx->prefix_len, xmlctx->prefix);
Michal Vasko45791ad2021-06-17 08:45:03 +0200126 ret = LY_ENOTFOUND;
Radek Krejci28681fa2019-09-06 13:08:45 +0200127 goto cleanup;
128 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200129
130 /* get the module with metadata definition */
Michal Vasko52927e22020-03-16 17:26:14 +0100131 mod = ly_ctx_get_module_implemented_ns(xmlctx->ctx, ns->uri);
Radek Krejci28681fa2019-09-06 13:08:45 +0200132 if (!mod) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100133 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100134 LOGVAL(xmlctx->ctx, LYVE_REFERENCE,
Michal Vasko69730152020-10-09 16:30:07 +0200135 "Unknown (or not implemented) YANG module with namespace \"%s\" for metadata \"%.*s%s%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100136 ns->uri, (int)xmlctx->prefix_len, xmlctx->prefix, xmlctx->prefix_len ? ":" : "",
137 (int)xmlctx->name_len, xmlctx->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200138 ret = LY_ENOTFOUND;
Michal Vaskob36053d2020-03-26 15:49:30 +0100139 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +0200140 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200141
142 /* skip attr */
143 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
144 assert(xmlctx->status == LYXML_ATTR_CONTENT);
145 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
146 continue;
Radek Krejci28681fa2019-09-06 13:08:45 +0200147 }
148
Michal Vasko45791ad2021-06-17 08:45:03 +0200149create_meta:
Michal Vasko60ea6352020-06-29 13:39:39 +0200150 /* remember meta name and get its content */
Michal Vaskob36053d2020-03-26 15:49:30 +0100151 name = xmlctx->name;
152 name_len = xmlctx->name_len;
153 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
154 assert(xmlctx->status == LYXML_ATTR_CONTENT);
155
156 /* create metadata */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200157 ret = lyd_parser_create_meta((struct lyd_ctx *)lydctx, NULL, meta, mod, name, name_len, xmlctx->value,
Michal Vaskoddd76592022-01-17 13:34:48 +0100158 xmlctx->value_len, &xmlctx->dynamic, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA, sparent);
Radek Krejci1798aae2020-07-14 13:26:06 +0200159 LY_CHECK_GOTO(ret, cleanup);
Michal Vaskob36053d2020-03-26 15:49:30 +0100160
161 /* next attribute */
162 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejcie7b95092019-05-15 11:03:07 +0200163 }
Michal Vasko52927e22020-03-16 17:26:14 +0100164
Radek Krejcie7b95092019-05-15 11:03:07 +0200165cleanup:
Michal Vaskob36053d2020-03-26 15:49:30 +0100166 if (ret) {
Michal Vasko3a41dff2020-07-15 14:30:28 +0200167 lyd_free_meta_siblings(*meta);
Michal Vaskob36053d2020-03-26 15:49:30 +0100168 *meta = NULL;
Radek Krejci38d85362019-09-05 16:26:38 +0200169 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200170 return ret;
171}
172
Michal Vasko52927e22020-03-16 17:26:14 +0100173static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200174lydxml_attrs(struct lyxml_ctx *xmlctx, struct lyd_attr **attr)
Michal Vasko52927e22020-03-16 17:26:14 +0100175{
176 LY_ERR ret = LY_SUCCESS;
177 const struct lyxml_ns *ns;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100178 void *val_prefix_data;
Radek Krejci8df109d2021-04-23 12:19:08 +0200179 LY_VALUE_FORMAT format;
Radek Krejci1798aae2020-07-14 13:26:06 +0200180 struct lyd_attr *attr2;
Michal Vaskob36053d2020-03-26 15:49:30 +0100181 const char *name, *prefix;
182 size_t name_len, prefix_len;
Michal Vasko52927e22020-03-16 17:26:14 +0100183
184 assert(attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100185 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100186
Michal Vaskob36053d2020-03-26 15:49:30 +0100187 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vasko52927e22020-03-16 17:26:14 +0100188 if (*attr) {
189 attr2 = *attr;
190 } else {
191 attr2 = NULL;
192 }
193
Michal Vaskob36053d2020-03-26 15:49:30 +0100194 /* remember attr prefix, name, and get its content */
195 prefix = xmlctx->prefix;
196 prefix_len = xmlctx->prefix_len;
197 name = xmlctx->name;
198 name_len = xmlctx->name_len;
199 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
200 assert(xmlctx->status == LYXML_ATTR_CONTENT);
201
Michal Vaskoe137fc42021-07-22 11:53:13 +0200202 /* handle special "xml" attribute prefix */
203 if ((prefix_len == 3) && !strncmp(prefix, "xml", 3)) {
204 name = prefix;
205 name_len += 1 + prefix_len;
206 prefix = NULL;
207 prefix_len = 0;
208 }
209
210 /* find namespace of the attribute, if any */
211 ns = NULL;
212 if (prefix_len) {
213 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
214 if (!ns) {
215 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
216 ret = LY_EVALID;
217 goto cleanup;
218 }
219 }
220
Michal Vasko52927e22020-03-16 17:26:14 +0100221 /* get value prefixes */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100222 val_prefix_data = NULL;
Radek Krejci8df109d2021-04-23 12:19:08 +0200223 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 +0100224 &xmlctx->ns, &format, &val_prefix_data), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100225
226 /* attr2 is always changed to the created attribute */
Michal Vasko501af032020-11-11 20:27:44 +0100227 ret = lyd_create_attr(NULL, &attr2, xmlctx->ctx, name, name_len, prefix, prefix_len, ns ? ns->uri : NULL,
Michal Vaskoe5e49e92022-02-01 13:15:08 +0100228 ns ? strlen(ns->uri) : 0, xmlctx->value, xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data,
229 LYD_HINT_DATA);
Michal Vasko52927e22020-03-16 17:26:14 +0100230 LY_CHECK_GOTO(ret, cleanup);
231
232 if (!*attr) {
233 *attr = attr2;
234 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100235
236 /* next attribute */
237 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100238 }
239
240cleanup:
Michal Vaskob36053d2020-03-26 15:49:30 +0100241 if (ret) {
Radek Krejci011e4aa2020-09-04 15:22:31 +0200242 lyd_free_attr_siblings(xmlctx->ctx, *attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100243 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100244 }
Michal Vasko52927e22020-03-16 17:26:14 +0100245 return ret;
246}
247
Michal Vasko44685da2020-03-17 15:38:06 +0100248static LY_ERR
Michal Vaskob36053d2020-03-26 15:49:30 +0100249lydxml_check_list(struct lyxml_ctx *xmlctx, const struct lysc_node *list)
Michal Vasko44685da2020-03-17 15:38:06 +0100250{
Michal Vaskob36053d2020-03-26 15:49:30 +0100251 LY_ERR ret = LY_SUCCESS, r;
252 enum LYXML_PARSER_STATUS next;
Michal Vasko44685da2020-03-17 15:38:06 +0100253 struct ly_set key_set = {0};
254 const struct lysc_node *snode;
Michal Vaskob36053d2020-03-26 15:49:30 +0100255 uint32_t i, parents_count;
Michal Vasko44685da2020-03-17 15:38:06 +0100256
257 assert(list && (list->nodetype == LYS_LIST));
258
259 /* get all keys into a set (keys do not have if-features or anything) */
260 snode = NULL;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100261 while ((snode = lys_getnext(snode, list, NULL, 0)) && (snode->flags & LYS_KEY)) {
Radek Krejci3d92e442020-10-12 12:48:13 +0200262 ret = ly_set_add(&key_set, (void *)snode, 1, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200263 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100264 }
265
Michal Vasko12d809c2021-03-03 16:34:32 +0100266 /* remember parent count */
267 parents_count = xmlctx->elements.count;
268
Michal Vaskob36053d2020-03-26 15:49:30 +0100269 while (xmlctx->status == LYXML_ELEMENT) {
Michal Vasko44685da2020-03-17 15:38:06 +0100270 /* find key definition */
271 for (i = 0; i < key_set.count; ++i) {
272 snode = (const struct lysc_node *)key_set.objs[i];
Michal Vaskob36053d2020-03-26 15:49:30 +0100273 if (!ly_strncmp(snode->name, xmlctx->name, xmlctx->name_len)) {
Michal Vasko44685da2020-03-17 15:38:06 +0100274 break;
275 }
276 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100277 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100278
279 /* skip attributes */
280 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100281 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
282 assert(xmlctx->status == LYXML_ATTR_CONTENT);
283 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100284 }
285
Michal Vaskob36053d2020-03-26 15:49:30 +0100286 assert(xmlctx->status == LYXML_ELEM_CONTENT);
287 if (i < key_set.count) {
288 /* validate the value */
Radek Krejci8df109d2021-04-23 12:19:08 +0200289 r = lys_value_validate(NULL, snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns);
Michal Vaskob36053d2020-03-26 15:49:30 +0100290 if (!r) {
291 /* key with a valid value, remove from the set */
292 ly_set_rm_index(&key_set, i, NULL);
Michal Vasko44685da2020-03-17 15:38:06 +0100293 }
294 }
295
Michal Vaskob36053d2020-03-26 15:49:30 +0100296 /* parser next */
297 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100298
Michal Vaskob36053d2020-03-26 15:49:30 +0100299 /* skip any children, resursively */
Michal Vasko12d809c2021-03-03 16:34:32 +0100300 while (xmlctx->status == LYXML_ELEMENT) {
301 while (parents_count < xmlctx->elements.count) {
302 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
303 }
304 assert(xmlctx->status == LYXML_ELEM_CLOSE);
Michal Vaskob36053d2020-03-26 15:49:30 +0100305 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
306 }
307
308 /* parser next, but do not parse closing element of the list because it would remove its namespaces */
309 assert(xmlctx->status == LYXML_ELEM_CLOSE);
310 LY_CHECK_GOTO(ret = lyxml_ctx_peek(xmlctx, &next), cleanup);
311 if (next != LYXML_ELEM_CLOSE) {
312 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
313 }
Michal Vasko44685da2020-03-17 15:38:06 +0100314 }
315
316 if (key_set.count) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100317 /* some keys are missing/did not validate */
Michal Vasko44685da2020-03-17 15:38:06 +0100318 ret = LY_ENOT;
Michal Vasko44685da2020-03-17 15:38:06 +0100319 }
320
321cleanup:
322 ly_set_erase(&key_set, NULL);
323 return ret;
324}
325
Michal Vasko5c24ed12021-06-09 09:27:32 +0200326/**
327 * @brief Skip an element with all its descendants.
328 *
329 * @param[in] xmlctx XML parser context.
330 * @return LY_ERR value.
331 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100332static LY_ERR
333lydxml_data_skip(struct lyxml_ctx *xmlctx)
334{
335 uint32_t parents_count;
336
337 /* remember current number of parents */
338 parents_count = xmlctx->elements.count;
aPiecek9cdb9e62021-05-18 09:46:20 +0200339 assert(parents_count);
Michal Vasko1bf09392020-03-27 12:38:10 +0100340
341 /* skip after the content */
342 while (xmlctx->status != LYXML_ELEM_CONTENT) {
343 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
344 }
345 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
346
347 /* skip all children elements, recursively, if any */
aPiecek9cdb9e62021-05-18 09:46:20 +0200348 while (parents_count <= xmlctx->elements.count) {
Michal Vasko1bf09392020-03-27 12:38:10 +0100349 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
350 }
351
352 /* close element */
353 assert(xmlctx->status == LYXML_ELEM_CLOSE);
354 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
355
356 return LY_SUCCESS;
357}
358
Michal Vasko5c24ed12021-06-09 09:27:32 +0200359/**
360 * @brief Check that the current element can be parsed as a data node.
361 *
362 * @param[in] lydctx XML data parser context.
363 * @param[in,out] snode Found schema node, set to NULL if data node cannot be created.
364 * @return LY_ERR value.
365 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100366static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200367lydxml_data_check_opaq(struct lyd_xml_ctx *lydctx, const struct lysc_node **snode)
Michal Vasko1bf09392020-03-27 12:38:10 +0100368{
369 LY_ERR ret = LY_SUCCESS;
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200370 struct lyxml_ctx *xmlctx = lydctx->xmlctx, pxmlctx;
Michal Vasko1bf09392020-03-27 12:38:10 +0100371
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100372 if (!(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
373 /* only checks specific to opaque nodes */
374 return LY_SUCCESS;
375 }
376
Michal Vasko13854662021-06-09 09:27:50 +0200377 if (!((*snode)->nodetype & (LYD_NODE_TERM | LYD_NODE_INNER))) {
378 /* nothing to check */
379 return LY_SUCCESS;
380 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100381
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200382 assert(xmlctx->elements.count);
383
Michal Vasko13854662021-06-09 09:27:50 +0200384 /* backup parser */
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200385 LY_CHECK_RET(lyxml_ctx_backup(xmlctx, &pxmlctx));
Michal Vasko1bf09392020-03-27 12:38:10 +0100386
Michal Vasko13854662021-06-09 09:27:50 +0200387 /* skip attributes */
388 while (xmlctx->status == LYXML_ATTRIBUTE) {
389 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
390 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
391 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100392
Michal Vasko13854662021-06-09 09:27:50 +0200393 if ((*snode)->nodetype & LYD_NODE_TERM) {
394 /* value may not be valid in which case we parse it as an opaque node */
395 if (lys_value_validate(NULL, *snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns)) {
Michal Vaskod0237d42021-07-12 14:49:46 +0200396 LOGVRB("Parsing opaque term node \"%s\" with invalid value \"%.*s\".", (*snode)->name, xmlctx->value_len,
397 xmlctx->value);
Michal Vasko13854662021-06-09 09:27:50 +0200398 *snode = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +0100399 }
Michal Vasko13854662021-06-09 09:27:50 +0200400 } else if ((*snode)->nodetype == LYS_LIST) {
401 /* skip content */
402 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
Michal Vasko1bf09392020-03-27 12:38:10 +0100403
Michal Vasko13854662021-06-09 09:27:50 +0200404 if (lydxml_check_list(xmlctx, *snode)) {
405 /* invalid list, parse as opaque if it missing/has invalid some keys */
Michal Vaskod0237d42021-07-12 14:49:46 +0200406 LOGVRB("Parsing opaque list node \"%s\" with missing/invalid keys.", (*snode)->name);
Michal Vasko13854662021-06-09 09:27:50 +0200407 *snode = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +0100408 }
Michal Vasko13854662021-06-09 09:27:50 +0200409 } else {
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100410 /* if there is a non-WS value, it cannot be parsed as an inner node */
411 assert(xmlctx->status == LYXML_ELEM_CONTENT);
412 if (!xmlctx->ws_only) {
413 *snode = NULL;
414 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100415 }
416
Michal Vasko13854662021-06-09 09:27:50 +0200417restore:
418 /* restore parser */
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200419 lyxml_ctx_restore(xmlctx, &pxmlctx);
Michal Vasko1bf09392020-03-27 12:38:10 +0100420 return ret;
421}
422
Radek Krejcie7b95092019-05-15 11:03:07 +0200423/**
Michal Vaskocea58712022-04-01 14:37:08 +0200424 * @brief Get sensible data hints for an opaque node.
425 *
426 * @param[in] name Node name.
427 * @param[in] name_len Length of @p name.
428 * @param[in] value Node value.
429 * @param[in] value_len Length of @p value.
430 * @param[in] first Node first sibling.
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100431 * @param[in] ns Node module namespace, NULL for no namespace.
Michal Vaskocea58712022-04-01 14:37:08 +0200432 * @param[out] hints Data hints to use.
433 * @param[out] anchor Anchor to insert after in case of a list.
434 */
435static void
Michal Vaskod027f382023-02-10 09:13:25 +0100436lydxml_get_hints_opaq(const char *name, size_t name_len, const char *value, size_t value_len, const struct lyd_node *first,
Michal Vaskocea58712022-04-01 14:37:08 +0200437 const char *ns, uint32_t *hints, struct lyd_node **anchor)
438{
439 struct lyd_node_opaq *opaq;
440 char *ptr;
441 long num;
442
443 *hints = 0;
444 *anchor = NULL;
445
446 if (!value_len) {
447 /* no value */
448 *hints |= LYD_VALHINT_EMPTY;
449 } else if (!strncmp(value, "true", value_len) || !strncmp(value, "false", value_len)) {
450 /* boolean value */
451 *hints |= LYD_VALHINT_BOOLEAN;
452 } else {
453 num = strtol(value, &ptr, 10);
454 if ((unsigned)(ptr - value) == value_len) {
455 /* number value */
456 *hints |= LYD_VALHINT_DECNUM;
457 if ((num < INT32_MIN) || (num > UINT32_MAX)) {
458 /* large number */
459 *hints |= LYD_VALHINT_NUM64;
460 }
461 } else {
462 /* string value */
463 *hints |= LYD_VALHINT_STRING;
464 }
465 }
466
467 if (!first) {
468 return;
469 }
470
471 /* search backwards to find the last instance */
472 do {
473 first = first->prev;
474 if (first->schema) {
475 continue;
476 }
477
478 opaq = (struct lyd_node_opaq *)first;
479 assert(opaq->format == LY_VALUE_XML);
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100480 if (!ly_strncmp(opaq->name.name, name, name_len) &&
481 ((ns && !strcmp(opaq->name.module_ns, ns)) || (!ns && !opaq->name.module_ns))) {
Michal Vaskocea58712022-04-01 14:37:08 +0200482 if (opaq->value && opaq->value[0]) {
483 /* leaf-list nodes */
484 opaq->hints |= LYD_NODEHINT_LEAFLIST;
485 *hints |= LYD_NODEHINT_LEAFLIST;
486 } else {
487 /* list nodes */
488 opaq->hints |= LYD_NODEHINT_LIST;
489 *hints |= LYD_NODEHINT_LIST;
490 }
Michal Vaskod027f382023-02-10 09:13:25 +0100491 *anchor = (struct lyd_node *)first;
Michal Vaskocea58712022-04-01 14:37:08 +0200492 break;
493 }
494 } while (first->prev->next);
495}
496
497/**
Michal Vasko8cc3f662022-03-29 11:25:51 +0200498 * @brief Get schema node for the current element.
Michal Vaskoddd76592022-01-17 13:34:48 +0100499 *
500 * @param[in] lydctx XML data parser context.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200501 * @param[in] parent Parsed parent data node, if any.
502 * @param[in] prefix Element prefix, if any.
503 * @param[in] prefix_len Length of @p prefix.
504 * @param[in] name Element name.
505 * @param[in] name_len Length of @p name.
506 * @param[out] snode Found schema node, NULL if no suitable was found.
507 * @param[out] ext Extension instance that provided @p snode, if any.
Michal Vaskoddd76592022-01-17 13:34:48 +0100508 * @return LY_SUCCESS on success;
Michal Vaskoddd76592022-01-17 13:34:48 +0100509 * @return LY_ERR on error.
510 */
511static LY_ERR
Michal Vaskod027f382023-02-10 09:13:25 +0100512lydxml_subtree_get_snode(struct lyd_xml_ctx *lydctx, const struct lyd_node *parent, const char *prefix, size_t prefix_len,
Michal Vasko8cc3f662022-03-29 11:25:51 +0200513 const char *name, size_t name_len, const struct lysc_node **snode, struct lysc_ext_instance **ext)
Michal Vaskoddd76592022-01-17 13:34:48 +0100514{
515 LY_ERR r;
Michal Vaskob36053d2020-03-26 15:49:30 +0100516 struct lyxml_ctx *xmlctx;
517 const struct ly_ctx *ctx;
Radek Krejcie7b95092019-05-15 11:03:07 +0200518 const struct lyxml_ns *ns;
Radek Krejcie7b95092019-05-15 11:03:07 +0200519 struct lys_module *mod;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200520 uint32_t getnext_opts;
Michal Vaskoe0665742021-02-11 11:08:44 +0100521
Michal Vaskob36053d2020-03-26 15:49:30 +0100522 xmlctx = lydctx->xmlctx;
523 ctx = xmlctx->ctx;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100524 getnext_opts = lydctx->int_opts & LYD_INTOPT_REPLY ? LYS_GETNEXT_OUTPUT : 0;
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100525
Michal Vasko8cc3f662022-03-29 11:25:51 +0200526 *snode = NULL;
527 *ext = NULL;
Michal Vaskoddd76592022-01-17 13:34:48 +0100528
Michal Vasko8cc3f662022-03-29 11:25:51 +0200529 /* get current namespace */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200530 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200531 if (!ns) {
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100532 if (lydctx->int_opts & LYD_INTOPT_ANY) {
533 goto unknown_module;
534 }
535
536 if (prefix_len) {
537 LOGVAL(ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
538 } else {
539 LOGVAL(ctx, LYVE_REFERENCE, "Missing XML namespace.");
540 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200541 return LY_EVALID;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200542 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200543
544 /* get the element module, use parent context if possible because of extensions */
545 mod = ly_ctx_get_module_implemented_ns(parent ? LYD_CTX(parent) : ctx, ns->uri);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200546 if (!mod) {
Michal Vaskoddd76592022-01-17 13:34:48 +0100547 /* check for extension data */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200548 r = ly_nested_ext_schema(parent, NULL, prefix, prefix_len, LY_VALUE_XML, &lydctx->xmlctx->ns, name, name_len,
549 snode, ext);
550 if (r != LY_ENOT) {
551 /* success or error */
Michal Vaskoddd76592022-01-17 13:34:48 +0100552 return r;
Michal Vaskoddd76592022-01-17 13:34:48 +0100553 }
554
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100555unknown_module:
Michal Vaskoe0665742021-02-11 11:08:44 +0100556 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100557 LOGVAL(ctx, LYVE_REFERENCE, "No module with namespace \"%s\" in the context.", ns->uri);
Michal Vasko8cc3f662022-03-29 11:25:51 +0200558 return LY_EVALID;
Radek Krejcie7b95092019-05-15 11:03:07 +0200559 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200560 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200561 }
562
Michal Vaskoa5da3292020-08-12 13:10:50 +0200563 /* get the schema node */
Michal Vasko81008a52021-07-21 16:06:12 +0200564 if (mod) {
Radek Krejcif16e2542021-02-17 15:39:23 +0100565 if (!parent && lydctx->ext) {
Michal Vasko8cc3f662022-03-29 11:25:51 +0200566 *snode = lysc_ext_find_node(lydctx->ext, mod, name, name_len, 0, getnext_opts);
Radek Krejcif16e2542021-02-17 15:39:23 +0100567 } else {
Michal Vasko8cc3f662022-03-29 11:25:51 +0200568 *snode = lys_find_child(parent ? parent->schema : NULL, mod, name, name_len, 0, getnext_opts);
Radek Krejcif16e2542021-02-17 15:39:23 +0100569 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200570 if (!*snode) {
Michal Vaskoddd76592022-01-17 13:34:48 +0100571 /* check for extension data */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200572 r = ly_nested_ext_schema(parent, NULL, prefix, prefix_len, LY_VALUE_XML, &lydctx->xmlctx->ns, name,
573 name_len, snode, ext);
574 if (r != LY_ENOT) {
575 /* success or error */
Michal Vaskoddd76592022-01-17 13:34:48 +0100576 return r;
tadeas-vintrlik2aa36b42021-11-03 13:07:34 +0100577 }
Michal Vaskoddd76592022-01-17 13:34:48 +0100578
579 /* unknown data node */
Michal Vaskoe0665742021-02-11 11:08:44 +0100580 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
581 if (parent) {
Radek Krejci422afb12021-03-04 16:38:16 +0100582 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found as a child of \"%s\" node.",
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100583 (int)name_len, name, LYD_NAME(parent));
Radek Krejcif16e2542021-02-17 15:39:23 +0100584 } else if (lydctx->ext) {
585 if (lydctx->ext->argument) {
Radek Krejci422afb12021-03-04 16:38:16 +0100586 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" %s extension instance.",
587 (int)name_len, name, lydctx->ext->argument, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100588 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100589 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the %s extension instance.",
590 (int)name_len, name, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100591 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100592 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100593 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" module.",
594 (int)name_len, name, mod->name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100595 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200596 return LY_EVALID;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200597 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200598 return LY_SUCCESS;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200599 } else {
600 /* check that schema node is valid and can be used */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200601 LY_CHECK_RET(lyd_parser_check_schema((struct lyd_ctx *)lydctx, *snode));
602 LY_CHECK_RET(lydxml_data_check_opaq(lydctx, snode));
Michal Vaskoa5da3292020-08-12 13:10:50 +0200603 }
604 }
605
Michal Vasko8cc3f662022-03-29 11:25:51 +0200606 return LY_SUCCESS;
607}
608
609/**
Michal Vaskod027f382023-02-10 09:13:25 +0100610 * @brief Parse an XML opque node.
611 *
612 * @param[in] lydctx XML YANG data parser context.
613 * @param[in] sibling Existing sibling node, if any.
614 * @param[in] prefix Parsed node prefix.
615 * @param[in] prefix_len Length of @p prefix.
616 * @param[in] name Parsed node name.
617 * @param[in] name_len Length of @p name.
618 * @param[out] insert_anchor Optional anchor node for inserting this node.
619 * @param[out] node Created node.
620 * @return LY_ERR value.
621 */
622static LY_ERR
623lydxml_subtree_opaq(struct lyd_xml_ctx *lydctx, const struct lyd_node *sibling, const char *prefix, uint32_t prefix_len,
624 const char *name, uint32_t name_len, struct lyd_node **insert_anchor, struct lyd_node **node)
625{
626 LY_ERR rc = LY_SUCCESS;
627 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
628 const char *ns_uri;
629 const struct lyxml_ns *ns;
630 uint32_t hints;
631 void *val_prefix_data = NULL;
632 LY_VALUE_FORMAT format;
633
634 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
635
636 *node = NULL;
637
638 if (xmlctx->ws_only) {
639 /* ignore WS-only value */
640 if (xmlctx->dynamic) {
641 free((char *)xmlctx->value);
642 }
643 xmlctx->dynamic = 0;
644 xmlctx->value = "";
645 xmlctx->value_len = 0;
646 format = LY_VALUE_XML;
647 } else {
648 /* get value prefixes */
649 rc = ly_store_prefix_data(xmlctx->ctx, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns, &format,
650 &val_prefix_data);
651 LY_CHECK_GOTO(rc, cleanup);
652 }
653
654 /* get NS again, it may have been backed up and restored */
655 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
656 ns_uri = ns ? ns->uri : NULL;
657
658 /* get best-effort node hints */
659 lydxml_get_hints_opaq(name, name_len, xmlctx->value, xmlctx->value_len, sibling, ns_uri, &hints, insert_anchor);
660
661 /* create node */
662 rc = lyd_create_opaq(xmlctx->ctx, name, name_len, prefix, prefix_len, ns_uri, ns_uri ? strlen(ns_uri) : 0,
663 xmlctx->value, xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data, hints, node);
664 LY_CHECK_GOTO(rc, cleanup);
665 val_prefix_data = NULL;
666
667 /* parser next */
668 rc = lyxml_ctx_next(xmlctx);
669 LY_CHECK_GOTO(rc, cleanup);
670
671 /* process children */
672 while (xmlctx->status == LYXML_ELEMENT) {
673 rc = lydxml_subtree_r(lydctx, *node, lyd_node_child_p(*node), NULL);
674 LY_CHECK_GOTO(rc, cleanup);
675 }
676
677cleanup:
678 ly_free_prefix_data(format, val_prefix_data);
679 if (rc) {
680 lyd_free_tree(*node);
681 *node = NULL;
682 }
683 return rc;
684}
685
686/**
687 * @brief Parse an XML leaf/leaf-list node.
688 *
689 * @param[in] lydctx XML YANG data parser context.
690 * @param[in] parent Parent node, if any.
691 * @param[in] snode Schema node of the new node.
692 * @param[out] node Created node.
693 * @return LY_ERR value.
694 */
695static LY_ERR
696lydxml_subtree_term(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, const struct lysc_node *snode,
697 struct lyd_node **node)
698{
699 LY_ERR r, rc = LY_SUCCESS;
700 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
701 struct lyd_node *anchor;
702
703 *node = NULL;
704
705 /* create node */
706 r = lyd_parser_create_term((struct lyd_ctx *)lydctx, snode, xmlctx->value, xmlctx->value_len, &xmlctx->dynamic,
707 LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA, node);
708 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
709
710 if (*node) {
711 LOG_LOCSET(snode, *node, NULL, NULL);
712 }
713
714 if (parent && (snode->flags & LYS_KEY)) {
715 /* check the key order, the anchor must never be a key */
716 anchor = lyd_insert_get_next_anchor(lyd_child(parent), *node);
717 if (anchor && anchor->schema && (anchor->schema->flags & LYS_KEY)) {
718 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
719 LOGVAL(xmlctx->ctx, LYVE_DATA, "Invalid position of the key \"%s\" in a list.", snode->name);
720 r = LY_EVALID;
721 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
722 } else {
723 LOGWRN(xmlctx->ctx, "Invalid position of the key \"%s\" in a list.", snode->name);
724 }
725 }
726 }
727
728 /* parser next */
729 r = lyxml_ctx_next(xmlctx);
730 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
731
732 /* no children expected */
733 if (xmlctx->status == LYXML_ELEMENT) {
734 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Child element \"%.*s\" inside a terminal node \"%s\" found.",
735 (int)xmlctx->name_len, xmlctx->name, snode->name);
736 r = LY_EVALID;
737 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
738 }
739
740cleanup:
741 if (*node) {
742 LOG_LOCBACK(1, 1, 0, 0);
743 }
744 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
745 lyd_free_tree(*node);
746 *node = NULL;
747 }
748 return rc;
749}
750
751/**
752 * @brief Parse an XML inner node.
753 *
754 * @param[in] lydctx XML YANG data parser context.
755 * @param[in] snode Schema node of the new node.
756 * @param[in] ext Extension instance of @p snode, if any.
757 * @param[out] node Created node.
758 * @return LY_ERR value.
759 */
760static LY_ERR
761lydxml_subtree_inner(struct lyd_xml_ctx *lydctx, const struct lysc_node *snode, const struct lysc_ext_instance *ext,
762 struct lyd_node **node)
763{
764 LY_ERR r, rc = LY_SUCCESS;
765 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
766 uint32_t prev_parse_opts = lydctx->parse_opts;
767
768 *node = NULL;
769
770 if (!xmlctx->ws_only) {
771 /* value in inner node */
772 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an inner node \"%s\" found.",
773 (int)xmlctx->value_len, xmlctx->value, snode->name);
774 r = LY_EVALID;
775 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
776 }
777
778 /* create node */
779 rc = lyd_create_inner(snode, node);
780 LY_CHECK_GOTO(rc, cleanup);
781
782 if (*node) {
783 LOG_LOCSET(snode, *node, NULL, NULL);
784 }
785
786 /* parser next */
787 rc = lyxml_ctx_next(xmlctx);
788 LY_CHECK_GOTO(rc, cleanup);
789
790 if (ext) {
791 /* only parse these extension data and validate afterwards */
792 lydctx->parse_opts |= LYD_PARSE_ONLY;
793 }
794
795 /* process children */
796 while (xmlctx->status == LYXML_ELEMENT) {
797 r = lydxml_subtree_r(lydctx, *node, lyd_node_child_p(*node), NULL);
798 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
799 }
800
801 /* restore options */
802 lydctx->parse_opts = prev_parse_opts;
803
804 if (snode->nodetype == LYS_LIST) {
805 /* check all keys exist */
806 r = lyd_parse_check_keys(*node);
807 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
808 }
809
810 if (!(lydctx->parse_opts & LYD_PARSE_ONLY)) {
811 /* new node validation, autodelete CANNOT occur, all nodes are new */
812 r = lyd_validate_new(lyd_node_child_p(*node), snode, NULL, lydctx->val_opts, NULL);
813 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
814
815 /* add any missing default children */
816 r = lyd_new_implicit_r(*node, lyd_node_child_p(*node), NULL, NULL, &lydctx->node_when, &lydctx->node_types,
817 &lydctx->ext_node, (lydctx->val_opts & LYD_VALIDATE_NO_STATE) ? LYD_IMPLICIT_NO_STATE : 0, NULL);
818 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
819 }
820
821 if (snode->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)) {
822 /* rememeber the RPC/action/notification */
823 lydctx->op_node = *node;
824 }
825
826cleanup:
827 if (*node) {
828 LOG_LOCBACK(1, 1, 0, 0);
829 }
830 lydctx->parse_opts = prev_parse_opts;
831 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
832 lyd_free_tree(*node);
833 *node = NULL;
834 }
835 return rc;
836}
837
838/**
839 * @brief Parse an XML anyxml/anydata node.
840 *
841 * @param[in] lydctx XML YANG data parser context.
842 * @param[in] snode Schema node of the new node.
843 * @param[in] ext Extension instance of @p snode, if any.
844 * @param[out] node Created node.
845 * @return LY_ERR value.
846 */
847static LY_ERR
848lydxml_subtree_any(struct lyd_xml_ctx *lydctx, const struct lysc_node *snode, const struct lysc_ext_instance *ext,
849 struct lyd_node **node)
850{
851 LY_ERR r, rc = LY_SUCCESS;
852 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
853 uint32_t prev_parse_opts = lydctx->parse_opts, prev_int_opts = lydctx->int_opts;
854 struct lyd_node *child = NULL;
855 char *val = NULL;
856
857 *node = NULL;
858
859 if ((snode->nodetype == LYS_ANYDATA) && !xmlctx->ws_only) {
860 /* value in anydata node, we expect a tree */
861 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an anydata node \"%s\" found.",
862 (int)xmlctx->value_len < 20 ? xmlctx->value_len : 20, xmlctx->value, snode->name);
863 r = LY_EVALID;
864 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
865 }
866
867 if (!xmlctx->ws_only) {
868 /* use an arbitrary text value for anyxml */
869 val = strndup(xmlctx->value, xmlctx->value_len);
870 LY_CHECK_ERR_GOTO(!val, LOGMEM(xmlctx->ctx); rc = LY_EMEM, cleanup);
871
872 /* parser next */
873 r = lyxml_ctx_next(xmlctx);
874 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
875
876 /* create node */
877 r = lyd_create_any(snode, val, LYD_ANYDATA_STRING, 1, node);
878 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
879 val = NULL;
880 } else {
881 /* parser next */
882 r = lyxml_ctx_next(xmlctx);
883 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
884
885 /* update options so that generic data can be parsed */
886 lydctx->parse_opts &= ~LYD_PARSE_STRICT;
887 lydctx->parse_opts |= LYD_PARSE_OPAQ | (ext ? LYD_PARSE_ONLY : 0);
888 lydctx->int_opts |= LYD_INTOPT_ANY | LYD_INTOPT_WITH_SIBLINGS;
889
890 /* parse any data tree */
891 while (xmlctx->status == LYXML_ELEMENT) {
892 r = lydxml_subtree_r(lydctx, NULL, &child, NULL);
893 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
894 }
895
896 /* restore options */
897 lydctx->parse_opts = prev_parse_opts;
898 lydctx->int_opts = prev_int_opts;
899
900 /* create node */
901 r = lyd_create_any(snode, child, LYD_ANYDATA_DATATREE, 1, node);
902 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
903 child = NULL;
904 }
905
906cleanup:
907 lydctx->parse_opts = prev_parse_opts;
908 lydctx->int_opts = prev_int_opts;
909 free(val);
910 lyd_free_tree(child);
911 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
912 lyd_free_tree(*node);
913 *node = NULL;
914 }
915 return rc;
916}
917
918/**
919 * @brief Parse an XML subtree, recursively.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200920 *
921 * @param[in] lydctx XML YANG data parser context.
922 * @param[in,out] parent Parent node where the children are inserted. NULL in case of parsing top-level elements.
Michal Vaskod027f382023-02-10 09:13:25 +0100923 * @param[in,out] first_p Pointer to the first (@p parent or top-level) child.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200924 * @param[in,out] parsed Optional set to add all the parsed siblings into.
925 * @return LY_ERR value.
926 */
927static LY_ERR
928lydxml_subtree_r(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, struct lyd_node **first_p, struct ly_set *parsed)
929{
Michal Vaskod027f382023-02-10 09:13:25 +0100930 LY_ERR r, rc = LY_SUCCESS;
931 const char *prefix, *name;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200932 size_t prefix_len, name_len;
933 struct lyxml_ctx *xmlctx;
934 const struct ly_ctx *ctx;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200935 struct lyd_meta *meta = NULL;
936 struct lyd_attr *attr = NULL;
937 const struct lysc_node *snode;
938 struct lysc_ext_instance *ext;
Michal Vaskod027f382023-02-10 09:13:25 +0100939 uint32_t orig_parse_opts;
940 struct lyd_node *node = NULL, *insert_anchor = NULL;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200941 ly_bool parse_subtree;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200942
943 assert(parent || first_p);
944
945 xmlctx = lydctx->xmlctx;
946 ctx = xmlctx->ctx;
947
948 parse_subtree = lydctx->parse_opts & LYD_PARSE_SUBTREE ? 1 : 0;
949 /* all descendants should be parsed */
950 lydctx->parse_opts &= ~LYD_PARSE_SUBTREE;
951 orig_parse_opts = lydctx->parse_opts;
952
953 assert(xmlctx->status == LYXML_ELEMENT);
954
955 /* remember element prefix and name */
956 prefix = xmlctx->prefix;
957 prefix_len = xmlctx->prefix_len;
958 name = xmlctx->name;
959 name_len = xmlctx->name_len;
960
961 /* parser next */
Michal Vaskod027f382023-02-10 09:13:25 +0100962 rc = lyxml_ctx_next(xmlctx);
963 LY_CHECK_GOTO(rc, cleanup);
Michal Vasko8cc3f662022-03-29 11:25:51 +0200964
965 /* get the schema node */
Michal Vaskod027f382023-02-10 09:13:25 +0100966 rc = lydxml_subtree_get_snode(lydctx, parent, prefix, prefix_len, name, name_len, &snode, &ext);
967 LY_CHECK_GOTO(rc, cleanup);
Michal Vasko8cc3f662022-03-29 11:25:51 +0200968
969 if (!snode && !(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
970 LOGVRB("Skipping parsing of unknown node \"%.*s\".", name_len, name);
971
972 /* skip element with children */
Michal Vaskod027f382023-02-10 09:13:25 +0100973 rc = lydxml_data_skip(xmlctx);
974 goto cleanup;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200975 }
976
Michal Vaskoa5da3292020-08-12 13:10:50 +0200977 /* create metadata/attributes */
978 if (xmlctx->status == LYXML_ATTRIBUTE) {
979 if (snode) {
Michal Vaskod027f382023-02-10 09:13:25 +0100980 rc = lydxml_metadata(lydctx, snode, &meta);
981 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200982 } else {
Michal Vaskoe0665742021-02-11 11:08:44 +0100983 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
Michal Vaskod027f382023-02-10 09:13:25 +0100984 rc = lydxml_attrs(xmlctx, &attr);
985 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200986 }
987 }
988
989 assert(xmlctx->status == LYXML_ELEM_CONTENT);
990 if (!snode) {
Michal Vaskod027f382023-02-10 09:13:25 +0100991 /* opaque */
992 r = lydxml_subtree_opaq(lydctx, parent ? lyd_child(parent) : *first_p, prefix, prefix_len, name, name_len,
993 &insert_anchor, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200994 } else if (snode->nodetype & LYD_NODE_TERM) {
Michal Vaskod027f382023-02-10 09:13:25 +0100995 /* term */
996 r = lydxml_subtree_term(lydctx, parent, snode, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200997 } else if (snode->nodetype & LYD_NODE_INNER) {
Michal Vaskod027f382023-02-10 09:13:25 +0100998 /* inner */
999 r = lydxml_subtree_inner(lydctx, snode, ext, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001000 } else if (snode->nodetype & LYD_NODE_ANY) {
Michal Vaskod027f382023-02-10 09:13:25 +01001001 /* any */
1002 r = lydxml_subtree_any(lydctx, snode, ext, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001003 }
Michal Vaskod027f382023-02-10 09:13:25 +01001004 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
1005 LY_CHECK_GOTO(!node, cleanup);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001006
Michal Vaskoa5da3292020-08-12 13:10:50 +02001007 if (snode) {
Michal Vasko135719f2022-08-25 12:18:17 +02001008 /* add/correct flags */
Michal Vaskod027f382023-02-10 09:13:25 +01001009 r = lyd_parse_set_data_flags(node, &meta, (struct lyd_ctx *)lydctx, ext);
1010 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vasko135719f2022-08-25 12:18:17 +02001011
Michal Vaskoeba23112022-08-26 08:35:41 +02001012 if (!(lydctx->parse_opts & LYD_PARSE_ONLY)) {
1013 /* store for ext instance node validation, if needed */
Michal Vaskod027f382023-02-10 09:13:25 +01001014 r = lyd_validate_node_ext(node, &lydctx->ext_node);
1015 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoeba23112022-08-26 08:35:41 +02001016 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001017 }
1018
1019 /* parser next */
1020 assert(xmlctx->status == LYXML_ELEM_CLOSE);
Michal Vaskoddd76592022-01-17 13:34:48 +01001021 if (!parse_subtree) {
Michal Vaskod027f382023-02-10 09:13:25 +01001022 r = lyxml_ctx_next(xmlctx);
1023 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vaskoddd76592022-01-17 13:34:48 +01001024 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001025
1026 /* add metadata/attributes */
1027 if (snode) {
Michal Vasko871a0252020-11-11 18:35:24 +01001028 lyd_insert_meta(node, meta, 0);
Michal Vaskod027f382023-02-10 09:13:25 +01001029 meta = NULL;
Michal Vaskoa5da3292020-08-12 13:10:50 +02001030 } else {
1031 lyd_insert_attr(node, attr);
Michal Vaskod027f382023-02-10 09:13:25 +01001032 attr = NULL;
Michal Vaskoa5da3292020-08-12 13:10:50 +02001033 }
1034
1035 /* insert, keep first pointer correct */
Michal Vaskocea58712022-04-01 14:37:08 +02001036 if (insert_anchor) {
1037 lyd_insert_after(insert_anchor, node);
1038 } else if (ext) {
Michal Vaskod027f382023-02-10 09:13:25 +01001039 r = lyplg_ext_insert(parent, node);
1040 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vasko8cc3f662022-03-29 11:25:51 +02001041 } else {
1042 lyd_insert_node(parent, first_p, node, lydctx->parse_opts & LYD_PARSE_ORDERED ? 1 : 0);
1043 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001044 while (!parent && (*first_p)->prev->next) {
1045 *first_p = (*first_p)->prev;
1046 }
1047
Michal Vaskoe0665742021-02-11 11:08:44 +01001048 /* rememeber a successfully parsed node */
1049 if (parsed) {
1050 ly_set_add(parsed, node, 1, NULL);
1051 }
1052
Michal Vaskod027f382023-02-10 09:13:25 +01001053cleanup:
Michal Vasko8cc3f662022-03-29 11:25:51 +02001054 lydctx->parse_opts = orig_parse_opts;
Michal Vasko3a41dff2020-07-15 14:30:28 +02001055 lyd_free_meta_siblings(meta);
Radek Krejci011e4aa2020-09-04 15:22:31 +02001056 lyd_free_attr_siblings(ctx, attr);
Michal Vaskod027f382023-02-10 09:13:25 +01001057 return rc;
Radek Krejcie7b95092019-05-15 11:03:07 +02001058}
1059
Michal Vaskoe0665742021-02-11 11:08:44 +01001060/**
1061 * @brief Parse a specific XML element into an opaque node.
1062 *
1063 * @param[in] xmlctx XML parser context.
1064 * @param[in] name Name of the element.
1065 * @param[in] uri URI of the element.
1066 * @param[in] value Whether a value is expected in the element.
1067 * @param[out] evnp Parsed envelope (opaque node).
1068 * @return LY_SUCCESS on success.
1069 * @return LY_ENOT if the specified element did not match.
1070 * @return LY_ERR value on error.
1071 */
Michal Vasko1bf09392020-03-27 12:38:10 +01001072static LY_ERR
Michal Vaskoe0665742021-02-11 11:08:44 +01001073lydxml_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 +01001074{
Michal Vaskoe0665742021-02-11 11:08:44 +01001075 LY_ERR rc = LY_SUCCESS;
1076 const struct lyxml_ns *ns;
Radek Krejci1798aae2020-07-14 13:26:06 +02001077 struct lyd_attr *attr = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +01001078 const char *prefix;
1079 size_t prefix_len;
1080
Michal Vasko1bf09392020-03-27 12:38:10 +01001081 assert(xmlctx->status == LYXML_ELEMENT);
1082 if (ly_strncmp(name, xmlctx->name, xmlctx->name_len)) {
1083 /* not the expected element */
Michal Vaskoe0665742021-02-11 11:08:44 +01001084 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001085 }
1086
1087 prefix = xmlctx->prefix;
1088 prefix_len = xmlctx->prefix_len;
Michal Vaskoc8a230d2020-08-14 12:17:10 +02001089 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001090 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +01001091 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +01001092 return LY_EVALID;
1093 } else if (strcmp(ns->uri, uri)) {
1094 /* different namespace */
1095 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001096 }
1097
1098 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
1099
1100 /* create attributes */
1101 if (xmlctx->status == LYXML_ATTRIBUTE) {
1102 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
1103 }
1104
Michal Vaskoe0665742021-02-11 11:08:44 +01001105 assert(xmlctx->status == LYXML_ELEM_CONTENT);
1106 if (!value && !xmlctx->ws_only) {
1107 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected value \"%.*s\" in the \"%s\" element.",
Radek Krejci422afb12021-03-04 16:38:16 +01001108 (int)xmlctx->value_len, xmlctx->value, name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001109 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001110 goto cleanup;
Michal Vaskoe0665742021-02-11 11:08:44 +01001111 }
Michal Vaskoa8edff02020-03-27 14:47:01 +01001112
1113 /* create node */
Michal Vaskoe0665742021-02-11 11:08:44 +01001114 rc = lyd_create_opaq(xmlctx->ctx, name, strlen(name), prefix, prefix_len, uri, strlen(uri), xmlctx->value,
Radek Krejci8df109d2021-04-23 12:19:08 +02001115 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001116 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001117
1118 /* assign atributes */
Michal Vaskoe0665742021-02-11 11:08:44 +01001119 ((struct lyd_node_opaq *)(*envp))->attr = attr;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001120 attr = NULL;
1121
Michal Vaskoe0665742021-02-11 11:08:44 +01001122 /* parser next element */
1123 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001124
Michal Vaskoe0665742021-02-11 11:08:44 +01001125cleanup:
1126 lyd_free_attr_siblings(xmlctx->ctx, attr);
1127 if (rc) {
1128 lyd_free_tree(*envp);
1129 *envp = NULL;
1130 }
1131 return rc;
1132}
1133
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001134LY_ERR
1135lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
1136 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, uint32_t int_opts,
1137 struct ly_set *parsed, ly_bool *subtree_sibling, struct lyd_ctx **lydctx_p)
1138{
Michal Vaskod027f382023-02-10 09:13:25 +01001139 LY_ERR r, rc = LY_SUCCESS;
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001140 struct lyd_xml_ctx *lydctx;
1141 ly_bool parsed_data_nodes = 0;
1142 enum LYXML_PARSER_STATUS status;
1143
1144 assert(ctx && in && lydctx_p);
1145 assert(!(parse_opts & ~LYD_PARSE_OPTS_MASK));
1146 assert(!(val_opts & ~LYD_VALIDATE_OPTS_MASK));
1147
1148 /* init context */
1149 lydctx = calloc(1, sizeof *lydctx);
1150 LY_CHECK_ERR_RET(!lydctx, LOGMEM(ctx), LY_EMEM);
1151 LY_CHECK_GOTO(rc = lyxml_ctx_new(ctx, in, &lydctx->xmlctx), cleanup);
1152 lydctx->parse_opts = parse_opts;
1153 lydctx->val_opts = val_opts;
1154 lydctx->int_opts = int_opts;
1155 lydctx->free = lyd_xml_ctx_free;
1156 lydctx->ext = ext;
1157
1158 /* find the operation node if it exists already */
1159 LY_CHECK_GOTO(rc = lyd_parser_find_operation(parent, int_opts, &lydctx->op_node), cleanup);
1160
1161 /* parse XML data */
1162 while (lydctx->xmlctx->status == LYXML_ELEMENT) {
Michal Vaskod027f382023-02-10 09:13:25 +01001163 r = lydxml_subtree_r(lydctx, parent, first_p, parsed);
1164 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
1165
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001166 parsed_data_nodes = 1;
1167
1168 if (!(int_opts & LYD_INTOPT_WITH_SIBLINGS)) {
1169 break;
1170 }
1171 }
1172
1173 /* check final state */
1174 if ((int_opts & LYD_INTOPT_NO_SIBLINGS) && (lydctx->xmlctx->status == LYXML_ELEMENT)) {
1175 LOGVAL(ctx, LYVE_SYNTAX, "Unexpected sibling node.");
Michal Vaskod027f382023-02-10 09:13:25 +01001176 r = LY_EVALID;
1177 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001178 }
1179 if ((int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_ACTION | LYD_INTOPT_NOTIF | LYD_INTOPT_REPLY)) && !lydctx->op_node) {
1180 LOGVAL(ctx, LYVE_DATA, "Missing the operation node.");
Michal Vaskod027f382023-02-10 09:13:25 +01001181 r = LY_EVALID;
1182 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001183 }
1184
1185 if (!parsed_data_nodes) {
1186 /* no data nodes were parsed */
1187 lydctx->op_node = NULL;
1188 }
1189
1190 if (parse_opts & LYD_PARSE_SUBTREE) {
1191 /* check for a sibling element */
1192 assert(subtree_sibling);
1193 if (!lyxml_ctx_peek(lydctx->xmlctx, &status) && (status == LYXML_ELEMENT)) {
1194 *subtree_sibling = 1;
1195 } else {
1196 *subtree_sibling = 0;
1197 }
1198 }
1199
1200cleanup:
1201 /* there should be no unres stored if validation should be skipped */
1202 assert(!(parse_opts & LYD_PARSE_ONLY) || (!lydctx->node_types.count && !lydctx->meta_types.count &&
1203 !lydctx->node_when.count));
1204
Michal Vaskod027f382023-02-10 09:13:25 +01001205 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001206 lyd_xml_ctx_free((struct lyd_ctx *)lydctx);
1207 } else {
1208 *lydctx_p = (struct lyd_ctx *)lydctx;
1209
1210 /* the XML context is no more needed, freeing it also stops logging line numbers which would be confusing now */
1211 lyxml_ctx_free(lydctx->xmlctx);
1212 lydctx->xmlctx = NULL;
1213 }
1214 return rc;
1215}
1216
Michal Vaskoe0665742021-02-11 11:08:44 +01001217/**
1218 * @brief Parse all expected non-data XML elements of a NETCONF rpc message.
1219 *
1220 * @param[in] xmlctx XML parser context.
1221 * @param[out] evnp Parsed envelope(s) (opaque node).
1222 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1223 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1224 * @return LY_SUCCESS on success.
1225 * @return LY_ERR value on error.
1226 */
1227static LY_ERR
1228lydxml_env_netconf_rpc(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1229{
1230 LY_ERR rc = LY_SUCCESS, r;
1231 struct lyd_node *child;
1232
1233 assert(envp && !*envp);
1234
Michal Vasko50375272022-04-26 12:07:46 +02001235 if (xmlctx->status != LYXML_ELEMENT) {
1236 /* nothing to parse */
1237 assert(xmlctx->status == LYXML_END);
1238 goto cleanup;
1239 }
1240
Michal Vaskoe0665742021-02-11 11:08:44 +01001241 /* parse "rpc" */
1242 r = lydxml_envelope(xmlctx, "rpc", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001243 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1244
1245 /* parse "action", if any */
1246 r = lydxml_envelope(xmlctx, "action", "urn:ietf:params:xml:ns:yang:1", 0, &child);
1247 if (r == LY_SUCCESS) {
1248 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001249 lyd_insert_node(*envp, NULL, child, 0);
Michal Vaskoe0665742021-02-11 11:08:44 +01001250
1251 /* NETCONF action */
1252 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_ACTION;
1253 *close_elem = 2;
1254 } else if (r == LY_ENOT) {
1255 /* NETCONF RPC */
1256 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_RPC;
1257 *close_elem = 1;
1258 } else {
1259 rc = r;
1260 goto cleanup;
1261 }
1262
1263cleanup:
1264 if (rc) {
1265 lyd_free_tree(*envp);
1266 *envp = NULL;
1267 }
1268 return rc;
1269}
1270
1271/**
Michal Vasko51de7b72022-04-29 09:50:22 +02001272 * @brief Validate eventTime date-and-time value.
1273 *
1274 * @param[in] node Opaque eventTime node.
1275 * @return LY_SUCCESS on success.
1276 * @return LY_ERR value on error.
1277 */
1278static LY_ERR
1279lydxml_env_netconf_eventtime_validate(const struct lyd_node *node)
1280{
1281 LY_ERR rc = LY_SUCCESS;
1282 struct ly_ctx *ctx = (struct ly_ctx *)LYD_CTX(node);
Michal Vaskoc636ea42022-09-16 10:20:31 +02001283 struct lysc_ctx cctx;
Michal Vasko51de7b72022-04-29 09:50:22 +02001284 const struct lys_module *mod;
1285 LY_ARRAY_COUNT_TYPE u;
1286 struct ly_err_item *err = NULL;
Michal Vaskoab36a7e2022-04-29 10:25:56 +02001287 struct lysp_type *type_p = NULL;
Michal Vasko51de7b72022-04-29 09:50:22 +02001288 struct lysc_pattern **patterns = NULL;
1289 const char *value;
1290
Michal Vaskoc636ea42022-09-16 10:20:31 +02001291 LYSC_CTX_INIT_CTX(cctx, ctx);
1292
Michal Vasko51de7b72022-04-29 09:50:22 +02001293 /* get date-and-time parsed type */
1294 mod = ly_ctx_get_module_latest(ctx, "ietf-yang-types");
Michal Vaskoab36a7e2022-04-29 10:25:56 +02001295 assert(mod);
Michal Vasko51de7b72022-04-29 09:50:22 +02001296 LY_ARRAY_FOR(mod->parsed->typedefs, u) {
1297 if (!strcmp(mod->parsed->typedefs[u].name, "date-and-time")) {
1298 type_p = &mod->parsed->typedefs[u].type;
1299 break;
1300 }
1301 }
1302 assert(type_p);
1303
1304 /* compile patterns */
1305 assert(type_p->patterns);
1306 LY_CHECK_GOTO(rc = lys_compile_type_patterns(&cctx, type_p->patterns, NULL, &patterns), cleanup);
1307
1308 /* validate */
1309 value = lyd_get_value(node);
1310 rc = lyplg_type_validate_patterns(patterns, value, strlen(value), &err);
1311
1312cleanup:
Michal Vaskoc636ea42022-09-16 10:20:31 +02001313 FREE_ARRAY(&cctx.free_ctx, patterns, lysc_pattern_free);
Michal Vasko51de7b72022-04-29 09:50:22 +02001314 if (rc && err) {
1315 LOGVAL_ERRITEM(ctx, err);
1316 ly_err_free(err);
1317 LOGVAL(ctx, LYVE_DATA, "Invalid \"eventTime\" in the notification.");
1318 }
1319 return rc;
1320}
1321
1322/**
Michal Vaskoe0665742021-02-11 11:08:44 +01001323 * @brief Parse all expected non-data XML elements of a NETCONF notification message.
1324 *
1325 * @param[in] xmlctx XML parser context.
1326 * @param[out] evnp Parsed envelope(s) (opaque node).
1327 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1328 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1329 * @return LY_SUCCESS on success.
1330 * @return LY_ERR value on error.
1331 */
1332static LY_ERR
1333lydxml_env_netconf_notif(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1334{
1335 LY_ERR rc = LY_SUCCESS, r;
1336 struct lyd_node *child;
1337
1338 assert(envp && !*envp);
1339
Michal Vasko50375272022-04-26 12:07:46 +02001340 if (xmlctx->status != LYXML_ELEMENT) {
1341 /* nothing to parse */
1342 assert(xmlctx->status == LYXML_END);
1343 goto cleanup;
1344 }
1345
Michal Vaskoe0665742021-02-11 11:08:44 +01001346 /* parse "notification" */
1347 r = lydxml_envelope(xmlctx, "notification", "urn:ietf:params:xml:ns:netconf:notification:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001348 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1349
1350 /* parse "eventTime" */
1351 r = lydxml_envelope(xmlctx, "eventTime", "urn:ietf:params:xml:ns:netconf:notification:1.0", 1, &child);
1352 if (r == LY_ENOT) {
Radek Krejci422afb12021-03-04 16:38:16 +01001353 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unexpected element \"%.*s\" instead of \"eventTime\".",
1354 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001355 r = LY_EVALID;
1356 }
1357 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1358
1359 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001360 lyd_insert_node(*envp, NULL, child, 0);
Michal Vaskoe0665742021-02-11 11:08:44 +01001361
1362 /* validate value */
Michal Vasko51de7b72022-04-29 09:50:22 +02001363 r = lydxml_env_netconf_eventtime_validate(child);
1364 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001365
1366 /* finish child parsing */
Michal Vaskoa8edff02020-03-27 14:47:01 +01001367 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1368 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoe0665742021-02-11 11:08:44 +01001369 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"eventTime\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001370 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001371 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001372 goto cleanup;
1373 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001374 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1375
1376 /* NETCONF notification */
1377 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_NOTIF;
1378 *close_elem = 1;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001379
1380cleanup:
Michal Vaskoe0665742021-02-11 11:08:44 +01001381 if (rc) {
Michal Vaskoa8edff02020-03-27 14:47:01 +01001382 lyd_free_tree(*envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001383 *envp = NULL;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001384 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001385 return rc;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001386}
Michal Vasko79135ae2020-12-16 10:08:35 +01001387
Michal Vaskoe0665742021-02-11 11:08:44 +01001388/**
1389 * @brief Parse an XML element as an opaque node subtree.
1390 *
1391 * @param[in] xmlctx XML parser context.
1392 * @param[in] parent Parent to append nodes to.
1393 * @return LY_ERR value.
1394 */
1395static LY_ERR
1396lydxml_opaq_r(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
Michal Vaskoa8edff02020-03-27 14:47:01 +01001397{
Michal Vaskoe0665742021-02-11 11:08:44 +01001398 LY_ERR rc = LY_SUCCESS;
1399 const struct lyxml_ns *ns;
1400 struct lyd_attr *attr = NULL;
1401 struct lyd_node *child = NULL;
1402 const char *name, *prefix;
1403 size_t name_len, prefix_len;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001404
Michal Vaskoe0665742021-02-11 11:08:44 +01001405 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001406
Michal Vaskoe0665742021-02-11 11:08:44 +01001407 name = xmlctx->name;
1408 name_len = xmlctx->name_len;
1409 prefix = xmlctx->prefix;
1410 prefix_len = xmlctx->prefix_len;
1411 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
1412 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +01001413 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +01001414 return LY_EVALID;
1415 }
Michal Vaskoa8edff02020-03-27 14:47:01 +01001416
Michal Vaskoe0665742021-02-11 11:08:44 +01001417 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
Michal Vaskoa8edff02020-03-27 14:47:01 +01001418
Michal Vaskoe0665742021-02-11 11:08:44 +01001419 /* create attributes */
1420 if (xmlctx->status == LYXML_ATTRIBUTE) {
1421 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
1422 }
1423
1424 /* create node */
1425 assert(xmlctx->status == LYXML_ELEM_CONTENT);
1426 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 +02001427 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, &child);
Michal Vaskoe0665742021-02-11 11:08:44 +01001428 LY_CHECK_GOTO(rc, cleanup);
1429
1430 /* assign atributes */
1431 ((struct lyd_node_opaq *)child)->attr = attr;
1432 attr = NULL;
1433
1434 /* parser next element */
1435 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1436
1437 /* parse all the descendants */
1438 while (xmlctx->status == LYXML_ELEMENT) {
1439 rc = lydxml_opaq_r(xmlctx, child);
1440 LY_CHECK_GOTO(rc, cleanup);
1441 }
1442
1443 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001444 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001445
1446cleanup:
1447 lyd_free_attr_siblings(xmlctx->ctx, attr);
1448 if (rc) {
1449 lyd_free_tree(child);
1450 }
1451 return rc;
1452}
1453
1454/**
1455 * @brief Parse all expected non-data XML elements of the error-info element in NETCONF rpc-reply message.
1456 *
1457 * @param[in] xmlctx XML parser context.
1458 * @param[in] parent Parent to append nodes to.
1459 * @return LY_ERR value.
1460 */
1461static LY_ERR
1462lydxml_env_netconf_rpc_reply_error_info(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
1463{
1464 LY_ERR r;
1465 struct lyd_node *child, *iter;
Michal Vaskoe0665742021-02-11 11:08:44 +01001466 ly_bool no_dup;
1467
1468 /* there must be some child */
1469 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1470 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"error-info\".");
1471 return LY_EVALID;
1472 }
1473
1474 while (xmlctx->status == LYXML_ELEMENT) {
1475 child = NULL;
1476
1477 /*
1478 * session-id
1479 */
1480 r = lydxml_envelope(xmlctx, "session-id", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1481 if (r == LY_SUCCESS) {
1482 no_dup = 1;
1483 goto check_child;
1484 } else if (r != LY_ENOT) {
1485 goto error;
1486 }
1487
1488 /*
1489 * bad-attribute
1490 */
1491 r = lydxml_envelope(xmlctx, "bad-attribute", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1492 if (r == LY_SUCCESS) {
1493 no_dup = 1;
1494 goto check_child;
1495 } else if (r != LY_ENOT) {
1496 goto error;
1497 }
1498
1499 /*
1500 * bad-element
1501 */
1502 r = lydxml_envelope(xmlctx, "bad-element", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1503 if (r == LY_SUCCESS) {
1504 no_dup = 1;
1505 goto check_child;
1506 } else if (r != LY_ENOT) {
1507 goto error;
1508 }
1509
1510 /*
1511 * bad-namespace
1512 */
1513 r = lydxml_envelope(xmlctx, "bad-namespace", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1514 if (r == LY_SUCCESS) {
1515 no_dup = 1;
1516 goto check_child;
1517 } else if (r != LY_ENOT) {
1518 goto error;
1519 }
1520
1521 if (r == LY_ENOT) {
1522 assert(xmlctx->status == LYXML_ELEMENT);
1523
Michal Vasko845ba392022-06-16 07:52:13 +02001524 /* custom elements, parse all the siblings */
1525 while (xmlctx->status == LYXML_ELEMENT) {
1526 LY_CHECK_GOTO(r = lydxml_opaq_r(xmlctx, parent), error);
1527 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1528 }
Michal Vasko6398eaf2022-01-10 10:12:30 +01001529 continue;
Michal Vaskoe0665742021-02-11 11:08:44 +01001530 }
1531
1532check_child:
1533 /* check for duplicates */
1534 if (no_dup) {
1535 LY_LIST_FOR(lyd_child(parent), iter) {
1536 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1537 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1538 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"error-info\".",
1539 ((struct lyd_node_opaq *)child)->name.name);
1540 r = LY_EVALID;
1541 goto error;
1542 }
1543 }
1544 }
1545
1546 /* finish child parsing */
1547 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1548 assert(xmlctx->status == LYXML_ELEMENT);
1549 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"error-info\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001550 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001551 r = LY_EVALID;
1552 goto error;
1553 }
1554 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1555
1556 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001557 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001558 }
1559
1560 return LY_SUCCESS;
1561
1562error:
1563 lyd_free_tree(child);
1564 return r;
1565}
1566
1567/**
1568 * @brief Parse all expected non-data XML elements of the rpc-error element in NETCONF rpc-reply message.
1569 *
1570 * @param[in] xmlctx XML parser context.
1571 * @param[in] parent Parent to append nodes to.
1572 * @return LY_ERR value.
1573 */
1574static LY_ERR
1575lydxml_env_netconf_rpc_reply_error(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
1576{
1577 LY_ERR r;
1578 struct lyd_node *child, *iter;
1579 const char *val;
1580 ly_bool no_dup;
1581
1582 /* there must be some child */
1583 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1584 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-error\".");
1585 return LY_EVALID;
1586 }
1587
1588 while (xmlctx->status == LYXML_ELEMENT) {
1589 child = NULL;
1590
1591 /*
1592 * error-type
1593 */
1594 r = lydxml_envelope(xmlctx, "error-type", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1595 if (r == LY_SUCCESS) {
1596 val = ((struct lyd_node_opaq *)child)->value;
1597 if (strcmp(val, "transport") && strcmp(val, "rpc") && strcmp(val, "protocol") && strcmp(val, "application")) {
1598 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1599 ((struct lyd_node_opaq *)child)->name.name);
1600 r = LY_EVALID;
1601 goto error;
1602 }
1603
1604 no_dup = 1;
1605 goto check_child;
1606 } else if (r != LY_ENOT) {
1607 goto error;
1608 }
1609
1610 /*
1611 * error-tag
1612 */
1613 r = lydxml_envelope(xmlctx, "error-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1614 if (r == LY_SUCCESS) {
1615 val = ((struct lyd_node_opaq *)child)->value;
1616 if (strcmp(val, "in-use") && strcmp(val, "invalid-value") && strcmp(val, "too-big") &&
1617 strcmp(val, "missing-attribute") && strcmp(val, "bad-attribute") &&
1618 strcmp(val, "unknown-attribute") && strcmp(val, "missing-element") && strcmp(val, "bad-element") &&
1619 strcmp(val, "unknown-element") && strcmp(val, "unknown-namespace") && strcmp(val, "access-denied") &&
1620 strcmp(val, "lock-denied") && strcmp(val, "resource-denied") && strcmp(val, "rollback-failed") &&
1621 strcmp(val, "data-exists") && strcmp(val, "data-missing") && strcmp(val, "operation-not-supported") &&
1622 strcmp(val, "operation-failed") && strcmp(val, "malformed-message")) {
1623 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1624 ((struct lyd_node_opaq *)child)->name.name);
1625 r = LY_EVALID;
1626 goto error;
1627 }
1628
1629 no_dup = 1;
1630 goto check_child;
1631 } else if (r != LY_ENOT) {
1632 goto error;
1633 }
1634
1635 /*
1636 * error-severity
1637 */
1638 r = lydxml_envelope(xmlctx, "error-severity", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1639 if (r == LY_SUCCESS) {
1640 val = ((struct lyd_node_opaq *)child)->value;
1641 if (strcmp(val, "error") && strcmp(val, "warning")) {
1642 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1643 ((struct lyd_node_opaq *)child)->name.name);
1644 r = LY_EVALID;
1645 goto error;
1646 }
1647
1648 no_dup = 1;
1649 goto check_child;
1650 } else if (r != LY_ENOT) {
1651 goto error;
1652 }
1653
1654 /*
1655 * error-app-tag
1656 */
1657 r = lydxml_envelope(xmlctx, "error-app-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1658 if (r == LY_SUCCESS) {
1659 no_dup = 1;
1660 goto check_child;
1661 } else if (r != LY_ENOT) {
1662 goto error;
1663 }
1664
1665 /*
1666 * error-path
1667 */
1668 r = lydxml_envelope(xmlctx, "error-path", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1669 if (r == LY_SUCCESS) {
1670 no_dup = 1;
1671 goto check_child;
1672 } else if (r != LY_ENOT) {
1673 goto error;
1674 }
1675
1676 /*
1677 * error-message
1678 */
1679 r = lydxml_envelope(xmlctx, "error-message", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1680 if (r == LY_SUCCESS) {
1681 no_dup = 1;
1682 goto check_child;
1683 } else if (r != LY_ENOT) {
1684 goto error;
1685 }
1686
1687 /* error-info */
1688 r = lydxml_envelope(xmlctx, "error-info", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1689 if (r == LY_SUCCESS) {
1690 /* parse all the descendants */
1691 LY_CHECK_GOTO(r = lydxml_env_netconf_rpc_reply_error_info(xmlctx, child), error);
1692
1693 no_dup = 0;
1694 goto check_child;
1695 } else if (r != LY_ENOT) {
1696 goto error;
1697 }
1698
1699 if (r == LY_ENOT) {
1700 assert(xmlctx->status == LYXML_ELEMENT);
1701 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001702 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001703 r = LY_EVALID;
1704 goto error;
1705 }
1706
1707check_child:
1708 /* check for duplicates */
1709 if (no_dup) {
1710 LY_LIST_FOR(lyd_child(parent), iter) {
1711 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1712 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1713 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"rpc-error\".",
1714 ((struct lyd_node_opaq *)child)->name.name);
1715 r = LY_EVALID;
1716 goto error;
1717 }
1718 }
1719 }
1720
1721 /* finish child parsing */
1722 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1723 assert(xmlctx->status == LYXML_ELEMENT);
1724 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001725 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001726 r = LY_EVALID;
1727 goto error;
1728 }
1729 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1730
1731 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001732 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001733 }
1734
1735 return LY_SUCCESS;
1736
1737error:
1738 lyd_free_tree(child);
1739 return r;
1740}
1741
1742/**
1743 * @brief Parse all expected non-data XML elements of a NETCONF rpc-reply message.
1744 *
1745 * @param[in] xmlctx XML parser context.
1746 * @param[out] evnp Parsed envelope(s) (opaque node).
1747 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1748 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1749 * @return LY_SUCCESS on success.
1750 * @return LY_ERR value on error.
1751 */
1752static LY_ERR
1753lydxml_env_netconf_reply(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1754{
1755 LY_ERR rc = LY_SUCCESS, r;
1756 struct lyd_node *child = NULL;
1757 const char *parsed_elem = NULL;
1758
1759 assert(envp && !*envp);
1760
Michal Vasko50375272022-04-26 12:07:46 +02001761 if (xmlctx->status != LYXML_ELEMENT) {
1762 /* nothing to parse */
1763 assert(xmlctx->status == LYXML_END);
1764 goto cleanup;
1765 }
1766
Michal Vaskoe0665742021-02-11 11:08:44 +01001767 /* parse "rpc-reply" */
1768 r = lydxml_envelope(xmlctx, "rpc-reply", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001769 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1770
1771 /* there must be some child */
1772 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1773 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-reply\".");
1774 rc = LY_EVALID;
Michal Vaskocf770e22020-08-12 13:21:43 +02001775 goto cleanup;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001776 }
1777
Michal Vaskoe0665742021-02-11 11:08:44 +01001778 /* try to parse "ok" */
1779 r = lydxml_envelope(xmlctx, "ok", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1780 if (r == LY_SUCCESS) {
1781 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001782 lyd_insert_node(*envp, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001783
1784 /* finish child parsing */
1785 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1786 assert(xmlctx->status == LYXML_ELEMENT);
1787 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"ok\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001788 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001789 rc = LY_EVALID;
1790 goto cleanup;
1791 }
1792 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1793
1794 /* success */
1795 parsed_elem = "ok";
1796 goto finish;
1797 } else if (r != LY_ENOT) {
1798 rc = r;
1799 goto cleanup;
Michal Vasko2552ea32020-12-08 15:32:34 +01001800 }
1801
Michal Vaskoe0665742021-02-11 11:08:44 +01001802 /* try to parse all "rpc-error" elements */
1803 while (xmlctx->status == LYXML_ELEMENT) {
1804 r = lydxml_envelope(xmlctx, "rpc-error", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1805 if (r == LY_ENOT) {
1806 break;
1807 } else if (r) {
1808 rc = r;
1809 goto cleanup;
1810 }
1811
1812 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001813 lyd_insert_node(*envp, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001814
1815 /* parse all children of "rpc-error" */
1816 LY_CHECK_GOTO(rc = lydxml_env_netconf_rpc_reply_error(xmlctx, child), cleanup);
1817
1818 /* finish child parsing */
1819 assert(xmlctx->status == LYXML_ELEM_CLOSE);
1820 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1821
1822 parsed_elem = "rpc-error";
Michal Vasko2552ea32020-12-08 15:32:34 +01001823 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001824
1825finish:
1826 if (parsed_elem) {
1827 /* NETCONF rpc-reply with no data */
1828 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1829 assert(xmlctx->status == LYXML_ELEMENT);
1830 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected sibling element \"%.*s\" of \"%s\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001831 (int)xmlctx->name_len, xmlctx->name, parsed_elem);
Michal Vaskoe0665742021-02-11 11:08:44 +01001832 rc = LY_EVALID;
1833 goto cleanup;
1834 }
1835 }
1836
1837 /* NETCONF rpc-reply */
Michal Vasko1d991fd2021-07-09 13:14:40 +02001838 *int_opts = LYD_INTOPT_WITH_SIBLINGS | LYD_INTOPT_REPLY;
Michal Vaskoe0665742021-02-11 11:08:44 +01001839 *close_elem = 1;
1840
1841cleanup:
1842 if (rc) {
1843 lyd_free_tree(*envp);
1844 *envp = NULL;
1845 }
1846 return rc;
1847}
1848
Michal Vasko2552ea32020-12-08 15:32:34 +01001849LY_ERR
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001850lyd_parse_xml_netconf(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
Radek Krejcif16e2542021-02-17 15:39:23 +01001851 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, enum lyd_type data_type,
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001852 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p)
Michal Vasko2552ea32020-12-08 15:32:34 +01001853{
Michal Vaskoe0665742021-02-11 11:08:44 +01001854 LY_ERR rc = LY_SUCCESS;
1855 struct lyd_xml_ctx *lydctx;
Michal Vasko2ca9f9e2021-07-02 09:21:36 +02001856 uint32_t i, int_opts = 0, close_elem = 0;
Michal Vaskoe0665742021-02-11 11:08:44 +01001857 ly_bool parsed_data_nodes = 0;
Michal Vasko2552ea32020-12-08 15:32:34 +01001858
Michal Vaskoe0665742021-02-11 11:08:44 +01001859 assert(ctx && in && lydctx_p);
1860 assert(!(parse_opts & ~LYD_PARSE_OPTS_MASK));
1861 assert(!(val_opts & ~LYD_VALIDATE_OPTS_MASK));
Michal Vasko2552ea32020-12-08 15:32:34 +01001862
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001863 assert((data_type == LYD_TYPE_RPC_NETCONF) || (data_type == LYD_TYPE_NOTIF_NETCONF) ||
1864 (data_type == LYD_TYPE_REPLY_NETCONF));
1865 assert(!(parse_opts & LYD_PARSE_SUBTREE));
1866
Michal Vaskoe0665742021-02-11 11:08:44 +01001867 /* init context */
1868 lydctx = calloc(1, sizeof *lydctx);
1869 LY_CHECK_ERR_RET(!lydctx, LOGMEM(ctx), LY_EMEM);
1870 LY_CHECK_GOTO(rc = lyxml_ctx_new(ctx, in, &lydctx->xmlctx), cleanup);
1871 lydctx->parse_opts = parse_opts;
1872 lydctx->val_opts = val_opts;
1873 lydctx->free = lyd_xml_ctx_free;
Radek Krejcif16e2542021-02-17 15:39:23 +01001874 lydctx->ext = ext;
Michal Vasko2552ea32020-12-08 15:32:34 +01001875
Michal Vaskoe0665742021-02-11 11:08:44 +01001876 switch (data_type) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001877 case LYD_TYPE_RPC_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001878 assert(!parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001879 rc = lydxml_env_netconf_rpc(lydctx->xmlctx, envp, &int_opts, &close_elem);
1880 if (rc == LY_ENOT) {
1881 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <rpc> envelope or in incorrect namespace.");
1882 }
1883 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001884 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001885 case LYD_TYPE_NOTIF_NETCONF:
1886 assert(!parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001887 rc = lydxml_env_netconf_notif(lydctx->xmlctx, envp, &int_opts, &close_elem);
1888 if (rc == LY_ENOT) {
1889 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <notification> envelope or in incorrect namespace.");
1890 }
1891 LY_CHECK_GOTO(rc, cleanup);
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001892 break;
1893 case LYD_TYPE_REPLY_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001894 assert(parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001895 rc = lydxml_env_netconf_reply(lydctx->xmlctx, envp, &int_opts, &close_elem);
1896 if (rc == LY_ENOT) {
1897 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <rpc-reply> envelope or in incorrect namespace.");
1898 }
1899 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001900 break;
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001901 default:
1902 LOGINT(ctx);
1903 rc = LY_EINT;
1904 goto cleanup;
Michal Vaskoe0665742021-02-11 11:08:44 +01001905 }
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001906
Michal Vaskoe0665742021-02-11 11:08:44 +01001907 lydctx->int_opts = int_opts;
1908
1909 /* find the operation node if it exists already */
1910 LY_CHECK_GOTO(rc = lyd_parser_find_operation(parent, int_opts, &lydctx->op_node), cleanup);
1911
1912 /* parse XML data */
1913 while (lydctx->xmlctx->status == LYXML_ELEMENT) {
1914 LY_CHECK_GOTO(rc = lydxml_subtree_r(lydctx, parent, first_p, parsed), cleanup);
1915 parsed_data_nodes = 1;
1916
1917 if (!(int_opts & LYD_INTOPT_WITH_SIBLINGS)) {
1918 break;
1919 }
Michal Vasko2552ea32020-12-08 15:32:34 +01001920 }
1921
Michal Vaskoe0665742021-02-11 11:08:44 +01001922 /* close all opened elements */
1923 for (i = 0; i < close_elem; ++i) {
1924 if (lydctx->xmlctx->status != LYXML_ELEM_CLOSE) {
1925 assert(lydctx->xmlctx->status == LYXML_ELEMENT);
Radek Krejci422afb12021-03-04 16:38:16 +01001926 LOGVAL(lydctx->xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\".",
1927 (int)lydctx->xmlctx->name_len, lydctx->xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001928 rc = LY_EVALID;
1929 goto cleanup;
1930 }
1931
1932 LY_CHECK_GOTO(rc = lyxml_ctx_next(lydctx->xmlctx), cleanup);
Michal Vasko4189c0f2020-08-13 09:05:22 +02001933 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001934
1935 /* check final state */
1936 if ((int_opts & LYD_INTOPT_NO_SIBLINGS) && (lydctx->xmlctx->status == LYXML_ELEMENT)) {
1937 LOGVAL(ctx, LYVE_SYNTAX, "Unexpected sibling node.");
1938 rc = LY_EVALID;
1939 goto cleanup;
1940 }
Michal Vaskoc939fdd2022-01-03 11:35:13 +01001941 if ((int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_ACTION | LYD_INTOPT_NOTIF | LYD_INTOPT_REPLY)) && !lydctx->op_node) {
Michal Vaskoe0665742021-02-11 11:08:44 +01001942 LOGVAL(ctx, LYVE_DATA, "Missing the operation node.");
1943 rc = LY_EVALID;
1944 goto cleanup;
1945 }
1946
1947 if (!parsed_data_nodes) {
1948 /* no data nodes were parsed */
1949 lydctx->op_node = NULL;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001950 }
1951
1952cleanup:
Michal Vaskoe0665742021-02-11 11:08:44 +01001953 /* there should be no unres stored if validation should be skipped */
1954 assert(!(parse_opts & LYD_PARSE_ONLY) || (!lydctx->node_types.count && !lydctx->meta_types.count &&
Michal Vaskoddd76592022-01-17 13:34:48 +01001955 !lydctx->node_when.count));
Michal Vaskoe0665742021-02-11 11:08:44 +01001956
1957 if (rc) {
1958 lyd_xml_ctx_free((struct lyd_ctx *)lydctx);
1959 } else {
1960 *lydctx_p = (struct lyd_ctx *)lydctx;
1961
1962 /* the XML context is no more needed, freeing it also stops logging line numbers which would be confusing now */
1963 lyxml_ctx_free(lydctx->xmlctx);
1964 lydctx->xmlctx = NULL;
Michal Vasko1ce933a2020-03-30 12:38:22 +02001965 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001966 return rc;
Michal Vasko1ce933a2020-03-30 12:38:22 +02001967}