sourcemm/CSmmAPI.cpp
author David Anderson <dvander@alliedmods.net>
Fri Apr 06 20:53:07 2007 +0000 (2007-04-06)
changeset 313 297482d07c85
parent 299 9bce3a94cde4
child 314 7666e83ef566
permissions -rw-r--r--
fixed a post-release error where the vsp listener API simply didn't work :(
dvander@9
     1
/* ======== SourceMM ========
dvander@282
     2
 * Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@282
     3
 * No warranties of any kind
dvander@282
     4
 *
dvander@282
     5
 * License: zlib/libpng
dvander@282
     6
 *
dvander@282
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@282
     8
 * ============================
dvander@282
     9
 */
dvander@9
    10
ds@280
    11
#include "convar_smm.h"
dvander@9
    12
#include "CSmmAPI.h"
dvander@7
    13
#include "sourcemm.h"
dvander@64
    14
#include "concommands.h"
dvander@124
    15
#include "CPlugin.h"
dvander@282
    16
#include "vsp_listener.h"
dvander@7
    17
dvander@9
    18
/**
dvander@9
    19
 * @brief Implementation of main API interface
dvander@9
    20
 * @file CSmmAPI.cpp
dvander@9
    21
 */
dvander@9
    22
dvander@26
    23
using namespace SourceMM;
dvander@26
    24
dvander@7
    25
CSmmAPI g_SmmAPI;
dvander@7
    26
dvander@76
    27
CSmmAPI::CSmmAPI()
dvander@76
    28
{
dvander@76
    29
	m_ConPrintf = NULL;
ds@287
    30
	m_CmdCache = false;
ds@287
    31
	m_MsgCount = -1;
dvander@282
    32
	m_VSP = false;
dvander@76
    33
}
dvander@76
    34
ds@287
    35
CSmmAPI::~CSmmAPI()
ds@287
    36
{
ds@287
    37
	m_UserMessages.RemoveAll();
ds@287
    38
}
ds@287
    39
dvander@7
    40
void CSmmAPI::LogMsg(ISmmPlugin *pl, const char *msg, ...)
dvander@7
    41
{
dvander@7
    42
	va_list ap;
dvander@7
    43
	static char buffer[2048];
dvander@7
    44
dvander@7
    45
	va_start(ap, msg);
ds@296
    46
	UTIL_FormatArgs(buffer, sizeof(buffer), msg, ap);
dvander@7
    47
	va_end(ap);
dvander@7
    48
dvander@7
    49
	LogMessage("[%s] %s", pl->GetLogTag(), buffer);
dvander@7
    50
}
dvander@7
    51
dvander@7
    52
CreateInterfaceFn CSmmAPI::engineFactory(bool syn)
dvander@7
    53
{
dvander@7
    54
	if (syn)
dvander@7
    55
		return EngineFactory;
dvander@7
    56
	return g_Engine.engineFactory;
dvander@7
    57
}
dvander@7
    58
dvander@7
    59
CreateInterfaceFn CSmmAPI::physicsFactory(bool syn)
dvander@7
    60
{
dvander@7
    61
	if (syn)
dvander@7
    62
		return PhysicsFactory;
dvander@7
    63
	return g_Engine.physicsFactory;
dvander@7
    64
}
dvander@7
    65
dvander@7
    66
CreateInterfaceFn CSmmAPI::fileSystemFactory(bool syn)
dvander@7
    67
{
dvander@7
    68
	if (syn)
dvander@7
    69
		return FileSystemFactory;
dvander@7
    70
	return g_Engine.fileSystemFactory;
dvander@7
    71
}
dvander@7
    72
dvander@7
    73
CreateInterfaceFn CSmmAPI::serverFactory(bool syn)
dvander@7
    74
{
dvander@7
    75
	if (syn)
dvander@7
    76
		return CreateInterface;
dvander@7
    77
	return g_GameDll.factory;
dvander@7
    78
}
dvander@7
    79
dvander@7
    80
CGlobalVars *CSmmAPI::pGlobals()
dvander@7
    81
{
dvander@7
    82
	return g_Engine.pGlobals;
dvander@7
    83
}
dvander@7
    84
