blob: 7108863f338281df8a25ef97dc76928e29a48842 [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 *
Radek Krejci1deb5be2020-08-26 16:43:36 +020062xml_print_ns(struct xmlpr_ctx *ctx, 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
Radek Krejciba03a5a2020-08-27 14:40:41 +020066 for (i = ctx->ns.count; i > 0; --i) {
Michal Vasko52927e22020-03-16 17:26:14 +010067 if (!new_prefix) {
68 /* find default namespace */
Radek Krejciba03a5a2020-08-27 14:40:41 +020069 if (!ctx->prefix.objs[i - 1]) {
Michal Vasko6b5cb2a2020-11-11 19:11:21 +010070 if (!strcmp(ctx->ns.objs[i - 1], ns)) {
Radek Krejciba03a5a2020-08-27 14:40:41 +020071 /* matching default namespace */
72 return ctx->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 Vasko6b5cb2a2020-11-11 19:11:21 +010079 if (!strcmp(ctx->ns.objs[i - 1], ns)) {
Radek Krejciba03a5a2020-08-27 14:40:41 +020080 if (!ctx->prefix.objs[i - 1]) {
Michal Vasko52927e22020-03-16 17:26:14 +010081 /* default namespace is not interesting */
82 continue;
83 }
84
Radek Krejciba03a5a2020-08-27 14:40:41 +020085 if (!strcmp(ctx->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 */
Radek Krejciba03a5a2020-08-27 14:40:41 +020087 return ctx->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 */
94 ly_print_(ctx->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) {
Radek Krejci011e4aa2020-09-04 15:22:31 +020098 LY_CHECK_RET(lydict_insert(ctx->ctx, new_prefix, 0, &new_prefix), NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +020099 }
Radek Krejci3d92e442020-10-12 12:48:13 +0200100 LY_CHECK_RET(ly_set_add(&ctx->prefix, (void *)new_prefix, 1, NULL), NULL);
101 LY_CHECK_RET(ly_set_add(&ctx->ns, (void *)ns, 1, &i), NULL);
Michal Vasko52927e22020-03-16 17:26:14 +0100102
103 /* return it */
104 return ctx->prefix.objs[i];
Radek Krejci28681fa2019-09-06 13:08:45 +0200105}
106
Michal Vasko22df3f02020-08-24 13:29:22 +0200107static const char *
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100108xml_print_ns_opaq(struct xmlpr_ctx *ctx, LY_PREFIX_FORMAT format, const struct ly_prefix *prefix, uint32_t prefix_opts)
Radek Krejci1798aae2020-07-14 13:26:06 +0200109{
Radek Krejci1798aae2020-07-14 13:26:06 +0200110 switch (format) {
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100111 case LY_PREF_XML:
Radek Krejci1798aae2020-07-14 13:26:06 +0200112 return xml_print_ns(ctx, prefix->module_ns, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : prefix->id, prefix_opts);
113 break;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100114 case LY_PREF_JSON:
Radek Krejci1798aae2020-07-14 13:26:06 +0200115 if (prefix->module_name) {
116 const struct lys_module *mod = ly_ctx_get_module_latest(ctx->ctx, prefix->module_name);
117 if (mod) {
118 return xml_print_ns(ctx, mod->ns, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : prefix->id, prefix_opts);
119 }
120 }
121 break;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100122 default:
Radek Krejci1798aae2020-07-14 13:26:06 +0200123 /* cannot be created */
124 LOGINT(ctx->ctx);
125 }
126
127 return NULL;
128}
129
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100130static void
131xml_print_ns_prefix_data(struct xmlpr_ctx *ctx, LY_PREFIX_FORMAT format, void *prefix_data, uint32_t prefix_opts)
132{
133 const struct ly_set *set;
134 const struct lyxml_ns *ns;
135 uint32_t i;
136
137 switch (format) {
138 case LY_PREF_XML:
139 set = prefix_data;
140 for (i = 0; i < set->count; ++i) {
141 ns = set->objs[i];
142 xml_print_ns(ctx, ns->uri, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : ns->prefix, prefix_opts);
143 }
144 break;
145 default:
146 /* cannot be created */
147 LOGINT(ctx->ctx);
148 }
149}
150
Radek Krejci28681fa2019-09-06 13:08:45 +0200151/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200152 * TODO
153 */
Michal Vasko52927e22020-03-16 17:26:14 +0100154static void
Michal Vasko9f96a052020-03-10 09:41:45 +0100155xml_print_meta(struct xmlpr_ctx *ctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200156{
Michal Vasko9f96a052020-03-10 09:41:45 +0100157 struct lyd_meta *meta;
Michal Vasko52927e22020-03-16 17:26:14 +0100158 const struct lys_module *mod;
159 struct ly_set ns_list = {0};
Michal Vasko69730152020-10-09 16:30:07 +0200160
Radek Krejci28681fa2019-09-06 13:08:45 +0200161#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200162 const char **prefs, **nss;
163 const char *xml_expr = NULL, *mod_name;
164 uint32_t ns_count, i;
Radek Krejci857189e2020-09-01 13:26:36 +0200165 ly_bool rpc_filter = 0;
Radek Krejcie7b95092019-05-15 11:03:07 +0200166 char *p;
167 size_t len;
Radek Krejci28681fa2019-09-06 13:08:45 +0200168#endif
Radek Krejci857189e2020-09-01 13:26:36 +0200169 ly_bool dynamic;
Radek Krejcie7b95092019-05-15 11:03:07 +0200170
Radek Krejcie7b95092019-05-15 11:03:07 +0200171 /* with-defaults */
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100172 if (node->schema->nodetype & LYD_NODE_TERM) {
Radek Krejci7931b192020-06-25 17:05:03 +0200173 if (((node->flags & LYD_DEFAULT) && (ctx->options & (LYD_PRINT_WD_ALL_TAG | LYD_PRINT_WD_IMPL_TAG))) ||
Radek Krejci19611252020-10-04 13:54:53 +0200174 ((ctx->options & LYD_PRINT_WD_ALL_TAG) && lyd_is_default(node))) {
Michal Vasko52927e22020-03-16 17:26:14 +0100175 /* we have implicit OR explicit default node, print attribute only if context include with-defaults schema */
176 mod = ly_ctx_get_module_latest(node->schema->module->ctx, "ietf-netconf-with-defaults");
177 if (mod) {
Michal Vasko5233e962020-08-14 14:26:20 +0200178 ly_print_(ctx->out, " %s:default=\"true\"", xml_print_ns(ctx, mod->ns, mod->prefix, 0));
Radek Krejcie7b95092019-05-15 11:03:07 +0200179 }
180 }
181 }
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100182#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200183 /* technically, check for the extension get-filter-element-attributes from ietf-netconf */
Michal Vasko69730152020-10-09 16:30:07 +0200184 if (!strcmp(node->schema->name, "filter") &&
185 (!strcmp(node->schema->module->name, "ietf-netconf") || !strcmp(node->schema->module->name, "notifications"))) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200186 rpc_filter = 1;
187 }
Radek Krejci28681fa2019-09-06 13:08:45 +0200188#endif
Michal Vasko9f96a052020-03-10 09:41:45 +0100189 for (meta = node->meta; meta; meta = meta->next) {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200190 const char *value = meta->value.realtype->plugin->print(&meta->value, LY_PREF_XML, &ns_list, &dynamic);
Radek Krejci28681fa2019-09-06 13:08:45 +0200191
Michal Vasko52927e22020-03-16 17:26:14 +0100192 /* print namespaces connected with the value's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200193 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko52927e22020-03-16 17:26:14 +0100194 mod = (const struct lys_module *)ns_list.objs[u];
195 xml_print_ns(ctx, mod->ns, mod->prefix, 1);
Radek Krejci28681fa2019-09-06 13:08:45 +0200196 }
197 ly_set_erase(&ns_list, NULL);
198
199#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200200 if (rpc_filter) {
201 /* exception for NETCONF's filter's attributes */
Michal Vasko9f96a052020-03-10 09:41:45 +0100202 if (!strcmp(meta->name, "select")) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200203 /* xpath content, we have to convert the JSON format into XML first */
Michal Vasko9f96a052020-03-10 09:41:45 +0100204 xml_expr = transform_json2xml(node->schema->module, meta->value_str, 0, &prefs, &nss, &ns_count);
Radek Krejcie7b95092019-05-15 11:03:07 +0200205 if (!xml_expr) {
206 /* error */
207 return EXIT_FAILURE;
208 }
209
210 for (i = 0; i < ns_count; ++i) {
Michal Vasko5233e962020-08-14 14:26:20 +0200211 ly_print_(out, " xmlns:%s=\"%s\"", prefs[i], nss[i]);
Radek Krejcie7b95092019-05-15 11:03:07 +0200212 }
213 free(prefs);
214 free(nss);
215 }
Michal Vasko5233e962020-08-14 14:26:20 +0200216 ly_print_(out, " %s=\"", meta->name);
Radek Krejcie7b95092019-05-15 11:03:07 +0200217 } else {
Radek Krejci28681fa2019-09-06 13:08:45 +0200218#endif
Radek Krejci0f969882020-08-21 16:56:47 +0200219 /* print the metadata with its namespace */
220 mod = meta->annotation->module;
221 ly_print_(ctx->out, " %s:%s=\"", xml_print_ns(ctx, mod->ns, mod->prefix, 1), meta->name);
Radek Krejci28681fa2019-09-06 13:08:45 +0200222#if 0
Radek Krejci0f969882020-08-21 16:56:47 +0200223 }
Radek Krejci28681fa2019-09-06 13:08:45 +0200224#endif
Radek Krejcie7b95092019-05-15 11:03:07 +0200225
Michal Vasko52927e22020-03-16 17:26:14 +0100226 /* print metadata value */
Radek Krejci28681fa2019-09-06 13:08:45 +0200227 if (value && value[0]) {
228 lyxml_dump_text(ctx->out, value, 1);
Radek Krejcie7b95092019-05-15 11:03:07 +0200229 }
Michal Vasko5233e962020-08-14 14:26:20 +0200230 ly_print_(ctx->out, "\"");
Radek Krejci28681fa2019-09-06 13:08:45 +0200231 if (dynamic) {
Michal Vasko52927e22020-03-16 17:26:14 +0100232 free((void *)value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200233 }
234 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200235}
236
237/**
238 * @brief Print generic XML element despite of the data node type.
239 *
240 * Prints the element name, attributes and necessary namespaces.
241 *
242 * @param[in] ctx XML printer context.
243 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200244 */
Michal Vasko52927e22020-03-16 17:26:14 +0100245static void
Radek Krejcie7b95092019-05-15 11:03:07 +0200246xml_print_node_open(struct xmlpr_ctx *ctx, const struct lyd_node *node)
247{
Michal Vasko52927e22020-03-16 17:26:14 +0100248 /* print node name */
Michal Vasko5233e962020-08-14 14:26:20 +0200249 ly_print_(ctx->out, "%*s<%s", INDENT, node->schema->name);
Michal Vasko52927e22020-03-16 17:26:14 +0100250
251 /* print default namespace */
252 xml_print_ns(ctx, node->schema->module->ns, NULL, 0);
253
254 /* print metadata */
255 xml_print_meta(ctx, node);
256}
257
258static LY_ERR
259xml_print_attr(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
260{
Radek Krejci5536d282020-08-04 23:27:44 +0200261 const struct lyd_attr *attr;
Michal Vasko52927e22020-03-16 17:26:14 +0100262 const char *pref;
Michal Vasko52927e22020-03-16 17:26:14 +0100263
264 LY_LIST_FOR(node->attr, attr) {
265 pref = NULL;
Radek Krejci1798aae2020-07-14 13:26:06 +0200266 if (attr->prefix.id) {
Michal Vasko52927e22020-03-16 17:26:14 +0100267 /* print attribute namespace */
Radek Krejci1798aae2020-07-14 13:26:06 +0200268 pref = xml_print_ns_opaq(ctx, attr->format, &attr->prefix, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100269 }
270
271 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100272 if (attr->val_prefix_data) {
273 xml_print_ns_prefix_data(ctx, attr->format, attr->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100274 }
275
276 /* print the attribute with its prefix and value */
Michal Vasko5233e962020-08-14 14:26:20 +0200277 ly_print_(ctx->out, " %s%s%s=\"%s\"", pref ? pref : "", pref ? ":" : "", attr->name, attr->value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200278 }
279
Michal Vasko52927e22020-03-16 17:26:14 +0100280 return LY_SUCCESS;
281}
282
283static LY_ERR
284xml_print_opaq_open(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
285{
286 /* print node name */
Michal Vasko5233e962020-08-14 14:26:20 +0200287 ly_print_(ctx->out, "%*s<%s", INDENT, node->name);
Michal Vasko52927e22020-03-16 17:26:14 +0100288
289 /* print default namespace */
Radek Krejci1798aae2020-07-14 13:26:06 +0200290 xml_print_ns_opaq(ctx, node->format, &node->prefix, LYXML_PREFIX_DEFAULT);
Radek Krejcie7b95092019-05-15 11:03:07 +0200291
Michal Vasko52927e22020-03-16 17:26:14 +0100292 /* print attributes */
293 LY_CHECK_RET(xml_print_attr(ctx, node));
Radek Krejcie7b95092019-05-15 11:03:07 +0200294
295 return LY_SUCCESS;
296}
297
298static LY_ERR xml_print_node(struct xmlpr_ctx *ctx, const struct lyd_node *node);
299
300/**
301 * @brief Print XML element representing lyd_node_term.
302 *
303 * @param[in] ctx XML printer context.
304 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200305 */
Michal Vasko52927e22020-03-16 17:26:14 +0100306static void
Radek Krejcie7b95092019-05-15 11:03:07 +0200307xml_print_term(struct xmlpr_ctx *ctx, const struct lyd_node_term *node)
308{
Radek Krejcia1911222019-07-22 17:24:50 +0200309 struct ly_set ns_list = {0};
Radek Krejci857189e2020-09-01 13:26:36 +0200310 ly_bool dynamic;
Radek Krejci28681fa2019-09-06 13:08:45 +0200311 const char *value;
312
Michal Vasko52927e22020-03-16 17:26:14 +0100313 xml_print_node_open(ctx, (struct lyd_node *)node);
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200314 value = ((struct lysc_node_leaf *)node->schema)->type->plugin->print(&node->value, LY_PREF_XML, &ns_list, &dynamic);
Radek Krejcie7b95092019-05-15 11:03:07 +0200315
Radek Krejcia1911222019-07-22 17:24:50 +0200316 /* print namespaces connected with the values's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200317 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100318 const struct lys_module *mod = (const struct lys_module *)ns_list.objs[u];
Michal Vasko5233e962020-08-14 14:26:20 +0200319 ly_print_(ctx->out, " xmlns:%s=\"%s\"", mod->prefix, mod->ns);
Radek Krejcie7b95092019-05-15 11:03:07 +0200320 }
Radek Krejcia1911222019-07-22 17:24:50 +0200321 ly_set_erase(&ns_list, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200322
Radek Krejcia1911222019-07-22 17:24:50 +0200323 if (!value || !value[0]) {
Michal Vasko5233e962020-08-14 14:26:20 +0200324 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200325 } else {
Michal Vasko5233e962020-08-14 14:26:20 +0200326 ly_print_(ctx->out, ">");
Radek Krejcia1911222019-07-22 17:24:50 +0200327 lyxml_dump_text(ctx->out, value, 0);
Michal Vasko5233e962020-08-14 14:26:20 +0200328 ly_print_(ctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200329 }
Radek Krejcia1911222019-07-22 17:24:50 +0200330 if (dynamic) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100331 free((void *)value);
Radek Krejcia1911222019-07-22 17:24:50 +0200332 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200333}
334
335/**
336 * @brief Print XML element representing lyd_node_inner.
337 *
338 * @param[in] ctx XML printer context.
339 * @param[in] node Data node to be printed.
340 * @return LY_ERR value.
341 */
342static LY_ERR
343xml_print_inner(struct xmlpr_ctx *ctx, const struct lyd_node_inner *node)
344{
345 LY_ERR ret;
346 struct lyd_node *child;
347
Michal Vasko52927e22020-03-16 17:26:14 +0100348 xml_print_node_open(ctx, (struct lyd_node *)node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200349
350 if (!node->child) {
Michal Vasko5233e962020-08-14 14:26:20 +0200351 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200352 return LY_SUCCESS;
353 }
354
355 /* children */
Michal Vasko5233e962020-08-14 14:26:20 +0200356 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200357
358 LEVEL_INC;
359 LY_LIST_FOR(node->child, child) {
360 ret = xml_print_node(ctx, child);
361 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
362 }
363 LEVEL_DEC;
364
Michal Vasko5233e962020-08-14 14:26:20 +0200365 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200366
367 return LY_SUCCESS;
368}
369
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200370static LY_ERR
371xml_print_anydata(struct xmlpr_ctx *ctx, const struct lyd_node_any *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200372{
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200373 struct lyd_node_any *any = (struct lyd_node_any *)node;
Radek Krejcie7b95092019-05-15 11:03:07 +0200374 struct lyd_node *iter;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200375 uint32_t prev_opts, prev_lo;
Michal Vasko52927e22020-03-16 17:26:14 +0100376 LY_ERR ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200377
Michal Vasko52927e22020-03-16 17:26:14 +0100378 xml_print_node_open(ctx, (struct lyd_node *)node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200379
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200380 if (!any->value.tree) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200381 /* no content */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200382no_content:
Michal Vasko5233e962020-08-14 14:26:20 +0200383 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200384 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200385 } else {
Michal Vasko60ea6352020-06-29 13:39:39 +0200386 if (any->value_type == LYD_ANYDATA_LYB) {
387 /* turn logging off */
388 prev_lo = ly_log_options(0);
389
390 /* try to parse it into a data tree */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200391 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 +0200392 /* successfully parsed */
393 free(any->value.mem);
394 any->value.tree = iter;
395 any->value_type = LYD_ANYDATA_DATATREE;
396 }
Radek Krejci7931b192020-06-25 17:05:03 +0200397
398 /* turn loggin on again */
399 ly_log_options(prev_lo);
Michal Vasko60ea6352020-06-29 13:39:39 +0200400 }
401
Radek Krejcie7b95092019-05-15 11:03:07 +0200402 switch (any->value_type) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200403 case LYD_ANYDATA_DATATREE:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200404 /* close opening tag and print data */
Michal Vasko52927e22020-03-16 17:26:14 +0100405 prev_opts = ctx->options;
Radek Krejci7931b192020-06-25 17:05:03 +0200406 ctx->options &= ~LYD_PRINT_WITHSIBLINGS;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200407 LEVEL_INC;
408
Michal Vasko5233e962020-08-14 14:26:20 +0200409 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200410 LY_LIST_FOR(any->value.tree, iter) {
Michal Vasko52927e22020-03-16 17:26:14 +0100411 ret = xml_print_node(ctx, iter);
412 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
Radek Krejcie7b95092019-05-15 11:03:07 +0200413 }
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200414
415 LEVEL_DEC;
Michal Vasko52927e22020-03-16 17:26:14 +0100416 ctx->options = prev_opts;
Radek Krejcie7b95092019-05-15 11:03:07 +0200417 break;
418 case LYD_ANYDATA_STRING:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200419 /* escape XML-sensitive characters */
420 if (!any->value.str[0]) {
421 goto no_content;
422 }
423 /* close opening tag and print data */
Michal Vasko5233e962020-08-14 14:26:20 +0200424 ly_print_(ctx->out, ">");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200425 lyxml_dump_text(ctx->out, any->value.str, 0);
Radek Krejcie7b95092019-05-15 11:03:07 +0200426 break;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200427 case LYD_ANYDATA_XML:
428 /* print without escaping special characters */
429 if (!any->value.str[0]) {
430 goto no_content;
431 }
Michal Vasko5233e962020-08-14 14:26:20 +0200432 ly_print_(ctx->out, ">%s", any->value.str);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200433 break;
434 case LYD_ANYDATA_JSON:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200435 case LYD_ANYDATA_LYB:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200436 /* JSON and LYB format is not supported */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200437 LOGWRN(LYD_CTX(node), "Unable to print anydata content (type %d) as XML.", any->value_type);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200438 goto no_content;
Radek Krejcie7b95092019-05-15 11:03:07 +0200439 }
440
441 /* closing tag */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200442 if (any->value_type == LYD_ANYDATA_DATATREE) {
Michal Vasko5233e962020-08-14 14:26:20 +0200443 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200444 } else {
Michal Vasko5233e962020-08-14 14:26:20 +0200445 ly_print_(ctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200446 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200447 }
448
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200449 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200450}
Radek Krejcie7b95092019-05-15 11:03:07 +0200451
Michal Vasko52927e22020-03-16 17:26:14 +0100452static LY_ERR
453xml_print_opaq(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
454{
455 LY_ERR ret;
456 struct lyd_node *child;
Michal Vasko52927e22020-03-16 17:26:14 +0100457
458 LY_CHECK_RET(xml_print_opaq_open(ctx, node));
459
460 if (node->value[0]) {
461 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100462 if (node->val_prefix_data) {
463 xml_print_ns_prefix_data(ctx, node->format, node->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100464 }
465
Michal Vasko5233e962020-08-14 14:26:20 +0200466 ly_print_(ctx->out, ">%s", node->value);
Michal Vasko52927e22020-03-16 17:26:14 +0100467 }
468
469 if (node->child) {
470 /* children */
471 if (!node->value[0]) {
Michal Vasko5233e962020-08-14 14:26:20 +0200472 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100473 }
474
475 LEVEL_INC;
476 LY_LIST_FOR(node->child, child) {
477 ret = xml_print_node(ctx, child);
478 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
479 }
480 LEVEL_DEC;
481
Michal Vasko5233e962020-08-14 14:26:20 +0200482 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100483 } else if (node->value[0]) {
Michal Vasko5233e962020-08-14 14:26:20 +0200484 ly_print_(ctx->out, "</%s>%s", node->name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100485 } else {
486 /* no value or children */
Michal Vasko5233e962020-08-14 14:26:20 +0200487 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100488 }
489
490 return LY_SUCCESS;
491}
492
Radek Krejcie7b95092019-05-15 11:03:07 +0200493/**
494 * @brief Print XML element representing lyd_node.
495 *
496 * @param[in] ctx XML printer context.
497 * @param[in] node Data node to be printed.
498 * @return LY_ERR value.
499 */
500static LY_ERR
501xml_print_node(struct xmlpr_ctx *ctx, const struct lyd_node *node)
502{
503 LY_ERR ret = LY_SUCCESS;
Michal Vasko52927e22020-03-16 17:26:14 +0100504 uint32_t ns_count;
Radek Krejcie7b95092019-05-15 11:03:07 +0200505
Michal Vasko9b368d32020-02-14 13:53:31 +0100506 if (!ly_should_print(node, ctx->options)) {
507 /* do not print at all */
Michal Vasko52927e22020-03-16 17:26:14 +0100508 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200509 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200510
Michal Vasko52927e22020-03-16 17:26:14 +0100511 /* remember namespace definition count on this level */
512 ns_count = ctx->ns.count;
513
514 if (!node->schema) {
515 ret = xml_print_opaq(ctx, (const struct lyd_node_opaq *)node);
516 } else {
517 switch (node->schema->nodetype) {
518 case LYS_CONTAINER:
519 case LYS_LIST:
520 case LYS_NOTIF:
Michal Vasko1bf09392020-03-27 12:38:10 +0100521 case LYS_RPC:
Michal Vasko52927e22020-03-16 17:26:14 +0100522 case LYS_ACTION:
523 ret = xml_print_inner(ctx, (const struct lyd_node_inner *)node);
524 break;
525 case LYS_LEAF:
526 case LYS_LEAFLIST:
527 xml_print_term(ctx, (const struct lyd_node_term *)node);
528 break;
529 case LYS_ANYXML:
530 case LYS_ANYDATA:
531 ret = xml_print_anydata(ctx, (const struct lyd_node_any *)node);
532 break;
533 default:
534 LOGINT(node->schema->module->ctx);
535 ret = LY_EINT;
536 break;
537 }
538 }
539
540 /* remove all added namespaces */
541 while (ns_count < ctx->ns.count) {
542 FREE_STRING(ctx->ctx, ctx->prefix.objs[ctx->prefix.count - 1]);
543 ly_set_rm_index(&ctx->prefix, ctx->prefix.count - 1, NULL);
544 ly_set_rm_index(&ctx->ns, ctx->ns.count - 1, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200545 }
546
547 return ret;
548}
549
550LY_ERR
Radek Krejci1deb5be2020-08-26 16:43:36 +0200551xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options)
Radek Krejcie7b95092019-05-15 11:03:07 +0200552{
553 const struct lyd_node *node;
Michal Vasko52927e22020-03-16 17:26:14 +0100554 struct xmlpr_ctx ctx = {0};
Radek Krejcie7b95092019-05-15 11:03:07 +0200555
556 if (!root) {
Michal Vasko69730152020-10-09 16:30:07 +0200557 if ((out->type == LY_OUT_MEMORY) || (out->type == LY_OUT_CALLBACK)) {
Michal Vasko5233e962020-08-14 14:26:20 +0200558 ly_print_(out, "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200559 }
560 goto finish;
561 }
562
Michal Vasko52927e22020-03-16 17:26:14 +0100563 ctx.out = out;
Radek Krejci52f65552020-09-01 17:03:35 +0200564 ctx.level = (options & LYD_PRINT_SHRINK ? 0 : 1);
Michal Vasko52927e22020-03-16 17:26:14 +0100565 ctx.options = options;
Michal Vaskob7be7a82020-08-20 09:09:04 +0200566 ctx.ctx = LYD_CTX(root);
Michal Vasko52927e22020-03-16 17:26:14 +0100567
Radek Krejcie7b95092019-05-15 11:03:07 +0200568 /* content */
569 LY_LIST_FOR(root, node) {
Michal Vasko52927e22020-03-16 17:26:14 +0100570 LY_CHECK_RET(xml_print_node(&ctx, node));
Radek Krejci7931b192020-06-25 17:05:03 +0200571 if (!(options & LYD_PRINT_WITHSIBLINGS)) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200572 break;
573 }
574 }
575
576finish:
Michal Vasko52927e22020-03-16 17:26:14 +0100577 assert(!ctx.prefix.count && !ctx.ns.count);
578 ly_set_erase(&ctx.prefix, NULL);
579 ly_set_erase(&ctx.ns, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200580 ly_print_flush(out);
581 return LY_SUCCESS;
582}