From 0cfaf25f660b4183a9bb5b90e4f6923d43263cb1 Mon Sep 17 00:00:00 2001
From: Salanto <62221668+Salanto@users.noreply.github.com>
Date: Wed, 25 Aug 2021 06:13:02 +0200
Subject: [PATCH] Fix Webhook Buffer, Fix QStringLiteral Arg missing
---
core/core.pro | 2 -
core/include/area_data.h | 1 -
core/include/logger.h | 140 ---------------------------------
core/include/logger/u_logger.h | 12 +--
core/include/server.h | 5 ++
core/src/area_data.cpp | 35 ---------
core/src/logger.cpp | 121 ----------------------------
core/src/logger/u_logger.cpp | 2 +-
core/src/packets.cpp | 16 ++--
core/src/server.cpp | 5 ++
10 files changed, 22 insertions(+), 317 deletions(-)
delete mode 100644 core/include/logger.h
delete mode 100644 core/src/logger.cpp
diff --git a/core/core.pro b/core/core.pro
index 8399589..6b05671 100644
--- a/core/core.pro
+++ b/core/core.pro
@@ -40,7 +40,6 @@ SOURCES += \
src/config_manager.cpp \
src/db_manager.cpp \
src/discord.cpp \
- src/logger.cpp \
src/packets.cpp \
src/server.cpp \
src/testimony_recorder.cpp \
@@ -60,7 +59,6 @@ HEADERS += include/advertiser.h \
include/data_types.h \
include/db_manager.h \
include/discord.h \
- include/logger.h \
include/server.h \
include/ws_client.h \
include/ws_proxy.h \
diff --git a/core/include/area_data.h b/core/include/area_data.h
index 0aeef05..f6f7e3c 100644
--- a/core/include/area_data.h
+++ b/core/include/area_data.h
@@ -18,7 +18,6 @@
#ifndef AREA_DATA_H
#define AREA_DATA_H
-#include "logger.h"
#include "aopacket.h"
#include "config_manager.h"
diff --git a/core/include/logger.h b/core/include/logger.h
deleted file mode 100644
index 63d5ef0..0000000
--- a/core/include/logger.h
+++ /dev/null
@@ -1,140 +0,0 @@
-//////////////////////////////////////////////////////////////////////////////////////
-// akashi - a server for Attorney Online 2 //
-// Copyright (C) 2020 scatterflower //
-// //
-// This program is free software: you can redistribute it and/or modify //
-// it under the terms of the GNU Affero 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 Affero General Public License for more details. //
-// //
-// You should have received a copy of the GNU Affero General Public License //
-// along with this program. If not, see . //
-//////////////////////////////////////////////////////////////////////////////////////
-#ifndef LOGGER_H
-#define LOGGER_H
-
-#include
-#include
-#include
-#include
-#include
-#include "data_types.h"
-
-/**
- * @brief A class associated with an AreaData class to log various events happening inside the latter.
- */
-class Logger
-{
-public:
- /**
- * @brief Constructs a Logger instance.
- *
- * @param f_max_length The maximum amount of entries the Logger can store at once.
- */
- Logger(QString f_area_name, int f_max_length, const DataTypes::LogType& f_logType_r) :
- m_maxLength(f_max_length), m_areaName(f_area_name), m_logType(f_logType_r) {};
-
- /**
- *@brief Returns a copy of the logger's buffer.
- */
- QQueue buffer() const;
-
-public slots:
- /**
- * @brief Logs an IC message.
- *
- * @param f_charName_r The character name of the client who sent the IC message.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param f_message_r The text of the IC message.
- */
- void logIC(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_message_r, const QString& f_showname);
-
- /**
- * @brief Logs an OOC message.
- *
- * @param f_areaName_r The name of the area where the event happened.
- * @param f_charName_r The character name of the client who sent the OOC message.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param f_message_r The text of the OOC message.
- */
- void logOOC(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_message_r);
-
- /**
- * @brief Logs a mod call message.
- *
- * @param f_charName_r The character name of the client who sent the mod call.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param f_modcallReason_r The reason for the modcall.
- */
- void logModcall(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_modcallReason_r);
-
- /**
- * @brief Logs a command called in OOC.
- *
- * @details If the command is not one of any of the 'special' ones, it defaults to logOOC().
- * The only thing that makes a command 'special' if it is handled differently in here.
- *
- * @param f_charName_r The character name of the client who sent the command.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param f_command_r The command being logged.
- * @param f_cmdArgs_r The command arguments being logged.
- */
- void logCmd(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_command_r, const QStringList& f_cmdArgs_r);
-
- /**
- * @brief Logs a login attempt.
- *
- * @param f_charName_r The character name of the client that attempted to login.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param success True if the client successfully authenticated as a mod.
- * @param f_modname_r If the client logged in with a modname, then this is it. Otherwise, it's `"moderator"`.
- */
- void logLogin(const QString& f_charName_r, const QString& f_ipid_r, bool success, const QString& f_modname_r);
-
- /**
- * @brief Appends the contents of #buffer into `config/server.log`, emptying the former.
- */
- void flush();
-
-private:
- /**
- * @brief Contains entries that have not yet been flushed out into a log file.
- */
- QQueue m_buffer;
-
- /**
- * @brief Convenience function to add an entry to #buffer.
- *
- * @details If the buffer's size is equal to #max_length, the first entry in the queue is removed,
- * and the newest entry is added to the end.
- *
- * @param f_charName_r The character name of the client who 'caused' the source event for the entry to happen.
- * @param f_ipid_r The IPID of the aforementioned client.
- * @param f_type_r The type of entry that is being built, something that uniquely identifies entries of similar being.
- * @param f_message_r Any additional information related to the entry.
- */
- void addEntry(const QString& f_charName_r, const QString& f_ipid_r,
- const QString& f_type_r, const QString& f_message_r);
-
- /**
- * @brief The max amount of entries that may be contained in #buffer.
- */
- int m_maxLength;
-
- QString m_areaName;
-
- /**
- * @brief Determines what kind of logging happens, `"full"` or `"modcall"`.
- *
- * @details This largely influences the resulting log file's name, and in case of a `"full"` setup,
- * the in-memory buffer is auto-dumped to said file if full.
- */
- DataTypes::LogType m_logType;
-};
-
-#endif // LOGGER_H
diff --git a/core/include/logger/u_logger.h b/core/include/logger/u_logger.h
index 1e04453..9a70398 100644
--- a/core/include/logger/u_logger.h
+++ b/core/include/logger/u_logger.h
@@ -45,6 +45,12 @@ public:
*/
virtual ~ULogger();
+ /**
+ * @brief Returns the buffer of a respective area. Primarily used by the Discord Webhook.
+ * @param Name of the area which buffer is requested.
+ */
+ QQueue buffer(const QString &f_areaName);
+
public slots:
/**
@@ -100,12 +106,6 @@ private:
*/
void updateAreaBuffer(const QString& f_areaName, const QString& f_logEntry);
- /**
- * @brief Returns the buffer of a respective area. Primarily used by the Discord Webhook.
- * @param Name of the area which buffer is requested.
- */
- QQueue buffer(const QString &f_areaName);
-
/**
* @brief QMap of all available area buffers.
*
diff --git a/core/include/server.h b/core/include/server.h
index dfb9c27..6b2b621 100644
--- a/core/include/server.h
+++ b/core/include/server.h
@@ -149,6 +149,11 @@ class Server : public QObject {
*/
void updateHTTPAdvertiserConfig();
+ /**
+ * @brief Getter for an area specific buffer from the logger.
+ */
+ QQueue getAreaBuffer(const QString& f_areaName);
+
/**
* @brief The collection of all currently connected clients.
*/
diff --git a/core/src/area_data.cpp b/core/src/area_data.cpp
index 672c14f..2a1af57 100644
--- a/core/src/area_data.cpp
+++ b/core/src/area_data.cpp
@@ -50,10 +50,8 @@ AreaData::AreaData(QString p_name, int p_index) :
m_ignoreBgList = areas_ini.value("ignore_bglist", "false").toBool();
areas_ini.endGroup();
int log_size = ConfigManager::logBuffer();
- DataTypes::LogType l_logType = ConfigManager::loggingType();
if (log_size == 0)
log_size = 500;
- m_logger = new Logger(m_name, log_size, l_logType);
QTimer* timer1 = new QTimer();
m_timers.append(timer1);
QTimer* timer2 = new QTimer();
@@ -277,44 +275,11 @@ void AreaData::toggleMusic()
m_toggleMusic = !m_toggleMusic;
}
-void AreaData::log(const QString &f_clientName_r, const QString &f_clientIpid_r, const AOPacket &f_packet_r) const
-{
- auto l_header = f_packet_r.header;
-
- if (l_header == "MS") {
- m_logger->logIC(f_clientName_r, f_clientIpid_r, f_packet_r.contents.at(4), f_packet_r.contents.at(15));
- } else if (l_header == "CT") {
- m_logger->logOOC(f_clientName_r, f_clientIpid_r, f_packet_r.contents.at(1));
- } else if (l_header == "ZZ") {
- m_logger->logModcall(f_clientName_r, f_clientIpid_r, f_packet_r.contents.at(0));
- }
-}
-
-void AreaData::logLogin(const QString &f_clientName_r, const QString &f_clientIpid_r, bool f_success, const QString& f_modname_r) const
-{
- m_logger->logLogin(f_clientName_r, f_clientIpid_r, f_success, f_modname_r);
-}
-
-void AreaData::logCmd(const QString &f_clientName_r, const QString &f_clientIpid_r, const QString &f_command_r, const QStringList &f_cmdArgs_r) const
-{
- m_logger->logCmd(f_clientName_r, f_clientIpid_r, f_command_r, f_cmdArgs_r);
-}
-
-void AreaData::flushLogs() const
-{
- m_logger->flush();
-}
-
void AreaData::setEviMod(const EvidenceMod &f_eviMod_r)
{
m_eviMod = f_eviMod_r;
}
-QQueue AreaData::buffer() const
-{
- return m_logger->buffer();
-}
-
void AreaData::setTestimonyRecording(const TestimonyRecording &f_testimonyRecording_r)
{
m_testimonyRecording = f_testimonyRecording_r;
diff --git a/core/src/logger.cpp b/core/src/logger.cpp
deleted file mode 100644
index 27710f9..0000000
--- a/core/src/logger.cpp
+++ /dev/null
@@ -1,121 +0,0 @@
-//////////////////////////////////////////////////////////////////////////////////////
-// akashi - a server for Attorney Online 2 //
-// Copyright (C) 2020 scatterflower //
-// //
-// This program is free software: you can redistribute it and/or modify //
-// it under the terms of the GNU Affero 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 Affero General Public License for more details. //
-// //
-// You should have received a copy of the GNU Affero General Public License //
-// along with this program. If not, see . //
-//////////////////////////////////////////////////////////////////////////////////////
-
-#include
-
-#include "include/logger.h"
-
-void Logger::logIC(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_message_r, const QString& f_showname_r)
-{
- addEntry((f_charName_r + " (" + f_showname_r + ") "), f_ipid_r, "IC", f_message_r);
-}
-
-void Logger::logOOC(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_message_r)
-{
- addEntry(f_charName_r, f_ipid_r, "OOC", f_message_r);
-}
-
-void Logger::logModcall(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_modcallReason_r)
-{
- addEntry(f_charName_r, f_ipid_r, "MODCALL", f_modcallReason_r);
-}
-
-void Logger::logCmd(const QString& f_charName_r, const QString& f_ipid_r, const QString& f_command_r, const QStringList& f_cmdArgs_r)
-{
- // Some commands contain sensitive data, like passwords
- // These must be filtered out
- if (f_command_r == "login") {
- addEntry(f_charName_r, f_ipid_r, "LOGIN", "Attempted login");
- }
- else if (f_command_r == "rootpass") {
- addEntry(f_charName_r, f_ipid_r, "USERS", "Root password created");
- }
- else if (f_command_r == "adduser" && !f_cmdArgs_r.isEmpty()) {
- addEntry(f_charName_r, f_ipid_r, "USERS", "Added user " + f_cmdArgs_r.at(0));
- }
- else {
- QString message = "/" + f_command_r + f_cmdArgs_r.join(" ");
- logOOC(f_charName_r, f_ipid_r, message);
- }
-}
-
-void Logger::logLogin(const QString& f_charName_r, const QString& f_ipid_r, bool success, const QString& f_modname_r)
-{
- QString l_message = success ? "Logged in as " + f_modname_r : "Failed to log in as " + f_modname_r;
- addEntry(f_charName_r, f_ipid_r, "LOGIN", l_message);
-}
-
-void Logger::addEntry(
- const QString& f_charName_r,
- const QString& f_ipid_r,
- const QString& f_type_r,
- const QString& f_message_r)
-{
- QString l_time = QDateTime::currentDateTime().toString("ddd MMMM d yyyy | hh:mm:ss");
-
- QString l_logEntry = QStringLiteral("[%1][%2][%6] %3(%4): %5\n")
- .arg(l_time, m_areaName, f_charName_r, f_ipid_r, f_message_r, f_type_r);
-
- if (m_buffer.length() < m_maxLength) {
- m_buffer.enqueue(l_logEntry);
-
- if (m_logType == DataTypes::LogType::FULL) {
- flush();
- }
- }
- else {
- m_buffer.dequeue();
- m_buffer.enqueue(l_logEntry);
- }
-}
-
-void Logger::flush()
-{
- QDir l_dir("logs/");
- if (!l_dir.exists()) {
- l_dir.mkpath(".");
- }
-
- QFile l_logfile;
-
- switch (m_logType) {
- case DataTypes::LogType::MODCALL:
- l_logfile.setFileName(QString("logs/report_%1_%2.log").arg(m_areaName, (QDateTime::currentDateTime().toString("yyyy-MM-dd_hhmmss"))));
- break;
- case DataTypes::LogType::FULL:
- l_logfile.setFileName(QString("logs/%1.log").arg(QDate::currentDate().toString("yyyy-MM-dd")));
- break;
- case DataTypes::LogType::SQL:
-
- break;
- }
-
- if (l_logfile.open(QIODevice::WriteOnly | QIODevice::Append)) {
- QTextStream file_stream(&l_logfile);
-
- while (!m_buffer.isEmpty())
- file_stream << m_buffer.dequeue();
- }
-
- l_logfile.close();
-}
-
-QQueue Logger::buffer() const
-{
- return m_buffer;
-}
diff --git a/core/src/logger/u_logger.cpp b/core/src/logger/u_logger.cpp
index f95c164..e5866de 100644
--- a/core/src/logger/u_logger.cpp
+++ b/core/src/logger/u_logger.cpp
@@ -134,7 +134,7 @@ void ULogger::logModcall(const QString &f_charName, const QString &f_ipid, const
void ULogger::logConnectionAttempt(const QString& f_ip_address, const QString& f_ipid, const QString& f_hwid)
{
QString l_time = QDateTime::currentDateTime().toString("ddd MMMM d yyyy | hh:mm:ss");
- QString l_logEntry = QStringLiteral("[%1][CONNECT][%2][%3]\n")
+ QString l_logEntry = QStringLiteral("[%1][CONNECT][%2][%3][%4]\n")
.arg(l_time, f_ip_address, f_ipid, f_hwid);
updateAreaBuffer("SERVER",l_logEntry);
}
diff --git a/core/src/packets.cpp b/core/src/packets.cpp
index 4796658..52bb861 100644
--- a/core/src/packets.cpp
+++ b/core/src/packets.cpp
@@ -36,6 +36,7 @@ void AOClient::pktHardwareId(AreaData* area, int argc, QStringList argv, AOPacke
Q_UNUSED(packet);
hwid = argv[0];
+ emit server->logConnectionAttempt(remote_ip.toString(), ipid, hwid);
auto ban = server->db_manager->isHDIDBanned(hwid);
if (ban.first) {
sendPacket("BD", {ban.second + "\nBan ID: " + QString::number(server->db_manager->getBanID(hwid))});
@@ -43,7 +44,6 @@ void AOClient::pktHardwareId(AreaData* area, int argc, QStringList argv, AOPacke
return;
}
sendPacket("ID", {QString::number(id), "akashi", QCoreApplication::applicationVersion()});
- emit server->logConnectionAttempt(remote_ip.toString(), ipid, hwid);
}
void AOClient::pktSoftwareId(AreaData* area, int argc, QStringList argv, AOPacket packet)
@@ -216,7 +216,6 @@ void AOClient::pktIcChat(AreaData* area, int argc, QStringList argv, AOPacket pa
if (pos != "")
validated_packet.contents[5] = pos;
- area->log(current_char, ipid, validated_packet);
server->broadcast(validated_packet, current_area);
emit logIC((current_char + " " + showname), ooc_name,ipid,server->areas[current_area]->name(),last_message);
area->updateLastICMessage(validated_packet.contents);
@@ -265,15 +264,13 @@ void AOClient::pktOocChat(AreaData* area, int argc, QStringList argv, AOPacket p
int cmd_argc = cmd_argv.length();
handleCommand(command, cmd_argc, cmd_argv);
- area->logCmd(current_char, ipid, command, cmd_argv);
emit logCMD((current_char + " " + showname),ipid, ooc_name,command,cmd_argv,server->areas[current_area]->name());
return;
}
else {
server->broadcast(final_packet, current_area);
}
- area->log(current_char, ipid, final_packet);
- emit logOOC((current_char + " " + showname), ooc_name, ipid,server->areas[current_area]->name(),message);
+ emit logOOC((current_char + " " + showname), ooc_name, ipid,area->name(),message);
}
void AOClient::pktPing(AreaData* area, int argc, QStringList argv, AOPacket packet)
@@ -422,7 +419,6 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p
if (client->authenticated)
client->sendPacket(packet);
}
- area->log(current_char, ipid, packet);
emit logModcall((current_char + " " + showname),ipid, ooc_name, server->areas[current_area]->name());
if (ConfigManager::discordModcallWebhookEnabled()) {
@@ -430,10 +426,9 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p
if (ooc_name.isEmpty())
name = current_char;
- emit server->modcallWebhookRequest(name, server->areas[current_area]->name(), packet.contents[0], area->buffer());
+ QString l_areaName = area->name();
+ emit server->modcallWebhookRequest(name, l_areaName, packet.contents[0],server->getAreaBuffer(l_areaName));
}
-
- area->flushLogs();
}
void AOClient::pktAddEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet)
@@ -995,7 +990,6 @@ void AOClient::loginAttempt(QString message)
sendPacket("AUTH", {"0"}); // Client: "Login unsuccessful."
sendServerMessage("Incorrect password.");
}
- server->areas.value(current_area)->logLogin(current_char, ipid, authenticated, "moderator");
emit logLogin((current_char + " " + showname),ooc_name,"Moderator", ipid, server->areas.value(current_area)->name(),authenticated);
break;
case DataTypes::AuthType::ADVANCED:
@@ -1020,7 +1014,7 @@ void AOClient::loginAttempt(QString message)
sendPacket("AUTH", {"0"}); // Client: "Login unsuccessful."
sendServerMessage("Incorrect password.");
}
- emit logLogin((current_char + " " + showname),ooc_name,username, ipid, server->areas.value(current_area)->name(),authenticated);
+ emit logLogin((current_char + " " + showname),ooc_name, username, ipid, server->areas.value(current_area)->name(),authenticated);
break;
}
sendServerMessage("Exiting login prompt.");
diff --git a/core/src/server.cpp b/core/src/server.cpp
index f740f10..1802816 100644
--- a/core/src/server.cpp
+++ b/core/src/server.cpp
@@ -284,6 +284,11 @@ void Server::updateHTTPAdvertiserConfig()
}
+QQueue Server::getAreaBuffer(const QString &f_areaName)
+{
+ return logger->buffer(f_areaName);
+}
+
void Server::allowMessage()
{
can_send_ic_messages = true;