schema parsers BUGFIX convert default identityref/instance-identifier value into JSON format

rkrejci · rkrejci · commit bd117f064ffa · 2016-11-04T16:32:43.000+01:00
default identityref and instance-identifier values defined in schemas uses
imported modules as prefixes, but libyang internally uses JSON format with
module names used as node's prefixes, so we have to convert the values on
parsing and be prepared to convert values back when printing schema.
diff --git a/src/parser.c b/src/parser.c
@@ -1007,7 +1007,7 @@ make_canonical(struct ly_ctx *ctx, int type, const char **value, void *data1, vo
 /*
  * xml  - optional for converting instance-identifier and identityref into JSON format
  * tree - optional for resolving instance-identifiers and leafrefs
- * leaf - optional for storing parsed data
+ * leaf - optional for storing parsed data, mandatory in case of dflt
  */
 struct lys_type *
 lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *xml, struct lyd_node *tree,
@@ -1021,6 +1021,8 @@ lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *x
     struct lys_type_bit **bits = NULL;
     struct lys_ident *ident;
 
+    assert(leaf || !dflt);
+
     if (leaf) {
         leaf->value_type = type->base;
     }
@@ -1263,6 +1265,28 @@ lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *x
                 }
                 goto cleanup;
             }
+        } else if (dflt) {
+            /* turn logging off */
+            hidden = *ly_vlog_hide_location();
+            ly_vlog_hide(1);
+
+            /* the value actually uses module's prefixes instead of the module names as in JSON format,
+             * we have to convert it */
+            value = transform_schema2json(leaf->schema->module, value);
+            if (!value) {
+                /* invalid identityref format or it was already transformed, so ignore the error here */
+                value = *value_;
+                /* erase error information */
+                ly_err_clean(1);
+            } else if (value == *value_) {
+                /* we have actually created the same expression (prefixes are the same as the module names)
+                 * so we have just increased dictionary's refcount - fix it */
+                lydict_remove(type->parent->module->ctx, value);
+            }
+            /* turn logging back on */
+            if (!hidden) {
+                ly_vlog_hide(0);
+            }
         }
 
         ident = resolve_identref(type, value, (struct lyd_node*)leaf);
@@ -1273,10 +1297,15 @@ lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *x
             leaf->value.ident = ident;
         }
 
-        if (xml) {
+        if (value != *value_) {
             /* update the changed value */
             lydict_remove(type->parent->module->ctx, *value_);
             *value_ = value;
+
+            /* we have to remember the conversion into JSON format to be able to print it in correct form */
+            if (dflt) {
+                type->parent->flags |= LYS_DFLTJSON;
+            }
         }
         break;
 
@@ -1302,6 +1331,28 @@ lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *x
                 }
                 goto cleanup;
             }
