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.models import BookStub, Author
23 from pdcounter import views as pdcounter_views
24 from picture.models import Picture, PictureArea
25 from ssify import ssi_included, ssi_expect, SsiVariable as Var
26 from suggest.forms import PublishingSuggestForm
27 from catalogue import constants
28 from catalogue import forms
29 from catalogue.helpers import get_top_level_related_tags
30 from catalogue.models import Book, Collection, Tag, Fragment
31 from catalogue.utils import split_tags
33 staff_required = user_passes_test(lambda user: user.is_staff)
36 def catalogue(request):
37 return render(request, 'catalogue/catalogue.html', {
38 'books': Book.objects.filter(parent=None),
39 'pictures': Picture.objects.all(),
40 'collections': Collection.objects.all(),
41 'active_menu_item': 'all_works',
45 def book_list(request, filters=None, template_name='catalogue/book_list.html',
46 nav_template_name='catalogue/snippets/book_list_nav.html',
47 list_template_name='catalogue/snippets/book_list.html'):
48 """ generates a listing of all books, optionally filtered """
49 books_by_author, orphans, books_by_parent = Book.book_list(filters)
50 books_nav = OrderedDict()
51 for tag in books_by_author:
52 if books_by_author[tag]:
53 books_nav.setdefault(tag.sort_key[0], []).append(tag)
54 # WTF: dlaczego nie include?
55 return render_to_response(template_name, {
56 'rendered_nav': render_to_string(nav_template_name, {'books_nav': books_nav}),
57 'rendered_book_list': render_to_string(list_template_name, {
58 'books_by_author': books_by_author,
60 'books_by_parent': books_by_parent,
62 }, context_instance=RequestContext(request))
65 def daisy_list(request):
66 return book_list(request, Q(media__type='daisy'), template_name='catalogue/daisy_list.html')
69 def collection(request, slug):
70 coll = get_object_or_404(Collection, slug=slug)
71 return render(request, 'catalogue/collection.html', {'collection': coll})
74 def differentiate_tags(request, tags, ambiguous_slugs):
75 beginning = '/'.join(tag.url_chunk for tag in tags)
76 unparsed = '/'.join(ambiguous_slugs[1:])
78 for tag in Tag.objects.filter(slug=ambiguous_slugs[0]):
80 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
83 return render_to_response(
84 'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
85 context_instance=RequestContext(request))
88 def object_list(request, objects, fragments=None, related_tags=None, tags=None, list_type='books', extra=None):
91 tag_ids = [tag.pk for tag in tags]
93 related_tag_lists = []
95 related_tag_lists.append(related_tags)
97 related_tag_lists.append(
98 Tag.objects.usage_for_queryset(objects, counts=True).exclude(category='set').exclude(pk__in=tag_ids))
99 if not (extra and extra.get('theme_is_set')):
100 if fragments is None:
101 if list_type == 'gallery':
102 fragments = PictureArea.objects.filter(picture__in=objects)
104 fragments = Fragment.objects.filter(book__in=objects)
105 related_tag_lists.append(
106 Tag.objects.usage_for_queryset(fragments, counts=True).filter(category='theme').exclude(pk__in=tag_ids))
108 categories = split_tags(*related_tag_lists)
110 objects = list(objects)
112 best = random.sample(objects, 3)
117 'object_list': objects,
118 'categories': categories,
119 'list_type': list_type,
122 'formats_form': forms.DownloadFormatsForm(),
124 'active_menu_item': list_type,
128 return render_to_response(
129 'catalogue/tagged_object_list.html', result,
130 context_instance=RequestContext(request))
133 def literature(request):
134 books = Book.objects.filter(parent=None)
136 last_published = Book.objects.exclude(cover_thumb='').filter(parent=None).order_by('-created_at')[:20]
137 most_popular = Book.objects.exclude(cover_thumb='')\
138 .order_by('-popularity__count', 'sort_key_author', 'sort_key')[:20]
139 return object_list(request, books, related_tags=get_top_level_related_tags([]), extra={
140 'last_published': last_published,
141 'most_popular': most_popular,
145 def gallery(request):
146 return object_list(request, Picture.objects.all(), list_type='gallery')
149 def audiobooks(request):
150 audiobooks = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
151 return object_list(request, audiobooks, list_type='audiobooks', extra={
152 'daisy': Book.objects.filter(media__type='daisy').distinct(),
156 class ResponseInstead(Exception):
157 def __init__(self, response):
158 super(ResponseInstead, self).__init__()
159 self.response = response
162 def analyse_tags(request, tag_str):
164 tags = Tag.get_tag_list(tag_str)
165 except Tag.DoesNotExist:
166 # Perhaps the user is asking about an author in Public Domain
167 # counter (they are not represented in tags)
168 chunks = tag_str.split('/')
169 if len(chunks) == 2 and chunks[0] == 'autor':
170 raise ResponseInstead(pdcounter_views.author_detail(request, chunks[1]))
173 except Tag.MultipleObjectsReturned, e:
174 # Ask the user to disambiguate
175 raise ResponseInstead(differentiate_tags(request, e.tags, e.ambiguous_slugs))
176 except Tag.UrlDeprecationWarning, e:
177 raise ResponseInstead(HttpResponsePermanentRedirect(
178 reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)])))
181 if len(tags) > settings.MAX_TAG_LIST:
183 except AttributeError:
189 def theme_list(request, tags, list_type):
190 shelf_tags = [tag for tag in tags if tag.category == 'set']
191 fragment_tags = [tag for tag in tags if tag.category != 'set']
192 if list_type == 'gallery':
193 fragments = PictureArea.tagged.with_all(fragment_tags)
195 fragments = Fragment.tagged.with_all(fragment_tags)
198 # TODO: Pictures on shelves not supported yet.
199 books = Book.tagged.with_all(shelf_tags).order_by()
200 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
202 if not fragments and len(tags) == 1:
204 if tag.category == 'theme' and (
205 PictureArea.tagged.with_any([tag]).exists() or
206 Picture.tagged.with_any([tag]).exists()):
207 return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
209 return object_list(request, fragments, tags=tags, list_type=list_type, extra={
210 'theme_is_set': True,
211 'active_menu_item': 'theme',
215 def tagged_object_list(request, tags, list_type):
217 tags = analyse_tags(request, tags)
218 except ResponseInstead as e:
221 if list_type == 'gallery' and any(tag.category == 'set' for tag in tags):
224 if any(tag.category == 'theme' for tag in tags):
225 return theme_list(request, tags, list_type=list_type)
227 if list_type == 'books':
228 books = Book.tagged.with_all(tags)
230 if any(tag.category == 'set' for tag in tags):
231 params = {'objects': books}
234 'objects': Book.tagged_top_level(tags),
235 'fragments': Fragment.objects.filter(book__in=books),
236 'related_tags': get_top_level_related_tags(tags),
238 elif list_type == 'gallery':
239 params = {'objects': Picture.tagged.with_all(tags)}
240 elif list_type == 'audiobooks':
241 audiobooks = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
243 'objects': Book.tagged.with_all(tags, audiobooks),
245 'daisy': Book.tagged.with_all(tags, audiobooks.filter(media__type='daisy').distinct()),
251 return object_list(request, tags=tags, list_type=list_type, **params)
254 def book_fragments(request, slug, theme_slug):
255 book = get_object_or_404(Book, slug=slug)
256 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
257 fragments = Fragment.tagged.with_all([theme]).filter(
258 Q(book=book) | Q(book__ancestor=book))
260 return render_to_response('catalogue/book_fragments.html', {
263 'fragments': fragments,
264 }, context_instance=RequestContext(request))
267 def book_detail(request, slug):
269 book = Book.objects.get(slug=slug)
270 except Book.DoesNotExist:
271 return pdcounter_views.book_stub_detail(request, slug)
273 return render_to_response('catalogue/book_detail.html', {
275 'tags': book.tags.exclude(category__in=('set', 'theme')),
276 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
277 }, context_instance=RequestContext(request))
280 def get_audiobooks(book):
282 for m in book.media.filter(type='ogg').order_by().iterator():
283 ogg_files[m.name] = m
288 for mp3 in book.media.filter(type='mp3').iterator():
289 # ogg files are always from the same project
290 meta = mp3.extra_info
291 project = meta.get('project')
294 project = u'CzytamySłuchając'
296 projects.add((project, meta.get('funded_by', '')))
300 ogg = ogg_files.get(mp3.name)
305 audiobooks.append(media)
307 projects = sorted(projects)
308 return audiobooks, projects, have_oggs
311 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
312 def player(request, slug):
313 book = get_object_or_404(Book, slug=slug)
314 if not book.has_media('mp3'):
317 audiobooks, projects, have_oggs = get_audiobooks(book)
319 # extra_info = book.extra_info
321 return render_to_response('catalogue/player.html', {
324 'audiobooks': audiobooks,
325 'projects': projects,
326 }, context_instance=RequestContext(request))
329 def book_text(request, slug):
330 book = get_object_or_404(Book, slug=slug)
332 if not book.has_html_file():
334 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
341 def _no_diacritics_regexp(query):
342 """ returns a regexp for searching for a query without diacritics
344 should be locale-aware """
346 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śŚ',
348 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
354 return u"(%s)" % '|'.join(names[l])
356 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
359 def unicode_re_escape(query):
360 """ Unicode-friendly version of re.escape """
361 return re.sub(r'(?u)(\W)', r'\\\1', query)
364 def _word_starts_with(name, prefix):
365 """returns a Q object getting models having `name` contain a word
366 starting with `prefix`
368 We define word characters as alphanumeric and underscore, like in JS.
370 Works for MySQL, PostgreSQL, Oracle.
371 For SQLite, _sqlite* version is substituted for this.
375 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
376 # can't use [[:<:]] (word start),
377 # but we want both `xy` and `(xy` to catch `(xyz)`
378 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
383 def _word_starts_with_regexp(prefix):
384 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
385 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
388 def _sqlite_word_starts_with(name, prefix):
389 """ version of _word_starts_with for SQLite
391 SQLite in Django uses Python re module
393 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
397 if hasattr(settings, 'DATABASES'):
398 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
399 _word_starts_with = _sqlite_word_starts_with
400 elif settings.DATABASE_ENGINE == 'sqlite3':
401 _word_starts_with = _sqlite_word_starts_with
405 def __init__(self, name, view):
408 self.lower = name.lower()
409 self.category = 'application'
412 return reverse(*self._view)
415 App(u'Leśmianator', (u'lesmianator', )),
419 def _tags_starting_with(prefix, user=None):
420 prefix = prefix.lower()
422 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
423 authors = Author.objects.filter(_word_starts_with('name', prefix))
425 books = Book.objects.filter(_word_starts_with('title', prefix))
426 tags = Tag.objects.filter(_word_starts_with('name', prefix))
427 if user and user.is_authenticated():
428 tags = tags.filter(~Q(category='set') | Q(user=user))
430 tags = tags.exclude(category='set')
432 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
433 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
437 def _get_result_link(match, tag_list):
438 if isinstance(match, Tag):
439 return reverse('catalogue.views.tagged_object_list',
440 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
441 elif isinstance(match, App):
444 return match.get_absolute_url()
447 def _get_result_type(match):
448 if isinstance(match, Book) or isinstance(match, BookStub):
451 match_type = match.category
455 def books_starting_with(prefix):
456 prefix = prefix.lower()
457 return Book.objects.filter(_word_starts_with('title', prefix))
460 def find_best_matches(query, user=None):
461 """ Finds a Book, Tag, BookStub or Author best matching a query.
464 - zero elements when nothing is found,
465 - one element when a best result is found,
466 - more then one element on multiple exact matches
468 Raises a ValueError on too short a query.
471 query = query.lower()
473 raise ValueError("query must have at least two characters")
475 result = tuple(_tags_starting_with(query, user))
476 # remove pdcounter stuff
477 book_titles = set(match.pretty_title().lower() for match in result
478 if isinstance(match, Book))
479 authors = set(match.name.lower() for match in result
480 if isinstance(match, Tag) and match.category == 'author')
481 result = tuple(res for res in result if not (
482 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
483 (isinstance(res, Author) and res.name.lower() in authors)
486 exact_matches = tuple(res for res in result if res.name.lower() == query)
490 return tuple(result)[:1]
494 tags = request.GET.get('tags', '')
495 prefix = request.GET.get('q', '')
498 tag_list = Tag.get_tag_list(tags)
499 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
503 result = find_best_matches(prefix, request.user)
505 return render_to_response(
506 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
507 context_instance=RequestContext(request))
510 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
511 elif len(result) > 1:
512 return render_to_response(
513 'catalogue/search_multiple_hits.html',
515 'tags': tag_list, 'prefix': prefix,
516 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
518 context_instance=RequestContext(request))
520 form = PublishingSuggestForm(initial={"books": prefix + ", "})
521 return render_to_response(
522 'catalogue/search_no_hits.html',
523 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
524 context_instance=RequestContext(request))
527 def tags_starting_with(request):
528 prefix = request.GET.get('q', '')
529 # Prefix must have at least 2 characters
531 return HttpResponse('')
534 for tag in _tags_starting_with(prefix, request.user):
535 if tag.name not in tags_list:
536 result += "\n" + tag.name
537 tags_list.append(tag.name)
538 return HttpResponse(result)
541 def json_tags_starting_with(request, callback=None):
543 prefix = request.GET.get('q', '')
544 callback = request.GET.get('callback', '')
545 # Prefix must have at least 2 characters
547 return HttpResponse('')
549 for tag in _tags_starting_with(prefix, request.user):
550 if tag.name not in tags_list:
551 tags_list.append(tag.name)
552 if request.GET.get('mozhint', ''):
553 result = [prefix, tags_list]
555 result = {"matches": tags_list}
556 response = JsonResponse(result, safe=False)
558 response.content = callback + "(" + response.content + ");"
567 def import_book(request):
568 """docstring for import_book"""
569 book_import_form = forms.BookImportForm(request.POST, request.FILES)
570 if book_import_form.is_valid():
572 book_import_form.save()
577 info = sys.exc_info()
578 exception = pprint.pformat(info[1])
579 tb = '\n'.join(traceback.format_tb(info[2]))
581 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
582 mimetype='text/plain')
583 return HttpResponse(_("Book imported successfully"))
585 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
590 def book_info(request, book_id, lang='pl'):
591 book = get_object_or_404(Book, id=book_id)
592 # set language by hand
593 translation.activate(lang)
594 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
597 def tag_info(request, tag_id):
598 tag = get_object_or_404(Tag, id=tag_id)
599 return HttpResponse(tag.description)
602 def download_zip(request, format, slug=None):
603 if format in Book.ebook_formats:
604 url = Book.zip_format(format)
605 elif format in ('mp3', 'ogg') and slug is not None:
606 book = get_object_or_404(Book, slug=slug)
607 url = book.zip_audiobooks(format)
609 raise Http404('No format specified for zip package')
610 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
613 class CustomPDFFormView(AjaxableFormView):
614 form_class = forms.CustomPDFForm
615 title = ugettext_lazy('Download custom PDF')
616 submit = ugettext_lazy('Download')
619 def __call__(self, *args, **kwargs):
620 if settings.NO_CUSTOM_PDF:
621 raise Http404('Custom PDF is disabled')
622 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
624 def form_args(self, request, obj):
625 """Override to parse view args and give additional args to the form."""
628 def get_object(self, request, slug, *args, **kwargs):
629 return get_object_or_404(Book, slug=slug)
631 def context_description(self, request, obj):
632 return obj.pretty_title()
641 def book_mini(request, pk, with_link=True):
642 book = get_object_or_404(Book, pk=pk)
643 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
644 return render(request, 'catalogue/book_mini_box.html', {
646 'author_str': author_str,
647 'with_link': with_link,
648 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
652 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
653 ('ssify.get_csrf_token',),
654 ('social_tags.likes_book', (ipk,)),
655 ('social_tags.book_shelf_tags', (ipk,)),
656 ))(ssi_expect(pk, int)))
657 def book_short(request, pk):
658 book = get_object_or_404(Book, pk=pk)
659 stage_note, stage_note_url = book.stage_note()
660 audiobooks, projects, have_oggs = get_audiobooks(book)
662 return render(request, 'catalogue/book_short.html', {
664 'has_audio': book.has_media('mp3'),
665 'main_link': book.get_absolute_url(),
666 'parents': book.parents(),
667 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
668 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
669 'stage_note': stage_note,
670 'stage_note_url': stage_note_url,
671 'audiobooks': audiobooks,
672 'have_oggs': have_oggs,
677 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
679 ('social_tags.choose_cite', [ipk]),
680 ('catalogue_tags.choose_fragment', [ipk], {
681 'unless': Var('social_tags.choose_cite', [ipk])}),
682 ))(ssi_expect(pk, int)))
683 def book_wide(request, pk):
684 book = get_object_or_404(Book, pk=pk)
685 stage_note, stage_note_url = book.stage_note()
686 extra_info = book.extra_info
687 audiobooks, projects, have_oggs = get_audiobooks(book)
689 return render(request, 'catalogue/book_wide.html', {
691 'has_audio': book.has_media('mp3'),
692 'parents': book.parents(),
693 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
694 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
695 'stage_note': stage_note,
696 'stage_note_url': stage_note_url,
698 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
699 'extra_info': extra_info,
700 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
701 'audiobooks': audiobooks,
702 'have_oggs': have_oggs,
707 def fragment_short(request, pk):
708 fragment = get_object_or_404(Fragment, pk=pk)
709 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
713 def fragment_promo(request, pk):
714 fragment = get_object_or_404(Fragment, pk=pk)
715 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
719 def tag_box(request, pk):
720 tag = get_object_or_404(Tag, pk=pk)
721 assert tag.category != 'set'
723 return render(request, 'catalogue/tag_box.html', {
729 def collection_box(request, pk):
730 obj = get_object_or_404(Collection, pk=pk)
732 return render(request, 'catalogue/collection_box.html', {
737 def tag_catalogue(request, category):
738 if category == 'theme':
739 tags = Tag.objects.usage_for_model(
740 Fragment, counts=True).filter(category='theme')
742 tags = list(get_top_level_related_tags((), categories=(category,)))
744 described_tags = [tag for tag in tags if tag.description]
746 if len(described_tags) > 4:
747 best = random.sample(described_tags, 4)
749 best = described_tags
751 return render(request, 'catalogue/tag_catalogue.html', {
754 'title': constants.CATEGORIES_NAME_PLURAL[category],
755 'whole_category': constants.WHOLE_CATEGORY[category],
756 'active_menu_item': 'theme' if category == 'theme' else None,
760 def collections(request):
761 objects = Collection.objects.all()
764 best = random.sample(objects, 3)
768 return render(request, 'catalogue/collections.html', {