feat(Core/Scripting): Add new hooks for Ticket (#21238)

src/server/game/Handlers/TicketHandler.cpp

@@ -116,7 +116,7 @@ void WorldSession::HandleGMTicketCreateOpcode(WorldPacket& recvData)
             ticket->SetChatLog(times, chatLog);
 
         sTicketMgr->AddTicket(ticket);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         ChatHandler(nullptr).SendGMText(LANG_COMMAND_TICKETNEW, GetPlayer()->GetName(), ticket->GetId());
 

src/server/game/Scripting/ScriptDefines/AllScriptsObjects.h

@@ -58,6 +58,7 @@
 #include "PlayerScript.h"
 #include "ServerScript.h"
 #include "SpellScriptLoader.h"
+#include "TicketScript.h"
 #include "TransportScript.h"
 #include "UnitScript.h"
 #include "VehicleScript.h"

src/server/game/Scripting/ScriptDefines/TicketScript.cpp

@@ -0,0 +1,58 @@
+/*
+ * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information
+ *
+ * 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 General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "TicketScript.h"
+#include "ScriptMgr.h"
+#include "ScriptMgrMacros.h"
+
+void ScriptMgr::OnTicketCreate(GmTicket* ticket)
+{
+    CALL_ENABLED_HOOKS(TicketScript, TICKETHOOK_ON_TICKET_CREATE, script->OnTicketCreate(ticket));
+}
+
+void ScriptMgr::OnTicketUpdateLastChange(GmTicket* ticket)
+{
+    CALL_ENABLED_HOOKS(TicketScript, TICKETHOOK_ON_TICKET_UPDATE_LAST_CHANGE, script->OnTicketUpdateLastChange(ticket));
+}
+
+void ScriptMgr::OnTicketClose(GmTicket* ticket)
+{
+    CALL_ENABLED_HOOKS(TicketScript, TICKETHOOK_ON_TICKET_CLOSE, script->OnTicketClose(ticket));
+}
+
+void ScriptMgr::OnTicketStatusUpdate(GmTicket* ticket)
+{
+    CALL_ENABLED_HOOKS(TicketScript, TICKETHOOK_ON_TICKET_STATUS_UPDATE, script->OnTicketStatusUpdate(ticket));
+}
+
+void ScriptMgr::OnTicketResolve(GmTicket* ticket)
+{
+    CALL_ENABLED_HOOKS(TicketScript, TICKETHOOK_ON_TICKET_RESOLVE, script->OnTicketResolve(ticket));
+}
+
+TicketScript::TicketScript(char const* name, std::vector<uint16> enabledHooks)
+: ScriptObject(name, TICKETHOOK_END)
+{
+    // If empty - enable all available hooks.
+    if (enabledHooks.empty())
+        for (uint16 i = 0; i < TICKETHOOK_END; ++i)
+            enabledHooks.emplace_back(i);
+
+    ScriptRegistry<TicketScript>::AddScript(this, std::move(enabledHooks));
+}
+
+template class AC_GAME_API ScriptRegistry<TicketScript>;

src/server/game/Scripting/ScriptDefines/TicketScript.h

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the AzerothCore Project. See AUTHORS file for Copyright information
+ *
+ * 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 General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef SCRIPT_OBJECT_TICKET_SCRIPT_H_
+#define SCRIPT_OBJECT_TICKET_SCRIPT_H_
+
+#include "ScriptObject.h"
+#include "TicketMgr.h"
+#include <vector>
+
+enum TicketHook
+{
+    TICKETHOOK_ON_TICKET_CREATE,
+    TICKETHOOK_ON_TICKET_UPDATE_LAST_CHANGE,
+    TICKETHOOK_ON_TICKET_CLOSE,
+    TICKETHOOK_ON_TICKET_STATUS_UPDATE,
+    TICKETHOOK_ON_TICKET_RESOLVE,
+    TICKETHOOK_END
+};
+
+class TicketScript : public ScriptObject
+{
+protected:
+    TicketScript(char const* name, std::vector<uint16> enabledHooks = std::vector<uint16>());
+
+public:
+    [[nodiscard]] bool IsDatabaseBound() const override { return false; }
+
+    virtual void OnTicketCreate(GmTicket* /*ticket*/) { }
+    virtual void OnTicketUpdateLastChange(GmTicket* /*ticket*/) { }
+    virtual void OnTicketClose(GmTicket* /*ticket*/) { }
+    virtual void OnTicketStatusUpdate(GmTicket* /*ticket*/) { }
+    virtual void OnTicketResolve(GmTicket* /*ticket*/) { }
+};
+
+#endif

