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/phpbb3/auth_hooks.py

@@ -20,6 +20,7 @@ class Phpbb3Service(ServicesHook):
         self.name = 'phpbb3'
         self.urlpatterns = urlpatterns
         self.service_url = settings.FORUM_URL  # TODO: This needs to be renamed at some point...
+        self.access_perm = 'phpbb3.access_phpbb3'
 
     @property
     def title(self):
@@ -43,11 +44,8 @@ class Phpbb3Service(ServicesHook):
         logger.debug('Update all %s groups called' % self.name)
         Phpbb3Tasks.update_all_groups.delay()
 
-    def service_enabled_members(self):
-        return settings.ENABLE_AUTH_FORUM or False  # TODO: Rename this setting
-
-    def service_enabled_blues(self):
-        return settings.ENABLE_BLUE_FORUM or False  # TODO: Rename this setting
+    def service_active_for_user(self, user):
+        return user.has_perm(self.access_perm)
 
     def render_services_ctrl(self, request):
         urls = self.Urls()

services/modules/phpbb3/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")
+    Phpbb3User = apps.get_model("phpbb3", "Phpbb3User")
+
+    perm = Permission.objects.get(codename='access_phpbb3')
+
+    member_group_name = getattr(settings, str('DEFAULT_AUTH_GROUP'), 'Member')
+    blue_group_name = getattr(settings, str('DEFAULT_BLUE_GROUP'), 'Blue')
+
+    # Migrate members
+    if Phpbb3User.objects.filter(user__groups__name=member_group_name).exists() or \
+            getattr(settings, str('ENABLE_AUTH_FORUM'), False):
+        try:
+            group = Group.objects.get(name=member_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_AUTH_FORUM setting')
+
+    # Migrate blues
+    if Phpbb3User.objects.filter(user__groups__name=blue_group_name).exists() or \
+            getattr(settings, str('ENABLE_BLUE_FORUM'), False):
+        try:
+            group = Group.objects.get(name=blue_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_BLUE_FORUM setting')
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('phpbb3', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='phpbb3user',
+            options={'permissions': (('access_phpbb3', 'Can access the phpBB3 service'),)},
+        ),
+        migrations.RunPython(migrate_service_enabled),
+    ]

services/modules/phpbb3/models.py

@@ -13,3 +13,8 @@ class Phpbb3User(models.Model):
 
     def __str__(self):
         return self.username
+
+    class Meta:
+        permissions = (
+            ("access_phpbb3", u"Can access the phpBB3 service"),
+        )

services/modules/phpbb3/tasks.py

@@ -66,8 +66,4 @@ class Phpbb3Tasks:
 
     @staticmethod
     def disable():
-        if settings.ENABLE_AUTH_FORUM:
-            logger.warn("ENABLE_AUTH_FORUM still True, after disabling users will still be able to create forum accounts")
-        if settings.ENABLE_BLUE_FORUM:
-            logger.warn("ENABLE_BLUE_FORUM still True, after disabling blues will still be able to create forum accounts")
         Phpbb3User.objects.all().delete()

services/modules/phpbb3/tests.py

@@ -10,7 +10,7 @@ except ImportError:
 from django.test import TestCase, RequestFactory
 from django.conf import settings
 from django import urls
-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
@@ -22,6 +22,13 @@ from .tasks import Phpbb3Tasks
 MODULE_PATH = 'services.modules.phpbb3'
 
 
+def add_permissions():
+    permission = Permission.objects.get(codename='access_phpbb3')
+    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 Phpbb3HooksTestCase(TestCase):
     def setUp(self):
         self.member = 'member_user'
@@ -33,6 +40,7 @@ class Phpbb3HooksTestCase(TestCase):
         self.none_user = 'none_user'
         none_user = AuthUtils.create_user(self.none_user)
         self.service = Phpbb3Service
+        add_permissions()
 
     def test_has_account(self):
         member = User.objects.get(username=self.member)
@@ -47,11 +55,9 @@ class Phpbb3HooksTestCase(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.assertEqual(service.service_active_for_user(member), settings.ENABLE_AUTH_FORUM)
-        self.assertEqual(service.service_active_for_user(blue), settings.ENABLE_BLUE_FORUM)
+        self.assertTrue(service.service_active_for_user(member))
+        self.assertTrue(service.service_active_for_user(blue))
         self.assertFalse(service.service_active_for_user(none_user))
 
     @mock.patch(MODULE_PATH + '.tasks.Phpbb3Manager')
@@ -136,6 +142,7 @@ class Phpbb3ViewsTestCase(TestCase):
         self.member.email = 'auth_member@example.com'
         self.member.save()
         AuthUtils.add_main_character(self.member, 'auth_member', '12345', corp_id='111', corp_name='Test Corporation')
+        add_permissions()
 
     def login(self):
         self.client.login(username=self.member.username, password='password')

services/modules/phpbb3/views.py

@@ -1,7 +1,7 @@
 from __future__ import unicode_literals
 
 from django.contrib import messages
-from django.contrib.auth.decorators import login_required
+from django.contrib.auth.decorators import login_required, permission_required
 from django.shortcuts import render, redirect
 
 from authentication.decorators import members_and_blues
@@ -16,9 +16,11 @@ import logging
 
 logger = logging.getLogger(__name__)
 
+ACCESS_PERM = 'phpbb3.access_phpbb3'
+
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def activate_forum(request):
     logger.debug("activate_forum called by user %s" % request.user)
     # Valid now we get the main characters
@@ -46,7 +48,7 @@ def activate_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def deactivate_forum(request):
     logger.debug("deactivate_forum called by user %s" % request.user)
     # false we failed
@@ -60,7 +62,7 @@ def deactivate_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def reset_forum_password(request):
     logger.debug("reset_forum_password called by user %s" % request.user)
     if Phpbb3Tasks.has_account(request.user):
@@ -83,7 +85,7 @@ def reset_forum_password(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def set_forum_password(request):
     logger.debug("set_forum_password called by user %s" % request.user)
     if request.method == 'POST':