df_site 0.1.0__py3-none-any.whl

df_site/management/commands/generate_favicon.py

@@ -0,0 +1,47 @@
+"""Generate the favicons."""
+
+import importlib
+import os
+import pathlib
+from argparse import ArgumentParser
+
+from django.conf import settings
+from django.core.management import BaseCommand
+from PIL import Image
+
+
+class Command(BaseCommand):
+    """Generate the favicons."""
+
+    specs = [
+        ("android-chrome-192x192.png", 192, 192),
+        ("android-chrome-512x512.png", 512, 512),
+        ("apple-touch-icon.png", 256, 256),
+        ("favicon.ico", 64, 64),
+        ("favicon-16x16.png", 16, 32),
+        ("favicon-32x32.png", 32, 32),
+        ("mstile-150x150.png", 150, 150),
+    ]
+
+    def add_arguments(self, parser: ArgumentParser):
+        """Add the arguments."""
+        mod = importlib.import_module(settings.DF_MODULE_NAME)
+        default = pathlib.Path(mod.__path__[0]) / "static/favicon"
+        parser.add_argument("input", help="Path of the image to add.", type=pathlib.Path)
+        parser.add_argument("--output", help="Destination directory.", type=pathlib.Path, default=default)
+
+    def handle(self, *args, **options):
+        """Generate the favicons from an original image to the destination directory."""
+        src_path: pathlib.Path = options["input"]
+        dst_dir: pathlib.Path = options["output"]
+        img_src = Image.open(src_path)
+        for dst_name, width, height in self.specs:
+            img_dst = img_src.resize((width, height))
+            dst_path: pathlib.Path = dst_dir / dst_name
+            basename, sep, ext = dst_name.rpartition(".")
+            os.makedirs(dst_path.parent, exist_ok=True)
+            with open(dst_path, "wb") as fd:
+                img_dst.save(fd, format=ext.upper())
+            self.stdout.write(f"Generated {dst_path}")
+
+        img_src.close()

df_site/middleware.py

@@ -0,0 +1,20 @@
+"""Set default topics for websockets."""
+
+from df_websockets.tasks import set_websocket_topics
+from django.http import HttpRequest, HttpResponse
+
+
+def websocket_middleware(get_response):
+    """Set default topics for websockets, when not set yet."""
+
+    def middleware(request: HttpRequest):
+        # Code to be executed for each request before
+        # the view (and later middleware) are called.
+
+        response: HttpResponse = get_response(request)
+        # noinspection PyUnresolvedReferences
+        if not request.has_websocket_topics:
+            set_websocket_topics(request)
+        return response
+
+    return middleware

df_site/migrations/0001_initial.py

