Adding more log cog options, better excludes certain users and channels from events

.gitignore

@@ -120,6 +120,7 @@ dmypy.json
 # Rocketbot stuff
 /config.py
 /config/**
+kickstarter.sqlite3
 
 # PyCharm
 .idea

rocketbot/cogs/helpcog.py

@@ -367,7 +367,8 @@ class HelpCog(BaseCog, name='Help'):
 				if not param.required:
 					text += '['
 					optional_nesting += 1
-				text += f'_{param.name}_'
+				escaped_param_name = param.name.replace('_', '\\_')
+				text += f'_{escaped_param_name}_'
 			if optional_nesting > 0:
 				text += ']' * optional_nesting
 		text += f'\n\n{command_or_group.description}'

rocketbot/cogs/logcog.py

@@ -3,16 +3,14 @@ Cog for detecting large numbers of guild joins in a short period of time.
 """
 import difflib
 import re
-from collections.abc import Callable, Sequence
+from collections.abc import Callable
 from datetime import datetime, timedelta, timezone
 from typing import Any
 
 from discord import (
 	AuditLogAction,
 	AuditLogEntry,
-	Emoji,
 	Guild,
-	GuildSticker,
 	Invite,
 	Member,
 	Message,
@@ -20,7 +18,6 @@ from discord import (
 	RawMessageDeleteEvent,
 	RawMessageUpdateEvent,
 	Role,
-	Thread,
 	User,
 )
 from discord.abc import GuildChannel
@@ -31,7 +28,7 @@ from discord.utils import escape_markdown
 
 from config import CONFIG
 from rocketbot.cogs.basecog import BaseCog, BotMessage, CogSetting
-from rocketbot.storage import Storage
+from rocketbot.storage import ConfigKey, Storage
 from rocketbot.utils import dump_stacktrace, norm_datetime
 
 
@@ -62,6 +59,41 @@ class LoggingCog(BaseCog, name='Logging'):
 		brief='logging',
 		description='Whether this module is enabled for a guild.',
 	)
+	SETTING_EDITS_ENABLED = CogSetting(
+		'edits',
+		bool,
+		default_value=True,
+		brief='whether to log message edit events',
+		description='Whether to log member message edits.'
+	)
+	SETTING_DELETES_ENABLED = CogSetting(
+		'deletes',
+		bool,
+		default_value=True,
+		brief='whether to log message deletion events',
+		description='Whether to log member message deletions.'
+	)
+	SETTING_JOIN_ENABLED = CogSetting(
+		'joins',
+		bool,
+		default_value=True,
+		brief='whether to log members joining the server',
+		description='Whether to log members joining the server.'
+	)
+	SETTING_LEAVE_ENABLED = CogSetting(
+		'leaves',
+		bool,
+		default_value=True,
+		brief='whether to log members leaving the server',
+		description='Whether to log members leaving the server.'
+	)
+	SETTING_MEMBER_UPDATES_ENABLED = CogSetting(
+		'member_updates',
+		bool,
+		default_value=True,
+		brief='whether to log changes to member details',
+		description='Whether to log changes to member roles, flags, display names, etc.'
+	)
 
 	STATE_EVENT_BUFFER = 'LoggingCog.eventBuffer'
 
@@ -71,13 +103,48 @@ class LoggingCog(BaseCog, name='Logging'):
 			config_prefix='logging',
 			short_description='Manages event logging.',
 		)
-		self.add_setting(LoggingCog.SETTING_ENABLED)
+		self.add_setting(Self.SETTING_ENABLED)
+		self.add_setting(Self.SETTING_EDITS_ENABLED)
+		self.add_setting(Self.SETTING_DELETES_ENABLED)
+		self.add_setting(Self.SETTING_JOIN_ENABLED)
+		self.add_setting(Self.SETTING_LEAVE_ENABLED)
+		self.add_setting(Self.SETTING_MEMBER_UPDATES_ENABLED)
 		self.flush_buffers.start()
 		self.buffered_guilds: set[Guild] = set()
 
+	# @overload
 	def cog_unload(self) -> None:
 		self.flush_buffers.cancel()
 
+	def __is_cog_disabled(self, guild: Guild | None) -> bool:
+		"""Whether this cog is disabled for a guild."""
+		return guild is None or not self.get_guild_setting(guild, Self.SETTING_ENABLED)
+	def __is_edits_disabled(self, guild: Guild | None) -> bool:
+		"""Whether logging message edit events is disabled for a guild."""
+		return guild is None or self.__is_cog_disabled(guild) or not self.get_guild_setting(guild, Self.SETTING_EDITS_ENABLED)
+	def __is_deletes_disabled(self, guild: Guild | None) -> bool:
+		"""Whether logging message delete events is disabled for a guild."""
+		return guild is None or self.__is_cog_disabled(guild) or not self.get_guild_setting(guild, Self.SETTING_DELETES_ENABLED)
+	def __is_joins_disabled(self, guild: Guild | None) -> bool:
+		"""Whether logging member join events is disabled for a guild."""
+		return guild is None or self.__is_cog_disabled(guild) or not self.get_guild_setting(guild, Self.SETTING_JOIN_ENABLED)
+	def __is_leaves_disabled(self, guild: Guild | None) -> bool:
+		"""Whether logging member departure events is disabled for a guild."""
+		return guild is None or self.__is_cog_disabled(guild) or not self.get_guild_setting(guild, Self.SETTING_LEAVE_ENABLED)
+	def __is_member_updates_disabled(self, guild: Guild | None) -> bool:
+		"""Whether logging member profile updates is disabled for a guild."""
+		return guild is None or self.__is_cog_disabled(guild) or not self.get_guild_setting(guild, Self.SETTING_MEMBER_UPDATES_ENABLED)
+	def __is_excluded_user(self, user: User | None) -> bool:
+		"""Whether member events should be ignored for the given user."""
+		return user is None or \
+			user.bot or \
+			user.id == self.bot.user.id
+	def __is_excluded_channel(self, channel: GuildChannel | None) -> bool:
+		"""Whether message events should be ignored in the given channel."""
+		if channel is None: return True
+		warning_channel_id = Storage.get_config_value(channel.guild, ConfigKey.WARNING_CHANNEL_ID)
+		return channel.id == warning_channel_id
+
 	# Events - Channels
 
 	@Cog.listener()
@@ -90,8 +157,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_channel_delete
 		"""
 		guild = channel.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Channel **{channel.name}** deleted.'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
 		await bot_message.update()
@@ -106,8 +173,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_channel_create
 		"""
 		guild = channel.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Channel **{channel.name}** created. {channel.mention}'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
 		await bot_message.update()
@@ -121,8 +188,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_channel_update
 		"""
 		guild = after.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		changes = []
 		if after.name != before.name:
 			changes.append(f'Name: `{before.name}` -> `{after.name}`')
@@ -145,25 +212,25 @@ class LoggingCog(BaseCog, name='Logging'):
 
 	# Events - Guilds
 
-	@Cog.listener()
-	async def on_guild_available(self, guild: Guild) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_guild_available(self, guild: Guild) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_guild_unavailable(self, guild: Guild) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_guild_unavailable(self, guild: Guild) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_guild_update(self, before: Guild, after: Guild) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_guild_update(self, before: Guild, after: Guild) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_guild_emojis_update(self, guild: Guild, before: Sequence[Emoji], after: Sequence[Emoji]) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_guild_emojis_update(self, guild: Guild, before: Sequence[Emoji], after: Sequence[Emoji]) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_guild_stickers_update(self, guild: Guild, before: Sequence[GuildSticker], after: Sequence[GuildSticker]) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_guild_stickers_update(self, guild: Guild, before: Sequence[GuildSticker], after: Sequence[GuildSticker]) -> None:
+	# 	pass
 
 	@Cog.listener()
 	async def on_invite_create(self, invite: Invite) -> None:
@@ -173,8 +240,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_invite_create
 		"""
 		guild = invite.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Invite code `{invite.code}` created by {self.__describe_user(invite.inviter)}. '
 		if invite.max_age == 0:
 			text += "Doesn't expire."
@@ -191,8 +258,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_invite_delete
 		"""
 		guild = invite.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		if invite.inviter:
 			text = f'Invite code `{invite.code}` deleted. Originally created by {self.__describe_user(invite.inviter)}.'
 		else:
@@ -212,11 +279,10 @@ class LoggingCog(BaseCog, name='Logging'):
 		Requires Members privileged intent.
 		"""
 		guild = member.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_joins_disabled(guild): return
+
 		flags = []
 		noteworthy = False
-
 		badge_info_link = 'https://support.discord.com/hc/en-us/articles/360035962891-Profile-Badges-101'
 
 		# Highest priority - should flag mods to be aware
@@ -306,8 +372,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		Requires Members privileged intent.
 		"""
 		guild = member.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		is_kick = False
 		kicker = None
 		kick_reason = None
@@ -323,6 +389,7 @@ class LoggingCog(BaseCog, name='Logging'):
 			else:
 				text = f'Member kicked from the server: {self.__describe_user(member)}'
 		else:
+			if self.__is_leaves_disabled(guild): return
 			text = f'Member left server: {self.__describe_user(member)}'
 		if kick_reason:
 			text += f'\nReason: "{kick_reason}"'
@@ -347,8 +414,9 @@ class LoggingCog(BaseCog, name='Logging'):
 		Requires Members privileged intent.
 		"""
 		guild = after.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_member_updates_disabled(guild): return
+		if self.__is_excluded_user(after): return
+
 		changes = []
 		noteworthy = False
 		if after.nick != before.nick:
@@ -427,12 +495,11 @@ class LoggingCog(BaseCog, name='Logging'):
 
 		Requires Members privileged intent.
 		"""
-		if hasattr(after, 'guild'):
-			guild = after.guild
-		else:
-			return
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if not hasattr(after, 'guild'): return
+		guild = after.guild
+		if self.__is_member_updates_disabled(guild): return
+		if self.__is_excluded_user(after): return
+
 		changes = []
 		before_avatar_url = before.avatar.url if before.avatar else None
 		after_avatar_url = after.avatar.url if after.avatar else None
@@ -454,8 +521,8 @@ class LoggingCog(BaseCog, name='Logging'):
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_member_ban
 		"""
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		banner = None
 		ban_reason = None
 		entry = await self.__find_audit_entry(user, AuditLogAction.ban)
@@ -495,8 +562,8 @@ class LoggingCog(BaseCog, name='Logging'):
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_member_unban
 		"""
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Member {self.__describe_user(user)} unbanned'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
 		await bot_message.update()
@@ -550,6 +617,10 @@ class LoggingCog(BaseCog, name='Logging'):
 
 		Content fields blank without MessageContent privileged intent.
 		"""
+		# if self.__is_cog_disabled(message.guild): return
+		# if self.__is_excluded_channel(message.channel): return
+		# if self.__is_excluded_user(message.author): return
+
 		# print(f"on_message:"
 		# 	f"\n\tid: {message.id}"
 		# 	f"\n\tauthor: {message.author.name}"
@@ -584,11 +655,10 @@ class LoggingCog(BaseCog, name='Logging'):
 		Content fields blank without MessageContent privileged intent.
 		"""
 		guild = after.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
-		if after.author.id == self.bot.user.id:
-			return
+		if self.__is_edits_disabled(guild): return
+		if self.__is_excluded_user(after.author): return
 		channel = after.channel
+		if self.__is_excluded_channel(channel): return
 
 		self.__buffer_event(guild, 'edit', BufferedMessageEditEvent(guild, channel, before, after))
 
@@ -618,16 +688,11 @@ class LoggingCog(BaseCog, name='Logging'):
 
 		Content fields blank without MessageContent privileged intent.
 		"""
-		if payload.cached_message:
-			return  # already handled by on_message_edit
+		if payload.cached_message: return  # already handled by on_message_edit
 		guild = self.bot.get_guild(payload.guild_id) or await self.bot.fetch_guild(payload.guild_id)
-		if not guild:
-			return
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if not guild or self.__is_edits_disabled(guild): return
 		channel = guild.get_channel(payload.channel_id) or await guild.fetch_channel(payload.channel_id)
-		if not channel:
-			return
+		if not channel or self.__is_excluded_channel(channel): return
 
 		self.__buffer_event(guild, 'edit', BufferedMessageEditEvent(
 			guild, channel, None, payload.message, payload.data))
@@ -728,20 +793,16 @@ class LoggingCog(BaseCog, name='Logging'):
 		Content fields blank without MessageContent privileged intent.
 		"""
 		message = payload.cached_message
-		if message and message.author.id == self.bot.user.id:
-			return
+		if message and self.__is_excluded_user(message.author): return
 		guild = (message.guild if message else None) or \
 				self.bot.get_guild(payload.guild_id) or \
 				await self.bot.fetch_guild(payload.guild_id)
-		if guild is None:
-			return
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if guild is None or self.__is_deletes_disabled(guild): return
 		channel = (message.channel if message else None) or \
 				  self.bot.get_channel(payload.channel_id) or \
 				  await guild.fetch_channel(payload.channel_id)
-		if channel is None:
-			return
+		if channel is None or self.__is_excluded_channel(channel): return
+
 		self.__buffer_event(guild, 'delete', BufferedMessageDeleteEvent(guild, channel, payload.message_id, message))
 
 	@Cog.listener()
@@ -759,11 +820,11 @@ class LoggingCog(BaseCog, name='Logging'):
 		Content fields blank without MessageContent privileged intent.
 		"""
 		guild = self.bot.get_guild(payload.guild_id) or await self.bot.fetch_guild(payload.guild_id)
-		if not guild:
-			return
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if not guild: return
+		if self.__is_deletes_disabled(guild): return
 		channel = guild.get_channel(payload.channel_id) or await guild.fetch_channel(payload.channel_id)
+		if self.__is_excluded_channel(channel): return
+
 		for message_id in payload.message_ids:
 			message = None
 			for cached_message in payload.cached_messages:
@@ -836,8 +897,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_role_create
 		"""
 		guild = role.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Role created: **{role.name}**'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
 		await bot_message.update()
@@ -852,8 +913,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_role_delete
 		"""
 		guild = role.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		text = f'Role removed: **{role.name}**'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
 		await bot_message.update()
@@ -866,8 +927,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_guild_role_update
 		"""
 		guild = after.guild
-		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
-			return
+		if self.__is_cog_disabled(guild): return
+
 		changes = []
 		if after.name != before.name:
 			changes.append(f'Name: `{before.name}` -> `{after.name}`')
@@ -901,17 +962,17 @@ class LoggingCog(BaseCog, name='Logging'):
 
 	# Events - Threads
 
-	@Cog.listener()
-	async def on_thread_create(self, thread: Thread) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_thread_create(self, thread: Thread) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_thread_update(self, before: Thread, after: Thread) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_thread_update(self, before: Thread, after: Thread) -> None:
+	# 	pass
 
-	@Cog.listener()
-	async def on_thread_delete(self, thread: Thread) -> None:
-		pass
+	# @Cog.listener()
+	# async def on_thread_delete(self, thread: Thread) -> None:
+	# 	pass
 
 
 	# ------------------------------------------------------------------------
@@ -1000,3 +1061,5 @@ class LoggingCog(BaseCog, name='Logging'):
 			else:
 				d[key] = [elem]
 		return d
+
+Self = LoggingCog