[Feature] Add Parcel Feature for RoF2 Clients (#4198)

* Add Parcel Feature

Add the parcel system for RoF2 client

* Fixed a duplicate define

* Reformat

reformating and review changes

* Further Formatting

* Memory Mgmt Updates

Refactored to using unique_ptr/make_unique/etc to avoid manual memory mgmt.

Other format changes

* Refactor db structure

Refactor for db structure of parcels to character_parcels
Removal of parcel_merchants
Addition of npc_types.is_parcel_merchant
Cleanup as a result

* Refactor to use item id 99990 for money transfers.  Removed the money string function as a result, though simplified the messaging related to money.  Other updates based on feedback.

* Move prune routine out of scheduler and into a world process.
Removed RuleI from #define

* Update

* Update database.cpp

* Update database_update_manifest.cpp

* Update main.cpp

* Update client_process.cpp

* Update parcels.cpp

* Remove parcel merchant content to optional sql instead of manifest.

---------

Co-authored-by: Akkadius <akkadius1@gmail.com>

common/repositories/base/base_character_parcels_repository.h

@@ -0,0 +1,463 @@
+/**
+ * DO NOT MODIFY THIS FILE
+ *
+ * This repository was automatically generated and is NOT to be modified directly.
+ * Any repository modifications are meant to be made to the repository extending the base.
+ * Any modifications to base repositories are to be made by the generator only
+ *
+ * @generator ./utils/scripts/generators/repository-generator.pl
+ * @docs https://docs.eqemu.io/developer/repositories
+ */
+
+#ifndef EQEMU_BASE_CHARACTER_PARCELS_REPOSITORY_H
+#define EQEMU_BASE_CHARACTER_PARCELS_REPOSITORY_H
+
+#include "../../database.h"
+#include "../../strings.h"
+#include <ctime>
+
+class BaseCharacterParcelsRepository {
+public:
+	struct CharacterParcels {
+		uint32_t    id;
+		uint32_t    char_id;
+		uint32_t    item_id;
+		uint32_t    slot_id;
+		uint32_t    quantity;
+		std::string from_name;
+		std::string note;
+		time_t      sent_date;
+	};
+
+	static std::string PrimaryKey()
+	{
+		return std::string("id");
+	}
+
+	static std::vector<std::string> Columns()
+	{
+		return {
+			"id",
+			"char_id",
+			"item_id",
+			"slot_id",
+			"quantity",
+			"from_name",
+			"note",
+			"sent_date",
+		};
+	}
+
+	static std::vector<std::string> SelectColumns()
+	{
+		return {
+			"id",
+			"char_id",
+			"item_id",
+			"slot_id",
+			"quantity",
+			"from_name",
+			"note",
+			"UNIX_TIMESTAMP(sent_date)",
+		};
+	}
+
+	static std::string ColumnsRaw()
+	{
+		return std::string(Strings::Implode(", ", Columns()));
+	}
+
+	static std::string SelectColumnsRaw()
+	{
+		return std::string(Strings::Implode(", ", SelectColumns()));
+	}
+
+	static std::string TableName()
+	{
+		return std::string("character_parcels");
+	}
+
+	static std::string BaseSelect()
+	{
+		return fmt::format(
+			"SELECT {} FROM {}",
+			SelectColumnsRaw(),
+			TableName()
+		);
+	}
+
+	static std::string BaseInsert()
+	{
+		return fmt::format(
+			"INSERT INTO {} ({}) ",
+			TableName(),
+			ColumnsRaw()
+		);
+	}
+
+	static CharacterParcels NewEntity()
+	{
+		CharacterParcels e{};
+
+		e.id        = 0;
+		e.char_id   = 0;
+		e.item_id   = 0;
+		e.slot_id   = 0;
+		e.quantity  = 0;
+		e.from_name = "";
+		e.note      = "";
+		e.sent_date = 0;
+
+		return e;
+	}
+
+	static CharacterParcels GetCharacterParcels(
+		const std::vector<CharacterParcels> &character_parcelss,
+		int character_parcels_id
+	)
+	{
+		for (auto &character_parcels : character_parcelss) {
+			if (character_parcels.id == character_parcels_id) {
+				return character_parcels;
+			}
+		}
+
+		return NewEntity();
+	}
+
+	static CharacterParcels FindOne(
+		Database& db,
+		int character_parcels_id
+	)
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} WHERE {} = {} LIMIT 1",
+				BaseSelect(),
+				PrimaryKey(),
+				character_parcels_id
+			)
+		);
+
+		auto row = results.begin();
+		if (results.RowCount() == 1) {
+			CharacterParcels e{};
+
+			e.id        = row[0] ? static_cast<uint32_t>(strtoul(row[0], nullptr, 10)) : 0;
+			e.char_id   = row[1] ? static_cast<uint32_t>(strtoul(row[1], nullptr, 10)) : 0;
+			e.item_id   = row[2] ? static_cast<uint32_t>(strtoul(row[2], nullptr, 10)) : 0;
+			e.slot_id   = row[3] ? static_cast<uint32_t>(strtoul(row[3], nullptr, 10)) : 0;
+			e.quantity  = row[4] ? static_cast<uint32_t>(strtoul(row[4], nullptr, 10)) : 0;
+			e.from_name = row[5] ? row[5] : "";
+			e.note      = row[6] ? row[6] : "";
+			e.sent_date = strtoll(row[7] ? row[7] : "-1", nullptr, 10);
+
+			return e;
+		}
+
+		return NewEntity();
+	}
+
+	static int DeleteOne(
+		Database& db,
+		int character_parcels_id
+	)
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"DELETE FROM {} WHERE {} = {}",
+				TableName(),
+				PrimaryKey(),
+				character_parcels_id
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static int UpdateOne(
+		Database& db,
+		const CharacterParcels &e
+	)
+	{
+		std::vector<std::string> v;
+
+		auto columns = Columns();
+
+		v.push_back(columns[1] + " = " + std::to_string(e.char_id));
+		v.push_back(columns[2] + " = " + std::to_string(e.item_id));
+		v.push_back(columns[3] + " = " + std::to_string(e.slot_id));
+		v.push_back(columns[4] + " = " + std::to_string(e.quantity));
+		v.push_back(columns[5] + " = '" + Strings::Escape(e.from_name) + "'");
+		v.push_back(columns[6] + " = '" + Strings::Escape(e.note) + "'");
+		v.push_back(columns[7] + " = FROM_UNIXTIME(" + (e.sent_date > 0 ? std::to_string(e.sent_date) : "null") + ")");
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"UPDATE {} SET {} WHERE {} = {}",
+				TableName(),
+				Strings::Implode(", ", v),
+				PrimaryKey(),
+				e.id
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static CharacterParcels InsertOne(
+		Database& db,
+		CharacterParcels e
+	)
+	{
+		std::vector<std::string> v;
+
+		v.push_back(std::to_string(e.id));
+		v.push_back(std::to_string(e.char_id));
+		v.push_back(std::to_string(e.item_id));
+		v.push_back(std::to_string(e.slot_id));
+		v.push_back(std::to_string(e.quantity));
+		v.push_back("'" + Strings::Escape(e.from_name) + "'");
+		v.push_back("'" + Strings::Escape(e.note) + "'");
+		v.push_back("FROM_UNIXTIME(" + (e.sent_date > 0 ? std::to_string(e.sent_date) : "null") + ")");
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} VALUES ({})",
+				BaseInsert(),
+				Strings::Implode(",", v)
+			)
+		);
+
+		if (results.Success()) {
+			e.id = results.LastInsertedID();
+			return e;
+		}
+
+		e = NewEntity();
+
+		return e;
+	}
+
+	static int InsertMany(
+		Database& db,
+		const std::vector<CharacterParcels> &entries
+	)
+	{
+		std::vector<std::string> insert_chunks;
+
+		for (auto &e: entries) {
+			std::vector<std::string> v;
+
+			v.push_back(std::to_string(e.id));
+			v.push_back(std::to_string(e.char_id));
+			v.push_back(std::to_string(e.item_id));
+			v.push_back(std::to_string(e.slot_id));
+			v.push_back(std::to_string(e.quantity));
+			v.push_back("'" + Strings::Escape(e.from_name) + "'");
+			v.push_back("'" + Strings::Escape(e.note) + "'");
+			v.push_back("FROM_UNIXTIME(" + (e.sent_date > 0 ? std::to_string(e.sent_date) : "null") + ")");
+
+			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
+		}
+
+		std::vector<std::string> v;
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} VALUES {}",
+				BaseInsert(),
+				Strings::Implode(",", insert_chunks)
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static std::vector<CharacterParcels> All(Database& db)
+	{
+		std::vector<CharacterParcels> all_entries;
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{}",
+				BaseSelect()
+			)
+		);
+
+		all_entries.reserve(results.RowCount());
+
+		for (auto row = results.begin(); row != results.end(); ++row) {
+			CharacterParcels e{};
+
+			e.id        = row[0] ? static_cast<uint32_t>(strtoul(row[0], nullptr, 10)) : 0;
+			e.char_id   = row[1] ? static_cast<uint32_t>(strtoul(row[1], nullptr, 10)) : 0;
+			e.item_id   = row[2] ? static_cast<uint32_t>(strtoul(row[2], nullptr, 10)) : 0;
+			e.slot_id   = row[3] ? static_cast<uint32_t>(strtoul(row[3], nullptr, 10)) : 0;
+			e.quantity  = row[4] ? static_cast<uint32_t>(strtoul(row[4], nullptr, 10)) : 0;
+			e.from_name = row[5] ? row[5] : "";
+			e.note      = row[6] ? row[6] : "";
+			e.sent_date = strtoll(row[7] ? row[7] : "-1", nullptr, 10);
+
+			all_entries.push_back(e);
+		}
+
+		return all_entries;
+	}
+
+	static std::vector<CharacterParcels> GetWhere(Database& db, const std::string &where_filter)
+	{
+		std::vector<CharacterParcels> all_entries;
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} WHERE {}",
+				BaseSelect(),
+				where_filter
+			)
+		);
+
+		all_entries.reserve(results.RowCount());
+
+		for (auto row = results.begin(); row != results.end(); ++row) {
+			CharacterParcels e{};
+
+			e.id        = row[0] ? static_cast<uint32_t>(strtoul(row[0], nullptr, 10)) : 0;
+			e.char_id   = row[1] ? static_cast<uint32_t>(strtoul(row[1], nullptr, 10)) : 0;
+			e.item_id   = row[2] ? static_cast<uint32_t>(strtoul(row[2], nullptr, 10)) : 0;
+			e.slot_id   = row[3] ? static_cast<uint32_t>(strtoul(row[3], nullptr, 10)) : 0;
+			e.quantity  = row[4] ? static_cast<uint32_t>(strtoul(row[4], nullptr, 10)) : 0;
+			e.from_name = row[5] ? row[5] : "";
+			e.note      = row[6] ? row[6] : "";
+			e.sent_date = strtoll(row[7] ? row[7] : "-1", nullptr, 10);
+
+			all_entries.push_back(e);
+		}
+
+		return all_entries;
+	}
+
+	static int DeleteWhere(Database& db, const std::string &where_filter)
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"DELETE FROM {} WHERE {}",
+				TableName(),
+				where_filter
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static int Truncate(Database& db)
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"TRUNCATE TABLE {}",
+				TableName()
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static int64 GetMaxId(Database& db)
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"SELECT COALESCE(MAX({}), 0) FROM {}",
+				PrimaryKey(),
+				TableName()
+			)
+		);
+
+		return (results.Success() && results.begin()[0] ? strtoll(results.begin()[0], nullptr, 10) : 0);
+	}
+
+	static int64 Count(Database& db, const std::string &where_filter = "")
+	{
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"SELECT COUNT(*) FROM {} {}",
+				TableName(),
+				(where_filter.empty() ? "" : "WHERE " + where_filter)
+			)
+		);
+
+		return (results.Success() && results.begin()[0] ? strtoll(results.begin()[0], nullptr, 10) : 0);
+	}
+
+	static std::string BaseReplace()
+	{
+		return fmt::format(
+			"REPLACE INTO {} ({}) ",
+			TableName(),
+			ColumnsRaw()
+		);
+	}
+
+	static int ReplaceOne(
+		Database& db,
+		const CharacterParcels &e
+	)
+	{
+		std::vector<std::string> v;
+
+		v.push_back(std::to_string(e.id));
+		v.push_back(std::to_string(e.char_id));
+		v.push_back(std::to_string(e.item_id));
+		v.push_back(std::to_string(e.slot_id));
+		v.push_back(std::to_string(e.quantity));
+		v.push_back("'" + Strings::Escape(e.from_name) + "'");
+		v.push_back("'" + Strings::Escape(e.note) + "'");
+		v.push_back("FROM_UNIXTIME(" + (e.sent_date > 0 ? std::to_string(e.sent_date) : "null") + ")");
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} VALUES ({})",
+				BaseReplace(),
+				Strings::Implode(",", v)
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+
+	static int ReplaceMany(
+		Database& db,
+		const std::vector<CharacterParcels> &entries
+	)
+	{
+		std::vector<std::string> insert_chunks;
+
+		for (auto &e: entries) {
+			std::vector<std::string> v;
+
+			v.push_back(std::to_string(e.id));
+			v.push_back(std::to_string(e.char_id));
+			v.push_back(std::to_string(e.item_id));
+			v.push_back(std::to_string(e.slot_id));
+			v.push_back(std::to_string(e.quantity));
+			v.push_back("'" + Strings::Escape(e.from_name) + "'");
+			v.push_back("'" + Strings::Escape(e.note) + "'");
+			v.push_back("FROM_UNIXTIME(" + (e.sent_date > 0 ? std::to_string(e.sent_date) : "null") + ")");
+
+			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
+		}
+
+		std::vector<std::string> v;
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"{} VALUES {}",
+				BaseReplace(),
+				Strings::Implode(",", insert_chunks)
+			)
+		);
+
+		return (results.Success() ? results.RowsAffected() : 0);
+	}
+};
+
+#endif //EQEMU_BASE_CHARACTER_PARCELS_REPOSITORY_H

