From 15416579048e220f61a96ddf54f6f75a735f3dd5 Mon Sep 17 00:00:00 2001 From: Salanto Date: Tue, 6 Apr 2021 23:11:15 +0200 Subject: [PATCH 01/17] Define recorder modes in area_data.h + Some documentation --- include/area_data.h | 49 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/include/area_data.h b/include/area_data.h index fca0248..d948d8c 100644 --- a/include/area_data.h +++ b/include/area_data.h @@ -272,6 +272,55 @@ class AreaData : public QObject { */ EvidenceMod evi_mod; QMap notecards; + + /** + * @brief The three "states" the testimony recording system can have in an area. + */ + enum TestimonyRecording{ + STOPPED, + RECORDING, + UPDATE, + AMEND, + 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 AMEND + * 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; + }; #endif // AREA_DATA_H From cfdee9b56eb063e5bbadda09beaedc2b87194c4c Mon Sep 17 00:00:00 2001 From: Salanto Date: Wed, 7 Apr 2021 23:52:45 +0200 Subject: [PATCH 02/17] I slowly regret ever thinking I could do this Part 1 --- akashi.pro | 1 + include/aoclient.h | 6 +++++ include/area_data.h | 10 +++++---- src/testimony_recorder.cpp | 45 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 58 insertions(+), 4 deletions(-) create mode 100644 src/testimony_recorder.cpp 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/include/aoclient.h b/include/aoclient.h index 0c4d7cf..4e83fd0 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1474,6 +1474,12 @@ class AOClient : public QObject { long long parseTime(QString input); QString getReprimand(bool positive = false); + void addStatement(QString packet); + void updateStatement(QString packet); + void deleteStatement(); + void clearTestimony(); + void playTestimony(); + void pauseTestimony(); ///@} /** diff --git a/include/area_data.h b/include/area_data.h index d948d8c..6871477 100644 --- a/include/area_data.h +++ b/include/area_data.h @@ -274,13 +274,13 @@ class AreaData : public QObject { QMap notecards; /** - * @brief The three "states" the testimony recording system can have in an area. + * @brief The five "states" the testimony recording system can have in an area. */ enum TestimonyRecording{ STOPPED, RECORDING, UPDATE, - AMEND, + ADD, PLAYBACK, }; @@ -305,7 +305,7 @@ class AreaData : public QObject { */ /** - * @var TestimonyRecording AMEND + * @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. */ @@ -319,7 +319,9 @@ class AreaData : public QObject { Q_ENUM(TestimonyRecording); TestimonyRecording test_rec; - QVector testimony; + + QVector testimony; //!< Vector of all statements saved. Index 0 is always the title of the testimony. + int current_statement; //!< Keeps track of the currently played statement. }; diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp new file mode 100644 index 0000000..b9e70a0 --- /dev/null +++ b/src/testimony_recorder.cpp @@ -0,0 +1,45 @@ +////////////////////////////////////////////////////////////////////////////////////// +// 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(QString packet) +{ + +} +void AOClient::updateStatement(QString packet) +{ + +} +void AOClient::deleteStatement() +{ + AreaData* area = server->areas[current_area]; +} +void AOClient::clearTestimony() +{ + +} +void AOClient::playTestimony() +{ + +} +void AOClient::pauseTestimony() +{ + +} From 5c3c92c603afd079096abd471ed60ab82038fbce Mon Sep 17 00:00:00 2001 From: Salanto Date: Thu, 8 Apr 2021 00:02:30 +0200 Subject: [PATCH 03/17] Some basic layout on how to approach this --- src/testimony_recorder.cpp | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp index b9e70a0..613cdf7 100644 --- a/src/testimony_recorder.cpp +++ b/src/testimony_recorder.cpp @@ -21,25 +21,48 @@ void AOClient::addStatement(QString packet) { - + // This one inserts to the array in order to add new statements inbetwee. Might pull double duty to populate the testimony. } + void AOClient::updateStatement(QString packet) { - + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if ((c_statement >= 0 && !(area->testimony[c_statement].isEmpty()))) { + sendServerMessage("Unable to update an empty statement. Please use /addtestimony."); + } + //Insert code to replace packet here } + void AOClient::deleteStatement() { AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if ((c_statement > 0 && !(area->testimony[c_statement].isEmpty()))) { + area->testimony.remove(c_statement); + sendServerMessage("The statement with id " + QString::number(c_statement) + " has been deleted from the testimony."); + } + return; } + 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. } + void AOClient::playTestimony() { - + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + server->broadcast(AOPacket("MS",area->testimony[c_statement]), current_area); + //Send Message when end is reached and testimony loops? } + void AOClient::pauseTestimony() { - + AreaData* area = server->areas[current_area]; + area->test_rec = AreaData::TestimonyRecording::STOPPED; } From e2c396690c5f3357450098f345f74eb51bb5e99e Mon Sep 17 00:00:00 2001 From: Salanto Date: Thu, 8 Apr 2021 00:08:56 +0200 Subject: [PATCH 04/17] Update area_data.h --- include/area_data.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/area_data.h b/include/area_data.h index eba0315..842bc6e 100644 --- a/include/area_data.h +++ b/include/area_data.h @@ -326,7 +326,7 @@ class AreaData : public QObject { QVector testimony; //!< Vector of all statements saved. Index 0 is always the title of the testimony. - int current_statement; //!< Keeps track of the currently played statement. + int statement; //!< Keeps track of the currently played statement. /** * @brief The last IC packet sent in an area. From 6639a39b0c36c515d8491d9e97d8206e9e04f925 Mon Sep 17 00:00:00 2001 From: Salanto Date: Sun, 11 Apr 2021 22:32:37 +0200 Subject: [PATCH 05/17] Butchering any sanity of the IC Packet handling one commit at a time --- include/aoclient.h | 6 ++--- src/packets.cpp | 11 ++++++++ src/testimony_recorder.cpp | 51 ++++++++++++++++++++++++++++++++------ 3 files changed, 57 insertions(+), 11 deletions(-) diff --git a/include/aoclient.h b/include/aoclient.h index e97d818..6583aa8 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1484,11 +1484,11 @@ class AOClient : public QObject { long long parseTime(QString input); QString getReprimand(bool positive = false); - void addStatement(QString packet); - void updateStatement(QString packet); + void addStatement(QStringList packet); + QStringList updateStatement(QStringList packet); void deleteStatement(); void clearTestimony(); - void playTestimony(); + QStringList playTestimony(); void pauseTestimony(); ///@} diff --git a/src/packets.cpp b/src/packets.cpp index 92e0906..9670b28 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -623,6 +623,17 @@ 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) { + addStatement(args); + } + else if (area->test_rec == AreaData::TestimonyRecording::UPDATE) { + args = updateStatement(args); + } + else if (area->test_rec == AreaData::TestimonyRecording::PLAYBACK) { + args = playTestimony(); // This still needs to handle > and < and when you jump, but god I am not doing this at 11PM + } + return AOPacket("MS", args); } diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp index 613cdf7..b1db0bd 100644 --- a/src/testimony_recorder.cpp +++ b/src/testimony_recorder.cpp @@ -19,19 +19,47 @@ // -void AOClient::addStatement(QString packet) +void AOClient::addStatement(QStringList packet) { - // This one inserts to the array in order to add new statements inbetwee. Might pull double duty to populate the testimony. + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + packet[13] = 1; + if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { + if (area->testimony.isEmpty() && c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged + area->testimony.append(packet); + } + else { + sendServerMessage("Unable to add more statements. The maximum amount of statements has been reached."); + } + } + else if (area->test_rec == AreaData::TestimonyRecording::ADD) { + if (c_statement < 50) { //Make this configurable once Mangos ConfigManager changes get merged + 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; + } + } + } -void AOClient::updateStatement(QString packet) +QStringList AOClient::updateStatement(QStringList packet) { AreaData* area = server->areas[current_area]; int c_statement = area->statement; if ((c_statement >= 0 && !(area->testimony[c_statement].isEmpty()))) { sendServerMessage("Unable to update an empty statement. Please use /addtestimony."); } - //Insert code to replace packet here + else { + packet[13] = 1; + area->testimony.replace(c_statement, packet); + sendServerMessage("Updated current statement."); + return area->testimony[c_statement]; + } + area->test_rec = AreaData::TestimonyRecording::PLAYBACK; + return packet; } void AOClient::deleteStatement() @@ -42,7 +70,7 @@ void AOClient::deleteStatement() area->testimony.remove(c_statement); sendServerMessage("The statement with id " + QString::number(c_statement) + " has been deleted from the testimony."); } - return; + server->areas[current_area]->test_rec = AreaData::TestimonyRecording::PLAYBACK; } void AOClient::clearTestimony() @@ -53,16 +81,23 @@ void AOClient::clearTestimony() area->testimony.squeeze(); //!< Release memory. Good idea? God knows, I do not. } -void AOClient::playTestimony() +QStringList AOClient::playTestimony() { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - server->broadcast(AOPacket("MS",area->testimony[c_statement]), current_area); - //Send Message when end is reached and testimony loops? + if (c_statement > area->testimony.size()) { + sendServerMessageArea("Last statement reached. Looping to first statement."); + area->statement = 1; + return area->testimony[1]; + } + else { + return area->testimony[c_statement]; + } } void AOClient::pauseTestimony() { AreaData* area = server->areas[current_area]; area->test_rec = AreaData::TestimonyRecording::STOPPED; + sendServerMessage("Testimony playback has been stopped."); } From dc90ee6d9aa50db3fe5afa5c62bec30a14246301 Mon Sep 17 00:00:00 2001 From: Salanto Date: Sun, 11 Apr 2021 22:34:58 +0200 Subject: [PATCH 06/17] Update area_data.h --- include/area_data.h | 1 + 1 file changed, 1 insertion(+) diff --git a/include/area_data.h b/include/area_data.h index 595d64e..4dceb90 100644 --- a/include/area_data.h +++ b/include/area_data.h @@ -328,6 +328,7 @@ class AreaData : public QObject { 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. From 15d4deebd31a99b7fb0100471b3ebbce954c6195 Mon Sep 17 00:00:00 2001 From: Salanto Date: Mon, 12 Apr 2021 00:20:10 +0200 Subject: [PATCH 07/17] At least make the intro message work --- include/aoclient.h | 29 +++++++++++++++++++++++++++++ src/commands.cpp | 14 ++++++++++++++ src/packets.cpp | 5 +++++ src/testimony_recorder.cpp | 6 ++++-- 4 files changed, 52 insertions(+), 2 deletions(-) diff --git a/include/aoclient.h b/include/aoclient.h index f27ac35..c5dae80 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1303,6 +1303,34 @@ class AOClient : public QObject { * @iscommand */ void cmdNoteCardClear(int argc, QStringList argv); + + /** + * @brief [Insert description here] + * + * @details [Insert explanation here] + */ + void cmdExamine(int argc, QStringList argv); + + /** + * @brief [Insert description here] + * + * @details [Insert explanation here] + */ + void cmdTestify(int argc, QStringList argv); + + /** + * @brief [Insert description here] + * + * @details [Insert explanation here] + */ + void cmdUpdateStatement(int argc, QStringList argv); + + /** + * @brief [Insert description here] + * + * @details [Insert explanation here] + */ + void cmdDeleteStatement(int argc, QStringList argv); // Messaging/Client @@ -1622,6 +1650,7 @@ class AOClient : public QObject { {"judgelog", {ACLFlags.value("CM"), 0, &AOClient::cmdJudgeLog}}, {"allow_blankposting", {ACLFlags.value("MODCHAT"), 0, &AOClient::cmdAllow_Blankposting}}, {"baninfo", {ACLFlags.value("BAN"), 1, &AOClient::cmdBanInfo}}, + {"examine", {ACLFlags.value("CM"), 0, &AOClient::cmdExamine}}, }; /** diff --git a/src/commands.cpp b/src/commands.cpp index fd65f09..b8470f3 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1356,6 +1356,20 @@ void AOClient::cmdBanInfo(int argc, QStringList argv) sendServerMessage(ban_info.join("\n")); } +void AOClient::cmdExamine(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { + sendServerMessage("Examination already in progress."); + } + else { + clearTestimony(); + area->statement = 0; + area->test_rec = AreaData::TestimonyRecording::RECORDING; + sendServerMessage("Started testimony recording."); + } +} + QStringList AOClient::buildAreaList(int area_idx) { QStringList entries; diff --git a/src/packets.cpp b/src/packets.cpp index 2c5acb7..ff1c8a1 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -630,6 +630,11 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) //Testimony playback if (area->test_rec == AreaData::TestimonyRecording::RECORDING || area->test_rec == AreaData::TestimonyRecording::ADD) { + if (area->statement == 0) { + args[4] = "~~--== " + args[4] + " ==--"; + args[14] = "5"; + server->broadcast(AOPacket("RT",{"testimony1"}), current_area); + } addStatement(args); } else if (area->test_rec == AreaData::TestimonyRecording::UPDATE) { diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp index b1db0bd..826819c 100644 --- a/src/testimony_recorder.cpp +++ b/src/testimony_recorder.cpp @@ -23,10 +23,12 @@ void AOClient::addStatement(QStringList packet) { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - packet[13] = 1; + packet[14] = 1; if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { - if (area->testimony.isEmpty() && c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged + if (c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged 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."); From 4bc53ab61ca5af5732a0ae36c6514778feffe234 Mon Sep 17 00:00:00 2001 From: Salanto Date: Mon, 12 Apr 2021 22:42:02 +0200 Subject: [PATCH 08/17] Make basic system functionality actually work Reminder to add docs --- include/aoclient.h | 11 +++++++ src/commands.cpp | 35 +++++++++++++++++++++- src/packets.cpp | 14 +++++++-- src/testimony_recorder.cpp | 60 ++++++++++++++++++++++---------------- 4 files changed, 91 insertions(+), 29 deletions(-) diff --git a/include/aoclient.h b/include/aoclient.h index c5dae80..647f5b7 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1331,6 +1331,13 @@ class AOClient : public QObject { * @details [Insert explanation here] */ void cmdDeleteStatement(int argc, QStringList argv); + + /** + * @brief [Insert description here] + * + * @details [Insert explanation here] + */ + void cmdPauseTestimony(int argc, QStringList argv); // Messaging/Client @@ -1650,7 +1657,11 @@ class AOClient : public QObject { {"judgelog", {ACLFlags.value("CM"), 0, &AOClient::cmdJudgeLog}}, {"allow_blankposting", {ACLFlags.value("MODCHAT"), 0, &AOClient::cmdAllow_Blankposting}}, {"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}}, }; /** diff --git a/src/commands.cpp b/src/commands.cpp index b8470f3..b495479 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1356,7 +1356,7 @@ void AOClient::cmdBanInfo(int argc, QStringList argv) sendServerMessage(ban_info.join("\n")); } -void AOClient::cmdExamine(int argc, QStringList argv) +void AOClient::cmdTestify(int argc, QStringList argv) { AreaData* area = server->areas[current_area]; if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { @@ -1370,6 +1370,39 @@ void AOClient::cmdExamine(int argc, QStringList argv) } } +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) +{ + deleteStatement(); +} + +void AOClient::cmdUpdateStatement(int argc, QStringList argv) +{ + server->areas[current_area]->test_rec = AreaData::TestimonyRecording::UPDATE; + sendServerMessage("Recording updated statement."); +} + +void AOClient::cmdStop(int argc, QStringList argv) +{ + pauseTestimony(); +} + QStringList AOClient::buildAreaList(int area_idx) { QStringList entries; diff --git a/src/packets.cpp b/src/packets.cpp index ff1c8a1..b4d5988 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -631,8 +631,8 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) //Testimony playback if (area->test_rec == AreaData::TestimonyRecording::RECORDING || area->test_rec == AreaData::TestimonyRecording::ADD) { if (area->statement == 0) { - args[4] = "~~--== " + args[4] + " ==--"; - args[14] = "5"; + args[4] = "~~-- " + args[4] + " --"; + args[14] = "3"; server->broadcast(AOPacket("RT",{"testimony1"}), current_area); } addStatement(args); @@ -641,7 +641,15 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) args = updateStatement(args); } else if (area->test_rec == AreaData::TestimonyRecording::PLAYBACK) { - args = playTestimony(); // This still needs to handle > and < and when you jump, but god I am not doing this at 11PM + if (args[4] == ">") { + area->statement = area->statement + 1; + args = playTestimony(); + } + if (args[4] == "<") { + area->statement = area->statement - 1; + args = playTestimony(); + } + } return AOPacket("MS", args); diff --git a/src/testimony_recorder.cpp b/src/testimony_recorder.cpp index 826819c..2ca6f7a 100644 --- a/src/testimony_recorder.cpp +++ b/src/testimony_recorder.cpp @@ -23,44 +23,49 @@ void AOClient::addStatement(QStringList packet) { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - packet[14] = 1; - if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { - if (c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged - area->testimony.append(packet); - area->statement = c_statement + 1; - return; + if (c_statement >= 0) { + if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { + if (c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged + 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 { - sendServerMessage("Unable to add more statements. The maximum amount of statements has been reached."); - } - } - else if (area->test_rec == AreaData::TestimonyRecording::ADD) { - if (c_statement < 50) { //Make this configurable once Mangos ConfigManager changes get merged - 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; + else if (area->test_rec == AreaData::TestimonyRecording::ADD) { + if (c_statement < 50) { //Make this configurable once Mangos ConfigManager changes get merged + 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; - if ((c_statement >= 0 && !(area->testimony[c_statement].isEmpty()))) { + 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[13] = 1; + packet[14] = "1"; area->testimony.replace(c_statement, packet); sendServerMessage("Updated current statement."); return area->testimony[c_statement]; } - area->test_rec = AreaData::TestimonyRecording::PLAYBACK; return packet; } @@ -87,10 +92,15 @@ QStringList AOClient::playTestimony() { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - if (c_statement > area->testimony.size()) { + if (c_statement > area->testimony.size() - 1) { sendServerMessageArea("Last statement reached. Looping to first statement."); area->statement = 1; - return area->testimony[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]; @@ -101,5 +111,5 @@ void AOClient::pauseTestimony() { AreaData* area = server->areas[current_area]; area->test_rec = AreaData::TestimonyRecording::STOPPED; - sendServerMessage("Testimony playback has been stopped."); + sendServerMessage("Testimony has been stopped."); } From 7eaf129b8bd49ae2d484b101975c273e115a3764 Mon Sep 17 00:00:00 2001 From: Salanto Date: Mon, 12 Apr 2021 22:47:02 +0200 Subject: [PATCH 09/17] Fix compile error --- src/commands.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/commands.cpp b/src/commands.cpp index b495479..e1ecb03 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1398,7 +1398,7 @@ void AOClient::cmdUpdateStatement(int argc, QStringList argv) sendServerMessage("Recording updated statement."); } -void AOClient::cmdStop(int argc, QStringList argv) +void AOClient::cmdPauseTestimony(int argc, QStringList argv) { pauseTestimony(); } From c61f578b40db469a82ba5b810f3cef73464ef923 Mon Sep 17 00:00:00 2001 From: Salanto Date: Tue, 13 Apr 2021 21:15:33 +0200 Subject: [PATCH 10/17] Add some documentation + add sample config Also removes some redundant functions and adds the respective commands. --- bin/config_sample/config.ini | 1 + include/aoclient.h | 59 ++++++++++++++++++++++++++++-------- include/server.h | 5 +++ src/commands.cpp | 29 +++++++++++++++--- src/server.cpp | 2 ++ src/testimony_recorder.cpp | 23 +------------- 6 files changed, 80 insertions(+), 39 deletions(-) diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index 6fb4481..68a128a 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=5 [Dice] max_value=100 diff --git a/include/aoclient.h b/include/aoclient.h index 647f5b7..e513b1b 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1305,39 +1305,49 @@ class AOClient : public QObject { void cmdNoteCardClear(int argc, QStringList argv); /** - * @brief [Insert description here] + * @brief Sets are to PLAYBACK mode * - * @details [Insert explanation here] + * @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 [Insert description here] + * @brief Enables the testimony recording functionality. * - * @details [Insert explanation here] + * @details Any IC-Message send after this command is issues will be recorded by the testimony recorder. */ void cmdTestify(int argc, QStringList argv); /** - * @brief [Insert description here] + * @brief Allows user to update the currently displayed IC-Message from the testimony replay. * - * @details [Insert explanation here] + * @details Using this command replaces the content of the current statement entirely. It does not append information. */ void cmdUpdateStatement(int argc, QStringList argv); /** - * @brief [Insert description here] + * @brief Deletes a statement from the testimony. * - * @details [Insert explanation here] + * @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 [Insert description here] + * @brief Pauses testimony playback. * - * @details [Insert explanation here] + * @details Disables the testimony playback controls. */ void cmdPauseTestimony(int argc, QStringList argv); + + + /** + * @brief + * + * @details + * + */ + void cmdAddStatement(int argc, QStringList argv); // Messaging/Client @@ -1540,12 +1550,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); - QStringList updateStatement(QStringList packet); - void deleteStatement(); + + /** + * @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(); - void pauseTestimony(); ///@} /** diff --git a/include/server.h b/include/server.h index 96cba1a..225c5fc 100644 --- a/include/server.h +++ b/include/server.h @@ -211,6 +211,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 server-wide global timer. */ diff --git a/src/commands.cpp b/src/commands.cpp index e1ecb03..f5804eb 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1360,7 +1360,7 @@ void AOClient::cmdTestify(int argc, QStringList argv) { AreaData* area = server->areas[current_area]; if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { - sendServerMessage("Examination already in progress."); + sendServerMessage("Testimony recording is already in progress. Please stop it before starting a new one."); } else { clearTestimony(); @@ -1389,18 +1389,39 @@ void AOClient::cmdExamine(int argc, QStringList argv) void AOClient::cmdDeleteStatement(int argc, QStringList argv) { - deleteStatement(); + AreaData* area = server->areas[current_area]; + int c_statement = area->statement; + if (area->test_rec == AreaData::TestimonyRecording::STOPPED) { + sendServerMessage("Unable to delete statement. There is currently no examination running."); + } + if (c_statement > 0 && area->test_rec == AreaData::TestimonyRecording::PLAYBACK) { + 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("Recording updated statement."); + sendServerMessage("The next IC-Message will replace the last displayed replay message."); } void AOClient::cmdPauseTestimony(int argc, QStringList argv) { - pauseTestimony(); + 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."); } QStringList AOClient::buildAreaList(int area_idx) diff --git a/src/server.cpp b/src/server.cpp index 5bf4403..7d7b1b2 100644 --- a/src/server.cpp +++ b/src/server.cpp @@ -53,6 +53,8 @@ void Server::start() MOTD = config.value("motd","MOTD is not set.").toString(); + 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 index 2ca6f7a..3c6897d 100644 --- a/src/testimony_recorder.cpp +++ b/src/testimony_recorder.cpp @@ -25,7 +25,7 @@ void AOClient::addStatement(QStringList packet) int c_statement = area->statement; if (c_statement >= 0) { if (area->test_rec == AreaData::TestimonyRecording::RECORDING) { - if (c_statement <= 50) { //Make this configurable once Mangos ConfigManager changes get merged + if (c_statement <= server->maximum_statements) { if (c_statement == 0) packet[14] = "3"; else @@ -39,7 +39,6 @@ void AOClient::addStatement(QStringList packet) } } else if (area->test_rec == AreaData::TestimonyRecording::ADD) { - if (c_statement < 50) { //Make this configurable once Mangos ConfigManager changes get merged area->testimony.insert(c_statement,packet); area->test_rec = AreaData::TestimonyRecording::PLAYBACK; } @@ -47,10 +46,7 @@ void AOClient::addStatement(QStringList packet) 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) @@ -69,17 +65,6 @@ QStringList AOClient::updateStatement(QStringList packet) return packet; } -void AOClient::deleteStatement() -{ - AreaData* area = server->areas[current_area]; - int c_statement = area->statement; - if ((c_statement > 0 && !(area->testimony[c_statement].isEmpty()))) { - area->testimony.remove(c_statement); - sendServerMessage("The statement with id " + QString::number(c_statement) + " has been deleted from the testimony."); - } - server->areas[current_area]->test_rec = AreaData::TestimonyRecording::PLAYBACK; -} - void AOClient::clearTestimony() { AreaData* area = server->areas[current_area]; @@ -107,9 +92,3 @@ QStringList AOClient::playTestimony() } } -void AOClient::pauseTestimony() -{ - AreaData* area = server->areas[current_area]; - area->test_rec = AreaData::TestimonyRecording::STOPPED; - sendServerMessage("Testimony has been stopped."); -} From 0a001141cfc6bdecfa602906244433b302f537a4 Mon Sep 17 00:00:00 2001 From: Salanto Date: Tue, 13 Apr 2021 21:25:24 +0200 Subject: [PATCH 11/17] Increase the amount of allowed messages --- bin/config_sample/config.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/config_sample/config.ini b/bin/config_sample/config.ini index 68a128a..34e14e4 100644 --- a/bin/config_sample/config.ini +++ b/bin/config_sample/config.ini @@ -16,7 +16,7 @@ auth=simple modpass=changeme logbuffer=500 logging=modcall -maximum_statements=5 +maximum_statements=10 [Dice] max_value=100 From 2a08f963864d6e0832d84fa767ab770b114940b7 Mon Sep 17 00:00:00 2001 From: MangosArentLiterature <58055358+MangosArentLiterature@users.noreply.github.com> Date: Tue, 13 Apr 2021 17:43:23 -0500 Subject: [PATCH 12/17] Add >[statement] support - Adds a regex to detect >[statement] - Also puts titles on a new line like AA --- src/packets.cpp | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/packets.cpp b/src/packets.cpp index b4d5988..a2da0f8 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -631,7 +631,7 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) //Testimony playback if (area->test_rec == AreaData::TestimonyRecording::RECORDING || area->test_rec == AreaData::TestimonyRecording::ADD) { if (area->statement == 0) { - args[4] = "~~-- " + args[4] + " --"; + args[4] = "~~\\n-- " + args[4] + " --"; args[14] = "3"; server->broadcast(AOPacket("RT",{"testimony1"}), current_area); } @@ -649,7 +649,12 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) 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()) { + area->statement = match.captured("int").toInt(); + args= playTestimony(); + } } return AOPacket("MS", args); From 1aa5361fe9ef4a732822d26b14670740b677f623 Mon Sep 17 00:00:00 2001 From: Salanto Date: Wed, 14 Apr 2021 00:58:00 +0200 Subject: [PATCH 13/17] Simple pos filter --- src/packets.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/packets.cpp b/src/packets.cpp index a2da0f8..67bdcfe 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -630,6 +630,9 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) //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"; From a62e0e82a246849177468ba3eef017a322e8dc86 Mon Sep 17 00:00:00 2001 From: MangosArentLiterature <58055358+MangosArentLiterature@users.noreply.github.com> Date: Tue, 13 Apr 2021 18:40:05 -0500 Subject: [PATCH 14/17] set pos to "wit" before sending packet during testimony playback --- src/packets.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/packets.cpp b/src/packets.cpp index 67bdcfe..8bafbb8 100644 --- a/src/packets.cpp +++ b/src/packets.cpp @@ -645,16 +645,19 @@ AOPacket AOClient::validateIcPacket(AOPacket packet) } 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(); } From 529a14bf1b02a6df5911a76a332b0048eeb61bc0 Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Wed, 14 Apr 2021 08:54:20 +0200 Subject: [PATCH 15/17] Allow delete without examination --- src/commands.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/commands.cpp b/src/commands.cpp index f5804eb..69ce4d4 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1391,10 +1391,10 @@ void AOClient::cmdDeleteStatement(int argc, QStringList argv) { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - if (area->test_rec == AreaData::TestimonyRecording::STOPPED) { - sendServerMessage("Unable to delete statement. There is currently no examination running."); + if (area->testimony.size() - 1 = 0) { + sendServerMessage("Unable to delete statement. No statements saved in this area."); } - if (c_statement > 0 && area->test_rec == AreaData::TestimonyRecording::PLAYBACK) { + 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."); } From 2b04075d331793d2b425149509f9181b53f1309d Mon Sep 17 00:00:00 2001 From: Salanto <62221668+Salanto@users.noreply.github.com> Date: Wed, 14 Apr 2021 09:57:11 +0200 Subject: [PATCH 16/17] Try to fix compile error with Github Editor I hate this. --- src/commands.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/commands.cpp b/src/commands.cpp index 19c3dca..d628d25 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1392,6 +1392,7 @@ void AOClient::cmdAddStatement(int argc, QStringList argv) } else sendServerMessage("Unable to add anymore statements. Please remove any unused ones."); + } void AOClient::cmdReload(int argc, QStringList argv) From d197f5d619a999c8f7a720d2697c0e5b89c89716 Mon Sep 17 00:00:00 2001 From: Salanto Date: Wed, 14 Apr 2021 18:00:20 +0200 Subject: [PATCH 17/17] Fix compile error for real this time. --- src/commands.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/commands.cpp b/src/commands.cpp index d628d25..3a2bc11 100644 --- a/src/commands.cpp +++ b/src/commands.cpp @@ -1362,7 +1362,7 @@ void AOClient::cmdDeleteStatement(int argc, QStringList argv) { AreaData* area = server->areas[current_area]; int c_statement = area->statement; - if (area->testimony.size() - 1 = 0) { + 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) { @@ -1392,7 +1392,6 @@ void AOClient::cmdAddStatement(int argc, QStringList argv) } else sendServerMessage("Unable to add anymore statements. Please remove any unused ones."); - } void AOClient::cmdReload(int argc, QStringList argv)