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