3 * =============================================================================
5 * Copyright (C) 2004-2010 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
32 #include "UserMessages.h"
33 #include "sm_stringutil.h"
35 #if SOURCE_ENGINE == SE_CSGO
36 #include <cstrike15_usermessage_helpers.h>
39 UserMessages g_UserMsgs;
41 #if SOURCE_ENGINE == SE_CSGO
42 SH_DECL_HOOK3_void(IVEngineServer, SendUserMessage, SH_NOATTRIB, 0, IRecipientFilter &, int, const protobuf::Message &);
44 #if SOURCE_ENGINE >= SE_LEFT4DEAD
45 SH_DECL_HOOK3(IVEngineServer, UserMessageBegin, SH_NOATTRIB, 0, bf_write *, IRecipientFilter *, int, const char *);
47 SH_DECL_HOOK2(IVEngineServer, UserMessageBegin, SH_NOATTRIB, 0, bf_write *, IRecipientFilter *, int);
49 SH_DECL_HOOK0_void(IVEngineServer, MessageEnd, SH_NOATTRIB, 0);
52 UserMessages::UserMessages()
53 #ifndef USE_PROTOBUF_USERMESSAGES
54 : m_InterceptBuffer(m_pBase, 2500)
56 m_Names = sm_trie_create();
58 : m_InterceptBuffer(NULL)
65 m_CurId = INVALID_MESSAGE_ID;
68 UserMessages::~UserMessages()
70 #ifndef USE_PROTOBUF_USERMESSAGES
71 sm_trie_destroy(m_Names);
74 CStack<ListenerInfo *>::iterator iter;
75 for (iter=m_FreeListeners.begin(); iter!=m_FreeListeners.end(); iter++)
79 m_FreeListeners.popall();
82 void UserMessages::OnSourceModStartup(bool late)
84 #ifndef USE_PROTOBUF_USERMESSAGES
85 /* -1 means SourceMM was unable to get the user message list */
86 m_FallbackSearch = (g_SMAPI->GetUserMessageCount() == -1);
90 void UserMessages::OnSourceModAllInitialized()
92 g_ShareSys.AddInterface(NULL, this);
95 void UserMessages::OnSourceModAllShutdown()
99 #if SOURCE_ENGINE == SE_CSGO
100 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Pre, false);
101 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Post, true);
103 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
104 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
105 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
106 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
112 int UserMessages::GetMessageIndex(const char *msg)
114 #if SOURCE_ENGINE == SE_CSGO
115 // Can split this per engine and/or game later
116 return g_Cstrike15UsermessageHelpers.GetIndex(msg);
120 if (!sm_trie_retrieve(m_Names, msg, reinterpret_cast<void **>(&msgid)))
122 if (m_FallbackSearch)
128 while (gamedll->GetUserMessageInfo(msgid, msgbuf, sizeof(msgbuf), size))
130 if (strcmp(msgbuf, msg) == 0)
132 sm_trie_insert(m_Names, msg, reinterpret_cast<void *>(msgid));
139 msgid = g_SMAPI->FindUserMessage(msg);
141 if (msgid != INVALID_MESSAGE_ID)
143 sm_trie_insert(m_Names, msg, reinterpret_cast<void *>(msgid));
151 bool UserMessages::GetMessageName(int msgid, char *buffer, size_t maxlength) const
153 #if SOURCE_ENGINE == SE_CSGO
154 const char *pszName = g_Cstrike15UsermessageHelpers.GetName(msgid);
158 strncopy(buffer, pszName, maxlength);
161 if (m_FallbackSearch)
164 return gamedll->GetUserMessageInfo(msgid, buffer, maxlength, size);
167 const char *msg = g_SMAPI->GetUserMessage(msgid);
171 strncopy(buffer, msg, maxlength);
179 bf_write *UserMessages::StartBitBufMessage(int msg_id, const cell_t players[], unsigned int playersNum, int flags)
181 #ifdef USE_PROTOBUF_USERMESSAGES
186 if (m_InExec || m_InHook)
190 if (msg_id < 0 || msg_id >= 255)
195 m_CellRecFilter.Initialize(players, playersNum);
198 if (m_CurFlags & USERMSG_INITMSG)
200 m_CellRecFilter.SetToInit(true);
202 if (m_CurFlags & USERMSG_RELIABLE)
204 m_CellRecFilter.SetToReliable(true);
209 if (m_CurFlags & USERMSG_BLOCKHOOKS)
211 #if SOURCE_ENGINE >= SE_LEFT4DEAD
212 buffer = ENGINE_CALL(UserMessageBegin)(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id, g_SMAPI->GetUserMessage(msg_id));
214 buffer = ENGINE_CALL(UserMessageBegin)(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
217 #if SOURCE_ENGINE >= SE_LEFT4DEAD
218 buffer = engine->UserMessageBegin(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id, g_SMAPI->GetUserMessage(msg_id));
220 buffer = engine->UserMessageBegin(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
225 #endif // USE_PROTOBUF_USERMESSAGES
228 google::protobuf::Message *UserMessages::StartProtobufMessage(int msg_id, const cell_t players[], unsigned int playersNum, int flags)
230 #ifndef USE_PROTOBUF_USERMESSAGES
233 protobuf::Message *buffer;
235 if (m_InExec || m_InHook)
239 if (msg_id < 0 || msg_id >= 255)
245 m_CellRecFilter.Initialize(players, playersNum);
248 if (m_CurFlags & USERMSG_INITMSG)
250 m_CellRecFilter.SetToInit(true);
252 if (m_CurFlags & USERMSG_RELIABLE)
254 m_CellRecFilter.SetToReliable(true);
259 if (m_CurFlags & USERMSG_BLOCKHOOKS)
261 // direct message creation, return buffer "from engine". keep track
262 m_FakeEngineBuffer = g_Cstrike15UsermessageHelpers.GetPrototype(msg_id)->New();
263 buffer = m_FakeEngineBuffer;
265 char messageName[32];
266 if (!GetMessageName(msg_id, messageName, sizeof(messageName)))
272 protobuf::Message *msg = OnStartMessage_Pre(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id, messageName);
273 switch (m_FakeMetaRes)
277 m_FakeEngineBuffer = g_Cstrike15UsermessageHelpers.GetPrototype(msg_id)->New();
278 buffer = m_FakeEngineBuffer;
282 m_FakeEngineBuffer = g_Cstrike15UsermessageHelpers.GetPrototype(msg_id)->New();
289 OnStartMessage_Post(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id, messageName);
293 #endif // USE_PROTOBUF_USERMESSAGES
296 bool UserMessages::EndMessage()
303 #if SOURCE_ENGINE == SE_CSGO
304 if (m_CurFlags & USERMSG_BLOCKHOOKS)
306 ENGINE_CALL(SendUserMessage)(static_cast<IRecipientFilter &>(m_CellRecFilter), m_CurId, *m_FakeEngineBuffer);
307 delete m_FakeEngineBuffer;
308 m_FakeEngineBuffer = NULL;
312 switch (m_FakeMetaRes)
317 engine->SendUserMessage(static_cast<IRecipientFilter &>(m_CellRecFilter), m_CurId, *m_FakeEngineBuffer);
318 delete m_FakeEngineBuffer;
319 m_FakeEngineBuffer = NULL;
321 //case MRES_SUPERCEDE:
327 if (m_CurFlags & USERMSG_BLOCKHOOKS)
329 ENGINE_CALL(MessageEnd)();
331 engine->MessageEnd();
337 m_CellRecFilter.Reset();
342 UserMessageType UserMessages::GetUserMessageType() const
344 #ifdef USE_PROTOBUF_USERMESSAGES
351 bool UserMessages::HookUserMessage2(int msg_id,
352 IUserMessageListener *pListener,
355 #ifdef USE_PROTOBUF_USERMESSAGES
356 return InternalHook(msg_id, (IProtobufUserMessageListener *)pListener, intercept, true);
358 return InternalHook(msg_id, (IBitBufUserMessageListener *)pListener, intercept, true);
362 bool UserMessages::UnhookUserMessage2(int msg_id,
363 IUserMessageListener *pListener,
366 #ifdef USE_PROTOBUF_USERMESSAGES
367 return InternalUnhook(msg_id, (IProtobufUserMessageListener *)pListener, intercept, true);
369 return InternalUnhook(msg_id, (IBitBufUserMessageListener *)pListener, intercept, true);
373 bool UserMessages::HookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
375 #ifdef USE_PROTOBUF_USERMESSAGES
376 return InternalHook(msg_id, (IProtobufUserMessageListener *)pListener, intercept, false);
378 return InternalHook(msg_id, (IBitBufUserMessageListener *)pListener, intercept, false);
382 bool UserMessages::UnhookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
384 #ifdef USE_PROTOBUF_USERMESSAGES
385 return InternalUnhook(msg_id, (IProtobufUserMessageListener *)pListener, intercept, false);
387 return InternalUnhook(msg_id, (IBitBufUserMessageListener *)pListener, intercept, false);
391 #ifdef USE_PROTOBUF_USERMESSAGES
392 bool UserMessages::InternalHook(int msg_id, IProtobufUserMessageListener *pListener, bool intercept, bool isNew)
394 bool UserMessages::InternalHook(int msg_id, IBitBufUserMessageListener *pListener, bool intercept, bool isNew)
397 if (msg_id < 0 || msg_id >= 255)
403 if (m_FreeListeners.empty())
405 pInfo = new ListenerInfo;
407 pInfo = m_FreeListeners.front();
408 m_FreeListeners.pop();
411 pInfo->Callback = pListener;
412 pInfo->IsHooked = false;
413 pInfo->KillMe = false;
414 pInfo->IsNew = isNew;
418 #if SOURCE_ENGINE == SE_CSGO
419 SH_ADD_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Pre, false);
420 SH_ADD_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Post, true);
422 SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
423 SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
424 SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
425 SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
431 m_msgIntercepts[msg_id].push_back(pInfo);
433 m_msgHooks[msg_id].push_back(pInfo);
439 #ifdef USE_PROTOBUF_USERMESSAGES
440 bool UserMessages::InternalUnhook(int msg_id, IProtobufUserMessageListener *pListener, bool intercept, bool isNew)
442 bool UserMessages::InternalUnhook(int msg_id, IBitBufUserMessageListener *pListener, bool intercept, bool isNew)
448 bool deleted = false;
450 if (msg_id < 0 || msg_id >= 255)
455 pList = (intercept) ? &m_msgIntercepts[msg_id] : &m_msgHooks[msg_id];
456 for (iter=pList->begin(); iter!=pList->end(); iter++)
459 if (pInfo->Callback == pListener && pInfo->IsNew == isNew)
463 pInfo->KillMe = true;
480 void UserMessages::_DecRefCounter()
482 if (--m_HookCount == 0)
484 #if SOURCE_ENGINE == SE_CSGO
485 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Pre, false);
486 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, SendUserMessage, engine, this, &UserMessages::OnSendUserMessage_Post, true);
488 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
489 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
490 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
491 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
496 #if SOURCE_ENGINE == SE_CSGO
497 void UserMessages::OnSendUserMessage_Pre(IRecipientFilter &filter, int msg_type, const protobuf::Message &msg)
499 OnStartMessage_Pre(&filter, msg_type, g_Cstrike15UsermessageHelpers.GetName(msg_type));
500 if (m_FakeMetaRes == MRES_SUPERCEDE)
502 int size = msg.ByteSize();
503 uint8 *data = (uint8 *)stackalloc(size);
504 msg.SerializePartialToArray(data, size);
505 m_InterceptBuffer->ParsePartialFromArray(data, size);
509 m_FakeEngineBuffer = &const_cast<protobuf::Message &>(msg);
512 OnStartMessage_Post(&filter, msg_type, g_Cstrike15UsermessageHelpers.GetName(msg_type));
515 if (m_FakeMetaRes == MRES_SUPERCEDE)
516 RETURN_META(MRES_SUPERCEDE);
518 RETURN_META(MRES_IGNORED);
521 void UserMessages::OnSendUserMessage_Post(IRecipientFilter &filter, int msg_type, const protobuf::Message &msg)
524 RETURN_META(MRES_IGNORED);
528 #ifdef USE_PROTOBUF_USERMESSAGES
529 #define UM_RETURN_META_VALUE(res, val) \
530 m_FakeMetaRes = res; \
533 #define UM_RETURN_META(res) \
534 m_FakeMetaRes = res; \
537 #define UM_RETURN_META_VALUE(res, val) \
538 RETURN_META_VALUE(res, val)
540 #define UM_RETURN_META(res) \
544 #if SOURCE_ENGINE == SE_CSGO
545 protobuf::Message *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type, const char *msg_name)
546 #elif SOURCE_ENGINE >= SE_LEFT4DEAD
547 bf_write *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type, const char *msg_name)
549 bf_write *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type)
552 bool is_intercept_empty = m_msgIntercepts[msg_type].empty();
553 bool is_hook_empty = m_msgHooks[msg_type].empty();
555 if ((is_intercept_empty && is_hook_empty)
556 || (m_InExec && (m_CurFlags & USERMSG_BLOCKHOOKS)))
559 UM_RETURN_META_VALUE(MRES_IGNORED, NULL);
563 m_CurRecFilter = filter;
565 m_BlockEndPost = false;
567 if (!is_intercept_empty)
569 #ifdef USE_PROTOBUF_USERMESSAGES
570 if (m_InterceptBuffer)
571 delete m_InterceptBuffer;
572 m_InterceptBuffer = g_Cstrike15UsermessageHelpers.GetPrototype(msg_type)->New();
573 UM_RETURN_META_VALUE(MRES_SUPERCEDE, m_InterceptBuffer);
575 m_InterceptBuffer.Reset();
576 UM_RETURN_META_VALUE(MRES_SUPERCEDE, &m_InterceptBuffer);
580 UM_RETURN_META_VALUE(MRES_IGNORED, NULL);
583 #if SOURCE_ENGINE == SE_CSGO
584 protobuf::Message *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type, const char *msg_name)
585 #elif SOURCE_ENGINE >= SE_LEFT4DEAD
586 bf_write *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type, const char *msg_name)
588 bf_write *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type)
593 UM_RETURN_META_VALUE(MRES_IGNORED, NULL);
596 #ifdef USE_PROTOBUF_USERMESSAGES
597 if (m_FakeMetaRes == MRES_SUPERCEDE)
598 m_OrigBuffer = m_InterceptBuffer;
600 m_OrigBuffer = m_FakeEngineBuffer;
602 m_OrigBuffer = META_RESULT_ORIG_RET(bf_write *);
605 UM_RETURN_META_VALUE(MRES_IGNORED, NULL);
608 void UserMessages::OnMessageEnd_Post()
612 UM_RETURN_META(MRES_IGNORED);
621 pList = &m_msgIntercepts[m_CurId];
622 for (iter=pList->begin(); iter!=pList->end(); )
625 if (m_BlockEndPost && !pInfo->IsNew)
629 pInfo->IsHooked = true;
630 pInfo->Callback->OnUserMessageSent(m_CurId);
633 pInfo->Callback->OnPostUserMessage(m_CurId, !m_BlockEndPost);
638 iter = pList->erase(iter);
639 m_FreeListeners.push(pInfo);
644 pInfo->IsHooked = false;
648 pList = &m_msgHooks[m_CurId];
649 for (iter=pList->begin(); iter!=pList->end(); )
652 if (m_BlockEndPost && !pInfo->IsNew)
656 pInfo->IsHooked = true;
657 pInfo->Callback->OnUserMessageSent(m_CurId);
660 pInfo->Callback->OnPostUserMessage(m_CurId, !m_BlockEndPost);
665 iter = pList->erase(iter);
666 m_FreeListeners.push(pInfo);
671 pInfo->IsHooked = false;
676 void UserMessages::OnMessageEnd_Pre()
680 UM_RETURN_META(MRES_IGNORED);
688 bool intercepted = false;
689 bool handled = false;
691 pList = &m_msgIntercepts[m_CurId];
692 for (iter=pList->begin(); iter!=pList->end(); )
695 pInfo->IsHooked = true;
696 #ifdef USE_PROTOBUF_USERMESSAGES
697 res = pInfo->Callback->InterceptUserMessage(m_CurId, m_InterceptBuffer, m_CurRecFilter);
699 res = pInfo->Callback->InterceptUserMessage(m_CurId, &m_InterceptBuffer, m_CurRecFilter);
711 m_FreeListeners.push(pInfo);
715 pInfo->IsHooked = false;
723 iter = pList->erase(iter);
724 m_FreeListeners.push(pInfo);
734 iter = pList->erase(iter);
735 m_FreeListeners.push(pInfo);
742 pInfo->IsHooked = false;
746 if (!handled && intercepted)
748 #if SOURCE_ENGINE == SE_CSGO
749 ENGINE_CALL(SendUserMessage)(static_cast<IRecipientFilter &>(*m_CurRecFilter), m_CurId, *m_InterceptBuffer);
751 bf_write *engine_bfw;
752 #if SOURCE_ENGINE >= SE_LEFT4DEAD
753 engine_bfw = ENGINE_CALL(UserMessageBegin)(m_CurRecFilter, m_CurId, g_SMAPI->GetUserMessage(m_CurId));
755 engine_bfw = ENGINE_CALL(UserMessageBegin)(m_CurRecFilter, m_CurId);
757 m_ReadBuffer.StartReading(m_InterceptBuffer.GetBasePointer(), m_InterceptBuffer.GetNumBytesWritten());
758 engine_bfw->WriteBitsFromBuffer(&m_ReadBuffer, m_InterceptBuffer.GetNumBitsWritten());
759 ENGINE_CALL(MessageEnd)();
764 #if SOURCE_ENGINE == SE_CSGO
765 int size = m_OrigBuffer->ByteSize();
766 uint8 *data = (uint8 *)stackalloc(size);
767 m_OrigBuffer->SerializePartialToArray(data, size);
768 protobuf::Message *pTempMsg = g_Cstrike15UsermessageHelpers.GetPrototype(m_CurId)->New();
769 pTempMsg->ParsePartialFromArray(data, size);
771 bf_write *pTempMsg = m_OrigBuffer;
774 pList = &m_msgHooks[m_CurId];
775 for (iter=pList->begin(); iter!=pList->end(); )
778 pInfo->IsHooked = true;
779 pInfo->Callback->OnUserMessage(m_CurId, pTempMsg, m_CurRecFilter);
783 iter = pList->erase(iter);
784 m_FreeListeners.push(pInfo);
789 pInfo->IsHooked = false;
793 #if SOURCE_ENGINE == SE_CSGO
798 UM_RETURN_META((intercepted) ? MRES_SUPERCEDE : MRES_IGNORED);
800 m_BlockEndPost = true;
801 UM_RETURN_META(MRES_SUPERCEDE);