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