Updated migration.
[wolnelektury.git] / apps / catalogue / views.py
index b61d5e8..aaf57fc 100644 (file)
@@ -1,7 +1,15 @@
 # -*- 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.
+#
 import tempfile
 import zipfile
+import sys
+import pprint
+import traceback
+import re
 
+from django.conf import settings
 from django.template import RequestContext
 from django.shortcuts import render_to_response, get_object_or_404
 from django.http import HttpResponse, HttpResponseRedirect, Http404
@@ -15,7 +23,10 @@ from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
 from django.utils import simplejson
 from django.utils.functional import Promise
 from django.utils.encoding import force_unicode
+from django.utils.http import urlquote_plus
 from django.views.decorators import cache
+from django.utils.translation import ugettext as _
+from django.views.generic.list_detail import object_list
 
 from catalogue import models
 from catalogue import forms
@@ -37,10 +48,10 @@ def main_page(request):
     if request.user.is_authenticated():
         shelves = models.Tag.objects.filter(category='set', user=request.user)
         new_set_form = forms.NewSetForm()
-    extra_where = 'NOT catalogue_tag.category = "set"'
+    extra_where = "NOT catalogue_tag.category = 'set'"
     tags = models.Tag.objects.usage_for_model(models.Book, counts=True, extra={'where': [extra_where]})
     fragment_tags = models.Tag.objects.usage_for_model(models.Fragment, counts=True,
-        extra={'where': ['catalogue_tag.category = "theme"'] + [extra_where]})
+        extra={'where': ["catalogue_tag.category = 'theme'"] + [extra_where]})
     categories = split_tags(tags)
     
     form = forms.SearchForm()
@@ -73,29 +84,63 @@ def tagged_object_list(request, tags=''):
     if len([tag for tag in tags if tag.category == 'book']):
         raise Http404
     
-    model = models.Book
-    shelf = [tag for tag in tags if tag.category == 'set']
-    shelf_is_set = (len(tags) == 1 and tags[0].category == 'set')
-    theme_is_set = len([tag for tag in tags if tag.category == 'theme']) > 0
-    if theme_is_set:
-        model = models.Fragment
-
-    user_is_owner = (len(shelf) and request.user.is_authenticated() and request.user == shelf[0].user)
+    theme_is_set = [tag for tag in tags if tag.category == 'theme']
+    shelf_is_set = len(tags) == 1 and tags[0].category == 'set'
+    my_shelf_is_set = shelf_is_set and request.user.is_authenticated() and request.user == tags[0].user
     
-    extra_where = 'catalogue_tag.category NOT IN ("set", "book")'
-    related_tags = models.Tag.objects.related_for_model(tags, model, counts=True, extra={'where': [extra_where]})
-    categories = split_tags(related_tags)
-
-    if not (theme_is_set or shelf_is_set):
-        model=models.Book.objects.filter(parent=None)
+    objects = only_author = pd_counter = categories = None
     
-    return newtagging_views.tagged_object_list(
+    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)
+        
+        if shelf_tags:
+            books = models.Book.tagged.with_all(shelf_tags).order_by()
+            l_tags = [models.Tag.objects.get(slug = 'l-' + book.slug) for book in books]
+            fragments = models.Fragment.tagged.with_any(l_tags, fragments)
+        
+        related_tags = models.Tag.objects.usage_for_queryset(fragments, counts=True, 
+                            extra={'where': ["catalogue_tag.category != 'book'"]})
+        related_tags = (tag for tag in related_tags if tag not in fragment_tags)
+        categories = split_tags(related_tags)
+        
+        objects = fragments
+    else:
+        books = models.Book.tagged.with_all(tags).order_by()
+        l_tags = [models.Tag.objects.get(slug = 'l-' + book.slug) for book in books]
+        book_keys = [book.pk for book in books]
+        related_tags = models.Tag.objects.usage_for_queryset(books, counts=True, 
+                            extra={'where': ["catalogue_tag.category NOT IN ('set', 'book', 'theme')"]})
+        related_tags = (tag for tag in related_tags if tag not in tags)
+        categories = split_tags(related_tags)
+
+        fragments = models.Fragment.tagged.with_any(l_tags)
+        categories['theme'] = models.Tag.objects.usage_for_queryset(fragments, counts=True,  
+                            extra={'where': ["catalogue_tag.category = 'theme'"]})
+            
+        books = books.exclude(parent__in = book_keys)
+        objects = books
+        
+    if not objects:
+        only_author = len(tags) == 1 and tags[0].category == 'author'
+        pd_counter = only_author and tags[0].goes_to_pd()
+        objects = models.Book.objects.none()
+    
+    return object_list(
         request,
-        tag_model=models.Tag,
-        queryset_or_model=model,
-        tags=tags,
+        objects,
         template_name='catalogue/tagged_object_list.html',
-        extra_context = {'categories': categories, 'shelf_is_set': shelf_is_set, 'user_is_owner': user_is_owner },
+        extra_context = {
+            'categories': categories,
+            'shelf_is_set': shelf_is_set,
+            'only_author': only_author,
+            'pd_counter': pd_counter,
+            'user_is_owner': my_shelf_is_set,
+            'formats_form': forms.DownloadFormatsForm(),
+
+            'tags': tags,
+        }
     )
 
 
@@ -111,12 +156,16 @@ def book_fragments(request, book_slug, theme_slug):
 
 
 def book_detail(request, slug):
-    book = get_object_or_404(models.Book, slug=slug)
+    try:
+        book = models.Book.objects.get(slug=slug)
+    except models.Book.DoesNotExist:
+        return book_stub_detail(request, slug)
+
     book_tag = get_object_or_404(models.Tag, slug = 'l-' + slug)
     tags = list(book.tags.filter(~Q(category='set')))
     categories = split_tags(tags)
     book_children = book.children.all().order_by('parent_number')
-    extra_where = 'catalogue_tag.category = "theme"'
+    extra_where = "catalogue_tag.category = 'theme'"
     book_themes = models.Tag.objects.related_for_model(book_tag, models.Fragment, counts=True, extra={'where': [extra_where]})
     extra_info = book.get_extra_info_value()
     
@@ -125,6 +174,15 @@ def book_detail(request, slug):
         context_instance=RequestContext(request))
 
 
+def book_stub_detail(request, slug):
+    book = get_object_or_404(models.BookStub, slug=slug)
+    pd_counter = book.pd
+    form = forms.SearchForm()
+    
+    return render_to_response('catalogue/book_stub_detail.html', locals(),
+        context_instance=RequestContext(request))
+    
+
 def book_text(request, slug):
     book = get_object_or_404(models.Book, slug=slug)
     book_themes = {}
@@ -141,40 +199,138 @@ def book_text(request, slug):
 # ==========
 # = 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 """
+    return re.sub('(?u)(\W)', r'\\\1', query)
+
+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
+    print kwargs['%s__iregex' % name]
+
+    return Q(**kwargs)
+
+    
+def _sqlite_word_starts_with(name, prefix):
+    """ version of _word_starts_with for SQLite 
+    
+    SQLite in Django uses Python re module
+    """
+    kwargs = {}
+    prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
+    kwargs['%s__iregex' % name] = ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
+    return Q(**kwargs)
+
+
+if settings.DATABASE_ENGINE == 'sqlite3':
+    _word_starts_with = _sqlite_word_starts_with
+
+
 def _tags_starting_with(prefix, user):
-    books = models.Book.objects.filter(title__icontains=prefix)
-    tags = models.Tag.objects.filter(name__icontains=prefix)
+    prefix = prefix.lower()
+    book_stubs = models.BookStub.objects.filter(_word_starts_with('title', prefix))
+    books = models.Book.objects.filter(_word_starts_with('title', prefix))
+    book_stubs = filter(lambda x: x not in books, book_stubs)
+    tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
     if user.is_authenticated():
         tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
     else:
         tags = tags.filter(~Q(category='book') & ~Q(category='set'))
 
-    return list(books) + list(tags)
+    return list(books) + list(tags) + list(book_stubs)
         
 
+
+def _get_result_link(match, tag_list):
+    if isinstance(match, models.Book) or isinstance(match, models.BookStub):
+        return match.get_absolute_url()
+    else:
+        return reverse('catalogue.views.tagged_object_list', 
+            kwargs={'tags': '/'.join(tag.slug for tag in tag_list + [match])}
+        )
+
+def _get_result_type(match):
+    if isinstance(match, models.Book) or isinstance(match, models.BookStub):
+        type = 'book'
+    else:
+        type = match.category
+    return dict(models.TAG_CATEGORIES)[type]
+    
+
+
+def find_best_matches(query, user):
+    """ Finds a Book, Tag or Bookstub 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))
+    exact_matches = tuple(res for res in result if res.name.lower() == query)
+    if exact_matches:
+        return exact_matches
+    else:
+        return result[:1]    
+
+
 def search(request):
     tags = request.GET.get('tags', '')
     prefix = request.GET.get('q', '')
-    # Prefix must have at least 2 characters
-    if len(prefix) < 2:
-        return HttpResponse('')
     
     try:
         tag_list = models.Tag.get_tag_list(tags)
     except:
         tag_list = []
     
-    result = _tags_starting_with(prefix, request.user)
-    if len(result) > 0:
-        tag = result[0]
-        if isinstance(tag, models.Book):
-            return HttpResponseRedirect(tag.get_absolute_url())
-        else:
-            tag_list.append(tag)
-        
-    return HttpResponseRedirect(reverse('catalogue.views.tagged_object_list', 
-        kwargs={'tags': '/'.join(tag.slug for tag in 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:
+        return render_to_response('catalogue/search_no_hits.html', {'tags':tag_list, 'prefix':prefix},
+            context_instance=RequestContext(request))
 
 
 def tags_starting_with(request):
@@ -204,7 +360,7 @@ def book_sets(request, slug):
     book_sets = book.tags.filter(category='set', user=request.user)
     
     if not request.user.is_authenticated():
-        return HttpResponse('<p>Aby zarządzać swoimi półkami, musisz się zalogować.</p>')
+        return HttpResponse(_('<p>To maintain your shelves you need to be logged in.</p>'))
     
     if request.method == 'POST':
         form = forms.ObjectSetsForm(book, request.user, request.POST)
@@ -222,7 +378,7 @@ def book_sets(request, slug):
             
             book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
             if request.is_ajax():
-                return HttpResponse('<p>Półki zostały zapisane.</p>')
+                return HttpResponse(_('<p>Shelves were sucessfully saved.</p>'))
             else:
                 return HttpResponseRedirect('/')
     else:
@@ -240,12 +396,28 @@ def remove_from_shelf(request, shelf, book):
     book = get_object_or_404(models.Book, slug=book)
     shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
     
-    models.Tag.objects.remove_tag(book, shelf)
-    
-    shelf.book_count -= 1
-    shelf.save()
-    
-    return HttpResponse('Usunieto')
+    if shelf in book.tags:
+        models.Tag.objects.remove_tag(book, shelf)
+
+        shelf.book_count -= 1
+        shelf.save()
+
+        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
@@ -256,31 +428,34 @@ def download_shelf(request, slug):
     be used for large dynamic PDF files.                                        
     """
     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 = ['pdf', 'odt', 'txt', 'mp3', 'ogg']
+    
     # Create a ZIP archive
-    temp = temp = tempfile.TemporaryFile()
+    temp = tempfile.TemporaryFile()
     archive = zipfile.ZipFile(temp, 'w')
     
-    # Collect all books to include in ZIP archive
-    def collect_books(books):
-        result = []
-        for book in books:
-            if len(book.children.all()) == 0:
-                result.append(book)
-            else:
-                result += collect_books(book.children.all())
-        return result
-    
     for book in collect_books(models.Book.tagged.with_all(shelf)):
-        if book.pdf_file:
+        if 'pdf' in formats and book.pdf_file:
             filename = book.pdf_file.path
             archive.write(filename, str('%s.pdf' % book.slug))
-        if book.odt_file:
+        if 'odt' in formats and book.odt_file:
             filename = book.odt_file.path
             archive.write(filename, str('%s.odt' % book.slug))
-        if book.txt_file:
+        if 'txt' in formats and book.txt_file:
             filename = book.txt_file.path
             archive.write(filename, str('%s.txt' % book.slug))
+        if 'mp3' in formats and book.mp3_file:
+            filename = book.mp3_file.path
+            archive.write(filename, str('%s.mp3' % book.slug))
+        if 'ogg' in formats and book.ogg_file:
+            filename = book.ogg_file.path
+            archive.write(filename, str('%s.ogg' % book.slug))
     archive.close()
     
     response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
@@ -292,6 +467,30 @@ def download_shelf(request, slug):
     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 = {'pdf': False, 'odt': False, 'txt': False, 'mp3': False, 'ogg': False}
+    
+    for book in collect_books(models.Book.tagged.with_all(shelf)):
+        if book.pdf_file:
+            formats['pdf'] = True
+        if book.odt_file:
+            formats['odt'] = True
+        if book.txt_file:
+            formats['txt'] = True
+        if book.mp3_file:
+            formats['mp3'] = True
+        if book.ogg_file:
+            formats['ogg'] = True
+
+    return HttpResponse(LazyEncoder().encode(formats))
+
+
 @login_required
 @require_POST
 @cache.never_cache
@@ -301,7 +500,7 @@ def new_set(request):
         new_set = new_set_form.save(request.user)
 
         if request.is_ajax():
-            return HttpResponse(u'<p>Półka <strong>%s</strong> została utworzona</p>' % new_set)
+            return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully created</p>') % new_set)
         else:
             return HttpResponseRedirect('/')
 
@@ -316,7 +515,7 @@ def delete_shelf(request, slug):
     user_set.delete()
 
     if request.is_ajax():
-        return HttpResponse(u'<p>Półka <strong>%s</strong> została usunięta</p>' % user_set.name)
+        return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully removed</p>') % user_set.name)
     else:
         return HttpResponseRedirect('/')
 
@@ -356,7 +555,7 @@ def register(request):
 @cache.never_cache
 def logout_then_redirect(request):
     auth.logout(request)
-    return HttpResponseRedirect(request.GET.get('next', '/'))
+    return HttpResponseRedirect(urlquote_plus(request.GET.get('next', '/'), safe='/?='))
 
 
 
@@ -369,10 +568,23 @@ def import_book(request):
     """docstring for import_book"""
     book_import_form = forms.BookImportForm(request.POST, request.FILES)
     if book_import_form.is_valid():
-        # try:
-        book_import_form.save()
-        # except:
-            # return HttpResponse("Error importing book: %r" % (sys.exc_info(),))
-        return HttpResponse("Book imported successfully")
+        try:
+            book_import_form.save()
+        except:
+            info = sys.exc_info()
+            exception = pprint.pformat(info[1])
+            tb = '\n'.join(traceback.format_tb(info[2]))
+            _('Today is %(month)s, %(day)s.') % {'month': m, 'day': d}
+            return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
+        return HttpResponse(_("Book imported successfully"))
     else:
-        return HttpResponse("Error importing file: %r" % book_import_form.errors)
\ No newline at end of file
+        return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
+
+
+
+def clock(request):
+    """ Provides server time for jquery.countdown,
+    in a format suitable for Date.parse()
+    """
+    from datetime import datetime
+    return HttpResponse(datetime.now().strftime('%Y/%m/%d %H:%M:%S'))