1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): David "BAILOPAN" Anderson
8 * ============================
13 #include "concommands.h"
15 #include "sh_string.h"
19 * @brief Console Command Implementations
20 * @file concommands.cpp
23 CAlwaysRegisterableCommand g_EternalCommand;
24 SMConVarAccessor g_SMConVarAccessor;
26 bool SMConVarAccessor::RegisterConCommandBase(ConCommandBase *pCommand)
28 // Add the FCVAR_GAMEDLL flag
29 // => No crash on exit!
30 // UPDATE: Do _not_ add the FCVAR_GAMEDLL flag here, as it
31 // causes the command to be unusable on listenservers until you load a map
32 // We will set the FCVAR_GAMEDLL flag on all commands we have registered once we are being unloaded
33 //pCommand->AddFlags(FCVAR_GAMEDLL);
34 m_RegisteredCommands.push_back(pCommand);
36 pCommand->SetNext( NULL );
37 g_Engine.icvar->RegisterConCommandBase(pCommand);
42 bool SMConVarAccessor::Register(ConCommandBase *pCommand)
44 //simple, don't mark as part of sourcemm!
45 pCommand->SetNext( NULL );
46 g_Engine.icvar->RegisterConCommandBase(pCommand);
51 void SMConVarAccessor::MarkCommandsAsGameDLL()
53 for (SourceHook::List<ConCommandBase*>::iterator iter = m_RegisteredCommands.begin();
54 iter != m_RegisteredCommands.end(); ++iter)
56 (*iter)->AddFlags(FCVAR_GAMEDLL);
60 void SMConVarAccessor::Unregister(ConCommandBase *pCommand)
62 ICvar *cv = g_Engine.icvar;
63 ConCommandBase *ptr = cv->GetCommands();
68 g_EternalCommand.BringToFront();
69 g_EternalCommand.SetNext(const_cast<ConCommandBase *>(pCommand->GetNext()));
71 //find us and unregister us
72 ConCommandBase *pPrev = NULL;
78 ptr = const_cast<ConCommandBase *>(ptr->GetNext());
80 if (pPrev && ptr == pCommand)
82 pPrev->SetNext(const_cast<ConCommandBase *>(pCommand->GetNext()));
87 void SMConVarAccessor::UnregisterGameDLLCommands()
89 ConCommandBase *begin = g_Engine.icvar->GetCommands();
90 ConCommandBase *iter = begin;
91 ConCommandBase *prev = NULL;
94 // watch out for the ETERNAL COMMAND!
95 if (iter != &g_EternalCommand && iter->IsBitSet(FCVAR_GAMEDLL))
100 g_EternalCommand.BringToFront();
101 iter = const_cast<ConCommandBase*>(iter->GetNext());
102 g_EternalCommand.SetNext(iter);
103 prev = &g_EternalCommand;
108 iter = const_cast<ConCommandBase*>(iter->GetNext());
114 iter = const_cast<ConCommandBase*>(iter->GetNext());
118 ConVar metamod_version("metamod_version", SOURCEMM_VERSION, FCVAR_REPLICATED | FCVAR_SPONLY | FCVAR_NOTIFY, "Metamod:Source Version");
119 #if defined WIN32 || defined _WIN32
120 ConVar mm_pluginsfile("mm_pluginsfile", "addons\\metamod\\metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
122 ConVar mm_pluginsfile("mm_pluginsfile", "addons/metamod/metaplugins.ini", FCVAR_SPONLY, "Metamod:Source Plugins File");
125 CON_COMMAND(meta, "Metamod:Source Menu")
127 IVEngineServer *e = g_Engine.engine;
129 int args = e->Cmd_Argc();
133 const char *command = e->Cmd_Argv(1);
134 if (strcmp(command, "credits") == 0)
136 CONMSG("Metamod:Source was developed by:\n");
137 CONMSG(" SourceHook: Pavol \"PM OnoTo\" Marko\n");
138 CONMSG(" GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
139 CONMSG(" GameDLL: Scott \"Damaged Soul\" Ehlert\n");
140 CONMSG("For more information, see the official website\n");
141 CONMSG("http://www.sourcemm.net/\n");
144 } else if (strcmp(command, "version") == 0) {
145 CONMSG("Metamod:Source version %s\n", SOURCEMM_VERSION);
146 CONMSG("Compiled on: %s\n", SOURCEMM_DATE);
147 CONMSG("Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
148 CONMSG("SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
149 CONMSG("http://www.sourcemm.net/\n");
152 } else if (strcmp(command, "game") == 0) {
153 CONMSG("GameDLL Information\n");
154 CONMSG(" Description: %s\n", g_GameDll.pGameDLL->GetGameDescription());
155 CONMSG(" Mod Path: %s\n", g_ModPath.c_str());
156 CONMSG(" DLL Path: %s\n", g_BinPath.c_str());
157 CONMSG(" Interface: ServerGameDLL%03d\n", g_GameDllVersion);
160 } else if (strcmp(command, "refresh") == 0) {
162 g_SmmAPI.PathFormat(full_path, sizeof(full_path) - 1, "%s/%s", g_ModPath.c_str(), GetPluginsFile());
164 LoadPluginsFromFile(full_path);
167 } else if (strcmp(command, "list") == 0) {
168 SourceMM::CPluginManager::CPlugin *pl;
170 const char *status="";
171 const char *version=NULL;
172 const char *name=NULL;
173 const char *author=NULL;
175 CONMSG("-Id- %-20.19s %-10.9s %-16.15s %-8.7s\n", "Name", "Version", "Author", "Status");
176 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
181 if (pl->m_Status == Pl_Paused)
184 } else if (pl->m_Status == Pl_Running) {
185 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
189 } else if (pl->m_Status == Pl_Refused) {
191 } else if (pl->m_Status == Pl_Error) {
193 } else if (pl->m_Status == Pl_NotFound) {
199 version = pl->m_API->GetVersion();
200 author = pl->m_API->GetAuthor();
201 name = pl->m_API->GetName();
213 name = pl->m_File.c_str();
216 CONMSG("[%02d] %-20.19s %-10.9s %-16.15s %-8.7s\n", pl->m_Id, name, version, author, status);
222 } else if (strcmp(command, "cmds") == 0) {
225 int id = atoi(e->Cmd_Argv(2));
226 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
230 CONMSG("Plugin %d not found.\n", id);
236 CONMSG("Plugin %d is not loaded.\n", id);
238 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
239 SourceHook::List<ConCommandBase *>::iterator ci;
242 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
245 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
249 CONMSG("Usage: meta cmds <id>\n");
253 } else if (strcmp(command, "cvars") == 0) {
256 int id = atoi(e->Cmd_Argv(2));
257 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
261 CONMSG("Plugin %d not found.\n", id);
267 CONMSG("Plugin %d is not loaded.\n", id);
269 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
270 SourceHook::List<ConCommandBase *>::iterator ci;
273 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
276 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
280 CONMSG("Usage: meta cvars <id>\n");
284 } else if (strcmp(command, "info") == 0) {
287 int id = atoi(e->Cmd_Argv(2));
288 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
291 CONMSG("Plugin %d not found.\n", id);
297 CONMSG("Plugin %d is not loaded.\n", id);
299 if (pl->m_Status == Pl_Paused)
301 CONMSG("Plugin %d is paused.\n", id);
302 } else if (pl->m_Status == Pl_Running) {
305 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
309 CONMSG("Plugin %d is running.\n", id);
311 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
314 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
315 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
316 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
317 CONMSG(" License: %s\n", pl->m_API->GetLicense());
318 CONMSG(" URL: %s\n", pl->m_API->GetURL());
319 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
321 CONMSG("File: %s\n\n", pl->m_File.c_str());
325 CONMSG("Usage: meta info <id>\n");
329 } else if (strcmp(command, "pause") == 0) {
332 int id = atoi(e->Cmd_Argv(2));
336 if (!g_PluginMngr.Pause(id, error, sizeof(error)-1))
338 CONMSG("Pause failed: %s\n", error);
342 CONMSG("Plugin %d has been paused.\n", id);
346 CONMSG("Usage: meta pause <id>\n");
350 } else if (strcmp(command, "unpause") == 0) {
353 int id = atoi(e->Cmd_Argv(2));
356 if (!g_PluginMngr.Unpause(id, error, sizeof(error)-1))
358 CONMSG("Unpause failed: %s\n", error);
362 CONMSG("Plugin %d has been unpaused.\n", id);
366 CONMSG("Usage: meta unpause <id>\n");
370 } else if (strcmp(command, "load") == 0) {
373 const char *file = e->Cmd_Argv(2);
376 const char *alias = g_PluginMngr.LookupAlias(file);
382 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
384 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s", file);
385 snprintf(full_path, sizeof(full_path)-1, "%s", file);
387 const char *ext = UTIL_GetExtension(file);
388 #if defined WIN32 || defined _WIN32
389 ext = ext ? "" : ".dll";
391 ext = ext ? "" : "_i486.so";
393 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
398 SourceMM::CPluginManager::CPlugin *pl;
400 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error)-1);
401 pl = g_PluginMngr.FindById(id);
402 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
404 CONMSG("Failed to load plugin %s (%s).\n", file, error);
410 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
412 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
417 CONMSG("Usage: meta load <path>\n");
421 } else if ( (strcmp(command, "alias") == 0) ||
422 (strcmp(command, "aliases") == 0) ) {
425 const char *alias = e->Cmd_Argv(2);
426 const char *value = e->Cmd_Argv(3);
428 g_PluginMngr.SetAlias(alias, value);
429 if (value[0] == '\0')
431 CONMSG("Deleted alias: %s.\n", alias);
433 CONMSG("Set alias \"%s\" to: %s\n", alias, value);
435 } else if (args >= 3) {
436 const char *alias = e->Cmd_Argv(2);
437 const char *value = g_PluginMngr.LookupAlias(alias);
440 CONMSG("Alias \"%s\" is set to: %s\n", alias, value);
442 CONMSG("Alias \"%s\" was not found.\n", alias);
445 SourceHook::List<SourceMM::CNameAlias *>::iterator iter, end;
446 SourceMM::CNameAlias *p;
448 iter = g_PluginMngr._alias_begin();
449 end = g_PluginMngr._alias_end();
453 CONMSG("%-10.9s %s\n", "Alias", "File");
455 for (; iter!=end; iter++)
458 CONMSG("%-10.9s %s\n", p->alias.c_str(), p->value.c_str());
462 CONMSG("%d aliases total.\n", total);
464 CONMSG("No aliases found.\n");
468 } else if (strcmp(command, "unload") == 0) {
471 const char *file = e->Cmd_Argv(2);
475 if (id == 0 && isalpha(file[0]))
478 const char *alias = g_PluginMngr.LookupAlias(file);
485 /* first check if it's a known filename */
486 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
488 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s", file);
489 snprintf(full_path, sizeof(full_path)-1, "%s", file);
491 const char *ext = UTIL_GetExtension(file);
492 #if defined WIN32 || defined _WIN32
493 ext = ext ? "" : ".dll";
495 ext = ext ? "" : "_i486.so";
497 g_SmmAPI.PathFormat(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
500 SourceHook::List<SourceMM::CPluginManager::CPlugin *>::iterator iter, end;
501 SourceMM::CPluginManager::CPlugin *pl;
502 iter = g_PluginMngr._begin();
503 end = g_PluginMngr._end();
504 for (; iter!=end; iter++)
507 if (strcmp(pl->m_File.c_str(), full_path) == 0)
515 CONMSG("Plugin \"%s\" not found.\n", full_path);
520 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
522 CONMSG("Unload failed: %s\n", error);
526 CONMSG("Plugin %d unloaded.\n", id);
528 CONMSG("Usage: meta unload <id>\n");
531 } else if (strcmp(command, "force_unload") == 0) {
534 int id = atoi(e->Cmd_Argv(2));
537 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
539 CONMSG("Force unload failed: %s\n", error);
543 CONMSG("Plugin %d force unloaded.\n", id);
547 CONMSG("Usage: meta force_unload <id>\n");
551 } else if (strcmp(command, "clear") == 0) {
552 if (!g_PluginMngr.UnloadAll())
554 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
558 CONMSG("All plugins unloaded.\n");
561 } else if (strcmp(command, "retry") == 0) {
564 int id = atoi(e->Cmd_Argv(2));
567 if (!g_PluginMngr.Retry(id, error, sizeof(error)-1))
569 CONMSG("Error reloading plugin: %s\n", error);
573 CONMSG("Plugin %d successfully reloaded.\n", id);
577 CONMSG("Usage: meta retry <id>\n");
584 CONMSG("Metamod:Source Menu\n");
585 CONMSG("usage: meta <command> [arguments]\n");
586 CONMSG(" alias - List or set an alias\n");
587 CONMSG(" clear - Unload all plugins forcefully\n");
588 CONMSG(" cmds - Show plugin commands\n");
589 CONMSG(" cvars - Show plugin cvars\n");
590 CONMSG(" credits - About Metamod:Source\n");
591 CONMSG(" force_unload - Forcefully unload a plugin\n");
592 CONMSG(" game - Information about GameDLL\n");
593 CONMSG(" info - Information about a plugin\n");
594 CONMSG(" list - List plugins\n");
595 CONMSG(" load - Load a plugin\n");
596 CONMSG(" pause - Pause a running plugin\n");
597 CONMSG(" refresh - Reparse plugins file\n");
598 CONMSG(" retry - Attempt to reload a plugin\n");
599 CONMSG(" unload - Unload a loaded plugin\n");
600 CONMSG(" unpause - Unpause a paused plugin\n");
601 CONMSG(" version - Version information\n");
604 CAlwaysRegisterableCommand::CAlwaysRegisterableCommand()
606 Create("", NULL, FCVAR_UNREGISTERED|FCVAR_GAMEDLL);
610 bool CAlwaysRegisterableCommand::IsRegistered( void ) const
615 void CAlwaysRegisterableCommand::BringToFront()
618 m_pICvar = g_Engine.icvar;
620 // First, let's try to find us!
621 ConCommandBase *pPtr = m_pICvar->GetCommands();
625 // We are already at the beginning; Nothing to do
631 if (pPtr == this && pPtr->IsCommand() && stricmp(GetName(), pPtr->GetName()) == 0)
633 ConCommandBase *pPrev = NULL;
639 pPtr = const_cast<ConCommandBase*>(pPtr->GetNext());
641 if (pPrev && pPtr == this)
643 pPrev->SetNext(m_pNext); // Remove us from the list
647 m_pICvar->RegisterConCommandBase(this);
651 void ClientCommand_handler(edict_t *client)
653 IVEngineServer *e = g_Engine.engine;
654 const char *cmd = e->Cmd_Argv(0);
656 if (strcmp(cmd, "meta") == 0)
658 int args = e->Cmd_Argc();
661 const char *subcmd = e->Cmd_Argv(1);
663 if (strcmp(subcmd, "credits") == 0)
665 CLIENT_CONMSG(client, "Metamod:Source was developed by:\n");
666 CLIENT_CONMSG(client, " SourceHook: Pavol \"PM OnoTo\" Marko\n");
667 CLIENT_CONMSG(client, " GameDLL/Plugins: David \"BAILOPAN\" Anderson\n");
668 CLIENT_CONMSG(client, " GameDLL: Scott \"Damaged Soul\" Ehlert\n");
669 CLIENT_CONMSG(client, "For more information, see the official website\n");
670 CLIENT_CONMSG(client, "http://www.sourcemm.net/\n");
672 else if(strcmp(subcmd, "version") == 0)
674 CLIENT_CONMSG(client, "Metamod:Source version %s\n", SOURCEMM_VERSION);
675 CLIENT_CONMSG(client, "Compiled on: %s\n", SOURCEMM_DATE);
676 CLIENT_CONMSG(client, "Plugin interface version: %d:%d\n", PLAPI_VERSION, PLAPI_MIN_VERSION);
677 CLIENT_CONMSG(client, "SourceHook version: %d:%d\n", g_SourceHook.GetIfaceVersion(), g_SourceHook.GetImplVersion());
678 CLIENT_CONMSG(client, "http://www.sourcemm.net/\n");
680 else if(strcmp(subcmd, "list") == 0)
682 SourceMM::CPluginManager::CPlugin *pl;
684 const char *version=NULL;
685 const char *name=NULL;
686 const char *author=NULL;
688 CLIENT_CONMSG(client, "-Id- %-20.19s %-10.9s %-16.15s\n", "Name", "Version", "Author");
690 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
696 // Should paused plugins really show up in the list too?
697 if (pl->m_API && (pl->m_Status == Pl_Running || pl->m_Status == Pl_Paused))
699 version = pl->m_API->GetVersion();
700 author = pl->m_API->GetAuthor();
701 name = pl->m_API->GetName();
703 if (!version || !author || !name)
706 CLIENT_CONMSG(client, "[%02d] %-20.19s %-10.9s %-16.15s\n", pl->m_Id, name, version, author);
713 CLIENT_CONMSG(client, "Metamod:Source Menu\n");
714 CLIENT_CONMSG(client, "usage: meta <command>\n");
715 CLIENT_CONMSG(client, " credits - About Metamod:Source\n");
716 CLIENT_CONMSG(client, " list - List plugins\n");
717 CLIENT_CONMSG(client, " version - Version information\n");
720 RETURN_META(MRES_SUPERCEDE);
723 RETURN_META(MRES_IGNORED);
726 const char *GetPluginsFile()
728 return mm_pluginsfile.GetString();