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.
5 from collections import OrderedDict
9 from django.conf import settings
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, render, redirect
13 from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect, JsonResponse
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.http import urlquote_plus
18 from django.utils import translation
19 from django.utils.translation import ugettext as _, ugettext_lazy
21 from ajaxable.utils import AjaxableFormView
22 from pdcounter import models as pdcounter_models
23 from pdcounter import views as pdcounter_views
24 from picture.models import Picture, PictureArea
25 from picture.views import picture_list_thumb
26 from ssify import ssi_included, ssi_expect, SsiVariable as V
27 from suggest.forms import PublishingSuggestForm
28 from catalogue import constants
29 from catalogue import forms
30 from catalogue.helpers import get_top_level_related_tags
31 from catalogue import models
32 from catalogue.utils import split_tags
33 from catalogue.templatetags.catalogue_tags import tag_list, collection_list
35 staff_required = user_passes_test(lambda user: user.is_staff)
38 def catalogue(request, as_json=False):
39 books = models.Book.objects.filter(parent=None)
40 pictures = Picture.objects.all()
41 collections = models.Collection.objects.all()
42 return render(request, 'catalogue/catalogue.html', locals())
46 def catalogue_json(request):
47 return catalogue(request, True)
50 def book_list(request, filter=None, get_filter=None,
51 template_name='catalogue/book_list.html',
52 nav_template_name='catalogue/snippets/book_list_nav.html',
53 list_template_name='catalogue/snippets/book_list.html',
56 """ generates a listing of all books, optionally filtered with a test function """
59 books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
60 books_nav = OrderedDict()
61 for tag in books_by_author:
62 if books_by_author[tag]:
63 books_nav.setdefault(tag.sort_key[0], []).append(tag)
64 rendered_nav = render_to_string(nav_template_name, locals())
65 rendered_book_list = render_to_string(list_template_name, locals())
66 return render_to_response(template_name, locals(),
67 context_instance=RequestContext(request))
70 def audiobook_list(request):
71 books = models.Book.objects.filter(Q(media__type='mp3') | Q(media__type='ogg')).distinct()
74 best = random.sample(books, 3)
78 daisy = models.Book.objects.filter(media__type='daisy').distinct()
80 return render(request, 'catalogue/audiobook_list.html', {
87 def daisy_list(request):
88 return book_list(request, Q(media__type='daisy'),
89 template_name='catalogue/daisy_list.html',
93 def collection(request, slug):
94 coll = get_object_or_404(models.Collection, slug=slug)
95 return render(request, 'catalogue/collection.html',
99 def differentiate_tags(request, tags, ambiguous_slugs):
100 beginning = '/'.join(tag.url_chunk for tag in tags)
101 unparsed = '/'.join(ambiguous_slugs[1:])
103 for tag in models.Tag.objects.filter(slug=ambiguous_slugs[0]):
105 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
108 return render_to_response('catalogue/differentiate_tags.html',
109 {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
110 context_instance=RequestContext(request))
113 # TODO: Rewrite this hellish piece of code which tries to do everything
114 def tagged_object_list(request, tags='', gallery=False):
116 # preliminary tests and conditions
118 tags = models.Tag.get_tag_list(tags)
119 except models.Tag.DoesNotExist:
120 # Perhaps the user is asking about an author in Public Domain
121 # counter (they are not represented in tags)
122 chunks = tags.split('/')
123 if len(chunks) == 2 and chunks[0] == 'autor':
124 return pdcounter_views.author_detail(request, chunks[1])
127 except models.Tag.MultipleObjectsReturned, e:
128 # Ask the user to disambiguate
129 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
130 except models.Tag.UrlDeprecationWarning, e:
131 return HttpResponsePermanentRedirect(reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
134 if len(tags) > settings.MAX_TAG_LIST:
136 except AttributeError:
139 # beginning of digestion
140 theme_is_set = [tag for tag in tags if tag.category == 'theme']
141 shelf_is_set = [tag for tag in tags if tag.category == 'set']
142 only_shelf = shelf_is_set and len(tags) == 1
143 only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
144 tags_pks = [tag.pk for tag in tags]
149 # Only fragments (or pirctureareas) here.
150 shelf_tags = [tag for tag in tags if tag.category == 'set']
151 fragment_tags = [tag for tag in tags if tag.category != 'set']
153 fragments = PictureArea.tagged.with_all(fragment_tags)
155 fragments = models.Fragment.tagged.with_all(fragment_tags)
159 # TODO: Pictures on shelves not supported yet.
162 books = models.Book.tagged.with_all(shelf_tags).order_by()
163 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
165 categories = split_tags(
166 models.Tag.objects.usage_for_queryset(fragments, counts=True
167 ).exclude(pk__in=tags_pks),
174 # TODO: Pictures on shelves not supported yet.
178 objects = Picture.tagged.with_all(tags).order_by(
179 'sort_key_author', 'title')
181 objects = Picture.objects.all().order_by(
182 'sort_key_author', 'title')
183 areas = PictureArea.objects.filter(picture__in=objects)
184 categories = split_tags(
185 models.Tag.objects.usage_for_queryset(
186 objects, counts=True).exclude(pk__in=tags_pks),
187 models.Tag.objects.usage_for_queryset(
188 areas, counts=True).filter(
189 category__in=('theme', 'thing')).exclude(
194 all_books = models.Book.tagged.with_all(tags)
196 all_books = models.Book.objects.filter(parent=None)
198 objects = all_books.order_by('sort_key_author', 'title')
199 related_book_tags = models.Tag.objects.usage_for_queryset(
200 objects, counts=True).exclude(
201 category='set').exclude(pk__in=tags_pks)
204 objects = models.Book.tagged_top_level(tags).order_by(
205 'sort_key_author', 'title')
207 objects = all_books.order_by('sort_key_author', 'title')
208 related_book_tags = get_top_level_related_tags(tags)
210 fragments = models.Fragment.objects.filter(book__in=all_books)
212 categories = split_tags(
214 models.Tag.objects.usage_for_queryset(
215 fragments, counts=True).filter(
216 category='theme').exclude(pk__in=tags_pks),
219 objects = list(objects)
221 best = random.sample(objects, 3)
225 if not gallery and not objects and len(tags) == 1:
227 if (tag.category in ('theme', 'thing') and PictureArea.tagged.with_any([tag]).exists() or
228 Picture.tagged.with_any([tag]).exists()):
229 return redirect('tagged_object_list_gallery', raw_tags, permanent=False)
231 return render_to_response('catalogue/tagged_object_list.html',
233 'object_list': objects,
234 'categories': categories,
235 'only_shelf': only_shelf,
236 'only_my_shelf': only_my_shelf,
237 'formats_form': forms.DownloadFormatsForm(),
240 'theme_is_set': theme_is_set,
244 context_instance=RequestContext(request))
247 def book_fragments(request, slug, theme_slug):
248 book = get_object_or_404(models.Book, slug=slug)
249 theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
250 fragments = models.Fragment.tagged.with_all([theme]).filter(
251 Q(book=book) | Q(book__ancestor=book))
253 return render_to_response('catalogue/book_fragments.html', locals(),
254 context_instance=RequestContext(request))
257 def book_detail(request, slug):
259 book = models.Book.objects.get(slug=slug)
260 except models.Book.DoesNotExist:
261 return pdcounter_views.book_stub_detail(request, slug)
263 tags = book.tags.exclude(category__in=('set', 'theme'))
264 book_children = book.children.all().order_by('parent_number', 'sort_key')
265 return render_to_response('catalogue/book_detail.html', locals(),
266 context_instance=RequestContext(request))
269 def get_audiobooks(book):
271 for m in book.media.filter(type='ogg').order_by().iterator():
272 ogg_files[m.name] = m
277 for mp3 in book.media.filter(type='mp3').iterator():
278 # ogg files are always from the same project
279 meta = mp3.extra_info
280 project = meta.get('project')
283 project = u'CzytamySłuchając'
285 projects.add((project, meta.get('funded_by', '')))
289 ogg = ogg_files.get(mp3.name)
294 audiobooks.append(media)
296 projects = sorted(projects)
297 return audiobooks, projects, have_oggs
300 def player(request, slug):
301 book = get_object_or_404(models.Book, slug=slug)
302 if not book.has_media('mp3'):
305 audiobooks, projects, have_oggs = get_audiobooks(book)
307 extra_info = book.extra_info
309 return render_to_response('catalogue/player.html', locals(),
310 context_instance=RequestContext(request))
313 def book_text(request, slug):
314 book = get_object_or_404(models.Book, slug=slug)
316 if not book.has_html_file():
318 return render_to_response('catalogue/book_text.html', locals(),
319 context_instance=RequestContext(request))
326 def _no_diacritics_regexp(query):
327 """ returns a regexp for searching for a query without diacritics
329 should be locale-aware """
331 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źżŹŻ',
332 u'ą':u'ąĄ', u'ć':u'ćĆ', u'ę':u'ęĘ', u'ł': u'łŁ', u'ń':u'ńŃ', u'ó':u'óÓ', u'ś':u'śŚ', u'ź':u'źŹ', u'ż':u'żŻ'
336 return u"(%s)" % '|'.join(names[l])
337 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
339 def unicode_re_escape(query):
340 """ Unicode-friendly version of re.escape """
341 return re.sub(r'(?u)(\W)', r'\\\1', query)
343 def _word_starts_with(name, prefix):
344 """returns a Q object getting models having `name` contain a word
345 starting with `prefix`
347 We define word characters as alphanumeric and underscore, like in JS.
349 Works for MySQL, PostgreSQL, Oracle.
350 For SQLite, _sqlite* version is substituted for this.
354 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
355 # can't use [[:<:]] (word start),
356 # but we want both `xy` and `(xy` to catch `(xyz)`
357 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
362 def _word_starts_with_regexp(prefix):
363 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
364 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
367 def _sqlite_word_starts_with(name, prefix):
368 """ version of _word_starts_with for SQLite
370 SQLite in Django uses Python re module
373 kwargs['%s__iregex' % name] = _word_starts_with_regexp(prefix)
377 if hasattr(settings, 'DATABASES'):
378 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
379 _word_starts_with = _sqlite_word_starts_with
380 elif settings.DATABASE_ENGINE == 'sqlite3':
381 _word_starts_with = _sqlite_word_starts_with
385 def __init__(self, name, view):
388 self.lower = name.lower()
389 self.category = 'application'
391 return reverse(*self._view)
394 App(u'Leśmianator', (u'lesmianator', )),
398 def _tags_starting_with(prefix, user=None):
399 prefix = prefix.lower()
401 book_stubs = pdcounter_models.BookStub.objects.filter(_word_starts_with('title', prefix))
402 authors = pdcounter_models.Author.objects.filter(_word_starts_with('name', prefix))
404 books = models.Book.objects.filter(_word_starts_with('title', prefix))
405 tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
406 if user and user.is_authenticated():
407 tags = tags.filter(~Q(category='set') | Q(user=user))
409 tags = tags.exclude(category='set')
411 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
412 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + list(authors)
415 def _get_result_link(match, tag_list):
416 if isinstance(match, models.Tag):
417 return reverse('catalogue.views.tagged_object_list',
418 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])}
420 elif isinstance(match, App):
423 return match.get_absolute_url()
426 def _get_result_type(match):
427 if isinstance(match, models.Book) or isinstance(match, pdcounter_models.BookStub):
430 match_type = match.category
434 def books_starting_with(prefix):
435 prefix = prefix.lower()
436 return models.Book.objects.filter(_word_starts_with('title', prefix))
439 def find_best_matches(query, user=None):
440 """ Finds a models.Book, Tag, models.BookStub or Author best matching a query.
443 - zero elements when nothing is found,
444 - one element when a best result is found,
445 - more then one element on multiple exact matches
447 Raises a ValueError on too short a query.
450 query = query.lower()
452 raise ValueError("query must have at least two characters")
454 result = tuple(_tags_starting_with(query, user))
455 # remove pdcounter stuff
456 book_titles = set(match.pretty_title().lower() for match in result
457 if isinstance(match, models.Book))
458 authors = set(match.name.lower() for match in result
459 if isinstance(match, models.Tag) and match.category == 'author')
460 result = tuple(res for res in result if not (
461 (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles)
462 or (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
465 exact_matches = tuple(res for res in result if res.name.lower() == query)
469 return tuple(result)[:1]
473 tags = request.GET.get('tags', '')
474 prefix = request.GET.get('q', '')
477 tag_list = models.Tag.get_tag_list(tags)
482 result = find_best_matches(prefix, request.user)
484 return render_to_response('catalogue/search_too_short.html', {'tags':tag_list, 'prefix':prefix},
485 context_instance=RequestContext(request))
488 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
489 elif len(result) > 1:
490 return render_to_response('catalogue/search_multiple_hits.html',
491 {'tags':tag_list, 'prefix':prefix, 'results':((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)},
492 context_instance=RequestContext(request))
494 form = PublishingSuggestForm(initial={"books": prefix + ", "})
495 return render_to_response('catalogue/search_no_hits.html',
496 {'tags':tag_list, 'prefix':prefix, "pubsuggest_form": form},
497 context_instance=RequestContext(request))
500 def tags_starting_with(request):
501 prefix = request.GET.get('q', '')
502 # Prefix must have at least 2 characters
504 return HttpResponse('')
507 for tag in _tags_starting_with(prefix, request.user):
508 if not tag.name in tags_list:
509 result += "\n" + tag.name
510 tags_list.append(tag.name)
511 return HttpResponse(result)
513 def json_tags_starting_with(request, callback=None):
515 prefix = request.GET.get('q', '')
516 callback = request.GET.get('callback', '')
517 # Prefix must have at least 2 characters
519 return HttpResponse('')
521 for tag in _tags_starting_with(prefix, request.user):
522 if not tag.name in tags_list:
523 tags_list.append(tag.name)
524 if request.GET.get('mozhint', ''):
525 result = [prefix, tags_list]
527 result = {"matches": tags_list}
528 response = JsonResponse(result, safe=False)
530 response.content = callback + "(" + response.content + ");"
539 def import_book(request):
540 """docstring for import_book"""
541 book_import_form = forms.BookImportForm(request.POST, request.FILES)
542 if book_import_form.is_valid():
544 book_import_form.save()
549 info = sys.exc_info()
550 exception = pprint.pformat(info[1])
551 tb = '\n'.join(traceback.format_tb(info[2]))
552 return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
553 return HttpResponse(_("Book imported successfully"))
555 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
560 def book_info(request, id, lang='pl'):
561 book = get_object_or_404(models.Book, id=id)
562 # set language by hand
563 translation.activate(lang)
564 return render_to_response('catalogue/book_info.html', locals(),
565 context_instance=RequestContext(request))
568 def tag_info(request, id):
569 tag = get_object_or_404(models.Tag, id=id)
570 return HttpResponse(tag.description)
573 def download_zip(request, format, slug=None):
575 if format in models.Book.ebook_formats:
576 url = models.Book.zip_format(format)
577 elif format in ('mp3', 'ogg') and slug is not None:
578 book = get_object_or_404(models.Book, slug=slug)
579 url = book.zip_audiobooks(format)
581 raise Http404('No format specified for zip package')
582 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
585 class CustomPDFFormView(AjaxableFormView):
586 form_class = forms.CustomPDFForm
587 title = ugettext_lazy('Download custom PDF')
588 submit = ugettext_lazy('Download')
591 def __call__(self, *args, **kwargs):
592 if settings.NO_CUSTOM_PDF:
593 raise Http404('Custom PDF is disabled')
594 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
596 def form_args(self, request, obj):
597 """Override to parse view args and give additional args to the form."""
600 def get_object(self, request, slug, *args, **kwargs):
601 return get_object_or_404(models.Book, slug=slug)
603 def context_description(self, request, obj):
604 return obj.pretty_title()
613 def book_mini(request, pk, with_link=True):
614 book = get_object_or_404(models.Book, pk=pk)
615 author_str = ", ".join(tag.name
616 for tag in book.tags.filter(category='author'))
617 return render(request, 'catalogue/book_mini_box.html', {
619 'author_str': author_str,
620 'with_link': with_link,
621 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
625 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
626 ('ssify.get_csrf_token',),
627 ('social_tags.likes_book', (ipk,)),
628 ('social_tags.book_shelf_tags', (ipk,)),
629 ))(ssi_expect(pk, int)))
630 def book_short(request, pk):
631 book = get_object_or_404(models.Book, pk=pk)
632 stage_note, stage_note_url = book.stage_note()
633 audiobooks, projects, have_oggs = get_audiobooks(book)
635 return render(request, 'catalogue/book_short.html', {
637 'has_audio': book.has_media('mp3'),
638 'main_link': book.get_absolute_url(),
639 'parents': book.parents(),
640 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
641 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
642 'stage_note': stage_note,
643 'stage_note_url': stage_note_url,
644 'audiobooks': audiobooks,
645 'have_oggs': have_oggs,
649 @ssi_included(get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
651 ('social_tags.choose_cite', [ipk]),
652 ('catalogue_tags.choose_fragment', [ipk], {
653 'unless': V('social_tags.choose_cite', [ipk])}),
654 ))(ssi_expect(pk, int)))
655 def book_wide(request, pk):
656 book = get_object_or_404(models.Book, pk=pk)
657 stage_note, stage_note_url = book.stage_note()
658 extra_info = book.extra_info
659 audiobooks, projects, have_oggs = get_audiobooks(book)
661 return render(request, 'catalogue/book_wide.html', {
663 'has_audio': book.has_media('mp3'),
664 'parents': book.parents(),
665 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
666 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
667 'stage_note': stage_note,
668 'stage_note_url': stage_note_url,
670 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
671 'extra_info': extra_info,
672 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
673 'audiobooks': audiobooks,
674 'have_oggs': have_oggs,
679 def fragment_short(request, pk):
680 fragment = get_object_or_404(models.Fragment, pk=pk)
681 return render(request, 'catalogue/fragment_short.html',
682 {'fragment': fragment})
686 def fragment_promo(request, pk):
687 fragment = get_object_or_404(models.Fragment, pk=pk)
688 return render(request, 'catalogue/fragment_promo.html', {
694 def tag_box(request, pk):
695 tag = get_object_or_404(models.Tag, pk=pk)
696 assert tag.category != 'set'
698 return render(request, 'catalogue/tag_box.html', {
704 def collection_box(request, pk):
705 obj = get_object_or_404(models.Collection, pk=pk)
707 return render(request, 'catalogue/collection_box.html', {
712 def tag_catalogue(request, category):
713 if category == 'theme':
714 tags = models.Tag.objects.usage_for_model(
715 models.Fragment, counts=True).filter(category='theme')
717 tags = list(get_top_level_related_tags((), categories=(category,)))
720 best = random.sample(tags, 3)
724 return render(request, 'catalogue/tag_catalogue.html', {
727 'title': constants.CATEGORIES_NAME_PLURAL[category],
731 def collections(request):
732 objects = models.Collection.objects.all()
735 best = random.sample(objects, 3)
739 return render(request, 'catalogue/collections.html', {