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 import models as pdcounter_models
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 V
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 import models
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': models.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': models.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 = models.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 = models.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 = models.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(models.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 models.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='', gallery=False):
112 # preliminary tests and conditions
114 tags = models.Tag.get_tag_list(tags)
115 except models.Tag.DoesNotExist:
116 # Perhaps the user is asking about an author in Public Domain
117 # counter (they are not represented in tags)
118 chunks = tags.split('/')
119 if len(chunks) == 2 and chunks[0] == 'autor':
120 return pdcounter_views.author_detail(request, chunks[1])
123 except models.Tag.MultipleObjectsReturned, e:
124 # Ask the user to disambiguate
125 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
126 except models.Tag.UrlDeprecationWarning, e:
127 return HttpResponsePermanentRedirect(
128 reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
131 if len(tags) > settings.MAX_TAG_LIST:
133 except AttributeError:
136 # beginning of digestion
137 theme_is_set = [tag for tag in tags if tag.category == 'theme']
138 shelf_is_set = [tag for tag in tags if tag.category == 'set']
139 only_shelf = shelf_is_set and len(tags) == 1
140 only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
141 tags_pks = [tag.pk for tag in tags]
146 # Only fragments (or pirctureareas) here.
147 shelf_tags = [tag for tag in tags if tag.category == 'set']
148 fragment_tags = [tag for tag in tags if tag.category != 'set']
150 fragments = PictureArea.tagged.with_all(fragment_tags)
152 fragments = models.Fragment.tagged.with_all(fragment_tags)
156 # TODO: Pictures on shelves not supported yet.
159 books = models.Book.tagged.with_all(shelf_tags).order_by()
160 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
162 categories = split_tags(
163 models.Tag.objects.usage_for_queryset(fragments, counts=True).exclude(pk__in=tags_pks),
170 # TODO: Pictures on shelves not supported yet.
174 objects = Picture.tagged.with_all(tags)
176 objects = Picture.objects.all()
177 areas = PictureArea.objects.filter(picture__in=objects)
178 categories = split_tags(
179 models.Tag.objects.usage_for_queryset(
180 objects, counts=True).exclude(pk__in=tags_pks),
181 models.Tag.objects.usage_for_queryset(
182 areas, counts=True).filter(
183 category__in=('theme', 'thing')).exclude(
188 all_books = models.Book.tagged.with_all(tags)
190 all_books = models.Book.objects.filter(parent=None)
193 related_book_tags = models.Tag.objects.usage_for_queryset(
194 objects, counts=True).exclude(
195 category='set').exclude(pk__in=tags_pks)
198 objects = models.Book.tagged_top_level(tags)
201 # WTF: was outside if, overwriting value assigned if shelf_is_set
202 related_book_tags = get_top_level_related_tags(tags)
204 fragments = models.Fragment.objects.filter(book__in=all_books)
206 categories = split_tags(
208 models.Tag.objects.usage_for_queryset(
209 fragments, counts=True).filter(
210 category='theme').exclude(pk__in=tags_pks),
212 objects = objects.order_by('sort_key_author', 'sort_key')
214 objects = list(objects)
216 best = random.sample(objects, 3)
220 if not gallery and not objects and len(tags) == 1:
222 if (tag.category in ('theme', 'thing') and PictureArea.tagged.with_any([tag]).exists() or
223 Picture.tagged.with_any([tag]).exists()):
224 return redirect('tagged_object_list_gallery', raw_tags, permanent=False)
226 return render_to_response(
227 'catalogue/tagged_object_list.html',
229 'object_list': objects,
230 'categories': categories,
231 'only_shelf': only_shelf,
232 'only_my_shelf': only_my_shelf,
233 'formats_form': forms.DownloadFormatsForm(),
236 'theme_is_set': theme_is_set,
240 context_instance=RequestContext(request))
243 def book_fragments(request, slug, theme_slug):
244 book = get_object_or_404(models.Book, slug=slug)
245 theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
246 fragments = models.Fragment.tagged.with_all([theme]).filter(
247 Q(book=book) | Q(book__ancestor=book))
249 return render_to_response('catalogue/book_fragments.html', {
252 'fragments': fragments,
253 }, context_instance=RequestContext(request))
256 def book_detail(request, slug):
258 book = models.Book.objects.get(slug=slug)
259 except models.Book.DoesNotExist:
260 return pdcounter_views.book_stub_detail(request, slug)
262 return render_to_response('catalogue/book_detail.html', {
264 'tags': book.tags.exclude(category__in=('set', 'theme')),
265 'book_children': book.children.all().order_by('parent_number', 'sort_key'),
266 }, context_instance=RequestContext(request))
269 def get_audiobooks(book):
271 for m in book.media.filter(type='ogg').order_by().iterator():
272 ogg_files[m.name] = m
277 for mp3 in book.media.filter(type='mp3').iterator():
278 # ogg files are always from the same project
279 meta = mp3.extra_info
280 project = meta.get('project')
283 project = u'CzytamySłuchając'
285 projects.add((project, meta.get('funded_by', '')))
289 ogg = ogg_files.get(mp3.name)
294 audiobooks.append(media)
296 projects = sorted(projects)
297 return audiobooks, projects, have_oggs
300 # używane tylko do audiobook_tree, które jest używane tylko w snippets/audiobook_list.html, które nie jest używane
301 def player(request, slug):
302 book = get_object_or_404(models.Book, slug=slug)
303 if not book.has_media('mp3'):
306 audiobooks, projects, have_oggs = get_audiobooks(book)
308 # extra_info = book.extra_info
310 return render_to_response('catalogue/player.html', {
313 'audiobooks': audiobooks,
314 'projects': projects,
315 }, context_instance=RequestContext(request))
318 def book_text(request, slug):
319 book = get_object_or_404(models.Book, slug=slug)
321 if not book.has_html_file():
323 return render_to_response('catalogue/book_text.html', {'book': book,}, context_instance=RequestContext(request))
330 def _no_diacritics_regexp(query):
331 """ returns a regexp for searching for a query without diacritics
333 should be locale-aware """
335 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śŚ',
337 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
343 return u"(%s)" % '|'.join(names[l])
345 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
348 def unicode_re_escape(query):
349 """ Unicode-friendly version of re.escape """
350 return re.sub(r'(?u)(\W)', r'\\\1', query)
353 def _word_starts_with(name, prefix):
354 """returns a Q object getting models having `name` contain a word
355 starting with `prefix`
357 We define word characters as alphanumeric and underscore, like in JS.
359 Works for MySQL, PostgreSQL, Oracle.
360 For SQLite, _sqlite* version is substituted for this.
364 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
365 # can't use [[:<:]] (word start),
366 # but we want both `xy` and `(xy` to catch `(xyz)`
367 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
372 def _word_starts_with_regexp(prefix):
373 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
374 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
377 def _sqlite_word_starts_with(name, prefix):
378 """ version of _word_starts_with for SQLite
380 SQLite in Django uses Python re module
382 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
386 if hasattr(settings, 'DATABASES'):
387 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
388 _word_starts_with = _sqlite_word_starts_with
389 elif settings.DATABASE_ENGINE == 'sqlite3':
390 _word_starts_with = _sqlite_word_starts_with
394 def __init__(self, name, view):
397 self.lower = name.lower()
398 self.category = 'application'
401 return reverse(*self._view)
404 App(u'Leśmianator', (u'lesmianator', )),
408 def _tags_starting_with(prefix, user=None):
409 prefix = prefix.lower()
411 book_stubs = pdcounter_models.BookStub.objects.filter(_word_starts_with('title', prefix))
412 authors = pdcounter_models.Author.objects.filter(_word_starts_with('name', prefix))
414 books = models.Book.objects.filter(_word_starts_with('title', prefix))
415 tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
416 if user and user.is_authenticated():
417 tags = tags.filter(~Q(category='set') | Q(user=user))
419 tags = tags.exclude(category='set')
421 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
422 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
426 def _get_result_link(match, tag_list):
427 if isinstance(match, models.Tag):
428 return reverse('catalogue.views.tagged_object_list',
429 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
430 elif isinstance(match, App):
433 return match.get_absolute_url()
436 def _get_result_type(match):
437 if isinstance(match, models.Book) or isinstance(match, pdcounter_models.BookStub):
440 match_type = match.category
444 def books_starting_with(prefix):
445 prefix = prefix.lower()
446 return models.Book.objects.filter(_word_starts_with('title', prefix))
449 def find_best_matches(query, user=None):
450 """ Finds a models.Book, Tag, models.BookStub or Author best matching a query.
453 - zero elements when nothing is found,
454 - one element when a best result is found,
455 - more then one element on multiple exact matches
457 Raises a ValueError on too short a query.
460 query = query.lower()
462 raise ValueError("query must have at least two characters")
464 result = tuple(_tags_starting_with(query, user))
465 # remove pdcounter stuff
466 book_titles = set(match.pretty_title().lower() for match in result
467 if isinstance(match, models.Book))
468 authors = set(match.name.lower() for match in result
469 if isinstance(match, models.Tag) and match.category == 'author')
470 result = tuple(res for res in result if not (
471 (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles) or
472 (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
475 exact_matches = tuple(res for res in result if res.name.lower() == query)
479 return tuple(result)[:1]
483 tags = request.GET.get('tags', '')
484 prefix = request.GET.get('q', '')
487 tag_list = models.Tag.get_tag_list(tags)
488 except (models.Tag.DoesNotExist, models.Tag.MultipleObjectsReturned, models.Tag.UrlDeprecationWarning):
492 result = find_best_matches(prefix, request.user)
494 return render_to_response(
495 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
496 context_instance=RequestContext(request))
499 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
500 elif len(result) > 1:
501 return render_to_response(
502 'catalogue/search_multiple_hits.html',
504 'tags': tag_list, 'prefix': prefix,
505 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
507 context_instance=RequestContext(request))
509 form = PublishingSuggestForm(initial={"books": prefix + ", "})
510 return render_to_response(
511 'catalogue/search_no_hits.html',
512 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
513 context_instance=RequestContext(request))
516 def tags_starting_with(request):
517 prefix = request.GET.get('q', '')
518 # Prefix must have at least 2 characters
520 return HttpResponse('')
523 for tag in _tags_starting_with(prefix, request.user):
524 if tag.name not in tags_list:
525 result += "\n" + tag.name
526 tags_list.append(tag.name)
527 return HttpResponse(result)
530 def json_tags_starting_with(request, callback=None):
532 prefix = request.GET.get('q', '')
533 callback = request.GET.get('callback', '')
534 # Prefix must have at least 2 characters
536 return HttpResponse('')
538 for tag in _tags_starting_with(prefix, request.user):
539 if tag.name not in tags_list:
540 tags_list.append(tag.name)
541 if request.GET.get('mozhint', ''):
542 result = [prefix, tags_list]
544 result = {"matches": tags_list}
545 response = JsonResponse(result, safe=False)
547 response.content = callback + "(" + response.content + ");"
556 def import_book(request):
557 """docstring for import_book"""
558 book_import_form = forms.BookImportForm(request.POST, request.FILES)
559 if book_import_form.is_valid():
561 book_import_form.save()
566 info = sys.exc_info()
567 exception = pprint.pformat(info[1])
568 tb = '\n'.join(traceback.format_tb(info[2]))
570 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
571 mimetype='text/plain')
572 return HttpResponse(_("Book imported successfully"))
574 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
579 def book_info(request, book_id, lang='pl'):
580 book = get_object_or_404(models.Book, id=book_id)
581 # set language by hand
582 translation.activate(lang)
583 return render_to_response('catalogue/book_info.html', {'book': book}, context_instance=RequestContext(request))
586 def tag_info(request, tag_id):
587 tag = get_object_or_404(models.Tag, id=tag_id)
588 return HttpResponse(tag.description)
591 def download_zip(request, format, slug=None):
592 if format in models.Book.ebook_formats:
593 url = models.Book.zip_format(format)
594 elif format in ('mp3', 'ogg') and slug is not None:
595 book = get_object_or_404(models.Book, slug=slug)
596 url = book.zip_audiobooks(format)
598 raise Http404('No format specified for zip package')
599 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
602 class CustomPDFFormView(AjaxableFormView):
603 form_class = forms.CustomPDFForm
604 title = ugettext_lazy('Download custom PDF')
605 submit = ugettext_lazy('Download')
608 def __call__(self, *args, **kwargs):
609 if settings.NO_CUSTOM_PDF:
610 raise Http404('Custom PDF is disabled')
611 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
613 def form_args(self, request, obj):
614 """Override to parse view args and give additional args to the form."""
617 def get_object(self, request, slug, *args, **kwargs):
618 return get_object_or_404(models.Book, slug=slug)
620 def context_description(self, request, obj):
621 return obj.pretty_title()
630 def book_mini(request, pk, with_link=True):
631 book = get_object_or_404(models.Book, pk=pk)
632 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
633 return render(request, 'catalogue/book_mini_box.html', {
635 'author_str': author_str,
636 'with_link': with_link,
637 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
641 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
642 ('ssify.get_csrf_token',),
643 ('social_tags.likes_book', (ipk,)),
644 ('social_tags.book_shelf_tags', (ipk,)),
645 ))(ssi_expect(pk, int)))
646 def book_short(request, pk):
647 book = get_object_or_404(models.Book, pk=pk)
648 stage_note, stage_note_url = book.stage_note()
649 audiobooks, projects, have_oggs = get_audiobooks(book)
651 return render(request, 'catalogue/book_short.html', {
653 'has_audio': book.has_media('mp3'),
654 'main_link': book.get_absolute_url(),
655 'parents': book.parents(),
656 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
657 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
658 'stage_note': stage_note,
659 'stage_note_url': stage_note_url,
660 'audiobooks': audiobooks,
661 'have_oggs': have_oggs,
666 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
668 ('social_tags.choose_cite', [ipk]),
669 ('catalogue_tags.choose_fragment', [ipk], {
670 'unless': V('social_tags.choose_cite', [ipk])}),
671 ))(ssi_expect(pk, int)))
672 def book_wide(request, pk):
673 book = get_object_or_404(models.Book, pk=pk)
674 stage_note, stage_note_url = book.stage_note()
675 extra_info = book.extra_info
676 audiobooks, projects, have_oggs = get_audiobooks(book)
678 return render(request, 'catalogue/book_wide.html', {
680 'has_audio': book.has_media('mp3'),
681 'parents': book.parents(),
682 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
683 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
684 'stage_note': stage_note,
685 'stage_note_url': stage_note_url,
687 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
688 'extra_info': extra_info,
689 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
690 'audiobooks': audiobooks,
691 'have_oggs': have_oggs,
696 def fragment_short(request, pk):
697 fragment = get_object_or_404(models.Fragment, pk=pk)
698 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
702 def fragment_promo(request, pk):
703 fragment = get_object_or_404(models.Fragment, pk=pk)
704 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
708 def tag_box(request, pk):
709 tag = get_object_or_404(models.Tag, pk=pk)
710 assert tag.category != 'set'
712 return render(request, 'catalogue/tag_box.html', {
718 def collection_box(request, pk):
719 obj = get_object_or_404(models.Collection, pk=pk)
721 return render(request, 'catalogue/collection_box.html', {
726 def tag_catalogue(request, category):
727 if category == 'theme':
728 tags = models.Tag.objects.usage_for_model(
729 models.Fragment, counts=True).filter(category='theme')
731 tags = list(get_top_level_related_tags((), categories=(category,)))
733 described_tags = [tag for tag in tags if tag.description]
735 if len(described_tags) > 4:
736 best = random.sample(described_tags, 4)
738 best = described_tags
740 return render(request, 'catalogue/tag_catalogue.html', {
743 'title': constants.CATEGORIES_NAME_PLURAL[category],
744 'whole_category': constants.WHOLE_CATEGORY[category],
748 def collections(request):
749 objects = models.Collection.objects.all()
752 best = random.sample(objects, 3)
756 return render(request, 'catalogue/collections.html', {