nils/ebusd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add adjustable verbosity to listen command (fixes #163)

Browse Source
This commit is contained in:
john30
2019-10-27 09:27:22 +01:00
parent 82d6a5b4a4
commit af77f4bc1e
4 changed files with 101 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ebusd/mainloop.cpp
Executable → Regular
+71 -39
View File
@@ -371,12 +371,12 @@ void MainLoop::run() {
continue; continue;
} }
if (m_shutdown) { if (m_shutdown) {
netMessage->setResult("ERR: shutdown", "", cm_normal, now, true); netMessage->setResult("ERR: shutdown", "", nullptr, now, true);
break; break;
} }
string request = netMessage->getRequest(); string request = netMessage->getRequest();
string user = netMessage->getUser(); string user = netMessage->getUser();
ClientMode mode = netMessage->getMode(&since); ClientSettings settings = netMessage->getSettings(&since);
if (!netMessage->isListeningMode()) { if (!netMessage->isListeningMode()) {
since = now; since = now;
} }
@@ -384,9 +384,9 @@ void MainLoop::run() {
bool connected = true; bool connected = true;
if (request.length() > 0) { if (request.length() > 0) {
logDebug(lf_main, ">>> %s", request.c_str()); 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 (!netMessage->isHttp() && (ostream.tellp() == 0 || result != RESULT_OK)) {
if (mode != cm_direct) { if (settings.mode != cm_direct) {
ostream.str(""); ostream.str("");
} }
ostream << getResultCode(result); ostream << getResultCode(result);
@@ -399,25 +399,25 @@ void MainLoop::run() {
if (ostream.tellp() == 0) { if (ostream.tellp() == 0) {
ostream << "\n"; // only for HTTP ostream << "\n"; // only for HTTP
} else if (!netMessage->isHttp()) { } 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); string levels = getUserLevels(user);
messages.clear(); messages.clear();
m_messages->findAll("", "", levels, false, true, true, true, true, true, since, now, true, &messages); m_messages->findAll("", "", levels, false, true, true, true, true, true, since, now, true, &messages);
for (const auto message : messages) { for (const auto message : messages) {
ostream << message->getCircuit() << " " << message->getName() << " = " << dec; ostream << message->getCircuit() << " " << message->getName() << " = " << dec;
message->decodeLastData(false, nullptr, -1, 0, &ostream); message->decodeLastData(false, nullptr, -1, settings.format, &ostream);
ostream << endl; ostream << endl;
} }
} else if (mode == cm_direct) { } else if (settings.mode == cm_direct) {
if (m_busHandler->isGrabEnabled()) { if (m_busHandler->isGrabEnabled()) {
m_busHandler->formatGrabResult(false, false, &ostream, true, since, now); m_busHandler->formatGrabResult(false, false, &ostream, true, since, now);
} }
} }
// send result to client // 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* user, bool* reload, ostringstream* ostream) {
string token, previous; string token, previous;
istringstream stream(data); 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); transform(cmd.begin(), cmd.end(), cmd.begin(), ::toupper);
args.clear(); // empty args is used as command help indicator args.clear(); // empty args is used as command help indicator
} }
if (*mode == cm_direct) { if (settings->mode == cm_direct) {
return executeDirect(args, mode, ostream); return executeDirect(args, &settings->mode, ostream);
} }
if (cmd.empty() && args.size() == 0) { if (cmd.empty() && args.size() == 0) {
return executeHelp(ostream); return executeHelp(ostream);
@@ -553,10 +553,10 @@ result_t MainLoop::decodeMessage(const string &data, bool isHttp, bool* connecte
return executeFind(args, getUserLevels(*user), ostream); return executeFind(args, getUserLevels(*user), ostream);
} }
if (cmd == "L" || cmd == "LISTEN") { if (cmd == "L" || cmd == "LISTEN") {
return executeListen(args, mode, ostream); return executeListen(args, settings, ostream);
} }
if (cmd == "DIRECT") { if (cmd == "DIRECT") {
return executeDirect(args, mode, ostream); return executeDirect(args, &settings->mode, ostream);
} }
if (cmd == "S" || cmd == "STATE") { if (cmd == "S" || cmd == "STATE") {
return executeState(args, ostream); return executeState(args, ostream);
@@ -652,7 +652,7 @@ result_t MainLoop::executeAuth(const vector<string>& args, string* user, ostring
result_t MainLoop::executeRead(const vector<string>& args, const string& levels, ostringstream* ostream) { result_t MainLoop::executeRead(const vector<string>& args, const string& levels, ostringstream* ostream) {
size_t argPos = 1; size_t argPos = 1;
bool hex = false, newDefinition = false, numeric = false, valueName = false; bool hex = false, newDefinition = false;
OutputFormat verbosity = 0; OutputFormat verbosity = 0;
time_t maxAge = 5*60; time_t maxAge = 5*60;
string circuit, params; string circuit, params;
@@ -699,10 +699,9 @@ result_t MainLoop::executeRead(const vector<string>& args, const string& levels,
} else if (args[argPos] == "-vvv" || args[argPos] == "-V") { } else if (args[argPos] == "-vvv" || args[argPos] == "-V") {
verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS; verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS;
} else if (args[argPos] == "-n") { } else if (args[argPos] == "-n") {
numeric = true; verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC;
} else if (args[argPos] == "-N") { } else if (args[argPos] == "-N") {
numeric = true; verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME;
valueName = true;
} else if (args[argPos] == "-c") { } else if (args[argPos] == "-c") {
argPos++; argPos++;
if (argPos >= args.size()) { if (argPos >= args.size()) {
@@ -751,7 +750,7 @@ result_t MainLoop::executeRead(const vector<string>& args, const string& levels,
} }
argPos++; 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)) || pollPriority > 0 || args.size() < argPos + 1))
|| (newDefinition && (hex || !circuit.empty() || pollPriority > 0 || args.size() != argPos + 1))) { || (newDefinition && (hex || !circuit.empty() || pollPriority > 0 || args.size() != argPos + 1))) {
argPos = 0; // print usage argPos = 0; // print usage
@@ -895,7 +894,6 @@ result_t MainLoop::executeRead(const vector<string>& args, const string& levels,
if (!newDefinition && message != nullptr && pollPriority > 0 && message->setPollPriority(pollPriority)) { if (!newDefinition && message != nullptr && pollPriority > 0 && message->setPollPriority(pollPriority)) {
m_messages->addPollMessage(false, message); 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; bool allowCache = !newDefinition && srcAddress == SYN && dstAddress == SYN && maxAge > 0 && params.length() == 0;
Message* cacheMessage = allowCache ? m_messages->find(circuit, name, levels, false, true) : nullptr; Message* cacheMessage = allowCache ? m_messages->find(circuit, name, levels, false, true) : nullptr;
bool hasCache = cacheMessage != nullptr; bool hasCache = cacheMessage != nullptr;
@@ -1479,23 +1477,57 @@ result_t MainLoop::executeFind(const vector<string>& args, const string& levels,
return RESULT_OK; return RESULT_OK;
} }
result_t MainLoop::executeListen(const vector<string>& args, ClientMode* mode, ostringstream* ostream) { result_t MainLoop::executeListen(const vector<string>& args, ClientSettings* settings, ostringstream* ostream) {
if (args.size() == 1) { size_t argPos = 1;
if (*mode == cm_listen) { 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"; *ostream << "listen continued";
return RESULT_OK; return RESULT_OK;
} }
*mode = cm_listen; settings->mode = cm_listen;
*ostream << "listen started"; *ostream << "listen started";
return RESULT_OK; return RESULT_OK;
} }
if (args.size() != 2 || args[1] != "stop") { if (argPos == 0 || args.size() != argPos + 1 || args[argPos] != "stop") {
*ostream << "usage: listen [stop]\n" *ostream << "usage: listen [-v|-V] [-n|-N] [stop]\n"
" Listen for updates or stop it."; " 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; return RESULT_OK;
} }
*mode = cm_normal; settings->mode = cm_normal;
*ostream << "listen stopped"; *ostream << "listen stopped";
return RESULT_OK; return RESULT_OK;
} }
@@ -1573,7 +1605,6 @@ result_t MainLoop::executeDefine(const vector<string>& args, ostringstream* ostr
result_t MainLoop::executeDecode(const vector<string>& args, ostringstream* ostream) { result_t MainLoop::executeDecode(const vector<string>& args, ostringstream* ostream) {
size_t argPos = 1; size_t argPos = 1;
bool numeric = false, valueName = false;
OutputFormat verbosity = 0; OutputFormat verbosity = 0;
while (args.size() > argPos && args[argPos][0] == '-') { while (args.size() > argPos && args[argPos][0] == '-') {
if (args[argPos] == "-v") { if (args[argPos] == "-v") {
@@ -1593,10 +1624,9 @@ result_t MainLoop::executeDecode(const vector<string>& args, ostringstream* ostr
} else if (args[argPos] == "-vvv" || args[argPos] == "-V") { } else if (args[argPos] == "-vvv" || args[argPos] == "-V") {
verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS; verbosity |= OF_NAMES|OF_UNITS|OF_COMMENTS;
} else if (args[argPos] == "-n") { } else if (args[argPos] == "-n") {
numeric = true; verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC;
} else if (args[argPos] == "-N") { } else if (args[argPos] == "-N") {
numeric = true; verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME;
valueName = true;
} else { } else {
argPos = 0; // print usage argPos = 0; // print usage
break; break;
@@ -1622,7 +1652,6 @@ result_t MainLoop::executeDecode(const vector<string>& args, ostringstream* ostr
time_t now; time_t now;
time(&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 istringstream defstr("#\n" + args[argPos]); // ensure first line is not used for determining col names
string errorDescription; string errorDescription;
DataFieldTemplates* templates = getTemplates("*"); 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" " 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]" " 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" " [-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" " direct Enter direct mode\n"
" state|s Report bus state\n" " state|s Report bus state\n"
" info|i Report information about the daemon, the configuration, and seen devices.\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<string>& args, bool* connected, ostringstream* ostream) { result_t MainLoop::executeGet(const vector<string>& 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; bool withDefinition = false;
OutputFormat verbosity = OF_NAMES; OutputFormat verbosity = OF_NAMES;
time_t maxAge = -1; time_t maxAge = -1;
@@ -1945,9 +1974,13 @@ result_t MainLoop::executeGet(const vector<string>& args, bool* connected, ostri
verbosity &= ~OF_NAMES; verbosity &= ~OF_NAMES;
} }
} else if (qname == "numeric") { } else if (qname == "numeric") {
numeric = parseBoolQuery(value); if (parseBoolQuery(value)) {
verbosity = (verbosity & ~OF_VALUENAME) | OF_NUMERIC;
}
} else if (qname == "valuename") { } else if (qname == "valuename") {
valueName = parseBoolQuery(value); if (parseBoolQuery(value)) {
verbosity = (verbosity & ~OF_NUMERIC) | OF_VALUENAME;
}
} else if (qname == "full") { } else if (qname == "full") {
full = parseBoolQuery(value); full = parseBoolQuery(value);
} else if (qname == "required") { } else if (qname == "required") {
@@ -1982,8 +2015,7 @@ result_t MainLoop::executeGet(const vector<string>& args, bool* connected, ostri
time_t maxLastUp = 0; time_t maxLastUp = 0;
if (ret == RESULT_OK) { if (ret == RESULT_OK) {
bool first = true; bool first = true;
verbosity |= (valueName ? OF_VALUENAME : numeric ? OF_NUMERIC : 0) | OF_JSON | (full ? OF_ALL_ATTRS : 0) verbosity |= OF_JSON | (full ? OF_ALL_ATTRS : 0) | (withDefinition ? OF_DEFINTION : 0);
| (withDefinition ? OF_DEFINTION : 0);
deque<Message*> messages; deque<Message*> messages;
m_messages->findAll(circuit, name, getUserLevels(user), exact, true, withWrite, true, true, true, 0, 0, false, m_messages->findAll(circuit, name, getUserLevels(user), exact, true, withWrite, true, true, true, 0, 0, false,
&messages); &messages);
src/ebusd/mainloop.h
Executable → Regular
+4 -4
View File
@@ -144,13 +144,13 @@ class MainLoop : public Thread, DeviceListener {
* @param data the data string to decode (may be empty). * @param data the data string to decode (may be empty).
* @param connected set to false when the client connection shall be closed. * @param connected set to false when the client connection shall be closed.
* @param isHttp true for HTTP message. * @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 user set to the new user name when changed by authentication.
* @param reload set to true when the configuration files were reloaded. * @param reload set to true when the configuration files were reloaded.
* @param ostream the @a ostringstream to format the result string to. * @param ostream the @a ostringstream to format the result string to.
* @return the result code. * @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); string* user, bool* reload, ostringstream* ostream);
/** /**
@@ -238,11 +238,11 @@ class MainLoop : public Thread, DeviceListener {
/** /**
* Execute the listen command. * Execute the listen command.
* @param args the arguments passed to the command (starting with the command itself), or empty for help. * @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. * @param ostream the @a ostringstream to format the result string to.
* @return the result code. * @return the result code.
*/ */
result_t executeListen(const vector<string>& args, ClientMode* mode, ostringstream* ostream); result_t executeListen(const vector<string>& args, ClientSettings* settings, ostringstream* ostream);
/** /**
* Execute the state command. * Execute the state command.
src/ebusd/network.cpp
Executable → Regular
+1 -1
View File
@@ -208,7 +208,7 @@ Network::~Network() {
stop(); stop();
NetMessage* netMsg; NetMessage* netMsg;
while ((netMsg = m_netQueue->pop()) != nullptr) { 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()) { while (!m_connections.empty()) {
Connection* connection = m_connections.back(); Connection* connection = m_connections.back();
src/ebusd/network.h
Executable → Regular
+25 -11
View File
@@ -23,6 +23,7 @@
#include <cstdio> #include <cstdio>
#include <algorithm> #include <algorithm>
#include <list> #include <list>
#include "lib/ebus/datatype.h"
#include "lib/utils/tcpsocket.h" #include "lib/utils/tcpsocket.h"
#include "lib/utils/queue.h" #include "lib/utils/queue.h"
#include "lib/utils/notify.h" #include "lib/utils/notify.h"
@@ -44,6 +45,14 @@ enum ClientMode {
cm_direct, //!< direct mode 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. * 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. * @param isHttp whether this is a HTTP message.
*/ */
explicit NetMessage(bool isHttp) 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_mutex_init(&m_mutex, nullptr);
pthread_cond_init(&m_cond, nullptr); pthread_cond_init(&m_cond, nullptr);
} }
@@ -124,16 +135,19 @@ class NetMessage {
* Set the result string and notify the waiting thread. * Set the result string and notify the waiting thread.
* @param result the result string. * @param result the result string.
* @param user the new user name. * @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 listenUntil the end time to which to updates were added (exclusive).
* @param disconnect true when the client shall be disconnected. * @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); pthread_mutex_lock(&m_mutex);
m_result = result; m_result = result;
m_user = user; m_user = user;
m_disconnect = disconnect; m_disconnect = disconnect;
m_mode = mode; if (settings) {
m_settings = *settings;
}
m_listenSince = listenUntil; m_listenSince = listenUntil;
m_resultSet = true; m_resultSet = true;
pthread_cond_signal(&m_cond); 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). * @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) { if (listenSince) {
*listenSince = m_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.
* @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. * Return whether the client shall be disconnected.
@@ -190,8 +204,8 @@ class NetMessage {
/** condition variable for exclusive lock. */ /** condition variable for exclusive lock. */
pthread_cond_t m_cond; pthread_cond_t m_cond;
/** the client mode. */ /** the client settings. */
ClientMode m_mode; ClientSettings m_settings;
/** start timestamp of listening update. */ /** start timestamp of listening update. */
time_t m_listenSince; time_t m_listenSince;