[Items] Overhaul Item Hand-in System (#4593)

* [Items] Overhaul Item Hand-in System

* Edge case lua fix

* Merge fix

* I'm going to be amazed if this works first try

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Update linux-build.sh

* Add protections against scripts that hand back items themselves

* Remove EVENT_ITEM_ScriptStopReturn

* test

* Update npc_handins.cpp

* Add Items:AlwaysReturnHandins

* Update spdat.cpp

* Bypass update prompt on CI

common/database/database_update.cpp

@@ -192,7 +192,7 @@ bool DatabaseUpdate::UpdateManifest(
 			LogInfo("{}", Strings::Repeat("-", BREAK_LENGTH));
 		}
 
-		if (force_interactive) {
+		if (force_interactive && !std::getenv("FORCE_INTERACTIVE")) {
 			LogInfo("{}", Strings::Repeat("-", BREAK_LENGTH));
 			LogInfo("Some migrations require user input. Running interactively");
 			LogInfo("This is usually due to a major change that could cause data loss");

common/database/database_update_manifest.cpp

@@ -6491,8 +6491,19 @@ ALTER TABLE `merchantlist_temp`
 MODIFY COLUMN `slot` int UNSIGNED NOT NULL DEFAULT 0 AFTER `npcid`;
 )",
 		.content_schema_update = false
+	},
+	ManifestEntry{
+		.version = 9300,
+		.description = "2024_10_15_npc_types_multiquest_enabled.sql",
+		.check = "SHOW COLUMNS FROM `npc_types` LIKE 'multiquest_enabled'",
+		.condition = "empty",
+		.match = "",
+		.sql = R"(
+ALTER TABLE `npc_types`
+ADD COLUMN `multiquest_enabled` tinyint(1) UNSIGNED NOT NULL DEFAULT 0 AFTER `is_parcel_merchant`;
+)",
+		.content_schema_update = true
 	}
-
 // -- template; copy/paste this when you need to create a new entry
 //	ManifestEntry{
 //		.version = 9228,

common/eqemu_logsys.cpp

@@ -105,6 +105,8 @@ EQEmuLogSys *EQEmuLogSys::LoadLogSettingsDefaults()
 	log_settings[Logs::QuestErrors].log_to_console          = static_cast<uint8>(Logs::General);
 	log_settings[Logs::EqTime].log_to_console               = static_cast<uint8>(Logs::General);
 	log_settings[Logs::EqTime].log_to_gmsay                 = static_cast<uint8>(Logs::General);
+	log_settings[Logs::NpcHandin].log_to_console            = static_cast<uint8>(Logs::General);
+	log_settings[Logs::NpcHandin].log_to_gmsay              = static_cast<uint8>(Logs::General);
 
 	/**
 	 * RFC 5424

common/eqemu_logsys.h

@@ -148,6 +148,7 @@ namespace Logs {
 		BotSettings,
 		BotSpellChecks,
 		BotSpellTypeChecks,
+		NpcHandin,
 		MaxCategoryID /* Don't Remove this */
 	};
 
@@ -254,7 +255,8 @@ namespace Logs {
 		"KSM", // Kernel Samepage Merging
 		"Bot Settings",
 		"Bot Spell Checks",
-		"Bot Spell Type Checks"
+		"Bot Spell Type Checks",
+		"NpcHandin"
 	};
 }
 

common/eqemu_logsys_log_aliases.h

@@ -904,6 +904,16 @@
         OutF(LogSys, Logs::Detail, Logs::BotSpellTypeChecks, __FILE__, __func__, __LINE__, message, ##__VA_ARGS__);\
 } while (0)
 
