The Great Services Refactor (#594)

* Hooks registration, discovery and retrieval module

Will discover @hooks.register decorated functions inside
the auth_hooks module in any installed django app.

* Class to register modular service apps

* Register service modules URLs

* Example service module

* Refactor services into modules

Each service type has been split out into its own django app/module. A
hook mechanism is provided to register a subclass of the ServiceHook
class. The modules then overload functions defined in ServiceHook as
required to provide interoperability with alliance auth. Service modules
provide their own urls and views for user registration and account
management and a partial template to display on the services page. Where
possible, new modules should provide their own models for local data
storage.

* Added menu items hooks and template tags

* Added menu item hook for broadcasts

* Added str method to ServicesHook

* Added exception handling to hook iterators

* Refactor mumble migration and table name

Upgrading will require `migrate mumble --fake-initial` to be run first
and then `migrate mumble` to rename the table.

* Refactor teamspeak3 migration and rename table

Upgrading will require `migrate teamspeak3 --fake-initial`

* Added module models and migrations for refactoring AuthServicesInfo

* Migrate AuthServiceInfo fields to service modules models

* Added helper for getting a users main character

* Added new style celery instance

* Changed Discord from AuthServicesInfo to DiscordUser model

* Switch celery tasks to staticmethods

* Changed Discourse from AuthServicesInfo to DiscourseUser model

* Changed IPBoard from AuthServicesInfo to IpboardUser model

* Changed Ips4 from AuthServicesInfo to Ips4User model

Also added disable service task.

This service still needs some love though. Was always missing a
deactivate services hook (before refactoring) for reasons I'm unsure of
so I'm reluctant to add it without knowing why.

* Changed Market from AuthServicesInfo to MarketUser model

* Changed Mumble from AuthServicesInfo to MumbleUser model

Switched user foreign key to one to one relationship.
Removed implicit password change on user exists.
Combined regular and blue user creation.

* Changed Openfire from AuthServicesInfo to OpenfireUser model

* Changed SMF from AuthServicesInfo to SmfUser model

Added disable task

* Changed Phpbb3 from AuthServicesInfo to Phpbb3User model

* Changed XenForo from AuthServicesInfo to XenforoUser model

* Changed Teamspeak3 from AuthServicesInfo to Teamspeak3User model

* Remove obsolete manager functions

* Standardise URL format

This will break some callback URLs
Discord changes from /discord_callback/ to /discord/callback/

* Removed unnecessary imports

* Mirror upstream decorator change

* Setup for unit testing

* Unit tests for discord service

* Added add main character helper

* Added Discourse unit tests

* Added Ipboard unit tests

* Added Ips4 unit tests

* Fix naming of market manager, switch to use class methods

* Remove unused hook functions

* Added market service unit tests

* Added corp ticker to add main character helper

* Added mumble unit tests

* Fix url name and remove namespace

* Fix missing return and add missing URL

* Added openfire unit tests

* Added missing return

* Added phpbb3 unit tests

* Fix SmfManager naming inconsistency and switch to classmethods

* Added smf unit tests

* Remove unused functions, Added missing return

* Added xenforo unit tests

* Added missing return

* Fixed reference to old model

* Fixed error preventing groups from syncing on reset request

* Added teamspeak3 unit tests

* Added nose as test runner and some test settings

* Added package requirements for running tests

* Added unit tests for services signals and tasks

* Remove unused tests file

* Fix teamspeak3 service signals

* Added unit tests for teamspeak3 signals

Changed other unit tests setUp to inert signals

* Fix password gen and hashing python3 compatibility

Fixes #630

Adds unit tests to check the password functions run on both platforms.

* Fix unit test to not rely on checking url params

* Add Travis CI settings file

* Remove default blank values from services models

* Added dynamic user model admin actions for syncing service groups

* Remove unused search fields

* Add hook function for syncing nicknames

* Added discord hook for sync nickname

* Added user admin model menu actions for sync nickname hook

* Remove obsolete code

* Rename celery config app to avoid package name clash

* Added new style celerybeat schedule configuration

periodic_task decorator is depreciated

* Added string representations

* Added admin pages for services user models

* Removed legacy code

* Move link discord button to correct template

* Remove blank default fields from example model

* Disallow empty django setting

* Fix typos

* Added coverage configuration file

* Add coverage and coveralls to travis config

Should probably use nose's built in coverage, but this works for now.

* Replace AuthServicesInfo get_or_create instances with get

Reflects upstream changes to AuthServicesInfo behaviour.

* Update mumble user table name

* Split out mumble authenticator requirements

zeroc-ice seems to cause long build times on travis-ci and isn't
required for the core projects functionality or testing.

services/modules/mumble/admin.py

@@ -0,0 +1,11 @@
+from __future__ import unicode_literals
+from django.contrib import admin
+from .models import MumbleUser
+
+
+class MumbleUserAdmin(admin.ModelAdmin):
+        fields = ('user', 'username', 'groups')  # pwhash is hidden from admin panel
+        list_display = ('user', 'username', 'groups')
+        search_fields = ('user__username', 'username', 'groups')
+
+admin.site.register(MumbleUser, MumbleUserAdmin)

services/modules/mumble/apps.py

@@ -0,0 +1,7 @@
+from __future__ import unicode_literals
+
+from django.apps import AppConfig
+
+
+class MumbleServiceConfig(AppConfig):
+    name = 'mumble'

services/modules/mumble/auth_hooks.py

@@ -0,0 +1,68 @@
+from __future__ import unicode_literals
+from django.template.loader import render_to_string
+from django.conf import settings
+from notifications import notify
+
+from alliance_auth import hooks
+from services.hooks import ServicesHook
+from .tasks import MumbleTasks
+from .manager import MumbleManager
+from .urls import urlpatterns
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class MumbleService(ServicesHook):
+    def __init__(self):
+        ServicesHook.__init__(self)
+        self.name = 'mumble'
+        self.urlpatterns = urlpatterns
+        self.service_url = settings.MUMBLE_URL
+
+    def delete_user(self, user, notify_user=False):
+        logging.debug("Deleting user %s %s account" % (user, self.name))
+        if MumbleManager.delete_user(user):
+            if notify_user:
+                notify(user, 'Mumble Account Disabled', level='danger')
+            return True
+        return False
+
+    def update_groups(self, user):
+        logger.debug("Updating %s groups for %s" % (self.name, user))
+        if MumbleTasks.has_account(user):
+            MumbleTasks.update_groups.delay(user.pk)
+
+    def validate_user(self, user):
+        if MumbleTasks.has_account(user) and not self.service_active_for_user(user):
+            self.delete_user(user, notify_user=True)
+
+    def update_all_groups(self):
+        logger.debug("Updating all %s groups" % self.name)
+        MumbleTasks.update_all_groups.delay()
+
+    def service_enabled_members(self):
+        return settings.ENABLE_AUTH_MUMBLE or False
+
+    def service_enabled_blues(self):
+        return settings.ENABLE_BLUE_MUMBLE or False
+
+    def render_services_ctrl(self, request):
+        urls = self.Urls()
+        urls.auth_activate = 'auth_activate_mumble'
+        urls.auth_deactivate = 'auth_deactivate_mumble'
+        urls.auth_reset_password = 'auth_reset_mumble_password'
+        urls.auth_set_password = 'auth_set_mumble_password'
+
+        return render_to_string(self.service_ctrl_template, {
+            'service_name': self.title,
+            'urls': urls,
+            'service_url': self.service_url,
+            'username': request.user.mumble.username if MumbleTasks.has_account(request.user) else '',
+        }, request=request)
+
+
+@hooks.register('services_hook')
+def register_mumble_service():
+    return MumbleService()

services/modules/mumble/manager.py

@@ -0,0 +1,105 @@
+from __future__ import unicode_literals
+import random
+import string
+import hashlib
+
+from django.core.exceptions import ObjectDoesNotExist
+
+from .models import MumbleUser
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class MumbleManager:
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def __santatize_username(username):
+        sanatized = username.replace(" ", "_")
+        return sanatized
+
+    @staticmethod
+    def __generate_random_pass():
+        return ''.join([random.choice(string.ascii_letters + string.digits) for n in range(16)])
+
+    @staticmethod
+    def __generate_username(username, corp_ticker):
+        return "[" + corp_ticker + "]" + username
+
+    @staticmethod
+    def __generate_username_blue(username, corp_ticker):
+        return "[BLUE][" + corp_ticker + "]" + username
+
+    @staticmethod
+    def _gen_pwhash(password):
+        return hashlib.sha1(password.encode('utf-8')).hexdigest()
+
+    @staticmethod
+    def create_user(user, corp_ticker, username, blue=False):
+        logger.debug("Creating%s mumble user with username %s and ticker %s" % (' blue' if blue else '',
+                                                                                username, corp_ticker))
+        username_clean = MumbleManager.__santatize_username(
+            MumbleManager.__generate_username_blue(username, corp_ticker) if blue else
+            MumbleManager.__generate_username(username, corp_ticker))
+        password = MumbleManager.__generate_random_pass()
+        pwhash = MumbleManager._gen_pwhash(password)
+        logger.debug("Proceeding with mumble user creation: clean username %s, pwhash starts with %s" % (
+            username_clean, pwhash[0:5]))
+        if not MumbleUser.objects.filter(username=username_clean).exists():
+            logger.info("Creating mumble user %s" % username_clean)
+            MumbleUser.objects.create(user=user, username=username_clean, pwhash=pwhash)
+            return username_clean, password
+        else:
+            logger.warn("Mumble user %s already exists.")
+            return False
+
+    @staticmethod
+    def delete_user(user):
+        logger.debug("Deleting user %s from mumble." % user)
+        if MumbleUser.objects.filter(user=user).exists():
+            MumbleUser.objects.filter(user=user).delete()
+            logger.info("Deleted user %s from mumble" % user)
+            return True
+        logger.error("Unable to delete user %s from mumble: MumbleUser model not found" % user)
+        return False
+
+    @staticmethod
+    def update_user_password(user, password=None):
+        logger.debug("Updating mumble user %s password." % user)
+        if not password:
+            password = MumbleManager.__generate_random_pass()
+        pwhash = MumbleManager._gen_pwhash(password)
+        logger.debug("Proceeding with mumble user %s password update - pwhash starts with %s" % (user, pwhash[0:5]))
+        try:
+            model = MumbleUser.objects.get(user=user)
+            model.pwhash = pwhash
+            model.save()
+            return password
+        except ObjectDoesNotExist:
+            logger.error("User %s not found on mumble. Unable to update password." % user)
+            return False
+
+    @staticmethod
+    def update_groups(user, groups):
+        logger.debug("Updating mumble user %s groups %s" % (user, groups))
+        safe_groups = list(set([g.replace(' ', '-') for g in groups]))
+        groups = ''
+        for g in safe_groups:
+            groups = groups + g + ','
+        groups = groups.strip(',')
+        if MumbleUser.objects.filter(user=user).exists():
+            logger.info("Updating mumble user %s groups to %s" % (user, safe_groups))
+            model = MumbleUser.objects.get(user=user)
+            model.groups = groups
+            model.save()
+            return True
+        else:
+            logger.error("User %s not found on mumble. Unable to update groups." % user)
+            return False
+
+    @staticmethod
+    def user_exists(username):
+        return MumbleUser.objects.filter(username=username).exists()

services/modules/mumble/migrations/0001_initial.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.2 on 2016-12-12 00:58
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MumbleUser',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('username', models.CharField(max_length=254, unique=True)),
+                ('pwhash', models.CharField(max_length=40)),
+                ('groups', models.TextField(blank=True, null=True)),
+            ],
+            options={
+                'db_table': 'services_mumbleuser',
+            },
+        ),
+    ]

services/modules/mumble/migrations/0002_auto_20161212_0100.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.2 on 2016-12-12 01:00
+from __future__ import unicode_literals
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mumble', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterModelTable(
+            name='mumbleuser',
+            table=None,
+        ),
+    ]

services/modules/mumble/migrations/0003_mumbleuser_user.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.2 on 2016-12-12 03:31
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('mumble', '0002_auto_20161212_0100'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='mumbleuser',
+            name='user',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='mumble', to=settings.AUTH_USER_MODEL),
+        ),
+    ]

services/modules/mumble/migrations/0004_auto_20161214_1024.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.4 on 2016-12-14 10:24
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('mumble', '0003_mumbleuser_user'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='mumbleuser',
+            name='user',
+            field=models.OneToOneField(null=True, on_delete=django.db.models.deletion.CASCADE, related_name='mumble', to=settings.AUTH_USER_MODEL),
+        ),
+    ]

services/modules/mumble/models.py

@@ -0,0 +1,14 @@
+from __future__ import unicode_literals
+from django.utils.encoding import python_2_unicode_compatible
+from django.db import models
+
+
+@python_2_unicode_compatible
+class MumbleUser(models.Model):
+    user = models.OneToOneField('auth.User', related_name='mumble', null=True)
+    username = models.CharField(max_length=254, unique=True)
+    pwhash = models.CharField(max_length=40)
+    groups = models.TextField(blank=True, null=True)
+
+    def __str__(self):
+        return self.username

