Merge develop into stable

.dockerignore

@@ -130,26 +130,27 @@ dmypy.json
 package-lock.json
 node_modules/
 
-# Modmail
+# Unused Modmail files
 config.json
 plugins/
 !plugins/registry.json
 !plugins/@local/
 temp/
 test.py
 
-# Other stuff
+# Unused repository files
 .env.example
 .gitignore
 .dockerignore
 .github/
+.pre-commit-config.yaml
 app.json
 Procfile
-pyproject.toml
 *.md
 .*.json
 Dockerfile
 docker-compose.yml
+requirements.txt
 LICENSE
 PRIVACY.md
 

.env.example

@@ -1,5 +1,44 @@
+# Your Discord bot token
 TOKEN=MyBotToken
-LOG_URL=https://logviewername.herokuapp.com/
-GUILD_ID=1234567890
-OWNERS=Owner1ID,Owner2ID,Owner3ID
-CONNECTION_URI=mongodb+srv://mongodburi
+
+# ID of your Discord server
+GUILD_ID=123456
+
+# ID of the server the thread channels will be created in
+# MODMAIL_GUILD_ID=123456
+
+# Discord ID of the owners
+OWNERS=123456,123456
+
+# Connection URI for your mongodb
+CONNECTION_URI=mongod+srv://mongo.net
+
+# The url of logviewer for viewing self-hosted logs
+# LOG_URL=https://logviewername.domain.com/
+
+# The path to your log viewer extending from your `LOG_URL`, defaults to "/logs"
+# LOG_URL_PREFIX=/logs
+
+# A github personal access token with the repo scope to access private repository
+# GITHUB_TOKEN=abcdef
+
+# If set to true, only plugins that are in the registry can be loaded
+# REGISTRY_PLUGINS_ONLY=false
+
+# Client ID for your application, used by logviewer`
+# OAUTH2_CLIENT_ID=12345
+
+# Client Secret for your application, used by logviewer
+# OAUTH2_CLIENT_SECRET=abcdef
+
+# The redirect URL for logviewer OAuth. You must also add this URL in your application's Redirects section
+# OAUTH2_REDIRECT_URI=https://logviewername.herokuapp.com/callback
+
+# The host address logviewer will bind itself to. Defaults to 0.0.0.0
+# HOST=0.0.0.0
+
+# The port logviewer plugin will listen to. Defaults to 8000
+# PORT=8000
+
+# The number of logs to display per page on logviewer. Defaults to 25
+# LOGVIEWER_PAGINATION=25

.github/FUNDING.yml

@@ -1 +1,2 @@
 ko_fi: raidensakura
+github: raidensakura

.github/workflows/docker-image.yml

@@ -8,9 +8,6 @@ on:
       - 'develop'
     tags:
       - 'v*'
-  pull_request:
-    branches:
-      - 'develop'
 
 env:
   REGISTRY: ghcr.io
