Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-13 14:30:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

XenForo integration initial version (#459)

Browse Source 
* XenForo integration beta

* Removing debug loggers
This commit is contained in:
Meletis Flevarakis 2016-06-12 00:22:58 +03:00 committed by Adarnof
parent 842080f3de
commit e6b08fca88
10 changed files with 313 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
alliance_auth/settings.py.example
View File

@ -264,6 +264,7 @@ BLUE_ALLIANCE_GROUPS = 'True' == os.environ.get('AA_BLUE_ALLIANCE_GROUPS', 'Fals
# ENABLE_AUTH_SMF - Enable SMF forum support in the auth for auth'd members
# ENABLE_AUTH_MARKET = Enable Alliance Market support in auth for auth'd members
# ENABLE_AUTH_PATHFINDER = Enable Alliance Pathfinder suppor in auth for auth'd members
# ENABLE_AUTH_XENFORO = Enable XenForo forums support in the auth for auth'd members
#########################
ENABLE_AUTH_FORUM = 'True' == os.environ.get('AA_ENABLE_AUTH_FORUM', 'False')
ENABLE_AUTH_JABBER = 'True' == os.environ.get('AA_ENABLE_AUTH_JABBER', 'False')
@ -276,6 +277,7 @@ ENABLE_AUTH_IPS4 = 'True' == os.environ.get('AA_ENABLE_AUTH_IPS4', 'False')
ENABLE_AUTH_SMF = 'True' == os.environ.get('AA_ENABLE_AUTH_SMF', 'False')
ENABLE_AUTH_MARKET = 'True' == os.environ.get('AA_ENABLE_AUTH_MARKET', 'False')
ENABLE_AUTH_PATHFINDER = 'True' == os.environ.get('AA_ENABLE_AUTH_PATHFINDER', 'False')
ENABLE_AUTH_XENFORO = 'True' == os.environ.get('AA_ENABLE_AUTH_XENFORO', 'False')
#####################
# Blue service Setup
@ -291,6 +293,7 @@ ENABLE_AUTH_PATHFINDER = 'True' == os.environ.get('AA_ENABLE_AUTH_PATHFINDER', '
# ENABLE_BLUE_SMF - Enable SMF forum support in the auth for blues
# ENABLE_BLUE_MARKET - Enable Alliance Market in the auth for blues
# ENABLE_BLUE_PATHFINDER = Enable Pathfinder support in the auth for blues
# ENABLE_BLUE_XENFORO = Enable XenForo forum support in the auth for blue
#####################
BLUE_STANDING = float(os.environ.get('AA_BLUE_STANDING', '5.0'))
ENABLE_BLUE_FORUM = 'True' == os.environ.get('AA_ENABLE_BLUE_FORUM', 'False')
@ -304,6 +307,7 @@ ENABLE_BLUE_IPS4 = 'True' == os.environ.get('AA_ENABLE_BLUE_IPS4', 'False')
ENABLE_BLUE_SMF = 'True' == os.environ.get('AA_ENABLE_BLUE_SMF', 'False')
ENABLE_BLUE_MARKET = 'True' == os.environ.get('AA_ENABLE_BLUE_MARKET', 'False')
ENABLE_BLUE_PATHFINDER = 'True' == os.environ.get('AA_ENABLE_BLUE_PATHFINDER', 'False')
ENABLE_BLUE_XENFORO = 'True' == os.environ.get('AA_ENABLE_BLUE_XENFORO', 'False')
#########################
# Corp Configuration
@ -374,6 +378,14 @@ IPBOARD_ENDPOINT = os.environ.get('AA_IPBOARD_ENDPOINT', 'yourdomain.com/interfa
IPBOARD_APIKEY = os.environ.get('AA_IPBOARD_APIKEY', 'somekeyhere')
IPBOARD_APIMODULE = 'aa'
########################
# XenForo Configuration
########################
XENFORO_ENDPOINT = os.environ.get('AA_XENFORO_ENDPOINT', 'yourdomain.com/api.php')
XENFORO_DEFAULT_GROUP = os.environ.get('AA_XENFORO_DEFAULT_GROUP', 0)
XENFORO_APIKEY = os.environ.get('AA_XENFORO_APIKEY', 'yourapikey')
#####################
######################
# Jabber Configuration
######################

9
alliance_auth/urls.py
View File

@ -123,6 +123,15 @@ urlpatterns = patterns('',
name='auth_reset_ipboard_password'),
url(r'^set_ipboard_password/$', 'services.views.set_ipboard_password', name='auth_set_ipboard_password'),
# XenForo service control
url(r'^activate_xenforo/$', 'services.views.activate_xenforo_forum',
name='auth_activate_xenforo'),
url(r'^deactivate_xenforo/$', 'services.views.deactivate_xenforo_forum',
name='auth_deactivate_xenforo'),
url(r'^reset_xenforo_password/$', 'services.views.reset_xenforo_password',
name='auth_reset_xenforo_password'),
url(r'^set_xenforo_password/$', 'services.views.set_xenforo_password', name='auth_set_xenforo_password'),
# Teamspeak3 service control
url(r'^activate_teamspeak3/$', 'services.views.activate_teamspeak3',
name='auth_activate_teamspeak3'),

12
authentication/managers.py
View File

@ -90,6 +90,18 @@ class AuthServicesInfoManager:
else:
logger.error("Failed to update user %s ipboard info: user does not exist." % user)
@staticmethod
def update_user_xenforo_info(username, password, user):
if User.objects.filter(username=user.username).exists():
logger.debug("Updating user %s xenforo info: uername %s" % (user, username))
authserviceinfo = AuthServicesInfoManager.__get_or_create(user)
authserviceinfo.xenforo_username = username
authserviceinfo.xenforo_password = password
authserviceinfo.save(update_fields=['xenforo_username', 'xenforo_password'])
logger.info("Updated user %s xenforo info in authservicesinfo model." % user)
else:
logger.error("Failed to update user %s xenforo info: user does not exist." % user)
@staticmethod
def update_user_teamspeak3_info(uid, perm_key, user):
if User.objects.filter(username=user.username).exists():

2
authentication/models.py
View File

@ -5,6 +5,8 @@ from django.contrib.auth.models import User
class AuthServicesInfo(models.Model):
ipboard_username = models.CharField(max_length=254, blank=True, default="")
ipboard_password = models.CharField(max_length=254, blank=True, default="")
xenforo_username = models.CharField(max_length=254, blank=True, default="")
xenforo_password = models.CharField(max_length=254, blank=True, default="")
forum_username = models.CharField(max_length=254, blank=True, default="")
forum_password = models.CharField(max_length=254, blank=True, default="")
jabber_username = models.CharField(max_length=254, blank=True, default="")

1
celerytask/tasks.py
View File

@ -9,6 +9,7 @@ from services.managers.openfire_manager import OpenfireManager
from services.managers.mumble_manager import MumbleManager
from services.managers.phpbb3_manager import Phpbb3Manager
from services.managers.ipboard_manager import IPBoardManager
from services.managers.xenforo_manager import XenForoManager
from services.managers.teamspeak3_manager import Teamspeak3Manager
from services.managers.discord_manager import DiscordManager, DiscordAPIManager
from services.managers.discourse_manager import DiscourseManager

137
services/managers/xenforo_manager.py Normal file
View File

@ -0,0 +1,137 @@
import os
import requests
import json
from django.conf import settings
import logging
logger = logging.getLogger(__name__)
class XenForoManager:
def __init__(self):
if not settings.XENFORO_ENDPOINT:
logger.debug("Could not find XenForo endpoint")
if not settings.XENFORO_APIKEY:
logger.debug("XenForo API Key not found")
pass
@staticmethod
def __sanitize_username(username):
sanitized = username.replace(" ", "_")
return sanitized
@staticmethod
def __generate_password():
return os.urandom(8).encode('hex')
@staticmethod
def exec_http_request(http_params):
default_params = {
'hash': settings.XENFORO_APIKEY
}
http_params.update(default_params)
r = requests.get(settings.XENFORO_ENDPOINT, params=http_params)
return r
@staticmethod
def add_user(username, email):
sanitized = XenForoManager.__sanitize_username(username)
password = XenForoManager.__generate_password();
data = {
'action': 'register',
'username': sanitized,
'password': password,
'email': email,
'group': settings.XENFORO_DEFAULT_GROUP,
'visible': '1',
'user_state': 'valid'
}
r = XenForoManager.exec_http_request(data)
# check if the user already exist but was disabled
if r.status_code != 200:
if json.loads(r.text)['error'] == 7:
data = XenForoManager.reactivate_user(sanitized)
return data
response = {
'response': {
'message': r.text,
'status_code': r.status_code
}
}
data.update(response)
return data
@staticmethod
def reset_password(username):
password = XenForoManager.__generate_password();
data = {
'action': 'editUser',
'user': username,
'password': password
}
r = XenForoManager.exec_http_request(data)
response = {
'response': {
'message': r.text,
'status_code': r.status_code
}
}
data.update(response)
return data
@staticmethod
def disable_user(username):
data = {
'action': 'editUser',
'user': username,
'remove_groups': settings.XENFORO_DEFAULT_GROUP
}
r = XenForoManager.exec_http_request(data)
return r
@staticmethod
def reactivate_user(username):
data = {
'action': 'editUser',
'user': username,
'add_groups': settings.XENFORO_DEFAULT_GROUP,
'password': XenForoManager.__generate_password()
}
r = XenForoManager.exec_http_request(data)
response = {
'response': {
'message': r.text,
'status_code': r.status_code
},
'username': username
}
data.update(response)
return data
@staticmethod
def update_user_password(username, raw_password):
data = {
'action': 'editUser',
'user': username,
'password': raw_password
}
r = XenForoManager.exec_http_request(data)
response = {
'response': {
'message': r.text,
'status_code': r.status_code
},
'username': username
}
data.update(response)
return data

74
services/views.py
View File

@ -12,6 +12,7 @@ from managers.openfire_manager import OpenfireManager
from managers.phpbb3_manager import Phpbb3Manager
from managers.mumble_manager import MumbleManager
from managers.ipboard_manager import IPBoardManager
from managers.xenforo_manager import XenForoManager
from managers.teamspeak3_manager import Teamspeak3Manager
from managers.discord_manager import DiscordManager
from managers.discourse_manager import DiscourseManager
@ -178,6 +179,79 @@ def reset_forum_password(request):
logger.error("Unsuccessful attempt to reset forum password for user %s" % request.user)
return HttpResponseRedirect("/dashboard")
@login_required
@user_passes_test(service_blue_alliance_test)
def activate_xenforo_forum(request):
logger.debug("activate_xenforo_forum called by user %s" % request.user)
authinfo = AuthServicesInfoManager.get_auth_service_info(request.user)
character = EveManager.get_character_by_id(authinfo.main_char_id)
logger.debug("Adding XenForo user for user %s with main character %s" % (request.user, character))
result = XenForoManager.add_user(character.character_name, request.user.email)
# Based on XenAPI's response codes
if result['response']['status_code'] == 200:
logger.info("Updated authserviceinfo for user %s with XenForo credentials. Updating groups." % request.user)
AuthServicesInfoManager.update_user_xenforo_info(result['username'], result['password'], request.user)
return HttpResponseRedirect("/services/")
logger.error("Unsuccesful attempt to activate xenforo for user %s" % request.user)
return HttpResponseRedirect("/dashboard")
@login_required
@user_passes_test(service_blue_alliance_test)
def deactivate_xenforo_forum(request):
logger.debug("deactivate_xenforo_forum called by user %s" % request.user)
authinfo = AuthServicesInfoManager.get_auth_service_info(request.user)
result = XenForoManager.disable_user(authinfo.xenforo_username)
if result.status_code == 200:
AuthServicesInfoManager.update_user_xenforo_info("", "", request.user)
logger.info("Succesfully deactivated XenForo for user %s" % request.user)
return HttpResponseRedirect("/services/")
return HttpResponseRedirect("/dashboard")
@login_required
@user_passes_test(service_blue_alliance_test)
def reset_xenforo_password(request):
logger.debug("reset_xenforo_password called by user %s" % request.user)
authinfo = AuthServicesInfoManager.get_auth_service_info(request.user)
character = EveManager.get_character_by_id(authinfo.main_char_id)
result = XenForoManager.reset_password(authinfo.xenforo_username)
# Based on XenAPI's response codes
if result['response']['status_code'] == 200:
AuthServicesInfoManager.update_user_xenforo_info(authinfo.xenforo_username, result['password'], request.user)
logger.info("Succesfully reset XenForo password for user %s" % request.user)
return HttpResponseRedirect("/services/")
logger.error("Unsuccessful attempt to reset XenForo password for user %s" % request.user)
return HttpResponseRedirect("/dashboard")
@login_required
@user_passes_test(service_blue_alliance_test)
def set_xenforo_password(request):
logger.debug("set_xenforo_password called by user %s" % request.user)
error = None
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():
password = form.cleaned_data['password']
logger.debug("Form contains password of length %s" % len(password))
authinfo = AuthServicesInfoManager.get_auth_service_info(request.user)
result = XenForoManager.update_user_password(authinfo.xenforo_username, password)
if result['response']['status_code'] == 200:
AuthServicesInfoManager.update_user_xenforo_info(authinfo.xenforo_username, result['password'], request.user)
logger.info("Succesfully reset XenForo password for user %s" % request.user)
return HttpResponseRedirect("/services/")
else:
logger.error("Failed to install custom XenForo password for user %s" % request.user)
error = "Failed to install custom password."
else:
error = "Invalid password provided"
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': 'Forum'}
return render_to_response('registered/service_password.html', context, context_instance=RequestContext(request))
@login_required
@user_passes_test(service_blue_alliance_test)

58
stock/templates/registered/services.html
View File

@ -105,6 +105,35 @@
</td>
</tr>
{% endif %}
{% if ENABLE_BLUE_XENFORO %}
<tr>
<td class="text-center">XenForo Forums</td>
<td class="text-center">{{ authinfo.xenforo_username }}</td>
<td class="text-center">{{ authinfo.xenforo_password }}</td>
<td class="text-center"><a href="{{ FORUM_URL }}">{{ FORUM_URL }}</a></td>
<td class="text-center">
{% ifequal authinfo.xenforo_username "" %}
<a href="{% url 'auth_activate_xenforo' %}">
<button type="button" class="btn btn-warning"><span
class="glyphicon glyphicon-ok"></span></button>
</a>
{% else %}
<a href="{% url 'auth_set_xenforo_password' %}">
<button type="button" class="btn btn-warning"><span
class="glyphicon glyphicon-pencil"></span></button>
</a>
<a href="{% url 'auth_reset_xenforo_password' %}">
<button type="button" class="btn btn-primary"><span
class="glyphicon glyphicon-refresh"></span></button>
</a>
<a href="{% url 'auth_deactivate_xenforo' %}">
<button type="button" class="btn btn-danger"><span
class="glyphicon glyphicon-remove"></span></button>
</a>
{% endifequal %}
</td>
</tr>
{% endif %}
{% if ENABLE_BLUE_MARKET %}
<tr>
<td class="text-center">Alliance Market</td>
@ -430,6 +459,35 @@
</td>
</tr>
{% endif %}
{% if ENABLE_AUTH_XENFORO %}
<tr>
<td class="text-center">XenForo Forums</td>
<td class="text-center">{{ authinfo.xenforo_username }}</td>
<td class="text-center">{{ authinfo.xenforo_password }}</td>
<td class="text-center"><a href="{{ FORUM_URL }}">{{ FORUM_URL }}</a></td>
<td class="text-center">
{% ifequal authinfo.xenforo_username "" %}
<a href="{% url 'auth_activate_xenforo' %}">
<button type="button" class="btn btn-warning"><span
class="glyphicon glyphicon-ok"></span></button>
</a>
{% else %}
<a href="{% url 'auth_set_xenforo_password' %}">
<button type="button" class="btn btn-warning"><span
class="glyphicon glyphicon-pencil"></span></button>
</a>
<a href="{% url 'auth_reset_xenforo_password' %}">
<button type="button" class="btn btn-primary"><span
class="glyphicon glyphicon-refresh"></span></button>
</a>
<a href="{% url 'auth_deactivate_xenforo' %}">
<button type="button" class="btn btn-danger"><span
class="glyphicon glyphicon-remove"></span></button>
</a>
{% endifequal %}
</td>
</tr>
{% endif %}
{% if ENABLE_AUTH_MARKET %}
<tr>
<td class="text-center">Alliance Market</td>

6
util/common_task.py
View File

@ -8,6 +8,7 @@ from services.managers.mumble_manager import MumbleManager
from services.managers.ipboard_manager import IPBoardManager
from services.managers.teamspeak3_manager import Teamspeak3Manager
from services.managers.discord_manager import DiscordManager
from services.managers.xenforo_manager import XenForoManager
import logging
@ -72,6 +73,11 @@ def deactivate_services(user):
DiscordManager.delete_user(authinfo.discord_uid)
AuthServicesInfoManager.update_user_discord_info("", user)
change = True
if authinfo.xenforo_username and authinfo.xenforo_password != "":
logger.debug("User %s has a XenForo account %s. Deleting." % (user, authinfo.xenforo_username))
XenForoManager.disable_user(authinfo.xenforo_username)
AuthServicesInfoManager.update_user_xenforo_info("", "", user)
change = True
if change:
notify(user, "Services Disabled", message="Your services accounts have been disabled.", level="danger")

2
util/context_processors.py
View File

@ -40,6 +40,7 @@ def domain_url(request):
'ENABLE_AUTH_DISCOURSE': settings.ENABLE_AUTH_DISCOURSE,
'ENABLE_AUTH_IPS4': settings.ENABLE_AUTH_IPS4,
'ENABLE_AUTH_SMF': settings.ENABLE_AUTH_SMF,
'ENABLE_AUTH_XENFORO': settings.ENABLE_AUTH_XENFORO,
'ENABLE_AUTH_MARKET': settings.ENABLE_AUTH_MARKET,
'ENABLE_AUTH_PATHFINDER': settings.ENABLE_AUTH_PATHFINDER,
'ENABLE_BLUE_JABBER': settings.ENABLE_BLUE_JABBER,
@ -53,6 +54,7 @@ def domain_url(request):
'ENABLE_BLUE_SMF': settings.ENABLE_BLUE_SMF,
'ENABLE_BLUE_MARKET': settings.ENABLE_BLUE_MARKET,
'ENABLE_BLUE_PATHFINDER': settings.ENABLE_BLUE_PATHFINDER,
'ENABLE_BLUE_XENFORO': settings.ENABLE_BLUE_XENFORO,
'TEAMSPEAK3_PUBLIC_URL': settings.TEAMSPEAK3_PUBLIC_URL,
'JACK_KNIFE_URL': settings.JACK_KNIFE_URL,
'DISCORD_SERVER_ID': settings.DISCORD_SERVER_ID,