@@ -0,0 +1,220 @@
+# Generated by Django 5.1 on 2024-08-22 17:06
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("auth", "0012_alter_user_first_name_max_length"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="AlertRibbon",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "color",
+                    models.CharField(
+                        choices=[
+                            ("info", "Info"),
+                            ("success", "Success"),
+                            ("warning", "Warning"),
+                            ("danger", "Danger"),
+                            ("primary", "Primary"),
+                            ("secondary", "Secondary"),
+                            ("dark", "Dark"),
+                            ("light", "Light"),
+                            ("tricolor", "Tricolor"),
+                        ],
+                        db_index=True,
+                        default="info",
+                        max_length=10,
+                        verbose_name="Color",
+                    ),
+                ),
+                ("message", models.TextField(verbose_name="Message")),
+                ("url", models.URLField(blank=True, null=True, verbose_name="URL")),
+                (
+                    "summary",
+                    models.CharField(blank=True, default="", max_length=100, verbose_name="Summary"),
+                ),
+                (
+                    "start_date",
+                    models.DateTimeField(blank=True, db_index=True, null=True, verbose_name="Start date"),
+                ),
+                (
+                    "end_date",
+                    models.DateTimeField(blank=True, db_index=True, null=True, verbose_name="End date"),
+                ),
+                (
+                    "is_active",
+                    models.BooleanField(db_index=True, default=True, verbose_name="Is active"),
+                ),
+                (
+                    "position",
+                    models.PositiveSmallIntegerField(
+                        choices=[
+                            (0, "Top left"),
+                            (1, "Bottom left"),
+                            (2, "Top right"),
+                            (3, "Bottom right"),
+                            (4, "Top center"),
+                            (5, "Bottom center"),
+                        ],
+                        db_index=True,
+                        default=2,
+                        verbose_name="Position",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Alert ribbon",
+                "verbose_name_plural": "Alert ribbons",
+                "ordering": ("-start_date",),
+            },
+        ),
+        migrations.CreateModel(
+            name="PreferencesUser",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("password", models.CharField(max_length=128, verbose_name="password")),
+                (
+                    "last_login",
+                    models.DateTimeField(blank=True, null=True, verbose_name="last login"),
+                ),
+                (
+                    "is_superuser",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates that this user has all permissions without explicitly assigning them.",
+                        verbose_name="superuser status",
+                    ),
+                ),
+                (
+                    "username",
+                    models.CharField(
+                        error_messages={"unique": "A user with that username already exists."},
+                        help_text="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
+                        max_length=150,
+                        unique=True,
+                        validators=[django.contrib.auth.validators.UnicodeUsernameValidator()],
+                        verbose_name="username",
+                    ),
+                ),
+                (
+                    "first_name",
+                    models.CharField(blank=True, max_length=150, verbose_name="first name"),
+                ),
+                (
+                    "last_name",
+                    models.CharField(blank=True, max_length=150, verbose_name="last name"),
+                ),
+                (
+                    "email",
+                    models.EmailField(blank=True, max_length=254, verbose_name="email address"),
+                ),
+                (
+                    "is_staff",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates whether the user can log into this admin site.",
+                        verbose_name="staff status",
+                    ),
+                ),
+                (
+                    "is_active",
+                    models.BooleanField(
+                        default=True,
+                        help_text="Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
+                        verbose_name="active",
+                    ),
+                ),
+                (
+                    "date_joined",
+                    models.DateTimeField(default=django.utils.timezone.now, verbose_name="date joined"),
+                ),
+                (
+                    "color_theme",
+                    models.CharField(
+                        choices=[
+                            ("auto", "Auto"),
+                            ("light", "Light"),
+                            ("dark", "Dark"),
+                        ],
+                        db_index=True,
+                        default="auto",
+                        max_length=10,
+                        verbose_name="Color theme",
+                    ),
+                ),
+                (
+                    "display_online",
+                    models.BooleanField(
+                        db_index=True,
+                        default=False,
+                        verbose_name="Display online status",
+                    ),
+                ),
+                (
+                    "email_notifications",
+                    models.BooleanField(
+                        db_index=True,
+                        default=False,
+                        verbose_name="Receive notifications by email",
+                    ),
+                ),
+                (
+                    "groups",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="The groups this user belongs to. A user will get all permissions granted to each of their groups.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.group",
+                        verbose_name="groups",
+                    ),
+                ),
+                (
+                    "user_permissions",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="Specific permissions for this user.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.permission",
+                        verbose_name="user permissions",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "user",
+                "verbose_name_plural": "users",
+                "abstract": False,
+            },
+            managers=[
+                ("objects", django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

df_site/migrations/0002_alter_alertribbon_message_alter_alertribbon_summary.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1 on 2024-08-23 16:32
+
+import df_site.model_fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("df_site", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="alertribbon",
+            name="message",
+            field=df_site.model_fields.CKEditor5TextField(blank=True, default="", verbose_name="Message"),
+        ),
+        migrations.AlterField(
+            model_name="alertribbon",
+            name="summary",
+            field=df_site.model_fields.CKEditor5CharField(db_index=True, max_length=100, verbose_name="Summary"),
+        ),
+    ]

df_site/model_fields.py

@@ -0,0 +1,35 @@
+"""Define custom model fields with the CKEditor5 widget."""
+
+from django.db import models
+
+from df_site import form_fields
+
+
+class CKEditor5TextField(models.TextField):
+    """Use a CKEditor5 widget for a TextField."""
+
+    def formfield(self, **kwargs):
+        """Replace the default widget with a CKEditor5 widget."""
+        defaults = {"form_class": form_fields.CKEditor5Field}
+        defaults.update(kwargs)
+        return super().formfield(**defaults)
+
+
+class CKEditor5CharField(models.CharField):
+    """Use a CKEditor5 widget for a CharField."""
+
+    def formfield(self, **kwargs):
+        """Replace the default widget with a CKEditor5 widget."""
+        defaults = {"form_class": form_fields.InlineCKEditor5Field}
+        defaults.update(kwargs)
+        return super().formfield(**defaults)
+
+
+class CKEditor5LinkCharField(models.CharField):
+    """Use a CKEditor5 widget for a CharField, allowing to write URLs."""
+
+    def formfield(self, **kwargs):
+        """Replace the default widget with a CKEditor5 widget."""
+        defaults = {"form_class": form_fields.InlineLinkCKEditor5Field}
+        defaults.update(kwargs)
+        return super().formfield(**defaults)

df_site/models.py

@@ -0,0 +1,130 @@
+"""Models for the df_site app."""
+
+from django.conf import settings
+from django.contrib.auth.models import AbstractUser
+from django.db import models
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+from df_site.model_fields import CKEditor5CharField, CKEditor5TextField
+
+
+class AlertRibbon(models.Model):
+    """Model for alert messages that are shown to users."""
+
+    LEVELS = (
+        ("info", _("Info")),
+        ("success", _("Success")),
+        ("warning", _("Warning")),
+        ("danger", _("Danger")),
+        ("primary", _("Primary")),
+        ("secondary", _("Secondary")),
+        ("dark", _("Dark")),
+        ("light", _("Light")),
+        ("tricolor", _("Tricolor")),
+    )
+    TOP_LEFT = 0
+    BOTTOM_LEFT = 1
+    TOP_RIGHT = 2
+    BOTTOM_RIGHT = 3
+    TOP_CENTER = 4
+    BOTTOM_CENTER = 5
+    POSITIONS = (
+        (TOP_LEFT, _("Top left")),
+        (BOTTOM_LEFT, _("Bottom left")),
+        (TOP_RIGHT, _("Top right")),
+        (BOTTOM_RIGHT, _("Bottom right")),
+        (TOP_CENTER, _("Top center")),
+        (BOTTOM_CENTER, _("Bottom center")),
+    )
+
+    color = models.CharField(max_length=10, choices=LEVELS, default="info", db_index=True, verbose_name=_("Color"))
+    message = CKEditor5TextField(verbose_name=_("Message"), blank=True, default="")
+    url = models.URLField(null=True, blank=True, verbose_name=_("URL"))  # noqa: DJ001
+    summary = CKEditor5CharField(max_length=100, verbose_name=_("Summary"), db_index=True)
+    start_date = models.DateTimeField(null=True, blank=True, db_index=True, verbose_name=_("Start date"))
+    end_date = models.DateTimeField(null=True, blank=True, db_index=True, verbose_name=_("End date"))
+    is_active = models.BooleanField(default=True, db_index=True, verbose_name=_("Is active"))
+    position = models.PositiveSmallIntegerField(
+        default=TOP_RIGHT, choices=POSITIONS, db_index=True, verbose_name=_("Position")
+    )
+
+    class Meta:
+        """Meta options for the model."""
+
+        ordering = ("-start_date",)
+        verbose_name = _("Alert ribbon")
+        verbose_name_plural = _("Alert ribbons")
+
+    def __str__(self):
+        """Return the string representation of the alert message."""
+        return self.summary
+
+    def get_absolute_url(self):
+        """Return the URL for the alert message."""
+        return reverse("ribbon", kwargs={"pk": self.pk})
+
+    @property
+    def html_tag(self):
+        """Return the HTML tag for the alert message."""
+        if self.position in (self.TOP_CENTER, self.BOTTOM_CENTER):
+            return "div"
+        elif self.url:
+            return "a"
+        return "span"
+
+    @property
+    def css_classes(self):
+        """Return the CSS classes for the alert message."""
+        if self.position == self.TOP_CENTER:
+            classes = f"container-fluid btn btn-{self.color} "
+        elif self.position == self.BOTTOM_CENTER:
+            classes = f"container-fluid btn btn-{self.color} fixed-bottom "
+        else:
+            classes = f"alert-ribbon fixed alert-ribbon-{self.color} "
+        if self.position in (self.TOP_LEFT, self.BOTTOM_LEFT):
+            classes += "left-"
+        elif self.position in (self.TOP_RIGHT, self.BOTTOM_RIGHT):
+            classes += "right-"
+        elif self.position in (self.TOP_CENTER, self.BOTTOM_CENTER):
+            classes += "center-"
+        if self.position in (self.TOP_LEFT, self.TOP_RIGHT, self.TOP_CENTER):
+            classes += "top"
+        elif self.position in (self.BOTTOM_LEFT, self.BOTTOM_RIGHT, self.BOTTOM_CENTER):
+            classes += "bottom"
+        return classes
+
+
+class AbstractPreferences(models.Model):
+    """User preferences for the df_site app."""
+
+    COLOR_THEMES = {x[0]: x[1] for x in settings.DF_SITE_THEMES}
+    color_theme = models.CharField(
+        max_length=10,
+        default=settings.DF_SITE_THEMES[0][0],
+        db_index=True,
+        choices=COLOR_THEMES,
+        verbose_name=_("Color theme"),
+    )
+    display_online = models.BooleanField(default=False, verbose_name=_("Display online status"), db_index=True)
+    email_notifications = models.BooleanField(
+        default=False, verbose_name=_("Receive notifications by email"), db_index=True
+    )
+
+    class Meta:
+        """Meta options for the model."""
+
+        abstract = True
+
+
+class PreferencesUser(AbstractUser, AbstractPreferences):
+    """User model for the df_site app."""
+
+    class Meta(AbstractUser.Meta):
+        """Meta options for the model."""
+
+        swappable = "AUTH_USER_MODEL"
+
+    def __str__(self):
+        """Return the string representation of the user."""
+        return super().__str__()

df_site/postman/__init__.py

@@ -0,0 +1 @@
+"""Customized postman views and forms."""

df_site/postman/forms.py

@@ -0,0 +1,38 @@
+"""Forms for the Postman application."""
+
+from django import forms
+from django.utils.translation import gettext_lazy as _
+from postman.forms import AnonymousWriteForm, FullReplyForm, QuickReplyForm, WriteForm
+
+from df_site.form_fields import CKEditor5Field
+
+
+class CKEditor5Form(forms.Form):
+    """Form with a CKEditor 5 widget."""
+
+    body = CKEditor5Field(label=_("body"), required=True, config_name="default")
+    subject = CKEditor5Field(label=_("subject"), required=True, config_name="inline")
+
+
+class HTMLWriteForm(CKEditor5Form, WriteForm):
+    """Form used by authenticated users."""
+
+    pass
+
+
+class HTMLAnonymousWriteForm(CKEditor5Form, AnonymousWriteForm):
+    """Form used by anonymous users."""
+
+    pass
+
+
+class HTMLFullReplyForm(CKEditor5Form, FullReplyForm):
+    """Form for complete Postman replies."""
+
+    pass
+
+
+class HTMLQuickReplyForm(CKEditor5Form, QuickReplyForm):
+    """Form for postman quick replies."""
+
+    pass

df_site/postman/urls.py

@@ -0,0 +1,75 @@
+"""URLs for customized views (mainly customized forms)."""
+
+from django.conf import settings
+from django.urls import include, re_path
+from postman import api_urls
+from postman.views import (
+    ArchivesView,
+    ArchiveView,
+    ConversationView,
+    DeleteView,
+    InboxView,
+    IndexView,
+    MarkReadView,
+    MarkUnreadView,
+    MessageView,
+    ReplyView,
+    SentView,
+    TrashView,
+    UndeleteView,
+    WriteView,
+)
+
+from df_site.postman.forms import HTMLAnonymousWriteForm, HTMLFullReplyForm, HTMLQuickReplyForm, HTMLWriteForm
+from df_site.postman.views import MessageUpdateView
+
+if settings.POSTMAN_I18N_URLS:
+    from django.utils.translation import pgettext_lazy
+else:
+
+    def pgettext_lazy(context: str, message: str):
+        """Does nothing when POSTMAN_I18N_URLS is off."""
+        return message
+
+
+app_name = "postman"
+urlpatterns = [
+    # Translators: keep consistency of the <option> parameter with the translation for 'm'
+    re_path(pgettext_lazy("postman_url", r"^inbox/(?:(?P<option>m)/)?$"), InboxView.as_view(), name="inbox"),
+    # Translators: keep consistency of the <option> parameter with the translation for 'm'
+    re_path(pgettext_lazy("postman_url", r"^sent/(?:(?P<option>m)/)?$"), SentView.as_view(), name="sent"),
+    # Translators: keep consistency of the <option> parameter with the translation for 'm'
+    re_path(pgettext_lazy("postman_url", r"^archives/(?:(?P<option>m)/)?$"), ArchivesView.as_view(), name="archives"),
+    # Translators: keep consistency of the <option> parameter with the translation for 'm'
+    re_path(pgettext_lazy("postman_url", r"^trash/(?:(?P<option>m)/)?$"), TrashView.as_view(), name="trash"),
+    re_path(
+        pgettext_lazy("postman_url", r"^write/(?:(?P<recipients>[^/#]+)/)?$"),
+        WriteView.as_view(form_classes=(HTMLWriteForm, HTMLAnonymousWriteForm)),
+        name="write",
+    ),
+    re_path(
+        pgettext_lazy("postman_url", r"^reply/(?P<message_id>[\d]+)/$"),
+        ReplyView.as_view(form_class=HTMLFullReplyForm),
+        name="reply",
+    ),
+    re_path(
+        pgettext_lazy("postman_url", r"^view/(?P<message_id>[\d]+)/$"),
+        MessageView.as_view(form_class=HTMLQuickReplyForm),
+        name="view",
+    ),
+    # Translators: 't' stands for 'thread'
+    re_path(
+        pgettext_lazy("postman_url", r"^view/t/(?P<thread_id>[\d]+)/$"),
+        ConversationView.as_view(form_class=HTMLQuickReplyForm),
+        name="view_conversation",
+    ),
+    re_path(pgettext_lazy("postman_url", r"^archive/$"), ArchiveView.as_view(), name="archive"),
+    re_path(pgettext_lazy("postman_url", r"^delete/$"), DeleteView.as_view(), name="delete"),
+    re_path(pgettext_lazy("postman_url", r"^undelete/$"), UndeleteView.as_view(), name="undelete"),
+    re_path(pgettext_lazy("postman_url", r"^mark-read/$"), MarkReadView.as_view(), name="mark-read"),
+    re_path(pgettext_lazy("postman_url", r"^mark-unread/$"), MarkUnreadView.as_view(), name="mark-unread"),
+    # this view is not a part of the original postman views
+    re_path(pgettext_lazy("postman_url", r"^mark-message/$"), MessageUpdateView.as_view(), name="update-message"),
+    re_path(r"^$", IndexView.as_view()),
+    re_path(pgettext_lazy("postman_url", r"^api/"), include(api_urls, namespace="api")),
+]

df_site/postman/views.py

@@ -0,0 +1,65 @@
+"""Customized postman views."""
+
+from django.contrib.auth.base_user import AbstractBaseUser
+from django.core.exceptions import PermissionDenied
+from django.db.models import Q
+from django.utils.timezone import now
+from django.utils.translation import gettext as _
+from django.views.generic import View
+from postman.models import Message
+from postman.views import UpdateDualMixin
+
+
+class MessageUpdateView(UpdateDualMixin, View):
+    """View for updating messages or conversations.
+
+    This single view replaces the following views: `ArchiveView`, `DeleteView`,
+    `UndeleteView`, 'MarkReadView', 'MarkUnreadView'.
+    This is required to avoid the onclick attribute in the template (forbidden by CSP).
+    """
+
+    @property
+    def selected_action(self):
+        """Get the action to perform on the selected messages or conversations."""
+        action = self.request.POST.get("action")
+        if action not in {"delete", "archive", "undelete", "read", "unread"}:
+            raise PermissionDenied
+        return action
+
+    def _action(self, user: AbstractBaseUser, filter_: Q):
+        """Perform the action on the selected messages or conversations."""
+        if self.selected_action in {"read", "unread"}:
+            Message.objects.as_recipient(user, filter_).filter(
+                **{f"{self.field_bit}__isnull": bool(self.field_value)}
+            ).update(**{self.field_bit: self.field_value})
+        else:
+            super()._action(user, filter_)
+        # an empty set cannot be estimated as an error, it may be just a badly chosen selection
+
+    @property
+    def field_bit(self):
+        """Get the field to update."""
+        return {
+            "delete": "deleted_at",
+            "archive": "archived",
+            "undelete": "deleted_at",
+            "read": "read_at",
+            "unread": "read_at",
+        }[self.selected_action]
+
+    @property
+    def success_msg(self):
+        """Get the success message to display."""
+        return {
+            "delete": _("Messages or conversations successfully deleted."),
+            "archive": _("Messages or conversations successfully archived."),
+            "undelete": _("Messages or conversations successfully recovered."),
+            "read": _("Messages or conversations successfully marked as read."),
+            "unread": _("Messages or conversations successfully marked as unread."),
+        }[self.selected_action]
+
+    @property
+    def field_value(self):
+        """Get the value to set the field to."""
+        n = now()
+        return {"delete": n, "archive": True, "undelete": None, "read": n, "unread": None}[self.selected_action]