/*
* EMS-ESP - https://github.com/emsesp/EMS-ESP
* Copyright 2020-2025 emsesp.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
#include "emsesp.h"
using ::uuid::console::Shell;
namespace emsesp {
WebLogService::WebLogService(AsyncWebServer * server, SecurityManager * securityManager)
: events_(EMSESP_EVENT_SOURCE_LOG_PATH) {
// there is a GET and a POST for LogSettings endpoint, in one function
securityManager->addEndpoint(
server,
EMSESP_LOG_SETTINGS_PATH,
AuthenticationPredicates::IS_AUTHENTICATED,
[this](AsyncWebServerRequest * request, JsonVariant json) { getSetValues(request, json); },
HTTP_ANY);
// Add authentication filter to EventSource
// EventSource (SSE) cannot use custom headers, so authentication is done via URL parameter
// events_.setFilter(securityManager->filterRequest(AuthenticationPredicates::IS_AUTHENTICATED));
server->addHandler(&events_);
}
// start the log service with INFO level
void WebLogService::begin() {
level_ = uuid::log::Level::INFO;
uuid::log::Logger::register_handler(this, level_);
}
// apply the user settings
void WebLogService::start() {
EMSESP::webSettingsService.read([&](WebSettings & settings) {
maximum_log_messages_ = settings.weblog_buffer;
limit_log_messages_ = maximum_log_messages_;
compact_ = settings.weblog_compact;
level_ = (uuid::log::Level)settings.weblog_level;
});
uuid::log::Logger::register_handler(this, level_);
if (level_ == uuid::log::Level::OFF) {
log_messages_.clear();
}
}
size_t WebLogService::num_log_messages() const {
return log_messages_.size();
}
WebLogService::QueuedLogMessage::QueuedLogMessage(unsigned long id, uint64_t uptime, uuid::log::Level level, const char * name, std::string text)
: id_(id)
, uptime_(uptime)
, level_(level)
, name_(name)
, text_(text.c_str()) {
}
void WebLogService::operator<<(std::shared_ptr message) {
#ifndef EMSESP_STANDALONE
if (emsesp::EMSESP::system_.PSram()) {
limit_log_messages_ = maximum_log_messages_;
} else {
uint32_t maxAlloc = ESP.getMaxAllocHeap();
if (limit_log_messages_ > 5 && maxAlloc < (50 * 1024)) { // 50k
--limit_log_messages_;
} else if (limit_log_messages_ < maximum_log_messages_ && maxAlloc > (60 * 1024)) { // 60k
++limit_log_messages_;
}
}
#endif
while (log_messages_.size() >= limit_log_messages_) {
log_messages_.pop_front();
}
log_messages_.emplace_back(++log_message_id_, message->uptime_ms, message->level, message->name, message->text.c_str());
}
// dumps out the contents of log buffer to shell console
void WebLogService::show(Shell & shell) {
if (log_messages_.empty()) {
return;
}
shell.println();
shell.printfln("Recent Log:");
shell.println();
for (const auto & message : log_messages_) {
char time_string[26];
shell.print(messagetime(time_string, message.uptime_, sizeof(time_string)));
shell.printf(" %c %lu: [%s] ", uuid::log::format_level_char(message.level_), message.id_, message.name_);
if ((message.level_ == uuid::log::Level::ERR) || (message.level_ == uuid::log::Level::WARNING)) {
shell.print(COLOR_RED);
shell.println(message.text_.c_str());
shell.print(COLOR_RESET);
} else if (message.level_ == uuid::log::Level::INFO) {
shell.print(COLOR_YELLOW);
shell.println(message.text_.c_str());
shell.print(COLOR_RESET);
} else if (message.level_ == uuid::log::Level::DEBUG) {
shell.print(COLOR_CYAN);
shell.println(message.text_.c_str());
shell.print(COLOR_RESET);
} else {
shell.println(message.text_.c_str());
}
}
shell.println();
}
void WebLogService::loop() {
if (!events_.count() || log_messages_.empty() || events_.avgPacketsWaiting() >= SSE_MAX_QUEUED_MESSAGES) {
return;
}
// see if we've advanced
if (log_messages_.back().id_ <= log_message_id_tail_) {
return;
}
/*
// put a small delay in - https://github.com/emsesp/EMS-ESP32/issues/1652
if (uuid::get_uptime_ms() - last_transmit_ < REFRESH_SYNC) {
return;
}
last_transmit_ = uuid::get_uptime_ms();
*/
// flush
for (const auto & message : log_messages_) {
if (message.id_ > log_message_id_tail_) {
transmit(message);
return;
}
}
}
// convert time to real offset
char * WebLogService::messagetime(char * out, const uint64_t t, const size_t bufsize) {
time_t offset = time(nullptr) - uuid::get_uptime_sec();
if (offset < 1500000000L) {
strlcpy(out, uuid::log::format_timestamp_ms(t, 3).c_str(), bufsize);
} else {
time_t t1 = offset + (time_t)(t / 1000);
char timestr[25];
strftime(timestr, 25, "%FT%T", localtime(&t1));
snprintf(out, bufsize, "%s.%03d", timestr, (uint16_t)(t % 1000));
}
return out;
}
// send to web eventsource
void WebLogService::transmit(const QueuedLogMessage & message) {
JsonDocument jsonDocument;
JsonObject logEvent = jsonDocument.to();
char time_string[25];
logEvent["t"] = messagetime(time_string, message.uptime_, sizeof(time_string));
logEvent["l"] = message.level_; // .content_->level;
logEvent["i"] = message.id_;
logEvent["n"] = message.name_; // content_->name;
logEvent["m"] = message.text_; // content_->text;
size_t len = measureJson(jsonDocument) + 1;
char * buffer = new char[len];
if (buffer) {
serializeJson(jsonDocument, buffer, len);
events_.send(buffer, "message", message.id_);
log_message_id_tail_ = message.id_;
}
delete[] buffer;
}
// sets the values after a POST
void WebLogService::getSetValues(AsyncWebServerRequest * request, JsonVariant json) {
if ((request->method() == HTTP_GET) || (!json.is())) {
// GET - return the values
auto * response = new AsyncJsonResponse(false);
JsonObject root = response->getRoot();
root["level"] = level_;
root["max_messages"] = maximum_log_messages_;
root["compact"] = compact_;
root["psram"] = (EMSESP::system_.PSram() > 0);
root["developer_mode"] = EMSESP::system_.developer_mode();
response->setLength();
request->send(response);
// reset the tail pointer so complete log is sent
log_message_id_tail_ = 0;
return;
}
// POST - write the settings
level_ = json["level"];
maximum_log_messages_ = json["max_messages"];
compact_ = json["compact"];
uuid::log::Logger::register_handler(this, level_);
if (level_ == uuid::log::Level::OFF) {
log_messages_.clear();
}
if (limit_log_messages_ > maximum_log_messages_) {
limit_log_messages_ = maximum_log_messages_;
while (log_messages_.size() > limit_log_messages_) {
log_messages_.pop_front();
}
}
EMSESP::webSettingsService.update([&](WebSettings & settings) {
settings.weblog_compact = compact_;
settings.weblog_level = level_;
settings.weblog_buffer = maximum_log_messages_;
return StateUpdateResult::CHANGED;
});
request->send(200); // OK
}
} // namespace emsesp