142 lines
4 KiB
Python
142 lines
4 KiB
Python
|
"""
|
||
|
|
[Maubot](https://mau.dev/maubot/maubot) plugin to shame room members into
|
||
|
|
upgrading their Matrix homeservers to the latest version.
|
||
|
|
"""
|
||
|
|
import json
|
||
|
|
|
||
|
|
from typing import Dict, List, Type
|
||
|
|
|
||
|
|
import requests
|
||
|
|
|
||
|
|
from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper
|
||
|
|
from mautrix.types import TextMessageEventContent, MessageType, Format, \
|
||
|
|
RelatesTo, RelationType, EventID, RoomID, UserID
|
||
|
|
from mautrix.util import markdown
|
||
|
|
|
||
|
|
from maubot import Plugin, MessageEvent
|
||
|
|
from maubot.handlers import command
|
||
|
|
|
||
|
|
|
||
|
|
class Config(BaseProxyConfig):
|
||
|
|
"""
|
||
|
|
Config class
|
||
|
|
"""
|
||
|
|
def do_update(self, helper: ConfigUpdateHelper) -> None:
|
||
|
|
"""
|
||
|
|
Class method to update the config
|
||
|
|
"""
|
||
|
|
helper.copy('federation_tester')
|
||
|
|
helper.copy('dead_servers')
|
||
|
|
|
||
|
|
|
||
|
|
class ShameOTron(Plugin):
|
||
|
|
"""
|
||
|
|
Main class for the Shame-o-Tron
|
||
|
|
"""
|
||
|
|
async def start(self) -> None:
|
||
|
|
"""
|
||
|
|
Class method for plugin startup
|
||
|
|
"""
|
||
|
|
self.on_external_config_update()
|
||
|
|
|
||
|
|
|
||
|
|
@classmethod
|
||
|
|
def get_config_class(cls) -> Type[Config]:
|
||
|
|
"""
|
||
|
|
Class method for getting the config
|
||
|
|
"""
|
||
|
|
return Config
|
||
|
|
|
||
|
|
|
||
|
|
async def _edit(self, room_id: RoomID, event_id: EventID, text: str) -> None:
|
||
|
|
"""
|
||
|
|
Class method to update an existing message event
|
||
|
|
"""
|
||
|
|
content = TextMessageEventContent(msgtype=MessageType.NOTICE, body=text, format=Format.HTML,
|
||
|
|
formatted_body=markdown.render(text))
|
||
|
|
content.set_edit(event_id)
|
||
|
|
await self.client.send_message(room_id, content)
|
||
|
|
|
||
|
|
|
||
|
|
async def _load_members(self, room_id: RoomID) -> Dict[str, List[UserID]]:
|
||
|
|
"""
|
||
|
|
Class method to return the servers and room members
|
||
|
|
"""
|
||
|
|
users = await self.client.get_joined_members(room_id)
|
||
|
|
servers: Dict[str, List[UserID]] = {}
|
||
|
|
for user in users:
|
||
|
|
_, server = self.client.parse_user_id(user)
|
||
|
|
servers.setdefault(server, []).append(user)
|
||
|
|
return servers
|
||
|
|
|
||
|
|
|
||
|
|
async def query_homeserver_version(self, host):
|
||
|
|
"""
|
||
|
|
Function to query the Federation Tester to retrieve the running version
|
||
|
|
for a server
|
||
|
|
|
||
|
|
host: (str) Server to get version for
|
||
|
|
|
||
|
|
Returns: (str) Version string of the server
|
||
|
|
"""
|
||
|
|
try:
|
||
|
|
req = requests.get(
|
||
|
|
self.config["federation_tester"].format(server=host),
|
||
|
|
timeout=10000
|
||
|
|
)
|
||
|
|
except requests.exceptions.Timeout:
|
||
|
|
return '[TIMEOUT]'
|
||
|
|
|
||
|
|
data = json.loads(req.text)
|
||
|
|
|
||
|
|
if not data['FederationOK']:
|
||
|
|
return '[OFFLINE]'
|
||
|
|
|
||
|
|
try:
|
||
|
|
return data['Version']['version']
|
||
|
|
except KeyError:
|
||
|
|
return '[ERROR]'
|
||
|
|
|
||
|
|
|
||
|
|
@command.new('shame', help='Show versions of all homeservers in the room')
|
||
|
|
async def shame_handler(self, evt: MessageEvent) -> None:
|
||
|
|
"""
|
||
|
|
Class method to handle the `!shame` command
|
||
|
|
"""
|
||
|
|
event_id = await evt.reply('Loading member list...')
|
||
|
|
member_servers = await self._load_members(evt.room_id)
|
||
|
|
|
||
|
|
# Filter out the "dead servers"
|
||
|
|
dead_servers = self.config['dead_servers']
|
||
|
|
if dead_servers:
|
||
|
|
# Return a unique list
|
||
|
|
member_servers = sorted(
|
||
|
|
list(
|
||
|
|
set(member_servers.keys() - set(dead_servers))
|
||
|
|
)
|
||
|
|
)
|
||
|
|
|
||
|
|
await self._edit(
|
||
|
|
evt.room_id,
|
||
|
|
event_id,
|
||
|
|
'Member list loaded, fetching versions... please wait...'
|
||
|
|
)
|
||
|
|
|
||
|
|
versions = []
|
||
|
|
for host in member_servers:
|
||
|
|
versions.append(
|
||
|
|
(host, await self.query_homeserver_version(host))
|
||
|
|
)
|
||
|
|
|
||
|
|
await self._edit(
|
||
|
|
evt.room_id,
|
||
|
|
event_id,
|
||
|
|
(
|
||
|
|
'#### Homeserver versions\n'
|
||
|
|
+ '\n'.join(
|
||
|
|
f'* {host}: [{version}]({self.config["federation_tester"].format(server=host)})'
|
||
|
|
for host, version in versions
|
||
|
|
)
|
||
|
|
)
|
||
|
|
)
|