Fixed circular dependency between sourcemm.h/util.h (build bustage).
1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2008 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"
18 #include "vsp_listener.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", MMS_FULL_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_bIsBridgedAsVsp && !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 \"Damaged Soul\" 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", MMS_FULL_VERSION);
145 CONMSG("Build ID: %s\n", MMS_BUILD_UNIQUEID);
146 if (g_bIsBridgedAsVsp)
148 CONMSG("Loaded As: Valve Server Plugin\n");
152 CONMSG("Loaded As: GameDLL (gameinfo.txt)\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
180 if (g_SmmAPI.MsgCacheSuccessful())
184 int msgcount = g_SmmAPI.GetUserMessageCount();
188 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
190 for (int i = 0; i < msgcount; i++)
192 msgname = g_SmmAPI.GetUserMessage(i, &msgsize);
194 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
197 CONMSG(" %d user message%s in total\n", msgcount, (msgcount > 1) ? "s" : "");
199 CONMSG(" User Messages: None\n");
202 CONMSG(" User Messages: Failed to get list of user messages\n");
206 } else if (strcmp(command, "refresh") == 0) {
207 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
208 g_SmmAPI.PathFormat(filepath, sizeof(filepath), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
209 g_SmmAPI.PathFormat(vdfpath, sizeof(vdfpath), "%s/%s", g_ModPath.c_str(), GetMetamodBaseDir());
211 LoadPlugins(filepath, vdfpath);
214 } else if (strcmp(command, "list") == 0) {
220 SourceMM::CPluginManager::CPlugin *pl;
221 unsigned int plnum = g_PluginMngr.GetPluginCount();
223 #define IS_STR_FILLED(var) (var != NULL && var[0] != '\0')
227 CONMSG("No plugins loaded.\n");
232 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
235 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
245 if (pl->m_Status != Pl_Running)
247 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
251 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
254 if ((plapi = pl->m_API))
256 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
257 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
259 if (IS_STR_FILLED(plapi->GetVersion()))
261 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
263 if (IS_STR_FILLED(plapi->GetAuthor()))
265 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
269 CONMSG("%s\n", buffer);
273 } else if (strcmp(command, "cmds") == 0) {
276 int id = atoi(e->Cmd_Argv(2));
277 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
281 CONMSG("Plugin %d not found.\n", id);
287 CONMSG("Plugin %d is not loaded.\n", id);
289 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
290 SourceHook::List<ConCommandBase *>::iterator ci;
293 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
296 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
300 CONMSG("Usage: meta cmds <id>\n");
304 } else if (strcmp(command, "cvars") == 0) {
307 int id = atoi(e->Cmd_Argv(2));
308 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
312 CONMSG("Plugin %d not found.\n", id);
318 CONMSG("Plugin %d is not loaded.\n", id);
320 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
321 SourceHook::List<ConCommandBase *>::iterator ci;
324 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
327 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
331 CONMSG("Usage: meta cvars <id>\n");
335 } else if (strcmp(command, "info") == 0) {
338 int id = atoi(e->Cmd_Argv(2));
339 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
342 CONMSG("Plugin %d not found.\n", id);
348 CONMSG("Plugin %d is not loaded.\n", id);
350 if (pl->m_Status == Pl_Paused)
352 CONMSG("Plugin %d is paused.\n", id);
353 } else if (pl->m_Status == Pl_Running) {
356 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
360 CONMSG("Plugin %d is running.\n", id);
362 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
365 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
366 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
367 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
368 CONMSG(" License: %s\n", pl->m_API->GetLicense());
369 CONMSG(" URL: %s\n", pl->m_API->GetURL());
370 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
372 CONMSG("File: %s\n\n", pl->m_File.c_str());
376 CONMSG("Usage: meta info <id>\n");
380 } else if (strcmp(command, "pause") == 0) {
383 int id = atoi(e->Cmd_Argv(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);
397 CONMSG("Usage: meta pause <id>\n");
401 } else if (strcmp(command, "unpause") == 0) {
404 int id = atoi(e->Cmd_Argv(2));
407 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
409 CONMSG("Unpause failed: %s\n", error);
413 CONMSG("Plugin %d has been unpaused.\n", id);
417 CONMSG("Usage: meta unpause <id>\n");
421 } else if (strcmp(command, "load") == 0) {
424 const char *file = e->Cmd_Argv(2);
427 const char *alias = g_PluginMngr.LookupAlias(file);
433 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
435 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
437 const char *ext = UTIL_GetExtension(file);
438 #if defined WIN32 || defined _WIN32
439 ext = ext ? "" : ".dll";
441 ext = ext ? "" : "_i486.so";
443 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
448 SourceMM::CPluginManager::CPlugin *pl;
450 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
451 pl = g_PluginMngr.FindById(id);
452 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
454 CONMSG("Failed to load plugin %s (%s).\n", file, error);
460 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
462 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
467 CONMSG("Usage: meta load <path>\n");
471 } else if ( (strcmp(command, "alias") == 0) ||
472 (strcmp(command, "aliases") == 0) ) {
475 const char *alias = e->Cmd_Argv(2);
476 const char *value = e->Cmd_Argv(3);
478 g_PluginMngr.SetAlias(alias, value);
479 if (value[0] == '\0')
481 CONMSG("Deleted alias: %s.\n", alias);
483 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
485 } else if (args >= 3) {
486 const char *alias = e->Cmd_Argv(2);
487 const char *value = g_PluginMngr.LookupAlias(alias);
490 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
492 CONMSG("Alias \"%s\" was not found.\n", alias);
495 SourceHook::List<SourceMM::CNameAlias *>::iterator iter, end;
496 SourceMM::CNameAlias *p;
498 iter = g_PluginMngr._alias_begin();
499 end = g_PluginMngr._alias_end();
503 CONMSG("%-10.9s %s\n", "Alias", "File");
505 for (; iter!=end; iter++)
508 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
512 CONMSG("%d aliases total.\n", total);
514 CONMSG("No aliases found.\n");
518 } else if (strcmp(command, "unload") == 0) {
521 const char *file = e->Cmd_Argv(2);
525 if (id == 0 && isalpha(file[0]))
528 const char *alias = g_PluginMngr.LookupAlias(file);
535 /* first check if it's a known filename */
536 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
538 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
540 const char *ext = UTIL_GetExtension(file);
541 #if defined WIN32 || defined _WIN32
542 ext = ext ? "" : ".dll";
544 ext = ext ? "" : "_i486.so";
546 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
549 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator iter, end;
550 SourceMM::CPluginManager::CPlugin *pl;
551 iter = g_PluginMngr._begin();
552 end = g_PluginMngr._end();
553 for (; iter!=end; iter++)
556 if (strcmp(pl->m_File.c_str(), full_path) == 0)
564 CONMSG("Plugin \"%s\" not found.\n", full_path);
569 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
571 CONMSG("Unload failed: %s\n", error);
575 CONMSG("Plugin %d unloaded.\n", id);
577 CONMSG("Usage: meta unload <id>\n");
580 } else if (strcmp(command, "force_unload") == 0) {
583 int id = atoi(e->Cmd_Argv(2));
586 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
588 CONMSG("Force unload failed: %s\n", error);
592 CONMSG("Plugin %d force unloaded.\n", id);
596 CONMSG("Usage: meta force_unload <id>\n");
600 } else if (strcmp(command, "clear") == 0) {
601 if (!g_PluginMngr.UnloadAll())
603 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
607 CONMSG("All plugins unloaded.\n");
610 } else if (strcmp(command, "retry") == 0) {
613 int id = atoi(e->Cmd_Argv(2));
616 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
618 CONMSG("Error reloading plugin: %s\n", error);
622 CONMSG("Plugin %d successfully reloaded.\n", id);
626 CONMSG("Usage: meta retry <id>\n");
633 CONMSG("Metamod:Source Menu\n");
634 CONMSG("usage: meta <command> [arguments]\n");
635 CONMSG(" alias - List or set an alias\n");
636 CONMSG(" clear - Unload all plugins forcefully\n");
637 CONMSG(" cmds - Show plugin commands\n");
638 CONMSG(" cvars - Show plugin cvars\n");
639 CONMSG(" credits - About Metamod:Source\n");
640 CONMSG(" force_unload - Forcefully unload a plugin\n");
641 CONMSG(" game - Information about GameDLL\n");
642 CONMSG(" info - Information about a plugin\n");
643 CONMSG(" list - List plugins\n");
644 CONMSG(" load - Load a plugin\n");
645 CONMSG(" pause - Pause a running plugin\n");
646 CONMSG(" refresh - Reparse plugin files\n");
647 CONMSG(" retry - Attempt to reload a plugin\n");
648 CONMSG(" unload - Unload a loaded plugin\n");
649 CONMSG(" unpause - Unpause a paused plugin\n");
650 CONMSG(" version - Version information\n");
653 void ClientCommand_handler(edict_t *client)
655 IVEngineServer *e = g_Engine.engine;
656 const char *cmd = e->Cmd_Argv(0);
658 if (strcmp(cmd, "meta") == 0)
660 int args = e->Cmd_Argc();
663 const char *subcmd = e->Cmd_Argv(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, " Core: David \"BAILOPAN\" Anderson\n");
670 CLIENT_CONMSG(client, " Core: Scott \"Damaged Soul\" Ehlert\n");
671 CLIENT_CONMSG(client, "For more information, see the official website\n");
672 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
674 RETURN_META(MRES_SUPERCEDE);
675 } else if(strcmp(subcmd, "version") == 0) {
676 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
677 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
678 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
679 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
680 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
682 RETURN_META(MRES_SUPERCEDE);
683 } else if(strcmp(subcmd, "list") == 0) {
684 SourceMM::CPluginManager::CPlugin *pl;
692 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
695 if (pl && pl->m_Status == Pl_Running)
698 if (!plapi || !plapi->QueryRunning(NULL, 0))
704 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
706 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
707 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
709 if (IS_STR_FILLED(plapi->GetVersion()))
711 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
713 if (IS_STR_FILLED(plapi->GetAuthor()))
715 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
718 CLIENT_CONMSG(client, "%s\n", buffer);
724 CLIENT_CONMSG(client, "No active plugins loaded.\n");
727 RETURN_META(MRES_SUPERCEDE);
731 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
732 CLIENT_CONMSG(client, "usage: meta <command>\n");
733 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
734 CLIENT_CONMSG(client, " list - List plugins\n");
735 CLIENT_CONMSG(client, " version - Version information\n");
737 RETURN_META(MRES_SUPERCEDE);
740 RETURN_META(MRES_IGNORED);
743 void SMConVarAccessor::UnloadMetamodCommands()
745 Unregister(&metamod_version);
746 Unregister(&mm_pluginsfile);
747 Unregister(&mm_basedir);
748 Unregister(&meta_command);
751 const char *GetPluginsFile()
753 return mm_pluginsfile.GetString();
756 const char *GetMetamodBaseDir()
758 return mm_basedir.GetString();
761 /* Signature for ICvar::GetCommands() in vstdlib for Win32 and Linux.
763 * 20226EE0 A1 50 5C 5A 20 mov eax,dword ptr ds:[205A5C50h] <-- What we want
766 #define CMDLIST_SIG "\xA1\x2A\x2A\x2A\x2A\xC3"
767 #define CMDLIST_SIGLEN 6
769 /* Linux symbol name of ConCommandBase list in vstdlib */
770 #define CMDLIST_SYMBOL "_ZN14ConCommandBase18s_pConCommandBasesE"
772 /* This function retrieves the address of the var that holds the top of the ConCommandBase list.
773 * Having this allows us to change the beginning of this list with ease.
775 * This craziness eliminates the need for the eternal command/cvar used previously which
776 * could have caused a crash as a result of registering commands/cvars more than once.
778 bool SMConVarAccessor::InitConCommandBaseList()
780 char *vfunc = UTIL_GetOrigFunction(&ICvar::GetCommands, g_Engine.icvar);
788 if (UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
790 /* Skip past 0xA1 and get addr of ConCommandBase list var */
791 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);
794 #elif defined OS_LINUX
795 /* Try dlsym first */
796 char path[PATH_SIZE];
797 if (GetFileOfAddress((void *)g_Engine.icvar, path, sizeof(path)))
799 void *handle = dlopen(path, RTLD_NOW);
802 m_TopConCommandBase = reinterpret_cast<ConCommandBase **>(dlsym(handle, CMDLIST_SYMBOL));
808 /* If dlsym failed, then verify signature of function */
809 if (!m_TopConCommandBase && UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
811 /* Skip past 0xA1 and get addr of ConCommandBase list var */
812 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);