core/sourcemod.cpp
author David Anderson <dvander@alliedmods.net>
Sat Feb 17 09:02:22 2007 +0000 (2007-02-17)
changeset 516 0807e52b4e02
parent 496 a16c05dcf584
child 520 7676d61cde2d
permissions -rw-r--r--
clientconnect now blocks properly when needed
removed cruft
dvander@370
     1
/**
dvander@370
     2
 * ===============================================================
dvander@370
     3
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     4
 * ===============================================================
dvander@370
     5
 *
dvander@370
     6
 * This file is not open source and may not be copied without explicit
dvander@370
     7
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     8
 * in whole or significant part.
dvander@370
     9
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    10
 *
dvander@370
    11
 * Version: $Id$
dvander@370
    12
 */
dvander@370
    13
dvander@160
    14
#include <stdio.h>
dvander@160
    15
#include "sourcemod.h"
dvander@160
    16
#include "sourcemm_api.h"
dvander@160
    17
#include "systems/LibrarySys.h"
dvander@160
    18
#include "vm/sp_vm_engine.h"
dvander@160
    19
#include <sh_string.h>
dvander@176
    20
#include "PluginSys.h"
dvander@252
    21
#include "ShareSys.h"
faluco@281
    22
#include "CLogger.h"
dvander@315
    23
#include "ExtensionSys.h"
dvander@340
    24
#include "AdminCache.h"
dvander@347
    25
#include "sm_stringutil.h"
dvander@448
    26
#include "CPlayerManager.h"
dvander@160
    27
dvander@209
    28
SH_DECL_HOOK6(IServerGameDLL, LevelInit, SH_NOATTRIB, false, bool, const char *, const char *, const char *, const char *, bool, bool);
faluco@333
    29
SH_DECL_HOOK0_void(IServerGameDLL, LevelShutdown, SH_NOATTRIB, false);
dvander@448
    30
SH_DECL_HOOK1_void(IServerGameDLL, GameFrame, SH_NOATTRIB, false, bool);
dvander@209
    31
dvander@160
    32
SourcePawnEngine g_SourcePawn;
dvander@160
    33
SourceModBase g_SourceMod;
dvander@160
    34
dvander@160
    35
ILibrary *g_pJIT = NULL;
dvander@160
    36
SourceHook::String g_BaseDir;
dvander@160
    37
ISourcePawnEngine *g_pSourcePawn = &g_SourcePawn;
dvander@160
    38
IVirtualMachine *g_pVM;
dvander@252
    39
IdentityToken_t *g_pCoreIdent = NULL;
dvander@448
    40
float g_LastTime = 0.0f;
dvander@448
    41
float g_LastAuthCheck = 0.0f;
dvander@160
    42
dvander@160
    43
typedef int (*GIVEENGINEPOINTER)(ISourcePawnEngine *);
dvander@160
    44
typedef unsigned int (*GETEXPORTCOUNT)();
dvander@160
    45
typedef IVirtualMachine *(*GETEXPORT)(unsigned int);
dvander@160
    46
typedef void (*NOTIFYSHUTDOWN)();
dvander@160
    47
dvander@160
    48
void ShutdownJIT()
dvander@160
    49
{
dvander@160
    50
	NOTIFYSHUTDOWN notify = (NOTIFYSHUTDOWN)g_pJIT->GetSymbolAddress("NotifyShutdown");
dvander@160
    51
	if (notify)
dvander@160
    52
	{
dvander@160
    53
		notify();
dvander@160
    54
	}
dvander@160
    55
dvander@160
    56
	g_pJIT->CloseLibrary();
dvander@160
    57
}
dvander@160
    58
dvander@209
    59
SourceModBase::SourceModBase()
dvander@209
    60
{
dvander@209
    61
	m_IsMapLoading = false;
faluco@333
    62
	m_ExecPluginReload = false;
dvander@209
    63
}
dvander@209
    64
dvander@160
    65