+        } else if (dflt) {
+            /* turn logging off */
+            hidden = *ly_vlog_hide_location();
+            ly_vlog_hide(1);
+
+            /* the value actually uses module's prefixes instead of the module names as in JSON format,
+             * we have to convert it */
+            value = transform_schema2json(leaf->schema->module, value);
+            if (!value) {
+                /* invalid identityref format or it was already transformed, so ignore the error here */
+                value = *value_;
+                /* erase error information */
+                ly_err_clean(1);
+            } else if (value == *value_) {
+                /* we have actually created the same expression (prefixes are the same as the module names)
+                 * so we have just increased dictionary's refcount - fix it */
+                lydict_remove(type->parent->module->ctx, value);
+            }
+            /* turn logging back on */
+            if (!hidden) {
+                ly_vlog_hide(0);
+            }
         }
         if (resolvable && tree && !resolve_instid(tree, value) && (ly_errno || type->info.inst.req)) {
             if (leaf) {
@@ -1316,10 +1367,15 @@ lyp_parse_value(struct lys_type *type, const char **value_, struct lyxml_elem *x
             leaf->value_type |= LY_TYPE_INST_UNRES;
         }
 
-        if (xml) {
+        if (value != *value_) {
             /* update the changed value */
             lydict_remove(type->parent->module->ctx, *value_);
             *value_ = value;
+
+            /* we have to remember the conversion into JSON format to be able to print it in correct form */
+            if (dflt) {
+                type->parent->flags |= LYS_DFLTJSON;
+            }
         }
         break;
 
diff --git a/src/parser_yang.c b/src/parser_yang.c
@@ -2111,9 +2111,11 @@ yang_fill_deviate_default(struct ly_ctx *ctx, struct type_deviation *dev, char *
             /* remove value */
             lydict_remove(ctx, leaf->dflt);
             leaf->dflt = NULL;
+            leaf->flags &= ~LYS_DFLTJSON;
         } else { /* add (already checked) and replace */
             /* remove value */
             lydict_remove(ctx, leaf->dflt);
+            leaf->flags &= ~LYS_DFLTJSON;
 
             /* set new value */
             leaf->dflt = lydict_insert(ctx, value, u);
@@ -2154,6 +2156,7 @@ yang_fill_deviate_default(struct ly_ctx *ctx, struct type_deviation *dev, char *
 
             /* remember to check it later (it may not fit now, but the type can be deviated too) */
             ly_set_add(dev->dflt_check, dev->target, 0);
+            llist->flags &= ~LYS_DFLTJSON;
         }
     }
 
diff --git a/src/parser_yin.c b/src/parser_yin.c
@@ -2303,14 +2303,16 @@ fill_yin_deviation(struct lys_module *module, struct lyxml_elem *yin, struct lys
                         /* remove value */
                         lydict_remove(ctx, leaf->dflt);
                         leaf->dflt = NULL;
+                        leaf->flags &= ~LYS_DFLTJSON;
                     } else { /* add (already checked) and replace */
                         /* remove value */
                         lydict_remove(ctx, leaf->dflt);
+                        leaf->flags &= ~LYS_DFLTJSON;
 
                         /* set new value */
                         leaf->dflt = lydict_insert(ctx, value, u);
 
-                        /* remember to check it later (it may not fit now, but the type can be deviated too) */
+                        /* remember to check it later (it may not fit now, because the type can be deviated too) */
                         ly_set_add(dflt_check, dev_target, 0);
                     }
                 } else { /* LYS_LEAFLIST */
@@ -2346,6 +2348,7 @@ fill_yin_deviation(struct lys_module *module, struct lyxml_elem *yin, struct lys
 
                         /* remember to check it later (it may not fit now, but the type can be deviated too) */
                         ly_set_add(dflt_check, dev_target, 0);
+                        leaf->flags &= ~LYS_DFLTJSON;
                     }
                 }
             }
diff --git a/src/printer_yang.c b/src/printer_yang.c
@@ -688,14 +688,23 @@ yang_print_typedef(struct lyout *out, int level, const struct lys_module *module
 {
     ly_print(out, "%*stypedef %s {\n", LEVEL, INDENT, tpdf->name);
     level++;
+    const char *dflt;
 
     yang_print_snode_common(out, level, (struct lys_node *)tpdf, NULL);
     yang_print_type(out, level, module, &tpdf->type);
     if (tpdf->units != NULL) {
         ly_print(out, "%*sunits \"%s\";\n", LEVEL, INDENT, tpdf->units);
     }
     if (tpdf->dflt != NULL) {
-        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, tpdf->dflt);
+        if (tpdf->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(module, tpdf->dflt);
+        } else {
+            dflt = tpdf->dflt;
+        }
+        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, dflt);
+        if (tpdf->flags & LYS_DFLTJSON) {
+            lydict_remove(module->ctx, dflt);
+        }
     }
 
     level--;
@@ -857,6 +866,7 @@ yang_print_leaf(struct lyout *out, int level, const struct lys_node *node)
 {
     int i;
     struct lys_node_leaf *leaf = (struct lys_node_leaf *)node;
+    const char *dflt;
 
     ly_print(out, "%*sleaf %s {\n", LEVEL, INDENT, node->name);
 
@@ -877,7 +887,15 @@ yang_print_leaf(struct lyout *out, int level, const struct lys_node *node)
         ly_print(out, "%*sunits \"%s\";\n", LEVEL, INDENT, leaf->units);
     }
     if (leaf->dflt) {
-        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, leaf->dflt);
+        if (leaf->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(node->module, leaf->dflt);
+        } else {
+            dflt = leaf->dflt;
+        }
+        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, dflt);
+        if (leaf->flags & LYS_DFLTJSON) {
+            lydict_remove(node->module->ctx, dflt);
+        }
     }
     level--;
 
