dvander@371: dvander@371: /** dvander@371: * vim: set ts=4 : dvander@371: * ====================================================== dvander@371: * Metamod:Source dvander@371: * Copyright (C) 2004-2007 AlliedModders LLC and authors. dvander@371: * All rights reserved. dvander@371: * ====================================================== dvander@371: * dvander@371: * This software is provided 'as-is', without any express or implied warranty. dvander@371: * In no event will the authors be held liable for any damages arising from dvander@371: * the use of this software. dvander@371: * dvander@371: * Permission is granted to anyone to use this software for any purpose, dvander@371: * including commercial applications, and to alter it and redistribute it dvander@371: * freely, subject to the following restrictions: dvander@371: * dvander@371: * 1. The origin of this software must not be misrepresented; you must not dvander@371: * claim that you wrote the original software. If you use this software in a dvander@371: * product, an acknowledgment in the product documentation would be dvander@371: * appreciated but is not required. dvander@371: * 2. Altered source versions must be plainly marked as such, and must not be dvander@371: * misrepresented as being the original software. dvander@371: * 3. This notice may not be removed or altered from any source distribution. dvander@371: * dvander@371: * Version: $Id$ dvander@371: */ dvander@371: dvander@371: #include dvander@371: #include "convar_smm.h" dvander@371: #include dvander@371: #include dvander@371: #include dvander@371: #include dvander@371: #include dvander@371: #include "../metamod_util.h" dvander@371: #include "provider_ep1.h" dvander@371: #include "console.h" dvander@371: #include "metamod_console.h" dvander@371: #include "vsp_listener.h" dvander@371: dvander@371: /* Types */ dvander@371: typedef void (*CONPRINTF_FUNC)(const char *, ...); dvander@371: struct UsrMsgInfo dvander@371: { dvander@371: int size; dvander@371: String name; dvander@371: }; dvander@371: /* Imports */ dvander@371: #undef CommandLine dvander@371: DLL_IMPORT ICommandLine *CommandLine(); dvander@371: /* Functions */ dvander@371: CONPRINTF_FUNC ExtractRemotePrinter(); dvander@371: bool CacheUserMessages(); dvander@371: void ClientCommand(edict_t *pEdict); dvander@371: void _ServerCommand(); dvander@371: /* Variables */ dvander@371: bool usermsgs_extracted = false; dvander@371: CVector usermsgs_list; dvander@371: CONPRINTF_FUNC echo_msg_func = NULL; dvander@371: ICvar *icvar = NULL; dvander@371: ISmmAPI *metamod_api = NULL; dvander@371: IVEngineServer *engine = NULL; dvander@371: IServerGameClients *gameclients = NULL; dvander@371: VSPListener g_VspListener; dvander@371: BaseProvider g_Ep1Provider; dvander@371: IMetamodSourceProvider *provider = &g_Ep1Provider; dvander@371: dvander@371: SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *); dvander@371: dvander@371: void BaseProvider::ConsolePrint(const char *str) dvander@371: { dvander@371: if (echo_msg_func != NULL) dvander@371: { dvander@371: echo_msg_func("%s", str); dvander@371: } dvander@371: else dvander@371: { dvander@371: Msg("%s", str); dvander@371: } dvander@371: } dvander@371: dvander@371: void BaseProvider::Notify_DLLInit_Pre(void *gamedll, dvander@371: CreateInterfaceFn engineFactory, dvander@371: CreateInterfaceFn serverFactory) dvander@371: { dvander@371: server = (IServerGameDLL *)gamedll; dvander@371: engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL)); dvander@371: if (!engine) dvander@371: { dvander@371: Error("Could not find IVEngineServer! Metamod cannot load."); dvander@371: return; dvander@371: } dvander@371: icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION, NULL)); dvander@371: if (!icvar) dvander@371: { dvander@371: Error("Could not find ICvar! Metamod cannot load."); dvander@371: return; dvander@371: } dvander@371: dvander@371: if ((gameclients = (IServerGameClients *)(serverFactory("ServerGameClients003", NULL))) dvander@371: == NULL) dvander@371: { dvander@371: gameclients = (IServerGameClients *)(serverFactory("ServerGameClients004", NULL)); dvander@371: } dvander@371: dvander@371: echo_msg_func = ExtractRemotePrinter(); dvander@371: usermsgs_extracted = CacheUserMessages(); dvander@371: dvander@371: if (gameclients) dvander@371: { dvander@371: SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, gameclients, ClientCommand, false); dvander@371: } dvander@371: dvander@371: ConCommandBaseMgr::OneTimeInit(&g_SMConVarAccessor); dvander@371: } dvander@371: dvander@371: void BaseProvider::Notify_DLLShutdown_Pre() dvander@371: { dvander@371: g_SMConVarAccessor.MarkCommandsAsGameDLL(); dvander@371: g_SMConVarAccessor.UnregisterGameDLLCommands(); dvander@371: } dvander@371: dvander@371: bool BaseProvider::IsRemotePrintingAvailable() dvander@371: { dvander@371: return (echo_msg_func != NULL); dvander@371: } dvander@371: dvander@371: void BaseProvider::ClientConsolePrint(edict_t *client, const char *message) dvander@371: { dvander@371: engine->ClientPrintf(client, message); dvander@371: } dvander@371: dvander@371: void BaseProvider::ServerCommand(const char *cmd) dvander@371: { dvander@371: engine->ServerCommand(cmd); dvander@371: } dvander@371: dvander@371: const char *BaseProvider::GetConVarString(ConVar *convar) dvander@371: { dvander@371: return convar->GetString(); dvander@371: } dvander@371: dvander@371: bool BaseProvider::IsConCommandBaseACommand(ConCommandBase *pCommand) dvander@371: { dvander@371: return pCommand->IsCommand(); dvander@371: } dvander@371: dvander@371: dvander@371: bool BaseProvider::IsSourceEngineBuildCompatible(int build) dvander@371: { dvander@371: return (build == SOURCE_ENGINE_ORIGINAL dvander@371: || build == SOURCE_ENGINE_EPISODEONE); dvander@371: } dvander@371: dvander@371: const char *BaseProvider::GetCommandLineValue(const char *key, const char *defval) dvander@371: { dvander@371: if (key[0] == '-' || key[0] == '+') dvander@371: { dvander@371: return CommandLine()->ParmValue(key, defval); dvander@371: } dvander@371: else dvander@371: { dvander@371: const char *val; dvander@371: if ((val = icvar->GetCommandLineValue(key)) == NULL) dvander@371: { dvander@371: return defval; dvander@371: } dvander@371: dvander@371: return val; dvander@371: } dvander@371: } dvander@371: dvander@371: int BaseProvider::TryServerGameDLL(const char *iface) dvander@371: { dvander@371: if (strncmp(iface, "ServerGameDLL", 13) != 0) dvander@371: { dvander@371: return 0; dvander@371: } dvander@371: dvander@371: return atoi(&iface[13]); dvander@371: } dvander@371: dvander@371: bool BaseProvider::LogMessage(const char *buffer) dvander@371: { dvander@371: if (!engine) dvander@371: { dvander@371: return false; dvander@371: } dvander@371: dvander@371: engine->LogPrint(buffer); dvander@371: dvander@371: return true; dvander@371: } dvander@371: dvander@371: bool BaseProvider::GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) dvander@371: { dvander@371: SourceHook::MemFuncInfo mfi = {true, -1, 0, 0}; dvander@371: dvander@371: if (hook == ProvidedHook_LevelInit) dvander@371: { dvander@371: SourceHook::GetFuncInfo(&IServerGameDLL::LevelInit, mfi); dvander@371: } dvander@371: else if (hook == ProvidedHook_LevelShutdown) dvander@371: { dvander@371: SourceHook::GetFuncInfo(&IServerGameDLL::LevelShutdown, mfi); dvander@371: } dvander@371: else if (hook == ProvidedHook_GameInit) dvander@371: { dvander@371: SourceHook::GetFuncInfo(&IServerGameDLL::GameInit, mfi); dvander@371: } dvander@371: else if (hook == ProvidedHook_DLLShutdown) dvander@371: { dvander@371: SourceHook::GetFuncInfo(&IServerGameDLL::DLLShutdown, mfi); dvander@371: } dvander@371: else if (hook == ProvidedHook_DLLInit) dvander@371: { dvander@371: SourceHook::GetFuncInfo(&IServerGameDLL::DLLInit, mfi); dvander@371: } dvander@371: dvander@371: *pInfo = mfi; dvander@371: dvander@371: return (mfi.thisptroffs >= 0); dvander@371: } dvander@371: dvander@371: void BaseProvider::DisplayError(const char *fmt, ...) dvander@371: { dvander@371: va_list ap; dvander@371: char buffer[2048]; dvander@371: dvander@371: va_start(ap, fmt); dvander@371: UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap); dvander@371: va_end(ap); dvander@371: dvander@371: Error(buffer); dvander@371: } dvander@371: dvander@371: void BaseProvider::DisplayWarning(const char *fmt, ...) dvander@371: { dvander@371: va_list ap; dvander@371: char buffer[2048]; dvander@371: dvander@371: va_start(ap, fmt); dvander@371: UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap); dvander@371: va_end(ap); dvander@371: dvander@371: Warning(buffer); dvander@371: } dvander@371: dvander@371: IConCommandBaseAccessor *BaseProvider::GetConCommandBaseAccessor() dvander@371: { dvander@371: return &g_SMConVarAccessor; dvander@371: } dvander@371: dvander@371: bool BaseProvider::RegisterConCommandBase(ConCommandBase *pCommand) dvander@371: { dvander@371: return g_SMConVarAccessor.Register(pCommand); dvander@371: } dvander@371: dvander@371: void BaseProvider::UnregisterConCommandBase(ConCommandBase *pCommand) dvander@371: { dvander@371: return g_SMConVarAccessor.Unregister(pCommand); dvander@371: } dvander@371: dvander@371: int BaseProvider::GetUserMessageCount() dvander@371: { dvander@371: if (!usermsgs_extracted) dvander@371: { dvander@371: return -1; dvander@371: } dvander@371: dvander@371: return (int)usermsgs_list.size(); dvander@371: } dvander@371: dvander@371: int BaseProvider::FindUserMessage(const char *name, int *size) dvander@371: { dvander@371: for (size_t i = 0; i < usermsgs_list.size(); i++) dvander@371: { dvander@371: if (usermsgs_list[i].name.compare(name) == 0) dvander@371: { dvander@371: if (size) dvander@371: { dvander@371: *size = usermsgs_list[i].size; dvander@371: } dvander@371: return (int)i; dvander@371: } dvander@371: } dvander@371: dvander@371: return -1; dvander@371: } dvander@371: dvander@371: const char *BaseProvider::GetUserMessage(int index, int *size) dvander@371: { dvander@371: if (!usermsgs_extracted || index < 0 || index >= (int)usermsgs_list.size()) dvander@371: { dvander@371: return NULL; dvander@371: } dvander@371: dvander@371: if (size) dvander@371: { dvander@371: *size = usermsgs_list[index].size; dvander@371: } dvander@371: dvander@371: return usermsgs_list[index].name.c_str(); dvander@371: } dvander@371: dvander@371: const char *BaseProvider::GetGameDescription() dvander@371: { dvander@371: return server->GetGameDescription(); dvander@371: } dvander@371: dvander@371: ConVar *BaseProvider::CreateConVar(const char *name, dvander@371: const char *defval, dvander@371: const char *help, dvander@371: int flags) dvander@371: { dvander@371: int newflags = 0; dvander@371: if (flags & ConVarFlag_Notify) dvander@371: { dvander@371: newflags |= FCVAR_NOTIFY; dvander@371: } dvander@371: if (flags & ConVarFlag_Replicated) dvander@371: { dvander@371: newflags |= FCVAR_REPLICATED; dvander@371: } dvander@371: if (flags & ConVarFlag_SpOnly) dvander@371: { dvander@371: newflags |= FCVAR_SPONLY; dvander@371: } dvander@371: dvander@371: return new ConVar(name, defval, newflags, help); dvander@371: } dvander@371: dvander@371: IServerPluginCallbacks *BaseProvider::GetVSPCallbacks(const char *iface) dvander@371: { dvander@371: g_VspListener.SetLoadable(true); dvander@371: return &g_VspListener; dvander@371: } dvander@371: dvander@371: class GlobCommand : public IMetamodSourceCommandInfo dvander@371: { dvander@371: public: dvander@371: unsigned int GetArgCount() dvander@371: { dvander@371: return engine->Cmd_Argc() - 1; dvander@371: } dvander@371: dvander@371: const char *GetArg(unsigned int num) dvander@371: { dvander@371: return engine->Cmd_Argv(num); dvander@371: } dvander@371: dvander@371: const char *GetArgString() dvander@371: { dvander@371: return engine->Cmd_Args(); dvander@371: } dvander@371: }; dvander@371: dvander@371: CON_COMMAND(meta, "Metamod:Source control commands") dvander@371: { dvander@371: GlobCommand cmd; dvander@371: Command_Meta(&cmd); dvander@371: } dvander@371: dvander@371: void ClientCommand(edict_t *pEdict) dvander@371: { dvander@371: GlobCommand cmd; dvander@371: dvander@371: if (strcmp(cmd.GetArg(0), "meta") == 0) dvander@371: { dvander@371: Command_ClientMeta(pEdict, &cmd); dvander@371: } dvander@371: } dvander@371: dvander@371: ////////////////////////////////////////////////////////////////////////// dvander@371: //THERE BE HAX HERE!!!! DON'T TELL ALFRED, BUT GABE WANTED IT THAT WAY. // dvander@371: // (note: you can find the offset by looking for the text // dvander@371: // "Echo text to console", you'll find the callback cmd pushed on the // dvander@371: // stack.) // dvander@371: ////////////////////////////////////////////////////////////////////////// dvander@371: dvander@371: #define SIGLEN 8 dvander@371: #define ENGINE486_SIG "\x55\x89\xE5\x53\x83\xEC\x14\xBB" dvander@371: #define ENGINE486_OFFS 40 dvander@371: #define ENGINE686_SIG "\x53\x83\xEC\x08\xBB\x01\x00\x00" dvander@371: #define ENGINE686_OFFS 50 dvander@371: #define ENGINEAMD_SIG "\x53\x51\xBB\x01\x00\x00\x00\x51" dvander@371: #define ENGINEAMD_OFFS 47 dvander@371: #define ENGINEW32_SIG "\xA1\x2A\x2A\x2A\x2A\x56\xBE\x01" dvander@371: #define ENGINEW32_OFFS 38 dvander@371: #define IA32_CALL 0xE8 dvander@371: dvander@371: bool vcmp(const void *_addr1, const void *_addr2, size_t len) dvander@371: { dvander@371: unsigned char *addr1 = (unsigned char *)_addr1; dvander@371: unsigned char *addr2 = (unsigned char *)_addr2; dvander@371: dvander@371: for (size_t i=0; iGetCommands(); dvander@371: unsigned char *ptr = NULL; dvander@371: FnCommandCallback callback = NULL; dvander@371: int offs = 0; dvander@371: dvander@371: while (pBase) dvander@371: { dvander@371: if (strcmp(pBase->GetName(), "echo") == 0) dvander@371: { dvander@371: callback = ((ConCommand *)pBase)->GetCallback(); dvander@371: ptr = (unsigned char *)callback; dvander@371: #ifdef OS_LINUX dvander@371: if (vcmp(ptr, ENGINE486_SIG, SIGLEN)) dvander@371: { dvander@371: offs = ENGINE486_OFFS; dvander@371: } dvander@371: else if (vcmp(ptr, ENGINE686_SIG, SIGLEN)) dvander@371: { dvander@371: offs = ENGINE686_OFFS; dvander@371: } dvander@371: else if (vcmp(ptr, ENGINEAMD_SIG, SIGLEN)) dvander@371: { dvander@371: offs = ENGINEAMD_OFFS; dvander@371: } dvander@371: #elif defined OS_WIN32 // Only one Windows engine binary so far... dvander@371: if (vcmp(ptr, ENGINEW32_SIG, SIGLEN)) dvander@371: { dvander@371: offs = ENGINEW32_OFFS; dvander@371: } dvander@371: #endif dvander@371: dvander@371: if (!offs || ptr[offs - 1] != IA32_CALL) dvander@371: { dvander@371: return NULL; dvander@371: } dvander@371: //get the relative offset dvander@371: void *addr = *((void **)(ptr + offs)); dvander@371: //add the base offset, to the ip (which is the address+offset + 4 bytes for next instruction) dvander@371: return (CONPRINTF_FUNC)((unsigned long)addr + (unsigned long)(ptr + offs) + 4); dvander@371: } dvander@371: pBase = const_cast(pBase->GetNext()); dvander@371: } dvander@371: dvander@371: return NULL; dvander@371: } dvander@371: dvander@371: ////////////////////////////////////////////////////////////////////// dvander@371: // EVEN MORE HACKS HERE! YOU HAVE BEEN WARNED! // dvander@371: // Signatures necessary in finding the pointer to the CUtlDict that // dvander@371: // stores user message information. // dvander@371: // IServerGameDLL::GetUserMessageInfo() normally crashes with bad // dvander@371: // message indices. This is our answer to it. Yuck! <:-( // dvander@371: ////////////////////////////////////////////////////////////////////// dvander@371: #ifdef OS_WIN32 dvander@371: /* General Windows sig */ dvander@371: #define MSGCLASS_SIGLEN 7 dvander@371: #define MSGCLASS_SIG "\x8B\x0D\x2A\x2A\x2A\x2A\x56" dvander@371: #define MSGCLASS_OFFS 2 dvander@371: dvander@371: /* Dystopia Wimdows hack */ dvander@371: #define MSGCLASS2_SIGLEN 16 dvander@371: #define MSGCLASS2_SIG "\x56\x8B\x74\x24\x2A\x85\xF6\x7C\x2A\x3B\x35\x2A\x2A\x2A\x2A\x7D" dvander@371: #define MSGCLASS2_OFFS 11 dvander@371: dvander@371: /* Windows frame pointer sig */ dvander@371: #define MSGCLASS3_SIGLEN 18 dvander@371: #define MSGCLASS3_SIG "\x55\x8B\xEC\x51\x89\x2A\x2A\x8B\x2A\x2A\x50\x8B\x0D\x2A\x2A\x2A\x2A\xE8" dvander@371: #define MSGCLASS3_OFFS 13 dvander@371: #elif defined OS_LINUX dvander@371: /* No frame pointer sig */ dvander@371: #define MSGCLASS_SIGLEN 14 dvander@371: #define MSGCLASS_SIG "\x53\x83\xEC\x2A\x8B\x2A\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89" dvander@371: #define MSGCLASS_OFFS 9 dvander@371: dvander@371: /* Frame pointer sig */ dvander@371: #define MSGCLASS2_SIGLEN 16 dvander@371: #define MSGCLASS2_SIG "\x55\x89\xE5\x53\x83\xEC\x2A\x8B\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89" dvander@371: #define MSGCLASS2_OFFS 11 dvander@371: #endif dvander@371: dvander@371: struct UserMessage dvander@371: { dvander@371: int size; dvander@371: const char *name; dvander@371: }; dvander@371: dvander@371: typedef CUtlDict UserMsgDict; dvander@371: dvander@371: /* This is the ugliest function in all of SourceMM */ dvander@371: bool CacheUserMessages() dvander@371: { dvander@371: /* Get address of original GetUserMessageInfo() */ dvander@371: char *vfunc = (char *)SH_GET_ORIG_VFNPTR_ENTRY(server, &IServerGameDLL::GetUserMessageInfo); dvander@371: dvander@371: /* Oh dear, we have a relative jump on our hands dvander@371: * PVK II on Windows made me do this, but I suppose it doesn't hurt to check this on Linux too... dvander@371: */ dvander@371: if (*vfunc == '\xE9') dvander@371: { dvander@371: /* Get address from displacement... dvander@371: * dvander@371: * Add 5 because it's relative to next instruction: dvander@371: * Opcode <1 byte> + 32-bit displacement <4 bytes> dvander@371: */ dvander@371: vfunc += *reinterpret_cast(vfunc + 1) + 5; dvander@371: } dvander@371: dvander@371: CUtlDict *dict = NULL; dvander@371: dvander@371: if (vcmp(vfunc, MSGCLASS_SIG, MSGCLASS_SIGLEN)) dvander@371: { dvander@371: /* Get address of CUserMessages instance */ dvander@371: char **userMsgClass = *reinterpret_cast(vfunc + MSGCLASS_OFFS); dvander@371: dvander@371: /* Get address of CUserMessages::m_UserMessages */ dvander@371: dict = reinterpret_cast(*userMsgClass); dvander@371: } dvander@371: else if (vcmp(vfunc, MSGCLASS2_SIG, MSGCLASS2_SIGLEN)) dvander@371: { dvander@371: #ifdef OS_WIN32 dvander@371: /* If we get here, the code is possibly inlined like in Dystopia */ dvander@371: dvander@371: /* Get the address of the CUtlRBTree */ dvander@371: char *rbtree = *reinterpret_cast(vfunc + MSGCLASS2_OFFS); dvander@371: dvander@371: /* CUtlDict should be 8 bytes before the CUtlRBTree (hacktacular!) */ dvander@371: dict = reinterpret_cast(rbtree - 8); dvander@371: #elif defined OS_LINUX dvander@371: /* Get address of CUserMessages instance */ dvander@371: char **userMsgClass = *reinterpret_cast(vfunc + MSGCLASS2_OFFS); dvander@371: dvander@371: /* Get address of CUserMessages::m_UserMessages */ dvander@371: dict = reinterpret_cast(*userMsgClass); dvander@371: #endif dvander@371: #ifdef OS_WIN32 dvander@371: } dvander@371: else if (vcmp(vfunc, MSGCLASS3_SIG, MSGCLASS3_SIGLEN)) dvander@371: { dvander@371: /* Get address of CUserMessages instance */ dvander@371: char **userMsgClass = *reinterpret_cast(vfunc + MSGCLASS3_OFFS); dvander@371: dvander@371: /* Get address of CUserMessages::m_UserMessages */ dvander@371: dict = reinterpret_cast(*userMsgClass); dvander@371: #endif dvander@371: } dvander@371: dvander@371: if (dict) dvander@371: { dvander@371: int msg_count = dict->Count(); dvander@371: dvander@371: /* Ensure that count is within bounds of an unsigned byte, because that's what engine supports */ dvander@371: if (msg_count < 0 || msg_count > 255) dvander@371: { dvander@371: return false; dvander@371: } dvander@371: dvander@371: UserMessage *msg; dvander@371: UsrMsgInfo u_msg; dvander@371: dvander@371: /* Cache messages in our CUtlDict */ dvander@371: for (int i = 0; i < msg_count; i++) dvander@371: { dvander@371: msg = dict->Element(i); dvander@371: u_msg.name = msg->name; dvander@371: u_msg.size = msg->size; dvander@371: usermsgs_list.push_back(u_msg); dvander@371: } dvander@371: dvander@371: return true; dvander@371: } dvander@371: dvander@371: return false; dvander@371: } dvander@371: