sourcemm/episode2/provider_ep2.cpp
author David Anderson <dvander@alliedmods.net>
Fri Jul 04 02:34:45 2008 +0000 (2008-07-04)
changeset 524 131160b48219
parent 523 6f1630519b81
child 534 eb2d7d18441c
permissions -rw-r--r--
fixed compatibility with future engine versions
dvander@371
     1
dvander@371
     2
/**
dvander@371
     3
 * vim: set ts=4 :
dvander@371
     4
 * ======================================================
dvander@371
     5
 * Metamod:Source
ds@523
     6
 * Copyright (C) 2004-2008 AlliedModders LLC and authors.
dvander@371
     7
 * All rights reserved.
dvander@371
     8
 * ======================================================
dvander@371
     9
 *
dvander@371
    10
 * This software is provided 'as-is', without any express or implied warranty.
dvander@371
    11
 * In no event will the authors be held liable for any damages arising from 
dvander@371
    12
 * the use of this software.
dvander@371
    13
 * 
dvander@371
    14
 * Permission is granted to anyone to use this software for any purpose, 
dvander@371
    15
 * including commercial applications, and to alter it and redistribute it 
dvander@371
    16
 * freely, subject to the following restrictions:
dvander@371
    17
 *
dvander@371
    18
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@371
    19
 * claim that you wrote the original software. If you use this software in a 
dvander@371
    20
 * product, an acknowledgment in the product documentation would be 
dvander@371
    21
 * appreciated but is not required.
dvander@371
    22
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@371
    23
 * misrepresented as being the original software.
dvander@371
    24
 * 3. This notice may not be removed or altered from any source distribution.
dvander@371
    25
 *
dvander@371
    26
 * Version: $Id$
dvander@371
    27
 */
dvander@371
    28
dvander@481
    29
#include "../metamod_oslink.h"
dvander@371
    30
#include <sourcehook.h>
dvander@371
    31
#include <convar.h>
dvander@371
    32
#include <eiface.h>
dvander@371
    33
#include <tier0/icommandline.h>
dvander@371
    34
#include <tier1/utldict.h>
dvander@371
    35
#include <sh_vector.h>
dvander@371
    36
#include <sh_string.h>
dvander@371
    37
#include "../metamod_util.h"
dvander@371
    38
#include "provider_ep2.h"
dvander@371
    39
#include "console.h"
dvander@371
    40
#include "metamod_console.h"
dvander@371
    41
#include "vsp_listener.h"
dvander@485
    42
#include <filesystem.h>
dvander@371
    43
dvander@371
    44
/* Types */
dvander@371
    45
typedef void (*CONPRINTF_FUNC)(const char *, ...);
dvander@371
    46
struct UsrMsgInfo
dvander@371
    47
{
dvander@517
    48
	UsrMsgInfo()
dvander@517
    49
	{
dvander@517
    50
	}
dvander@517
    51
	UsrMsgInfo(int s, const char *t) : size(s), name(t)
dvander@517
    52
	{
dvander@517
    53
	}
dvander@371
    54
	int size;
dvander@371
    55
	String name;
dvander@371
    56
};
dvander@371
    57
/* Imports */
dvander@371
    58
#undef CommandLine
dvander@371
    59
DLL_IMPORT ICommandLine *CommandLine();
dvander@371
    60
/* Functions */
dvander@371
    61
bool CacheUserMessages();
dvander@371
    62
void ClientCommand(edict_t *pEdict, const CCommand &args);
dvander@371
    63
void LocalCommand_Meta(const CCommand &args);
dvander@371
    64
void _ServerCommand();
dvander@371
    65
/* Variables */
dvander@371
    66
bool usermsgs_extracted = false;
dvander@371
    67
CVector<UsrMsgInfo> usermsgs_list;
dvander@371
    68
ICvar *icvar = NULL;
dvander@371
    69
ISmmAPI *metamod_api = NULL;
dvander@371
    70
IVEngineServer *engine = NULL;
dvander@371
    71
IServerGameClients *gameclients = NULL;
dvander@371
    72
VSPListener g_VspListener;
dvander@371
    73
BaseProvider g_Ep1Provider;
dvander@371
    74
IMetamodSourceProvider *provider = &g_Ep1Provider;
dvander@371
    75
