/* * ***** BEGIN LICENSE BLOCK ***** Copyright (C) 2009-2016 Olof Hagsand and Benny Holmgren Copyright (C) 2017-2019 Olof Hagsand Copyright (C) 2020 Olof Hagsand and Rubicon Communications, LLC(Netgate) 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 #include #include #include #include #include #include #include #include /* cligen */ #include /* clicon */ #include #include "clixon_cli_api.h" #include "cli_plugin.h" #include "cli_generate.h" #include "cli_common.h" #include "cli_handle.h" /* Command line options to be passed to getopt(3) */ #define CLI_OPTS "hD:f:E:l:F:1a:u:d:m:qp:GLy:c:U:o:" /*! Check if there is a CLI history file and if so dump the CLI histiry to it * Just log if file does not exist or is not readable * @param[in] h CLICON handle */ static int cli_history_load(clicon_handle h) { int retval = -1; int lines; char *filename; FILE *f = NULL; wordexp_t result = {0,}; /* for tilde expansion */ /* Get history size from clixon option, if not use cligen default. */ if (clicon_option_exists(h, "CLICON_CLI_HIST_SIZE")) lines = clicon_option_int(h,"CLICON_CLI_HIST_SIZE"); else lines = CLIGEN_HISTSIZE_DEFAULT; /* Re-init history with clixon lines (1st time was w cligen defaults) */ if (cligen_hist_init(cli_cligen(h), lines) < 0) goto done; if ((filename = clicon_option_str(h,"CLICON_CLI_HIST_FILE")) == NULL) goto ok; /* ignore */ if (wordexp(filename, &result, 0) < 0){ clicon_err(OE_UNIX, errno, "wordexp"); goto done; } if ((f = fopen(result.we_wordv[0], "r")) == NULL){ clicon_log(LOG_DEBUG, "Warning: Could not open CLI history file for reading: %s: %s", result.we_wordv[0], strerror(errno)); goto ok; } if (cligen_hist_file_load(cli_cligen(h), f) < 0){ clicon_err(OE_UNIX, errno, "cligen_hist_file_load"); goto done; } ok: retval = 0; done: wordfree(&result); if (f) fclose(f); return retval; } /*! Start CLI history and load from file * Just log if file does not exist or is not readable * @param[in] h CLICON handle */ static int cli_history_save(clicon_handle h) { int retval = -1; char *filename; FILE *f = NULL; wordexp_t result = {0,}; /* for tilde expansion */ if ((filename = clicon_option_str(h, "CLICON_CLI_HIST_FILE")) == NULL) goto ok; /* ignore */ if (wordexp(filename, &result, 0) < 0){ clicon_err(OE_UNIX, errno, "wordexp"); goto done; } if ((f = fopen(result.we_wordv[0], "w+")) == NULL){ clicon_log(LOG_DEBUG, "Warning: Could not open CLI history file for writing: %s: %s", result.we_wordv[0], strerror(errno)); goto ok; } if (cligen_hist_file_save(cli_cligen(h), f) < 0){ clicon_err(OE_UNIX, errno, "cligen_hist_file_save"); goto done; } ok: retval = 0; done: wordfree(&result); if (f) fclose(f); return retval; } /*! Clean and close all state of cli process (but dont exit). * Cannot use h after this * @param[in] h Clixon handle */ static int cli_terminate(clicon_handle h) { yang_stmt *yspec; cvec *nsctx; cxobj *x; clicon_rpc_close_session(h); if ((yspec = clicon_dbspec_yang(h)) != NULL) yspec_free(yspec); if ((yspec = clicon_config_yang(h)) != NULL) yspec_free(yspec); if ((nsctx = clicon_nsctx_global_get(h)) != NULL) cvec_free(nsctx); if ((x = clicon_conf_xml(h)) != NULL) xml_free(x); clicon_data_cvec_del(h, "cli-edit-cvv");; xpath_optimize_exit(); cli_plugin_finish(h); cli_history_save(h); cli_handle_exit(h); clicon_log_exit(); return 0; } /*! Unlink pidfile and quit */ static void cli_sig_term(int arg) { clicon_log(LOG_NOTICE, "%s: %u Terminated (killed by sig %d)", __PROGRAM__, getpid(), arg); exit(1); } /*! Setup signal handlers */ static void cli_signal_init (clicon_handle h) { cli_signal_block(h); set_signal(SIGTERM, cli_sig_term, NULL); } /*! Interactive CLI command loop * @param[in] h CLICON handle * @retval 0 * @retval -1 * @see cligen_loop */ static int cli_interactive(clicon_handle h) { int retval = -1; char *cmd; char *new_mode; cligen_result result; /* Loop through all commands */ while(!cligen_exiting(cli_cligen(h))) { new_mode = cli_syntax_mode(h); cmd = NULL; if (clicon_cliread(h, &cmd) < 0) goto done; if (cmd == NULL) { /* EOF */ cligen_exiting_set(cli_cligen(h), 1); continue; } if (clicon_parse(h, cmd, &new_mode, &result, NULL) < 0) goto done; /* Why not check result? */ } retval = 0; done: return retval; } /*! Generate one autocli clispec tree * * @param[in] h Clixon handle * @param[in] name Name of tree * @param[in] gt genmodel-type, ie HOW to generate the CLI * @param[in] printgen Print CLI syntax to stderr * @param[in] show_tree Is tree for show cli command (1 - yes. 0 - no) * * Generate clispec (datamodel) from YANG dataspec and add to the set of cligen trees * (as a separate mode) * This tree is referenced from the main CLI spec (CLICON_CLISPEC_DIR) using the "tree reference" * syntax, ie @datamodel * @param[in] h Clixon handle * @param[in] printgen Print CLI syntax generated from dbspec * @retval 0 OK * @retval -1 Error * * @note that yang2cli generates syntax for ALL modules under the loaded yangspec. */ static int autocli_tree(clicon_handle h, char *name, enum genmodel_type gt, int state, int printgen, int show_tree) { int retval = -1; parse_tree *pt = NULL; /* cli parse tree */ yang_stmt *yspec; pt_head *ph; if ((pt = pt_new()) == NULL){ clicon_err(OE_UNIX, errno, "pt_new"); goto done; } yspec = clicon_dbspec_yang(h); /* Generate tree (this is where the action is) */ if (yang2cli(h, yspec, gt, printgen, state, show_tree, pt) < 0) goto done; /* Append cligen tree and name it */ if ((ph = cligen_ph_add(cli_cligen(h), name)) == NULL) goto done; if (cligen_ph_parsetree_set(ph, pt) < 0) goto done; retval = 0; done: return retval; } /*! Generate autocli, ie if enabled, generate clispec from YANG and add to cligen parse-trees * * Generate clispec (datamodel) from YANG dataspec and add to the set of cligen trees * (as a separate mode) * This tree is referenced from the main CLI spec (CLICON_CLISPEC_DIR) using the "tree reference" * syntax, ie @datamodel * Also (if enabled) generate a second "state" tree called @datamodelstate * * @param[in] h Clixon handle * @param[in] printgen Print CLI syntax generated from dbspec * @retval 0 OK * @retval -1 Error */ static int autocli_start(clicon_handle h, int printgen) { int retval = -1; int autocli_model = 0; cbuf *show_treename = NULL, *treename = NULL; enum genmodel_type gt; /* If autocli disabled quit */ if ((autocli_model = clicon_cli_genmodel(h)) == 0) goto ok; /* Get the autocli type, ie HOW the cli is generated (could be much more here) */ gt = clicon_cli_genmodel_type(h); /* Create show_treename cbuf */ if ((show_treename = cbuf_new()) == NULL){ clicon_err(OE_UNIX, errno, "cbuf_new"); goto done; } /* Create treename cbuf */ if ((treename = cbuf_new()) == NULL){ clicon_err(OE_UNIX, errno, "cbuf_new"); goto done; } /* The tree name is by default @datamodel but can be changed by option (why would one do that?) */ cprintf(treename, "%s", clicon_cli_model_treename(h)); if (autocli_tree(h, cbuf_get(treename), gt, 0, printgen, 0) < 0) goto done; /* The tree name is by default @datamodelshow but can be changed by option (why would one do that?) */ cprintf(show_treename, "%s", clicon_cli_model_treename(h)); cprintf(show_treename, "show"); if (autocli_tree(h, cbuf_get(show_treename), gt, 0, printgen, 1) < 0) goto done; /* Create a tree for config+state. This tree's name has appended "state" to @datamodel (XXX) */ if (autocli_model > 1){ cprintf(treename, "state"); if (autocli_tree(h, cbuf_get(treename), gt, 1, printgen, 1) < 0) goto done; } ok: retval = 0; done: if (show_treename) cbuf_free(show_treename); if (treename) cbuf_free(treename); return retval; } static void usage(clicon_handle h, char *argv0) { char *plgdir = clicon_cli_dir(h); fprintf(stderr, "usage:%s [options] [commands]\n" "where commands is a CLI command or options passed to the main plugin\n" "where options are\n" "\t-h \t\tHelp\n" "\t-D \tDebug level\n" "\t-f \tConfig-file (mandatory)\n" "\t-E \tExtra configuration file directory\n" "\t-F \tRead commands from file (default stdin)\n" "\t-1\t\tDo not enter interactive mode\n" "\t-a UNIX|IPv4|IPv6\tInternal backend socket family\n" "\t-u \tInternal socket domain path or IP addr (see -a)\n" "\t-d \tSpecify plugin directory (default: %s)\n" "\t-m \tSpecify plugin syntax mode\n" "\t-q \t\tQuiet mode, dont print greetings or prompt, terminate on ctrl-C\n" "\t-p \tYang directory path (see CLICON_YANG_DIR)\n" "\t-G \t\tPrint CLI syntax generated from dbspec (if CLICON_CLI_GENMODEL enabled)\n" "\t-L \t\tDebug print dynamic CLI syntax including completions and expansions\n" "\t-l > \tLog on (s)yslog, std(e)rr, std(o)ut or (f)ile (stderr is default)\n" "\t-y \tOverride yang spec file (dont include .yang suffix)\n" "\t-c \tSpecify cli spec file.\n" "\t-U \tOver-ride unix user with a pseudo user for NACM.\n" "\t-o \"