core-legacy/CSmmAPI.cpp
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 683 b507295429f9
child 714 966f819588a2
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

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