pretix_original/src/pretix/plugins/wallet/placeholders.py

from collections.abc import Callable
from .signals import (
    register_wallet_text_placeholders,
    register_wallet_image_placeholders,
)
from django.core.files import File
from django.dispatch import receiver
from pretix.base.templatetags.money import money_filter
from django.contrib.staticfiles import finders
from django.templatetags.static import static
from django.utils.translation import gettext_lazy as _
from i18nfield.strings import LazyI18nString


class BaseWalletPlaceholder:
    """
    This is the base class for all wallet placeholders.
    """

    @property
    def required_context(self) -> set[str]:
        """
        A a set of all attribute names that need to be contained in the base context so that this placeholder is available.
        """
        return set()

    @property
    def identifier(self) -> str:
        """The unique identifier of this placeholder"""
        raise NotImplementedError()

    @property
    def label(self) -> LazyI18nString:
        """The human readable name of this placeholder"""
        raise NotImplementedError()

    @property
    def control_label(self) -> LazyI18nString:
        """
        The human readable name of this placeholder shown in the backend.

        Defaults to `label`
        """
        return self.label

    def render(self, **context):
        raise NotImplementedError()

    def render_sample(self, **context):
        raise NotImplementedError()



class BaseWalletTextPlaceholder(BaseWalletPlaceholder):
    def render(self, **context) -> str | None:
        """
        This method is called to generate the text that is being shown on the pass.
        You will be passed the keyword arguments specified in ``required_context``.
        You are expected to return a plain-text string.
        """
        raise NotImplementedError()

    def render_sample(self, **context) -> str:
        """
        This method is called to generate a text to be used in previews.

        You will be passed sample instances of the arguments specified in ``required_context``.
        If those instances contain all data needed, you do not need to implement this.
        """
        sample = self.render(**context)
        if sample is None:
            raise RuntimeError("`render` returned None when rendering a sample")
        return sample


class BaseWalletImagePlaceholder(BaseWalletPlaceholder):
    def render(self, **context) -> File | None:
        """
        This method is called to generate the image that is being shown on the pass.
        You will be passed the keyword arguments specified in ``required_context``.
        You are expected to return a `File` object.
        """
        raise NotImplementedError()

    def render_sample(self, **context) -> str | None:
        """
        This method is called to generate a text to be used in previews.

        You will be passed sample instances of the arguments specified in ``required_context``.
        You are expected to return a URL to a sample image or `None` if no sample can be shown.
        """
        return None


class FunctionalWalletTextPlaceholder(BaseWalletTextPlaceholder):
    def __init__(
        self,
        identifier: str,
        label: LazyI18nString,
        args: set[str],
        func: Callable[..., str | None],
        sample: None | str | Callable[..., str] = None,
    ):
        self._identifier = identifier
        self._label = label
        self._args = args
        self.render = func
        self._sample = sample

    @property
    def identifier(self):
        return self._identifier

    @property
    def label(self):
        return self._label

    @property
    def required_context(self) -> set[str]:
        return self._args

    def render_sample(self, **context) -> str:
        if isinstance(self._sample, Callable):
            return self._sample(**context)
        elif self._sample:
            return self._sample
        else:
            return super().render_sample(**context)


class FunctionalWalletImagePlaceholder(BaseWalletImagePlaceholder):
    def __init__(
        self,
        identifier: str,
        label: LazyI18nString,
        args: set[str],
        func: Callable[..., File | None],
        sample: None | str | Callable[..., str] = None,
    ):
        self._identifier = identifier
        self._label = label
        self._args = args
        self.render = func
        self._sample = sample

    @property
    def required_context(self) -> set[str]:
        return self._args

    @property
    def identifier(self):
        return self._identifier

    @property
    def label(self):
        return self._label

    def render_sample(self, **context) -> str | None:
        if isinstance(self._sample, Callable):
            return self._sample(**context)
        return self._sample


class MissingContextException(Exception):
    pass


class WalletPlaceholderContext:
    def __init__(self, **kwargs):
        self.context_args = kwargs
        self.cache = {}

    def _get_placeholder_context(self, placeholder: BaseWalletPlaceholder):
        missing_context = placeholder.required_context - self.context_args.keys()
        if missing_context:
            raise MissingContextException(
                f"Missing context args for '{placeholder.identifier}': {', '.join(missing_context)}"
            )

        return {
            k: v for k, v in self.context_args.items() if k in placeholder.required_context
        }

    @classmethod
    def is_available(cls, placeholder: BaseWalletPlaceholder, context_args: set[str]):
        missing_context = placeholder.required_context - context_args
        return not missing_context

    def render_placeholder(self, placeholder: BaseWalletPlaceholder):
        if placeholder.identifier in self.cache:
            return self.cache[placeholder.identifier]

        value = self.cache[placeholder.identifier] = placeholder.render(**self._get_placeholder_context(placeholder))
        return value

    def render_sample(self, placeholder: BaseWalletPlaceholder):
        return placeholder.render_sample(**self._get_placeholder_context(placeholder))


def get_wallet_placeholders(event) -> dict[str, dict[str, BaseWalletPlaceholder]]:
    placeholders = {
        "text": {
            v.identifier: v
            for r, vs in register_wallet_text_placeholders.send(sender=event)
            for v in vs
        },
        "image": {
            v.identifier: v
            for r, vs in register_wallet_image_placeholders.send(sender=event)
            for v in vs
        },
    }
    return placeholders



def get_static_file(name) -> File | None:
    path: str | None = finders.find(name)  # type: ignore
    if not path:
        return
    return File(open(path, "rb"))


@receiver(
    register_wallet_text_placeholders,
    dispatch_uid="plugin_wallet_register_wallet_text_placeholders",
)
def base_text_placeholders(sender, **kwargs):
    return [
        FunctionalWalletTextPlaceholder("name", LazyI18nString.from_gettext("Event Name"), {"event"}, lambda event: event.name),
        FunctionalWalletTextPlaceholder(
            "event_slug", LazyI18nString.from_gettext("Event Slug"), {"event"}, lambda event: event.slug
        ),
        FunctionalWalletTextPlaceholder("order", LazyI18nString.from_gettext("Order Code"), {"order"}, lambda order: order.code),
        FunctionalWalletTextPlaceholder(
            "total",
            LazyI18nString.from_gettext("Order Total"),
            {"event", "order"},
            lambda event, order: money_filter(order.total, event.currency),
        ),
        FunctionalWalletTextPlaceholder(
            "order_email",LazyI18nString.from_gettext("Order Email"), {"order"}, lambda order: order.email
        ),
        FunctionalWalletTextPlaceholder(
            "price",LazyI18nString.from_gettext("Item Price"), {"event", "order_position"}, lambda event, order_position: money_filter(order_position.price, event.currency)
        ),
        FunctionalWalletTextPlaceholder(
            "secret",LazyI18nString.from_gettext("Order Secret (QR-Code-Content)"), {"order_position"}, lambda order_position: order_position.secret
        ),
    ]

@receiver(
    register_wallet_image_placeholders,
    dispatch_uid="plugin_wallet_register_wallet_image_placeholders",
)
def base_image_placeholders(sender, **kwargs):
    return [
        FunctionalWalletImagePlaceholder(
            "poweredby",
            LazyI18nString.from_gettext("Logo"),
            set(),
            # TODO: replace with paths not from another plugin
            lambda: get_static_file("pretix_passbook/logo.png"),
            static("pretix_passbook/logo.png"),
        ),
        FunctionalWalletImagePlaceholder(
            "poweredby_icon",
            LazyI18nString.from_gettext("Icon"),
            set(),
            lambda: get_static_file("pretix_passbook/icon.png"),
            static("pretix_passbook/icon.png"),
        ),
        FunctionalWalletImagePlaceholder(
            "example_no_preview",
            LazyI18nString.from_gettext("Image with no preview"),
            set(),
            lambda: get_static_file("pretix_passbook/icon.png"),
        ),
        # TODO: Image upload
    ]