core/ChatTriggers.cpp
author Nicholas Hastings <skamonkey@gmail.com>
Tue Nov 30 13:09:30 2010 -0500 (2010-11-30)
changeset 3162 d8f90b56529f
parent 3004 e3ac0dc6d9a4
child 3819 d17aed3d46bf
permissions -rw-r--r--
Fixed BanClient always banning by IP address (bug 4626, r=fyren).
dvander@1231
     1
/**
dvander@1231
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@1231
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1231
    28
 *
dvander@1231
    29
 * Version: $Id$
dvander@1231
    30
 */
dvander@1231
    31
dvander@1406
    32
#include <ITextParsers.h>
dvander@893
    33
#include "ChatTriggers.h"
dvander@893
    34
#include "sm_stringutil.h"
dvander@893
    35
#include "ConCmdManager.h"
dvander@1794
    36
#include "PlayerManager.h"
dvander@1925
    37
#include "HalfLife2.h"
dvander@3004
    38
#include "logic_bridge.h"
dvander@893
    39
dvander@1547
    40
/* :HACKHACK: We can't SH_DECL here because ConCmdManager.cpp does.
dvander@1547
    41
 * While the OB build only runs on MM:S 1.6.0+ (SH 5+), the older one 
dvander@1547
    42
 * can technically be compiled against any MM:S version after 1.4.2.
dvander@1547
    43
 */
ds@2400
    44
#if SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
    45
extern bool __SourceHook_FHRemoveConCommandDispatch(void *, bool, class fastdelegate::FastDelegate1<const CCommand &, void>);
faluco@1541
    46
extern int __SourceHook_FHAddConCommandDispatch(void *, ISourceHook::AddHookMode, bool, class fastdelegate::FastDelegate1<const CCommand &, void>);
faluco@1541
    47
#else
dvander@893
    48
extern bool __SourceHook_FHRemoveConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
dvander@1547
    49
#if SH_IMPL_VERSION >= 5
dvander@1547
    50
extern int __SourceHook_FHAddConCommandDispatch(void *, ISourceHook::AddHookMode, bool, class fastdelegate::FastDelegate0<void>);
dvander@1547
    51
#elif SH_IMPL_VERSION == 4
dvander@893
    52
extern int __SourceHook_FHAddConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
dvander@1547
    53
#elif SH_IMPL_VERSION == 3
dvander@904
    54
extern bool __SourceHook_FHAddConCommandDispatch(void *, bool, class fastdelegate::FastDelegate0<void>);
dvander@1547
    55
#endif //SH_IMPL_VERSION
ds@2400
    56
#endif //SE_ORANGEBOX
dvander@893
    57
dvander@893
    58
ChatTriggers g_ChatTriggers;
dvander@1794
    59
bool g_bSupressSilentFails = false;
dvander@893
    60
dvander@893
    61
ChatTriggers::ChatTriggers() : m_pSayCmd(NULL), m_bWillProcessInPost(false), 
dvander@1103
    62
	m_bTriggerWasSilent(false), m_ReplyTo(SM_REPLY_CONSOLE)
dvander@893
    63
{
dvander@893
    64
	m_PubTrigger = sm_strdup("!");
dvander@893
    65
	m_PrivTrigger = sm_strdup("/");
dvander@893
    66
	m_PubTriggerSize = 1;
dvander@893
    67
	m_PrivTriggerSize = 1;
dvander@1469
    68
	m_bIsChatTrigger = false;
dvander@893
    69
}
dvander@893
    70
dvander@897
    71
ChatTriggers::~ChatTriggers()
dvander@897
    72
{
dvander@897
    73
	delete [] m_PubTrigger;
dvander@897
    74
	m_PubTrigger = NULL;
dvander@897
    75
	delete [] m_PrivTrigger;
dvander@897
    76
	m_PrivTrigger = NULL;
dvander@897
    77
}
dvander@896
    78
dvander@896
    79
ConfigResult ChatTriggers::OnSourceModConfigChanged(const char *key, 
dvander@896
    80
													const char *value, 
dvander@896
    81
													ConfigSource source,
dvander@896
    82
													char *error, 
dvander@896
    83
													size_t maxlength)
