1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
///! Constructors for [predefined push rules].
///!
///! [predefined push rules]: https://matrix.org/docs/spec/client_server/r0.6.1#predefined-rules
use indexmap::indexset;
use ruma_identifiers::UserId;
use super::{
Action::*, ConditionalPushRule, PatternedPushRule, PushCondition::*, RoomMemberCountIs,
Ruleset, Tweak,
};
impl Ruleset {
/// The list of all [predefined push rules].
///
/// [predefined push rules]: https://matrix.org/docs/spec/client_server/r0.6.1#predefined-rules
///
/// # Parameters
///
/// - `user_id`: the user for which to generate the default rules. Some rules depend on the
/// user's ID (for instance those to send notifications when they are mentioned).
pub fn server_default(user_id: &UserId) -> Self {
Self {
content: indexset![PatternedPushRule::contains_user_name(user_id)],
#[cfg(feature = "unstable-pre-spec")]
override_: indexset![
ConditionalPushRule::master(),
ConditionalPushRule::suppress_notices(),
ConditionalPushRule::invite_for_me(user_id),
ConditionalPushRule::member_event(),
ConditionalPushRule::contains_display_name(),
ConditionalPushRule::tombstone(),
ConditionalPushRule::roomnotif(),
ConditionalPushRule::reaction(),
],
#[cfg(not(feature = "unstable-pre-spec"))]
override_: indexset![
ConditionalPushRule::master(),
ConditionalPushRule::suppress_notices(),
ConditionalPushRule::invite_for_me(user_id),
ConditionalPushRule::member_event(),
ConditionalPushRule::contains_display_name(),
ConditionalPushRule::tombstone(),
ConditionalPushRule::roomnotif(),
],
underride: indexset![
ConditionalPushRule::call(),
ConditionalPushRule::encrypted_room_one_to_one(),
ConditionalPushRule::room_one_to_one(),
ConditionalPushRule::message(),
ConditionalPushRule::encrypted(),
],
..Default::default()
}
}
}
/// Default override push rules
impl ConditionalPushRule {
/// Matches all events, this can be enabled to turn off all push notifications other than those
/// generated by override rules set by the user.
pub fn master() -> Self {
Self {
actions: vec![DontNotify],
default: true,
enabled: false,
rule_id: ".m.rule.master".into(),
conditions: vec![],
}
}
/// Matches messages with a `msgtype` of `notice`.
pub fn suppress_notices() -> Self {
Self {
actions: vec![DontNotify],
default: true,
enabled: true,
rule_id: ".m.rule.suppress_notices".into(),
conditions: vec![EventMatch {
key: "content.msgtype".into(),
pattern: "m.notice".into(),
}],
}
}
/// Matches any invites to a new room for this user.
pub fn invite_for_me(user_id: &UserId) -> Self {
Self {
actions: vec![
Notify,
SetTweak(Tweak::Sound("default".into())),
SetTweak(Tweak::Highlight(false)),
],
default: true,
enabled: true,
rule_id: ".m.rule.invite_for_me".into(),
conditions: vec![
EventMatch { key: "type".into(), pattern: "m.room.member".into() },
EventMatch { key: "content.membership".into(), pattern: "invite".into() },
EventMatch { key: "state_key".into(), pattern: user_id.to_string() },
],
}
}
/// Matches any `m.room.member_event`.
pub fn member_event() -> Self {
Self {
actions: vec![DontNotify],
default: true,
enabled: true,
rule_id: ".m.rule.member_event".into(),
conditions: vec![EventMatch { key: "type".into(), pattern: "m.room.member".into() }],
}
}
/// Matches any message whose content is unencrypted and contains the user's current display
/// name in the room in which it was sent.
pub fn contains_display_name() -> Self {
Self {
actions: vec![
Notify,
SetTweak(Tweak::Sound("default".into())),
SetTweak(Tweak::Highlight(true)),
],
default: true,
enabled: true,
rule_id: ".m.rule.contains_display_name".into(),
conditions: vec![ContainsDisplayName],
}
}
/// Matches any state event whose type is `m.room.tombstone`. This
/// is intended to notify users of a room when it is upgraded,
/// similar to what an `@room` notification would accomplish.
pub fn tombstone() -> Self {
Self {
actions: vec![Notify, SetTweak(Tweak::Highlight(true))],
default: true,
enabled: false,
rule_id: ".m.rule.tombstone".into(),
conditions: vec![
EventMatch { key: "type".into(), pattern: "m.room.tombstone".into() },
EventMatch { key: "state_key".into(), pattern: "".into() },
],
}
}
/// Matches any message whose content is unencrypted and contains the text `@room`, signifying
/// the whole room should be notified of the event.
pub fn roomnotif() -> Self {
Self {
actions: vec![Notify, SetTweak(Tweak::Highlight(true))],
default: true,
enabled: true,
rule_id: ".m.rule.roomnotif".into(),
conditions: vec![
EventMatch { key: "content.body".into(), pattern: "@room".into() },
SenderNotificationPermission { key: "room".into() },
],
}
}
/// Matches emoji reactions to a message
/// MSC2677: Annotations and Reactions
#[cfg(feature = "unstable-pre-spec")]
#[cfg_attr(docsrs, doc(cfg(feature = "unstable-pre-spec")))]
pub fn reaction() -> Self {
Self {
actions: vec![DontNotify],
default: true,
enabled: true,
rule_id: ".m.rule.reaction".into(),
conditions: vec![EventMatch { key: "type".into(), pattern: "m.reaction".into() }],
}
}
}
/// Default content push rules
impl PatternedPushRule {
/// Matches any message whose content is unencrypted and contains the local part of the user's
/// Matrix ID, separated by word boundaries.
pub fn contains_user_name(user_id: &UserId) -> Self {
Self {
rule_id: ".m.rules.contains_user_name".into(),
enabled: true,
default: true,
pattern: user_id.localpart().into(),
actions: vec![
Notify,
SetTweak(Tweak::Sound("default".into())),
SetTweak(Tweak::Highlight(true)),
],
}
}
}
/// Default underrides push rules
impl ConditionalPushRule {
/// Matches any incoming VOIP call.
pub fn call() -> Self {
Self {
rule_id: ".m.rules.call".into(),
default: true,
enabled: true,
conditions: vec![EventMatch { key: "type".into(), pattern: "m.call.invite".into() }],
actions: vec![
Notify,
SetTweak(Tweak::Sound("ring".into())),
SetTweak(Tweak::Highlight(false)),
],
}
}
/// Matches any encrypted event sent in a room with exactly two members. Unlike other push
/// rules, this rule cannot be matched against the content of the event by nature of it being
/// encrypted. This causes the rule to be an "all or nothing" match where it either matches all
/// events that are encrypted (in 1:1 rooms) or none.
pub fn encrypted_room_one_to_one() -> Self {
Self {
rule_id: ".m.rules.encrypted_room_one_to_one".into(),
default: true,
enabled: true,
conditions: vec![
RoomMemberCount { is: RoomMemberCountIs::from(js_int::uint!(2)) },
EventMatch { key: "type".into(), pattern: "m.room.encrypted".into() },
],
actions: vec![
Notify,
SetTweak(Tweak::Sound("default".into())),
SetTweak(Tweak::Highlight(false)),
],
}
}
/// Matches any message sent in a room with exactly two members.
pub fn room_one_to_one() -> Self {
Self {
rule_id: ".m.rules.room_one_to_one".into(),
default: true,
enabled: true,
conditions: vec![
RoomMemberCount { is: RoomMemberCountIs::from(js_int::uint!(2)) },
EventMatch { key: "type".into(), pattern: "m.room.message".into() },
],
actions: vec![
Notify,
SetTweak(Tweak::Sound("default".into())),
SetTweak(Tweak::Highlight(false)),
],
}
}
/// Matches all chat messages.
pub fn message() -> Self {
Self {
rule_id: ".m.rules.message".into(),
default: true,
enabled: true,
conditions: vec![EventMatch { key: "type".into(), pattern: "m.room.message".into() }],
actions: vec![Notify, SetTweak(Tweak::Highlight(false))],
}
}
/// Matches all encrypted events. Unlike other push rules, this rule cannot be matched against
/// the content of the event by nature of it being encrypted. This causes the rule to be an
/// "all or nothing" match where it either matches all events that are encrypted (in group
/// rooms) or none.
pub fn encrypted() -> Self {
Self {
rule_id: ".m.rules.encrypted".into(),
default: true,
enabled: true,
conditions: vec![EventMatch { key: "type".into(), pattern: "m.room.encrypted".into() }],
actions: vec![Notify, SetTweak(Tweak::Highlight(false))],
}
}
}