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