blob: 1914e767aa5b0bc90f3fd6af34868d3b454c4f1b [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 Vasko85be65e2023-06-13 09:44:17 +020078 LOG_LOCSET(sparent, NULL, NULL, NULL);
79
Michal Vasko45791ad2021-06-17 08:45:03 +020080 /* check for NETCONF filter unqualified attributes */
Michal Vasko1b2a3f42022-12-20 09:38:28 +010081 if (!strcmp(sparent->module->name, "notifications")) {
82 /* ancient module that does not even use the extension */
83 filter_attrs = 1;
84 } else {
85 LY_ARRAY_FOR(sparent->exts, u) {
86 if (!strcmp(sparent->exts[u].def->name, "get-filter-element-attributes") &&
87 !strcmp(sparent->exts[u].def->module->name, "ietf-netconf")) {
88 filter_attrs = 1;
89 break;
90 }
Michal Vasko45791ad2021-06-17 08:45:03 +020091 }
92 }
93
Michal Vaskob36053d2020-03-26 15:49:30 +010094 while (xmlctx->status == LYXML_ATTRIBUTE) {
95 if (!xmlctx->prefix_len) {
Michal Vasko45791ad2021-06-17 08:45:03 +020096 /* in XML all attributes must be prefixed except NETCONF filter ones marked by an extension */
97 if (filter_attrs && (!ly_strncmp("type", xmlctx->name, xmlctx->name_len) ||
98 !ly_strncmp("select", xmlctx->name, xmlctx->name_len))) {
99 mod = ly_ctx_get_module_implemented(xmlctx->ctx, "ietf-netconf");
100 if (!mod) {
101 LOGVAL(xmlctx->ctx, LYVE_REFERENCE,
102 "Missing (or not implemented) YANG module \"ietf-netconf\" for special filter attributes.");
103 ret = LY_ENOTFOUND;
104 goto cleanup;
105 }
106 goto create_meta;
107 }
108
Michal Vaskoe0665742021-02-11 11:08:44 +0100109 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100110 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Missing mandatory prefix for XML metadata \"%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100111 (int)xmlctx->name_len, xmlctx->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200112 ret = LY_EVALID;
Michal Vaskob36053d2020-03-26 15:49:30 +0100113 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +0200114 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100115
Michal Vasko45791ad2021-06-17 08:45:03 +0200116 /* skip attr */
Michal Vaskob36053d2020-03-26 15:49:30 +0100117 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
118 assert(xmlctx->status == LYXML_ATTR_CONTENT);
119 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejci28681fa2019-09-06 13:08:45 +0200120 continue;
121 }
122
123 /* get namespace of the attribute to find its annotation definition */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200124 ns = lyxml_ns_get(&xmlctx->ns, xmlctx->prefix, xmlctx->prefix_len);
Radek Krejci28681fa2019-09-06 13:08:45 +0200125 if (!ns) {
Michal Vasko52927e22020-03-16 17:26:14 +0100126 /* unknown namespace, XML error */
Radek Krejci422afb12021-03-04 16:38:16 +0100127 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)xmlctx->prefix_len, xmlctx->prefix);
Michal Vasko45791ad2021-06-17 08:45:03 +0200128 ret = LY_ENOTFOUND;
Radek Krejci28681fa2019-09-06 13:08:45 +0200129 goto cleanup;
130 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200131
132 /* get the module with metadata definition */
Michal Vasko52927e22020-03-16 17:26:14 +0100133 mod = ly_ctx_get_module_implemented_ns(xmlctx->ctx, ns->uri);
Radek Krejci28681fa2019-09-06 13:08:45 +0200134 if (!mod) {
Michal Vaskoe0665742021-02-11 11:08:44 +0100135 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100136 LOGVAL(xmlctx->ctx, LYVE_REFERENCE,
Michal Vasko69730152020-10-09 16:30:07 +0200137 "Unknown (or not implemented) YANG module with namespace \"%s\" for metadata \"%.*s%s%.*s\".",
Radek Krejci422afb12021-03-04 16:38:16 +0100138 ns->uri, (int)xmlctx->prefix_len, xmlctx->prefix, xmlctx->prefix_len ? ":" : "",
139 (int)xmlctx->name_len, xmlctx->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200140 ret = LY_ENOTFOUND;
Michal Vaskob36053d2020-03-26 15:49:30 +0100141 goto cleanup;
Radek Krejci28681fa2019-09-06 13:08:45 +0200142 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200143
144 /* skip attr */
145 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
146 assert(xmlctx->status == LYXML_ATTR_CONTENT);
147 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
148 continue;
Radek Krejci28681fa2019-09-06 13:08:45 +0200149 }
150
Michal Vasko45791ad2021-06-17 08:45:03 +0200151create_meta:
Michal Vasko60ea6352020-06-29 13:39:39 +0200152 /* remember meta name and get its content */
Michal Vaskob36053d2020-03-26 15:49:30 +0100153 name = xmlctx->name;
154 name_len = xmlctx->name_len;
155 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
156 assert(xmlctx->status == LYXML_ATTR_CONTENT);
157
158 /* create metadata */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200159 ret = lyd_parser_create_meta((struct lyd_ctx *)lydctx, NULL, meta, mod, name, name_len, xmlctx->value,
Michal Vaskoddd76592022-01-17 13:34:48 +0100160 xmlctx->value_len, &xmlctx->dynamic, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA, sparent);
Radek Krejci1798aae2020-07-14 13:26:06 +0200161 LY_CHECK_GOTO(ret, cleanup);
Michal Vaskob36053d2020-03-26 15:49:30 +0100162
163 /* next attribute */
164 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Radek Krejcie7b95092019-05-15 11:03:07 +0200165 }
Michal Vasko52927e22020-03-16 17:26:14 +0100166
Radek Krejcie7b95092019-05-15 11:03:07 +0200167cleanup:
Michal Vasko85be65e2023-06-13 09:44:17 +0200168 LOG_LOCBACK(1, 0, 0, 0);
Michal Vaskob36053d2020-03-26 15:49:30 +0100169 if (ret) {
Michal Vasko3a41dff2020-07-15 14:30:28 +0200170 lyd_free_meta_siblings(*meta);
Michal Vaskob36053d2020-03-26 15:49:30 +0100171 *meta = NULL;
Radek Krejci38d85362019-09-05 16:26:38 +0200172 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200173 return ret;
174}
175
Michal Vasko52927e22020-03-16 17:26:14 +0100176static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200177lydxml_attrs(struct lyxml_ctx *xmlctx, struct lyd_attr **attr)
Michal Vasko52927e22020-03-16 17:26:14 +0100178{
179 LY_ERR ret = LY_SUCCESS;
180 const struct lyxml_ns *ns;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100181 void *val_prefix_data;
Radek Krejci8df109d2021-04-23 12:19:08 +0200182 LY_VALUE_FORMAT format;
Radek Krejci1798aae2020-07-14 13:26:06 +0200183 struct lyd_attr *attr2;
Michal Vaskob36053d2020-03-26 15:49:30 +0100184 const char *name, *prefix;
185 size_t name_len, prefix_len;
Michal Vasko52927e22020-03-16 17:26:14 +0100186
187 assert(attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100188 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100189
Michal Vaskob36053d2020-03-26 15:49:30 +0100190 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vasko52927e22020-03-16 17:26:14 +0100191 if (*attr) {
192 attr2 = *attr;
193 } else {
194 attr2 = NULL;
195 }
196
Michal Vaskob36053d2020-03-26 15:49:30 +0100197 /* remember attr prefix, name, and get its content */
198 prefix = xmlctx->prefix;
199 prefix_len = xmlctx->prefix_len;
200 name = xmlctx->name;
201 name_len = xmlctx->name_len;
202 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
203 assert(xmlctx->status == LYXML_ATTR_CONTENT);
204
Michal Vaskoe137fc42021-07-22 11:53:13 +0200205 /* handle special "xml" attribute prefix */
206 if ((prefix_len == 3) && !strncmp(prefix, "xml", 3)) {
207 name = prefix;
208 name_len += 1 + prefix_len;
209 prefix = NULL;
210 prefix_len = 0;
211 }
212
213 /* find namespace of the attribute, if any */
214 ns = NULL;
215 if (prefix_len) {
216 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
217 if (!ns) {
218 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
219 ret = LY_EVALID;
220 goto cleanup;
221 }
222 }
223
Michal Vasko52927e22020-03-16 17:26:14 +0100224 /* get value prefixes */
Michal Vaskofc2cd072021-02-24 13:17:17 +0100225 val_prefix_data = NULL;
Radek Krejci8df109d2021-04-23 12:19:08 +0200226 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 +0100227 &xmlctx->ns, &format, &val_prefix_data), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100228
229 /* attr2 is always changed to the created attribute */
Michal Vasko501af032020-11-11 20:27:44 +0100230 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 +0100231 ns ? strlen(ns->uri) : 0, xmlctx->value, xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data,
232 LYD_HINT_DATA);
Michal Vasko52927e22020-03-16 17:26:14 +0100233 LY_CHECK_GOTO(ret, cleanup);
234
235 if (!*attr) {
236 *attr = attr2;
237 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100238
239 /* next attribute */
240 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko52927e22020-03-16 17:26:14 +0100241 }
242
243cleanup:
Michal Vaskob36053d2020-03-26 15:49:30 +0100244 if (ret) {
Radek Krejci011e4aa2020-09-04 15:22:31 +0200245 lyd_free_attr_siblings(xmlctx->ctx, *attr);
Michal Vaskob36053d2020-03-26 15:49:30 +0100246 *attr = NULL;
Michal Vasko52927e22020-03-16 17:26:14 +0100247 }
Michal Vasko52927e22020-03-16 17:26:14 +0100248 return ret;
249}
250
Michal Vasko44685da2020-03-17 15:38:06 +0100251static LY_ERR
Michal Vaskob36053d2020-03-26 15:49:30 +0100252lydxml_check_list(struct lyxml_ctx *xmlctx, const struct lysc_node *list)
Michal Vasko44685da2020-03-17 15:38:06 +0100253{
Michal Vaskob36053d2020-03-26 15:49:30 +0100254 LY_ERR ret = LY_SUCCESS, r;
255 enum LYXML_PARSER_STATUS next;
Michal Vasko44685da2020-03-17 15:38:06 +0100256 struct ly_set key_set = {0};
257 const struct lysc_node *snode;
Michal Vaskob36053d2020-03-26 15:49:30 +0100258 uint32_t i, parents_count;
Michal Vasko44685da2020-03-17 15:38:06 +0100259
260 assert(list && (list->nodetype == LYS_LIST));
261
262 /* get all keys into a set (keys do not have if-features or anything) */
263 snode = NULL;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100264 while ((snode = lys_getnext(snode, list, NULL, 0)) && (snode->flags & LYS_KEY)) {
Radek Krejci3d92e442020-10-12 12:48:13 +0200265 ret = ly_set_add(&key_set, (void *)snode, 1, NULL);
Radek Krejciba03a5a2020-08-27 14:40:41 +0200266 LY_CHECK_GOTO(ret, cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100267 }
268
Michal Vasko12d809c2021-03-03 16:34:32 +0100269 /* remember parent count */
270 parents_count = xmlctx->elements.count;
271
Michal Vaskob36053d2020-03-26 15:49:30 +0100272 while (xmlctx->status == LYXML_ELEMENT) {
Michal Vasko44685da2020-03-17 15:38:06 +0100273 /* find key definition */
274 for (i = 0; i < key_set.count; ++i) {
275 snode = (const struct lysc_node *)key_set.objs[i];
Michal Vaskob36053d2020-03-26 15:49:30 +0100276 if (!ly_strncmp(snode->name, xmlctx->name, xmlctx->name_len)) {
Michal Vasko44685da2020-03-17 15:38:06 +0100277 break;
278 }
279 }
Michal Vaskob36053d2020-03-26 15:49:30 +0100280 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100281
282 /* skip attributes */
283 while (xmlctx->status == LYXML_ATTRIBUTE) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100284 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
285 assert(xmlctx->status == LYXML_ATTR_CONTENT);
286 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100287 }
288
Michal Vaskob36053d2020-03-26 15:49:30 +0100289 assert(xmlctx->status == LYXML_ELEM_CONTENT);
290 if (i < key_set.count) {
291 /* validate the value */
Michal Vasko583b4642023-05-25 10:39:34 +0200292 r = ly_value_validate(NULL, snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA);
Michal Vaskob36053d2020-03-26 15:49:30 +0100293 if (!r) {
294 /* key with a valid value, remove from the set */
295 ly_set_rm_index(&key_set, i, NULL);
Michal Vasko44685da2020-03-17 15:38:06 +0100296 }
297 }
298
Michal Vaskob36053d2020-03-26 15:49:30 +0100299 /* parser next */
300 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
Michal Vasko44685da2020-03-17 15:38:06 +0100301
Michal Vaskob36053d2020-03-26 15:49:30 +0100302 /* skip any children, resursively */
Michal Vasko12d809c2021-03-03 16:34:32 +0100303 while (xmlctx->status == LYXML_ELEMENT) {
304 while (parents_count < xmlctx->elements.count) {
305 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
306 }
307 assert(xmlctx->status == LYXML_ELEM_CLOSE);
Michal Vaskob36053d2020-03-26 15:49:30 +0100308 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
309 }
310
311 /* parser next, but do not parse closing element of the list because it would remove its namespaces */
312 assert(xmlctx->status == LYXML_ELEM_CLOSE);
313 LY_CHECK_GOTO(ret = lyxml_ctx_peek(xmlctx, &next), cleanup);
314 if (next != LYXML_ELEM_CLOSE) {
315 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), cleanup);
316 }
Michal Vasko44685da2020-03-17 15:38:06 +0100317 }
318
319 if (key_set.count) {
Michal Vaskob36053d2020-03-26 15:49:30 +0100320 /* some keys are missing/did not validate */
Michal Vasko44685da2020-03-17 15:38:06 +0100321 ret = LY_ENOT;
Michal Vasko44685da2020-03-17 15:38:06 +0100322 }
323
324cleanup:
325 ly_set_erase(&key_set, NULL);
326 return ret;
327}
328
Michal Vasko5c24ed12021-06-09 09:27:32 +0200329/**
330 * @brief Skip an element with all its descendants.
331 *
332 * @param[in] xmlctx XML parser context.
333 * @return LY_ERR value.
334 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100335static LY_ERR
336lydxml_data_skip(struct lyxml_ctx *xmlctx)
337{
338 uint32_t parents_count;
339
340 /* remember current number of parents */
341 parents_count = xmlctx->elements.count;
aPiecek9cdb9e62021-05-18 09:46:20 +0200342 assert(parents_count);
Michal Vasko1bf09392020-03-27 12:38:10 +0100343
344 /* skip after the content */
345 while (xmlctx->status != LYXML_ELEM_CONTENT) {
346 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
347 }
348 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
349
350 /* skip all children elements, recursively, if any */
aPiecek9cdb9e62021-05-18 09:46:20 +0200351 while (parents_count <= xmlctx->elements.count) {
Michal Vasko1bf09392020-03-27 12:38:10 +0100352 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
353 }
354
355 /* close element */
356 assert(xmlctx->status == LYXML_ELEM_CLOSE);
357 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
358
359 return LY_SUCCESS;
360}
361
Michal Vasko5c24ed12021-06-09 09:27:32 +0200362/**
363 * @brief Check that the current element can be parsed as a data node.
364 *
365 * @param[in] lydctx XML data parser context.
366 * @param[in,out] snode Found schema node, set to NULL if data node cannot be created.
367 * @return LY_ERR value.
368 */
Michal Vasko1bf09392020-03-27 12:38:10 +0100369static LY_ERR
Radek Krejci1798aae2020-07-14 13:26:06 +0200370lydxml_data_check_opaq(struct lyd_xml_ctx *lydctx, const struct lysc_node **snode)
Michal Vasko1bf09392020-03-27 12:38:10 +0100371{
372 LY_ERR ret = LY_SUCCESS;
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200373 struct lyxml_ctx *xmlctx = lydctx->xmlctx, pxmlctx;
Michal Vasko1bf09392020-03-27 12:38:10 +0100374
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100375 if (!(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
376 /* only checks specific to opaque nodes */
377 return LY_SUCCESS;
378 }
379
Michal Vasko13854662021-06-09 09:27:50 +0200380 if (!((*snode)->nodetype & (LYD_NODE_TERM | LYD_NODE_INNER))) {
381 /* nothing to check */
382 return LY_SUCCESS;
383 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100384
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200385 assert(xmlctx->elements.count);
386
Michal Vasko13854662021-06-09 09:27:50 +0200387 /* backup parser */
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200388 LY_CHECK_RET(lyxml_ctx_backup(xmlctx, &pxmlctx));
Michal Vasko1bf09392020-03-27 12:38:10 +0100389
Michal Vasko13854662021-06-09 09:27:50 +0200390 /* skip attributes */
391 while (xmlctx->status == LYXML_ATTRIBUTE) {
392 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
393 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
394 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100395
Michal Vasko13854662021-06-09 09:27:50 +0200396 if ((*snode)->nodetype & LYD_NODE_TERM) {
397 /* value may not be valid in which case we parse it as an opaque node */
Michal Vasko583b4642023-05-25 10:39:34 +0200398 if (ly_value_validate(NULL, *snode, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA)) {
Michal Vaskod0237d42021-07-12 14:49:46 +0200399 LOGVRB("Parsing opaque term node \"%s\" with invalid value \"%.*s\".", (*snode)->name, xmlctx->value_len,
400 xmlctx->value);
Michal Vasko13854662021-06-09 09:27:50 +0200401 *snode = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +0100402 }
Michal Vasko13854662021-06-09 09:27:50 +0200403 } else if ((*snode)->nodetype == LYS_LIST) {
404 /* skip content */
405 LY_CHECK_GOTO(ret = lyxml_ctx_next(xmlctx), restore);
Michal Vasko1bf09392020-03-27 12:38:10 +0100406
Michal Vasko13854662021-06-09 09:27:50 +0200407 if (lydxml_check_list(xmlctx, *snode)) {
408 /* invalid list, parse as opaque if it missing/has invalid some keys */
Michal Vaskod0237d42021-07-12 14:49:46 +0200409 LOGVRB("Parsing opaque list node \"%s\" with missing/invalid keys.", (*snode)->name);
Michal Vasko13854662021-06-09 09:27:50 +0200410 *snode = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +0100411 }
Michal Vasko13854662021-06-09 09:27:50 +0200412 } else {
Radek IÅ¡a3930fd72021-03-08 10:48:40 +0100413 /* if there is a non-WS value, it cannot be parsed as an inner node */
414 assert(xmlctx->status == LYXML_ELEM_CONTENT);
415 if (!xmlctx->ws_only) {
416 *snode = NULL;
417 }
Michal Vasko1bf09392020-03-27 12:38:10 +0100418 }
419
Michal Vasko13854662021-06-09 09:27:50 +0200420restore:
421 /* restore parser */
Michal Vaskoda8fbbf2021-06-16 11:44:44 +0200422 lyxml_ctx_restore(xmlctx, &pxmlctx);
Michal Vasko1bf09392020-03-27 12:38:10 +0100423 return ret;
424}
425
Radek Krejcie7b95092019-05-15 11:03:07 +0200426/**
Michal Vaskocea58712022-04-01 14:37:08 +0200427 * @brief Get sensible data hints for an opaque node.
428 *
429 * @param[in] name Node name.
430 * @param[in] name_len Length of @p name.
431 * @param[in] value Node value.
432 * @param[in] value_len Length of @p value.
433 * @param[in] first Node first sibling.
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100434 * @param[in] ns Node module namespace, NULL for no namespace.
Michal Vaskocea58712022-04-01 14:37:08 +0200435 * @param[out] hints Data hints to use.
436 * @param[out] anchor Anchor to insert after in case of a list.
437 */
438static void
Michal Vaskod027f382023-02-10 09:13:25 +0100439lydxml_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 +0200440 const char *ns, uint32_t *hints, struct lyd_node **anchor)
441{
442 struct lyd_node_opaq *opaq;
443 char *ptr;
444 long num;
445
446 *hints = 0;
447 *anchor = NULL;
448
449 if (!value_len) {
450 /* no value */
451 *hints |= LYD_VALHINT_EMPTY;
452 } else if (!strncmp(value, "true", value_len) || !strncmp(value, "false", value_len)) {
453 /* boolean value */
454 *hints |= LYD_VALHINT_BOOLEAN;
455 } else {
456 num = strtol(value, &ptr, 10);
457 if ((unsigned)(ptr - value) == value_len) {
458 /* number value */
459 *hints |= LYD_VALHINT_DECNUM;
460 if ((num < INT32_MIN) || (num > UINT32_MAX)) {
461 /* large number */
462 *hints |= LYD_VALHINT_NUM64;
463 }
464 } else {
465 /* string value */
466 *hints |= LYD_VALHINT_STRING;
467 }
468 }
469
470 if (!first) {
471 return;
472 }
473
474 /* search backwards to find the last instance */
475 do {
476 first = first->prev;
477 if (first->schema) {
478 continue;
479 }
480
481 opaq = (struct lyd_node_opaq *)first;
482 assert(opaq->format == LY_VALUE_XML);
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100483 if (!ly_strncmp(opaq->name.name, name, name_len) &&
484 ((ns && !strcmp(opaq->name.module_ns, ns)) || (!ns && !opaq->name.module_ns))) {
Michal Vaskocea58712022-04-01 14:37:08 +0200485 if (opaq->value && opaq->value[0]) {
486 /* leaf-list nodes */
487 opaq->hints |= LYD_NODEHINT_LEAFLIST;
488 *hints |= LYD_NODEHINT_LEAFLIST;
489 } else {
490 /* list nodes */
491 opaq->hints |= LYD_NODEHINT_LIST;
492 *hints |= LYD_NODEHINT_LIST;
493 }
Michal Vaskod027f382023-02-10 09:13:25 +0100494 *anchor = (struct lyd_node *)first;
Michal Vaskocea58712022-04-01 14:37:08 +0200495 break;
496 }
497 } while (first->prev->next);
498}
499
500/**
Michal Vasko8cc3f662022-03-29 11:25:51 +0200501 * @brief Get schema node for the current element.
Michal Vaskoddd76592022-01-17 13:34:48 +0100502 *
503 * @param[in] lydctx XML data parser context.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200504 * @param[in] parent Parsed parent data node, if any.
505 * @param[in] prefix Element prefix, if any.
506 * @param[in] prefix_len Length of @p prefix.
507 * @param[in] name Element name.
508 * @param[in] name_len Length of @p name.
509 * @param[out] snode Found schema node, NULL if no suitable was found.
510 * @param[out] ext Extension instance that provided @p snode, if any.
Michal Vaskoddd76592022-01-17 13:34:48 +0100511 * @return LY_SUCCESS on success;
Michal Vaskoddd76592022-01-17 13:34:48 +0100512 * @return LY_ERR on error.
513 */
514static LY_ERR
Michal Vaskod027f382023-02-10 09:13:25 +0100515lydxml_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 +0200516 const char *name, size_t name_len, const struct lysc_node **snode, struct lysc_ext_instance **ext)
Michal Vaskoddd76592022-01-17 13:34:48 +0100517{
518 LY_ERR r;
Michal Vaskob36053d2020-03-26 15:49:30 +0100519 struct lyxml_ctx *xmlctx;
520 const struct ly_ctx *ctx;
Radek Krejcie7b95092019-05-15 11:03:07 +0200521 const struct lyxml_ns *ns;
Radek Krejcie7b95092019-05-15 11:03:07 +0200522 struct lys_module *mod;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200523 uint32_t getnext_opts;
Michal Vaskoe0665742021-02-11 11:08:44 +0100524
Michal Vaskob36053d2020-03-26 15:49:30 +0100525 xmlctx = lydctx->xmlctx;
526 ctx = xmlctx->ctx;
Michal Vasko7b1ad1a2020-11-02 15:41:27 +0100527 getnext_opts = lydctx->int_opts & LYD_INTOPT_REPLY ? LYS_GETNEXT_OUTPUT : 0;
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100528
Michal Vasko8cc3f662022-03-29 11:25:51 +0200529 *snode = NULL;
530 *ext = NULL;
Michal Vaskoddd76592022-01-17 13:34:48 +0100531
Michal Vasko8cc3f662022-03-29 11:25:51 +0200532 /* get current namespace */
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200533 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200534 if (!ns) {
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100535 if (lydctx->int_opts & LYD_INTOPT_ANY) {
536 goto unknown_module;
537 }
538
539 if (prefix_len) {
540 LOGVAL(ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
541 } else {
542 LOGVAL(ctx, LYVE_REFERENCE, "Missing XML namespace.");
543 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200544 return LY_EVALID;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200545 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200546
547 /* get the element module, use parent context if possible because of extensions */
548 mod = ly_ctx_get_module_implemented_ns(parent ? LYD_CTX(parent) : ctx, ns->uri);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200549 if (!mod) {
Michal Vaskoddd76592022-01-17 13:34:48 +0100550 /* check for extension data */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200551 r = ly_nested_ext_schema(parent, NULL, prefix, prefix_len, LY_VALUE_XML, &lydctx->xmlctx->ns, name, name_len,
552 snode, ext);
553 if (r != LY_ENOT) {
554 /* success or error */
Michal Vaskoddd76592022-01-17 13:34:48 +0100555 return r;
Michal Vaskoddd76592022-01-17 13:34:48 +0100556 }
557
Michal Vaskoce2e07c2022-12-01 11:08:52 +0100558unknown_module:
Michal Vaskoe0665742021-02-11 11:08:44 +0100559 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
Radek Krejci2efc45b2020-12-22 16:25:44 +0100560 LOGVAL(ctx, LYVE_REFERENCE, "No module with namespace \"%s\" in the context.", ns->uri);
Michal Vasko8cc3f662022-03-29 11:25:51 +0200561 return LY_EVALID;
Radek Krejcie7b95092019-05-15 11:03:07 +0200562 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200563 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200564 }
565
Michal Vaskoa5da3292020-08-12 13:10:50 +0200566 /* get the schema node */
Michal Vasko81008a52021-07-21 16:06:12 +0200567 if (mod) {
Radek Krejcif16e2542021-02-17 15:39:23 +0100568 if (!parent && lydctx->ext) {
Michal Vasko8cc3f662022-03-29 11:25:51 +0200569 *snode = lysc_ext_find_node(lydctx->ext, mod, name, name_len, 0, getnext_opts);
Radek Krejcif16e2542021-02-17 15:39:23 +0100570 } else {
Michal Vasko8cc3f662022-03-29 11:25:51 +0200571 *snode = lys_find_child(parent ? parent->schema : NULL, mod, name, name_len, 0, getnext_opts);
Radek Krejcif16e2542021-02-17 15:39:23 +0100572 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200573 if (!*snode) {
Michal Vaskoddd76592022-01-17 13:34:48 +0100574 /* check for extension data */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200575 r = ly_nested_ext_schema(parent, NULL, prefix, prefix_len, LY_VALUE_XML, &lydctx->xmlctx->ns, name,
576 name_len, snode, ext);
577 if (r != LY_ENOT) {
578 /* success or error */
Michal Vaskoddd76592022-01-17 13:34:48 +0100579 return r;
tadeas-vintrlik2aa36b42021-11-03 13:07:34 +0100580 }
Michal Vaskoddd76592022-01-17 13:34:48 +0100581
582 /* unknown data node */
Michal Vaskoe0665742021-02-11 11:08:44 +0100583 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
584 if (parent) {
Radek Krejci422afb12021-03-04 16:38:16 +0100585 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found as a child of \"%s\" node.",
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100586 (int)name_len, name, LYD_NAME(parent));
Radek Krejcif16e2542021-02-17 15:39:23 +0100587 } else if (lydctx->ext) {
588 if (lydctx->ext->argument) {
Radek Krejci422afb12021-03-04 16:38:16 +0100589 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" %s extension instance.",
590 (int)name_len, name, lydctx->ext->argument, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100591 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100592 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the %s extension instance.",
593 (int)name_len, name, lydctx->ext->def->name);
Radek Krejcif16e2542021-02-17 15:39:23 +0100594 }
Michal Vaskoe0665742021-02-11 11:08:44 +0100595 } else {
Radek Krejci422afb12021-03-04 16:38:16 +0100596 LOGVAL(ctx, LYVE_REFERENCE, "Node \"%.*s\" not found in the \"%s\" module.",
597 (int)name_len, name, mod->name);
Michal Vaskoe0665742021-02-11 11:08:44 +0100598 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200599 return LY_EVALID;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200600 }
Michal Vasko8cc3f662022-03-29 11:25:51 +0200601 return LY_SUCCESS;
Michal Vaskoa5da3292020-08-12 13:10:50 +0200602 } else {
603 /* check that schema node is valid and can be used */
Michal Vasko8cc3f662022-03-29 11:25:51 +0200604 LY_CHECK_RET(lyd_parser_check_schema((struct lyd_ctx *)lydctx, *snode));
605 LY_CHECK_RET(lydxml_data_check_opaq(lydctx, snode));
Michal Vaskoa5da3292020-08-12 13:10:50 +0200606 }
607 }
608
Michal Vasko8cc3f662022-03-29 11:25:51 +0200609 return LY_SUCCESS;
610}
611
612/**
Michal Vaskod027f382023-02-10 09:13:25 +0100613 * @brief Parse an XML opque node.
614 *
615 * @param[in] lydctx XML YANG data parser context.
616 * @param[in] sibling Existing sibling node, if any.
617 * @param[in] prefix Parsed node prefix.
618 * @param[in] prefix_len Length of @p prefix.
619 * @param[in] name Parsed node name.
620 * @param[in] name_len Length of @p name.
621 * @param[out] insert_anchor Optional anchor node for inserting this node.
622 * @param[out] node Created node.
623 * @return LY_ERR value.
624 */
625static LY_ERR
626lydxml_subtree_opaq(struct lyd_xml_ctx *lydctx, const struct lyd_node *sibling, const char *prefix, uint32_t prefix_len,
627 const char *name, uint32_t name_len, struct lyd_node **insert_anchor, struct lyd_node **node)
628{
629 LY_ERR rc = LY_SUCCESS;
630 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
631 const char *ns_uri;
632 const struct lyxml_ns *ns;
633 uint32_t hints;
634 void *val_prefix_data = NULL;
635 LY_VALUE_FORMAT format;
636
637 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
638
639 *node = NULL;
640
641 if (xmlctx->ws_only) {
642 /* ignore WS-only value */
643 if (xmlctx->dynamic) {
644 free((char *)xmlctx->value);
645 }
646 xmlctx->dynamic = 0;
647 xmlctx->value = "";
648 xmlctx->value_len = 0;
649 format = LY_VALUE_XML;
650 } else {
651 /* get value prefixes */
652 rc = ly_store_prefix_data(xmlctx->ctx, xmlctx->value, xmlctx->value_len, LY_VALUE_XML, &xmlctx->ns, &format,
653 &val_prefix_data);
654 LY_CHECK_GOTO(rc, cleanup);
655 }
656
657 /* get NS again, it may have been backed up and restored */
658 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
659 ns_uri = ns ? ns->uri : NULL;
660
661 /* get best-effort node hints */
662 lydxml_get_hints_opaq(name, name_len, xmlctx->value, xmlctx->value_len, sibling, ns_uri, &hints, insert_anchor);
663
664 /* create node */
665 rc = lyd_create_opaq(xmlctx->ctx, name, name_len, prefix, prefix_len, ns_uri, ns_uri ? strlen(ns_uri) : 0,
666 xmlctx->value, xmlctx->value_len, &xmlctx->dynamic, format, val_prefix_data, hints, node);
667 LY_CHECK_GOTO(rc, cleanup);
668 val_prefix_data = NULL;
669
670 /* parser next */
671 rc = lyxml_ctx_next(xmlctx);
672 LY_CHECK_GOTO(rc, cleanup);
673
674 /* process children */
675 while (xmlctx->status == LYXML_ELEMENT) {
676 rc = lydxml_subtree_r(lydctx, *node, lyd_node_child_p(*node), NULL);
677 LY_CHECK_GOTO(rc, cleanup);
678 }
679
680cleanup:
681 ly_free_prefix_data(format, val_prefix_data);
682 if (rc) {
683 lyd_free_tree(*node);
684 *node = NULL;
685 }
686 return rc;
687}
688
689/**
690 * @brief Parse an XML leaf/leaf-list node.
691 *
692 * @param[in] lydctx XML YANG data parser context.
693 * @param[in] parent Parent node, if any.
694 * @param[in] snode Schema node of the new node.
695 * @param[out] node Created node.
696 * @return LY_ERR value.
697 */
698static LY_ERR
699lydxml_subtree_term(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, const struct lysc_node *snode,
700 struct lyd_node **node)
701{
702 LY_ERR r, rc = LY_SUCCESS;
703 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
704 struct lyd_node *anchor;
705
706 *node = NULL;
707
708 /* create node */
709 r = lyd_parser_create_term((struct lyd_ctx *)lydctx, snode, xmlctx->value, xmlctx->value_len, &xmlctx->dynamic,
710 LY_VALUE_XML, &xmlctx->ns, LYD_HINT_DATA, node);
711 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
712
713 if (*node) {
Michal Vasko58a1a702023-03-01 13:45:38 +0100714 LOG_LOCSET(NULL, *node, NULL, NULL);
Michal Vaskod027f382023-02-10 09:13:25 +0100715 }
716
Michal Vasko58a1a702023-03-01 13:45:38 +0100717 if (*node && parent && (snode->flags & LYS_KEY)) {
Michal Vaskod027f382023-02-10 09:13:25 +0100718 /* check the key order, the anchor must never be a key */
719 anchor = lyd_insert_get_next_anchor(lyd_child(parent), *node);
720 if (anchor && anchor->schema && (anchor->schema->flags & LYS_KEY)) {
721 if (lydctx->parse_opts & LYD_PARSE_STRICT) {
722 LOGVAL(xmlctx->ctx, LYVE_DATA, "Invalid position of the key \"%s\" in a list.", snode->name);
723 r = LY_EVALID;
724 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
725 } else {
726 LOGWRN(xmlctx->ctx, "Invalid position of the key \"%s\" in a list.", snode->name);
727 }
728 }
729 }
730
731 /* parser next */
732 r = lyxml_ctx_next(xmlctx);
733 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
734
735 /* no children expected */
736 if (xmlctx->status == LYXML_ELEMENT) {
737 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Child element \"%.*s\" inside a terminal node \"%s\" found.",
738 (int)xmlctx->name_len, xmlctx->name, snode->name);
739 r = LY_EVALID;
740 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
741 }
742
743cleanup:
744 if (*node) {
Michal Vasko58a1a702023-03-01 13:45:38 +0100745 LOG_LOCBACK(0, 1, 0, 0);
Michal Vaskod027f382023-02-10 09:13:25 +0100746 }
747 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
748 lyd_free_tree(*node);
749 *node = NULL;
750 }
751 return rc;
752}
753
754/**
755 * @brief Parse an XML inner node.
756 *
757 * @param[in] lydctx XML YANG data parser context.
758 * @param[in] snode Schema node of the new node.
759 * @param[in] ext Extension instance of @p snode, if any.
760 * @param[out] node Created node.
761 * @return LY_ERR value.
762 */
763static LY_ERR
764lydxml_subtree_inner(struct lyd_xml_ctx *lydctx, const struct lysc_node *snode, const struct lysc_ext_instance *ext,
765 struct lyd_node **node)
766{
767 LY_ERR r, rc = LY_SUCCESS;
768 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
769 uint32_t prev_parse_opts = lydctx->parse_opts;
770
771 *node = NULL;
772
773 if (!xmlctx->ws_only) {
774 /* value in inner node */
775 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an inner node \"%s\" found.",
776 (int)xmlctx->value_len, xmlctx->value, snode->name);
777 r = LY_EVALID;
778 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
779 }
780
781 /* create node */
782 rc = lyd_create_inner(snode, node);
783 LY_CHECK_GOTO(rc, cleanup);
784
Michal Vasko58a1a702023-03-01 13:45:38 +0100785 assert(*node);
786 LOG_LOCSET(NULL, *node, NULL, NULL);
Michal Vaskod027f382023-02-10 09:13:25 +0100787
788 /* parser next */
789 rc = lyxml_ctx_next(xmlctx);
790 LY_CHECK_GOTO(rc, cleanup);
791
792 if (ext) {
793 /* only parse these extension data and validate afterwards */
794 lydctx->parse_opts |= LYD_PARSE_ONLY;
795 }
796
797 /* process children */
798 while (xmlctx->status == LYXML_ELEMENT) {
799 r = lydxml_subtree_r(lydctx, *node, lyd_node_child_p(*node), NULL);
800 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
801 }
802
803 /* restore options */
804 lydctx->parse_opts = prev_parse_opts;
805
806 if (snode->nodetype == LYS_LIST) {
807 /* check all keys exist */
808 r = lyd_parse_check_keys(*node);
Michal Vasko202d8162023-03-01 14:42:19 +0100809 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vaskod027f382023-02-10 09:13:25 +0100810 }
811
812 if (!(lydctx->parse_opts & LYD_PARSE_ONLY)) {
813 /* new node validation, autodelete CANNOT occur, all nodes are new */
814 r = lyd_validate_new(lyd_node_child_p(*node), snode, NULL, lydctx->val_opts, NULL);
815 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
816
817 /* add any missing default children */
818 r = lyd_new_implicit_r(*node, lyd_node_child_p(*node), NULL, NULL, &lydctx->node_when, &lydctx->node_types,
819 &lydctx->ext_node, (lydctx->val_opts & LYD_VALIDATE_NO_STATE) ? LYD_IMPLICIT_NO_STATE : 0, NULL);
820 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
821 }
822
823 if (snode->nodetype & (LYS_RPC | LYS_ACTION | LYS_NOTIF)) {
824 /* rememeber the RPC/action/notification */
825 lydctx->op_node = *node;
826 }
827
828cleanup:
829 if (*node) {
Michal Vasko58a1a702023-03-01 13:45:38 +0100830 LOG_LOCBACK(0, 1, 0, 0);
Michal Vaskod027f382023-02-10 09:13:25 +0100831 }
832 lydctx->parse_opts = prev_parse_opts;
Michal Vasko202d8162023-03-01 14:42:19 +0100833 if (rc && ((*node && !(*node)->hash) || !(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
834 /* list without keys is unusable or an error */
Michal Vaskod027f382023-02-10 09:13:25 +0100835 lyd_free_tree(*node);
836 *node = NULL;
837 }
838 return rc;
839}
840
841/**
842 * @brief Parse an XML anyxml/anydata node.
843 *
844 * @param[in] lydctx XML YANG data parser context.
845 * @param[in] snode Schema node of the new node.
846 * @param[in] ext Extension instance of @p snode, if any.
847 * @param[out] node Created node.
848 * @return LY_ERR value.
849 */
850static LY_ERR
851lydxml_subtree_any(struct lyd_xml_ctx *lydctx, const struct lysc_node *snode, const struct lysc_ext_instance *ext,
852 struct lyd_node **node)
853{
854 LY_ERR r, rc = LY_SUCCESS;
855 struct lyxml_ctx *xmlctx = lydctx->xmlctx;
856 uint32_t prev_parse_opts = lydctx->parse_opts, prev_int_opts = lydctx->int_opts;
857 struct lyd_node *child = NULL;
858 char *val = NULL;
Michal Vasko85be65e2023-06-13 09:44:17 +0200859 ly_bool log_node = 0;
Michal Vaskod027f382023-02-10 09:13:25 +0100860
861 *node = NULL;
862
863 if ((snode->nodetype == LYS_ANYDATA) && !xmlctx->ws_only) {
864 /* value in anydata node, we expect a tree */
865 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Text value \"%.*s\" inside an anydata node \"%s\" found.",
866 (int)xmlctx->value_len < 20 ? xmlctx->value_len : 20, xmlctx->value, snode->name);
867 r = LY_EVALID;
868 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
869 }
870
871 if (!xmlctx->ws_only) {
872 /* use an arbitrary text value for anyxml */
873 val = strndup(xmlctx->value, xmlctx->value_len);
874 LY_CHECK_ERR_GOTO(!val, LOGMEM(xmlctx->ctx); rc = LY_EMEM, cleanup);
875
876 /* parser next */
877 r = lyxml_ctx_next(xmlctx);
878 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
879
880 /* create node */
881 r = lyd_create_any(snode, val, LYD_ANYDATA_STRING, 1, node);
882 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
883 val = NULL;
884 } else {
Michal Vasko85be65e2023-06-13 09:44:17 +0200885 /* create node */
886 r = lyd_create_any(snode, NULL, LYD_ANYDATA_DATATREE, 1, node);
887 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
888
889 assert(*node);
890 LOG_LOCSET(NULL, *node, NULL, NULL);
891 log_node = 1;
892
Michal Vaskod027f382023-02-10 09:13:25 +0100893 /* parser next */
894 r = lyxml_ctx_next(xmlctx);
895 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
896
897 /* update options so that generic data can be parsed */
898 lydctx->parse_opts &= ~LYD_PARSE_STRICT;
899 lydctx->parse_opts |= LYD_PARSE_OPAQ | (ext ? LYD_PARSE_ONLY : 0);
900 lydctx->int_opts |= LYD_INTOPT_ANY | LYD_INTOPT_WITH_SIBLINGS;
901
902 /* parse any data tree */
903 while (xmlctx->status == LYXML_ELEMENT) {
904 r = lydxml_subtree_r(lydctx, NULL, &child, NULL);
905 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
906 }
907
Michal Vasko85be65e2023-06-13 09:44:17 +0200908 /* assign the data tree */
909 ((struct lyd_node_any *)*node)->value.tree = child;
Michal Vaskod027f382023-02-10 09:13:25 +0100910 child = NULL;
911 }
912
913cleanup:
Michal Vasko85be65e2023-06-13 09:44:17 +0200914 if (log_node) {
915 LOG_LOCBACK(0, 1, 0, 0);
916 }
Michal Vaskod027f382023-02-10 09:13:25 +0100917 lydctx->parse_opts = prev_parse_opts;
918 lydctx->int_opts = prev_int_opts;
919 free(val);
920 lyd_free_tree(child);
921 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
922 lyd_free_tree(*node);
923 *node = NULL;
924 }
925 return rc;
926}
927
928/**
929 * @brief Parse an XML subtree, recursively.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200930 *
931 * @param[in] lydctx XML YANG data parser context.
932 * @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 +0100933 * @param[in,out] first_p Pointer to the first (@p parent or top-level) child.
Michal Vasko8cc3f662022-03-29 11:25:51 +0200934 * @param[in,out] parsed Optional set to add all the parsed siblings into.
935 * @return LY_ERR value.
936 */
937static LY_ERR
938lydxml_subtree_r(struct lyd_xml_ctx *lydctx, struct lyd_node *parent, struct lyd_node **first_p, struct ly_set *parsed)
939{
Michal Vaskod027f382023-02-10 09:13:25 +0100940 LY_ERR r, rc = LY_SUCCESS;
941 const char *prefix, *name;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200942 size_t prefix_len, name_len;
943 struct lyxml_ctx *xmlctx;
944 const struct ly_ctx *ctx;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200945 struct lyd_meta *meta = NULL;
946 struct lyd_attr *attr = NULL;
947 const struct lysc_node *snode;
948 struct lysc_ext_instance *ext;
Michal Vaskod027f382023-02-10 09:13:25 +0100949 uint32_t orig_parse_opts;
950 struct lyd_node *node = NULL, *insert_anchor = NULL;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200951 ly_bool parse_subtree;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200952
953 assert(parent || first_p);
954
955 xmlctx = lydctx->xmlctx;
956 ctx = xmlctx->ctx;
957
958 parse_subtree = lydctx->parse_opts & LYD_PARSE_SUBTREE ? 1 : 0;
959 /* all descendants should be parsed */
960 lydctx->parse_opts &= ~LYD_PARSE_SUBTREE;
961 orig_parse_opts = lydctx->parse_opts;
962
963 assert(xmlctx->status == LYXML_ELEMENT);
964
965 /* remember element prefix and name */
966 prefix = xmlctx->prefix;
967 prefix_len = xmlctx->prefix_len;
968 name = xmlctx->name;
969 name_len = xmlctx->name_len;
970
971 /* parser next */
Michal Vaskod027f382023-02-10 09:13:25 +0100972 rc = lyxml_ctx_next(xmlctx);
973 LY_CHECK_GOTO(rc, cleanup);
Michal Vasko8cc3f662022-03-29 11:25:51 +0200974
975 /* get the schema node */
Michal Vasko202d8162023-03-01 14:42:19 +0100976 r = lydxml_subtree_get_snode(lydctx, parent, prefix, prefix_len, name, name_len, &snode, &ext);
977 if (r) {
978 rc = r;
979 if ((r == LY_EVALID) && (lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR)) {
980 /* skip the invalid data */
981 if ((r = lydxml_data_skip(xmlctx))) {
982 rc = r;
983 }
984 }
985 goto cleanup;
986 } else if (!snode && !(lydctx->parse_opts & LYD_PARSE_OPAQ)) {
Michal Vasko8cc3f662022-03-29 11:25:51 +0200987 LOGVRB("Skipping parsing of unknown node \"%.*s\".", name_len, name);
988
989 /* skip element with children */
Michal Vaskod027f382023-02-10 09:13:25 +0100990 rc = lydxml_data_skip(xmlctx);
991 goto cleanup;
Michal Vasko8cc3f662022-03-29 11:25:51 +0200992 }
993
Michal Vaskoa5da3292020-08-12 13:10:50 +0200994 /* create metadata/attributes */
995 if (xmlctx->status == LYXML_ATTRIBUTE) {
996 if (snode) {
Michal Vaskod027f382023-02-10 09:13:25 +0100997 rc = lydxml_metadata(lydctx, snode, &meta);
998 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa5da3292020-08-12 13:10:50 +0200999 } else {
Michal Vaskoe0665742021-02-11 11:08:44 +01001000 assert(lydctx->parse_opts & LYD_PARSE_OPAQ);
Michal Vaskod027f382023-02-10 09:13:25 +01001001 rc = lydxml_attrs(xmlctx, &attr);
1002 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001003 }
1004 }
1005
1006 assert(xmlctx->status == LYXML_ELEM_CONTENT);
1007 if (!snode) {
Michal Vaskod027f382023-02-10 09:13:25 +01001008 /* opaque */
1009 r = lydxml_subtree_opaq(lydctx, parent ? lyd_child(parent) : *first_p, prefix, prefix_len, name, name_len,
1010 &insert_anchor, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001011 } else if (snode->nodetype & LYD_NODE_TERM) {
Michal Vaskod027f382023-02-10 09:13:25 +01001012 /* term */
1013 r = lydxml_subtree_term(lydctx, parent, snode, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001014 } else if (snode->nodetype & LYD_NODE_INNER) {
Michal Vaskod027f382023-02-10 09:13:25 +01001015 /* inner */
1016 r = lydxml_subtree_inner(lydctx, snode, ext, &node);
Michal Vasko7c6f33f2023-02-10 09:40:11 +01001017 } else {
Michal Vaskod027f382023-02-10 09:13:25 +01001018 /* any */
Michal Vasko7c6f33f2023-02-10 09:40:11 +01001019 assert(snode->nodetype & LYD_NODE_ANY);
Michal Vaskod027f382023-02-10 09:13:25 +01001020 r = lydxml_subtree_any(lydctx, snode, ext, &node);
Michal Vaskoa5da3292020-08-12 13:10:50 +02001021 }
Michal Vaskod027f382023-02-10 09:13:25 +01001022 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vasko1524f1a2023-03-01 09:36:34 +01001023
Michal Vasko58a1a702023-03-01 13:45:38 +01001024 if (node && snode) {
Michal Vasko135719f2022-08-25 12:18:17 +02001025 /* add/correct flags */
Michal Vaskod027f382023-02-10 09:13:25 +01001026 r = lyd_parse_set_data_flags(node, &meta, (struct lyd_ctx *)lydctx, ext);
Michal Vasko567d7032023-02-13 08:53:31 +01001027 LY_CHECK_ERR_GOTO(r, rc = r; lyd_free_tree(node), cleanup);
Michal Vasko135719f2022-08-25 12:18:17 +02001028
Michal Vaskoeba23112022-08-26 08:35:41 +02001029 if (!(lydctx->parse_opts & LYD_PARSE_ONLY)) {
1030 /* store for ext instance node validation, if needed */
Michal Vaskod027f382023-02-10 09:13:25 +01001031 r = lyd_validate_node_ext(node, &lydctx->ext_node);
1032 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoeba23112022-08-26 08:35:41 +02001033 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001034 }
1035
1036 /* parser next */
1037 assert(xmlctx->status == LYXML_ELEM_CLOSE);
Michal Vaskoddd76592022-01-17 13:34:48 +01001038 if (!parse_subtree) {
Michal Vaskod027f382023-02-10 09:13:25 +01001039 r = lyxml_ctx_next(xmlctx);
Michal Vasko567d7032023-02-13 08:53:31 +01001040 LY_CHECK_ERR_GOTO(r, rc = r; lyd_free_tree(node), cleanup);
Michal Vaskoddd76592022-01-17 13:34:48 +01001041 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001042
Michal Vasko58a1a702023-03-01 13:45:38 +01001043 LY_CHECK_GOTO(!node, cleanup);
1044
Michal Vaskoa5da3292020-08-12 13:10:50 +02001045 /* add metadata/attributes */
1046 if (snode) {
Michal Vasko871a0252020-11-11 18:35:24 +01001047 lyd_insert_meta(node, meta, 0);
Michal Vaskod027f382023-02-10 09:13:25 +01001048 meta = NULL;
Michal Vaskoa5da3292020-08-12 13:10:50 +02001049 } else {
1050 lyd_insert_attr(node, attr);
Michal Vaskod027f382023-02-10 09:13:25 +01001051 attr = NULL;
Michal Vaskoa5da3292020-08-12 13:10:50 +02001052 }
1053
1054 /* insert, keep first pointer correct */
Michal Vaskocea58712022-04-01 14:37:08 +02001055 if (insert_anchor) {
1056 lyd_insert_after(insert_anchor, node);
1057 } else if (ext) {
Michal Vaskod027f382023-02-10 09:13:25 +01001058 r = lyplg_ext_insert(parent, node);
Michal Vasko567d7032023-02-13 08:53:31 +01001059 LY_CHECK_ERR_GOTO(r, rc = r; lyd_free_tree(node), cleanup);
Michal Vasko8cc3f662022-03-29 11:25:51 +02001060 } else {
1061 lyd_insert_node(parent, first_p, node, lydctx->parse_opts & LYD_PARSE_ORDERED ? 1 : 0);
1062 }
Michal Vaskoa5da3292020-08-12 13:10:50 +02001063 while (!parent && (*first_p)->prev->next) {
1064 *first_p = (*first_p)->prev;
1065 }
1066
Michal Vaskoe0665742021-02-11 11:08:44 +01001067 /* rememeber a successfully parsed node */
1068 if (parsed) {
1069 ly_set_add(parsed, node, 1, NULL);
1070 }
1071
Michal Vaskod027f382023-02-10 09:13:25 +01001072cleanup:
Michal Vasko8cc3f662022-03-29 11:25:51 +02001073 lydctx->parse_opts = orig_parse_opts;
Michal Vasko3a41dff2020-07-15 14:30:28 +02001074 lyd_free_meta_siblings(meta);
Radek Krejci011e4aa2020-09-04 15:22:31 +02001075 lyd_free_attr_siblings(ctx, attr);
Michal Vaskod027f382023-02-10 09:13:25 +01001076 return rc;
Radek Krejcie7b95092019-05-15 11:03:07 +02001077}
1078
Michal Vaskoe0665742021-02-11 11:08:44 +01001079/**
1080 * @brief Parse a specific XML element into an opaque node.
1081 *
1082 * @param[in] xmlctx XML parser context.
1083 * @param[in] name Name of the element.
1084 * @param[in] uri URI of the element.
1085 * @param[in] value Whether a value is expected in the element.
1086 * @param[out] evnp Parsed envelope (opaque node).
1087 * @return LY_SUCCESS on success.
1088 * @return LY_ENOT if the specified element did not match.
1089 * @return LY_ERR value on error.
1090 */
Michal Vasko1bf09392020-03-27 12:38:10 +01001091static LY_ERR
Michal Vaskoe0665742021-02-11 11:08:44 +01001092lydxml_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 +01001093{
Michal Vaskoe0665742021-02-11 11:08:44 +01001094 LY_ERR rc = LY_SUCCESS;
1095 const struct lyxml_ns *ns;
Radek Krejci1798aae2020-07-14 13:26:06 +02001096 struct lyd_attr *attr = NULL;
Michal Vasko1bf09392020-03-27 12:38:10 +01001097 const char *prefix;
1098 size_t prefix_len;
1099
Michal Vaskof048ba52023-06-13 10:40:43 +02001100 if (xmlctx->status != LYXML_ELEMENT) {
1101 /* nothing to parse */
1102 return LY_ENOT;
1103 }
1104
Michal Vasko1bf09392020-03-27 12:38:10 +01001105 if (ly_strncmp(name, xmlctx->name, xmlctx->name_len)) {
1106 /* not the expected element */
Michal Vaskoe0665742021-02-11 11:08:44 +01001107 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001108 }
1109
1110 prefix = xmlctx->prefix;
1111 prefix_len = xmlctx->prefix_len;
Michal Vaskoc8a230d2020-08-14 12:17:10 +02001112 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001113 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +01001114 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +01001115 return LY_EVALID;
1116 } else if (strcmp(ns->uri, uri)) {
1117 /* different namespace */
1118 return LY_ENOT;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001119 }
1120
1121 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
1122
1123 /* create attributes */
1124 if (xmlctx->status == LYXML_ATTRIBUTE) {
1125 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
1126 }
1127
Michal Vaskoe0665742021-02-11 11:08:44 +01001128 assert(xmlctx->status == LYXML_ELEM_CONTENT);
1129 if (!value && !xmlctx->ws_only) {
1130 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected value \"%.*s\" in the \"%s\" element.",
Radek Krejci422afb12021-03-04 16:38:16 +01001131 (int)xmlctx->value_len, xmlctx->value, name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001132 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001133 goto cleanup;
Michal Vaskoe0665742021-02-11 11:08:44 +01001134 }
Michal Vaskoa8edff02020-03-27 14:47:01 +01001135
1136 /* create node */
Michal Vaskoe0665742021-02-11 11:08:44 +01001137 rc = lyd_create_opaq(xmlctx->ctx, name, strlen(name), prefix, prefix_len, uri, strlen(uri), xmlctx->value,
Radek Krejci8df109d2021-04-23 12:19:08 +02001138 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001139 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001140
1141 /* assign atributes */
Michal Vaskoe0665742021-02-11 11:08:44 +01001142 ((struct lyd_node_opaq *)(*envp))->attr = attr;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001143 attr = NULL;
1144
Michal Vaskoe0665742021-02-11 11:08:44 +01001145 /* parser next element */
1146 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001147
Michal Vaskoe0665742021-02-11 11:08:44 +01001148cleanup:
1149 lyd_free_attr_siblings(xmlctx->ctx, attr);
1150 if (rc) {
1151 lyd_free_tree(*envp);
1152 *envp = NULL;
1153 }
1154 return rc;
1155}
1156
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001157LY_ERR
1158lyd_parse_xml(const struct ly_ctx *ctx, const struct lysc_ext_instance *ext, struct lyd_node *parent,
1159 struct lyd_node **first_p, struct ly_in *in, uint32_t parse_opts, uint32_t val_opts, uint32_t int_opts,
1160 struct ly_set *parsed, ly_bool *subtree_sibling, struct lyd_ctx **lydctx_p)
1161{
Michal Vaskod027f382023-02-10 09:13:25 +01001162 LY_ERR r, rc = LY_SUCCESS;
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001163 struct lyd_xml_ctx *lydctx;
Michal Vasko64592692023-06-12 13:50:11 +02001164 ly_bool parsed_data_nodes = 0, close_elem = 0;
1165 struct lyd_node *act = NULL;
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001166 enum LYXML_PARSER_STATUS status;
1167
1168 assert(ctx && in && lydctx_p);
1169 assert(!(parse_opts & ~LYD_PARSE_OPTS_MASK));
1170 assert(!(val_opts & ~LYD_VALIDATE_OPTS_MASK));
1171
1172 /* init context */
1173 lydctx = calloc(1, sizeof *lydctx);
1174 LY_CHECK_ERR_RET(!lydctx, LOGMEM(ctx), LY_EMEM);
1175 LY_CHECK_GOTO(rc = lyxml_ctx_new(ctx, in, &lydctx->xmlctx), cleanup);
1176 lydctx->parse_opts = parse_opts;
1177 lydctx->val_opts = val_opts;
1178 lydctx->int_opts = int_opts;
1179 lydctx->free = lyd_xml_ctx_free;
1180 lydctx->ext = ext;
1181
1182 /* find the operation node if it exists already */
1183 LY_CHECK_GOTO(rc = lyd_parser_find_operation(parent, int_opts, &lydctx->op_node), cleanup);
1184
Michal Vasko64592692023-06-12 13:50:11 +02001185 if ((int_opts & LYD_INTOPT_RPC) && (int_opts & LYD_INTOPT_ACTION)) {
1186 /* can be either, try to parse "action" */
1187 if (!lydxml_envelope(lydctx->xmlctx, "action", "urn:ietf:params:xml:ns:yang:1", 0, &act)) {
1188 close_elem = 1;
1189 int_opts &= ~LYD_INTOPT_RPC;
1190 }
1191 }
1192
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001193 /* parse XML data */
1194 while (lydctx->xmlctx->status == LYXML_ELEMENT) {
Michal Vaskod027f382023-02-10 09:13:25 +01001195 r = lydxml_subtree_r(lydctx, parent, first_p, parsed);
1196 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
1197
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001198 parsed_data_nodes = 1;
1199
1200 if (!(int_opts & LYD_INTOPT_WITH_SIBLINGS)) {
1201 break;
1202 }
1203 }
1204
Michal Vasko64592692023-06-12 13:50:11 +02001205 /* close an opened element */
1206 if (close_elem) {
1207 if (lydctx->xmlctx->status != LYXML_ELEM_CLOSE) {
1208 assert(lydctx->xmlctx->status == LYXML_ELEMENT);
1209 LOGVAL(lydctx->xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\".",
1210 (int)lydctx->xmlctx->name_len, lydctx->xmlctx->name);
1211 rc = LY_EVALID;
1212 goto cleanup;
1213 }
1214
1215 LY_CHECK_GOTO(rc = lyxml_ctx_next(lydctx->xmlctx), cleanup);
1216 }
1217
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001218 /* check final state */
1219 if ((int_opts & LYD_INTOPT_NO_SIBLINGS) && (lydctx->xmlctx->status == LYXML_ELEMENT)) {
1220 LOGVAL(ctx, LYVE_SYNTAX, "Unexpected sibling node.");
Michal Vaskod027f382023-02-10 09:13:25 +01001221 r = LY_EVALID;
1222 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001223 }
1224 if ((int_opts & (LYD_INTOPT_RPC | LYD_INTOPT_ACTION | LYD_INTOPT_NOTIF | LYD_INTOPT_REPLY)) && !lydctx->op_node) {
1225 LOGVAL(ctx, LYVE_DATA, "Missing the operation node.");
Michal Vaskod027f382023-02-10 09:13:25 +01001226 r = LY_EVALID;
1227 LY_DPARSER_ERR_GOTO(r, rc = r, lydctx, cleanup);
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001228 }
1229
1230 if (!parsed_data_nodes) {
1231 /* no data nodes were parsed */
1232 lydctx->op_node = NULL;
1233 }
1234
1235 if (parse_opts & LYD_PARSE_SUBTREE) {
1236 /* check for a sibling element */
1237 assert(subtree_sibling);
1238 if (!lyxml_ctx_peek(lydctx->xmlctx, &status) && (status == LYXML_ELEMENT)) {
1239 *subtree_sibling = 1;
1240 } else {
1241 *subtree_sibling = 0;
1242 }
1243 }
1244
1245cleanup:
1246 /* there should be no unres stored if validation should be skipped */
1247 assert(!(parse_opts & LYD_PARSE_ONLY) || (!lydctx->node_types.count && !lydctx->meta_types.count &&
1248 !lydctx->node_when.count));
1249
Michal Vasko64592692023-06-12 13:50:11 +02001250 lyd_free_tree(act);
Michal Vaskod027f382023-02-10 09:13:25 +01001251 if (rc && (!(lydctx->val_opts & LYD_VALIDATE_MULTI_ERROR) || (rc != LY_EVALID))) {
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001252 lyd_xml_ctx_free((struct lyd_ctx *)lydctx);
1253 } else {
1254 *lydctx_p = (struct lyd_ctx *)lydctx;
1255
1256 /* the XML context is no more needed, freeing it also stops logging line numbers which would be confusing now */
1257 lyxml_ctx_free(lydctx->xmlctx);
1258 lydctx->xmlctx = NULL;
1259 }
1260 return rc;
1261}
1262
Michal Vaskoe0665742021-02-11 11:08:44 +01001263/**
1264 * @brief Parse all expected non-data XML elements of a NETCONF rpc message.
1265 *
1266 * @param[in] xmlctx XML parser context.
1267 * @param[out] evnp Parsed envelope(s) (opaque node).
1268 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1269 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1270 * @return LY_SUCCESS on success.
1271 * @return LY_ERR value on error.
1272 */
1273static LY_ERR
1274lydxml_env_netconf_rpc(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1275{
1276 LY_ERR rc = LY_SUCCESS, r;
1277 struct lyd_node *child;
1278
1279 assert(envp && !*envp);
1280
1281 /* parse "rpc" */
1282 r = lydxml_envelope(xmlctx, "rpc", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001283 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1284
1285 /* parse "action", if any */
1286 r = lydxml_envelope(xmlctx, "action", "urn:ietf:params:xml:ns:yang:1", 0, &child);
1287 if (r == LY_SUCCESS) {
1288 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001289 lyd_insert_node(*envp, NULL, child, 0);
Michal Vaskoe0665742021-02-11 11:08:44 +01001290
1291 /* NETCONF action */
1292 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_ACTION;
1293 *close_elem = 2;
1294 } else if (r == LY_ENOT) {
1295 /* NETCONF RPC */
1296 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_RPC;
1297 *close_elem = 1;
1298 } else {
1299 rc = r;
1300 goto cleanup;
1301 }
1302
1303cleanup:
1304 if (rc) {
1305 lyd_free_tree(*envp);
1306 *envp = NULL;
1307 }
1308 return rc;
1309}
1310
1311/**
1312 * @brief Parse all expected non-data XML elements of a NETCONF notification message.
1313 *
1314 * @param[in] xmlctx XML parser context.
1315 * @param[out] evnp Parsed envelope(s) (opaque node).
1316 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1317 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1318 * @return LY_SUCCESS on success.
1319 * @return LY_ERR value on error.
1320 */
1321static LY_ERR
1322lydxml_env_netconf_notif(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1323{
1324 LY_ERR rc = LY_SUCCESS, r;
1325 struct lyd_node *child;
1326
1327 assert(envp && !*envp);
1328
1329 /* parse "notification" */
1330 r = lydxml_envelope(xmlctx, "notification", "urn:ietf:params:xml:ns:netconf:notification:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001331 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1332
1333 /* parse "eventTime" */
1334 r = lydxml_envelope(xmlctx, "eventTime", "urn:ietf:params:xml:ns:netconf:notification:1.0", 1, &child);
1335 if (r == LY_ENOT) {
Radek Krejci422afb12021-03-04 16:38:16 +01001336 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unexpected element \"%.*s\" instead of \"eventTime\".",
1337 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001338 r = LY_EVALID;
1339 }
1340 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1341
1342 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001343 lyd_insert_node(*envp, NULL, child, 0);
Michal Vaskoe0665742021-02-11 11:08:44 +01001344
1345 /* validate value */
Michal Vasko820efe82023-05-12 15:47:43 +02001346 r = lyd_parser_notif_eventtime_validate(child);
Michal Vasko51de7b72022-04-29 09:50:22 +02001347 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001348
1349 /* finish child parsing */
Michal Vaskoa8edff02020-03-27 14:47:01 +01001350 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1351 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoe0665742021-02-11 11:08:44 +01001352 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"eventTime\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001353 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001354 rc = LY_EVALID;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001355 goto cleanup;
1356 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001357 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1358
1359 /* NETCONF notification */
1360 *int_opts = LYD_INTOPT_NO_SIBLINGS | LYD_INTOPT_NOTIF;
1361 *close_elem = 1;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001362
1363cleanup:
Michal Vaskoe0665742021-02-11 11:08:44 +01001364 if (rc) {
Michal Vaskoa8edff02020-03-27 14:47:01 +01001365 lyd_free_tree(*envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001366 *envp = NULL;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001367 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001368 return rc;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001369}
Michal Vasko79135ae2020-12-16 10:08:35 +01001370
Michal Vaskoe0665742021-02-11 11:08:44 +01001371/**
1372 * @brief Parse an XML element as an opaque node subtree.
1373 *
1374 * @param[in] xmlctx XML parser context.
1375 * @param[in] parent Parent to append nodes to.
1376 * @return LY_ERR value.
1377 */
1378static LY_ERR
1379lydxml_opaq_r(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
Michal Vaskoa8edff02020-03-27 14:47:01 +01001380{
Michal Vaskoe0665742021-02-11 11:08:44 +01001381 LY_ERR rc = LY_SUCCESS;
1382 const struct lyxml_ns *ns;
1383 struct lyd_attr *attr = NULL;
1384 struct lyd_node *child = NULL;
1385 const char *name, *prefix;
1386 size_t name_len, prefix_len;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001387
Michal Vaskoe0665742021-02-11 11:08:44 +01001388 assert(xmlctx->status == LYXML_ELEMENT);
Michal Vaskoa8edff02020-03-27 14:47:01 +01001389
Michal Vaskoe0665742021-02-11 11:08:44 +01001390 name = xmlctx->name;
1391 name_len = xmlctx->name_len;
1392 prefix = xmlctx->prefix;
1393 prefix_len = xmlctx->prefix_len;
1394 ns = lyxml_ns_get(&xmlctx->ns, prefix, prefix_len);
1395 if (!ns) {
Radek Krejci422afb12021-03-04 16:38:16 +01001396 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Unknown XML prefix \"%.*s\".", (int)prefix_len, prefix);
Michal Vaskoe0665742021-02-11 11:08:44 +01001397 return LY_EVALID;
1398 }
Michal Vaskoa8edff02020-03-27 14:47:01 +01001399
Michal Vaskoe0665742021-02-11 11:08:44 +01001400 LY_CHECK_RET(lyxml_ctx_next(xmlctx));
Michal Vaskoa8edff02020-03-27 14:47:01 +01001401
Michal Vaskoe0665742021-02-11 11:08:44 +01001402 /* create attributes */
1403 if (xmlctx->status == LYXML_ATTRIBUTE) {
1404 LY_CHECK_RET(lydxml_attrs(xmlctx, &attr));
1405 }
1406
1407 /* create node */
1408 assert(xmlctx->status == LYXML_ELEM_CONTENT);
1409 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 +02001410 xmlctx->ws_only ? 0 : xmlctx->value_len, NULL, LY_VALUE_XML, NULL, 0, &child);
Michal Vaskoe0665742021-02-11 11:08:44 +01001411 LY_CHECK_GOTO(rc, cleanup);
1412
1413 /* assign atributes */
1414 ((struct lyd_node_opaq *)child)->attr = attr;
1415 attr = NULL;
1416
1417 /* parser next element */
1418 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1419
1420 /* parse all the descendants */
1421 while (xmlctx->status == LYXML_ELEMENT) {
1422 rc = lydxml_opaq_r(xmlctx, child);
1423 LY_CHECK_GOTO(rc, cleanup);
1424 }
1425
1426 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001427 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001428
1429cleanup:
1430 lyd_free_attr_siblings(xmlctx->ctx, attr);
1431 if (rc) {
1432 lyd_free_tree(child);
1433 }
1434 return rc;
1435}
1436
1437/**
1438 * @brief Parse all expected non-data XML elements of the error-info element in NETCONF rpc-reply message.
1439 *
1440 * @param[in] xmlctx XML parser context.
1441 * @param[in] parent Parent to append nodes to.
1442 * @return LY_ERR value.
1443 */
1444static LY_ERR
1445lydxml_env_netconf_rpc_reply_error_info(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
1446{
1447 LY_ERR r;
1448 struct lyd_node *child, *iter;
Michal Vaskoe0665742021-02-11 11:08:44 +01001449 ly_bool no_dup;
1450
1451 /* there must be some child */
1452 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1453 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"error-info\".");
1454 return LY_EVALID;
1455 }
1456
1457 while (xmlctx->status == LYXML_ELEMENT) {
1458 child = NULL;
1459
1460 /*
1461 * session-id
1462 */
1463 r = lydxml_envelope(xmlctx, "session-id", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1464 if (r == LY_SUCCESS) {
1465 no_dup = 1;
1466 goto check_child;
1467 } else if (r != LY_ENOT) {
1468 goto error;
1469 }
1470
1471 /*
1472 * bad-attribute
1473 */
1474 r = lydxml_envelope(xmlctx, "bad-attribute", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1475 if (r == LY_SUCCESS) {
1476 no_dup = 1;
1477 goto check_child;
1478 } else if (r != LY_ENOT) {
1479 goto error;
1480 }
1481
1482 /*
1483 * bad-element
1484 */
1485 r = lydxml_envelope(xmlctx, "bad-element", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1486 if (r == LY_SUCCESS) {
1487 no_dup = 1;
1488 goto check_child;
1489 } else if (r != LY_ENOT) {
1490 goto error;
1491 }
1492
1493 /*
1494 * bad-namespace
1495 */
1496 r = lydxml_envelope(xmlctx, "bad-namespace", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1497 if (r == LY_SUCCESS) {
1498 no_dup = 1;
1499 goto check_child;
1500 } else if (r != LY_ENOT) {
1501 goto error;
1502 }
1503
1504 if (r == LY_ENOT) {
1505 assert(xmlctx->status == LYXML_ELEMENT);
1506
Michal Vasko845ba392022-06-16 07:52:13 +02001507 /* custom elements, parse all the siblings */
1508 while (xmlctx->status == LYXML_ELEMENT) {
1509 LY_CHECK_GOTO(r = lydxml_opaq_r(xmlctx, parent), error);
1510 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1511 }
Michal Vasko6398eaf2022-01-10 10:12:30 +01001512 continue;
Michal Vaskoe0665742021-02-11 11:08:44 +01001513 }
1514
1515check_child:
1516 /* check for duplicates */
1517 if (no_dup) {
1518 LY_LIST_FOR(lyd_child(parent), iter) {
1519 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1520 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1521 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"error-info\".",
1522 ((struct lyd_node_opaq *)child)->name.name);
1523 r = LY_EVALID;
1524 goto error;
1525 }
1526 }
1527 }
1528
1529 /* finish child parsing */
1530 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1531 assert(xmlctx->status == LYXML_ELEMENT);
1532 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"error-info\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001533 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001534 r = LY_EVALID;
1535 goto error;
1536 }
1537 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1538
1539 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001540 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001541 }
1542
1543 return LY_SUCCESS;
1544
1545error:
1546 lyd_free_tree(child);
1547 return r;
1548}
1549
1550/**
1551 * @brief Parse all expected non-data XML elements of the rpc-error element in NETCONF rpc-reply message.
1552 *
1553 * @param[in] xmlctx XML parser context.
1554 * @param[in] parent Parent to append nodes to.
1555 * @return LY_ERR value.
1556 */
1557static LY_ERR
1558lydxml_env_netconf_rpc_reply_error(struct lyxml_ctx *xmlctx, struct lyd_node *parent)
1559{
1560 LY_ERR r;
1561 struct lyd_node *child, *iter;
1562 const char *val;
1563 ly_bool no_dup;
1564
1565 /* there must be some child */
1566 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1567 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-error\".");
1568 return LY_EVALID;
1569 }
1570
1571 while (xmlctx->status == LYXML_ELEMENT) {
1572 child = NULL;
1573
1574 /*
1575 * error-type
1576 */
1577 r = lydxml_envelope(xmlctx, "error-type", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1578 if (r == LY_SUCCESS) {
1579 val = ((struct lyd_node_opaq *)child)->value;
1580 if (strcmp(val, "transport") && strcmp(val, "rpc") && strcmp(val, "protocol") && strcmp(val, "application")) {
1581 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1582 ((struct lyd_node_opaq *)child)->name.name);
1583 r = LY_EVALID;
1584 goto error;
1585 }
1586
1587 no_dup = 1;
1588 goto check_child;
1589 } else if (r != LY_ENOT) {
1590 goto error;
1591 }
1592
1593 /*
1594 * error-tag
1595 */
1596 r = lydxml_envelope(xmlctx, "error-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1597 if (r == LY_SUCCESS) {
1598 val = ((struct lyd_node_opaq *)child)->value;
1599 if (strcmp(val, "in-use") && strcmp(val, "invalid-value") && strcmp(val, "too-big") &&
1600 strcmp(val, "missing-attribute") && strcmp(val, "bad-attribute") &&
1601 strcmp(val, "unknown-attribute") && strcmp(val, "missing-element") && strcmp(val, "bad-element") &&
1602 strcmp(val, "unknown-element") && strcmp(val, "unknown-namespace") && strcmp(val, "access-denied") &&
1603 strcmp(val, "lock-denied") && strcmp(val, "resource-denied") && strcmp(val, "rollback-failed") &&
1604 strcmp(val, "data-exists") && strcmp(val, "data-missing") && strcmp(val, "operation-not-supported") &&
1605 strcmp(val, "operation-failed") && strcmp(val, "malformed-message")) {
1606 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1607 ((struct lyd_node_opaq *)child)->name.name);
1608 r = LY_EVALID;
1609 goto error;
1610 }
1611
1612 no_dup = 1;
1613 goto check_child;
1614 } else if (r != LY_ENOT) {
1615 goto error;
1616 }
1617
1618 /*
1619 * error-severity
1620 */
1621 r = lydxml_envelope(xmlctx, "error-severity", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1622 if (r == LY_SUCCESS) {
1623 val = ((struct lyd_node_opaq *)child)->value;
1624 if (strcmp(val, "error") && strcmp(val, "warning")) {
1625 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Invalid value \"%s\" of element \"%s\".", val,
1626 ((struct lyd_node_opaq *)child)->name.name);
1627 r = LY_EVALID;
1628 goto error;
1629 }
1630
1631 no_dup = 1;
1632 goto check_child;
1633 } else if (r != LY_ENOT) {
1634 goto error;
1635 }
1636
1637 /*
1638 * error-app-tag
1639 */
1640 r = lydxml_envelope(xmlctx, "error-app-tag", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1641 if (r == LY_SUCCESS) {
1642 no_dup = 1;
1643 goto check_child;
1644 } else if (r != LY_ENOT) {
1645 goto error;
1646 }
1647
1648 /*
1649 * error-path
1650 */
1651 r = lydxml_envelope(xmlctx, "error-path", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1652 if (r == LY_SUCCESS) {
1653 no_dup = 1;
1654 goto check_child;
1655 } else if (r != LY_ENOT) {
1656 goto error;
1657 }
1658
1659 /*
1660 * error-message
1661 */
1662 r = lydxml_envelope(xmlctx, "error-message", "urn:ietf:params:xml:ns:netconf:base:1.0", 1, &child);
1663 if (r == LY_SUCCESS) {
1664 no_dup = 1;
1665 goto check_child;
1666 } else if (r != LY_ENOT) {
1667 goto error;
1668 }
1669
1670 /* error-info */
1671 r = lydxml_envelope(xmlctx, "error-info", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1672 if (r == LY_SUCCESS) {
1673 /* parse all the descendants */
1674 LY_CHECK_GOTO(r = lydxml_env_netconf_rpc_reply_error_info(xmlctx, child), error);
1675
1676 no_dup = 0;
1677 goto check_child;
1678 } else if (r != LY_ENOT) {
1679 goto error;
1680 }
1681
1682 if (r == LY_ENOT) {
1683 assert(xmlctx->status == LYXML_ELEMENT);
1684 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001685 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001686 r = LY_EVALID;
1687 goto error;
1688 }
1689
1690check_child:
1691 /* check for duplicates */
1692 if (no_dup) {
1693 LY_LIST_FOR(lyd_child(parent), iter) {
1694 if ((((struct lyd_node_opaq *)iter)->name.name == ((struct lyd_node_opaq *)child)->name.name) &&
1695 (((struct lyd_node_opaq *)iter)->name.module_ns == ((struct lyd_node_opaq *)child)->name.module_ns)) {
1696 LOGVAL(xmlctx->ctx, LYVE_REFERENCE, "Duplicate element \"%s\" in \"rpc-error\".",
1697 ((struct lyd_node_opaq *)child)->name.name);
1698 r = LY_EVALID;
1699 goto error;
1700 }
1701 }
1702 }
1703
1704 /* finish child parsing */
1705 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1706 assert(xmlctx->status == LYXML_ELEMENT);
1707 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"rpc-error\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001708 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001709 r = LY_EVALID;
1710 goto error;
1711 }
1712 LY_CHECK_GOTO(r = lyxml_ctx_next(xmlctx), error);
1713
1714 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001715 lyd_insert_node(parent, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001716 }
1717
1718 return LY_SUCCESS;
1719
1720error:
1721 lyd_free_tree(child);
1722 return r;
1723}
1724
1725/**
1726 * @brief Parse all expected non-data XML elements of a NETCONF rpc-reply message.
1727 *
1728 * @param[in] xmlctx XML parser context.
1729 * @param[out] evnp Parsed envelope(s) (opaque node).
1730 * @param[out] int_opts Internal options for parsing the rest of YANG data.
1731 * @param[out] close_elem Number of parsed opened elements that need to be closed.
1732 * @return LY_SUCCESS on success.
1733 * @return LY_ERR value on error.
1734 */
1735static LY_ERR
1736lydxml_env_netconf_reply(struct lyxml_ctx *xmlctx, struct lyd_node **envp, uint32_t *int_opts, uint32_t *close_elem)
1737{
1738 LY_ERR rc = LY_SUCCESS, r;
1739 struct lyd_node *child = NULL;
1740 const char *parsed_elem = NULL;
1741
1742 assert(envp && !*envp);
1743
1744 /* parse "rpc-reply" */
1745 r = lydxml_envelope(xmlctx, "rpc-reply", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, envp);
Michal Vaskoe0665742021-02-11 11:08:44 +01001746 LY_CHECK_ERR_GOTO(r, rc = r, cleanup);
1747
1748 /* there must be some child */
1749 if (xmlctx->status == LYXML_ELEM_CLOSE) {
1750 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Missing child elements of \"rpc-reply\".");
1751 rc = LY_EVALID;
Michal Vaskocf770e22020-08-12 13:21:43 +02001752 goto cleanup;
Michal Vaskoa8edff02020-03-27 14:47:01 +01001753 }
1754
Michal Vaskoe0665742021-02-11 11:08:44 +01001755 /* try to parse "ok" */
1756 r = lydxml_envelope(xmlctx, "ok", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1757 if (r == LY_SUCCESS) {
1758 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001759 lyd_insert_node(*envp, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001760
1761 /* finish child parsing */
1762 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1763 assert(xmlctx->status == LYXML_ELEMENT);
1764 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected child element \"%.*s\" of \"ok\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001765 (int)xmlctx->name_len, xmlctx->name);
Michal Vaskoe0665742021-02-11 11:08:44 +01001766 rc = LY_EVALID;
1767 goto cleanup;
1768 }
1769 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1770
1771 /* success */
1772 parsed_elem = "ok";
1773 goto finish;
1774 } else if (r != LY_ENOT) {
1775 rc = r;
1776 goto cleanup;
Michal Vasko2552ea32020-12-08 15:32:34 +01001777 }
1778
Michal Vaskoe0665742021-02-11 11:08:44 +01001779 /* try to parse all "rpc-error" elements */
1780 while (xmlctx->status == LYXML_ELEMENT) {
1781 r = lydxml_envelope(xmlctx, "rpc-error", "urn:ietf:params:xml:ns:netconf:base:1.0", 0, &child);
1782 if (r == LY_ENOT) {
1783 break;
1784 } else if (r) {
1785 rc = r;
1786 goto cleanup;
1787 }
1788
1789 /* insert */
Michal Vasko6ee6f432021-07-16 09:49:14 +02001790 lyd_insert_node(*envp, NULL, child, 1);
Michal Vaskoe0665742021-02-11 11:08:44 +01001791
1792 /* parse all children of "rpc-error" */
1793 LY_CHECK_GOTO(rc = lydxml_env_netconf_rpc_reply_error(xmlctx, child), cleanup);
1794
1795 /* finish child parsing */
1796 assert(xmlctx->status == LYXML_ELEM_CLOSE);
1797 LY_CHECK_GOTO(rc = lyxml_ctx_next(xmlctx), cleanup);
1798
1799 parsed_elem = "rpc-error";
Michal Vasko2552ea32020-12-08 15:32:34 +01001800 }
Michal Vaskoe0665742021-02-11 11:08:44 +01001801
1802finish:
1803 if (parsed_elem) {
1804 /* NETCONF rpc-reply with no data */
1805 if (xmlctx->status != LYXML_ELEM_CLOSE) {
1806 assert(xmlctx->status == LYXML_ELEMENT);
1807 LOGVAL(xmlctx->ctx, LYVE_SYNTAX, "Unexpected sibling element \"%.*s\" of \"%s\".",
Radek Krejci422afb12021-03-04 16:38:16 +01001808 (int)xmlctx->name_len, xmlctx->name, parsed_elem);
Michal Vaskoe0665742021-02-11 11:08:44 +01001809 rc = LY_EVALID;
1810 goto cleanup;
1811 }
1812 }
1813
1814 /* NETCONF rpc-reply */
Michal Vasko1d991fd2021-07-09 13:14:40 +02001815 *int_opts = LYD_INTOPT_WITH_SIBLINGS | LYD_INTOPT_REPLY;
Michal Vaskoe0665742021-02-11 11:08:44 +01001816 *close_elem = 1;
1817
1818cleanup:
1819 if (rc) {
1820 lyd_free_tree(*envp);
1821 *envp = NULL;
1822 }
1823 return rc;
1824}
1825
Michal Vasko2552ea32020-12-08 15:32:34 +01001826LY_ERR
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001827lyd_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 +01001828 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 +01001829 struct lyd_node **envp, struct ly_set *parsed, struct lyd_ctx **lydctx_p)
Michal Vasko2552ea32020-12-08 15:32:34 +01001830{
Michal Vaskoe0665742021-02-11 11:08:44 +01001831 LY_ERR rc = LY_SUCCESS;
1832 struct lyd_xml_ctx *lydctx;
Michal Vasko2ca9f9e2021-07-02 09:21:36 +02001833 uint32_t i, int_opts = 0, close_elem = 0;
Michal Vaskoe0665742021-02-11 11:08:44 +01001834 ly_bool parsed_data_nodes = 0;
Michal Vasko2552ea32020-12-08 15:32:34 +01001835
Michal Vaskoe0665742021-02-11 11:08:44 +01001836 assert(ctx && in && lydctx_p);
1837 assert(!(parse_opts & ~LYD_PARSE_OPTS_MASK));
1838 assert(!(val_opts & ~LYD_VALIDATE_OPTS_MASK));
Michal Vaskoe3ed7dc2022-11-30 11:39:44 +01001839 assert(!(parse_opts & LYD_PARSE_SUBTREE));
1840
Michal Vaskoe0665742021-02-11 11:08:44 +01001841 /* init context */
1842 lydctx = calloc(1, sizeof *lydctx);
1843 LY_CHECK_ERR_RET(!lydctx, LOGMEM(ctx), LY_EMEM);
1844 LY_CHECK_GOTO(rc = lyxml_ctx_new(ctx, in, &lydctx->xmlctx), cleanup);
1845 lydctx->parse_opts = parse_opts;
1846 lydctx->val_opts = val_opts;
1847 lydctx->free = lyd_xml_ctx_free;
Radek Krejcif16e2542021-02-17 15:39:23 +01001848 lydctx->ext = ext;
Michal Vasko2552ea32020-12-08 15:32:34 +01001849
Michal Vaskoe0665742021-02-11 11:08:44 +01001850 switch (data_type) {
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001851 case LYD_TYPE_RPC_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001852 assert(!parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001853 rc = lydxml_env_netconf_rpc(lydctx->xmlctx, envp, &int_opts, &close_elem);
1854 if (rc == LY_ENOT) {
1855 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <rpc> envelope or in incorrect namespace.");
1856 }
1857 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001858 break;
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001859 case LYD_TYPE_NOTIF_NETCONF:
1860 assert(!parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001861 rc = lydxml_env_netconf_notif(lydctx->xmlctx, envp, &int_opts, &close_elem);
1862 if (rc == LY_ENOT) {
1863 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <notification> envelope or in incorrect namespace.");
1864 }
1865 LY_CHECK_GOTO(rc, cleanup);
Michal Vasko1e4c68e2021-02-18 15:03:01 +01001866 break;
1867 case LYD_TYPE_REPLY_NETCONF:
Michal Vaskoe0665742021-02-11 11:08:44 +01001868 assert(parent);
Michal Vaskod71c2d42022-04-29 09:50:44 +02001869 rc = lydxml_env_netconf_reply(lydctx->xmlctx, envp, &int_opts, &close_elem);
1870 if (rc == LY_ENOT) {
1871 LOGVAL(ctx, LYVE_DATA, "Missing NETCONF <rpc-reply> envelope or in incorrect namespace.");
1872 }
1873 LY_CHECK_GOTO(rc, cleanup);
Michal Vaskoe0665742021-02-11 11:08:44 +01001874 break;
Michal Vasko820efe82023-05-12 15:47:43 +02001875 case LYD_TYPE_RPC_RESTCONF:
1876 assert(parent);
1877
1878 /* parse "input" */
1879 rc = lydxml_envelope(lydctx->xmlctx, "input", lyd_owner_module(parent)->ns, 0, envp);
1880 if (rc == LY_ENOT) {
1881 LOGVAL(ctx, LYVE_DATA, "Missing RESTCONF \"input\" object or in incorrect namespace.");
1882 }
1883 LY_CHECK_GOTO(rc, cleanup);
1884
1885 int_opts = LYD_INTOPT_WITH_SIBLINGS | LYD_INTOPT_RPC | LYD_INTOPT_ACTION;
1886 close_elem = 1;
1887 break;
1888 case LYD_TYPE_REPLY_RESTCONF:
1889 assert(parent);
1890
1891 /* parse "output" */
1892 rc = lydxml_envelope(lydctx->xmlctx, "output", lyd_owner_module(parent)->ns, 0, envp);
1893 if (rc == LY_ENOT) {
1894 LOGVAL(ctx, LYVE_DATA, "Missing RESTCONF \"output\" object or in incorrect namespace.");
1895 }
1896 LY_CHECK_GOTO(rc, cleanup);
1897
1898 int_opts = LYD_INTOPT_WITH_SIBLINGS | LYD_INTOPT_REPLY;
1899 close_elem = 1;
1900 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}