List<ConCommandBase *> conbases_unreg;
dvander@485
    76
IFileSystem *baseFs = NULL;
dvander@371
    77
ConCommand meta_local_cmd("meta", LocalCommand_Meta, "Metamod:Source control options");
dvander@371
    78
dvander@371
    79
SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &);
dvander@371
    80
dvander@517
    81
bool AssumeUserMessages()
dvander@517
    82
{
dvander@517
    83
	int q, size;
dvander@517
    84
	char buffer[256];
dvander@517
    85
dvander@517
    86
	q = 0;
dvander@517
    87
dvander@517
    88
	while (server->GetUserMessageInfo(q, buffer, sizeof(buffer), size))
dvander@517
    89
	{
dvander@517
    90
		usermsgs_list.push_back(UsrMsgInfo(size, buffer));
dvander@517
    91
		q++;
dvander@517
    92
	}
dvander@517
    93
dvander@517
    94
	return true;
dvander@517
    95
}
dvander@517
    96
dvander@371
    97
void BaseProvider::ConsolePrint(const char *str)
dvander@371
    98
{
dvander@371
    99
	ConMsg("%s", str);
dvander@371
   100
}
dvander@371
   101
dvander@481
   102
void BaseProvider::Notify_DLLInit_Pre(CreateInterfaceFn engineFactory, 
dvander@371
   103
									  CreateInterfaceFn serverFactory)
dvander@371
   104
{
dvander@371
   105
	engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
dvander@371
   106
	if (!engine)
dvander@371
   107
	{
dvander@371
   108
		DisplayError("Could not find IVEngineServer! Metamod cannot load.");
dvander@371
   109
		return;
dvander@371
   110
	}
dvander@371
   111
	icvar = (ICvar *)((engineFactory)(CVAR_INTERFACE_VERSION, NULL));
dvander@371
   112
	if (!icvar)
dvander@371
   113
	{
dvander@371
   114
		DisplayError("Could not find ICvar! Metamod cannot load.");
dvander@371
   115
		return;
dvander@371
   116
	}
dvander@472
   117
	g_pCVar = icvar;
dvander@371
   118
dvander@371
   119
	if ((gameclients = (IServerGameClients *)(serverFactory("ServerGameClients003", NULL)))
dvander@371
   120
		== NULL)
dvander@371
   121
	{
dvander@371
   122
		gameclients = (IServerGameClients *)(serverFactory("ServerGameClients004", NULL));
dvander@371
   123
	}
dvander@371
   124
dvander@485
   125
	baseFs = (IFileSystem *)((engineFactory)(FILESYSTEM_INTERFACE_VERSION, NULL));
dvander@485
   126
	if (baseFs == NULL)
dvander@485
   127
	{
dvander@485
   128
		::LogMessage("Unable to find \"%s\": .vdf files will not be parsed", FILESYSTEM_INTERFACE_VERSION);
dvander@485
   129
		return;
dvander@485
   130
	}
dvander@485
   131
dvander@371
   132
	RegisterConCommandBase(&meta_local_cmd);
dvander@371
   133
	conbases_unreg.push_back(&meta_local_cmd);
dvander@371
   134
dvander@517
   135
	if ((usermsgs_extracted = CacheUserMessages()) == false)
dvander@517
   136
	{
dvander@517
   137
		usermsgs_extracted = AssumeUserMessages();
dvander@517
   138
	}
dvander@371
   139
dvander@371
   140
	if (gameclients)
dvander@371
   141
	{
dvander@371
   142
		SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, gameclients, ClientCommand, false);
dvander@371
   143
	}
dvander@371
   144
}
dvander@371
   145
dvander@371
   146
void BaseProvider::Notify_DLLShutdown_Pre()
dvander@371
   147
{
dvander@371
   148
	List<ConCommandBase *>::iterator iter;
dvander@371
   149
dvander@371
   150
	for (iter = conbases_unreg.begin();
dvander@371
   151
		 iter != conbases_unreg.end();
dvander@371
   152
		 iter++)
dvander@371
   153
	{
dvander@371
   154
		UnregisterConCommandBase((*iter));
dvander@371
   155
	}
dvander@371
   156
}
dvander@371
   157
dvander@371
   158