@@ -915,6 +933,7 @@ yang_print_leaflist(struct lyout *out, int level, const struct lys_node *node)
 {
     int i;
     struct lys_node_leaflist *llist = (struct lys_node_leaflist *)node;
+    const char *dflt;
 
     ly_print(out, "%*sleaf-list %s {\n", LEVEL, INDENT, node->name);
 
@@ -932,7 +951,15 @@ yang_print_leaflist(struct lyout *out, int level, const struct lys_node *node)
     yang_print_snode_common2(out, level, node, NULL);
     yang_print_type(out, level, node->module, &llist->type);
     for (i = 0; i < llist->dflt_size; ++i) {
-        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, llist->dflt[i]);
+        if (llist->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(node->module, llist->dflt[i]);
+        } else {
+            dflt = llist->dflt[i];
+        }
+        ly_print(out, "%*sdefault \"%s\";\n", LEVEL, INDENT, dflt);
+        if (llist->flags & LYS_DFLTJSON) {
+            lydict_remove(node->module->ctx, dflt);
+        }
     }
     if (llist->units != NULL) {
         ly_print(out, "%*sunits \"%s\";\n", LEVEL, INDENT, llist->units);
diff --git a/src/printer_yin.c b/src/printer_yin.c
@@ -706,6 +706,7 @@ static void
 yin_print_typedef(struct lyout *out, int level, const struct lys_module *module, const struct lys_tpdf *tpdf)
 {
     yin_print_open(out, level, "typedef", "name", tpdf->name, 0);
+    const char *dflt;
 
     level++;
     yin_print_snode_common(out, level, (struct lys_node *)tpdf);
@@ -714,7 +715,15 @@ yin_print_typedef(struct lyout *out, int level, const struct lys_module *module,
         yin_print_open(out, level, "units", "name", tpdf->units, 1);
     }
     if (tpdf->dflt) {
-        yin_print_open(out, level, "default", "value", tpdf->dflt, 1);
+        if (tpdf->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(module, tpdf->dflt);
+        } else {
+            dflt = tpdf->dflt;
+        }
+        yin_print_open(out, level, "default", "value", dflt, 1);
+        if (tpdf->flags & LYS_DFLTJSON) {
+            lydict_remove(module->ctx, dflt);
+        }
     }
     level--;
 
@@ -874,6 +883,7 @@ yin_print_leaf(struct lyout *out, int level, const struct lys_node *node)
 {
     int i;
     struct lys_node_leaf *leaf = (struct lys_node_leaf *)node;
+    const char *dflt;
 
     yin_print_open(out, level, "leaf", "name", node->name, 0);
 
@@ -894,7 +904,15 @@ yin_print_leaf(struct lyout *out, int level, const struct lys_node *node)
         yin_print_open(out, level, "units", "name", leaf->units, 1);
     }
     if (leaf->dflt) {
-        yin_print_open(out, level, "default", "value", leaf->dflt, 1);
+        if (leaf->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(node->module, leaf->dflt);
+        } else {
+            dflt = leaf->dflt;
+        }
+        yin_print_open(out, level, "default", "value", dflt, 1);
+        if (leaf->flags & LYS_DFLTJSON) {
+            lydict_remove(node->module->ctx, dflt);
+        }
     }
     level--;
 
@@ -937,6 +955,7 @@ yin_print_leaflist(struct lyout *out, int level, const struct lys_node *node)
 {
     int i;
     struct lys_node_leaflist *llist = (struct lys_node_leaflist *)node;
+    const char *dflt;
 
     yin_print_open(out, level, "leaf-list", "name", node->name, 0);
 
@@ -957,7 +976,15 @@ yin_print_leaflist(struct lyout *out, int level, const struct lys_node *node)
         yin_print_open(out, level, "units", "name", llist->units, 1);
     }
     for (i = 0; i < llist->dflt_size; i++) {
-        yin_print_open(out, level, "default", "value", llist->dflt[i], 1);
+        if (llist->flags & LYS_DFLTJSON) {
+            dflt = transform_json2schema(node->module, llist->dflt[i]);
+        } else {
+            dflt = llist->dflt[i];
+        }
+        yin_print_open(out, level, "default", "value", dflt, 1);
+        if (llist->flags & LYS_DFLTJSON) {
+            lydict_remove(node->module->ctx, dflt);
+        }
     }
     if (llist->min > 0) {
         yin_print_unsigned(out, level, "min-elements", "value", llist->min);
diff --git a/src/tree_schema.h b/src/tree_schema.h
@@ -639,6 +639,8 @@ struct lys_iffeature {
  *       LYS_FENABLED     | | | | | | | | | | | | | | |x| | | |
  *                        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  *    10 LYS_VALID_DEP    |x|x|x|x|x|x|x|x|x|x|x| |x|x| | | | |
+ *                        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *    11 LYS_DFLTJSON     | | |x|x| | | | | | | | | | | |x| | |
  *    --------------------+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  * @{
  */
@@ -670,6 +672,10 @@ struct lys_iffeature {
 #define LYS_VALID_DEP    0x200       /**< flag marking nodes, whose validation (when, must expressions or leafrefs)
                                           depends on nodes outside their subtree (applicable only to RPCs,
                                           notifications, and actions) */
+#define LYS_DFLTJSON     0x400       /**< default value (in ::lys_node_leaf, ::lys_node_leaflist, :lys_tpdf) was
+                                          converted into JSON format, since it contains identityref value which is
+                                          being used in JSON format (instead of module prefixes, we use the module
+                                          names) */
 /**
  * @}
  */
@@ -1455,7 +1461,7 @@ struct lys_tpdf {
     const char *name;                /**< name of the newly defined type (mandatory) */
     const char *dsc;                 /**< description statement (optional) */
     const char *ref;                 /**< reference statement (optional) */
-    uint16_t flags;                  /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ values (or 0) are allowed */
+    uint16_t flags;                  /**< [schema node flags](@ref snodeflags) - only LYS_STATUS_ and LYS_DFLTJSON values (or 0) are allowed */
     struct lys_module *module;       /**< pointer to the module where the data type is defined (mandatory),
                                           NULL in case of built-in typedefs */
 

Original file line number	Diff line number	Diff line change
`@@ -2303,14 +2303,16 @@ fill_yin_deviation(struct lys_module module, struct lyxml_elem yin, struct lys`
`2303`	`2303`	`/* remove value */`
`2304`	`2304`	`lydict_remove(ctx, leaf->dflt);`
`2305`	`2305`	`leaf->dflt = NULL;`
	`2306`	`+ leaf->flags &= ~LYS_DFLTJSON;`
`2306`	`2307`	`} else { /* add (already checked) and replace */`
`2307`	`2308`	`/* remove value */`
`2308`	`2309`	`lydict_remove(ctx, leaf->dflt);`
	`2310`	`+ leaf->flags &= ~LYS_DFLTJSON;`
`2309`	`2311`
`2310`	`2312`	`/* set new value */`
`2311`	`2313`	`leaf->dflt = lydict_insert(ctx, value, u);`
`2312`	`2314`
`2313`		`- /* remember to check it later (it may not fit now, but the type can be deviated too) */`
	`2315`	`+ /* remember to check it later (it may not fit now, because the type can be deviated too) */`
`2314`	`2316`	`ly_set_add(dflt_check, dev_target, 0);`
`2315`	`2317`	`}`
`2316`	`2318`	`} else { /* LYS_LEAFLIST */`
`@@ -2346,6 +2348,7 @@ fill_yin_deviation(struct lys_module module, struct lyxml_elem yin, struct lys`
`2346`	`2348`
`2347`	`2349`	`/* remember to check it later (it may not fit now, but the type can be deviated too) */`
`2348`	`2350`	`ly_set_add(dflt_check, dev_target, 0);`
	`2351`	`+ leaf->flags &= ~LYS_DFLTJSON;`
`2349`	`2352`	`}`
`2350`	`2353`	`}`
`2351`	`2354`	`}`