Edits and deletions now attachment and embed aware. Edits show diffs. Better startup logging.

bot.py

@@ -22,6 +22,7 @@ from rocketbot.cogs.logcog import LoggingCog
 from rocketbot.cogs.patterncog import PatternCog
 from rocketbot.cogs.urlspamcog import URLSpamCog
 from rocketbot.cogs.usernamecog import UsernamePatternCog
+from rocketbot.utils import bot_log
 
 CURRENT_CONFIG_VERSION = 3
 if (CONFIG.get('__config_version') or 0) < CURRENT_CONFIG_VERSION:
@@ -72,8 +73,8 @@ async def start_bot():
 	intents.message_content = True  # pylint: disable=assigning-non-slot
 	intents.members = True  # pylint: disable=assigning-non-slot
 	intents.presences = True
-	print(f"Intents are {intents}")
-	print(f"Command prefix is {CONFIG['command_prefix']}")
+	bot_log(None, None, 'Bot initializing...')
+	bot_log(None, None, f"Type {CONFIG['command_prefix']}help in Discord for available commands.")
 	bot = Rocketbot(command_prefix=CONFIG['command_prefix'], intents=intents)
 
 	# Core
@@ -96,4 +97,4 @@ async def start_bot():
 try:
 	asyncio.run(start_bot())
 except KeyboardInterrupt:
-	pass
+	bot_log(None, None, 'Stopping bot due to Ctrl+C key')

rocketbot/cogs/generalcog.py

@@ -21,28 +21,37 @@ class GeneralCog(BaseCog, name='General'):
 		super().__init__(bot)
 		self.is_connected = False
 		self.is_ready = False
+		self.is_first_ready = True
+		self.is_first_connect = True
 
 	@commands.Cog.listener()
 	async def on_connect(self):
 		'Event handler'
-		print('on_connect')
+		if self.is_first_connect:
+			self.log(None, 'Connected')
+			self.is_first_connect = False
+		else:
+			self.log(None, 'Reconnected')
 		self.is_connected = True
 
 	@commands.Cog.listener()
 	async def on_disconnect(self):
 		'Event handler'
-		print('on_disconnect')
+		self.log(None, 'Disconnected')
 
 	@commands.Cog.listener()
 	async def on_ready(self):
 		'Event handler'
-		print('on_ready')
+		self.log(None, 'Bot done initializing')
 		self.is_ready = True
+		if self.is_first_ready:
+			print('----------------------------------------------------------')
+			self.is_first_ready = False
 
 	@commands.Cog.listener()
 	async def on_resumed(self):
 		'Event handler'
-		print('on_resumed')
+		self.log(None, 'Session resumed')
 
 	@commands.command(
 		brief='Posts a test warning',

rocketbot/cogs/logcog.py

@@ -8,7 +8,8 @@ from discord import AuditLogAction, AuditLogEntry, Emoji, Guild, GuildSticker, I
 from discord.abc import GuildChannel
 from discord.ext import commands
 from discord.utils import escape_markdown
-from typing import List, Optional, Union
+from typing import List, Optional, Tuple, Union
+import difflib
 import traceback
 
 from config import CONFIG
@@ -451,12 +452,54 @@ class LoggingCog(BaseCog, name='Logging'):
 			return
 		if after.author.id == self.bot.user.id:
 			return
-		if after.content == before.content:
-			# Most likely an embed being updated
+
+		content_changed = (after.content != before.content)
+		attachments_changed = (after.attachments != before.attachments)
+		embeds_changed = (after.embeds != before.embeds)
+		embeds_add_only = len(before.embeds or []) == 0 and len(after.embeds or []) > 0
+
+		if not content_changed and not attachments_changed and (not embeds_changed or embeds_add_only):
+			# Most likely an embed being asynchronously populated by server
 			return
+		if content_changed:
+			(before_markdown, after_markdown) = self.__diff(self.__quote_markdown(before.content), \
+													  self.__quote_markdown(after.content))
+		else:
+			before_markdown = self.__quote_markdown(before.content)
+			after_markdown = before_markdown if len(before.content.strip()) == 0 else '> _<content unchanged>_'
+		if attachments_changed:
+			if len(before.attachments or []) > 0:
+				for attachment in before.attachments:
+					before_markdown += f'\n> * 📎 {attachment.url}'
+					if attachment not in after.attachments or []:
+						before_markdown += ' (removed)'
+			else:
+				before_markdown += '\n> * _<no attachments>_'
+			if len(after.attachments or []) > 0:
+				for attachment in after.attachments:
+					after_markdown += f'\n> * 📎 {attachment.url}'
+					if attachment not in before.attachments or []:
+						after_markdown += ' (added)'
+			else:
+				after_markdown += '\n> * _<no attachments>_'
+		if embeds_changed:
+			if len(before.embeds or []) > 0:
+				for embed in before.embeds:
+					before_markdown += f'\n> * 🔗 {embed.url}'
+					if embed not in after.embeds or []:
+						before_markdown += ' (removed)'
+			else:
+				before_markdown += '\n> * _<no embeds>_'
+			if len(after.embeds or []) > 0:
+				for embed in after.embeds:
+					after_markdown += f'\n> * 🔗 {embed.url}'
+					if embed not in before.embeds or []:
+						after_markdown += ' (added)'
+			else:
+				after_markdown += '\n> * _<no embeds>_'
 		text = f'Message {after.jump_url} edited by {self.__describe_user(after.author)}.\n' + \
-			f'Original markdown:\n{self.__quote_markdown(before.content)}\n' + \
-			f'Updated markdown:\n{self.__quote_markdown(after.content)}'
+			f'Original:\n{before_markdown}\n' + \
+			f'Updated:\n{after_markdown}'
 		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG, suppress_embeds=True)
 		await bot_message.update()
 
@@ -523,6 +566,10 @@ class LoggingCog(BaseCog, name='Logging'):
 				return
 			text = f'Message by {self.__describe_user(message.author)} deleted from {message.channel.mention}. ' + \
 				f'Markdown:\n{self.__quote_markdown(message.content)}'
+			for attachment in message.attachments or []:
+				text += f'\n> * 📎 {attachment.url}'
+			for embed in message.embeds or []:
+				text += f'\n> * 🔗 {embed.url}'
 			bot_message = BotMessage(message.guild, text, BotMessage.TYPE_LOG, suppress_embeds=True)
 			await bot_message.update()
 		else:
@@ -564,13 +611,17 @@ class LoggingCog(BaseCog, name='Logging'):
 			text += f' No cached content available for any of them.'
 		elif uncached_count > 0:
 			text += f' No cached content available for {uncached_count} of them.'
-		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
+		bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG, suppress_embeds=True)
 		await bot_message.update()
 
 		for message in payload.cached_messages:
 			text = f'Message by {self.__describe_user(message.author)} bulk deleted from {message.channel.mention}. ' + \
 				f'Markdown:\n{self.__quote_markdown(message.content)}'
-			bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG)
+			for attachment in message.attachments or []:
+				text += f'\n> * 📎 {attachment.url}'
+			for embed in message.embeds or []:
+				text += f'\n> * 🔗 {embed.url}'
+			bot_message = BotMessage(guild, text, BotMessage.TYPE_LOG, suppress_embeds=True)
 			await bot_message.update()
 
 	# Events - Roles
@@ -665,6 +716,8 @@ class LoggingCog(BaseCog, name='Logging'):
 
 	# ------------------------------------------------------------------------
 	def __quote_markdown(self, s: str) -> str:
+		if len(s.strip()) == 0:
+			return '> _<no content>_'
 		return '> ' + escape_markdown(s).replace('\n', '\n> ')
 
 	def __describe_user(self, user: Union[User, Member]) -> str:
@@ -672,3 +725,42 @@ class LoggingCog(BaseCog, name='Logging'):
 		Standardized markdown describing a user or member.
 		"""
 		return f'**{user.name}** ({user.display_name} {user.id})'
+
+	def __diff(self, a: str, b: str) -> Tuple[str, str]:
+		deletion_start = '~~'
+		deletion_end = '~~'
+		addition_start = '**'
+		addition_end = '**'
+		markdown_a = ''
+		markdown_b = ''
+		a_open = False
+		b_open = False
+		# FIXME: Handle URLs better. They get mangled.
+		# URL regex: http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+
+		for i, s in enumerate(difflib.ndiff(a, b)):
+			operation = s[0]
+			content = s[2:]
+			if operation != '-' and a_open:
+				markdown_a += deletion_end
+				a_open = False
+			if operation != '+' and b_open:
+				markdown_b += addition_end
+				b_open = False
+			if operation == ' ':
+				markdown_a += content
+				markdown_b += content
+			elif operation == '-':
+				if not a_open:
+					markdown_a += deletion_start
+					a_open = True
+				markdown_a += content
+			elif operation == '+':
+				if not b_open:
+					markdown_b += addition_start
+					b_open = True
+				markdown_b += content
+		if a_open:
+			markdown_a += deletion_end
+		if b_open:
+			markdown_b += addition_end
+		return (markdown_a, markdown_b)