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