dvander@354: /* ======== SourceMM ======== dvander@354: * Copyright (C) 2004-2007 Metamod:Source Development Team dvander@354: * No warranties of any kind dvander@354: * dvander@354: * License: zlib/libpng dvander@354: * dvander@354: * Author(s): David "BAILOPAN" Anderson dvander@354: * ============================ dvander@354: */ dvander@354: dvander@354: #if defined _DEBUG dvander@354: #define DEBUG2 dvander@354: #undef _DEBUG dvander@354: #endif dvander@354: #include "metamod.h" dvander@354: #include "metamod_plugins.h" dvander@354: #include "metamod_util.h" dvander@354: #if defined DEBUG2 dvander@354: #undef DEBUG2 dvander@354: #define _DEBUG dvander@354: #endif dvander@354: dvander@354: /** dvander@354: * @brief Implements functions from CPlugin.h dvander@354: * @file CPlugin.cpp dvander@354: */ dvander@354: dvander@354: using namespace SourceMM; dvander@354: dvander@354: #define ITER_PLEVENT(evn, plid) \ dvander@354: CPluginManager::CPlugin *_Xpl; \ dvander@354: SourceHook::List::iterator event; \ dvander@354: IMetamodListener *api; \ dvander@354: for (PluginIter iter = g_PluginMngr._begin(); iter != g_PluginMngr._end(); iter++) { \ dvander@354: _Xpl = (*iter); \ dvander@354: if (_Xpl->m_Id == plid) \ dvander@354: continue; \ dvander@354: for (event=_Xpl->m_Events.begin(); event!=_Xpl->m_Events.end(); event++) { \ dvander@354: api = (*event); \ dvander@354: api->evn(plid); \ dvander@354: } \ dvander@354: } dvander@354: dvander@354: CPluginManager g_PluginMngr; dvander@354: dvander@354: CPluginManager::CPluginManager() dvander@354: { dvander@354: m_LastId = Pl_MinId; dvander@354: m_AllLoaded = false; dvander@354: } dvander@354: dvander@354: CPluginManager::~CPluginManager() dvander@354: { dvander@354: SourceHook::List::iterator iter; dvander@354: dvander@354: for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++) dvander@354: { dvander@354: delete (*iter); dvander@354: } dvander@354: dvander@354: m_Aliases.clear(); dvander@354: } dvander@354: dvander@354: const char *CPluginManager::LookupAlias(const char *alias) dvander@354: { dvander@354: SourceHook::List::iterator iter; dvander@354: CNameAlias *p; dvander@354: dvander@354: for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++) dvander@354: { dvander@354: p = (*iter); dvander@354: if (p->alias.compare(alias) == 0) dvander@354: { dvander@354: return p->value.c_str(); dvander@354: } dvander@354: } dvander@354: dvander@354: return NULL; dvander@354: } dvander@354: dvander@354: SourceHook::List::iterator CPluginManager::_alias_begin() dvander@354: { dvander@354: return m_Aliases.begin(); dvander@354: } dvander@354: dvander@354: SourceHook::List::iterator CPluginManager::_alias_end() dvander@354: { dvander@354: return m_Aliases.end(); dvander@354: } dvander@354: dvander@354: void CPluginManager::SetAlias(const char *alias, const char *value) dvander@354: { dvander@354: SourceHook::List::iterator iter; dvander@354: CNameAlias *p; dvander@354: dvander@354: for (iter = m_Aliases.begin(); iter != m_Aliases.end(); iter++) dvander@354: { dvander@354: p = (*iter); dvander@354: if (p->alias.compare(alias) == 0) dvander@354: { dvander@354: if (value[0] == '\0') dvander@354: { dvander@354: iter = m_Aliases.erase(iter); dvander@354: return; dvander@354: } dvander@354: else dvander@354: { dvander@354: p->value.assign(value); dvander@354: return; dvander@354: } dvander@354: } dvander@354: } dvander@354: dvander@354: if (value[0] != '\0') dvander@354: { dvander@354: p = new CNameAlias; dvander@354: dvander@354: p->alias.assign(alias); dvander@354: p->value.assign(value); dvander@354: dvander@354: m_Aliases.push_back(p); dvander@354: } dvander@354: } dvander@354: dvander@354: CPluginManager::CPlugin::CPlugin() : m_Id(0), m_Source(0), m_API(NULL), m_Lib(NULL) dvander@354: { dvander@354: dvander@354: } dvander@354: dvander@354: PluginId CPluginManager::Load(const char *file, PluginId source, bool &already, char *error, size_t maxlen) dvander@354: { dvander@354: already = false; dvander@354: //Check if we're about to reload an old plugin dvander@354: PluginIter i = m_Plugins.begin(); dvander@354: while (i != m_Plugins.end()) dvander@354: { dvander@354: if ((*i) && UTIL_PathCmp(file, (*i)->m_File.c_str())) dvander@354: { dvander@354: if ((*i)->m_Status < Pl_Paused) dvander@354: { dvander@354: //Attempt to load the plugin again dvander@354: already = true; dvander@354: i = m_Plugins.erase(i); dvander@354: continue; dvander@354: } dvander@354: else dvander@354: { dvander@354: //No need to load it dvander@354: already = true; dvander@354: return (*i)->m_Id; dvander@354: } dvander@354: } dvander@354: i++; dvander@354: } dvander@354: dvander@354: CPlugin *pl = _Load(file, source, error, maxlen); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return Pl_BadLoad; dvander@354: } dvander@354: dvander@354: ITER_PLEVENT(OnPluginLoad, pl->m_Id); dvander@354: dvander@354: return pl->m_Id; dvander@354: } dvander@354: dvander@354: CPluginManager::CPlugin *CPluginManager::FindById(PluginId id) dvander@354: { dvander@354: PluginIter i; dvander@354: dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ( (*i)->m_Id == id )\ dvander@354: { dvander@354: return (*i); dvander@354: } dvander@354: } dvander@354: dvander@354: return NULL; dvander@354: } dvander@354: dvander@354: void CPluginManager::SetAllLoaded() dvander@354: { dvander@354: m_AllLoaded = true; dvander@354: PluginIter i; dvander@354: dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ( (*i) && (*i)->m_Status == Pl_Running && (*i)->m_API ) dvander@354: { dvander@354: //API 4 is when we added this callback dvander@354: //Min version is now 5, so we ignore this check dvander@354: //if ( (*i)->m_API->GetApiVersion() >= 004 ) dvander@354: (*i)->m_API->AllPluginsLoaded(); dvander@354: } dvander@354: } dvander@354: } dvander@354: dvander@354: bool CPluginManager::Pause(PluginId id, char *error, size_t maxlen) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin id not found"); dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool ret; dvander@354: dvander@354: if ((ret=_Pause(pl, error, maxlen)) == true) dvander@354: { dvander@354: ITER_PLEVENT(OnPluginPause, pl->m_Id); dvander@354: } dvander@354: dvander@354: return ret; dvander@354: } dvander@354: dvander@354: bool CPluginManager::Unpause(PluginId id, char *error, size_t maxlen) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin id not found"); dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool ret; dvander@354: dvander@354: if ( (ret=_Unpause(pl, error, maxlen)) == true ) dvander@354: { dvander@354: ITER_PLEVENT(OnPluginUnpause, pl->m_Id); dvander@354: } dvander@354: dvander@354: return ret; dvander@354: } dvander@354: dvander@354: bool CPluginManager::Unload(PluginId id, bool force, char *error, size_t maxlen) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin %d not found", id); dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool ret; dvander@354: PluginId old_id = pl->m_Id; dvander@354: if ( (ret=_Unload(pl, force, error, maxlen)) == true ) dvander@354: { dvander@354: ITER_PLEVENT(OnPluginUnload, old_id); dvander@354: } dvander@354: dvander@354: return ret; dvander@354: } dvander@354: dvander@354: bool CPluginManager::Retry(PluginId id, char *error, size_t len) dvander@354: { dvander@354: PluginIter i; dvander@354: char buffer[64]; dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ( (*i) && (*i)->m_Id == id ) dvander@354: { dvander@354: if ( (*i)->m_Status >= Pl_Paused) dvander@354: { dvander@354: UTIL_Format(error, len, "Plugin %d is already running.", id); dvander@354: return false; dvander@354: } dvander@354: CPlugin *pl = _Load((*i)->m_File.c_str(), Pl_Console, error, len); dvander@354: if (!pl) dvander@354: { dvander@354: return false; dvander@354: } dvander@354: if (pl->m_Status >= Pl_Paused) dvander@354: { dvander@354: //Now it gets crazy... unload the original copy. dvander@354: _Unload( (*i), true, buffer, sizeof(buffer)-1 ); dvander@354: dvander@354: //Set the new copy's id dvander@354: pl->m_Id = id; dvander@354: dvander@354: //We just wasted an id... reclaim it dvander@354: m_LastId--; dvander@354: dvander@354: return true; dvander@354: } dvander@354: else dvander@354: { dvander@354: //don't really care about the buffer here dvander@354: _Unload(pl, true, buffer, sizeof(buffer)-1); dvander@354: dvander@354: //We just wasted an id... reclaim it dvander@354: m_LastId--; dvander@354: return false; dvander@354: } dvander@354: } dvander@354: } dvander@354: dvander@354: UTIL_Format(error, len, "Plugin %d not found,", id); dvander@354: return false; dvander@354: } dvander@354: dvander@354: CPluginManager::CPlugin *CPluginManager::FindByAPI(ISmmPlugin *api) dvander@354: { dvander@354: PluginIter i; dvander@354: dvander@354: //don't find bad plugins! dvander@354: if (!api) dvander@354: { dvander@354: return NULL; dvander@354: } dvander@354: dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ((*i)->m_API == api) dvander@354: { dvander@354: return (*i); dvander@354: } dvander@354: } dvander@354: dvander@354: return NULL; dvander@354: } dvander@354: dvander@354: int CPluginManager::GetPluginCount() dvander@354: { dvander@354: return (int)m_Plugins.size(); dvander@354: } dvander@354: dvander@354: const char *CPluginManager::GetStatusText(CPlugin *pl) dvander@354: { dvander@354: switch (pl->m_Status) dvander@354: { dvander@354: case Pl_NotFound: dvander@354: return "NOFILE"; dvander@354: case Pl_Error: dvander@354: return "ERROR"; dvander@354: case Pl_Refused: dvander@354: return "FAILED"; dvander@354: case Pl_Paused: dvander@354: return "PAUSED"; dvander@354: case Pl_Running: dvander@354: { dvander@354: if (pl->m_API && pl->m_API->QueryRunning(NULL, 0)) dvander@354: { dvander@354: return "STOPPED"; dvander@354: } else { dvander@354: return "RUNNING"; dvander@354: } dvander@354: } dvander@354: default: dvander@354: return "-"; dvander@354: } dvander@354: } dvander@354: dvander@354: CPluginManager::CPlugin *CPluginManager::_Load(const char *file, PluginId source, char *error, size_t maxlen) dvander@354: { dvander@354: FILE *fp; dvander@354: CPlugin *pl; dvander@354: dvander@354: pl = new CPlugin(); dvander@354: *error = '\0'; dvander@354: dvander@354: //Add plugin to list dvander@354: pl->m_Id = m_LastId; dvander@354: pl->m_File.assign(file); dvander@354: m_Plugins.push_back(pl); dvander@354: m_LastId++; dvander@354: dvander@354: //Check if the file even exists dvander@354: fp = fopen(file, "r"); dvander@354: if (!fp) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "File not found: %s", file); dvander@354: } dvander@354: pl->m_Status = Pl_NotFound; dvander@354: } dvander@354: dvander@354: if (fp) dvander@354: { dvander@354: fclose(fp); dvander@354: fp = NULL; dvander@354: dvander@354: //Load the file dvander@354: pl->m_Lib = dlmount(file); dvander@354: if (!pl->m_Lib) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "%s", dlerror()); dvander@354: } dvander@354: pl->m_Status = Pl_Error; dvander@354: } dvander@354: else dvander@354: { dvander@354: CreateInterfaceFn pfn = (CreateInterfaceFn)(dlsym(pl->m_Lib, PL_EXPOSURE_C)); dvander@354: if (!pfn) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Function %s not found", PL_EXPOSURE_C); dvander@354: } dvander@354: pl->m_Status = Pl_Error; dvander@354: } dvander@354: else dvander@354: { dvander@354: pl->m_API = static_cast((pfn)(PLAPI_NAME, NULL)); dvander@354: if (!pl->m_API) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Failed to get API"); dvander@354: } dvander@354: pl->m_Status = Pl_Error; dvander@354: } dvander@354: else dvander@354: { dvander@354: int api = pl->m_API->GetApiVersion(); dvander@354: if (api < PLAPI_MIN_VERSION) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin API %d is out of date with required minimum (%d)", api, PLAPI_MIN_VERSION); dvander@354: } dvander@354: pl->m_Status = Pl_Error; dvander@354: } dvander@354: else if (api > PLAPI_VERSION) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin API %d is newer than internal version (%d)", api, PLAPI_VERSION); dvander@354: } dvander@354: pl->m_Status = Pl_Error; dvander@354: } dvander@354: else dvander@354: { dvander@354: if (pl->m_API->Load(pl->m_Id, &g_Metamod, error, maxlen, m_AllLoaded)) dvander@354: { dvander@354: pl->m_Status = Pl_Running; dvander@354: if (m_AllLoaded) dvander@354: { dvander@354: //API 4 is when we added this callback dvander@354: //Removing this code as the min version is now 5 dvander@354: //if (pl->m_API->GetApiVersion() >= 4) dvander@354: pl->m_API->AllPluginsLoaded(); dvander@354: } dvander@354: } dvander@354: else dvander@354: { dvander@354: pl->m_Status = Pl_Refused; dvander@354: } dvander@354: } dvander@354: } dvander@354: } dvander@354: } dvander@354: } dvander@354: dvander@354: if (pl->m_Lib && (pl->m_Status < Pl_Paused)) dvander@354: { dvander@354: pl->m_Events.clear(); dvander@354: g_SourceHook.UnloadPlugin(pl->m_Id); dvander@354: UnregAllConCmds(pl); dvander@354: dvander@354: dlclose(pl->m_Lib); dvander@354: pl->m_Lib = NULL; dvander@354: pl->m_API = NULL; dvander@354: } dvander@354: dvander@354: return pl; dvander@354: } dvander@354: dvander@354: bool CPluginManager::_Unload(CPluginManager::CPlugin *pl, bool force, char *error, size_t maxlen) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: *error = '\0'; dvander@354: } dvander@354: dvander@354: if (pl->m_API && pl->m_Lib) dvander@354: { dvander@354: //Note, we'll always tell the plugin it will be unloading... dvander@354: if (pl->m_API->Unload(error, maxlen) || force) dvander@354: { dvander@354: //Make sure to detach it from sourcehook! dvander@354: g_SourceHook.UnloadPlugin(pl->m_Id); dvander@354: dvander@363: pl->m_Events.clear(); dvander@363: dvander@354: UnregAllConCmds(pl); dvander@354: dvander@354: //Clean up the DLL dvander@354: dlclose(pl->m_Lib); dvander@354: pl->m_Lib = NULL; dvander@354: pl->m_API = NULL; dvander@354: dvander@354: //Remove the plugin from the list dvander@354: PluginIter i; dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ( (*i)->m_Id == pl->m_Id ) dvander@354: { dvander@354: i = m_Plugins.erase(i); dvander@354: break; dvander@354: } dvander@354: } dvander@354: //Free its memory dvander@354: delete pl; dvander@354: dvander@354: return true; dvander@354: } dvander@354: } else { dvander@354: //The plugin is not valid, and let's just remove it from the list anyway dvander@354: PluginIter i; dvander@354: for (i=m_Plugins.begin(); i!=m_Plugins.end(); i++) dvander@354: { dvander@354: if ( (*i)->m_Id == pl->m_Id ) dvander@354: { dvander@354: i = m_Plugins.erase(i); dvander@354: break; dvander@354: } dvander@354: } dvander@354: delete pl; dvander@354: dvander@354: return true; dvander@354: } dvander@354: dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool CPluginManager::_Pause(CPluginManager::CPlugin *pl, char *error, size_t maxlen) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: *error = '\0'; dvander@354: } dvander@354: dvander@354: if (pl->m_Status != Pl_Running || !pl->m_API) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin cannot be paused"); dvander@354: } dvander@354: } dvander@354: else dvander@354: { dvander@354: if (pl->m_API->Pause(error, maxlen)) dvander@354: { dvander@354: g_SourceHook.PausePlugin(pl->m_Id); dvander@354: pl->m_Status = Pl_Paused; dvander@354: dvander@354: return true; dvander@354: } dvander@354: } dvander@354: dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool CPluginManager::_Unpause(CPluginManager::CPlugin *pl, char *error, size_t maxlen) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: *error = '\0'; dvander@354: } dvander@354: dvander@354: if (pl->m_Status != Pl_Paused || !pl->m_API) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlen, "Plugin cannot be unpaused"); dvander@354: } dvander@354: } dvander@354: else dvander@354: { dvander@354: if (pl->m_API->Unpause(error, maxlen)) dvander@354: { dvander@354: g_SourceHook.UnpausePlugin(pl->m_Id); dvander@354: pl->m_Status = Pl_Running; dvander@354: dvander@354: return true; dvander@354: } dvander@354: } dvander@354: dvander@354: return false; dvander@354: } dvander@354: dvander@354: bool CPluginManager::UnloadAll() dvander@354: { dvander@354: PluginIter i; dvander@354: dvander@354: char error[128]; dvander@354: bool status = true; dvander@354: dvander@354: while ((i = m_Plugins.begin()) != m_Plugins.end()) dvander@354: { dvander@354: if ( !_Unload( (*i), true, error, sizeof(error)) ) dvander@354: { dvander@354: status = false; dvander@354: } dvander@354: } dvander@354: dvander@354: return status; dvander@354: } dvander@354: dvander@354: bool CPluginManager::Query(PluginId id, const char *&file, Pl_Status &status, PluginId &source) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return false; dvander@354: } dvander@354: dvander@354: file = pl->m_File.c_str(); dvander@354: status = pl->m_Status; dvander@354: source = pl->m_Source; dvander@354: dvander@354: return true; dvander@354: } dvander@354: dvander@354: bool CPluginManager::QueryRunning(PluginId id, char *error, size_t maxlength) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl || !pl->m_API) dvander@354: { dvander@354: if (error) dvander@354: { dvander@354: UTIL_Format(error, maxlength, "Plugin not valid"); dvander@354: } dvander@354: return false; dvander@354: } dvander@354: dvander@354: return pl->m_API->QueryRunning(error, maxlength); dvander@354: } dvander@354: dvander@354: bool CPluginManager::QueryHandle(PluginId id, void *&handle) dvander@354: { dvander@354: CPlugin *pl = FindById(id); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return false; dvander@354: } dvander@354: dvander@354: handle = static_cast(pl->m_Lib); dvander@354: dvander@354: return true; dvander@354: } dvander@354: dvander@354: PluginIter CPluginManager::_begin() dvander@354: { dvander@354: return m_Plugins.begin(); dvander@354: } dvander@354: dvander@354: PluginIter CPluginManager::_end() dvander@354: { dvander@354: return m_Plugins.end(); dvander@354: } dvander@354: dvander@354: void CPluginManager::AddPluginCvar(ISmmPlugin *api, ConCommandBase *pCvar) dvander@354: { dvander@354: CPlugin *pl = FindByAPI(api); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return; dvander@354: } dvander@354: dvander@354: pl->m_Cvars.push_back(pCvar); dvander@354: } dvander@354: dvander@354: void CPluginManager::AddPluginCmd(ISmmPlugin *api, ConCommandBase *pCmd) dvander@354: { dvander@354: CPlugin *pl = FindByAPI(api); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return; dvander@354: } dvander@354: dvander@354: pl->m_Cmds.push_back(pCmd); dvander@354: } dvander@354: dvander@354: void CPluginManager::RemovePluginCvar(ISmmPlugin *api, ConCommandBase *pCvar) dvander@354: { dvander@354: CPlugin *pl = FindByAPI(api); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return; dvander@354: } dvander@354: dvander@354: pl->m_Cvars.remove(pCvar); dvander@354: } dvander@354: dvander@354: void CPluginManager::RemovePluginCmd(ISmmPlugin *api, ConCommandBase *pCmd) dvander@354: { dvander@354: CPlugin *pl = FindByAPI(api); dvander@354: dvander@354: if (!pl) dvander@354: { dvander@354: return; dvander@354: } dvander@354: dvander@354: pl->m_Cmds.remove(pCmd); dvander@354: } dvander@354: dvander@354: void CPluginManager::UnregAllConCmds(CPlugin *pl) dvander@354: { dvander@354: SourceHook::List::iterator i; dvander@354: dvander@354: /* :TODO: */ dvander@354: for (i=pl->m_Cvars.begin(); i!=pl->m_Cvars.end(); i++) dvander@354: { dvander@363: g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) ); dvander@354: } dvander@354: pl->m_Cvars.clear(); dvander@354: dvander@354: for (i=pl->m_Cmds.begin(); i!=pl->m_Cmds.end(); i++) dvander@354: { dvander@363: g_Metamod.UnregisterConCommandBase(pl->m_Id, (*i) ); dvander@354: } dvander@363: pl->m_Cmds.clear(); dvander@363: } dvander@354: