dvander@608: /** ds@669: * vim: set ts=4 sw=4 tw=99 noet : dvander@608: * ====================================================== dvander@608: * Metamod:Source ds@669: * Copyright (C) 2004-2009 AlliedModders LLC and authors. dvander@608: * All rights reserved. dvander@608: * ====================================================== dvander@608: * dvander@608: * This software is provided 'as-is', without any express or implied warranty. dvander@608: * In no event will the authors be held liable for any damages arising from dvander@608: * the use of this software. dvander@608: * dvander@608: * Permission is granted to anyone to use this software for any purpose, dvander@608: * including commercial applications, and to alter it and redistribute it dvander@608: * freely, subject to the following restrictions: dvander@608: * dvander@608: * 1. The origin of this software must not be misrepresented; you must not dvander@608: * claim that you wrote the original software. If you use this software in a dvander@608: * product, an acknowledgment in the product documentation would be dvander@608: * appreciated but is not required. dvander@608: * 2. Altered source versions must be plainly marked as such, and must not be dvander@608: * misrepresented as being the original software. dvander@608: * 3. This notice may not be removed or altered from any source distribution. dvander@608: */ dvander@608: dvander@546: #include dvander@547: #include dvander@546: #include dvander@546: #include dvander@546: #include "loader.h" dvander@546: #include dvander@546: #include dvander@546: #include "serverplugin.h" ds@683: #include "gamedll.h" dvander@546: dvander@546: typedef enum dvander@546: { dvander@546: PLUGIN_CONTINUE = 0, dvander@546: PLUGIN_OVERRIDE, dvander@546: PLUGIN_STOP, dvander@546: } PLUGIN_RESULT; dvander@546: dvander@546: typedef enum dvander@546: { dvander@546: eQueryCvarValueStatus_ValueIntact=0, dvander@546: eQueryCvarValueStatus_CvarNotFound=1, dvander@546: eQueryCvarValueStatus_NotACvar=2, dvander@546: eQueryCvarValueStatus_CvarProtected=3 dvander@546: } EQueryCvarValueStatus; dvander@546: dvander@546: typedef int QueryCvarCookie_t; dvander@546: class CCommand; dvander@546: class IServerPluginCallbacks; dvander@546: struct edict_t; dvander@546: dvander@546: class IRandomThings dvander@546: { dvander@546: public: dvander@546: virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args) dvander@546: { dvander@546: return PLUGIN_CONTINUE; dvander@546: } dvander@546: }; dvander@546: dvander@579: IVspBridge *vsp_bridge = NULL; dvander@579: dvander@546: /** dvander@546: * The vtable must match the general layout for ISPC. We modify the vtable dvander@546: * based on what we get back. dvander@546: */ dvander@546: class ServerPlugin dvander@546: { skamonkey@820: char game_name[128]; dvander@546: unsigned int vsp_version; dvander@546: bool load_allowed; dvander@546: public: dvander@546: ServerPlugin() dvander@546: { dvander@546: load_allowed = false; dvander@546: } dvander@546: virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory) dvander@546: { dvander@546: if (!load_allowed) dvander@546: return false; dvander@546: dvander@546: load_allowed = false; dvander@546: ds@683: /* Backend should already filled in if loaded as gamedll */ ds@683: if (gamedll_bridge == NULL) ds@637: { skamonkey@820: if (!mm_GetGameName(game_name, sizeof(game_name))) ds@683: { ds@683: return false; ds@683: } ds@683: ds@683: mm_backend = mm_DetermineBackend(engineFactory, game_name); ds@637: } ds@637: ds@683: if (mm_backend == MMBackend_UNKNOWN) dvander@546: { dvander@579: mm_LogFatal("Could not detect engine version"); dvander@546: return false; dvander@546: } ds@729: ds@729: void **this_vtable; ds@729: this_vtable = (void **)*(void **)this; ds@729: skamonkey@850: if (mm_backend != MMBackend_Episode1 skamonkey@850: && mm_backend != MMBackend_DarkMessiah) dvander@546: { dvander@546: /* We need to insert the right type of call into this vtable */ dvander@546: void **vtable_src; dvander@546: IRandomThings sample; dvander@546: SourceHook::MemFuncInfo mfp_dest, mfp_src; dvander@546: dvander@546: mfp_dest.isVirtual = false; dvander@546: mfp_src.isVirtual = false; dvander@546: dvander@546: SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest); dvander@546: SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src); dvander@546: dvander@546: assert(mfp_dest.isVirtual); dvander@546: assert(mfp_dest.thisptroffs == 0); dvander@546: assert(mfp_dest.vtbloffs == 0); dvander@546: assert(mfp_src.isVirtual); dvander@546: assert(mfp_src.thisptroffs == 0); dvander@546: assert(mfp_src.vtbloffs == 0); dvander@546: dvander@546: vtable_src = (void **)*(void **)&sample; ds@729: SourceHook::SetMemAccess(&this_vtable[mfp_dest.vtblindex], ds@687: sizeof(void*), dvander@546: SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC); ds@729: this_vtable[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex]; ds@729: } ds@728: ds@729: /* AS inserted ClientFullyConnect into vtable, so move entries up on older engines */ skamonkey@850: if (mm_backend != MMBackend_AlienSwarm skamonkey@850: && mm_backend != MMBackend_Portal2 skamonkey@850: && mm_backend != MMBackend_CSGO skamonkey@850: && mm_backend != MMBackend_DOTA) ds@729: { ds@729: SourceHook::MemFuncInfo mfp_fconnect; ds@729: mfp_fconnect.isVirtual = false; ds@728: ds@729: SourceHook::GetFuncInfo(&ServerPlugin::ClientFullyConnect, mfp_fconnect); ds@728: ds@729: assert(mfp_fconnect.isVirtual); ds@729: assert(mfp_fconnect.thisptroffs == 0); ds@729: assert(mfp_fconnect.vtbloffs == 0); ds@728: ds@729: /* Shifting ClientDisconnect through OnQueryCvarValueFinished up into slot for ds@729: * ClientFullyConnect (8 entries) ds@729: */ ds@729: SourceHook::SetMemAccess(&this_vtable[mfp_fconnect.vtblindex], ds@729: sizeof(void *) * 8, ds@729: SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC); ds@729: memmove(&this_vtable[mfp_fconnect.vtblindex], ds@729: &this_vtable[mfp_fconnect.vtblindex + 1], ds@729: sizeof(void *) * 8); dvander@546: } dvander@546: dvander@546: char error[255]; ds@683: if (gamedll_bridge == NULL) dvander@546: { ds@683: if (!mm_LoadMetamodLibrary(mm_backend, error, sizeof(error))) ds@683: { ds@683: mm_LogFatal("Detected engine %d but could not load: %s", mm_backend, error); ds@683: return false; ds@683: } dvander@546: } dvander@546: dvander@546: typedef IVspBridge *(*GetVspBridge)(); dvander@546: GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge"); dvander@546: if (get_bridge == NULL) dvander@546: { ds@683: if (gamedll_bridge == NULL) ds@683: { ds@683: mm_UnloadMetamodLibrary(); ds@683: } ds@683: mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", mm_backend); dvander@546: return false; dvander@546: } dvander@546: dvander@579: vsp_bridge = get_bridge(); dvander@546: dvander@546: vsp_bridge_info info; dvander@546: dvander@546: info.engineFactory = engineFactory; dvander@546: info.gsFactory = gsFactory; dvander@546: info.vsp_callbacks = (IServerPluginCallbacks*)this; dvander@546: info.vsp_version = vsp_version; dvander@546: dvander@547: strcpy(error, "Unknown error"); dvander@579: if (!vsp_bridge->Load(&info, error, sizeof(error))) dvander@546: { dvander@579: vsp_bridge = NULL; ds@683: if (gamedll_bridge == NULL) ds@683: { ds@683: mm_UnloadMetamodLibrary(); ds@683: } ds@683: mm_LogFatal("Unknown error loading Metamod for engine %d: %s", mm_backend, error); dvander@546: return false; dvander@546: } dvander@546: dvander@546: return true; dvander@546: } dvander@546: virtual void Unload() dvander@546: { dvander@579: if (vsp_bridge == NULL) dvander@546: return; dvander@579: vsp_bridge->Unload(); ds@683: ds@683: if (gamedll_bridge == NULL) ds@683: { ds@683: mm_UnloadMetamodLibrary(); ds@683: } dvander@546: } dvander@546: virtual void Pause() dvander@546: { dvander@546: } dvander@546: virtual void UnPause() dvander@546: { dvander@546: } dvander@546: virtual const char *GetPluginDescription() dvander@546: { dvander@579: if (vsp_bridge == NULL) dvander@546: return "Metamod:Source Loader Shim"; dvander@579: return vsp_bridge->GetDescription(); dvander@546: } dvander@546: virtual void LevelInit(char const *pMapName) dvander@546: { dvander@546: } dvander@546: virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax) dvander@546: { dvander@546: } dvander@546: virtual void GameFrame(bool simulating) dvander@546: { dvander@546: } dvander@546: virtual void LevelShutdown() dvander@546: { dvander@546: } dvander@546: virtual void ClientActive(edict_t *pEntity) dvander@546: { dvander@546: } ds@728: virtual void ClientFullyConnect(edict_t *pEntity) ds@728: { ds@728: } dvander@546: virtual void ClientDisconnect(edict_t *pEntity) dvander@546: { dvander@546: } dvander@546: virtual void ClientPutInServer(edict_t *pEntity, char const *playername) dvander@546: { dvander@546: } dvander@546: virtual void SetCommandClient(int index) dvander@546: { dvander@546: } dvander@546: virtual void ClientSettingsChanged(edict_t *pEdict) dvander@546: { dvander@546: } dvander@546: virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect, dvander@546: edict_t *pEntity, dvander@546: const char *pszName, dvander@546: const char *pszAddress, dvander@546: char *reject, dvander@546: int maxrejectlen) dvander@546: { dvander@546: return PLUGIN_CONTINUE; dvander@546: } dvander@546: virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity) dvander@546: { dvander@546: return PLUGIN_CONTINUE; dvander@546: } dvander@546: virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID) dvander@546: { dvander@546: return PLUGIN_CONTINUE; dvander@546: } dvander@546: virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie, dvander@546: edict_t *pPlayerEntity, dvander@546: EQueryCvarValueStatus eStatus, dvander@546: const char *pCvarName, dvander@546: const char *pCvarValue) dvander@546: { dvander@546: } dvander@546: void PrepForLoad(unsigned int version) dvander@546: { dvander@546: vsp_version = version; dvander@546: load_allowed = true; dvander@546: } dvander@546: }; dvander@546: dvander@546: ServerPlugin mm_vsp_callbacks; dvander@546: dvander@546: void *mm_GetVspCallbacks(unsigned int version) dvander@546: { dvander@579: if (vsp_bridge != NULL) dvander@546: return NULL; dvander@546: dvander@555: /* Only support versions 1 or 2 right now */ dvander@555: if (version > 2) dvander@555: return NULL; dvander@555: dvander@546: mm_vsp_callbacks.PrepForLoad(version); dvander@546: dvander@546: return &mm_vsp_callbacks; dvander@546: } dvander@546: