Django 1.7, working version.
[wolnelektury.git] / apps / catalogue / views.py
index b874c4c..0026b0a 100644 (file)
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
+from collections import OrderedDict
 import re
 import itertools
-from datetime import datetime
 
 from django.conf import settings
+from django.core.cache import get_cache
 from django.template import RequestContext
+from django.template.loader import render_to_string
 from django.shortcuts import render_to_response, get_object_or_404
-from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
+from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect, JsonResponse
 from django.core.urlresolvers import reverse
-from django.db.models import Count, Sum, Q
+from django.db.models import Q
 from django.contrib.auth.decorators import login_required, user_passes_test
-from django.utils.datastructures import SortedDict
-from django.views.decorators.http import require_POST
-from django.contrib import auth
-from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
 from django.utils.http import urlquote_plus
-from django.views.decorators import cache
 from django.utils import translation
-from django.utils.translation import ugettext as _
-from django.views.generic.list_detail import object_list
-
-from ajaxable.utils import LazyEncoder, JSONResponse, AjaxableFormView
+from django.utils.translation import get_language, ugettext as _, ugettext_lazy
+from django.views.decorators.vary import vary_on_headers
 
+from ajaxable.utils import AjaxableFormView
 from catalogue import models
 from catalogue import forms
-from catalogue.utils import (split_tags, AttachmentHttpResponse,
-    async_build_pdf, MultiQuerySet)
-from catalogue.tasks import touch_tag
+from catalogue.utils import split_tags, MultiQuerySet, SortedMultiQuerySet
+from catalogue.templatetags.catalogue_tags import tag_list, collection_list
 from pdcounter import models as pdcounter_models
 from pdcounter import views as pdcounter_views
 from suggest.forms import PublishingSuggestForm
-from picture.models import Picture
-
-from os import path
+from picture.models import Picture, PictureArea
+from picture.views import picture_list_thumb
 
 staff_required = user_passes_test(lambda user: user.is_staff)
+permanent_cache = get_cache('permanent')
 
 
+@vary_on_headers('X-Requested-With')
 def catalogue(request):
-    tags = models.Tag.objects.exclude(
-        category__in=('set', 'book')).exclude(book_count=0)
-    tags = list(tags)
-    for tag in tags:
-        tag.count = tag.book_count
-    categories = split_tags(tags)
-    fragment_tags = categories.get('theme', [])
-
-    return render_to_response('catalogue/catalogue.html', locals(),
-        context_instance=RequestContext(request))
-
+    cache_key = 'catalogue.catalogue/' + get_language()
+    output = permanent_cache.get(cache_key)
+
+    if output is None:
+        tags = models.Tag.objects.exclude(
+            category__in=('set', 'book')).exclude(book_count=0, picture_count=0)
+        tags = list(tags)
+        for tag in tags:
+            tag.count = tag.book_count + tag.picture_count
+        categories = split_tags(tags)
+        fragment_tags = categories.get('theme', [])
+        collections = models.Collection.objects.all()
+
+        render_tag_list = lambda x: render_to_string(
+            'catalogue/tag_list.html', tag_list(x))
+        has_pictures = lambda x: filter(lambda y: y.picture_count > 0, x)
+        has_books = lambda x: filter(lambda y: y.book_count > 0, x)
+        def render_split(tags):
+            with_books = has_books(tags)
+            with_pictures = has_pictures(tags)
+            ctx = {}
+            if with_books:
+                ctx['books'] = render_tag_list(with_books)
+            if with_pictures:
+                ctx['pictures'] = render_tag_list(with_pictures)
+            return render_to_string('catalogue/tag_list_split.html', ctx)
+
+        output = {'theme': {}}
+        output['theme'] = render_tag_list(fragment_tags)
+        for category, tags in categories.items():
+            if category in ('author', 'theme'):
+                output[category] = render_tag_list(tags)
+            else:
+                output[category] = render_split(tags)
 
-def book_list(request, filter=None, template_name='catalogue/book_list.html'):
-    """ generates a listing of all books, optionally filtered with a test function """
+        output['collections'] = render_to_string(
+            'catalogue/collection_list.html', collection_list(collections))
+        permanent_cache.set(cache_key, output)
+    if request.is_ajax():
+        return JsonResponse(output)
+    else:
+        return render_to_response('catalogue/catalogue.html', locals(),
+            context_instance=RequestContext(request))
 
-    books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
-    books_nav = SortedDict()
-    for tag in books_by_author:
-        if books_by_author[tag]:
-            books_nav.setdefault(tag.sort_key[0], []).append(tag)
 
+def book_list(request, filter=None, get_filter=None,
+        template_name='catalogue/book_list.html',
+        nav_template_name='catalogue/snippets/book_list_nav.html',
+        list_template_name='catalogue/snippets/book_list.html',
+        cache_key='catalogue.book_list',
+        context=None,
+        ):
+    """ generates a listing of all books, optionally filtered with a test function """
+    cache_key = "%s/%s" % (cache_key, get_language())
+    cached = permanent_cache.get(cache_key)
+    if cached is not None:
+        rendered_nav, rendered_book_list = cached
+    else:
+        if get_filter:
+            filter = get_filter()
+        books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
+        books_nav = OrderedDict()
+        for tag in books_by_author:
+            if books_by_author[tag]:
+                books_nav.setdefault(tag.sort_key[0], []).append(tag)
+        rendered_nav = render_to_string(nav_template_name, locals())
+        rendered_book_list = render_to_string(list_template_name, locals())
+        permanent_cache.set(cache_key, (rendered_nav, rendered_book_list))
     return render_to_response(template_name, locals(),
         context_instance=RequestContext(request))
 
 
 def audiobook_list(request):
     return book_list(request, Q(media__type='mp3') | Q(media__type='ogg'),
-                     template_name='catalogue/audiobook_list.html')
+                     template_name='catalogue/audiobook_list.html',
+                     list_template_name='catalogue/snippets/audiobook_list.html',
+                     cache_key='catalogue.audiobook_list')
 
 
 def daisy_list(request):
     return book_list(request, Q(media__type='daisy'),
-                     template_name='catalogue/daisy_list.html')
+                     template_name='catalogue/daisy_list.html',
+                     cache_key='catalogue.daisy_list')
+
+
+def collection(request, slug):
+    coll = get_object_or_404(models.Collection, slug=slug)
+    if coll.kind == 'book':
+        view = book_list
+        tmpl = "catalogue/collection.html"
+    elif coll.kind == 'picture':
+        view = picture_list_thumb
+        tmpl = "picture/collection.html"
+    else:
+        raise ValueError('How do I show this kind of collection? %s' % coll.kind)
+    return view(request, get_filter=coll.get_query,
+                     template_name=tmpl,
+                     cache_key='catalogue.collection:%s' % coll.slug,
+                     context={'collection': coll})
 
 
 def differentiate_tags(request, tags, ambiguous_slugs):
@@ -90,17 +152,21 @@ def differentiate_tags(request, tags, ambiguous_slugs):
                 context_instance=RequestContext(request))
 
 
+# TODO: Rewrite this hellish piece of code which tries to do everything
 def tagged_object_list(request, tags=''):
-    #    import pdb; pdb.set_trace()
+    # preliminary tests and conditions
     try:
         tags = models.Tag.get_tag_list(tags)
     except models.Tag.DoesNotExist:
+        # Perhaps the user is asking about an author in Public Domain
+        # counter (they are not represented in tags)
         chunks = tags.split('/')
         if len(chunks) == 2 and chunks[0] == 'autor':
             return pdcounter_views.author_detail(request, chunks[1])
         else:
             raise Http404
     except models.Tag.MultipleObjectsReturned, e:
+        # Ask the user to disambiguate
         return differentiate_tags(request, e.tags, e.ambiguous_slugs)
     except models.Tag.UrlDeprecationWarning, e:
         return HttpResponsePermanentRedirect(reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
@@ -114,65 +180,99 @@ def tagged_object_list(request, tags=''):
     if len([tag for tag in tags if tag.category == 'book']):
         raise Http404
 
+    # beginning of digestion
     theme_is_set = [tag for tag in tags if tag.category == 'theme']
     shelf_is_set = [tag for tag in tags if tag.category == 'set']
     only_shelf = shelf_is_set and len(tags) == 1
     only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
 
+
     objects = only_author = None
     categories = {}
+    object_queries = []
 
     if theme_is_set:
         shelf_tags = [tag for tag in tags if tag.category == 'set']
         fragment_tags = [tag for tag in tags if tag.category != 'set']
         fragments = models.Fragment.tagged.with_all(fragment_tags)
+        areas = PictureArea.tagged.with_all(fragment_tags)
 
         if shelf_tags:
             books = models.Book.tagged.with_all(shelf_tags).order_by()
-            l_tags = models.Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in books])
+            l_tags = models.Tag.objects.filter(category='book',
+                slug__in=[book.book_tag_slug() for book in books.iterator()])
             fragments = models.Fragment.tagged.with_any(l_tags, fragments)
 
         # newtagging goes crazy if we just try:
         #related_tags = models.Tag.objects.usage_for_queryset(fragments, counts=True,
         #                    extra={'where': ["catalogue_tag.category != 'book'"]})
-        fragment_keys = [fragment.pk for fragment in fragments]
+
+        related_tags = []
+
+        fragment_keys = [fragment.pk for fragment in fragments.iterator()]
         if fragment_keys:
             related_tags = models.Fragment.tags.usage(counts=True,
-                                filters={'pk__in': fragment_keys},
-                                extra={'where': ["catalogue_tag.category != 'book'"]})
+                                filters={'pk__in': fragment_keys}).exclude(
+                                category='book')
             related_tags = (tag for tag in related_tags if tag not in fragment_tags)
-            categories = split_tags(related_tags)
+            categories = split_tags(related_tags, categories)
+
+        object_queries.insert(0, fragments)
 
-            objects = fragments
+        area_keys = [area.pk for area in areas.iterator()]
+        if area_keys:
+            related_tags = PictureArea.tags.usage(counts=True,
+                                                         filters={'pk__in': area_keys})
+            related_tags = (tag for tag in related_tags if tag not in fragment_tags)
+
+            categories = split_tags(related_tags, categories)
+
+        # we want the Pictures to go first
+        object_queries.insert(0, areas)
+        objects = MultiQuerySet(*object_queries)
     else:
         if shelf_is_set:
-            objects = models.Book.tagged.with_all(tags)
+            books = models.Book.tagged.with_all(tags).order_by('sort_key_author')
         else:
-            objects = models.Book.tagged_top_level(tags)
+            books = models.Book.tagged_top_level(tags).order_by('sort_key_author')
+
+        pictures = Picture.tagged.with_all(tags).order_by('sort_key_author')
 
-        # get related tags from `tag_counter` and `theme_counter`
         related_counts = {}
-        tags_pks = [tag.pk for tag in tags]
-        for book in objects:
-            for tag_pk, value in itertools.chain(book.tag_counter.iteritems(), book.theme_counter.iteritems()):
-                if tag_pk in tags_pks:
-                    continue
-                related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
+        if books.count() > 0:
+            # get related tags from `tag_counter` and `theme_counter`
+            tags_pks = [tag.pk for tag in tags]
+            for book in books:
+                for tag_pk, value in itertools.chain(book.tag_counter.iteritems(), book.theme_counter.iteritems()):
+                    if tag_pk in tags_pks:
+                        continue
+                    related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
+
+        if pictures.count() > 0:
+            tags_pks = [tag.pk for tag in tags]
+            for picture in pictures:
+                for tag_pk, value in itertools.chain(picture.tag_counter.iteritems(), picture.theme_counter.iteritems()):
+                    if tag_pk in tags_pks:
+                        continue
+                    related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
+
         related_tags = models.Tag.objects.filter(pk__in=related_counts.keys())
         related_tags = [tag for tag in related_tags if tag not in tags]
