1 /* ======== SourceMM ========
2 * Copyright (C) 2004-2005 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(" Mod path: %s\n", g_ModPath.c_str());
155 CONMSG(" Dll path: %s\n", g_BinPath.c_str());
158 } else if (strcmp(command, "refresh") == 0) {
160 #if defined WIN32 || defined _WIN32
161 snprintf(full_path, sizeof(full_path)-1, "%s\\addons\\metamod\\%s", g_ModPath.c_str(), "metaplugins.ini");
163 snprintf(full_path, sizeof(full_path)-1, "%s/addons/metamod/%s", g_ModPath.c_str(), "metaplugins.ini");
165 LoadPluginsFromFile(full_path);
168 } else if (strcmp(command, "list") == 0) {
169 SourceMM::CPluginManager::CPlugin *pl;
171 const char *status="";
172 const char *version=NULL;
173 const char *name=NULL;
174 const char *author=NULL;
176 CONMSG("-Id- %-16.15s %-8.7s %-12.11s %-8.7s\n", "Name", "Version", "Author", "Status");
177 for (i=g_PluginMngr._begin(); i!=g_PluginMngr._end(); i++)
182 if (pl->m_Status == Pl_Paused)
185 } else if (pl->m_Status == Pl_Running) {
186 if (pl->m_API && pl->m_API->QueryRunning(NULL, 0))
190 } else if (pl->m_Status == Pl_Refused) {
192 } else if (pl->m_Status == Pl_Error) {
194 } else if (pl->m_Status == Pl_NotFound) {
200 version = pl->m_API->GetVersion();
201 author = pl->m_API->GetAuthor();
202 name = pl->m_API->GetName();
214 name = pl->m_File.c_str();
217 CONMSG("[%02d] %-16.15s %-8.7s %-12.11s %-8.7s\n", pl->m_Id, name, version, author, status);
223 } else if (strcmp(command, "cmds") == 0) {
226 int id = atoi(e->Cmd_Argv(2));
227 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
231 CONMSG("Plugin %d not found.\n", id);
237 CONMSG("Plugin %d is not loaded.\n", id);
239 CONMSG("Console commands for %s:\n", pl->m_API->GetName());
240 SourceHook::List<ConCommandBase *>::iterator ci;
243 for (ci=pl->m_Cmds.begin(); ci!=pl->m_Cmds.end(); ci++)
246 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
250 CONMSG("Usage: meta cmds <id>\n");
254 } else if (strcmp(command, "cvars") == 0) {
257 int id = atoi(e->Cmd_Argv(2));
258 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
262 CONMSG("Plugin %d not found.\n", id);
268 CONMSG("Plugin %d is not loaded.\n", id);
270 CONMSG("Registered cvars for %s:\n", pl->m_API->GetName());
271 SourceHook::List<ConCommandBase *>::iterator ci;
274 for (ci=pl->m_Cvars.begin(); ci!=pl->m_Cvars.end(); ci++)
277 CONMSG(" [%5d] %-s\n", count, (*ci)->GetName());
281 CONMSG("Usage: meta cvars <id>\n");
285 } else if (strcmp(command, "info") == 0) {
288 int id = atoi(e->Cmd_Argv(2));
289 SourceMM::CPluginManager::CPlugin *pl = g_PluginMngr.FindById(id);
292 CONMSG("Plugin %d not found.\n", id);
298 CONMSG("Plugin %d is not loaded.\n", id);
300 if (pl->m_Status == Pl_Paused)
302 CONMSG("Plugin %d is paused.\n", id);
303 } else if (pl->m_Status == Pl_Running) {
306 if (pl->m_API && pl->m_API->QueryRunning(run_msg, sizeof(run_msg)-1))
310 CONMSG("Plugin %d is running.\n", id);
312 CONMSG("Plugin %d is stopped: %s\n", id, run_msg);
315 CONMSG(" Name: \"%s\" by %s\n", pl->m_API->GetName(), pl->m_API->GetAuthor());
316 CONMSG(" Version: %s\n", pl->m_API->GetVersion());
317 CONMSG(" Description: %s\n", pl->m_API->GetDescription());
318 CONMSG(" License: %s\n", pl->m_API->GetLicense());
319 CONMSG(" URL: %s\n", pl->m_API->GetURL());
320 CONMSG(" Details: API %03d, Date: %s\n", pl->m_API->GetApiVersion(), pl->m_API->GetDate());
322 CONMSG("File: %s\n\n", pl->m_File.c_str());
326 CONMSG("Usage: meta info <id>\n");
330 } else if (strcmp(command, "pause") == 0) {
333 int id = atoi(e->Cmd_Argv(2));
337 if (!g_PluginMngr.Pause(id, error, sizeof(error)-1))
339 CONMSG("Pause failed: %s\n", error);
343 CONMSG("Plugin %d has been paused.\n", id);
347 CONMSG("Usage: meta pause <id>\n");
351 } else if (strcmp(command, "unpause") == 0) {
354 int id = atoi(e->Cmd_Argv(2));
357 if (!g_PluginMngr.Unpause(id, error, sizeof(error)-1))
359 CONMSG("Unpause failed: %s\n", error);
363 CONMSG("Plugin %d has been unpaused.\n", id);
367 CONMSG("Usage: meta unpause <id>\n");
371 } else if (strcmp(command, "load") == 0) {
374 const char *file = e->Cmd_Argv(2);
377 if (file[0] == '/' || strcmp(&(file[1]), ":\\") == 0)
379 snprintf(full_path, sizeof(full_path)-1, "%s", file);
381 const char *ext = UTIL_GetExtension(file);
382 #if defined WIN32 || defined _WIN32
383 ext = ext ? "" : ".dll";
384 snprintf(full_path, sizeof(full_path)-1, "%s\\%s%s", g_ModPath.c_str(), file, ext);
386 ext = ext ? "" : "_i486.so";
387 snprintf(full_path, sizeof(full_path)-1, "%s/%s%s", g_ModPath.c_str(), file, ext);
393 SourceMM::CPluginManager::CPlugin *pl;
395 PluginId id = g_PluginMngr.Load(full_path, Pl_Console, already, error, sizeof(error)-1);
396 pl = g_PluginMngr.FindById(id);
397 if (!pl || id < Pl_MinId || (pl->m_Status < Pl_Paused))
399 CONMSG("Failed to load plugin %s (%s).\n", file, error);
405 CONMSG("Plugin \"%s\" loaded with id %d.\n", pl->m_API->GetName(), pl->m_Id);
407 CONMSG("Plugin \"%s\" is already loaded as %d.\n", pl->m_API->GetName(), pl->m_Id);
412 CONMSG("Usage: meta load <path>\n");
416 } else if (strcmp(command, "unload") == 0) {
419 int id = atoi(e->Cmd_Argv(2));
422 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
424 CONMSG("Unload failed: %s\n", error);
428 CONMSG("Plugin %d unloaded.\n", id);
432 CONMSG("Usage: meta unload <id>\n");
436 } else if (strcmp(command, "force_unload") == 0) {
439 int id = atoi(e->Cmd_Argv(2));
442 if (!g_PluginMngr.Unload(id, false, error, sizeof(error)-1))
444 CONMSG("Force unload failed: %s\n", error);
448 CONMSG("Plugin %d force unloaded.\n", id);
452 CONMSG("Usage: meta force_unload <id>\n");
456 } else if (strcmp(command, "clear") == 0) {
457 if (!g_PluginMngr.UnloadAll())
459 CONMSG("One or more plugins resisted removal (cleaned anyway).\n");
463 CONMSG("All plugins unloaded.\n");
466 } else if (strcmp(command, "retry") == 0) {
469 int id = atoi(e->Cmd_Argv(2));
472 if (!g_PluginMngr.Retry(id, error, sizeof(error)-1))
474 CONMSG("Error reloading plugin: %s\n", error);
478 CONMSG("Plugin %d successfully reloaded.\n", id);
482 CONMSG("Usage: meta retry <id>\n");
489 CONMSG("Metamod:Source Menu\n");
490 CONMSG("usage: meta <command> [arguments]\n");
491 CONMSG(" clear - Unload all plugins forcefully\n");
492 CONMSG(" cmds - Show plugin commands\n");
493 CONMSG(" cvars - Show plugin cvars\n");
494 CONMSG(" credits - About Metamod:Source\n");
495 CONMSG(" force_unload - Forcefully unload a plugin\n");
496 CONMSG(" game - Information about GameDLL\n");
497 CONMSG(" info - Information about a plugin\n");
498 CONMSG(" list - List plugins\n");
499 CONMSG(" load - Load a plugin\n");
500 CONMSG(" pause - Pause a running plugin\n");
501 CONMSG(" refresh - Reparse plugins file\n");
502 CONMSG(" retry - Attempt to reload a plugin\n");
503 CONMSG(" unload - Unload a loaded plugin\n");
504 CONMSG(" unpause - Unpause a paused plugin\n");
505 CONMSG(" version - Version information\n");
508 CAlwaysRegisterableCommand::CAlwaysRegisterableCommand()
510 Create("", NULL, FCVAR_UNREGISTERED|FCVAR_GAMEDLL);
514 bool CAlwaysRegisterableCommand::IsRegistered( void ) const
519 void CAlwaysRegisterableCommand::BringToFront()
522 m_pICvar = g_Engine.icvar;
524 // First, let's try to find us!
525 ConCommandBase *pPtr = m_pICvar->GetCommands();
529 // We are already at the beginning; Nothing to do
535 if (pPtr == this && pPtr->IsCommand() && stricmp(GetName(), pPtr->GetName()) == 0)
537 ConCommandBase *pPrev = NULL;
543 pPtr = const_cast<ConCommandBase*>(pPtr->GetNext());
545 if (pPrev && pPtr == this)
547 pPrev->SetNext(m_pNext); // Remove us from the list
550 m_pICvar->RegisterConCommandBase(this);
554 const char *GetPluginsFile()
556 return mm_pluginsfile.GetString();