Merge branch 'hotfix/2025.2.1'

Author: Kruptein

CHANGELOG.md

@@ -10,6 +10,22 @@ tech changes will usually be stripped from release notes for the public
 
 ## Unreleased
 
+## [2025.2.1]
+
+This fixes/adds support for a wider variety of smtp email servers.
+
+### Added
+
+-   SSL email configuration
+    -   Choose between START TLS / TLS / SSL / LMTP for smtp connection
+
+### Fixed
+
+-   Mail not working in envs where username env is missing (e.g. docker)
+    -   This is a problem in the mail lib used, but circumvented in the Dockerfile
+-   Mail error showing a 500 error in the client
+-   Email setup reset when the config changes to make sure new email values are used
+
 ## [2025.2]
 
 **Server owners:** The server config has changed location and format. Ensure you check the release notes for the necessary info.

Dockerfile

@@ -52,6 +52,8 @@ VOLUME /planarally/static/mods
 ENV PA_GIT_INFO docker:${DOCKER_TAG}-${SOURCE_COMMIT}
 ENV PYTHONUNBUFFERED=1
 ENV UV_CACHE_DIR /planarally/.uv
+# This is only done to ensure that the mail lib does not crash :4
+ENV USERNAME=planarally 
 
 RUN apt-get update && apt-get install --no-install-recommends dumb-init curl libffi-dev libssl-dev gcc -y && \
     rm -rf /var/lib/apt/lists/*

client/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "client",
-    "version": "2025.2.0",
+    "version": "2025.2.1",
     "private": true,
     "type": "module",
     "scripts": {

client/package.json

@@ -1,4 +1,4 @@
-2025.2.0
+2025.2.1
 
 **Server owners:** The server config has changed location and format. Ensure you check the release notes for the necessary info.
 The old config files are not yet removed from git to prevent losing modifications you made to these files.
@@ -64,4 +64,4 @@ They will be removed in a future release though.
 -   Asset picker out of game now uses the newer UI
 -   Dropping assets you have shared-view permission for on the map was not working
 -   Movement only door toggle not immediately rerendering screen
--   Select tool UI would sometimes stick around when there is no shape selected anymore
+-   Select tool UI would sometimes stick around when there is no shape selected anymore

server/VERSION

@@ -1,6 +1,6 @@
 [project]
 name = "planarally-server"
-version = "2025.2.0"
+version = "2025.2.1"
 description = "Planarally server"
 readme = "README.md"
 requires-python = ">=3.13.2"

server/pyproject.toml

@@ -95,12 +95,13 @@ async def forgot_password(request):
     reset_url = f"{cfg().general.client_url}/auth/login?resetToken={reset_token}"
 
     # Send the email
-    send_mail(
+    if not send_mail(
         "Password reset request",
         f"A password reset for the PlanarAlly account associated with this email address was requested. Visit {reset_url} to reset your password. If you did not do this, please ignore this email.",
         f"A password reset for the PlanarAlly account associated with this email address was requested. Visit <a href='{reset_url}'>{reset_url}</a> to reset your password.<br><br>If you did not do this, please ignore this email.",
         [email],
-    )
+    ):
+        return web.HTTPInternalServerError(reason="Failed to send email - check with your administrator")
 
     return web.HTTPOk()
 

server/src/api/http/auth.py

@@ -50,8 +50,10 @@ def load_config(self, *, startup=False) -> None:
 
                 if not startup:
                     from ..logs import logger
+                    from ..mail import reset_email
 
                     logger.info("Config file changed, reloading")
+                    reset_email()
         except rtoml.TomlParsingError as e:
             print(f"Error loading config: {e}")
         except ValidationError as e:

server/src/config/manager.py

@@ -101,6 +101,7 @@ class MailConfig(BaseModel):
     password: Optional[str] = None
     # The default from address to use for emails
     default_from_address: EmailStr
+    ssl_mode: Literal["ssl", "tls", "starttls", "lmtp"] = "starttls"
 
 
 class StatsConfig(BaseModel):

server/src/config/types.py

@@ -1,10 +1,18 @@
+from smtplib import LMTP, SMTP_SSL
+
 from redmail.email.sender import EmailSender
 
 from ..config import cfg
+from ..logs import logger
 
 _email = None
 
 
+def reset_email() -> None:
+    global _email
+    _email = None
+
+
 def get_email() -> EmailSender:
     """
     Get the email sender object.
@@ -28,12 +36,20 @@ def get_email() -> EmailSender:
         if not config.mail.default_from_address:
             raise ValueError("Mail default from address is not set")
 
+        ssl_kwargs = {}
+        if config.mail.ssl_mode == "ssl":
+            ssl_kwargs["cls_smtp"] = SMTP_SSL
+        elif config.mail.ssl_mode == "lmtp":
+            ssl_kwargs["cls_smtp"] = LMTP
+
         _email = EmailSender(
             host=config.mail.host,
             port=config.mail.port,
             # These are wrongly typed in the redmail library
             username=config.mail.username,  # type: ignore
             password=config.mail.password,  # type: ignore
+            use_starttls=config.mail.ssl_mode == "starttls",
+            **ssl_kwargs,
         )
     return _email
 
@@ -44,15 +60,20 @@ def send_mail(
     html: str | None,
     to: str | list[str],
     from_address: str | None = None,
-) -> None:
+) -> bool:
     email = get_email()
     config = cfg()
 
     assert config.mail is not None
-    email.send(
-        subject=subject,
-        text=text,
-        html=html,
-        receivers=to,
-        sender=from_address or config.mail.default_from_address,
-    )
+    try:
+        email.send(
+            subject=subject,
+            text=text,
+            html=html,
+            receivers=to,
+            sender=from_address or config.mail.default_from_address,
+        )
+    except Exception as e:
+        logger.error(f"Error sending mail: {e}")
+        return False
+    return True