Crosspost cog seems done

cogs/basecog.py

@@ -9,10 +9,16 @@ import json
 class BaseCog(commands.Cog):
 	def __init__(self, bot):
 		self.bot = bot
-		self.listened_mod_react_message_ids = AgeBoundDict(timedelta(minutes=5), lambda message_id, age : age)
+		self.listened_mod_react_message_ids = AgeBoundDict(timedelta(minutes=5), lambda message_id, tpl : tpl[0])
 
-	def listen_for_reactions_to(self, message: Message) -> None:
-		self.listened_mod_react_message_ids[message.id] = message.created_at
+	def listen_for_reactions_to(self, message: Message, context = None) -> None:
+		"""
+		Registers a warning message as something a mod may react to to enact
+		some action. `context` will be passed back in `on_mod_react` and can be
+		any value that helps give the cog context about the action being
+		performed.
+		"""
+		self.listened_mod_react_message_ids[message.id] = (message.created_at, context)
 
 	@commands.Cog.listener()
 	async def on_raw_reaction_add(self, payload: RawReactionActionEvent):
@@ -41,20 +47,50 @@ class BaseCog(commands.Cog):
 		if not member.permissions_in(channel).ban_members:
 			# Not a mod
 			return
-		if self.listened_mod_react_message_ids.get(message.id) is None:
+		tpl = self.listened_mod_react_message_ids.get(message.id)
+		if tpl is None:
 			# Not a message we're listening for
 			return
-		await self.on_mod_react(message, payload.emoji)
+		context = tpl[1]
+		await self.on_mod_react(message, payload.emoji, context)
 
-	async def on_mod_react(self, message: Message, emoji: PartialEmoji) -> None:
+	async def on_mod_react(self, message: Message, emoji: PartialEmoji, context) -> None:
 		"""
 		Override point for getting a mod's emote on a bot message. Used to take
 		action on a warning, such as banning an offending user. This event is
 		only triggered for registered bot messages and reactions by members
-		with the proper permissions.
+		with the proper permissions. The given `context` value is whatever was
+		passed in `listen_to_reactions_to()`.
 		"""
 		pass
 
