Changing plugin base models for a more intuitive understanding of what types of…

Changing plugin base models for a more intuitive understanding of what types of models should exist. The image model should maintain revisions of itself to avoid a difficult process when replacing images.

wiki/models/article.py

@@ -228,13 +228,14 @@ class ArticleRevision(BaseRevisionMixin, models.Model):
     # the last used revision...
     title = models.CharField(max_length=512, verbose_name=_(u'article title'), 
                              null=False, blank=False, help_text=_(u'Each revision contains a title field that must be filled out, even if the title has not changed'))
-
+    
+    # TODO:
     # Allow a revision to redirect to another *article*. This 
     # way, we can redirects and still maintain old content.
-    redirect = models.ForeignKey('Article', null=True, blank=True,
-                                 verbose_name=_(u'redirect'),
-                                 help_text=_(u'If set, the article will redirect to the contents of another article.'),
-                                 related_name='redirect_set')
+    #redirect = models.ForeignKey('Article', null=True, blank=True,
+    #                             verbose_name=_(u'redirect'),
+    #                             help_text=_(u'If set, the article will redirect to the contents of another article.'),
+    #                             related_name='redirect_set')
     
     def __unicode__(self):
         return "%s (%d)" % (self.title, self.revision_number)
@@ -250,7 +251,6 @@ class ArticleRevision(BaseRevisionMixin, models.Model):
         self.title = predecessor.title
         self.deleted = predecessor.deleted
         self.locked = predecessor.locked
-        self.redirect = predecessor.redirect
     
     def save(self, *args, **kwargs):
         if (not self.id and

wiki/models/pluginbase.py

@@ -2,19 +2,24 @@
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 from django.db.models import signals
+from wiki.models.article import BaseRevisionMixin
 
 """
-There are two kinds of plugin objects:
-  1) ArticlePlugin - an object associated with an article. Does not reference
-     a Revision.
+There are three kinds of plugin objects:
+  1) SimplePlugin - an object purely associated with an article. Will bump the
+     article's revision history upon creation, and rolling back an article will
+     make it go away (not from the database, you can roll forwards again).
      
-  2) RevisionPlugin - an object associated with a revision. This object
-     is automatically referenced to each new revision, and if you create
-     a new object, a new revision will be created.
+  2) RevisionPlugin - an object with its own revisions. The object will have its
+     own history independent of the article. The strategy is that you will provide
+     different code for the article text while including it, so it will indirectly
+     affect the article history, but you have the force of rolling back this
+     object independently.
   
   3) ReusablePlugin - a plugin that can be used on many articles. Please note
      that the logics for keeping revisions on such plugins are complicated, so you
-     have to implement that on your own.
+     have to implement that on your own. Furthermore, you need to be aware of
+     the permission system!
 """
 
 from article import Article, ArticleRevision
@@ -22,7 +27,7 @@ from article import Article, ArticleRevision
 from wiki.conf import settings 
 
 class ArticlePlugin(models.Model):
-    """Always extend from this if you're making a plugin. That way, a deletion
+    """This is the mother of all plugins. Extending from it means a deletion
     of an article will CASCADE to your plugin, and the database will be kept
     clean. Furthermore, it's possible to list all plugins and maintain generic
     properties in the future..."""    
@@ -80,9 +85,9 @@ class ReusablePlugin(ArticlePlugin):
     class Meta:
         app_label = settings.APP_LABEL
 
-class RevisionPluginCreateError(Exception): pass
+class SimplePluginCreateError(Exception): pass
 
-class RevisionPlugin(ArticlePlugin):
+class SimplePlugin(ArticlePlugin):
     """
     Inherit from this model and make sure to specify an article when
     saving a new instance. This way, a new revision will be created, and
@@ -93,21 +98,20 @@ class RevisionPlugin(ArticlePlugin):
     
     Usage:
     
-    class YourPlugin(RevisionPlugin):
+    class YourPlugin(SimplePlugin):
         ...
     
     Creating new plugins instances:
     YourPlugin(article=article_instance, ...) or
     YourPlugin.objects.create(article=article_instance, ...)
-    
-    
     """
-    revision = models.ForeignKey(ArticleRevision, on_delete=models.CASCADE)
+    # The article revision that this plugin is attached to
+    article_revision = models.ForeignKey(ArticleRevision, on_delete=models.CASCADE)
     
     def __init__(self, *args, **kwargs):
-        super(RevisionPlugin, self).__init__(*args, **kwargs)
+        super(SimplePlugin, self).__init__(*args, **kwargs)
         if not self.id and not 'article' in kwargs:
-            raise RevisionPluginCreateError("Keyword argument 'article' expected.")
+            raise SimplePluginCreateError("Keyword argument 'article' expected.")
             self.article = kwargs['article']
         
     def get_logmessage(self):
@@ -116,18 +120,94 @@ class RevisionPlugin(ArticlePlugin):
     def save(self, *args, **kwargs):
         if not self.id:
             if not self.article.current_revision:
-                raise RevisionPluginCreateError("Article does not have a current_revision set.")
+                raise SimplePluginCreateError("Article does not have a current_revision set.")
             new_revision = ArticleRevision()
             new_revision.inherit_predecessor(self.article)
             new_revision.automatic_log = self.get_logmessage()
             new_revision.save()
             
-            self.revision = new_revision
-        super(RevisionPlugin, self).save(*args, **kwargs)
+            self.article_revision = new_revision
+        super(SimplePlugin, self).save(*args, **kwargs)
+    
+    class Meta:
+        app_label = settings.APP_LABEL
+
+class RevisionPlugin(ArticlePlugin):
+    """
+    If you want your plugin to maintain revisions, extend from this one,
+    not SimplePlugin.
+    
+    This kind of plugin is not attached to article plugins so rolling articles
+    back and forth does not affect it.
+    """
+    # The current revision of this plugin, if any!
+    current_revision = models.OneToOneField('RevisionPluginRevision', 
+                                            verbose_name=_(u'current revision'),
+                                            blank=True, null=True, related_name='plugin_set',
+                                            help_text=_(u'The revision being displayed for this plugin.'
+                                                         'If you need to do a roll-back, simply change the value of this field.'),
+                                            )
     
     class Meta:
         app_label = settings.APP_LABEL
 
+class RevisionPluginRevision(BaseRevisionMixin, models.Model):
+    """
+    If you want your plugin to maintain revisions, make an extra model
+    that extends from this one.
+    
+    (this class is very much copied from wiki.models.article.ArticleRevision
+    """
+    
+    plugin = models.ForeignKey(RevisionPlugin)
+
+    def save(self, *args, **kwargs):
+        if (not self.id and
+            not self.previous_revision and 
+            self.plugin and
+            self.plugin.current_revision and 
+            self.plugin.current_revision != self):
+            
+            self.previous_revision = self.plugin.current_revision
+
+        if not self.revision_number:
+            try:
+                previous_revision = self.article.articlerevision_set.latest()
+                self.revision_number = previous_revision.revision_number + 1
+            except ArticleRevision.DoesNotExist:
+                self.revision_number = 1
+
+        super(RevisionPluginRevision, self).save(*args, **kwargs)
+        
+        if not self.plugin.current_revision:
+            # If I'm saved from Django admin, then plugin.current_revision is me!
+            self.plugin.current_revision = self
+            self.plugin.save()
+
+
+    def add_revision(self, new_revision, save=True):
+        """
+        Sets the properties of a revision and ensures its the current
+        revision.
+        """
+        assert self.id or save, ('RevisionPluginRevision.add_revision: Sorry, you cannot add a' 
+                                 'revision to a plugin that has not been saved '
+                                 'without using save=True')
+        if not self.id: self.save()
+        revisions = self.pluginrevision_set.all()
+        try:
+            new_revision.revision_number = revisions.latest().revision_number + 1
+        except RevisionPlugin.DoesNotExist:
+            new_revision.revision_number = 0
+        new_revision.plugin = self
+        new_revision.previous_revision = self.current_revision
+        if save: new_revision.save()
+        self.current_revision = new_revision
+        if save: self.save()
+
+    class Meta:
+        app_label = settings.APP_LABEL
+
 ######################################################
 # SIGNAL HANDLERS
 ######################################################
@@ -137,11 +217,11 @@ class RevisionPlugin(ArticlePlugin):
 # It's my art, when I disguise my body in the shape of a plane.
 # (Shellac, 1993)
 
-def update_revision_plugins(instance, *args, **kwargs):
+def update_simple_plugins(instance, *args, **kwargs):
     """Every time a new article revision is created, we update all active 
     plugins to match this article revision"""
     if kwargs.get('created', False):
-        p_revisions = RevisionPlugin.objects.filter(article=instance.article, deleted=False)
+        p_revisions = SimplePlugin.objects.filter(article=instance.article, deleted=False)
         p_revisions.update(revision=instance)
 
-signals.post_save.connect(update_revision_plugins, ArticleRevision)
\ No newline at end of file
+signals.post_save.connect(update_simple_plugins, ArticleRevision)
\ No newline at end of file

wiki/plugins/images/admin.py

@@ -2,11 +2,12 @@ from django.contrib import admin
 
 import models
 
-class ImageAdmin(admin.ModelAdmin):
+class ImageRevisionInline(admin.TabularInline):
+    model = models.ImageRevision
+    extra = 1
+    fields = ('image', 'locked', 'deleted')
     
-    # Do not let images be added in the admin. An image can only be added
-    # from the article admin due to the automatic revision system.
-    def has_add_permission(self, request):
-        return False
+class ImageAdmin(admin.ModelAdmin):
+    inlines = (ImageRevisionInline,)
 
 admin.site.register(models.Image, ImageAdmin)
\ No newline at end of file

wiki/plugins/images/forms.py

@@ -15,5 +15,5 @@ class SidebarForm(forms.ModelForm, PluginSidebarFormMixin):
         return _(u"New image %s was successfully uploaded. You can use it by selecting it from the list of available images.") % self.instance.get_filename()
     
     class Meta:
-        model = models.Image
+        model = models.ImageRevision
         fields = ('image',)
\ No newline at end of file

wiki/plugins/images/models.py

@@ -5,27 +5,34 @@ from django.utils.translation import ugettext_lazy as _
 
 import settings
 
-from wiki.models.pluginbase import RevisionPlugin
+from wiki.models.pluginbase import RevisionPlugin, RevisionPluginRevision
 
 if not "sorl.thumbnail" in django_settings.INSTALLED_APPS:
     raise ImproperlyConfigured('wiki.plugins.images: needs sorl.thumbnail in INSTALLED_APPS')
 
 class Image(RevisionPlugin):
     
-    image = models.ImageField(upload_to=settings.IMAGE_PATH,
-                              max_length=2000)
+    # The plugin system is so awesome that the inheritor doesn't need to do
+    # anything! :D
     
+    class Meta:
+        verbose_name = _(u'image')
+        verbose_name_plural = _(u'images')
+        app_label = settings.APP_LABEL
     
+    def __unicode__(self):
+        return _(u'Image: %s') % self.current_revision.get_filename()
+
+class ImageRevision(RevisionPluginRevision):
     
+    image = models.ImageField(upload_to=settings.IMAGE_PATH,
+                              max_length=2000)
+
     def get_filename(self):
         if self.image:
             return self.image.path.split('/')[-1]
     
     class Meta:
-        verbose_name = _(u'image')
-        verbose_name_plural = _(u'images')
+        verbose_name = _(u'image revision')
+        verbose_name_plural = _(u'image revisions')
         app_label = settings.APP_LABEL
-    
-    def __unicode__(self):
-        return _(u'Image: %s') % self.get_filename()
-    
\ No newline at end of file

wiki/plugins/images/templatetags/wiki_images_tags.py

@@ -6,4 +6,4 @@ register = template.Library()
 
 @register.filter
 def images_for_article(article):
-    return models.Image.objects.filter(revision__article=article).order_by('-created')
+    return models.Image.objects.filter(article=article).order_by('-created')

wiki/plugins/notifications/models.py

@@ -6,12 +6,10 @@ from django.db.models import signals
 from django_notify import notify
 from django_notify.models import Subscription
 
-from wiki.plugins.notifications import ARTICLE_EDIT
-
 from wiki import models as wiki_models
 from wiki.core import plugins_registry
-
-from . import settings
+from wiki.plugins.notifications import ARTICLE_EDIT #TODO: Is this bad practice?
+from wiki.plugins.notifications import settings
 
 class ArticleSubscription(wiki_models.pluginbase.ArticlePlugin, Subscription):