mirror of
https://github.com/element-hq/synapse.git
synced 2026-11-11 16:37:42 +00:00
Johannes Marbach
c54fd437e3
As suggested in https://github.com/matrix-org/matrix-spec-proposals/pull/4075#discussion_r4288130493.
912 lines
36 KiB
Rust
912 lines
36 KiB
Rust
/*
|
|
* This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
*
|
|
* Copyright 2022, 2023 The Matrix.org Foundation C.I.C.
|
|
* Copyright (C) 2023 New Vector, Ltd
|
|
*
|
|
* 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.
|
|
*
|
|
* See the GNU Affero General Public License for more details:
|
|
* <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
*
|
|
* Originally licensed under the Apache License, Version 2.0:
|
|
* <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
*
|
|
* [This file includes modifications made by New Vector Limited]
|
|
*
|
|
*/
|
|
|
|
//! Contains the definitions of the "base" push rules.
|
|
|
|
use std::borrow::Cow;
|
|
use std::collections::HashMap;
|
|
|
|
use lazy_static::lazy_static;
|
|
use serde_json::Value;
|
|
|
|
use super::KnownCondition;
|
|
use crate::push::RelatedEventMatchTypeCondition;
|
|
use crate::push::SetTweak;
|
|
use crate::push::TweakValue;
|
|
use crate::push::{Action, EventPropertyIsCondition, SimpleJsonValue};
|
|
use crate::push::{Condition, EventMatchTypeCondition};
|
|
use crate::push::{EventMatchCondition, EventMatchPatternType};
|
|
use crate::push::{EventPropertyIsTypeCondition, PushRule};
|
|
|
|
const HIGHLIGHT_ACTION: Action = Action::SetTweak(SetTweak {
|
|
set_tweak: Cow::Borrowed("highlight"),
|
|
value: None,
|
|
other_keys: Value::Null,
|
|
});
|
|
|
|
const HIGHLIGHT_FALSE_ACTION: Action = Action::SetTweak(SetTweak {
|
|
set_tweak: Cow::Borrowed("highlight"),
|
|
value: Some(TweakValue::Other(Value::Bool(false))),
|
|
other_keys: Value::Null,
|
|
});
|
|
|
|
const SOUND_ACTION: Action = Action::SetTweak(SetTweak {
|
|
set_tweak: Cow::Borrowed("sound"),
|
|
value: Some(TweakValue::String(Cow::Borrowed("default"))),
|
|
other_keys: Value::Null,
|
|
});
|
|
|
|
const RING_ACTION: Action = Action::SetTweak(SetTweak {
|
|
set_tweak: Cow::Borrowed("sound"),
|
|
value: Some(TweakValue::String(Cow::Borrowed("ring"))),
|
|
other_keys: Value::Null,
|
|
});
|
|
|
|
pub const BASE_PREPEND_OVERRIDE_RULES: &[PushRule] = &[PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.master"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: false,
|
|
}];
|
|
|
|
pub const BASE_APPEND_OVERRIDE_RULES: &[PushRule] = &[
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.org.matrix.msc4028.encrypted_event"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.encrypted"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.suppress_notices"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("content.msgtype"),
|
|
pattern: Cow::Borrowed("m.notice"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.invite_for_me"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.member"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("content.membership"),
|
|
pattern: Cow::Borrowed("invite"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatchType(EventMatchTypeCondition {
|
|
key: Cow::Borrowed("state_key"),
|
|
pattern_type: Cow::Borrowed(&EventMatchPatternType::UserId),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.member_event"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.member"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.im.nheko.msc3664.reply"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::RelatedEventMatchType(
|
|
RelatedEventMatchTypeCondition {
|
|
key: Cow::Borrowed("sender"),
|
|
pattern_type: Cow::Borrowed(&EventMatchPatternType::UserId),
|
|
rel_type: Cow::Borrowed("m.in_reply_to"),
|
|
include_fallbacks: None,
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.org.matrix.msc4075.rule.rtc.invite_for_me"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventPropertyIs(EventPropertyIsCondition {
|
|
key: Cow::Borrowed("type"),
|
|
value: Cow::Owned(SimpleJsonValue::Str(Cow::Borrowed(
|
|
"org.matrix.msc4075.rtc.notification",
|
|
))),
|
|
})),
|
|
Condition::Known(KnownCondition::ExactEventPropertyContainsType(
|
|
EventPropertyIsTypeCondition {
|
|
key: Cow::Borrowed(r"content.m\.mentions.user_ids"),
|
|
value_type: Cow::Borrowed(&EventMatchPatternType::UserId),
|
|
},
|
|
)),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, RING_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.org.matrix.msc4075.rule.rtc.invite_for_room"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventPropertyIs(EventPropertyIsCondition {
|
|
key: Cow::Borrowed("type"),
|
|
value: Cow::Owned(SimpleJsonValue::Str(Cow::Borrowed(
|
|
"org.matrix.msc4075.rtc.notification",
|
|
))),
|
|
})),
|
|
Condition::Known(KnownCondition::EventPropertyIs(EventPropertyIsCondition {
|
|
key: Cow::Borrowed(r"content.m\.mentions.room"),
|
|
value: Cow::Owned(SimpleJsonValue::Bool(true)),
|
|
})),
|
|
Condition::Known(KnownCondition::SenderNotificationPermission {
|
|
key: Cow::Borrowed("room"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, RING_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.is_user_mention"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(
|
|
KnownCondition::ExactEventPropertyContainsType(EventPropertyIsTypeCondition {
|
|
key: Cow::Borrowed(r"content.m\.mentions.user_ids"),
|
|
value_type: Cow::Borrowed(&EventMatchPatternType::UserId),
|
|
}),
|
|
)]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.contains_display_name"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::ContainsDisplayName)]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.is_room_mention"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventPropertyIs(EventPropertyIsCondition {
|
|
key: Cow::Borrowed(r"content.m\.mentions.room"),
|
|
value: Cow::Owned(SimpleJsonValue::Bool(true)),
|
|
})),
|
|
Condition::Known(KnownCondition::SenderNotificationPermission {
|
|
key: Cow::Borrowed("room"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.roomnotif"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::SenderNotificationPermission {
|
|
key: Cow::Borrowed("room"),
|
|
}),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("content.body"),
|
|
pattern: Cow::Borrowed("@room"),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.tombstone"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.tombstone"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("state_key"),
|
|
pattern: Cow::Borrowed(""),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.reaction"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.reaction"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.room.server_acl"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.server_acl"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("state_key"),
|
|
pattern: Cow::Borrowed(""),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
// We don't want to notify on edits *unless* the edit directly mentions a
|
|
// user, which is handled above.
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.m.rule.suppress_edits"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventPropertyIs(
|
|
EventPropertyIsCondition {
|
|
key: Cow::Borrowed(r"content.m\.relates_to.rel_type"),
|
|
value: Cow::Owned(SimpleJsonValue::Str(Cow::Borrowed("m.replace"))),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/override/.org.matrix.msc3930.rule.poll_response"),
|
|
priority_class: 5,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("org.matrix.msc3381.poll.response"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
];
|
|
|
|
pub const BASE_APPEND_CONTENT_RULES: &[PushRule] = &[PushRule {
|
|
rule_id: Cow::Borrowed("global/content/.m.rule.contains_user_name"),
|
|
priority_class: 4,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatchType(
|
|
EventMatchTypeCondition {
|
|
key: Cow::Borrowed("content.body"),
|
|
pattern_type: Cow::Borrowed(&EventMatchPatternType::UserLocalpart),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_ACTION, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
}];
|
|
|
|
pub const BASE_APPEND_POSTCONTENT_RULES: &[PushRule] = &[
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/postcontent/.io.element.msc4306.rule.unsubscribed_thread"),
|
|
priority_class: 6,
|
|
conditions: Cow::Borrowed(&[Condition::Known(
|
|
KnownCondition::Msc4306ThreadSubscription { subscribed: false },
|
|
)]),
|
|
actions: Cow::Borrowed(&[]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/postcontent/.io.element.msc4306.rule.subscribed_thread"),
|
|
priority_class: 6,
|
|
conditions: Cow::Borrowed(&[Condition::Known(
|
|
KnownCondition::Msc4306ThreadSubscription { subscribed: true },
|
|
)]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
];
|
|
|
|
pub const BASE_APPEND_UNDERRIDE_RULES: &[PushRule] = &[
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.m.rule.call"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.call.invite"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify, RING_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.m.rule.encrypted_room_one_to_one"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.encrypted"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.m.rule.room_one_to_one"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.message"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.encrypted_room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.encrypted"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.message.room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.message"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.file.room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.file"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.image.room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.image"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.video.room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.video"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed(
|
|
"global/underride/.org.matrix.msc3933.rule.extensible.audio.room_one_to_one",
|
|
),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("org.matrix.msc1767.audio"),
|
|
})),
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.m.rule.message"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.message"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.m.rule.encrypted"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("m.room.encrypted"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.encrypted"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.encrypted"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.message"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.message"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.file"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.file"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.image"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.image"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.video"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.video"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc1767.rule.extensible.audio"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
// MSC3933: Type changed from template rule - see MSC.
|
|
pattern: Cow::Borrowed("m.audio"),
|
|
})),
|
|
// MSC3933: Add condition on top of template rule - see MSC.
|
|
Condition::Known(KnownCondition::RoomVersionSupports {
|
|
// RoomVersionFeatures::ExtensibleEvents.as_str(), ideally
|
|
feature: Cow::Borrowed("org.matrix.msc3932.extensible_events"),
|
|
}),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.im.vector.jitsi"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("im.vector.modular.widgets"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("content.type"),
|
|
pattern: Cow::Borrowed("jitsi"),
|
|
})),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("state_key"),
|
|
pattern: Cow::Borrowed("*"),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, HIGHLIGHT_FALSE_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc3930.rule.poll_start_one_to_one"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("org.matrix.msc3381.poll.start"),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc3930.rule.poll_start"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("org.matrix.msc3381.poll.start"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc3930.rule.poll_end_one_to_one"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[
|
|
Condition::Known(KnownCondition::RoomMemberCount {
|
|
is: Some(Cow::Borrowed("2")),
|
|
}),
|
|
Condition::Known(KnownCondition::EventMatch(EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("org.matrix.msc3381.poll.end"),
|
|
})),
|
|
]),
|
|
actions: Cow::Borrowed(&[Action::Notify, SOUND_ACTION]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
PushRule {
|
|
rule_id: Cow::Borrowed("global/underride/.org.matrix.msc3930.rule.poll_end"),
|
|
priority_class: 1,
|
|
conditions: Cow::Borrowed(&[Condition::Known(KnownCondition::EventMatch(
|
|
EventMatchCondition {
|
|
key: Cow::Borrowed("type"),
|
|
pattern: Cow::Borrowed("org.matrix.msc3381.poll.end"),
|
|
},
|
|
))]),
|
|
actions: Cow::Borrowed(&[Action::Notify]),
|
|
default: true,
|
|
default_enabled: true,
|
|
},
|
|
];
|
|
|
|
lazy_static! {
|
|
pub static ref BASE_RULES_BY_ID: HashMap<&'static str, &'static PushRule> =
|
|
BASE_PREPEND_OVERRIDE_RULES
|
|
.iter()
|
|
.chain(BASE_APPEND_OVERRIDE_RULES.iter())
|
|
.chain(BASE_APPEND_CONTENT_RULES.iter())
|
|
.chain(BASE_APPEND_POSTCONTENT_RULES.iter())
|
|
.chain(BASE_APPEND_UNDERRIDE_RULES.iter())
|
|
.map(|rule| { (&*rule.rule_id, rule) })
|
|
.collect();
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::borrow::Cow;
|
|
use std::collections::BTreeMap;
|
|
|
|
use super::RING_ACTION;
|
|
use crate::push::evaluator::PushRuleEvaluator;
|
|
use crate::push::{Action, FilteredPushRules, JsonValue, PushRules, SimpleJsonValue};
|
|
|
|
const RTC_NOTIFICATION_TYPE: &str = "org.matrix.msc4075.rtc.notification";
|
|
const ALICE: &str = "@alice:example.org";
|
|
const BOB: &str = "@bob:example.org";
|
|
|
|
/// The default push rules with no user-defined rules.
|
|
///
|
|
/// The generic mention rules are disabled so that they cannot mask the
|
|
/// MSC4075 rules, which have identical actions and come immediately
|
|
/// before them in the override list.
|
|
fn push_rules(msc4075_enabled: bool) -> FilteredPushRules {
|
|
let mut enabled_map = BTreeMap::new();
|
|
enabled_map.insert("global/override/.m.rule.is_user_mention".to_string(), false);
|
|
enabled_map.insert("global/override/.m.rule.is_room_mention".to_string(), false);
|
|
|
|
FilteredPushRules::py_new(
|
|
PushRules::new(vec![]),
|
|
enabled_map,
|
|
false, // msc1767_enabled
|
|
false, // msc3381_polls_enabled
|
|
false, // msc3664_enabled
|
|
false, // msc4028_push_encrypted_events
|
|
msc4075_enabled,
|
|
false, // msc4210_enabled
|
|
false, // msc4306_enabled
|
|
)
|
|
}
|
|
|
|
/// Builds an evaluator for an event of the given type whose `m.mentions`
|
|
/// lists the given user IDs and optionally mentions the room, sent by a
|
|
/// user with the given power level.
|
|
fn build_evaluator(
|
|
event_type: &'static str,
|
|
mentioned_user_ids: &[&'static str],
|
|
mentions_room: bool,
|
|
sender_power_level: i64,
|
|
) -> PushRuleEvaluator {
|
|
let mut flattened_keys = BTreeMap::new();
|
|
flattened_keys.insert(
|
|
"type".to_string(),
|
|
JsonValue::Value(SimpleJsonValue::Str(Cow::Borrowed(event_type))),
|
|
);
|
|
flattened_keys.insert(
|
|
r"content.m\.mentions.user_ids".to_string(),
|
|
JsonValue::Array(
|
|
mentioned_user_ids
|
|
.iter()
|
|
.map(|&user_id| SimpleJsonValue::Str(Cow::Borrowed(user_id)))
|
|
.collect(),
|
|
),
|
|
);
|
|
if mentions_room {
|
|
flattened_keys.insert(
|
|
r"content.m\.mentions.room".to_string(),
|
|
JsonValue::Value(SimpleJsonValue::Bool(true)),
|
|
);
|
|
}
|
|
|
|
PushRuleEvaluator::py_new(
|
|
flattened_keys,
|
|
true,
|
|
10,
|
|
Some(sender_power_level),
|
|
BTreeMap::new(),
|
|
BTreeMap::new(),
|
|
false,
|
|
vec![],
|
|
false,
|
|
false,
|
|
false,
|
|
)
|
|
.unwrap()
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_invite_for_me_notifies_mentioned_user() {
|
|
let evaluator = build_evaluator(RTC_NOTIFICATION_TYPE, &[ALICE], false, 0);
|
|
|
|
let actions = evaluator.run(&push_rules(true), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![Action::Notify, RING_ACTION]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_invite_for_me_ignores_other_users() {
|
|
let evaluator = build_evaluator(RTC_NOTIFICATION_TYPE, &[BOB], false, 0);
|
|
|
|
let actions = evaluator.run(&push_rules(true), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_invite_for_room_notifies_with_permission() {
|
|
// The default `notifications.room` power level is 50.
|
|
let evaluator = build_evaluator(RTC_NOTIFICATION_TYPE, &[], true, 50);
|
|
|
|
let actions = evaluator.run(&push_rules(true), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![Action::Notify, RING_ACTION]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_invite_for_room_requires_permission() {
|
|
let evaluator = build_evaluator(RTC_NOTIFICATION_TYPE, &[], true, 0);
|
|
|
|
let actions = evaluator.run(&push_rules(true), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_rules_ignore_other_event_types() {
|
|
let evaluator = build_evaluator("org.example.other", &[ALICE], true, 50);
|
|
|
|
let actions = evaluator.run(&push_rules(true), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![]);
|
|
}
|
|
|
|
#[test]
|
|
fn test_rtc_rules_are_omitted_when_msc4075_is_disabled() {
|
|
let evaluator = build_evaluator(RTC_NOTIFICATION_TYPE, &[ALICE], true, 50);
|
|
|
|
let actions = evaluator.run(&push_rules(false), Some(ALICE), None, None);
|
|
assert_eq!(actions, vec![]);
|
|
}
|
|
}
|