sourcemm/sourcemm.cpp
author David Anderson <dvander@alliedmods.net>
Mon Apr 18 03:30:30 2005 +0000 (2005-04-18)
changeset 15 6c861b24941b
parent 14 a3f323f6f91d
child 17 2d86867713af
permissions -rw-r--r--
Removed hooking of DLLShutdown
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
pavolmarko@14
    27
CServerGameDLL g_TempGameDLL;
pavolmarko@14
    28
CServerGameEnts g_TempGameEnts;
pavolmarko@14
    29
CServerGameClients g_TempGameClients;
pavolmarko@14
    30
CHLTVDirector g_TempDirector;
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@12
    34
SourceHook::ISourceHook *g_SHPtr;
dvander@7
    35
std::string g_ModPath;
dvander@7
    36
std::string g_BinPath;
dvander@12
    37
PluginId g_PLID = Pl_Console;		//Technically, SourceMM is the "Console" plugin... :p
dvander@15
    38
bool bInShutdown = false;
dvander@7
    39
dvander@7
    40
///////////////////////////////////
dvander@7
    41
// Main code for HL2 Interaction //
dvander@7
    42
///////////////////////////////////
dvander@7
    43
dvander@7
    44
//This is where the magic happens
dvander@7
    45
SMM_API void *CreateInterface(const char *name, int *ret)
dvander@7
    46
{
dvander@7
    47
	if (!g_GameDll.loaded)
dvander@7
    48
	{
dvander@7
    49
		//State of the Mod:
dvander@7
    50
		// Currently, HL2 Engine has loaded Metamod:Source
dvander@7
    51
		// It is now asking it to get an interface.  We don't have one,
dvander@7
    52
		//  so we're gonna try to give it a fake one to get the information we need.
pavolmarko@14
    53
		//  Then, the the interface will forward the calls to the original interface
dvander@7
    54
dvander@7
    55
		if (strcmp(name, INTERFACEVERSION_SERVERGAMEDLL) == 0)
dvander@7
    56
		{
dvander@7
    57
			//We're in.  Give the server our fake class as bait.
dvander@7
    58
			if (ret)
dvander@7
    59
				*ret = IFACE_OK;
pavolmarko@14
    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
pavolmarko@14
    65
			return static_cast<void *>(&g_TempGameEnts);
dvander@7
    66
		} else if (strcmp(name, INTERFACEVERSION_SERVERGAMECLIENTS) == 0) {
dvander@7
    67
			if (ret)
dvander@7
    68
				*ret = IFACE_OK;
dvander@7
    69
pavolmarko@14
    70
			return static_cast<void *>(&g_TempGameClients);
dvander@7
    71
		} else if (strcmp(name, INTERFACEVERSION_HLTVDIRECTOR) == 0) {
dvander@7
    72
			if (ret)
dvander@7
    73
				*ret = IFACE_OK;
dvander@7
    74
pavolmarko@14
    75
			return static_cast<void *>(&g_TempDirector);
dvander@7
    76
		} else {
dvander@7
    77
			if (ret)
dvander@7
    78
				*ret = IFACE_FAILED;
dvander@7
    79
dvander@7
    80
			return NULL;
dvander@7
    81
		}
dvander@7
    82
	} else {
dvander@9
    83
		META_INTERFACE_MACRO(server, g_GameDll.factory);
dvander@7
    84
	}
dvander@7
    85
}
dvander@7
    86
dvander@7
    87
