core/systems/PluginSys.cpp
author Scott Ehlert <ds@alliedmods.net>
Mon May 14 21:29:17 2007 +0000 (2007-05-14)
changeset 794 5947b0ee60bb
parent 755 66c9fde7f632
child 798 3ae0debc74be
permissions -rw-r--r--
Implemented amb286 - .smx extension no longer required with "sm plugins load"
dvander@370
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@370
     3
 * ===============================================================
dvander@370
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@370
     5
 * ===============================================================
dvander@370
     6
 *
dvander@370
     7
 * This file is not open source and may not be copied without explicit
dvander@370
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@370
     9
 * in whole or significant part.
dvander@370
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@370
    11
 *
dvander@370
    12
 * Version: $Id$
dvander@370
    13
 */
dvander@370
    14
dvander@173
    15
#include <stdio.h>
dvander@173
    16
#include "PluginSys.h"
dvander@229
    17
#include "ShareSys.h"
dvander@190
    18
#include "LibrarySys.h"
dvander@220
    19
#include "HandleSys.h"
ds@611
    20
#include "ForwardSys.h"
dvander@197
    21
#include "sourcemm_api.h"
dvander@209
    22
#include "sourcemod.h"
dvander@591
    23
#include "TextParsers.h"
dvander@592
    24
#include "Logger.h"
dvander@298
    25
#include "ExtensionSys.h"
dvander@309
    26
#include "sm_srvcmds.h"
dvander@309
    27
#include "sm_stringutil.h"
dvander@173
    28
dvander@211
    29
CPluginManager g_PluginSys;
dvander@220
    30
HandleType_t g_PluginType = 0;
dvander@229
    31
IdentityType_t g_PluginIdent = 0;
dvander@173
    32
dvander@209
    33
CPlugin::CPlugin(const char *file)
dvander@209
    34
{
dvander@209
    35
	static int MySerial = 0;
dvander@209
    36
dvander@209
    37
	m_type = PluginType_Private;
dvander@209
    38
	m_status = Plugin_Uncompiled;
dvander@209
    39
	m_serial = ++MySerial;
dvander@209
    40
	m_plugin = NULL;
dvander@209
    41
	m_errormsg[256] = '\0';
dvander@209
    42
	snprintf(m_filename, sizeof(m_filename), "%s", file);
dvander@229
    43
	m_handle = 0;
dvander@229
    44
	m_ident = NULL;
dvander@486
    45
	m_pProps = sm_trie_create();
dvander@605
    46
	m_FakeNativesMissing = false;
dvander@209
    47
}
dvander@209
    48
dvander@209
    49
CPlugin::~CPlugin()
dvander@173
    50
{
dvander@298
    51
	if (m_handle)
dvander@298
    52
	{
dvander@298
    53
		HandleSecurity sec;
dvander@298
    54
		sec.pOwner = g_PluginSys.GetIdentity();
dvander@298
    55
		sec.pIdentity = sec.pOwner;
dvander@298
    56
dvander@298
    57
		g_HandleSys.FreeHandle(m_handle, &sec);
dvander@298
    58
		g_ShareSys.DestroyIdentity(m_ident);
dvander@298
    59
	}
dvander@298
    60
dvander@209
    61
	if (m_ctx.base)
dvander@209
    62
	{
dvander@262
    63
		delete m_ctx.base;
dvander@209
    64
		m_ctx.base = NULL;
dvander@209
    65
	}
dvander@209
    66
	if (m_ctx.ctx)
dvander@209
    67
	{
dvander@209
    68
		m_ctx.vm->FreeContext(m_ctx.ctx);
dvander@209
    69
		m_ctx.ctx = NULL;
dvander@209
    70
	}
dvander@209
    71
	if (m_ctx.co)
dvander@209
    72
	{
dvander@209
    73
		m_ctx.vm->AbortCompilation(m_ctx.co);
dvander@209
    74
		m_ctx.co = NULL;
dvander@209
    75
	}
dvander@209
    76
dvander@222
    77
	if (m_plugin)
dvander@222
    78
	{
dvander@222
    79
		g_pSourcePawn->FreeFromMemory(m_plugin);
dvander@222
    80
		m_plugin = NULL;
dvander@222
    81
	}
faluco@641
    82
	if (m_pProps)
dvander@486
    83
	{
dvander@486
    84
		sm_trie_destroy(m_pProps);
dvander@486
    85
	}
dvander@229
    86
}
dvander@229
    87
dvander@229
    88
void CPlugin::InitIdentity()
dvander@229
    89
{
dvander@229
    90
	if (!m_handle)
dvander@229
    91
	{
dvander@229
    92
		m_ident = g_ShareSys.CreateIdentity(g_PluginIdent);
dvander@262
    93
		m_handle = g_HandleSys.CreateHandle(g_PluginType, this, g_PluginSys.GetIdentity(), g_PluginSys.GetIdentity(), NULL);
dvander@262
    94
		m_ctx.base->SetIdentity(m_ident);
dvander@229
    95
	}
dvander@209
    96
}
dvander@209
    97
dvander@536
    98
Handle_t CPlugin::GetMyHandle()
dvander@536
    99
{
dvander@536
   100
	return m_handle;
dvander@536
   101
}
dvander@536
   102
dvander@209
   103
CPlugin *CPlugin::CreatePlugin(const char *file, char *error, size_t maxlength)
dvander@209
   104
{
ds@652
   105
	char fullpath[PLATFORM_MAX_PATH];
dvander@317
   106
	g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", file);
dvander@209
   107
	FILE *fp = fopen(fullpath, "rb");
dvander@173
   108
dvander@298
   109
	CPlugin *pPlugin = new CPlugin(file);
dvander@298
   110
dvander@173
   111
	if (!fp)
dvander@173
   112
	{
dvander@209
   113
		if (error)
dvander@209
   114
		{
dvander@209
   115
			snprintf(error, maxlength, "Unable to open file");
dvander@209
   116
		}
dvander@298
   117
		pPlugin->m_status = Plugin_BadLoad;
dvander@298
   118
		return pPlugin;
dvander@173
   119
	}
dvander@173
   120
dvander@173
   121
	int err;
dvander@173
   122
	sp_plugin_t *pl = g_pSourcePawn->LoadFromFilePointer(fp, &err);
dvander@173
   123
	if (pl == NULL)
dvander@173
   124
	{
dvander@209
   125
		fclose(fp);
dvander@209
   126
		if (error)
dvander@209
   127
		{
dvander@209
   128
			snprintf(error, maxlength, "Error %d while parsing plugin", err);
dvander@209
   129
		}
dvander@298
   130
		pPlugin->m_status = Plugin_BadLoad;
dvander@298
   131
		return pPlugin;
dvander@173
   132
	}
dvander@173
   133
dvander@173
   134
	fclose(fp);
dvander@173
   135
dvander@209
   136
	pPlugin->m_plugin = pl;
dvander@298
   137
dvander@209
   138
	return pPlugin;
dvander@209
   139
}
dvander@209
   140
dvander@486
   141
bool CPlugin::GetProperty(const char *prop, void **ptr, bool remove/* =false */)
dvander@486
   142
{
dvander@486
   143
	bool exists = sm_trie_retrieve(m_pProps, prop, ptr);
dvander@486
   144
dvander@486
   145
	if (exists && remove)
dvander@486
   146
	{
dvander@486
   147
		sm_trie_delete(m_pProps, prop);
dvander@486
   148
	}
dvander@486
   149
dvander@486
   150
	return exists;
dvander@486
   151
}
dvander@486
   152
dvander@486
   153
bool CPlugin::SetProperty(const char *prop, void *ptr)
dvander@486
   154
{
dvander@486
   155
	return sm_trie_insert(m_pProps, prop, ptr);
dvander@486
   156
}
dvander@486
   157
dvander@209
   158
ICompilation *CPlugin::StartMyCompile(IVirtualMachine *vm)
dvander@209
   159
{
dvander@209
   160
	if (!m_plugin)
dvander@173
   161
	{
dvander@209
   162
		return NULL;
dvander@173
   163
	}
dvander@173
   164
dvander@209
   165
	/* :NOTICE: We will eventually need to change these natives
dvander@209
   166
	 * for swapping in new contexts
dvander@209
   167
	 */
dvander@209
   168
	if (m_ctx.co || m_ctx.ctx)
dvander@173
   169
	{
dvander@173
   170
		return NULL;
dvander@173
   171
	}
dvander@173
   172
dvander@209
   173
	m_status = Plugin_Uncompiled;
dvander@173
   174
dvander@209
   175
	m_ctx.vm = vm;
dvander@209
   176
	m_ctx.co = vm->StartCompilation(m_plugin);
dvander@209
   177
dvander@209
   178
	return m_ctx.co;
dvander@209
   179
}
dvander@173
   180
dvander@209
   181
void CPlugin::CancelMyCompile()
dvander@209
   182
{
dvander@209
   183
	if (!m_ctx.co)
dvander@209
   184
	{
dvander@209
   185
		return;
dvander@209
   186
	}
dvander@176
   187
dvander@209
   188
	m_ctx.vm->AbortCompilation(m_ctx.co);
dvander@209
   189
	m_ctx.co = NULL;
dvander@209
   190
	m_ctx.vm = NULL;
dvander@209
   191
}
dvander@209
   192
dvander@209
   193
bool CPlugin::FinishMyCompile(char *error, size_t maxlength)
dvander@209
   194
{
dvander@209
   195
	if (!m_ctx.co)
dvander@176
   196
	{
dvander@209
   197
		return false;
dvander@176
   198
	}
dvander@176
   199
dvander@209
   200
	int err;
dvander@209
   201
	m_ctx.ctx = m_ctx.vm->CompileToContext(m_ctx.co, &err);
dvander@209
   202
	if (!m_ctx.ctx)
dvander@176
   203
	{
dvander@209
   204
		memset(&m_ctx, 0, sizeof(m_ctx));
dvander@298
   205
		if (error)
dvander@209
   206
		{
dvander@209
   207
			snprintf(error, maxlength, "Failed to compile (error %d)", err);
dvander@209
   208
		}
dvander@209
   209
		return false;
dvander@176
   210
	}
dvander@176
   211
dvander@262
   212
	m_ctx.base = new BaseContext(m_ctx.ctx);
dvander@209
   213
	m_ctx.ctx->user[SM_CONTEXTVAR_MYSELF] = (void *)this;
dvander@209
   214
dvander@211
   215
	m_status = Plugin_Created;
faluco@216
   216
	m_ctx.co = NULL;
dvander@211
   217
dvander@209
   218
	UpdateInfo();
dvander@209
   219
dvander@209
   220
	return true;
dvander@209
   221
}
dvander@209
   222
dvander@209
   223
void CPlugin::SetErrorState(PluginStatus status, const char *error_fmt, ...)
dvander@209
   224
{
dvander@605
   225
	PluginStatus old_status = m_status;
dvander@209
   226
	m_status = status;
dvander@209
   227
dvander@605
   228
	if (old_status == Plugin_Running)
dvander@605
   229
	{
dvander@605
   230
		/* Tell everyone we're now paused */
dvander@605
   231
		g_PluginSys._SetPauseState(this, true);
dvander@605
   232
	}
dvander@605
   233
dvander@209
   234
	va_list ap;
dvander@209
   235
	va_start(ap, error_fmt);
dvander@209
   236
	vsnprintf(m_errormsg, sizeof(m_errormsg), error_fmt, ap);
dvander@209
   237
	va_end(ap);
dvander@173
   238
dvander@525
   239
	if (m_ctx.ctx)
dvander@176
   240
	{
dvander@525
   241
		m_ctx.ctx->flags |= SPFLAG_PLUGIN_PAUSED;
dvander@176
   242
	}
dvander@176
   243
}
dvander@176
   244
dvander@173
   245