@@ -25,18 +22,24 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
       - name: Log in to the Container registry
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
@@ -51,9 +54,12 @@ jobs:
             type=raw,value=latest,enable=${{ github.event.release.prerelease == false }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v5
         with:
           context: .
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/lint.yml

@@ -12,12 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8"]
+        python-version: ["3.11"]
     name: Python ${{ matrix.python-version }} on ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64

.github/workflows/load-check.yml

@@ -16,40 +16,39 @@ jobs:
 
     name: Load Modmail - Python ${{ matrix.python-version }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-
-      - name: Cache venv
-        id: cache-venv
+      - uses: Gr1N/setup-poetry@v8
+      - name: Cache poetry
+        id: cache-poetry
         uses: actions/cache@v3
         with:
-          path: .venv
-          key: ${{ matrix.python-version }}-${{ hashFiles('Pipfile') }}-${{ secrets.CACHE_V }}
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
 
-      - name: Maybe make pipenv
+      - name: Maybe install dependencies
         if: steps.cache-venv.outputs.cache-hit != 'true'
-        run: |
-          pip install pipenv && PIPENV_VENV_IN_PROJECT=1
-          pipenv install --deploy
+        run: poetry install --no-root
 
       - name: Run script loadcheck.py
         run: |
-          pipenv run python .github/workflows/scripts/loadcheck.py
+          poetry run python .github/workflows/scripts/loadcheck.py
         env:
           TOKEN: ${{ secrets.DISCORD_TEST_BOT }}
           CONNECTION_URI: ${{ secrets.CONNECTION_URI }}
           LOG_URL: https://domain.example
           GUILD_ID: "616969119685935162"
+          MODMAIL_GUILD_ID: "1100011945207271494"
           OWNERS: "243316261264556032,505386507440488458"
           DATA_COLLECTION: off
           LOG_LEVEL: DEBUG
 
       - name: Save Modmail output as Artifact
         if: always() # still run if prev step failed
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "Modmail log - Python ${{ matrix.python-version }}"
           path: modmail.log

.github/workflows/scripts/loadcheck.py

@@ -14,7 +14,7 @@
 
 file = open("modmail.log", "w")
 proc = subprocess.Popen(
-    "pipenv run bot",
+    "poetry run python bot.py",
     stdout=file,
     stderr=subprocess.STDOUT,
     shell=True,

CHANGELOG.md

@@ -8,6 +8,42 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 
 # [UNRELEASED]
 
+### Breaking
+- Completely rewritten blocklist system. Blocklisting now runs off its own mongoDB collection. This once again introduces backwards incompatible schema changes, so a manual migration is required. You may upgrade from both v4.0 and v4.1 using the `[p]migrate blocklist` command. This removes any need to perform the previous migration steps in v4.1.0, you may upgrade directly to this version. After running the command, blocklist functionality will return and legacy config based blocks will have been deleted. You should always back up your config before migration.
+- Migrated package manager from pipenv to Poetry. Dockerfile and GitHub Actions are also now set up to install using Poetry.
+
+### Deprecated
+- Legacy blocklist properties are deprecated and no longer function. They now log a warning when used and provide no functionality. They have been replaced with methods in blocklist.py 
+
+### Added
+- Added `content_type` to attachments stored in the database.
+- Introduced multiplatform Docker workflow for GitHub Actions.
+- Improved join/leave message for multiple servers.
+
+### Changed
+- Changing a threads title or NSFW status immediately updates the status in the database.
+
+### Removed
+- The logviewer plugin is no longer included locally.
+- Removed lottie sticker support and its dependencies due to unnecessary bulk.
+
+### Fixed
+- Persistent notes have been fixed after the previous discord.py update.
+- `is_image` now is true only if the image is actually an image.
+- Resolved deprecated pkg_resources warning in certain Python environment.
+- Improved genesis message retrieval checks where it would fail under certain circumstances.
+- Fixed failure on installing local plugins when plugin path contains whitespace.
+- Fixed sticker replies not being sent in a Modmail thread.
+- Fixed plugin update command where it would fail to remove the plugin when the plugin is invalid.
+- Fixed MissingRequiredArgument requiring additional param.
+- Fixed rate limit issue on raw reaction add/remove events.
+
+### Internal
+- Add `update_title` and `update_nsfw` methods to `ApiClient` to update thread title and nsfw status in the database.
+- `thread.set_title` now requires `channel_id` to be passed as keyword arguments.
+- New `thread.set_nsfw_status` method to set nsfw status of a thread.
+- Updated discord.py to 2.3.2, with [speed] extra.
+
 # v4.1.0
 
 ### Breaking
@@ -46,6 +82,9 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Fixed blocked roles improperly saving in `blocked_users` config.
 - Fixed `?block` command improperly parsing reason as timestamp. 
 
+### Internal
+- `ConfigManager.get` no longer accepts two positional arguments: the `convert` argument is now keyword-only.
+
 # v4.0.2
 
 ### Breaking

Dockerfile

@@ -1,27 +1,37 @@
 FROM python:3.11-alpine as base
 
 RUN apk update && apk add git \
-	# cairosvg dependencies
-	cairo-dev cairo cairo-tools \
 	# pillow dependencies
-	jpeg-dev zlib-dev
+	jpeg-dev zlib-dev && \
+    pip install --upgrade pip && \
+	adduser -D -h /home/modmail -g 'Modmail' modmail
 
-FROM base as python-deps
+WORKDIR /home/modmail
 
-RUN apk add --virtual build-deps build-base gcc libffi-dev
-COPY requirements.txt /
-RUN pip install --prefix=/inst -U -r /requirements.txt
+FROM base as builder
+
+ENV POETRY_NO_INTERACTION=1 \
+    POETRY_VIRTUALENVS_IN_PROJECT=1 \
+    POETRY_VIRTUALENVS_CREATE=1 \
+    POETRY_CACHE_DIR=/tmp/poetry_cache
+
+RUN apk add build-base libffi-dev && \
+	pip install -U poetry
+
+COPY --chown=modmail:modmail poetry.lock pyproject.toml /home/modmail/
+
+RUN --mount=type=cache,target=$POETRY_CACHE_DIR poetry install --without dev --no-root
 
 FROM base as runtime
 
-ENV USING_DOCKER yes
-COPY --from=python-deps /inst /usr/local
+ENV VIRTUAL_ENV=/home/modmail/.venv \
+    PATH="/home/modmail/.venv/bin:$PATH" \
+    USING_DOCKER=yes
 
-COPY . /modmail
-WORKDIR /modmail
+COPY --from=builder --chown=modmail:modmail ${VIRTUAL_ENV} ${VIRTUAL_ENV}
 
-CMD ["python", "bot.py"]
+COPY --chown=modmail:modmail . .
+
+USER modmail
 
-RUN adduser --disabled-password --gecos '' app && \
-    chown -R app /modmail
-USER app
+CMD ["python", "bot.py"]