2 * vim: set ts=4 sw=4 tw=99 noet :
3 * ======================================================
5 * Copyright (C) 2004-2010 AlliedModders LLC and authors.
7 * ======================================================
9 * This software is provided 'as-is', without any express or implied warranty.
10 * In no event will the authors be held liable for any damages arising from
11 * the use of this software.
13 * Permission is granted to anyone to use this software for any purpose,
14 * including commercial applications, and to alter it and redistribute it
15 * freely, subject to the following restrictions:
17 * 1. The origin of this software must not be misrepresented; you must not
18 * claim that you wrote the original software. If you use this software in a
19 * product, an acknowledgment in the product documentation would be
20 * appreciated but is not required.
21 * 2. Altered source versions must be plainly marked as such, and must not be
22 * misrepresented as being the original software.
23 * 3. This notice may not be removed or altered from any source distribution.
27 #include "metamod_oslink.h"
30 #include "metamod_util.h"
31 #include "metamod_console.h"
32 #include "metamod_plugins.h"
34 using namespace SourceMM;
35 using namespace SourceHook;
38 * @brief Console Command Implementations
39 * @file concommands.cpp
42 #define CONMSG g_Metamod.ConPrintf
43 #define CLIENT_CONMSG g_Metamod.ClientConPrintf
45 bool Command_Meta(IMetamodSourceCommandInfo *info)
47 unsigned int args = info->GetArgCount();
49 if (mm_IsVspBridged() && !mm_IsVspLoadComplete())
51 CONMSG("You must change the map to activate Metamod:Source.\n");
57 const char *command = info->GetArg(1);
58 if (strcmp(command, "credits") == 0)
60 CONMSG("Metamod:Source was developed by:\n");
61 CONMSG(" SourceHook: Pavol \"PM OnoTo\" Marko\n");
62 CONMSG(" GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
63 CONMSG(" GameDLL: Scott \"DS\" Ehlert\n");
64 CONMSG("For more information, see the official website\n");
65 CONMSG("http://www.metamodsource.net/\n");
69 else if (strcmp(command, "version") == 0)
71 CONMSG("Metamod:Source version %s\n", MMS_FULL_VERSION);
72 CONMSG("Build ID: %s\n", MMS_BUILD_UNIQUEID);
74 if (g_Metamod.IsLoadedAsGameDLL())
76 CONMSG("Loaded As: GameDLL (gameinfo.txt)\n");
80 CONMSG("Loaded As: Valve Server Plugin\n");
83 CONMSG("Compiled on: %s\n", SOURCEMM_DATE);
84 CONMSG("Plugin interface version: %d:%d\n", METAMOD_PLAPI_VERSION, PLAPI_MIN_VERSION);
85 CONMSG("SourceHook version: %d:%d\n", g_SHPtr->GetIfaceVersion(), g_SHPtr->GetImplVersion());
86 CONMSG("http://www.metamodsource.net/\n");
90 else if (strcmp(command, "game") == 0)
92 CONMSG("GameDLL Information\n");
93 CONMSG(" Description: %s\n", provider->GetGameDescription());
94 CONMSG(" Mod Path: %s\n", g_Metamod.GetBaseDir());
95 CONMSG(" DLL Path: %s\n", g_Metamod.GetGameBinaryPath());
96 CONMSG(" Interface: ServerGameDLL%03d\n", g_Metamod.GetGameDLLVersion());
99 int engine = g_Metamod.GetSourceEngineBuild();
100 if (engine == SOURCE_ENGINE_ORIGINAL)
102 CONMSG(" Engine: Original (pre-Episode 1)\n");
104 else if (engine == SOURCE_ENGINE_EPISODEONE)
106 CONMSG(" Engine: Episode 1 (2004)\n");
108 else if (engine == SOURCE_ENGINE_ORANGEBOX)
110 CONMSG(" Engine: Episode 2 (Orange Box, 2007)\n");
114 #if SOURCE_ENGINE == SE_BLOODYGOODTIME
115 CONMSG(" Engine: Bloody Good Time (2010)\n");
116 #elif SOURCE_ENGINE == SE_ALIENSWARM
117 CONMSG(" Engine: Alien Swarm (2010)\n");
118 #elif SOURCE_ENGINE == SE_LEFT4DEAD2
119 CONMSG(" Engine: Left 4 Dead 2 (2009)\n");
120 #elif SOURCE_ENGINE == SE_NUCLEARDAWN
121 CONMSG(" Engine: Nuclear Dawn (2011)\n");
122 #elif SOURCE_ENGINE == SE_LEFT4DEAD
123 CONMSG(" Engine: Left 4 Dead (2008)\n");
124 #elif SOURCE_ENGINE == SE_ORANGEBOX
125 CONMSG(" Engine: Episode 2 (Orange Box, 2007)\n");
126 #elif SOURCE_ENGINE == SE_CSS
127 CONMSG(" Engine: Counter-Strike: Source (Valve Orange Box)\n");
128 #elif SOURCE_ENGINE == SE_HL2DM
129 CONMSG(" Engine: Half-Life 2 Deathmatch (Valve Orange Box)\n");
130 #elif SOURCE_ENGINE == SE_DODS
131 CONMSG(" Engine: Day of Defeat: Source (Valve Orange Box)\n");
132 #elif SOURCE_ENGINE == SE_SDK2013
133 CONMSG(" Engine: Source SDK 2013 (2013)\n");
134 #elif SOURCE_ENGINE == SE_TF2
135 CONMSG(" Engine: Team Fortress 2 (Valve Orange Box)\n");
136 #elif SOURCE_ENGINE == SE_DARKMESSIAH
137 CONMSG(" Engine: Dark Messiah (2006)\n");
138 #elif SOURCE_ENGINE == SE_EYE
139 CONMSG(" Engine: E.Y.E. Divine Cybermancy (2011)\n");
140 #elif SOURCE_ENGINE == SE_PORTAL2
141 CONMSG(" Engine: Portal 2 (2011)\n");
142 #elif SOURCE_ENGINE == SE_CSGO
143 CONMSG(" Engine: Counter-Strike: Global Offensive (2012)\n");
144 #elif SOURCE_ENGINE == SE_DOTA
145 CONMSG(" Engine: Dota 2 (2013)\n");
147 #error "SOURCE_ENGINE not defined to a known value"
150 // Display user messages
153 int messages = g_Metamod.GetUserMessageCount();
157 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
159 for (int i = 0; i < messages; i++)
161 msgname = g_Metamod.GetUserMessage(i, &msgsize);
163 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
166 CONMSG(" %d user message%s in total\n", messages, (messages > 1) ? "s" : "");
170 CONMSG(" User Messages: None\n");
175 else if (strcmp(command, "refresh") == 0)
177 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
178 g_Metamod.PathFormat(filepath,
181 g_Metamod.GetBaseDir(),
182 g_Metamod.GetPluginsFile());
183 g_Metamod.PathFormat(vdfpath,
186 g_Metamod.GetBaseDir(),
187 g_Metamod.GetVDFDir());
189 mm_LoadPlugins(filepath, vdfpath);
193 else if (strcmp(command, "list") == 0)
195 CPluginManager::CPlugin *pl;
201 int plnum = g_PluginMngr.GetPluginCount();
205 CONMSG("No plugins loaded.\n");
208 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
211 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++)
221 if (pl->m_Status != Pl_Running)
223 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
225 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
228 if ((plapi = pl->m_API))
230 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
231 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
233 if (IS_STR_FILLED(plapi->GetVersion()))
235 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
237 if (IS_STR_FILLED(plapi->GetAuthor()))
239 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
243 CONMSG("%s\n", buffer);
248 else if (strcmp(command, "cmds") == 0)
252 int id = atoi(info->GetArg(2));
253 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
257 CONMSG("Plugin %d not found.\n", id);
263 CONMSG("Plugin %d is not loaded.\n", id);
267 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
268 List<ConCommandBase *>::iterator ci;
271 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
274 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
280 CONMSG("Usage: meta cmds <id>\n");
285 else if (strcmp(command, "cvars") == 0)
289 int id = atoi(info->GetArg(2));
290 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
294 CONMSG("Plugin %d not found.\n", id);
300 CONMSG("Plugin %d is not loaded.\n", id);
304 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
305 List<ConCommandBase *>::iterator ci;
308 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
311 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
317 CONMSG("Usage: meta cvars <id>\n");
322 else if (strcmp(command, "info") == 0)
326 int id = atoi(info->GetArg(2));
327 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
330 CONMSG("Plugin %d not found.\n", id);
336 CONMSG("Plugin %d is not loaded.\n", id);
340 if (pl->m_Status == Pl_Paused)
342 CONMSG("Plugin %d is paused.\n", id);
344 else if (pl->m_Status == Pl_Running)
348 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
354 CONMSG("Plugin %d is running.\n", id);
358 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
361 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
362 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
363 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
364 CONMSG(" License: %s\n", pl->m_API->GetLicense());
365 CONMSG(" URL: %s\n", pl->m_API->GetURL());
366 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
368 CONMSG("File: %s\n\n", pl->m_File.c_str());
374 CONMSG("Usage: meta info <id>\n");
379 else if (strcmp(command, "pause") == 0)
383 int id = atoi(info->GetArg(2));
387 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
389 CONMSG("Pause failed: %s\n", error);
393 CONMSG("Plugin %d has been paused.\n", id);
399 CONMSG("Usage: meta pause <id>\n");
404 else if (strcmp(command, "unpause") == 0)
408 int id = atoi(info->GetArg(2));
411 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
413 CONMSG("Unpause failed: %s\n", error);
417 CONMSG("Plugin %d has been unpaused.\n", id);
423 CONMSG("Usage: meta unpause <id>\n");
428 else if (strcmp(command, "load") == 0)
432 const char *file = info->GetArg(2);
435 const char *alias = g_PluginMngr.LookupAlias(file);
441 g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path));
445 CPluginManager::CPlugin *pl;
447 // If we've recently tried to unload plugins, they might still
448 // be in the unload queue. Force them out now. This is not
449 // lowered to CPluginManager because it's not strictly safe
451 g_SourceHook.ResolvePendingUnloads(true);
453 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
454 pl = g_PluginMngr.FindById(id);
455 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
457 CONMSG("Failed to load plugin %s (%s).\n", file, error);
463 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
465 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
472 CONMSG("Usage: meta load <path>\n");
477 else if ( (strcmp(command, "alias") == 0) ||
478 (strcmp(command, "aliases") == 0) )
482 const char *alias = info->GetArg(2);
483 const char *value = info->GetArg(3);
485 g_PluginMngr.SetAlias(alias, value);
486 if (value == NULL || value[0] == '\0')
488 CONMSG("Deleted alias: %s.\n", alias);
490 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
495 const char *alias = info->GetArg(2);
496 const char *value = g_PluginMngr.LookupAlias(alias);
499 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
501 CONMSG("Alias \"%s\" was not found.\n", alias);
506 List<CNameAlias *>::iterator iter, end;
509 iter = g_PluginMngr._alias_begin();
510 end = g_PluginMngr._alias_end();
514 CONMSG("%-10.9s %s\n", "Alias", "File");
516 for (; iter!=end; iter++)
519 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
523 CONMSG("%d aliases total.\n", total);
527 CONMSG("No aliases found.\n");
532 else if (strcmp(command, "unload") == 0)
536 const char *file = info->GetArg(2);
540 if (id == 0 && isalpha(file[0]))
543 const char *alias = g_PluginMngr.LookupAlias(file);
550 g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path));
552 List<CPluginManager::CPlugin *>::iterator iter, end;
553 CPluginManager::CPlugin *pl;
554 iter = g_PluginMngr._begin();
555 end = g_PluginMngr._end();
556 for (; iter!=end; iter++)
559 if (strcmp(pl->m_File.c_str(), full_path) == 0)
567 CONMSG("Plugin \"%s\" not found.\n", full_path);
572 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
574 CONMSG("Unload failed: %s\n", error);
578 CONMSG("Plugin %d unloaded.\n", id);
582 CONMSG("Usage: meta unload <id>\n");
586 else if (strcmp(command, "force_unload") == 0)
590 int id = atoi(info->GetArg(2));
593 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
595 CONMSG("Force unload failed: %s\n", error);
599 CONMSG("Plugin %d force unloaded.\n", id);
605 CONMSG("Usage: meta force_unload <id>\n");
610 else if (strcmp(command, "clear") == 0)
612 if (!g_PluginMngr.UnloadAll())
614 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
618 CONMSG("All plugins unloaded.\n");
622 else if (strcmp(command, "retry") == 0)
626 int id = atoi(info->GetArg(2));
629 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
631 CONMSG("Error reloading plugin: %s\n", error);
635 CONMSG("Plugin %d successfully reloaded.\n", id);
641 CONMSG("Usage: meta retry <id>\n");
648 CONMSG("Metamod:Source Menu\n");
649 CONMSG("usage: meta <command> [arguments]\n");
650 CONMSG(" alias - List or set an alias\n");
651 CONMSG(" clear - Unload all plugins forcefully\n");
652 CONMSG(" cmds - Show plugin commands\n");
653 CONMSG(" cvars - Show plugin cvars\n");
654 CONMSG(" credits - About Metamod:Source\n");
655 CONMSG(" force_unload - Forcefully unload a plugin\n");
656 CONMSG(" game - Information about GameDLL\n");
657 CONMSG(" info - Information about a plugin\n");
658 CONMSG(" list - List plugins\n");
659 CONMSG(" load - Load a plugin\n");
660 CONMSG(" pause - Pause a running plugin\n");
661 CONMSG(" refresh - Reparse plugin files\n");
662 CONMSG(" retry - Attempt to reload a plugin\n");
663 CONMSG(" unload - Unload a loaded plugin\n");
664 CONMSG(" unpause - Unpause a paused plugin\n");
665 CONMSG(" version - Version information\n");
670 #if SOURCE_ENGINE == SE_DOTA
671 bool Command_ClientMeta(int client, IMetamodSourceCommandInfo *info)
673 bool Command_ClientMeta(edict_t *client, IMetamodSourceCommandInfo *info)
676 const char *cmd = info->GetArg(0);
678 if (strcmp(cmd, "meta") == 0)
680 unsigned int args = info->GetArgCount();
683 const char *subcmd = info->GetArg(1);
685 if (strcmp(subcmd, "credits") == 0)
687 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
688 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
689 CLIENT_CONMSG(client, " GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
690 CLIENT_CONMSG(client, " GameDLL: Scott \"DS\" Ehlert\n");
691 CLIENT_CONMSG(client, "For more information, see the official website\n");
692 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
696 else if(strcmp(subcmd, "version") == 0)
698 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
699 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
700 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", METAMOD_PLAPI_VERSION, PLAPI_MIN_VERSION);
701 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SHPtr->GetIfaceVersion(), g_SHPtr->GetImplVersion());
702 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
706 else if(strcmp(subcmd, "list") == 0)
708 CPluginManager::CPlugin *pl;
716 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
719 if (pl && pl->m_Status == Pl_Running)
722 if (!plapi || !plapi->QueryRunning(NULL, 0))
728 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
730 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
731 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
733 if (IS_STR_FILLED(plapi->GetVersion()))
735 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
737 if (IS_STR_FILLED(plapi->GetAuthor()))
739 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
742 CLIENT_CONMSG(client, "%s\n", buffer);
748 CLIENT_CONMSG(client, "No active plugins loaded.\n");
755 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
756 CLIENT_CONMSG(client, "usage: meta <command>\n");
757 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
758 CLIENT_CONMSG(client, " list - List plugins\n");
759 CLIENT_CONMSG(client, " version - Version information\n");