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 gettings 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_starting_with(prefix, user):
 194     book_stubs = models.BookStub.objects.filter(_word_starts_with('title', prefix))
 195     books = models.Book.objects.filter(_word_starts_with('title', prefix))
 196     book_stubs = filter(lambda x: x not in books, book_stubs)
 197     tags = models.Tag.objects.filter(_word_starts_with('name', 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 search(request):
 207     tags = request.GET.get('tags', '')
 208     prefix = request.GET.get('q', '')
 209     # Prefix must have at least 2 characters
 210     if len(prefix) < 2:
 211         return HttpResponse('')
 212
 213     try:
 214         tag_list = models.Tag.get_tag_list(tags)
 215     except:
 216         tag_list = []
 217
 218     result = _tags_starting_with(prefix, request.user)
 219     if len(result) > 0:
 220         tag = result[0]
 221         if isinstance(tag, models.Book) or isinstance(tag, models.BookStub):
 222             return HttpResponseRedirect(tag.get_absolute_url())
 223         else:
 224             tag_list.append(tag)
 225
 226             return HttpResponseRedirect(reverse('catalogue.views.tagged_object_list',
 227                 kwargs={'tags': '/'.join(tag.slug for tag in tag_list)}
 228             ))
 229     else:
 230         return render_to_response('catalogue/search_no_hits.html', {'query':prefix, 'tags':tag_list},
 231             context_instance=RequestContext(request))
 232
 233
 234 def tags_starting_with(request):
 235     prefix = request.GET.get('q', '')
 236     # Prefix must have at least 2 characters
 237     if len(prefix) < 2:
 238         return HttpResponse('')
 239
 240     return HttpResponse('\n'.join(tag.name for tag in _tags_starting_with(prefix, request.user)))
 241
 242
 243 # ====================
 244 # = Shelf management =
 245 # ====================
 246 @login_required
 247 @cache.never_cache
 248 def user_shelves(request):
 249     shelves = models.Tag.objects.filter(category='set', user=request.user)
 250     new_set_form = forms.NewSetForm()
 251     return render_to_response('catalogue/user_shelves.html', locals(),
 252             context_instance=RequestContext(request))
 253
 254 @cache.never_cache
 255 def book_sets(request, slug):
 256     book = get_object_or_404(models.Book, slug=slug)
 257     user_sets = models.Tag.objects.filter(category='set', user=request.user)
 258     book_sets = book.tags.filter(category='set', user=request.user)
 259
 260     if not request.user.is_authenticated():
 261         return HttpResponse('<p>Aby zarządzać swoimi półkami, musisz się zalogować.</p>')
 262
 263     if request.method == 'POST':
 264         form = forms.ObjectSetsForm(book, request.user, request.POST)
 265         if form.is_valid():
 266             old_shelves = list(book.tags.filter(category='set'))
 267             new_shelves = [models.Tag.objects.get(pk=id) for id in form.cleaned_data['set_ids']]
 268
 269             for shelf in [shelf for shelf in old_shelves if shelf not in new_shelves]:
 270                 shelf.book_count -= 1
 271                 shelf.save()
 272
 273             for shelf in [shelf for shelf in new_shelves if shelf not in old_shelves]:
 274                 shelf.book_count += 1
 275                 shelf.save()
 276
 277             book.tags = new_shelves + list(book.tags.filter(~Q(category='set') | ~Q(user=request.user)))
 278             if request.is_ajax():
 279                 return HttpResponse('<p>Półki zostały zapisane.</p>')
 280             else:
 281                 return HttpResponseRedirect('/')
 282     else:
 283         form = forms.ObjectSetsForm(book, request.user)
 284         new_set_form = forms.NewSetForm()
 285
 286     return render_to_response('catalogue/book_sets.html', locals(),
 287         context_instance=RequestContext(request))
 288
 289
 290 @login_required
 291 @require_POST
 292 @cache.never_cache
 293 def remove_from_shelf(request, shelf, book):
 294     book = get_object_or_404(models.Book, slug=book)
 295     shelf = get_object_or_404(models.Tag, slug=shelf, category='set', user=request.user)
 296
 297     if shelf in book.tags:
 298         models.Tag.objects.remove_tag(book, shelf)
 299
 300         shelf.book_count -= 1
 301         shelf.save()
 302
 303         return HttpResponse('Usunięto')
 304     else:
 305         return HttpResponse('Książki nie ma na półce')
 306
 307
 308 def collect_books(books):
 309     """
 310     Returns all real books in collection.
 311     """
 312     result = []
 313     for book in books:
 314         if len(book.children.all()) == 0:
 315             result.append(book)
 316         else:
 317             result += collect_books(book.children.all())
 318     return result
 319
 320
 321 @cache.never_cache
 322 def download_shelf(request, slug):
 323     """"
 324     Create a ZIP archive on disk and transmit it in chunks of 8KB,
 325     without loading the whole file into memory. A similar approach can
 326     be used for large dynamic PDF files.
 327     """
 328     shelf = get_object_or_404(models.Tag, slug=slug, category='set')
 329
 330     formats = []
 331     form = forms.DownloadFormatsForm(request.GET)
 332     if form.is_valid():
 333         formats = form.cleaned_data['formats']
 334     if len(formats) == 0:
 335         formats = ['pdf', 'odt', 'txt', 'mp3', 'ogg']
 336
 337     # Create a ZIP archive
 338     temp = temp = tempfile.TemporaryFile()
 339     archive = zipfile.ZipFile(temp, 'w')
 340
 341     for book in collect_books(models.Book.tagged.with_all(shelf)):
 342         if 'pdf' in formats and book.pdf_file:
 343             filename = book.pdf_file.path
 344             archive.write(filename, str('%s.pdf' % book.slug))
 345         if 'odt' in formats and book.odt_file:
 346             filename = book.odt_file.path
 347             archive.write(filename, str('%s.odt' % book.slug))
 348         if 'txt' in formats and book.txt_file:
 349             filename = book.txt_file.path
 350             archive.write(filename, str('%s.txt' % book.slug))
 351         if 'mp3' in formats and book.mp3_file:
 352             filename = book.mp3_file.path
 353             archive.write(filename, str('%s.mp3' % book.slug))
 354         if 'ogg' in formats and book.ogg_file:
 355             filename = book.ogg_file.path
 356             archive.write(filename, str('%s.ogg' % book.slug))
 357     archive.close()
 358
 359     response = HttpResponse(content_type='application/zip', mimetype='application/x-zip-compressed')
 360     response['Content-Disposition'] = 'attachment; filename=%s.zip' % shelf.sort_key
 361     response['Content-Length'] = temp.tell()
 362
 363     temp.seek(0)
 364     response.write(temp.read())
 365     return response
 366
 367
 368 @cache.never_cache
 369 def shelf_book_formats(request, shelf):
 370     """"
 371     Returns a list of formats of books in shelf.
 372     """
 373     shelf = get_object_or_404(models.Tag, slug=shelf, category='set')
 374
 375     formats = {'pdf': False, 'odt': False, 'txt': False, 'mp3': False, 'ogg': False}
 376
 377     for book in collect_books(models.Book.tagged.with_all(shelf)):
 378         if book.pdf_file:
 379             formats['pdf'] = True
 380         if book.odt_file:
 381             formats['odt'] = True
 382         if book.txt_file:
 383             formats['txt'] = True
 384         if book.mp3_file:
 385             formats['mp3'] = True
 386         if book.ogg_file:
 387             formats['ogg'] = True
 388
 389     return HttpResponse(LazyEncoder().encode(formats))
 390
 391
 392 @login_required
 393 @require_POST
 394 @cache.never_cache
 395 def new_set(request):
 396     new_set_form = forms.NewSetForm(request.POST)
 397     if new_set_form.is_valid():
 398         new_set = new_set_form.save(request.user)
 399
 400         if request.is_ajax():
 401             return HttpResponse(u'<p>Półka <strong>%s</strong> została utworzona</p>' % new_set)
 402         else:
 403             return HttpResponseRedirect('/')
 404
 405     return HttpResponseRedirect('/')
 406
 407
 408 @login_required
 409 @require_POST
 410 @cache.never_cache
 411 def delete_shelf(request, slug):
 412     user_set = get_object_or_404(models.Tag, slug=slug, category='set', user=request.user)
 413     user_set.delete()
 414
 415     if request.is_ajax():
 416         return HttpResponse(u'<p>Półka <strong>%s</strong> została usunięta</p>' % user_set.name)
 417     else:
 418         return HttpResponseRedirect('/')
 419
 420
 421 # ==================
 422 # = Authentication =
 423 # ==================
 424 @require_POST
 425 @cache.never_cache
 426 def login(request):
 427     form = AuthenticationForm(data=request.POST, prefix='login')
 428     if form.is_valid():
 429         auth.login(request, form.get_user())
 430         response_data = {'success': True, 'errors': {}}
 431     else:
 432         response_data = {'success': False, 'errors': form.errors}
 433     return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
 434
 435
 436 @require_POST
 437 @cache.never_cache
 438 def register(request):
 439     registration_form = UserCreationForm(request.POST, prefix='registration')
 440     if registration_form.is_valid():
 441         user = registration_form.save()
 442         user = auth.authenticate(
 443             username=registration_form.cleaned_data['username'],
 444             password=registration_form.cleaned_data['password1']
 445         )
 446         auth.login(request, user)
 447         response_data = {'success': True, 'errors': {}}
 448     else:
 449         response_data = {'success': False, 'errors': registration_form.errors}
 450     return HttpResponse(LazyEncoder(ensure_ascii=False).encode(response_data))
 451
 452
 453 @cache.never_cache
 454 def logout_then_redirect(request):
 455     auth.logout(request)
 456     return HttpResponseRedirect(request.GET.get('next', '/'))
 457
 458
 459
 460 # =========
 461 # = Admin =
 462 # =========
 463 @login_required
 464 @staff_required
 465 def import_book(request):
 466     """docstring for import_book"""
 467     book_import_form = forms.BookImportForm(request.POST, request.FILES)
 468     if book_import_form.is_valid():
 469         try:
 470             book_import_form.save()
 471         except:
 472             info = sys.exc_info()
 473             exception = pprint.pformat(info[1])
 474             tb = '\n'.join(traceback.format_tb(info[2]))
 475             return HttpResponse("An error occurred: %s\n\n%s" % (exception, tb), mimetype='text/plain')
 476         return HttpResponse("Book imported successfully")
 477     else:
 478         return HttpResponse("Error importing file: %r" % book_import_form.errors)
 479
 480
 481
 482 def clock(request):
 483     """ Provides server time for jquery.countdown,
 484     in a format suitable for Date.parse()
 485     """
 486     from datetime import datetime
 487     return HttpResponse(datetime.now().strftime('%Y/%m/%d %H:%M:%S'))