Fix

[wolnelektury.git] / src / catalogue / models / book.py

diff --git a/src/catalogue/models/book.py b/src/catalogue/models/book.py
index 923a604..5dbda47 100644 (file)
--- a/src/catalogue/models/book.py
+++ b/src/catalogue/models/book.py
@@ -1,24 +1,21 @@
-# -*- 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 collections import OrderedDict
 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
 from collections import OrderedDict

+import json

 from datetime import date, timedelta
 from random import randint
 import os.path
 import re
 from datetime import date, timedelta
 from random import randint
 import os.path
 import re

-import urllib
+from urllib.request import urlretrieve

 from django.conf import settings
 from django.db import connection, models, transaction
 from django.conf import settings
 from django.db import connection, models, transaction

-from django.db.models import permalink

 import django.dispatch
 from django.contrib.contenttypes.fields import GenericRelation
 import django.dispatch
 from django.contrib.contenttypes.fields import GenericRelation

-from django.core.urlresolvers import reverse
+from django.urls import reverse

 from django.utils.translation import ugettext_lazy as _, get_language
 from django.utils.deconstruct import deconstructible
 from django.utils.translation import ugettext_lazy as _, get_language
 from django.utils.deconstruct import deconstructible

-import jsonfield

 from fnpdjango.storage import BofhFileSystemStorage
 from fnpdjango.storage import BofhFileSystemStorage

-from ssify import flush_ssi_includes

 
 from librarian.cover import WLCover
 from librarian.html import transform_abstrakt
 
 from librarian.cover import WLCover
 from librarian.html import transform_abstrakt


@@ -26,11 +23,11 @@ from newtagging import managers
 from catalogue import constants
 from catalogue.fields import EbookField
 from catalogue.models import Tag, Fragment, BookMedia
 from catalogue import constants
 from catalogue.fields import EbookField
 from catalogue.models import Tag, Fragment, BookMedia

-from catalogue.utils import create_zip, gallery_url, gallery_path, split_tags
+from catalogue.utils import create_zip, gallery_url, gallery_path, split_tags, get_random_hash

 from catalogue.models.tag import prefetched_relations
 from catalogue import app_settings
 from catalogue import tasks
 from catalogue.models.tag import prefetched_relations
 from catalogue import app_settings
 from catalogue import tasks

-from wolnelektury.utils import makedirs
+from wolnelektury.utils import makedirs, cached_render, clear_cached_renders

 
 bofh_storage = BofhFileSystemStorage()
 
 
 bofh_storage = BofhFileSystemStorage()
 


@@ -59,7 +56,7 @@ class Book(models.Model):
     title = models.CharField(_('title'), max_length=32767)
     sort_key = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False)
     sort_key_author = models.CharField(
     title = models.CharField(_('title'), max_length=32767)
     sort_key = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False)
     sort_key_author = models.CharField(

-        _('sort key by author'), max_length=120, db_index=True, editable=False, default=u'')
+        _('sort key by author'), max_length=120, db_index=True, editable=False, default='')

     slug = models.SlugField(_('slug'), max_length=120, db_index=True, unique=True)
     common_slug = models.SlugField(_('slug'), max_length=120, db_index=True)
     language = models.CharField(_('language code'), max_length=3, db_index=True, default=app_settings.DEFAULT_LANGUAGE)
     slug = models.SlugField(_('slug'), max_length=120, db_index=True, unique=True)
     common_slug = models.SlugField(_('slug'), max_length=120, db_index=True)
     language = models.CharField(_('language code'), max_length=3, db_index=True, default=app_settings.DEFAULT_LANGUAGE)


@@ -68,7 +65,7 @@ class Book(models.Model):
     created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
     changed_at = models.DateTimeField(_('change date'), auto_now=True, db_index=True)
     parent_number = models.IntegerField(_('parent number'), default=0)
     created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
     changed_at = models.DateTimeField(_('change date'), auto_now=True, db_index=True)
     parent_number = models.IntegerField(_('parent number'), default=0)

