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