bool BaseProvider::IsRemotePrintingAvailable()
dvander@371
   159
{
dvander@371
   160
	return true;
dvander@371
   161
}
dvander@371
   162
dvander@371
   163
void BaseProvider::ClientConsolePrint(edict_t *client, const char *message)
dvander@371
   164
{
dvander@371
   165
	engine->ClientPrintf(client, message);
dvander@371
   166
}
dvander@371
   167
dvander@371
   168
void BaseProvider::ServerCommand(const char *cmd)
dvander@371
   169
{
dvander@371
   170
	engine->ServerCommand(cmd);
dvander@371
   171
}
dvander@371
   172
dvander@371
   173
const char *BaseProvider::GetConVarString(ConVar *convar)
dvander@371
   174
{
dvander@371
   175
	if (convar == NULL)
dvander@371
   176
	{
dvander@371
   177
		return NULL;
dvander@371
   178
	}
dvander@371
   179
dvander@371
   180
	return convar->GetString();
dvander@371
   181
}
dvander@371
   182
dvander@485
   183
void BaseProvider::SetConVarString(ConVar *convar, const char *str)
dvander@485
   184
{
dvander@485
   185
	convar->SetValue(str);
dvander@485
   186
}
dvander@485
   187
dvander@371
   188
bool BaseProvider::IsConCommandBaseACommand(ConCommandBase *pCommand)
dvander@371
   189
{
dvander@371
   190
	return pCommand->IsCommand();
dvander@371
   191
}
dvander@371
   192
dvander@371
   193
dvander@371
   194
bool BaseProvider::IsSourceEngineBuildCompatible(int build)
dvander@371
   195
{
dvander@371
   196
	return (build == SOURCE_ENGINE_ORIGINAL
dvander@371
   197
			|| build == SOURCE_ENGINE_EPISODEONE);
dvander@371
   198
}
dvander@371
   199
dvander@371
   200
const char *BaseProvider::GetCommandLineValue(const char *key, const char *defval)
dvander@371
   201
{
dvander@371
   202
	if (key[0] == '-' || key[0] == '+')
dvander@371
   203
	{
dvander@371
   204
		return CommandLine_Tier0()->ParmValue(key, defval);
dvander@371
   205
	}
dvander@371
   206
	else if (icvar)
dvander@371
   207
	{
dvander@371
   208
		const char *val;
dvander@371
   209
		if ((val = icvar->GetCommandLineValue(key)) == NULL)
dvander@371
   210
		{
dvander@371
   211
			return defval;
dvander@371
   212
		}
dvander@371
   213
dvander@371
   214
		return val;
dvander@371
   215
	}
dvander@371
   216
dvander@371
   217
	return NULL;
dvander@371
   218
}
dvander@371
   219
dvander@371
   220
int BaseProvider::TryServerGameDLL(const char *iface)
dvander@371
   221
{
dvander@371
   222
	if (strncmp(iface, "ServerGameDLL", 13) != 0)
dvander@371
   223
	{
dvander@371
   224
		return 0;
dvander@371
   225
	}
dvander@371
   226
dvander@371
   227
	return atoi(&iface[13]);
dvander@371
   228
}
dvander@371
   229
dvander@371
   230
bool BaseProvider::LogMessage(const char *buffer)
dvander@371
   231
{
dvander@371
   232
	if (!engine)
dvander@371
   233
	{
dvander@371
   234
		return false;
dvander@371
   235
	}
dvander@371
   236
dvander@371
   237
	engine->LogPrint(buffer);
dvander@371
   238
dvander@371
   239
	return true;
dvander@371
   240
}
dvander@371
   241
dvander@371
   242
