core/sourcemod.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jan 25 22:36:38 2007 +0000 (2007-01-25)
changeset 370 d3a484f98f6d
parent 347 aa2dfce8bff6
child 397 d78fcaa24fbb
permissions -rw-r--r--
added license headers
     1 /**
     2  * ===============================================================
     3  * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
     4  * ===============================================================
     5  *
     6  * This file is not open source and may not be copied without explicit
     7  * written permission of AlliedModders LLC.  This file may not be redistributed 
     8  * in whole or significant part.
     9  * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
    10  *
    11  * Version: $Id$
    12  */
    13 
    14 #include <stdio.h>
    15 #include "sourcemod.h"
    16 #include "sourcemm_api.h"
    17 #include "systems/LibrarySys.h"
    18 #include "vm/sp_vm_engine.h"
    19 #include <sh_string.h>
    20 #include "PluginSys.h"
    21 #include "ShareSys.h"
    22 #include "CLogger.h"
    23 #include "ExtensionSys.h"
    24 #include "AdminCache.h"
    25 #include "sm_stringutil.h"
    26 
    27 SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
    28 SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
    29 
    30 SourcePawnEngine g_SourcePawn;
    31 SourceModBase g_SourceMod;
    32 
    33 ILibrary *g_pJIT = NULL;
    34 SourceHook::String g_BaseDir;
    35 ISourcePawnEngine *g_pSourcePawn = &g_SourcePawn;
    36 IVirtualMachine *g_pVM;
    37 IdentityToken_t *g_pCoreIdent = NULL;
    38 
    39 typedef int (*GIVEENGINEPOINTER)(ISourcePawnEngine *);
    40 typedef unsigned int (*GETEXPORTCOUNT)();
    41 typedef IVirtualMachine *(*GETEXPORT)(unsigned int);
    42 typedef void (*NOTIFYSHUTDOWN)();
    43 
    44 void ShutdownJIT()
    45 {
    46 	NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
    47 	if (notify)
    48 	{
    49 		notify();
    50 	}
    51 
    52 	g_pJIT->CloseLibrary();
    53 }
    54 
    55 SourceModBase::SourceModBase()
    56 {
    57 	m_IsMapLoading = false;
    58 	m_ExecPluginReload = false;
    59 }
    60 
    61 bool SourceModBase::InitializeSourceMod(char *error, size_t err_max, bool late)
    62 {
    63 	g_BaseDir.assign(g_SMAPI->GetBaseDir());
    64 	g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/addons/sourcemod", g_BaseDir.c_str());
    65 	g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "addons/sourcemod");
    66 
    67 	/* Attempt to load the JIT! */
    68 	char file[PLATFORM_MAX_PATH];
    69 	char myerror[255];
    70 	g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
    71 		GetSourceModPath(),
    72 		PLATFORM_LIB_EXT
    73 		);
    74 
    75 	g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
    76 	if (!g_pJIT)
    77 	{
    78 		if (error && err_max)
    79 		{
    80 			snprintf(error, err_max, "%s (failed to load bin/sourcepawn.jit.x86.%s)", 
    81 				myerror,
    82 				PLATFORM_LIB_EXT);
    83 		}
    84 		return false;
    85 	}
    86 
    87 	int err;
    88 	GIVEENGINEPOINTER jit_init = (GIVEENGINEPOINTER)g_pJIT->GetSymbolAddress("GiveEnginePointer");
    89 	if (!jit_init)
    90 	{
    91 		ShutdownJIT();
    92 		if (error && err_max)
    93 		{
    94 			snprintf(error, err_max, "Failed to find GiveEnginePointer in JIT!");
    95 		}
    96 		return false;
    97 	}
    98 
    99 	if ((err=jit_init(g_pSourcePawn)) != 0)
   100 	{
   101 		ShutdownJIT();
   102 		if (error && err_max)
   103 		{
   104 			snprintf(error, err_max, "GiveEnginePointer returned %d in the JIT", err);
   105 		}
   106 		return false;
   107 	}
   108 
   109 	GETEXPORTCOUNT jit_getnum = (GETEXPORTCOUNT)g_pJIT->GetSymbolAddress("GetExportCount");
   110 	GETEXPORT jit_get = (GETEXPORT)g_pJIT->GetSymbolAddress("GetExport");
   111 	if (!jit_get)
   112 	{
   113 		ShutdownJIT();
   114 		if (error && err_max)
   115 		{
   116 			snprintf(error, err_max, "JIT is missing a necessary export!");
   117 		}
   118 		return false;
   119 	}
   120 
   121 	unsigned int num = jit_getnum();
   122 	if (!num || ((g_pVM=jit_get(0)) == NULL))
   123 	{
   124 		ShutdownJIT();
   125 		if (error && err_max)
   126 		{
   127 			snprintf(error, err_max, "JIT did not export any virtual machines!");
   128 		}
   129 		return false;
   130 	}
   131 
   132 	unsigned int api = g_pVM->GetAPIVersion();
   133 	if (api != SOURCEPAWN_VM_API_VERSION)
   134 	{
   135 		ShutdownJIT();
   136 		if (error && err_max)
   137 		{
   138 			snprintf(error, err_max, "JIT is not a compatible version");
   139 		}
   140 		return false;
   141 	}
   142 
   143 	StartSourceMod(late);
   144 
   145 	return true;
   146 }
   147 
   148 void SourceModBase::StartSourceMod(bool late)
   149 {
   150 	/* First initialize the global hooks we need */
   151 	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
   152 	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
   153 
   154 	/* Notify! */
   155 	SMGlobalClass *pBase = SMGlobalClass::head;
   156 	while (pBase)
   157 	{
   158 		pBase->OnSourceModStartup(false);
   159 		pBase = pBase->m_pGlobalClassNext;
   160 	}
   161 
   162 	/* Make the global core identity */
   163 	g_pCoreIdent = g_ShareSys.CreateCoreIdentity();
   164 
   165 	/* Notify! */
   166 	pBase = SMGlobalClass::head;
   167 	while (pBase)
   168 	{
   169 		pBase->OnSourceModAllInitialized();
   170 		pBase = pBase->m_pGlobalClassNext;
   171 	}
   172 
   173 	/* Add us now... */
   174 	g_ShareSys.AddInterface(NULL, this);
   175 }
   176 
   177 bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
   178 {
   179 	m_IsMapLoading = true;
   180 	m_ExecPluginReload = true;
   181 
   182 	g_Logger.MapChange(pMapName);
   183 
   184 	DoGlobalPluginLoads();
   185 
   186 	m_IsMapLoading = false;
   187 
   188 	g_Admins.DumpAdminCache(ADMIN_CACHE_GROUPS|ADMIN_CACHE_ADMINS|ADMIN_CACHE_OVERRIDES, true);
   189 
   190 	RETURN_META_VALUE(MRES_IGNORED, true);
   191 }
   192 
   193 void SourceModBase::LevelShutdown()
   194 {
   195 	if (m_ExecPluginReload)
   196 	{
   197 		g_PluginSys.ReloadOrUnloadPlugins();
   198 		m_ExecPluginReload = false;
   199 	}
   200 }
   201 
   202 bool SourceModBase::IsMapLoading()
   203 {
   204 	return m_IsMapLoading;
   205 }
   206 
   207 void SourceModBase::DoGlobalPluginLoads()
   208 {
   209 	char config_path[PLATFORM_MAX_PATH];
   210 	char plugins_path[PLATFORM_MAX_PATH];
   211 
   212 	BuildPath(Path_SM, config_path, 
   213 		sizeof(config_path),
   214 		"configs/plugin_settings.cfg");
   215 	BuildPath(Path_SM, plugins_path,
   216 		sizeof(plugins_path),
   217 		"plugins");
   218 
   219 	/* Run the first pass */
   220 	g_PluginSys.LoadAll_FirstPass(config_path, plugins_path);
   221 
   222 	/* Mark any extensions as loaded */
   223 	g_Extensions.MarkAllLoaded();
   224 
   225 	/* No modules yet, it's safe to call this from here */
   226 	g_PluginSys.LoadAll_SecondPass();
   227 
   228 	/* Re-mark any extensions as loaded */
   229 	g_Extensions.MarkAllLoaded();
   230 }
   231 
   232 size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, char *format, ...)
   233 {
   234 	char _buffer[PLATFORM_MAX_PATH+1];
   235 	va_list ap;
   236 
   237 	va_start(ap, format);
   238 	vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
   239 	va_end(ap);
   240 
   241 	const char *base = NULL;
   242 	if (type == Path_Game)
   243 	{
   244 		base = GetModPath();
   245 	} else if (type == Path_SM) {
   246 		base = GetSourceModPath();
   247 	} else if (type == Path_SM_Rel) {
   248 		base = m_SMRelDir;
   249 	}
   250 
   251 	if (base)
   252 	{
   253 		return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
   254 	} else {
   255 		return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
   256 	}
   257 }
   258 
   259 void SourceModBase::CloseSourceMod()
   260 {
   261 	/* Notify! */
   262 	SMGlobalClass *pBase = SMGlobalClass::head;
   263 	while (pBase)
   264 	{
   265 		pBase->OnSourceModShutdown();
   266 		pBase = pBase->m_pGlobalClassNext;
   267 	}
   268 
   269 	/* Notify! */
   270 	pBase = SMGlobalClass::head;
   271 	while (pBase)
   272 	{
   273 		pBase->OnSourceModAllShutdown();
   274 		pBase = pBase->m_pGlobalClassNext;
   275 	}
   276 
   277 	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
   278 	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
   279 
   280 	/* Rest In Peace */
   281 	ShutdownJIT();
   282 }
   283 
   284 void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
   285 {
   286 	IExtensionInterface *pAPI = pExt->GetAPI();
   287 	const char *tag = pAPI->GetExtensionTag();
   288 	char buffer[2048];
   289 	va_list ap;
   290 
   291 	va_start(ap, format);
   292 	vsnprintf(buffer, sizeof(buffer), format, ap);
   293 	va_end(ap);
   294 
   295 	if (tag)
   296 	{
   297 		g_Logger.LogMessage("[%s] %s", tag, buffer);
   298 	} else {
   299 		g_Logger.LogMessage("%s", buffer);
   300 	}
   301 }
   302 
   303 void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
   304 {
   305 	IExtensionInterface *pAPI = pExt->GetAPI();
   306 	const char *tag = pAPI->GetExtensionTag();
   307 	char buffer[2048];
   308 	va_list ap;
   309 
   310 	va_start(ap, format);
   311 	vsnprintf(buffer, sizeof(buffer), format, ap);
   312 	va_end(ap);
   313 
   314 	if (tag)
   315 	{
   316 		g_Logger.LogError("[%s] %s", tag, buffer);
   317 	} else {
   318 		g_Logger.LogError("%s", buffer);
   319 	}
   320 }
   321 
   322 size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
   323 {
   324 	char *fmt;
   325 
   326 	pContext->LocalToString(params[param], &fmt);
   327 
   328 	int lparam = ++param;
   329 
   330 	return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
   331 }
   332 
   333 const char *SourceModBase::GetSourceModPath()
   334 {
   335 	return m_SMBaseDir;
   336 }
   337 
   338 const char *SourceModBase::GetModPath()
   339 {
   340 	return g_BaseDir.c_str();
   341 }
   342 
   343 SMGlobalClass *SMGlobalClass::head = NULL;
   344 
   345 SMGlobalClass::SMGlobalClass()
   346 {
   347 	m_pGlobalClassNext = SMGlobalClass::head;
   348 	SMGlobalClass::head = this;
   349 }