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).order_by('sort_key_author', 'sort_key'),
39 'pictures': Picture.objects.order_by('sort_key_author', 'sort_key'),
40 'collections': Collection.objects.all(),
44 def book_list(request, filter=None, get_filter=None, template_name='catalogue/book_list.html',
45 nav_template_name='catalogue/snippets/book_list_nav.html',
46 list_template_name='catalogue/snippets/book_list.html', context=None):
47 """ generates a listing of all books, optionally filtered with a test function """
50 books_by_author, orphans, books_by_parent = Book.book_list(filter)
51 books_nav = OrderedDict()
52 for tag in books_by_author:
53 if books_by_author[tag]:
54 books_nav.setdefault(tag.sort_key[0], []).append(tag)
55 # WTF: dlaczego nie include?
56 return render_to_response(template_name, {
57 'rendered_nav': render_to_string(nav_template_name, {'books_nav': books_nav}),
58 'rendered_book_list': render_to_string(list_template_name, {
59 'books_by_author': books_by_author,
61 'books_by_parent': books_by_parent,
63 }, context_instance=RequestContext(request))
66 def audiobook_list(request):
67 books = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct().order_by(
68 'sort_key_author', 'sort_key')
71 best = random.sample(books, 3)
75 daisy = Book.objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
77 return render(request, 'catalogue/audiobook_list.html', {
84 def daisy_list(request):
85 return book_list(request, Q(media__type='daisy'),
86 template_name='catalogue/daisy_list.html',
90 def collection(request, slug):
91 coll = get_object_or_404(Collection, slug=slug)
92 return render(request, 'catalogue/collection.html', {'collection': coll})
95 def differentiate_tags(request, tags, ambiguous_slugs):
96 beginning = '/'.join(tag.url_chunk for tag in tags)
97 unparsed = '/'.join(ambiguous_slugs[1:])
99 for tag in Tag.objects.filter(slug=ambiguous_slugs[0]):
101 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
104 return render_to_response(
105 'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
106 context_instance=RequestContext(request))
109 # TODO: Rewrite this hellish piece of code which tries to do everything
110 def tagged_object_list(request, tags='', list_type='default'):
112 # preliminary tests and conditions
113 gallery = list_type == 'gallery'
114 audiobooks = list_type == 'audiobooks'
116 tags = Tag.get_tag_list(tags)
117 except Tag.DoesNotExist:
118 # Perhaps the user is asking about an author in Public Domain
119 # counter (they are not represented in tags)
120 chunks = tags.split('/')
121 if len(chunks) == 2 and chunks[0] == 'autor':
122 return pdcounter_views.author_detail(request, chunks[1])
125 except Tag.MultipleObjectsReturned, e:
126 # Ask the user to disambiguate
127 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
128 except Tag.UrlDeprecationWarning, e:
129 return HttpResponsePermanentRedirect(
130 reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
133 if len(tags) > settings.MAX_TAG_LIST:
135 except AttributeError:
138 # beginning of digestion
139 theme_is_set = any(tag.category == 'theme' for tag in tags)
140 shelf_is_set = any(tag.category == 'set' for tag in tags)
141 only_shelf = shelf_is_set and len(tags) == 1
142 only_my_shelf = only_shelf and request.user == tags[0].user
143 tags_pks = [tag.pk for tag in tags]
145 if gallery and shelf_is_set:
150 # Only fragments (or pirctureareas) here.
151 shelf_tags = [tag for tag in tags if tag.category == 'set']
152 fragment_tags = [tag for tag in tags if tag.category != 'set']
154 fragments = PictureArea.tagged.with_all(fragment_tags)
156 fragments = Fragment.tagged.with_all(fragment_tags)
159 # TODO: Pictures on shelves not supported yet.
160 books = Book.tagged.with_all(shelf_tags).order_by()
161 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
163 categories = split_tags(
164 Tag.objects.usage_for_queryset(fragments, counts=True).exclude(pk__in=tags_pks),
170 # TODO: Pictures on shelves not supported yet.
172 objects = Picture.tagged.with_all(tags)
174 objects = Picture.objects.all()
175 areas = PictureArea.objects.filter(picture__in=objects)
176 categories = split_tags(
177 Tag.objects.usage_for_queryset(
178 objects, counts=True).exclude(pk__in=tags_pks),
179 Tag.objects.usage_for_queryset(
180 areas, counts=True).filter(
181 category__in=('theme', 'thing')).exclude(
186 all_books = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
188 all_books = Book.tagged.with_all(tags, all_books)
190 # there's never only the daisy audiobook
191 daisy = objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
192 related_book_tags = Tag.objects.usage_for_queryset(
193 objects, counts=True).exclude(
194 category='set').exclude(pk__in=tags_pks)
197 all_books = Book.tagged.with_all(tags)
199 all_books = Book.objects.filter(parent=None)
202 related_book_tags = Tag.objects.usage_for_queryset(
203 objects, counts=True).exclude(
204 category='set').exclude(pk__in=tags_pks)
207 objects = Book.tagged_top_level(tags)
210 related_book_tags = get_top_level_related_tags(tags)
212 fragments = Fragment.objects.filter(book__in=all_books)
214 categories = split_tags(
216 Tag.objects.usage_for_queryset(
217 fragments, counts=True).filter(
218 category='theme').exclude(pk__in=tags_pks),
220 objects = objects.order_by('sort_key_author', 'sort_key')
222 objects = list(objects)
224 best = random.sample(objects, 3)
228 if not gallery and not objects and len(tags) == 1:
230 if tag.category in ('theme', 'thing') and (
231 PictureArea.tagged.with_any([tag]).exists() or
232 Picture.tagged.with_any([tag]).exists()):
233 return redirect('tagged_object_list_gallery', raw_tags)
235 return render_to_response(
236 'catalogue/tagged_object_list.html',
238 'object_list': objects,
239 'categories': categories,
240 'only_shelf': only_shelf,
241 'only_my_shelf': only_my_shelf,
242 'formats_form': forms.DownloadFormatsForm(),
245 'theme_is_set': theme_is_set,
247 'list_type': list_type,
250 context_instance=RequestContext(request))
253 def book_fragments(request, slug, theme_slug):
254 book = get_object_or_404(Book, slug=slug)
255 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
256 fragments = Fragment.tagged.with_all([theme]).filter(
257 Q(book=book) | Q(book__ancestor=book))
259 return render_to_response('catalogue/book_fragments.html', {
262 'fragments': fragments,
263 }, context_instance=RequestContext(request))
266 def book_detail(request, slug):
268 book = Book.objects.get(slug=slug)
269 except Book.DoesNotExist:
270 return pdcounter_views.book_stub_detail(request, slug)
272 return render_to_response('catalogue/book_detail.html', {
274 'tags': book.tags.exclude(category__in=('set', 'theme')),
275 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
276 }, context_instance=RequestContext(request))
279 def get_audiobooks(book):
281 for m in book.media.filter(type='ogg').order_by().iterator():
282 ogg_files[m.name] = m
287 for mp3 in book.media.filter(type='mp3').iterator():
288 # ogg files are always from the same project
289 meta = mp3.extra_info
290 project = meta.get('project')
293 project = u'CzytamySłuchając'
295 projects.add((project, meta.get('funded_by', '')))
299 ogg = ogg_files.get(mp3.name)
304 audiobooks.append(media)
306 projects = sorted(projects)
307 return audiobooks, projects, have_oggs
310 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
311 def player(request, slug):
312 book = get_object_or_404(Book, slug=slug)
313 if not book.has_media('mp3'):
316 audiobooks, projects, have_oggs = get_audiobooks(book)
318 # extra_info = book.extra_info
320 return render_to_response('catalogue/player.html', {
323 'audiobooks': audiobooks,
324 'projects': projects,
325 }, context_instance=RequestContext(request))
328 def book_text(request, slug):
329 book = get_object_or_404(Book, slug=slug)
331 if not book.has_html_file():
333 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
340 def _no_diacritics_regexp(query):
341 """ returns a regexp for searching for a query without diacritics
343 should be locale-aware """
345 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śŚ',
347 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
353 return u"(%s)" % '|'.join(names[l])
355 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
358 def unicode_re_escape(query):
359 """ Unicode-friendly version of re.escape """
360 return re.sub(r'(?u)(\W)', r'\\\1', query)
363 def _word_starts_with(name, prefix):
364 """returns a Q object getting models having `name` contain a word
365 starting with `prefix`
367 We define word characters as alphanumeric and underscore, like in JS.
369 Works for MySQL, PostgreSQL, Oracle.
370 For SQLite, _sqlite* version is substituted for this.
374 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
375 # can't use [[:<:]] (word start),
376 # but we want both `xy` and `(xy` to catch `(xyz)`
377 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
382 def _word_starts_with_regexp(prefix):
383 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
384 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
387 def _sqlite_word_starts_with(name, prefix):
388 """ version of _word_starts_with for SQLite
390 SQLite in Django uses Python re module
392 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
396 if hasattr(settings, 'DATABASES'):
397 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
398 _word_starts_with = _sqlite_word_starts_with
399 elif settings.DATABASE_ENGINE == 'sqlite3':
400 _word_starts_with = _sqlite_word_starts_with
404 def __init__(self, name, view):
407 self.lower = name.lower()
408 self.category = 'application'
411 return reverse(*self._view)
414 App(u'Leśmianator', (u'lesmianator', )),
418 def _tags_starting_with(prefix, user=None):
419 prefix = prefix.lower()
421 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
422 authors = Author.objects.filter(_word_starts_with('name', prefix))
424 books = Book.objects.filter(_word_starts_with('title', prefix))
425 tags = Tag.objects.filter(_word_starts_with('name', prefix))
426 if user and user.is_authenticated():
427 tags = tags.filter(~Q(category='set') | Q(user=user))
429 tags = tags.exclude(category='set')
431 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
432 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
436 def _get_result_link(match, tag_list):
437 if isinstance(match, Tag):
438 return reverse('catalogue.views.tagged_object_list',
439 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
440 elif isinstance(match, App):
443 return match.get_absolute_url()
446 def _get_result_type(match):
447 if isinstance(match, Book) or isinstance(match, BookStub):
450 match_type = match.category
454 def books_starting_with(prefix):
455 prefix = prefix.lower()
456 return Book.objects.filter(_word_starts_with('title', prefix))
459 def find_best_matches(query, user=None):
460 """ Finds a Book, Tag, BookStub or Author best matching a query.
463 - zero elements when nothing is found,
464 - one element when a best result is found,
465 - more then one element on multiple exact matches
467 Raises a ValueError on too short a query.
470 query = query.lower()
472 raise ValueError("query must have at least two characters")
474 result = tuple(_tags_starting_with(query, user))
475 # remove pdcounter stuff
476 book_titles = set(match.pretty_title().lower() for match in result
477 if isinstance(match, Book))
478 authors = set(match.name.lower() for match in result
479 if isinstance(match, Tag) and match.category == 'author')
480 result = tuple(res for res in result if not (
481 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
482 (isinstance(res, Author) and res.name.lower() in authors)
485 exact_matches = tuple(res for res in result if res.name.lower() == query)
489 return tuple(result)[:1]
493 tags = request.GET.get('tags', '')
494 prefix = request.GET.get('q', '')
497 tag_list = Tag.get_tag_list(tags)
498 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
502 result = find_best_matches(prefix, request.user)
504 return render_to_response(
505 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
506 context_instance=RequestContext(request))
509 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
510 elif len(result) > 1:
511 return render_to_response(
512 'catalogue/search_multiple_hits.html',
514 'tags': tag_list, 'prefix': prefix,
515 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
517 context_instance=RequestContext(request))
519 form = PublishingSuggestForm(initial={"books": prefix + ", "})
520 return render_to_response(
521 'catalogue/search_no_hits.html',
522 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
523 context_instance=RequestContext(request))
526 def tags_starting_with(request):
527 prefix = request.GET.get('q', '')
528 # Prefix must have at least 2 characters
530 return HttpResponse('')
533 for tag in _tags_starting_with(prefix, request.user):
534 if tag.name not in tags_list:
535 result += "\n" + tag.name
536 tags_list.append(tag.name)
537 return HttpResponse(result)
540 def json_tags_starting_with(request, callback=None):
542 prefix = request.GET.get('q', '')
543 callback = request.GET.get('callback', '')
544 # Prefix must have at least 2 characters
546 return HttpResponse('')
548 for tag in _tags_starting_with(prefix, request.user):
549 if tag.name not in tags_list:
550 tags_list.append(tag.name)
551 if request.GET.get('mozhint', ''):
552 result = [prefix, tags_list]
554 result = {"matches": tags_list}
555 response = JsonResponse(result, safe=False)
557 response.content = callback + "(" + response.content + ");"
566 def import_book(request):
567 """docstring for import_book"""
568 book_import_form = forms.BookImportForm(request.POST, request.FILES)
569 if book_import_form.is_valid():
571 book_import_form.save()
576 info = sys.exc_info()
577 exception = pprint.pformat(info[1])
578 tb = '\n'.join(traceback.format_tb(info[2]))
580 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
581 mimetype='text/plain')
582 return HttpResponse(_("Book imported successfully"))
584 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
589 def book_info(request, book_id, lang='pl'):
590 book = get_object_or_404(Book, id=book_id)
591 # set language by hand
592 translation.activate(lang)
593 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
596 def tag_info(request, tag_id):
597 tag = get_object_or_404(Tag, id=tag_id)
598 return HttpResponse(tag.description)
601 def download_zip(request, format, slug=None):
602 if format in Book.ebook_formats:
603 url = Book.zip_format(format)
604 elif format in ('mp3', 'ogg') and slug is not None:
605 book = get_object_or_404(Book, slug=slug)
606 url = book.zip_audiobooks(format)
608 raise Http404('No format specified for zip package')
609 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
612 class CustomPDFFormView(AjaxableFormView):
613 form_class = forms.CustomPDFForm
614 title = ugettext_lazy('Download custom PDF')
615 submit = ugettext_lazy('Download')
618 def __call__(self, *args, **kwargs):
619 if settings.NO_CUSTOM_PDF:
620 raise Http404('Custom PDF is disabled')
621 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
623 def form_args(self, request, obj):
624 """Override to parse view args and give additional args to the form."""
627 def get_object(self, request, slug, *args, **kwargs):
628 return get_object_or_404(Book, slug=slug)
630 def context_description(self, request, obj):
631 return obj.pretty_title()
640 def book_mini(request, pk, with_link=True):
641 book = get_object_or_404(Book, pk=pk)
642 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
643 return render(request, 'catalogue/book_mini_box.html', {
645 'author_str': author_str,
646 'with_link': with_link,
647 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
651 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
652 ('ssify.get_csrf_token',),
653 ('social_tags.likes_book', (ipk,)),
654 ('social_tags.book_shelf_tags', (ipk,)),
655 ))(ssi_expect(pk, int)))
656 def book_short(request, pk):
657 book = get_object_or_404(Book, pk=pk)
658 stage_note, stage_note_url = book.stage_note()
659 audiobooks, projects, have_oggs = get_audiobooks(book)
661 return render(request, 'catalogue/book_short.html', {
663 'has_audio': book.has_media('mp3'),
664 'main_link': book.get_absolute_url(),
665 'parents': book.parents(),
666 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
667 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
668 'stage_note': stage_note,
669 'stage_note_url': stage_note_url,
670 'audiobooks': audiobooks,
671 'have_oggs': have_oggs,
676 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
678 ('social_tags.choose_cite', [ipk]),
679 ('catalogue_tags.choose_fragment', [ipk], {
680 'unless': Var('social_tags.choose_cite', [ipk])}),
681 ))(ssi_expect(pk, int)))
682 def book_wide(request, pk):
683 book = get_object_or_404(Book, pk=pk)
684 stage_note, stage_note_url = book.stage_note()
685 extra_info = book.extra_info
686 audiobooks, projects, have_oggs = get_audiobooks(book)
688 return render(request, 'catalogue/book_wide.html', {
690 'has_audio': book.has_media('mp3'),
691 'parents': book.parents(),
692 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
693 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
694 'stage_note': stage_note,
695 'stage_note_url': stage_note_url,
697 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
698 'extra_info': extra_info,
699 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
700 'audiobooks': audiobooks,
701 'have_oggs': have_oggs,
706 def fragment_short(request, pk):
707 fragment = get_object_or_404(Fragment, pk=pk)
708 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
712 def fragment_promo(request, pk):
713 fragment = get_object_or_404(Fragment, pk=pk)
714 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
718 def tag_box(request, pk):
719 tag = get_object_or_404(Tag, pk=pk)
720 assert tag.category != 'set'
722 return render(request, 'catalogue/tag_box.html', {
728 def collection_box(request, pk):
729 obj = get_object_or_404(Collection, pk=pk)
731 return render(request, 'catalogue/collection_box.html', {
736 def tag_catalogue(request, category):
737 if category == 'theme':
738 tags = Tag.objects.usage_for_model(
739 Fragment, counts=True).filter(category='theme')
741 tags = list(get_top_level_related_tags((), categories=(category,)))
743 described_tags = [tag for tag in tags if tag.description]
745 if len(described_tags) > 4:
746 best = random.sample(described_tags, 4)
748 best = described_tags
750 return render(request, 'catalogue/tag_catalogue.html', {
753 'title': constants.CATEGORIES_NAME_PLURAL[category],
754 'whole_category': constants.WHOLE_CATEGORY[category],
758 def collections(request):
759 objects = Collection.objects.all()
762 best = random.sample(objects, 3)
766 return render(request, 'catalogue/collections.html', {