bool BaseProvider::GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo)
dvander@371
   243
{
dvander@371
   244
	SourceHook::MemFuncInfo mfi = {true, -1, 0, 0};
dvander@371
   245
dvander@371
   246
	if (hook == ProvidedHook_LevelInit)
dvander@371
   247
	{
dvander@371
   248
		SourceHook::GetFuncInfo(&IServerGameDLL::LevelInit, mfi);
dvander@371
   249
	}
dvander@371
   250
	else if (hook == ProvidedHook_LevelShutdown)
dvander@371
   251
	{
dvander@371
   252
		SourceHook::GetFuncInfo(&IServerGameDLL::LevelShutdown, mfi);
dvander@371
   253
	}
dvander@371
   254
	else if (hook == ProvidedHook_GameInit)
dvander@371
   255
	{
dvander@371
   256
		SourceHook::GetFuncInfo(&IServerGameDLL::GameInit, mfi);
dvander@371
   257
	}
dvander@371
   258
	else if (hook == ProvidedHook_DLLShutdown)
dvander@371
   259
	{
dvander@371
   260
		SourceHook::GetFuncInfo(&IServerGameDLL::DLLShutdown, mfi);
dvander@371
   261
	}
dvander@371
   262
	else if (hook == ProvidedHook_DLLInit)
dvander@371
   263
	{
dvander@371
   264
		SourceHook::GetFuncInfo(&IServerGameDLL::DLLInit, mfi);
dvander@371
   265
	}
dvander@371
   266
dvander@371
   267
	*pInfo = mfi;
dvander@371
   268
dvander@371
   269
	return (mfi.thisptroffs >= 0);
dvander@371
   270
}
dvander@371
   271
dvander@371
   272
void BaseProvider::DisplayError(const char *fmt, ...)
dvander@371
   273
{
dvander@371
   274
	va_list ap;
dvander@371
   275
	char buffer[2048];
dvander@371
   276
dvander@371
   277
	va_start(ap, fmt);
dvander@371
   278
	UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap);
dvander@371
   279
	va_end(ap);
dvander@371
   280
dvander@371
   281
	Error(buffer);
dvander@371
   282
}
dvander@371
   283
dvander@371
   284
void BaseProvider::DisplayWarning(const char *fmt, ...)
dvander@371
   285
{
dvander@371
   286
	va_list ap;
dvander@371
   287
	char buffer[2048];
dvander@371
   288
dvander@371
   289
	va_start(ap, fmt);
dvander@371
   290
	UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap);
dvander@371
   291
	va_end(ap);
dvander@371
   292
dvander@371
   293
	Warning(buffer);
dvander@371
   294
}
dvander@371
   295
dvander@371
   296
IConCommandBaseAccessor *BaseProvider::GetConCommandBaseAccessor()
dvander@371
   297
{
dvander@371
   298
	return &g_SMConVarAccessor;
dvander@371
   299
}
dvander@371
   300
dvander@371
   301
bool BaseProvider::RegisterConCommandBase(ConCommandBase *pCommand)
dvander@371
   302
{
dvander@371
   303
	return g_SMConVarAccessor.Register(pCommand);
dvander@371
   304
}
dvander@371
   305
dvander@371
   306
void BaseProvider::UnregisterConCommandBase(ConCommandBase *pCommand)
dvander@371
   307
{
dvander@371
   308
	return g_SMConVarAccessor.Unregister(pCommand);
dvander@371
   309
}
dvander@371
   310
dvander@371
   311
int BaseProvider::GetUserMessageCount()
dvander@371
   312
{
dvander@371
   313
	if (!usermsgs_extracted)
dvander@371
   314
	{
dvander@371
   315
		return -1;
dvander@371
   316
	}
dvander@371
   317
dvander@371
   318
	return (int)usermsgs_list.size();
dvander@371
   319
}
dvander@371
   320
dvander@371
   321
int BaseProvider::FindUserMessage(const char *name, int *size)
dvander@371
   322
{
dvander@371
   323
	for (size_t i = 0; i < usermsgs_list.size(); i++)
dvander@371
   324
	{
dvander@371
   325
		if (usermsgs_list[i].name.compare(name) == 0)
dvander@371
   326
		{
dvander@371
   327
			if (size)
dvander@371
   328
			{
dvander@371
   329
				*size = usermsgs_list[i].size;
dvander@371
   330
			}
dvander@371
   331
			return (int)i;
dvander@371
   332
		}
dvander@371
   333
	}
dvander@371
   334
	
dvander@371
   335
	return -1;
dvander@371
   336
}
dvander@371
   337
dvander@371
   338
