UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make all command lookups case-insensitive (#1542)

Browse Source 
SM internally maintained both a case-sensitive and a case-insensitive
lookup method for commands, where the case-sensitive hashmap was used as
a fast path, and case-insensitive iteration over a list used as the slow
path if a command was not found in the hashmap. But only command
dispatch handling used this dual path approach, chat triggers for
example only did a loopup in the hashmap.

Over the years Valve has made more and more of the command dispatch
logic case-insensitive to the point where all console commands are now
case-insensitive, so maintaining case sensitivity when using chat
triggers does not make a lot of sense. There are somewhat popular
plugins that attempt to "correct" this behaviour - but at least one is
having issues after the previous case-sensitivity fixes for commands -
see #1480.

We still have to keep the list around for the sorted help use case and
command iteration, but this PR changes the hashmap to use a
case-insensitive hashing policy (as previously done for convars, and
more recently for game command lookup) and changes all by-name lookup to
exclusively use the hashmap (as there is no need to fall back to the
list any more).

Tested a bunch in TF2, I don't know of any games that still have a
case-sensitive command dispatch pipeline to test. I think the worst case
would be that we'd accept a chat command in the "wrong" case then fail
to execute the underlying command. If that turns out to be an issue in
practice, we should be able to fix it easily enough by replacing the
command name in the buffer with the correct casing of the command we
looked up.

Also fixed a couple of very minor Lookup vs. Key issues in NameHashSet
(noted in #1529) that were being masked due to CharsAndLength's
converting constructor. I tried to make the constructor explicit to
avoid this happening in the future but HashTable's add function relies
on being able to do an implicit conversion so that wasn't possible. We
might want to just rely on the implicit conversion up here as well, but
it doesn't really matter either way.

Fixes #1480, #1529
This commit is contained in:
Asher Baker 2021-07-18 19:05:06 +01:00 committed by GitHub
parent 6a2ac9800b
commit 2d241316c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 34 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
core/ChatTriggers.cpp
View File

@ -363,7 +363,7 @@ bool ChatTriggers::PreProcessTrigger(edict_t *pEdict, const char *args)
if (!g_ConCmds.LookForSourceModCommand(cmd_buf))
{
/* Check if we had an "sm_" prefix */
if (strncmp(cmd_buf, "sm_", 3) == 0)
if (strncasecmp(cmd_buf, "sm_", 3) == 0)
{
return false;
}
@ -387,15 +387,7 @@ bool ChatTriggers::PreProcessTrigger(edict_t *pEdict, const char *args)
/* See if we need to do extra string manipulation */
if (prepended)
{
size_t len;
/* Check if we need to prepend sm_ */
if (prepended)
{
len = ke::SafeSprintf(m_ToExecute, sizeof(m_ToExecute), "sm_%s", args);
} else {
len = ke::SafeStrcpy(m_ToExecute, sizeof(m_ToExecute), args);
}
ke::SafeSprintf(m_ToExecute, sizeof(m_ToExecute), "sm_%s", args);
} else {
ke::SafeStrcpy(m_ToExecute, sizeof(m_ToExecute), args);
}

39
core/ConCmdManager.cpp
View File

@ -153,30 +153,13 @@ ConCmdInfo *ConCmdManager::FindInTrie(const char *name)
return pInfo;
}
ConCmdList::iterator ConCmdManager::FindInList(const char *cmd)
{
List<ConCmdInfo *>::iterator iter = m_CmdList.begin();
while (iter != m_CmdList.end())
{
if (strcasecmp((*iter)->pCmd->GetName(), cmd) == 0)
break;
iter++;
}
return iter;
}
ResultType ConCmdManager::DispatchClientCommand(int client, const char *cmd, int args, ResultType type)
{
ConCmdInfo *pInfo;
ConCmdInfo *pInfo = FindInTrie(cmd);
if ((pInfo = FindInTrie(cmd)) == NULL)
if (pInfo == NULL)
{
ConCmdList::iterator item = FindInList(cmd);
if (item == m_CmdList.end())
return type;
pInfo = *item;
return type;
}
cell_t result = type;
@ -231,17 +214,7 @@ bool ConCmdManager::InternalDispatch(int client, const ICommandArgs *args)
ConCmdInfo *pInfo = FindInTrie(cmd);
if (pInfo == NULL)
{
/* Unfortunately, we now have to do a slow lookup because Valve made client commands
* case-insensitive. We can't even use our sortedness.
*/
if (client == 0 && !engine->IsDedicatedServer())
return false;
ConCmdList::iterator item = FindInList(cmd);
if (item == m_CmdList.end())
return false;
pInfo = *item;
return false;
}
/* This is a hack to prevent say triggers from firing on messages that were
@ -568,10 +541,6 @@ ConCmdInfo *ConCmdManager::AddOrFindCommand(const char *name, const char *descri
ConCmdInfo *pInfo;
if (!m_Cmds.retrieve(name, &pInfo))
{
ConCmdList::iterator item = FindInList(name);
if (item != m_CmdList.end())
return *item;
pInfo = new ConCmdInfo();
/* Find the commandopan */
ConCommand *pCmd = FindCommand(name);

28
core/ConCmdManager.h
View File

@ -49,6 +49,7 @@
#include <IAdminSystem.h>
#include "concmd_cleaner.h"
#include "GameHooks.h"
#include <sm_namehashset.h>
using namespace SourceHook;
@ -108,12 +109,32 @@ struct ConCmdInfo
pCmd = nullptr;
eflags = 0;
}
bool sourceMod; /**< Determines whether or not concmd was created by a SourceMod plugin */
ConCommand *pCmd; /**< Pointer to the command itself */
CmdHookList hooks; /**< Hook list */
FlagBits eflags; /**< Effective admin flags */
ke::RefPtr<CommandHook> sh_hook; /**< SourceHook hook, if any. */
IPlugin *pPlugin; /**< Owning plugin handle. */
struct ConCmdPolicy
{
static inline bool matches(const char *name, ConCmdInfo *info)
{
const char *conCmdChars = info->pCmd->GetName();
std::string concmdName = ke::Lowercase(conCmdChars);
std::string input = ke::Lowercase(name);
return concmdName == input;
}
static inline uint32_t hash(const detail::CharsAndLength &key)
{
std::string lower = ke::Lowercase(key.c_str());
return detail::CharsAndLength(lower.c_str()).hash();
}
};
};
typedef List<ConCmdInfo *> ConCmdList;
@ -157,11 +178,6 @@ private:
void AddToCmdList(ConCmdInfo *info);
void RemoveConCmd(ConCmdInfo *info, const char *cmd, bool untrack);
bool CheckAccess(int client, const char *cmd, AdminCmdInfo *pAdmin);
// Case insensitive
ConCmdList::iterator FindInList(const char *name);
// Case sensitive
ConCmdInfo *FindInTrie(const char *name);
public:
inline const List<ConCmdInfo *> & GetCommandList()
@ -171,7 +187,7 @@ public:
private:
typedef StringHashMap<ke::RefPtr<CommandGroup> > GroupMap;
StringHashMap<ConCmdInfo *> m_Cmds; /* command lookup */
NameHashSet<ConCmdInfo *, ConCmdInfo::ConCmdPolicy> m_Cmds; /* command lookup */
GroupMap m_CmdGrps; /* command group map */
ConCmdList m_CmdList; /* command list */
};

10
public/sm_namehashset.h
View File

@ -111,12 +111,14 @@ public:
Result find(const char *aKey)
{
return table_.find(aKey);
CharsAndLength key(aKey);
return table_.find(key);
}
Insert findForAdd(const char *aKey)
{
return table_.findForAdd(aKey);
CharsAndLength key(aKey);
return table_.findForAdd(key);
}
template <typename U>
@ -128,7 +130,7 @@ public:
bool retrieve(const char *aKey, T *value)
{
CharsAndLength key(aKey);
Result r = table_.find(aKey);
Result r = table_.find(key);
if (!r.found())
return false;
*value = *r;
@ -148,7 +150,7 @@ public:
bool contains(const char *aKey)
{
CharsAndLength key(aKey);
Result r = table_.find(aKey);
Result r = table_.find(key);
return r.found();
}