# -*- coding: utf-8 -*-
# This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
# 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 django.utils.functional import lazy
+from django.utils.timezone import utc
+from piston.handler import AnonymousBaseHandler, BaseHandler
from piston.utils import rc
+from sorl.thumbnail import default
from api.helpers import timestamp
from api.models import Deleted
-from catalogue.models import Book, Tag, BookMedia, Fragment
+from catalogue.forms import BookImportForm
+from catalogue.models import Book, Tag, BookMedia, Fragment, Collection
+from catalogue.utils import related_tag_name
+from picture.models import Picture
+from picture.forms import PictureImportForm
+from wolnelektury.utils import tz
+from stats.utils import piwik_track
-API_BASE = WL_BASE = MEDIA_BASE = 'http://' + Site.objects.get_current().domain
+API_BASE = WL_BASE = MEDIA_BASE = lazy(
+ lambda: u'http://' + Site.objects.get_current().domain, unicode)()
category_singular = {
'themes': 'theme',
'books': 'book',
}
-category_plural={}
+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 []
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
""" Responsible for representing media in Books. """
model = BookMedia
- fields = ['name', 'type', 'url']
+ fields = ['name', 'type', 'url', 'artist', 'director']
@classmethod
def url(cls, media):
return MEDIA_BASE + media.file.url
+ @classmethod
+ def artist(cls, media):
+ return media.extra_info.get('artist_name', '')
-class BookDetailHandler(BaseHandler):
- """ Main handler for Book objects.
+ @classmethod
+ def director(cls, media):
+ return media.extra_info.get('director_name', '')
- Responsible for lists of Book objects
- and fields used for representing Books.
- """
- allowed_methods = ['GET']
- fields = ['title', 'parent',
- 'xml', 'html', 'pdf', 'epub', 'txt',
- 'media', 'url'] + category_singular.keys()
+class BookDetails(object):
+ """Custom fields used for representing Books."""
- def read(self, request, slug):
- """ Returns details of a book, identified by a slug. """
+ @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. """
+
+ return WL_BASE + book.get_absolute_url()
+
+ @classmethod
+ def children(cls, book):
+ """ Returns all children for a book. """
+
+ return book.children.all()
+
+ @classmethod
+ def media(cls, book):
+ """ Returns all media for a book. """
+ return book.media.all()
- return get_object_or_404(Book, slug=slug)
+ @classmethod
+ def cover(cls, book):
+ return MEDIA_BASE + book.cover.url if book.cover else ''
+ @classmethod
+ def cover_thumb(cls, book):
+ return MEDIA_BASE + default.backend.get_thumbnail(
+ book.cover, "139x193").url if book.cover else ''
-class BooksHandler(BaseHandler):
+
+
+class BookDetailHandler(BaseHandler, BookDetails):
""" Main handler for Book objects.
- Responsible for lists of Book objects
- and fields used for representing Books.
+ Responsible for single Book details.
+ """
+ allowed_methods = ['GET']
+ fields = ['title', 'parent', 'children'] + Book.formats + [
+ 'media', 'url', 'cover', 'cover_thumb'] + [
+ category_plural[c] for c in book_tag_categories]
+
+ @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
+
+
+class AnonymousBooksHandler(AnonymousBaseHandler, BookDetails):
+ """ Main handler for Book objects.
+ Responsible for lists of Book objects.
"""
allowed_methods = ('GET',)
model = Book
- fields = ['href', 'title']
-
- categories = set(['author', 'epoch', 'kind', 'genre'])
-
- @classmethod
- def href(cls, book):
- """ Returns an URI for a Book in the API. """
- return API_BASE + reverse("api_book", args=[book.slug])
+ fields = book_tag_categories + ['href', 'title', 'url', 'cover', 'cover_thumb']
@classmethod
- def url(cls, book):
- """ Returns Book's URL on the site. """
-
- return WL_BASE + book.get_absolute_url()
+ def genres(cls, book):
+ """ Returns all media for a book. """
+ return book.tags.filter(category='genre')
- def read(self, request, tags, top_level=False):
+ @piwik_track
+ def read(self, request, tags, top_level=False,
+ audiobooks=False, daisy=False):
""" Lists all books with given tags.
:param tags: filtering tags; should be a path of categories
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)
else:
books = Book.objects.all()
+ if top_level:
+ books = books.filter(parent=None)
+ if audiobooks:
+ books = books.filter(media__type='mp3').distinct()
+ if daisy:
+ books = books.filter(media__type='daisy').distinct()
+
if books.exists():
return books
else:
return rc.NOT_FOUND
- @classmethod
- def media(self, book):
- """ Returns all media for a book. """
+ def create(self, request, *args, **kwargs):
+ return rc.FORBIDDEN
- return book.media.all()
+
+class BooksHandler(BookDetailHandler):
+ allowed_methods = ('GET', 'POST')
+ model = Book
+ fields = book_tag_categories + ['href', 'title', 'url', 'cover', 'cover_thumb']
+ anonymous = AnonymousBooksHandler
+
+ def create(self, request, *args, **kwargs):
+ 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
+
+
+class EBooksHandler(AnonymousBooksHandler):
+ fields = ('author', 'href', 'title', 'cover') + tuple(Book.ebook_formats)
# add categorized tags fields for Book
def get_tags(cls, book):
return book.tags.filter(category=category)
return get_tags
+def _tag_getter(category):
+ @classmethod
+ def get_tag(cls, book):
+ return ", ".join(related_tag_name(t) for t in book.related_info()['tags'].get(category, []))
+ return get_tag
for plural, singular in category_singular.items():
- setattr(BooksHandler, plural, _tags_getter(singular))
+ setattr(BookDetails, plural, _tags_getter(singular))
+ setattr(BookDetails, singular, _tag_getter(singular))
# add fields for files in Book
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 CollectionDetails(object):
+ """Custom Collection fields."""
+
+ @classmethod
+ def href(cls, collection):
+ """ Returns URI in the API for the collection. """
-class TagDetailHandler(BaseHandler):
+ return API_BASE + reverse("api_collection", args=[collection.slug])
+
+ @classmethod
+ def url(cls, collection):
+ """ Returns URL on the site. """
+
+ return WL_BASE + collection.get_absolute_url()
+
+ @classmethod
+ def books(cls, collection):
+ return Book.objects.filter(collection.get_query())
+
+
+
+class CollectionDetailHandler(BaseHandler, CollectionDetails):
+ allowed_methods = ('GET',)
+ fields = ['url', 'title', 'description', 'books']
+
+ @piwik_track
+ def read(self, request, slug):
+ """ Returns details of a collection, identified by slug. """
+ try:
+ return Collection.objects.get(slug=slug)
+ except Collection.DoesNotExist:
+ return rc.NOT_FOUND
+
+
+class CollectionsHandler(BaseHandler, CollectionDetails):
+ allowed_methods = ('GET',)
+ model = Collection
+ fields = ['url', 'href', 'title']
+
+ @piwik_track
+ def read(self, request):
+ """ Returns all collections. """
+ return Collection.objects.all()
+
+
+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, 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. """
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
"""
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). """
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
"""
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.
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
"""
# set to five minutes ago, to avoid concurrency issues
if t is None:
- t = datetime.now() - timedelta(seconds=settings.API_WAIT)
+ t = datetime.utcnow().replace(tzinfo=utc) - timedelta(seconds=settings.API_WAIT)
# set to whole second in case DB supports something smaller
return t.replace(microsecond=0)
@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.keys() + [
'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:
fields = all_fields
- extra_info = book.get_extra_info_value()
+ extra_info = book.extra_info
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] = {
'size': f.size,
}
- elif field in ('mp3', 'ogg', 'daisy'):
+ elif field in BookMedia.formats:
media = []
- for m in book.media.filter(type=field):
+ for m in book.media.filter(type=field).iterator():
media.append({
'url': m.file.url,
'size': m.file.size,
obj[field] = book.get_absolute_url()
elif field == 'tags':
- obj[field] = [t.id for t in book.tags.exclude(category__in=('book', 'set'))]
+ obj[field] = [t.id for t in book.tags.exclude(category__in=('book', 'set')).iterator()]
elif field == 'author':
- obj[field] = ", ".join(t.name for t in book.tags.filter(category='author'))
+ obj[field] = ", ".join(t.name for t in book.tags.filter(category='author').iterator())
elif field == 'parent':
obj[field] = book.parent_id
@classmethod
def book_changes(cls, request=None, since=0, until=None, fields=None):
- since = datetime.fromtimestamp(int(since))
+ since = datetime.fromtimestamp(int(since), tz)
until = cls.until(until)
changes = {
last_change = since
for book in Book.objects.filter(changed_at__gte=since,
- changed_at__lt=until):
+ changed_at__lt=until).iterator():
book_d = cls.book_dict(book, fields)
updated.append(book_d)
if updated:
changes['updated'] = updated
- for book in Deleted.objects.filter(content_type=Book,
+ for book in Deleted.objects.filter(content_type=Book,
deleted_at__gte=since,
deleted_at__lt=until,
- created_at__lt=since):
+ created_at__lt=since).iterator():
deleted.append(book.id)
if deleted:
changes['deleted'] = deleted
obj[field] = tag.get_absolute_url()
elif field == 'books':
- obj[field] = [b.id for b in Book.tagged_top_level([tag])]
+ obj[field] = [b.id for b in Book.tagged_top_level([tag]).iterator()]
elif field == 'sort_key':
obj[field] = tag.sort_key
@classmethod
def tag_changes(cls, request=None, since=0, until=None, fields=None, categories=None):
- since = datetime.fromtimestamp(int(since))
+ since = datetime.fromtimestamp(int(since), tz)
until = cls.until(until)
changes = {
updated = []
deleted = []
- for tag in Tag.objects.filter(category__in=categories,
+ for tag in Tag.objects.filter(category__in=categories,
changed_at__gte=since,
- changed_at__lt=until):
+ changed_at__lt=until).iterator():
# 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:
changes['updated'] = updated
for tag in Deleted.objects.filter(category__in=categories,
- content_type=Tag,
+ content_type=Tag,
deleted_at__gte=since,
deleted_at__lt=until,
- created_at__lt=since):
+ created_at__lt=since).iterator():
deleted.append(tag.id)
if deleted:
changes['deleted'] = deleted
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)
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)
class TagChangesHandler(CatalogueHandler):
allowed_methods = ('GET',)
+ @piwik_track
def read(self, request, since):
return self.tag_changes(request, since)
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
fnp / wolnelektury.git / blobdiff