blob: 744f5be047450fab01f86d405a3cdbf4de95bc15 [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 Vaskoad92b672020-11-12 13:11:31 +0100108xml_print_ns_opaq(struct xmlpr_ctx *ctx, LY_PREFIX_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) {
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100111 case LY_PREF_XML:
Michal Vaskoad92b672020-11-12 13:11:31 +0100112 return xml_print_ns(ctx, name->module_ns, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : name->prefix, prefix_opts);
Radek Krejci1798aae2020-07-14 13:26:06 +0200113 break;
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100114 case LY_PREF_JSON:
Michal Vaskoad92b672020-11-12 13:11:31 +0100115 if (name->module_name) {
116 const struct lys_module *mod = ly_ctx_get_module_latest(ctx->ctx, name->module_name);
Radek Krejci1798aae2020-07-14 13:26:06 +0200117 if (mod) {
Michal Vaskoad92b672020-11-12 13:11:31 +0100118 return xml_print_ns(ctx, 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 */
124 LOGINT(ctx->ctx);
125 }
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.
134 * @param[in] format Value prefix format.
135 * @param[in] prefix_data Format-specific data to print:
136 * LY_PREF_SCHEMA - const struct lysp_module * (module used for resolving prefixes from imports)
137 * LY_PREF_SCHEMA_RESOLVED - struct lyd_value_prefix * (sized array of pairs: prefix - module)
138 * LY_PREF_XML - const struct ly_set * (set with defined namespaces stored as ::lyxml_ns)
139 * LY_PREF_JSON - NULL
140 * @param[in] prefix_opts Prefix options changing the meaning of parameters.
141 * @return LY_ERR value.
142 */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100143static void
144xml_print_ns_prefix_data(struct xmlpr_ctx *ctx, LY_PREFIX_FORMAT format, void *prefix_data, uint32_t prefix_opts)
145{
146 const struct ly_set *set;
147 const struct lyxml_ns *ns;
148 uint32_t i;
149
150 switch (format) {
151 case LY_PREF_XML:
152 set = prefix_data;
153 for (i = 0; i < set->count; ++i) {
154 ns = set->objs[i];
155 xml_print_ns(ctx, ns->uri, (prefix_opts & LYXML_PREFIX_DEFAULT) ? NULL : ns->prefix, prefix_opts);
156 }
157 break;
158 default:
159 /* cannot be created */
160 LOGINT(ctx->ctx);
161 }
162}
163
Radek Krejci28681fa2019-09-06 13:08:45 +0200164/**
Radek Krejcie7b95092019-05-15 11:03:07 +0200165 * TODO
166 */
Michal Vasko52927e22020-03-16 17:26:14 +0100167static void
Michal Vasko9f96a052020-03-10 09:41:45 +0100168xml_print_meta(struct xmlpr_ctx *ctx, const struct lyd_node *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200169{
Michal Vasko9f96a052020-03-10 09:41:45 +0100170 struct lyd_meta *meta;
Michal Vasko52927e22020-03-16 17:26:14 +0100171 const struct lys_module *mod;
172 struct ly_set ns_list = {0};
Michal Vasko69730152020-10-09 16:30:07 +0200173
Radek Krejci28681fa2019-09-06 13:08:45 +0200174#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200175 const char **prefs, **nss;
176 const char *xml_expr = NULL, *mod_name;
177 uint32_t ns_count, i;
Radek Krejci857189e2020-09-01 13:26:36 +0200178 ly_bool rpc_filter = 0;
Radek Krejcie7b95092019-05-15 11:03:07 +0200179 char *p;
180 size_t len;
Radek Krejci28681fa2019-09-06 13:08:45 +0200181#endif
Radek Krejci857189e2020-09-01 13:26:36 +0200182 ly_bool dynamic;
Radek Krejcie7b95092019-05-15 11:03:07 +0200183
Radek Krejcie7b95092019-05-15 11:03:07 +0200184 /* with-defaults */
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100185 if (node->schema->nodetype & LYD_NODE_TERM) {
Radek Krejci7931b192020-06-25 17:05:03 +0200186 if (((node->flags & LYD_DEFAULT) && (ctx->options & (LYD_PRINT_WD_ALL_TAG | LYD_PRINT_WD_IMPL_TAG))) ||
Radek Krejci19611252020-10-04 13:54:53 +0200187 ((ctx->options & LYD_PRINT_WD_ALL_TAG) && lyd_is_default(node))) {
Michal Vasko52927e22020-03-16 17:26:14 +0100188 /* we have implicit OR explicit default node, print attribute only if context include with-defaults schema */
189 mod = ly_ctx_get_module_latest(node->schema->module->ctx, "ietf-netconf-with-defaults");
190 if (mod) {
Michal Vasko5233e962020-08-14 14:26:20 +0200191 ly_print_(ctx->out, " %s:default=\"true\"", xml_print_ns(ctx, mod->ns, mod->prefix, 0));
Radek Krejcie7b95092019-05-15 11:03:07 +0200192 }
193 }
194 }
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100195#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200196 /* technically, check for the extension get-filter-element-attributes from ietf-netconf */
Michal Vasko69730152020-10-09 16:30:07 +0200197 if (!strcmp(node->schema->name, "filter") &&
198 (!strcmp(node->schema->module->name, "ietf-netconf") || !strcmp(node->schema->module->name, "notifications"))) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200199 rpc_filter = 1;
200 }
Radek Krejci28681fa2019-09-06 13:08:45 +0200201#endif
Michal Vasko9f96a052020-03-10 09:41:45 +0100202 for (meta = node->meta; meta; meta = meta->next) {
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200203 const char *value = meta->value.realtype->plugin->print(&meta->value, LY_PREF_XML, &ns_list, &dynamic);
Radek Krejci28681fa2019-09-06 13:08:45 +0200204
Michal Vasko52927e22020-03-16 17:26:14 +0100205 /* print namespaces connected with the value's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200206 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko52927e22020-03-16 17:26:14 +0100207 mod = (const struct lys_module *)ns_list.objs[u];
208 xml_print_ns(ctx, mod->ns, mod->prefix, 1);
Radek Krejci28681fa2019-09-06 13:08:45 +0200209 }
210 ly_set_erase(&ns_list, NULL);
211
212#if 0
Radek Krejcie7b95092019-05-15 11:03:07 +0200213 if (rpc_filter) {
214 /* exception for NETCONF's filter's attributes */
Michal Vasko9f96a052020-03-10 09:41:45 +0100215 if (!strcmp(meta->name, "select")) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200216 /* xpath content, we have to convert the JSON format into XML first */
Michal Vasko9f96a052020-03-10 09:41:45 +0100217 xml_expr = transform_json2xml(node->schema->module, meta->value_str, 0, &prefs, &nss, &ns_count);
Radek Krejcie7b95092019-05-15 11:03:07 +0200218 if (!xml_expr) {
219 /* error */
220 return EXIT_FAILURE;
221 }
222
223 for (i = 0; i < ns_count; ++i) {
Michal Vasko5233e962020-08-14 14:26:20 +0200224 ly_print_(out, " xmlns:%s=\"%s\"", prefs[i], nss[i]);
Radek Krejcie7b95092019-05-15 11:03:07 +0200225 }
226 free(prefs);
227 free(nss);
228 }
Michal Vasko5233e962020-08-14 14:26:20 +0200229 ly_print_(out, " %s=\"", meta->name);
Radek Krejcie7b95092019-05-15 11:03:07 +0200230 } else {
Radek Krejci28681fa2019-09-06 13:08:45 +0200231#endif
Radek Krejci0f969882020-08-21 16:56:47 +0200232 /* print the metadata with its namespace */
233 mod = meta->annotation->module;
234 ly_print_(ctx->out, " %s:%s=\"", xml_print_ns(ctx, mod->ns, mod->prefix, 1), meta->name);
Radek Krejci28681fa2019-09-06 13:08:45 +0200235#if 0
Radek Krejci0f969882020-08-21 16:56:47 +0200236 }
Radek Krejci28681fa2019-09-06 13:08:45 +0200237#endif
Radek Krejcie7b95092019-05-15 11:03:07 +0200238
Michal Vasko52927e22020-03-16 17:26:14 +0100239 /* print metadata value */
Radek Krejci28681fa2019-09-06 13:08:45 +0200240 if (value && value[0]) {
241 lyxml_dump_text(ctx->out, value, 1);
Radek Krejcie7b95092019-05-15 11:03:07 +0200242 }
Michal Vasko5233e962020-08-14 14:26:20 +0200243 ly_print_(ctx->out, "\"");
Radek Krejci28681fa2019-09-06 13:08:45 +0200244 if (dynamic) {
Michal Vasko52927e22020-03-16 17:26:14 +0100245 free((void *)value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200246 }
247 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200248}
249
250/**
251 * @brief Print generic XML element despite of the data node type.
252 *
253 * Prints the element name, attributes and necessary namespaces.
254 *
255 * @param[in] ctx XML printer context.
256 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200257 */
Michal Vasko52927e22020-03-16 17:26:14 +0100258static void
Radek Krejcie7b95092019-05-15 11:03:07 +0200259xml_print_node_open(struct xmlpr_ctx *ctx, const struct lyd_node *node)
260{
Michal Vasko52927e22020-03-16 17:26:14 +0100261 /* print node name */
Michal Vasko5233e962020-08-14 14:26:20 +0200262 ly_print_(ctx->out, "%*s<%s", INDENT, node->schema->name);
Michal Vasko52927e22020-03-16 17:26:14 +0100263
264 /* print default namespace */
265 xml_print_ns(ctx, node->schema->module->ns, NULL, 0);
266
267 /* print metadata */
268 xml_print_meta(ctx, node);
269}
270
271static LY_ERR
272xml_print_attr(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
273{
Radek Krejci5536d282020-08-04 23:27:44 +0200274 const struct lyd_attr *attr;
Michal Vasko52927e22020-03-16 17:26:14 +0100275 const char *pref;
Michal Vasko52927e22020-03-16 17:26:14 +0100276
277 LY_LIST_FOR(node->attr, attr) {
278 pref = NULL;
Michal Vaskoad92b672020-11-12 13:11:31 +0100279 if (attr->name.prefix) {
Michal Vasko52927e22020-03-16 17:26:14 +0100280 /* print attribute namespace */
Michal Vaskoad92b672020-11-12 13:11:31 +0100281 pref = xml_print_ns_opaq(ctx, attr->format, &attr->name, 0);
Michal Vasko52927e22020-03-16 17:26:14 +0100282 }
283
284 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100285 if (attr->val_prefix_data) {
286 xml_print_ns_prefix_data(ctx, attr->format, attr->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100287 }
288
289 /* print the attribute with its prefix and value */
Michal Vaskoad92b672020-11-12 13:11:31 +0100290 ly_print_(ctx->out, " %s%s%s=\"%s\"", pref ? pref : "", pref ? ":" : "", attr->name.name, attr->value);
Radek Krejcie7b95092019-05-15 11:03:07 +0200291 }
292
Michal Vasko52927e22020-03-16 17:26:14 +0100293 return LY_SUCCESS;
294}
295
296static LY_ERR
297xml_print_opaq_open(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
298{
299 /* print node name */
Michal Vaskoad92b672020-11-12 13:11:31 +0100300 ly_print_(ctx->out, "%*s<%s", INDENT, node->name.name);
Michal Vasko52927e22020-03-16 17:26:14 +0100301
302 /* print default namespace */
Michal Vaskoad92b672020-11-12 13:11:31 +0100303 xml_print_ns_opaq(ctx, node->format, &node->name, LYXML_PREFIX_DEFAULT);
Radek Krejcie7b95092019-05-15 11:03:07 +0200304
Michal Vasko52927e22020-03-16 17:26:14 +0100305 /* print attributes */
306 LY_CHECK_RET(xml_print_attr(ctx, node));
Radek Krejcie7b95092019-05-15 11:03:07 +0200307
308 return LY_SUCCESS;
309}
310
311static LY_ERR xml_print_node(struct xmlpr_ctx *ctx, const struct lyd_node *node);
312
313/**
314 * @brief Print XML element representing lyd_node_term.
315 *
316 * @param[in] ctx XML printer context.
317 * @param[in] node Data node to be printed.
Radek Krejcie7b95092019-05-15 11:03:07 +0200318 */
Michal Vasko52927e22020-03-16 17:26:14 +0100319static void
Radek Krejcie7b95092019-05-15 11:03:07 +0200320xml_print_term(struct xmlpr_ctx *ctx, const struct lyd_node_term *node)
321{
Radek Krejcia1911222019-07-22 17:24:50 +0200322 struct ly_set ns_list = {0};
Radek Krejci857189e2020-09-01 13:26:36 +0200323 ly_bool dynamic;
Radek Krejci28681fa2019-09-06 13:08:45 +0200324 const char *value;
325
Michal Vasko52927e22020-03-16 17:26:14 +0100326 xml_print_node_open(ctx, (struct lyd_node *)node);
Michal Vaskoc8a230d2020-08-14 12:17:10 +0200327 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 +0200328
Radek Krejcia1911222019-07-22 17:24:50 +0200329 /* print namespaces connected with the values's prefixes */
Radek Krejci1deb5be2020-08-26 16:43:36 +0200330 for (uint32_t u = 0; u < ns_list.count; ++u) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100331 const struct lys_module *mod = (const struct lys_module *)ns_list.objs[u];
Michal Vasko5233e962020-08-14 14:26:20 +0200332 ly_print_(ctx->out, " xmlns:%s=\"%s\"", mod->prefix, mod->ns);
Radek Krejcie7b95092019-05-15 11:03:07 +0200333 }
Radek Krejcia1911222019-07-22 17:24:50 +0200334 ly_set_erase(&ns_list, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200335
Radek Krejcia1911222019-07-22 17:24:50 +0200336 if (!value || !value[0]) {
Michal Vasko5233e962020-08-14 14:26:20 +0200337 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200338 } else {
Michal Vasko5233e962020-08-14 14:26:20 +0200339 ly_print_(ctx->out, ">");
Radek Krejcia1911222019-07-22 17:24:50 +0200340 lyxml_dump_text(ctx->out, value, 0);
Michal Vasko5233e962020-08-14 14:26:20 +0200341 ly_print_(ctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200342 }
Radek Krejcia1911222019-07-22 17:24:50 +0200343 if (dynamic) {
Michal Vasko6f4cbb62020-02-28 11:15:47 +0100344 free((void *)value);
Radek Krejcia1911222019-07-22 17:24:50 +0200345 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200346}
347
348/**
349 * @brief Print XML element representing lyd_node_inner.
350 *
351 * @param[in] ctx XML printer context.
352 * @param[in] node Data node to be printed.
353 * @return LY_ERR value.
354 */
355static LY_ERR
356xml_print_inner(struct xmlpr_ctx *ctx, const struct lyd_node_inner *node)
357{
358 LY_ERR ret;
359 struct lyd_node *child;
360
Michal Vasko52927e22020-03-16 17:26:14 +0100361 xml_print_node_open(ctx, (struct lyd_node *)node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200362
Michal Vasko630d9892020-12-08 17:11:08 +0100363 LY_LIST_FOR(node->child, child) {
364 if (ly_should_print(child, ctx->options)) {
365 break;
366 }
367 }
368 if (!child) {
369 /* there are no children that will be printed */
Michal Vasko5233e962020-08-14 14:26:20 +0200370 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200371 return LY_SUCCESS;
372 }
373
374 /* children */
Michal Vasko5233e962020-08-14 14:26:20 +0200375 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200376
377 LEVEL_INC;
378 LY_LIST_FOR(node->child, child) {
379 ret = xml_print_node(ctx, child);
380 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
381 }
382 LEVEL_DEC;
383
Michal Vasko5233e962020-08-14 14:26:20 +0200384 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200385
386 return LY_SUCCESS;
387}
388
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200389static LY_ERR
390xml_print_anydata(struct xmlpr_ctx *ctx, const struct lyd_node_any *node)
Radek Krejcie7b95092019-05-15 11:03:07 +0200391{
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200392 struct lyd_node_any *any = (struct lyd_node_any *)node;
Radek Krejcie7b95092019-05-15 11:03:07 +0200393 struct lyd_node *iter;
Radek Krejci1deb5be2020-08-26 16:43:36 +0200394 uint32_t prev_opts, prev_lo;
Michal Vasko52927e22020-03-16 17:26:14 +0100395 LY_ERR ret;
Radek Krejcie7b95092019-05-15 11:03:07 +0200396
Michal Vasko52927e22020-03-16 17:26:14 +0100397 xml_print_node_open(ctx, (struct lyd_node *)node);
Radek Krejcie7b95092019-05-15 11:03:07 +0200398
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200399 if (!any->value.tree) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200400 /* no content */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200401no_content:
Michal Vasko5233e962020-08-14 14:26:20 +0200402 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200403 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200404 } else {
Michal Vasko60ea6352020-06-29 13:39:39 +0200405 if (any->value_type == LYD_ANYDATA_LYB) {
406 /* turn logging off */
407 prev_lo = ly_log_options(0);
408
409 /* try to parse it into a data tree */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200410 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 +0200411 /* successfully parsed */
412 free(any->value.mem);
413 any->value.tree = iter;
414 any->value_type = LYD_ANYDATA_DATATREE;
415 }
Radek Krejci7931b192020-06-25 17:05:03 +0200416
417 /* turn loggin on again */
418 ly_log_options(prev_lo);
Michal Vasko60ea6352020-06-29 13:39:39 +0200419 }
420
Radek Krejcie7b95092019-05-15 11:03:07 +0200421 switch (any->value_type) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200422 case LYD_ANYDATA_DATATREE:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200423 /* close opening tag and print data */
Michal Vasko52927e22020-03-16 17:26:14 +0100424 prev_opts = ctx->options;
Radek Krejci7931b192020-06-25 17:05:03 +0200425 ctx->options &= ~LYD_PRINT_WITHSIBLINGS;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200426 LEVEL_INC;
427
Michal Vasko5233e962020-08-14 14:26:20 +0200428 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200429 LY_LIST_FOR(any->value.tree, iter) {
Michal Vasko52927e22020-03-16 17:26:14 +0100430 ret = xml_print_node(ctx, iter);
431 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
Radek Krejcie7b95092019-05-15 11:03:07 +0200432 }
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200433
434 LEVEL_DEC;
Michal Vasko52927e22020-03-16 17:26:14 +0100435 ctx->options = prev_opts;
Radek Krejcie7b95092019-05-15 11:03:07 +0200436 break;
437 case LYD_ANYDATA_STRING:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200438 /* escape XML-sensitive characters */
439 if (!any->value.str[0]) {
440 goto no_content;
441 }
442 /* close opening tag and print data */
Michal Vasko5233e962020-08-14 14:26:20 +0200443 ly_print_(ctx->out, ">");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200444 lyxml_dump_text(ctx->out, any->value.str, 0);
Radek Krejcie7b95092019-05-15 11:03:07 +0200445 break;
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200446 case LYD_ANYDATA_XML:
447 /* print without escaping special characters */
448 if (!any->value.str[0]) {
449 goto no_content;
450 }
Michal Vasko5233e962020-08-14 14:26:20 +0200451 ly_print_(ctx->out, ">%s", any->value.str);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200452 break;
453 case LYD_ANYDATA_JSON:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200454 case LYD_ANYDATA_LYB:
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200455 /* JSON and LYB format is not supported */
Michal Vaskob7be7a82020-08-20 09:09:04 +0200456 LOGWRN(LYD_CTX(node), "Unable to print anydata content (type %d) as XML.", any->value_type);
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200457 goto no_content;
Radek Krejcie7b95092019-05-15 11:03:07 +0200458 }
459
460 /* closing tag */
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200461 if (any->value_type == LYD_ANYDATA_DATATREE) {
Michal Vasko5233e962020-08-14 14:26:20 +0200462 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200463 } else {
Michal Vasko5233e962020-08-14 14:26:20 +0200464 ly_print_(ctx->out, "</%s>%s", node->schema->name, DO_FORMAT ? "\n" : "");
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200465 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200466 }
467
Radek Krejci26a5dfb2019-07-26 14:51:06 +0200468 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200469}
Radek Krejcie7b95092019-05-15 11:03:07 +0200470
Michal Vasko52927e22020-03-16 17:26:14 +0100471static LY_ERR
472xml_print_opaq(struct xmlpr_ctx *ctx, const struct lyd_node_opaq *node)
473{
474 LY_ERR ret;
475 struct lyd_node *child;
Michal Vasko52927e22020-03-16 17:26:14 +0100476
477 LY_CHECK_RET(xml_print_opaq_open(ctx, node));
478
479 if (node->value[0]) {
480 /* print namespaces connected with the value's prefixes */
Michal Vasko6b5cb2a2020-11-11 19:11:21 +0100481 if (node->val_prefix_data) {
482 xml_print_ns_prefix_data(ctx, node->format, node->val_prefix_data, LYXML_PREFIX_REQUIRED);
Michal Vasko52927e22020-03-16 17:26:14 +0100483 }
484
Michal Vasko5233e962020-08-14 14:26:20 +0200485 ly_print_(ctx->out, ">%s", node->value);
Michal Vasko52927e22020-03-16 17:26:14 +0100486 }
487
488 if (node->child) {
489 /* children */
490 if (!node->value[0]) {
Michal Vasko5233e962020-08-14 14:26:20 +0200491 ly_print_(ctx->out, ">%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100492 }
493
494 LEVEL_INC;
495 LY_LIST_FOR(node->child, child) {
496 ret = xml_print_node(ctx, child);
497 LY_CHECK_ERR_RET(ret, LEVEL_DEC, ret);
498 }
499 LEVEL_DEC;
500
Michal Vaskoad92b672020-11-12 13:11:31 +0100501 ly_print_(ctx->out, "%*s</%s>%s", INDENT, node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100502 } else if (node->value[0]) {
Michal Vaskoad92b672020-11-12 13:11:31 +0100503 ly_print_(ctx->out, "</%s>%s", node->name.name, DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100504 } else {
505 /* no value or children */
Michal Vasko5233e962020-08-14 14:26:20 +0200506 ly_print_(ctx->out, "/>%s", DO_FORMAT ? "\n" : "");
Michal Vasko52927e22020-03-16 17:26:14 +0100507 }
508
509 return LY_SUCCESS;
510}
511
Radek Krejcie7b95092019-05-15 11:03:07 +0200512/**
513 * @brief Print XML element representing lyd_node.
514 *
515 * @param[in] ctx XML printer context.
516 * @param[in] node Data node to be printed.
517 * @return LY_ERR value.
518 */
519static LY_ERR
520xml_print_node(struct xmlpr_ctx *ctx, const struct lyd_node *node)
521{
522 LY_ERR ret = LY_SUCCESS;
Michal Vasko52927e22020-03-16 17:26:14 +0100523 uint32_t ns_count;
Radek Krejcie7b95092019-05-15 11:03:07 +0200524
Michal Vasko9b368d32020-02-14 13:53:31 +0100525 if (!ly_should_print(node, ctx->options)) {
526 /* do not print at all */
Michal Vasko52927e22020-03-16 17:26:14 +0100527 return LY_SUCCESS;
Radek Krejcie7b95092019-05-15 11:03:07 +0200528 }
Radek Krejcie7b95092019-05-15 11:03:07 +0200529
Michal Vasko52927e22020-03-16 17:26:14 +0100530 /* remember namespace definition count on this level */
531 ns_count = ctx->ns.count;
532
533 if (!node->schema) {
534 ret = xml_print_opaq(ctx, (const struct lyd_node_opaq *)node);
535 } else {
536 switch (node->schema->nodetype) {
537 case LYS_CONTAINER:
538 case LYS_LIST:
539 case LYS_NOTIF:
Michal Vasko1bf09392020-03-27 12:38:10 +0100540 case LYS_RPC:
Michal Vasko52927e22020-03-16 17:26:14 +0100541 case LYS_ACTION:
542 ret = xml_print_inner(ctx, (const struct lyd_node_inner *)node);
543 break;
544 case LYS_LEAF:
545 case LYS_LEAFLIST:
546 xml_print_term(ctx, (const struct lyd_node_term *)node);
547 break;
548 case LYS_ANYXML:
549 case LYS_ANYDATA:
550 ret = xml_print_anydata(ctx, (const struct lyd_node_any *)node);
551 break;
552 default:
553 LOGINT(node->schema->module->ctx);
554 ret = LY_EINT;
555 break;
556 }
557 }
558
559 /* remove all added namespaces */
560 while (ns_count < ctx->ns.count) {
561 FREE_STRING(ctx->ctx, ctx->prefix.objs[ctx->prefix.count - 1]);
562 ly_set_rm_index(&ctx->prefix, ctx->prefix.count - 1, NULL);
563 ly_set_rm_index(&ctx->ns, ctx->ns.count - 1, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200564 }
565
566 return ret;
567}
568
569LY_ERR
Radek Krejci1deb5be2020-08-26 16:43:36 +0200570xml_print_data(struct ly_out *out, const struct lyd_node *root, uint32_t options)
Radek Krejcie7b95092019-05-15 11:03:07 +0200571{
572 const struct lyd_node *node;
Michal Vasko52927e22020-03-16 17:26:14 +0100573 struct xmlpr_ctx ctx = {0};
Radek Krejcie7b95092019-05-15 11:03:07 +0200574
575 if (!root) {
Michal Vasko69730152020-10-09 16:30:07 +0200576 if ((out->type == LY_OUT_MEMORY) || (out->type == LY_OUT_CALLBACK)) {
Michal Vasko5233e962020-08-14 14:26:20 +0200577 ly_print_(out, "");
Radek Krejcie7b95092019-05-15 11:03:07 +0200578 }
579 goto finish;
580 }
581
Michal Vasko52927e22020-03-16 17:26:14 +0100582 ctx.out = out;
Radek Krejci17ede7a2020-11-13 10:38:30 +0100583 ctx.level = 0;
Michal Vasko52927e22020-03-16 17:26:14 +0100584 ctx.options = options;
Michal Vaskob7be7a82020-08-20 09:09:04 +0200585 ctx.ctx = LYD_CTX(root);
Michal Vasko52927e22020-03-16 17:26:14 +0100586
Radek Krejcie7b95092019-05-15 11:03:07 +0200587 /* content */
588 LY_LIST_FOR(root, node) {
Michal Vasko52927e22020-03-16 17:26:14 +0100589 LY_CHECK_RET(xml_print_node(&ctx, node));
Radek Krejci7931b192020-06-25 17:05:03 +0200590 if (!(options & LYD_PRINT_WITHSIBLINGS)) {
Radek Krejcie7b95092019-05-15 11:03:07 +0200591 break;
592 }
593 }
594
595finish:
Michal Vasko52927e22020-03-16 17:26:14 +0100596 assert(!ctx.prefix.count && !ctx.ns.count);
597 ly_set_erase(&ctx.prefix, NULL);
598 ly_set_erase(&ctx.ns, NULL);
Radek Krejcie7b95092019-05-15 11:03:07 +0200599 ly_print_flush(out);
600 return LY_SUCCESS;
601}