3 * =============================================================================
5 * Copyright (C) 2004-2008 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 "HalfLife2.h"
38 #include "ChatTriggers.h"
39 #include "logic_bridge.h"
41 ConCmdManager g_ConCmds;
43 #if SOURCE_ENGINE >= SE_ORANGEBOX
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 SOURCE_ENGINE >= SE_ORANGEBOX
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 ConCmdInfo *ConCmdManager::FindInTrie(const char *name)
232 if (!sm_trie_retrieve(m_pCmds, name, (void **)&pInfo))
237 ConCmdList::iterator ConCmdManager::FindInList(const char *cmd)
239 List<ConCmdInfo *>::iterator iter = m_CmdList.begin();
241 while (iter != m_CmdList.end())
243 if (strcasecmp((*iter)->pCmd->GetName(), cmd) == 0)
251 ResultType ConCmdManager::DispatchClientCommand(int client, const char *cmd, int args, ResultType type)
255 if ((pInfo = FindInTrie(cmd)) == NULL)
257 ConCmdList::iterator item = FindInList(cmd);
258 if (item == m_CmdList.end())
263 cell_t result = type;
264 cell_t tempres = result;
265 List<CmdHook *>::iterator iter;
267 for (iter=pInfo->conhooks.begin();
268 iter!=pInfo->conhooks.end();
272 if (!pHook->pf->IsRunnable())
276 if (pHook->pAdmin && !CheckAccess(client, cmd, pHook->pAdmin))
278 if (result < Pl_Handled)
284 pHook->pf->PushCell(client);
285 pHook->pf->PushCell(args);
286 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
288 if (tempres > result)
292 if (result == Pl_Stop)
299 type = (ResultType)result;
304 void ConCmdManager::InternalDispatch(const CCommand &command)
306 int client = m_CmdClient;
310 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
311 if (!pPlayer || !pPlayer->IsConnected())
318 * Note: Console commands will EITHER go through IServerGameDLL::ClientCommand,
319 * OR this dispatch. They will NEVER go through both.
321 * Whether or not it goes through the callback is determined by FCVAR_GAMEDLL
323 const char *cmd = g_HL2.CurrentCommandName();
325 ConCmdInfo *pInfo = FindInTrie(cmd);
328 /* Unfortunately, we now have to do a slow lookup because Valve made client commands
329 * case-insensitive. We can't even use our sortedness.
331 if (client == 0 && !engine->IsDedicatedServer())
334 ConCmdList::iterator item = FindInList(cmd);
335 if (item == m_CmdList.end())
341 /* This is a hack to prevent say triggers from firing on messages that were
342 * blocked because of flooding. We won't remove this, but the hack will get
343 * "nicer" when we expose explicit say hooks.
345 if (g_ChatTriggers.WasFloodedMessage())
350 cell_t result = Pl_Continue;
351 int args = command.ArgC() - 1;
353 List<CmdHook *>::iterator iter;
356 /* Execute server-only commands if viable */
357 if (client == 0 && pInfo->srvhooks.size())
359 cell_t tempres = result;
360 for (iter=pInfo->srvhooks.begin();
361 iter!=pInfo->srvhooks.end();
365 if (!pHook->pf->IsRunnable())
369 pHook->pf->PushCell(args);
370 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
372 if (tempres > result)
376 if (result == Pl_Stop)
383 /* Check if there's an early stop */
384 if (result >= Pl_Stop)
386 if (!pInfo->sourceMod)
388 RETURN_META(MRES_SUPERCEDE);
394 /* Execute console commands */
395 if (pInfo->conhooks.size())
397 cell_t tempres = result;
398 for (iter=pInfo->conhooks.begin();
399 iter!=pInfo->conhooks.end();
403 if (!pHook->pf->IsRunnable())
409 && !CheckAccess(client, cmd, pHook->pAdmin))
411 if (result < Pl_Handled)
418 /* On a listen server, sometimes the server host's client index can be set as 0.
419 * So index 1 is passed to the command callback to correct this potential problem.
421 if (!engine->IsDedicatedServer())
423 client = g_Players.ListenClient();
426 pHook->pf->PushCell(client);
427 pHook->pf->PushCell(args);
429 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
431 if (tempres > result)
435 if (result == Pl_Stop)
443 if (result >= Pl_Handled)
445 if (!pInfo->sourceMod)
447 RETURN_META(MRES_SUPERCEDE);
453 bool ConCmdManager::CheckClientCommandAccess(int client, const char *cmd, FlagBits cmdflags)
455 if (cmdflags == 0 || client == 0)
460 /* If running listen server, then client 1 is the server host and should have 'root' access */
461 if (client == 1 && !engine->IsDedicatedServer())
466 CPlayer *player = g_Players.GetPlayerByIndex(client);
468 || player->GetEdict() == NULL
469 || player->IsFakeClient())
474 return CheckAdminCommandAccess(player->GetAdminId(), cmd, cmdflags);
477 bool ConCmdManager::CheckAdminCommandAccess(AdminId adm, const char *cmd, FlagBits cmdflags)
479 if (adm != INVALID_ADMIN_ID)
481 FlagBits bits = g_Admins.GetAdminFlags(adm, Access_Effective);
483 /* root knows all, WHOA */
484 if ((bits & ADMFLAG_ROOT) == ADMFLAG_ROOT)
489 /* Check for overrides
490 * :TODO: is it worth optimizing this?
492 unsigned int groups = g_Admins.GetAdminGroupCount(adm);
495 bool override = false;
496 for (unsigned int i=0; i<groups; i++)
498 gid = g_Admins.GetAdminGroup(adm, i, NULL);
499 /* First get group-level override */
500 override = g_Admins.GetGroupCommandOverride(gid, cmd, Override_CommandGroup, &rule);
501 /* Now get the specific command override */
502 if (g_Admins.GetGroupCommandOverride(gid, cmd, Override_Command, &rule))
508 if (rule == Command_Allow)
512 else if (rule == Command_Deny)
519 /* See if our other flags match */
520 if ((bits & cmdflags) == cmdflags)
529 bool ConCmdManager::CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin)
531 if (CheckClientCommandAccess(client, cmd, pAdmin->eflags))
536 edict_t *pEdict = PEntityOfEntIndex(client);
538 /* If we got here, the command failed... */
540 if (!logicore.CoreTranslate(buffer, sizeof(buffer), "%T", 2, NULL, "No Access", &client))
542 UTIL_Format(buffer, sizeof(buffer), "You do not have access to this command");
545 unsigned int replyto = g_ChatTriggers.GetReplyTo();
546 if (replyto == SM_REPLY_CONSOLE)
548 char fullbuffer[192];
549 UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s.\n", buffer);
550 engine->ClientPrintf(pEdict, fullbuffer);
552 else if (replyto == SM_REPLY_CHAT)
554 char fullbuffer[192];
555 UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s.", buffer);
556 g_HL2.TextMsg(client, HUD_PRINTTALK, fullbuffer);
562 bool ConCmdManager::AddAdminCommand(IPluginFunction *pFunction,
566 const char *description,
569 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
576 CmdHook *pHook = new CmdHook();
577 AdminCmdInfo *pAdmin = new AdminCmdInfo();
579 pHook->pf = pFunction;
580 if (description && description[0])
582 pHook->helptext.assign(description);
584 pHook->pAdmin = pAdmin;
588 if (!sm_trie_retrieve(m_pCmdGrps, group, (void **)&object))
590 grpid = m_Strings.AddString(group);
591 sm_trie_insert(m_pCmdGrps, group, (void *)grpid);
598 pAdmin->cmdGrpId = grpid;
599 pAdmin->flags = adminflags;
601 /* First get the command group override, if any */
602 bool override = g_Admins.GetCommandOverride(group,
603 Override_CommandGroup,
606 /* Next get the command override, if any */
607 if (g_Admins.GetCommandOverride(name,
614 /* Assign normal flags if there were no overrides */
617 pAdmin->eflags = pAdmin->flags;
620 /* Finally, add the hook */
621 pInfo->conhooks.push_back(pHook);
622 pInfo->admin = *(pHook->pAdmin);
624 /* Now add to the plugin */
626 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
627 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
629 pList = new CmdList();
630 pPlugin->SetProperty("CommandList", pList);
634 info.type = Cmd_Admin;
636 AddToPlCmdList(pList, info);
641 bool ConCmdManager::AddServerCommand(IPluginFunction *pFunction,
643 const char *description,
647 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
654 CmdHook *pHook = new CmdHook();
656 pHook->pf = pFunction;
657 if (description && description[0])
659 pHook->helptext.assign(description);
662 pInfo->srvhooks.push_back(pHook);
664 /* Add to the plugin */
666 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
667 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
669 pList = new CmdList();
670 pPlugin->SetProperty("CommandList", pList);
674 info.type = Cmd_Server;
676 AddToPlCmdList(pList, info);
681 void AddToPlCmdList(CmdList *pList, const PlCmdInfo &info)
683 CmdList::iterator iter = pList->begin();
684 bool inserted = false;
685 const char *orig = NULL;
687 orig = info.pInfo->pCmd->GetName();
689 /* Insert this into the help list, SORTED alphabetically. */
690 while (iter != pList->end())
692 PlCmdInfo &obj = (*iter);
693 const char *cmd = obj.pInfo->pCmd->GetName();
694 if (strcmp(orig, cmd) < 0)
696 pList->insert(iter, info);
705 pList->push_back(info);
709 void ConCmdManager::AddToCmdList(ConCmdInfo *info)
711 List<ConCmdInfo *>::iterator iter = m_CmdList.begin();
713 bool inserted = false;
714 const char *orig = NULL;
716 orig = info->pCmd->GetName();
718 /* Insert this into the help list, SORTED alphabetically. */
719 while (iter != m_CmdList.end())
721 const char *cmd = NULL;
723 cmd = pInfo->pCmd->GetName();
724 if (strcmp(orig, cmd) < 0)
726 m_CmdList.insert(iter, info);
735 m_CmdList.push_back(info);
739 void ConCmdManager::UpdateAdminCmdFlags(const char *cmd, OverrideType type, FlagBits bits, bool remove)
743 if (type == Override_Command)
745 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
750 List<CmdHook *>::iterator iter;
753 for (iter=pInfo->conhooks.begin(); iter!=pInfo->conhooks.end(); iter++)
760 pHook->pAdmin->eflags = bits;
762 pHook->pAdmin->eflags = pHook->pAdmin->flags;
764 pInfo->admin = *(pHook->pAdmin);
768 else if (type == Override_CommandGroup)
771 if (!sm_trie_retrieve(m_pCmdGrps, cmd, &object))
775 int grpid = (int)object;
777 /* This is bad :( loop through all commands */
778 List<ConCmdInfo *>::iterator iter;
780 for (iter=m_CmdList.begin(); iter!=m_CmdList.end(); iter++)
783 for (List<CmdHook *>::iterator citer=pInfo->conhooks.begin();
784 citer!=pInfo->conhooks.end();
788 if (pHook->pAdmin && pHook->pAdmin->cmdGrpId == grpid)
792 pHook->pAdmin->eflags = bits;
794 pHook->pAdmin->eflags = pHook->pAdmin->flags;
796 pInfo->admin = *(pHook->pAdmin);
803 void ConCmdManager::RemoveConCmd(ConCmdInfo *info, const char *name, bool is_read_safe, bool untrack)
805 /* Remove from the trie */
806 sm_trie_delete(m_pCmds, name);
808 /* Remove console-specific information
809 * This should always be true as of right now
815 /* Unlink from SourceMM */
816 g_SMAPI->UnregisterConCommandBase(g_PLAPI, info->pCmd);
817 /* Delete the command's memory */
818 char *new_help = const_cast<char *>(info->pCmd->GetHelpText());
819 char *new_name = const_cast<char *>(info->pCmd->GetName());
828 /* Remove the external hook */
829 SH_REMOVE_HOOK_STATICFUNC(ConCommand, Dispatch, info->pCmd, CommandCallback, false);
833 UntrackConCommandBase(info->pCmd, this);
838 /* Remove from list */
839 m_CmdList.remove(info);
844 bool ConCmdManager::LookForSourceModCommand(const char *cmd)
848 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
853 return pInfo->sourceMod && (pInfo->conhooks.size() > 0);
856 bool ConCmdManager::LookForCommandAdminFlags(const char *cmd, FlagBits *pFlags)
860 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
865 *pFlags = pInfo->admin.eflags;
870 ConCmdInfo *ConCmdManager::AddOrFindCommand(const char *name, const char *description, int flags)
873 if (!sm_trie_retrieve(m_pCmds, name, (void **)&pInfo))
875 ConCmdList::iterator item = FindInList(name);
876 if (item != m_CmdList.end())
879 pInfo = new ConCmdInfo();
880 /* Find the commandopan */
881 ConCommand *pCmd = FindCommand(name);
885 /* Note that we have to duplicate because the source might not be
886 * a static string, and these expect static memory.
892 char *new_name = sm_strdup(name);
893 char *new_help = sm_strdup(description);
894 pCmd = new ConCommand(new_name, CommandCallback, new_help, flags);
895 pInfo->sourceMod = true;
899 TrackConCommandBase(pCmd, this);
900 SH_ADD_HOOK_STATICFUNC(ConCommand, Dispatch, pCmd, CommandCallback, false);
905 sm_trie_insert(m_pCmds, name, pInfo);
912 void ConCmdManager::OnRootConsoleCommand(const char *cmdname, const CCommand &command)
914 if (command.ArgC() >= 3)
916 const char *text = command.Arg(2);
918 CPlugin *pPlugin = g_PluginSys.FindPluginByConsoleArg(text);
922 g_RootMenu.ConsolePrint("[SM] Plugin \"%s\" was not found.", text);
926 const sm_plugininfo_t *plinfo = pPlugin->GetPublicInfo();
927 const char *plname = IS_STR_FILLED(plinfo->name) ? plinfo->name : pPlugin->GetFilename();
930 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
932 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
937 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
941 CmdList::iterator iter;
942 const char *type = NULL;
945 g_RootMenu.ConsolePrint("[SM] Listing %d commands for: %s", pList->size(), plname);
946 g_RootMenu.ConsolePrint(" %-17.16s %-8.7s %s", "[Name]", "[Type]", "[Help]");
947 for (iter=pList->begin();
951 PlCmdInfo &cmd = (*iter);
952 if (cmd.type == Cmd_Server)
956 else if (cmd.type == Cmd_Admin)
958 type = (cmd.pInfo->admin.eflags == 0)?"console":"admin";
960 name = cmd.pInfo->pCmd->GetName();
961 if (cmd.pHook->helptext.size())
963 help = cmd.pHook->helptext.c_str();
967 help = cmd.pInfo->pCmd->GetHelpText();
969 g_RootMenu.ConsolePrint(" %-17.16s %-12.11s %s", name, type, help);
975 g_RootMenu.ConsolePrint("[SM] Usage: sm cmds <plugin #>");