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_LEFT4DEAD
121 CONMSG(" Engine: Left 4 Dead (2008)\n");
122 #elif SOURCE_ENGINE == SE_ORANGEBOX
123 CONMSG(" Engine: Episode 2 (Orange Box, 2007)\n");
124 #elif SOURCE_ENGINE == SE_ORANGEBOXVALVE
125 CONMSG(" Engine: Episode 2 (Valve Orange Box, 2009)\n");
126 #elif SOURCE_ENGINE == SE_DARKMESSIAH
127 CONMSG(" Engine: Dark Messiah (2006)\n");
128 #elif SOURCE_ENGINE == SE_EYE
129 CONMSG(" Engine: E.Y.E. Divine Cybermancy (2011)\n");
131 #error "SOURCE_ENGINE not defined to a known value"
134 // Display user messages
137 int messages = g_Metamod.GetUserMessageCount();
141 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
143 for (int i = 0; i < messages; i++)
145 msgname = g_Metamod.GetUserMessage(i, &msgsize);
147 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
150 CONMSG(" %d user message%s in total\n", messages, (messages > 1) ? "s" : "");
154 CONMSG(" User Messages: None\n");
159 else if (strcmp(command, "refresh") == 0)
161 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
162 g_Metamod.PathFormat(filepath,
165 g_Metamod.GetBaseDir(),
166 g_Metamod.GetPluginsFile());
167 g_Metamod.PathFormat(vdfpath,
170 g_Metamod.GetBaseDir(),
171 g_Metamod.GetVDFDir());
173 mm_LoadPlugins(filepath, vdfpath);
177 else if (strcmp(command, "list") == 0)
179 CPluginManager::CPlugin *pl;
185 int plnum = g_PluginMngr.GetPluginCount();
189 CONMSG("No plugins loaded.\n");
192 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
195 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++)
205 if (pl->m_Status != Pl_Running)
207 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
209 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
212 if ((plapi = pl->m_API))
214 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
215 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
217 if (IS_STR_FILLED(plapi->GetVersion()))
219 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
221 if (IS_STR_FILLED(plapi->GetAuthor()))
223 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
227 CONMSG("%s\n", buffer);
232 else if (strcmp(command, "cmds") == 0)
236 int id = atoi(info->GetArg(2));
237 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
241 CONMSG("Plugin %d not found.\n", id);
247 CONMSG("Plugin %d is not loaded.\n", id);
251 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
252 List<ConCommandBase *>::iterator ci;
255 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
258 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
264 CONMSG("Usage: meta cmds <id>\n");
269 else if (strcmp(command, "cvars") == 0)
273 int id = atoi(info->GetArg(2));
274 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
278 CONMSG("Plugin %d not found.\n", id);
284 CONMSG("Plugin %d is not loaded.\n", id);
288 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
289 List<ConCommandBase *>::iterator ci;
292 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
295 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
301 CONMSG("Usage: meta cvars <id>\n");
306 else if (strcmp(command, "info") == 0)
310 int id = atoi(info->GetArg(2));
311 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
314 CONMSG("Plugin %d not found.\n", id);
320 CONMSG("Plugin %d is not loaded.\n", id);
324 if (pl->m_Status == Pl_Paused)
326 CONMSG("Plugin %d is paused.\n", id);
328 else if (pl->m_Status == Pl_Running)
332 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
338 CONMSG("Plugin %d is running.\n", id);
342 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
345 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
346 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
347 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
348 CONMSG(" License: %s\n", pl->m_API->GetLicense());
349 CONMSG(" URL: %s\n", pl->m_API->GetURL());
350 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
352 CONMSG("File: %s\n\n", pl->m_File.c_str());
358 CONMSG("Usage: meta info <id>\n");
363 else if (strcmp(command, "pause") == 0)
367 int id = atoi(info->GetArg(2));
371 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
373 CONMSG("Pause failed: %s\n", error);
377 CONMSG("Plugin %d has been paused.\n", id);
383 CONMSG("Usage: meta pause <id>\n");
388 else if (strcmp(command, "unpause") == 0)
392 int id = atoi(info->GetArg(2));
395 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
397 CONMSG("Unpause failed: %s\n", error);
401 CONMSG("Plugin %d has been unpaused.\n", id);
407 CONMSG("Usage: meta unpause <id>\n");
412 else if (strcmp(command, "load") == 0)
416 const char *file = info->GetArg(2);
419 const char *alias = g_PluginMngr.LookupAlias(file);
425 g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path));
429 CPluginManager::CPlugin *pl;
431 // If we've recently tried to unload plugins, they might still
432 // be in the unload queue. Force them out now. This is not
433 // lowered to CPluginManager because it's not strictly safe
435 g_SourceHook.ResolvePendingUnloads(true);
437 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
438 pl = g_PluginMngr.FindById(id);
439 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
441 CONMSG("Failed to load plugin %s (%s).\n", file, error);
447 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
449 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
456 CONMSG("Usage: meta load <path>\n");
461 else if ( (strcmp(command, "alias") == 0) ||
462 (strcmp(command, "aliases") == 0) )
466 const char *alias = info->GetArg(2);
467 const char *value = info->GetArg(3);
469 g_PluginMngr.SetAlias(alias, value);
470 if (value == NULL || value[0] == '\0')
472 CONMSG("Deleted alias: %s.\n", alias);
474 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
479 const char *alias = info->GetArg(2);
480 const char *value = g_PluginMngr.LookupAlias(alias);
483 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
485 CONMSG("Alias \"%s\" was not found.\n", alias);
490 List<CNameAlias *>::iterator iter, end;
493 iter = g_PluginMngr._alias_begin();
494 end = g_PluginMngr._alias_end();
498 CONMSG("%-10.9s %s\n", "Alias", "File");
500 for (; iter!=end; iter++)
503 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
507 CONMSG("%d aliases total.\n", total);
511 CONMSG("No aliases found.\n");
516 else if (strcmp(command, "unload") == 0)
520 const char *file = info->GetArg(2);
524 if (id == 0 && isalpha(file[0]))
527 const char *alias = g_PluginMngr.LookupAlias(file);
534 g_Metamod.GetFullPluginPath(file, full_path, sizeof(full_path));
536 List<CPluginManager::CPlugin *>::iterator iter, end;
537 CPluginManager::CPlugin *pl;
538 iter = g_PluginMngr._begin();
539 end = g_PluginMngr._end();
540 for (; iter!=end; iter++)
543 if (strcmp(pl->m_File.c_str(), full_path) == 0)
551 CONMSG("Plugin \"%s\" not found.\n", full_path);
556 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
558 CONMSG("Unload failed: %s\n", error);
562 CONMSG("Plugin %d unloaded.\n", id);
566 CONMSG("Usage: meta unload <id>\n");
570 else if (strcmp(command, "force_unload") == 0)
574 int id = atoi(info->GetArg(2));
577 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
579 CONMSG("Force unload failed: %s\n", error);
583 CONMSG("Plugin %d force unloaded.\n", id);
589 CONMSG("Usage: meta force_unload <id>\n");
594 else if (strcmp(command, "clear") == 0)
596 if (!g_PluginMngr.UnloadAll())
598 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
602 CONMSG("All plugins unloaded.\n");
606 else if (strcmp(command, "retry") == 0)
610 int id = atoi(info->GetArg(2));
613 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
615 CONMSG("Error reloading plugin: %s\n", error);
619 CONMSG("Plugin %d successfully reloaded.\n", id);
625 CONMSG("Usage: meta retry <id>\n");
632 CONMSG("Metamod:Source Menu\n");
633 CONMSG("usage: meta <command> [arguments]\n");
634 CONMSG(" alias - List or set an alias\n");
635 CONMSG(" clear - Unload all plugins forcefully\n");
636 CONMSG(" cmds - Show plugin commands\n");
637 CONMSG(" cvars - Show plugin cvars\n");
638 CONMSG(" credits - About Metamod:Source\n");
639 CONMSG(" force_unload - Forcefully unload a plugin\n");
640 CONMSG(" game - Information about GameDLL\n");
641 CONMSG(" info - Information about a plugin\n");
642 CONMSG(" list - List plugins\n");
643 CONMSG(" load - Load a plugin\n");
644 CONMSG(" pause - Pause a running plugin\n");
645 CONMSG(" refresh - Reparse plugin files\n");
646 CONMSG(" retry - Attempt to reload a plugin\n");
647 CONMSG(" unload - Unload a loaded plugin\n");
648 CONMSG(" unpause - Unpause a paused plugin\n");
649 CONMSG(" version - Version information\n");
654 bool Command_ClientMeta(edict_t *client, IMetamodSourceCommandInfo *info)
656 const char *cmd = info->GetArg(0);
658 if (strcmp(cmd, "meta") == 0)
660 unsigned int args = info->GetArgCount();
663 const char *subcmd = info->GetArg(1);
665 if (strcmp(subcmd, "credits") == 0)
667 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
668 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
669 CLIENT_CONMSG(client, " GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
670 CLIENT_CONMSG(client, " GameDLL: Scott \"DS\" Ehlert\n");
671 CLIENT_CONMSG(client, "For more information, see the official website\n");
672 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
676 else if(strcmp(subcmd, "version") == 0)
678 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
679 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
680 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", METAMOD_PLAPI_VERSION, PLAPI_MIN_VERSION);
681 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SHPtr->GetIfaceVersion(), g_SHPtr->GetImplVersion());
682 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
686 else if(strcmp(subcmd, "list") == 0)
688 CPluginManager::CPlugin *pl;
696 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
699 if (pl && pl->m_Status == Pl_Running)
702 if (!plapi || !plapi->QueryRunning(NULL, 0))
708 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
710 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
711 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
713 if (IS_STR_FILLED(plapi->GetVersion()))
715 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
717 if (IS_STR_FILLED(plapi->GetAuthor()))
719 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
722 CLIENT_CONMSG(client, "%s\n", buffer);
728 CLIENT_CONMSG(client, "No active plugins loaded.\n");
735 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
736 CLIENT_CONMSG(client, "usage: meta <command>\n");
737 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
738 CLIENT_CONMSG(client, " list - List plugins\n");
739 CLIENT_CONMSG(client, " version - Version information\n");