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