+
         for tag in related_tags:
             tag.count = related_counts[tag.pk]
 
         categories = split_tags(related_tags)
         del related_tags
 
+
+        objects = SortedMultiQuerySet(pictures, books, order_by='sort_key_author')
+
+
     if not objects:
         only_author = len(tags) == 1 and tags[0].category == 'author'
         objects = models.Book.objects.none()
 
-    # Add pictures
-    objects = MultiQuerySet(Picture.tagged.with_all(tags), objects)
-
     return render_to_response('catalogue/tagged_object_list.html',
         {
             'object_list': objects,
@@ -182,6 +282,7 @@ def tagged_object_list(request, tags=''):
             'only_my_shelf': only_my_shelf,
             'formats_form': forms.DownloadFormatsForm(),
             'tags': tags,
+            'theme_is_set': theme_is_set,
         },
         context_instance=RequestContext(request))
 
@@ -201,29 +302,9 @@ def book_detail(request, slug):
     try:
         book = models.Book.objects.get(slug=slug)
     except models.Book.DoesNotExist:
-        return pdcounter_views.book_stub_detail(request, kwargs['slug'])
+        return pdcounter_views.book_stub_detail(request, slug)
 
-    book_tag = book.book_tag()
-    tags = list(book.tags.filter(~Q(category='set')))
-    categories = split_tags(tags)
     book_children = book.children.all().order_by('parent_number', 'sort_key')
-
-    _book = book
-    parents = []
-    while _book.parent:
-        parents.append(_book.parent)
-        _book = _book.parent
-    parents = reversed(parents)
-
-    theme_counter = book.theme_counter
-    book_themes = models.Tag.objects.filter(pk__in=theme_counter.keys())
-    for tag in book_themes:
-        tag.count = theme_counter[tag.pk]
-
-    extra_info = book.get_extra_info_value()
-    hide_about = extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl')
-
-    custom_pdf_form = forms.CustomPDFForm()
     return render_to_response('catalogue/book_detail.html', locals(),
         context_instance=RequestContext(request))
 
@@ -234,15 +315,15 @@ def player(request, slug):
         raise Http404
 
     ogg_files = {}
-    for m in book.media.filter(type='ogg').order_by():
+    for m in book.media.filter(type='ogg').order_by().iterator():
         ogg_files[m.name] = m
 
     audiobooks = []
     have_oggs = True
     projects = set()
-    for mp3 in book.media.filter(type='mp3'):
+    for mp3 in book.media.filter(type='mp3').iterator():
         # ogg files are always from the same project
-        meta = mp3.get_extra_info_value()
+        meta = mp3.extra_info
         project = meta.get('project')
         if not project:
             # temporary fallback
@@ -258,10 +339,11 @@ def player(request, slug):
         else:
             have_oggs = False
         audiobooks.append(media)
-    print audiobooks
 
     projects = sorted(projects)
 
+    extra_info = book.extra_info
+
     return render_to_response('catalogue/player.html', locals(),
         context_instance=RequestContext(request))
 
@@ -271,13 +353,7 @@ def book_text(request, slug):
 
     if not book.has_html_file():
         raise Http404
-    book_themes = {}
-    for fragment in book.fragments.all():
-        for theme in fragment.tags.filter(category='theme'):
-            book_themes.setdefault(theme, []).append(fragment)
-
-    book_themes = book_themes.items()
-    book_themes.sort(key=lambda s: s[0].sort_key)
+    related = book.related_info()
     return render_to_response('catalogue/book_text.html', locals(),
         context_instance=RequestContext(request))
 
