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