src/catalogue/models/fragment.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from django.conf import settings
   5 from django.contrib.contenttypes.fields import GenericRelation
   6 from django.urls import reverse
   7 from django.db import models
   8 from django.utils.translation import ugettext_lazy as _
   9 from newtagging import managers
  10 from catalogue.models import Tag
  11 from ssify import flush_ssi_includes
  12
  13
  14 class Fragment(models.Model):
  15     """Represents a themed fragment of a book."""
  16     text = models.TextField()
  17     short_text = models.TextField(editable=False)
  18     anchor = models.CharField(max_length=120)
  19     book = models.ForeignKey('Book', models.CASCADE, related_name='fragments')
  20
  21     objects = models.Manager()
  22     tagged = managers.ModelTaggedItemManager(Tag)
  23     tags = managers.TagDescriptor(Tag)
  24     tag_relations = GenericRelation(Tag.intermediary_table_model)
  25
  26     short_html_url_name = 'catalogue_fragment_short'
  27
  28     class Meta:
  29         ordering = ('book', 'anchor',)
  30         verbose_name = _('fragment')
  31         verbose_name_plural = _('fragments')
  32         app_label = 'catalogue'
  33
  34     def get_absolute_url(self):
  35         return '%s#m%s' % (reverse('book_text', args=[self.book.slug]), self.anchor)
  36
  37     def get_api_url(self):
  38         return reverse('catalogue_api_fragment', args=[self.book.slug, self.anchor])
  39
  40     def get_short_text(self):
  41         """Returns short version of the fragment."""
  42         return self.short_text if self.short_text else self.text
  43
  44     @property
  45     def themes(self):
  46         return self.tags.filter(category='theme')
  47
  48     def flush_includes(self, languages=True):
  49         if not languages:
  50             return
  51         if languages is True:
  52             languages = [lc for (lc, _ln) in settings.LANGUAGES]
  53         flush_ssi_includes([
  54             template % (self.pk, lang)
  55             for template in [
  56                 '/katalog/f/%d/short.%s.html',
  57                 '/api/include/fragment/%d.%s.json',
  58                 '/api/include/fragment/%d.%s.xml',
  59                 ]
  60             for lang in languages
  61             ])