X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/84aecebd96f2bc8a27396ecf10c409a8b91e1bcc..f030289137a031a2e78f9aadb9ce075d8de76649:/apps/catalogue/models.py diff --git a/apps/catalogue/models.py b/apps/catalogue/models.py index 98e37c1af..6291d97e8 100644 --- a/apps/catalogue/models.py +++ b/apps/catalogue/models.py @@ -8,20 +8,22 @@ from django.utils.translation import ugettext_lazy as _ from django.contrib.auth.models import User from django.core.files import File from django.template.loader import render_to_string -from django.template.defaultfilters import slugify 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 django.db.models.signals import post_save, m2m_changed, pre_delete from django.conf import settings from newtagging.models import TagBase, tags_updated from newtagging import managers from catalogue.fields import JSONField +from catalogue.utils import ExistingFile from librarian import dcparser, html, epub, NoDublinCore +import mutagen from mutagen import id3 +from slughifi import slughifi TAG_CATEGORIES = ( @@ -60,11 +62,13 @@ class Tag(TagBase): main_page = models.BooleanField(_('main page'), default=False, db_index=True, help_text=_('Show tag on main page')) 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) + book_count = models.IntegerField(_('book count'), blank=True, null=True) gazeta_link = models.CharField(blank=True, max_length=240) wiki_link = models.CharField(blank=True, max_length=240) + class UrlDeprecationWarning(DeprecationWarning): + pass + categories_rev = { 'autor': 'author', 'epoka': 'epoch', @@ -96,17 +100,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 """ @@ -134,19 +127,20 @@ class Tag(TagBase): real_tags = [] ambiguous_slugs = [] category = None + deprecated = False tags_splitted = tags.split('/') - for index, name in enumerate(tags_splitted): - if name in Tag.categories_rev: + for name in tags_splitted: + if category: + real_tags.append(Tag.objects.get(slug=name, category=category)) + category = None + elif name in Tag.categories_rev: category = Tag.categories_rev[name] else: - if category: - real_tags.append(Tag.objects.get(slug=name, category=category)) - category = None - else: - try: - real_tags.append(Tag.objects.exclude(category='book').get(slug=name)) - except Tag.MultipleObjectsReturned, e: - ambiguous_slugs.append(name) + try: + real_tags.append(Tag.objects.exclude(category='book').get(slug=name)) + deprecated = True + except Tag.MultipleObjectsReturned, e: + ambiguous_slugs.append(name) if category: # something strange left off @@ -157,8 +151,11 @@ class Tag(TagBase): e.tags = real_tags e.ambiguous_slugs = ambiguous_slugs raise e - else: - return real_tags + if deprecated: + e = Tag.UrlDeprecationWarning() + e.tags = real_tags + raise e + return real_tags else: return TagBase.get_tag_list(tags) @@ -168,20 +165,30 @@ class Tag(TagBase): # TODO: why is this hard-coded ? -def book_upload_path(ext=None): +def book_upload_path(ext=None, maxlen=100): def get_dynamic_path(media, filename, ext=ext): # how to put related book's slug here? if not ext: - ext = media.type - return 'lektura/%s.%s' % (slugify(media.name), ext) + if media.type == 'daisy': + ext = 'daisy.zip' + else: + ext = media.type + if not media.name: + name = slughifi(filename.split(".")[0]) + else: + name = slughifi(media.name) + return 'book/%s/%s.%s' % (ext, name[:maxlen-len('book/%s/.%s' % (ext, ext))-4], ext) return get_dynamic_path class BookMedia(models.Model): type = models.CharField(_('type'), choices=MEDIA_FORMATS, max_length="100") name = models.CharField(_('name'), max_length="100") - file = models.FileField(_('file'), upload_to=book_upload_path(), blank=True) + file = models.FileField(_('file'), upload_to=book_upload_path()) uploaded_at = models.DateTimeField(_('creation date'), auto_now_add=True, editable=False) + extra_info = JSONField(_('extra information'), default='{}', editable=False) + book = models.ForeignKey('Book', related_name='media') + source_sha1 = models.CharField(null=True, blank=True, max_length=40, editable=False) def __unicode__(self): return "%s (%s)" % (self.name, self.file.name.split("/")[-1]) @@ -191,6 +198,80 @@ class BookMedia(models.Model): verbose_name = _('book media') verbose_name_plural = _('book media') + def save(self, *args, **kwargs): + try: + b = BookMedia.objects.get(pk=self.pk) + except BookMedia.DoesNotExist, e: + pass + else: + # if file is replaced, delete the old one + if self.file.path != b.file.path: + b.file.delete(save=False) + # if name changed, change the file name, too + elif self.name != b.name: + self.file.save(None, ExistingFile(self.file.path)) + + super(BookMedia, self).save(*args, **kwargs) + extra_info = self.get_extra_info_value() + extra_info.update(self.read_meta()) + self.set_extra_info_value(extra_info) + self.source_sha1 = self.read_source_sha1(self.file.path, self.type) + return super(BookMedia, self).save(*args, **kwargs) + + def read_meta(self): + """ + Reads some metadata from the audiobook. + """ + + artist_name = director_name = project = funded_by = '' + if self.type == 'mp3': + try: + audio = id3.ID3(self.file.path) + artist_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE1')) + director_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE3')) + project = ", ".join([t.data for t in audio.getall('PRIV') + if t.owner=='wolnelektury.pl?project']) + funded_by = ", ".join([t.data for t in audio.getall('PRIV') + if t.owner=='wolnelektury.pl?funded_by']) + except: + pass + elif self.type == 'ogg': + try: + audio = mutagen.File(self.file.path) + artist_name = ', '.join(audio.get('artist', [])) + director_name = ', '.join(audio.get('conductor', [])) + project = ", ".join(audio.get('project', [])) + funded_by = ", ".join(audio.get('funded_by', [])) + except: + pass + else: + return {} + return {'artist_name': artist_name, 'director_name': director_name, + 'project': project, 'funded_by': funded_by} + + @staticmethod + def read_source_sha1(filepath, filetype): + """ + Reads source file SHA1 from audiobok metadata. + """ + + if filetype == 'mp3': + try: + audio = id3.ID3(filepath) + return [t.data for t in audio.getall('PRIV') + if t.owner=='wolnelektury.pl?flac_sha1'][0] + except: + return None + elif filetype == 'ogg': + try: + audio = mutagen.File(filepath) + return audio.get('flac_sha1', [None])[0] + except: + return None + else: + return None + + class Book(models.Model): title = models.CharField(_('title'), max_length=120) slug = models.SlugField(_('slug'), max_length=120, unique=True, db_index=True) @@ -207,9 +288,7 @@ class Book(models.Model): pdf_file = models.FileField(_('PDF file'), upload_to=book_upload_path('pdf'), blank=True) epub_file = models.FileField(_('EPUB file'), upload_to=book_upload_path('epub'), blank=True) txt_file = models.FileField(_('TXT file'), upload_to=book_upload_path('txt'), blank=True) - # other files - medias = models.ManyToManyField(BookMedia, blank=True) - + parent = models.ForeignKey('self', blank=True, null=True, related_name='children') objects = models.Manager() tagged = managers.ModelTaggedItemManager(Tag) @@ -229,7 +308,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, **kwargs): + def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs): if reset_short_html: # Reset _short_html during save update = {} @@ -239,16 +318,7 @@ class Book(models.Model): # Fragment.short_html relies on book's tags, so reset it here too self.fragments.all().update(**update) - book = super(Book, self).save(force_insert, force_update) - - if refresh_mp3 and self.has_media('mp3'): - file = self.get_media('mp3')[0] - #print file, file.path - extra_info = self.get_extra_info_value() - extra_info.update(self.get_mp3_info()) - self.set_extra_info_value(extra_info) - book = super(Book, self).save(force_insert, force_update) - return book + return super(Book, self).save(force_insert, force_update) @permalink def get_absolute_url(self): @@ -297,7 +367,7 @@ class Book(models.Model): else: return False else: - if self.medias.filter(book=self, type=type).count() > 0: + if self.media.filter(type=type).exists(): return True else: return False @@ -309,13 +379,13 @@ class Book(models.Model): elif type == "html": return self.html_file elif type == "epub": - return self.html_file + return self.epub_file elif type == "txt": return self.txt_file elif type == "pdf": return self.pdf_file else: - return self.medias.filter(book=self, type=type) + return self.media.filter(type=type) else: return None @@ -346,14 +416,12 @@ class Book(models.Model): formats.append(u'PDF' % self.get_media('pdf').url) if self.root_ancestor.has_media("epub"): formats.append(u'EPUB' % self.root_ancestor.get_media('epub').url) - if self.has_media("odt"): - formats.append(u'ODT' % self.get_media('odt').url) if self.has_media("txt"): formats.append(u'TXT' % self.get_media('txt').url) # other files for m in self.media.order_by('type'): - formats.append(u'%s' % m.type, m.file.url) - + formats.append(u'%s' % (m.file.url, m.type.upper())) + formats = [mark_safe(format) for format in formats] setattr(self, key, unicode(render_to_string('catalogue/book_short.html', @@ -374,13 +442,6 @@ class Book(models.Model): return self._root_ancestor - def get_mp3_info(self): - """Retrieves artist and director names from audio ID3 tags.""" - audio = id3.ID3(self.get_media('mp3')[0].file.path) - artist_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE1')) - director_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE3')) - return {'artist_name': artist_name, 'director_name': director_name} - def has_description(self): return len(self.description) > 0 has_description.short_description = _('description') @@ -397,6 +458,11 @@ class Book(models.Model): has_epub_file.short_description = 'EPUB' has_epub_file.boolean = True + def has_txt_file(self): + return bool(self.txt_file) + has_txt_file.short_description = 'HTML' + has_txt_file.boolean = True + def has_html_file(self): return bool(self.html_file) has_html_file.short_description = 'HTML' @@ -451,9 +517,8 @@ class Book(models.Model): 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) + epub.transform(BookImportDocProvider(self), self.slug, output_file=epub_file) + self.epub_file.save('%s.epub' % self.slug, ContentFile(epub_file.getvalue())) FileRecord(slug=self.slug, type='epub', sha1=sha1(epub_file.getvalue()).hexdigest()).save() except NoDublinCore: pass @@ -464,12 +529,22 @@ class Book(models.Model): 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) + child_book.save() book_descendants += list(child_book.children.all()) + def build_txt(self): + from StringIO import StringIO + from django.core.files.base import ContentFile + from librarian import text + + out = StringIO() + text.transform(open(self.xml_file.path), out) + self.txt_file.save('%s.txt' % self.slug, ContentFile(out.getvalue())) + self.save() + @classmethod - def from_xml_file(cls, xml_file, overwrite=False): + def from_xml_file(cls, xml_file, **kwargs): # use librarian to parse meta-data book_info = dcparser.parse(xml_file) @@ -477,14 +552,14 @@ 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, **kwargs) 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, build_txt=True): + import re from tempfile import NamedTemporaryFile - from slughifi import slughifi from markupstring import MarkupString from django.core.files.storage import default_storage @@ -501,6 +576,8 @@ class Book(models.Model): # Read book metadata book_base, book_slug = book_info.url.rsplit('/', 1) + if re.search(r'[^a-zA-Z0-9-]', book_slug): + raise ValueError('Invalid characters in slug') book, created = Book.objects.get_or_create(slug=book_slug) if created: @@ -535,7 +612,7 @@ class Book(models.Model): tag.save() book_tags.append(tag) - book.tags = book_tags + book_shelves + book.tags = set(book_tags + book_shelves) book_tag = book.book_tag() @@ -591,8 +668,11 @@ class Book(models.Model): new_fragment.save() new_fragment.tags = set(book_tags + themes + [book_tag] + ancestor_tags) - if not settings.NO_BUILD_EPUB: - book.root_ancestor().build_epub() + if not settings.NO_BUILD_TXT and build_txt: + book.build_txt() + + if not settings.NO_BUILD_EPUB and build_epub: + book.root_ancestor.build_epub() book_descendants = list(book.children.all()) # add l-tag to descendants and their fragments @@ -621,12 +701,12 @@ class Book(models.Model): for tag in self.tags.exclude(category__in=('book', 'theme', 'set')).order_by(): tags[tag.pk] = 1 self.set__tag_counter_value(tags) - self.save(reset_short_html=False, refresh_mp3=False) + self.save(reset_short_html=False) return tags def reset_tag_counter(self): self._tag_counter = None - self.save(reset_short_html=False, refresh_mp3=False) + self.save(reset_short_html=False) if self.parent: self.parent.reset_tag_counter() @@ -642,12 +722,12 @@ class Book(models.Model): for tag in fragment.tags.filter(category='theme').order_by(): tags[tag.pk] = tags.get(tag.pk, 0) + 1 self.set__theme_counter_value(tags) - self.save(reset_short_html=False, refresh_mp3=False) + self.save(reset_short_html=False) return tags def reset_theme_counter(self): self._theme_counter = None - self.save(reset_short_html=False, refresh_mp3=False) + self.save(reset_short_html=False) if self.parent: self.parent.reset_theme_counter() @@ -657,6 +737,24 @@ 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 = ['%s' % (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): text = models.TextField() short_text = models.TextField(editable=False) @@ -688,34 +786,6 @@ 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 Meta: - ordering = ('title',) - verbose_name = _('book stub') - verbose_name_plural = _('book stubs') - - 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 - - class FileRecord(models.Model): slug = models.SlugField(_('slug'), max_length=120, db_index=True) type = models.CharField(_('type'), max_length=20, db_index=True) @@ -730,6 +800,12 @@ class FileRecord(models.Model): def __unicode__(self): return "%s %s.%s" % (self.sha1, self.slug, self.type) +########### +# +# SIGNALS +# +########### + def _tags_updated_handler(sender, affected_tags, **kwargs): # reset tag global counter @@ -747,3 +823,15 @@ def _tags_updated_handler(sender, affected_tags, **kwargs): sender.book.reset_theme_counter() tags_updated.connect(_tags_updated_handler) + +def _pre_delete_handler(sender, instance, **kwargs): + """ refresh Book on BookMedia delete """ + if sender == BookMedia: + instance.book.save() +pre_delete.connect(_pre_delete_handler) + +def _post_save_handler(sender, instance, **kwargs): + """ refresh all the short_html stuff on BookMedia update """ + if sender == BookMedia: + instance.book.save() +post_save.connect(_post_save_handler)