void CPlugin::UpdateInfo()
dvander@173
   246
{
dvander@173
   247
	/* Now grab the info */
dvander@173
   248
	uint32_t idx;
dvander@173
   249
	IPluginContext *base = GetBaseContext();
dvander@173
   250
	int err = base->FindPubvarByName("myinfo", &idx);
dvander@173
   251
dvander@413
   252
	memset(&m_info, 0, sizeof(m_info));
dvander@413
   253
dvander@173
   254
	if (err == SP_ERROR_NONE)
dvander@173
   255
	{
dvander@173
   256
		struct sm_plugininfo_c_t
dvander@173
   257
		{
dvander@173
   258
			cell_t name;
dvander@173
   259
			cell_t description;
dvander@173
   260
			cell_t author;
dvander@173
   261
			cell_t version;
dvander@173
   262
			cell_t url;
dvander@173
   263
		};
dvander@173
   264
		sm_plugininfo_c_t *cinfo;
dvander@173
   265
		cell_t local_addr;
dvander@173
   266
dvander@173
   267
		base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&cinfo);
dvander@173
   268
		base->LocalToString(cinfo->name, (char **)&m_info.name);
dvander@173
   269
		base->LocalToString(cinfo->description, (char **)&m_info.description);
dvander@173
   270
		base->LocalToString(cinfo->author, (char **)&m_info.author);
dvander@173
   271
		base->LocalToString(cinfo->url, (char **)&m_info.url);
dvander@173
   272
		base->LocalToString(cinfo->version, (char **)&m_info.version);
dvander@173
   273
	}
dvander@173
   274
dvander@173
   275
	m_info.author = m_info.author ? m_info.author : "";
dvander@173
   276
	m_info.description = m_info.description ? m_info.description : "";
dvander@173
   277
	m_info.name = m_info.name ? m_info.name : "";
dvander@173
   278
	m_info.url = m_info.url ? m_info.url : "";
dvander@173
   279
	m_info.version = m_info.version ? m_info.version : "";
dvander@173
   280
}
dvander@173
   281
ds@426
   282
void CPlugin::Call_OnPluginStart()
dvander@211
   283
{
dvander@211
   284
	if (m_status != Plugin_Loaded)
dvander@211
   285
	{
dvander@211
   286
		return;
dvander@211
   287
	}
dvander@211
   288
dvander@211
   289
	m_status = Plugin_Running;
dvander@211
   290
dvander@211
   291
	cell_t result;
dvander@340
   292
	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginStart");
dvander@211
   293
	if (!pFunction)
dvander@211
   294
	{
dvander@211
   295
		return;
dvander@211
   296
	}
dvander@211
   297
dvander@282
   298
	pFunction->Execute(&result);
dvander@282
   299
}
dvander@282
   300
ds@426
   301
void CPlugin::Call_OnPluginEnd()
dvander@282
   302
{
faluco@736
   303
	if (m_status > Plugin_Paused)
dvander@211
   304
	{
dvander@282
   305
		return;
dvander@211
   306
	}
dvander@282
   307
dvander@282
   308
	cell_t result;
dvander@340
   309
	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginEnd");
dvander@282
   310
	if (!pFunction)
dvander@282
   311
	{
dvander@282
   312
		return;
dvander@282
   313
	}
dvander@282
   314
dvander@282
   315
	pFunction->Execute(&result);
dvander@211
   316
}
dvander@211
   317
dvander@211
   318
bool CPlugin::Call_AskPluginLoad(char *error, size_t maxlength)
dvander@211
   319
{
dvander@211
   320
	if (m_status != Plugin_Created)
dvander@211
   321
	{
dvander@211
   322
		return false;
dvander@211
   323
	}
dvander@211
   324
faluco@216
   325
	m_status = Plugin_Loaded;
faluco@216
   326
dvander@211
   327
	int err;
dvander@211
   328
	cell_t result;
dvander@327
   329
	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("AskPluginLoad");
dvander@211
   330
dvander@211
   331
	if (!pFunction)
dvander@211
   332
	{
dvander@211
   333
		return true;
dvander@211
   334
	}
dvander@211
   335
dvander@222
   336
	pFunction->PushCell(m_handle);
dvander@211
   337
	pFunction->PushCell(g_PluginSys.IsLateLoadTime() ? 1 : 0);
dvander@211
   338
	pFunction->PushStringEx(error, maxlength, 0, SM_PARAM_COPYBACK);
dvander@211
   339
	pFunction->PushCell(maxlength);
dvander@211
   340
	if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE)
dvander@211
   341
	{
dvander@211
   342
		return false;
dvander@211
   343
	}
dvander@211
   344
dvander@282
   345
	if (!result || m_status != Plugin_Loaded)
dvander@211
   346
	{
dvander@211
   347
		return false;
dvander@211
   348
	}
dvander@211
   349
dvander@211
   350
	return true;
dvander@211
   351
}
dvander@211
   352
dvander@615
   353
const sp_plugin_t *CPlugin::GetPluginStructure()
dvander@173
   354
{
dvander@173
   355
	return m_plugin;
dvander@173
   356
}
dvander@173
   357
dvander@615
   358
IPluginContext *CPlugin::GetBaseContext()
dvander@173
   359
{
dvander@209
   360
	return m_ctx.base;
dvander@173
   361
}
dvander@173
   362
dvander@615
   363
sp_context_t *CPlugin::GetContext()
dvander@173
   364
{
dvander@209
   365
	return m_ctx.ctx;
dvander@173
   366
}
dvander@173
   367
dvander@615
   368
const char *CPlugin::GetFilename()
dvander@173
   369
{
dvander@173
   370
	return m_filename;
dvander@173
   371
}
dvander@173
   372
dvander@615
   373
PluginType CPlugin::GetType()
dvander@173
   374
{
dvander@174
   375
	return m_type;
dvander@173
   376
}
dvander@173
   377
dvander@615
   378
const sm_plugininfo_t *CPlugin::GetPublicInfo()
dvander@173
   379
{
dvander@173
   380
	return &m_info;
dvander@173
   381
}
dvander@173
   382
dvander@615
   383
unsigned int CPlugin::GetSerial()
dvander@173
   384
{
dvander@173
   385
	return m_serial;
dvander@173
   386
}
dvander@173
   387
dvander@615
   388
PluginStatus CPlugin::GetStatus()
dvander@173
   389
{
dvander@173
   390
	return m_status;
dvander@173
   391
}
dvander@173
   392
dvander@615
   393
bool CPlugin::IsDebugging()
dvander@173
   394
{
dvander@209
   395
	if (!m_ctx.ctx)
dvander@209
   396
	{
dvander@209
   397
		return false;
dvander@209
   398
	}
dvander@209
   399
dvander@209
   400
	return ((m_ctx.ctx->flags & SP_FLAG_DEBUG) == SP_FLAG_DEBUG);
dvander@173
   401
}
dvander@173
   402
dvander@173
   403
bool CPlugin::SetPauseState(bool paused)
dvander@173
   404
{
dvander@173
   405
	if (paused && GetStatus() != Plugin_Paused)
dvander@173
   406
	{
dvander@173
   407
		return false;
dvander@173
   408
	} else if (!paused && GetStatus() != Plugin_Running) {
dvander@173
   409
		return false;
dvander@173
   410
	}
dvander@282
   411
dvander@327
   412
	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginPauseChange");
dvander@282
   413
	if (pFunction)
dvander@282
   414
	{
dvander@282
   415
		cell_t result;
dvander@282
   416
		pFunction->PushCell(paused ? 1 : 0);
dvander@282
   417
		pFunction->Execute(&result);
dvander@282
   418
	}
dvander@173
   419
dvander@525
   420
	if (paused)
dvander@525
   421
	{
dvander@525
   422
		m_status = Plugin_Paused;
dvander@525
   423
		m_ctx.ctx->flags |= SPFLAG_PLUGIN_PAUSED;
dvander@525
   424
	} else {
dvander@525
   425
		m_status = Plugin_Running;
dvander@525
   426
		m_ctx.ctx->flags &= ~SPFLAG_PLUGIN_PAUSED;
dvander@525
   427
	}
dvander@525
   428
faluco@430
   429
	g_PluginSys._SetPauseState(this, paused);
faluco@430
   430
dvander@173
   431
	return true;
dvander@173
   432
}
dvander@174
   433
dvander@615
   434
IdentityToken_t *CPlugin::GetIdentity()
dvander@220
   435
{
dvander@229
   436
	return m_ident;
dvander@220
   437
}
dvander@220
   438
dvander@309
   439
bool CPlugin::ToggleDebugMode(bool debug, char *error, size_t maxlength)
faluco@290
   440
{
faluco@290
   441
	int err;
faluco@290
   442
faluco@290
   443
	if (!IsRunnable())
faluco@290
   444
	{
dvander@309
   445
		if (error)
dvander@309
   446
		{
dvander@309
   447
			snprintf(error, maxlength, "Plugin is not runnable.");
dvander@309
   448
		}
faluco@290
   449
		return false;
faluco@290
   450
	}
faluco@290
   451
dvander@309
   452
	if (debug && IsDebugging())
faluco@290
   453
	{
dvander@309
   454
		if (error)
dvander@309
   455
		{
dvander@309
   456
			snprintf(error, maxlength, "Plugin is already in debug mode.");
dvander@309
   457
		}
dvander@309
   458
		return false;
dvander@309
   459
	} else if (!debug && !IsDebugging()) {
dvander@309
   460
		if (error)
dvander@309
   461
		{
dvander@309
   462
			snprintf(error, maxlength, "Plugins is already in production mode.");
dvander@309
   463
		}
faluco@290
   464
		return false;
faluco@290
   465
	}
dvander@309
   466
faluco@290
   467
	ICompilation *co = g_pVM->StartCompilation(m_ctx.ctx->plugin);
faluco@290
   468
	if (!g_pVM->SetCompilationOption(co, "debug", (debug) ? "1" : "0"))
faluco@290
   469
	{
dvander@309
   470
		if (error)
dvander@309
   471
		{
dvander@309
   472
			snprintf(error, maxlength, "Failed to change plugin mode (JIT failure).");
dvander@309
   473
		}
faluco@290
   474
		return false;
faluco@290
   475
	}
dvander@309
   476
faluco@290
   477
	sp_context_t *new_ctx = g_pVM->CompileToContext(co, &err);
faluco@290
   478
dvander@309
   479
	if (new_ctx)
dvander@309
   480
	{
dvander@309
   481
		memcpy(new_ctx->memory, m_ctx.ctx->memory, m_ctx.ctx->mem_size);
dvander@309
   482
		new_ctx->hp = m_ctx.ctx->hp;
dvander@309
   483
		new_ctx->sp = m_ctx.ctx->sp;
dvander@309
   484
		new_ctx->frm = m_ctx.ctx->frm;
dvander@309
   485
		new_ctx->dbreak = m_ctx.ctx->dbreak;
dvander@309
   486
		new_ctx->context = m_ctx.ctx->context;
dvander@309
   487
		memcpy(new_ctx->user, m_ctx.ctx->user, sizeof(m_ctx.ctx->user));
faluco@290
   488
dvander@693
   489
		uint32_t nativeCount = m_plugin->info.natives_num;
dvander@693
   490
		for (uint32_t i=0; i<nativeCount; i++)
dvander@693
   491
		{
dvander@693
   492
			new_ctx->natives[i].pfn = m_ctx.ctx->natives[i].pfn;
dvander@693
   493
			new_ctx->natives[i].status = m_ctx.ctx->natives[i].status;
dvander@693
   494
		}
dvander@693
   495
dvander@309
   496
		g_pVM->FreeContext(m_ctx.ctx);
dvander@309
   497
		m_ctx.ctx = new_ctx;
dvander@309
   498
		m_ctx.base->SetContext(new_ctx);
faluco@290
   499
dvander@309
   500
		UpdateInfo();
dvander@309
   501
	} else {
dvander@309
   502
		if (error)
dvander@309
   503
		{
dvander@309
   504
			snprintf(error, maxlength, "Failed to recompile plugin (JIT error %d).", err);
dvander@309
   505
		}
dvander@309
   506
		return false;
dvander@309
   507
	}
faluco@290
   508
faluco@290
   509
	return true;
faluco@290
   510
}
faluco@290
   511
dvander@615
   512
bool CPlugin::IsRunnable()
faluco@290
   513
{
faluco@290
   514
	return (m_status <= Plugin_Paused) ? true : false;
faluco@290
   515
}
faluco@290
   516
faluco@333
   517
time_t CPlugin::GetFileTimeStamp()
faluco@333
   518
{
ds@652
   519
	char path[PLATFORM_MAX_PATH];
faluco@333
   520
	g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "plugins/%s", m_filename);
