loader/serverplugin.cpp
author Scott Ehlert <ds@alliedmods.net>
Wed Feb 18 01:38:23 2009 -0600 (2009-02-18)
changeset 637 b66489d8aedc
parent 608 30b546cc4e03
child 669 2ae87570fab2
permissions -rw-r--r--
Added support for Dark Messiah engine and game. (no bug, r=me).

The development of this feature would not be possible without the support of the following people from the game's community:
Dylan Riggs, Carl Pettengill, Ed Moreland, and Christian.
dvander@608
     1
/**
dvander@608
     2
 * vim: set ts=4 :
dvander@608
     3
 * ======================================================
dvander@608
     4
 * Metamod:Source
dvander@608
     5
 * Copyright (C) 2004-2008 AlliedModders LLC and authors.
dvander@608
     6
 * All rights reserved.
dvander@608
     7
 * ======================================================
dvander@608
     8
 *
dvander@608
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@608
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@608
    11
 * the use of this software.
dvander@608
    12
 * 
dvander@608
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@608
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@608
    15
 * freely, subject to the following restrictions:
dvander@608
    16
 *
dvander@608
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@608
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@608
    19
 * product, an acknowledgment in the product documentation would be 
dvander@608
    20
 * appreciated but is not required.
dvander@608
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@608
    22
 * misrepresented as being the original software.
dvander@608
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@608
    24
 *
dvander@608
    25
 * Version: $Id$
dvander@608
    26
 */
dvander@608
    27
dvander@546
    28
#include <stdio.h>
dvander@547
    29
#include <string.h>
dvander@546
    30
#include <assert.h>
dvander@546
    31
#include <stddef.h>
dvander@546
    32
#include "loader.h"
dvander@546
    33
#include <sh_memfuncinfo.h>
dvander@546
    34
#include <sh_memory.h>
dvander@546
    35
#include "serverplugin.h"
dvander@546
    36
dvander@546
    37
typedef enum
dvander@546
    38
{
dvander@546
    39
	PLUGIN_CONTINUE = 0,
dvander@546
    40
	PLUGIN_OVERRIDE,
dvander@546
    41
	PLUGIN_STOP,
dvander@546
    42
} PLUGIN_RESULT;
dvander@546
    43
dvander@546
    44
typedef enum
dvander@546
    45
{
dvander@546
    46
    eQueryCvarValueStatus_ValueIntact=0,
dvander@546
    47
    eQueryCvarValueStatus_CvarNotFound=1,
dvander@546
    48
    eQueryCvarValueStatus_NotACvar=2,
dvander@546
    49
    eQueryCvarValueStatus_CvarProtected=3
dvander@546
    50
} EQueryCvarValueStatus;
dvander@546
    51
dvander@546
    52
typedef int QueryCvarCookie_t;
dvander@546
    53
class CCommand;
dvander@546
    54
class IServerPluginCallbacks;
dvander@546
    55
struct edict_t;
dvander@546
    56
dvander@546
    57
#if defined WIN32
dvander@546
    58
#define LIBRARY_EXT		".dll"
dvander@546
    59
#else
dvander@546
    60
#define LIBRARY_EXT		"_i486.so"
dvander@546
    61
#endif
dvander@546
    62
dvander@546
    63
class IRandomThings
dvander@546
    64
{
dvander@546
    65
public:
dvander@546
    66
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity, const CCommand& args)
dvander@546
    67
	{
dvander@546
    68
		return PLUGIN_CONTINUE;
dvander@546
    69
	}
dvander@546
    70
};
dvander@546
    71
dvander@579
    72
IVspBridge *vsp_bridge = NULL;
dvander@579
    73
dvander@546
    74
/**
dvander@546
    75
 * The vtable must match the general layout for ISPC.  We modify the vtable
dvander@546
    76
 * based on what we get back.
dvander@546
    77
 */
dvander@546
    78
