matrix_sdk_base/
deserialized_responses.rs

Help
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(raw.deserialize()?)),
281            Self::Stripped(raw) => Ok(AnySyncOrStrippedState::Stripped(raw.deserialize()?)),
282        }
283    }
284
285    /// Turns this `RawAnySyncOrStrippedState` into `RawSyncOrStrippedState<C>`
286    /// without changing the underlying JSON.
287    pub fn cast<C>(self) -> RawSyncOrStrippedState<C>
288    where
289        C: StaticStateEventContent + RedactContent,
290        C::Redacted: RedactedStateEventContent,
291    {
292        match self {
293            Self::Sync(raw) => RawSyncOrStrippedState::Sync(raw.cast()),
294            Self::Stripped(raw) => RawSyncOrStrippedState::Stripped(raw.cast()),
295        }
296    }
297}
298
299/// Wrapper around both versions of any state event.
300#[derive(Clone, Debug)]
301pub enum AnySyncOrStrippedState {
302    /// An event from a room in joined or left state.
303    Sync(AnySyncStateEvent),
304    /// An event from a room in invited state.
305    Stripped(AnyStrippedStateEvent),
306}
307
308impl AnySyncOrStrippedState {
309    /// If this is an `AnySyncStateEvent`, return a reference to the inner
310    /// event.
311    pub fn as_sync(&self) -> Option<&AnySyncStateEvent> {
312        match self {
313            Self::Sync(ev) => Some(ev),
314            Self::Stripped(_) => None,
315        }
316    }
317
318    /// If this is an `AnyStrippedStateEvent`, return a reference to the inner
319    /// event.
320    pub fn as_stripped(&self) -> Option<&AnyStrippedStateEvent> {
321        match self {
322            Self::Sync(_) => None,
323            Self::Stripped(ev) => Some(ev),
324        }
325    }
326}
327
328/// Wrapper around both versions of a raw state event.
329#[derive(Clone, Debug, Serialize)]
330#[serde(untagged)]
331pub enum RawSyncOrStrippedState<C>
332where
333    C: StaticStateEventContent + RedactContent,
334    C::Redacted: RedactedStateEventContent,
335{
336    /// An event from a room in joined or left state.
337    Sync(Raw<SyncStateEvent<C>>),
338    /// An event from a room in invited state.
339    Stripped(Raw<StrippedStateEvent<C::PossiblyRedacted>>),
340}
341
342impl<C> RawSyncOrStrippedState<C>
343where
344    C: StaticStateEventContent + RedactContent,
345    C::Redacted: RedactedStateEventContent + fmt::Debug + Clone,
346{
347    /// Try to deserialize the inner JSON as the expected type.
348    pub fn deserialize(&self) -> serde_json::Result<SyncOrStrippedState<C>>
349    where
350        C: StaticStateEventContent + EventContentFromType + RedactContent,
351        C::Redacted: RedactedStateEventContent<StateKey = C::StateKey> + EventContentFromType,
352        C::PossiblyRedacted: PossiblyRedactedStateEventContent + EventContentFromType,
353    {
354        match self {
355            Self::Sync(ev) => Ok(SyncOrStrippedState::Sync(ev.deserialize()?)),
356            Self::Stripped(ev) => Ok(SyncOrStrippedState::Stripped(ev.deserialize()?)),
357        }
358    }
359}
360
361/// Raw version of [`MemberEvent`].
362pub type RawMemberEvent = RawSyncOrStrippedState<RoomMemberEventContent>;
363
364/// Wrapper around both versions of a state event.
365#[derive(Clone, Debug)]
366pub enum SyncOrStrippedState<C>
367where
368    C: StaticStateEventContent + RedactContent,
369    C::Redacted: RedactedStateEventContent + fmt::Debug + Clone,
370{
371    /// An event from a room in joined or left state.
372    Sync(SyncStateEvent<C>),
373    /// An event from a room in invited state.
374    Stripped(StrippedStateEvent<C::PossiblyRedacted>),
375}
376
377impl<C> SyncOrStrippedState<C>
378where
379    C: StaticStateEventContent + RedactContent,
380    C::Redacted: RedactedStateEventContent<StateKey = C::StateKey> + fmt::Debug + Clone,
381    C::PossiblyRedacted: PossiblyRedactedStateEventContent<StateKey = C::StateKey>,
382{
383    /// If this is a `SyncStateEvent`, return a reference to the inner event.
384    pub fn as_sync(&self) -> Option<&SyncStateEvent<C>> {
385        match self {
386            Self::Sync(ev) => Some(ev),
387            Self::Stripped(_) => None,
388        }
389    }
390
391    /// If this is a `StrippedStateEvent`, return a reference to the inner
392    /// event.
393    pub fn as_stripped(&self) -> Option<&StrippedStateEvent<C::PossiblyRedacted>> {
394        match self {
395            Self::Sync(_) => None,
396            Self::Stripped(ev) => Some(ev),
397        }
398    }
399
400    /// The sender of this event.
401    pub fn sender(&self) -> &UserId {
402        match self {
403            Self::Sync(e) => e.sender(),
404            Self::Stripped(e) => &e.sender,
405        }
406    }
407
408    /// The ID of this event.
409    pub fn event_id(&self) -> Option<&EventId> {
410        match self {
411            Self::Sync(e) => Some(e.event_id()),
412            Self::Stripped(_) => None,
413        }
414    }
415
416    /// The server timestamp of this event.
417    pub fn origin_server_ts(&self) -> Option<MilliSecondsSinceUnixEpoch> {
418        match self {
419            Self::Sync(e) => Some(e.origin_server_ts()),
420            Self::Stripped(_) => None,
421        }
422    }
423
424    /// The state key associated to this state event.
425    pub fn state_key(&self) -> &C::StateKey {
426        match self {
427            Self::Sync(e) => e.state_key(),
428            Self::Stripped(e) => &e.state_key,
429        }
430    }
431}
432
433impl<C> SyncOrStrippedState<C>
434where
435    C: StaticStateEventContent<PossiblyRedacted = C>
436        + RedactContent
437        + PossiblyRedactedStateEventContent,
438    C::Redacted: RedactedStateEventContent<StateKey = <C as StateEventContent>::StateKey>
439        + fmt::Debug
440        + Clone,
441{
442    /// The inner content of the wrapped event.
443    pub fn original_content(&self) -> Option<&C> {
444        match self {
445            Self::Sync(e) => e.as_original().map(|e| &e.content),
446            Self::Stripped(e) => Some(&e.content),
447        }
448    }
449}
450
451/// Wrapper around both MemberEvent-Types
452pub type MemberEvent = SyncOrStrippedState<RoomMemberEventContent>;
453
454impl MemberEvent {
455    /// The membership state of the user.
456    pub fn membership(&self) -> &MembershipState {
457        match self {
458            MemberEvent::Sync(e) => e.membership(),
459            MemberEvent::Stripped(e) => &e.content.membership,
460        }
461    }
462
463    /// The user id associated to this member event.
464    pub fn user_id(&self) -> &UserId {
465        self.state_key()
466    }
467
468    /// The name that should be displayed for this member event.
469    ///
470    /// It there is no `displayname` in the event's content, the localpart or
471    /// the user ID is returned.
472    pub fn display_name(&self) -> DisplayName {
473        DisplayName::new(
474            self.original_content()
475                .and_then(|c| c.displayname.as_deref())
476                .unwrap_or_else(|| self.user_id().localpart()),
477        )
478    }
479
480    /// The optional reason why the membership changed.
481    pub fn reason(&self) -> Option<&str> {
482        match self {
483            MemberEvent::Sync(SyncStateEvent::Original(c)) => c.content.reason.as_deref(),
484            MemberEvent::Stripped(e) => e.content.reason.as_deref(),
485            _ => None,
486        }
487    }
488
489    /// The optional timestamp for this member event.
490    pub fn timestamp(&self) -> Option<UInt> {
491        match self {
492            MemberEvent::Sync(SyncStateEvent::Original(c)) => Some(c.origin_server_ts.0),
493            _ => None,
494        }
495    }
496}
497
498impl SyncOrStrippedState<RoomPowerLevelsEventContent> {
499    /// The power levels of the event.
500    pub fn power_levels(&self) -> RoomPowerLevels {
501        match self {
502            Self::Sync(e) => e.power_levels(),
503            Self::Stripped(e) => e.power_levels(),
504        }
505    }
506}
507
508#[cfg(test)]
509mod test {
510    macro_rules! assert_display_name_eq {
511        ($left:expr, $right:expr $(, $desc:expr)?) => {{
512            let left = crate::deserialized_responses::DisplayName::new($left);
513            let right = crate::deserialized_responses::DisplayName::new($right);
514
515            similar_asserts::assert_eq!(
516                left,
517                right
518                $(, $desc)?
519            );
520        }};
521    }
522
523    macro_rules! assert_display_name_ne {
524        ($left:expr, $right:expr $(, $desc:expr)?) => {{
525            let left = crate::deserialized_responses::DisplayName::new($left);
526            let right = crate::deserialized_responses::DisplayName::new($right);
527
528            assert_ne!(
529                left,
530                right
531                $(, $desc)?
532            );
533        }};
534    }
535
536    macro_rules! assert_ambiguous {
537        ($name:expr) => {
538            let name = crate::deserialized_responses::DisplayName::new($name);
539
540            assert!(
541                name.is_inherently_ambiguous(),
542                "The display {:?} should be considered amgibuous",
543                name
544            );
545        };
546    }
547
548    macro_rules! assert_not_ambiguous {
549        ($name:expr) => {
550            let name = crate::deserialized_responses::DisplayName::new($name);
551
552            assert!(
553                !name.is_inherently_ambiguous(),
554                "The display {:?} should not be considered amgibuous",
555                name
556            );
557        };
558    }
559
560    #[test]
561    fn test_display_name_inherently_ambiguous() {
562        // These should not be inherently ambiguous, only if another similarly looking
563        // display name appears should they be considered to be ambiguous.
564        assert_not_ambiguous!("Alice");
565        assert_not_ambiguous!("Carol");
566        assert_not_ambiguous!("Car0l");
567        assert_not_ambiguous!("Ivan");
568        assert_not_ambiguous!("𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");
569        assert_not_ambiguous!("Ⓢⓐⓗⓐⓢⓡⓐⓗⓛⓐ");
570        assert_not_ambiguous!("🅂🄰🄷🄰🅂🅁🄰🄷🄻🄰");
571        assert_not_ambiguous!("Ｓａｈａｓｒａｈｌａ");
572        // Left to right is fine, if it's the only one in the room.
573        assert_not_ambiguous!("\u{202e}alharsahas");
574
575        // These on the other hand contain invisible chars.
576        assert_ambiguous!("Sa̴hasrahla");
577        assert_ambiguous!("Sahas\u{200D}rahla");
578    }
579
580    #[test]
581    fn test_display_name_equality_capitalization() {
582        // Display name with different capitalization
583        assert_display_name_eq!("Alice", "alice");
584    }
585
586    #[test]
587    fn test_display_name_equality_different_names() {
588        // Different display names
589        assert_display_name_ne!("Alice", "Carol");
590    }
591
592    #[test]
593    fn test_display_name_equality_capital_l() {
594        // Different display names
595        assert_display_name_eq!("Hello", "HeIlo");
596    }
597
598    #[test]
599    fn test_display_name_equality_confusable_zero() {
600        // Different display names
601        assert_display_name_eq!("Carol", "Car0l");
602    }
603
604    #[test]
605    fn test_display_name_equality_cyrillic() {
606        // Display name with scritpure symbols
607        assert_display_name_eq!("alice", "аlice");
608    }
609
610    #[test]
611    fn test_display_name_equality_scriptures() {
612        // Display name with scritpure symbols
613        assert_display_name_eq!("Sahasrahla", "𝒮𝒶𝒽𝒶𝓈𝓇𝒶𝒽𝓁𝒶");
614    }
615
616    #[test]
617    fn test_display_name_equality_frakturs() {
618        // Display name with fraktur symbols
619        assert_display_name_eq!("Sahasrahla", "𝔖𝔞𝔥𝔞𝔰𝔯𝔞𝔥𝔩𝔞");
620    }
621
622    #[test]
623    fn test_display_name_equality_circled() {
624        // Display name with circled symbols
625        assert_display_name_eq!("Sahasrahla", "Ⓢⓐⓗⓐⓢⓡⓐⓗⓛⓐ");
626    }
627
628    #[test]
629    fn test_display_name_equality_squared() {
630        // Display name with squared symbols
631        assert_display_name_eq!("Sahasrahla", "🅂🄰🄷🄰🅂🅁🄰🄷🄻🄰");
632    }
633
634    #[test]
635    fn test_display_name_equality_big_unicode() {
636        // Display name with big unicode letters
637        assert_display_name_eq!("Sahasrahla", "Ｓａｈａｓｒａｈｌａ");
638    }
639
640    #[test]
641    fn test_display_name_equality_left_to_right() {
642        // Display name with a left-to-right character
643        assert_display_name_eq!("Sahasrahla", "\u{202e}alharsahas");
644    }
645
646    #[test]
647    fn test_display_name_equality_diacritical() {
648        // Display name with a diacritical mark.
649        assert_display_name_eq!("Sahasrahla", "Sa̴hasrahla");
650    }
651
652    #[test]
653    fn test_display_name_equality_zero_width_joiner() {
654        // Display name with a zero-width joiner
655        assert_display_name_eq!("Sahasrahla", "Sahas\u{200B}rahla");
656    }
657
658    #[test]
659    fn test_display_name_equality_zero_width_space() {
660        // Display name with zero-width space.
661        assert_display_name_eq!("Sahasrahla", "Sahas\u{200D}rahla");
662    }
663
664    #[test]
665    fn test_display_name_equality_ligatures() {
666        // Display name with a ligature.
667        assert_display_name_eq!("ff", "\u{FB00}");
668    }
669
670    #[test]
671    fn test_display_name_confusable_mxid_colon() {
672        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0589}domain.tld");
673        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{05c3}domain.tld");
674        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0703}domain.tld");
675        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{0a83}domain.tld");
676        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{16ec}domain.tld");
677        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{205a}domain.tld");
678        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{2236}domain.tld");
679        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe13}domain.tld");
680        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe52}domain.tld");
681        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{fe30}domain.tld");
682        assert_display_name_eq!("@mxid:domain.tld", "@mxid\u{ff1a}domain.tld");
683
684        // Additionally these should be considered to be ambiguous on their own.
685        assert_ambiguous!("@mxid\u{0589}domain.tld");
686        assert_ambiguous!("@mxid\u{05c3}domain.tld");
687        assert_ambiguous!("@mxid\u{0703}domain.tld");
688        assert_ambiguous!("@mxid\u{0a83}domain.tld");
689        assert_ambiguous!("@mxid\u{16ec}domain.tld");
690        assert_ambiguous!("@mxid\u{205a}domain.tld");
691        assert_ambiguous!("@mxid\u{2236}domain.tld");
692        assert_ambiguous!("@mxid\u{fe13}domain.tld");
693        assert_ambiguous!("@mxid\u{fe52}domain.tld");
694        assert_ambiguous!("@mxid\u{fe30}domain.tld");
695        assert_ambiguous!("@mxid\u{ff1a}domain.tld");
696    }
697
698    #[test]
699    fn test_display_name_confusable_mxid_dot() {
700        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{0701}tld");
701        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{0702}tld");
702        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{2024}tld");
703        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{fe52}tld");
704        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{ff0e}tld");
705        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain\u{1d16d}tld");
706
707        // Additionally these should be considered to be ambiguous on their own.
708        assert_ambiguous!("@mxid:domain\u{0701}tld");
709        assert_ambiguous!("@mxid:domain\u{0702}tld");
710        assert_ambiguous!("@mxid:domain\u{2024}tld");
711        assert_ambiguous!("@mxid:domain\u{fe52}tld");
712        assert_ambiguous!("@mxid:domain\u{ff0e}tld");
713        assert_ambiguous!("@mxid:domain\u{1d16d}tld");
714    }
715
716    #[test]
717    fn test_display_name_confusable_mxid_replacing_a() {
718        assert_display_name_eq!("@mxid:domain.tld", "@mxid:dom\u{1d44e}in.tld");
719        assert_display_name_eq!("@mxid:domain.tld", "@mxid:dom\u{0430}in.tld");
720
721        // Additionally these should be considered to be ambiguous on their own.
722        assert_ambiguous!("@mxid:dom\u{1d44e}in.tld");
723        assert_ambiguous!("@mxid:dom\u{0430}in.tld");
724    }
725
726    #[test]
727    fn test_display_name_confusable_mxid_replacing_l() {
728        assert_display_name_eq!("@mxid:domain.tld", "@mxid:domain.tId");
729        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{217c}d");
730        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{ff4c}d");
731        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{1d5f9}d");
732        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{1d695}d");
733        assert_display_name_eq!("mxid:domain.tld", "mxid:domain.t\u{2223}d");
734
735        // Additionally these should be considered to be ambiguous on their own.
736        assert_ambiguous!("@mxid:domain.tId");
737        assert_ambiguous!("@mxid:domain.t\u{217c}d");
738        assert_ambiguous!("@mxid:domain.t\u{ff4c}d");
739        assert_ambiguous!("@mxid:domain.t\u{1d5f9}d");
740        assert_ambiguous!("@mxid:domain.t\u{1d695}d");
741        assert_ambiguous!("@mxid:domain.t\u{2223}d");
742    }
743}
matrix_sdk_base/deserialized_responses.rs

matrix_sdk_base/
deserialized_responses.rs