+	async def validate_param(self, context: commands.Context, param_name: str, value,
+		allowed_types: tuple = None,
+		min_value = None,
+		max_value = None) -> bool:
+		"""
+		Convenience method for validating a command parameter is of the expected
+		type and in the expected range. Bad values will cause a reply to be sent
+		to the original message and a False will be returned. If all checks
+		succeed, True will be returned.
+		"""
+		if allowed_types is not None and not isinstance(value, allowed_types):
+			if len(allowed_types) == 1:
+				await context.message.reply(f'⚠️ `{param_name}` must be of type ' +
+					f'{allowed_types[0]}.', mention_author=False)
+			else:
+				await context.message.reply(f'⚠️ `{param_name}` must be of types ' +
+					f'{allowed_types}.', mention_author=False)
+			return False
+		if min_value is not None and value < min_value:
+			await context.message.reply(f'⚠️ `{param_name}` must be >= {min_value}.',
+				mention_author=False)
+			return False
+		if max_value is not None and value > max_value:
+			await context.message.reply(f'⚠️ `{param_name}` must be <= {max_value}.',
+				mention_author=False)
+		return True
+
 	@classmethod
 	async def warn(cls, guild: Guild, message: str) -> Message:
 		"""

cogs/crosspostcog.py

@@ -1,6 +1,7 @@
 from discord import Guild, Message, PartialEmoji
 from discord.ext import commands
 from datetime import datetime, timedelta
+import math
 
 from rscollections import AgeBoundList, SizeBoundDict
 from cogs.basecog import BaseCog
@@ -21,26 +22,51 @@ class CrossPostCog(BaseCog):
 	STATE_KEY_RECENT_MESSAGES = "crosspost_recent_messages"
 	STATE_KEY_SPAM_CONTEXT = "crosspost_spam_context"
 
+	CONFIG_KEY_WARN_COUNT = "crosspost_warn_count"
+	CONFIG_KEY_BAN_COUNT = "crosspost_ban_count"
+	CONFIG_KEY_MIN_MESSAGE_LENGTH = "crosspost_min_message_length"
+	CONFIG_KEY_MESSAGE_AGE = "crosspost_message_age"
+
+	MIN_WARN_COUNT = 2
+	MIN_BAN_COUNT = 2
+	MIN_MESSAGE_LENGTH = 0
+	MIN_TIME_SPAN = 1
+
 	def __init__(self, bot):
 		super().__init__(bot)
-		self.max_recent_message_age = timedelta(minutes=2)
 		self.max_spam_contexts = 12
-		self.warn_messages_per_user = 3
-		self.ban_messages_per_user = 5
-		self.min_message_length = 10
+
+	# Config
+
+	def __warn_count(self, guild: Guild) -> int:
+		return Storage.get_config_value(guild, self.CONFIG_KEY_WARN_COUNT) or 3
+
+	def __ban_count(self, guild: Guild) -> int:
+		return Storage.get_config_value(guild, self.CONFIG_KEY_BAN_COUNT) or 9999
+
+	def __min_message_length(self, guild: Guild) -> int:
+		return Storage.get_config_value(guild, self.CONFIG_KEY_MIN_MESSAGE_LENGTH) or 0
+
+	def __message_age_seconds(self, guild: Guild) -> int:
+		return Storage.get_config_value(guild, self.CONFIG_KEY_MESSAGE_AGE) or 120
 
 	async def __record_message(self, message: Message) -> None:
 		if message.author.permissions_in(message.channel).ban_members:
 			# User exempt from spam detection
 			return
+		if len(message.content) < self.__min_message_length(message.guild):
+			# Message too short to count towards spam total
+			return
+		max_age = timedelta(seconds=self.__message_age_seconds(message.guild))
 		recent_messages = Storage.get_state_value(message.guild, self.STATE_KEY_RECENT_MESSAGES) \
-			or AgeBoundList(self.max_recent_message_age, lambda index, message : message.created_at)
+			or AgeBoundList(max_age, lambda index, message : message.created_at)
+		recent_messages.max_age = max_age
 		recent_messages.append(message)
 		Storage.set_state_value(message.guild, self.STATE_KEY_RECENT_MESSAGES, recent_messages)
 
 		# Get all recent messages by user
 		member_messages = [m for m in recent_messages if m.author.id == message.author.id]
-		if len(member_messages) < self.warn_messages_per_user:
+		if len(member_messages) < self.__warn_count(message.guild):
 			return
 
 		# Look for repeats
@@ -51,7 +77,7 @@ class CrossPostCog(BaseCog):
 			count = (hash_to_count.get(key) or 0) + 1
 			hash_to_count[key] = count
 			max_count = max(max_count, count)
-		if max_count < self.warn_messages_per_user:
+		if max_count < self.__warn_count(message.guild):
 			return
 
 		# Handle the spam
@@ -59,7 +85,7 @@ class CrossPostCog(BaseCog):
 			or SizeBoundDict(self.max_spam_contexts, lambda key, context : context.age)
 		Storage.set_state_value(message.guild, self.STATE_KEY_SPAM_CONTEXT, spam_lookup)
 		for message_hash, count in hash_to_count.items():
-			if count < self.warn_messages_per_user:
+			if count < self.__warn_count(message.guild):
 				continue
 			key = f'{message.author.id}|{message_hash}'
 			context = spam_lookup.get(key)
@@ -75,20 +101,20 @@ class CrossPostCog(BaseCog):
 
 	async def __update_from_context(self, context: SpamContext):
 		content = next(iter(context.messages)).content
-		if len(context.messages) > self.ban_messages_per_user:
+		if len(context.messages) >= self.__ban_count(context.member.guild):
 			if not context.is_banned:
 				await context.member.ban(reason='Posting same message repeatedly', delete_message_days=1)
 				msg = f'User {context.member.mention} auto banned for ' + \
 					'crosspost spamming.\n' + \
-					'> {content}'
+					f'> {content}'
 				if context.warning_message:
 					await self.update_warn(context.warning_message, msg)
 					await context.warning_message.clear_reaction('🗑')
 					await context.warning_message.clear_reaction('👢')
 					await context.warning_message.clear_reaction('🚫')
 				else:
-					self.warning_message = await self.warn(context.member.guild, msg)
-		elif len(context.messages) > self.warn_messages_per_user:
+					context.warning_message = await self.warn(context.member.guild, msg)
+		elif len(context.messages) >= self.__warn_count(context.member.guild):
 			content = next(iter(context.messages)).content
 			msg = f'User {context.member.mention} has posted the exact same ' + \
 				f'message {len(context.messages)} times.\n' + \
@@ -111,7 +137,7 @@ class CrossPostCog(BaseCog):
 				await self.update_warn(context.warning_message, msg)
 			else:
 				context.warning_message = await self.warn(context.member.guild, msg)
-				self.listen_for_reactions_to(context.warning_message)
+				self.listen_for_reactions_to(context.warning_message, context)
 			if can_delete:
 				await context.warning_message.add_reaction('🗑')
 			else:
@@ -125,27 +151,6 @@ class CrossPostCog(BaseCog):
 			else:
 				await context.warning_message.clear_reaction('🚫')
 
-	def __context_for_warning_message(self, message: Message) -> SpamContext:
-		spam_lookup = Storage.get_state_value(message.guild, self.STATE_KEY_SPAM_CONTEXT)
-		if spam_lookup is None:
-			return
-		for _, context in spam_lookup.items():
-			if context.warning_message.id == message.id:
-				return context
-		return None
-
-	async def on_mod_react(self, message: Message, emoji: PartialEmoji) -> None:
-		context = self.__context_for_warning_message(message)
-		if context is None:
-			return
-
-		if emoji.name == '🗑':
-			await self.__delete_messages(context)
-		elif emoji.name == '👢':
-			await self.__kick(context)
-		elif emoji.name == '🚫':
-			await self.__ban(context)
-
 	async def __delete_messages(self, context: SpamContext) -> None:
 		for message in context.messages - context.deleted_messages:
 			await message.delete()
@@ -164,6 +169,151 @@ class CrossPostCog(BaseCog):
 		context.is_banned = True
 		await self.__update_from_context(context)
 
+	async def on_mod_react(self, message: Message, emoji: PartialEmoji, context: SpamContext) -> None:
+		if context is None:
+			return
+
+		if emoji.name == '🗑':
+			await self.__delete_messages(context)
+		elif emoji.name == '👢':
+			await self.__kick(context)
+		elif emoji.name == '🚫':
+			await self.__ban(context)
+
 	@commands.Cog.listener()
 	async def on_message(self, message: Message):
 		await self.__record_message(message)
+
+	# -- Commands -----------------------------------------------------------
+
+	@commands.group(
+		brief='Manages crosspost/repeated post detection and handling',
+	)
+	@commands.has_permissions(ban_members=True)
+	@commands.guild_only()
+	async def crosspost(self, context: commands.Context):
+		'Command group'
+		if context.invoked_subcommand is None:
+			await context.send_help()
+
+	@crosspost.command(
+		name='setwarncount',
+		brief='Sets the number of duplicate messages to trigger a mod warning',
+		description='If the same user posts the exact same message ' +
+			'content this many times a warning will be posted to the mods,' +
+			'even if the messages are posted in different channels.',
+		usage='<warn_count:int>',
+	)
+	async def joinraid_setwarncount(self, context: commands.Context,
+			warn_count: int):
+		if not await self.validate_param(context, 'warn_count', warn_count,
+			allowed_types=(int, ), min_value=self.MIN_WARN_COUNT):
+			return
+		Storage.set_config_value(context.guild, self.CONFIG_KEY_WARN_COUNT, warn_count)
+		await context.message.reply(f'✅ Mods will be warned if a user posts ' +
+			f'the exact same message {warn_count} or more times within ' +
+			f'{self.__message_age_seconds(context.guild)} seconds.',
+			mention_author=False)
+
+	@crosspost.command(
+		name='getwarncount',
+		brief='Returns the number of duplicate messages to trigger a mod warning',
+	)
+	async def joinraid_getwarncount(self, context: commands.Context):
+		await context.message.reply(f'ℹ️ Mods will be warned if a user posts ' +
+			f'the exact same message {self.__warn_count(context.guild)} or more ' +
+			f'times within {self.__message_age_seconds(context.guild)} seconds.',
+			mention_author=False)
+
+	@crosspost.command(
+		name='setbancount',
+		brief='Sets the number of duplicate messages to trigger an automatic ban',
+		description='If the same user posts the exact same message ' +
+			'content this many times they will be automatically banned and the ' +
+			'mods will be alerted.',
+		usage='<ban_count:int>',
+	)
+	async def joinraid_setbancount(self, context: commands.Context,
+			ban_count: int):
+		if not await self.validate_param(context, 'ban_count', ban_count,
+			allowed_types=(int, ), min_value=self.MIN_BAN_COUNT):
+			return
+		Storage.set_config_value(context.guild, self.CONFIG_KEY_BAN_COUNT, ban_count)
+		await context.message.reply(f'✅ Users will be banned if they post ' +
+			f'the exact same message {ban_count} or more times within ' +
+			f'{self.__message_age_seconds(context.guild)} seconds.',
+			mention_author=False)
+
+	@crosspost.command(
+		name='getbancount',
+		brief='Returns the number of duplicate messages to trigger an automatic ban',
+	)
+	async def joinraid_getbancount(self, context: commands.Context):
+		await context.message.reply(f'ℹ️ Users will be banned if they post ' +
+			f'the exact same message {self.__ban_count(context.guild)} or more ' +
+			f'times within {self.__message_age_seconds(context.guild)} seconds.',
+			mention_author=False)
+
+	@crosspost.command(
+		name='setminlength',
+		brief='Sets the minimum number of characters for a message to count toward spamming',
+		description='Messages shorter than this number of characters will not ' +
+			'count toward spam counts. This helps prevent flagging common, ' +
+			'frequent, short responses like "lol". A value of 0 counts all messages.',
+		usage='<min_length:int>',
+	)
+	async def joinraid_setminlength(self, context: commands.Context,
+			min_length: int):
+		if not await self.validate_param(context, 'min_length', min_length,
+			allowed_types=(int, ), min_value=self.MIN_MESSAGE_LENGTH):
+			return
+		Storage.set_config_value(context.guild, self.CONFIG_KEY_MIN_MESSAGE_LENGTH, min_length)
+		if min_length == 0:
+			await context.message.reply(f'✅ All messages will count against ' +
+				'spam counts, regardless of length.', mention_author=False)
+		else:
+			await context.message.reply(f'✅ Only messages {min_length} ' +
+				f'characters or longer will count against spam counts.',
+				mention_author=False)
+
+	@crosspost.command(
+		name='getminlength',
+		brief='Returns the number of duplicate messages to trigger an automatic ban',
+	)
+	async def joinraid_getminlength(self, context: commands.Context):
+		min_length = self.__min_message_length(context.guild)
+		if min_length == 0:
+			await context.message.reply(f'ℹ️ All messages will count against ' +
+				'spam counts, regardless of length.', mention_author=False)
+		else:
+			await context.message.reply(f'ℹ️ Only messages {min_length} ' +
+				f'characters or longer will count against spam counts.',
+				mention_author=False)
+
+	@crosspost.command(
+		name='settimewindow',
+		brief='Sets the length of time recent messages are checked for duplicates',
+		description='Repeated messages are only checked against recent ' +
+			'messages. This sets the length of that window, in seconds. Lower ' +
+			'values save memory and prevent false positives.',
+		usage='<seconds:int>',
+	)
+	async def joinraid_settimewindow(self, context: commands.Context,
+			seconds: int):
+		if not await self.validate_param(context, 'seconds', seconds,
+			allowed_types=(int, ), min_value=self.MIN_TIME_SPAN):
+			return
+		Storage.set_config_value(context.guild, self.CONFIG_KEY_MESSAGE_AGE, seconds)
+		await context.message.reply(f'✅ Only messages in the past {seconds} ' +
+			f'seconds will be checked for duplicates.',
+			mention_author=False)
+
+	@crosspost.command(
+		name='gettimewindow',
+		brief='Returns the length of time recent messages are checked for duplicates',
+	)
+	async def joinraid_gettimewindow(self, context: commands.Context):
+		seconds = self.__message_age_seconds(context.guild)
+		await context.message.reply(f'ℹ️ Only messages in the past {seconds} ' +
+			'seconds will be checked for duplicates.',
+			mention_author=False)

rocketbot.py

@@ -10,7 +10,7 @@ from discord.ext import commands
 
 from config import CONFIG
 from cogs.configcog import ConfigCog
-# from cogs.crosspostcog import CrossPostCog
+from cogs.crosspostcog import CrossPostCog
 from cogs.generalcog import GeneralCog
 from cogs.joinraidcog import JoinRaidCog
 
@@ -25,6 +25,6 @@ bot = Rocketbot(command_prefix=CONFIG['commandPrefix'], intents=intents)
 bot.add_cog(GeneralCog(bot))
 bot.add_cog(ConfigCog(bot))
 bot.add_cog(JoinRaidCog(bot))
-# bot.add_cog(CrossPostCog(bot))
+bot.add_cog(CrossPostCog(bot))
 bot.run(CONFIG['clientToken'], bot=True, reconnect=True)
 print('\nBot aborted')