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 # this is becoming more and more hacky
236 if list_type == 'default' and not tags:
237 last_published = Book.objects.exclude(cover_thumb='').filter(parent=None).order_by('-created_at')[:20]
239 last_published = None
241 return render_to_response(
242 'catalogue/tagged_object_list.html',
244 'object_list': objects,
245 'categories': categories,
246 'only_shelf': only_shelf,
247 'only_my_shelf': only_my_shelf,
248 'formats_form': forms.DownloadFormatsForm(),
251 'theme_is_set': theme_is_set,
253 'list_type': list_type,
255 'last_published': last_published,
257 context_instance=RequestContext(request))
260 def book_fragments(request, slug, theme_slug):
261 book = get_object_or_404(Book, slug=slug)
262 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
263 fragments = Fragment.tagged.with_all([theme]).filter(
264 Q(book=book) | Q(book__ancestor=book))
266 return render_to_response('catalogue/book_fragments.html', {
269 'fragments': fragments,
270 }, context_instance=RequestContext(request))
273 def book_detail(request, slug):
275 book = Book.objects.get(slug=slug)
276 except Book.DoesNotExist:
277 return pdcounter_views.book_stub_detail(request, slug)
279 return render_to_response('catalogue/book_detail.html', {
281 'tags': book.tags.exclude(category__in=('set', 'theme')),
282 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
283 }, context_instance=RequestContext(request))
286 def get_audiobooks(book):
288 for m in book.media.filter(type='ogg').order_by().iterator():
289 ogg_files[m.name] = m
294 for mp3 in book.media.filter(type='mp3').iterator():
295 # ogg files are always from the same project
296 meta = mp3.extra_info
297 project = meta.get('project')
300 project = u'CzytamySłuchając'
302 projects.add((project, meta.get('funded_by', '')))
306 ogg = ogg_files.get(mp3.name)
311 audiobooks.append(media)
313 projects = sorted(projects)
314 return audiobooks, projects, have_oggs
317 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
318 def player(request, slug):
319 book = get_object_or_404(Book, slug=slug)
320 if not book.has_media('mp3'):
323 audiobooks, projects, have_oggs = get_audiobooks(book)
325 # extra_info = book.extra_info
327 return render_to_response('catalogue/player.html', {
330 'audiobooks': audiobooks,
331 'projects': projects,
332 }, context_instance=RequestContext(request))
335 def book_text(request, slug):
336 book = get_object_or_404(Book, slug=slug)
338 if not book.has_html_file():
340 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
347 def _no_diacritics_regexp(query):
348 """ returns a regexp for searching for a query without diacritics
350 should be locale-aware """
352 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śŚ',
354 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
360 return u"(%s)" % '|'.join(names[l])
362 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
365 def unicode_re_escape(query):
366 """ Unicode-friendly version of re.escape """
367 return re.sub(r'(?u)(\W)', r'\\\1', query)
370 def _word_starts_with(name, prefix):
371 """returns a Q object getting models having `name` contain a word
372 starting with `prefix`
374 We define word characters as alphanumeric and underscore, like in JS.
376 Works for MySQL, PostgreSQL, Oracle.
377 For SQLite, _sqlite* version is substituted for this.
381 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
382 # can't use [[:<:]] (word start),
383 # but we want both `xy` and `(xy` to catch `(xyz)`
384 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
389 def _word_starts_with_regexp(prefix):
390 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
391 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
394 def _sqlite_word_starts_with(name, prefix):
395 """ version of _word_starts_with for SQLite
397 SQLite in Django uses Python re module
399 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
403 if hasattr(settings, 'DATABASES'):
404 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
405 _word_starts_with = _sqlite_word_starts_with
406 elif settings.DATABASE_ENGINE == 'sqlite3':
407 _word_starts_with = _sqlite_word_starts_with
411 def __init__(self, name, view):
414 self.lower = name.lower()
415 self.category = 'application'
418 return reverse(*self._view)
421 App(u'Leśmianator', (u'lesmianator', )),
425 def _tags_starting_with(prefix, user=None):
426 prefix = prefix.lower()
428 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
429 authors = Author.objects.filter(_word_starts_with('name', prefix))
431 books = Book.objects.filter(_word_starts_with('title', prefix))
432 tags = Tag.objects.filter(_word_starts_with('name', prefix))
433 if user and user.is_authenticated():
434 tags = tags.filter(~Q(category='set') | Q(user=user))
436 tags = tags.exclude(category='set')
438 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
439 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
443 def _get_result_link(match, tag_list):
444 if isinstance(match, Tag):
445 return reverse('catalogue.views.tagged_object_list',
446 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
447 elif isinstance(match, App):
450 return match.get_absolute_url()
453 def _get_result_type(match):
454 if isinstance(match, Book) or isinstance(match, BookStub):
457 match_type = match.category
461 def books_starting_with(prefix):
462 prefix = prefix.lower()
463 return Book.objects.filter(_word_starts_with('title', prefix))
466 def find_best_matches(query, user=None):
467 """ Finds a Book, Tag, BookStub or Author best matching a query.
470 - zero elements when nothing is found,
471 - one element when a best result is found,
472 - more then one element on multiple exact matches
474 Raises a ValueError on too short a query.
477 query = query.lower()
479 raise ValueError("query must have at least two characters")
481 result = tuple(_tags_starting_with(query, user))
482 # remove pdcounter stuff
483 book_titles = set(match.pretty_title().lower() for match in result
484 if isinstance(match, Book))
485 authors = set(match.name.lower() for match in result
486 if isinstance(match, Tag) and match.category == 'author')
487 result = tuple(res for res in result if not (
488 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
489 (isinstance(res, Author) and res.name.lower() in authors)
492 exact_matches = tuple(res for res in result if res.name.lower() == query)
496 return tuple(result)[:1]
500 tags = request.GET.get('tags', '')
501 prefix = request.GET.get('q', '')
504 tag_list = Tag.get_tag_list(tags)
505 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
509 result = find_best_matches(prefix, request.user)
511 return render_to_response(
512 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
513 context_instance=RequestContext(request))
516 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
517 elif len(result) > 1:
518 return render_to_response(
519 'catalogue/search_multiple_hits.html',
521 'tags': tag_list, 'prefix': prefix,
522 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
524 context_instance=RequestContext(request))
526 form = PublishingSuggestForm(initial={"books": prefix + ", "})
527 return render_to_response(
528 'catalogue/search_no_hits.html',
529 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
530 context_instance=RequestContext(request))
533 def tags_starting_with(request):
534 prefix = request.GET.get('q', '')
535 # Prefix must have at least 2 characters
537 return HttpResponse('')
540 for tag in _tags_starting_with(prefix, request.user):
541 if tag.name not in tags_list:
542 result += "\n" + tag.name
543 tags_list.append(tag.name)
544 return HttpResponse(result)
547 def json_tags_starting_with(request, callback=None):
549 prefix = request.GET.get('q', '')
550 callback = request.GET.get('callback', '')
551 # Prefix must have at least 2 characters
553 return HttpResponse('')
555 for tag in _tags_starting_with(prefix, request.user):
556 if tag.name not in tags_list:
557 tags_list.append(tag.name)
558 if request.GET.get('mozhint', ''):
559 result = [prefix, tags_list]
561 result = {"matches": tags_list}
562 response = JsonResponse(result, safe=False)
564 response.content = callback + "(" + response.content + ");"
573 def import_book(request):
574 """docstring for import_book"""
575 book_import_form = forms.BookImportForm(request.POST, request.FILES)
576 if book_import_form.is_valid():
578 book_import_form.save()
583 info = sys.exc_info()
584 exception = pprint.pformat(info[1])
585 tb = '\n'.join(traceback.format_tb(info[2]))
587 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
588 mimetype='text/plain')
589 return HttpResponse(_("Book imported successfully"))
591 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
596 def book_info(request, book_id, lang='pl'):
597 book = get_object_or_404(Book, id=book_id)
598 # set language by hand
599 translation.activate(lang)
600 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
603 def tag_info(request, tag_id):
604 tag = get_object_or_404(Tag, id=tag_id)
605 return HttpResponse(tag.description)
608 def download_zip(request, format, slug=None):
609 if format in Book.ebook_formats:
610 url = Book.zip_format(format)
611 elif format in ('mp3', 'ogg') and slug is not None:
612 book = get_object_or_404(Book, slug=slug)
613 url = book.zip_audiobooks(format)
615 raise Http404('No format specified for zip package')
616 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
619 class CustomPDFFormView(AjaxableFormView):
620 form_class = forms.CustomPDFForm
621 title = ugettext_lazy('Download custom PDF')
622 submit = ugettext_lazy('Download')
625 def __call__(self, *args, **kwargs):
626 if settings.NO_CUSTOM_PDF:
627 raise Http404('Custom PDF is disabled')
628 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
630 def form_args(self, request, obj):
631 """Override to parse view args and give additional args to the form."""
634 def get_object(self, request, slug, *args, **kwargs):
635 return get_object_or_404(Book, slug=slug)
637 def context_description(self, request, obj):
638 return obj.pretty_title()
647 def book_mini(request, pk, with_link=True):
648 book = get_object_or_404(Book, pk=pk)
649 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
650 return render(request, 'catalogue/book_mini_box.html', {
652 'author_str': author_str,
653 'with_link': with_link,
654 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
658 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
659 ('ssify.get_csrf_token',),
660 ('social_tags.likes_book', (ipk,)),
661 ('social_tags.book_shelf_tags', (ipk,)),
662 ))(ssi_expect(pk, int)))
663 def book_short(request, pk):
664 book = get_object_or_404(Book, pk=pk)
665 stage_note, stage_note_url = book.stage_note()
666 audiobooks, projects, have_oggs = get_audiobooks(book)
668 return render(request, 'catalogue/book_short.html', {
670 'has_audio': book.has_media('mp3'),
671 'main_link': book.get_absolute_url(),
672 'parents': book.parents(),
673 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
674 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
675 'stage_note': stage_note,
676 'stage_note_url': stage_note_url,
677 'audiobooks': audiobooks,
678 'have_oggs': have_oggs,
683 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
685 ('social_tags.choose_cite', [ipk]),
686 ('catalogue_tags.choose_fragment', [ipk], {
687 'unless': Var('social_tags.choose_cite', [ipk])}),
688 ))(ssi_expect(pk, int)))
689 def book_wide(request, pk):
690 book = get_object_or_404(Book, pk=pk)
691 stage_note, stage_note_url = book.stage_note()
692 extra_info = book.extra_info
693 audiobooks, projects, have_oggs = get_audiobooks(book)
695 return render(request, 'catalogue/book_wide.html', {
697 'has_audio': book.has_media('mp3'),
698 'parents': book.parents(),
699 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
700 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
701 'stage_note': stage_note,
702 'stage_note_url': stage_note_url,
704 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
705 'extra_info': extra_info,
706 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
707 'audiobooks': audiobooks,
708 'have_oggs': have_oggs,
713 def fragment_short(request, pk):
714 fragment = get_object_or_404(Fragment, pk=pk)
715 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
719 def fragment_promo(request, pk):
720 fragment = get_object_or_404(Fragment, pk=pk)
721 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
725 def tag_box(request, pk):
726 tag = get_object_or_404(Tag, pk=pk)
727 assert tag.category != 'set'
729 return render(request, 'catalogue/tag_box.html', {
735 def collection_box(request, pk):
736 obj = get_object_or_404(Collection, pk=pk)
738 return render(request, 'catalogue/collection_box.html', {
743 def tag_catalogue(request, category):
744 if category == 'theme':
745 tags = Tag.objects.usage_for_model(
746 Fragment, counts=True).filter(category='theme')
748 tags = list(get_top_level_related_tags((), categories=(category,)))
750 described_tags = [tag for tag in tags if tag.description]
752 if len(described_tags) > 4:
753 best = random.sample(described_tags, 4)
755 best = described_tags
757 return render(request, 'catalogue/tag_catalogue.html', {
760 'title': constants.CATEGORIES_NAME_PLURAL[category],
761 'whole_category': constants.WHOLE_CATEGORY[category],
765 def collections(request):
766 objects = Collection.objects.all()
769 best = random.sample(objects, 3)
773 return render(request, 'catalogue/collections.html', {