Mamanyonyo/akashi-esquizolandia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #143 from AttorneyOnline/discord-refactor

Browse Source 
Discord webhook refactor
This commit is contained in:
scatterflower 2021-06-21 22:07:20 -05:00 committed by GitHub
commit 2885bddc30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 167 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
core/include/discord.h
View File

@ -20,48 +20,95 @@
#include <QtNetwork>
#include <QCoreApplication>
#include "server.h"
class Server;
#include "config_manager.h"
/**
* @brief A class for handling all Discord webhook requests.
*/
class Discord : public QObject {
Q_OBJECT
public:
/**
* @brief Creates an instance of the Discord class.
* @brief Constructor for the Discord object
*
* @param p_server A pointer to the Server instance Discord is constructed by.
* @param f_webhook_url The URL to send webhook POST requests to.
* @param f_webhook_content The content to include in the webhook POST request.
* @param f_webhook_sendfile Whether or not to send a file containing area logs with the webhook POST request.
* @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);
/**
* @brief Deconstructor for the Discord class.
*
* @details Marks the nam to be deleted later.
*/
~Discord();
/**
* @brief Sends a webhook POST request with the given JSON document.
*
* @param f_json The JSON document to send.
*/
void postJsonWebhook(const QJsonDocument& f_json);
/**
* @brief Sends a webhook POST request with the given QHttpMultiPart.
*
* @param f_multipart The QHttpMultiPart to send.
*/
void postMultipartWebhook(QHttpMultiPart& f_multipart);
/**
* @brief Constructs a new JSON document for modcalls.
*
* @param f_name The name of the modcall sender.
* @param f_area The name of the area the modcall was sent from.
* @param f_reason The reason for the modcall.
*
* @return A JSON document for the modcall.
*/
QJsonDocument constructModcallJson(const QString& f_name, const QString& f_area, const QString& f_reason) const;
/**
* @brief Constructs a new QHttpMultiPart document for log files.
*
* @param f_buffer The area's log buffer.
*
* @return A QHttpMultiPart containing the log file.
*/
QHttpMultiPart* constructLogMultipart(const QQueue<QString>& f_buffer) const;
public slots:
/**
* @brief Sends a modcall to a discord webhook.
* @brief Handles a modcall webhook request.
*
* @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.
* @param f_name The name of the modcall sender.
* @param f_area The name of the area the modcall was sent from.
* @param f_reason The reason for the modcall.
* @param f_buffer The area's log buffer.
*/
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);
void onModcallWebhookRequested(const QString& f_name, const QString& f_area, const QString& f_reason, const QQueue<QString>& f_buffer);
private:
/**
* @brief The QNetworkAccessManager for webhooks.
*/
QNetworkAccessManager* m_nam;
/**
* @brief A pointer to the Server.
* @brief The QNetworkRequest for webhooks.
*/
Server* server;
QNetworkRequest m_request;
private slots:
/**
* @brief Handles a network reply from a webhook POST request.
*
* @param f_reply Pointer to the QNetworkReply created by the webhook POST request.
*/
void onReplyFinished(QNetworkReply* f_reply);
};
#endif // DISCORD_H

20
core/include/server.h
View File

@ -39,7 +39,6 @@
class AOClient;
class DBManager;
class AreaData;
class Discord;
/**
* @brief The class that represents the actual server as it is.
@ -231,11 +230,12 @@ 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 reason The reason the client specified for the modcall.
* @param current_area Integer ID of the area the modcall is made.
* @param f_name The character or OOC name of the client who sent the modcall.
* @param f_area The name of the area the modcall was sent from.
* @param f_reason The reason the client specified for the modcall.
* @param f_buffer The area's log buffer.
*/
void webhookRequest(QString name, QString reason, int current_area);
void modcallWebhookRequest(const QString& f_name, const QString& f_area, const QString& f_reason, const QQueue<QString>& f_buffer);
private:
/**
@ -250,6 +250,11 @@ class Server : public QObject {
*/
QTcpServer* server;
/**
* @brief Handles Discord webhooks.
*/
Discord* discord;
/**
* @brief The port through which the server will accept TCP connections.
*/
@ -259,11 +264,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

128
core/src/discord.cpp
View File

