diff --git a/akashi.pro b/akashi.pro index 365150c..1766080 100644 --- a/akashi.pro +++ b/akashi.pro @@ -37,6 +37,7 @@ SOURCES += src/advertiser.cpp \ src/main.cpp \ src/packets.cpp \ src/server.cpp \ + src/testimony_recorder.cpp \ src/ws_client.cpp \ src/ws_proxy.cpp diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index 6fb4481..34e14e4 100644 --- a/bin/config_sample/config.ini +++ b/bin/config_sample/config.ini @@ -16,6 +16,7 @@ auth=simple modpass=changeme logbuffer=500 logging=modcall +maximum_statements=10 [Dice] max_value=100 diff --git a/include/aoclient.h b/include/aoclient.h index fa755a6..d64c774 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1303,6 +1303,51 @@ class AOClient : public QObject { * @iscommand */ void cmdNoteCardClear(int argc, QStringList argv); + + /** + * @brief Sets are to PLAYBACK mode + * + * @details Enables control over the stored testimony, prevent new messages to be added and + * allows people to navigate trough it using > and <. + */ + void cmdExamine(int argc, QStringList argv); + + /** + * @brief Enables the testimony recording functionality. + * + * @details Any IC-Message send after this command is issues will be recorded by the testimony recorder. + */ + void cmdTestify(int argc, QStringList argv); + + /** + * @brief Allows user to update the currently displayed IC-Message from the testimony replay. + * + * @details Using this command replaces the content of the current statement entirely. It does not append information. + */ + void cmdUpdateStatement(int argc, QStringList argv); + + /** + * @brief Deletes a statement from the testimony. + * + * @details Using this deletes the entire entry in the QVector and resizes it appropriately to prevent empty record indices. + */ + void cmdDeleteStatement(int argc, QStringList argv); + + /** + * @brief Pauses testimony playback. + * + * @details Disables the testimony playback controls. + */ + void cmdPauseTestimony(int argc, QStringList argv); + + + /** + * @brief + * + * @details + * + */ + void cmdAddStatement(int argc, QStringList argv); // Messaging/Client @@ -1568,6 +1613,35 @@ class AOClient : public QObject { long long parseTime(QString input); QString getReprimand(bool positive = false); + /** + * @brief Adds the last send IC-Message to QVector of the respective area. + * + * @details This one pulls double duty to both append IC-Messages to the QVector or insert them, depending on the current recorder enum. + * + * @param packet The MS-Packet being recorded with their color changed to green. + */ + void addStatement(QStringList packet); + + /** + * @brief Clears QVector of the current area. + * + * @details It clears both its content and trims it back to size 0 + * + */ + void clearTestimony(); + + /** + * @brief Updates the currently displayed IC-Message with the next one send + * @param packet The IC-Message that will overwrite the currently stored one. + * @return Returns the updated IC-Message to be send to the other users. It also changes the color to green. + */ + QStringList updateStatement(QStringList packet); + + /** + * @brief Called when area enum is set to PLAYBACK. Sends the IC-Message stored at the current statement. + * @return IC-Message stored in the QVector. + */ + QStringList playTestimony(); ///@} /** @@ -1681,6 +1755,11 @@ class AOClient : public QObject { {"gimp", {ACLFlags.value("MUTE"), 1, &AOClient::cmdGimp}}, {"ungimp", {ACLFlags.value("MUTE"), 1, &AOClient::cmdUnGimp}}, {"baninfo", {ACLFlags.value("BAN"), 1, &AOClient::cmdBanInfo}}, + {"testify", {ACLFlags.value("CM"), 0, &AOClient::cmdTestify}}, + {"examine", {ACLFlags.value("CM"), 0, &AOClient::cmdExamine}}, + {"pause", {ACLFlags.value("CM"), 0, &AOClient::cmdPauseTestimony}}, + {"delete", {ACLFlags.value("CM"), 0, &AOClient::cmdDeleteStatement}}, + {"update", {ACLFlags.value("CM"), 0, &AOClient::cmdUpdateStatement}}, {"reload", {ACLFlags.value("SUPER"), 0, &AOClient::cmdReload}}, {"disemvowel", {ACLFlags.value("MUTE"), 1, &AOClient::cmdDisemvowel}}, {"undisemvowel", {ACLFlags.value("MUTE"), 1, &AOClient::cmdUnDisemvowel}}, diff --git a/include/area_data.h b/include/area_data.h index 4a12ba9..5cab8ef 100644 --- a/include/area_data.h +++ b/include/area_data.h @@ -278,13 +278,63 @@ class AreaData : public QObject { EvidenceMod evi_mod; QMap notecards; + /** + * @brief The five "states" the testimony recording system can have in an area. + */ + enum TestimonyRecording{ + STOPPED, + RECORDING, + UPDATE, + ADD, + PLAYBACK, + }; + + /** + * @var TestimonyRecording STOPPED + * The testimony recorder is inactive and no ic-messages can be played back. + * If messages are inside the buffer when its stopped, the messages will remain until the recorder is set to RECORDING + */ + + /** + * @var TestimonyRecording RECORDING + * The testimony recorder is active and any ic-message send is recorded for playback. + * It does not differentiate between positions, so any message is recorded. Further improvement? + * When the recorder is started, it will clear the buffer and will make the first message the title. + * To prevent accidental recording by not disabling the recorder, a configurable buffer size can be set in the config. + */ + + /** + * @var TestimonyRecording UPDATE + * The testimony recorder is active and replaces the current message at the index with the next ic-message + * Once the IC-Message is send the recorder will default back into playback mode to prevent accidental overwriting of messages. + */ + + /** + * @var TestimonyRecording ADD + * The testimony recorder is active and inserts the next message after the currently displayed ic-message + * This will increase the size by 1. + */ + + /** + * @var TestimonyRecording PLAYBACK + * The testimony recorder is inactive and ic-messages in the buffer will be played back. + */ + + /// Exposes the metadata of the TestimonyRecording enum. + Q_ENUM(TestimonyRecording); + TestimonyRecording test_rec; + + + QVector testimony; //!< Vector of all statements saved. Index 0 is always the title of the testimony. + int statement; //!< Keeps track of the currently played statement. + /** * @brief The judgelog of an area. * * @details This list contains up to 10 recorded packets of the most recent judge actions (WT/CE or penalty updates) in an area. */ QStringList judgelog; - + /** * @brief The last IC packet sent in an area. */ diff --git a/include/server.h b/include/server.h index a02743e..91fb5ef 100644 --- a/include/server.h +++ b/include/server.h @@ -200,6 +200,11 @@ class Server : public QObject { */ QString MOTD; + /** + * @brief The Maximum amounts of IC-Messages an area is allowed to store. + */ + int maximum_statements; + /** * @brief The authorization type of the server. * diff --git a/src/commands.cpp b/src/commands.cpp index b5a47d6..e6dd316 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1366,6 +1366,73 @@ void AOClient::cmdBanInfo(int argc, QStringList argv) sendServerMessage(ban_info.join("\n")); } +void AOClient::cmdTestify(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { + sendServerMessage("Testimony recording is already in progress. Please stop it before starting a new one."); + } + else { + clearTestimony(); + area->statement = 0; + area->test_rec = AreaData::TestimonyRecording::RECORDING; + sendServerMessage("Started testimony recording."); + } +} + +void AOClient::cmdExamine(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + if (area->testimony.size() -1 > 0) + { + area->test_rec = AreaData::TestimonyRecording::PLAYBACK; + server->broadcast(AOPacket("RT",{"testimony2"}), current_area); + server->broadcast(AOPacket("MS", {area->testimony[0]}), current_area); + area->statement = 0; + return; + } + if (area->test_rec == AreaData::TestimonyRecording::PLAYBACK) + sendServerMessage("Unable to examine while another examination is running"); + else + sendServerMessage("Unable to start replay without prior examination."); +} + +void AOClient::cmdDeleteStatement(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if (area->testimony.size() - 1 == 0) { + sendServerMessage("Unable to delete statement. No statements saved in this area."); + } + if (c_statement > 0 && area->testimony.size() > 2) { + area->testimony.remove(c_statement); + sendServerMessage("The statement with id " + QString::number(c_statement) + " has been deleted from the testimony."); + } +} + +void AOClient::cmdUpdateStatement(int argc, QStringList argv) +{ + server->areas[current_area]->test_rec = AreaData::TestimonyRecording::UPDATE; + sendServerMessage("The next IC-Message will replace the last displayed replay message."); +} + +void AOClient::cmdPauseTestimony(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + area->test_rec = AreaData::TestimonyRecording::STOPPED; + sendServerMessage("Testimony has been stopped."); +} + +void AOClient::cmdAddStatement(int argc, QStringList argv) +{ + if (server->areas[current_area]->statement < server->maximum_statements) { + server->areas[current_area]->test_rec = AreaData::TestimonyRecording::ADD; + sendServerMessage("The next IC-Message will be inserted into the testimony."); + } + else + sendServerMessage("Unable to add anymore statements. Please remove any unused ones."); +} + void AOClient::cmdReload(int argc, QStringList argv) { server->loadServerConfig(); diff --git a/src/packets.cpp b/src/packets.cpp index a922595..f271216 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -643,6 +643,41 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) args.append(incoming_args[25].toString()); } + //Testimony playback + if (area->test_rec == AreaData::TestimonyRecording::RECORDING || area->test_rec == AreaData::TestimonyRecording::ADD) { + if (args[5] != "wit") + return AOPacket("MS", args); + + if (area->statement == 0) { + args[4] = "~~\\n-- " + args[4] + " --"; + args[14] = "3"; + server->broadcast(AOPacket("RT",{"testimony1"}), current_area); + } + addStatement(args); + } + else if (area->test_rec == AreaData::TestimonyRecording::UPDATE) { + args = updateStatement(args); + } + else if (area->test_rec == AreaData::TestimonyRecording::PLAYBACK) { + if (args[4] == ">") { + pos = "wit"; + area->statement = area->statement + 1; + args = playTestimony(); + } + if (args[4] == "<") { + pos = "wit"; + area->statement = area->statement - 1; + args = playTestimony(); + } + QRegularExpression jump("(?>)(?[0,1,2,3,4,5,6,7,8,9]+)"); + QRegularExpressionMatch match = jump.match(args[4]); + if (match.hasMatch()) { + pos = "wit"; + area->statement = match.captured("int").toInt(); + args= playTestimony(); + } + } + return AOPacket("MS", args); } diff --git a/src/server.cpp b/src/server.cpp index 9ac35c8..48d2787 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -54,6 +54,8 @@ void Server::start() loadServerConfig(); loadCommandConfig(); + maximum_statements = config.value("maximum_statements", 50).toInt(); + proxy = new WSProxy(port, ws_port, this); if(ws_port != -1) proxy->start(); diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp new file mode 100644 index 0000000..3c6897d --- /dev/null +++ b/src/testimony_recorder.cpp @@ -0,0 +1,94 @@ +////////////////////////////////////////////////////////////////////////////////////// +// 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/aoclient.h" + +// + +void AOClient::addStatement(QStringList packet) +{ + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if (c_statement >= 0) { + if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { + if (c_statement <= server->maximum_statements) { + if (c_statement == 0) + packet[14] = "3"; + else + packet[14] = "1"; + area->testimony.append(packet); + area->statement = c_statement + 1; + return; + } + else { + sendServerMessage("Unable to add more statements. The maximum amount of statements has been reached."); + } + } + else if (area->test_rec == AreaData::TestimonyRecording::ADD) { + area->testimony.insert(c_statement,packet); + area->test_rec = AreaData::TestimonyRecording::PLAYBACK; + } + else { + sendServerMessage("Unable to add more statements. The maximum amount of statements has been reached."); + area->test_rec = AreaData::TestimonyRecording::PLAYBACK; + } + } +} + +QStringList AOClient::updateStatement(QStringList packet) +{ + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + area->test_rec = AreaData::TestimonyRecording::PLAYBACK; + if (c_statement <= 0 || area->testimony[c_statement].empty()) + sendServerMessage("Unable to update an empty statement. Please use /addtestimony."); + else { + packet[14] = "1"; + area->testimony.replace(c_statement, packet); + sendServerMessage("Updated current statement."); + return area->testimony[c_statement]; + } + return packet; +} + +void AOClient::clearTestimony() +{ + AreaData* area = server->areas[current_area]; + area->test_rec = AreaData::TestimonyRecording::STOPPED; + area->testimony.clear(); //!< Empty out the QVector + area->testimony.squeeze(); //!< Release memory. Good idea? God knows, I do not. +} + +QStringList AOClient::playTestimony() +{ + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if (c_statement > area->testimony.size() - 1) { + sendServerMessageArea("Last statement reached. Looping to first statement."); + area->statement = 1; + return area->testimony[area->statement]; + } + if (c_statement <= 0) { + sendServerMessage("First statement reached."); + area->statement = 1; + return area->testimony[area->statement = 1]; + } + else { + return area->testimony[c_statement]; + } +} +