1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2007 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"
23 using namespace SourceMM;
26 * @brief Implementation of main SourceMM GameDLL functionality
31 DLL_IMPORT ICommandLine *CommandLine();
33 SH_DECL_HOOK4(IServerGameDLL, DLLInit, SH_NOATTRIB, false, bool, CreateInterfaceFn, CreateInterfaceFn, CreateInterfaceFn, CGlobalVars *);
34 SH_DECL_HOOK0_void(IServerGameDLL, DLLShutdown, SH_NOATTRIB, false);
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 bool DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals);
41 bool DLLInit_Post(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals);
42 void DLLShutdown_handler();
43 void LevelShutdown_handler();
44 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
45 bool GameInit_handler();
47 GameDllInfo g_GameDll = {false, NULL, NULL, NULL, NULL};
49 SourceHook::CSourceHookImpl g_SourceHook;
50 SourceHook::ISourceHook *g_SHPtr = &g_SourceHook;
51 SourceHook::String g_ModPath;
52 SourceHook::String g_BinPath;
53 PluginId g_PLID = Pl_Console; /* Technically, SourceMM is the "Console" plugin... :p */
54 bool bInFirstLevel = true;
55 bool gParsedGameInfo = false;
56 bool bGameInit = false;
57 SourceHook::List<GameDllInfo *> gamedll_list;
58 SourceHook::CallClass<IServerGameDLL> *g_GameDllPatch;
59 int g_GameDllVersion = 0;
60 const char VSPIFACE[] = "ISERVERPLUGINS";
61 const char GAMEINFO_PATH[] = "|gameinfo_path|";
63 void ClearGamedllList();
66 #define IFACE_MACRO(orig,nam) \
67 CPluginManager::CPlugin *pl; \
68 SourceHook::List<IMetamodListener *>::iterator event; \
69 IMetamodListener *api; \
72 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
74 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
76 mret = IFACE_FAILED; \
77 if ( (val=api->On##nam##Query(iface, &mret)) != NULL ) { \
78 if (ret) *ret = mret; \
83 return (orig)(iface, ret);
85 #define ITER_EVENT(evn, args) \
86 CPluginManager::CPlugin *pl; \
87 SourceHook::List<IMetamodListener *>::iterator event; \
88 IMetamodListener *api; \
89 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
91 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
97 ///////////////////////////////////
98 // Main code for HL2 Interaction //
99 ///////////////////////////////////
101 /* Initialize everything here */
102 void InitMainStates()
104 char full_path[PATH_SIZE] = {0};
105 GetFileOfAddress((void *)g_GameDll.factory, full_path, sizeof(full_path));
106 g_BinPath.assign(full_path);
108 /* Like Metamod, reload plugins at the end of the map.
109 * This is so plugins can hook everything on load, BUT, new plugins will be reloaded
110 * if the server is shut down (silly, but rare case).
112 bInFirstLevel = true;
114 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit, false);
115 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit_Post, true);
116 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLShutdown, g_GameDll.pGameDLL, DLLShutdown_handler, false);
117 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelShutdown, g_GameDll.pGameDLL, LevelShutdown_handler, true);
118 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelInit, g_GameDll.pGameDLL, LevelInit_handler, true);
119 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, GameInit, g_GameDll.pGameDLL, GameInit_handler, false);
121 if (g_GameDll.pGameClients)
123 SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, g_GameDll.pGameClients, ClientCommand_handler, false);
125 /* If IServerGameClients isn't found, this really isn't a fatal error so... */
126 LogMessage("[META] Warning: Could not find IServerGameClients!");
127 LogMessage("[META] Warning: The 'meta' command will not be available to clients.");
131 bool DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
133 g_Engine.engineFactory = engineFactory;
134 g_Engine.fileSystemFactory = filesystemFactory;
135 g_Engine.physicsFactory = physicsFactory;
136 g_Engine.pGlobals = pGlobals;
138 g_Engine.engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
139 if (!g_Engine.engine)
141 Error("Could not find IVEngineServer! Metamod cannot load.");
144 g_Engine.icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION , NULL));
147 Error("Could not find ICvar! Metamod cannot load.");
151 g_Engine.loaded = true;
153 /* Initialize our console hooks */
154 ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
156 g_GameDllPatch = SH_GET_CALLCLASS(g_GameDll.pGameDLL);
158 if (!g_SmmAPI.CacheCmds())
160 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
161 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
164 if (!g_SmmAPI.CacheUserMessages())
166 /* Don't know of a mod that has stripped out user messages completely,
167 * but perhaps should do something different here?
169 LogMessage("[META] Warning: Failed to get list of user messages.");
170 LogMessage("[META] Warning: The 'meta game' command will not display user messages.");
173 const char *pluginFile = g_Engine.icvar->GetCommandLineValue("mm_pluginsfile");
176 pluginFile = GetPluginsFile();
180 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), pluginFile);
182 LoadPluginsFromFile(full_path);
184 bInFirstLevel = true;
186 RETURN_META_VALUE(MRES_IGNORED, true);
189 bool GameInit_handler()
196 if (g_SmmAPI.VSPEnabled())
198 g_SmmAPI.LoadAsVSP();
203 RETURN_META_VALUE(MRES_IGNORED, true);
206 bool DLLInit_Post(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
208 g_PluginMngr.SetAllLoaded();
209 RETURN_META_VALUE(MRES_IGNORED, true);
212 /* This is where the magic happens */
213 SMM_API void *CreateInterface(const char *iface, int *ret)
215 /* Prevent loading of self as a SourceMM plugin or Valve server plugin :x */
216 if (strcmp(iface, PLAPI_NAME) == 0)
218 Warning("Do not try loading Metamod:Source as a SourceMM or Valve server plugin.\n");
228 if (strncmp(iface, VSPIFACE, sizeof(VSPIFACE) - 1) == 0)
235 return &g_VspListener;
238 if (!gParsedGameInfo)
240 gParsedGameInfo = true;
241 const char *gameDir = NULL;
242 char gamePath[PATH_SIZE];
243 char smmPath[PATH_SIZE];
245 /* Get path to SourceMM DLL */
246 if (!GetFileOfAddress((void *)CreateInterface, smmPath, sizeof(smmPath)))
248 Error("GetFileOfAddress() failed! Metamod cannot load.\n");
252 /* Get value of -game from command line, defaulting to hl2 as engine seems to do */
253 gameDir = CommandLine()->ParmValue("-game", "hl2");
255 /* Get absolute path */
256 abspath(gamePath, gameDir);
257 g_ModPath.assign(gamePath);
259 char tempPath[PATH_SIZE];
261 /* Path to gameinfo.txt */
262 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s", g_ModPath.c_str(), "gameinfo.txt");
264 FILE *fp = fopen(tempPath, "rt");
268 Error("Unable to open gameinfo.txt! Metamod cannot load.\n");
273 char key[128], val[128];
276 bool gamebin = false;
279 char curPath[PATH_SIZE];
281 getcwd(curPath, PATH_SIZE);
286 fgets(buffer, sizeof(buffer), fp);
287 len = strlen(buffer);
288 if (buffer[len-1] == '\n')
289 buffer[--len] = '\0';
290 UTIL_TrimComments(buffer);
291 UTIL_TrimLeft(buffer);
292 UTIL_TrimRight(buffer);
293 if (stricmp(buffer, "SearchPaths") == 0)
297 UTIL_KeySplit(buffer, key, sizeof(key) - 1, val, sizeof(val) - 1);
298 if (stricmp(key, "Game") == 0 || stricmp(key, "GameBin") == 0)
300 if (stricmp(key, "Game") == 0)
305 if (strncmp(val, GAMEINFO_PATH, sizeof(GAMEINFO_PATH) - 1) == 0)
307 ptr = &(val[sizeof(GAMEINFO_PATH) - 1]);
310 lptr = g_ModPath.c_str();
316 size_t ptr_len = strlen(ptr);
317 if (ptr[ptr_len] == '/' || ptr[ptr_len] == '\\')
318 ptr[--ptr_len] = '\0';
320 /* No need to append "bin" if key is GameBin */
323 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s", lptr, ptr, SERVER_DLL);
324 } else if (!ptr[0]) {
325 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s", lptr, "bin", SERVER_DLL);
327 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s/%s", lptr, ptr, "bin", SERVER_DLL);
330 /* If not path to SourceMM... */
331 if (!UTIL_PathCmp(smmPath, tempPath))
333 FILE *fp = fopen(tempPath, "rb");
336 //:TODO: Optimize this a bit!
337 SourceHook::List<GameDllInfo *>::iterator iter;
340 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
343 if (GetFileOfAddress((void *)pCheck->factory, buffer, sizeof(buffer)))
345 if (UTIL_PathCmp(tempPath, buffer))
355 HINSTANCE gamedll = dlmount(tempPath);
358 CreateInterfaceFn fn = (CreateInterfaceFn)dlsym(gamedll, "CreateInterface");
364 GameDllInfo *pInfo = new GameDllInfo;
366 pInfo->lib = gamedll;
367 pInfo->loaded = true;
368 pInfo->pGameDLL = NULL;
369 pInfo->pGameClients = (IServerGameClients *)((fn)(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
370 gamedll_list.push_back(pInfo);
378 if (!g_GameDll.loaded)
380 const char *str = "ServerGameDLL";
381 size_t len = strlen(str);
383 if (strncmp(iface, str, len) == 0)
385 /* This is the interface we want! Right now we support versions 3 through 8 */
386 g_GameDllVersion = atoi(&(iface[len]));
387 int sizeTooBig = 0; //rename this to sizeWrong in the future!
388 if (g_GameDllVersion < MIN_GAMEDLL_VERSION || g_GameDllVersion > MAX_GAMEDLL_VERSION)
390 /* Maybe this will get used in the future */
391 sizeTooBig = g_GameDllVersion;
397 SourceHook::List<GameDllInfo *>::iterator iter;
398 GameDllInfo *pInfo = NULL;
400 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
403 ptr = (pInfo->factory)(iface, ret);
406 /* This is our GameDLL. Unload the others. */
407 gamedll_list.erase(iter);
409 pInfo->pGameDLL = static_cast<IServerGameDLL *>(ptr);
415 if (g_GameDll.loaded)
419 Error("This mod version requires a SourceMM update (ServerGameDLL%03d)!\n", sizeTooBig);
435 /* wtf do we do... */
436 /* :TODO: .. something a bit more intelligent? */
437 Error("Engine requested unknown interface before GameDLL was known!\n");
442 /* If we got here, there's definitely a GameDLL */
443 IFACE_MACRO(g_GameDll.factory, GameDLL);
446 void ClearGamedllList()
448 SourceHook::List<GameDllInfo *>::iterator iter;
451 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
458 gamedll_list.clear();
461 void DLLShutdown_handler()
464 g_PluginMngr.UnloadAll();
466 /* Add the FCVAR_GAMEDLL flag to our cvars so the engine removes them properly */
467 g_SMConVarAccessor.MarkCommandsAsGameDLL();
468 g_SMConVarAccessor.UnregisterGameDLLCommands();
470 SH_CALL(g_GameDllPatch, &IServerGameDLL::DLLShutdown)();
472 SH_RELEASE_CALLCLASS(g_GameDllPatch);
473 g_GameDllPatch = NULL;
475 g_SourceHook.CompleteShutdown();
477 if (g_GameDll.lib && g_GameDll.loaded)
478 dlclose(g_GameDll.lib);
479 memset(&g_GameDll, 0, sizeof(GameDllInfo));
481 RETURN_META(MRES_SUPERCEDE);
484 int LoadPluginsFromFile(const char *_file)
487 int total = 0, skipped=0;
491 fp = fopen(_file, "rt");
494 LogMessage("[META] Could not open plugins file %s\n", _file);
498 char buffer[255], error[255], full_path[255];
499 const char *ptr, *ext, *file;
504 fgets(buffer, sizeof(buffer), fp);
505 length = strlen(buffer);
508 if (buffer[length-1] == '\n')
509 buffer[--length] = '\0';
511 UTIL_TrimLeft(buffer);
512 UTIL_TrimRight(buffer);
514 if (buffer[0] == '\0' || buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
517 if (buffer[0] == '"')
538 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);
571 /* Attempt to find a file extension */
572 ptr = UTIL_GetExtension(file);
573 /* Add an extension if there's none there */
576 #if defined WIN32 || defined _WIN32
584 /* Format the new path */
585 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
586 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error));
587 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
589 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
602 LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
604 LogMessage("[META] Loaded %d plugins from file.", total);
610 /* Wrapper function. This is called when the GameDLL thinks it's using
611 * the engine's real engineFactory.
613 void *EngineFactory(const char *iface, int *ret)
615 IFACE_MACRO(g_Engine.engineFactory, Engine);
618 /* Wrapper function. This is called when the GameDLL thinks it's using
619 * the engine's real physicsFactory.
621 void *PhysicsFactory(const char *iface, int *ret)
623 IFACE_MACRO(g_Engine.physicsFactory, Physics);
626 /* Wrapper function. This is called when the GameDLL thinks it's using
627 * the engine's real fileSystemFactory.
629 void *FileSystemFactory(const char *iface, int *ret)
631 IFACE_MACRO(g_Engine.fileSystemFactory, FileSystem);
634 void LogMessage(const char *msg, ...)
637 static char buffer[2048];
640 size_t len = vsnprintf(buffer, sizeof(buffer) - 2, msg, ap);
643 buffer[len++] = '\n';
646 if (!g_Engine.engine)
648 fprintf(stdout, "%s", buffer);
650 g_Engine.engine->LogPrint(buffer);
654 void LevelShutdown_handler(void)
659 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
661 LoadPluginsFromFile(full_path);
663 bInFirstLevel = false;
666 ITER_EVENT(OnLevelShutdown, ());
668 RETURN_META(MRES_IGNORED);
671 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
673 if (!g_SmmAPI.CmdCacheSuccessful())
675 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
676 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
679 ITER_EVENT(OnLevelInit, (pMapName, pMapEntities, pOldLevel, pLandmarkName, loadGame, background));
681 RETURN_META_VALUE(MRES_IGNORED, false);
684 #if defined __GNUC__ && (__GNUC__ == 3 || __GNUC__ == 4)
685 void * operator new(size_t size) {
686 return(calloc(1, size));
689 void * operator new[](size_t size) {
690 return(calloc(1, size));
693 void operator delete(void * ptr) {
698 void operator delete[](void * ptr) {