apps/catalogue/views.py

   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.
   4 #
   5 import tempfile
   6 import zipfile
   7 import sys
   8 import pprint
   9 import traceback
  10 import re
  11
  12 from django.conf import settings
  13 from django.template import RequestContext
  14 from django.shortcuts import render_to_response, get_object_or_404
  15 from django.http import HttpResponse, HttpResponseRedirect, Http404
  16 from django.core.urlresolvers import reverse
  17 from django.db.models import Q
  18 from django.contrib.auth.decorators import login_required, user_passes_test
  19 from django.utils.datastructures import SortedDict
  20 from django.views.decorators.http import require_POST
  21 from django.contrib import auth
  22 from django.contrib.auth.forms import UserCreationForm, AuthenticationForm
  23 from django.utils import simplejson
  24 from django.utils.functional import Promise
  25 from django.utils.encoding import force_unicode
  26 from django.utils.http import urlquote_plus
  27 from django.views.decorators import cache
  28 from django.utils.translation import ugettext as _
  29
  30 from catalogue import models
  31 from catalogue import forms
  32 from catalogue.utils import split_tags
  33 from newtagging import views as newtagging_views
  34
  35
  36 staff_required = user_passes_test(lambda user: user.is_staff)
  37
  38
  39 class LazyEncoder(simplejson.JSONEncoder):
  40     def default(self, obj):
  41         if isinstance(obj, Promise):
  42             return force_unicode(obj)
  43         return obj
  44
  45
  46 def main_page(request):
  47     if request.user.is_authenticated():
  48         shelves = models.Tag.objects.filter(category='set', user=request.user)
  49         new_set_form = forms.NewSetForm()
  50     extra_where = "NOT catalogue_tag.category = 'set'"
  51     tags = models.Tag.objects.usage_for_model(models.Book, counts=True, extra={'where': [extra_where]})
  52     fragment_tags = models.Tag.objects.usage_for_model(models.Fragment, counts=True,
  53         extra={'where': ["catalogue_tag.category = 'theme'"] + [extra_where]})
  54     categories = split_tags(tags)
  55
  56     form = forms.SearchForm()
  57     return render_to_response('catalogue/main_page.html', locals(),
  58         context_instance=RequestContext(request))
  59
  60
  61 def book_list(request):
  62     books = models.Book.objects.all()
  63     form = forms.SearchForm()
  64
  65     books_by_first_letter = SortedDict()
  66     for book in books:
  67         books_by_first_letter.setdefault(book.title[0], []).append(book)
  68
  69     return render_to_response('catalogue/book_list.html', locals(),
  70         context_instance=RequestContext(request))
  71
  72
  73 def tagged_object_list(request, tags=''):
  74     # Prevent DoS attacks on our database
  75     if len(tags.split('/')) > 6:
  76         raise Http404
  77
  78     try:
  79         tags = models.Tag.get_tag_list(tags)
  80     except models.Tag.DoesNotExist:
  81         raise Http404
  82
  83     if len([tag for tag in tags if tag.category == 'book']):
  84         raise Http404
  85
  86     theme_is_set = [tag for tag in tags if tag.category == 'theme']
  87     shelf_is_set = len(tags) == 1 and tags[0].category == 'set'
  88     my_shelf_is_set = shelf_is_set and request.user.is_authenticated() and request.user == shelf[0].user
  89
  90     objects = only_author = pd_counter = categories = None
  91
  92     if theme_is_set:
  93         shelf_tags = [tag for tag in tags if tag.category == 'set']
  94         fragment_tags = [tag for tag in tags if tag.category != 'set']
  95         fragments = models.Fragment.tagged.with_all(fragment_tags)
  96
  97         if shelf_tags:
  98             books = models.Book.tagged.with_all(shelf_tags)
  99             l_tags = [models.Tag.objects.get(slug = 'l-' + book.slug) for book in books]
 100             fragments = (fragment for fragment in models.Fragment.tagged.with_any(l_tags) if fragment in fragments)
 101
 102         fragment_keys = (fragment.pk for fragment in fragments)
 103         if fragment_keys:
 104             related_tags = models.Fragment.tags.usage(counts=True,
 105                                 filters={'pk__in': fragment_keys},
 106                                 extra={'where': ["catalogue_tag.category != 'book'"]})
 107             related_tags = (tag for tag in related_tags if tag not in fragment_tags)
 108             categories = split_tags(related_tags)
 109
 110             objects = fragments
 111     else:
 112         books = models.Book.tagged.with_all(tags)
 113         l_tags = [models.Tag.objects.get(slug = 'l-' + book.slug) for book in books]
 114         book_keys = [book.pk for book in books]
 115         if book_keys:
 116             related_tags = models.Book.tags.usage(counts=True,
 117                                 filters={'pk__in': book_keys},
 118                                 extra={'where': ["catalogue_tag.category NOT IN ('set', 'book', 'theme')"]})
 119             categories = split_tags(related_tags)
 120
 121             fragment_keys = [fragment.pk for fragment in models.Fragment.tagged.with_any(l_tags)]
 122             if fragment_keys:
 123                 categories['theme'] = models.Fragment.tags.usage(counts=True,
 124                                     filters={'pk__in': fragment_keys},
 125                                     extra={'where': ["catalogue_tag.category = 'theme'"]})
 126
 127             books = books.exclude(parent__in = book_keys)
 128             objects = books
 129
 130     if not objects:
 131         only_author = len(tags) == 1 and tags[0].category == 'author'
 132         pd_counter = only_author and tags[0].goes_to_pd()
 133         objects = models.Book.objects.none()
 134
 135     return newtagging_views.tagged_object_list(
 136         request,
 137         tag_model=models.Tag,
 138         queryset_or_model=objects,
 139         tags=tags,
 140         template_name='catalogue/tagged_object_list.html',
 141         extra_context = {
 142             'categories': categories,
 143             'shelf_is_set': shelf_is_set,
 144             'only_author': only_author,
 145             'pd_counter': pd_counter,
 146             'user_is_owner': my_shelf_is_set,
 147             'formats_form': forms.DownloadFormatsForm(),
 148         },
 149     )
 150
 151
 152 def book_fragments(request, book_slug, theme_slug):
 153     book = get_object_or_404(models.Book, slug=book_slug)
 154     book_tag = get_object_or_404(models.Tag, slug='l-' + book_slug)
 155     theme = get_object_or_404(models.Tag, slug=theme_slug)
 156     fragments = models.Fragment.tagged.with_all([book_tag, theme])
 157
 158     form = forms.SearchForm()
 159     return render_to_response('catalogue/book_fragments.html', locals(),
 160         context_instance=RequestContext(request))
 161
 162
 163 def book_detail(request, slug):
 164     try:
 165         book = models.Book.objects.get(slug=slug)
 166     except models.Book.DoesNotExist:
 167         return book_stub_detail(request, slug)
 168
 169     book_tag = get_object_or_404(models.Tag, slug = 'l-' + slug)
 170     tags = list(book.tags.filter(~Q(category='set')))
 171     categories = split_tags(tags)
 172     book_children = book.children.all().order_by('parent_number')
 173     extra_where = "catalogue_tag.category = 'theme'"
 174     book_themes = models.Tag.objects.related_for_model(book_tag, models.Fragment, counts=True, extra={'where': [extra_where]})
 175     extra_info = book.get_extra_info_value()
 176
 177     form = forms.SearchForm()
 178     return render_to_response('catalogue/book_detail.html', locals(),
 179         context_instance=RequestContext(request))
 180
 181
 182 def book_stub_detail(request, slug):
 183     book = get_object_or_404(models.BookStub, slug=slug)
 184     pd_counter = book.pd
 185     form = forms.SearchForm()
 186
 187     return render_to_response('catalogue/book_stub_detail.html', locals(),
 188         context_instance=RequestContext(request))
 189
 190
 191 def book_text(request, slug):
 192     book = get_object_or_404(models.Book, slug=slug)
 193     book_themes = {}
 194     for fragment in book.fragments.all():
 195         for theme in fragment.tags.filter(category='theme'):
 196             book_themes.setdefault(theme, []).append(fragment)
 197
 198     book_themes = book_themes.items()
 199     book_themes.sort(key=lambda s: s[0].sort_key)
 200     return render_to_response('catalogue/book_text.html', locals(),
 201         context_instance=RequestContext(request))
 202
 203
 204 # ==========
 205 # = Search =
 206 # ==========
 207
 208 def _no_diacritics_regexp(query):
 209     """ returns a regexp for searching for a query without diacritics
 210
 211     should be locale-aware """
 212     names = {'a':u'ą', 'c':u'ć', 'e':u'ę', 'l': u'ł', 'n':u'ń', 'o':u'ó', 's':u'ś', 'z':u'ź|ż'}
 213     def repl(m):
 214         l = m.group()
 215         return "(%s|%s)" % (l, names[l])
 216     return re.sub('[%s]'%(''.join(names.keys())), repl, query)
 217
 218 def _word_starts_with(name, prefix):
 219     """returns a Q object getting models having `name` contain a word
 220     starting with `prefix`
 221     """
 222     kwargs = {}
 223     if settings.DATABASE_ENGINE in ('mysql', 'postgresql_psycopg2', 'postgresql'):
 224         prefix = _no_diacritics_regexp(re.escape(prefix))
 225         # we could use a [[:<:]] (word start),
 226         # but we want both `xy` and `(xy` to catch `(xyz)`
 227         kwargs['%s__iregex' % name] = u"(^|[^[:alpha:]])%s" % prefix
 228     else:
 229         # don't know how to do a generic regex
 230         # checking for simple icontain instead
 231         kwargs['%s__icontains' % name] = prefix
 232     return Q(**kwargs)
 233
 234
 235 def _tags_exact_matches(prefix, user):
 236     book_stubs = models.BookStub.objects.filter(title__iexact = prefix)
 237     books = models.Book.objects.filter(title__iexact = prefix)
 238     book_stubs = filter(lambda x: x not in books, book_stubs)
 239     tags = models.Tag.objects.filter(name__iexact = prefix)
 240     if user.is_authenticated():
 241         tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
 242     else:
 243         tags = tags.filter(~Q(category='book') & ~Q(category='set'))
 244
 245     return list(books) + list(tags) + list(book_stubs)
 246
 247
 248 def _tags_starting_with(prefix, user):
 249     book_stubs = models.BookStub.objects.filter(_word_starts_with('title', prefix))
 250     books = models.Book.objects.filter(_word_starts_with('title', prefix))
 251     book_stubs = filter(lambda x: x not in books, book_stubs)
 252     tags = models.Tag.objects.filter(_word_starts_with('name', prefix))
 253     if user.is_authenticated():
 254         tags = tags.filter(~Q(category='book') & (~Q(category='set') | Q(user=user)))
 255     else:
 256         tags = tags.filter(~Q(category='book') & ~Q(category='set'))
 257
 258     return list(books) + list(tags) + list(book_stubs)
 259
 260
 261
 262 def _get_result_link(match, tag_list):
 263     if isinstance(match, models.Book) or isinstance(match, models.BookStub):
 264         return match.get_absolute_url()
 265     else:
 266         return reverse('catalogue.views.tagged_object_list',
 267             kwargs={'tags': '/'.join(tag.slug for tag in tag_list + [match])}
 268         )
 269
 270 def _get_result_type(match):
 271     if isinstance(match, models.Book) or isinstance(match, models.BookStub):
 272         type = 'book'
 273     else:
 274         type = match.category
 275     return dict(models.TAG_CATEGORIES)[type]
 276
 277
 278
 279 def search(request):
 280     tags = request.GET.get('tags', '')
 281     prefix = request.GET.get('q', '')
 282
 283     try:
 284         tag_list = models.Tag.get_tag_list(tags)
 285     except:
 286         tag_list = []
 287
 288     # Prefix must have at least 2 characters
 289     if len(prefix) < 2:
 290         return render_to_response('catalogue/search_too_short.html', {'tags':tag_list, 'prefix':prefix},
 291             context_instance=RequestContext(request))
 292
 293     result = _tags_exact_matches(prefix, request.user)
 294
 295     if len(result) > 1:
 296         # multiple exact matches
 297         return render_to_response('catalogue/search_multiple_hits.html',
 298             {'tags':tag_list, 'prefix':prefix, 'results':((x, _get_result_link(x, tag_list), _get_result_type(x)) for x in result)},
 299             context_instance=RequestContext(request))
 300
 301     if not result:
 302         # no exact matches
 303         result = _tags_starting_with(prefix, request.user)
 304
 305     if result:
 306         return HttpResponseRedirect(_get_result_link(result[0], tag_list))
 307     else:
 308         return render_to_response('catalogue/search_no_hits.html', {'tags':tag_list, 'prefix':prefix},
 309             context_instance=RequestContext(request))
 310
 311
 312 def tags_starting_with(request):
 313     prefix = request.GET.get('q', '')
 314     # Prefix must have at least 2 characters
 315     if len(prefix) < 2:
 316         return HttpResponse('')
 317
 318     return HttpResponse('\n'.join(tag.name for tag in _tags_starting_with(prefix, request.user)))
 319
 320
 321 # ====================
 322 # = Shelf management =
 323 # ====================
 324 @login_required
 325 @cache.never_cache
 326 def user_shelves(request):
 327     shelves = models.Tag.objects.filter(category='set', user=request.user)
 328     new_set_form = forms.NewSetForm()
 329     return render_to_response('catalogue/user_shelves.html', locals(),
 330             context_instance=RequestContext(request))
 331
 332 @cache.never_cache
 333 def book_sets(request, slug):
 334     book = get_object_or_404(models.Book, slug=slug)
 335     user_sets = models.Tag.objects.filter(category='set', user=request.user)
 336     book_sets = book.tags.filter(category='set', user=request.user)
 337
 338     if not request.user.is_authenticated():
 339         return HttpResponse(_('<p>To maintain your shelves you need to be logged in.</p>'))
 340
 341     if request.method == 'POST':
 342         form = forms.ObjectSetsForm(book, request.user, request.POST)
 343         if form.is_valid():
 344             old_shelves = list(book.tags.filter(category='set'))
 345             new_shelves = [models.Tag.objects.get(pk=id) for id in form.cleaned_data['set_ids']]
 346
 347             for shelf in [shelf for shelf in old_shelves if shelf not in new_shelves]:
 348                 shelf.book_count -= 1
 349                 shelf.save()
 350
 351             for shelf in [shelf for shelf in new_shelves if shelf not in old_shelves]:
 352                 shelf.book_count += 1
 353                 shelf.save()
 354
 355             book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
 356             if request.is_ajax():
 357                 return HttpResponse(_('<p>Shelves were sucessfully saved.</p>'))
 358             else:
 359                 return HttpResponseRedirect('/')
 360     else:
 361         form = forms.ObjectSetsForm(book, request.user)
 362         new_set_form = forms.NewSetForm()
 363
 364     return render_to_response('catalogue/book_sets.html', locals(),
 365         context_instance=RequestContext(request))
 366
 367
 368 @login_required
 369 @require_POST
 370 @cache.never_cache
 371 def remove_from_shelf(request, shelf, book):
 372     book = get_object_or_404(models.Book, slug=book)
 373     shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
 374
 375     if shelf in book.tags:
 376         models.Tag.objects.remove_tag(book, shelf)
 377
 378         shelf.book_count -= 1
 379         shelf.save()
 380
 381         return HttpResponse(_('Book was successfully removed from the shelf'))
 382     else:
 383         return HttpResponse(_('This book is not on the shelf'))
 384
 385
 386 def collect_books(books):
 387     """
 388     Returns all real books in collection.
 389     """
 390     result = []
 391     for book in books:
 392         if len(book.children.all()) == 0:
 393             result.append(book)
 394         else:
 395             result += collect_books(book.children.all())
 396     return result
 397
 398
 399 @cache.never_cache
 400 def download_shelf(request, slug):
 401     """"
 402     Create a ZIP archive on disk and transmit it in chunks of 8KB,
 403     without loading the whole file into memory. A similar approach can
 404     be used for large dynamic PDF files.
 405     """
 406     shelf = get_object_or_404(models.Tag, slug=slug, category='set')
 407
 408     formats = []
 409     form = forms.DownloadFormatsForm(request.GET)
 410     if form.is_valid():
 411         formats = form.cleaned_data['formats']
 412     if len(formats) == 0:
 413         formats = ['pdf', 'odt', 'txt', 'mp3', 'ogg']
 414
 415     # Create a ZIP archive
 416     temp = tempfile.TemporaryFile()
 417     archive = zipfile.ZipFile(temp, 'w')
 418
 419     for book in collect_books(models.Book.tagged.with_all(shelf)):
 420         if 'pdf' in formats and book.pdf_file:
 421             filename = book.pdf_file.path
 422             archive.write(filename, str('%s.pdf' % book.slug))
 423         if 'odt' in formats and book.odt_file:
 424             filename = book.odt_file.path
 425             archive.write(filename, str('%s.odt' % book.slug))
 426         if 'txt' in formats and book.txt_file:
 427             filename = book.txt_file.path
 428             archive.write(filename, str('%s.txt' % book.slug))
 429         if 'mp3' in formats and book.mp3_file:
 430             filename = book.mp3_file.path
 431             archive.write(filename, str('%s.mp3' % book.slug))
 432         if 'ogg' in formats and book.ogg_file:
 433             filename = book.ogg_file.path
 434             archive.write(filename, str('%s.ogg' % book.slug))
 435     archive.close()
 436
 437     response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
 438     response['Content-Disposition'] = 'attachment; filename=%s.zip' % shelf.sort_key
 439     response['Content-Length'] = temp.tell()
 440
 441     temp.seek(0)
 442     response.write(temp.read())
 443     return response
 444
 445
 446 @cache.never_cache
 447 def shelf_book_formats(request, shelf):
 448     """"
 449     Returns a list of formats of books in shelf.
 450     """
 451     shelf = get_object_or_404(models.Tag, slug=shelf, category='set')
 452
 453     formats = {'pdf': False, 'odt': False, 'txt': False, 'mp3': False, 'ogg': False}
 454
 455     for book in collect_books(models.Book.tagged.with_all(shelf)):
 456         if book.pdf_file:
 457             formats['pdf'] = True
 458         if book.odt_file:
 459             formats['odt'] = True
 460         if book.txt_file:
 461             formats['txt'] = True
 462         if book.mp3_file:
 463             formats['mp3'] = True
 464         if book.ogg_file:
 465             formats['ogg'] = True
 466
 467     return HttpResponse(LazyEncoder().encode(formats))
 468
 469
 470 @login_required
 471 @require_POST
 472 @cache.never_cache
 473 def new_set(request):
 474     new_set_form = forms.NewSetForm(request.POST)
 475     if new_set_form.is_valid():
 476         new_set = new_set_form.save(request.user)
 477
 478         if request.is_ajax():
 479             return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully created</p>') % new_set)
 480         else:
 481             return HttpResponseRedirect('/')
 482
 483     return HttpResponseRedirect('/')
 484
 485
 486 @login_required
 487 @require_POST
 488 @cache.never_cache
 489 def delete_shelf(request, slug):
 490     user_set = get_object_or_404(models.Tag, slug=slug, category='set', user=request.user)
 491     user_set.delete()
 492
 493     if request.is_ajax():
 494         return HttpResponse(_('<p>Shelf <strong>%s</strong> was successfully removed</p>') % user_set.name)
 495     else:
 496         return HttpResponseRedirect('/')
 497
 498
 499 # ==================
 500 # = Authentication =
 501 # ==================
 502 @require_POST
 503 @cache.never_cache
 504 def login(request):
 505     form = AuthenticationForm(data=request.POST, prefix='login')
 506     if form.is_valid():
 507         auth.login(request, form.get_user())
 508         response_data = {'success': True, 'errors': {}}
 509     else:
 510         response_data = {'success': False, 'errors': form.errors}
 511     return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
 512
 513
 514 @require_POST
 515 @cache.never_cache
 516 def register(request):
 517     registration_form = UserCreationForm(request.POST, prefix='registration')
 518     if registration_form.is_valid():
 519         user = registration_form.save()
 520         user = auth.authenticate(
 521             username=registration_form.cleaned_data['username'],
 522             password=registration_form.cleaned_data['password1']
 523         )
 524         auth.login(request, user)
 525         response_data = {'success': True, 'errors': {}}
 526     else:
 527         response_data = {'success': False, 'errors': registration_form.errors}
 528     return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
 529
 530
 531 @cache.never_cache
 532 def logout_then_redirect(request):
 533     auth.logout(request)
 534     return HttpResponseRedirect(urlquote_plus(request.GET.get('next', '/'), safe='/?='))
 535
 536
 537
 538 # =========
 539 # = Admin =
 540 # =========
 541 @login_required
 542 @staff_required
 543 def import_book(request):
 544     """docstring for import_book"""
 545     book_import_form = forms.BookImportForm(request.POST, request.FILES)
 546     if book_import_form.is_valid():
 547         try:
 548             book_import_form.save()
 549         except:
 550             info = sys.exc_info()
 551             exception = pprint.pformat(info[1])
 552             tb = '\n'.join(traceback.format_tb(info[2]))
 553             _('Today is %(month)s, %(day)s.') % {'month': m, 'day': d}
 554             return HttpResponse(_("An error occurred: %(exception)s\n\n%(tb)s") % {'exception':exception, 'tb':tb}, mimetype='text/plain')
 555         return HttpResponse(_("Book imported successfully"))
 556     else:
 557         return HttpResponse(_("Error importing file: %r") % book_import_form.errors)
 558
 559
 560
 561 def clock(request):
 562     """ Provides server time for jquery.countdown,
 563     in a format suitable for Date.parse()
 564     """
 565     from datetime import datetime
 566     return HttpResponse(datetime.now().strftime('%Y/%m/%d %H:%M:%S'))