Add configuration option to allow all users to access the CTF after archiving

Author: mklarz

README.md

@@ -17,6 +17,7 @@ The only required variable is `DISCORD_TOKEN`, the rest will use the default val
 | `LOGGING_FORMAT` | `%(asctime)s:%(levelname)s:%(name)s: %(message)s` | Logging format, see [here](https://docs.python.org/3/library/logging.html#formatter-objects) |
 | `LOGGING_FILE` |  | If enabled, will send logging to this file |
 | `LOGGING_DISCORD_LEVEL` | `ERROR` | The minimum level for logging into the logging channel (`CHANNEL_LOGGING_ID`) |
+| `ARCHIVE_ACCESS_TO_ALL_USERS` | `false` | Should all the users in the Discord Server gain access to the CTF channels when the CTF is archived? Set to `true` if so. |
 | `COMMAND_PREFIX` | `!` | Prefix for all the bot commands (i.e. `!done`) |
 | `MAINTAINERS` |  | Comma-separated list with profile IDs of the bot maintainers, these users have permission to export and delete CTFs |
 | `GUILD_IDS` |  | Comma-separated list with guild IDs of where the bot should run. Used for executing CTF channel cleanup manually |

bot/config.py

@@ -5,6 +5,8 @@ def parse_variable(variable, default=None, valid=None):
     value = os.getenv(variable, None)
     if default and valid and variable not in valid:
         return default
+    elif isinstance(default, bool):
+        return True if value.lower() in ["true", "1", "t", "y", "yes"] else False
     elif isinstance(default, int):
         return int(value) if value and value.isdigit() else default
     else:
@@ -48,6 +50,8 @@ def parse_int_list(variable):
     "logging_file": parse_variable("LOGGING_FILE"),
     # The minimum level for logging into the logging channel (`CHANNEL_LOGGING_ID`)
     "logging_discord_level": parse_variable("LOGGING_DISCORD_LEVEL", "ERROR"),
+    # Should all the users in the Discord Server gain access to the CTF channels when the CTF is archived? Set to `true` if so.
+    "archive_access_to_all_users": parse_variable("ARCHIVE_ACCESS_TO_ALL_USERS", False),
     # Prefix for all the bot commands
     "prefix": parse_variable("COMMAND_PREFIX", "!"),
     # Profile ids of the maintainers of your installation. These will be messaged when running `!report "issue"` or `!request "feature"`

bot/ctf_model.py

@@ -333,7 +333,10 @@ async def archive(self):
 
         # Archive all challenge channels
         main_chan = guild.get_channel(cid)
-        # await main_chan.set_permissions(guild.default_role, overwrite=basic_read_send)
+        if config["archive_access_to_all_users"]:
+            await main_chan.set_permissions(
+                guild.default_role, overwrite=basic_read_send
+            )
         category_archives[-1]["channels"] -= 1
 
         for i, d in enumerate(category_archives):
@@ -566,7 +569,10 @@ async def _archive(self, catg_archive):
         channel = guild.get_channel(cid)
         if channel is not None:
             await channel.edit(category=catg_archive)
-            # await channel.set_permissions(guild.default_role, overwrite=basic_read_send)
+            if config["archive_access_to_all_users"]:
+                await channel.set_permissions(
+                    guild.default_role, overwrite=basic_read_send
+                )
             self.refresh()
         else:
             raise ValueError(f"Couldn't find channel {cid}")

docker-compose.yml

@@ -11,6 +11,7 @@ services:
       - "LOGGING_FORMAT=${LOGGING_FORMAT:-%(asctime)s:%(levelname)s:%(name)s: %(message)s}"
       - "LOGGING_FILE=${LOGGING_FILE}"
       - "LOGGING_DISCORD_LEVEL=${LOGGING_DISCORD_LEVEL:-ERROR}"
+      - "ARCHIVE_ACCESS_TO_ALL_USERS=${ARCHIVE_ACCESS_TO_ALL_USERS:-false}"
       - "COMMAND_PREFIX=${COMMAND_PREFIX:-!}"
       - "MAINTAINERS=${MAINTAINERS}"
       - "GUILD_IDS=${GUILD_IDS}"