Another try at fixing build.
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 ResultType ConCmdManager::DispatchClientCommand(int client, const char *cmd, int args, ResultType type)
233 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
235 List<ConCmdInfo *>::iterator iter;
238 iter = m_CmdList.begin();
239 while (iter != m_CmdList.end())
241 if (strcasecmp((*iter)->pCmd->GetName(), cmd) == 0)
255 cell_t result = type;
256 cell_t tempres = result;
257 List<CmdHook *>::iterator iter;
259 for (iter=pInfo->conhooks.begin();
260 iter!=pInfo->conhooks.end();
264 if (!pHook->pf->IsRunnable())
268 if (pHook->pAdmin && !CheckAccess(client, cmd, pHook->pAdmin))
270 if (result < Pl_Handled)
276 pHook->pf->PushCell(client);
277 pHook->pf->PushCell(args);
278 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
280 if (tempres > result)
284 if (result == Pl_Stop)
291 type = (ResultType)result;
296 void ConCmdManager::InternalDispatch(const CCommand &command)
298 int client = m_CmdClient;
302 CPlayer *pPlayer = g_Players.GetPlayerByIndex(client);
303 if (!pPlayer || !pPlayer->IsConnected())
310 * Note: Console commands will EITHER go through IServerGameDLL::ClientCommand,
311 * OR this dispatch. They will NEVER go through both.
313 * Whether or not it goes through the callback is determined by FCVAR_GAMEDLL
315 const char *cmd = g_HL2.CurrentCommandName();
318 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
320 /* Unfortunately, we now have to do a slow lookup because Valve made client commands
321 * case-insensitive. We can't even use our sortedness.
323 if (client == 0 && !engine->IsDedicatedServer())
328 List<ConCmdInfo *>::iterator iter;
331 iter = m_CmdList.begin();
332 while (iter != m_CmdList.end())
334 if (strcasecmp((*iter)->pCmd->GetName(), cmd) == 0)
348 /* This is a hack to prevent say triggers from firing on messages that were
349 * blocked because of flooding. We won't remove this, but the hack will get
350 * "nicer" when we expose explicit say hooks.
352 if (g_ChatTriggers.WasFloodedMessage())
357 cell_t result = Pl_Continue;
358 int args = command.ArgC() - 1;
360 List<CmdHook *>::iterator iter;
363 /* Execute server-only commands if viable */
364 if (client == 0 && pInfo->srvhooks.size())
366 cell_t tempres = result;
367 for (iter=pInfo->srvhooks.begin();
368 iter!=pInfo->srvhooks.end();
372 if (!pHook->pf->IsRunnable())
376 pHook->pf->PushCell(args);
377 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
379 if (tempres > result)
383 if (result == Pl_Stop)
390 /* Check if there's an early stop */
391 if (result >= Pl_Stop)
393 if (!pInfo->sourceMod)
395 RETURN_META(MRES_SUPERCEDE);
401 /* Execute console commands */
402 if (pInfo->conhooks.size())
404 cell_t tempres = result;
405 for (iter=pInfo->conhooks.begin();
406 iter!=pInfo->conhooks.end();
410 if (!pHook->pf->IsRunnable())
416 && !CheckAccess(client, cmd, pHook->pAdmin))
418 if (result < Pl_Handled)
425 /* On a listen server, sometimes the server host's client index can be set as 0.
426 * So index 1 is passed to the command callback to correct this potential problem.
428 if (!engine->IsDedicatedServer())
430 client = g_Players.ListenClient();
433 pHook->pf->PushCell(client);
434 pHook->pf->PushCell(args);
436 if (pHook->pf->Execute(&tempres) == SP_ERROR_NONE)
438 if (tempres > result)
442 if (result == Pl_Stop)
450 if (result >= Pl_Handled)
452 if (!pInfo->sourceMod)
454 RETURN_META(MRES_SUPERCEDE);
460 bool ConCmdManager::CheckCommandAccess(int client, const char *cmd, FlagBits cmdflags)
462 if (cmdflags == 0 || client == 0)
467 /* If running listen server, then client 1 is the server host and should have 'root' access */
468 if (client == 1 && !engine->IsDedicatedServer())
473 CPlayer *player = g_Players.GetPlayerByIndex(client);
475 || player->GetEdict() == NULL
476 || player->IsFakeClient())
481 AdminId adm = player->GetAdminId();
482 if (adm != INVALID_ADMIN_ID)
484 FlagBits bits = g_Admins.GetAdminFlags(adm, Access_Effective);
486 /* root knows all, WHOA */
487 if ((bits & ADMFLAG_ROOT) == ADMFLAG_ROOT)
492 /* Check for overrides
493 * :TODO: is it worth optimizing this?
495 unsigned int groups = g_Admins.GetAdminGroupCount(adm);
498 bool override = false;
499 for (unsigned int i=0; i<groups; i++)
501 gid = g_Admins.GetAdminGroup(adm, i, NULL);
502 /* First get group-level override */
503 override = g_Admins.GetGroupCommandOverride(gid, cmd, Override_CommandGroup, &rule);
504 /* Now get the specific command override */
505 if (g_Admins.GetGroupCommandOverride(gid, cmd, Override_Command, &rule))
511 if (rule == Command_Allow)
515 else if (rule == Command_Deny)
522 /* See if our other flags match */
523 if ((bits & cmdflags) == cmdflags)
532 bool ConCmdManager::CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin)
534 if (CheckCommandAccess(client, cmd, pAdmin->eflags))
539 edict_t *pEdict = PEntityOfEntIndex(client);
541 /* If we got here, the command failed... */
543 if (!logicore.CoreTranslate(buffer, sizeof(buffer), "%T", 2, NULL, "No Access", &client))
545 UTIL_Format(buffer, sizeof(buffer), "You do not have access to this command");
548 unsigned int replyto = g_ChatTriggers.GetReplyTo();
549 if (replyto == SM_REPLY_CONSOLE)
551 char fullbuffer[192];
552 UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s.\n", buffer);
553 engine->ClientPrintf(pEdict, fullbuffer);
555 else if (replyto == SM_REPLY_CHAT)
557 char fullbuffer[192];
558 UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s.", buffer);
559 g_HL2.TextMsg(client, HUD_PRINTTALK, fullbuffer);
565 bool ConCmdManager::AddConsoleCommand(IPluginFunction *pFunction,
567 const char *description,
570 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
577 CmdHook *pHook = new CmdHook();
579 pHook->pf = pFunction;
580 if (description && description[0])
582 pHook->helptext.assign(description);
584 pInfo->conhooks.push_back(pHook);
586 /* Add to the plugin */
588 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
589 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
591 pList = new CmdList();
592 pPlugin->SetProperty("CommandList", pList);
596 info.type = Cmd_Console;
598 AddToPlCmdList(pList, info);
603 bool ConCmdManager::AddAdminCommand(IPluginFunction *pFunction,
607 const char *description,
610 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
617 CmdHook *pHook = new CmdHook();
618 AdminCmdInfo *pAdmin = new AdminCmdInfo();
620 pHook->pf = pFunction;
621 if (description && description[0])
623 pHook->helptext.assign(description);
625 pHook->pAdmin = pAdmin;
629 if (!sm_trie_retrieve(m_pCmdGrps, group, (void **)&object))
631 grpid = m_Strings.AddString(group);
632 sm_trie_insert(m_pCmdGrps, group, (void *)grpid);
639 pAdmin->cmdGrpId = grpid;
640 pAdmin->flags = adminflags;
642 /* First get the command group override, if any */
643 bool override = g_Admins.GetCommandOverride(group,
644 Override_CommandGroup,
647 /* Next get the command override, if any */
648 if (g_Admins.GetCommandOverride(name,
655 /* Assign normal flags if there were no overrides */
658 pAdmin->eflags = pAdmin->flags;
661 /* Finally, add the hook */
662 pInfo->conhooks.push_back(pHook);
663 pInfo->admin = *(pHook->pAdmin);
664 pInfo->is_admin_set = true;
666 /* Now add to the plugin */
668 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
669 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
671 pList = new CmdList();
672 pPlugin->SetProperty("CommandList", pList);
676 info.type = Cmd_Admin;
678 AddToPlCmdList(pList, info);
683 bool ConCmdManager::AddServerCommand(IPluginFunction *pFunction,
685 const char *description,
689 ConCmdInfo *pInfo = AddOrFindCommand(name, description, flags);
696 CmdHook *pHook = new CmdHook();
698 pHook->pf = pFunction;
699 if (description && description[0])
701 pHook->helptext.assign(description);
704 pInfo->srvhooks.push_back(pHook);
706 /* Add to the plugin */
708 IPlugin *pPlugin = g_PluginSys.GetPluginByCtx(pFunction->GetParentContext()->GetContext());
709 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
711 pList = new CmdList();
712 pPlugin->SetProperty("CommandList", pList);
716 info.type = Cmd_Server;
718 AddToPlCmdList(pList, info);
723 void AddToPlCmdList(CmdList *pList, const PlCmdInfo &info)
725 CmdList::iterator iter = pList->begin();
726 bool inserted = false;
727 const char *orig = NULL;
729 orig = info.pInfo->pCmd->GetName();
731 /* Insert this into the help list, SORTED alphabetically. */
732 while (iter != pList->end())
734 PlCmdInfo &obj = (*iter);
735 const char *cmd = obj.pInfo->pCmd->GetName();
736 if (strcmp(orig, cmd) < 0)
738 pList->insert(iter, info);
747 pList->push_back(info);
751 void ConCmdManager::AddToCmdList(ConCmdInfo *info)
753 List<ConCmdInfo *>::iterator iter = m_CmdList.begin();
755 bool inserted = false;
756 const char *orig = NULL;
758 orig = info->pCmd->GetName();
760 /* Insert this into the help list, SORTED alphabetically. */
761 while (iter != m_CmdList.end())
763 const char *cmd = NULL;
765 cmd = pInfo->pCmd->GetName();
766 if (strcmp(orig, cmd) < 0)
768 m_CmdList.insert(iter, info);
777 m_CmdList.push_back(info);
781 void ConCmdManager::UpdateAdminCmdFlags(const char *cmd, OverrideType type, FlagBits bits, bool remove)
785 if (type == Override_Command)
787 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
792 List<CmdHook *>::iterator iter;
795 for (iter=pInfo->conhooks.begin(); iter!=pInfo->conhooks.end(); iter++)
802 pHook->pAdmin->eflags = bits;
804 pHook->pAdmin->eflags = pHook->pAdmin->flags;
806 pInfo->admin = *(pHook->pAdmin);
809 pInfo->is_admin_set = true;
811 else if (type == Override_CommandGroup)
814 if (!sm_trie_retrieve(m_pCmdGrps, cmd, &object))
818 int grpid = (int)object;
820 /* This is bad :( loop through all commands */
821 List<ConCmdInfo *>::iterator iter;
823 for (iter=m_CmdList.begin(); iter!=m_CmdList.end(); iter++)
826 for (List<CmdHook *>::iterator citer=pInfo->conhooks.begin();
827 citer!=pInfo->conhooks.end();
831 if (pHook->pAdmin && pHook->pAdmin->cmdGrpId == grpid)
835 pHook->pAdmin->eflags = bits;
837 pHook->pAdmin->eflags = pHook->pAdmin->flags;
839 pInfo->admin = *(pHook->pAdmin);
843 pInfo->is_admin_set = true;
847 void ConCmdManager::RemoveConCmd(ConCmdInfo *info, const char *name, bool is_read_safe, bool untrack)
849 /* Remove from the trie */
850 sm_trie_delete(m_pCmds, name);
852 /* Remove console-specific information
853 * This should always be true as of right now
859 /* Unlink from SourceMM */
860 g_SMAPI->UnregisterConCommandBase(g_PLAPI, info->pCmd);
861 /* Delete the command's memory */
862 char *new_help = const_cast<char *>(info->pCmd->GetHelpText());
863 char *new_name = const_cast<char *>(info->pCmd->GetName());
872 /* Remove the external hook */
873 SH_REMOVE_HOOK_STATICFUNC(ConCommand, Dispatch, info->pCmd, CommandCallback, false);
877 UntrackConCommandBase(info->pCmd, this);
882 /* Remove from list */
883 m_CmdList.remove(info);
888 bool ConCmdManager::LookForSourceModCommand(const char *cmd)
892 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
897 return pInfo->sourceMod && (pInfo->conhooks.size() > 0);
900 bool ConCmdManager::LookForCommandAdminFlags(const char *cmd, FlagBits *pFlags)
904 if (!sm_trie_retrieve(m_pCmds, cmd, (void **)&pInfo))
909 *pFlags = pInfo->admin.eflags;
911 return pInfo->is_admin_set;
914 ConCmdInfo *ConCmdManager::AddOrFindCommand(const char *name, const char *description, int flags)
917 if (!sm_trie_retrieve(m_pCmds, name, (void **)&pInfo))
919 pInfo = new ConCmdInfo();
920 /* Find the commandopan */
921 ConCommand *pCmd = FindCommand(name);
925 /* Note that we have to duplicate because the source might not be
926 * a static string, and these expect static memory.
932 char *new_name = sm_strdup(name);
933 char *new_help = sm_strdup(description);
934 pCmd = new ConCommand(new_name, CommandCallback, new_help, flags);
935 pInfo->sourceMod = true;
939 TrackConCommandBase(pCmd, this);
940 SH_ADD_HOOK_STATICFUNC(ConCommand, Dispatch, pCmd, CommandCallback, false);
944 pInfo->is_admin_set = false;
946 sm_trie_insert(m_pCmds, name, pInfo);
953 void ConCmdManager::OnRootConsoleCommand(const char *cmdname, const CCommand &command)
955 if (command.ArgC() >= 3)
957 const char *text = command.Arg(2);
959 CPlugin *pPlugin = g_PluginSys.FindPluginByConsoleArg(text);
963 g_RootMenu.ConsolePrint("[SM] Plugin \"%s\" was not found.", text);
967 const sm_plugininfo_t *plinfo = pPlugin->GetPublicInfo();
968 const char *plname = IS_STR_FILLED(plinfo->name) ? plinfo->name : pPlugin->GetFilename();
971 if (!pPlugin->GetProperty("CommandList", (void **)&pList))
973 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
978 g_RootMenu.ConsolePrint("[SM] No commands found for: %s", plname);
982 CmdList::iterator iter;
983 const char *type = NULL;
986 g_RootMenu.ConsolePrint("[SM] Listing %d commands for: %s", pList->size(), plname);
987 g_RootMenu.ConsolePrint(" %-17.16s %-8.7s %s", "[Name]", "[Type]", "[Help]");
988 for (iter=pList->begin();
992 PlCmdInfo &cmd = (*iter);
993 if (cmd.type == Cmd_Server)
997 else if (cmd.type == Cmd_Console)
1001 else if (cmd.type == Cmd_Admin)
1005 name = cmd.pInfo->pCmd->GetName();
1006 if (cmd.pHook->helptext.size())
1008 help = cmd.pHook->helptext.c_str();
1012 help = cmd.pInfo->pCmd->GetHelpText();
1014 g_RootMenu.ConsolePrint(" %-17.16s %-12.11s %s", name, type, help);
1020 g_RootMenu.ConsolePrint("[SM] Usage: sm cmds <plugin #>");