detail page getting shape
[wolnelektury.git] / apps / catalogue / models.py
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.
4 #
5 from collections import namedtuple
6
7 from django.db import models
8 from django.db.models import permalink, Q
9 import django.dispatch
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
20
21 from django.conf import settings
22
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
29 from glob import glob
30 import re
31 from os import path
32
33
34 import search
35
36 TAG_CATEGORIES = (
37     ('author', _('author')),
38     ('epoch', _('epoch')),
39     ('kind', _('kind')),
40     ('genre', _('genre')),
41     ('theme', _('theme')),
42     ('set', _('set')),
43     ('book', _('book')),
44 )
45
46 # not quite, but Django wants you to set a timeout
47 CACHE_FOREVER = 2419200  # 28 days
48
49
50 class TagSubcategoryManager(models.Manager):
51     def __init__(self, subcategory):
52         super(TagSubcategoryManager, self).__init__()
53         self.subcategory = subcategory
54
55     def get_query_set(self):
56         return super(TagSubcategoryManager, self).get_query_set().filter(category=self.subcategory)
57
58
59 class Tag(TagBase):
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)
66
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)
71
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)
74
75     class UrlDeprecationWarning(DeprecationWarning):
76         pass
77
78     categories_rev = {
79         'autor': 'author',
80         'epoka': 'epoch',
81         'rodzaj': 'kind',
82         'gatunek': 'genre',
83         'motyw': 'theme',
84         'polka': 'set',
85     }
86     categories_dict = dict((item[::-1] for item in categories_rev.iteritems()))
87
88     class Meta:
89         ordering = ('sort_key',)
90         verbose_name = _('tag')
91         verbose_name_plural = _('tags')
92         unique_together = (("slug", "category"),)
93
94     def __unicode__(self):
95         return self.name
96
97     def __repr__(self):
98         return "Tag(slug=%r)" % self.slug
99
100     @permalink
101     def get_absolute_url(self):
102         return ('catalogue.views.tagged_object_list', [self.url_chunk])
103
104     def has_description(self):
105         return len(self.description) > 0
106     has_description.short_description = _('description')
107     has_description.boolean = True
108
109     def get_count(self):
110         """Returns global book count for book tags, fragment count for themes."""
111
112         if self.category == 'book':
113             # never used
114             objects = Book.objects.none()
115         elif self.category == 'theme':
116             objects = Fragment.tagged.with_all((self,))
117         else:
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)]
123                 if descendants_keys:
124                     objects = objects.exclude(pk__in=descendants_keys)
125         return objects.count()
126
127     @staticmethod
128     def get_tag_list(tags):
129         if isinstance(tags, basestring):
130             real_tags = []
131             ambiguous_slugs = []
132             category = None
133             deprecated = False
134             tags_splitted = tags.split('/')
135             for name in tags_splitted:
136                 if category:
137                     real_tags.append(Tag.objects.get(slug=name, category=category))
138                     category = None
139                 elif name in Tag.categories_rev:
140                     category = Tag.categories_rev[name]
141                 else:
142                     try:
143                         real_tags.append(Tag.objects.exclude(category='book').get(slug=name))
144                         deprecated = True 
145                     except Tag.MultipleObjectsReturned, e:
146                         ambiguous_slugs.append(name)
147
148             if category:
149                 # something strange left off
150                 raise Tag.DoesNotExist()
151             if ambiguous_slugs:
152                 # some tags should be qualified
153                 e = Tag.MultipleObjectsReturned()
154                 e.tags = real_tags
155                 e.ambiguous_slugs = ambiguous_slugs
156                 raise e
157             if deprecated:
158                 e = Tag.UrlDeprecationWarning()
159                 e.tags = real_tags
160                 raise e
161             return real_tags
162         else:
163             return TagBase.get_tag_list(tags)
164
165     @property
166     def url_chunk(self):
167         return '/'.join((Tag.categories_dict[self.category], self.slug))
168
169     @staticmethod
170     def tags_from_info(info):
171         from slughifi import slughifi
172         from sortify import sortify
173         meta_tags = []
174         categories = (('kinds', 'kind'), ('genres', 'genre'), ('authors', 'author'), ('epochs', 'epoch'))
175         for field_name, category in categories:
176             try:
177                 tag_names = getattr(info, field_name)
178             except:
179                 try:
180                     tag_names = [getattr(info, category)]
181                 except:
182                     # For instance, Pictures do not have 'genre' field.
183                     continue
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)
190                 if created:
191                     tag.name = tag_name
192                     tag.sort_key = sortify(tag_sort_key.lower())
193                     tag.save()
194                 meta_tags.append(tag)
195         return meta_tags
196
197
198
199 def get_dynamic_path(media, filename, ext=None, maxlen=100):
200     from slughifi import slughifi
201
202     # how to put related book's slug here?
203     if not ext:
204         # BookMedia case
205         ext = media.formats[media.type].ext
206     if media is None or not media.name:
207         name = slughifi(filename.split(".")[0])
208     else:
209         name = slughifi(media.name)
210     return 'book/%s/%s.%s' % (ext, name[:maxlen-len('book/%s/.%s' % (ext, ext))-4], ext)
211
212
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)
216
217
218 def get_customized_pdf_path(book, customizations):
219     """
220     Returns a MEDIA_ROOT relative path for a customized pdf. The name will contain a hash of customization options.
221     """
222     customizations.sort()
223     h = hash(tuple(customizations))
224
225     pdf_name = '%s-custom-%s' % (book.fileid(), h)
226     pdf_file = get_dynamic_path(None, pdf_name, ext='pdf')
227
228     return pdf_file
229
230
231 def get_existing_customized_pdf(book):
232     """
233     Returns a list of paths to generated customized pdf of a book
234     """
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))
239
240
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')),
247     ])
248     format_choices = [(k, _('%s file') % t.name)
249             for k, t in formats.items()]
250
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)
258
259     def __unicode__(self):
260         return "%s (%s)" % (self.name, self.file.name.split("/")[-1])
261
262     class Meta:
263         ordering            = ('type', 'name')
264         verbose_name        = _('book media')
265         verbose_name_plural = _('book media')
266
267     def save(self, *args, **kwargs):
268         from slughifi import slughifi
269         from catalogue.utils import ExistingFile, remove_zip
270
271         try:
272             old = BookMedia.objects.get(pk=self.pk)
273         except BookMedia.DoesNotExist, e:
274             pass
275         else:
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)
279
280         super(BookMedia, self).save(*args, **kwargs)
281
282         # remove the zip package for book with modified media
283         remove_zip(self.book.fileid())
284
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)
290
291     def read_meta(self):
292         """
293             Reads some metadata from the audiobook.
294         """
295         import mutagen
296         from mutagen import id3
297
298         artist_name = director_name = project = funded_by = ''
299         if self.type == 'mp3':
300             try:
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'])
308             except:
309                 pass
310         elif self.type == 'ogg':
311             try:
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', []))
317             except:
318                 pass
319         else:
320             return {}
321         return {'artist_name': artist_name, 'director_name': director_name,
322                 'project': project, 'funded_by': funded_by}
323
324     @staticmethod
325     def read_source_sha1(filepath, filetype):
326         """
327             Reads source file SHA1 from audiobok metadata.
328         """
329         import mutagen
330         from mutagen import id3
331
332         if filetype == 'mp3':
333             try:
334                 audio = id3.ID3(filepath)
335                 return [t.data for t in audio.getall('PRIV') 
336                         if t.owner=='wolnelektury.pl?flac_sha1'][0]
337             except:
338                 return None
339         elif filetype == 'ogg':
340             try:
341                 audio = mutagen.File(filepath)
342                 return audio.get('flac_sha1', [None])[0] 
343             except:
344                 return None
345         else:
346             return None
347
348
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
363
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']
368
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)
373
374     html_built = django.dispatch.Signal()
375     published = django.dispatch.Signal()
376
377     URLID_RE = r'[a-z0-9-]+(?:/[a-z]{3})?'
378     FILEID_RE = r'[a-z0-9-]+(?:_[a-z]{3})?'
379
380     class AlreadyExists(Exception):
381         pass
382
383     class Meta:
384         unique_together = [['slug', 'language']]
385         ordering = ('sort_key',)
386         verbose_name = _('book')
387         verbose_name_plural = _('books')
388
389     def __unicode__(self):
390         return self.title
391
392     def urlid(self, sep='/'):
393         stem = self.slug
394         if self.language != settings.CATALOGUE_DEFAULT_LANGUAGE:
395             stem += sep + self.language
396         return stem
397
398     def fileid(self):
399         return self.urlid('_')
400
401     @staticmethod
402     def split_urlid(urlid, sep='/', default_lang=settings.CATALOGUE_DEFAULT_LANGUAGE):
403         """Splits a URL book id into slug and language code.
404         
405         Returns a dictionary usable i.e. for object lookup, or None.
406
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")
414
415         """
416         parts = urlid.rsplit(sep, 1)
417         if len(parts) == 2:
418             if parts[1] == default_lang:
419                 return None
420             return {'slug': parts[0], 'language': parts[1]}
421         else:
422             return {'slug': urlid, 'language': default_lang}
423
424     @classmethod
425     def split_fileid(cls, fileid):
426         return cls.split_urlid(fileid, '_')
427
428     def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs):
429         from sortify import sortify
430
431         self.sort_key = sortify(self.title)
432
433         ret = super(Book, self).save(force_insert, force_update)
434
435         if reset_short_html:
436             self.reset_short_html()
437
438         return ret
439
440     @permalink
441     def get_absolute_url(self):
442         return ('catalogue.views.book_detail', [self.urlid()])
443
444     @property
445     def name(self):
446         return self.title
447
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
452         else:
453             return stem[:120]
454
455     def book_tag(self):
456         slug = self.book_tag_slug()
457         book_tag, created = Tag.objects.get_or_create(slug=slug, category='book')
458         if created:
459             book_tag.name = self.title[:50]
460             book_tag.sort_key = self.title.lower()
461             book_tag.save()
462         return book_tag
463
464     def has_media(self, type):
465         if type in Book.formats:
466             return bool(getattr(self, "%s_file" % type))
467         else:
468             return self.media.filter(type=type).exists()
469
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)
474             else:                                             
475                 return self.media.filter(type=type)
476         else:
477             return None
478
479     def get_mp3(self):
480         return self.get_media("mp3")
481     def get_odt(self):
482         return self.get_media("odt")
483     def get_ogg(self):
484         return self.get_media("ogg")
485     def get_daisy(self):
486         return self.get_media("daisy")                       
487
488     def reset_short_html(self):
489         if self.id is None:
490             return
491
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()
499
500     def short_html(self):
501         if self.id:
502             cache_key = "Book.short_html/%d/%s" % (self.id, get_language())
503             short_html = cache.get(cache_key)
504         else:
505             short_html = None
506
507         if short_html is not None:
508             return mark_safe(short_html)
509         else:
510             tags = self.tags.filter(category__in=('author', 'kind', 'genre', 'epoch'))
511             tags = split_tags(tags)
512
513             formats = {}
514             # files generated during publication
515             for ebook_format in self.ebook_formats:
516                 if self.has_media(ebook_format):
517                     formats[ebook_format] = self.get_media(ebook_format)
518
519
520             short_html = unicode(render_to_string('catalogue/book_short.html',
521                 {'book': self, 'tags': tags, 'formats': formats}))
522
523             if self.id:
524                 cache.set(cache_key, short_html, CACHE_FOREVER)
525             return mark_safe(short_html)
526
527     def mini_box(self):
528         if self.id:
529             cache_key = "Book.mini_box/%d" % (self.id, )
530             short_html = cache.get(cache_key)
531         else:
532             short_html = None
533
534         if short_html is None:
535             authors = self.tags.filter(category='author')
536
537             short_html = unicode(render_to_string('catalogue/book_mini_box.html',
538                 {'book': self, 'authors': authors, 'STATIC_URL': settings.STATIC_URL}))
539
540             if self.id:
541                 cache.set(cache_key, short_html, CACHE_FOREVER)
542         return mark_safe(short_html)
543
544     def has_description(self):
545         return len(self.description) > 0
546     has_description.short_description = _('description')
547     has_description.boolean = True
548
549     # ugly ugly ugly
550     def has_mp3_file(self):
551         return bool(self.has_media("mp3"))
552     has_mp3_file.short_description = 'MP3'
553     has_mp3_file.boolean = True
554
555     def has_ogg_file(self):
556         return bool(self.has_media("ogg"))
557     has_ogg_file.short_description = 'OGG'
558     has_ogg_file.boolean = True
559
560     def has_daisy_file(self):
561         return bool(self.has_media("daisy"))
562     has_daisy_file.short_description = 'DAISY'
563     has_daisy_file.boolean = True
564
565     def wldocument(self, parse_dublincore=True):
566         from catalogue.utils import ORMDocProvider
567         from librarian.parser import WLDocument
568
569         return WLDocument.from_file(self.xml_file.path,
570                 provider=ORMDocProvider(self),
571                 parse_dublincore=parse_dublincore)
572
573     def build_cover(self, book_info=None):
574         """(Re)builds the cover image."""
575         from StringIO import StringIO
576         from django.core.files.base import ContentFile
577         from librarian.cover import WLCover
578
579         if book_info is None:
580             book_info = self.wldocument().book_info
581
582         cover = WLCover(book_info).image()
583         imgstr = StringIO()
584         cover.save(imgstr, 'png')
585         self.cover.save(None, ContentFile(imgstr.getvalue()))
586
587     def build_pdf(self, customizations=None, file_name=None):
588         """ (Re)builds the pdf file.
589         customizations - customizations which are passed to LaTeX class file.
590         file_name - save the pdf file under a different name and DO NOT save it in db.
591         """
592         from os import unlink
593         from django.core.files import File
594         from catalogue.utils import remove_zip
595
596         pdf = self.wldocument().as_pdf(customizations=customizations)
597
598         if file_name is None:
599             # we'd like to be sure not to overwrite changes happening while
600             # (timely) pdf generation is taking place (async celery scenario)
601             current_self = Book.objects.get(id=self.id)
602             current_self.pdf_file.save('%s.pdf' % self.fileid(),
603                     File(open(pdf.get_filename())))
604             self.pdf_file = current_self.pdf_file
605
606             # remove cached downloadables
607             remove_zip(settings.ALL_PDF_ZIP)
608
609             for customized_pdf in get_existing_customized_pdf(self):
610                 unlink(customized_pdf)
611         else:
612             print "saving %s" % file_name
613             print "to: %s" % DefaultStorage().path(file_name)
614             DefaultStorage().save(file_name, File(open(pdf.get_filename())))
615
616     def build_mobi(self):
617         """ (Re)builds the MOBI file.
618
619         """
620         from django.core.files import File
621         from catalogue.utils import remove_zip
622
623         mobi = self.wldocument().as_mobi()
624
625         self.mobi_file.save('%s.mobi' % self.fileid(), File(open(mobi.get_filename())))
626
627         # remove zip with all mobi files
628         remove_zip(settings.ALL_MOBI_ZIP)
629
630     def build_epub(self):
631         """(Re)builds the epub file."""
632         from django.core.files import File
633         from catalogue.utils import remove_zip
634
635         epub = self.wldocument().as_epub()
636
637         self.epub_file.save('%s.epub' % self.fileid(),
638                 File(open(epub.get_filename())))
639
640         # remove zip package with all epub files
641         remove_zip(settings.ALL_EPUB_ZIP)
642
643     def build_txt(self):
644         from django.core.files.base import ContentFile
645
646         text = self.wldocument().as_text()
647         self.txt_file.save('%s.txt' % self.fileid(), ContentFile(text.get_string()))
648
649
650     def build_html(self):
651         from markupstring import MarkupString
652         from django.core.files.base import ContentFile
653         from slughifi import slughifi
654         from librarian import html
655
656         meta_tags = list(self.tags.filter(
657             category__in=('author', 'epoch', 'genre', 'kind')))
658         book_tag = self.book_tag()
659
660         html_output = self.wldocument(parse_dublincore=False).as_html()
661         if html_output:
662             self.html_file.save('%s.html' % self.fileid(),
663                     ContentFile(html_output.get_string()))
664
665             # get ancestor l-tags for adding to new fragments
666             ancestor_tags = []
667             p = self.parent
668             while p:
669                 ancestor_tags.append(p.book_tag())
670                 p = p.parent
671
672             # Delete old fragments and create them from scratch
673             self.fragments.all().delete()
674             # Extract fragments
675             closed_fragments, open_fragments = html.extract_fragments(self.html_file.path)
676             for fragment in closed_fragments.values():
677                 try:
678                     theme_names = [s.strip() for s in fragment.themes.split(',')]
679                 except AttributeError:
680                     continue
681                 themes = []
682                 for theme_name in theme_names:
683                     if not theme_name:
684                         continue
685                     tag, created = Tag.objects.get_or_create(slug=slughifi(theme_name), category='theme')
686                     if created:
687                         tag.name = theme_name
688                         tag.sort_key = theme_name.lower()
689                         tag.save()
690                     themes.append(tag)
691                 if not themes:
692                     continue
693
694                 text = fragment.to_string()
695                 short_text = ''
696                 if (len(MarkupString(text)) > 240):
697                     short_text = unicode(MarkupString(text)[:160])
698                 new_fragment = Fragment.objects.create(anchor=fragment.id, book=self,
699                     text=text, short_text=short_text)
700
701                 new_fragment.save()
702                 new_fragment.tags = set(meta_tags + themes + [book_tag] + ancestor_tags)
703             self.save()
704             self.html_built.send(sender=self)
705             return True
706         return False
707
708     @staticmethod
709     def zip_format(format_):
710         def pretty_file_name(book):
711             return "%s/%s.%s" % (
712                 b.get_extra_info_value()['author'],
713                 b.fileid(),
714                 format_)
715
716         field_name = "%s_file" % format_
717         books = Book.objects.filter(parent=None).exclude(**{field_name: ""})
718         paths = [(pretty_file_name(b), getattr(b, field_name).path)
719                     for b in books]
720         result = create_zip.delay(paths,
721                     getattr(settings, "ALL_%s_ZIP" % format_.upper()))
722         return result.wait()
723
724     def zip_audiobooks(self):
725         bm = BookMedia.objects.filter(book=self, type='mp3')
726         paths = map(lambda bm: (None, bm.file.path), bm)
727         result = create_zip.delay(paths, self.fileid())
728         return result.wait()
729
730     def search_index(self, book_info=None):
731         if settings.CELERY_ALWAYS_EAGER:
732             idx = search.ReusableIndex()
733         else:
734             idx = search.Index()
735             
736         idx.open()
737         try:
738             idx.index_book(self, book_info)
739             idx.index_tags()
740         finally:
741             idx.close()
742
743     @classmethod
744     def from_xml_file(cls, xml_file, **kwargs):
745         from django.core.files import File
746         from librarian import dcparser
747
748         # use librarian to parse meta-data
749         book_info = dcparser.parse(xml_file)
750
751         if not isinstance(xml_file, File):
752             xml_file = File(open(xml_file))
753
754         try:
755             return cls.from_text_and_meta(xml_file, book_info, **kwargs)
756         finally:
757             xml_file.close()
758
759     @classmethod
760     def from_text_and_meta(cls, raw_file, book_info, overwrite=False,
761             build_epub=True, build_txt=True, build_pdf=True, build_mobi=True,
762             search_index=True):
763         import re
764         from sortify import sortify
765
766         # check for parts before we do anything
767         children = []
768         if hasattr(book_info, 'parts'):
769             for part_url in book_info.parts:
770                 try:
771                     children.append(Book.objects.get(
772                         slug=part_url.slug, language=part_url.language))
773                 except Book.DoesNotExist, e:
774                     raise Book.DoesNotExist(_('Book "%s/%s" does not exist.') %
775                             (part_url.slug, part_url.language))
776
777
778         # Read book metadata
779         book_slug = book_info.url.slug
780         language = book_info.language
781         if re.search(r'[^a-zA-Z0-9-]', book_slug):
782             raise ValueError('Invalid characters in slug')
783         book, created = Book.objects.get_or_create(slug=book_slug, language=language)
784
785         if created:
786             book_shelves = []
787         else:
788             if not overwrite:
789                 raise Book.AlreadyExists(_('Book %s/%s already exists') % (
790                         book_slug, language))
791             # Save shelves for this book
792             book_shelves = list(book.tags.filter(category='set'))
793
794         book.title = book_info.title
795         book.set_extra_info_value(book_info.to_dict())
796         book.save()
797
798         meta_tags = Tag.tags_from_info(book_info)
799
800         book.tags = set(meta_tags + book_shelves)
801
802         book_tag = book.book_tag()
803
804         for n, child_book in enumerate(children):
805             child_book.parent = book
806             child_book.parent_number = n
807             child_book.save()
808
809         # Save XML and HTML files
810         book.xml_file.save('%s.xml' % book.slug, raw_file, save=False)
811
812         # delete old fragments when overwriting
813         book.fragments.all().delete()
814
815         if book.build_html():
816             if not settings.NO_BUILD_TXT and build_txt:
817                 book.build_txt()
818
819         book.build_cover(book_info)
820
821         if not settings.NO_BUILD_EPUB and build_epub:
822             book.build_epub()
823
824         if not settings.NO_BUILD_PDF and build_pdf:
825             book.build_pdf()
826
827         if not settings.NO_BUILD_MOBI and build_mobi:
828             book.build_mobi()
829
830         if not settings.NO_SEARCH_INDEX and search_index:
831             index_book.delay(book.id, book_info)
832
833         book_descendants = list(book.children.all())
834         descendants_tags = set()
835         # add l-tag to descendants and their fragments
836         while len(book_descendants) > 0:
837             child_book = book_descendants.pop(0)
838             descendants_tags.update(child_book.tags)
839             child_book.tags = list(child_book.tags) + [book_tag]
840             child_book.save()
841             for fragment in child_book.fragments.all():
842                 fragment.tags = set(list(fragment.tags) + [book_tag])
843             book_descendants += list(child_book.children.all())
844
845         for tag in descendants_tags:
846             touch_tag.delay(tag)
847
848         book.save()
849
850         # refresh cache
851         book.reset_tag_counter()
852         book.reset_theme_counter()
853
854         cls.published.send(sender=book)
855         return book
856
857     def reset_tag_counter(self):
858         if self.id is None:
859             return
860
861         cache_key = "Book.tag_counter/%d" % self.id
862         cache.delete(cache_key)
863         if self.parent:
864             self.parent.reset_tag_counter()
865
866     @property
867     def tag_counter(self):
868         if self.id:
869             cache_key = "Book.tag_counter/%d" % self.id
870             tags = cache.get(cache_key)
871         else:
872             tags = None
873
874         if tags is None:
875             tags = {}
876             for child in self.children.all().order_by():
877                 for tag_pk, value in child.tag_counter.iteritems():
878                     tags[tag_pk] = tags.get(tag_pk, 0) + value
879             for tag in self.tags.exclude(category__in=('book', 'theme', 'set')).order_by():
880                 tags[tag.pk] = 1
881
882             if self.id:
883                 cache.set(cache_key, tags, CACHE_FOREVER)
884         return tags
885
886     def reset_theme_counter(self):
887         if self.id is None:
888             return
889
890         cache_key = "Book.theme_counter/%d" % self.id
891         cache.delete(cache_key)
892         if self.parent:
893             self.parent.reset_theme_counter()
894
895     @property
896     def theme_counter(self):
897         if self.id:
898             cache_key = "Book.theme_counter/%d" % self.id
899             tags = cache.get(cache_key)
900         else:
901             tags = None
902
903         if tags is None:
904             tags = {}
905             for fragment in Fragment.tagged.with_any([self.book_tag()]).order_by():
906                 for tag in fragment.tags.filter(category='theme').order_by():
907                     tags[tag.pk] = tags.get(tag.pk, 0) + 1
908
909             if self.id:
910                 cache.set(cache_key, tags, CACHE_FOREVER)
911         return tags
912
913     def pretty_title(self, html_links=False):
914         book = self
915         names = list(book.tags.filter(category='author'))
916
917         books = []
918         while book:
919             books.append(book)
920             book = book.parent
921         names.extend(reversed(books))
922
923         if html_links:
924             names = ['<a href="%s">%s</a>' % (tag.get_absolute_url(), tag.name) for tag in names]
925         else:
926             names = [tag.name for tag in names]
927
928         return ', '.join(names)
929
930     @classmethod
931     def tagged_top_level(cls, tags):
932         """ Returns top-level books tagged with `tags'.
933
934         It only returns those books which don't have ancestors which are
935         also tagged with those tags.
936
937         """
938         # get relevant books and their tags
939         objects = cls.tagged.with_all(tags)
940         # eliminate descendants
941         l_tags = Tag.objects.filter(category='book', slug__in=[book.book_tag_slug() for book in objects])
942         descendants_keys = [book.pk for book in cls.tagged.with_any(l_tags)]
943         if descendants_keys:
944             objects = objects.exclude(pk__in=descendants_keys)
945
946         return objects
947
948     @classmethod
949     def book_list(cls, filter=None):
950         """Generates a hierarchical listing of all books.
951
952         Books are optionally filtered with a test function.
953
954         """
955
956         books_by_parent = {}
957         books = cls.objects.all().order_by('parent_number', 'sort_key').only(
958                 'title', 'parent', 'slug', 'language')
959         if filter:
960             books = books.filter(filter).distinct()
961             book_ids = set((book.pk for book in books))
962             for book in books:
963                 parent = book.parent_id
964                 if parent not in book_ids:
965                     parent = None
966                 books_by_parent.setdefault(parent, []).append(book)
967         else:
968             for book in books:
969                 books_by_parent.setdefault(book.parent_id, []).append(book)
970
971         orphans = []
972         books_by_author = SortedDict()
973         for tag in Tag.objects.filter(category='author'):
974             books_by_author[tag] = []
975
976         for book in books_by_parent.get(None,()):
977             authors = list(book.tags.filter(category='author'))
978             if authors:
979                 for author in authors:
980                     books_by_author[author].append(book)
981             else:
982                 orphans.append(book)
983
984         return books_by_author, orphans, books_by_parent
985
986     _audiences_pl = {
987         "SP1": (1, u"szkoła podstawowa"),
988         "SP2": (1, u"szkoła podstawowa"),
989         "P": (1, u"szkoła podstawowa"),
990         "G": (2, u"gimnazjum"),
991         "L": (3, u"liceum"),
992         "LP": (3, u"liceum"),
993     }
994     def audiences_pl(self):
995         audiences = self.get_extra_info_value().get('audiences', [])
996         audiences = sorted(set([self._audiences_pl[a] for a in audiences]))
997         return [a[1] for a in audiences]
998
999
1000 def _has_factory(ftype):
1001     has = lambda self: bool(getattr(self, "%s_file" % ftype))
1002     has.short_description = t.upper()
1003     has.boolean = True
1004     has.__name__ = "has_%s_file" % ftype
1005     return has
1006
1007     
1008 # add the file fields
1009 for t in Book.formats:
1010     field_name = "%s_file" % t
1011     models.FileField(_("%s file" % t.upper()),
1012             upload_to=book_upload_path(t),
1013             blank=True).contribute_to_class(Book, field_name)
1014
1015     setattr(Book, "has_%s_file" % t, _has_factory(t))
1016
1017
1018 class Fragment(models.Model):
1019     text = models.TextField()
1020     short_text = models.TextField(editable=False)
1021     anchor = models.CharField(max_length=120)
1022     book = models.ForeignKey(Book, related_name='fragments')
1023
1024     objects = models.Manager()
1025     tagged = managers.ModelTaggedItemManager(Tag)
1026     tags = managers.TagDescriptor(Tag)
1027
1028     class Meta:
1029         ordering = ('book', 'anchor',)
1030         verbose_name = _('fragment')
1031         verbose_name_plural = _('fragments')
1032
1033     def get_absolute_url(self):
1034         return '%s#m%s' % (reverse('book_text', args=[self.book.slug]), self.anchor)
1035
1036     def reset_short_html(self):
1037         if self.id is None:
1038             return
1039
1040         cache_key = "Fragment.short_html/%d/%s"
1041         for lang, langname in settings.LANGUAGES:
1042             cache.delete(cache_key % (self.id, lang))
1043
1044     def short_html(self):
1045         if self.id:
1046             cache_key = "Fragment.short_html/%d/%s" % (self.id, get_language())
1047             short_html = cache.get(cache_key)
1048         else:
1049             short_html = None
1050
1051         if short_html is not None:
1052             return mark_safe(short_html)
1053         else:
1054             short_html = unicode(render_to_string('catalogue/fragment_short.html',
1055                 {'fragment': self}))
1056             if self.id:
1057                 cache.set(cache_key, short_html, CACHE_FOREVER)
1058             return mark_safe(short_html)
1059
1060
1061 ###########
1062 #
1063 # SIGNALS
1064 #
1065 ###########
1066
1067
1068 def _tags_updated_handler(sender, affected_tags, **kwargs):
1069     # reset tag global counter
1070     # we want Tag.changed_at updated for API to know the tag was touched
1071     for tag in affected_tags:
1072         touch_tag.delay(tag)
1073
1074     # if book tags changed, reset book tag counter
1075     if isinstance(sender, Book) and \
1076                 Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\
1077                     exclude(category__in=('book', 'theme', 'set')).count():
1078         sender.reset_tag_counter()
1079     # if fragment theme changed, reset book theme counter
1080     elif isinstance(sender, Fragment) and \
1081                 Tag.objects.filter(pk__in=(tag.pk for tag in affected_tags)).\
1082                     filter(category='theme').count():
1083         sender.book.reset_theme_counter()
1084 tags_updated.connect(_tags_updated_handler)
1085
1086
1087 def _pre_delete_handler(sender, instance, **kwargs):
1088     """ refresh Book on BookMedia delete """
1089     if sender == BookMedia:
1090         instance.book.save()
1091 pre_delete.connect(_pre_delete_handler)
1092
1093 def _post_save_handler(sender, instance, **kwargs):
1094     """ refresh all the short_html stuff on BookMedia update """
1095     if sender == BookMedia:
1096         instance.book.save()
1097 post_save.connect(_post_save_handler)