OpenSlides/openslides/core/serializers.py

from openslides.utils.rest_api import Field, ModelSerializer, ValidationError
from openslides.utils.validate import validate_html

from .models import (
    ChatMessage,
    ConfigStore,
    Countdown,
    History,
    ProjectionDefault,
    Projector,
    ProjectorMessage,
    Tag,
)


class JSONSerializerField(Field):
    """
    Serializer for projector's and config JSONField.
    """

    def to_internal_value(self, data):
        """
        Checks that data is a dictionary. The key is a hex UUID and the
        value is a dictionary with must have a key 'name'.
        """
        if type(data) is not dict:
            raise ValidationError({"detail": "Data must be a dictionary."})
        for element in data.values():
            if type(element) is not dict:
                raise ValidationError({"detail": "Data must be a dictionary."})
            elif element.get("name") is None:
                raise ValidationError(
                    {"detail": "Every dictionary must have a key 'name'."}
                )
        return data

    def to_representation(self, value):
        """
        Returns the value. It is decoded from the Django JSONField.
        """
        return value


class ProjectionDefaultSerializer(ModelSerializer):
    """
    Serializer for core.models.ProjectionDefault objects.
    """

    class Meta:
        model = ProjectionDefault
        fields = ("id", "name", "display_name", "projector")


class ProjectorSerializer(ModelSerializer):
    """
    Serializer for core.models.Projector objects.
    """

    config = JSONSerializerField(write_only=True)
    projectiondefaults = ProjectionDefaultSerializer(many=True, read_only=True)

    class Meta:
        model = Projector
        fields = (
            "id",
            "config",
            "elements",
            "scale",
            "scroll",
            "name",
            "blank",
            "width",
            "height",
            "projectiondefaults",
        )
        read_only_fields = ("scale", "scroll", "blank", "width", "height")


class TagSerializer(ModelSerializer):
    """
    Serializer for core.models.Tag objects.
    """

    class Meta:
        model = Tag
        fields = ("id", "name")


class ConfigSerializer(ModelSerializer):
    """
    Serializer for core.models.Tag objects.
    """

    value = JSONSerializerField()

    class Meta:
        model = ConfigStore
        fields = ("id", "key", "value")


class ChatMessageSerializer(ModelSerializer):
    """
    Serializer for core.models.ChatMessage objects.
    """

    class Meta:
        model = ChatMessage
        fields = ("id", "message", "timestamp", "user")
        read_only_fields = ("user",)


class ProjectorMessageSerializer(ModelSerializer):
    """
    Serializer for core.models.ProjectorMessage objects.
    """

    class Meta:
        model = ProjectorMessage
        fields = ("id", "message")

    def validate(self, data):
        if "message" in data:
            data["message"] = validate_html(data["message"])
        return data


class CountdownSerializer(ModelSerializer):
    """
    Serializer for core.models.Countdown objects.
    """

    class Meta:
        model = Countdown
        fields = ("id", "description", "default_time", "countdown_time", "running")


class HistorySerializer(ModelSerializer):
    """
    Serializer for core.models.Countdown objects.

    Does not contain full data of history object.
    """

    class Meta:
        model = History
        fields = ("id", "element_id", "now", "information", "user")