Bumped all versions.
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"
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 CPluginManager::CPluginManager()
46 CPluginManager::~CPluginManager()
48 SourceHook::List<CNameAlias *>::iterator iter;
50 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
58 const char *CPluginManager::LookupAlias(const char *alias)
60 SourceHook::List<CNameAlias *>::iterator iter;
63 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
66 if (p->alias.compare(alias) == 0)
68 return p->value.c_str();
75 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
77 return m_Aliases.begin();
80 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
82 return m_Aliases.end();
85 void CPluginManager::SetAlias(const char *alias, const char *value)
87 SourceHook::List<CNameAlias *>::iterator iter;
90 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
93 if (p->alias.compare(alias) == 0)
97 iter = m_Aliases.erase(iter);
100 p->value.assign(value);
106 if (value[0] != '\0')
110 p->alias.assign(alias);
111 p->value.assign(value);
113 m_Aliases.push_back(p);
117 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
122 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
125 //Check if we're about to reload an old plugin
126 PluginIter i = m_Plugins.begin();
127 while (i != m_Plugins.end())
129 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
131 if ( (*i)->m_Status < Pl_Paused )
133 //Attempt to load the plugin again
135 i = m_Plugins.erase(i);
146 CPlugin *pl = _Load(file, source, error, maxlen);
151 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
156 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
160 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
162 if ( (*i)->m_Id == id )
169 void CPluginManager::SetAllLoaded()
174 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
176 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
178 //API 4 is when we added this callback
179 //Min version is now 5, so we ignore this check
180 //if ( (*i)->m_API->GetApiVersion() >= 004 )
181 (*i)->m_API->AllPluginsLoaded();
186 void CPluginManager::SetVSPAsLoaded()
190 SourceHook::List<CPluginEventHandler>::iterator event;
192 for (i = m_Plugins.begin(); i != m_Plugins.end(); i++)
195 if (pPlugin->m_Status < Pl_Paused)
199 /* Only valid for plugins >= 10 (v1:5, SourceMM 1.4) */
200 if (pPlugin->m_API->GetApiVersion() < 10)
204 for (event = pPlugin->m_Events.begin();
205 event != pPlugin->m_Events.end();
208 if ((*event).got_vsp)
212 (*event).got_vsp = true;
213 (*event).event->OnVSPListening(g_pRealVspCallbacks);
218 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
220 CPlugin *pl = FindById(id);
224 UTIL_Format(error, maxlen, "Plugin id not found");
230 if ( (ret=_Pause(pl, error, maxlen)) == true )
232 ITER_PLEVENT(OnPluginPause, pl->m_Id);
238 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
240 CPlugin *pl = FindById(id);
244 UTIL_Format(error, maxlen, "Plugin id not found");
250 if ( (ret=_Unpause(pl, error, maxlen)) == true )
252 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
258 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
260 CPlugin *pl = FindById(id);
264 UTIL_Format(error, maxlen, "Plugin %d not found", id);
269 PluginId old_id = pl->m_Id;
270 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
272 ITER_PLEVENT(OnPluginUnload, old_id);
278 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
282 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
284 if ( (*i) && (*i)->m_Id == id )
286 if ( (*i)->m_Status >= Pl_Paused)
288 UTIL_Format(error, len, "Plugin %d is already running.", id);
291 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
294 if (pl->m_Status >= Pl_Paused)
296 //Now it gets crazy... unload the original copy.
297 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
299 //Set the new copy's id
302 //We just wasted an id... reclaim it
307 //don't really care about the buffer here
308 _Unload(pl, true, buffer, sizeof(buffer)-1);
310 //We just wasted an id... reclaim it
317 UTIL_Format(error, len, "Plugin %d not found,", id);
321 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
325 //don't find bad plugins!
329 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
331 if ( (*i)->m_API == api )
338 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
348 pl->m_File.assign(file);
349 m_Plugins.push_back(pl);
352 //Check if the file even exists
353 fp = fopen(file, "r");
357 UTIL_Format(error, maxlen, "File not found: %s", file);
358 pl->m_Status = Pl_NotFound;
367 pl->m_Lib = dlmount(file);
371 UTIL_Format(error, maxlen, "[%d]", GetLastError());
372 pl->m_Status = Pl_Error;
374 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
378 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
379 pl->m_Status = Pl_Error;
381 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
385 UTIL_Format(error, maxlen, "Failed to get API");
386 pl->m_Status = Pl_Error;
388 int api = pl->m_API->GetApiVersion();
389 if (api < PLAPI_MIN_VERSION)
392 UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
393 pl->m_Status = Pl_Error;
394 } else if (api > PLAPI_VERSION) {
396 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
397 pl->m_Status = Pl_Error;
399 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
401 pl->m_Status = Pl_Running;
404 //API 4 is when we added this callback
405 //Removing this code as the min version is now 5
406 //if (pl->m_API->GetApiVersion() >= 4)
407 pl->m_API->AllPluginsLoaded();
409 if (g_bIsBridgedAsVsp ||
410 (g_VspListener.IsLoaded() && g_SmmAPI.VSPEnabled()))
412 SourceHook::List<CPluginEventHandler>::iterator event;
413 for (event = pl->m_Events.begin();
414 event != pl->m_Events.end();
417 if (pl->m_API->GetApiVersion() < 10 || (*event).got_vsp)
419 (*event).got_vsp = true;
420 (*event).event->OnVSPListening(g_pRealVspCallbacks);
424 pl->m_Status = Pl_Refused;
432 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
434 pl->m_Events.clear();
435 g_SourceHook.UnloadPlugin(pl->m_Id);
446 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
450 if (pl->m_API && pl->m_Lib)
452 //Note, we'll always tell the plugin it will be unloading...
453 if (pl->m_API->Unload(error, maxlen) || force)
455 //Make sure to detach it from sourcehook!
456 g_SourceHook.UnloadPlugin(pl->m_Id);
465 //Remove the plugin from the list
467 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
469 if ( (*i)->m_Id == pl->m_Id )
471 i = m_Plugins.erase(i);
481 //The plugin is not valid, and let's just remove it from the list anyway
483 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
485 if ( (*i)->m_Id == pl->m_Id )
487 i = m_Plugins.erase(i);
499 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
503 if (pl->m_Status != Pl_Running || !pl->m_API)
506 UTIL_Format(error, maxlen, "Plugin cannot be paused");
508 if (pl->m_API->Pause(error, maxlen))
510 g_SourceHook.PausePlugin(pl->m_Id);
511 pl->m_Status = Pl_Paused;
520 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
525 if (pl->m_Status != Pl_Paused || !pl->m_API)
528 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
530 if (pl->m_API->Unpause(error, maxlen))
532 g_SourceHook.UnpausePlugin(pl->m_Id);
533 pl->m_Status = Pl_Running;
542 bool CPluginManager::UnloadAll()
549 while ((i = m_Plugins.begin()) != m_Plugins.end())
551 if ( !_Unload( (*i), true, error, sizeof(error)) )
560 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
562 CPlugin *pl = FindById(id);
567 file = pl->m_File.c_str();
568 status = pl->m_Status;
569 source = pl->m_Source;
574 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
576 CPlugin *pl = FindById(id);
578 if (!pl || !pl->m_API)
581 UTIL_Format(error, maxlength, "Plugin not valid");
585 return pl->m_API->QueryRunning(error, maxlength);
588 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
590 CPlugin *pl = FindById(id);
597 handle = static_cast<void *>(pl->m_Lib);
602 PluginIter CPluginManager::_begin()
604 return m_Plugins.begin();
607 PluginIter CPluginManager::_end()
609 return m_Plugins.end();
612 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
614 CPlugin *pl = FindByAPI(api);
619 pl->m_Cvars.push_back(pCvar);
622 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
624 CPlugin *pl = FindByAPI(api);
629 pl->m_Cmds.push_back(pCmd);
632 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
634 CPlugin *pl = FindByAPI(api);
639 pl->m_Cvars.remove(pCvar);
642 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
644 CPlugin *pl = FindByAPI(api);
649 pl->m_Cmds.remove(pCmd);
652 void CPluginManager::UnregAllConCmds(CPlugin *pl)
654 SourceHook::List<ConCommandBase *>::iterator i;
656 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
657 g_SMConVarAccessor.Unregister( (*i) );
661 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
662 g_SMConVarAccessor.Unregister( (*i) );
667 const char *CPluginManager::GetStatusText(CPlugin *pl)
669 switch (pl->m_Status)
681 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
693 unsigned int CPluginManager::GetPluginCount()
695 return (unsigned int)m_Plugins.size();