Fixed circular dependency between sourcemm.h/util.h (build bustage).
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2008 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
14 #include "concommands.h"
15 #include "vsp_listener.h"
19 * @brief Implements functions from CPlugin.h
23 using namespace SourceMM;
25 #define ITER_PLEVENT(evn, plid) \
26 CPluginManager::CPlugin *_Xpl; \
27 SourceHook::List<CPluginEventHandler>::iterator event; \
28 IMetamodListener *api; \
29 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
31 if (_Xpl->m_Id == plid) \
33 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
34 api = (*event).event; \
39 CPluginManager g_PluginMngr;
41 CPluginManager::CPluginManager()
47 CPluginManager::~CPluginManager()
49 SourceHook::List<CNameAlias *>::iterator iter;
51 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
59 const char *CPluginManager::LookupAlias(const char *alias)
61 SourceHook::List<CNameAlias *>::iterator iter;
64 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
67 if (p->alias.compare(alias) == 0)
69 return p->value.c_str();
76 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
78 return m_Aliases.begin();
81 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
83 return m_Aliases.end();
86 void CPluginManager::SetAlias(const char *alias, const char *value)
88 SourceHook::List<CNameAlias *>::iterator iter;
91 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
94 if (p->alias.compare(alias) == 0)
98 iter = m_Aliases.erase(iter);
101 p->value.assign(value);
107 if (value[0] != '\0')
111 p->alias.assign(alias);
112 p->value.assign(value);
114 m_Aliases.push_back(p);
118 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
123 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
126 //Check if we're about to reload an old plugin
127 PluginIter i = m_Plugins.begin();
128 while (i != m_Plugins.end())
130 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
132 if ( (*i)->m_Status < Pl_Paused )
134 //Attempt to load the plugin again
136 i = m_Plugins.erase(i);
147 CPlugin *pl = _Load(file, source, error, maxlen);
152 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
157 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
161 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
163 if ( (*i)->m_Id == id )
170 void CPluginManager::SetAllLoaded()
175 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
177 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
179 //API 4 is when we added this callback
180 //Min version is now 5, so we ignore this check
181 //if ( (*i)->m_API->GetApiVersion() >= 004 )
182 (*i)->m_API->AllPluginsLoaded();
187 void CPluginManager::SetVSPAsLoaded()
191 SourceHook::List<CPluginEventHandler>::iterator event;
193 for (i = m_Plugins.begin(); i != m_Plugins.end(); i++)
196 if (pPlugin->m_Status < Pl_Paused)
200 /* Only valid for plugins >= 10 (v1:5, SourceMM 1.4) */
201 if (pPlugin->m_API->GetApiVersion() < 10)
205 for (event = pPlugin->m_Events.begin();
206 event != pPlugin->m_Events.end();
209 if ((*event).got_vsp)
213 (*event).got_vsp = true;
214 (*event).event->OnVSPListening(g_pRealVspCallbacks);
219 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
221 CPlugin *pl = FindById(id);
225 UTIL_Format(error, maxlen, "Plugin id not found");
231 if ( (ret=_Pause(pl, error, maxlen)) == true )
233 ITER_PLEVENT(OnPluginPause, pl->m_Id);
239 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
241 CPlugin *pl = FindById(id);
245 UTIL_Format(error, maxlen, "Plugin id not found");
251 if ( (ret=_Unpause(pl, error, maxlen)) == true )
253 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
259 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
261 CPlugin *pl = FindById(id);
265 UTIL_Format(error, maxlen, "Plugin %d not found", id);
270 PluginId old_id = pl->m_Id;
271 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
273 ITER_PLEVENT(OnPluginUnload, old_id);
279 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
283 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
285 if ( (*i) && (*i)->m_Id == id )
287 if ( (*i)->m_Status >= Pl_Paused)
289 UTIL_Format(error, len, "Plugin %d is already running.", id);
292 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
295 if (pl->m_Status >= Pl_Paused)
297 //Now it gets crazy... unload the original copy.
298 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
300 //Set the new copy's id
303 //We just wasted an id... reclaim it
308 //don't really care about the buffer here
309 _Unload(pl, true, buffer, sizeof(buffer)-1);
311 //We just wasted an id... reclaim it
318 UTIL_Format(error, len, "Plugin %d not found,", id);
322 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
326 //don't find bad plugins!
330 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
332 if ( (*i)->m_API == api )
339 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
349 pl->m_File.assign(file);
350 m_Plugins.push_back(pl);
353 //Check if the file even exists
354 fp = fopen(file, "r");
358 UTIL_Format(error, maxlen, "File not found: %s", file);
359 pl->m_Status = Pl_NotFound;
368 pl->m_Lib = dlmount(file);
372 UTIL_Format(error, maxlen, "[%d]", GetLastError());
373 pl->m_Status = Pl_Error;
375 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
379 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
380 pl->m_Status = Pl_Error;
382 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
386 UTIL_Format(error, maxlen, "Failed to get API");
387 pl->m_Status = Pl_Error;
389 int api = pl->m_API->GetApiVersion();
390 if (api < PLAPI_MIN_VERSION)
393 UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
394 pl->m_Status = Pl_Error;
395 } else if (api > PLAPI_VERSION) {
397 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
398 pl->m_Status = Pl_Error;
400 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
402 pl->m_Status = Pl_Running;
405 //API 4 is when we added this callback
406 //Removing this code as the min version is now 5
407 //if (pl->m_API->GetApiVersion() >= 4)
408 pl->m_API->AllPluginsLoaded();
410 if (g_bIsBridgedAsVsp ||
411 (g_VspListener.IsLoaded() && g_SmmAPI.VSPEnabled()))
413 SourceHook::List<CPluginEventHandler>::iterator event;
414 for (event = pl->m_Events.begin();
415 event != pl->m_Events.end();
418 if (pl->m_API->GetApiVersion() < 10 || (*event).got_vsp)
420 (*event).got_vsp = true;
421 (*event).event->OnVSPListening(g_pRealVspCallbacks);
425 pl->m_Status = Pl_Refused;
433 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
435 pl->m_Events.clear();
436 g_SourceHook.UnloadPlugin(pl->m_Id);
447 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
451 if (pl->m_API && pl->m_Lib)
453 //Note, we'll always tell the plugin it will be unloading...
454 if (pl->m_API->Unload(error, maxlen) || force)
456 //Make sure to detach it from sourcehook!
457 g_SourceHook.UnloadPlugin(pl->m_Id);
466 //Remove the plugin from the list
468 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
470 if ( (*i)->m_Id == pl->m_Id )
472 i = m_Plugins.erase(i);
482 //The plugin is not valid, and let's just remove it from the list anyway
484 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
486 if ( (*i)->m_Id == pl->m_Id )
488 i = m_Plugins.erase(i);
500 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
504 if (pl->m_Status != Pl_Running || !pl->m_API)
507 UTIL_Format(error, maxlen, "Plugin cannot be paused");
509 if (pl->m_API->Pause(error, maxlen))
511 g_SourceHook.PausePlugin(pl->m_Id);
512 pl->m_Status = Pl_Paused;
521 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
526 if (pl->m_Status != Pl_Paused || !pl->m_API)
529 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
531 if (pl->m_API->Unpause(error, maxlen))
533 g_SourceHook.UnpausePlugin(pl->m_Id);
534 pl->m_Status = Pl_Running;
543 bool CPluginManager::UnloadAll()
550 while ((i = m_Plugins.begin()) != m_Plugins.end())
552 if ( !_Unload( (*i), true, error, sizeof(error)) )
561 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
563 CPlugin *pl = FindById(id);
568 file = pl->m_File.c_str();
569 status = pl->m_Status;
570 source = pl->m_Source;
575 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
577 CPlugin *pl = FindById(id);
579 if (!pl || !pl->m_API)
582 UTIL_Format(error, maxlength, "Plugin not valid");
586 return pl->m_API->QueryRunning(error, maxlength);
589 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
591 CPlugin *pl = FindById(id);
598 handle = static_cast<void *>(pl->m_Lib);
603 PluginIter CPluginManager::_begin()
605 return m_Plugins.begin();
608 PluginIter CPluginManager::_end()
610 return m_Plugins.end();
613 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
615 CPlugin *pl = FindByAPI(api);
620 pl->m_Cvars.push_back(pCvar);
623 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
625 CPlugin *pl = FindByAPI(api);
630 pl->m_Cmds.push_back(pCmd);
633 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
635 CPlugin *pl = FindByAPI(api);
640 pl->m_Cvars.remove(pCvar);
643 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
645 CPlugin *pl = FindByAPI(api);
650 pl->m_Cmds.remove(pCmd);
653 void CPluginManager::UnregAllConCmds(CPlugin *pl)
655 SourceHook::List<ConCommandBase *>::iterator i;
657 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
658 g_SMConVarAccessor.Unregister( (*i) );
662 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
663 g_SMConVarAccessor.Unregister( (*i) );
668 const char *CPluginManager::GetStatusText(CPlugin *pl)
670 switch (pl->m_Status)
682 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
694 unsigned int CPluginManager::GetPluginCount()
696 return (unsigned int)m_Plugins.size();