1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2006 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>
16 #include "concommands.h"
21 using namespace SourceMM;
24 * @brief Implementation of main SourceMM GameDLL functionality
28 SH_DECL_HOOK4(IServerGameDLL, DLLInit, SH_NOATTRIB, false, bool, CreateInterfaceFn, CreateInterfaceFn, CreateInterfaceFn, CGlobalVars *);
29 SH_DECL_HOOK0_void(IServerGameDLL, DLLShutdown, SH_NOATTRIB, false);
30 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
31 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
32 SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *);
33 bool DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals);
34 bool DLLInit_Post(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals);
35 void DLLShutdown_handler();
36 void LevelShutdown_handler();
37 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background);
39 GameDllInfo g_GameDll = {false, NULL, NULL, NULL, NULL};
41 SourceHook::CSourceHookImpl g_SourceHook;
42 SourceHook::ISourceHook *g_SHPtr = &g_SourceHook;
43 SourceHook::String g_ModPath;
44 SourceHook::String g_BinPath;
45 PluginId g_PLID = Pl_Console; //Technically, SourceMM is the "Console" plugin... :p
46 bool bInFirstLevel = true;
47 bool gParsedGameInfo = false;
48 SourceHook::List<GameDllInfo *> gamedll_list;
49 SourceHook::CallClass<IServerGameDLL> *dllExec;
50 int g_GameDllVersion = 0;
52 void ClearGamedllList();
55 #define IFACE_MACRO(orig,nam) \
56 CPluginManager::CPlugin *pl; \
57 SourceHook::List<IMetamodListener *>::iterator event; \
58 IMetamodListener *api; \
61 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
63 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
65 mret = IFACE_FAILED; \
66 if ( (val=api->On##nam##Query(iface, &mret)) != NULL ) { \
67 if (ret) *ret = mret; \
72 return (orig)(iface, ret);
74 #define ITER_EVENT(evn, args) \
75 CPluginManager::CPlugin *pl; \
76 SourceHook::List<IMetamodListener *>::iterator event; \
77 IMetamodListener *api; \
78 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
80 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
86 ///////////////////////////////////
87 // Main code for HL2 Interaction //
88 ///////////////////////////////////
90 //Initialize everything here
93 char full_path[260] = {0};
94 GetFileOfAddress((void *)g_GameDll.factory, full_path, sizeof(full_path)-1);
95 g_BinPath.assign(full_path);
97 //Like metamod, reload plugins at the end of the map.
98 //This is so plugins can hook everything on load, BUT, new plugins will be reloaded
99 // if the server is shut down (silly, but rare case).
100 bInFirstLevel = true;
102 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit, false);
103 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit_Post, true);
104 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLShutdown, g_GameDll.pGameDLL, DLLShutdown_handler, false);
105 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelShutdown, g_GameDll.pGameDLL, LevelShutdown_handler, true);
106 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelInit, g_GameDll.pGameDLL, LevelInit_handler, true);
108 if (g_GameDll.pGameClients)
109 SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, g_GameDll.pGameClients, ClientCommand_handler, false);
112 // If IServerGameClients isn't found, this really isn't a fatal error so...
113 LogMessage("[META] Warning: Could not find IServerGameClients!");
114 LogMessage("[META] Warning: The 'meta' command will not be available to clients.");
118 bool DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
120 g_Engine.engineFactory = engineFactory;
121 g_Engine.fileSystemFactory = filesystemFactory;
122 g_Engine.physicsFactory = physicsFactory;
123 g_Engine.pGlobals = pGlobals;
125 g_Engine.engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
126 if (!g_Engine.engine)
128 Error("Could not find IVEngineServer! Metamod cannot load.");
131 g_Engine.icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION , NULL));
134 Error("Could not find ICvar! Metamod cannot load.");
138 g_Engine.loaded = true;
140 //Initialize our console hooks
141 ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
143 if (!g_SmmAPI.CacheCmds())
145 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
146 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
150 const char *pluginFile = g_Engine.icvar->GetCommandLineValue("mm_pluginsfile");
152 pluginFile = GetPluginsFile();
155 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s/%s", g_ModPath.c_str(), pluginFile);
157 LoadPluginsFromFile(full_path);
159 bInFirstLevel = true;
161 dllExec = SH_GET_CALLCLASS(g_GameDll.pGameDLL);
163 RETURN_META_VALUE(MRES_IGNORED, true);
166 bool DLLInit_Post(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
168 g_PluginMngr.SetAllLoaded();
169 RETURN_META_VALUE(MRES_IGNORED, true);
172 //This is where the magic happens
173 SMM_API void *CreateInterface(const char *iface, int *ret)
175 // Prevent loading of self as a SourceMM plugin or Valve server plugin :x
176 const char *vspIface = "ISERVERPLUGINCALLBACKS";
177 if (strcmp(iface, PLAPI_NAME) == 0 || strnicmp(iface, vspIface, strlen(vspIface)) == 0)
179 Warning("Do not try loading Metamod:Source as a SourceMM or Valve server plugin.\n");
186 if (!gParsedGameInfo)
188 gParsedGameInfo = true;
189 char curpath[260] = {0};
190 char dllpath[260] = {0};
191 getcwd(curpath, sizeof(curpath)-1);
192 if (!GetFileOfAddress((void *)CreateInterface, dllpath, sizeof(dllpath)-1))
194 Error("GetFileOfAddress() failed! Metamod cannot load.\n");
197 SourceHook::String s_dllpath(dllpath);
198 //begin the heuristics for searching for the mod path (these are quite ugly).
199 //for OS compatibility purposes, we're going to do case insensitivity on windows.
200 size_t path_len = strlen(curpath);
201 size_t dll_len = strlen(dllpath);
203 //strip the dll path off
204 //:TODO: with path stuff - in Linux, \ can exist in a file path as a non-seperator!
205 for (size_t i=dll_len-1; i>0; i--)
207 if (dllpath[i] == '\\' || dllpath[i] == '/')
211 //save path by stripping off file name and ending terminator
218 //strip absolute path terminators if any!
219 if (curpath[path_len-1] == '/' || curpath[path_len-1] == '\\')
220 curpath[--path_len] = '\0';
222 //if the base path doesn't fit into the module path, something is wrong!
223 // ex: c:\games\srcds
225 if (path_len > dll_len)
227 Error("Could not detect GameDLL path! Metamod cannot load[1].\n");
231 //we are now in such a position that the two dir names SHOULD MATCH!
232 typedef int (*STRNCMP)(const char *str1, const char *str2, size_t n);
240 if ( ((cmp)(curpath, dllpath, path_len)) != 0 )
242 //:TODO: In this case, we should read /proc/self/maps and find srcds!
243 Error("Could not detect GameDLL path! Metamod cannot load[2].\n");
246 //this will skip past the dir and its separator char
247 char *ptr = &(dllpath[path_len+1]);
248 path_len = strlen(ptr);
249 for (size_t i=0; i<path_len; i++)
251 if (ptr[i] == '/' || ptr[i] == '\\')
255 Error("Could not detect GameDLL path! Metamod cannot load[3].\n");
264 //WE NOW HAVE A GUESS AT THE MOD DIR. OH MY GOD.
266 snprintf(temp_path, sizeof(temp_path)-1,
272 g_ModPath.assign(temp_path);
274 snprintf(temp_path, sizeof(temp_path)-1,
280 FILE *fp = fopen(temp_path, "rt");
283 /* Do not error out here! It's possible the mod exists in the root directory, i.e.
284 * Dark Messiah. Let's check that just in case!
286 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s", curpath);
287 g_ModPath.assign(temp_path);
288 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s", g_ModPath.c_str(), "gameinfo.txt");
290 fp = fopen(temp_path, "rt");
293 /* Okay, we have to concede here. */
294 Error("Unable to open gameinfo.txt! Metamod cannot load.\n");
299 char key[128], val[128];
301 const char *gameinfo = "|gameinfo_path|";
302 size_t gameinfo_len = strlen(gameinfo);
304 bool gamebin = false;
309 fgets(buffer, sizeof(buffer)-1, fp);
310 len = strlen(buffer);
311 if (buffer[len-1] == '\n')
312 buffer[--len] = '\0';
313 UTIL_TrimComments(buffer);
314 UTIL_TrimLeft(buffer);
315 UTIL_TrimRight(buffer);
316 if (stricmp(buffer, "SearchPaths") == 0)
320 UTIL_KeySplit(buffer, key, sizeof(key)-1, val, sizeof(val)-1);
321 if (stricmp(key, "Game") == 0 || stricmp(key, "GameBin") == 0)
323 if (stricmp(key, "Game") == 0)
328 if (strncmp(val, gameinfo, gameinfo_len) == 0)
330 ptr = &(val[gameinfo_len]);
333 lptr = g_ModPath.c_str();
338 size_t ptr_len = strlen(ptr);
339 if (ptr[ptr_len] == '/' || ptr[ptr_len] == '\\')
340 ptr[--ptr_len] = '\0';
342 //no need to append "bin"
345 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s", lptr, ptr, SERVER_DLL);
346 } else if (!ptr[0]) {
347 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s", lptr, "bin", SERVER_DLL);
349 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s/%s", lptr, ptr, "bin", SERVER_DLL);
351 if (!UTIL_PathCmp(s_dllpath.c_str(), temp_path))
353 FILE *fp = fopen(temp_path, "rb");
356 //:TODO: Optimize this a bit!
357 SourceHook::List<GameDllInfo *>::iterator iter;
360 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
363 if (GetFileOfAddress((void *)pCheck->factory, buffer, sizeof(buffer)-1))
365 if (UTIL_PathCmp(temp_path, buffer))
375 HINSTANCE gamedll = dlmount(temp_path);
378 CreateInterfaceFn fn = (CreateInterfaceFn)dlsym(gamedll, "CreateInterface");
384 GameDllInfo *pInfo = new GameDllInfo;
386 pInfo->lib = gamedll;
387 pInfo->loaded = true;
388 pInfo->pGameDLL = NULL;
389 pInfo->pGameClients = (IServerGameClients *)((fn)(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
390 gamedll_list.push_back(pInfo);
398 if (!g_GameDll.loaded)
400 const char *str = "ServerGameDLL";
401 size_t len = strlen(str);
403 if (strncmp(iface, str, len) == 0)
405 //This is the interface we want! Right now we support versions 3 through 5.
406 g_GameDllVersion = atoi(&(iface[len]));
407 int sizeTooBig = 0; //rename this to sizeWrong in the future!
408 if (g_GameDllVersion < MIN_GAMEDLL_VERSION || g_GameDllVersion > MAX_GAMEDLL_VERSION)
410 //maybe this will get used in the future
411 sizeTooBig = g_GameDllVersion;
415 SourceHook::List<GameDllInfo *>::iterator iter;
416 GameDllInfo *pInfo = NULL;
418 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
421 ptr = (pInfo->factory)(iface, ret);
424 //this is our gamedll. unload the others.
425 gamedll_list.erase(iter);
427 pInfo->pGameDLL = static_cast<IServerGameDLL *>(ptr);
433 if (g_GameDll.loaded)
437 Error("This mod version requires a SourceMM update (ServerGameDLL%03d)!\n", sizeTooBig);
452 //:TODO: .. something a bit more intelligent?
453 Error("Engine requested unknown interface before GameDLL was known!\n");
458 //if we got here, there's definitely a gamedll.
459 IFACE_MACRO(g_GameDll.factory, GameDLL);
462 void ClearGamedllList()
464 SourceHook::List<GameDllInfo *>::iterator iter;
467 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
474 gamedll_list.clear();
477 void DLLShutdown_handler()
480 g_PluginMngr.UnloadAll();
482 // Add the FCVAR_GAMEDLL flag to our cvars so the engine removes them properly
483 g_SMConVarAccessor.MarkCommandsAsGameDLL();
484 g_SMConVarAccessor.UnregisterGameDLLCommands();
486 SH_CALL(dllExec, &IServerGameDLL::DLLShutdown)();
488 SH_RELEASE_CALLCLASS(dllExec);
491 g_SourceHook.CompleteShutdown();
493 if (g_GameDll.lib && g_GameDll.loaded)
494 dlclose(g_GameDll.lib);
495 memset(&g_GameDll, 0, sizeof(GameDllInfo));
497 RETURN_META(MRES_SUPERCEDE);
500 int LoadPluginsFromFile(const char *_file)
503 int total = 0, skipped=0;
507 fp = fopen(_file, "rt");
510 LogMessage("[META] Could not open plugins file %s\n", _file);
514 char buffer[255], error[255], full_path[255];
515 const char *ptr, *ext, *file;
520 fgets(buffer, sizeof(buffer)-1, fp);
521 length = strlen(buffer);
524 if (buffer[length-1] == '\n')
525 buffer[--length] = '\0';
527 UTIL_TrimLeft(buffer);
528 UTIL_TrimRight(buffer);
530 if (buffer[0] == '\0' || buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
533 if (buffer[0] == '"')
554 while (*cptr && isspace(*cptr))
557 UTIL_TrimRight(cptr);
558 if (*cptr && isalpha(*cptr))
560 g_PluginMngr.SetAlias(buffer, cptr);
572 //First find if it's an absolute path or not...
573 if (file[0] == '/' || strncmp(&(file[1]), ":\\", 2) == 0)
575 //If we're in an absolute path, ignore our normal heuristics
576 id = g_PluginMngr.Load(file, Pl_File, already, error, sizeof(error)-1);
577 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
579 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
587 //Attempt to find a file extension
588 ptr = UTIL_GetExtension(file);
589 //Add an extension if there's none there
592 #if defined WIN32 || defined _WIN32
600 //Format the new path
601 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
602 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error)-1);
603 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
605 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
618 LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
620 LogMessage("[META] Loaded %d plugins from file.", total);
626 //Wrapper function. This is called when the GameDLL thinks it's using
627 // the engine's real engineFactory.
628 void *EngineFactory(const char *iface, int *ret)
630 IFACE_MACRO(g_Engine.engineFactory, Engine);
633 //Wrapper function. This is called when the GameDLL thinks it's using
634 // the engine's real physicsFactory.
635 void *PhysicsFactory(const char *iface, int *ret)
637 IFACE_MACRO(g_Engine.physicsFactory, Physics);
640 //Wrapper function. This is called when the GameDLL thinks it's using
641 // the engine's real fileSystemFactory.
642 void *FileSystemFactory(const char *iface, int *ret)
644 IFACE_MACRO(g_Engine.fileSystemFactory, FileSystem);
647 void LogMessage(const char *msg, ...)
650 static char buffer[2048];
655 vsnprintf(buffer, sizeof(buffer)-5, msg, ap);
656 strcat(buffer, "\n");
659 if (!g_Engine.engine)
661 fprintf(stdout, "%s", buffer);
663 g_Engine.engine->LogPrint(buffer);
667 void LevelShutdown_handler(void)
672 g_SmmAPI.PathFormat(full_path, sizeof(full_path) - 1, "%s/%s", g_ModPath.c_str(), GetPluginsFile());
674 LoadPluginsFromFile(full_path);
676 bInFirstLevel = false;
679 ITER_EVENT(OnLevelShutdown, ());
681 RETURN_META(MRES_IGNORED);
684 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
686 if (!g_SmmAPI.CacheSuccessful())
688 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
689 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
692 #if (defined _DEBUG || defined DEBUG) && (defined OS_WIN32)
693 SetUnhandledExceptionFilter(NULL);
696 ITER_EVENT(OnLevelInit, (pMapName, pMapEntities, pOldLevel, pLandmarkName, loadGame, background));
698 RETURN_META_VALUE(MRES_IGNORED, false);
701 #if defined __GNUC__ && (__GNUC__ == 3 || __GNUC__ == 4)
702 void * operator new(size_t size) {
703 return(calloc(1, size));
706 void * operator new[](size_t size) {
707 return(calloc(1, size));
710 void operator delete(void * ptr) {
715 void operator delete[](void * ptr) {