faluco@333
   521
#ifdef PLATFORM_WINDOWS
faluco@333
   522
	struct _stat s;
faluco@333
   523
	if (_stat(path, &s) != 0)
dvander@351
   524
#elif defined PLATFORM_POSIX
faluco@333
   525
	struct stat s;
faluco@333
   526
	if (stat(path, &s) != 0)
faluco@333
   527
#endif
faluco@333
   528
	{
faluco@333
   529
		return 0;
faluco@333
   530
	} else {
faluco@333
   531
		return s.st_mtime;
faluco@333
   532
	}
faluco@333
   533
}
faluco@333
   534
dvander@615
   535
time_t CPlugin::GetTimeStamp()
faluco@333
   536
{
faluco@333
   537
	return m_LastAccess;
faluco@333
   538
}
faluco@333
   539
faluco@333
   540
void CPlugin::SetTimeStamp(time_t t)
faluco@333
   541
{
faluco@333
   542
	m_LastAccess = t;
faluco@333
   543
}
faluco@333
   544
faluco@389
   545
void CPlugin::AddLangFile(unsigned int index)
faluco@389
   546
{
faluco@389
   547
	m_PhraseFiles.push_back(index);
faluco@389
   548
}
faluco@389
   549
dvander@615
   550
size_t CPlugin::GetLangFileCount()
faluco@389
   551
{
faluco@389
   552
	return m_PhraseFiles.size();
faluco@389
   553
}
faluco@389
   554
dvander@615
   555
unsigned int CPlugin::GetLangFileByIndex(unsigned int index)
faluco@389
   556
{
faluco@389
   557
	return m_PhraseFiles.at(index);
faluco@389
   558
}
faluco@389
   559
dvander@605
   560
void CPlugin::DependencyDropped(CPlugin *pOwner)
dvander@605
   561
{
dvander@605
   562
	if (!m_ctx.ctx)
dvander@605
   563
	{
dvander@605
   564
		return;
dvander@605
   565
	}
dvander@605
   566
dvander@605
   567
	List<FakeNative *>::iterator iter;
dvander@605
   568
	FakeNative *pNative;
dvander@605
   569
	sp_native_t *native;
dvander@605
   570
	uint32_t idx;
dvander@605
   571
	unsigned int unbound = 0;
dvander@605
   572
dvander@605
   573
	for (iter = pOwner->m_fakeNatives.begin();
dvander@605
   574
		 iter != pOwner->m_fakeNatives.end();
dvander@605
   575
		 iter++)
dvander@605
   576
	{
dvander@605
   577
		pNative = (*iter);
dvander@605
   578
		/* Find this native! */
dvander@605
   579
		if (m_ctx.base->FindNativeByName(pNative->name.c_str(), &idx) != SP_ERROR_NONE)
dvander@605
   580
		{
dvander@605
   581
			continue;
dvander@605
   582
		}
dvander@605
   583
		/* Unbind it */
dvander@605
   584
		m_ctx.base->GetNativeByIndex(idx, &native);
dvander@605
   585
		native->pfn = NULL;
dvander@605
   586
		native->status = SP_NATIVE_UNBOUND;
dvander@605
   587
		unbound++;
dvander@605
   588
	}
dvander@605
   589
dvander@605
   590
	/* :IDEA: in the future, add native trapping? */
dvander@605
   591
	if (unbound)
dvander@605
   592
	{
dvander@605
   593
		m_FakeNativesMissing = true;
dvander@605
   594
		SetErrorState(Plugin_Error, "Depends on plugin: %s", pOwner->GetFilename());
dvander@605
   595
	}
dvander@605
   596
dvander@605
   597
	m_dependsOn.remove(pOwner);
dvander@605
   598
}
dvander@605
   599
dvander@174
   600
/*******************
dvander@174
   601
 * PLUGIN ITERATOR *
dvander@174
   602
 *******************/
dvander@190
   603
dvander@213
   604
CPluginManager::CPluginIterator::CPluginIterator(List<CPlugin *> *_mylist)
dvander@174
   605
{
dvander@174
   606
	mylist = _mylist;
faluco@216
   607
	Reset();
dvander@174
   608
}
dvander@174
   609
dvander@174
   610
IPlugin *CPluginManager::CPluginIterator::GetPlugin()
dvander@174
   611
{
dvander@174
   612
	return (*current);
dvander@174
   613
}
dvander@174
   614
dvander@174
   615
bool CPluginManager::CPluginIterator::MorePlugins()
dvander@174
   616
{
dvander@174
   617
	return (current != mylist->end());
dvander@174
   618
}
dvander@174
   619
dvander@174
   620
void CPluginManager::CPluginIterator::NextPlugin()
dvander@174
   621
{
dvander@174
   622
	current++;
dvander@174
   623
}
dvander@174
   624
dvander@174
   625
void CPluginManager::CPluginIterator::Release()
dvander@174
   626
{
dvander@211
   627
	g_PluginSys.ReleaseIterator(this);
dvander@174
   628
}
dvander@174
   629
dvander@174
   630
CPluginManager::CPluginIterator::~CPluginIterator()
dvander@174
   631
{
dvander@174
   632
}
dvander@174
   633
dvander@174
   634
void CPluginManager::CPluginIterator::Reset()
dvander@174
   635
{
dvander@174
   636
	current = mylist->begin();
dvander@174
   637
}
dvander@174
   638
dvander@174
   639
/******************
dvander@174
   640
 * PLUGIN MANAGER *
dvander@174
   641
 ******************/
dvander@174
   642
dvander@211
   643
CPluginManager::CPluginManager()
dvander@211
   644
{
dvander@211
   645
	m_LoadLookup = sm_trie_create();
dvander@211
   646
	m_AllPluginsLoaded = false;
dvander@229
   647
	m_MyIdent = NULL;
dvander@601
   648
	m_pNativeLookup = sm_trie_create();
dvander@211
   649
}
dvander@211
   650
dvander@211
   651
CPluginManager::~CPluginManager()
dvander@211
   652
{
dvander@282
   653
	/* :NOTICE: 
dvander@282
   654
	 * Ignore the fact that there might be plugins in the cache.
dvander@282
   655
	 * This usually means that Core is not being unloaded properly, and everything
dvander@282
   656
	 * will crash anyway.  YAY
dvander@282
   657
	 */
dvander@211
   658
	sm_trie_destroy(m_LoadLookup);
dvander@601
   659
	sm_trie_destroy(m_pNativeLookup);
faluco@641
   660
faluco@641
   661
	CStack<CPluginManager::CPluginIterator *>::iterator iter;
faluco@641
   662
	for (iter=m_iters.begin(); iter!=m_iters.end(); iter++)
faluco@641
   663
	{
faluco@641
   664
		delete (*iter);
faluco@641
   665
	}
faluco@641
   666
	m_iters.popall();
dvander@211
   667
}
dvander@211
   668
dvander@213
   669
void CPluginManager::LoadAll_FirstPass(const char *config, const char *basedir)
dvander@190
   670
{
dvander@203
   671
	/* First read in the database of plugin settings */
dvander@203
   672
	SMCParseError err;
dvander@203
   673
	unsigned int line, col;
faluco@216
   674
	m_AllPluginsLoaded = false;
dvander@273
   675
	if ((err=g_TextParser.ParseFile_SMC(config, &m_PluginInfo, &line, &col)) != SMCParse_Okay)
dvander@203
   676
	{
dvander@305
   677
		g_Logger.LogError("[SM] Encountered fatal error parsing file \"%s\"", config);
dvander@282
   678
		const char *err_msg = g_TextParser.GetSMCErrorString(err);
dvander@282
   679
		if (err_msg)
dvander@282
   680
		{
dvander@305
   681
			g_Logger.LogError("[SM] Parse error encountered: \"%s\"", err_msg);
dvander@282
   682
		}
dvander@203
   683
	}
dvander@203
   684
dvander@209
   685
	LoadPluginsFromDir(basedir, NULL);
dvander@209
   686
}
dvander@203
   687
dvander@209
   688
void CPluginManager::LoadPluginsFromDir(const char *basedir, const char *localpath)
dvander@209
   689
{
ds@652
   690
	char base_path[PLATFORM_MAX_PATH];
dvander@209
   691
dvander@209
   692
	/* Form the current path to start reading from */
dvander@209
   693
	if (localpath == NULL)
dvander@209
   694
	{
dvander@209
   695
		g_LibSys.PathFormat(base_path, sizeof(base_path), "%s", basedir);
dvander@209
   696
	} else {
dvander@209
   697
		g_LibSys.PathFormat(base_path, sizeof(base_path), "%s/%s", basedir, localpath);
dvander@209
   698
	}
dvander@209
   699
dvander@209
   700
	IDirectory *dir = g_LibSys.OpenDirectory(base_path);
dvander@209
   701
dvander@209
   702
	if (!dir)
dvander@209
   703
	{
dvander@282
   704
		char error[256];
dvander@282
   705
		g_LibSys.GetPlatformError(error, sizeof(error));
dvander@305
   706
		g_Logger.LogError("[SM] Failure reading from plugins path: %s", localpath);
dvander@305
   707
		g_Logger.LogError("[SM] Platform returned error: %s", error);
dvander@209
   708
		return;
dvander@209
   709
	}
dvander@209
   710
dvander@190
   711
	while (dir->MoreFiles())
dvander@190
   712
	{
dvander@209
   713
		if (dir->IsEntryDirectory() 
dvander@209
   714
			&& (strcmp(dir->GetEntryName(), ".") != 0)
dvander@209
   715
			&& (strcmp(dir->GetEntryName(), "..") != 0)
dvander@209
   716
			&& (strcmp(dir->GetEntryName(), "disabled") != 0)
dvander@209
   717
			&& (strcmp(dir->GetEntryName(), "optional") != 0))
dvander@190
   718
		{
ds@652
   719
			char new_local[PLATFORM_MAX_PATH];
dvander@209
   720
			if (localpath == NULL)
dvander@209
   721
			{
dvander@209
   722
				/* If no path yet, don't add a former slash */
dvander@209
   723
				snprintf(new_local, sizeof(new_local), "%s", dir->GetEntryName());
dvander@209
   724
			} else {
dvander@209
   725
				g_LibSys.PathFormat(new_local, sizeof(new_local), "%s/%s", localpath, dir->GetEntryName());
dvander@209
   726
			}
dvander@209
   727
			LoadPluginsFromDir(basedir, new_local);
dvander@209
   728
		} else if (dir->IsEntryFile()) {
dvander@209
   729
			const char *name = dir->GetEntryName();
dvander@209
   730
			size_t len = strlen(name);
dvander@211
   731
			if (len >= 4
dvander@211
   732
				&& strcmp(&name[len-4], ".smx") == 0)
dvander@209
   733
			{
dvander@211
   734
				/* If the filename matches, load the plugin */
ds@652
   735
				char plugin[PLATFORM_MAX_PATH];
dvander@211
   736
				if (localpath == NULL)
dvander@211
   737
				{
dvander@211
   738
					snprintf(plugin, sizeof(plugin), "%s", name);
dvander@211
   739
				} else {
dvander@211
   740
					g_LibSys.PathFormat(plugin, sizeof(plugin), "%s/%s", localpath, name);
dvander@211
   741
				}
dvander@211
   742
				LoadAutoPlugin(plugin);
dvander@209
   743
			}
dvander@209
   744
		}
dvander@209
   745
		dir->NextEntry();
dvander@209
   746
	}
dvander@209
   747
	g_LibSys.CloseDirectory(dir);
dvander@209
   748
}
dvander@209
   749
dvander@211
   750
//well i have discovered that gabe newell is very fat, so i wrote this comment now
ds@755
   751
LoadRes CPluginManager::_LoadPlugin(CPlugin **_plugin, const char *path, bool debug, PluginType type, char error[], size_t maxlength)
dvander@209
   752
{
dvander@211
   753
	/**
dvander@211
   754
	 * Does this plugin already exist?
dvander@211
   755
	 */
dvander@211
   756
	CPlugin *pPlugin;
dvander@298
   757
	if (sm_trie_retrieve(m_LoadLookup, path, (void **)&pPlugin))
dvander@211
   758
	{
dvander@211
   759
		/* Check to see if we should try reloading it */
dvander@211
   760
		if (pPlugin->GetStatus() == Plugin_BadLoad
dvander@282
   761
			|| pPlugin->GetStatus() == Plugin_Error
dvander@282
   762
			|| pPlugin->GetStatus() == Plugin_Failed)
dvander@211
   763
		{
dvander@211
   764
			UnloadPlugin(pPlugin);
faluco@383
   765
		} else {
faluco@383
   766
			if (_plugin)
faluco@383
   767
			{
faluco@383
   768
				*_plugin = pPlugin;
faluco@383
   769
			}
faluco@383
   770
			return LoadRes_AlreadyLoaded;
dvander@211
   771
		}
dvander@211
   772
	}
dvander@211
   773
ds@755
   774
	pPlugin = CPlugin::CreatePlugin(path, error, maxlength);
dvander@209
   775
dvander@209
   776
	assert(pPlugin != NULL);
dvander@209
   777
dvander@209
   778
	pPlugin->m_type = PluginType_MapUpdated;
dvander@209
   779
dvander@209
   780
	ICompilation *co = NULL;
dvander@209
   781
dvander@209
   782
	if (pPlugin->m_status == Plugin_Uncompiled)
dvander@209
   783
	{
dvander@209
   784
		co = pPlugin->StartMyCompile(g_pVM);
dvander@209
   785
	}
dvander@209
   786
dvander@209
   787
	PluginSettings *pset;
dvander@209
   788
	unsigned int setcount = m_PluginInfo.GetSettingsNum();
dvander@209
   789
	for (unsigned int i=0; i<setcount; i++)
dvander@209
   790
	{
dvander@298
   791
		if ((pset=m_PluginInfo.GetSettingsIfMatch(i, path)) == NULL)
dvander@209
   792
		{
dvander@209
   793
			continue;
dvander@209
   794
		}
dvander@209
   795
		pPlugin->m_type = pset->type_val;
dvander@209
   796
		if (co)
dvander@209
   797
		{
dvander@209
   798
			for (unsigned int j=0; j<pset->opts_num; j++)
dvander@209
   799
			{
dvander@209
   800
				const char *key, *val;
dvander@209
   801
				m_PluginInfo.GetOptionsForPlugin(pset, j, &key, &val);
dvander@209
   802
				if (!key || !val)
dvander@209
   803
				{
dvander@209
   804
					continue;
dvander@209
   805
				}
dvander@209
   806
				if (!g_pVM->SetCompilationOption(co, key, val))
dvander@209
   807
				{
dvander@298
   808
					if (error)
dvander@298
   809
					{
ds@755
   810
						snprintf(error, maxlength, "Unable to set JIT option (key \"%s\") (value \"%s\")", key, val);
dvander@298
   811
					}
dvander@209
   812
					pPlugin->CancelMyCompile();
dvander@209
   813
					co = NULL;
dvander@209
   814
					break;
dvander@209
   815
				}
dvander@209
   816
			}
dvander@190
   817
		}
dvander@190
   818
	}
dvander@209
   819
dvander@298
   820
	/* Do the actual compiling */
dvander@209
   821
	if (co)
dvander@209
   822
	{
dvander@209
   823
		pPlugin->FinishMyCompile(NULL, 0);
dvander@209
   824
		co = NULL;
dvander@209
   825
	}
dvander@209
   826
dvander@298
   827
	/* Get the status */
dvander@211
   828
	if (pPlugin->GetStatus() == Plugin_Created)
dvander@211
   829
	{
dvander@211
   830
		AddCoreNativesToPlugin(pPlugin);
dvander@229
   831
		pPlugin->InitIdentity();
ds@755
   832
		if (pPlugin->Call_AskPluginLoad(error, maxlength))
dvander@315
   833
		{
dvander@315
   834
			/* Autoload any modules */
ds@755
   835
			LoadOrRequireExtensions(pPlugin, 1, error, maxlength);
dvander@315
   836
		}
dvander@211
   837
	}
dvander@211
   838
faluco@333
   839
	/* Save the time stamp */
faluco@333
   840
	time_t t = pPlugin->GetFileTimeStamp();
faluco@333
   841
	pPlugin->SetTimeStamp(t);
faluco@333
   842
dvander@298
   843
	if (_plugin)
dvander@298
   844
	{
dvander@298
   845
		*_plugin = pPlugin;
dvander@298
   846
	}
dvander@298
   847
faluco@383
   848
	return (pPlugin->GetStatus() == Plugin_Loaded) ? LoadRes_Successful : LoadRes_Failure;
dvander@190
   849
}
dvander@190
   850
ds@755
   851
IPlugin *CPluginManager::LoadPlugin(const char *path, bool debug, PluginType type, char error[], size_t maxlength, bool *wasloaded)
dvander@174
   852
{
dvander@298
   853
	CPlugin *pl;
faluco@383
   854
	LoadRes res;
dvander@211
   855
faluco@383
   856
	*wasloaded = false;
ds@755
   857
	if ((res=_LoadPlugin(&pl, path, debug, type, error, maxlength)) == LoadRes_Failure)
dvander@211
   858
	{
dvander@298
   859
		delete pl;
dvander@174
   860
		return NULL;
dvander@174
   861
	}
dvander@174
   862
faluco@383
   863
	if (res == LoadRes_AlreadyLoaded)
faluco@383
   864
	{
faluco@383
   865
		*wasloaded = true;
faluco@383
   866
		return pl;
faluco@383
   867
	}
faluco@383
   868
dvander@298
   869
	AddPlugin(pl);
dvander@298
   870
dvander@315
   871
	/* Run second pass if we need to */
dvander@315
   872
	if (IsLateLoadTime() && pl->GetStatus() == Plugin_Loaded)
dvander@315
   873
	{
ds@755
   874
		if (!RunSecondPass(pl, error, maxlength))
dvander@315
   875
		{
dvander@315
   876
			UnloadPlugin(pl);
dvander@315
   877
			return NULL;
dvander@315
   878
		}
dvander@315
   879
	}
dvander@315
   880
dvander@298
   881
	return pl;
dvander@298
   882
}
dvander@298
   883
dvander@298
   884
void CPluginManager::LoadAutoPlugin(const char *plugin)
dvander@298
   885
{
dvander@298
   886
	CPlugin *pl;
faluco@383
   887
	LoadRes res;
dvander@298
   888
	char error[255] = "Unknown error";
dvander@298
   889
faluco@383
   890
	if ((res=_LoadPlugin(&pl, plugin, false, PluginType_MapUpdated, error, sizeof(error))) == LoadRes_Failure)
dvander@209
   891
	{
dvander@305
   892
		g_Logger.LogError("[SM] Failed to load plugin \"%s\": %s", plugin, error);
dvander@298
   893
		pl->SetErrorState(Plugin_Failed, "%s", error);
dvander@209
   894
	}
dvander@209
   895
faluco@383
   896
	if (res == LoadRes_Successful)
faluco@383
   897
	{
faluco@383
   898
		AddPlugin(pl);
faluco@383
   899
	}
dvander@209
   900
}
dvander@209
   901
dvander@211
   902
void CPluginManager::AddPlugin(CPlugin *pPlugin)
dvander@209
   903
{
dvander@174
   904
	List<IPluginsListener *>::iterator iter;
dvander@174
   905
	IPluginsListener *pListener;
dvander@298
   906
dvander@174
   907
	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)
dvander@174
   908
	{
dvander@174
   909
		pListener = (*iter);
dvander@174
   910
		pListener->OnPluginCreated(pPlugin);
dvander@174
   911
	}
dvander@174
   912
dvander@298
   913
	m_plugins.push_back(pPlugin);
dvander@298
   914
	sm_trie_insert(m_LoadLookup, pPlugin->m_filename, pPlugin);
dvander@211
   915
}
dvander@211
   916
dvander@213
   917
void CPluginManager::LoadAll_SecondPass()
dvander@213
   918
{
dvander@213
   919
	List<CPlugin *>::iterator iter;
dvander@213
   920
	CPlugin *pPlugin;
dvander@213
   921
dvander@315
   922
	char error[256];
dvander@213
   923
	for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++)
dvander@213
   924
	{
dvander@213
   925
		pPlugin = (*iter);
dvander@213
   926
		if (pPlugin->GetStatus() == Plugin_Loaded)
dvander@213
   927
		{
dvander@315
   928
			error[0] = '\0';
dvander@315
   929
			if (!RunSecondPass(pPlugin, error, sizeof(error)))
dvander@315
   930
			{
dvander@315
   931
				g_Logger.LogError("[SM] Unable to load plugin \"%s\": %s", pPlugin->GetFilename(), error);
dvander@315
   932
				pPlugin->SetErrorState(Plugin_Failed, "%s", error);
dvander@315
   933
			}
dvander@213
   934
		}
dvander@213
   935
	}
dvander@298
   936
faluco@216
   937
	m_AllPluginsLoaded = true;
dvander@213
   938
}
dvander@213
   939
dvander@315
   940
bool CPluginManager::LoadOrRequireExtensions(CPlugin *pPlugin, unsigned int pass, char *error, size_t maxlength)
dvander@211
   941
{
dvander@298
   942
	/* Find any extensions this plugin needs */
dvander@298
   943
	struct _ext
dvander@298
   944
	{
dvander@298
   945
		cell_t name;
dvander@298
   946
		cell_t file;
dvander@298
   947
		cell_t autoload;
dvander@298
   948
		cell_t required;
dvander@298
   949
	} *ext;
dvander@298
   950
dvander@298
   951
	IPluginContext *pBase = pPlugin->GetBaseContext();
dvander@298
   952
	uint32_t num = pBase->GetPubVarsNum();
dvander@298
   953
	sp_pubvar_t *pubvar;
dvander@298
   954
	IExtension *pExt;
ds@652
   955
	char path[PLATFORM_MAX_PATH];
dvander@298
   956
	char *file, *name;
dvander@298
   957
	for (uint32_t i=0; i<num; i++)
dvander@298
   958
	{
dvander@298
   959
		if (pBase->GetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE)
dvander@298
   960
		{
dvander@298
   961
			continue;
dvander@298
   962
		}
dvander@298
   963
		if (strncmp(pubvar->name, "__ext_", 6) == 0)
dvander@298
   964
		{
dvander@298
   965
			ext = (_ext *)pubvar->offs;
dvander@298
   966
			if (!ext->required && !ext->autoload)
dvander@298
   967
			{
dvander@298
   968
				continue;
dvander@298
   969
			}
dvander@298
   970
			if (pBase->LocalToString(ext->file, &file) != SP_ERROR_NONE)
dvander@298
   971
			{
dvander@298
   972
				continue;
dvander@298
   973
			}
dvander@298
   974
			if (pBase->LocalToString(ext->name, &name) != SP_ERROR_NONE)
dvander@298
   975
			{
dvander@298
   976
				continue;
dvander@298
   977
			}
dvander@315
   978
			if (pass == 1)
dvander@298
   979
			{
dvander@315
   980
				/* Attempt to auto-load if necessary */
dvander@315
   981
				if (ext->autoload)
dvander@315
   982
				{
dvander@315
   983
					g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file);
dvander@315
   984
					g_Extensions.LoadAutoExtension(path);
dvander@315
   985
				}
dvander@315
   986
			} else if (pass == 2) {
dvander@315
   987
				/* Is this required? */
dvander@315
   988
				if (ext->required)
dvander@298
   989
				{
dvander@315
   990
					g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file);
dvander@315
   991
					if ((pExt = g_Extensions.FindExtensionByFile(path)) == NULL)
dvander@315
   992
					{
dvander@315
   993
						pExt = g_Extensions.FindExtensionByName(name);
dvander@315
   994
					}
dvander@315
   995
					/* :TODO: should we bind to unloaded extensions?
dvander@315
   996
					 * Currently the extension manager will ignore this.
dvander@315
   997
					 */
dvander@315
   998
					if (!pExt || !pExt->IsRunning(NULL, 0))
dvander@315
   999
					{
dvander@315
  1000
						if (error)
dvander@315
  1001
						{
dvander@315
  1002
							snprintf(error, maxlength, "Required extension \"%s\" file(\"%s\") not running", name, file);
dvander@315
  1003
						}
dvander@315
  1004
						return false;
dvander@315
  1005
					} else {
dvander@315
  1006
						g_Extensions.BindChildPlugin(pExt, pPlugin);
dvander@315
  1007
					}
dvander@298
  1008
				}
dvander@298
  1009
			}
dvander@315
  1010
		}
dvander@315
  1011
	}
dvander@315
  1012
dvander@315
  1013
	return true;
dvander@315
  1014
}
dvander@315
  1015
dvander@315
  1016
bool CPluginManager::RunSecondPass(CPlugin *pPlugin, char *error, size_t maxlength)
dvander@315
  1017
{
dvander@315
  1018
	/* Second pass for extension requirements */
dvander@315
  1019
	if (!LoadOrRequireExtensions(pPlugin, 2, error, maxlength))
dvander@315
  1020
	{
dvander@315
  1021
		return false;
dvander@315
  1022
	}
dvander@315
  1023
dvander@315
  1024
	/* Bind all extra natives */
dvander@315
  1025
	g_Extensions.BindAllNativesToPlugin(pPlugin);
dvander@601
  1026
	AddFakeNativesToPlugin(pPlugin);
dvander@315
  1027
dvander@315
  1028
	/* Find any unbound natives
dvander@315
  1029
	 * Right now, these are not allowed
dvander@315
  1030
	 */
dvander@315
  1031
	IPluginContext *pContext = pPlugin->GetBaseContext();
dvander@315
  1032
	uint32_t num = pContext->GetNativesNum();
dvander@315
  1033
	sp_native_t *native;
dvander@315
  1034
	for (unsigned int i=0; i<num; i++)
dvander@315
  1035
	{
dvander@315
  1036
		if (pContext->GetNativeByIndex(i, &native) != SP_ERROR_NONE)
dvander@315
  1037
		{
dvander@315
  1038
			break;
dvander@315
  1039
		}
dvander@315
  1040
		if (native->status == SP_NATIVE_UNBOUND)
dvander@315
  1041
		{
dvander@315
  1042
			if (error)
dvander@298
  1043
			{
dvander@315
  1044
				snprintf(error, maxlength, "Native \"%s\" was not found.", native->name);
dvander@298
  1045
			}
dvander@315
  1046
			return false;
dvander@298
  1047
		}
dvander@298
  1048
	}
dvander@211
  1049
dvander@211
  1050
	/* Finish by telling all listeners */
dvander@211
  1051
	List<IPluginsListener *>::iterator iter;
dvander@211
  1052
	IPluginsListener *pListener;
dvander@211
  1053
	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)
dvander@211
  1054
	{
dvander@211
  1055
		pListener = (*iter);
dvander@211
  1056
		pListener->OnPluginLoaded(pPlugin);
dvander@211
  1057
	}
dvander@298
  1058
	
dvander@298
  1059
	/* Tell this plugin to finish initializing itself */
ds@426
  1060
	pPlugin->Call_OnPluginStart();
dvander@298
  1061
dvander@605
  1062
	/* Now, if we have fake natives, go through all plugins that might need rebinding */
dvander@605
  1063
	if (pPlugin->m_fakeNatives.size())
dvander@605
  1064
	{
dvander@605
  1065
		List<CPlugin *>::iterator pl_iter;
dvander@605
  1066
		CPlugin *pOther;
dvander@605
  1067
		for (pl_iter = m_plugins.begin();
dvander@605
  1068
			 pl_iter != m_plugins.end();
dvander@605
  1069
			 pl_iter++)
dvander@605
  1070
		{
dvander@605
  1071
			pOther = (*pl_iter);
dvander@605
  1072
			if (pOther->GetStatus() == Plugin_Error
dvander@605
  1073
				&& pOther->m_FakeNativesMissing)
dvander@605
  1074
			{
dvander@605
  1075
				TryRefreshNatives(pOther);
dvander@605
  1076
			}
dvander@605
  1077
		}
dvander@605
  1078
	}
dvander@605
  1079
dvander@298
  1080
	return true;
dvander@211
  1081
}
dvander@211
  1082
dvander@211
  1083
void CPluginManager::AddCoreNativesToPlugin(CPlugin *pPlugin)
dvander@211
  1084
{
dvander@211
  1085
	List<sp_nativeinfo_t *>::iterator iter;
dvander@211
  1086
dvander@211
  1087
	for (iter=m_natives.begin(); iter!=m_natives.end(); iter++)
dvander@211
  1088
	{
dvander@211
  1089
		sp_nativeinfo_t *natives = (*iter);
dvander@211
  1090
		IPluginContext *ctx = pPlugin->GetBaseContext();
dvander@211
  1091
		unsigned int i=0;
dvander@211
  1092
		/* Attempt to bind every native! */
dvander@211
  1093
		while (natives[i].func != NULL)
dvander@211
  1094
		{
dvander@211
  1095
			ctx->BindNative(&natives[i++]);
dvander@211
  1096
		}
dvander@211
  1097
	}
dvander@174
  1098
}
dvander@174
  1099
dvander@605
  1100
void CPluginManager::TryRefreshNatives(CPlugin *pPlugin)
dvander@605
  1101
{
dvander@605
  1102
	assert(pPlugin->GetBaseContext() != NULL);
dvander@605
  1103
dvander@605
  1104
	AddFakeNativesToPlugin(pPlugin);
dvander@605
  1105
dvander@605
  1106
	/* Find any unbound natives
dvander@605
  1107
	 * Right now, these are not allowed
dvander@605
  1108
	 */
dvander@605
  1109
	IPluginContext *pContext = pPlugin->GetBaseContext();
dvander@605
  1110
	uint32_t num = pContext->GetNativesNum();
dvander@605
  1111
	sp_native_t *native;
dvander@605
  1112
	for (unsigned int i=0; i<num; i++)
dvander@605
  1113
	{
dvander@605
  1114
		if (pContext->GetNativeByIndex(i, &native) != SP_ERROR_NONE)
dvander@605
  1115
		{
dvander@605
  1116
			break;
dvander@605
  1117
		}
dvander@605
  1118
		if (native->status == SP_NATIVE_UNBOUND)
dvander@605
  1119
		{
dvander@605
  1120
			pPlugin->SetErrorState(Plugin_Error, "Native not found: %s", native->name);
dvander@605
  1121
			return;
dvander@605
  1122
		}
dvander@605
  1123
	}
dvander@605
  1124
dvander@605
  1125
	/* If we got here, all natives are okay again! */
dvander@605
  1126
	pPlugin->m_status = Plugin_Running;
dvander@605
  1127
	if ((pPlugin->m_ctx.ctx->flags & SPFLAG_PLUGIN_PAUSED) == SPFLAG_PLUGIN_PAUSED)
dvander@605
  1128
	{
dvander@605
  1129
		pPlugin->m_ctx.ctx->flags &= ~SPFLAG_PLUGIN_PAUSED;
dvander@605
  1130
		_SetPauseState(pPlugin, false);
dvander@605
  1131
	}
dvander@605
  1132
}
dvander@605
  1133
dvander@601
  1134
void CPluginManager::AddFakeNativesToPlugin(CPlugin *pPlugin)
dvander@601
  1135
{
dvander@601
  1136
	IPluginContext *pContext = pPlugin->GetBaseContext();
dvander@601
  1137
	sp_nativeinfo_t native;
dvander@601
  1138
dvander@601
  1139
	List<FakeNative *>::iterator iter;
dvander@601
  1140
	FakeNative *pNative;
dvander@601
  1141
	sp_context_t *ctx;
dvander@601
  1142
	for (iter = m_Natives.begin(); iter != m_Natives.end(); iter++)
dvander@601
  1143
	{
dvander@601
  1144
		pNative = (*iter);
dvander@601
  1145
		ctx = pNative->ctx->GetContext();
dvander@601
  1146
		if ((ctx->flags & SPFLAG_PLUGIN_PAUSED) == SPFLAG_PLUGIN_PAUSED)
dvander@601
  1147
		{
dvander@601
  1148
			/* Ignore natives in paused plugins */
dvander@601
  1149
			continue;
dvander@601
  1150
		}
dvander@601
  1151
		native.name = pNative->name.c_str();
dvander@601
  1152
		native.func = pNative->func;
dvander@601
  1153
		if (pContext->BindNative(&native) == SP_ERROR_NONE)
dvander@601
  1154
		{
dvander@605
  1155
			/* Add us as a dependency, but we're careful not to do this circularly! */
dvander@605
  1156
			if (pNative->ctx != pContext)
dvander@605
  1157
			{
dvander@605
  1158
				CPlugin *pOther = GetPluginByCtx(ctx);
dvander@605
  1159
				if (pOther->m_dependents.find(pPlugin) == pOther->m_dependents.end())
dvander@605
  1160
				{
dvander@605
  1161
					pOther->m_dependents.push_back(pPlugin);
dvander@605
  1162
				}
dvander@605
  1163
				if (pPlugin->m_dependsOn.find(pOther) == pPlugin->m_dependsOn.end())
dvander@605
  1164
				{
dvander@605
  1165
					pPlugin->m_dependsOn.push_back(pOther);
dvander@605
  1166
				}
dvander@605
  1167
			}
dvander@601
  1168
		}
dvander@601
  1169
	}
dvander@601
  1170
}
dvander@601
  1171
dvander@174
  1172
bool CPluginManager::UnloadPlugin(IPlugin *plugin)
dvander@174
  1173
{
dvander@174
  1174
	CPlugin *pPlugin = (CPlugin *)plugin;
dvander@298
  1175
dvander@298
  1176
	/* This prevents removal during insertion or anything else weird */
dvander@298
  1177
	if (m_plugins.find(pPlugin) == m_plugins.end())
dvander@298
  1178
	{
dvander@298
  1179
		return false;
dvander@298
  1180
	}
dvander@298
  1181
dvander@605
  1182
	/* Remove us from the lookup table and linked list */
dvander@605
  1183
	m_plugins.remove(pPlugin);
dvander@605
  1184
	sm_trie_delete(m_LoadLookup, pPlugin->m_filename);
dvander@605
  1185
dvander@605
  1186
	/* Go through all dependent plugins and tell them this plugin is now gone */
dvander@605
  1187
	List<CPlugin *>::iterator pl_iter;
dvander@605
  1188
	CPlugin *pOther;
dvander@605
  1189
	for (pl_iter = pPlugin->m_dependents.begin();
dvander@605
  1190
		 pl_iter != pPlugin->m_dependents.end();
dvander@605
  1191
		 pl_iter++)
dvander@605
  1192
	{
dvander@605
  1193
		pOther = (*pl_iter);
dvander@605
  1194
		pOther->DependencyDropped(pPlugin);
dvander@605
  1195
	}
dvander@605
  1196
dvander@605
  1197
	/* Tell everyone we depend on that we no longer exist */
dvander@605
  1198
	for (pl_iter = pPlugin->m_dependsOn.begin();
dvander@605
  1199
		 pl_iter != pPlugin->m_dependsOn.end();
dvander@605
  1200
		 pl_iter++)
dvander@605
  1201
	{
dvander@605
  1202
		pOther = (*pl_iter);
dvander@605
  1203
		pOther->m_dependents.remove(pPlugin);
dvander@605
  1204
	}
dvander@605
  1205
dvander@605
  1206
	/* Remove all of our native functions */
dvander@605
  1207
	List<FakeNative *>::iterator fn_iter;
dvander@605
  1208
	FakeNative *pNative;
dvander@605
  1209
	for (fn_iter = pPlugin->m_fakeNatives.begin();
dvander@605
  1210
		 fn_iter != pPlugin->m_fakeNatives.end();
dvander@605
  1211
		 fn_iter++)
dvander@605
  1212
	{
dvander@605
  1213
		pNative = (*fn_iter);
dvander@605
  1214
		m_Natives.remove(pNative);
dvander@605
  1215
		sm_trie_delete(m_pNativeLookup, pNative->name.c_str());
dvander@605
  1216
		g_pVM->DestroyFakeNative(pNative->func);
dvander@605
  1217
		delete pNative;
dvander@605
  1218
	}
dvander@605
  1219
dvander@174
  1220
	List<IPluginsListener *>::iterator iter;
dvander@174
  1221
	IPluginsListener *pListener;
dvander@282
  1222
dvander@311
  1223
	if (pPlugin->GetStatus() <= Plugin_Error)
dvander@282
  1224
	{
dvander@282
  1225
		/* Notify listeners of unloading */
dvander@282
  1226
		for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)
dvander@282
  1227
		{
dvander@282
  1228
			pListener = (*iter);
dvander@282
  1229
			pListener->OnPluginUnloaded(pPlugin);
dvander@282
  1230
		}
dvander@282
  1231
		/* Notify plugin */
ds@426
  1232
		pPlugin->Call_OnPluginEnd();
dvander@282
  1233
	}