bool SourceModBase::InitializeSourceMod(char *error, size_t err_max, bool late)
dvander@160
    66
{
dvander@160
    67
	g_BaseDir.assign(g_SMAPI->GetBaseDir());
dvander@209
    68
	g_LibSys.PathFormat(m_SMBaseDir, sizeof(m_SMBaseDir), "%s/addons/sourcemod", g_BaseDir.c_str());
dvander@345
    69
	g_LibSys.PathFormat(m_SMRelDir, sizeof(m_SMRelDir), "addons/sourcemod");
dvander@160
    70
dvander@160
    71
	/* Attempt to load the JIT! */
dvander@160
    72
	char file[PLATFORM_MAX_PATH];
dvander@160
    73
	char myerror[255];
dvander@209
    74
	g_SMAPI->PathFormat(file, sizeof(file), "%s/bin/sourcepawn.jit.x86.%s",
dvander@317
    75
		GetSourceModPath(),
dvander@160
    76
		PLATFORM_LIB_EXT
dvander@160
    77
		);
dvander@160
    78
dvander@160
    79
	g_pJIT = g_LibSys.OpenLibrary(file, myerror, sizeof(myerror));
dvander@160
    80
	if (!g_pJIT)
dvander@160
    81
	{
dvander@160
    82
		if (error && err_max)
dvander@160
    83
		{
dvander@160
    84
			snprintf(error, err_max, "%s (failed to load bin/sourcepawn.jit.x86.%s)", 
dvander@160
    85
				myerror,
dvander@160
    86
				PLATFORM_LIB_EXT);
dvander@160
    87
		}
dvander@160
    88
		return false;
dvander@160
    89
	}
dvander@160
    90
dvander@160
    91
	int err;
dvander@160
    92
	GIVEENGINEPOINTER jit_init = (GIVEENGINEPOINTER)g_pJIT->GetSymbolAddress("GiveEnginePointer");
dvander@160
    93
	if (!jit_init)
dvander@160
    94
	{
dvander@160
    95
		ShutdownJIT();
dvander@160
    96
		if (error && err_max)
dvander@160
    97
		{
dvander@160
    98
			snprintf(error, err_max, "Failed to find GiveEnginePointer in JIT!");
dvander@160
    99
		}
dvander@160
   100
		return false;
dvander@160
   101
	}
dvander@160
   102
dvander@160
   103
	if ((err=jit_init(g_pSourcePawn)) != 0)
dvander@160
   104
	{
dvander@160
   105
		ShutdownJIT();
dvander@160
   106
		if (error && err_max)
dvander@160
   107
		{
dvander@160
   108
			snprintf(error, err_max, "GiveEnginePointer returned %d in the JIT", err);
dvander@160
   109
		}
dvander@160
   110
		return false;
dvander@160
   111
	}
dvander@160
   112
dvander@160
   113
	GETEXPORTCOUNT jit_getnum = (GETEXPORTCOUNT)g_pJIT->GetSymbolAddress("GetExportCount");
dvander@160
   114
	GETEXPORT jit_get = (GETEXPORT)g_pJIT->GetSymbolAddress("GetExport");
dvander@160
   115
	if (!jit_get)
dvander@160
   116
	{
dvander@160
   117
		ShutdownJIT();
dvander@160
   118
		if (error && err_max)
dvander@160
   119
		{
dvander@160
   120
			snprintf(error, err_max, "JIT is missing a necessary export!");
dvander@160
   121
		}
dvander@160
   122
		return false;
dvander@160
   123
	}
dvander@160
   124
dvander@160
   125
	unsigned int num = jit_getnum();
dvander@160
   126
	if (!num || ((g_pVM=jit_get(0)) == NULL))
dvander@160
   127
	{
dvander@160
   128
		ShutdownJIT();
dvander@160
   129
		if (error && err_max)
dvander@160
   130
		{
dvander@160
   131
			snprintf(error, err_max, "JIT did not export any virtual machines!");
dvander@160
   132
		}
dvander@160
   133
		return false;
dvander@160
   134
	}
dvander@160
   135
dvander@176
   136
	unsigned int api = g_pVM->GetAPIVersion();
dvander@176
   137
	if (api != SOURCEPAWN_VM_API_VERSION)
dvander@176
   138
	{
dvander@176
   139
		ShutdownJIT();
dvander@176
   140
		if (error && err_max)
dvander@176
   141
		{
dvander@176
   142
			snprintf(error, err_max, "JIT is not a compatible version");
dvander@176
   143
		}
dvander@176
   144
		return false;
dvander@176
   145
	}
dvander@176
   146
dvander@209
   147
	StartSourceMod(late);
dvander@176
   148
dvander@160
   149
	return true;
dvander@160
   150
}
dvander@209
   151
dvander@209
   152
void SourceModBase::StartSourceMod(bool late)
dvander@209
   153
{
dvander@209
   154
	/* First initialize the global hooks we need */
dvander@209
   155
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
faluco@333
   156
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
dvander@448
   157
	SH_ADD_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, this, &SourceModBase::GameFrame, false);
dvander@209
   158
dvander@496
   159
	enginePatch = SH_GET_CALLCLASS(engine);
dvander@496
   160
dvander@214
   161
	/* Notify! */
dvander@214
   162
	SMGlobalClass *pBase = SMGlobalClass::head;
