From 8ad57633ae1122c94b82550101e32aa99d72e768 Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Fri, 10 Sep 2021 15:59:10 +0200 Subject: [PATCH 1/4] Implement simple area sorted logs --- core/include/data_types.h | 1 + core/include/logger/writer_full.h | 7 +++++++ core/src/logger/u_logger.cpp | 9 +++++++++ core/src/logger/writer_full.cpp | 11 +++++++++++ 4 files changed, 28 insertions(+) diff --git a/core/include/data_types.h b/core/include/data_types.h index 4983f86..f6385e8 100644 --- a/core/include/data_types.h +++ b/core/include/data_types.h @@ -42,6 +42,7 @@ public: enum class LogType { MODCALL, FULL, + FULLAREA }; Q_ENUM(LogType) }; diff --git a/core/include/logger/writer_full.h b/core/include/logger/writer_full.h index ce1677c..33abe87 100644 --- a/core/include/logger/writer_full.h +++ b/core/include/logger/writer_full.h @@ -50,6 +50,13 @@ public: */ void flush(const QString f_entry); + /** + * @brief Writes log entry into area seperated logfiles. + * @param Preformatted QString which will be written into the logfile + * @param Area name of the target logfile. + */ + void flushArea(const QString f_entry, const QString f_areaName); + private: /** * @brief Filename of the logfile used. This will always be the time the server starts up. diff --git a/core/src/logger/u_logger.cpp b/core/src/logger/u_logger.cpp index 5e2bcea..badc6d8 100644 --- a/core/src/logger/u_logger.cpp +++ b/core/src/logger/u_logger.cpp @@ -27,6 +27,9 @@ ULogger::ULogger(QObject* parent) : case DataTypes::LogType::FULL : writerFull = new WriterFull; break; + case DataTypes::LogType::FULLAREA : + writerFull = new WriterFull; + break; } } @@ -39,6 +42,9 @@ ULogger::~ULogger() case DataTypes::LogType::FULL : writerFull->deleteLater(); break; + case DataTypes::LogType::FULLAREA : + writerFull->deleteLater(); + break; } } @@ -148,6 +154,9 @@ void ULogger::updateAreaBuffer(const QString& f_areaName, const QString& f_logEn if (ConfigManager::loggingType() == DataTypes::LogType::FULL){ writerFull->flush(f_logEntry); } + if (ConfigManager::loggingType() == DataTypes::LogType::FULLAREA) { + writerFull->flushArea(f_logEntry, f_areaName); + } } QQueue ULogger::buffer(const QString& f_areaName) diff --git a/core/src/logger/writer_full.cpp b/core/src/logger/writer_full.cpp index 613b6c4..6a6827c 100644 --- a/core/src/logger/writer_full.cpp +++ b/core/src/logger/writer_full.cpp @@ -30,6 +30,17 @@ void WriterFull::flush(const QString f_entry) { l_logfile.setFileName(QString("logs/%1.log").arg(QDate::currentDate().toString("yyyy-MM-dd"))); + if (l_logfile.open(QIODevice::WriteOnly | QIODevice::Append)) { + QTextStream file_stream(&l_logfile); + file_stream << f_entry; + } + l_logfile.close(); +} + +void WriterFull::flushArea(const QString f_entry, const QString f_areaName) +{ + l_logfile.setFileName(QString("logs/%1_%2.log").arg(f_areaName, QDate::currentDate().toString("yyyy-MM-dd"))); + if (l_logfile.open(QIODevice::WriteOnly | QIODevice::Append)) { QTextStream file_stream(&l_logfile); file_stream << f_entry; From f24d16eb68eaf62c5823753e8471df245a4e8872 Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Fri, 10 Sep 2021 18:39:02 +0200 Subject: [PATCH 2/4] Remove old log definitions from area_data.h Apparently I completely forgot about those. --- core/include/area_data.h | 56 ---------------------------------------- 1 file changed, 56 deletions(-) diff --git a/core/include/area_data.h b/core/include/area_data.h index f6f7e3c..2bdad36 100644 --- a/core/include/area_data.h +++ b/core/include/area_data.h @@ -766,62 +766,6 @@ class AreaData : public QObject { */ void toggleMusic(); - /** - * @brief Logs a packet in the area's logger. - * - * @details Logs IC, OOC and modcall packets. Anything else is discarded. - * - * This function is a convenience function over the Logger's log functions. - * - * If you wish to log a login attempt, use logLogin() instead. - * - * @param f_clientName_r The showname of the packet sender's character. - * @param f_clientIpid_r The IPID of the packet sender. - * @param f_packet_r The packet that was sent. - */ - void log(const QString& f_clientName_r, const QString& f_clientIpid_r, const AOPacket& f_packet_r) const; - - /** - * @brief Logs a moderator login attempt. - * - * @details This is not a duplicated function! When a client uses the `/login` command to log in, the command call - * itself is logged with logCmd(), but the outcome of that call is logged here. - * - * If there was a way to login *without* the command, only this would be logged. - * - * @param f_clientName_r The showname of the login attempt sender's character. - * @param f_clientIpid_r The IPID of the client attempting login. - * @param f_success The outcome of the login attempt. - * @param f_modname_r The moderator name the client attempted to log in with. - */ - void logLogin(const QString &f_clientName_r, const QString &f_clientIpid_r, bool f_success, const QString& f_modname_r) const; - - /** - * @brief Logs a command in the area logger. - * - * @details When a client sends any packet containing `/`, it is sent to this function instead of log(). - * - * @param f_clientName_r The showname of the command sender's character. - * @param f_clientIpid_r The IPID of the command sender. - * @param f_command_r The command that was sent. - * @param f_cmdArgs_r The arguments of the command - */ - void logCmd(const QString& f_clientName_r, const QString& f_clientIpid_r, const QString& f_command_r, const QStringList& f_cmdArgs_r) const; - - /** - * @brief Convenience function over Logger::flush(). - */ - void flushLogs() const; - - /** - * @brief Returns a copy of the underlying logger's buffer. - * - * @return See short description. - * - * @see #m_ignoreBgList - */ - QQueue buffer() const; - /** * @brief Returns whether the BG list is ignored in this araa. * From c7181dfcd6546f52b6a5fe205c0a5e5305b39a17 Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Fri, 10 Sep 2021 18:51:39 +0200 Subject: [PATCH 3/4] Document change in config.ini --- bin/config_sample/config.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index f89cfd9..411b453 100644 --- a/bin/config_sample/config.ini +++ b/bin/config_sample/config.ini @@ -39,9 +39,10 @@ modpass=changeme ; This is only used for modcall logging, or if the webhook_sendfile is enabled. logbuffer=500 -; The server logging type. Valid values here are "modcall" and "full". +; The server logging type. Valid values here are "modcall","full" and "fullarea". ; Modcall logging will only save an area log file if a modcall is sent. ; Full logging will log every event in every area, and will output to a new file every day. +; FullArea logging will log every event in every area, seperating them into individual files and output to a new one every day. logging=modcall ; The maximum number of statements that can be recorded in the testimony recorder. From fec1722697dca1f26c6570c94cae504eec3280cf Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Fri, 10 Sep 2021 20:38:27 +0200 Subject: [PATCH 4/4] Overload flush method and un-stupid the switch case --- core/include/logger/writer_full.h | 2 +- core/src/logger/u_logger.cpp | 6 +----- core/src/logger/writer_full.cpp | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/core/include/logger/writer_full.h b/core/include/logger/writer_full.h index 33abe87..6156332 100644 --- a/core/include/logger/writer_full.h +++ b/core/include/logger/writer_full.h @@ -55,7 +55,7 @@ public: * @param Preformatted QString which will be written into the logfile * @param Area name of the target logfile. */ - void flushArea(const QString f_entry, const QString f_areaName); + void flush(const QString f_entry, const QString f_areaName); private: /** diff --git a/core/src/logger/u_logger.cpp b/core/src/logger/u_logger.cpp index badc6d8..c416a3b 100644 --- a/core/src/logger/u_logger.cpp +++ b/core/src/logger/u_logger.cpp @@ -25,8 +25,6 @@ ULogger::ULogger(QObject* parent) : writerModcall = new WriterModcall; break; case DataTypes::LogType::FULL : - writerFull = new WriterFull; - break; case DataTypes::LogType::FULLAREA : writerFull = new WriterFull; break; @@ -40,8 +38,6 @@ ULogger::~ULogger() writerModcall->deleteLater(); break; case DataTypes::LogType::FULL : - writerFull->deleteLater(); - break; case DataTypes::LogType::FULLAREA : writerFull->deleteLater(); break; @@ -155,7 +151,7 @@ void ULogger::updateAreaBuffer(const QString& f_areaName, const QString& f_logEn writerFull->flush(f_logEntry); } if (ConfigManager::loggingType() == DataTypes::LogType::FULLAREA) { - writerFull->flushArea(f_logEntry, f_areaName); + writerFull->flush(f_logEntry, f_areaName); } } diff --git a/core/src/logger/writer_full.cpp b/core/src/logger/writer_full.cpp index 6a6827c..ea99842 100644 --- a/core/src/logger/writer_full.cpp +++ b/core/src/logger/writer_full.cpp @@ -37,7 +37,7 @@ void WriterFull::flush(const QString f_entry) l_logfile.close(); } -void WriterFull::flushArea(const QString f_entry, const QString f_areaName) +void WriterFull::flush(const QString f_entry, const QString f_areaName) { l_logfile.setFileName(QString("logs/%1_%2.log").arg(f_areaName, QDate::currentDate().toString("yyyy-MM-dd")));