Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 CESNET, https://photonics.cesnet.cz/ |
Jan Kundrát | a274044 | 2018-03-22 16:56:43 +0100 | [diff] [blame] | 3 | * Copyright (C) 2018 FIT CVUT, https://fit.cvut.cz/ |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 4 | * |
Václav Kubernát | 624a887 | 2018-03-02 17:28:47 +0100 | [diff] [blame] | 5 | * Written by Václav Kubernát <kubervac@fit.cvut.cz> |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 6 | * |
| 7 | */ |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 8 | #include <docopt.h> |
Václav Kubernát | 624a887 | 2018-03-02 17:28:47 +0100 | [diff] [blame] | 9 | #include <iostream> |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 10 | #include <optional> |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 11 | #include <replxx.hxx> |
Václav Kubernát | 90de950 | 2019-11-20 17:19:44 +0100 | [diff] [blame] | 12 | #include <sstream> |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 13 | #include "NETCONF_CLI_VERSION.h" |
Václav Kubernát | 96344a1 | 2018-05-28 16:33:39 +0200 | [diff] [blame] | 14 | #include "interpreter.hpp" |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 15 | #include "proxy_datastore.hpp" |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 16 | #if defined(SYSREPO_CLI) |
Václav Kubernát | 6415b82 | 2018-08-22 17:40:01 +0200 | [diff] [blame] | 17 | #include "sysrepo_access.hpp" |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 18 | #define PROGRAM_NAME "sysrepo-cli" |
Václav Kubernát | 715c85c | 2020-04-14 01:46:08 +0200 | [diff] [blame] | 19 | static const auto usage = R"(CLI interface to sysrepo |
| 20 | |
| 21 | Usage: |
| 22 | sysrepo-cli [-d <datastore>] |
| 23 | sysrepo-cli (-h | --help) |
| 24 | sysrepo-cli --version |
| 25 | |
| 26 | Options: |
| 27 | -d <datastore> can be "running" or "startup" [default: running])"; |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 28 | #elif defined(YANG_CLI) |
| 29 | #include <boost/spirit/home/x3.hpp> |
Václav Kubernát | 619e654 | 2020-06-29 14:13:43 +0200 | [diff] [blame] | 30 | #include <filesystem> |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 31 | #include "yang_access.hpp" |
| 32 | #define PROGRAM_NAME "yang-cli" |
| 33 | static const auto usage = R"(CLI interface for creating local YANG data instances |
| 34 | |
Václav Kubernát | 619e654 | 2020-06-29 14:13:43 +0200 | [diff] [blame] | 35 | The <schema_file_or_module_name> argument is treated as a file name if a file |
| 36 | with such a path exists, otherwise it's treated as a module name. Search dirs |
| 37 | will be used to find a schema for that module. |
| 38 | |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 39 | Usage: |
Václav Kubernát | 28cf336 | 2020-06-29 17:52:51 +0200 | [diff] [blame] | 40 | yang-cli [--configonly] [-s <search_dir>] [-e enable_features]... [-i data_file]... <schema_file_or_module_name>... |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 41 | yang-cli (-h | --help) |
| 42 | yang-cli --version |
| 43 | |
| 44 | Options: |
| 45 | -s <search_dir> Set search for schema lookup |
Václav Kubernát | 548cb19 | 2020-06-26 14:00:42 +0200 | [diff] [blame] | 46 | -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át | 28cf336 | 2020-06-29 17:52:51 +0200 | [diff] [blame] | 47 | -i <data_file> File to import data from |
| 48 | --configonly Disable editing of operational data)"; |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 49 | #else |
| 50 | #error "Unknown CLI backend" |
| 51 | #endif |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 52 | |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 53 | const auto HISTORY_FILE_NAME = PROGRAM_NAME "_history"; |
| 54 | |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 55 | int main(int argc, char* argv[]) |
| 56 | { |
| 57 | auto args = docopt::docopt(usage, |
| 58 | {argv + 1, argv + argc}, |
| 59 | true, |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 60 | PROGRAM_NAME " " NETCONF_CLI_VERSION, |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 61 | true); |
Václav Kubernát | 28cf336 | 2020-06-29 17:52:51 +0200 | [diff] [blame] | 62 | WritableOps writableOps = WritableOps::No; |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 63 | |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 64 | #if defined(SYSREPO_CLI) |
Václav Kubernát | 715c85c | 2020-04-14 01:46:08 +0200 | [diff] [blame] | 65 | auto datastoreType = Datastore::Running; |
| 66 | if (const auto& ds = args["-d"]) { |
| 67 | if (ds.asString() == "startup") { |
| 68 | datastoreType = Datastore::Startup; |
| 69 | } else if (ds.asString() == "running") { |
| 70 | datastoreType = Datastore::Running; |
| 71 | } else { |
| 72 | std::cerr << PROGRAM_NAME << ": unknown datastore: " << ds.asString() << "\n"; |
| 73 | return 1; |
| 74 | } |
| 75 | } |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 76 | auto datastore = std::make_shared<SysrepoAccess>(PROGRAM_NAME, datastoreType); |
Václav Kubernát | 715c85c | 2020-04-14 01:46:08 +0200 | [diff] [blame] | 77 | std::cout << "Connected to sysrepo [datastore: " << (datastoreType == Datastore::Startup ? "startup" : "running") << "]" << std::endl; |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 78 | #elif defined(YANG_CLI) |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 79 | auto datastore = std::make_shared<YangAccess>(); |
Václav Kubernát | 28cf336 | 2020-06-29 17:52:51 +0200 | [diff] [blame] | 80 | if (args["--configonly"].asBool()) { |
| 81 | writableOps = WritableOps::No; |
| 82 | } else { |
| 83 | writableOps = WritableOps::Yes; |
| 84 | std::cout << "ops is writable" << std::endl; |
| 85 | } |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 86 | if (const auto& search_dir = args["-s"]) { |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 87 | datastore->addSchemaDir(search_dir.asString()); |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 88 | } |
Václav Kubernát | 619e654 | 2020-06-29 14:13:43 +0200 | [diff] [blame] | 89 | for (const auto& schemaFile : args["<schema_file_or_module_name>"].asStringList()) { |
| 90 | if (std::filesystem::exists(schemaFile)) { |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 91 | datastore->addSchemaFile(schemaFile); |
Václav Kubernát | 619e654 | 2020-06-29 14:13:43 +0200 | [diff] [blame] | 92 | } else if (schemaFile.find('/') == std::string::npos) { // Module names cannot have a slash |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 93 | datastore->loadModule(schemaFile); |
Václav Kubernát | 619e654 | 2020-06-29 14:13:43 +0200 | [diff] [blame] | 94 | } else { |
| 95 | std::cerr << "Cannot load YANG module " << schemaFile << "\n"; |
| 96 | } |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 97 | } |
| 98 | if (const auto& enableFeatures = args["-e"]) { |
| 99 | namespace x3 = boost::spirit::x3; |
| 100 | auto grammar = +(x3::char_-":") >> ":" >> +(x3::char_-":"); |
| 101 | for (const auto& enableFeature : enableFeatures.asStringList()) { |
| 102 | std::pair<std::string, std::string> parsed; |
| 103 | auto it = enableFeature.begin(); |
| 104 | auto res = x3::parse(it, enableFeature.cend(), grammar, parsed); |
| 105 | if (!res || it != enableFeature.cend()) { |
| 106 | std::cerr << "Error parsing feature enable flags: " << enableFeature << "\n"; |
| 107 | return 1; |
| 108 | } |
| 109 | try { |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 110 | datastore->enableFeature(parsed.first, parsed.second); |
Václav Kubernát | 74487df | 2020-06-04 01:29:28 +0200 | [diff] [blame] | 111 | } catch (std::runtime_error& ex) { |
| 112 | std::cerr << ex.what() << "\n"; |
| 113 | return 1; |
| 114 | } |
| 115 | |
| 116 | } |
| 117 | } |
Václav Kubernát | 548cb19 | 2020-06-26 14:00:42 +0200 | [diff] [blame] | 118 | if (const auto& dataFiles = args["-i"]) { |
| 119 | for (const auto& dataFile : dataFiles.asStringList()) { |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 120 | datastore->addDataFile(dataFile); |
Václav Kubernát | 548cb19 | 2020-06-26 14:00:42 +0200 | [diff] [blame] | 121 | } |
| 122 | } |
Václav Kubernát | b79f3ca | 2020-02-04 15:56:01 +0100 | [diff] [blame] | 123 | #else |
| 124 | #error "Unknown CLI backend" |
| 125 | #endif |
| 126 | |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 127 | ProxyDatastore proxyDatastore(datastore); |
| 128 | auto dataQuery = std::make_shared<DataQuery>(*datastore); |
| 129 | Parser parser(datastore->schema(), writableOps, dataQuery); |
Václav Kubernát | 395d92c | 2020-01-24 12:18:18 +0100 | [diff] [blame] | 130 | |
| 131 | using replxx::Replxx; |
| 132 | |
| 133 | Replxx lineEditor; |
| 134 | |
Václav Kubernát | 4863729 | 2020-07-08 16:54:13 +0200 | [diff] [blame] | 135 | lineEditor.bind_key(Replxx::KEY::meta(Replxx::KEY::BACKSPACE), [&lineEditor] (const auto& code) { |
| 136 | return lineEditor.invoke(Replxx::ACTION::KILL_TO_BEGINING_OF_WORD, code); |
| 137 | }); |
| 138 | lineEditor.bind_key(Replxx::KEY::control('W'), [&lineEditor] (const auto& code) { |
| 139 | return lineEditor.invoke(Replxx::ACTION::KILL_TO_WHITESPACE_ON_LEFT, code); |
| 140 | }); |
Václav Kubernát | 395d92c | 2020-01-24 12:18:18 +0100 | [diff] [blame] | 141 | |
| 142 | lineEditor.set_word_break_characters("\t _[]/:'\"=-%"); |
| 143 | |
Václav Kubernát | 1ed4aa3 | 2020-01-23 13:13:28 +0100 | [diff] [blame] | 144 | lineEditor.set_completion_callback([&parser](const std::string& input, int& context) { |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 145 | std::stringstream stream; |
Václav Kubernát | 1ed4aa3 | 2020-01-23 13:13:28 +0100 | [diff] [blame] | 146 | auto completions = parser.completeCommand(input, stream); |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 147 | |
Jan Kundrát | 8d8efe8 | 2019-10-18 10:21:36 +0200 | [diff] [blame] | 148 | std::vector<replxx::Replxx::Completion> res; |
Václav Kubernát | 1ed4aa3 | 2020-01-23 13:13:28 +0100 | [diff] [blame] | 149 | std::copy(completions.m_completions.begin(), completions.m_completions.end(), std::back_inserter(res)); |
| 150 | context = completions.m_contextLength; |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 151 | return res; |
| 152 | }); |
Václav Kubernát | 2b68461 | 2018-08-09 18:55:24 +0200 | [diff] [blame] | 153 | |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 154 | std::optional<std::string> historyFile; |
| 155 | if (auto xdgHome = getenv("XDG_DATA_HOME")) { |
| 156 | historyFile = std::string(xdgHome) + "/" + HISTORY_FILE_NAME; |
| 157 | } else if (auto home = getenv("HOME")) { |
| 158 | historyFile = std::string(home) + "/.local/share/" + HISTORY_FILE_NAME; |
| 159 | } |
| 160 | |
Václav Kubernát | 3a43323 | 2020-07-08 17:52:50 +0200 | [diff] [blame] | 161 | if (historyFile) { |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 162 | lineEditor.history_load(historyFile.value()); |
Václav Kubernát | 3a43323 | 2020-07-08 17:52:50 +0200 | [diff] [blame] | 163 | } |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 164 | |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 165 | while (true) { |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 166 | auto line = lineEditor.input(parser.currentNode() + "> "); |
| 167 | if (!line) { |
Václav Kubernát | 82bf131 | 2019-11-05 11:19:26 +0100 | [diff] [blame] | 168 | // If user pressed CTRL-C to abort the line, errno gets set to EAGAIN. |
| 169 | // If user pressed CTRL-D (for EOF), errno doesn't get set to EAGAIN, so we exit the program. |
| 170 | // I have no idea why replxx uses errno for this. |
| 171 | if (errno == EAGAIN) { |
| 172 | continue; |
| 173 | } else { |
| 174 | break; |
| 175 | } |
Václav Kubernát | 5b80e52 | 2019-01-25 12:17:03 +0100 | [diff] [blame] | 176 | } |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 177 | |
Jan Kundrát | e387702 | 2018-09-05 15:32:09 +0200 | [diff] [blame] | 178 | std::locale C_locale("C"); |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 179 | std::string_view view{line}; |
| 180 | if (std::all_of(view.begin(), view.end(), |
Jan Kundrát | e387702 | 2018-09-05 15:32:09 +0200 | [diff] [blame] | 181 | [C_locale](const auto c) { return std::isspace(c, C_locale);})) { |
| 182 | continue; |
| 183 | } |
| 184 | |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 185 | try { |
Václav Kubernát | 5b80e52 | 2019-01-25 12:17:03 +0100 | [diff] [blame] | 186 | command_ cmd = parser.parseCommand(line, std::cout); |
Václav Kubernát | 48e9dfa | 2020-07-08 10:55:12 +0200 | [diff] [blame^] | 187 | boost::apply_visitor(Interpreter(parser, proxyDatastore), cmd); |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 188 | } catch (InvalidCommandException& ex) { |
| 189 | std::cerr << ex.what() << std::endl; |
Václav Kubernát | c58e4aa | 2019-04-03 18:37:32 +0200 | [diff] [blame] | 190 | } catch (DatastoreException& ex) { |
| 191 | std::cerr << ex.what() << std::endl; |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 192 | } |
Václav Kubernát | 5b80e52 | 2019-01-25 12:17:03 +0100 | [diff] [blame] | 193 | |
Václav Kubernát | a395d33 | 2019-02-13 16:49:20 +0100 | [diff] [blame] | 194 | lineEditor.history_add(line); |
Václav Kubernát | ff2c9f6 | 2018-05-16 20:26:31 +0200 | [diff] [blame] | 195 | } |
| 196 | |
Václav Kubernát | 3a43323 | 2020-07-08 17:52:50 +0200 | [diff] [blame] | 197 | if (historyFile) { |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 198 | lineEditor.history_save(historyFile.value()); |
Václav Kubernát | 3a43323 | 2020-07-08 17:52:50 +0200 | [diff] [blame] | 199 | } |
Václav Kubernát | 435706e | 2019-02-20 18:05:59 +0100 | [diff] [blame] | 200 | |
Jan Kundrát | dc2b072 | 2018-03-02 14:13:37 +0100 | [diff] [blame] | 201 | return 0; |
| 202 | } |