beta implementation

[wolnelektury.git] / apps / api / handlers.py

diff --git a/apps/api/handlers.py b/apps/api/handlers.py
index 270a4fd..437b3be 100644 (file)
--- a/apps/api/handlers.py
+++ b/apps/api/handlers.py
@@ -4,9 +4,11 @@
 
 from datetime import datetime, timedelta
 import json
 
 from datetime import datetime, timedelta
 import json

+from urlparse import urljoin

 
 from django.conf import settings
 from django.contrib.sites.models import Site
 
 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 piston.handler import AnonymousBaseHandler, BaseHandler
 from piston.utils import rc
 from django.core.urlresolvers import reverse
 from piston.handler import AnonymousBaseHandler, BaseHandler
 from piston.utils import rc


@@ -15,6 +17,8 @@ from api.helpers import timestamp
 from api.models import Deleted
 from catalogue.forms import BookImportForm
 from catalogue.models import Book, Tag, BookMedia, Fragment
 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
 
 
 from stats.utils import piwik_track
 


@@ -33,6 +37,9 @@ category_plural={}
 for k, v in category_singular.items():
     category_plural[v] = k
 
 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.
 
 def read_tags(tags, allowed):
     """ Reads a path of filtering tags.


@@ -76,7 +83,7 @@ class BookMediaHandler(BaseHandler):
     """ Responsible for representing media in Books. """
 
     model = BookMedia
     """ Responsible for representing media in Books. """
 
     model = BookMedia

-    fields = ['name', 'type', 'url']
+    fields = ['name', 'type', 'url', 'artist', 'director']

 
     @classmethod
     def url(cls, media):
 
     @classmethod
     def url(cls, media):


@@ -84,57 +91,82 @@ class BookMediaHandler(BaseHandler):
 
         return MEDIA_BASE + media.file.url
 
 
         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', '')
+        
+
+
+class BookDetails(object):
+    """Custom fields used for representing Books."""
+
+    @classmethod
+    def author(cls, book):
+        return ",".join(t[0] for t in book.related_info()['tags'].get('author', []))
+
+    @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()
+
+    @classmethod
+    def cover(cls, book):
+        return MEDIA_BASE + book.cover.url if book.cover else ''

 
 

-    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']
     """
     allowed_methods = ['GET']

-    fields = ['title', 'parent'] + Book.formats + [
-        'media', 'url'] + category_singular.keys()
+    fields = ['title', 'parent', 'children'] + Book.formats + [
+        'media', 'url', 'cover'] + [
+            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. """
 
     @piwik_track
     def read(self, request, book):
         """ Returns details of a book, identified by a slug and lang. """

-        kwargs = Book.split_urlid(book)
-        if not kwargs:
-            return rc.NOT_FOUND
-

         try:
         try:

-            return Book.objects.get(**kwargs)
+            return Book.objects.get(slug=book)

         except Book.DoesNotExist:
             return rc.NOT_FOUND
 
 
         except Book.DoesNotExist:
             return rc.NOT_FOUND
 
 

-class AnonymousBooksHandler(AnonymousBaseHandler):
+class AnonymousBooksHandler(AnonymousBaseHandler, BookDetails):

     """ Main handler for Book objects.
 
     """ Main handler for Book objects.
 

-    Responsible for lists of Book objects
-    and fields used for representing Books.
-
+    Responsible for lists of Book objects.

     """
     allowed_methods = ('GET',)
     model = Book
     """
     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.urlid()])
-
-    @classmethod
-    def url(cls, book):
-        """ Returns Book's URL on the site. """
-
-        return WL_BASE + book.get_absolute_url()
+    fields = ['author', 'href', 'title', 'url', 'cover']

 
     @piwik_track
 
     @piwik_track

-    def read(self, request, tags, top_level=False):
+    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
         """ Lists all books with given tags.
 
         :param tags: filtering tags; should be a path of categories


@@ -143,7 +175,11 @@ class AnonymousBooksHandler(AnonymousBaseHandler):
              it's children are aren't. By default all books matching the tags
              are returned.
         """
              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)
         if tags:
             if top_level:
                 books = Book.tagged_top_level(tags)


@@ -152,28 +188,30 @@ class AnonymousBooksHandler(AnonymousBaseHandler):
                 books = Book.tagged.with_all(tags)
         else:
             books = Book.objects.all()
                 books = Book.tagged.with_all(tags)
         else:
             books = Book.objects.all()

+            
+        if top_level:
+            books = books.filter(parent=None)
+        if audiobooks:
+            books = books.filter(media__type='mp3')
+        if daisy:
+            books = books.filter(media__type='daisy')

 
         if books.exists():
             return books
         else:
             return rc.NOT_FOUND
 
 
         if books.exists():
             return books
         else:
             return rc.NOT_FOUND
 