dvander@282
  1234
dvander@174
  1235
	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)
dvander@174
  1236
	{
dvander@282
  1237
		/* Notify listeners of destruction */
dvander@174
  1238
		pListener = (*iter);
dvander@174
  1239
		pListener->OnPluginDestroyed(pPlugin);
dvander@174
  1240
	}
dvander@176
  1241
	
dvander@282
  1242
	/* Tell the plugin to delete itself */
dvander@174
  1243
	delete pPlugin;
dvander@174
  1244
dvander@174
  1245
	return true;
dvander@174
  1246
}
dvander@174
  1247
dvander@174
  1248
IPlugin *CPluginManager::FindPluginByContext(const sp_context_t *ctx)
dvander@174
  1249
{
dvander@174
  1250
	IPlugin *pl = (IPlugin *)ctx->user[SM_CONTEXTVAR_MYSELF];
dvander@174
  1251
	return pl;
dvander@174
  1252
}
dvander@174
  1253
dvander@174
  1254
unsigned int CPluginManager::GetPluginCount()
dvander@174
  1255
{
dvander@174
  1256
	return m_plugins.size();
dvander@174
  1257
}
dvander@174
  1258
dvander@174
  1259
void CPluginManager::AddPluginsListener(IPluginsListener *listener)
dvander@174
  1260
{
dvander@174
  1261
	m_listeners.push_back(listener);
dvander@174
  1262
}
dvander@174
  1263
dvander@174
  1264
void CPluginManager::RemovePluginsListener(IPluginsListener *listener)
dvander@174
  1265
{
dvander@174
  1266
	m_listeners.remove(listener);
dvander@174
  1267
}
dvander@174
  1268
dvander@174
  1269
IPluginIterator *CPluginManager::GetPluginIterator()
dvander@174
  1270
{
dvander@174
  1271
	if (m_iters.empty())
dvander@174
  1272
	{
dvander@174
  1273
		return new CPluginIterator(&m_plugins);
dvander@174
  1274
	} else {
dvander@174
  1275
		CPluginIterator *iter = m_iters.front();
dvander@174
  1276
		m_iters.pop();
faluco@216
  1277
		iter->Reset();
dvander@174
  1278
		return iter;
dvander@174
  1279
	}
dvander@174
  1280
}
dvander@174
  1281
dvander@174
  1282
void CPluginManager::ReleaseIterator(CPluginIterator *iter)
dvander@174
  1283
{
dvander@174
  1284
	m_iters.push(iter);
dvander@174
  1285
}
dvander@176
  1286
dvander@203
  1287
bool CPluginManager::TestAliasMatch(const char *alias, const char *localpath)
dvander@203
  1288
{
dvander@203
  1289
	/* As an optimization, we do not call strlen, but compute the length in the first pass */
dvander@203
  1290
	size_t alias_len = 0;
dvander@203
  1291
	size_t local_len = 0;
dvander@203
  1292
dvander@203
  1293
	const char *ptr = alias;
dvander@203
  1294
	unsigned int alias_explicit_paths = 0;
dvander@203
  1295
	unsigned int alias_path_end = 0;
dvander@203
  1296
	while (*ptr != '\0')
dvander@203
  1297
	{
dvander@203
  1298
		if (*ptr == '\\' || *ptr == '/')
dvander@203
  1299
		{
dvander@203
  1300
			alias_explicit_paths++;
dvander@203
  1301
			alias_path_end = alias_len;
dvander@203
  1302
		}
dvander@203
  1303
		alias_len++;
dvander@203
  1304
		ptr++;
dvander@203
  1305
	}
dvander@203
  1306
dvander@209
  1307
	if (alias_explicit_paths && alias_path_end == alias_len - 1)
dvander@203
  1308
	{
dvander@203
  1309
		/* Trailing slash is totally invalid here */
dvander@203
  1310
		return false;
dvander@203
  1311
	}
dvander@203
  1312
dvander@203
  1313
	ptr = localpath;
dvander@203
  1314
	unsigned int local_explicit_paths = 0;
dvander@203
  1315
	unsigned int local_path_end = 0;
dvander@203
  1316
	while (*ptr != '\0')
dvander@203
  1317
	{
dvander@203
  1318
		if (*ptr == '\\' || *ptr == '/')
dvander@203
  1319
		{
dvander@203
  1320
			local_explicit_paths++;
dvander@203
  1321
			local_path_end = local_len;
dvander@203
  1322
		}
dvander@203
  1323
		local_len++;
dvander@203
  1324
		ptr++;
dvander@203
  1325
	}
dvander@203
  1326
dvander@203
  1327
	/* If the alias has more explicit paths than the real path,
dvander@203
  1328
	 * no match will be possible.
dvander@203
  1329
	 */
dvander@203
  1330
	if (alias_explicit_paths > local_explicit_paths)
dvander@203
  1331
	{
dvander@203
  1332
		return false;
dvander@203
  1333
	}
dvander@203
  1334
dvander@203
  1335
	if (alias_explicit_paths)
dvander@203
  1336
	{
dvander@203
  1337
		/* We need to find if the paths match now.  For example, these should all match:
dvander@203
  1338
		 * csdm     csdm
dvander@203
  1339
		 * csdm     optional/csdm
dvander@203
  1340
		 * csdm/ban optional/crab/csdm/ban
dvander@203
  1341
		*/
dvander@203
  1342
		const char *aliasptr = alias;
dvander@203
  1343
		const char *localptr = localpath;
dvander@203
  1344
		bool match = true;
dvander@203
  1345
		do
dvander@203
  1346
		{
dvander@203
  1347
			if (*aliasptr != *localptr)
dvander@203
  1348
			{
dvander@203
  1349
				/* We have to knock one path off */
dvander@203
  1350
				local_explicit_paths--;
dvander@203
  1351
				if (alias_explicit_paths > local_explicit_paths)
dvander@203
  1352
				{
dvander@203
  1353
					/* Skip out if we're gonna have an impossible match */
dvander@203
  1354
					return false;
dvander@203
  1355
				}
dvander@203
  1356
				/* Eat up localptr tokens until we get a result */
dvander@203
  1357
				while (((localptr - localpath) < (int)local_path_end)
dvander@203
  1358
					&& *localptr != '/'
dvander@203
  1359
					&& *localptr != '\\')
dvander@203
  1360
				{
dvander@203
  1361
					localptr++;
dvander@203
  1362
				}
dvander@203
  1363
				/* Check if we hit the end of our searchable area.
dvander@203
  1364
				 * This probably isn't possible because of the path 
dvander@203
  1365
				 * count check, but it's a good idea anyway.
dvander@203
  1366
				 */
dvander@203
  1367
				if ((localptr - localpath) >= (int)local_path_end)
dvander@203
  1368
				{
dvander@203
  1369
					return false;
dvander@203
  1370
				} else {
dvander@203
  1371
					/* Consume the slash token */
dvander@203
  1372
					localptr++;
dvander@203
  1373
				}
dvander@203
  1374
				/* Reset the alias pointer so we can continue consuming */
dvander@203
  1375
				aliasptr = alias;
dvander@203
  1376
				match = false;
dvander@203
  1377
				continue;
dvander@203
  1378
			}
dvander@203
  1379
			/* Note:
dvander@203
  1380
			 * This is safe because if localptr terminates early, aliasptr will too
dvander@203
  1381
			 */
dvander@203
  1382
			do
dvander@203
  1383
			{
dvander@203
  1384
				/* We should never reach the end of the string because of this check. */
dvander@203
  1385
				bool aliasend = (aliasptr - alias) > (int)alias_path_end;
dvander@203
  1386
				bool localend = (localptr - localpath) > (int)local_path_end;
dvander@203
  1387
				if (aliasend || localend)
dvander@203
  1388
				{
dvander@203
  1389
					if (aliasend && localend)
dvander@203
  1390
					{
dvander@203
  1391
						/* we matched, and we can break out now */
dvander@203
  1392
						match = true;
dvander@203
  1393
						break;
dvander@203
  1394
					}
dvander@203
  1395
					/* Otherwise, we've hit the end somehow and rest won't match up.  Break out. */
dvander@203
  1396
					match = false;
dvander@203
  1397
					break;
dvander@203
  1398
				}
dvander@203
  1399
dvander@203
  1400
				/* If we got here, it's safe to compare the next two tokens */
dvander@203
  1401
				if (*localptr != *aliasptr)
dvander@203
  1402
				{
dvander@203
  1403
					match = false;
dvander@203
  1404
					break;
dvander@203
  1405
				}
dvander@203
  1406
				localptr++;
dvander@203
  1407
				aliasptr++;
dvander@203
  1408
			} while (true);
dvander@203
  1409
		} while (!match);
dvander@203
  1410
	}
dvander@203
  1411
dvander@203
  1412
	/* If we got here, it's time to compare filenames */
dvander@203
  1413
	const char *aliasptr = alias;
dvander@203
  1414
	const char *localptr = localpath;
dvander@203
  1415
dvander@203
  1416
	if (alias_explicit_paths)
dvander@203
  1417
	{
dvander@203
  1418
		aliasptr = &alias[alias_path_end + 1];
dvander@203
  1419
	}
dvander@203
  1420
dvander@203
  1421
	if (local_explicit_paths)
dvander@203
  1422
	{
dvander@203
  1423
		localptr = &localpath[local_path_end + 1];
dvander@203
  1424
	}
dvander@203
  1425
dvander@203
  1426
	while (true)
dvander@203
  1427
	{
dvander@203
  1428
		if (*aliasptr == '*')
dvander@203
  1429
		{
dvander@203
  1430
			/* First, see if this is the last character */
dvander@351
  1431
			if ((unsigned)(aliasptr - alias) == alias_len - 1)
dvander@203
  1432
			{
dvander@203
  1433
				/* If so, there's no need to match anything else */
dvander@203
  1434
				return true;
dvander@203
  1435
			}
dvander@203
  1436
			/* Otherwise, we need to search for an appropriate matching sequence in local.
dvander@203
  1437
			 * Note that we only need to search up to the next asterisk.
dvander@203
  1438
			 */
dvander@203
  1439
			aliasptr++;
dvander@203
  1440
			bool match = true;
dvander@203
  1441
			const char *local_orig = localptr;
dvander@203
  1442
			do
dvander@203
  1443
			{
dvander@203
  1444
				match = true;
dvander@203
  1445
				while (*aliasptr != '\0' && *aliasptr != '*')
dvander@203
  1446
				{
dvander@203
  1447
					/* Since aliasptr is never '\0', localptr hitting the end will fail */
dvander@203
  1448
					if (*aliasptr != *localptr)
dvander@203
  1449
					{
dvander@203
  1450
						match = false;
dvander@203
  1451
						break;
dvander@203
  1452
					}
dvander@203
  1453
					aliasptr++;
dvander@203
  1454
					localptr++;
dvander@203
  1455
				}
dvander@203
  1456
				if (!match)
dvander@203
  1457
				{
dvander@203
  1458
					/* If we didn't get a match, we need to advance the search stream.
dvander@203
  1459
					 * This will let us skip tokens while still searching for another match.
dvander@203
  1460
					 */
dvander@203
  1461
					localptr = ++local_orig;
dvander@203
  1462
					/* Make sure we don't go out of bounds */
dvander@203
  1463
					if (*localptr == '\0')
dvander@203
  1464
					{
dvander@203
  1465
						break;
dvander@203
  1466
					}
dvander@203
  1467
				}
dvander@203
  1468
			} while (!match);
dvander@203
  1469
dvander@203
  1470
			if (!match)
dvander@203
  1471
			{
dvander@203
  1472
				return false;
dvander@203
  1473
			} else {
dvander@203
  1474
				/* If we got a match, move on to the next token */
dvander@203
  1475
				continue;
dvander@203
  1476
			}
dvander@203
  1477
		} else if (*aliasptr == '\0') {
dvander@203
  1478
			if (*localptr == '\0'
dvander@203
  1479
				||
dvander@203
  1480
				strcmp(localptr, ".smx") == 0)
dvander@203
  1481
			{
dvander@203
  1482
				return true;
dvander@203
  1483
			} else {
dvander@203
  1484
				return false;
dvander@203
  1485
			}
dvander@203
  1486
		} else if (*aliasptr != *localptr) {
dvander@203
  1487
			return false;
dvander@203
  1488
		}
dvander@203
  1489
		aliasptr++;
dvander@203
  1490
		localptr++;
dvander@203
  1491
	}
dvander@203
  1492
dvander@203
  1493
	return true;
dvander@203
  1494
}
dvander@203
  1495
