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