Code block: add configurable variables

4 files changed, 41 insertions, 21 deletions

diff --git a/bot/cogs/codeblock/cog.py b/bot/cogs/codeblock/cog.py
index ecaf51aa0..e3917751b 100644
--- a/bot/cogs/codeblock/cog.py
+++ b/bot/cogs/codeblock/cog.py
@@ -6,8 +6,8 @@ import discord
 from discord import Message, RawMessageUpdateEvent
 from discord.ext.commands import Bot, Cog
 
+from bot import constants
 from bot.cogs.token_remover import TokenRemover
-from bot.constants import Channels, DEBUG_MODE
 from bot.utils import has_lines
 from bot.utils.channel import is_help_channel
 from bot.utils.messages import wait_for_deletion
@@ -33,8 +33,7 @@ class CodeBlockCog(Cog, name="Code Block"):
             1. Spaces before the language
             2. No newline immediately following the language
 
-    Messages with 3 or fewer lines overall are ignored. Each code block is subject to this threshold
-    as well i.e. the text between the ticks must be greater than 3 lines. Detecting multiple code
+    Messages or code blocks must meet a minimum line count to be detected. Detecting multiple code
     blocks is supported. However, if at least one code block is correct, then instructions will not
     be sent even if others are incorrect. When multiple incorrect code blocks are found, only the
     first one is used as the basis for the instructions sent.
@@ -45,23 +44,17 @@ class CodeBlockCog(Cog, name="Code Block"):
     show what is still incorrect after the user's edit. The embed can be manually deleted with a
     reaction. Otherwise, it will automatically be removed after 5 minutes.
 
-    The cog only detects messages in whitelisted channels. Channels may also have a 300-second
-    cooldown on the instructions being sent. See `__init__` for which channels are whitelisted or
-    have cooldowns enabled. Note that all help channels are also whitelisted with cooldowns enabled.
+    The cog only detects messages in whitelisted channels. Channels may also have a cooldown on the
+    instructions being sent. Note all help channels are also whitelisted with cooldowns enabled.
+
+    For configurable parameters, see the `code_block` section in config-default.py.
     """
 
     def __init__(self, bot: Bot):
         self.bot = bot
 
         # Stores allowed channels plus epoch times since the last instructional messages sent.
-        self.channel_cooldowns = {
-            Channels.python_discussion: 0,
-        }
-
-        # These channels will also work, but will not be subject to a cooldown.
-        self.channel_whitelist = (
-            Channels.bot_commands,
-        )
+        self.channel_cooldowns = {channel: 0.0 for channel in constants.CodeBlock.cooldown_channels}
 
         # Maps users' messages to the messages the bot sent with instructions.
         self.codeblock_message_ids = {}
@@ -102,7 +95,7 @@ class CodeBlockCog(Cog, name="Code Block"):
         return (
             is_help_channel(channel)
             or channel.id in self.channel_cooldowns
-            or channel.id in self.channel_whitelist
+            or channel.id in constants.CodeBlock.channel_whitelist
         )
 
     async def send_instructions(self, message: discord.Message, instructions: str) -> None:
@@ -135,7 +128,7 @@ class CodeBlockCog(Cog, name="Code Block"):
         return (
             not message.author.bot
             and self.is_valid_channel(message.channel)
-            and has_lines(message.content, 4)
+            and has_lines(message.content, constants.CodeBlock.minimum_lines)
             and not TokenRemover.find_token_in_message(message)
         )
 
@@ -147,7 +140,7 @@ class CodeBlockCog(Cog, name="Code Block"):
             return
 
         # When debugging, ignore cooldowns.
-        if self.is_on_cooldown(msg.channel) and not DEBUG_MODE:
+        if self.is_on_cooldown(msg.channel) and not constants.DEBUG_MODE:
             log.trace(f"Skipping code block detection of {msg.id}: #{msg.channel} is on cooldown.")
             return
 
@@ -155,7 +148,7 @@ class CodeBlockCog(Cog, name="Code Block"):
         if instructions:
             await self.send_instructions(msg, instructions)
 
-            if msg.channel.id not in self.channel_whitelist:
+            if msg.channel.id not in constants.CodeBlock.channel_whitelist:
                 log.debug(f"Adding #{msg.channel} to the channel cooldowns.")
                 self.channel_cooldowns[msg.channel.id] = time.time()
 
diff --git a/bot/cogs/codeblock/parsing.py b/bot/cogs/codeblock/parsing.py
index 332a1deb0..89f8111fc 100644
--- a/bot/cogs/codeblock/parsing.py
+++ b/bot/cogs/codeblock/parsing.py
@@ -5,6 +5,7 @@ import logging
 import re
 from typing import NamedTuple, Optional, Sequence
 
+from bot import constants
 from bot.utils import has_lines
 
 log = logging.getLogger(__name__)
@@ -84,7 +85,7 @@ def find_code_blocks(message: str) -> Optional[Sequence[CodeBlock]]:
         if groups["tick"] == BACKTICK and language:
             log.trace("Message has a valid code block with a language; returning None.")
             return None
-        elif has_lines(groups["code"], 4):
+        elif has_lines(groups["code"], constants.CodeBlock.minimum_lines):
             code_block = CodeBlock(groups["code"], language, groups["tick"])
             code_blocks.append(code_block)
         else:
diff --git a/bot/constants.py b/bot/constants.py
index 470221369..6c9654e89 100644
--- a/bot/constants.py
+++ b/bot/constants.py
@@ -540,6 +540,15 @@ class BigBrother(metaclass=YAMLGetter):
     header_message_limit: int
 
 
+class CodeBlock(metaclass=YAMLGetter):
+    section = 'code_block'
+
+    channel_whitelist: List[int]
+    cooldown_channels: List[int]
+    cooldown_seconds: int
+    minimum_lines: int
+
+
 class Free(metaclass=YAMLGetter):
     section = 'free'
 
diff --git a/config-default.yml b/config-default.yml
index 3388e5f78..845a20979 100644
--- a/config-default.yml
+++ b/config-default.yml
@@ -137,8 +137,8 @@ guild:
         dev_log:            &DEV_LOG        622895325144940554
 
         # Discussion
-        meta:               429409067623251969
-        python_discussion:  267624335836053506
+        meta:                               429409067623251969
+        python_discussion:  &PY_DISCUSSION  267624335836053506
 
         # Python Help: Available
         how_to_get_help:    704250143020417084
@@ -522,6 +522,23 @@ big_brother:
     header_message_limit: 15
 
 
+code_block:
+    # The channels in which code blocks will be detected. They are not subject to a cooldown.
+    channel_whitelist:
+        - *BOT_CMD
+
+    # The channels which will be affected by a cooldown. These channels are also whitelisted.
+    cooldown_channels:
+        - *PY_DISCUSSION
+
+    # Sending instructions triggers a cooldown on a per-channel basis.
+    # More instruction messages will not be sent in the same channel until the cooldown has elapsed.
+    cooldown_seconds: 300
+
+    # The minimum amount of lines a message or code block must have for instructions to be sent.
+    minimum_lines: 4
+
+
 free:
     # Seconds to elapse for a channel
     # to be considered inactive.