faluco@290
  1496
bool CPluginManager::IsLateLoadTime() const
dvander@176
  1497
{
dvander@315
  1498
	return (m_AllPluginsLoaded || !g_SourceMod.IsMapLoading());
dvander@176
  1499
}
dvander@220
  1500
dvander@220
  1501
void CPluginManager::OnSourceModAllInitialized()
dvander@220
  1502
{
dvander@229
  1503
	m_MyIdent = g_ShareSys.CreateCoreIdentity();
dvander@229
  1504
dvander@262
  1505
	HandleAccess sec;
dvander@262
  1506
	g_HandleSys.InitAccessDefaults(NULL, &sec);
dvander@220
  1507
dvander@262
  1508
	sec.access[HandleAccess_Delete] = HANDLE_RESTRICT_IDENTITY;
dvander@262
  1509
	sec.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY;
dvander@262
  1510
dvander@262
  1511
	g_PluginType = g_HandleSys.CreateType("Plugin", this, 0, NULL, &sec, m_MyIdent, NULL);
dvander@229
  1512
	g_PluginIdent = g_ShareSys.CreateIdentType("PLUGIN");
dvander@309
  1513
dvander@309
  1514
	g_RootMenu.AddRootConsoleCommand("plugins", "Manage Plugins", this);
dvander@336
  1515
dvander@336
  1516
	g_ShareSys.AddInterface(NULL, this);
dvander@220
  1517
}
dvander@220
  1518
dvander@220
  1519
void CPluginManager::OnSourceModShutdown()
dvander@220
  1520
{
dvander@309
  1521
	g_RootMenu.RemoveRootConsoleCommand("plugins", this);
dvander@309
  1522
dvander@298
  1523
	List<CPlugin *>::iterator iter;
dvander@298
  1524
	while ( (iter = m_plugins.begin()) != m_plugins.end() )
dvander@298
  1525
	{
dvander@298
  1526
		UnloadPlugin((*iter));
dvander@298
  1527
	}
dvander@298
  1528
dvander@229
  1529
	g_HandleSys.RemoveType(g_PluginType, m_MyIdent);
dvander@229
  1530
	g_ShareSys.DestroyIdentType(g_PluginIdent);
dvander@229
  1531
	g_ShareSys.DestroyIdentity(m_MyIdent);
dvander@220
  1532
}
dvander@220
  1533
dvander@220
  1534
void CPluginManager::OnHandleDestroy(HandleType_t type, void *object)
dvander@220
  1535
{
dvander@220
  1536
	/* We don't care about the internal object, actually */
dvander@220
  1537
}
dvander@233
  1538
dvander@233
  1539
void CPluginManager::RegisterNativesFromCore(sp_nativeinfo_t *natives)
dvander@233
  1540
{
dvander@233
  1541
	m_natives.push_back(natives);
dvander@233
  1542
}
dvander@247
  1543
dvander@247
  1544
IPlugin *CPluginManager::PluginFromHandle(Handle_t handle, HandleError *err)
dvander@247
  1545
{
dvander@247
  1546
	IPlugin *pPlugin;
dvander@247
  1547
	HandleError _err;
dvander@247
  1548
dvander@262
  1549
	HandleSecurity sec;
dvander@262
  1550
dvander@262
  1551
	sec.pOwner = NULL;
dvander@262
  1552
	sec.pIdentity = m_MyIdent;
dvander@262
  1553
dvander@262
  1554
	if ((_err=g_HandleSys.ReadHandle(handle, g_PluginType, &sec, (void **)&pPlugin)) != HandleError_None)
dvander@247
  1555
	{
dvander@247
  1556
		pPlugin = NULL;
dvander@247
  1557
	}
dvander@247
  1558
dvander@247
  1559
	if (err)
dvander@247
  1560
	{
dvander@247
  1561
		*err = _err;
dvander@247
  1562
	}
dvander@247
  1563
dvander@247
  1564
	return pPlugin;
dvander@247
  1565
}
faluco@290
  1566
faluco@290
  1567
CPlugin *CPluginManager::GetPluginByOrder(int num)
faluco@290
  1568
{
faluco@290
  1569
	if (num < 1 || num > (int)GetPluginCount())
faluco@290
  1570
	{
faluco@290
  1571
		return NULL;
faluco@290
  1572
	}
faluco@290
  1573
faluco@290
  1574
	CPlugin *pl;
faluco@290
  1575
	int id = 1;
faluco@290
  1576
faluco@290
  1577
	IPluginIterator *iter = GetPluginIterator();
faluco@290
  1578
	for (; iter->MorePlugins() && id<num; iter->NextPlugin(), id++) {}
faluco@290
  1579
faluco@290
  1580
	pl = (CPlugin *)(iter->GetPlugin());
faluco@290
  1581
	iter->Release();
faluco@290
  1582
faluco@290
  1583
	return pl;
dvander@298
  1584
}
dvander@309
  1585
dvander@309
  1586
const char *CPluginManager::GetStatusText(PluginStatus st)
dvander@309
  1587
{
dvander@309
  1588
	switch (st)
dvander@309
  1589
	{
dvander@309
  1590
	case Plugin_Running:
dvander@309
  1591
		return "Running";
dvander@309
  1592
	case Plugin_Paused:
dvander@309
  1593
		return "Paused";
dvander@309
  1594
	case Plugin_Error:
dvander@309
  1595
		return "Error";
dvander@309
  1596
	case Plugin_Uncompiled:
dvander@309
  1597
		return "Uncompiled";
dvander@309
  1598
	case Plugin_BadLoad:
dvander@309
  1599
		return "Bad Load";
dvander@309
  1600
	case Plugin_Failed:
dvander@309
  1601
		return "Failed";
dvander@309
  1602
	default:
dvander@309
  1603
		assert(false);
dvander@309
  1604
		return "-";
dvander@309
  1605
	}
dvander@309
  1606
}
dvander@309
  1607
dvander@309
  1608
