149 lines
4.5 KiB
Python
149 lines
4.5 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8
|
|
|
|
# (c) 2018, Jan Christian Grünhage <jan.christian@gruenhage.xyz>
|
|
# (c) 2020, 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
|
|
|
|
ANSIBLE_METADATA = {
|
|
'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'
|
|
}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author: "Jan Christian Grünhage (@jcgruenhage)"
|
|
module: matrix_room
|
|
short_description: Join/Create matrix room
|
|
description:
|
|
- This module takes a room alias and makes sure that the user identified by the access token is in such a room. If that room does not exist, it is created, if it does exist but the user is not in it, it tries to join. If the alias is taken and the user can't join the room, the module will fail. Remote aliases are not supported for creating, but work for joining.
|
|
options:
|
|
alias:
|
|
description:
|
|
- Alias of the room to join/create
|
|
required: true
|
|
hs_url:
|
|
description:
|
|
- URL of the homeserver, where the CS-API is reachable
|
|
required: true
|
|
token:
|
|
description:
|
|
- Authentication token for the API call.
|
|
requirements:
|
|
- matrix-nio (Python library)
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Create notification room
|
|
matrix_room:
|
|
alias: "#ansible-notifications:matrix.org"
|
|
hs_url: "https://matrix.org"
|
|
token: "{{ matrix_auth_token }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
room_id:
|
|
description: ID of the room
|
|
type: str
|
|
sample: !asdfbuiarbk213e479asf:server.tld
|
|
'''
|
|
import traceback
|
|
import asyncio
|
|
import re
|
|
import sys
|
|
|
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
|
|
|
MATRIX_IMP_ERR = None
|
|
try:
|
|
from nio import (AsyncClient, RoomResolveAliasResponse, JoinedRoomsError, RoomCreateResponse, JoinResponse)
|
|
except ImportError:
|
|
MATRIX_IMP_ERR = traceback.format_exc()
|
|
matrix_found = False
|
|
else:
|
|
matrix_found = True
|
|
|
|
async def run_module():
|
|
module_args = dict(
|
|
alias=dict(type='str', required=True),
|
|
hs_url=dict(type='str', required=True),
|
|
token=dict(type='str', required=True, no_log=True),
|
|
)
|
|
|
|
result = dict(
|
|
changed=False,
|
|
message=''
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=module_args,
|
|
supports_check_mode=True
|
|
)
|
|
|
|
if not matrix_found:
|
|
module.fail_json(msg=missing_required_lib('matrix-nio'), exception=MATRIX_IMP_ERR)
|
|
|
|
if module.check_mode:
|
|
return result
|
|
|
|
# create a client object
|
|
client = AsyncClient(module.params['hs_url'])
|
|
client.access_token = module.params['token']
|
|
|
|
# Try to look up room_id
|
|
room_id_resp = await client.room_resolve_alias(module.params['alias'])
|
|
|
|
failed = False
|
|
result = {}
|
|
|
|
if isinstance(room_id_resp, RoomResolveAliasResponse):
|
|
# Check if already in room
|
|
rooms_resp = await client.joined_rooms()
|
|
if isinstance(rooms_resp, JoinedRoomsError):
|
|
failed = True
|
|
result = {"msg":"Couldn't get joined rooms."}
|
|
elif room_id_resp.room_id in rooms_resp.rooms:
|
|
result = {"room_id": room_id_resp.room_id, "changed": False}
|
|
else:
|
|
# Try to join room
|
|
join_resp = await client.join(module.params['alias'])
|
|
|
|
# If successful, return, changed=true
|
|
if isinstance(join_resp, JoinResponse):
|
|
result = {"room_id": join_resp.room_id, "changed": True}
|
|
else:
|
|
failed = True
|
|
result = {"msg": "Room exists, but couldn't join: {1}".format(join_resp)}
|
|
else:
|
|
# Get local part of alias
|
|
local_part_regex = re.search("#([^:]*):(.*)", module.params['alias'])
|
|
local_part = local_part_regex.groups()[0]
|
|
|
|
# Try to create room with alias
|
|
create_room_resp = await client.room_create(alias=local_part)
|
|
|
|
# If successful, exit with changed=true and room_id
|
|
if isinstance(create_room_resp, RoomCreateResponse):
|
|
result = {"room_id": create_room_resp.room_id, "changed": True}
|
|
else:
|
|
json_resp = await create_room_resp.transport_response.json()
|
|
failed = True
|
|
result = {"msg": "Room does not exist but couldn't be created either: {0}".format(create_room_resp)}
|
|
|
|
await client.close()
|
|
if failed:
|
|
module.fail_json(**result)
|
|
else:
|
|
module.exit_json(**result)
|
|
|
|
def main():
|
|
asyncio.run(run_module())
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|