Updates to logging member joins and member updates

rocketbot/cogs/logcog.py

@@ -29,6 +29,7 @@ from discord.ext import tasks
 from discord.ext.commands import Cog
 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.utils import dump_stacktrace, norm_datetime
@@ -213,58 +214,83 @@ class LoggingCog(BaseCog, name='Logging'):
 		guild = member.guild
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
 			return
-		text = f'Member joined server: {self.__describe_user(member)}.'
 		flags = []
 		noteworthy = False
 
-		if member.flags.did_rejoin:
-			flags.append('Rejoined this server')
-
-		if member.public_flags.active_developer:
-			flags.append('Is an active developer')
-		if member.public_flags.hypesquad:
-			flags.append('Is a HypeSquad Events member')
-		if member.public_flags.hypesquad_bravery:
-			flags.append('Is a HypeSquad Bravery member')
-		if member.public_flags.hypesquad_brilliance:
-			flags.append('Is a HypeSquad Brilliance member')
-		if member.public_flags.hypesquad_balance:
-			flags.append('Is a HypeSquad Balance member')
-		if member.public_flags.early_supporter:
-			flags.append('Is an early supporter')
+		badge_info_link = 'https://support.discord.com/hc/en-us/articles/360035962891-Profile-Badges-101'
 
+		# Highest priority - should flag mods to be aware
 		if member.public_flags.spammer:
-			flags.append('**Is flagged as a spammer**')
+			flags.append(f"{CONFIG['warning_emoji']} **Is flagged as a spammer by Discord**")
 			noteworthy = True
-		if member.public_flags.discord_certified_moderator:
-			flags.append('**Is a Discord Certified Moderator**')
+		if member.flags.automod_quarantined_username:
+			flags.append(f"{CONFIG['warning_emoji']} **Quarantined by AutoMod for their username**")
 			noteworthy = True
-		if member.public_flags.early_verified_bot_developer:
-			flags.append('**Is a verified bot developer**')
+		if member.flags.automod_quarantined_guild_tag:
+			flags.append(f"{CONFIG['warning_emoji']} **Quarantined by AutoMod for their server tag**")
 			noteworthy = True
 		if member.public_flags.verified_bot:
-			flags.append('**Is a verified bot**')
-			noteworthy = True
-		if member.public_flags.bug_hunter or member.public_flags.bug_hunter_level_2:
-			flags.append('**Is a bug hunter**')
+			flags.append(f"{CONFIG['info_emoji']} **Is a verified bot**")
 			noteworthy = True
 		if member.public_flags.system:
-			flags.append('**Is a Discord system user**')
+			flags.append(f"{CONFIG['info_emoji']} **Is a Discord system user**")
 			noteworthy = True
 		if member.public_flags.staff:
-			flags.append('**Is Discord staff**')
+			flags.append(f"{CONFIG['info_emoji']} **Is Discord staff**")
 			noteworthy = True
+
+		# Interesting but doesn't need flagging
 		if member.public_flags.partner:
-			flags.append('**Is a Discord partner**')
-			noteworthy = True
+			flags.append(f"{CONFIG['info_emoji']} **Is a Discord partner**")
 
+		# Guild-specific
+		if member.flags.did_rejoin:
+			flags.append('Rejoined this server')
+		if member.flags.guest:
+			flags.append('Guest (can only access voice channel they were invited to)')
+		if member.flags.bypasses_verification:
+			flags.append('Can bypass guild verification steps')
+		if member.flags.completed_home_actions:
+			flags.append('Completed guild Server Guide actions')
+		elif member.flags.started_home_actions:
+			flags.append('Started guild Server Guide actions')
+		if member.flags.completed_onboarding:
+			flags.append('Completed guild onboarding')
+		elif member.flags.started_onboarding:
+			flags.append('Started guild onboarding')
+		# member.flags.dm_settings_upsell_acknowledged - no idea what the "DM settings upsell" is
+
+		# Trivia
+		if member.public_flags.verified_bot_developer:
+			flags.append('In an Early Verified Bot Developer')
+		elif member.public_flags.active_developer:
+			flags.append('Is an active developer')
+		if member.public_flags.hypesquad_bravery:
+			flags.append(f'Was a HypeSquad Bravery member ([info](<{badge_info_link}>))')
+		elif member.public_flags.hypesquad_brilliance:
+			flags.append(f'Was a HypeSquad Brilliance member ([info](<{badge_info_link}>))')
+		elif member.public_flags.hypesquad_balance:
+			flags.append(f'Was a HypeSquad Balance member ([info](<{badge_info_link}>))')
+		elif member.public_flags.hypesquad:
+			flags.append(f'Was a HypeSquad Events member ([info](<{badge_info_link}>))')
+		if member.public_flags.early_supporter:
+			flags.append(f'Was a Nitro early supporter ([info](<{badge_info_link}>))')
+		if member.public_flags.team_user:
+			flags.append('Is a Team User')
+		if member.public_flags.bug_hunter_level_2:
+			flags.append('Is a Discord bug hunter level 2')
+		elif member.public_flags.bug_hunter:
+			flags.append('Is a Discord bug hunter')
+		if member.public_flags.discord_certified_moderator:
+			flags.append('Was a Discord Certified Moderator')
+		if member.public_flags.early_verified_bot_developer:
+			flags.append('Is a verified bot developer')
+		# public_flags.bot_http_interactions isn't interesting
+
+		text = f"Member joined server: {self.__describe_user(member, tag=noteworthy)}"
 		if len(flags) > 0:
-			text += '\n* ' + '\n* '.join(flags)
-		if noteworthy:
-			text += f'\n\nLink: {member.mention}'
-			bot_message = BotMessage(guild, text, BotMessage.TYPE_MOD_WARNING)
-		else:
-			bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
+			text += '\n- ' + '\n- '.join(flags)
+		bot_message = BotMessage(guild, text, BotMessage.TYPE_MOD_WARNING if noteworthy else BotMessage.TYPE_LOG)
 		await bot_message.update()
 
 	@Cog.listener()
@@ -324,8 +350,13 @@ class LoggingCog(BaseCog, name='Logging'):
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
 			return
 		changes = []
+		noteworthy = False
 		if after.nick != before.nick:
 			changes.append(f'Nick: `{before.nick}` -> `{after.nick}`')
+		if after.name != before.name:
+			changes.append(f'Username: `@{before.name}` -> `@{after.name}`')
+		if after.display_name != before.display_name:
+			changes.append(f'Display name: `{before.display_name}` -> `{after.display_name}`')
 		if after.roles != before.roles:
 			added_role_names = []
 			removed_role_names = []
@@ -353,18 +384,33 @@ class LoggingCog(BaseCog, name='Logging'):
 			changes.append(f'Guild avatar: <{before_guild_avatar}> -> <{after_guild_avatar}>')
 		if after.flags != before.flags:
 			flag_changes = []
+			noteworthy_flags = { 'automod_quarantined_username', 'automod_quarantined_guild_tag' }
 			for (name, after_value) in iter(after.flags):
 				before_value = getattr(before.flags, name)
 				if after_value != before_value:
 					flag_changes.append(f'`{name}` = `{before_value}` -> `{after_value}`')
+					if after_value and name in noteworthy_flags:
+						noteworthy = True
+			if len(flag_changes) > 0:
+				changes.append(f'Guild-specific flag changes: {", ".join(flag_changes)}')
+		if after.public_flags != before.public_flags:
+			flag_changes = []
+			noteworthy_flags = { 'spammer' }
+			for (name, after_value) in iter(after.public_flags):
+				before_value = getattr(before.public_flags, name)
+				if after_value != before_value:
+					flag_changes.append(f'`{name}` = `{before_value}` -> `{after_value}`')
+					if after_value and name in noteworthy_flags:
+						noteworthy = True
 			if len(flag_changes) > 0:
-				changes.append(f'Flag changes: {", ".join(flag_changes)}')
+				changes.append(f'Public flag changes: {", ".join(flag_changes)}')
 
 		if len(changes) == 0:
 			return
-		text = f'Details for member {self.__describe_user(before)} changed:\n'
-		text += '* ' + ('\n* '.join(changes))
-		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
+		text = f'Details for member {self.__describe_user(before, tag=noteworthy)} changed:\n'
+		text += '- ' + ('\n- '.join(changes))
+		bot_message = BotMessage(guild, text,
+			BotMessage.TYPE_MOD_WARNING if noteworthy else BotMessage.TYPE_LOG)
 		await bot_message.update()
 
 	@Cog.listener()
@@ -874,11 +920,13 @@ class LoggingCog(BaseCog, name='Logging'):
 			return '> _<no content>_'
 		return '> ' + escape_markdown(s).replace('\n', '\n> ')
 
-	def __describe_user(self, user: User | Member) -> str:
+	def __describe_user(self, user: User | Member, tag: bool = False) -> str:
 		"""
 		Standardized Markdown describing a user or member.
 		"""
-		return f'**{user.name}** ({user.display_name} {user.id})'
+		if tag:
+			return f'<@{user.id}> (`@{user.name}`, display "{user.display_name}", id `{user.id}`)'
+		return f'**`@{user.name}`** (display "{user.display_name}", id `{user.id}`)'
 
 	def __diff(self, a: str, b: str) -> tuple[str, str]:
 		# URLs don't work well in the diffs. Replace them with private use characters, one per unique URL.