Absorb the matrix-react-sdk repository (#28192)

Co-authored-by: github-merge-queue <118344674+github-merge-queue@users.noreply.github.com> Co-authored-by: github-merge-queue <github-merge-queue@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Florian Duros <florian.duros@ormaz.fr> Co-authored-by: Kim Brose <kim.brose@nordeck.net> Co-authored-by: Florian Duros <florianduros@element.io> Co-authored-by: R Midhun Suresh <hi@midhun.dev> Co-authored-by: dbkr <986903+dbkr@users.noreply.github.com> Co-authored-by: ElementRobot <releases@riot.im> Co-authored-by: dbkr <dbkr@users.noreply.github.com> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: David Langley <davidl@element.io> Co-authored-by: Michael Weimann <michaelw@matrix.org> Co-authored-by: Timshel <Timshel@users.noreply.github.com> Co-authored-by: Sahil Silare <32628578+sahil9001@users.noreply.github.com> Co-authored-by: Will Hunt <will@half-shot.uk> Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> Co-authored-by: Andrew Ferrazzutti <andrewf@element.io> Co-authored-by: Robin <robin@robin.town> Co-authored-by: Tulir Asokan <tulir@maunium.net>
2024-10-16 13:31:55 +01:00
parent 2b99496025
commit c05c429803
3280 changed files with 586617 additions and 905 deletions
--- a/src/shouldHideEvent.ts
+++ b/src/shouldHideEvent.ts
@@ -0,0 +1,75 @@
+/*
+Copyright 2024 New Vector Ltd.
+Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+ */
+
+import { MatrixEvent, EventType, RelationType } from "matrix-js-sdk/src/matrix";
+import { KnownMembership } from "matrix-js-sdk/src/types";
+
+import SettingsStore from "./settings/SettingsStore";
+import { IRoomState } from "./components/structures/RoomView";
+
+interface IDiff {
+    isMemberEvent: boolean;
+    isJoin?: boolean;
+    isPart?: boolean;
+    isDisplaynameChange?: boolean;
+    isAvatarChange?: boolean;
+}
+
+function memberEventDiff(ev: MatrixEvent): IDiff {
+    const diff: IDiff = {
+        isMemberEvent: ev.getType() === EventType.RoomMember,
+    };
+
+    // If is not a Member Event then the other checks do not apply, so bail early.
+    if (!diff.isMemberEvent) return diff;
+
+    const content = ev.getContent();
+    const prevContent = ev.getPrevContent();
+
+    const isMembershipChanged = content.membership !== prevContent.membership;
+    diff.isJoin = isMembershipChanged && content.membership === KnownMembership.Join;
+    diff.isPart =
+        isMembershipChanged && content.membership === KnownMembership.Leave && ev.getStateKey() === ev.getSender();
+
+    const isJoinToJoin = !isMembershipChanged && content.membership === KnownMembership.Join;
+    diff.isDisplaynameChange = isJoinToJoin && content.displayname !== prevContent.displayname;
+    diff.isAvatarChange = isJoinToJoin && content.avatar_url !== prevContent.avatar_url;
+    return diff;
+}
+
+/**
+ * Determines whether the given event should be hidden from timelines.
+ * @param ev The event
+ * @param ctx An optional RoomContext to pull cached settings values from to avoid
+ *     hitting the settings store
+ */
+export default function shouldHideEvent(ev: MatrixEvent, ctx?: IRoomState): boolean {
+    // Accessing the settings store directly can be expensive if done frequently,
+    // so we should prefer using cached values if a RoomContext is available
+    const isEnabled = ctx
+        ? (name: keyof IRoomState) => ctx[name]
+        : (name: string) => SettingsStore.getValue(name, ev.getRoomId());
+
+    // Hide redacted events
+    // Deleted events with a thread are always shown regardless of user preference
+    // to make sure that a thread can be accessible even if the root message is deleted
+    if (ev.isRedacted() && !isEnabled("showRedactions") && !ev.getThread()) return true;
+
+    // Hide replacement events since they update the original tile (if enabled)
+    if (ev.isRelation(RelationType.Replace)) return true;
+
+    const eventDiff = memberEventDiff(ev);
+
+    if (eventDiff.isMemberEvent) {
+        if ((eventDiff.isJoin || eventDiff.isPart) && !isEnabled("showJoinLeaves")) return true;
+        if (eventDiff.isAvatarChange && !isEnabled("showAvatarChanges")) return true;
+        if (eventDiff.isDisplaynameChange && !isEnabled("showDisplaynameChanges")) return true;
+    }
+
+    return false;
+}