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