Merge pull request #107 from MangosArentLiterature/discord

Add Discord Webhook for Modcall + Optional Buffer Log Upload

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 \

bin/config_sample/config.ini

@@ -23,3 +23,8 @@ maximum_characters=256
 [Dice]
 max_value=100
 max_dice=100
+
+[Discord]
+webhook_enabled=false
+webhook_url=Your webhook url here.
+webhook_sendfile=false

include/discord.h

@@ -0,0 +1,67 @@
+//////////////////////////////////////////////////////////////////////////////////////
+//    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 <https://www.gnu.org/licenses/>.        //
+//////////////////////////////////////////////////////////////////////////////////////
+#ifndef DISCORD_H
+#define DISCORD_H
+
+#include <QtNetwork>
+#include <QCoreApplication>
+#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.
+     * @param current_area The index of the area the modcall is made.
+     */
+    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:
+
+    /**
+     * @brief A pointer to the Server.
+     */
+    Server* server;
+
+};
+
+#endif // DISCORD_H

include/logger.h

@@ -98,6 +98,11 @@ public:
      */
     void flush();
 
+    /**
+     *@brief Returns the current area buffer
+     */
+    QQueue<QString> getBuffer();
+
 private:
     /**
      * @brief Convenience function to format entries to the acceptable standard for logging.

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 <QCoreApplication>
 #include <QDebug>
@@ -37,6 +38,7 @@
 class AOClient;
 class DBManager;
 class AreaData;
+class Discord;
 
 /**
  * @brief The class that represents the actual server as it is.
@@ -232,6 +234,21 @@ class Server : public QObject {
      */
     int afk_timeout;
 
+    /**
+     * @brief Whether discord webhooks are enabled on this server.
+     */
+    bool webhook_enabled;
+
+    /**
+     * @brief Requires an https Webhook link, including both ID and Token in the link.
+     */
+    QString webhook_url;
+
+    /**
+     * @brief If the modcall buffer is sent as a file.
+     */
+    bool webhook_sendfile;
+
     /**
      * @brief The server-wide global timer.
      */
@@ -305,6 +322,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 reason The reason the client specified for the modcall.
+     * @param current_area Integer ID of the area the modcall is made.
+     */
+    void webhookRequest(QString name, QString reason, int current_area);
+
   private:
     /**
      * @brief The proxy used for WebSocket connections.
@@ -327,6 +353,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

src/discord.cpp

@@ -0,0 +1,73 @@
+//////////////////////////////////////////////////////////////////////////////////////
+//    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 <https://www.gnu.org/licenses/>.        //
+//////////////////////////////////////////////////////////////////////////////////////
+#include "include/discord.h"
+
+void Discord::postModcallWebhook(QString name, QString reason, int current_area)
+{
+    if (!QUrl (server->webhook_url).isValid()) {
+        qWarning() << "Invalid webhook url!";
+        return;
+    }
+
+    QNetworkRequest request(QUrl (server->webhook_url));
+    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;
+
+    nam->post(request, QJsonDocument(json).toJson());
+
+    if (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<QString> 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)
+{
+    QByteArray data = reply->readAll();
+    QString str_reply = data;
+    qDebug() << str_reply;
+}

src/logger.cpp

@@ -113,3 +113,8 @@ void Logger::flush()
         }
     logfile.close();
 }
+
+QQueue<QString> Logger::getBuffer()
+{
+    return buffer;
+}

src/packets.cpp

@@ -327,6 +327,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, packet.contents[0], current_area);
+    }
     area->logger->flush();
 }
 

src/server.cpp

@@ -54,6 +54,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)
         proxy->start();
@@ -290,6 +297,13 @@ 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();
+    webhook_sendfile = config.value("webhook_sendfile", false).toBool();
+    config.endGroup();
 }
 
 Server::~Server()