2 * vim: set ts=4 sw=4 tw=99 noet :
3 * ======================================================
5 * Copyright (C) 2004-2009 AlliedModders LLC and authors.
7 * ======================================================
9 * This software is provided 'as-is', without any express or implied warranty.
10 * In no event will the authors be held liable for any damages arising from
11 * the use of this software.
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software in a
19 * product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
31 #include <sh_memfuncinfo.h>
32 #include <sh_memory.h>
33 #include "serverplugin.h"
45 eQueryCvarValueStatus_ValueIntact=0,
46 eQueryCvarValueStatus_CvarNotFound=1,
47 eQueryCvarValueStatus_NotACvar=2,
48 eQueryCvarValueStatus_CvarProtected=3
49 } EQueryCvarValueStatus;
51 typedef int QueryCvarCookie_t;
53 class IServerPluginCallbacks;
59 virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
61 return PLUGIN_CONTINUE;
65 IVspBridge *vsp_bridge = NULL;
68 * The vtable must match the general layout for ISPC. We modify the vtable
69 * based on what we get back.
73 const char *game_name;
74 unsigned int vsp_version;
81 virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
88 /* Backend should already filled in if loaded as gamedll */
89 if (gamedll_bridge == NULL)
91 if ((game_name = mm_GetGameName()) == NULL)
96 mm_backend = mm_DetermineBackend(engineFactory, game_name);
99 if (mm_backend == MMBackend_UNKNOWN)
101 mm_LogFatal("Could not detect engine version");
104 else if (mm_backend >= MMBackend_Episode2)
106 /* We need to insert the right type of call into this vtable */
109 IRandomThings sample;
110 SourceHook::MemFuncInfo mfp_dest, mfp_src;
112 mfp_dest.isVirtual = false;
113 mfp_src.isVirtual = false;
115 SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
116 SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
118 assert(mfp_dest.isVirtual);
119 assert(mfp_dest.thisptroffs == 0);
120 assert(mfp_dest.vtbloffs == 0);
121 assert(mfp_src.isVirtual);
122 assert(mfp_src.thisptroffs == 0);
123 assert(mfp_src.vtbloffs == 0);
125 vtable_src = (void **)*(void **)&sample;
126 vtable_dest = (void **)*(void **)this;
127 SourceHook::SetMemAccess(&vtable_dest[mfp_dest.vtblindex],
129 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
130 vtable_dest[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
132 /* AS engine inserted ClientFullyConnect into the vtable, so move entries up on older engines */
133 if (mm_backend != MMBackend_AlienSwarm)
135 SourceHook::MemFuncInfo mfp_fconnect;
136 mfp_fconnect.isVirtual = false;
138 SourceHook::GetFuncInfo(&ServerPlugin::ClientFullyConnect, mfp_fconnect);
140 assert(mfp_fconnect.isVirtual);
141 assert(mfp_fconnect.thisptroffs == 0);
142 assert(mfp_fconnect.vtbloffs == 0);
144 /* Shifting ClientDisconnect through OnQueryCvarValueFinished up into slot for ClientFullyConnect (8 entries) */
145 SourceHook::SetMemAccess(&vtable_dest[mfp_fconnect.vtblindex],
147 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
148 memmove(&vtable_dest[mfp_fconnect.vtblindex], &vtable_dest[mfp_fconnect.vtblindex + 1], sizeof(void *) * 8);
153 if (gamedll_bridge == NULL)
155 if (!mm_LoadMetamodLibrary(mm_backend, error, sizeof(error)))
157 mm_LogFatal("Detected engine %d but could not load: %s", mm_backend, error);
162 typedef IVspBridge *(*GetVspBridge)();
163 GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
164 if (get_bridge == NULL)
166 if (gamedll_bridge == NULL)
168 mm_UnloadMetamodLibrary();
170 mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", mm_backend);
174 vsp_bridge = get_bridge();
176 vsp_bridge_info info;
178 info.engineFactory = engineFactory;
179 info.gsFactory = gsFactory;
180 info.vsp_callbacks = (IServerPluginCallbacks*)this;
181 info.vsp_version = vsp_version;
183 strcpy(error, "Unknown error");
184 if (!vsp_bridge->Load(&info, error, sizeof(error)))
187 if (gamedll_bridge == NULL)
189 mm_UnloadMetamodLibrary();
191 mm_LogFatal("Unknown error loading Metamod for engine %d: %s", mm_backend, error);
197 virtual void Unload()
199 if (vsp_bridge == NULL)
201 vsp_bridge->Unload();
203 if (gamedll_bridge == NULL)
205 mm_UnloadMetamodLibrary();
211 virtual void UnPause()
214 virtual const char *GetPluginDescription()
216 if (vsp_bridge == NULL)
217 return "Metamod:Source Loader Shim";
218 return vsp_bridge->GetDescription();
220 virtual void LevelInit(char const *pMapName)
223 virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
226 virtual void GameFrame(bool simulating)
229 virtual void LevelShutdown()
232 virtual void ClientActive(edict_t *pEntity)
235 virtual void ClientFullyConnect(edict_t *pEntity)
238 virtual void ClientDisconnect(edict_t *pEntity)
241 virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
244 virtual void SetCommandClient(int index)
247 virtual void ClientSettingsChanged(edict_t *pEdict)
250 virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
253 const char *pszAddress,
257 return PLUGIN_CONTINUE;
259 virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
261 return PLUGIN_CONTINUE;
263 virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
265 return PLUGIN_CONTINUE;
267 virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
268 edict_t *pPlayerEntity,
269 EQueryCvarValueStatus eStatus,
270 const char *pCvarName,
271 const char *pCvarValue)
274 void PrepForLoad(unsigned int version)
276 vsp_version = version;
281 ServerPlugin mm_vsp_callbacks;
283 void *mm_GetVspCallbacks(unsigned int version)
285 if (vsp_bridge != NULL)
288 /* Only support versions 1 or 2 right now */
292 mm_vsp_callbacks.PrepForLoad(version);
294 return &mm_vsp_callbacks;