Progressive functionality based on enabled privileged intents

config.sample.py

@@ -1,6 +1,6 @@
 # Copy this file to config.py and fill in "<REQUIRED>" values
 CONFIG = {
-	'__config_version': 4,
+	'__config_version': 5,
 
     # -----------------------------------------------------------------------
     # General
@@ -14,6 +14,12 @@ CONFIG = {
 	'max_members_per_message': 20,
 	# Minimum seconds between warnings about the same member.
 	'squelch_warning_seconds': 300,
+	# Whether the Discord app has Message Content intent enabled. Enables more
+	# features but requires applying for access for bots serving 10k or more users.
+	'has_message_content_intent': False,
+	# Whether the Discord app has Server Members intent enabled. Enables more
+	# features but requires applying for access for bots serving 10k or more users.
+	'has_members_intent': False,
 
     # -----------------------------------------------------------------------
     # Emojis used for performing actions on flagged activities. The bot will

main.py

@@ -19,7 +19,7 @@ from config import CONFIG  # noqa: E402
 from rocketbot.bot import start_bot  # noqa: E402
 from rocketbot.utils import bot_log  # noqa: E402
 
-CURRENT_CONFIG_VERSION = 4
+CURRENT_CONFIG_VERSION = 5
 if (CONFIG.get('__config_version') or 0) < CURRENT_CONFIG_VERSION:
 	# If you're getting this error, it means something changed in config.py's
 	# format. Consult config.sample.py and compare it to your own config.py.

rocketbot/bot.py

@@ -83,8 +83,9 @@ def __create_bot():
 		return
 	bot_log(None, None, 'Creating bot...')
 	intents = Intents.default()
-	intents.message_content = True
-	intents.members = True
+	# Set privileged intents. Must agree with configuration in Discord app.
+	intents.message_content = CONFIG.get('has_message_content_intent', False)
+	intents.members = CONFIG.get('has_members_intent', False)
 	intents.presences = False
 	rocketbot = Rocketbot(intents=intents)
 __create_bot()
@@ -111,17 +112,28 @@ async def start_bot():
 	await rocketbot.add_cog(ConfigCog(rocketbot))
 
 	# Optional
-	await rocketbot.add_cog(AutoKickCog(rocketbot))
-	await rocketbot.add_cog(BangCommandCog(rocketbot))
-	await rocketbot.add_cog(CrossPostCog(rocketbot))
-	await rocketbot.add_cog(GamesCog(rocketbot))
-	await rocketbot.add_cog(HelpCog(rocketbot))
-	await rocketbot.add_cog(JoinRaidCog(rocketbot))
-	await rocketbot.add_cog(LoggingCog(rocketbot))
-	await rocketbot.add_cog(PatternCog(rocketbot))
-	await rocketbot.add_cog(URLSpamCog(rocketbot))
-	await rocketbot.add_cog(UsernamePatternCog(rocketbot))
-	await rocketbot.add_cog(VideoPreviewCog(rocketbot))
+	if AutoKickCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(AutoKickCog(rocketbot))
+	if BangCommandCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(BangCommandCog(rocketbot))
+	if CrossPostCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(CrossPostCog(rocketbot))
+	if GamesCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(GamesCog(rocketbot))
+	if HelpCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(HelpCog(rocketbot))
+	if JoinRaidCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(JoinRaidCog(rocketbot))
+	if LoggingCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(LoggingCog(rocketbot))
+	if PatternCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(PatternCog(rocketbot))
+	if URLSpamCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(URLSpamCog(rocketbot))
+	if UsernamePatternCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(UsernamePatternCog(rocketbot))
+	if VideoPreviewCog.supports_intents(rocketbot.intents):
+		await rocketbot.add_cog(VideoPreviewCog(rocketbot))
 
 	await rocketbot.start(CONFIG['client_token'], reconnect=True)
 	print('\nBot aborted')

rocketbot/cogs/autokickcog.py

@@ -1,6 +1,6 @@
 from datetime import datetime, timedelta, timezone
 
-from discord import Guild, Member, Status
+from discord import Guild, Intents, Member, Status
 from discord.ext import tasks
 from discord.ext.commands import Cog
 from discord.ext.tasks import Loop
@@ -158,3 +158,7 @@ class AutoKickCog(BaseCog, name='Auto Kick'):
 			if val % 10 == 3:
 				return f'{val}rd'
 		return f'{val}th'
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.members

rocketbot/cogs/bangcommandcog.py

@@ -1,7 +1,15 @@
 import re
 from typing import Optional, TypedDict
 
-from discord import Guild, Interaction, Message, SelectOption, TextChannel, TextStyle
+from discord import (
+	Guild,
+	Intents,
+	Interaction,
+	Message,
+	SelectOption,
+	TextChannel,
+	TextStyle,
+)
 from discord.app_commands import Choice, Group, autocomplete
 from discord.ext.commands import Cog
 from discord.ui import Label, Modal, Select, TextInput
@@ -270,6 +278,10 @@ class BangCommandCog(BaseCog, name='Bang Commands'):
 		match = re.match(r'^!((?:[a-z]+)(?:[_-][a-z]+)*)\b.*$', name)
 		return BangCommandCog._normalize_name(match.group(1)) if match else None
 
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.message_content
+
 class _EditModal(Modal, title='Edit Command'):
 	name_label = Label(
 		text='Command name',

rocketbot/cogs/basecog.py

@@ -7,6 +7,7 @@ from typing import Optional
 import discord
 from discord import (
 	Guild,
+	Intents,
 	Interaction,
 	Member,
 	Message,
@@ -302,3 +303,9 @@ class BaseCog(Cog):
 		Writes a message to the console. Intended for significant events only.
 		"""
 		bot_log(guild, cls, message)
+
+	# Meta
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return True

rocketbot/cogs/crosspostcog.py

@@ -141,13 +141,17 @@ class CrossPostCog(BaseCog, name='Crosspost Detection'):
 			self.__trace(f"User {message.author.name} exempt from crosspost checks")
 			return
 		def compute_message_hash(m: Message) -> int:
-			to_hash = m.content
-			# URLs sometimes differ per spam message, so simplify them
-			url_regex = r'http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+'
-			to_hash = re.sub(url_regex, '<url>', to_hash)
-			# Add attachment metadata
-			for attachment in m.attachments:
-				to_hash += f'\n[[ATT: ct={attachment.content_type} s={attachment.size} w={attachment.width} h={attachment.height}]]'
+			if self.bot.intents.message_content:
+				to_hash = m.content
+				# URLs sometimes differ per spam message, so simplify them
+				url_regex = r'http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+'
+				to_hash = re.sub(url_regex, '<url>', to_hash)
+				# Add attachment metadata
+				for attachment in m.attachments:
+					to_hash += f'\n[[ATT: ct={attachment.content_type} s={attachment.size} w={attachment.width} h={attachment.height}]]'
+			else:
+				# Without content, treat every message as unique
+				to_hash = str(m.id)
 			h = hash(to_hash)
 			self.__trace(f"Hash for message #{m.id} by {m.author.name} is {h}\n\thash content: \"{to_hash}\"")
 			return h

rocketbot/cogs/joinraidcog.py

@@ -5,7 +5,7 @@ import weakref
 from datetime import datetime, timedelta
 from typing import Optional
 
-from discord import Guild, Member
+from discord import Guild, Intents, Member
 from discord.ext.commands import Cog
 
 from config import CONFIG
@@ -189,3 +189,7 @@ class JoinRaidCog(BaseCog, name='Join Raids'):
 			did_kick=kick_count >= member_count,
 			did_ban=ban_count >= member_count,
 			user_count=member_count))
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.members

rocketbot/cogs/logcog.py

@@ -206,6 +206,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		Called when a Member joins a Guild.
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_member_join
+
+		Requires Members privileged intent.
 		"""
 		guild = member.guild
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
@@ -273,6 +275,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		will not be called, you may use on_raw_member_remove() instead.
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_member_remove
+
+		Requires Members privileged intent.
 		"""
 		guild = member.guild
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
@@ -312,6 +316,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		* flags
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_member_update
+
+		Requires Members privileged intent.
 		"""
 		guild = after.guild
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
@@ -371,6 +377,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		* discriminator
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_user_update
+
+		Requires Members privileged intent.
 		"""
 		if hasattr(after, 'guild'):
 			guild = after.guild
@@ -492,6 +500,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		Called when a Message is created and sent.
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_message
+
+		Content fields blank without MessageContent privileged intent.
 		"""
 		# print(f"on_message:"
 		# 	f"\n\tid: {message.id}"
@@ -523,6 +533,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		* A call message has received an update to its participants or ending time.
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_message_edit
+
+		Content fields blank without MessageContent privileged intent.
 		"""
 		guild = after.guild
 		if not self.get_guild_setting(guild, self.SETTING_ENABLED):
@@ -556,6 +568,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		Discord embed server.
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_raw_message_edit
+
+		Content fields blank without MessageContent privileged intent.
 		"""
 		if payload.cached_message:
 			return  # already handled by on_message_edit
@@ -663,6 +677,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		RawMessageDeleteEvent.cached_message
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_raw_message_delete
+
+		Content fields blank without MessageContent privileged intent.
 		"""
 		message = payload.cached_message
 		if message and message.author.id == self.bot.user.id:
@@ -692,6 +708,8 @@ class LoggingCog(BaseCog, name='Logging'):
 		RawBulkMessageDeleteEvent.cached_messages
 
 		https://discordpy.readthedocs.io/en/stable/api.html#discord.on_raw_bulk_message_delete
+
+		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:

rocketbot/cogs/patterncog.py

@@ -6,7 +6,7 @@ import re
 from datetime import datetime
 from typing import Optional
 
-from discord import Guild, Interaction, Member, Message
+from discord import Guild, Intents, Interaction, Member, Message
 from discord import utils as discordutils
 from discord.app_commands import Choice, Group, autocomplete
 from discord.ext.commands import Cog
@@ -435,3 +435,7 @@ class PatternCog(BaseCog, name='Pattern Matching'):
 				f'updated to `{priority}`.',
 			ephemeral=True,
 		)
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.message_content

rocketbot/cogs/urlspamcog.py

@@ -5,7 +5,7 @@ import re
 from datetime import timedelta
 from typing import Literal
 
-from discord import Guild, Member, Message
+from discord import Guild, Intents, Member, Message
 from discord import utils as discordutils
 from discord.ext.commands import Cog
 from discord.utils import escape_markdown
@@ -358,3 +358,7 @@ class URLSpamCog(BaseCog, name='URL Spam'):
 	def __find_urls(cls, text: str) -> list[str]:
 		p = re.compile(r'https?://\S+')
 		return re.findall(p, text)
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.message_content

rocketbot/cogs/usernamecog.py

@@ -3,7 +3,7 @@ Cog for detecting username patterns.
 """
 from typing import Optional
 
-from discord import Guild, Interaction, Member
+from discord import Guild, Intents, Interaction, Member
 from discord.app_commands import Group
 from discord.ext.commands import Cog
 
@@ -239,3 +239,7 @@ class UsernamePatternCog(BaseCog, name='Username Pattern'):
 			context.ignored_by = reacted_by
 			self.log(context.member.guild, f'Warning ignored by {reacted_by.name}')
 			await bot_message.set_reactions(context.reactions())
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.members

rocketbot/cogs/videopreviewcog.py

@@ -4,7 +4,7 @@ import re
 import subprocess
 from datetime import timedelta
 
-from discord import Message
+from discord import Intents, Message
 from discord.ext.commands import Cog
 
 from rocketbot.cogs.basecog import BaseCog
@@ -219,3 +219,7 @@ class VideoPreviewCog(BaseCog, name='Video Link Previews'):
 			content,
 			mention_author=False
 		)
+
+	@classmethod
+	def supports_intents(cls, intents: Intents) -> bool:
+		return intents.message_content