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

@@ -19,6 +19,7 @@ class XenforoService(ServicesHook):
         ServicesHook.__init__(self)
         self.name = 'xenforo'
         self.urlpatterns = urlpatterns
+        self.access_perm = 'xenforo.access_xenforo'
 
     @property
     def title(self):
@@ -33,11 +34,8 @@ class XenforoService(ServicesHook):
         if XenforoTasks.has_account(user) and not self.service_active_for_user(user):
             self.delete_user(user, notify_user=True)
 
-    def service_enabled_members(self):
-        return settings.ENABLE_AUTH_XENFORO or False
-
-    def service_enabled_blues(self):
-        return settings.ENABLE_BLUE_XENFORO 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/xenforo/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")
+    XenforoUser = apps.get_model("xenforo", "XenforoUser")
+
+    perm = Permission.objects.get(codename='access_xenforo')
+
+    member_group_name = getattr(settings, str('DEFAULT_AUTH_GROUP'), 'Member')
+    blue_group_name = getattr(settings, str('DEFAULT_BLUE_GROUP'), 'Blue')
+
+    # Migrate members
+    if XenforoUser.objects.filter(user__groups__name=member_group_name).exists() or \
+            getattr(settings, str('ENABLE_AUTH_XENFORO'), False):
+        try:
+            group = Group.objects.get(name=member_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_AUTH_XENFORO setting')
+
+    # Migrate blues
+    if XenforoUser.objects.filter(user__groups__name=blue_group_name).exists() or \
+            getattr(settings, str('ENABLE_BLUE_XENFORO'), False):
+        try:
+            group = Group.objects.get(name=blue_group_name)
+            group.permissions.add(perm)
+        except ObjectDoesNotExist:
+            logger.warning('Failed to migrate ENABLE_BLUE_XENFORO setting')
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('xenforo', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='xenforouser',
+            options={'permissions': (('access_xenforo', 'Can access the XenForo service'),)},
+        ),
+        migrations.RunPython(migrate_service_enabled),
+    ]

services/modules/xenforo/models.py

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

services/modules/xenforo/tasks.py

@@ -36,11 +36,5 @@ class XenforoTasks:
 
     @classmethod
     def disable(cls):
-        if settings.ENABLE_AUTH_XENFORO:
-            logger.warn(
-                "ENABLE_AUTH_XENFORO still True, after disabling users will still be able to link XenForo accounts")
-        if settings.ENABLE_BLUE_XENFORO:
-            logger.warn(
-                "ENABLE_BLUE_XENFORO still True, after disabling blues will still be able to link XenForo accounts")
         logger.debug("Deleting ALL XenForo users")
         XenforoUser.objects.all().delete()

services/modules/xenforo/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 XenforoTasks
 MODULE_PATH = 'services.modules.xenforo'
 
 
+def add_permissions():
+    permission = Permission.objects.get(codename='access_xenforo')
+    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 XenforoHooksTestCase(TestCase):
     def setUp(self):
         self.member = 'member_user'
@@ -33,6 +40,7 @@ class XenforoHooksTestCase(TestCase):
         self.none_user = 'none_user'
         none_user = AuthUtils.create_user(self.none_user)
         self.service = XenforoService
+        add_permissions()
 
     def test_has_account(self):
         member = User.objects.get(username=self.member)
@@ -47,11 +55,9 @@ class XenforoHooksTestCase(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_XENFORO)
-        self.assertEqual(service.service_active_for_user(blue), settings.ENABLE_BLUE_XENFORO)
+        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.XenForoManager')
@@ -112,6 +118,7 @@ class XenforoViewsTestCase(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/xenforo/views.py

@@ -3,10 +3,9 @@ from __future__ import unicode_literals
 import logging
 
 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 eveonline.managers import EveManager
 from services.forms import ServicePasswordForm
 from .manager import XenForoManager
@@ -15,8 +14,11 @@ from .tasks import XenforoTasks
 
 logger = logging.getLogger(__name__)
 
+ACCESS_PERM = 'xenforo.access_xenforo'
+
+
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def activate_xenforo_forum(request):
     logger.debug("activate_xenforo_forum called by user %s" % request.user)
     character = EveManager.get_main_character(request.user)
@@ -41,7 +43,7 @@ def activate_xenforo_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def deactivate_xenforo_forum(request):
     logger.debug("deactivate_xenforo_forum called by user %s" % request.user)
     if XenforoTasks.delete_user(request.user):
@@ -53,7 +55,7 @@ def deactivate_xenforo_forum(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def reset_xenforo_password(request):
     logger.debug("reset_xenforo_password called by user %s" % request.user)
     if XenforoTasks.has_account(request.user):
@@ -74,7 +76,7 @@ def reset_xenforo_password(request):
 
 
 @login_required
-@members_and_blues()
+@permission_required(ACCESS_PERM)
 def set_xenforo_password(request):
     logger.debug("set_xenforo_password called by user %s" % request.user)
     if request.method == 'POST':