+#define LogNpcHandin(message, ...) do {\
+    if (LogSys.IsLogEnabled(Logs::General, Logs::NpcHandin))\
+        OutF(LogSys, Logs::General, Logs::NpcHandin, __FILE__, __func__, __LINE__, message, ##__VA_ARGS__);\
+} while (0)
+
+#define LogNpcHandinDetail(message, ...) do {\
+    if (LogSys.IsLogEnabled(Logs::Detail, Logs::NpcHandin))\
+        OutF(LogSys, Logs::Detail, Logs::NpcHandin, __FILE__, __func__, __LINE__, message, ##__VA_ARGS__);\
+} while (0)
+
 #define Log(debug_level, log_category, message, ...) do {\
     if (LogSys.IsLogEnabled(debug_level, log_category))\
         LogSys.Out(debug_level, log_category, __FILE__, __func__, __LINE__, message, ##__VA_ARGS__);\

common/events/player_event_discord_formatter.cpp

@@ -714,6 +714,18 @@ std::string PlayerEventDiscordFormatter::FormatNPCHandinEvent(
 				h.charges > 1 ? fmt::format(" Charges: {}", h.charges) : "",
 				h.attuned ? " (Attuned)" : ""
 			);
+
+			for (int i = 0; i < h.augment_ids.size(); i++) {
+				if (!Strings::EqualFold(h.augment_names[i], "None")) {
+					const uint8 slot_id = (i + 1);
+					handin_items_info += fmt::format(
+						"Augment {}: {} ({})\n",
+						slot_id,
+						h.augment_names[i],
+						h.augment_ids[i]
+					);
+				}
+			}
 		}
 	}
 
@@ -727,6 +739,18 @@ std::string PlayerEventDiscordFormatter::FormatNPCHandinEvent(
 				r.charges > 1 ? fmt::format(" Charges: {}", r.charges) : "",
 				r.attuned ? " (Attuned)" : ""
 			);
+
+			for (int i = 0; i < r.augment_ids.size(); i++) {
+				if (!Strings::EqualFold(r.augment_names[i], "None")) {
+					const uint8 slot_id = (i + 1);
+					return_items_info += fmt::format(
+						"Augment {}: {} ({})\n",
+						slot_id,
+						r.augment_names[i],
+						r.augment_ids[i]
+					);
+				}
+			}
 		}
 	}
 

common/item_data.cpp

@@ -220,6 +220,34 @@ bool EQ::ItemData::IsType1HWeapon() const
 	return ((ItemType == item::ItemType1HBlunt) || (ItemType == item::ItemType1HSlash) || (ItemType == item::ItemType1HPiercing) || (ItemType == item::ItemTypeMartial));
 }
 
+bool EQ::ItemData::IsPetUsable() const
+{
+	if (ItemClass == item::ItemClassBag) {
+		return true;
+	}
+
+	// if it's a misc item and has slots, it's wearable
+	// this item type is conflated with many other item types
+	if (ItemClass == item::ItemTypeMisc && Slots != 0) {
+		return true;
+	}
+
+	switch (ItemType) {
+		case item::ItemType1HBlunt:
+		case item::ItemType1HSlash:
+		case item::ItemType1HPiercing:
+		case item::ItemType2HBlunt:
+		case item::ItemType2HSlash:
+		case item::ItemTypeMartial:
+		case item::ItemTypeShield:
+		case item::ItemTypeArmor:
+		case item::ItemTypeJewelry:
+			return true;
+		default:
+			return false;
+	}
+}
+
 bool EQ::ItemData::IsType2HWeapon() const
 {
 	return ((ItemType == item::ItemType2HBlunt) || (ItemType == item::ItemType2HSlash) || (ItemType == item::ItemType2HPiercing));

common/item_data.h

@@ -550,6 +550,7 @@ namespace EQ
 		bool IsType1HWeapon() const;
 		bool IsType2HWeapon() const;
 		bool IsTypeShield() const;
+		bool IsPetUsable() const;
 		bool IsQuestItem() const;
 
 		static bool CheckLoreConflict(const ItemData* l_item, const ItemData* r_item);

common/item_instance.cpp

@@ -1785,6 +1785,18 @@ std::vector<uint32> EQ::ItemInstance::GetAugmentIDs() const
 	return augments;
 }
 
