nk20/apps/note/api/views.py

176 lines
6.6 KiB
Python
Raw Normal View History

2020-02-07 16:02:07 +00:00
# Copyright (C) 2018-2020 by BDE ENS Paris-Saclay
# SPDX-License-Identifier: GPL-3.0-or-later
from django.db.models import Q
2020-03-11 10:15:03 +00:00
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.filters import OrderingFilter, SearchFilter
from api.viewsets import ReadProtectedModelViewSet
from member.backends import PermissionBackend
from .serializers import NoteSerializer, NotePolymorphicSerializer, NoteClubSerializer, NoteSpecialSerializer, \
NoteUserSerializer, AliasSerializer, \
2020-03-11 10:15:03 +00:00
TemplateCategorySerializer, TransactionTemplateSerializer, TransactionPolymorphicSerializer
2020-03-07 21:28:59 +00:00
from ..models.notes import Note, NoteClub, NoteSpecial, NoteUser, Alias
2020-03-11 10:15:03 +00:00
from ..models.transactions import TransactionTemplate, Transaction, TemplateCategory
2020-02-07 16:02:07 +00:00
class NoteViewSet(ReadProtectedModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `Note` objects, serialize it to JSON with the given serializer,
then render it on /api/note/note/
"""
queryset = Note.objects.all()
serializer_class = NoteSerializer
class NoteClubViewSet(ReadProtectedModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `NoteClub` objects, serialize it to JSON with the given serializer,
then render it on /api/note/club/
"""
queryset = NoteClub.objects.all()
serializer_class = NoteClubSerializer
class NoteSpecialViewSet(ReadProtectedModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `NoteSpecial` objects, serialize it to JSON with the given serializer,
then render it on /api/note/special/
"""
queryset = NoteSpecial.objects.all()
serializer_class = NoteSpecialSerializer
class NoteUserViewSet(ReadProtectedModelViewSet):
2020-02-07 16:02:07 +00:00
"""
REST API View set.
The djangorestframework plugin will get all `NoteUser` objects, serialize it to JSON with the given serializer,
then render it on /api/note/user/
"""
queryset = NoteUser.objects.all()
serializer_class = NoteUserSerializer
class NotePolymorphicViewSet(ReadProtectedModelViewSet):
2020-02-07 19:47:49 +00:00
"""
REST API View set.
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.all()
serializer_class = NotePolymorphicSerializer
filter_backends = [SearchFilter, OrderingFilter]
search_fields = ['$alias__normalized_name', '$alias__name', '$polymorphic_ctype__model', ]
ordering_fields = ['alias__name', 'alias__normalized_name']
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 = super().get_queryset().filter(PermissionBackend.filter_queryset(self.request.user, Note, "view"))
alias = self.request.query_params.get("alias", ".*")
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
2020-03-10 16:16:03 +00:00
Q(alias__name__regex="^" + alias)
| Q(alias__normalized_name__regex="^" + alias.lower()))
note_type = self.request.query_params.get("type", None)
if note_type:
2020-02-18 20:14:29 +00:00
types = str(note_type).lower()
if "user" in types:
queryset = queryset.filter(polymorphic_ctype__model="noteuser")
2020-02-18 20:14:29 +00:00
elif "club" in types:
queryset = queryset.filter(polymorphic_ctype__model="noteclub")
2020-02-18 20:14:29 +00:00
elif "special" in types:
2020-03-12 00:10:52 +00:00
queryset = queryset.filter(polymorphic_ctype__model="notespecial")
else:
queryset = queryset.none()
2020-03-12 10:12:21 +00:00
return queryset.distinct()
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.all()
serializer_class = AliasSerializer
filter_backends = [SearchFilter, OrderingFilter]
2020-03-12 00:10:52 +00:00
search_fields = ['$normalized_name', '$name', '$note__polymorphic_ctype__model', ]
ordering_fields = ['name', 'normalized_name']
2020-02-08 14:08:55 +00:00
def get_queryset(self):
"""
Parse query and apply filters.
:return: The filtered set of requested aliases
"""
queryset = super().get_queryset().filter(PermissionBackend.filter_queryset(self.request.user, Alias, "view"))
alias = self.request.query_params.get("alias", ".*")
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
2020-03-10 16:16:03 +00:00
Q(name__regex="^" + alias) | Q(normalized_name__regex="^" + alias.lower()))
note_id = self.request.query_params.get("note", None)
if note_id:
queryset = queryset.filter(id=note_id)
note_type = self.request.query_params.get("type", None)
if note_type:
2020-02-18 20:14:29 +00:00
types = str(note_type).lower()
if "user" in types:
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
note__polymorphic_ctype__model="noteuser")
2020-02-18 20:14:29 +00:00
elif "club" in types:
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
note__polymorphic_ctype__model="noteclub")
2020-02-18 20:14:29 +00:00
elif "special" in types:
2020-02-18 11:31:15 +00:00
queryset = queryset.filter(
note__polymorphic_ctype__model="notespecial")
else:
queryset = queryset.none()
return queryset
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.all()
serializer_class = TemplateCategorySerializer
2020-03-11 10:15:03 +00:00
filter_backends = [SearchFilter]
search_fields = ['$name', ]
2020-03-11 00:03:15 +00:00
class TransactionTemplateViewSet(ReadProtectedModelViewSet):
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.all()
serializer_class = TransactionTemplateSerializer
2020-03-11 10:15:03 +00:00
filter_backends = [DjangoFilterBackend]
filterset_fields = ['name', 'amount', 'display', 'category', ]
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.all()
2020-03-11 10:15:03 +00:00
serializer_class = TransactionPolymorphicSerializer
filter_backends = [SearchFilter]
search_fields = ['$reason', ]