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(),
41 'active_menu_item': 'all_works',
45 def book_list(request, filter=None, get_filter=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', context=None):
48 """ generates a listing of all books, optionally filtered with a test function """
51 books_by_author, orphans, books_by_parent = Book.book_list(filter)
52 books_nav = OrderedDict()
53 for tag in books_by_author:
54 if books_by_author[tag]:
55 books_nav.setdefault(tag.sort_key[0], []).append(tag)
56 # WTF: dlaczego nie include?
57 return render_to_response(template_name, {
58 'rendered_nav': render_to_string(nav_template_name, {'books_nav': books_nav}),
59 'rendered_book_list': render_to_string(list_template_name, {
60 'books_by_author': books_by_author,
62 'books_by_parent': books_by_parent,
64 }, context_instance=RequestContext(request))
67 def audiobook_list(request):
68 books = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct().order_by(
69 'sort_key_author', 'sort_key')
72 best = random.sample(books, 3)
76 daisy = Book.objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
78 return render(request, 'catalogue/audiobook_list.html', {
85 def daisy_list(request):
86 return book_list(request, Q(media__type='daisy'),
87 template_name='catalogue/daisy_list.html',
91 def collection(request, slug):
92 coll = get_object_or_404(Collection, slug=slug)
93 return render(request, 'catalogue/collection.html', {'collection': coll})
96 def differentiate_tags(request, tags, ambiguous_slugs):
97 beginning = '/'.join(tag.url_chunk for tag in tags)
98 unparsed = '/'.join(ambiguous_slugs[1:])
100 for tag in Tag.objects.filter(slug=ambiguous_slugs[0]):
102 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
105 return render_to_response(
106 'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
107 context_instance=RequestContext(request))
110 # TODO: Rewrite this hellish piece of code which tries to do everything
111 def tagged_object_list(request, tags='', list_type='books'):
113 # preliminary tests and conditions
114 gallery = list_type == 'gallery'
115 audiobooks = list_type == 'audiobooks'
117 tags = Tag.get_tag_list(tags)
118 except Tag.DoesNotExist:
119 # Perhaps the user is asking about an author in Public Domain
120 # counter (they are not represented in tags)
121 chunks = tags.split('/')
122 if len(chunks) == 2 and chunks[0] == 'autor':
123 return pdcounter_views.author_detail(request, chunks[1])
126 except Tag.MultipleObjectsReturned, e:
127 # Ask the user to disambiguate
128 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
129 except Tag.UrlDeprecationWarning, e:
130 return HttpResponsePermanentRedirect(
131 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 = any(tag.category == 'theme' for tag in tags)
141 shelf_is_set = any(tag.category == 'set' for tag in tags)
142 only_shelf = shelf_is_set and len(tags) == 1
143 only_my_shelf = only_shelf and request.user == tags[0].user
144 tags_pks = [tag.pk for tag in tags]
146 if gallery and shelf_is_set:
151 # Only fragments (or pirctureareas) here.
152 shelf_tags = [tag for tag in tags if tag.category == 'set']
153 fragment_tags = [tag for tag in tags if tag.category != 'set']
155 fragments = PictureArea.tagged.with_all(fragment_tags)
157 fragments = Fragment.tagged.with_all(fragment_tags)
160 # TODO: Pictures on shelves not supported yet.
161 books = Book.tagged.with_all(shelf_tags).order_by()
162 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
164 categories = split_tags(
165 Tag.objects.usage_for_queryset(fragments, counts=True).exclude(pk__in=tags_pks),
171 # TODO: Pictures on shelves not supported yet.
173 objects = Picture.tagged.with_all(tags)
175 objects = Picture.objects.all()
176 areas = PictureArea.objects.filter(picture__in=objects)
177 categories = split_tags(
178 Tag.objects.usage_for_queryset(
179 objects, counts=True).exclude(pk__in=tags_pks),
180 Tag.objects.usage_for_queryset(
181 areas, counts=True).filter(
182 category__in=('theme', 'thing')).exclude(
187 all_books = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
189 all_books = Book.tagged.with_all(tags, all_books)
191 # there's never only the daisy audiobook
192 daisy = objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
193 related_book_tags = Tag.objects.usage_for_queryset(
194 objects, counts=True).exclude(
195 category='set').exclude(pk__in=tags_pks)
198 all_books = Book.tagged.with_all(tags)
200 all_books = Book.objects.filter(parent=None)
203 related_book_tags = Tag.objects.usage_for_queryset(
204 objects, counts=True).exclude(
205 category='set').exclude(pk__in=tags_pks)
208 objects = Book.tagged_top_level(tags)
211 related_book_tags = get_top_level_related_tags(tags)
213 fragments = Fragment.objects.filter(book__in=all_books)
215 categories = split_tags(
217 Tag.objects.usage_for_queryset(
218 fragments, counts=True).filter(
219 category='theme').exclude(pk__in=tags_pks),
221 objects = objects.order_by('sort_key_author', 'sort_key')
223 objects = list(objects)
225 best = random.sample(objects, 3)
229 if not gallery and not objects and len(tags) == 1:
231 if tag.category in ('theme', 'thing') and (
232 PictureArea.tagged.with_any([tag]).exists() or
233 Picture.tagged.with_any([tag]).exists()):
234 return redirect('tagged_object_list_gallery', raw_tags)
236 # this is becoming more and more hacky
237 if list_type == 'books' and not tags:
238 last_published = Book.objects.exclude(cover_thumb='').filter(parent=None).order_by('-created_at')[:20]
240 last_published = None
242 return render_to_response(
243 'catalogue/tagged_object_list.html',
245 'object_list': objects,
246 'categories': categories,
247 'only_shelf': only_shelf,
248 'only_my_shelf': only_my_shelf,
249 'formats_form': forms.DownloadFormatsForm(),
252 'theme_is_set': theme_is_set,
254 'list_type': list_type,
256 'last_published': last_published,
257 'active_menu_item': 'theme' if theme_is_set else list_type,
259 context_instance=RequestContext(request))
262 def book_fragments(request, slug, theme_slug):
263 book = get_object_or_404(Book, slug=slug)
264 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
265 fragments = Fragment.tagged.with_all([theme]).filter(
266 Q(book=book) | Q(book__ancestor=book))
268 return render_to_response('catalogue/book_fragments.html', {
271 'fragments': fragments,
272 }, context_instance=RequestContext(request))
275 def book_detail(request, slug):
277 book = Book.objects.get(slug=slug)
278 except Book.DoesNotExist:
279 return pdcounter_views.book_stub_detail(request, slug)
281 return render_to_response('catalogue/book_detail.html', {
283 'tags': book.tags.exclude(category__in=('set', 'theme')),
284 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
285 }, context_instance=RequestContext(request))
288 def get_audiobooks(book):
290 for m in book.media.filter(type='ogg').order_by().iterator():
291 ogg_files[m.name] = m
296 for mp3 in book.media.filter(type='mp3').iterator():
297 # ogg files are always from the same project
298 meta = mp3.extra_info
299 project = meta.get('project')
302 project = u'CzytamySłuchając'
304 projects.add((project, meta.get('funded_by', '')))
308 ogg = ogg_files.get(mp3.name)
313 audiobooks.append(media)
315 projects = sorted(projects)
316 return audiobooks, projects, have_oggs
319 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
320 def player(request, slug):
321 book = get_object_or_404(Book, slug=slug)
322 if not book.has_media('mp3'):
325 audiobooks, projects, have_oggs = get_audiobooks(book)
327 # extra_info = book.extra_info
329 return render_to_response('catalogue/player.html', {
332 'audiobooks': audiobooks,
333 'projects': projects,
334 }, context_instance=RequestContext(request))
337 def book_text(request, slug):
338 book = get_object_or_404(Book, slug=slug)
340 if not book.has_html_file():
342 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
349 def _no_diacritics_regexp(query):
350 """ returns a regexp for searching for a query without diacritics
352 should be locale-aware """
354 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śŚ',
356 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
362 return u"(%s)" % '|'.join(names[l])
364 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
367 def unicode_re_escape(query):
368 """ Unicode-friendly version of re.escape """
369 return re.sub(r'(?u)(\W)', r'\\\1', query)
372 def _word_starts_with(name, prefix):
373 """returns a Q object getting models having `name` contain a word
374 starting with `prefix`
376 We define word characters as alphanumeric and underscore, like in JS.
378 Works for MySQL, PostgreSQL, Oracle.
379 For SQLite, _sqlite* version is substituted for this.
383 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
384 # can't use [[:<:]] (word start),
385 # but we want both `xy` and `(xy` to catch `(xyz)`
386 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
391 def _word_starts_with_regexp(prefix):
392 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
393 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
396 def _sqlite_word_starts_with(name, prefix):
397 """ version of _word_starts_with for SQLite
399 SQLite in Django uses Python re module
401 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
405 if hasattr(settings, 'DATABASES'):
406 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
407 _word_starts_with = _sqlite_word_starts_with
408 elif settings.DATABASE_ENGINE == 'sqlite3':
409 _word_starts_with = _sqlite_word_starts_with
413 def __init__(self, name, view):
416 self.lower = name.lower()
417 self.category = 'application'
420 return reverse(*self._view)
423 App(u'Leśmianator', (u'lesmianator', )),
427 def _tags_starting_with(prefix, user=None):
428 prefix = prefix.lower()
430 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
431 authors = Author.objects.filter(_word_starts_with('name', prefix))
433 books = Book.objects.filter(_word_starts_with('title', prefix))
434 tags = Tag.objects.filter(_word_starts_with('name', prefix))
435 if user and user.is_authenticated():
436 tags = tags.filter(~Q(category='set') | Q(user=user))
438 tags = tags.exclude(category='set')
440 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
441 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
445 def _get_result_link(match, tag_list):
446 if isinstance(match, Tag):
447 return reverse('catalogue.views.tagged_object_list',
448 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
449 elif isinstance(match, App):
452 return match.get_absolute_url()
455 def _get_result_type(match):
456 if isinstance(match, Book) or isinstance(match, BookStub):
459 match_type = match.category
463 def books_starting_with(prefix):
464 prefix = prefix.lower()
465 return Book.objects.filter(_word_starts_with('title', prefix))
468 def find_best_matches(query, user=None):
469 """ Finds a Book, Tag, BookStub or Author best matching a query.
472 - zero elements when nothing is found,
473 - one element when a best result is found,
474 - more then one element on multiple exact matches
476 Raises a ValueError on too short a query.
479 query = query.lower()
481 raise ValueError("query must have at least two characters")
483 result = tuple(_tags_starting_with(query, user))
484 # remove pdcounter stuff
485 book_titles = set(match.pretty_title().lower() for match in result
486 if isinstance(match, Book))
487 authors = set(match.name.lower() for match in result
488 if isinstance(match, Tag) and match.category == 'author')
489 result = tuple(res for res in result if not (
490 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
491 (isinstance(res, Author) and res.name.lower() in authors)
494 exact_matches = tuple(res for res in result if res.name.lower() == query)
498 return tuple(result)[:1]
502 tags = request.GET.get('tags', '')
503 prefix = request.GET.get('q', '')
506 tag_list = Tag.get_tag_list(tags)
507 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
511 result = find_best_matches(prefix, request.user)
513 return render_to_response(
514 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
515 context_instance=RequestContext(request))
518 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
519 elif len(result) > 1:
520 return render_to_response(
521 'catalogue/search_multiple_hits.html',
523 'tags': tag_list, 'prefix': prefix,
524 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
526 context_instance=RequestContext(request))
528 form = PublishingSuggestForm(initial={"books": prefix + ", "})
529 return render_to_response(
530 'catalogue/search_no_hits.html',
531 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
532 context_instance=RequestContext(request))
535 def tags_starting_with(request):
536 prefix = request.GET.get('q', '')
537 # Prefix must have at least 2 characters
539 return HttpResponse('')
542 for tag in _tags_starting_with(prefix, request.user):
543 if tag.name not in tags_list:
544 result += "\n" + tag.name
545 tags_list.append(tag.name)
546 return HttpResponse(result)
549 def json_tags_starting_with(request, callback=None):
551 prefix = request.GET.get('q', '')
552 callback = request.GET.get('callback', '')
553 # Prefix must have at least 2 characters
555 return HttpResponse('')
557 for tag in _tags_starting_with(prefix, request.user):
558 if tag.name not in tags_list:
559 tags_list.append(tag.name)
560 if request.GET.get('mozhint', ''):
561 result = [prefix, tags_list]
563 result = {"matches": tags_list}
564 response = JsonResponse(result, safe=False)
566 response.content = callback + "(" + response.content + ");"
575 def import_book(request):
576 """docstring for import_book"""
577 book_import_form = forms.BookImportForm(request.POST, request.FILES)
578 if book_import_form.is_valid():
580 book_import_form.save()
585 info = sys.exc_info()
586 exception = pprint.pformat(info[1])
587 tb = '\n'.join(traceback.format_tb(info[2]))
589 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
590 mimetype='text/plain')
591 return HttpResponse(_("Book imported successfully"))
593 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
598 def book_info(request, book_id, lang='pl'):
599 book = get_object_or_404(Book, id=book_id)
600 # set language by hand
601 translation.activate(lang)
602 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
605 def tag_info(request, tag_id):
606 tag = get_object_or_404(Tag, id=tag_id)
607 return HttpResponse(tag.description)
610 def download_zip(request, format, slug=None):
611 if format in Book.ebook_formats:
612 url = Book.zip_format(format)
613 elif format in ('mp3', 'ogg') and slug is not None:
614 book = get_object_or_404(Book, slug=slug)
615 url = book.zip_audiobooks(format)
617 raise Http404('No format specified for zip package')
618 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
621 class CustomPDFFormView(AjaxableFormView):
622 form_class = forms.CustomPDFForm
623 title = ugettext_lazy('Download custom PDF')
624 submit = ugettext_lazy('Download')
627 def __call__(self, *args, **kwargs):
628 if settings.NO_CUSTOM_PDF:
629 raise Http404('Custom PDF is disabled')
630 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
632 def form_args(self, request, obj):
633 """Override to parse view args and give additional args to the form."""
636 def get_object(self, request, slug, *args, **kwargs):
637 return get_object_or_404(Book, slug=slug)
639 def context_description(self, request, obj):
640 return obj.pretty_title()
649 def book_mini(request, pk, with_link=True):
650 book = get_object_or_404(Book, pk=pk)
651 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
652 return render(request, 'catalogue/book_mini_box.html', {
654 'author_str': author_str,
655 'with_link': with_link,
656 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
660 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
661 ('ssify.get_csrf_token',),
662 ('social_tags.likes_book', (ipk,)),
663 ('social_tags.book_shelf_tags', (ipk,)),
664 ))(ssi_expect(pk, int)))
665 def book_short(request, pk):
666 book = get_object_or_404(Book, pk=pk)
667 stage_note, stage_note_url = book.stage_note()
668 audiobooks, projects, have_oggs = get_audiobooks(book)
670 return render(request, 'catalogue/book_short.html', {
672 'has_audio': book.has_media('mp3'),
673 'main_link': book.get_absolute_url(),
674 'parents': book.parents(),
675 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
676 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
677 'stage_note': stage_note,
678 'stage_note_url': stage_note_url,
679 'audiobooks': audiobooks,
680 'have_oggs': have_oggs,
685 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
687 ('social_tags.choose_cite', [ipk]),
688 ('catalogue_tags.choose_fragment', [ipk], {
689 'unless': Var('social_tags.choose_cite', [ipk])}),
690 ))(ssi_expect(pk, int)))
691 def book_wide(request, pk):
692 book = get_object_or_404(Book, pk=pk)
693 stage_note, stage_note_url = book.stage_note()
694 extra_info = book.extra_info
695 audiobooks, projects, have_oggs = get_audiobooks(book)
697 return render(request, 'catalogue/book_wide.html', {
699 'has_audio': book.has_media('mp3'),
700 'parents': book.parents(),
701 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
702 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
703 'stage_note': stage_note,
704 'stage_note_url': stage_note_url,
706 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
707 'extra_info': extra_info,
708 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
709 'audiobooks': audiobooks,
710 'have_oggs': have_oggs,
715 def fragment_short(request, pk):
716 fragment = get_object_or_404(Fragment, pk=pk)
717 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
721 def fragment_promo(request, pk):
722 fragment = get_object_or_404(Fragment, pk=pk)
723 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
727 def tag_box(request, pk):
728 tag = get_object_or_404(Tag, pk=pk)
729 assert tag.category != 'set'
731 return render(request, 'catalogue/tag_box.html', {
737 def collection_box(request, pk):
738 obj = get_object_or_404(Collection, pk=pk)
740 return render(request, 'catalogue/collection_box.html', {
745 def tag_catalogue(request, category):
746 if category == 'theme':
747 tags = Tag.objects.usage_for_model(
748 Fragment, counts=True).filter(category='theme')
750 tags = list(get_top_level_related_tags((), categories=(category,)))
752 described_tags = [tag for tag in tags if tag.description]
754 if len(described_tags) > 4:
755 best = random.sample(described_tags, 4)
757 best = described_tags
759 return render(request, 'catalogue/tag_catalogue.html', {
762 'title': constants.CATEGORIES_NAME_PLURAL[category],
763 'whole_category': constants.WHOLE_CATEGORY[category],
764 'active_menu_item': 'theme' if category == 'theme' else None,
768 def collections(request):
769 objects = Collection.objects.all()
772 best = random.sample(objects, 3)
776 return render(request, 'catalogue/collections.html', {