blob: 63c8259759c1d8d4f82e12acd67090d043a5d308 [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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko61ad1ff2022-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 Vasko294e7f02022-02-28 13:59:00 +0100151 if (!ns->prefix) {
152 /* default namespace is not for the element */
153 continue;
154 }
155
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100156 xml_print_ns(pctx, ns->uri, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : ns->prefix, prefix_opts);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100157 }
158 break;
159 default:
160 /* cannot be created */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100161 LOGINT(pctx->ctx);
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100162 }
163}
164
Radek Krejci28681fa2019-09-06 13:08:45 +0200165/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200166 * TODO
167 */
Michal Vasko52927e22020-03-16 17:26:14 +0100168static void
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100169xml_print_meta(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200170{
Michal Vasko9f96a052020-03-10 09:41:45 +0100171 struct lyd_meta *meta;
Michal Vasko52927e22020-03-16 17:26:14 +0100172 const struct lys_module *mod;
173 struct ly_set ns_list = {0};
Michal Vasko45791ad2021-06-17 08:45:03 +0200174 LY_ARRAY_COUNT_TYPE u;
175 ly_bool dynamic, filter_attrs = 0;
Radek Krejcie7b95092019-05-15 11:03:07 +0200176
Radek Krejcie7b95092019-05-15 11:03:07 +0200177 /* with-defaults */
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100178 if (node->schema->nodetype & LYD_NODE_TERM) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100179 if (((node->flags & LYD_DEFAULT) && (pctx->options & (LYD_PRINT_WD_ALL_TAG | LYD_PRINT_WD_IMPL_TAG))) ||
180 ((pctx->options & LYD_PRINT_WD_ALL_TAG) && lyd_is_default(node))) {
Michal Vasko52927e22020-03-16 17:26:14 +0100181 /* we have implicit OR explicit default node, print attribute only if context include with-defaults schema */
Radek Krejcic2b49d82021-04-26 08:05:57 +0200182 mod = ly_ctx_get_module_latest(LYD_CTX(node), "ietf-netconf-with-defaults");
Michal Vasko52927e22020-03-16 17:26:14 +0100183 if (mod) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100184 ly_print_(pctx->out, " %s:default=\"true\"", xml_print_ns(pctx, mod->ns, mod->prefix, 0));
Radek Krejcie7b95092019-05-15 11:03:07 +0200185 }
186 }
187 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200188
189 /* check for NETCONF filter unqualified attributes */
190 LY_ARRAY_FOR(node->schema->exts, u) {
191 if (!strcmp(node->schema->exts[u].def->name, "get-filter-element-attributes") &&
192 !strcmp(node->schema->exts[u].def->module->name, "ietf-netconf")) {
193 filter_attrs = 1;
194 break;
195 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200196 }
Michal Vasko45791ad2021-06-17 08:45:03 +0200197
Michal Vasko9f96a052020-03-10 09:41:45 +0100198 for (meta = node->meta; meta; meta = meta->next) {
Radek Krejci224d4b42021-04-23 13:54:59 +0200199 const char *value = meta->value.realtype->plugin->print(LYD_CTX(node), &meta->value, LY_VALUE_XML, &ns_list,
200 &dynamic, NULL);
Radek Krejci28681fa2019-09-06 13:08:45 +0200201
Michal Vasko52927e22020-03-16 17:26:14 +0100202 /* print namespaces connected with the value's prefixes */
Michal Vasko45791ad2021-06-17 08:45:03 +0200203 for (uint32_t i = 0; i < ns_list.count; ++i) {
204 mod = ns_list.objs[i];
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100205 xml_print_ns(pctx, mod->ns, mod->prefix, 1);
Radek Krejci28681fa2019-09-06 13:08:45 +0200206 }
207 ly_set_erase(&ns_list, NULL);
208
Radek Krejci0f969882020-08-21 16:56:47 +0200209 mod = meta->annotation->module;
Michal Vasko45791ad2021-06-17 08:45:03 +0200210 if (filter_attrs && !strcmp(mod->name, "ietf-netconf") && (!strcmp(meta->name, "type") ||
211 !strcmp(meta->name, "select"))) {
212 /* print special NETCONF filter unqualified attributes */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100213 ly_print_(pctx->out, " %s=\"", meta->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200214 } else {
215 /* print the metadata with its namespace */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100216 ly_print_(pctx->out, " %s:%s=\"", xml_print_ns(pctx, mod->ns, mod->prefix, 1), meta->name);
Michal Vasko45791ad2021-06-17 08:45:03 +0200217 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200218
Michal Vasko52927e22020-03-16 17:26:14 +0100219 /* print metadata value */
Radek Krejci28681fa2019-09-06 13:08:45 +0200220 if (value && value[0]) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100221 lyxml_dump_text(pctx->out, value, 1);
Radek Krejcie7b95092019-05-15 11:03:07 +0200222 }
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100223 ly_print_(pctx->out, "\"");
Radek Krejci28681fa2019-09-06 13:08:45 +0200224 if (dynamic) {
Michal Vasko52927e22020-03-16 17:26:14 +0100225 free((void *)value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200226 }
227 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200228}
229
230/**
231 * @brief Print generic XML element despite of the data node type.
232 *
233 * Prints the element name, attributes and necessary namespaces.
234 *
235 * @param[in] ctx XML printer context.
236 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200237 */
Michal Vasko52927e22020-03-16 17:26:14 +0100238static void
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100239xml_print_node_open(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200240{
Michal Vasko52927e22020-03-16 17:26:14 +0100241 /* print node name */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100242 ly_print_(pctx->out, "%*s<%s", INDENT, node->schema->name);
Michal Vasko52927e22020-03-16 17:26:14 +0100243
244 /* print default namespace */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100245 xml_print_ns(pctx, node->schema->module->ns, NULL, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100246
247 /* print metadata */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100248 xml_print_meta(pctx, node);
Michal Vasko52927e22020-03-16 17:26:14 +0100249}
250
251static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100252xml_print_attr(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100253{
Radek Krejci5536d282020-08-04 23:27:44 +0200254 const struct lyd_attr *attr;
Michal Vasko52927e22020-03-16 17:26:14 +0100255 const char *pref;
Michal Vasko52927e22020-03-16 17:26:14 +0100256
257 LY_LIST_FOR(node->attr, attr) {
258 pref = NULL;
Michal Vaskoad92b672020-11-12 13:11:31 +0100259 if (attr->name.prefix) {
Michal Vasko52927e22020-03-16 17:26:14 +0100260 /* print attribute namespace */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100261 pref = xml_print_ns_opaq(pctx, attr->format, &attr->name, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100262 }
263
264 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100265 if (attr->val_prefix_data) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100266 xml_print_ns_prefix_data(pctx, attr->format, attr->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100267 }
268
269 /* print the attribute with its prefix and value */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100270 ly_print_(pctx->out, " %s%s%s=\"", pref ? pref : "", pref ? ":" : "", attr->name.name);
271 lyxml_dump_text(pctx->out, attr->value, 1);
272 ly_print_(pctx->out, "\""); /* print attribute value terminator */
Radek IÅ¡a52c4ac62021-03-08 09:37:32 +0100273
Radek Krejcie7b95092019-05-15 11:03:07 +0200274 }
275
Michal Vasko52927e22020-03-16 17:26:14 +0100276 return LY_SUCCESS;
277}
278
279static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100280xml_print_opaq_open(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100281{
282 /* print node name */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100283 ly_print_(pctx->out, "%*s<%s", INDENT, node->name.name);
Michal Vasko52927e22020-03-16 17:26:14 +0100284
285 /* print default namespace */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100286 xml_print_ns_opaq(pctx, node->format, &node->name, LYXML_PREFIX_DEFAULT);
Radek Krejcie7b95092019-05-15 11:03:07 +0200287
Michal Vasko52927e22020-03-16 17:26:14 +0100288 /* print attributes */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100289 LY_CHECK_RET(xml_print_attr(pctx, node));
Radek Krejcie7b95092019-05-15 11:03:07 +0200290
291 return LY_SUCCESS;
292}
293
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100294static LY_ERR xml_print_node(struct xmlpr_ctx *pctx, const struct lyd_node *node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200295
296/**
297 * @brief Print XML element representing lyd_node_term.
298 *
299 * @param[in] ctx XML printer context.
300 * @param[in] node Data node to be printed.
Michal Vasko569f2f42021-08-04 11:31:08 +0200301 * @return LY_ERR value.
Radek Krejcie7b95092019-05-15 11:03:07 +0200302 */
Michal Vasko569f2f42021-08-04 11:31:08 +0200303static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100304xml_print_term(struct xmlpr_ctx *pctx, const struct lyd_node_term *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200305{
Radek Krejcia1911222019-07-22 17:24:50 +0200306 struct ly_set ns_list = {0};
Radek Krejci857189e2020-09-01 13:26:36 +0200307 ly_bool dynamic;
Radek Krejci28681fa2019-09-06 13:08:45 +0200308 const char *value;
309
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100310 xml_print_node_open(pctx, &node->node);
Radek Krejci224d4b42021-04-23 13:54:59 +0200311 value = ((struct lysc_node_leaf *)node->schema)->type->plugin->print(LYD_CTX(node), &node->value, LY_VALUE_XML,
312 &ns_list, &dynamic, NULL);
Michal Vasko569f2f42021-08-04 11:31:08 +0200313 LY_CHECK_RET(!value, LY_EINVAL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200314
Radek Krejcia1911222019-07-22 17:24:50 +0200315 /* print namespaces connected with the values's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200316 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100317 const struct lys_module *mod = (const struct lys_module *)ns_list.objs[u];
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100318 ly_print_(pctx->out, " xmlns:%s=\"%s\"", mod->prefix, mod->ns);
Radek Krejcie7b95092019-05-15 11:03:07 +0200319 }
Radek Krejcia1911222019-07-22 17:24:50 +0200320 ly_set_erase(&ns_list, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200321
Michal Vasko569f2f42021-08-04 11:31:08 +0200322 if (!value[0]) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100323 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200324 } else {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100325 ly_print_(pctx->out, ">");
326 lyxml_dump_text(pctx->out, value, 0);
327 ly_print_(pctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200328 }
Radek Krejcia1911222019-07-22 17:24:50 +0200329 if (dynamic) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100330 free((void *)value);
Radek Krejcia1911222019-07-22 17:24:50 +0200331 }
Michal Vasko569f2f42021-08-04 11:31:08 +0200332
333 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200334}
335
336/**
337 * @brief Print XML element representing lyd_node_inner.
338 *
339 * @param[in] ctx XML printer context.
340 * @param[in] node Data node to be printed.
341 * @return LY_ERR value.
342 */
343static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100344xml_print_inner(struct xmlpr_ctx *pctx, const struct lyd_node_inner *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200345{
346 LY_ERR ret;
347 struct lyd_node *child;
348
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100349 xml_print_node_open(pctx, &node->node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200350
Michal Vasko630d9892020-12-08 17:11:08 +0100351 LY_LIST_FOR(node->child, child) {
Michal Vasko8db584d2022-03-30 13:42:48 +0200352 if (lyd_node_should_print(child, pctx->options)) {
Michal Vasko630d9892020-12-08 17:11:08 +0100353 break;
354 }
355 }
356 if (!child) {
357 /* there are no children that will be printed */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100358 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200359 return LY_SUCCESS;
360 }
361
362 /* children */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100363 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200364
365 LEVEL_INC;
366 LY_LIST_FOR(node->child, child) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100367 ret = xml_print_node(pctx, child);
Radek Krejcie7b95092019-05-15 11:03:07 +0200368 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
369 }
370 LEVEL_DEC;
371
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100372 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200373
374 return LY_SUCCESS;
375}
376
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200377static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100378xml_print_anydata(struct xmlpr_ctx *pctx, const struct lyd_node_any *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200379{
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200380 struct lyd_node_any *any = (struct lyd_node_any *)node;
Radek Krejcie7b95092019-05-15 11:03:07 +0200381 struct lyd_node *iter;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200382 uint32_t prev_opts, prev_lo;
Michal Vasko52927e22020-03-16 17:26:14 +0100383 LY_ERR ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200384
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100385 xml_print_node_open(pctx, &node->node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200386
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200387 if (!any->value.tree) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200388 /* no content */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200389no_content:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100390 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200391 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200392 } else {
Michal Vasko60ea6352020-06-29 13:39:39 +0200393 if (any->value_type == LYD_ANYDATA_LYB) {
394 /* turn logging off */
395 prev_lo = ly_log_options(0);
396
397 /* try to parse it into a data tree */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200398 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 +0200399 /* successfully parsed */
400 free(any->value.mem);
401 any->value.tree = iter;
402 any->value_type = LYD_ANYDATA_DATATREE;
403 }
Radek Krejci7931b192020-06-25 17:05:03 +0200404
405 /* turn loggin on again */
406 ly_log_options(prev_lo);
Michal Vasko60ea6352020-06-29 13:39:39 +0200407 }
408
Radek Krejcie7b95092019-05-15 11:03:07 +0200409 switch (any->value_type) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200410 case LYD_ANYDATA_DATATREE:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200411 /* close opening tag and print data */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100412 prev_opts = pctx->options;
413 pctx->options &= ~LYD_PRINT_WITHSIBLINGS;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200414 LEVEL_INC;
415
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100416 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200417 LY_LIST_FOR(any->value.tree, iter) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100418 ret = xml_print_node(pctx, iter);
Michal Vasko52927e22020-03-16 17:26:14 +0100419 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
Radek Krejcie7b95092019-05-15 11:03:07 +0200420 }
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200421
422 LEVEL_DEC;
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100423 pctx->options = prev_opts;
Radek Krejcie7b95092019-05-15 11:03:07 +0200424 break;
425 case LYD_ANYDATA_STRING:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200426 /* escape XML-sensitive characters */
427 if (!any->value.str[0]) {
428 goto no_content;
429 }
430 /* close opening tag and print data */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100431 ly_print_(pctx->out, ">");
432 lyxml_dump_text(pctx->out, any->value.str, 0);
Radek Krejcie7b95092019-05-15 11:03:07 +0200433 break;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200434 case LYD_ANYDATA_XML:
435 /* print without escaping special characters */
436 if (!any->value.str[0]) {
437 goto no_content;
438 }
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100439 ly_print_(pctx->out, ">%s", any->value.str);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200440 break;
441 case LYD_ANYDATA_JSON:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200442 case LYD_ANYDATA_LYB:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200443 /* JSON and LYB format is not supported */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100444 LOGWRN(pctx->ctx, "Unable to print anydata content (type %d) as XML.", any->value_type);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200445 goto no_content;
Radek Krejcie7b95092019-05-15 11:03:07 +0200446 }
447
448 /* closing tag */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200449 if (any->value_type == LYD_ANYDATA_DATATREE) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100450 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200451 } else {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100452 ly_print_(pctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200453 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200454 }
455
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200456 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200457}
Radek Krejcie7b95092019-05-15 11:03:07 +0200458
Michal Vasko52927e22020-03-16 17:26:14 +0100459static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100460xml_print_opaq(struct xmlpr_ctx *pctx, const struct lyd_node_opaq *node)
Michal Vasko52927e22020-03-16 17:26:14 +0100461{
462 LY_ERR ret;
463 struct lyd_node *child;
Michal Vasko52927e22020-03-16 17:26:14 +0100464
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100465 LY_CHECK_RET(xml_print_opaq_open(pctx, node));
Michal Vasko52927e22020-03-16 17:26:14 +0100466
467 if (node->value[0]) {
468 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100469 if (node->val_prefix_data) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100470 xml_print_ns_prefix_data(pctx, node->format, node->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100471 }
472
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100473 ly_print_(pctx->out, ">");
474 lyxml_dump_text(pctx->out, node->value, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100475 }
476
477 if (node->child) {
478 /* children */
479 if (!node->value[0]) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100480 ly_print_(pctx->out, ">%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100481 }
482
483 LEVEL_INC;
484 LY_LIST_FOR(node->child, child) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100485 ret = xml_print_node(pctx, child);
Michal Vasko52927e22020-03-16 17:26:14 +0100486 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
487 }
488 LEVEL_DEC;
489
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100490 ly_print_(pctx->out, "%*s</%s>%s", INDENT, node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100491 } else if (node->value[0]) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100492 ly_print_(pctx->out, "</%s>%s", node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100493 } else {
494 /* no value or children */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100495 ly_print_(pctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100496 }
497
498 return LY_SUCCESS;
499}
500
Radek Krejcie7b95092019-05-15 11:03:07 +0200501/**
502 * @brief Print XML element representing lyd_node.
503 *
504 * @param[in] ctx XML printer context.
505 * @param[in] node Data node to be printed.
506 * @return LY_ERR value.
507 */
508static LY_ERR
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100509xml_print_node(struct xmlpr_ctx *pctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200510{
511 LY_ERR ret = LY_SUCCESS;
Michal Vasko52927e22020-03-16 17:26:14 +0100512 uint32_t ns_count;
Radek Krejcie7b95092019-05-15 11:03:07 +0200513
Michal Vasko8db584d2022-03-30 13:42:48 +0200514 if (!lyd_node_should_print(node, pctx->options)) {
Michal Vasko9b368d32020-02-14 13:53:31 +0100515 /* do not print at all */
Michal Vasko52927e22020-03-16 17:26:14 +0100516 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200517 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200518
Michal Vasko52927e22020-03-16 17:26:14 +0100519 /* remember namespace definition count on this level */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100520 ns_count = pctx->ns.count;
Michal Vasko52927e22020-03-16 17:26:14 +0100521
522 if (!node->schema) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100523 ret = xml_print_opaq(pctx, (const struct lyd_node_opaq *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100524 } else {
525 switch (node->schema->nodetype) {
526 case LYS_CONTAINER:
527 case LYS_LIST:
528 case LYS_NOTIF:
Michal Vasko1bf09392020-03-27 12:38:10 +0100529 case LYS_RPC:
Michal Vasko52927e22020-03-16 17:26:14 +0100530 case LYS_ACTION:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100531 ret = xml_print_inner(pctx, (const struct lyd_node_inner *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100532 break;
533 case LYS_LEAF:
534 case LYS_LEAFLIST:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100535 ret = xml_print_term(pctx, (const struct lyd_node_term *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100536 break;
537 case LYS_ANYXML:
538 case LYS_ANYDATA:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100539 ret = xml_print_anydata(pctx, (const struct lyd_node_any *)node);
Michal Vasko52927e22020-03-16 17:26:14 +0100540 break;
541 default:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100542 LOGINT(pctx->ctx);
Michal Vasko52927e22020-03-16 17:26:14 +0100543 ret = LY_EINT;
544 break;
545 }
546 }
547
548 /* remove all added namespaces */
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100549 while (ns_count < pctx->ns.count) {
550 lydict_remove(pctx->ctx, pctx->prefix.objs[pctx->prefix.count - 1]);
551 ly_set_rm_index(&pctx->prefix, pctx->prefix.count - 1, NULL);
552 ly_set_rm_index(&pctx->ns, pctx->ns.count - 1, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200553 }
554
555 return ret;
556}
557
558LY_ERR
Radek Krejci1deb5be2020-08-26 16:43:36 +0200559xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options)
Radek Krejcie7b95092019-05-15 11:03:07 +0200560{
561 const struct lyd_node *node;
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100562 struct xmlpr_ctx pctx = {0};
Radek Krejcie7b95092019-05-15 11:03:07 +0200563
564 if (!root) {
Michal Vasko69730152020-10-09 16:30:07 +0200565 if ((out->type == LY_OUT_MEMORY) || (out->type == LY_OUT_CALLBACK)) {
Michal Vasko5233e962020-08-14 14:26:20 +0200566 ly_print_(out, "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200567 }
568 goto finish;
569 }
570
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100571 pctx.out = out;
572 pctx.level = 0;
573 pctx.options = options;
574 pctx.ctx = LYD_CTX(root);
Michal Vasko52927e22020-03-16 17:26:14 +0100575
Radek Krejcie7b95092019-05-15 11:03:07 +0200576 /* content */
577 LY_LIST_FOR(root, node) {
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100578 LY_CHECK_RET(xml_print_node(&pctx, node));
Radek Krejci7931b192020-06-25 17:05:03 +0200579 if (!(options & LYD_PRINT_WITHSIBLINGS)) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200580 break;
581 }
582 }
583
584finish:
Michal Vasko61ad1ff2022-02-10 15:48:39 +0100585 assert(!pctx.prefix.count && !pctx.ns.count);
586 ly_set_erase(&pctx.prefix, NULL);
587 ly_set_erase(&pctx.ns, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200588 ly_print_flush(out);
589 return LY_SUCCESS;
590}