dvander@7
    85
void CSmmAPI::SetLastMetaReturn(META_RES res)
dvander@7
    86
{
dvander@7
    87
	m_Res = res;
dvander@7
    88
}
dvander@7
    89
dvander@7
    90
META_RES CSmmAPI::GetLastMetaReturn()
dvander@7
    91
{
dvander@7
    92
	return m_Res;
dvander@7
    93
}
dvander@64
    94
dvander@64
    95
IConCommandBaseAccessor *CSmmAPI::GetCvarBaseAccessor()
dvander@64
    96
{
dvander@64
    97
	return static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor);
dvander@64
    98
}
dvander@64
    99
dvander@67
   100
bool CSmmAPI::RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
dvander@64
   101
{
dvander@67
   102
	if (pCommand->IsCommand())
dvander@67
   103
	{
dvander@67
   104
		g_PluginMngr.AddPluginCmd(plugin, pCommand);
dvander@67
   105
	} else {
dvander@67
   106
		g_PluginMngr.AddPluginCvar(plugin, pCommand);
dvander@67
   107
	}
dvander@67
   108
dvander@67
   109
	return g_SMConVarAccessor.Register(pCommand);
dvander@64
   110
}
dvander@64
   111
dvander@67
   112
void CSmmAPI::UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
ds@65
   113
{
dvander@67
   114
	if (pCommand->IsCommand())
dvander@67
   115
	{
dvander@67
   116
		g_PluginMngr.RemovePluginCmd(plugin, pCommand);
dvander@67
   117
	} else {
dvander@67
   118
		g_PluginMngr.RemovePluginCvar(plugin, pCommand);
dvander@67
   119
	}
dvander@67
   120
ds@65
   121
	g_SMConVarAccessor.Unregister(pCommand);
ds@65
   122
}
ds@65
   123
dvander@76
   124
void CSmmAPI::ConPrint(const char *fmt)
dvander@76
   125
{
dvander@76
   126
	(m_ConPrintf)("%s", fmt);
dvander@76
   127
}
dvander@76
   128
dvander@76
   129
void CSmmAPI::ConPrintf(const char *fmt, ...)
dvander@76
   130
{
dvander@76
   131
	va_list ap;
ds@296
   132
	static char buffer[4096];
ds@296
   133
dvander@76
   134
	va_start(ap, fmt);
ds@296
   135
	UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap);
dvander@76
   136
	va_end(ap);
ds@296
   137
ds@296
   138
	(m_ConPrintf)("%s", buffer);
dvander@76
   139
}
dvander@76
   140
dvander@138
   141
void CSmmAPI::AddListener(ISmmPlugin *plugin, IMetamodListener *pListener)
dvander@138
   142
{
dvander@138
   143
	CPluginManager::CPlugin *pl = g_PluginMngr.FindByAPI(plugin);
dvander@138
   144
dvander@138
   145
	pl->m_Events.push_back(pListener);
dvander@138
   146
}
dvander@138
   147
dvander@139
   148
void *CSmmAPI::MetaFactory(const char *iface, int *_ret, PluginId *id)
dvander@138
   149
{
dvander@139
   150
	if (id)
dvander@282
   151
	{
dvander@139
   152
		*id = 0;
dvander@282
   153
	}
dvander@139
   154
dvander@138
   155
	if (!iface)
dvander@282
   156
	{
dvander@138
   157
		return NULL;
dvander@282
   158
	}
dvander@138
   159
dvander@138
   160
	//first check ours... we get first chance!
ds@225
   161
	if (strcmp(iface, MMIFACE_SOURCEHOOK) == 0)
dvander@138
   162
	{
dvander@138
   163
		if (_ret)
dvander@282
   164
		{
dvander@138
   165
			*_ret = IFACE_OK;
dvander@282
   166
		}
dvander@138
   167
		return static_cast<void *>(static_cast<SourceHook::ISourceHook *>(&g_SourceHook));
ds@225
   168
	} else if (strcmp(iface, MMIFACE_PLMANAGER) == 0) {
dvander@138
   169
		if (_ret)
dvander@282
   170
		{
dvander@138
   171
			*_ret = IFACE_OK;
dvander@282
   172
		}
ds@225
   173
		return static_cast<void *>(static_cast<ISmmPluginManager *>(&g_PluginMngr));
dvander@138
   174
	}
dvander@138
   175
dvander@138
   176
	CPluginManager::CPlugin *pl;
dvander@138
   177
	SourceHook::List<IMetamodListener *>::iterator event;
dvander@138
   178
	IMetamodListener *api;
dvander@138
   179
	int ret = 0;
dvander@138
   180
	void *val = NULL;
dvander@138
   181
dvander@138
   182
	for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++)
dvander@138
   183
	{
dvander@138
   184
		pl = (*iter);
dvander@138
   185
		for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++)
dvander@138
   186
		{
dvander@138
   187
			api = (*event);
dvander@138
   188
			ret = IFACE_FAILED;
dvander@138
   189
			if ( (val=api->OnMetamodQuery(iface, &ret)) != NULL )
dvander@138
   190
			{
dvander@138
   191
				if (_ret)
dvander@138
   192
					*_ret = ret;
dvander@139
   193
				if (id)
dvander@139
   194
					*id = pl->m_Id;
dvander@138
   195
				return val;
dvander@138
   196
			}
dvander@138
   197
		}
dvander@138
   198
	}
dvander@138
   199
dvander@138
   200
	if (_ret)
dvander@138
   201
		*_ret = IFACE_FAILED;
dvander@138
   202
dvander@138
   203
	return NULL;
dvander@138
   204
}
dvander@138
   205
dvander@76
   206
//////////////////////////////////////////////////////////////////////////
dvander@76
   207
//THERE BE HAX HERE!!!! DON'T TELL ALFRED, BUT GABE WANTED IT THAT WAY. //
dvander@77
   208
// (note: you can find the offset by looking for the text               //
dvander@76
   209
//   "Echo text to console", you'll find the callback cmd pushed on the //
dvander@76
   210
//   stack.)                                                            //
dvander@76
   211
//////////////////////////////////////////////////////////////////////////
dvander@76
   212
dvander@76
   213
#define SIGLEN			8
dvander@76
   214
#define ENGINE486_SIG	"\x55\x89\xE5\x53\x83\xEC\x14\xBB"
dvander@76
   215
#define ENGINE486_OFFS	40
dvander@76
   216
#define ENGINE686_SIG	"\x53\x83\xEC\x08\xBB\x01\x00\x00"
dvander@76
   217
#define ENGINE686_OFFS	50
dvander@94
   218
#define	ENGINEAMD_SIG	"\x53\x51\xBB\x01\x00\x00\x00\x51"
dvander@76
   219
#define	ENGINEAMD_OFFS	47
dvander@76
   220
#define ENGINEW32_SIG	"\xA1\x2A\x2A\x2A\x2A\x56\xBE\x01"
dvander@76
   221
#define ENGINEW32_OFFS	38
dvander@76
   222
#define IA32_CALL		0xE8
dvander@76
   223
dvander@231
   224
bool vcmp(const void *_addr1, const void *_addr2, size_t len)
dvander@76
   225
{
dvander@76
   226
	unsigned char *addr1 = (unsigned char *)_addr1;
dvander@76
   227
	unsigned char *addr2 = (unsigned char *)_addr2;
dvander@76
   228
dvander@76
   229
	for (size_t i=0; i<len; i++)
dvander@76
   230
	{
dvander@76
   231
		if (addr2[i] == '*')
dvander@76
   232
			continue;
dvander@76
   233
		if (addr1[i] != addr2[i])
dvander@76
   234
			return false;
dvander@76
   235
	}
dvander@76
   236
dvander@76
   237
	return true;
dvander@76
   238
}
dvander@76
   239
dvander@76
   240
//Thanks to fysh for the idea of extracting info from "echo" and for
dvander@76
   241
