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, as_json=False):
37 books = models.Book.objects.filter(parent=None).order_by('sort_key_author', 'sort_key')
38 pictures = Picture.objects.order_by('sort_key_author', 'sort_key')
39 collections = models.Collection.objects.all()
40 return render(request, 'catalogue/catalogue.html', locals())
43 def book_list(request, filter=None, get_filter=None, template_name='catalogue/book_list.html',
44 nav_template_name='catalogue/snippets/book_list_nav.html',
45 list_template_name='catalogue/snippets/book_list.html', context=None):
46 """ generates a listing of all books, optionally filtered with a test function """
49 books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
50 books_nav = OrderedDict()
51 for tag in books_by_author:
52 if books_by_author[tag]:
53 books_nav.setdefault(tag.sort_key[0], []).append(tag)
54 rendered_nav = render_to_string(nav_template_name, locals())
55 rendered_book_list = render_to_string(list_template_name, locals())
56 return render_to_response(template_name, locals(), context_instance=RequestContext(request))
59 def audiobook_list(request):
60 books = models.Book.objects.filter(media__type__in=('mp3', 'ogg')).distinct().order_by(
61 'sort_key_author', 'sort_key')
64 best = random.sample(books, 3)
68 daisy = models.Book.objects.filter(media__type='daisy').distinct().order_by('sort_key_author', 'sort_key')
70 return render(request, 'catalogue/audiobook_list.html', {
77 def daisy_list(request):
78 return book_list(request, Q(media__type='daisy'),
79 template_name='catalogue/daisy_list.html',
83 def collection(request, slug):
84 coll = get_object_or_404(models.Collection, slug=slug)
85 return render(request, 'catalogue/collection.html', {'collection': coll})
88 def differentiate_tags(request, tags, ambiguous_slugs):
89 beginning = '/'.join(tag.url_chunk for tag in tags)
90 unparsed = '/'.join(ambiguous_slugs[1:])
92 for tag in models.Tag.objects.filter(slug=ambiguous_slugs[0]):
94 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
97 return render_to_response(
98 'catalogue/differentiate_tags.html', {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
99 context_instance=RequestContext(request))
102 # TODO: Rewrite this hellish piece of code which tries to do everything
103 def tagged_object_list(request, tags='', gallery=False):
105 # preliminary tests and conditions
107 tags = models.Tag.get_tag_list(tags)
108 except models.Tag.DoesNotExist:
109 # Perhaps the user is asking about an author in Public Domain
110 # counter (they are not represented in tags)
111 chunks = tags.split('/')
112 if len(chunks) == 2 and chunks[0] == 'autor':
113 return pdcounter_views.author_detail(request, chunks[1])
116 except models.Tag.MultipleObjectsReturned, e:
117 # Ask the user to disambiguate
118 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
119 except models.Tag.UrlDeprecationWarning, e:
120 return HttpResponsePermanentRedirect(
121 reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
124 if len(tags) > settings.MAX_TAG_LIST:
126 except AttributeError:
129 # beginning of digestion
130 theme_is_set = [tag for tag in tags if tag.category == 'theme']
131 shelf_is_set = [tag for tag in tags if tag.category == 'set']
132 only_shelf = shelf_is_set and len(tags) == 1
133 only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
134 tags_pks = [tag.pk for tag in tags]
139 # Only fragments (or pirctureareas) here.
140 shelf_tags = [tag for tag in tags if tag.category == 'set']
141 fragment_tags = [tag for tag in tags if tag.category != 'set']
143 fragments = PictureArea.tagged.with_all(fragment_tags)
145 fragments = models.Fragment.tagged.with_all(fragment_tags)
149 # TODO: Pictures on shelves not supported yet.
152 books = models.Book.tagged.with_all(shelf_tags).order_by()
153 fragments = fragments.filter(Q(book__in=books) | Q(book__ancestor__in=books))
155 categories = split_tags(
156 models.Tag.objects.usage_for_queryset(fragments, counts=True).exclude(pk__in=tags_pks),
163 # TODO: Pictures on shelves not supported yet.
167 objects = Picture.tagged.with_all(tags)
169 objects = Picture.objects.all()
170 areas = PictureArea.objects.filter(picture__in=objects)
171 categories = split_tags(
172 models.Tag.objects.usage_for_queryset(
173 objects, counts=True).exclude(pk__in=tags_pks),
174 models.Tag.objects.usage_for_queryset(
175 areas, counts=True).filter(
176 category__in=('theme', 'thing')).exclude(
181 all_books = models.Book.tagged.with_all(tags)
183 all_books = models.Book.objects.filter(parent=None)
186 related_book_tags = models.Tag.objects.usage_for_queryset(
187 objects, counts=True).exclude(
188 category='set').exclude(pk__in=tags_pks)
191 objects = models.Book.tagged_top_level(tags)
194 # WTF: was outside if, overwriting value assigned if shelf_is_set
195 related_book_tags = get_top_level_related_tags(tags)
197 fragments = models.Fragment.objects.filter(book__in=all_books)
199 categories = split_tags(
201 models.Tag.objects.usage_for_queryset(
202 fragments, counts=True).filter(
203 category='theme').exclude(pk__in=tags_pks),
205 objects = objects.order_by('sort_key_author', 'sort_key')
207 objects = list(objects)
209 best = random.sample(objects, 3)
213 if not gallery and not objects and len(tags) == 1:
215 if (tag.category in ('theme', 'thing') and PictureArea.tagged.with_any([tag]).exists() or
216 Picture.tagged.with_any([tag]).exists()):
217 return redirect('tagged_object_list_gallery', raw_tags, permanent=False)
219 return render_to_response(
220 'catalogue/tagged_object_list.html',
222 'object_list': objects,
223 'categories': categories,
224 'only_shelf': only_shelf,
225 'only_my_shelf': only_my_shelf,
226 'formats_form': forms.DownloadFormatsForm(),
229 'theme_is_set': theme_is_set,
233 context_instance=RequestContext(request))
236 def book_fragments(request, slug, theme_slug):
237 book = get_object_or_404(models.Book, slug=slug)
238 theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
239 fragments = models.Fragment.tagged.with_all([theme]).filter(
240 Q(book=book) | Q(book__ancestor=book))
242 return render_to_response('catalogue/book_fragments.html', locals(), context_instance=RequestContext(request))
245 def book_detail(request, slug):
247 book = models.Book.objects.get(slug=slug)
248 except models.Book.DoesNotExist:
249 return pdcounter_views.book_stub_detail(request, slug)
251 tags = book.tags.exclude(category__in=('set', 'theme'))
252 book_children = book.children.all().order_by('parent_number', 'sort_key')
253 return render_to_response('catalogue/book_detail.html', locals(), context_instance=RequestContext(request))
256 def get_audiobooks(book):
258 for m in book.media.filter(type='ogg').order_by().iterator():
259 ogg_files[m.name] = m
264 for mp3 in book.media.filter(type='mp3').iterator():
265 # ogg files are always from the same project
266 meta = mp3.extra_info
267 project = meta.get('project')
270 project = u'CzytamySłuchając'
272 projects.add((project, meta.get('funded_by', '')))
276 ogg = ogg_files.get(mp3.name)
281 audiobooks.append(media)
283 projects = sorted(projects)
284 return audiobooks, projects, have_oggs
287 def player(request, slug):
288 book = get_object_or_404(models.Book, slug=slug)
289 if not book.has_media('mp3'):
292 audiobooks, projects, have_oggs = get_audiobooks(book)
294 extra_info = book.extra_info
296 return render_to_response('catalogue/player.html', locals(), context_instance=RequestContext(request))
299 def book_text(request, slug):
300 book = get_object_or_404(models.Book, slug=slug)
302 if not book.has_html_file():
304 return render_to_response('catalogue/book_text.html', locals(), context_instance=RequestContext(request))
311 def _no_diacritics_regexp(query):
312 """ returns a regexp for searching for a query without diacritics
314 should be locale-aware """
316 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śŚ',
318 u'ą': u'ąĄ', u'ć': u'ćĆ', u'ę': u'ęĘ', u'ł': u'łŁ', u'ń': u'ńŃ', u'ó': u'óÓ', u'ś': u'śŚ', u'ź': u'źŹ',
324 return u"(?:%s)" % '|'.join(names[l])
326 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
329 def unicode_re_escape(query):
330 """ Unicode-friendly version of re.escape """
331 return re.sub(r'(?u)(\W)', r'\\\1', query)
334 def _word_starts_with(name, prefix):
335 """returns a Q object getting models having `name` contain a word
336 starting with `prefix`
338 We define word characters as alphanumeric and underscore, like in JS.
340 Works for MySQL, PostgreSQL, Oracle.
341 For SQLite, _sqlite* version is substituted for this.
345 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
346 # can't use [[:<:]] (word start),
347 # but we want both `xy` and `(xy` to catch `(xyz)`
348 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
353 def _word_starts_with_regexp(prefix):
354 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
355 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
358 def _sqlite_word_starts_with(name, prefix):
359 """ version of _word_starts_with for SQLite
361 SQLite in Django uses Python re module
363 kwargs = {'%s__iregex' % name: _word_starts_with_regexp(prefix)}
367 if hasattr(settings, 'DATABASES'):
368 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
369 _word_starts_with = _sqlite_word_starts_with
370 elif settings.DATABASE_ENGINE == 'sqlite3':
371 _word_starts_with = _sqlite_word_starts_with
375 def __init__(self, name, view):
378 self.lower = name.lower()
379 self.category = 'application'
382 return reverse(*self._view)
385 App(u'Leśmianator', (u'lesmianator', )),
389 def _tags_starting_with(prefix, user=None):
390 prefix = prefix.lower()
392 book_stubs = pdcounter_models.BookStub.objects.filter(_word_starts_with('title', prefix))
393 authors = pdcounter_models.Author.objects.filter(_word_starts_with('name', prefix))
395 books = models.Book.objects.filter(_word_starts_with('title', prefix))
396 tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
397 if user and user.is_authenticated():
398 tags = tags.filter(~Q(category='set') | Q(user=user))
400 tags = tags.exclude(category='set')
402 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
403 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + \
407 def _get_result_link(match, tag_list):
408 if isinstance(match, models.Tag):
409 return reverse('catalogue.views.tagged_object_list',
410 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])})
411 elif isinstance(match, App):
414 return match.get_absolute_url()
417 def _get_result_type(match):
418 if isinstance(match, models.Book) or isinstance(match, pdcounter_models.BookStub):
421 match_type = match.category
425 def books_starting_with(prefix):
426 prefix = prefix.lower()
427 return models.Book.objects.filter(_word_starts_with('title', prefix))
430 def find_best_matches(query, user=None):
431 """ Finds a models.Book, Tag, models.BookStub or Author best matching a query.
434 - zero elements when nothing is found,
435 - one element when a best result is found,
436 - more then one element on multiple exact matches
438 Raises a ValueError on too short a query.
441 query = query.lower()
443 raise ValueError("query must have at least two characters")
445 result = tuple(_tags_starting_with(query, user))
446 # remove pdcounter stuff
447 book_titles = set(match.pretty_title().lower() for match in result
448 if isinstance(match, models.Book))
449 authors = set(match.name.lower() for match in result
450 if isinstance(match, models.Tag) and match.category == 'author')
451 result = tuple(res for res in result if not (
452 (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles) or
453 (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
456 exact_matches = tuple(res for res in result if res.name.lower() == query)
460 return tuple(result)[:1]
464 tags = request.GET.get('tags', '')
465 prefix = request.GET.get('q', '')
468 tag_list = models.Tag.get_tag_list(tags)
469 except (models.Tag.DoesNotExist, models.Tag.MultipleObjectsReturned, models.Tag.UrlDeprecationWarning):
473 result = find_best_matches(prefix, request.user)
475 return render_to_response(
476 'catalogue/search_too_short.html', {'tags': tag_list, 'prefix': prefix},
477 context_instance=RequestContext(request))
480 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
481 elif len(result) > 1:
482 return render_to_response(
483 'catalogue/search_multiple_hits.html',
485 'tags': tag_list, 'prefix': prefix,
486 'results': ((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)
488 context_instance=RequestContext(request))
490 form = PublishingSuggestForm(initial={"books": prefix + ", "})
491 return render_to_response(
492 'catalogue/search_no_hits.html',
493 {'tags': tag_list, 'prefix': prefix, "pubsuggest_form": form},
494 context_instance=RequestContext(request))
497 def tags_starting_with(request):
498 prefix = request.GET.get('q', '')
499 # Prefix must have at least 2 characters
501 return HttpResponse('')
504 for tag in _tags_starting_with(prefix, request.user):
505 if tag.name not in tags_list:
506 result += "\n" + tag.name
507 tags_list.append(tag.name)
508 return HttpResponse(result)
511 def json_tags_starting_with(request, callback=None):
513 prefix = request.GET.get('q', '')
514 callback = request.GET.get('callback', '')
515 # Prefix must have at least 2 characters
517 return HttpResponse('')
519 for tag in _tags_starting_with(prefix, request.user):
520 if tag.name not in tags_list:
521 tags_list.append(tag.name)
522 if request.GET.get('mozhint', ''):
523 result = [prefix, tags_list]
525 result = {"matches": tags_list}
526 response = JsonResponse(result, safe=False)
528 response.content = callback + "(" + response.content + ");"
537 def import_book(request):
538 """docstring for import_book"""
539 book_import_form = forms.BookImportForm(request.POST, request.FILES)
540 if book_import_form.is_valid():
542 book_import_form.save()
547 info = sys.exc_info()
548 exception = pprint.pformat(info[1])
549 tb = '\n'.join(traceback.format_tb(info[2]))
551 _("An error occurred: %(exception)s\n\n%(tb)s") % {'exception': exception, 'tb': tb},
552 mimetype='text/plain')
553 return HttpResponse(_("Book imported successfully"))
555 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
560 def book_info(request, book_id, lang='pl'):
561 book = get_object_or_404(models.Book, id=book_id)
562 # set language by hand
563 translation.activate(lang)
564 return render_to_response('catalogue/book_info.html', locals(), context_instance=RequestContext(request))
567 def tag_info(request, tag_id):
568 tag = get_object_or_404(models.Tag, id=tag_id)
569 return HttpResponse(tag.description)
572 def download_zip(request, format, slug=None):
573 if format in models.Book.ebook_formats:
574 url = models.Book.zip_format(format)
575 elif format in ('mp3', 'ogg') and slug is not None:
576 book = get_object_or_404(models.Book, slug=slug)
577 url = book.zip_audiobooks(format)
579 raise Http404('No format specified for zip package')
580 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
583 class CustomPDFFormView(AjaxableFormView):
584 form_class = forms.CustomPDFForm
585 title = ugettext_lazy('Download custom PDF')
586 submit = ugettext_lazy('Download')
589 def __call__(self, *args, **kwargs):
590 if settings.NO_CUSTOM_PDF:
591 raise Http404('Custom PDF is disabled')
592 return super(CustomPDFFormView, self).__call__(*args, **kwargs)
594 def form_args(self, request, obj):
595 """Override to parse view args and give additional args to the form."""
598 def get_object(self, request, slug, *args, **kwargs):
599 return get_object_or_404(models.Book, slug=slug)
601 def context_description(self, request, obj):
602 return obj.pretty_title()
611 def book_mini(request, pk, with_link=True):
612 book = get_object_or_404(models.Book, pk=pk)
613 author_str = ", ".join(tag.name for tag in book.tags.filter(category='author'))
614 return render(request, 'catalogue/book_mini_box.html', {
616 'author_str': author_str,
617 'with_link': with_link,
618 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
622 @ssi_included(get_ssi_vars=lambda pk: (lambda ipk: (
623 ('ssify.get_csrf_token',),
624 ('social_tags.likes_book', (ipk,)),
625 ('social_tags.book_shelf_tags', (ipk,)),
626 ))(ssi_expect(pk, int)))
627 def book_short(request, pk):
628 book = get_object_or_404(models.Book, pk=pk)
629 stage_note, stage_note_url = book.stage_note()
630 audiobooks, projects, have_oggs = get_audiobooks(book)
632 return render(request, 'catalogue/book_short.html', {
634 'has_audio': book.has_media('mp3'),
635 'main_link': book.get_absolute_url(),
636 'parents': book.parents(),
637 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
638 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
639 'stage_note': stage_note,
640 'stage_note_url': stage_note_url,
641 'audiobooks': audiobooks,
642 'have_oggs': have_oggs,
647 get_ssi_vars=lambda pk: book_short.get_ssi_vars(pk) +
649 ('social_tags.choose_cite', [ipk]),
650 ('catalogue_tags.choose_fragment', [ipk], {
651 'unless': V('social_tags.choose_cite', [ipk])}),
652 ))(ssi_expect(pk, int)))
653 def book_wide(request, pk):
654 book = get_object_or_404(models.Book, pk=pk)
655 stage_note, stage_note_url = book.stage_note()
656 extra_info = book.extra_info
657 audiobooks, projects, have_oggs = get_audiobooks(book)
659 return render(request, 'catalogue/book_wide.html', {
661 'has_audio': book.has_media('mp3'),
662 'parents': book.parents(),
663 'tags': split_tags(book.tags.exclude(category__in=('set', 'theme'))),
664 'show_lang': book.language_code() != settings.LANGUAGE_CODE,
665 'stage_note': stage_note,
666 'stage_note_url': stage_note_url,
668 'main_link': reverse('book_text', args=[book.slug]) if book.html_file else None,
669 'extra_info': extra_info,
670 'hide_about': extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl'),
671 'audiobooks': audiobooks,
672 'have_oggs': have_oggs,
677 def fragment_short(request, pk):
678 fragment = get_object_or_404(models.Fragment, pk=pk)
679 return render(request, 'catalogue/fragment_short.html', {'fragment': fragment})
683 def fragment_promo(request, pk):
684 fragment = get_object_or_404(models.Fragment, pk=pk)
685 return render(request, 'catalogue/fragment_promo.html', {'fragment': fragment})
689 def tag_box(request, pk):
690 tag = get_object_or_404(models.Tag, pk=pk)
691 assert tag.category != 'set'
693 return render(request, 'catalogue/tag_box.html', {
699 def collection_box(request, pk):
700 obj = get_object_or_404(models.Collection, pk=pk)
702 return render(request, 'catalogue/collection_box.html', {
707 def tag_catalogue(request, category):
708 if category == 'theme':
709 tags = models.Tag.objects.usage_for_model(
710 models.Fragment, counts=True).filter(category='theme')
712 tags = list(get_top_level_related_tags((), categories=(category,)))
714 described_tags = [tag for tag in tags if tag.description]
716 if len(described_tags) > 4:
717 best = random.sample(described_tags, 4)
719 best = described_tags
721 return render(request, 'catalogue/tag_catalogue.html', {
724 'title': constants.CATEGORIES_NAME_PLURAL[category],
725 'whole_category': constants.WHOLE_CATEGORY[category],
729 def collections(request):
730 objects = models.Collection.objects.all()
733 best = random.sample(objects, 3)
737 return render(request, 'catalogue/collections.html', {