common/repositories/base/base_npc_types_repository.h

@@ -146,6 +146,7 @@ public:
 		int32_t     heroic_strikethrough;
 		int32_t     faction_amount;
 		uint8_t     keeps_sold_items;
+		uint8_t     is_parcel_merchant;
 	};
 
 	static std::string PrimaryKey()
@@ -283,6 +284,7 @@ public:
 			"heroic_strikethrough",
 			"faction_amount",
 			"keeps_sold_items",
+			"is_parcel_merchant",
 		};
 	}
 
@@ -416,6 +418,7 @@ public:
 			"heroic_strikethrough",
 			"faction_amount",
 			"keeps_sold_items",
+			"is_parcel_merchant",
 		};
 	}
 
@@ -583,6 +586,7 @@ public:
 		e.heroic_strikethrough   = 0;
 		e.faction_amount         = 0;
 		e.keeps_sold_items       = 1;
+		e.is_parcel_merchant     = 0;
 
 		return e;
 	}
@@ -746,6 +750,7 @@ public:
 			e.heroic_strikethrough   = row[124] ? static_cast<int32_t>(atoi(row[124])) : 0;
 			e.faction_amount         = row[125] ? static_cast<int32_t>(atoi(row[125])) : 0;
 			e.keeps_sold_items       = row[126] ? static_cast<uint8_t>(strtoul(row[126], nullptr, 10)) : 1;
+			e.is_parcel_merchant     = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 0;
 
 			return e;
 		}
@@ -905,6 +910,7 @@ public:
 		v.push_back(columns[124] + " = " + std::to_string(e.heroic_strikethrough));
 		v.push_back(columns[125] + " = " + std::to_string(e.faction_amount));
 		v.push_back(columns[126] + " = " + std::to_string(e.keeps_sold_items));
+		v.push_back(columns[127] + " = " + std::to_string(e.is_parcel_merchant));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1053,6 +1059,7 @@ public:
 		v.push_back(std::to_string(e.heroic_strikethrough));
 		v.push_back(std::to_string(e.faction_amount));
 		v.push_back(std::to_string(e.keeps_sold_items));
+		v.push_back(std::to_string(e.is_parcel_merchant));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1209,6 +1216,7 @@ public:
 			v.push_back(std::to_string(e.heroic_strikethrough));
 			v.push_back(std::to_string(e.faction_amount));
 			v.push_back(std::to_string(e.keeps_sold_items));
+			v.push_back(std::to_string(e.is_parcel_merchant));
 
 			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
 		}
@@ -1369,6 +1377,7 @@ public:
 			e.heroic_strikethrough   = row[124] ? static_cast<int32_t>(atoi(row[124])) : 0;
 			e.faction_amount         = row[125] ? static_cast<int32_t>(atoi(row[125])) : 0;
 			e.keeps_sold_items       = row[126] ? static_cast<uint8_t>(strtoul(row[126], nullptr, 10)) : 1;
+			e.is_parcel_merchant     = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 0;
 
 			all_entries.push_back(e);
 		}
@@ -1520,6 +1529,7 @@ public:
 			e.heroic_strikethrough   = row[124] ? static_cast<int32_t>(atoi(row[124])) : 0;
 			e.faction_amount         = row[125] ? static_cast<int32_t>(atoi(row[125])) : 0;
 			e.keeps_sold_items       = row[126] ? static_cast<uint8_t>(strtoul(row[126], nullptr, 10)) : 1;
+			e.is_parcel_merchant     = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 0;
 
 			all_entries.push_back(e);
 		}
@@ -1721,6 +1731,7 @@ public:
 		v.push_back(std::to_string(e.heroic_strikethrough));
 		v.push_back(std::to_string(e.faction_amount));
 		v.push_back(std::to_string(e.keeps_sold_items));
+		v.push_back(std::to_string(e.is_parcel_merchant));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1870,6 +1881,7 @@ public:
 			v.push_back(std::to_string(e.heroic_strikethrough));
 			v.push_back(std::to_string(e.faction_amount));
 			v.push_back(std::to_string(e.keeps_sold_items));
+			v.push_back(std::to_string(e.is_parcel_merchant));
 
 			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
 		}

common/repositories/character_parcels_repository.h

