Added ISmmAPI::GetVSPVersion() to get highest supported IServerPluginCallbacks interface version
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 SourceHook::String g_SmmPath;
54 PluginId g_PLID = Pl_Console; /* Technically, SourceMM is the "Console" plugin... :p */
55 bool bInFirstLevel = true;
56 bool gParsedGameInfo = false;
57 bool bGameInit = false;
58 SourceHook::List<GameDllInfo *> gamedll_list;
59 SourceHook::CallClass<IServerGameDLL> *g_GameDllPatch;
60 int g_GameDllVersion = 0;
62 const char VSPIFACE[] = "ISERVERPLUGINCALLBACKS";
63 const char GAMEINFO_PATH[] = "|gameinfo_path|";
65 void ClearGamedllList();
68 #define IFACE_MACRO(orig,nam) \
69 CPluginManager::CPlugin *pl; \
70 SourceHook::List<IMetamodListener *>::iterator event; \
71 IMetamodListener *api; \
74 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
76 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
78 mret = IFACE_FAILED; \
79 if ( (val=api->On##nam##Query(iface, &mret)) != NULL ) { \
80 if (ret) *ret = mret; \
85 return (orig)(iface, ret);
87 #define ITER_EVENT(evn, args) \
88 CPluginManager::CPlugin *pl; \
89 SourceHook::List<IMetamodListener *>::iterator event; \
90 IMetamodListener *api; \
91 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
93 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++) { \
99 ///////////////////////////////////
100 // Main code for HL2 Interaction //
101 ///////////////////////////////////
103 /* Initialize everything here */
104 void InitMainStates()
106 char full_path[PATH_SIZE] = {0};
107 GetFileOfAddress((void *)g_GameDll.factory, full_path, sizeof(full_path));
108 g_BinPath.assign(full_path);
110 /* Like Metamod, reload plugins at the end of the map.
111 * This is so plugins can hook everything on load, BUT, new plugins will be reloaded
112 * if the server is shut down (silly, but rare case).
114 bInFirstLevel = true;
116 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit, false);
117 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLInit, g_GameDll.pGameDLL, DLLInit_Post, true);
118 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, DLLShutdown, g_GameDll.pGameDLL, DLLShutdown_handler, false);
119 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelShutdown, g_GameDll.pGameDLL, LevelShutdown_handler, true);
120 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, LevelInit, g_GameDll.pGameDLL, LevelInit_handler, true);
121 SH_ADD_HOOK_STATICFUNC(IServerGameDLL, GameInit, g_GameDll.pGameDLL, GameInit_handler, false);
123 if (g_GameDll.pGameClients)
125 SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, g_GameDll.pGameClients, ClientCommand_handler, false);
127 /* If IServerGameClients isn't found, this really isn't a fatal error so... */
128 LogMessage("[META] Warning: Could not find IServerGameClients!");
129 LogMessage("[META] Warning: The 'meta' command will not be available to clients.");
133 bool DLLInit(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
135 g_Engine.engineFactory = engineFactory;
136 g_Engine.fileSystemFactory = filesystemFactory;
137 g_Engine.physicsFactory = physicsFactory;
138 g_Engine.pGlobals = pGlobals;
140 g_Engine.engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL));
141 if (!g_Engine.engine)
143 Error("Could not find IVEngineServer! Metamod cannot load.");
146 g_Engine.icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION , NULL));
149 Error("Could not find ICvar! Metamod cannot load.");
153 g_Engine.loaded = true;
155 /* Initialize our console hooks */
156 ConCommandBaseMgr::OneTimeInit(static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor));
158 g_GameDllPatch = SH_GET_CALLCLASS(g_GameDll.pGameDLL);
160 if (!g_SmmAPI.CacheCmds())
162 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
163 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
166 if (!g_SmmAPI.CacheUserMessages())
168 /* Don't know of a mod that has stripped out user messages completely,
169 * but perhaps should do something different here?
171 LogMessage("[META] Warning: Failed to get list of user messages.");
172 LogMessage("[META] Warning: The 'meta game' command will not display user messages.");
175 const char *pluginFile = g_Engine.icvar->GetCommandLineValue("mm_pluginsfile");
178 pluginFile = GetPluginsFile();
182 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), pluginFile);
184 LoadPluginsFromFile(full_path);
186 bInFirstLevel = true;
188 RETURN_META_VALUE(MRES_IGNORED, true);
191 bool GameInit_handler()
198 if (g_SmmAPI.VSPEnabled())
200 g_SmmAPI.LoadAsVSP();
205 RETURN_META_VALUE(MRES_IGNORED, true);
208 bool DLLInit_Post(CreateInterfaceFn engineFactory, CreateInterfaceFn physicsFactory, CreateInterfaceFn filesystemFactory, CGlobalVars *pGlobals)
210 g_PluginMngr.SetAllLoaded();
211 RETURN_META_VALUE(MRES_IGNORED, true);
214 /* This is where the magic happens */
215 SMM_API void *CreateInterface(const char *iface, int *ret)
217 /* Prevent loading of self as a SourceMM plugin or Valve server plugin :x */
218 if (strcmp(iface, PLAPI_NAME) == 0)
220 Warning("Do not try loading Metamod:Source as a SourceMM or Valve server plugin.\n");
230 if (strncmp(iface, VSPIFACE, 22) == 0)
232 g_VspVersion = atoi(&(iface[22]));
234 if (g_VspVersion <= MAX_VSP_VERSION)
240 return &g_VspListener;
244 if (!gParsedGameInfo)
246 gParsedGameInfo = true;
247 const char *gameDir = NULL;
248 char gamePath[PATH_SIZE];
249 char smmPath[PATH_SIZE];
251 /* Get path to SourceMM DLL */
252 if (!GetFileOfAddress((void *)CreateInterface, smmPath, sizeof(smmPath)))
254 Error("GetFileOfAddress() failed! Metamod cannot load.\n");
258 g_SmmPath.assign(smmPath);
260 /* Get value of -game from command line, defaulting to hl2 as engine seems to do */
261 gameDir = CommandLine()->ParmValue("-game", "hl2");
263 /* Get absolute path */
264 abspath(gamePath, gameDir);
265 g_ModPath.assign(gamePath);
267 char tempPath[PATH_SIZE];
269 /* Path to gameinfo.txt */
270 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s", g_ModPath.c_str(), "gameinfo.txt");
272 FILE *fp = fopen(tempPath, "rt");
276 Error("Unable to open gameinfo.txt! Metamod cannot load.\n");
281 char key[128], val[128];
284 bool gamebin = false;
287 char curPath[PATH_SIZE];
289 getcwd(curPath, PATH_SIZE);
294 fgets(buffer, sizeof(buffer), fp);
295 len = strlen(buffer);
296 if (buffer[len-1] == '\n')
297 buffer[--len] = '\0';
298 UTIL_TrimComments(buffer);
299 UTIL_TrimLeft(buffer);
300 UTIL_TrimRight(buffer);
301 if (stricmp(buffer, "SearchPaths") == 0)
305 UTIL_KeySplit(buffer, key, sizeof(key) - 1, val, sizeof(val) - 1);
306 if (stricmp(key, "Game") == 0 || stricmp(key, "GameBin") == 0)
308 if (stricmp(key, "Game") == 0)
313 if (strncmp(val, GAMEINFO_PATH, sizeof(GAMEINFO_PATH) - 1) == 0)
315 ptr = &(val[sizeof(GAMEINFO_PATH) - 1]);
318 lptr = g_ModPath.c_str();
324 size_t ptr_len = strlen(ptr);
325 if (ptr[ptr_len] == '/' || ptr[ptr_len] == '\\')
326 ptr[--ptr_len] = '\0';
328 /* No need to append "bin" if key is GameBin */
331 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s", lptr, ptr, SERVER_DLL);
332 } else if (!ptr[0]) {
333 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s", lptr, "bin", SERVER_DLL);
335 g_SmmAPI.PathFormat(tempPath, PATH_SIZE, "%s/%s/%s/%s", lptr, ptr, "bin", SERVER_DLL);
338 /* If not path to SourceMM... */
339 if (!UTIL_PathCmp(smmPath, tempPath))
341 FILE *fp = fopen(tempPath, "rb");
344 //:TODO: Optimize this a bit!
345 SourceHook::List<GameDllInfo *>::iterator iter;
348 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
351 if (GetFileOfAddress((void *)pCheck->factory, buffer, sizeof(buffer)))
353 if (UTIL_PathCmp(tempPath, buffer))
363 HINSTANCE gamedll = dlmount(tempPath);
366 CreateInterfaceFn fn = (CreateInterfaceFn)dlsym(gamedll, "CreateInterface");
372 GameDllInfo *pInfo = new GameDllInfo;
374 pInfo->lib = gamedll;
375 pInfo->loaded = true;
376 pInfo->pGameDLL = NULL;
377 pInfo->pGameClients = (IServerGameClients *)((fn)(INTERFACEVERSION_SERVERGAMECLIENTS, NULL));
378 gamedll_list.push_back(pInfo);
386 if (!g_GameDll.loaded)
388 const char *str = "ServerGameDLL";
389 size_t len = strlen(str);
391 if (strncmp(iface, str, len) == 0)
393 /* This is the interface we want! Right now we support versions 3 through 8 */
394 g_GameDllVersion = atoi(&(iface[len]));
395 int sizeTooBig = 0; //rename this to sizeWrong in the future!
396 if (g_GameDllVersion < MIN_GAMEDLL_VERSION || g_GameDllVersion > MAX_GAMEDLL_VERSION)
398 /* Maybe this will get used in the future */
399 sizeTooBig = g_GameDllVersion;
405 SourceHook::List<GameDllInfo *>::iterator iter;
406 GameDllInfo *pInfo = NULL;
408 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
411 ptr = (pInfo->factory)(iface, ret);
414 /* This is our GameDLL. Unload the others. */
415 gamedll_list.erase(iter);
417 pInfo->pGameDLL = static_cast<IServerGameDLL *>(ptr);
423 if (g_GameDll.loaded)
427 Error("This mod version requires a SourceMM update (ServerGameDLL%03d)!\n", sizeTooBig);
443 /* wtf do we do... */
444 /* :TODO: .. something a bit more intelligent? */
445 Error("Engine requested unknown interface before GameDLL was known!\n");
450 /* If we got here, there's definitely a GameDLL */
451 IFACE_MACRO(g_GameDll.factory, GameDLL);
454 void ClearGamedllList()
456 SourceHook::List<GameDllInfo *>::iterator iter;
459 for (iter=gamedll_list.begin(); iter!=gamedll_list.end(); iter++)
466 gamedll_list.clear();
469 void DLLShutdown_handler()
472 g_PluginMngr.UnloadAll();
474 /* Add the FCVAR_GAMEDLL flag to our cvars so the engine removes them properly */
475 g_SMConVarAccessor.MarkCommandsAsGameDLL();
476 g_SMConVarAccessor.UnregisterGameDLLCommands();
478 SH_CALL(g_GameDllPatch, &IServerGameDLL::DLLShutdown)();
480 SH_RELEASE_CALLCLASS(g_GameDllPatch);
481 g_GameDllPatch = NULL;
483 g_SourceHook.CompleteShutdown();
485 if (g_GameDll.lib && g_GameDll.loaded)
486 dlclose(g_GameDll.lib);
487 memset(&g_GameDll, 0, sizeof(GameDllInfo));
489 RETURN_META(MRES_SUPERCEDE);
492 int LoadPluginsFromFile(const char *_file)
495 int total = 0, skipped=0;
499 fp = fopen(_file, "rt");
502 LogMessage("[META] Could not open plugins file %s\n", _file);
506 char buffer[255], error[255], full_path[255];
507 const char *ptr, *ext, *file;
512 fgets(buffer, sizeof(buffer), fp);
513 length = strlen(buffer);
516 if (buffer[length-1] == '\n')
517 buffer[--length] = '\0';
519 UTIL_TrimLeft(buffer);
520 UTIL_TrimRight(buffer);
522 if (buffer[0] == '\0' || buffer[0] == ';' || strncmp(buffer, "//", 2) == 0)
525 if (buffer[0] == '"')
546 while (*cptr && isspace(*cptr))
549 UTIL_TrimRight(cptr);
550 if (*cptr && isalpha(*cptr))
552 g_PluginMngr.SetAlias(buffer, cptr);
564 /* First find if it's an absolute path or not... */
565 if (file[0] == '/' || strncmp(&(file[1]), ":\\", 2) == 0)
567 /* If we're in an absolute path, ignore our normal heuristics */
568 id = g_PluginMngr.Load(file, Pl_File, already, error, sizeof(error));
569 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
571 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
592 /* Format the new path */
593 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
594 id = g_PluginMngr.Load(full_path, Pl_File, already, error, sizeof(error));
595 if (id < Pl_MinId || g_PluginMngr.FindById(id)->m_Status < Pl_Paused)
597 LogMessage("[META] Failed to load plugin %s. %s", buffer, error);
610 LogMessage("[META] Loaded %d plugins from file (%d already loaded)", total, skipped);
612 LogMessage("[META] Loaded %d plugins from file.", total);
618 /* Wrapper function. This is called when the GameDLL thinks it's using
619 * the engine's real engineFactory.
621 void *EngineFactory(const char *iface, int *ret)
623 IFACE_MACRO(g_Engine.engineFactory, Engine);
626 /* Wrapper function. This is called when the GameDLL thinks it's using
627 * the engine's real physicsFactory.
629 void *PhysicsFactory(const char *iface, int *ret)
631 IFACE_MACRO(g_Engine.physicsFactory, Physics);
634 /* Wrapper function. This is called when the GameDLL thinks it's using
635 * the engine's real fileSystemFactory.
637 void *FileSystemFactory(const char *iface, int *ret)
639 IFACE_MACRO(g_Engine.fileSystemFactory, FileSystem);
642 void LogMessage(const char *msg, ...)
645 static char buffer[2048];
648 size_t len = vsnprintf(buffer, sizeof(buffer) - 2, msg, ap);
651 buffer[len++] = '\n';
654 if (!g_Engine.engine)
656 fprintf(stdout, "%s", buffer);
658 g_Engine.engine->LogPrint(buffer);
662 void LevelShutdown_handler(void)
667 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
669 LoadPluginsFromFile(full_path);
671 bInFirstLevel = false;
674 ITER_EVENT(OnLevelShutdown, ());
676 RETURN_META(MRES_IGNORED);
679 bool LevelInit_handler(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
681 if (!g_SmmAPI.CmdCacheSuccessful())
683 LogMessage("[META] Warning: Failed to initialize Con_Printf. Defaulting to Msg().");
684 LogMessage("[META] Warning: Console messages will not be redirected to rcon console.");
687 ITER_EVENT(OnLevelInit, (pMapName, pMapEntities, pOldLevel, pLandmarkName, loadGame, background));
689 RETURN_META_VALUE(MRES_IGNORED, false);
692 #if defined __GNUC__ && (__GNUC__ == 3 || __GNUC__ == 4)
693 void * operator new(size_t size) {
694 return(calloc(1, size));
697 void * operator new[](size_t size) {
698 return(calloc(1, size));
701 void operator delete(void * ptr) {
706 void operator delete[](void * ptr) {