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.
12 from operator import itemgetter
14 from django.conf import settings
15 from django.template import RequestContext
16 from django.shortcuts import render_to_response, get_object_or_404
17 from django.http import HttpResponse, HttpResponseRedirect, Http404
18 from django.core.urlresolvers import reverse
19 from django.db.models import Q
20 from django.contrib.auth.decorators import login_required, user_passes_test
21 from django.utils.datastructures import SortedDict
22 from django.views.decorators.http import require_POST
23 from django.contrib import auth
24 from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
25 from django.utils import simplejson
26 from django.utils.functional import Promise
27 from django.utils.encoding import force_unicode
28 from django.utils.http import urlquote_plus
29 from django.views.decorators import cache
30 from django.utils.translation import ugettext as _
31 from django.views.generic.list_detail import object_list
33 from catalogue import models
34 from catalogue import forms
35 from catalogue.utils import split_tags
36 from newtagging import views as newtagging_views
39 staff_required = user_passes_test(lambda user: user.is_staff)
42 class LazyEncoder(simplejson.JSONEncoder):
43 def default(self, obj):
44 if isinstance(obj, Promise):
45 return force_unicode(obj)
48 # shortcut for JSON reponses
49 class JSONResponse(HttpResponse):
50 def __init__(self, data={}, callback=None, **kwargs):
52 kwargs.pop('mimetype', None)
53 data = simplejson.dumps(data)
55 data = callback + "(" + data + ");"
56 super(JSONResponse, self).__init__(data, mimetype="application/json", **kwargs)
59 def main_page(request):
60 if request.user.is_authenticated():
61 shelves = models.Tag.objects.filter(category='set', user=request.user)
62 new_set_form = forms.NewSetForm()
64 tags = models.Tag.objects.exclude(category__in=('set', 'book'))
66 tag.count = tag.get_count()
67 categories = split_tags(tags)
68 fragment_tags = categories.get('theme', [])
70 form = forms.SearchForm()
71 return render_to_response('catalogue/main_page.html', locals(),
72 context_instance=RequestContext(request))
75 def book_list(request):
76 form = forms.SearchForm()
79 for book in models.Book.objects.all().order_by('parent_number'):
80 books_by_parent.setdefault(book.parent, []).append(book)
83 books_by_author = SortedDict()
84 for tag in models.Tag.objects.filter(category='author'):
85 books_by_author[tag] = []
87 for book in books_by_parent[None]:
88 authors = list(book.tags.filter(category='author'))
90 for author in authors:
91 books_by_author[author].append(book)
95 return render_to_response('catalogue/book_list.html', locals(),
96 context_instance=RequestContext(request))
99 def differentiate_tags(request, tags, ambiguous_slugs):
100 beginning = '/'.join(tag.url_chunk for tag in tags)
101 unparsed = '/'.join(ambiguous_slugs[1:])
103 for tag in models.Tag.objects.exclude(category='book').filter(slug=ambiguous_slugs[0]):
105 'url_args': '/'.join((beginning, tag.url_chunk, unparsed)).strip('/'),
108 return render_to_response('catalogue/differentiate_tags.html',
109 {'tags': tags, 'options': options, 'unparsed': ambiguous_slugs[1:]},
110 context_instance=RequestContext(request))
113 def tagged_object_list(request, tags=''):
115 tags = models.Tag.get_tag_list(tags)
116 except models.Tag.DoesNotExist:
118 except models.Tag.MultipleObjectsReturned, e:
119 return differentiate_tags(request, e.tags, e.ambiguous_slugs)
122 if len(tags) > settings.MAX_TAG_LIST:
124 except AttributeError:
127 if len([tag for tag in tags if tag.category == 'book']):
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
135 objects = only_author = pd_counter = None
139 shelf_tags = [tag for tag in tags if tag.category == 'set']
140 fragment_tags = [tag for tag in tags if tag.category != 'set']
141 fragments = models.Fragment.tagged.with_all(fragment_tags)
144 books = models.Book.tagged.with_all(shelf_tags).order_by()
145 l_tags = models.Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in books])
146 fragments = models.Fragment.tagged.with_any(l_tags, fragments)
148 # newtagging goes crazy if we just try:
149 #related_tags = models.Tag.objects.usage_for_queryset(fragments, counts=True,
150 # extra={'where': ["catalogue_tag.category != 'book'"]})
151 fragment_keys = [fragment.pk for fragment in fragments]
153 related_tags = models.Fragment.tags.usage(counts=True,
154 filters={'pk__in': fragment_keys},
155 extra={'where': ["catalogue_tag.category != 'book'"]})
156 related_tags = (tag for tag in related_tags if tag not in fragment_tags)
157 categories = split_tags(related_tags)
161 # get relevant books and their tags
162 objects = models.Book.tagged.with_all(tags).order_by()
164 # eliminate descendants
165 l_tags = models.Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in objects])
166 descendants_keys = [book.pk for book in models.Book.tagged.with_any(l_tags)]
168 objects = objects.exclude(pk__in=descendants_keys)
170 # get related tags from `tag_counter` and `theme_counter`
172 tags_pks = [tag.pk for tag in tags]
174 for tag_pk, value in itertools.chain(book.tag_counter.iteritems(), book.theme_counter.iteritems()):
175 if tag_pk in tags_pks:
177 related_counts[tag_pk] = related_counts.get(tag_pk, 0) + value
178 related_tags = models.Tag.objects.filter(pk__in=related_counts.keys())
179 related_tags = [tag for tag in related_tags if tag not in tags]
180 for tag in related_tags:
181 tag.count = related_counts[tag.pk]
183 categories = split_tags(related_tags)
187 only_author = len(tags) == 1 and tags[0].category == 'author'
188 pd_counter = only_author and tags[0].goes_to_pd()
189 objects = models.Book.objects.none()
194 template_name='catalogue/tagged_object_list.html',
196 'categories': categories,
197 'only_shelf': only_shelf,
198 'only_author': only_author,
199 'pd_counter': pd_counter,
200 'only_my_shelf': only_my_shelf,
201 'formats_form': forms.DownloadFormatsForm(),
208 def book_fragments(request, book_slug, theme_slug):
209 book = get_object_or_404(models.Book, slug=book_slug)
210 book_tag = get_object_or_404(models.Tag, slug='l-' + book_slug, category='book')
211 theme = get_object_or_404(models.Tag, slug=theme_slug, category='theme')
212 fragments = models.Fragment.tagged.with_all([book_tag, theme])
214 form = forms.SearchForm()
215 return render_to_response('catalogue/book_fragments.html', locals(),
216 context_instance=RequestContext(request))
219 def book_detail(request, slug):
221 book = models.Book.objects.get(slug=slug)
222 except models.Book.DoesNotExist:
223 return book_stub_detail(request, slug)
225 book_tag = book.book_tag()
226 tags = list(book.tags.filter(~Q(category='set')))
227 categories = split_tags(tags)
228 book_children = book.children.all().order_by('parent_number')
233 parents.append(_book.parent)
235 parents = reversed(parents)
237 theme_counter = book.theme_counter
238 book_themes = models.Tag.objects.filter(pk__in=theme_counter.keys())
239 for tag in book_themes:
240 tag.count = theme_counter[tag.pk]
242 extra_info = book.get_extra_info_value()
244 form = forms.SearchForm()
245 return render_to_response('catalogue/book_detail.html', locals(),
246 context_instance=RequestContext(request))
249 def book_stub_detail(request, slug):
250 book = get_object_or_404(models.BookStub, slug=slug)
252 form = forms.SearchForm()
254 return render_to_response('catalogue/book_stub_detail.html', locals(),
255 context_instance=RequestContext(request))
258 def book_text(request, slug):
259 book = get_object_or_404(models.Book, slug=slug)
260 if not book.has_html_file():
263 for fragment in book.fragments.all():
264 for theme in fragment.tags.filter(category='theme'):
265 book_themes.setdefault(theme, []).append(fragment)
267 book_themes = book_themes.items()
268 book_themes.sort(key=lambda s: s[0].sort_key)
269 return render_to_response('catalogue/book_text.html', locals(),
270 context_instance=RequestContext(request))
277 def _no_diacritics_regexp(query):
278 """ returns a regexp for searching for a query without diacritics
280 should be locale-aware """
282 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źżŹŻ',
283 u'ą':u'ąĄ', u'ć':u'ćĆ', u'ę':u'ęĘ', u'ł': u'łŁ', u'ń':u'ńŃ', u'ó':u'óÓ', u'ś':u'śŚ', u'ź':u'źŹ', u'ż':u'żŻ'
287 return u"(%s)" % '|'.join(names[l])
288 return re.sub(u'[%s]' % (u''.join(names.keys())), repl, query)
290 def unicode_re_escape(query):
291 """ Unicode-friendly version of re.escape """
292 return re.sub('(?u)(\W)', r'\\\1', query)
294 def _word_starts_with(name, prefix):
295 """returns a Q object getting models having `name` contain a word
296 starting with `prefix`
298 We define word characters as alphanumeric and underscore, like in JS.
300 Works for MySQL, PostgreSQL, Oracle.
301 For SQLite, _sqlite* version is substituted for this.
305 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
306 # can't use [[:<:]] (word start),
307 # but we want both `xy` and `(xy` to catch `(xyz)`
308 kwargs['%s__iregex' % name] = u"(^|[^[:alnum:]_])%s" % prefix
313 def _sqlite_word_starts_with(name, prefix):
314 """ version of _word_starts_with for SQLite
316 SQLite in Django uses Python re module
319 prefix = _no_diacritics_regexp(unicode_re_escape(prefix))
320 kwargs['%s__iregex' % name] = ur"(^|(?<=[^\wąćęłńóśźżĄĆĘŁŃÓŚŹŻ]))%s" % prefix
324 if settings.DATABASE_ENGINE == 'sqlite3':
325 _word_starts_with = _sqlite_word_starts_with
328 def _tags_starting_with(prefix, user=None):
329 prefix = prefix.lower()
330 book_stubs = models.BookStub.objects.filter(_word_starts_with('title', prefix))
331 books = models.Book.objects.filter(_word_starts_with('title', prefix))
332 book_stubs = filter(lambda x: x not in books, book_stubs)
333 tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
334 if user and user.is_authenticated():
335 tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
337 tags = tags.filter(~Q(category='book') & ~Q(category='set'))
338 return list(books) + list(tags) + list(book_stubs)
341 def _get_result_link(match, tag_list):
342 if isinstance(match, models.Book) or isinstance(match, models.BookStub):
343 return match.get_absolute_url()
345 return reverse('catalogue.views.tagged_object_list',
346 kwargs={'tags': '/'.join(tag.url_chunk for tag in tag_list + [match])}
349 def _get_result_type(match):
350 if isinstance(match, models.Book) or isinstance(match, models.BookStub):
353 type = match.category
358 def find_best_matches(query, user=None):
359 """ Finds a Book, Tag or Bookstub best matching a query.
362 - zero elements when nothing is found,
363 - one element when a best result is found,
364 - more then one element on multiple exact matches
366 Raises a ValueError on too short a query.
369 query = query.lower()
371 raise ValueError("query must have at least two characters")
373 result = tuple(_tags_starting_with(query, user))
374 exact_matches = tuple(res for res in result if res.name.lower() == query)
382 tags = request.GET.get('tags', '')
383 prefix = request.GET.get('q', '')
386 tag_list = models.Tag.get_tag_list(tags)
391 result = find_best_matches(prefix, request.user)
393 return render_to_response('catalogue/search_too_short.html', {'tags':tag_list, 'prefix':prefix},
394 context_instance=RequestContext(request))
397 return HttpResponseRedirect(_get_result_link(result[0], tag_list))
398 elif len(result) > 1:
399 return render_to_response('catalogue/search_multiple_hits.html',
400 {'tags':tag_list, 'prefix':prefix, 'results':((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)},
401 context_instance=RequestContext(request))
403 return render_to_response('catalogue/search_no_hits.html', {'tags':tag_list, 'prefix':prefix},
404 context_instance=RequestContext(request))
407 def tags_starting_with(request):
408 prefix = request.GET.get('q', '')
409 # Prefix must have at least 2 characters
411 return HttpResponse('')
414 for tag in _tags_starting_with(prefix, request.user):
415 if not tag.name in tags_list:
416 result += "\n" + tag.name
417 tags_list.append(tag.name)
418 return HttpResponse(result)
420 def json_tags_starting_with(request, callback=None):
422 prefix = request.GET.get('q', '')
423 callback = request.GET.get('callback', '')
424 # Prefix must have at least 2 characters
426 return HttpResponse('')
429 for tag in _tags_starting_with(prefix, request.user):
430 if not tag.name in tags_list:
431 result += "\n" + tag.name
432 tags_list.append(tag.name)
433 dict_result = {"matches": tags_list}
434 return JSONResponse(dict_result, callback)
436 # ====================
437 # = Shelf management =
438 # ====================
441 def user_shelves(request):
442 shelves = models.Tag.objects.filter(category='set', user=request.user)
443 new_set_form = forms.NewSetForm()
444 return render_to_response('catalogue/user_shelves.html', locals(),
445 context_instance=RequestContext(request))
448 def book_sets(request, slug):
449 book = get_object_or_404(models.Book, slug=slug)
450 user_sets = models.Tag.objects.filter(category='set', user=request.user)
451 book_sets = book.tags.filter(category='set', user=request.user)
453 if not request.user.is_authenticated():
454 return HttpResponse(_('<p>To maintain your shelves you need to be logged in.</p>'))
456 if request.method == 'POST':
457 form = forms.ObjectSetsForm(book, request.user, request.POST)
459 old_shelves = list(book.tags.filter(category='set'))
460 new_shelves = [models.Tag.objects.get(pk=id) for id in form.cleaned_data['set_ids']]
462 for shelf in [shelf for shelf in old_shelves if shelf not in new_shelves]:
463 shelf.book_count = None
466 for shelf in [shelf for shelf in new_shelves if shelf not in old_shelves]:
467 shelf.book_count = None
470 book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
471 if request.is_ajax():
472 return HttpResponse(_('<p>Shelves were sucessfully saved.</p>'))
474 return HttpResponseRedirect('/')
476 form = forms.ObjectSetsForm(book, request.user)
477 new_set_form = forms.NewSetForm()
479 return render_to_response('catalogue/book_sets.html', locals(),
480 context_instance=RequestContext(request))
486 def remove_from_shelf(request, shelf, book):
487 book = get_object_or_404(models.Book, slug=book)
488 shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
490 if shelf in book.tags:
491 models.Tag.objects.remove_tag(book, shelf)
493 shelf.book_count = None
496 return HttpResponse(_('Book was successfully removed from the shelf'))
498 return HttpResponse(_('This book is not on the shelf'))
501 def collect_books(books):
503 Returns all real books in collection.
507 if len(book.children.all()) == 0:
510 result += collect_books(book.children.all())
515 def download_shelf(request, slug):
517 Create a ZIP archive on disk and transmit it in chunks of 8KB,
518 without loading the whole file into memory. A similar approach can
519 be used for large dynamic PDF files.
521 shelf = get_object_or_404(models.Tag, slug=slug, category='set')
524 form = forms.DownloadFormatsForm(request.GET)
526 formats = form.cleaned_data['formats']
527 if len(formats) == 0:
528 formats = ['pdf', 'epub', 'odt', 'txt', 'mp3', 'ogg']
530 # Create a ZIP archive
531 temp = tempfile.TemporaryFile()
532 archive = zipfile.ZipFile(temp, 'w')
535 for book in collect_books(models.Book.tagged.with_all(shelf)):
536 if 'pdf' in formats and book.pdf_file:
537 filename = book.pdf_file.path
538 archive.write(filename, str('%s.pdf' % book.slug))
539 if book.root_ancestor not in already and 'epub' in formats and book.root_ancestor.epub_file:
540 filename = book.root_ancestor.epub_file.path
541 archive.write(filename, str('%s.epub' % book.root_ancestor.slug))
542 already.add(book.root_ancestor)
543 if 'odt' in formats and book.odt_file:
544 filename = book.odt_file.path
545 archive.write(filename, str('%s.odt' % book.slug))
546 if 'txt' in formats and book.txt_file:
547 filename = book.txt_file.path
548 archive.write(filename, str('%s.txt' % book.slug))
549 if 'mp3' in formats and book.mp3_file:
550 filename = book.mp3_file.path
551 archive.write(filename, str('%s.mp3' % book.slug))
552 if 'ogg' in formats and book.ogg_file:
553 filename = book.ogg_file.path
554 archive.write(filename, str('%s.ogg' % book.slug))
557 response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
558 response['Content-Disposition'] = 'attachment; filename=%s.zip' % shelf.sort_key
559 response['Content-Length'] = temp.tell()
562 response.write(temp.read())
567 def shelf_book_formats(request, shelf):
569 Returns a list of formats of books in shelf.
571 shelf = get_object_or_404(models.Tag, slug=shelf, category='set')
573 formats = {'pdf': False, 'epub': False, 'odt': False, 'txt': False, 'mp3': False, 'ogg': False}
575 for book in collect_books(models.Book.tagged.with_all(shelf)):
577 formats['pdf'] = True
578 if book.root_ancestor.epub_file:
579 formats['epub'] = True
581 formats['odt'] = True
583 formats['txt'] = True
585 formats['mp3'] = True
587 formats['ogg'] = True
589 return HttpResponse(LazyEncoder().encode(formats))
595 def new_set(request):
596 new_set_form = forms.NewSetForm(request.POST)
597 if new_set_form.is_valid():
598 new_set = new_set_form.save(request.user)
600 if request.is_ajax():
601 return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully created</p>') % new_set)
603 return HttpResponseRedirect('/')
605 return HttpResponseRedirect('/')
611 def delete_shelf(request, slug):
612 user_set = get_object_or_404(models.Tag, slug=slug, category='set', user=request.user)
615 if request.is_ajax():
616 return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully removed</p>') % user_set.name)
618 return HttpResponseRedirect('/')
627 form = AuthenticationForm(data=request.POST, prefix='login')
629 auth.login(request, form.get_user())
630 response_data = {'success': True, 'errors': {}}
632 response_data = {'success': False, 'errors': form.errors}
633 return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
638 def register(request):
639 registration_form = UserCreationForm(request.POST, prefix='registration')
640 if registration_form.is_valid():
641 user = registration_form.save()
642 user = auth.authenticate(
643 username=registration_form.cleaned_data['username'],
644 password=registration_form.cleaned_data['password1']
646 auth.login(request, user)
647 response_data = {'success': True, 'errors': {}}
649 response_data = {'success': False, 'errors': registration_form.errors}
650 return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
654 def logout_then_redirect(request):
656 return HttpResponseRedirect(urlquote_plus(request.GET.get('next', '/'), safe='/?='))
665 def import_book(request):
666 """docstring for import_book"""
667 book_import_form = forms.BookImportForm(request.POST, request.FILES)
668 if book_import_form.is_valid():
670 book_import_form.save()
672 info = sys.exc_info()
673 exception = pprint.pformat(info[1])
674 tb = '\n'.join(traceback.format_tb(info[2]))
675 return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
676 return HttpResponse(_("Book imported successfully"))
678 return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
683 """ Provides server time for jquery.countdown,
684 in a format suitable for Date.parse()
686 from datetime import datetime
687 return HttpResponse(datetime.now().strftime('%Y/%m/%d %H:%M:%S'))