1 # -*- coding: utf-8 -*-
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.
6 from django.contrib.sites.models import Site
7 from django.db import models, transaction
8 from django.template.loader import render_to_string
9 from django.utils.translation import ugettext_lazy as _
10 from slughifi import slughifi
11 from librarian import NoDublinCore, ParseError, ValidationError
12 from librarian.dcparser import BookInfo
15 from catalogue.helpers import cached_in_field
16 from catalogue.models import BookPublishRecord, ChunkPublishRecord
17 from catalogue.signals import post_publish
18 from catalogue.tasks import refresh_instance
19 from catalogue.xml_tools import compile_text, split_xml
22 class Book(models.Model):
23 """ A document edited on the wiki """
25 title = models.CharField(_('title'), max_length=255, db_index=True)
26 slug = models.SlugField(_('slug'), max_length=128, unique=True, db_index=True)
27 public = models.BooleanField(_('public'), default=True, db_index=True)
28 gallery = models.CharField(_('scan gallery name'), max_length=255, blank=True)
30 #wl_slug = models.CharField(_('title'), max_length=255, null=True, db_index=True, editable=False)
31 parent = models.ForeignKey('self', null=True, blank=True, verbose_name=_('parent'), related_name="children", editable=False)
32 parent_number = models.IntegerField(_('parent number'), null=True, blank=True, db_index=True, editable=False)
35 _short_html = models.TextField(null=True, blank=True, editable=False)
36 _single = models.NullBooleanField(editable=False, db_index=True)
37 _new_publishable = models.NullBooleanField(editable=False)
38 _published = models.NullBooleanField(editable=False)
40 class NoTextError(BaseException):
44 app_label = 'catalogue'
45 ordering = ['title', 'slug']
46 verbose_name = _('book')
47 verbose_name_plural = _('books')
54 return iter(self.chunk_set.all())
56 def __getitem__(self, chunk):
57 return self.chunk_set.all()[chunk]
60 return self.chunk_set.count()
62 def __nonzero__(self):
64 Necessary so that __len__ isn't used for bool evaluation.
68 def __unicode__(self):
72 def get_absolute_url(self):
73 return ("catalogue_book", [self.slug])
75 def correct_about(self):
76 return "http://%s%s" % (
77 Site.objects.get_current().domain,
78 self.get_absolute_url()
81 # Creating & manipulating
82 # =======================
84 def accessible(self, request):
85 return self.public or request.user.is_authenticated()
88 @transaction.commit_on_success
89 def create(cls, creator, text, *args, **kwargs):
90 b = cls.objects.create(*args, **kwargs)
91 b.chunk_set.all().update(creator=creator)
92 b[0].commit(text, author=creator)
95 def add(self, *args, **kwargs):
96 """Add a new chunk at the end."""
97 return self.chunk_set.reverse()[0].split(*args, **kwargs)
100 @transaction.commit_on_success
101 def import_xml_text(cls, text=u'', previous_book=None,
102 commit_args=None, **kwargs):
103 """Imports a book from XML, splitting it into chunks as necessary."""
104 texts = split_xml(text)
106 instance = previous_book
108 instance = cls(**kwargs)
111 # if there are more parts, set the rest to empty strings
112 book_len = len(instance)
113 for i in range(book_len - len(texts)):
114 texts.append((u'pusta część %d' % (i + 1), u''))
117 for i, (title, text) in enumerate(texts):
119 title = u'część %d' % (i + 1)
121 slug = slughifi(title)
125 chunk.slug = slug[:50]
126 chunk.title = title[:255]
129 chunk = instance.add(slug, title)
131 chunk.commit(text, **commit_args)
135 def make_chunk_slug(self, proposed):
137 Finds a chunk slug not yet used in the book.
139 slugs = set(c.slug for c in self)
141 new_slug = proposed[:50]
142 while new_slug in slugs:
143 new_slug = "%s_%d" % (proposed[:45], i)
147 @transaction.commit_on_success
148 def append(self, other, slugs=None, titles=None):
149 """Add all chunks of another book to self."""
152 number = self[len(self) - 1].number + 1
153 len_other = len(other)
154 single = len_other == 1
156 if slugs is not None:
157 assert len(slugs) == len_other
158 if titles is not None:
159 assert len(titles) == len_other
161 slugs = [slughifi(t) for t in titles]
163 for i, chunk in enumerate(other):
164 # move chunk to new book
166 chunk.number = number
169 # try some title guessing
170 if other.title.startswith(self.title):
171 other_title_part = other.title[len(self.title):].lstrip(' /')
173 other_title_part = other.title
176 # special treatment for appending one-parters:
177 # just use the guessed title and original book slug
178 chunk.title = other_title_part
179 if other.slug.startswith(self.slug):
180 chunk.slug = other.slug[len(self.slug):].lstrip('-_')
182 chunk.slug = other.slug
184 chunk.title = ("%s, %s" % (other_title_part, chunk.title))[:255]
186 chunk.slug = slugs[i]
187 chunk.title = titles[i]
189 chunk.slug = self.make_chunk_slug(chunk.slug)
192 assert not other.chunk_set.exists()
195 @transaction.commit_on_success
196 def prepend_history(self, other):
197 """Prepend history from all the other book's chunks to own."""
200 for i in range(len(self), len(other)):
201 title = u"pusta część %d" % i
202 chunk = self.add(slughifi(title), title)
205 for i in range(len(other)):
206 self[i].prepend_history(other[0])
208 assert not other.chunk_set.exists()
215 def last_published(self):
217 return self.publish_log.all()[0].timestamp
221 def assert_publishable(self):
222 assert self.chunk_set.exists(), _('No chunks in the book.')
224 changes = self.get_current_changes(publishable=True)
225 except self.NoTextError:
226 raise AssertionError(_('Not all chunks have publishable revisions.'))
227 book_xml = self.materialize(changes=changes)
230 bi = BookInfo.from_string(book_xml.encode('utf-8'))
231 except ParseError, e:
232 raise AssertionError(_('Invalid XML') + ': ' + str(e))
234 raise AssertionError(_('No Dublin Core found.'))
235 except ValidationError, e:
236 raise AssertionError(_('Invalid Dublin Core') + ': ' + str(e))
238 valid_about = self.correct_about()
239 assert bi.about == valid_about, _("rdf:about is not") + " " + valid_about
242 return self.slug.startswith('.')
244 def is_new_publishable(self):
245 """Checks if book is ready for publishing.
247 Returns True if there is a publishable version newer than the one
251 new_publishable = False
252 if not self.chunk_set.exists():
255 change = chunk.publishable()
258 if not new_publishable and not change.publish_log.exists():
259 new_publishable = True
260 return new_publishable
261 new_publishable = cached_in_field('_new_publishable')(is_new_publishable)
263 def is_published(self):
264 return self.publish_log.exists()
265 published = cached_in_field('_published')(is_published)
268 return len(self) == 1
269 single = cached_in_field('_single')(is_single)
271 @cached_in_field('_short_html')
272 def short_html(self):
273 return render_to_string('catalogue/book_list/book.html', {'book': self})
277 "_new_publishable": self.is_new_publishable(),
278 "_published": self.is_published(),
279 "_single": self.is_single(),
282 Book.objects.filter(pk=self.pk).update(**update)
283 refresh_instance(self)
286 """This should be done offline."""
292 # Materializing & publishing
293 # ==========================
295 def get_current_changes(self, publishable=True):
297 Returns a list containing one Change for every Chunk in the Book.
298 Takes the most recent revision (publishable, if set).
299 Throws an error, if a proper revision is unavailable for a Chunk.
302 changes = [chunk.publishable() for chunk in self]
304 changes = [chunk.head for chunk in self if chunk.head is not None]
306 raise self.NoTextError('Some chunks have no available text.')
309 def materialize(self, publishable=False, changes=None):
311 Get full text of the document compiled from chunks.
312 Takes the current versions of all texts
313 or versions most recently tagged for publishing,
314 or a specified iterable changes.
317 changes = self.get_current_changes(publishable)
318 return compile_text(change.materialize() for change in changes)
320 def publish(self, user):
322 Publishes a book on behalf of a (local) user.
324 self.assert_publishable()
325 changes = self.get_current_changes(publishable=True)
326 book_xml = self.materialize(changes=changes)
327 apiclient.api_call(user, "books/", {"book_xml": book_xml})
329 br = BookPublishRecord.objects.create(book=self, user=user)
331 ChunkPublishRecord.objects.create(book_record=br, change=c)
332 post_publish.send(sender=br)