X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/38b4defd76b7ed4fedcd81631ec6a4351b469cdc..3768325f42689394f4639ff92e3cc483670c0d17:/apps/api/handlers.py diff --git a/apps/api/handlers.py b/apps/api/handlers.py index bd44e57a8..0255c05c5 100644 --- a/apps/api/handlers.py +++ b/apps/api/handlers.py @@ -3,19 +3,23 @@ # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information. from datetime import datetime, timedelta +import json from django.conf import settings from django.contrib.sites.models import Site +from django.core.cache import get_cache from django.core.urlresolvers import reverse -from django.http import Http404 -from django.shortcuts import get_object_or_404 -from piston.handler import BaseHandler +from piston.handler import AnonymousBaseHandler, BaseHandler from piston.utils import rc from api.helpers import timestamp from api.models import Deleted +from catalogue.forms import BookImportForm from catalogue.models import Book, Tag, BookMedia, Fragment +from picture.models import Picture +from picture.forms import PictureImportForm +from stats.utils import piwik_track API_BASE = WL_BASE = MEDIA_BASE = 'http://' + Site.objects.get_current().domain @@ -32,13 +36,16 @@ category_plural={} for k, v in category_singular.items(): category_plural[v] = k +book_tag_categories = ['author', 'epoch', 'kind', 'genre'] + + def read_tags(tags, allowed): """ Reads a path of filtering tags. :param str tags: a path of category and slug pairs, like: authors/an-author/... :returns: list of Tag objects - :raises: django.http.Http404 + :raises: ValueError when tags can't be found """ if not tags: return [] @@ -52,16 +59,19 @@ def read_tags(tags, allowed): try: category = category_singular[category] except KeyError: - raise Http404 + raise ValueError('Unknown category.') if not category in allowed: - raise Http404 + raise ValueError('Category not allowed.') # !^%@#$^#! if category == 'book': slug = 'l-' + slug - real_tags.append(get_object_or_404(Tag, category=category, slug=slug)) + try: + real_tags.append(Tag.objects.get(category=category, slug=slug)) + except Tag.DoesNotExist: + raise ValueError('Tag not found') return real_tags @@ -81,48 +91,66 @@ class BookMediaHandler(BaseHandler): return MEDIA_BASE + media.file.url -class BookDetailHandler(BaseHandler): - """ Main handler for Book objects. +class BookDetails(object): + """Custom fields used for representing Books.""" - Responsible for lists of Book objects - and fields used for representing Books. + @classmethod + def author(cls, book): + return ", ".join(t.name for t in book.tags.filter(category='author')) - """ - allowed_methods = ['GET'] - fields = ['title', 'parent', - 'xml', 'html', 'pdf', 'epub', 'txt', - 'media', 'url'] + category_singular.keys() + @classmethod + def href(cls, book): + """ Returns an URI for a Book in the API. """ + return API_BASE + reverse("api_book", args=[book.slug]) - def read(self, request, slug): - """ Returns details of a book, identified by a slug. """ + @classmethod + def url(cls, book): + """ Returns Book's URL on the site. """ - return get_object_or_404(Book, slug=slug) + return WL_BASE + book.get_absolute_url() + + @classmethod + def children(cls, book): + """ Returns all media for a book. """ + + return book.children.all() + + @classmethod + def media(cls, book): + """ Returns all media for a book. """ + + return book.media.all() -class BooksHandler(BaseHandler): - """ Main handler for Book objects. - Responsible for lists of Book objects - and fields used for representing Books. +class BookDetailHandler(BaseHandler, BookDetails): + """ Main handler for Book objects. + Responsible for single Book details. """ - allowed_methods = ('GET',) - model = Book - fields = ['href', 'title'] + allowed_methods = ['GET'] + fields = ['title', 'parent', 'children'] + Book.formats + [ + 'media', 'url'] + book_tag_categories - categories = set(['author', 'epoch', 'kind', 'genre']) + @piwik_track + def read(self, request, book): + """ Returns details of a book, identified by a slug and lang. """ + try: + return Book.objects.get(slug=book) + except Book.DoesNotExist: + return rc.NOT_FOUND - @classmethod - def href(cls, book): - """ Returns an URI for a Book in the API. """ - return API_BASE + reverse("api_book", args=[book.slug]) - @classmethod - def url(cls, book): - """ Returns Book's URL on the site. """ +class AnonymousBooksHandler(AnonymousBaseHandler, BookDetails): + """ Main handler for Book objects. - return WL_BASE + book.get_absolute_url() + Responsible for lists of Book objects. + """ + allowed_methods = ('GET',) + model = Book + fields = ['author', 'href', 'title', 'url'] + @piwik_track def read(self, request, tags, top_level=False): """ Lists all books with given tags. @@ -132,13 +160,19 @@ class BooksHandler(BaseHandler): it's children are aren't. By default all books matching the tags are returned. """ - tags = read_tags(tags, allowed=self.categories) + try: + tags = read_tags(tags, allowed=book_tag_categories) + except ValueError: + return rc.NOT_FOUND + if tags: if top_level: books = Book.tagged_top_level(tags) return books if books else rc.NOT_FOUND else: books = Book.tagged.with_all(tags) + elif top_level: + books = Book.objects.filter(parent=None) else: books = Book.objects.all() @@ -147,6 +181,27 @@ class BooksHandler(BaseHandler): else: return rc.NOT_FOUND + def create(self, request, tags, top_level=False): + return rc.FORBIDDEN + + +class BooksHandler(BookDetailHandler): + model = Book + fields = ['author', 'href', 'title', 'url'] + anonymous = AnonymousBooksHandler + + def create(self, request, tags, top_level=False): + if not request.user.has_perm('catalogue.add_book'): + return rc.FORBIDDEN + + data = json.loads(request.POST.get('data')) + form = BookImportForm(data) + if form.is_valid(): + form.save() + return rc.CREATED + else: + return rc.NOT_FOUND + # add categorized tags fields for Book def _tags_getter(category): @@ -155,7 +210,7 @@ def _tags_getter(category): return book.tags.filter(category=category) return get_tags for plural, singular in category_singular.items(): - setattr(BooksHandler, plural, _tags_getter(singular)) + setattr(BookDetails, plural, _tags_getter(singular)) # add fields for files in Book def _file_getter(format): @@ -168,15 +223,32 @@ def _file_getter(format): else: return '' return get_file -for format in ('xml', 'txt', 'html', 'epub', 'pdf'): - setattr(BooksHandler, format, _file_getter(format)) +for format in Book.formats: + setattr(BookDetails, format, _file_getter(format)) + + +class TagDetails(object): + """Custom Tag fields.""" + + @classmethod + def href(cls, tag): + """ Returns URI in the API for the tag. """ + + return API_BASE + reverse("api_tag", args=[category_plural[tag.category], tag.slug]) + @classmethod + def url(cls, tag): + """ Returns URL on the site. """ + + return WL_BASE + tag.get_absolute_url() -class TagDetailHandler(BaseHandler): + +class TagDetailHandler(BaseHandler, TagDetails): """ Responsible for details of a single Tag object. """ - fields = ['name', 'sort_key', 'description'] + fields = ['name', 'url', 'sort_key', 'description'] + @piwik_track def read(self, request, category, slug): """ Returns details of a tag, identified by category and slug. """ @@ -185,10 +257,13 @@ class TagDetailHandler(BaseHandler): except KeyError, e: return rc.NOT_FOUND - return get_object_or_404(Tag, category=category_sng, slug=slug) + try: + return Tag.objects.get(category=category_sng, slug=slug) + except Tag.DoesNotExist: + return rc.NOT_FOUND -class TagsHandler(BaseHandler): +class TagsHandler(BaseHandler, TagDetails): """ Main handler for Tag objects. Responsible for lists of Tag objects @@ -197,8 +272,9 @@ class TagsHandler(BaseHandler): """ allowed_methods = ('GET',) model = Tag - fields = ['name', 'href'] + fields = ['name', 'href', 'url'] + @piwik_track def read(self, request, category): """ Lists all tags in the category (eg. all themes). """ @@ -207,31 +283,49 @@ class TagsHandler(BaseHandler): except KeyError, e: return rc.NOT_FOUND - tags = Tag.objects.filter(category=category_sng) - tags = [t for t in tags if t.get_count() > 0] - if tags: + tags = Tag.objects.filter(category=category_sng).exclude(book_count=0) + if tags.exists(): return tags else: return rc.NOT_FOUND +class FragmentDetails(object): + """Custom Fragment fields.""" + @classmethod - def href(cls, tag): - """ Returns URI in the API for the tag. """ + def href(cls, fragment): + """ Returns URI in the API for the fragment. """ - return API_BASE + reverse("api_tag", args=[category_plural[tag.category], tag.slug]) + return API_BASE + reverse("api_fragment", + args=[fragment.book.slug, fragment.anchor]) + @classmethod + def url(cls, fragment): + """ Returns URL on the site for the fragment. """ -class FragmentDetailHandler(BaseHandler): + return WL_BASE + fragment.get_absolute_url() + + @classmethod + def themes(cls, fragment): + """ Returns a list of theme tags for the fragment. """ + + return fragment.tags.filter(category='theme') + + +class FragmentDetailHandler(BaseHandler, FragmentDetails): fields = ['book', 'anchor', 'text', 'url', 'themes'] - def read(self, request, slug, anchor): + @piwik_track + def read(self, request, book, anchor): """ Returns details of a fragment, identified by book slug and anchor. """ - - return get_object_or_404(Fragment, book__slug=slug, anchor=anchor) + try: + return Fragment.objects.get(book__slug=book, anchor=anchor) + except Fragment.DoesNotExist: + return rc.NOT_FOUND -class FragmentsHandler(BaseHandler): +class FragmentsHandler(BaseHandler, FragmentDetails): """ Main handler for Fragments. Responsible for lists of Fragment objects @@ -239,11 +333,12 @@ class FragmentsHandler(BaseHandler): """ model = Fragment - fields = ['book', 'anchor', 'href'] + fields = ['book', 'url', 'anchor', 'href'] allowed_methods = ('GET',) categories = set(['author', 'epoch', 'kind', 'genre', 'book', 'theme']) + @piwik_track def read(self, request, tags): """ Lists all fragments with given book, tags, themes. @@ -251,32 +346,16 @@ class FragmentsHandler(BaseHandler): books/book-slug/authors/an-author/themes/a-theme/ """ - tags = read_tags(tags, allowed=self.categories) + try: + tags = read_tags(tags, allowed=self.categories) + except ValueError: + return rc.NOT_FOUND fragments = Fragment.tagged.with_all(tags).select_related('book') if fragments.exists(): return fragments else: return rc.NOT_FOUND - @classmethod - def href(cls, fragment): - """ Returns URI in the API for the fragment. """ - - return API_BASE + reverse("api_fragment", args=[fragment.book.slug, fragment.anchor]) - - @classmethod - def url(cls, fragment): - """ Returns URL on the site for the fragment. """ - - return WL_BASE + fragment.get_absolute_url() - - @classmethod - def themes(cls, fragment): - """ Returns a list of theme tags for the fragment. """ - - return fragment.tags.filter(category='theme') - - # Changes handlers @@ -308,16 +387,15 @@ class CatalogueHandler(BaseHandler): @staticmethod def book_dict(book, fields=None): - all_fields = ('url', 'title', 'description', + all_fields = ['url', 'title', 'description', 'gazeta_link', 'wiki_link', - 'xml', 'epub', 'txt', 'pdf', 'html', - 'mp3', 'ogg', 'daisy', + ] + Book.formats + BookMedia.formats + [ 'parent', 'parent_number', 'tags', 'license', 'license_description', 'source_name', 'technical_editors', 'editors', 'author', 'sort_key', - ) + ] if fields: fields = (f for f in fields if f in all_fields) else: @@ -328,7 +406,7 @@ class CatalogueHandler(BaseHandler): obj = {} for field in fields: - if field in ('xml', 'epub', 'txt', 'pdf', 'html'): + if field in Book.formats: f = getattr(book, field+'_file') if f: obj[field] = { @@ -336,7 +414,7 @@ class CatalogueHandler(BaseHandler): 'size': f.size, } - elif field in ('mp3', 'ogg', 'daisy'): + elif field in BookMedia.formats: media = [] for m in book.media.filter(type=field): media.append({ @@ -465,7 +543,7 @@ class CatalogueHandler(BaseHandler): changed_at__gte=since, changed_at__lt=until): # only serve non-empty tags - if tag.get_count(): + if tag.book_count: tag_d = cls.tag_dict(tag, fields) updated.append(tag_d) elif tag.created_at < since: @@ -488,6 +566,16 @@ class CatalogueHandler(BaseHandler): def changes(cls, request=None, since=0, until=None, book_fields=None, tag_fields=None, tag_categories=None): until = cls.until(until) + since = int(since) + + if not since: + cache = get_cache('api') + key = hash((book_fields, tag_fields, tag_categories, + tuple(sorted(request.GET.items())) + )) + value = cache.get(key) + if value is not None: + return value changes = { 'time_checked': timestamp(until) @@ -503,12 +591,17 @@ class CatalogueHandler(BaseHandler): if field == 'time_checked': continue changes.setdefault(field, {})[model] = changes_by_type[model][field] + + if not since: + cache.set(key, changes) + return changes class BookChangesHandler(CatalogueHandler): allowed_methods = ('GET',) + @piwik_track def read(self, request, since): return self.book_changes(request, since) @@ -516,6 +609,7 @@ class BookChangesHandler(CatalogueHandler): class TagChangesHandler(CatalogueHandler): allowed_methods = ('GET',) + @piwik_track def read(self, request, since): return self.tag_changes(request, since) @@ -523,5 +617,24 @@ class TagChangesHandler(CatalogueHandler): class ChangesHandler(CatalogueHandler): allowed_methods = ('GET',) + @piwik_track def read(self, request, since): return self.changes(request, since) + + +class PictureHandler(BaseHandler): + model = Picture + fields = ('slug', 'title') + allowed_methods = ('POST',) + + def create(self, request): + if not request.user.has_perm('picture.add_picture'): + return rc.FORBIDDEN + + data = json.loads(request.POST.get('data')) + form = PictureImportForm(data) + if form.is_valid(): + form.save() + return rc.CREATED + else: + return rc.NOT_FOUND