src/catalogue/api/views.py

   1 # This file is part of Wolne Lektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
   3 #
   4 import json
   5 import os.path
   6 from urllib.request import urlopen
   7 from django.conf import settings
   8 from django.core.files.base import ContentFile
   9 from django.http import Http404, HttpResponse
  10 from django.utils.decorators import method_decorator
  11 from django.views.decorators.cache import never_cache
  12 from django_filters import rest_framework as dfilters
  13 from rest_framework import filters
  14 from rest_framework.generics import (ListAPIView, RetrieveAPIView,
  15                                      RetrieveUpdateAPIView, get_object_or_404)
  16 from rest_framework.permissions import DjangoModelPermissionsOrAnonReadOnly
  17 from rest_framework.response import Response
  18 from rest_framework import status
  19 from api.handlers import read_tags
  20 from api.utils import vary_on_auth
  21 from catalogue.forms import BookImportForm
  22 from catalogue.models import Book, Collection, Tag, Fragment, BookMedia
  23 from catalogue.models.tag import prefetch_relations
  24 from club.models import Membership
  25 from club.permissions import IsClubMember
  26 from sortify import sortify
  27 from wolnelektury.utils import re_escape
  28 from .helpers import books_after, order_books
  29 from . import serializers
  30
  31
  32 book_tag_categories = ['author', 'epoch', 'kind', 'genre']
  33
  34
  35 class LegacyListAPIView(ListAPIView):
  36     pagination_class = None
  37
  38
  39 class CreateOnPutMixin:
  40     '''
  41     Creates a new model instance when PUTting a nonexistent resource.
  42     '''
  43     def get_object(self):
  44         try:
  45             return super().get_object()
  46         except Http404:
  47             if self.request.method == 'PUT':
  48                 lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
  49                 return self.get_queryset().model(**{
  50                     self.lookup_field: self.kwargs[lookup_url_kwarg]
  51                 })
  52             else:
  53                 raise
  54
  55
  56 class CollectionList(LegacyListAPIView):
  57     queryset = Collection.objects.filter(listed=True)
  58     serializer_class = serializers.CollectionListSerializer
  59
  60
  61 @vary_on_auth  # Because of 'liked'.
  62 class CollectionDetail(CreateOnPutMixin, RetrieveUpdateAPIView):
  63     permission_classes = [DjangoModelPermissionsOrAnonReadOnly]
  64     queryset = Collection.objects.all()
  65     lookup_field = 'slug'
  66     serializer_class = serializers.CollectionSerializer
  67
  68
  69 @vary_on_auth  # Because of 'liked'.
  70 class BookList(LegacyListAPIView):
  71     permission_classes = [DjangoModelPermissionsOrAnonReadOnly]
  72     queryset = Book.objects.none()  # Required for DjangoModelPermissions
  73     serializer_class = serializers.BookListSerializer
  74
  75     def get(self, request, filename=None, **kwargs):
  76         if filename and not kwargs.get('tags') and 'count' not in request.query_params:
  77             try:
  78                 with open(os.path.join(settings.MEDIA_ROOT, 'api', '%s.%s' % (filename, request.accepted_renderer.format)), 'rb') as f:
  79                     content = f.read()
  80                 return HttpResponse(content, content_type=request.accepted_media_type)
  81             except:
  82                 pass
  83         return super().get(request, filename=filename, **kwargs)
  84
  85     def get_queryset(self):
  86         try:
  87             tags, ancestors = read_tags(
  88                 self.kwargs.get('tags', ''), self.request,
  89                 allowed=('author', 'epoch', 'kind', 'genre')
  90             )
  91         except ValueError:
  92             raise Http404
  93
  94         new_api = self.request.query_params.get('new_api')
  95         after = self.request.query_params.get('after', self.kwargs.get('after'))
  96         count = self.request.query_params.get('count', self.kwargs.get('count'))
  97         if count:
  98             try:
  99                 count = int(count)
 100             except TypeError:
 101                 raise Http404  # Fixme
 102
 103         if tags:
 104             if self.kwargs.get('top_level'):
 105                 books = Book.tagged_top_level(tags)
 106                 if not books:
 107                     raise Http404
 108                 return books
 109             else:
 110                 books = Book.tagged.with_all(tags)
 111         else:
 112             books = Book.objects.all()
 113         books = books.filter(findable=True)
 114         books = order_books(books, new_api)
 115
 116         if not Membership.is_active_for(self.request.user):
 117             books = books.exclude(preview=True)
 118
 119         if self.kwargs.get('top_level'):
 120             books = books.filter(parent=None)
 121         if self.kwargs.get('audiobooks'):
 122             books = books.filter(media__type='mp3').distinct()
 123         if self.kwargs.get('daisy'):
 124             books = books.filter(media__type='daisy').distinct()
 125         if self.kwargs.get('recommended'):
 126             books = books.filter(recommended=True)
 127         if self.kwargs.get('newest'):
 128             books = books.order_by('-created_at')
 129
 130         if after:
 131             books = books_after(books, after, new_api)
 132
 133         prefetch_relations(books, 'author')
 134         prefetch_relations(books, 'genre')
 135         prefetch_relations(books, 'kind')
 136         prefetch_relations(books, 'epoch')
 137
 138         if count:
 139             books = books[:count]
 140
 141         return books
 142
 143     def post(self, request, **kwargs):
 144         if kwargs.get('audiobooks'):
 145             return self.post_audiobook(request, **kwargs)
 146         else:
 147             return self.post_book(request, **kwargs)
 148
 149     def post_book(self, request, **kwargs):
 150         data = json.loads(request.POST.get('data'))
 151         form = BookImportForm(data)
 152         if form.is_valid():
 153             form.save()
 154             return Response({}, status=status.HTTP_201_CREATED)
 155         else:
 156             raise Http404
 157
 158     def post_audiobook(self, request, **kwargs):
 159         index = int(request.POST['part_index'])
 160         parts_count = int(request.POST['parts_count'])
 161         media_type = request.POST['type'].lower()
 162         source_sha1 = request.POST.get('source_sha1')
 163         name = request.POST.get('name', '')
 164         part_name = request.POST.get('part_name', '')
 165
 166         project_description = request.POST.get('project_description', '')
 167         project_icon = request.POST.get('project_icon', '')
 168
 169         _rest, slug = request.POST['book'].rstrip('/').rsplit('/', 1)
 170         book = Book.objects.get(slug=slug)
 171
 172         try:
 173             assert source_sha1
 174             bm = book.media.get(type=media_type, source_sha1=source_sha1)
 175         except (AssertionError, BookMedia.DoesNotExist):
 176             bm = BookMedia(book=book, type=media_type)
 177         bm.name = name
 178         bm.part_name = part_name
 179         bm.index = index
 180         bm.project_description = project_description
 181         bm.project_icon = project_icon
 182         bm.file.save(None, request.data['file'], save=False)
 183         bm.save(parts_count=parts_count)
 184
 185         return Response({}, status=status.HTTP_201_CREATED)
 186
 187
 188 class BookFilter(dfilters.FilterSet):
 189     sort = dfilters.OrderingFilter(
 190         fields=(
 191             ('sort_key_author', 'alpha'),
 192             ('popularity', 'popularity'),
 193         )
 194     )
 195     tag = dfilters.ModelMultipleChoiceFilter(
 196         field_name='tag_relations__tag',
 197         queryset=Tag.objects.filter(category__in=('author', 'epoch', 'genre', 'kind')),
 198         conjoined=True,
 199     )
 200
 201
 202 class BookList2(ListAPIView):
 203     permission_classes = [DjangoModelPermissionsOrAnonReadOnly]
 204     queryset = Book.objects.none()  # Required for DjangoModelPermissions
 205     serializer_class = serializers.BookSerializer2
 206     filter_backends = (
 207         dfilters.DjangoFilterBackend,
 208         filters.SearchFilter,
 209     )
 210     filterset_class = BookFilter
 211     search_fields = [
 212         'title',
 213     ]
 214
 215     def get_queryset(self):
 216         books = Book.objects.all()
 217         books = books.filter(findable=True)
 218         books = order_books(books, True)
 219
 220         return books
 221
 222
 223 class BookList11Labs(BookList2):
 224     serializer_class = serializers.BookSerializer11Labs
 225
 226     def get_queryset(self):
 227         books = Book.objects.all()
 228         books = books.filter(findable=True)
 229         books = books.filter(license='')
 230         books = order_books(books, True)
 231
 232         return books
 233
 234
 235 @vary_on_auth  # Because of 'liked'.
 236 class BookDetail(RetrieveAPIView):
 237     queryset = Book.objects.all()
 238     lookup_field = 'slug'
 239     serializer_class = serializers.BookDetailSerializer
 240
 241
 242 class BookDetail2(RetrieveAPIView):
 243     queryset = Book.objects.all()
 244     lookup_field = 'slug'
 245     serializer_class = serializers.BookSerializer2
 246
 247
 248 @vary_on_auth  # Because of embargo links.
 249 class EbookList(BookList):
 250     serializer_class = serializers.EbookSerializer
 251
 252
 253 @method_decorator(never_cache, name='dispatch')
 254 class Preview(LegacyListAPIView):
 255     #queryset = Book.objects.filter(preview=True)
 256     serializer_class = serializers.BookPreviewSerializer
 257
 258     def get_queryset(self):
 259         qs = Book.objects.filter(preview=True)
 260         # FIXME: temporary workaround for a problem with iOS app; see #3954.
 261         if 'Darwin' in self.request.META.get('HTTP_USER_AGENT', '') and 'debug' not in self.request.GET:
 262             qs = qs.none()
 263         return qs
 264
 265
 266 @vary_on_auth  # Because of 'liked'.
 267 class FilterBookList(LegacyListAPIView):
 268     serializer_class = serializers.FilterBookListSerializer
 269
 270     def parse_bool(self, s):
 271         if s in ('true', 'false'):
 272             return s == 'true'
 273         else:
 274             return None
 275
 276     def get_queryset(self):
 277         key_sep = '$'
 278         search_string = self.request.query_params.get('search')
 279         is_lektura = self.parse_bool(self.request.query_params.get('lektura'))
 280         is_audiobook = self.parse_bool(self.request.query_params.get('audiobook'))
 281         preview = self.parse_bool(self.request.query_params.get('preview'))
 282         if not Membership.is_active_for(self.request.user):
 283             preview = False
 284
 285         new_api = self.request.query_params.get('new_api')
 286         after = self.request.query_params.get('after')
 287         count = int(self.request.query_params.get('count', 50))
 288         books = order_books(Book.objects.distinct(), new_api)
 289         books = books.filter(findable=True)
 290         if is_lektura is not None:
 291             books = books.filter(has_audience=is_lektura)
 292         if is_audiobook is not None:
 293             if is_audiobook:
 294                 books = books.filter(media__type='mp3')
 295             else:
 296                 books = books.exclude(media__type='mp3')
 297         if preview is not None:
 298             books = books.filter(preview=preview)
 299         for category in book_tag_categories:
 300             category_plural = category + 's'
 301             if category_plural in self.request.query_params:
 302                 slugs = self.request.query_params[category_plural].split(',')
 303                 tags = Tag.objects.filter(category=category, slug__in=slugs)
 304                 books = Book.tagged.with_any(tags, books)
 305         if (search_string is not None) and len(search_string) < 3:
 306             search_string = None
 307         if search_string:
 308             search_string = re_escape(search_string)
 309             books_author = books.filter(cached_author__iregex=r'\m' + search_string)
 310             books_title = books.filter(title__iregex=r'\m' + search_string)
 311             books_title = books_title.exclude(id__in=list(books_author.values_list('id', flat=True)))
 312             if after and (key_sep in after):
 313                 which, key = after.split(key_sep, 1)
 314                 if which == 'title':
 315                     book_lists = [(books_after(books_title, key, new_api), 'title')]
 316                 else:  # which == 'author'
 317                     book_lists = [(books_after(books_author, key, new_api), 'author'), (books_title, 'title')]
 318             else:
 319                 book_lists = [(books_author, 'author'), (books_title, 'title')]
 320         else:
 321             if after and key_sep in after:
 322                 which, key = after.split(key_sep, 1)
 323                 books = books_after(books, key, new_api)
 324             book_lists = [(books, 'book')]
 325
 326         filtered_books = []
 327         for book_list, label in book_lists:
 328             for category in book_tag_categories:
 329                 book_list = prefetch_relations(book_list, category)
 330             remaining_count = count - len(filtered_books)
 331             for book in book_list[:remaining_count]:
 332                 book.key = '%s%s%s' % (
 333                     label, key_sep, book.slug if not new_api else book.full_sort_key())
 334                 filtered_books.append(book)
 335             if len(filtered_books) == count:
 336                 break
 337
 338         return filtered_books
 339
 340
 341 class EpubView(RetrieveAPIView):
 342     queryset = Book.objects.all()
 343     lookup_field = 'slug'
 344     permission_classes = [IsClubMember]
 345
 346     @method_decorator(never_cache)
 347     def get(self, *args, **kwargs):
 348         return HttpResponse(self.get_object().get_media('epub'))
 349
 350
 351 class TagCategoryView(LegacyListAPIView):
 352     serializer_class = serializers.TagSerializer
 353
 354     def get_queryset(self):
 355         category = self.kwargs['category']
 356         tags = Tag.objects.filter(category=category).exclude(items=None).order_by('slug')
 357
 358         after = self.request.query_params.get('after')
 359         count = self.request.query_params.get('count')
 360         if after:
 361             tags = tags.filter(slug__gt=after)
 362         if count:
 363             tags = tags[:count]
 364
 365         return tags
 366
 367 class AuthorList(ListAPIView):
 368     serializer_class = serializers.AuthorSerializer
 369     queryset = Tag.objects.filter(category='author')
 370
 371 class AuthorView(RetrieveAPIView):
 372     serializer_class = serializers.AuthorSerializer
 373     queryset = Tag.objects.filter(category='author')
 374     lookup_field = 'slug'
 375
 376 class EpochList(ListAPIView):
 377     serializer_class = serializers.EpochSerializer
 378     queryset = Tag.objects.filter(category='epoch')
 379
 380 class EpochView(RetrieveAPIView):
 381     serializer_class = serializers.EpochSerializer
 382     queryset = Tag.objects.filter(category='epoch')
 383     lookup_field = 'slug'
 384
 385 class GenreList(ListAPIView):
 386     serializer_class = serializers.GenreSerializer
 387     queryset = Tag.objects.filter(category='genre')
 388
 389 class GenreView(RetrieveAPIView):
 390     serializer_class = serializers.GenreSerializer
 391     queryset = Tag.objects.filter(category='genre')
 392     lookup_field = 'slug'
 393
 394 class KindList(ListAPIView):
 395     serializer_class = serializers.KindSerializer
 396     queryset = Tag.objects.filter(category='kind')
 397
 398 class KindView(RetrieveAPIView):
 399     serializer_class = serializers.KindSerializer
 400     queryset = Tag.objects.filter(category='kind')
 401     lookup_field = 'slug'
 402
 403
 404 class TagView(RetrieveAPIView):
 405     permission_classes = [DjangoModelPermissionsOrAnonReadOnly]
 406     serializer_class = serializers.TagDetailSerializer
 407     queryset = Tag.objects.all()
 408
 409     def get_object(self):
 410         try:
 411             return get_object_or_404(
 412                 Tag,
 413                 category=self.kwargs['category'],
 414                 slug=self.kwargs['slug']
 415             )
 416         except Http404:
 417             if self.request.method == 'POST':
 418                 return Tag(
 419                     category=self.kwargs['category'],
 420                     slug=self.kwargs['slug']
 421                 )
 422             else:
 423                 raise
 424
 425     def post(self, request, **kwargs):
 426         data = json.loads(request.POST.get('data'))
 427         fields = {
 428             "name_pl": "name_pl",
 429             "description_pl": "description_pl",
 430             "plural": "plural",
 431             "is_epoch_specific": "genre_epoch_specific",
 432             "collective_noun": "collective_noun",
 433             "adjective_feminine_singular": "adjective_feminine_singular",
 434             "adjective_nonmasculine_plural": "adjective_nonmasculine_plural",
 435             "genitive": "genitive",
 436             "collective_noun": "collective_noun",
 437             "gazeta_link": "gazeta_link",
 438             "culturepl_link": "culturepl_link",
 439             "wiki_link_pl": "wiki_link_pl",
 440             "photo_attribution": "photo_attribution",
 441         }
 442         obj = self.get_object()
 443         updated = set()
 444         for data_field, model_field in fields.items():
 445             value = data.get(data_field)
 446             if value:
 447                 if obj.category == 'author' and model_field == 'name_pl':
 448                     obj.sort_key = sortify(value.lower())
 449                     updated.add('sort_key')
 450                     value = ' '.join(reversed([t.strip() for t in value.split(',', 1)]))
 451                 setattr(obj, model_field, value)
 452                 updated.add(model_field)
 453         if data.get('photo'):
 454             response = urlopen(data['photo'])
 455             ext = response.headers.get('Content-Type', '').rsplit('/', 1)[-1]
 456             obj.photo.save(
 457                 "{}.{}".format(self.kwargs['slug'], ext),
 458                 ContentFile(response.read()),
 459                 save=False,
 460             )
 461             updated.add('photo')
 462
 463         if obj.pk:
 464             obj.save(update_fields=updated, quick=True)
 465         else:
 466             obj.save()
 467         return Response({})
 468
 469
 470 @vary_on_auth  # Because of 'liked'.
 471 class FragmentList(LegacyListAPIView):
 472     serializer_class = serializers.FragmentSerializer
 473
 474     def get_queryset(self):
 475         try:
 476             tags, ancestors = read_tags(
 477                 self.kwargs['tags'],
 478                 self.request,
 479                 allowed={'author', 'epoch', 'kind', 'genre', 'book', 'theme'}
 480             )
 481         except ValueError:
 482             raise Http404
 483         return Fragment.tagged.with_all(tags).filter(book__findable=True).select_related('book')
 484
 485
 486 @vary_on_auth  # Because of 'liked'.
 487 class FragmentView(RetrieveAPIView):
 488     serializer_class = serializers.FragmentDetailSerializer
 489
 490     def get_object(self):
 491         return get_object_or_404(
 492             Fragment,
 493             book__slug=self.kwargs['book'],
 494             anchor=self.kwargs['anchor']
 495         )