6edbbd6a4a368d9fb1859ea5bb3f7042db2856fc
[wolnelektury.git] / src / catalogue / 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 from collections import OrderedDict
5 import random
6 import re
7
8 from django.conf import settings
9 from django.template.loader import render_to_string
10 from django.shortcuts import get_object_or_404, render, redirect
11 from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
12 from django.urls import reverse
13 from django.db.models import Q, QuerySet
14 from django.contrib.auth.decorators import login_required, user_passes_test
15 from django.utils.http import urlquote_plus
16 from django.utils import translation
17 from django.utils.translation import ugettext as _, ugettext_lazy
18 from django.views.decorators.cache import never_cache
19
20 from ajaxable.utils import AjaxableFormView
21 from club.forms import ScheduleForm
22 from club.models import Club
23 from annoy.models import DynamicTextInsert
24 from pdcounter import views as pdcounter_views
25 from picture.models import Picture, PictureArea
26 from catalogue import constants
27 from catalogue import forms
28 from catalogue.helpers import get_top_level_related_tags
29 from catalogue.models import Book, Collection, Tag, Fragment
30 from catalogue.utils import split_tags
31 from catalogue.models.tag import prefetch_relations
32
33 staff_required = user_passes_test(lambda user: user.is_staff)
34
35
36 def catalogue(request):
37     return render(request, 'catalogue/catalogue.html', {
38         'books': Book.objects.filter(findable=True, parent=None),
39         'pictures': Picture.objects.all(),
40         'collections': Collection.objects.filter(listed=True),
41         'active_menu_item': 'all_works',
42     })
43
44
45 def book_list(request, filters=None, template_name='catalogue/book_list.html',
46               nav_template_name='catalogue/snippets/book_list_nav.html',
47               list_template_name='catalogue/snippets/book_list.html'):
48     """ generates a listing of all books, optionally filtered """
49     books_by_author, orphans, books_by_parent = Book.book_list(filters)
50     books_nav = OrderedDict()
51     for tag in books_by_author:
52         if books_by_author[tag]:
53             books_nav.setdefault(tag.sort_key[0], []).append(tag)
54     return render(request, template_name, {
55         'rendered_nav': render_to_string(nav_template_name, {'books_nav': books_nav}),
56         'rendered_book_list': render_to_string(list_template_name, {
57             'books_by_author': books_by_author,
58             'orphans': orphans,
59             'books_by_parent': books_by_parent,
60         })
61     })
62
63
64 def daisy_list(request):
65     return book_list(request, Q(media__type='daisy'), template_name='catalogue/daisy_list.html')
66
67
68 def collection(request, slug):
69     coll = get_object_or_404(Collection, slug=slug)
70     return render(request, 'catalogue/collection.html', {
71         'collection': coll,
72         'active_menu_item': 'collections',
73     })
74
75
76 def differentiate_tags(request, tags, ambiguous_slugs):
77     beginning = '/'.join(tag.url_chunk for tag in tags)
78     unparsed = '/'.join(ambiguous_slugs[1:])
79     options = []
80     for tag in Tag.objects.filter(slug=ambiguous_slugs[0]):
81         options.append({
82             'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
83             'tags': [tag]
84         })
85     return render(
86         request,
87         'catalogue/differentiate_tags.html',
88         {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]}
89     )
90
91
92 def object_list(request, objects, fragments=None, related_tags=None, tags=None,
93                 list_type='books', extra=None):
94     if not tags:
95         tags = []
96     tag_ids = [tag.pk for tag in tags]
97
98     related_tag_lists = []
99     if related_tags:
100         related_tag_lists.append(related_tags)
101     else:
102         related_tag_lists.append(
103             Tag.objects.usage_for_queryset(
104                 objects, counts=True
105             ).exclude(category='set').exclude(pk__in=tag_ids))
106     if not (extra and extra.get('theme_is_set')):
107         if fragments is None:
108             if list_type == 'gallery':
109                 fragments = PictureArea.objects.filter(picture__in=objects)
110             else:
111                 fragments = Fragment.objects.filter(book__in=objects)
112         related_tag_lists.append(
113             Tag.objects.usage_for_queryset(
114                 fragments, counts=True
115             ).filter(category='theme').exclude(pk__in=tag_ids)
116             .only('name', 'sort_key', 'category', 'slug'))
117         if isinstance(objects, QuerySet):
118             objects = prefetch_relations(objects, 'author')
119
120     categories = split_tags(*related_tag_lists)
121
122     objects = list(objects)
123
124     if not objects and len(tags) == 1 and list_type == 'books':
125         if PictureArea.tagged.with_any(tags).exists() or Picture.tagged.with_any(tags).exists():
126             return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
127
128     if len(objects) > 3:
129         best = random.sample(objects, 3)
130     else:
131         best = objects
132
133     result = {
134         'object_list': objects,
135         'categories': categories,
136         'list_type': list_type,
137         'tags': tags,
138
139         'formats_form': forms.DownloadFormatsForm(),
140         'best': best,
141         'active_menu_item': list_type,
142     }
143     if extra:
144         result.update(extra)
145
146     is_author = len(tags) == 1 and tags[0].category == 'author'
147     new_layout = request.EXPERIMENTS['layout']
148     if is_author and new_layout.value:
149         template = 'catalogue/2022/author_detail.html'
150     else:
151         template = 'catalogue/tagged_object_list.html'
152         
153     return render(
154         request, template, result,
155     )
156
157
158 def literature(request):
159     books = Book.objects.filter(parent=None, findable=True)
160     return object_list(request, books, related_tags=get_top_level_related_tags([]))
161
162
163 def gallery(request):
164     return object_list(request, Picture.objects.all(), list_type='gallery')
165
166
167 def audiobooks(request):
168     audiobooks = Book.objects.filter(findable=True, media__type__in=('mp3', 'ogg')).distinct()
169     return object_list(request, audiobooks, list_type='audiobooks', extra={
170         'daisy': Book.objects.filter(findable=True, media__type='daisy').distinct(),
171     })
172
173
174 class ResponseInstead(Exception):
175     def __init__(self, response):
176         super(ResponseInstead, self).__init__()
177         self.response = response
178
179
180 def analyse_tags(request, tag_str):
181     try:
182         tags = Tag.get_tag_list(tag_str)
183     except Tag.DoesNotExist:
184         # Perhaps the user is asking about an author in Public Domain
185         # counter (they are not represented in tags)
186         chunks = tag_str.split('/')
187         if len(chunks) == 2 and chunks[0] == 'autor':
188             raise ResponseInstead(pdcounter_views.author_detail(request, chunks[1]))
189         raise Http404
190     except Tag.MultipleObjectsReturned as e:
191         # Ask the user to disambiguate
192         raise ResponseInstead(differentiate_tags(request, e.tags, e.ambiguous_slugs))
193     except Tag.UrlDeprecationWarning as e:
194         raise ResponseInstead(HttpResponsePermanentRedirect(
195             reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)])))
196
197     try:
198         if len(tags) > settings.MAX_TAG_LIST:
199             raise Http404
200     except AttributeError:
201         pass
202
203     return tags
204
205
206 def theme_list(request, tags, list_type):
207     shelf_tags = [tag for tag in tags if tag.category == 'set']
208     fragment_tags = [tag for tag in tags if tag.category != 'set']
209     if list_type == 'gallery':
210         fragments = PictureArea.tagged.with_all(fragment_tags)
211     else:
212         fragments = Fragment.tagged.with_all(fragment_tags)
213
214     if shelf_tags:
215         # TODO: Pictures on shelves not supported yet.
216         books = Book.tagged.with_all(shelf_tags).order_by()
217         fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
218     elif list_type == 'books':
219         fragments = fragments.filter(book__findable=True)
220
221     if not fragments and len(tags) == 1 and list_type == 'books':
222         if PictureArea.tagged.with_any(tags).exists() or Picture.tagged.with_any(tags).exists():
223             return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
224
225     return object_list(request, fragments, tags=tags, list_type=list_type, extra={
226         'theme_is_set': True,
227         'active_menu_item': 'theme',
228     })
229
230
231 def tagged_object_list(request, tags, list_type):
232     try:
233         tags = analyse_tags(request, tags)
234     except ResponseInstead as e:
235         return e.response
236
237     if list_type == 'gallery' and any(tag.category == 'set' for tag in tags):
238         raise Http404
239
240     if any(tag.category in ('theme', 'thing') for tag in tags):
241         return theme_list(request, tags, list_type=list_type)
242
243     if list_type == 'books':
244         books = Book.tagged.with_all(tags)
245
246         if any(tag.category == 'set' for tag in tags):
247             params = {'objects': books}
248         else:
249             books = books.filter(findable=True)
250             params = {
251                 'objects': Book.tagged_top_level(tags).filter(findable=True),
252                 'fragments': Fragment.objects.filter(book__in=books),
253                 'related_tags': get_top_level_related_tags(tags),
254             }
255     elif list_type == 'gallery':
256         params = {'objects': Picture.tagged.with_all(tags)}
257     elif list_type == 'audiobooks':
258         audiobooks = Book.objects.filter(findable=True, media__type__in=('mp3', 'ogg')).distinct()
259         params = {
260             'objects': Book.tagged.with_all(tags, audiobooks),
261             'extra': {
262                 'daisy': Book.tagged.with_all(
263                     tags, audiobooks.filter(media__type='daisy').distinct()
264                 ),
265             }
266         }
267     else:
268         raise Http404
269
270     return object_list(request, tags=tags, list_type=list_type, **params)
271
272
273 def book_fragments(request, slug, theme_slug):
274     book = get_object_or_404(Book, slug=slug)
275     theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
276     fragments = Fragment.tagged.with_all([theme]).filter(
277         Q(book=book) | Q(book__ancestor=book))
278
279     return render(
280         request,
281         'catalogue/book_fragments.html',
282         {
283             'book': book,
284             'theme': theme,
285             'fragments': fragments,
286             'active_menu_item': 'books',
287         })
288
289
290 @never_cache
291 def book_detail(request, slug):
292     try:
293         book = Book.objects.get(slug=slug)
294     except Book.DoesNotExist:
295         return pdcounter_views.book_stub_detail(request, slug)
296
297     new_layout = request.EXPERIMENTS['layout']
298     # Not for preview books.
299     if new_layout.value and not book.is_accessible_to(request.user):
300         new_layout.override(None)
301     
302     return render(
303         request,
304         'catalogue/2022/book_detail.html' if new_layout.value else 'catalogue/book_detail.html',
305         {
306             'book': book,
307             'book_children': book.children.all().order_by('parent_number', 'sort_key'),
308             'active_menu_item': 'books',
309             'club_form': ScheduleForm() if book.preview else None,
310             'club': Club.objects.first() if book.preview else None,
311
312             'EXPERIMENTS_SWITCHABLE_layout': True,
313         })
314
315
316 # używane w publicznym interfejsie
317 def player(request, slug):
318     book = get_object_or_404(Book, slug=slug)
319     if not book.has_media('mp3'):
320         raise Http404
321
322     audiobooks, projects, total_duration = book.get_audiobooks()
323
324     return render(
325         request,
326         'catalogue/player.html',
327         {
328             'book': book,
329             'audiobook': '',
330             'audiobooks': audiobooks,
331             'projects': projects,
332         })
333
334
335 def book_text(request, slug):
336     book = get_object_or_404(Book, slug=slug)
337
338     if not book.is_accessible_to(request.user):
339         return HttpResponseRedirect(book.get_absolute_url())
340
341     if not book.has_html_file():
342         raise Http404
343     with book.html_file.open('r') as f:
344         book_text = f.read()
345
346     return render(request, 'catalogue/book_text.html', {
347         'book': book,
348         'book_text': book_text,
349         'inserts': DynamicTextInsert.get_all(request)
350     })
351
352
353 # =========
354 # = Admin =
355 # =========
356 @login_required
357 @staff_required
358 def import_book(request):
359     """docstring for import_book"""
360     book_import_form = forms.BookImportForm(request.POST, request.FILES)
361     if book_import_form.is_valid():
362         try:
363             book_import_form.save()
364         except:
365             import sys
366             import pprint
367             import traceback
368             info = sys.exc_info()
369             exception = pprint.pformat(info[1])
370             tb = '\n'.join(traceback.format_tb(info[2]))
371             return HttpResponse(
372                 _("An error occurred: %(exception)s\n\n%(tb)s") % {
373                     'exception': exception, 'tb': tb
374                 },
375                 content_type='text/plain'
376             )
377         return HttpResponse(_("Book imported successfully"))
378     return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
379
380
381 # info views for API
382
383 def book_info(request, book_id, lang='pl'):
384     book = get_object_or_404(Book, id=book_id)
385     # set language by hand
386     translation.activate(lang)
387     return render(request, 'catalogue/book_info.html', {'book': book})
388
389
390 def tag_info(request, tag_id):
391     tag = get_object_or_404(Tag, id=tag_id)
392     return HttpResponse(tag.description)
393
394
395 @never_cache
396 def embargo_link(request, key, format_, slug):
397     book = get_object_or_404(Book, slug=slug)
398     if format_ not in Book.formats:
399         raise Http404
400     if key != book.preview_key:
401         raise Http404
402     media_file = book.get_media(format_)
403     if not book.preview:
404         return HttpResponseRedirect(media_file.url)
405     return HttpResponse(media_file, content_type=constants.EBOOK_CONTENT_TYPES[format_])
406
407
408 def download_zip(request, format, slug=None):
409     if format in Book.ebook_formats:
410         url = Book.zip_format(format)
411     elif format in ('mp3', 'ogg') and slug is not None:
412         book = get_object_or_404(Book, slug=slug)
413         url = book.zip_audiobooks(format)
414     else:
415         raise Http404('No format specified for zip package')
416     return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
417
418
419 class CustomPDFFormView(AjaxableFormView):
420     form_class = forms.CustomPDFForm
421     title = ugettext_lazy('Download custom PDF')
422     submit = ugettext_lazy('Download')
423     template = 'catalogue/custom_pdf_form.html'
424     honeypot = True
425
426     def __call__(self, *args, **kwargs):
427         if settings.NO_CUSTOM_PDF:
428             raise Http404('Custom PDF is disabled')
429         return super(CustomPDFFormView, self).__call__(*args, **kwargs)
430
431     def form_args(self, request, obj):
432         """Override to parse view args and give additional args to the form."""
433         return (obj,), {}
434
435     def validate_object(self, obj, request):
436         book = obj
437         if not book.is_accessible_to(request.user):
438             return HttpResponseRedirect(book.get_absolute_url())
439         return super(CustomPDFFormView, self).validate_object(obj, request)
440
441     def get_object(self, request, slug, *args, **kwargs):
442         book = get_object_or_404(Book, slug=slug)
443         return book
444
445     def context_description(self, request, obj):
446         return obj.pretty_title()
447
448
449 def tag_catalogue(request, category):
450     if category == 'theme':
451         tags = Tag.objects.usage_for_model(
452             Fragment, counts=True).filter(category='theme')
453     else:
454         tags = list(get_top_level_related_tags((), categories=(category,)))
455
456     described_tags = [tag for tag in tags if tag.description]
457
458     if len(described_tags) > 4:
459         best = random.sample(described_tags, 4)
460     else:
461         best = described_tags
462
463     return render(request, 'catalogue/tag_catalogue.html', {
464         'tags': tags,
465         'best': best,
466         'title': constants.CATEGORIES_NAME_PLURAL[category],
467         'whole_category': constants.WHOLE_CATEGORY[category],
468         'active_menu_item': 'theme' if category == 'theme' else None,
469     })
470
471
472 def collections(request):
473     objects = Collection.objects.filter(listed=True)
474
475     if len(objects) > 3:
476         best = random.sample(list(objects), 4)
477     else:
478         best = objects
479
480     return render(request, 'catalogue/collections.html', {
481         'objects': objects,
482         'best': best,
483         'active_menu_item': 'collections'
484     })
485
486
487 def ridero_cover(request, slug):
488     from librarian.cover import make_cover
489     wldoc = Book.objects.get(slug=slug).wldocument()
490     cover = make_cover(wldoc.book_info, width=980, bleed=20, format='PNG')
491     response = HttpResponse(content_type="image/png")
492     cover.save(response)
493     return response
494
495
496 def get_isbn(request, book_format, slug):
497     book = Book.objects.get(slug=slug)
498     return HttpResponse(book.get_extra_info_json().get('isbn_%s' % book_format))