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 <ITextParsers.h>
33 #include "ChatTriggers.h"
34 #include "sm_stringutil.h"
35 #include "ConCmdManager.h"
36 #include "PlayerManager.h"
37 #include "Translator.h"
38 #include "HalfLife2.h"
40 /* :HACKHACK: We can't SH_DECL here because ConCmdManager.cpp does.
41 * While the OB build only runs on MM:S 1.6.0+ (SH 5+), the older one
42 * can technically be compiled against any MM:S version after 1.4.2.
44 #if defined ORANGEBOX_BUILD
45 extern bool __SourceHook_FHRemoveConCommandDispatch(void *, bool, class fastdelegate::FastDelegate1<const CCommand &, void>);
46 extern int __SourceHook_FHAddConCommandDispatch(void *, ISourceHook::AddHookMode, bool, class fastdelegate::FastDelegate1<const CCommand &, void>);
48 extern bool __SourceHook_FHRemoveConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
49 #if SH_IMPL_VERSION >= 5
50 extern int __SourceHook_FHAddConCommandDispatch(void *, ISourceHook::AddHookMode, bool, class fastdelegate::FastDelegate0<void>);
51 #elif SH_IMPL_VERSION == 4
52 extern int __SourceHook_FHAddConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
53 #elif SH_IMPL_VERSION == 3
54 extern bool __SourceHook_FHAddConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
55 #endif //SH_IMPL_VERSION
56 #endif //ORANGEBOX_BUILD
58 ChatTriggers g_ChatTriggers;
59 bool g_bSupressSilentFails = false;
60 CPhraseFile *g_pFloodPhrases = NULL;
62 ChatTriggers::ChatTriggers() : m_pSayCmd(NULL), m_bWillProcessInPost(false),
63 m_bTriggerWasSilent(false), m_ReplyTo(SM_REPLY_CONSOLE)
65 m_PubTrigger = sm_strdup("!");
66 m_PrivTrigger = sm_strdup("/");
68 m_PrivTriggerSize = 1;
69 m_bIsChatTrigger = false;
72 ChatTriggers::~ChatTriggers()
74 delete [] m_PubTrigger;
76 delete [] m_PrivTrigger;
80 ConfigResult ChatTriggers::OnSourceModConfigChanged(const char *key,
86 if (strcmp(key, "PublicChatTrigger") == 0)
88 delete [] m_PubTrigger;
89 m_PubTrigger = sm_strdup(value);
90 m_PubTriggerSize = strlen(m_PubTrigger);
91 return ConfigResult_Accept;
93 else if (strcmp(key, "SilentChatTrigger") == 0)
95 delete [] m_PrivTrigger;
96 m_PrivTrigger = sm_strdup(value);
97 m_PrivTriggerSize = strlen(m_PrivTrigger);
98 return ConfigResult_Accept;
100 else if (strcmp(key, "SilentFailSuppress") == 0)
102 g_bSupressSilentFails = strcmp(value, "yes") == 0;
103 return ConfigResult_Accept;
106 return ConfigResult_Ignore;
109 void ChatTriggers::OnSourceModAllInitialized()
111 m_pShouldFloodBlock = g_Forwards.CreateForward("OnClientFloodCheck", ET_Event, 1, NULL, Param_Cell);
112 m_pDidFloodBlock = g_Forwards.CreateForward("OnClientFloodResult", ET_Event, 2, NULL, Param_Cell, Param_Cell);
115 void ChatTriggers::OnSourceModAllInitialized_Post()
117 unsigned int file_id;
119 file_id = g_Translator.FindOrAddPhraseFile("antiflood.phrases.txt");
120 g_pFloodPhrases = g_Translator.GetFileByIndex(file_id);
123 void ChatTriggers::OnSourceModGameInitialized()
125 unsigned int total = 2;
126 ConCommandBase *pCmd = icvar->GetCommands();
130 if (pCmd->IsCommand())
132 name = pCmd->GetName();
133 if (!m_pSayCmd && strcmp(name, "say") == 0)
135 m_pSayCmd = (ConCommand *)pCmd;
140 } else if (!m_pSayTeamCmd && strcmp(name, "say_team") == 0) {
141 m_pSayTeamCmd = (ConCommand *)pCmd;
148 pCmd = const_cast<ConCommandBase *>(pCmd->GetNext());
153 SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
154 SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Post, true);
158 SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
159 SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Post, true);
163 void ChatTriggers::OnSourceModShutdown()
167 SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Post, true);
168 SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
172 SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Post, true);
173 SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
176 g_Forwards.ReleaseForward(m_pShouldFloodBlock);
177 g_Forwards.ReleaseForward(m_pDidFloodBlock);
180 #if defined ORANGEBOX_BUILD
181 void ChatTriggers::OnSayCommand_Pre(const CCommand &command)
184 void ChatTriggers::OnSayCommand_Pre()
191 client = g_ConCmds.GetCommandClient();
192 m_bIsChatTrigger = false;
193 m_bWasFloodedMessage = false;
195 /* The server console cannot do this */
196 if (client == 0 || (pPlayer = g_Players.GetPlayerByIndex(client)) == NULL)
198 RETURN_META(MRES_IGNORED);
201 /* We guarantee the client is connected */
202 if (!pPlayer->IsConnected())
204 RETURN_META(MRES_IGNORED);
207 const char *args = command.ArgS();
211 RETURN_META(MRES_IGNORED);
214 /* Check if we need to block this message from being sent */
215 if (ClientIsFlooding(client))
219 /* :TODO: log an error? */
220 if (g_Translator.CoreTransEx(g_pFloodPhrases,
224 "Flooding the server",
229 UTIL_Format(buffer, sizeof(buffer), "You are flooding the server!");
232 /* :TODO: we should probably kick people who spam too much. */
234 char fullbuffer[192];
235 UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s", buffer);
236 g_HL2.TextMsg(client, HUD_PRINTTALK, fullbuffer);
238 m_bWasFloodedMessage = true;
240 RETURN_META(MRES_SUPERCEDE);
243 /* Handle quoted string sets */
244 bool is_quoted = false;
251 bool is_trigger = false;
252 bool is_silent = false;
254 /* Check for either trigger */
255 if (m_PubTriggerSize && strncmp(args, m_PubTrigger, m_PubTriggerSize) == 0)
258 args = &args[m_PubTriggerSize];
260 else if (m_PrivTriggerSize && strncmp(args, m_PrivTrigger, m_PrivTriggerSize) == 0)
264 args = &args[m_PrivTriggerSize];
269 RETURN_META(MRES_IGNORED);
273 * Test if this is actually a command!
275 if (!PreProcessTrigger(engine->PEntityOfEntIndex(client), args, is_quoted))
279 && g_bSupressSilentFails
281 && (pPlayer = g_Players.GetPlayerByIndex(client)) != NULL
282 && pPlayer->GetAdminId() != INVALID_ADMIN_ID)
284 RETURN_META(MRES_SUPERCEDE);
286 RETURN_META(MRES_IGNORED);
289 m_bIsChatTrigger = true;
292 * We'll execute it in post.
294 m_bWillProcessInPost = true;
295 m_bTriggerWasSilent = is_silent;
297 /* If we're silent, block */
300 RETURN_META(MRES_SUPERCEDE);
303 /* Otherwise, let the command continue */
304 RETURN_META(MRES_IGNORED);
307 #if defined ORANGEBOX_BUILD
308 void ChatTriggers::OnSayCommand_Post(const CCommand &command)
310 void ChatTriggers::OnSayCommand_Post()
313 m_bIsChatTrigger = false;
314 m_bWasFloodedMessage = false;
315 if (m_bWillProcessInPost)
317 /* Reset this for re-entrancy */
318 m_bWillProcessInPost = false;
320 /* Execute the cached command */
321 int client = g_ConCmds.GetCommandClient();
322 unsigned int old = SetReplyTo(SM_REPLY_CHAT);
323 serverpluginhelpers->ClientCommand(engine->PEntityOfEntIndex(client), m_ToExecute);
328 bool ChatTriggers::PreProcessTrigger(edict_t *pEdict, const char *args, bool is_quoted)
330 /* Extract a command. This is kind of sloppy. */
333 const char *inptr = args;
334 while (*inptr != '\0'
335 && !textparsers->IsWhitespace(inptr)
337 && cmd_len < sizeof(cmd_buf) - 1)
339 cmd_buf[cmd_len++] = *inptr++;
341 cmd_buf[cmd_len] = '\0';
348 /* See if we have this registered */
349 bool prepended = false;
350 if (!g_ConCmds.LookForSourceModCommand(cmd_buf))
352 /* Check if we had an "sm_" prefix */
353 if (strncmp(cmd_buf, "sm_", 3) == 0)
358 /* Now, prepend. Don't worry about the buffers. This will
359 * work because the sizes are limited from earlier.
362 strcpy(new_buf, "sm_");
363 strncopy(&new_buf[3], cmd_buf, sizeof(new_buf)-3);
366 if (!g_ConCmds.LookForSourceModCommand(new_buf))
374 /* See if we need to do extra string manipulation */
375 if (is_quoted || prepended)
379 /* Check if we need to prepend sm_ */
382 len = UTIL_Format(m_ToExecute, sizeof(m_ToExecute), "sm_%s", args);
384 len = strncopy(m_ToExecute, args, sizeof(m_ToExecute));
387 /* Check if we need to strip a quote */
390 if (m_ToExecute[len-1] == '"')
392 m_ToExecute[--len] = '\0';
396 strncopy(m_ToExecute, args, sizeof(m_ToExecute));
402 unsigned int ChatTriggers::SetReplyTo(unsigned int reply)
404 unsigned int old = m_ReplyTo;
411 unsigned int ChatTriggers::GetReplyTo()
416 bool ChatTriggers::IsChatTrigger()
418 return m_bIsChatTrigger;
421 bool ChatTriggers::ClientIsFlooding(int client)
423 bool is_flooding = false;
425 if (m_pShouldFloodBlock->GetFunctionCount() != 0)
429 m_pShouldFloodBlock->PushCell(client);
430 m_pShouldFloodBlock->Execute(&res);
438 if (m_pDidFloodBlock->GetFunctionCount() != 0)
440 m_pDidFloodBlock->PushCell(client);
441 m_pDidFloodBlock->PushCell(is_flooding ? 1 : 0);
442 m_pDidFloodBlock->Execute(NULL);
448 bool ChatTriggers::WasFloodedMessage()
450 return m_bWasFloodedMessage;