Trigger build for hl2sdk-l4d changes.
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2010 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"
19 #include <versionlib.h>
22 * @brief Console Command Implementations
23 * @file concommands.cpp
26 SMConVarAccessor g_SMConVarAccessor;
28 SMConVarAccessor::SMConVarAccessor()
30 m_TopConCommandBase = NULL;
33 bool SMConVarAccessor::RegisterConCommandBase(ConCommandBase *pCommand)
35 /* Add the FCVAR_GAMEDLL flag
36 * => No crash on exit!
37 * UPDATE: Do _not_ add the FCVAR_GAMEDLL flag here, as it
38 * causes the command to be unusable on listen servers until you load a map
39 * We will set the FCVAR_GAMEDLL flag on all commands we have registered once we are being unloaded
41 // pCommand->AddFlags(FCVAR_GAMEDLL);
42 m_RegisteredCommands.push_back(pCommand);
44 pCommand->SetNext(NULL);
45 g_Engine.icvar->RegisterConCommandBase(pCommand);
50 bool SMConVarAccessor::Register(ConCommandBase *pCommand)
52 /* Simple, don't mark as part of sourcemm! */
53 pCommand->SetNext(NULL);
54 g_Engine.icvar->RegisterConCommandBase(pCommand);
59 void SMConVarAccessor::MarkCommandsAsGameDLL()
61 for (SourceHook::List<ConCommandBase*>::iterator iter = m_RegisteredCommands.begin();
62 iter != m_RegisteredCommands.end(); ++iter)
64 (*iter)->AddFlags(FCVAR_GAMEDLL);
68 void SMConVarAccessor::Unregister(ConCommandBase *pCommand)
70 ConCommandBase *pCur = NULL;
71 ConCommandBase *pPrev = NULL;
73 if (!pCommand || !pCommand->IsRegistered())
78 pCur = g_Engine.icvar->GetCommands();
79 pCommand->SetRegistered(false);
81 if (!m_TopConCommandBase || !pCur)
88 *m_TopConCommandBase = const_cast<ConCommandBase *>(pCommand->GetNext());
89 pCommand->SetNext(NULL);
94 pCur = const_cast<ConCommandBase *>(pCur->GetNext());
100 pPrev->SetNext(const_cast<ConCommandBase *>(pCommand->GetNext()));
101 pCommand->SetNext(NULL);
105 pCur = const_cast<ConCommandBase *>(pCur->GetNext());
109 ConVar metamod_version("metamod_version", METAMOD_VERSION, FCVAR_SPONLY | FCVAR_NOTIFY, "Metamod:Source Version");
111 ConVar mm_pluginsfile("mm_pluginsfile", "addons\\metamod\\metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
112 ConVar mm_basedir("mm_basedir", "addons\\metamod", FCVAR_SPONLY, "Metamod:Source base folder");
114 ConVar mm_pluginsfile("mm_pluginsfile", "addons/metamod/metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
115 ConVar mm_basedir("mm_basedir", "addons/metamod", FCVAR_SPONLY, "Metamod:Source base folder");
118 CON_COMMAND(meta, "Metamod:Source Menu")
120 IVEngineServer *e = g_Engine.engine;
122 int args = e->Cmd_Argc();
124 if (!g_GameDll.loaded && !g_bLevelChanged)
126 CONMSG("WARNING: You must change the map to activate Metamod:Source.\n");
132 const char *command = e->Cmd_Argv(1);
133 if (strcmp(command, "credits") == 0)
135 CONMSG("Metamod:Source was developed by:\n");
136 CONMSG(" SourceHook: Pavol \"PM OnoTo\" Marko\n");
137 CONMSG(" GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
138 CONMSG(" GameDLL: Scott \"DS\" Ehlert\n");
139 CONMSG("For more information, see the official website\n");
140 CONMSG("http://www.metamodsource.net/\n");
143 } else if (strcmp(command, "version") == 0) {
144 CONMSG("Metamod:Source version %s\n", METAMOD_VERSION);
145 CONMSG("Build ID: %s\n", METAMOD_BUILD_ID);
146 if (g_GameDll.loaded)
148 CONMSG("Loaded As: GameDLL (gameinfo.txt)\n");
152 CONMSG("Loaded As: Valve Server Plugin\n");
154 CONMSG("Compiled on: %s\n", SOURCEMM_DATE);
155 CONMSG("Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
156 CONMSG("SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
157 CONMSG("http://www.metamodsource.net/\n");
160 } else if (strcmp(command, "game") == 0) {
161 char bin_path[PATH_SIZE];
162 GetFileOfAddress((void*)g_GameDll.factory, bin_path, sizeof(bin_path));
164 CONMSG("GameDLL Information\n");
165 CONMSG(" Description: %s\n", g_GameDll.pGameDLL->GetGameDescription());
166 CONMSG(" Mod Path: %s\n", g_ModPath.c_str());
167 CONMSG(" DLL Path: %s\n", bin_path);
168 CONMSG(" Interface: ServerGameDLL%03d\n", g_GameDllVersion);
170 if (g_Engine.original)
172 CONMSG(" Engine: Original (pre-Episode 1)\n");
176 CONMSG(" Engine: Episode 1 (2004)\n");
179 // Display user messages
182 int msgcount = g_SmmAPI.GetUserMessageCount();
186 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
188 for (int i = 0; i < msgcount; i++)
190 msgname = g_SmmAPI.GetUserMessage(i, &msgsize);
192 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
195 CONMSG(" %d user message%s in total\n", msgcount, (msgcount > 1) ? "s" : "");
197 CONMSG(" User Messages: None\n");
201 } else if (strcmp(command, "refresh") == 0) {
202 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
203 g_SmmAPI.PathFormat(filepath, sizeof(filepath), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
204 g_SmmAPI.PathFormat(vdfpath, sizeof(vdfpath), "%s/%s", g_ModPath.c_str(), GetMetamodBaseDir());
206 LoadPlugins(filepath, vdfpath);
209 } else if (strcmp(command, "list") == 0) {
215 SourceMM::CPluginManager::CPlugin *pl;
216 unsigned int plnum = g_PluginMngr.GetPluginCount();
218 #define IS_STR_FILLED(var) (var != NULL && var[0] != '\0')
222 CONMSG("No plugins loaded.\n");
227 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
230 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
240 if (pl->m_Status != Pl_Running)
242 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
246 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
249 if ((plapi = pl->m_API))
251 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
252 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
254 if (IS_STR_FILLED(plapi->GetVersion()))
256 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
258 if (IS_STR_FILLED(plapi->GetAuthor()))
260 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
264 CONMSG("%s\n", buffer);
268 } else if (strcmp(command, "cmds") == 0) {
271 int id = atoi(e->Cmd_Argv(2));
272 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
276 CONMSG("Plugin %d not found.\n", id);
282 CONMSG("Plugin %d is not loaded.\n", id);
284 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
285 SourceHook::List<ConCommandBase *>::iterator ci;
288 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
291 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
295 CONMSG("Usage: meta cmds <id>\n");
299 } else if (strcmp(command, "cvars") == 0) {
302 int id = atoi(e->Cmd_Argv(2));
303 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
307 CONMSG("Plugin %d not found.\n", id);
313 CONMSG("Plugin %d is not loaded.\n", id);
315 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
316 SourceHook::List<ConCommandBase *>::iterator ci;
319 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
322 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
326 CONMSG("Usage: meta cvars <id>\n");
330 } else if (strcmp(command, "info") == 0) {
333 int id = atoi(e->Cmd_Argv(2));
334 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
337 CONMSG("Plugin %d not found.\n", id);
343 CONMSG("Plugin %d is not loaded.\n", id);
345 if (pl->m_Status == Pl_Paused)
347 CONMSG("Plugin %d is paused.\n", id);
348 } else if (pl->m_Status == Pl_Running) {
351 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
355 CONMSG("Plugin %d is running.\n", id);
357 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
360 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
361 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
362 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
363 CONMSG(" License: %s\n", pl->m_API->GetLicense());
364 CONMSG(" URL: %s\n", pl->m_API->GetURL());
365 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
367 CONMSG("File: %s\n\n", pl->m_File.c_str());
371 CONMSG("Usage: meta info <id>\n");
375 } else if (strcmp(command, "pause") == 0) {
378 int id = atoi(e->Cmd_Argv(2));
382 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
384 CONMSG("Pause failed: %s\n", error);
388 CONMSG("Plugin %d has been paused.\n", id);
392 CONMSG("Usage: meta pause <id>\n");
396 } else if (strcmp(command, "unpause") == 0) {
399 int id = atoi(e->Cmd_Argv(2));
402 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
404 CONMSG("Unpause failed: %s\n", error);
408 CONMSG("Plugin %d has been unpaused.\n", id);
412 CONMSG("Usage: meta unpause <id>\n");
416 } else if (strcmp(command, "load") == 0) {
419 const char *file = e->Cmd_Argv(2);
422 const char *alias = g_PluginMngr.LookupAlias(file);
428 g_SmmAPI.GetFullPluginPath(file, full_path, sizeof(full_path));
432 SourceMM::CPluginManager::CPlugin *pl;
434 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
435 pl = g_PluginMngr.FindById(id);
436 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
438 CONMSG("Failed to load plugin %s (%s).\n", file, error);
444 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
446 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
451 CONMSG("Usage: meta load <path>\n");
455 } else if ( (strcmp(command, "alias") == 0) ||
456 (strcmp(command, "aliases") == 0) ) {
459 const char *alias = e->Cmd_Argv(2);
460 const char *value = e->Cmd_Argv(3);
462 g_PluginMngr.SetAlias(alias, value);
463 if (value[0] == '\0')
465 CONMSG("Deleted alias: %s.\n", alias);
467 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
469 } else if (args >= 3) {
470 const char *alias = e->Cmd_Argv(2);
471 const char *value = g_PluginMngr.LookupAlias(alias);
474 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
476 CONMSG("Alias \"%s\" was not found.\n", alias);
479 SourceHook::List<SourceMM::CNameAlias *>::iterator iter, end;
480 SourceMM::CNameAlias *p;
482 iter = g_PluginMngr._alias_begin();
483 end = g_PluginMngr._alias_end();
487 CONMSG("%-10.9s %s\n", "Alias", "File");
489 for (; iter!=end; iter++)
492 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
496 CONMSG("%d aliases total.\n", total);
498 CONMSG("No aliases found.\n");
502 } else if (strcmp(command, "unload") == 0) {
505 const char *file = e->Cmd_Argv(2);
509 if (id == 0 && isalpha(file[0]))
512 const char *alias = g_PluginMngr.LookupAlias(file);
519 g_SmmAPI.GetFullPluginPath(file, full_path, sizeof(full_path));
521 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator iter, end;
522 SourceMM::CPluginManager::CPlugin *pl;
523 iter = g_PluginMngr._begin();
524 end = g_PluginMngr._end();
525 for (; iter!=end; iter++)
528 if (strcmp(pl->m_File.c_str(), full_path) == 0)
536 CONMSG("Plugin \"%s\" not found.\n", full_path);
541 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
543 CONMSG("Unload failed: %s\n", error);
547 CONMSG("Plugin %d unloaded.\n", id);
549 CONMSG("Usage: meta unload <id>\n");
552 } else if (strcmp(command, "force_unload") == 0) {
555 int id = atoi(e->Cmd_Argv(2));
558 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
560 CONMSG("Force unload failed: %s\n", error);
564 CONMSG("Plugin %d force unloaded.\n", id);
568 CONMSG("Usage: meta force_unload <id>\n");
572 } else if (strcmp(command, "clear") == 0) {
573 if (!g_PluginMngr.UnloadAll())
575 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
579 CONMSG("All plugins unloaded.\n");
582 } else if (strcmp(command, "retry") == 0) {
585 int id = atoi(e->Cmd_Argv(2));
588 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
590 CONMSG("Error reloading plugin: %s\n", error);
594 CONMSG("Plugin %d successfully reloaded.\n", id);
598 CONMSG("Usage: meta retry <id>\n");
605 CONMSG("Metamod:Source Menu\n");
606 CONMSG("usage: meta <command> [arguments]\n");
607 CONMSG(" alias - List or set an alias\n");
608 CONMSG(" clear - Unload all plugins forcefully\n");
609 CONMSG(" cmds - Show plugin commands\n");
610 CONMSG(" cvars - Show plugin cvars\n");
611 CONMSG(" credits - About Metamod:Source\n");
612 CONMSG(" force_unload - Forcefully unload a plugin\n");
613 CONMSG(" game - Information about GameDLL\n");
614 CONMSG(" info - Information about a plugin\n");
615 CONMSG(" list - List plugins\n");
616 CONMSG(" load - Load a plugin\n");
617 CONMSG(" pause - Pause a running plugin\n");
618 CONMSG(" refresh - Reparse plugin files\n");
619 CONMSG(" retry - Attempt to reload a plugin\n");
620 CONMSG(" unload - Unload a loaded plugin\n");
621 CONMSG(" unpause - Unpause a paused plugin\n");
622 CONMSG(" version - Version information\n");
625 void ClientCommand_handler(edict_t *client)
627 IVEngineServer *e = g_Engine.engine;
628 const char *cmd = e->Cmd_Argv(0);
630 if (strcmp(cmd, "meta") == 0)
632 int args = e->Cmd_Argc();
635 const char *subcmd = e->Cmd_Argv(1);
637 if (strcmp(subcmd, "credits") == 0)
639 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
640 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
641 CLIENT_CONMSG(client, " Core: David \"BAILOPAN\" Anderson\n");
642 CLIENT_CONMSG(client, " Core: Scott \"DS\" Ehlert\n");
643 CLIENT_CONMSG(client, "For more information, see the official website\n");
644 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
646 RETURN_META(MRES_SUPERCEDE);
647 } else if(strcmp(subcmd, "version") == 0) {
648 CLIENT_CONMSG(client, "Metamod:Source version %s\n", METAMOD_VERSION);
649 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
650 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
651 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
652 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
654 RETURN_META(MRES_SUPERCEDE);
655 } else if(strcmp(subcmd, "list") == 0) {
656 SourceMM::CPluginManager::CPlugin *pl;
664 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
667 if (pl && pl->m_Status == Pl_Running)
670 if (!plapi || !plapi->QueryRunning(NULL, 0))
676 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
678 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
679 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
681 if (IS_STR_FILLED(plapi->GetVersion()))
683 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
685 if (IS_STR_FILLED(plapi->GetAuthor()))
687 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
690 CLIENT_CONMSG(client, "%s\n", buffer);
696 CLIENT_CONMSG(client, "No active plugins loaded.\n");
699 RETURN_META(MRES_SUPERCEDE);
703 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
704 CLIENT_CONMSG(client, "usage: meta <command>\n");
705 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
706 CLIENT_CONMSG(client, " list - List plugins\n");
707 CLIENT_CONMSG(client, " version - Version information\n");
709 RETURN_META(MRES_SUPERCEDE);
712 RETURN_META(MRES_IGNORED);
715 void SMConVarAccessor::UnloadMetamodCommands()
717 Unregister(&metamod_version);
718 Unregister(&mm_pluginsfile);
719 Unregister(&mm_basedir);
720 Unregister(&meta_command);
723 const char *GetPluginsFile()
725 return mm_pluginsfile.GetString();
728 const char *GetMetamodBaseDir()
730 return mm_basedir.GetString();
733 /* Signature for ICvar::GetCommands() in vstdlib for Win32 and Linux.
735 * 20226EE0 A1 50 5C 5A 20 mov eax,dword ptr ds:[205A5C50h] <-- What we want
738 #define CMDLIST_SIG "\xA1\x2A\x2A\x2A\x2A\xC3"
739 #define CMDLIST_SIGLEN 6
741 /* Linux symbol name of ConCommandBase list in vstdlib */
742 #define CMDLIST_SYMBOL "_ZN14ConCommandBase18s_pConCommandBasesE"
744 /* This function retrieves the address of the var that holds the top of the ConCommandBase list.
745 * Having this allows us to change the beginning of this list with ease.
747 * This craziness eliminates the need for the eternal command/cvar used previously which
748 * could have caused a crash as a result of registering commands/cvars more than once.
750 bool SMConVarAccessor::InitConCommandBaseList()
752 char *vfunc = UTIL_GetOrigFunction(&ICvar::GetCommands, g_Engine.icvar);
760 if (UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
762 /* Skip past 0xA1 and get addr of ConCommandBase list var */
763 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);
766 #elif defined OS_LINUX
767 /* Try dlsym first */
768 char path[PATH_SIZE];
769 if (GetFileOfAddress((void *)g_Engine.icvar, path, sizeof(path)))
771 void *handle = dlopen(path, RTLD_NOW);
774 m_TopConCommandBase = reinterpret_cast<ConCommandBase **>(dlsym(handle, CMDLIST_SYMBOL));
780 /* If dlsym failed, then verify signature of function */
781 if (!m_TopConCommandBase && UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
783 /* Skip past 0xA1 and get addr of ConCommandBase list var */
784 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);