mirror of
https://github.com/famedly/ansible-collection-matrix
synced 2024-12-14 05:02:27 +00:00
134 lines
4.8 KiB
Python
134 lines
4.8 KiB
Python
# coding: utf-8
|
|
|
|
# (c) 2021-2022, Famedly GmbH
|
|
# GNU Affero General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/agpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
import traceback
|
|
|
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
|
|
|
# Check if all required libs can load
|
|
LIB_IMP_ERR = None
|
|
try:
|
|
from nio import AsyncClient, AsyncClientConfig, \
|
|
Api, \
|
|
LoginResponse, LoginError, \
|
|
LogoutResponse, LogoutError, \
|
|
RoomGetStateResponse, RoomGetStateError, \
|
|
RoomBanResponse, RoomBanError, \
|
|
RoomUnbanResponse, RoomUnbanError, \
|
|
RoomKickResponse, RoomKickError, \
|
|
RoomInviteResponse, RoomInviteError, \
|
|
RoomResolveAliasResponse, RoomResolveAliasError, \
|
|
JoinedRoomsResponse, JoinedRoomsError
|
|
HAS_LIB = True
|
|
except ImportError:
|
|
LIB_IMP_ERR = traceback.format_exc()
|
|
HAS_LIB = False
|
|
|
|
|
|
class AnsibleNioModule:
|
|
def __init__(self,
|
|
custom_spec=None,
|
|
bypass_checks=False,
|
|
no_log=False,
|
|
mutually_exclusive=None,
|
|
required_together=None,
|
|
required_one_of=None,
|
|
required_by=None,
|
|
add_file_common_args=False,
|
|
supports_check_mode=True,
|
|
required_if=None,
|
|
user_logout=None):
|
|
|
|
if required_by is None:
|
|
required_by = {'password': 'user_id'}
|
|
|
|
if required_one_of is None:
|
|
required_one_of = [['password', 'token']]
|
|
|
|
if mutually_exclusive is None:
|
|
mutually_exclusive = [['password', 'token']]
|
|
|
|
if custom_spec is None:
|
|
custom_spec = {}
|
|
|
|
# Create the Ansible module
|
|
self.module = AnsibleModule(
|
|
argument_spec=AnsibleNioModule.__common_argument_spec(custom_spec),
|
|
bypass_checks=bypass_checks,
|
|
no_log=no_log,
|
|
mutually_exclusive=mutually_exclusive,
|
|
required_together=required_together,
|
|
required_one_of=required_one_of,
|
|
add_file_common_args=add_file_common_args,
|
|
supports_check_mode=supports_check_mode,
|
|
required_if=required_if,
|
|
required_by=required_by
|
|
)
|
|
|
|
if user_logout is None:
|
|
# If a user/password login is provided, should we logout when exiting?
|
|
self.user_logout = self.module.params['token'] is not None
|
|
else:
|
|
self.user_logout = user_logout
|
|
|
|
# Make some values from the module easly accessible
|
|
self.check_mode = self.module.check_mode
|
|
self.params = self.module.params
|
|
|
|
# Fail when matix-nio is not installed
|
|
# WARNING: We don't perform a version check!
|
|
if not HAS_LIB:
|
|
self.module.fail_json(msg=missing_required_lib("matrix-nio"))
|
|
|
|
async def matrix_login(self):
|
|
# Login with token or supplied user account
|
|
if self.module.params['token'] is None:
|
|
self.client = AsyncClient(self.module.params['hs_url'], self.module.params['user_id'])
|
|
login_response = await self.client.login(password=self.module.params['password'])
|
|
else:
|
|
self.client = AsyncClient(self.module.params['hs_url'])
|
|
login_response = await self.client.login(token=self.module.params['token'])
|
|
if isinstance(login_response, LoginResponse):
|
|
self.access_token = login_response.access_token
|
|
self.device_id = login_response.device_id
|
|
else:
|
|
result = {
|
|
'msg': login_response.message,
|
|
'http_status_code': login_response.status_code
|
|
}
|
|
self.module.fail_json(**result)
|
|
|
|
async def matrix_logout(self):
|
|
if self.client.logged_in:
|
|
request = await self.client.logout()
|
|
if isinstance(request, LogoutError):
|
|
result = {'msg': request.message}
|
|
self.module.fail_json(**result)
|
|
|
|
async def exit_json(self, **result):
|
|
if self.module.params['token'] is None and self.user_logout is True:
|
|
await self.matrix_logout()
|
|
await self.client.close()
|
|
self.module.exit_json(**result)
|
|
|
|
async def fail_json(self, **result):
|
|
if self.module.params['token'] is None and self.user_logout is True:
|
|
await self.matrix_logout()
|
|
await self.client.close()
|
|
self.module.fail_json(**result)
|
|
|
|
@staticmethod
|
|
def __common_argument_spec(custom_spec: dict):
|
|
argument_spec = dict(
|
|
hs_url=dict(type='str', required=True),
|
|
user_id=dict(type='str', required=False),
|
|
password=dict(type='str', required=False, no_log=True),
|
|
token=dict(type='str', required=False, no_log=True)
|
|
)
|
|
return {**argument_spec, **custom_spec}
|