From e75b80aaae098f0f08c368f30854d2e46c67dcd2 Mon Sep 17 00:00:00 2001 From: MangosArentLiterature <58055358+MangosArentLiterature@users.noreply.github.com> Date: Sun, 25 Apr 2021 15:49:47 -0500 Subject: [PATCH 1/6] Add modcall webhook support This is the worst code I have ever contributed to this project. This commit is the result of several days of attempting to decipher Qt's documentation. This is the best I can write. Qt has broken me. God help us all. - Allows sending modcalls to a discord webhook, containing the name of the sender, the area, and the reason. - Adds configurable options to config.ini for enabling/disabling webhooks and specifying the webhook url. --- akashi.pro | 2 ++ bin/config_sample/config.ini | 4 +++ include/discord.h | 68 ++++++++++++++++++++++++++++++++++++ include/server.h | 26 ++++++++++++++ src/discord.cpp | 54 ++++++++++++++++++++++++++++ src/packets.cpp | 8 +++++ src/server.cpp | 12 +++++++ 7 files changed, 174 insertions(+) create mode 100644 include/discord.h create mode 100644 src/discord.cpp diff --git a/akashi.pro b/akashi.pro index 8e995b4..611f8f8 100644 --- a/akashi.pro +++ b/akashi.pro @@ -40,6 +40,7 @@ SOURCES += src/advertiser.cpp \ src/commands/roleplay.cpp \ src/config_manager.cpp \ src/db_manager.cpp \ + src/discord.cpp \ src/logger.cpp \ src/main.cpp \ src/packets.cpp \ @@ -55,6 +56,7 @@ HEADERS += include/advertiser.h \ include/area_data.h \ include/config_manager.h \ include/db_manager.h \ + include/discord.h \ include/logger.h \ include/server.h \ include/ws_client.h \ diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index bd43618..a0c7dab 100644 --- a/bin/config_sample/config.ini +++ b/bin/config_sample/config.ini @@ -22,3 +22,7 @@ multiclient_limit=15 [Dice] max_value=100 max_dice=100 + +[Discord] +webhook_enabled=false +webhook_url=Your webhook url here. diff --git a/include/discord.h b/include/discord.h new file mode 100644 index 0000000..c0339cd --- /dev/null +++ b/include/discord.h @@ -0,0 +1,68 @@ +////////////////////////////////////////////////////////////////////////////////////// +// 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 DISCORD_H +#define DISCORD_H + +#include +#include +#include "server.h" + +class Server; + +class Discord : public QObject { + Q_OBJECT + +public: + /** + * @brief Creates an instance of the Discord class. + * + * @param p_server A pointer to the Server instance Discord is constructed by. + * @param parent Qt-based parent, passed along to inherited constructor from QObject. + */ + Discord(Server* p_server, QObject* parent = nullptr) + : QObject(parent), server(p_server) { + }; + +public slots: + + /** + * @brief Sends a modcall to a discord webhook. + * + * @param name The character or OOC name of the client who sent the modcall. + * @param area The area name of the area the modcall was sent from. + * @param reason The reason the client specified for the modcall. + */ + void postModcallWebhook(QString name, QString area, QString reason); + +private: + + /** + * @brief A pointer to the Server. + */ + Server* server; + +private slots: + + /** + * @brief Sends the reply to the POST request sent by Discord::postModcallWebhook. + */ + void onFinish(QNetworkReply *reply); + +}; + +#endif // DISCORD_H diff --git a/include/server.h b/include/server.h index f96fd79..46b6062 100644 --- a/include/server.h +++ b/include/server.h @@ -23,6 +23,7 @@ #include "include/area_data.h" #include "include/ws_proxy.h" #include "include/db_manager.h" +#include "include/discord.h" #include #include @@ -37,6 +38,7 @@ class AOClient; class DBManager; class AreaData; +class Discord; /** * @brief The class that represents the actual server as it is. @@ -237,6 +239,16 @@ class Server : public QObject { */ int afk_timeout; + /** + * @brief Whether discord webhooks are enabled on this server. + */ + bool webhook_enabled; + + /** + * @brief The URL of the discord webhook. + */ + QString webhook_url; + /** * @brief The server-wide global timer. */ @@ -305,6 +317,15 @@ class Server : public QObject { */ void reloadRequest(QString p_name, QString p_desc); + /** + * @brief Sends a modcall webhook request, emitted by AOClient::pktModcall. + * + * @param name The character or OOC name of the client who sent the modcall. + * @param area_name The name of the area the modcall was sent from. + * @param reason The reason the client specified for the modcall. + */ + void webhookRequest(QString name, QString area_name, QString reason); + private: /** * @brief The proxy used for WebSocket connections. @@ -327,6 +348,11 @@ class Server : public QObject { * @brief The port through which the server will accept WebSocket connections. */ int ws_port; + + /** + * @brief Handles discord webhooks. + */ + Discord* discord; }; #endif // SERVER_H diff --git a/src/discord.cpp b/src/discord.cpp new file mode 100644 index 0000000..173522e --- /dev/null +++ b/src/discord.cpp @@ -0,0 +1,54 @@ +////////////////////////////////////////////////////////////////////////////////////// +// 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/discord.h" + +void Discord::postModcallWebhook(QString name, QString area, QString reason) +{ + if (!QUrl (server->webhook_url).isValid()) { + qWarning() << "Invalid webhook url!"; + return; + } + QNetworkRequest request(QUrl (server->webhook_url)); + request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); + + // This is the kind of garbage Qt makes me write. + // I am so tired. Qt has broken me. + QJsonObject json; + QJsonArray jsonArray; + QJsonObject jsonObject { + {"color", "13312842"}, + {"title", name + " filed a modcall in " + area}, + {"description", reason} + }; + + jsonArray.append(jsonObject); + json["embeds"] = jsonArray; + + QNetworkAccessManager* nam = new QNetworkAccessManager(); + connect(nam, &QNetworkAccessManager::finished, + this, &Discord::onFinish); + + nam->post(request, QJsonDocument(json).toJson()); +} + +void Discord::onFinish(QNetworkReply *reply) +{ + QByteArray data = reply->readAll(); + QString str_reply = data; + qDebug() << str_reply; +} diff --git a/src/packets.cpp b/src/packets.cpp index 498ed9f..b5f3d59 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -322,6 +322,14 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p client->sendPacket(packet); } area->logger->logModcall(this, &packet); + + if (server->webhook_enabled) { + QString name = ooc_name; + if (ooc_name.isEmpty()) + name = current_char; + + server->webhookRequest(name, area->name, packet.contents[0]); + } } void AOClient::pktAddEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet) diff --git a/src/server.cpp b/src/server.cpp index 30dea51..f4b00c4 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -53,6 +53,13 @@ void Server::start() loadServerConfig(); loadCommandConfig(); + + if (webhook_enabled) { + discord = new Discord(this, this); + connect(this, &Server::webhookRequest, + discord, &Discord::postModcallWebhook); + + } proxy = new WSProxy(port, ws_port, this); if(ws_port != -1) @@ -290,6 +297,11 @@ void Server::loadServerConfig() dice_value = config.value("value_type", "100").toInt(); max_dice = config.value("max_dice","100").toInt(); config.endGroup(); + + //Load discord webhook + config.beginGroup("Discord"); + webhook_enabled = config.value("webhook_enabled", "false").toBool(); + webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); } Server::~Server() From 8aed2989f2c476b4c6265a7369e919816715555a Mon Sep 17 00:00:00 2001 From: Salanto Date: Tue, 27 Apr 2021 23:28:45 +0200 Subject: [PATCH 2/6] Add file upload if modcall logging is used + Configurable option if no log should be send + Fix logger not flushing to file if modcall is used + Update sample\config.ini --- bin/config_sample/config.ini | 1 + include/discord.h | 3 ++- include/logger.h | 5 +++++ include/server.h | 8 +++++++- src/discord.cpp | 33 ++++++++++++++++++++++++++------- src/logger.cpp | 5 +++++ src/packets.cpp | 3 ++- src/server.cpp | 1 + 8 files changed, 49 insertions(+), 10 deletions(-) diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index a0c7dab..3c14874 100644 --- a/bin/config_sample/config.ini +++ b/bin/config_sample/config.ini @@ -26,3 +26,4 @@ max_dice=100 [Discord] webhook_enabled=false webhook_url=Your webhook url here. +webhook_sendfile=false diff --git a/include/discord.h b/include/discord.h index c0339cd..18b8781 100644 --- a/include/discord.h +++ b/include/discord.h @@ -46,8 +46,9 @@ public slots: * @param name The character or OOC name of the client who sent the modcall. * @param area The area name of the area the modcall was sent from. * @param reason The reason the client specified for the modcall. + * @param current_area The index of the area the modcall is made. */ - void postModcallWebhook(QString name, QString area, QString reason); + void postModcallWebhook(QString name, QString area, QString reason, int current_area); private: diff --git a/include/logger.h b/include/logger.h index e73d77f..046dfe6 100644 --- a/include/logger.h +++ b/include/logger.h @@ -98,6 +98,11 @@ public: */ void flush(); + /** + *@brief Returns the current area buffer + */ + QQueue getBuffer(); + private: /** * @brief Convenience function to format entries to the acceptable standard for logging. diff --git a/include/server.h b/include/server.h index 46b6062..a8d1d21 100644 --- a/include/server.h +++ b/include/server.h @@ -249,6 +249,11 @@ class Server : public QObject { */ QString webhook_url; + /** + * @brief If the modcall buffer is send as a file. + */ + bool webhook_sendfile; + /** * @brief The server-wide global timer. */ @@ -323,8 +328,9 @@ class Server : public QObject { * @param name The character or OOC name of the client who sent the modcall. * @param area_name The name of the area the modcall was sent from. * @param reason The reason the client specified for the modcall. + * @param */ - void webhookRequest(QString name, QString area_name, QString reason); + void webhookRequest(QString name, QString area_name, QString reason, int current_area); private: /** diff --git a/src/discord.cpp b/src/discord.cpp index 173522e..40d888a 100644 --- a/src/discord.cpp +++ b/src/discord.cpp @@ -17,17 +17,22 @@ ////////////////////////////////////////////////////////////////////////////////////// #include "include/discord.h" -void Discord::postModcallWebhook(QString name, QString area, QString reason) +void Discord::postModcallWebhook(QString name, QString area, QString reason, int current_area) { if (!QUrl (server->webhook_url).isValid()) { qWarning() << "Invalid webhook url!"; return; } + QNetworkRequest request(QUrl (server->webhook_url)); - request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); + QNetworkAccessManager* nam = new QNetworkAccessManager(); + connect(nam, &QNetworkAccessManager::finished, + this, &Discord::onFinish); // This is the kind of garbage Qt makes me write. // I am so tired. Qt has broken me. + request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); + QJsonObject json; QJsonArray jsonArray; QJsonObject jsonObject { @@ -35,15 +40,29 @@ void Discord::postModcallWebhook(QString name, QString area, QString reason) {"title", name + " filed a modcall in " + area}, {"description", reason} }; - jsonArray.append(jsonObject); json["embeds"] = jsonArray; - QNetworkAccessManager* nam = new QNetworkAccessManager(); - connect(nam, &QNetworkAccessManager::finished, - this, &Discord::onFinish); - nam->post(request, QJsonDocument(json).toJson()); + + if (server->areas[current_area]->log_type == "modcall" && server->webhook_sendfile) { + QHttpMultiPart* construct = new QHttpMultiPart(); + request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + construct->boundary()); + + //This cost me two days of my life. Thanks Qt and Discord. You have broken me. + QHttpPart file; + file.setRawHeader(QByteArray("Content-Disposition"), QByteArray("form-data; name=\"file\"; filename=\"log.txt\"")); + file.setRawHeader(QByteArray("Content-Type"), QByteArray("plain/text")); + QQueue buffer = server->areas[current_area]->logger->getBuffer(); // I feel no shame for doing this + QString log; + while (!buffer.isEmpty()) { + log.append(buffer.dequeue() + "\n"); + } + file.setBody(log.toUtf8()); + construct->append(file); + + nam->post(request, construct); + } } void Discord::onFinish(QNetworkReply *reply) diff --git a/src/logger.cpp b/src/logger.cpp index 96ea2c6..a4c33f9 100644 --- a/src/logger.cpp +++ b/src/logger.cpp @@ -113,3 +113,8 @@ void Logger::flush() } logfile.close(); } + +QQueue Logger::getBuffer() +{ + return buffer; +} diff --git a/src/packets.cpp b/src/packets.cpp index b5f3d59..32a0629 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -328,8 +328,9 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p if (ooc_name.isEmpty()) name = current_char; - server->webhookRequest(name, area->name, packet.contents[0]); + server->webhookRequest(name, area->name, packet.contents[0], current_area); } + area->logger->flush(); } void AOClient::pktAddEvidence(AreaData* area, int argc, QStringList argv, AOPacket packet) diff --git a/src/server.cpp b/src/server.cpp index f4b00c4..c7b23ac 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -302,6 +302,7 @@ void Server::loadServerConfig() config.beginGroup("Discord"); webhook_enabled = config.value("webhook_enabled", "false").toBool(); webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); + webhook_sendfile = config.value("webhook_sendfile", false).toBool(); } Server::~Server() From e00e7b571d006332a3688d0e541f55e94298544a Mon Sep 17 00:00:00 2001 From: Salanto Date: Wed, 28 Apr 2021 23:32:48 +0200 Subject: [PATCH 3/6] Apply code suggestions Non-functional as of now. --- include/discord.h | 34 +++++++++++++++++++--------------- include/logger.h | 2 +- include/server.h | 30 +++++++----------------------- src/discord.cpp | 13 ++++++------- src/logger.cpp | 2 +- src/packets.cpp | 4 ++-- src/server.cpp | 7 ++++--- 7 files changed, 40 insertions(+), 52 deletions(-) diff --git a/include/discord.h b/include/discord.h index 18b8781..437e92f 100644 --- a/include/discord.h +++ b/include/discord.h @@ -20,9 +20,7 @@ #include #include -#include "server.h" - -class Server; +#include "area_data.h" class Discord : public QObject { Q_OBJECT @@ -34,10 +32,25 @@ public: * @param p_server A pointer to the Server instance Discord is constructed by. * @param parent Qt-based parent, passed along to inherited constructor from QObject. */ - Discord(Server* p_server, QObject* parent = nullptr) - : QObject(parent), server(p_server) { + Discord(QObject* parent = nullptr) + : QObject(parent) { }; + /** + * @brief Whether discord webhooks are enabled on this server. + */ + bool webhook_enabled; + + /** + * @brief Requires link to be https and that both WebhookID and WebhookToken are present, if used for Discord. + */ + QString webhook_url; + + /** + * @brief If the modcall buffer is sent as a file. + */ + bool webhook_sendfile; + public slots: /** @@ -48,16 +61,7 @@ public slots: * @param reason The reason the client specified for the modcall. * @param current_area The index of the area the modcall is made. */ - void postModcallWebhook(QString name, QString area, QString reason, int current_area); - -private: - - /** - * @brief A pointer to the Server. - */ - Server* server; - -private slots: + void postModcallWebhook(QString name, QString reason, AreaData* area); /** * @brief Sends the reply to the POST request sent by Discord::postModcallWebhook. diff --git a/include/logger.h b/include/logger.h index 046dfe6..6e44884 100644 --- a/include/logger.h +++ b/include/logger.h @@ -101,7 +101,7 @@ public: /** *@brief Returns the current area buffer */ - QQueue getBuffer(); + const QQueue& getBuffer() const; private: /** diff --git a/include/server.h b/include/server.h index e53ec81..6947c96 100644 --- a/include/server.h +++ b/include/server.h @@ -183,6 +183,11 @@ class Server : public QObject { */ DBManager* db_manager; + /** + * @brief Handles discord webhooks. + */ + Discord* discord; + /** * @brief The max amount of players on the server. */ @@ -239,21 +244,6 @@ class Server : public QObject { */ int afk_timeout; - /** - * @brief Whether discord webhooks are enabled on this server. - */ - bool webhook_enabled; - - /** - * @brief The URL of the discord webhook. - */ - QString webhook_url; - - /** - * @brief If the modcall buffer is send as a file. - */ - bool webhook_sendfile; - /** * @brief The server-wide global timer. */ @@ -331,11 +321,10 @@ class Server : public QObject { * @brief Sends a modcall webhook request, emitted by AOClient::pktModcall. * * @param name The character or OOC name of the client who sent the modcall. - * @param area_name The name of the area the modcall was sent from. * @param reason The reason the client specified for the modcall. - * @param + * @param current_area Integer ID of the area the modcall was send. */ - void webhookRequest(QString name, QString area_name, QString reason, int current_area); + void webhookRequest(QString name, QString reason, AreaData* area); private: /** @@ -359,11 +348,6 @@ class Server : public QObject { * @brief The port through which the server will accept WebSocket connections. */ int ws_port; - - /** - * @brief Handles discord webhooks. - */ - Discord* discord; }; #endif // SERVER_H diff --git a/src/discord.cpp b/src/discord.cpp index 40d888a..ba61a0e 100644 --- a/src/discord.cpp +++ b/src/discord.cpp @@ -17,14 +17,13 @@ ////////////////////////////////////////////////////////////////////////////////////// #include "include/discord.h" -void Discord::postModcallWebhook(QString name, QString area, QString reason, int current_area) +void Discord::postModcallWebhook(QString name, QString reason, AreaData* area) { - if (!QUrl (server->webhook_url).isValid()) { + if (!QUrl (webhook_url).isValid()) { qWarning() << "Invalid webhook url!"; return; } - - QNetworkRequest request(QUrl (server->webhook_url)); + QNetworkRequest request((QUrl (webhook_url))); QNetworkAccessManager* nam = new QNetworkAccessManager(); connect(nam, &QNetworkAccessManager::finished, this, &Discord::onFinish); @@ -37,7 +36,7 @@ void Discord::postModcallWebhook(QString name, QString area, QString reason, int QJsonArray jsonArray; QJsonObject jsonObject { {"color", "13312842"}, - {"title", name + " filed a modcall in " + area}, + {"title", name + " filed a modcall in " + area->name}, {"description", reason} }; jsonArray.append(jsonObject); @@ -45,7 +44,7 @@ void Discord::postModcallWebhook(QString name, QString area, QString reason, int nam->post(request, QJsonDocument(json).toJson()); - if (server->areas[current_area]->log_type == "modcall" && server->webhook_sendfile) { + if (area->log_type == "modcall" && webhook_sendfile) { QHttpMultiPart* construct = new QHttpMultiPart(); request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + construct->boundary()); @@ -53,7 +52,7 @@ void Discord::postModcallWebhook(QString name, QString area, QString reason, int QHttpPart file; file.setRawHeader(QByteArray("Content-Disposition"), QByteArray("form-data; name=\"file\"; filename=\"log.txt\"")); file.setRawHeader(QByteArray("Content-Type"), QByteArray("plain/text")); - QQueue buffer = server->areas[current_area]->logger->getBuffer(); // I feel no shame for doing this + QQueue buffer = area->logger->getBuffer(); // I feel no shame for doing this QString log; while (!buffer.isEmpty()) { log.append(buffer.dequeue() + "\n"); diff --git a/src/logger.cpp b/src/logger.cpp index a4c33f9..6c487e8 100644 --- a/src/logger.cpp +++ b/src/logger.cpp @@ -114,7 +114,7 @@ void Logger::flush() logfile.close(); } -QQueue Logger::getBuffer() +const QQueue& Logger::getBuffer() const { return buffer; } diff --git a/src/packets.cpp b/src/packets.cpp index 42733db..baf88fc 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -328,12 +328,12 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p } area->logger->logModcall(this, &packet); - if (server->webhook_enabled) { + if (server->discord->webhook_enabled) { QString name = ooc_name; if (ooc_name.isEmpty()) name = current_char; - server->webhookRequest(name, area->name, packet.contents[0], current_area); + server->webhookRequest(name, packet.contents[0], area); } area->logger->flush(); } diff --git a/src/server.cpp b/src/server.cpp index 6b45068..19d7d7e 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -304,9 +304,10 @@ void Server::loadServerConfig() //Load discord webhook config.beginGroup("Discord"); - webhook_enabled = config.value("webhook_enabled", "false").toBool(); - webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); - webhook_sendfile = config.value("webhook_sendfile", false).toBool(); + discord->webhook_enabled = config.value("webhook_enabled", "false").toBool(); + discord->webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); + discord->webhook_sendfile = config.value("webhook_sendfile", false).toBool(); + config.endGroup(); } Server::~Server() From b689c715331772c51f9e1fa8ae01e00542db8034 Mon Sep 17 00:00:00 2001 From: Salanto Date: Wed, 28 Apr 2021 23:53:03 +0200 Subject: [PATCH 4/6] Revert "Apply code suggestions" This reverts commit e00e7b571d006332a3688d0e541f55e94298544a. --- include/discord.h | 34 +++++++++++++++------------------- include/logger.h | 2 +- include/server.h | 30 +++++++++++++++++++++++------- src/discord.cpp | 13 +++++++------ src/logger.cpp | 2 +- src/packets.cpp | 4 ++-- src/server.cpp | 7 +++---- 7 files changed, 52 insertions(+), 40 deletions(-) diff --git a/include/discord.h b/include/discord.h index 437e92f..18b8781 100644 --- a/include/discord.h +++ b/include/discord.h @@ -20,7 +20,9 @@ #include #include -#include "area_data.h" +#include "server.h" + +class Server; class Discord : public QObject { Q_OBJECT @@ -32,25 +34,10 @@ public: * @param p_server A pointer to the Server instance Discord is constructed by. * @param parent Qt-based parent, passed along to inherited constructor from QObject. */ - Discord(QObject* parent = nullptr) - : QObject(parent) { + Discord(Server* p_server, QObject* parent = nullptr) + : QObject(parent), server(p_server) { }; - /** - * @brief Whether discord webhooks are enabled on this server. - */ - bool webhook_enabled; - - /** - * @brief Requires link to be https and that both WebhookID and WebhookToken are present, if used for Discord. - */ - QString webhook_url; - - /** - * @brief If the modcall buffer is sent as a file. - */ - bool webhook_sendfile; - public slots: /** @@ -61,7 +48,16 @@ public slots: * @param reason The reason the client specified for the modcall. * @param current_area The index of the area the modcall is made. */ - void postModcallWebhook(QString name, QString reason, AreaData* area); + void postModcallWebhook(QString name, QString area, QString reason, int current_area); + +private: + + /** + * @brief A pointer to the Server. + */ + Server* server; + +private slots: /** * @brief Sends the reply to the POST request sent by Discord::postModcallWebhook. diff --git a/include/logger.h b/include/logger.h index 6e44884..046dfe6 100644 --- a/include/logger.h +++ b/include/logger.h @@ -101,7 +101,7 @@ public: /** *@brief Returns the current area buffer */ - const QQueue& getBuffer() const; + QQueue getBuffer(); private: /** diff --git a/include/server.h b/include/server.h index 6947c96..e53ec81 100644 --- a/include/server.h +++ b/include/server.h @@ -183,11 +183,6 @@ class Server : public QObject { */ DBManager* db_manager; - /** - * @brief Handles discord webhooks. - */ - Discord* discord; - /** * @brief The max amount of players on the server. */ @@ -244,6 +239,21 @@ class Server : public QObject { */ int afk_timeout; + /** + * @brief Whether discord webhooks are enabled on this server. + */ + bool webhook_enabled; + + /** + * @brief The URL of the discord webhook. + */ + QString webhook_url; + + /** + * @brief If the modcall buffer is send as a file. + */ + bool webhook_sendfile; + /** * @brief The server-wide global timer. */ @@ -321,10 +331,11 @@ class Server : public QObject { * @brief Sends a modcall webhook request, emitted by AOClient::pktModcall. * * @param name The character or OOC name of the client who sent the modcall. + * @param area_name The name of the area the modcall was sent from. * @param reason The reason the client specified for the modcall. - * @param current_area Integer ID of the area the modcall was send. + * @param */ - void webhookRequest(QString name, QString reason, AreaData* area); + void webhookRequest(QString name, QString area_name, QString reason, int current_area); private: /** @@ -348,6 +359,11 @@ class Server : public QObject { * @brief The port through which the server will accept WebSocket connections. */ int ws_port; + + /** + * @brief Handles discord webhooks. + */ + Discord* discord; }; #endif // SERVER_H diff --git a/src/discord.cpp b/src/discord.cpp index ba61a0e..40d888a 100644 --- a/src/discord.cpp +++ b/src/discord.cpp @@ -17,13 +17,14 @@ ////////////////////////////////////////////////////////////////////////////////////// #include "include/discord.h" -void Discord::postModcallWebhook(QString name, QString reason, AreaData* area) +void Discord::postModcallWebhook(QString name, QString area, QString reason, int current_area) { - if (!QUrl (webhook_url).isValid()) { + if (!QUrl (server->webhook_url).isValid()) { qWarning() << "Invalid webhook url!"; return; } - QNetworkRequest request((QUrl (webhook_url))); + + QNetworkRequest request(QUrl (server->webhook_url)); QNetworkAccessManager* nam = new QNetworkAccessManager(); connect(nam, &QNetworkAccessManager::finished, this, &Discord::onFinish); @@ -36,7 +37,7 @@ void Discord::postModcallWebhook(QString name, QString reason, AreaData* area) QJsonArray jsonArray; QJsonObject jsonObject { {"color", "13312842"}, - {"title", name + " filed a modcall in " + area->name}, + {"title", name + " filed a modcall in " + area}, {"description", reason} }; jsonArray.append(jsonObject); @@ -44,7 +45,7 @@ void Discord::postModcallWebhook(QString name, QString reason, AreaData* area) nam->post(request, QJsonDocument(json).toJson()); - if (area->log_type == "modcall" && webhook_sendfile) { + if (server->areas[current_area]->log_type == "modcall" && server->webhook_sendfile) { QHttpMultiPart* construct = new QHttpMultiPart(); request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + construct->boundary()); @@ -52,7 +53,7 @@ void Discord::postModcallWebhook(QString name, QString reason, AreaData* area) QHttpPart file; file.setRawHeader(QByteArray("Content-Disposition"), QByteArray("form-data; name=\"file\"; filename=\"log.txt\"")); file.setRawHeader(QByteArray("Content-Type"), QByteArray("plain/text")); - QQueue buffer = area->logger->getBuffer(); // I feel no shame for doing this + QQueue buffer = server->areas[current_area]->logger->getBuffer(); // I feel no shame for doing this QString log; while (!buffer.isEmpty()) { log.append(buffer.dequeue() + "\n"); diff --git a/src/logger.cpp b/src/logger.cpp index 6c487e8..a4c33f9 100644 --- a/src/logger.cpp +++ b/src/logger.cpp @@ -114,7 +114,7 @@ void Logger::flush() logfile.close(); } -const QQueue& Logger::getBuffer() const +QQueue Logger::getBuffer() { return buffer; } diff --git a/src/packets.cpp b/src/packets.cpp index baf88fc..42733db 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -328,12 +328,12 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p } area->logger->logModcall(this, &packet); - if (server->discord->webhook_enabled) { + if (server->webhook_enabled) { QString name = ooc_name; if (ooc_name.isEmpty()) name = current_char; - server->webhookRequest(name, packet.contents[0], area); + server->webhookRequest(name, area->name, packet.contents[0], current_area); } area->logger->flush(); } diff --git a/src/server.cpp b/src/server.cpp index 19d7d7e..6b45068 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -304,10 +304,9 @@ void Server::loadServerConfig() //Load discord webhook config.beginGroup("Discord"); - discord->webhook_enabled = config.value("webhook_enabled", "false").toBool(); - discord->webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); - discord->webhook_sendfile = config.value("webhook_sendfile", false).toBool(); - config.endGroup(); + webhook_enabled = config.value("webhook_enabled", "false").toBool(); + webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); + webhook_sendfile = config.value("webhook_sendfile", false).toBool(); } Server::~Server() From 96396d3404361d827288350ca44f42f3b3f70b4f Mon Sep 17 00:00:00 2001 From: Salanto Date: Thu, 29 Apr 2021 01:02:47 +0200 Subject: [PATCH 5/6] Apply some suggested changes --- include/discord.h | 14 ++++++-------- include/server.h | 9 ++++----- src/discord.cpp | 4 ++-- src/packets.cpp | 2 +- src/server.cpp | 1 + 5 files changed, 14 insertions(+), 16 deletions(-) diff --git a/include/discord.h b/include/discord.h index 18b8781..86e008e 100644 --- a/include/discord.h +++ b/include/discord.h @@ -48,7 +48,12 @@ public slots: * @param reason The reason the client specified for the modcall. * @param current_area The index of the area the modcall is made. */ - void postModcallWebhook(QString name, QString area, QString reason, int current_area); + void postModcallWebhook(QString name, QString reason, int current_area); + + /** + * @brief Sends the reply to the POST request sent by Discord::postModcallWebhook. + */ + void onFinish(QNetworkReply *reply); private: @@ -57,13 +62,6 @@ private: */ Server* server; -private slots: - - /** - * @brief Sends the reply to the POST request sent by Discord::postModcallWebhook. - */ - void onFinish(QNetworkReply *reply); - }; #endif // DISCORD_H diff --git a/include/server.h b/include/server.h index e53ec81..fe10e6a 100644 --- a/include/server.h +++ b/include/server.h @@ -245,12 +245,12 @@ class Server : public QObject { bool webhook_enabled; /** - * @brief The URL of the discord webhook. + * @brief Requires an https Webhook link, including both ID and Token in the link. */ QString webhook_url; /** - * @brief If the modcall buffer is send as a file. + * @brief If the modcall buffer is sent as a file. */ bool webhook_sendfile; @@ -331,11 +331,10 @@ class Server : public QObject { * @brief Sends a modcall webhook request, emitted by AOClient::pktModcall. * * @param name The character or OOC name of the client who sent the modcall. - * @param area_name The name of the area the modcall was sent from. * @param reason The reason the client specified for the modcall. - * @param + * @param current_area Integer ID of the area the modcall is made. */ - void webhookRequest(QString name, QString area_name, QString reason, int current_area); + void webhookRequest(QString name, QString reason, int current_area); private: /** diff --git a/src/discord.cpp b/src/discord.cpp index 40d888a..5c2485a 100644 --- a/src/discord.cpp +++ b/src/discord.cpp @@ -17,7 +17,7 @@ ////////////////////////////////////////////////////////////////////////////////////// #include "include/discord.h" -void Discord::postModcallWebhook(QString name, QString area, QString reason, int current_area) +void Discord::postModcallWebhook(QString name, QString reason, int current_area) { if (!QUrl (server->webhook_url).isValid()) { qWarning() << "Invalid webhook url!"; @@ -37,7 +37,7 @@ void Discord::postModcallWebhook(QString name, QString area, QString reason, int QJsonArray jsonArray; QJsonObject jsonObject { {"color", "13312842"}, - {"title", name + " filed a modcall in " + area}, + {"title", name + " filed a modcall in " + server->areas[current_area]->name}, {"description", reason} }; jsonArray.append(jsonObject); diff --git a/src/packets.cpp b/src/packets.cpp index 42733db..c5633dc 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -333,7 +333,7 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p if (ooc_name.isEmpty()) name = current_char; - server->webhookRequest(name, area->name, packet.contents[0], current_area); + server->webhookRequest(name, packet.contents[0], current_area); } area->logger->flush(); } diff --git a/src/server.cpp b/src/server.cpp index 6b45068..948c41a 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -307,6 +307,7 @@ void Server::loadServerConfig() webhook_enabled = config.value("webhook_enabled", "false").toBool(); webhook_url = config.value("webhook_url", "Your webhook url here.").toString(); webhook_sendfile = config.value("webhook_sendfile", false).toBool(); + config.endGroup(); } Server::~Server() From f166a6f4fc6e84a49b0f93162a4becb847820391 Mon Sep 17 00:00:00 2001 From: Salanto Date: Thu, 29 Apr 2021 01:07:08 +0200 Subject: [PATCH 6/6] Slight improvement --- src/discord.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/discord.cpp b/src/discord.cpp index 5c2485a..e18f784 100644 --- a/src/discord.cpp +++ b/src/discord.cpp @@ -45,7 +45,7 @@ void Discord::postModcallWebhook(QString name, QString reason, int current_area) nam->post(request, QJsonDocument(json).toJson()); - if (server->areas[current_area]->log_type == "modcall" && server->webhook_sendfile) { + if (server->webhook_sendfile) { QHttpMultiPart* construct = new QHttpMultiPart(); request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + construct->boundary());