push_notification_translation.py

from __future__ import annotations

from typing import TYPE_CHECKING

from django.conf import settings
from django.db import models
from django.utils.translation import gettext_lazy as _

from ...constants import push_notifications as pnt_const
from ..abstract_base_model import AbstractBaseModel
from ..languages.language import Language
from .push_notification import PushNotification

if TYPE_CHECKING:
    from django.db.models.query import QuerySet

    from ..regions.region import Region


class PushNotificationTranslation(AbstractBaseModel):
    """
    Data model representing a push notification translation
    """

    title = models.CharField(max_length=250, blank=True, verbose_name=_("title"))
    text = models.TextField(
        max_length=250,
        blank=True,
        verbose_name=_("content"),
    )
    language = models.ForeignKey(
        Language,
        on_delete=models.CASCADE,
        related_name="push_notification_translations",
        verbose_name=_("language"),
    )
    push_notification = models.ForeignKey(
        PushNotification,
        on_delete=models.CASCADE,
        related_name="translations",
        verbose_name=_("push notification"),
    )
    last_updated = models.DateTimeField(
        auto_now=True,
        verbose_name=_("modification date"),
    )

    @classmethod
    def search(
        cls, region: Region, language_slug: str, query: str
    ) -> QuerySet[PushNotificationTranslation]:
        """
        Searches for all push notifications which match the given `query` in their title.
        :param region: The current region
        :param language_slug: The language slug
        :param query: The query string used for filtering the push notifications
        :return: A query for all matching objects
        """
        return cls.objects.filter(
            push_notification__regions=region,
            language__slug=language_slug,
            title__icontains=query,
        )

    def get_title(self) -> str:
        """
        Get the title of the notification translation.

        :return: A title for the push notification
        """
        if (
            self.push_notification.mode == pnt_const.USE_MAIN_LANGUAGE
            and not self.title
            and self.push_notification.default_translation
        ):
            return self.push_notification.default_translation.title
        return self.title

    def get_text(self) -> str:
        """
        Get the text of the notification. Construct a fallback text if possible.

        :return: A text for the push notification
        """
        if self.push_notification.mode == pnt_const.USE_MAIN_LANGUAGE and not self.text:
            translations = "\n".join(
                [
                    f"{translation.language.native_name}: {settings.WEBAPP_URL}{translation.get_absolute_url()}"
                    for translation in self.push_notification.translations.exclude(
                        text=""
                    )
                ]
            )
            return f"{self.language.message_content_not_available}\n{translations}"
        return self.text

    def get_absolute_url(self) -> str:
        """
        Generates the absolute url to a news object in the app

        :return: The link to the news
        """
        return f"/{self.push_notification.regions.first().slug}/{self.language.slug}/{self.push_notification.channel}/local/{self.id}"

    def __str__(self) -> str:
        """
        This overwrites the default Django :meth:`~django.db.models.Model.__str__` method which would return ``PushNotificationTranslation object (id)``.
        It is used in the Django admin backend and as label for ModelChoiceFields.

        :return: A readable string representation of the event
        """
        return self.title

    def get_repr(self) -> str:
        """
        This overwrites the default Django ``__repr__()`` method which would return ``<PushNotificationTranslation: PushNotificationTranslation object (id)>``.
        It is used for logging.

        :return: The canonical string representation of the event
        """
        return f"<PushNotificationTranslation (id: {self.id}, push_notification_id: {self.push_notification.id}, title: {self.title})>"

    class Meta:
        #: The verbose name of the model
        verbose_name = _("push notification translation")
        #: The plural verbose name of the model
        verbose_name_plural = _("push notification translations")
        #: The fields which are used to sort the returned objects of a QuerySet
        ordering = ["push_notification__pk", "language__pk", "language"]
        #: The default permissions for this model
        default_permissions = ()
        #: Sets of field names that, taken together, must be unique
        unique_together = ["push_notification", "language"]