General A/B testing.
[wolnelektury.git] / src / catalogue / views.py
index 267d9b4..007ebe4 100644 (file)
@@ -1,35 +1,33 @@
-# -*- coding: utf-8 -*-
 # 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 random
 
 from django.conf import settings
-from django.template import RequestContext
+from django.http.response import HttpResponseForbidden
 from django.template.loader import render_to_string
-from django.shortcuts import render_to_response, get_object_or_404, render, redirect
-from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect, JsonResponse
-from django.core.urlresolvers import reverse
+from django.shortcuts import get_object_or_404, render, redirect
+from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
+from django.urls import reverse
 from django.db.models import Q, QuerySet
 from django.contrib.auth.decorators import login_required, user_passes_test
 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 AjaxableFormView
-from pdcounter.models import BookStub, Author
+from club.models import Membership
 from pdcounter import views as pdcounter_views
 from picture.models import Picture, PictureArea
-from ssify import ssi_included, ssi_expect, SsiVariable as Var
-from suggest.forms import PublishingSuggestForm
 from catalogue import constants
 from catalogue import forms
 from catalogue.helpers import get_top_level_related_tags
 from catalogue.models import Book, Collection, Tag, Fragment
 from catalogue.utils import split_tags
 from catalogue.models.tag import prefetch_relations
+from wolnelektury.utils import is_crawler
 
 staff_required = user_passes_test(lambda user: user.is_staff)
 
@@ -52,15 +50,14 @@ def book_list(request, filters=None, template_name='catalogue/book_list.html',
     for tag in books_by_author:
         if books_by_author[tag]:
             books_nav.setdefault(tag.sort_key[0], []).append(tag)
-    # WTF: dlaczego nie include?
-    return render_to_response(template_name, {
+    return render(request, template_name, {
         'rendered_nav': render_to_string(nav_template_name, {'books_nav': books_nav}),
         'rendered_book_list': render_to_string(list_template_name, {
             'books_by_author': books_by_author,
             'orphans': orphans,
             'books_by_parent': books_by_parent,
         })
-    }, context_instance=RequestContext(request))
+    })
 
 
 def daisy_list(request):
@@ -81,9 +78,9 @@ def differentiate_tags(request, tags, ambiguous_slugs):
             'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
             'tags': [tag]
         })
-    return render_to_response(
-        'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
-        context_instance=RequestContext(request))
+    return render(
+        request,
+        'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]})
 
 
 def object_list(request, objects, fragments=None, related_tags=None, tags=None, list_type='books', extra=None):
@@ -134,22 +131,15 @@ def object_list(request, objects, fragments=None, related_tags=None, tags=None,
     }
     if extra:
         result.update(extra)
-    return render_to_response(
+    return render(
+        request,
         'catalogue/tagged_object_list.html', result,
-        context_instance=RequestContext(request))
+    )
 
 
 def literature(request):
     books = Book.objects.filter(parent=None)
-
-    # last_published = Book.objects.exclude(cover_thumb='').filter(parent=None).order_by('-created_at')[:20]
-    # most_popular = Book.objects.exclude(cover_thumb='')\
-    #                    .order_by('-popularity__count', 'sort_key_author', 'sort_key')[:20]
     return object_list(request, books, related_tags=get_top_level_related_tags([]))
-    # extra={
-    #     'last_published': last_published,
-    #     'most_popular': most_popular,
-    # })
 
 
 def gallery(request):
@@ -180,10 +170,10 @@ def analyse_tags(request, tag_str):
             raise ResponseInstead(pdcounter_views.author_detail(request, chunks[1]))
         else:
             raise Http404
-    except Tag.MultipleObjectsReturned, e:
+    except Tag.MultipleObjectsReturned as e:
         # Ask the user to disambiguate
         raise ResponseInstead(differentiate_tags(request, e.tags, e.ambiguous_slugs))
-    except Tag.UrlDeprecationWarning, e:
+    except Tag.UrlDeprecationWarning as e:
         raise ResponseInstead(HttpResponsePermanentRedirect(
             reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)])))
 
@@ -225,6 +215,9 @@ def tagged_object_list(request, tags, list_type):
     except ResponseInstead as e:
         return e.response
 
+    if is_crawler(request) and len(tags) > 1:
+        return HttpResponseForbidden('address removed from crawling. check robots.txt')
+
     if list_type == 'gallery' and any(tag.category == 'set' for tag in tags):
         raise Http404
 
@@ -264,57 +257,32 @@ def book_fragments(request, slug, theme_slug):
     fragments = Fragment.tagged.with_all([theme]).filter(
         Q(book=book) | Q(book__ancestor=book))
 
-    return render_to_response('catalogue/book_fragments.html', {
-        'book': book,
-        'theme': theme,
-        'fragments': fragments,
-        'active_menu_item': 'books',
-    }, context_instance=RequestContext(request))
+    return render(
+        request,
+        'catalogue/book_fragments.html',
+        {
+            'book': book,
+            'theme': theme,
+            'fragments': fragments,
+            'active_menu_item': 'books',
+        })
 
 
+@never_cache
 def book_detail(request, slug):
     try:
         book = Book.objects.get(slug=slug)
     except Book.DoesNotExist:
         return pdcounter_views.book_stub_detail(request, slug)
 
-    return render_to_response('catalogue/book_detail.html', {
-        'book': book,
-        'tags': book.tags.exclude(category__in=('set', 'theme')),
-        'book_children': book.children.all().order_by('parent_number', 'sort_key'),
-        'active_menu_item': 'books',
-    }, context_instance=RequestContext(request))
-
-
-def get_audiobooks(book):
-    ogg_files = {}
-    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').iterator():
-        # ogg files are always from the same project
-        meta = mp3.extra_info
-        project = meta.get('project')
-        if not project:
-            # temporary fallback
-            project = u'CzytamySłuchając'
-
-        projects.add((project, meta.get('funded_by', '')))
-
-        media = {'mp3': mp3}
-
-        ogg = ogg_files.get(mp3.name)
-        if ogg:
-            media['ogg'] = ogg
-        else:
-            have_oggs = False
-        audiobooks.append(media)
-
-    projects = sorted(projects)
-    return audiobooks, projects, have_oggs
+    return render(
+        request,
+        'catalogue/book_detail.html',
+        {
+            'book': book,
+            'book_children': book.children.all().order_by('parent_number', 'sort_key'),
+            'active_menu_item': 'books',
+        })
 
 
 # używane w publicznym interfejsie
@@ -323,254 +291,33 @@ def player(request, slug):
     if not book.has_media('mp3'):
         raise Http404
 
-    audiobooks, projects, have_oggs = get_audiobooks(book)
+    audiobooks, projects = book.get_audiobooks()
 
-    return render_to_response('catalogue/player.html', {
-        'book': book,
-        'audiobook': '',
-        'audiobooks': audiobooks,
-        'projects': projects,
-    }, context_instance=RequestContext(request))
+    return render(
+        request,
+        'catalogue/player.html',
+        {
+            'book': book,
+            'audiobook': '',
+            'audiobooks': audiobooks,
+            'projects': projects,
+        })
 
 
 def book_text(request, slug):
     book = get_object_or_404(Book, slug=slug)
 
+    if book.preview and not Membership.is_active_for(request.user):
+        return HttpResponseRedirect(book.get_absolute_url())
+
     if not book.has_html_file():
         raise Http404
-    return render_to_response('catalogue/book_text.html', {'book': book}, context_instance=RequestContext(request))
-
-
-# ==========
-# = Search =
-# ==========
-
-def _no_diacritics_regexp(query):
-    """ returns a regexp for searching for a query without diacritics
-
-    should be locale-aware """
-    names = {
-        u'a': u'aąĄ', u'c': u'cćĆ', u'e': u'eęĘ', u'l': u'lłŁ', u'n': u'nńŃ', u'o': u'oóÓ', u's': u'sśŚ',
-        u'z': u'zźżŹŻ',
-        u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
-        u'ż': u'żŻ'
-        }
-
-    def repl(m):
-        l = m.group()
-        return u"(?:%s)" % '|'.join(names[l])
-
-    return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
-
-
-def unicode_re_escape(query):
-    """ Unicode-friendly version of re.escape """
-    s = list(query)
-    for i, c in enumerate(query):
-        if re.match(r'(?u)(\W)', c) and re.match(r'[\x00-\x7e]', c):
-            if c == "\000":
-                s[i] = "\\000"
-            else:
-                s[i] = "\\" + c
-    return query[:0].join(s)
-
-
-def _word_starts_with(name, prefix):
-    """returns a Q object getting models having `name` contain a word
-    starting with `prefix`
-
-    We define word characters as alphanumeric and underscore, like in JS.
-
-    Works for MySQL, PostgreSQL, Oracle.
-    For SQLite, _sqlite* version is substituted for this.
-    """
-    kwargs = {}
-
-    prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
-    # can't use [[:<:]] (word start),
-    # but we want both `xy` and `(xy` to catch `(xyz)`
-    kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
-
-    return Q(**kwargs)
-
-
-def _word_starts_with_regexp(prefix):
-    prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
-    return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
-
-
-def _sqlite_word_starts_with(name, prefix):
-    """ version of _word_starts_with for SQLite
-
-    SQLite in Django uses Python re module
-    """
-    kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
-    return Q(**kwargs)
-
-
-if hasattr(settings, 'DATABASES'):
-    if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
-        _word_starts_with = _sqlite_word_starts_with
-elif settings.DATABASE_ENGINE == 'sqlite3':
-    _word_starts_with = _sqlite_word_starts_with
-
-
-class App:
-    def __init__(self, name, view):
-        self.name = name
-        self._view = view
-        self.lower = name.lower()
-        self.category = 'application'
-
-    def view(self):
-        return reverse(*self._view)
-
-_apps = (
-    App(u'Leśmianator', (u'lesmianator', )),
-    )
-
-
-def _tags_starting_with(prefix, user=None):
-    prefix = prefix.lower()
-    # PD counter
-    book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
-    authors = Author.objects.filter(_word_starts_with('name', prefix))
-
-    books = Book.objects.filter(_word_starts_with('title', prefix))
-    tags = Tag.objects.filter(_word_starts_with('name', prefix))
-    if user and user.is_authenticated():
-        tags = tags.filter(~Q(category='set') | Q(user=user))
-    else:
-        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)
-
-
-def _get_result_link(match, tag_list):
-    if isinstance(match, Tag):
-        return reverse('catalogue.views.tagged_object_list',
-                       kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
-    elif isinstance(match, App):
-        return match.view()
-    else:
-        return match.get_absolute_url()
-
-
-def _get_result_type(match):
-    if isinstance(match, Book) or isinstance(match, BookStub):
-        match_type = 'book'
-    else:
-        match_type = match.category
-    return match_type
-
-
-def books_starting_with(prefix):
-    prefix = prefix.lower()
-    return Book.objects.filter(_word_starts_with('title', prefix))
-
-
-def find_best_matches(query, user=None):
-    """ Finds a Book, Tag, BookStub or Author best matching a query.
-
-    Returns a with:
-      - zero elements when nothing is found,
-      - one element when a best result is found,
-      - more then one element on multiple exact matches
-
-    Raises a ValueError on too short a query.
-    """
-
-    query = query.lower()
-    if len(query) < 2:
-        raise ValueError("query must have at least two characters")
-
-    result = tuple(_tags_starting_with(query, user))
-    # remove pdcounter stuff
-    book_titles = set(match.pretty_title().lower() for match in result
-                      if isinstance(match, Book))
-    authors = set(match.name.lower() for match in result
-                  if isinstance(match, Tag) and match.category == 'author')
-    result = tuple(res for res in result if not (
-                 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
-                 (isinstance(res, Author) and res.name.lower() in authors)
-             ))
-
-    exact_matches = tuple(res for res in result if res.name.lower() == query)
-    if exact_matches:
-        return exact_matches
-    else:
-        return tuple(result)[:1]
-
-
-def search(request):
-    tags = request.GET.get('tags', '')
-    prefix = request.GET.get('q', '')
-
-    try:
-        tag_list = Tag.get_tag_list(tags)
-    except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
-        tag_list = []
-
-    try:
-        result = find_best_matches(prefix, request.user)
-    except ValueError:
-        return render_to_response(
-            'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
-            context_instance=RequestContext(request))
-
-    if len(result) == 1:
-        return HttpResponseRedirect(_get_result_link(result[0], tag_list))
-    elif len(result) > 1:
-        return render_to_response(
-            'catalogue/search_multiple_hits.html',
-            {
-                'tags': tag_list, 'prefix': prefix,
-                'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
-            },
-            context_instance=RequestContext(request))
-    else:
-        form = PublishingSuggestForm(initial={"books": prefix + ", "})
-        return render_to_response(
-            'catalogue/search_no_hits.html',
-            {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
-            context_instance=RequestContext(request))
-
-
-def tags_starting_with(request):
-    prefix = request.GET.get('q', '')
-    # Prefix must have at least 2 characters
-    if len(prefix) < 2:
-        return HttpResponse('')
-    tags_list = []
-    result = ""
-    for tag in _tags_starting_with(prefix, request.user):
-        if tag.name not in tags_list:
-            result += "\n" + tag.name
-            tags_list.append(tag.name)
-    return HttpResponse(result)
-
-
-def json_tags_starting_with(request, callback=None):
-    # Callback for JSONP
-    prefix = request.GET.get('q', '')
-    callback = request.GET.get('callback', '')
-    # Prefix must have at least 2 characters
-    if len(prefix) < 2:
-        return HttpResponse('')
-    tags_list = []
-    for tag in _tags_starting_with(prefix, request.user):
-        if tag.name not in tags_list:
-            tags_list.append(tag.name)
-    if request.GET.get('mozhint', ''):
-        result = [prefix, tags_list]
-    else:
-        result = {"matches": tags_list}
-    response = JsonResponse(result, safe=False)
-    if callback:
-        response.content = callback + "(" + response.content + ");"
-    return response
+    with book.html_file.open('r') as f:
+        book_text = f.read()
+    return render(request, 'catalogue/book_text.html', {
+        'book': book,
+        'book_text': book_text,
+    })
 
 
 # =========
@@ -605,7 +352,7 @@ def book_info(request, book_id, lang='pl'):
     book = get_object_or_404(Book, id=book_id)
     # set language by hand
     translation.activate(lang)
-    return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
+    return render(request, 'catalogue/book_info.html', {'book': book})
 
 
 def tag_info(request, tag_id):
@@ -613,6 +360,19 @@ def tag_info(request, tag_id):
     return HttpResponse(tag.description)
 
 
+@never_cache
+def embargo_link(request, key, format_, slug):
+    book = get_object_or_404(Book, slug=slug)
+    if format_ not in Book.formats:
+        raise Http404
+    if key != book.preview_key:
+        raise Http404
+    media_file = book.get_media(format_)
+    if not book.preview:
+        return HttpResponseRedirect(media_file.url)
+    return HttpResponse(media_file, content_type=constants.EBOOK_CONTENT_TYPES[format_])
+
+
 def download_zip(request, format, slug=None):
     if format in Book.ebook_formats:
         url = Book.zip_format(format)
@@ -640,116 +400,20 @@ class CustomPDFFormView(AjaxableFormView):
         """Override to parse view args and give additional args to the form."""
         return (obj,), {}
 
+    def validate_object(self, obj, request):
+        book = obj
+        if book.preview and not Membership_is_active_for(request.user):
+            return HttpResponseRedirect(book.get_absolute_url())
+        return super(CustomPDFFormView, self).validate_object(obj, request)
+
     def get_object(self, request, slug, *args, **kwargs):
-        return get_object_or_404(Book, slug=slug)
+        book = get_object_or_404(Book, slug=slug)
+        return book
 
     def context_description(self, request, obj):
         return obj.pretty_title()
 
 
-####
-# Includes
-####
-
-
-@ssi_included
-def book_mini(request, pk, with_link=True):
-    # book = get_object_or_404(Book, pk=pk)
-    try:
-        book = Book.objects.only('cover_thumb', 'title', 'language', 'slug').get(pk=pk)
-    except Book.DoesNotExist:
-        raise Http404
-    return render(request, 'catalogue/book_mini_box.html', {
-        'book': book,
-        'no_link': not with_link,
-    })
-
-
-@ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
-        ('ssify.get_csrf_token',),
-        ('social_tags.likes_book', (ipk,)),
-        ('social_tags.book_shelf_tags', (ipk,)),
-    ))(ssi_expect(pk, int)))
-def book_short(request, pk):
-    book = get_object_or_404(Book, pk=pk)
-    stage_note, stage_note_url = book.stage_note()
-    audiobooks, projects, have_oggs = get_audiobooks(book)
-
-    return render(request, 'catalogue/book_short.html', {
-        'book': book,
-        'has_audio': book.has_media('mp3'),
-        'main_link': book.get_absolute_url(),
-        'parents': book.parents(),
-        'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
-        'show_lang': book.language_code() != settings.LANGUAGE_CODE,
-        'stage_note': stage_note,
-        'stage_note_url': stage_note_url,
-        'audiobooks': audiobooks,
-        'have_oggs': have_oggs,
-    })
-
-
-@ssi_included(
-    get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
-    (lambda ipk: (
-        ('social_tags.choose_cite', [ipk]),
-        ('catalogue_tags.choose_fragment', [ipk], {
-            'unless': Var('social_tags.choose_cite', [ipk])}),
-    ))(ssi_expect(pk, int)))
-def book_wide(request, pk):
-    book = get_object_or_404(Book, pk=pk)
-    stage_note, stage_note_url = book.stage_note()
-    extra_info = book.extra_info
-    audiobooks, projects, have_oggs = get_audiobooks(book)
-
-    return render(request, 'catalogue/book_wide.html', {
-        'book': book,
-        'has_audio': book.has_media('mp3'),
-        'parents': book.parents(),
-        'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
-        'show_lang': book.language_code() != settings.LANGUAGE_CODE,
-        'stage_note': stage_note,
-        'stage_note_url': stage_note_url,
-
-        'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
-        'extra_info': extra_info,
-        'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
-        'audiobooks': audiobooks,
-        'have_oggs': have_oggs,
-    })
-
-
-@ssi_included
-def fragment_short(request, pk):
-    fragment = get_object_or_404(Fragment, pk=pk)
-    return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
-
-
-@ssi_included
-def fragment_promo(request, pk):
-    fragment = get_object_or_404(Fragment, pk=pk)
-    return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
-
-
-@ssi_included
-def tag_box(request, pk):
-    tag = get_object_or_404(Tag, pk=pk)
-    assert tag.category != 'set'
-
-    return render(request, 'catalogue/tag_box.html', {
-        'tag': tag,
-    })
-
-
-@ssi_included
-def collection_box(request, pk):
-    collection = get_object_or_404(Collection, pk=pk)
-
-    return render(request, 'catalogue/collection_box.html', {
-        'collection': collection,
-    })
-
-
 def tag_catalogue(request, category):
     if category == 'theme':
         tags = Tag.objects.usage_for_model(
@@ -777,7 +441,7 @@ def collections(request):
     objects = Collection.objects.all()
 
     if len(objects) > 3:
-        best = random.sample(objects, 3)
+        best = random.sample(list(objects), 3)
     else:
         best = objects
 
@@ -798,4 +462,4 @@ def ridero_cover(request, slug):
 
 def get_isbn(request, book_format, slug):
     book = Book.objects.get(slug=slug)
-    return HttpResponse(book.extra_info.get('isbn_%s' % book_format))
+    return HttpResponse(book.get_extra_info_json().get('isbn_%s' % book_format))