dvander@214
   163
	while (pBase)
dvander@214
   164
	{
dvander@315
   165
		pBase->OnSourceModStartup(false);
dvander@214
   166
		pBase = pBase->m_pGlobalClassNext;
dvander@214
   167
	}
dvander@214
   168
dvander@252
   169
	/* Make the global core identity */
dvander@252
   170
	g_pCoreIdent = g_ShareSys.CreateCoreIdentity();
dvander@252
   171
dvander@214
   172
	/* Notify! */
dvander@214
   173
	pBase = SMGlobalClass::head;
dvander@214
   174
	while (pBase)
dvander@214
   175
	{
dvander@214
   176
		pBase->OnSourceModAllInitialized();
dvander@214
   177
		pBase = pBase->m_pGlobalClassNext;
dvander@214
   178
	}
dvander@317
   179
dvander@317
   180
	/* Add us now... */
dvander@317
   181
	g_ShareSys.AddInterface(NULL, this);
dvander@209
   182
}
dvander@209
   183
dvander@209
   184
bool SourceModBase::LevelInit(char const *pMapName, char const *pMapEntities, char const *pOldLevel, char const *pLandmarkName, bool loadGame, bool background)
dvander@209
   185
{
dvander@209
   186
	m_IsMapLoading = true;
faluco@333
   187
	m_ExecPluginReload = true;
dvander@448
   188
	g_LastTime = 0.0f;
dvander@448
   189
	g_LastAuthCheck = 0.0f;
dvander@209
   190
faluco@281
   191
	g_Logger.MapChange(pMapName);
faluco@281
   192
dvander@209
   193
	DoGlobalPluginLoads();
dvander@209
   194
dvander@209
   195
	m_IsMapLoading = false;
dvander@209
   196
dvander@438
   197
	g_Admins.DumpAdminCache(AdminCache_Overrides, true);
dvander@438
   198
	g_Admins.DumpAdminCache(AdminCache_Groups, true);
dvander@340
   199
dvander@209
   200
	RETURN_META_VALUE(MRES_IGNORED, true);
dvander@209
   201
}
dvander@209
   202
dvander@448
   203
void SourceModBase::GameFrame(bool simulating)
dvander@448
   204
{
dvander@448
   205
	/**
dvander@448
   206
	 * Note: This is all hardcoded rather than delegated to save
dvander@448
   207
	 * precious CPU cycles.
dvander@448
   208
	 */
dvander@448
   209
	float curtime = gpGlobals->curtime;
dvander@448
   210
	if (curtime - g_LastTime > 0.1f)
dvander@448
   211
	{
dvander@448
   212
		if (m_CheckingAuth
dvander@448
   213
			&& (gpGlobals->curtime - g_LastAuthCheck > 0.7f))
dvander@448
   214
		{
dvander@448
   215
			g_LastAuthCheck = gpGlobals->curtime;
dvander@448
   216
			g_Players.RunAuthChecks();
dvander@448
   217
		}
dvander@448
   218
		g_LastTime = curtime;
dvander@448
   219
	}
dvander@448
   220
}
dvander@448
   221
faluco@333
   222
void SourceModBase::LevelShutdown()
faluco@333
   223
{
faluco@333
   224
	if (m_ExecPluginReload)
faluco@333
   225
	{
faluco@333
   226
		g_PluginSys.ReloadOrUnloadPlugins();
faluco@333
   227
		m_ExecPluginReload = false;
faluco@333
   228
	}
faluco@333
   229
}
faluco@333
   230
faluco@484
   231
bool SourceModBase::IsMapLoading() const
dvander@315
   232
{
dvander@315
   233
	return m_IsMapLoading;
dvander@315
   234
}
dvander@315
   235
dvander@209
   236
void SourceModBase::DoGlobalPluginLoads()
dvander@209
   237
{
dvander@209
   238
	char config_path[PLATFORM_MAX_PATH];
dvander@209
   239
	char plugins_path[PLATFORM_MAX_PATH];
dvander@209
   240
dvander@317
   241
	BuildPath(Path_SM, config_path, 
dvander@209
   242
		sizeof(config_path),
dvander@317
   243
		"configs/plugin_settings.cfg");
dvander@317
   244
	BuildPath(Path_SM, plugins_path,
dvander@209
   245
		sizeof(plugins_path),
dvander@317
   246
		"plugins");
dvander@209
   247
dvander@397
   248
	/* Load any auto extensions */
dvander@397
   249
	g_Extensions.TryAutoload();
dvander@397
   250
dvander@315
   251
	/* Run the first pass */
dvander@211
   252
	g_PluginSys.LoadAll_FirstPass(config_path, plugins_path);
dvander@213
   253
dvander@315
   254
	/* Mark any extensions as loaded */
dvander@315
   255
	g_Extensions.MarkAllLoaded();
dvander@315
   256
dvander@213
   257
	/* No modules yet, it's safe to call this from here */
dvander@213
   258
	g_PluginSys.LoadAll_SecondPass();
dvander@315
   259
dvander@315
   260
	/* Re-mark any extensions as loaded */
dvander@315
   261
	g_Extensions.MarkAllLoaded();
dvander@211
   262
}
dvander@211
   263
