update to new flickr metadata format

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

diff --git a/apps/dvcs/models.py b/apps/dvcs/models.py
index 1668dee..24bdeb3 100644 (file)
--- a/apps/dvcs/models.py
+++ b/apps/dvcs/models.py
@@ -1,25 +1,27 @@
+# -*- 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.
+#

 from datetime import datetime
 from datetime import datetime

+import os.path

 
 

+from django.contrib.auth.models import User

 from django.core.files.base import ContentFile
 from django.core.files.base import ContentFile

-from django.core.files.storage import FileSystemStorage
-from django.db import models
+from django.db import models, transaction

 from django.db.models.base import ModelBase
 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
+from django.utils.translation import string_concat, ugettext_lazy as _
+from mercurial import simplemerge

 
 

-from dvcs.fields import GzipFileSystemStorage
-from dvcs.settings import REPO_PATH
+from django.conf import settings
+from dvcs.signals import post_commit, post_publishable
+from dvcs.storage import GzipFileSystemStorage

 
 
 class Tag(models.Model):
 
 
 class Tag(models.Model):

-    """
-        a tag (e.g. document stage) which can be applied to a change
-    """
-
+    """A tag (e.g. document stage) which can be applied to a Change."""

     name = models.CharField(_('name'), max_length=64)
     name = models.CharField(_('name'), max_length=64)

-    slug = models.SlugField(_('slug'), unique=True, max_length=64, 
-            null=True, blank=True)
+    slug = models.SlugField(_('slug'), unique=True, max_length=64, null=True, blank=True)

     ordering = models.IntegerField(_('ordering'))
 
     _object_cache = {}
     ordering = models.IntegerField(_('ordering'))
 
     _object_cache = {}


@@ -44,24 +46,23 @@ class Tag(models.Model):
     def listener_changed(sender, instance, **kwargs):
         sender._object_cache = {}
 
     def listener_changed(sender, instance, **kwargs):
         sender._object_cache = {}
 

-    def next(self):
+    def get_next(self):

         """
             Returns the next tag - stage to work on.
             Returns None for the last stage.
         """
         try:
         """
             Returns the next tag - stage to work on.
             Returns None for the last stage.
         """
         try:

-            return Tag.objects.filter(ordering__gt=self.ordering)[0]
+            return type(self).objects.filter(ordering__gt=self.ordering)[0]

         except IndexError:
             return None
 
 models.signals.pre_save.connect(Tag.listener_changed, sender=Tag)
 
 
         except IndexError:
             return None
 
 models.signals.pre_save.connect(Tag.listener_changed, sender=Tag)
 
 

-repo = GzipFileSystemStorage(location=REPO_PATH)
-

 def data_upload_to(instance, filename):
     return "%d/%d" % (instance.tree.pk, instance.pk)
 
 def data_upload_to(instance, filename):
     return "%d/%d" % (instance.tree.pk, instance.pk)
 

+

 class Change(models.Model):
     """
         Single document change related to previous change. The "parent"
 class Change(models.Model):
     """
         Single document change related to previous change. The "parent"


@@ -70,24 +71,22 @@ class Change(models.Model):
         
         Data file contains a gzipped text of the document.
     """
         
         Data file contains a gzipped text of the 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)
-    data = models.FileField(upload_to=data_upload_to, storage=repo)
-    revision = models.IntegerField(db_index=True)
+    author = models.ForeignKey(User, null=True, blank=True, verbose_name=_('author'))
+    author_name = models.CharField(
+        _('author name'), max_length=128, null=True, blank=True, help_text=_("Used if author is not set."))
+    author_email = models.CharField(
+        _('author email'), max_length=128, null=True, blank=True, help_text=_("Used if author is not set."))
+    revision = models.IntegerField(_('revision'), db_index=True)

 
 

-    parent = models.ForeignKey('self',
-                        null=True, blank=True, default=None,
-                        related_name="children")
+    parent = models.ForeignKey(
+        'self', null=True, blank=True, default=None, verbose_name=_('parent'), related_name="children")

 
 

-    merge_parent = models.ForeignKey('self',
-                        null=True, blank=True, default=None,
-                        related_name="merge_children")
+    merge_parent = models.ForeignKey(
+        'self', null=True, blank=True, default=None, verbose_name=_('merge parent'), related_name="merge_children")

 
 

-    description = models.TextField(blank=True, default='')
-    created_at = models.DateTimeField(editable=False, db_index=True, 
-                        default=datetime.now)
-    publishable = models.BooleanField(default=False)
+    description = models.TextField(_('description'), blank=True, default='')
+    created_at = models.DateTimeField(editable=False, db_index=True, default=datetime.now)
+    publishable = models.BooleanField(_('publishable'), default=False)

 
     class Meta:
         abstract = True
 
     class Meta:
         abstract = True


@@ -109,7 +108,6 @@ class Change(models.Model):
                 self.author_email
                 )
 
                 self.author_email
                 )
 

-

     def save(self, *args, **kwargs):
         """
             take the next available revision number if none yet
     def save(self, *args, **kwargs):
         """
             take the next available revision number if none yet


@@ -117,7 +115,7 @@ class Change(models.Model):
         if self.revision is None:
             tree_rev = self.tree.revision()
             if tree_rev is None:
         if self.revision is None:
             tree_rev = self.tree.revision()
             if tree_rev is None:

-                self.revision = 0
+                self.revision = 1

             else:
                 self.revision = tree_rev + 1
         return super(Change, self).save(*args, **kwargs)
             else:
                 self.revision = tree_rev + 1
         return super(Change, self).save(*args, **kwargs)


@@ -156,58 +154,86 @@ class Change(models.Model):
         """ commit this version of a doc as new head """
         self.tree.commit(text=self.materialize(), **kwargs)
 
         """ commit this version of a doc as new head """
         self.tree.commit(text=self.materialize(), **kwargs)
 

+    def set_publishable(self, publishable):
+        self.publishable = publishable
+        self.save()
+        post_publishable.send(sender=self, publishable=publishable)
+

 
 def create_tag_model(model):
     name = model.__name__ + 'Tag'
 
 def create_tag_model(model):
     name = model.__name__ + 'Tag'

+
+    class Meta(Tag.Meta):
+        app_label = model._meta.app_label
+        verbose_name = string_concat(
+            _("tag"), " ", _("for:"), " ", model._meta.verbose_name)
+        verbose_name_plural = string_concat(
+            _("tags"), " ", _("for:"), " ", model._meta.verbose_name)
+

     attrs = {
         '__module__': model.__module__,
     attrs = {
         '__module__': model.__module__,

+        'Meta': Meta,

     }
     return type(name, (Tag,), attrs)
 
 
 def create_change_model(model):
     name = model.__name__ + 'Change'
     }
     return type(name, (Tag,), attrs)
 
 
 def create_change_model(model):
     name = model.__name__ + 'Change'

+    repo = GzipFileSystemStorage(location=model.REPO_PATH)
+
+    class Meta(Change.Meta):
+        app_label = model._meta.app_label
+        verbose_name = string_concat(
+            _("change"), " ", _("for:"), " ", model._meta.verbose_name)
+        verbose_name_plural = string_concat(
+            _("changes"), " ", _("for:"), " ", model._meta.verbose_name)

 
     attrs = {
         '__module__': model.__module__,
 
     attrs = {
         '__module__': model.__module__,

-        'tree': models.ForeignKey(model, related_name='change_set'),
-        'tags': models.ManyToManyField(model.tag_model, related_name='change_set'),
+        'tree': models.ForeignKey(model, related_name='change_set', verbose_name=_('document')),
+        'tags': models.ManyToManyField(model.tag_model, verbose_name=_('tags'), related_name='change_set'),
+        'data': models.FileField(_('data'), upload_to=data_upload_to, storage=repo),
+        'Meta': Meta,

     }
     return type(name, (Change,), attrs)
 
 
     }
     return type(name, (Change,), attrs)
 
 

-

 class DocumentMeta(ModelBase):
 class DocumentMeta(ModelBase):

-    "Metaclass for Document models."
+    """Metaclass for Document models."""

     def __new__(cls, name, bases, attrs):
     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)
         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, 
+            models.ForeignKey(model.tag_model, verbose_name=_('stage'),

                 null=True, blank=True).contribute_to_class(model, 'stage')
 
             # create real Change model and `head' fk
             model.change_model = create_change_model(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
+            models.ForeignKey(
+                model.change_model, null=True, blank=True, default=None,
+                verbose_name=_('head'), help_text=_("This document's current head."),
+                editable=False).contribute_to_class(model, 'head')

 
 

+            models.ForeignKey(
+                User, null=True, blank=True, editable=False,
+                verbose_name=_('creator'), related_name="created_%s" % name.lower()
+                ).contribute_to_class(model, 'creator')
+
+        return model

 
 
 class Document(models.Model):
 
 
 class Document(models.Model):

-    """
-        File in repository.        
-    """
+    """File in repository. Subclass it to use version control in your app."""
+

     __metaclass__ = DocumentMeta
 
     __metaclass__ = DocumentMeta
 

-    creator = models.ForeignKey(User, null=True, blank=True, editable=False,
-                related_name="created_documents")
+    # default repository path
+    REPO_PATH = os.path.join(settings.MEDIA_ROOT, 'dvcs')

 
 

-    user = models.ForeignKey(User, null=True, blank=True)
+    user = models.ForeignKey(User, null=True, blank=True, verbose_name=_('user'), help_text=_('Work assignment.'))

 
     class Meta:
         abstract = True
 
     class Meta:
         abstract = True


@@ -215,13 +241,6 @@ class Document(models.Model):
     def __unicode__(self):
         return u"{0}, HEAD: {1}".format(self.id, self.head_id)
 
     def __unicode__(self):
         return u"{0}, HEAD: {1}".format(self.id, self.head_id)
 

-    @models.permalink
-    def get_absolute_url(self):
-        return ('dvcs.views.document_data', (), {
-                        'document_id': self.id,
-                        'version': self.head_id,
-        })
-

     def materialize(self, change=None):
         if self.head is None:
             return u''
     def materialize(self, change=None):
         if self.head is None:
             return u''


@@ -231,7 +250,22 @@ class Document(models.Model):
             change = self.change_set.get(pk=change)
         return change.materialize()
 
             change = self.change_set.get(pk=change)
         return change.materialize()
 

-    def commit(self, text, **kwargs):
+    def commit(self, text, author=None, author_name=None, author_email=None, publishable=False, **kwargs):
+        """Commits a new revision.
+
+        This will automatically merge the commit into the main branch,
+        if parent is not document's head.
+
+        :param unicode text: new version of the document
+        :param parent: parent revision (head, if not specified)
+        :type parent: Change or None
+        :param User author: the commiter
+        :param unicode author_name: commiter name (if ``author`` not specified)
+        :param unicode author_email: commiter e-mail (if ``author`` not specified)
+        :param Tag[] tags: list of tags to apply to the new commit
+        :param bool publishable: set new commit as ready to publish
+        :returns: new head
+        """

         if 'parent' not in kwargs:
             parent = self.head
         else:
         if 'parent' not in kwargs:
             parent = self.head
         else:


@@ -239,19 +273,14 @@ class Document(models.Model):
             if parent is not None and not isinstance(parent, Change):
                 parent = self.change_set.objects.get(pk=kwargs['parent'])
 
             if parent is not None and not isinstance(parent, Change):
                 parent = self.change_set.objects.get(pk=kwargs['parent'])
 

-        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
         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()
+            self.stage = max(tags, key=lambda t: t.ordering).get_next()

 
 

-        change = self.change_set.create(author=author,
-                    author_name=author_name,
-                    author_email=author_email,
-                    description=kwargs.get('description', ''),
-                    parent=parent)
+        change = self.change_set.create(
+            author=author, author_name=author_name, author_email=author_email,
+            description=kwargs.get('description', ''), publishable=publishable, parent=parent)

 
         change.tags = tags
         change.data.save('', ContentFile(text.encode('utf-8')))
 
         change.tags = tags
         change.data.save('', ContentFile(text.encode('utf-8')))


@@ -265,10 +294,13 @@ class Document(models.Model):
         else:
             self.head = change
         self.save()
         else:
             self.head = change
         self.save()

+
+        post_commit.send(sender=self.head)
+

         return self.head
 
     def history(self):
         return self.head
 
     def history(self):

-        return self.change_set.filter(revision__gt=-1)
+        return self.change_set.all().order_by('revision')

 
     def revision(self):
         rev = self.change_set.aggregate(
 
     def revision(self):
         rev = self.change_set.aggregate(


@@ -280,8 +312,21 @@ class Document(models.Model):
         return self.change_set.get(revision=rev)
 
     def publishable(self):
         return self.change_set.get(revision=rev)
 
     def publishable(self):

-        changes = self.change_set.filter(publishable=True).order_by('-created_at')[:1]
-        if changes.count():
-            return changes[0]
+        changes = self.history().filter(publishable=True)
+        if changes.exists():
+            return changes.order_by('-revision')[0]

         else:
             return None
         else:
             return None

+
+    @transaction.atomic
+    def prepend_history(self, other):
+        """Takes over the the other document's history and prepends to own."""
+
+        assert self != other
+        other_revs = other.change_set.all().count()
+        # workaround for a non-atomic UPDATE in SQLITE
+        self.change_set.all().update(revision=0-models.F('revision'))
+        self.change_set.all().update(revision=other_revs - models.F('revision'))
+        other.change_set.all().update(tree=self)
+        assert not other.change_set.exists()
+        other.delete()