Merge branch 'develop' into feature/forced-plugins

Author: khakers

.dockerignore

@@ -4,10 +4,8 @@
 **
 !/cogs
 !/core
-!/plugins
-!*.py
+!bot.py
 !LICENSE
 !pdm.lock
 !pyproject.toml
 !README.md
-

.github/workflows/docker-image.yml

@@ -22,21 +22,21 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - 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: |
@@ -50,11 +50,11 @@ 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: .
           push: true
-          platforms: linux/amd64,linux/arm64, linux/arm64/v7
+          platforms: linux/amd64,linux/arm64
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           sbom: true

.github/workflows/lint.yml

@@ -12,7 +12,7 @@ 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
@@ -21,12 +21,16 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64
+    - name: Setup PDM
+      uses: pdm-project/setup-pdm@v4
+      with:
+        cache: true
     - name: Install dependencies
       run: |
-        python -m pip install black ruff
+        pdm install --group dev
     - name: Ruff
-      run: ruff . --no-fix
+      run: pdm run ruff . --no-fix
       continue-on-error: true
     - name: Black
       run: |
-        black . --diff --check
+        pdm run black . --diff --check

.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: "23.10.1"
+    rev: "24.4.2"
     hooks:
       - id: black
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.1.4'
+    rev: 'v0.4.9'
     hooks:
       - id: ruff
   - repo: https://github.com/pdm-project/pdm

CHANGELOG.md

@@ -10,20 +10,32 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 
 ### 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.
+- Remove internal logviewer plugin
 
 ### 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.
+- `?log key <key>` to retrieve the log link and view a preview using a log key. ([PR #3196](https://github.com/modmail-dev/Modmail/pull/3196))
 - Add Forced plugins. Allows auto installing un-removable plugins via `FORCED_PLUGINS` environment variable contain a comma separate list of plugins. (GH#5)
 
 ### Changed
 - Changing a threads title or NSFW status immediately updates the status in the database.
+- Replace Pipenv with PDM
+- Bump discord.py version to 2.3.2
+- Rewrote docker build for PDM
+
+### Removed
+- Remove Discord.py dependency version check
+- Remove modmail telemetry
+- Remove lottie sticker support
 
 ### 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.
+- Fix contact command reporting user was blocked when they weren't.
+- Cleanup imports after removing/unloading a plugin. ([PR #3226](https://github.com/modmail-dev/Modmail/pull/3226))
 
 ### Internal
 - Add `update_title` and `update_nsfw` methods to `ApiClient` to update thread title and nsfw status in the database.
@@ -43,6 +55,7 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Support for trailing space in `?prefix` command, example: `?prefix "mm "` for `mm ping`.
 - Added logviewer as built-in local plugin `?plugin load @local/logviewer`.
 - `?plugin uninstall` is now an alias for `?plugin remove` ([GH #3260](https://github.com/modmail-dev/modmail/issues/3260))
+- `DISCORD_LOG_LEVEL` environment variable to set the log level of discord.py. ([PR #3216](https://github.com/modmail-dev/Modmail/pull/3216))
 
 ### Changed
 - Guild icons in embed footers and author urls now have a fixed size of 128. ([PR #3261](https://github.com/modmail-dev/modmail/pull/3261))
@@ -67,10 +80,15 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Fixed uncached member issue in large guild for react_to_contact and ticket creation.
 - Fixed blocked roles improperly saving in `blocked_users` config.
 - Fixed `?block` command improperly parsing reason as timestamp. 
+- Rate limit issue when fetch the messages due to reaction linking. ([PR #3306](https://github.com/modmail-dev/Modmail/pull/3306))
+- Update command fails when the plugin is invalid. ([PR #3295](https://github.com/modmail-dev/Modmail/pull/3295))
 
 ### Internal
 - `ConfigManager.get` no longer accepts two positional arguments: the `convert` argument is now keyword-only.
 
+### Internal
+- Renamed `Bot.log_file_name` to `Bot.log_file_path`. Log files are now created at `temp/logs/modmail.log`. ([PR #3216](https://github.com/modmail-dev/Modmail/pull/3216))
+
 # v4.0.2
 
 ### Breaking

README.md

@@ -31,10 +31,6 @@
 
 I am the developer of [modmail-viewer](https://github.com/khakers/modmail-viewer), which is the recommended way to view
 logs for this fork.
-Although you can use the built-in logviewer plugin, it is not recommended as it is not as feature-rich as
-modmail-viewer, and I do not intend to maintain it.
-The logviewer plugin is included with this fork, but it is disabled by default, and it contains extras features and
-security fixes that are not present in the original logviewer plugin.
 
 ## Features
 
@@ -91,7 +87,6 @@ This guide assumes you have git, and a supported Python version installed and ad
     ```console
     $ pdm run bot
     ```
-9. Load the logviewer plugin included with Modmail with `?plugin load @local/logviewer`
 
 ### Running the Docker Image
 

app.json

@@ -11,10 +11,6 @@
             "description": "The id for the server you are hosting this bot for.",
             "required": true
         },
-        "MODMAIL_GUILD_ID": {
-            "description": "The ID of the discord server where the threads channels should be created (receiving server). Default to GUILD_ID.",
-            "required": false
-        },
         "OWNERS": {
             "description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval).",
             "required": true
@@ -68,4 +64,4 @@
             "required": false
         }
     }
-}
+}