loader/serverplugin.cpp
author Scott Ehlert <ds@alliedmods.net>
Tue Nov 24 08:01:06 2009 -0600 (2009-11-24)
changeset 687 cf809a183e16
parent 683 b507295429f9
child 728 6fd06d6c6e30
permissions -rw-r--r--
Fixed line endings in a couple of loader files.
     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 	const char *game_name;
    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 ((game_name = mm_GetGameName()) == NULL)
    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 		else if (mm_backend >= MMBackend_Episode2)
   105 		{
   106 			/* We need to insert the right type of call into this vtable */
   107 			void **vtable_src;
   108 			void **vtable_dest;
   109 			IRandomThings sample;
   110 			SourceHook::MemFuncInfo mfp_dest, mfp_src;
   111 
   112 			mfp_dest.isVirtual = false;
   113 			mfp_src.isVirtual = false;
   114 
   115 			SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
   116 			SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
   117 
   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);
   124 
   125 			vtable_src = (void **)*(void **)&sample;
   126 			vtable_dest = (void **)*(void **)this;
   127 			SourceHook::SetMemAccess(&vtable_dest[mfp_dest.vtblindex],
   128 									 sizeof(void*),
   129 									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
   130 			vtable_dest[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
   131 		}
   132 
   133 		char error[255];
   134 		if (gamedll_bridge == NULL)
   135 		{
   136 			if (!mm_LoadMetamodLibrary(mm_backend, error, sizeof(error)))
   137 			{
   138 				mm_LogFatal("Detected engine %d but could not load: %s", mm_backend, error);
   139 				return false;
   140 			}
   141 		}
   142 
   143 		typedef IVspBridge *(*GetVspBridge)();
   144 		GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
   145 		if (get_bridge == NULL)
   146 		{
   147 			if (gamedll_bridge == NULL)
   148 			{
   149 				mm_UnloadMetamodLibrary();
   150 			}
   151 			mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", mm_backend);
   152 			return false;
   153 		}
   154 
   155 		vsp_bridge = get_bridge();
   156 
   157 		vsp_bridge_info info;
   158 
   159 		info.engineFactory = engineFactory;
   160 		info.gsFactory = gsFactory;
   161 		info.vsp_callbacks = (IServerPluginCallbacks*)this;
   162 		info.vsp_version = vsp_version;
   163 
   164 		strcpy(error, "Unknown error");
   165 		if (!vsp_bridge->Load(&info, error, sizeof(error)))
   166 		{
   167 			vsp_bridge = NULL;
   168 			if (gamedll_bridge == NULL)
   169 			{
   170 				mm_UnloadMetamodLibrary();
   171 			}
   172 			mm_LogFatal("Unknown error loading Metamod for engine %d: %s", mm_backend, error);	
   173 			return false;
   174 		}
   175 
   176 		return true;
   177 	}
   178 	virtual void Unload()
   179 	{
   180 		if (vsp_bridge == NULL)
   181 			return;
   182 		vsp_bridge->Unload();
   183 
   184 		if (gamedll_bridge == NULL)
   185 		{
   186 			mm_UnloadMetamodLibrary();
   187 		}
   188 	}
   189 	virtual void Pause()
   190 	{
   191 	}
   192 	virtual void UnPause()
   193 	{
   194 	}
   195 	virtual const char *GetPluginDescription()
   196 	{
   197 		if (vsp_bridge == NULL)
   198 			return "Metamod:Source Loader Shim";
   199 		return vsp_bridge->GetDescription();
   200 	}
   201 	virtual void LevelInit(char const *pMapName)
   202 	{
   203 	}
   204 	virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
   205 	{
   206 	}
   207 	virtual void GameFrame(bool simulating)
   208 	{
   209 	}
   210 	virtual void LevelShutdown()
   211 	{
   212 	}
   213 	virtual void ClientActive(edict_t *pEntity)
   214 	{
   215 	}
   216 	virtual void ClientDisconnect(edict_t *pEntity)
   217 	{
   218 	}
   219 	virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
   220 	{
   221 	}
   222 	virtual void SetCommandClient(int index)
   223 	{
   224 	}
   225 	virtual void ClientSettingsChanged(edict_t *pEdict)
   226 	{
   227 	}
   228 	virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
   229 										edict_t *pEntity,
   230 										const char *pszName,
   231 										const char *pszAddress,
   232 										char *reject,
   233 										int maxrejectlen) 
   234 	{
   235 		return PLUGIN_CONTINUE;
   236 	}
   237 	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
   238 	{
   239 		return PLUGIN_CONTINUE;
   240 	}
   241 	virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
   242 	{
   243 		return PLUGIN_CONTINUE;
   244 	}
   245 	virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
   246 										  edict_t *pPlayerEntity,
   247 										  EQueryCvarValueStatus eStatus,
   248 										  const char *pCvarName,
   249 										  const char *pCvarValue)
   250 	{
   251 	}
   252 	void PrepForLoad(unsigned int version)
   253 	{
   254 		vsp_version = version;
   255 		load_allowed = true;
   256 	}
   257 };
   258 
   259 ServerPlugin mm_vsp_callbacks;
   260 
   261 void *mm_GetVspCallbacks(unsigned int version)
   262 {
   263 	if (vsp_bridge != NULL)
   264 		return NULL;
   265 
   266 	/* Only support versions 1 or 2 right now */
   267 	if (version > 2)
   268 		return NULL;
   269 
   270 	mm_vsp_callbacks.PrepForLoad(version);
   271 
   272 	return &mm_vsp_callbacks;
   273 }
   274