2 * vim: set ts=4 sw=4 tw=99 noet:
3 * =============================================================================
5 * Copyright (C) 2004-2010 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 "LibrarySys.h"
36 #include <sh_string.h>
37 #include "CoreConfig.h"
39 #include "AdminCache.h"
40 #include "sm_stringutil.h"
41 #include "PlayerManager.h"
42 #include "ForwardSys.h"
44 #include <IGameConfigs.h>
45 #include "frame_hooks.h"
46 #include "logic_bridge.h"
48 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
49 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
50 SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, false, bool);
51 SH_DECL_HOOK1_void(IVEngineServer, ServerCommand, SH_NOATTRIB, false, const char *);
53 SourceModBase g_SourceMod;
55 ILibrary *g_pJIT = NULL;
56 SourceHook::String g_BaseDir;
57 ISourcePawnEngine *g_pSourcePawn = NULL;
58 ISourcePawnEngine2 *g_pSourcePawn2 = NULL;
59 IdentityToken_t *g_pCoreIdent = NULL;
60 IForward *g_pOnMapEnd = NULL;
61 IGameConfig *g_pGameConf = NULL;
62 bool g_Loaded = false;
63 bool sm_show_debug_spew = false;
65 typedef ISourcePawnEngine *(*GET_SP_V1)();
66 typedef ISourcePawnEngine2 *(*GET_SP_V2)();
67 typedef void (*NOTIFYSHUTDOWN)();
69 #ifdef PLATFORM_WINDOWS
70 ConVar sm_basepath("sm_basepath", "addons\\sourcemod", 0, "SourceMod base path (set via command line)");
71 #elif defined PLATFORM_LINUX || defined PLATFORM_APPLE
72 ConVar sm_basepath("sm_basepath", "addons/sourcemod", 0, "SourceMod base path (set via command line)");
77 NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
83 if (g_pSourcePawn2 != NULL)
85 g_pSourcePawn2->Shutdown();
88 g_pJIT->CloseLibrary();
91 SourceModBase::SourceModBase()
93 m_IsMapLoading = false;
94 m_ExecPluginReload = false;
95 m_GotBasePath = false;
98 ConfigResult SourceModBase::OnSourceModConfigChanged(const char *key,
104 if (strcasecmp(key, "BasePath") == 0)
106 if (source == ConfigSource_Console)
108 UTIL_Format(error, maxlength, "Cannot be set at runtime");
109 return ConfigResult_Reject;
114 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/%s", g_BaseDir.c_str(), value);
115 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), value);
117 m_GotBasePath = true;
120 return ConfigResult_Accept;
122 else if (strcasecmp(key, "DebugSpew") == 0)
124 sm_show_debug_spew = (strcasecmp(value, "yes") == 0) ? true : false;
126 return ConfigResult_Accept;
129 return ConfigResult_Ignore;
132 static bool sSourceModInitialized = false;
134 bool SourceModBase::InitializeSourceMod(char *error, size_t maxlength, bool late)
136 const char *gamepath = g_SMAPI->GetBaseDir();
138 /* Store full path to game */
139 g_BaseDir.assign(gamepath);
141 /* Store name of game directory by itself */
142 size_t len = strlen(gamepath);
143 for (size_t i = len - 1; i < len; i--)
145 if (gamepath[i] == PLATFORM_SEP_CHAR)
147 strncopy(m_ModDir, &gamepath[++i], sizeof(m_ModDir));
152 const char *basepath = icvar->GetCommandLineValue("sm_basepath");
153 /* Set a custom base path if there is one. */
154 if (basepath != NULL && basepath[0] != '\0')
156 m_GotBasePath = true;
158 /* Otherwise, use a default and keep the m_GotBasePath unlocked. */
161 basepath = sm_basepath.GetDefault();
164 g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/%s", g_BaseDir.c_str(), basepath);
165 g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "%s", basepath);
167 if (!StartLogicBridge(error, maxlength))
172 /* Initialize CoreConfig to get the SourceMod base path properly - this parses core.cfg */
173 g_CoreConfig.Initialize();
175 /* There will always be a path by this point, since it was force-set above. */
176 m_GotBasePath = true;
178 /* Attempt to load the JIT! */
179 char file[PLATFORM_MAX_PATH];
181 g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
186 g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
189 if (error && maxlength)
191 UTIL_Format(error, maxlength, "%s (failed to load bin/sourcepawn.jit.x86.%s)",
198 GET_SP_V1 getv1 = (GET_SP_V1)g_pJIT->GetSymbolAddress("GetSourcePawnEngine1");
199 GET_SP_V2 getv2 = (GET_SP_V2)g_pJIT->GetSymbolAddress("GetSourcePawnEngine2");
203 if (error && maxlength)
205 snprintf(error, maxlength, "JIT is too old; upgrade SourceMod");
210 else if (getv2 == NULL)
212 if (error && maxlength)
214 snprintf(error, maxlength, "JIT is too old; upgrade SourceMod");
220 g_pSourcePawn = getv1();
221 g_pSourcePawn2 = getv2();
223 if (g_pSourcePawn2->GetAPIVersion() < 3)
225 g_pSourcePawn2 = NULL;
226 if (error && maxlength)
228 snprintf(error, maxlength, "JIT version is out of date");
233 if (!g_pSourcePawn2->Initialize())
235 g_pSourcePawn2 = NULL;
236 if (error && maxlength)
238 snprintf(error, maxlength, "JIT could not be initialized");
243 g_pSourcePawn2->SetDebugListener(logicore.debugger);
245 sSourceModInitialized = true;
247 /* Hook this now so we can detect startup without calling StartSourceMod() */
248 SH_ADD_HOOK(IServerGameDLL, LevelInit, gamedll, SH_MEMBER(this, &SourceModBase::LevelInit), false);
250 /* Only load if we're not late */
253 StartSourceMod(false);
259 void SourceModBase::StartSourceMod(bool late)
261 SH_ADD_HOOK(IServerGameDLL, LevelShutdown, gamedll, SH_MEMBER(this, &SourceModBase::LevelShutdown), false);
262 SH_ADD_HOOK(IServerGameDLL, GameFrame, gamedll, SH_MEMBER(&g_Timers, &TimerSystem::GameFrame), false);
264 enginePatch = SH_GET_CALLCLASS(engine);
265 gamedllPatch = SH_GET_CALLCLASS(gamedll);
270 SMGlobalClass *pBase = SMGlobalClass::head;
273 pBase->OnSourceModStartup(false);
274 pBase = pBase->m_pGlobalClassNext;
276 g_pGameConf = logicore.GetCoreGameConfig();
279 pBase = SMGlobalClass::head;
282 pBase->OnSourceModAllInitialized();
283 pBase = pBase->m_pGlobalClassNext;
287 pBase = SMGlobalClass::head;
290 pBase->OnSourceModAllInitialized_Post();
291 pBase = pBase->m_pGlobalClassNext;
295 sharesys->AddInterface(NULL, this);
300 /* Initialize VSP stuff */
301 if (vsp_interface != NULL)
303 g_SourceMod_Core.OnVSPListening(vsp_interface);
308 /* We missed doing anythin gin this if we late-loaded. Sneak it in now. */
312 /* If we want to autoload, do that now */
313 const char *disabled = GetCoreConfigValue("DisableAutoUpdate");
314 if (disabled == NULL || strcasecmp(disabled, "yes") != 0)
316 extsys->LoadAutoExtension("updater.ext." PLATFORM_LIB_EXT);
319 const char *timeout = GetCoreConfigValue("SlowScriptTimeout");
324 if (atoi(timeout) != 0)
326 g_pSourcePawn2->InstallWatchdogTimer(atoi(timeout) * 1000);
330 static bool g_LevelEndBarrier = false;
331 bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
333 /* If we're not loaded... */
336 /* Do all global initialization now */
337 StartSourceMod(true);
340 m_IsMapLoading = true;
341 m_ExecPluginReload = true;
344 SMGlobalClass *pBase = SMGlobalClass::head;
347 pBase->OnSourceModLevelChange(pMapName);
348 pBase = pBase->m_pGlobalClassNext;
351 DoGlobalPluginLoads();
353 m_IsMapLoading = false;
356 pBase = SMGlobalClass::head;
359 pBase->OnSourceModPluginsLoaded();
360 pBase = pBase->m_pGlobalClassNext;
365 g_pOnMapEnd = g_Forwards.CreateForward("OnMapEnd", ET_Ignore, 0, NULL);
368 g_LevelEndBarrier = true;
370 RETURN_META_VALUE(MRES_IGNORED, true);
373 void SourceModBase::LevelShutdown()
375 if (g_LevelEndBarrier)
377 SMGlobalClass *next = SMGlobalClass::head;
380 next->OnSourceModLevelEnd();
381 next = next->m_pGlobalClassNext;
384 if (g_pOnMapEnd != NULL)
386 g_pOnMapEnd->Execute(NULL);
389 g_Timers.RemoveMapChangeTimers();
391 g_LevelEndBarrier = false;
394 g_OnMapStarted = false;
396 if (m_ExecPluginReload)
398 scripts->RefreshAll();
399 m_ExecPluginReload = false;
403 bool SourceModBase::IsMapLoading() const
405 return m_IsMapLoading;
408 void SourceModBase::DoGlobalPluginLoads()
410 char config_path[PLATFORM_MAX_PATH];
411 char plugins_path[PLATFORM_MAX_PATH];
413 BuildPath(Path_SM, config_path,
415 "configs/plugin_settings.cfg");
416 BuildPath(Path_SM, plugins_path,
417 sizeof(plugins_path),
420 /* Load any auto extensions */
421 extsys->TryAutoload();
423 /* Fire the extensions ready message */
424 g_SMAPI->MetaFactory(SOURCEMOD_NOTICE_EXTENSIONS, NULL, NULL);
426 /* Load any game extension */
427 const char *game_ext;
428 if ((game_ext = g_pGameConf->GetKeyValue("GameExtension")) != NULL)
430 char path[PLATFORM_MAX_PATH];
431 UTIL_Format(path, sizeof(path), "%s.ext." PLATFORM_LIB_EXT, game_ext);
432 extsys->LoadAutoExtension(path);
435 scripts->LoadAll(config_path, plugins_path);
438 size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, const char *format, ...)
440 char _buffer[PLATFORM_MAX_PATH];
443 va_start(ap, format);
444 vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
447 /* If we get a "file://" notation, strip off the file:// part so we're left
448 * with an absolute path. Note that the absolute path gets returned, so
449 * usage with relative paths here is completely invalid.
451 if (type != Path_SM_Rel && strncmp(_buffer, "file://", 7) == 0)
453 return g_LibSys.PathFormat(buffer, maxlength, "%s", &_buffer[7]);
456 const char *base = NULL;
457 if (type == Path_Game)
459 base = GetGamePath();
461 else if (type == Path_SM)
463 base = GetSourceModPath();
465 else if (type == Path_SM_Rel)
472 return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
476 return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
480 void SourceModBase::CloseSourceMod()
482 if (!sSourceModInitialized)
485 SH_REMOVE_HOOK(IServerGameDLL, LevelInit, gamedll, SH_MEMBER(this, &SourceModBase::LevelInit), false);
489 /* Force a level end */
495 ShutdownLogicBridge();
499 void SourceModBase::ShutdownServices()
504 /* Unload extensions */
508 g_Forwards.ReleaseForward(g_pOnMapEnd);
511 SMGlobalClass *pBase = SMGlobalClass::head;
514 pBase->OnSourceModShutdown();
515 pBase = pBase->m_pGlobalClassNext;
518 /* Delete all data packs */
519 CStack<CDataPack *>::iterator iter;
521 for (iter=m_freepacks.begin(); iter!=m_freepacks.end(); iter++)
526 m_freepacks.popall();
529 pBase = SMGlobalClass::head;
532 pBase->OnSourceModAllShutdown();
533 pBase = pBase->m_pGlobalClassNext;
538 SH_RELEASE_CALLCLASS(enginePatch);
544 SH_RELEASE_CALLCLASS(gamedllPatch);
548 SH_REMOVE_HOOK(IServerGameDLL, LevelShutdown, gamedll, SH_MEMBER(this, &SourceModBase::LevelShutdown), false);
549 SH_REMOVE_HOOK(IServerGameDLL, GameFrame, gamedll, SH_MEMBER(&g_Timers, &TimerSystem::GameFrame), false);
552 void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
554 IExtensionInterface *pAPI = pExt->GetAPI();
555 const char *tag = pAPI->GetExtensionTag();
559 va_start(ap, format);
560 vsnprintf(buffer, sizeof(buffer), format, ap);
565 g_Logger.LogMessage("[%s] %s", tag, buffer);
567 g_Logger.LogMessage("%s", buffer);
571 void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
573 IExtensionInterface *pAPI = pExt->GetAPI();
574 const char *tag = pAPI->GetExtensionTag();
578 va_start(ap, format);
579 vsnprintf(buffer, sizeof(buffer), format, ap);
584 g_Logger.LogError("[%s] %s", tag, buffer);
586 g_Logger.LogError("%s", buffer);
590 size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
594 pContext->LocalToString(params[param], &fmt);
596 int lparam = ++param;
598 return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
601 const char *SourceModBase::GetSourceModPath() const
606 const char *SourceModBase::GetGamePath() const
608 return g_BaseDir.c_str();
611 unsigned int SourceModBase::SetGlobalTarget(unsigned int index)
613 unsigned int old = m_target;
618 unsigned int SourceModBase::GetGlobalTarget() const
623 IDataPack *SourceModBase::CreateDataPack()
626 if (m_freepacks.empty())
628 pack = new CDataPack;
630 pack = m_freepacks.front();
637 void SourceModBase::FreeDataPack(IDataPack *pack)
639 m_freepacks.push(static_cast<CDataPack *>(pack));
642 Handle_t SourceModBase::GetDataPackHandleType(bool readonly)
648 const char *SourceModBase::GetGameFolderName() const
653 ISourcePawnEngine *SourceModBase::GetScriptingEngine()
655 return g_pSourcePawn;
658 IVirtualMachine *SourceModBase::GetScriptingVM()
663 void SourceModBase::AllPluginsLoaded()
670 SMGlobalClass *base = SMGlobalClass::head;
673 base->OnSourceModGameInitialized();
674 base = base->m_pGlobalClassNext;
678 time_t SourceModBase::GetAdjustedTime()
680 return ::GetAdjustedTime();
683 void SourceModBase::AddGameFrameHook(GAME_FRAME_HOOK hook)
685 m_frame_hooks.push_back(hook);
688 void SourceModBase::RemoveGameFrameHook(GAME_FRAME_HOOK hook)
690 for (size_t i = 0; i < m_frame_hooks.size(); i++)
692 if (m_frame_hooks[i] == hook)
694 m_frame_hooks.erase(m_frame_hooks.iterAt(i));
700 void SourceModBase::ProcessGameFrameHooks(bool simulating)
702 if (m_frame_hooks.size() == 0)
707 for (size_t i = 0; i < m_frame_hooks.size(); i++)
709 m_frame_hooks[i](simulating);
713 size_t SourceModBase::Format(char *buffer, size_t maxlength, const char *fmt, ...)
719 len = FormatArgs(buffer, maxlength, fmt, ap);
725 size_t SourceModBase::FormatArgs(char *buffer,
730 return UTIL_FormatArgs(buffer, maxlength, fmt, ap);
733 void SourceModBase::AddFrameAction(FRAMEACTION fn, void *data)
735 ::AddFrameAction(FrameAction(fn, data));
738 const char *SourceModBase::GetCoreConfigValue(const char *key)
740 return g_CoreConfig.GetCoreConfigValue(key);
743 int SourceModBase::GetPluginId()
748 int SourceModBase::GetShApiVersion()
751 g_SMAPI->GetShVersions(api, impl);
756 bool SourceModBase::IsMapRunning()
758 return g_OnMapStarted;
761 SMGlobalClass *SMGlobalClass::head = NULL;