Autoupdate functions

Author: fourjr

CHANGELOG.md

@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project mostly adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html);
 however, insignificant breaking changes do not guarantee a major version bump, see the reasoning [here](https://github.com/kyb3r/modmail/issues/319). If you're a plugin developer, note the "BREAKING" section.
 
-# v3.7.0-dev16
+# v3.7.0-dev17
 
 ### Added
 
@@ -28,6 +28,7 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Added `data_collection` to specify if bot metadata should be collected by Modmail developers.
 - Added `?autotrigger`, `use_regex_autotrigger` config to specify keywords to trigger commands. ([GH #130](https://github.com/kyb3r/modmail/issues/130), [GH #649](https://github.com/kyb3r/modmail/issues/649))
 - Added `?note persistent` that creates notes that are persistent for a user. ([GH #2842](https://github.com/kyb3r/modmail/issues/2842), [PR #2878](https://github.com/kyb3r/modmail/pull/2878))
+- Autoupdates and `?update` which was removed in v3.0.0
 
 ### Fixed
 

bot.py

@@ -1,11 +1,12 @@
-__version__ = "3.7.0-dev16"
+__version__ = "3.7.0-dev17"
 
 
 import asyncio
 import copy
 import logging
 import os
 import re
+import subprocess
 import sys
 import typing
 from datetime import datetime
@@ -31,9 +32,17 @@
     pass
 
 from core import checks
+from core.changelog import Changelog
 from core.clients import ApiClient, MongoDBClient, PluginDatabaseClient
 from core.config import ConfigManager
-from core.models import DMDisabled, PermissionLevel, SafeFormatter, configure_logging, getLogger
+from core.models import (
+    DMDisabled,
+    HostingMethod,
+    PermissionLevel,
+    SafeFormatter,
+    configure_logging,
+    getLogger,
+)
 from core.thread import ThreadManager
 from core.time import human_timedelta
 from core.utils import human_join, match_title, normalize_alias
@@ -58,6 +67,7 @@ def __init__(self):
         self._session = None
         self._api = None
         self.metadata_loop = None
+        self.autoupdate_loop = None
         self.formatter = SafeFormatter()
         self.loaded_cogs = ["cogs.modmail", "cogs.plugins", "cogs.utility"]
         self._connected = asyncio.Event()
@@ -88,6 +98,21 @@ def uptime(self) -> str:
 
         return self.formatter.format(fmt, d=days, h=hours, m=minutes, s=seconds)
 
+    @property
+    def hosting_method(self) -> HostingMethod:
+        # use enums
+        if ".heroku" in os.environ.get("PYTHONHOME", ""):
+            return HostingMethod.HEROKU
+
+        if os.environ.get("pm_id"):
+            return HostingMethod.PM2
+
+        return HostingMethod.OTHER
+
+    @property
+    def is_pm2(self) -> bool:
+        return ".heroku" in os.environ.get("PYTHONHOME", "")
+
     def startup(self):
         logger.line()
         if os.name != "nt":
@@ -494,6 +519,12 @@ async def on_ready(self):
             self.metadata_loop.before_loop(self.before_post_metadata)
             self.metadata_loop.start()
 
+        self.autoupdate_loop = tasks.Loop(
+            self.autoupdate, seconds=0, minutes=0, hours=1, count=None, reconnect=True, loop=None
+        )
+        self.autoupdate_loop.before_loop(self.before_autoupdate)
+        self.autoupdate_loop.start()
+
         other_guilds = [
             guild for guild in self.guilds if guild not in {self.guild, self.modmail_guild}
         ]
@@ -1398,6 +1429,81 @@ async def before_post_metadata(self):
         if not self.guild:
             self.metadata_loop.cancel()
 
+    async def autoupdate(self):
+        changelog = await Changelog.from_url(self)
+        latest = changelog.latest_version
+
+        if self.version < parse_version(latest.version):
+            if self.hosting_method == HostingMethod.HEROKU:
+                data = await self.api.update_repository()
+
+                embed = discord.Embed(color=self.main_color)
+
+                commit_data = data["data"]
+                user = data["user"]
+                embed.set_author(
+                    name=user["username"] + " - Updating Bot",
+                    icon_url=user["avatar_url"],
+                    url=user["url"],
+                )
+
+                embed.set_footer(text=f"Updating Modmail v{self.version} " f"-> v{latest.version}")
+
+                embed.description = latest.description
+                for name, value in latest.fields.items():
+                    embed.add_field(name=name, value=value)
+
+                if commit_data:
+                    message = commit_data["commit"]["message"]
+                    html_url = commit_data["html_url"]
+                    short_sha = commit_data["sha"][:6]
+                    embed.add_field(
+                        name="Merge Commit",
+                        value=f"[`{short_sha}`]({html_url}) " f"{message} - {user['username']}",
+                    )
+                    logger.info("Bot has been updated.")
+                    channel = self.log_channel
+                    await channel.send(embed=embed)
+            else:
+                command = "git pull"
+
+                cmd = subprocess.run(
+                    command,
+                    cwd=os.getcwd(),
+                    stderr=subprocess.PIPE,
+                    stdout=subprocess.PIPE,
+                    shell=True,
+                )
+                res = cmd.stdout.decode("utf-8").strip()
+
+                if res != "Already up to date.":
+                    logger.info("Bot has been updated.")
+                    channel = self.log_channel
+                    if self.hosting_method == HostingMethod.PM2:
+                        embed = discord.Embed(title="Bot has been updated", color=self.main_color)
+                        await channel.send(embed=embed)
+                    else:
+                        embed = discord.Embed(
+                            title="Bot has been updated and is logging out.",
+                            description="If you do not have an auto-restart setup, please manually start the bot.",
+                            color=self.main_color,
+                        )
+                        await channel.send(embed=embed)
+                        await self.logout()
+
+    async def before_autoupdate(self):
+        await self.wait_for_connected()
+        logger.debug("Starting autoupdate loop")
+
+        if self.config.get("disable_autoupdates"):
+            logger.warning("Autoupdates disabled.")
+            self.autoupdate_loop.cancel()
+
+        if not self.config.get("github_token"):
+            logger.warning("GitHub access token not found.")
+            logger.warning("Autoupdates disabled.")
+            self.autoupdate_loop.cancel()
+
 
 def main():
     try:

cogs/modmail.py

@@ -1535,6 +1535,15 @@ async def isenable(self, ctx):
 
         return await ctx.send(embed=embed)
 
+    @commands.command(usage="[after] [close message]")
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    @checks.thread_only()
+    async def adduser(self, ctx, *, member: discord.Member = None):
+        await ctx.thread.add_user(member)
+
+        sent_emoji, _ = await self.bot.retrieve_emoji()
+        await self.bot.add_reaction(ctx.message, sent_emoji)
+
 
 def setup(bot):
     bot.add_cog(Modmail(bot))

cogs/utility.py

@@ -10,6 +10,7 @@
 from io import BytesIO, StringIO
 from itertools import takewhile, zip_longest
 from json import JSONDecodeError, loads
+import subprocess
 from textwrap import indent
 from types import SimpleNamespace
 from typing import Union
@@ -24,12 +25,13 @@
 from core import checks, utils
 from core.changelog import Changelog
 from core.models import (
+    HostingMethod,
     InvalidConfigError,
     PermissionLevel,
-    SimilarCategoryConverter,
     UnseenFormatter,
     getLogger,
 )
+from core.utils import trigger_typing
 from core.paginator import EmbedPaginatorSession, MessagePaginatorSession
 
 
@@ -1825,6 +1827,122 @@ async def autotrigger_list(self, ctx):
 
         await EmbedPaginatorSession(ctx, *embeds).run()
 
+    @commands.command()
+    @checks.has_permissions(PermissionLevel.OWNER)
+    @checks.github_token_required()
+    @trigger_typing
+    async def github(self, ctx):
+        """Shows the GitHub user your Github_Token is linked to."""
+        data = await self.bot.api.get_user_info()
+
+        embed = discord.Embed(
+            title="GitHub", description="Current User", color=self.bot.main_color
+        )
+        user = data["user"]
+        embed.set_author(name=user["username"], icon_url=user["avatar_url"], url=user["url"])
+        embed.set_thumbnail(url=user["avatar_url"])
+        await ctx.send(embed=embed)
+
+    @commands.command()
+    @checks.has_permissions(PermissionLevel.OWNER)
+    @checks.github_token_required(ignore_if_not_heroku=True)
+    @trigger_typing
+    async def update(self, ctx, *, flag: str = ""):
+        """
+        Update Modmail.
+        This only works for PM2 or Heroku users who have configured their bot for updates.
+        To stay up-to-date with the latest commit
+        from GitHub, specify "force" as the flag.
+        """
+
+        changelog = await Changelog.from_url(self.bot)
+        latest = changelog.latest_version
+
+        desc = (
+            f"The latest version is [`{self.bot.version}`]"
+            "(https://github.com/kyb3r/modmail/blob/master/bot.py#L25)"
+        )
+
+        if self.bot.version >= parse_version(latest.version) and flag.lower() != "force":
+            embed = discord.Embed(
+                title="Already up to date", description=desc, color=self.bot.main_color
+            )
+
+            data = await self.bot.api.get_user_info()
+            if not data.get("error"):
+                user = data["user"]
+                embed.set_author(
+                    name=user["username"], icon_url=user["avatar_url"], url=user["url"]
+                )
+            await ctx.send(embed=embed)
+        else:
+            if self.bot.hosting_method == HostingMethod.HEROKU:
+                data = await self.bot.api.update_repository()
+
+                commit_data = data["data"]
+                user = data["user"]
+
+                if commit_data:
+                    embed = discord.Embed(color=self.bot.main_color)
+
+                    embed.set_footer(
+                        text=f"Updating Modmail v{self.bot.version} " f"-> v{latest.version}"
+                    )
+
+                    embed.set_author(
+                        name=user["username"] + " - Updating bot",
+                        icon_url=user["avatar_url"],
+                        url=user["url"],
+                    )
+
+                    embed.description = latest.description
+                    for name, value in latest.fields.items():
+                        embed.add_field(name=name, value=value)
+                    # message = commit_data['commit']['message']
+                    html_url = commit_data["html_url"]
+                    short_sha = commit_data["sha"][:6]
+                    embed.add_field(name="Merge Commit", value=f"[`{short_sha}`]({html_url})")
+                else:
+                    embed = discord.Embed(
+                        title="Already up to date with master repository.",
+                        description="No further updates required",
+                        color=self.bot.main_color,
+                    )
+                    embed.set_author(
+                        name=user["username"], icon_url=user["avatar_url"], url=user["url"]
+                    )
+                await ctx.send(embed=embed)
+            else:
+                command = "git pull"
+
+                cmd = subprocess.run(
+                    command,
+                    cwd=os.getcwd(),
+                    stderr=subprocess.PIPE,
+                    stdout=subprocess.PIPE,
+                    shell=True,
+                )
+                res = cmd.stdout.decode("utf-8").strip()
+
+                if res != "Already up to date.":
+                    logger.info("Bot has been updated.")
+                    if self.bot.hosting_method == HostingMethod.PM2:
+                        embed = discord.Embed(
+                            title="Bot has been updated", color=self.bot.main_color
+                        )
+                        await ctx.send(embed=embed)
+                    else:
+                        embed = discord.Embed(
+                            title="Bot has been updated and is logging out.",
+                            description="If you do not have an auto-restart setup, please manually start the bot.",
+                            color=self.bot.main_color,
+                        )
+                        await ctx.send(embed=embed)
+                        await self.bot.logout()
+                else:
+                    embed = discord.Embed(title="Already up to date.", color=self.bot.main_color,)
+                    await ctx.send(embed=embed)
+
     @commands.command(hidden=True, name="eval")
     @checks.has_permissions(PermissionLevel.OWNER)
     async def eval_(self, ctx, *, body: str):

core/checks.py

@@ -1,6 +1,6 @@
 from discord.ext import commands
 
-from core.models import PermissionLevel, getLogger
+from core.models import HostingMethod, PermissionLevel, getLogger
 
 logger = getLogger(__name__)
 
@@ -100,3 +100,23 @@ async def predicate(ctx):
 
     predicate.fail_msg = "This is not a Modmail thread."
     return commands.check(predicate)
+
+
+def github_token_required(ignore_if_not_heroku=False):
+    """
+    A decorator that ensures github token
+    is set
+    """
+
+    async def predicate(ctx):
+        if ignore_if_not_heroku and ctx.bot.hosting_method != HostingMethod.HEROKU:
+            return True
+        else:
+            return ctx.bot.config.get("github_token")
+
+    predicate.fail_msg = (
+        "You can only use this command if you have a "
+        "configured `GITHUB_TOKEN`. Get a "
+        "personal access token from developer settings."
+    )
+    return commands.check(predicate)