blob: 68d4a2759ca3ee13729279d2b5d0b47d9742bc57 [file] [log] [blame]
Jan Kundrátdc2b0722018-03-02 14:13:37 +01001/*
2 * Copyright (C) 2018 CESNET, https://photonics.cesnet.cz/
Jan Kundráta2740442018-03-22 16:56:43 +01003 * Copyright (C) 2018 FIT CVUT, https://fit.cvut.cz/
Jan Kundrátdc2b0722018-03-02 14:13:37 +01004 *
Václav Kubernát624a8872018-03-02 17:28:47 +01005 * Written by Václav Kubernát <kubervac@fit.cvut.cz>
Jan Kundrátdc2b0722018-03-02 14:13:37 +01006 *
7*/
Jan Kundrátdc2b0722018-03-02 14:13:37 +01008#include <docopt.h>
Václav Kubernát624a8872018-03-02 17:28:47 +01009#include <iostream>
Václav Kubernát435706e2019-02-20 18:05:59 +010010#include <optional>
Václav Kubernáta395d332019-02-13 16:49:20 +010011#include <replxx.hxx>
Václav Kubernát90de9502019-11-20 17:19:44 +010012#include <sstream>
Jan Kundrátdc2b0722018-03-02 14:13:37 +010013#include "NETCONF_CLI_VERSION.h"
Václav Kubernát96344a12018-05-28 16:33:39 +020014#include "interpreter.hpp"
Václav Kubernát48e9dfa2020-07-08 10:55:12 +020015#include "proxy_datastore.hpp"
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010016#if defined(SYSREPO_CLI)
Václav Kubernát6415b822018-08-22 17:40:01 +020017#include "sysrepo_access.hpp"
Václav Kubernáte7248b22020-06-26 15:38:59 +020018#include "yang_schema.hpp"
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010019#define PROGRAM_NAME "sysrepo-cli"
Václav Kubernát715c85c2020-04-14 01:46:08 +020020static const auto usage = R"(CLI interface to sysrepo
21
22Usage:
23 sysrepo-cli [-d <datastore>]
24 sysrepo-cli (-h | --help)
25 sysrepo-cli --version
26
27Options:
28 -d <datastore> can be "running" or "startup" [default: running])";
Václav Kubernát74487df2020-06-04 01:29:28 +020029#elif defined(YANG_CLI)
30#include <boost/spirit/home/x3.hpp>
Václav Kubernát619e6542020-06-29 14:13:43 +020031#include <filesystem>
Václav Kubernát74487df2020-06-04 01:29:28 +020032#include "yang_access.hpp"
33#define PROGRAM_NAME "yang-cli"
34static const auto usage = R"(CLI interface for creating local YANG data instances
35
Václav Kubernát619e6542020-06-29 14:13:43 +020036 The <schema_file_or_module_name> argument is treated as a file name if a file
37 with such a path exists, otherwise it's treated as a module name. Search dirs
38 will be used to find a schema for that module.
39
Václav Kubernát74487df2020-06-04 01:29:28 +020040Usage:
Václav Kubernát28cf3362020-06-29 17:52:51 +020041 yang-cli [--configonly] [-s <search_dir>] [-e enable_features]... [-i data_file]... <schema_file_or_module_name>...
Václav Kubernát74487df2020-06-04 01:29:28 +020042 yang-cli (-h | --help)
43 yang-cli --version
44
45Options:
46 -s <search_dir> Set search for schema lookup
Václav Kubernát548cb192020-06-26 14:00:42 +020047 -e <enable_features> Feature to enable after modules are loaded. This option can be supplied more than once. Format: <module_name>:<feature>
Václav Kubernát28cf3362020-06-29 17:52:51 +020048 -i <data_file> File to import data from
49 --configonly Disable editing of operational data)";
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010050#else
51#error "Unknown CLI backend"
52#endif
Jan Kundrátdc2b0722018-03-02 14:13:37 +010053
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010054const auto HISTORY_FILE_NAME = PROGRAM_NAME "_history";
55
Jan Kundrátdc2b0722018-03-02 14:13:37 +010056int main(int argc, char* argv[])
57{
58 auto args = docopt::docopt(usage,
59 {argv + 1, argv + argc},
60 true,
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010061 PROGRAM_NAME " " NETCONF_CLI_VERSION,
Jan Kundrátdc2b0722018-03-02 14:13:37 +010062 true);
Václav Kubernát28cf3362020-06-29 17:52:51 +020063 WritableOps writableOps = WritableOps::No;
Václav Kubernátff2c9f62018-05-16 20:26:31 +020064
Václav Kubernátb79f3ca2020-02-04 15:56:01 +010065#if defined(SYSREPO_CLI)
Václav Kubernát715c85c2020-04-14 01:46:08 +020066 auto datastoreType = Datastore::Running;
67 if (const auto& ds = args["-d"]) {
68 if (ds.asString() == "startup") {
69 datastoreType = Datastore::Startup;
70 } else if (ds.asString() == "running") {
71 datastoreType = Datastore::Running;
72 } else {
73 std::cerr << PROGRAM_NAME << ": unknown datastore: " << ds.asString() << "\n";
74 return 1;
75 }
76 }
Václav Kubernát654303f2020-07-31 13:16:54 +020077 auto datastore = std::make_shared<SysrepoAccess>(datastoreType);
Václav Kubernát715c85c2020-04-14 01:46:08 +020078 std::cout << "Connected to sysrepo [datastore: " << (datastoreType == Datastore::Startup ? "startup" : "running") << "]" << std::endl;
Václav Kubernát74487df2020-06-04 01:29:28 +020079#elif defined(YANG_CLI)
Václav Kubernát48e9dfa2020-07-08 10:55:12 +020080 auto datastore = std::make_shared<YangAccess>();
Václav Kubernát28cf3362020-06-29 17:52:51 +020081 if (args["--configonly"].asBool()) {
82 writableOps = WritableOps::No;
83 } else {
84 writableOps = WritableOps::Yes;
85 std::cout << "ops is writable" << std::endl;
86 }
Václav Kubernát74487df2020-06-04 01:29:28 +020087 if (const auto& search_dir = args["-s"]) {
Václav Kubernát48e9dfa2020-07-08 10:55:12 +020088 datastore->addSchemaDir(search_dir.asString());
Václav Kubernát74487df2020-06-04 01:29:28 +020089 }
Václav Kubernát619e6542020-06-29 14:13:43 +020090 for (const auto& schemaFile : args["<schema_file_or_module_name>"].asStringList()) {
91 if (std::filesystem::exists(schemaFile)) {
Václav Kubernát48e9dfa2020-07-08 10:55:12 +020092 datastore->addSchemaFile(schemaFile);
Václav Kubernát619e6542020-06-29 14:13:43 +020093 } else if (schemaFile.find('/') == std::string::npos) { // Module names cannot have a slash
Václav Kubernát48e9dfa2020-07-08 10:55:12 +020094 datastore->loadModule(schemaFile);
Václav Kubernát619e6542020-06-29 14:13:43 +020095 } else {
96 std::cerr << "Cannot load YANG module " << schemaFile << "\n";
97 }
Václav Kubernát74487df2020-06-04 01:29:28 +020098 }
99 if (const auto& enableFeatures = args["-e"]) {
100 namespace x3 = boost::spirit::x3;
101 auto grammar = +(x3::char_-":") >> ":" >> +(x3::char_-":");
102 for (const auto& enableFeature : enableFeatures.asStringList()) {
103 std::pair<std::string, std::string> parsed;
104 auto it = enableFeature.begin();
105 auto res = x3::parse(it, enableFeature.cend(), grammar, parsed);
106 if (!res || it != enableFeature.cend()) {
107 std::cerr << "Error parsing feature enable flags: " << enableFeature << "\n";
108 return 1;
109 }
110 try {
Václav Kubernát48e9dfa2020-07-08 10:55:12 +0200111 datastore->enableFeature(parsed.first, parsed.second);
Václav Kubernát74487df2020-06-04 01:29:28 +0200112 } catch (std::runtime_error& ex) {
113 std::cerr << ex.what() << "\n";
114 return 1;
115 }
116
117 }
118 }
Václav Kubernát548cb192020-06-26 14:00:42 +0200119 if (const auto& dataFiles = args["-i"]) {
120 for (const auto& dataFile : dataFiles.asStringList()) {
Václav Kubernát48e9dfa2020-07-08 10:55:12 +0200121 datastore->addDataFile(dataFile);
Václav Kubernát548cb192020-06-26 14:00:42 +0200122 }
123 }
Václav Kubernátb79f3ca2020-02-04 15:56:01 +0100124#else
125#error "Unknown CLI backend"
126#endif
127
Václav Kubernáte7248b22020-06-26 15:38:59 +0200128#if defined(SYSREPO_CLI)
129 auto createTemporaryDatastore = [](const std::shared_ptr<DatastoreAccess>& datastore) {
130 return std::make_shared<YangAccess>(std::static_pointer_cast<YangSchema>(datastore->schema()));
131 };
132#elif defined(YANG_CLI)
133 auto createTemporaryDatastore = [](const std::shared_ptr<DatastoreAccess>&) {
134 return nullptr;
135 };
136#endif
137
138 ProxyDatastore proxyDatastore(datastore, createTemporaryDatastore);
Václav Kubernát48e9dfa2020-07-08 10:55:12 +0200139 auto dataQuery = std::make_shared<DataQuery>(*datastore);
140 Parser parser(datastore->schema(), writableOps, dataQuery);
Václav Kubernát395d92c2020-01-24 12:18:18 +0100141
142 using replxx::Replxx;
143
144 Replxx lineEditor;
145
Václav Kubernát48637292020-07-08 16:54:13 +0200146 lineEditor.bind_key(Replxx::KEY::meta(Replxx::KEY::BACKSPACE), [&lineEditor] (const auto& code) {
147 return lineEditor.invoke(Replxx::ACTION::KILL_TO_BEGINING_OF_WORD, code);
148 });
149 lineEditor.bind_key(Replxx::KEY::control('W'), [&lineEditor] (const auto& code) {
150 return lineEditor.invoke(Replxx::ACTION::KILL_TO_WHITESPACE_ON_LEFT, code);
151 });
Václav Kubernát395d92c2020-01-24 12:18:18 +0100152
153 lineEditor.set_word_break_characters("\t _[]/:'\"=-%");
154
Václav Kubernát1ed4aa32020-01-23 13:13:28 +0100155 lineEditor.set_completion_callback([&parser](const std::string& input, int& context) {
Václav Kubernáta395d332019-02-13 16:49:20 +0100156 std::stringstream stream;
Václav Kubernát1ed4aa32020-01-23 13:13:28 +0100157 auto completions = parser.completeCommand(input, stream);
Václav Kubernáta395d332019-02-13 16:49:20 +0100158
Jan Kundrát8d8efe82019-10-18 10:21:36 +0200159 std::vector<replxx::Replxx::Completion> res;
Václav Kubernát1ed4aa32020-01-23 13:13:28 +0100160 std::copy(completions.m_completions.begin(), completions.m_completions.end(), std::back_inserter(res));
161 context = completions.m_contextLength;
Václav Kubernáta395d332019-02-13 16:49:20 +0100162 return res;
163 });
Václav Kubernát2b684612018-08-09 18:55:24 +0200164
Václav Kubernát435706e2019-02-20 18:05:59 +0100165 std::optional<std::string> historyFile;
166 if (auto xdgHome = getenv("XDG_DATA_HOME")) {
167 historyFile = std::string(xdgHome) + "/" + HISTORY_FILE_NAME;
168 } else if (auto home = getenv("HOME")) {
169 historyFile = std::string(home) + "/.local/share/" + HISTORY_FILE_NAME;
170 }
171
Václav Kubernát3a433232020-07-08 17:52:50 +0200172 if (historyFile) {
Václav Kubernát435706e2019-02-20 18:05:59 +0100173 lineEditor.history_load(historyFile.value());
Václav Kubernát3a433232020-07-08 17:52:50 +0200174 }
Václav Kubernát435706e2019-02-20 18:05:59 +0100175
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200176 while (true) {
Václav Kubernáta395d332019-02-13 16:49:20 +0100177 auto line = lineEditor.input(parser.currentNode() + "> ");
178 if (!line) {
Václav Kubernát82bf1312019-11-05 11:19:26 +0100179 // If user pressed CTRL-C to abort the line, errno gets set to EAGAIN.
180 // If user pressed CTRL-D (for EOF), errno doesn't get set to EAGAIN, so we exit the program.
181 // I have no idea why replxx uses errno for this.
182 if (errno == EAGAIN) {
183 continue;
184 } else {
185 break;
186 }
Václav Kubernát5b80e522019-01-25 12:17:03 +0100187 }
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200188
Jan Kundráte3877022018-09-05 15:32:09 +0200189 std::locale C_locale("C");
Václav Kubernáta395d332019-02-13 16:49:20 +0100190 std::string_view view{line};
191 if (std::all_of(view.begin(), view.end(),
Jan Kundráte3877022018-09-05 15:32:09 +0200192 [C_locale](const auto c) { return std::isspace(c, C_locale);})) {
193 continue;
194 }
195
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200196 try {
Václav Kubernát5b80e522019-01-25 12:17:03 +0100197 command_ cmd = parser.parseCommand(line, std::cout);
Václav Kubernát48e9dfa2020-07-08 10:55:12 +0200198 boost::apply_visitor(Interpreter(parser, proxyDatastore), cmd);
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200199 } catch (InvalidCommandException& ex) {
200 std::cerr << ex.what() << std::endl;
Václav Kubernátc58e4aa2019-04-03 18:37:32 +0200201 } catch (DatastoreException& ex) {
202 std::cerr << ex.what() << std::endl;
Václav Kubernáte7248b22020-06-26 15:38:59 +0200203 } catch (std::runtime_error& ex) {
204 std::cerr << ex.what() << std::endl;
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200205 }
Václav Kubernát5b80e522019-01-25 12:17:03 +0100206
Václav Kubernáta395d332019-02-13 16:49:20 +0100207 lineEditor.history_add(line);
Václav Kubernátff2c9f62018-05-16 20:26:31 +0200208 }
209
Václav Kubernát3a433232020-07-08 17:52:50 +0200210 if (historyFile) {
Václav Kubernát435706e2019-02-20 18:05:59 +0100211 lineEditor.history_save(historyFile.value());
Václav Kubernát3a433232020-07-08 17:52:50 +0200212 }
Václav Kubernát435706e2019-02-20 18:05:59 +0100213
Jan Kundrátdc2b0722018-03-02 14:13:37 +0100214 return 0;
215}