importbooks: no-build-epub and wait-until options
[wolnelektury.git] / apps / catalogue / models.py
index 9228284..5f7eb17 100644 (file)
@@ -11,13 +11,12 @@ from django.template.loader import render_to_string
 from django.utils.safestring import mark_safe
 from django.utils.translation import get_language
 from django.core.urlresolvers import reverse
-from datetime import datetime
 
 from newtagging.models import TagBase, tags_updated
 from newtagging import managers
 from catalogue.fields import JSONField
 
-from librarian import html, dcparser
+from librarian import dcparser, html, epub, NoDublinCore
 from mutagen import id3
 
 
@@ -52,7 +51,6 @@ class Tag(TagBase):
 
     user = models.ForeignKey(User, blank=True, null=True)
     book_count = models.IntegerField(_('book count'), blank=False, null=True)
-    death = models.IntegerField(_(u'year of death'), blank=True, null=True)
     gazeta_link = models.CharField(blank=True, max_length=240)
     wiki_link = models.CharField(blank=True, max_length=240)
 
@@ -87,17 +85,6 @@ class Tag(TagBase):
     has_description.short_description = _('description')
     has_description.boolean = True
 
-    def alive(self):
-        return self.death is None
-
-    def in_pd(self):
-        """ tests whether an author is in public domain """
-        return self.death is not None and self.goes_to_pd() <= datetime.now().year
-
-    def goes_to_pd(self):
-        """ calculates the year of public domain entry for an author """
-        return self.death + 71 if self.death is not None else None
-
     def get_count(self):
         """ returns global book count for book tags, fragment count for themes """
 
@@ -186,6 +173,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)
+    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')
 
@@ -207,7 +195,7 @@ class Book(models.Model):
     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 = {}
@@ -263,8 +251,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)
-            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:
@@ -273,6 +261,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)
+            if self.daisy_file:
+                formats.append(u'<a href="%s">DAISY</a>' % self.daisy_file.url)
 
             formats = [mark_safe(format) for format in formats]
 
@@ -282,6 +272,18 @@ class Book(models.Model):
             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)
@@ -314,8 +316,54 @@ class Book(models.Model):
     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, output_file=epub_file)
+            self.epub_file.save('%s.epub' % self.slug, ContentFile(epub_file.getvalue()), save=False)
+            self.save()
+            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()
+            book_descendants += list(child_book.children.all())
+
+
     @classmethod
-    def from_xml_file(cls, xml_file, overwrite=False):
+    def from_xml_file(cls, xml_file, overwrite=False, build_epub=True):
         # use librarian to parse meta-data
         book_info = dcparser.parse(xml_file)
 
@@ -323,15 +371,16 @@ class Book(models.Model):
             xml_file = File(open(xml_file))
 
         try:
-            return cls.from_text_and_meta(xml_file, book_info, overwrite)
+            return cls.from_text_and_meta(xml_file, book_info, overwrite, build_epub=build_epub)
         finally:
             xml_file.close()
 
     @classmethod
-    def from_text_and_meta(cls, raw_file, book_info, overwrite=False):
+    def from_text_and_meta(cls, raw_file, book_info, overwrite=False, build_epub=True):
         from tempfile import NamedTemporaryFile
         from slughifi import slughifi
         from markupstring import MarkupString
+        from django.core.files.storage import default_storage
 
         # Read book metadata
         book_base, book_slug = book_info.url.rsplit('/', 1)
@@ -384,22 +433,23 @@ class Book(models.Model):
                 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]
-            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)
 
+        # 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)
 
+            # 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)
             for fragment in closed_fragments.values():
@@ -428,11 +478,28 @@ class Book(models.Model):
                     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 build_epub and not book.parent:
+            print 'epub'
+            book.build_epub(remove_descendants=False)
+
+        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]
+            if child_book.has_epub_file():
+                child_book.epub_file.delete()
+            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
-        book.tag_counter
-        book.theme_counter
+        book.reset_tag_counter()
+        book.reset_theme_counter()
 
         book.save()
         return book
@@ -482,6 +549,22 @@ class Book(models.Model):
             return self.refresh_theme_counter()
         return dict((int(k), v) for k, v in self.get__theme_counter_value().iteritems())
 
+    def pretty_title(self, html_links=False):
+        book = self
+        names = list(book.tags.filter(category='author'))
+
+        books = []
+        while book:
+            books.append(book)
+            book = book.parent
+        names.extend(reversed(books))
+
+        if html_links:
+            names = ['<a href="%s">%s</a>' % (tag.get_absolute_url(), tag.name) for tag in names]
+        else:
+            names = [tag.name for tag in names]
+
+        return ', '.join(names)
 
 
 class Fragment(models.Model):
@@ -515,32 +598,19 @@ class Fragment(models.Model):
             return mark_safe(getattr(self, key))
 
 
-class BookStub(models.Model):
-    title = models.CharField(_('title'), max_length=120)
-    author = models.CharField(_('author'), max_length=120)
-    pd = models.IntegerField(_('goes to public domain'), null=True, blank=True)
-    slug = models.SlugField(_('slug'), max_length=120, unique=True, db_index=True)
-    translator = models.TextField(_('translator'), blank=True)
-    translator_death = models.TextField(_('year of translator\'s death'), blank=True)
+class FileRecord(models.Model):
+    slug = models.SlugField(_('slug'), max_length=120, db_index=True)
+    type = models.CharField(_('type'), max_length=20, db_index=True)
+    sha1 = models.CharField(_('sha-1 hash'), max_length=40)
+    time = models.DateTimeField(_('time'), auto_now_add=True)
 
     class Meta:
-        ordering = ('title',)
-        verbose_name = _('book stub')
-        verbose_name_plural = _('book stubs')
+        ordering = ('-time','-slug', '-type')
+        verbose_name = _('file record')
+        verbose_name_plural = _('file records')
 
     def __unicode__(self):
-        return self.title
-
-    @permalink
-    def get_absolute_url(self):
-        return ('catalogue.views.book_detail', [self.slug])
-
-    def in_pd(self):
-        return self.pd is not None and self.pd <= datetime.now().year
-
-    @property
-    def name(self):
-        return self.title
+        return "%s %s.%s" % (self.sha1,  self.slug, self.type)
 
 
 def _tags_updated_handler(sender, affected_tags, **kwargs):