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.
7 from datetime import datetime
9 from django.conf import settings
10 from django.template import RequestContext
11 from django.shortcuts import render_to_response, get_object_or_404
12 from django.http import HttpResponse, HttpResponseRedirect, Http404, HttpResponsePermanentRedirect
13 from django.core.urlresolvers import reverse
14 from django.db.models import Count, Sum, Q
15 from django.contrib.auth.decorators import login_required, user_passes_test
16 from django.utils.datastructures import SortedDict
17 from django.views.decorators.http import require_POST
18 from django.contrib import auth
19 from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
20 from django.utils.http import urlquote_plus
21 from django.views.decorators import cache
22 from django.utils import translation
23 from django.utils.translation import ugettext as _
24 from django.views.generic.list_detail import object_list
26 from ajaxable.utils import LazyEncoder, JSONResponse
27 from catalogue import models
28 from catalogue import forms
29 from catalogue.utils import (split_tags, AttachmentHttpResponse,
30 async_build_pdf, MultiQuerySet)
31 from catalogue.tasks import touch_tag
32 from pdcounter import models as pdcounter_models
33 from pdcounter import views as pdcounter_views
34 from suggest.forms import PublishingSuggestForm
35 from picture.models import Picture
39 staff_required = user_passes_test(lambda user: user.is_staff)
42 def catalogue(request):
43 tags = models.Tag.objects.exclude(
44 category__in=('set', 'book')).exclude(book_count=0)
47 tag.count = tag.book_count
48 categories = split_tags(tags)
49 fragment_tags = categories.get('theme', [])
51 return render_to_response('catalogue/catalogue.html', locals(),
52 context_instance=RequestContext(request))
55 def book_list(request, filter=None, template_name='catalogue/book_list.html'):
56 """ generates a listing of all books, optionally filtered with a test function """
58 books_by_author, orphans, books_by_parent = models.Book.book_list(filter)
59 books_nav = SortedDict()
60 for tag in books_by_author:
61 if books_by_author[tag]:
62 books_nav.setdefault(tag.sort_key[0], []).append(tag)
64 return render_to_response(template_name, locals(),
65 context_instance=RequestContext(request))
68 def audiobook_list(request):
69 return book_list(request, Q(media__type='mp3') | Q(media__type='ogg'),
70 template_name='catalogue/audiobook_list.html')
73 def daisy_list(request):
74 return book_list(request, Q(media__type='daisy'),
75 template_name='catalogue/daisy_list.html')
78 def differentiate_tags(request, tags, ambiguous_slugs):
79 beginning = '/'.join(tag.url_chunk for tag in tags)
80 unparsed = '/'.join(ambiguous_slugs[1:])
82 for tag in models.Tag.objects.exclude(category='book').filter(slug=ambiguous_slugs[0]):
84 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
87 return render_to_response('catalogue/differentiate_tags.html',
88 {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
89 context_instance=RequestContext(request))
92 def tagged_object_list(request, tags=''):
93 # import pdb; pdb.set_trace()
95 tags = models.Tag.get_tag_list(tags)
96 except models.Tag.DoesNotExist:
97 chunks = tags.split('/')
98 if len(chunks) == 2 and chunks[0] == 'autor':
99 return pdcounter_views.author_detail(request, chunks[1])
102 except models.Tag.MultipleObjectsReturned, e:
103 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
104 except models.Tag.UrlDeprecationWarning, e:
105 return HttpResponsePermanentRedirect(reverse('tagged_object_list', args=['/'.join(tag.url_chunk for tag in e.tags)]))
108 if len(tags) > settings.MAX_TAG_LIST:
110 except AttributeError:
113 if len([tag for tag in tags if tag.category == 'book']):
116 theme_is_set = [tag for tag in tags if tag.category == 'theme']
117 shelf_is_set = [tag for tag in tags if tag.category == 'set']
118 only_shelf = shelf_is_set and len(tags) == 1
119 only_my_shelf = only_shelf and request.user.is_authenticated() and request.user == tags[0].user
121 objects = only_author = None
125 shelf_tags = [tag for tag in tags if tag.category == 'set']
126 fragment_tags = [tag for tag in tags if tag.category != 'set']
127 fragments = models.Fragment.tagged.with_all(fragment_tags)
130 books = models.Book.tagged.with_all(shelf_tags).order_by()
131 l_tags = models.Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in books])
132 fragments = models.Fragment.tagged.with_any(l_tags, fragments)
134 # newtagging goes crazy if we just try:
135 #related_tags = models.Tag.objects.usage_for_queryset(fragments, counts=True,
136 # extra={'where': ["catalogue_tag.category != 'book'"]})
137 fragment_keys = [fragment.pk for fragment in fragments]
139 related_tags = models.Fragment.tags.usage(counts=True,
140 filters={'pk__in': fragment_keys},
141 extra={'where': ["catalogue_tag.category != 'book'"]})
142 related_tags = (tag for tag in related_tags if tag not in fragment_tags)
143 categories = split_tags(related_tags)
148 objects = models.Book.tagged.with_all(tags)
150 objects = models.Book.tagged_top_level(tags)
152 # get related tags from `tag_counter` and `theme_counter`
154 tags_pks = [tag.pk for tag in tags]
156 for tag_pk, value in itertools.chain(book.tag_counter.iteritems(), book.theme_counter.iteritems()):
157 if tag_pk in tags_pks:
159 related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
160 related_tags = models.Tag.objects.filter(pk__in=related_counts.keys())
161 related_tags = [tag for tag in related_tags if tag not in tags]
162 for tag in related_tags:
163 tag.count = related_counts[tag.pk]
165 categories = split_tags(related_tags)
169 only_author = len(tags) == 1 and tags[0].category == 'author'
170 objects = models.Book.objects.none()
173 objects = MultiQuerySet(Picture.tagged.with_all(tags), objects)
175 return render_to_response('catalogue/tagged_object_list.html',
177 'object_list': objects,
178 'categories': categories,
179 'only_shelf': only_shelf,
180 'only_author': only_author,
181 'only_my_shelf': only_my_shelf,
182 'formats_form': forms.DownloadFormatsForm(),
185 context_instance=RequestContext(request))
188 def book_fragments(request, book, theme_slug):
189 kwargs = models.Book.split_urlid(book)
192 book = get_object_or_404(models.Book, **kwargs)
194 book_tag = book.book_tag()
195 theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
196 fragments = models.Fragment.tagged.with_all([book_tag, theme])
198 return render_to_response('catalogue/book_fragments.html', locals(),
199 context_instance=RequestContext(request))
202 def book_detail(request, book):
203 kwargs = models.Book.split_urlid(book)
207 book = models.Book.objects.get(**kwargs)
208 except models.Book.DoesNotExist:
209 return pdcounter_views.book_stub_detail(request, kwargs['slug'])
211 book_tag = book.book_tag()
212 tags = list(book.tags.filter(~Q(category='set')))
213 categories = split_tags(tags)
214 book_children = book.children.all().order_by('parent_number', 'sort_key')
219 parents.append(_book.parent)
221 parents = reversed(parents)
223 theme_counter = book.theme_counter
224 book_themes = models.Tag.objects.filter(pk__in=theme_counter.keys())
225 for tag in book_themes:
226 tag.count = theme_counter[tag.pk]
228 extra_info = book.get_extra_info_value()
229 hide_about = extra_info.get('about', '').startswith('http://wiki.wolnepodreczniki.pl')
232 for m in book.media.filter(type='mp3'):
233 # ogg files are always from the same project
234 meta = m.get_extra_info_value()
235 project = meta.get('project')
238 project = u'CzytamySłuchając'
240 projects.add((project, meta.get('funded_by', '')))
241 projects = sorted(projects)
243 custom_pdf_form = forms.CustomPDFForm()
244 return render_to_response('catalogue/book_detail.html', locals(),
245 context_instance=RequestContext(request))
248 def book_text(request, book):
249 kwargs = models.Book.split_fileid(book)
252 book = get_object_or_404(models.Book, **kwargs)
254 if not book.has_html_file():
257 for fragment in book.fragments.all():
258 for theme in fragment.tags.filter(category='theme'):
259 book_themes.setdefault(theme, []).append(fragment)
261 book_themes = book_themes.items()
262 book_themes.sort(key=lambda s: s[0].sort_key)
263 return render_to_response('catalogue/book_text.html', locals(),
264 context_instance=RequestContext(request))
271 def _no_diacritics_regexp(query):
272 """ returns a regexp for searching for a query without diacritics
274 should be locale-aware """
276 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śŚ', u'z':u'zźżŹŻ',
277 u'ą':u'ąĄ', u'ć':u'ćĆ', u'ę':u'ęĘ', u'ł': u'łŁ', u'ń':u'ńŃ', u'ó':u'óÓ', u'ś':u'śŚ', u'ź':u'źŹ', u'ż':u'żŻ'
281 return u"(%s)" % '|'.join(names[l])
282 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
284 def unicode_re_escape(query):
285 """ Unicode-friendly version of re.escape """
286 return re.sub('(?u)(\W)', r'\\\1', query)
288 def _word_starts_with(name, prefix):
289 """returns a Q object getting models having `name` contain a word
290 starting with `prefix`
292 We define word characters as alphanumeric and underscore, like in JS.
294 Works for MySQL, PostgreSQL, Oracle.
295 For SQLite, _sqlite* version is substituted for this.
299 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
300 # can't use [[:<:]] (word start),
301 # but we want both `xy` and `(xy` to catch `(xyz)`
302 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
307 def _word_starts_with_regexp(prefix):
308 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
309 return ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
312 def _sqlite_word_starts_with(name, prefix):
313 """ version of _word_starts_with for SQLite
315 SQLite in Django uses Python re module
318 kwargs['%s__iregex' % name] = _word_starts_with_regexp(prefix)
322 if hasattr(settings, 'DATABASES'):
323 if settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3':
324 _word_starts_with = _sqlite_word_starts_with
325 elif settings.DATABASE_ENGINE == 'sqlite3':
326 _word_starts_with = _sqlite_word_starts_with
330 def __init__(self, name, view):
333 self.lower = name.lower()
334 self.category = 'application'
336 return reverse(*self._view)
339 App(u'Leśmianator', (u'lesmianator', )),
343 def _tags_starting_with(prefix, user=None):
344 prefix = prefix.lower()
346 book_stubs = pdcounter_models.BookStub.objects.filter(_word_starts_with('title', prefix))
347 authors = pdcounter_models.Author.objects.filter(_word_starts_with('name', prefix))
349 books = models.Book.objects.filter(_word_starts_with('title', prefix))
350 tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
351 if user and user.is_authenticated():
352 tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
354 tags = tags.filter(~Q(category='book') & ~Q(category='set'))
356 prefix_regexp = re.compile(_word_starts_with_regexp(prefix))
357 return list(books) + list(tags) + [app for app in _apps if prefix_regexp.search(app.lower)] + list(book_stubs) + list(authors)
360 def _get_result_link(match, tag_list):
361 if isinstance(match, models.Tag):
362 return reverse('catalogue.views.tagged_object_list',
363 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])}
365 elif isinstance(match, App):
368 return match.get_absolute_url()
371 def _get_result_type(match):
372 if isinstance(match, models.Book) or isinstance(match, pdcounter_models.BookStub):
375 type = match.category
379 def books_starting_with(prefix):
380 prefix = prefix.lower()
381 return models.Book.objects.filter(_word_starts_with('title', prefix))
384 def find_best_matches(query, user=None):
385 """ Finds a models.Book, Tag, models.BookStub or Author best matching a query.
388 - zero elements when nothing is found,
389 - one element when a best result is found,
390 - more then one element on multiple exact matches
392 Raises a ValueError on too short a query.
395 query = query.lower()
397 raise ValueError("query must have at least two characters")
399 result = tuple(_tags_starting_with(query, user))
400 # remove pdcounter stuff
401 book_titles = set(match.pretty_title().lower() for match in result
402 if isinstance(match, models.Book))
403 authors = set(match.name.lower() for match in result
404 if isinstance(match, models.Tag) and match.category=='author')
405 result = tuple(res for res in result if not (
406 (isinstance(res, pdcounter_models.BookStub) and res.pretty_title().lower() in book_titles)
407 or (isinstance(res, pdcounter_models.Author) and res.name.lower() in authors)
410 exact_matches = tuple(res for res in result if res.name.lower() == query)
414 return tuple(result)[:1]
418 tags = request.GET.get('tags', '')
419 prefix = request.GET.get('q', '')
422 tag_list = models.Tag.get_tag_list(tags)
427 result = find_best_matches(prefix, request.user)
429 return render_to_response('catalogue/search_too_short.html', {'tags':tag_list, 'prefix':prefix},
430 context_instance=RequestContext(request))
433 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
434 elif len(result) > 1:
435 return render_to_response('catalogue/search_multiple_hits.html',
436 {'tags':tag_list, 'prefix':prefix, 'results':((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)},
437 context_instance=RequestContext(request))
439 form = PublishingSuggestForm(initial={"books": prefix + ", "})
440 return render_to_response('catalogue/search_no_hits.html',
441 {'tags':tag_list, 'prefix':prefix, "pubsuggest_form": form},
442 context_instance=RequestContext(request))
445 def tags_starting_with(request):
446 prefix = request.GET.get('q', '')
447 # Prefix must have at least 2 characters
449 return HttpResponse('')
452 for tag in _tags_starting_with(prefix, request.user):
453 if not tag.name in tags_list:
454 result += "\n" + tag.name
455 tags_list.append(tag.name)
456 return HttpResponse(result)
458 def json_tags_starting_with(request, callback=None):
460 prefix = request.GET.get('q', '')
461 callback = request.GET.get('callback', '')
462 # Prefix must have at least 2 characters
464 return HttpResponse('')
466 for tag in _tags_starting_with(prefix, request.user):
467 if not tag.name in tags_list:
468 tags_list.append(tag.name)
469 if request.GET.get('mozhint', ''):
470 result = [prefix, tags_list]
472 result = {"matches": tags_list}
473 return JSONResponse(result, callback)
475 # ====================
476 # = Shelf management =
477 # ====================
480 def user_shelves(request):
481 shelves = models.Tag.objects.filter(category='set', user=request.user)
482 new_set_form = forms.NewSetForm()
483 return render_to_response('catalogue/user_shelves.html', locals(),
484 context_instance=RequestContext(request))
487 def book_sets(request, book):
488 if not request.user.is_authenticated():
489 return HttpResponse(_('<p>To maintain your shelves you need to be logged in.</p>'))
491 kwargs = models.Book.split_urlid(book)
494 book = get_object_or_404(models.Book, **kwargs)
496 user_sets = models.Tag.objects.filter(category='set', user=request.user)
497 book_sets = book.tags.filter(category='set', user=request.user)
499 if request.method == 'POST':
500 form = forms.ObjectSetsForm(book, request.user, request.POST)
502 old_shelves = list(book.tags.filter(category='set'))
503 new_shelves = [models.Tag.objects.get(pk=id) for id in form.cleaned_data['set_ids']]
505 for shelf in [shelf for shelf in old_shelves if shelf not in new_shelves]:
508 for shelf in [shelf for shelf in new_shelves if shelf not in old_shelves]:
511 book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
512 if request.is_ajax():
513 return JSONResponse('{"msg":"'+_("<p>Shelves were sucessfully saved.</p>")+'", "after":"close"}')
515 return HttpResponseRedirect('/')
517 form = forms.ObjectSetsForm(book, request.user)
518 new_set_form = forms.NewSetForm()
520 return render_to_response('catalogue/book_sets.html', locals(),
521 context_instance=RequestContext(request))
527 def remove_from_shelf(request, shelf, book):
528 kwargs = models.Book.split_urlid(book)
531 book = get_object_or_404(models.Book, **kwargs)
533 shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
535 if shelf in book.tags:
536 models.Tag.objects.remove_tag(book, shelf)
539 return HttpResponse(_('Book was successfully removed from the shelf'))
541 return HttpResponse(_('This book is not on the shelf'))
544 def collect_books(books):
546 Returns all real books in collection.
550 if len(book.children.all()) == 0:
553 result += collect_books(book.children.all())
558 def download_shelf(request, slug):
560 Create a ZIP archive on disk and transmit it in chunks of 8KB,
561 without loading the whole file into memory. A similar approach can
562 be used for large dynamic PDF files.
564 from slughifi import slughifi
568 shelf = get_object_or_404(models.Tag, slug=slug, category='set')
571 form = forms.DownloadFormatsForm(request.GET)
573 formats = form.cleaned_data['formats']
574 if len(formats) == 0:
575 formats = models.Book.ebook_formats
577 # Create a ZIP archive
578 temp = tempfile.TemporaryFile()
579 archive = zipfile.ZipFile(temp, 'w')
581 for book in collect_books(models.Book.tagged.with_all(shelf)):
582 fileid = book.fileid()
583 for ebook_format in models.Book.ebook_formats:
584 if ebook_format in formats and book.has_media(ebook_format):
585 filename = book.get_media(ebook_format).path
586 archive.write(filename, str('%s.%s' % (fileid, ebook_format)))
589 response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
590 response['Content-Disposition'] = 'attachment; filename=%s.zip' % slughifi(shelf.name)
591 response['Content-Length'] = temp.tell()
594 response.write(temp.read())
599 def shelf_book_formats(request, shelf):
601 Returns a list of formats of books in shelf.
603 shelf = get_object_or_404(models.Tag, slug=shelf, category='set')
606 for ebook_format in models.Book.ebook_formats:
607 formats[ebook_format] = False
609 for book in collect_books(models.Book.tagged.with_all(shelf)):
610 for ebook_format in models.Book.ebook_formats:
611 if book.has_media(ebook_format):
612 formats[ebook_format] = True
614 return HttpResponse(LazyEncoder().encode(formats))
620 def new_set(request):
621 new_set_form = forms.NewSetForm(request.POST)
622 if new_set_form.is_valid():
623 new_set = new_set_form.save(request.user)
625 if request.is_ajax():
626 return JSONResponse('{"id":"%d", "name":"%s", "msg":"<p>Shelf <strong>%s</strong> was successfully created</p>"}' % (new_set.id, new_set.name, new_set))
628 return HttpResponseRedirect('/')
630 return HttpResponseRedirect('/')
636 def delete_shelf(request, slug):
637 user_set = get_object_or_404(models.Tag, slug=slug, category='set', user=request.user)
640 if request.is_ajax():
641 return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully removed</p>') % user_set.name)
643 return HttpResponseRedirect('/')
651 def import_book(request):
652 """docstring for import_book"""
653 book_import_form = forms.BookImportForm(request.POST, request.FILES)
654 if book_import_form.is_valid():
656 book_import_form.save()
661 info = sys.exc_info()
662 exception = pprint.pformat(info[1])
663 tb = '\n'.join(traceback.format_tb(info[2]))
664 return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
665 return HttpResponse(_("Book imported successfully"))
667 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
672 def book_info(request, id, lang='pl'):
673 book = get_object_or_404(models.Book, id=id)
674 # set language by hand
675 translation.activate(lang)
676 return render_to_response('catalogue/book_info.html', locals(),
677 context_instance=RequestContext(request))
680 def tag_info(request, id):
681 tag = get_object_or_404(models.Tag, id=id)
682 return HttpResponse(tag.description)
685 def download_zip(request, format, book=None):
686 kwargs = models.Book.split_fileid(book)
689 if format in models.Book.ebook_formats:
690 url = models.Book.zip_format(format)
691 elif format == 'audiobook' and kwargs is not None:
692 book = get_object_or_404(models.Book, **kwargs)
693 url = book.zip_audiobooks()
695 raise Http404('No format specified for zip package')
696 return HttpResponseRedirect(urlquote_plus(settings.MEDIA_URL + url, safe='/?='))
699 def download_custom_pdf(request, book_fileid):
700 kwargs = models.Book.split_fileid(book_fileid)
703 book = get_object_or_404(models.Book, **kwargs)
705 if request.method == 'GET':
706 form = forms.CustomPDFForm(request.GET)
708 cust = form.customizations
709 pdf_file = models.get_customized_pdf_path(book, cust)
711 if not path.exists(pdf_file):
712 result = async_build_pdf.delay(book.id, cust, pdf_file)
714 return AttachmentHttpResponse(file_name=("%s.pdf" % book_fileid), file_path=pdf_file, mimetype="application/pdf")
716 raise Http404(_('Incorrect customization options for PDF'))
718 raise Http404(_('Bad method'))