akashi-esquizolandia/core/include/discord.h

//////////////////////////////////////////////////////////////////////////////////////
//    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 <QCoreApplication>
#include <QtNetwork>

class ConfigManager;

/**
 * @brief A class for handling all Discord webhook requests.
 */
class Discord : public QObject
{
    Q_OBJECT

  public:
    /**
     * @brief Constructor for the Discord object
     *
     * @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(QObject *parent = nullptr);

    /**
     * @brief Deconstructor for the Discord class.
     *
     * @details Marks the nam to be deleted later.
     */
    ~Discord();

    /**
     * @brief Method to start the Uptime Webhook posting timer.
     */
    void startUptimeTimer();

    /**
     * @brief Method to stop the Uptime Webhook posting timer.
     */
    void stopUptimeTimer();

  public slots:
    /**
     * @brief Handles a modcall webhook request.
     *
     * @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 onModcallWebhookRequested(const QString &f_name, const QString &f_area, const QString &f_reason, const QQueue<QString> &f_buffer);

    /**
     * @brief Handles a ban webhook request.
     *
     * @param f_ipid The IPID of the client.
     * @param f_moderator The name of the moderator banning.
     * @param f_duration The date the ban expires.
     * @param f_reason The reason of the ban.
     */
    void onBanWebhookRequested(const QString &f_ipid, const QString &f_moderator, const QString &f_duration, const QString &f_reason, const int &f_banID);

    /**
     * @brief Handles a uptime webhook request.
     */
    void onUptimeWebhookRequested();

  private:
    /**
     * @brief The QNetworkAccessManager for webhooks.
     */
    QNetworkAccessManager *m_nam;

    /**
     * @brief The QNetworkRequest for webhooks.
     */
    QNetworkRequest m_request;

    /**
     * @brief Timer to post a message that the server is still alive.
     */
    QTimer *m_uptimePostTimer;

    /**
     * @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;

  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);

    /**
     * @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 bans.
     *
     * @param f_ipid The IPID of the client.
     * @param f_moderator The name of the moderator banning.
     * @param f_duration The date the ban expires.
     * @param f_reason The reason of the ban.
     *
     * @return A JSON document for the ban.
     */
    QJsonDocument constructBanJson(const QString &f_ipid, const QString &f_moderator, const QString &f_duration, const QString &f_reason, const int &f_banID);
    /**
     * @brief Constructs a new JSON document for the server alive message.
     * @param f_timeExpired formatted uptime as a string.
     *
     * @return A JSON document for the alive notification.
     */
    QJsonDocument constructUptimeJson(const QString &f_timeExpired);
};

#endif // DISCORD_H