Merge branch 'development' into snippets-preview

Author: sebkuip

CHANGELOG.md

@@ -6,6 +6,15 @@ 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/modmail-dev/modmail/issues/319). If you're a plugin developer, note the "BREAKING" section.
 
+# v4.1.1
+
+### Fixed
+- `?msglink` now supports threads with multiple recipients. ([PR #3341](https://github.com/modmail-dev/Modmail/pull/3341))
+- Fixed persistent notes not working due to discord.py internal change. ([PR #3324](https://github.com/modmail-dev/Modmail/pull/3324))
+
+### Added
+- Support for custom activities with `?activity custom <text>` ([PR #3352](https://github.com/modmail-dev/Modmail/pull/3352))
+
 # v4.1.0
 
 Drops support for Python 3.9. Python 3.10 and Python 3.11 are now the only supported versions.
@@ -14,7 +23,7 @@ Drops support for Python 3.9. Python 3.10 and Python 3.11 are now the only suppo
 - GIF stickers no longer cause the bot to crash.
 - `?alias make/create` as aliases to `?alias add`. This improves continuity between the bot and its command structure. ([PR #3195](https://github.com/kyb3r/modmail/pull/3195))
 - Loading the blocked list with the `?blocked` command takes a long time when the list is large. ([PR #3242](https://github.com/kyb3r/modmail/pull/3242))
-- Reply not being forwarded from DM. (PR [#3239](https://github.com/modmail-dev/modmail/pull/3239))
+- Reply not being forwarded from DM. ([PR #3239](https://github.com/modmail-dev/modmail/pull/3239))
 - Cleanup imports after removing/unloading a plugin. ([PR #3226](https://github.com/modmail-dev/Modmail/pull/3226))
 - Fixed a syntactic error in the close message when a thread is closed after a certain duration. ([PR #3233](https://github.com/modmail-dev/Modmail/pull/3233))
 - Removed an extra space in the help command title when the command has no parameters. ([PR #3271](https://github.com/modmail-dev/Modmail/pull/3271))

Dockerfile

@@ -1,20 +1,38 @@
-FROM python:3.10 as py
+FROM python:3.11-slim-bookworm as base
 
-FROM py as build
+RUN apt-get update &&  \
+    apt-get install --no-install-recommends -y \
+    # Install CairoSVG dependencies.
+    libcairo2 && \
+    # Cleanup APT.
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/* && \
+    # Create a non-root user.
+    useradd --shell /usr/sbin/nologin --create-home -d /opt/modmail modmail
 
-RUN apt update && apt install -y g++ git
+FROM base as builder
 
-COPY requirements.txt /
-RUN pip install --prefix=/inst -U -r /requirements.txt
+COPY requirements.txt .
 
-FROM py
+RUN pip install --root-user-action=ignore --no-cache-dir --upgrade pip wheel && \
+    python -m venv /opt/modmail/.venv && \
+    . /opt/modmail/.venv/bin/activate && \
+    pip install --no-cache-dir --upgrade -r requirements.txt
 
-COPY --from=build /inst /usr/local
+FROM base
 
-ENV USING_DOCKER yes
-RUN useradd --system --no-create-home modmail
-USER modmail
+# Copy the entire venv.
+COPY --from=builder --chown=modmail:modmail /opt/modmail/.venv /opt/modmail/.venv
+
+# Copy repository files.
+WORKDIR /opt/modmail
+USER modmail:modmail
+COPY --chown=modmail:modmail . .
+
+# This sets some Python runtime variables and disables the internal auto-update.
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PATH=/opt/modmail/.venv/bin:$PATH \
+    USING_DOCKER=yes
 
-WORKDIR /modmailbot
 CMD ["python", "bot.py"]
-COPY --chown=modmail:modmail . /modmailbot

README.md

@@ -147,6 +147,13 @@ Advertise Your Server:
 </a>
 <br>
 <br>
+Help Us • Help Other's:
+<br>
+<a href='https://discord.gg/5yQCFzY6HU'>
+  <img height=100 src='https://i.imgur.com/Gi3jxeH.gif' style='margin:5px'>
+</a>
+<br>
+<br>
 Discord Advice Center:
 <br>
 <a href='https://discord.gg/zmwZy5fd9v'>

SPONSORS.json

@@ -81,7 +81,7 @@
                 "icon_url": "https://i.imgur.com/cjVtRw5.jpg"
             },
             "image": {
-                "url":  "https://i.imgur.com/1hrjcHd.png"
+                "url": "https://i.imgur.com/1hrjcHd.png"
             },
             "fields": [
                 {
@@ -91,23 +91,6 @@
             ]
         }
     },
-    {
-        "embed": {
-            "title": "Advertise Your Server",
-            "description": "Advertise Your Server is the leading advertising and growth Discord Server. With over 60,000 members we can help grow your community with our range of services.\n\n__**Advertise Your Server offers everything you need to grow and find servers:**__\n\n:chart_with_upwards_trend: **Discord Growth Experts** to give you advice on how to __grow your server.__ (server/advert reviews, growth tips)\n:dividers: Over 40 different channels for **different server categories.**\n:robot: Our own __custom__ **bump bot.** (Liam)\n:bar_chart: Currently the __BIGGEST__ advertising server on Discord.\n:computer: Our own server __Listing Site__!\n:ticket: Small Servers Program for servers with less than 300 members.\n:dvd: Weekly Podcast, Blog, Email Newsletter and YouTube Tutorials. \n\nhttps://discord.gg/zP8KcF4VQz\nhttps://aysdiscord.com",
-            "author": {
-                "name": "Advertise Your Server",
-                "icon_url": "https://cdn.discordapp.com/attachments/563522692418895872/907067815486427176/logo4.png"
-            },
-            "color": 431075,
-            "footer": {
-                "text": "Grow Your Discord Server"
-            },
-            "image": {
-                "url": "https://cdn.discordapp.com/attachments/472811257913933834/907068966311166043/unknown_2.png"
-            }
-        }
-    },
     {
         "embed": {
             "footer": {
@@ -128,5 +111,52 @@
             "url": "https://discord.gg/uncommon",
             "title": "uncommon community"
         }
+    },
+    {
+        "embed": {
+            "author": {
+                "name": "Help us • Help Others"
+            },
+            "title": "Join Today",
+            "url": "https://discord.gg/5yQCFzY6HU",
+            "description": "At Help Us • Help Others, we accept as true with inside the transformative electricity of cooperation and kindness. Each one people has the capability to make a meaningful impact by means of helping and caring for others. Whether you want assistance or want to offer it, this is the right region for you!",
+            "fields": [
+                {
+                    "name": "What we offer:",
+                    "value": "`🎬` - Active community\n`👮` - Active staff around the globe! \n`🛜` - 40+ Advertising channels to grow your socials!\n`💎` - Boosting Perks\n`🎉` - Event's monthly especially bank holiday roles!!\n`🔢` - Unique levelling systems\n`📞` - Multiple voice channels including gaming!\n`🎁` - Exclusive giveaways!"
+                },
+                {
+                    "name": "We Are Hiring",
+                    "value": "`🔵` - Moderators\n`🔵` - Human Resources\n`🔵` - Community Team\n`🔵` - Partnership Manager\n`🔵` - Growth Manager\n`🚀` Much more to come!\n\n\nJoin Today!"
+                }
+            ],
+            "image": {
+                "url": "https://cdn.discordapp.com/attachments/1218338794416246874/1243635366326567002/AD_animated.gif"
+            },
+            "color": 45300,
+            "footer": {
+                "text": "Help Us • Help Others"
+            }
+        }
+    },
+    {
+        "embed": {
+            "description": "> Be apart of our community as we start to grow! and embark on a long journey.\n——————————————————-\n**What we offer?**\n\n➺〚🖌️〛Custom Liveries \n➺〚❤️〛Friendly and Growing community.\n➺〚🤝〛Partnerships.\n➺〚🎮〛Daily SSUs. \n➺〚🚨〛Great roleplays.\n➺〚💬〛Kind and Professional staff\n➺〚🎉〛Giveaways!!! \n——————————————————-\n**Emergency Services**\n\n➺〚🚔〛NY Police Force\n➺〚🚒〛Fire & Emergency NY\n➺〚🚧〛NY department of transportation \n\n——————————————————-\n**Whitelisted**\nComing soon!\n——————————————————-\n**What are we looking for!**\n\n➺〚💬〛More members\n➺〚⭐〛Staff Members - **WE'RE HIRING!**\n➺〚🤝〛Partnerships\n➺〚💎〛Boosters\n——————————————————\n\n**[Join now](https://discord.com/invite/qt62qSnKVa)**",
+            "author": {
+                "name": "New York Roleplay",
+                "icon_url": "https://cdn.discordapp.com/icons/1172553254882775111/648d5bc50393a21216527a1aaa61286d.webp"
+            },
+            "color": 431075,
+            "thumbnail": {
+                "url": "https://cdn.discordapp.com/icons/1172553254882775111/648d5bc50393a21216527a1aaa61286d.webp"
+            }
+        }
+    },
+    {
+        "embed": {
+            "title": "CityStore PLC",
+            "description": "*Your Retail Journey*\n*\"Better choice and better value in food, fashion & homewares.\"*\n\n\n**------------------------------------------**\n*__About us__*\nSupermarket, CityStore PLC! Attend a training to become staff!\n\nThis game is currently in V3\n\nWe have a training Centre and applications center!\n\n**------------------------------------------**\n\n> *❤️ Don't hesitate! Dive into the excitement today by joining our vibrant community on Discord. Experience our unique perspective and become an integral part of our group. Your **journey** with us promises to be unforgettable no regrets, only great memories await! ❤️*\n\n*We hope to see you. *\n\n*Signed,*\n**CityStore PLC**\n> Discord: https://discord.gg/yjFQb5mrSk\n> Roblox Group: https://www.roblox.com/groups/32819373/CityStore-PLC#!/about\n\nJoin us now and become apart of Citystore PLC community!  🎉",
+            "color": 15523550
+        }
     }
 ]

bot.py

@@ -1,4 +1,4 @@
-__version__ = "4.1.0"
+__version__ = "4.1.1"
 
 
 import asyncio

cogs/modmail.py

@@ -712,9 +712,15 @@ async def sfw(self, ctx):
     @checks.thread_only()
     async def msglink(self, ctx, message_id: int):
         """Retrieves the link to a message in the current thread."""
-        try:
-            message = await ctx.thread.recipient.fetch_message(message_id)
-        except discord.NotFound:
+        found = False
+        for recipient in ctx.thread.recipients:
+            try:
+                message = await recipient.fetch_message(message_id)
+                found = True
+                break
+            except discord.NotFound:
+                continue
+        if not found:
             embed = discord.Embed(
                 color=self.bot.error_color, description="Message not found or no longer exists."
             )

cogs/plugins.py

@@ -6,22 +6,21 @@
 import sys
 import typing
 import zipfile
-from importlib import invalidate_caches
 from difflib import get_close_matches
+from importlib import invalidate_caches
 from pathlib import Path, PurePath
 from re import match
 from site import USER_SITE
 from subprocess import PIPE
 
 import discord
 from discord.ext import commands
-
 from packaging.version import Version
 
 from core import checks
 from core.models import PermissionLevel, getLogger
 from core.paginator import EmbedPaginatorSession
-from core.utils import truncate, trigger_typing
+from core.utils import trigger_typing, truncate
 
 logger = getLogger(__name__)
 
@@ -132,8 +131,11 @@ async def cog_load(self):
 
     async def populate_registry(self):
         url = "https://raw.githubusercontent.com/modmail-dev/modmail/master/plugins/registry.json"
-        async with self.bot.session.get(url) as resp:
-            self.registry = json.loads(await resp.text())
+        try:
+            async with self.bot.session.get(url) as resp:
+                self.registry = json.loads(await resp.text())
+        except asyncio.TimeoutError:
+            logger.warning("Failed to fetch registry. Loading with empty registry")
 
     async def initial_load_plugins(self):
         for plugin_name in list(self.bot.config["plugins"]):
@@ -638,6 +640,14 @@ async def plugins_registry(self, ctx, *, plugin_name: typing.Union[int, str] = N
 
         registry = sorted(self.registry.items(), key=lambda elem: elem[0])
 
+        if not registry:
+            embed = discord.Embed(
+                color=self.bot.error_color,
+                description="Registry is empty. This could be because it failed to load.",
+            )
+            await ctx.send(embed=embed)
+            return
+
         if isinstance(plugin_name, int):
             index = plugin_name - 1
             if index < 0:

cogs/utility.py

@@ -499,6 +499,7 @@ async def activity(self, ctx, activity_type: str.lower, *, message: str = ""):
             - `listening`
             - `watching`
             - `competing`
+            - `custom`
 
         When activity type is set to `listening`,
         it must be followed by a "to": "listening to..."
@@ -510,6 +511,9 @@ async def activity(self, ctx, activity_type: str.lower, *, message: str = ""):
         the linked twitch page:
         - `{prefix}config set twitch_url https://www.twitch.tv/somechannel/`
 
+        When activity type is set to `custom`, you can set
+        any custom text as the activity message.
+
         To remove the current activity status:
         - `{prefix}activity clear`
         """
@@ -609,7 +613,9 @@ async def set_presence(self, *, status=None, activity_type=None, activity_messag
         elif activity_type == ActivityType.streaming:
             url = self.bot.config["twitch_url"]
 
-        if activity_type is not None:
+        if activity_type == ActivityType.custom:
+            activity = discord.CustomActivity(name=activity_message)
+        elif activity_type is not None:
             activity = discord.Activity(type=activity_type, name=activity_message, url=url)
         else:
             activity = None

core/thread.py

@@ -250,7 +250,7 @@ async def send_persistent_notes():
             ids = {}
 
             class State:
-                def store_user(self, user):
+                def store_user(self, user, cache):
                     return user
 
             for note in notes:

pyproject.toml

@@ -21,7 +21,7 @@ extend-exclude = '''
 
 [tool.poetry]
 name = 'Modmail'
-version = '4.1.0'
+version = '4.1.1'
 description = "Modmail is similar to Reddit's Modmail, both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way."
 license = 'AGPL-3.0-only'
 authors = [