# reminder - A maubot plugin that reacts to messages that match predefined rules. # Copyright (C) 2019 Tulir Asokan # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . from typing import NewType, Optional, Pattern, Match, Union, Dict, List, Tuple, Set, Type, Any from itertools import chain import copy import re from attr import dataclass from jinja2 import Template as JinjaTemplate from mautrix.types import RoomID, EventType, Event from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper from maubot import Plugin, MessageEvent from maubot.handlers import event class Config(BaseProxyConfig): def do_update(self, helper: ConfigUpdateHelper) -> None: helper.copy("rules") helper.copy("templates") class Key(str): pass Index = NewType("Index", Union[str, int, Key]) variable_regex = re.compile(r"\$\${([0-9A-Za-z-_]+)}") @dataclass class Template: type: EventType variables: Dict[str, JinjaTemplate] content: Dict[str, Any] _variable_locations: List[Tuple[Index, ...]] = None def init(self) -> 'Template': self._variable_locations = [] self._map_variable_locations((), self.content) return self def _map_variable_locations(self, path: Tuple[Index, ...], data: Any) -> None: if isinstance(data, list): for i, v in enumerate(data): self._map_variable_locations((*path, i), v) elif isinstance(data, dict): for k, v in data.items(): if variable_regex.match(k): self._variable_locations.append((*path, Key(k))) self._map_variable_locations((*path, k), v) elif isinstance(data, str): if variable_regex.match(data): self._variable_locations.append(path) @classmethod def _recurse(cls, content: Any, path: Tuple[Index, ...]) -> Any: if len(path) == 0: return content return cls._recurse(content[path[0]], path[1:]) @staticmethod def _replace_variables(tpl: str, variables: Dict[str, Any]) -> str: for match in variable_regex.finditer(tpl): val = variables[match.group(1)] tpl = tpl[:match.start()] + val + tpl[match.end():] return tpl def execute(self, evt: Event, rule_vars: Dict[str, JinjaTemplate], extra_vars: Dict[str, str] ) -> Dict[str, Any]: variables = {**{name: template.render(event=evt) for name, template in chain(self.variables.items(), rule_vars.items())}, **extra_vars} content = copy.deepcopy(self.content) for path in self._variable_locations: data: Dict[str, Any] = self._recurse(content, path[:1]) key = path[-1] if isinstance(key, Key): key = str(key) data[self._replace_variables(key, variables)] = data.pop(key) else: data[key] = self._replace_variables(data[key], variables) return content @dataclass class Rule: rooms: Set[RoomID] matches: List[Pattern] template: Template type: Optional[EventType] variables: Dict[str, JinjaTemplate] def match(self, evt: MessageEvent) -> Optional[Match]: if len(self.rooms) > 0 and evt.room_id not in self.rooms: return None for pattern in self.matches: match = pattern.search(evt.content.body) if match: return match return None async def execute(self, evt: MessageEvent, match: Match) -> None: content = self.template.execute(evt=evt, rule_vars=self.variables, extra_vars={str(i): val for i, val in enumerate(match.groups())}) await evt.client.send_message_event(evt.room_id, self.type or self.template.type, content) class ReactBot(Plugin): rules: Dict[str, Rule] templates: Dict[str, Template] @classmethod def get_config_class(cls) -> Type[BaseProxyConfig]: return Config async def start(self) -> None: await super().start() self.rules = {} self.templates = {} self.on_external_config_update() @staticmethod def _parse_variables(data: Dict[str, Any]) -> Dict[str, JinjaTemplate]: return {name: JinjaTemplate(var_tpl) for name, var_tpl in data.get("variables", {}).items()} def _make_template(self, tpl: Dict[str, Any]) -> Template: return Template(type=EventType.find(tpl.get("type", "m.room.message")), variables=self._parse_variables(tpl), content=tpl.get("content", {})).init() def _make_rule(self, rule: Dict[str, Any]) -> Rule: return Rule(rooms=set(rule.get("rooms", [])), matches=[re.compile(match) for match in rule.get("matches")], type=EventType.find(rule["type"]) if "type" in rule else None, template=self.templates[rule["template"]], variables=self._parse_variables(rule)) def on_external_config_update(self) -> None: self.config.load_and_update() self.templates = {name: self._make_template(tpl) for name, tpl in self.config["templates"].items()} self.rules = {name: self._make_rule(rule) for name, rule in self.config["rules"].items()} @event.on(EventType.ROOM_MESSAGE) async def event_handler(self, evt: MessageEvent) -> None: if evt.sender == self.client.mxid: return for name, rule in self.rules.items(): match = rule.match(evt) if match is not None: try: await rule.execute(evt, match) except Exception: self.log.exception(f"Failed to execute {name}") return