Last patch for Flask++ (discontinued)

Author: Pierre

DOCS.md

@@ -580,12 +580,13 @@ The default features of the FppSocket class are its event_context (inspired by F
 
 ```python
 from flaskpp.app.extensions import socket
-from flaskpp.utils.debugger import log
+from flaskpp.utils.logging import log
+
 
 @socket.on("my_event")
 async def event(
-    sid: str,       # if you did not set sid_passing to False
-    payload: Any
+        sid: str,  # if you did not set sid_passing to False
+        payload: Any
 ):
     # here you can access:
     ctx = socket.event_context

src/flaskpp/app/data/__init__.py

@@ -6,7 +6,7 @@
 
 from flaskpp.modules import installed_modules
 from flaskpp.utils import enabled
-from flaskpp.utils.debugger import log
+from flaskpp.utils.logging import debug
 
 if TYPE_CHECKING:
     from flask import Flask
@@ -89,4 +89,4 @@ def _fix_missing(migrations: str):
                 content = f"{import_str}\n{content}"
                 with open(latest_file, "w", encoding="utf-8") as f:
                     f.write(content)
-                log("migrate", f"Fixed missing flask_security import in {latest_file}")
+                debug(f"[MIGRATE] Fixed missing flask_security import in {latest_file}")

src/flaskpp/app/data/fst_base.py src/flaskpp/app/data/fst.pysrc/flaskpp/app/data/fst_base.py renamed to src/flaskpp/app/data/fst.py

@@ -1,14 +1,11 @@
-from importlib import import_module
-from typing import Callable
-import json
-
-from flaskpp.app.data import commit, _package, delete_model
-from flaskpp.app.data.babel import add_entry, get_entries
 from flaskpp.babel import valid_state
 from flaskpp.utils import enabled
-from flaskpp.utils.debugger import log
+from flaskpp.app.utils.i18n import update_translations
 from flaskpp.exceptions import I18nError
 
+
+translations: dict[str, dict[str, str]] = {}
+
 _msg_keys = [
     "NAV_BRAND",
     "NOT_FOUND_TITLE",
@@ -27,7 +24,7 @@
 
 ]
 
-_translations_en = {
+translations["en"] = {
     _msg_keys[0]: "My Flask++ App",
     _msg_keys[1]: "Not Found",
     _msg_keys[2]: "We are sorry, but the requested page doesn't exist.",
@@ -45,7 +42,7 @@
 
 }
 
-_translations_de = {
+translations["de"] = {
     _msg_keys[0]: "Meine Flask++ App",
     _msg_keys[1]: "Nicht Gefunden",
     _msg_keys[2]: "Wir konnten die angefragte Seite leider nicht finden.",
@@ -64,93 +61,10 @@
 }
 
 
-def _add_entries(key: str, domain: str):
-    add_entry("en", key, _translations_en[key], domain, False)
-    add_entry("de", key, _translations_de[key], domain, False)
-
-
 def setup_db(domain: str = "flaskpp"):
     if not (enabled("EXT_BABEL") and enabled("EXT_SQLALCHEMY")):
         raise I18nError("To setup Flask++ base translations, you must enable EXT_BABEL and EXT_SQLALCHEMY.")
 
     state = valid_state()
     state.fpp_fallback_domain = domain
-    entries = get_entries(domain=domain, locale="en")
-
-    if entries:
-        log("info", f"Updating Flask++ base translations...")
-
-        keys = [e.key for e in entries]
-        for key in _msg_keys:
-            if key not in keys:
-                _add_entries(key, domain)
-
-        from .. import data
-        for entry in entries:
-            key = entry.key
-            translations = getattr(data.noinit_translations, f"_translations_{entry.locale}", _translations_en)
-            try:
-                if translations[key] != entry.text:
-                    entry.text = translations[key]
-            except KeyError:
-                delete_model(entry, False)
-    else:
-        log("info", f"Setting up Flask++ translations...")
-
-        for key in _msg_keys:
-            _add_entries(key, domain)
-
-    commit()
-
-
-def get_locale_data(locale: str) -> tuple[str, str]:
-    if len(locale) != 2 and len(locale) != 5 or len(locale) == 5 and "_" not in locale:
-        raise I18nError(f"Invalid locale code: {locale}")
-
-    if "_" in locale:
-        locale = locale.split("_")[0]
-
-    try:
-        locale_data = json.loads(
-            (_package / "locales.json").read_text(encoding="utf-8")
-        )
-    except json.JSONDecodeError:
-        raise I18nError("Failed to parse locales.json")
-
-    flags = locale_data.get("flags", {})
-    names = locale_data.get("names", {})
-    return flags.get(locale, "🇬🇧"), names.get(locale, "English")
-
-
-def update_translations(executor: str, msg_keys: list[str], add_entries_fn: Callable, translations_import_name: str, domain: str = None):
-    default_domain = valid_state().domain.domain
-    if not domain:
-        domain = default_domain
-    entries = get_entries(domain=domain)
-
-    if entries:
-        log("info", f"[{executor}] Updating translations...")
-
-        keys = [e.key for e in entries]
-        for key in msg_keys:
-            if key not in keys:
-                add_entries_fn(key, domain)
-
-        translations_module = import_module(translations_import_name)
-        for entry in entries:
-            key = entry.key
-            translations = getattr(translations_module, f"_translations_{entry.locale}", _translations_en)
-            try:
-                if translations[key] != entry.text:
-                    entry.text = translations[key]
-            except KeyError:
-                if domain == default_domain:
-                    continue
-                delete_model(entry, False)
-    else:
-        log("info", f"[{executor}] Setting up translations...")
-
-        for key in msg_keys:
-            add_entries_fn(key, domain)
-
-    commit()
+    update_translations("Flask++", __name__, domain)

src/flaskpp/app/data/noinit_translations.py

@@ -215,6 +215,8 @@ socket.on('error', async (message) => {
 });
 
 
+export const initializedEvent = new Event("FPPBaseInitialized");
+
 window.FPP = {
     showModal: showModal,
     hideModal: hideModal,
@@ -234,13 +236,16 @@ window.FPP = {
     socket: socket,
     emit: emit,
     emitAsync: emitAsync,
-}
 
+    initializedEvent: initializedEvent
+}
 
 document.addEventListener("DOMContentLoaded", () => {
     document.querySelectorAll(".modal").forEach(modal => {
         modal.setAttribute("inert", "");
         hideModal(modal);
         bindModalCloseEvents(modal);
     });
-});
+
+    document.dispatchEvent(initializedEvent);
+});

src/flaskpp/app/static/js/base.js

@@ -1,7 +1,7 @@
 from pathlib import Path
 from importlib import import_module
 from flask_security.forms import LoginForm, RegisterFormV2
-from flask_mailman import EmailMessage
+from flask_mailman import EmailMessage, EmailMultiAlternatives
 from threading import Thread
 from typing import Callable, TYPE_CHECKING
 
@@ -27,7 +27,7 @@ def init_forms(app: "FlaskPP"):
             continue
 
         try:
-            import_module(f"modules.{p}.forms")
+            import_module(f"modules.{p}.fst_forms")
         except ModuleNotFoundError:
             pass
 
@@ -81,10 +81,12 @@ def build_register_form() -> type:
 
 
 def send_security_mail(msg: dict):
-    message = EmailMessage(
+    message = EmailMultiAlternatives(
         subject=msg["subject"],
         body=msg["body"],
         from_email=msg["sender"],
         to=[msg["recipient"]],
     )
+    if "html" in msg:
+        message.attach_alternative(msg["html"], "text/html")
     Thread(target=message.send).start()

src/flaskpp/app/utils/fst.py

@@ -0,0 +1,82 @@
+from pathlib import Path
+from importlib import import_module
+import json
+
+from flaskpp.app.data.babel import add_entry, get_entries
+from flaskpp.app.data import commit, delete_model
+from flaskpp.babel import valid_state
+from flaskpp.utils import enabled
+from flaskpp.utils.logging import log
+from flaskpp.exceptions import I18nError
+
+
+def _add_entries(translations: dict, key: str, domain: str):
+    for locale, t in translations.items():
+        if key not in t:
+            continue
+        add_entry(locale, key, t[key], domain, False)
+
+
+def get_locale_data(locale: str) -> tuple[str, str]:
+    if len(locale) != 2 and len(locale) != 5 or len(locale) == 5 and "_" not in locale:
+        raise I18nError(f"Invalid locale code: {locale}")
+
+    if "_" in locale:
+        locale = locale.split("_")[0]
+
+    try:
+        locale_data = json.loads(
+            (Path(__file__).parent.parent / "data" / "locales.json").read_text(encoding="utf-8")
+        )
+    except json.JSONDecodeError:
+        raise I18nError("Failed to parse locales.json")
+
+    flags = locale_data.get("flags", {})
+    names = locale_data.get("names", {})
+    return flags.get(locale, "🇬🇧"), names.get(locale, "English")
+
+
+def update_translations(executor: str, translations_import_name: str, domain: str = None):
+    default_domain = valid_state().domain.domain
+    if not domain:
+        domain = default_domain
+    entries = get_entries(domain=domain)
+
+    translations_module = import_module(translations_import_name)
+    translations_dict = getattr(translations_module, "translations", {})
+
+    fb_translations = {}
+    for t in translations_dict.values():
+        fb_translations = t
+        break
+    msg_keys = [k for k in fb_translations]
+
+    if entries and enabled("I18N_AUTOUPDATE"):
+        log(f"[{executor}] Updating translations...")
+
+        keys = [e.key for e in entries]
+        for key in msg_keys:
+            if key not in keys:
+                _add_entries(translations_dict, key, domain)
+
+
+        for entry in entries:
+            key = entry.key
+            translations = translations_dict.get(entry.locale, translations_dict.get("en"))
+            if not translations:
+                translations = fb_translations
+
+            try:
+                if translations[key] != entry.text:
+                    entry.text = translations[key]
+            except KeyError:
+                if domain == default_domain:
+                    continue
+                delete_model(entry, False)
+    else:
+        log(f"[{executor}] Setting up translations...")
+
+        for key in msg_keys:
+            _add_entries(translations_dict, key, domain)
+
+    commit()

src/flaskpp/app/utils/i18n.py

@@ -0,0 +1,40 @@
+from flask import render_template, current_app
+from jinja2 import TemplateNotFound
+from flask_mailman import EmailMultiAlternatives
+from threading import Thread
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flaskpp import Module
+
+
+def _safe_render(template: str, module: "Module", context: dict) -> str:
+    try:
+        return render_mail_template(template, module, **context)
+    except TemplateNotFound:
+        return ""
+
+
+def render_mail_template(template: str, module: "Module" = None, **context) -> str:
+    if module is None:
+        return render_template(f"app/email/{template}", **context)
+    return module.render_template(f"email/{template}", **context)
+
+
+def send_email(subject: str, recipient: str, email_template: str,
+               sender_name: str = None, module: "Module" = None, **context):
+    body = _safe_render(f"{email_template}.txt", module, context)
+    html = _safe_render(f"{email_template}.html", module, context)
+
+    msg = EmailMultiAlternatives(
+        subject=subject,
+        body=body,
+        to=[recipient]
+    )
+    msg.attach_alternative(html, "text/html")
+
+    if sender_name:
+        user = current_app.config.get("MAIL_USERNAME", "noreply@example.com")
+        msg.from_email = f"{sender_name} <{user}>"
+
+    Thread(target=msg.send).start()

src/flaskpp/app/utils/mailing.py

@@ -3,11 +3,11 @@
 from markupsafe import Markup
 from typing import Callable
 
-from flaskpp.app.data.noinit_translations import get_locale_data
 from flaskpp.app.utils.translating import get_locale
 from flaskpp.app.utils.auto_nav import build_nav
+from flaskpp.app.utils.i18n import get_locale_data
 from flaskpp.utils import random_code, enabled
-from flaskpp.utils.debugger import log, exception
+from flaskpp.utils.logging import log, exception
 
 _handlers = {}
 
@@ -39,7 +39,7 @@ def _before_request():
     agent = request.headers.get("User-Agent")
     agent = agent if agent else "no-agent"
 
-    log("request", f"{method:4} '{path:48}' from {ip:15} via ({agent}).")
+    log(f"[REQUEST] {method:4} '{path:50}'\t\tfrom {ip:15} via ({agent}).")
 
 
 def after_request(fn: Callable) -> Callable: