sourcemm/sourcemm.cpp
author David Anderson <dvander@alliedmods.net>
Sat Apr 16 23:33:39 2005 +0000 (2005-04-16)
changeset 9 01b8b7435e67
parent 7 8ef11f6189e4
child 12 9fd53562f68c
permissions -rw-r--r--
Implemented factory hooks
Added commands: clear, load, pause, unload, unpause
Rewrote headers
dvander@7
     1
/* ======== SourceMM ========
dvander@9
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* Contributor(s): Scott "Damaged Soul" Ehlert
dvander@7
     9
*				: Pavol "PM OnoTo" Marko
dvander@7
    10
* ============================
dvander@7
    11
*/
dvander@7
    12
dvander@7
    13
#include "sourcemm.h"
dvander@7
    14
#include "CServerGameDLL.h"
dvander@7
    15
#include "CServerGameEnts.h"
dvander@7
    16
#include "CServerGameClients.h"
dvander@7
    17
#include "CHLTVDirector.h"
dvander@7
    18
#include "concommands.h"
dvander@9
    19
#include "CSmmAPI.h"
dvander@9
    20
#include "util.h"
dvander@7
    21
dvander@7
    22
/**
dvander@7
    23
 * @brief Implementation of main SourceMM GameDLL functionality
dvander@7
    24
 * @file sourcemm.cpp
dvander@7
    25
 */
dvander@7
    26
dvander@7
    27
CServerGameDLL *g_TempGameDLL = NULL;
dvander@7
    28
CServerGameEnts *g_TempGameEnts = NULL;
dvander@7
    29
CServerGameClients *g_TempGameClients = NULL;
dvander@7
    30
CHLTVDirector *g_TempDirector = NULL;
dvander@7
    31
GameDllInfo g_GameDll = {false, NULL, NULL};
dvander@7
    32
EngineInfo g_Engine = {NULL, NULL, NULL, NULL};
dvander@7
    33
SourceHook::CSourceHookImpl g_SourceHook;
dvander@7
    34
std::string g_ModPath;
dvander@7
    35
std::string g_BinPath;
dvander@7
    36
dvander@7
    37
///////////////////////////////////
dvander@7
    38
// Main code for HL2 Interaction //
dvander@7
    39
///////////////////////////////////
dvander@7
    40
dvander@7
    41
//This is where the magic happens
dvander@7
    42
SMM_API void *CreateInterface(const char *name, int *ret)
dvander@7
    43
{
dvander@7
    44
	if (!g_GameDll.loaded)
dvander@7
    45
	{
dvander@7
    46
		//State of the Mod:
dvander@7
    47
		// Currently, HL2 Engine has loaded Metamod:Source
dvander@7
    48
		// It is now asking it to get an interface.  We don't have one,
dvander@7
    49
		//  so we're gonna try to give it a fake one to get the information we need.
dvander@7
    50
		//  Then we'll swap the vtables with the real one from the real gamedll.
dvander@7
    51
dvander@7
    52
		if (strcmp(name, INTERFACEVERSION_SERVERGAMEDLL) == 0)
dvander@7
    53
		{
dvander@7
    54
			//We're in.  Give the server our fake class as bait.
dvander@7
    55
			if (ret)
dvander@7
    56
				*ret = IFACE_OK;
dvander@7
    57
dvander@7
    58
			g_TempGameDLL = new CServerGameDLL;
dvander@7
    59
dvander@7
    60
			return static_cast<void *>(g_TempGameDLL);
dvander@7
    61
		} else if (strcmp(name, INTERFACEVERSION_SERVERGAMEENTS) == 0) {
dvander@7
    62
			if (ret)
dvander@7
    63
				*ret = IFACE_OK;
dvander@7
    64
dvander@7
    65
			g_TempGameEnts = new CServerGameEnts;
dvander@7
    66
dvander@7
    67
			return static_cast<void *>(g_TempGameEnts);
dvander@7
    68
		} else if (strcmp(name, INTERFACEVERSION_SERVERGAMECLIENTS) == 0) {
dvander@7
    69
			if (ret)
dvander@7
    70
				*ret = IFACE_OK;
dvander@7
    71
dvander@7
    72
			g_TempGameClients = new CServerGameClients;
dvander@7
    73
dvander@7
    74
			return static_cast<void *>(g_TempGameClients);
dvander@7
    75
		} else if (strcmp(name, INTERFACEVERSION_HLTVDIRECTOR) == 0) {
dvander@7
    76
			if (ret)
dvander@7
    77
				*ret = IFACE_OK;
dvander@7
    78
dvander@7
    79
			g_TempDirector = new CHLTVDirector;
dvander@7
    80
dvander@7
    81
			return static_cast<void *>(g_TempDirector);
dvander@7
    82
		} else {
dvander@7
    83
			if (ret)
dvander@7
    84
				*ret = IFACE_FAILED;
dvander@7
    85
dvander@7
    86
			return NULL;
dvander@7
    87
		}
dvander@7
    88
	} else {
dvander@9
    89
		META_INTERFACE_MACRO(server, g_GameDll.factory);
dvander@7
    90
	}
dvander@7
    91
}
dvander@7
    92
