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