@@ -0,0 +1,83 @@
+#ifndef EQEMU_CHARACTER_PARCELS_REPOSITORY_H
+#define EQEMU_CHARACTER_PARCELS_REPOSITORY_H
+
+#include "../database.h"
+#include "../strings.h"
+#include "base/base_character_parcels_repository.h"
+
+class CharacterParcelsRepository: public BaseCharacterParcelsRepository {
+public:
+
+	/**
+	 * This file was auto generated and can be modified and extended upon
+	 *
+	 * Base repository methods are automatically
+	 * generated in the "base" version of this repository. The base repository
+	 * is immutable and to be left untouched, while methods in this class
+	 * are used as extension methods for more specific persistence-layer
+	 * accessors or mutators.
+	 *
+	 * Base Methods (Subject to be expanded upon in time)
+	 *
+	 * Note: Not all tables are designed appropriately to fit functionality with all base methods
+	 *
+	 * InsertOne
+	 * UpdateOne
+	 * DeleteOne
+	 * FindOne
+	 * GetWhere(std::string where_filter)
+	 * DeleteWhere(std::string where_filter)
+	 * InsertMany
+	 * All
+	 *
+	 * Example custom methods in a repository
+	 *
+	 * ParcelsRepository::GetByZoneAndVersion(int zone_id, int zone_version)
+	 * ParcelsRepository::GetWhereNeverExpires()
+	 * ParcelsRepository::GetWhereXAndY()
+	 * ParcelsRepository::DeleteWhereXAndY()
+	 *
+	 * Most of the above could be covered by base methods, but if you as a developer
+	 * find yourself re-using logic for other parts of the code, its best to just make a
+	 * method that can be re-used easily elsewhere especially if it can use a base repository
+	 * method and encapsulate filters there
+	 */
+
+	// Custom extended repository methods here
+	struct ParcelCountAndCharacterName
+	{
+		std::string character_name;
+		uint32      char_id;
+		uint32      parcel_count;
+	};
+
+	static std::vector<ParcelCountAndCharacterName> GetParcelCountAndCharacterName(Database &db, const std::string &character_name)
+	{
+		std::vector<ParcelCountAndCharacterName> all_entries;
+
+		auto results = db.QueryDatabase(
+			fmt::format(
+				"SELECT c.name, COUNT(p.id), c.id FROM character_data c "
+				"JOIN character_parcels p ON p.char_id = c.id "
+				"WHERE c.name = '{}' "
+				"LIMIT 1",
+				character_name)
+		);
+
+		all_entries.reserve(results.RowCount());
+
+		for(auto row = results.begin(); row != results.end(); ++row) {
+			ParcelCountAndCharacterName e {};
+
+			e.character_name = row[0] ? row[0] : "";
+			e.parcel_count   = row[1] ? Strings::ToUnsignedInt(row[1]) : 0;
+			e.char_id        = row[2] ? Strings::ToUnsignedInt(row[2]) : 0;
+
+			all_entries.push_back(e);
+		}
+
+		return all_entries;
+	}
+};
+
+#endif //EQEMU_CHARACTER_PARCELS_REPOSITORY_H