loader/serverplugin.cpp
author Nicholas Hastings <skamonkey@gmail.com>
Wed Jul 31 06:49:21 2013 -0400 (2013-07-31)
changeset 850 3d9258ef9a30
parent 820 a05f33ba5ad4
child 857 d8cc9c7087b0
permissions -rw-r--r--
Split TF2, DoD:S, HL2:DM, and ND to separate binaries (bug 5667, r=asherkin).
     1 /**
     2  * vim: set ts=4 sw=4 tw=99 noet :
     3  * ======================================================
     4  * Metamod:Source
     5  * Copyright (C) 2004-2009 AlliedModders LLC and authors.
     6  * All rights reserved.
     7  * ======================================================
     8  *
     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.
    12  * 
    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:
    16  *
    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.
    24  */
    25 
    26 #include <stdio.h>
    27 #include <string.h>
    28 #include <assert.h>
    29 #include <stddef.h>
    30 #include "loader.h"
    31 #include <sh_memfuncinfo.h>
    32 #include <sh_memory.h>
    33 #include "serverplugin.h"
    34 #include "gamedll.h"
    35 
    36 typedef enum
    37 {
    38 	PLUGIN_CONTINUE = 0,
    39 	PLUGIN_OVERRIDE,
    40 	PLUGIN_STOP,
    41 } PLUGIN_RESULT;
    42 
    43 typedef enum
    44 {
    45     eQueryCvarValueStatus_ValueIntact=0,
    46     eQueryCvarValueStatus_CvarNotFound=1,
    47     eQueryCvarValueStatus_NotACvar=2,
    48     eQueryCvarValueStatus_CvarProtected=3
    49 } EQueryCvarValueStatus;
    50 
    51 typedef int QueryCvarCookie_t;
    52 class CCommand;
    53 class IServerPluginCallbacks;
    54 struct edict_t;
    55 
    56 class IRandomThings
    57 {
    58 public:
    59 	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
    60 	{
    61 		return PLUGIN_CONTINUE;
    62 	}
    63 };
    64 
    65 IVspBridge *vsp_bridge = NULL;
    66 
    67 /**
    68  * The vtable must match the general layout for ISPC.  We modify the vtable
    69  * based on what we get back.
    70  */
    71 class ServerPlugin
    72 {
    73 	char game_name[128];
    74 	unsigned int vsp_version;
    75 	bool load_allowed;
    76 public:
    77 	ServerPlugin()
    78 	{
    79 		load_allowed = false;
    80 	}
    81 	virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
    82 	{
    83 		if (!load_allowed)
    84 			return false;
    85 
    86 		load_allowed = false;
    87 
    88 		/* Backend should already filled in if loaded as gamedll */
    89 		if (gamedll_bridge == NULL)
    90 		{
    91 			if (!mm_GetGameName(game_name, sizeof(game_name)))
    92 			{
    93 				return false;
    94 			}
    95 
    96 			mm_backend = mm_DetermineBackend(engineFactory, game_name);
    97 		}
    98 
    99 		if (mm_backend == MMBackend_UNKNOWN)
   100 		{
   101 			mm_LogFatal("Could not detect engine version");
   102 			return false;
   103 		}
   104 		
   105 		void **this_vtable;
   106 		this_vtable = (void **)*(void **)this;
   107 
   108 		if (mm_backend != MMBackend_Episode1
   109 			&& mm_backend != MMBackend_DarkMessiah)
   110 		{
   111 			/* We need to insert the right type of call into this vtable */
   112 			void **vtable_src;
   113 			IRandomThings sample;
   114 			SourceHook::MemFuncInfo mfp_dest, mfp_src;
   115 
   116 			mfp_dest.isVirtual = false;
   117 			mfp_src.isVirtual = false;
   118 
   119 			SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
   120 			SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
   121 
   122 			assert(mfp_dest.isVirtual);
   123 			assert(mfp_dest.thisptroffs == 0);
   124 			assert(mfp_dest.vtbloffs == 0);
   125 			assert(mfp_src.isVirtual);
   126 			assert(mfp_src.thisptroffs == 0);
   127 			assert(mfp_src.vtbloffs == 0);
   128 
   129 			vtable_src = (void **)*(void **)&sample;
   130 			SourceHook::SetMemAccess(&this_vtable[mfp_dest.vtblindex],
   131 									 sizeof(void*),
   132 									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
   133 			this_vtable[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
   134 		}
   135 
   136 		/* AS inserted ClientFullyConnect into vtable, so move entries up on older engines */
   137 		if (mm_backend != MMBackend_AlienSwarm
   138 			&& mm_backend != MMBackend_Portal2
   139 			&& mm_backend != MMBackend_CSGO
   140 			&& mm_backend != MMBackend_DOTA)
   141 		{
   142 			SourceHook::MemFuncInfo mfp_fconnect;
   143 			mfp_fconnect.isVirtual = false;
   144 
   145 			SourceHook::GetFuncInfo(&ServerPlugin::ClientFullyConnect, mfp_fconnect);
   146 
   147 			assert(mfp_fconnect.isVirtual);
   148 			assert(mfp_fconnect.thisptroffs == 0);
   149 			assert(mfp_fconnect.vtbloffs == 0);
   150 
   151 			/* Shifting ClientDisconnect through OnQueryCvarValueFinished up into slot for
   152 			 * ClientFullyConnect (8 entries)
   153 			 */
   154 			SourceHook::SetMemAccess(&this_vtable[mfp_fconnect.vtblindex],
   155 									 sizeof(void *) * 8,
   156 									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
   157 			memmove(&this_vtable[mfp_fconnect.vtblindex],
   158 					&this_vtable[mfp_fconnect.vtblindex + 1],
   159 					sizeof(void *) * 8);
   160 		}
   161 
   162 		char error[255];
   163 		if (gamedll_bridge == NULL)
   164 		{
   165 			if (!mm_LoadMetamodLibrary(mm_backend, error, sizeof(error)))
   166 			{
   167 				mm_LogFatal("Detected engine %d but could not load: %s", mm_backend, error);
   168 				return false;
   169 			}
   170 		}
   171 
   172 		typedef IVspBridge *(*GetVspBridge)();
   173 		GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
   174 		if (get_bridge == NULL)
   175 		{
   176 			if (gamedll_bridge == NULL)
   177 			{
   178 				mm_UnloadMetamodLibrary();
   179 			}
   180 			mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", mm_backend);
   181 			return false;
   182 		}
   183 
   184 		vsp_bridge = get_bridge();
   185 
   186 		vsp_bridge_info info;
   187 
   188 		info.engineFactory = engineFactory;
   189 		info.gsFactory = gsFactory;
   190 		info.vsp_callbacks = (IServerPluginCallbacks*)this;
   191 		info.vsp_version = vsp_version;
   192 
   193 		strcpy(error, "Unknown error");
   194 		if (!vsp_bridge->Load(&info, error, sizeof(error)))
   195 		{
   196 			vsp_bridge = NULL;
   197 			if (gamedll_bridge == NULL)
   198 			{
   199 				mm_UnloadMetamodLibrary();
   200 			}
   201 			mm_LogFatal("Unknown error loading Metamod for engine %d: %s", mm_backend, error);	
   202 			return false;
   203 		}
   204 
   205 		return true;
   206 	}
   207 	virtual void Unload()
   208 	{
   209 		if (vsp_bridge == NULL)
   210 			return;
   211 		vsp_bridge->Unload();
   212 
   213 		if (gamedll_bridge == NULL)
   214 		{
   215 			mm_UnloadMetamodLibrary();
   216 		}
   217 	}
   218 	virtual void Pause()
   219 	{
   220 	}
   221 	virtual void UnPause()
   222 	{
   223 	}
   224 	virtual const char *GetPluginDescription()
   225 	{
   226 		if (vsp_bridge == NULL)
   227 			return "Metamod:Source Loader Shim";
   228 		return vsp_bridge->GetDescription();
   229 	}
   230 	virtual void LevelInit(char const *pMapName)
   231 	{
   232 	}
   233 	virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
   234 	{
   235 	}
   236 	virtual void GameFrame(bool simulating)
   237 	{
   238 	}
   239 	virtual void LevelShutdown()
   240 	{
   241 	}
   242 	virtual void ClientActive(edict_t *pEntity)
   243 	{
   244 	}
   245 	virtual void ClientFullyConnect(edict_t *pEntity)
   246 	{
   247 	}
   248 	virtual void ClientDisconnect(edict_t *pEntity)
   249 	{
   250 	}
   251 	virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
   252 	{
   253 	}
   254 	virtual void SetCommandClient(int index)
   255 	{
   256 	}
   257 	virtual void ClientSettingsChanged(edict_t *pEdict)
   258 	{
   259 	}
   260 	virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
   261 										edict_t *pEntity,
   262 										const char *pszName,
   263 										const char *pszAddress,
   264 										char *reject,
   265 										int maxrejectlen) 
   266 	{
   267 		return PLUGIN_CONTINUE;
   268 	}
   269 	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
   270 	{
   271 		return PLUGIN_CONTINUE;
   272 	}
   273 	virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
   274 	{
   275 		return PLUGIN_CONTINUE;
   276 	}
   277 	virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
   278 										  edict_t *pPlayerEntity,
   279 										  EQueryCvarValueStatus eStatus,
   280 										  const char *pCvarName,
   281 										  const char *pCvarValue)
   282 	{
   283 	}
   284 	void PrepForLoad(unsigned int version)
   285 	{
   286 		vsp_version = version;
   287 		load_allowed = true;
   288 	}
   289 };
   290 
   291 ServerPlugin mm_vsp_callbacks;
   292 
   293 void *mm_GetVspCallbacks(unsigned int version)
   294 {
   295 	if (vsp_bridge != NULL)
   296 		return NULL;
   297 
   298 	/* Only support versions 1 or 2 right now */
   299 	if (version > 2)
   300 		return NULL;
   301 
   302 	mm_vsp_callbacks.PrepForLoad(version);
   303 
   304 	return &mm_vsp_callbacks;
   305 }
   306