remove commas from sets' names

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

diff --git a/apps/api/handlers.py b/apps/api/handlers.py
index 8f06dea..0255c05 100644 (file)
--- a/apps/api/handlers.py
+++ b/apps/api/handlers.py
@@ -7,6 +7,7 @@ import json
 
 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 +16,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 +36,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.


@@ -85,50 +91,64 @@ class BookMediaHandler(BaseHandler):
         return MEDIA_BASE + media.file.url
 
 
         return MEDIA_BASE + media.file.url
 
 

-class BookDetailHandler(BaseHandler):
-    """ Main handler for Book objects.
+class BookDetails(object):
+    """Custom fields used for representing Books."""
+
+    @classmethod
+    def author(cls, book):
+        return ", ".join(t.name for t in book.tags.filter(category='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 media for a book. """

 
 

-    Responsible for lists of Book objects
-    and fields used for representing Books.
+        return book.children.all()

 
 

+    @classmethod
+    def media(cls, book):
+        """ Returns all media for a book. """
+
+        return book.media.all()
+
+
+
+class BookDetailHandler(BaseHandler, BookDetails):
+    """ Main handler for Book objects.
+
+    Responsible for single Book details.

     """
     allowed_methods = ['GET']
     """
     allowed_methods = ['GET']

-    fields = ['title', 'parent'] + Book.file_types + [
-        'media', 'url'] + category_singular.keys()
+    fields = ['title', 'parent', 'children'] + Book.formats + [
+        'media', 'url'] + book_tag_categories

 
     @piwik_track
 
     @piwik_track

-    def read(self, request, slug):
-        """ Returns details of a book, identified by a slug. """
-
+    def read(self, request, book):
+        """ Returns details of a book, identified by a slug and lang. """

         try:
         try:

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

 
     @piwik_track
     def read(self, request, tags, top_level=False):
 
     @piwik_track
     def read(self, request, tags, top_level=False):


@@ -140,13 +160,19 @@ 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)
                 return books if books else rc.NOT_FOUND
             else:
                 books = Book.tagged.with_all(tags)
         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()
 
         else:
             books = Book.objects.all()
 


@@ -156,18 +182,12 @@ class AnonymousBooksHandler(AnonymousBaseHandler):
             return rc.NOT_FOUND
 
     def create(self, request, tags, top_level=False):
             return rc.NOT_FOUND
 
     def create(self, request, tags, top_level=False):

-        return 'aaa'
+        return rc.FORBIDDEN

 
 

-    @classmethod
-    def media(self, book):
-        """ Returns all media for a book. """
-
-        return book.media.all()

 
 

-
-class BooksHandler(BaseHandler):
+class BooksHandler(BookDetailHandler):

     model = Book
     model = Book

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

     anonymous = AnonymousBooksHandler
 
     def create(self, request, tags, top_level=False):
     anonymous = AnonymousBooksHandler
 
     def create(self, request, tags, top_level=False):


@@ -182,6 +202,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


@@ -189,7 +210,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):


@@ -202,14 +223,30 @@ def _file_getter(format):
         else:
             return ''
     return get_file
         else:
             return ''
     return get_file

-for format in Book.file_types:
-    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. """
 
     """ 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):


@@ -226,7 +263,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


@@ -235,7 +272,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):


@@ -246,35 +283,49 @@ class TagsHandler(BaseHandler):
         except KeyError, e:
             return rc.NOT_FOUND
 
         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
 
 
             return tags
         else:
             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
     fields = ['book', 'anchor', 'text', 'url', 'themes']
 
     @piwik_track

-    def read(self, request, slug, anchor):
+    def read(self, request, book, anchor):

         """ Returns details of a fragment, identified by book slug and anchor. """
         """ Returns details of a fragment, identified by book slug and anchor. """

-

         try:
         try:

-            return Fragment.objects.get(book__slug=slug, anchor=anchor)
+            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


@@ -282,7 +333,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'])


@@ -295,32 +346,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.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
 
 
 # Changes handlers


@@ -354,8 +389,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.file_types + [
-                      'mp3', 'ogg', 'daisy',
+                      ] + Book.formats + BookMedia.formats + [

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


@@ -372,7 +406,7 @@ class CatalogueHandler(BaseHandler):
         obj = {}
         for field in fields:
 
         obj = {}
         for field in fields:
 

-            if field in Book.file_types:
+            if field in Book.formats:

                 f = getattr(book, field+'_file')
                 if f:
                     obj[field] = {
                 f = getattr(book, field+'_file')
                 if f:
                     obj[field] = {


@@ -380,7 +414,7 @@ class CatalogueHandler(BaseHandler):
                         'size': f.size,
                     }
 
                         '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({
                 media = []
                 for m in book.media.filter(type=field):
                     media.append({


@@ -509,7 +543,7 @@ class CatalogueHandler(BaseHandler):
                     changed_at__gte=since,
                     changed_at__lt=until):
             # only serve non-empty tags
                     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:
                 tag_d = cls.tag_dict(tag, fields)
                 updated.append(tag_d)
             elif tag.created_at < since:


@@ -532,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)
     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)


@@ -547,6 +591,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
 
 


@@ -572,3 +620,21 @@ class ChangesHandler(CatalogueHandler):
     @piwik_track
     def read(self, request, since):
         return self.changes(request, since)
     @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