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