dvander@317
   264
size_t SourceModBase::BuildPath(PathType type, char *buffer, size_t maxlength, char *format, ...)
dvander@317
   265
{
dvander@317
   266
	char _buffer[PLATFORM_MAX_PATH+1];
dvander@317
   267
	va_list ap;
dvander@317
   268
dvander@317
   269
	va_start(ap, format);
dvander@317
   270
	vsnprintf(_buffer, PLATFORM_MAX_PATH, format, ap);
dvander@317
   271
	va_end(ap);
dvander@317
   272
dvander@317
   273
	const char *base = NULL;
dvander@317
   274
	if (type == Path_Game)
dvander@317
   275
	{
dvander@317
   276
		base = GetModPath();
dvander@317
   277
	} else if (type == Path_SM) {
dvander@317
   278
		base = GetSourceModPath();
dvander@345
   279
	} else if (type == Path_SM_Rel) {
dvander@345
   280
		base = m_SMRelDir;
dvander@317
   281
	}
dvander@317
   282
dvander@317
   283
	if (base)
dvander@317
   284
	{
dvander@317
   285
		return g_LibSys.PathFormat(buffer, maxlength, "%s/%s", base, _buffer);
dvander@317
   286
	} else {
dvander@317
   287
		return g_LibSys.PathFormat(buffer, maxlength, "%s", _buffer);
dvander@317
   288
	}
dvander@317
   289
}
dvander@317
   290
faluco@289
   291
void SourceModBase::CloseSourceMod()
faluco@289
   292
{
faluco@289
   293
	/* Notify! */
faluco@289
   294
	SMGlobalClass *pBase = SMGlobalClass::head;
faluco@289
   295
	while (pBase)
faluco@289
   296
	{
faluco@289
   297
		pBase->OnSourceModShutdown();
faluco@289
   298
		pBase = pBase->m_pGlobalClassNext;
faluco@289
   299
	}
faluco@289
   300
faluco@484
   301
	/* Delete all data packs */
faluco@484
   302
	CStack<CDataPack *>::iterator iter;
faluco@484
   303
	CDataPack *pd;
faluco@484
   304
	for (iter=m_freepacks.begin(); iter!=m_freepacks.end(); iter++)
faluco@484
   305
	{
faluco@484
   306
		pd = (*iter);
faluco@484
   307
		delete pd;
faluco@484
   308
	}
faluco@484
   309
	m_freepacks.popall();
faluco@484
   310
faluco@289
   311
	/* Notify! */
faluco@289
   312
	pBase = SMGlobalClass::head;
faluco@289
   313
	while (pBase)
faluco@289
   314
	{
faluco@289
   315
		pBase->OnSourceModAllShutdown();
faluco@289
   316
		pBase = pBase->m_pGlobalClassNext;
faluco@289
   317
	}
faluco@289
   318
dvander@496
   319
	if (enginePatch)
dvander@496
   320
	{
dvander@496
   321
		SH_RELEASE_CALLCLASS(enginePatch);
dvander@496
   322
		enginePatch = NULL;
dvander@496
   323
	}
dvander@496
   324
faluco@333
   325
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelInit, gamedll, this, &SourceModBase::LevelInit, false);
faluco@333
   326
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, LevelShutdown, gamedll, this, &SourceModBase::LevelShutdown, false);
dvander@448
   327
	SH_REMOVE_HOOK_MEMFUNC(IServerGameDLL, GameFrame, gamedll, this, &SourceModBase::GameFrame, false);
faluco@333
   328
faluco@289
   329
	/* Rest In Peace */
faluco@289
   330
	ShutdownJIT();
faluco@289
   331
}
faluco@289
   332
dvander@317
   333
