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