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