// having the original offsets at hand!
dvander@76
   242
bool CSmmAPI::CacheCmds()
dvander@76
   243
{
dvander@76
   244
	ICvar *pCvar = g_Engine.icvar;
dvander@76
   245
dvander@76
   246
	ConCommandBase *pBase = pCvar->GetCommands();
dvander@76
   247
	unsigned char *ptr = NULL;
dvander@76
   248
	FnCommandCallback callback = NULL;
dvander@76
   249
	int offs = 0;
dvander@76
   250
dvander@76
   251
	while (pBase)
dvander@76
   252
	{
dvander@76
   253
		if ( strcmp(pBase->GetName(), "echo") == 0 )
dvander@76
   254
		{
dvander@76
   255
			//callback = //*((FnCommandCallback *)((char *)pBase + offsetof(ConCommand, m_fnCommandCallback)));
dvander@76
   256
			callback = ((ConCommand *)pBase)->GetCallback();
dvander@76
   257
			ptr = (unsigned char *)callback;
ds@201
   258
		#ifdef OS_LINUX
dvander@76
   259
			if (vcmp(ptr, ENGINE486_SIG, SIGLEN))
dvander@76
   260
			{
dvander@76
   261
				offs = ENGINE486_OFFS;
ds@201
   262
			}
ds@201
   263
			else if (vcmp(ptr, ENGINE686_SIG, SIGLEN))
ds@201
   264
			{
dvander@76
   265
				offs = ENGINE686_OFFS;
ds@201
   266
			}
ds@201
   267
			else if (vcmp(ptr, ENGINEAMD_SIG, SIGLEN))
ds@201
   268
			{
dvander@76
   269
				offs = ENGINEAMD_OFFS;
ds@201
   270
			}
ds@201
   271
		#elif defined OS_WIN32 // Only one Windows engine binary so far...
ds@201
   272
			if (vcmp(ptr, ENGINEW32_SIG, SIGLEN))
ds@201
   273
			{
dvander@76
   274
				offs = ENGINEW32_OFFS;
dvander@76
   275
			}
ds@201
   276
		#endif
ds@201
   277
ds@296
   278
			if (!offs || ptr[offs - 1] != IA32_CALL)
dvander@76
   279
			{
dvander@76
   280
				m_ConPrintf = (CONPRINTF_FUNC)Msg;
dvander@76
   281
				return false;
dvander@76
   282
			}
dvander@76
   283
			//get the relative offset
dvander@76
   284
			m_ConPrintf = *((CONPRINTF_FUNC *)(ptr + offs));
dvander@76
   285
			//add the base offset, to the ip (which is the address+offset + 4 bytes for next instruction)
dvander@76
   286
			m_ConPrintf = (CONPRINTF_FUNC)((unsigned long)m_ConPrintf + (unsigned long)(ptr + offs) + 4);
dvander@76
   287
ds@287
   288
			m_CmdCache = true;
dvander@76
   289
dvander@76
   290
			return true;
dvander@76
   291
		}
dvander@76
   292
		pBase = const_cast<ConCommandBase *>(pBase->GetNext());
dvander@76
   293
	}
dvander@76
   294
dvander@76
   295
	m_ConPrintf = (CONPRINTF_FUNC)Msg;
dvander@76
   296
dvander@76
   297
	return false;
dvander@76
   298
}
dvander@76
   299
ds@287
   300
bool CSmmAPI::CmdCacheSuccessful()
dvander@76
   301
{
ds@287
   302
	return m_CmdCache;
dvander@76
   303
}
dvander@124
   304
dvander@124
   305
void CSmmAPI::GetApiVersions(int &major, int &minor, int &plvers, int &plmin)
dvander@124
   306
{
dvander@124
   307
	major = SM_VERS_API_MAJOR;
dvander@124
   308
	minor = SM_VERS_API_MINOR;
dvander@124
   309
	plvers = PLAPI_VERSION;
dvander@124
   310
	plmin = PLAPI_MIN_VERSION;
dvander@124
   311
}
dvander@124
   312
dvander@124
   313
void CSmmAPI::GetShVersions(int &shvers, int &shimpl)
dvander@124
   314
{
dvander@124
   315
	shvers = SH_IFACE_VERSION;
dvander@124
   316
	shimpl = SH_IMPL_VERSION;
dvander@124
   317
}
dvander@152
   318
dvander@152
   319
int CSmmAPI::FormatIface(char iface[], unsigned int maxlength)
dvander@152
   320
{
dvander@206
   321
	int length = (int)strlen(iface);
dvander@152
   322
	int i;
dvander@152
   323
	int num = 0;
dvander@152
   324
ds@296
   325
	for (i = length - 1; i >= 0; i--)
dvander@152
   326
	{
dvander@152
   327
		if (!isdigit(iface[i]))
dvander@228
   328
		{
ds@296
   329
			if (i != length - 1)
dvander@228
   330
			{
dvander@228
   331
				num = 1;
dvander@228
   332
			}
dvander@152
   333
			break;
dvander@228
   334
		}
dvander@152
   335
	}
dvander@152
   336
ds@296
   337
	if ( (num && ((int)maxlength <= length)) || (!num && ((int)maxlength <= length + 3)) )
dvander@152
   338
	{
dvander@152
   339
		return -1;
dvander@152
   340
	}
dvander@152
   341
ds@296
   342
	if (i != length - 1)
dvander@152
   343
		num = atoi(&(iface[++i]));
dvander@152
   344
dvander@152
   345
	num++;
dvander@152
   346
dvander@152
   347
	snprintf(&(iface[i]), 4, "%03d", num);
dvander@152
   348
dvander@152
   349
	return num;
dvander@152
   350
}
dvander@152
   351
dvander@166
   352
void *CSmmAPI::InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret)
dvander@166
   353
{
dvander@253
   354
	char _if[256];	/* assume no interface goes beyond this */
dvander@166
   355
	size_t len = strlen(iface);
dvander@166
   356
	int num = 0;
dvander@166
   357
	void *pf = NULL;
dvander@166
   358
dvander@166
   359
	if (max > 999)
dvander@166
   360
		max = 999;
dvander@166
   361
dvander@253
   362
	if (len + 4 > sizeof(_if))
dvander@253
   363
	{
dvander@253
   364
		if (ret)
dvander@253
   365
		{
dvander@253
   366
			*ret = IFACE_FAILED;
dvander@253
   367
		}
dvander@253
   368
		return NULL;
dvander@253
   369
	}
dvander@253
   370
dvander@166
   371
	strcpy(_if, iface);
dvander@166
   372
dvander@166
   373
	do
dvander@166
   374
	{
dvander@174
   375
		if ( (pf = (fn)(_if, ret)) != NULL )
dvander@166
   376
			break;
dvander@166
   377
		if (num > max)
dvander@166
   378
			break;
ds@238
   379
	} while (( num = FormatIface(_if, len+1) ));
dvander@166
   380
dvander@166
   381
	return pf;
dvander@166
   382
}
dvander@166
   383
dvander@251
   384
void *CSmmAPI::VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min)
dvander@244
   385
{
dvander@244
   386
	char buffer[256];	/* assume no interface will go beyond this */
ds@296
   387
	size_t len = strlen(iface);
dvander@251
   388
	int ret;			/* just in case something doesn't handle NULL properly */
dvander@244
   389
ds@296
   390
	if (len > sizeof(buffer) - 4)
dvander@244
   391
	{
dvander@244
   392
		return NULL;
dvander@244
   393
	}
dvander@244
   394
dvander@244
   395
	strcpy(buffer, iface);
dvander@244
   396
dvander@251
   397
	if (min != -1)
dvander@244
   398
	{
ds@296
   399
		char *ptr = &buffer[len - 1];
dvander@244
   400
		int digits = 0;
dvander@244
   401
		while (isdigit(*ptr) && digits <=3)
dvander@244
   402
		{
dvander@244
   403
			*ptr = '\0';
dvander@244
   404
			digits++;
dvander@244
   405
			ptr--;
dvander@244
   406
		}
dvander@244
   407
		if (digits != 3)
dvander@244
   408
		{
dvander@244
   409
			/* for now, assume this is an error */
dvander@244
   410
			strcpy(buffer, iface);
dvander@251
   411
		} else {
dvander@251
   412
			char num[4];
dvander@251
   413
			min = (min == 0) ? 1 : min;
dvander@251
   414
			snprintf(num, sizeof(num), "%03d", min);
dvander@251
   415
			strcat(buffer, num);
dvander@244
   416
		}
dvander@244
   417
	}
dvander@244
   418
dvander@251
   419
	return InterfaceSearch(fn, buffer, IFACE_MAXNUM, &ret);
dvander@244
   420
}
dvander@244
   421
