3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
16 #include "sourcemod.h"
17 #include "sourcemm_api.h"
18 #include "systems/LibrarySys.h"
19 #include "vm/sp_vm_engine.h"
20 #include <sh_string.h>
21 #include "PluginSys.h"
23 #include "CoreConfig.h"
25 #include "ExtensionSys.h"
26 #include "AdminCache.h"
27 #include "sm_stringutil.h"
28 #include "PlayerManager.h"
29 #include "Translator.h"
30 #include "ForwardSys.h"
32 #include "MenuStyle_Valve.h"
33 #include "MenuStyle_Radio.h"
35 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
36 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
37 SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, false, bool);
39 SourcePawnEngine g_SourcePawn;
40 SourceModBase g_SourceMod;
42 ILibrary *g_pJIT = NULL;
43 SourceHook::String g_BaseDir;
44 ISourcePawnEngine *g_pSourcePawn = &g_SourcePawn;
45 IVirtualMachine *g_pVM;
46 IdentityToken_t *g_pCoreIdent = NULL;
47 float g_LastTime = 0.0f;
48 float g_LastMenuTime = 0.0f;
49 float g_LastAuthCheck = 0.0f;
50 IForward *g_pOnGameFrame = NULL;
51 IForward *g_pOnMapEnd = NULL;
52 bool g_Loaded = false;
53 int g_StillFrames = 0;
54 float g_StillTime = 0.0f;
56 typedef int (*GIVEENGINEPOINTER)(ISourcePawnEngine *);
57 typedef unsigned int (*GETEXPORTCOUNT)();
58 typedef IVirtualMachine *(*GETEXPORT)(unsigned int);
59 typedef void (*NOTIFYSHUTDOWN)();
63 NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
69 g_pJIT->CloseLibrary();
72 SourceModBase::SourceModBase()
74 m_IsMapLoading = false;
75 m_ExecPluginReload = false;
76 m_ExecOnMapEnd = false;
77 m_GotBasePath = false;
80 ConfigResult SourceModBase::OnSourceModConfigChanged(const char *key,
86 if (strcasecmp(key, "BasePath") == 0)
88 if (source == ConfigSource_Console)
90 UTIL_Format(error, maxlength, "Cannot be set at runtime");
91 return ConfigResult_Reject;
96 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/%s", g_BaseDir.c_str(), value);
97 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), value);
102 return ConfigResult_Accept;
105 return ConfigResult_Ignore;
108 bool SourceModBase::InitializeSourceMod(char *error, size_t maxlength, bool late)
110 const char *gamepath = g_SMAPI->GetBaseDir();
112 /* Store full path to game */
113 g_BaseDir.assign(gamepath);
115 /* Store name of game directory by itself */
116 size_t len = strlen(gamepath);
117 for (size_t i = len - 1; i >= 0; i--)
119 if (gamepath[i] == PLATFORM_SEP_CHAR)
121 strncopy(m_ModDir, &gamepath[++i], sizeof(m_ModDir));
126 /* Initialize CoreConfig so we can get SourceMod base path properly - this basically parses core.cfg */
127 g_CoreConfig.Initialize();
129 /* This shouldn't happen, but can't hurt to be safe */
130 if (!g_LibSys.PathExists(m_SMBaseDir) || !m_GotBasePath)
132 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/addons/sourcemod", g_BaseDir.c_str());
133 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "addons/sourcemod");
134 m_GotBasePath = true;
137 /* Attempt to load the JIT! */
138 char file[PLATFORM_MAX_PATH];
140 g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
145 g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
148 if (error && maxlength)
150 snprintf(error, maxlength, "%s (failed to load bin/sourcepawn.jit.x86.%s)",
158 GIVEENGINEPOINTER jit_init = (GIVEENGINEPOINTER)g_pJIT->GetSymbolAddress("GiveEnginePointer");
162 if (error && maxlength)
164 snprintf(error, maxlength, "Failed to find GiveEnginePointer in JIT!");
169 if ((err=jit_init(g_pSourcePawn)) != 0)
172 if (error && maxlength)
174 snprintf(error, maxlength, "GiveEnginePointer returned %d in the JIT", err);
179 GETEXPORTCOUNT jit_getnum = (GETEXPORTCOUNT)g_pJIT->GetSymbolAddress("GetExportCount");
180 GETEXPORT jit_get = (GETEXPORT)g_pJIT->GetSymbolAddress("GetExport");
184 if (error && maxlength)
186 snprintf(error, maxlength, "JIT is missing a necessary export!");
191 unsigned int num = jit_getnum();
192 if (!num || ((g_pVM=jit_get(0)) == NULL))
195 if (error && maxlength)
197 snprintf(error, maxlength, "JIT did not export any virtual machines!");
202 unsigned int api = g_pVM->GetAPIVersion();
203 /* :TODO: clean this up (see amb398) */
204 if (api > SOURCEPAWN_VM_API_VERSION || api < 2)
207 if (error && maxlength)
209 snprintf(error, maxlength, "JIT is not a compatible version");
214 /* Hook this now so we can detect startup without calling StartSourceMod() */
215 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
217 /* Only load if we're not late */
220 StartSourceMod(false);
226 void SourceModBase::StartSourceMod(bool late)
228 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
229 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, this, &SourceModBase::GameFrame, false);
231 enginePatch = SH_GET_CALLCLASS(engine);
232 gamedllPatch = SH_GET_CALLCLASS(gamedll);
235 SMGlobalClass *pBase = SMGlobalClass::head;
238 pBase->OnSourceModStartup(false);
239 pBase = pBase->m_pGlobalClassNext;
242 /* Make the global core identity */
243 g_pCoreIdent = g_ShareSys.CreateCoreIdentity();
246 pBase = SMGlobalClass::head;
249 pBase->OnSourceModAllInitialized();
250 pBase = pBase->m_pGlobalClassNext;
254 g_ShareSys.AddInterface(NULL, this);
260 static bool g_LevelEndBarrier = false;
261 bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
263 /* If we're not loaded... */
266 /* Do all global initialization now */
267 StartSourceMod(true);
270 m_IsMapLoading = true;
271 m_ExecPluginReload = true;
272 m_ExecOnMapEnd = true;
274 g_LastMenuTime = 0.0f;
275 g_LastAuthCheck = 0.0f;
276 g_SimTicks.ticking = true;
277 g_SimTicks.tickcount = 0;
282 SMGlobalClass *pBase = SMGlobalClass::head;
285 pBase->OnSourceModLevelChange(pMapName);
286 pBase = pBase->m_pGlobalClassNext;
289 DoGlobalPluginLoads();
291 m_IsMapLoading = false;
294 pBase = SMGlobalClass::head;
297 pBase->OnSourceModPluginsLoaded();
298 pBase = pBase->m_pGlobalClassNext;
303 g_pOnGameFrame = g_Forwards.CreateForward("OnGameFrame", ET_Ignore, 0, NULL);
308 g_pOnMapEnd = g_Forwards.CreateForward("OnMapEnd", ET_Ignore, 0, NULL);
311 g_LevelEndBarrier = true;
313 RETURN_META_VALUE(MRES_IGNORED, true);
316 void StartTickSimulation()
318 g_SimTicks.ticking = false;
319 g_SimTicks.tickcount = 0;
320 g_SimTicks.ticktime = gpGlobals->curtime;
323 void StopTickSimulation()
325 g_SimTicks.ticking = true;
326 g_Timers.MapChange();
328 g_LastTime = gpGlobals->curtime;
333 g_SimTicks.tickcount++;
334 g_SimTicks.ticktime = g_StillTime + (g_SimTicks.tickcount * gpGlobals->interval_per_tick);
337 void SourceModBase::GameFrame(bool simulating)
340 * Note: This is all hardcoded rather than delegated to save
341 * precious CPU cycles.
343 float curtime = gpGlobals->curtime;
344 int framecount = gpGlobals->framecount;
346 /* Verify that we're still ticking */
347 if (g_SimTicks.ticking)
349 if (g_StillFrames == 0)
351 g_StillFrames = framecount;
352 g_StillTime = curtime;
354 /* Try to detect when we've stopped ticking.
355 * We do this once 10 frames pass and there have been no ticks.
357 if (g_StillTime == curtime)
359 if (framecount - g_StillFrames >= 5)
361 StartTickSimulation();
365 /* We're definitely ticking we get here,
366 * but update everything as a precaution */
367 g_StillFrames = framecount;
368 g_StillTime = curtime;
372 /* We need to make sure we should still be simulating. */
373 if (g_StillTime != curtime)
375 /* Wow, we're ticking again! It's time to revert. */
376 StopTickSimulation();
379 /* Nope, not ticking. Simulate! */
381 curtime = g_SimTicks.ticktime;
384 if (curtime - g_LastTime >= 0.1f)
387 && (gpGlobals->curtime - g_LastAuthCheck > 0.7f))
389 g_LastAuthCheck = gpGlobals->curtime;
390 g_Players.RunAuthChecks();
394 g_LastTime = curtime;
397 if (g_SimTicks.ticking && curtime - g_LastMenuTime >= 1.0f)
399 g_ValveMenuStyle.ProcessWatchList();
400 g_RadioMenuStyle.ProcessWatchList();
401 g_LastMenuTime = curtime;
404 if (g_pOnGameFrame && g_pOnGameFrame->GetFunctionCount())
406 g_pOnGameFrame->Execute(NULL);
410 void SourceModBase::LevelShutdown()
412 if (g_LevelEndBarrier)
414 SMGlobalClass *next = SMGlobalClass::head;
417 next->OnSourceModLevelEnd();
418 next = next->m_pGlobalClassNext;
420 g_LevelEndBarrier = false;
423 if (g_pOnMapEnd && m_ExecOnMapEnd)
425 g_pOnMapEnd->Execute(NULL);
426 m_ExecOnMapEnd = false;
429 g_OnMapStarted = false;
431 if (m_ExecPluginReload)
433 g_PluginSys.ReloadOrUnloadPlugins();
434 m_ExecPluginReload = false;
438 bool SourceModBase::IsMapLoading() const
440 return m_IsMapLoading;
443 void SourceModBase::DoGlobalPluginLoads()
445 char config_path[PLATFORM_MAX_PATH];
446 char plugins_path[PLATFORM_MAX_PATH];
448 BuildPath(Path_SM, config_path,
450 "configs/plugin_settings.cfg");
451 BuildPath(Path_SM, plugins_path,
452 sizeof(plugins_path),
455 /* Load any auto extensions */
456 g_Extensions.TryAutoload();
458 /* Run the first pass */
459 g_PluginSys.LoadAll_FirstPass(config_path, plugins_path);
461 /* Mark any extensions as loaded */
462 g_Extensions.MarkAllLoaded();
464 /* No modules yet, it's safe to call this from here */
465 g_PluginSys.LoadAll_SecondPass();
467 /* Re-mark any extensions as loaded */
468 g_Extensions.MarkAllLoaded();
471 size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, char *format, ...)
473 char _buffer[PLATFORM_MAX_PATH];
476 va_start(ap, format);
477 vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
480 const char *base = NULL;
481 if (type == Path_Game)
483 base = GetGamePath();
484 } else if (type == Path_SM) {
485 base = GetSourceModPath();
486 } else if (type == Path_SM_Rel) {
492 return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
494 return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
498 void SourceModBase::CloseSourceMod()
500 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
506 g_Forwards.ReleaseForward(g_pOnGameFrame);
511 g_Forwards.ReleaseForward(g_pOnMapEnd);
515 SMGlobalClass *pBase = SMGlobalClass::head;
518 pBase->OnSourceModShutdown();
519 pBase = pBase->m_pGlobalClassNext;
522 /* Delete all data packs */
523 CStack<CDataPack *>::iterator iter;
525 for (iter=m_freepacks.begin(); iter!=m_freepacks.end(); iter++)
530 m_freepacks.popall();
533 pBase = SMGlobalClass::head;
536 pBase->OnSourceModAllShutdown();
537 pBase = pBase->m_pGlobalClassNext;
542 SH_RELEASE_CALLCLASS(enginePatch);
548 SH_RELEASE_CALLCLASS(gamedllPatch);
552 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
553 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, this, &SourceModBase::GameFrame, false);
560 void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
562 IExtensionInterface *pAPI = pExt->GetAPI();
563 const char *tag = pAPI->GetExtensionTag();
567 va_start(ap, format);
568 vsnprintf(buffer, sizeof(buffer), format, ap);
573 g_Logger.LogMessage("[%s] %s", tag, buffer);
575 g_Logger.LogMessage("%s", buffer);
579 void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
581 IExtensionInterface *pAPI = pExt->GetAPI();
582 const char *tag = pAPI->GetExtensionTag();
586 va_start(ap, format);
587 vsnprintf(buffer, sizeof(buffer), format, ap);
592 g_Logger.LogError("[%s] %s", tag, buffer);
594 g_Logger.LogError("%s", buffer);
598 size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
602 pContext->LocalToString(params[param], &fmt);
604 int lparam = ++param;
606 return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
609 const char *SourceModBase::GetSourceModPath() const
614 const char *SourceModBase::GetGamePath() const
616 return g_BaseDir.c_str();
619 void SourceModBase::SetGlobalTarget(unsigned int index)
624 void SourceModBase::SetAuthChecking(bool set)
626 m_CheckingAuth = set;
629 unsigned int SourceModBase::GetGlobalTarget() const
634 IDataPack *SourceModBase::CreateDataPack()
637 if (m_freepacks.empty())
639 pack = new CDataPack;
641 pack = m_freepacks.front();
648 void SourceModBase::FreeDataPack(IDataPack *pack)
650 m_freepacks.push(static_cast<CDataPack *>(pack));
653 Handle_t SourceModBase::GetDataPackHandleType(bool readonly)
659 const char *SourceModBase::GetGameFolderName() const
664 ISourcePawnEngine *SourceModBase::GetScriptingEngine()
666 return g_pSourcePawn;
669 IVirtualMachine *SourceModBase::GetScriptingVM()
674 void SourceModBase::AllPluginsLoaded()
676 SMGlobalClass *base = SMGlobalClass::head;
679 base->OnSourceModGameInitialized();
680 base = base->m_pGlobalClassNext;
684 SMGlobalClass *SMGlobalClass::head = NULL;
686 SMGlobalClass::SMGlobalClass()
688 m_pGlobalClassNext = SMGlobalClass::head;
689 SMGlobalClass::head = this;