class ServerPlugin
dvander@546
    79
{
ds@637
    80
	const char *game_name;
dvander@546
    81
	unsigned int vsp_version;
dvander@546
    82
	bool load_allowed;
dvander@546
    83
public:
dvander@546
    84
	ServerPlugin()
dvander@546
    85
	{
dvander@546
    86
		load_allowed = false;
dvander@546
    87
	}
dvander@546
    88
	virtual bool Load(QueryValveInterface engineFactory, QueryValveInterface gsFactory)
dvander@546
    89
	{
dvander@546
    90
		if (!load_allowed)
dvander@546
    91
			return false;
dvander@546
    92
dvander@546
    93
		load_allowed = false;
dvander@546
    94
ds@637
    95
		if ((game_name = mm_GetGameName()) == NULL)
ds@637
    96
		{
ds@637
    97
			return false;
ds@637
    98
		}
ds@637
    99
ds@637
   100
		MetamodBackend backend = mm_DetermineBackend(engineFactory, game_name);
dvander@546
   101
dvander@546
   102
		if (backend == MMBackend_UNKNOWN)
dvander@546
   103
		{
dvander@579
   104
			mm_LogFatal("Could not detect engine version");
dvander@546
   105
			return false;
dvander@546
   106
		}
ds@637
   107
		else if (backend == MMBackend_Episode2 || backend == MMBackend_Left4Dead)
dvander@546
   108
		{
dvander@546
   109
			/* We need to insert the right type of call into this vtable */
dvander@546
   110
			void **vtable_src;
dvander@546
   111
			void **vtable_dest;
dvander@546
   112
			IRandomThings sample;
dvander@546
   113
			SourceHook::MemFuncInfo mfp_dest, mfp_src;
dvander@546
   114
dvander@546
   115
			mfp_dest.isVirtual = false;
dvander@546
   116
			mfp_src.isVirtual = false;
dvander@546
   117
dvander@546
   118
			SourceHook::GetFuncInfo(&ServerPlugin::ClientCommand, mfp_dest);
dvander@546
   119
			SourceHook::GetFuncInfo(&IRandomThings::ClientCommand, mfp_src);
dvander@546
   120
dvander@546
   121
			assert(mfp_dest.isVirtual);
dvander@546
   122
			assert(mfp_dest.thisptroffs == 0);
dvander@546
   123
			assert(mfp_dest.vtbloffs == 0);
dvander@546
   124
			assert(mfp_src.isVirtual);
dvander@546
   125
			assert(mfp_src.thisptroffs == 0);
dvander@546
   126
			assert(mfp_src.vtbloffs == 0);
dvander@546
   127
dvander@546
   128
			vtable_src = (void **)*(void **)&sample;
dvander@546
   129
			vtable_dest = (void **)*(void **)this;
dvander@546
   130
			SourceHook::SetMemAccess(&vtable_dest[mfp_dest.vtblindex],
dvander@546
   131
									 sizeof(void*),
dvander@546
   132
									 SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC);
dvander@546
   133
			vtable_dest[mfp_dest.vtblindex] = vtable_src[mfp_src.vtblindex];
dvander@546
   134
		}
dvander@546
   135
dvander@546
   136
		char error[255];
dvander@546
   137
		if (!mm_LoadMetamodLibrary(backend, error, sizeof(error)))
dvander@546
   138
		{
dvander@546
   139
			mm_LogFatal("Detected engine %d but could not load: %s", backend, error);
dvander@546
   140
			return false;
dvander@546
   141
		}
dvander@546
   142
dvander@546
   143
		typedef IVspBridge *(*GetVspBridge)();
dvander@546
   144
		GetVspBridge get_bridge = (GetVspBridge)mm_GetProcAddress("GetVspBridge");
dvander@546
   145
		if (get_bridge == NULL)
dvander@546
   146
		{
dvander@546
   147
			mm_UnloadMetamodLibrary();
dvander@579
   148
			mm_LogFatal("Detected engine %d but could not find GetVspBridge callback", backend);
dvander@546
   149
			return false;
dvander@546
   150
		}
dvander@546
   151
dvander@579
   152
		vsp_bridge = get_bridge();
dvander@546
   153
dvander@546
   154
		vsp_bridge_info info;
dvander@546
   155
dvander@546
   156
		info.engineFactory = engineFactory;
dvander@546
   157
		info.gsFactory = gsFactory;
dvander@546
   158
		info.vsp_callbacks = (IServerPluginCallbacks*)this;
dvander@546
   159
		info.vsp_version = vsp_version;
dvander@546
   160
dvander@547
   161
		strcpy(error, "Unknown error");
dvander@579
   162
		if (!vsp_bridge->Load(&info, error, sizeof(error)))
dvander@546
   163
		{
dvander@579
   164
			vsp_bridge = NULL;
dvander@546
   165
			mm_UnloadMetamodLibrary();
dvander@547
   166
			mm_LogFatal("Unknown error loading Metamod for engine %d: %s", backend, error);	
dvander@546
   167
			return false;
dvander@546
   168
		}
dvander@546
   169
dvander@546
   170
		return true;
dvander@546
   171
	}
dvander@546
   172
	virtual void Unload()
dvander@546
   173
	{
dvander@579
   174
		if (vsp_bridge == NULL)
dvander@546
   175
			return;
dvander@579
   176
		vsp_bridge->Unload();
ds@576
   177
		mm_UnloadMetamodLibrary();
dvander@546
   178
	}
dvander@546
   179
	virtual void Pause()
dvander@546
   180
	{
dvander@546
   181
	}
dvander@546
   182
	virtual void UnPause()
dvander@546
   183
	{
dvander@546
   184
	}
dvander@546
   185
	virtual const char *GetPluginDescription()
dvander@546
   186
	{
dvander@579
   187
		if (vsp_bridge == NULL)
dvander@546
   188
			return "Metamod:Source Loader Shim";
dvander@579
   189
		return vsp_bridge->GetDescription();
dvander@546
   190
	}
dvander@546
   191
	virtual void LevelInit(char const *pMapName)
dvander@546
   192
	{
dvander@546
   193
	}
dvander@546
   194
	virtual void ServerActivate(edict_t *pEdictList, int edictCount, int clientMax)
dvander@546
   195
	{
dvander@546
   196
	}
dvander@546
   197
	virtual void GameFrame(bool simulating)
dvander@546
   198
	{
dvander@546
   199
	}
dvander@546
   200
	virtual void LevelShutdown()
dvander@546
   201
	{
dvander@546
   202
	}
dvander@546
   203
	virtual void ClientActive(edict_t *pEntity)
dvander@546
   204
	{
dvander@546
   205
	}
dvander@546
   206
	virtual void ClientDisconnect(edict_t *pEntity)
dvander@546
   207
	{
dvander@546
   208
	}
dvander@546
   209
	virtual void ClientPutInServer(edict_t *pEntity, char const *playername)
dvander@546
   210
	{
dvander@546
   211
	}
dvander@546
   212
	virtual void SetCommandClient(int index)
dvander@546
   213
	{
dvander@546
   214
	}
dvander@546
   215
	virtual void ClientSettingsChanged(edict_t *pEdict)
dvander@546
   216
	{
dvander@546
   217
	}
dvander@546
   218
	virtual PLUGIN_RESULT ClientConnect(bool *bAllowConnect,
dvander@546
   219
										edict_t *pEntity,
dvander@546
   220
										const char *pszName,
dvander@546
   221
										const char *pszAddress,
dvander@546
   222
										char *reject,
dvander@546
   223
										int maxrejectlen) 
dvander@546
   224
	{
dvander@546
   225
		return PLUGIN_CONTINUE;
dvander@546
   226
	}
dvander@546
   227
	virtual PLUGIN_RESULT ClientCommand(edict_t *pEntity)
dvander@546
   228
	{
dvander@546
   229
		return PLUGIN_CONTINUE;
dvander@546
   230
	}
dvander@546
   231
	virtual PLUGIN_RESULT NetworkIDValidated(const char *pszUserName, const char *pszNetworkID)
dvander@546
   232
	{
dvander@546
   233
		return PLUGIN_CONTINUE;
dvander@546
   234
	}
dvander@546
   235
	virtual void OnQueryCvarValueFinished(QueryCvarCookie_t iCookie,
dvander@546
   236
										  edict_t *pPlayerEntity,
dvander@546
   237
										  EQueryCvarValueStatus eStatus,
dvander@546
   238
										  const char *pCvarName,
dvander@546
   239
										  const char *pCvarValue)
dvander@546
   240
	{
dvander@546
   241
	}
dvander@546
   242
	void PrepForLoad(unsigned int version)
dvander@546
   243
	{
dvander@546
   244
		vsp_version = version;
dvander@546
   245
		load_allowed = true;
dvander@546
   246
	}
dvander@546
   247
};
dvander@546
   248
dvander@546
   249
ServerPlugin mm_vsp_callbacks;
dvander@546
   250
dvander@546
   251
void *mm_GetVspCallbacks(unsigned int version)
dvander@546
   252
{
dvander@579
   253
	if (vsp_bridge != NULL)
dvander@546
   254
		return NULL;
dvander@546
   255
dvander@555
   256
	/* Only support versions 1 or 2 right now */
dvander@555
   257
	if (version > 2)
dvander@555
   258
		return NULL;
dvander@555
   259
dvander@546
   260
	mm_vsp_callbacks.PrepForLoad(version);
dvander@546
   261
dvander@546
   262
	return &mm_vsp_callbacks;
dvander@546
   263
}
dvander@546
   264