1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2005 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 /*if (m_Plugins.size())
54 CPluginManager::CPlugin::CPlugin() : m_Lib(NULL), m_API(NULL), m_Id(0), m_Source(0)
59 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
64 //Check if we're about to reload an old plugin
65 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
67 if ( (*i) && (*i)->m_File.compare(file)==0 )
69 if ( (*i)->m_Status < Pl_Paused )
71 //Attempt to load the plugin again
73 i = m_Plugins.erase(i);
82 CPlugin *pl = _Load(file, source, error, maxlen);
87 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
92 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
96 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
98 if ( (*i)->m_Id == id )
105 void CPluginManager::SetAllLoaded()
110 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
112 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
114 //API 4 is when we added this callback
115 //Min version is now 5, so we ignore this check
116 //if ( (*i)->m_API->GetApiVersion() >= 004 )
117 (*i)->m_API->AllPluginsLoaded();
122 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
124 CPlugin *pl = FindById(id);
128 snprintf(error, maxlen, "Plugin id not found");
134 if ( (ret=_Pause(pl, error, maxlen)) == true )
136 ITER_PLEVENT(OnPluginPause, pl->m_Id);
142 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
144 CPlugin *pl = FindById(id);
148 snprintf(error, maxlen, "Plugin id not found");
154 if ( (ret=_Unpause(pl, error, maxlen)) == true )
156 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
162 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
164 CPlugin *pl = FindById(id);
168 snprintf(error, maxlen, "Plugin %d not found", id);
173 PluginId old_id = pl->m_Id;
174 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
176 ITER_PLEVENT(OnPluginUnload, old_id);
182 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
186 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
188 if ( (*i) && (*i)->m_Id == id )
190 if ( (*i)->m_Status >= Pl_Paused)
192 snprintf(error, len, "Plugin %d is already running.", id);
195 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
198 if (pl->m_Status >= Pl_Paused)
200 //Now it gets crazy... unload the original copy.
201 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
203 //Set the new copy's id
206 //We just wasted an id... reclaim it
211 //don't really care about the buffer here
212 _Unload(pl, true, buffer, sizeof(buffer)-1);
214 //We just wasted an id... reclaim it
221 snprintf(error, len, "Plugin %d not found,", id);
225 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
229 //don't find bad plugins!
233 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
235 if ( (*i)->m_API == api )
242 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
252 pl->m_File.assign(file);
253 m_Plugins.push_back(pl);
256 //Check if the file even exists
257 fp = fopen(file, "r");
261 snprintf(error, maxlen, "File not found: %s", file);
262 pl->m_Status = Pl_NotFound;
268 pl->m_Lib = dlmount(file);
272 snprintf(error, maxlen, "%s", dlerror());
273 pl->m_Status = Pl_Error;
275 CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
279 snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
280 pl->m_Status = Pl_Error;
282 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
286 snprintf(error, maxlen, "Failed to get API");
287 pl->m_Status = Pl_Error;
289 int api = pl->m_API->GetApiVersion();
290 if (api < PLAPI_MIN_VERSION)
293 snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
294 pl->m_Status = Pl_Error;
295 } else if (api > PLAPI_VERSION) {
297 snprintf(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
298 pl->m_Status = Pl_Error;
300 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
302 pl->m_Status = Pl_Running;
305 //API 4 is when we added this callback
306 //Removing this code as the min version is now 5
307 //if (pl->m_API->GetApiVersion() >= 4)
308 pl->m_API->AllPluginsLoaded();
311 pl->m_Status = Pl_Refused;
319 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
329 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
333 if (pl->m_API && pl->m_Lib)
335 //Note, we'll always tell the plugin it will be unloading...
336 if (pl->m_API->Unload(error, maxlen) || force)
338 //Make sure to detach it from sourcehook!
339 g_SourceHook.UnloadPlugin(pl->m_Id);
348 //Remove the plugin from the list
350 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
352 if ( (*i)->m_Id == pl->m_Id )
354 i = m_Plugins.erase(i);
364 //The plugin is not valid, and let's just remove it from the list anyway
366 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
368 if ( (*i)->m_Id == pl->m_Id )
370 i = m_Plugins.erase(i);
382 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
386 if (pl->m_Status != Pl_Running || !pl->m_API)
389 snprintf(error, maxlen, "Plugin cannot be paused");
391 if (pl->m_API->Pause(error, maxlen))
393 g_SourceHook.PausePlugin(pl->m_Id);
394 pl->m_Status = Pl_Paused;
403 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
408 if (pl->m_Status != Pl_Paused || !pl->m_API)
411 snprintf(error, maxlen, "Plugin cannot be unpaused");
413 if (pl->m_API->Unpause(error, maxlen))
415 g_SourceHook.UnpausePlugin(pl->m_Id);
416 pl->m_Status = Pl_Running;
425 bool CPluginManager::UnloadAll()
429 SourceHook::List<SourceMM::CPluginManager::CPlugin *> remqueue;
431 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
432 remqueue.push_back( (*i) );
437 for (i=remqueue.begin(); i!=remqueue.end(); i++)
439 if ( !_Unload( (*i), true, error, sizeof(error)-1) )
449 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
451 CPlugin *pl = FindById(id);
456 file = pl->m_File.c_str();
457 status = pl->m_Status;
458 source = pl->m_Source;
463 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
465 CPlugin *pl = FindById(id);
467 if (!pl || !pl->m_API)
470 snprintf(error, maxlength, "Plugin not valid");
474 return pl->m_API->QueryRunning(error, maxlength);
477 PluginIter CPluginManager::_begin()
479 return m_Plugins.begin();
482 PluginIter CPluginManager::_end()
484 return m_Plugins.end();
487 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
489 CPlugin *pl = FindByAPI(api);
494 pl->m_Cvars.push_back(pCvar);
497 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
499 CPlugin *pl = FindByAPI(api);
504 pl->m_Cmds.push_back(pCmd);
507 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
509 CPlugin *pl = FindByAPI(api);
514 pl->m_Cvars.remove(pCvar);
517 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
519 CPlugin *pl = FindByAPI(api);
524 pl->m_Cmds.remove(pCmd);
527 void CPluginManager::UnregAllConCmds(CPlugin *pl)
529 SourceHook::List<ConCommandBase *>::iterator i;
531 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
532 g_SMConVarAccessor.Unregister( (*i) );
536 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
537 g_SMConVarAccessor.Unregister( (*i) );