void SourceModBase::LogMessage(IExtension *pExt, const char *format, ...)
dvander@317
   334
{
dvander@317
   335
	IExtensionInterface *pAPI = pExt->GetAPI();
dvander@317
   336
	const char *tag = pAPI->GetExtensionTag();
dvander@317
   337
	char buffer[2048];
dvander@317
   338
	va_list ap;
dvander@317
   339
dvander@317
   340
	va_start(ap, format);
dvander@317
   341
	vsnprintf(buffer, sizeof(buffer), format, ap);
dvander@317
   342
	va_end(ap);
dvander@317
   343
dvander@317
   344
	if (tag)
dvander@317
   345
	{
dvander@317
   346
		g_Logger.LogMessage("[%s] %s", tag, buffer);
dvander@317
   347
	} else {
dvander@317
   348
		g_Logger.LogMessage("%s", buffer);
dvander@317
   349
	}
dvander@317
   350
}
dvander@317
   351
dvander@317
   352
void SourceModBase::LogError(IExtension *pExt, const char *format, ...)
dvander@317
   353
{
dvander@317
   354
	IExtensionInterface *pAPI = pExt->GetAPI();
dvander@317
   355
	const char *tag = pAPI->GetExtensionTag();
dvander@317
   356
	char buffer[2048];
dvander@317
   357
	va_list ap;
dvander@317
   358
dvander@317
   359
	va_start(ap, format);
dvander@317
   360
	vsnprintf(buffer, sizeof(buffer), format, ap);
dvander@317
   361
	va_end(ap);
dvander@317
   362
dvander@317
   363
	if (tag)
dvander@317
   364
	{
dvander@317
   365
		g_Logger.LogError("[%s] %s", tag, buffer);
dvander@317
   366
	} else {
dvander@317
   367
		g_Logger.LogError("%s", buffer);
dvander@317
   368
	}
dvander@317
   369
}
dvander@317
   370
dvander@347
   371
size_t SourceModBase::FormatString(char *buffer, size_t maxlength, IPluginContext *pContext, const cell_t *params, unsigned int param)
dvander@347
   372
{
dvander@347
   373
	char *fmt;
dvander@347
   374
dvander@347
   375
	pContext->LocalToString(params[param], &fmt);
dvander@347
   376
dvander@347
   377
	int lparam = ++param;
dvander@347
   378
dvander@347
   379
	return atcprintf(buffer, maxlength, fmt, pContext, params, &lparam);
dvander@347
   380
}
dvander@347
   381
faluco@484
   382
const char *SourceModBase::GetSourceModPath() const
dvander@209
   383
{
dvander@209
   384
	return m_SMBaseDir;
dvander@209
   385
}
dvander@211
   386
faluco@484
   387
const char *SourceModBase::GetModPath() const
dvander@255
   388
{
dvander@255
   389
	return g_BaseDir.c_str();
dvander@255
   390
}
dvander@255
   391
faluco@422
   392
void SourceModBase::SetGlobalTarget(unsigned int index)
faluco@422
   393
{
faluco@422
   394
	m_target = index;
faluco@422
   395
}
faluco@422
   396
dvander@448
   397
void SourceModBase::SetAuthChecking(bool set)
dvander@448
   398
{
dvander@448
   399
	m_CheckingAuth = set;
dvander@448
   400
}
dvander@448
   401
faluco@422
   402
unsigned int SourceModBase::GetGlobalTarget() const
faluco@422
   403
{
faluco@422
   404
	return m_target;
faluco@422
   405
}
faluco@422
   406
faluco@484
   407
IDataPack *SourceModBase::CreateDataPack()
faluco@484
   408
{
faluco@484
   409
	CDataPack *pack;
faluco@484
   410
	if (m_freepacks.empty())
faluco@484
   411
	{
faluco@484
   412
		pack = new CDataPack;
faluco@484
   413
	} else {
faluco@484
   414
		pack = m_freepacks.front();
faluco@484
   415
		m_freepacks.pop();
faluco@484
   416
		pack->Initialize();
faluco@484
   417
	}
faluco@484
   418
	return pack;
faluco@484
   419
}
faluco@484
   420
faluco@484
   421
void SourceModBase::FreeDataPack(IDataPack *pack)
faluco@484
   422
{
faluco@484
   423
	m_freepacks.push(static_cast<CDataPack *>(pack));
faluco@484
   424
}
faluco@484
   425
faluco@484
   426
Handle_t SourceModBase::GetDataPackHandleType(bool readonly)
faluco@484
   427
{
faluco@484
   428
	//:TODO:
faluco@484
   429
	return 0;
faluco@484
   430
}
faluco@484
   431
dvander@211
   432
SMGlobalClass *SMGlobalClass::head = NULL;
dvander@211
   433
dvander@211
   434
SMGlobalClass::SMGlobalClass()
dvander@211
   435
{
dvander@211
   436
	m_pGlobalClassNext = SMGlobalClass::head;
dvander@211
   437
	SMGlobalClass::head = this;
dvander@211
   438
}