@ -17,60 +17,92 @@
//////////////////////////////////////////////////////////////////////////////////////
#include "include/discord.h"
void Discord::postModcallWebhook(QString name, QString reason, int current_area)
Discord::Discord(QObject* parent) :
QObject(parent)
{
if (!QUrl (ConfigManager::discordWebhookUrl()).isValid()) {
qWarning() << "Invalid webhook url!";
return;
}
if (!QUrl(ConfigManager::discordWebhookUrl()).isValid())
qWarning("Invalid webhook URL!");
m_nam = new QNetworkAccessManager();
connect(m_nam, &QNetworkAccessManager::finished,
this, &Discord::onReplyFinished);
m_request.setUrl(QUrl(ConfigManager::discordWebhookUrl()));
}
QNetworkRequest request;
request.setUrl(QUrl (ConfigManager::discordWebhookUrl()));
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 {
{"color", "13312842"},
{"title", name + " filed a modcall in " + server->areas[current_area]->name()},
{"description", reason}
};
jsonArray.append(jsonObject);
json["embeds"] = jsonArray;
if (!ConfigManager::discordWebhookContent().isEmpty())
json["content"] = ConfigManager::discordWebhookContent();
nam->post(request, QJsonDocument(json).toJson());
void Discord::onModcallWebhookRequested(const QString &f_name, const QString &f_area, const QString &f_reason, const QQueue<QString> &f_buffer)
{
QJsonDocument l_json = constructModcallJson(f_name, f_area, f_reason);
postJsonWebhook(l_json);
if (ConfigManager::discordWebhookSendFile()) {
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<QString> buffer = server->areas[current_area]->buffer(); // 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);
QHttpMultiPart *l_multipart = constructLogMultipart(f_buffer);
postMultipartWebhook(*l_multipart);
}
}
void Discord::onFinish(QNetworkReply *reply)
QJsonDocument Discord::constructModcallJson(const QString &f_name, const QString &f_area, const QString &f_reason) const
{
QByteArray data = reply->readAll();
QString str_reply = data;
qDebug() << str_reply;
QJsonObject l_json;
QJsonArray l_array;
QJsonObject l_object {
{"color", "13312842"},
{"title", f_name + " filed a modcall in " + f_area},
{"description", f_reason}
};
l_array.append(l_object);
l_json["embeds"] = l_array;
if (!ConfigManager::discordWebhookContent().isEmpty())
l_json["content"] = ConfigManager::discordWebhookContent();
return QJsonDocument(l_json);
}
QHttpMultiPart* Discord::constructLogMultipart(const QQueue<QString> &f_buffer) const
{
QHttpMultiPart* l_multipart = new QHttpMultiPart();
QHttpPart l_file;
l_file.setRawHeader(QByteArray("Content-Disposition"), QByteArray("form-data; name=\"file\"; filename=\"log.txt\""));
l_file.setRawHeader(QByteArray("Content-Type"), QByteArray("plain/text"));
QString l_log;
for (QString log_entry : f_buffer) {
l_log.append(log_entry + "\n");
}
l_file.setBody(l_log.toUtf8());
l_multipart->append(l_file);
return l_multipart;
}
void Discord::postJsonWebhook(const QJsonDocument &f_json)
{
if (!QUrl(m_request.url()).isValid()) {
qWarning("Invalid webhook URL!");
return;
}
m_request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
m_nam->post(m_request, f_json.toJson());
}
void Discord::postMultipartWebhook(QHttpMultiPart &f_multipart)
{
if (!QUrl(m_request.url()).isValid()) {
qWarning("Invalid webhook URL!");
f_multipart.deleteLater();
return;
}
m_request.setHeader(QNetworkRequest::ContentTypeHeader, "multipart/form-data; boundary=" + f_multipart.boundary());
QNetworkReply* l_reply = m_nam->post(m_request, &f_multipart);
f_multipart.setParent(l_reply);
}
void Discord::onReplyFinished(QNetworkReply *f_reply)
{
auto l_data = f_reply->readAll();
f_reply->deleteLater();
#ifdef DISCORD_DEBUG
QDebug() << l_data;
#endif
}
Discord::~Discord()
{
m_nam->deleteLater();
}

2
core/src/packets.cpp
View File

@ -355,7 +355,7 @@ void AOClient::pktModCall(AreaData* area, int argc, QStringList argv, AOPacket p
if (ooc_name.isEmpty())
name = current_char;
server->webhookRequest(name, packet.contents[0], current_area);
emit server->modcallWebhookRequest(name, server->areas[current_area]->name(), packet.contents[0], area->buffer());
}
area->flushLogs();

14
core/src/server.cpp
View File

@ -50,14 +50,13 @@ void Server::start()
else {
qDebug() << "Server listening on" << port;
}
if (ConfigManager::discordWebhookEnabled()) {
discord = new Discord(this, this);
connect(this, &Server::webhookRequest,
discord, &Discord::postModcallWebhook);
}
if (ConfigManager::discordWebhookEnabled()) {
discord = new Discord(this);
connect(this, &Server::modcallWebhookRequest,
discord, &Discord::onModcallWebhookRequested);
}
proxy = new WSProxy(port, ws_port, this);
if(ws_port != -1)
proxy->start();
@ -253,6 +252,7 @@ Server::~Server()
}
server->deleteLater();
proxy->deleteLater();
discord->deleteLater();
delete db_manager;
}