Added some extra information to the "meta game" command: Description and Interface
(This is BAILOPAN's excellent idea!)
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(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 if (!gParsedGameInfo)
177 gParsedGameInfo = true;
178 char curpath[260] = {0};
179 char dllpath[260] = {0};
180 getcwd(curpath, sizeof(curpath)-1);
181 if (!GetFileOfAddress((void *)CreateInterface, dllpath, sizeof(dllpath)-1))
183 Error("GetFileOfAddress() failed! Metamod cannot load.");
186 SourceHook::String s_dllpath(dllpath);
187 //begin the heuristics for searching for the mod path (these are quite ugly).
188 //for OS compatibility purposes, we're going to do case insensitivity on windows.
189 size_t path_len = strlen(curpath);
190 size_t dll_len = strlen(dllpath);
192 //strip the dll path off
193 //:TODO: with path stuff - in Linux, \ can exist in a file path as a non-seperator!
194 for (size_t i=dll_len-1; i>0; i--)
196 if (dllpath[i] == '\\' || dllpath[i] == '/')
200 //save path by stripping off file name and ending terminator
207 //strip absolute path terminators if any!
208 if (curpath[path_len-1] == '/' || curpath[path_len-1] == '\\')
209 curpath[--path_len] = '\0';
211 //if the base path doesn't fit into the module path, something is wrong!
212 // ex: c:\games\srcds
214 if (path_len > dll_len)
216 Error("Could not detect GameDLL path! Metamod cannot load[1].");
220 //we are now in such a position that the two dir names SHOULD MATCH!
221 typedef int (*STRNCMP)(const char *str1, const char *str2, size_t n);
229 if ( ((cmp)(curpath, dllpath, path_len)) != 0 )
231 //:TODO: In this case, we should read /proc/self/maps and find srcds!
232 Error("Could not detect GameDLL path! Metamod cannot load[2].");
235 //this will skip past the dir and its separator char
236 char *ptr = &(dllpath[path_len+1]);
237 path_len = strlen(ptr);
238 for (size_t i=0; i<path_len; i++)
240 if (ptr[i] == '/' || ptr[i] == '\\')
244 Error("Could not detect GameDLL path! Metamod cannot load[3].");
253 //WE NOW HAVE A GUESS AT THE MOD DIR. OH MY GOD.
255 snprintf(temp_path, sizeof(temp_path)-1,
261 g_ModPath.assign(temp_path);
263 snprintf(temp_path, sizeof(temp_path)-1,
269 FILE *fp = fopen(temp_path, "rt");
272 Error("Unable to open gameinfo.txt! Metamod cannot load.");
276 char key[128], val[128];
278 const char *gameinfo = "|gameinfo_path|";
279 size_t gameinfo_len = strlen(gameinfo);
281 bool gamebin = false;
286 fgets(buffer, sizeof(buffer)-1, 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, gameinfo_len) == 0)
307 ptr = &(val[gameinfo_len]);
310 lptr = g_ModPath.c_str();
315 size_t ptr_len = strlen(ptr);
316 if (ptr[ptr_len] == '/' || ptr[ptr_len] == '\\')
317 ptr[--ptr_len] = '\0';
319 //no need to append "bin"
322 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s", lptr, ptr, SERVER_DLL);
323 } else if (ptr[0] == NULL) {
324 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s", lptr, "bin", SERVER_DLL);
326 g_SmmAPI.PathFormat(temp_path, sizeof(temp_path)-1, "%s/%s/%s/%s", lptr, ptr, "bin", SERVER_DLL);
328 if (!UTIL_PathCmp(s_dllpath.c_str(), temp_path))
330 FILE *fp = fopen(temp_path, "rb");
333 //:TODO: Optimize this a bit!
334 SourceHook::List<GameDllInfo *>::iterator iter;
337 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
340 if (GetFileOfAddress(pCheck->factory, buffer, sizeof(buffer)-1))
342 if (UTIL_PathCmp(temp_path, buffer))
352 HINSTANCE gamedll = dlmount(temp_path);
355 CreateInterfaceFn fn = (CreateInterfaceFn)dlsym(gamedll, "CreateInterface");
361 GameDllInfo *pInfo = new GameDllInfo;
363 pInfo->lib = gamedll;
364 pInfo->loaded = true;
365 pInfo->pGameDLL = NULL;
366 pInfo->pGameClients = (IServerGameClients *)((fn)(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
367 gamedll_list.push_back(pInfo);
375 if (!g_GameDll.loaded)
377 const char *str = "ServerGameDLL";
378 size_t len = strlen(str);
380 if (strncmp(iface, str, len) == 0)
382 //This is the interface we want! Right now we support versions 3 through 5.
383 g_GameDllVersion = atoi(&(iface[len]));
384 int sizeTooBig = 0; //rename this to sizeWrong in the future!
385 if (g_GameDllVersion < MIN_GAMEDLL_VERSION || g_GameDllVersion > MAX_GAMEDLL_VERSION)
387 //maybe this will get used in the future
388 sizeTooBig = g_GameDllVersion;
392 SourceHook::List<GameDllInfo *>::iterator iter;
393 GameDllInfo *pInfo = NULL;
395 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
398 ptr = (pInfo->factory)(iface, ret);
401 //this is our gamedll. unload the others.
402 gamedll_list.erase(iter);
404 pInfo->pGameDLL = static_cast<IServerGameDLL *>(ptr);
410 if (g_GameDll.loaded)
414 Error("This mod version requires a SourceMM update (ServerGameDLL%03d)!", sizeTooBig);
429 //:TODO: .. something a bit more intelligent?
430 Error("Engine requested unknown interface before GameDLL was known!");
435 //if we got here, there's definitely a gamedll.
436 IFACE_MACRO(g_GameDll.factory, GameDLL);
439 void ClearGamedllList()
441 SourceHook::List<GameDllInfo *>::iterator iter;
444 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
451 gamedll_list.clear();
454 void DLLShutdown_handler()
457 g_PluginMngr.UnloadAll();
459 // Add the FCVAR_GAMEDLL flag to our cvars so the engine removes them properly
460 g_SMConVarAccessor.MarkCommandsAsGameDLL();
461 g_SMConVarAccessor.UnregisterGameDLLCommands();
463 SH_CALL(dllExec, &IServerGameDLL::DLLShutdown)();
465 SH_RELEASE_CALLCLASS(dllExec);
468 g_SourceHook.CompleteShutdown();
470 if (g_GameDll.lib && g_GameDll.loaded)
471 dlclose(g_GameDll.lib);
472 memset(&g_GameDll, 0, sizeof(GameDllInfo));
474 RETURN_META(MRES_SUPERCEDE);
477 int LoadPluginsFromFile(const char *_file)
480 int total = 0, skipped=0;
484 fp = fopen(_file, "rt");
487 LogMessage("[META] Could not open plugins file %s\n", _file);
491 char buffer[255], error[255], full_path[128];
492 const char *ptr, *ext, *file;
497 fgets(buffer, sizeof(buffer)-1, fp);
498 length = strlen(buffer);
501 if (buffer[length-1] == '\n')
502 buffer[--length] = '\0';
504 UTIL_TrimLeft(buffer);
505 UTIL_TrimRight(buffer);
507 if (buffer[0] == '\0' || buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
510 if (buffer[0] == '"')
531 while (*cptr && isspace(*cptr))
534 UTIL_TrimRight(cptr);
535 if (*cptr && isalpha(*cptr))
537 g_PluginMngr.SetAlias(buffer, cptr);
549 //First find if it's an absolute path or not...
550 if (file[0] == '/' || strncmp(&(file[1]), ":\\", 2) == 0)
552 //If we're in an absolute path, ignore our normal heuristics
553 id = g_PluginMngr.Load(file, Pl_File, already, error, sizeof(error)-1);
554 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
556 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
564 //Attempt to find a file extension
565 ptr = UTIL_GetExtension(file);
566 //Add an extension if there's none there
569 #if defined WIN32 || defined _WIN32
577 //Format the new path
578 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
579 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error)-1);
580 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
582 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
595 LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
597 LogMessage("[META] Loaded %d plugins from file.", total);
603 //Wrapper function. This is called when the GameDLL thinks it's using
604 // the engine's real engineFactory.
605 void *EngineFactory(const char *iface, int *ret)
607 IFACE_MACRO(g_Engine.engineFactory, Engine);
610 //Wrapper function. This is called when the GameDLL thinks it's using
611 // the engine's real physicsFactory.
612 void *PhysicsFactory(const char *iface, int *ret)
614 IFACE_MACRO(g_Engine.physicsFactory, Physics);
617 //Wrapper function. This is called when the GameDLL thinks it's using
618 // the engine's real fileSystemFactory.
619 void *FileSystemFactory(const char *iface, int *ret)
621 IFACE_MACRO(g_Engine.fileSystemFactory, FileSystem);
624 void LogMessage(const char *msg, ...)
627 static char buffer[2048];
632 vsnprintf(buffer, sizeof(buffer)-5, msg, ap);
633 strcat(buffer, "\n");
636 if (!g_Engine.engine)
638 fprintf(stdout, "%s", buffer);
640 g_Engine.engine->LogPrint(buffer);
644 void LevelShutdown_handler(void)
649 g_SmmAPI.PathFormat(full_path, sizeof(full_path) - 1, "%s/%s", g_ModPath.c_str(), GetPluginsFile());
651 LoadPluginsFromFile(full_path);
653 bInFirstLevel = false;
656 ITER_EVENT(OnLevelShutdown, ());
658 RETURN_META(MRES_IGNORED);
661 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
663 if (!g_SmmAPI.CacheSuccessful())
665 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
666 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
669 #if (defined _DEBUG || defined DEBUG) && (defined OS_WIN32)
670 SetUnhandledExceptionFilter(NULL);
673 ITER_EVENT(OnLevelInit, (pMapName, pMapEntities, pOldLevel, pLandmarkName, loadGame, background));
675 RETURN_META_VALUE(MRES_IGNORED, false);
678 #if defined __GNUC__ && (__GNUC__ == 3)
679 void * ::operator new(size_t size) {
680 return(calloc(1, size));
683 void * ::operator new[](size_t size) {
684 return(calloc(1, size));
687 void ::operator delete(void * ptr) {
692 void ::operator delete[](void * ptr) {