src/server/game/Scripting/ScriptMgr.cpp

@@ -98,6 +98,7 @@ void ScriptMgr::Initialize()
     ScriptRegistry<PlayerScript>::InitEnabledHooksIfNeeded(PLAYERHOOK_END);
     ScriptRegistry<ServerScript>::InitEnabledHooksIfNeeded(SERVERHOOK_END);
     ScriptRegistry<SpellSC>::InitEnabledHooksIfNeeded(ALLSPELLHOOK_END);
+    ScriptRegistry<TicketScript>::InitEnabledHooksIfNeeded(TICKETHOOK_END);
     ScriptRegistry<UnitScript>::InitEnabledHooksIfNeeded(UNITHOOK_END);
     ScriptRegistry<WorldObjectScript>::InitEnabledHooksIfNeeded(WORLDOBJECTHOOK_END);
     ScriptRegistry<WorldScript>::InitEnabledHooksIfNeeded(WORLDHOOK_END);
@@ -145,6 +146,7 @@ void ScriptMgr::Unload()
     SCR_CLEAR<ServerScript>();
     SCR_CLEAR<SpellSC>();
     SCR_CLEAR<SpellScriptLoader>();
+    SCR_CLEAR<TicketScript>();
     SCR_CLEAR<TransportScript>();
     SCR_CLEAR<UnitScript>();
     SCR_CLEAR<VehicleScript>();
@@ -224,7 +226,8 @@ void ScriptMgr::CheckIfScriptsInDatabaseExist()
                 !ScriptRegistry<CommandSC>::GetScriptById(sid) &&
                 !ScriptRegistry<ArenaScript>::GetScriptById(sid) &&
                 !ScriptRegistry<GroupScript>::GetScriptById(sid) &&
-                !ScriptRegistry<DatabaseScript>::GetScriptById(sid))
+                !ScriptRegistry<DatabaseScript>::GetScriptById(sid) &&
+                !ScriptRegistry<TicketScript>::GetScriptById(sid))
                 {
                     LOG_ERROR("sql.sql", "Script named '{}' is assigned in the database, but has no code!", scriptName);
                 }

src/server/game/Scripting/ScriptMgr.h

@@ -704,6 +704,14 @@ class ScriptMgr
 
     void OnLootMoney(Player* player, uint32 gold);
 
+public: /* TicketScript */
+
+    void OnTicketCreate(GmTicket* ticket);
+    void OnTicketUpdateLastChange(GmTicket* ticket);
+    void OnTicketClose(GmTicket* ticket);
+    void OnTicketStatusUpdate(GmTicket* ticket);
+    void OnTicketResolve(GmTicket* ticket);
+
 private:
     uint32 _scriptCount;
 

src/server/game/Scripting/ScriptObjectFwd.h

@@ -67,6 +67,7 @@ class SpellCastTargets;
 class SpellInfo;
 class SpellScript;
 class TempSummon;
+class TicketMgr;
 class Transport;
 class Unit;
 class Vehicle;

src/server/game/Tickets/TicketMgr.cpp

@@ -25,6 +25,7 @@
 #include "Log.h"
 #include "Opcodes.h"
 #include "Player.h"
+#include "ScriptMgr.h"
 #include "World.h"
 #include "WorldPacket.h"
 #include "WorldSession.h"
@@ -364,6 +365,8 @@ void TicketMgr::AddTicket(GmTicket* ticket)
         ++_openTicketCount;
     CharacterDatabaseTransaction trans = CharacterDatabaseTransaction(nullptr);
     ticket->SaveToDB(trans);
+
+    sScriptMgr->OnTicketCreate(ticket);
 }
 
 void TicketMgr::CloseTicket(uint32 ticketId, ObjectGuid source)
@@ -375,6 +378,8 @@ void TicketMgr::CloseTicket(uint32 ticketId, ObjectGuid source)
         if (source)
             --_openTicketCount;
         ticket->SaveToDB(trans);
+
+        sScriptMgr->OnTicketClose(ticket);
     }
 }
 
@@ -398,6 +403,8 @@ void TicketMgr::ResolveAndCloseTicket(uint32 ticketId, ObjectGuid source)
         if (source)
             --_openTicketCount;
         ticket->SaveToDB(trans);
+
+        sScriptMgr->OnTicketResolve(ticket);
     }
 }
 
@@ -438,7 +445,9 @@ void TicketMgr::SendTicket(WorldSession* session, GmTicket* ticket) const
     session->SendPacket(&data);
 }
 
