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