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