ds@658: /** ds@669: * vim: set ts=4 sw=4 tw=99 noet : ds@658: * ====================================================== ds@658: * Metamod:Source ds@669: * Copyright (C) 2004-2009 AlliedModders LLC and authors. ds@658: * All rights reserved. ds@658: * ====================================================== ds@658: * ds@658: * This software is provided 'as-is', without any express or implied warranty. ds@658: * In no event will the authors be held liable for any damages arising from ds@658: * the use of this software. ds@658: * ds@658: * Permission is granted to anyone to use this software for any purpose, ds@658: * including commercial applications, and to alter it and redistribute it ds@658: * freely, subject to the following restrictions: ds@658: * ds@658: * 1. The origin of this software must not be misrepresented; you must not ds@658: * claim that you wrote the original software. If you use this software in a ds@658: * product, an acknowledgment in the product documentation would be ds@658: * appreciated but is not required. ds@658: * 2. Altered source versions must be plainly marked as such, and must not be ds@658: * misrepresented as being the original software. ds@658: * 3. This notice may not be removed or altered from any source distribution. ds@658: */ ds@658: ds@658: #include ds@689: #include ds@658: #include "../metamod_oslink.h" ds@658: #include ds@658: #include ds@658: #include ds@658: #include ds@658: #include ds@658: #include ds@658: #include "../metamod_util.h" ds@658: #include "provider_ep2.h" ds@658: #include "console.h" ds@658: #include "metamod_console.h" ds@658: #include ds@658: #include "metamod.h" ds@658: ds@658: /* Types */ ds@658: typedef void (*CONPRINTF_FUNC)(const char *, ...); ds@658: struct UsrMsgInfo ds@658: { ds@658: UsrMsgInfo() ds@658: { ds@658: } ds@658: UsrMsgInfo(int s, const char *t) : size(s), name(t) ds@658: { ds@658: } ds@658: int size; ds@658: String name; ds@658: }; ds@658: ds@658: /* Imports */ ds@658: #if SOURCE_ENGINE == SE_DARKMESSIAH ds@658: #undef CommandLine ds@658: DLL_IMPORT ICommandLine *CommandLine(); ds@658: #endif ds@658: ds@658: /* Functions */ ds@689: void CacheUserMessages(); ds@689: void Detour_Error(const tchar *pMsg, ...); ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: void ClientCommand(edict_t *pEdict, const CCommand &args); ds@658: void LocalCommand_Meta(const CCommand &args); ds@658: #else ds@658: void ClientCommand(edict_t *pEdict); ds@658: void LocalCommand_Meta(); ds@658: #endif ds@658: ds@658: void _ServerCommand(); ds@658: /* Variables */ ds@658: static BaseProvider g_Ep1Provider; ds@658: static List conbases_unreg; ds@689: static CVector usermsgs_list; ds@689: static jmp_buf usermsg_end; ds@658: ds@658: ICvar *icvar = NULL; ds@658: IFileSystem *baseFs = NULL; ds@658: IServerGameDLL *server = NULL; ds@658: IVEngineServer *engine = NULL; ds@658: IServerGameClients *gameclients = NULL; ds@658: IMetamodSourceProvider *provider = &g_Ep1Provider; ds@658: ConCommand meta_local_cmd("meta", LocalCommand_Meta, "Metamod:Source control options"); ds@658: ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: SH_DECL_HOOK2_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *, const CCommand &); ds@658: #else ds@658: SH_DECL_HOOK1_void(IServerGameClients, ClientCommand, SH_NOATTRIB, 0, edict_t *); ds@658: #endif ds@658: ds@658: void BaseProvider::ConsolePrint(const char *str) ds@658: { ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: ConMsg("%s", str); ds@658: #else ds@658: Msg("%s", str); ds@658: #endif ds@658: } ds@658: ds@658: void BaseProvider::Notify_DLLInit_Pre(CreateInterfaceFn engineFactory, ds@658: CreateInterfaceFn serverFactory) ds@658: { ds@658: engine = (IVEngineServer *)((engineFactory)(INTERFACEVERSION_VENGINESERVER, NULL)); ds@658: if (!engine) ds@658: { ds@658: DisplayError("Could not find IVEngineServer! Metamod cannot load."); ds@658: return; ds@658: } ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: icvar = (ICvar *)((engineFactory)(CVAR_INTERFACE_VERSION, NULL)); ds@658: #else ds@658: icvar = (ICvar *)((engineFactory)(VENGINE_CVAR_INTERFACE_VERSION, NULL)); ds@658: #endif ds@658: if (!icvar) ds@658: { ds@658: DisplayError("Could not find ICvar! Metamod cannot load."); ds@658: return; ds@658: } ds@658: ds@658: ds@658: if ((gameclients = (IServerGameClients *)(serverFactory("ServerGameClients003", NULL))) ds@658: == NULL) ds@658: { ds@658: gameclients = (IServerGameClients *)(serverFactory("ServerGameClients004", NULL)); ds@658: } ds@658: ds@658: baseFs = (IFileSystem *)((engineFactory)(FILESYSTEM_INTERFACE_VERSION, NULL)); ds@658: if (baseFs == NULL) ds@658: { ds@658: mm_LogMessage("Unable to find \"%s\": .vdf files will not be parsed", FILESYSTEM_INTERFACE_VERSION); ds@658: } ds@658: ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: g_pCVar = icvar; ds@658: #endif ds@658: ds@658: g_SMConVarAccessor.RegisterConCommandBase(&meta_local_cmd); ds@658: ds@689: CacheUserMessages(); ds@658: ds@658: #if SOURCE_ENGINE == SE_DARKMESSIAH ds@637: if (!g_SMConVarAccessor.InitConCommandBaseList()) ds@637: { ds@637: /* This is very unlikely considering it's old engine */ ds@637: mm_LogMessage("[META] Warning: Failed to find ConCommandBase list!"); ds@637: mm_LogMessage("[META] Warning: ConVars and ConCommands cannot be unregistered properly! Please file a bug report."); ds@658: } ds@658: #endif ds@658: ds@658: if (gameclients) ds@658: { ds@658: SH_ADD_HOOK_STATICFUNC(IServerGameClients, ClientCommand, gameclients, ClientCommand, false); ds@658: } ds@658: } ds@658: ds@658: void BaseProvider::Notify_DLLShutdown_Pre() ds@658: { ds@658: g_SMConVarAccessor.RemoveMetamodCommands(); ds@658: ds@658: #if SOURCE_ENGINE == SE_DARKMESSIAH ds@658: if (g_Metamod.IsLoadedAsGameDLL()) ds@658: { ds@658: icvar->UnlinkVariables(FCVAR_GAMEDLL); ds@658: } ds@658: #endif ds@658: } ds@658: ds@658: bool BaseProvider::IsRemotePrintingAvailable() ds@658: { ds@658: return true; ds@658: } ds@658: ds@658: void BaseProvider::ClientConsolePrint(edict_t *client, const char *message) ds@658: { ds@658: engine->ClientPrintf(client, message); ds@658: } ds@658: ds@658: void BaseProvider::ServerCommand(const char *cmd) ds@658: { ds@658: engine->ServerCommand(cmd); ds@658: } ds@658: ds@658: const char *BaseProvider::GetConVarString(ConVar *convar) ds@658: { ds@658: if (convar == NULL) ds@658: { ds@658: return NULL; ds@658: } ds@658: ds@658: return convar->GetString(); ds@658: } ds@658: ds@658: void BaseProvider::SetConVarString(ConVar *convar, const char *str) ds@658: { ds@658: convar->SetValue(str); ds@658: } ds@658: ds@658: bool BaseProvider::IsConCommandBaseACommand(ConCommandBase *pCommand) ds@658: { ds@658: return pCommand->IsCommand(); ds@658: } ds@658: ds@658: ds@658: bool BaseProvider::IsSourceEngineBuildCompatible(int build) ds@658: { ds@658: return (build == SOURCE_ENGINE_ORIGINAL ds@658: || build == SOURCE_ENGINE_EPISODEONE); ds@658: } ds@658: ds@658: const char *BaseProvider::GetCommandLineValue(const char *key, const char *defval) ds@658: { ds@658: if (key[0] == '-' || key[0] == '+') ds@658: { ds@658: return CommandLine()->ParmValue(key, defval); ds@658: } ds@658: else if (icvar) ds@658: { ds@658: const char *val; ds@658: if ((val = icvar->GetCommandLineValue(key)) == NULL) ds@658: { ds@658: return defval; ds@658: } ds@658: ds@658: return val; ds@658: } ds@658: ds@658: return NULL; ds@658: } ds@658: ds@658: int BaseProvider::TryServerGameDLL(const char *iface) ds@658: { ds@658: if (strncmp(iface, "ServerGameDLL", 13) != 0) ds@658: { ds@658: return 0; ds@658: } ds@658: ds@658: return atoi(&iface[13]); ds@658: } ds@658: ds@658: bool BaseProvider::LogMessage(const char *buffer) ds@658: { ds@658: if (!engine) ds@658: { ds@658: return false; ds@658: } ds@658: ds@658: engine->LogPrint(buffer); ds@658: ds@658: return true; ds@658: } ds@658: ds@658: bool BaseProvider::GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) ds@658: { ds@658: SourceHook::MemFuncInfo mfi = {true, -1, 0, 0}; ds@658: ds@658: if (hook == ProvidedHook_LevelInit) ds@658: { ds@658: SourceHook::GetFuncInfo(&IServerGameDLL::LevelInit, mfi); ds@658: } ds@658: else if (hook == ProvidedHook_LevelShutdown) ds@658: { ds@658: SourceHook::GetFuncInfo(&IServerGameDLL::LevelShutdown, mfi); ds@658: } ds@658: else if (hook == ProvidedHook_GameInit) ds@658: { ds@658: SourceHook::GetFuncInfo(&IServerGameDLL::GameInit, mfi); ds@658: } ds@658: ds@658: *pInfo = mfi; ds@658: ds@658: return (mfi.thisptroffs >= 0); ds@658: } ds@658: ds@658: void BaseProvider::DisplayError(const char *fmt, ...) ds@658: { ds@658: va_list ap; ds@658: char buffer[2048]; ds@658: ds@658: va_start(ap, fmt); ds@658: UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap); ds@658: va_end(ap); ds@658: skamonkey@782: Error("%s", buffer); ds@658: } ds@658: ds@658: void BaseProvider::DisplayWarning(const char *fmt, ...) ds@658: { ds@658: va_list ap; ds@658: char buffer[2048]; ds@658: ds@658: va_start(ap, fmt); ds@658: UTIL_FormatArgs(buffer, sizeof(buffer), fmt, ap); ds@658: va_end(ap); ds@658: skamonkey@782: Warning("%s", buffer); ds@658: } ds@658: ds@658: IConCommandBaseAccessor *BaseProvider::GetConCommandBaseAccessor() ds@658: { ds@658: return &g_SMConVarAccessor; ds@658: } ds@658: ds@658: bool BaseProvider::RegisterConCommandBase(ConCommandBase *pCommand) ds@658: { ds@658: return g_SMConVarAccessor.Register(pCommand); ds@658: } ds@658: ds@658: void BaseProvider::UnregisterConCommandBase(ConCommandBase *pCommand) ds@658: { ds@658: return g_SMConVarAccessor.Unregister(pCommand); ds@658: } ds@658: ds@658: int BaseProvider::GetUserMessageCount() ds@658: { ds@658: return (int)usermsgs_list.size(); ds@658: } ds@658: ds@658: int BaseProvider::FindUserMessage(const char *name, int *size) ds@658: { ds@658: for (size_t i = 0; i < usermsgs_list.size(); i++) ds@658: { ds@658: if (usermsgs_list[i].name.compare(name) == 0) ds@658: { ds@658: if (size) ds@658: { ds@658: *size = usermsgs_list[i].size; ds@658: } ds@658: return (int)i; ds@658: } ds@658: } ds@658: ds@658: return -1; ds@658: } ds@658: ds@658: const char *BaseProvider::GetUserMessage(int index, int *size) ds@658: { ds@689: if (index < 0 || index >= (int)usermsgs_list.size()) ds@658: { ds@658: return NULL; ds@658: } ds@658: ds@658: if (size) ds@658: { ds@658: *size = usermsgs_list[index].size; ds@658: } ds@658: ds@658: return usermsgs_list[index].name.c_str(); ds@658: } ds@658: ds@658: const char *BaseProvider::GetGameDescription() ds@658: { ds@658: return server->GetGameDescription(); ds@658: } ds@658: ds@658: int BaseProvider::DetermineSourceEngine(const char *game) ds@658: { skamonkey@740: #if SOURCE_ENGINE == SE_BLOODYGOODTIME skamonkey@740: return SOURCE_ENGINE_BLOODYGOODTIME; skamonkey@740: #elif SOURCE_ENGINE == SE_ALIENSWARM ds@725: return SOURCE_ENGINE_ALIENSWARM; ds@725: #elif SOURCE_ENGINE == SE_LEFT4DEAD2 ds@669: return SOURCE_ENGINE_LEFT4DEAD2; ds@669: #elif SOURCE_ENGINE == SE_LEFT4DEAD ds@658: return SOURCE_ENGINE_LEFT4DEAD; ds@658: #elif SOURCE_ENGINE == SE_ORANGEBOX ds@658: return SOURCE_ENGINE_ORANGEBOX; skamonkey@791: #elif SOURCE_ENGINE == SE_CSS skamonkey@791: return SOURCE_ENGINE_CSS; ds@674: #elif SOURCE_ENGINE == SE_ORANGEBOXVALVE ds@674: return SOURCE_ENGINE_ORANGEBOXVALVE; ds@669: #elif SOURCE_ENGINE == SE_DARKMESSIAH ds@669: return SOURCE_ENGINE_DARKMESSIAH; skamonkey@763: #elif SOURCE_ENGINE == SE_EYE skamonkey@763: return SOURCE_ENGINE_EYE; skamonkey@780: #elif SOURCE_ENGINE == SE_PORTAL2 skamonkey@780: return SOURCE_ENGINE_PORTAL2; skamonkey@780: #elif SOURCE_ENGINE == SE_CSGO skamonkey@780: return SOURCE_ENGINE_CSGO; ds@658: #else ds@669: #error "SOURCE_ENGINE not defined to a known value" ds@658: #endif ds@658: } ds@658: ds@658: ConVar *BaseProvider::CreateConVar(const char *name, ds@658: const char *defval, ds@658: const char *help, ds@658: int flags) ds@658: { ds@658: int newflags = 0; ds@658: if (flags & ConVarFlag_Notify) ds@658: { ds@658: newflags |= FCVAR_NOTIFY; ds@658: } ds@658: if (flags & ConVarFlag_SpOnly) ds@658: { ds@658: newflags |= FCVAR_SPONLY; ds@658: } ds@658: ds@658: ConVar *pVar = new ConVar(name, defval, newflags, help); ds@658: ds@658: g_SMConVarAccessor.RegisterConCommandBase(pVar); ds@658: ds@658: return pVar; ds@658: } ds@658: ds@658: bool BaseProvider::ProcessVDF(const char *file, char path[], size_t path_len, char alias[], size_t alias_len) ds@658: { ds@658: if (baseFs == NULL) ds@658: { ds@658: return false; ds@658: } ds@658: ds@658: KeyValues *pValues; ds@658: const char *plugin_file, *p_alias; ds@658: ds@658: pValues = new KeyValues("Metamod Plugin"); ds@658: ds@658: if (!pValues->LoadFromFile(baseFs, file)) ds@658: { ds@658: pValues->deleteThis(); ds@658: return false; ds@658: } ds@658: ds@658: if ((plugin_file = pValues->GetString("file", NULL)) == NULL) ds@658: { ds@658: pValues->deleteThis(); ds@658: return false; ds@658: } ds@658: ds@658: UTIL_Format(path, path_len, "%s", plugin_file); ds@658: ds@658: if ((p_alias = pValues->GetString("alias", NULL)) != NULL) ds@658: { ds@658: UTIL_Format(alias, alias_len, "%s", p_alias); ds@658: } ds@658: else ds@658: { ds@658: UTIL_Format(alias, alias_len, ""); ds@658: } ds@658: ds@658: pValues->deleteThis(); ds@658: ds@658: return true; ds@658: } ds@658: ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: class GlobCommand : public IMetamodSourceCommandInfo ds@658: { ds@658: public: ds@658: GlobCommand(const CCommand *cmd) : m_cmd(cmd) ds@658: { ds@658: } ds@658: public: ds@658: unsigned int GetArgCount() ds@658: { ds@658: return m_cmd->ArgC() - 1; ds@658: } ds@658: ds@658: const char *GetArg(unsigned int num) ds@658: { ds@658: return m_cmd->Arg(num); ds@658: } ds@658: ds@658: const char *GetArgString() ds@658: { ds@658: return m_cmd->ArgS(); ds@658: } ds@658: private: ds@658: const CCommand *m_cmd; ds@658: }; ds@658: #else ds@658: class GlobCommand : public IMetamodSourceCommandInfo ds@658: { ds@658: public: ds@658: unsigned int GetArgCount() ds@658: { ds@658: return engine->Cmd_Argc() - 1; ds@658: } ds@658: ds@658: const char *GetArg(unsigned int num) ds@658: { ds@658: return engine->Cmd_Argv(num); ds@658: } ds@658: ds@658: const char *GetArgString() ds@658: { ds@658: return engine->Cmd_Args(); ds@658: } ds@658: }; ds@658: #endif ds@658: ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: void LocalCommand_Meta(const CCommand &args) ds@658: { ds@658: GlobCommand cmd(&args); ds@658: #else ds@658: void LocalCommand_Meta() ds@658: { ds@658: GlobCommand cmd; ds@658: #endif ds@658: Command_Meta(&cmd); ds@658: } ds@658: ds@658: #if SOURCE_ENGINE >= SE_ORANGEBOX ds@658: void ClientCommand(edict_t *pEdict, const CCommand &_cmd) ds@658: { ds@658: GlobCommand cmd(&_cmd); ds@658: #else ds@658: void ClientCommand(edict_t *pEdict) ds@658: { ds@658: GlobCommand cmd; ds@658: #endif ds@658: if (strcmp(cmd.GetArg(0), "meta") == 0) ds@658: { ds@658: Command_ClientMeta(pEdict, &cmd); ds@658: RETURN_META(MRES_SUPERCEDE); ds@658: } ds@658: ds@658: RETURN_META(MRES_IGNORED); ds@658: } ds@658: ds@689: /* This only gets called if IServerGameDLL::GetUserMessageInfo() triggers it */ ds@689: void Detour_Error(const tchar *pMsg, ...) ds@689: { ds@689: /* Jump back to setjmp() in CacheUserMessages() */ ds@689: longjmp(usermsg_end, 1); ds@689: } ds@658: ds@689: #define IA32_JMP_IMM32 0xE9 ds@658: ds@689: /* IServerGameDLL::GetUserMessageInfo() crashes on games based on the old engine and ds@689: * early Orange Box. This is because Error() from tier0 gets called when a bad index is ds@689: * passed. This is all due to a bug in CUtlRBTree::IsValidIndex(). ds@689: * ds@689: * So we detour Error() to fix this. Our detour then jumps back into CacheUserMessages() ds@689: * to a point before GetUserMessageInfo() is called. The detour is then removed and we ds@689: * exit. ds@689: */ ds@689: void CacheUserMessages() ds@658: { ds@689: int q, size; ds@689: char buffer[256]; ds@689: unsigned char *target, *detour; ds@689: unsigned char orig_bytes[5]; ds@658: ds@689: target = (unsigned char *)&Error; ds@689: detour = (unsigned char *)&Detour_Error; ds@689: ds@689: /* Save bytes from target function */ ds@689: memcpy(orig_bytes, target, sizeof(orig_bytes)); ds@658: ds@689: /* Patch in relative jump to our Error() detour */ ds@689: SetMemAccess(target, sizeof(orig_bytes), SH_MEM_READ|SH_MEM_WRITE|SH_MEM_EXEC); ds@689: target[0] = IA32_JMP_IMM32; ds@689: *(int32_t *)&target[1] = (int32_t)(detour - (target + 5)); ds@689: ds@689: /* This is where longjmp() will end up */ ds@689: if (setjmp(usermsg_end)) ds@658: { ds@689: /* Restore bytes and memory protection */ ds@689: memcpy(target, orig_bytes, sizeof(orig_bytes)); ds@689: SetMemAccess(target, sizeof(orig_bytes), SH_MEM_READ|SH_MEM_EXEC); ds@689: return; ds@658: } ds@658: ds@689: q = 0; ds@658: ds@689: /* If GetUserMessageInfo() calls Error(), we should end up in our detour */ ds@689: while (server->GetUserMessageInfo(q, buffer, sizeof(buffer), size)) ds@658: { ds@689: usermsgs_list.push_back(UsrMsgInfo(size, buffer)); ds@689: q++; ds@658: } ds@658: ds@689: /* Jump back to setjmp() */ ds@689: longjmp(usermsg_end, 1); ds@658: }