2 * vim: set ts=4 sw=4 tw=99 noet :
3 * ======================================================
5 * Copyright (C) 2004-2009 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_LEFT4DEAD2
115 CONMSG(" Engine: Left 4 Dead 2 (2009)\n");
116 #elif SOURCE_ENGINE == SE_LEFT4DEAD
117 CONMSG(" Engine: Left 4 Dead (2008)\n");
118 #elif SOURCE_ENGINE == SE_ORANGEBOX
119 CONMSG(" Engine: Episode 2 (Orange Box, 2007)\n");
120 #elif SOURCE_ENGINE == SE_DARKMESSIAH
121 CONMSG(" Engine: Dark Messiah (2006)\n");
123 #error "SOURCE_ENGINE not defined to a known value"
126 // Display user messages
127 int messages = g_Metamod.GetUserMessageCount();
135 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
137 for (int i = 0; i < messages; i++)
139 msgname = g_Metamod.GetUserMessage(i, &msgsize);
141 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
144 CONMSG(" %d user message%s in total\n", messages, (messages > 1) ? "s" : "");
148 CONMSG(" User Messages: None\n");
153 CONMSG(" User Messages: Failed to get list of user messages\n");
158 else if (strcmp(command, "refresh") == 0)
160 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
161 g_Metamod.PathFormat(filepath,
164 g_Metamod.GetBaseDir(),
165 g_Metamod.GetPluginsFile());
166 g_Metamod.PathFormat(vdfpath,
169 g_Metamod.GetBaseDir(),
170 g_Metamod.GetVDFDir());
172 mm_LoadPlugins(filepath, vdfpath);
176 else if (strcmp(command, "list") == 0)
178 CPluginManager::CPlugin *pl;
184 int plnum = g_PluginMngr.GetPluginCount();
188 CONMSG("No plugins loaded.\n");
191 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
194 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++)
204 if (pl->m_Status != Pl_Running)
206 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
208 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
211 if ((plapi = pl->m_API))
213 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
214 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
216 if (IS_STR_FILLED(plapi->GetVersion()))
218 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
220 if (IS_STR_FILLED(plapi->GetAuthor()))
222 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
226 CONMSG("%s\n", buffer);
231 else if (strcmp(command, "cmds") == 0)
235 int id = atoi(info->GetArg(2));
236 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
240 CONMSG("Plugin %d not found.\n", id);
246 CONMSG("Plugin %d is not loaded.\n", id);
250 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
251 List<ConCommandBase *>::iterator ci;
254 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
257 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
263 CONMSG("Usage: meta cmds <id>\n");
268 else if (strcmp(command, "cvars") == 0)
272 int id = atoi(info->GetArg(2));
273 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
277 CONMSG("Plugin %d not found.\n", id);
283 CONMSG("Plugin %d is not loaded.\n", id);
287 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
288 List<ConCommandBase *>::iterator ci;
291 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
294 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
300 CONMSG("Usage: meta cvars <id>\n");
305 else if (strcmp(command, "info") == 0)
309 int id = atoi(info->GetArg(2));
310 CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
313 CONMSG("Plugin %d not found.\n", id);
319 CONMSG("Plugin %d is not loaded.\n", id);
323 if (pl->m_Status == Pl_Paused)
325 CONMSG("Plugin %d is paused.\n", id);
327 else if (pl->m_Status == Pl_Running)
331 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
337 CONMSG("Plugin %d is running.\n", id);
341 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
344 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
345 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
346 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
347 CONMSG(" License: %s\n", pl->m_API->GetLicense());
348 CONMSG(" URL: %s\n", pl->m_API->GetURL());
349 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
351 CONMSG("File: %s\n\n", pl->m_File.c_str());
357 CONMSG("Usage: meta info <id>\n");
362 else if (strcmp(command, "pause") == 0)
366 int id = atoi(info->GetArg(2));
370 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
372 CONMSG("Pause failed: %s\n", error);
376 CONMSG("Plugin %d has been paused.\n", id);
382 CONMSG("Usage: meta pause <id>\n");
387 else if (strcmp(command, "unpause") == 0)
391 int id = atoi(info->GetArg(2));
394 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
396 CONMSG("Unpause failed: %s\n", error);
400 CONMSG("Plugin %d has been unpaused.\n", id);
406 CONMSG("Usage: meta unpause <id>\n");
411 else if (strcmp(command, "load") == 0)
415 const char *file = info->GetArg(2);
418 const char *alias = g_PluginMngr.LookupAlias(file);
424 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
426 g_Metamod.PathFormat(full_path, sizeof(full_path), "%s", file);
430 const char *ext = UTIL_GetExtension(file);
431 #if defined WIN32 || defined _WIN32
432 ext = ext ? "" : ".dll";
434 ext = ext ? "" : "_i486.so";
436 g_Metamod.PathFormat(full_path,
439 g_Metamod.GetBaseDir(),
446 CPluginManager::CPlugin *pl;
448 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
449 pl = g_PluginMngr.FindById(id);
450 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
452 CONMSG("Failed to load plugin %s (%s).\n", file, error);
458 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
460 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
467 CONMSG("Usage: meta load <path>\n");
472 else if ( (strcmp(command, "alias") == 0) ||
473 (strcmp(command, "aliases") == 0) )
477 const char *alias = info->GetArg(2);
478 const char *value = info->GetArg(3);
480 g_PluginMngr.SetAlias(alias, value);
481 if (value == NULL || value[0] == '\0')
483 CONMSG("Deleted alias: %s.\n", alias);
485 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
490 const char *alias = info->GetArg(2);
491 const char *value = g_PluginMngr.LookupAlias(alias);
494 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
496 CONMSG("Alias \"%s\" was not found.\n", alias);
501 List<CNameAlias *>::iterator iter, end;
504 iter = g_PluginMngr._alias_begin();
505 end = g_PluginMngr._alias_end();
509 CONMSG("%-10.9s %s\n", "Alias", "File");
511 for (; iter!=end; iter++)
514 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
518 CONMSG("%d aliases total.\n", total);
522 CONMSG("No aliases found.\n");
527 else if (strcmp(command, "unload") == 0)
531 const char *file = info->GetArg(2);
535 if (id == 0 && isalpha(file[0]))
538 const char *alias = g_PluginMngr.LookupAlias(file);
545 /* first check if it's a known filename */
546 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
548 g_Metamod.PathFormat(full_path, sizeof(full_path), "%s", file);
552 const char *ext = UTIL_GetExtension(file);
553 #if defined WIN32 || defined _WIN32
554 ext = ext ? "" : ".dll";
556 ext = ext ? "" : "_i486.so";
558 g_Metamod.PathFormat(full_path,
561 g_Metamod.GetBaseDir(),
566 List<CPluginManager::CPlugin *>::iterator iter, end;
567 CPluginManager::CPlugin *pl;
568 iter = g_PluginMngr._begin();
569 end = g_PluginMngr._end();
570 for (; iter!=end; iter++)
573 if (strcmp(pl->m_File.c_str(), full_path) == 0)
581 CONMSG("Plugin \"%s\" not found.\n", full_path);
586 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
588 CONMSG("Unload failed: %s\n", error);
592 CONMSG("Plugin %d unloaded.\n", id);
596 CONMSG("Usage: meta unload <id>\n");
600 else if (strcmp(command, "force_unload") == 0)
604 int id = atoi(info->GetArg(2));
607 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
609 CONMSG("Force unload failed: %s\n", error);
613 CONMSG("Plugin %d force unloaded.\n", id);
619 CONMSG("Usage: meta force_unload <id>\n");
624 else if (strcmp(command, "clear") == 0)
626 if (!g_PluginMngr.UnloadAll())
628 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
632 CONMSG("All plugins unloaded.\n");
636 else if (strcmp(command, "retry") == 0)
640 int id = atoi(info->GetArg(2));
643 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
645 CONMSG("Error reloading plugin: %s\n", error);
649 CONMSG("Plugin %d successfully reloaded.\n", id);
655 CONMSG("Usage: meta retry <id>\n");
662 CONMSG("Metamod:Source Menu\n");
663 CONMSG("usage: meta <command> [arguments]\n");
664 CONMSG(" alias - List or set an alias\n");
665 CONMSG(" clear - Unload all plugins forcefully\n");
666 CONMSG(" cmds - Show plugin commands\n");
667 CONMSG(" cvars - Show plugin cvars\n");
668 CONMSG(" credits - About Metamod:Source\n");
669 CONMSG(" force_unload - Forcefully unload a plugin\n");
670 CONMSG(" game - Information about GameDLL\n");
671 CONMSG(" info - Information about a plugin\n");
672 CONMSG(" list - List plugins\n");
673 CONMSG(" load - Load a plugin\n");
674 CONMSG(" pause - Pause a running plugin\n");
675 CONMSG(" refresh - Reparse plugin files\n");
676 CONMSG(" retry - Attempt to reload a plugin\n");
677 CONMSG(" unload - Unload a loaded plugin\n");
678 CONMSG(" unpause - Unpause a paused plugin\n");
679 CONMSG(" version - Version information\n");
684 bool Command_ClientMeta(edict_t *client, IMetamodSourceCommandInfo *info)
686 const char *cmd = info->GetArg(0);
688 if (strcmp(cmd, "meta") == 0)
690 unsigned int args = info->GetArgCount();
693 const char *subcmd = info->GetArg(1);
695 if (strcmp(subcmd, "credits") == 0)
697 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
698 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
699 CLIENT_CONMSG(client, " GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
700 CLIENT_CONMSG(client, " GameDLL: Scott \"DS\" Ehlert\n");
701 CLIENT_CONMSG(client, "For more information, see the official website\n");
702 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
706 else if(strcmp(subcmd, "version") == 0)
708 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
709 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
710 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", METAMOD_PLAPI_VERSION, PLAPI_MIN_VERSION);
711 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SHPtr->GetIfaceVersion(), g_SHPtr->GetImplVersion());
712 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
716 else if(strcmp(subcmd, "list") == 0)
718 CPluginManager::CPlugin *pl;
726 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
729 if (pl && pl->m_Status == Pl_Running)
732 if (!plapi || !plapi->QueryRunning(NULL, 0))
738 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
740 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
741 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
743 if (IS_STR_FILLED(plapi->GetVersion()))
745 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
747 if (IS_STR_FILLED(plapi->GetAuthor()))
749 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
752 CLIENT_CONMSG(client, "%s\n", buffer);
758 CLIENT_CONMSG(client, "No active plugins loaded.\n");
765 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
766 CLIENT_CONMSG(client, "usage: meta <command>\n");
767 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
768 CLIENT_CONMSG(client, " list - List plugins\n");
769 CLIENT_CONMSG(client, " version - Version information\n");