1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
14 #include "concommands.h"
17 * @brief Implements functions from CPlugin.h
21 using namespace SourceMM;
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++) { \
29 if (_Xpl->m_Id == plid) \
31 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
37 CPluginManager g_PluginMngr;
39 CPluginManager::CPluginManager()
45 CPluginManager::~CPluginManager()
47 SourceHook::List<CNameAlias *>::iterator iter;
49 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
57 const char *CPluginManager::LookupAlias(const char *alias)
59 SourceHook::List<CNameAlias *>::iterator iter;
62 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
65 if (p->alias.compare(alias) == 0)
67 return p->value.c_str();
74 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
76 return m_Aliases.begin();
79 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
81 return m_Aliases.end();
84 void CPluginManager::SetAlias(const char *alias, const char *value)
86 SourceHook::List<CNameAlias *>::iterator iter;
89 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
92 if (p->alias.compare(alias) == 0)
96 iter = m_Aliases.erase(iter);
99 p->value.assign(value);
105 if (value[0] != '\0')
109 p->alias.assign(alias);
110 p->value.assign(value);
112 m_Aliases.push_back(p);
116 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
121 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
124 //Check if we're about to reload an old plugin
125 PluginIter i = m_Plugins.begin();
126 while (i != m_Plugins.end())
128 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
130 if ( (*i)->m_Status < Pl_Paused )
132 //Attempt to load the plugin again
134 i = m_Plugins.erase(i);
145 CPlugin *pl = _Load(file, source, error, maxlen);
150 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
155 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
159 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
161 if ( (*i)->m_Id == id )
168 void CPluginManager::SetAllLoaded()
173 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
175 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
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();
185 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
187 CPlugin *pl = FindById(id);
191 UTIL_Format(error, maxlen, "Plugin id not found");
197 if ( (ret=_Pause(pl, error, maxlen)) == true )
199 ITER_PLEVENT(OnPluginPause, pl->m_Id);
205 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
207 CPlugin *pl = FindById(id);
211 UTIL_Format(error, maxlen, "Plugin id not found");
217 if ( (ret=_Unpause(pl, error, maxlen)) == true )
219 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
225 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
227 CPlugin *pl = FindById(id);
231 UTIL_Format(error, maxlen, "Plugin %d not found", id);
236 PluginId old_id = pl->m_Id;
237 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
239 ITER_PLEVENT(OnPluginUnload, old_id);
245 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
249 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
251 if ( (*i) && (*i)->m_Id == id )
253 if ( (*i)->m_Status >= Pl_Paused)
255 UTIL_Format(error, len, "Plugin %d is already running.", id);
258 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
261 if (pl->m_Status >= Pl_Paused)
263 //Now it gets crazy... unload the original copy.
264 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
266 //Set the new copy's id
269 //We just wasted an id... reclaim it
274 //don't really care about the buffer here
275 _Unload(pl, true, buffer, sizeof(buffer)-1);
277 //We just wasted an id... reclaim it
284 UTIL_Format(error, len, "Plugin %d not found,", id);
288 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
292 //don't find bad plugins!
296 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
298 if ( (*i)->m_API == api )
305 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
315 pl->m_File.assign(file);
316 m_Plugins.push_back(pl);
319 //Check if the file even exists
320 fp = fopen(file, "r");
324 UTIL_Format(error, maxlen, "File not found: %s", file);
325 pl->m_Status = Pl_NotFound;
334 pl->m_Lib = dlmount(file);
338 UTIL_Format(error, maxlen, "%s", dlerror());
339 pl->m_Status = Pl_Error;
341 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
345 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
346 pl->m_Status = Pl_Error;
348 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
352 UTIL_Format(error, maxlen, "Failed to get API");
353 pl->m_Status = Pl_Error;
355 int api = pl->m_API->GetApiVersion();
356 if (api < PLAPI_MIN_VERSION)
359 UTIL_Format(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) {
363 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
364 pl->m_Status = Pl_Error;
366 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
368 pl->m_Status = Pl_Running;
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();
377 pl->m_Status = Pl_Refused;
385 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
387 pl->m_Events.clear();
388 g_SourceHook.UnloadPlugin(pl->m_Id);
399 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
403 if (pl->m_API && pl->m_Lib)
405 //Note, we'll always tell the plugin it will be unloading...
406 if (pl->m_API->Unload(error, maxlen) || force)
408 //Make sure to detach it from sourcehook!
409 g_SourceHook.UnloadPlugin(pl->m_Id);
418 //Remove the plugin from the list
420 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
422 if ( (*i)->m_Id == pl->m_Id )
424 i = m_Plugins.erase(i);
434 //The plugin is not valid, and let's just remove it from the list anyway
436 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
438 if ( (*i)->m_Id == pl->m_Id )
440 i = m_Plugins.erase(i);
452 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
456 if (pl->m_Status != Pl_Running || !pl->m_API)
459 UTIL_Format(error, maxlen, "Plugin cannot be paused");
461 if (pl->m_API->Pause(error, maxlen))
463 g_SourceHook.PausePlugin(pl->m_Id);
464 pl->m_Status = Pl_Paused;
473 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
478 if (pl->m_Status != Pl_Paused || !pl->m_API)
481 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
483 if (pl->m_API->Unpause(error, maxlen))
485 g_SourceHook.UnpausePlugin(pl->m_Id);
486 pl->m_Status = Pl_Running;
495 bool CPluginManager::UnloadAll()
499 SourceHook::List<SourceMM::CPluginManager::CPlugin *> remqueue;
501 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
502 remqueue.push_back( (*i) );
507 for (i=remqueue.begin(); i!=remqueue.end(); i++)
509 if ( !_Unload( (*i), true, error, sizeof(error)) )
519 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
521 CPlugin *pl = FindById(id);
526 file = pl->m_File.c_str();
527 status = pl->m_Status;
528 source = pl->m_Source;
533 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
535 CPlugin *pl = FindById(id);
537 if (!pl || !pl->m_API)
540 UTIL_Format(error, maxlength, "Plugin not valid");
544 return pl->m_API->QueryRunning(error, maxlength);
547 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
549 CPlugin *pl = FindById(id);
556 handle = static_cast<void *>(pl->m_Lib);
561 PluginIter CPluginManager::_begin()
563 return m_Plugins.begin();
566 PluginIter CPluginManager::_end()
568 return m_Plugins.end();
571 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
573 CPlugin *pl = FindByAPI(api);
578 pl->m_Cvars.push_back(pCvar);
581 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
583 CPlugin *pl = FindByAPI(api);
588 pl->m_Cmds.push_back(pCmd);
591 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
593 CPlugin *pl = FindByAPI(api);
598 pl->m_Cvars.remove(pCvar);
601 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
603 CPlugin *pl = FindByAPI(api);
608 pl->m_Cmds.remove(pCmd);
611 void CPluginManager::UnregAllConCmds(CPlugin *pl)
613 SourceHook::List<ConCommandBase *>::iterator i;
615 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
616 g_SMConVarAccessor.Unregister( (*i) );
620 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
621 g_SMConVarAccessor.Unregister( (*i) );