From 3c5659af22efa3682de7e6f55b768667c92e956c Mon Sep 17 00:00:00 2001 From: Salanto Date: Sun, 18 Apr 2021 03:59:12 +0200 Subject: [PATCH 1/3] Add testimony loading and saving --- bin/storage/testimony/sample.txt | 4 ++ include/aoclient.h | 36 +++++++++++++++ src/commands/casing.cpp | 75 ++++++++++++++++++++++++++++++++ src/commands/moderation.cpp | 10 +++++ 4 files changed, 125 insertions(+) create mode 100644 bin/storage/testimony/sample.txt diff --git a/bin/storage/testimony/sample.txt b/bin/storage/testimony/sample.txt new file mode 100644 index 0000000..125e173 --- /dev/null +++ b/bin/storage/testimony/sample.txt @@ -0,0 +1,4 @@ +1#-#Hobo_Phoenix#hobo-normal#~~\n-- Sample Recording --#wit#1#0#22#1#0#0#0#0#3##-1#0#0#00#0#0#0#0#0#-^(b)hobo-normal^(a)hobo-normal^#-^(b)hobo-normal^(a)hobo-normal^#-^(b)hobo-normal^(a)hobo-normal^#0#|| +1#-#Hobo_Phoenix#hobo-normal#This is a sample recording to test the loading and saving of testimonies.#wit#1#0#22#1#0#0#0#0#1##-1#0#0#00#0#0#0#0#0#-^(b)hobo-normal^(a)hobo-normal^#-^(b)hobo-normal^(a)hobo-normal^#-^(b)hobo-normal^(a)hobo-normal^#0#|| +1#-#Hobo_Phoenix#hobo-bigeyed#If you are reading this your server supports testimony loading correctly.#wit#1#0#22#1#0#0#0#0#1##-1#0#0#00#0#0#0#0#0#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#0#|| +1#-#Hobo_Phoenix#hobo-bigeyed#There is nothing else to be read here.#wit#1#0#22#1#0#0#0#0#1##-1#0#0#00#0#0#0#0#0#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#-^(b)hobo-bigeyed^(a)hobo-bigeyed^#0#|| diff --git a/include/aoclient.h b/include/aoclient.h index 3ab8429..9da4658 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -219,6 +219,7 @@ class AOClient : public QObject { {"ANNOUNCE", 1ULL << 8 }, {"MODCHAT", 1ULL << 9 }, {"MUTE", 1ULL << 10}, + {"SAVETEST", 1ULL << 11}, {"SUPER", ~0ULL }, }; @@ -254,6 +255,10 @@ class AOClient : public QObject { */ QTimer* afk_timer; + /** + * @brief Temporary client permission if client is allowed to save a testimony to server storage. + */ + bool testimony_saving = false; public slots: /** @@ -1143,6 +1148,16 @@ class AOClient : public QObject { */ void cmdAllowIniswap(int argc, QStringList argv); + /** + * @brief Grants a client the temporary permission to save a testimony. + * + * @details ClientID as the target of permission + * + * @iscommand + * + */ + void cmdPermitSaving(int argc, QStringList argv); + ///@} /** @@ -1533,6 +1548,24 @@ class AOClient : public QObject { */ void cmdAddStatement(int argc, QStringList argv); + /** + * @brief Saves a testimony recording to the servers storage. + * + * @details Saves a titled text file which contains the edited packets into a text file. + * + */ + void cmdSaveTestimony(int argc, QStringList argv); + + /** + * @brief Loads testimony for the testimony replay + * + * @details Loads a titled text file which contains the edited packets to be loaded into the QVector. + * Unlike manually adding statements during testifying there is no size validation as the only + * way to create files is saving them. + * + */ + void cmdLoadTestimony(int argc, QStringList argv); + ///@} /** @@ -1850,6 +1883,9 @@ class AOClient : public QObject { {"allowiniswap", {ACLFlags.value("CM"), 0, &AOClient::cmdAllowIniswap}}, {"allow_iniswap", {ACLFlags.value("CM"), 0, &AOClient::cmdAllowIniswap}}, {"afk", {ACLFlags.value("NONE"), 0, &AOClient::cmdAfk}}, + {"savetestimony", {ACLFlags.value("NONE"), 1, &AOClient::cmdSaveTestimony}}, + {"loadtestimony", {ACLFlags.value("CM"), 1, &AOClient::cmdLoadTestimony}}, + {"permitsaving", {ACLFlags.value("MODCHAT"), 1, &AOClient::cmdPermitSaving}}, }; /** diff --git a/src/commands/casing.cpp b/src/commands/casing.cpp index db4ce40..238efd0 100644 --- a/src/commands/casing.cpp +++ b/src/commands/casing.cpp @@ -153,6 +153,7 @@ void AOClient::cmdPauseTestimony(int argc, QStringList argv) { AreaData* area = server->areas[current_area]; area->test_rec = AreaData::TestimonyRecording::STOPPED; + server->broadcast(AOPacket("RT",{"testimony1"}), current_area); sendServerMessage("Testimony has been stopped."); } @@ -165,3 +166,77 @@ void AOClient::cmdAddStatement(int argc, QStringList argv) else sendServerMessage("Unable to add anymore statements. Please remove any unused ones."); } + +void AOClient::cmdSaveTestimony(int argc, QStringList argv) +{ + bool permission_found = false; + if (checkAuth(ACLFlags.value("SAVETEST"))) + permission_found = true; + + if (testimony_saving == true) + permission_found = true; + + if (permission_found) { + AreaData* area = server->areas[current_area]; + if (area->testimony.size() -1 <= 0) { + sendServerMessage("Can't save an empty testimony."); + return; + } + + QDir dir_testimony("storage/testimony"); + if (!dir_testimony.exists()) { + dir_testimony.mkpath("."); + } + + QString testimony_name = argv[0].trimmed().toLower().replace("..",""); // :) + QFile file("storage/testimony/" + testimony_name + ".txt"); + if (file.exists()) { + sendServerMessage("Unable to save testimony. Testimony name already exists."); + return; + } + + QTextStream out(&file); + if(file.open(QIODevice::WriteOnly | QIODevice::Append | QIODevice::Text)) { + for (int i = 0; i <= area->testimony.size() -1; i++) + { + out << area->testimony.at(i).join("#") << "\n"; + } + sendServerMessage("Testimony saved. To load it use /loadtestimony " + testimony_name); + testimony_saving = false; + } + } + else { + sendServerMessage("You don't have permission to save a testimony. Please contact a moderator for permission."); + return; + } +} + +void AOClient::cmdLoadTestimony(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + QDir dir_testimony("storage/testimony"); + if (!dir_testimony.exists()) { + sendServerMessage("Unable to load testimonies. Testimony storage not found."); + return; + } + + QString testimony_name = argv[0].trimmed().toLower().replace("..",""); // :) + QFile file("storage/testimony/" + testimony_name + ".txt"); + if (!file.exists()) { + sendServerMessage("Unable to load testimony. Testimony name not found."); + return; + } + if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) { + sendServerMessage("Unable to load testimony. Permission denied."); + return; + } + + clearTestimony(); + QTextStream in(&file); + while (!in.atEnd()) { + QString line = in.readLine(); + QStringList packet = line.split("#"); + area->testimony.append(packet); + } + sendServerMessage("Testimony loaded successfully. Use /examine to start playback."); +} diff --git a/src/commands/moderation.cpp b/src/commands/moderation.cpp index 2fa8efe..6e3b99c 100644 --- a/src/commands/moderation.cpp +++ b/src/commands/moderation.cpp @@ -402,3 +402,13 @@ void AOClient::cmdAllowIniswap(int argc, QStringList argv) QString state = area->iniswap_allowed ? "allowed." : "disallowed."; sendServerMessage("Iniswapping in this area is now " + state); } + +void AOClient::cmdPermitSaving(int argc, QStringList argv) +{ + AOClient* client = server->getClientByID(argv[0].toInt()); + if (client == nullptr) { + sendServerMessage("Invalid ID."); + return; + } + client->testimony_saving = true; +} From 73cd8f1eb942a3ae7bfe02034b2d6bb7eeabc374 Mon Sep 17 00:00:00 2001 From: Salanto Date: Sun, 18 Apr 2021 13:42:08 +0200 Subject: [PATCH 2/3] Account for older server settings --- include/aoclient.h | 7 ++++--- src/commands/casing.cpp | 15 ++++++++++++--- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/include/aoclient.h b/include/aoclient.h index 332e043..1415187 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1562,16 +1562,17 @@ class AOClient : public QObject { * @brief Saves a testimony recording to the servers storage. * * @details Saves a titled text file which contains the edited packets into a text file. + * The filename will always be lowercase. * */ void cmdSaveTestimony(int argc, QStringList argv); /** - * @brief Loads testimony for the testimony replay + * @brief Loads testimony for the testimony replay. Argument is the testimony name. * * @details Loads a titled text file which contains the edited packets to be loaded into the QVector. - * Unlike manually adding statements during testifying there is no size validation as the only - * way to create files is saving them. + * Validates the size of the testimony to ensure the entire testimony can be replayed. + * Testimony name will always be converted to lowercase. * */ void cmdLoadTestimony(int argc, QStringList argv); diff --git a/src/commands/casing.cpp b/src/commands/casing.cpp index 238efd0..4bb8cfd 100644 --- a/src/commands/casing.cpp +++ b/src/commands/casing.cpp @@ -232,11 +232,20 @@ void AOClient::cmdLoadTestimony(int argc, QStringList argv) } clearTestimony(); + int testimony_lines = 0; QTextStream in(&file); while (!in.atEnd()) { - QString line = in.readLine(); - QStringList packet = line.split("#"); - area->testimony.append(packet); + if (testimony_lines <= server->maximum_statements) { + QString line = in.readLine(); + QStringList packet = line.split("#"); + area->testimony.append(packet); + testimony_lines = testimony_lines + 1; + } + else { + sendServerMessage("Testimony too large to be loaded."); + clearTestimony(); + return; + } } sendServerMessage("Testimony loaded successfully. Use /examine to start playback."); } From 5eabcc191eb925d5a64d0724089175cee0ac16ab Mon Sep 17 00:00:00 2001 From: Salanto Date: Sun, 18 Apr 2021 20:52:27 +0200 Subject: [PATCH 3/3] Add /testimony --- include/aoclient.h | 10 ++++++++++ src/commands/casing.cpp | 18 ++++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/include/aoclient.h b/include/aoclient.h index 1415187..627eebe 100644 --- a/include/aoclient.h +++ b/include/aoclient.h @@ -1558,6 +1558,15 @@ class AOClient : public QObject { */ void cmdAddStatement(int argc, QStringList argv); + + /** + * @brief Sends a list of the testimony to OOC of the requesting client + * + * @details Retrieves all stored IC-Messages of the area and dumps them into OOC with some formatting. + * + */ + void cmdTestimony(int argc, QStringList argv); + /** * @brief Saves a testimony recording to the servers storage. * @@ -1869,6 +1878,7 @@ class AOClient : public QObject { {"ungimp", {ACLFlags.value("MUTE"), 1, &AOClient::cmdUnGimp}}, {"baninfo", {ACLFlags.value("BAN"), 1, &AOClient::cmdBanInfo}}, {"testify", {ACLFlags.value("CM"), 0, &AOClient::cmdTestify}}, + {"testimony", {ACLFlags.value("NONE"), 0, &AOClient::cmdTestimony}}, {"examine", {ACLFlags.value("CM"), 0, &AOClient::cmdExamine}}, {"pause", {ACLFlags.value("CM"), 0, &AOClient::cmdPauseTestimony}}, {"delete", {ACLFlags.value("CM"), 0, &AOClient::cmdDeleteStatement}}, diff --git a/src/commands/casing.cpp b/src/commands/casing.cpp index 4bb8cfd..3a43ac5 100644 --- a/src/commands/casing.cpp +++ b/src/commands/casing.cpp @@ -130,6 +130,24 @@ void AOClient::cmdExamine(int argc, QStringList argv) sendServerMessage("Unable to start replay without prior examination."); } +void AOClient::cmdTestimony(int argc, QStringList argv) +{ + AreaData* area = server->areas[current_area]; + if (area->testimony.size() -1 < 1) { + sendServerMessage("Unable to display empty testimony."); + return; + } + + QString ooc_message; + for (int i = 1; i <= area->testimony.size() -1; i++) + { + QStringList packet = area->testimony.at(i); + QString ic_message = packet[4]; + ooc_message.append( "[" + QString::number(i) + "]" + ic_message + "\n"); + } + sendServerMessage(ooc_message); +} + void AOClient::cmdDeleteStatement(int argc, QStringList argv) { AreaData* area = server->areas[current_area];