1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2009 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
12 #include "convar_smm.h"
14 #include "concommands.h"
16 #include "sh_string.h"
21 * @brief Console Command Implementations
22 * @file concommands.cpp
25 SMConVarAccessor g_SMConVarAccessor;
27 SMConVarAccessor::SMConVarAccessor()
29 m_TopConCommandBase = NULL;
32 bool SMConVarAccessor::RegisterConCommandBase(ConCommandBase *pCommand)
34 /* Add the FCVAR_GAMEDLL flag
35 * => No crash on exit!
36 * UPDATE: Do _not_ add the FCVAR_GAMEDLL flag here, as it
37 * causes the command to be unusable on listen servers until you load a map
38 * We will set the FCVAR_GAMEDLL flag on all commands we have registered once we are being unloaded
40 // pCommand->AddFlags(FCVAR_GAMEDLL);
41 m_RegisteredCommands.push_back(pCommand);
43 pCommand->SetNext(NULL);
44 g_Engine.icvar->RegisterConCommandBase(pCommand);
49 bool SMConVarAccessor::Register(ConCommandBase *pCommand)
51 /* Simple, don't mark as part of sourcemm! */
52 pCommand->SetNext(NULL);
53 g_Engine.icvar->RegisterConCommandBase(pCommand);
58 void SMConVarAccessor::MarkCommandsAsGameDLL()
60 for (SourceHook::List<ConCommandBase*>::iterator iter = m_RegisteredCommands.begin();
61 iter != m_RegisteredCommands.end(); ++iter)
63 (*iter)->AddFlags(FCVAR_GAMEDLL);
67 void SMConVarAccessor::Unregister(ConCommandBase *pCommand)
69 ConCommandBase *pCur = NULL;
70 ConCommandBase *pPrev = NULL;
72 if (!pCommand || !pCommand->IsRegistered())
77 pCur = g_Engine.icvar->GetCommands();
78 pCommand->SetRegistered(false);
80 if (!m_TopConCommandBase || !pCur)
87 *m_TopConCommandBase = const_cast<ConCommandBase *>(pCommand->GetNext());
88 pCommand->SetNext(NULL);
93 pCur = const_cast<ConCommandBase *>(pCur->GetNext());
99 pPrev->SetNext(const_cast<ConCommandBase *>(pCommand->GetNext()));
100 pCommand->SetNext(NULL);
104 pCur = const_cast<ConCommandBase *>(pCur->GetNext());
108 ConVar metamod_version("metamod_version", MMS_FULL_VERSION, FCVAR_SPONLY | FCVAR_NOTIFY, "Metamod:Source Version");
110 ConVar mm_pluginsfile("mm_pluginsfile", "addons\\metamod\\metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
111 ConVar mm_basedir("mm_basedir", "addons\\metamod", FCVAR_SPONLY, "Metamod:Source base folder");
113 ConVar mm_pluginsfile("mm_pluginsfile", "addons/metamod/metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
114 ConVar mm_basedir("mm_basedir", "addons/metamod", FCVAR_SPONLY, "Metamod:Source base folder");
117 CON_COMMAND(meta, "Metamod:Source Menu")
119 IVEngineServer *e = g_Engine.engine;
121 int args = e->Cmd_Argc();
123 if (!g_GameDll.loaded && !g_bLevelChanged)
125 CONMSG("WARNING: You must change the map to activate Metamod:Source.\n");
131 const char *command = e->Cmd_Argv(1);
132 if (strcmp(command, "credits") == 0)
134 CONMSG("Metamod:Source was developed by:\n");
135 CONMSG(" SourceHook: Pavol \"PM OnoTo\" Marko\n");
136 CONMSG(" GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
137 CONMSG(" GameDLL: Scott \"DS\" Ehlert\n");
138 CONMSG("For more information, see the official website\n");
139 CONMSG("http://www.metamodsource.net/\n");
142 } else if (strcmp(command, "version") == 0) {
143 CONMSG("Metamod:Source version %s\n", MMS_FULL_VERSION);
144 CONMSG("Build ID: %s\n", MMS_BUILD_UNIQUEID);
145 if (g_GameDll.loaded)
147 CONMSG("Loaded As: GameDLL (gameinfo.txt)\n");
151 CONMSG("Loaded As: Valve Server Plugin\n");
153 CONMSG("Compiled on: %s\n", SOURCEMM_DATE);
154 CONMSG("Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
155 CONMSG("SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
156 CONMSG("http://www.metamodsource.net/\n");
159 } else if (strcmp(command, "game") == 0) {
160 char bin_path[PATH_SIZE];
161 GetFileOfAddress((void*)g_GameDll.factory, bin_path, sizeof(bin_path));
163 CONMSG("GameDLL Information\n");
164 CONMSG(" Description: %s\n", g_GameDll.pGameDLL->GetGameDescription());
165 CONMSG(" Mod Path: %s\n", g_ModPath.c_str());
166 CONMSG(" DLL Path: %s\n", bin_path);
167 CONMSG(" Interface: ServerGameDLL%03d\n", g_GameDllVersion);
169 if (g_Engine.original)
171 CONMSG(" Engine: Original (pre-Episode 1)\n");
175 CONMSG(" Engine: Episode 1 (2004)\n");
178 // Display user messages
181 int msgcount = g_SmmAPI.GetUserMessageCount();
185 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
187 for (int i = 0; i < msgcount; i++)
189 msgname = g_SmmAPI.GetUserMessage(i, &msgsize);
191 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
194 CONMSG(" %d user message%s in total\n", msgcount, (msgcount > 1) ? "s" : "");
196 CONMSG(" User Messages: None\n");
200 } else if (strcmp(command, "refresh") == 0) {
201 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
202 g_SmmAPI.PathFormat(filepath, sizeof(filepath), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
203 g_SmmAPI.PathFormat(vdfpath, sizeof(vdfpath), "%s/%s", g_ModPath.c_str(), GetMetamodBaseDir());
205 LoadPlugins(filepath, vdfpath);
208 } else if (strcmp(command, "list") == 0) {
214 SourceMM::CPluginManager::CPlugin *pl;
215 unsigned int plnum = g_PluginMngr.GetPluginCount();
217 #define IS_STR_FILLED(var) (var != NULL && var[0] != '\0')
221 CONMSG("No plugins loaded.\n");
226 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
229 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
239 if (pl->m_Status != Pl_Running)
241 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
245 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
248 if ((plapi = pl->m_API))
250 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
251 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
253 if (IS_STR_FILLED(plapi->GetVersion()))
255 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
257 if (IS_STR_FILLED(plapi->GetAuthor()))
259 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
263 CONMSG("%s\n", buffer);
267 } else if (strcmp(command, "cmds") == 0) {
270 int id = atoi(e->Cmd_Argv(2));
271 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
275 CONMSG("Plugin %d not found.\n", id);
281 CONMSG("Plugin %d is not loaded.\n", id);
283 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
284 SourceHook::List<ConCommandBase *>::iterator ci;
287 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
290 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
294 CONMSG("Usage: meta cmds <id>\n");
298 } else if (strcmp(command, "cvars") == 0) {
301 int id = atoi(e->Cmd_Argv(2));
302 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
306 CONMSG("Plugin %d not found.\n", id);
312 CONMSG("Plugin %d is not loaded.\n", id);
314 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
315 SourceHook::List<ConCommandBase *>::iterator ci;
318 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
321 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
325 CONMSG("Usage: meta cvars <id>\n");
329 } else if (strcmp(command, "info") == 0) {
332 int id = atoi(e->Cmd_Argv(2));
333 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
336 CONMSG("Plugin %d not found.\n", id);
342 CONMSG("Plugin %d is not loaded.\n", id);
344 if (pl->m_Status == Pl_Paused)
346 CONMSG("Plugin %d is paused.\n", id);
347 } else if (pl->m_Status == Pl_Running) {
350 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
354 CONMSG("Plugin %d is running.\n", id);
356 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
359 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
360 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
361 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
362 CONMSG(" License: %s\n", pl->m_API->GetLicense());
363 CONMSG(" URL: %s\n", pl->m_API->GetURL());
364 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
366 CONMSG("File: %s\n\n", pl->m_File.c_str());
370 CONMSG("Usage: meta info <id>\n");
374 } else if (strcmp(command, "pause") == 0) {
377 int id = atoi(e->Cmd_Argv(2));
381 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
383 CONMSG("Pause failed: %s\n", error);
387 CONMSG("Plugin %d has been paused.\n", id);
391 CONMSG("Usage: meta pause <id>\n");
395 } else if (strcmp(command, "unpause") == 0) {
398 int id = atoi(e->Cmd_Argv(2));
401 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
403 CONMSG("Unpause failed: %s\n", error);
407 CONMSG("Plugin %d has been unpaused.\n", id);
411 CONMSG("Usage: meta unpause <id>\n");
415 } else if (strcmp(command, "load") == 0) {
418 const char *file = e->Cmd_Argv(2);
421 const char *alias = g_PluginMngr.LookupAlias(file);
427 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
429 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
431 const char *ext = UTIL_GetExtension(file);
432 #if defined WIN32 || defined _WIN32
433 ext = ext ? "" : ".dll";
435 ext = ext ? "" : "_i486.so";
437 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
442 SourceMM::CPluginManager::CPlugin *pl;
444 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
445 pl = g_PluginMngr.FindById(id);
446 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
448 CONMSG("Failed to load plugin %s (%s).\n", file, error);
454 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
456 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
461 CONMSG("Usage: meta load <path>\n");
465 } else if ( (strcmp(command, "alias") == 0) ||
466 (strcmp(command, "aliases") == 0) ) {
469 const char *alias = e->Cmd_Argv(2);
470 const char *value = e->Cmd_Argv(3);
472 g_PluginMngr.SetAlias(alias, value);
473 if (value[0] == '\0')
475 CONMSG("Deleted alias: %s.\n", alias);
477 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
479 } else if (args >= 3) {
480 const char *alias = e->Cmd_Argv(2);
481 const char *value = g_PluginMngr.LookupAlias(alias);
484 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
486 CONMSG("Alias \"%s\" was not found.\n", alias);
489 SourceHook::List<SourceMM::CNameAlias *>::iterator iter, end;
490 SourceMM::CNameAlias *p;
492 iter = g_PluginMngr._alias_begin();
493 end = g_PluginMngr._alias_end();
497 CONMSG("%-10.9s %s\n", "Alias", "File");
499 for (; iter!=end; iter++)
502 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
506 CONMSG("%d aliases total.\n", total);
508 CONMSG("No aliases found.\n");
512 } else if (strcmp(command, "unload") == 0) {
515 const char *file = e->Cmd_Argv(2);
519 if (id == 0 && isalpha(file[0]))
522 const char *alias = g_PluginMngr.LookupAlias(file);
529 /* first check if it's a known filename */
530 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
532 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
534 const char *ext = UTIL_GetExtension(file);
535 #if defined WIN32 || defined _WIN32
536 ext = ext ? "" : ".dll";
538 ext = ext ? "" : "_i486.so";
540 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
543 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator iter, end;
544 SourceMM::CPluginManager::CPlugin *pl;
545 iter = g_PluginMngr._begin();
546 end = g_PluginMngr._end();
547 for (; iter!=end; iter++)
550 if (strcmp(pl->m_File.c_str(), full_path) == 0)
558 CONMSG("Plugin \"%s\" not found.\n", full_path);
563 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
565 CONMSG("Unload failed: %s\n", error);
569 CONMSG("Plugin %d unloaded.\n", id);
571 CONMSG("Usage: meta unload <id>\n");
574 } else if (strcmp(command, "force_unload") == 0) {
577 int id = atoi(e->Cmd_Argv(2));
580 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
582 CONMSG("Force unload failed: %s\n", error);
586 CONMSG("Plugin %d force unloaded.\n", id);
590 CONMSG("Usage: meta force_unload <id>\n");
594 } else if (strcmp(command, "clear") == 0) {
595 if (!g_PluginMngr.UnloadAll())
597 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
601 CONMSG("All plugins unloaded.\n");
604 } else if (strcmp(command, "retry") == 0) {
607 int id = atoi(e->Cmd_Argv(2));
610 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
612 CONMSG("Error reloading plugin: %s\n", error);
616 CONMSG("Plugin %d successfully reloaded.\n", id);
620 CONMSG("Usage: meta retry <id>\n");
627 CONMSG("Metamod:Source Menu\n");
628 CONMSG("usage: meta <command> [arguments]\n");
629 CONMSG(" alias - List or set an alias\n");
630 CONMSG(" clear - Unload all plugins forcefully\n");
631 CONMSG(" cmds - Show plugin commands\n");
632 CONMSG(" cvars - Show plugin cvars\n");
633 CONMSG(" credits - About Metamod:Source\n");
634 CONMSG(" force_unload - Forcefully unload a plugin\n");
635 CONMSG(" game - Information about GameDLL\n");
636 CONMSG(" info - Information about a plugin\n");
637 CONMSG(" list - List plugins\n");
638 CONMSG(" load - Load a plugin\n");
639 CONMSG(" pause - Pause a running plugin\n");
640 CONMSG(" refresh - Reparse plugin files\n");
641 CONMSG(" retry - Attempt to reload a plugin\n");
642 CONMSG(" unload - Unload a loaded plugin\n");
643 CONMSG(" unpause - Unpause a paused plugin\n");
644 CONMSG(" version - Version information\n");
647 void ClientCommand_handler(edict_t *client)
649 IVEngineServer *e = g_Engine.engine;
650 const char *cmd = e->Cmd_Argv(0);
652 if (strcmp(cmd, "meta") == 0)
654 int args = e->Cmd_Argc();
657 const char *subcmd = e->Cmd_Argv(1);
659 if (strcmp(subcmd, "credits") == 0)
661 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
662 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
663 CLIENT_CONMSG(client, " Core: David \"BAILOPAN\" Anderson\n");
664 CLIENT_CONMSG(client, " Core: Scott \"DS\" Ehlert\n");
665 CLIENT_CONMSG(client, "For more information, see the official website\n");
666 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
668 RETURN_META(MRES_SUPERCEDE);
669 } else if(strcmp(subcmd, "version") == 0) {
670 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
671 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
672 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
673 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
674 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
676 RETURN_META(MRES_SUPERCEDE);
677 } else if(strcmp(subcmd, "list") == 0) {
678 SourceMM::CPluginManager::CPlugin *pl;
686 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
689 if (pl && pl->m_Status == Pl_Running)
692 if (!plapi || !plapi->QueryRunning(NULL, 0))
698 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
700 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
701 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
703 if (IS_STR_FILLED(plapi->GetVersion()))
705 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
707 if (IS_STR_FILLED(plapi->GetAuthor()))
709 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
712 CLIENT_CONMSG(client, "%s\n", buffer);
718 CLIENT_CONMSG(client, "No active plugins loaded.\n");
721 RETURN_META(MRES_SUPERCEDE);
725 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
726 CLIENT_CONMSG(client, "usage: meta <command>\n");
727 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
728 CLIENT_CONMSG(client, " list - List plugins\n");
729 CLIENT_CONMSG(client, " version - Version information\n");
731 RETURN_META(MRES_SUPERCEDE);
734 RETURN_META(MRES_IGNORED);
737 void SMConVarAccessor::UnloadMetamodCommands()
739 Unregister(&metamod_version);
740 Unregister(&mm_pluginsfile);
741 Unregister(&mm_basedir);
742 Unregister(&meta_command);
745 const char *GetPluginsFile()
747 return mm_pluginsfile.GetString();
750 const char *GetMetamodBaseDir()
752 return mm_basedir.GetString();
755 /* Signature for ICvar::GetCommands() in vstdlib for Win32 and Linux.
757 * 20226EE0 A1 50 5C 5A 20 mov eax,dword ptr ds:[205A5C50h] <-- What we want
760 #define CMDLIST_SIG "\xA1\x2A\x2A\x2A\x2A\xC3"
761 #define CMDLIST_SIGLEN 6
763 /* Linux symbol name of ConCommandBase list in vstdlib */
764 #define CMDLIST_SYMBOL "_ZN14ConCommandBase18s_pConCommandBasesE"
766 /* This function retrieves the address of the var that holds the top of the ConCommandBase list.
767 * Having this allows us to change the beginning of this list with ease.
769 * This craziness eliminates the need for the eternal command/cvar used previously which
770 * could have caused a crash as a result of registering commands/cvars more than once.
772 bool SMConVarAccessor::InitConCommandBaseList()
774 char *vfunc = UTIL_GetOrigFunction(&ICvar::GetCommands, g_Engine.icvar);
782 if (UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
784 /* Skip past 0xA1 and get addr of ConCommandBase list var */
785 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);
788 #elif defined OS_LINUX
789 /* Try dlsym first */
790 char path[PATH_SIZE];
791 if (GetFileOfAddress((void *)g_Engine.icvar, path, sizeof(path)))
793 void *handle = dlopen(path, RTLD_NOW);
796 m_TopConCommandBase = reinterpret_cast<ConCommandBase **>(dlsym(handle, CMDLIST_SYMBOL));
802 /* If dlsym failed, then verify signature of function */
803 if (!m_TopConCommandBase && UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
805 /* Skip past 0xA1 and get addr of ConCommandBase list var */
806 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);