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