sourcemm/CPlugin.cpp
author David Anderson <dvander@alliedmods.net>
Sat Feb 10 00:31:34 2007 +0000 (2007-02-10)
changeset 282 7a237e9ea5a1
parent 238 c27105949293
child 296 ba7337defd34
permissions -rw-r--r--
added experimental API for hooking VSP interface calls
updated file license headers
     1 /* ======== SourceMM ========
     2  * Copyright (C) 2004-2007 Metamod:Source Development Team
     3  * No warranties of any kind
     4  *
     5  * License: zlib/libpng
     6  *
     7  * Author(s): David "BAILOPAN" Anderson
     8  * ============================
     9  */
    10 
    11 #include "CPlugin.h"
    12 #include "CSmmAPI.h"
    13 #include "sourcemm.h"
    14 #include "concommands.h"
    15 
    16 /** 
    17  * @brief Implements functions from CPlugin.h
    18  * @file CPlugin.cpp
    19  */
    20 
    21 using namespace SourceMM;
    22 
    23 #define ITER_PLEVENT(evn, plid) \
    24 	CPluginManager::CPlugin *_Xpl; \
    25 	SourceHook::List<IMetamodListener *>::iterator event; \
    26 	IMetamodListener *api; \
    27 	for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
    28 		_Xpl = (*iter); \
    29 		if (_Xpl->m_Id == plid) \
    30 			continue; \
    31 		for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
    32 			api = (*event); \
    33 			api->evn(plid); \
    34 		} \
    35 	}
    36 
    37 CPluginManager g_PluginMngr;
    38 
    39 CPluginManager::CPluginManager()
    40 {
    41 	m_LastId = Pl_MinId;
    42 	m_AllLoaded = false;
    43 }
    44 
    45 CPluginManager::~CPluginManager()
    46 {
    47 	SourceHook::List<CNameAlias *>::iterator iter;
    48 
    49 	for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
    50 	{
    51 		delete (*iter);
    52 	}
    53 
    54 	m_Aliases.clear();
    55 }
    56 
    57 const char *CPluginManager::LookupAlias(const char *alias)
    58 {
    59 	SourceHook::List<CNameAlias *>::iterator iter;
    60 	CNameAlias *p;
    61 
    62 	for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
    63 	{
    64 		p = (*iter);
    65 		if (p->alias.compare(alias) == 0)
    66 		{
    67 			return p->value.c_str();
    68 		}
    69 	}
    70 
    71 	return NULL;
    72 }
    73 
    74 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
    75 {
    76 	return m_Aliases.begin();
    77 }
    78 
    79 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
    80 {
    81 	return m_Aliases.end();
    82 }
    83 
    84 void CPluginManager::SetAlias(const char *alias, const char *value)
    85 {
    86 	SourceHook::List<CNameAlias *>::iterator iter;
    87 	CNameAlias *p;
    88 
    89 	for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
    90 	{
    91 		p = (*iter);
    92 		if (p->alias.compare(alias) == 0)
    93 		{
    94 			if (value[0] == '\0')
    95 			{
    96 				iter = m_Aliases.erase(iter);
    97 				return;
    98 			} else {
    99 				p->value.assign(value);
   100 				return;
   101 			}
   102 		}
   103 	}
   104 
   105 	if (value[0] != '\0')
   106 	{
   107 		p = new CNameAlias;
   108 	
   109 		p->alias.assign(alias);
   110 		p->value.assign(value);
   111 	
   112 		m_Aliases.push_back(p);
   113 	}
   114 }
   115 
   116 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
   117 {
   118 
   119 }
   120 
   121 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
   122 {
   123 	already = false;
   124 	//Check if we're about to reload an old plugin
   125 	PluginIter i = m_Plugins.begin();
   126 	while (i != m_Plugins.end())
   127 	{
   128 		if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
   129 		{
   130 			if ( (*i)->m_Status < Pl_Paused )
   131 			{
   132 				//Attempt to load the plugin again
   133 				already = true;
   134 				i = m_Plugins.erase(i);
   135 				continue;
   136 			} else {
   137 				//No need to load it
   138 				already = true;
   139 				return (*i)->m_Id;
   140 			}
   141 		}
   142 		i++;
   143 	}
   144 
   145 	CPlugin *pl = _Load(file, source, error, maxlen);
   146 
   147 	if (!pl)
   148 		return Pl_BadLoad;
   149 
   150 	ITER_PLEVENT(OnPluginLoad, pl->m_Id);
   151 
   152 	return pl->m_Id;
   153 }
   154 
   155 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
   156 {
   157 	PluginIter i;
   158 
   159 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   160 	{
   161 		if ( (*i)->m_Id == id )
   162 			return (*i);
   163 	}
   164 
   165 	return NULL;
   166 }
   167 
   168 void CPluginManager::SetAllLoaded()
   169 {
   170 	m_AllLoaded = true;
   171 	PluginIter i;
   172 
   173 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   174 	{
   175 		if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
   176 		{
   177 			//API 4 is when we added this callback
   178 			//Min version is now 5, so we ignore this check
   179 			//if ( (*i)->m_API->GetApiVersion() >= 004 )
   180 			(*i)->m_API->AllPluginsLoaded();
   181 		}
   182 	}
   183 }
   184 
   185 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
   186 {
   187 	CPlugin *pl = FindById(id);
   188 	
   189 	if (!pl)
   190 	{
   191 		snprintf(error, maxlen, "Plugin id not found");
   192 		return false;
   193 	}
   194 
   195 	bool ret;
   196 	
   197 	if ( (ret=_Pause(pl, error, maxlen)) == true )
   198 	{
   199 		ITER_PLEVENT(OnPluginPause, pl->m_Id);
   200 	}
   201 
   202 	return ret;
   203 }
   204 
   205 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
   206 {
   207 	CPlugin *pl = FindById(id);
   208 	
   209 	if (!pl)
   210 	{
   211 		snprintf(error, maxlen, "Plugin id not found");
   212 		return false;
   213 	}
   214 
   215 	bool ret;
   216 	
   217 	if ( (ret=_Unpause(pl, error, maxlen)) == true )
   218 	{
   219 		ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
   220 	}
   221 
   222 	return ret;
   223 }
   224 
   225 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
   226 {
   227 	CPlugin *pl = FindById(id);
   228 	
   229 	if (!pl)
   230 	{
   231 		snprintf(error, maxlen, "Plugin %d not found", id);
   232 		return false;
   233 	}
   234 
   235 	bool ret;
   236 	PluginId old_id = pl->m_Id;
   237 	if ( (ret=_Unload(pl, force, error, maxlen)) == true )
   238 	{
   239 		ITER_PLEVENT(OnPluginUnload, old_id);
   240 	}
   241 
   242 	return ret;
   243 }
   244 
   245 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
   246 {
   247 	PluginIter i;
   248 	char buffer[64];
   249 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   250 	{
   251 		if ( (*i) && (*i)->m_Id == id )
   252 		{
   253 			if ( (*i)->m_Status >= Pl_Paused)
   254 			{
   255 				snprintf(error, len, "Plugin %d is already running.", id);
   256 				return false;
   257 			}
   258 			CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
   259 			if (!pl)
   260 				return false;
   261 			if (pl->m_Status >= Pl_Paused)
   262 			{
   263 				//Now it gets crazy... unload the original copy.
   264 				_Unload( (*i), true, buffer, sizeof(buffer)-1 );
   265 				
   266 				//Set the new copy's id
   267 				pl->m_Id = id;
   268 
   269 				//We just wasted an id... reclaim it
   270 				m_LastId--;
   271 				
   272 				return true;
   273 			} else {
   274 				//don't really care about the buffer here
   275 				_Unload(pl, true, buffer, sizeof(buffer)-1);
   276 
   277 				//We just wasted an id... reclaim it
   278 				m_LastId--;
   279 				return false;
   280 			}
   281 		}
   282 	}
   283 
   284 	snprintf(error, len, "Plugin %d not found,", id);
   285 	return false;
   286 }
   287 
   288 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
   289 {
   290 	PluginIter i;
   291 
   292 	//don't find bad plugins!
   293 	if (!api)
   294 		return NULL;
   295 
   296 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   297 	{
   298 		if ( (*i)->m_API == api )
   299 			return (*i);
   300 	}
   301 
   302 	return NULL;
   303 }
   304 
   305 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
   306 {
   307 	FILE *fp;
   308 	CPlugin *pl;
   309 
   310 	pl = new CPlugin();
   311 	*error = '\0';
   312 	
   313 	//Add plugin to list
   314 	pl->m_Id = m_LastId;
   315 	pl->m_File.assign(file);
   316 	m_Plugins.push_back(pl);
   317 	m_LastId++;
   318 
   319 	//Check if the file even exists
   320 	fp = fopen(file, "r");
   321 	if (!fp)
   322 	{
   323 		if (error)
   324 			snprintf(error, maxlen, "File not found: %s", file);
   325 		pl->m_Status = Pl_NotFound;
   326 	}
   327 
   328 	if (fp)
   329 	{
   330 		fclose(fp);
   331 		fp = NULL;
   332 		
   333 		//Load the file
   334 		pl->m_Lib = dlmount(file);
   335 		if (!pl->m_Lib)
   336 		{
   337 			if (error)
   338 				snprintf(error, maxlen, "%s", dlerror());
   339 			pl->m_Status = Pl_Error;
   340 		} else {
   341 			CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
   342 			if (!pfn)
   343 			{
   344 				if (error)
   345 					snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
   346 				pl->m_Status = Pl_Error;
   347 			} else {
   348 				pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
   349 				if (!pl->m_API)
   350 				{
   351 					if (error)
   352 						snprintf(error, maxlen, "Failed to get API");
   353 					pl->m_Status = Pl_Error;
   354 				} else {
   355 					int api = pl->m_API->GetApiVersion();
   356 					if (api < PLAPI_MIN_VERSION)
   357 					{
   358 						if (error)
   359 							snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
   360 						pl->m_Status = Pl_Error;
   361 					} else if (api > PLAPI_VERSION) {
   362 						if (error)
   363 							snprintf(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
   364 						pl->m_Status = Pl_Error;
   365 					} else {
   366 						if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
   367 						{
   368 							pl->m_Status = Pl_Running;
   369 							if (m_AllLoaded)
   370 							{
   371 								//API 4 is when we added this callback
   372 								//Removing this code as the min version is now 5
   373 								//if (pl->m_API->GetApiVersion() >= 4)
   374 								pl->m_API->AllPluginsLoaded();
   375 							}
   376 						} else {
   377 							pl->m_Status = Pl_Refused;
   378 						}
   379 					}
   380 				}
   381 			}
   382 		}
   383 	}
   384 
   385 	if (pl->m_Lib && (pl->m_Status < Pl_Paused))
   386 	{
   387 		pl->m_Events.clear();
   388 		g_SourceHook.UnloadPlugin(pl->m_Id);
   389 		UnregAllConCmds(pl);
   390 
   391 		dlclose(pl->m_Lib);
   392 		pl->m_Lib = NULL;
   393 		pl->m_API = NULL;
   394 	}
   395 
   396 	return pl;
   397 }
   398 
   399 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
   400 {
   401 	if (error)
   402 		*error = '\0';
   403 	if (pl->m_API && pl->m_Lib)
   404 	{
   405 		//Note, we'll always tell the plugin it will be unloading...
   406 		if (pl->m_API->Unload(error, maxlen) || force)
   407 		{
   408 			//Make sure to detach it from sourcehook!
   409 			g_SourceHook.UnloadPlugin(pl->m_Id);
   410 
   411 			UnregAllConCmds(pl);
   412 
   413 			//Clean up the DLL
   414 			dlclose(pl->m_Lib);
   415 			pl->m_Lib = NULL;
   416 			pl->m_API = NULL;
   417 
   418 			//Remove the plugin from the list
   419 			PluginIter i;
   420 			for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   421 			{
   422 				if ( (*i)->m_Id == pl->m_Id )
   423 				{
   424 					i = m_Plugins.erase(i);
   425 					break;
   426 				}
   427 			}
   428 			//Free its memory
   429 			delete pl;
   430 
   431 			return true;
   432 		}
   433 	} else {
   434 		//The plugin is not valid, and let's just remove it from the list anyway
   435 		PluginIter i;
   436 		for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   437 		{
   438 			if ( (*i)->m_Id == pl->m_Id )
   439 			{
   440 				i = m_Plugins.erase(i);
   441 				break;
   442 			}
   443 		}
   444 		delete pl;
   445 
   446 		return true;
   447 	}
   448 
   449 	return false;
   450 }
   451 
   452 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   453 {
   454 	if (error)
   455 		*error = '\0';
   456 	if (pl->m_Status != Pl_Running || !pl->m_API)
   457 	{
   458 		if (error)
   459 			snprintf(error, maxlen, "Plugin cannot be paused");
   460 	} else {
   461 		if (pl->m_API->Pause(error, maxlen))
   462 		{
   463 			g_SourceHook.PausePlugin(pl->m_Id);
   464 			pl->m_Status = Pl_Paused;
   465 
   466 			return true;
   467 		}
   468 	}
   469 
   470 	return false;
   471 }
   472 
   473 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
   474 {
   475 	if (error)
   476 		*error = '\0';
   477 
   478 	if (pl->m_Status != Pl_Paused || !pl->m_API)
   479 	{
   480 		if (error)
   481 			snprintf(error, maxlen, "Plugin cannot be unpaused");
   482 	} else {
   483 		if (pl->m_API->Unpause(error, maxlen))
   484 		{
   485 			g_SourceHook.UnpausePlugin(pl->m_Id);
   486 			pl->m_Status = Pl_Running;
   487 
   488 			return true;
   489 		}
   490 	}
   491 
   492 	return false;
   493 }
   494 
   495 bool CPluginManager::UnloadAll()
   496 {
   497 	PluginIter i;
   498 
   499 	SourceHook::List<SourceMM::CPluginManager::CPlugin *> remqueue;
   500 
   501 	for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
   502 		remqueue.push_back( (*i) );
   503 
   504 	char error[128];
   505 	bool status = true;
   506 
   507 	for (i=remqueue.begin(); i!=remqueue.end(); i++)
   508 	{
   509 		if ( !_Unload( (*i), true, error, sizeof(error)-1) )
   510 			status = false;
   511 	}
   512 
   513 	m_Plugins.clear();
   514 	remqueue.clear();
   515 
   516 	return status;
   517 }
   518 
   519 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
   520 {
   521 	CPlugin *pl = FindById(id);
   522 
   523 	if (!pl)
   524 		return false;
   525 
   526 	file = pl->m_File.c_str();
   527 	status = pl->m_Status;
   528 	source = pl->m_Source;
   529 
   530 	return true;
   531 }
   532 
   533 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
   534 {
   535 	CPlugin *pl = FindById(id);
   536 
   537 	if (!pl || !pl->m_API)
   538 	{
   539 		if (error)
   540 			snprintf(error, maxlength, "Plugin not valid");
   541 		return false;
   542 	}
   543 
   544 	return pl->m_API->QueryRunning(error, maxlength);
   545 }
   546 
   547 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
   548 {
   549 	CPlugin *pl = FindById(id);
   550 
   551 	if (!pl)
   552 	{
   553 		return false;
   554 	}
   555 
   556 	handle = static_cast<void *>(pl->m_Lib);
   557 
   558 	return true;
   559 }
   560 
   561 PluginIter CPluginManager::_begin()
   562 {
   563 	return m_Plugins.begin();
   564 }
   565 
   566 PluginIter CPluginManager::_end()
   567 {
   568 	return m_Plugins.end();
   569 }
   570 
   571 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
   572 {
   573 	CPlugin *pl = FindByAPI(api);
   574 
   575 	if (!pl)
   576 		return;
   577 
   578 	pl->m_Cvars.push_back(pCvar);
   579 }
   580 
   581 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
   582 {
   583 	CPlugin *pl = FindByAPI(api);
   584 
   585 	if (!pl)
   586 		return;
   587 
   588 	pl->m_Cmds.push_back(pCmd);
   589 }
   590 
   591 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
   592 {
   593 	CPlugin *pl = FindByAPI(api);
   594 
   595 	if (!pl)
   596 		return;
   597 
   598 	pl->m_Cvars.remove(pCvar);
   599 }
   600 
   601 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
   602 {
   603 	CPlugin *pl = FindByAPI(api);
   604 
   605 	if (!pl)
   606 		return;
   607 
   608 	pl->m_Cmds.remove(pCmd);
   609 }
   610 
   611 void CPluginManager::UnregAllConCmds(CPlugin *pl)
   612 {
   613 	SourceHook::List<ConCommandBase *>::iterator i;
   614 
   615 	for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
   616 		g_SMConVarAccessor.Unregister( (*i) );
   617 
   618 	pl->m_Cvars.clear();
   619 
   620 	for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
   621 		g_SMConVarAccessor.Unregister( (*i) );
   622 
   623 	pl->m_Cmds.clear();
   624 }