core/UserMessages.cpp
author David Anderson <dvander@alliedmods.net>
Sun May 06 06:15:48 2007 +0000 (2007-05-06)
changeset 743 a2804c2faba2
parent 698 8c68fc683dba
child 765 d78dd115f23a
permissions -rw-r--r--
added request amb251
     1 /**
     2  * vim: set ts=4 :
     3  * ===============================================================
     4  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     5  * ===============================================================
     6  *
     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
    11  *
    12  * Version: $Id$
    13  */
    14 
    15 #include "UserMessages.h"
    16 
    17 UserMessages g_UserMsgs;
    18 
    19 SH_DECL_HOOK2(IVEngineServer, UserMessageBegin, SH_NOATTRIB, 0, bf_write *, IRecipientFilter *, int);
    20 SH_DECL_HOOK0_void(IVEngineServer, MessageEnd, SH_NOATTRIB, 0);
    21 
    22 UserMessages::UserMessages() : m_InterceptBuffer(m_pBase, 2500)
    23 {
    24 	m_Names = sm_trie_create();
    25 	m_HookCount = 0;
    26 	m_InExec = false;
    27 	m_InHook = false;
    28 	m_CurFlags = 0;
    29 	m_CurId = INVALID_MESSAGE_ID;
    30 }
    31 
    32 UserMessages::~UserMessages()
    33 {
    34 	sm_trie_destroy(m_Names);
    35 
    36 	CStack<ListenerInfo *>::iterator iter;
    37 	for (iter=m_FreeListeners.begin(); iter!=m_FreeListeners.end(); iter++)
    38 	{
    39 		delete (*iter);
    40 	}
    41 	m_FreeListeners.popall();
    42 }
    43 
    44 void UserMessages::OnSourceModAllInitialized()
    45 {
    46 	g_ShareSys.AddInterface(NULL, this);
    47 }
    48 
    49 void UserMessages::OnSourceModAllShutdown()
    50 {
    51 	if (m_HookCount)
    52 	{
    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);
    57 	}
    58 	m_HookCount = 0;
    59 }
    60 
    61 int UserMessages::GetMessageIndex(const char *msg)
    62 {
    63 	int msgid;
    64 
    65 	if (!sm_trie_retrieve(m_Names, msg, reinterpret_cast<void **>(&msgid)))
    66 	{
    67 		msgid = g_SMAPI->FindUserMessage(msg);
    68 
    69 		if (msgid != INVALID_MESSAGE_ID)
    70 		{
    71 			sm_trie_insert(m_Names, msg, reinterpret_cast<void *>(msgid));
    72 		}
    73 	}
    74 
    75 	return msgid;
    76 }
    77 
    78 bf_write *UserMessages::StartMessage(int msg_id, cell_t players[], unsigned int playersNum, int flags)
    79 {
    80 	bf_write *buffer;
    81 
    82 	if (m_InExec || m_InHook)
    83 	{
    84 		return NULL;
    85 	}
    86 	if (msg_id < 0 || msg_id >= 255)
    87 	{
    88 		return NULL;
    89 	}
    90 
    91 	m_CellRecFilter.Initialize(players, playersNum);
    92 
    93 	m_CurFlags = flags;
    94 	if (m_CurFlags & USERMSG_INITMSG)
    95 	{
    96 		m_CellRecFilter.SetToInit(true);
    97 	}
    98 	if (m_CurFlags & USERMSG_RELIABLE)
    99 	{
   100 		m_CellRecFilter.SetToReliable(true);
   101 	}
   102 
   103 	m_InExec = true;
   104 
   105 	if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
   106 	{
   107 		buffer = engine->UserMessageBegin(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
   108 	} else {
   109 		buffer = ENGINE_CALL(UserMessageBegin)(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
   110 	}
   111 
   112 	return buffer;
   113 }
   114 
   115 bool UserMessages::EndMessage()
   116 {
   117 	if (!m_InExec)
   118 	{
   119 		return false;
   120 	}
   121 
   122 	if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
   123 	{
   124 		engine->MessageEnd();
   125 	} else {
   126 		ENGINE_CALL(MessageEnd)();
   127 	}
   128 
   129 	m_InExec = false;
   130 	m_CurFlags = 0;
   131 	m_CellRecFilter.Reset();
   132 
   133 	return true;
   134 }
   135 
   136 bool UserMessages::HookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
   137 {
   138 	if (msg_id < 0 || msg_id >= 255)
   139 	{
   140 		return false;
   141 	}
   142 
   143 	ListenerInfo *pInfo;
   144 	if (m_FreeListeners.empty())
   145 	{
   146 		pInfo = new ListenerInfo;
   147 	} else {
   148 		pInfo = m_FreeListeners.front();
   149 		m_FreeListeners.pop();
   150 	}
   151 
   152 	pInfo->Callback = pListener;
   153 	pInfo->IsHooked = false;
   154 	pInfo->KillMe = false;
   155 
   156 	if (!m_HookCount++)
   157 	{
   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);
   162 	}
   163 
   164 	if (intercept)
   165 	{
   166 		m_msgIntercepts[msg_id].push_back(pInfo);
   167 	} else {
   168 		m_msgHooks[msg_id].push_back(pInfo);
   169 	}
   170 
   171 	return true;
   172 }
   173 
   174 bool UserMessages::UnhookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
   175 {	
   176 	MsgList *pList;
   177 	MsgIter iter;
   178 	ListenerInfo *pInfo;
   179 	bool deleted = false;
   180 
   181 	if (msg_id < 0 || msg_id >= 255)
   182 	{
   183 		return false;
   184 	}
   185 
   186 	pList = (intercept) ? &m_msgIntercepts[msg_id] : &m_msgHooks[msg_id];
   187 	for (iter=pList->begin(); iter!=pList->end(); iter++)
   188 	{
   189 		pInfo = (*iter);
   190 		if (pInfo->Callback == pListener)
   191 		{
   192 			if (pInfo->IsHooked)
   193 			{
   194 				pInfo->KillMe = true;
   195 				return true;
   196 			}
   197 			pList->erase(iter);
   198 			deleted = true;
   199 			break;
   200 		}
   201 	}
   202 
   203 	if (deleted)
   204 	{
   205 		_DecRefCounter();
   206 	}
   207 
   208 	return deleted;
   209 }
   210 
   211 void UserMessages::_DecRefCounter()
   212 {
   213 	if (--m_HookCount == 0)
   214 	{
   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);
   219 	}
   220 }
   221 
   222 bf_write *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type)
   223 {
   224 	bool is_intercept_empty = m_msgIntercepts[msg_type].empty();
   225 	bool is_hook_empty = m_msgHooks[msg_type].empty();
   226 
   227 	if ((is_intercept_empty && is_hook_empty)
   228 		|| (m_InExec && !(m_CurFlags & USERMSG_PASSTHRU_ALL)))
   229 	{
   230 		m_InHook = false;
   231 		RETURN_META_VALUE(MRES_IGNORED, NULL);
   232 	}
   233 
   234 	m_CurId = msg_type;
   235 	m_CurRecFilter = filter;
   236 	m_InHook = true;
   237 	m_BlockEndPost = false;
   238 
   239 	if (!is_intercept_empty)
   240 	{
   241 		m_InterceptBuffer.Reset();
   242 		RETURN_META_VALUE(MRES_SUPERCEDE, &m_InterceptBuffer);
   243 	}
   244 
   245 	RETURN_META_VALUE(MRES_IGNORED, NULL);
   246 }
   247 
   248 bf_write *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type)
   249 {
   250 	if (!m_InHook)
   251 	{
   252 		RETURN_META_VALUE(MRES_IGNORED, NULL);
   253 	}
   254 
   255 	m_OrigBuffer = META_RESULT_ORIG_RET(bf_write *);
   256 
   257 	RETURN_META_VALUE(MRES_IGNORED, NULL);
   258 }
   259 
   260 void UserMessages::OnMessageEnd_Post()
   261 {
   262 	if (!m_InHook || m_BlockEndPost)
   263 	{
   264 		RETURN_META(MRES_IGNORED);
   265 	}
   266 
   267 	MsgList *pList;
   268 	MsgIter iter;
   269 	ListenerInfo *pInfo;
   270 
   271 	pList = &m_msgIntercepts[m_CurId];
   272 	for (iter=pList->begin(); iter!=pList->end(); )
   273 	{
   274 		pInfo = (*iter);
   275 		pInfo->IsHooked = true;
   276 		pInfo->Callback->OnUserMessageSent(m_CurId);
   277 
   278 		if (pInfo->KillMe)
   279 		{
   280 			iter = pList->erase(iter);
   281 			m_FreeListeners.push(pInfo);
   282 			_DecRefCounter();
   283 			continue;
   284 		}
   285 
   286 		pInfo->IsHooked = false;
   287 		iter++;
   288 	}
   289 
   290 	pList = &m_msgHooks[m_CurId];
   291 	for (iter=pList->begin(); iter!=pList->end(); )
   292 	{
   293 		pInfo = (*iter);
   294 		pInfo->IsHooked = true;
   295 		pInfo->Callback->OnUserMessageSent(m_CurId);
   296 
   297 		if (pInfo->KillMe)
   298 		{
   299 			iter = pList->erase(iter);
   300 			m_FreeListeners.push(pInfo);
   301 			_DecRefCounter();
   302 			continue;
   303 		}
   304 
   305 		pInfo->IsHooked = false;
   306 		iter++;
   307 	}
   308 
   309 	m_InHook = false;
   310 }
   311 
   312 void UserMessages::OnMessageEnd_Pre()
   313 {
   314 	if (!m_InHook)
   315 	{
   316 		RETURN_META(MRES_IGNORED);
   317 	}
   318 
   319 	MsgList *pList;
   320 	MsgIter iter;
   321 	ListenerInfo *pInfo;
   322 
   323 	ResultType res;
   324 	bool intercepted = false;
   325 	bool handled = false;
   326 
   327 	pList = &m_msgIntercepts[m_CurId];
   328 	for (iter=pList->begin(); iter!=pList->end(); )
   329 	{
   330 		pInfo = (*iter);
   331 		pInfo->IsHooked = true;
   332 		res = pInfo->Callback->InterceptUserMessage(m_CurId, &m_InterceptBuffer, m_CurRecFilter);
   333 
   334 		intercepted = true;
   335 
   336 		switch (res)
   337 		{
   338 		case Pl_Stop:
   339 			{
   340 				if (pInfo->KillMe)
   341 				{
   342 					pList->erase(iter);
   343 					m_FreeListeners.push(pInfo);
   344 					_DecRefCounter();
   345 					goto supercede;
   346 				}
   347 				pInfo->IsHooked = false;
   348 				goto supercede;
   349 			}
   350 		case Pl_Handled:
   351 			{
   352 				handled = true;
   353 				if (pInfo->KillMe)
   354 				{
   355 					iter = pList->erase(iter);
   356 					m_FreeListeners.push(pInfo);
   357 					_DecRefCounter();
   358 					continue;
   359 				}
   360 				break;
   361 			}
   362 		default:
   363 			{
   364 				if (pInfo->KillMe)
   365 				{
   366 					iter = pList->erase(iter);
   367 					m_FreeListeners.push(pInfo);
   368 					_DecRefCounter();
   369 					continue;
   370 				}
   371 				break;
   372 			}
   373 		}
   374 		pInfo->IsHooked = false;
   375 		iter++;
   376 	}
   377 
   378 	if (handled)
   379 	{
   380 		goto supercede;
   381 	}
   382 
   383 	if (intercepted)
   384 	{
   385 		bf_write *engine_bfw;
   386 
   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)();
   391 	}
   392 
   393 	pList = &m_msgHooks[m_CurId];
   394 	for (iter=pList->begin(); iter!=pList->end(); )
   395 	{
   396 		pInfo = (*iter);
   397 		pInfo->IsHooked = true;
   398 		pInfo->Callback->OnUserMessage(m_CurId, m_OrigBuffer, m_CurRecFilter);
   399 
   400 		if (pInfo->KillMe)
   401 		{
   402 			iter = pList->erase(iter);
   403 			m_FreeListeners.push(pInfo);
   404 			_DecRefCounter();
   405 			continue;
   406 		}
   407 
   408 		pInfo->IsHooked = false;
   409 		iter++;
   410 	}
   411 
   412 	RETURN_META((intercepted) ? MRES_SUPERCEDE : MRES_IGNORED);
   413 supercede:
   414 	m_InHook = false;
   415 	m_BlockEndPost = true;
   416 	RETURN_META(MRES_SUPERCEDE);
   417 }