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