Collapse long messages into gist command

futaba/__init__.py

@@ -34,6 +34,7 @@
     str_builder,
     unicode,
     utils,
+    gist,
 )
 
 __version__ = "0.6.2"

futaba/cogs/moderation/core.py

@@ -21,8 +21,8 @@
 import discord
 from discord.ext import commands
 
-from futaba import permissions
-from futaba.converters import MemberConv, UserConv
+from futaba import permissions, gist
+from futaba.converters import MemberConv, UserConv, MessageConv
 from futaba.enums import PunishAction
 from futaba.exceptions import CommandFailed, ManualCheckFailure
 from futaba.navi import PunishTask
@@ -439,3 +439,41 @@ async def unban(self, ctx, user: UserConv, *, reason: str):
             raise ManualCheckFailure(
                 content="I don't have permission to unban this user"
             )
+
+    @commands.command(name="msgcollapse", aliases=["gist"])
+    @commands.guild_only()
+    async def msgcollapse(self, ctx, *messages: MessageConv):
+        """
+        Concatenates the range of messages and uploads to a gist.
+        The original messages are deleted and a link to the gist is posted.
+
+        Note: The messages specified should be by the same user
+        """
+
+        if not self.bot.config.gist_oauth_token:
+            raise CommandFailed(content="The gist oauth token is not configured.")
+
+        if not permissions.has_perm(ctx, "manage_messages") and any(
+            message.author.id != ctx.author.id for message in messages
+        ):
+            # check if the messages were created by the same user
+            raise ManualCheckFailure(content="I can only collapse your messages")
+
+        logger.info("Collapsing %d messages into a gist", len(messages))
+
+        gist_url = await gist.create_single_gist(
+            token=self.bot.config.gist_oauth_token,
+            content="  \n".join(str(message.content) for message in messages),
+            filename="collapsed.md",
+            description="Discord collapsed messages",
+            public=False,
+        )
+
+        embed = discord.Embed(description="Done! Messages successfully collapsed!")
+        embed.add_field(name="Permalink", value=gist_url)
+        embed.colour = discord.Colour.dark_teal()
+
+        for message in messages:
+            await message.delete()
+
+        await ctx.send(embed=embed)

futaba/config.py

@@ -44,7 +44,10 @@ def wrapper(value):
             "error-channel-id": Or(And(str, ID_REGEX.match), "0"),
         },
         "cogs": {"example": object, "statbot": object},
-        "moderation": {"max-cleanup-messages": And(str, _check_gtz(int))},
+        "moderation": {
+            "max-cleanup-messages": And(str, _check_gtz(int)),
+            "gist-oauth-token": str,
+        },
         "delay": {
             "chunk-size": And(str, _check_gtz(int)),
             "sleep": And(str, _check_gtz(float)),
@@ -68,6 +71,7 @@ def wrapper(value):
         "error_channel_id",
         "optional_cogs",
         "max_cleanup_messages",
+        "gist_oauth_token",
         "delay_chunk_size",
         "delay_sleep",
         "anger_emoji_id",
@@ -92,6 +96,7 @@ def load_config(path):
         error_channel_id=int(config["bot"]["error-channel-id"]),
         optional_cogs=config["cogs"],
         max_cleanup_messages=int(config["moderation"]["max-cleanup-messages"]),
+        gist_oauth_token=config["moderation"]["gist-oauth-token"],
         delay_chunk_size=int(config["delay"]["chunk-size"]),
         delay_sleep=float(config["delay"]["sleep"]),
         anger_emoji_id=int(config["emojis"]["anger"]),

futaba/gist.py

@@ -0,0 +1,49 @@
+#
+# gist.py
+#
+# futaba - A Discord Mod bot for the Programming server
+# Copyright (c) 2017-2020 Jake Richardson, Ammon Smith, jackylam5
+#
+# futaba is available free of charge under the terms of the MIT
+# License. You are free to redistribute and/or modify it under those
+# terms. It is distributed in the hopes that it will be useful, but
+# WITHOUT ANY WARRANTY. See the LICENSE file for more details.
+#
+
+import logging
+import urllib.parse
+
+import aiohttp
+
+logger = logging.getLogger(__name__)
+
+__all__ = ["create_single_gist"]
+
+github_api_url = "https://api.github.com/"
+github_gist_endpoint = urllib.parse.urljoin(github_api_url, "/gists")
+
+
+async def create_single_gist(
+    token, content, filename="message.md", description="", public: bool = True
+) -> str:
+    """
+    Creates a new gist as specified by the parameters
+    Returns the url that the new gist can be accessed by
+    """
+
+    github_headers = {
+        "Accept": "application/vnd.github.v3+json",
+        "Authorization": f"token {token}",
+    }
+    request_data = {
+        "description": description,
+        "public": public,
+        "files": {filename: {"content": content}},
+    }
+
+    async with aiohttp.ClientSession(
+        headers=github_headers, raise_for_status=True
+    ) as session:
+        async with session.post(github_gist_endpoint, json=request_data) as resp:
+            response_object = await resp.json()
+            return response_object.get("html_url")

misc/config.toml

@@ -26,6 +26,10 @@ url = "postgres://statbot:passwordhere@localhost/statbot_ro"
 # when doing a bulk message cleanup
 max-cleanup-messages = "500"
 
+# Your github oauth token for creating gists with the 
+# !gist command. 
+gist-oauth-token = ""
+
 [delay]
 # Configuration for the delayed event queue