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