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, QuerySet
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
32 from catalogue.models.tag import prefetch_relations
34 staff_required = user_passes_test(lambda user: user.is_staff)
37 def catalogue(request):
38 return render(request, 'catalogue/catalogue.html', {
39 'books': Book.objects.filter(parent=None),
40 'pictures': Picture.objects.all(),
41 'collections': Collection.objects.all(),
42 'active_menu_item': 'all_works',
46 def book_list(request, filters=None, template_name='catalogue/book_list.html',
47 nav_template_name='catalogue/snippets/book_list_nav.html',
48 list_template_name='catalogue/snippets/book_list.html'):
49 """ generates a listing of all books, optionally filtered """
50 books_by_author, orphans, books_by_parent = Book.book_list(filters)
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 daisy_list(request):
67 return book_list(request, Q(media__type='daisy'), template_name='catalogue/daisy_list.html')
70 def collection(request, slug):
71 coll = get_object_or_404(Collection, slug=slug)
72 return render(request, 'catalogue/collection.html', {'collection': coll})
75 def differentiate_tags(request, tags, ambiguous_slugs):
76 beginning = '/'.join(tag.url_chunk for tag in tags)
77 unparsed = '/'.join(ambiguous_slugs[1:])
79 for tag in Tag.objects.filter(slug=ambiguous_slugs[0]):
81 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
84 return render_to_response(
85 'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
86 context_instance=RequestContext(request))
89 def object_list(request, objects, fragments=None, related_tags=None, tags=None, list_type='books', extra=None):
92 tag_ids = [tag.pk for tag in tags]
94 related_tag_lists = []
96 related_tag_lists.append(related_tags)
98 related_tag_lists.append(
99 Tag.objects.usage_for_queryset(objects, counts=True).exclude(category='set').exclude(pk__in=tag_ids))
100 if not (extra and extra.get('theme_is_set')):
101 if fragments is None:
102 if list_type == 'gallery':
103 fragments = PictureArea.objects.filter(picture__in=objects)
105 fragments = Fragment.objects.filter(book__in=objects)
106 related_tag_lists.append(
107 Tag.objects.usage_for_queryset(fragments, counts=True).filter(category='theme').exclude(pk__in=tag_ids)
108 .only('name', 'sort_key', 'category', 'slug'))
109 if isinstance(objects, QuerySet):
110 objects = prefetch_relations(objects, 'author')
112 categories = split_tags(*related_tag_lists)
114 objects = list(objects)
116 if not objects and len(tags) == 1 and list_type == 'books':
117 if PictureArea.tagged.with_any(tags).exists() or Picture.tagged.with_any(tags).exists():
118 return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
121 best = random.sample(objects, 3)
126 'object_list': objects,
127 'categories': categories,
128 'list_type': list_type,
131 'formats_form': forms.DownloadFormatsForm(),
133 'active_menu_item': list_type,
137 return render_to_response(
138 'catalogue/tagged_object_list.html', result,
139 context_instance=RequestContext(request))
142 def literature(request):
143 books = Book.objects.filter(parent=None)
145 # last_published = Book.objects.exclude(cover_thumb='').filter(parent=None).order_by('-created_at')[:20]
146 # most_popular = Book.objects.exclude(cover_thumb='')\
147 # .order_by('-popularity__count', 'sort_key_author', 'sort_key')[:20]
148 return object_list(request, books, related_tags=get_top_level_related_tags([]))
150 # 'last_published': last_published,
151 # 'most_popular': most_popular,
155 def gallery(request):
156 return object_list(request, Picture.objects.all(), list_type='gallery')
159 def audiobooks(request):
160 audiobooks = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
161 return object_list(request, audiobooks, list_type='audiobooks', extra={
162 'daisy': Book.objects.filter(media__type='daisy').distinct(),
166 class ResponseInstead(Exception):
167 def __init__(self, response):
168 super(ResponseInstead, self).__init__()
169 self.response = response
172 def analyse_tags(request, tag_str):
174 tags = Tag.get_tag_list(tag_str)
175 except Tag.DoesNotExist:
176 # Perhaps the user is asking about an author in Public Domain
177 # counter (they are not represented in tags)
178 chunks = tag_str.split('/')
179 if len(chunks) == 2 and chunks[0] == 'autor':
180 raise ResponseInstead(pdcounter_views.author_detail(request, chunks[1]))
183 except Tag.MultipleObjectsReturned, e:
184 # Ask the user to disambiguate
185 raise ResponseInstead(differentiate_tags(request, e.tags, e.ambiguous_slugs))
186 except Tag.UrlDeprecationWarning, e:
187 raise ResponseInstead(HttpResponsePermanentRedirect(
188 reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)])))
191 if len(tags) > settings.MAX_TAG_LIST:
193 except AttributeError:
199 def theme_list(request, tags, list_type):
200 shelf_tags = [tag for tag in tags if tag.category == 'set']
201 fragment_tags = [tag for tag in tags if tag.category != 'set']
202 if list_type == 'gallery':
203 fragments = PictureArea.tagged.with_all(fragment_tags)
205 fragments = Fragment.tagged.with_all(fragment_tags)
208 # TODO: Pictures on shelves not supported yet.
209 books = Book.tagged.with_all(shelf_tags).order_by()
210 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
212 if not fragments and len(tags) == 1 and list_type == 'books':
213 if PictureArea.tagged.with_any(tags).exists() or Picture.tagged.with_any(tags).exists():
214 return redirect('tagged_object_list_gallery', '/'.join(tag.url_chunk for tag in tags))
216 return object_list(request, fragments, tags=tags, list_type=list_type, extra={
217 'theme_is_set': True,
218 'active_menu_item': 'theme',
222 def tagged_object_list(request, tags, list_type):
224 tags = analyse_tags(request, tags)
225 except ResponseInstead as e:
228 if list_type == 'gallery' and any(tag.category == 'set' for tag in tags):
231 if any(tag.category in ('theme', 'thing') for tag in tags):
232 return theme_list(request, tags, list_type=list_type)
234 if list_type == 'books':
235 books = Book.tagged.with_all(tags)
237 if any(tag.category == 'set' for tag in tags):
238 params = {'objects': books}
241 'objects': Book.tagged_top_level(tags),
242 'fragments': Fragment.objects.filter(book__in=books),
243 'related_tags': get_top_level_related_tags(tags),
245 elif list_type == 'gallery':
246 params = {'objects': Picture.tagged.with_all(tags)}
247 elif list_type == 'audiobooks':
248 audiobooks = Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct()
250 'objects': Book.tagged.with_all(tags, audiobooks),
252 'daisy': Book.tagged.with_all(tags, audiobooks.filter(media__type='daisy').distinct()),
258 return object_list(request, tags=tags, list_type=list_type, **params)
261 def book_fragments(request, slug, theme_slug):
262 book = get_object_or_404(Book, slug=slug)
263 theme = get_object_or_404(Tag, slug=theme_slug, category='theme')
264 fragments = Fragment.tagged.with_all([theme]).filter(
265 Q(book=book) | Q(book__ancestor=book))
267 return render_to_response('catalogue/book_fragments.html', {
270 'fragments': fragments,
271 'active_menu_item': 'books',
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 'active_menu_item': 'books',
286 }, context_instance=RequestContext(request))
289 def get_audiobooks(book):
291 for m in book.media.filter(type='ogg').order_by().iterator():
292 ogg_files[m.name] = m
297 for mp3 in book.media.filter(type='mp3').iterator():
298 # ogg files are always from the same project
299 meta = mp3.extra_info
300 project = meta.get('project')
303 project = u'CzytamySłuchając'
305 projects.add((project, meta.get('funded_by', '')))
309 ogg = ogg_files.get(mp3.name)
314 audiobooks.append(media)
316 projects = sorted(projects)
317 return audiobooks, projects, have_oggs
320 # używane w publicznym interfejsie
321 def player(request, slug):
322 book = get_object_or_404(Book, slug=slug)
323 if not book.has_media('mp3'):
326 audiobooks, projects, have_oggs = get_audiobooks(book)
328 return render_to_response('catalogue/player.html', {
331 'audiobooks': audiobooks,
332 'projects': projects,
333 }, context_instance=RequestContext(request))
336 def book_text(request, slug):
337 book = get_object_or_404(Book, slug=slug)
339 if not book.has_html_file():
341 return render_to_response('catalogue/book_text.html', {'book': book}, context_instance=RequestContext(request))
348 def _no_diacritics_regexp(query):
349 """ returns a regexp for searching for a query without diacritics
351 should be locale-aware """
353 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śŚ',
355 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
361 return u"(?:%s)" % '|'.join(names[l])
363 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
366 def unicode_re_escape(query):
367 """ Unicode-friendly version of re.escape """
368 return re.sub(r'(?u)(\W)', r'\\\1', query)
371 def _word_starts_with(name, prefix):
372 """returns a Q object getting models having `name` contain a word
373 starting with `prefix`
375 We define word characters as alphanumeric and underscore, like in JS.
377 Works for MySQL, PostgreSQL, Oracle.
378 For SQLite, _sqlite* version is substituted for this.
382 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
383 # can't use [[:<:]] (word start),
384 # but we want both `xy` and `(xy` to catch `(xyz)`
385 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
390 def _word_starts_with_regexp(prefix):
391 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
392 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
395 def _sqlite_word_starts_with(name, prefix):
396 """ version of _word_starts_with for SQLite
398 SQLite in Django uses Python re module
400 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
404 if hasattr(settings, 'DATABASES'):
405 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
406 _word_starts_with = _sqlite_word_starts_with
407 elif settings.DATABASE_ENGINE == 'sqlite3':
408 _word_starts_with = _sqlite_word_starts_with
412 def __init__(self, name, view):
415 self.lower = name.lower()
416 self.category = 'application'
419 return reverse(*self._view)
422 App(u'Leśmianator', (u'lesmianator', )),
426 def _tags_starting_with(prefix, user=None):
427 prefix = prefix.lower()
429 book_stubs = BookStub.objects.filter(_word_starts_with('title', prefix))
430 authors = Author.objects.filter(_word_starts_with('name', prefix))
432 books = Book.objects.filter(_word_starts_with('title', prefix))
433 tags = Tag.objects.filter(_word_starts_with('name', prefix))
434 if user and user.is_authenticated():
435 tags = tags.filter(~Q(category='set') | Q(user=user))
437 tags = tags.exclude(category='set')
439 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
440 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
444 def _get_result_link(match, tag_list):
445 if isinstance(match, Tag):
446 return reverse('catalogue.views.tagged_object_list',
447 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
448 elif isinstance(match, App):
451 return match.get_absolute_url()
454 def _get_result_type(match):
455 if isinstance(match, Book) or isinstance(match, BookStub):
458 match_type = match.category
462 def books_starting_with(prefix):
463 prefix = prefix.lower()
464 return Book.objects.filter(_word_starts_with('title', prefix))
467 def find_best_matches(query, user=None):
468 """ Finds a Book, Tag, BookStub or Author best matching a query.
471 - zero elements when nothing is found,
472 - one element when a best result is found,
473 - more then one element on multiple exact matches
475 Raises a ValueError on too short a query.
478 query = query.lower()
480 raise ValueError("query must have at least two characters")
482 result = tuple(_tags_starting_with(query, user))
483 # remove pdcounter stuff
484 book_titles = set(match.pretty_title().lower() for match in result
485 if isinstance(match, Book))
486 authors = set(match.name.lower() for match in result
487 if isinstance(match, Tag) and match.category == 'author')
488 result = tuple(res for res in result if not (
489 (isinstance(res, BookStub) and res.pretty_title().lower() in book_titles) or
490 (isinstance(res, Author) and res.name.lower() in authors)
493 exact_matches = tuple(res for res in result if res.name.lower() == query)
497 return tuple(result)[:1]
501 tags = request.GET.get('tags', '')
502 prefix = request.GET.get('q', '')
505 tag_list = Tag.get_tag_list(tags)
506 except (Tag.DoesNotExist, Tag.MultipleObjectsReturned, Tag.UrlDeprecationWarning):
510 result = find_best_matches(prefix, request.user)
512 return render_to_response(
513 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
514 context_instance=RequestContext(request))
517 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
518 elif len(result) > 1:
519 return render_to_response(
520 'catalogue/search_multiple_hits.html',
522 'tags': tag_list, 'prefix': prefix,
523 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
525 context_instance=RequestContext(request))
527 form = PublishingSuggestForm(initial={"books": prefix + ", "})
528 return render_to_response(
529 'catalogue/search_no_hits.html',
530 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
531 context_instance=RequestContext(request))
534 def tags_starting_with(request):
535 prefix = request.GET.get('q', '')
536 # Prefix must have at least 2 characters
538 return HttpResponse('')
541 for tag in _tags_starting_with(prefix, request.user):
542 if tag.name not in tags_list:
543 result += "\n" + tag.name
544 tags_list.append(tag.name)
545 return HttpResponse(result)
548 def json_tags_starting_with(request, callback=None):
550 prefix = request.GET.get('q', '')
551 callback = request.GET.get('callback', '')
552 # Prefix must have at least 2 characters
554 return HttpResponse('')
556 for tag in _tags_starting_with(prefix, request.user):
557 if tag.name not in tags_list:
558 tags_list.append(tag.name)
559 if request.GET.get('mozhint', ''):
560 result = [prefix, tags_list]
562 result = {"matches": tags_list}
563 response = JsonResponse(result, safe=False)
565 response.content = callback + "(" + response.content + ");"
574 def import_book(request):
575 """docstring for import_book"""
576 book_import_form = forms.BookImportForm(request.POST, request.FILES)
577 if book_import_form.is_valid():
579 book_import_form.save()
584 info = sys.exc_info()
585 exception = pprint.pformat(info[1])
586 tb = '\n'.join(traceback.format_tb(info[2]))
588 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
589 mimetype='text/plain')
590 return HttpResponse(_("Book imported successfully"))
592 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
597 def book_info(request, book_id, lang='pl'):
598 book = get_object_or_404(Book, id=book_id)
599 # set language by hand
600 translation.activate(lang)
601 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
604 def tag_info(request, tag_id):
605 tag = get_object_or_404(Tag, id=tag_id)
606 return HttpResponse(tag.description)
609 def download_zip(request, format, slug=None):
610 if format in Book.ebook_formats:
611 url = Book.zip_format(format)
612 elif format in ('mp3', 'ogg') and slug is not None:
613 book = get_object_or_404(Book, slug=slug)
614 url = book.zip_audiobooks(format)
616 raise Http404('No format specified for zip package')
617 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
620 class CustomPDFFormView(AjaxableFormView):
621 form_class = forms.CustomPDFForm
622 title = ugettext_lazy('Download custom PDF')
623 submit = ugettext_lazy('Download')
626 def __call__(self, *args, **kwargs):
627 if settings.NO_CUSTOM_PDF:
628 raise Http404('Custom PDF is disabled')
629 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
631 def form_args(self, request, obj):
632 """Override to parse view args and give additional args to the form."""
635 def get_object(self, request, slug, *args, **kwargs):
636 return get_object_or_404(Book, slug=slug)
638 def context_description(self, request, obj):
639 return obj.pretty_title()
648 def book_mini(request, pk, with_link=True):
649 # book = get_object_or_404(Book, pk=pk)
651 book = Book.objects.only('cover_thumb', 'title', 'language', 'slug').get(pk=pk)
652 except Book.DoesNotExist:
654 return render(request, 'catalogue/book_mini_box.html', {
656 'no_link': not with_link,
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 collection = get_object_or_404(Collection, pk=pk)
740 return render(request, 'catalogue/collection_box.html', {
741 'collection': collection,
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', {