dvander@896
    84
{
dvander@896
    85
	if (strcmp(key, "PublicChatTrigger") == 0)
dvander@896
    86
	{
dvander@896
    87
		delete [] m_PubTrigger;
dvander@896
    88
		m_PubTrigger = sm_strdup(value);
dvander@896
    89
		m_PubTriggerSize = strlen(m_PubTrigger);
dvander@896
    90
		return ConfigResult_Accept;
dvander@1794
    91
	}
dvander@1794
    92
	else if (strcmp(key, "SilentChatTrigger") == 0)
dvander@1794
    93
	{
dvander@896
    94
		delete [] m_PrivTrigger;
dvander@896
    95
		m_PrivTrigger = sm_strdup(value);
dvander@896
    96
		m_PrivTriggerSize = strlen(m_PrivTrigger);
dvander@896
    97
		return ConfigResult_Accept;
dvander@896
    98
	}
dvander@1794
    99
	else if (strcmp(key, "SilentFailSuppress") == 0)
dvander@1794
   100
	{
dvander@1794
   101
		g_bSupressSilentFails = strcmp(value, "yes") == 0;
dvander@1794
   102
		return ConfigResult_Accept;
dvander@1794
   103
	}
dvander@896
   104
dvander@896
   105
	return ConfigResult_Ignore;
dvander@896
   106
}
dvander@896
   107
dvander@1925
   108
void ChatTriggers::OnSourceModAllInitialized()
dvander@1925
   109
{
dvander@1925
   110
	m_pShouldFloodBlock = g_Forwards.CreateForward("OnClientFloodCheck", ET_Event, 1, NULL, Param_Cell);
dvander@1925
   111
	m_pDidFloodBlock = g_Forwards.CreateForward("OnClientFloodResult", ET_Event, 2, NULL, Param_Cell, Param_Cell);
dvander@1925
   112
}
dvander@1925
   113
dvander@1925
   114
void ChatTriggers::OnSourceModAllInitialized_Post()
dvander@1925
   115
{
dvander@3004
   116
	logicore.AddCorePhraseFile("antiflood.phrases");
dvander@1925
   117
}
dvander@1925
   118
dvander@893
   119
void ChatTriggers::OnSourceModGameInitialized()
dvander@893
   120
{
ds@2400
   121
	m_pSayCmd = FindCommand("say");
ds@2400
   122
	m_pSayTeamCmd = FindCommand("say_team");
dvander@893
   123
dvander@893
   124
	if (m_pSayCmd)
dvander@893
   125
	{
dvander@893
   126
		SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
dvander@893
   127
		SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Post, true);
dvander@893
   128
	}
dvander@897
   129
	if (m_pSayTeamCmd)
dvander@897
   130
	{
dvander@897
   131
		SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
dvander@897
   132
		SH_ADD_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Post, true);
dvander@897
   133
	}
dvander@893
   134
}
dvander@893
   135
dvander@893
   136
void ChatTriggers::OnSourceModShutdown()
dvander@893
   137
{
dvander@897
   138
	if (m_pSayTeamCmd)
dvander@897
   139
	{
dvander@897
   140
		SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Post, true);
dvander@897
   141
		SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayTeamCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
dvander@897
   142
	}
dvander@893
   143
	if (m_pSayCmd)
dvander@893
   144
	{
dvander@893
   145
		SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Post, true);
dvander@893
   146
		SH_REMOVE_HOOK_MEMFUNC(ConCommand, Dispatch, m_pSayCmd, this, &ChatTriggers::OnSayCommand_Pre, false);
dvander@893
   147
	}
dvander@1925
   148
dvander@1925
   149
	g_Forwards.ReleaseForward(m_pShouldFloodBlock);
dvander@1925
   150
	g_Forwards.ReleaseForward(m_pDidFloodBlock);
dvander@893
   151
}
dvander@893
   152
ds@2400
   153
#if SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
   154