dvander@7
    93
bool CServerGameDLL::DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn fileSystemFactory, CGlobalVars *pGlobals)
dvander@7
    94
{
dvander@7
    95
	if (!g_GameDll.loaded)
dvander@7
    96
	{
dvander@7
    97
		//The gamedll isn't loaded yet.  We need to find out where it's hiding.
dvander@7
    98
		IVEngineServer *ive = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
dvander@7
    99
		if (!ive)
dvander@7
   100
		{
dvander@7
   101
			Error("Metamod:Source could not load %s", INTERFACEVERSION_VENGINESERVER);
dvander@7
   102
			return false;
dvander@7
   103
		}
dvander@7
   104
		
dvander@7
   105
		//Guess the file name
dvander@7
   106
		//We'll have better heurestics[sp?] later on
dvander@7
   107
		char mod_path[128], full_path[255];
dvander@7
   108
		ive->GetGameDir(mod_path, sizeof(mod_path)-1);
dvander@7
   109
		g_ModPath.assign(mod_path);
dvander@7
   110
#if defined WIN32 || defined _WIN32
dvander@7
   111
		snprintf(full_path, sizeof(full_path)-1, "%s\\bin\\server.dll", mod_path);
dvander@7
   112
#else
dvander@7
   113
		snprintf(full_path, sizeof(full_path)-1, "%s/bin/server_i486.so", mod_path);
dvander@7
   114
#endif
dvander@7
   115
dvander@7
   116
		g_BinPath.assign(full_path);
dvander@7
   117
dvander@7
   118
		//See if the file even exists
dvander@7
   119
		FILE *fp = fopen(g_BinPath.c_str(), "r");
dvander@7
   120
		if (!fp)
dvander@7
   121
		{
dvander@7
   122
			Error("Metamod:Source could not read %s", g_BinPath.c_str());
dvander@7
   123
			return false;
dvander@7
   124
		}
dvander@7
   125
		fclose(fp);
dvander@7
   126
		fp = NULL;
dvander@7
   127
dvander@7
   128
		//Load the DLL
dvander@7
   129
		g_GameDll.lib = dlmount(g_BinPath.c_str());
dvander@7
   130
		if (!g_GameDll.lib)
dvander@7
   131
		{
dvander@7
   132
			Error("Metamod:Source could not load GameDLL: %s", dlerror());
dvander@7
   133
			return false;
dvander@7
   134
		} else {
dvander@7
   135
			//Find its factory
dvander@7
   136
			g_GameDll.factory = (CreateInterfaceFn)(dlsym(g_GameDll.lib, "CreateInterface"));
dvander@7
   137
			if (!g_GameDll.factory)
dvander@7
   138
			{
dvander@7
   139
				Error("Metamod:Source could not find an entry point in GameDLL: %s", g_BinPath.c_str());
dvander@7
   140
				dlclose(g_GameDll.lib);
dvander@7
   141
				return false;
dvander@7
   142
			}
dvander@7
   143
dvander@7
   144
			//Find the new IServerGameDLL pointer
dvander@7
   145
			IServerGameDLL *serverDll;
dvander@7
   146
			serverDll = (IServerGameDLL *)((g_GameDll.factory)(INTERFACEVERSION_SERVERGAMEDLL, NULL));
dvander@7
   147
			if (!serverDll)
dvander@7
   148
			{
dvander@7
   149
				Error("Metamod:Source could not find %s in GameDLL: %s", INTERFACEVERSION_SERVERGAMEDLL, g_BinPath.c_str());
dvander@7
   150
				dlclose(g_GameDll.lib);
dvander@7
   151
				return false;
dvander@7
   152
			}
dvander@7
   153
dvander@7
   154
			//Set this information early in case our wrappers are called somehow
dvander@7
   155
			g_Engine.engineFactory = engineFactory;
dvander@7
   156
			g_Engine.icvar = (ICvar *)(g_Engine.engineFactory)(VENGINE_CVAR_INTERFACE_VERSION, NULL);
dvander@7
   157
			if (!g_Engine.icvar)
dvander@7
   158
			{
dvander@7
   159
				Error("Metamod:Source could not find %s in engine!", VENGINE_CVAR_INTERFACE_VERSION);
dvander@7
   160
				dlclose(g_GameDll.lib);
dvander@7
   161
				return false;
dvander@7
   162
			}
dvander@7
   163
			g_Engine.fileSystemFactory = fileSystemFactory;
dvander@7
   164
			g_Engine.pGlobals = pGlobals;
dvander@7
   165
			g_Engine.physicsFactory = physicsFactory;
dvander@7
   166
			g_Engine.engine = ive;
dvander@7
   167
			
dvander@7
   168
			//Attempt to load the GameDLL
dvander@7
   169
			// Note that nothing will be intercepting yet.
dvander@7
   170
			// This is the one and only call that plugins have no chance of seeing.
dvander@7
   171
			// Likewise, you won't be able to trick the Server DLL into loading random things.
dvander@7
   172
			// Luckily, because of SourceHook, this really isn't a problem - you can change
dvander@7
   173
			//  the virtual interfaces in anything it requests.
dvander@7
   174
			if (!serverDll->DLLInit(EngineFactory, PhysicsFactory, FileSystemFactory, pGlobals))
dvander@7
   175
			{
dvander@7
   176
				//For some reason, the GameDLL failed to load. 
dvander@7
   177
				Error("Metamod:Source: GameDLL %s refused to load.", g_BinPath.c_str());
dvander@7
   178
				dlclose(g_GameDll.lib);
dvander@7
   179
				return false;
dvander@7
   180
			}
dvander@7
   181
dvander@9
   182
			//Retrieve the pointers we'll need from the GameDLL
dvander@7
   183
			IServerGameEnts *serverEnts;
dvander@7
   184
			IServerGameClients *serverClients;
dvander@7
   185
			IHLTVDirector *serverHLTV;
dvander@7
   186
dvander@7
   187
			serverEnts = (IServerGameEnts *)((g_GameDll.factory)(INTERFACEVERSION_SERVERGAMEENTS, NULL));
dvander@7
   188
			if (!serverEnts)
dvander@7
   189
			{
dvander@7
   190
				Error("Metamod:Source could not find %s in GameDLL: %s", INTERFACEVERSION_SERVERGAMEENTS, g_BinPath.c_str());
dvander@7
   191
				dlclose(g_GameDll.lib);
dvander@7
   192
				return false;
dvander@7
   193
			}
dvander@7
   194
dvander@7
   195
			serverClients = (IServerGameClients *)((g_GameDll.factory)(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
dvander@7
   196
			if (!serverClients)
dvander@7
   197
			{
dvander@7
   198
				Error("Metamod:Source could not find %s in GameDLL: %s", INTERFACEVERSION_SERVERGAMECLIENTS, g_BinPath.c_str());
dvander@7
   199
				dlclose(g_GameDll.lib);
dvander@7
   200
				return false;
dvander@7
   201
			}
dvander@7
   202
dvander@7
   203
            serverHLTV = (IHLTVDirector *)((g_GameDll.factory)(INTERFACEVERSION_HLTVDIRECTOR, NULL));
dvander@7
   204
			if (!serverHLTV)
dvander@7
   205
			{
dvander@7
   206
				Error("Metamod:Source could not find %s in GameDLL: %s", INTERFACEVERSION_HLTVDIRECTOR, g_BinPath.c_str());
dvander@7
   207
				dlclose(g_GameDll.lib);
dvander@7
   208
				return false;
dvander@7
   209
			}
dvander@7
   210
dvander@7
   211
			//The GameDLL has given the go - now we'll swap the vtables ( eww! )
dvander@7
   212
			//This ugly hack will patch the pointer we've given the engine
dvander@7
   213
			// so it will just be calling the real GameDLL instead.
dvander@7
   214
			// Unlike Metamod:HL1, this is the effect we want, rather than duplicating
dvander@7
   215
			//  the entire class (because SourceHook doesn't do that).
dvander@7
   216
			void *vtableDst = ((void *)(g_TempGameDLL));
dvander@7
   217
			void *vtableSrc = ((void *)(serverDll));
dvander@7
   218
dvander@7
   219
			SourceHook::SetMemAccess(vtableDst, sizeof(IServerGameDLL), SH_MEM_READ|SH_MEM_WRITE);
dvander@7
   220
			memcpy(vtableDst, vtableSrc, sizeof(IServerGameDLL));
dvander@7
   221
dvander@7
   222
			//Now patch IServerGameEnts
dvander@7
   223
			vtableDst = ((void *)(g_TempGameEnts));
dvander@7
   224
			vtableSrc = ((void *)(serverEnts));
dvander@7
   225
			SourceHook::SetMemAccess(vtableDst, sizeof(IServerGameEnts), SH_MEM_READ|SH_MEM_WRITE);
dvander@7
   226
			memcpy(vtableDst, vtableSrc, sizeof(IServerGameEnts));
dvander@7
   227
dvander@7
   228
			//Now patch IServerGameClients
dvander@7
   229
			vtableDst = ((void *)(g_TempGameClients));
dvander@7
   230
			vtableSrc = ((void *)(serverClients));
dvander@7
   231
			SourceHook::SetMemAccess(vtableDst, sizeof(IServerGameClients), SH_MEM_READ|SH_MEM_WRITE);
dvander@7
   232
			memcpy(vtableDst, vtableSrc, sizeof(IServerGameClients));
dvander@7
   233
dvander@7
   234
			//Now patch IHLTVDirector
dvander@7
   235
			vtableDst = ((void *)(g_TempDirector));
dvander@7
   236
			vtableSrc = ((void *)(serverHLTV));
dvander@7
   237
			SourceHook::SetMemAccess(vtableDst, sizeof(IHLTVDirector), SH_MEM_READ|SH_MEM_WRITE);
dvander@7
   238
			memcpy(vtableDst, vtableSrc, sizeof(IHLTVDirector));
dvander@7
   239
dvander@7
   240
			//Everything's done.
dvander@7
   241
			g_GameDll.loaded = true;
dvander@7
   242
dvander@7
   243
			//Initialize our console hooks
dvander@7
   244
			ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
dvander@7
   245
            
dvander@7
   246
			//Now it's safe to load plugins.
dvander@7
   247
#if defined WIN32 || defined _WIN32
dvander@7
   248
			snprintf(full_path, sizeof(full_path)-1, "%s\\%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   249
#else
dvander@7
   250
			snprintf(full_path, sizeof(full_path)-1, "%s/%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   251
#endif
dvander@7
   252
dvander@7
   253
			LoadPluginsFromFile(full_path);
dvander@7
   254
dvander@7
   255
			return true;
dvander@7
   256
		}
dvander@7
   257
	}
dvander@7
   258
dvander@7
   259
	//Somehow, the function got here.  This should be impossible, as not only is it 
dvander@7
   260
	// only called once, but the vtables should be overridden.
dvander@7
   261
	Error("Metamod:Source fatal error - IServerGameDLL::DLLInit() called inappropriately");
dvander@7
   262
dvander@7
   263
	return false;
dvander@7
   264
}
dvander@7
   265
dvander@7
   266
int LoadPluginsFromFile(const char *file)
dvander@7
   267
{
dvander@7
   268
	FILE *fp;
dvander@7
   269
	int total = 0, skipped=0;
dvander@7
   270
	PluginId id;
dvander@7
   271
	bool already;
dvander@7
   272
dvander@7
   273
	fp = fopen(file, "rt");
dvander@7
   274
	if (!fp)
dvander@7
   275
	{
dvander@7
   276
		LogMessage("[META] Could not open plugins file %s\n", file);
dvander@7
   277
		return -1;
dvander@7
   278
	}
dvander@7
   279
dvander@7
   280
	char buffer[255], error[255], full_path[128];
dvander@7
   281
	const char *ptr, *ext;
dvander@7
   282
	while (!feof(fp))
dvander@7
   283
	{
dvander@7
   284
		buffer[0] = '\0';
dvander@7
   285
		fgets(buffer, sizeof(buffer)-1, fp);
dvander@7
   286
		if (buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
dvander@7
   287
			continue;
dvander@7
   288
		//First find if it's an absolute path or not...
dvander@7
   289
		if (buffer[0] == '/' || strncmp(&(buffer[1]), ":\\", 2) == 0)
dvander@7
   290
		{
dvander@7
   291
			//If we're in an absolute path, ignore our normal heuristics
dvander@7
   292
			id = g_PluginMngr.Load(buffer, Pl_File, already, error, sizeof(error)-1);
dvander@7
   293
			if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
dvander@7
   294
			{
dvander@7
   295
				LogMessage("[META] Failed to load plugin %s.  %s", buffer, error);
dvander@7
   296
			} else {
dvander@7
   297
				if (already)
dvander@7
   298
					skipped++;
dvander@7
   299
				else
dvander@7
   300
					total++;
dvander@7
   301
			}
dvander@7
   302
		} else {
dvander@7
   303
			//Attempt to find a file extension
dvander@7
   304
			ptr = UTIL_GetExtension(buffer);
dvander@7
   305
			//Add an extension if there's none there
dvander@7
   306
			if (!ptr)
dvander@7
   307
			{
dvander@7
   308
#if defined WIN32 || defined _WIN32
dvander@7
   309
				ext = ".dll";
dvander@7
   310
#else
dvander@7
   311
				ext = "_i486.so";
dvander@7
   312
#endif
dvander@7
   313
			} else {
dvander@7
   314
				ext = "";
dvander@7
   315
			}
dvander@7
   316
			//Format the new path
dvander@7
   317
#if defined WIN32 || defined _WIN32
dvander@7
   318
			snprintf(full_path, sizeof(full_path)-1, "%s\\%s%s", g_ModPath.c_str(), buffer, ext);
dvander@7
   319
#else
dvander@7
   320
			snprintf(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), buffer, ext);
dvander@7
   321
#endif
dvander@7
   322
			id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error)-1);
dvander@7
   323
			if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
dvander@7
   324
			{
dvander@7
   325
				LogMessage("[META] Failed to load plugin %s.  %s", buffer, error);
dvander@7
   326
			} else {
dvander@7
   327
				if (already)
dvander@7
   328
					skipped++;
dvander@7
   329
				else
dvander@7
   330
					total++;
dvander@7
   331
			}
dvander@7
   332
		}
dvander@7
   333
	}
dvander@7
   334
	fclose(fp);
dvander@7
   335
dvander@7
   336
	if (skipped)
dvander@7
   337
	{
dvander@7
   338
		LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
dvander@7
   339
	} else {
dvander@7
   340
		LogMessage("[META] Loaded %d plugins from file.", total);
dvander@7
   341
	}
dvander@7
   342
	
dvander@7
   343
	return total;
dvander@7
   344
}
dvander@7
   345
dvander@7
   346
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   347
// the engine's real engineFactory.
dvander@7
   348
void *EngineFactory(const char *name, int *ret)
dvander@7
   349
{
dvander@9
   350
	META_INTERFACE_MACRO(engine, g_Engine.engineFactory);
dvander@7
   351
}
dvander@7
   352
dvander@7
   353
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   354
// the engine's real physicsFactory.
dvander@7
   355
void *PhysicsFactory(const char *name, int *ret)
dvander@7
   356
{
dvander@9
   357
	META_INTERFACE_MACRO(physics, g_Engine.physicsFactory);
dvander@7
   358
}
dvander@7
   359
dvander@7
   360
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   361
// the engine's real fileSystemFactory.
dvander@7
   362
void *FileSystemFactory(const char *name, int *ret)
dvander@7
   363
{
dvander@9
   364
	META_INTERFACE_MACRO(fileSystem, g_Engine.fileSystemFactory);
dvander@7
   365
}
dvander@7
   366
dvander@7
   367
void LogMessage(const char *msg, ...)
dvander@7
   368
{
dvander@7
   369
	va_list ap;
dvander@7
   370
	static char buffer[2048];
dvander@7
   371
dvander@7
   372
	buffer[0] = '\0';
dvander@7
   373
dvander@7
   374
	va_start(ap, msg);
dvander@7
   375
	vsnprintf(buffer, sizeof(buffer)-5, msg, ap);
dvander@7
   376
	strcat(buffer, "\n");
dvander@7
   377
	va_end(ap);
dvander@7
   378
dvander@7
   379
	g_Engine.engine->LogPrint(buffer);
dvander@7
   380
}