/** * vim: set ts=4 : * ============================================================================= * SourceMod * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved. * ============================================================================= * * This program is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License, version 3.0, as published by the * Free Software Foundation. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License along with * this program. If not, see . * * As a special exception, AlliedModders LLC gives you permission to link the * code of this program (as well as its derivative works) to "Half-Life 2," the * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software * by the Valve Corporation. You must obey the GNU General Public License in * all respects for all other code used. Additionally, AlliedModders LLC grants * this exception to all derivative works. AlliedModders LLC defines further * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007), * or . * * Version: $Id$ */ #include #include "PluginSys.h" #include "ShareSys.h" #include "LibrarySys.h" #include "HandleSys.h" #include "ForwardSys.h" #include "sourcemm_api.h" #include "sourcemod.h" #include "TextParsers.h" #include "Logger.h" #include "ExtensionSys.h" #include "sm_srvcmds.h" #include "sm_stringutil.h" #include "ConCmdManager.h" #include "PlayerManager.h" #include "CoreConfig.h" #include "Translator.h" CPluginManager g_PluginSys; HandleType_t g_PluginType = 0; IdentityType_t g_PluginIdent = 0; CPlugin::CPlugin(const char *file) { static int MySerial = 0; m_type = PluginType_Private; m_status = Plugin_Uncompiled; m_serial = ++MySerial; m_pRuntime = NULL; m_errormsg[256] = '\0'; snprintf(m_filename, sizeof(m_filename), "%s", file); m_handle = 0; m_ident = NULL; m_pProps = sm_trie_create(); m_FakeNativesMissing = false; m_LibraryMissing = false; m_bGotAllLoaded = false; m_pPhrases = g_Translator.CreatePhraseCollection(); m_MaxClientsVar = NULL; } CPlugin::~CPlugin() { if (m_handle) { HandleSecurity sec; sec.pOwner = g_PluginSys.GetIdentity(); sec.pIdentity = sec.pOwner; g_HandleSys.FreeHandle(m_handle, &sec); g_ShareSys.DestroyIdentity(m_ident); } if (m_pRuntime != NULL) { delete m_pRuntime; m_pRuntime = NULL; } if (m_pProps) { sm_trie_destroy(m_pProps); } for (size_t i=0; iDestroy(); m_pPhrases = NULL; } } void CPlugin::InitIdentity() { if (!m_handle) { m_ident = g_ShareSys.CreateIdentity(g_PluginIdent, this); m_handle = g_HandleSys.CreateHandle(g_PluginType, this, g_PluginSys.GetIdentity(), g_PluginSys.GetIdentity(), NULL); m_pRuntime->GetDefaultContext()->SetKey(1, m_ident); m_pRuntime->GetDefaultContext()->SetKey(2, (IPlugin *)this); } } unsigned int CPlugin::CalcMemUsage() { unsigned int base_size = sizeof(CPlugin) + sizeof(IdentityToken_t) + (m_configs.size() * (sizeof(AutoConfig *) + sizeof(AutoConfig))) + sm_trie_mem_usage(m_pProps); for (unsigned int i = 0; i < m_configs.size(); i++) { base_size += m_configs[i]->autocfg.size(); base_size += m_configs[i]->folder.size(); } for (List::iterator i = m_Libraries.begin(); i != m_Libraries.end(); i++) { base_size += (*i).size(); } for (List::iterator i = m_RequiredLibs.begin(); i != m_RequiredLibs.end(); i++) { base_size += (*i).size(); } return base_size; } Handle_t CPlugin::GetMyHandle() { return m_handle; } CPlugin *CPlugin::CreatePlugin(const char *file, char *error, size_t maxlength) { char fullpath[PLATFORM_MAX_PATH]; g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", file); FILE *fp = fopen(fullpath, "rb"); CPlugin *pPlugin = new CPlugin(file); if (!fp) { if (error) { snprintf(error, maxlength, "Unable to open file"); } pPlugin->m_status = Plugin_BadLoad; return pPlugin; } fclose(fp); return pPlugin; } bool CPlugin::GetProperty(const char *prop, void **ptr, bool remove/* =false */) { bool exists = sm_trie_retrieve(m_pProps, prop, ptr); if (exists && remove) { sm_trie_delete(m_pProps, prop); } return exists; } bool CPlugin::SetProperty(const char *prop, void *ptr) { return sm_trie_insert(m_pProps, prop, ptr); } IPluginRuntime *CPlugin::GetRuntime() { return m_pRuntime; } void CPlugin::SetErrorState(PluginStatus status, const char *error_fmt, ...) { PluginStatus old_status = m_status; m_status = status; if (old_status == Plugin_Running) { /* Tell everyone we're now paused */ g_PluginSys._SetPauseState(this, true); } va_list ap; va_start(ap, error_fmt); vsnprintf(m_errormsg, sizeof(m_errormsg), error_fmt, ap); va_end(ap); if (m_pRuntime != NULL) { m_pRuntime->SetPauseState(true); } } bool CPlugin::UpdateInfo() { /* Now grab the info */ uint32_t idx; IPluginContext *base = GetBaseContext(); int err = base->FindPubvarByName("myinfo", &idx); memset(&m_info, 0, sizeof(m_info)); if (err == SP_ERROR_NONE) { struct sm_plugininfo_c_t { cell_t name; cell_t description; cell_t author; cell_t version; cell_t url; }; sm_plugininfo_c_t *cinfo; cell_t local_addr; base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&cinfo); base->LocalToString(cinfo->name, (char **)&m_info.name); base->LocalToString(cinfo->description, (char **)&m_info.description); base->LocalToString(cinfo->author, (char **)&m_info.author); base->LocalToString(cinfo->url, (char **)&m_info.url); base->LocalToString(cinfo->version, (char **)&m_info.version); } m_info.author = m_info.author ? m_info.author : ""; m_info.description = m_info.description ? m_info.description : ""; m_info.name = m_info.name ? m_info.name : ""; m_info.url = m_info.url ? m_info.url : ""; m_info.version = m_info.version ? m_info.version : ""; if ((err = base->FindPubvarByName("__version", &idx)) == SP_ERROR_NONE) { struct __version_info { cell_t version; cell_t filevers; cell_t date; cell_t time; }; __version_info *info; cell_t local_addr; const char *pDate, *pTime, *pFileVers; pDate = ""; pTime = ""; base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&info); m_FileVersion = info->version; if (m_FileVersion >= 3) { base->LocalToString(info->date, (char **)&pDate); base->LocalToString(info->time, (char **)&pTime); UTIL_Format(m_DateTime, sizeof(m_DateTime), "%s %s", pDate, pTime); } if (m_FileVersion > 4) { base->LocalToString(info->filevers, (char **)&pFileVers); SetErrorState(Plugin_Failed, "Newer SourceMod required (%s or higher)", pFileVers); return false; } } else { m_FileVersion = 0; } if ((err = base->FindPubvarByName("MaxClients", &idx)) == SP_ERROR_NONE) { base->GetPubvarByIndex(idx, &m_MaxClientsVar); } return true; } void CPlugin::SyncMaxClients(int max_clients) { if (m_MaxClientsVar == NULL) { return; } *m_MaxClientsVar->offs = max_clients; } void CPlugin::Call_OnPluginStart() { if (m_status != Plugin_Loaded) { return; } m_status = Plugin_Running; SyncMaxClients(g_Players.MaxClients()); cell_t result; IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginStart"); if (!pFunction) { return; } int err; if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE) { SetErrorState(Plugin_Error, "Error detected in plugin startup (see error logs)"); } } void CPlugin::Call_OnPluginEnd() { if (m_status > Plugin_Paused) { return; } cell_t result; IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginEnd"); if (!pFunction) { return; } pFunction->Execute(&result); } void CPlugin::Call_OnAllPluginsLoaded() { if (m_status > Plugin_Paused) { return; } if (m_bGotAllLoaded) { return; } m_bGotAllLoaded = true; cell_t result; IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnAllPluginsLoaded"); if (pFunction != NULL) { pFunction->Execute(&result); } if (g_OnMapStarted) { if ((pFunction = m_pRuntime->GetFunctionByName("OnMapStart")) != NULL) { pFunction->Execute(NULL); } } if (SM_AreConfigsExecuted()) { SM_ExecuteForPlugin(GetBaseContext()); } } bool CPlugin::Call_AskPluginLoad(char *error, size_t maxlength) { if (m_status != Plugin_Created) { return false; } m_status = Plugin_Loaded; int err; cell_t result; IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("AskPluginLoad"); if (!pFunction) { return true; } pFunction->PushCell(m_handle); pFunction->PushCell(g_PluginSys.IsLateLoadTime() ? 1 : 0); pFunction->PushStringEx(error, maxlength, 0, SM_PARAM_COPYBACK); pFunction->PushCell(maxlength); if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE) { return false; } if (!result || m_status != Plugin_Loaded) { return false; } return true; } void *CPlugin::GetPluginStructure() { return NULL; } IPluginContext *CPlugin::GetBaseContext() { if (m_pRuntime == NULL) { return NULL; } return m_pRuntime->GetDefaultContext(); } sp_context_t *CPlugin::GetContext() { return NULL; } const char *CPlugin::GetFilename() { return m_filename; } PluginType CPlugin::GetType() { return m_type; } const sm_plugininfo_t *CPlugin::GetPublicInfo() { if (GetStatus() >= Plugin_Created) { return NULL; } return &m_info; } unsigned int CPlugin::GetSerial() { return m_serial; } PluginStatus CPlugin::GetStatus() { return m_status; } bool CPlugin::IsDebugging() { if (m_pRuntime == NULL) { return false; } return true; } void CPlugin::LibraryActions(bool dropping) { List::iterator iter; for (iter = m_Libraries.begin(); iter != m_Libraries.end(); iter++) { g_PluginSys.OnLibraryAction((*iter).c_str(), true, dropping); } } bool CPlugin::SetPauseState(bool paused) { if (paused && GetStatus() != Plugin_Running) { return false; } else if (!paused && GetStatus() != Plugin_Paused) { return false; } if (paused) { LibraryActions(true); } IPluginFunction *pFunction = m_pRuntime->GetFunctionByName("OnPluginPauseChange"); if (pFunction) { cell_t result; pFunction->PushCell(paused ? 1 : 0); pFunction->Execute(&result); } if (paused) { m_status = Plugin_Paused; m_pRuntime->SetPauseState(true); } else { m_status = Plugin_Running; m_pRuntime->SetPauseState(false); } g_PluginSys._SetPauseState(this, paused); if (!paused) { LibraryActions(false); } return true; } IdentityToken_t *CPlugin::GetIdentity() { return m_ident; } bool CPlugin::IsRunnable() { return (m_status <= Plugin_Paused) ? true : false; } time_t CPlugin::GetFileTimeStamp() { char path[PLATFORM_MAX_PATH]; g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "plugins/%s", m_filename); #ifdef PLATFORM_WINDOWS struct _stat s; if (_stat(path, &s) != 0) #elif defined PLATFORM_POSIX struct stat s; if (stat(path, &s) != 0) #endif { return 0; } else { return s.st_mtime; } } time_t CPlugin::GetTimeStamp() { return m_LastAccess; } void CPlugin::SetTimeStamp(time_t t) { m_LastAccess = t; } IPhraseCollection *CPlugin::GetPhrases() { return m_pPhrases; } void CPlugin::DependencyDropped(CPlugin *pOwner) { if (!m_pRuntime) { return; } List::iterator reqlib_iter; List::iterator lib_iter; for (lib_iter=pOwner->m_Libraries.begin(); lib_iter!=pOwner->m_Libraries.end(); lib_iter++) { for (reqlib_iter=m_RequiredLibs.begin(); reqlib_iter!=m_RequiredLibs.end(); reqlib_iter++) { if ((*reqlib_iter) == (*lib_iter)) { m_LibraryMissing = true; } } } List::iterator iter; NativeEntry *pNative; sp_native_t *native; uint32_t idx; unsigned int unbound = 0; for (iter = pOwner->m_Natives.begin(); iter != pOwner->m_Natives.end(); iter++) { pNative = (*iter); /* Find this native! */ if (m_pRuntime->FindNativeByName(pNative->name, &idx) != SP_ERROR_NONE) { continue; } /* Unbind it */ m_pRuntime->GetNativeByIndex(idx, &native); native->pfn = NULL; native->status = SP_NATIVE_UNBOUND; unbound++; } if (unbound) { m_FakeNativesMissing = true; } /* :IDEA: in the future, add native trapping? */ if (m_FakeNativesMissing || m_LibraryMissing) { SetErrorState(Plugin_Error, "Depends on plugin: %s", pOwner->GetFilename()); } } unsigned int CPlugin::GetConfigCount() { return (unsigned int)m_configs.size(); } AutoConfig *CPlugin::GetConfig(unsigned int i) { if (i >= GetConfigCount()) { return NULL; } return m_configs[i]; } void CPlugin::AddConfig(bool autoCreate, const char *cfg, const char *folder) { /* Do a check for duplicates to prevent double-execution */ for (size_t i = 0; i < m_configs.size(); i++) { if (m_configs[i]->autocfg.compare(cfg) == 0 && m_configs[i]->folder.compare(folder) == 0 && m_configs[i]->create == autoCreate) { return; } } AutoConfig *c = new AutoConfig; c->autocfg = cfg; c->folder = folder; c->create = autoCreate; m_configs.push_back(c); } void CPlugin::DropEverything() { CPlugin *pOther; List::iterator iter; List::iterator wk_iter; /* Tell everyone that depends on us that we're about to drop */ for (iter = m_Dependents.begin(); iter != m_Dependents.end(); iter++) { pOther = (*iter); pOther->DependencyDropped(this); } /* Note: we don't care about things we depend on. * The reason is that extensions have their own cleanup * code for plugins. Although the "right" design would be * to centralize that here, i'm omitting it for now. Thus, * the code below to walk the plugins list will suffice. */ /* Other plugins could be holding weak references that were * added by us. We need to clean all of those up now. */ for (iter = g_PluginSys.m_plugins.begin(); iter != g_PluginSys.m_plugins.end(); iter++) { (*iter)->DropRefsTo(this); } /* Proceed with the rest of the necessities. */ CNativeOwner::DropEverything(); } bool CPlugin::AddFakeNative(IPluginFunction *pFunc, const char *name, SPVM_FAKENATIVE_FUNC func) { NativeEntry *pEntry; if ((pEntry = g_ShareSys.AddFakeNative(pFunc, name, func)) == NULL) { return false; } m_Natives.push_back(pEntry); return true; } /******************* * PLUGIN ITERATOR * *******************/ CPluginManager::CPluginIterator::CPluginIterator(List *_mylist) { mylist = _mylist; Reset(); } IPlugin *CPluginManager::CPluginIterator::GetPlugin() { return (*current); } bool CPluginManager::CPluginIterator::MorePlugins() { return (current != mylist->end()); } void CPluginManager::CPluginIterator::NextPlugin() { current++; } void CPluginManager::CPluginIterator::Release() { g_PluginSys.ReleaseIterator(this); } CPluginManager::CPluginIterator::~CPluginIterator() { } void CPluginManager::CPluginIterator::Reset() { current = mylist->begin(); } /****************** * PLUGIN MANAGER * ******************/ CPluginManager::CPluginManager() { m_LoadLookup = sm_trie_create(); m_AllPluginsLoaded = false; m_MyIdent = NULL; m_LoadingLocked = false; } CPluginManager::~CPluginManager() { /* :NOTICE: * Ignore the fact that there might be plugins in the cache. * This usually means that Core is not being unloaded properly, and everything * will crash anyway. YAY */ sm_trie_destroy(m_LoadLookup); CStack::iterator iter; for (iter=m_iters.begin(); iter!=m_iters.end(); iter++) { delete (*iter); } m_iters.popall(); } void CPluginManager::Shutdown() { List::iterator iter; while ((iter = m_plugins.begin()) != m_plugins.end()) { UnloadPlugin(*iter); } } void CPluginManager::LoadAll_FirstPass(const char *config, const char *basedir) { /* First read in the database of plugin settings */ SMCError err; SMCStates states; m_AllPluginsLoaded = false; if ((err=textparsers->ParseFile_SMC(config, &m_PluginInfo, &states)) != SMCError_Okay) { g_Logger.LogError("[SM] Encountered fatal error parsing file \"%s\"", config); const char *err_msg = textparsers->GetSMCErrorString(err); if (err_msg) { g_Logger.LogError("[SM] Parse error encountered: \"%s\"", err_msg); } } LoadPluginsFromDir(basedir, NULL); } void CPluginManager::LoadPluginsFromDir(const char *basedir, const char *localpath) { char base_path[PLATFORM_MAX_PATH]; /* Form the current path to start reading from */ if (localpath == NULL) { g_LibSys.PathFormat(base_path, sizeof(base_path), "%s", basedir); } else { g_LibSys.PathFormat(base_path, sizeof(base_path), "%s/%s", basedir, localpath); } IDirectory *dir = g_LibSys.OpenDirectory(base_path); if (!dir) { char error[256]; g_LibSys.GetPlatformError(error, sizeof(error)); g_Logger.LogError("[SM] Failure reading from plugins path: %s", localpath); g_Logger.LogError("[SM] Platform returned error: %s", error); return; } while (dir->MoreFiles()) { if (dir->IsEntryDirectory() && (strcmp(dir->GetEntryName(), ".") != 0) && (strcmp(dir->GetEntryName(), "..") != 0) && (strcmp(dir->GetEntryName(), "disabled") != 0) && (strcmp(dir->GetEntryName(), "optional") != 0)) { char new_local[PLATFORM_MAX_PATH]; if (localpath == NULL) { /* If no path yet, don't add a former slash */ snprintf(new_local, sizeof(new_local), "%s", dir->GetEntryName()); } else { g_LibSys.PathFormat(new_local, sizeof(new_local), "%s/%s", localpath, dir->GetEntryName()); } LoadPluginsFromDir(basedir, new_local); } else if (dir->IsEntryFile()) { const char *name = dir->GetEntryName(); size_t len = strlen(name); if (len >= 4 && strcmp(&name[len-4], ".smx") == 0) { /* If the filename matches, load the plugin */ char plugin[PLATFORM_MAX_PATH]; if (localpath == NULL) { snprintf(plugin, sizeof(plugin), "%s", name); } else { g_LibSys.PathFormat(plugin, sizeof(plugin), "%s/%s", localpath, name); } LoadAutoPlugin(plugin); } } dir->NextEntry(); } g_LibSys.CloseDirectory(dir); } LoadRes CPluginManager::_LoadPlugin(CPlugin **_plugin, const char *path, bool debug, PluginType type, char error[], size_t maxlength) { if (m_LoadingLocked) { return LoadRes_NeverLoad; } int err; bool no_load = false; PluginSettings *pset; unsigned int setcount = m_PluginInfo.GetSettingsNum(); for (unsigned int i=0; iblockload_val) { no_load = true; break; } } /** * Does this plugin already exist? */ CPlugin *pPlugin; if (sm_trie_retrieve(m_LoadLookup, path, (void **)&pPlugin)) { /* Check to see if we should try reloading it */ if (pPlugin->GetStatus() == Plugin_BadLoad || pPlugin->GetStatus() == Plugin_Error || pPlugin->GetStatus() == Plugin_Failed || no_load) { UnloadPlugin(pPlugin); } else { if (_plugin) { *_plugin = pPlugin; } return LoadRes_AlreadyLoaded; } } if (no_load) { return LoadRes_NeverLoad; } pPlugin = CPlugin::CreatePlugin(path, error, maxlength); assert(pPlugin != NULL); pPlugin->m_type = PluginType_MapUpdated; ICompilation *co = NULL; if (pPlugin->m_status == Plugin_Uncompiled) { co = g_pSourcePawn2->StartCompilation(); } for (unsigned int i=0; im_type = pset->type_val; if (co) { for (unsigned int j=0; jopts_num; j++) { const char *key, *val; m_PluginInfo.GetOptionsForPlugin(pset, j, &key, &val); if (!key || !val) { continue; } if ((err = co->SetOption(key, val)) == SP_ERROR_NONE) { if (error) { snprintf(error, maxlength, "Unable to set JIT option (key \"%s\") (value \"%s\")", key, val); } co->Abort(); co = NULL; break; } } } } /* Do the actual compiling */ if (co != NULL) { char fullpath[PLATFORM_MAX_PATH]; g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", pPlugin->m_filename); pPlugin->m_pRuntime = g_pSourcePawn2->LoadPlugin(co, fullpath, &err); if (pPlugin->m_pRuntime == NULL) { snprintf(error, maxlength, "Unable to load plugin (error %d: %s)", err, g_pSourcePawn2->GetErrorString(err)); pPlugin->m_status = Plugin_BadLoad; } else { if (pPlugin->UpdateInfo()) { pPlugin->m_status = Plugin_Created; } else { UTIL_Format(error, maxlength, "%s", pPlugin->m_errormsg); } } } /* Get the status */ if (pPlugin->GetStatus() == Plugin_Created) { /* First native pass - add anything from Core */ g_ShareSys.BindNativesToPlugin(pPlugin, true); pPlugin->InitIdentity(); if (pPlugin->Call_AskPluginLoad(error, maxlength)) { /* Autoload any modules */ LoadOrRequireExtensions(pPlugin, 1, error, maxlength); } else { pPlugin->SetErrorState(Plugin_Failed, "%s", error); } } /* Save the time stamp */ time_t t = pPlugin->GetFileTimeStamp(); pPlugin->SetTimeStamp(t); if (_plugin) { *_plugin = pPlugin; } return (pPlugin->GetStatus() == Plugin_Loaded) ? LoadRes_Successful : LoadRes_Failure; } IPlugin *CPluginManager::LoadPlugin(const char *path, bool debug, PluginType type, char error[], size_t maxlength, bool *wasloaded) { CPlugin *pl; LoadRes res; *wasloaded = false; if ((res=_LoadPlugin(&pl, path, true, type, error, maxlength)) == LoadRes_Failure) { delete pl; return NULL; } if (res == LoadRes_AlreadyLoaded) { *wasloaded = true; return pl; } if (res == LoadRes_NeverLoad) { if (m_LoadingLocked) { UTIL_Format(error, maxlength, "There is a global plugin loading lock in effect"); } else { UTIL_Format(error, maxlength, "This plugin is blocked from loading (see plugin_settings.cfg)"); } return NULL; } AddPlugin(pl); /* Run second pass if we need to */ if (IsLateLoadTime() && pl->GetStatus() == Plugin_Loaded) { if (!RunSecondPass(pl, error, maxlength)) { UnloadPlugin(pl); return NULL; } pl->Call_OnAllPluginsLoaded(); } return pl; } void CPluginManager::LoadAutoPlugin(const char *plugin) { CPlugin *pl = NULL; LoadRes res; char error[255] = "Unknown error"; if ((res=_LoadPlugin(&pl, plugin, false, PluginType_MapUpdated, error, sizeof(error))) == LoadRes_Failure) { g_Logger.LogError("[SM] Failed to load plugin \"%s\": %s", plugin, error); pl->SetErrorState( pl->GetStatus() == Plugin_BadLoad ? Plugin_BadLoad : Plugin_Failed, "%s", error); } if (res == LoadRes_Successful || res == LoadRes_Failure) { AddPlugin(pl); } } void CPluginManager::AddPlugin(CPlugin *pPlugin) { List::iterator iter; IPluginsListener *pListener; for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++) { pListener = (*iter); pListener->OnPluginCreated(pPlugin); } m_plugins.push_back(pPlugin); sm_trie_insert(m_LoadLookup, pPlugin->m_filename, pPlugin); } void CPluginManager::LoadAll_SecondPass() { List::iterator iter; CPlugin *pPlugin; char error[256]; for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { pPlugin = (*iter); if (pPlugin->GetStatus() == Plugin_Loaded) { error[0] = '\0'; if (!RunSecondPass(pPlugin, error, sizeof(error))) { g_Logger.LogError("[SM] Unable to load plugin \"%s\": %s", pPlugin->GetFilename(), error); pPlugin->SetErrorState(Plugin_Failed, "%s", error); } } } m_AllPluginsLoaded = true; } bool CPluginManager::FindOrRequirePluginDeps(CPlugin *pPlugin, char *error, size_t maxlength) { struct _pl { cell_t name; cell_t file; cell_t required; } *pl; IPluginContext *pBase = pPlugin->GetBaseContext(); uint32_t num = pBase->GetPubVarsNum(); sp_pubvar_t *pubvar; char *name, *file; char pathfile[PLATFORM_MAX_PATH]; for (uint32_t i=0; iGetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE) { continue; } if (strncmp(pubvar->name, "__pl_", 5) == 0) { pl = (_pl *)pubvar->offs; if (pBase->LocalToString(pl->file, &file) != SP_ERROR_NONE) { continue; } if (pBase->LocalToString(pl->name, &name) != SP_ERROR_NONE) { continue; } g_LibSys.GetFileFromPath(pathfile, sizeof(pathfile), pPlugin->GetFilename()); if (strcmp(pathfile, file) == 0) { continue; } if (pl->required == false) { IPluginFunction *pFunc; char buffer[64]; UTIL_Format(buffer, sizeof(buffer), "__pl_%s_SetNTVOptional", &pubvar->name[5]); if ((pFunc=pBase->GetFunctionByName(buffer))) { cell_t res; pFunc->Execute(&res); if (pPlugin->GetBaseContext()->GetLastNativeError() != SP_ERROR_NONE) { if (error) { snprintf(error, maxlength, "Fatal error during initializing plugin load"); } return false; } } } else { /* Check that we aren't registering the same library twice */ if (pPlugin->m_RequiredLibs.find(name) == pPlugin->m_RequiredLibs.end()) { pPlugin->m_RequiredLibs.push_back(name); } else { continue; } List::iterator iter; CPlugin *pl; bool found = false; for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { pl = (*iter); if (pl->m_Libraries.find(name) != pl->m_Libraries.end()) { found = true; break; } } if (!found) { if (error) { snprintf(error, maxlength, "Could not find required plugin \"%s\"", name); } return false; } } } } return true; } bool CPluginManager::LoadOrRequireExtensions(CPlugin *pPlugin, unsigned int pass, char *error, size_t maxlength) { /* Find any extensions this plugin needs */ struct _ext { cell_t name; cell_t file; cell_t autoload; cell_t required; } *ext; IPluginContext *pBase = pPlugin->GetBaseContext(); uint32_t num = pBase->GetPubVarsNum(); sp_pubvar_t *pubvar; IExtension *pExt; char path[PLATFORM_MAX_PATH]; char *file, *name; for (uint32_t i=0; iGetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE) { continue; } if (strncmp(pubvar->name, "__ext_", 6) == 0) { ext = (_ext *)pubvar->offs; if (pBase->LocalToString(ext->file, &file) != SP_ERROR_NONE) { continue; } if (pBase->LocalToString(ext->name, &name) != SP_ERROR_NONE) { continue; } if (pass == 1) { /* Attempt to auto-load if necessary */ if (ext->autoload) { g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file); g_Extensions.LoadAutoExtension(path); } } else if (pass == 2) { /* Is this required? */ if (ext->required) { g_LibSys.PathFormat(path, PLATFORM_MAX_PATH, "%s", file); if ((pExt = g_Extensions.FindExtensionByFile(path)) == NULL) { pExt = g_Extensions.FindExtensionByName(name); } /* :TODO: should we bind to unloaded extensions? * Currently the extension manager will ignore this. */ if (!pExt || !pExt->IsRunning(NULL, 0)) { if (error) { snprintf(error, maxlength, "Required extension \"%s\" file(\"%s\") not running", name, file); } return false; } else { g_Extensions.BindChildPlugin(pExt, pPlugin); } } else { IPluginFunction *pFunc; char buffer[64]; UTIL_Format(buffer, sizeof(buffer), "__ext_%s_SetNTVOptional", &pubvar->name[6]); if ((pFunc = pBase->GetFunctionByName(buffer)) != NULL) { cell_t res; pFunc->Execute(&res); if (pPlugin->GetBaseContext()->GetLastNativeError() != SP_ERROR_NONE) { if (error) { UTIL_Format(error, maxlength, "Fatal error during plugin initialization (ext req)"); } return false; } } } } } } return true; } bool CPluginManager::RunSecondPass(CPlugin *pPlugin, char *error, size_t maxlength) { /* Second pass for extension requirements */ if (!LoadOrRequireExtensions(pPlugin, 2, error, maxlength)) { return false; } if (!FindOrRequirePluginDeps(pPlugin, error, maxlength)) { return false; } /* Run another binding pass */ g_ShareSys.BindNativesToPlugin(pPlugin, false); /* Find any unbound natives. Right now, these are not allowed. */ IPluginContext *pContext = pPlugin->GetBaseContext(); uint32_t num = pContext->GetNativesNum(); sp_native_t *native; for (unsigned int i=0; iGetNativeByIndex(i, &native) != SP_ERROR_NONE) { break; } if (native->status == SP_NATIVE_UNBOUND && native->name[0] != '@' && !(native->flags & SP_NTVFLAG_OPTIONAL)) { if (error) { snprintf(error, maxlength, "Native \"%s\" was not found", native->name); } return false; } } /* Finish by telling all listeners */ List::iterator iter; IPluginsListener *pListener; for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++) { pListener = (*iter); pListener->OnPluginLoaded(pPlugin); } /* Tell this plugin to finish initializing itself */ pPlugin->Call_OnPluginStart(); /* Now, if we have fake natives, go through all plugins that might need rebinding */ if (pPlugin->GetStatus() <= Plugin_Paused && pPlugin->m_Natives.size()) { List::iterator pl_iter; CPlugin *pOther; for (pl_iter = m_plugins.begin(); pl_iter != m_plugins.end(); pl_iter++) { pOther = (*pl_iter); if ((pOther->GetStatus() == Plugin_Error && (pOther->m_FakeNativesMissing || pOther->m_LibraryMissing)) || pOther->m_FakeNativesMissing) { TryRefreshDependencies(pOther); } else if ((pOther->GetStatus() == Plugin_Running || pOther->GetStatus() == Plugin_Paused) && pOther != pPlugin) { List::iterator nv_iter; for (nv_iter = pPlugin->m_Natives.begin(); nv_iter != pPlugin->m_Natives.end(); nv_iter++) { g_ShareSys.BindNativeToPlugin(pOther, (*nv_iter)); } } } } /* Go through our libraries and tell other plugins they're added */ List::iterator s_iter; for (s_iter = pPlugin->m_Libraries.begin(); s_iter != pPlugin->m_Libraries.end(); s_iter++) { OnLibraryAction((*s_iter).c_str(), true, false); } /* :TODO: optimize? does this even matter? */ pPlugin->GetPhrases()->AddPhraseFile("core.phrases"); return true; } void CPluginManager::TryRefreshDependencies(CPlugin *pPlugin) { assert(pPlugin->GetBaseContext() != NULL); g_ShareSys.BindNativesToPlugin(pPlugin, false); List::iterator lib_iter; List::iterator req_iter; List::iterator pl_iter; CPlugin *pl; for (req_iter=pPlugin->m_RequiredLibs.begin(); req_iter!=pPlugin->m_RequiredLibs.end(); req_iter++) { bool found = false; for (pl_iter=m_plugins.begin(); pl_iter!=m_plugins.end(); pl_iter++) { pl = (*pl_iter); for (lib_iter=pl->m_Libraries.begin(); lib_iter!=pl->m_Libraries.end(); lib_iter++) { if ((*req_iter) == (*lib_iter)) { found = true; } } } if (!found) { pPlugin->SetErrorState(Plugin_Error, "Library not found: %s", (*req_iter).c_str()); return; } } /* Find any unbound natives * Right now, these are not allowed */ IPluginContext *pContext = pPlugin->GetBaseContext(); uint32_t num = pContext->GetNativesNum(); sp_native_t *native; for (unsigned int i=0; iGetNativeByIndex(i, &native) != SP_ERROR_NONE) { break; } if (native->status == SP_NATIVE_UNBOUND && !(native->flags & SP_NTVFLAG_OPTIONAL)) { pPlugin->SetErrorState(Plugin_Error, "Native not found: %s", native->name); return; } } if (pPlugin->GetStatus() == Plugin_Error) { /* If we got here, all natives are okay again! */ pPlugin->m_status = Plugin_Running; if (pPlugin->m_pRuntime->IsPaused()) { pPlugin->m_pRuntime->SetPauseState(false); _SetPauseState(pPlugin, false); } } } bool CPluginManager::UnloadPlugin(IPlugin *plugin) { CPlugin *pPlugin = (CPlugin *)plugin; /* This prevents removal during insertion or anything else weird */ if (m_plugins.find(pPlugin) == m_plugins.end()) { return false; } IPluginContext *pContext = plugin->GetBaseContext(); if (pContext != NULL && pContext->IsInExec()) { char buffer[255]; UTIL_Format(buffer, sizeof(buffer), "sm plugins unload %s\n", plugin->GetFilename()); engine->ServerCommand(buffer); return false; } /* Remove us from the lookup table and linked list */ m_plugins.remove(pPlugin); sm_trie_delete(m_LoadLookup, pPlugin->m_filename); /* Go through our libraries and tell other plugins they're gone */ List::iterator s_iter; for (s_iter = pPlugin->m_Libraries.begin(); s_iter != pPlugin->m_Libraries.end(); s_iter++) { OnLibraryAction((*s_iter).c_str(), true, true); } List::iterator iter; IPluginsListener *pListener; if (pPlugin->GetStatus() <= Plugin_Error) { /* Notify listeners of unloading */ for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++) { pListener = (*iter); pListener->OnPluginUnloaded(pPlugin); } /* Notify plugin */ pPlugin->Call_OnPluginEnd(); } pPlugin->DropEverything(); for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++) { /* Notify listeners of destruction */ pListener = (*iter); pListener->OnPluginDestroyed(pPlugin); } /* Tell the plugin to delete itself */ delete pPlugin; return true; } IPlugin *CPluginManager::FindPluginByContext(const sp_context_t *ctx) { IPlugin *pPlugin; IPluginContext *pContext; pContext = reinterpret_cast(const_cast(ctx)); if (pContext->GetKey(2, (void **)&pPlugin)) { return pPlugin; } return NULL; } CPlugin *CPluginManager::GetPluginByCtx(const sp_context_t *ctx) { return (CPlugin *)FindPluginByContext(ctx); } unsigned int CPluginManager::GetPluginCount() { return m_plugins.size(); } void CPluginManager::AddPluginsListener(IPluginsListener *listener) { m_listeners.push_back(listener); } void CPluginManager::RemovePluginsListener(IPluginsListener *listener) { m_listeners.remove(listener); } IPluginIterator *CPluginManager::GetPluginIterator() { if (m_iters.empty()) { return new CPluginIterator(&m_plugins); } else { CPluginIterator *iter = m_iters.front(); m_iters.pop(); iter->Reset(); return iter; } } void CPluginManager::ReleaseIterator(CPluginIterator *iter) { m_iters.push(iter); } bool CPluginManager::TestAliasMatch(const char *alias, const char *localpath) { /* As an optimization, we do not call strlen, but compute the length in the first pass */ size_t alias_len = 0; size_t local_len = 0; const char *ptr = alias; unsigned int alias_explicit_paths = 0; unsigned int alias_path_end = 0; while (*ptr != '\0') { if (*ptr == '\\' || *ptr == '/') { alias_explicit_paths++; alias_path_end = alias_len; } alias_len++; ptr++; } if (alias_explicit_paths && alias_path_end == alias_len - 1) { /* Trailing slash is totally invalid here */ return false; } ptr = localpath; unsigned int local_explicit_paths = 0; unsigned int local_path_end = 0; while (*ptr != '\0') { if (*ptr == '\\' || *ptr == '/') { local_explicit_paths++; local_path_end = local_len; } local_len++; ptr++; } /* If the alias has more explicit paths than the real path, * no match will be possible. */ if (alias_explicit_paths > local_explicit_paths) { return false; } if (alias_explicit_paths) { /* We need to find if the paths match now. For example, these should all match: * csdm csdm * csdm optional/csdm * csdm/ban optional/crab/csdm/ban */ const char *aliasptr = alias; const char *localptr = localpath; bool match = true; do { if (*aliasptr != *localptr) { /* We have to knock one path off */ local_explicit_paths--; if (alias_explicit_paths > local_explicit_paths) { /* Skip out if we're gonna have an impossible match */ return false; } /* Eat up localptr tokens until we get a result */ while (((localptr - localpath) < (int)local_path_end) && *localptr != '/' && *localptr != '\\') { localptr++; } /* Check if we hit the end of our searchable area. * This probably isn't possible because of the path * count check, but it's a good idea anyway. */ if ((localptr - localpath) >= (int)local_path_end) { return false; } else { /* Consume the slash token */ localptr++; } /* Reset the alias pointer so we can continue consuming */ aliasptr = alias; match = false; continue; } /* Note: * This is safe because if localptr terminates early, aliasptr will too */ do { /* We should never reach the end of the string because of this check. */ bool aliasend = (aliasptr - alias) > (int)alias_path_end; bool localend = (localptr - localpath) > (int)local_path_end; if (aliasend || localend) { if (aliasend && localend) { /* we matched, and we can break out now */ match = true; break; } /* Otherwise, we've hit the end somehow and rest won't match up. Break out. */ match = false; break; } /* If we got here, it's safe to compare the next two tokens */ if (*localptr != *aliasptr) { match = false; break; } localptr++; aliasptr++; } while (true); } while (!match); } /* If we got here, it's time to compare filenames */ const char *aliasptr = alias; const char *localptr = localpath; if (alias_explicit_paths) { aliasptr = &alias[alias_path_end + 1]; } if (local_explicit_paths) { localptr = &localpath[local_path_end + 1]; } while (true) { if (*aliasptr == '*') { /* First, see if this is the last character */ if ((unsigned)(aliasptr - alias) == alias_len - 1) { /* If so, there's no need to match anything else */ return true; } /* Otherwise, we need to search for an appropriate matching sequence in local. * Note that we only need to search up to the next asterisk. */ aliasptr++; bool match = true; const char *local_orig = localptr; do { match = true; while (*aliasptr != '\0' && *aliasptr != '*') { /* Since aliasptr is never '\0', localptr hitting the end will fail */ if (*aliasptr != *localptr) { match = false; break; } aliasptr++; localptr++; } if (!match) { /* If we didn't get a match, we need to advance the search stream. * This will let us skip tokens while still searching for another match. */ localptr = ++local_orig; /* Make sure we don't go out of bounds */ if (*localptr == '\0') { break; } } } while (!match); if (!match) { return false; } else { /* If we got a match, move on to the next token */ continue; } } else if (*aliasptr == '\0') { if (*localptr == '\0' || strcmp(localptr, ".smx") == 0) { return true; } else { return false; } } else if (*aliasptr != *localptr) { return false; } aliasptr++; localptr++; } return true; } bool CPluginManager::IsLateLoadTime() const { return (m_AllPluginsLoaded || !g_SourceMod.IsMapLoading()); } void CPluginManager::OnSourceModAllInitialized() { m_MyIdent = g_ShareSys.CreateCoreIdentity(); HandleAccess sec; g_HandleSys.InitAccessDefaults(NULL, &sec); sec.access[HandleAccess_Delete] = HANDLE_RESTRICT_IDENTITY; sec.access[HandleAccess_Clone] = HANDLE_RESTRICT_IDENTITY; g_PluginType = g_HandleSys.CreateType("Plugin", this, 0, NULL, &sec, m_MyIdent, NULL); g_PluginIdent = g_ShareSys.CreateIdentType("PLUGIN"); g_RootMenu.AddRootConsoleCommand("plugins", "Manage Plugins", this); g_ShareSys.AddInterface(NULL, this); } void CPluginManager::OnSourceModShutdown() { g_RootMenu.RemoveRootConsoleCommand("plugins", this); UnloadAll(); g_HandleSys.RemoveType(g_PluginType, m_MyIdent); g_ShareSys.DestroyIdentType(g_PluginIdent); g_ShareSys.DestroyIdentity(m_MyIdent); } void CPluginManager::OnHandleDestroy(HandleType_t type, void *object) { /* We don't care about the internal object, actually */ } bool CPluginManager::GetHandleApproxSize(HandleType_t type, void *object, unsigned int *pSize) { *pSize = ((CPlugin *)object)->CalcMemUsage(); return true; } IPlugin *CPluginManager::PluginFromHandle(Handle_t handle, HandleError *err) { IPlugin *pPlugin; HandleError _err; HandleSecurity sec; sec.pOwner = NULL; sec.pIdentity = m_MyIdent; if ((_err=g_HandleSys.ReadHandle(handle, g_PluginType, &sec, (void **)&pPlugin)) != HandleError_None) { pPlugin = NULL; } if (err) { *err = _err; } return pPlugin; } CPlugin *CPluginManager::GetPluginByOrder(int num) { if (num < 1 || num > (int)GetPluginCount()) { return NULL; } CPlugin *pl; int id = 1; SourceHook::List::iterator iter; for (iter = m_plugins.begin(); iter != m_plugins.end() && id < num; iter++, id++) {} pl = *iter; return pl; } const char *CPluginManager::GetStatusText(PluginStatus st) { switch (st) { case Plugin_Running: return "Running"; case Plugin_Paused: return "Paused"; case Plugin_Error: return "Error"; case Plugin_Uncompiled: return "Uncompiled"; case Plugin_BadLoad: return "Bad Load"; case Plugin_Failed: return "Failed"; default: assert(false); return "-"; } } void CPluginManager::OnRootConsoleCommand(const char *cmdname, const CCommand &command) { int argcount = command.ArgC(); if (argcount >= 3) { const char *cmd = command.Arg(2); if (strcmp(cmd, "list") == 0) { char buffer[256]; unsigned int id = 1; int plnum = GetPluginCount(); if (!plnum) { g_RootMenu.ConsolePrint("[SM] No plugins loaded"); return; } else { g_RootMenu.ConsolePrint("[SM] Listing %d plugin%s:", GetPluginCount(), (plnum > 1) ? "s" : ""); } CPlugin *pl; SourceHook::List::iterator iter; SourceHook::List m_FailList; for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++, id++) { pl = (*iter); assert(pl->GetStatus() != Plugin_Created); int len = 0; const sm_plugininfo_t *info = pl->GetPublicInfo(); if (pl->GetStatus() != Plugin_Running) { len += UTIL_Format(buffer, sizeof(buffer), " %02d <%s>", id, GetStatusText(pl->GetStatus())); if (pl->GetStatus() <= Plugin_Error) { /* Plugin has failed to load. */ m_FailList.push_back(pl); } } else { len += UTIL_Format(buffer, sizeof(buffer), " %02d", id); } if (pl->GetStatus() < Plugin_Created) { len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " \"%s\"", (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename()); if (IS_STR_FILLED(info->version)) { len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", info->version); } if (IS_STR_FILLED(info->author)) { UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", info->author); } } else { UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", pl->m_filename); } g_RootMenu.ConsolePrint("%s", buffer); } if (!m_FailList.empty()) { g_RootMenu.ConsolePrint("Load Errors:"); SourceHook::List::iterator _iter; CPlugin *pl; for (_iter=m_FailList.begin(); _iter!=m_FailList.end(); _iter++) { pl = (CPlugin *)*_iter; g_RootMenu.ConsolePrint("%s: %s",(IS_STR_FILLED(pl->GetPublicInfo()->name)) ? pl->GetPublicInfo()->name : pl->GetFilename(), pl->m_errormsg); } } return; } else if (strcmp(cmd, "load") == 0) { if (argcount < 4) { g_RootMenu.ConsolePrint("[SM] Usage: sm plugins load "); return; } char error[128]; bool wasloaded; const char *filename = command.Arg(3); char pluginfile[256]; const char *ext = g_LibSys.GetFileExtension(filename) ? "" : ".smx"; UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", filename, ext); IPlugin *pl = LoadPlugin(pluginfile, false, PluginType_MapUpdated, error, sizeof(error), &wasloaded); if (wasloaded) { g_RootMenu.ConsolePrint("[SM] Plugin %s is already loaded.", pluginfile); return; } if (pl) { g_RootMenu.ConsolePrint("[SM] Loaded plugin %s successfully.", pluginfile); } else { g_RootMenu.ConsolePrint("[SM] Plugin %s failed to load: %s.", pluginfile, error); } return; } else if (strcmp(cmd, "unload") == 0) { if (argcount < 4) { g_RootMenu.ConsolePrint("[SM] Usage: sm plugins unload <#|file>"); return; } CPlugin *pl; char *end; const char *arg = command.Arg(3); int id = strtol(arg, &end, 10); if (*end == '\0') { pl = GetPluginByOrder(id); if (!pl) { g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id); return; } } else { char pluginfile[256]; const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx"; UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext); if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl)) { g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile); return; } } char name[PLATFORM_MAX_PATH]; if (pl->GetStatus() < Plugin_Created) { const sm_plugininfo_t *info = pl->GetPublicInfo(); UTIL_Format(name, sizeof(name), (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename()); } else { UTIL_Format(name, sizeof(name), "%s", pl->GetFilename()); } if (UnloadPlugin(pl)) { g_RootMenu.ConsolePrint("[SM] Plugin %s unloaded successfully.", name); } else { g_RootMenu.ConsolePrint("[SM] Failed to unload plugin %s.", name); } return; } else if (strcmp(cmd, "unload_all") == 0) { g_PluginSys.UnloadAll(); g_RootMenu.ConsolePrint("[SM] All plugins have been unloaded."); return; } else if (strcmp(cmd, "load_lock") == 0) { if (m_LoadingLocked) { g_RootMenu.ConsolePrint("[SM] There is already a loading lock in effect."); } else { m_LoadingLocked = true; g_RootMenu.ConsolePrint("[SM] Loading is now locked; no plugins will be loaded or re-loaded."); } return; } else if (strcmp(cmd, "load_unlock") == 0) { if (m_LoadingLocked) { m_LoadingLocked = false; g_RootMenu.ConsolePrint("[SM] The loading lock is no longer in effect."); } else { g_RootMenu.ConsolePrint("[SM] There was no loading lock in effect."); } return; } else if (strcmp(cmd, "info") == 0) { if (argcount < 4) { g_RootMenu.ConsolePrint("[SM] Usage: sm plugins info <#>"); return; } CPlugin *pl; char *end; const char *arg = command.Arg(3); int id = strtol(arg, &end, 10); if (*end == '\0') { pl = GetPluginByOrder(id); if (!pl) { g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id); return; } } else { char pluginfile[256]; const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx"; UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext); if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl)) { g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile); return; } } const sm_plugininfo_t *info = pl->GetPublicInfo(); g_RootMenu.ConsolePrint(" Filename: %s", pl->GetFilename()); if (pl->GetStatus() <= Plugin_Error) { if (IS_STR_FILLED(info->name)) { if (IS_STR_FILLED(info->description)) { g_RootMenu.ConsolePrint(" Title: %s (%s)", info->name, info->description); } else { g_RootMenu.ConsolePrint(" Title: %s", info->name); } } if (IS_STR_FILLED(info->author)) { g_RootMenu.ConsolePrint(" Author: %s", info->author); } if (IS_STR_FILLED(info->version)) { g_RootMenu.ConsolePrint(" Version: %s", info->version); } if (IS_STR_FILLED(info->url)) { g_RootMenu.ConsolePrint(" URL: %s", info->url); } if (pl->GetStatus() == Plugin_Error) { g_RootMenu.ConsolePrint(" Error: %s", pl->m_errormsg); } else { if (pl->GetStatus() == Plugin_Running) { g_RootMenu.ConsolePrint(" Status: running"); } else { g_RootMenu.ConsolePrint(" Status: not running"); } const char *typestr = ""; switch (pl->GetType()) { case PluginType_MapUpdated: typestr = "Map Change if Updated"; break; case PluginType_MapOnly: typestr = "Map Change"; break; case PluginType_Private: case PluginType_Global: typestr = "Never"; break; } g_RootMenu.ConsolePrint(" Reloads: %s", typestr); } if (pl->m_FileVersion >= 3) { g_RootMenu.ConsolePrint(" Timestamp: %s", pl->m_DateTime); } } else { g_RootMenu.ConsolePrint(" Load error: %s", pl->m_errormsg); if (pl->GetStatus() < Plugin_Created) { g_RootMenu.ConsolePrint(" File info: (title \"%s\") (version \"%s\")", info->name ? info->name : "", info->version ? info->version : ""); if (IS_STR_FILLED(info->url)) { g_RootMenu.ConsolePrint(" File URL: %s", info->url); } } } return; } else if (strcmp(cmd, "refresh") == 0) { g_SourceMod.DoGlobalPluginLoads(); g_RootMenu.ConsolePrint("[SM] The plugin list has been refreshed and reloaded."); return; } else if (strcmp(cmd, "reload") == 0) { if (argcount < 4) { g_RootMenu.ConsolePrint("[SM] Usage: sm plugins reload <#|file>"); return; } CPlugin *pl; char *end; const char *arg = command.Arg(3); int id = strtol(arg, &end, 10); if (*end == '\0') { pl = GetPluginByOrder(id); if (!pl) { g_RootMenu.ConsolePrint("[SM] Plugin index %d not found.", id); return; } } else { char pluginfile[256]; const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx"; UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext); if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl)) { g_RootMenu.ConsolePrint("[SM] Plugin %s is not loaded.", pluginfile); return; } } char name[PLATFORM_MAX_PATH]; const sm_plugininfo_t *info = pl->GetPublicInfo(); strcpy(name, (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename()); if (ReloadPlugin(pl)) { g_RootMenu.ConsolePrint("[SM] Plugin %s reloaded successfully.", name); } else { g_RootMenu.ConsolePrint("[SM] Failed to reload plugin %s.", name); } return; } } /* Draw the main menu */ g_RootMenu.ConsolePrint("SourceMod Plugins Menu:"); g_RootMenu.DrawGenericOption("info", "Information about a plugin"); g_RootMenu.DrawGenericOption("list", "Show loaded plugins"); g_RootMenu.DrawGenericOption("load", "Load a plugin"); g_RootMenu.DrawGenericOption("load_lock", "Prevents any more plugins from being loaded"); g_RootMenu.DrawGenericOption("load_unlock", "Re-enables plugin loading"); g_RootMenu.DrawGenericOption("refresh", "Reloads/refreshes all plugins in the plugins folder"); g_RootMenu.DrawGenericOption("reload", "Reloads a plugin"); g_RootMenu.DrawGenericOption("unload", "Unload a plugin"); g_RootMenu.DrawGenericOption("unload_all", "Unloads all plugins"); } bool CPluginManager::ReloadPlugin(CPlugin *pl) { List::iterator iter; char filename[PLATFORM_MAX_PATH]; bool wasloaded; PluginType ptype; IPlugin *newpl; int id = 1; strcpy(filename, pl->m_filename); ptype = pl->GetType(); for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++, id++) { if ((*iter) == pl) { break; } } if (!UnloadPlugin(pl)) { return false; } if (!(newpl=LoadPlugin(filename, true, ptype, NULL, 0, &wasloaded))) { return false; } for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { if ((*iter) == (CPlugin *)newpl) { m_plugins.erase(iter); break; } } int i; for (i=1, iter=m_plugins.begin(); iter!=m_plugins.end() && i::iterator iter; List tmp_list = m_plugins; CPlugin *pl; time_t t; for (iter=tmp_list.begin(); iter!=tmp_list.end(); iter++) { pl = (*iter); if (pl->GetType() == PluginType_MapOnly) { UnloadPlugin((IPlugin *)pl); } else if (pl->GetType() == PluginType_MapUpdated) { t = pl->GetFileTimeStamp(); if (!t || t > pl->GetTimeStamp()) { pl->SetTimeStamp(t); UnloadPlugin((IPlugin *)pl); } } } } void CPluginManager::_SetPauseState(CPlugin *pl, bool paused) { List::iterator iter; IPluginsListener *pListener; for (iter=m_listeners.begin(); iter!=m_listeners.end(); iter++) { pListener = (*iter); pListener->OnPluginPauseChange(pl, paused); } } void CPluginManager::AddFunctionsToForward(const char *name, IChangeableForward *pForward) { List::iterator iter; CPlugin *pPlugin; IPluginFunction *pFunction; for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++) { pPlugin = (*iter); if (pPlugin->GetStatus() <= Plugin_Paused) { pFunction = pPlugin->GetBaseContext()->GetFunctionByName(name); if (pFunction) { pForward->AddFunction(pFunction); } } } } CPlugin *CPluginManager::GetPluginFromIdentity(IdentityToken_t *pToken) { if (pToken->type != g_PluginIdent) { return NULL; } return (CPlugin *)(pToken->ptr); } void CPluginManager::OnLibraryAction(const char *lib, bool is_a_plugin, bool drop) { List::iterator iter; struct _pl { cell_t name; cell_t file; cell_t required; } *plc; struct _ext { cell_t name; cell_t file; cell_t autoload; cell_t required; } *ext; const char *name = drop ? "OnLibraryRemoved" : "OnLibraryAdded"; for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { CPlugin *pl = (*iter); if (pl->GetStatus() != Plugin_Running) { continue; } IPluginContext *pContext = pl->GetBaseContext(); IPluginFunction *pf = pContext->GetFunctionByName(name); if (!pf) { continue; } uint32_t num_vars = pContext->GetPubVarsNum(); for (uint32_t i=0; iGetPubvarByIndex(i, &pubvar) != SP_ERROR_NONE) { continue; } if (is_a_plugin && strncmp(pubvar->name, "__pl_", 5) == 0) { plc = (_pl *)pubvar->offs; if (plc->required) { continue; } char *str; pContext->LocalToString(plc->name, &str); if (strcmp(str, lib) != 0) { continue; } pf->PushString(lib); pf->Execute(NULL); } else if (!is_a_plugin && strncmp(pubvar->name, "__ext_", 6) == 0) { ext = (_ext *)pubvar->offs; if (ext->required) { continue; } char *str; pContext->LocalToString(ext->name, &str); if (strcmp(str, lib) != 0) { continue; } pf->PushString(lib); pf->Execute(NULL); } } } } bool CPluginManager::LibraryExists(const char *lib) { List::iterator iter; for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { CPlugin *pl = (*iter); if (pl->GetStatus() != Plugin_Running) { continue; } List::iterator s_iter; for (s_iter = pl->m_Libraries.begin(); s_iter != pl->m_Libraries.end(); s_iter++) { if ((*s_iter).compare(lib) == 0) { return true; } } } return false; } void CPluginManager::AllPluginsLoaded() { List::iterator iter; CPlugin *pl; for (iter=m_plugins.begin(); iter!=m_plugins.end(); iter++) { pl = (*iter); pl->Call_OnAllPluginsLoaded(); } } void CPluginManager::UnloadAll() { List::iterator iter; while ( (iter = m_plugins.begin()) != m_plugins.end() ) { UnloadPlugin((*iter)); } } int CPluginManager::GetOrderOfPlugin(IPlugin *pl) { int id = 1; List::iterator iter; for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++, id++) { if ((*iter) == pl) { return id; } } return -1; } CPlugin *CPluginManager::FindPluginByConsoleArg(const char *arg) { int id; char *end; CPlugin *pl; id = strtol(arg, &end, 10); if (*end == '\0') { pl = GetPluginByOrder(id); if (!pl) { return NULL; } } else { char pluginfile[256]; const char *ext = g_LibSys.GetFileExtension(arg) ? "" : ".smx"; UTIL_Format(pluginfile, sizeof(pluginfile), "%s%s", arg, ext); if (!sm_trie_retrieve(m_LoadLookup, pluginfile, (void **)&pl)) { return NULL; } } return pl; } void CPluginManager::OnSourceModMaxPlayersChanged(int newvalue) { SyncMaxClients(newvalue); } void CPluginManager::SyncMaxClients(int max_clients) { List::iterator iter; for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++) { (*iter)->SyncMaxClients(max_clients); } } void CPluginManager::ListPluginsToClient(CPlayer *player, const CCommand &args) { char buffer[256]; unsigned int id = 0; int plnum = GetPluginCount(); edict_t *e = player->GetEdict(); unsigned int start = 0; if (!plnum) { ClientConsolePrint(e, "[SM] No plugins found."); return; } if (args.ArgC() > 2) { start = atoi(args.Arg(2)); } CPlugin *pl; SourceHook::List::iterator iter; SourceHook::List m_FailList; for (iter = m_plugins.begin(); iter != m_plugins.end(); iter++) { pl = (*iter); if (pl->GetStatus() != Plugin_Running) { continue; } /* Count valid plugins */ id++; if (id < start) { continue; } if (id - start > 10) { break; } size_t len; const sm_plugininfo_t *info = pl->GetPublicInfo(); len = UTIL_Format(buffer, sizeof(buffer), " \"%s\"", (IS_STR_FILLED(info->name)) ? info->name : pl->GetFilename()); if (IS_STR_FILLED(info->version)) { len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", info->version); } if (IS_STR_FILLED(info->author)) { UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", info->author); } else { UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", pl->m_filename); } ClientConsolePrint(e, "%s", buffer); } /* See if we can get more plugins */ while (iter != m_plugins.end()) { if ((*iter)->GetStatus() == Plugin_Running) { break; } } /* Do we actually have more plugins? */ if (iter != m_plugins.end()) { ClientConsolePrint(e, "To see more, type \"sm plugins %d\"", id + 1); } }