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