Push build.
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2009 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
14 #include "concommands.h"
18 * @brief Implements functions from CPlugin.h
22 using namespace SourceMM;
24 #define ITER_PLEVENT(evn, plid) \
25 CPluginManager::CPlugin *_Xpl; \
26 SourceHook::List<CPluginEventHandler>::iterator event; \
27 IMetamodListener *api; \
28 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
30 if (_Xpl->m_Id == plid) \
32 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
33 api = (*event).event; \
38 CPluginManager g_PluginMngr;
40 void NotifyConCommandBaseDrop(PluginId id, ConCommandBase *base)
42 CPluginManager::CPlugin *pl;
43 SourceHook::List<CPluginEventHandler>::iterator event;
44 IMetamodListener *api;
45 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++)
48 if (pl->m_Status < Pl_Paused)
50 if (pl->m_API->GetApiVersion() < 11)
52 for (event = pl->m_Events.begin(); event != pl->m_Events.end(); event++)
55 api->OnUnlinkConCommandBase(id, base);
60 CPluginManager::CPluginManager()
66 CPluginManager::~CPluginManager()
68 SourceHook::List<CNameAlias *>::iterator iter;
70 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
78 const char *CPluginManager::LookupAlias(const char *alias)
80 SourceHook::List<CNameAlias *>::iterator iter;
83 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
86 if (p->alias.compare(alias) == 0)
88 return p->value.c_str();
95 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
97 return m_Aliases.begin();
100 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
102 return m_Aliases.end();
105 void CPluginManager::SetAlias(const char *alias, const char *value)
107 SourceHook::List<CNameAlias *>::iterator iter;
110 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
113 if (p->alias.compare(alias) == 0)
115 if (value[0] == '\0')
117 iter = m_Aliases.erase(iter);
120 p->value.assign(value);
126 if (value[0] != '\0')
130 p->alias.assign(alias);
131 p->value.assign(value);
133 m_Aliases.push_back(p);
137 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
142 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
145 //Check if we're about to reload an old plugin
146 PluginIter i = m_Plugins.begin();
147 while (i != m_Plugins.end())
149 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
151 if ( (*i)->m_Status < Pl_Paused )
153 //Attempt to load the plugin again
155 i = m_Plugins.erase(i);
166 CPlugin *pl = _Load(file, source, error, maxlen);
171 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
176 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
180 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
182 if ( (*i)->m_Id == id )
189 void CPluginManager::SetAllLoaded()
194 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
196 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
198 //API 4 is when we added this callback
199 //Min version is now 5, so we ignore this check
200 //if ( (*i)->m_API->GetApiVersion() >= 004 )
201 (*i)->m_API->AllPluginsLoaded();
206 void CPluginManager::SetVSPAsLoaded()
210 SourceHook::List<CPluginEventHandler>::iterator event;
212 for (i = m_Plugins.begin(); i != m_Plugins.end(); i++)
215 if (pPlugin->m_Status < Pl_Paused)
219 /* Only valid for plugins >= 10 (v1:5, SourceMM 1.4) */
220 if (pPlugin->m_API->GetApiVersion() < 10)
224 for (event = pPlugin->m_Events.begin();
225 event != pPlugin->m_Events.end();
228 if ((*event).got_vsp)
232 (*event).got_vsp = true;
233 (*event).event->OnVSPListening(g_pRealVspCallbacks);
238 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
240 CPlugin *pl = FindById(id);
244 UTIL_Format(error, maxlen, "Plugin id not found");
250 if ( (ret=_Pause(pl, error, maxlen)) == true )
252 ITER_PLEVENT(OnPluginPause, pl->m_Id);
258 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
260 CPlugin *pl = FindById(id);
264 UTIL_Format(error, maxlen, "Plugin id not found");
270 if ( (ret=_Unpause(pl, error, maxlen)) == true )
272 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
278 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
280 CPlugin *pl = FindById(id);
284 UTIL_Format(error, maxlen, "Plugin %d not found", id);
289 PluginId old_id = pl->m_Id;
290 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
292 ITER_PLEVENT(OnPluginUnload, old_id);
298 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
302 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
304 if ( (*i) && (*i)->m_Id == id )
306 if ( (*i)->m_Status >= Pl_Paused)
308 UTIL_Format(error, len, "Plugin %d is already running.", id);
311 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
314 if (pl->m_Status >= Pl_Paused)
316 //Now it gets crazy... unload the original copy.
317 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
319 //Set the new copy's id
322 //We just wasted an id... reclaim it
327 //don't really care about the buffer here
328 _Unload(pl, true, buffer, sizeof(buffer)-1);
330 //We just wasted an id... reclaim it
337 UTIL_Format(error, len, "Plugin %d not found,", id);
341 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
345 //don't find bad plugins!
349 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
351 if ( (*i)->m_API == api )
358 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
368 pl->m_File.assign(file);
369 m_Plugins.push_back(pl);
372 //Check if the file even exists
373 fp = fopen(file, "r");
377 UTIL_Format(error, maxlen, "File not found: %s", file);
378 pl->m_Status = Pl_NotFound;
387 pl->m_Lib = dlmount(file);
391 UTIL_Format(error, maxlen, "[%d]", GetLastError());
392 pl->m_Status = Pl_Error;
394 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
398 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
399 pl->m_Status = Pl_Error;
401 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
405 UTIL_Format(error, maxlen, "Failed to get API");
406 pl->m_Status = Pl_Error;
408 int api = pl->m_API->GetApiVersion();
409 if (api < PLAPI_MIN_VERSION)
412 UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
413 pl->m_Status = Pl_Error;
414 } else if (api > PLAPI_VERSION) {
416 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
417 pl->m_Status = Pl_Error;
419 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
421 pl->m_Status = Pl_Running;
424 //API 4 is when we added this callback
425 //Removing this code as the min version is now 5
426 //if (pl->m_API->GetApiVersion() >= 4)
427 pl->m_API->AllPluginsLoaded();
429 if (g_bIsBridgedAsVsp)
431 SourceHook::List<CPluginEventHandler>::iterator event;
432 for (event = pl->m_Events.begin();
433 event != pl->m_Events.end();
436 if (pl->m_API->GetApiVersion() < 10 || (*event).got_vsp)
438 (*event).got_vsp = true;
439 (*event).event->OnVSPListening(g_pRealVspCallbacks);
443 pl->m_Status = Pl_Refused;
451 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
453 pl->m_Events.clear();
454 g_SourceHook.UnloadPlugin(pl->m_Id);
465 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
469 if (pl->m_API && pl->m_Lib)
471 //Note, we'll always tell the plugin it will be unloading...
472 if (pl->m_API->Unload(error, maxlen) || force)
474 //Make sure to detach it from sourcehook!
475 g_SourceHook.UnloadPlugin(pl->m_Id);
484 //Remove the plugin from the list
486 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
488 if ( (*i)->m_Id == pl->m_Id )
490 i = m_Plugins.erase(i);
500 //The plugin is not valid, and let's just remove it from the list anyway
502 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
504 if ( (*i)->m_Id == pl->m_Id )
506 i = m_Plugins.erase(i);
518 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
522 if (pl->m_Status != Pl_Running || !pl->m_API)
525 UTIL_Format(error, maxlen, "Plugin cannot be paused");
527 if (pl->m_API->Pause(error, maxlen))
529 g_SourceHook.PausePlugin(pl->m_Id);
530 pl->m_Status = Pl_Paused;
539 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
544 if (pl->m_Status != Pl_Paused || !pl->m_API)
547 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
549 if (pl->m_API->Unpause(error, maxlen))
551 g_SourceHook.UnpausePlugin(pl->m_Id);
552 pl->m_Status = Pl_Running;
561 bool CPluginManager::UnloadAll()
568 while ((i = m_Plugins.begin()) != m_Plugins.end())
570 if ( !_Unload( (*i), true, error, sizeof(error)) )
579 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
581 CPlugin *pl = FindById(id);
586 file = pl->m_File.c_str();
587 status = pl->m_Status;
588 source = pl->m_Source;
593 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
595 CPlugin *pl = FindById(id);
597 if (!pl || !pl->m_API)
600 UTIL_Format(error, maxlength, "Plugin not valid");
604 return pl->m_API->QueryRunning(error, maxlength);
607 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
609 CPlugin *pl = FindById(id);
616 handle = static_cast<void *>(pl->m_Lib);
621 PluginIter CPluginManager::_begin()
623 return m_Plugins.begin();
626 PluginIter CPluginManager::_end()
628 return m_Plugins.end();
631 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
633 CPlugin *pl = FindByAPI(api);
638 pl->m_Cvars.push_back(pCvar);
641 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
643 CPlugin *pl = FindByAPI(api);
648 pl->m_Cmds.push_back(pCmd);
651 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
653 CPlugin *pl = FindByAPI(api);
658 pl->m_Cvars.remove(pCvar);
661 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
663 CPlugin *pl = FindByAPI(api);
668 pl->m_Cmds.remove(pCmd);
671 void CPluginManager::UnregAllConCmds(CPlugin *pl)
673 SourceHook::List<ConCommandBase *>::iterator i;
675 for (i = pl->m_Cvars.begin(); i != pl->m_Cvars.end(); i++)
677 NotifyConCommandBaseDrop(pl->m_Id, (*i));
678 g_SMConVarAccessor.Unregister((*i));
683 for (i = pl->m_Cmds.begin(); i != pl->m_Cmds.end(); i++)
685 NotifyConCommandBaseDrop(pl->m_Id, (*i));
686 g_SMConVarAccessor.Unregister((*i));
692 const char *CPluginManager::GetStatusText(CPlugin *pl)
694 switch (pl->m_Status)
706 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
718 unsigned int CPluginManager::GetPluginCount()
720 return (unsigned int)m_Plugins.size();