void CPluginManager::OnRootConsoleCommand(const char *command, unsigned int argcount)
dvander@309
  1609
{
dvander@309
  1610
	if (argcount >= 3)
dvander@309
  1611
	{
dvander@309
  1612
		const char *cmd = g_RootMenu.GetArgument(2);
dvander@309
  1613
		if (strcmp(cmd, "list") == 0)
dvander@309
  1614
		{
dvander@309
  1615
			char buffer[256];
dvander@309
  1616
			unsigned int id = 1;
dvander@309
  1617
			int plnum = GetPluginCount();
dvander@309
  1618
dvander@309
  1619
			if (!plnum)
dvander@309
  1620
			{
dvander@309
  1621
				g_RootMenu.ConsolePrint("[SM] No plugins loaded");
dvander@309
  1622
				return;
dvander@309
  1623
			} else {
ds@582
  1624
				g_RootMenu.ConsolePrint("[SM] Listing %d plugin%s:", GetPluginCount(), (plnum > 1) ? "s" : "");
dvander@309
  1625
			}
dvander@309
  1626
dvander@309
  1627
			IPluginIterator *iter = GetPluginIterator();
dvander@309
  1628
			for (; iter->MorePlugins(); iter->NextPlugin(), id++)
dvander@309
  1629
			{
dvander@309
  1630
				IPlugin *pl = iter->GetPlugin();
dvander@309
  1631
				assert(pl->GetStatus() != Plugin_Created);
dvander@309
  1632
				int len = 0;
dvander@309
  1633
				const sm_plugininfo_t *info = pl->GetPublicInfo();
dvander@351
  1634
				if (pl->GetStatus() != Plugin_Running)
dvander@340
  1635
				{
dvander@340
  1636
					len += UTIL_Format(buffer, sizeof(buffer), "  %02d <%s>", id, GetStatusText(pl->GetStatus()));
dvander@340
  1637
				} else {
dvander@340
  1638
					len += UTIL_Format(buffer, sizeof(buffer), "  %02d", id);
dvander@340
  1639
				}
dvander@309
  1640
				len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " \"%s\"", (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());
dvander@309
  1641
				if (IS_STR_FILLED(info->version))
dvander@309
  1642
				{
dvander@309
  1643
					len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", info->version);
dvander@309
  1644
				}
dvander@309
  1645
				if (IS_STR_FILLED(info->author))
dvander@309
  1646
				{
dvander@309
  1647
					UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", info->author);
dvander@309
  1648
				}
dvander@309
  1649
				g_RootMenu.ConsolePrint("%s", buffer);
dvander@309
  1650
			}
dvander@309
  1651
dvander@309
  1652
			iter->Release();
dvander@309
  1653
			return;
dvander@309
  1654
		} else if (strcmp(cmd, "load") == 0) {
dvander@309
  1655
			if (argcount < 4)
dvander@309
  1656
			{
dvander@310
  1657
				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins load <file>");
dvander@309
  1658
				return;
dvander@309
  1659
			}
dvander@309
  1660
dvander@309
  1661
			char error[128];
faluco@383
  1662
			bool wasloaded;
dvander@309
  1663
			const char *filename = g_RootMenu.GetArgument(3);
ds@794
  1664
ds@794
  1665
			char pluginfile[256];
ds@794
  1666
			const char *ext = g_LibSys.GetFileExtension(filename) ? "" : ".smx";
ds@794
  1667
			UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", filename, ext);
ds@794
  1668
ds@794
  1669
			IPlugin *pl = LoadPlugin(pluginfile, false, PluginType_MapUpdated, error, sizeof(error), &wasloaded);
faluco@383
  1670
faluco@383
  1671
			if (wasloaded)
faluco@383
  1672
			{
ds@794
  1673
				g_RootMenu.ConsolePrint("[SM] Plugin %s is already loaded.", pluginfile);
faluco@383
  1674
				return;
faluco@383
  1675
			}
dvander@309
  1676
dvander@309
  1677
			if (pl)
dvander@309
  1678
			{
ds@794
  1679
				g_RootMenu.ConsolePrint("[SM] Loaded plugin %s successfully.", pluginfile);
dvander@309
  1680
			} else {
ds@794
  1681
				g_RootMenu.ConsolePrint("[SM] Plugin %s failed to load: %s.", pluginfile, error);
dvander@309
  1682
			}
dvander@309
  1683
dvander@309
  1684
			return;
dvander@309
  1685
		} else if (strcmp(cmd, "unload") == 0) {
dvander@309
  1686
			if (argcount < 4)
dvander@309
  1687
			{
dvander@310
  1688
				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins unload <#>");
dvander@309
  1689
				return;
dvander@309
  1690
			}
dvander@309
  1691
dvander@309
  1692
			int id = 1;
dvander@309
  1693
			int num = atoi(g_RootMenu.GetArgument(3));
dvander@309
  1694
			if (num < 1 || num > (int)GetPluginCount())
dvander@309
  1695
			{
dvander@310
  1696
				g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", num);
dvander@309
  1697
				return;
dvander@309
  1698
			}
dvander@309
  1699
dvander@309
  1700
			IPluginIterator *iter = GetPluginIterator();
dvander@309
  1701
			for (; iter->MorePlugins() && id<num; iter->NextPlugin(), id++)
dvander@309
  1702
				;
dvander@309
  1703
			IPlugin *pl = iter->GetPlugin();
dvander@309
  1704
ds@652
  1705
			char name[PLATFORM_MAX_PATH];
dvander@309
  1706
			const sm_plugininfo_t *info = pl->GetPublicInfo();
dvander@309
  1707
			strcpy(name, (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());
dvander@309
  1708
dvander@309
  1709
			if (UnloadPlugin(pl))
dvander@309
  1710
			{
dvander@310
  1711
				g_RootMenu.ConsolePrint("[SM] Plugin %s unloaded successfully.", name);
dvander@309
  1712
			} else {
dvander@310
  1713
				g_RootMenu.ConsolePrint("[SM] Failed to unload plugin %s.", name);
dvander@309
  1714
			}
dvander@309
  1715
dvander@309
  1716
			iter->Release();
dvander@309
  1717
			return;
dvander@309
  1718
		} else if (strcmp(cmd, "info") == 0) {
dvander@309
  1719
			if (argcount < 4)
dvander@309
  1720
			{
dvander@310
  1721
				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins info <#>");
dvander@309
  1722
				return;
dvander@309
  1723
			}
dvander@309
  1724
dvander@309
  1725
			int num = atoi(g_RootMenu.GetArgument(3));
dvander@309
  1726
			if (num < 1 || num > (int)GetPluginCount())
dvander@309
  1727
			{
dvander@310
  1728
				g_RootMenu.ConsolePrint("[SM] Plugin index not found.");
dvander@309
  1729
				return;
dvander@309
  1730
			}
dvander@309
  1731
dvander@315
  1732
			CPlugin *pl = GetPluginByOrder(num);
dvander@309
  1733
			const sm_plugininfo_t *info = pl->GetPublicInfo();
dvander@309
  1734
dvander@309
  1735
			g_RootMenu.ConsolePrint("  Filename: %s", pl->GetFilename());
dvander@315
  1736
			if (pl->GetStatus() <= Plugin_Error)
dvander@309
  1737
			{
dvander@315
  1738
				if (IS_STR_FILLED(info->name))
dvander@315
  1739
				{
dvander@605
  1740
					if (IS_STR_FILLED(info->description))
dvander@605
  1741
					{
dvander@605
  1742
						g_RootMenu.ConsolePrint("  Title: %s (%s)", info->name, info->description);
dvander@605
  1743
					} else {
dvander@605
  1744
						g_RootMenu.ConsolePrint("  Title: %s", info->name);
dvander@605
  1745
					}
dvander@605
  1746
				}
dvander@605
  1747
				if (IS_STR_FILLED(info->author))
dvander@605
  1748
				{
dvander@605
  1749
					g_RootMenu.ConsolePrint("  Author: %s", info->author);
dvander@315
  1750
				}
dvander@315
  1751
				if (IS_STR_FILLED(info->version))
dvander@315
  1752
				{
dvander@315
  1753
					g_RootMenu.ConsolePrint("  Version: %s", info->version);
dvander@315
  1754
				}
dvander@315
  1755
				if (IS_STR_FILLED(info->url))
dvander@315
  1756
				{
dvander@315
  1757
					g_RootMenu.ConsolePrint("  URL: %s", info->url);
dvander@315
  1758
				}
dvander@605
  1759
				if (pl->GetStatus() == Plugin_Error)
dvander@315
  1760
				{
dvander@605
  1761
					g_RootMenu.ConsolePrint("  Error: %s", pl->m_errormsg);
dvander@605
  1762
				} else {
dvander@605
  1763
					g_RootMenu.ConsolePrint("  Debugging: %s", pl->IsDebugging() ? "yes" : "no");
dvander@605
  1764
					g_RootMenu.ConsolePrint("  Running: %s", pl->GetStatus() == Plugin_Running ? "yes" : "no");
dvander@315
  1765
				}
dvander@315
  1766
			} else {
dvander@315
  1767
				g_RootMenu.ConsolePrint("  Load error: %s", pl->m_errormsg);
dvander@315
  1768
				g_RootMenu.ConsolePrint("  File info: (title \"%s\") (version \"%s\")", 
dvander@315
  1769
										info->name ? info->name : "<none>",
dvander@315
  1770
										info->version ? info->version : "<none>");
dvander@315
  1771
				if (IS_STR_FILLED(info->url))
dvander@315
  1772
				{
dvander@315
  1773
					g_RootMenu.ConsolePrint("  File URL: %s", info->url);
dvander@315
  1774
				}
dvander@309
  1775
			}
dvander@309
  1776
dvander@309
  1777
			return;
dvander@309
  1778
		} else if (strcmp(cmd, "debug") == 0) {
dvander@309
  1779
			if (argcount < 5)
dvander@309
  1780
			{
dvander@310
  1781
				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins debug <#> [on|off]");
dvander@309
  1782
				return;
dvander@309
  1783
			}
dvander@309
  1784
dvander@309
  1785
			int num = atoi(g_RootMenu.GetArgument(3));
dvander@309
  1786
			if (num < 1 || num > (int)GetPluginCount())
dvander@309
  1787
			{
dvander@310
  1788
				g_RootMenu.ConsolePrint("[SM] Plugin index not found.");
dvander@309
  1789
				return;
dvander@309
  1790
			}
dvander@309
  1791
dvander@309
  1792
			int res;
dvander@309
  1793
			const char *mode = g_RootMenu.GetArgument(4);
dvander@309
  1794
			if ((res=strcmp("on", mode)) && strcmp("off", mode))
dvander@309
  1795
			{
dvander@310
  1796
				g_RootMenu.ConsolePrint("[SM] The only possible options are \"on\" and \"off.\"");
dvander@309
  1797
				return;
dvander@309
  1798
			}
dvander@309
  1799
dvander@309
  1800
			bool debug;
dvander@309
  1801
			if (!res)
dvander@309
  1802
			{
dvander@309
  1803
				debug = true;
dvander@309
  1804
			} else {
dvander@309
  1805
				debug = false;
dvander@309
  1806
			}
dvander@309
  1807
dvander@309
  1808
			CPlugin *pl = GetPluginByOrder(num);
dvander@309
  1809
			if (debug && pl->IsDebugging())
dvander@309
  1810
			{
dvander@309
  1811
				g_RootMenu.ConsolePrint("[SM] This plugin is already in debug mode.");
dvander@309
  1812
				return;
dvander@309
  1813
			} else if (!debug && !pl->IsDebugging()) {
dvander@309
  1814
				g_RootMenu.ConsolePrint("[SM] Debug mode is already disabled in this plugin.");
dvander@309
  1815
				return;
dvander@309
  1816
			}
dvander@309
  1817
dvander@309
  1818
			char error[256];
dvander@309
  1819
			if (pl->ToggleDebugMode(debug, error, sizeof(error)))
dvander@309
  1820
			{
dvander@310
  1821
				g_RootMenu.ConsolePrint("[SM] Successfully toggled debug mode on plugin %s.", pl->GetFilename());
dvander@309
  1822
				return;
dvander@309
  1823
			} else {
dvander@309
  1824
				g_RootMenu.ConsolePrint("[SM] Could not toggle debug mode on plugin %s.", pl->GetFilename());
dvander@309
  1825
				g_RootMenu.ConsolePrint("[SM] Plugin returned error: %s", error);
dvander@309
  1826
				return;
dvander@309
  1827
			}
dvander@309
  1828
		}
dvander@309
  1829
	}
dvander@309
  1830
dvander@309
  1831
	/* Draw the main menu */
dvander@309
  1832
	g_RootMenu.ConsolePrint("SourceMod Plugins Menu:");
dvander@309
  1833
	g_RootMenu.DrawGenericOption("list", "Show loaded plugins");
dvander@309
  1834
	g_RootMenu.DrawGenericOption("load", "Load a plugin");
dvander@309
  1835
	g_RootMenu.DrawGenericOption("unload", "Unload a plugin");
dvander@309
  1836
	g_RootMenu.DrawGenericOption("info", "Information about a plugin");
dvander@309
  1837
	g_RootMenu.DrawGenericOption("debug", "Toggle debug mode on a plugin");
dvander@309
  1838
}
faluco@333
  1839
faluco@333
  1840
void CPluginManager::ReloadOrUnloadPlugins()
faluco@333
  1841
{
faluco@333
  1842
	List<CPlugin *>::iterator iter;
faluco@333
  1843
	List<CPlugin *> tmp_list = m_plugins;
faluco@333
  1844
	CPlugin *pl;
faluco@333
  1845
	time_t t;
faluco@333
  1846
faluco@333
  1847
	for (iter=tmp_list.begin(); iter!=tmp_list.end(); iter++)
faluco@333
  1848
	{
faluco@333
  1849
		pl = (*iter);
faluco@333
  1850
		if (pl->GetType() ==  PluginType_MapOnly)
faluco@333
  1851
		{
faluco@333
  1852
			UnloadPlugin((IPlugin *)pl);
faluco@333
  1853
		} else if (pl->GetType() == PluginType_MapUpdated) {
dvander@450
  1854
			t = pl->GetFileTimeStamp();
dvander@450
  1855
			if (!t || t > pl->GetTimeStamp())
faluco@333
  1856
			{
faluco@333
  1857
				pl->SetTimeStamp(t);
faluco@333
  1858
				UnloadPlugin((IPlugin *)pl);
faluco@333
  1859
			}
faluco@333
  1860
		}
faluco@333
  1861
	}
faluco@333
  1862
}
faluco@430
  1863
faluco@430
  1864
void CPluginManager::_SetPauseState(CPlugin *pl, bool paused)
faluco@430
  1865
{
faluco@430
  1866
	List<IPluginsListener *>::iterator iter;
faluco@430
  1867
	IPluginsListener *pListener;
faluco@430
  1868
	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)
faluco@430
  1869
	{
faluco@430
  1870
		pListener = (*iter);
faluco@430
  1871
		pListener->OnPluginPauseChange(pl, paused);
faluco@430
  1872
	}	
dvander@464
  1873
}
dvander@464
  1874
dvander@601
  1875
bool CPluginManager::AddFakeNative(IPluginFunction *pFunction, const char *name, SPVM_FAKENATIVE_FUNC func)
dvander@601
  1876
{
dvander@601
  1877
	if (sm_trie_retrieve(m_pNativeLookup, name, NULL))
dvander@601
  1878
	{
dvander@601
  1879
		return false;
dvander@601
  1880
	}
dvander@601
  1881
dvander@601
  1882
	FakeNative *pNative = new FakeNative;
dvander@601
  1883
dvander@601
  1884
	pNative->func = g_pVM->CreateFakeNative(func, pNative);
dvander@601
  1885
	if (!pNative->func)
dvander@601
  1886
	{
dvander@601
  1887
		delete pNative;
dvander@601
  1888
		return false;
dvander@601
  1889
	}
dvander@601
  1890
dvander@601
  1891
	pNative->call = pFunction;
dvander@601
  1892
	pNative->name.assign(name);
dvander@601
  1893
	pNative->ctx = pFunction->GetParentContext();
dvander@601
  1894
dvander@601
  1895
	m_Natives.push_back(pNative);
dvander@601
  1896
	sm_trie_insert(m_pNativeLookup, name,pNative);
dvander@601
  1897
dvander@605
  1898
	CPlugin *pPlugin = GetPluginByCtx(pNative->ctx->GetContext());
dvander@605
  1899
	pPlugin->m_fakeNatives.push_back(pNative);
dvander@605
  1900
dvander@601
  1901
	return true;
dvander@601
  1902
}
ds@611
  1903
ds@611
  1904
void CPluginManager::AddFunctionsToForward(const char *name, IChangeableForward *pForward)
ds@611
  1905
{
ds@611
  1906
	List<CPlugin *>::iterator iter;
ds@611
  1907
	CPlugin *pPlugin;
ds@611
  1908
	IPluginFunction *pFunction;
ds@611
  1909
ds@611
  1910
	for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++)
ds@611
  1911
	{
ds@611
  1912
		pPlugin = (*iter);
ds@611
  1913
ds@611
  1914
		if (pPlugin->GetStatus() <= Plugin_Paused)
ds@611
  1915
		{
ds@611
  1916
			pFunction = pPlugin->GetBaseContext()->GetFunctionByName(name);
ds@611
  1917
ds@611
  1918
			if (pFunction)
ds@611
  1919
			{
ds@611
  1920
				pForward->AddFunction(pFunction);
ds@611
  1921
			}
ds@611
  1922
		}
ds@611
  1923
	}
ds@611
  1924
}