From: Radek Czajka Date: Thu, 9 Aug 2012 15:09:06 +0000 (+0200) Subject: split catalogue.models X-Git-Url: https://git.mdrn.pl/wolnelektury.git/commitdiff_plain/c661073dd0969caa9a47a225f3d3fae767295c3d split catalogue.models --- diff --git a/apps/catalogue/constants.py b/apps/catalogue/constants.py old mode 100755 new mode 100644 diff --git a/apps/catalogue/import_utils.py b/apps/catalogue/import_utils.py old mode 100755 new mode 100644 diff --git a/apps/catalogue/models.py b/apps/catalogue/models.py deleted file mode 100644 index 3704b1663..000000000 --- a/apps/catalogue/models.py +++ /dev/null @@ -1,1040 +0,0 @@ -# -*- 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 namedtuple - -from django.db import models -from django.db.models import permalink -import django.dispatch -from django.core.cache import get_cache -from django.utils.translation import ugettext_lazy as _ -from django.contrib.auth.models import User -from django.template.loader import render_to_string -from django.utils.datastructures import SortedDict -from django.utils.safestring import mark_safe -from django.utils.translation import get_language -from django.core.urlresolvers import reverse -from django.db.models.signals import post_save, pre_delete, post_delete -import jsonfield - -from django.conf import settings - -from newtagging.models import TagBase, tags_updated -from newtagging import managers -from catalogue.fields import OverwritingFileField -from catalogue.utils import create_zip, split_tags, truncate_html_words -from catalogue import tasks -import re - - -# Those are hard-coded here so that makemessages sees them. -TAG_CATEGORIES = ( - ('author', _('author')), - ('epoch', _('epoch')), - ('kind', _('kind')), - ('genre', _('genre')), - ('theme', _('theme')), - ('set', _('set')), - ('book', _('book')), -) - - -permanent_cache = get_cache('permanent') - - -class TagSubcategoryManager(models.Manager): - def __init__(self, subcategory): - super(TagSubcategoryManager, self).__init__() - self.subcategory = subcategory - - def get_query_set(self): - return super(TagSubcategoryManager, self).get_query_set().filter(category=self.subcategory) - - -class Tag(TagBase): - """A tag attachable to books and fragments (and possibly anything). - - Used to represent searchable metadata (authors, epochs, genres, kinds), - fragment themes (motifs) and some book hierarchy related kludges.""" - name = models.CharField(_('name'), max_length=50, db_index=True) - slug = models.SlugField(_('slug'), 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) - - user = models.ForeignKey(User, 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) - - created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True) - changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True) - - class UrlDeprecationWarning(DeprecationWarning): - pass - - categories_rev = { - 'autor': 'author', - 'epoka': 'epoch', - 'rodzaj': 'kind', - 'gatunek': 'genre', - 'motyw': 'theme', - 'polka': 'set', - } - categories_dict = dict((item[::-1] for item in categories_rev.iteritems())) - - class Meta: - ordering = ('sort_key',) - verbose_name = _('tag') - verbose_name_plural = _('tags') - unique_together = (("slug", "category"),) - - def __unicode__(self): - return self.name - - def __repr__(self): - return "Tag(slug=%r)" % self.slug - - @permalink - def get_absolute_url(self): - return ('catalogue.views.tagged_object_list', [self.url_chunk]) - - def has_description(self): - return len(self.description) > 0 - has_description.short_description = _('description') - has_description.boolean = True - - def get_count(self): - """Returns global book count for book tags, fragment count for themes.""" - - if self.category == 'book': - # never used - objects = Book.objects.none() - elif self.category == 'theme': - objects = Fragment.tagged.with_all((self,)) - else: - objects = Book.tagged.with_all((self,)).order_by() - if self.category != 'set': - # eliminate descendants - l_tags = Tag.objects.filter(slug__in=[book.book_tag_slug() for book in objects.iterator()]) - descendants_keys = [book.pk for book in Book.tagged.with_any(l_tags).iterator()] - if descendants_keys: - objects = objects.exclude(pk__in=descendants_keys) - return objects.count() - - @staticmethod - def get_tag_list(tags): - if isinstance(tags, basestring): - real_tags = [] - ambiguous_slugs = [] - category = None - deprecated = False - tags_splitted = tags.split('/') - 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: - 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 - raise Tag.DoesNotExist() - if ambiguous_slugs: - # some tags should be qualified - e = Tag.MultipleObjectsReturned() - e.tags = real_tags - e.ambiguous_slugs = ambiguous_slugs - raise e - if deprecated: - e = Tag.UrlDeprecationWarning() - e.tags = real_tags - raise e - return real_tags - else: - return TagBase.get_tag_list(tags) - - @property - def url_chunk(self): - return '/'.join((Tag.categories_dict[self.category], self.slug)) - - @staticmethod - def tags_from_info(info): - from slughifi import slughifi - from sortify import sortify - meta_tags = [] - categories = (('kinds', 'kind'), ('genres', 'genre'), ('authors', 'author'), ('epochs', 'epoch')) - for field_name, category in categories: - try: - tag_names = getattr(info, field_name) - except: - try: - tag_names = [getattr(info, category)] - except: - # For instance, Pictures do not have 'genre' field. - continue - for tag_name in tag_names: - tag_sort_key = tag_name - if category == 'author': - tag_sort_key = tag_name.last_name - tag_name = tag_name.readable() - tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category) - if created: - tag.name = tag_name - tag.sort_key = sortify(tag_sort_key.lower()) - tag.save() - meta_tags.append(tag) - return meta_tags - - - -def get_dynamic_path(media, filename, ext=None, maxlen=100): - from slughifi import slughifi - - # how to put related book's slug here? - if not ext: - # BookMedia case - ext = media.formats[media.type].ext - if media is None or 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) - - -# TODO: why is this hard-coded ? -def book_upload_path(ext=None, maxlen=100): - return lambda *args: get_dynamic_path(*args, ext=ext, maxlen=maxlen) - - -class BookMedia(models.Model): - """Represents media attached to a book.""" - FileFormat = namedtuple("FileFormat", "name ext") - formats = SortedDict([ - ('mp3', FileFormat(name='MP3', ext='mp3')), - ('ogg', FileFormat(name='Ogg Vorbis', ext='ogg')), - ('daisy', FileFormat(name='DAISY', ext='daisy.zip')), - ]) - format_choices = [(k, _('%s file') % t.name) - for k, t in formats.items()] - - type = models.CharField(_('type'), choices=format_choices, max_length="100") - name = models.CharField(_('name'), max_length="100") - file = OverwritingFileField(_('file'), upload_to=book_upload_path()) - uploaded_at = models.DateTimeField(_('creation date'), auto_now_add=True, editable=False) - extra_info = jsonfield.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]) - - class Meta: - ordering = ('type', 'name') - verbose_name = _('book media') - verbose_name_plural = _('book media') - - def save(self, *args, **kwargs): - from slughifi import slughifi - from catalogue.utils import ExistingFile, remove_zip - - try: - old = BookMedia.objects.get(pk=self.pk) - except BookMedia.DoesNotExist: - old = None - else: - # if name changed, change the file name, too - if slughifi(self.name) != slughifi(old.name): - self.file.save(None, ExistingFile(self.file.path), save=False, leave=True) - - super(BookMedia, self).save(*args, **kwargs) - - # remove the zip package for book with modified media - if old: - remove_zip("%s_%s" % (old.book.slug, old.type)) - remove_zip("%s_%s" % (self.book.slug, self.type)) - - extra_info = self.extra_info - extra_info.update(self.read_meta()) - self.extra_info = 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. - """ - import mutagen - from mutagen import id3 - - 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. - """ - import mutagen - from mutagen import id3 - - 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): - """Represents a book imported from WL-XML.""" - title = models.CharField(_('title'), max_length=120) - sort_key = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False) - 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=settings.CATALOGUE_DEFAULT_LANGUAGE) - description = models.TextField(_('description'), blank=True) - created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True) - changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True) - parent_number = models.IntegerField(_('parent number'), default=0) - extra_info = jsonfield.JSONField(_('extra information'), default='{}') - gazeta_link = models.CharField(blank=True, max_length=240) - wiki_link = models.CharField(blank=True, max_length=240) - # files generated during publication - - cover = models.FileField(_('cover'), upload_to=book_upload_path('png'), - null=True, blank=True) - ebook_formats = ['pdf', 'epub', 'mobi', 'fb2', 'txt'] - formats = ebook_formats + ['html', 'xml'] - - parent = models.ForeignKey('self', blank=True, null=True, related_name='children') - - _related_info = jsonfield.JSONField(blank=True, null=True, editable=False) - - objects = models.Manager() - tagged = managers.ModelTaggedItemManager(Tag) - tags = managers.TagDescriptor(Tag) - - html_built = django.dispatch.Signal() - published = django.dispatch.Signal() - - class AlreadyExists(Exception): - pass - - class Meta: - ordering = ('sort_key',) - verbose_name = _('book') - verbose_name_plural = _('books') - - def __unicode__(self): - return self.title - - def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs): - from sortify import sortify - - self.sort_key = sortify(self.title) - - ret = super(Book, self).save(force_insert, force_update) - - if reset_short_html: - self.reset_short_html() - - return ret - - @permalink - def get_absolute_url(self): - return ('catalogue.views.book_detail', [self.slug]) - - @property - def name(self): - return self.title - - def book_tag_slug(self): - return ('l-' + self.slug)[:120] - - def book_tag(self): - slug = self.book_tag_slug() - book_tag, created = Tag.objects.get_or_create(slug=slug, category='book') - if created: - book_tag.name = self.title[:50] - book_tag.sort_key = self.title.lower() - book_tag.save() - return book_tag - - def has_media(self, type_): - if type_ in Book.formats: - return bool(getattr(self, "%s_file" % type_)) - else: - return self.media.filter(type=type_).exists() - - def get_media(self, type_): - if self.has_media(type_): - if type_ in Book.formats: - return getattr(self, "%s_file" % type_) - else: - return self.media.filter(type=type_) - else: - return None - - def get_mp3(self): - return self.get_media("mp3") - def get_odt(self): - return self.get_media("odt") - def get_ogg(self): - return self.get_media("ogg") - def get_daisy(self): - return self.get_media("daisy") - - def reset_short_html(self): - if self.id is None: - return - - type(self).objects.filter(pk=self.pk).update(_related_info=None) - # Fragment.short_html relies on book's tags, so reset it here too - for fragm in self.fragments.all().iterator(): - fragm.reset_short_html() - - def has_description(self): - return len(self.description) > 0 - has_description.short_description = _('description') - has_description.boolean = True - - # ugly ugly ugly - def has_mp3_file(self): - return bool(self.has_media("mp3")) - has_mp3_file.short_description = 'MP3' - has_mp3_file.boolean = True - - def has_ogg_file(self): - return bool(self.has_media("ogg")) - has_ogg_file.short_description = 'OGG' - has_ogg_file.boolean = True - - def has_daisy_file(self): - return bool(self.has_media("daisy")) - has_daisy_file.short_description = 'DAISY' - has_daisy_file.boolean = True - - def wldocument(self, parse_dublincore=True): - from catalogue.import_utils import ORMDocProvider - from librarian.parser import WLDocument - - return WLDocument.from_file(self.xml_file.path, - provider=ORMDocProvider(self), - parse_dublincore=parse_dublincore) - - def build_cover(self, book_info=None): - """(Re)builds the cover image.""" - from StringIO import StringIO - from django.core.files.base import ContentFile - from librarian.cover import WLCover - - if book_info is None: - book_info = self.wldocument().book_info - - cover = WLCover(book_info).image() - imgstr = StringIO() - cover.save(imgstr, 'png') - self.cover.save(None, ContentFile(imgstr.getvalue())) - - def build_html(self): - from django.core.files.base import ContentFile - from slughifi import slughifi - from sortify import sortify - from librarian import html - - meta_tags = list(self.tags.filter( - category__in=('author', 'epoch', 'genre', 'kind'))) - book_tag = self.book_tag() - - html_output = self.wldocument(parse_dublincore=False).as_html() - if html_output: - self.html_file.save('%s.html' % self.slug, - ContentFile(html_output.get_string())) - - # get ancestor l-tags for adding to new fragments - ancestor_tags = [] - p = self.parent - while p: - ancestor_tags.append(p.book_tag()) - p = p.parent - - # Delete old fragments and create them from scratch - self.fragments.all().delete() - # Extract fragments - closed_fragments, open_fragments = html.extract_fragments(self.html_file.path) - for fragment in closed_fragments.values(): - try: - theme_names = [s.strip() for s in fragment.themes.split(',')] - except AttributeError: - continue - themes = [] - for theme_name in theme_names: - if not theme_name: - continue - tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme') - if created: - tag.name = theme_name - tag.sort_key = sortify(theme_name.lower()) - tag.save() - themes.append(tag) - if not themes: - continue - - text = fragment.to_string() - short_text = truncate_html_words(text, 15) - if text == short_text: - short_text = '' - new_fragment = Fragment.objects.create(anchor=fragment.id, book=self, - text=text, short_text=short_text) - - new_fragment.save() - new_fragment.tags = set(meta_tags + themes + [book_tag] + ancestor_tags) - self.save() - self.html_built.send(sender=self) - return True - return False - - # Thin wrappers for builder tasks - def build_pdf(self, *args, **kwargs): - """(Re)builds PDF.""" - return tasks.build_pdf.delay(self.pk, *args, **kwargs) - def build_epub(self, *args, **kwargs): - """(Re)builds EPUB.""" - return tasks.build_epub.delay(self.pk, *args, **kwargs) - def build_mobi(self, *args, **kwargs): - """(Re)builds MOBI.""" - return tasks.build_mobi.delay(self.pk, *args, **kwargs) - def build_fb2(self, *args, **kwargs): - """(Re)build FB2""" - return tasks.build_fb2.delay(self.pk, *args, **kwargs) - def build_txt(self, *args, **kwargs): - """(Re)builds TXT.""" - return tasks.build_txt.delay(self.pk, *args, **kwargs) - - @staticmethod - def zip_format(format_): - def pretty_file_name(book): - return "%s/%s.%s" % ( - b.extra_info['author'], - b.slug, - format_) - - field_name = "%s_file" % format_ - books = Book.objects.filter(parent=None).exclude(**{field_name: ""}) - paths = [(pretty_file_name(b), getattr(b, field_name).path) - for b in books.iterator()] - return create_zip(paths, - getattr(settings, "ALL_%s_ZIP" % format_.upper())) - - def zip_audiobooks(self, format_): - bm = BookMedia.objects.filter(book=self, type=format_) - paths = map(lambda bm: (None, bm.file.path), bm) - return create_zip(paths, "%s_%s" % (self.slug, format_)) - - def search_index(self, book_info=None, reuse_index=False, index_tags=True): - import search - if reuse_index: - idx = search.ReusableIndex() - else: - idx = search.Index() - - idx.open() - try: - idx.index_book(self, book_info) - if index_tags: - idx.index_tags() - finally: - idx.close() - - @classmethod - def from_xml_file(cls, xml_file, **kwargs): - from django.core.files import File - from librarian import dcparser - - # use librarian to parse meta-data - book_info = dcparser.parse(xml_file) - - if not isinstance(xml_file, File): - xml_file = File(open(xml_file)) - - try: - 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, - build_epub=True, build_txt=True, build_pdf=True, build_mobi=True, build_fb2=True, - search_index=True, search_index_tags=True, search_index_reuse=False): - - # check for parts before we do anything - children = [] - if hasattr(book_info, 'parts'): - for part_url in book_info.parts: - try: - children.append(Book.objects.get(slug=part_url.slug)) - except Book.DoesNotExist: - raise Book.DoesNotExist(_('Book "%s" does not exist.') % - part_url.slug) - - - # Read book metadata - book_slug = book_info.url.slug - if re.search(r'[^a-z0-9-]', book_slug): - raise ValueError('Invalid characters in slug') - book, created = Book.objects.get_or_create(slug=book_slug) - - if created: - book_shelves = [] - else: - if not overwrite: - raise Book.AlreadyExists(_('Book %s already exists') % ( - book_slug)) - # Save shelves for this book - book_shelves = list(book.tags.filter(category='set')) - - 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.save() - - meta_tags = Tag.tags_from_info(book_info) - - book.tags = set(meta_tags + book_shelves) - - book_tag = book.book_tag() - - for n, child_book in enumerate(children): - child_book.parent = book - child_book.parent_number = n - child_book.save() - - # 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() - - if book.build_html(): - if not settings.NO_BUILD_TXT and build_txt: - book.build_txt() - - book.build_cover(book_info) - - if not settings.NO_BUILD_EPUB and build_epub: - book.build_epub() - - if not settings.NO_BUILD_PDF and build_pdf: - book.build_pdf() - - if not settings.NO_BUILD_MOBI and build_mobi: - book.build_mobi() - - if not settings.NO_BUILD_FB2 and build_fb2: - book.build_fb2() - - if not settings.NO_SEARCH_INDEX and search_index: - book.search_index(index_tags=search_index_tags, reuse_index=search_index_reuse) - #index_book.delay(book.id, book_info) - - book_descendants = list(book.children.all()) - descendants_tags = set() - # add l-tag to descendants and their fragments - while len(book_descendants) > 0: - child_book = book_descendants.pop(0) - descendants_tags.update(child_book.tags) - child_book.tags = list(child_book.tags) + [book_tag] - child_book.save() - for fragment in child_book.fragments.all().iterator(): - fragment.tags = set(list(fragment.tags) + [book_tag]) - book_descendants += list(child_book.children.all()) - - for tag in descendants_tags: - tasks.touch_tag(tag) - - book.save() - - # refresh cache - book.reset_tag_counter() - book.reset_theme_counter() - - cls.published.send(sender=book) - return book - - def related_info(self): - """Keeps info about related objects (tags, media) in cache field.""" - if self._related_info is not None: - return self._related_info - else: - rel = {'tags': {}, 'media': {}} - - tags = self.tags.filter(category__in=( - 'author', 'kind', 'genre', 'epoch')) - tags = split_tags(tags) - for category in tags: - rel['tags'][category] = [ - (t.name, t.slug) for t in tags[category]] - - for media_format in BookMedia.formats: - rel['media'][media_format] = self.has_media(media_format) - - book = self - parents = [] - while book.parent: - parents.append((book.parent.title, book.parent.slug)) - book = book.parent - parents = parents[::-1] - if parents: - rel['parents'] = parents - - if self.pk: - type(self).objects.filter(pk=self.pk).update(_related_info=rel) - return rel - - def related_themes(self): - theme_counter = self.theme_counter - book_themes = list(Tag.objects.filter(pk__in=theme_counter.keys())) - for tag in book_themes: - tag.count = theme_counter[tag.pk] - return book_themes - - def reset_tag_counter(self): - if self.id is None: - return - - cache_key = "Book.tag_counter/%d" % self.id - permanent_cache.delete(cache_key) - if self.parent: - self.parent.reset_tag_counter() - - @property - def tag_counter(self): - if self.id: - cache_key = "Book.tag_counter/%d" % self.id - tags = permanent_cache.get(cache_key) - else: - tags = None - - if tags is None: - tags = {} - for child in self.children.all().order_by().iterator(): - for tag_pk, value in child.tag_counter.iteritems(): - tags[tag_pk] = tags.get(tag_pk, 0) + value - for tag in self.tags.exclude(category__in=('book', 'theme', 'set')).order_by().iterator(): - tags[tag.pk] = 1 - - if self.id: - permanent_cache.set(cache_key, tags) - return tags - - def reset_theme_counter(self): - if self.id is None: - return - - cache_key = "Book.theme_counter/%d" % self.id - permanent_cache.delete(cache_key) - if self.parent: - self.parent.reset_theme_counter() - - @property - def theme_counter(self): - if self.id: - cache_key = "Book.theme_counter/%d" % self.id - tags = permanent_cache.get(cache_key) - else: - tags = None - - if tags is None: - tags = {} - for fragment in Fragment.tagged.with_any([self.book_tag()]).order_by().iterator(): - for tag in fragment.tags.filter(category='theme').order_by().iterator(): - tags[tag.pk] = tags.get(tag.pk, 0) + 1 - - if self.id: - permanent_cache.set(cache_key, tags) - return tags - - 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) - - @classmethod - def tagged_top_level(cls, tags): - """ Returns top-level books tagged with `tags`. - - It only returns those books which don't have ancestors which are - also tagged with those tags. - - """ - # get relevant books and their tags - objects = cls.tagged.with_all(tags) - # eliminate descendants - l_tags = Tag.objects.filter(category='book', - slug__in=[book.book_tag_slug() for book in objects.iterator()]) - descendants_keys = [book.pk for book in cls.tagged.with_any(l_tags).iterator()] - if descendants_keys: - objects = objects.exclude(pk__in=descendants_keys) - - return objects - - @classmethod - def book_list(cls, filter=None): - """Generates a hierarchical listing of all books. - - Books are optionally filtered with a test function. - - """ - - books_by_parent = {} - books = cls.objects.all().order_by('parent_number', 'sort_key').only( - 'title', 'parent', 'slug') - if filter: - books = books.filter(filter).distinct() - - book_ids = set(b['pk'] for b in books.values("pk").iterator()) - for book in books.iterator(): - parent = book.parent_id - if parent not in book_ids: - parent = None - books_by_parent.setdefault(parent, []).append(book) - else: - for book in books.iterator(): - books_by_parent.setdefault(book.parent_id, []).append(book) - - orphans = [] - books_by_author = SortedDict() - for tag in Tag.objects.filter(category='author').iterator(): - books_by_author[tag] = [] - - for book in books_by_parent.get(None,()): - authors = list(book.tags.filter(category='author')) - if authors: - for author in authors: - books_by_author[author].append(book) - else: - orphans.append(book) - - return books_by_author, orphans, books_by_parent - - _audiences_pl = { - "SP1": (1, u"szkoła podstawowa"), - "SP2": (1, u"szkoła podstawowa"), - "P": (1, u"szkoła podstawowa"), - "G": (2, u"gimnazjum"), - "L": (3, u"liceum"), - "LP": (3, u"liceum"), - } - def audiences_pl(self): - audiences = self.extra_info.get('audiences', []) - audiences = sorted(set([self._audiences_pl[a] for a in audiences])) - return [a[1] for a in audiences] - - def choose_fragment(self): - tag = self.book_tag() - fragments = Fragment.tagged.with_any([tag]) - if fragments.exists(): - return fragments.order_by('?')[0] - elif self.parent: - return self.parent.choose_fragment() - else: - return None - - -def _has_factory(ftype): - has = lambda self: bool(getattr(self, "%s_file" % ftype)) - has.short_description = ftype.upper() - has.__doc__ = None - has.boolean = True - has.__name__ = "has_%s_file" % ftype - return has - - -# add the file fields -for t in Book.formats: - field_name = "%s_file" % t - models.FileField(_("%s file" % t.upper()), - upload_to=book_upload_path(t), - blank=True).contribute_to_class(Book, field_name) - - setattr(Book, "has_%s_file" % t, _has_factory(t)) - - -class Fragment(models.Model): - """Represents a themed fragment of a book.""" - text = models.TextField() - short_text = models.TextField(editable=False) - anchor = models.CharField(max_length=120) - book = models.ForeignKey(Book, related_name='fragments') - - objects = models.Manager() - tagged = managers.ModelTaggedItemManager(Tag) - tags = managers.TagDescriptor(Tag) - - class Meta: - ordering = ('book', 'anchor',) - verbose_name = _('fragment') - verbose_name_plural = _('fragments') - - def get_absolute_url(self): - return '%s#m%s' % (reverse('book_text', args=[self.book.slug]), self.anchor) - - def reset_short_html(self): - if self.id is None: - return - - cache_key = "Fragment.short_html/%d/%s" - for lang, langname in settings.LANGUAGES: - permanent_cache.delete(cache_key % (self.id, lang)) - - def get_short_text(self): - """Returns short version of the fragment.""" - return self.short_text if self.short_text else self.text - - def short_html(self): - if self.id: - cache_key = "Fragment.short_html/%d/%s" % (self.id, get_language()) - short_html = permanent_cache.get(cache_key) - else: - short_html = None - - if short_html is not None: - return mark_safe(short_html) - else: - short_html = unicode(render_to_string('catalogue/fragment_short.html', - {'fragment': self})) - if self.id: - permanent_cache.set(cache_key, short_html) - return mark_safe(short_html) - - -class Collection(models.Model): - """A collection of books, which might be defined before publishing them.""" - title = models.CharField(_('title'), max_length=120, db_index=True) - slug = models.SlugField(_('slug'), max_length=120, primary_key=True) - description = models.TextField(_('description'), null=True, blank=True) - - models.SlugField(_('slug'), max_length=120, unique=True, db_index=True) - book_slugs = models.TextField(_('book slugs')) - - class Meta: - ordering = ('title',) - verbose_name = _('collection') - verbose_name_plural = _('collections') - - def __unicode__(self): - return self.title - - -########### -# -# SIGNALS -# -########### - - -def _tags_updated_handler(sender, affected_tags, **kwargs): - # reset tag global counter - # we want Tag.changed_at updated for API to know the tag was touched - for tag in affected_tags: - tasks.touch_tag(tag) - - # if book tags changed, reset book tag counter - if isinstance(sender, Book) and \ - Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\ - exclude(category__in=('book', 'theme', 'set')).count(): - sender.reset_tag_counter() - # if fragment theme changed, reset book theme counter - elif isinstance(sender, Fragment) and \ - Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\ - filter(category='theme').count(): - 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) - - -if not settings.NO_SEARCH_INDEX: - @django.dispatch.receiver(post_delete, sender=Book) - def _remove_book_from_index_handler(sender, instance, **kwargs): - """ remove the book from search index, when it is deleted.""" - import search - search.JVM.attachCurrentThread() - idx = search.Index() - idx.open(timeout=10000) # 10 seconds timeout. - try: - idx.remove_book(instance) - idx.index_tags() - finally: - idx.close() diff --git a/apps/catalogue/models/__init__.py b/apps/catalogue/models/__init__.py new file mode 100644 index 000000000..541ab5c8c --- /dev/null +++ b/apps/catalogue/models/__init__.py @@ -0,0 +1,10 @@ +# -*- 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 catalogue.models.tag import Tag +from catalogue.models.bookmedia import BookMedia +from catalogue.models.fragment import Fragment +from catalogue.models.book import Book +from catalogue.models.collection import Collection +from catalogue.models.listeners import * diff --git a/apps/catalogue/models/book.py b/apps/catalogue/models/book.py new file mode 100644 index 000000000..4b50fc9fc --- /dev/null +++ b/apps/catalogue/models/book.py @@ -0,0 +1,614 @@ +# -*- 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. +# +import re +from django.conf import settings +from django.core.cache import get_cache +from django.db import models +from django.db.models import permalink +import django.dispatch +from django.utils.datastructures import SortedDict +from django.utils.translation import ugettext_lazy as _ +import jsonfield +from catalogue.models import Tag, Fragment, BookMedia +from catalogue.utils import create_zip, split_tags, truncate_html_words, book_upload_path +from catalogue import tasks +from newtagging import managers + + +permanent_cache = get_cache('permanent') + + +class Book(models.Model): + """Represents a book imported from WL-XML.""" + title = models.CharField(_('title'), max_length=120) + sort_key = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False) + 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=settings.CATALOGUE_DEFAULT_LANGUAGE) + description = models.TextField(_('description'), blank=True) + created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True) + changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True) + parent_number = models.IntegerField(_('parent number'), default=0) + extra_info = jsonfield.JSONField(_('extra information'), default='{}') + gazeta_link = models.CharField(blank=True, max_length=240) + wiki_link = models.CharField(blank=True, max_length=240) + # files generated during publication + + cover = models.FileField(_('cover'), upload_to=book_upload_path('png'), + null=True, blank=True) + ebook_formats = ['pdf', 'epub', 'mobi', 'fb2', 'txt'] + formats = ebook_formats + ['html', 'xml'] + + parent = models.ForeignKey('self', blank=True, null=True, related_name='children') + + _related_info = jsonfield.JSONField(blank=True, null=True, editable=False) + + objects = models.Manager() + tagged = managers.ModelTaggedItemManager(Tag) + tags = managers.TagDescriptor(Tag) + + html_built = django.dispatch.Signal() + published = django.dispatch.Signal() + + class AlreadyExists(Exception): + pass + + class Meta: + ordering = ('sort_key',) + verbose_name = _('book') + verbose_name_plural = _('books') + app_label = 'catalogue' + + def __unicode__(self): + return self.title + + def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs): + from sortify import sortify + + self.sort_key = sortify(self.title) + + ret = super(Book, self).save(force_insert, force_update) + + if reset_short_html: + self.reset_short_html() + + return ret + + @permalink + def get_absolute_url(self): + return ('catalogue.views.book_detail', [self.slug]) + + @property + def name(self): + return self.title + + def book_tag_slug(self): + return ('l-' + self.slug)[:120] + + def book_tag(self): + slug = self.book_tag_slug() + book_tag, created = Tag.objects.get_or_create(slug=slug, category='book') + if created: + book_tag.name = self.title[:50] + book_tag.sort_key = self.title.lower() + book_tag.save() + return book_tag + + def has_media(self, type_): + if type_ in Book.formats: + return bool(getattr(self, "%s_file" % type_)) + else: + return self.media.filter(type=type_).exists() + + def get_media(self, type_): + if self.has_media(type_): + if type_ in Book.formats: + return getattr(self, "%s_file" % type_) + else: + return self.media.filter(type=type_) + else: + return None + + def get_mp3(self): + return self.get_media("mp3") + def get_odt(self): + return self.get_media("odt") + def get_ogg(self): + return self.get_media("ogg") + def get_daisy(self): + return self.get_media("daisy") + + def reset_short_html(self): + if self.id is None: + return + + type(self).objects.filter(pk=self.pk).update(_related_info=None) + # Fragment.short_html relies on book's tags, so reset it here too + for fragm in self.fragments.all().iterator(): + fragm.reset_short_html() + + def has_description(self): + return len(self.description) > 0 + has_description.short_description = _('description') + has_description.boolean = True + + # ugly ugly ugly + def has_mp3_file(self): + return bool(self.has_media("mp3")) + has_mp3_file.short_description = 'MP3' + has_mp3_file.boolean = True + + def has_ogg_file(self): + return bool(self.has_media("ogg")) + has_ogg_file.short_description = 'OGG' + has_ogg_file.boolean = True + + def has_daisy_file(self): + return bool(self.has_media("daisy")) + has_daisy_file.short_description = 'DAISY' + has_daisy_file.boolean = True + + def wldocument(self, parse_dublincore=True): + from catalogue.import_utils import ORMDocProvider + from librarian.parser import WLDocument + + return WLDocument.from_file(self.xml_file.path, + provider=ORMDocProvider(self), + parse_dublincore=parse_dublincore) + + def build_cover(self, book_info=None): + """(Re)builds the cover image.""" + from StringIO import StringIO + from django.core.files.base import ContentFile + from librarian.cover import WLCover + + if book_info is None: + book_info = self.wldocument().book_info + + cover = WLCover(book_info).image() + imgstr = StringIO() + cover.save(imgstr, 'png') + self.cover.save(None, ContentFile(imgstr.getvalue())) + + def build_html(self): + from django.core.files.base import ContentFile + from slughifi import slughifi + from sortify import sortify + from librarian import html + + meta_tags = list(self.tags.filter( + category__in=('author', 'epoch', 'genre', 'kind'))) + book_tag = self.book_tag() + + html_output = self.wldocument(parse_dublincore=False).as_html() + if html_output: + self.html_file.save('%s.html' % self.slug, + ContentFile(html_output.get_string())) + + # get ancestor l-tags for adding to new fragments + ancestor_tags = [] + p = self.parent + while p: + ancestor_tags.append(p.book_tag()) + p = p.parent + + # Delete old fragments and create them from scratch + self.fragments.all().delete() + # Extract fragments + closed_fragments, open_fragments = html.extract_fragments(self.html_file.path) + for fragment in closed_fragments.values(): + try: + theme_names = [s.strip() for s in fragment.themes.split(',')] + except AttributeError: + continue + themes = [] + for theme_name in theme_names: + if not theme_name: + continue + tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme') + if created: + tag.name = theme_name + tag.sort_key = sortify(theme_name.lower()) + tag.save() + themes.append(tag) + if not themes: + continue + + text = fragment.to_string() + short_text = truncate_html_words(text, 15) + if text == short_text: + short_text = '' + new_fragment = Fragment.objects.create(anchor=fragment.id, book=self, + text=text, short_text=short_text) + + new_fragment.save() + new_fragment.tags = set(meta_tags + themes + [book_tag] + ancestor_tags) + self.save() + self.html_built.send(sender=self) + return True + return False + + # Thin wrappers for builder tasks + def build_pdf(self, *args, **kwargs): + """(Re)builds PDF.""" + return tasks.build_pdf.delay(self.pk, *args, **kwargs) + def build_epub(self, *args, **kwargs): + """(Re)builds EPUB.""" + return tasks.build_epub.delay(self.pk, *args, **kwargs) + def build_mobi(self, *args, **kwargs): + """(Re)builds MOBI.""" + return tasks.build_mobi.delay(self.pk, *args, **kwargs) + def build_fb2(self, *args, **kwargs): + """(Re)build FB2""" + return tasks.build_fb2.delay(self.pk, *args, **kwargs) + def build_txt(self, *args, **kwargs): + """(Re)builds TXT.""" + return tasks.build_txt.delay(self.pk, *args, **kwargs) + + @staticmethod + def zip_format(format_): + def pretty_file_name(book): + return "%s/%s.%s" % ( + b.extra_info['author'], + b.slug, + format_) + + field_name = "%s_file" % format_ + books = Book.objects.filter(parent=None).exclude(**{field_name: ""}) + paths = [(pretty_file_name(b), getattr(b, field_name).path) + for b in books.iterator()] + return create_zip(paths, + getattr(settings, "ALL_%s_ZIP" % format_.upper())) + + def zip_audiobooks(self, format_): + bm = BookMedia.objects.filter(book=self, type=format_) + paths = map(lambda bm: (None, bm.file.path), bm) + return create_zip(paths, "%s_%s" % (self.slug, format_)) + + def search_index(self, book_info=None, reuse_index=False, index_tags=True): + import search + if reuse_index: + idx = search.ReusableIndex() + else: + idx = search.Index() + + idx.open() + try: + idx.index_book(self, book_info) + if index_tags: + idx.index_tags() + finally: + idx.close() + + @classmethod + def from_xml_file(cls, xml_file, **kwargs): + from django.core.files import File + from librarian import dcparser + + # use librarian to parse meta-data + book_info = dcparser.parse(xml_file) + + if not isinstance(xml_file, File): + xml_file = File(open(xml_file)) + + try: + 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, + build_epub=True, build_txt=True, build_pdf=True, build_mobi=True, build_fb2=True, + search_index=True, search_index_tags=True, search_index_reuse=False): + + # check for parts before we do anything + children = [] + if hasattr(book_info, 'parts'): + for part_url in book_info.parts: + try: + children.append(Book.objects.get(slug=part_url.slug)) + except Book.DoesNotExist: + raise Book.DoesNotExist(_('Book "%s" does not exist.') % + part_url.slug) + + + # Read book metadata + book_slug = book_info.url.slug + if re.search(r'[^a-z0-9-]', book_slug): + raise ValueError('Invalid characters in slug') + book, created = Book.objects.get_or_create(slug=book_slug) + + if created: + book_shelves = [] + else: + if not overwrite: + raise Book.AlreadyExists(_('Book %s already exists') % ( + book_slug)) + # Save shelves for this book + book_shelves = list(book.tags.filter(category='set')) + + 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.save() + + meta_tags = Tag.tags_from_info(book_info) + + book.tags = set(meta_tags + book_shelves) + + book_tag = book.book_tag() + + for n, child_book in enumerate(children): + child_book.parent = book + child_book.parent_number = n + child_book.save() + + # 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() + + if book.build_html(): + if not settings.NO_BUILD_TXT and build_txt: + book.build_txt() + + book.build_cover(book_info) + + if not settings.NO_BUILD_EPUB and build_epub: + book.build_epub() + + if not settings.NO_BUILD_PDF and build_pdf: + book.build_pdf() + + if not settings.NO_BUILD_MOBI and build_mobi: + book.build_mobi() + + if not settings.NO_BUILD_FB2 and build_fb2: + book.build_fb2() + + if not settings.NO_SEARCH_INDEX and search_index: + book.search_index(index_tags=search_index_tags, reuse_index=search_index_reuse) + #index_book.delay(book.id, book_info) + + book_descendants = list(book.children.all()) + descendants_tags = set() + # add l-tag to descendants and their fragments + while len(book_descendants) > 0: + child_book = book_descendants.pop(0) + descendants_tags.update(child_book.tags) + child_book.tags = list(child_book.tags) + [book_tag] + child_book.save() + for fragment in child_book.fragments.all().iterator(): + fragment.tags = set(list(fragment.tags) + [book_tag]) + book_descendants += list(child_book.children.all()) + + for tag in descendants_tags: + tasks.touch_tag(tag) + + book.save() + + # refresh cache + book.reset_tag_counter() + book.reset_theme_counter() + + cls.published.send(sender=book) + return book + + def related_info(self): + """Keeps info about related objects (tags, media) in cache field.""" + if self._related_info is not None: + return self._related_info + else: + rel = {'tags': {}, 'media': {}} + + tags = self.tags.filter(category__in=( + 'author', 'kind', 'genre', 'epoch')) + tags = split_tags(tags) + for category in tags: + rel['tags'][category] = [ + (t.name, t.slug) for t in tags[category]] + + for media_format in BookMedia.formats: + rel['media'][media_format] = self.has_media(media_format) + + book = self + parents = [] + while book.parent: + parents.append((book.parent.title, book.parent.slug)) + book = book.parent + parents = parents[::-1] + if parents: + rel['parents'] = parents + + if self.pk: + type(self).objects.filter(pk=self.pk).update(_related_info=rel) + return rel + + def related_themes(self): + theme_counter = self.theme_counter + book_themes = list(Tag.objects.filter(pk__in=theme_counter.keys())) + for tag in book_themes: + tag.count = theme_counter[tag.pk] + return book_themes + + def reset_tag_counter(self): + if self.id is None: + return + + cache_key = "Book.tag_counter/%d" % self.id + permanent_cache.delete(cache_key) + if self.parent: + self.parent.reset_tag_counter() + + @property + def tag_counter(self): + if self.id: + cache_key = "Book.tag_counter/%d" % self.id + tags = permanent_cache.get(cache_key) + else: + tags = None + + if tags is None: + tags = {} + for child in self.children.all().order_by().iterator(): + for tag_pk, value in child.tag_counter.iteritems(): + tags[tag_pk] = tags.get(tag_pk, 0) + value + for tag in self.tags.exclude(category__in=('book', 'theme', 'set')).order_by().iterator(): + tags[tag.pk] = 1 + + if self.id: + permanent_cache.set(cache_key, tags) + return tags + + def reset_theme_counter(self): + if self.id is None: + return + + cache_key = "Book.theme_counter/%d" % self.id + permanent_cache.delete(cache_key) + if self.parent: + self.parent.reset_theme_counter() + + @property + def theme_counter(self): + if self.id: + cache_key = "Book.theme_counter/%d" % self.id + tags = permanent_cache.get(cache_key) + else: + tags = None + + if tags is None: + tags = {} + for fragment in Fragment.tagged.with_any([self.book_tag()]).order_by().iterator(): + for tag in fragment.tags.filter(category='theme').order_by().iterator(): + tags[tag.pk] = tags.get(tag.pk, 0) + 1 + + if self.id: + permanent_cache.set(cache_key, tags) + return tags + + 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) + + @classmethod + def tagged_top_level(cls, tags): + """ Returns top-level books tagged with `tags`. + + It only returns those books which don't have ancestors which are + also tagged with those tags. + + """ + # get relevant books and their tags + objects = cls.tagged.with_all(tags) + # eliminate descendants + l_tags = Tag.objects.filter(category='book', + slug__in=[book.book_tag_slug() for book in objects.iterator()]) + descendants_keys = [book.pk for book in cls.tagged.with_any(l_tags).iterator()] + if descendants_keys: + objects = objects.exclude(pk__in=descendants_keys) + + return objects + + @classmethod + def book_list(cls, filter=None): + """Generates a hierarchical listing of all books. + + Books are optionally filtered with a test function. + + """ + + books_by_parent = {} + books = cls.objects.all().order_by('parent_number', 'sort_key').only( + 'title', 'parent', 'slug') + if filter: + books = books.filter(filter).distinct() + + book_ids = set(b['pk'] for b in books.values("pk").iterator()) + for book in books.iterator(): + parent = book.parent_id + if parent not in book_ids: + parent = None + books_by_parent.setdefault(parent, []).append(book) + else: + for book in books.iterator(): + books_by_parent.setdefault(book.parent_id, []).append(book) + + orphans = [] + books_by_author = SortedDict() + for tag in Tag.objects.filter(category='author').iterator(): + books_by_author[tag] = [] + + for book in books_by_parent.get(None,()): + authors = list(book.tags.filter(category='author')) + if authors: + for author in authors: + books_by_author[author].append(book) + else: + orphans.append(book) + + return books_by_author, orphans, books_by_parent + + _audiences_pl = { + "SP1": (1, u"szkoła podstawowa"), + "SP2": (1, u"szkoła podstawowa"), + "P": (1, u"szkoła podstawowa"), + "G": (2, u"gimnazjum"), + "L": (3, u"liceum"), + "LP": (3, u"liceum"), + } + def audiences_pl(self): + audiences = self.extra_info.get('audiences', []) + audiences = sorted(set([self._audiences_pl[a] for a in audiences])) + return [a[1] for a in audiences] + + def choose_fragment(self): + tag = self.book_tag() + fragments = Fragment.tagged.with_any([tag]) + if fragments.exists(): + return fragments.order_by('?')[0] + elif self.parent: + return self.parent.choose_fragment() + else: + return None + + +def _has_factory(ftype): + has = lambda self: bool(getattr(self, "%s_file" % ftype)) + has.short_description = ftype.upper() + has.__doc__ = None + has.boolean = True + has.__name__ = "has_%s_file" % ftype + return has + + +# add the file fields +for t in Book.formats: + field_name = "%s_file" % t + models.FileField(_("%s file" % t.upper()), + upload_to=book_upload_path(t), + blank=True).contribute_to_class(Book, field_name) + + setattr(Book, "has_%s_file" % t, _has_factory(t)) diff --git a/apps/catalogue/models/bookmedia.py b/apps/catalogue/models/bookmedia.py new file mode 100644 index 000000000..024f713c2 --- /dev/null +++ b/apps/catalogue/models/bookmedia.py @@ -0,0 +1,123 @@ +# -*- 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 namedtuple +from django.db import models +from django.utils.translation import ugettext_lazy as _ +from django.utils.datastructures import SortedDict +import jsonfield +from catalogue.fields import OverwritingFileField +from catalogue.utils import book_upload_path + + +class BookMedia(models.Model): + """Represents media attached to a book.""" + FileFormat = namedtuple("FileFormat", "name ext") + formats = SortedDict([ + ('mp3', FileFormat(name='MP3', ext='mp3')), + ('ogg', FileFormat(name='Ogg Vorbis', ext='ogg')), + ('daisy', FileFormat(name='DAISY', ext='daisy.zip')), + ]) + format_choices = [(k, _('%s file') % t.name) + for k, t in formats.items()] + + type = models.CharField(_('type'), choices=format_choices, max_length="100") + name = models.CharField(_('name'), max_length="100") + file = OverwritingFileField(_('file'), upload_to=book_upload_path()) + uploaded_at = models.DateTimeField(_('creation date'), auto_now_add=True, editable=False) + extra_info = jsonfield.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]) + + class Meta: + ordering = ('type', 'name') + verbose_name = _('book media') + verbose_name_plural = _('book media') + app_label = 'catalogue' + + def save(self, *args, **kwargs): + from slughifi import slughifi + from catalogue.utils import ExistingFile, remove_zip + + try: + old = BookMedia.objects.get(pk=self.pk) + except BookMedia.DoesNotExist: + old = None + else: + # if name changed, change the file name, too + if slughifi(self.name) != slughifi(old.name): + self.file.save(None, ExistingFile(self.file.path), save=False, leave=True) + + super(BookMedia, self).save(*args, **kwargs) + + # remove the zip package for book with modified media + if old: + remove_zip("%s_%s" % (old.book.slug, old.type)) + remove_zip("%s_%s" % (self.book.slug, self.type)) + + extra_info = self.extra_info + extra_info.update(self.read_meta()) + self.extra_info = 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. + """ + import mutagen + from mutagen import id3 + + 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. + """ + import mutagen + from mutagen import id3 + + 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 diff --git a/apps/catalogue/models/collection.py b/apps/catalogue/models/collection.py new file mode 100644 index 000000000..1c9027c31 --- /dev/null +++ b/apps/catalogue/models/collection.py @@ -0,0 +1,25 @@ +# -*- 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 django.db import models +from django.utils.translation import ugettext_lazy as _ + + +class Collection(models.Model): + """A collection of books, which might be defined before publishing them.""" + title = models.CharField(_('title'), max_length=120, db_index=True) + slug = models.SlugField(_('slug'), max_length=120, primary_key=True) + description = models.TextField(_('description'), null=True, blank=True) + + models.SlugField(_('slug'), max_length=120, unique=True, db_index=True) + book_slugs = models.TextField(_('book slugs')) + + class Meta: + ordering = ('title',) + verbose_name = _('collection') + verbose_name_plural = _('collections') + app_label = 'catalogue' + + def __unicode__(self): + return self.title diff --git a/apps/catalogue/models/fragment.py b/apps/catalogue/models/fragment.py new file mode 100644 index 000000000..c9131aa49 --- /dev/null +++ b/apps/catalogue/models/fragment.py @@ -0,0 +1,65 @@ +# -*- 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 django.conf import settings +from django.core.cache import get_cache +from django.core.urlresolvers import reverse +from django.db import models +from django.template.loader import render_to_string +from django.utils.safestring import mark_safe +from django.utils.translation import get_language, ugettext_lazy as _ +from newtagging import managers +from catalogue.models import Tag + + +permanent_cache = get_cache('permanent') + + +class Fragment(models.Model): + """Represents a themed fragment of a book.""" + text = models.TextField() + short_text = models.TextField(editable=False) + anchor = models.CharField(max_length=120) + book = models.ForeignKey('Book', related_name='fragments') + + objects = models.Manager() + tagged = managers.ModelTaggedItemManager(Tag) + tags = managers.TagDescriptor(Tag) + + class Meta: + ordering = ('book', 'anchor',) + verbose_name = _('fragment') + verbose_name_plural = _('fragments') + app_label = 'catalogue' + + def get_absolute_url(self): + return '%s#m%s' % (reverse('book_text', args=[self.book.slug]), self.anchor) + + def reset_short_html(self): + if self.id is None: + return + + cache_key = "Fragment.short_html/%d/%s" + for lang, langname in settings.LANGUAGES: + permanent_cache.delete(cache_key % (self.id, lang)) + + def get_short_text(self): + """Returns short version of the fragment.""" + return self.short_text if self.short_text else self.text + + def short_html(self): + if self.id: + cache_key = "Fragment.short_html/%d/%s" % (self.id, get_language()) + short_html = permanent_cache.get(cache_key) + else: + short_html = None + + if short_html is not None: + return mark_safe(short_html) + else: + short_html = unicode(render_to_string('catalogue/fragment_short.html', + {'fragment': self})) + if self.id: + permanent_cache.set(cache_key, short_html) + return mark_safe(short_html) diff --git a/apps/catalogue/models/listeners.py b/apps/catalogue/models/listeners.py new file mode 100644 index 000000000..9e9fcabff --- /dev/null +++ b/apps/catalogue/models/listeners.py @@ -0,0 +1,58 @@ +# -*- 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 django.conf import settings +from django.db.models.signals import post_save, pre_delete, post_delete +import django.dispatch +from catalogue.models import Tag, BookMedia, Book, Fragment +from catalogue import tasks +from newtagging.models import tags_updated + + +def _tags_updated_handler(sender, affected_tags, **kwargs): + # reset tag global counter + # we want Tag.changed_at updated for API to know the tag was touched + for tag in affected_tags: + tasks.touch_tag(tag) + + # if book tags changed, reset book tag counter + if isinstance(sender, Book) and \ + Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\ + exclude(category__in=('book', 'theme', 'set')).count(): + sender.reset_tag_counter() + # if fragment theme changed, reset book theme counter + elif isinstance(sender, Fragment) and \ + Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\ + filter(category='theme').count(): + 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) + + +if not settings.NO_SEARCH_INDEX: + @django.dispatch.receiver(post_delete, sender=Book) + def _remove_book_from_index_handler(sender, instance, **kwargs): + """ remove the book from search index, when it is deleted.""" + import search + search.JVM.attachCurrentThread() + idx = search.Index() + idx.open(timeout=10000) # 10 seconds timeout. + try: + idx.remove_book(instance) + idx.index_tags() + finally: + idx.close() diff --git a/apps/catalogue/models/tag.py b/apps/catalogue/models/tag.py new file mode 100644 index 000000000..353d567bb --- /dev/null +++ b/apps/catalogue/models/tag.py @@ -0,0 +1,166 @@ +# -*- 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 django.contrib.auth.models import User +from django.db import models +from django.db.models import permalink +from django.utils.translation import ugettext_lazy as _ +from newtagging.models import TagBase + + +# Those are hard-coded here so that makemessages sees them. +TAG_CATEGORIES = ( + ('author', _('author')), + ('epoch', _('epoch')), + ('kind', _('kind')), + ('genre', _('genre')), + ('theme', _('theme')), + ('set', _('set')), + ('book', _('book')), +) + + +class Tag(TagBase): + """A tag attachable to books and fragments (and possibly anything). + + Used to represent searchable metadata (authors, epochs, genres, kinds), + fragment themes (motifs) and some book hierarchy related kludges.""" + name = models.CharField(_('name'), max_length=50, db_index=True) + slug = models.SlugField(_('slug'), 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) + + user = models.ForeignKey(User, 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) + + created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True) + changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True) + + class UrlDeprecationWarning(DeprecationWarning): + pass + + categories_rev = { + 'autor': 'author', + 'epoka': 'epoch', + 'rodzaj': 'kind', + 'gatunek': 'genre', + 'motyw': 'theme', + 'polka': 'set', + } + categories_dict = dict((item[::-1] for item in categories_rev.iteritems())) + + class Meta: + ordering = ('sort_key',) + verbose_name = _('tag') + verbose_name_plural = _('tags') + unique_together = (("slug", "category"),) + app_label = 'catalogue' + + def __unicode__(self): + return self.name + + def __repr__(self): + return "Tag(slug=%r)" % self.slug + + @permalink + def get_absolute_url(self): + return ('catalogue.views.tagged_object_list', [self.url_chunk]) + + def has_description(self): + return len(self.description) > 0 + has_description.short_description = _('description') + has_description.boolean = True + + def get_count(self): + """Returns global book count for book tags, fragment count for themes.""" + from catalogue.models import Book, Fragment + + if self.category == 'book': + # never used + objects = Book.objects.none() + elif self.category == 'theme': + objects = Fragment.tagged.with_all((self,)) + else: + objects = Book.tagged.with_all((self,)).order_by() + if self.category != 'set': + # eliminate descendants + l_tags = Tag.objects.filter(slug__in=[book.book_tag_slug() for book in objects.iterator()]) + descendants_keys = [book.pk for book in Book.tagged.with_any(l_tags).iterator()] + if descendants_keys: + objects = objects.exclude(pk__in=descendants_keys) + return objects.count() + + @staticmethod + def get_tag_list(tags): + if isinstance(tags, basestring): + real_tags = [] + ambiguous_slugs = [] + category = None + deprecated = False + tags_splitted = tags.split('/') + 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: + 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 + raise Tag.DoesNotExist() + if ambiguous_slugs: + # some tags should be qualified + e = Tag.MultipleObjectsReturned() + e.tags = real_tags + e.ambiguous_slugs = ambiguous_slugs + raise e + if deprecated: + e = Tag.UrlDeprecationWarning() + e.tags = real_tags + raise e + return real_tags + else: + return TagBase.get_tag_list(tags) + + @property + def url_chunk(self): + return '/'.join((Tag.categories_dict[self.category], self.slug)) + + @staticmethod + def tags_from_info(info): + from slughifi import slughifi + from sortify import sortify + meta_tags = [] + categories = (('kinds', 'kind'), ('genres', 'genre'), ('authors', 'author'), ('epochs', 'epoch')) + for field_name, category in categories: + try: + tag_names = getattr(info, field_name) + except: + try: + tag_names = [getattr(info, category)] + except: + # For instance, Pictures do not have 'genre' field. + continue + for tag_name in tag_names: + tag_sort_key = tag_name + if category == 'author': + tag_sort_key = tag_name.last_name + tag_name = tag_name.readable() + tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category) + if created: + tag.name = tag_name + tag.sort_key = sortify(tag_sort_key.lower()) + tag.save() + meta_tags.append(tag) + return meta_tags diff --git a/apps/catalogue/tasks.py b/apps/catalogue/tasks.py old mode 100755 new mode 100644 diff --git a/apps/catalogue/tests/book_import.py b/apps/catalogue/tests/book_import.py index 6ece3287e..904c1bf1d 100644 --- a/apps/catalogue/tests/book_import.py +++ b/apps/catalogue/tests/book_import.py @@ -297,7 +297,7 @@ class BookImportGenerateTest(WLTestCase): self.assertTrue(path.exists(parent.pdf_file.path)) def test_custom_pdf(self): - from catalogue.tasks import build_custom_pdf + from catalogue.utils import build_custom_pdf out = models.get_dynamic_path(None, 'test-custom', ext='pdf') absoulute_path = path.join(settings.MEDIA_ROOT, out) diff --git a/apps/catalogue/utils.py b/apps/catalogue/utils.py index 29f40d16b..bda7e0475 100644 --- a/apps/catalogue/utils.py +++ b/apps/catalogue/utils.py @@ -44,6 +44,25 @@ def split_tags(tags): return result +def get_dynamic_path(media, filename, ext=None, maxlen=100): + from slughifi import slughifi + + # how to put related book's slug here? + if not ext: + # BookMedia case + ext = media.formats[media.type].ext + if media is None or 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) + + +# TODO: why is this hard-coded ? +def book_upload_path(ext=None, maxlen=100): + return lambda *args: get_dynamic_path(*args, ext=ext, maxlen=maxlen) + + class ExistingFile(UploadedFile): def __init__(self, path, *args, **kwargs): diff --git a/apps/newtagging/models.py b/apps/newtagging/models.py index 6d05e287e..7e0f949f1 100644 --- a/apps/newtagging/models.py +++ b/apps/newtagging/models.py @@ -516,6 +516,7 @@ def create_intermediary_table_model(model): class Meta: db_table = '%s_relation' % model._meta.db_table unique_together = (('tag', 'content_type', 'object_id'),) + app_label = model._meta.app_label def obj_unicode(self): try: diff --git a/requirements-dev.txt b/requirements-dev.txt old mode 100755 new mode 100644