Using cache middleware instead of various caching micro-strategies,
[wolnelektury.git] / apps / catalogue / templatetags / catalogue_tags.py
index c1d318a..54fcf5a 100644 (file)
@@ -2,17 +2,20 @@
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
-import feedparser
-import datetime
+from random import randint
+from urlparse import urlparse
 
+from django.conf import settings
 from django import template
-from django.template import Node, Variable
-from django.utils.encoding import smart_str
+from django.template import Node, Variable, Template, Context
 from django.core.urlresolvers import reverse
 from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
-from django.db.models import Q
-from django.conf import settings
+from django.utils.cache import add_never_cache_headers
+from django.utils.translation import ugettext as _
 
+from ssify import ssi_variable
+from catalogue.models import Book, BookMedia, Fragment, Tag, Source
+from catalogue.constants import LICENSES
 
 register = template.Library()
 
@@ -44,46 +47,25 @@ def capfirst(text):
         return ''
 
 
+@register.simple_tag
+def html_title_from_tags(tags):
+    if len(tags) < 2:
+        return title_from_tags(tags)
+    template = Template("{{ category }}: <a href='{{ tag.get_absolute_url }}'>{{ tag.name }}</a>")
+    return capfirst(",<br/>".join(
+        template.render(Context({'tag': tag, 'category': _(tag.category)})) for tag in tags))
 
-def simple_title(tags):
-    mapping = {
-        'author': u'Autor',
-        'theme': u'motyw',
-        'epoch': u'epoka',
-        'genre': u'gatunek',
-        'kind': u'rodzaj',
-        'set': u'półka',
-    }
 
+def simple_title(tags):
     title = []
     for tag in tags:
-        title.append("%s: %s" % (mapping[tag.category], tag.name))
+        title.append("%s: %s" % (_(tag.category), tag.name))
     return capfirst(', '.join(title))
 
 
-def book_stub_title(book):
-    return ', '.join((book.author, book.title))
-
-
 @register.simple_tag
 def book_title(book, html_links=False):
-    try:
-        names = list(book.tags.filter(category='author'))
-    except AttributeError:
-        return book_stub_title(book)
-
-    books = []
-    while book:
-        books.append(book)
-        book = book.parent
-    names.extend(reversed(books))
-
-    if html_links:
-        names = ['<a href="%s">%s</a>' % (tag.get_absolute_url(), tag.name) for tag in names]
-    else:
-        names = [tag.name for tag in names]
-
-    return ', '.join(names)
+    return book.pretty_title(html_links)
 
 
 @register.simple_tag
@@ -166,6 +148,73 @@ def book_tree(book_list, books_by_parent):
     else:
         return ''
 
+@register.simple_tag
+def audiobook_tree(book_list, books_by_parent):
+    text = "".join("<li><a class='open-player' href='%s'>%s</a>%s</li>" % (
+        reverse("book_player", args=[book.slug]), book.title, audiobook_tree(books_by_parent.get(book, ()), books_by_parent)
+        ) for book in book_list)
+
+    if text:
+        return "<ol>%s</ol>" % text
+    else:
+        return ''
+
+@register.simple_tag
+def book_tree_texml(book_list, books_by_parent, depth=1):
+    return "".join("""
+            <cmd name='hspace'><parm>%(depth)dem</parm></cmd>%(title)s
+            <spec cat='align' /><cmd name="note"><parm>%(audiences)s</parm></cmd>
+            <spec cat='align' /><cmd name="note"><parm>%(audiobook)s</parm></cmd>
+            <ctrl ch='\\' />
+            %(children)s
+            """ % {
+                "depth": depth,
+                "title": book.title,
+                "audiences": ", ".join(book.audiences_pl()),
+                "audiobook": "audiobook" if book.has_media('mp3') else "",
+                "children": book_tree_texml(books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
+            } for book in book_list)
+
+
+@register.simple_tag
+def book_tree_csv(author, book_list, books_by_parent, depth=1, max_depth=3, delimeter="\t"):
+    def quote_if_necessary(s):
+        try:
+            s.index(delimeter)
+            s.replace('"', '\\"')
+            return '"%s"' % s
+        except ValueError:
+            return s
+
+    return "".join("""%(author)s%(d)s%(preindent)s%(title)s%(d)s%(postindent)s%(audiences)s%(d)s%(audiobook)s
+%(children)s""" % {
+                "d": delimeter,
+                "preindent": delimeter * (depth - 1),
+                "postindent": delimeter * (max_depth - depth),
+                "depth": depth,
+                "author": quote_if_necessary(author.name),
+                "title": quote_if_necessary(book.title),
+                "audiences": ", ".join(book.audiences_pl()),
+                "audiobook": "audiobook" if book.has_media('mp3') else "",
+                "children": book_tree_csv(author, books_by_parent.get(book.id, ()), books_by_parent, depth + 1)
+            } for book in book_list)
+
+@register.simple_tag
+def all_editors(extra_info):
+    editors = []
+    if 'editors' in extra_info:
+        editors += extra_info['editors']
+    if 'technical_editors' in extra_info:
+        editors += extra_info['technical_editors']
+    # support for extra_info-s from librarian<1.2
+    if 'editor' in extra_info:
+        editors.append(extra_info['editor'])
+    if 'technical_editor' in extra_info:
+        editors.append(extra_info['technical_editor'])
+    return ', '.join(
+                     ' '.join(p.strip() for p in person.rsplit(',', 1)[::-1])
+                     for person in sorted(set(editors)))
+
 
 @register.simple_tag
 def user_creation_form():
@@ -177,23 +226,9 @@ def authentication_form():
     return LoginForm(prefix='login').as_ul()
 
 
-@register.inclusion_tag('catalogue/breadcrumbs.html')
-def breadcrumbs(tags, search_form=True):
-    from catalogue.forms import SearchForm
-    context = {'tag_list': tags}
-    try:
-        max_tag_list = settings.MAX_TAG_LIST
-    except AttributeError:
-        max_tag_list = -1
-    if search_form and (max_tag_list == -1 or len(tags) < max_tag_list):
-        context['search_form'] = SearchForm(tags=tags)
-    return context
-
-
 @register.tag
 def catalogue_url(parser, token):
     bits = token.split_contents()
-    tag_name = bits[0]
 
     tags_to_add = []
     tags_to_remove = []
@@ -242,47 +277,141 @@ class CatalogueURLNode(Node):
             return reverse('main_page')
 
 
-@register.inclusion_tag('catalogue/latest_blog_posts.html')
-def latest_blog_posts(feed_url, posts_to_show=5):
-    try:
-        feed = feedparser.parse(str(feed_url))
-        posts = []
-        for i in range(posts_to_show):
-            pub_date = feed['entries'][i].updated_parsed
-            published = datetime.date(pub_date[0], pub_date[1], pub_date[2] )
-            posts.append({
-                'title': feed['entries'][i].title,
-                'summary': feed['entries'][i].summary,
-                'link': feed['entries'][i].link,
-                'date': published,
-                })
-        return {'posts': posts}
-    except:
-        return {'posts': []}
-
-
 @register.inclusion_tag('catalogue/tag_list.html')
 def tag_list(tags, choices=None):
     if choices is None:
         choices = []
-    if len(tags) == 1:
+    if len(tags) == 1 and tags[0].category not in [t.category for t in choices]:
         one_tag = tags[0]
     return locals()
 
 
-@register.inclusion_tag('catalogue/folded_tag_list.html')
-def folded_tag_list(tags, choices=None):
-    tags = [tag for tag in tags if tag.count]
-    if choices is None:
-        choices = []
-    some_tags_hidden = False
-    tag_count = len(tags)
+@register.inclusion_tag('catalogue/inline_tag_list.html')
+def inline_tag_list(tags, choices=None):
+    return tag_list(tags, choices)
 
-    if tag_count == 1:
-        one_tag = tags[0]
-    else:
-        shown_tags = [tag for tag in tags if tag.main_page]
-        if tag_count > len(shown_tags):
-            some_tags_hidden = True
+
+@register.inclusion_tag('catalogue/collection_list.html')
+def collection_list(collections):
+    return locals()
+
+
+@register.inclusion_tag('catalogue/book_info.html')
+def book_info(book):
+    return locals()
+
+
+@register.inclusion_tag('catalogue/work-list.html', takes_context=True)
+def work_list(context, object_list):
+    request = context.get('request')
     return locals()
 
+
+@register.inclusion_tag('catalogue/related_books.html', takes_context=True)
+def related_books(context, book, limit=6, random=1, taken=0):
+    limit = limit - taken
+    related = Book.tagged.related_to(book,
+            Book.objects.exclude(common_slug=book.common_slug)
+            ).exclude(ancestor=book)[:limit-random]
+    random_excluded = [b.pk for b in related] + [book.pk]
+    return {
+        'request': context['request'],
+        'books': related,
+        'random': random,
+        'random_excluded': random_excluded,
+    }
+
+
+@register.inclusion_tag('catalogue/menu.html')
+def catalogue_menu():
+    return {'categories': [
+                ('author', _('Authors'), 'autorzy'),
+                ('genre', _('Genres'), 'gatunki'),
+                ('kind', _('Kinds'), 'rodzaje'),
+                ('epoch', _('Epochs'), 'epoki'),
+                ('theme', _('Themes'), 'motywy'),
+        ]}
+
+
+@register.simple_tag
+def download_audio(book, daisy=True):
+    links = []
+    if book.has_media('mp3'):
+        links.append("<a href='%s'>%s</a>" %
+            (reverse('download_zip_mp3', args=[book.slug]),
+                BookMedia.formats['mp3'].name))
+    if book.has_media('ogg'):
+        links.append("<a href='%s'>%s</a>" %
+            (reverse('download_zip_ogg', args=[book.slug]),
+                BookMedia.formats['ogg'].name))
+    if daisy and book.has_media('daisy'):
+        for dsy in book.get_media('daisy'):
+            links.append("<a href='%s'>%s</a>" %
+                (dsy.file.url, BookMedia.formats['daisy'].name))
+    return ", ".join(links)
+
+
+@register.inclusion_tag("catalogue/snippets/custom_pdf_link_li.html")
+def custom_pdf_link_li(book):
+    return {
+        'book': book,
+        'NO_CUSTOM_PDF': settings.NO_CUSTOM_PDF,
+    }
+
+
+@register.inclusion_tag("catalogue/snippets/license_icon.html")
+def license_icon(license_url):
+    """Creates a license icon, if the license_url is known."""
+    known = LICENSES.get(license_url)
+    if known is None:
+        return {}
+    return {
+        "license_url": license_url,
+        "icon": "img/licenses/%s.png" % known['icon'],
+        "license_description": known['description'],
+    }
+
+
+@register.filter
+def class_name(obj):
+    return obj.__class__.__name__
+
+
+@register.simple_tag
+def source_name(url):
+    url = url.lstrip()
+    netloc = urlparse(url).netloc
+    if not netloc:
+        netloc = urlparse('http://' + url).netloc
+    if not netloc:
+        return ''
+    source, created = Source.objects.get_or_create(netloc=netloc)
+    return source.name or netloc
+
+
+@ssi_variable(register, patch_response=[add_never_cache_headers])
+def catalogue_random_book(request, exclude_ids):
+    queryset = Book.objects.exclude(pk__in=exclude_ids)
+    count = queryset.count()
+    if count:
+        return queryset[randint(0, count - 1)].pk
+    else:
+        return None
+
+
+@ssi_variable(register, patch_response=[add_never_cache_headers])
+def choose_fragment(request, book_id=None, tag_ids=None, unless=False):
+    if unless:
+        return None
+
+    if book_id is not None:
+        fragment = Book.objects.get(pk=book_id).choose_fragment()
+    else:
+        if tag_ids is not None:
+            tags = Tag.objects.filter(pk__in=tag_ids)
+            fragments = Fragment.tagged.with_all(tags).order_by().only('id')
+        else:
+            fragments = Fragment.objects.all().order_by().only('id')
+        fragment_count = fragments.count()
+        fragment = fragments[randint(0, fragment_count - 1)] if fragment_count else None
+    return fragment.pk if fragment is not None else None