import itertools
import re
+from django.core.urlresolvers import reverse
from django.db import models
+from django.utils.safestring import mark_safe
from django.utils.translation import ugettext_lazy as _
+from django.template.loader import render_to_string
from dvcs import models as dvcs_models
-
+from wiki.xml_tools import compile_text
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 """
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)
+ last_published = models.DateTimeField(null=True, editable=False)
+
+ _list_html = models.TextField(editable=False, null=True)
+
+ class NoTextError(BaseException):
+ pass
class Meta:
ordering = ['parent_number', 'title']
def __unicode__(self):
return self.title
+ def get_absolute_url(self):
+ return reverse("wiki_book", args=[self.slug])
+
+ def save(self, reset_list_html=True, *args, **kwargs):
+ if reset_list_html:
+ self._list_html = None
+ return super(Book, self).save(*args, **kwargs)
+
@classmethod
def create(cls, creator=None, text=u'', *args, **kwargs):
"""
"""
instance = cls(*args, **kwargs)
instance.save()
- instance.chunk_set.all()[0].doc.commit(author=creator, text=text)
+ instance[0].commit(author=creator, text=text)
return instance
- @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 __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()
+
+ def list_html(self):
+ if self._list_html is None:
+ print 'rendering', self.title
+ self._list_html = render_to_string('wiki/document_list_item.html',
+ {'book': self})
+ self.save(reset_list_html=False)
+ return mark_safe(self._list_html)
- def materialize(self):
+ def materialize(self, publishable=True):
"""
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.
+ Takes the current versions of all texts
+ or versions most recently tagged for publishing.
+ """
+ if publishable:
+ changes = [chunk.publishable() for chunk in self]
+ else:
+ changes = [chunk.head for chunk in self]
+ if None in changes:
+ raise self.NoTextError('Some chunks have no available text.')
+ return compile_text(change.materialize() for change in changes)
+
+ def publishable(self):
+ if not len(self):
+ return False
+ for chunk in self:
+ if not chunk.publishable():
+ return False
+ return True
+
+ def make_chunk_slug(self, proposed):
+ """
+ Finds a chunk slug not yet used in the book.
"""
- texts = []
- trim_begin = False
- text = ''
- for chunk in self.chunk_set.all():
- next_text = chunk.doc.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)
+ slugs = set(c.slug for c in self)
+ i = 1
+ new_slug = proposed
+ while new_slug in slugs:
+ new_slug = "%s-%d" % (proposed, i)
+ i += 1
+ return new_slug
+
+ def append(self, other):
+ number = self[len(self) - 1].number + 1
+ single = len(other) == 1
+ for chunk in other:
+ # move chunk to new book
+ chunk.book = self
+ chunk.number = number
+
+ # try some title guessing
+ if other.title.startswith(self.title):
+ other_title_part = other.title[len(self.title):].lstrip(' /')
+ else:
+ other_title_part = other.title
+
+ if single:
+ # special treatment for appending one-parters:
+ # just use the guessed title and original book slug
+ chunk.comment = other_title_part
+ if other.slug.startswith(self.slug):
+ chunk_slug = other.slug[len(self.slug):].lstrip('-_')
+ else:
+ chunk_slug = other.slug
+ chunk.slug = self.make_chunk_slug(chunk_slug)
+ else:
+ chunk.comment = "%s, %s" % (other_title_part, chunk.comment)
+ chunk.slug = self.make_chunk_slug(chunk.slug)
+ chunk.save()
+ number += 1
+ other.delete()
@staticmethod
def listener_create(sender, instance, created, **kwargs):
models.signals.post_save.connect(Book.listener_create, sender=Book)
-class Chunk(models.Model):
+class Chunk(dvcs_models.Document):
""" An editable chunk of text. Every Book text is divided into chunks. """
- book = models.ForeignKey(Book)
+ book = models.ForeignKey(Book, editable=False)
number = models.IntegerField()
slug = models.SlugField()
- comment = models.CharField(max_length=255)
- doc = models.ForeignKey(dvcs_models.Document, editable=False, unique=True, null=True)
+ comment = models.CharField(max_length=255, blank=True)
class Meta:
unique_together = [['book', 'number'], ['book', 'slug']]
def __unicode__(self):
return "%d-%d: %s" % (self.book_id, self.number, self.comment)
- def save(self, *args, **kwargs):
- if self.doc is None:
- self.doc = dvcs_models.Document.objects.create()
- super(Chunk, self).save(*args, **kwargs)
+ def get_absolute_url(self):
+ return reverse("wiki_editor", args=[self.book.slug, self.slug])
@classmethod
def get(cls, slug, chunk=None):
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, self.book.chunk_set.count())
+ title = self.book.title
+ if self.comment:
+ title += ", %s" % self.comment
+ count = len(self.book)
+ if count > 1:
+ title += " (%d/%d)" % (self.number, len(self.book))
+ return title
+
+ def split(self, slug, comment='', creator=None):
+ """ Create an empty chunk after this one """
+ self.book.chunk_set.filter(number__gt=self.number).update(
+ number=models.F('number')+1)
+ new_chunk = self.book.chunk_set.create(number=self.number+1,
+ creator=creator, slug=slug, comment=comment)
+ return new_chunk
+
+ def list_html(self):
+ _list_html = render_to_string('wiki/chunk_list_item.html',
+ {'chunk': self})
+ return mark_safe(_list_html)
+ @staticmethod
+ def listener_saved(sender, instance, created, **kwargs):
+ if instance.book:
+ # save book so that its _list_html is reset
+ instance.book.save()
+models.signals.post_save.connect(Chunk.listener_saved, sender=Chunk)
-'''
-from wiki import settings, constants
-from slughifi import slughifi
-
-from django.http import Http404
-
-
-
-
-class Document(object):
-
- def add_tag(self, tag, revision, author):
- """ Add document specific tag """
- logger.debug("Adding tag %s to doc %s version %d", tag, self.name, revision)
- self.storage.vstorage.add_page_tag(self.name, revision, tag, user=author)
-
- @property
- def plain_text(self):
- return re.sub(self.META_REGEX, '', self.text, 1)
-
- def meta(self):
- result = {}
-
- m = re.match(self.META_REGEX, self.text)
- if m:
- for line in m.group(1).split('\n'):
- try:
- k, v = line.split(':', 1)
- result[k.strip()] = v.strip()
- except ValueError:
- continue
-
- gallery = result.get('gallery', slughifi(self.name.replace(' ', '_')))
-
- if gallery.startswith('/'):
- gallery = os.path.basename(gallery)
-
- result['gallery'] = gallery
- return result
-
- def info(self):
- return self.storage.vstorage.page_meta(self.name, self.revision)
-
-
-
-'''
class Theme(models.Model):
name = models.CharField(_('name'), max_length=50, unique=True)