nk20/apps/note/api/views.py

208 lines
9.2 KiB
Python
Raw Normal View History

# Copyright (C) 2018-2021 by BDE ENS Paris-Saclay
2020-02-07 16:02:07 +00:00
# SPDX-License-Identifier: GPL-3.0-or-later
2020-09-10 12:37:11 +00:00
from django.conf import settings
from django.db.models import Q
2020-03-26 22:05:37 +00:00
from django.core.exceptions import ValidationError
2020-03-11 10:15:03 +00:00
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.filters import OrderingFilter, SearchFilter
2020-03-24 21:12:44 +00:00
from rest_framework import viewsets
2020-03-26 22:05:37 +00:00
from rest_framework.response import Response
from rest_framework import status
from api.viewsets import ReadProtectedModelViewSet, ReadOnlyProtectedModelViewSet
2020-08-03 14:11:05 +00:00
from permission.backends import PermissionBackend
2020-03-20 01:14:43 +00:00
2020-03-28 16:42:29 +00:00
from .serializers import NotePolymorphicSerializer, AliasSerializer, ConsumerSerializer,\
TemplateCategorySerializer, TransactionTemplateSerializer, TransactionPolymorphicSerializer
from ..models.notes import Note, Alias, NoteUser, NoteClub, NoteSpecial
2020-03-11 10:15:03 +00:00
from ..models.transactions import TransactionTemplate, Transaction, TemplateCategory
2020-02-07 16:02:07 +00:00
2020-08-31 18:15:48 +00:00
class NotePolymorphicViewSet(ReadProtectedModelViewSet):
2020-02-07 19:47:49 +00:00
"""
REST API View set.
2020-12-22 11:37:21 +00:00
The djangorestframework plugin will get all `Note` objects (with polymorhism),
serialize it to JSON with the given serializer,
then render it on /api/note/note/
2020-02-07 19:47:49 +00:00
"""
queryset = Note.objects.order_by('id')
2020-02-07 19:47:49 +00:00
serializer_class = NotePolymorphicSerializer
filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter]
2020-12-22 11:37:21 +00:00
filterset_fields = ['alias__name', 'polymorphic_ctype', 'is_active', 'balance', 'last_negative', 'created_at', ]
search_fields = ['$alias__normalized_name', '$alias__name', '$polymorphic_ctype__model',
'$noteuser__user__last_name', '$noteuser__user__first_name', '$noteuser__user__email',
'$noteuser__user__email', '$noteclub__club__email', ]
ordering_fields = ['alias__name', 'alias__normalized_name', 'balance', 'created_at', ]
2020-02-07 19:47:49 +00:00
def get_queryset(self):
"""
Parse query and apply filters.
:return: The filtered set of requested notes
"""
queryset = self.queryset.filter(PermissionBackend.filter_queryset(self.request, Note, "view")
| PermissionBackend.filter_queryset(self.request, NoteUser, "view")
| PermissionBackend.filter_queryset(self.request, NoteClub, "view")
| PermissionBackend.filter_queryset(self.request, NoteSpecial, "view"))\
.distinct()
alias = self.request.query_params.get("alias", ".*")
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
2020-08-31 18:15:48 +00:00
Q(alias__name__iregex="^" + alias)
| Q(alias__normalized_name__iregex="^" + Alias.normalize(alias))
| Q(alias__normalized_name__iregex="^" + alias.lower())
)
2020-09-01 13:54:56 +00:00
return queryset.order_by("id")
2020-02-07 19:47:49 +00:00
class AliasViewSet(ReadProtectedModelViewSet):
2020-02-08 14:08:55 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `Alias` objects, serialize it to JSON with the given serializer,
then render it on /api/aliases/
"""
queryset = Alias.objects
2020-02-08 14:08:55 +00:00
serializer_class = AliasSerializer
2020-09-10 12:37:11 +00:00
filter_backends = [SearchFilter, DjangoFilterBackend, OrderingFilter]
2020-03-12 00:10:52 +00:00
search_fields = ['$normalized_name', '$name', '$note__polymorphic_ctype__model', ]
2020-12-22 11:37:21 +00:00
filterset_fields = ['note', 'note__noteuser__user', 'note__noteclub__club', 'note__polymorphic_ctype__model', ]
ordering_fields = ['name', 'normalized_name', ]
2020-02-08 14:08:55 +00:00
2020-03-26 16:45:24 +00:00
def get_serializer_class(self):
serializer_class = self.serializer_class
if self.request.method in ['PUT', 'PATCH']:
2020-03-27 13:19:55 +00:00
# alias owner cannot be change once establish
serializer_class.Meta.read_only_fields = ('note',)
2020-03-26 16:45:24 +00:00
return serializer_class
2020-03-27 13:19:55 +00:00
2020-03-26 22:05:37 +00:00
def destroy(self, request, *args, **kwargs):
instance = self.get_object()
try:
self.perform_destroy(instance)
except ValidationError as e:
return Response({e.code: str(e)}, status.HTTP_400_BAD_REQUEST)
2020-03-26 22:05:37 +00:00
return Response(status=status.HTTP_204_NO_CONTENT)
2020-03-27 13:19:55 +00:00
def get_queryset(self):
"""
Parse query and apply filters.
:return: The filtered set of requested aliases
"""
2020-08-31 19:32:45 +00:00
queryset = super().get_queryset().distinct()
2020-08-31 19:32:45 +00:00
alias = self.request.query_params.get("alias", None)
if alias:
queryset = queryset.filter(
name__iregex="^" + alias
).union(
queryset.filter(
Q(normalized_name__iregex="^" + Alias.normalize(alias))
& ~Q(name__iregex="^" + alias)
),
all=True).union(
queryset.filter(
Q(normalized_name__iregex="^" + alias.lower())
& ~Q(normalized_name__iregex="^" + Alias.normalize(alias))
& ~Q(name__iregex="^" + alias)
),
all=True)
2020-09-01 13:54:56 +00:00
return queryset.order_by("name")
2020-03-28 16:42:29 +00:00
class ConsumerViewSet(ReadOnlyProtectedModelViewSet):
queryset = Alias.objects
2020-03-28 16:42:29 +00:00
serializer_class = ConsumerSerializer
2020-09-10 12:42:52 +00:00
filter_backends = [SearchFilter, OrderingFilter, DjangoFilterBackend]
2020-03-28 16:42:29 +00:00
search_fields = ['$normalized_name', '$name', '$note__polymorphic_ctype__model', ]
2020-12-22 11:37:21 +00:00
filterset_fields = ['note', 'note__noteuser__user', 'note__noteclub__club', 'note__polymorphic_ctype__model', ]
ordering_fields = ['name', 'normalized_name', ]
2020-03-28 16:42:29 +00:00
def get_queryset(self):
"""
Parse query and apply filters.
:return: The filtered set of requested aliases
"""
2020-09-10 12:42:52 +00:00
queryset = super().get_queryset().distinct()
# Sqlite doesn't support ORDER BY in subqueries
2020-09-02 20:54:01 +00:00
queryset = queryset.order_by("name") \
if settings.DATABASES[queryset.db]["ENGINE"] == 'django.db.backends.postgresql' else queryset
2020-03-28 16:42:29 +00:00
2020-09-10 12:41:09 +00:00
alias = self.request.query_params.get("alias", None)
2020-09-01 13:54:56 +00:00
queryset = queryset.prefetch_related('note')
2020-09-10 12:41:09 +00:00
if alias:
# We match first an alias if it is matched without normalization,
# then if the normalized pattern matches a normalized alias.
queryset = queryset.filter(
name__iregex="^" + alias
).union(
queryset.filter(
Q(normalized_name__iregex="^" + Alias.normalize(alias))
& ~Q(name__iregex="^" + alias)
),
all=True).union(
queryset.filter(
Q(normalized_name__iregex="^" + alias.lower())
& ~Q(normalized_name__iregex="^" + Alias.normalize(alias))
& ~Q(name__iregex="^" + alias)
),
all=True)
2020-03-28 16:42:29 +00:00
2020-09-02 20:54:01 +00:00
queryset = queryset if settings.DATABASES[queryset.db]["ENGINE"] == 'django.db.backends.postgresql' \
else queryset.order_by("name")
return queryset.distinct()
2020-02-08 14:08:55 +00:00
class TemplateCategoryViewSet(ReadProtectedModelViewSet):
2020-03-11 00:03:15 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `TemplateCategory` objects, serialize it to JSON with the given serializer,
then render it on /api/note/transaction/category/
"""
queryset = TemplateCategory.objects.order_by('name')
2020-03-11 00:03:15 +00:00
serializer_class = TemplateCategorySerializer
2020-12-22 11:37:21 +00:00
filter_backends = [DjangoFilterBackend, SearchFilter]
filterset_fields = ['name', 'templates', 'templates__name']
search_fields = ['$name', '$templates__name', ]
2020-03-11 00:03:15 +00:00
2020-03-24 21:12:44 +00:00
class TransactionTemplateViewSet(viewsets.ModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `TransactionTemplate` objects, serialize it to JSON with the given serializer,
then render it on /api/note/transaction/template/
"""
queryset = TransactionTemplate.objects.order_by('name')
2020-02-07 16:02:07 +00:00
serializer_class = TransactionTemplateSerializer
2020-12-22 11:37:21 +00:00
filter_backends = [SearchFilter, DjangoFilterBackend, OrderingFilter]
filterset_fields = ['name', 'amount', 'display', 'category', 'category__name', ]
search_fields = ['$name', '$category__name', ]
ordering_fields = ['amount', ]
2020-02-07 16:02:07 +00:00
class TransactionViewSet(ReadProtectedModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `Transaction` objects, serialize it to JSON with the given serializer,
then render it on /api/note/transaction/transaction/
"""
queryset = Transaction.objects.order_by('-created_at')
2020-03-11 10:15:03 +00:00
serializer_class = TransactionPolymorphicSerializer
2020-09-10 12:37:11 +00:00
filter_backends = [SearchFilter, DjangoFilterBackend, OrderingFilter]
2020-12-22 12:28:43 +00:00
filterset_fields = ['source', 'source_alias', 'source__alias__name', 'source__alias__normalized_name',
2020-12-22 11:37:21 +00:00
'destination', 'destination_alias', 'destination__alias__name',
'destination__alias__normalized_name', 'quantity', 'polymorphic_ctype', 'amount',
'created_at', 'valid', 'invalidity_reason', ]
search_fields = ['$reason', '$source_alias', '$source__alias__name', '$source__alias__normalized_name',
'$destination_alias', '$destination__alias__name', '$destination__alias__normalized_name',
'$invalidity_reason', ]
ordering_fields = ['created_at', 'amount', ]
2020-08-03 14:11:05 +00:00
def get_queryset(self):
return self.model.objects.filter(PermissionBackend.filter_queryset(self.request, self.model, "view"))\
.order_by("created_at", "id")