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"
44 eQueryCvarValueStatus_ValueIntact=0,
45 eQueryCvarValueStatus_CvarNotFound=1,
46 eQueryCvarValueStatus_NotACvar=2,
47 eQueryCvarValueStatus_CvarProtected=3
48 } EQueryCvarValueStatus;
50 typedef int QueryCvarCookie_t;
52 class IServerPluginCallbacks;
56 #define LIBRARY_EXT ".dll"
58 #define LIBRARY_EXT "_i486.so"
64 virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
66 return PLUGIN_CONTINUE;
70 IVspBridge *vsp_bridge = NULL;
73 * The vtable must match the general layout for ISPC. We modify the vtable
74 * based on what we get back.
78 const char *game_name;
79 unsigned int vsp_version;
86 virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
93 if ((game_name = mm_GetGameName()) == NULL)
98 MetamodBackend backend = mm_DetermineBackend(engineFactory, game_name);
100 if (backend == MMBackend_UNKNOWN)
102 mm_LogFatal("Could not detect engine version");
105 else if (backend >= MMBackend_Episode2)
107 /* We need to insert the right type of call into this vtable */
110 IRandomThings sample;
111 SourceHook::MemFuncInfo mfp_dest, mfp_src;
113 mfp_dest.isVirtual = false;
114 mfp_src.isVirtual = false;
116 SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
117 SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
119 assert(mfp_dest.isVirtual);
120 assert(mfp_dest.thisptroffs == 0);
121 assert(mfp_dest.vtbloffs == 0);
122 assert(mfp_src.isVirtual);
123 assert(mfp_src.thisptroffs == 0);
124 assert(mfp_src.vtbloffs == 0);
126 vtable_src = (void **)*(void **)&sample;
127 vtable_dest = (void **)*(void **)this;
128 SourceHook::SetMemAccess(&vtable_dest[mfp_dest.vtblindex],
130 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
131 vtable_dest[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
135 if (!mm_LoadMetamodLibrary(backend, error, sizeof(error)))
137 mm_LogFatal("Detected engine %d but could not load: %s", backend, error);
141 typedef IVspBridge *(*GetVspBridge)();
142 GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
143 if (get_bridge == NULL)
145 mm_UnloadMetamodLibrary();
146 mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", backend);
150 vsp_bridge = get_bridge();
152 vsp_bridge_info info;
154 info.engineFactory = engineFactory;
155 info.gsFactory = gsFactory;
156 info.vsp_callbacks = (IServerPluginCallbacks*)this;
157 info.vsp_version = vsp_version;
159 strcpy(error, "Unknown error");
160 if (!vsp_bridge->Load(&info, error, sizeof(error)))
163 mm_UnloadMetamodLibrary();
164 mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error);
170 virtual void Unload()
172 if (vsp_bridge == NULL)
174 vsp_bridge->Unload();
175 mm_UnloadMetamodLibrary();
180 virtual void UnPause()
183 virtual const char *GetPluginDescription()
185 if (vsp_bridge == NULL)
186 return "Metamod:Source Loader Shim";
187 return vsp_bridge->GetDescription();
189 virtual void LevelInit(char const *pMapName)
192 virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
195 virtual void GameFrame(bool simulating)
198 virtual void LevelShutdown()
201 virtual void ClientActive(edict_t *pEntity)
204 virtual void ClientDisconnect(edict_t *pEntity)
207 virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
210 virtual void SetCommandClient(int index)
213 virtual void ClientSettingsChanged(edict_t *pEdict)
216 virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
219 const char *pszAddress,
223 return PLUGIN_CONTINUE;
225 virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
227 return PLUGIN_CONTINUE;
229 virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
231 return PLUGIN_CONTINUE;
233 virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
234 edict_t *pPlayerEntity,
235 EQueryCvarValueStatus eStatus,
236 const char *pCvarName,
237 const char *pCvarValue)
240 void PrepForLoad(unsigned int version)
242 vsp_version = version;
247 ServerPlugin mm_vsp_callbacks;
249 void *mm_GetVspCallbacks(unsigned int version)
251 if (vsp_bridge != NULL)
254 /* Only support versions 1 or 2 right now */
258 mm_vsp_callbacks.PrepForLoad(version);
260 return &mm_vsp_callbacks;