const char *BaseProvider::GetUserMessage(int index, int *size)
dvander@371
   339
{
dvander@371
   340
	if (!usermsgs_extracted || index < 0 || index >= (int)usermsgs_list.size())
dvander@371
   341
	{
dvander@371
   342
		return NULL;
dvander@371
   343
	}
dvander@371
   344
dvander@371
   345
	if (size)
dvander@371
   346
	{
dvander@371
   347
		*size = usermsgs_list[index].size;
dvander@371
   348
	}
dvander@371
   349
dvander@371
   350
	return usermsgs_list[index].name.c_str();
dvander@371
   351
}
dvander@371
   352
dvander@371
   353
const char *BaseProvider::GetGameDescription()
dvander@371
   354
{
dvander@371
   355
	return server->GetGameDescription();
dvander@371
   356
}
dvander@371
   357
dvander@408
   358
int BaseProvider::DetermineSourceEngine(const char *game)
dvander@408
   359
{
dvander@408
   360
	return SOURCE_ENGINE_ORANGEBOX;
dvander@408
   361
}
dvander@408
   362
dvander@371
   363
ConVar *BaseProvider::CreateConVar(const char *name,
dvander@371
   364
								   const char *defval,
dvander@371
   365
								   const char *help,
dvander@371
   366
								   int flags)
dvander@371
   367
{
dvander@371
   368
	int newflags = 0;
dvander@371
   369
	if (flags & ConVarFlag_Notify)
dvander@371
   370
	{
dvander@371
   371
		newflags |= FCVAR_NOTIFY;
dvander@371
   372
	}
dvander@371
   373
	if (flags & ConVarFlag_SpOnly)
dvander@371
   374
	{
dvander@371
   375
		newflags |= FCVAR_SPONLY;
dvander@371
   376
	}
dvander@371
   377
dvander@371
   378
	ConVar *pVar = new ConVar(name, defval, newflags, help);
dvander@371
   379
dvander@371
   380
	RegisterConCommandBase(pVar);
dvander@371
   381
	conbases_unreg.push_back(pVar);
dvander@371
   382
dvander@371
   383
	return pVar;
dvander@371
   384
}
dvander@371
   385
dvander@524
   386
IServerPluginCallbacks *BaseProvider::GetVSPCallbacks(int version)
dvander@371
   387
{
dvander@524
   388
	if (version > 2)
dvander@524
   389
	{
dvander@524
   390
		return NULL;
dvander@524
   391
	}
dvander@524
   392
dvander@371
   393
	g_VspListener.SetLoadable(true);
dvander@371
   394
	return &g_VspListener;
dvander@371
   395
}
dvander@371
   396
dvander@481
   397
bool BaseProvider::IsAlternatelyLoaded()
dvander@481
   398
{
dvander@481
   399
	return g_VspListener.IsRootLoadMethod();
dvander@481
   400
}
dvander@481
   401
dvander@485
   402
bool BaseProvider::ProcessVDF(const char *file, char path[], size_t path_len, char alias[], size_t alias_len)
dvander@485
   403
{
dvander@485
   404
	if (baseFs == NULL)
dvander@485
   405
	{
dvander@485
   406
		return false;
dvander@485
   407
	}
dvander@485
   408
dvander@485
   409
	KeyValues *pValues;
dvander@485
   410
	const char *plugin_file, *p_alias;
dvander@485
   411
dvander@485
   412
	pValues = new KeyValues("Metamod Plugin");
dvander@485
   413
dvander@485
   414
	if (!pValues->LoadFromFile(baseFs, file))
dvander@485
   415
	{
dvander@485
   416
		pValues->deleteThis();
dvander@485
   417
		return false;
dvander@485
   418
	}
dvander@485
   419
dvander@485
   420
	if ((plugin_file = pValues->GetString("file", NULL)) == NULL)
dvander@485
   421
	{
dvander@485
   422
		pValues->deleteThis();
dvander@485
   423
		return false;
dvander@485
   424
	}
dvander@485
   425
dvander@485
   426
	if ((p_alias = pValues->GetString("alias", NULL)) != NULL)
dvander@485
   427
	{
dvander@485
   428
		UTIL_Format(alias, alias_len, "%s", p_alias);
dvander@485
   429
	}
dvander@485
   430
	else
dvander@485
   431
	{
dvander@485
   432
		UTIL_Format(alias, alias_len, "");
dvander@485
   433
	}
dvander@485
   434
dvander@485
   435
	/* Attempt to find a file extension */
dvander@485
   436
	if (UTIL_GetExtension(plugin_file) == NULL)
dvander@485
   437
	{
dvander@485
   438
		g_pMetamod->PathFormat(path, 
dvander@485
   439
			path_len, 
dvander@485
   440
			"%s/%s%s", 
dvander@485
   441
			g_pMetamod->GetBaseDir(), 
dvander@485
   442
			plugin_file, 
dvander@485
   443
#if defined WIN32 || defined _WIN32
dvander@485
   444
			".dll"
dvander@485
   445
#else
dvander@485
   446
			"_i486.so"
dvander@485
   447
#endif
dvander@485
   448
			);
dvander@485
   449
	}
dvander@485
   450
	else
dvander@485
   451
	{
dvander@485
   452
		g_pMetamod->PathFormat(path,
dvander@485
   453
			path_len,
dvander@485
   454
			"%s/%s", 
dvander@485
   455
			g_pMetamod->GetBaseDir(),
dvander@485
   456
			plugin_file);
dvander@485
   457
	}
dvander@485
   458
dvander@485
   459
	pValues->deleteThis();
dvander@485
   460
dvander@485
   461
	return true;
dvander@485
   462
}
dvander@485
   463
