1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
11 #include "convar_smm.h"
14 #include "concommands.h"
16 #include "vsp_listener.h"
19 * @brief Implementation of main API interface
23 using namespace SourceMM;
37 m_UserMessages.RemoveAll();
40 void CSmmAPI::LogMsg(ISmmPlugin *pl, const char *msg, ...)
43 static char buffer[2048];
48 vsnprintf(buffer, sizeof(buffer)-1, msg, ap);
51 LogMessage("[%s] %s", pl->GetLogTag(), buffer);
54 CreateInterfaceFn CSmmAPI::engineFactory(bool syn)
58 return g_Engine.engineFactory;
61 CreateInterfaceFn CSmmAPI::physicsFactory(bool syn)
64 return PhysicsFactory;
65 return g_Engine.physicsFactory;
68 CreateInterfaceFn CSmmAPI::fileSystemFactory(bool syn)
71 return FileSystemFactory;
72 return g_Engine.fileSystemFactory;
75 CreateInterfaceFn CSmmAPI::serverFactory(bool syn)
78 return CreateInterface;
79 return g_GameDll.factory;
82 CGlobalVars *CSmmAPI::pGlobals()
84 return g_Engine.pGlobals;
87 void CSmmAPI::SetLastMetaReturn(META_RES res)
92 META_RES CSmmAPI::GetLastMetaReturn()
97 IConCommandBaseAccessor *CSmmAPI::GetCvarBaseAccessor()
99 return static_cast<IConCommandBaseAccessor *>(&g_SMConVarAccessor);
102 bool CSmmAPI::RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
104 if (pCommand->IsCommand())
106 g_PluginMngr.AddPluginCmd(plugin, pCommand);
108 g_PluginMngr.AddPluginCvar(plugin, pCommand);
111 return g_SMConVarAccessor.Register(pCommand);
114 void CSmmAPI::UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand)
116 if (pCommand->IsCommand())
118 g_PluginMngr.RemovePluginCmd(plugin, pCommand);
120 g_PluginMngr.RemovePluginCvar(plugin, pCommand);
123 g_SMConVarAccessor.Unregister(pCommand);
126 void CSmmAPI::ConPrint(const char *fmt)
128 (m_ConPrintf)("%s", fmt);
131 void CSmmAPI::ConPrintf(const char *fmt, ...)
134 static char buf[4096];
136 vsnprintf(buf, sizeof(buf)-1, fmt, ap);
141 void CSmmAPI::AddListener(ISmmPlugin *plugin, IMetamodListener *pListener)
143 CPluginManager::CPlugin *pl = g_PluginMngr.FindByAPI(plugin);
145 pl->m_Events.push_back(pListener);
148 void *CSmmAPI::MetaFactory(const char *iface, int *_ret, PluginId *id)
160 //first check ours... we get first chance!
161 if (strcmp(iface, MMIFACE_SOURCEHOOK) == 0)
167 return static_cast<void *>(static_cast<SourceHook::ISourceHook *>(&g_SourceHook));
168 } else if (strcmp(iface, MMIFACE_PLMANAGER) == 0) {
173 return static_cast<void *>(static_cast<ISmmPluginManager *>(&g_PluginMngr));
176 CPluginManager::CPlugin *pl;
177 SourceHook::List<IMetamodListener *>::iterator event;
178 IMetamodListener *api;
182 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++)
185 for (event=pl->m_Events.begin(); event!=pl->m_Events.end(); event++)
189 if ( (val=api->OnMetamodQuery(iface, &ret)) != NULL )
201 *_ret = IFACE_FAILED;
206 //////////////////////////////////////////////////////////////////////////
207 //THERE BE HAX HERE!!!! DON'T TELL ALFRED, BUT GABE WANTED IT THAT WAY. //
208 // (note: you can find the offset by looking for the text //
209 // "Echo text to console", you'll find the callback cmd pushed on the //
211 //////////////////////////////////////////////////////////////////////////
214 #define ENGINE486_SIG "\x55\x89\xE5\x53\x83\xEC\x14\xBB"
215 #define ENGINE486_OFFS 40
216 #define ENGINE686_SIG "\x53\x83\xEC\x08\xBB\x01\x00\x00"
217 #define ENGINE686_OFFS 50
218 #define ENGINEAMD_SIG "\x53\x51\xBB\x01\x00\x00\x00\x51"
219 #define ENGINEAMD_OFFS 47
220 #define ENGINEW32_SIG "\xA1\x2A\x2A\x2A\x2A\x56\xBE\x01"
221 #define ENGINEW32_OFFS 38
222 #define IA32_CALL 0xE8
224 bool vcmp(const void *_addr1, const void *_addr2, size_t len)
226 unsigned char *addr1 = (unsigned char *)_addr1;
227 unsigned char *addr2 = (unsigned char *)_addr2;
229 for (size_t i=0; i<len; i++)
233 if (addr1[i] != addr2[i])
240 //Thanks to fysh for the idea of extracting info from "echo" and for
241 // having the original offsets at hand!
242 bool CSmmAPI::CacheCmds()
244 ICvar *pCvar = g_Engine.icvar;
246 ConCommandBase *pBase = pCvar->GetCommands();
247 unsigned char *ptr = NULL;
248 FnCommandCallback callback = NULL;
253 if ( strcmp(pBase->GetName(), "echo") == 0 )
255 //callback = //*((FnCommandCallback *)((char *)pBase + offsetof(ConCommand, m_fnCommandCallback)));
256 callback = ((ConCommand *)pBase)->GetCallback();
257 ptr = (unsigned char *)callback;
259 if (vcmp(ptr, ENGINE486_SIG, SIGLEN))
261 offs = ENGINE486_OFFS;
263 else if (vcmp(ptr, ENGINE686_SIG, SIGLEN))
265 offs = ENGINE686_OFFS;
267 else if (vcmp(ptr, ENGINEAMD_SIG, SIGLEN))
269 offs = ENGINEAMD_OFFS;
271 #elif defined OS_WIN32 // Only one Windows engine binary so far...
272 if (vcmp(ptr, ENGINEW32_SIG, SIGLEN))
274 offs = ENGINEW32_OFFS;
278 if (!offs || ptr[offs-1] != IA32_CALL)
280 m_ConPrintf = (CONPRINTF_FUNC)Msg;
283 //get the relative offset
284 m_ConPrintf = *((CONPRINTF_FUNC *)(ptr + offs));
285 //add the base offset, to the ip (which is the address+offset + 4 bytes for next instruction)
286 m_ConPrintf = (CONPRINTF_FUNC)((unsigned long)m_ConPrintf + (unsigned long)(ptr + offs) + 4);
292 pBase = const_cast<ConCommandBase *>(pBase->GetNext());
295 m_ConPrintf = (CONPRINTF_FUNC)Msg;
300 bool CSmmAPI::CmdCacheSuccessful()
305 void CSmmAPI::GetApiVersions(int &major, int &minor, int &plvers, int &plmin)
307 major = SM_VERS_API_MAJOR;
308 minor = SM_VERS_API_MINOR;
309 plvers = PLAPI_VERSION;
310 plmin = PLAPI_MIN_VERSION;
313 void CSmmAPI::GetShVersions(int &shvers, int &shimpl)
315 shvers = SH_IFACE_VERSION;
316 shimpl = SH_IMPL_VERSION;
319 int CSmmAPI::FormatIface(char iface[], unsigned int maxlength)
321 int length = (int)strlen(iface);
325 for (i=length-1; i>=0; i--)
327 if (!isdigit(iface[i]))
337 if ( (num && ((int)maxlength <= length)) || (!num && ((int)maxlength <= length+3)) )
343 num = atoi(&(iface[++i]));
347 snprintf(&(iface[i]), 4, "%03d", num);
352 void *CSmmAPI::InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret)
354 char _if[256]; /* assume no interface goes beyond this */
355 size_t len = strlen(iface);
362 if (len + 4 > sizeof(_if))
375 if ( (pf = (fn)(_if, ret)) != NULL )
379 } while (( num = FormatIface(_if, len+1) ));
384 void *CSmmAPI::VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min)
386 char buffer[256]; /* assume no interface will go beyond this */
387 int len = static_cast<int>(strlen(iface));
388 int ret; /* just in case something doesn't handle NULL properly */
390 if (len > static_cast<int>(sizeof(buffer) - 4))
395 strcpy(buffer, iface);
399 char *ptr = &buffer[len-1];
401 while (isdigit(*ptr) && digits <=3)
409 /* for now, assume this is an error */
410 strcpy(buffer, iface);
413 min = (min == 0) ? 1 : min;
414 snprintf(num, sizeof(num), "%03d", min);
419 return InterfaceSearch(fn, buffer, IFACE_MAXNUM, &ret);
422 const char *CSmmAPI::GetBaseDir()
424 return g_ModPath.c_str();
427 void CSmmAPI::PathFormat(char *buffer, size_t len, const char *fmt, ...)
431 size_t mylen = vsnprintf(buffer, len, fmt, ap);
434 if (mylen == 0xFFFFFFFF || mylen >= len)
439 for (size_t i=0; i<mylen; i++)
441 if (buffer[i] == ALT_SEP_CHAR)
442 buffer[i] = PATH_SEP_CHAR;
446 void CSmmAPI::ClientConPrintf(edict_t *client, const char *fmt, ...)
449 static char buf[4096];
451 vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
452 g_Engine.engine->ClientPrintf(client, buf);
456 void CSmmAPI::LoadAsVSP()
458 g_Engine.engine->ServerCommand("plugin_load \n");
459 g_Engine.engine->ServerExecute();
461 IServerPluginCallbacks *iface = NULL;
462 if (g_VspListener.IsLoaded())
464 iface = &g_VspListener;
468 CPluginManager::CPlugin *pPlugin;
469 SourceHook::List<IMetamodListener *>::iterator event;
470 IMetamodListener *pML;
471 for (iter=g_PluginMngr._begin(); iter!=g_PluginMngr._end(); iter++)
474 if (pPlugin->m_Status < Pl_Paused)
478 /* Only valid for plugins >= 10 (v1:5, SourceMM 1.4) */
479 if (pPlugin->m_API->GetApiVersion() < 10)
483 for (event=pPlugin->m_Events.begin();
484 event!=pPlugin->m_Events.end();
488 pML->OnVSPListening(iface);
493 void CSmmAPI::EnableVSPListener()
495 /* If GameInit already passed and we're not already enabled or loaded, go ahead and LoadAsVSP load */
496 if (bGameInit && !m_VSP && !g_VspListener.IsLoaded())
503 int CSmmAPI::GetGameDLLVersion()
505 return g_GameDllVersion;
508 //////////////////////////////////////////////////////////////////////
509 // EVEN MORE HACKS HERE! YOU HAVE BEEN WARNED! //
510 // Signatures necessary in finding the pointer to the CUtlDict that //
511 // stores user message information. //
512 // IServerGameDLL::GetUserMessageInfo() normally crashes with bad //
513 // message indices. This is our answer to it. Yuck! <:-( //
514 //////////////////////////////////////////////////////////////////////
516 /* General Windows sig */
517 #define MSGCLASS_SIGLEN 7
518 #define MSGCLASS_SIG "\x8B\x0D\x2A\x2A\x2A\x2A\x56"
519 #define MSGCLASS_OFFS 2
521 /* Dystopia Wimdows hack */
522 #define MSGCLASS2_SIGLEN 16
523 #define MSGCLASS2_SIG "\x56\x8B\x74\x24\x2A\x85\xF6\x7C\x2A\x3B\x35\x2A\x2A\x2A\x2A\x7D"
524 #define MSGCLASS2_OFFS 11
525 #elif defined OS_LINUX
526 /* No frame pointer sig */
527 #define MSGCLASS_SIGLEN 14
528 #define MSGCLASS_SIG "\x53\x83\xEC\x2A\x8B\x2A\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
529 #define MSGCLASS_OFFS 9
531 /* Frame pointer sig */
532 #define MSGCLASS2_SIGLEN 16
533 #define MSGCLASS2_SIG "\x55\x89\xE5\x53\x83\xEC\x2A\x8B\x2A\x2A\xA1\x2A\x2A\x2A\x2A\x89"
534 #define MSGCLASS2_OFFS 11
537 /* This is the ugliest function in all of SourceMM */
538 /* :TODO: Make this prettier */
539 bool CSmmAPI::CacheUserMessages()
541 SourceHook::MemFuncInfo info = {true, -1, 0, 0};
542 SourceHook::GetFuncInfo(&IServerGameDLL::GetUserMessageInfo, info);
544 /* Get address of original GetUserMessageInfo() */
545 char *vfunc = reinterpret_cast<char *>(g_GameDllPatch->GetOrigFunc(info.vtbloffs, info.vtblindex));
547 /* If we can't get original function, that means there's no hook */
550 /* Get virtual function address 'manually' then */
551 char *adjustedptr = reinterpret_cast<char *>(g_GameDll.pGameDLL) + info.thisptroffs + info.vtbloffs;
552 char **vtable = *reinterpret_cast<char ***>(adjustedptr);
554 vfunc = vtable[info.vtblindex];
557 UserMsgDict *dict = NULL;
559 if (vcmp(vfunc, MSGCLASS_SIG, MSGCLASS_SIGLEN))
561 /* Get address of CUserMessages instance */
562 char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS_OFFS);
564 /* Get address of CUserMessages::m_UserMessages */
565 dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
566 } else if (vcmp(vfunc, MSGCLASS2_SIG, MSGCLASS2_SIGLEN)) {
568 /* If we get here, the code is possibly inlined like in Dystopia */
570 /* Get the address of the CUtlRBTree */
571 char *rbtree = *reinterpret_cast<char **>(vfunc + MSGCLASS2_OFFS);
573 /* CUtlDict should be 8 bytes before the CUtlRBTree (hacktacular!) */
574 dict = reinterpret_cast<UserMsgDict *>(rbtree - 8);
575 #elif defined OS_LINUX
576 /* Get address of CUserMessages instance */
577 char **userMsgClass = *reinterpret_cast<char ***>(vfunc + MSGCLASS2_OFFS);
579 /* Get address of CUserMessages::m_UserMessages */
580 dict = reinterpret_cast<UserMsgDict *>(*userMsgClass);
586 m_MsgCount = dict->Count();
588 /* Ensure that count is within bounds of an unsigned byte, because that's what engine supports */
589 if (m_MsgCount < 0 || m_MsgCount > 255)
597 /* Cache messages in our CUtlDict */
598 for (int i = 0; i < m_MsgCount; i++)
600 msg = dict->Element(i);
601 m_UserMessages.Insert(msg->name, msg);
610 bool CSmmAPI::MsgCacheSuccessful()
612 return m_MsgCount > -1;
615 int CSmmAPI::GetUserMessageCount()
620 int CSmmAPI::FindUserMessage(const char *name, int *size)
622 int index = m_UserMessages.Find(name);
624 if (size && index > -1)
626 UserMessage *msg = m_UserMessages.Element(index);
633 const char *CSmmAPI::GetUserMessage(int index, int *size)
635 if (m_MsgCount <= 0 || index < 0 || index >= m_MsgCount)
640 UserMessage *msg = m_UserMessages.Element(index);