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