Trigger build for hl2sdk-l4d changes.
2 * vim: set ts=4 sw=4 tw=99 noet :
3 * ======================================================
5 * Copyright (C) 2004-2009 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.
27 #include "metamod_oslink.h"
29 #include "metamod_plugins.h"
30 #include "metamod_util.h"
33 * @brief Implements functions from CPlugin.h
37 using namespace SourceMM;
39 #define ITER_PLEVENT(evn, plid) \
40 CPluginManager::CPlugin *_Xpl; \
41 SourceHook::List<IMetamodListener *>::iterator event; \
42 IMetamodListener *api; \
43 for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \
45 if (_Xpl->m_Id == plid) \
47 for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \
53 CPluginManager g_PluginMngr;
55 MetamodVersionInfo GlobVersionInfo =
62 METAMOD_PLAPI_VERSION,
63 SOURCE_ENGINE_UNKNOWN,
67 CPluginManager::CPluginManager()
73 CPluginManager::~CPluginManager()
75 SourceHook::List<CNameAlias *>::iterator iter;
77 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
85 const char *CPluginManager::LookupAlias(const char *alias)
87 SourceHook::List<CNameAlias *>::iterator iter;
90 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
93 if (p->alias.compare(alias) == 0)
95 return p->value.c_str();
102 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_begin()
104 return m_Aliases.begin();
107 SourceHook::List<CNameAlias *>::iterator CPluginManager::_alias_end()
109 return m_Aliases.end();
112 void CPluginManager::SetAlias(const char *alias, const char *value)
114 SourceHook::List<CNameAlias *>::iterator iter;
117 for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++)
120 if (p->alias.compare(alias) == 0)
122 if (value[0] == '\0')
124 iter = m_Aliases.erase(iter);
129 p->value.assign(value);
135 if (value[0] != '\0')
139 p->alias.assign(alias);
140 p->value.assign(value);
142 m_Aliases.push_back(p);
146 CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL), m_UnloadFn(NULL)
151 PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen)
154 //Check if we're about to reload an old plugin
155 PluginIter i = m_Plugins.begin();
156 while (i != m_Plugins.end())
158 if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str()))
160 if ((*i)->m_Status < Pl_Paused)
162 //Attempt to load the plugin again
164 i = m_Plugins.erase(i);
177 CPlugin *pl = _Load(file, source, error, maxlen);
184 ITER_PLEVENT(OnPluginLoad, pl->m_Id);
189 CPluginManager::CPlugin *CPluginManager::FindById(PluginId id)
193 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
195 if ( (*i)->m_Id == id )\
204 void CPluginManager::SetAllLoaded()
214 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
216 if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API )
218 //API 4 is when we added this callback
219 //Min version is now 5, so we ignore this check
220 //if ( (*i)->m_API->GetApiVersion() >= 004 )
221 (*i)->m_API->AllPluginsLoaded();
226 bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen)
228 CPlugin *pl = FindById(id);
232 UTIL_Format(error, maxlen, "Plugin id not found");
238 if ((ret=_Pause(pl, error, maxlen)) == true)
240 ITER_PLEVENT(OnPluginPause, pl->m_Id);
246 bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen)
248 CPlugin *pl = FindById(id);
252 UTIL_Format(error, maxlen, "Plugin id not found");
258 if ( (ret=_Unpause(pl, error, maxlen)) == true )
260 ITER_PLEVENT(OnPluginUnpause, pl->m_Id);
266 bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen)
268 CPlugin *pl = FindById(id);
272 UTIL_Format(error, maxlen, "Plugin %d not found", id);
277 PluginId old_id = pl->m_Id;
278 if ( (ret=_Unload(pl, force, error, maxlen)) == true )
280 ITER_PLEVENT(OnPluginUnload, old_id);
286 bool CPluginManager::Retry(PluginId id, char *error, size_t len)
290 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
292 if ( (*i) && (*i)->m_Id == id )
294 if ( (*i)->m_Status >= Pl_Paused)
296 UTIL_Format(error, len, "Plugin %d is already running.", id);
299 CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len);
304 if (pl->m_Status >= Pl_Paused)
306 //Now it gets crazy... unload the original copy.
307 _Unload( (*i), true, buffer, sizeof(buffer)-1 );
309 //Set the new copy's id
312 //We just wasted an id... reclaim it
319 //don't really care about the buffer here
320 _Unload(pl, true, buffer, sizeof(buffer)-1);
322 //We just wasted an id... reclaim it
329 UTIL_Format(error, len, "Plugin %d not found,", id);
333 CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api)
337 //don't find bad plugins!
343 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
345 if ((*i)->m_API == api)
354 int CPluginManager::GetPluginCount()
356 return (int)m_Plugins.size();
359 const char *CPluginManager::GetStatusText(CPlugin *pl)
361 switch (pl->m_Status)
373 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
385 struct Unloader : public SourceHook::Impl::UnloadListener
387 CPluginManager::CPlugin *plugin_;
390 Unloader(CPluginManager::CPlugin *plugin, bool destroy)
391 : plugin_(plugin), destroy_(destroy)
394 void ReadyToUnload(SourceHook::Plugin plug)
396 if (plugin_->m_UnloadFn != NULL)
397 plugin_->m_UnloadFn();
399 dlclose(plugin_->m_Lib);
407 plugin_->m_Lib = NULL;
408 plugin_->m_API = NULL;
415 CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen)
425 pl->m_File.assign(file);
426 m_Plugins.push_back(pl);
429 //Check if the file even exists
430 fp = fopen(file, "r");
435 UTIL_Format(error, maxlen, "File not found: %s", file);
437 pl->m_Status = Pl_NotFound;
446 pl->m_Lib = dlmount(file);
451 UTIL_Format(error, maxlen, "%s", dlerror());
453 pl->m_Status = Pl_Error;
460 * First, try the new "advanced" interface
462 METAMOD_FN_LOAD fnLoad = (METAMOD_FN_LOAD)dlsym(pl->m_Lib, "CreateInterface_MMS");
465 if (GlobVersionInfo.source_engine == SOURCE_ENGINE_UNKNOWN)
467 GlobVersionInfo.source_engine = g_Metamod.GetSourceEngineBuild();
469 if (GlobVersionInfo.game_dir == NULL)
471 GlobVersionInfo.game_dir = strrchr(g_Metamod.GetBaseDir(), PATH_SEP_CHAR) + 1;
474 /* Build path information */
476 size_t len = g_Metamod.PathFormat(file_path, sizeof(file_path), "%s", file);
478 for (size_t i = len - 1; i < len; i--)
480 if (_IsPathSepChar(file_path[i]))
487 MetamodLoaderInfo info;
489 info.pl_path = file_path;
491 pl->m_API = fnLoad(&GlobVersionInfo, &info);
492 #if SOURCE_ENGINE == SE_CSS || SOURCE_ENGINE == SE_HL2DM || SOURCE_ENGINE == SE_DODS || SOURCE_ENGINE == SE_TF2
493 /* For plugin compat - try loading again using original OB if OB-Valve has failed */
494 if (pl->m_API == NULL)
496 GlobVersionInfo.source_engine = SOURCE_ENGINE_ORANGEBOXVALVE_DEPRECATED;
497 pl->m_API = fnLoad(&GlobVersionInfo, &info);
498 if (pl->m_API == NULL)
500 GlobVersionInfo.source_engine = SOURCE_ENGINE_ORANGEBOX;
501 pl->m_API = fnLoad(&GlobVersionInfo, &info);
503 GlobVersionInfo.source_engine = g_Metamod.GetSourceEngineBuild();
506 pl->m_UnloadFn = (METAMOD_FN_UNLOAD)dlsym(pl->m_Lib, "UnloadInterface_MMS");
510 * If we didn't get anything, try the normal/simple interface.
512 if (pl->m_API == NULL)
514 CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C));
519 UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C);
521 pl->m_Status = Pl_Error;
525 pl->m_API = static_cast<ISmmPlugin *>((pfn)(METAMOD_PLAPI_NAME, NULL));
531 UTIL_Format(error, maxlen, "Failed to get API");
533 pl->m_Status = Pl_Error;
538 if (pl->m_API != NULL)
540 int api = pl->m_API->GetApiVersion();
541 if (api < PLAPI_MIN_VERSION)
547 UTIL_Format(error, maxlen, "Plugin uses experimental Metamod build, probably 1.6.x (%d < %d)", api, PLAPI_MIN_VERSION);
549 else if (api <= 12 && api >= 7)
551 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.4.x (%d < %d)", api, PLAPI_MIN_VERSION);
555 UTIL_Format(error, maxlen, "Older Metamod version required, probably 1.0 (%d < %d)", api, PLAPI_MIN_VERSION);
558 pl->m_Status = Pl_Error;
560 else if (api > METAMOD_PLAPI_VERSION)
564 UTIL_Format(error, maxlen, "Plugin requires newer Metamod version (%d > %d)", api, METAMOD_PLAPI_VERSION);
566 pl->m_Status = Pl_Error;
570 if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded))
572 pl->m_Status = Pl_Running;
575 pl->m_API->AllPluginsLoaded();
580 pl->m_Status = Pl_Refused;
587 if (pl->m_Lib && (pl->m_Status < Pl_Paused))
589 pl->m_Events.clear();
591 g_SourceHook.UnloadPlugin(pl->m_Id, new Unloader(pl, false));
597 bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen)
604 if (pl->m_API && pl->m_Lib)
606 //Note, we'll always tell the plugin it will be unloading...
607 if (pl->m_API->Unload(error, maxlen) || force)
609 pl->m_Events.clear();
612 //Remove the plugin from the list
614 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
616 if ( (*i)->m_Id == pl->m_Id )
618 i = m_Plugins.erase(i);
623 //Make sure to detach it from sourcehook!
624 g_SourceHook.UnloadPlugin(pl->m_Id, new Unloader(pl, true));
628 //The plugin is not valid, and let's just remove it from the list anyway
630 for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++)
632 if ( (*i)->m_Id == pl->m_Id )
634 i = m_Plugins.erase(i);
646 bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
653 if (pl->m_Status != Pl_Running || !pl->m_API)
657 UTIL_Format(error, maxlen, "Plugin cannot be paused");
662 if (pl->m_API->Pause(error, maxlen))
664 g_SourceHook.PausePlugin(pl->m_Id);
665 pl->m_Status = Pl_Paused;
674 bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen)
681 if (pl->m_Status != Pl_Paused || !pl->m_API)
685 UTIL_Format(error, maxlen, "Plugin cannot be unpaused");
690 if (pl->m_API->Unpause(error, maxlen))
692 g_SourceHook.UnpausePlugin(pl->m_Id);
693 pl->m_Status = Pl_Running;
702 bool CPluginManager::UnloadAll()
709 while ((i = m_Plugins.begin()) != m_Plugins.end())
711 if ( !_Unload( (*i), true, error, sizeof(error)) )
720 bool CPluginManager::Query(PluginId id, const char **file, Pl_Status *status, PluginId *source)
722 CPlugin *pl = FindById(id);
731 *file = pl->m_File.c_str();
736 *status = pl->m_Status;
741 *source = pl->m_Source;
747 bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength)
749 CPlugin *pl = FindById(id);
751 if (!pl || !pl->m_API)
755 UTIL_Format(error, maxlength, "Plugin not valid");
760 return pl->m_API->QueryRunning(error, maxlength);
763 bool CPluginManager::QueryHandle(PluginId id, void **handle)
765 CPlugin *pl = FindById(id);
774 *handle = static_cast<void *>(pl->m_Lib);
780 PluginIter CPluginManager::_begin()
782 return m_Plugins.begin();
785 PluginIter CPluginManager::_end()
787 return m_Plugins.end();
790 void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
792 CPlugin *pl = FindByAPI(api);
799 pl->m_Cvars.push_back(pCvar);
802 void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
804 CPlugin *pl = FindByAPI(api);
811 pl->m_Cmds.push_back(pCmd);
814 void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar)
816 CPlugin *pl = FindByAPI(api);
823 pl->m_Cvars.remove(pCvar);
826 void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd)
828 CPlugin *pl = FindByAPI(api);
835 pl->m_Cmds.remove(pCmd);
838 void CPluginManager::UnregAllConCmds(CPlugin *pl)
840 SourceHook::List<ConCommandBase *>::iterator i;
843 for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++)
845 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );
849 for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++)
851 g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) );