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