From c370ac8706d194a82f513e31a76d0e1eadec53e3 Mon Sep 17 00:00:00 2001 From: shmuels Date: Sun, 18 Apr 2021 16:58:18 +0300 Subject: [PATCH] completing the function of hide for autocli-op in the yang files --- apps/cli/cli_auto.c | 8 ++++---- apps/cli/cli_common.c | 8 ++++---- apps/cli/cli_generate.c | 35 ++++++++++++++++++++++++++------ apps/cli/cli_show.c | 8 ++++---- apps/netconf/netconf_lib.c | 2 +- doc/FAQ.md | 2 +- example/main/example_cli.c | 4 ++-- lib/clixon/clixon_xml_io.h | 4 ++-- lib/src/clixon_datastore_read.c | 6 +++--- lib/src/clixon_datastore_write.c | 4 ++-- lib/src/clixon_xml_io.c | 33 ++++++++++++++++++++++-------- lib/src/clixon_xml_map.c | 16 +++++++++++++++ lib/src/clixon_xml_vec.c | 2 +- util/clixon_util_datastore.c | 4 ++-- util/clixon_util_path.c | 2 +- util/clixon_util_xml_mod.c | 4 ++-- 16 files changed, 98 insertions(+), 44 deletions(-) diff --git a/apps/cli/cli_auto.c b/apps/cli/cli_auto.c index 0441937e..ebd56c4e 100644 --- a/apps/cli/cli_auto.c +++ b/apps/cli/cli_auto.c @@ -413,10 +413,10 @@ cli_auto_show(clicon_handle h, switch (format){ case FORMAT_XML: if (isroot) - clicon_xml2file(stdout, xp, 0, pretty); + clicon_xml2file(stdout, xp, 0, pretty, 1); else{ while ((xc = xml_child_each(xp, xc, CX_ELMNT)) != NULL) - clicon_xml2file(stdout, xc, 0, pretty); + clicon_xml2file(stdout, xc, 0, pretty, 1); } fprintf(stdout, "\n"); break; @@ -451,10 +451,10 @@ cli_auto_show(clicon_handle h, if (pretty) fprintf(stdout, "\n"); if (isroot) - clicon_xml2file(stdout, xp, 2, pretty); + clicon_xml2file(stdout, xp, 2, pretty, 1); else while ((xc = xml_child_each(xp, xc, CX_ELMNT)) != NULL) - clicon_xml2file(stdout, xc, 2, pretty); + clicon_xml2file(stdout, xc, 2, pretty, 1); fprintf(stdout, "]]>]]>\n"); break; } /* switch */ diff --git a/apps/cli/cli_common.c b/apps/cli/cli_common.c index 2a3c74a9..8ab03396 100644 --- a/apps/cli/cli_common.c +++ b/apps/cli/cli_common.c @@ -676,7 +676,7 @@ compare_xmls(cxobj *xc1, xml2txt_cb(f, xc, cligen_output); else while ((xc = xml_child_each(xc1, xc, -1)) != NULL) - clicon_xml2file_cb(f, xc, 0, 1, cligen_output); + clicon_xml2file_cb(f, xc, 0, 1, cligen_output, 0); fclose(f); close(fd); @@ -693,7 +693,7 @@ compare_xmls(cxobj *xc1, xml2txt_cb(f, xc, cligen_output); else while ((xc = xml_child_each(xc2, xc, -1)) != NULL) - clicon_xml2file_cb(f, xc, 0, 1, cligen_output); + clicon_xml2file_cb(f, xc, 0, 1, cligen_output, 0); fclose(f); close(fd); @@ -923,7 +923,7 @@ save_config_file(clicon_handle h, clicon_err(OE_CFG, errno, "Creating file %s", filename); goto done; } - if (clicon_xml2file(f, xt, 0, 1) < 0) + if (clicon_xml2file(f, xt, 0, 1, 0) < 0) goto done; retval = 0; /* Fall through */ @@ -1029,7 +1029,7 @@ cli_notification_cb(int s, while ((x = xml_child_each(xe, x, -1)) != NULL) { switch (format){ case FORMAT_XML: - if (clicon_xml2file_cb(stdout, x, 0, 1, cligen_output) < 0) + if (clicon_xml2file_cb(stdout, x, 0, 1, cligen_output, 0) < 0) goto done; break; case FORMAT_TEXT: diff --git a/apps/cli/cli_generate.c b/apps/cli/cli_generate.c index bf76b26f..8235d9d8 100644 --- a/apps/cli/cli_generate.c +++ b/apps/cli/cli_generate.c @@ -119,7 +119,14 @@ cli_expand_var_generate(clicon_handle h, cbuf *cb) { int retval = -1; - char *api_path_fmt = NULL; + char *api_path_fmt = NULL, *opext = NULL; + + if (yang_extension_value(ys, "autocli-op", CLIXON_LIB_NS, &opext) < 0) + goto done; + if (opext && strcmp(opext, "hide-database") == 0) { + retval = 1; + goto done; + } if (yang2api_path_fmt(ys, 1, &api_path_fmt) < 0) goto done; @@ -574,7 +581,7 @@ yang2cli_var(clicon_handle h, uint8_t fraction_digits = 0; enum cv_type cvtype; int options = 0; - int completionp; + int completionp, result; char *type; if ((patterns = cvec_new(0)) == NULL){ @@ -599,9 +606,10 @@ yang2cli_var(clicon_handle h, if (yang2cli_var_union(h, ys, origtype, yrestype, helptext, cb) < 0) goto done; if (clicon_cli_genmodel_completion(h)){ - if (cli_expand_var_generate(h, ys, cvtype, + result = cli_expand_var_generate(h, ys, cvtype, options, fraction_digits, - cb) < 0) + cb); + if (result < 0) goto done; yang2cli_helptext(cb, helptext); } @@ -622,9 +630,10 @@ yang2cli_var(clicon_handle h, options, cvv, patterns, fraction_digits, cb)) < 0) goto done; if (completionp){ - if (cli_expand_var_generate(h, ys, cvtype, + result = cli_expand_var_generate(h, ys, cvtype, options, fraction_digits, - cb) < 0) + cb); + if (result < 0) goto done; yang2cli_helptext(cb, helptext); cprintf(cb, ")"); @@ -688,6 +697,10 @@ yang2cli_leaf(clicon_handle h, cprintf(cb, ",hide{"); extralevel = 1; } + if (opext && strcmp(opext, "hide-database-auto-completion") == 0){ + cprintf(cb, ",hide-database-auto-completion{"); + extralevel = 1; + } if (yang2cli_var(h, ys, helptext, cb) < 0) goto done; } @@ -695,6 +708,9 @@ yang2cli_leaf(clicon_handle h, if (opext && strcmp(opext, "hide") == 0){ cprintf(cb, ",hide"); } + if (opext && strcmp(opext, "hide-database-auto-completion") == 0){ + cprintf(cb, ",hide-database-auto-completion"); + } } } else{ @@ -767,6 +783,9 @@ yang2cli_container(clicon_handle h, if (opext != NULL && strcmp(opext, "hide") == 0){ cprintf(cb, ",hide"); } + if (opext != NULL && strcmp(opext, "hide-database-auto-completion") == 0){ + cprintf(cb, ",hide-database-auto-completion"); + } cprintf(cb, ";{\n"); } @@ -822,6 +841,10 @@ yang2cli_list(clicon_handle h, cprintf(cb, ",hide"); extralevel = 1; } + if (opext != NULL && strcmp(opext, "hide-database-auto-completion") == 0){ + cprintf(cb, ",hide-database-auto-completion"); + extralevel = 1; + } if ((yd = yang_find(ys, Y_DESCRIPTION, NULL)) != NULL){ if ((helptext = strdup(yang_argument_get(yd))) == NULL){ clicon_err(OE_UNIX, errno, "strdup"); diff --git a/apps/cli/cli_show.c b/apps/cli/cli_show.c index e323d8b3..47666e20 100644 --- a/apps/cli/cli_show.c +++ b/apps/cli/cli_show.c @@ -476,7 +476,7 @@ cli_show_config1(clicon_handle h, case FORMAT_XML: xc = NULL; /* Dont print xt itself */ while ((xc = xml_child_each(xt, xc, -1)) != NULL) - clicon_xml2file_cb(stdout, xc, 0, 1, cligen_output); + clicon_xml2file_cb(stdout, xc, 0, 1, cligen_output, 1); break; case FORMAT_JSON: xml2json_cb(stdout, xt, 1, cligen_output); @@ -499,7 +499,7 @@ cli_show_config1(clicon_handle h, NETCONF_BASE_NAMESPACE); xc = NULL; /* Dont print xt itself */ while ((xc = xml_child_each(xt, xc, -1)) != NULL) - clicon_xml2file_cb(stdout, xc, 2, 1, cligen_output); + clicon_xml2file_cb(stdout, xc, 2, 1, cligen_output, 1); cligen_output(stdout, "]]>]]>\n"); break; } @@ -747,14 +747,14 @@ cli_show_auto1(clicon_handle h, break; case FORMAT_NETCONF: fprintf(stdout, "\n"); - clicon_xml2file(stdout, xp, 2, 1); + clicon_xml2file(stdout, xp, 2, 1, 1); fprintf(stdout, "]]>]]>\n"); break; default: for (; i < xml_child_nr(xml_parent(xp)) ; ++i, xp_helper = xml_child_i(xml_parent(xp), i)) { switch (format){ case FORMAT_XML: - clicon_xml2file(stdout, xp_helper, 0, 1); + clicon_xml2file(stdout, xp_helper, 0, 1, 1); break; case FORMAT_JSON: xml2json_cb(stdout, xp_helper, 1, cligen_output); diff --git a/apps/netconf/netconf_lib.c b/apps/netconf/netconf_lib.c index ebbe43cb..56580951 100644 --- a/apps/netconf/netconf_lib.c +++ b/apps/netconf/netconf_lib.c @@ -200,7 +200,7 @@ netconf_output(int s, if (clicon_debug_get() > 1){ /* XXX: below only works to stderr, clicon_debug may log to syslog */ cxobj *xt = NULL; if (clixon_xml_parse_string(buf, YB_NONE, NULL, &xt, NULL) == 0){ - clicon_xml2file(stderr, xml_child_i(xt, 0), 0, 0); + clicon_xml2file(stderr, xml_child_i(xt, 0), 0, 0, 0); fprintf(stderr, "\n"); xml_free(xt); } diff --git a/doc/FAQ.md b/doc/FAQ.md index d105af3f..d321d0a3 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -485,7 +485,7 @@ Suppose you want to print all added interfaces: cxobj *target = transaction_target(td); # wanted XML tree vec = xpath_vec_flag(target, NULL, "//interface", &len, XML_FLAG_ADD); /* Get added i/fs */ for (i=0; i1) - clicon_xml2file(stderr, xt, 0, 1); + clicon_xml2file(stderr, xt, 0, 1, 0); *xtop = xt; xt = NULL; retval = 1; @@ -872,7 +872,7 @@ xmldb_get_cache(clicon_handle h, * If cache was empty, also update to datastore cache */ if (clicon_debug_get()>1) - clicon_xml2file(stderr, x1t, 0, 1); + clicon_xml2file(stderr, x1t, 0, 1, 0); *xtop = x1t; retval = 1; done: @@ -971,7 +971,7 @@ xmldb_get_zerocopy(clicon_handle h, goto done; } if (clicon_debug_get()>1) - clicon_xml2file(stderr, x0t, 0, 1); + clicon_xml2file(stderr, x0t, 0, 1, 0); *xtop = x0t; retval = 1; done: diff --git a/lib/src/clixon_datastore_write.c b/lib/src/clixon_datastore_write.c index a4425258..5945d8fa 100644 --- a/lib/src/clixon_datastore_write.c +++ b/lib/src/clixon_datastore_write.c @@ -1043,7 +1043,7 @@ xmldb_put(clicon_handle h, if (xml2json(f, x0, pretty) < 0) goto done; } - else if (clicon_xml2file(f, x0, 0, pretty) < 0) + else if (clicon_xml2file(f, x0, 0, pretty, 0) < 0) goto done; /* Remove modules state after writing to file */ @@ -1101,7 +1101,7 @@ xmldb_dump(clicon_handle h, if (xml2json(f, xt, pretty) < 0) goto done; } - else if (clicon_xml2file(f, xt, 0, pretty) < 0) + else if (clicon_xml2file(f, xt, 0, pretty, 0) < 0) goto done; retval = 0; done: diff --git a/lib/src/clixon_xml_io.c b/lib/src/clixon_xml_io.c index 7b2e1a2f..4b424f40 100644 --- a/lib/src/clixon_xml_io.c +++ b/lib/src/clixon_xml_io.c @@ -94,6 +94,7 @@ * @param[in] level how many spaces to insert before each line * @param[in] prettyprint insert \n and spaces tomake the xml more readable. * @param[in] fn Callback to make print function + * @param[in] used_for_show_command is the function used for a cli show command. * @see clicon_xml2cbuf * One can use clicon_xml2cbuf to get common code, but using fprintf is * much faster than using cbuf and then printing that,... @@ -103,7 +104,8 @@ xml2file_recurse(FILE *f, cxobj *x, int level, int prettyprint, - clicon_output_cb *fn) + clicon_output_cb *fn, + int used_for_show_command) { int retval = -1; char *name; @@ -113,9 +115,17 @@ xml2file_recurse(FILE *f, int haselement; char *val; char *encstr = NULL; /* xml encoded string */ - + char *opext = NULL; + if (x == NULL) goto ok; + /* Look for autocli-op defined in clixon-lib.yang */ + if (yang_extension_value(xml_spec(x), "autocli-op", CLIXON_LIB_NS, &opext) < 0) { + goto ok; + } + if ((used_for_show_command == 1) && (opext != NULL) && ((strcmp(opext, "hide-database") == 0) || (strcmp(opext, "hide-database-auto-completion") == 0))){ + goto ok; + } name = xml_name(x); namespace = xml_prefix(x); switch(xml_type(x)){ @@ -144,7 +154,7 @@ xml2file_recurse(FILE *f, while ((xc = xml_child_each(x, xc, -1)) != NULL) { switch (xml_type(xc)){ case CX_ATTR: - if (xml2file_recurse(f, xc, level+1, prettyprint, fn) <0) + if (xml2file_recurse(f, xc, level+1, prettyprint, fn, used_for_show_command) <0) goto done; break; case CX_BODY: @@ -169,7 +179,7 @@ xml2file_recurse(FILE *f, xc = NULL; while ((xc = xml_child_each(x, xc, -1)) != NULL) { if (xml_type(xc) != CX_ATTR) - if (xml2file_recurse(f, xc, level+1, prettyprint, fn) <0) + if (xml2file_recurse(f, xc, level+1, prettyprint, fn, used_for_show_command) <0) goto done; } if (prettyprint && hasbody==0) @@ -199,6 +209,7 @@ xml2file_recurse(FILE *f, * @param[in] xn clicon xml tree * @param[in] level how many spaces to insert before each line * @param[in] prettyprint insert \n and spaces tomake the xml more readable. + * @param[in] used_for_show_command is the function used for a cli show command. * @see clicon_xml2cbuf print to a cbuf string * @see clicon_xml2cbuf_cb print using a callback */ @@ -206,9 +217,10 @@ int clicon_xml2file(FILE *f, cxobj *x, int level, - int prettyprint) + int prettyprint, + int used_for_show_command) { - return xml2file_recurse(f, x, level, prettyprint, fprintf); + return xml2file_recurse(f, x, level, prettyprint, fprintf, used_for_show_command); } /*! Print an XML tree structure to an output stream and encode chars "<>&" @@ -217,6 +229,7 @@ clicon_xml2file(FILE *f, * @param[in] xn clicon xml tree * @param[in] level how many spaces to insert before each line * @param[in] prettyprint insert \n and spaces tomake the xml more readable. + * @param[in] used_for_show_command is the function used for a cli show command. * @see clicon_xml2cbuf */ int @@ -224,9 +237,10 @@ clicon_xml2file_cb(FILE *f, cxobj *x, int level, int prettyprint, - clicon_output_cb *fn) + clicon_output_cb *fn, + int used_for_show_command) { - return xml2file_recurse(f, x, level, prettyprint, fn); + return xml2file_recurse(f, x, level, prettyprint, fn, used_for_show_command); } /*! Print an XML tree structure to an output stream @@ -235,6 +249,7 @@ clicon_xml2file_cb(FILE *f, * * @param[in] f UNIX output stream * @param[in] xn clicon xml tree + * used_for_show_command * @see clicon_xml2cbuf * @see clicon_xml2cbuf_cb print using a callback */ @@ -242,7 +257,7 @@ int xml_print(FILE *f, cxobj *x) { - return xml2file_recurse(f, x, 0, 1, fprintf); + return xml2file_recurse(f, x, 0, 1, fprintf, 0); } /*! Print an XML tree structure to a cligen buffer and encode chars "<>&" diff --git a/lib/src/clixon_xml_map.c b/lib/src/clixon_xml_map.c index 848f4ebf..5cd31f37 100644 --- a/lib/src/clixon_xml_map.c +++ b/lib/src/clixon_xml_map.c @@ -144,11 +144,19 @@ xml2txt_recurse(FILE *f, cxobj *xc = NULL; int children=0; int retval = -1; + char *opext = NULL; if (f == NULL || x == NULL || fn == NULL){ clicon_err(OE_XML, EINVAL, "f, x or fn is NULL"); goto done; } + /* Look for autocli-op defined in clixon-lib.yang */ + if (yang_extension_value(xml_spec(x), "autocli-op", CLIXON_LIB_NS, &opext) < 0) { + goto ok; + } + if ((opext != NULL) && ((strcmp(opext, "hide-database") == 0) || (strcmp(opext, "hide-database-auto-completion") == 0))){ + goto ok; + } xc = NULL; /* count children (elements and bodies, not attributes) */ while ((xc = xml_child_each(x, xc, -1)) != NULL) if (xml_type(xc) == CX_ELMNT || xml_type(xc) == CX_BODY) @@ -233,11 +241,19 @@ xml2cli_recurse(FILE *f, yang_stmt *ys; int match; char *body; + char *opext = NULL; if (xml_type(x)==CX_ATTR) goto ok; if ((ys = xml_spec(x)) == NULL) goto ok; + /* Look for autocli-op defined in clixon-lib.yang */ + if (yang_extension_value(xml_spec(x), "autocli-op", CLIXON_LIB_NS, &opext) < 0) { + goto ok; + } + if ((opext != NULL) && ((strcmp(opext, "hide-database") == 0) || (strcmp(opext, "hide-database-auto-completion") == 0))){ + goto ok; + } /* If leaf/leaf-list or presence container, then print line */ if (yang_keyword_get(ys) == Y_LEAF || yang_keyword_get(ys) == Y_LEAF_LIST){ diff --git a/lib/src/clixon_xml_vec.c b/lib/src/clixon_xml_vec.c index 21e222a9..e5ceb57c 100644 --- a/lib/src/clixon_xml_vec.c +++ b/lib/src/clixon_xml_vec.c @@ -341,7 +341,7 @@ clixon_xvec_print(FILE *f, int i; for (i=0; ixv_len; i++) - clicon_xml2file(f, xv->xv_vec[i], 0, 1); + clicon_xml2file(f, xv->xv_vec[i], 0, 1, 0); return 0; } diff --git a/util/clixon_util_datastore.c b/util/clixon_util_datastore.c index 65e611f2..8b8207a9 100644 --- a/util/clixon_util_datastore.c +++ b/util/clixon_util_datastore.c @@ -205,7 +205,7 @@ main(int argc, char **argv) xpath = "/"; if (xmldb_get(h, db, NULL, xpath, &xt) < 0) goto done; - clicon_xml2file(stdout, xt, 0, 0); + clicon_xml2file(stdout, xt, 0, 0, 0); fprintf(stdout, "\n"); if (xt){ xml_free(xt); @@ -228,7 +228,7 @@ main(int argc, char **argv) clicon_err(OE_DB, 0, "xt is NULL"); goto done; } - clicon_xml2file(stdout, xt, 0, 0); + clicon_xml2file(stdout, xt, 0, 0, 0); if (xt){ xml_free(xt); xt = NULL; diff --git a/util/clixon_util_path.c b/util/clixon_util_path.c index f75a36da..c2b73c98 100644 --- a/util/clixon_util_path.c +++ b/util/clixon_util_path.c @@ -279,7 +279,7 @@ main(int argc, for (i = 0; i < xlen; i++){ xc = xvec[i]; fprintf(stdout, "%d: ", i); - clicon_xml2file(stdout, xc, 0, 0); + clicon_xml2file(stdout, xc, 0, 0, 0); fprintf(stdout, "\n"); fflush(stdout); } diff --git a/util/clixon_util_xml_mod.c b/util/clixon_util_xml_mod.c index 7347842c..b2850afe 100644 --- a/util/clixon_util_xml_mod.c +++ b/util/clixon_util_xml_mod.c @@ -281,9 +281,9 @@ main(int argc, char **argv) if (sort) xml_sort_recurse(xb); if (strcmp(xml_name(xb),"top")==0) - clicon_xml2file(stdout, xml_child_i_type(xb, 0, CX_ELMNT), 0, 0); + clicon_xml2file(stdout, xml_child_i_type(xb, 0, CX_ELMNT), 0, 0, 0); else - clicon_xml2file(stdout, xb, 0, 0); + clicon_xml2file(stdout, xb, 0, 0, 0); fprintf(stdout, "\n"); retval = 0; done: