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.tagged.with_all(tags)
188 all_books = Book.objects.filter(parent=None)
191 related_book_tags = Tag.objects.usage_for_queryset(
192 objects, counts=True).exclude(
193 category='set').exclude(pk__in=tags_pks)
196 objects = Book.tagged_top_level(tags)
199 # WTF: was outside if, overwriting value assigned if shelf_is_set
200 related_book_tags = get_top_level_related_tags(tags)
203 if objects != all_books:
204 all_books = all_books.filter(media__type__in=('mp3', 'ogg')).distinct()
205 objects = objects.filter(media__type__in=('mp3', 'ogg')).distinct()
207 all_books = objects = objects.filter(media__type__in=('mp3', 'ogg')).distinct()
208 daisy = objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
210 fragments = Fragment.objects.filter(book__in=all_books)
212 categories = split_tags(
214 Tag.objects.usage_for_queryset(
215 fragments, counts=True).filter(
216 category='theme').exclude(pk__in=tags_pks),
218 objects = objects.order_by('sort_key_author', 'sort_key')
220 objects = list(objects)
222 best = random.sample(objects, 3)
226 if not gallery and not objects and len(tags) == 1:
228 if tag.category in ('theme', 'thing') and (
229 PictureArea.tagged.with_any([tag]).exists() or
230 Picture.tagged.with_any([tag]).exists()):
231 return redirect('tagged_object_list_gallery', raw_tags, permanent=False)
233 return render_to_response(
234 'catalogue/tagged_object_list.html',
236 'object_list': objects,
237 'categories': categories,
238 'only_shelf': only_shelf,
239 'only_my_shelf': only_my_shelf,
240 'formats_form': forms.DownloadFormatsForm(),
243 'theme_is_set': theme_is_set,
245 'list_type': list_type,
248 context_instance=RequestContext(request))
251 def book_fragments(request, slug, theme_slug):
252 book = get_object_or_404(Book, slug=slug)
253 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
254 fragments = Fragment.tagged.with_all([theme]).filter(
255 Q(book=book) | Q(book__ancestor=book))
257 return render_to_response('catalogue/book_fragments.html', {
260 'fragments': fragments,
261 }, context_instance=RequestContext(request))
264 def book_detail(request, slug):
266 book = Book.objects.get(slug=slug)
267 except Book.DoesNotExist:
268 return pdcounter_views.book_stub_detail(request, slug)
270 return render_to_response('catalogue/book_detail.html', {
272 'tags': book.tags.exclude(category__in=('set', 'theme')),
273 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
274 }, context_instance=RequestContext(request))
277 def get_audiobooks(book):
279 for m in book.media.filter(type='ogg').order_by().iterator():
280 ogg_files[m.name] = m
285 for mp3 in book.media.filter(type='mp3').iterator():
286 # ogg files are always from the same project
287 meta = mp3.extra_info
288 project = meta.get('project')
291 project = u'CzytamySłuchając'
293 projects.add((project, meta.get('funded_by', '')))
297 ogg = ogg_files.get(mp3.name)
302 audiobooks.append(media)
304 projects = sorted(projects)
305 return audiobooks, projects, have_oggs
308 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
309 def player(request, slug):
310 book = get_object_or_404(Book, slug=slug)
311 if not book.has_media('mp3'):
314 audiobooks, projects, have_oggs = get_audiobooks(book)
316 # extra_info = book.extra_info
318 return render_to_response('catalogue/player.html', {
321 'audiobooks': audiobooks,
322 'projects': projects,
323 }, context_instance=RequestContext(request))
326 def book_text(request, slug):
327 book = get_object_or_404(Book, slug=slug)
329 if not book.has_html_file():
331 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
338 def _no_diacritics_regexp(query):
339 """ returns a regexp for searching for a query without diacritics
341 should be locale-aware """
343 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śŚ',
345 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
351 return u"(%s)" % '|'.join(names[l])
353 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
356 def unicode_re_escape(query):
357 """ Unicode-friendly version of re.escape """
358 return re.sub(r'(?u)(\W)', r'\\\1', query)
361 def _word_starts_with(name, prefix):
362 """returns a Q object getting models having `name` contain a word
363 starting with `prefix`
365 We define word characters as alphanumeric and underscore, like in JS.
367 Works for MySQL, PostgreSQL, Oracle.
368 For SQLite, _sqlite* version is substituted for this.
372 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
373 # can't use [[:<:]] (word start),
374 # but we want both `xy` and `(xy` to catch `(xyz)`
375 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
380 def _word_starts_with_regexp(prefix):
381 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
382 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
385 def _sqlite_word_starts_with(name, prefix):
386 """ version of _word_starts_with for SQLite
388 SQLite in Django uses Python re module
390 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
394 if hasattr(settings, 'DATABASES'):
395 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
396 _word_starts_with = _sqlite_word_starts_with
397 elif settings.DATABASE_ENGINE == 'sqlite3':
398 _word_starts_with = _sqlite_word_starts_with
402 def __init__(self, name, view):
405 self.lower = name.lower()
406 self.category = 'application'
409 return reverse(*self._view)
412 App(u'Leśmianator', (u'lesmianator', )),
416 def _tags_starting_with(prefix, user=None):
417 prefix = prefix.lower()
419 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
420 authors = Author.objects.filter(_word_starts_with('name', prefix))
422 books = Book.objects.filter(_word_starts_with('title', prefix))
423 tags = Tag.objects.filter(_word_starts_with('name', prefix))
424 if user and user.is_authenticated():
425 tags = tags.filter(~Q(category='set') | Q(user=user))
427 tags = tags.exclude(category='set')
429 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
430 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
434 def _get_result_link(match, tag_list):
435 if isinstance(match, Tag):
436 return reverse('catalogue.views.tagged_object_list',
437 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
438 elif isinstance(match, App):
441 return match.get_absolute_url()
444 def _get_result_type(match):
445 if isinstance(match, Book) or isinstance(match, BookStub):
448 match_type = match.category
452 def books_starting_with(prefix):
453 prefix = prefix.lower()
454 return Book.objects.filter(_word_starts_with('title', prefix))
457 def find_best_matches(query, user=None):
458 """ Finds a Book, Tag, BookStub or Author best matching a query.
461 - zero elements when nothing is found,
462 - one element when a best result is found,
463 - more then one element on multiple exact matches
465 Raises a ValueError on too short a query.
468 query = query.lower()
470 raise ValueError("query must have at least two characters")
472 result = tuple(_tags_starting_with(query, user))
473 # remove pdcounter stuff
474 book_titles = set(match.pretty_title().lower() for match in result
475 if isinstance(match, Book))
476 authors = set(match.name.lower() for match in result
477 if isinstance(match, Tag) and match.category == 'author')
478 result = tuple(res for res in result if not (
479 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
480 (isinstance(res, Author) and res.name.lower() in authors)
483 exact_matches = tuple(res for res in result if res.name.lower() == query)
487 return tuple(result)[:1]
491 tags = request.GET.get('tags', '')
492 prefix = request.GET.get('q', '')
495 tag_list = Tag.get_tag_list(tags)
496 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
500 result = find_best_matches(prefix, request.user)
502 return render_to_response(
503 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
504 context_instance=RequestContext(request))
507 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
508 elif len(result) > 1:
509 return render_to_response(
510 'catalogue/search_multiple_hits.html',
512 'tags': tag_list, 'prefix': prefix,
513 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
515 context_instance=RequestContext(request))
517 form = PublishingSuggestForm(initial={"books": prefix + ", "})
518 return render_to_response(
519 'catalogue/search_no_hits.html',
520 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
521 context_instance=RequestContext(request))
524 def tags_starting_with(request):
525 prefix = request.GET.get('q', '')
526 # Prefix must have at least 2 characters
528 return HttpResponse('')
531 for tag in _tags_starting_with(prefix, request.user):
532 if tag.name not in tags_list:
533 result += "\n" + tag.name
534 tags_list.append(tag.name)
535 return HttpResponse(result)
538 def json_tags_starting_with(request, callback=None):
540 prefix = request.GET.get('q', '')
541 callback = request.GET.get('callback', '')
542 # Prefix must have at least 2 characters
544 return HttpResponse('')
546 for tag in _tags_starting_with(prefix, request.user):
547 if tag.name not in tags_list:
548 tags_list.append(tag.name)
549 if request.GET.get('mozhint', ''):
550 result = [prefix, tags_list]
552 result = {"matches": tags_list}
553 response = JsonResponse(result, safe=False)
555 response.content = callback + "(" + response.content + ");"
564 def import_book(request):
565 """docstring for import_book"""
566 book_import_form = forms.BookImportForm(request.POST, request.FILES)
567 if book_import_form.is_valid():
569 book_import_form.save()
574 info = sys.exc_info()
575 exception = pprint.pformat(info[1])
576 tb = '\n'.join(traceback.format_tb(info[2]))
578 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
579 mimetype='text/plain')
580 return HttpResponse(_("Book imported successfully"))
582 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
587 def book_info(request, book_id, lang='pl'):
588 book = get_object_or_404(Book, id=book_id)
589 # set language by hand
590 translation.activate(lang)
591 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
594 def tag_info(request, tag_id):
595 tag = get_object_or_404(Tag, id=tag_id)
596 return HttpResponse(tag.description)
599 def download_zip(request, format, slug=None):
600 if format in Book.ebook_formats:
601 url = Book.zip_format(format)
602 elif format in ('mp3', 'ogg') and slug is not None:
603 book = get_object_or_404(Book, slug=slug)
604 url = book.zip_audiobooks(format)
606 raise Http404('No format specified for zip package')
607 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
610 class CustomPDFFormView(AjaxableFormView):
611 form_class = forms.CustomPDFForm
612 title = ugettext_lazy('Download custom PDF')
613 submit = ugettext_lazy('Download')
616 def __call__(self, *args, **kwargs):
617 if settings.NO_CUSTOM_PDF:
618 raise Http404('Custom PDF is disabled')
619 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
621 def form_args(self, request, obj):
622 """Override to parse view args and give additional args to the form."""
625 def get_object(self, request, slug, *args, **kwargs):
626 return get_object_or_404(Book, slug=slug)
628 def context_description(self, request, obj):
629 return obj.pretty_title()
638 def book_mini(request, pk, with_link=True):
639 book = get_object_or_404(Book, pk=pk)
640 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
641 return render(request, 'catalogue/book_mini_box.html', {
643 'author_str': author_str,
644 'with_link': with_link,
645 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
649 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
650 ('ssify.get_csrf_token',),
651 ('social_tags.likes_book', (ipk,)),
652 ('social_tags.book_shelf_tags', (ipk,)),
653 ))(ssi_expect(pk, int)))
654 def book_short(request, pk):
655 book = get_object_or_404(Book, pk=pk)
656 stage_note, stage_note_url = book.stage_note()
657 audiobooks, projects, have_oggs = get_audiobooks(book)
659 return render(request, 'catalogue/book_short.html', {
661 'has_audio': book.has_media('mp3'),
662 'main_link': book.get_absolute_url(),
663 'parents': book.parents(),
664 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
665 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
666 'stage_note': stage_note,
667 'stage_note_url': stage_note_url,
668 'audiobooks': audiobooks,
669 'have_oggs': have_oggs,
674 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
676 ('social_tags.choose_cite', [ipk]),
677 ('catalogue_tags.choose_fragment', [ipk], {
678 'unless': Var('social_tags.choose_cite', [ipk])}),
679 ))(ssi_expect(pk, int)))
680 def book_wide(request, pk):
681 book = get_object_or_404(Book, pk=pk)
682 stage_note, stage_note_url = book.stage_note()
683 extra_info = book.extra_info
684 audiobooks, projects, have_oggs = get_audiobooks(book)
686 return render(request, 'catalogue/book_wide.html', {
688 'has_audio': book.has_media('mp3'),
689 'parents': book.parents(),
690 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
691 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
692 'stage_note': stage_note,
693 'stage_note_url': stage_note_url,
695 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
696 'extra_info': extra_info,
697 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
698 'audiobooks': audiobooks,
699 'have_oggs': have_oggs,
704 def fragment_short(request, pk):
705 fragment = get_object_or_404(Fragment, pk=pk)
706 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
710 def fragment_promo(request, pk):
711 fragment = get_object_or_404(Fragment, pk=pk)
712 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
716 def tag_box(request, pk):
717 tag = get_object_or_404(Tag, pk=pk)
718 assert tag.category != 'set'
720 return render(request, 'catalogue/tag_box.html', {
726 def collection_box(request, pk):
727 obj = get_object_or_404(Collection, pk=pk)
729 return render(request, 'catalogue/collection_box.html', {
734 def tag_catalogue(request, category):
735 if category == 'theme':
736 tags = Tag.objects.usage_for_model(
737 Fragment, counts=True).filter(category='theme')
739 tags = list(get_top_level_related_tags((), categories=(category,)))
741 described_tags = [tag for tag in tags if tag.description]
743 if len(described_tags) > 4:
744 best = random.sample(described_tags, 4)
746 best = described_tags
748 return render(request, 'catalogue/tag_catalogue.html', {
751 'title': constants.CATEGORIES_NAME_PLURAL[category],
752 'whole_category': constants.WHOLE_CATEGORY[category],
756 def collections(request):
757 objects = Collection.objects.all()
760 best = random.sample(objects, 3)
764 return render(request, 'catalogue/collections.html', {