Merge pull request #6 from virogenesis/master

Signal for state switch

Author: krischer

djangoplugins/models.py

@@ -1,9 +1,10 @@
 from __future__ import absolute_import
 
+from dirtyfields import DirtyFieldsMixin
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 from django.utils.encoding import python_2_unicode_compatible
-
+from djangoplugins.signals import django_plugin_enabled, django_plugin_disabled
 from .utils import get_plugin_name, get_plugin_from_string
 
 ENABLED = 0
@@ -16,6 +17,9 @@
     (REMOVED,  _('Removed')),
 )
 
+STATUS_CHOICES_ENABLED = (ENABLED,)
+STATUS_CHOICES_DISABLED = (DISABLED, REMOVED,)
+
 
 class PluginPointManager(models.Manager):
     def get_point(self, point):
@@ -47,7 +51,7 @@ def get_by_natural_key(self, name):
 
 
 @python_2_unicode_compatible
-class Plugin(models.Model):
+class Plugin(DirtyFieldsMixin, models.Model):
     """
     Database representation of a plugin.
 
@@ -101,3 +105,14 @@ def is_active(self):
     def get_plugin(self):
         plugin_class = get_plugin_from_string(self.pythonpath)
         return plugin_class()
+
+    def save(self, *args, **kwargs):
+        if "status" in self.get_dirty_fields().keys() and self.pk:
+            if self.status in STATUS_CHOICES_ENABLED:
+                django_plugin_enabled.send(sender=self.__class__,
+                                           plugin=self.get_plugin())
+            else:
+                django_plugin_disabled.send(sender=self.__class__,
+                                            plugin=self.get_plugin())
+
+        return super(Plugin, self).save(*args, **kwargs)

djangoplugins/signals.py

@@ -0,0 +1,4 @@
+from django.dispatch import Signal
+
+django_plugin_disabled = Signal(providing_args=["plugin"])
+django_plugin_enabled = Signal(providing_args=["plugin"])

docs/index.rst

@@ -221,6 +221,30 @@ ORM::
             'plugins': MyPluginPoint.get_plugins_qs().order_by('name')
         }
 
+
+
+Signals
+-------
+
+There are two registered signals with Django that you might use for hooking
+event handlers in case a Django plugin gets disabled or enabled at a certain
+point. See the following code snippet for an example usage:
+
+.. code-block:: python
+
+    from django.dispatch.dispatcher import receiver
+    from djangoplugins.signals import django_plugin_disabled, django_plugin_enabled
+
+    @receiver(django_plugin_enabled)
+    def _django_plugin_enabled(sender, plugin, **kwargs):
+        enable_plugin(plugin)
+
+        @receiver(django_plugin_disabled)
+        def _django_plugin_disabled(sender, plugin, **kwargs):
+            disable_plugin(plugin)
+
+
+
 Model fields
 ------------
 

setup.py

@@ -30,6 +30,7 @@ def read_docs(filename):
       packages=find_packages(exclude=['sample-project']),
       install_requires=[
           'django>=1.6',
+          'django-dirtyfields',
       ],
       url='https://github.com/krischer/django-plugins',
       download_url='http://pypi.python.org/pypi/django-plugins',