Properly implementing GameDLL unloading.
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2008 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * Contributor(s): Scott "Damaged Soul" Ehlert
9 * : Pavol "PM OnoTo" Marko
10 * ============================
13 #include <interface.h>
15 #include <tier0/icommandline.h>
17 #include "concommands.h"
21 #include "vsp_listener.h"
22 #include "iplayerinfo.h"
23 #include <filesystem.h>
25 using namespace SourceMM;
28 * @brief Implementation of main SourceMM GameDLL functionality
33 DLL_IMPORT ICommandLine *CommandLine();
35 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
36 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
37 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
38 SH_DECL_HOOK0(IServerGameDLL, GameInit, SH_NOATTRIB, false, bool);
40 void LevelShutdown_handler();
41 bool LevelInit_handler(char const *pMapName,
42 char const *pMapEntities,
43 char const *pOldLevel,
44 char const *pLandmarkName,
47 bool GameInit_handler();
48 void LookForVDFs(const char *dir);
49 bool KVLoadFromFile(KeyValues *kv,
50 IBaseFileSystem *filesystem,
51 const char *resourceName,
52 const char *pathID = NULL);
54 GameDllInfo g_GameDll = {false, NULL, NULL, NULL};
56 SourceHook::CSourceHookImpl g_SourceHook;
57 SourceHook::ISourceHook *g_SHPtr = &g_SourceHook;
58 SourceHook::String g_ModPath;
59 PluginId g_PLID = Pl_Console; /* Technically, SourceMM is the "Console" plugin... :p */
60 static bool bInFirstLevel = true;
61 bool g_bGameInit = false;
62 SourceHook::CallClass<IServerGameDLL> *g_GameDllPatch;
63 SourceHook::CallClass<ICvar> *g_CvarPatch;
64 int g_GameDllVersion = 0;
65 static const char VSPIFACE_001[] = "ISERVERPLUGINCALLBACKS001";
66 static const char VSPIFACE_002[] = "ISERVERPLUGINCALLBACKS002";
67 static const char GAMEINFO_PATH[] = "|gameinfo_path|";
68 IFileSystem *baseFs = NULL;
69 bool g_bLevelChanged = false;
70 IServerPluginCallbacks *g_pRealVspCallbacks = &g_VspListener;
72 #define ITER_EVENT(evn, args) \
73 CPluginManager::CPlugin *pl; \
74 SourceHook::List<CPluginEventHandler>::iterator event; \
75 IMetamodListener *api; \
76 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
78 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
79 api = (*event).event; \
84 ///////////////////////////////////
85 // Main code for HL2 Interaction //
86 ///////////////////////////////////
88 /* Initialize everything here */
91 /* Like Metamod, reload plugins at the end of the map.
92 * This is so plugins can hook everything on load, BUT, new plugins will be reloaded
93 * if the server is shut down (silly, but rare case).
97 char smm_path[PATH_SIZE];
98 const char *game_dir = CommandLine()->ParmValue("-game", "hl2");
99 abspath(smm_path, game_dir);
100 g_ModPath.assign(smm_path);
102 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelShutdown, g_GameDll.pGameDLL, LevelShutdown_handler, true);
103 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelInit, g_GameDll.pGameDLL, LevelInit_handler, true);
104 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, GameInit, g_GameDll.pGameDLL, GameInit_handler, false);
107 void DoInitialPluginLoads()
109 const char *pluginFile = g_Engine.icvar->GetCommandLineValue("mm_pluginsfile");
110 const char *mmBaseDir = g_Engine.icvar->GetCommandLineValue("mm_basedir");
114 pluginFile = GetPluginsFile();
118 mmBaseDir = GetMetamodBaseDir();
123 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), pluginFile);
124 LoadPluginsFromFile(full_path);
125 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), mmBaseDir);
126 LookForVDFs(full_path);
129 bool StartupMetamod(CreateInterfaceFn engineFactory, bool bWaitForGameInit)
131 g_Engine.engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
133 if (!g_Engine.engine)
135 Error("Could not find IVEngineServer! Metamod cannot load.");
138 g_Engine.icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION , NULL));
141 Error("Could not find ICvar! Metamod cannot load.");
145 g_Engine.loaded = true;
147 /* The Ship is the only game known at this time that uses the pre-Episode One engine */
148 g_Engine.original = strcmp(CommandLine()->ParmValue("-game", "hl2"), "ship") == 0;
150 ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
152 g_GameDllPatch = SH_GET_CALLCLASS(g_GameDll.pGameDLL);
153 g_CvarPatch = SH_GET_CALLCLASS(g_Engine.icvar);
155 if (g_GameDll.pGameClients)
157 SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, g_GameDll.pGameClients, ClientCommand_handler, false);
161 /* If IServerGameClients isn't found, this really isn't a fatal error so... */
162 LogMessage("[META] Warning: Could not find IServerGameClients!");
163 LogMessage("[META] Warning: The 'meta' command will not be available to clients.");
166 if (!g_SmmAPI.CacheCmds())
168 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
169 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
172 if (!g_SmmAPI.CacheUserMessages())
174 /* Don't know of a mod that has stripped out user messages completely,
175 * but perhaps should do something different here?
177 LogMessage("[META] Warning: Failed to get list of user messages.");
178 LogMessage("[META] Warning: The 'meta game' command will not display user messages.");
181 baseFs = (IFileSystem *)((engineFactory)(FILESYSTEM_INTERFACE_VERSION, NULL));
184 LogMessage("[META] Failed to find filesystem interface, .vdf files will not be parsed.");
187 if (!g_SMConVarAccessor.InitConCommandBaseList())
189 /* This is very unlikely considering it's old engine */
190 LogMessage("[META] Warning: Failed to find ConCommandBase list!");
191 LogMessage("[META] Warning: ConVars and ConCommands cannot be unregistered properly! Please file a bug report.");
194 if (!bWaitForGameInit)
196 DoInitialPluginLoads();
197 bInFirstLevel = true;
203 void LoadAsGameDLL(const gamedll_bridge_info *info)
205 g_Engine.engineFactory = (CreateInterfaceFn)info->engineFactory;
206 g_Engine.fileSystemFactory = (CreateInterfaceFn)info->fsFactory;
207 g_Engine.physicsFactory = (CreateInterfaceFn)info->physicsFactory;
208 g_Engine.pGlobals = (CGlobalVars*)info->pGlobals;
209 g_GameDll.loaded = true;
210 g_GameDll.factory = (CreateInterfaceFn)info->gsFactory;
211 g_GameDll.pGameDLL = (IServerGameDLL*)info->isgd;
212 g_GameDllVersion = info->dllVersion;
216 StartupMetamod(g_Engine.engineFactory, false);
219 bool AlternatelyLoadMetamod(CreateInterfaceFn ifaceFactory, CreateInterfaceFn serverFactory)
221 g_Engine.engineFactory = ifaceFactory;
222 g_Engine.fileSystemFactory = ifaceFactory;
223 g_Engine.physicsFactory = ifaceFactory;
225 IPlayerInfoManager *playerInfoManager = (IPlayerInfoManager *)serverFactory("PlayerInfoManager002", NULL);
226 if (playerInfoManager == NULL)
228 Error("Metamod:Source requires gameinfo.txt modification to load on this game.");
232 g_Engine.pGlobals = playerInfoManager->GetGlobalVars();
234 /* Now find the server */
235 g_GameDll.factory = serverFactory;
237 char gamedll_iface[] = "ServerGameDLL000";
238 for (unsigned int i = 3; i <= 50; i++)
240 gamedll_iface[15] = '0' + i;
241 g_GameDll.pGameDLL = (IServerGameDLL *)serverFactory(gamedll_iface, NULL);
242 if (g_GameDll.pGameDLL != NULL)
244 g_GameDllVersion = i;
249 if (g_GameDll.pGameDLL == NULL)
251 Error("Metamod:Source requires gameinfo.txt modification to load on this game.");
255 char gameclients_iface[] = "ServerGameClients000";
256 for (unsigned int i = 3; i <= 4; i++)
258 gameclients_iface[19] = '0' + i;
259 g_GameDll.pGameClients = (IServerGameClients *)serverFactory(gameclients_iface, NULL);
260 if (g_GameDll.pGameClients != NULL)
268 if (!StartupMetamod(ifaceFactory, true))
273 g_PluginMngr.SetAllLoaded();
278 bool GameInit_handler()
281 RETURN_META_VALUE(MRES_IGNORED, true);
283 if (g_SmmAPI.VSPEnabled() && !g_bIsBridgedAsVsp)
284 g_SmmAPI.LoadAsVSP();
286 if (g_bIsBridgedAsVsp)
287 DoInitialPluginLoads();
291 RETURN_META_VALUE(MRES_IGNORED, true);
294 void UnloadMetamod(bool shutting_down)
297 g_PluginMngr.UnloadAll();
301 /* Add the FCVAR_GAMEDLL flag to our cvars so the engine removes them properly */
302 g_SMConVarAccessor.MarkCommandsAsGameDLL();
303 g_Engine.icvar->UnlinkVariables(FCVAR_GAMEDLL);
306 SH_RELEASE_CALLCLASS(g_GameDllPatch);
307 SH_RELEASE_CALLCLASS(g_CvarPatch);
308 g_GameDllPatch = NULL;
311 g_SourceHook.CompleteShutdown();
314 void LoadFromVDF(const char *file)
317 bool already, kvfileLoaded;
319 const char *plugin_file, *alias;
320 char full_path[256], error[256];
322 pValues = new KeyValues("Metamod Plugin");
324 if (g_Engine.original)
326 /* The Ship must use a special version of this function */
327 kvfileLoaded = KVLoadFromFile(pValues, baseFs, file);
331 kvfileLoaded = pValues->LoadFromFile(baseFs, file);
336 pValues->deleteThis();
340 if ((plugin_file = pValues->GetString("file", NULL)) == NULL)
342 pValues->deleteThis();
346 if ((alias = pValues->GetString("alias", NULL)) != NULL)
348 g_PluginMngr.SetAlias(alias, plugin_file);
351 /* Attempt to find a file extension */
352 if (UTIL_GetExtension(plugin_file) == NULL)
354 g_SmmAPI.PathFormat(full_path,
359 #if defined WIN32 || defined _WIN32
368 g_SmmAPI.PathFormat(full_path,
375 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error));
376 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
378 LogMessage("[META] Failed to load plugin %s: %s", plugin_file, error);
381 pValues->deleteThis();
384 void LookForVDFs(const char *dir)
393 g_SmmAPI.PathFormat(path, sizeof(path), "%s\\*.vdf", dir);
394 if ((hFind = FindFirstFile(path, &fd)) == INVALID_HANDLE_VALUE)
396 DWORD dw = GetLastError();
397 if (dw == ERROR_FILE_NOT_FOUND)
400 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_IGNORE_INSERTS,
403 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
407 LogMessage("[META] Could not open folder \"%s\" (%s)", dir, error);
413 g_SmmAPI.PathFormat(path, sizeof(path), "%s\\%s", dir, fd.cFileName);
415 } while (FindNextFile(hFind, &fd));
423 if ((pDir = opendir(dir)) == NULL)
425 LogMessage("[META] Could not open folder \"%s\" (%s)", dir, strerror(errno));
429 while ((pEnt = readdir(pDir)) != NULL)
431 if (strcmp(pEnt->d_name, ".") == 0
432 || strcmp(pEnt->d_name, "..") == 0)
436 extidx = strlen(pEnt->d_name) - 4;
437 if (extidx < 0 || stricmp(&pEnt->d_name[extidx], ".vdf"))
441 g_SmmAPI.PathFormat(path, sizeof(path), "%s/%s", dir, pEnt->d_name);
449 bool KVLoadFromFile(KeyValues *kv, IBaseFileSystem *filesystem, const char *resourceName, const char *pathID)
453 Assert(_heapchk() == _HEAPOK);
456 FileHandle_t f = filesystem->Open(resourceName, "rb", pathID);
460 // load file into a null-terminated buffer
461 int fileSize = filesystem->Size(f);
462 char *buffer = (char *)MemAllocScratch(fileSize + 1);
466 filesystem->Read(buffer, fileSize, f); // read into local buffer
468 buffer[fileSize] = 0; // null terminate file as EOF
470 filesystem->Close( f ); // close file after reading
472 bool retOK = kv->LoadFromBuffer( resourceName, buffer, filesystem );
479 int LoadPluginsFromFile(const char *_file)
482 int total = 0, skipped=0;
486 fp = fopen(_file, "rt");
489 LogMessage("[META] Could not open plugins file %s\n", _file);
493 char buffer[255], error[255], full_path[255];
494 const char *ptr, *ext, *file;
496 while (!feof(fp) && fgets(buffer, sizeof(buffer), fp) != NULL)
498 UTIL_TrimLeft(buffer);
499 UTIL_TrimRight(buffer);
501 length = strlen(buffer);
507 if (buffer[0] == '\0' || buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
513 if (buffer[0] == '"')
536 while (*cptr && isspace(*cptr))
541 UTIL_TrimRight(cptr);
542 if (*cptr && isalpha(*cptr))
544 g_PluginMngr.SetAlias(buffer, cptr);
556 /* First find if it's an absolute path or not... */
557 if (file[0] == '/' || strncmp(&(file[1]), ":\\", 2) == 0)
559 /* If we're in an absolute path, ignore our normal heuristics */
560 id = g_PluginMngr.Load(file, Pl_File, already, error, sizeof(error));
561 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
563 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
579 /* Attempt to find a file extension */
580 ptr = UTIL_GetExtension(file);
581 /* Add an extension if there's none there */
584 #if defined WIN32 || defined _WIN32
594 /* Format the new path */
595 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
596 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error));
597 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
599 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
618 LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
622 LogMessage("[META] Loaded %d plugins from file.", total);
628 void LogMessage(const char *msg, ...)
631 static char buffer[2048];
634 size_t len = vsnprintf(buffer, sizeof(buffer) - 2, msg, ap);
637 buffer[len++] = '\n';
640 if (!g_Engine.engine)
642 fprintf(stdout, "%s", buffer);
644 g_Engine.engine->LogPrint(buffer);
648 void LevelShutdown_handler(void)
654 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
655 LoadPluginsFromFile(full_path);
657 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), GetMetamodBaseDir());
658 LookForVDFs(full_path);
662 bInFirstLevel = false;
665 g_bLevelChanged = true;
667 ITER_EVENT(OnLevelShutdown, ());
669 RETURN_META(MRES_IGNORED);
672 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
674 if (!g_SmmAPI.CmdCacheSuccessful())
676 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
677 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
680 ITER_EVENT(OnLevelInit, (pMapName, pMapEntities, pOldLevel, pLandmarkName, loadGame, background));
682 RETURN_META_VALUE(MRES_IGNORED, false);
685 #if defined __GNUC__ && (__GNUC__ == 3 || __GNUC__ == 4)
686 void * operator new(size_t size) {
687 return(calloc(1, size));
690 void * operator new[](size_t size) {
691 return(calloc(1, size));
694 void operator delete(void * ptr) {
699 void operator delete[](void * ptr) {