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