0.2.1: December 7, 2011

Kevin Renskers · Kevin Renskers · commit 7ee1e5aacccc · 2011-12-07T10:30:00.000+01:00
- New model DisabledNotificationsTypeBackend: instead of saving what backend a user wants to use, we save what he does not want to use instead
diff --git a/CHANGELOG b/CHANGELOG
@@ -23,3 +23,6 @@
 - Define __getattr__ for easy access to kwargs
 - Start of new settings app, where users can select which types they're interested in
 - Users can also select backends per type
+
+0.2.1: December 7, 2011
+- New model DisabledNotificationsTypeBackend: instead of saving what backend a user wants to use, we save what he does not want to use instead
diff --git a/notifications/__init__.py b/notifications/__init__.py
@@ -1 +1 @@
-__version__ = '0.2'
+__version__ = '0.2.1'
diff --git a/notifications/backend/__init__.py b/notifications/backend/__init__.py
@@ -1,3 +1,5 @@
+from notifications.engine import NotificationEngine
+
 class BackendConfigError(Exception):
     pass
 
@@ -18,6 +20,9 @@ def __init__(self, user=None, subject=None, text=None):
         self.subject = subject
         self.text = text
 
+    def is_registered(self):
+        return self.__class__.__name__ in NotificationEngine._backends
+
     def _queue(self):
         """
         This will add the notification to the database queue. A cron job will then get the notification,
diff --git a/notifications/migrations/0002_auto__del_selectednotificationstype__del_unique_selectednotificationst.py b/notifications/migrations/0002_auto__del_selectednotificationstype__del_unique_selectednotificationst.py
@@ -0,0 +1,113 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Removing unique constraint on 'SelectedNotificationsType', fields ['user', 'notification_type']
+        db.delete_unique('notifications_selectednotificationstype', ['user_id', 'notification_type'])
+
+        # Deleting model 'SelectedNotificationsType'
+        db.delete_table('notifications_selectednotificationstype')
+
+        # Adding model 'DisabledNotificationsTypeBackend'
+        db.create_table('notifications_disablednotificationstypebackend', (
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['auth.User'])),
+            ('notification_type', self.gf('django.db.models.fields.CharField')(max_length=255)),
+            ('notification_backends', self.gf('django.db.models.fields.TextField')()),
+        ))
+        db.send_create_signal('notifications', ['DisabledNotificationsTypeBackend'])
+
+        # Adding unique constraint on 'DisabledNotificationsTypeBackend', fields ['user', 'notification_type']
+        db.create_unique('notifications_disablednotificationstypebackend', ['user_id', 'notification_type'])
+
+
+    def backwards(self, orm):
+        
+        # Removing unique constraint on 'DisabledNotificationsTypeBackend', fields ['user', 'notification_type']
+        db.delete_unique('notifications_disablednotificationstypebackend', ['user_id', 'notification_type'])
+
+        # Adding model 'SelectedNotificationsType'
+        db.create_table('notifications_selectednotificationstype', (
+            ('notification_type', self.gf('django.db.models.fields.CharField')(max_length=255)),
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('notification_backends', self.gf('django.db.models.fields.TextField')()),
+            ('user', self.gf('django.db.models.fields.related.ForeignKey')(to=orm['auth.User'])),
+        ))
+        db.send_create_signal('notifications', ['SelectedNotificationsType'])
+
+        # Adding unique constraint on 'SelectedNotificationsType', fields ['user', 'notification_type']
+        db.create_unique('notifications_selectednotificationstype', ['user_id', 'notification_type'])
+
+        # Deleting model 'DisabledNotificationsTypeBackend'
+        db.delete_table('notifications_disablednotificationstypebackend')
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'unique': 'True', 'null': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'notifications.disablednotificationstypebackend': {
+            'Meta': {'unique_together': "(['user', 'notification_type'],)", 'object_name': 'DisabledNotificationsTypeBackend'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'notification_backends': ('django.db.models.fields.TextField', [], {}),
+            'notification_type': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"})
+        },
+        'notifications.notificationbackendsettings': {
+            'Meta': {'unique_together': "(['user', 'notification_backend'],)", 'object_name': 'NotificationBackendSettings'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'notification_backend': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'settings': ('django.db.models.fields.TextField', [], {'default': "'{}'"}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"})
+        },
+        'notifications.notificationqueue': {
+            'Meta': {'object_name': 'NotificationQueue'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'notification_backend': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'subject': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'text': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'tries': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'notifications'", 'to': "orm['auth.User']"})
+        }
+    }
+
+    complete_apps = ['notifications']
diff --git a/notifications/models.py b/notifications/models.py
@@ -25,10 +25,10 @@ def __unicode__(self):
         return self.text
 
 
-class SelectedNotificationsType(models.Model):
+class DisabledNotificationsTypeBackend(models.Model):
     """
