Grant service access by permissions (#692)

* Add service access permissions and migration

`ENABLE_AUTH_<servicename> = True` will have the new permission applied
to the settings configured `DEFAULT_AUTH_GROUP` group or `Member` if
none is configured.

`ENABLE_BLUE_<servicename> = True` will have the new permission applied
to the settings configured `DEFAULT_BLUE_GROUP` group or `Blue` if none
is configured.

* Move views and hooks to permissions based access

* Remove access restriction to services view

Hypothetically non-member/blues could be granted permission to access
services manually as desired now. A user that has no permissions to
access any services will see a blank services list.

* Remove obsolete service settings

* Remove references to obsolete settings

* Adjusted tests to support permissions based access

* Fix incorrectly named permissions

* Add simple get_services generator function

* Added signals for user and groups perm changes

* Update validate_services to support permissions

deactivate_services removed as its surplus to requirements.

* Removed state parameter from validate_services calls

* Update tests to support signals changes

* Fix incorrect call to validate_services task

* Fix validate_services and test

* Add validate_user to changed user groups signal

* Added tests for new signals

* Remove unnecessary post_add signals

* Added documentation for service permissions

* Added detection for members with service active

If there are any service users in the Member or Blue groups active, then
the permission will be added to the respective Member or Blue group.
This means its no longer necessary to maintain the service enablesettings to migrate to permissions based service.

Remove obsolete state based status checking

services/modules/discord/auth_hooks.py

@@ -19,6 +19,7 @@ class DiscordService(ServicesHook):
         self.urlpatterns = urlpatterns
         self.name = 'discord'
         self.service_ctrl_template = 'registered/discord_service_ctrl.html'
+        self.access_perm = 'discord.access_discord'
 
     def delete_user(self, user, notify_user=False):
         logger.debug('Deleting user %s %s account' % (user, self.name))
@@ -42,11 +43,8 @@ class DiscordService(ServicesHook):
         logger.debug('Update all %s groups called' % self.name)
         DiscordTasks.update_all_groups.delay()
 
-    def service_enabled_members(self):
-        return settings.ENABLE_AUTH_DISCORD or False
-
-    def service_enabled_blues(self):
-        return settings.ENABLE_BLUE_DISCORD or False
+    def service_active_for_user(self, user):
+        return user.has_perm(self.access_perm)
 
     def render_services_ctrl(self, request):
         return render_to_string(self.service_ctrl_template, {

services/modules/discord/migrations/0002_service_permissions.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.5 on 2017-02-02 05:59
+from __future__ import unicode_literals
+
+from django.db import migrations
+from django.conf import settings
+from django.core.exceptions import ObjectDoesNotExist
+from django.contrib.auth.management import create_permissions
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def migrate_service_enabled(apps, schema_editor):
+    for app_config in apps.get_app_configs():
+        app_config.models_module = True
+        create_permissions(app_config, apps=apps, verbosity=0)
+        app_config.models_module = None
+
+    Group = apps.get_model("auth", "Group")
+    Permission = apps.get_model("auth", "Permission")
+    DiscordUser = apps.get_model("discord", "DiscordUser")
+
+    perm = Permission.objects.get(codename='access_discord')
+
+    member_group_name = getattr(settings, str('DEFAULT_AUTH_GROUP'), 'Member')
+    blue_group_name = getattr(settings, str('DEFAULT_BLUE_GROUP'), 'Blue')
+
+    # Migrate members
+    if DiscordUser.objects.filter(user__groups__name=member_group_name).exists() or \
+            getattr(settings, str('ENABLE_AUTH_DISCORD'), False):
+        try:
+            group = Group.objects.get(name=member_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_AUTH_DISCORD setting')
+
+    # Migrate blues
+    if DiscordUser.objects.filter(user__groups__name=blue_group_name).exists() or \
+            getattr(settings, str('ENABLE_BLUE_DISCORD'), False):
+        try:
+            group = Group.objects.get(name=blue_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_BLUE_DISCORD setting')
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('discord', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='discorduser',
+            options={'permissions': (('access_discord', 'Can access the Discord service'),)},
+        ),
+        migrations.RunPython(migrate_service_enabled),
+    ]

services/modules/discord/models.py

@@ -4,6 +4,7 @@ from django.contrib.auth.models import User
 from django.db import models
 
 
+@python_2_unicode_compatible
 class DiscordUser(models.Model):
     user = models.OneToOneField(User,
                                 primary_key=True,
@@ -13,3 +14,8 @@ class DiscordUser(models.Model):
 
     def __str__(self):
         return "{} - {}".format(self.user.username, self.uid)
+
+    class Meta:
+        permissions = (
+            ("access_discord", u"Can access the Discord service"),
+        )

services/modules/discord/tasks.py

@@ -122,10 +122,4 @@ class DiscordTasks:
 
     @classmethod
     def disable(cls):
-        if settings.ENABLE_AUTH_DISCORD:
-            logger.warn(
-                "ENABLE_AUTH_DISCORD still True, after disabling users will still be able to link Discord accounts")
-        if settings.ENABLE_BLUE_DISCORD:
-            logger.warn(
-                "ENABLE_BLUE_DISCORD still True, after disabling blues will still be able to link Discord accounts")
         DiscordUser.objects.all().delete()

services/modules/discord/tests.py

@@ -9,7 +9,7 @@ except ImportError:
 
 from django.test import TestCase, RequestFactory
 from django.conf import settings
-from django.contrib.auth.models import User
+from django.contrib.auth.models import User, Group, Permission
 from django.core.exceptions import ObjectDoesNotExist
 
 from alliance_auth.tests.auth_utils import AuthUtils
@@ -21,6 +21,13 @@ from .tasks import DiscordTasks
 MODULE_PATH = 'services.modules.discord'
 
 
+def add_permissions():
+    permission = Permission.objects.get(codename='access_discord')
+    members = Group.objects.get(name=settings.DEFAULT_AUTH_GROUP)
+    blues = Group.objects.get(name=settings.DEFAULT_BLUE_GROUP)
+    AuthUtils.add_permissions_to_groups([permission], [members, blues])
+
+
 class DiscordHooksTestCase(TestCase):
     def setUp(self):
         self.member = 'member_user'
@@ -32,6 +39,7 @@ class DiscordHooksTestCase(TestCase):
         self.none_user = 'none_user'
         none_user = AuthUtils.create_user(self.none_user)
         self.service = DiscordService
+        add_permissions()
 
     def test_has_account(self):
         member = User.objects.get(username=self.member)
@@ -46,8 +54,6 @@ class DiscordHooksTestCase(TestCase):
         member = User.objects.get(username=self.member)
         blue = User.objects.get(username=self.blue)
         none_user = User.objects.get(username=self.none_user)
-        self.assertTrue(service.service_enabled_members())
-        self.assertTrue(service.service_enabled_blues())
 
         self.assertTrue(service.service_active_for_user(member))
         self.assertTrue(service.service_active_for_user(blue))
@@ -147,6 +153,7 @@ class DiscordViewsTestCase(TestCase):
         self.member = AuthUtils.create_member('auth_member')
         self.member.set_password('password')
         self.member.save()
+        add_permissions()
 
     def login(self):
         self.client.login(username=self.member.username, password='password')

services/modules/discord/views.py

@@ -5,9 +5,9 @@ import logging
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.contrib.auth.decorators import user_passes_test
+from django.contrib.auth.decorators import permission_required
 from django.shortcuts import redirect
 
-from authentication.decorators import members_and_blues
 from .manager import DiscordOAuthManager
 from .tasks import DiscordTasks
 from services.views import superuser_test
@@ -15,9 +15,11 @@ from services.views import superuser_test
 
 logger = logging.getLogger(__name__)
 
+ACCESS_PERM = 'discord.access_discord'
+
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def deactivate_discord(request):
     logger.debug("deactivate_discord called by user %s" % request.user)
     if DiscordTasks.delete_user(request.user):
@@ -30,7 +32,7 @@ def deactivate_discord(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def reset_discord(request):
     logger.debug("reset_discord called by user %s" % request.user)
     if DiscordTasks.delete_user(request.user):
@@ -42,14 +44,14 @@ def reset_discord(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def activate_discord(request):
     logger.debug("activate_discord called by user %s" % request.user)
     return redirect(DiscordOAuthManager.generate_oauth_redirect_url())
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def discord_callback(request):
     logger.debug("Received Discord callback for activation of user %s" % request.user)
     code = request.GET.get('code', None)