/** * vim: set ts=4 sw=4 tw=99 noet : * ====================================================== * Metamod:Source * Copyright (C) 2004-2010 AlliedModders LLC and authors. * All rights reserved. * ====================================================== * * This software is provided 'as-is', without any express or implied warranty. * In no event will the authors be held liable for any damages arising from * the use of this software. * * Permission is granted to anyone to use this software for any purpose, * including commercial applications, and to alter it and redistribute it * freely, subject to the following restrictions: * * 1. The origin of this software must not be misrepresented; you must not * claim that you wrote the original software. If you use this software in a * product, an acknowledgment in the product documentation would be * appreciated but is not required. * 2. Altered source versions must be plainly marked as such, and must not be * misrepresented as being the original software. * 3. This notice may not be removed or altered from any source distribution. */ #include #include "metamod_oslink.h" #include #include #include "metamod.h" #include "metamod_util.h" #include "metamod_console.h" #include "metamod_plugins.h" using namespace SourceMM; using namespace SourceHook; /** * @brief Console Command Implementations * @file concommands.cpp */ #define CONMSG g_Metamod.ConPrintf #define CLIENT_CONMSG g_Metamod.ClientConPrintf template void CMDMSG(MMSPlayer_t client, const char *pMsg, Ts ... ts) { if (client != MMSPlayer_INVALID) { CLIENT_CONMSG(client, pMsg, ts...); } else { CONMSG(pMsg, ts...); } } static void ReplyCredits(MMSPlayer_t client = MMSPlayer_INVALID) { CMDMSG(client, "Metamod:Source was developed by:\n"); CMDMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n"); CMDMSG(client, " GameDLL/Plugins: David \"BAILOPAN\" Anderson\n"); CMDMSG(client, " GameDLL: Scott \"DS\" Ehlert\n"); CMDMSG(client, "For more information, see the official website\n"); CMDMSG(client, "http://www.metamodsource.net/\n"); } static void ReplyVersion(MMSPlayer_t client = MMSPlayer_INVALID) { CMDMSG(client, " Metamod:Source Version Information\n"); CMDMSG(client, " Metamod:Source version %s\n", METAMOD_VERSION); CMDMSG(client, " Plugin interface version: %d:%d\n", METAMOD_PLAPI_VERSION, PLAPI_MIN_VERSION); CMDMSG(client, " SourceHook version: %d:%d\n", g_SHPtr->GetIfaceVersion(), g_SHPtr->GetImplVersion()); if (g_Metamod.IsLoadedAsGameDLL()) { CMDMSG(client, " Loaded As: GameDLL (gameinfo.txt)\n"); } else { CMDMSG(client, " Loaded As: Valve Server Plugin\n"); } CMDMSG(client, " Compiled on: %s\n", MMS_BUILD_TIMESTAMP); #if defined(MMS_GENERATED_BUILD) CMDMSG(client, " Built from: https://github.com/alliedmodders/metamod-source/commit/%s\n", METAMOD_SHA); CMDMSG(client, " Build ID: %s:%s\n", METAMOD_LOCAL_REV, METAMOD_SHA); #endif CMDMSG(client, " http://www.metamodsource.net/\n"); } bool Command_Meta(IMetamodSourceCommandInfo *info) { unsigned int args = info->GetArgCount(); if (mm_IsVspBridged() && !mm_IsVspLoadComplete()) { CONMSG("You must change the map to activate Metamod:Source.\n"); return true; } if (args >= 1) { const char *command = info->GetArg(1); if (strcmp(command, "credits") == 0) { ReplyCredits(); return true; } else if (strcmp(command, "version") == 0) { ReplyVersion(); return true; } else if (strcmp(command, "game") == 0) { CONMSG("GameDLL Information\n"); CONMSG(" Description: %s\n", provider->GetGameDescription()); CONMSG(" Mod Path: %s\n", g_Metamod.GetBaseDir()); CONMSG(" DLL Path: %s\n", g_Metamod.GetGameBinaryPath()); CONMSG(" Interface: %s\n", g_Metamod.GetGameDLLInterfaceName()); CONMSG(" Engine: %s\n", provider->GetEngineDescription()); // Display user messages const char *msgname; int msgsize; int messages = g_Metamod.GetUserMessageCount(); if (messages > 0) { CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size"); for (int i = 0; i < messages; i++) { msgname = g_Metamod.GetUserMessage(i, &msgsize); CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize); } CONMSG(" %d user message%s in total\n", messages, (messages > 1) ? "s" : ""); } else { CONMSG(" User Messages: None\n"); } return true; } else if (strcmp(command, "refresh") == 0) { char filepath[PATH_SIZE], vdfpath[PATH_SIZE]; g_Metamod.PathFormat(filepath, sizeof(filepath), "%s/%s", g_Metamod.GetBaseDir(), g_Metamod.GetPluginsFile()); g_Metamod.PathFormat(vdfpath, sizeof(vdfpath), "%s/%s", g_Metamod.GetBaseDir(), g_Metamod.GetVDFDir()); mm_LoadPlugins(filepath, vdfpath); return true; } else if (strcmp(command, "list") == 0) { CPluginManager::CPlugin *pl; ISmmPlugin *plapi; const char *plname; PluginIter i; char buffer[256]; size_t len; int plnum = g_PluginMngr.GetPluginCount(); if (!plnum) { CONMSG("No plugins loaded.\n"); return true; } else { CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : ""); } for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++) { pl = (*i); if (!pl) { break; } len = 0; if (pl->m_Status != Pl_Running) { len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl)); } else { len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id); } if ((plapi = pl->m_API)) { plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str(); len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname); if (IS_STR_FILLED(plapi->GetVersion())) { len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion()); } if (IS_STR_FILLED(plapi->GetAuthor())) { UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor()); } } CONMSG("%s\n", buffer); } return true; } else if (strcmp(command, "cmds") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id); if (!pl) { CONMSG("Plugin %d not found.\n", id); return true; } if (!pl->m_API) { CONMSG("Plugin %d is not loaded.\n", id); } else { CONMSG("Console commands for %s:\n", pl->m_API->GetName()); List::iterator ci; size_t count = 0; for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++) { count++; CONMSG(" [%5d] %-s\n", count, (*ci)->GetName()); } } } else { CONMSG("Usage: meta cmds \n"); } return true; } else if (strcmp(command, "cvars") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id); if (!pl) { CONMSG("Plugin %d not found.\n", id); return true; } if (!pl->m_API) { CONMSG("Plugin %d is not loaded.\n", id); } else { CONMSG("Registered cvars for %s:\n", pl->m_API->GetName()); List::iterator ci; size_t count = 0; for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++) { count++; CONMSG(" [%5d] %-s\n", count, (*ci)->GetName()); } } } else { CONMSG("Usage: meta cvars \n"); } return true; } else if (strcmp(command, "info") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id); if (!pl) { CONMSG("Plugin %d not found.\n", id); return true; } if (!pl->m_API) { CONMSG("Plugin %d is not loaded.\n", id); } else { if (pl->m_Status == Pl_Paused) { CONMSG("Plugin %d is paused.\n", id); } else if (pl->m_Status == Pl_Running) { char run_msg[255]; bool run = false; if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1)) { run = true; } if (run) { CONMSG("Plugin %d is running.\n", id); } else { CONMSG("Plugin %d is stopped: %s\n", id, run_msg); } } CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor()); CONMSG(" Version: %s\n", pl->m_API->GetVersion()); CONMSG(" Description: %s\n", pl->m_API->GetDescription()); CONMSG(" License: %s\n", pl->m_API->GetLicense()); CONMSG(" URL: %s\n", pl->m_API->GetURL()); CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate()); } CONMSG("File: %s\n\n", pl->m_File.c_str()); return true; } else { CONMSG("Usage: meta info \n"); return true; } } else if (strcmp(command, "pause") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); char error[255]; if (!g_PluginMngr.Pause(id, error, sizeof(error))) { CONMSG("Pause failed: %s\n", error); return true; } CONMSG("Plugin %d has been paused.\n", id); return true; } else { CONMSG("Usage: meta pause \n"); return true; } } else if (strcmp(command, "unpause") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); char error[255]; if (!g_PluginMngr.Unpause(id, error, sizeof(error))) { CONMSG("Unpause failed: %s\n", error); return true; } CONMSG("Plugin %d has been unpaused.\n", id); return true; } else { CONMSG("Usage: meta unpause \n"); return true; } } else if (strcmp(command, "load") == 0) { if (args >= 2) { const char *file = info->GetArg(2); char full_path[255]; const char *alias = g_PluginMngr.LookupAlias(file); if (alias) { file = alias; } g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path)); char error[255]={0}; bool already; CPluginManager::CPlugin *pl; // If we've recently tried to unload plugins, they might still // be in the unload queue. Force them out now. This is not // lowered to CPluginManager because it's not strictly safe // there. g_SourceHook.ResolvePendingUnloads(true); PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error)); pl = g_PluginMngr.FindById(id); if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused)) { CONMSG("Failed to load plugin %s (%s).\n", file, error); return true; } if (!already) { CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id); } else { CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id); } return true; } else { CONMSG("Usage: meta load \n"); return true; } } else if ( (strcmp(command, "alias") == 0) || (strcmp(command, "aliases") == 0) ) { if (args >= 3) { const char *alias = info->GetArg(2); const char *value = info->GetArg(3); g_PluginMngr.SetAlias(alias, value); if (value == NULL || value[0] == '\0') { CONMSG("Deleted alias: %s.\n", alias); } else { CONMSG("Set alias \"%s\" to: %s\n", alias, value); } } else if (args >= 2) { const char *alias = info->GetArg(2); const char *value = g_PluginMngr.LookupAlias(alias); if (value) { CONMSG("Alias \"%s\" is set to: %s\n", alias, value); } else { CONMSG("Alias \"%s\" was not found.\n", alias); } } else { List::iterator iter, end; CNameAlias *p; iter = g_PluginMngr._alias_begin(); end = g_PluginMngr._alias_end(); size_t total = 0; if (iter != end) { CONMSG("%-10.9s %s\n", "Alias", "File"); CONMSG(" --- \n"); for (; iter!=end; iter++) { p = (*iter); CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str()); total++; } CONMSG(" --- \n"); CONMSG("%d aliases total.\n", total); } else { CONMSG("No aliases found.\n"); } } return true; } else if (strcmp(command, "unload") == 0) { if (args >= 2) { const char *file = info->GetArg(2); int id = atoi(file); char error[255]={0}; if (id == 0 && isalpha(file[0])) { char full_path[255]; const char *alias = g_PluginMngr.LookupAlias(file); if (alias) { file = alias; } g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path)); List::iterator iter, end; CPluginManager::CPlugin *pl; iter = g_PluginMngr._begin(); end = g_PluginMngr._end(); for (; iter!=end; iter++) { pl = (*iter); if (strcmp(pl->m_File.c_str(), full_path) == 0) { id = pl->m_Id; break; } } if (id == 0) { CONMSG("Plugin \"%s\" not found.\n", full_path); return true; } } if (!g_PluginMngr.Unload(id, false, error, sizeof(error))) { CONMSG("Unload failed: %s\n", error); return true; } CONMSG("Plugin %d unloaded.\n", id); } else { CONMSG("Usage: meta unload \n"); } return true; } else if (strcmp(command, "force_unload") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); char error[255]={0}; if (!g_PluginMngr.Unload(id, false, error, sizeof(error))) { CONMSG("Force unload failed: %s\n", error); return true; } CONMSG("Plugin %d force unloaded.\n", id); return true; } else { CONMSG("Usage: meta force_unload \n"); return true; } } else if (strcmp(command, "clear") == 0) { if (!g_PluginMngr.UnloadAll()) { CONMSG("One or more plugins resisted removal (cleaned anyway).\n"); return true; } CONMSG("All plugins unloaded.\n"); return true; } else if (strcmp(command, "retry") == 0) { if (args >= 2) { int id = atoi(info->GetArg(2)); char error[255]; if (!g_PluginMngr.Retry(id, error, sizeof(error))) { CONMSG("Error reloading plugin: %s\n", error); return true; } CONMSG("Plugin %d successfully reloaded.\n", id); return true; } else { CONMSG("Usage: meta retry \n"); return true; } } } CONMSG("Metamod:Source Menu\n"); CONMSG("usage: meta [arguments]\n"); CONMSG(" alias - List or set an alias\n"); CONMSG(" clear - Unload all plugins forcefully\n"); CONMSG(" cmds - Show plugin commands\n"); CONMSG(" cvars - Show plugin cvars\n"); CONMSG(" credits - About Metamod:Source\n"); CONMSG(" force_unload - Forcefully unload a plugin\n"); CONMSG(" game - Information about GameDLL\n"); CONMSG(" info - Information about a plugin\n"); CONMSG(" list - List plugins\n"); CONMSG(" load - Load a plugin\n"); CONMSG(" pause - Pause a running plugin\n"); CONMSG(" refresh - Reparse plugin files\n"); CONMSG(" retry - Attempt to reload a plugin\n"); CONMSG(" unload - Unload a loaded plugin\n"); CONMSG(" unpause - Unpause a paused plugin\n"); CONMSG(" version - Version information\n"); return true; } bool Command_ClientMeta(MMSPlayer_t client, IMetamodSourceCommandInfo *info) { const char *cmd = info->GetArg(0); if (strcmp(cmd, "meta") == 0) { unsigned int args = info->GetArgCount(); if (args == 1) { const char *subcmd = info->GetArg(1); if (strcmp(subcmd, "credits") == 0) { ReplyCredits(client); return true; } else if(strcmp(subcmd, "version") == 0) { ReplyVersion(client); return true; } else if(strcmp(subcmd, "list") == 0) { CPluginManager::CPlugin *pl; ISmmPlugin *plapi; const char *plname; PluginIter i; char buffer[256]; size_t len = 0; int plnum = 0; for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0) { pl = (*i); if (pl && pl->m_Status == Pl_Running) { plapi = pl->m_API; if (!plapi || !plapi->QueryRunning(NULL, 0)) { continue; } plnum++; len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum); plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str(); len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname); if (IS_STR_FILLED(plapi->GetVersion())) { len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion()); } if (IS_STR_FILLED(plapi->GetAuthor())) { UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor()); } CLIENT_CONMSG(client, "%s\n", buffer); } } if (!plnum) { CLIENT_CONMSG(client, "No active plugins loaded.\n"); } return true; } } CLIENT_CONMSG(client, "Metamod:Source Menu\n"); CLIENT_CONMSG(client, "usage: meta \n"); CLIENT_CONMSG(client, " credits - About Metamod:Source\n"); CLIENT_CONMSG(client, " list - List plugins\n"); CLIENT_CONMSG(client, " version - Version information\n"); return true; } return false; }