dvander@166
   422
const char *CSmmAPI::GetBaseDir()
dvander@166
   423
{
dvander@166
   424
	return g_ModPath.c_str();
dvander@166
   425
}
dvander@166
   426
dvander@166
   427
void CSmmAPI::PathFormat(char *buffer, size_t len, const char *fmt, ...)
dvander@166
   428
{
dvander@166
   429
	va_list ap;
ds@296
   430
	va_start(ap, fmt);
ds@296
   431
	size_t mylen = UTIL_FormatArgs(buffer, len, fmt, ap);
dvander@166
   432
	va_end(ap);
dvander@166
   433
ds@296
   434
	for (size_t i = 0; i < mylen; i++)
dvander@166
   435
	{
dvander@166
   436
		if (buffer[i] == ALT_SEP_CHAR)
ds@296
   437
		{
dvander@166
   438
			buffer[i] = PATH_SEP_CHAR;
ds@296
   439
		}
dvander@166
   440
	}
dvander@166
   441
}
dvander@166
   442
ds@192
   443
void CSmmAPI::ClientConPrintf(edict_t *client, const char *fmt, ...)
ds@192
   444
{
ds@192
   445
	va_list ap;
ds@296
   446
	static char buffer[4096];
ds@296
   447
ds@192
   448
	va_start(ap, fmt);
ds@296
   449
	UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap);
ds@192
   450
	va_end(ap);
ds@296
   451
ds@296
   452
	g_Engine.engine->ClientPrintf(client, buffer);
ds@192
   453
}
dvander@282
   454
dvander@282
   455
void CSmmAPI::LoadAsVSP()
dvander@282
   456
{
dvander@313
   457
	char path[260];
dvander@313
   458
	if (!GetFileOfAddress(CreateInterface, path, sizeof(path)))
dvander@282
   459
	{
dvander@313
   460
		/* Failed! */
dvander@282
   461
	}
dvander@313
   462
	char command[350];
dvander@313
   463
	g_VspListener.SetLoadable(true);
dvander@313
   464
	UTIL_Format(command, sizeof(command), "plugin_load \"%s\"\n", path);
dvander@313
   465
	g_Engine.engine->ServerCommand(command);
dvander@282
   466
}
dvander@282
   467
dvander@282
   468
void CSmmAPI::EnableVSPListener()
dvander@282
   469
{
dvander@282
   470
	/* If GameInit already passed and we're not already enabled or loaded, go ahead and LoadAsVSP load */
dvander@282
   471
	if (bGameInit && !m_VSP && !g_VspListener.IsLoaded())
dvander@282
   472
	{
dvander@282
   473
		LoadAsVSP();
dvander@282
   474
	}
dvander@282
   475
	m_VSP = true;
dvander@282
   476
}
dvander@282
   477
dvander@282
   478
int CSmmAPI::GetGameDLLVersion()
dvander@282
   479
{
dvander@282
   480
	return g_GameDllVersion;
dvander@282
   481
}
ds@287
   482
ds@287
   483
//////////////////////////////////////////////////////////////////////
ds@287
   484
// EVEN MORE HACKS HERE! YOU HAVE BEEN WARNED!                      //
ds@287
   485
// Signatures necessary in finding the pointer to the CUtlDict that //
ds@287
   486
//   stores user message information.                               //
ds@287
   487
