Merge.
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 void NotifyConCommandBaseDrop(PluginId id, ConCommandBase *base)
43 CPluginManager::CPlugin *pl;
44 SourceHook::List<CPluginEventHandler>::iterator event;
45 IMetamodListener *api;
46 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++)
49 if (pl->m_Status < Pl_Paused)
51 if (pl->m_API->GetApiVersion() < 11)
53 for (event = pl->m_Events.begin(); event != pl->m_Events.end(); event++)
56 api->OnUnlinkConCommandBase(id, base);
61 CPluginManager::CPluginManager()
67 CPluginManager::~CPluginManager()
69 SourceHook::List<CNameAlias *>::iterator iter;
71 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
79 const char *CPluginManager::LookupAlias(const char *alias)
81 SourceHook::List<CNameAlias *>::iterator iter;
84 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
87 if (p->alias.compare(alias) == 0)
89 return p->value.c_str();
96 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_begin()
98 return m_Aliases.begin();
101 SourceHook::List<SourceMM::CNameAlias *>::iterator CPluginManager::_alias_end()
103 return m_Aliases.end();
106 void CPluginManager::SetAlias(const char *alias, const char *value)
108 SourceHook::List<CNameAlias *>::iterator iter;
111 for (iter=m_Aliases.begin(); iter!=m_Aliases.end(); iter++)
114 if (p->alias.compare(alias) == 0)
116 if (value[0] == '\0')
118 iter = m_Aliases.erase(iter);
121 p->value.assign(value);
127 if (value[0] != '\0')
131 p->alias.assign(alias);
132 p->value.assign(value);
134 m_Aliases.push_back(p);
138 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL)
143 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
146 //Check if we're about to reload an old plugin
147 PluginIter i = m_Plugins.begin();
148 while (i != m_Plugins.end())
150 if ( (*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()) )
152 if ( (*i)->m_Status < Pl_Paused )
154 //Attempt to load the plugin again
156 i = m_Plugins.erase(i);
167 CPlugin *pl = _Load(file, source, error, maxlen);
172 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
177 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
181 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
183 if ( (*i)->m_Id == id )
190 void CPluginManager::SetAllLoaded()
195 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
197 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
199 //API 4 is when we added this callback
200 //Min version is now 5, so we ignore this check
201 //if ( (*i)->m_API->GetApiVersion() >= 004 )
202 (*i)->m_API->AllPluginsLoaded();
207 void CPluginManager::SetVSPAsLoaded()
211 SourceHook::List<CPluginEventHandler>::iterator event;
213 for (i = m_Plugins.begin(); i != m_Plugins.end(); i++)
216 if (pPlugin->m_Status < Pl_Paused)
220 /* Only valid for plugins >= 10 (v1:5, SourceMM 1.4) */
221 if (pPlugin->m_API->GetApiVersion() < 10)
225 for (event = pPlugin->m_Events.begin();
226 event != pPlugin->m_Events.end();
229 if ((*event).got_vsp)
233 (*event).got_vsp = true;
234 (*event).event->OnVSPListening(g_pRealVspCallbacks);
239 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
241 CPlugin *pl = FindById(id);
245 UTIL_Format(error, maxlen, "Plugin id not found");
251 if ( (ret=_Pause(pl, error, maxlen)) == true )
253 ITER_PLEVENT(OnPluginPause, pl->m_Id);
259 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
261 CPlugin *pl = FindById(id);
265 UTIL_Format(error, maxlen, "Plugin id not found");
271 if ( (ret=_Unpause(pl, error, maxlen)) == true )
273 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
279 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
281 CPlugin *pl = FindById(id);
285 UTIL_Format(error, maxlen, "Plugin %d not found", id);
290 PluginId old_id = pl->m_Id;
291 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
293 ITER_PLEVENT(OnPluginUnload, old_id);
299 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
303 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
305 if ( (*i) && (*i)->m_Id == id )
307 if ( (*i)->m_Status >= Pl_Paused)
309 UTIL_Format(error, len, "Plugin %d is already running.", id);
312 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
315 if (pl->m_Status >= Pl_Paused)
317 //Now it gets crazy... unload the original copy.
318 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
320 //Set the new copy's id
323 //We just wasted an id... reclaim it
328 //don't really care about the buffer here
329 _Unload(pl, true, buffer, sizeof(buffer)-1);
331 //We just wasted an id... reclaim it
338 UTIL_Format(error, len, "Plugin %d not found,", id);
342 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
346 //don't find bad plugins!
350 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
352 if ( (*i)->m_API == api )
359 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
369 pl->m_File.assign(file);
370 m_Plugins.push_back(pl);
373 //Check if the file even exists
374 fp = fopen(file, "r");
378 UTIL_Format(error, maxlen, "File not found: %s", file);
379 pl->m_Status = Pl_NotFound;
388 pl->m_Lib = dlmount(file);
392 UTIL_Format(error, maxlen, "[%d]", GetLastError());
393 pl->m_Status = Pl_Error;
395 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
399 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
400 pl->m_Status = Pl_Error;
402 pl->m_API = static_cast<ISmmPlugin *>((pfn)(PLAPI_NAME, NULL));
406 UTIL_Format(error, maxlen, "Failed to get API");
407 pl->m_Status = Pl_Error;
409 int api = pl->m_API->GetApiVersion();
410 if (api < PLAPI_MIN_VERSION)
413 UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION);
414 pl->m_Status = Pl_Error;
415 } else if (api > PLAPI_VERSION) {
417 UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION);
418 pl->m_Status = Pl_Error;
420 if (pl->m_API->Load(pl->m_Id, static_cast<ISmmAPI *>(&g_SmmAPI), error, maxlen, m_AllLoaded))
422 pl->m_Status = Pl_Running;
425 //API 4 is when we added this callback
426 //Removing this code as the min version is now 5
427 //if (pl->m_API->GetApiVersion() >= 4)
428 pl->m_API->AllPluginsLoaded();
430 if (g_bIsBridgedAsVsp ||
431 (g_VspListener.IsLoaded() && g_SmmAPI.VSPEnabled()))
433 SourceHook::List<CPluginEventHandler>::iterator event;
434 for (event = pl->m_Events.begin();
435 event != pl->m_Events.end();
438 if (pl->m_API->GetApiVersion() < 10 || (*event).got_vsp)
440 (*event).got_vsp = true;
441 (*event).event->OnVSPListening(g_pRealVspCallbacks);
445 pl->m_Status = Pl_Refused;
453 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
455 pl->m_Events.clear();
456 g_SourceHook.UnloadPlugin(pl->m_Id);
467 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
471 if (pl->m_API && pl->m_Lib)
473 //Note, we'll always tell the plugin it will be unloading...
474 if (pl->m_API->Unload(error, maxlen) || force)
476 //Make sure to detach it from sourcehook!
477 g_SourceHook.UnloadPlugin(pl->m_Id);
486 //Remove the plugin from the list
488 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
490 if ( (*i)->m_Id == pl->m_Id )
492 i = m_Plugins.erase(i);
502 //The plugin is not valid, and let's just remove it from the list anyway
504 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
506 if ( (*i)->m_Id == pl->m_Id )
508 i = m_Plugins.erase(i);
520 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
524 if (pl->m_Status != Pl_Running || !pl->m_API)
527 UTIL_Format(error, maxlen, "Plugin cannot be paused");
529 if (pl->m_API->Pause(error, maxlen))
531 g_SourceHook.PausePlugin(pl->m_Id);
532 pl->m_Status = Pl_Paused;
541 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
546 if (pl->m_Status != Pl_Paused || !pl->m_API)
549 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
551 if (pl->m_API->Unpause(error, maxlen))
553 g_SourceHook.UnpausePlugin(pl->m_Id);
554 pl->m_Status = Pl_Running;
563 bool CPluginManager::UnloadAll()
570 while ((i = m_Plugins.begin()) != m_Plugins.end())
572 if ( !_Unload( (*i), true, error, sizeof(error)) )
581 bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source)
583 CPlugin *pl = FindById(id);
588 file = pl->m_File.c_str();
589 status = pl->m_Status;
590 source = pl->m_Source;
595 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
597 CPlugin *pl = FindById(id);
599 if (!pl || !pl->m_API)
602 UTIL_Format(error, maxlength, "Plugin not valid");
606 return pl->m_API->QueryRunning(error, maxlength);
609 bool CPluginManager::QueryHandle(PluginId id, void *&handle)
611 CPlugin *pl = FindById(id);
618 handle = static_cast<void *>(pl->m_Lib);
623 PluginIter CPluginManager::_begin()
625 return m_Plugins.begin();
628 PluginIter CPluginManager::_end()
630 return m_Plugins.end();
633 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
635 CPlugin *pl = FindByAPI(api);
640 pl->m_Cvars.push_back(pCvar);
643 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
645 CPlugin *pl = FindByAPI(api);
650 pl->m_Cmds.push_back(pCmd);
653 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
655 CPlugin *pl = FindByAPI(api);
660 pl->m_Cvars.remove(pCvar);
663 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
665 CPlugin *pl = FindByAPI(api);
670 pl->m_Cmds.remove(pCmd);
673 void CPluginManager::UnregAllConCmds(CPlugin *pl)
675 SourceHook::List<ConCommandBase *>::iterator i;
677 for (i = pl->m_Cvars.begin(); i != pl->m_Cvars.end(); i++)
679 NotifyConCommandBaseDrop(pl->m_Id, (*i));
680 g_SMConVarAccessor.Unregister((*i));
685 for (i = pl->m_Cmds.begin(); i != pl->m_Cmds.end(); i++)
687 NotifyConCommandBaseDrop(pl->m_Id, (*i));
688 g_SMConVarAccessor.Unregister((*i));
694 const char *CPluginManager::GetStatusText(CPlugin *pl)
696 switch (pl->m_Status)
708 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
720 unsigned int CPluginManager::GetPluginCount()
722 return (unsigned int)m_Plugins.size();