dvander@371
   464
class GlobCommand : public IMetamodSourceCommandInfo
dvander@371
   465
{
dvander@371
   466
public:
dvander@371
   467
	GlobCommand(const CCommand *cmd) : m_cmd(cmd)
dvander@371
   468
	{
dvander@371
   469
	}
dvander@371
   470
public:
dvander@371
   471
	unsigned int GetArgCount()
dvander@371
   472
	{
dvander@482
   473
		return m_cmd->ArgC() - 1;
dvander@371
   474
	}
dvander@371
   475
dvander@371
   476
	const char *GetArg(unsigned int num)
dvander@371
   477
	{
dvander@371
   478
		return m_cmd->Arg(num);
dvander@371
   479
	}
dvander@371
   480
dvander@371
   481
	const char *GetArgString()
dvander@371
   482
	{
dvander@371
   483
		return m_cmd->ArgS();
dvander@371
   484
	}
dvander@371
   485
private:
dvander@371
   486
	const CCommand *m_cmd;
dvander@371
   487
};
dvander@371
   488
dvander@371
   489
void LocalCommand_Meta(const CCommand &args)
dvander@371
   490
{
dvander@371
   491
	GlobCommand cmd(&args);
dvander@371
   492
	Command_Meta(&cmd);
dvander@371
   493
}
dvander@371
   494
dvander@371
   495
void ClientCommand(edict_t *pEdict, const CCommand &_cmd)
dvander@371
   496
{
dvander@371
   497
	GlobCommand cmd(&_cmd);
dvander@371
   498
dvander@371
   499
	if (strcmp(cmd.GetArg(0), "meta") == 0)
dvander@371
   500
	{
dvander@371
   501
		Command_ClientMeta(pEdict, &cmd);
dvander@484
   502
		RETURN_META(MRES_SUPERCEDE);
dvander@371
   503
	}
dvander@482
   504
dvander@484
   505
	RETURN_META(MRES_IGNORED);
dvander@371
   506
}
dvander@371
   507
dvander@371
   508
bool vcmp(const void *_addr1, const void *_addr2, size_t len)
dvander@371
   509
{
dvander@371
   510
	unsigned char *addr1 = (unsigned char *)_addr1;
dvander@371
   511
	unsigned char *addr2 = (unsigned char *)_addr2;
dvander@371
   512
dvander@371
   513
	for (size_t i=0; i<len; i++)
dvander@371
   514
	{
dvander@371
   515
		if (addr2[i] == '*')
dvander@371
   516
		{
dvander@371
   517
			continue;
dvander@371
   518
		}
dvander@371
   519
		if (addr1[i] != addr2[i])
dvander@371
   520
		{
dvander@371
   521
			return false;
dvander@371
   522
		}
dvander@371
   523
	}
dvander@371
   524
dvander@371
   525
	return true;
dvander@371
   526
}
dvander@371
   527
dvander@371
   528
//////////////////////////////////////////////////////////////////////
dvander@371
   529
// EVEN MORE HACKS HERE! YOU HAVE BEEN WARNED!                      //
dvander@371
   530