// IServerGameDLL::GetUserMessageInfo() normally crashes with bad   //
ds@287
   488
//   message indices. This is our answer to it. Yuck! <:-(          //
ds@287
   489
//////////////////////////////////////////////////////////////////////
ds@287
   490
#ifdef OS_WIN32
ds@292
   491
	/* General Windows sig */
ds@291
   492
	#define MSGCLASS_SIGLEN		7
ds@291
   493
	#define MSGCLASS_SIG		"\x8B\x0D\x2A\x2A\x2A\x2A\x56"
ds@291
   494
	#define MSGCLASS_OFFS		2
ds@291
   495
ds@292
   496
	/* Dystopia Wimdows hack */
ds@291
   497
	#define MSGCLASS2_SIGLEN	16
ds@291
   498
	#define MSGCLASS2_SIG		"\x56\x8B\x74\x24\x2A\x85\xF6\x7C\x2A\x3B\x35\x2A\x2A\x2A\x2A\x7D"
ds@291
   499
	#define MSGCLASS2_OFFS		11
ds@287
   500
#elif defined OS_LINUX
ds@292
   501
	/* No frame pointer sig */
ds@291
   502
	#define MSGCLASS_SIGLEN		14
ds@291
   503
	#define MSGCLASS_SIG		"\x53\x83\xEC\x2A\x8B\x2A\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
ds@291
   504
	#define MSGCLASS_OFFS		9
ds@291
   505
ds@292
   506
	/* Frame pointer sig */
ds@291
   507
	#define MSGCLASS2_SIGLEN	16
ds@291
   508
	#define MSGCLASS2_SIG		"\x55\x89\xE5\x53\x83\xEC\x2A\x8B\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
ds@291
   509
	#define MSGCLASS2_OFFS		11
ds@287
   510
#endif
ds@287
   511
ds@287
   512
/* This is the ugliest function in all of SourceMM */
ds@291
   513
/* :TODO: Make this prettier */
ds@287
   514
bool CSmmAPI::CacheUserMessages()
ds@287
   515
{
ds@287
   516
	SourceHook::MemFuncInfo info = {true, -1, 0, 0};
ds@287
   517
	SourceHook::GetFuncInfo(&IServerGameDLL::GetUserMessageInfo, info);
ds@287
   518
ds@294
   519
	/* Get address of original GetUserMessageInfo() */
ds@287
   520
	char *vfunc = reinterpret_cast<char *>(g_GameDllPatch->GetOrigFunc(info.vtbloffs, info.vtblindex));
ds@287
   521
ds@294
   522
	/* If we can't get original function, that means there's no hook */
ds@287
   523
	if (vfunc == NULL)
ds@287
   524
	{
ds@294
   525
		/* Get virtual function address 'manually' then */
ds@287
   526
		char *adjustedptr = reinterpret_cast<char *>(g_GameDll.pGameDLL) + info.thisptroffs + info.vtbloffs;
ds@287
   527
		char **vtable = *reinterpret_cast<char ***>(adjustedptr);
ds@287
   528
ds@287
   529
		vfunc = vtable[info.vtblindex];
ds@287
   530
	}
ds@287
   531
ds@298
   532
	/* Oh dear, we have a relative jump on our hands
ds@298
   533
	 * PVK II on Windows made me do this, but I suppose it doesn't hurt to check this on Linux too...
ds@298
   534
	 */
ds@298
   535
	if (*vfunc == '\xE9')
ds@298
   536
	{
ds@298
   537
		/* Get address from displacement...
ds@298
   538
		 *
ds@298
   539
		 * Add 5 because it's relative to next instruction:
ds@298
   540
		 * Opcode <1 byte> + 32-bit displacement <4 bytes> 
ds@298
   541
		 */
ds@299
   542
		vfunc = vfunc + *reinterpret_cast<int *>(vfunc + 1) + 5;
ds@298
   543
	}
ds@298
   544
ds@291
   545
	UserMsgDict *dict = NULL;
ds@291
   546
ds@287
   547
	if (vcmp(vfunc, MSGCLASS_SIG, MSGCLASS_SIGLEN))
ds@287
   548
	{
ds@294
   549
		/* Get address of CUserMessages instance */
ds@287
   550
		char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS_OFFS);
ds@287
   551
ds@294
   552
		/* Get address of CUserMessages::m_UserMessages */
ds@291
   553
		dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
ds@291
   554
	} else if (vcmp(vfunc, MSGCLASS2_SIG, MSGCLASS2_SIGLEN)) {
ds@291
   555
	#ifdef OS_WIN32
ds@291
   556
		/* If we get here, the code is possibly inlined like in Dystopia */
ds@291
   557
ds@294
   558
		/* Get the address of the CUtlRBTree */
ds@291
   559
		char *rbtree = *reinterpret_cast<char **>(vfunc + MSGCLASS2_OFFS);
ds@287
   560
ds@294
   561
		/* CUtlDict should be 8 bytes before the CUtlRBTree (hacktacular!) */
ds@291
   562
		dict = reinterpret_cast<UserMsgDict *>(rbtree - 8);
ds@291
   563
	#elif defined OS_LINUX
ds@294
   564
		/* Get address of CUserMessages instance */
ds@291
   565
		char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS2_OFFS);
