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