3 * =============================================================================
5 * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
33 #include "sourcemod.h"
34 #include "sourcemm_api.h"
35 #include "systems/LibrarySys.h"
36 #include "vm/sp_vm_engine.h"
37 #include <sh_string.h>
38 #include "PluginSys.h"
40 #include "CoreConfig.h"
42 #include "ExtensionSys.h"
43 #include "AdminCache.h"
44 #include "sm_stringutil.h"
45 #include "PlayerManager.h"
46 #include "Translator.h"
47 #include "ForwardSys.h"
49 #include "GameConfigs.h"
51 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
52 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
53 SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, false, bool);
54 SH_DECL_HOOK1_void(IVEngineServer, ServerCommand, SH_NOATTRIB, false, const char *);
56 SourcePawnEngine g_SourcePawn;
57 SourceModBase g_SourceMod;
59 ILibrary *g_pJIT = NULL;
60 SourceHook::String g_BaseDir;
61 ISourcePawnEngine *g_pSourcePawn = &g_SourcePawn;
62 IVirtualMachine *g_pVM;
63 IdentityToken_t *g_pCoreIdent = NULL;
64 IForward *g_pOnMapEnd = NULL;
65 bool g_Loaded = false;
67 typedef int (*GIVEENGINEPOINTER)(ISourcePawnEngine *);
68 typedef int (*GIVEENGINEPOINTER2)(ISourcePawnEngine *, unsigned int api_version);
69 typedef unsigned int (*GETEXPORTCOUNT)();
70 typedef IVirtualMachine *(*GETEXPORT)(unsigned int);
71 typedef void (*NOTIFYSHUTDOWN)();
75 NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
81 g_pJIT->CloseLibrary();
84 SourceModBase::SourceModBase()
86 m_IsMapLoading = false;
87 m_ExecPluginReload = false;
88 m_GotBasePath = false;
91 ConfigResult SourceModBase::OnSourceModConfigChanged(const char *key,
97 if (strcasecmp(key, "BasePath") == 0)
99 if (source == ConfigSource_Console)
101 UTIL_Format(error, maxlength, "Cannot be set at runtime");
102 return ConfigResult_Reject;
107 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/%s", g_BaseDir.c_str(), value);
108 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), value);
110 m_GotBasePath = true;
113 return ConfigResult_Accept;
116 return ConfigResult_Ignore;
119 bool SourceModBase::InitializeSourceMod(char *error, size_t maxlength, bool late)
121 const char *gamepath = g_SMAPI->GetBaseDir();
123 /* Store full path to game */
124 g_BaseDir.assign(gamepath);
126 /* Store name of game directory by itself */
127 size_t len = strlen(gamepath);
128 for (size_t i = len - 1; i >= 0; i--)
130 if (gamepath[i] == PLATFORM_SEP_CHAR)
132 strncopy(m_ModDir, &gamepath[++i], sizeof(m_ModDir));
137 /* Initialize CoreConfig so we can get SourceMod base path properly - this basically parses core.cfg */
138 g_CoreConfig.Initialize();
140 /* This shouldn't happen, but can't hurt to be safe */
141 if (!g_LibSys.PathExists(m_SMBaseDir) || !m_GotBasePath)
143 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/addons/sourcemod", g_BaseDir.c_str());
144 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "addons/sourcemod");
145 m_GotBasePath = true;
148 /* Attempt to load the JIT! */
149 char file[PLATFORM_MAX_PATH];
151 g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
156 g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
159 if (error && maxlength)
161 snprintf(error, maxlength, "%s (failed to load bin/sourcepawn.jit.x86.%s)",
170 GIVEENGINEPOINTER2 jit_init2 = (GIVEENGINEPOINTER2)g_pJIT->GetSymbolAddress("GiveEnginePointer2");
173 GIVEENGINEPOINTER jit_init = (GIVEENGINEPOINTER)g_pJIT->GetSymbolAddress("GiveEnginePointer");
177 if (error && maxlength)
179 snprintf(error, maxlength, "Failed to find GiveEnginePointer in JIT!");
184 if ((err=jit_init(g_pSourcePawn)) != 0)
187 if (error && maxlength)
189 snprintf(error, maxlength, "GiveEnginePointer returned %d in the JIT", err);
194 /* On version bumps, we should check for older versions as well, if the new version fails.
195 * We can then check the exports to see if any VM versions will be sufficient.
197 if ((err=jit_init2(g_pSourcePawn, SOURCEPAWN_ENGINE_API_VERSION)) != SP_ERROR_NONE)
200 if (error && maxlength)
202 snprintf(error, maxlength, "JIT incompatible with SourceMod version");
208 GETEXPORTCOUNT jit_getnum = (GETEXPORTCOUNT)g_pJIT->GetSymbolAddress("GetExportCount");
209 GETEXPORT jit_get = (GETEXPORT)g_pJIT->GetSymbolAddress("GetExport");
213 if (error && maxlength)
215 snprintf(error, maxlength, "JIT is missing a necessary export!");
220 unsigned int num = jit_getnum();
224 if (error && maxlength)
226 snprintf(error, maxlength, "JIT did not export any virtual machines!");
231 unsigned int api_version;
232 for (unsigned int i=0; i<num; i++)
234 if ((g_pVM=jit_get(i)) == NULL)
236 if (error && maxlength)
238 snprintf(error, maxlength, "JIT did not export any virtual machines!");
242 /* Refuse any API that we might not be able to deal with.
243 * Also refuse anything < 3 because we need fake natives.
245 api_version = g_pVM->GetAPIVersion();
246 if (api_version < 3 || api_version > SOURCEPAWN_VM_API_VERSION)
248 if (error && maxlength)
250 snprintf(error, maxlength, "JIT is not a compatible version");
264 /* Hook this now so we can detect startup without calling StartSourceMod() */
265 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
267 /* Only load if we're not late */
270 StartSourceMod(false);
276 void SourceModBase::StartSourceMod(bool late)
278 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
279 SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, &g_Timers, &TimerSystem::GameFrame, false);
281 enginePatch = SH_GET_CALLCLASS(engine);
282 gamedllPatch = SH_GET_CALLCLASS(gamedll);
284 g_ShareSys.Initialize();
286 /* Make the global core identity */
287 g_pCoreIdent = g_ShareSys.CreateCoreIdentity();
290 SMGlobalClass *pBase = SMGlobalClass::head;
293 pBase->OnSourceModStartup(false);
294 pBase = pBase->m_pGlobalClassNext;
298 pBase = SMGlobalClass::head;
301 pBase->OnSourceModAllInitialized();
302 pBase = pBase->m_pGlobalClassNext;
306 pBase = SMGlobalClass::head;
309 pBase->OnSourceModAllInitialized_Post();
310 pBase = pBase->m_pGlobalClassNext;
314 g_ShareSys.AddInterface(NULL, this);
319 /* Initialize VSP stuff */
320 if (vsp_interface != NULL)
322 g_SourceMod_Core.OnVSPListening(vsp_interface);
326 static bool g_LevelEndBarrier = false;
327 bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
329 /* If we're not loaded... */
332 /* Do all global initialization now */
333 StartSourceMod(true);
336 m_IsMapLoading = true;
337 m_ExecPluginReload = true;
340 SMGlobalClass *pBase = SMGlobalClass::head;
343 pBase->OnSourceModLevelChange(pMapName);
344 pBase = pBase->m_pGlobalClassNext;
347 DoGlobalPluginLoads();
349 m_IsMapLoading = false;
352 pBase = SMGlobalClass::head;
355 pBase->OnSourceModPluginsLoaded();
356 pBase = pBase->m_pGlobalClassNext;
361 g_pOnMapEnd = g_Forwards.CreateForward("OnMapEnd", ET_Ignore, 0, NULL);
364 g_LevelEndBarrier = true;
366 RETURN_META_VALUE(MRES_IGNORED, true);
369 void SourceModBase::LevelShutdown()
371 if (g_LevelEndBarrier)
373 SMGlobalClass *next = SMGlobalClass::head;
376 next->OnSourceModLevelEnd();
377 next = next->m_pGlobalClassNext;
380 if (g_pOnMapEnd != NULL)
382 g_pOnMapEnd->Execute(NULL);
385 g_Timers.RemoveMapChangeTimers();
387 g_LevelEndBarrier = false;
390 g_OnMapStarted = false;
392 if (m_ExecPluginReload)
394 g_PluginSys.ReloadOrUnloadPlugins();
395 m_ExecPluginReload = false;
399 bool SourceModBase::IsMapLoading() const
401 return m_IsMapLoading;
404 void SourceModBase::DoGlobalPluginLoads()
406 char config_path[PLATFORM_MAX_PATH];
407 char plugins_path[PLATFORM_MAX_PATH];
409 BuildPath(Path_SM, config_path,
411 "configs/plugin_settings.cfg");
412 BuildPath(Path_SM, plugins_path,
413 sizeof(plugins_path),
416 /* Load any auto extensions */
417 g_Extensions.TryAutoload();
419 /* Fire the extensions ready message */
420 g_SMAPI->MetaFactory(SOURCEMOD_NOTICE_EXTENSIONS, NULL, NULL);
422 /* Load any game extension */
423 const char *game_ext;
424 if ((game_ext = g_pGameConf->GetKeyValue("GameExtension")) != NULL)
426 char path[PLATFORM_MAX_PATH];
427 UTIL_Format(path, sizeof(path), "%s.ext." PLATFORM_LIB_EXT, game_ext);
428 g_Extensions.LoadAutoExtension(path);
431 /* Run the first pass */
432 g_PluginSys.LoadAll_FirstPass(config_path, plugins_path);
434 /* Mark any extensions as loaded */
435 g_Extensions.MarkAllLoaded();
437 /* No modules yet, it's safe to call this from here */
438 g_PluginSys.LoadAll_SecondPass();
440 /* Re-mark any extensions as loaded */
441 g_Extensions.MarkAllLoaded();
443 /* Call OnAllPluginsLoaded */
444 g_PluginSys.AllPluginsLoaded();
447 size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, const char *format, ...)
449 char _buffer[PLATFORM_MAX_PATH];
452 va_start(ap, format);
453 vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
456 /* If we get a "file://" notation, strip off the file:// part so we're left
457 * with an absolute path. Note that the absolute path gets returned, so
458 * usage with relative paths here is completely invalid.
460 if (type != Path_SM_Rel && strncmp(_buffer, "file://", 7) == 0)
462 return g_LibSys.PathFormat(buffer, maxlength, "%s", &_buffer[7]);
465 const char *base = NULL;
466 if (type == Path_Game)
468 base = GetGamePath();
470 else if (type == Path_SM)
472 base = GetSourceModPath();
474 else if (type == Path_SM_Rel)
481 return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
485 return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
489 void SourceModBase::CloseSourceMod()
491 /* Force a level end */
495 g_PluginSys.Shutdown();
497 /* Unload extensions */
498 g_Extensions.Shutdown();
500 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
506 g_Forwards.ReleaseForward(g_pOnMapEnd);
510 SMGlobalClass *pBase = SMGlobalClass::head;
513 pBase->OnSourceModShutdown();
514 pBase = pBase->m_pGlobalClassNext;
517 /* Delete all data packs */
518 CStack<CDataPack *>::iterator iter;
520 for (iter=m_freepacks.begin(); iter!=m_freepacks.end(); iter++)
525 m_freepacks.popall();
528 pBase = SMGlobalClass::head;
531 pBase->OnSourceModAllShutdown();
532 pBase = pBase->m_pGlobalClassNext;
537 SH_RELEASE_CALLCLASS(enginePatch);
543 SH_RELEASE_CALLCLASS(gamedllPatch);
547 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
548 SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, &g_Timers, &TimerSystem::GameFrame, false);
555 void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
557 IExtensionInterface *pAPI = pExt->GetAPI();
558 const char *tag = pAPI->GetExtensionTag();
562 va_start(ap, format);
563 vsnprintf(buffer, sizeof(buffer), format, ap);
568 g_Logger.LogMessage("[%s] %s", tag, buffer);
570 g_Logger.LogMessage("%s", buffer);
574 void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
576 IExtensionInterface *pAPI = pExt->GetAPI();
577 const char *tag = pAPI->GetExtensionTag();
581 va_start(ap, format);
582 vsnprintf(buffer, sizeof(buffer), format, ap);
587 g_Logger.LogError("[%s] %s", tag, buffer);
589 g_Logger.LogError("%s", buffer);
593 size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
597 pContext->LocalToString(params[param], &fmt);
599 int lparam = ++param;
601 return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
604 const char *SourceModBase::GetSourceModPath() const
609 const char *SourceModBase::GetGamePath() const
611 return g_BaseDir.c_str();
614 unsigned int SourceModBase::SetGlobalTarget(unsigned int index)
616 unsigned int old = m_target;
621 unsigned int SourceModBase::GetGlobalTarget() const
626 IDataPack *SourceModBase::CreateDataPack()
629 if (m_freepacks.empty())
631 pack = new CDataPack;
633 pack = m_freepacks.front();
640 void SourceModBase::FreeDataPack(IDataPack *pack)
642 m_freepacks.push(static_cast<CDataPack *>(pack));
645 Handle_t SourceModBase::GetDataPackHandleType(bool readonly)
651 const char *SourceModBase::GetGameFolderName() const
656 ISourcePawnEngine *SourceModBase::GetScriptingEngine()
658 return g_pSourcePawn;
661 IVirtualMachine *SourceModBase::GetScriptingVM()
666 void SourceModBase::AllPluginsLoaded()
668 SMGlobalClass *base = SMGlobalClass::head;
671 base->OnSourceModGameInitialized();
672 base = base->m_pGlobalClassNext;
676 time_t SourceModBase::GetAdjustedTime()
678 return GetAdjustedTime();
681 void SourceModBase::AddGameFrameHook(GAME_FRAME_HOOK hook)
683 m_frame_hooks.push_back(hook);
686 void SourceModBase::RemoveGameFrameHook(GAME_FRAME_HOOK hook)
688 for (size_t i = 0; i < m_frame_hooks.size(); i++)
690 if (m_frame_hooks[i] == hook)
692 m_frame_hooks.erase(m_frame_hooks.iterAt(i));
698 void SourceModBase::ProcessGameFrameHooks(bool simulating)
700 if (m_frame_hooks.size() == 0)
705 for (size_t i = 0; i < m_frame_hooks.size(); i++)
707 m_frame_hooks[i](simulating);
711 SMGlobalClass *SMGlobalClass::head = NULL;
713 SMGlobalClass::SMGlobalClass()
715 m_pGlobalClassNext = SMGlobalClass::head;
716 SMGlobalClass::head = this;