Cleaning.
[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(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)
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(media__type__in=('mp3', 'ogg')).distinct()
159     return object_list(request, audiobooks, list_type='audiobooks', extra={
160         'daisy': Book.objects.filter(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
209     if not fragments and len(tags) == 1 and list_type == 'books':
210         if PictureArea.tagged.with_any(tags).exists() or Picture.tagged.with_any(tags).exists():
211             return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
212
213     return object_list(request, fragments, tags=tags, list_type=list_type, extra={
214         'theme_is_set': True,
215         'active_menu_item': 'theme',
216     })
217
218
219 def tagged_object_list(request, tags, list_type):
220     try:
221         tags = analyse_tags(request, tags)
222     except ResponseInstead as e:
223         return e.response
224
225     if is_crawler(request) and len(tags) > 1:
226         return HttpResponseForbidden('address removed from crawling. check robots.txt')
227
228     if list_type == 'gallery' and any(tag.category == 'set' for tag in tags):
229         raise Http404
230
231     if any(tag.category in ('theme', 'thing') for tag in tags):
232         return theme_list(request, tags, list_type=list_type)
233
234     if list_type == 'books':
235         books = Book.tagged.with_all(tags)
236
237         if any(tag.category == 'set' for tag in tags):
238             params = {'objects': books}
239         else:
240             params = {
241                 'objects': Book.tagged_top_level(tags),
242                 'fragments': Fragment.objects.filter(book__in=books),
243                 'related_tags': get_top_level_related_tags(tags),
244             }
245     elif list_type == 'gallery':
246         params = {'objects': Picture.tagged.with_all(tags)}
247     elif list_type == 'audiobooks':
248         audiobooks = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
249         params = {
250             'objects': Book.tagged.with_all(tags, audiobooks),
251             'extra': {
252                 'daisy': Book.tagged.with_all(
253                     tags, audiobooks.filter(media__type='daisy').distinct()
254                 ),
255             }
256         }
257     else:
258         raise Http404
259
260     return object_list(request, tags=tags, list_type=list_type, **params)
261
262
263 def book_fragments(request, slug, theme_slug):
264     book = get_object_or_404(Book, slug=slug)
265     theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
266     fragments = Fragment.tagged.with_all([theme]).filter(
267         Q(book=book) | Q(book__ancestor=book))
268
269     return render(
270         request,
271         'catalogue/book_fragments.html',
272         {
273             'book': book,
274             'theme': theme,
275             'fragments': fragments,
276             'active_menu_item': 'books',
277         })
278
279
280 @never_cache
281 def book_detail(request, slug):
282     try:
283         book = Book.objects.get(slug=slug)
284     except Book.DoesNotExist:
285         return pdcounter_views.book_stub_detail(request, slug)
286
287     return render(
288         request,
289         'catalogue/book_detail.html',
290         {
291             'book': book,
292             'book_children': book.children.all().order_by('parent_number', 'sort_key'),
293             'active_menu_item': 'books',
294         })
295
296
297 # używane w publicznym interfejsie
298 def player(request, slug):
299     book = get_object_or_404(Book, slug=slug)
300     if not book.has_media('mp3'):
301         raise Http404
302
303     audiobooks, projects = book.get_audiobooks()
304
305     return render(
306         request,
307         'catalogue/player.html',
308         {
309             'book': book,
310             'audiobook': '',
311             'audiobooks': audiobooks,
312             'projects': projects,
313         })
314
315
316 def book_text(request, slug):
317     book = get_object_or_404(Book, slug=slug)
318
319     if book.preview and not Membership.is_active_for(request.user):
320         return HttpResponseRedirect(book.get_absolute_url())
321
322     if not book.has_html_file():
323         raise Http404
324     with book.html_file.open('r') as f:
325         book_text = f.read()
326
327     return render(request, 'catalogue/book_text.html', {
328         'book': book,
329         'book_text': book_text,
330         'inserts': DynamicTextInsert.get_all(request)
331     })
332
333
334 # =========
335 # = Admin =
336 # =========
337 @login_required
338 @staff_required
339 def import_book(request):
340     """docstring for import_book"""
341     book_import_form = forms.BookImportForm(request.POST, request.FILES)
342     if book_import_form.is_valid():
343         try:
344             book_import_form.save()
345         except:
346             import sys
347             import pprint
348             import traceback
349             info = sys.exc_info()
350             exception = pprint.pformat(info[1])
351             tb = '\n'.join(traceback.format_tb(info[2]))
352             return HttpResponse(
353                 _("An error occurred: %(exception)s\n\n%(tb)s") % {
354                     'exception': exception, 'tb': tb
355                 },
356                 mimetype='text/plain'
357             )
358         return HttpResponse(_("Book imported successfully"))
359     return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
360
361
362 # info views for API
363
364 def book_info(request, book_id, lang='pl'):
365     book = get_object_or_404(Book, id=book_id)
366     # set language by hand
367     translation.activate(lang)
368     return render(request, 'catalogue/book_info.html', {'book': book})
369
370
371 def tag_info(request, tag_id):
372     tag = get_object_or_404(Tag, id=tag_id)
373     return HttpResponse(tag.description)
374
375
376 @never_cache
377 def embargo_link(request, key, format_, slug):
378     book = get_object_or_404(Book, slug=slug)
379     if format_ not in Book.formats:
380         raise Http404
381     if key != book.preview_key:
382         raise Http404
383     media_file = book.get_media(format_)
384     if not book.preview:
385         return HttpResponseRedirect(media_file.url)
386     return HttpResponse(media_file, content_type=constants.EBOOK_CONTENT_TYPES[format_])
387
388
389 def download_zip(request, format, slug=None):
390     if format in Book.ebook_formats:
391         url = Book.zip_format(format)
392     elif format in ('mp3', 'ogg') and slug is not None:
393         book = get_object_or_404(Book, slug=slug)
394         url = book.zip_audiobooks(format)
395     else:
396         raise Http404('No format specified for zip package')
397     return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
398
399
400 class CustomPDFFormView(AjaxableFormView):
401     form_class = forms.CustomPDFForm
402     title = ugettext_lazy('Download custom PDF')
403     submit = ugettext_lazy('Download')
404     template = 'catalogue/custom_pdf_form.html'
405     honeypot = True
406
407     def __call__(self, *args, **kwargs):
408         if settings.NO_CUSTOM_PDF:
409             raise Http404('Custom PDF is disabled')
410         return super(CustomPDFFormView, self).__call__(*args, **kwargs)
411
412     def form_args(self, request, obj):
413         """Override to parse view args and give additional args to the form."""
414         return (obj,), {}
415
416     def validate_object(self, obj, request):
417         book = obj
418         if book.preview and not Membership.is_active_for(request.user):
419             return HttpResponseRedirect(book.get_absolute_url())
420         return super(CustomPDFFormView, self).validate_object(obj, request)
421
422     def get_object(self, request, slug, *args, **kwargs):
423         book = get_object_or_404(Book, slug=slug)
424         return book
425
426     def context_description(self, request, obj):
427         return obj.pretty_title()
428
429
430 def tag_catalogue(request, category):
431     if category == 'theme':
432         tags = Tag.objects.usage_for_model(
433             Fragment, counts=True).filter(category='theme')
434     else:
435         tags = list(get_top_level_related_tags((), categories=(category,)))
436
437     described_tags = [tag for tag in tags if tag.description]
438
439     if len(described_tags) > 4:
440         best = random.sample(described_tags, 4)
441     else:
442         best = described_tags
443
444     return render(request, 'catalogue/tag_catalogue.html', {
445         'tags': tags,
446         'best': best,
447         'title': constants.CATEGORIES_NAME_PLURAL[category],
448         'whole_category': constants.WHOLE_CATEGORY[category],
449         'active_menu_item': 'theme' if category == 'theme' else None,
450     })
451
452
453 def collections(request):
454     objects = Collection.objects.all()
455
456     if len(objects) > 3:
457         best = random.sample(list(objects), 3)
458     else:
459         best = objects
460
461     return render(request, 'catalogue/collections.html', {
462         'objects': objects,
463         'best': best,
464     })
465
466
467 def ridero_cover(request, slug):
468     from librarian.cover import make_cover
469     wldoc = Book.objects.get(slug=slug).wldocument()
470     cover = make_cover(wldoc.book_info, width=980, bleed=20, format='PNG')
471     response = HttpResponse(content_type="image/png")
472     cover.save(response)
473     return response
474
475
476 def get_isbn(request, book_format, slug):
477     book = Book.objects.get(slug=slug)
478     return HttpResponse(book.get_extra_info_json().get('isbn_%s' % book_format))