apps/catalogue/views.py

   1 # -*- coding: utf-8 -*-
   2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   4 #
   5 import re
   6 import itertools
   7
   8 from django.conf import settings
   9 from django.core.cache import get_cache
  10 from django.template import RequestContext
  11 from django.template.loader import render_to_string
  12 from django.shortcuts import render_to_response, get_object_or_404, redirect
  13 from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
  14 from django.core.urlresolvers import reverse
  15 from django.db.models import Q
  16 from django.contrib.auth.decorators import login_required, user_passes_test
  17 from django.utils.datastructures import SortedDict
  18 from django.utils.http import urlquote_plus
  19 from django.utils import translation
  20 from django.utils.translation import get_language, ugettext as _, ugettext_lazy
  21 from django.views.decorators.vary import vary_on_headers
  22
  23 from ajaxable.utils import JSONResponse, AjaxableFormView
  24 from catalogue import models
  25 from catalogue import forms
  26 from catalogue.utils import split_tags, MultiQuerySet
  27 from catalogue.templatetags.catalogue_tags import tag_list, collection_list
  28 from pdcounter import models as pdcounter_models
  29 from pdcounter import views as pdcounter_views
  30 from suggest.forms import PublishingSuggestForm
  31 from picture.models import Picture
  32
  33 staff_required = user_passes_test(lambda user: user.is_staff)
  34 permanent_cache = get_cache('permanent')
  35
  36
  37 @vary_on_headers('X-Requested-With')
  38 def catalogue(request):
  39     cache_key='catalogue.catalogue/' + get_language()
  40     output = permanent_cache.get(cache_key)
  41     if output is None:
  42         tags = models.Tag.objects.exclude(
  43             category__in=('set', 'book')).exclude(book_count=0)
  44         tags = list(tags)
  45         for tag in tags:
  46             tag.count = tag.book_count
  47         categories = split_tags(tags)
  48         fragment_tags = categories.get('theme', [])
  49         collections = models.Collection.objects.all()
  50         render_tag_list = lambda x: render_to_string(
  51             'catalogue/tag_list.html', tag_list(x))
  52         output = {'theme': render_tag_list(fragment_tags)}
  53         for category, tags in categories.items():
  54             output[category] = render_tag_list(tags)
  55         output['collections'] = render_to_string(
  56             'catalogue/collection_list.html', collection_list(collections))
  57         permanent_cache.set(cache_key, output)
  58     if request.is_ajax():
  59         return JSONResponse(output)
  60     else:
  61         return render_to_response('catalogue/catalogue.html', locals(),
  62             context_instance=RequestContext(request))
  63
  64
  65 def book_list(request, filter=None, get_filter=None,
  66         template_name='catalogue/book_list.html',
  67         nav_template_name='catalogue/snippets/book_list_nav.html',
  68         list_template_name='catalogue/snippets/book_list.html',
  69         cache_key='catalogue.book_list',
  70         context=None,
  71         ):
  72     """ generates a listing of all books, optionally filtered with a test function """
  73     cache_key = "%s/%s" % (cache_key, get_language())
  74     cached = permanent_cache.get(cache_key)
  75     if cached is not None:
  76         rendered_nav, rendered_book_list = cached
  77     else:
  78         if get_filter:
  79             filter = get_filter()
  80         books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
  81         books_nav = SortedDict()
  82         for tag in books_by_author:
  83             if books_by_author[tag]:
  84                 books_nav.setdefault(tag.sort_key[0], []).append(tag)
  85         rendered_nav = render_to_string(nav_template_name, locals())
  86         rendered_book_list = render_to_string(list_template_name, locals())
  87         permanent_cache.set(cache_key, (rendered_nav, rendered_book_list))
  88     return render_to_response(template_name, locals(),
  89         context_instance=RequestContext(request))
  90
  91
  92 def audiobook_list(request):
  93     return book_list(request, Q(media__type='mp3') | Q(media__type='ogg'),
  94                      template_name='catalogue/audiobook_list.html',
  95                      list_template_name='catalogue/snippets/audiobook_list.html',
  96                      cache_key='catalogue.audiobook_list')
  97
  98
  99 def daisy_list(request):
 100     return book_list(request, Q(media__type='daisy'),
 101                      template_name='catalogue/daisy_list.html',
 102                      cache_key='catalogue.daisy_list')
 103
 104
 105 def collection(request, slug):
 106     coll = get_object_or_404(models.Collection, slug=slug)
 107     return book_list(request, get_filter=coll.get_query,
 108                      template_name='catalogue/collection.html',
 109                      cache_key='catalogue.collection:%s' % coll.slug,
 110                      context={'collection': coll})
 111
 112
 113 def differentiate_tags(request, tags, ambiguous_slugs):
 114     beginning = '/'.join(tag.url_chunk for tag in tags)
 115     unparsed = '/'.join(ambiguous_slugs[1:])
 116     options = []
 117     for tag in models.Tag.objects.exclude(category='book').filter(slug=ambiguous_slugs[0]):
 118         options.append({
 119             'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
 120             'tags': [tag]
 121         })
 122     return render_to_response('catalogue/differentiate_tags.html',
 123                 {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
 124                 context_instance=RequestContext(request))
 125
 126
 127 def tagged_object_list(request, tags=''):
 128     try:
 129         tags = models.Tag.get_tag_list(tags)
 130     except models.Tag.DoesNotExist:
 131         chunks = tags.split('/')
 132         if len(chunks) == 2 and chunks[0] == 'autor':
 133             return pdcounter_views.author_detail(request, chunks[1])
 134         else:
 135             raise Http404
 136     except models.Tag.MultipleObjectsReturned, e:
 137         return differentiate_tags(request, e.tags, e.ambiguous_slugs)
 138     except models.Tag.UrlDeprecationWarning, e:
 139         return HttpResponsePermanentRedirect(reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
 140
 141     try:
 142         if len(tags) > settings.MAX_TAG_LIST:
 143             raise Http404
 144     except AttributeError:
 145         pass
 146
 147     if len([tag for tag in tags if tag.category == 'book']):
 148         raise Http404
 149
 150     theme_is_set = [tag for tag in tags if tag.category == 'theme']
 151     shelf_is_set = [tag for tag in tags if tag.category == 'set']
 152     only_shelf = shelf_is_set and len(tags) == 1
 153     only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
 154
 155     objects = only_author = None
 156     categories = {}
 157
 158     if theme_is_set:
 159         shelf_tags = [tag for tag in tags if tag.category == 'set']
 160         fragment_tags = [tag for tag in tags if tag.category != 'set']
 161         fragments = models.Fragment.tagged.with_all(fragment_tags)
 162
 163         if shelf_tags:
 164             books = models.Book.tagged.with_all(shelf_tags).order_by()
 165             l_tags = models.Tag.objects.filter(category='book',
 166                 slug__in=[book.book_tag_slug() for book in books.iterator()])
 167             fragments = models.Fragment.tagged.with_any(l_tags, fragments)
 168
 169         # newtagging goes crazy if we just try:
 170         #related_tags = models.Tag.objects.usage_for_queryset(fragments, counts=True,
 171         #                    extra={'where': ["catalogue_tag.category != 'book'"]})
 172         fragment_keys = [fragment.pk for fragment in fragments.iterator()]
 173         if fragment_keys:
 174             related_tags = models.Fragment.tags.usage(counts=True,
 175                                 filters={'pk__in': fragment_keys},
 176                                 extra={'where': ["catalogue_tag.category != 'book'"]})
 177             related_tags = (tag for tag in related_tags if tag not in fragment_tags)
 178             categories = split_tags(related_tags)
 179
 180             objects = fragments
 181     else:
 182         if shelf_is_set:
 183             objects = models.Book.tagged.with_all(tags)
 184         else:
 185             objects = models.Book.tagged_top_level(tags)
 186
 187         # get related tags from `tag_counter` and `theme_counter`
 188         related_counts = {}
 189         tags_pks = [tag.pk for tag in tags]
 190         for book in objects:
 191             for tag_pk, value in itertools.chain(book.tag_counter.iteritems(), book.theme_counter.iteritems()):
 192                 if tag_pk in tags_pks:
 193                     continue
 194                 related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
 195         related_tags = models.Tag.objects.filter(pk__in=related_counts.keys())
 196         related_tags = [tag for tag in related_tags if tag not in tags]
 197         for tag in related_tags:
 198             tag.count = related_counts[tag.pk]
 199
 200         categories = split_tags(related_tags)
 201         del related_tags
 202
 203     if not objects:
 204         only_author = len(tags) == 1 and tags[0].category == 'author'
 205         objects = models.Book.objects.none()
 206
 207     # Add pictures
 208     objects = MultiQuerySet(Picture.tagged.with_all(tags), objects)
 209
 210     return render_to_response('catalogue/tagged_object_list.html',
 211         {
 212             'object_list': objects,
 213             'categories': categories,
 214             'only_shelf': only_shelf,
 215             'only_author': only_author,
 216             'only_my_shelf': only_my_shelf,
 217             'formats_form': forms.DownloadFormatsForm(),
 218             'tags': tags,
 219             'theme_is_set': theme_is_set,
 220         },
 221         context_instance=RequestContext(request))
 222
 223
 224 def book_fragments(request, slug, theme_slug):
 225     book = get_object_or_404(models.Book, slug=slug)
 226
 227     book_tag = book.book_tag()
 228     theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
 229     fragments = models.Fragment.tagged.with_all([book_tag, theme])
 230
 231     return render_to_response('catalogue/book_fragments.html', locals(),
 232         context_instance=RequestContext(request))
 233
 234
 235 def book_detail(request, slug):
 236     try:
 237         book = models.Book.objects.get(slug=slug)
 238     except models.Book.DoesNotExist:
 239         return pdcounter_views.book_stub_detail(request, slug)
 240
 241     book_children = book.children.all().order_by('parent_number', 'sort_key')
 242     return render_to_response('catalogue/book_detail.html', locals(),
 243         context_instance=RequestContext(request))
 244
 245
 246 def player(request, slug):
 247     book = get_object_or_404(models.Book, slug=slug)
 248     if not book.has_media('mp3'):
 249         raise Http404
 250
 251     ogg_files = {}
 252     for m in book.media.filter(type='ogg').order_by().iterator():
 253         ogg_files[m.name] = m
 254
 255     audiobooks = []
 256     have_oggs = True
 257     projects = set()
 258     for mp3 in book.media.filter(type='mp3').iterator():
 259         # ogg files are always from the same project
 260         meta = mp3.extra_info
 261         project = meta.get('project')
 262         if not project:
 263             # temporary fallback
 264             project = u'CzytamySłuchając'
 265
 266         projects.add((project, meta.get('funded_by', '')))
 267
 268         media = {'mp3': mp3}
 269
 270         ogg = ogg_files.get(mp3.name)
 271         if ogg:
 272             media['ogg'] = ogg
 273         else:
 274             have_oggs = False
 275         audiobooks.append(media)
 276
 277     projects = sorted(projects)
 278
 279     extra_info = book.extra_info
 280
 281     return render_to_response('catalogue/player.html', locals(),
 282         context_instance=RequestContext(request))
 283
 284
 285 def book_text(request, slug):
 286     book = get_object_or_404(models.Book, slug=slug)
 287
 288     if not book.has_html_file():
 289         raise Http404
 290     related = book.related_info()
 291     return render_to_response('catalogue/book_text.html', locals(),
 292         context_instance=RequestContext(request))
 293
 294
 295 # ==========
 296 # = Search =
 297 # ==========
 298
 299 def _no_diacritics_regexp(query):
 300     """ returns a regexp for searching for a query without diacritics
 301
 302     should be locale-aware """
 303     names = {
 304         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źżŹŻ',
 305         u'ą':u'ąĄ', u'ć':u'ćĆ', u'ę':u'ęĘ', u'ł': u'łŁ', u'ń':u'ńŃ', u'ó':u'óÓ', u'ś':u'śŚ', u'ź':u'źŹ', u'ż':u'żŻ'
 306         }
 307     def repl(m):
 308         l = m.group()
 309         return u"(%s)" % '|'.join(names[l])
 310     return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
 311
 312 def unicode_re_escape(query):
 313     """ Unicode-friendly version of re.escape """
 314     return re.sub('(?u)(\W)', r'\\\1', query)
 315
 316 def _word_starts_with(name, prefix):
 317     """returns a Q object getting models having `name` contain a word
 318     starting with `prefix`
 319
 320     We define word characters as alphanumeric and underscore, like in JS.
 321
 322     Works for MySQL, PostgreSQL, Oracle.
 323     For SQLite, _sqlite* version is substituted for this.
 324     """
 325     kwargs = {}
 326
 327     prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
 328     # can't use [[:<:]] (word start),
 329     # but we want both `xy` and `(xy` to catch `(xyz)`
 330     kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
 331
 332     return Q(**kwargs)
 333
 334
 335 def _word_starts_with_regexp(prefix):
 336     prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
 337     return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
 338
 339
 340 def _sqlite_word_starts_with(name, prefix):
 341     """ version of _word_starts_with for SQLite
 342
 343     SQLite in Django uses Python re module
 344     """
 345     kwargs = {}
 346     kwargs['%s__iregex' % name] = _word_starts_with_regexp(prefix)
 347     return Q(**kwargs)
 348
 349
 350 if hasattr(settings, 'DATABASES'):
 351     if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
 352         _word_starts_with = _sqlite_word_starts_with
 353 elif settings.DATABASE_ENGINE == 'sqlite3':
 354     _word_starts_with = _sqlite_word_starts_with
 355
 356
 357 class App():
 358     def __init__(self, name, view):
 359         self.name = name
 360         self._view = view
 361         self.lower = name.lower()
 362         self.category = 'application'
 363     def view(self):
 364         return reverse(*self._view)
 365
 366 _apps = (
 367     App(u'Leśmianator', (u'lesmianator', )),
 368     )
 369
 370
 371 def _tags_starting_with(prefix, user=None):
 372     prefix = prefix.lower()
 373     # PD counter
 374     book_stubs = pdcounter_models.BookStub.objects.filter(_word_starts_with('title', prefix))
 375     authors = pdcounter_models.Author.objects.filter(_word_starts_with('name', prefix))
 376
 377     books = models.Book.objects.filter(_word_starts_with('title', prefix))
 378     tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
 379     if user and user.is_authenticated():
 380         tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
 381     else:
 382         tags = tags.filter(~Q(category='book') & ~Q(category='set'))
 383
 384     prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
 385     return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + list(authors)
 386
 387
 388 def _get_result_link(match, tag_list):
 389     if isinstance(match, models.Tag):
 390         return reverse('catalogue.views.tagged_object_list',
 391             kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])}
 392         )
 393     elif isinstance(match, App):
 394         return match.view()
 395     else:
 396         return match.get_absolute_url()
 397
 398
 399 def _get_result_type(match):
 400     if isinstance(match, models.Book) or isinstance(match, pdcounter_models.BookStub):
 401         type = 'book'
 402     else:
 403         type = match.category
 404     return type
 405
 406
 407 def books_starting_with(prefix):
 408     prefix = prefix.lower()
 409     return models.Book.objects.filter(_word_starts_with('title', prefix))
 410
 411
 412 def find_best_matches(query, user=None):
 413     """ Finds a models.Book, Tag, models.BookStub or Author best matching a query.
 414
 415     Returns a with:
 416       - zero elements when nothing is found,
 417       - one element when a best result is found,
 418       - more then one element on multiple exact matches
 419
 420     Raises a ValueError on too short a query.
 421     """
 422
 423     query = query.lower()
 424     if len(query) < 2:
 425         raise ValueError("query must have at least two characters")
 426
 427     result = tuple(_tags_starting_with(query, user))
 428     # remove pdcounter stuff
 429     book_titles = set(match.pretty_title().lower() for match in result
 430                       if isinstance(match, models.Book))
 431     authors = set(match.name.lower() for match in result
 432                   if isinstance(match, models.Tag) and match.category=='author')
 433     result = tuple(res for res in result if not (
 434                  (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles)
 435                  or (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
 436              ))
 437
 438     exact_matches = tuple(res for res in result if res.name.lower() == query)
 439     if exact_matches:
 440         return exact_matches
 441     else:
 442         return tuple(result)[:1]
 443
 444
 445 def search(request):
 446     tags = request.GET.get('tags', '')
 447     prefix = request.GET.get('q', '')
 448
 449     try:
 450         tag_list = models.Tag.get_tag_list(tags)
 451     except:
 452         tag_list = []
 453
 454     try:
 455         result = find_best_matches(prefix, request.user)
 456     except ValueError:
 457         return render_to_response('catalogue/search_too_short.html', {'tags':tag_list, 'prefix':prefix},
 458             context_instance=RequestContext(request))
 459
 460     if len(result) == 1:
 461         return HttpResponseRedirect(_get_result_link(result[0], tag_list))
 462     elif len(result) > 1:
 463         return render_to_response('catalogue/search_multiple_hits.html',
 464             {'tags':tag_list, 'prefix':prefix, 'results':((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)},
 465             context_instance=RequestContext(request))
 466     else:
 467         form = PublishingSuggestForm(initial={"books": prefix + ", "})
 468         return render_to_response('catalogue/search_no_hits.html',
 469             {'tags':tag_list, 'prefix':prefix, "pubsuggest_form": form},
 470             context_instance=RequestContext(request))
 471
 472
 473 def tags_starting_with(request):
 474     prefix = request.GET.get('q', '')
 475     # Prefix must have at least 2 characters
 476     if len(prefix) < 2:
 477         return HttpResponse('')
 478     tags_list = []
 479     result = ""
 480     for tag in _tags_starting_with(prefix, request.user):
 481         if not tag.name in tags_list:
 482             result += "\n" + tag.name
 483             tags_list.append(tag.name)
 484     return HttpResponse(result)
 485
 486 def json_tags_starting_with(request, callback=None):
 487     # Callback for JSONP
 488     prefix = request.GET.get('q', '')
 489     callback = request.GET.get('callback', '')
 490     # Prefix must have at least 2 characters
 491     if len(prefix) < 2:
 492         return HttpResponse('')
 493     tags_list = []
 494     for tag in _tags_starting_with(prefix, request.user):
 495         if not tag.name in tags_list:
 496             tags_list.append(tag.name)
 497     if request.GET.get('mozhint', ''):
 498         result = [prefix, tags_list]
 499     else:
 500         result = {"matches": tags_list}
 501     return JSONResponse(result, callback)
 502
 503
 504 # =========
 505 # = Admin =
 506 # =========
 507 @login_required
 508 @staff_required
 509 def import_book(request):
 510     """docstring for import_book"""
 511     book_import_form = forms.BookImportForm(request.POST, request.FILES)
 512     if book_import_form.is_valid():
 513         try:
 514             book_import_form.save()
 515         except:
 516             import sys
 517             import pprint
 518             import traceback
 519             info = sys.exc_info()
 520             exception = pprint.pformat(info[1])
 521             tb = '\n'.join(traceback.format_tb(info[2]))
 522             return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
 523         return HttpResponse(_("Book imported successfully"))
 524     else:
 525         return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
 526
 527
 528 # info views for API
 529
 530 def book_info(request, id, lang='pl'):
 531     book = get_object_or_404(models.Book, id=id)
 532     # set language by hand
 533     translation.activate(lang)
 534     return render_to_response('catalogue/book_info.html', locals(),
 535         context_instance=RequestContext(request))
 536
 537
 538 def tag_info(request, id):
 539     tag = get_object_or_404(models.Tag, id=id)
 540     return HttpResponse(tag.description)
 541
 542
 543 def download_zip(request, format, slug=None):
 544     url = None
 545     if format in models.Book.ebook_formats:
 546         url = models.Book.zip_format(format)
 547     elif format in ('mp3', 'ogg') and slug is not None:
 548         book = get_object_or_404(models.Book, slug=slug)
 549         url = book.zip_audiobooks(format)
 550     else:
 551         raise Http404('No format specified for zip package')
 552     return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
 553
 554
 555 class CustomPDFFormView(AjaxableFormView):
 556     form_class = forms.CustomPDFForm
 557     title = ugettext_lazy('Download custom PDF')
 558     submit = ugettext_lazy('Download')
 559     honeypot = True
 560
 561     def __call__(self, *args, **kwargs):
 562         if settings.NO_CUSTOM_PDF:
 563             raise Http404('Custom PDF is disabled')
 564         return super(CustomPDFFormView, self).__call__(*args, **kwargs)
 565
 566     def form_args(self, request, obj):
 567         """Override to parse view args and give additional args to the form."""
 568         return (obj,), {}
 569
 570     def get_object(self, request, slug, *args, **kwargs):
 571         return get_object_or_404(models.Book, slug=slug)
 572
 573     def context_description(self, request, obj):
 574         return obj.pretty_title()