apps/catalogue/templatetags/catalogue_tags.py

   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.
   4 #
   5 import datetime
   6 import feedparser
   7
   8 from django import template
   9 from django.template import Node, Variable, Template, Context
  10 from django.core.cache import cache
  11 from django.core.urlresolvers import reverse
  12 from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
  13 from django.utils.translation import ugettext as _
  14
  15 from catalogue import forms
  16 from catalogue.utils import split_tags
  17 from catalogue.models import Book, Fragment, Tag
  18
  19 register = template.Library()
  20
  21
  22 class RegistrationForm(UserCreationForm):
  23     def as_ul(self):
  24         "Returns this form rendered as HTML <li>s -- excluding the <ul></ul>."
  25         return self._html_output(u'<li>%(errors)s%(label)s %(field)s<span class="help-text">%(help_text)s</span></li>', u'<li>%s</li>', '</li>', u' %s', False)
  26
  27
  28 class LoginForm(AuthenticationForm):
  29     def as_ul(self):
  30         "Returns this form rendered as HTML <li>s -- excluding the <ul></ul>."
  31         return self._html_output(u'<li>%(errors)s%(label)s %(field)s<span class="help-text">%(help_text)s</span></li>', u'<li>%s</li>', '</li>', u' %s', False)
  32
  33
  34 def iterable(obj):
  35     try:
  36         iter(obj)
  37         return True
  38     except TypeError:
  39         return False
  40
  41
  42 def capfirst(text):
  43     try:
  44         return '%s%s' % (text[0].upper(), text[1:])
  45     except IndexError:
  46         return ''
  47
  48
  49 @register.simple_tag
  50 def html_title_from_tags(tags):
  51     if len(tags) < 2:
  52         return title_from_tags(tags)
  53     template = Template("{{ category }}: <a href='{{ tag.get_absolute_url }}'>{{ tag.name }}</a>")
  54     return capfirst(",<br/>".join(
  55         template.render(Context({'tag': tag, 'category': _(tag.category)})) for tag in tags))
  56
  57
  58
  59 def simple_title(tags):
  60     title = []
  61     for tag in tags:
  62         title.append("%s: %s" % (_(tag.category), tag.name))
  63     return capfirst(', '.join(title))
  64
  65
  66 @register.simple_tag
  67 def book_title(book, html_links=False):
  68     return book.pretty_title(html_links)
  69
  70
  71 @register.simple_tag
  72 def book_title_html(book):
  73     return book_title(book, html_links=True)
  74
  75
  76 @register.simple_tag
  77 def title_from_tags(tags):
  78     def split_tags(tags):
  79         result = {}
  80         for tag in tags:
  81             result[tag.category] = tag
  82         return result
  83
  84     # TODO: Remove this after adding flection mechanism
  85     return simple_title(tags)
  86
  87     class Flection(object):
  88         def get_case(self, name, flection):
  89             return name
  90     flection = Flection()
  91
  92     self = split_tags(tags)
  93
  94     title = u''
  95
  96     # Specjalny przypadek oglądania wszystkich lektur na danej półce
  97     if len(self) == 1 and 'set' in self:
  98         return u'Półka %s' % self['set']
  99
 100     # Specjalny przypadek "Twórczość w pozytywizmie", wtedy gdy tylko epoka
 101     # jest wybrana przez użytkownika
 102     if 'epoch' in self and len(self) == 1:
 103         text = u'Twórczość w %s' % flection.get_case(unicode(self['epoch']), u'miejscownik')
 104         return capfirst(text)
 105
 106     # Specjalny przypadek "Dramat w twórczości Sofoklesa", wtedy gdy podane
 107     # są tylko rodzaj literacki i autor
 108     if 'kind' in self and 'author' in self and len(self) == 2:
 109         text = u'%s w twórczości %s' % (unicode(self['kind']),
 110             flection.get_case(unicode(self['author']), u'dopełniacz'))
 111         return capfirst(text)
 112
 113     # Przypadki ogólniejsze
 114     if 'theme' in self:
 115         title += u'Motyw %s' % unicode(self['theme'])
 116
 117     if 'genre' in self:
 118         if 'theme' in self:
 119             title += u' w %s' % flection.get_case(unicode(self['genre']), u'miejscownik')
 120         else:
 121             title += unicode(self['genre'])
 122
 123     if 'kind' in self or 'author' in self or 'epoch' in self:
 124         if 'genre' in self or 'theme' in self:
 125             if 'kind' in self:
 126                 title += u' w %s ' % flection.get_case(unicode(self['kind']), u'miejscownik')
 127             else:
 128                 title += u' w twórczości '
 129         else:
 130             title += u'%s ' % unicode(self.get('kind', u'twórczość'))
 131
 132     if 'author' in self:
 133         title += flection.get_case(unicode(self['author']), u'dopełniacz')
 134     elif 'epoch' in self:
 135         title += flection.get_case(unicode(self['epoch']), u'dopełniacz')
 136
 137     return capfirst(title)
 138
 139
 140 @register.simple_tag
 141 def book_tree(book_list, books_by_parent):
 142     text = "".join("<li><a href='%s'>%s</a>%s</li>" % (
 143         book.get_absolute_url(), book.title, book_tree(books_by_parent.get(book, ()), books_by_parent)
 144         ) for book in book_list)
 145
 146     if text:
 147         return "<ol>%s</ol>" % text
 148     else:
 149         return ''
 150
 151 @register.simple_tag
 152 def audiobook_tree(book_list, books_by_parent):
 153     text = "".join("<li><a class='open-player' href='%s'>%s</a>%s</li>" % (
 154         reverse("book_player", args=[book.slug]), book.title, audiobook_tree(books_by_parent.get(book, ()), books_by_parent)
 155         ) for book in book_list)
 156
 157     if text:
 158         return "<ol>%s</ol>" % text
 159     else:
 160         return ''
 161
 162 @register.simple_tag
 163 def book_tree_texml(book_list, books_by_parent, depth=1):
 164     return "".join("""
 165             <cmd name='hspace'><parm>%(depth)dem</parm></cmd>%(title)s
 166             <spec cat='align' /><cmd name="note"><parm>%(audiences)s</parm></cmd>
 167             <spec cat='align' /><cmd name="note"><parm>%(audiobook)s</parm></cmd>
 168             <ctrl ch='\\' />
 169             %(children)s
 170             """ % {
 171                 "depth": depth,
 172                 "title": book.title,
 173                 "audiences": ", ".join(book.audiences_pl()),
 174                 "audiobook": "audiobook" if book.has_media('mp3') else "",
 175                 "children": book_tree_texml(books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
 176             } for book in book_list)
 177
 178
 179 @register.simple_tag
 180 def all_editors(extra_info):
 181     editors = []
 182     if 'editors' in extra_info:
 183         editors += extra_info['editors']
 184     if 'technical_editors' in extra_info:
 185         editors += extra_info['technical_editors']
 186     # support for extra_info-s from librarian<1.2
 187     if 'editor' in extra_info:
 188         editors.append(extra_info['editor'])
 189     if 'technical_editor' in extra_info:
 190         editors.append(extra_info['technical_editor'])
 191     return ', '.join(
 192                      ' '.join(p.strip() for p in person.rsplit(',', 1)[::-1])
 193                      for person in sorted(set(editors)))
 194
 195
 196 @register.simple_tag
 197 def user_creation_form():
 198     return RegistrationForm(prefix='registration').as_ul()
 199
 200
 201 @register.simple_tag
 202 def authentication_form():
 203     return LoginForm(prefix='login').as_ul()
 204
 205
 206 @register.tag
 207 def catalogue_url(parser, token):
 208     bits = token.split_contents()
 209     tag_name = bits[0]
 210
 211     tags_to_add = []
 212     tags_to_remove = []
 213     for bit in bits[1:]:
 214         if bit[0] == '-':
 215             tags_to_remove.append(bit[1:])
 216         else:
 217             tags_to_add.append(bit)
 218
 219     return CatalogueURLNode(tags_to_add, tags_to_remove)
 220
 221
 222 class CatalogueURLNode(Node):
 223     def __init__(self, tags_to_add, tags_to_remove):
 224         self.tags_to_add = [Variable(tag) for tag in tags_to_add]
 225         self.tags_to_remove = [Variable(tag) for tag in tags_to_remove]
 226
 227     def render(self, context):
 228         tags_to_add = []
 229         tags_to_remove = []
 230
 231         for tag_variable in self.tags_to_add:
 232             tag = tag_variable.resolve(context)
 233             if isinstance(tag, (list, dict)):
 234                 tags_to_add += [t for t in tag]
 235             else:
 236                 tags_to_add.append(tag)
 237
 238         for tag_variable in self.tags_to_remove:
 239             tag = tag_variable.resolve(context)
 240             if iterable(tag):
 241                 tags_to_remove += [t for t in tag]
 242             else:
 243                 tags_to_remove.append(tag)
 244
 245         tag_slugs = [tag.url_chunk for tag in tags_to_add]
 246         for tag in tags_to_remove:
 247             try:
 248                 tag_slugs.remove(tag.url_chunk)
 249             except KeyError:
 250                 pass
 251
 252         if len(tag_slugs) > 0:
 253             return reverse('tagged_object_list', kwargs={'tags': '/'.join(tag_slugs)})
 254         else:
 255             return reverse('main_page')
 256
 257
 258 @register.inclusion_tag('catalogue/latest_blog_posts.html')
 259 def latest_blog_posts(feed_url, posts_to_show=5):
 260     try:
 261         feed = feedparser.parse(str(feed_url))
 262         posts = []
 263         for i in range(posts_to_show):
 264             pub_date = feed['entries'][i].updated_parsed
 265             published = datetime.date(pub_date[0], pub_date[1], pub_date[2] )
 266             posts.append({
 267                 'title': feed['entries'][i].title,
 268                 'summary': feed['entries'][i].summary,
 269                 'link': feed['entries'][i].link,
 270                 'date': published,
 271                 })
 272         return {'posts': posts}
 273     except:
 274         return {'posts': []}
 275
 276
 277 @register.inclusion_tag('catalogue/tag_list.html')
 278 def tag_list(tags, choices=None):
 279     if choices is None:
 280         choices = []
 281     if len(tags) == 1 and tags[0].category not in [t.category for t in choices]:
 282         one_tag = tags[0]
 283     return locals()
 284
 285
 286 @register.inclusion_tag('catalogue/inline_tag_list.html')
 287 def inline_tag_list(tags, choices=None):
 288     return tag_list(tags, choices)
 289
 290
 291 @register.inclusion_tag('catalogue/book_info.html')
 292 def book_info(book):
 293     return locals()
 294
 295
 296 @register.inclusion_tag('catalogue/book_wide.html', takes_context=True)
 297 def book_wide(context, book):
 298     book_themes = book.related_themes()
 299     extra_info = book.get_extra_info_value()
 300     hide_about = extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl')
 301
 302     return {
 303         'book': book,
 304         'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
 305         'related': book.related_info(),
 306         'extra_info': book.get_extra_info_value(),
 307         'hide_about': hide_about,
 308         'themes': book_themes,
 309         'request': context.get('request'),
 310     }
 311
 312
 313 @register.inclusion_tag('catalogue/book_short.html', takes_context=True)
 314 def book_short(context, book):
 315     return {
 316         'book': book,
 317         'main_link': book.get_absolute_url(),
 318         'related': book.related_info(),
 319         'request': context.get('request'),
 320     }
 321
 322
 323 @register.inclusion_tag('catalogue/book_mini_box.html')
 324 def book_mini(book):
 325     return {
 326         'book': book,
 327         'related': book.related_info(),
 328     }
 329
 330
 331 @register.inclusion_tag('catalogue/work-list.html', takes_context=True)
 332 def work_list(context, object_list):
 333     request = context.get('request')
 334     if object_list:
 335         object_type = type(object_list[0]).__name__
 336     return locals()
 337
 338
 339 @register.inclusion_tag('catalogue/fragment_promo.html')
 340 def fragment_promo(arg=None):
 341     if arg is None:
 342         fragments = Fragment.objects.all().order_by('?')
 343         fragment = fragments[0] if fragments.exists() else None
 344     elif isinstance(arg, Book):
 345         fragment = arg.choose_fragment()
 346     else:
 347         fragments = Fragment.tagged.with_all(arg).order_by('?')
 348         fragment = fragments[0] if fragments.exists() else None
 349
 350     return {
 351         'fragment': fragment,
 352     }
 353
 354
 355 @register.inclusion_tag('catalogue/related_books.html')
 356 def related_books(book, limit=6, random=1):
 357     cache_key = "catalogue.related_books.%d.%d" % (book.id, limit - random)
 358     related = cache.get(cache_key)
 359     if related is None:
 360         related = list(Book.objects.filter(
 361             common_slug=book.common_slug).exclude(pk=book.pk)[:limit])
 362         limit -= len(related)
 363         if limit > random:
 364             related += Book.tagged.related_to(book,
 365                     Book.objects.exclude(common_slug=book.common_slug),
 366                     ignore_by_tag=book.book_tag())[:limit-random]
 367         cache.set(cache_key, related, 1800)
 368     if random:
 369         related += list(Book.objects.exclude(
 370                         pk__in=[b.pk for b in related] + [book.pk]
 371                     ).order_by('?')[:random])
 372     return {
 373         'books': related,
 374     }
 375
 376
 377 @register.inclusion_tag('catalogue/menu.html')
 378 def catalogue_menu():
 379     tags = Tag.objects.filter(
 380             category__in=('author', 'epoch', 'genre', 'kind', 'theme')
 381         ).exclude(book_count=0)
 382     return split_tags(tags)
 383
 384
 385
 386 @register.simple_tag
 387 def tag_url(category, slug):
 388     return reverse('catalogue.views.tagged_object_list', args=[
 389         '/'.join((Tag.categories_dict[category], slug))
 390     ])