+std::vector<std::string> EQ::ItemInstance::GetAugmentNames() const
+{
+	std::vector<std::string> augment_names;
+
+	for (uint8 slot_id = invaug::SOCKET_BEGIN; slot_id <= invaug::SOCKET_END; slot_id++) {
+		const auto augment = GetAugment(slot_id);
+		augment_names.push_back(augment ? augment->GetItem()->Name : "None");
+	}
+
+	return augment_names;
+}
+
 int EQ::ItemInstance::GetItemRegen(bool augments) const
 {
 	int        stat = 0;

common/item_instance.h

@@ -305,6 +305,7 @@ namespace EQ
 		int GetItemSkillsStat(EQ::skills::SkillType skill, bool augments = false) const;
 		uint32 GetItemGuildFavor() const;
 		std::vector<uint32> GetAugmentIDs() const;
+		std::vector<std::string> GetAugmentNames() const;
 		static void AddGUIDToMap(uint64 existing_serial_number);
 		static void ClearGUIDMap();
 

common/repositories/base/base_npc_types_repository.h

@@ -123,7 +123,7 @@ public:
 		int8_t      legtexture;
 		int8_t      feettexture;
 		int8_t      light;
-		int8_t      walkspeed;
+		float       walkspeed;
 		int32_t     peqid;
 		int8_t      unique_;
 		int8_t      fixed;
@@ -148,6 +148,7 @@ public:
 		int32_t     faction_amount;
 		uint8_t     keeps_sold_items;
 		uint8_t     is_parcel_merchant;
+		uint8_t     multiquest_enabled;
 	};
 
 	static std::string PrimaryKey()
@@ -287,6 +288,7 @@ public:
 			"faction_amount",
 			"keeps_sold_items",
 			"is_parcel_merchant",
+			"multiquest_enabled",
 		};
 	}
 
@@ -422,6 +424,7 @@ public:
 			"faction_amount",
 			"keeps_sold_items",
 			"is_parcel_merchant",
+			"multiquest_enabled",
 		};
 	}
 
@@ -591,6 +594,7 @@ public:
 		e.faction_amount         = 0;
 		e.keeps_sold_items       = 1;
 		e.is_parcel_merchant     = 0;
+		e.multiquest_enabled     = 0;
 
 		return e;
 	}
@@ -731,7 +735,7 @@ public:
 			e.legtexture             = row[101] ? static_cast<int8_t>(atoi(row[101])) : 0;
 			e.feettexture            = row[102] ? static_cast<int8_t>(atoi(row[102])) : 0;
 			e.light                  = row[103] ? static_cast<int8_t>(atoi(row[103])) : 0;
-			e.walkspeed              = row[104] ? static_cast<int8_t>(atoi(row[104])) : 0;
+			e.walkspeed              = row[104] ? strtof(row[104], nullptr) : 0;
 			e.peqid                  = row[105] ? static_cast<int32_t>(atoi(row[105])) : 0;
 			e.unique_                = row[106] ? static_cast<int8_t>(atoi(row[106])) : 0;
 			e.fixed                  = row[107] ? static_cast<int8_t>(atoi(row[107])) : 0;
@@ -756,6 +760,7 @@ public:
 			e.faction_amount         = row[126] ? static_cast<int32_t>(atoi(row[126])) : 0;
 			e.keeps_sold_items       = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 1;
 			e.is_parcel_merchant     = row[128] ? static_cast<uint8_t>(strtoul(row[128], nullptr, 10)) : 0;
+			e.multiquest_enabled     = row[129] ? static_cast<uint8_t>(strtoul(row[129], nullptr, 10)) : 0;
 
 			return e;
 		}
@@ -917,6 +922,7 @@ public:
 		v.push_back(columns[126] + " = " + std::to_string(e.faction_amount));
 		v.push_back(columns[127] + " = " + std::to_string(e.keeps_sold_items));
 		v.push_back(columns[128] + " = " + std::to_string(e.is_parcel_merchant));
