#include "pch.h" #include "squirrel.h" #include "concommand.h" #include "modmanager.h" #include "dedicated.h" #include "r2engine.h" #include "tier0.h" AUTOHOOK_INIT() const char* GetContextName(ScriptContext context) { switch (context) { case ScriptContext::CLIENT: return "CLIENT"; case ScriptContext::SERVER: return "SERVER"; case ScriptContext::UI: return "UI"; default: return "UNKNOWN"; } } eSQReturnType SQReturnTypeFromString(const char* pReturnType) { static const std::map sqReturnTypeNameToString = { {"bool", eSQReturnType::Boolean}, {"float", eSQReturnType::Float}, {"vector", eSQReturnType::Vector}, {"int", eSQReturnType::Integer}, {"entity", eSQReturnType::Entity}, {"string", eSQReturnType::String}, {"array", eSQReturnType::Arrays}, {"asset", eSQReturnType::Asset}, {"table", eSQReturnType::Table}}; if (sqReturnTypeNameToString.find(pReturnType) != sqReturnTypeNameToString.end()) return sqReturnTypeNameToString.at(pReturnType); else return eSQReturnType::Default; // previous default value } const char* SQTypeNameFromID(int type) { switch (type) { case OT_ASSET: return "asset"; case OT_INTEGER: return "int"; case OT_BOOL: return "bool"; case SQOBJECT_NUMERIC: return "float or int"; case OT_NULL: return "null"; case OT_VECTOR: return "vector"; case 0: return "var"; case OT_USERDATA: return "userdata"; case OT_FLOAT: return "float"; case OT_STRING: return "string"; case OT_ARRAY: return "array"; case 0x8000200: return "function"; case 0x8100000: return "structdef"; case OT_THREAD: return "thread"; case OT_FUNCPROTO: return "function"; case OT_CLAAS: return "class"; case OT_WEAKREF: return "weakref"; case 0x8080000: return "unimplemented function"; case 0x8200000: return "struct instance"; case OT_TABLE: return "table"; case 0xA008000: return "instance"; case OT_ENTITY: return "entity"; } return ""; } // needed to define implementations for squirrelmanager outside of squirrel.h without compiler errors template class SquirrelManager; template class SquirrelManager; template class SquirrelManager; template void SquirrelManager::VMCreated(CSquirrelVM* newSqvm) { m_pSQVM = newSqvm; for (SQFuncRegistration* funcReg : m_funcRegistrations) { spdlog::info("Registering {} function {}", GetContextName(context), funcReg->squirrelFuncName); RegisterSquirrelFunc(m_pSQVM, funcReg, 1); } for (auto& pair : g_pModManager->m_DependencyConstants) { bool bWasFound = false; for (Mod& dependency : g_pModManager->m_LoadedMods) { if (!dependency.m_bEnabled) continue; if (dependency.Name == pair.second) { bWasFound = true; break; } } defconst(m_pSQVM, pair.first.c_str(), bWasFound); } } template void SquirrelManager::VMDestroyed() { m_pSQVM = nullptr; } template void SquirrelManager::ExecuteCode(const char* pCode) { if (!m_pSQVM || !m_pSQVM->sqvm) { spdlog::error("Cannot execute code, {} squirrel vm is not initialised", GetContextName(context)); return; } spdlog::info("Executing {} script code {} ", GetContextName(context), pCode); std::string strCode(pCode); CompileBufferState bufferState = CompileBufferState(strCode); SQRESULT compileResult = compilebuffer(&bufferState, "console"); spdlog::info("sq_compilebuffer returned {}", PrintSQRESULT.at(compileResult)); if (compileResult != SQRESULT_ERROR) { pushroottable(m_pSQVM->sqvm); SQRESULT callResult = call(m_pSQVM->sqvm, 0); spdlog::info("sq_call returned {}", PrintSQRESULT.at(callResult)); } } template void SquirrelManager::AddFuncRegistration( std::string returnType, std::string name, std::string argTypes, std::string helpText, SQFunction func) { SQFuncRegistration* reg = new SQFuncRegistration; reg->squirrelFuncName = new char[name.size() + 1]; strcpy((char*)reg->squirrelFuncName, name.c_str()); reg->cppFuncName = reg->squirrelFuncName; reg->helpText = new char[helpText.size() + 1]; strcpy((char*)reg->helpText, helpText.c_str()); reg->returnTypeString = new char[returnType.size() + 1]; strcpy((char*)reg->returnTypeString, returnType.c_str()); reg->returnType = SQReturnTypeFromString(returnType.c_str()); reg->argTypes = new char[argTypes.size() + 1]; strcpy((char*)reg->argTypes, argTypes.c_str()); reg->funcPtr = func; m_funcRegistrations.push_back(reg); } template SQRESULT SquirrelManager::setupfunc(const SQChar* funcname) { pushroottable(m_pSQVM->sqvm); pushstring(m_pSQVM->sqvm, funcname, -1); SQRESULT result = get(m_pSQVM->sqvm, -2); if (result != SQRESULT_ERROR) pushroottable(m_pSQVM->sqvm); return result; } template void SquirrelManager::AddFuncOverride(std::string name, SQFunction func) { m_funcOverrides[name] = func; } // hooks bool IsUIVM(ScriptContext context, HSquirrelVM* pSqvm) { return context != ScriptContext::SERVER && g_pSquirrel->m_pSQVM && g_pSquirrel->m_pSQVM->sqvm == pSqvm; } template void* (*sq_compiler_create)(HSquirrelVM* sqvm, void* a2, void* a3, SQBool bShouldThrowError); template void* sq_compiler_createHook(HSquirrelVM* sqvm, void* a2, void* a3, SQBool bShouldThrowError) { // store whether errors generated from this compile should be fatal if (IsUIVM(context, sqvm)) g_pSquirrel->m_bFatalCompilationErrors = bShouldThrowError; else g_pSquirrel->m_bFatalCompilationErrors = bShouldThrowError; return sq_compiler_create(sqvm, a2, a3, bShouldThrowError); } template SQInteger (*SQPrint)(HSquirrelVM* sqvm, const char* fmt); template SQInteger SQPrintHook(HSquirrelVM* sqvm, const char* fmt, ...) { va_list va; va_start(va, fmt); SQChar buf[1024]; int charsWritten = vsnprintf_s(buf, _TRUNCATE, fmt, va); if (charsWritten > 0) { if (buf[charsWritten - 1] == '\n') buf[charsWritten - 1] = '\0'; spdlog::info("[{} SCRIPT] {}", GetContextName(context), buf); } va_end(va); return 0; } template CSquirrelVM* (*CreateNewVM)(void* a1, ScriptContext realContext); template CSquirrelVM* CreateNewVMHook(void* a1, ScriptContext realContext) { CSquirrelVM* sqvm = CreateNewVM(a1, realContext); if (realContext == ScriptContext::UI) g_pSquirrel->VMCreated(sqvm); else g_pSquirrel->VMCreated(sqvm); spdlog::info("CreateNewVM {} {}", GetContextName(realContext), (void*)sqvm); return sqvm; } template void (*DestroyVM)(void* a1, HSquirrelVM* sqvm); template void DestroyVMHook(void* a1, HSquirrelVM* sqvm) { ScriptContext realContext = context; // ui and client use the same function so we use this for prints if (IsUIVM(context, sqvm)) { realContext = ScriptContext::UI; g_pSquirrel->VMDestroyed(); } else DestroyVM(a1, sqvm); spdlog::info("DestroyVM {} {}", GetContextName(realContext), (void*)sqvm); } template void (*SQCompileError)(HSquirrelVM* sqvm, const char* error, const char* file, int line, int column); template void ScriptCompileErrorHook(HSquirrelVM* sqvm, const char* error, const char* file, int line, int column) { bool bIsFatalError = g_pSquirrel->m_bFatalCompilationErrors; ScriptContext realContext = context; // ui and client use the same function so we use this for prints if (IsUIVM(context, sqvm)) { realContext = ScriptContext::UI; bIsFatalError = g_pSquirrel->m_bFatalCompilationErrors; } spdlog::error("{} SCRIPT COMPILE ERROR {}", GetContextName(realContext), error); spdlog::error("{} line [{}] column [{}]", file, line, column); // use disconnect to display an error message for the compile error, but only if the compilation error was fatal // todo, we could get this from sqvm itself probably, rather than hooking sq_compiler_create if (bIsFatalError) { // kill dedicated server if we hit this if (IsDedicatedServer()) abort(); else { R2::Cbuf_AddText( R2::Cbuf_GetCurrentPlayer(), fmt::format("disconnect \"Encountered {} script compilation error, see console for details.\"", GetContextName(realContext)) .c_str(), R2::cmd_source_t::kCommandSrcCode); // likely temp: show console so user can see any errors, as error message wont display if ui is dead // maybe we could disable all mods other than the coremods and try a reload before doing this? // could also maybe do some vgui bullshit to show something visually rather than console if (realContext == ScriptContext::UI) R2::Cbuf_AddText(R2::Cbuf_GetCurrentPlayer(), "showconsole", R2::cmd_source_t::kCommandSrcCode); } } // dont call the original function since it kills game lol } template int64_t(*RegisterSquirrelFunction)(CSquirrelVM* sqvm, SQFuncRegistration* funcReg, char unknown); template int64_t RegisterSquirrelFunctionHook(CSquirrelVM* sqvm, SQFuncRegistration* funcReg, char unknown) { if (IsUIVM(context, sqvm->sqvm)) { if (g_pSquirrel->m_funcOverrides.count(funcReg->squirrelFuncName)) { g_pSquirrel->m_funcOriginals[funcReg->squirrelFuncName] = funcReg->funcPtr; funcReg->funcPtr = g_pSquirrel->m_funcOverrides[funcReg->squirrelFuncName]; spdlog::info("Replacing {} in UI", std::string(funcReg->squirrelFuncName)); } return g_pSquirrel->RegisterSquirrelFunc(sqvm, funcReg, unknown); } if (g_pSquirrel->m_funcOverrides.find(funcReg->squirrelFuncName) != g_pSquirrel->m_funcOverrides.end()) { g_pSquirrel->m_funcOriginals[funcReg->squirrelFuncName] = funcReg->funcPtr; funcReg->funcPtr = g_pSquirrel->m_funcOverrides[funcReg->squirrelFuncName]; spdlog::info("Replacing {} in Client", std::string(funcReg->squirrelFuncName)); } return g_pSquirrel->RegisterSquirrelFunc(sqvm, funcReg, unknown); } template bool (*CallScriptInitCallback)(void* sqvm, const char* callback); template bool CallScriptInitCallbackHook(void* sqvm, const char* callback) { ScriptContext realContext = context; bool bShouldCallCustomCallbacks = true; if (context == ScriptContext::CLIENT) { if (!strcmp(callback, "UICodeCallback_UIInit")) realContext = ScriptContext::UI; else if (strcmp(callback, "ClientCodeCallback_MapSpawn")) bShouldCallCustomCallbacks = false; } else if (context == ScriptContext::SERVER) bShouldCallCustomCallbacks = !strcmp(callback, "CodeCallback_MapSpawn"); if (bShouldCallCustomCallbacks) { for (Mod mod : g_pModManager->m_LoadedMods) { if (!mod.m_bEnabled) continue; for (ModScript script : mod.Scripts) { for (ModScriptCallback modCallback : script.Callbacks) { if (modCallback.Context == realContext && modCallback.BeforeCallback.length()) { spdlog::info("Running custom {} script callback \"{}\"", GetContextName(realContext), modCallback.BeforeCallback); CallScriptInitCallback(sqvm, modCallback.BeforeCallback.c_str()); } } } } } spdlog::info("{} CodeCallback {} called", GetContextName(realContext), callback); if (!bShouldCallCustomCallbacks) spdlog::info("Not executing custom callbacks for CodeCallback {}", callback); bool ret = CallScriptInitCallback(sqvm, callback); // run after callbacks if (bShouldCallCustomCallbacks) { for (Mod mod : g_pModManager->m_LoadedMods) { if (!mod.m_bEnabled) continue; for (ModScript script : mod.Scripts) { for (ModScriptCallback modCallback : script.Callbacks) { if (modCallback.Context == realContext && modCallback.AfterCallback.length()) { spdlog::info("Running custom {} script callback \"{}\"", GetContextName(realContext), modCallback.AfterCallback); CallScriptInitCallback(sqvm, modCallback.AfterCallback.c_str()); } } } } } return ret; } template void ConCommand_script(const CCommand& args) { g_pSquirrel->ExecuteCode(args.ArgS()); } // literal class type that wraps a constant expression string template struct TemplateStringLiteral { constexpr TemplateStringLiteral(const char (&str)[N]) { std::copy_n(str, N, value); } char value[N]; }; template SQRESULT SQ_StubbedFunc(HSquirrelVM* sqvm) { spdlog::info("Blocking call to stubbed function {} in {}", funcName.value, GetContextName(context)); return SQRESULT_NULL; } template void StubUnsafeSQFuncs() { if (!Tier0::CommandLine()->CheckParm("-allowunsafesqfuncs")) { g_pSquirrel->AddFuncOverride("DevTextBufferWrite", SQ_StubbedFunc); g_pSquirrel->AddFuncOverride("DevTextBufferClear", SQ_StubbedFunc); g_pSquirrel->AddFuncOverride("DevTextBufferDumpToFile", SQ_StubbedFunc); g_pSquirrel->AddFuncOverride("Dev_CommandLineAddParam", SQ_StubbedFunc); g_pSquirrel->AddFuncOverride("DevP4Checkout", SQ_StubbedFunc); g_pSquirrel->AddFuncOverride("DevP4Add", SQ_StubbedFunc); } } ON_DLL_LOAD_RELIESON("client.dll", ClientSquirrel, ConCommand, (CModule module)) { AUTOHOOK_DISPATCH_MODULE(client.dll) g_pSquirrel = new SquirrelManager; g_pSquirrel = new SquirrelManager; g_pSquirrel->__sq_defconst = module.Offset(0x12120).As(); g_pSquirrel->__sq_defconst = g_pSquirrel->__sq_defconst; g_pSquirrel->__sq_compilebuffer = module.Offset(0x3110).As(); g_pSquirrel->__sq_pushroottable = module.Offset(0x5860).As(); g_pSquirrel->__sq_compilebuffer = g_pSquirrel->__sq_compilebuffer; g_pSquirrel->__sq_pushroottable = g_pSquirrel->__sq_pushroottable; g_pSquirrel->__sq_call = module.Offset(0x8650).As(); g_pSquirrel->__sq_call = g_pSquirrel->__sq_call; g_pSquirrel->__sq_newarray = module.Offset(0x39F0).As(); g_pSquirrel->__sq_arrayappend = module.Offset(0x3C70).As(); g_pSquirrel->__sq_newarray = g_pSquirrel->__sq_newarray; g_pSquirrel->__sq_arrayappend = g_pSquirrel->__sq_arrayappend; g_pSquirrel->__sq_newtable = module.Offset(0x3960).As(); g_pSquirrel->__sq_newslot = module.Offset(0x70B0).As(); g_pSquirrel->__sq_newtable = g_pSquirrel->__sq_newtable; g_pSquirrel->__sq_newslot = g_pSquirrel->__sq_newslot; g_pSquirrel->__sq_pushstring = module.Offset(0x3440).As(); g_pSquirrel->__sq_pushinteger = module.Offset(0x36A0).As(); g_pSquirrel->__sq_pushfloat = module.Offset(0x3800).As(); g_pSquirrel->__sq_pushbool = module.Offset(0x3710).As(); g_pSquirrel->__sq_pushasset = module.Offset(0x3560).As(); g_pSquirrel->__sq_pushvector = module.Offset(0x3780).As(); g_pSquirrel->__sq_raiseerror = module.Offset(0x8470).As(); g_pSquirrel->__sq_pushstring = g_pSquirrel->__sq_pushstring; g_pSquirrel->__sq_pushinteger = g_pSquirrel->__sq_pushinteger; g_pSquirrel->__sq_pushfloat = g_pSquirrel->__sq_pushfloat; g_pSquirrel->__sq_pushbool = g_pSquirrel->__sq_pushbool; g_pSquirrel->__sq_pushvector = g_pSquirrel->__sq_pushvector; g_pSquirrel->__sq_pushasset = g_pSquirrel->__sq_pushasset; g_pSquirrel->__sq_raiseerror = g_pSquirrel->__sq_raiseerror; g_pSquirrel->__sq_getstring = module.Offset(0x60C0).As(); g_pSquirrel->__sq_getinteger = module.Offset(0x60E0).As(); g_pSquirrel->__sq_getfloat = module.Offset(0x6100).As(); g_pSquirrel->__sq_getbool = module.Offset(0x6130).As(); g_pSquirrel->__sq_get = module.Offset(0x7C30).As(); g_pSquirrel->__sq_getasset = module.Offset(0x6010).As(); g_pSquirrel->__sq_getuserdata = module.Offset(0x63D0).As(); g_pSquirrel->__sq_getvector = module.Offset(0x6140).As(); g_pSquirrel->__sq_getstring = g_pSquirrel->__sq_getstring; g_pSquirrel->__sq_getinteger = g_pSquirrel->__sq_getinteger; g_pSquirrel->__sq_getfloat = g_pSquirrel->__sq_getfloat; g_pSquirrel->__sq_getbool = g_pSquirrel->__sq_getbool; g_pSquirrel->__sq_get = g_pSquirrel->__sq_get; g_pSquirrel->__sq_getasset = g_pSquirrel->__sq_getasset; g_pSquirrel->__sq_getuserdata = g_pSquirrel->__sq_getuserdata; g_pSquirrel->__sq_getvector = g_pSquirrel->__sq_getvector; g_pSquirrel->__sq_createuserdata = module.Offset(0x38D0).As(); g_pSquirrel->__sq_setuserdatatypeid = module.Offset(0x6490).As(); g_pSquirrel->__sq_createuserdata = g_pSquirrel->__sq_createuserdata; g_pSquirrel->__sq_setuserdatatypeid = g_pSquirrel->__sq_setuserdatatypeid; MAKEHOOK( module.Offset(0x108E0), &RegisterSquirrelFunctionHook, &g_pSquirrel->RegisterSquirrelFunc); g_pSquirrel->RegisterSquirrelFunc = g_pSquirrel->RegisterSquirrelFunc; // uiscript_reset concommand: don't loop forever if compilation fails module.Offset(0x3C6E4C).NOP(6); MAKEHOOK(module.Offset(0x8AD0), &sq_compiler_createHook, &sq_compiler_create); MAKEHOOK(module.Offset(0x12B00), &SQPrintHook, &SQPrint); MAKEHOOK(module.Offset(0x12BA0), &SQPrintHook, &SQPrint); MAKEHOOK(module.Offset(0x26130), &CreateNewVMHook, &CreateNewVM); MAKEHOOK(module.Offset(0x26E70), &DestroyVMHook, &DestroyVM); MAKEHOOK(module.Offset(0x79A50), &ScriptCompileErrorHook, &SQCompileError); MAKEHOOK( module.Offset(0x10190), &CallScriptInitCallbackHook, &CallScriptInitCallback); RegisterConCommand("script_client", ConCommand_script, "Executes script code on the client vm", FCVAR_CLIENTDLL); RegisterConCommand("script_ui", ConCommand_script, "Executes script code on the ui vm", FCVAR_CLIENTDLL); StubUnsafeSQFuncs(); StubUnsafeSQFuncs(); } ON_DLL_LOAD_RELIESON("server.dll", ServerSquirrel, ConCommand, (CModule module)) { AUTOHOOK_DISPATCH_MODULE(server.dll) g_pSquirrel = new SquirrelManager; g_pSquirrel->__sq_defconst = module.Offset(0x1F550).As(); g_pSquirrel->__sq_compilebuffer = module.Offset(0x3110).As(); g_pSquirrel->__sq_pushroottable = module.Offset(0x5840).As(); g_pSquirrel->__sq_call = module.Offset(0x8620).As(); g_pSquirrel->__sq_newarray = module.Offset(0x39F0).As(); g_pSquirrel->__sq_arrayappend = module.Offset(0x3C70).As(); g_pSquirrel->__sq_newtable = module.Offset(0x3960).As(); g_pSquirrel->__sq_newslot = module.Offset(0x7080).As(); g_pSquirrel->__sq_pushstring = module.Offset(0x3440).As(); g_pSquirrel->__sq_pushinteger = module.Offset(0x36A0).As(); g_pSquirrel->__sq_pushfloat = module.Offset(0x3800).As(); g_pSquirrel->__sq_pushbool = module.Offset(0x3710).As(); g_pSquirrel->__sq_pushasset = module.Offset(0x3560).As(); g_pSquirrel->__sq_pushvector = module.Offset(0x3780).As(); g_pSquirrel->__sq_raiseerror = module.Offset(0x8440).As(); g_pSquirrel->__sq_getstring = module.Offset(0x60A0).As(); g_pSquirrel->__sq_getinteger = module.Offset(0x60C0).As(); g_pSquirrel->__sq_getfloat = module.Offset(0x60E0).As(); g_pSquirrel->__sq_getbool = module.Offset(0x6110).As(); g_pSquirrel->__sq_getasset = module.Offset(0x5FF0).As(); g_pSquirrel->__sq_getuserdata = module.Offset(0x63B0).As(); g_pSquirrel->__sq_getvector = module.Offset(0x6120).As(); g_pSquirrel->__sq_get = module.Offset(0x7C00).As(); g_pSquirrel->__sq_createuserdata = module.Offset(0x38D0).As(); g_pSquirrel->__sq_setuserdatatypeid = module.Offset(0x6470).As(); MAKEHOOK( module.Offset(0x1DD10), &RegisterSquirrelFunctionHook, &g_pSquirrel->RegisterSquirrelFunc); MAKEHOOK(module.Offset(0x8AA0), &sq_compiler_createHook, &sq_compiler_create); MAKEHOOK(module.Offset(0x1FE90), &SQPrintHook, &SQPrint); MAKEHOOK(module.Offset(0x260E0), &CreateNewVMHook, &CreateNewVM); MAKEHOOK(module.Offset(0x26E20), &DestroyVMHook, &DestroyVM); MAKEHOOK(module.Offset(0x799E0), &ScriptCompileErrorHook, &SQCompileError); MAKEHOOK(module.Offset(0x1D5C0), &CallScriptInitCallbackHook, &CallScriptInitCallback); // FCVAR_CHEAT and FCVAR_GAMEDLL_FOR_REMOTE_CLIENTS allows clients to execute this, but since it's unsafe we only allow it when cheats // are enabled for script_client and script_ui, we don't use cheats, so clients can execute them on themselves all they want RegisterConCommand( "script", ConCommand_script, "Executes script code on the server vm", FCVAR_GAMEDLL | FCVAR_GAMEDLL_FOR_REMOTE_CLIENTS | FCVAR_CHEAT); StubUnsafeSQFuncs(); }