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