services/modules/mumble/tasks.py

@@ -0,0 +1,63 @@
+from __future__ import unicode_literals
+
+from alliance_auth.celeryapp import app
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.core.exceptions import ObjectDoesNotExist
+
+from .models import MumbleUser
+from .manager import MumbleManager
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class MumbleTasks:
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def has_account(user):
+        try:
+            return user.mumble.username != ''
+        except ObjectDoesNotExist:
+            return False
+
+    @staticmethod
+    def disable_mumble():
+        if settings.ENABLE_AUTH_MUMBLE:
+            logger.warn("ENABLE_AUTH_MUMBLE still True, after disabling users will still be able to create mumble accounts")
+        if settings.ENABLE_BLUE_MUMBLE:
+            logger.warn("ENABLE_BLUE_MUMBLE still True, after disabling blues will still be able to create mumble accounts")
+        logger.info("Deleting all MumbleUser models")
+        MumbleUser.objects.all().delete()
+
+    @staticmethod
+    @app.task(bind=True)
+    def update_groups(self, pk):
+        user = User.objects.get(pk=pk)
+        logger.debug("Updating mumble groups for user %s" % user)
+        if MumbleTasks.has_account(user):
+            groups = []
+            for group in user.groups.all():
+                groups.append(str(group.name))
+            if len(groups) == 0:
+                groups.append('empty')
+            logger.debug("Updating user %s mumble groups to %s" % (user, groups))
+            try:
+                if not MumbleManager.update_groups(user, groups):
+                    raise Exception("Group sync failed")
+            except:
+                logger.exception("Mumble group sync failed for %s, retrying in 10 mins" % user)
+                raise self.retry(countdown=60 * 10)
+            logger.debug("Updated user %s mumble groups." % user)
+        else:
+            logger.debug("User %s does not have a mumble account, skipping" % user)
+
+    @staticmethod
+    @app.task
+    def update_all_groups():
+        logger.debug("Updating ALL mumble groups")
+        for mumble_user in MumbleUser.objects.exclude(username__exact=''):
+            MumbleTasks.update_groups.delay(mumble_user.user.pk)

services/modules/mumble/tests.py

@@ -0,0 +1,201 @@
+from __future__ import unicode_literals
+
+try:
+    # Py3
+    from unittest import mock
+except ImportError:
+    # Py2
+    import mock
+
+from django.test import TestCase, RequestFactory
+from django.conf import settings
+from django import urls
+from django.contrib.auth.models import User
+from django.core.exceptions import ObjectDoesNotExist
+
+from alliance_auth.tests.auth_utils import AuthUtils
+
+from .auth_hooks import MumbleService
+from .models import MumbleUser
+from .tasks import MumbleTasks
+
+import hashlib
+
+MODULE_PATH = 'services.modules.mumble'
+
+
+def gen_pwhash(password):
+    return hashlib.sha1(password).hexdigest()
+
+
+class MumbleHooksTestCase(TestCase):
+    def setUp(self):
+        self.member = 'member_user'
+        member = AuthUtils.create_member(self.member)
+        MumbleUser.objects.create(user=member, username=self.member, pwhash='password', groups='Member')
+        self.blue = 'blue_user'
+        blue = AuthUtils.create_blue(self.blue)
+        MumbleUser.objects.create(user=blue, username=self.blue, pwhash='password', groups='Blue')
+        self.none_user = 'none_user'
+        none_user = AuthUtils.create_user(self.none_user)
+        self.service = MumbleService
+
+    def test_has_account(self):
+        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(MumbleTasks.has_account(member))
+        self.assertTrue(MumbleTasks.has_account(blue))
+        self.assertFalse(MumbleTasks.has_account(none_user))
+
+    def test_service_enabled(self):
+        service = self.service()
+        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_MUMBLE)
+        self.assertEqual(service.service_active_for_user(blue), settings.ENABLE_BLUE_MUMBLE)
+        self.assertFalse(service.service_active_for_user(none_user))
+
+    @mock.patch(MODULE_PATH + '.tasks.MumbleManager')
+    def test_update_all_groups(self, manager):
+        service = self.service()
+        service.update_all_groups()
+        # Check member and blue user have groups updated
+        self.assertTrue(manager.update_groups.called)
+        self.assertEqual(manager.update_groups.call_count, 2)
+
+    def test_update_groups(self):
+        # Check member has Member group updated
+        service = self.service()
+        member = User.objects.get(username=self.member)
+        member.mumble.groups = ''  # Remove the group set in setUp
+        member.mumble.save()
+
+        service.update_groups(member)
+
+        mumble_user = MumbleUser.objects.get(user=member)
+        self.assertIn(settings.DEFAULT_AUTH_GROUP, mumble_user.groups)
+
+        # Check none user does not have groups updated
+        with mock.patch(MODULE_PATH + '.tasks.MumbleManager') as manager:
+            service = self.service()
+            none_user = User.objects.get(username=self.none_user)
+            service.update_groups(none_user)
+            self.assertFalse(manager.update_groups.called)
+
+    def test_validate_user(self):
+        service = self.service()
+        # Test member is not deleted
+        member = User.objects.get(username=self.member)
+        service.validate_user(member)
+        self.assertTrue(member.mumble)
+
+        # Test none user is deleted
+        none_user = User.objects.get(username=self.none_user)
+        MumbleUser.objects.create(user=none_user, username='mr no-name', pwhash='password', groups='Blue,Orange')
+        service.validate_user(none_user)
+        with self.assertRaises(ObjectDoesNotExist):
+            none_mumble = User.objects.get(username=self.none_user).mumble
+
+    def test_delete_user(self):
+        member = User.objects.get(username=self.member)
+
+        service = self.service()
+        result = service.delete_user(member)
+
+        self.assertTrue(result)
+        with self.assertRaises(ObjectDoesNotExist):
+            mumble_user = User.objects.get(username=self.member).mumble
+
+    def test_render_services_ctrl(self):
+        service = self.service()
+        member = User.objects.get(username=self.member)
+        request = RequestFactory().get('/en/services/')
+        request.user = member
+
+        response = service.render_services_ctrl(request)
+        self.assertTemplateUsed(service.service_ctrl_template)
+        self.assertIn(urls.reverse('auth_deactivate_mumble'), response)
+        self.assertIn(urls.reverse('auth_reset_mumble_password'), response)
+        self.assertIn(urls.reverse('auth_set_mumble_password'), response)
+
+        # Test register becomes available
+        member.mumble.delete()
+        member = User.objects.get(username=self.member)
+        request.user = member
+        response = service.render_services_ctrl(request)
+        self.assertIn(urls.reverse('auth_activate_mumble'), response)
+
+
+class MumbleViewsTestCase(TestCase):
+    def setUp(self):
+        self.member = AuthUtils.create_member('auth_member')
+        self.member.set_password('password')
+        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',
+                                     corp_ticker='TESTR')
+
+    def login(self):
+        self.client.login(username=self.member.username, password='password')
+
+    def test_activate(self):
+        self.login()
+        expected_username = '[TESTR]auth_member'
+        response = self.client.get(urls.reverse('auth_activate_mumble'), follow=False)
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, expected_username)
+        mumble_user = MumbleUser.objects.get(user=self.member)
+        self.assertEqual(mumble_user.username, expected_username)
+        self.assertTrue(mumble_user.pwhash)
+        self.assertEqual(self.member.mumble.username, expected_username)
+
+    def test_deactivate(self):
+        self.login()
+        MumbleUser.objects.create(user=self.member, username='some member')
+
+        response = self.client.get(urls.reverse('auth_deactivate_mumble'))
+
+        self.assertRedirects(response, expected_url=urls.reverse('auth_services'), target_status_code=200)
+        with self.assertRaises(ObjectDoesNotExist):
+            mumble_user = User.objects.get(pk=self.member.pk).mumble
+
+    def test_set_password(self):
+        self.login()
+        MumbleUser.objects.create(user=self.member, username='some member', pwhash='old')
+
+        response = self.client.post(urls.reverse('auth_set_mumble_password'), data={'password': '1234asdf'})
+
+        self.assertNotEqual(MumbleUser.objects.get(user=self.member).pwhash, 'old')
+        self.assertRedirects(response, expected_url=urls.reverse('auth_services'), target_status_code=200)
+
+    def test_reset_password(self):
+        self.login()
+        MumbleUser.objects.create(user=self.member, username='some member', pwhash='old')
+
+        response = self.client.get(urls.reverse('auth_reset_mumble_password'))
+
+        self.assertNotEqual(MumbleUser.objects.get(user=self.member).pwhash, 'old')
+        self.assertTemplateUsed(response, 'registered/service_credentials.html')
+        self.assertContains(response, 'some member')
+
+
+class MumbleManagerTestCase(TestCase):
+    def setUp(self):
+        from .manager import MumbleManager
+        self.manager = MumbleManager
+
+    def test_generate_random_password(self):
+        password = self.manager._MumbleManager__generate_random_pass()
+
+        self.assertEqual(len(password), 16)
+        self.assertIsInstance(password, type(''))
+
+    def test_gen_pwhash(self):
+        pwhash = self.manager._gen_pwhash('test')
+
+        self.assertEqual(pwhash, 'a94a8fe5ccb19ba61c4c0873d391e987982fbbd3')

