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