// Signatures necessary in finding the pointer to the CUtlDict that //
dvander@371
   531
//   stores user message information.                               //
dvander@371
   532
// IServerGameDLL::GetUserMessageInfo() normally crashes with bad   //
dvander@371
   533
//   message indices. This is our answer to it. Yuck! <:-(          //
dvander@371
   534
//////////////////////////////////////////////////////////////////////
dvander@371
   535
#ifdef OS_WIN32
dvander@371
   536
	/* General Windows sig */
dvander@371
   537
	#define MSGCLASS_SIGLEN		7
dvander@371
   538
	#define MSGCLASS_SIG		"\x8B\x0D\x2A\x2A\x2A\x2A\x56"
dvander@371
   539
	#define MSGCLASS_OFFS		2
dvander@371
   540
dvander@371
   541
	/* Dystopia Wimdows hack */
dvander@371
   542
	#define MSGCLASS2_SIGLEN	16
dvander@371
   543
	#define MSGCLASS2_SIG		"\x56\x8B\x74\x24\x2A\x85\xF6\x7C\x2A\x3B\x35\x2A\x2A\x2A\x2A\x7D"
dvander@371
   544
	#define MSGCLASS2_OFFS		11
dvander@371
   545
dvander@371
   546
	/* Windows frame pointer sig */
dvander@371
   547
	#define MSGCLASS3_SIGLEN	18
dvander@371
   548
	#define MSGCLASS3_SIG		"\x55\x8B\xEC\x51\x89\x2A\x2A\x8B\x2A\x2A\x50\x8B\x0D\x2A\x2A\x2A\x2A\xE8"
dvander@371
   549
	#define MSGCLASS3_OFFS		13
dvander@371
   550
#elif defined OS_LINUX
dvander@371
   551
	/* No frame pointer sig */
dvander@371
   552
	#define MSGCLASS_SIGLEN		14
dvander@371
   553
	#define MSGCLASS_SIG		"\x53\x83\xEC\x2A\x8B\x2A\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
dvander@371
   554
	#define MSGCLASS_OFFS		9
dvander@371
   555
dvander@371
   556
	/* Frame pointer sig */
dvander@371
   557
	#define MSGCLASS2_SIGLEN	16
dvander@371
   558
	#define MSGCLASS2_SIG		"\x55\x89\xE5\x53\x83\xEC\x2A\x8B\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
dvander@371
   559
	#define MSGCLASS2_OFFS		11
dvander@371
   560
#endif
dvander@371
   561
dvander@371
   562
struct UserMessage
dvander@371
   563
{
dvander@371
   564
	int size;
dvander@371
   565
	const char *name;
dvander@371
   566
};
dvander@371
   567
dvander@371
   568
typedef CUtlDict<UserMessage *, int> UserMsgDict;
dvander@371
   569
dvander@371
   570
/* This is the ugliest function in all of SourceMM */
dvander@371
   571
bool CacheUserMessages()
dvander@371
   572
{
dvander@371
   573
	/* Get address of original GetUserMessageInfo() */
dvander@371
   574
	char *vfunc = (char *)SH_GET_ORIG_VFNPTR_ENTRY(server, &IServerGameDLL::GetUserMessageInfo);
dvander@371
   575
dvander@371
   576
	/* Oh dear, we have a relative jump on our hands
dvander@371
   577
	 * PVK II on Windows made me do this, but I suppose it doesn't hurt to check this on Linux too...
dvander@371
   578
	 */
dvander@371
   579
	if (*vfunc == '\xE9')
dvander@371
   580
	{
dvander@371
   581
		/* Get address from displacement...
dvander@371
   582
		 *
dvander@371
   583
		 * Add 5 because it's relative to next instruction:
dvander@371
   584
		 * Opcode <1 byte> + 32-bit displacement <4 bytes> 
dvander@371
   585
		 */
dvander@371
   586
		vfunc += *reinterpret_cast<int *>(vfunc + 1) + 5;
dvander@371
   587
	}
dvander@371
   588
dvander@371
   589
	CUtlDict<UserMessage *, int> *dict = NULL;
dvander@371
   590
dvander@371
   591
	if (vcmp(vfunc, MSGCLASS_SIG, MSGCLASS_SIGLEN))
dvander@371
   592
	{
dvander@371
   593
		/* Get address of CUserMessages instance */
dvander@371
   594
		char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS_OFFS);
dvander@371
   595
dvander@371
   596
		/* Get address of CUserMessages::m_UserMessages */
dvander@371
   597
		dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
dvander@371
   598
	} 