@@ -419,7 +495,7 @@ def find_best_matches(query, user=None):
     book_titles = set(match.pretty_title().lower() for match in result
                       if isinstance(match, models.Book))
     authors = set(match.name.lower() for match in result
-                  if isinstance(match, models.Tag) and match.category=='author')
+                  if isinstance(match, models.Tag) and match.category == 'author')
     result = tuple(res for res in result if not (
                  (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles)
                  or (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
@@ -488,170 +564,7 @@ def json_tags_starting_with(request, callback=None):
         result = [prefix, tags_list]
     else:
         result = {"matches": tags_list}
-    return JSONResponse(result, callback)
-
-# ====================
-# = Shelf management =
-# ====================
-@login_required
-@cache.never_cache
-def user_shelves(request):
-    shelves = models.Tag.objects.filter(category='set', user=request.user)
-    new_set_form = forms.NewSetForm()
-    return render_to_response('catalogue/user_shelves.html', locals(),
-            context_instance=RequestContext(request))
-
-@cache.never_cache
-def book_sets(request, slug):
-    if not request.user.is_authenticated():
-        return HttpResponse(_('<p>To maintain your shelves you need to be logged in.</p>'))
-
-    book = get_object_or_404(models.Book, slug=slug)
-
-    user_sets = models.Tag.objects.filter(category='set', user=request.user)
-    book_sets = book.tags.filter(category='set', user=request.user)
-
-    if request.method == 'POST':
-        form = forms.ObjectSetsForm(book, request.user, request.POST)
-        if form.is_valid():
-            old_shelves = list(book.tags.filter(category='set'))
-            new_shelves = [models.Tag.objects.get(pk=id) for id in form.cleaned_data['set_ids']]
-
-            for shelf in [shelf for shelf in old_shelves if shelf not in new_shelves]:
-                touch_tag(shelf)
-
-            for shelf in [shelf for shelf in new_shelves if shelf not in old_shelves]:
-                touch_tag(shelf)
-
-            book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
-            if request.is_ajax():
-                return JSONResponse('{"msg":"'+_("<p>Shelves were sucessfully saved.</p>")+'", "after":"close"}')
-            else:
-                return HttpResponseRedirect('/')
-    else:
-        form = forms.ObjectSetsForm(book, request.user)
-        new_set_form = forms.NewSetForm()
-
-    return render_to_response('catalogue/book_sets.html', locals(),
-        context_instance=RequestContext(request))
-
-
-@login_required
-@require_POST
-@cache.never_cache
-def remove_from_shelf(request, shelf, slug):
-    book = get_object_or_404(models.Book, slug=slug)
-
-    shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
-
-    if shelf in book.tags:
-        models.Tag.objects.remove_tag(book, shelf)
-        touch_tag(shelf)
-
-        return HttpResponse(_('Book was successfully removed from the shelf'))
-    else:
-        return HttpResponse(_('This book is not on the shelf'))
-
-
-def collect_books(books):
-    """
-    Returns all real books in collection.
-    """
-    result = []
-    for book in books:
-        if len(book.children.all()) == 0:
-            result.append(book)
-        else:
-            result += collect_books(book.children.all())
-    return result
-
-
-@cache.never_cache
-def download_shelf(request, slug):
-    """"
-    Create a ZIP archive on disk and transmit it in chunks of 8KB,
-    without loading the whole file into memory. A similar approach can
-    be used for large dynamic PDF files.
-    """
-    from slughifi import slughifi
-    import tempfile
-    import zipfile
-
-    shelf = get_object_or_404(models.Tag, slug=slug, category='set')
-
-    formats = []
-    form = forms.DownloadFormatsForm(request.GET)
-    if form.is_valid():
-        formats = form.cleaned_data['formats']
-    if len(formats) == 0:
-        formats = models.Book.ebook_formats
-
-    # Create a ZIP archive
-    temp = tempfile.TemporaryFile()
-    archive = zipfile.ZipFile(temp, 'w')
-
-    for book in collect_books(models.Book.tagged.with_all(shelf)):
-        for ebook_format in models.Book.ebook_formats:
-            if ebook_format in formats and book.has_media(ebook_format):
-                filename = book.get_media(ebook_format).path
-                archive.write(filename, str('%s.%s' % (book.slug, ebook_format)))
-    archive.close()
-
-    response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
-    response['Content-Disposition'] = 'attachment; filename=%s.zip' % slughifi(shelf.name)
-    response['Content-Length'] = temp.tell()
-
-    temp.seek(0)
-    response.write(temp.read())
-    return response
-
-
-@cache.never_cache
-def shelf_book_formats(request, shelf):
-    """"
-    Returns a list of formats of books in shelf.
-    """
-    shelf = get_object_or_404(models.Tag, slug=shelf, category='set')
-
-    formats = {}
-    for ebook_format in models.Book.ebook_formats:
-        formats[ebook_format] = False
-
-    for book in collect_books(models.Book.tagged.with_all(shelf)):
-        for ebook_format in models.Book.ebook_formats:
-            if book.has_media(ebook_format):
-                formats[ebook_format] = True
-
-    return HttpResponse(LazyEncoder().encode(formats))
-
-
-@login_required
-@require_POST
-@cache.never_cache
-def new_set(request):
-    new_set_form = forms.NewSetForm(request.POST)
-    if new_set_form.is_valid():
-        new_set = new_set_form.save(request.user)
-
-        if request.is_ajax():
-            return JSONResponse('{"id":"%d", "name":"%s", "msg":"<p>Shelf <strong>%s</strong> was successfully created</p>"}' % (new_set.id, new_set.name, new_set))
-        else:
-            return HttpResponseRedirect('/')
-
-    return HttpResponseRedirect('/')
-
-
-@login_required
-@require_POST
-@cache.never_cache
-def delete_shelf(request, slug):
-    user_set = get_object_or_404(models.Tag, slug=slug, category='set', user=request.user)
-    user_set.delete()
-
-    if request.is_ajax():
-        return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully removed</p>') % user_set.name)
-    else:
-        return HttpResponseRedirect('/')
+    return JsonResponse(result, callback)
 
 
 # =========
@@ -705,32 +618,23 @@ def download_zip(request, format, slug=None):
     return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
 
 
-def download_custom_pdf(request, slug, method='GET'):
-    book = get_object_or_404(models.Book, slug=slug)
+class CustomPDFFormView(AjaxableFormView):
+    form_class = forms.CustomPDFForm
+    title = ugettext_lazy('Download custom PDF')
+    submit = ugettext_lazy('Download')
+    honeypot = True
 
-    if request.method == method:
-        form = forms.CustomPDFForm(method == 'GET' and request.GET or request.POST)
-        if form.is_valid():
-            cust = form.customizations
-            pdf_file = models.get_customized_pdf_path(book, cust)
+    def __call__(self, *args, **kwargs):
+        if settings.NO_CUSTOM_PDF:
+            raise Http404('Custom PDF is disabled')
+        return super(CustomPDFFormView, self).__call__(*args, **kwargs)
 
-            if not path.exists(pdf_file):
-                result = async_build_pdf.delay(book.id, cust, pdf_file)
-                result.wait()
-            return AttachmentHttpResponse(file_name=("%s.pdf" % book.slug), file_path=pdf_file, mimetype="application/pdf")
-        else:
-            raise Http404(_('Incorrect customization options for PDF'))
-    else:
-        raise Http404(_('Bad method'))
+    def form_args(self, request, obj):
+        """Override to parse view args and give additional args to the form."""
+        return (obj,), {}
 
+    def get_object(self, request, slug, *args, **kwargs):
+        return get_object_or_404(models.Book, slug=slug)
 
-class CustomPDFFormView(AjaxableFormView):
-    form_class = forms.CustomPDFForm
-    title = _('Download custom PDF')
-    submit = _('Download')
-
-    def __call__(self, request):
-        if request.method == 'POST':
-            return download_custom_pdf(request, request.GET['book_id'], method='POST')
-        else:
-            return super(CustomPDFFormView, self).__call__(request)
+    def context_description(self, request, obj):
+        return obj.pretty_title()