funkwhale/api/funkwhale_api/common/serializers.py

94 wiersze
3.3 KiB
Python
Czysty Zwykły widok Historia

2018-05-23 17:52:47 +00:00
from rest_framework import serializers
class Action(object):
def __init__(self, name, allow_all=False, qs_filter=None):
self.name = name
self.allow_all = allow_all
self.qs_filter = qs_filter
def __repr__(self):
return "<Action {}>".format(self.name)
2018-05-23 17:52:47 +00:00
class ActionSerializer(serializers.Serializer):
"""
A special serializer that can operate on a list of objects
and apply actions on it.
"""
action = serializers.CharField(required=True)
objects = serializers.JSONField(required=True)
filters = serializers.DictField(required=False)
actions = None
def __init__(self, *args, **kwargs):
self.actions_by_name = {a.name: a for a in self.actions}
2018-06-09 13:36:16 +00:00
self.queryset = kwargs.pop("queryset")
2018-05-23 17:52:47 +00:00
if self.actions is None:
raise ValueError(
2018-06-09 13:36:16 +00:00
"You must declare a list of actions on " "the serializer class"
)
2018-05-23 17:52:47 +00:00
for action in self.actions_by_name.keys():
2018-06-09 13:36:16 +00:00
handler_name = "handle_{}".format(action)
assert hasattr(self, handler_name), "{} miss a {} method".format(
self.__class__.__name__, handler_name
2018-05-23 17:52:47 +00:00
)
super().__init__(self, *args, **kwargs)
def validate_action(self, value):
try:
return self.actions_by_name[value]
except KeyError:
2018-05-23 17:52:47 +00:00
raise serializers.ValidationError(
2018-06-09 13:36:16 +00:00
"{} is not a valid action. Pick one of {}.".format(
value, ", ".join(self.actions_by_name.keys())
2018-05-23 17:52:47 +00:00
)
)
def validate_objects(self, value):
2018-06-09 13:36:16 +00:00
if value == "all":
return self.queryset.all().order_by("id")
2018-05-23 17:52:47 +00:00
if type(value) in [list, tuple]:
2018-06-09 13:36:16 +00:00
return self.queryset.filter(pk__in=value).order_by("id")
2018-05-23 17:52:47 +00:00
raise serializers.ValidationError(
2018-06-09 13:36:16 +00:00
"{} is not a valid value for objects. You must provide either a "
'list of identifiers or the string "all".'.format(value)
)
2018-05-23 17:52:47 +00:00
def validate(self, data):
allow_all = data["action"].allow_all
if not allow_all and self.initial_data["objects"] == "all":
raise serializers.ValidationError(
"You cannot apply this action on all objects"
2018-06-09 13:36:16 +00:00
)
final_filters = data.get("filters", {}) or {}
if self.filterset_class and final_filters:
qs_filterset = self.filterset_class(final_filters, queryset=data["objects"])
try:
assert qs_filterset.form.is_valid()
except (AssertionError, TypeError):
2018-06-09 13:36:16 +00:00
raise serializers.ValidationError("Invalid filters")
data["objects"] = qs_filterset.qs
2018-05-23 17:52:47 +00:00
if data["action"].qs_filter:
data["objects"] = data["action"].qs_filter(data["objects"])
2018-06-09 13:36:16 +00:00
data["count"] = data["objects"].count()
if data["count"] < 1:
raise serializers.ValidationError("No object matching your request")
2018-05-23 17:52:47 +00:00
return data
def save(self):
handler_name = "handle_{}".format(self.validated_data["action"].name)
2018-05-23 17:52:47 +00:00
handler = getattr(self, handler_name)
2018-06-09 13:36:16 +00:00
result = handler(self.validated_data["objects"])
2018-05-23 17:52:47 +00:00
payload = {
2018-06-09 13:36:16 +00:00
"updated": self.validated_data["count"],
"action": self.validated_data["action"].name,
2018-06-09 13:36:16 +00:00
"result": result,
2018-05-23 17:52:47 +00:00
}
return payload