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