1 # -*- coding: utf-8 -*-
2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 from collections import namedtuple
7 from django.db import models
8 from django.db.models import permalink, Q
10 from django.core.cache import cache
11 from django.core.files.storage import DefaultStorage
12 from django.utils.translation import ugettext_lazy as _
13 from django.contrib.auth.models import User
14 from django.template.loader import render_to_string
15 from django.utils.datastructures import SortedDict
16 from django.utils.safestring import mark_safe
17 from django.utils.translation import get_language
18 from django.core.urlresolvers import reverse
19 from django.db.models.signals import post_save, m2m_changed, pre_delete
21 from django.conf import settings
23 from newtagging.models import TagBase, tags_updated
24 from newtagging import managers
25 from catalogue.fields import JSONField, OverwritingFileField
26 from catalogue.utils import create_zip, split_tags
27 from catalogue.tasks import touch_tag, index_book
28 from shutil import copy
37 ('author', _('author')),
38 ('epoch', _('epoch')),
40 ('genre', _('genre')),
41 ('theme', _('theme')),
46 # not quite, but Django wants you to set a timeout
47 CACHE_FOREVER = 2419200 # 28 days
50 class TagSubcategoryManager(models.Manager):
51 def __init__(self, subcategory):
52 super(TagSubcategoryManager, self).__init__()
53 self.subcategory = subcategory
55 def get_query_set(self):
56 return super(TagSubcategoryManager, self).get_query_set().filter(category=self.subcategory)
60 name = models.CharField(_('name'), max_length=50, db_index=True)
61 slug = models.SlugField(_('slug'), max_length=120, db_index=True)
62 sort_key = models.CharField(_('sort key'), max_length=120, db_index=True)
63 category = models.CharField(_('category'), max_length=50, blank=False, null=False,
64 db_index=True, choices=TAG_CATEGORIES)
65 description = models.TextField(_('description'), blank=True)
67 user = models.ForeignKey(User, blank=True, null=True)
68 book_count = models.IntegerField(_('book count'), blank=True, null=True)
69 gazeta_link = models.CharField(blank=True, max_length=240)
70 wiki_link = models.CharField(blank=True, max_length=240)
72 created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
73 changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True)
75 class UrlDeprecationWarning(DeprecationWarning):
86 categories_dict = dict((item[::-1] for item in categories_rev.iteritems()))
89 ordering = ('sort_key',)
90 verbose_name = _('tag')
91 verbose_name_plural = _('tags')
92 unique_together = (("slug", "category"),)
94 def __unicode__(self):
98 return "Tag(slug=%r)" % self.slug
101 def get_absolute_url(self):
102 return ('catalogue.views.tagged_object_list', [self.url_chunk])
104 def has_description(self):
105 return len(self.description) > 0
106 has_description.short_description = _('description')
107 has_description.boolean = True
110 """Returns global book count for book tags, fragment count for themes."""
112 if self.category == 'book':
114 objects = Book.objects.none()
115 elif self.category == 'theme':
116 objects = Fragment.tagged.with_all((self,))
118 objects = Book.tagged.with_all((self,)).order_by()
119 if self.category != 'set':
120 # eliminate descendants
121 l_tags = Tag.objects.filter(slug__in=[book.book_tag_slug() for book in objects])
122 descendants_keys = [book.pk for book in Book.tagged.with_any(l_tags)]
124 objects = objects.exclude(pk__in=descendants_keys)
125 return objects.count()
128 def get_tag_list(tags):
129 if isinstance(tags, basestring):
134 tags_splitted = tags.split('/')
135 for name in tags_splitted:
137 real_tags.append(Tag.objects.get(slug=name, category=category))
139 elif name in Tag.categories_rev:
140 category = Tag.categories_rev[name]
143 real_tags.append(Tag.objects.exclude(category='book').get(slug=name))
145 except Tag.MultipleObjectsReturned, e:
146 ambiguous_slugs.append(name)
149 # something strange left off
150 raise Tag.DoesNotExist()
152 # some tags should be qualified
153 e = Tag.MultipleObjectsReturned()
155 e.ambiguous_slugs = ambiguous_slugs
158 e = Tag.UrlDeprecationWarning()
163 return TagBase.get_tag_list(tags)
167 return '/'.join((Tag.categories_dict[self.category], self.slug))
170 def tags_from_info(info):
171 from slughifi import slughifi
172 from sortify import sortify
174 categories = (('kinds', 'kind'), ('genres', 'genre'), ('authors', 'author'), ('epochs', 'epoch'))
175 for field_name, category in categories:
177 tag_names = getattr(info, field_name)
180 tag_names = [getattr(info, category)]
182 # For instance, Pictures do not have 'genre' field.
184 for tag_name in tag_names:
185 tag_sort_key = tag_name
186 if category == 'author':
187 tag_sort_key = tag_name.last_name
188 tag_name = tag_name.readable()
189 tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category)
192 tag.sort_key = sortify(tag_sort_key.lower())
194 meta_tags.append(tag)
199 def get_dynamic_path(media, filename, ext=None, maxlen=100):
200 from slughifi import slughifi
202 # how to put related book's slug here?
205 ext = media.formats[media.type].ext
206 if media is None or not media.name:
207 name = slughifi(filename.split(".")[0])
209 name = slughifi(media.name)
210 return 'book/%s/%s.%s' % (ext, name[:maxlen-len('book/%s/.%s' % (ext, ext))-4], ext)
213 # TODO: why is this hard-coded ?
214 def book_upload_path(ext=None, maxlen=100):
215 return lambda *args: get_dynamic_path(*args, ext=ext, maxlen=maxlen)
218 def get_customized_pdf_path(book, customizations):
220 Returns a MEDIA_ROOT relative path for a customized pdf. The name will contain a hash of customization options.
222 customizations.sort()
223 h = hash(tuple(customizations))
225 pdf_name = '%s-custom-%s' % (book.fileid(), h)
226 pdf_file = get_dynamic_path(None, pdf_name, ext='pdf')
231 def get_existing_customized_pdf(book):
233 Returns a list of paths to generated customized pdf of a book
235 pdf_glob = '%s-custom-' % (book.fileid(),)
236 pdf_glob = get_dynamic_path(None, pdf_glob, ext='pdf')
237 pdf_glob = re.sub(r"[.]([a-z0-9]+)$", "*.\\1", pdf_glob)
238 return glob(path.join(settings.MEDIA_ROOT, pdf_glob))
241 class BookMedia(models.Model):
242 FileFormat = namedtuple("FileFormat", "name ext")
243 formats = SortedDict([
244 ('mp3', FileFormat(name='MP3', ext='mp3')),
245 ('ogg', FileFormat(name='Ogg Vorbis', ext='ogg')),
246 ('daisy', FileFormat(name='DAISY', ext='daisy.zip')),
248 format_choices = [(k, _('%s file') % t.name)
249 for k, t in formats.items()]
251 type = models.CharField(_('type'), choices=format_choices, max_length="100")
252 name = models.CharField(_('name'), max_length="100")
253 file = OverwritingFileField(_('file'), upload_to=book_upload_path())
254 uploaded_at = models.DateTimeField(_('creation date'), auto_now_add=True, editable=False)
255 extra_info = JSONField(_('extra information'), default='{}', editable=False)
256 book = models.ForeignKey('Book', related_name='media')
257 source_sha1 = models.CharField(null=True, blank=True, max_length=40, editable=False)
259 def __unicode__(self):
260 return "%s (%s)" % (self.name, self.file.name.split("/")[-1])
263 ordering = ('type', 'name')
264 verbose_name = _('book media')
265 verbose_name_plural = _('book media')
267 def save(self, *args, **kwargs):
268 from slughifi import slughifi
269 from catalogue.utils import ExistingFile, remove_zip
272 old = BookMedia.objects.get(pk=self.pk)
273 except BookMedia.DoesNotExist, e:
276 # if name changed, change the file name, too
277 if slughifi(self.name) != slughifi(old.name):
278 self.file.save(None, ExistingFile(self.file.path), save=False, leave=True)
280 super(BookMedia, self).save(*args, **kwargs)
282 # remove the zip package for book with modified media
283 remove_zip(self.book.fileid())
285 extra_info = self.get_extra_info_value()
286 extra_info.update(self.read_meta())
287 self.set_extra_info_value(extra_info)
288 self.source_sha1 = self.read_source_sha1(self.file.path, self.type)
289 return super(BookMedia, self).save(*args, **kwargs)
293 Reads some metadata from the audiobook.
296 from mutagen import id3
298 artist_name = director_name = project = funded_by = ''
299 if self.type == 'mp3':
301 audio = id3.ID3(self.file.path)
302 artist_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE1'))
303 director_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE3'))
304 project = ", ".join([t.data for t in audio.getall('PRIV')
305 if t.owner=='wolnelektury.pl?project'])
306 funded_by = ", ".join([t.data for t in audio.getall('PRIV')
307 if t.owner=='wolnelektury.pl?funded_by'])
310 elif self.type == 'ogg':
312 audio = mutagen.File(self.file.path)
313 artist_name = ', '.join(audio.get('artist', []))
314 director_name = ', '.join(audio.get('conductor', []))
315 project = ", ".join(audio.get('project', []))
316 funded_by = ", ".join(audio.get('funded_by', []))
321 return {'artist_name': artist_name, 'director_name': director_name,
322 'project': project, 'funded_by': funded_by}
325 def read_source_sha1(filepath, filetype):
327 Reads source file SHA1 from audiobok metadata.
330 from mutagen import id3
332 if filetype == 'mp3':
334 audio = id3.ID3(filepath)
335 return [t.data for t in audio.getall('PRIV')
336 if t.owner=='wolnelektury.pl?flac_sha1'][0]
339 elif filetype == 'ogg':
341 audio = mutagen.File(filepath)
342 return audio.get('flac_sha1', [None])[0]
349 class Book(models.Model):
350 title = models.CharField(_('title'), max_length=120)
351 sort_key = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False)
352 slug = models.SlugField(_('slug'), max_length=120, db_index=True)
353 language = models.CharField(_('language code'), max_length=3, db_index=True,
354 default=settings.CATALOGUE_DEFAULT_LANGUAGE)
355 description = models.TextField(_('description'), blank=True)
356 created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
357 changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True)
358 parent_number = models.IntegerField(_('parent number'), default=0)
359 extra_info = JSONField(_('extra information'), default='{}')
360 gazeta_link = models.CharField(blank=True, max_length=240)
361 wiki_link = models.CharField(blank=True, max_length=240)
362 # files generated during publication
364 cover = models.FileField(_('cover'), upload_to=book_upload_path('png'),
365 null=True, blank=True)
366 ebook_formats = ['pdf', 'epub', 'mobi', 'txt']
367 formats = ebook_formats + ['html', 'xml']
369 parent = models.ForeignKey('self', blank=True, null=True, related_name='children')
370 objects = models.Manager()
371 tagged = managers.ModelTaggedItemManager(Tag)
372 tags = managers.TagDescriptor(Tag)
374 html_built = django.dispatch.Signal()
375 published = django.dispatch.Signal()
377 URLID_RE = r'[a-z0-9-]+(?:/[a-z]{3})?'
378 FILEID_RE = r'[a-z0-9-]+(?:_[a-z]{3})?'
380 class AlreadyExists(Exception):
384 unique_together = [['slug', 'language']]
385 ordering = ('sort_key',)
386 verbose_name = _('book')
387 verbose_name_plural = _('books')
389 def __unicode__(self):
392 def urlid(self, sep='/'):
394 if self.language != settings.CATALOGUE_DEFAULT_LANGUAGE:
395 stem += sep + self.language
399 return self.urlid('_')
402 def split_urlid(urlid, sep='/', default_lang=settings.CATALOGUE_DEFAULT_LANGUAGE):
403 """Splits a URL book id into slug and language code.
405 Returns a dictionary usable i.e. for object lookup, or None.
407 >>> Book.split_urlid("a-slug/pol", default_lang="eng")
408 {'slug': 'a-slug', 'language': 'pol'}
409 >>> Book.split_urlid("a-slug", default_lang="eng")
410 {'slug': 'a-slug', 'language': 'eng'}
411 >>> Book.split_urlid("a-slug_pol", "_", default_lang="eng")
412 {'slug': 'a-slug', 'language': 'pol'}
413 >>> Book.split_urlid("a-slug/eng", default_lang="eng")
416 parts = urlid.rsplit(sep, 1)
418 if parts[1] == default_lang:
420 return {'slug': parts[0], 'language': parts[1]}
422 return {'slug': urlid, 'language': default_lang}
425 def split_fileid(cls, fileid):
426 return cls.split_urlid(fileid, '_')
428 def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs):
429 from sortify import sortify
431 self.sort_key = sortify(self.title)
433 ret = super(Book, self).save(force_insert, force_update)
436 self.reset_short_html()
441 def get_absolute_url(self):
442 return ('catalogue.views.book_detail', [self.urlid()])
448 def book_tag_slug(self):
449 stem = 'l-' + self.slug
450 if self.language != settings.CATALOGUE_DEFAULT_LANGUAGE:
451 return stem[:116] + ' ' + self.language
456 slug = self.book_tag_slug()
457 book_tag, created = Tag.objects.get_or_create(slug=slug, category='book')
459 book_tag.name = self.title[:50]
460 book_tag.sort_key = self.title.lower()
464 def has_media(self, type):
465 if type in Book.formats:
466 return bool(getattr(self, "%s_file" % type))
468 return self.media.filter(type=type).exists()
470 def get_media(self, type):
471 if self.has_media(type):
472 if type in Book.formats:
473 return getattr(self, "%s_file" % type)
475 return self.media.filter(type=type)
480 return self.get_media("mp3")
482 return self.get_media("odt")
484 return self.get_media("ogg")
486 return self.get_media("daisy")
488 def reset_short_html(self):
492 cache_key = "Book.short_html/%d/%s"
493 for lang, langname in settings.LANGUAGES:
494 cache.delete(cache_key % (self.id, lang))
495 cache.delete("Book.mini_box/%d" % (self.id, ))
496 # Fragment.short_html relies on book's tags, so reset it here too
497 for fragm in self.fragments.all():
498 fragm.reset_short_html()
500 def short_html(self):
502 cache_key = "Book.short_html/%d/%s" % (self.id, get_language())
503 short_html = cache.get(cache_key)
507 if short_html is not None:
508 return mark_safe(short_html)
510 tags = self.tags.filter(category__in=('author', 'kind', 'genre', 'epoch'))
511 tags = split_tags(tags)
514 # files generated during publication
515 for ebook_format in self.ebook_formats:
516 if self.has_media(ebook_format):
517 formats.append(u'<a href="%s">%s</a>' % (
518 self.get_media(ebook_format).url,
522 formats = [mark_safe(format) for format in formats]
524 short_html = unicode(render_to_string('catalogue/book_short.html',
525 {'book': self, 'tags': tags, 'formats': formats}))
528 cache.set(cache_key, short_html, CACHE_FOREVER)
529 return mark_safe(short_html)
533 cache_key = "Book.mini_box/%d" % (self.id, )
534 short_html = cache.get(cache_key)
538 if short_html is None:
539 authors = self.tags.filter(category='author')
541 short_html = unicode(render_to_string('catalogue/book_mini_box.html',
542 {'book': self, 'authors': authors, 'STATIC_URL': settings.STATIC_URL}))
545 cache.set(cache_key, short_html, CACHE_FOREVER)
546 return mark_safe(short_html)
548 def has_description(self):
549 return len(self.description) > 0
550 has_description.short_description = _('description')
551 has_description.boolean = True
554 def has_mp3_file(self):
555 return bool(self.has_media("mp3"))
556 has_mp3_file.short_description = 'MP3'
557 has_mp3_file.boolean = True
559 def has_ogg_file(self):
560 return bool(self.has_media("ogg"))
561 has_ogg_file.short_description = 'OGG'
562 has_ogg_file.boolean = True
564 def has_daisy_file(self):
565 return bool(self.has_media("daisy"))
566 has_daisy_file.short_description = 'DAISY'
567 has_daisy_file.boolean = True
569 def wldocument(self, parse_dublincore=True):
570 from catalogue.utils import ORMDocProvider
571 from librarian.parser import WLDocument
573 return WLDocument.from_file(self.xml_file.path,
574 provider=ORMDocProvider(self),
575 parse_dublincore=parse_dublincore)
577 def build_cover(self, book_info=None):
578 """(Re)builds the cover image."""
579 from StringIO import StringIO
580 from django.core.files.base import ContentFile
581 from librarian.cover import WLCover
583 if book_info is None:
584 book_info = self.wldocument().book_info
586 cover = WLCover(book_info).image()
588 cover.save(imgstr, 'png')
589 self.cover.save(None, ContentFile(imgstr.getvalue()))
591 def build_pdf(self, customizations=None, file_name=None):
592 """ (Re)builds the pdf file.
593 customizations - customizations which are passed to LaTeX class file.
594 file_name - save the pdf file under a different name and DO NOT save it in db.
596 from os import unlink
597 from django.core.files import File
598 from catalogue.utils import remove_zip
600 pdf = self.wldocument().as_pdf(customizations=customizations)
602 if file_name is None:
603 # we'd like to be sure not to overwrite changes happening while
604 # (timely) pdf generation is taking place (async celery scenario)
605 current_self = Book.objects.get(id=self.id)
606 current_self.pdf_file.save('%s.pdf' % self.fileid(),
607 File(open(pdf.get_filename())))
608 self.pdf_file = current_self.pdf_file
610 # remove cached downloadables
611 remove_zip(settings.ALL_PDF_ZIP)
613 for customized_pdf in get_existing_customized_pdf(self):
614 unlink(customized_pdf)
616 print "saving %s" % file_name
617 print "to: %s" % DefaultStorage().path(file_name)
618 DefaultStorage().save(file_name, File(open(pdf.get_filename())))
620 def build_mobi(self):
621 """ (Re)builds the MOBI file.
624 from django.core.files import File
625 from catalogue.utils import remove_zip
627 mobi = self.wldocument().as_mobi()
629 self.mobi_file.save('%s.mobi' % self.fileid(), File(open(mobi.get_filename())))
631 # remove zip with all mobi files
632 remove_zip(settings.ALL_MOBI_ZIP)
634 def build_epub(self):
635 """(Re)builds the epub file."""
636 from django.core.files import File
637 from catalogue.utils import remove_zip
639 epub = self.wldocument().as_epub()
641 self.epub_file.save('%s.epub' % self.fileid(),
642 File(open(epub.get_filename())))
644 # remove zip package with all epub files
645 remove_zip(settings.ALL_EPUB_ZIP)
648 from django.core.files.base import ContentFile
650 text = self.wldocument().as_text()
651 self.txt_file.save('%s.txt' % self.fileid(), ContentFile(text.get_string()))
654 def build_html(self):
655 from markupstring import MarkupString
656 from django.core.files.base import ContentFile
657 from slughifi import slughifi
658 from librarian import html
660 meta_tags = list(self.tags.filter(
661 category__in=('author', 'epoch', 'genre', 'kind')))
662 book_tag = self.book_tag()
664 html_output = self.wldocument(parse_dublincore=False).as_html()
666 self.html_file.save('%s.html' % self.fileid(),
667 ContentFile(html_output.get_string()))
669 # get ancestor l-tags for adding to new fragments
673 ancestor_tags.append(p.book_tag())
676 # Delete old fragments and create them from scratch
677 self.fragments.all().delete()
679 closed_fragments, open_fragments = html.extract_fragments(self.html_file.path)
680 for fragment in closed_fragments.values():
682 theme_names = [s.strip() for s in fragment.themes.split(',')]
683 except AttributeError:
686 for theme_name in theme_names:
689 tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme')
691 tag.name = theme_name
692 tag.sort_key = theme_name.lower()
698 text = fragment.to_string()
700 if (len(MarkupString(text)) > 240):
701 short_text = unicode(MarkupString(text)[:160])
702 new_fragment = Fragment.objects.create(anchor=fragment.id, book=self,
703 text=text, short_text=short_text)
706 new_fragment.tags = set(meta_tags + themes + [book_tag] + ancestor_tags)
708 self.html_built.send(sender=self)
713 def zip_format(format_):
714 def pretty_file_name(book):
715 return "%s/%s.%s" % (
716 b.get_extra_info_value()['author'],
720 field_name = "%s_file" % format_
721 books = Book.objects.filter(parent=None).exclude(**{field_name: ""})
722 paths = [(pretty_file_name(b), getattr(b, field_name).path)
724 result = create_zip.delay(paths,
725 getattr(settings, "ALL_%s_ZIP" % format_.upper()))
728 def zip_audiobooks(self):
729 bm = BookMedia.objects.filter(book=self, type='mp3')
730 paths = map(lambda bm: (None, bm.file.path), bm)
731 result = create_zip.delay(paths, self.fileid())
734 def search_index(self, book_info=None):
735 if settings.CELERY_ALWAYS_EAGER:
736 idx = search.ReusableIndex()
742 idx.index_book(self, book_info)
748 def from_xml_file(cls, xml_file, **kwargs):
749 from django.core.files import File
750 from librarian import dcparser
752 # use librarian to parse meta-data
753 book_info = dcparser.parse(xml_file)
755 if not isinstance(xml_file, File):
756 xml_file = File(open(xml_file))
759 return cls.from_text_and_meta(xml_file, book_info, **kwargs)
764 def from_text_and_meta(cls, raw_file, book_info, overwrite=False,
765 build_epub=True, build_txt=True, build_pdf=True, build_mobi=True,
768 from sortify import sortify
770 # check for parts before we do anything
772 if hasattr(book_info, 'parts'):
773 for part_url in book_info.parts:
775 children.append(Book.objects.get(
776 slug=part_url.slug, language=part_url.language))
777 except Book.DoesNotExist, e:
778 raise Book.DoesNotExist(_('Book "%s/%s" does not exist.') %
779 (part_url.slug, part_url.language))
783 book_slug = book_info.url.slug
784 language = book_info.language
785 if re.search(r'[^a-zA-Z0-9-]', book_slug):
786 raise ValueError('Invalid characters in slug')
787 book, created = Book.objects.get_or_create(slug=book_slug, language=language)
793 raise Book.AlreadyExists(_('Book %s/%s already exists') % (
794 book_slug, language))
795 # Save shelves for this book
796 book_shelves = list(book.tags.filter(category='set'))
798 book.title = book_info.title
799 book.set_extra_info_value(book_info.to_dict())
802 meta_tags = Tag.tags_from_info(book_info)
804 book.tags = set(meta_tags + book_shelves)
806 book_tag = book.book_tag()
808 for n, child_book in enumerate(children):
809 child_book.parent = book
810 child_book.parent_number = n
813 # Save XML and HTML files
814 book.xml_file.save('%s.xml' % book.slug, raw_file, save=False)
816 # delete old fragments when overwriting
817 book.fragments.all().delete()
819 if book.build_html():
820 if not settings.NO_BUILD_TXT and build_txt:
823 book.build_cover(book_info)
825 if not settings.NO_BUILD_EPUB and build_epub:
828 if not settings.NO_BUILD_PDF and build_pdf:
831 if not settings.NO_BUILD_MOBI and build_mobi:
834 if not settings.NO_SEARCH_INDEX and search_index:
835 index_book.delay(book.id, book_info)
837 book_descendants = list(book.children.all())
838 descendants_tags = set()
839 # add l-tag to descendants and their fragments
840 while len(book_descendants) > 0:
841 child_book = book_descendants.pop(0)
842 descendants_tags.update(child_book.tags)
843 child_book.tags = list(child_book.tags) + [book_tag]
845 for fragment in child_book.fragments.all():
846 fragment.tags = set(list(fragment.tags) + [book_tag])
847 book_descendants += list(child_book.children.all())
849 for tag in descendants_tags:
855 book.reset_tag_counter()
856 book.reset_theme_counter()
858 cls.published.send(sender=book)
861 def reset_tag_counter(self):
865 cache_key = "Book.tag_counter/%d" % self.id
866 cache.delete(cache_key)
868 self.parent.reset_tag_counter()
871 def tag_counter(self):
873 cache_key = "Book.tag_counter/%d" % self.id
874 tags = cache.get(cache_key)
880 for child in self.children.all().order_by():
881 for tag_pk, value in child.tag_counter.iteritems():
882 tags[tag_pk] = tags.get(tag_pk, 0) + value
883 for tag in self.tags.exclude(category__in=('book', 'theme', 'set')).order_by():
887 cache.set(cache_key, tags, CACHE_FOREVER)
890 def reset_theme_counter(self):
894 cache_key = "Book.theme_counter/%d" % self.id
895 cache.delete(cache_key)
897 self.parent.reset_theme_counter()
900 def theme_counter(self):
902 cache_key = "Book.theme_counter/%d" % self.id
903 tags = cache.get(cache_key)
909 for fragment in Fragment.tagged.with_any([self.book_tag()]).order_by():
910 for tag in fragment.tags.filter(category='theme').order_by():
911 tags[tag.pk] = tags.get(tag.pk, 0) + 1
914 cache.set(cache_key, tags, CACHE_FOREVER)
917 def pretty_title(self, html_links=False):
919 names = list(book.tags.filter(category='author'))
925 names.extend(reversed(books))
928 names = ['<a href="%s">%s</a>' % (tag.get_absolute_url(), tag.name) for tag in names]
930 names = [tag.name for tag in names]
932 return ', '.join(names)
935 def tagged_top_level(cls, tags):
936 """ Returns top-level books tagged with `tags'.
938 It only returns those books which don't have ancestors which are
939 also tagged with those tags.
942 # get relevant books and their tags
943 objects = cls.tagged.with_all(tags)
944 # eliminate descendants
945 l_tags = Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in objects])
946 descendants_keys = [book.pk for book in cls.tagged.with_any(l_tags)]
948 objects = objects.exclude(pk__in=descendants_keys)
953 def book_list(cls, filter=None):
954 """Generates a hierarchical listing of all books.
956 Books are optionally filtered with a test function.
961 books = cls.objects.all().order_by('parent_number', 'sort_key').only(
962 'title', 'parent', 'slug', 'language')
964 books = books.filter(filter).distinct()
965 book_ids = set((book.pk for book in books))
967 parent = book.parent_id
968 if parent not in book_ids:
970 books_by_parent.setdefault(parent, []).append(book)
973 books_by_parent.setdefault(book.parent_id, []).append(book)
976 books_by_author = SortedDict()
977 for tag in Tag.objects.filter(category='author'):
978 books_by_author[tag] = []
980 for book in books_by_parent.get(None,()):
981 authors = list(book.tags.filter(category='author'))
983 for author in authors:
984 books_by_author[author].append(book)
988 return books_by_author, orphans, books_by_parent
991 "SP1": (1, u"szkoła podstawowa"),
992 "SP2": (1, u"szkoła podstawowa"),
993 "P": (1, u"szkoła podstawowa"),
994 "G": (2, u"gimnazjum"),
996 "LP": (3, u"liceum"),
998 def audiences_pl(self):
999 audiences = self.get_extra_info_value().get('audiences', [])
1000 audiences = sorted(set([self._audiences_pl[a] for a in audiences]))
1001 return [a[1] for a in audiences]
1004 def _has_factory(ftype):
1005 has = lambda self: bool(getattr(self, "%s_file" % ftype))
1006 has.short_description = t.upper()
1008 has.__name__ = "has_%s_file" % ftype
1012 # add the file fields
1013 for t in Book.formats:
1014 field_name = "%s_file" % t
1015 models.FileField(_("%s file" % t.upper()),
1016 upload_to=book_upload_path(t),
1017 blank=True).contribute_to_class(Book, field_name)
1019 setattr(Book, "has_%s_file" % t, _has_factory(t))
1022 class Fragment(models.Model):
1023 text = models.TextField()
1024 short_text = models.TextField(editable=False)
1025 anchor = models.CharField(max_length=120)
1026 book = models.ForeignKey(Book, related_name='fragments')
1028 objects = models.Manager()
1029 tagged = managers.ModelTaggedItemManager(Tag)
1030 tags = managers.TagDescriptor(Tag)
1033 ordering = ('book', 'anchor',)
1034 verbose_name = _('fragment')
1035 verbose_name_plural = _('fragments')
1037 def get_absolute_url(self):
1038 return '%s#m%s' % (reverse('book_text', args=[self.book.slug]), self.anchor)
1040 def reset_short_html(self):
1044 cache_key = "Fragment.short_html/%d/%s"
1045 for lang, langname in settings.LANGUAGES:
1046 cache.delete(cache_key % (self.id, lang))
1048 def short_html(self):
1050 cache_key = "Fragment.short_html/%d/%s" % (self.id, get_language())
1051 short_html = cache.get(cache_key)
1055 if short_html is not None:
1056 return mark_safe(short_html)
1058 short_html = unicode(render_to_string('catalogue/fragment_short.html',
1059 {'fragment': self}))
1061 cache.set(cache_key, short_html, CACHE_FOREVER)
1062 return mark_safe(short_html)
1072 def _tags_updated_handler(sender, affected_tags, **kwargs):
1073 # reset tag global counter
1074 # we want Tag.changed_at updated for API to know the tag was touched
1075 for tag in affected_tags:
1076 touch_tag.delay(tag)
1078 # if book tags changed, reset book tag counter
1079 if isinstance(sender, Book) and \
1080 Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\
1081 exclude(category__in=('book', 'theme', 'set')).count():
1082 sender.reset_tag_counter()
1083 # if fragment theme changed, reset book theme counter
1084 elif isinstance(sender, Fragment) and \
1085 Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\
1086 filter(category='theme').count():
1087 sender.book.reset_theme_counter()
1088 tags_updated.connect(_tags_updated_handler)
1091 def _pre_delete_handler(sender, instance, **kwargs):
1092 """ refresh Book on BookMedia delete """
1093 if sender == BookMedia:
1094 instance.book.save()
1095 pre_delete.connect(_pre_delete_handler)
1097 def _post_save_handler(sender, instance, **kwargs):
1098 """ refresh all the short_html stuff on BookMedia update """
1099 if sender == BookMedia:
1100 instance.book.save()
1101 post_save.connect(_post_save_handler)