Bumped all versions.
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"
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_bIsBridgedAsVsp && !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 \"Damaged Soul\" 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_bIsBridgedAsVsp)
147 CONMSG("Loaded As: Valve Server Plugin\n");
151 CONMSG("Loaded As: GameDLL (gameinfo.txt)\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
179 if (g_SmmAPI.MsgCacheSuccessful())
183 int msgcount = g_SmmAPI.GetUserMessageCount();
187 CONMSG(" User Messages: %-32.31s %-5s %-5s\n", "Name", "Index", "Size");
189 for (int i = 0; i < msgcount; i++)
191 msgname = g_SmmAPI.GetUserMessage(i, &msgsize);
193 CONMSG(" %-32.31s %-5d %-5d\n", msgname, i, msgsize);
196 CONMSG(" %d user message%s in total\n", msgcount, (msgcount > 1) ? "s" : "");
198 CONMSG(" User Messages: None\n");
201 CONMSG(" User Messages: Failed to get list of user messages\n");
205 } else if (strcmp(command, "refresh") == 0) {
206 char filepath[PATH_SIZE], vdfpath[PATH_SIZE];
207 g_SmmAPI.PathFormat(filepath, sizeof(filepath), "%s/%s", g_ModPath.c_str(), GetPluginsFile());
208 g_SmmAPI.PathFormat(vdfpath, sizeof(vdfpath), "%s/%s", g_ModPath.c_str(), GetMetamodBaseDir());
210 LoadPlugins(filepath, vdfpath);
213 } else if (strcmp(command, "list") == 0) {
219 SourceMM::CPluginManager::CPlugin *pl;
220 unsigned int plnum = g_PluginMngr.GetPluginCount();
222 #define IS_STR_FILLED(var) (var != NULL && var[0] != '\0')
226 CONMSG("No plugins loaded.\n");
231 CONMSG("Listing %d plugin%s:\n", plnum, (plnum > 1) ? "s" : "");
234 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
244 if (pl->m_Status != Pl_Running)
246 len += UTIL_Format(buffer, sizeof(buffer), " [%02d] <%s>", pl->m_Id, g_PluginMngr.GetStatusText(pl));
250 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", pl->m_Id);
253 if ((plapi = pl->m_API))
255 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
256 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
258 if (IS_STR_FILLED(plapi->GetVersion()))
260 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
262 if (IS_STR_FILLED(plapi->GetAuthor()))
264 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
268 CONMSG("%s\n", buffer);
272 } else if (strcmp(command, "cmds") == 0) {
275 int id = atoi(e->Cmd_Argv(2));
276 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
280 CONMSG("Plugin %d not found.\n", id);
286 CONMSG("Plugin %d is not loaded.\n", id);
288 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
289 SourceHook::List<ConCommandBase *>::iterator ci;
292 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
295 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
299 CONMSG("Usage: meta cmds <id>\n");
303 } else if (strcmp(command, "cvars") == 0) {
306 int id = atoi(e->Cmd_Argv(2));
307 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
311 CONMSG("Plugin %d not found.\n", id);
317 CONMSG("Plugin %d is not loaded.\n", id);
319 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
320 SourceHook::List<ConCommandBase *>::iterator ci;
323 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
326 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
330 CONMSG("Usage: meta cvars <id>\n");
334 } else if (strcmp(command, "info") == 0) {
337 int id = atoi(e->Cmd_Argv(2));
338 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
341 CONMSG("Plugin %d not found.\n", id);
347 CONMSG("Plugin %d is not loaded.\n", id);
349 if (pl->m_Status == Pl_Paused)
351 CONMSG("Plugin %d is paused.\n", id);
352 } else if (pl->m_Status == Pl_Running) {
355 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
359 CONMSG("Plugin %d is running.\n", id);
361 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
364 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
365 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
366 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
367 CONMSG(" License: %s\n", pl->m_API->GetLicense());
368 CONMSG(" URL: %s\n", pl->m_API->GetURL());
369 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
371 CONMSG("File: %s\n\n", pl->m_File.c_str());
375 CONMSG("Usage: meta info <id>\n");
379 } else if (strcmp(command, "pause") == 0) {
382 int id = atoi(e->Cmd_Argv(2));
386 if (!g_PluginMngr.Pause(id, error, sizeof(error)))
388 CONMSG("Pause failed: %s\n", error);
392 CONMSG("Plugin %d has been paused.\n", id);
396 CONMSG("Usage: meta pause <id>\n");
400 } else if (strcmp(command, "unpause") == 0) {
403 int id = atoi(e->Cmd_Argv(2));
406 if (!g_PluginMngr.Unpause(id, error, sizeof(error)))
408 CONMSG("Unpause failed: %s\n", error);
412 CONMSG("Plugin %d has been unpaused.\n", id);
416 CONMSG("Usage: meta unpause <id>\n");
420 } else if (strcmp(command, "load") == 0) {
423 const char *file = e->Cmd_Argv(2);
426 const char *alias = g_PluginMngr.LookupAlias(file);
432 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
434 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
436 const char *ext = UTIL_GetExtension(file);
437 #if defined WIN32 || defined _WIN32
438 ext = ext ? "" : ".dll";
440 ext = ext ? "" : "_i486.so";
442 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
447 SourceMM::CPluginManager::CPlugin *pl;
449 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error));
450 pl = g_PluginMngr.FindById(id);
451 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
453 CONMSG("Failed to load plugin %s (%s).\n", file, error);
459 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
461 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
466 CONMSG("Usage: meta load <path>\n");
470 } else if ( (strcmp(command, "alias") == 0) ||
471 (strcmp(command, "aliases") == 0) ) {
474 const char *alias = e->Cmd_Argv(2);
475 const char *value = e->Cmd_Argv(3);
477 g_PluginMngr.SetAlias(alias, value);
478 if (value[0] == '\0')
480 CONMSG("Deleted alias: %s.\n", alias);
482 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
484 } else if (args >= 3) {
485 const char *alias = e->Cmd_Argv(2);
486 const char *value = g_PluginMngr.LookupAlias(alias);
489 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
491 CONMSG("Alias \"%s\" was not found.\n", alias);
494 SourceHook::List<SourceMM::CNameAlias *>::iterator iter, end;
495 SourceMM::CNameAlias *p;
497 iter = g_PluginMngr._alias_begin();
498 end = g_PluginMngr._alias_end();
502 CONMSG("%-10.9s %s\n", "Alias", "File");
504 for (; iter!=end; iter++)
507 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
511 CONMSG("%d aliases total.\n", total);
513 CONMSG("No aliases found.\n");
517 } else if (strcmp(command, "unload") == 0) {
520 const char *file = e->Cmd_Argv(2);
524 if (id == 0 && isalpha(file[0]))
527 const char *alias = g_PluginMngr.LookupAlias(file);
534 /* first check if it's a known filename */
535 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
537 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s", file);
539 const char *ext = UTIL_GetExtension(file);
540 #if defined WIN32 || defined _WIN32
541 ext = ext ? "" : ".dll";
543 ext = ext ? "" : "_i486.so";
545 g_SmmAPI.PathFormat(full_path, sizeof(full_path), "%s/%s%s", g_ModPath.c_str(), file, ext);
548 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator iter, end;
549 SourceMM::CPluginManager::CPlugin *pl;
550 iter = g_PluginMngr._begin();
551 end = g_PluginMngr._end();
552 for (; iter!=end; iter++)
555 if (strcmp(pl->m_File.c_str(), full_path) == 0)
563 CONMSG("Plugin \"%s\" not found.\n", full_path);
568 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
570 CONMSG("Unload failed: %s\n", error);
574 CONMSG("Plugin %d unloaded.\n", id);
576 CONMSG("Usage: meta unload <id>\n");
579 } else if (strcmp(command, "force_unload") == 0) {
582 int id = atoi(e->Cmd_Argv(2));
585 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)))
587 CONMSG("Force unload failed: %s\n", error);
591 CONMSG("Plugin %d force unloaded.\n", id);
595 CONMSG("Usage: meta force_unload <id>\n");
599 } else if (strcmp(command, "clear") == 0) {
600 if (!g_PluginMngr.UnloadAll())
602 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
606 CONMSG("All plugins unloaded.\n");
609 } else if (strcmp(command, "retry") == 0) {
612 int id = atoi(e->Cmd_Argv(2));
615 if (!g_PluginMngr.Retry(id, error, sizeof(error)))
617 CONMSG("Error reloading plugin: %s\n", error);
621 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");
652 void ClientCommand_handler(edict_t *client)
654 IVEngineServer *e = g_Engine.engine;
655 const char *cmd = e->Cmd_Argv(0);
657 if (strcmp(cmd, "meta") == 0)
659 int args = e->Cmd_Argc();
662 const char *subcmd = e->Cmd_Argv(1);
664 if (strcmp(subcmd, "credits") == 0)
666 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
667 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
668 CLIENT_CONMSG(client, " Core: David \"BAILOPAN\" Anderson\n");
669 CLIENT_CONMSG(client, " Core: Scott \"Damaged Soul\" Ehlert\n");
670 CLIENT_CONMSG(client, "For more information, see the official website\n");
671 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
673 RETURN_META(MRES_SUPERCEDE);
674 } else if(strcmp(subcmd, "version") == 0) {
675 CLIENT_CONMSG(client, "Metamod:Source version %s\n", MMS_FULL_VERSION);
676 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
677 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
678 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
679 CLIENT_CONMSG(client, "http://www.metamodsource.net/\n");
681 RETURN_META(MRES_SUPERCEDE);
682 } else if(strcmp(subcmd, "list") == 0) {
683 SourceMM::CPluginManager::CPlugin *pl;
691 for (i = g_PluginMngr._begin(); i != g_PluginMngr._end(); i++, len=0)
694 if (pl && pl->m_Status == Pl_Running)
697 if (!plapi || !plapi->QueryRunning(NULL, 0))
703 len += UTIL_Format(buffer, sizeof(buffer), " [%02d]", plnum);
705 plname = IS_STR_FILLED(plapi->GetName()) ? plapi->GetName() : pl->m_File.c_str();
706 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " %s", plname);
708 if (IS_STR_FILLED(plapi->GetVersion()))
710 len += UTIL_Format(&buffer[len], sizeof(buffer)-len, " (%s)", plapi->GetVersion());
712 if (IS_STR_FILLED(plapi->GetAuthor()))
714 UTIL_Format(&buffer[len], sizeof(buffer)-len, " by %s", plapi->GetAuthor());
717 CLIENT_CONMSG(client, "%s\n", buffer);
723 CLIENT_CONMSG(client, "No active plugins loaded.\n");
726 RETURN_META(MRES_SUPERCEDE);
730 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
731 CLIENT_CONMSG(client, "usage: meta <command>\n");
732 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
733 CLIENT_CONMSG(client, " list - List plugins\n");
734 CLIENT_CONMSG(client, " version - Version information\n");
736 RETURN_META(MRES_SUPERCEDE);
739 RETURN_META(MRES_IGNORED);
742 void SMConVarAccessor::UnloadMetamodCommands()
744 Unregister(&metamod_version);
745 Unregister(&mm_pluginsfile);
746 Unregister(&mm_basedir);
747 Unregister(&meta_command);
750 const char *GetPluginsFile()
752 return mm_pluginsfile.GetString();
755 const char *GetMetamodBaseDir()
757 return mm_basedir.GetString();
760 /* Signature for ICvar::GetCommands() in vstdlib for Win32 and Linux.
762 * 20226EE0 A1 50 5C 5A 20 mov eax,dword ptr ds:[205A5C50h] <-- What we want
765 #define CMDLIST_SIG "\xA1\x2A\x2A\x2A\x2A\xC3"
766 #define CMDLIST_SIGLEN 6
768 /* Linux symbol name of ConCommandBase list in vstdlib */
769 #define CMDLIST_SYMBOL "_ZN14ConCommandBase18s_pConCommandBasesE"
771 /* This function retrieves the address of the var that holds the top of the ConCommandBase list.
772 * Having this allows us to change the beginning of this list with ease.
774 * This craziness eliminates the need for the eternal command/cvar used previously which
775 * could have caused a crash as a result of registering commands/cvars more than once.
777 bool SMConVarAccessor::InitConCommandBaseList()
779 char *vfunc = UTIL_GetOrigFunction(&ICvar::GetCommands, g_Engine.icvar, g_CvarPatch);
787 if (UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
789 /* Skip past 0xA1 and get addr of ConCommandBase list var */
790 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);
793 #elif defined OS_LINUX
794 /* Try dlsym first */
795 char path[PATH_SIZE];
796 if (GetFileOfAddress((void *)g_Engine.icvar, path, sizeof(path)))
798 void *handle = dlopen(path, RTLD_NOW);
801 m_TopConCommandBase = reinterpret_cast<ConCommandBase **>(dlsym(handle, CMDLIST_SYMBOL));
807 /* If dlsym failed, then verify signature of function */
808 if (!m_TopConCommandBase && UTIL_VerifySignature(vfunc, CMDLIST_SIG, CMDLIST_SIGLEN))
810 /* Skip past 0xA1 and get addr of ConCommandBase list var */
811 m_TopConCommandBase = *reinterpret_cast<ConCommandBase ***>(vfunc + 1);