Adding lastmatched so patterns can have cooldowns

patterns.md

@@ -51,12 +51,13 @@ The available operators and type of value depends on the field being accessed.
 
 #### Fields
 
-* `content.plain` - The plain text of the message. All markdown formatting is removed, and mentions look like the `@Username` text name that gets displayed.
-* `content.markdown` - The raw markdown of the message. This contains all markdown characters, and mentions are of the `<@!0000000>` form. Available operators: `==`, `!=`, `contains`, `!contains`, `matches`, `!matches`. Comparison value must be a quoted string.
 * `author` - Who sent the message. Available operators: `==`, `!=`. Comparison value must be a user mention (an @ that Discord will tab-complete for you).
 * `author.id` - The numeric ID of the user who sent the message. Available operators: `==`, `!=`. Comparison value must be a numeric user ID.
-* `author.name` - The username of the author. Available operators: `==`, `!=`, `contains`, `!contains`, `containsword`, `!containsword`, `matches`, `!matches`. Comparison value must be a quoted string.
 * `author.joinage` - How much time has elapsed from when the author joined and when the message was sent. If the user has joined and left multiple times this is the most recent join time. Available operators: `==`, `!=`, `<`, `>`, `<=`, `>=`. Comparison value must be a timespan (see below)
+* `author.name` - The username of the author. Available operators: `==`, `!=`, `contains`, `!contains`, `containsword`, `!containsword`, `matches`, `!matches`. Comparison value must be a quoted string.
+* `content.plain` - The plain text of the message. All markdown formatting is removed, and mentions look like the `@Username` text name that gets displayed.
+* `content.markdown` - The raw markdown of the message. This contains all markdown characters, and mentions are of the `<@!0000000>` form. Available operators: `==`, `!=`, `contains`, `!contains`, `matches`, `!matches`. Comparison value must be a quoted string.
+* `lastmatched` - How long ago this pattern matched a message. Used for imposing a cooldown, especially for autoresponses. If the pattern has never matched it will be treated as if it last ran 100 years ago for comparison purposes. Available operators: `==`, `!=`, `<`, `>`, `<=`, `>=`. Comparison value must be a timespan (see below).
 
 #### Operators
 
@@ -139,7 +140,7 @@ $rb_pattern add "lunch" reply "Lunch is at noon." if content.plain == "When is l
 
 `<actions>` ::= `<action>` | `<action>` " " `<actions>`
 
-`<action>` ::= "ban" | "delete" | "kick" | "modwarn" | "reply " `<quoted_string>`
+`<action>` ::= "ban" | "delete" | "kick" | "modinfo" | "modwarn" | "reply " `<quoted_string>`
 
 `<quoted_string>` ::= '"' `<any>` '"'
 
@@ -157,9 +158,9 @@ $rb_pattern add "lunch" reply "Lunch is at noon." if content.plain == "When is l
 
 `<or_expr>` ::= `<expression>` " or " `<expression>`
 
-`<field_name>` ::= "content.plain" | "content.markdown" | "author" | "author.id" | "author.name" | "author.joinage"
+`<field_name>` ::= "author" | "author.id" | "author.joinage" | "author.name" | "content.markdown" | "content.plain" | "lastmatched"
 
-`<op>` ::= "==" | "!=" | "<" | ">" | "<=" | ">=" | "contains" | "!contains" | "matches" | "!matches"
+`<op>` ::= "==" | "!=" | "<" | ">" | "<=" | ">=" | "contains" | "!contains" | "containsword" | "!containsword" | "matches" | "!matches"
 
 `<value>` ::= `<int>` | `<float>` | `<quoted_string>` | `<timespan>` | `<mention>`
 

rocketbot/cogs/patterncog.py

@@ -2,6 +2,7 @@
 Cog for matching messages against guild-configurable criteria and taking
 automated actions on them.
 """
+from datetime import datetime
 from discord import Guild, Member, Message, utils as discordutils
 from discord.ext import commands
 
@@ -62,6 +63,21 @@ class PatternCog(BaseCog, name='Pattern Matching'):
 		to_save: list[dict] = list(map(PatternStatement.to_json, patterns.values()))
 		cls.set_guild_setting(guild, cls.SETTING_PATTERNS, to_save)
 
+	@classmethod
+	def __get_last_matched(cls, guild: Guild, name: str) -> datetime:
+		last_matched: dict[name, datetime] = Storage.get_state_value(guild, 'PatternCog.last_matched')
+		if last_matched:
+			return last_matched.get(name)
+		return None
+
+	@classmethod
+	def __set_last_matched(cls, guild: Guild, name: str, time: datetime) -> None:
+		last_matched: dict[name, datetime] = Storage.get_state_value(guild, 'PatternCog.last_matched')
+		if last_matched is None:
+			last_matched = {}
+			Storage.set_state_value(guild, 'PatternCog.last_matched', last_matched)
+		last_matched[name] = time
+
 	@commands.Cog.listener()
 	async def on_message(self, message: Message) -> None:
 		'Event listener'
@@ -78,7 +94,11 @@ class PatternCog(BaseCog, name='Pattern Matching'):
 
 		patterns = self.__get_patterns(message.guild)
 		for statement in sorted(patterns.values(), key=lambda s : s.priority, reverse=True):
-			if statement.expression.matches(message):
+			other_fields = {
+				'last_matched': self.__get_last_matched(message.guild, statement.name),
+			}
+			if statement.expression.matches(message, other_fields):
+				self.__set_last_matched(message.guild, statement.name, message.created_at)
 				await self.__trigger_actions(message, statement)
 				break
 

rocketbot/pattern.py

@@ -4,6 +4,7 @@ to take on them.
 """
 import re
 from abc import ABCMeta, abstractmethod
+from datetime import datetime
 from typing import Any
 
 from discord import Message, utils as discordutils
@@ -42,9 +43,10 @@ class PatternExpression(metaclass=ABCMeta):
 		pass
 
 	@abstractmethod
-	def matches(self, message: Message) -> bool:
+	def matches(self, message: Message, other_fields: dict[str: Any]) -> bool:
 		"""
-		Whether a message matches this expression.
+		Whether a message matches this expression. other_fields are additional
+		fields that can be queried not contained in the message itself.
 		"""
 		return False
 
@@ -59,7 +61,7 @@ class PatternSimpleExpression(PatternExpression):
 		self.operator = operator
 		self.value = value
 
-	def __field_value(self, message: Message) -> Any:
+	def __field_value(self, message: Message, other_fields: dict[str: Any]) -> Any:
 		if self.field in ('content.markdown', 'content'):
 			return message.content
 		if self.field == 'content.plain':
@@ -72,11 +74,14 @@ class PatternSimpleExpression(PatternExpression):
 			return message.created_at - message.author.joined_at
 		if self.field == 'author.name':
 			return message.author.name
-		else:
-			raise ValueError(f'Bad field name {self.field}')
-
-	def matches(self, message: Message) -> bool:
-		field_value = self.__field_value(message)
+		if self.field == 'lastmatched':
+			long_ago = datetime(year=1900, month=1, day=1, hour=0, minute=0, second=0)
+			last_matched = other_fields.get('last_matched') or long_ago
+			return message.created_at - last_matched
+		raise ValueError(f'Bad field name {self.field}')
+
+	def matches(self, message: Message, other_fields: dict[str, Any]) -> bool:
+		field_value = self.__field_value(message, other_fields)
 		if self.operator == '==':
 			if isinstance(field_value, str) and isinstance(self.value, str):
 				return field_value.lower() == self.value.lower()
@@ -116,17 +121,17 @@ class PatternCompoundExpression(PatternExpression):
 		self.operator = operator
 		self.operands = list(operands)
 
-	def matches(self, message: Message) -> bool:
+	def matches(self, message: Message, other_fields: dict[str, Any]) -> bool:
 		if self.operator == '!':
-			return not self.operands[0].matches(message)
+			return not self.operands[0].matches(message, other_fields)
 		if self.operator == 'and':
 			for op in self.operands:
-				if not op.matches(message):
+				if not op.matches(message, other_fields):
 					return False
 			return True
 		if self.operator == 'or':
 			for op in self.operands:
-				if op.matches(message):
+				if op.matches(message, other_fields):
 					return True
 			return False
 		raise ValueError(f'Bad operator "{self.operator}"')
@@ -208,14 +213,14 @@ class PatternCompiler:
 	TYPE_TIMESPAN = 'timespan'
 
 	FIELD_TO_TYPE: dict[str, str] = {
-		'content.plain': TYPE_TEXT,
-		'content.markdown': TYPE_TEXT,
 		'author': TYPE_MEMBER,
 		'author.id': TYPE_ID,
-		'author.name': TYPE_TEXT,
 		'author.joinage': TYPE_TIMESPAN,
-
+		'author.name': TYPE_TEXT,
 		'content': TYPE_TEXT, # deprecated, use content.markdown or content.plain
+		'content.markdown': TYPE_TEXT,
+		'content.plain': TYPE_TEXT,
+		'lastmatched': TYPE_TIMESPAN,
 	}
 	DEPRECATED_FIELDS: set[str] = set([ 'content' ])