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.
33 #include "metamod_plugins.h"
34 #include "metamod_util.h"
41 * @brief Implements functions from CPlugin.h
45 using namespace SourceMM;
47 #define ITER_PLEVENT(evn, plid) \
48 CPluginManager::CPlugin *_Xpl; \
49 SourceHook::List<IMetamodListener *>::iterator event; \
50 IMetamodListener *api; \
51 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
53 if (_Xpl->m_Id == plid) \
55 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
61 CPluginManager g_PluginMngr;
63 MetamodVersionInfo GlobVersionInfo =
70 METAMOD_PLAPI_VERSION,
74 CPluginManager::CPluginManager()
80 CPluginManager::~CPluginManager()
82 SourceHook::List<CNameAlias *>::iterator iter;
84 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
92 const char *CPluginManager::LookupAlias(const char *alias)
94 SourceHook::List<CNameAlias *>::iterator iter;
97 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
100 if (p->alias.compare(alias) == 0)
102 return p->value.c_str();
109 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_begin()
111 return m_Aliases.begin();
114 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_end()
116 return m_Aliases.end();
119 void CPluginManager::SetAlias(const char *alias, const char *value)
121 SourceHook::List<CNameAlias *>::iterator iter;
124 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
127 if (p->alias.compare(alias) == 0)
129 if (value[0] == '\0')
131 iter = m_Aliases.erase(iter);
136 p->value.assign(value);
142 if (value[0] != '\0')
146 p->alias.assign(alias);
147 p->value.assign(value);
149 m_Aliases.push_back(p);
153 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL), m_UnloadFn(NULL)
158 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
161 //Check if we're about to reload an old plugin
162 PluginIter i = m_Plugins.begin();
163 while (i != m_Plugins.end())
165 if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()))
167 if ((*i)->m_Status < Pl_Paused)
169 //Attempt to load the plugin again
171 i = m_Plugins.erase(i);
184 CPlugin *pl = _Load(file, source, error, maxlen);
191 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
196 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
200 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
202 if ( (*i)->m_Id == id )\
211 void CPluginManager::SetAllLoaded()
216 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
218 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
220 //API 4 is when we added this callback
221 //Min version is now 5, so we ignore this check
222 //if ( (*i)->m_API->GetApiVersion() >= 004 )
223 (*i)->m_API->AllPluginsLoaded();
228 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
230 CPlugin *pl = FindById(id);
234 UTIL_Format(error, maxlen, "Plugin id not found");
240 if ((ret=_Pause(pl, error, maxlen)) == true)
242 ITER_PLEVENT(OnPluginPause, pl->m_Id);
248 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
250 CPlugin *pl = FindById(id);
254 UTIL_Format(error, maxlen, "Plugin id not found");
260 if ( (ret=_Unpause(pl, error, maxlen)) == true )
262 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
268 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
270 CPlugin *pl = FindById(id);
274 UTIL_Format(error, maxlen, "Plugin %d not found", id);
279 PluginId old_id = pl->m_Id;
280 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
282 ITER_PLEVENT(OnPluginUnload, old_id);
288 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
292 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
294 if ( (*i) && (*i)->m_Id == id )
296 if ( (*i)->m_Status >= Pl_Paused)
298 UTIL_Format(error, len, "Plugin %d is already running.", id);
301 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
306 if (pl->m_Status >= Pl_Paused)
308 //Now it gets crazy... unload the original copy.
309 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
311 //Set the new copy's id
314 //We just wasted an id... reclaim it
321 //don't really care about the buffer here
322 _Unload(pl, true, buffer, sizeof(buffer)-1);
324 //We just wasted an id... reclaim it
331 UTIL_Format(error, len, "Plugin %d not found,", id);
335 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
339 //don't find bad plugins!
345 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
347 if ((*i)->m_API == api)
356 int CPluginManager::GetPluginCount()
358 return (int)m_Plugins.size();
361 const char *CPluginManager::GetStatusText(CPlugin *pl)
363 switch (pl->m_Status)
375 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
387 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
397 pl->m_File.assign(file);
398 m_Plugins.push_back(pl);
401 //Check if the file even exists
402 fp = fopen(file, "r");
407 UTIL_Format(error, maxlen, "File not found: %s", file);
409 pl->m_Status = Pl_NotFound;
418 pl->m_Lib = dlmount(file);
423 UTIL_Format(error, maxlen, "%s", dlerror());
425 pl->m_Status = Pl_Error;
432 * First, try the new "advanced" interface
434 METAMOD_FN_LOAD fnLoad = (METAMOD_FN_LOAD)dlsym(pl->m_Lib, "CreateInterface_MMS");
437 if (GlobVersionInfo.source_engine == SOURCE_ENGINE_UNKNOWN)
439 GlobVersionInfo.source_engine = g_Metamod.GetSourceEngineBuild();
442 /* Build path information */
444 size_t len = g_Metamod.PathFormat(file_path, sizeof(file_path), "%s", file);
446 for (size_t i = len - 1; i >= 0 && i < len; i--)
448 if (_IsPathSepChar(file_path[i]))
455 MetamodLoaderInfo info;
457 info.pl_path = file_path;
459 pl->m_API = fnLoad(&GlobVersionInfo, &info);
460 pl->m_UnloadFn = (METAMOD_FN_UNLOAD)dlsym(pl->m_Lib, "UnloadInterface_MMS");
464 * If we didn't get anything, try the normal/simple interface.
466 if (pl->m_API == NULL)
468 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
473 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
475 pl->m_Status = Pl_Error;
479 pl->m_API = static_cast<ISmmPlugin *>((pfn)(METAMOD_PLAPI_NAME, NULL));
485 UTIL_Format(error, maxlen, "Failed to get API");
487 pl->m_Status = Pl_Error;
492 if (pl->m_API != NULL)
494 int api = pl->m_API->GetApiVersion();
495 if (api < PLAPI_MIN_VERSION)
501 UTIL_Format(error, maxlen, "Plugin uses experimental Metamod build, probably 1.6.x (%d < %d)", api, PLAPI_MIN_VERSION);
503 else if (api <= 12 && api >= 7)
505 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.4.x (%d < %d)", api, PLAPI_MIN_VERSION);
509 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.0 (%d < %d)", api, PLAPI_MIN_VERSION);
512 pl->m_Status = Pl_Error;
514 else if (api > METAMOD_PLAPI_VERSION)
518 UTIL_Format(error, maxlen, "Plugin requires newer Metamod version (%d > %d)", api, METAMOD_PLAPI_VERSION);
520 pl->m_Status = Pl_Error;
524 if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded))
526 pl->m_Status = Pl_Running;
529 pl->m_API->AllPluginsLoaded();
534 pl->m_Status = Pl_Refused;
541 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
543 pl->m_Events.clear();
544 g_SourceHook.UnloadPlugin(pl->m_Id);
547 if (pl->m_UnloadFn != NULL)
560 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
567 if (pl->m_API && pl->m_Lib)
569 //Note, we'll always tell the plugin it will be unloading...
570 if (pl->m_API->Unload(error, maxlen) || force)
572 //Make sure to detach it from sourcehook!
573 g_SourceHook.UnloadPlugin(pl->m_Id);
575 pl->m_Events.clear();
579 if (pl->m_UnloadFn != NULL)
589 //Remove the plugin from the list
591 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
593 if ( (*i)->m_Id == pl->m_Id )
595 i = m_Plugins.erase(i);
605 //The plugin is not valid, and let's just remove it from the list anyway
607 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
609 if ( (*i)->m_Id == pl->m_Id )
611 i = m_Plugins.erase(i);
623 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
630 if (pl->m_Status != Pl_Running || !pl->m_API)
634 UTIL_Format(error, maxlen, "Plugin cannot be paused");
639 if (pl->m_API->Pause(error, maxlen))
641 g_SourceHook.PausePlugin(pl->m_Id);
642 pl->m_Status = Pl_Paused;
651 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
658 if (pl->m_Status != Pl_Paused || !pl->m_API)
662 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
667 if (pl->m_API->Unpause(error, maxlen))
669 g_SourceHook.UnpausePlugin(pl->m_Id);
670 pl->m_Status = Pl_Running;
679 bool CPluginManager::UnloadAll()
686 while ((i = m_Plugins.begin()) != m_Plugins.end())
688 if ( !_Unload( (*i), true, error, sizeof(error)) )
697 bool CPluginManager::Query(PluginId id, const char **file, Pl_Status *status, PluginId *source)
699 CPlugin *pl = FindById(id);
708 *file = pl->m_File.c_str();
713 *status = pl->m_Status;
718 *source = pl->m_Source;
724 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
726 CPlugin *pl = FindById(id);
728 if (!pl || !pl->m_API)
732 UTIL_Format(error, maxlength, "Plugin not valid");
737 return pl->m_API->QueryRunning(error, maxlength);
740 bool CPluginManager::QueryHandle(PluginId id, void **handle)
742 CPlugin *pl = FindById(id);
751 *handle = static_cast<void *>(pl->m_Lib);
757 PluginIter CPluginManager::_begin()
759 return m_Plugins.begin();
762 PluginIter CPluginManager::_end()
764 return m_Plugins.end();
767 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
769 CPlugin *pl = FindByAPI(api);
776 pl->m_Cvars.push_back(pCvar);
779 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
781 CPlugin *pl = FindByAPI(api);
788 pl->m_Cmds.push_back(pCmd);
791 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
793 CPlugin *pl = FindByAPI(api);
800 pl->m_Cvars.remove(pCvar);
803 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
805 CPlugin *pl = FindByAPI(api);
812 pl->m_Cmds.remove(pCmd);
815 void CPluginManager::UnregAllConCmds(CPlugin *pl)
817 SourceHook::List<ConCommandBase *>::iterator i;
820 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
822 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );
826 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
828 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );