Make verse numbers, footnote anchors, themes, dynamic inserts unselectable. Fixes...

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

diff --git a/src/catalogue/models/book.py b/src/catalogue/models/book.py
index ecf6d96..534f00b 100644 (file)
--- a/src/catalogue/models/book.py
+++ b/src/catalogue/models/book.py
@@ -2,6 +2,7 @@
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
 from collections import OrderedDict
 # 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
 from datetime import date, timedelta
 from random import randint
 import os.path


@@ -14,9 +15,7 @@ from django.contrib.contenttypes.fields import GenericRelation
 from django.urls import reverse
 from django.utils.translation import ugettext_lazy as _, get_language
 from django.utils.deconstruct import deconstructible
 from django.urls import reverse
 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


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


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


@@ -75,6 +74,7 @@ class Book(models.Model):
     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)
     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)

+    findable = models.BooleanField(_('findable'), default=True, db_index=True)

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


@@ -129,6 +129,9 @@ class Book(models.Model):
     def __str__(self):
         return self.title
 
     def __str__(self):
         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)


@@ -170,7 +173,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:


@@ -178,10 +181,10 @@ 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
 
     def save(self, force_insert=False, force_update=False, **kwargs):
         from sortify import sortify


@@ -192,11 +195,11 @@ class Book(models.Model):
         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]
 
         if self.preview and not self.preview_key:
             self.preview_key = get_random_hash(self.slug)[:32]


@@ -235,6 +238,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


@@ -341,11 +350,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', '')))
 


@@ -378,12 +387,12 @@ 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_)
 
         field_name = "%s_file" % format_
                 book.slug,
                 format_)
 
         field_name = "%s_file" % format_

-        books = Book.objects.filter(parent=None).exclude(**{field_name: ""}).exclude(preview=True)
+        books = Book.objects.filter(parent=None).exclude(**{field_name: ""}).exclude(preview=True).exclude(findable=False)

         paths = [(pretty_file_name(b), getattr(b, field_name).path) for b in books.iterator()]
         return create_zip(paths, app_settings.FORMAT_ZIPS[format_])
 
         paths = [(pretty_file_name(b), getattr(b, field_name).path) for b in books.iterator()]
         return create_zip(paths, app_settings.FORMAT_ZIPS[format_])
 


@@ -393,6 +402,8 @@ class Book(models.Model):
         return create_zip(paths, "%s_%s" % (self.slug, format_))
 
     def search_index(self, book_info=None, index=None, index_tags=True, commit=True):
         return create_zip(paths, "%s_%s" % (self.slug, format_))
 
     def search_index(self, book_info=None, index=None, index_tags=True, commit=True):

+        if not self.findable:
+            return

         if index is None:
             from search.index import Index
             index = Index()
         if index is None:
             from search.index import Index
             index = Index()


@@ -447,7 +458,7 @@ class Book(models.Model):
 
     @classmethod
     def from_text_and_meta(cls, raw_file, book_info, overwrite=False, dont_build=None, search_index=True,
 
     @classmethod
     def from_text_and_meta(cls, raw_file, book_info, overwrite=False, dont_build=None, search_index=True,

-                           search_index_tags=True, remote_gallery_url=None, days=0):
+                           search_index_tags=True, remote_gallery_url=None, days=0, findable=True):

         if dont_build is None:
             dont_build = set()
         dont_build = set.union(set(dont_build), set(app_settings.DONT_BUILD))
         if dont_build is None:
             dont_build = set()
         dont_build = set.union(set(dont_build), set(app_settings.DONT_BUILD))


@@ -485,13 +496,14 @@ class Book(models.Model):
         if book.preview:
             book.xml_file.set_readable(False)
 
         if book.preview:
             book.xml_file.set_readable(False)
 

+        book.findable = findable

         book.language = book_info.language
         book.title = book_info.title
         if book_info.variant_of:
             book.common_slug = book_info.variant_of.slug
         else:
             book.common_slug = book.slug
         book.language = book_info.language
         book.title = book_info.title
         if book_info.variant_of:
             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()
 


@@ -503,6 +515,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()


@@ -548,13 +561,12 @@ class Book(models.Model):
             if format_ not in dont_build:
                 getattr(book, '%s_file' % format_).build_delay()
 
             if format_ not in dont_build:
                 getattr(book, '%s_file' % format_).build_delay()
 

-        if not settings.NO_SEARCH_INDEX and search_index:
+        if not settings.NO_SEARCH_INDEX and search_index and findable:

             tasks.index_book.delay(book.id, book_info=book_info, index_tags=search_index_tags)
 
         for child in notify_cover_changed:
             child.parent_cover_changed()
 
             tasks.index_book.delay(book.id, book_info=book_info, index_tags=search_index_tags)
 
         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


@@ -592,23 +604,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):
+    def clear_cache(self):

         clear_cached_renders(self.mini_box)
         clear_cached_renders(self.mini_box_nolink)
         clear_cached_renders(self.mini_box)
         clear_cached_renders(self.mini_box_nolink)

-        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/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 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.


@@ -618,7 +616,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:


@@ -650,7 +648,7 @@ class Book(models.Model):
 
     def other_versions(self):
         """Find other versions (i.e. in other languages) of the book."""
 
     def other_versions(self):
         """Find other versions (i.e. in other languages) of the book."""

-        return type(self).objects.filter(common_slug=self.common_slug).exclude(pk=self.pk)
+        return type(self).objects.filter(common_slug=self.common_slug, findable=True).exclude(pk=self.pk)

 
     def parents(self):
         books = []
 
     def parents(self):
         books = []


@@ -672,7 +670,7 @@ class Book(models.Model):
         return ', '.join(names)
 
     def publisher(self):
         return ', '.join(names)
 
     def publisher(self):

-        publisher = self.extra_info['publisher']
+        publisher = self.get_extra_info_json()['publisher']

         if isinstance(publisher, str):
             return publisher
         elif isinstance(publisher, list):
         if isinstance(publisher, str):
             return publisher
         elif isinstance(publisher, list):


@@ -687,7 +685,7 @@ class Book(models.Model):
 
         """
         objects = cls.tagged.with_all(tags)
 
         """
         objects = cls.tagged.with_all(tags)

-        return objects.exclude(ancestor__in=objects)
+        return objects.filter(findable=True).exclude(ancestor__in=objects)

 
     @classmethod
     def book_list(cls, book_filter=None):
 
     @classmethod
     def book_list(cls, book_filter=None):


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

-        books = cls.objects.order_by('parent_number', 'sort_key').only('title', 'parent', 'slug', 'extra_info')
+        books = cls.objects.filter(findable=True).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()
 


@@ -728,23 +726,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']))


@@ -801,7 +799,7 @@ 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):
 
     @cached_render('catalogue/book_mini_box.html')
     def mini_box(self):