added NO_BUILD_EPUB option, fixed child republish

[wolnelektury.git] / apps / catalogue / models.py

diff --git a/apps/catalogue/models.py b/apps/catalogue/models.py
index 8c83faa..28db00d 100644 (file)
--- a/apps/catalogue/models.py
+++ b/apps/catalogue/models.py
@@ -13,11 +13,13 @@ from django.utils.translation import get_language
 from django.core.urlresolvers import reverse
 from datetime import datetime
 
 from django.core.urlresolvers import reverse
 from datetime import datetime
 

+from django.conf import settings
+

 from newtagging.models import TagBase, tags_updated
 from newtagging import managers
 from catalogue.fields import JSONField
 
 from newtagging.models import TagBase, tags_updated
 from newtagging import managers
 from catalogue.fields import JSONField
 

-from librarian import dcparser, html, epub
+from librarian import dcparser, html, epub, NoDublinCore

 from mutagen import id3
 
 
 from mutagen import id3
 
 


@@ -44,7 +46,7 @@ class TagSubcategoryManager(models.Manager):
 class Tag(TagBase):
     name = models.CharField(_('name'), max_length=50, db_index=True)
     slug = models.SlugField(_('slug'), max_length=120, db_index=True)
 class Tag(TagBase):
     name = models.CharField(_('name'), max_length=50, db_index=True)
     slug = models.SlugField(_('slug'), max_length=120, db_index=True)

-    sort_key = models.SlugField(_('sort key'), max_length=120, db_index=True)
+    sort_key = models.CharField(_('sort key'), max_length=120, db_index=True)

     category = models.CharField(_('category'), max_length=50, blank=False, null=False,
         db_index=True, choices=TAG_CATEGORIES)
     description = models.TextField(_('description'), blank=True)
     category = models.CharField(_('category'), max_length=50, blank=False, null=False,
         db_index=True, choices=TAG_CATEGORIES)
     description = models.TextField(_('description'), blank=True)


@@ -169,7 +171,7 @@ class Book(models.Model):
     title = models.CharField(_('title'), max_length=120)
     slug = models.SlugField(_('slug'), max_length=120, unique=True, db_index=True)
     description = models.TextField(_('description'), blank=True)
     title = models.CharField(_('title'), max_length=120)
     slug = models.SlugField(_('slug'), max_length=120, unique=True, db_index=True)
     description = models.TextField(_('description'), blank=True)

-    created_at = models.DateTimeField(_('creation date'), auto_now=True)
+    created_at = models.DateTimeField(_('creation date'), auto_now_add=True)

     _short_html = models.TextField(_('short HTML'), editable=False)
     parent_number = models.IntegerField(_('parent number'), default=0)
     extra_info = JSONField(_('extra information'))
     _short_html = models.TextField(_('short HTML'), editable=False)
     parent_number = models.IntegerField(_('parent number'), default=0)
     extra_info = JSONField(_('extra information'))


@@ -186,6 +188,7 @@ class Book(models.Model):
     txt_file = models.FileField(_('TXT file'), upload_to=book_upload_path('txt'), blank=True)
     mp3_file = models.FileField(_('MP3 file'), upload_to=book_upload_path('mp3'), blank=True)
     ogg_file = models.FileField(_('OGG file'), upload_to=book_upload_path('ogg'), blank=True)
     txt_file = models.FileField(_('TXT file'), upload_to=book_upload_path('txt'), blank=True)
     mp3_file = models.FileField(_('MP3 file'), upload_to=book_upload_path('mp3'), blank=True)
     ogg_file = models.FileField(_('OGG file'), upload_to=book_upload_path('ogg'), blank=True)

+    daisy_file = models.FileField(_('DAISY file'), upload_to=book_upload_path('daisy.zip'), blank=True)

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


@@ -207,7 +210,7 @@ class Book(models.Model):
     def __unicode__(self):
         return self.title
 
     def __unicode__(self):
         return self.title
 

-    def save(self, force_insert=False, force_update=False, reset_short_html=True, refresh_mp3=True):
+    def save(self, force_insert=False, force_update=False, reset_short_html=True, refresh_mp3=True, **kwargs):

         if reset_short_html:
             # Reset _short_html during save
             update = {}
         if reset_short_html:
             # Reset _short_html during save
             update = {}


@@ -244,7 +247,7 @@ class Book(models.Model):
         book_tag, created = Tag.objects.get_or_create(slug=slug, category='book')
         if created:
             book_tag.name = self.title[:50]
         book_tag, created = Tag.objects.get_or_create(slug=slug, category='book')
         if created:
             book_tag.name = self.title[:50]

-            book_tag.sort_key = slug
+            book_tag.sort_key = self.title.lower()

             book_tag.save()
         return book_tag
 
             book_tag.save()
         return book_tag
 


@@ -263,8 +266,8 @@ class Book(models.Model):
                 formats.append(u'<a href="%s">%s</a>' % (reverse('book_text', kwargs={'slug': self.slug}), _('Read online')))
             if self.pdf_file:
                 formats.append(u'<a href="%s">PDF</a>' % self.pdf_file.url)
                 formats.append(u'<a href="%s">%s</a>' % (reverse('book_text', kwargs={'slug': self.slug}), _('Read online')))
             if self.pdf_file:
                 formats.append(u'<a href="%s">PDF</a>' % self.pdf_file.url)

-            if self.epub_file:
-                formats.append(u'<a href="%s">EPUB</a>' % self.epub_file.url)
+            if self.root_ancestor.epub_file:
+                formats.append(u'<a href="%s">EPUB</a>' % self.root_ancestor.epub_file.url)

             if self.odt_file:
                 formats.append(u'<a href="%s">ODT</a>' % self.odt_file.url)
             if self.txt_file:
             if self.odt_file:
                 formats.append(u'<a href="%s">ODT</a>' % self.odt_file.url)
             if self.txt_file:


@@ -273,6 +276,8 @@ class Book(models.Model):
                 formats.append(u'<a href="%s">MP3</a>' % self.mp3_file.url)
             if self.ogg_file:
                 formats.append(u'<a href="%s">OGG</a>' % self.ogg_file.url)
                 formats.append(u'<a href="%s">MP3</a>' % self.mp3_file.url)
             if self.ogg_file:
                 formats.append(u'<a href="%s">OGG</a>' % self.ogg_file.url)

+            if self.daisy_file:
+                formats.append(u'<a href="%s">DAISY</a>' % self.daisy_file.url)

 
             formats = [mark_safe(format) for format in formats]
 
 
             formats = [mark_safe(format) for format in formats]
 


@@ -282,6 +287,18 @@ class Book(models.Model):
             return mark_safe(getattr(self, key))
 
 
             return mark_safe(getattr(self, key))
 
 

+    @property
+    def root_ancestor(self):
+        """ returns the oldest ancestor """
+
+        if not hasattr(self, '_root_ancestor'):
+            book = self
+            while book.parent:
+                book = book.parent
+            self._root_ancestor = book
+        return self._root_ancestor
+
+

     def get_mp3_info(self):
         """Retrieves artist and director names from audio ID3 tags."""
         audio = id3.ID3(self.mp3_file.path)
     def get_mp3_info(self):
         """Retrieves artist and director names from audio ID3 tags."""
         audio = id3.ID3(self.mp3_file.path)


@@ -314,6 +331,52 @@ class Book(models.Model):
     has_html_file.short_description = 'HTML'
     has_html_file.boolean = True
 
     has_html_file.short_description = 'HTML'
     has_html_file.boolean = True
 

+    def build_epub(self, remove_descendants=True):
+        """ (Re)builds the epub file.
+            If book has a parent, does nothing.
+            Unless remove_descendants is False, descendants' epubs are removed.
+        """
+    
+        from StringIO import StringIO
+        from hashlib import sha1
+        from django.core.files.base import ContentFile
+        from librarian import DocProvider
+
+        class BookImportDocProvider(DocProvider):
+            """ used for joined EPUBs """
+
+            def __init__(self, book):
+                self.book = book
+
+            def by_slug(self, slug):
+                if slug == self.book.slug:
+                    return self.book.xml_file
+                else:
+                    return Book.objects.get(slug=slug).xml_file
+
+        if self.parent:
+            # don't need an epub
+            return
+
+        epub_file = StringIO()
+        try:
+            epub.transform(BookImportDocProvider(self), self.slug, epub_file)
+            self.epub_file.save('%s.epub' % self.slug, ContentFile(epub_file.getvalue()), save=False)
+            self.save(refresh_mp3=False)
+            FileRecord(slug=self.slug, type='epub', sha1=sha1(epub_file.getvalue()).hexdigest()).save()
+        except NoDublinCore:
+            pass
+
+        book_descendants = list(self.children.all())
+        while len(book_descendants) > 0:
+            child_book = book_descendants.pop(0)
+            if remove_descendants and child_book.has_epub_file():
+                child_book.epub_file.delete()
+            # save anyway, to refresh short_html
+            child_book.save(refresh_mp3=False)
+            book_descendants += list(child_book.children.all())
+
+

     @classmethod
     def from_xml_file(cls, xml_file, overwrite=False):
         # use librarian to parse meta-data
     @classmethod
     def from_xml_file(cls, xml_file, overwrite=False):
         # use librarian to parse meta-data


@@ -332,10 +395,18 @@ class Book(models.Model):
         from tempfile import NamedTemporaryFile
         from slughifi import slughifi
         from markupstring import MarkupString
         from tempfile import NamedTemporaryFile
         from slughifi import slughifi
         from markupstring import MarkupString

-        from hashlib import sha1
-        from django.core.files.base import ContentFile

         from django.core.files.storage import default_storage
         from django.core.files.storage import default_storage

-        from StringIO import StringIO
+
+        # check for parts before we do anything
+        children = []
+        if hasattr(book_info, 'parts'):
+            for part_url in book_info.parts:
+                base, slug = part_url.rsplit('/', 1)
+                try:
+                    children.append(Book.objects.get(slug=slug))
+                except Book.DoesNotExist, e:
+                    raise Book.DoesNotExist(_('Book with slug = "%s" does not exist.') % slug)
+

 
         # Read book metadata
         book_base, book_slug = book_info.url.rsplit('/', 1)
 
         # Read book metadata
         book_base, book_slug = book_info.url.rsplit('/', 1)


@@ -369,7 +440,7 @@ class Book(models.Model):
                 tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category)
                 if created:
                     tag.name = tag_name
                 tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category)
                 if created:
                     tag.name = tag_name

-                    tag.sort_key = slughifi(tag_sort_key)
+                    tag.sort_key = tag_sort_key.lower()

                     tag.save()
                 book_tags.append(tag)
 
                     tag.save()
                 book_tags.append(tag)
 


@@ -377,38 +448,27 @@ class Book(models.Model):
 
         book_tag = book.book_tag()
 
 
         book_tag = book.book_tag()
 

-        if hasattr(book_info, 'parts'):
-            for n, part_url in enumerate(book_info.parts):
-                base, slug = part_url.rsplit('/', 1)
-                try:
-                    child_book = Book.objects.get(slug=slug)
-                    child_book.parent = book
-                    child_book.parent_number = n
-                    child_book.save()
-                except Book.DoesNotExist, e:
-                    raise Book.DoesNotExist(_('Book with slug = "%s" does not exist.') % slug)
-
-        book_descendants = list(book.children.all())
-        while len(book_descendants) > 0:
-            child_book = book_descendants.pop(0)
-            child_book.tags = list(child_book.tags) + [book_tag]
+        for n, child_book in enumerate(children):
+            child_book.parent = book
+            child_book.parent_number = n

             child_book.save()
             child_book.save()

-            for fragment in child_book.fragments.all():
-                fragment.tags = set(list(fragment.tags) + [book_tag])
-            book_descendants += list(child_book.children.all())

 
         # Save XML and HTML files
         book.xml_file.save('%s.xml' % book.slug, raw_file, save=False)
 
 
         # Save XML and HTML files
         book.xml_file.save('%s.xml' % book.slug, raw_file, save=False)
 

+        # delete old fragments when overwriting
+        book.fragments.all().delete()
+

         html_file = NamedTemporaryFile()
         if html.transform(book.xml_file.path, html_file, parse_dublincore=False):
             book.html_file.save('%s.html' % book.slug, File(html_file), save=False)
 
         html_file = NamedTemporaryFile()
         if html.transform(book.xml_file.path, html_file, parse_dublincore=False):
             book.html_file.save('%s.html' % book.slug, File(html_file), save=False)
 

-            # Create EPUB
-            epub_file = StringIO()
-            epub.transform(book.xml_file, epub_file)
-            book.epub_file.save('%s.epub' % book.slug, ContentFile(epub_file.getvalue()), save=False)
-            FileRecord(slug=book.slug, type='epub', sha1=sha1(epub_file.getvalue()).hexdigest()).save()
+            # get ancestor l-tags for adding to new fragments
+            ancestor_tags = []
+            p = book.parent
+            while p:
+                ancestor_tags.append(p.book_tag())
+                p = p.parent

 
             # Extract fragments
             closed_fragments, open_fragments = html.extract_fragments(book.html_file.path)
 
             # Extract fragments
             closed_fragments, open_fragments = html.extract_fragments(book.html_file.path)


@@ -424,7 +484,7 @@ class Book(models.Model):
                     tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme')
                     if created:
                         tag.name = theme_name
                     tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme')
                     if created:
                         tag.name = theme_name

-                        tag.sort_key = slughifi(theme_name)
+                        tag.sort_key = theme_name.lower()

                         tag.save()
                     themes.append(tag)
                 if not themes:
                         tag.save()
                     themes.append(tag)
                 if not themes:


@@ -438,11 +498,25 @@ class Book(models.Model):
                     defaults={'text': text, 'short_text': short_text})
 
                 new_fragment.save()
                     defaults={'text': text, 'short_text': short_text})
 
                 new_fragment.save()

-                new_fragment.tags = set(book_tags + themes + [book_tag])
+                new_fragment.tags = set(book_tags + themes + [book_tag] + ancestor_tags)
+
+        if not settings.NO_BUILD_EPUB:
+            book.root_ancestor().build_epub()
+
+        book_descendants = list(book.children.all())
+        # add l-tag to descendants and their fragments
+        # delete unnecessary EPUB files
+        while len(book_descendants) > 0:
+            child_book = book_descendants.pop(0)
+            child_book.tags = list(child_book.tags) + [book_tag]
+            child_book.save()
+            for fragment in child_book.fragments.all():
+                fragment.tags = set(list(fragment.tags) + [book_tag])
+            book_descendants += list(child_book.children.all())

 
         # refresh cache
 
         # refresh cache

-        book.tag_counter
-        book.theme_counter
+        book.reset_tag_counter()
+        book.reset_theme_counter()

 
         book.save()
         return book
 
         book.save()
         return book