1 # -*- coding: utf-8 -*-
2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 from random import randint, random
6 from urlparse import urlparse
7 from django.contrib.contenttypes.models import ContentType
9 from django.conf import settings
10 from django import template
11 from django.template import Node, Variable, Template, Context
12 from django.core.urlresolvers import reverse
13 from django.utils.cache import add_never_cache_headers
14 from django.utils.translation import ugettext as _
16 from ssify import ssi_variable
18 from catalogue.helpers import get_audiobook_tags
19 from catalogue.models import Book, BookMedia, Fragment, Tag, Source
20 from catalogue.constants import LICENSES
21 from picture.models import Picture
23 register = template.Library()
36 return '%s%s' % (text[0].upper(), text[1:])
42 def html_title_from_tags(tags):
44 return title_from_tags(tags)
45 template = Template("{{ category }}: <a href='{{ tag.get_absolute_url }}'>{{ tag.name }}</a>")
46 return capfirst(",<br/>".join(
47 template.render(Context({'tag': tag, 'category': _(tag.category)})) for tag in tags))
50 def simple_title(tags):
53 title.append("%s: %s" % (_(tag.category), tag.name))
54 return capfirst(', '.join(title))
58 def book_title(book, html_links=False):
59 return book.pretty_title(html_links)
63 def book_title_html(book):
64 return book_title(book, html_links=True)
68 def title_from_tags(tags):
72 result[tag.category] = tag
75 # TODO: Remove this after adding flection mechanism
76 return simple_title(tags)
78 class Flection(object):
79 def get_case(self, name, flection):
83 self = split_tags(tags)
87 # Specjalny przypadek oglądania wszystkich lektur na danej półce
88 if len(self) == 1 and 'set' in self:
89 return u'Półka %s' % self['set']
91 # Specjalny przypadek "Twórczość w pozytywizmie", wtedy gdy tylko epoka
92 # jest wybrana przez użytkownika
93 if 'epoch' in self and len(self) == 1:
94 text = u'Twórczość w %s' % flection.get_case(unicode(self['epoch']), u'miejscownik')
97 # Specjalny przypadek "Dramat w twórczości Sofoklesa", wtedy gdy podane
98 # są tylko rodzaj literacki i autor
99 if 'kind' in self and 'author' in self and len(self) == 2:
100 text = u'%s w twórczości %s' % (
101 unicode(self['kind']), flection.get_case(unicode(self['author']), u'dopełniacz'))
102 return capfirst(text)
104 # Przypadki ogólniejsze
106 title += u'Motyw %s' % unicode(self['theme'])
110 title += u' w %s' % flection.get_case(unicode(self['genre']), u'miejscownik')
112 title += unicode(self['genre'])
114 if 'kind' in self or 'author' in self or 'epoch' in self:
115 if 'genre' in self or 'theme' in self:
117 title += u' w %s ' % flection.get_case(unicode(self['kind']), u'miejscownik')
119 title += u' w twórczości '
121 title += u'%s ' % unicode(self.get('kind', u'twórczość'))
124 title += flection.get_case(unicode(self['author']), u'dopełniacz')
125 elif 'epoch' in self:
126 title += flection.get_case(unicode(self['epoch']), u'dopełniacz')
128 return capfirst(title)
132 def book_tree(book_list, books_by_parent):
133 text = "".join("<li><a href='%s'>%s</a>%s</li>" % (
134 book.get_absolute_url(), book.title, book_tree(books_by_parent.get(book, ()), books_by_parent)
135 ) for book in book_list)
138 return "<ol>%s</ol>" % text
144 def audiobook_tree(book_list, books_by_parent):
145 text = "".join("<li><a class='open-player' href='%s'>%s</a>%s</li>" % (
146 reverse("book_player", args=[book.slug]), book.title,
147 audiobook_tree(books_by_parent.get(book, ()), books_by_parent)
148 ) for book in book_list)
151 return "<ol>%s</ol>" % text
157 def book_tree_texml(book_list, books_by_parent, depth=1):
159 <cmd name='hspace'><parm>%(depth)dem</parm></cmd>%(title)s
160 <spec cat='align' /><cmd name="note"><parm>%(audiences)s</parm></cmd>
161 <spec cat='align' /><cmd name="note"><parm>%(audiobook)s</parm></cmd>
167 "audiences": ", ".join(book.audiences_pl()),
168 "audiobook": "audiobook" if book.has_media('mp3') else "",
169 "children": book_tree_texml(books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
170 } for book in book_list)
174 def book_tree_csv(author, book_list, books_by_parent, depth=1, max_depth=3, delimeter="\t"):
175 def quote_if_necessary(s):
178 s.replace('"', '\\"')
183 return "".join("""%(author)s%(d)s%(preindent)s%(title)s%(d)s%(postindent)s%(audiences)s%(d)s%(audiobook)s
186 "preindent": delimeter * (depth - 1),
187 "postindent": delimeter * (max_depth - depth),
189 "author": quote_if_necessary(author.name),
190 "title": quote_if_necessary(book.title),
191 "audiences": ", ".join(book.audiences_pl()),
192 "audiobook": "audiobook" if book.has_media('mp3') else "",
193 "children": book_tree_csv(author, books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
194 } for book in book_list)
198 def all_editors(extra_info):
200 if 'editors' in extra_info:
201 editors += extra_info['editors']
202 if 'technical_editors' in extra_info:
203 editors += extra_info['technical_editors']
204 # support for extra_info-s from librarian<1.2
205 if 'editor' in extra_info:
206 editors.append(extra_info['editor'])
207 if 'technical_editor' in extra_info:
208 editors.append(extra_info['technical_editor'])
210 ' '.join(p.strip() for p in person.rsplit(',', 1)[::-1])
211 for person in sorted(set(editors)))
215 def catalogue_url(parser, token):
216 bits = token.split_contents()
222 tags_to_remove.append(bit[1:])
224 tags_to_add.append(bit)
226 return CatalogueURLNode(bits[1], tags_to_add, tags_to_remove)
229 class CatalogueURLNode(Node):
230 def __init__(self, list_type, tags_to_add, tags_to_remove):
231 self.tags_to_add = [Variable(tag) for tag in tags_to_add]
232 self.tags_to_remove = [Variable(tag) for tag in tags_to_remove]
233 self.list_type_var = Variable(list_type)
235 def render(self, context):
236 list_type = self.list_type_var.resolve(context)
240 for tag_variable in self.tags_to_add:
241 tag = tag_variable.resolve(context)
242 if isinstance(tag, (list, dict)):
243 tags_to_add += [t for t in tag]
245 tags_to_add.append(tag)
247 for tag_variable in self.tags_to_remove:
248 tag = tag_variable.resolve(context)
250 tags_to_remove += [t for t in tag]
252 tags_to_remove.append(tag)
254 tag_slugs = [tag.url_chunk for tag in tags_to_add]
255 for tag in tags_to_remove:
257 tag_slugs.remove(tag.url_chunk)
261 if len(tag_slugs) > 0:
262 if list_type == 'gallery':
263 return reverse('tagged_object_list_gallery', kwargs={'tags': '/'.join(tag_slugs)})
264 elif list_type == 'audiobooks':
265 return reverse('tagged_object_list_audiobooks', kwargs={'tags': '/'.join(tag_slugs)})
267 return reverse('tagged_object_list', kwargs={'tags': '/'.join(tag_slugs)})
269 if list_type == 'gallery':
270 return reverse('gallery')
271 elif list_type == 'audiobooks':
272 return reverse('audiobook_list')
274 return reverse('book_list')
277 # @register.inclusion_tag('catalogue/tag_list.html')
278 def tag_list(tags, choices=None, category=None, list_type='books'):
279 # print(tags, choices, category)
283 if category is None and tags:
284 category = tags[0].category
286 category_choices = [tag for tag in choices if tag.category == category]
288 if len(tags) == 1 and category not in [t.category for t in choices]:
293 if category is not None:
294 other = Tag.objects.filter(category=category).exclude(pk__in=[t.pk for t in tags])\
295 .exclude(pk__in=[t.pk for t in category_choices])
296 # Filter out empty tags.
297 ct = ContentType.objects.get_for_model(Picture if list_type == 'gallery' else Book)
298 other = other.filter(items__content_type=ct).distinct()
299 if list_type == 'audiobooks':
300 other = other.filter(id__in=get_audiobook_tags())
301 other = other.only('name', 'slug', 'category')
308 'category_choices': category_choices,
311 'list_type': list_type,
315 @register.inclusion_tag('catalogue/inline_tag_list.html')
316 def inline_tag_list(tags, choices=None, category=None, list_type='books'):
317 return tag_list(tags, choices, category, list_type)
320 @register.inclusion_tag('catalogue/collection_list.html')
321 def collection_list(collections):
322 return {'collections': collections}
325 @register.inclusion_tag('catalogue/book_info.html')
328 'is_picture': isinstance(book, Picture),
333 @register.inclusion_tag('catalogue/work-list.html', takes_context=True)
334 def work_list(context, object_list):
335 request = context.get('request')
336 return {'object_list': object_list, 'request': request}
339 @register.inclusion_tag('catalogue/plain_list.html', takes_context=True)
340 def plain_list(context, object_list, with_initials=True, by_author=False, choice=None, book=None, list_type='books',
341 paged=True, initial_blocks=False):
344 if len(object_list) < settings.CATALOGUE_MIN_INITIALS and not by_author:
345 with_initials = False
346 initial_blocks = False
347 for obj in object_list:
350 initial = obj.sort_key_author
352 initial = obj.get_initial().upper()
353 if initial != last_initial:
354 last_initial = initial
355 names.append((obj.author_unicode() if by_author else initial, []))
356 names[-1][1].append(obj)
357 if names[0] == ('', []):
362 'initial_blocks': initial_blocks,
364 'list_type': list_type,
369 # TODO: These are no longer just books.
370 @register.inclusion_tag('catalogue/related_books.html', takes_context=True)
371 def related_books(context, instance, limit=6, random=1, taken=0):
373 max_books = limit - random
374 is_picture = isinstance(instance, Picture)
376 pics_qs = Picture.objects.all()
378 pics_qs = pics_qs.exclude(pk=instance.pk)
379 pics = Picture.tagged.related_to(instance, pics_qs)
381 # Reserve one spot for an image.
384 books_qs = Book.objects.all()
386 books_qs = books_qs.exclude(common_slug=instance.common_slug).exclude(ancestor=instance)
387 books = Book.tagged.related_to(instance, books_qs)[:max_books]
389 pics = pics[:1 + max_books - books.count()]
391 random_excluded_books = [b.pk for b in books]
392 random_excluded_pics = [p.pk for p in pics]
393 (random_excluded_pics if is_picture else random_excluded_books).append(instance.pk)
396 'request': context['request'],
400 'random_excluded_books': random_excluded_books,
401 'random_excluded_pics': random_excluded_pics,
406 def download_audio(book, daisy=True, mp3=True):
408 if mp3 and book.has_media('mp3'):
409 links.append("<a href='%s'>%s</a>" % (
410 reverse('download_zip_mp3', args=[book.slug]), BookMedia.formats['mp3'].name))
411 if book.has_media('ogg'):
412 links.append("<a href='%s'>%s</a>" % (
413 reverse('download_zip_ogg', args=[book.slug]), BookMedia.formats['ogg'].name))
414 if daisy and book.has_media('daisy'):
415 for dsy in book.get_media('daisy'):
416 links.append("<a href='%s'>%s</a>" % (dsy.file.url, BookMedia.formats['daisy'].name))
417 return "".join(links)
420 @register.inclusion_tag("catalogue/snippets/custom_pdf_link_li.html")
421 def custom_pdf_link_li(book):
424 'NO_CUSTOM_PDF': settings.NO_CUSTOM_PDF,
428 @register.inclusion_tag("catalogue/snippets/license_icon.html")
429 def license_icon(license_url):
430 """Creates a license icon, if the license_url is known."""
431 known = LICENSES.get(license_url)
435 "license_url": license_url,
436 "icon": "img/licenses/%s.png" % known['icon'],
437 "license_description": known['description'],
443 return obj.__class__.__name__
447 def source_name(url):
449 netloc = urlparse(url).netloc
451 netloc = urlparse('http://' + url).netloc
454 source, created = Source.objects.get_or_create(netloc=netloc)
455 return source.name or netloc
458 @ssi_variable(register, patch_response=[add_never_cache_headers])
459 def catalogue_random_book(request, exclude_ids):
460 from .. import app_settings
461 if random() < app_settings.RELATED_RANDOM_PICTURE_CHANCE:
463 queryset = Book.objects.exclude(pk__in=exclude_ids)
464 count = queryset.count()
466 return queryset[randint(0, count - 1)].pk
471 @ssi_variable(register, patch_response=[add_never_cache_headers])
472 def choose_fragment(request, book_id=None, tag_ids=None, unless=False):
476 if book_id is not None:
477 fragment = Book.objects.get(pk=book_id).choose_fragment()
479 if tag_ids is not None:
480 tags = Tag.objects.filter(pk__in=tag_ids)
481 fragments = Fragment.tagged.with_all(tags).order_by().only('id')
483 fragments = Fragment.objects.all().order_by().only('id')
484 fragment_count = fragments.count()
485 fragment = fragments[randint(0, fragment_count - 1)] if fragment_count else None
486 return fragment.pk if fragment is not None else None
490 def strip_tag(html, tag_name):
491 # docelowo może być warto zainstalować BeautifulSoup do takich rzeczy
493 return re.sub(r"<.?%s\b[^>]*>" % tag_name, "", html)