X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/ce8bb4b693d45e5e33f94cbf5fb381acb8d593ad..357027375ff8867f42ca34bcbfb5a78b5b185fc3:/apps/catalogue/models/book.py diff --git a/apps/catalogue/models/book.py b/apps/catalogue/models/book.py deleted file mode 100644 index a8b342d74..000000000 --- a/apps/catalogue/models/book.py +++ /dev/null @@ -1,636 +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. -# -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) - - obsolete_children = set(b for b in book.children.all() if b not in children) - for n, child_book in enumerate(children): - child_book.parent = book - child_book.parent_number = n - child_book.save() - # Disown unfaithful children and let them cope on their own. - for child in obsolete_children: - child.parent = None - child.parent_number = 0 - child.save() - tasks.fix_tree_tags.delay(child) - - # Save XML and HTML files - book.xml_file.save('%s.xml' % book.slug, raw_file, save=False) - book.build_cover(book_info) - - # delete old fragments when overwriting - book.fragments.all().delete() - - if book.build_html(): - # No direct saves behind this point. - if not settings.NO_BUILD_TXT and build_txt: - book.build_txt() - - 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) - - tasks.fix_tree_tags.delay(book) - cls.published.send(sender=book) - return book - - def fix_tree_tags(self): - """Fixes the l-tags on the book's subtree. - - Makes sure that: - * the book has its parents book-tags, - * its fragments have the book's and its parents book-tags, - * runs those for every child book too, - * touches all relevant tags, - * resets tag and theme counter on the book and its ancestry. - """ - def fix_subtree(book, parent_tags): - affected_tags = set(book.tags) - book.tags = list(book.tags.exclude(category='book')) + parent_tags - sub_parent_tags = parent_tags + [book.book_tag()] - for frag in book.fragments.all(): - affected_tags.update(frag.tags) - frag.tags = list(frag.tags.exclude(category='book')) + sub_parent_tags - for child in book.children.all(): - affected_tags.update(fix_subtree(child, sub_parent_tags)) - return affected_tags - - parent_tags = [] - parent = self.parent - while parent is not None: - parent_tags.append(parent.book_tag()) - parent = parent.parent - - affected_tags = fix_subtree(self, parent_tags) - for tag in affected_tags: - tasks.touch_tag(tag) - - book = self - while book is not None: - book.reset_tag_counter() - book.reset_theme_counter() - book = book.parent - - 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))