[Quests] Cleanup Quest Parser Logic #4025

Kinglykrab · 2024-01-27T17:16:06Z

Notes

Consolidate duplicated code into loops to make it easier to read and easier to add on to.

Images

NPC `EVENT_SAY` Example

Global Player `EVENT_SAY` Example

Global Player `EVENT_TARGET_CHANGE` Example

Zone Player `EVENT_EXP_GAIN` Example

# Notes - Consolidate duplicated code into loops to make it easier to read and easier to add on to. # Images

Akkadius · 2024-02-01T10:35:56Z

This ones gonna require some extra care and more detailed review

zone/embparser.cpp

zone/quest_parser_collection.cpp

zone/embperl.cpp

If a mob has a target when a zone is shutdown it will crash while trying to dispatch EVENT_TARGET_CHANGE when the Mob destructor cleans up hatelists if a quest interface isn't loaded for the type (in this case no bot scripts): zone.exe!fmt::v10::format<std::string const &,char const *>(fmt::v10::basic_format_string<char,std::string const &,char const *> fmt={...}, const std::string & <args_0>={...}, const char * && <args_1>=0x0000000000000000) Line 2835 C++ > zone.exe!QuestParserCollection::GetQIByBotQuest(std::string & filename={...}) Line 1138 C++ zone.exe!QuestParserCollection::BotHasQuestSubLocal(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 353 C++ zone.exe!QuestParserCollection::BotHasQuestSub(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 389 C++ zone.exe!Mob::SetTarget(Mob * mob=0x0000000000000000) Line 5431 C++ zone.exe!NPC::SetTarget(Mob * mob=0x0000000000000000) Line 575 C++ zone.exe!Mob::RemoveFromHateList(Mob * mob=0x000001bfbdc66040) Line 4894 C++ zone.exe!EntityList::RemoveFromTargets(Mob * mob=0x000001bfbdc66040, bool RemoveFromXTargets=true) Line 1530 C++ zone.exe!Mob::~Mob() Line 547 C++ zone.exe!NPC::~NPC() Line 537 C++ zone.exe!NPC::`scalar deleting destructor'(unsigned int) C++ zone.exe!EntityList::RemoveAllMobs() Line 2678 C++ zone.exe!EntityList::Clear() Line 3090 C++ zone.exe!Zone::~Zone() Line 1103 C++ zone.exe!Zone::`scalar deleting destructor'(unsigned int) C++ zone.exe!Zone::Shutdown(bool quiet=false) Line 928 C++ This is caused by the Zone destructor deleting short_name before calling entity_list.Clear(). With an unloaded quest interface BotHasQuestSubLocal calls GetQIByBotQuest which gets a null zone->GetShortName() and crashes while formatting strings. The immediate regressing commit for this crash is because a check for zone->IsLoaded() was removed in 74f1eac with others that were removed to fix a regression by EQEmu#4025. GetQIByBotQuest and GetQIByPlayerQuest always had this check and should have remained for them. This restores the zone->IsLoaded() checks for GetQIByBotQuest/PlayerQuest. The other functions cannot have that check added until the other issues mentioned in EQEmu#4149 are addressed.

If a mob has a target when a zone is shutdown it will crash while trying to dispatch EVENT_TARGET_CHANGE when the Mob destructor cleans up hatelists if a quest interface isn't loaded for the type (in this case no bot scripts): zone.exe!fmt::v10::format<std::string const &,char const *>(fmt::v10::basic_format_string<char,std::string const &,char const *> fmt={...}, const std::string & <args_0>={...}, const char * && <args_1>=0x0000000000000000) Line 2835 C++ > zone.exe!QuestParserCollection::GetQIByBotQuest(std::string & filename={...}) Line 1138 C++ zone.exe!QuestParserCollection::BotHasQuestSubLocal(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 353 C++ zone.exe!QuestParserCollection::BotHasQuestSub(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 389 C++ zone.exe!Mob::SetTarget(Mob * mob=0x0000000000000000) Line 5431 C++ zone.exe!NPC::SetTarget(Mob * mob=0x0000000000000000) Line 575 C++ zone.exe!Mob::RemoveFromHateList(Mob * mob=0x000001bfbdc66040) Line 4894 C++ zone.exe!EntityList::RemoveFromTargets(Mob * mob=0x000001bfbdc66040, bool RemoveFromXTargets=true) Line 1530 C++ zone.exe!Mob::~Mob() Line 547 C++ zone.exe!NPC::~NPC() Line 537 C++ zone.exe!NPC::`scalar deleting destructor'(unsigned int) C++ zone.exe!EntityList::RemoveAllMobs() Line 2678 C++ zone.exe!EntityList::Clear() Line 3090 C++ zone.exe!Zone::~Zone() Line 1103 C++ zone.exe!Zone::`scalar deleting destructor'(unsigned int) C++ zone.exe!Zone::Shutdown(bool quiet=false) Line 928 C++ This is caused by the Zone destructor deleting short_name before calling entity_list.Clear(). With an unloaded quest interface BotHasQuestSubLocal calls GetQIByBotQuest which gets a null zone->GetShortName() and crashes while formatting strings. The immediate regressing commit for this crash is because a check for zone->IsLoaded() was removed in 74f1eac with others that were removed to fix a regression by #4025. GetQIByBotQuest and GetQIByPlayerQuest always had this check and should have remained for them. This restores the zone->IsLoaded() checks for GetQIByBotQuest/PlayerQuest. The other functions cannot have that check added until the other issues mentioned in #4149 are addressed.

