core-legacy/CSmmAPI.cpp
author Scott Ehlert <ds@alliedmods.net>
Tue Nov 24 07:33:52 2009 -0600 (2009-11-24)
changeset 685 522727461c0d
parent 683 b507295429f9
child 689 4065ba5e9155
permissions -rw-r--r--
Fixed crashes in code generated by SourceHook's HookManGen on Mac OS X (bug 3514, r=dvander).

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