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 PluginIter iter = m_Plugins.begin();
66 PluginIter end = m_Plugins.end();
69 if ( (*i) && (*i)->m_File.compare(file)==0 )
71 if ( (*i)->m_Status < Pl_Paused )
73 //Attempt to load the plugin again
75 i = m_Plugins.erase(i);
86 CPlugin *pl = _Load(file, source, error, maxlen);
91 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
96 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
100 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
102 if ( (*i)->m_Id == id )
109 void CPluginManager::SetAllLoaded()
114 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
116 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
118 //API 4 is when we added this callback
119 //Min version is now 5, so we ignore this check
120 //if ( (*i)->m_API->GetApiVersion() >= 004 )
121 (*i)->m_API->AllPluginsLoaded();
126 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
128 CPlugin *pl = FindById(id);
132 snprintf(error, maxlen, "Plugin id not found");
138 if ( (ret=_Pause(pl, error, maxlen)) == true )
140 ITER_PLEVENT(OnPluginPause, pl->m_Id);
146 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
148 CPlugin *pl = FindById(id);
152 snprintf(error, maxlen, "Plugin id not found");
158 if ( (ret=_Unpause(pl, error, maxlen)) == true )
160 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
166 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
168 CPlugin *pl = FindById(id);
172 snprintf(error, maxlen, "Plugin %d not found", id);
177 PluginId old_id = pl->m_Id;
178 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
180 ITER_PLEVENT(OnPluginUnload, old_id);
186 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
190 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
192 if ( (*i) && (*i)->m_Id == id )
194 if ( (*i)->m_Status >= Pl_Paused)
196 snprintf(error, len, "Plugin %d is already running.", id);
199 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
202 if (pl->m_Status >= Pl_Paused)
204 //Now it gets crazy... unload the original copy.
205 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
207 //Set the new copy's id
210 //We just wasted an id... reclaim it
215 //don't really care about the buffer here
216 _Unload(pl, true, buffer, sizeof(buffer)-1);
218 //We just wasted an id... reclaim it
225 snprintf(error, len, "Plugin %d not found,", id);
229 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
233 //don't find bad plugins!
237 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
239 if ( (*i)->m_API == api )
246 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
256 pl->m_File.assign(file);
257 m_Plugins.push_back(pl);
260 //Check if the file even exists
261 fp = fopen(file, "r");
265 snprintf(error, maxlen, "File not found: %s", file);
266 pl->m_Status = Pl_NotFound;
272 pl->m_Lib = dlmount(file);
276 snprintf(error, maxlen, "%s", dlerror());
277 pl->m_Status = Pl_Error;
279 CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
283 snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
284 pl->m_Status = Pl_Error;
286 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
290 snprintf(error, maxlen, "Failed to get API");
291 pl->m_Status = Pl_Error;
293 int api = pl->m_API->GetApiVersion();
294 if (api < PLAPI_MIN_VERSION)
297 snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
298 pl->m_Status = Pl_Error;
299 } else if (api > PLAPI_VERSION) {
301 snprintf(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
302 pl->m_Status = Pl_Error;
304 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
306 pl->m_Status = Pl_Running;
309 //API 4 is when we added this callback
310 //Removing this code as the min version is now 5
311 //if (pl->m_API->GetApiVersion() >= 4)
312 pl->m_API->AllPluginsLoaded();
315 pl->m_Status = Pl_Refused;
323 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
333 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
337 if (pl->m_API && pl->m_Lib)
339 //Note, we'll always tell the plugin it will be unloading...
340 if (pl->m_API->Unload(error, maxlen) || force)
342 //Make sure to detach it from sourcehook!
343 g_SourceHook.UnloadPlugin(pl->m_Id);
352 //Remove the plugin from the list
354 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
356 if ( (*i)->m_Id == pl->m_Id )
358 i = m_Plugins.erase(i);
368 //The plugin is not valid, and let's just remove it from the list anyway
370 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
372 if ( (*i)->m_Id == pl->m_Id )
374 i = m_Plugins.erase(i);
386 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
390 if (pl->m_Status != Pl_Running || !pl->m_API)
393 snprintf(error, maxlen, "Plugin cannot be paused");
395 if (pl->m_API->Pause(error, maxlen))
397 g_SourceHook.PausePlugin(pl->m_Id);
398 pl->m_Status = Pl_Paused;
407 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
412 if (pl->m_Status != Pl_Paused || !pl->m_API)
415 snprintf(error, maxlen, "Plugin cannot be unpaused");
417 if (pl->m_API->Unpause(error, maxlen))
419 g_SourceHook.UnpausePlugin(pl->m_Id);
420 pl->m_Status = Pl_Running;
429 bool CPluginManager::UnloadAll()
433 SourceHook::List<SourceMM::CPluginManager::CPlugin *> remqueue;
435 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
436 remqueue.push_back( (*i) );
441 for (i=remqueue.begin(); i!=remqueue.end(); i++)
443 if ( !_Unload( (*i), true, error, sizeof(error)-1) )
453 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
455 CPlugin *pl = FindById(id);
460 file = pl->m_File.c_str();
461 status = pl->m_Status;
462 source = pl->m_Source;
467 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
469 CPlugin *pl = FindById(id);
471 if (!pl || !pl->m_API)
474 snprintf(error, maxlength, "Plugin not valid");
478 return pl->m_API->QueryRunning(error, maxlength);
481 PluginIter CPluginManager::_begin()
483 return m_Plugins.begin();
486 PluginIter CPluginManager::_end()
488 return m_Plugins.end();
491 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
493 CPlugin *pl = FindByAPI(api);
498 pl->m_Cvars.push_back(pCvar);
501 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
503 CPlugin *pl = FindByAPI(api);
508 pl->m_Cmds.push_back(pCmd);
511 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
513 CPlugin *pl = FindByAPI(api);
518 pl->m_Cvars.remove(pCvar);
521 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
523 CPlugin *pl = FindByAPI(api);
528 pl->m_Cmds.remove(pCmd);
531 void CPluginManager::UnregAllConCmds(CPlugin *pl)
533 SourceHook::List<ConCommandBase *>::iterator i;
535 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
536 g_SMConVarAccessor.Unregister( (*i) );
540 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
541 g_SMConVarAccessor.Unregister( (*i) );