services/modules/mumble/urls.py

@@ -0,0 +1,17 @@
+from __future__ import unicode_literals
+from django.conf.urls import url, include
+
+from . import views
+
+module_urls = [
+    # Mumble service control
+    url(r'^activate/$', views.activate_mumble, name='auth_activate_mumble'),
+    url(r'^deactivate/$', views.deactivate_mumble, name='auth_deactivate_mumble'),
+    url(r'^reset_password/$', views.reset_mumble_password,
+        name='auth_reset_mumble_password'),
+    url(r'^set_password/$', views.set_mumble_password, name='auth_set_mumble_password'),
+]
+
+urlpatterns = [
+    url(r'^mumble/', include(module_urls))
+]

services/modules/mumble/views.py

@@ -0,0 +1,120 @@
+from __future__ import unicode_literals
+from django.contrib.auth.decorators import login_required
+from django.shortcuts import render, redirect
+from django.contrib import messages
+
+from authentication.decorators import members_and_blues
+from eveonline.managers import EveManager
+from eveonline.models import EveAllianceInfo
+from authentication.states import MEMBER_STATE, BLUE_STATE, NONE_STATE
+from authentication.models import AuthServicesInfo
+
+from services.forms import ServicePasswordForm
+
+from .manager import MumbleManager
+from .tasks import MumbleTasks
+from .models import MumbleUser
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+@login_required
+@members_and_blues()
+def activate_mumble(request):
+    logger.debug("activate_mumble called by user %s" % request.user)
+    authinfo = AuthServicesInfo.objects.get(user=request.user)
+    character = EveManager.get_main_character(request.user)
+    ticker = character.corporation_ticker
+
+    if authinfo.state == BLUE_STATE:
+        logger.debug("Adding mumble user for blue user %s with main character %s" % (request.user, character))
+        # Blue members should have alliance ticker (if in alliance)
+        if EveAllianceInfo.objects.filter(alliance_id=character.alliance_id).exists():
+            alliance = EveAllianceInfo.objects.filter(alliance_id=character.alliance_id)[0]
+            ticker = alliance.alliance_ticker
+        result = MumbleManager.create_user(request.user, ticker, character.character_name, blue=True)
+    else:
+        logger.debug("Adding mumble user for user %s with main character %s" % (request.user, character))
+        result = MumbleManager.create_user(request.user, ticker, character.character_name)
+
+    if result:
+        logger.debug("Updated authserviceinfo for user %s with mumble credentials. Updating groups." % request.user)
+        MumbleTasks.update_groups.apply(request.user.pk)  # Run synchronously to prevent timing issues
+        logger.info("Successfully activated mumble for user %s" % request.user)
+        messages.success(request, 'Activated Mumble account.')
+        credentials = {
+            'username': result[0],
+            'password': result[1],
+        }
+        return render(request, 'registered/service_credentials.html',
+                      context={'credentials': credentials, 'service': 'Mumble'})
+    else:
+        logger.error("Unsuccessful attempt to activate mumble for user %s" % request.user)
+        messages.error(request, 'An error occurred while processing your Mumble account.')
+    return redirect("auth_services")
+
+
+@login_required
+@members_and_blues()
+def deactivate_mumble(request):
+    logger.debug("deactivate_mumble called by user %s" % request.user)
+    # if we successfully remove the user or the user is already removed
+    if MumbleManager.delete_user(request.user):
+        logger.info("Successfully deactivated mumble for user %s" % request.user)
+        messages.success(request, 'Deactivated Mumble account.')
+    else:
+        logger.error("Unsuccessful attempt to deactivate mumble for user %s" % request.user)
+        messages.error(request, 'An error occurred while processing your Mumble account.')
+    return redirect("auth_services")
+
+
+@login_required
+@members_and_blues()
+def reset_mumble_password(request):
+    logger.debug("reset_mumble_password called by user %s" % request.user)
+    result = MumbleManager.update_user_password(request.user)
+
+    # if blank we failed
+    if result != "":
+        logger.info("Successfully reset mumble password for user %s" % request.user)
+        messages.success(request, 'Reset Mumble password.')
+        credentials = {
+            'username': request.user.mumble.username,
+            'password': result,
+        }
+        return render(request, 'registered/service_credentials.html',
+                      context={'credentials': credentials, 'service': 'Mumble'})
+    else:
+        logger.error("Unsuccessful attempt to reset mumble password for user %s" % request.user)
+        messages.error(request, 'An error occurred while processing your Mumble account.')
+    return redirect("auth_services")
+
+
+@login_required
+@members_and_blues()
+def set_mumble_password(request):
+    logger.debug("set_mumble_password called by user %s" % request.user)
+    if request.method == 'POST':
+        logger.debug("Received POST request with form.")
+        form = ServicePasswordForm(request.POST)
+        logger.debug("Form is valid: %s" % form.is_valid())
+        if form.is_valid() and MumbleTasks.has_account(request.user):
+            password = form.cleaned_data['password']
+            logger.debug("Form contains password of length %s" % len(password))
+            result = MumbleManager.update_user_password(request.user, password=password)
+            if result != "":
+                logger.info("Successfully reset forum password for user %s" % request.user)
+                messages.success(request, 'Set Mumble password.')
+            else:
+                logger.error("Failed to install custom mumble password for user %s" % request.user)
+                messages.error(request, 'An error occurred while processing your Mumble account.')
+            return redirect("auth_services")
+    else:
+        logger.debug("Request is not type POST - providing empty form.")
+        form = ServicePasswordForm()
+
+    logger.debug("Rendering form for user %s" % request.user)
+    context = {'form': form, 'service': 'Mumble'}
+    return render(request, 'registered/service_password.html', context=context)