blob: 5c17aa8bee7f7a5db0c4a459969c64dcc3f0f6ab [file] [log] [blame]
Radek Krejcie7b95092019-05-15 11:03:07 +02001/**
2 * @file printer_xml.c
3 * @author Michal Vasko <mvasko@cesnet.cz>
4 * @author Radek Krejci <rkrejci@cesnet.cz>
5 * @brief XML printer for libyang data structure
6 *
7 * Copyright (c) 2015 - 2019 CESNET, z.s.p.o.
8 *
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
Radek Krejci535ea9f2020-05-29 16:01:05 +020016#include <assert.h>
17#include <stdint.h>
Radek Krejcie7b95092019-05-15 11:03:07 +020018#include <stdlib.h>
19#include <string.h>
20
Radek Krejci535ea9f2020-05-29 16:01:05 +020021#include "common.h"
22#include "context.h"
23#include "dict.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020024#include "log.h"
Radek Krejci47fab892020-11-05 17:02:41 +010025#include "out.h"
26#include "out_internal.h"
Radek Krejci7931b192020-06-25 17:05:03 +020027#include "parser_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020028#include "plugins_types.h"
29#include "printer_data.h"
30#include "printer_internal.h"
Radek Krejci535ea9f2020-05-29 16:01:05 +020031#include "set.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020032#include "tree.h"
Radek Krejci47fab892020-11-05 17:02:41 +010033#include "tree_data.h"
Radek Krejcie7b95092019-05-15 11:03:07 +020034#include "tree_schema.h"
35#include "xml.h"
36
37/**
38 * @brief XML printer context.
39 */
40struct xmlpr_ctx {
Radek Krejci1deb5be2020-08-26 16:43:36 +020041 struct ly_out *out; /**< output specification */
42 uint16_t level; /**< current indentation level: 0 - no formatting, >= 1 indentation levels */
43 uint32_t options; /**< [Data printer flags](@ref dataprinterflags) */
Michal Vasko52927e22020-03-16 17:26:14 +010044 const struct ly_ctx *ctx; /**< libyang context */
Radek Krejci1deb5be2020-08-26 16:43:36 +020045 struct ly_set prefix; /**< printed namespace prefixes */
46 struct ly_set ns; /**< printed namespaces */
Radek Krejcie7b95092019-05-15 11:03:07 +020047};
48
Michal Vasko52927e22020-03-16 17:26:14 +010049#define LYXML_PREFIX_REQUIRED 0x01 /**< The prefix is not just a suggestion but a requirement. */
Radek Krejci1798aae2020-07-14 13:26:06 +020050#define LYXML_PREFIX_DEFAULT 0x02 /**< The namespace is required to be a default (without prefix) */
Radek Krejcie7b95092019-05-15 11:03:07 +020051
52/**
Michal Vasko52927e22020-03-16 17:26:14 +010053 * @brief Print a namespace if not already printed.
54 *
55 * @param[in] ctx XML printer context.
56 * @param[in] ns Namespace to print, expected to be in dictionary.
57 * @param[in] new_prefix Suggested new prefix, NULL for a default namespace without prefix. Stored in the dictionary.
58 * @param[in] prefix_opts Prefix options changing the meaning of parameters.
59 * @return Printed prefix of the namespace to use.
Radek Krejcie7b95092019-05-15 11:03:07 +020060 */
Michal Vasko52927e22020-03-16 17:26:14 +010061static const char *
Michal Vaskoc08b9d22022-02-10 15:48:39 +010062xml_print_ns(struct xmlpr_ctx *pctx, const char *ns, const char *new_prefix, uint32_t prefix_opts)
Radek Krejcie7b95092019-05-15 11:03:07 +020063{
Radek Krejciba03a5a2020-08-27 14:40:41 +020064 uint32_t i;
Michal Vasko6f4cbb62020-02-28 11:15:47 +010065
Michal Vaskoc08b9d22022-02-10 15:48:39 +010066 for (i = pctx->ns.count; i > 0; --i) {
Michal Vasko52927e22020-03-16 17:26:14 +010067 if (!new_prefix) {
68 /* find default namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +010069 if (!pctx->prefix.objs[i - 1]) {
70 if (!strcmp(pctx->ns.objs[i - 1], ns)) {
Radek Krejciba03a5a2020-08-27 14:40:41 +020071 /* matching default namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +010072 return pctx->prefix.objs[i - 1];
Radek Krejcie7b95092019-05-15 11:03:07 +020073 }
Radek Krejciba03a5a2020-08-27 14:40:41 +020074 /* not matching default namespace */
Michal Vasko52927e22020-03-16 17:26:14 +010075 break;
76 }
77 } else {
78 /* find prefixed namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +010079 if (!strcmp(pctx->ns.objs[i - 1], ns)) {
80 if (!pctx->prefix.objs[i - 1]) {
Michal Vasko52927e22020-03-16 17:26:14 +010081 /* default namespace is not interesting */
82 continue;
83 }
84
Michal Vaskoc08b9d22022-02-10 15:48:39 +010085 if (!strcmp(pctx->prefix.objs[i - 1], new_prefix) || !(prefix_opts & LYXML_PREFIX_REQUIRED)) {
Michal Vasko52927e22020-03-16 17:26:14 +010086 /* the same prefix or can be any */
Michal Vaskoc08b9d22022-02-10 15:48:39 +010087 return pctx->prefix.objs[i - 1];
Michal Vasko52927e22020-03-16 17:26:14 +010088 }
89 }
Radek Krejcie7b95092019-05-15 11:03:07 +020090 }
Radek Krejcie7b95092019-05-15 11:03:07 +020091 }
Radek Krejci28681fa2019-09-06 13:08:45 +020092
Radek Krejciba03a5a2020-08-27 14:40:41 +020093 /* suitable namespace not found, must be printed */
Michal Vaskoc08b9d22022-02-10 15:48:39 +010094 ly_print_(pctx->out, " xmlns%s%s=\"%s\"", new_prefix ? ":" : "", new_prefix ? new_prefix : "", ns);
Radek Krejcie7b95092019-05-15 11:03:07 +020095
Radek Krejciba03a5a2020-08-27 14:40:41 +020096 /* and added into namespaces */
97 if (new_prefix) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +010098 LY_CHECK_RET(lydict_insert(pctx->ctx, new_prefix, 0, &new_prefix), NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +020099 }
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100100 LY_CHECK_RET(ly_set_add(&pctx->prefix, (void *)new_prefix, 1, NULL), NULL);
101 LY_CHECK_RET(ly_set_add(&pctx->ns, (void *)ns, 1, &i), NULL);
Michal Vasko52927e22020-03-16 17:26:14 +0100102
103 /* return it */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100104 return pctx->prefix.objs[i];
Radek Krejci28681fa2019-09-06 13:08:45 +0200105}
106
Michal Vasko22df3f02020-08-24 13:29:22 +0200107static const char *
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100108xml_print_ns_opaq(struct xmlpr_ctx *pctx, LY_VALUE_FORMAT format, const struct ly_opaq_name *name, uint32_t prefix_opts)
Radek Krejci1798aae2020-07-14 13:26:06 +0200109{
Radek Krejci1798aae2020-07-14 13:26:06 +0200110 switch (format) {
Radek Krejci8df109d2021-04-23 12:19:08 +0200111 case LY_VALUE_XML:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100112 return xml_print_ns(pctx, name->module_ns, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : name->prefix, prefix_opts);
Radek Krejci1798aae2020-07-14 13:26:06 +0200113 break;
Radek Krejci8df109d2021-04-23 12:19:08 +0200114 case LY_VALUE_JSON:
Michal Vaskoad92b672020-11-12 13:11:31 +0100115 if (name->module_name) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100116 const struct lys_module *mod = ly_ctx_get_module_latest(pctx->ctx, name->module_name);
Radek Krejci1798aae2020-07-14 13:26:06 +0200117 if (mod) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100118 return xml_print_ns(pctx, mod->ns, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : name->prefix, prefix_opts);
Radek Krejci1798aae2020-07-14 13:26:06 +0200119 }
120 }
121 break;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100122 default:
Radek Krejci1798aae2020-07-14 13:26:06 +0200123 /* cannot be created */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100124 LOGINT(pctx->ctx);
Radek Krejci1798aae2020-07-14 13:26:06 +0200125 }
126
127 return NULL;
128}
129
Radek Krejciec9ad602021-01-04 10:46:30 +0100130/**
131 * @brief Print prefix data.
132 *
133 * @param[in] ctx XML printer context.
Radek Krejci8df109d2021-04-23 12:19:08 +0200134 * @param[in] format Value prefix format, only ::LY_VALUE_XML supported.
135 * @param[in] prefix_data Format-specific data for resolving any prefixes (see ::ly_resolve_prefix).
Radek Krejciec9ad602021-01-04 10:46:30 +0100136 * @param[in] prefix_opts Prefix options changing the meaning of parameters.
137 * @return LY_ERR value.
138 */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100139static void
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100140xml_print_ns_prefix_data(struct xmlpr_ctx *pctx, LY_VALUE_FORMAT format, void *prefix_data, uint32_t prefix_opts)
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100141{
142 const struct ly_set *set;
143 const struct lyxml_ns *ns;
144 uint32_t i;
145
146 switch (format) {
Radek Krejci8df109d2021-04-23 12:19:08 +0200147 case LY_VALUE_XML:
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100148 set = prefix_data;
149 for (i = 0; i < set->count; ++i) {
150 ns = set->objs[i];
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100151 xml_print_ns(pctx, ns->uri, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : ns->prefix, prefix_opts);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100152 }
153 break;
154 default:
155 /* cannot be created */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100156 LOGINT(pctx->ctx);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100157 }
158}
159
Radek Krejci28681fa2019-09-06 13:08:45 +0200160/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200161 * TODO
162 */
Michal Vasko52927e22020-03-16 17:26:14 +0100163static void
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100164xml_print_meta(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200165{
Michal Vasko9f96a052020-03-10 09:41:45 +0100166 struct lyd_meta *meta;
Michal Vasko52927e22020-03-16 17:26:14 +0100167 const struct lys_module *mod;
168 struct ly_set ns_list = {0};
Michal Vasko45791ad2021-06-17 08:45:03 +0200169 LY_ARRAY_COUNT_TYPE u;
170 ly_bool dynamic, filter_attrs = 0;
Radek Krejcie7b95092019-05-15 11:03:07 +0200171
Radek Krejcie7b95092019-05-15 11:03:07 +0200172 /* with-defaults */
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100173 if (node->schema->nodetype & LYD_NODE_TERM) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100174 if (((node->flags & LYD_DEFAULT) && (pctx->options & (LYD_PRINT_WD_ALL_TAG | LYD_PRINT_WD_IMPL_TAG))) ||
175 ((pctx->options & LYD_PRINT_WD_ALL_TAG) && lyd_is_default(node))) {
Michal Vasko52927e22020-03-16 17:26:14 +0100176 /* we have implicit OR explicit default node, print attribute only if context include with-defaults schema */
Radek Krejcic2b49d82021-04-26 08:05:57 +0200177 mod = ly_ctx_get_module_latest(LYD_CTX(node), "ietf-netconf-with-defaults");
Michal Vasko52927e22020-03-16 17:26:14 +0100178 if (mod) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100179 ly_print_(pctx->out, " %s:default=\"true\"", xml_print_ns(pctx, mod->ns, mod->prefix, 0));
Radek Krejcie7b95092019-05-15 11:03:07 +0200180 }
181 }
182 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200183
184 /* check for NETCONF filter unqualified attributes */
185 LY_ARRAY_FOR(node->schema->exts, u) {
186 if (!strcmp(node->schema->exts[u].def->name, "get-filter-element-attributes") &&
187 !strcmp(node->schema->exts[u].def->module->name, "ietf-netconf")) {
188 filter_attrs = 1;
189 break;
190 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200191 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200192
Michal Vasko9f96a052020-03-10 09:41:45 +0100193 for (meta = node->meta; meta; meta = meta->next) {
Radek Krejci224d4b42021-04-23 13:54:59 +0200194 const char *value = meta->value.realtype->plugin->print(LYD_CTX(node), &meta->value, LY_VALUE_XML, &ns_list,
195 &dynamic, NULL);
Radek Krejci28681fa2019-09-06 13:08:45 +0200196
Michal Vasko52927e22020-03-16 17:26:14 +0100197 /* print namespaces connected with the value's prefixes */
Michal Vasko45791ad2021-06-17 08:45:03 +0200198 for (uint32_t i = 0; i < ns_list.count; ++i) {
199 mod = ns_list.objs[i];
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100200 xml_print_ns(pctx, mod->ns, mod->prefix, 1);
Radek Krejci28681fa2019-09-06 13:08:45 +0200201 }
202 ly_set_erase(&ns_list, NULL);
203
Radek Krejci0f969882020-08-21 16:56:47 +0200204 mod = meta->annotation->module;
Michal Vasko45791ad2021-06-17 08:45:03 +0200205 if (filter_attrs && !strcmp(mod->name, "ietf-netconf") && (!strcmp(meta->name, "type") ||
206 !strcmp(meta->name, "select"))) {
207 /* print special NETCONF filter unqualified attributes */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100208 ly_print_(pctx->out, " %s=\"", meta->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200209 } else {
210 /* print the metadata with its namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100211 ly_print_(pctx->out, " %s:%s=\"", xml_print_ns(pctx, mod->ns, mod->prefix, 1), meta->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200212 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200213
Michal Vasko52927e22020-03-16 17:26:14 +0100214 /* print metadata value */
Radek Krejci28681fa2019-09-06 13:08:45 +0200215 if (value && value[0]) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100216 lyxml_dump_text(pctx->out, value, 1);
Radek Krejcie7b95092019-05-15 11:03:07 +0200217 }
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100218 ly_print_(pctx->out, "\"");
Radek Krejci28681fa2019-09-06 13:08:45 +0200219 if (dynamic) {
Michal Vasko52927e22020-03-16 17:26:14 +0100220 free((void *)value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200221 }
222 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200223}
224
225/**
226 * @brief Print generic XML element despite of the data node type.
227 *
228 * Prints the element name, attributes and necessary namespaces.
229 *
230 * @param[in] ctx XML printer context.
231 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200232 */
Michal Vasko52927e22020-03-16 17:26:14 +0100233static void
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100234xml_print_node_open(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200235{
Michal Vasko52927e22020-03-16 17:26:14 +0100236 /* print node name */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100237 ly_print_(pctx->out, "%*s<%s", INDENT, node->schema->name);
Michal Vasko52927e22020-03-16 17:26:14 +0100238
239 /* print default namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100240 xml_print_ns(pctx, node->schema->module->ns, NULL, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100241
242 /* print metadata */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100243 xml_print_meta(pctx, node);
Michal Vasko52927e22020-03-16 17:26:14 +0100244}
245
246static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100247xml_print_attr(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100248{
Radek Krejci5536d282020-08-04 23:27:44 +0200249 const struct lyd_attr *attr;
Michal Vasko52927e22020-03-16 17:26:14 +0100250 const char *pref;
Michal Vasko52927e22020-03-16 17:26:14 +0100251
252 LY_LIST_FOR(node->attr, attr) {
253 pref = NULL;
Michal Vaskoad92b672020-11-12 13:11:31 +0100254 if (attr->name.prefix) {
Michal Vasko52927e22020-03-16 17:26:14 +0100255 /* print attribute namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100256 pref = xml_print_ns_opaq(pctx, attr->format, &attr->name, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100257 }
258
259 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100260 if (attr->val_prefix_data) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100261 xml_print_ns_prefix_data(pctx, attr->format, attr->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100262 }
263
264 /* print the attribute with its prefix and value */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100265 ly_print_(pctx->out, " %s%s%s=\"", pref ? pref : "", pref ? ":" : "", attr->name.name);
266 lyxml_dump_text(pctx->out, attr->value, 1);
267 ly_print_(pctx->out, "\""); /* print attribute value terminator */
Radek IÅ¡a52c4ac62021-03-08 09:37:32 +0100268
Radek Krejcie7b95092019-05-15 11:03:07 +0200269 }
270
Michal Vasko52927e22020-03-16 17:26:14 +0100271 return LY_SUCCESS;
272}
273
274static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100275xml_print_opaq_open(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100276{
277 /* print node name */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100278 ly_print_(pctx->out, "%*s<%s", INDENT, node->name.name);
Michal Vasko52927e22020-03-16 17:26:14 +0100279
280 /* print default namespace */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100281 xml_print_ns_opaq(pctx, node->format, &node->name, LYXML_PREFIX_DEFAULT);
Radek Krejcie7b95092019-05-15 11:03:07 +0200282
Michal Vasko52927e22020-03-16 17:26:14 +0100283 /* print attributes */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100284 LY_CHECK_RET(xml_print_attr(pctx, node));
Radek Krejcie7b95092019-05-15 11:03:07 +0200285
286 return LY_SUCCESS;
287}
288
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100289static LY_ERR xml_print_node(struct xmlpr_ctx *pctx, const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200290
291/**
292 * @brief Print XML element representing lyd_node_term.
293 *
294 * @param[in] ctx XML printer context.
295 * @param[in] node Data node to be printed.
Michal Vasko569f2f42021-08-04 11:31:08 +0200296 * @return LY_ERR value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200297 */
Michal Vasko569f2f42021-08-04 11:31:08 +0200298static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100299xml_print_term(struct xmlpr_ctx *pctx, const struct lyd_node_term *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200300{
Radek Krejcia1911222019-07-22 17:24:50 +0200301 struct ly_set ns_list = {0};
Radek Krejci857189e2020-09-01 13:26:36 +0200302 ly_bool dynamic;
Radek Krejci28681fa2019-09-06 13:08:45 +0200303 const char *value;
304
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100305 xml_print_node_open(pctx, &node->node);
Radek Krejci224d4b42021-04-23 13:54:59 +0200306 value = ((struct lysc_node_leaf *)node->schema)->type->plugin->print(LYD_CTX(node), &node->value, LY_VALUE_XML,
307 &ns_list, &dynamic, NULL);
Michal Vasko569f2f42021-08-04 11:31:08 +0200308 LY_CHECK_RET(!value, LY_EINVAL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200309
Radek Krejcia1911222019-07-22 17:24:50 +0200310 /* print namespaces connected with the values's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200311 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100312 const struct lys_module *mod = (const struct lys_module *)ns_list.objs[u];
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100313 ly_print_(pctx->out, " xmlns:%s=\"%s\"", mod->prefix, mod->ns);
Radek Krejcie7b95092019-05-15 11:03:07 +0200314 }
Radek Krejcia1911222019-07-22 17:24:50 +0200315 ly_set_erase(&ns_list, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200316
Michal Vasko569f2f42021-08-04 11:31:08 +0200317 if (!value[0]) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100318 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200319 } else {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100320 ly_print_(pctx->out, ">");
321 lyxml_dump_text(pctx->out, value, 0);
322 ly_print_(pctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200323 }
Radek Krejcia1911222019-07-22 17:24:50 +0200324 if (dynamic) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100325 free((void *)value);
Radek Krejcia1911222019-07-22 17:24:50 +0200326 }
Michal Vasko569f2f42021-08-04 11:31:08 +0200327
328 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200329}
330
331/**
332 * @brief Print XML element representing lyd_node_inner.
333 *
334 * @param[in] ctx XML printer context.
335 * @param[in] node Data node to be printed.
336 * @return LY_ERR value.
337 */
338static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100339xml_print_inner(struct xmlpr_ctx *pctx, const struct lyd_node_inner *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200340{
341 LY_ERR ret;
342 struct lyd_node *child;
343
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100344 xml_print_node_open(pctx, &node->node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200345
Michal Vasko630d9892020-12-08 17:11:08 +0100346 LY_LIST_FOR(node->child, child) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100347 if (ly_should_print(child, pctx->options)) {
Michal Vasko630d9892020-12-08 17:11:08 +0100348 break;
349 }
350 }
351 if (!child) {
352 /* there are no children that will be printed */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100353 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200354 return LY_SUCCESS;
355 }
356
357 /* children */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100358 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200359
360 LEVEL_INC;
361 LY_LIST_FOR(node->child, child) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100362 ret = xml_print_node(pctx, child);
Radek Krejcie7b95092019-05-15 11:03:07 +0200363 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
364 }
365 LEVEL_DEC;
366
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100367 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200368
369 return LY_SUCCESS;
370}
371
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200372static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100373xml_print_anydata(struct xmlpr_ctx *pctx, const struct lyd_node_any *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200374{
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200375 struct lyd_node_any *any = (struct lyd_node_any *)node;
Radek Krejcie7b95092019-05-15 11:03:07 +0200376 struct lyd_node *iter;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200377 uint32_t prev_opts, prev_lo;
Michal Vasko52927e22020-03-16 17:26:14 +0100378 LY_ERR ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200379
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100380 xml_print_node_open(pctx, &node->node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200381
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200382 if (!any->value.tree) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200383 /* no content */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200384no_content:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100385 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200386 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200387 } else {
Michal Vasko60ea6352020-06-29 13:39:39 +0200388 if (any->value_type == LYD_ANYDATA_LYB) {
389 /* turn logging off */
390 prev_lo = ly_log_options(0);
391
392 /* try to parse it into a data tree */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200393 if (lyd_parse_data_mem((struct ly_ctx *)LYD_CTX(node), any->value.mem, LYD_LYB, LYD_PARSE_ONLY | LYD_PARSE_OPAQ | LYD_PARSE_STRICT, 0, &iter) == LY_SUCCESS) {
Michal Vasko60ea6352020-06-29 13:39:39 +0200394 /* successfully parsed */
395 free(any->value.mem);
396 any->value.tree = iter;
397 any->value_type = LYD_ANYDATA_DATATREE;
398 }
Radek Krejci7931b192020-06-25 17:05:03 +0200399
400 /* turn loggin on again */
401 ly_log_options(prev_lo);
Michal Vasko60ea6352020-06-29 13:39:39 +0200402 }
403
Radek Krejcie7b95092019-05-15 11:03:07 +0200404 switch (any->value_type) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200405 case LYD_ANYDATA_DATATREE:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200406 /* close opening tag and print data */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100407 prev_opts = pctx->options;
408 pctx->options &= ~LYD_PRINT_WITHSIBLINGS;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200409 LEVEL_INC;
410
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100411 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200412 LY_LIST_FOR(any->value.tree, iter) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100413 ret = xml_print_node(pctx, iter);
Michal Vasko52927e22020-03-16 17:26:14 +0100414 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
Radek Krejcie7b95092019-05-15 11:03:07 +0200415 }
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200416
417 LEVEL_DEC;
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100418 pctx->options = prev_opts;
Radek Krejcie7b95092019-05-15 11:03:07 +0200419 break;
420 case LYD_ANYDATA_STRING:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200421 /* escape XML-sensitive characters */
422 if (!any->value.str[0]) {
423 goto no_content;
424 }
425 /* close opening tag and print data */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100426 ly_print_(pctx->out, ">");
427 lyxml_dump_text(pctx->out, any->value.str, 0);
Radek Krejcie7b95092019-05-15 11:03:07 +0200428 break;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200429 case LYD_ANYDATA_XML:
430 /* print without escaping special characters */
431 if (!any->value.str[0]) {
432 goto no_content;
433 }
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100434 ly_print_(pctx->out, ">%s", any->value.str);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200435 break;
436 case LYD_ANYDATA_JSON:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200437 case LYD_ANYDATA_LYB:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200438 /* JSON and LYB format is not supported */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100439 LOGWRN(pctx->ctx, "Unable to print anydata content (type %d) as XML.", any->value_type);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200440 goto no_content;
Radek Krejcie7b95092019-05-15 11:03:07 +0200441 }
442
443 /* closing tag */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200444 if (any->value_type == LYD_ANYDATA_DATATREE) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100445 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200446 } else {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100447 ly_print_(pctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200448 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200449 }
450
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200451 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200452}
Radek Krejcie7b95092019-05-15 11:03:07 +0200453
Michal Vasko52927e22020-03-16 17:26:14 +0100454static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100455xml_print_opaq(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100456{
457 LY_ERR ret;
458 struct lyd_node *child;
Michal Vasko52927e22020-03-16 17:26:14 +0100459
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100460 LY_CHECK_RET(xml_print_opaq_open(pctx, node));
Michal Vasko52927e22020-03-16 17:26:14 +0100461
462 if (node->value[0]) {
463 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100464 if (node->val_prefix_data) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100465 xml_print_ns_prefix_data(pctx, node->format, node->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100466 }
467
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100468 ly_print_(pctx->out, ">");
469 lyxml_dump_text(pctx->out, node->value, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100470 }
471
472 if (node->child) {
473 /* children */
474 if (!node->value[0]) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100475 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100476 }
477
478 LEVEL_INC;
479 LY_LIST_FOR(node->child, child) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100480 ret = xml_print_node(pctx, child);
Michal Vasko52927e22020-03-16 17:26:14 +0100481 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
482 }
483 LEVEL_DEC;
484
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100485 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100486 } else if (node->value[0]) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100487 ly_print_(pctx->out, "</%s>%s", node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100488 } else {
489 /* no value or children */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100490 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100491 }
492
493 return LY_SUCCESS;
494}
495
Radek Krejcie7b95092019-05-15 11:03:07 +0200496/**
497 * @brief Print XML element representing lyd_node.
498 *
499 * @param[in] ctx XML printer context.
500 * @param[in] node Data node to be printed.
501 * @return LY_ERR value.
502 */
503static LY_ERR
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100504xml_print_node(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200505{
506 LY_ERR ret = LY_SUCCESS;
Michal Vasko52927e22020-03-16 17:26:14 +0100507 uint32_t ns_count;
Radek Krejcie7b95092019-05-15 11:03:07 +0200508
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100509 if (!ly_should_print(node, pctx->options)) {
Michal Vasko9b368d32020-02-14 13:53:31 +0100510 /* do not print at all */
Michal Vasko52927e22020-03-16 17:26:14 +0100511 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200512 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200513
Michal Vasko52927e22020-03-16 17:26:14 +0100514 /* remember namespace definition count on this level */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100515 ns_count = pctx->ns.count;
Michal Vasko52927e22020-03-16 17:26:14 +0100516
517 if (!node->schema) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100518 ret = xml_print_opaq(pctx, (const struct lyd_node_opaq *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100519 } else {
520 switch (node->schema->nodetype) {
521 case LYS_CONTAINER:
522 case LYS_LIST:
523 case LYS_NOTIF:
Michal Vasko1bf09392020-03-27 12:38:10 +0100524 case LYS_RPC:
Michal Vasko52927e22020-03-16 17:26:14 +0100525 case LYS_ACTION:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100526 ret = xml_print_inner(pctx, (const struct lyd_node_inner *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100527 break;
528 case LYS_LEAF:
529 case LYS_LEAFLIST:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100530 ret = xml_print_term(pctx, (const struct lyd_node_term *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100531 break;
532 case LYS_ANYXML:
533 case LYS_ANYDATA:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100534 ret = xml_print_anydata(pctx, (const struct lyd_node_any *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100535 break;
536 default:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100537 LOGINT(pctx->ctx);
Michal Vasko52927e22020-03-16 17:26:14 +0100538 ret = LY_EINT;
539 break;
540 }
541 }
542
543 /* remove all added namespaces */
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100544 while (ns_count < pctx->ns.count) {
545 lydict_remove(pctx->ctx, pctx->prefix.objs[pctx->prefix.count - 1]);
546 ly_set_rm_index(&pctx->prefix, pctx->prefix.count - 1, NULL);
547 ly_set_rm_index(&pctx->ns, pctx->ns.count - 1, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200548 }
549
550 return ret;
551}
552
553LY_ERR
Radek Krejci1deb5be2020-08-26 16:43:36 +0200554xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options)
Radek Krejcie7b95092019-05-15 11:03:07 +0200555{
556 const struct lyd_node *node;
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100557 struct xmlpr_ctx pctx = {0};
Radek Krejcie7b95092019-05-15 11:03:07 +0200558
559 if (!root) {
Michal Vasko69730152020-10-09 16:30:07 +0200560 if ((out->type == LY_OUT_MEMORY) || (out->type == LY_OUT_CALLBACK)) {
Michal Vasko5233e962020-08-14 14:26:20 +0200561 ly_print_(out, "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200562 }
563 goto finish;
564 }
565
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100566 pctx.out = out;
567 pctx.level = 0;
568 pctx.options = options;
569 pctx.ctx = LYD_CTX(root);
Michal Vasko52927e22020-03-16 17:26:14 +0100570
Radek Krejcie7b95092019-05-15 11:03:07 +0200571 /* content */
572 LY_LIST_FOR(root, node) {
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100573 LY_CHECK_RET(xml_print_node(&pctx, node));
Radek Krejci7931b192020-06-25 17:05:03 +0200574 if (!(options & LYD_PRINT_WITHSIBLINGS)) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200575 break;
576 }
577 }
578
579finish:
Michal Vaskoc08b9d22022-02-10 15:48:39 +0100580 assert(!pctx.prefix.count && !pctx.ns.count);
581 ly_set_erase(&pctx.prefix, NULL);
582 ly_set_erase(&pctx.ns, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200583 ly_print_flush(out);
584 return LY_SUCCESS;
585}