Regex system

[e-dreyer]

Problem

MastoBot-3D currently implements a reporting system, allowing users to mention the bot as @3dprinting $report <some report message>.

This allows for a custom response to reply to the report with a templating system similar to the proposed one in #7 and also sends a message to the moderators.

This functionality can be extended to allow for more advanced commands to be sent to the bot and is generic enough to be part of MastoBot

Solution

A possinle solution would be to allow users to supply MastoBot with a list of regex expressions and a list of callbacks. Thus allowing the user to implement actions similar to how abstract class methods are currently used to implement custom behavior.

[e-dreyer]

This is how it is currently handled in MastoBot-3D:

def processMention(self, mention: Dict):
        # Get the content from the mention
        content = self.getStatus(mention.get("status")).get("content")

        # Check for report tag
        report_pattern = r"(.*?)(?<!\S)\$report\b\s*(.*)</p>"
        report_match = re.search(report_pattern, content)
        if report_match:
            before_report = report_match.group(1).strip()
            report_message = report_match.group(2).strip()
            logging.info(f"⛔ \t Report message received: {report_message}")

            # Get account
            api_account = self.getAccount(mention.get("account"))
            api_status = self.getStatus(mention.get("status"))

            try:
                file_loader = FileSystemLoader("templates")
                env = Environment(loader=file_loader)
                template = env.get_template("report.txt")

                output = template.render(
                    creator=api_account.get("acct"),
                    reported_post_id=mention.get("status"),
                    reported_post_url=api_status.get("url"),
                    report_message=report_message,
                )
            except Exception as e:
                logging.critical("❗ \t Error initializing template")
                raise e

            try:
                self._api.st(status=output, visibility="direct")
            except Exception as e:
                logging.critical("❗ \t Error posting status message")
                raise e

            ... # implementation continues

A good implementation would be

def applyRegex(regex_expression, content: str) -> Any:
    ...

But looking at the example implementation, multiple strings or a List[AnyStr] can be returned. I am not quite sure what is the best way to return the result of such a feature:

before_report = report_match.group(1).strip()
report_message = report_match.group(2).strip()