-    A model for saving which types of notification a user is interested in,
-    and which backends are selected for each of them
+    In this model we save which backends a user does NOT want to use for a notification type.
+    By saving what he does NOT want, new users and new types/backends default to everything.
     """
     user = models.ForeignKey(User)
     notification_type = models.CharField(max_length=255)
diff --git a/notifications/templates/notifications/index.html b/notifications/templates/notifications/index.html
@@ -25,7 +25,7 @@
                         {% for backend_class_name, backend_class in notification_backends.items %}
                             <td>
                                 {% if backend_class_name in type_dict.type_class.allowed_backends %}
-                                    <input type="checkbox" name="{{ type_class_name }}" value="{{ backend_class_name }}"{% if backend_class_name in type_dict.selected_backends %} checked="checked"{% endif %} />
+                                    <input type="checkbox" name="{{ type_class_name }}" value="{{ backend_class_name }}"{% if backend_class_name not in type_dict.disabled_backends %} checked="checked"{% endif %} />
                                 {% endif %}
                             </td>
                         {% endfor %}
diff --git a/notifications/type/__init__.py b/notifications/type/__init__.py
@@ -87,22 +87,22 @@ def _get_backends(self, user):
         Only backends that validate (all required settings are available) apply.
         """
 
-        from notifications.models import SelectedNotificationsType
+        from notifications.models import DisabledNotificationsTypeBackend
 
-        user_selected_backends = []
+        disabled_backends = []
 
         try:
-            user_selected_backends = SelectedNotificationsType.objects.get(user=user, notification_type=self.__class__.__name__).get_backends()
-        except SelectedNotificationsType.DoesNotExist:
+            disabled_backends = DisabledNotificationsTypeBackend.objects.get(user=user, notification_type=self.__class__.__name__).get_backends()
+        except DisabledNotificationsTypeBackend.DoesNotExist:
             pass
 
         backends = {}
         for backend_name in self.allowed_backends:
-            if backend_name in user_selected_backends:
+            if backend_name not in disabled_backends:
                 subject = self.get_subject(backend_name, user)
                 text = self.get_text(backend_name, user)
                 backend = self._all_backends[backend_name](user=user, subject=subject, text=text)
-                if backend.validate():
+                if backend.is_registered() and backend.validate():
                     backends[backend_name] = backend
 
         if not backends and not notification_settings.FAIL_SILENT:
diff --git a/notifications/views.py b/notifications/views.py
@@ -3,23 +3,23 @@
 from django.http import HttpResponseRedirect
 from django.views.generic.base import TemplateView
 from notifications.engine import NotificationEngine
-from notifications.models import SelectedNotificationsType
+from notifications.models import DisabledNotificationsTypeBackend
 
 
 class IndexView(TemplateView):
     template_name = 'notifications/index.html'
 
     def get_context_data(self, **kwargs):
-        selected_backends = {}
+        disabled_backends = {}
 
-        for obj in SelectedNotificationsType.objects.filter(user=self.request.user):
-            selected_backends[obj.notification_type] = obj.get_backends()
+        for obj in DisabledNotificationsTypeBackend.objects.filter(user=self.request.user):
+            disabled_backends[obj.notification_type] = obj.get_backends()
 
         notification_types = {}
         for class_name, type_class in NotificationEngine._types.items():
             notification_types[class_name] = {
                 'type_class': type_class,
-                'selected_backends': selected_backends.get(class_name, [])
+                'disabled_backends': disabled_backends.get(class_name, [])
             }
 
         context = super(IndexView, self).get_context_data(**kwargs)
@@ -28,16 +28,21 @@ def get_context_data(self, **kwargs):
         return context
 
     def post(self, request, **kwargs):
-        SelectedNotificationsType.objects.filter(user=request.user).delete()
+        DisabledNotificationsTypeBackend.objects.filter(user=request.user).delete()
 
-        for type_name in NotificationEngine._types.keys():
-            backends = request.POST.getlist(type_name)
+        for type_name, type_class in NotificationEngine._types.items():
+            allowed_backends = type_class().allowed_backends
+            enabled_backends = request.POST.getlist(type_name)
 
-            if backends:
-                SelectedNotificationsType.objects.create(
+            # Subtract the enabled backends from allowed_backends, the difference is disabled_backends
+            disabled_backends = list(allowed_backends)
+            [disabled_backends.remove(x) for x in enabled_backends]
+
+            if disabled_backends:
+                DisabledNotificationsTypeBackend.objects.create(
                     user = request.user,
                     notification_type = type_name,
-                    notification_backends = ','.join(backends)
+                    notification_backends = ','.join(disabled_backends)
                 )
 
         messages.success(request, 'Your notification settings have been saved')

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.2'`
	`1`	`+__version__ = '0.2.1'`