/* * ***** BEGIN LICENSE BLOCK ***** Copyright (C) 2009-2018 Olof Hagsand and Benny Holmgren This file is part of CLIXON. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Alternatively, the contents of this file may be used under the terms of the GNU General Public License Version 3 or later (the "GPL"), in which case the provisions of the GPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of the GPL, and not to allow others to use your version of this file under the terms of Apache License version 2, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the Apache License version 2 or the GPL. ***** END LICENSE BLOCK ***** * */ #ifdef HAVE_CONFIG_H #include "clixon_config.h" /* generated by config & autoconf */ #endif #include #include #include #include #include #include #include #include #include #ifdef HAVE_CRYPT_H #include #endif #include #include #include #include #include #include #include #include #include #include #include #include /* cligen */ #include /* clicon */ #include /* Exported functions in this file are in clixon_cli_api.h */ #include "clixon_cli_api.h" #include "cli_common.h" /* internal functions */ /*! Completion callback intended for automatically generated data model * * Returns an expand-type list of commands as used by cligen 'expand' * functionality. * * Assume callback given in a cligen spec: a ") * @param[in] h clicon handle * @param[in] name Name of this function (eg "expand_dbvar") * @param[in] cvv The command so far. Eg: cvec [0]:"a 5 b"; [1]: x=5; * @param[in] argv Arguments given at the callback ("" "") * @param[out] len len of return commands & helptxt * @param[out] commands vector of function pointers to callback functions * @param[out] helptxt vector of pointers to helptexts * @see cli_expand_var_generate This is where arg is generated */ int expand_dbvar(void *h, char *name, cvec *cvv, cvec *argv, cvec *commands, cvec *helptexts) { int retval = -1; char *api_path_fmt; char *api_path = NULL; char *dbstr; cxobj *xt = NULL; char *xpath = NULL; cxobj **xvec = NULL; cxobj *xerr; size_t xlen = 0; cxobj *x; char *bodystr; int i; int j; int k; cg_var *cv; yang_spec *yspec; cxobj *xtop = NULL; /* xpath root */ cxobj *xbot = NULL; /* xpath, NULL if datastore */ yang_node *y = NULL; /* yang spec of xpath */ yang_stmt *ytype; yang_stmt *ypath; cxobj *xcur; char *xpathcur; char *reason = NULL; if (argv == NULL || cvec_len(argv) != 2){ clicon_err(OE_PLUGIN, 0, "requires arguments: "); goto done; } if ((yspec = clicon_dbspec_yang(h)) == NULL){ clicon_err(OE_FATAL, 0, "No DB_SPEC"); goto done; } if ((cv = cvec_i(argv, 0)) == NULL){ clicon_err(OE_PLUGIN, 0, "Error when accessing argument "); goto done; } dbstr = cv_string_get(cv); if (strcmp(dbstr, "running") != 0 && strcmp(dbstr, "candidate") != 0 && strcmp(dbstr, "startup") != 0){ clicon_err(OE_PLUGIN, 0, "No such db name: %s", dbstr); goto done; } if ((cv = cvec_i(argv, 1)) == NULL){ clicon_err(OE_PLUGIN, 0, "Error when accessing argument "); goto done; } api_path_fmt = cv_string_get(cv); /* api_path_fmt = /interface/%s/address/%s --> ^/interface/eth0/address/.*$ --> /interface/[name=eth0]/address */ if (api_path_fmt2xpath(api_path_fmt, cvv, &xpath) < 0) goto done; if (api_path_fmt2api_path(api_path_fmt, cvv, &api_path) < 0) goto done; /* XXX read whole configuration, why not send xpath? */ if (clicon_rpc_get_config(h, dbstr, "/", &xt) < 0) goto done; if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){ clicon_rpc_generate_error("Get configuration", xerr); goto ok; } xcur = xt; /* default top-of-tree */ xpathcur = xpath; /* Create config top-of-tree */ if ((xtop = xml_new("config", NULL, NULL)) == NULL) goto done; xbot = xtop; /* This is primarily to get "y", * xpath2xml would have worked!! */ if (api_path && api_path2xml(api_path, yspec, xtop, YC_DATANODE, &xbot, &y) < 0) goto done; if (y==NULL) goto ok; /* Special case for leafref. Detect leafref via Yang-type, * Get Yang path element, tentatively add the new syntax to the whole * tree and apply the path to that. * Last, the reference point for the xpath code below is changed to * the point of the tentative new xml. * Here the whole syntax tree is loaded, and it would be better to offload * such operations to the datastore by a generic xpath function. */ if ((ytype = yang_find((yang_node*)y, Y_TYPE, NULL)) != NULL) if (strcmp(ytype->ys_argument, "leafref")==0){ if ((ypath = yang_find((yang_node*)ytype, Y_PATH, NULL)) == NULL){ clicon_err(OE_DB, 0, "Leafref %s requires path statement", ytype->ys_argument); goto done; } xpathcur = ypath->ys_argument; if (xml_merge(xt, xtop, yspec, &reason) < 0) /* Merge xtop into xt */ goto done; if (reason){ cli_output(stderr, "%s\n", reason); goto done; } if ((xcur = xpath_first(xt, "%s", xpath)) == NULL){ clicon_err(OE_DB, 0, "xpath %s should return merged content", xpath); goto done; } } /* One round to detect duplicates */ j = 0; if (xpath_vec(xcur, "%s", &xvec, &xlen, xpathcur) < 0) goto done; for (i = 0; i < xlen; i++) { char *str; x = xvec[i]; if (xml_type(x) == CX_BODY) bodystr = xml_value(x); else bodystr = xml_body(x); if (bodystr == NULL){ continue; /* no body, cornercase */ } /* detect duplicates */ for (k=0; kd_name, ".") != 0 && strcmp(dp->d_name, "..") != 0 #else dp->d_name[0] != '.' #endif ) { snprintf(filename, MAXPATHLEN-1, "%s/%s", dir, dp->d_name); if (lstat(filename, &st) == 0){ if ((st.st_mode & flags) == 0) continue; #if EXPAND_RECURSIVE if (S_ISDIR(st.st_mode)) { int nrsav = *nr; if(expand_dir(filename, nr, commands, detail) < 0) goto quit; while(nrsav < *nr) { len = strlen(dp->d_name) + strlen((*commands)[nrsav]) + 2; if((str = malloc(len)) == NULL) { fprintf(stderr, "expand_dir: malloc: %s\n", strerror(errno)); goto quit; } snprintf(str, len-1, "%s/%s", dp->d_name, (*commands)[nrsav]); free((*commands)[nrsav]); (*commands)[nrsav] = str; nrsav++; } continue; } #endif if ((cmd = strdup(dp->d_name)) == NULL) { fprintf(stderr, "expand_dir: strdup: %s\n", strerror(errno)); goto quit; } #ifndef __APPLE__ if (0 &&detail){ if ((pw = getpwuid(st.st_uid)) == NULL){ fprintf(stderr, "expand_dir: getpwuid(%d): %s\n", st.st_uid, strerror(errno)); goto quit; } len = strlen(cmd) + strlen(pw->pw_name) + #ifdef __FreeBSD__ strlen(ctime(&st.st_mtimespec.tv_sec)) + #else strlen(ctime(&st.st_mtim.tv_sec)) + #endif strlen("{ by }") + 1 /* \0 */; if ((str=realloc(cmd, strlen(cmd)+len)) == NULL) { fprintf(stderr, "expand_dir: malloc: %s\n", strerror(errno)); goto quit; } snprintf(str + strlen(dp->d_name), len - strlen(dp->d_name), "{%s by %s}", #ifdef __FreeBSD__ ctime(&st.st_mtimespec.tv_sec), #else ctime(&st.st_mtim.tv_sec), #endif pw->pw_name ); cmd = str; } #endif /* __APPLE__ */ if (((*commands) = realloc(*commands, ((*nr)+1)*sizeof(char**))) == NULL){ perror("expand_dir: realloc"); goto quit; } (*commands)[(*nr)] = cmd; (*nr)++; if (*nr >= 128) /* Limit number of options */ break; } } } retval = 0; quit: closedir(dirp); return retval; } /*! CLI callback show yang spec. If arg given matches yang argument string */ int show_yang(clicon_handle h, cvec *cvv, cvec *argv) { yang_node *yn; char *str = NULL; yang_spec *yspec; yspec = clicon_dbspec_yang(h); if (cvec_len(argv) > 0){ str = cv_string_get(cvec_i(argv, 0)); yn = (yang_node*)yang_find((yang_node*)yspec, 0, str); } else yn = (yang_node*)yspec; yang_print(stdout, yn); return 0; } /*! Generic show configuration CLIGEN callback * Utility function used by cligen spec file * @param[in] h CLICON handle * @param[in] cvv Vector of variables from CLIgen command-line * @param[in] argv String vector: [] * Format of argv: * "running"|"candidate"|"startup" * "text"|"xml"|"json"|"cli"|"netconf" (see format_enum) * xpath expression, that may contain one %, eg "/sender[name=%s]" * optional name of variable in cvv. If set, xpath must have a '%s' * @code * show config id , cli_show_config("running","xml","iface[name=%s]","n"); * @endcode */ int cli_show_config(clicon_handle h, cvec *cvv, cvec *argv) { int retval = -1; char *db; char *formatstr; char *xpath; enum format_enum format; cbuf *cbxpath = NULL; char *attr = NULL; int i; int j; cg_var *cvattr; char *val = NULL; cxobj *xt = NULL; cxobj *xc; cxobj *xerr; enum genmodel_type gt; if (cvec_len(argv) != 3 && cvec_len(argv) != 4){ clicon_err(OE_PLUGIN, 0, "Got %d arguments. Expected: ,,[,]", cvec_len(argv)); goto done; } /* First argv argument: Database */ db = cv_string_get(cvec_i(argv, 0)); /* Second argv argument: Format */ formatstr = cv_string_get(cvec_i(argv, 1)); if ((format = format_str2int(formatstr)) < 0){ clicon_err(OE_PLUGIN, 0, "Not valid format: %s", formatstr); goto done; } /* Third argv argument: xpath */ xpath = cv_string_get(cvec_i(argv, 2)); /* Create XPATH variable string */ if ((cbxpath = cbuf_new()) == NULL){ clicon_err(OE_PLUGIN, errno, "cbuf_new"); goto done; } /* Fourth argument is stdarg to xpath format string */ if (cvec_len(argv) == 4){ attr = cv_string_get(cvec_i(argv, 3)); j = 0; for (i=0; i\n"); xc = NULL; /* Dont print xt itself */ while ((xc = xml_child_each(xt, xc, -1)) != NULL) clicon_xml2file(stdout, xc, 2, 1); fprintf(stdout, "]]>]]>\n"); break; } retval = 0; done: if (xt) xml_free(xt); if (val) free(val); if (cbxpath) cbuf_free(cbxpath); return retval; } /*! Show configuration as text given an xpath * Utility function used by cligen spec file * @param[in] h CLICON handle * @param[in] cvv Vector of variables from CLIgen command-line * @param[in] arg A string: * @note Hardcoded that a variable in cvv is named "xpath" */ int show_conf_xpath(clicon_handle h, cvec *cvv, cvec *argv) { int retval = -1; char *str; char *xpath; cg_var *cv; cxobj *xt = NULL; cxobj *xerr; cxobj **xv = NULL; size_t xlen; int i; if (cvec_len(argv) != 1){ clicon_err(OE_PLUGIN, 0, "Requires one element to be "); goto done; } str = cv_string_get(cvec_i(argv, 0)); /* Dont get attr here, take it from arg instead */ if (strcmp(str, "running") != 0 && strcmp(str, "candidate") != 0 && strcmp(str, "startup") != 0){ clicon_err(OE_PLUGIN, 0, "No such db name: %s", str); goto done; } cv = cvec_find(cvv, "xpath"); xpath = cv_string_get(cv); if (clicon_rpc_get_config(h, str, xpath, &xt) < 0) goto done; if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){ clicon_rpc_generate_error("Get configuration", xerr); goto done; } if (xpath_vec(xt, "%s", &xv, &xlen, xpath) < 0) goto done; for (i=0; i Generated API PATH * "running"|"candidate"|"startup" * "text"|"xml"|"json"|"cli"|"netconf" (see format_enum) */ int cli_show_auto(clicon_handle h, cvec *cvv, cvec *argv) { int retval = 1; yang_spec *yspec; char *api_path_fmt; /* xml key format */ // char *api_path = NULL; /* xml key */ char *db; char *xpath; char *formatstr; enum format_enum format = FORMAT_XML; cxobj *xt = NULL; cxobj *xp; cxobj *xerr; enum genmodel_type gt; if (cvec_len(argv) != 3){ clicon_err(OE_PLUGIN, 0, "Usage: * . (*) generated."); goto done; } /* First argv argument: API_path format */ api_path_fmt = cv_string_get(cvec_i(argv, 0)); /* Second argv argument: Database */ db = cv_string_get(cvec_i(argv, 1)); /* Third format: output format */ formatstr = cv_string_get(cvec_i(argv, 2)); if ((format = format_str2int(formatstr)) < 0){ clicon_err(OE_PLUGIN, 0, "Not valid format: %s", formatstr); goto done; } if ((yspec = clicon_dbspec_yang(h)) == NULL){ clicon_err(OE_FATAL, 0, "No DB_SPEC"); goto done; } // if (api_path_fmt2api_path(api_path_fmt, cvv, &api_path) < 0) // goto done; if (api_path_fmt2xpath(api_path_fmt, cvv, &xpath) < 0) goto done; /* Get configuration from database */ if (clicon_rpc_get_config(h, db, xpath, &xt) < 0) goto done; if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){ clicon_rpc_generate_error("Get configuration", xerr); goto done; } if ((xp = xpath_first(xt, "%s", xpath)) != NULL) /* Print configuration according to format */ switch (format){ case FORMAT_XML: clicon_xml2file(stdout, xp, 0, 1); break; case FORMAT_JSON: xml2json(stdout, xp, 1); break; case FORMAT_TEXT: xml2txt(stdout, xp, 0); /* tree-formed text */ break; case FORMAT_CLI: if ((gt = clicon_cli_genmodel_type(h)) == GT_ERR) goto done; xml2cli(stdout, xp, NULL, gt); /* cli syntax */ break; case FORMAT_NETCONF: fprintf(stdout, "\n"); clicon_xml2file(stdout, xp, 2, 1); fprintf(stdout, "]]>]]>\n"); break; default: /* see cli_show_config() */ break; } retval = 0; done: if (xt) xml_free(xt); return retval; } #ifdef COMPAT_CLIV int show_yangv(clicon_handle h, cvec *vars, cvec *argv) { return show_yang(h, vars, argv); } int show_confv_xpath(clicon_handle h, cvec *vars, cvec *argv) { return show_conf_xpath(h, vars, argv); } #endif /* COMPAT_CLIV */