-    extra_info = jsonfield.JSONField(_('extra information'), default={})
+    extra_info = models.TextField(_('extra information'), default='{}')

     gazeta_link = models.CharField(blank=True, max_length=240)
     wiki_link = models.CharField(blank=True, max_length=240)
     print_on_demand = models.BooleanField(_('print on demand'), default=False)
     gazeta_link = models.CharField(blank=True, max_length=240)
     wiki_link = models.CharField(blank=True, max_length=240)
     print_on_demand = models.BooleanField(_('print on demand'), default=False)


@@ -76,6 +73,7 @@ class Book(models.Model):
     audio_length = models.CharField(_('audio length'), blank=True, max_length=8)
     preview = models.BooleanField(_('preview'), default=False)
     preview_until = models.DateField(_('preview until'), blank=True, null=True)
     audio_length = models.CharField(_('audio length'), blank=True, max_length=8)
     preview = models.BooleanField(_('preview'), default=False)
     preview_until = models.DateField(_('preview until'), blank=True, null=True)

+    preview_key = models.CharField(max_length=32, blank=True, null=True)

 
     # files generated during publication
     cover = EbookField(
 
     # files generated during publication
     cover = EbookField(


@@ -102,7 +100,7 @@ class Book(models.Model):
     ebook_formats = constants.EBOOK_FORMATS
     formats = ebook_formats + ['html', 'xml']
 
     ebook_formats = constants.EBOOK_FORMATS
     formats = ebook_formats + ['html', 'xml']
 

-    parent = models.ForeignKey('self', blank=True, null=True, related_name='children')
+    parent = models.ForeignKey('self', models.CASCADE, blank=True, null=True, related_name='children')

     ancestor = models.ManyToManyField('self', blank=True, editable=False, related_name='descendant', symmetrical=False)
 
     cached_author = models.CharField(blank=True, max_length=240, db_index=True)
     ancestor = models.ManyToManyField('self', blank=True, editable=False, related_name='descendant', symmetrical=False)
 
     cached_author = models.CharField(blank=True, max_length=240, db_index=True)


@@ -127,9 +125,12 @@ class Book(models.Model):
         verbose_name_plural = _('books')
         app_label = 'catalogue'
 
         verbose_name_plural = _('books')
         app_label = 'catalogue'
 

-    def __unicode__(self):
+    def __str__(self):

         return self.title
 
         return self.title
 

+    def get_extra_info_json(self):
+        return json.loads(self.extra_info or '{}')
+

     def get_initial(self):
         try:
             return re.search(r'\w', self.title, re.U).group(0)
     def get_initial(self):
         try:
             return re.search(r'\w', self.title, re.U).group(0)


@@ -171,7 +172,7 @@ class Book(models.Model):
         return self.tag_unicode('genre')
 
     def translator(self):
         return self.tag_unicode('genre')
 
     def translator(self):

-        translators = self.extra_info.get('translators')
+        translators = self.get_extra_info_json().get('translators')

         if not translators:
             return None
         if len(translators) > 3:
         if not translators:
             return None
         if len(translators) > 3:


@@ -179,33 +180,35 @@ class Book(models.Model):
             others = ' i inni'
         else:
             others = ''
             others = ' i inni'
         else:
             others = ''

-        return ', '.join(u'\xa0'.join(reversed(translator.split(', ', 1))) for translator in translators) + others
+        return ', '.join('\xa0'.join(reversed(translator.split(', ', 1))) for translator in translators) + others

 
     def cover_source(self):
 
     def cover_source(self):

-        return self.extra_info.get('cover_source', self.parent.cover_source() if self.parent else '')
+        return self.get_extra_info_json().get('cover_source', self.parent.cover_source() if self.parent else '')

 
     def save(self, force_insert=False, force_update=False, **kwargs):
         from sortify import sortify
 
         self.sort_key = sortify(self.title)[:120]
 
     def save(self, force_insert=False, force_update=False, **kwargs):
         from sortify import sortify
 
         self.sort_key = sortify(self.title)[:120]

-        self.title = unicode(self.title)  # ???
+        self.title = str(self.title)  # ???

 
         try:
             author = self.authors().first().sort_key
         except AttributeError:
 
         try:
             author = self.authors().first().sort_key
         except AttributeError:

-            author = u''
+            author = ''

         self.sort_key_author = author
 
         self.cached_author = self.tag_unicode('author')
         self.sort_key_author = author
 
         self.cached_author = self.tag_unicode('author')

-        self.has_audience = 'audience' in self.extra_info
+        self.has_audience = 'audience' in self.get_extra_info_json()
+
+        if self.preview and not self.preview_key:
+            self.preview_key = get_random_hash(self.slug)[:32]

 
         ret = super(Book, self).save(force_insert, force_update, **kwargs)
 
         return ret
 
 
         ret = super(Book, self).save(force_insert, force_update, **kwargs)
 
         return ret
 

-    @permalink

     def get_absolute_url(self):
     def get_absolute_url(self):

-        return 'book_detail', [self.slug]
+        return reverse('book_detail', args=[self.slug])

 
     def gallery_path(self):
         return gallery_path(self.slug)
 
     def gallery_path(self):
         return gallery_path(self.slug)


@@ -234,6 +237,12 @@ class Book(models.Model):
 
     @staticmethod
     def format_audio_length(seconds):
 
     @staticmethod
     def format_audio_length(seconds):

+        """
+        >>> Book.format_audio_length(1)
+        '0:01'
+        >>> Book.format_audio_length(3661)
+        '1:01:01'
+        """

         if seconds < 60*60:
             minutes = seconds // 60
             seconds = seconds % 60
         if seconds < 60*60:
             minutes = seconds // 60
             seconds = seconds % 60


@@ -284,7 +293,7 @@ class Book(models.Model):
         media = self.get_media(format_)
         if media:
             if self.preview:
         media = self.get_media(format_)
         if media:
             if self.preview:

-                return reverse('embargo_link', kwargs={'slug': self.slug, 'format_': format_})
+                return reverse('embargo_link', kwargs={'key': self.preview_key, 'slug': self.slug, 'format_': format_})

             else:
                 return media.url
         else:
             else:
                 return media.url
         else:


@@ -340,11 +349,11 @@ class Book(models.Model):
         projects = set()
         for mp3 in self.media.filter(type='mp3').iterator():
             # ogg files are always from the same project
         projects = set()
         for mp3 in self.media.filter(type='mp3').iterator():
             # ogg files are always from the same project

-            meta = mp3.extra_info
+            meta = mp3.get_extra_info_json()

             project = meta.get('project')
             if not project:
                 # temporary fallback
             project = meta.get('project')
             if not project:
                 # temporary fallback

-                project = u'CzytamySłuchając'
+                project = 'CzytamySłuchając'

 
             projects.add((project, meta.get('funded_by', '')))
 
 
             projects.add((project, meta.get('funded_by', '')))
 


@@ -377,7 +386,7 @@ class Book(models.Model):
     def zip_format(format_):
         def pretty_file_name(book):
             return "%s/%s.%s" % (
     def zip_format(format_):
         def pretty_file_name(book):
             return "%s/%s.%s" % (

-                book.extra_info['author'],
+                book.get_extra_info_json()['author'],

                 book.slug,
                 format_)
 
                 book.slug,
                 format_)
 


@@ -401,7 +410,7 @@ class Book(models.Model):
                 index.index_tags()
             if commit:
                 index.index.commit()
                 index.index_tags()
             if commit:
                 index.index.commit()

-        except Exception, e:
+        except Exception as e:

             index.index.rollback()
             raise e
 
             index.index.rollback()
             raise e
 


@@ -419,7 +428,7 @@ class Book(models.Model):
             for ilustr in ilustr_elements:
                 ilustr_src = ilustr.get('src')
                 ilustr_path = os.path.join(gallery_path, ilustr_src)
             for ilustr in ilustr_elements:
                 ilustr_src = ilustr.get('src')
                 ilustr_path = os.path.join(gallery_path, ilustr_src)

-                urllib.urlretrieve('%s/%s' % (remote_gallery_url, ilustr_src), ilustr_path)
+                urlretrieve('%s/%s' % (remote_gallery_url, ilustr_src), ilustr_path)

 
     def load_abstract(self):
         abstract = self.wldocument(parse_dublincore=False).edoc.getroot().find('.//abstrakt')
 
     def load_abstract(self):
         abstract = self.wldocument(parse_dublincore=False).edoc.getroot().find('.//abstrakt')


@@ -490,7 +499,7 @@ class Book(models.Model):
             book.common_slug = book_info.variant_of.slug
         else:
             book.common_slug = book.slug
             book.common_slug = book_info.variant_of.slug
         else:
             book.common_slug = book.slug

-        book.extra_info = book_info.to_dict()
+        book.extra_info = json.dumps(book_info.to_dict())

         book.load_abstract()
         book.save()
 
         book.load_abstract()
         book.save()
 


@@ -502,6 +511,7 @@ class Book(models.Model):
                 tag.save()
 
         book.tags = set(meta_tags + book_shelves)
                 tag.save()
 
         book.tags = set(meta_tags + book_shelves)

+        book.save()  # update sort_key_author

 
         cover_changed = old_cover != book.cover_info()
         obsolete_children = set(b for b in book.children.all()
 
         cover_changed = old_cover != book.cover_info()
         obsolete_children = set(b for b in book.children.all()


@@ -553,7 +563,6 @@ class Book(models.Model):
         for child in notify_cover_changed:
             child.parent_cover_changed()
 
         for child in notify_cover_changed:
             child.parent_cover_changed()
 

-        book.save()  # update sort_key_author

         book.update_popularity()
         cls.published.send(sender=cls, instance=book)
         return book
         book.update_popularity()
         cls.published.send(sender=cls, instance=book)
         return book


@@ -591,23 +600,9 @@ class Book(models.Model):
                     b.ancestor.add(parent)
                     parent = parent.parent
 
                     b.ancestor.add(parent)
                     parent = parent.parent
 

-    def flush_includes(self, languages=True):
-        if not languages:
-            return
-        if languages is True:
-            languages = [lc for (lc, _ln) in settings.LANGUAGES]
-        flush_ssi_includes([
-            template % (self.pk, lang)
-            for template in [
-                '/katalog/b/%d/mini.%s.html',
-                '/katalog/b/%d/mini_nolink.%s.html',
-                '/katalog/b/%d/short.%s.html',
-                '/katalog/b/%d/wide.%s.html',
-                '/api/include/book/%d.%s.json',
-                '/api/include/book/%d.%s.xml',
-                ]
-            for lang in languages
-            ])
+    def clear_cache(self):
+        clear_cached_renders(self.mini_box)
+        clear_cached_renders(self.mini_box_nolink)

 
     def cover_info(self, inherit=True):
         """Returns a dictionary to serve as fallback for BookInfo.
 
     def cover_info(self, inherit=True):
         """Returns a dictionary to serve as fallback for BookInfo.


@@ -617,7 +612,7 @@ class Book(models.Model):
         need = False
         info = {}
         for field in ('cover_url', 'cover_by', 'cover_source'):
         need = False
         info = {}
         for field in ('cover_url', 'cover_by', 'cover_source'):

-            val = self.extra_info.get(field)
+            val = self.get_extra_info_json().get(field)

             if val:
                 info[field] = val
             else:
             if val:
                 info[field] = val
             else:


@@ -671,8 +666,8 @@ class Book(models.Model):
         return ', '.join(names)
 
     def publisher(self):
         return ', '.join(names)
 
     def publisher(self):

-        publisher = self.extra_info['publisher']
-        if isinstance(publisher, basestring):
+        publisher = self.get_extra_info_json()['publisher']
+        if isinstance(publisher, str):

             return publisher
         elif isinstance(publisher, list):
             return ', '.join(publisher)
             return publisher
         elif isinstance(publisher, list):
             return ', '.join(publisher)


@@ -697,7 +692,7 @@ class Book(models.Model):
         """
 
         books_by_parent = {}
         """
 
         books_by_parent = {}

-        books = cls.objects.order_by('parent_number', 'sort_key').only('title', 'parent', 'slug')
+        books = cls.objects.order_by('parent_number', 'sort_key').only('title', 'parent', 'slug', 'extra_info')

         if book_filter:
             books = books.filter(book_filter).distinct()
 
         if book_filter:
             books = books.filter(book_filter).distinct()
 


@@ -727,23 +722,23 @@ class Book(models.Model):
         return books_by_author, orphans, books_by_parent
 
     _audiences_pl = {
         return books_by_author, orphans, books_by_parent
 
     _audiences_pl = {

-        "SP": (1, u"szkoła podstawowa"),
-        "SP1": (1, u"szkoła podstawowa"),
-        "SP2": (1, u"szkoła podstawowa"),
-        "SP3": (1, u"szkoła podstawowa"),
-        "P": (1, u"szkoła podstawowa"),
-        "G": (2, u"gimnazjum"),
-        "L": (3, u"liceum"),
-        "LP": (3, u"liceum"),
+        "SP": (1, "szkoła podstawowa"),
+        "SP1": (1, "szkoła podstawowa"),
+        "SP2": (1, "szkoła podstawowa"),
+        "SP3": (1, "szkoła podstawowa"),
+        "P": (1, "szkoła podstawowa"),
+        "G": (2, "gimnazjum"),
+        "L": (3, "liceum"),
+        "LP": (3, "liceum"),

     }
 
     def audiences_pl(self):
     }
 
     def audiences_pl(self):

-        audiences = self.extra_info.get('audiences', [])
+        audiences = self.get_extra_info_json().get('audiences', [])

         audiences = sorted(set([self._audiences_pl.get(a, (99, a)) for a in audiences]))
         return [a[1] for a in audiences]
 
     def stage_note(self):
         audiences = sorted(set([self._audiences_pl.get(a, (99, a)) for a in audiences]))
         return [a[1] for a in audiences]
 
     def stage_note(self):

-        stage = self.extra_info.get('stage')
+        stage = self.get_extra_info_json().get('stage')

         if stage and stage < '0.4':
             return (_('This work needs modernisation'),
                     reverse('infopage', args=['wymagajace-uwspolczesnienia']))
         if stage and stage < '0.4':
             return (_('This work needs modernisation'),
                     reverse('infopage', args=['wymagajace-uwspolczesnienia']))


@@ -800,8 +795,20 @@ class Book(models.Model):
         return self.SORT_KEY_SEP.join((self.sort_key_author, self.sort_key, str(self.id)))
 
     def cover_color(self):
         return self.SORT_KEY_SEP.join((self.sort_key_author, self.sort_key, str(self.id)))
 
     def cover_color(self):

-        return WLCover.epoch_colors.get(self.extra_info.get('epoch'), '#000000')
+        return WLCover.epoch_colors.get(self.get_extra_info_json().get('epoch'), '#000000')
+
+    @cached_render('catalogue/book_mini_box.html')
+    def mini_box(self):
+        return {
+            'book': self
+        }

 
 

+    @cached_render('catalogue/book_mini_box.html')
+    def mini_box_nolink(self):
+        return {
+            'book': self,
+            'no_link': True,
+        }

 
 def add_file_fields():
     for format_ in Book.formats:
 
 def add_file_fields():
     for format_ in Book.formats:


@@ -825,5 +832,5 @@ add_file_fields()
 
 
 class BookPopularity(models.Model):
 
 
 class BookPopularity(models.Model):

-    book = models.OneToOneField(Book, related_name='popularity')
+    book = models.OneToOneField(Book, models.CASCADE, related_name='popularity')

     count = models.IntegerField(default=0, db_index=True)
     count = models.IntegerField(default=0, db_index=True)