3 * ======================================================
5 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
7 * ======================================================
9 * This software is provided 'as-is', without any express or implied warranty.
10 * In no event will the authors be held liable for any damages arising from
11 * the use of this software.
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software in a
19 * product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
28 #include "metamod_oslink.h"
34 #include "metamod_plugins.h"
35 #include "metamod_util.h"
42 * @brief Implements functions from CPlugin.h
46 using namespace SourceMM;
48 #define ITER_PLEVENT(evn, plid) \
49 CPluginManager::CPlugin *_Xpl; \
50 SourceHook::List<IMetamodListener *>::iterator event; \
51 IMetamodListener *api; \
52 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
54 if (_Xpl->m_Id == plid) \
56 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
62 CPluginManager g_PluginMngr;
64 MetamodVersionInfo GlobVersionInfo =
71 METAMOD_PLAPI_VERSION,
75 CPluginManager::CPluginManager()
81 CPluginManager::~CPluginManager()
83 SourceHook::List<CNameAlias *>::iterator iter;
85 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
93 const char *CPluginManager::LookupAlias(const char *alias)
95 SourceHook::List<CNameAlias *>::iterator iter;
98 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
101 if (p->alias.compare(alias) == 0)
103 return p->value.c_str();
110 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_begin()
112 return m_Aliases.begin();
115 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_end()
117 return m_Aliases.end();
120 void CPluginManager::SetAlias(const char *alias, const char *value)
122 SourceHook::List<CNameAlias *>::iterator iter;
125 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
128 if (p->alias.compare(alias) == 0)
130 if (value[0] == '\0')
132 iter = m_Aliases.erase(iter);
137 p->value.assign(value);
143 if (value[0] != '\0')
147 p->alias.assign(alias);
148 p->value.assign(value);
150 m_Aliases.push_back(p);
154 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL), m_UnloadFn(NULL)
159 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
162 //Check if we're about to reload an old plugin
163 PluginIter i = m_Plugins.begin();
164 while (i != m_Plugins.end())
166 if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()))
168 if ((*i)->m_Status < Pl_Paused)
170 //Attempt to load the plugin again
172 i = m_Plugins.erase(i);
185 CPlugin *pl = _Load(file, source, error, maxlen);
192 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
197 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
201 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
203 if ( (*i)->m_Id == id )\
212 void CPluginManager::SetAllLoaded()
222 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
224 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
226 //API 4 is when we added this callback
227 //Min version is now 5, so we ignore this check
228 //if ( (*i)->m_API->GetApiVersion() >= 004 )
229 (*i)->m_API->AllPluginsLoaded();
234 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
236 CPlugin *pl = FindById(id);
240 UTIL_Format(error, maxlen, "Plugin id not found");
246 if ((ret=_Pause(pl, error, maxlen)) == true)
248 ITER_PLEVENT(OnPluginPause, pl->m_Id);
254 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
256 CPlugin *pl = FindById(id);
260 UTIL_Format(error, maxlen, "Plugin id not found");
266 if ( (ret=_Unpause(pl, error, maxlen)) == true )
268 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
274 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
276 CPlugin *pl = FindById(id);
280 UTIL_Format(error, maxlen, "Plugin %d not found", id);
285 PluginId old_id = pl->m_Id;
286 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
288 ITER_PLEVENT(OnPluginUnload, old_id);
294 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
298 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
300 if ( (*i) && (*i)->m_Id == id )
302 if ( (*i)->m_Status >= Pl_Paused)
304 UTIL_Format(error, len, "Plugin %d is already running.", id);
307 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
312 if (pl->m_Status >= Pl_Paused)
314 //Now it gets crazy... unload the original copy.
315 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
317 //Set the new copy's id
320 //We just wasted an id... reclaim it
327 //don't really care about the buffer here
328 _Unload(pl, true, buffer, sizeof(buffer)-1);
330 //We just wasted an id... reclaim it
337 UTIL_Format(error, len, "Plugin %d not found,", id);
341 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
345 //don't find bad plugins!
351 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
353 if ((*i)->m_API == api)
362 int CPluginManager::GetPluginCount()
364 return (int)m_Plugins.size();
367 const char *CPluginManager::GetStatusText(CPlugin *pl)
369 switch (pl->m_Status)
381 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
393 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
403 pl->m_File.assign(file);
404 m_Plugins.push_back(pl);
407 //Check if the file even exists
408 fp = fopen(file, "r");
413 UTIL_Format(error, maxlen, "File not found: %s", file);
415 pl->m_Status = Pl_NotFound;
424 pl->m_Lib = dlmount(file);
429 UTIL_Format(error, maxlen, "%s", dlerror());
431 pl->m_Status = Pl_Error;
438 * First, try the new "advanced" interface
440 METAMOD_FN_LOAD fnLoad = (METAMOD_FN_LOAD)dlsym(pl->m_Lib, "CreateInterface_MMS");
443 if (GlobVersionInfo.source_engine == SOURCE_ENGINE_UNKNOWN)
445 GlobVersionInfo.source_engine = g_Metamod.GetSourceEngineBuild();
448 /* Build path information */
450 size_t len = g_Metamod.PathFormat(file_path, sizeof(file_path), "%s", file);
452 for (size_t i = len - 1; i >= 0 && i < len; i--)
454 if (_IsPathSepChar(file_path[i]))
461 MetamodLoaderInfo info;
463 info.pl_path = file_path;
465 pl->m_API = fnLoad(&GlobVersionInfo, &info);
466 pl->m_UnloadFn = (METAMOD_FN_UNLOAD)dlsym(pl->m_Lib, "UnloadInterface_MMS");
470 * If we didn't get anything, try the normal/simple interface.
472 if (pl->m_API == NULL)
474 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
479 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
481 pl->m_Status = Pl_Error;
485 pl->m_API = static_cast<ISmmPlugin *>((pfn)(METAMOD_PLAPI_NAME, NULL));
491 UTIL_Format(error, maxlen, "Failed to get API");
493 pl->m_Status = Pl_Error;
498 if (pl->m_API != NULL)
500 int api = pl->m_API->GetApiVersion();
501 if (api < PLAPI_MIN_VERSION)
507 UTIL_Format(error, maxlen, "Plugin uses experimental Metamod build, probably 1.6.x (%d < %d)", api, PLAPI_MIN_VERSION);
509 else if (api <= 12 && api >= 7)
511 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.4.x (%d < %d)", api, PLAPI_MIN_VERSION);
515 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.0 (%d < %d)", api, PLAPI_MIN_VERSION);
518 pl->m_Status = Pl_Error;
520 else if (api > METAMOD_PLAPI_VERSION)
524 UTIL_Format(error, maxlen, "Plugin requires newer Metamod version (%d > %d)", api, METAMOD_PLAPI_VERSION);
526 pl->m_Status = Pl_Error;
530 if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded))
532 pl->m_Status = Pl_Running;
535 pl->m_API->AllPluginsLoaded();
540 pl->m_Status = Pl_Refused;
547 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
549 pl->m_Events.clear();
550 g_SourceHook.UnloadPlugin(pl->m_Id);
553 if (pl->m_UnloadFn != NULL)
566 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
573 if (pl->m_API && pl->m_Lib)
575 //Note, we'll always tell the plugin it will be unloading...
576 if (pl->m_API->Unload(error, maxlen) || force)
578 //Make sure to detach it from sourcehook!
579 g_SourceHook.UnloadPlugin(pl->m_Id);
581 pl->m_Events.clear();
585 if (pl->m_UnloadFn != NULL)
595 //Remove the plugin from the list
597 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
599 if ( (*i)->m_Id == pl->m_Id )
601 i = m_Plugins.erase(i);
611 //The plugin is not valid, and let's just remove it from the list anyway
613 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
615 if ( (*i)->m_Id == pl->m_Id )
617 i = m_Plugins.erase(i);
629 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
636 if (pl->m_Status != Pl_Running || !pl->m_API)
640 UTIL_Format(error, maxlen, "Plugin cannot be paused");
645 if (pl->m_API->Pause(error, maxlen))
647 g_SourceHook.PausePlugin(pl->m_Id);
648 pl->m_Status = Pl_Paused;
657 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
664 if (pl->m_Status != Pl_Paused || !pl->m_API)
668 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
673 if (pl->m_API->Unpause(error, maxlen))
675 g_SourceHook.UnpausePlugin(pl->m_Id);
676 pl->m_Status = Pl_Running;
685 bool CPluginManager::UnloadAll()
692 while ((i = m_Plugins.begin()) != m_Plugins.end())
694 if ( !_Unload( (*i), true, error, sizeof(error)) )
703 bool CPluginManager::Query(PluginId id, const char **file, Pl_Status *status, PluginId *source)
705 CPlugin *pl = FindById(id);
714 *file = pl->m_File.c_str();
719 *status = pl->m_Status;
724 *source = pl->m_Source;
730 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
732 CPlugin *pl = FindById(id);
734 if (!pl || !pl->m_API)
738 UTIL_Format(error, maxlength, "Plugin not valid");
743 return pl->m_API->QueryRunning(error, maxlength);
746 bool CPluginManager::QueryHandle(PluginId id, void **handle)
748 CPlugin *pl = FindById(id);
757 *handle = static_cast<void *>(pl->m_Lib);
763 PluginIter CPluginManager::_begin()
765 return m_Plugins.begin();
768 PluginIter CPluginManager::_end()
770 return m_Plugins.end();
773 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
775 CPlugin *pl = FindByAPI(api);
782 pl->m_Cvars.push_back(pCvar);
785 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
787 CPlugin *pl = FindByAPI(api);
794 pl->m_Cmds.push_back(pCmd);
797 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
799 CPlugin *pl = FindByAPI(api);
806 pl->m_Cvars.remove(pCvar);
809 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
811 CPlugin *pl = FindByAPI(api);
818 pl->m_Cmds.remove(pCmd);
821 void CPluginManager::UnregAllConCmds(CPlugin *pl)
823 SourceHook::List<ConCommandBase *>::iterator i;
826 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
828 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );
832 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
834 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );