src/catalogue/api/views.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 import json
   5 import os.path
   6 from django.conf import settings
   7 from django.http import Http404, HttpResponse
   8 from django.utils.decorators import method_decorator
   9 from django.views.decorators.cache import never_cache
  10 from rest_framework.generics import ListAPIView, RetrieveAPIView, get_object_or_404
  11 from rest_framework.permissions import DjangoModelPermissionsOrAnonReadOnly
  12 from rest_framework.response import Response
  13 from rest_framework import status
  14 from api.handlers import read_tags
  15 from api.utils import vary_on_auth
  16 from catalogue.forms import BookImportForm
  17 from catalogue.models import Book, Collection, Tag, Fragment, BookMedia
  18 from catalogue.models.tag import prefetch_relations
  19 from club.models import Membership
  20 from club.permissions import IsClubMember
  21 from wolnelektury.utils import re_escape
  22 from .helpers import books_after, order_books
  23 from . import serializers
  24
  25
  26 book_tag_categories = ['author', 'epoch', 'kind', 'genre']
  27
  28
  29 class CollectionList(ListAPIView):
  30     queryset = Collection.objects.all()
  31     serializer_class = serializers.CollectionListSerializer
  32
  33
  34 @vary_on_auth  # Because of 'liked'.
  35 class CollectionDetail(RetrieveAPIView):
  36     queryset = Collection.objects.all()
  37     lookup_field = 'slug'
  38     serializer_class = serializers.CollectionSerializer
  39
  40
  41 @vary_on_auth  # Because of 'liked'.
  42 class BookList(ListAPIView):
  43     permission_classes = [DjangoModelPermissionsOrAnonReadOnly]
  44     queryset = Book.objects.none()  # Required for DjangoModelPermissions
  45     serializer_class = serializers.BookListSerializer
  46
  47     def get(self, request, filename=None, **kwargs):
  48         if filename and not kwargs.get('tags') and 'count' not in request.query_params:
  49             try:
  50                 with open(os.path.join(settings.MEDIA_ROOT, 'api', '%s.%s' % (filename, request.accepted_renderer.format)), 'rb') as f:
  51                     content = f.read()
  52                 return HttpResponse(content, content_type=request.accepted_media_type)
  53             except:
  54                 pass
  55         return super().get(request, filename=filename, **kwargs)
  56
  57     def get_queryset(self):
  58         try:
  59             tags, ancestors = read_tags(
  60                 self.kwargs.get('tags', ''), self.request,
  61                 allowed=('author', 'epoch', 'kind', 'genre')
  62             )
  63         except ValueError:
  64             raise Http404
  65
  66         new_api = self.request.query_params.get('new_api')
  67         after = self.request.query_params.get('after', self.kwargs.get('after'))
  68         count = self.request.query_params.get('count', self.kwargs.get('count'))
  69         if count:
  70             try:
  71                 count = int(count)
  72             except TypeError:
  73                 raise Http404  # Fixme
  74
  75         if tags:
  76             if self.kwargs.get('top_level'):
  77                 books = Book.tagged_top_level(tags)
  78                 if not books:
  79                     raise Http404
  80                 return books
  81             else:
  82                 books = Book.tagged.with_all(tags)
  83         else:
  84             books = Book.objects.all()
  85         books = books.filter(findable=True)
  86         books = order_books(books, new_api)
  87
  88         if not Membership.is_active_for(self.request.user):
  89             books = books.exclude(preview=True)
  90
  91         if self.kwargs.get('top_level'):
  92             books = books.filter(parent=None)
  93         if self.kwargs.get('audiobooks'):
  94             books = books.filter(media__type='mp3').distinct()
  95         if self.kwargs.get('daisy'):
  96             books = books.filter(media__type='daisy').distinct()
  97         if self.kwargs.get('recommended'):
  98             books = books.filter(recommended=True)
  99         if self.kwargs.get('newest'):
 100             books = books.order_by('-created_at')
 101
 102         if after:
 103             books = books_after(books, after, new_api)
 104
 105         prefetch_relations(books, 'author')
 106         prefetch_relations(books, 'genre')
 107         prefetch_relations(books, 'kind')
 108         prefetch_relations(books, 'epoch')
 109
 110         if count:
 111             books = books[:count]
 112
 113         return books
 114
 115     def post(self, request, **kwargs):
 116         if kwargs.get('audiobooks'):
 117             return self.post_audiobook(request, **kwargs)
 118         else:
 119             return self.post_book(request, **kwargs)
 120
 121     def post_book(self, request, **kwargs):
 122         data = json.loads(request.POST.get('data'))
 123         form = BookImportForm(data)
 124         if form.is_valid():
 125             form.save()
 126             return Response({}, status=status.HTTP_201_CREATED)
 127         else:
 128             raise Http404
 129
 130     def post_audiobook(self, request, **kwargs):
 131         index = int(request.POST['part_index'])
 132         parts_count = int(request.POST['parts_count'])
 133         media_type = request.POST['type'].lower()
 134         source_sha1 = request.POST.get('source_sha1')
 135         name = request.POST.get('name', '')
 136         part_name = request.POST.get('part_name', '')
 137
 138         project_data = request.POST.get('project', {})
 139         project_description = project_data.get('description', '')
 140         project_icon = project_data.get('icon', '')
 141
 142         _rest, slug = request.POST['book'].rstrip('/').rsplit('/', 1)
 143         book = Book.objects.get(slug=slug)
 144
 145         try:
 146             assert source_sha1
 147             bm = book.media.get(type=media_type, source_sha1=source_sha1)
 148         except (AssertionError, BookMedia.DoesNotExist):
 149             bm = BookMedia(book=book, type=media_type)
 150         bm.name = name
 151         bm.part_name = part_name
 152         bm.index = index
 153         bm.project_description = project_description
 154         bm.project_icon = project_icon
 155         bm.file.save(None, request.data['file'], save=False)
 156         bm.save(parts_count=parts_count)
 157
 158         return Response({}, status=status.HTTP_201_CREATED)
 159
 160
 161 @vary_on_auth  # Because of 'liked'.
 162 class BookDetail(RetrieveAPIView):
 163     queryset = Book.objects.all()
 164     lookup_field = 'slug'
 165     serializer_class = serializers.BookDetailSerializer
 166
 167
 168 @vary_on_auth  # Because of embargo links.
 169 class EbookList(BookList):
 170     serializer_class = serializers.EbookSerializer
 171
 172
 173 @method_decorator(never_cache, name='dispatch')
 174 class Preview(ListAPIView):
 175     #queryset = Book.objects.filter(preview=True)
 176     serializer_class = serializers.BookPreviewSerializer
 177
 178     def get_queryset(self):
 179         qs = Book.objects.filter(preview=True)
 180         # FIXME: temporary workaround for a problem with iOS app; see #3954.
 181         if 'Darwin' in self.request.META.get('HTTP_USER_AGENT', '') and 'debug' not in self.request.GET:
 182             qs = qs.none()
 183         return qs
 184
 185
 186 @vary_on_auth  # Because of 'liked'.
 187 class FilterBookList(ListAPIView):
 188     serializer_class = serializers.FilterBookListSerializer
 189
 190     def parse_bool(self, s):
 191         if s in ('true', 'false'):
 192             return s == 'true'
 193         else:
 194             return None
 195
 196     def get_queryset(self):
 197         key_sep = '$'
 198         search_string = self.request.query_params.get('search')
 199         is_lektura = self.parse_bool(self.request.query_params.get('lektura'))
 200         is_audiobook = self.parse_bool(self.request.query_params.get('audiobook'))
 201         preview = self.parse_bool(self.request.query_params.get('preview'))
 202         if not Membership.is_active_for(self.request.user):
 203             preview = False
 204
 205         new_api = self.request.query_params.get('new_api')
 206         after = self.request.query_params.get('after')
 207         count = int(self.request.query_params.get('count', 50))
 208         books = order_books(Book.objects.distinct(), new_api)
 209         books = books.filter(findable=True)
 210         if is_lektura is not None:
 211             books = books.filter(has_audience=is_lektura)
 212         if is_audiobook is not None:
 213             if is_audiobook:
 214                 books = books.filter(media__type='mp3')
 215             else:
 216                 books = books.exclude(media__type='mp3')
 217         if preview is not None:
 218             books = books.filter(preview=preview)
 219         for category in book_tag_categories:
 220             category_plural = category + 's'
 221             if category_plural in self.request.query_params:
 222                 slugs = self.request.query_params[category_plural].split(',')
 223                 tags = Tag.objects.filter(category=category, slug__in=slugs)
 224                 books = Book.tagged.with_any(tags, books)
 225         if (search_string is not None) and len(search_string) < 3:
 226             search_string = None
 227         if search_string:
 228             search_string = re_escape(search_string)
 229             books_author = books.filter(cached_author__iregex=r'\m' + search_string)
 230             books_title = books.filter(title__iregex=r'\m' + search_string)
 231             books_title = books_title.exclude(id__in=list(books_author.values_list('id', flat=True)))
 232             if after and (key_sep in after):
 233                 which, key = after.split(key_sep, 1)
 234                 if which == 'title':
 235                     book_lists = [(books_after(books_title, key, new_api), 'title')]
 236                 else:  # which == 'author'
 237                     book_lists = [(books_after(books_author, key, new_api), 'author'), (books_title, 'title')]
 238             else:
 239                 book_lists = [(books_author, 'author'), (books_title, 'title')]
 240         else:
 241             if after and key_sep in after:
 242                 which, key = after.split(key_sep, 1)
 243                 books = books_after(books, key, new_api)
 244             book_lists = [(books, 'book')]
 245
 246         filtered_books = []
 247         for book_list, label in book_lists:
 248             for category in book_tag_categories:
 249                 book_list = prefetch_relations(book_list, category)
 250             remaining_count = count - len(filtered_books)
 251             for book in book_list[:remaining_count]:
 252                 book.key = '%s%s%s' % (
 253                     label, key_sep, book.slug if not new_api else book.full_sort_key())
 254                 filtered_books.append(book)
 255             if len(filtered_books) == count:
 256                 break
 257
 258         return filtered_books
 259
 260
 261 class EpubView(RetrieveAPIView):
 262     queryset = Book.objects.all()
 263     lookup_field = 'slug'
 264     permission_classes = [IsClubMember]
 265
 266     @method_decorator(never_cache)
 267     def get(self, *args, **kwargs):
 268         return HttpResponse(self.get_object().get_media('epub'))
 269
 270
 271 class TagCategoryView(ListAPIView):
 272     serializer_class = serializers.TagSerializer
 273
 274     def get_queryset(self):
 275         category = self.kwargs['category']
 276         tags = Tag.objects.filter(category=category).exclude(items=None).order_by('slug')
 277         if self.request.query_params.get('book_only') == 'true':
 278             tags = tags.filter(for_books=True)
 279         if self.request.GET.get('picture_only') == 'true':
 280             tags = filter(for_pictures=True)
 281
 282         after = self.request.query_params.get('after')
 283         count = self.request.query_params.get('count')
 284         if after:
 285             tags = tags.filter(slug__gt=after)
 286         if count:
 287             tags = tags[:count]
 288
 289         return tags
 290
 291
 292 class TagView(RetrieveAPIView):
 293     serializer_class = serializers.TagDetailSerializer
 294
 295     def get_object(self):
 296         return get_object_or_404(
 297             Tag,
 298             category=self.kwargs['category'],
 299             slug=self.kwargs['slug']
 300         )
 301
 302
 303 @vary_on_auth  # Because of 'liked'.
 304 class FragmentList(ListAPIView):
 305     serializer_class = serializers.FragmentSerializer
 306
 307     def get_queryset(self):
 308         try:
 309             tags, ancestors = read_tags(
 310                 self.kwargs['tags'],
 311                 self.request,
 312                 allowed={'author', 'epoch', 'kind', 'genre', 'book', 'theme'}
 313             )
 314         except ValueError:
 315             raise Http404
 316         return Fragment.tagged.with_all(tags).filter(book__findable=True).select_related('book')
 317
 318
 319 @vary_on_auth  # Because of 'liked'.
 320 class FragmentView(RetrieveAPIView):
 321     serializer_class = serializers.FragmentDetailSerializer
 322
 323     def get_object(self):
 324         return get_object_or_404(
 325             Fragment,
 326             book__slug=self.kwargs['book'],
 327             anchor=self.kwargs['anchor']
 328         )