+from datetime import datetime
+
from django.db import models
+from django.db.models.base import ModelBase
from django.contrib.auth.models import User
from django.utils.translation import ugettext_lazy as _
from mercurial import mdiff, simplemerge
import pickle
+
+class Tag(models.Model):
+ """
+ a tag (e.g. document stage) which can be applied to a change
+ """
+
+ name = models.CharField(_('name'), max_length=64)
+ slug = models.SlugField(_('slug'), unique=True, max_length=64,
+ null=True, blank=True)
+ ordering = models.IntegerField(_('ordering'))
+
+ _object_cache = {}
+
+ class Meta:
+ abstract = True
+ ordering = ['ordering']
+
+ def __unicode__(self):
+ return self.name
+
+ @classmethod
+ def get(cls, slug):
+ if slug in cls._object_cache:
+ return cls._object_cache[slug]
+ else:
+ obj = cls.objects.get(slug=slug)
+ cls._object_cache[slug] = obj
+ return obj
+
+ @staticmethod
+ def listener_changed(sender, instance, **kwargs):
+ sender._object_cache = {}
+
+ def next(self):
+ """
+ Returns the next tag - stage to work on.
+ Returns None for the last stage.
+ """
+ try:
+ return Tag.objects.filter(ordering__gt=self.ordering)[0]
+ except IndexError:
+ return None
+
+models.signals.pre_save.connect(Tag.listener_changed, sender=Tag)
+
+
class Change(models.Model):
"""
Single document change related to previous change. The "parent"
Data contains a pickled diff needed to reproduce the initial document.
"""
author = models.ForeignKey(User, null=True, blank=True)
+ author_name = models.CharField(max_length=128, null=True, blank=True)
+ author_email = models.CharField(max_length=128, null=True, blank=True)
patch = models.TextField(blank=True)
- tree = models.ForeignKey('Document')
+ revision = models.IntegerField(db_index=True)
parent = models.ForeignKey('self',
null=True, blank=True, default=None,
related_name="merge_children")
description = models.TextField(blank=True, default='')
- created_at = models.DateTimeField(auto_now_add=True)
+ created_at = models.DateTimeField(editable=False, db_index=True,
+ default=datetime.now)
+ publishable = models.BooleanField(default=False)
class Meta:
+ abstract = True
ordering = ('created_at',)
+ unique_together = ['tree', 'revision']
def __unicode__(self):
return u"Id: %r, Tree %r, Parent %r, Patch '''\n%s'''" % (self.id, self.tree_id, self.parent_id, self.patch)
+ def author_str(self):
+ if self.author:
+ return "%s %s <%s>" % (
+ self.author.first_name,
+ self.author.last_name,
+ self.author.email)
+ else:
+ return "%s <%s>" % (
+ self.author_name,
+ self.author_email
+ )
+
+
+ def save(self, *args, **kwargs):
+ """
+ take the next available revision number if none yet
+ """
+ if self.revision is None:
+ self.revision = self.tree.revision() + 1
+ return super(Change, self).save(*args, **kwargs)
+
@staticmethod
def make_patch(src, dst):
if isinstance(src, unicode):
if self.parent is None and self.merge_parent is not None:
return self.apply_to(self.merge_parent.materialize())
- changes = Change.objects.filter(
- ~models.Q(parent=None) | models.Q(merge_parent=None),
- tree=self.tree,
- created_at__lte=self.created_at).order_by('created_at')
- text = u''
+ changes = self.tree.change_set.exclude(parent=None).filter(
+ revision__lte=self.revision).order_by('revision')
+ text = ''
for change in changes:
text = change.apply_to(text)
- return text
+ return text.decode('utf-8')
- def make_child(self, patch, author, description):
- return self.children.create(patch=patch,
+ def make_child(self, patch, description, author=None,
+ author_name=None, author_email=None, tags=None):
+ ch = self.children.create(patch=patch,
tree=self.tree, author=author,
+ author_name=author_name,
+ author_email=author_email,
description=description)
+ if tags is not None:
+ ch.tags = tags
+ return ch
- def make_merge_child(self, patch, author, description):
- return self.merge_children.create(patch=patch,
+ def make_merge_child(self, patch, description, author=None,
+ author_name=None, author_email=None, tags=None):
+ ch = self.merge_children.create(patch=patch,
tree=self.tree, author=author,
- description=description)
+ author_name=author_name,
+ author_email=author_email,
+ description=description,
+ tags=tags)
+ if tags is not None:
+ ch.tags = tags
+ return ch
def apply_to(self, text):
return mdiff.patch(text, pickle.loads(self.patch.encode('ascii')))
- def merge_with(self, other, author, description=u"Automatic merge."):
+ def merge_with(self, other, author=None,
+ author_name=None, author_email=None,
+ description=u"Automatic merge."):
assert self.tree_id == other.tree_id # same tree
if other.parent_id == self.pk:
# immediate child
patch = self.make_patch(local, result)
return self.children.create(
patch=patch, merge_parent=other, tree=self.tree,
- author=author, description=description)
+ author=author,
+ author_name=author_name,
+ author_email=author_email,
+ description=description)
def revert(self, **kwargs):
""" commit this version of a doc as new head """
self.tree.commit(text=self.materialize(), **kwargs)
+def create_tag_model(model):
+ name = model.__name__ + 'Tag'
+ attrs = {
+ '__module__': model.__module__,
+ }
+ return type(name, (Tag,), attrs)
+
+
+def create_change_model(model):
+ name = model.__name__ + 'Change'
+
+ attrs = {
+ '__module__': model.__module__,
+ 'tree': models.ForeignKey(model, related_name='change_set'),
+ 'tags': models.ManyToManyField(model.tag_model, related_name='change_set'),
+ }
+ return type(name, (Change,), attrs)
+
+
+
+class DocumentMeta(ModelBase):
+ "Metaclass for Document models."
+ def __new__(cls, name, bases, attrs):
+ model = super(DocumentMeta, cls).__new__(cls, name, bases, attrs)
+ if not model._meta.abstract:
+ # create a real Tag object and `stage' fk
+ model.tag_model = create_tag_model(model)
+ models.ForeignKey(model.tag_model,
+ null=True, blank=True).contribute_to_class(model, 'stage')
+
+ # create real Change model and `head' fk
+ model.change_model = create_change_model(model)
+ models.ForeignKey(model.change_model,
+ null=True, blank=True, default=None,
+ help_text=_("This document's current head."),
+ editable=False).contribute_to_class(model, 'head')
+
+ return model
+
+
+
class Document(models.Model):
"""
File in repository.
"""
- creator = models.ForeignKey(User, null=True, blank=True)
- head = models.ForeignKey(Change,
- null=True, blank=True, default=None,
- help_text=_("This document's current head."))
+ __metaclass__ = DocumentMeta
- @classmethod
- def create(cls, text='', *args, **kwargs):
- instance = cls(*args, **kwargs)
- instance.save()
- head = instance.head
- head.patch = Change.make_patch('', text)
- head.save()
- return instance
+ creator = models.ForeignKey(User, null=True, blank=True, editable=False,
+ related_name="created_documents")
+
+ user = models.ForeignKey(User, null=True, blank=True)
+
+ class Meta:
+ abstract = True
def __unicode__(self):
return u"{0}, HEAD: {1}".format(self.id, self.head_id)
else:
parent = kwargs['parent']
if not isinstance(parent, Change):
- parent = Change.objects.get(pk=kwargs['parent'])
+ parent = self.change_set.objects.get(pk=kwargs['parent'])
if 'patch' not in kwargs:
if 'text' not in kwargs:
raise ValueError("You can provide only text or patch - not both")
patch = kwargs['patch']
+ author = kwargs.get('author', None)
+ author_name = kwargs.get('author_name', None)
+ author_email = kwargs.get('author_email', None)
+ tags = kwargs.get('tags', [])
+ if tags:
+ # set stage to next tag after the commited one
+ self.stage = max(tags, key=lambda t: t.ordering).next()
+
old_head = self.head
if parent != old_head:
- change = parent.make_merge_child(patch, kwargs['author'], kwargs.get('description', ''))
+ change = parent.make_merge_child(patch, author=author,
+ author_name=author_name,
+ author_email=author_email,
+ description=kwargs.get('description', ''),
+ tags=tags)
# not Fast-Forward - perform a merge
- self.head = old_head.merge_with(change, author=kwargs['author'])
+ self.head = old_head.merge_with(change, author=author,
+ author_name=author_name,
+ author_email=author_email)
else:
- self.head = parent.make_child(patch, kwargs['author'], kwargs.get('description', ''))
+ self.head = parent.make_child(patch, author=author,
+ author_name=author_name,
+ author_email=author_email,
+ description=kwargs.get('description', ''),
+ tags=tags)
self.save()
return self.head
def history(self):
- return self.change_set.all()
+ return self.change_set.filter(revision__gt=-1)
def revision(self):
- return self.change_set.all().count()
+ rev = self.change_set.aggregate(
+ models.Max('revision'))['revision__max']
+ return rev if rev is not None else -1
def at_revision(self, rev):
- if rev:
- return self.change_set.all()[rev-1]
+ if rev is not None:
+ return self.change_set.get(revision=rev)
else:
return self.head
+ def publishable(self):
+ changes = self.change_set.filter(publishable=True).order_by('-created_at')[:1]
+ if changes.count():
+ return changes[0]
+ else:
+ return None
+
@staticmethod
def listener_initial_commit(sender, instance, created, **kwargs):
+ # run for Document and its subclasses
+ if not isinstance(instance, Document):
+ return
if created:
- instance.head = Change.objects.create(
+ instance.head = instance.change_model.objects.create(
+ revision=-1,
author=instance.creator,
patch=Change.make_patch('', ''),
tree=instance)
instance.save()
-models.signals.post_save.connect(Document.listener_initial_commit, sender=Document)
+models.signals.post_save.connect(Document.listener_initial_commit)
fnp / redakcja.git / blobdiff