1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
16 #include "metamod_plugins.h"
17 #include "metamod_util.h"
24 * @brief Implements functions from CPlugin.h
28 using namespace SourceMM;
30 #define ITER_PLEVENT(evn, plid) \
31 CPluginManager::CPlugin *_Xpl; \
32 SourceHook::List<IMetamodListener *>::iterator event; \
33 IMetamodListener *api; \
34 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
36 if (_Xpl->m_Id == plid) \
38 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
44 CPluginManager g_PluginMngr;
46 CPluginManager::CPluginManager()
52 CPluginManager::~CPluginManager()
54 SourceHook::List<CNameAlias *>::iterator iter;
56 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
64 const char *CPluginManager::LookupAlias(const char *alias)
66 SourceHook::List<CNameAlias *>::iterator iter;
69 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
72 if (p->alias.compare(alias) == 0)
74 return p->value.c_str();
81 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
83 return m_Aliases.begin();
86 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
88 return m_Aliases.end();
91 void CPluginManager::SetAlias(const char *alias, const char *value)
93 SourceHook::List<CNameAlias *>::iterator iter;
96 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
99 if (p->alias.compare(alias) == 0)
101 if (value[0] == '\0')
103 iter = m_Aliases.erase(iter);
108 p->value.assign(value);
114 if (value[0] != '\0')
118 p->alias.assign(alias);
119 p->value.assign(value);
121 m_Aliases.push_back(p);
125 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
130 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
133 //Check if we're about to reload an old plugin
134 PluginIter i = m_Plugins.begin();
135 while (i != m_Plugins.end())
137 if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()))
139 if ((*i)->m_Status < Pl_Paused)
141 //Attempt to load the plugin again
143 i = m_Plugins.erase(i);
156 CPlugin *pl = _Load(file, source, error, maxlen);
163 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
168 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
172 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
174 if ( (*i)->m_Id == id )\
183 void CPluginManager::SetAllLoaded()
188 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
190 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
192 //API 4 is when we added this callback
193 //Min version is now 5, so we ignore this check
194 //if ( (*i)->m_API->GetApiVersion() >= 004 )
195 (*i)->m_API->AllPluginsLoaded();
200 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
202 CPlugin *pl = FindById(id);
206 UTIL_Format(error, maxlen, "Plugin id not found");
212 if ((ret=_Pause(pl, error, maxlen)) == true)
214 ITER_PLEVENT(OnPluginPause, pl->m_Id);
220 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
222 CPlugin *pl = FindById(id);
226 UTIL_Format(error, maxlen, "Plugin id not found");
232 if ( (ret=_Unpause(pl, error, maxlen)) == true )
234 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
240 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
242 CPlugin *pl = FindById(id);
246 UTIL_Format(error, maxlen, "Plugin %d not found", id);
251 PluginId old_id = pl->m_Id;
252 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
254 ITER_PLEVENT(OnPluginUnload, old_id);
260 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
264 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
266 if ( (*i) && (*i)->m_Id == id )
268 if ( (*i)->m_Status >= Pl_Paused)
270 UTIL_Format(error, len, "Plugin %d is already running.", id);
273 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
278 if (pl->m_Status >= Pl_Paused)
280 //Now it gets crazy... unload the original copy.
281 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
283 //Set the new copy's id
286 //We just wasted an id... reclaim it
293 //don't really care about the buffer here
294 _Unload(pl, true, buffer, sizeof(buffer)-1);
296 //We just wasted an id... reclaim it
303 UTIL_Format(error, len, "Plugin %d not found,", id);
307 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
311 //don't find bad plugins!
317 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
319 if ((*i)->m_API == api)
328 int CPluginManager::GetPluginCount()
330 return (int)m_Plugins.size();
333 const char *CPluginManager::GetStatusText(CPlugin *pl)
335 switch (pl->m_Status)
347 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
359 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
369 pl->m_File.assign(file);
370 m_Plugins.push_back(pl);
373 //Check if the file even exists
374 fp = fopen(file, "r");
379 UTIL_Format(error, maxlen, "File not found: %s", file);
381 pl->m_Status = Pl_NotFound;
390 pl->m_Lib = dlmount(file);
395 UTIL_Format(error, maxlen, "%s", dlerror());
397 pl->m_Status = Pl_Error;
401 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
406 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
408 pl->m_Status = Pl_Error;
412 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
417 UTIL_Format(error, maxlen, "Failed to get API");
419 pl->m_Status = Pl_Error;
423 int api = pl->m_API->GetApiVersion();
424 if (api < PLAPI_MIN_VERSION)
428 UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
430 pl->m_Status = Pl_Error;
432 else if (api > PLAPI_VERSION)
436 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
438 pl->m_Status = Pl_Error;
442 if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded))
444 pl->m_Status = Pl_Running;
447 //API 4 is when we added this callback
448 //Removing this code as the min version is now 5
449 //if (pl->m_API->GetApiVersion() >= 4)
450 pl->m_API->AllPluginsLoaded();
455 pl->m_Status = Pl_Refused;
463 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
465 pl->m_Events.clear();
466 g_SourceHook.UnloadPlugin(pl->m_Id);
477 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
484 if (pl->m_API && pl->m_Lib)
486 //Note, we'll always tell the plugin it will be unloading...
487 if (pl->m_API->Unload(error, maxlen) || force)
489 //Make sure to detach it from sourcehook!
490 g_SourceHook.UnloadPlugin(pl->m_Id);
499 //Remove the plugin from the list
501 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
503 if ( (*i)->m_Id == pl->m_Id )
505 i = m_Plugins.erase(i);
515 //The plugin is not valid, and let's just remove it from the list anyway
517 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
519 if ( (*i)->m_Id == pl->m_Id )
521 i = m_Plugins.erase(i);
533 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
540 if (pl->m_Status != Pl_Running || !pl->m_API)
544 UTIL_Format(error, maxlen, "Plugin cannot be paused");
549 if (pl->m_API->Pause(error, maxlen))
551 g_SourceHook.PausePlugin(pl->m_Id);
552 pl->m_Status = Pl_Paused;
561 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
568 if (pl->m_Status != Pl_Paused || !pl->m_API)
572 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
577 if (pl->m_API->Unpause(error, maxlen))
579 g_SourceHook.UnpausePlugin(pl->m_Id);
580 pl->m_Status = Pl_Running;
589 bool CPluginManager::UnloadAll()
596 while ((i = m_Plugins.begin()) != m_Plugins.end())
598 if ( !_Unload( (*i), true, error, sizeof(error)) )
607 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
609 CPlugin *pl = FindById(id);
616 file = pl->m_File.c_str();
617 status = pl->m_Status;
618 source = pl->m_Source;
623 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
625 CPlugin *pl = FindById(id);
627 if (!pl || !pl->m_API)
631 UTIL_Format(error, maxlength, "Plugin not valid");
636 return pl->m_API->QueryRunning(error, maxlength);
639 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
641 CPlugin *pl = FindById(id);
648 handle = static_cast<void *>(pl->m_Lib);
653 PluginIter CPluginManager::_begin()
655 return m_Plugins.begin();
658 PluginIter CPluginManager::_end()
660 return m_Plugins.end();
663 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
665 CPlugin *pl = FindByAPI(api);
672 pl->m_Cvars.push_back(pCvar);
675 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
677 CPlugin *pl = FindByAPI(api);
684 pl->m_Cmds.push_back(pCmd);
687 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
689 CPlugin *pl = FindByAPI(api);
696 pl->m_Cvars.remove(pCvar);
699 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
701 CPlugin *pl = FindByAPI(api);
708 pl->m_Cmds.remove(pCmd);
711 void CPluginManager::UnregAllConCmds(CPlugin *pl)
714 SourceHook::List<ConCommandBase *>::iterator i;
717 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
719 g_SMConVarAccessor.Unregister(pl->m_Id, (*i) );
724 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
726 g_SMConVarAccessor.Unregister(pl->m_Id, (*i) );