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

@@ -20,6 +20,7 @@ class IpboardService(ServicesHook):
         self.name = 'ipboard'
         self.service_url = settings.IPBOARD_ENDPOINT
         self.urlpatterns = urlpatterns
+        self.access_perm = 'ipboard.access_ipboard'
 
     @property
     def title(self):
@@ -43,11 +44,8 @@ class IpboardService(ServicesHook):
         logger.debug('Update all %s groups called' % self.name)
         IpboardTasks.update_all_groups.delay()
 
-    def service_enabled_members(self):
-        return settings.ENABLE_AUTH_IPBOARD or False
-
-    def service_enabled_blues(self):
-        return settings.ENABLE_BLUE_IPBOARD or False
+    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/ipboard/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")
+    IpboardUser = apps.get_model("ipboard", "IpboardUser")
+
+    perm = Permission.objects.get(codename='access_ipboard')
+
+    member_group_name = getattr(settings, str('DEFAULT_AUTH_GROUP'), 'Member')
+    blue_group_name = getattr(settings, str('DEFAULT_BLUE_GROUP'), 'Blue')
+
+    # Migrate members
+    if IpboardUser.objects.filter(user__groups__name=member_group_name).exists() or \
+            getattr(settings, str('ENABLE_AUTH_IPBOARD'), False):
+        try:
+            group = Group.objects.get(name=member_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_AUTH_IPBOARD setting')
+
+    # Migrate blues
+    if IpboardUser.objects.filter(user__groups__name=blue_group_name).exists() or \
+            getattr(settings, str('ENABLE_BLUE_IPBOARD'), False):
+        try:
+            group = Group.objects.get(name=blue_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_BLUE_IPBOARD setting')
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('ipboard', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='ipboarduser',
+            options={'permissions': (('access_ipboard', 'Can access the IPBoard service'),)},
+        ),
+        migrations.RunPython(migrate_service_enabled),
+    ]

services/modules/ipboard/models.py

@@ -14,3 +14,8 @@ class IpboardUser(models.Model):
 
     def __str__(self):
         return self.username
+
+    class Meta:
+        permissions = (
+            ("access_ipboard", u"Can access the IPBoard service"),
+        )

services/modules/ipboard/tasks.py

@@ -62,11 +62,5 @@ class IpboardTasks:
 
     @staticmethod
     def disable():
-        if settings.ENABLE_AUTH_IPBOARD:
-            logger.warn(
-                "ENABLE_AUTH_IPBOARD still True, after disabling users will still be able to create IPBoard accounts")
-        if settings.ENABLE_BLUE_IPBOARD:
-            logger.warn(
-                "ENABLE_BLUE_IPBOARD still True, after disabling blues will still be able to create IPBoard accounts")
         logger.debug("Deleting all Ipboard Users")
         IpboardUser.objects.all().delete()

services/modules/ipboard/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 import urls
 from django.core.exceptions import ObjectDoesNotExist
 
@@ -23,6 +23,13 @@ from .manager import IPBoardManager
 MODULE_PATH = 'services.modules.ipboard'
 
 
+def add_permissions():
+    permission = Permission.objects.get(codename='access_ipboard')
+    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 IpboardHooksTestCase(TestCase):
     def setUp(self):
         self.member = 'member_user'
@@ -34,6 +41,7 @@ class IpboardHooksTestCase(TestCase):
         self.none_user = 'none_user'
         none_user = AuthUtils.create_user(self.none_user)
         self.service = IpboardService
+        add_permissions()
 
     def test_has_account(self):
         member = User.objects.get(username=self.member)
@@ -48,11 +56,9 @@ class IpboardHooksTestCase(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_IPBOARD)
-        self.assertEqual(service.service_active_for_user(blue), settings.ENABLE_BLUE_IPBOARD)
+        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.IPBoardManager')
@@ -133,6 +139,7 @@ class IpboardViewsTestCase(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/ipboard/views.py

@@ -1,10 +1,9 @@
 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
 from services.forms import ServicePasswordForm
 from eveonline.managers import EveManager
 
@@ -16,9 +15,11 @@ import logging
 
 logger = logging.getLogger(__name__)
 
+ACCESS_PERM = 'ipboard.access_ipboard'
+
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def activate_ipboard_forum(request):
     logger.debug("activate_ipboard_forum called by user %s" % request.user)
     character = EveManager.get_main_character(request.user)
@@ -46,7 +47,7 @@ def activate_ipboard_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def deactivate_ipboard_forum(request):
     logger.debug("deactivate_ipboard_forum called by user %s" % request.user)
     # false we failed
@@ -60,7 +61,7 @@ def deactivate_ipboard_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def set_ipboard_password(request):
     logger.debug("set_ipboard_password called by user %s" % request.user)
     error = None
@@ -90,7 +91,7 @@ def set_ipboard_password(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def reset_ipboard_password(request):
     logger.debug("reset_ipboard_password called by user %s" % request.user)
     if IpboardTasks.has_account(request.user):