core/UserMessages.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Mar 22 21:50:20 2007 +0000 (2007-03-22)
changeset 653 ef60870067ff
parent 641 ce1f369ba889
child 698 8c68fc683dba
permissions -rw-r--r--
More consistency of some sort...

Oh god, what has possessed me to do this?
     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 //:TODO: USE NEW MM IFACE TO SEARCH FOR MESSAGE NAMES ETC! faluco--> i'll do this when i have some spare time
    23 
    24 UserMessages::UserMessages() : m_InterceptBuffer(m_pBase, 2500)
    25 {
    26 	m_Names = sm_trie_create();
    27 	m_HookCount = 0;
    28 	m_InExec = false;
    29 	m_InHook = false;
    30 	m_CurFlags = 0;
    31 	m_CurId = INVALID_MESSAGE_ID;
    32 }
    33 
    34 UserMessages::~UserMessages()
    35 {
    36 	sm_trie_destroy(m_Names);
    37 
    38 	CStack<ListenerInfo *>::iterator iter;
    39 	for (iter=m_FreeListeners.begin(); iter!=m_FreeListeners.end(); iter++)
    40 	{
    41 		delete (*iter);
    42 	}
    43 	m_FreeListeners.popall();
    44 }
    45 
    46 void UserMessages::OnSourceModAllInitialized()
    47 {
    48 	g_ShareSys.AddInterface(NULL, this);
    49 }
    50 
    51 void UserMessages::OnSourceModAllShutdown()
    52 {
    53 	if (m_HookCount)
    54 	{
    55 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
    56 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
    57 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
    58 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
    59 	}
    60 	m_HookCount = 0;
    61 }
    62 
    63 int UserMessages::GetMessageIndex(const char *msg)
    64 {
    65 	int msgid;
    66 	if (!sm_trie_retrieve(m_Names, msg, reinterpret_cast<void **>(&msgid)))
    67 	{
    68 		char buf[255];
    69 		int dummy;
    70 		msgid = 0;
    71 
    72 		while (gamedll->GetUserMessageInfo(msgid, buf, sizeof(buf), dummy))
    73 		{
    74 			if (strcmp(msg, buf) == 0)
    75 			{
    76 				sm_trie_insert(m_Names, msg, reinterpret_cast<void *>(msgid));
    77 				return msgid;
    78 			}
    79 			msgid++;
    80 		}
    81 
    82 		return INVALID_MESSAGE_ID;
    83 	}
    84 
    85 	return msgid;
    86 }
    87 
    88 bool UserMessages::GetMessageName(int msgid, char *buffer, size_t maxlen) const
    89 {
    90 	int dummy;
    91 
    92 	return gamedll->GetUserMessageInfo(msgid, buffer, maxlen, dummy);
    93 }
    94 
    95 bf_write *UserMessages::StartMessage(int msg_id, cell_t players[], unsigned int playersNum, int flags)
    96 {
    97 	bf_write *buffer;
    98 
    99 	if (m_InExec || m_InHook)
   100 	{
   101 		return NULL;
   102 	}
   103 	if (msg_id < 0 || msg_id >= 255)
   104 	{
   105 		return NULL;
   106 	}
   107 
   108 	m_CellRecFilter.Initialize(players, playersNum);
   109 
   110 	m_CurFlags = flags;
   111 	if (m_CurFlags & USERMSG_INITMSG)
   112 	{
   113 		m_CellRecFilter.SetToInit(true);
   114 	}
   115 	if (m_CurFlags & USERMSG_RELIABLE)
   116 	{
   117 		m_CellRecFilter.SetToReliable(true);
   118 	}
   119 
   120 	m_InExec = true;
   121 
   122 	if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
   123 	{
   124 		buffer = engine->UserMessageBegin(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
   125 	} else {
   126 		buffer = ENGINE_CALL(UserMessageBegin)(static_cast<IRecipientFilter *>(&m_CellRecFilter), msg_id);
   127 	}
   128 
   129 	return buffer;
   130 }
   131 
   132 bool UserMessages::EndMessage()
   133 {
   134 	if (!m_InExec)
   135 	{
   136 		return false;
   137 	}
   138 
   139 	if (m_CurFlags & (USERMSG_PASSTHRU_ALL|USERMSG_PASSTHRU))
   140 	{
   141 		engine->MessageEnd();
   142 	} else {
   143 		ENGINE_CALL(MessageEnd)();
   144 	}
   145 
   146 	m_InExec = false;
   147 	m_CurFlags = 0;
   148 	m_CellRecFilter.Reset();
   149 
   150 	return true;
   151 }
   152 
   153 bool UserMessages::HookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
   154 {
   155 	if (msg_id < 0 || msg_id >= 255)
   156 	{
   157 		return false;
   158 	}
   159 
   160 	ListenerInfo *pInfo;
   161 	if (m_FreeListeners.empty())
   162 	{
   163 		pInfo = new ListenerInfo;
   164 	} else {
   165 		pInfo = m_FreeListeners.front();
   166 		m_FreeListeners.pop();
   167 	}
   168 
   169 	pInfo->Callback = pListener;
   170 	pInfo->IsHooked = false;
   171 	pInfo->KillMe = false;
   172 
   173 	if (!m_HookCount++)
   174 	{
   175 		SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
   176 		SH_ADD_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
   177 		SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
   178 		SH_ADD_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
   179 	}
   180 
   181 	if (intercept)
   182 	{
   183 		m_msgIntercepts[msg_id].push_back(pInfo);
   184 	} else {
   185 		m_msgHooks[msg_id].push_back(pInfo);
   186 	}
   187 
   188 	return true;
   189 }
   190 
   191 bool UserMessages::UnhookUserMessage(int msg_id, IUserMessageListener *pListener, bool intercept)
   192 {	
   193 	MsgList *pList;
   194 	MsgIter iter;
   195 	ListenerInfo *pInfo;
   196 	bool deleted = false;
   197 
   198 	if (msg_id < 0 || msg_id >= 255)
   199 	{
   200 		return false;
   201 	}
   202 
   203 	pList = (intercept) ? &m_msgIntercepts[msg_id] : &m_msgHooks[msg_id];
   204 	for (iter=pList->begin(); iter!=pList->end(); iter++)
   205 	{
   206 		pInfo = (*iter);
   207 		if (pInfo->Callback == pListener)
   208 		{
   209 			if (pInfo->IsHooked)
   210 			{
   211 				pInfo->KillMe = true;
   212 				return true;
   213 			}
   214 			pList->erase(iter);
   215 			deleted = true;
   216 			break;
   217 		}
   218 	}
   219 
   220 	if (deleted)
   221 	{
   222 		_DecRefCounter();
   223 	}
   224 
   225 	return deleted;
   226 }
   227 
   228 void UserMessages::_DecRefCounter()
   229 {
   230 	if (--m_HookCount == 0)
   231 	{
   232 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Pre, false);
   233 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, UserMessageBegin, engine, this, &UserMessages::OnStartMessage_Post, true);
   234 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Pre, false);
   235 		SH_REMOVE_HOOK_MEMFUNC(IVEngineServer, MessageEnd, engine, this, &UserMessages::OnMessageEnd_Post, true);
   236 	}
   237 }
   238 
   239 bf_write *UserMessages::OnStartMessage_Pre(IRecipientFilter *filter, int msg_type)
   240 {
   241 	bool is_intercept_empty = m_msgIntercepts[msg_type].empty();
   242 	bool is_hook_empty = m_msgHooks[msg_type].empty();
   243 
   244 	if ((is_intercept_empty && is_hook_empty)
   245 		|| (m_InExec && !(m_CurFlags & USERMSG_PASSTHRU_ALL)))
   246 	{
   247 		m_InHook = false;
   248 		RETURN_META_VALUE(MRES_IGNORED, NULL);
   249 	}
   250 
   251 	m_CurId = msg_type;
   252 	m_CurRecFilter = filter;
   253 	m_InHook = true;
   254 	m_BlockEndPost = false;
   255 
   256 	if (!is_intercept_empty)
   257 	{
   258 		m_InterceptBuffer.Reset();
   259 		RETURN_META_VALUE(MRES_SUPERCEDE, &m_InterceptBuffer);
   260 	}
   261 
   262 	RETURN_META_VALUE(MRES_IGNORED, NULL);
   263 }
   264 
   265 bf_write *UserMessages::OnStartMessage_Post(IRecipientFilter *filter, int msg_type)
   266 {
   267 	if (!m_InHook)
   268 	{
   269 		RETURN_META_VALUE(MRES_IGNORED, NULL);
   270 	}
   271 
   272 	m_OrigBuffer = META_RESULT_ORIG_RET(bf_write *);
   273 
   274 	RETURN_META_VALUE(MRES_IGNORED, NULL);
   275 }
   276 
   277 void UserMessages::OnMessageEnd_Post()
   278 {
   279 	if (!m_InHook || m_BlockEndPost)
   280 	{
   281 		RETURN_META(MRES_IGNORED);
   282 	}
   283 
   284 	MsgList *pList;
   285 	MsgIter iter;
   286 	ListenerInfo *pInfo;
   287 
   288 	pList = &m_msgIntercepts[m_CurId];
   289 	for (iter=pList->begin(); iter!=pList->end(); )
   290 	{
   291 		pInfo = (*iter);
   292 		pInfo->IsHooked = true;
   293 		pInfo->Callback->OnUserMessageSent(m_CurId);
   294 
   295 		if (pInfo->KillMe)
   296 		{
   297 			iter = pList->erase(iter);
   298 			m_FreeListeners.push(pInfo);
   299 			_DecRefCounter();
   300 			continue;
   301 		}
   302 
   303 		pInfo->IsHooked = false;
   304 		iter++;
   305 	}
   306 
   307 	pList = &m_msgHooks[m_CurId];
   308 	for (iter=pList->begin(); iter!=pList->end(); )
   309 	{
   310 		pInfo = (*iter);
   311 		pInfo->IsHooked = true;
   312 		pInfo->Callback->OnUserMessageSent(m_CurId);
   313 
   314 		if (pInfo->KillMe)
   315 		{
   316 			iter = pList->erase(iter);
   317 			m_FreeListeners.push(pInfo);
   318 			_DecRefCounter();
   319 			continue;
   320 		}
   321 
   322 		pInfo->IsHooked = false;
   323 		iter++;
   324 	}
   325 
   326 	m_InHook = false;
   327 }
   328 
   329 void UserMessages::OnMessageEnd_Pre()
   330 {
   331 	if (!m_InHook)
   332 	{
   333 		RETURN_META(MRES_IGNORED);
   334 	}
   335 
   336 	MsgList *pList;
   337 	MsgIter iter;
   338 	ListenerInfo *pInfo;
   339 
   340 	ResultType res;
   341 	bool intercepted = false;
   342 	bool handled = false;
   343 
   344 	pList = &m_msgIntercepts[m_CurId];
   345 	for (iter=pList->begin(); iter!=pList->end(); )
   346 	{
   347 		pInfo = (*iter);
   348 		pInfo->IsHooked = true;
   349 		res = pInfo->Callback->InterceptUserMessage(m_CurId, &m_InterceptBuffer, m_CurRecFilter);
   350 
   351 		intercepted = true;
   352 
   353 		switch (res)
   354 		{
   355 		case Pl_Stop:
   356 			{
   357 				if (pInfo->KillMe)
   358 				{
   359 					pList->erase(iter);
   360 					m_FreeListeners.push(pInfo);
   361 					_DecRefCounter();
   362 					goto supercede;
   363 				}
   364 				pInfo->IsHooked = false;
   365 				goto supercede;
   366 			}
   367 		case Pl_Handled:
   368 			{
   369 				handled = true;
   370 				if (pInfo->KillMe)
   371 				{
   372 					iter = pList->erase(iter);
   373 					m_FreeListeners.push(pInfo);
   374 					_DecRefCounter();
   375 					continue;
   376 				}
   377 				break;
   378 			}
   379 		default:
   380 			{
   381 				if (pInfo->KillMe)
   382 				{
   383 					iter = pList->erase(iter);
   384 					m_FreeListeners.push(pInfo);
   385 					_DecRefCounter();
   386 					continue;
   387 				}
   388 				break;
   389 			}
   390 		}
   391 		pInfo->IsHooked = false;
   392 		iter++;
   393 	}
   394 
   395 	if (handled)
   396 	{
   397 		goto supercede;
   398 	}
   399 
   400 	if (intercepted)
   401 	{
   402 		bf_write *engine_bfw;
   403 
   404 		engine_bfw = ENGINE_CALL(UserMessageBegin)(m_CurRecFilter, m_CurId);
   405 		m_ReadBuffer.StartReading(m_InterceptBuffer.GetBasePointer(), m_InterceptBuffer.GetNumBytesWritten());
   406 		engine_bfw->WriteBitsFromBuffer(&m_ReadBuffer, m_InterceptBuffer.GetNumBitsWritten());
   407 		ENGINE_CALL(MessageEnd)();
   408 	}
   409 
   410 	pList = &m_msgHooks[m_CurId];
   411 	for (iter=pList->begin(); iter!=pList->end(); )
   412 	{
   413 		pInfo = (*iter);
   414 		pInfo->IsHooked = true;
   415 		pInfo->Callback->OnUserMessage(m_CurId, m_OrigBuffer, m_CurRecFilter);
   416 
   417 		if (pInfo->KillMe)
   418 		{
   419 			iter = pList->erase(iter);
   420 			m_FreeListeners.push(pInfo);
   421 			_DecRefCounter();
   422 			continue;
   423 		}
   424 
   425 		pInfo->IsHooked = false;
   426 		iter++;
   427 	}
   428 
   429 	RETURN_META((intercepted) ? MRES_SUPERCEDE : MRES_IGNORED);
   430 supercede:
   431 	m_InHook = false;
   432 	m_BlockEndPost = true;
   433 	RETURN_META(MRES_SUPERCEDE);
   434 }