1 # This file is part of Wolne Lektury, licensed under GNU Affero GPLv3 or later.
2 # Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
4 from random import randint, random
5 from urllib.parse import urlparse
6 from django.contrib.contenttypes.models import ContentType
8 from django.conf import settings
9 from django import template
10 from django.template import Node, Variable, Template, Context
11 from django.urls import reverse
12 from django.utils.cache import add_never_cache_headers
13 from django.utils.safestring import mark_safe
14 from django.utils.translation import gettext as _
16 from catalogue.helpers import get_audiobook_tags
17 from catalogue.models import Book, BookMedia, Fragment, Tag, Source
18 from catalogue.constants import LICENSES
19 from club.models import Membership
20 from picture.models import Picture
22 register = template.Library()
35 return '%s%s' % (text[0].upper(), text[1:])
41 def html_title_from_tags(tags):
43 return title_from_tags(tags)
44 template = Template("{{ category }}: <a href='{{ tag.get_absolute_url }}'>{{ tag.name }}</a>")
45 return mark_safe(capfirst(",<br/>".join(
46 template.render(Context({'tag': tag, 'category': tag.get_category_display()})) for tag in tags)))
49 def simple_title(tags):
52 title.append("%s: %s" % (tag.get_category_display(), tag.name))
53 return capfirst(', '.join(title))
57 def book_title(book, html_links=False):
58 return mark_safe(book.pretty_title(html_links))
62 def book_title_html(book):
63 return book_title(book, html_links=True)
67 def title_from_tags(tags):
68 # TODO: Remove this after adding flection mechanism
69 return simple_title(tags)
73 def nice_title_from_tags(tags, related_tags):
77 result.setdefault(tag.category, []).append(tag)
80 self = split_tags(tags)
84 epoch_reduntant = False
88 t.plural or t.name for t in self['genre']
90 epoch_reduntant = self['genre'][-1].genre_epoch_specific
92 # If we don't have genre,
93 # look if maybe we only have one genre in this context?
94 if 'genre' in related_tags and len(related_tags['genre']) == 1:
96 t.plural or t.name for t in related_tags['genre']
98 epoch_reduntant = related_tags['genre'][-1].genre_epoch_specific
100 # Only use kind if not talking about genre.
102 t.collective_noun or t.name for t in self['kind']
105 elif 'kind' in related_tags and len(related_tags['kind']) == 1:
106 # No info on genre, but there's only one kind related.
109 t.collective_noun or t.name for t in related_tags['kind']
113 # We can't say anything about genre or kind.
114 pieces.append(['Twórczość'])
117 if not epoch_reduntant and 'epoch' in self:
119 form = lambda t: t.adjective_nonmasculine_plural or t.name
121 form = lambda t: t.adjective_feminine_singular or t.name
123 form(t) for t in self['epoch']
128 t.genitive or t.name for t in self['author']
132 for sublist in pieces:
133 for item in sublist[:-2]:
135 for item in sublist[-2:-1]:
136 p.append(item + ' i')
137 p.append(sublist[-1])
143 def book_tree(book_list, books_by_parent):
144 text = "".join("<li><a href='%s'>%s</a>%s</li>" % (
145 book.get_absolute_url(), book.title, book_tree(books_by_parent.get(book, ()), books_by_parent)
146 ) for book in book_list)
149 return mark_safe("<ol>%s</ol>" % text)
155 def book_tree_texml(book_list, books_by_parent, depth=1):
156 return mark_safe("".join("""
157 <cmd name='hspace'><parm>%(depth)dem</parm></cmd>%(title)s
158 <spec cat='align' /><cmd name="note"><parm>%(audiences)s</parm></cmd>
159 <spec cat='align' /><cmd name="note"><parm>%(audiobook)s</parm></cmd>
165 "audiences": ", ".join(book.audiences_pl()),
166 "audiobook": "audiobook" if book.has_media('mp3') else "",
167 "children": book_tree_texml(books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
168 } for book in book_list))
172 def book_tree_csv(author, book_list, books_by_parent, depth=1, max_depth=3, delimeter="\t"):
173 def quote_if_necessary(s):
176 s.replace('"', '\\"')
181 return mark_safe("".join("""%(author)s%(d)s%(preindent)s%(title)s%(d)s%(postindent)s%(audiences)s%(d)s%(audiobook)s
184 "preindent": delimeter * (depth - 1),
185 "postindent": delimeter * (max_depth - depth),
187 "author": quote_if_necessary(author.name),
188 "title": quote_if_necessary(book.title),
189 "audiences": ", ".join(book.audiences_pl()),
190 "audiobook": "audiobook" if book.has_media('mp3') else "",
191 "children": book_tree_csv(author, books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
192 } for book in book_list))
196 def all_editors(extra_info):
198 if 'editors' in extra_info:
199 editors += extra_info['editors']
200 if 'technical_editors' in extra_info:
201 editors += extra_info['technical_editors']
202 # support for extra_info-s from librarian<1.2
203 if 'editor' in extra_info:
204 editors.append(extra_info['editor'])
205 if 'technical_editor' in extra_info:
206 editors.append(extra_info['technical_editor'])
208 ' '.join(p.strip() for p in person.rsplit(',', 1)[::-1])
209 for person in sorted(set(editors)))
213 def catalogue_url(parser, token):
214 bits = token.split_contents()
220 tags_to_remove.append(bit[1:])
222 tags_to_add.append(bit)
224 return CatalogueURLNode(bits[1], tags_to_add, tags_to_remove)
227 class CatalogueURLNode(Node):
228 def __init__(self, list_type, tags_to_add, tags_to_remove):
229 self.tags_to_add = [Variable(tag) for tag in tags_to_add]
230 self.tags_to_remove = [Variable(tag) for tag in tags_to_remove]
231 self.list_type_var = Variable(list_type)
233 def render(self, context):
234 list_type = self.list_type_var.resolve(context)
238 for tag_variable in self.tags_to_add:
239 tag = tag_variable.resolve(context)
240 if isinstance(tag, (list, dict)):
241 tags_to_add += [t for t in tag]
243 tags_to_add.append(tag)
245 for tag_variable in self.tags_to_remove:
246 tag = tag_variable.resolve(context)
248 tags_to_remove += [t for t in tag]
250 tags_to_remove.append(tag)
252 tag_slugs = [tag.url_chunk for tag in tags_to_add]
253 for tag in tags_to_remove:
255 tag_slugs.remove(tag.url_chunk)
259 if len(tag_slugs) > 0:
260 if list_type == 'gallery':
261 return reverse('tagged_object_list_gallery', kwargs={'tags': '/'.join(tag_slugs)})
262 elif list_type == 'audiobooks':
263 return reverse('tagged_object_list_audiobooks', kwargs={'tags': '/'.join(tag_slugs)})
265 return reverse('tagged_object_list', kwargs={'tags': '/'.join(tag_slugs)})
267 if list_type == 'gallery':
268 return reverse('gallery')
269 elif list_type == 'audiobooks':
270 return reverse('audiobook_list')
272 return reverse('book_list')
275 # @register.inclusion_tag('catalogue/tag_list.html')
276 def tag_list(tags, choices=None, category=None, list_type='books'):
280 if category is None and tags:
281 category = tags[0].category
283 category_choices = [tag for tag in choices if tag.category == category]
285 if len(tags) == 1 and category not in [t.category for t in choices]:
290 if category is not None:
291 other = Tag.objects.filter(category=category).exclude(pk__in=[t.pk for t in tags])\
292 .exclude(pk__in=[t.pk for t in category_choices])
293 # Filter out empty tags.
294 ct = ContentType.objects.get_for_model(Picture if list_type == 'gallery' else Book)
295 other = other.filter(items__content_type=ct).distinct()
296 if list_type == 'audiobooks':
297 other = other.filter(id__in=get_audiobook_tags())
298 other = other.only('name', 'slug', 'category')
305 'category_choices': category_choices,
308 'list_type': list_type,
312 @register.inclusion_tag('catalogue/book_info.html')
315 'is_picture': isinstance(book, Picture),
320 @register.inclusion_tag('catalogue/plain_list.html', takes_context=True)
321 def plain_list(context, object_list, with_initials=True, by_author=False, choice=None, book=None, list_type='books',
322 paged=True, initial_blocks=False):
325 if len(object_list) < settings.CATALOGUE_MIN_INITIALS and not by_author:
326 with_initials = False
327 initial_blocks = False
328 for obj in object_list:
331 initial = obj.sort_key_author
333 initial = obj.get_initial().upper()
334 if initial != last_initial:
335 last_initial = initial
336 names.append((obj.author_unicode() if by_author else initial, []))
337 names[-1][1].append(obj)
338 if names[0] == ('', []):
343 'initial_blocks': initial_blocks,
345 'list_type': list_type,
350 # TODO: These are no longer just books.
351 @register.inclusion_tag('catalogue/related_books.html', takes_context=True)
352 def related_books(context, instance, limit=6, random=1, taken=0):
354 max_books = limit - random
355 is_picture = isinstance(instance, Picture)
357 pics_qs = Picture.objects.all()
359 pics_qs = pics_qs.exclude(pk=instance.pk)
360 pics = Picture.tagged.related_to(instance, pics_qs)
362 # Reserve one spot for an image.
365 books_qs = Book.objects.filter(findable=True)
367 books_qs = books_qs.exclude(common_slug=instance.common_slug).exclude(ancestor=instance)
368 books = Book.tagged.related_to(instance, books_qs)[:max_books]
370 pics = pics[:1 + max_books - books.count()]
372 random_excluded_books = [b.pk for b in books]
373 random_excluded_pics = [p.pk for p in pics]
374 (random_excluded_pics if is_picture else random_excluded_books).append(instance.pk)
377 'request': context['request'],
381 'random_excluded_books': random_excluded_books,
382 'random_excluded_pics': random_excluded_pics,
387 def related_books_2022(book=None, picture=None, limit=4, taken=0):
391 books_qs = Book.objects.filter(findable=True)
393 books_qs = books_qs.exclude(common_slug=book.common_slug).exclude(ancestor=book)
394 instance = book or picture
395 books = Book.tagged.related_to(instance, books_qs)[:max_books]
400 def related_pictures_2022(book=None, picture=None, limit=4, taken=0):
404 books_qs = Picture.objects.all()
405 instance = book or picture
406 books = Picture.tagged.related_to(instance, books_qs)[:max_books]
412 def download_audio(book, daisy=True, mp3=True):
414 if mp3 and book.has_media('mp3'):
415 links.append("<a href='%s'>%s</a>" % (
416 reverse('download_zip_mp3', args=[book.slug]), BookMedia.formats['mp3'].name))
417 if book.has_media('ogg'):
418 links.append("<a href='%s'>%s</a>" % (
419 reverse('download_zip_ogg', args=[book.slug]), BookMedia.formats['ogg'].name))
420 if daisy and book.has_media('daisy'):
421 for dsy in book.get_media('daisy'):
422 links.append("<a href='%s'>%s</a>" % (dsy.file.url, BookMedia.formats['daisy'].name))
423 if daisy and book.has_media('audio.epub'):
424 for dsy in book.get_media('audio.epub'):
425 links.append("<a href='%s'>%s</a>" % (dsy.file.url, BookMedia.formats['audio.epub'].name))
426 return mark_safe("".join(links))
429 @register.inclusion_tag("catalogue/snippets/custom_pdf_link_li.html")
430 def custom_pdf_link_li(book):
433 'NO_CUSTOM_PDF': settings.NO_CUSTOM_PDF,
437 @register.inclusion_tag("catalogue/snippets/license_icon.html")
438 def license_icon(license_url):
439 """Creates a license icon, if the license_url is known."""
440 known = LICENSES.get(license_url)
444 "license_url": license_url,
445 "icon": "img/licenses/%s.png" % known['icon'],
446 "license_description": known['description'],
451 def license_locative(license_url, default):
452 return LICENSES.get(license_url, {}).get('locative', default)
456 def source_name(url):
458 netloc = urlparse(url).netloc
460 netloc = urlparse('http://' + url).netloc
463 source, created = Source.objects.get_or_create(netloc=netloc)
464 return source.name or netloc
468 def catalogue_random_book(exclude_ids):
469 from .. import app_settings
470 if random() < app_settings.RELATED_RANDOM_PICTURE_CHANCE:
472 queryset = Book.objects.filter(findable=True).exclude(pk__in=exclude_ids)
473 count = queryset.count()
475 return queryset[randint(0, count - 1)]
481 def choose_fragment(book=None, tag_ids=None):
483 fragment = book.choose_fragment()
485 if tag_ids is not None:
486 tags = Tag.objects.filter(pk__in=tag_ids)
487 fragments = Fragment.tagged.with_all(tags).filter(book__findable=True).order_by().only('id')
489 fragments = Fragment.objects.filter(book__findable=True).order_by().only('id')
490 fragment_count = fragments.count()
491 fragment = fragments[randint(0, fragment_count - 1)] if fragment_count else None
496 def strip_tag(html, tag_name):
497 # docelowo może być warto zainstalować BeautifulSoup do takich rzeczy
499 return re.sub(r"<.?%s\b[^>]*>" % tag_name, "", html)
503 def status(book, user):
506 elif book.is_accessible_to(user):
512 @register.inclusion_tag('catalogue/snippets/content_warning.html')
513 def content_warning(book):
515 'wulgaryzmy': _('wulgaryzmy'),
517 warnings = book.get_extra_info_json().get('content_warnings', [])
519 warnings_def.get(w, w)
527 @register.inclusion_tag('catalogue/preview_ad.html', takes_context=True)
528 def preview_ad(context):
529 book = Book.objects.filter(parent=None, preview=True).first()
533 'accessible': book.is_accessible_to(context['request'].user),
537 @register.inclusion_tag('catalogue/preview_ad_homepage.html', takes_context=True)
538 def preview_ad_homepage(context):
539 book = Book.objects.filter(parent=None, preview=True).first()
543 'accessible': book.is_accessible_to(context['request'].user),