+		v.push_back(columns[129] + " = " + std::to_string(e.multiquest_enabled));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1067,6 +1073,7 @@ public:
 		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));
+		v.push_back(std::to_string(e.multiquest_enabled));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1225,6 +1232,7 @@ public:
 			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));
+			v.push_back(std::to_string(e.multiquest_enabled));
 
 			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
 		}
@@ -1362,7 +1370,7 @@ public:
 			e.legtexture             = row[101] ? static_cast<int8_t>(atoi(row[101])) : 0;
 			e.feettexture            = row[102] ? static_cast<int8_t>(atoi(row[102])) : 0;
 			e.light                  = row[103] ? static_cast<int8_t>(atoi(row[103])) : 0;
-			e.walkspeed              = row[104] ? static_cast<int8_t>(atoi(row[104])) : 0;
+			e.walkspeed              = row[104] ? strtof(row[104], nullptr) : 0;
 			e.peqid                  = row[105] ? static_cast<int32_t>(atoi(row[105])) : 0;
 			e.unique_                = row[106] ? static_cast<int8_t>(atoi(row[106])) : 0;
 			e.fixed                  = row[107] ? static_cast<int8_t>(atoi(row[107])) : 0;
@@ -1387,6 +1395,7 @@ public:
 			e.faction_amount         = row[126] ? static_cast<int32_t>(atoi(row[126])) : 0;
 			e.keeps_sold_items       = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 1;
 			e.is_parcel_merchant     = row[128] ? static_cast<uint8_t>(strtoul(row[128], nullptr, 10)) : 0;
+			e.multiquest_enabled     = row[129] ? static_cast<uint8_t>(strtoul(row[129], nullptr, 10)) : 0;
 
 			all_entries.push_back(e);
 		}
@@ -1515,7 +1524,7 @@ public:
 			e.legtexture             = row[101] ? static_cast<int8_t>(atoi(row[101])) : 0;
 			e.feettexture            = row[102] ? static_cast<int8_t>(atoi(row[102])) : 0;
 			e.light                  = row[103] ? static_cast<int8_t>(atoi(row[103])) : 0;
-			e.walkspeed              = row[104] ? static_cast<int8_t>(atoi(row[104])) : 0;
+			e.walkspeed              = row[104] ? strtof(row[104], nullptr) : 0;
 			e.peqid                  = row[105] ? static_cast<int32_t>(atoi(row[105])) : 0;
 			e.unique_                = row[106] ? static_cast<int8_t>(atoi(row[106])) : 0;
 			e.fixed                  = row[107] ? static_cast<int8_t>(atoi(row[107])) : 0;
@@ -1540,6 +1549,7 @@ public:
 			e.faction_amount         = row[126] ? static_cast<int32_t>(atoi(row[126])) : 0;
 			e.keeps_sold_items       = row[127] ? static_cast<uint8_t>(strtoul(row[127], nullptr, 10)) : 1;
 			e.is_parcel_merchant     = row[128] ? static_cast<uint8_t>(strtoul(row[128], nullptr, 10)) : 0;
+			e.multiquest_enabled     = row[129] ? static_cast<uint8_t>(strtoul(row[129], nullptr, 10)) : 0;
 
 			all_entries.push_back(e);
 		}
@@ -1743,6 +1753,7 @@ public:
 		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));
+		v.push_back(std::to_string(e.multiquest_enabled));
 
 		auto results = db.QueryDatabase(
 			fmt::format(
@@ -1894,6 +1905,7 @@ public:
 			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));
+			v.push_back(std::to_string(e.multiquest_enabled));
 
 			insert_chunks.push_back("(" + Strings::Implode(",", v) + ")");
 		}

common/ruletypes.h

@@ -283,10 +283,9 @@ RULE_CATEGORY(Pets)
 RULE_REAL(Pets, AttackCommandRange, 150, "Range at which a pet will respond to attack commands")
 RULE_BOOL(Pets, UnTargetableSwarmPet, false, "Setting whether swarm pets should be targetable")
 RULE_REAL(Pets, PetPowerLevelCap, 10, "Maximum number of levels a player pet can go up with pet power")
