mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-16 16:00:17 +02:00
277 lines
12 KiB
Python
277 lines
12 KiB
Python
import logging
|
|
|
|
from django.conf import settings
|
|
|
|
from .util.ts3 import TS3Server, TeamspeakError
|
|
from .models import TSgroup
|
|
from allianceauth.groupmanagement.models import ReservedGroupName
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class Teamspeak3Manager:
|
|
def __init__(self):
|
|
self._server = None
|
|
|
|
@property
|
|
def server(self):
|
|
if self._server is not None and self._server._connected:
|
|
return self._server
|
|
else:
|
|
raise ValueError("Teamspeak not connected")
|
|
|
|
def connect(self):
|
|
self._server = self.__get_created_server()
|
|
return self
|
|
|
|
def disconnect(self):
|
|
self._server.disconnect()
|
|
self._server = None
|
|
|
|
def __enter__(self):
|
|
logger.debug("Entering with statement, connecting")
|
|
self.connect()
|
|
return self
|
|
|
|
def __exit__(self, _type, value, traceback):
|
|
logger.debug("Exiting with statement, cleaning up")
|
|
self.disconnect()
|
|
|
|
@staticmethod
|
|
def __get_created_server():
|
|
server = TS3Server(settings.TEAMSPEAK3_SERVER_IP, settings.TEAMSPEAK3_SERVER_PORT)
|
|
server.login(settings.TEAMSPEAK3_SERVERQUERY_USER, settings.TEAMSPEAK3_SERVERQUERY_PASSWORD)
|
|
server.use(settings.TEAMSPEAK3_VIRTUAL_SERVER)
|
|
logger.debug("Got TS3 server instance based on settings.")
|
|
return server
|
|
|
|
@staticmethod
|
|
def __santatize_username(username):
|
|
sanatized = username.replace(" ", "_")
|
|
sanatized = sanatized.replace("'", "-")
|
|
return sanatized
|
|
|
|
def _get_userid(self, uid):
|
|
logger.debug("Looking for uid %s on TS3 server." % uid)
|
|
try:
|
|
ret = self.server.send_command('customsearch', {'ident': 'sso_uid', 'pattern': uid})
|
|
if ret and 'keys' in ret and 'cldbid' in ret['keys']:
|
|
logger.debug("Got userid {} for uid {}".format(ret['keys']['cldbid'], uid))
|
|
return ret['keys']['cldbid']
|
|
except TeamspeakError as e:
|
|
if not e.code == '1281':
|
|
raise e
|
|
return None
|
|
|
|
def _group_id_by_name(self, groupname):
|
|
logger.debug("Looking for group %s on TS3 server." % groupname)
|
|
group_cache = self.server.send_command('servergrouplist')
|
|
logger.debug("Received group cache from server: %s" % group_cache)
|
|
for group in group_cache:
|
|
if group['keys']['type'] != '1':
|
|
continue
|
|
logger.debug("Checking group %s" % group)
|
|
if group['keys']['name'] == groupname:
|
|
logger.debug("Found group {}, returning id {}".format(groupname, group['keys']['sgid']))
|
|
return group['keys']['sgid']
|
|
logger.debug("Group %s not found on server." % groupname)
|
|
return None
|
|
|
|
def _create_group(self, groupname):
|
|
logger.debug("Creating group %s on TS3 server." % groupname)
|
|
sgid = self._group_id_by_name(groupname)
|
|
if not sgid:
|
|
logger.debug("Group does not yet exist. Proceeding with creation.")
|
|
ret = self.server.send_command('servergroupadd', {'name': groupname})
|
|
self.__group_cache = None
|
|
sgid = ret['keys']['sgid']
|
|
self.server.send_command('servergroupaddperm',
|
|
{'sgid': sgid, 'permsid': 'i_group_needed_modify_power', 'permvalue': 75,
|
|
'permnegated': 0, 'permskip': 0})
|
|
self.server.send_command('servergroupaddperm',
|
|
{'sgid': sgid, 'permsid': 'i_group_needed_member_add_power', 'permvalue': 100,
|
|
'permnegated': 0, 'permskip': 0})
|
|
self.server.send_command('servergroupaddperm',
|
|
{'sgid': sgid, 'permsid': 'i_group_needed_member_remove_power', 'permvalue': 100,
|
|
'permnegated': 0, 'permskip': 0})
|
|
logger.info(f"Created group on TS3 server with name {groupname} and id {sgid}")
|
|
return sgid
|
|
|
|
def _user_group_list(self, cldbid):
|
|
logger.debug("Retrieving group list for user with id %s" % cldbid)
|
|
server = Teamspeak3Manager.__get_created_server()
|
|
try:
|
|
groups = self.server.send_command('servergroupsbyclientid', {'cldbid': cldbid})
|
|
except TeamspeakError as e:
|
|
if e.code == '1281': # no groups
|
|
groups = []
|
|
else:
|
|
raise e
|
|
logger.debug("Retrieved group list: %s" % groups)
|
|
outlist = {}
|
|
|
|
if type(groups) == list:
|
|
logger.debug("Recieved multiple groups. Iterating.")
|
|
for group in groups:
|
|
outlist[group['keys']['name']] = group['keys']['sgid']
|
|
elif type(groups) == dict:
|
|
logger.debug("Recieved single group.")
|
|
outlist[groups['keys']['name']] = groups['keys']['sgid']
|
|
logger.debug("Returning name/id pairing: %s" % outlist)
|
|
return outlist
|
|
|
|
def _group_list(self):
|
|
logger.debug("Retrieving group list on TS3 server.")
|
|
group_cache = self.server.send_command('servergrouplist')
|
|
logger.debug("Received group cache from server: %s" % group_cache)
|
|
outlist = {}
|
|
if group_cache:
|
|
for group in group_cache:
|
|
if group['keys']['type'] != '1':
|
|
continue
|
|
logger.debug("Assigning name/id dict: {} = {}".format(group['keys']['name'], group['keys']['sgid']))
|
|
outlist[group['keys']['name']] = group['keys']['sgid']
|
|
else:
|
|
logger.error("Received empty group cache while retrieving group cache from TS3 server. 1024 error.")
|
|
logger.debug("Returning name/id pairing: %s" % outlist)
|
|
return outlist
|
|
|
|
def _add_user_to_group(self, uid, groupid):
|
|
logger.debug(f"Adding group id {groupid} to TS3 user id {uid}")
|
|
user_groups = self._user_group_list(uid)
|
|
|
|
if groupid not in user_groups.values():
|
|
logger.debug("User does not have group already. Issuing command to add.")
|
|
self.server.send_command('servergroupaddclient',
|
|
{'sgid': str(groupid), 'cldbid': uid})
|
|
logger.info(f"Added user id {uid} to group id {groupid} on TS3 server.")
|
|
|
|
def _remove_user_from_group(self, uid, groupid):
|
|
logger.debug(f"Removing group id {groupid} from TS3 user id {uid}")
|
|
user_groups = self._user_group_list(uid)
|
|
|
|
if str(groupid) in user_groups.values():
|
|
logger.debug("User is in group. Issuing command to remove.")
|
|
self.server.send_command('servergroupdelclient',
|
|
{'sgid': str(groupid), 'cldbid': uid})
|
|
logger.info(f"Removed user id {uid} from group id {groupid} on TS3 server.")
|
|
|
|
def _sync_ts_group_db(self):
|
|
try:
|
|
remote_groups = self._group_list()
|
|
managed_groups = {g:int(remote_groups[g]) for g in remote_groups if g in set(remote_groups.keys()) - set(ReservedGroupName.objects.values_list('name', flat=True))}
|
|
remove = TSgroup.objects.exclude(ts_group_id__in=managed_groups.values())
|
|
|
|
if remove:
|
|
logger.debug(f"Deleting {remove.count()} TSgroup models: not found on server, or reserved name.")
|
|
remove.delete()
|
|
|
|
add = {g:managed_groups[g] for g in managed_groups if managed_groups[g] in set(managed_groups.values()) - set(TSgroup.objects.values_list("ts_group_id", flat=True))}
|
|
if add:
|
|
logger.debug(f"Adding {len(add)} new TSgroup models.")
|
|
models = [TSgroup(ts_group_name=name, ts_group_id=add[name]) for name in add]
|
|
TSgroup.objects.bulk_create(models)
|
|
|
|
except TeamspeakError as e:
|
|
logger.error(f"Error occurred while syncing TS group db: {str(e)}")
|
|
except Exception:
|
|
logger.exception(f"An unhandled exception has occurred while syncing TS groups.")
|
|
|
|
def add_user(self, user, fmt_name):
|
|
username_clean = self.__santatize_username(fmt_name[:30])
|
|
logger.debug("Adding user to TS3 server with cleaned username %s" % username_clean)
|
|
server_groups = self._group_list()
|
|
|
|
state = user.profile.state.name
|
|
if state not in server_groups:
|
|
self._create_group(state)
|
|
|
|
state_group_id = self._group_id_by_name(state)
|
|
|
|
try:
|
|
ret = self.server.send_command('tokenadd', {'tokentype': 0, 'tokenid1': state_group_id, 'tokenid2': 0,
|
|
'tokendescription': username_clean,
|
|
'tokencustomset': "ident=sso_uid value=%s" % username_clean})
|
|
except TeamspeakError as e:
|
|
logger.error(f"Failed to add teamspeak user {username_clean}: {str(e)}")
|
|
return "",""
|
|
|
|
try:
|
|
token = ret['keys']['token']
|
|
logger.info("Created permission token for user %s on TS3 server" % username_clean)
|
|
return username_clean, token
|
|
except:
|
|
logger.exception(f"Failed to add teamspeak user {username_clean} - received response: {ret}")
|
|
return "", ""
|
|
|
|
def delete_user(self, uid):
|
|
user = self._get_userid(uid)
|
|
logger.debug(f"Deleting user {user} with id {uid} from TS3 server.")
|
|
if user:
|
|
clients = self.server.send_command('clientlist')
|
|
if isinstance(clients, dict):
|
|
# Rewrap list
|
|
clients = [clients]
|
|
|
|
for client in clients:
|
|
try:
|
|
if client['keys']['client_database_id'] == user:
|
|
logger.debug("Found user %s on TS3 server - issuing deletion command." % user)
|
|
self.server.send_command('clientkick', {'clid': client['keys']['clid'], 'reasonid': 5,
|
|
'reasonmsg': 'Auth service deleted'})
|
|
except:
|
|
logger.exception(f"Failed to delete user id {uid} from TS3 - received response {client}")
|
|
return False
|
|
try:
|
|
ret = self.server.send_command('clientdbdelete', {'cldbid': user})
|
|
except TeamspeakError as e:
|
|
logger.error(f"Failed to delete teamspeak user {uid}: {str(e)}")
|
|
return False
|
|
if ret == '0':
|
|
logger.info("Deleted user with id %s from TS3 server." % uid)
|
|
return True
|
|
else:
|
|
logger.exception(f"Failed to delete user id {uid} from TS3 - received response {ret}")
|
|
return False
|
|
else:
|
|
logger.warning("User with id %s not found on TS3 server. Assuming succesful deletion." % uid)
|
|
return True
|
|
|
|
def check_user_exists(self, uid):
|
|
if self._get_userid(uid):
|
|
return True
|
|
|
|
return False
|
|
|
|
def generate_new_permissionkey(self, uid, user, username):
|
|
logger.debug("Re-issuing permission key for user id %s" % uid)
|
|
self.delete_user(uid)
|
|
return self.add_user(user, username)
|
|
|
|
def update_groups(self, uid, ts_groups):
|
|
logger.debug(f"Updating uid {uid} TS3 groups {ts_groups}")
|
|
userid = self._get_userid(uid)
|
|
addgroups = []
|
|
remgroups = []
|
|
if userid is not None:
|
|
user_ts_groups = self._user_group_list(userid)
|
|
logger.debug("User has groups on TS3 server: %s" % user_ts_groups)
|
|
for key in user_ts_groups:
|
|
user_ts_groups[key] = int(user_ts_groups[key])
|
|
for ts_group_key in ts_groups:
|
|
logger.debug("Checking if user has group %s on TS3 server." % ts_group_key)
|
|
if ts_groups[ts_group_key] not in user_ts_groups.values():
|
|
addgroups.append(ts_groups[ts_group_key])
|
|
for user_ts_group_key in user_ts_groups:
|
|
if user_ts_groups[user_ts_group_key] not in ts_groups.values():
|
|
if not ReservedGroupName.objects.filter(name=user_ts_group_key).exists():
|
|
remgroups.append(user_ts_groups[user_ts_group_key])
|
|
|
|
for g in addgroups:
|
|
logger.info(f"Adding Teamspeak user {userid} into group {g}")
|
|
self._add_user_to_group(userid, g)
|
|
|
|
for g in remgroups:
|
|
logger.info(f"Removing Teamspeak user {userid} from group {g}")
|
|
self._remove_user_from_group(userid, g)
|