// Copyright 2022 The Matrix.org Foundation C.I.C. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use std::collections::BTreeMap; use anyhow::{Context, Error}; use lazy_static::lazy_static; use log::warn; use pyo3::prelude::*; use regex::Regex; use super::{ utils::{get_glob_matcher, get_localpart_from_id, GlobMatchType}, Action, Condition, EventMatchCondition, FilteredPushRules, KnownCondition, }; lazy_static! { /// Used to parse the `is` clause in the room member count condition. static ref INEQUALITY_EXPR: Regex = Regex::new(r"^([=<>]*)([0-9]+)$").expect("valid regex"); } /// Allows running a set of push rules against a particular event. #[pyclass] pub struct PushRuleEvaluator { /// A mapping of "flattened" keys to string values in the event, e.g. /// includes things like "type" and "content.msgtype". flattened_keys: BTreeMap, /// The "content.body", if any. body: String, /// The number of users in the room. room_member_count: u64, /// The `notifications` section of the current power levels in the room. notification_power_levels: BTreeMap, /// The power level of the sender of the event, or None if event is an /// outlier. sender_power_level: Option, } #[pymethods] impl PushRuleEvaluator { /// Create a new `PushRuleEvaluator`. See struct docstring for details. #[new] pub fn py_new( flattened_keys: BTreeMap, room_member_count: u64, sender_power_level: Option, notification_power_levels: BTreeMap, ) -> Result { let body = flattened_keys .get("content.body") .cloned() .unwrap_or_default(); Ok(PushRuleEvaluator { flattened_keys, body, room_member_count, notification_power_levels, sender_power_level, }) } /// Run the evaluator with the given push rules, for the given user ID and /// display name of the user. /// /// Passing in None will skip evaluating rules matching user ID and display /// name. /// /// Returns the set of actions, if any, that match (filtering out any /// `dont_notify` actions). pub fn run( &self, push_rules: &FilteredPushRules, user_id: Option<&str>, display_name: Option<&str>, ) -> Vec { 'outer: for (push_rule, enabled) in push_rules.iter() { if !enabled { continue; } for condition in push_rule.conditions.iter() { match self.match_condition(condition, user_id, display_name) { Ok(true) => {} Ok(false) => continue 'outer, Err(err) => { warn!("Condition match failed {err}"); continue 'outer; } } } let actions = push_rule .actions .iter() // Filter out "dont_notify" actions, as we don't store them. .filter(|a| **a != Action::DontNotify) .cloned() .collect(); return actions; } Vec::new() } /// Check if the given condition matches. fn matches( &self, condition: Condition, user_id: Option<&str>, display_name: Option<&str>, ) -> bool { match self.match_condition(&condition, user_id, display_name) { Ok(true) => true, Ok(false) => false, Err(err) => { warn!("Condition match failed {err}"); false } } } } impl PushRuleEvaluator { /// Match a given `Condition` for a push rule. pub fn match_condition( &self, condition: &Condition, user_id: Option<&str>, display_name: Option<&str>, ) -> Result { let known_condition = match condition { Condition::Known(known) => known, Condition::Unknown(_) => { return Ok(false); } }; let result = match known_condition { KnownCondition::EventMatch(event_match) => { self.match_event_match(event_match, user_id)? } KnownCondition::ContainsDisplayName => { if let Some(dn) = display_name { if !dn.is_empty() { get_glob_matcher(dn, GlobMatchType::Word)?.is_match(&self.body)? } else { // We specifically ignore empty display names, as otherwise // they would always match. false } } else { false } } KnownCondition::RoomMemberCount { is } => { if let Some(is) = is { self.match_member_count(is)? } else { false } } KnownCondition::SenderNotificationPermission { key } => { if let Some(sender_power_level) = &self.sender_power_level { let required_level = self .notification_power_levels .get(key.as_ref()) .copied() .unwrap_or(50); *sender_power_level >= required_level } else { false } } }; Ok(result) } /// Evaluates a `event_match` condition. fn match_event_match( &self, event_match: &EventMatchCondition, user_id: Option<&str>, ) -> Result { let pattern = if let Some(pattern) = &event_match.pattern { pattern } else if let Some(pattern_type) = &event_match.pattern_type { // The `pattern_type` can either be "user_id" or "user_localpart", // either way if we don't have a `user_id` then the condition can't // match. let user_id = if let Some(user_id) = user_id { user_id } else { return Ok(false); }; match &**pattern_type { "user_id" => user_id, "user_localpart" => get_localpart_from_id(user_id)?, _ => return Ok(false), } } else { return Ok(false); }; let haystack = if let Some(haystack) = self.flattened_keys.get(&*event_match.key) { haystack } else { return Ok(false); }; // For the content.body we match against "words", but for everything // else we match against the entire value. let match_type = if event_match.key == "content.body" { GlobMatchType::Word } else { GlobMatchType::Whole }; let mut compiled_pattern = get_glob_matcher(pattern, match_type)?; compiled_pattern.is_match(haystack) } /// Match the member count against an 'is' condition /// The `is` condition can be things like '>2', '==3' or even just '4'. fn match_member_count(&self, is: &str) -> Result { let captures = INEQUALITY_EXPR.captures(is).context("bad 'is' clause")?; let ineq = captures.get(1).map_or("==", |m| m.as_str()); let rhs: u64 = captures .get(2) .context("missing number")? .as_str() .parse()?; let matches = match ineq { "" | "==" => self.room_member_count == rhs, "<" => self.room_member_count < rhs, ">" => self.room_member_count > rhs, ">=" => self.room_member_count >= rhs, "<=" => self.room_member_count <= rhs, _ => false, }; Ok(matches) } } #[test] fn push_rule_evaluator() { let mut flattened_keys = BTreeMap::new(); flattened_keys.insert("content.body".to_string(), "foo bar bob hello".to_string()); let evaluator = PushRuleEvaluator::py_new(flattened_keys, 10, Some(0), BTreeMap::new()).unwrap(); let result = evaluator.run(&FilteredPushRules::default(), None, Some("bob")); assert_eq!(result.len(), 3); }