-void TicketMgr::UpdateLastChange()
+void TicketMgr::UpdateLastChange(GmTicket* ticket)
 {
     _lastChange = GameTime::GetGameTime().count();
+
+    sScriptMgr->OnTicketUpdateLastChange(ticket);
 }

src/server/game/Tickets/TicketMgr.h

@@ -230,7 +230,7 @@ class TicketMgr
     void SetStatus(bool status) { _status = status; }
 
     uint64 GetLastChange() const { return _lastChange; }
-    void UpdateLastChange();
+    void UpdateLastChange(GmTicket* ticket);
 
     uint32 GenerateTicketId() { return ++_lastTicketId; }
     uint32 GetOpenTicketCount() const { return _openTicketCount; }

src/server/scripts/Commands/cs_ticket.cpp

@@ -117,7 +117,7 @@ class ticket_commandscript : public CommandScript
         CharacterDatabaseTransaction trans = CharacterDatabaseTransaction(nullptr);
         ticket->SetAssignedTo(targetGuid, AccountMgr::IsAdminAccount(targetGmLevel));
         ticket->SaveToDB(trans);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string msg = ticket->FormatMessageString(*handler, nullptr, target.c_str(), nullptr, nullptr);
         handler->SendGlobalGMSysMessage(msg.c_str());
@@ -143,7 +143,7 @@ class ticket_commandscript : public CommandScript
         }
 
         sTicketMgr->ResolveAndCloseTicket(ticket->GetId(), player ? player->GetGUID() : ObjectGuid::Empty);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string msg = ticket->FormatMessageString(*handler, player ? player->GetName().c_str() : "Console", nullptr, nullptr, nullptr);
         handler->SendGlobalGMSysMessage(msg.c_str());
@@ -182,7 +182,7 @@ class ticket_commandscript : public CommandScript
         CharacterDatabaseTransaction trans = CharacterDatabaseTransaction(nullptr);
         ticket->SetComment(comment.data());
         ticket->SaveToDB(trans);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string const assignedName = ticket->GetAssignedToName();
         std::string msg = ticket->FormatMessageString(*handler, assignedName.empty() ? nullptr : assignedName.c_str(), nullptr, nullptr, nullptr);
@@ -237,7 +237,7 @@ class ticket_commandscript : public CommandScript
         std::string msg = ticket->FormatMessageString(*handler, nullptr, nullptr, nullptr, nullptr);
         msg += handler->PGetParseString(LANG_COMMAND_TICKETCOMPLETED, gm ? gm->GetName().c_str() : "Console");
         handler->SendGlobalGMSysMessage(msg.c_str());
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
         return true;
     }
 
@@ -260,7 +260,7 @@ class ticket_commandscript : public CommandScript
         handler->SendGlobalGMSysMessage(msg.c_str());
 
         sTicketMgr->RemoveTicket(ticket->GetId());
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         if (Player* player = ticket->GetPlayer())
         {
@@ -287,7 +287,7 @@ class ticket_commandscript : public CommandScript
         if (Player* player = ticket->GetPlayer())
             sTicketMgr->SendTicket(player->GetSession(), ticket);
 
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
         return true;
     }
 
@@ -373,7 +373,7 @@ class ticket_commandscript : public CommandScript
         CharacterDatabaseTransaction trans = CharacterDatabaseTransaction(nullptr);
         ticket->SetUnassigned();
         ticket->SaveToDB(trans);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string msg = ticket->FormatMessageString(*handler, nullptr, assignedTo.c_str(),
                           handler->GetSession() ? handler->GetSession()->GetPlayer()->GetName().c_str() : "Console", nullptr);
@@ -464,7 +464,7 @@ class ticket_commandscript : public CommandScript
             ticket->AppendResponse("\n");
         ticket->AppendResponse(response);
         ticket->SaveToDB(trans);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string msg = ticket->FormatMessageString(*handler, nullptr, nullptr, nullptr, nullptr);
         msg += handler->PGetParseString(LANG_COMMAND_TICKETRESPONSEAPPENDED, response);
@@ -505,7 +505,7 @@ class ticket_commandscript : public CommandScript
         CharacterDatabaseTransaction trans = CharacterDatabaseTransaction(nullptr);
         ticket->DeleteResponse();
         ticket->SaveToDB(trans);
-        sTicketMgr->UpdateLastChange();
+        sTicketMgr->UpdateLastChange(ticket);
 
         std::string msg = ticket->FormatMessageString(*handler, nullptr, nullptr, nullptr, nullptr);
         msg += handler->PGetParseString(LANG_COMMAND_TICKETRESPONSEDELETED, player ? player->GetName() : "Console");