From af77f4bc1e3fed4895278a78c527bb66ac21a7d9 Mon Sep 17 00:00:00 2001 From: john30 Date: Sun, 27 Oct 2019 09:27:22 +0100 Subject: [PATCH] add adjustable verbosity to listen command (fixes #163) --- src/ebusd/mainloop.cpp | 110 ++++++++++++++++++++++++++--------------- src/ebusd/mainloop.h | 8 +-- src/ebusd/network.cpp | 2 +- src/ebusd/network.h | 36 +++++++++----- 4 files changed, 101 insertions(+), 55 deletions(-) mode change 100755 => 100644 src/ebusd/mainloop.cpp mode change 100755 => 100644 src/ebusd/mainloop.h mode change 100755 => 100644 src/ebusd/network.cpp mode change 100755 => 100644 src/ebusd/network.h diff --git a/src/ebusd/mainloop.cpp b/src/ebusd/mainloop.cpp old mode 100755 new mode 100644 index 9229278c..f39729a5 --- a/src/ebusd/mainloop.cpp +++ b/src/ebusd/mainloop.cpp @@ -371,12 +371,12 @@ void MainLoop::run() { continue; } if (m_shutdown) { - netMessage->setResult("ERR: shutdown", "", cm_normal, now, true); + netMessage->setResult("ERR: shutdown", "", nullptr, now, true); break; } string request = netMessage->getRequest(); string user = netMessage->getUser(); - ClientMode mode = netMessage->getMode(&since); + ClientSettings settings = netMessage->getSettings(&since); if (!netMessage->isListeningMode()) { since = now; } @@ -384,9 +384,9 @@ void MainLoop::run() { bool connected = true; if (request.length() > 0) { logDebug(lf_main, ">>> %s", request.c_str()); - result_t result = decodeMessage(request, netMessage->isHttp(), &connected, &mode, &user, &reload, &ostream); + result_t result = decodeMessage(request, netMessage->isHttp(), &connected, &settings, &user, &reload, &ostream); if (!netMessage->isHttp() && (ostream.tellp() == 0 || result != RESULT_OK)) { - if (mode != cm_direct) { + if (settings.mode != cm_direct) { ostream.str(""); } ostream << getResultCode(result); @@ -399,25 +399,25 @@ void MainLoop::run() { if (ostream.tellp() == 0) { ostream << "\n"; // only for HTTP } else if (!netMessage->isHttp()) { - ostream << (mode == cm_direct ? "\n" : "\n\n"); + ostream << (settings.mode == cm_direct ? "\n" : "\n\n"); } } - if (mode == cm_listen) { + if (settings.mode == cm_listen) { string levels = getUserLevels(user); messages.clear(); m_messages->findAll("", "", levels, false, true, true, true, true, true, since, now, true, &messages); for (const auto message : messages) { ostream << message->getCircuit() << " " << message->getName() << " = " << dec; - message->decodeLastData(false, nullptr, -1, 0, &ostream); + message->decodeLastData(false, nullptr, -1, settings.format, &ostream); ostream << endl; } - } else if (mode == cm_direct) { + } else if (settings.mode == cm_direct) { if (m_busHandler->isGrabEnabled()) { m_busHandler->formatGrabResult(false, false, &ostream, true, since, now); } } // send result to client - netMessage->setResult(ostream.str(), user, mode, now, !connected); + netMessage->setResult(ostream.str(), user, &settings, now, !connected); } } @@ -462,7 +462,7 @@ void MainLoop::notifyDeviceData(symbol_t symbol, bool received) { } } -result_t MainLoop::decodeMessage(const string &data, bool isHttp, bool* connected, ClientMode* mode, +result_t MainLoop::decodeMessage(const string &data, bool isHttp, bool* connected, ClientSettings* settings, string* user, bool* reload, ostringstream* ostream) { string token, previous; istringstream stream(data); @@ -520,8 +520,8 @@ result_t MainLoop::decodeMessage(const string &data, bool isHttp, bool* connecte transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper); args.clear(); // empty args is used as command help indicator } - if (*mode == cm_direct) { - return executeDirect(args, mode, ostream); + if (settings->mode == cm_direct) { + return executeDirect(args, &settings->mode, ostream); } if (cmd.empty() && args.size() == 0) { return executeHelp(ostream); @@ -553,10 +553,10 @@ result_t MainLoop::decodeMessage(const string &data, bool isHttp, bool* connecte return executeFind(args, getUserLevels(*user), ostream); } if (cmd == "L" || cmd == "LISTEN") { - return executeListen(args, mode, ostream); + return executeListen(args, settings, ostream); } if (cmd == "DIRECT") { - return executeDirect(args, mode, ostream); + return executeDirect(args, &settings->mode, ostream); } if (cmd == "S" || cmd == "STATE") { return executeState(args, ostream); @@ -652,7 +652,7 @@ result_t MainLoop::executeAuth(const vector& args, string* user, ostring result_t MainLoop::executeRead(const vector& args, const string& levels, ostringstream* ostream) { size_t argPos = 1; - bool hex = false, newDefinition = false, numeric = false, valueName = false; + bool hex = false, newDefinition = false; OutputFormat verbosity = 0; time_t maxAge = 5*60; string circuit, params; @@ -699,10 +699,9 @@ result_t MainLoop::executeRead(const vector& args, const string& levels, } else if (args[argPos] == "-vvv" || args[argPos] == "-V") { verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS; } else if (args[argPos] == "-n") { - numeric = true; + verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC; } else if (args[argPos] == "-N") { - numeric = true; - valueName = true; + verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME; } else if (args[argPos] == "-c") { argPos++; if (argPos >= args.size()) { @@ -751,7 +750,7 @@ result_t MainLoop::executeRead(const vector& args, const string& levels, } argPos++; } - if ((hex && (newDefinition || numeric || verbosity != 0 || !circuit.empty() || !params.empty() || dstAddress != SYN + if ((hex && (newDefinition || verbosity != 0 || !circuit.empty() || !params.empty() || dstAddress != SYN || pollPriority > 0 || args.size() < argPos + 1)) || (newDefinition && (hex || !circuit.empty() || pollPriority > 0 || args.size() != argPos + 1))) { argPos = 0; // print usage @@ -895,7 +894,6 @@ result_t MainLoop::executeRead(const vector& args, const string& levels, if (!newDefinition && message != nullptr && pollPriority > 0 && message->setPollPriority(pollPriority)) { m_messages->addPollMessage(false, message); } - verbosity |= valueName ? OF_VALUENAME : numeric ? OF_NUMERIC : 0; bool allowCache = !newDefinition && srcAddress == SYN && dstAddress == SYN && maxAge > 0 && params.length() == 0; Message* cacheMessage = allowCache ? m_messages->find(circuit, name, levels, false, true) : nullptr; bool hasCache = cacheMessage != nullptr; @@ -1479,23 +1477,57 @@ result_t MainLoop::executeFind(const vector& args, const string& levels, return RESULT_OK; } -result_t MainLoop::executeListen(const vector& args, ClientMode* mode, ostringstream* ostream) { - if (args.size() == 1) { - if (*mode == cm_listen) { +result_t MainLoop::executeListen(const vector& args, ClientSettings* settings, ostringstream* ostream) { + size_t argPos = 1; + OutputFormat verbosity = 0; + while (args.size() > argPos && args[argPos][0] == '-') { + if (args[argPos] == "-v") { + switch (verbosity) { + case 0: + verbosity = OF_NAMES; + break; + case OF_NAMES: + verbosity |= OF_UNITS; + break; + case OF_NAMES|OF_UNITS: + verbosity |= OF_COMMENTS; + break; + } + } else if (args[argPos] == "-vv") { + verbosity |= OF_NAMES|OF_UNITS; + } else if (args[argPos] == "-vvv" || args[argPos] == "-V") { + verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS; + } else if (args[argPos] == "-n") { + verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC; + } else if (args[argPos] == "-N") { + verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME; + } else { + argPos = 0; // print usage + break; + } + argPos++; + } + if (argPos > 0 && args.size() == argPos) { + settings->format = verbosity; + if (settings->mode == cm_listen) { *ostream << "listen continued"; return RESULT_OK; } - *mode = cm_listen; + settings->mode = cm_listen; *ostream << "listen started"; return RESULT_OK; } - if (args.size() != 2 || args[1] != "stop") { - *ostream << "usage: listen [stop]\n" - " Listen for updates or stop it."; + if (argPos == 0 || args.size() != argPos + 1 || args[argPos] != "stop") { + *ostream << "usage: listen [-v|-V] [-n|-N] [stop]\n" + " Listen for updates or stop it.\n" + " -v increase verbosity (include names/units/comments)\n" + " -V be very verbose (include names, units, and comments)\n" + " -n use numeric value of value=name pairs\n" + " -N use numeric and named value of value=name pairs"; return RESULT_OK; } - *mode = cm_normal; + settings->mode = cm_normal; *ostream << "listen stopped"; return RESULT_OK; } @@ -1573,7 +1605,6 @@ result_t MainLoop::executeDefine(const vector& args, ostringstream* ostr result_t MainLoop::executeDecode(const vector& args, ostringstream* ostream) { size_t argPos = 1; - bool numeric = false, valueName = false; OutputFormat verbosity = 0; while (args.size() > argPos && args[argPos][0] == '-') { if (args[argPos] == "-v") { @@ -1593,10 +1624,9 @@ result_t MainLoop::executeDecode(const vector& args, ostringstream* ostr } else if (args[argPos] == "-vvv" || args[argPos] == "-V") { verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS; } else if (args[argPos] == "-n") { - numeric = true; + verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC; } else if (args[argPos] == "-N") { - numeric = true; - valueName = true; + verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME; } else { argPos = 0; // print usage break; @@ -1622,7 +1652,6 @@ result_t MainLoop::executeDecode(const vector& args, ostringstream* ostr time_t now; time(&now); - verbosity |= valueName ? OF_VALUENAME : numeric ? OF_NUMERIC : 0; istringstream defstr("#\n" + args[argPos]); // ensure first line is not used for determining col names string errorDescription; DataFieldTemplates* templates = getTemplates("*"); @@ -1865,7 +1894,7 @@ result_t MainLoop::executeHelp(ostringstream* ostream) { " hex Send hex data: hex [-s QQ] ZZPBSBNN[DD]* (if enabled)\n" " find|f Find message(s): find [-v|-V] [-r] [-w] [-p] [-a] [-d] [-h] [-i ID] [-f] [-F COL[,COL]*] [-e]" " [-c CIRCUIT] [-l LEVEL] [NAME]\n" - " listen|l Listen for updates: listen [stop]\n" + " listen|l Listen for updates: listen [-v|-V] [-n|-N] [stop]\n" " direct Enter direct mode\n" " state|s Report bus state\n" " info|i Report information about the daemon, the configuration, and seen devices.\n" @@ -1895,7 +1924,7 @@ bool parseBoolQuery(const string& value) { } result_t MainLoop::executeGet(const vector& args, bool* connected, ostringstream* ostream) { - bool numeric = false, valueName = false, required = false, full = false, withWrite = false, raw = false; + bool required = false, full = false, withWrite = false, raw = false; bool withDefinition = false; OutputFormat verbosity = OF_NAMES; time_t maxAge = -1; @@ -1945,9 +1974,13 @@ result_t MainLoop::executeGet(const vector& args, bool* connected, ostri verbosity &= ~OF_NAMES; } } else if (qname == "numeric") { - numeric = parseBoolQuery(value); + if (parseBoolQuery(value)) { + verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC; + } } else if (qname == "valuename") { - valueName = parseBoolQuery(value); + if (parseBoolQuery(value)) { + verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME; + } } else if (qname == "full") { full = parseBoolQuery(value); } else if (qname == "required") { @@ -1982,8 +2015,7 @@ result_t MainLoop::executeGet(const vector& args, bool* connected, ostri time_t maxLastUp = 0; if (ret == RESULT_OK) { bool first = true; - verbosity |= (valueName ? OF_VALUENAME : numeric ? OF_NUMERIC : 0) | OF_JSON | (full ? OF_ALL_ATTRS : 0) - | (withDefinition ? OF_DEFINTION : 0); + verbosity |= OF_JSON | (full ? OF_ALL_ATTRS : 0) | (withDefinition ? OF_DEFINTION : 0); deque messages; m_messages->findAll(circuit, name, getUserLevels(user), exact, true, withWrite, true, true, true, 0, 0, false, &messages); diff --git a/src/ebusd/mainloop.h b/src/ebusd/mainloop.h old mode 100755 new mode 100644 index f07f9866..742ce866 --- a/src/ebusd/mainloop.h +++ b/src/ebusd/mainloop.h @@ -144,13 +144,13 @@ class MainLoop : public Thread, DeviceListener { * @param data the data string to decode (may be empty). * @param connected set to false when the client connection shall be closed. * @param isHttp true for HTTP message. - * @param mode set to the new client mode. + * @param settings set to the new client settings. * @param user set to the new user name when changed by authentication. * @param reload set to true when the configuration files were reloaded. * @param ostream the @a ostringstream to format the result string to. * @return the result code. */ - result_t decodeMessage(const string& data, bool isHttp, bool* connected, ClientMode* mode, + result_t decodeMessage(const string& data, bool isHttp, bool* connected, ClientSettings* settings, string* user, bool* reload, ostringstream* ostream); /** @@ -238,11 +238,11 @@ class MainLoop : public Thread, DeviceListener { /** * Execute the listen command. * @param args the arguments passed to the command (starting with the command itself), or empty for help. - * @param mode set to the new client mode. + * @param settings set to the new client settings. * @param ostream the @a ostringstream to format the result string to. * @return the result code. */ - result_t executeListen(const vector& args, ClientMode* mode, ostringstream* ostream); + result_t executeListen(const vector& args, ClientSettings* settings, ostringstream* ostream); /** * Execute the state command. diff --git a/src/ebusd/network.cpp b/src/ebusd/network.cpp old mode 100755 new mode 100644 index b53831d5..dd6d0e30 --- a/src/ebusd/network.cpp +++ b/src/ebusd/network.cpp @@ -208,7 +208,7 @@ Network::~Network() { stop(); NetMessage* netMsg; while ((netMsg = m_netQueue->pop()) != nullptr) { - netMsg->setResult("ERR: shutdown", "", cm_normal, 0, true); + netMsg->setResult("ERR: shutdown", "", nullptr, 0, true); } while (!m_connections.empty()) { Connection* connection = m_connections.back(); diff --git a/src/ebusd/network.h b/src/ebusd/network.h old mode 100755 new mode 100644 index fdcabc05..cf3e8406 --- a/src/ebusd/network.h +++ b/src/ebusd/network.h @@ -23,6 +23,7 @@ #include #include #include +#include "lib/ebus/datatype.h" #include "lib/utils/tcpsocket.h" #include "lib/utils/queue.h" #include "lib/utils/notify.h" @@ -44,6 +45,14 @@ enum ClientMode { cm_direct, //!< direct mode }; +/** + * Combination of client settings. + */ +struct ClientSettings { + ClientMode mode; //!< the current client mode + OutputFormat format; //!< the output format settings for listen mode +}; + /** * Class for data/message transfer between @a Connection and @a MainLoop. */ @@ -54,7 +63,9 @@ class NetMessage { * @param isHttp whether this is a HTTP message. */ explicit NetMessage(bool isHttp) - : m_isHttp(isHttp), m_resultSet(false), m_disconnect(false), m_mode(cm_normal), m_listenSince(0) { + : m_isHttp(isHttp), m_resultSet(false), m_disconnect(false), m_listenSince(0) { + m_settings.mode = cm_normal; + m_settings.format = 0; pthread_mutex_init(&m_mutex, nullptr); pthread_cond_init(&m_cond, nullptr); } @@ -124,16 +135,19 @@ class NetMessage { * Set the result string and notify the waiting thread. * @param result the result string. * @param user the new user name. - * @param mode the new client mode. + * @param settings the new client settings. * @param listenUntil the end time to which to updates were added (exclusive). * @param disconnect true when the client shall be disconnected. */ - void setResult(const string& result, const string& user, ClientMode mode, time_t listenUntil, bool disconnect) { + void setResult(const string& result, const string& user, ClientSettings* settings, time_t listenUntil, + bool disconnect) { pthread_mutex_lock(&m_mutex); m_result = result; m_user = user; m_disconnect = disconnect; - m_mode = mode; + if (settings) { + m_settings = *settings; + } m_listenSince = listenUntil; m_resultSet = true; pthread_cond_signal(&m_cond); @@ -141,22 +155,22 @@ class NetMessage { } /** - * Return the client mode. + * Return the client settings. * @param listenSince set listening to the specified start time from which to add updates (inclusive). - * @return the client mode. + * @return the client settings. */ - ClientMode getMode(time_t* listenSince = nullptr) { + ClientSettings getSettings(time_t* listenSince = nullptr) { if (listenSince) { *listenSince = m_listenSince; } - return m_mode; + return m_settings; } /** * Return whether this instance is in one of the listening modes. * @return whether this instance is in one of the listening modes. */ - bool isListeningMode() { return m_mode == cm_listen || m_mode == cm_direct; } + bool isListeningMode() { return m_settings.mode == cm_listen || m_settings.mode == cm_direct; } /** * Return whether the client shall be disconnected. @@ -190,8 +204,8 @@ class NetMessage { /** condition variable for exclusive lock. */ pthread_cond_t m_cond; - /** the client mode. */ - ClientMode m_mode; + /** the client settings. */ + ClientSettings m_settings; /** start timestamp of listening update. */ time_t m_listenSince;