void ChatTriggers::OnSayCommand_Pre(const CCommand &command)
faluco@1541
   155
{
faluco@1541
   156
#else
dvander@893
   157
void ChatTriggers::OnSayCommand_Pre()
dvander@893
   158
{
faluco@1541
   159
	CCommand command;
faluco@1541
   160
#endif
dvander@1934
   161
	int client;
dvander@1934
   162
	CPlayer *pPlayer;
dvander@1934
   163
	
dvander@1934
   164
	client = g_ConCmds.GetCommandClient();
dvander@1469
   165
	m_bIsChatTrigger = false;
dvander@1925
   166
	m_bWasFloodedMessage = false;
dvander@893
   167
dvander@893
   168
	/* The server console cannot do this */
dvander@1934
   169
	if (client == 0 || (pPlayer = g_Players.GetPlayerByIndex(client)) == NULL)
dvander@1934
   170
	{
dvander@1934
   171
		RETURN_META(MRES_IGNORED);
dvander@1934
   172
	}
dvander@1934
   173
dvander@1934
   174
	/* We guarantee the client is connected */
dvander@1934
   175
	if (!pPlayer->IsConnected())
dvander@893
   176
	{
dvander@893
   177
		RETURN_META(MRES_IGNORED);
dvander@893
   178
	}
dvander@893
   179
faluco@1541
   180
	const char *args = command.ArgS();
ds@1139
   181
	
ds@1139
   182
	if (!args)
ds@1139
   183
	{
ds@1139
   184
		RETURN_META(MRES_IGNORED);
ds@1139
   185
	}
dvander@893
   186
dvander@1925
   187
	/* Check if we need to block this message from being sent */
dvander@1925
   188
	if (ClientIsFlooding(client))
dvander@1925
   189
	{
dvander@1925
   190
		char buffer[128];
dvander@1925
   191
dvander@3004
   192
		if (!logicore.CoreTranslate(buffer, sizeof(buffer), "%T", 2, NULL, "Flooding the server", &client))
dvander@1925
   193
			UTIL_Format(buffer, sizeof(buffer), "You are flooding the server!");
dvander@1925
   194
dvander@1925
   195
		/* :TODO: we should probably kick people who spam too much. */
dvander@1925
   196
dvander@1925
   197
		char fullbuffer[192];
dvander@1925
   198
		UTIL_Format(fullbuffer, sizeof(fullbuffer), "[SM] %s", buffer);
dvander@1925
   199
		g_HL2.TextMsg(client, HUD_PRINTTALK, fullbuffer);
dvander@1925
   200
dvander@1925
   201
		m_bWasFloodedMessage = true;
dvander@1925
   202
dvander@1925
   203
		RETURN_META(MRES_SUPERCEDE);
dvander@1925
   204
	}
dvander@1925
   205
dvander@893
   206
	/* Handle quoted string sets */
dvander@893
   207
	bool is_quoted = false;
dvander@893
   208
	if (args[0] == '"')
dvander@893
   209
	{
dvander@893
   210
		args++;
dvander@893
   211
		is_quoted = true;
dvander@893
   212
	}
dvander@893
   213
dvander@893
   214
	bool is_trigger = false;
dvander@893
   215
	bool is_silent = false;
dvander@893
   216
dvander@893
   217
	/* Check for either trigger */
dvander@893
   218
	if (m_PubTriggerSize && strncmp(args, m_PubTrigger, m_PubTriggerSize) == 0)
dvander@893
   219
	{
dvander@893
   220
		is_trigger = true;
dvander@1103
   221
		args = &args[m_PubTriggerSize];
dvander@1925
   222
	} 
dvander@2607
   223
	else if (m_PrivTriggerSize && strncmp(args, m_PrivTrigger, m_PrivTriggerSize) == 0) 
dvander@1925
   224
	{
dvander@893
   225
		is_trigger = true;
dvander@893
   226
		is_silent = true;
dvander@1103
   227
		args = &args[m_PrivTriggerSize];
dvander@893
   228
	}
dvander@893
   229
dvander@893
   230
	if (!is_trigger)
dvander@893
   231
	{
dvander@893
   232
		RETURN_META(MRES_IGNORED);
dvander@893
   233
	}
dvander@893
   234
dvander@1103
   235
	/**
dvander@1103
   236
	 * Test if this is actually a command!
dvander@1103
   237
	 */
ds@2400
   238
	if (!PreProcessTrigger(PEntityOfEntIndex(client), args, is_quoted))
dvander@893
   239
	{
dvander@1794
   240
		CPlayer *pPlayer;
dvander@1794
   241
		if (is_silent 
dvander@1794
   242
			&& g_bSupressSilentFails 
dvander@1794
   243
			&& client != 0
dvander@1794
   244
			&& (pPlayer = g_Players.GetPlayerByIndex(client)) != NULL
dvander@1794
   245
			&& pPlayer->GetAdminId() != INVALID_ADMIN_ID)
dvander@1794
   246
		{
dvander@1794
   247
			RETURN_META(MRES_SUPERCEDE);
dvander@1794
   248
		}
dvander@893
   249
		RETURN_META(MRES_IGNORED);
dvander@893
   250
	}
dvander@893
   251
dvander@1469
   252
	m_bIsChatTrigger = true;
dvander@1469
   253
dvander@1103
   254
	/**
dvander@1103
   255
	 * We'll execute it in post.
dvander@1103
   256
	 */
dvander@1103
   257
	m_bWillProcessInPost = true;
dvander@1103
   258
	m_bTriggerWasSilent = is_silent;
dvander@1103
   259
dvander@1103
   260
	/* If we're silent, block */
dvander@1103
   261
	if (is_silent)
dvander@893
   262
	{
dvander@893
   263
		RETURN_META(MRES_SUPERCEDE);
dvander@893
   264
	}
dvander@893
   265
dvander@1103
   266
	/* Otherwise, let the command continue */
dvander@893
   267
	RETURN_META(MRES_IGNORED);
dvander@893
   268
}
dvander@893
   269
ds@2400
   270
#if SOURCE_ENGINE >= SE_ORANGEBOX
faluco@1541
   271
void ChatTriggers::OnSayCommand_Post(const CCommand &command)
faluco@1541
   272
#else
dvander@893
   273
void ChatTriggers::OnSayCommand_Post()
faluco@1541
   274
#endif
dvander@893
   275
{
dvander@1469
   276
	m_bIsChatTrigger = false;
dvander@1925
   277
	m_bWasFloodedMessage = false;
dvander@893
   278
	if (m_bWillProcessInPost)
dvander@893
   279
	{
dvander@893
   280
		/* Reset this for re-entrancy */
dvander@893
   281
		m_bWillProcessInPost = false;
dvander@1103
   282
		
dvander@1103
   283
		/* Execute the cached command */
dvander@893
   284
		int client = g_ConCmds.GetCommandClient();
dvander@1103
   285
		unsigned int old = SetReplyTo(SM_REPLY_CHAT);
ds@2400
   286
		serverpluginhelpers->ClientCommand(PEntityOfEntIndex(client), m_ToExecute);
dvander@1103
   287
		SetReplyTo(old);
dvander@893
   288
	}
dvander@893
   289
}
dvander@893
   290
dvander@1103
   291
bool ChatTriggers::PreProcessTrigger(edict_t *pEdict, const char *args, bool is_quoted)
dvander@893
   292
{
dvander@893
   293
	/* Extract a command.  This is kind of sloppy. */
dvander@893
   294
	char cmd_buf[64];
dvander@893
   295
	size_t cmd_len = 0;
dvander@893
   296
	const char *inptr = args;
dvander@893
   297
	while (*inptr != '\0' 
dvander@1406
   298
			&& !textparsers->IsWhitespace(inptr) 
dvander@935
   299
			&& *inptr != '"'
dvander@893
   300
			&& cmd_len < sizeof(cmd_buf) - 1)
dvander@893
   301
	{
dvander@893
   302
		cmd_buf[cmd_len++] = *inptr++;
dvander@893
   303
	}
dvander@893
   304
	cmd_buf[cmd_len] = '\0';
dvander@893
   305
dvander@1377
   306
	if (cmd_len == 0)
dvander@1377
   307
	{
dvander@1377
   308
		return false;
dvander@1377
   309
	}
dvander@1377
   310
dvander@893
   311
	/* See if we have this registered */
dvander@893
   312
	bool prepended = false;
dvander@893
   313
	if (!g_ConCmds.LookForSourceModCommand(cmd_buf))
dvander@893
   314
	{
dvander@893
   315
		/* Check if we had an "sm_" prefix */
dvander@893
   316
		if (strncmp(cmd_buf, "sm_", 3) == 0)
dvander@893
   317
		{
dvander@893
   318
			return false;
dvander@893
   319
		}
dvander@893
   320
dvander@893
   321
		/* Now, prepend.  Don't worry about the buffers.  This will 
dvander@893
   322
		 * work because the sizes are limited from earlier.
dvander@893
   323
		 */
dvander@893
   324
		char new_buf[80];
dvander@893
   325
		strcpy(new_buf, "sm_");
dvander@893
   326
		strncopy(&new_buf[3], cmd_buf, sizeof(new_buf)-3);
dvander@893
   327
dvander@893
   328
		/* Recheck */
dvander@893
   329
		if (!g_ConCmds.LookForSourceModCommand(new_buf))
dvander@893
   330
		{
dvander@893
   331
			return false;
dvander@893
   332
		}
dvander@893
   333
		
dvander@893
   334
		prepended = true;
dvander@893
   335
	}
dvander@893
   336
dvander@893
   337
	/* See if we need to do extra string manipulation */
dvander@893
   338
	if (is_quoted || prepended)
dvander@893
   339
	{
dvander@893
   340
		size_t len;
dvander@893
   341
dvander@893
   342
		/* Check if we need to prepend sm_ */
dvander@893
   343
		if (prepended)
dvander@893
   344
		{
dvander@1103
   345
			len = UTIL_Format(m_ToExecute, sizeof(m_ToExecute), "sm_%s", args);
dvander@893
   346
		} else {
dvander@1103
   347
			len = strncopy(m_ToExecute, args, sizeof(m_ToExecute));
dvander@893
   348
		}
dvander@893
   349
		
dvander@893
   350
		/* Check if we need to strip a quote */
dvander@893
   351
		if (is_quoted)
dvander@893
   352
		{
dvander@1103
   353
			if (m_ToExecute[len-1] == '"')
dvander@893
   354
			{
dvander@1103
   355
				m_ToExecute[--len] = '\0';
dvander@893
   356
			}
dvander@893
   357
		}
dvander@1103
   358
	} else {
dvander@1103
   359
		strncopy(m_ToExecute, args, sizeof(m_ToExecute));
dvander@893
   360
	}
dvander@893
   361
dvander@893
   362
	return true;
dvander@893
   363
}
dvander@893
   364
dvander@893
   365
unsigned int ChatTriggers::SetReplyTo(unsigned int reply)
dvander@893
   366
{
dvander@893
   367
	unsigned int old = m_ReplyTo;
dvander@893
   368
dvander@893
   369
	m_ReplyTo = reply;
dvander@893
   370
dvander@893
   371
	return old;
dvander@893
   372
}
dvander@893
   373
dvander@893
   374
unsigned int ChatTriggers::GetReplyTo()
dvander@893
   375
{
dvander@893
   376
	return m_ReplyTo;
dvander@893
   377
}
dvander@1469
   378
dvander@1469
   379
bool ChatTriggers::IsChatTrigger()
dvander@1469
   380
{
dvander@1469
   381
	return m_bIsChatTrigger;
dvander@1469
   382
}
dvander@1925
   383
dvander@1925
   384
bool ChatTriggers::ClientIsFlooding(int client)
dvander@1925
   385
{
dvander@1925
   386
	bool is_flooding = false;
dvander@1925
   387
dvander@1925
   388
	if (m_pShouldFloodBlock->GetFunctionCount() != 0)
dvander@1925
   389
	{
dvander@1925
   390
		cell_t res = 0;
dvander@1925
   391
dvander@1925
   392
		m_pShouldFloodBlock->PushCell(client);
dvander@1925
   393
		m_pShouldFloodBlock->Execute(&res);
dvander@1925
   394
dvander@1925
   395
		if (res != 0)
dvander@1925
   396
		{
dvander@1925
   397
			is_flooding = true;
dvander@1925
   398
		}
dvander@1925
   399
	}
dvander@1925
   400
dvander@1925
   401
	if (m_pDidFloodBlock->GetFunctionCount() != 0)
dvander@1925
   402
	{
dvander@1925
   403
		m_pDidFloodBlock->PushCell(client);
dvander@1925
   404
		m_pDidFloodBlock->PushCell(is_flooding ? 1 : 0);
dvander@1925
   405
		m_pDidFloodBlock->Execute(NULL);
dvander@1925
   406
	}
dvander@1925
   407
dvander@1925
   408
	return is_flooding;
dvander@1925
   409
}
dvander@1925
   410
dvander@1925
   411
bool ChatTriggers::WasFloodedMessage()
dvander@1925
   412
{
dvander@1925
   413
	return m_bWasFloodedMessage;
dvander@1925
   414
}