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