-RULE_BOOL(Pets, CanTakeNoDrop, false, "Setting whether anyone can give no-drop items to pets")
-RULE_BOOL(Pets, CanTakeQuestItems, true, "Setting whether anyone can give quest items to pets")
 RULE_BOOL(Pets, LivelikeBreakCharmOnInvis, true, "Default: true will break charm on any type of invis (hide/ivu/iva/etc) false will only break if the pet can not see you (ex. you have an undead pet and cast IVU")
 RULE_BOOL(Pets, ClientPetsUseOwnerNameInLastName, true, "Disable this to keep client pet's last names from being owner_name's pet")
+RULE_BOOL(Pets, CanTakeNoDrop, false, "Setting whether anyone can give no-drop items to pets")
 RULE_INT(Pets, PetTauntRange, 150, "Range at which a pet will taunt targets.")
 RULE_CATEGORY_END()
 
@@ -666,8 +665,6 @@ RULE_BOOL(NPC, EnableNPCQuestJournal, false, "Setting whether the NPC Quest Jour
 RULE_INT(NPC, LastFightingDelayMovingMin, 10000, "Minimum time before mob goes home after all aggro loss (milliseconds)")
 RULE_INT(NPC, LastFightingDelayMovingMax, 20000, "Maximum time before mob goes home after all aggro loss (milliseconds)")
 RULE_BOOL(NPC, SmartLastFightingDelayMoving, true, "When true, mobs that started going home previously will do so again immediately if still on FD hate list")
-RULE_BOOL(NPC, ReturnNonQuestNoDropItems, false, "Returns NO DROP items on NPC that don't have an EVENT_TRADE sub in their script")
-RULE_BOOL(NPC, ReturnQuestItemsFromNonQuestNPCs, false, "Returns Quest items traded to NPCs that are not flagged as a Quest NPC")
 RULE_INT(NPC, StartEnrageValue, 9, " Percentage HP that an NPC will begin to enrage")
 RULE_BOOL(NPC, LiveLikeEnrage, false, "If set to true then only player controlled pets will enrage")
 RULE_BOOL(NPC, EnableMeritBasedFaction, false, "If set to true, faction will be given in the same way as experience (solo/group/raid)")
@@ -1144,6 +1141,7 @@ RULE_BOOL(Items, DisablePotionBelt, false, "Enable this to disable Potion Belt I
 RULE_BOOL(Items, DisableSpellFocusEffects, false, "Enable this to disable Spell Focus Effects on Items")
 RULE_BOOL(Items, SummonItemAllowInvisibleAugments, false, "Enable this to allow augments to be put in invisible augment slots of items in Client::SummonItem")
 RULE_BOOL(Items, AugmentItemAllowInvisibleAugments, false, "Enable this to allow augments to be put in invisible augment slots by players")
+RULE_BOOL(Items, AlwaysReturnHandins, true, "Enable this to always return handins to the player")
 RULE_CATEGORY_END()
 
 RULE_CATEGORY(Parcel)

common/spdat.cpp

@@ -233,8 +233,8 @@ bool IsDamageOverTimeSpell(uint16 spell_id)
 	for (int i = 0; i < EFFECT_COUNT; i++) {
 		const auto effect_id = spell.effect_id[i];
 		if (
-			spell.base_value[i] < 0 && 
-			effect_id == SE_CurrentHP && 
+			spell.base_value[i] < 0 &&
+			effect_id == SE_CurrentHP &&
 			spell.buff_duration > 1
 		) {
 			return true;
@@ -629,7 +629,7 @@ bool IsPBAENukeSpell(uint16 spell_id)
 	) {
 		return true;
 	}
-	
+
 	return false;
 }
 
@@ -670,7 +670,7 @@ bool IsAnyNukeOrStunSpell(uint16 spell_id) {
 	) {
 		return true;
 	}
-	
+
 	return false;
 }
 
@@ -2693,7 +2693,7 @@ bool IsAegolismSpell(uint16 spell_id) {
 
 
 bool AegolismStackingIsSymbolSpell(uint16 spell_id) {
-	
+
 	/*
 		This is hardcoded to be specific to the type of HP buffs that are removed if a mob has an Aegolism buff.
 	*/
@@ -2793,7 +2793,7 @@ bool IsValidSpellAndLoS(uint32 spell_id, bool has_los) {
 	if (!IsValidSpell(spell_id)) {
 		return false;
 	}
-	
+
 	if (!has_los && IsTargetRequiredForSpell(spell_id)) {
 		return false;
 	}
@@ -2949,3 +2949,55 @@ bool IsHateSpell(uint16 spell_id) {
 		)
 	);
 }
+
+
+bool IsDisciplineTome(const EQ::ItemData* item)
+{
+	if (!item->IsClassCommon() || item->ItemType != EQ::item::ItemTypeSpell) {
+		return false;
+	}
+
+	//Need a way to determine the difference between a spell and a tome
+	//so they cant turn in a spell and get it as a discipline
+	//this is kinda a hack:
+
+	const std::string item_name = item->Name;
+
+	if (
+		!Strings::BeginsWith(item_name, "Tome of ") &&
+		!Strings::BeginsWith(item_name, "Skill: ")
+		) {
+		return false;
+	}
+
+	//we know for sure none of the int casters get disciplines
+	uint32 class_bit = 0;
+	class_bit |= 1 << (Class::Wizard - 1);
+	class_bit |= 1 << (Class::Enchanter - 1);
+	class_bit |= 1 << (Class::Magician - 1);
+	class_bit |= 1 << (Class::Necromancer - 1);
+	if (item->Classes & class_bit) {
+		return false;
+	}
+
+	const auto& spell_id = static_cast<uint32>(item->Scroll.Effect);
+	if (!IsValidSpell(spell_id)) {
+		return false;
+	}
+
+	if (!IsDiscipline(spell_id)) {
+		return false;
+	}
+
+	const auto &spell = spells[spell_id];
+	if (
+		spell.classes[Class::Wizard - 1] != 255 &&
+		spell.classes[Class::Enchanter - 1] != 255 &&
+		spell.classes[Class::Magician - 1] != 255 &&
+		spell.classes[Class::Necromancer - 1] != 255
+		) {
+		return false;
+	}
+
+	return true;
+}

common/spdat.h

@@ -20,6 +20,7 @@
 
 #include "classes.h"
 #include "skills.h"
+#include "item_data.h"
 
 #define SPELL_UNKNOWN 0xFFFF
 #define POISON_PROC 0xFFFE
@@ -651,8 +652,8 @@ enum SpellTypes : uint32
 	SpellType_PreCombatBuffSong      = (1 << 21)
 };
 
-namespace BotSpellTypes 
-{ 
+namespace BotSpellTypes
+{
 	constexpr uint16	Nuke                       = 0;
 	constexpr uint16	RegularHeal                = 1;
 	constexpr uint16	Root                       = 2;
@@ -1913,5 +1914,6 @@ bool IsResistanceOnlySpell(uint16 spell_id);
 bool IsDamageShieldOnlySpell(uint16 spell_id);
 bool IsDamageShieldAndResistSpell(uint16 spell_id);
 bool IsHateSpell(uint16 spell_id);
+bool IsDisciplineTome(const EQ::ItemData* item);
 
 #endif

common/version.h

@@ -42,7 +42,7 @@
  * Manifest: https://github.com/EQEmu/Server/blob/master/utils/sql/db_update_manifest.txt
  */
 
-#define CURRENT_BINARY_DATABASE_VERSION 9299
+#define CURRENT_BINARY_DATABASE_VERSION 9300
 #define CURRENT_BINARY_BOTS_DATABASE_VERSION 9054
 
 #endif