diff --git a/.github/workflows/python-lint.yml b/.github/workflows/python-lint.yml new file mode 100644 index 0000000..ea32a95 --- /dev/null +++ b/.github/workflows/python-lint.yml @@ -0,0 +1,24 @@ +name: Python lint + +on: [push, pull_request] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: "3.11" + - uses: isort/isort-action@master + with: + sortPaths: "./reactbot" + - uses: psf/black@stable + with: + src: "./reactbot" + - name: pre-commit + run: | + pip install pre-commit + pre-commit run -av trailing-whitespace + pre-commit run -av end-of-file-fixer + pre-commit run -av check-added-large-files diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c649b91..7c690ef 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,27 +1,3 @@ -image: dock.mau.dev/maubot/maubot - -stages: -- build - -variables: - PYTHONPATH: /opt/maubot - -build: - stage: build - except: - - tags - script: - - python3 -m maubot.cli build -o xyz.maubot.$CI_PROJECT_NAME-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHORT_SHA.mbp - artifacts: - paths: - - "*.mbp" - -build tags: - stage: build - only: - - tags - script: - - python3 -m maubot.cli build -o xyz.maubot.$CI_PROJECT_NAME-$CI_COMMIT_TAG.mbp - artifacts: - paths: - - "*.mbp" +include: +- project: 'maubot/maubot' + file: '/.gitlab-ci-plugin.yml' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..2d79b6c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: trailing-whitespace + exclude_types: [markdown] + - id: end-of-file-fixer + - id: check-added-large-files + - repo: https://github.com/psf/black + rev: 23.9.1 + hooks: + - id: black + language_version: python3 + files: ^reactbot/.*\.pyi?$ + - repo: https://github.com/PyCQA/isort + rev: 5.12.0 + hooks: + - id: isort + files: ^reactbot/.*\.pyi?$ diff --git a/README.md b/README.md index 049a400..682b881 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ A [maubot](https://github.com/maubot/maubot) that responds to messages that matc and an image response for "alot". * [samples/jesari.yaml](samples/jesari.yaml) contains a replacement for [jesaribot](https://github.com/maubot/jesaribot). * [samples/stallman.yaml](samples/stallman.yaml) contains a Stallman interject bot. +* [samples/random-reaction.yaml](samples/random-reaction.yaml) has an example of + a randomized reaction to matching messages. +* [samples/nitter.yaml](samples/nitter.yaml) has an example of matching tweet links + and responding with a corresponding nitter.net link. +* [samples/thread.yaml](samples/thread.yaml) has an example of replying in a thread. ## Config format ### Templates @@ -15,7 +20,10 @@ Templates contain the actual event type and content to be sent. * `content` - The event content. Either an object or jinja2 template that produces JSON. * `variables` - A key-value map of variables. -Variables are parsed as jinja2 templates and get the maubot event object in `event`. +Variables that start with `{{` are parsed as jinja2 templates and get the +maubot event object in `event`. As of v3, variables are parsed using jinja2's +[native types mode](https://jinja.palletsprojects.com/en/3.1.x/nativetypes/), +which means the output can be a non-string type. If the content is a string, it'll be parsed as a jinja2 template and the output will be parsed as JSON. The content jinja2 template will get `event` just like diff --git a/maubot.yaml b/maubot.yaml index 16d0e3f..13f6a9e 100644 --- a/maubot.yaml +++ b/maubot.yaml @@ -1,6 +1,6 @@ maubot: 0.1.0 id: xyz.maubot.reactbot -version: 2.1.0 +version: 2.2.0 license: AGPL-3.0-or-later modules: - reactbot diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..3e608c9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,11 @@ +[tool.isort] +profile = "black" +force_to_top = "typing" +from_first = true +combine_as_imports = true +known_first_party = ["mautrix", "maubot"] +line_length = 99 + +[tool.black] +line-length = 99 +target-version = ["py38"] diff --git a/reactbot/bot.py b/reactbot/bot.py index b893110..a31fa31 100644 --- a/reactbot/bot.py +++ b/reactbot/bot.py @@ -13,16 +13,15 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from typing import Type, Tuple, Dict +from typing import Dict, Tuple, Type import time from attr import dataclass -from mautrix.types import EventType, MessageType, UserID, RoomID -from mautrix.util.config import BaseProxyConfig - -from maubot import Plugin, MessageEvent +from maubot import MessageEvent, Plugin from maubot.handlers import event +from mautrix.types import EventType, MessageType, RoomID, UserID +from mautrix.util.config import BaseProxyConfig from .config import Config, ConfigError @@ -73,12 +72,15 @@ class ReactBot(Plugin): fi.max = self.config["antispam.room.max"] fi.delay = self.config["antispam.room.delay"] - def _make_flood_info(self, for_type: str) -> 'FloodInfo': - return FloodInfo(max=self.config[f"antispam.{for_type}.max"], - delay=self.config[f"antispam.{for_type}.delay"], - count=0, last_message=0) + def _make_flood_info(self, for_type: str) -> "FloodInfo": + return FloodInfo( + max=self.config[f"antispam.{for_type}.max"], + delay=self.config[f"antispam.{for_type}.delay"], + count=0, + last_message=0, + ) - def _get_flood_info(self, flood_map: dict, key: str, for_type: str) -> 'FloodInfo': + def _get_flood_info(self, flood_map: dict, key: str, for_type: str) -> "FloodInfo": try: return flood_map[key] except KeyError: @@ -86,8 +88,10 @@ class ReactBot(Plugin): return fi def is_flood(self, evt: MessageEvent) -> bool: - return (self._get_flood_info(self.user_flood, evt.sender, "user").bump() - or self._get_flood_info(self.room_flood, evt.room_id, "room").bump()) + return ( + self._get_flood_info(self.user_flood, evt.sender, "user").bump() + or self._get_flood_info(self.room_flood, evt.room_id, "room").bump() + ) @event.on(EventType.ROOM_MESSAGE) async def event_handler(self, evt: MessageEvent) -> None: @@ -101,5 +105,5 @@ class ReactBot(Plugin): try: await rule.execute(evt, match) except Exception: - self.log.exception(f"Failed to execute {name}") + self.log.exception(f"Failed to execute {name} in {evt.room_id}") return diff --git a/reactbot/config.py b/reactbot/config.py index 8cb9ba5..b264a6b 100644 --- a/reactbot/config.py +++ b/reactbot/config.py @@ -13,17 +13,18 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from typing import List, Union, Dict, Any +from typing import Any, Dict, List, Union import re -from jinja2 import Template as JinjaTemplate +from jinja2 import Template as JinjaStringTemplate +from jinja2.nativetypes import NativeTemplate as JinjaNativeTemplate -from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper from mautrix.types import EventType +from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper +from .rule import RPattern, Rule from .simplepattern import SimplePattern from .template import Template -from .rule import Rule, RPattern InputPattern = Union[str, Dict[str, str]] @@ -44,29 +45,36 @@ class Config(BaseProxyConfig): def parse_data(self) -> None: self.default_flags = re.RegexFlag(0) + self.templates = {} + self.rules = {} + self.default_flags = self._get_flags(self["default_flags"]) - self.templates = {name: self._make_template(name, tpl) - for name, tpl in self["templates"].items()} - self.rules = {name: self._make_rule(name, rule) - for name, rule in self["rules"].items()} + self.templates = { + name: self._make_template(name, tpl) for name, tpl in self["templates"].items() + } + self.rules = {name: self._make_rule(name, rule) for name, rule in self["rules"].items()} def _make_rule(self, name: str, rule: Dict[str, Any]) -> Rule: try: - return Rule(rooms=set(rule.get("rooms", [])), - not_rooms=set(rule.get("not_rooms", [])), - matches=self._compile_all(rule["matches"]), - not_matches=self._compile_all(rule.get("not_matches", [])), - type=EventType.find(rule["type"]) if "type" in rule else None, - template=self.templates[rule["template"]], - variables=self._parse_variables(rule)) + return Rule( + rooms=set(rule.get("rooms", [])), + not_rooms=set(rule.get("not_rooms", [])), + matches=self._compile_all(rule["matches"]), + not_matches=self._compile_all(rule.get("not_matches", [])), + type=EventType.find(rule["type"]) if "type" in rule else None, + template=self.templates[rule["template"]], + variables=self._parse_variables(rule), + ) except Exception as e: raise ConfigError(f"Failed to load {name}") from e def _make_template(self, name: str, tpl: Dict[str, Any]) -> Template: try: - return Template(type=EventType.find(tpl.get("type", "m.room.message")), - variables=self._parse_variables(tpl), - content=self._parse_content(tpl.get("content", None))).init() + return Template( + type=EventType.find(tpl.get("type", "m.room.message")), + variables=self._parse_variables(tpl), + content=self._parse_content(tpl.get("content", None)), + ).init() except Exception as e: raise ConfigError(f"Failed to load {name}") from e @@ -89,17 +97,23 @@ class Config(BaseProxyConfig): @staticmethod def _parse_variables(data: Dict[str, Any]) -> Dict[str, Any]: - return {name: (JinjaTemplate(var_tpl) - if isinstance(var_tpl, str) and var_tpl.startswith("{{") - else var_tpl) - for name, var_tpl in data.get("variables", {}).items()} + return { + name: ( + JinjaNativeTemplate(var_tpl) + if isinstance(var_tpl, str) and var_tpl.startswith("{{") + else var_tpl + ) + for name, var_tpl in data.get("variables", {}).items() + } @staticmethod - def _parse_content(content: Union[Dict[str, Any], str]) -> Union[Dict[str, Any], JinjaTemplate]: + def _parse_content( + content: Union[Dict[str, Any], str] + ) -> Union[Dict[str, Any], JinjaStringTemplate]: if not content: return {} elif isinstance(content, str): - return JinjaTemplate(content) + return JinjaStringTemplate(content) return content @staticmethod diff --git a/reactbot/rule.py b/reactbot/rule.py index f7703d2..07e714d 100644 --- a/reactbot/rule.py +++ b/reactbot/rule.py @@ -13,17 +13,15 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from typing import Optional, Match, Dict, List, Set, Union, Pattern, Any +from typing import Any, Dict, List, Match, Optional, Pattern, Set, Union from attr import dataclass -from jinja2 import Template as JinjaTemplate - -from mautrix.types import RoomID, EventType from maubot import MessageEvent +from mautrix.types import EventType, RoomID -from .template import Template from .simplepattern import SimplePattern +from .template import OmitValue, Template RPattern = Union[Pattern, SimplePattern] @@ -59,7 +57,8 @@ class Rule: async def execute(self, evt: MessageEvent, match: Match) -> None: extra_vars = { - **{str(i): val for i, val in enumerate(match.groups())}, + "0": match.group(0), + **{str(i + 1): val for i, val in enumerate(match.groups())}, **match.groupdict(), } content = self.template.execute(evt=evt, rule_vars=self.variables, extra_vars=extra_vars) diff --git a/reactbot/simplepattern.py b/reactbot/simplepattern.py index d9e74e1..e2ed6a3 100644 --- a/reactbot/simplepattern.py +++ b/reactbot/simplepattern.py @@ -1,5 +1,5 @@ # reminder - A maubot plugin that reacts to messages that match predefined rules. -# Copyright (C) 2019 Tulir Asokan +# Copyright (C) 2021 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 @@ -13,54 +13,82 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from typing import Callable, List, Dict, Optional +from typing import Callable, Dict, List, NamedTuple, Optional import re -class BlankMatch: - @staticmethod - def groups() -> List[str]: - return [] +class SimpleMatch(NamedTuple): + value: str - @staticmethod - def groupdict() -> Dict[str, str]: + def groups(self) -> List[str]: + return [self.value] + + def group(self, group: int) -> Optional[str]: + if group == 0: + return self.value + return None + + def groupdict(self) -> Dict[str, str]: return {} -class SimplePattern: - _ptm = BlankMatch() +def matcher_equals(val: str, pattern: str) -> bool: + return val == pattern - matcher: Callable[[str], bool] + +def matcher_startswith(val: str, pattern: str) -> bool: + return val.startswith(pattern) + + +def matcher_endswith(val: str, pattern: str) -> bool: + return val.endswith(pattern) + + +def matcher_contains(val: str, pattern: str) -> bool: + return pattern in val + + +SimpleMatcherFunc = Callable[[str, str], bool] + + +class SimplePattern: + matcher: SimpleMatcherFunc + pattern: str ignorecase: bool - def __init__(self, matcher: Callable[[str], bool], ignorecase: bool) -> None: + def __init__(self, matcher: SimpleMatcherFunc, pattern: str, ignorecase: bool) -> None: self.matcher = matcher + self.pattern = pattern self.ignorecase = ignorecase - def search(self, val: str) -> BlankMatch: + def search(self, val: str) -> SimpleMatch: if self.ignorecase: val = val.lower() - if self.matcher(val): - return self._ptm + if self.matcher(val, self.pattern): + return SimpleMatch(self.pattern) @staticmethod - def compile(pattern: str, flags: re.RegexFlag = re.RegexFlag(0), force_raw: bool = False - ) -> Optional['SimplePattern']: + def compile( + pattern: str, flags: re.RegexFlag = re.RegexFlag(0), force_raw: bool = False + ) -> Optional["SimplePattern"]: ignorecase = flags == re.IGNORECASE s_pattern = pattern.lower() if ignorecase else pattern esc = "" if not force_raw: esc = re.escape(pattern) first, last = pattern[0], pattern[-1] - if first == '^' and last == '$' and (force_raw or esc == f"\\^{pattern[1:-1]}\\$"): + if first == "^" and last == "$" and (force_raw or esc == f"\\^{pattern[1:-1]}\\$"): s_pattern = s_pattern[1:-1] - return SimplePattern(lambda val: val == s_pattern, ignorecase=ignorecase) - elif first == '^' and (force_raw or esc == f"\\^{pattern[1:]}"): + func = matcher_equals + elif first == "^" and (force_raw or esc == f"\\^{pattern[1:]}"): s_pattern = s_pattern[1:] - return SimplePattern(lambda val: val.startswith(s_pattern), ignorecase=ignorecase) - elif last == '$' and (force_raw or esc == f"{pattern[:-1]}\\$"): + func = matcher_startswith + elif last == "$" and (force_raw or esc == f"{pattern[:-1]}\\$"): s_pattern = s_pattern[:-1] - return SimplePattern(lambda val: val.endswith(s_pattern), ignorecase=ignorecase) + func = matcher_endswith elif force_raw or esc == pattern: - return SimplePattern(lambda val: s_pattern in val, ignorecase=ignorecase) - return None + func = matcher_contains + else: + # Not a simple pattern + return None + return SimplePattern(matcher=func, pattern=s_pattern, ignorecase=ignorecase) diff --git a/reactbot/template.py b/reactbot/template.py index 13ee593..8ab96a5 100644 --- a/reactbot/template.py +++ b/reactbot/template.py @@ -1,5 +1,5 @@ # reminder - A maubot plugin that reacts to messages that match predefined rules. -# Copyright (C) 2019 Tulir Asokan +# Copyright (C) 2021 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 @@ -13,16 +13,17 @@ # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from typing import Union, Dict, List, Tuple, Any +from typing import Any, Dict, List, Tuple, Union from itertools import chain -import json import copy +import json import re from attr import dataclass -from jinja2 import Template as JinjaTemplate +from jinja2 import Template as JinjaStringTemplate +from jinja2.nativetypes import Template as JinjaNativeTemplate -from mautrix.types import EventType, Event +from mautrix.types import Event, EventType class Key(str): @@ -30,6 +31,11 @@ class Key(str): variable_regex = re.compile(r"\$\${([0-9A-Za-z-_]+)}") +OmitValue = object() + +global_vars = { + "omit": OmitValue, +} Index = Union[str, int, Key] @@ -38,11 +44,11 @@ Index = Union[str, int, Key] class Template: type: EventType variables: Dict[str, Any] - content: Union[Dict[str, Any], JinjaTemplate] + content: Union[Dict[str, Any], JinjaStringTemplate] _variable_locations: List[Tuple[Index, ...]] = None - def init(self) -> 'Template': + def init(self) -> "Template": self._variable_locations = [] self._map_variable_locations((), self.content) return self @@ -68,23 +74,29 @@ class Template: @staticmethod def _replace_variables(tpl: str, variables: Dict[str, Any]) -> str: - for match in variable_regex.finditer(tpl): - val = variables[match.group(1)] - if match.start() == 0 and match.end() == len(tpl): - # Whole field is a single variable, just return the value to allow non-string types. - return val - tpl = tpl[:match.start()] + val + tpl[match.end():] - return tpl + full_var_match = variable_regex.fullmatch(tpl) + if full_var_match: + # Whole field is a single variable, just return the value to allow non-string types. + return variables[full_var_match.group(1)] + return variable_regex.sub(lambda match: str(variables[match.group(1)]), tpl) - def execute(self, evt: Event, rule_vars: Dict[str, Any], extra_vars: Dict[str, str] - ) -> Dict[str, Any]: + def execute( + self, evt: Event, rule_vars: Dict[str, Any], extra_vars: Dict[str, str] + ) -> Dict[str, Any]: variables = extra_vars for name, template in chain(rule_vars.items(), self.variables.items()): - if isinstance(template, JinjaTemplate): - variables[name] = template.render(event=evt, variables=variables) + if isinstance(template, JinjaNativeTemplate): + rendered_var = template.render(event=evt, variables=variables, **global_vars) + if ( + not isinstance(rendered_var, (str, int, list, tuple, dict, bool)) + and rendered_var is not None + and rendered_var is not OmitValue + ): + rendered_var = str(rendered_var) + variables[name] = rendered_var else: variables[name] = template - if isinstance(self.content, JinjaTemplate): + if isinstance(self.content, JinjaStringTemplate): raw_json = self.content.render(event=evt, **variables) return json.loads(raw_json) content = copy.deepcopy(self.content) @@ -95,5 +107,9 @@ class Template: key = str(key) data[self._replace_variables(key, variables)] = data.pop(key) else: - data[key] = self._replace_variables(data[key], variables) + replaced_data = self._replace_variables(data[key], variables) + if replaced_data is OmitValue: + del data[key] + else: + data[key] = replaced_data return content diff --git a/samples/nitter.yaml b/samples/nitter.yaml new file mode 100644 index 0000000..3cfb856 --- /dev/null +++ b/samples/nitter.yaml @@ -0,0 +1,15 @@ +templates: + nitter: + type: m.room.message + content: + msgtype: m.text + body: https://nitter.net/$${1}/status/$${2} + +default_flags: +- ignorecase + +rules: + twitter: + matches: + - https://twitter.com/(.+?)/status/(\d+) + template: nitter diff --git a/samples/random-reaction.yaml b/samples/random-reaction.yaml new file mode 100644 index 0000000..4784bef --- /dev/null +++ b/samples/random-reaction.yaml @@ -0,0 +1,25 @@ +templates: + random_reaction: + type: m.reaction + variables: + react_to_event: '{{event.event_id}}' + reaction: '{{ variables.reaction_choices | random }}' + content: + m.relates_to: + rel_type: m.annotation + event_id: $${react_to_event} + key: $${reaction} + +default_flags: +- ignorecase + +rules: + random: + matches: + - hmm + template: random_reaction + variables: + reaction_choices: + - 🤔 + - 🧐 + - 🤨 diff --git a/samples/stallman.yaml b/samples/stallman.yaml index 6ec3c3d..c97c5d8 100644 --- a/samples/stallman.yaml +++ b/samples/stallman.yaml @@ -419,4 +419,3 @@ rules: Under the US legal system, copyright infringement is not theft. Laws about theft are not applicable to copyright infringement. The supporters of repressive copyright are making an appeal to authority—and misrepresenting what authority says. Unauthorized copying is forbidden by copyright law in many circumstances (not all!), but being forbidden doesn't make it wrong. In general, laws don't define right and wrong. Laws, at their best, attempt to implement justice. If the laws (the implementation) don't fit our ideas of right and wrong (the spec), the laws are what should change. In addition, a US judge, presiding over a trial for copyright infringement, recognized that “piracy” and “theft” are smear-words. - diff --git a/samples/thread.yaml b/samples/thread.yaml new file mode 100644 index 0000000..b963332 --- /dev/null +++ b/samples/thread.yaml @@ -0,0 +1,50 @@ +templates: + always_in_thread: + type: m.room.message + variables: + thread_parent: '{{event.content.get_thread_parent() or event.event_id}}' + event_id: '{{event.event_id}}' + content: + msgtype: m.text + body: $${text} + m.relates_to: + rel_type: m.thread + event_id: $${thread_parent} + is_falling_back: true + m.in_reply_to: + event_id: $${event_id} + # Reply in thread if the message is already in a thread, otherwise use a normal reply. + # This currently requires using a jinja template as the content instead of a normal yaml map. + thread_or_reply: + type: m.room.message + variables: + relates_to: | + {{ + {"rel_type": "m.thread", "event_id": event.content.get_thread_parent(), "is_falling_back": True, "m.in_reply_to": {"event_id": event.event_id}} + if event.content.get_thread_parent() + else {"m.in_reply_to": {"event_id": event.event_id}} + }} + content: + msgtype: m.text + body: $${text} + m.relates_to: $${relates_to} + +antispam: + room: + max: 60 + delay: 60 + user: + max: 60 + delay: 60 + +rules: + thread: + matches: [^!thread$] + template: always_in_thread + variables: + text: meow 3:< + maybe_thread: + matches: [^!thread --maybe$] + template: thread_or_reply + variables: + text: meow >:3