3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
15 #include "UserMessages.h"
17 UserMessages g_UserMsgs;
19 SH_DECL_HOOK2(IVEngineServer, UserMessageBegin, SH_NOATTRIB, 0, bf_write *, IRecipientFilter *, int);
20 SH_DECL_HOOK0_void(IVEngineServer, MessageEnd, SH_NOATTRIB, 0);
22 UserMessages::UserMessages() : m_InterceptBuffer(m_pBase, 2500)
24 m_Names = sm_trie_create();
29 m_CurId = INVALID_MESSAGE_ID;
32 UserMessages::~UserMessages()
34 sm_trie_destroy(m_Names);
36 CStack<ListenerInfo *>::iterator iter;
37 for (iter=m_FreeListeners.begin(); iter!=m_FreeListeners.end(); iter++)
41 m_FreeListeners.popall();
44 void UserMessages::OnSourceModAllInitialized()
46 g_ShareSys.AddInterface(NULL, this);
49 void UserMessages::OnSourceModAllShutdown()
53 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
54 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
55 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
56 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
61 int UserMessages::GetMessageIndex(const char *msg)
65 if (!sm_trie_retrieve(m_Names, msg, reinterpret_cast<void **>(&msgid)))
67 msgid = g_SMAPI->FindUserMessage(msg);
69 if (msgid != INVALID_MESSAGE_ID)
71 sm_trie_insert(m_Names, msg, reinterpret_cast<void *>(msgid));
78 bf_write *UserMessages::StartMessage(int msg_id, cell_t players[], unsigned int playersNum, int flags)
82 if (m_InExec || m_InHook)
86 if (msg_id < 0 || msg_id >= 255)
91 m_CellRecFilter.Initialize(players, playersNum);
94 if (m_CurFlags & USERMSG_INITMSG)
96 m_CellRecFilter.SetToInit(true);
98 if (m_CurFlags & USERMSG_RELIABLE)
100 m_CellRecFilter.SetToReliable(true);
105 if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
107 buffer = engine->UserMessageBegin(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
109 buffer = ENGINE_CALL(UserMessageBegin)(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
115 bool UserMessages::EndMessage()
122 if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
124 engine->MessageEnd();
126 ENGINE_CALL(MessageEnd)();
131 m_CellRecFilter.Reset();
136 bool UserMessages::HookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
138 if (msg_id < 0 || msg_id >= 255)
144 if (m_FreeListeners.empty())
146 pInfo = new ListenerInfo;
148 pInfo = m_FreeListeners.front();
149 m_FreeListeners.pop();
152 pInfo->Callback = pListener;
153 pInfo->IsHooked = false;
154 pInfo->KillMe = false;
158 SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
159 SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
160 SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
161 SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
166 m_msgIntercepts[msg_id].push_back(pInfo);
168 m_msgHooks[msg_id].push_back(pInfo);
174 bool UserMessages::UnhookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
179 bool deleted = false;
181 if (msg_id < 0 || msg_id >= 255)
186 pList = (intercept) ? &m_msgIntercepts[msg_id] : &m_msgHooks[msg_id];
187 for (iter=pList->begin(); iter!=pList->end(); iter++)
190 if (pInfo->Callback == pListener)
194 pInfo->KillMe = true;
211 void UserMessages::_DecRefCounter()
213 if (--m_HookCount == 0)
215 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
216 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
217 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
218 SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
222 bf_write *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type)
224 bool is_intercept_empty = m_msgIntercepts[msg_type].empty();
225 bool is_hook_empty = m_msgHooks[msg_type].empty();
227 if ((is_intercept_empty && is_hook_empty)
228 || (m_InExec && !(m_CurFlags & USERMSG_PASSTHRU_ALL)))
231 RETURN_META_VALUE(MRES_IGNORED, NULL);
235 m_CurRecFilter = filter;
237 m_BlockEndPost = false;
239 if (!is_intercept_empty)
241 m_InterceptBuffer.Reset();
242 RETURN_META_VALUE(MRES_SUPERCEDE, &m_InterceptBuffer);
245 RETURN_META_VALUE(MRES_IGNORED, NULL);
248 bf_write *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type)
252 RETURN_META_VALUE(MRES_IGNORED, NULL);
255 m_OrigBuffer = META_RESULT_ORIG_RET(bf_write *);
257 RETURN_META_VALUE(MRES_IGNORED, NULL);
260 void UserMessages::OnMessageEnd_Post()
262 if (!m_InHook || m_BlockEndPost)
264 RETURN_META(MRES_IGNORED);
271 pList = &m_msgIntercepts[m_CurId];
272 for (iter=pList->begin(); iter!=pList->end(); )
275 pInfo->IsHooked = true;
276 pInfo->Callback->OnUserMessageSent(m_CurId);
280 iter = pList->erase(iter);
281 m_FreeListeners.push(pInfo);
286 pInfo->IsHooked = false;
290 pList = &m_msgHooks[m_CurId];
291 for (iter=pList->begin(); iter!=pList->end(); )
294 pInfo->IsHooked = true;
295 pInfo->Callback->OnUserMessageSent(m_CurId);
299 iter = pList->erase(iter);
300 m_FreeListeners.push(pInfo);
305 pInfo->IsHooked = false;
312 void UserMessages::OnMessageEnd_Pre()
316 RETURN_META(MRES_IGNORED);
324 bool intercepted = false;
325 bool handled = false;
327 pList = &m_msgIntercepts[m_CurId];
328 for (iter=pList->begin(); iter!=pList->end(); )
331 pInfo->IsHooked = true;
332 res = pInfo->Callback->InterceptUserMessage(m_CurId, &m_InterceptBuffer, m_CurRecFilter);
343 m_FreeListeners.push(pInfo);
347 pInfo->IsHooked = false;
355 iter = pList->erase(iter);
356 m_FreeListeners.push(pInfo);
366 iter = pList->erase(iter);
367 m_FreeListeners.push(pInfo);
374 pInfo->IsHooked = false;
385 bf_write *engine_bfw;
387 engine_bfw = ENGINE_CALL(UserMessageBegin)(m_CurRecFilter, m_CurId);
388 m_ReadBuffer.StartReading(m_InterceptBuffer.GetBasePointer(), m_InterceptBuffer.GetNumBytesWritten());
389 engine_bfw->WriteBitsFromBuffer(&m_ReadBuffer, m_InterceptBuffer.GetNumBitsWritten());
390 ENGINE_CALL(MessageEnd)();
393 pList = &m_msgHooks[m_CurId];
394 for (iter=pList->begin(); iter!=pList->end(); )
397 pInfo->IsHooked = true;
398 pInfo->Callback->OnUserMessage(m_CurId, m_OrigBuffer, m_CurRecFilter);
402 iter = pList->erase(iter);
403 m_FreeListeners.push(pInfo);
408 pInfo->IsHooked = false;
412 RETURN_META((intercepted) ? MRES_SUPERCEDE : MRES_IGNORED);
415 m_BlockEndPost = true;
416 RETURN_META(MRES_SUPERCEDE);