-    def create(self, request, tags, top_level=False):
-        return 'aaa'
-
-    @classmethod
-    def media(self, book):
-        """ Returns all media for a book. """
-
-        return book.media.all()
+    def create(self, request, *args, **kwargs):
+        return rc.FORBIDDEN

 
 
 
 

-class BooksHandler(BaseHandler):
+class BooksHandler(BookDetailHandler):
+    allowed_methods = ('GET', 'POST')

     model = Book
     model = Book

-    fields = ('slug', 'title')
+    fields = ['author', 'href', 'title', 'url']

     anonymous = AnonymousBooksHandler
 
     anonymous = AnonymousBooksHandler
 

-    def create(self, request, tags, top_level=False):
+    def create(self, request, *args, **kwargs):

         if not request.user.has_perm('catalogue.add_book'):
             return rc.FORBIDDEN
 
         if not request.user.has_perm('catalogue.add_book'):
             return rc.FORBIDDEN
 


@@ -185,6 +223,7 @@ class BooksHandler(BaseHandler):
         else:
             return rc.NOT_FOUND
 
         else:
             return rc.NOT_FOUND
 

+

 # add categorized tags fields for Book
 def _tags_getter(category):
     @classmethod
 # add categorized tags fields for Book
 def _tags_getter(category):
     @classmethod


@@ -192,7 +231,7 @@ def _tags_getter(category):
         return book.tags.filter(category=category)
     return get_tags
 for plural, singular in category_singular.items():
         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):
 
 # add fields for files in Book
 def _file_getter(format):


@@ -206,13 +245,29 @@ def _file_getter(format):
             return ''
     return get_file
 for format in Book.formats:
             return ''
     return get_file
 for format in Book.formats:

-    setattr(BooksHandler, format, _file_getter(format))
+    setattr(BookDetails, format, _file_getter(format))
+

 
 

+class TagDetails(object):
+    """Custom Tag fields."""

 
 

-class TagDetailHandler(BaseHandler):
+    @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. """
 
     """ 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):
 
     @piwik_track
     def read(self, request, category, slug):


@@ -229,7 +284,7 @@ class TagDetailHandler(BaseHandler):
             return rc.NOT_FOUND
 
 
             return rc.NOT_FOUND
 
 

-class TagsHandler(BaseHandler):
+class TagsHandler(BaseHandler, TagDetails):

     """ Main handler for Tag objects.
 
     Responsible for lists of Tag objects
     """ Main handler for Tag objects.
 
     Responsible for lists of Tag objects


@@ -238,7 +293,7 @@ class TagsHandler(BaseHandler):
     """
     allowed_methods = ('GET',)
     model = Tag
     """
     allowed_methods = ('GET',)
     model = Tag

-    fields = ['name', 'href']
+    fields = ['name', 'href', 'url']

 
     @piwik_track
     def read(self, request, category):
 
     @piwik_track
     def read(self, request, category):


@@ -256,34 +311,42 @@ class TagsHandler(BaseHandler):
             return rc.NOT_FOUND
 
 
             return rc.NOT_FOUND
 
 

+class FragmentDetails(object):
+    """Custom Fragment fields."""
+

     @classmethod
     @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. """
+
+        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):
+class FragmentDetailHandler(BaseHandler, FragmentDetails):

     fields = ['book', 'anchor', 'text', 'url', 'themes']
 
     @piwik_track
     def read(self, request, book, anchor):
         """ Returns details of a fragment, identified by book slug and anchor. """
     fields = ['book', 'anchor', 'text', 'url', 'themes']
 
     @piwik_track
     def read(self, request, book, anchor):
         """ Returns details of a fragment, identified by book slug and anchor. """

-        kwargs = Book.split_urlid(book)
-        if not kwargs:
-            return rc.NOT_FOUND
-
-        fragment_kwargs = {}
-        for field, value in kwargs.items():
-            fragment_kwargs['book__' + field] = value
-

         try:
         try:

-            return Fragment.objects.get(anchor=anchor, **fragment_kwargs)
+            return Fragment.objects.get(book__slug=book, anchor=anchor)

         except Fragment.DoesNotExist:
             return rc.NOT_FOUND
 
 
         except Fragment.DoesNotExist:
             return rc.NOT_FOUND
 
 

-class FragmentsHandler(BaseHandler):
+class FragmentsHandler(BaseHandler, FragmentDetails):

     """ Main handler for Fragments.
 
     Responsible for lists of Fragment objects
     """ Main handler for Fragments.
 
     Responsible for lists of Fragment objects


@@ -291,7 +354,7 @@ class FragmentsHandler(BaseHandler):
 
     """
     model = Fragment
 
     """
     model = Fragment

-    fields = ['book', 'anchor', 'href']
+    fields = ['book', 'url', 'anchor', 'href']

     allowed_methods = ('GET',)
 
     categories = set(['author', 'epoch', 'kind', 'genre', 'book', 'theme'])
     allowed_methods = ('GET',)
 
     categories = set(['author', 'epoch', 'kind', 'genre', 'book', 'theme'])


@@ -304,32 +367,16 @@ class FragmentsHandler(BaseHandler):
              books/book-slug/authors/an-author/themes/a-theme/
 
         """
              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
 
         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.urlid(), 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
 
 
 # Changes handlers


