OpenSlides/openslides/core/serializers.py

176 lines
4.4 KiB
Python
Raw Normal View History

from typing import Any
2015-01-06 00:04:36 +01:00
from ..utils.projector import projector_slides
from ..utils.rest_api import Field, IntegerField, ModelSerializer, ValidationError
from ..utils.validate import validate_html
from .models import (
ChatMessage,
2017-08-22 14:17:20 +02:00
ConfigStore,
Countdown,
History,
ProjectionDefault,
Projector,
ProjectorMessage,
Tag,
)
class JSONSerializerField(Field):
"""
2017-08-22 14:17:20 +02:00
Serializer for projector's and config JSONField.
"""
2019-01-06 16:22:33 +01:00
def to_internal_value(self, data):
"""
Returns the value. It is encoded from the Django JSONField.
"""
return data
2017-08-22 14:17:20 +02:00
def to_representation(self, value):
"""
Returns the value. It is decoded from the Django JSONField.
"""
return value
2016-09-12 11:05:34 +02:00
class ProjectionDefaultSerializer(ModelSerializer):
"""
Serializer for core.models.ProjectionDefault objects.
"""
2019-01-06 16:22:33 +01:00
2016-09-12 11:05:34 +02:00
class Meta:
model = ProjectionDefault
2019-01-06 16:22:33 +01:00
fields = ("id", "name", "display_name", "projector")
2016-09-12 11:05:34 +02:00
def elements_validator(value: Any) -> None:
"""
Checks the format of the elements field.
"""
if not isinstance(value, list):
raise ValidationError({"detail": "Data must be a list."})
for element in value:
if not isinstance(element, dict):
raise ValidationError({"detail": "Data must be a dictionary."})
if element.get("name") is None:
raise ValidationError(
{"detail": "Every dictionary must have a key 'name'."}
)
if element["name"] not in projector_slides:
raise ValidationError(
{"detail": f"Unknown projector element {element['name']},"}
)
def elements_array_validator(value: Any) -> None:
"""
Validates the value of the element field of the projector model.
"""
if not isinstance(value, list):
raise ValidationError({"detail": "Data must be a list."})
for element in value:
elements_validator(element)
class ProjectorSerializer(ModelSerializer):
"""
Serializer for core.models.Projector objects.
"""
2019-01-06 16:22:33 +01:00
elements = JSONSerializerField(validators=[elements_validator])
elements_preview = JSONSerializerField(validators=[elements_validator])
elements_history = JSONSerializerField(validators=[elements_array_validator])
2016-09-12 11:05:34 +02:00
projectiondefaults = ProjectionDefaultSerializer(many=True, read_only=True)
width = IntegerField(min_value=800, max_value=3840, required=False)
height = IntegerField(min_value=340, max_value=2880, required=False)
class Meta:
model = Projector
2019-01-06 16:22:33 +01:00
fields = (
"id",
"elements",
"elements_preview",
"elements_history",
2019-01-06 16:22:33 +01:00
"scale",
"scroll",
"name",
"width",
"height",
"projectiondefaults",
)
read_only_fields = ("scale", "scroll")
2015-01-06 00:04:36 +01:00
class TagSerializer(ModelSerializer):
"""
Serializer for core.models.Tag objects.
"""
2019-01-06 16:22:33 +01:00
class Meta:
model = Tag
2019-01-06 16:22:33 +01:00
fields = ("id", "name")
2017-08-22 14:17:20 +02:00
class ConfigSerializer(ModelSerializer):
"""
Serializer for core.models.Tag objects.
"""
2019-01-06 16:22:33 +01:00
2017-08-22 14:17:20 +02:00
value = JSONSerializerField()
class Meta:
model = ConfigStore
2019-01-06 16:22:33 +01:00
fields = ("id", "key", "value")
2017-08-22 14:17:20 +02:00
class ChatMessageSerializer(ModelSerializer):
"""
Serializer for core.models.ChatMessage objects.
"""
2019-01-06 16:22:33 +01:00
class Meta:
model = ChatMessage
2019-01-06 16:22:33 +01:00
fields = ("id", "message", "timestamp", "user")
read_only_fields = ("user",)
class ProjectorMessageSerializer(ModelSerializer):
"""
Serializer for core.models.ProjectorMessage objects.
"""
2019-01-06 16:22:33 +01:00
class Meta:
model = ProjectorMessage
2019-01-06 16:22:33 +01:00
fields = ("id", "message")
2017-01-20 11:34:05 +01:00
def validate(self, data):
2019-01-06 16:22:33 +01:00
if "message" in data:
data["message"] = validate_html(data["message"])
2017-01-20 11:34:05 +01:00
return data
class CountdownSerializer(ModelSerializer):
"""
Serializer for core.models.Countdown objects.
"""
2019-01-06 16:22:33 +01:00
class Meta:
model = Countdown
2019-01-06 16:22:33 +01:00
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.
"""
2019-01-06 16:22:33 +01:00
2019-01-19 18:50:05 +01:00
information = JSONSerializerField()
class Meta:
model = History
fields = ("id", "element_id", "now", "information", "restricted", "user")
read_only_fields = ("now",)