dvander@371
   599
	else if (vcmp(vfunc, MSGCLASS2_SIG, MSGCLASS2_SIGLEN)) 
dvander@371
   600
	{
dvander@371
   601
	#ifdef OS_WIN32
dvander@371
   602
		/* If we get here, the code is possibly inlined like in Dystopia */
dvander@371
   603
dvander@371
   604
		/* Get the address of the CUtlRBTree */
dvander@371
   605
		char *rbtree = *reinterpret_cast<char **>(vfunc + MSGCLASS2_OFFS);
dvander@371
   606
dvander@371
   607
		/* CUtlDict should be 8 bytes before the CUtlRBTree (hacktacular!) */
dvander@371
   608
		dict = reinterpret_cast<UserMsgDict *>(rbtree - 8);
dvander@371
   609
	#elif defined OS_LINUX
dvander@371
   610
		/* Get address of CUserMessages instance */
dvander@371
   611
		char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS2_OFFS);
dvander@371
   612
dvander@371
   613
		/* Get address of CUserMessages::m_UserMessages */
dvander@371
   614
		dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
dvander@371
   615
	#endif
dvander@371
   616
	#ifdef OS_WIN32
dvander@371
   617
	} 
dvander@371
   618
	else if (vcmp(vfunc, MSGCLASS3_SIG, MSGCLASS3_SIGLEN)) 
dvander@371
   619
	{
dvander@371
   620
		/* Get address of CUserMessages instance */
dvander@371
   621
		char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS3_OFFS);
dvander@371
   622
dvander@371
   623
		/* Get address of CUserMessages::m_UserMessages */
dvander@371
   624
		dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
dvander@371
   625
	#endif
dvander@371
   626
	}
dvander@371
   627
dvander@402
   628
	#if !defined OS_WIN32
dvander@402
   629
	if (dict == NULL)
dvander@402
   630
	{
dvander@402
   631
		char path[255];
dvander@402
   632
		if (GetFileOfAddress(vfunc, path, sizeof(path)))
dvander@402
   633
		{
dvander@402
   634
			void *handle = dlopen(path, RTLD_NOW);
dvander@402
   635
			if (handle != NULL)
dvander@402
   636
			{
dvander@402
   637
				void *addr = dlsym(handle, "usermessages");
dvander@517
   638
				if (addr == NULL)
dvander@517
   639
				{
dvander@517
   640
					return false;
dvander@517
   641
				}
dvander@402
   642
				dict = (UserMsgDict *)*(void **)addr;
dvander@402
   643
				dlclose(handle);
dvander@402
   644
			}
dvander@402
   645
		}
dvander@402
   646
	}
dvander@402
   647
	#endif
dvander@402
   648
dvander@402
   649
	if (dict != NULL)
dvander@371
   650
	{
dvander@371
   651
		int msg_count = dict->Count();
dvander@371
   652
dvander@371
   653
		/* Ensure that count is within bounds of an unsigned byte, because that's what engine supports */
dvander@371
   654
		if (msg_count < 0 || msg_count > 255)
dvander@371
   655
		{
dvander@371
   656
			return false;
dvander@371
   657
		}
dvander@371
   658
dvander@371
   659
		UserMessage *msg;
dvander@371
   660
		UsrMsgInfo u_msg;
dvander@371
   661
dvander@371
   662
		/* Cache messages in our CUtlDict */
dvander@371
   663
		for (int i = 0; i < msg_count; i++)
dvander@371
   664
		{
dvander@371
   665
			msg = dict->Element(i);
dvander@371
   666
			u_msg.name = msg->name;
dvander@371
   667
			u_msg.size = msg->size;
dvander@371
   668
			usermsgs_list.push_back(u_msg);
dvander@371
   669
		}
dvander@371
   670
dvander@371
   671
		return true;
dvander@371
   672
	}
dvander@371
   673
dvander@371
   674
	return false;
dvander@371
   675
}
dvander@371
   676