matrix_sdk_base/
deserialized_responses.rs

1// Copyright 2022 The Matrix.org Foundation C.I.C.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! SDK-specific variations of response types from Ruma.
16
17use std::{collections::BTreeMap, fmt, hash::Hash, iter};
18
19pub use matrix_sdk_common::deserialized_responses::*;
20use once_cell::sync::Lazy;
21use regex::Regex;
22use ruma::{
23    events::{
24        room::{
25            member::{MembershipState, RoomMemberEvent, RoomMemberEventContent},
26            power_levels::{RoomPowerLevels, RoomPowerLevelsEventContent},
27        },
28        AnyStrippedStateEvent, AnySyncStateEvent, AnySyncTimelineEvent, EventContentFromType,
29        PossiblyRedactedStateEventContent, RedactContent, RedactedStateEventContent,
30        StateEventContent, StaticStateEventContent, StrippedStateEvent, SyncStateEvent,
31    },
32    serde::Raw,
33    EventId, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId, OwnedUserId, UInt, UserId,
34};
35use serde::Serialize;
36use unicode_normalization::UnicodeNormalization;
37
38/// A change in ambiguity of room members that an `m.room.member` event
39/// triggers.
40#[derive(Clone, Debug)]
41#[non_exhaustive]
42pub struct AmbiguityChange {
43    /// The user ID of the member that is contained in the state key of the
44    /// `m.room.member` event.
45    pub member_id: OwnedUserId,
46    /// Is the member that is contained in the state key of the `m.room.member`
47    /// event itself ambiguous because of the event.
48    pub member_ambiguous: bool,
49    /// Has another user been disambiguated because of this event.
50    pub disambiguated_member: Option<OwnedUserId>,
51    /// Has another user become ambiguous because of this event.
52    pub ambiguated_member: Option<OwnedUserId>,
53}
54
55impl AmbiguityChange {
56    /// Get an iterator over the user IDs listed in this `AmbiguityChange`.
57    pub fn user_ids(&self) -> impl Iterator<Item = &UserId> {
58        iter::once(&*self.member_id)
59            .chain(self.disambiguated_member.as_deref())
60            .chain(self.ambiguated_member.as_deref())
61    }
62}
63
64/// Collection of ambiguity changes that room member events trigger.
65#[derive(Clone, Debug, Default)]
66#[non_exhaustive]
67pub struct AmbiguityChanges {
68    /// A map from room id to a map of an event id to the `AmbiguityChange` that
69    /// the event with the given id caused.
70    pub changes: BTreeMap<OwnedRoomId, BTreeMap<OwnedEventId, AmbiguityChange>>,
71}
72
73static MXID_REGEX: Lazy<Regex> = Lazy::new(|| {
74    Regex::new(DisplayName::MXID_PATTERN)
75        .expect("We should be able to create a regex from our static MXID pattern")
76});
77static LEFT_TO_RIGHT_REGEX: Lazy<Regex> = Lazy::new(|| {
78    Regex::new(DisplayName::LEFT_TO_RIGHT_PATTERN)
79        .expect("We should be able to create a regex from our static left-to-right pattern")
80});
81static HIDDEN_CHARACTERS_REGEX: Lazy<Regex> = Lazy::new(|| {
82    Regex::new(DisplayName::HIDDEN_CHARACTERS_PATTERN)
83        .expect("We should be able to create a regex from our static hidden characters pattern")
84});
85
86/// Regex to match `i` characters.
87///
88/// This is used to replace an `i` with a lowercase `l`, i.e. to mark "Hello"
89/// and "HeIlo" as ambiguous. Decancer will lowercase an `I` for us.
90static I_REGEX: Lazy<Regex> = Lazy::new(|| {
91    Regex::new("[i]").expect("We should be able to create a regex from our uppercase I pattern")
92});
93
94/// Regex to match `0` characters.
95///
96/// This is used to replace an `0` with a lowercase `o`, i.e. to mark "HellO"
97/// and "Hell0" as ambiguous. Decancer will lowercase an `O` for us.
98static ZERO_REGEX: Lazy<Regex> = Lazy::new(|| {
99    Regex::new("[0]").expect("We should be able to create a regex from our zero pattern")
100});
101
102/// Regex to match a couple of dot-like characters, also matches an actual dot.
103///
104/// This is used to replace a `.` with a `:`, i.e. to mark "@mxid.domain.tld" as
105/// ambiguous.
106static DOT_REGEX: Lazy<Regex> = Lazy::new(|| {
107    Regex::new("[.\u{1d16d}]").expect("We should be able to create a regex from our dot pattern")
108});
109
110/// A high-level wrapper for strings representing display names.
111///
112/// This wrapper provides attempts to determine whether a display name
113/// contains characters that could make it ambiguous or easily confused
114/// with similar names.
115///
116///
117/// # Examples
118///
119/// ```
120/// use matrix_sdk_base::deserialized_responses::DisplayName;
121///
122/// let display_name = DisplayName::new("𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");
123///
124/// // The normalized and sanitized string will be returned by DisplayName.as_normalized_str().
125/// assert_eq!(display_name.as_normalized_str(), Some("sahasrahla"));
126/// ```
127///
128/// ```
129/// # use matrix_sdk_base::deserialized_responses::DisplayName;
130/// let display_name = DisplayName::new("@alice:localhost");
131///
132/// // The display name looks like an MXID, which makes it ambiguous.
133/// assert!(display_name.is_inherently_ambiguous());
134/// ```
135#[derive(Debug, Clone, Eq)]
136pub struct DisplayName {
137    raw: String,
138    decancered: Option<String>,
139}
140
141impl Hash for DisplayName {
142    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
143        if let Some(decancered) = &self.decancered {
144            decancered.hash(state);
145        } else {
146            self.raw.hash(state);
147        }
148    }
149}
150
151impl PartialEq for DisplayName {
152    fn eq(&self, other: &Self) -> bool {
153        match (self.decancered.as_deref(), other.decancered.as_deref()) {
154            (None, None) => self.raw == other.raw,
155            (None, Some(_)) | (Some(_), None) => false,
156            (Some(this), Some(other)) => this == other,
157        }
158    }
159}
160
161impl DisplayName {
162    /// Regex pattern matching an MXID.
163    const MXID_PATTERN: &'static str = "@.+[:.].+";
164
165    /// Regex pattern matching some left-to-right formatting marks:
166    ///     * LTR and RTL marks U+200E and U+200F
167    ///     * LTR/RTL and other directional formatting marks U+202A - U+202F
168    const LEFT_TO_RIGHT_PATTERN: &'static str = "[\u{202a}-\u{202f}\u{200e}\u{200f}]";
169
170    /// Regex pattern matching bunch of unicode control characters and otherwise
171    /// misleading/invisible characters.
172    ///
173    /// This includes:
174    ///     * various width spaces U+2000 - U+200D
175    ///     * Combining characters U+0300 - U+036F
176    ///     * Blank/invisible characters (U2800, U2062-U2063)
177    ///     * Arabic Letter RTL mark U+061C
178    ///     * Zero width no-break space (BOM) U+FEFF
179    const HIDDEN_CHARACTERS_PATTERN: &'static str =
180        "[\u{2000}-\u{200D}\u{300}-\u{036f}\u{2062}-\u{2063}\u{2800}\u{061c}\u{feff}]";
181
182    /// Creates a new [`DisplayName`] from the given raw string.
183    ///
184    /// The raw display name is transformed into a Unicode-normalized form, with
185    /// common confusable characters removed to reduce ambiguity.
186    ///
187    /// **Note**: If removing confusable characters fails,
188    /// [`DisplayName::is_inherently_ambiguous`] will return `true`, and
189    /// [`DisplayName::as_normalized_str()`] will return `None.
190    pub fn new(raw: &str) -> Self {
191        let normalized = raw.nfd().collect::<String>();
192        let replaced = DOT_REGEX.replace_all(&normalized, ":");
193        let replaced = HIDDEN_CHARACTERS_REGEX.replace_all(&replaced, "");
194
195        let decancered = decancer::cure!(&replaced).ok().map(|cured| {
196            let removed_left_to_right = LEFT_TO_RIGHT_REGEX.replace_all(cured.as_ref(), "");
197            let replaced = I_REGEX.replace_all(&removed_left_to_right, "l");
198            // We re-run the dot replacement because decancer normalized a lot of weird
199            // characets into a `.`, it just doesn't do that for /u{1d16d}.
200            let replaced = DOT_REGEX.replace_all(&replaced, ":");
201            let replaced = ZERO_REGEX.replace_all(&replaced, "o");
202
203            replaced.to_string()
204        });
205
206        Self { raw: raw.to_owned(), decancered }
207    }
208
209    /// Is this display name considered to be ambiguous?
210    ///
211    /// If the display name has cancer (i.e. fails normalisation or has a
212    /// different normalised form) or looks like an MXID, then it's ambiguous.
213    pub fn is_inherently_ambiguous(&self) -> bool {
214        // If we look like an MXID or have hidden characters then we're ambiguous.
215        self.looks_like_an_mxid() || self.has_hidden_characters() || self.decancered.is_none()
216    }
217
218    /// Returns the underlying raw and and unsanitized string of this
219    /// [`DisplayName`].
220    pub fn as_raw_str(&self) -> &str {
221        &self.raw
222    }
223
224    /// Returns the underlying normalized and and sanitized string of this
225    /// [`DisplayName`].
226    ///
227    /// Returns `None` if normalization failed during construction of this
228    /// [`DisplayName`].
229    pub fn as_normalized_str(&self) -> Option<&str> {
230        self.decancered.as_deref()
231    }
232
233    fn has_hidden_characters(&self) -> bool {
234        HIDDEN_CHARACTERS_REGEX.is_match(&self.raw)
235    }
236
237    fn looks_like_an_mxid(&self) -> bool {
238        self.decancered
239            .as_deref()
240            .map(|d| MXID_REGEX.is_match(d))
241            .unwrap_or_else(|| MXID_REGEX.is_match(&self.raw))
242    }
243}
244
245/// A deserialized response for the rooms members API call.
246///
247/// [`GET /_matrix/client/r0/rooms/{roomId}/members`](https://spec.matrix.org/v1.5/client-server-api/#get_matrixclientv3roomsroomidmembers)
248#[derive(Clone, Debug, Default)]
249pub struct MembersResponse {
250    /// The list of members events.
251    pub chunk: Vec<RoomMemberEvent>,
252    /// Collection of ambiguity changes that room member events trigger.
253    pub ambiguity_changes: AmbiguityChanges,
254}
255
256/// Wrapper around both versions of any event received via sync.
257#[derive(Clone, Debug, Serialize)]
258#[serde(untagged)]
259pub enum RawAnySyncOrStrippedTimelineEvent {
260    /// An event from a room in joined or left state.
261    Sync(Raw<AnySyncTimelineEvent>),
262    /// An event from a room in invited state.
263    Stripped(Raw<AnyStrippedStateEvent>),
264}
265
266/// Wrapper around both versions of any raw state event.
267#[derive(Clone, Debug, Serialize)]
268#[serde(untagged)]
269pub enum RawAnySyncOrStrippedState {
270    /// An event from a room in joined or left state.
271    Sync(Raw<AnySyncStateEvent>),
272    /// An event from a room in invited state.
273    Stripped(Raw<AnyStrippedStateEvent>),
274}
275
276impl RawAnySyncOrStrippedState {
277    /// Try to deserialize the inner JSON as the expected type.
278    pub fn deserialize(&self) -> serde_json::Result<AnySyncOrStrippedState> {
279        match self {
280            Self::Sync(raw) => Ok(AnySyncOrStrippedState::Sync(Box::new(raw.deserialize()?))),
281            Self::Stripped(raw) => {
282                Ok(AnySyncOrStrippedState::Stripped(Box::new(raw.deserialize()?)))
283            }
284        }
285    }
286
287    /// Turns this `RawAnySyncOrStrippedState` into `RawSyncOrStrippedState<C>`
288    /// without changing the underlying JSON.
289    pub fn cast<C>(self) -> RawSyncOrStrippedState<C>
290    where
291        C: StaticStateEventContent + RedactContent,
292        C::Redacted: RedactedStateEventContent,
293    {
294        match self {
295            Self::Sync(raw) => RawSyncOrStrippedState::Sync(raw.cast()),
296            Self::Stripped(raw) => RawSyncOrStrippedState::Stripped(raw.cast()),
297        }
298    }
299}
300
301/// Wrapper around both versions of any state event.
302#[derive(Clone, Debug)]
303pub enum AnySyncOrStrippedState {
304    /// An event from a room in joined or left state.
305    ///
306    /// The value is `Box`ed because it is quite large. Let's keep the size of
307    /// `Self` as small as possible.
308    Sync(Box<AnySyncStateEvent>),
309    /// An event from a room in invited state.
310    ///
311    /// The value is `Box`ed because it is quite large. Let's keep the size of
312    /// `Self` as small as possible.
313    Stripped(Box<AnyStrippedStateEvent>),
314}
315
316impl AnySyncOrStrippedState {
317    /// If this is an `AnySyncStateEvent`, return a reference to the inner
318    /// event.
319    pub fn as_sync(&self) -> Option<&AnySyncStateEvent> {
320        match self {
321            Self::Sync(ev) => Some(ev),
322            Self::Stripped(_) => None,
323        }
324    }
325
326    /// If this is an `AnyStrippedStateEvent`, return a reference to the inner
327    /// event.
328    pub fn as_stripped(&self) -> Option<&AnyStrippedStateEvent> {
329        match self {
330            Self::Sync(_) => None,
331            Self::Stripped(ev) => Some(ev),
332        }
333    }
334}
335
336/// Wrapper around both versions of a raw state event.
337#[derive(Clone, Debug, Serialize)]
338#[serde(untagged)]
339pub enum RawSyncOrStrippedState<C>
340where
341    C: StaticStateEventContent + RedactContent,
342    C::Redacted: RedactedStateEventContent,
343{
344    /// An event from a room in joined or left state.
345    Sync(Raw<SyncStateEvent<C>>),
346    /// An event from a room in invited state.
347    Stripped(Raw<StrippedStateEvent<C::PossiblyRedacted>>),
348}
349
350impl<C> RawSyncOrStrippedState<C>
351where
352    C: StaticStateEventContent + RedactContent,
353    C::Redacted: RedactedStateEventContent + fmt::Debug + Clone,
354{
355    /// Try to deserialize the inner JSON as the expected type.
356    pub fn deserialize(&self) -> serde_json::Result<SyncOrStrippedState<C>>
357    where
358        C: StaticStateEventContent + EventContentFromType + RedactContent,
359        C::Redacted: RedactedStateEventContent<StateKey = C::StateKey> + EventContentFromType,
360        C::PossiblyRedacted: PossiblyRedactedStateEventContent + EventContentFromType,
361    {
362        match self {
363            Self::Sync(ev) => Ok(SyncOrStrippedState::Sync(ev.deserialize()?)),
364            Self::Stripped(ev) => Ok(SyncOrStrippedState::Stripped(ev.deserialize()?)),
365        }
366    }
367}
368
369/// Raw version of [`MemberEvent`].
370pub type RawMemberEvent = RawSyncOrStrippedState<RoomMemberEventContent>;
371
372/// Wrapper around both versions of a state event.
373#[derive(Clone, Debug)]
374pub enum SyncOrStrippedState<C>
375where
376    C: StaticStateEventContent + RedactContent,
377    C::Redacted: RedactedStateEventContent + fmt::Debug + Clone,
378{
379    /// An event from a room in joined or left state.
380    Sync(SyncStateEvent<C>),
381    /// An event from a room in invited state.
382    Stripped(StrippedStateEvent<C::PossiblyRedacted>),
383}
384
385impl<C> SyncOrStrippedState<C>
386where
387    C: StaticStateEventContent + RedactContent,
388    C::Redacted: RedactedStateEventContent<StateKey = C::StateKey> + fmt::Debug + Clone,
389    C::PossiblyRedacted: PossiblyRedactedStateEventContent<StateKey = C::StateKey>,
390{
391    /// If this is a `SyncStateEvent`, return a reference to the inner event.
392    pub fn as_sync(&self) -> Option<&SyncStateEvent<C>> {
393        match self {
394            Self::Sync(ev) => Some(ev),
395            Self::Stripped(_) => None,
396        }
397    }
398
399    /// If this is a `StrippedStateEvent`, return a reference to the inner
400    /// event.
401    pub fn as_stripped(&self) -> Option<&StrippedStateEvent<C::PossiblyRedacted>> {
402        match self {
403            Self::Sync(_) => None,
404            Self::Stripped(ev) => Some(ev),
405        }
406    }
407
408    /// The sender of this event.
409    pub fn sender(&self) -> &UserId {
410        match self {
411            Self::Sync(e) => e.sender(),
412            Self::Stripped(e) => &e.sender,
413        }
414    }
415
416    /// The ID of this event.
417    pub fn event_id(&self) -> Option<&EventId> {
418        match self {
419            Self::Sync(e) => Some(e.event_id()),
420            Self::Stripped(_) => None,
421        }
422    }
423
424    /// The server timestamp of this event.
425    pub fn origin_server_ts(&self) -> Option<MilliSecondsSinceUnixEpoch> {
426        match self {
427            Self::Sync(e) => Some(e.origin_server_ts()),
428            Self::Stripped(_) => None,
429        }
430    }
431
432    /// The state key associated to this state event.
433    pub fn state_key(&self) -> &C::StateKey {
434        match self {
435            Self::Sync(e) => e.state_key(),
436            Self::Stripped(e) => &e.state_key,
437        }
438    }
439}
440
441impl<C> SyncOrStrippedState<C>
442where
443    C: StaticStateEventContent<PossiblyRedacted = C>
444        + RedactContent
445        + PossiblyRedactedStateEventContent,
446    C::Redacted: RedactedStateEventContent<StateKey = <C as StateEventContent>::StateKey>
447        + fmt::Debug
448        + Clone,
449{
450    /// The inner content of the wrapped event.
451    pub fn original_content(&self) -> Option<&C> {
452        match self {
453            Self::Sync(e) => e.as_original().map(|e| &e.content),
454            Self::Stripped(e) => Some(&e.content),
455        }
456    }
457}
458
459/// Wrapper around both MemberEvent-Types
460pub type MemberEvent = SyncOrStrippedState<RoomMemberEventContent>;
461
462impl MemberEvent {
463    /// The membership state of the user.
464    pub fn membership(&self) -> &MembershipState {
465        match self {
466            MemberEvent::Sync(e) => e.membership(),
467            MemberEvent::Stripped(e) => &e.content.membership,
468        }
469    }
470
471    /// The user id associated to this member event.
472    pub fn user_id(&self) -> &UserId {
473        self.state_key()
474    }
475
476    /// The name that should be displayed for this member event.
477    ///
478    /// It there is no `displayname` in the event's content, the localpart or
479    /// the user ID is returned.
480    pub fn display_name(&self) -> DisplayName {
481        DisplayName::new(
482            self.original_content()
483                .and_then(|c| c.displayname.as_deref())
484                .unwrap_or_else(|| self.user_id().localpart()),
485        )
486    }
487
488    /// The optional reason why the membership changed.
489    pub fn reason(&self) -> Option<&str> {
490        match self {
491            MemberEvent::Sync(SyncStateEvent::Original(c)) => c.content.reason.as_deref(),
492            MemberEvent::Stripped(e) => e.content.reason.as_deref(),
493            _ => None,
494        }
495    }
496
497    /// The optional timestamp for this member event.
498    pub fn timestamp(&self) -> Option<UInt> {
499        match self {
500            MemberEvent::Sync(SyncStateEvent::Original(c)) => Some(c.origin_server_ts.0),
501            _ => None,
502        }
503    }
504}
505
506impl SyncOrStrippedState<RoomPowerLevelsEventContent> {
507    /// The power levels of the event.
508    pub fn power_levels(&self) -> RoomPowerLevels {
509        match self {
510            Self::Sync(e) => e.power_levels(),
511            Self::Stripped(e) => e.power_levels(),
512        }
513    }
514}
515
516#[cfg(test)]
517mod test {
518    macro_rules! assert_display_name_eq {
519        ($left:expr, $right:expr $(, $desc:expr)?) => {{
520            let left = crate::deserialized_responses::DisplayName::new($left);
521            let right = crate::deserialized_responses::DisplayName::new($right);
522
523            similar_asserts::assert_eq!(
524                left,
525                right
526                $(, $desc)?
527            );
528        }};
529    }
530
531    macro_rules! assert_display_name_ne {
532        ($left:expr, $right:expr $(, $desc:expr)?) => {{
533            let left = crate::deserialized_responses::DisplayName::new($left);
534            let right = crate::deserialized_responses::DisplayName::new($right);
535
536            assert_ne!(
537                left,
538                right
539                $(, $desc)?
540            );
541        }};
542    }
543
544    macro_rules! assert_ambiguous {
545        ($name:expr) => {
546            let name = crate::deserialized_responses::DisplayName::new($name);
547
548            assert!(
549                name.is_inherently_ambiguous(),
550                "The display {:?} should be considered amgibuous",
551                name
552            );
553        };
554    }
555
556    macro_rules! assert_not_ambiguous {
557        ($name:expr) => {
558            let name = crate::deserialized_responses::DisplayName::new($name);
559
560            assert!(
561                !name.is_inherently_ambiguous(),
562                "The display {:?} should not be considered amgibuous",
563                name
564            );
565        };
566    }
567
568    #[test]
569    fn test_display_name_inherently_ambiguous() {
570        // These should not be inherently ambiguous, only if another similarly looking
571        // display name appears should they be considered to be ambiguous.
572        assert_not_ambiguous!("Alice");
573        assert_not_ambiguous!("Carol");
574        assert_not_ambiguous!("Car0l");
575        assert_not_ambiguous!("Ivan");
576        assert_not_ambiguous!("𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");
577        assert_not_ambiguous!("Ⓢⓐⓗⓐⓢⓡⓐⓗⓛⓐ");
578        assert_not_ambiguous!("🅂🄰🄷🄰🅂🅁🄰🄷🄻🄰");
579        assert_not_ambiguous!("Ｓａｈａｓｒａｈｌａ");
580        // Left to right is fine, if it's the only one in the room.
581        assert_not_ambiguous!("\u{202e}alharsahas");
582
583        // These on the other hand contain invisible chars.
584        assert_ambiguous!("Sa̴hasrahla");
585        assert_ambiguous!("Sahas\u{200D}rahla");
586    }
587
588    #[test]
589    fn test_display_name_equality_capitalization() {
590        // Display name with different capitalization
591        assert_display_name_eq!("Alice", "alice");
592    }
593
594    #[test]
595    fn test_display_name_equality_different_names() {
596        // Different display names
597        assert_display_name_ne!("Alice", "Carol");
598    }
599
600    #[test]
601    fn test_display_name_equality_capital_l() {
602        // Different display names
603        assert_display_name_eq!("Hello", "HeIlo");
604    }
605
606    #[test]
607    fn test_display_name_equality_confusable_zero() {
608        // Different display names
609        assert_display_name_eq!("Carol", "Car0l");
610    }
611
612    #[test]
613    fn test_display_name_equality_cyrillic() {
614        // Display name with scritpure symbols
615        assert_display_name_eq!("alice", "аlice");
616    }
617
618    #[test]
619    fn test_display_name_equality_scriptures() {
620        // Display name with scritpure symbols
621        assert_display_name_eq!("Sahasrahla", "𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");
622    }
623
624    #[test]
625    fn test_display_name_equality_frakturs() {
626        // Display name with fraktur symbols
627        assert_display_name_eq!("Sahasrahla", "𝔖𝔞𝔥𝔞𝔰𝔯𝔞𝔥𝔩𝔞");
628    }
629
630    #[test]
631    fn test_display_name_equality_circled() {
632        // Display name with circled symbols
633        assert_display_name_eq!("Sahasrahla", "Ⓢⓐⓗⓐⓢⓡⓐⓗⓛⓐ");
634    }
635
636    #[test]
637    fn test_display_name_equality_squared() {
638        // Display name with squared symbols
639        assert_display_name_eq!("Sahasrahla", "🅂🄰🄷🄰🅂🅁🄰🄷🄻🄰");
640    }
641
642    #[test]
643    fn test_display_name_equality_big_unicode() {
644        // Display name with big unicode letters
645        assert_display_name_eq!("Sahasrahla", "Ｓａｈａｓｒａｈｌａ");
646    }
647
648    #[test]
649    fn test_display_name_equality_left_to_right() {
650        // Display name with a left-to-right character
651        assert_display_name_eq!("Sahasrahla", "\u{202e}alharsahas");
652    }
653
654    #[test]
655    fn test_display_name_equality_diacritical() {
656        // Display name with a diacritical mark.
657        assert_display_name_eq!("Sahasrahla", "Sa̴hasrahla");
658    }
659
660    #[test]
661    fn test_display_name_equality_zero_width_joiner() {
662        // Display name with a zero-width joiner
663        assert_display_name_eq!("Sahasrahla", "Sahas\u{200B}rahla");
664    }
665
666    #[test]
667    fn test_display_name_equality_zero_width_space() {
668        // Display name with zero-width space.
669        assert_display_name_eq!("Sahasrahla", "Sahas\u{200D}rahla");
670    }
671
672    #[test]
673    fn test_display_name_equality_ligatures() {
674        // Display name with a ligature.
675        assert_display_name_eq!("ff", "\u{FB00}");
676    }
677
678    #[test]
679    fn test_display_name_confusable_mxid_colon() {
680        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0589}domain.tld");
681        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{05c3}domain.tld");
682        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0703}domain.tld");
683        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0a83}domain.tld");
684        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{16ec}domain.tld");
685        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{205a}domain.tld");
686        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{2236}domain.tld");
687        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe13}domain.tld");
688        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe52}domain.tld");
689        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe30}domain.tld");
690        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{ff1a}domain.tld");
691
692        // Additionally these should be considered to be ambiguous on their own.
693        assert_ambiguous!("@mxid\u{0589}domain.tld");
694        assert_ambiguous!("@mxid\u{05c3}domain.tld");
695        assert_ambiguous!("@mxid\u{0703}domain.tld");
696        assert_ambiguous!("@mxid\u{0a83}domain.tld");
697        assert_ambiguous!("@mxid\u{16ec}domain.tld");
698        assert_ambiguous!("@mxid\u{205a}domain.tld");
699        assert_ambiguous!("@mxid\u{2236}domain.tld");
700        assert_ambiguous!("@mxid\u{fe13}domain.tld");
701        assert_ambiguous!("@mxid\u{fe52}domain.tld");
702        assert_ambiguous!("@mxid\u{fe30}domain.tld");
703        assert_ambiguous!("@mxid\u{ff1a}domain.tld");
704    }
705
706    #[test]
707    fn test_display_name_confusable_mxid_dot() {
708        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{0701}tld");
709        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{0702}tld");
710        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{2024}tld");
711        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{fe52}tld");
712        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{ff0e}tld");
713        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{1d16d}tld");
714
715        // Additionally these should be considered to be ambiguous on their own.
716        assert_ambiguous!("@mxid:domain\u{0701}tld");
717        assert_ambiguous!("@mxid:domain\u{0702}tld");
718        assert_ambiguous!("@mxid:domain\u{2024}tld");
719        assert_ambiguous!("@mxid:domain\u{fe52}tld");
720        assert_ambiguous!("@mxid:domain\u{ff0e}tld");
721        assert_ambiguous!("@mxid:domain\u{1d16d}tld");
722    }
723
724    #[test]
725    fn test_display_name_confusable_mxid_replacing_a() {
726        assert_display_name_eq!("@mxid:domain.tld", "@mxid:dom\u{1d44e}in.tld");
727        assert_display_name_eq!("@mxid:domain.tld", "@mxid:dom\u{0430}in.tld");
728
729        // Additionally these should be considered to be ambiguous on their own.
730        assert_ambiguous!("@mxid:dom\u{1d44e}in.tld");
731        assert_ambiguous!("@mxid:dom\u{0430}in.tld");
732    }
733
734    #[test]
735    fn test_display_name_confusable_mxid_replacing_l() {
736        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain.tId");
737        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{217c}d");
738        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{ff4c}d");
739        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{1d5f9}d");
740        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{1d695}d");
741        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{2223}d");
742
743        // Additionally these should be considered to be ambiguous on their own.
744        assert_ambiguous!("@mxid:domain.tId");
745        assert_ambiguous!("@mxid:domain.t\u{217c}d");
746        assert_ambiguous!("@mxid:domain.t\u{ff4c}d");
747        assert_ambiguous!("@mxid:domain.t\u{1d5f9}d");
748        assert_ambiguous!("@mxid:domain.t\u{1d695}d");
749        assert_ambiguous!("@mxid:domain.t\u{2223}d");
750    }
751}
matrix_sdk_base/deserialized_responses.rs

matrix_sdk_base/
deserialized_responses.rs