If a mob has a target when a zone is shutdown it will crash while trying to dispatch EVENT_TARGET_CHANGE when the Mob destructor cleans up hatelists if a quest interface isn't loaded for the type (in this case no bot scripts): zone.exe!fmt::v10::format<std::string const &,char const *>(fmt::v10::basic_format_string<char,std::string const &,char const *> fmt={...}, const std::string & <args_0>={...}, const char * && <args_1>=0x0000000000000000) Line 2835 C++ > zone.exe!QuestParserCollection::GetQIByBotQuest(std::string & filename={...}) Line 1138 C++ zone.exe!QuestParserCollection::BotHasQuestSubLocal(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 353 C++ zone.exe!QuestParserCollection::BotHasQuestSub(QuestEventID event_id=EVENT_TARGET_CHANGE) Line 389 C++ zone.exe!Mob::SetTarget(Mob * mob=0x0000000000000000) Line 5431 C++ zone.exe!NPC::SetTarget(Mob * mob=0x0000000000000000) Line 575 C++ zone.exe!Mob::RemoveFromHateList(Mob * mob=0x000001bfbdc66040) Line 4894 C++ zone.exe!EntityList::RemoveFromTargets(Mob * mob=0x000001bfbdc66040, bool RemoveFromXTargets=true) Line 1530 C++ zone.exe!Mob::~Mob() Line 547 C++ zone.exe!NPC::~NPC() Line 537 C++ zone.exe!NPC::`scalar deleting destructor'(unsigned int) C++ zone.exe!EntityList::RemoveAllMobs() Line 2678 C++ zone.exe!EntityList::Clear() Line 3090 C++ zone.exe!Zone::~Zone() Line 1103 C++ zone.exe!Zone::`scalar deleting destructor'(unsigned int) C++ zone.exe!Zone::Shutdown(bool quiet=false) Line 928 C++ This is caused by the Zone destructor deleting short_name before calling entity_list.Clear(). With an unloaded quest interface BotHasQuestSubLocal calls GetQIByBotQuest which gets a null zone->GetShortName() and crashes while formatting strings. The immediate regressing commit for this crash is because a check for zone->IsLoaded() was removed in 74f1eac with others that were removed to fix a regression by EQEmu#4025. GetQIByBotQuest and GetQIByPlayerQuest always had this check and should have remained for them. This restores the zone->IsLoaded() checks for GetQIByBotQuest/PlayerQuest. The other functions cannot have that check added until the other issues mentioned in EQEmu#4149 are addressed.

[Quests] Cleanup Quest Parser Logic

4add82d

# Notes - Consolidate duplicated code into loops to make it easier to read and easier to add on to. # Images

Kinglykrab requested review from Akkadius and hgtw and removed request for Akkadius January 27, 2024 17:16

Kinglykrab added 5 commits January 27, 2024 12:19

Update quest_parser_collection.cpp

ab3d2ae

Push

4d29cf4

Push

3637d8b

Update embperl.cpp

6445614

Push

fc8e3a9

Additional cleanup, use File::Exists utility

844923e