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