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