bool CServerGameDLL::DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn fileSystemFactory, CGlobalVars *pGlobals)
dvander@7
    88
{
pavolmarko@14
    89
	if (m_pOrig)
pavolmarko@14
    90
		return m_pOrig->DLLInit(engineFactory, physicsFactory, fileSystemFactory, pGlobals);
pavolmarko@14
    91
dvander@7
    92
	if (!g_GameDll.loaded)
dvander@7
    93
	{
dvander@12
    94
		//Initialize SourceHook
dvander@12
    95
		g_SHPtr = static_cast<SourceHook::ISourceHook *>(&g_SourceHook);
dvander@12
    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
			}
pavolmarko@14
   210
			
pavolmarko@14
   211
			// Now tell the global temp classes that they can call the original functions
pavolmarko@14
   212
			g_TempDirector.SetOrig(serverHLTV);
pavolmarko@14
   213
			g_TempGameClients.SetOrig(serverClients);
pavolmarko@14
   214
			g_TempGameEnts.SetOrig(serverEnts);
pavolmarko@14
   215
			g_TempGameDLL.SetOrig(serverDll);
dvander@7
   216
dvander@7
   217
			//Everything's done.
dvander@7
   218
			g_GameDll.loaded = true;
dvander@7
   219
dvander@15
   220
			//Get call class, etc
dvander@15
   221
			g_GameDll.serverDll = serverDll;
dvander@15
   222
			g_GameDll.serverDll_CC = SH_GET_CALLCLASS(IServerGameDLL, serverDll);
dvander@12
   223
dvander@7
   224
			//Initialize our console hooks
dvander@7
   225
			ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
dvander@7
   226
            
dvander@7
   227
			//Now it's safe to load plugins.
dvander@7
   228
#if defined WIN32 || defined _WIN32
dvander@7
   229
			snprintf(full_path, sizeof(full_path)-1, "%s\\%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   230
#else
dvander@7
   231
			snprintf(full_path, sizeof(full_path)-1, "%s/%s", g_ModPath.c_str(), "metaplugins.ini");
dvander@7
   232
#endif
dvander@7
   233
dvander@7
   234
			LoadPluginsFromFile(full_path);
dvander@7
   235
dvander@7
   236
			return true;
dvander@7
   237
		}
dvander@7
   238
	}
dvander@7
   239
pavolmarko@14
   240
	//Somehow, the function got here.  This should be impossible.
dvander@7
   241
	Error("Metamod:Source fatal error - IServerGameDLL::DLLInit() called inappropriately");
dvander@7
   242
dvander@7
   243
	return false;
dvander@7
   244
}
dvander@7
   245
dvander@15
   246
void CServerGameDLL::DLLShutdown()
dvander@12
   247
{
dvander@15
   248
	//cancel if we're shutting down already
dvander@15
   249
	if (bInShutdown)
dvander@15
   250
		return;
dvander@15
   251
dvander@15
   252
	//we're not re-entrant
dvander@15
   253
	bInShutdown = true;
dvander@15
   254
dvander@15
   255
    //Call the original function through its call class
dvander@15
   256
	g_GameDll.serverDll_CC->DLLShutdown();
dvander@15
   257
dvander@15
   258
	//Unload plugins
dvander@12
   259
	g_PluginMngr.UnloadAll();
dvander@12
   260
dvander@15
   261
	//Shutdown sourcehook now
dvander@15
   262
	SH_RELEASE_CALLCLASS(g_GameDll.serverDll_CC);
pavolmarko@14
   263
	g_SourceHook.CompleteShutdown();
dvander@12
   264
dvander@12
   265
	//Unload the DLL forcefully
dvander@12
   266
	dlclose(g_GameDll.lib);
dvander@12
   267
	memset(&g_GameDll, 0, sizeof(GameDllInfo));
dvander@12
   268
}
dvander@12
   269
dvander@7
   270