ds@291
   566
ds@294
   567
		/* Get address of CUserMessages::m_UserMessages */
ds@291
   568
		dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
ds@291
   569
	#endif
ds@291
   570
	}
ds@291
   571
ds@291
   572
	if (dict)
ds@291
   573
	{
ds@287
   574
		m_MsgCount = dict->Count();
ds@287
   575
ds@294
   576
		/* Ensure that count is within bounds of an unsigned byte, because that's what engine supports */
ds@288
   577
		if (m_MsgCount < 0 || m_MsgCount > 255)
ds@288
   578
		{
ds@288
   579
			m_MsgCount = -1;
ds@288
   580
			return false;
ds@288
   581
		}
ds@288
   582
ds@287
   583
		UserMessage *msg;
ds@291
   584
ds@294
   585
		/* Cache messages in our CUtlDict */
ds@287
   586
		for (int i = 0; i < m_MsgCount; i++)
ds@287
   587
		{
ds@287
   588
			msg = dict->Element(i);
ds@287
   589
			m_UserMessages.Insert(msg->name, msg);
ds@287
   590
		}
ds@287
   591
ds@287
   592
		return true;
ds@287
   593
	}
ds@287
   594
ds@287
   595
	return false;
ds@287
   596
}
ds@287
   597
ds@287
   598
bool CSmmAPI::MsgCacheSuccessful()
ds@287
   599
{
ds@287
   600
	return m_MsgCount > -1;
ds@287
   601
}
ds@287
   602
ds@287
   603
int CSmmAPI::GetUserMessageCount()
ds@287
   604
{
ds@287
   605
	return m_MsgCount;
ds@287
   606
}
ds@287
   607
ds@287
   608
int CSmmAPI::FindUserMessage(const char *name, int *size)
ds@287
   609
{
ds@287
   610
	int index = m_UserMessages.Find(name);
ds@287
   611
ds@287
   612
	if (size && index > -1)
ds@287
   613
	{
ds@287
   614
		UserMessage *msg = m_UserMessages.Element(index);
ds@287
   615
		*size = msg->size;
ds@287
   616
	}
ds@287
   617
ds@287
   618
	return index;
ds@287
   619
}
ds@287
   620
ds@287
   621
const char *CSmmAPI::GetUserMessage(int index, int *size)
ds@287
   622
{
ds@287
   623
	if (m_MsgCount <= 0 || index < 0 || index >= m_MsgCount)
ds@287
   624
	{
ds@287
   625
		return NULL;
ds@287
   626
	}
ds@287
   627
ds@287
   628
	UserMessage *msg = m_UserMessages.Element(index);
ds@287
   629
ds@287
   630
	if (size)
ds@287
   631
	{
ds@287
   632
		*size = msg->size;
ds@287
   633
	}
ds@287
   634
ds@287
   635
	return msg->name;
ds@287
   636
}