1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2006 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)
62 //Check if we're about to reload an old plugin
63 PluginIter i = m_Plugins.begin();
64 while (i != m_Plugins.end())
66 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
68 if ( (*i)->m_Status < Pl_Paused )
70 //Attempt to load the plugin again
72 i = m_Plugins.erase(i);
83 CPlugin *pl = _Load(file, source, error, maxlen);
88 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
93 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
97 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
99 if ( (*i)->m_Id == id )
106 void CPluginManager::SetAllLoaded()
111 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
113 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
115 //API 4 is when we added this callback
116 //Min version is now 5, so we ignore this check
117 //if ( (*i)->m_API->GetApiVersion() >= 004 )
118 (*i)->m_API->AllPluginsLoaded();
123 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
125 CPlugin *pl = FindById(id);
129 snprintf(error, maxlen, "Plugin id not found");
135 if ( (ret=_Pause(pl, error, maxlen)) == true )
137 ITER_PLEVENT(OnPluginPause, pl->m_Id);
143 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
145 CPlugin *pl = FindById(id);
149 snprintf(error, maxlen, "Plugin id not found");
155 if ( (ret=_Unpause(pl, error, maxlen)) == true )
157 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
163 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
165 CPlugin *pl = FindById(id);
169 snprintf(error, maxlen, "Plugin %d not found", id);
174 PluginId old_id = pl->m_Id;
175 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
177 ITER_PLEVENT(OnPluginUnload, old_id);
183 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
187 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
189 if ( (*i) && (*i)->m_Id == id )
191 if ( (*i)->m_Status >= Pl_Paused)
193 snprintf(error, len, "Plugin %d is already running.", id);
196 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
199 if (pl->m_Status >= Pl_Paused)
201 //Now it gets crazy... unload the original copy.
202 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
204 //Set the new copy's id
207 //We just wasted an id... reclaim it
212 //don't really care about the buffer here
213 _Unload(pl, true, buffer, sizeof(buffer)-1);
215 //We just wasted an id... reclaim it
222 snprintf(error, len, "Plugin %d not found,", id);
226 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
230 //don't find bad plugins!
234 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
236 if ( (*i)->m_API == api )
243 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
253 pl->m_File.assign(file);
254 m_Plugins.push_back(pl);
257 //Check if the file even exists
258 fp = fopen(file, "r");
262 snprintf(error, maxlen, "File not found: %s", file);
263 pl->m_Status = Pl_NotFound;
269 pl->m_Lib = dlmount(file);
273 snprintf(error, maxlen, "%s", dlerror());
274 pl->m_Status = Pl_Error;
276 CreateInterfaceFn pfn = reinterpret_cast<CreateInterfaceFn>(dlsym(pl->m_Lib, PL_EXPOSURE_C));
280 snprintf(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
281 pl->m_Status = Pl_Error;
283 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
287 snprintf(error, maxlen, "Failed to get API");
288 pl->m_Status = Pl_Error;
290 int api = pl->m_API->GetApiVersion();
291 if (api < PLAPI_MIN_VERSION)
294 snprintf(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
295 pl->m_Status = Pl_Error;
296 } else if (api > PLAPI_VERSION) {
298 snprintf(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
299 pl->m_Status = Pl_Error;
301 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
303 pl->m_Status = Pl_Running;
306 //API 4 is when we added this callback
307 //Removing this code as the min version is now 5
308 //if (pl->m_API->GetApiVersion() >= 4)
309 pl->m_API->AllPluginsLoaded();
312 pl->m_Status = Pl_Refused;
320 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
330 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
334 if (pl->m_API && pl->m_Lib)
336 //Note, we'll always tell the plugin it will be unloading...
337 if (pl->m_API->Unload(error, maxlen) || force)
339 //Make sure to detach it from sourcehook!
340 g_SourceHook.UnloadPlugin(pl->m_Id);
349 //Remove the plugin from the list
351 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
353 if ( (*i)->m_Id == pl->m_Id )
355 i = m_Plugins.erase(i);
365 //The plugin is not valid, and let's just remove it from the list anyway
367 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
369 if ( (*i)->m_Id == pl->m_Id )
371 i = m_Plugins.erase(i);
383 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
387 if (pl->m_Status != Pl_Running || !pl->m_API)
390 snprintf(error, maxlen, "Plugin cannot be paused");
392 if (pl->m_API->Pause(error, maxlen))
394 g_SourceHook.PausePlugin(pl->m_Id);
395 pl->m_Status = Pl_Paused;
404 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
409 if (pl->m_Status != Pl_Paused || !pl->m_API)
412 snprintf(error, maxlen, "Plugin cannot be unpaused");
414 if (pl->m_API->Unpause(error, maxlen))
416 g_SourceHook.UnpausePlugin(pl->m_Id);
417 pl->m_Status = Pl_Running;
426 bool CPluginManager::UnloadAll()
430 SourceHook::List<SourceMM::CPluginManager::CPlugin *> remqueue;
432 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
433 remqueue.push_back( (*i) );
438 for (i=remqueue.begin(); i!=remqueue.end(); i++)
440 if ( !_Unload( (*i), true, error, sizeof(error)-1) )
450 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
452 CPlugin *pl = FindById(id);
457 file = pl->m_File.c_str();
458 status = pl->m_Status;
459 source = pl->m_Source;
464 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
466 CPlugin *pl = FindById(id);
468 if (!pl || !pl->m_API)
471 snprintf(error, maxlength, "Plugin not valid");
475 return pl->m_API->QueryRunning(error, maxlength);
478 PluginIter CPluginManager::_begin()
480 return m_Plugins.begin();
483 PluginIter CPluginManager::_end()
485 return m_Plugins.end();
488 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
490 CPlugin *pl = FindByAPI(api);
495 pl->m_Cvars.push_back(pCvar);
498 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
500 CPlugin *pl = FindByAPI(api);
505 pl->m_Cmds.push_back(pCmd);
508 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
510 CPlugin *pl = FindByAPI(api);
515 pl->m_Cvars.remove(pCvar);
518 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
520 CPlugin *pl = FindByAPI(api);
525 pl->m_Cmds.remove(pCmd);
528 void CPluginManager::UnregAllConCmds(CPlugin *pl)
530 SourceHook::List<ConCommandBase *>::iterator i;
532 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
533 g_SMConVarAccessor.Unregister( (*i) );
537 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
538 g_SMConVarAccessor.Unregister( (*i) );