3 * =============================================================================
5 * Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
6 * =============================================================================
8 * This program is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU General Public License, version 3.0, as published by the
10 * Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License along with
18 * this program. If not, see <http://www.gnu.org/licenses/>.
20 * As a special exception, AlliedModders LLC gives you permission to link the
21 * code of this program (as well as its derivative works) to "Half-Life 2," the
22 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
23 * by the Valve Corporation. You must obey the GNU General Public License in
24 * all respects for all other code used. Additionally, AlliedModders LLC grants
25 * this exception to all derivative works. AlliedModders LLC defines further
26 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
27 * or <http://www.sourcemod.net/license.php>.
32 #include "ConCmdManager.h"
33 #include "sm_srvcmds.h"
34 #include "AdminCache.h"
35 #include "sm_stringutil.h"
36 #include "PlayerManager.h"
37 #include "Translator.h"
38 #include "HalfLife2.h"
39 #include "ChatTriggers.h"
41 ConCmdManager g_ConCmds;
43 #if defined ORANGEBOX_BUILD
44 SH_DECL_HOOK1_void(ConCommand, Dispatch, SH_NOATTRIB, false, const CCommand &);
46 SH_DECL_HOOK0_void(ConCommand, Dispatch, SH_NOATTRIB, false);
49 SH_DECL_HOOK1_void(IServerGameClients, SetCommandClient, SH_NOATTRIB, false, int);
57 typedef List<PlCmdInfo> CmdList;
59 void AddToPlCmdList(CmdList *pList, const PlCmdInfo &info);
61 ConCmdManager::ConCmdManager() : m_Strings(1024)
63 m_pCmds = sm_trie_create();
64 m_pCmdGrps = sm_trie_create();
68 ConCmdManager::~ConCmdManager()
70 sm_trie_destroy(m_pCmds);
71 sm_trie_destroy(m_pCmdGrps);
74 void ConCmdManager::OnSourceModAllInitialized()
76 g_PluginSys.AddPluginsListener(this);
77 g_RootMenu.AddRootConsoleCommand("cmds", "List console commands", this);
78 SH_ADD_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, serverClients, this, &ConCmdManager::SetCommandClient, false);
81 void ConCmdManager::OnSourceModShutdown()
83 /* All commands should already be removed by the time we're done */
84 SH_REMOVE_HOOK_MEMFUNC(IServerGameClients, SetCommandClient, serverClients, this, &ConCmdManager::SetCommandClient, false);
85 g_RootMenu.RemoveRootConsoleCommand("cmds", this);
88 void ConCmdManager::OnUnlinkConCommandBase(ConCommandBase *pBase, const char *name, bool is_read_safe)
90 /* Whoa, first get its information struct */
93 if (!sm_trie_retrieve(m_pCmds, name, (void **)&pInfo))
98 RemoveConCmds(pInfo->srvhooks);
99 RemoveConCmds(pInfo->conhooks);
101 RemoveConCmd(pInfo, name, is_read_safe, false);
104 void ConCmdManager::RemoveConCmds(List<CmdHook *> &cmdlist)
106 List<CmdHook *>::iterator iter = cmdlist.begin();
108 while (iter != cmdlist.end())
110 CmdHook *pHook = (*iter);
111 IPluginContext *pContext = pHook->pf->GetParentContext();
112 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pContext->GetContext());
113 CmdList *pList = NULL;
116 if (!pPlugin->GetProperty("CommandList", (void **)&pList, false) || !pList)
121 CmdList::iterator p_iter = pList->begin();
122 while (p_iter != pList->end())
124 PlCmdInfo &cmd = (*p_iter);
125 if (cmd.pHook == pHook)
127 p_iter = pList->erase(p_iter);
135 delete pHook->pAdmin;
138 iter = cmdlist.erase(iter);
142 void ConCmdManager::RemoveConCmds(List<CmdHook *> &cmdlist, IPluginContext *pContext)
144 List<CmdHook *>::iterator iter = cmdlist.begin();
147 while (iter != cmdlist.end())
150 if (pHook->pf->GetParentContext() == pContext)
152 delete pHook->pAdmin;
154 iter = cmdlist.erase(iter);
163 void ConCmdManager::OnPluginDestroyed(IPlugin *plugin)
166 List<ConCmdInfo *> removed;
167 if (plugin->GetProperty("CommandList", (void **)&pList, true))
169 IPluginContext *pContext = plugin->GetBaseContext();
170 CmdList::iterator iter;
172 * Only bother if there's an actual command list on this plugin...
174 for (iter=pList->begin();
178 PlCmdInfo &cmd = (*iter);
179 ConCmdInfo *pInfo = cmd.pInfo;
181 /* Has this chain already been fully cleaned/removed? */
182 if (removed.find(pInfo) != removed.end())
187 /* Remove any hooks from us on this command */
188 RemoveConCmds(pInfo->conhooks, pContext);
189 RemoveConCmds(pInfo->srvhooks, pContext);
191 /* See if there are still hooks */
192 if (pInfo->srvhooks.size())
196 if (pInfo->conhooks.size())
201 /* Remove the command, it should be safe now */
202 RemoveConCmd(pInfo, pInfo->pCmd->GetName(), true, true);
203 removed.push_back(pInfo);
208 #if defined ORANGEBOX_BUILD
209 void CommandCallback(const CCommand &command)
212 void CommandCallback()
217 g_HL2.PushCommandStack(&command);
219 g_ConCmds.InternalDispatch(command);
221 g_HL2.PopCommandStack();
224 void ConCmdManager::SetCommandClient(int client)
226 m_CmdClient = client + 1;
229 ResultType ConCmdManager::DispatchClientCommand(int client, const char *cmd, int args, ResultType type)
232 if (sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
234 cell_t result = type;
235 cell_t tempres = result;
236 List<CmdHook *>::iterator iter;
238 for (iter=pInfo->conhooks.begin();
239 iter!=pInfo->conhooks.end();
243 if (!pHook->pf->IsRunnable())
247 if (pHook->pAdmin && !CheckAccess(client, cmd, pHook->pAdmin))
249 if (result < Pl_Handled)
255 pHook->pf->PushCell(client);
256 pHook->pf->PushCell(args);
257 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
259 if (tempres > result)
263 if (result == Pl_Stop)
269 type = (ResultType)result;
275 void ConCmdManager::InternalDispatch(const CCommand &command)
277 int client = m_CmdClient;
281 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
282 if (!pPlayer || !pPlayer->IsConnected())
289 * Note: Console commands will EITHER go through IServerGameDLL::ClientCommand,
290 * OR this dispatch. They will NEVER go through both.
292 * Whether or not it goes through the callback is determined by FCVAR_GAMEDLL
294 const char *cmd = g_HL2.CurrentCommandName();
297 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
302 cell_t result = Pl_Continue;
303 int args = command.ArgC() - 1;
305 List<CmdHook *>::iterator iter;
308 /* Execute server-only commands if viable */
309 if (client == 0 && pInfo->srvhooks.size())
311 cell_t tempres = result;
312 for (iter=pInfo->srvhooks.begin();
313 iter!=pInfo->srvhooks.end();
317 if (!pHook->pf->IsRunnable())
321 pHook->pf->PushCell(args);
322 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
324 if (tempres > result)
328 if (result == Pl_Stop)
335 /* Check if there's an early stop */
336 if (result >= Pl_Stop)
338 if (!pInfo->sourceMod)
340 RETURN_META(MRES_SUPERCEDE);
346 /* Execute console commands */
347 if (pInfo->conhooks.size())
349 cell_t tempres = result;
350 for (iter=pInfo->conhooks.begin();
351 iter!=pInfo->conhooks.end();
355 if (!pHook->pf->IsRunnable())
361 && !CheckAccess(client, cmd, pHook->pAdmin))
363 if (result < Pl_Handled)
370 /* On a listen server, sometimes the server host's client index can be set as 0.
371 * So index 1 is passed to the command callback to correct this potential problem.
373 if (client == 0 && !engine->IsDedicatedServer())
375 pHook->pf->PushCell(1);
377 pHook->pf->PushCell(client);
380 pHook->pf->PushCell(args);
381 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
383 if (tempres > result)
387 if (result == Pl_Stop)
395 if (result >= Pl_Handled)
397 if (!pInfo->sourceMod)
399 RETURN_META(MRES_SUPERCEDE);
405 bool ConCmdManager::CheckCommandAccess(int client, const char *cmd, FlagBits cmdflags)
407 if (cmdflags == 0 || client == 0)
412 /* If running listen server, then client 1 is the server host and should have 'root' access */
413 if (client == 1 && !engine->IsDedicatedServer())
418 CPlayer *player = g_Players.GetPlayerByIndex(client);
420 || player->GetEdict() == NULL
421 || player->IsFakeClient())
426 AdminId adm = player->GetAdminId();
427 if (adm != INVALID_ADMIN_ID)
429 FlagBits bits = g_Admins.GetAdminFlags(adm, Access_Effective);
431 /* root knows all, WHOA */
432 if ((bits & ADMFLAG_ROOT) == ADMFLAG_ROOT)
437 /* Check for overrides
438 * :TODO: is it worth optimizing this?
440 unsigned int groups = g_Admins.GetAdminGroupCount(adm);
443 bool override = false;
444 for (unsigned int i=0; i<groups; i++)
446 gid = g_Admins.GetAdminGroup(adm, i, NULL);
447 /* First get group-level override */
448 override = g_Admins.GetGroupCommandOverride(gid, cmd, Override_CommandGroup, &rule);
449 /* Now get the specific command override */
450 if (g_Admins.GetGroupCommandOverride(gid, cmd, Override_Command, &rule))
456 if (rule == Command_Allow)
459 } else if (rule == Command_Deny) {
465 /* See if our other flags match */
466 if ((bits & cmdflags) == cmdflags)
475 bool ConCmdManager::CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin)
477 if (CheckCommandAccess(client, cmd, pAdmin->eflags))
482 edict_t *pEdict = engine->PEntityOfEntIndex(client);
484 /* If we got here, the command failed... */
486 if (g_Translator.CoreTrans(client, buffer, sizeof(buffer), "No Access", NULL, NULL)
489 snprintf(buffer, sizeof(buffer), "You do not have access to this command");
492 unsigned int replyto = g_ChatTriggers.GetReplyTo();
493 if (replyto == SM_REPLY_CONSOLE)
495 char fullbuffer[192];
496 snprintf(fullbuffer, sizeof(fullbuffer), "[SM] %s.\n", buffer);
497 engine->ClientPrintf(pEdict, fullbuffer);
498 } else if (replyto == SM_REPLY_CHAT) {
499 char fullbuffer[192];
500 snprintf(fullbuffer, sizeof(fullbuffer), "[SM] %s.", buffer);
501 g_HL2.TextMsg(client, HUD_PRINTTALK, fullbuffer);
507 bool ConCmdManager::AddConsoleCommand(IPluginFunction *pFunction,
509 const char *description,
512 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
519 CmdHook *pHook = new CmdHook();
521 pHook->pf = pFunction;
522 if (description && description[0])
524 pHook->helptext.assign(description);
526 pInfo->conhooks.push_back(pHook);
528 /* Add to the plugin */
530 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
531 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
533 pList = new CmdList();
534 pPlugin->SetProperty("CommandList", pList);
538 info.type = Cmd_Console;
540 AddToPlCmdList(pList, info);
545 bool ConCmdManager::AddAdminCommand(IPluginFunction *pFunction,
549 const char *description,
552 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
559 CmdHook *pHook = new CmdHook();
560 AdminCmdInfo *pAdmin = new AdminCmdInfo();
562 pHook->pf = pFunction;
563 if (description && description[0])
565 pHook->helptext.assign(description);
567 pHook->pAdmin = pAdmin;
571 if (!sm_trie_retrieve(m_pCmdGrps, group, (void **)&object))
573 grpid = m_Strings.AddString(group);
574 sm_trie_insert(m_pCmdGrps, group, (void *)grpid);
581 pAdmin->cmdGrpId = grpid;
582 pAdmin->flags = adminflags;
584 /* First get the command group override, if any */
585 bool override = g_Admins.GetCommandOverride(group,
586 Override_CommandGroup,
589 /* Next get the command override, if any */
590 if (g_Admins.GetCommandOverride(name,
597 /* Assign normal flags if there were no overrides */
600 pAdmin->eflags = pAdmin->flags;
603 /* Finally, add the hook */
604 pInfo->conhooks.push_back(pHook);
605 pInfo->admin = *(pHook->pAdmin);
606 pInfo->is_admin_set = true;
608 /* Now add to the plugin */
610 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
611 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
613 pList = new CmdList();
614 pPlugin->SetProperty("CommandList", pList);
618 info.type = Cmd_Admin;
620 AddToPlCmdList(pList, info);
625 bool ConCmdManager::AddServerCommand(IPluginFunction *pFunction,
627 const char *description,
631 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
638 CmdHook *pHook = new CmdHook();
640 pHook->pf = pFunction;
641 if (description && description[0])
643 pHook->helptext.assign(description);
646 pInfo->srvhooks.push_back(pHook);
648 /* Add to the plugin */
650 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
651 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
653 pList = new CmdList();
654 pPlugin->SetProperty("CommandList", pList);
658 info.type = Cmd_Server;
660 AddToPlCmdList(pList, info);
665 void AddToPlCmdList(CmdList *pList, const PlCmdInfo &info)
667 CmdList::iterator iter = pList->begin();
668 bool inserted = false;
669 const char *orig = NULL;
671 orig = info.pInfo->pCmd->GetName();
673 /* Insert this into the help list, SORTED alphabetically. */
674 while (iter != pList->end())
676 PlCmdInfo &obj = (*iter);
677 const char *cmd = obj.pInfo->pCmd->GetName();
678 if (strcmp(orig, cmd) < 0)
680 pList->insert(iter, info);
689 pList->push_back(info);
693 void ConCmdManager::AddToCmdList(ConCmdInfo *info)
695 List<ConCmdInfo *>::iterator iter = m_CmdList.begin();
697 bool inserted = false;
698 const char *orig = NULL;
700 orig = info->pCmd->GetName();
702 /* Insert this into the help list, SORTED alphabetically. */
703 while (iter != m_CmdList.end())
705 const char *cmd = NULL;
707 cmd = pInfo->pCmd->GetName();
708 if (strcmp(orig, cmd) < 0)
710 m_CmdList.insert(iter, info);
719 m_CmdList.push_back(info);
723 void ConCmdManager::UpdateAdminCmdFlags(const char *cmd, OverrideType type, FlagBits bits, bool remove)
727 if (type == Override_Command)
729 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
734 List<CmdHook *>::iterator iter;
737 for (iter=pInfo->conhooks.begin(); iter!=pInfo->conhooks.end(); iter++)
744 pHook->pAdmin->eflags = bits;
746 pHook->pAdmin->eflags = pHook->pAdmin->flags;
748 pInfo->admin = *(pHook->pAdmin);
751 pInfo->is_admin_set = true;
753 else if (type == Override_CommandGroup)
756 if (!sm_trie_retrieve(m_pCmdGrps, cmd, &object))
760 int grpid = (int)object;
762 /* This is bad :( loop through all commands */
763 List<ConCmdInfo *>::iterator iter;
765 for (iter=m_CmdList.begin(); iter!=m_CmdList.end(); iter++)
768 for (List<CmdHook *>::iterator citer=pInfo->conhooks.begin();
769 citer!=pInfo->conhooks.end();
773 if (pHook->pAdmin && pHook->pAdmin->cmdGrpId == grpid)
777 pHook->pAdmin->eflags = bits;
779 pHook->pAdmin->eflags = pHook->pAdmin->flags;
781 pInfo->admin = *(pHook->pAdmin);
785 pInfo->is_admin_set = true;
789 void ConCmdManager::RemoveConCmd(ConCmdInfo *info, const char *name, bool is_read_safe, bool untrack)
791 /* Remove from the trie */
792 sm_trie_delete(m_pCmds, name);
794 /* Remove console-specific information
795 * This should always be true as of right now
801 /* Unlink from SourceMM */
802 g_SMAPI->UnregisterConCommandBase(g_PLAPI, info->pCmd);
803 /* Delete the command's memory */
804 char *new_help = const_cast<char *>(info->pCmd->GetHelpText());
805 char *new_name = const_cast<char *>(info->pCmd->GetName());
814 /* Remove the external hook */
815 SH_REMOVE_HOOK_STATICFUNC(ConCommand, Dispatch, info->pCmd, CommandCallback, false);
819 UntrackConCommandBase(info->pCmd, this);
824 /* Remove from list */
825 m_CmdList.remove(info);
830 bool ConCmdManager::LookForSourceModCommand(const char *cmd)
834 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
839 return pInfo->sourceMod && (pInfo->conhooks.size() > 0);
842 bool ConCmdManager::LookForCommandAdminFlags(const char *cmd, FlagBits *pFlags)
846 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
851 *pFlags = pInfo->admin.eflags;
853 return pInfo->is_admin_set;
856 ConCmdInfo *ConCmdManager::AddOrFindCommand(const char *name, const char *description, int flags)
859 if (!sm_trie_retrieve(m_pCmds, name, (void **)&pInfo))
861 pInfo = new ConCmdInfo();
862 /* Find the commandopan */
863 ConCommandBase *pBase = icvar->GetCommands();
864 ConCommand *pCmd = NULL;
867 if (strcmp(pBase->GetName(), name) == 0)
869 /* Don't want to return convar with same name */
870 if (!pBase->IsCommand())
875 pCmd = (ConCommand *)pBase;
878 pBase = const_cast<ConCommandBase *>(pBase->GetNext());
883 /* Note that we have to duplicate because the source might not be
884 * a static string, and these expect static memory.
890 char *new_name = sm_strdup(name);
891 char *new_help = sm_strdup(description);
892 pCmd = new ConCommand(new_name, CommandCallback, new_help, flags);
893 pInfo->sourceMod = true;
897 TrackConCommandBase(pCmd, this);
898 SH_ADD_HOOK_STATICFUNC(ConCommand, Dispatch, pCmd, CommandCallback, false);
902 pInfo->is_admin_set = false;
904 sm_trie_insert(m_pCmds, name, pInfo);
911 void ConCmdManager::OnRootConsoleCommand(const char *cmdname, const CCommand &command)
913 if (command.ArgC() >= 3)
915 const char *text = command.Arg(2);
917 CPlugin *pPlugin = g_PluginSys.FindPluginByConsoleArg(text);
921 g_RootMenu.ConsolePrint("[SM] Plugin \"%s\" was not found.", text);
925 const sm_plugininfo_t *plinfo = pPlugin->GetPublicInfo();
926 const char *plname = IS_STR_FILLED(plinfo->name) ? plinfo->name : pPlugin->GetFilename();
929 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
931 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
936 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
940 CmdList::iterator iter;
941 const char *type = NULL;
944 g_RootMenu.ConsolePrint("[SM] Listing %d commands for: %s", pList->size(), plname);
945 g_RootMenu.ConsolePrint(" %-17.16s %-8.7s %s", "[Name]", "[Type]", "[Help]");
946 for (iter=pList->begin();
950 PlCmdInfo &cmd = (*iter);
951 if (cmd.type == Cmd_Server)
955 else if (cmd.type == Cmd_Console)
959 else if (cmd.type == Cmd_Admin)
963 name = cmd.pInfo->pCmd->GetName();
964 if (cmd.pHook->helptext.size())
966 help = cmd.pHook->helptext.c_str();
970 help = cmd.pInfo->pCmd->GetHelpText();
972 g_RootMenu.ConsolePrint(" %-17.16s %-12.11s %s", name, type, help);
978 g_RootMenu.ConsolePrint("[SM] Usage: sm cmds <plugin #>");