sourcemod-central: core/PluginSys.cpp@472f27784e9b

     1 /**

     2  * vim: set ts=4 :

     3  * =============================================================================

     4  * SourceMod

     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.

     6  * =============================================================================

     7  *

     8  * This program is free software; you can redistribute it and/or modify it under

     9  * the terms of the GNU General Public License, version 3.0, as published by the

    10  * Free Software Foundation.

    11  *

    12  * This program is distributed in the hope that it will be useful, but WITHOUT

    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more

    15  * details.

    16  *

    17  * You should have received a copy of the GNU General Public License along with

    18  * this program.  If not, see <http://www.gnu.org/licenses/>.

    19  *

    20  * As a special exception, AlliedModders LLC gives you permission to link the

    21  * code of this program (as well as its derivative works) to "Half-Life 2," the

    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software

    23  * by the Valve Corporation.  You must obey the GNU General Public License in

    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants

    25  * this exception to all derivative works.  AlliedModders LLC defines further

    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),

    27  * or <http://www.sourcemod.net/license.php>.

    28  *

    29  * Version: $Id$

    30  */

    32 #include <stdio.h>

    33 #include "PluginSys.h"

    34 #include "ShareSys.h"

    35 #include "LibrarySys.h"

    36 #include "HandleSys.h"

    37 #include "ForwardSys.h"

    38 #include "sourcemm_api.h"

    39 #include "sourcemod.h"

    40 #include "Logger.h"

    41 #include "ExtensionSys.h"

    42 #include "sm_srvcmds.h"

    43 #include "sm_stringutil.h"

    44 #include "ConCmdManager.h"

    45 #include "PlayerManager.h"

    46 #include "CoreConfig.h"

    47 #include "Translator.h"

    49 CPluginManager g_PluginSys;

    50 HandleType_t g_PluginType = 0;

    51 IdentityType_t g_PluginIdent = 0;

    53 CPlugin::CPlugin(const char *file)

    54 {

    55 	static int MySerial = 0;

    57 	m_type = PluginType_Private;

    58 	m_status = Plugin_Uncompiled;

    59 	m_bSilentlyFailed = false;

    60 	m_serial = ++MySerial;

    61 	m_pRuntime = NULL;

    62 	m_errormsg[256] = '\0';

    63 	snprintf(m_filename, sizeof(m_filename), "%s", file);

    64 	m_handle = 0;

    65 	m_ident = NULL;

    66 	m_pProps = sm_trie_create();

    67 	m_FakeNativesMissing = false;

    68 	m_LibraryMissing = false;

    69 	m_bGotAllLoaded = false;

    70 	m_pPhrases = g_Translator.CreatePhraseCollection();

    71 	m_MaxClientsVar = NULL;

    72 }

    74 CPlugin::~CPlugin()

    75 {

    76 	if (m_handle)

    77 	{

    78 		HandleSecurity sec;

    79 		sec.pOwner = g_PluginSys.GetIdentity();

    80 		sec.pIdentity = sec.pOwner;

    82 		g_HandleSys.FreeHandle(m_handle, &sec);

    83 		g_ShareSys.DestroyIdentity(m_ident);

    84 	}

    86 	if (m_pRuntime != NULL)

    87 	{

    88 		delete m_pRuntime;

    89 		m_pRuntime = NULL;

    90 	}

    92 	if (m_pProps)

    93 	{

    94 		sm_trie_destroy(m_pProps);

    95 	}

    96 	for (size_t i=0; i<m_configs.size(); i++)

    97 	{

    98 		delete m_configs[i];

    99 	}

   100 	m_configs.clear();

   101 	if (m_pPhrases != NULL)

   102 	{

   103 		m_pPhrases->Destroy();

   104 		m_pPhrases = NULL;

   105 	}

   106 }

   108 void CPlugin::InitIdentity()

   109 {

   110 	if (!m_handle)

   111 	{

   112 		m_ident = g_ShareSys.CreateIdentity(g_PluginIdent, this);

   113 		m_handle = g_HandleSys.CreateHandle(g_PluginType, this, g_PluginSys.GetIdentity(), g_PluginSys.GetIdentity(), NULL);

   114 		m_pRuntime->GetDefaultContext()->SetKey(1, m_ident);

   115 		m_pRuntime->GetDefaultContext()->SetKey(2, (IPlugin *)this);

   116 	}

   117 }

   119 unsigned int CPlugin::CalcMemUsage()

   120 {

   121 	unsigned int base_size =

   122 		sizeof(CPlugin)

   123 		+ sizeof(IdentityToken_t)

   124 		+ (m_configs.size() * (sizeof(AutoConfig *) + sizeof(AutoConfig)))

   125 		+ sm_trie_mem_usage(m_pProps);

   127 	for (unsigned int i = 0; i < m_configs.size(); i++)

   128 	{

   129 		base_size += m_configs[i]->autocfg.size();

   130 		base_size += m_configs[i]->folder.size();

   131 	}

   133 	for (List<String>::iterator i = m_Libraries.begin();

   134 		 i != m_Libraries.end();

   135 		 i++)

   136 	{

   137 		base_size += (*i).size();

   138 	}

   140 	for (List<String>::iterator i = m_RequiredLibs.begin();

   141 		 i != m_RequiredLibs.end();

   142 		 i++)

   143 	{

   144 		base_size += (*i).size();

   145 	}

   147 	return base_size;

   148 }

   150 Handle_t CPlugin::GetMyHandle()

   151 {

   152 	return m_handle;

   153 }

   155 CPlugin *CPlugin::CreatePlugin(const char *file, char *error, size_t maxlength)

   156 {

   157 	char fullpath[PLATFORM_MAX_PATH];

   158 	g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", file);

   159 	FILE *fp = fopen(fullpath, "rb");

   161 	CPlugin *pPlugin = new CPlugin(file);

   163 	if (!fp)

   164 	{

   165 		if (error)

   166 		{

   167 			snprintf(error, maxlength, "Unable to open file");

   168 		}

   169 		pPlugin->m_status = Plugin_BadLoad;

   170 		return pPlugin;

   171 	}

   173 	fclose(fp);

   175 	return pPlugin;

   176 }

   178 bool CPlugin::GetProperty(const char *prop, void **ptr, bool remove/* =false */)

   179 {

   180 	bool exists = sm_trie_retrieve(m_pProps, prop, ptr);

   182 	if (exists && remove)

   183 	{

   184 		sm_trie_delete(m_pProps, prop);

   185 	}

   187 	return exists;

   188 }

   190 bool CPlugin::SetProperty(const char *prop, void *ptr)

   191 {

   192 	return sm_trie_insert(m_pProps, prop, ptr);

   193 }

   195 IPluginRuntime *CPlugin::GetRuntime()

   196 {

   197 	return m_pRuntime;

   198 }

   200 void CPlugin::SetErrorState(PluginStatus status, const char *error_fmt, ...)

   201 {

   202 	PluginStatus old_status = m_status;

   203 	m_status = status;

   205 	if (old_status == Plugin_Running)

   206 	{

   207 		/* Tell everyone we're now paused */

   208 		g_PluginSys._SetPauseState(this, true);

   209 	}

   211 	va_list ap;

   212 	va_start(ap, error_fmt);

   213 	vsnprintf(m_errormsg, sizeof(m_errormsg), error_fmt, ap);

   214 	va_end(ap);

   216 	if (m_pRuntime != NULL)

   217 	{

   218 		m_pRuntime->SetPauseState(true);

   219 	}

   220 }

   222 bool CPlugin::UpdateInfo()

   223 {

   224 	/* Now grab the info */

   225 	uint32_t idx;

   226 	IPluginContext *base = GetBaseContext();

   227 	int err = base->FindPubvarByName("myinfo", &idx);

   229 	memset(&m_info, 0, sizeof(m_info));

   231 	if (err == SP_ERROR_NONE)

   232 	{

   233 		struct sm_plugininfo_c_t

   234 		{

   235 			cell_t name;

   236 			cell_t description;

   237 			cell_t author;

   238 			cell_t version;

   239 			cell_t url;

   240 		};

   241 		sm_plugininfo_c_t *cinfo;

   242 		cell_t local_addr;

   244 		base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&cinfo);

   245 		base->LocalToString(cinfo->name, (char **)&m_info.name);

   246 		base->LocalToString(cinfo->description, (char **)&m_info.description);

   247 		base->LocalToString(cinfo->author, (char **)&m_info.author);

   248 		base->LocalToString(cinfo->url, (char **)&m_info.url);

   249 		base->LocalToString(cinfo->version, (char **)&m_info.version);

   250 	}

   252 	m_info.author = m_info.author ? m_info.author : "";

   253 	m_info.description = m_info.description ? m_info.description : "";

   254 	m_info.name = m_info.name ? m_info.name : "";

   255 	m_info.url = m_info.url ? m_info.url : "";

   256 	m_info.version = m_info.version ? m_info.version : "";

   258 	if ((err = base->FindPubvarByName("__version", &idx)) == SP_ERROR_NONE)

   259 	{

   260 		struct __version_info

   261 		{

   262 			cell_t version;

   263 			cell_t filevers;

   264 			cell_t date;

   265 			cell_t time;

   266 		};

   267 		__version_info *info;

   268 		cell_t local_addr;

   269 		const char *pDate, *pTime, *pFileVers;

   271 		pDate = "";

   272 		pTime = "";

   274 		base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&info);

   275 		m_FileVersion = info->version;

   276 		if (m_FileVersion >= 4)

   277 		{

   278 			base->LocalToString(info->date, (char **)&pDate);

   279 			base->LocalToString(info->time, (char **)&pTime);

   280 			UTIL_Format(m_DateTime, sizeof(m_DateTime), "%s %s", pDate, pTime);

   281 		}

   282 		if (m_FileVersion > 5)

   283 		{

   284 			base->LocalToString(info->filevers, (char **)&pFileVers);

   285 			SetErrorState(Plugin_Failed, "Newer SourceMod required (%s or higher)", pFileVers);

   286 			return false;

   287 		}

   288 	}

   289 	else

   290 	{

   291 		m_FileVersion = 0;

   292 	}

   294 	if ((err = base->FindPubvarByName("MaxClients", &idx)) == SP_ERROR_NONE)

   295 	{

   296 		base->GetPubvarByIndex(idx, &m_MaxClientsVar);

   297 	}

   299 	return true;

   300 }

   302 void CPlugin::SyncMaxClients(int max_clients)

   303 {

   304 	if (m_MaxClientsVar == NULL)

   305 	{

   306 		return;

   307 	}

   309 	*m_MaxClientsVar->offs = max_clients;

   310 }

   312 void CPlugin::Call_OnPluginStart()

   313 {

   314 	if (m_status != Plugin_Loaded)

   315 	{

   316 		return;

   317 	}

   319 	m_status = Plugin_Running;

   321 	SyncMaxClients(g_Players.MaxClients());

   323 	cell_t result;

   324 	IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginStart");

   325 	if (!pFunction)

   326 	{

   327 		return;

   328 	}

   330 	int err;

   331 	if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE)

   332 	{

   333 		SetErrorState(Plugin_Error, "Error detected in plugin startup (see error logs)");

   334 	}

   335 }

   337 void CPlugin::Call_OnPluginEnd()

   338 {

   339 	if (m_status > Plugin_Paused)

   340 	{

   341 		return;

   342 	}

   344 	cell_t result;

   345 	IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginEnd");

   346 	if (!pFunction)

   347 	{

   348 		return;

   349 	}

   351 	pFunction->Execute(&result);

   352 }

   354 void CPlugin::Call_OnAllPluginsLoaded()

   355 {

   356 	if (m_status > Plugin_Paused)

   357 	{

   358 		return;

   359 	}

   361 	if (m_bGotAllLoaded)

   362 	{

   363 		return;

   364 	}

   366 	m_bGotAllLoaded = true;

   368 	cell_t result;

   369 	IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnAllPluginsLoaded");

   370 	if (pFunction != NULL)

   371 	{

   372 		pFunction->Execute(&result);

   373 	}

   375 	if (g_OnMapStarted)

   376 	{

   377 		if ((pFunction = m_pRuntime->GetFunctionByName("OnMapStart")) != NULL)

   378 		{

   379 			pFunction->Execute(NULL);

   380 		}

   381 	}

   383 	if (SM_AreConfigsExecuted())

   384 	{

   385 		SM_ExecuteForPlugin(GetBaseContext());

   386 	}

   387 }

   389 APLRes CPlugin::Call_AskPluginLoad(char *error, size_t maxlength)

   390 {

   391 	if (m_status != Plugin_Created)

   392 	{

   393 		return APLRes_Failure;

   394 	}

   396 	m_status = Plugin_Loaded;

   398 	int err;

   399 	cell_t result;

   400 	bool haveNewAPL = false;

   401 	IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("AskPluginLoad2");

   403 	if (pFunction)

   404 	{

   405 		haveNewAPL = true;

   406 	}

   407 	else if (!(pFunction = m_pRuntime->GetFunctionByName("AskPluginLoad")))

   408 	{

   409 		return APLRes_Success;

   410 	}

   412 	pFunction->PushCell(m_handle);

   413 	pFunction->PushCell(g_PluginSys.IsLateLoadTime() ? 1 : 0);

   414 	pFunction->PushStringEx(error, maxlength, 0, SM_PARAM_COPYBACK);

   415 	pFunction->PushCell(maxlength);

   416 	if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE)

   417 	{

   418 		return APLRes_Failure;

   419 	}

   421 	if (haveNewAPL)

   422 	{

   423 		return (APLRes)result;

   424 	}

   425 	else if (result)

   426 	{

   427 		return APLRes_Success;

   428 	}

   429 	else

   430 	{

   431 		return APLRes_Failure;

   432 	}

   433 }

   435 void *CPlugin::GetPluginStructure()

   436 {

   437 	return NULL;

   438 }

   440 IPluginContext *CPlugin::GetBaseContext()

   441 {

   442 	if (m_pRuntime == NULL)

   443 	{

   444 		return NULL;

   445 	}

   447 	return m_pRuntime->GetDefaultContext();

   448 }

   450 sp_context_t *CPlugin::GetContext()

   451 {

   452 	return NULL;

   453 }

   455 const char *CPlugin::GetFilename()

   456 {

   457 	return m_filename;

   458 }

   460 PluginType CPlugin::GetType()

   461 {

   462 	return m_type;

   463 }

   465 const sm_plugininfo_t *CPlugin::GetPublicInfo()

   466 {

   467 	if (GetStatus() >= Plugin_Created)

   468 	{

   469 		return NULL;

   470 	}

   471 	return &m_info;

   472 }

   474 unsigned int CPlugin::GetSerial()

   475 {

   476 	return m_serial;

   477 }

   479 PluginStatus CPlugin::GetStatus()

   480 {

   481 	return m_status;

   482 }

   484 bool CPlugin::IsSilentlyFailed()

   485 {

   486 	return m_bSilentlyFailed;

   487 }

   489 bool CPlugin::IsDebugging()

   490 {

   491 	if (m_pRuntime == NULL)

   492 	{

   493 		return false;

   494 	}

   496 	return true;

   497 }

   499 void CPlugin::SetSilentlyFailed(bool sf)

   500 {

   501 	m_bSilentlyFailed = sf;

   502 }

   504 void CPlugin::LibraryActions(bool dropping)

   505 {

   506 	List<String>::iterator iter;

   507 	for (iter = m_Libraries.begin();

   508 		iter != m_Libraries.end();

   509 		iter++)

   510 	{

   511 		g_PluginSys.OnLibraryAction((*iter).c_str(), true, dropping);

   512 	}

   513 }

   515 bool CPlugin::SetPauseState(bool paused)

   516 {

   517 	if (paused && GetStatus() != Plugin_Running)

   518 	{

   519 		return false;

   520 	} else if (!paused && GetStatus() != Plugin_Paused) {

   521 		return false;

   522 	}

   524 	if (paused)

   525 	{

   526 		LibraryActions(true);

   527 	}

   529 	IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginPauseChange");

   530 	if (pFunction)

   531 	{

   532 		cell_t result;

   533 		pFunction->PushCell(paused ? 1 : 0);

   534 		pFunction->Execute(&result);

   535 	}

   537 	if (paused)

   538 	{

   539 		m_status = Plugin_Paused;

   540 		m_pRuntime->SetPauseState(true);

   541 	} else {

   542 		m_status = Plugin_Running;

   543 		m_pRuntime->SetPauseState(false);

   544 	}

   546 	g_PluginSys._SetPauseState(this, paused);

   548 	if (!paused)

   549 	{

   550 		LibraryActions(false);

   551 	}

   553 	return true;

   554 }

   556 IdentityToken_t *CPlugin::GetIdentity()

   557 {

   558 	return m_ident;

   559 }

   561 bool CPlugin::IsRunnable()

   562 {

   563 	return (m_status <= Plugin_Paused) ? true : false;

   564 }

   566 time_t CPlugin::GetFileTimeStamp()

   567 {

   568 	char path[PLATFORM_MAX_PATH];

   569 	g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "plugins/%s", m_filename);

   570 #ifdef PLATFORM_WINDOWS

   571 	struct _stat s;

   572 	if (_stat(path, &s) != 0)

   573 #elif defined PLATFORM_POSIX

   574 	struct stat s;

   575 	if (stat(path, &s) != 0)

   576 #endif

   577 	{

   578 		return 0;

   579 	}

   580 	else

   581 	{

   582 		return s.st_mtime;

   583 	}

   584 }

   586 time_t CPlugin::GetTimeStamp()

   587 {

   588 	return m_LastAccess;

   589 }

   591 void CPlugin::SetTimeStamp(time_t t)

   592 {

   593 	m_LastAccess = t;

   594 }

   596 IPhraseCollection *CPlugin::GetPhrases()

   597 {

   598 	return m_pPhrases;

   599 }

   601 void CPlugin::DependencyDropped(CPlugin *pOwner)

   602 {

   603 	if (!m_pRuntime)

   604 	{

   605 		return;

   606 	}

   608 	List<String>::iterator reqlib_iter;

   609 	List<String>::iterator lib_iter;

   610 	for (lib_iter=pOwner->m_Libraries.begin(); lib_iter!=pOwner->m_Libraries.end(); lib_iter++)

   611 	{

   612 		for (reqlib_iter=m_RequiredLibs.begin(); reqlib_iter!=m_RequiredLibs.end(); reqlib_iter++)

   613 		{

   614 			if ((*reqlib_iter) == (*lib_iter))

   615 			{

   616 				m_LibraryMissing = true;

   617 			}

   618 		}

   619 	}

   621 	List<NativeEntry *>::iterator iter;

   622 	NativeEntry *pNative;

   623 	sp_native_t *native;

   624 	uint32_t idx;

   625 	unsigned int unbound = 0;

   627 	for (iter = pOwner->m_Natives.begin();

   628 		 iter != pOwner->m_Natives.end();

   629 		 iter++)

   630 	{

   631 		pNative = (*iter);

   632 		/* Find this native! */

   633 		if (m_pRuntime->FindNativeByName(pNative->name, &idx) != SP_ERROR_NONE)

   634 		{

   635 			continue;

   636 		}

   637 		/* Unbind it */

   638 		m_pRuntime->GetNativeByIndex(idx, &native);

   639 		native->pfn = NULL;

   640 		native->status = SP_NATIVE_UNBOUND;

   641 		unbound++;

   642 	}

   644 	if (unbound)

   645 	{

   646 		m_FakeNativesMissing = true;

   647 	}

   649 	/* :IDEA: in the future, add native trapping? */

   650 	if (m_FakeNativesMissing || m_LibraryMissing)

   651 	{

   652 		SetErrorState(Plugin_Error, "Depends on plugin: %s", pOwner->GetFilename());

   653 	}

   654 }

   656 unsigned int CPlugin::GetConfigCount()

   657 {

   658 	return (unsigned int)m_configs.size();

   659 }

   661 AutoConfig *CPlugin::GetConfig(unsigned int i)

   662 {

   663 	if (i >= GetConfigCount())

   664 	{

   665 		return NULL;

   666 	}

   668 	return m_configs[i];

   669 }

   671 void CPlugin::AddConfig(bool autoCreate, const char *cfg, const char *folder)

   672 {

   673 	/* Do a check for duplicates to prevent double-execution */

   674 	for (size_t i = 0; i < m_configs.size(); i++)

   675 	{

   676 		if (m_configs[i]->autocfg.compare(cfg) == 0

   677 			&& m_configs[i]->folder.compare(folder) == 0

   678 			&& m_configs[i]->create == autoCreate)

   679 		{

   680 			return;

   681 		}

   682 	}

   684 	AutoConfig *c = new AutoConfig;

   686 	c->autocfg = cfg;

   687 	c->folder = folder;

   688 	c->create = autoCreate;

   690 	m_configs.push_back(c);

   691 }

   693 void CPlugin::DropEverything()

   694 {

   695 	CPlugin *pOther;

   696 	List<CPlugin *>::iterator iter;

   697 	List<WeakNative>::iterator wk_iter;

   699 	/* Tell everyone that depends on us that we're about to drop */

   700 	for (iter = m_Dependents.begin();

   701 		 iter != m_Dependents.end();

   702 		 iter++)

   703 	{

   704 		pOther = (*iter);

   705 		pOther->DependencyDropped(this);

   706 	}

   708 	/* Note: we don't care about things we depend on.

   709 	 * The reason is that extensions have their own cleanup

   710 	 * code for plugins.  Although the "right" design would be

   711 	 * to centralize that here, i'm omitting it for now.  Thus,

   712 	 * the code below to walk the plugins list will suffice.

   713 	 */

   715 	/* Other plugins could be holding weak references that were

   716 	 * added by us.  We need to clean all of those up now.

   717 	 */

   718 	for (iter = g_PluginSys.m_plugins.begin();

   719 		 iter != g_PluginSys.m_plugins.end();

   720 		 iter++)

   721 	{

   722 		(*iter)->DropRefsTo(this);

   723 	}

   725 	/* Proceed with the rest of the necessities. */

   726 	CNativeOwner::DropEverything();

   727 }

   729 bool CPlugin::AddFakeNative(IPluginFunction *pFunc, const char *name, SPVM_FAKENATIVE_FUNC func)

   730 {

   731 	NativeEntry *pEntry;

   733 	if ((pEntry = g_ShareSys.AddFakeNative(pFunc, name, func)) == NULL)

   734 	{

   735 		return false;

   736 	}

   738 	m_Natives.push_back(pEntry);

   740 	return true;

   741 }

   743 /*******************

   744  * PLUGIN ITERATOR *

   745  *******************/

   747 CPluginManager::CPluginIterator::CPluginIterator(List<CPlugin *> *_mylist)

   748 {

   749 	mylist = _mylist;

   750 	Reset();

   751 }

   753 IPlugin *CPluginManager::CPluginIterator::GetPlugin()

   754 {

   755 	return (*current);

   756 }

   758 bool CPluginManager::CPluginIterator::MorePlugins()

   759 {

   760 	return (current != mylist->end());

   761 }

   763 void CPluginManager::CPluginIterator::NextPlugin()

   764 {

   765 	current++;

   766 }

   768 void CPluginManager::CPluginIterator::Release()

   769 {

   770 	g_PluginSys.ReleaseIterator(this);

   771 }

   773 CPluginManager::CPluginIterator::~CPluginIterator()

   774 {

   775 }

   777 void CPluginManager::CPluginIterator::Reset()

   778 {

   779 	current = mylist->begin();

   780 }

   782 /******************

   783  * PLUGIN MANAGER *

   784  ******************/

   786 CPluginManager::CPluginManager()

   787 {

   788 	m_LoadLookup = sm_trie_create();

   789 	m_AllPluginsLoaded = false;

   790 	m_MyIdent = NULL;

   791 	m_LoadingLocked = false;

   792 }

   794 CPluginManager::~CPluginManager()

   795 {

   796 	/* :NOTICE:

   797 	 * Ignore the fact that there might be plugins in the cache.

   798 	 * This usually means that Core is not being unloaded properly, and everything

   799 	 * will crash anyway.  YAY

   800 	 */

   801 	sm_trie_destroy(m_LoadLookup);

   803 	CStack<CPluginManager::CPluginIterator *>::iterator iter;

   804 	for (iter=m_iters.begin(); iter!=m_iters.end(); iter++)

   805 	{

   806 		delete (*iter);

   807 	}

   808 	m_iters.popall();

   809 }

   811 void CPluginManager::Shutdown()

   812 {

   813 	List<CPlugin *>::iterator iter;

   815 	while ((iter = m_plugins.begin()) != m_plugins.end())

   816 	{

   817 		UnloadPlugin(*iter);

   818 	}

   819 }

   821 void CPluginManager::LoadAll_FirstPass(const char *config, const char *basedir)

   822 {

   823 	/* First read in the database of plugin settings */

   824 	SMCError err;

   825 	SMCStates states;

   826 	m_AllPluginsLoaded = false;

   827 	if ((err=textparsers->ParseFile_SMC(config, &m_PluginInfo, &states)) != SMCError_Okay)

   828 	{

   829 		g_Logger.LogError("[SM] Encountered fatal error parsing file \"%s\"", config);

   830 		const char *err_msg = textparsers->GetSMCErrorString(err);

   831 		if (err_msg)

   832 		{

   833 			g_Logger.LogError("[SM] Parse error encountered: \"%s\"", err_msg);

   834 		}

   835 	}

   837 	LoadPluginsFromDir(basedir, NULL);

   838 }

   840 void CPluginManager::LoadPluginsFromDir(const char *basedir, const char *localpath)

   841 {

   842 	char base_path[PLATFORM_MAX_PATH];

   844 	/* Form the current path to start reading from */

   845 	if (localpath == NULL)

   846 	{

   847 		g_LibSys.PathFormat(base_path, sizeof(base_path), "%s", basedir);

   848 	} else {

   849 		g_LibSys.PathFormat(base_path, sizeof(base_path), "%s/%s", basedir, localpath);

   850 	}

   852 	IDirectory *dir = g_LibSys.OpenDirectory(base_path);

   854 	if (!dir)

   855 	{

   856 		char error[256];

   857 		g_LibSys.GetPlatformError(error, sizeof(error));

   858 		g_Logger.LogError("[SM] Failure reading from plugins path: %s", localpath);

   859 		g_Logger.LogError("[SM] Platform returned error: %s", error);

   860 		return;

   861 	}

   863 	while (dir->MoreFiles())

   864 	{

   865 		if (dir->IsEntryDirectory()

   866 			&& (strcmp(dir->GetEntryName(), ".") != 0)

   867 			&& (strcmp(dir->GetEntryName(), "..") != 0)

   868 			&& (strcmp(dir->GetEntryName(), "disabled") != 0)

   869 			&& (strcmp(dir->GetEntryName(), "optional") != 0))

   870 		{

   871 			char new_local[PLATFORM_MAX_PATH];

   872 			if (localpath == NULL)

   873 			{

   874 				/* If no path yet, don't add a former slash */

   875 				snprintf(new_local, sizeof(new_local), "%s", dir->GetEntryName());

   876 			} else {

   877 				g_LibSys.PathFormat(new_local, sizeof(new_local), "%s/%s", localpath, dir->GetEntryName());

   878 			}

   879 			LoadPluginsFromDir(basedir, new_local);

   880 		} else if (dir->IsEntryFile()) {

   881 			const char *name = dir->GetEntryName();

   882 			size_t len = strlen(name);

   883 			if (len >= 4

   884 				&& strcmp(&name[len-4], ".smx") == 0)

   885 			{

   886 				/* If the filename matches, load the plugin */

   887 				char plugin[PLATFORM_MAX_PATH];

   888 				if (localpath == NULL)

   889 				{

   890 					snprintf(plugin, sizeof(plugin), "%s", name);

   891 				} else {

   892 					g_LibSys.PathFormat(plugin, sizeof(plugin), "%s/%s", localpath, name);

   893 				}

   894 				LoadAutoPlugin(plugin);

   895 			}

   896 		}

   897 		dir->NextEntry();

   898 	}

   899 	g_LibSys.CloseDirectory(dir);

   900 }

   902 LoadRes CPluginManager::_LoadPlugin(CPlugin **_plugin, const char *path, bool debug, PluginType type, char error[], size_t maxlength)

   903 {

   904 	if (m_LoadingLocked)

   905 	{

   906 		return LoadRes_NeverLoad;

   907 	}

   909 	int err;

   910 	bool no_load = false;

   911 	PluginSettings *pset;

   912 	unsigned int setcount = m_PluginInfo.GetSettingsNum();

   913 	for (unsigned int i=0; i<setcount; i++)

   914 	{

   915 		if ((pset = m_PluginInfo.GetSettingsIfMatch(i, path)) == NULL)

   916 		{

   917 			continue;

   918 		}

   919 		if (pset->blockload_val)

   920 		{

   921 			no_load = true;

   922 			break;

   923 		}

   924 	}

   926 	/**

   927 	 * Does this plugin already exist?

   928 	 */

   929 	CPlugin *pPlugin;

   930 	if (sm_trie_retrieve(m_LoadLookup, path, (void **)&pPlugin))

   931 	{

   932 		/* Check to see if we should try reloading it */

   933 		if (pPlugin->GetStatus() == Plugin_BadLoad

   934 			|| pPlugin->GetStatus() == Plugin_Error

   935 			|| pPlugin->GetStatus() == Plugin_Failed

   936 			|| no_load)

   937 		{

   938 			UnloadPlugin(pPlugin);

   939 		}

   940 		else

   941 		{

   942 			if (_plugin)

   943 			{

   944 				*_plugin = pPlugin;

   945 			}

   946 			return LoadRes_AlreadyLoaded;

   947 		}

   948 	}

   950 	if (no_load)

   951 	{

   952 		return LoadRes_NeverLoad;

   953 	}

   955 	pPlugin = CPlugin::CreatePlugin(path, error, maxlength);

   957 	assert(pPlugin != NULL);

   959 	pPlugin->m_type = PluginType_MapUpdated;

   961 	ICompilation *co = NULL;

   963 	if (pPlugin->m_status == Plugin_Uncompiled)

   964 	{

   965 		co = g_pSourcePawn2->StartCompilation();

   966 	}

   968 	for (unsigned int i=0; i<setcount; i++)

   969 	{

   970 		if ((pset=m_PluginInfo.GetSettingsIfMatch(i, path)) == NULL)

   971 		{

   972 			continue;

   973 		}

   974 		pPlugin->m_type = pset->type_val;

   975 		if (co)

   976 		{

   977 			for (unsigned int j=0; j<pset->opts_num; j++)

   978 			{

   979 				const char *key, *val;

   980 				m_PluginInfo.GetOptionsForPlugin(pset, j, &key, &val);

   981 				if (!key || !val)

   982 				{

   983 					continue;

   984 				}

   985 				if ((err = co->SetOption(key, val)) == SP_ERROR_NONE)

   986 				{

   987 					if (error)

   988 					{

   989 						snprintf(error, maxlength, "Unable to set JIT option (key \"%s\") (value \"%s\")", key, val);

   990 					}

   991 					co->Abort();

   992 					co = NULL;

   993 					break;

   994 				}

   995 			}

   996 		}

   997 	}

   999 	/* Do the actual compiling */

  1000 	if (co != NULL)

  1001 	{

  1002 		char fullpath[PLATFORM_MAX_PATH];

  1003 		g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", pPlugin->m_filename);

  1005 		pPlugin->m_pRuntime = g_pSourcePawn2->LoadPlugin(co, fullpath, &err);

  1006 		if (pPlugin->m_pRuntime == NULL)

  1007 		{

  1008 			snprintf(error,

  1009 				maxlength,

  1010 				"Unable to load plugin (error %d: %s)",

  1011 				err,

  1012 				g_pSourcePawn2->GetErrorString(err));

  1013 			pPlugin->m_status = Plugin_BadLoad;

  1014 		}

  1015 		else

  1016 		{

  1017 			if (pPlugin->UpdateInfo())

  1018 			{

  1019 				pPlugin->m_status = Plugin_Created;

  1020 			}

  1021 			else

  1022 			{

  1023 				UTIL_Format(error, maxlength, "%s", pPlugin->m_errormsg);

  1024 			}

  1025 		}

  1026 	}

  1028 	LoadRes loadFailure = LoadRes_Failure;

  1029 	/* Get the status */

  1030 	if (pPlugin->GetStatus() == Plugin_Created)

  1031 	{

  1032 		/* First native pass - add anything from Core */

  1033 		g_ShareSys.BindNativesToPlugin(pPlugin, true);

  1034 		pPlugin->InitIdentity();

  1035 		APLRes result = pPlugin->Call_AskPluginLoad(error, maxlength);

  1036 		switch (result)

  1037 		{

  1038 		case APLRes_Success:

  1039 			/* Autoload any modules */

  1040 			LoadOrRequireExtensions(pPlugin, 1, error, maxlength);

  1041 			break;

  1042 		case APLRes_Failure:

  1043 			pPlugin->SetErrorState(Plugin_Failed, "%s", error);

  1044 			loadFailure = LoadRes_Failure;

  1045 			break;

  1046 		case APLRes_SilentFailure:

  1047 			pPlugin->SetErrorState(Plugin_Failed, "%s", error);

  1048 			loadFailure = LoadRes_SilentFailure;

  1049 			pPlugin->SetSilentlyFailed(true);

  1050 			break;

  1051 		default:

  1052 			assert(false);

  1053 		}

  1054 	}

  1056 	/* Save the time stamp */

  1057 	time_t t = pPlugin->GetFileTimeStamp();

  1058 	pPlugin->SetTimeStamp(t);

  1060 	if (_plugin)

  1061 	{

  1062 		*_plugin = pPlugin;

  1063 	}

  1065 	return (pPlugin->GetStatus() == Plugin_Loaded) ? LoadRes_Successful : loadFailure;

  1066 }

  1068 IPlugin *CPluginManager::LoadPlugin(const char *path, bool debug, PluginType type, char error[], size_t maxlength, bool *wasloaded)

  1069 {

  1070 	CPlugin *pl;

  1071 	LoadRes res;

  1073 	*wasloaded = false;

  1074 	if ((res=_LoadPlugin(&pl, path, true, type, error, maxlength)) == LoadRes_Failure)

  1075 	{

  1076 		delete pl;

  1077 		return NULL;

  1078 	}

  1080 	if (res == LoadRes_AlreadyLoaded)

  1081 	{

  1082 		*wasloaded = true;

  1083 		return pl;

  1084 	}

  1086 	if (res == LoadRes_NeverLoad)

  1087 	{

  1088 		if (m_LoadingLocked)

  1089 		{

  1090 			UTIL_Format(error, maxlength, "There is a global plugin loading lock in effect");

  1091 		}

  1092 		else

  1093 		{

  1094 			UTIL_Format(error, maxlength, "This plugin is blocked from loading (see plugin_settings.cfg)");

  1095 		}

  1096 		return NULL;

  1097 	}

  1099 	AddPlugin(pl);

  1101 	/* Run second pass if we need to */

  1102 	if (IsLateLoadTime() && pl->GetStatus() == Plugin_Loaded)

  1103 	{

  1104 		if (!RunSecondPass(pl, error, maxlength))

  1105 		{

  1106 			UnloadPlugin(pl);

  1107 			return NULL;

  1108 		}

  1109 		pl->Call_OnAllPluginsLoaded();

  1110 	}

  1112 	return pl;

  1113 }

  1115 void CPluginManager::LoadAutoPlugin(const char *plugin)

  1116 {

  1117 	CPlugin *pl = NULL;

  1118 	LoadRes res;

  1119 	char error[255] = "Unknown error";

  1121 	if ((res=_LoadPlugin(&pl, plugin, false, PluginType_MapUpdated, error, sizeof(error))) == LoadRes_Failure)

  1122 	{

  1123 		g_Logger.LogError("[SM] Failed to load plugin \"%s\": %s", plugin, error);

  1124 		pl->SetErrorState(

  1125 			pl->GetStatus() == Plugin_BadLoad ? Plugin_BadLoad : Plugin_Failed,

  1126 			"%s",

  1127 			error);

  1128 	}

  1130 	if (res == LoadRes_Successful || res == LoadRes_Failure || res == LoadRes_SilentFailure)

  1131 	{

  1132 		AddPlugin(pl);

  1133 	}

  1134 }

  1136 void CPluginManager::AddPlugin(CPlugin *pPlugin)

  1137 {

  1138 	List<IPluginsListener *>::iterator iter;

  1139 	IPluginsListener *pListener;

  1141 	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)

  1142 	{

  1143 		pListener = (*iter);

  1144 		pListener->OnPluginCreated(pPlugin);

  1145 	}

  1147 	m_plugins.push_back(pPlugin);

  1148 	sm_trie_insert(m_LoadLookup, pPlugin->m_filename, pPlugin);

  1149 }

  1151 void CPluginManager::LoadAll_SecondPass()

  1152 {

  1153 	List<CPlugin *>::iterator iter;

  1154 	CPlugin *pPlugin;

  1156 	char error[256];

  1157 	for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++)

  1158 	{

  1159 		pPlugin = (*iter);

  1160 		if (pPlugin->GetStatus() == Plugin_Loaded)

  1161 		{

  1162 			error[0] = '\0';

  1163 			if (!RunSecondPass(pPlugin, error, sizeof(error)))

  1164 			{

  1165 				g_Logger.LogError("[SM] Unable to load plugin \"%s\": %s", pPlugin->GetFilename(), error);

  1166 				pPlugin->SetErrorState(Plugin_Failed, "%s", error);

  1167 			}

  1168 		}

  1169 	}

  1171 	m_AllPluginsLoaded = true;

  1172 }

  1174 bool CPluginManager::FindOrRequirePluginDeps(CPlugin *pPlugin, char *error, size_t maxlength)

  1175 {

  1176 	struct _pl

  1177 	{

  1178 		cell_t name;

  1179 		cell_t file;

  1180 		cell_t required;

  1181 	} *pl;

  1183 	IPluginContext *pBase = pPlugin->GetBaseContext();

  1184 	uint32_t num = pBase->GetPubVarsNum();

  1185 	sp_pubvar_t *pubvar;

  1186 	char *name, *file;

  1187 	char pathfile[PLATFORM_MAX_PATH];

  1189 	for (uint32_t i=0; i<num; i++)

  1190 	{

  1191 		if (pBase->GetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE)

  1192 		{

  1193 			continue;

  1194 		}

  1195 		if (strncmp(pubvar->name, "__pl_", 5) == 0)

  1196 		{

  1197 			pl = (_pl *)pubvar->offs;

  1198 			if (pBase->LocalToString(pl->file, &file) != SP_ERROR_NONE)

  1199 			{

  1200 				continue;

  1201 			}

  1202 			if (pBase->LocalToString(pl->name, &name) != SP_ERROR_NONE)

  1203 			{

  1204 				continue;

  1205 			}

  1206 			g_LibSys.GetFileFromPath(pathfile, sizeof(pathfile), pPlugin->GetFilename());

  1207 			if (strcmp(pathfile, file) == 0)

  1208 			{

  1209 				continue;

  1210 			}

  1211 			if (pl->required == false)

  1212 			{

  1213 				IPluginFunction *pFunc;

  1214 				char buffer[64];

  1215 				UTIL_Format(buffer, sizeof(buffer), "__pl_%s_SetNTVOptional", &pubvar->name[5]);

  1216 				if ((pFunc=pBase->GetFunctionByName(buffer)))

  1217 				{

  1218 					cell_t res;

  1219 					pFunc->Execute(&res);

  1220 					if (pPlugin->GetBaseContext()->GetLastNativeError() != SP_ERROR_NONE)

  1221 					{

  1222 						if (error)

  1223 						{

  1224 							snprintf(error, maxlength, "Fatal error during initializing plugin load");

  1225 						}

  1226 						return false;

  1227 					}

  1228 				}

  1229 			}

  1230 			else

  1231 			{

  1232 				/* Check that we aren't registering the same library twice */

  1233 				if (pPlugin->m_RequiredLibs.find(name) == pPlugin->m_RequiredLibs.end())

  1234 				{

  1235 					pPlugin->m_RequiredLibs.push_back(name);

  1236 				}

  1237 				else

  1238 				{

  1239 					continue;

  1240 				}

  1241 				List<CPlugin *>::iterator iter;

  1242 				CPlugin *pl;

  1243 				bool found = false;

  1244 				for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++)

  1245 				{

  1246 					pl = (*iter);

  1247 					if (pl->m_Libraries.find(name) != pl->m_Libraries.end())

  1248 					{

  1249 						found = true;

  1250 						break;

  1251 					}

  1252 				}

  1253 				if (!found)

  1254 				{

  1255 					if (error)

  1256 					{

  1257 						snprintf(error, maxlength, "Could not find required plugin \"%s\"", name);

  1258 					}

  1259 					return false;

  1260 				}

  1261 			}

  1262 		}

  1263 	}

  1265 	return true;

  1266 }

  1268 bool CPluginManager::LoadOrRequireExtensions(CPlugin *pPlugin, unsigned int pass, char *error, size_t maxlength)

  1269 {

  1270 	/* Find any extensions this plugin needs */

  1271 	struct _ext

  1272 	{

  1273 		cell_t name;

  1274 		cell_t file;

  1275 		cell_t autoload;

  1276 		cell_t required;

  1277 	} *ext;

  1279 	IPluginContext *pBase = pPlugin->GetBaseContext();

  1280 	uint32_t num = pBase->GetPubVarsNum();

  1281 	sp_pubvar_t *pubvar;

  1282 	IExtension *pExt;

  1283 	char path[PLATFORM_MAX_PATH];

  1284 	char *file, *name;

  1285 	for (uint32_t i=0; i<num; i++)

  1286 	{

  1287 		if (pBase->GetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE)

  1288 		{

  1289 			continue;

  1290 		}

  1291 		if (strncmp(pubvar->name, "__ext_", 6) == 0)

  1292 		{

  1293 			ext = (_ext *)pubvar->offs;

  1294 			if (pBase->LocalToString(ext->file, &file) != SP_ERROR_NONE)

  1295 			{

  1296 				continue;

  1297 			}

  1298 			if (pBase->LocalToString(ext->name, &name) != SP_ERROR_NONE)

  1299 			{

  1300 				continue;

  1301 			}

  1302 			if (pass == 1)

  1303 			{

  1304 				/* Attempt to auto-load if necessary */

  1305 				if (ext->autoload)

  1306 				{

  1307 					g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file);

  1308 					g_Extensions.LoadAutoExtension(path);

  1309 				}

  1310 			}

  1311 			else if (pass == 2)

  1312 			{

  1313 				/* Is this required? */

  1314 				if (ext->required)

  1315 				{

  1316 					g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file);

  1317 					if ((pExt = g_Extensions.FindExtensionByFile(path)) == NULL)

  1318 					{

  1319 						pExt = g_Extensions.FindExtensionByName(name);

  1320 					}

  1321 					/* :TODO: should we bind to unloaded extensions?

  1322 					 * Currently the extension manager will ignore this.

  1323 					 */

  1324 					if (!pExt || !pExt->IsRunning(NULL, 0))

  1325 					{

  1326 						if (error)

  1327 						{

  1328 							snprintf(error, maxlength, "Required extension \"%s\" file(\"%s\") not running", name, file);

  1329 						}

  1330 						return false;

  1331 					}

  1332 					else

  1333 					{

  1334 						g_Extensions.BindChildPlugin(pExt, pPlugin);

  1335 					}

  1336 				}

  1337 				else

  1338 				{

  1339 					IPluginFunction *pFunc;

  1340 					char buffer[64];

  1341 					UTIL_Format(buffer, sizeof(buffer), "__ext_%s_SetNTVOptional", &pubvar->name[6]);

  1343 					if ((pFunc = pBase->GetFunctionByName(buffer)) != NULL)

  1344 					{

  1345 						cell_t res;

  1346 						pFunc->Execute(&res);

  1347 						if (pPlugin->GetBaseContext()->GetLastNativeError() != SP_ERROR_NONE)

  1348 						{

  1349 							if (error)

  1350 							{

  1351 								UTIL_Format(error, maxlength, "Fatal error during plugin initialization (ext req)");

  1352 							}

  1353 							return false;

  1354 						}

  1355 					}

  1356 				}

  1357 			}

  1358 		}

  1359 	}

  1361 	return true;

  1362 }

  1364 bool CPluginManager::RunSecondPass(CPlugin *pPlugin, char *error, size_t maxlength)

  1365 {

  1366 	/* Second pass for extension requirements */

  1367 	if (!LoadOrRequireExtensions(pPlugin, 2, error, maxlength))

  1368 	{

  1369 		return false;

  1370 	}

  1372 	if (!FindOrRequirePluginDeps(pPlugin, error, maxlength))

  1373 	{

  1374 		return false;

  1375 	}

  1377 	/* Run another binding pass */

  1378 	g_ShareSys.BindNativesToPlugin(pPlugin, false);

  1380 	/* Find any unbound natives. Right now, these are not allowed. */

  1381 	IPluginContext *pContext = pPlugin->GetBaseContext();

  1382 	uint32_t num = pContext->GetNativesNum();

  1383 	sp_native_t *native;

  1384 	for (unsigned int i=0; i<num; i++)

  1385 	{

  1386 		if (pContext->GetNativeByIndex(i, &native) != SP_ERROR_NONE)

  1387 		{

  1388 			break;

  1389 		}

  1390 		if (native->status == SP_NATIVE_UNBOUND

  1391 			&& native->name[0] != '@'

  1392 			&& !(native->flags & SP_NTVFLAG_OPTIONAL))

  1393 		{

  1394 			if (error)

  1395 			{

  1396 				snprintf(error, maxlength, "Native \"%s\" was not found", native->name);

  1397 			}

  1398 			return false;

  1399 		}

  1400 	}

  1402 	/* Finish by telling all listeners */

  1403 	List<IPluginsListener *>::iterator iter;

  1404 	IPluginsListener *pListener;

  1405 	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)

  1406 	{

  1407 		pListener = (*iter);

  1408 		pListener->OnPluginLoaded(pPlugin);

  1409 	}

  1411 	/* Tell this plugin to finish initializing itself */

  1412 	pPlugin->Call_OnPluginStart();

  1414 	/* Now, if we have fake natives, go through all plugins that might need rebinding */

  1415 	if (pPlugin->GetStatus() <= Plugin_Paused && pPlugin->m_Natives.size())

  1416 	{

  1417 		List<CPlugin *>::iterator pl_iter;

  1418 		CPlugin *pOther;

  1419 		for (pl_iter = m_plugins.begin();

  1420 			 pl_iter != m_plugins.end();

  1421 			 pl_iter++)

  1422 		{

  1423 			pOther = (*pl_iter);

  1424 			if ((pOther->GetStatus() == Plugin_Error

  1425 				&& (pOther->m_FakeNativesMissing || pOther->m_LibraryMissing))

  1426 				|| pOther->m_FakeNativesMissing)

  1427 			{

  1428 				TryRefreshDependencies(pOther);

  1429 			}

  1430 			else if ((pOther->GetStatus() == Plugin_Running

  1431 					  || pOther->GetStatus() == Plugin_Paused)

  1432 					 && pOther != pPlugin)

  1433 			{

  1434 				List<NativeEntry *>::iterator nv_iter;

  1435 				for (nv_iter = pPlugin->m_Natives.begin();

  1436 					 nv_iter != pPlugin->m_Natives.end();

  1437 					 nv_iter++)

  1438 				{

  1439 					g_ShareSys.BindNativeToPlugin(pOther, (*nv_iter));

  1440 				}

  1441 			}

  1442 		}

  1443 	}

  1445 	/* Go through our libraries and tell other plugins they're added */

  1446 	List<String>::iterator s_iter;

  1447 	for (s_iter = pPlugin->m_Libraries.begin();

  1448 		s_iter != pPlugin->m_Libraries.end();

  1449 		s_iter++)

  1450 	{

  1451 		OnLibraryAction((*s_iter).c_str(), true, false);

  1452 	}

  1454 	/* :TODO: optimize? does this even matter? */

  1455 	pPlugin->GetPhrases()->AddPhraseFile("core.phrases");

  1457 	return true;

  1458 }

  1460 void CPluginManager::TryRefreshDependencies(CPlugin *pPlugin)

  1461 {

  1462 	assert(pPlugin->GetBaseContext() != NULL);

  1464 	g_ShareSys.BindNativesToPlugin(pPlugin, false);

  1466 	List<String>::iterator lib_iter;

  1467 	List<String>::iterator req_iter;

  1468 	List<CPlugin *>::iterator pl_iter;

  1469 	CPlugin *pl;

  1470 	for (req_iter=pPlugin->m_RequiredLibs.begin(); req_iter!=pPlugin->m_RequiredLibs.end(); req_iter++)

  1471 	{

  1472 		bool found = false;

  1473 		for (pl_iter=m_plugins.begin(); pl_iter!=m_plugins.end(); pl_iter++)

  1474 		{

  1475 			pl = (*pl_iter);

  1476 			for (lib_iter=pl->m_Libraries.begin(); lib_iter!=pl->m_Libraries.end(); lib_iter++)

  1477 			{

  1478 				if ((*req_iter) == (*lib_iter))

  1479 				{

  1480 					found = true;

  1481 				}

  1482 			}

  1483 		}

  1484 		if (!found)

  1485 		{

  1486 			pPlugin->SetErrorState(Plugin_Error, "Library not found: %s", (*req_iter).c_str());

  1487 			return;

  1488 		}

  1489 	}

  1491 	/* Find any unbound natives

  1492 	 * Right now, these are not allowed

  1493 	 */

  1494 	IPluginContext *pContext = pPlugin->GetBaseContext();

  1495 	uint32_t num = pContext->GetNativesNum();

  1496 	sp_native_t *native;

  1497 	for (unsigned int i=0; i<num; i++)

  1498 	{

  1499 		if (pContext->GetNativeByIndex(i, &native) != SP_ERROR_NONE)

  1500 		{

  1501 			break;

  1502 		}

  1503 		if (native->status == SP_NATIVE_UNBOUND && !(native->flags & SP_NTVFLAG_OPTIONAL))

  1504 		{

  1505 			pPlugin->SetErrorState(Plugin_Error, "Native not found: %s", native->name);

  1506 			return;

  1507 		}

  1508 	}

  1510 	if (pPlugin->GetStatus() == Plugin_Error)

  1511 	{

  1512 		/* If we got here, all natives are okay again! */

  1513 		pPlugin->m_status = Plugin_Running;

  1514 		if (pPlugin->m_pRuntime->IsPaused())

  1515 		{

  1516 			pPlugin->m_pRuntime->SetPauseState(false);

  1517 			_SetPauseState(pPlugin, false);

  1518 		}

  1519 	}

  1520 }

  1522 bool CPluginManager::UnloadPlugin(IPlugin *plugin)

  1523 {

  1524 	CPlugin *pPlugin = (CPlugin *)plugin;

  1526 	/* This prevents removal during insertion or anything else weird */

  1527 	if (m_plugins.find(pPlugin) == m_plugins.end())

  1528 	{

  1529 		return false;

  1530 	}

  1532 	IPluginContext *pContext = plugin->GetBaseContext();

  1533 	if (pContext != NULL && pContext->IsInExec())

  1534 	{

  1535 		char buffer[255];

  1536 		UTIL_Format(buffer, sizeof(buffer), "sm plugins unload %s\n", plugin->GetFilename());

  1537 		engine->ServerCommand(buffer);

  1538 		return false;

  1539 	}

  1541 	/* Remove us from the lookup table and linked list */

  1542 	m_plugins.remove(pPlugin);

  1543 	sm_trie_delete(m_LoadLookup, pPlugin->m_filename);

  1545 	/* Go through our libraries and tell other plugins they're gone */

  1546 	List<String>::iterator s_iter;

  1547 	for (s_iter = pPlugin->m_Libraries.begin();

  1548 		 s_iter != pPlugin->m_Libraries.end();

  1549 		 s_iter++)

  1550 	{

  1551 		OnLibraryAction((*s_iter).c_str(), true, true);

  1552 	}

  1554 	List<IPluginsListener *>::iterator iter;

  1555 	IPluginsListener *pListener;

  1557 	if (pPlugin->GetStatus() <= Plugin_Error)

  1558 	{

  1559 		/* Notify listeners of unloading */

  1560 		for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)

  1561 		{

  1562 			pListener = (*iter);

  1563 			pListener->OnPluginUnloaded(pPlugin);

  1564 		}

  1565 		/* Notify plugin */

  1566 		pPlugin->Call_OnPluginEnd();

  1567 	}

  1569 	pPlugin->DropEverything();

  1571 	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)

  1572 	{

  1573 		/* Notify listeners of destruction */

  1574 		pListener = (*iter);

  1575 		pListener->OnPluginDestroyed(pPlugin);

  1576 	}

  1578 	/* Tell the plugin to delete itself */

  1579 	delete pPlugin;

  1581 	return true;

  1582 }

  1584 IPlugin *CPluginManager::FindPluginByContext(const sp_context_t *ctx)

  1585 {

  1586 	IPlugin *pPlugin;

  1587 	IPluginContext *pContext;

  1589 	pContext = reinterpret_cast<IPluginContext *>(const_cast<sp_context_t *>(ctx));

  1591 	if (pContext->GetKey(2, (void **)&pPlugin))

  1592 	{

  1593 		return pPlugin;

  1594 	}

  1596 	return NULL;

  1597 }

  1599 CPlugin *CPluginManager::GetPluginByCtx(const sp_context_t *ctx)

  1600 {

  1601 	return (CPlugin *)FindPluginByContext(ctx);

  1602 }

  1604 unsigned int CPluginManager::GetPluginCount()

  1605 {

  1606 	return m_plugins.size();

  1607 }

  1609 void CPluginManager::AddPluginsListener(IPluginsListener *listener)

  1610 {

  1611 	m_listeners.push_back(listener);

  1612 }

  1614 void CPluginManager::RemovePluginsListener(IPluginsListener *listener)

  1615 {

  1616 	m_listeners.remove(listener);

  1617 }

  1619 IPluginIterator *CPluginManager::GetPluginIterator()

  1620 {

  1621 	if (m_iters.empty())

  1622 	{

  1623 		return new CPluginIterator(&m_plugins);

  1624 	} else {

  1625 		CPluginIterator *iter = m_iters.front();

  1626 		m_iters.pop();

  1627 		iter->Reset();

  1628 		return iter;

  1629 	}

  1630 }

  1632 void CPluginManager::ReleaseIterator(CPluginIterator *iter)

  1633 {

  1634 	m_iters.push(iter);

  1635 }

  1637 bool CPluginManager::TestAliasMatch(const char *alias, const char *localpath)

  1638 {

  1639 	/* As an optimization, we do not call strlen, but compute the length in the first pass */

  1640 	size_t alias_len = 0;

  1641 	size_t local_len = 0;

  1643 	const char *ptr = alias;

  1644 	unsigned int alias_explicit_paths = 0;

  1645 	unsigned int alias_path_end = 0;

  1646 	while (*ptr != '\0')

  1647 	{

  1648 		if (*ptr == '\\' || *ptr == '/')

  1649 		{

  1650 			alias_explicit_paths++;

  1651 			alias_path_end = alias_len;

  1652 		}

  1653 		alias_len++;

  1654 		ptr++;

  1655 	}

  1657 	if (alias_explicit_paths && alias_path_end == alias_len - 1)

  1658 	{

  1659 		/* Trailing slash is totally invalid here */

  1660 		return false;

  1661 	}

  1663 	ptr = localpath;

  1664 	unsigned int local_explicit_paths = 0;

  1665 	unsigned int local_path_end = 0;

  1666 	while (*ptr != '\0')

  1667 	{

  1668 		if (*ptr == '\\' || *ptr == '/')

  1669 		{

  1670 			local_explicit_paths++;

  1671 			local_path_end = local_len;

  1672 		}

  1673 		local_len++;

  1674 		ptr++;

  1675 	}

  1677 	/* If the alias has more explicit paths than the real path,

  1678 	 * no match will be possible.

  1679 	 */

  1680 	if (alias_explicit_paths > local_explicit_paths)

  1681 	{

  1682 		return false;

  1683 	}

  1685 	if (alias_explicit_paths)

  1686 	{

  1687 		/* We need to find if the paths match now.  For example, these should all match:

  1688 		 * csdm     csdm

  1689 		 * csdm     optional/csdm

  1690 		 * csdm/ban optional/crab/csdm/ban

  1691 		*/

  1692 		const char *aliasptr = alias;

  1693 		const char *localptr = localpath;

  1694 		bool match = true;

  1695 		do

  1696 		{

  1697 			if (*aliasptr != *localptr)

  1698 			{

  1699 				/* We have to knock one path off */

  1700 				local_explicit_paths--;

  1701 				if (alias_explicit_paths > local_explicit_paths)

  1702 				{

  1703 					/* Skip out if we're gonna have an impossible match */

  1704 					return false;

  1705 				}

  1706 				/* Eat up localptr tokens until we get a result */

  1707 				while (((localptr - localpath) < (int)local_path_end)

  1708 					&& *localptr != '/'

  1709 					&& *localptr != '\\')

  1710 				{

  1711 					localptr++;

  1712 				}

  1713 				/* Check if we hit the end of our searchable area.

  1714 				 * This probably isn't possible because of the path

  1715 				 * count check, but it's a good idea anyway.

  1716 				 */

  1717 				if ((localptr - localpath) >= (int)local_path_end)

  1718 				{

  1719 					return false;

  1720 				} else {

  1721 					/* Consume the slash token */

  1722 					localptr++;

  1723 				}

  1724 				/* Reset the alias pointer so we can continue consuming */

  1725 				aliasptr = alias;

  1726 				match = false;

  1727 				continue;

  1728 			}

  1729 			/* Note:

  1730 			 * This is safe because if localptr terminates early, aliasptr will too

  1731 			 */

  1732 			do

  1733 			{

  1734 				/* We should never reach the end of the string because of this check. */

  1735 				bool aliasend = (aliasptr - alias) > (int)alias_path_end;

  1736 				bool localend = (localptr - localpath) > (int)local_path_end;

  1737 				if (aliasend || localend)

  1738 				{

  1739 					if (aliasend && localend)

  1740 					{

  1741 						/* we matched, and we can break out now */

  1742 						match = true;

  1743 						break;

  1744 					}

  1745 					/* Otherwise, we've hit the end somehow and rest won't match up.  Break out. */

  1746 					match = false;

  1747 					break;

  1748 				}

  1750 				/* If we got here, it's safe to compare the next two tokens */

  1751 				if (*localptr != *aliasptr)

  1752 				{

  1753 					match = false;

  1754 					break;

  1755 				}

  1756 				localptr++;

  1757 				aliasptr++;

  1758 			} while (true);

  1759 		} while (!match);

  1760 	}

  1762 	/* If we got here, it's time to compare filenames */

  1763 	const char *aliasptr = alias;

  1764 	const char *localptr = localpath;

  1766 	if (alias_explicit_paths)

  1767 	{

  1768 		aliasptr = &alias[alias_path_end + 1];

  1769 	}

  1771 	if (local_explicit_paths)

  1772 	{

  1773 		localptr = &localpath[local_path_end + 1];

  1774 	}

  1776 	while (true)

  1777 	{

  1778 		if (*aliasptr == '*')

  1779 		{

  1780 			/* First, see if this is the last character */

  1781 			if ((unsigned)(aliasptr - alias) == alias_len - 1)

  1782 			{

  1783 				/* If so, there's no need to match anything else */

  1784 				return true;

  1785 			}

  1786 			/* Otherwise, we need to search for an appropriate matching sequence in local.

  1787 			 * Note that we only need to search up to the next asterisk.

  1788 			 */

  1789 			aliasptr++;

  1790 			bool match = true;

  1791 			const char *local_orig = localptr;

  1792 			do

  1793 			{

  1794 				match = true;

  1795 				while (*aliasptr != '\0' && *aliasptr != '*')

  1796 				{

  1797 					/* Since aliasptr is never '\0', localptr hitting the end will fail */

  1798 					if (*aliasptr != *localptr)

  1799 					{

  1800 						match = false;

  1801 						break;

  1802 					}

  1803 					aliasptr++;

  1804 					localptr++;

  1805 				}

  1806 				if (!match)

  1807 				{

  1808 					/* If we didn't get a match, we need to advance the search stream.

  1809 					 * This will let us skip tokens while still searching for another match.

  1810 					 */

  1811 					localptr = ++local_orig;

  1812 					/* Make sure we don't go out of bounds */

  1813 					if (*localptr == '\0')

  1814 					{

  1815 						break;

  1816 					}

  1817 				}

  1818 			} while (!match);

  1820 			if (!match)

  1821 			{

  1822 				return false;

  1823 			} else {

  1824 				/* If we got a match, move on to the next token */

  1825 				continue;

  1826 			}

  1827 		} else if (*aliasptr == '\0') {

  1828 			if (*localptr == '\0'

  1829 				||

  1830 				strcmp(localptr, ".smx") == 0)

  1831 			{

  1832 				return true;

  1833 			} else {

  1834 				return false;

  1835 			}

  1836 		} else if (*aliasptr != *localptr) {

  1837 			return false;

  1838 		}

  1839 		aliasptr++;

  1840 		localptr++;

  1841 	}

  1843 	return true;

  1844 }

  1846 bool CPluginManager::IsLateLoadTime() const

  1847 {

  1848 	return (m_AllPluginsLoaded || !g_SourceMod.IsMapLoading());

  1849 }

  1851 void CPluginManager::OnSourceModAllInitialized()

  1852 {

  1853 	m_MyIdent = g_ShareSys.CreateCoreIdentity();

  1855 	HandleAccess sec;

  1856 	g_HandleSys.InitAccessDefaults(NULL, &sec);

  1858 	sec.access[HandleAccess_Delete] = HANDLE_RESTRICT_IDENTITY;

  1859 	sec.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY;

  1861 	g_PluginType = g_HandleSys.CreateType("Plugin", this, 0, NULL, &sec, m_MyIdent, NULL);

  1862 	g_PluginIdent = g_ShareSys.CreateIdentType("PLUGIN");

  1864 	g_RootMenu.AddRootConsoleCommand("plugins", "Manage Plugins", this);

  1866 	g_ShareSys.AddInterface(NULL, this);

  1867 }

  1869 void CPluginManager::OnSourceModShutdown()

  1870 {

  1871 	g_RootMenu.RemoveRootConsoleCommand("plugins", this);

  1873 	UnloadAll();

  1875 	g_HandleSys.RemoveType(g_PluginType, m_MyIdent);

  1876 	g_ShareSys.DestroyIdentType(g_PluginIdent);

  1877 	g_ShareSys.DestroyIdentity(m_MyIdent);

  1878 }

  1880 void CPluginManager::OnHandleDestroy(HandleType_t type, void *object)

  1881 {

  1882 	/* We don't care about the internal object, actually */

  1883 }

  1885 bool CPluginManager::GetHandleApproxSize(HandleType_t type, void *object, unsigned int *pSize)

  1886 {

  1887 	*pSize = ((CPlugin *)object)->CalcMemUsage();

  1888 	return true;

  1889 }

  1891 IPlugin *CPluginManager::PluginFromHandle(Handle_t handle, HandleError *err)

  1892 {

  1893 	IPlugin *pPlugin;

  1894 	HandleError _err;

  1896 	HandleSecurity sec;

  1898 	sec.pOwner = NULL;

  1899 	sec.pIdentity = m_MyIdent;

  1901 	if ((_err=g_HandleSys.ReadHandle(handle, g_PluginType, &sec, (void **)&pPlugin)) != HandleError_None)

  1902 	{

  1903 		pPlugin = NULL;

  1904 	}

  1906 	if (err)

  1907 	{

  1908 		*err = _err;

  1909 	}

  1911 	return pPlugin;

  1912 }

  1914 CPlugin *CPluginManager::GetPluginByOrder(int num)

  1915 {

  1916 	if (num < 1 || num > (int)GetPluginCount())

  1917 	{

  1918 		return NULL;

  1919 	}

  1921 	CPlugin *pl;

  1922 	int id = 1;

  1924 	SourceHook::List<CPlugin *>::iterator iter;

  1925 	for (iter = m_plugins.begin(); iter != m_plugins.end() && id < num; iter++, id++) {}

  1927 	pl = *iter;

  1929 	return pl;

  1930 }

  1932 const char *CPluginManager::GetStatusText(PluginStatus st)

  1933 {

  1934 	switch (st)

  1935 	{

  1936 	case Plugin_Running:

  1937 		return "Running";

  1938 	case Plugin_Paused:

  1939 		return "Paused";

  1940 	case Plugin_Error:

  1941 		return "Error";

  1942 	case Plugin_Uncompiled:

  1943 		return "Uncompiled";

  1944 	case Plugin_BadLoad:

  1945 		return "Bad Load";

  1946 	case Plugin_Failed:

  1947 		return "Failed";

  1948 	default:

  1949 		assert(false);

  1950 		return "-";

  1951 	}

  1952 }

  1954 void CPluginManager::OnRootConsoleCommand(const char *cmdname, const CCommand &command)

  1955 {

  1956 	int argcount = command.ArgC();

  1957 	if (argcount >= 3)

  1958 	{

  1959 		const char *cmd = command.Arg(2);

  1960 		if (strcmp(cmd, "list") == 0)

  1961 		{

  1962 			char buffer[256];

  1963 			unsigned int id = 1;

  1964 			int plnum = GetPluginCount();

  1966 			if (!plnum)

  1967 			{

  1968 				g_RootMenu.ConsolePrint("[SM] No plugins loaded");

  1969 				return;

  1970 			}

  1971 			else

  1972 			{

  1973 				g_RootMenu.ConsolePrint("[SM] Listing %d plugin%s:", GetPluginCount(), (plnum > 1) ? "s" : "");

  1974 			}

  1976 			CPlugin *pl;

  1977 			SourceHook::List<CPlugin *>::iterator iter;

  1978 			SourceHook::List<CPlugin *> m_FailList;

  1980 			for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++, id++)

  1981 			{

  1982 				pl = (*iter);

  1983 				assert(pl->GetStatus() != Plugin_Created);

  1984 				int len = 0;

  1985 				const sm_plugininfo_t *info = pl->GetPublicInfo();

  1986 				if (pl->GetStatus() != Plugin_Running && !pl->IsSilentlyFailed())

  1987 				{

  1988 					len += UTIL_Format(buffer, sizeof(buffer), "  %02d <%s>", id, GetStatusText(pl->GetStatus()));

  1990 					if (pl->GetStatus() <= Plugin_Error)

  1991 					{

  1992 						/* Plugin has failed to load. */

  1993 						m_FailList.push_back(pl);

  1994 					}

  1995 				}

  1996 				else

  1997 				{

  1998 					len += UTIL_Format(buffer, sizeof(buffer), "  %02d", id);

  1999 				}

  2000 				if (pl->GetStatus() < Plugin_Created)

  2001 				{

  2002 					if (pl->IsSilentlyFailed())

  2003 						len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " Disabled:");

  2004 					len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " \"%s\"", (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());

  2005 					if (IS_STR_FILLED(info->version))

  2006 					{

  2007 						len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", info->version);

  2008 					}

  2009 					if (IS_STR_FILLED(info->author))

  2010 					{

  2011 						UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", info->author);

  2012 					}

  2013 				}

  2014 				else

  2015 				{

  2016 					UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", pl->m_filename);

  2017 				}

  2018 				g_RootMenu.ConsolePrint("%s", buffer);

  2019 			}

  2021 			if (!m_FailList.empty())

  2022 			{

  2023 				g_RootMenu.ConsolePrint("Load Errors:");

  2025 				SourceHook::List<CPlugin *>::iterator _iter;

  2027 				CPlugin *pl;

  2029 				for (_iter=m_FailList.begin(); _iter!=m_FailList.end(); _iter++)

  2030 				{

  2031 					pl = (CPlugin *)*_iter;

  2032 					g_RootMenu.ConsolePrint("%s: %s",(IS_STR_FILLED(pl->GetPublicInfo()->name)) ? pl->GetPublicInfo()->name : pl->GetFilename(), pl->m_errormsg);

  2033 				}

  2034 			}

  2036 			return;

  2037 		}

  2038 		else if (strcmp(cmd, "load") == 0)

  2039 		{

  2040 			if (argcount < 4)

  2041 			{

  2042 				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins load <file>");

  2043 				return;

  2044 			}

  2046 			char error[128];

  2047 			bool wasloaded;

  2048 			const char *filename = command.Arg(3);

  2050 			char pluginfile[256];

  2051 			const char *ext = g_LibSys.GetFileExtension(filename) ? "" : ".smx";

  2052 			UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", filename, ext);

  2054 			IPlugin *pl = LoadPlugin(pluginfile, false, PluginType_MapUpdated, error, sizeof(error), &wasloaded);

  2056 			if (wasloaded)

  2057 			{

  2058 				g_RootMenu.ConsolePrint("[SM] Plugin %s is already loaded.", pluginfile);

  2059 				return;

  2060 			}

  2062 			if (pl)

  2063 			{

  2064 				g_RootMenu.ConsolePrint("[SM] Loaded plugin %s successfully.", pluginfile);

  2065 			}

  2066 			else

  2067 			{

  2068 				g_RootMenu.ConsolePrint("[SM] Plugin %s failed to load: %s.", pluginfile, error);

  2069 			}

  2071 			return;

  2072 		}

  2073 		else if (strcmp(cmd, "unload") == 0)

  2074 		{

  2075 			if (argcount < 4)

  2076 			{

  2077 				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins unload <#|file>");

  2078 				return;

  2079 			}

  2081 			CPlugin *pl;

  2082 			char *end;

  2083 			const char *arg = command.Arg(3);

  2084 			int id = strtol(arg, &end, 10);

  2086 			if (*end == '\0')

  2087 			{

  2088 				pl = GetPluginByOrder(id);

  2089 				if (!pl)

  2090 				{

  2091 					g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id);

  2092 					return;

  2093 				}

  2094 			}

  2095 			else

  2096 			{

  2097 				char pluginfile[256];

  2098 				const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx";

  2099 				UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext);

  2101 				if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl))

  2102 				{

  2103 					g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile);

  2104 					return;

  2105 				}

  2106 			}

  2108 			char name[PLATFORM_MAX_PATH];

  2110 			if (pl->GetStatus() < Plugin_Created)

  2111 			{

  2112 				const sm_plugininfo_t *info = pl->GetPublicInfo();

  2113 				UTIL_Format(name, sizeof(name), (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());

  2114 			}

  2115 			else

  2116 			{

  2117 				UTIL_Format(name, sizeof(name), "%s", pl->GetFilename());

  2118 			}

  2120 			if (UnloadPlugin(pl))

  2121 			{

  2122 				g_RootMenu.ConsolePrint("[SM] Plugin %s unloaded successfully.", name);

  2123 			}

  2124 			else

  2125 			{

  2126 				g_RootMenu.ConsolePrint("[SM] Failed to unload plugin %s.", name);

  2127 			}

  2129 			return;

  2130 		}

  2131 		else if (strcmp(cmd, "unload_all") == 0)

  2132 		{

  2133 			g_PluginSys.UnloadAll();

  2134 			g_RootMenu.ConsolePrint("[SM] All plugins have been unloaded.");

  2135 			return;

  2136 		}

  2137 		else if (strcmp(cmd, "load_lock") == 0)

  2138 		{

  2139 			if (m_LoadingLocked)

  2140 			{

  2141 				g_RootMenu.ConsolePrint("[SM] There is already a loading lock in effect.");

  2142 			}

  2143 			else

  2144 			{

  2145 				m_LoadingLocked = true;

  2146 				g_RootMenu.ConsolePrint("[SM] Loading is now locked; no plugins will be loaded or re-loaded.");

  2147 			}

  2148 			return;

  2149 		}

  2150 		else if (strcmp(cmd, "load_unlock") == 0)

  2151 		{

  2152 			if (m_LoadingLocked)

  2153 			{

  2154 				m_LoadingLocked = false;

  2155 				g_RootMenu.ConsolePrint("[SM] The loading lock is no longer in effect.");

  2156 			}

  2157 			else

  2158 			{

  2159 				g_RootMenu.ConsolePrint("[SM] There was no loading lock in effect.");

  2160 			}

  2161 			return;

  2162 		}

  2163 		else if (strcmp(cmd, "info") == 0)

  2164 		{

  2165 			if (argcount < 4)

  2166 			{

  2167 				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins info <#>");

  2168 				return;

  2169 			}

  2171 			CPlugin *pl;

  2172 			char *end;

  2173 			const char *arg = command.Arg(3);

  2174 			int id = strtol(arg, &end, 10);

  2176 			if (*end == '\0')

  2177 			{

  2178 				pl = GetPluginByOrder(id);

  2179 				if (!pl)

  2180 				{

  2181 					g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id);

  2182 					return;

  2183 				}

  2184 			}

  2185 			else

  2186 			{

  2187 				char pluginfile[256];

  2188 				const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx";

  2189 				UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext);

  2191 				if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl))

  2192 				{

  2193 					g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile);

  2194 					return;

  2195 				}

  2196 			}

  2198 			const sm_plugininfo_t *info = pl->GetPublicInfo();

  2200 			g_RootMenu.ConsolePrint("  Filename: %s", pl->GetFilename());

  2201 			if (pl->GetStatus() <= Plugin_Error)

  2202 			{

  2203 				if (IS_STR_FILLED(info->name))

  2204 				{

  2205 					if (IS_STR_FILLED(info->description))

  2206 					{

  2207 						g_RootMenu.ConsolePrint("  Title: %s (%s)", info->name, info->description);

  2208 					} else {

  2209 						g_RootMenu.ConsolePrint("  Title: %s", info->name);

  2210 					}

  2211 				}

  2212 				if (IS_STR_FILLED(info->author))

  2213 				{

  2214 					g_RootMenu.ConsolePrint("  Author: %s", info->author);

  2215 				}

  2216 				if (IS_STR_FILLED(info->version))

  2217 				{

  2218 					g_RootMenu.ConsolePrint("  Version: %s", info->version);

  2219 				}

  2220 				if (IS_STR_FILLED(info->url))

  2221 				{

  2222 					g_RootMenu.ConsolePrint("  URL: %s", info->url);

  2223 				}

  2224 				if (pl->GetStatus() == Plugin_Error)

  2225 				{

  2226 					g_RootMenu.ConsolePrint("  Error: %s", pl->m_errormsg);

  2227 				}

  2228 				else

  2229 				{

  2230 					if (pl->GetStatus() == Plugin_Running)

  2231 					{

  2232 						g_RootMenu.ConsolePrint("  Status: running");

  2233 					}

  2234 					else

  2235 					{

  2236 						g_RootMenu.ConsolePrint("  Status: not running");

  2237 					}

  2239 					const char *typestr = "";

  2240 					switch (pl->GetType())

  2241 					{

  2242 					case PluginType_MapUpdated:

  2243 						typestr = "Map Change if Updated";

  2244 						break;

  2245 					case PluginType_MapOnly:

  2246 						typestr = "Map Change";

  2247 						break;

  2248 					case PluginType_Private:

  2249 					case PluginType_Global:

  2250 						typestr = "Never";

  2251 						break;

  2252 					}

  2254 					g_RootMenu.ConsolePrint("  Reloads: %s", typestr);

  2255 				}

  2256 				if (pl->m_FileVersion >= 3)

  2257 				{

  2258 					g_RootMenu.ConsolePrint("  Timestamp: %s", pl->m_DateTime);

  2259 				}

  2260 			}

  2261 			else

  2262 			{

  2263 				g_RootMenu.ConsolePrint("  Load error: %s", pl->m_errormsg);

  2264 				if (pl->GetStatus() < Plugin_Created)

  2265 				{

  2266 					g_RootMenu.ConsolePrint("  File info: (title \"%s\") (version \"%s\")",

  2267 											info->name ? info->name : "<none>",

  2268 											info->version ? info->version : "<none>");

  2269 					if (IS_STR_FILLED(info->url))

  2270 					{

  2271 						g_RootMenu.ConsolePrint("  File URL: %s", info->url);

  2272 					}

  2273 				}

  2274 			}

  2276 			return;

  2277 		}

  2278 		else if (strcmp(cmd, "refresh") == 0)

  2279 		{

  2280 			g_SourceMod.DoGlobalPluginLoads();

  2281 			g_RootMenu.ConsolePrint("[SM] The plugin list has been refreshed and reloaded.");

  2282 			return;

  2283 		}

  2284 		else if (strcmp(cmd, "reload") == 0)

  2285 		{

  2286 			if (argcount < 4)

  2287 			{

  2288 				g_RootMenu.ConsolePrint("[SM] Usage: sm plugins reload <#|file>");

  2289 				return;

  2290 			}

  2292 			CPlugin *pl;

  2293 			char *end;

  2294 			const char *arg = command.Arg(3);

  2295 			int id = strtol(arg, &end, 10);

  2297 			if (*end == '\0')

  2298 			{

  2299 				pl = GetPluginByOrder(id);

  2300 				if (!pl)

  2301 				{

  2302 					g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id);

  2303 					return;

  2304 				}

  2305 			}

  2306 			else

  2307 			{

  2308 				char pluginfile[256];

  2309 				const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx";

  2310 				UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext);

  2312 				if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl))

  2313 				{

  2314 					g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile);

  2315 					return;

  2316 				}

  2317 			}

  2319 			char name[PLATFORM_MAX_PATH];

  2320 			const sm_plugininfo_t *info = pl->GetPublicInfo();

  2321 			strcpy(name, (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());

  2323 			if (ReloadPlugin(pl))

  2324 			{

  2325 				g_RootMenu.ConsolePrint("[SM] Plugin %s reloaded successfully.", name);

  2326 			}

  2327 			else

  2328 			{

  2329 				g_RootMenu.ConsolePrint("[SM] Failed to reload plugin %s.", name);

  2330 			}

  2332 			return;

  2333 		}

  2334 	}

  2336 	/* Draw the main menu */

  2337 	g_RootMenu.ConsolePrint("SourceMod Plugins Menu:");

  2338 	g_RootMenu.DrawGenericOption("info", "Information about a plugin");

  2339 	g_RootMenu.DrawGenericOption("list", "Show loaded plugins");

  2340 	g_RootMenu.DrawGenericOption("load", "Load a plugin");

  2341 	g_RootMenu.DrawGenericOption("load_lock", "Prevents any more plugins from being loaded");

  2342 	g_RootMenu.DrawGenericOption("load_unlock", "Re-enables plugin loading");

  2343 	g_RootMenu.DrawGenericOption("refresh", "Reloads/refreshes all plugins in the plugins folder");

  2344 	g_RootMenu.DrawGenericOption("reload", "Reloads a plugin");

  2345 	g_RootMenu.DrawGenericOption("unload", "Unload a plugin");

  2346 	g_RootMenu.DrawGenericOption("unload_all", "Unloads all plugins");

  2347 }

  2349 bool CPluginManager::ReloadPlugin(CPlugin *pl)

  2350 {

  2351 	List<CPlugin *>::iterator iter;

  2352 	char filename[PLATFORM_MAX_PATH];

  2353 	bool wasloaded;

  2354 	PluginType ptype;

  2355 	IPlugin *newpl;

  2356 	int id = 1;

  2358 	strcpy(filename, pl->m_filename);

  2359 	ptype = pl->GetType();

  2361 	for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++, id++)

  2362 	{

  2363 		if ((*iter) == pl)

  2364 		{

  2365 			break;

  2366 		}

  2367 	}

  2369 	if (!UnloadPlugin(pl))

  2370 	{

  2371 		return false;

  2372 	}

  2373 	if (!(newpl=LoadPlugin(filename, true, ptype, NULL, 0, &wasloaded)))

  2374 	{

  2375 		return false;

  2376 	}

  2378 	for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++)

  2379 	{

  2380 		if ((*iter) == (CPlugin *)newpl)

  2381 		{

  2382 			m_plugins.erase(iter);

  2383 			break;

  2384 		}

  2385 	}

  2387 	int i;

  2388 	for (i=1, iter=m_plugins.begin(); iter!=m_plugins.end() && i<id; iter++, i++)

  2389 	{

  2390 	}

  2391 	m_plugins.insert(iter, (CPlugin *)newpl);

  2393 	return true;

  2394 }

  2396 void CPluginManager::ReloadOrUnloadPlugins()

  2397 {

  2398 	/* If we're in a load lock, just skip this whole bit. */

  2399 	if (m_LoadingLocked)

  2400 	{

  2401 		return;

  2402 	}

  2404 	List<CPlugin *>::iterator iter;

  2405 	List<CPlugin *> tmp_list = m_plugins;

  2406 	CPlugin *pl;

  2407 	time_t t;

  2409 	for (iter=tmp_list.begin(); iter!=tmp_list.end(); iter++)

  2410 	{

  2411 		pl = (*iter);

  2412 		if (pl->GetType() ==  PluginType_MapOnly)

  2413 		{

  2414 			UnloadPlugin((IPlugin *)pl);

  2415 		}

  2416 		else if (pl->GetType() == PluginType_MapUpdated)

  2417 		{

  2418 			t = pl->GetFileTimeStamp();

  2419 			if (!t || t > pl->GetTimeStamp())

  2420 			{

  2421 				pl->SetTimeStamp(t);

  2422 				UnloadPlugin((IPlugin *)pl);

  2423 			}

  2424 		}

  2425 	}

  2426 }

  2428 void CPluginManager::_SetPauseState(CPlugin *pl, bool paused)

  2429 {

  2430 	List<IPluginsListener *>::iterator iter;

  2431 	IPluginsListener *pListener;

  2432 	for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++)

  2433 	{

  2434 		pListener = (*iter);

  2435 		pListener->OnPluginPauseChange(pl, paused);

  2436 	}

  2437 }

  2439 void CPluginManager::AddFunctionsToForward(const char *name, IChangeableForward *pForward)

  2440 {

  2441 	List<CPlugin *>::iterator iter;

  2442 	CPlugin *pPlugin;

  2443 	IPluginFunction *pFunction;

  2445 	for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++)

  2446 	{

  2447 		pPlugin = (*iter);

  2449 		if (pPlugin->GetStatus() <= Plugin_Paused)

  2450 		{

  2451 			pFunction = pPlugin->GetBaseContext()->GetFunctionByName(name);

  2453 			if (pFunction)

  2454 			{

  2455 				pForward->AddFunction(pFunction);

  2456 			}

  2457 		}

  2458 	}

  2459 }

  2461 CPlugin *CPluginManager::GetPluginFromIdentity(IdentityToken_t *pToken)

  2462 {

  2463 	if (pToken->type != g_PluginIdent)

  2464 	{

  2465 		return NULL;

  2466 	}

  2468 	return (CPlugin *)(pToken->ptr);

  2469 }

  2471 void CPluginManager::OnLibraryAction(const char *lib, bool is_a_plugin, bool drop)

  2472 {

  2473 	List<CPlugin *>::iterator iter;

  2475 	struct _pl

  2476 	{

  2477 		cell_t name;

  2478 		cell_t file;

  2479 		cell_t required;

  2480 	} *plc;

  2482 	struct _ext

  2483 	{

  2484 		cell_t name;

  2485 		cell_t file;

  2486 		cell_t autoload;

  2487 		cell_t required;

  2488 	} *ext;

  2490 	const char *name = drop ? "OnLibraryRemoved" : "OnLibraryAdded";

  2492 	for (iter=m_plugins.begin();

  2493 		 iter!=m_plugins.end();

  2494 		 iter++)

  2495 	{

  2496 		CPlugin *pl = (*iter);

  2497 		if (pl->GetStatus() != Plugin_Running)

  2498 		{

  2499 			continue;

  2500 		}

  2501 		IPluginContext *pContext = pl->GetBaseContext();

  2502 		IPluginFunction *pf = pContext->GetFunctionByName(name);

  2503 		if (!pf)

  2504 		{

  2505 			continue;

  2506 		}

  2507 		uint32_t num_vars = pContext->GetPubVarsNum();

  2508 		for (uint32_t i=0; i<num_vars; i++)

  2509 		{

  2510 			sp_pubvar_t *pubvar;

  2511 			if (pContext->GetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE)

  2512 			{

  2513 				continue;

  2514 			}

  2515 			if (is_a_plugin && strncmp(pubvar->name, "__pl_", 5) == 0)

  2516 			{

  2517 				plc = (_pl *)pubvar->offs;

  2518 				if (plc->required)

  2519 				{

  2520 					continue;

  2521 				}

  2522 				char *str;

  2523 				pContext->LocalToString(plc->name, &str);

  2524 				if (strcmp(str, lib) != 0)

  2525 				{

  2526 					continue;

  2527 				}

  2528 				pf->PushString(lib);

  2529 				pf->Execute(NULL);

  2530 			}

  2531 			else if (!is_a_plugin && strncmp(pubvar->name, "__ext_", 6) == 0)

  2532 			{

  2533 				ext = (_ext *)pubvar->offs;

  2534 				if (ext->required)

  2535 				{

  2536 					continue;

  2537 				}

  2538 				char *str;

  2539 				pContext->LocalToString(ext->name, &str);

  2540 				if (strcmp(str, lib) != 0)

  2541 				{

  2542 					continue;

  2543 				}

  2544 				pf->PushString(lib);

  2545 				pf->Execute(NULL);

  2546 			}

  2547 		}

  2548 	}

  2549 }

  2551 bool CPluginManager::LibraryExists(const char *lib)

  2552 {

  2553 	List<CPlugin *>::iterator iter;

  2555 	for (iter=m_plugins.begin();

  2556 		 iter!=m_plugins.end();

  2557 		 iter++)

  2558 	{

  2559 		CPlugin *pl = (*iter);

  2560 		if (pl->GetStatus() != Plugin_Running)

  2561 		{

  2562 			continue;

  2563 		}

  2564 		List<String>::iterator s_iter;

  2565 		for (s_iter = pl->m_Libraries.begin();

  2566 			 s_iter != pl->m_Libraries.end();

  2567 			 s_iter++)

  2568 		{

  2569 			if ((*s_iter).compare(lib) == 0)

  2570 			{

  2571 				return true;

  2572 			}

  2573 		}

  2574 	}

  2576 	return false;

  2577 }

  2579 void CPluginManager::AllPluginsLoaded()

  2580 {

  2581 	List<CPlugin *>::iterator iter;

  2582 	CPlugin *pl;

  2584 	for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++)

  2585 	{

  2586 		pl = (*iter);

  2587 		pl->Call_OnAllPluginsLoaded();

  2588 	}

  2589 }

  2591 void CPluginManager::UnloadAll()

  2592 {

  2593 	List<CPlugin *>::iterator iter;

  2594 	while ( (iter = m_plugins.begin()) != m_plugins.end() )

  2595 	{

  2596 		UnloadPlugin((*iter));

  2597 	}

  2598 }

  2600 int CPluginManager::GetOrderOfPlugin(IPlugin *pl)

  2601 {

  2602 	int id = 1;

  2603 	List<CPlugin *>::iterator iter;

  2605 	for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++, id++)

  2606 	{

  2607 		if ((*iter) == pl)

  2608 		{

  2609 			return id;

  2610 		}

  2611 	}

  2613 	return -1;

  2614 }

  2616 CPlugin *CPluginManager::FindPluginByConsoleArg(const char *arg)

  2617 {

  2618 	int id;

  2619 	char *end;

  2620 	CPlugin *pl;

  2622 	id = strtol(arg, &end, 10);

  2624 	if (*end == '\0')

  2625 	{

  2626 		pl = GetPluginByOrder(id);

  2627 		if (!pl)

  2628 		{

  2629 			return NULL;

  2630 		}

  2631 	}

  2632 	else

  2633 	{

  2634 		char pluginfile[256];

  2635 		const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx";

  2636 		UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext);

  2638 		if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl))

  2639 		{

  2640 			return NULL;

  2641 		}

  2642 	}

  2644 	return pl;

  2645 }

  2647 void CPluginManager::OnSourceModMaxPlayersChanged(int newvalue)

  2648 {

  2649 	SyncMaxClients(newvalue);

  2650 }

  2652 void CPluginManager::SyncMaxClients(int max_clients)

  2653 {

  2654 	List<CPlugin *>::iterator iter;

  2656 	for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++)

  2657 	{

  2658 		(*iter)->SyncMaxClients(max_clients);

  2659 	}

  2660 }

  2662 void CPluginManager::ListPluginsToClient(CPlayer *player, const CCommand &args)

  2663 {

  2664 	char buffer[256];

  2665 	unsigned int id = 0;

  2666 	int plnum = GetPluginCount();

  2667 	edict_t *e = player->GetEdict();

  2668 	unsigned int start = 0;

  2670 	if (!plnum)

  2671 	{

  2672 		ClientConsolePrint(e, "[SM] No plugins found.");

  2673 		return;

  2674 	}

  2676 	if (args.ArgC() > 2)

  2677 	{

  2678 		start = atoi(args.Arg(2));

  2679 	}

  2681 	CPlugin *pl;

  2682 	SourceHook::List<CPlugin *>::iterator iter;

  2683 	SourceHook::List<CPlugin *> m_FailList;

  2685 	for (iter = m_plugins.begin();

  2686 		 iter != m_plugins.end();

  2687 		 iter++)

  2688 	{

  2689 		pl = (*iter);

  2691 		if (pl->GetStatus() != Plugin_Running)

  2692 		{

  2693 			continue;

  2694 		}

  2696 		/* Count valid plugins */

  2697 		id++;

  2698 		if (id < start)

  2699 		{

  2700 			continue;

  2701 		}

  2703 		if (id - start > 10)

  2704 		{

  2705 			break;

  2706 		}

  2708 		size_t len;

  2709 		const sm_plugininfo_t *info = pl->GetPublicInfo();

  2710 		len = UTIL_Format(buffer, sizeof(buffer), " \"%s\"", (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename());

  2711 		if (IS_STR_FILLED(info->version))

  2712 		{

  2713 			len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", info->version);

  2714 		}

  2715 		if (IS_STR_FILLED(info->author))

  2716 		{

  2717 			UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", info->author);

  2718 		}

  2719 		else

  2720 		{

  2721 			UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", pl->m_filename);

  2722 		}

  2723 		ClientConsolePrint(e, "%s", buffer);

  2724 	}

  2726 	/* See if we can get more plugins */

  2727 	while (iter != m_plugins.end())

  2728 	{

  2729 		if ((*iter)->GetStatus() == Plugin_Running)

  2730 		{

  2731 			break;

  2732 		}

  2733 	}

  2735 	/* Do we actually have more plugins? */

  2736 	if (iter != m_plugins.end())

  2737 	{

  2738 		ClientConsolePrint(e, "To see more, type \"sm plugins %d\"", id + 1);

  2739 	}

  2740 }

author	Matt Woodrow <pred@alliedmods.net>
	Mon Aug 24 09:41:53 2009 +1200 (2009-08-24)
changeset 2781	472f27784e9b
parent 2726	c96f3fab8211
child 2798	6dd90eaa0593
permissions	-rw-r--r--