Add mock Search class for development.
[wolnelektury.git] / apps / catalogue / views.py
index 5dff961..f47329a 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 django.conf import settings
+from django.core.cache import get_cache
 from django.template import RequestContext
-from django.shortcuts import render_to_response, get_object_or_404, redirect
-from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
+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, JsonResponse
 from django.core.urlresolvers import reverse
 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.utils.http import urlquote_plus
 from django.utils import translation
-from django.utils.translation import ugettext as _, ugettext_lazy
-from django.views.decorators.cache import never_cache
-
-from ajaxable.utils import 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,
-    async_build_pdf, MultiQuerySet)
+from .helpers import get_related_tags, get_fragment_related_tags, tags_usage_for_books, tags_usage_for_works, tags_usage_for_fragments
+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 waiter.models import WaitedFile
+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)
+    output = None
+
+    if output is None:
+        common_categories = ('author',)
+        split_categories = ('epoch', 'genre', 'kind')
+
+        categories = split_tags(tags_usage_for_works(common_categories))
+        book_categories = split_tags(tags_usage_for_books(split_categories))
+        picture_categories = split_tags(
+            models.Tag.objects.usage_for_model(Picture, counts=True).filter(
+                category__in=split_categories))
+        # we want global usage for themes
+        fragment_tags = list(tags_usage_for_fragments(('theme',)))
+        collections = models.Collection.objects.all()
+
+        render_tag_list = lambda x: render_to_string(
+            'catalogue/tag_list.html', tag_list(x))
+
+        def render_split(with_books, with_pictures):
+            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 = {}
+        output['theme'] = render_tag_list(fragment_tags)
+        for category in common_categories:
+            output[category] = render_tag_list(categories.get(category, []))
+        for category in split_categories:
+            output[category] = render_split(
+                book_categories.get(category, []),
+                picture_categories.get(category, []))
+
+        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))
 
 
-def book_list(request, filter=None, template_name='catalogue/book_list.html',
-        context=None):
+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 """
-
-    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)
-
+    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)
-    slugs = coll.book_slugs.split()
-    # allow URIs
-    slugs = [slug.rstrip('/').rsplit('/', 1)[-1] if '/' in slug else slug
-                for slug in slugs]
-    return book_list(request, Q(slug__in=slugs),
-                     template_name='catalogue/collection.html',
+    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})
 
 
@@ -87,7 +144,7 @@ def differentiate_tags(request, tags, ambiguous_slugs):
     beginning = '/'.join(tag.url_chunk for tag in tags)
     unparsed = '/'.join(ambiguous_slugs[1:])
     options = []
-    for tag in models.Tag.objects.exclude(category='book').filter(slug=ambiguous_slugs[0]):
+    for tag in models.Tag.objects.filter(slug=ambiguous_slugs[0]):
         options.append({
             'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
             'tags': [tag]
@@ -97,17 +154,21 @@ def differentiate_tags(request, tags, ambiguous_slugs):
                 context_instance=RequestContext(request))
 
 
-@never_cache
+# TODO: Rewrite this hellish piece of code which tries to do everything
 def tagged_object_list(request, tags=''):
+    # 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)]))
@@ -121,71 +182,70 @@ 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
+
+    objects =  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:
+            # FIXME: book tags here
             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]
-        if fragment_keys:
-            related_tags = models.Fragment.tags.usage(counts=True,
-                                filters={'pk__in': fragment_keys},
-                                extra={'where': ["catalogue_tag.category != 'book'"]})
+        related_tags = get_fragment_related_tags(tags)
+        categories = split_tags(related_tags, categories)
+        object_queries.insert(0, 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)
 
-            objects = fragments
+            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', 'title')
         else:
-            objects = models.Book.tagged_top_level(tags)
-
-        # 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
-        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
+            books = models.Book.tagged_top_level(tags).order_by(
+                'sort_key_author', 'title')
+
+        pictures = Picture.tagged.with_all(tags).order_by(
+            'sort_key_author', 'title')
+
+        categories = split_tags(get_related_tags(tags))
+
+        objects = SortedMultiQuerySet(pictures, books,
+            order_by=('sort_key_author', 'title'))
+
 
     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,
             'categories': categories,
             'only_shelf': only_shelf,
-            'only_author': only_author,
             'only_my_shelf': only_my_shelf,
             'formats_form': forms.DownloadFormatsForm(),
             'tags': tags,
@@ -196,16 +256,14 @@ def tagged_object_list(request, tags=''):
 
 def book_fragments(request, slug, theme_slug):
     book = get_object_or_404(models.Book, slug=slug)
-
-    book_tag = book.book_tag()
     theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
-    fragments = models.Fragment.tagged.with_all([book_tag, theme])
+    fragments = models.Fragment.tagged.with_all([theme]).filter(
+        Q(book=book) | Q(book__ancestor=book))
 
     return render_to_response('catalogue/book_fragments.html', locals(),
         context_instance=RequestContext(request))
 
 
-@never_cache
 def book_detail(request, slug):
     try:
         book = models.Book.objects.get(slug=slug)
@@ -223,15 +281,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
@@ -250,7 +308,7 @@ def player(request, slug):
 
     projects = sorted(projects)
 
-    extra_info = book.get_extra_info_value()
+    extra_info = book.extra_info
 
     return render_to_response('catalogue/player.html', locals(),
         context_instance=RequestContext(request))
@@ -261,13 +319,6 @@ 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)
     return render_to_response('catalogue/book_text.html', locals(),
         context_instance=RequestContext(request))
 
@@ -357,9 +408,9 @@ def _tags_starting_with(prefix, user=None):
     books = models.Book.objects.filter(_word_starts_with('title', prefix))
     tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
     if user and user.is_authenticated():
-        tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
+        tags = tags.filter(~Q(category='set') | Q(user=user))
     else:
-        tags = tags.filter(~Q(category='book') & ~Q(category='set'))
+        tags = tags.exclude(category='set')
 
     prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
     return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + list(authors)
@@ -409,7 +460,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)
@@ -478,7 +529,7 @@ def json_tags_starting_with(request, callback=None):
         result = [prefix, tags_list]
     else:
         result = {"matches": tags_list}
-    return JSONResponse(result, callback)
+    return JsonResponse(result, callback)
 
 
 # =========
@@ -532,45 +583,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)
-
-    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)
-
-            url = WaitedFile.order(pdf_file,
-                    lambda p: async_build_pdf.delay(book.id, cust, p),
-                    book.pretty_title()
-                )
-            return redirect(url)
-        else:
-            raise Http404(_('Incorrect customization options for PDF'))
-    else:
-        raise Http404(_('Bad method'))
-
-
 class CustomPDFFormView(AjaxableFormView):
     form_class = forms.CustomPDFForm
     title = ugettext_lazy('Download custom PDF')
     submit = ugettext_lazy('Download')
     honeypot = True
 
-    def __call__(self, request):
-        from copy import copy
-        if request.method == 'POST':
-            request.GET = copy(request.GET)
-            request.GET['next'] = "%s?%s" % (reverse('catalogue.views.download_custom_pdf', args=[request.GET.get('slug')]),
-                                             request.POST.urlencode())
-        return super(CustomPDFFormView, self).__call__(request)
+    def __call__(self, *args, **kwargs):
+        if settings.NO_CUSTOM_PDF:
+            raise Http404('Custom PDF is disabled')
+        return super(CustomPDFFormView, self).__call__(*args, **kwargs)
 
-    def get_object(self, request):
-        return get_object_or_404(models.Book, slug=request.GET.get('slug'))
+    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)
 
     def context_description(self, request, obj):
         return obj.pretty_title()
-
-    def success(self, *args):
-        pass