@@ -363,7 +410,7 @@ class CatalogueHandler(BaseHandler):
     def book_dict(book, fields=None):
         all_fields = ['url', 'title', 'description',
                       'gazeta_link', 'wiki_link',
     def book_dict(book, fields=None):
         all_fields = ['url', 'title', 'description',
                       'gazeta_link', 'wiki_link',

-                      ] + Book.formats + BookMedia.formats + [
+                      ] + Book.formats + BookMedia.formats.keys() + [

                       'parent', 'parent_number',
                       'tags',
                       'license', 'license_description', 'source_name',
                       'parent', 'parent_number',
                       'tags',
                       'license', 'license_description', 'source_name',


@@ -375,7 +422,7 @@ class CatalogueHandler(BaseHandler):
         else:
             fields = all_fields
 
         else:
             fields = all_fields
 

-        extra_info = book.get_extra_info_value()
+        extra_info = book.extra_info

 
         obj = {}
         for field in fields:
 
         obj = {}
         for field in fields:


@@ -390,7 +437,7 @@ class CatalogueHandler(BaseHandler):
 
             elif field in BookMedia.formats:
                 media = []
 
             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,
                     media.append({
                         'url': m.file.url,
                         'size': m.file.size,


@@ -402,10 +449,10 @@ class CatalogueHandler(BaseHandler):
                 obj[field] = book.get_absolute_url()
 
             elif field == 'tags':
                 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':
 
             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
 
             elif field == 'parent':
                 obj[field] = book.parent_id


@@ -442,7 +489,7 @@ class CatalogueHandler(BaseHandler):
 
         last_change = since
         for book in Book.objects.filter(changed_at__gte=since,
 
         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:
             book_d = cls.book_dict(book, fields)
             updated.append(book_d)
         if updated:


@@ -451,7 +498,7 @@ class CatalogueHandler(BaseHandler):
         for book in Deleted.objects.filter(content_type=Book, 
                     deleted_at__gte=since,
                     deleted_at__lt=until,
         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
             deleted.append(book.id)
         if deleted:
             changes['deleted'] = deleted


@@ -477,7 +524,7 @@ class CatalogueHandler(BaseHandler):
                 obj[field] = tag.get_absolute_url()
 
             elif field == 'books':
                 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
 
             elif field == 'sort_key':
                 obj[field] = tag.sort_key


@@ -515,7 +562,7 @@ class CatalogueHandler(BaseHandler):
 
         for tag in Tag.objects.filter(category__in=categories, 
                     changed_at__gte=since,
 
         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.book_count:
                 tag_d = cls.tag_dict(tag, fields)
             # only serve non-empty tags
             if tag.book_count:
                 tag_d = cls.tag_dict(tag, fields)


@@ -529,7 +576,7 @@ class CatalogueHandler(BaseHandler):
                 content_type=Tag, 
                     deleted_at__gte=since,
                     deleted_at__lt=until,
                 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
             deleted.append(tag.id)
         if deleted:
             changes['deleted'] = deleted


@@ -540,6 +587,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)
     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)
 
         changes = {
             'time_checked': timestamp(until)


@@ -555,6 +612,10 @@ class CatalogueHandler(BaseHandler):
                 if field == 'time_checked':
                     continue
                 changes.setdefault(field, {})[model] = changes_by_type[model][field]
                 if field == 'time_checked':
                     continue
                 changes.setdefault(field, {})[model] = changes_by_type[model][field]

+
+        if not since:
+            cache.set(key, changes)
+

         return changes
 
 
         return changes
 
 


@@ -588,11 +649,11 @@ class PictureHandler(BaseHandler):
     allowed_methods = ('POST',)
 
     def create(self, request):
     allowed_methods = ('POST',)
 
     def create(self, request):

-        if not request.user.has_perm('catalogue.add_book'):
+        if not request.user.has_perm('picture.add_picture'):

             return rc.FORBIDDEN
 
         data = json.loads(request.POST.get('data'))
             return rc.FORBIDDEN
 
         data = json.loads(request.POST.get('data'))

-        form = BookImportForm(data)
+        form = PictureImportForm(data)

         if form.is_valid():
             form.save()
             return rc.CREATED
         if form.is_valid():
             form.save()
             return rc.CREATED