pep8 etc
[redakcja.git] / apps / catalogue / models / chunk.py
1 # -*- coding: utf-8 -*-
2 #
3 # This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 #
6 from django.conf import settings
7 from django.db import models
8 from django.db.utils import IntegrityError
9 from django.template.loader import render_to_string
10 from django.utils.translation import ugettext_lazy as _
11 from catalogue.helpers import cached_in_field
12 from catalogue.managers import VisibleManager
13 from catalogue.tasks import refresh_instance
14 from dvcs import models as dvcs_models
15
16
17 class Chunk(dvcs_models.Document):
18     """ An editable chunk of text. Every Book text is divided into chunks. """
19     REPO_PATH = settings.CATALOGUE_REPO_PATH
20
21     book = models.ForeignKey('Book', editable=False, verbose_name=_('book'))
22     number = models.IntegerField(_('number'))
23     title = models.CharField(_('title'), max_length=255, blank=True)
24     slug = models.SlugField(_('slug'))
25     gallery_start = models.IntegerField(_('gallery start'), null=True, blank=True, default=1)
26
27     # cache
28     _short_html = models.TextField(null=True, blank=True, editable=False)
29     _hidden = models.NullBooleanField(editable=False)
30     _changed = models.NullBooleanField(editable=False)
31
32     # managers
33     objects = models.Manager()
34     visible_objects = VisibleManager()
35
36     class Meta:
37         app_label = 'catalogue'
38         unique_together = [['book', 'number'], ['book', 'slug']]
39         ordering = ['number']
40         verbose_name = _('chunk')
41         verbose_name_plural = _('chunks')
42         permissions = [('can_pubmark', 'Can mark for publishing')]
43
44     # Representing
45     # ============
46
47     def __unicode__(self):
48         return "%d:%d: %s" % (self.book_id, self.number, self.title)
49
50     @models.permalink
51     def get_absolute_url(self):
52         return "wiki_editor", [self.book.slug, self.slug]
53
54     def pretty_name(self, book_length=None):
55         title = self.book.title
56         if self.title:
57             title += ", %s" % self.title
58         if book_length > 1:
59             title += " (%d/%d)" % (self.number, book_length)
60         return title
61
62     # Creating and manipulation
63     # =========================
64
65     def split(self, slug, title='', **kwargs):
66         """ Create an empty chunk after this one """
67         self.book.chunk_set.filter(number__gt=self.number).update(
68                 number=models.F('number')+1)
69         new_chunk = None
70         while not new_chunk:
71             new_slug = self.book.make_chunk_slug(slug)
72             try:
73                 new_chunk = self.book.chunk_set.create(
74                     number=self.number+1,
75                     slug=new_slug[:50], title=title[:255], **kwargs)
76             except IntegrityError:
77                 pass
78         return new_chunk
79
80     @classmethod
81     def get(cls, book_slug, chunk_slug=None):
82         if chunk_slug is None:
83             return cls.objects.get(book__slug=book_slug, number=1)
84         else:
85             return cls.objects.get(book__slug=book_slug, slug=chunk_slug)
86
87     # State & cache
88     # =============
89
90     def new_publishable(self):
91         change = self.publishable()
92         if not change:
93             return False
94         return not change.publish_log.exists()
95
96     def is_changed(self):
97         if self.head is None:
98             return False
99         return not self.head.publishable
100     changed = cached_in_field('_changed')(is_changed)
101
102     def is_hidden(self):
103         return self.book.hidden()
104     hidden = cached_in_field('_hidden')(is_hidden)
105
106     @cached_in_field('_short_html')
107     def short_html(self):
108         return render_to_string(
109                     'catalogue/book_list/chunk.html', {'chunk': self})
110
111     def touch(self):
112         update = {
113             "_changed": self.is_changed(),
114             "_hidden": self.is_hidden(),
115             "_short_html": None,
116         }
117         Chunk.objects.filter(pk=self.pk).update(**update)
118         refresh_instance(self)
119
120     def refresh(self):
121         """This should be done offline."""
122         self.changed
123         self.hidden
124         self.short_html