added model inheritance,

[redakcja.git] / apps / wiki / models.py

diff --git a/apps/wiki/models.py b/apps/wiki/models.py
index a926493..f8c9d25 100644 (file)
--- a/apps/wiki/models.py
+++ b/apps/wiki/models.py
@@ -3,6 +3,10 @@
 # This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
 #
+import itertools
+import re
+
+from django.core.urlresolvers import reverse
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 
@@ -13,16 +17,22 @@ import logging
 logger = logging.getLogger("fnp.wiki")
 
 
+RE_TRIM_BEGIN = re.compile("^<!-- TRIM_BEGIN -->$", re.M)
+RE_TRIM_END = re.compile("^<!-- TRIM_END -->$", re.M)
+
+
 class Book(models.Model):
     """ A document edited on the wiki """
 
-    slug = models.SlugField(_('slug'), max_length=255, unique=True)
-    title = models.CharField(_('displayed title'), max_length=255, blank=True)
-    doc = models.ForeignKey(dvcs_models.Document, editable=False)
+    title = models.CharField(_('title'), max_length=255)
+    slug = models.SlugField(_('slug'), max_length=128, unique=True)
     gallery = models.CharField(_('scan gallery name'), max_length=255, blank=True)
 
+    parent = models.ForeignKey('self', null=True, blank=True, verbose_name=_('parent'), related_name="children")
+    parent_number = models.IntegerField(_('parent number'), null=True, blank=True, db_index=True)
+
     class Meta:
-        ordering = ['title']
+        ordering = ['parent_number', 'title']
         verbose_name = _('book')
         verbose_name_plural = _('books')
 
@@ -31,20 +41,102 @@ class Book(models.Model):
 
     @classmethod
     def create(cls, creator=None, text=u'', *args, **kwargs):
+        """
+            >>> Book.create(slug='x', text='abc').materialize()
+            'abc'
+        """
         instance = cls(*args, **kwargs)
-        instance.doc = dvcs_models.Document.create(creator=creator, text=text)
         instance.save()
+        instance[0].commit(author=creator, text=text)
         return instance
 
+    def __iter__(self):
+        return iter(self.chunk_set.all())
+
+    def __getitem__(self, chunk):
+        return self.chunk_set.all()[chunk]
+
+    def __len__(self):
+        return self.chunk_set.count()
+
+    @staticmethod
+    def trim(text, trim_begin=True, trim_end=True):
+        """ 
+            Cut off everything before RE_TRIM_BEGIN and after RE_TRIM_END, so
+            that eg. one big XML file can be compiled from many small XML files.
+        """
+        if trim_begin:
+            text = RE_TRIM_BEGIN.split(text, maxsplit=1)[-1]
+        if trim_end:
+            text = RE_TRIM_END.split(text, maxsplit=1)[0]
+        return text
+
+    def materialize(self):
+        """ 
+            Get full text of the document compiled from chunks.
+            Takes the current versions of all texts for now, but it should
+            be possible to specify a tag or a point in time for compiling.
+
+            First non-empty text's beginning isn't trimmed,
+            and last non-empty text's end isn't trimmed.
+        """
+        texts = []
+        trim_begin = False
+        text = ''
+        for chunk in self:
+            next_text = chunk.materialize()
+            if not next_text:
+                continue
+            if text:
+                # trim the end, because there's more non-empty text
+                # don't trim beginning, if `text' is the first non-empty part
+                texts.append(self.trim(text, trim_begin=trim_begin))
+                trim_begin = True
+            text = next_text
+        # don't trim the end, because there's no more text coming after `text'
+        # only trim beginning if it's not still the first non-empty
+        texts.append(self.trim(text, trim_begin=trim_begin, trim_end=False))
+        return "".join(texts)
+
     @staticmethod
     def listener_create(sender, instance, created, **kwargs):
-        if created and instance.doc is None:
-            instance.doc = dvcs_models.Document.objects.create()
-            instance.save()
+        if created:
+            instance.chunk_set.create(number=1, slug='1')
 
 models.signals.post_save.connect(Book.listener_create, sender=Book)
 
 
+class Chunk(dvcs_models.Document):
+    """ An editable chunk of text. Every Book text is divided into chunks. """
+
+    book = models.ForeignKey(Book)
+    number = models.IntegerField()
+    slug = models.SlugField()
+    comment = models.CharField(max_length=255)
+
+    class Meta:
+        unique_together = [['book', 'number'], ['book', 'slug']]
+        ordering = ['number']
+
+    def __unicode__(self):
+        return "%d-%d: %s" % (self.book_id, self.number, self.comment)
+
+    def get_absolute_url(self):
+        return reverse("wiki_editor", args=[self.book.slug, self.slug])
+
+    @classmethod
+    def get(cls, slug, chunk=None):
+        if chunk is None:
+            return cls.objects.get(book__slug=slug, number=1)
+        else:
+            return cls.objects.get(book__slug=slug, slug=chunk)
+
+    def pretty_name(self):
+        return "%s, %s (%d/%d)" % (self.book.title, self.comment, 
+                self.number, len(self.book))
+
+
+
 
 '''
 from wiki import settings, constants