X-Git-Url: https://git.mdrn.pl/redakcja.git/blobdiff_plain/f499ee9347f539c36f3846fdc41020f2320bae77..af0693ddb5e4f6240d273c8a66fd1e6ef2a52872:/apps/wiki/models.py diff --git a/apps/wiki/models.py b/apps/wiki/models.py index a530916f..66f8a288 100644 --- a/apps/wiki/models.py +++ b/apps/wiki/models.py @@ -1,75 +1,151 @@ # -*- coding: utf-8 -*- # # This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later. -# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information. +# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information. # +import itertools import re -import os -import vstorage -from vstorage import DocumentNotFound -from wiki import settings -from django.http import Http404 +from django.db import models +from django.utils.translation import ugettext_lazy as _ + +from dvcs import models as dvcs_models + import logging logger = logging.getLogger("fnp.wiki") -class DocumentStorage(object): - def __init__(self, path): - self.vstorage = vstorage.VersionedStorage(path) - def get(self, name, revision = None): - if revision is None: - text = self.vstorage.page_text(name) +RE_TRIM_BEGIN = re.compile("^$", re.M) +RE_TRIM_END = re.compile("^$", re.M) + + +class Book(models.Model): + """ A document edited on the wiki """ + + 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 = ['parent_number', 'title'] + verbose_name = _('book') + verbose_name_plural = _('books') + + def __unicode__(self): + return self.title + + @classmethod + def create(cls, creator=None, text=u'', *args, **kwargs): + """ + >>> Book.create(slug='x', text='abc').materialize() + 'abc' + """ + instance = cls(*args, **kwargs) + instance.save() + instance.chunk_set.all()[0].doc.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 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.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) + + @staticmethod + def listener_create(sender, instance, created, **kwargs): + if created: + instance.chunk_set.create(number=1, slug='1') + +models.signals.post_save.connect(Book.listener_create, sender=Book) + + +class Chunk(models.Model): + """ 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) + doc = models.ForeignKey(dvcs_models.Document, editable=False, unique=True, null=True) + + 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 save(self, *args, **kwargs): + if self.doc is None: + self.doc = dvcs_models.Document.objects.create() + super(Chunk, self).save(*args, **kwargs) + + @classmethod + def get(cls, slug, chunk=None): + if chunk is None: + return cls.objects.get(book__slug=slug, number=1) else: - text = self.vstorage.revision_text(name, revision) - return Document(self, name = name, text = text) - - def get_or_404(self, *args, **kwargs): - try: - return self.get(*args, **kwargs) - except DocumentNotFound: - raise Http404 - - def put(self, document, author, comment, parent): - self.vstorage.save_text( - title = document.name, - text = document.text, - author = author, - comment = comment, - parent = parent) - - def delete(self, name, author, comment): - self.vstorage.delete_page(name, author, comment) - - def all(self): - return list(self.vstorage.all_pages()) - - def history(self, title): - return list(self.vstorage.page_history(title)) - - def _info(self, name): - return self.vstorage.page_meta(name) + 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()) + + + + +''' +from wiki import settings, constants +from slughifi import slughifi + +from django.http import Http404 + + class Document(object): - META_REGEX = re.compile(r'\s*', re.DOTALL | re.MULTILINE) - - def __init__(self, storage, **kwargs): - self.storage = storage - for attr, value in kwargs.iteritems(): - setattr(self, attr, value) - - def revision(self): - try: - return self.storage._info(self.name)[0] - except DocumentNotFound: - return -1 - - def add_tag(self, tag): + + def add_tag(self, tag, revision, author): """ Add document specific tag """ - logger.debug("Adding tag %s to doc %s version %d", tag, self.name, self.revision) - self.storage.vstorage.add_page_tag(self.name, self.revision, 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): @@ -85,25 +161,33 @@ class Document(object): k, v = line.split(':', 1) result[k.strip()] = v.strip() except ValueError: - continue - - gallery = result.get('gallery', self.name.replace(' ', '_')) - - if gallery.startswith('/'): + continue + + gallery = result.get('gallery', slughifi(self.name.replace(' ', '_'))) + + if gallery.startswith('/'): gallery = os.path.basename(gallery) - - result['gallery'] = gallery - - if 'title' not in result: - result['title'] = self.name.title() + result['gallery'] = gallery return result - + def info(self): - return dict(zip( - ('revision', 'last_update', 'last_comitter', 'commit_message'), - self.storage._info(self.name) - )) + return self.storage.vstorage.page_meta(self.name, self.revision) + + + +''' +class Theme(models.Model): + name = models.CharField(_('name'), max_length=50, unique=True) + + class Meta: + ordering = ('name',) + verbose_name = _('theme') + verbose_name_plural = _('themes') + + def __unicode__(self): + return self.name + + def __repr__(self): + return "Theme(name=%r)" % self.name -def getstorage(): - return DocumentStorage(settings.REPOSITORY_PATH)