int LoadPluginsFromFile(const char *file)
dvander@7
   271
{
dvander@7
   272
	FILE *fp;
dvander@7
   273
	int total = 0, skipped=0;
dvander@7
   274
	PluginId id;
dvander@7
   275
	bool already;
dvander@7
   276
dvander@7
   277
	fp = fopen(file, "rt");
dvander@7
   278
	if (!fp)
dvander@7
   279
	{
dvander@7
   280
		LogMessage("[META] Could not open plugins file %s\n", file);
dvander@7
   281
		return -1;
dvander@7
   282
	}
dvander@7
   283
dvander@7
   284
	char buffer[255], error[255], full_path[128];
dvander@7
   285
	const char *ptr, *ext;
dvander@7
   286
	while (!feof(fp))
dvander@7
   287
	{
dvander@7
   288
		buffer[0] = '\0';
dvander@7
   289
		fgets(buffer, sizeof(buffer)-1, fp);
dvander@7
   290
		if (buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
dvander@7
   291
			continue;
dvander@7
   292
		//First find if it's an absolute path or not...
dvander@7
   293
		if (buffer[0] == '/' || strncmp(&(buffer[1]), ":\\", 2) == 0)
dvander@7
   294
		{
dvander@7
   295
			//If we're in an absolute path, ignore our normal heuristics
dvander@7
   296
			id = g_PluginMngr.Load(buffer, Pl_File, already, error, sizeof(error)-1);
dvander@7
   297
			if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
dvander@7
   298
			{
dvander@7
   299
				LogMessage("[META] Failed to load plugin %s.  %s", buffer, error);
dvander@7
   300
			} else {
dvander@7
   301
				if (already)
dvander@7
   302
					skipped++;
dvander@7
   303
				else
dvander@7
   304
					total++;
dvander@7
   305
			}
dvander@7
   306
		} else {
dvander@7
   307
			//Attempt to find a file extension
dvander@7
   308
			ptr = UTIL_GetExtension(buffer);
dvander@7
   309
			//Add an extension if there's none there
dvander@7
   310
			if (!ptr)
dvander@7
   311
			{
dvander@7
   312
#if defined WIN32 || defined _WIN32
dvander@7
   313
				ext = ".dll";
dvander@7
   314
#else
dvander@7
   315
				ext = "_i486.so";
dvander@7
   316
#endif
dvander@7
   317
			} else {
dvander@7
   318
				ext = "";
dvander@7
   319
			}
dvander@7
   320
			//Format the new path
dvander@7
   321
#if defined WIN32 || defined _WIN32
dvander@7
   322
			snprintf(full_path, sizeof(full_path)-1, "%s\\%s%s", g_ModPath.c_str(), buffer, ext);
dvander@7
   323
#else
dvander@7
   324
			snprintf(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), buffer, ext);
dvander@7
   325
#endif
dvander@7
   326
			id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error)-1);
dvander@7
   327
			if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
dvander@7
   328
			{
dvander@7
   329
				LogMessage("[META] Failed to load plugin %s.  %s", buffer, error);
dvander@7
   330
			} else {
dvander@7
   331
				if (already)
dvander@7
   332
					skipped++;
dvander@7
   333
				else
dvander@7
   334
					total++;
dvander@7
   335
			}
dvander@7
   336
		}
dvander@7
   337
	}
dvander@7
   338
	fclose(fp);
dvander@7
   339
dvander@7
   340
	if (skipped)
dvander@7
   341
	{
dvander@7
   342
		LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
dvander@7
   343
	} else {
dvander@7
   344
		LogMessage("[META] Loaded %d plugins from file.", total);
dvander@7
   345
	}
dvander@7
   346
	
dvander@7
   347
	return total;
dvander@7
   348
}
dvander@7
   349
dvander@7
   350
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   351
// the engine's real engineFactory.
dvander@7
   352
void *EngineFactory(const char *name, int *ret)
dvander@7
   353
{
dvander@9
   354
	META_INTERFACE_MACRO(engine, g_Engine.engineFactory);
dvander@7
   355
}
dvander@7
   356
dvander@7
   357
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   358
// the engine's real physicsFactory.
dvander@7
   359
void *PhysicsFactory(const char *name, int *ret)
dvander@7
   360
{
dvander@9
   361
	META_INTERFACE_MACRO(physics, g_Engine.physicsFactory);
dvander@7
   362
}
dvander@7
   363
dvander@7
   364
//Wrapper function.  This is called when the GameDLL thinks it's using
dvander@7
   365
// the engine's real fileSystemFactory.
dvander@7
   366
void *FileSystemFactory(const char *name, int *ret)
dvander@7
   367
{
dvander@9
   368
	META_INTERFACE_MACRO(fileSystem, g_Engine.fileSystemFactory);
dvander@7
   369
}
dvander@7
   370
dvander@7
   371
void LogMessage(const char *msg, ...)
dvander@7
   372
{
dvander@7
   373
	va_list ap;
dvander@7
   374
	static char buffer[2048];
dvander@7
   375
dvander@7
   376
	buffer[0] = '\0';
dvander@7
   377
dvander@7
   378
	va_start(ap, msg);
dvander@7
   379
	vsnprintf(buffer, sizeof(buffer)-5, msg, ap);
dvander@7
   380
	strcat(buffer, "\n");
dvander@7
   381
	va_end(ap);
dvander@7
   382
dvander@7
   383
	g_Engine.engine->LogPrint(buffer);
dvander@7
   384
}