2017-07-21 21:38:01 +03:00
|
|
|
/*
|
2024-09-09 16:57:16 +03:00
|
|
|
Copyright 2024 New Vector Ltd.
|
|
|
|
Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
|
2017-07-21 21:38:01 +03:00
|
|
|
|
2024-09-09 16:57:16 +03:00
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
|
|
Please see LICENSE files in the repository root for full details.
|
2017-07-21 21:38:01 +03:00
|
|
|
*/
|
|
|
|
|
2024-03-18 17:40:52 +03:00
|
|
|
import { MatrixEvent, EventType, RelationType } from "matrix-js-sdk/src/matrix";
|
|
|
|
import { KnownMembership } from "matrix-js-sdk/src/types";
|
2020-10-13 19:38:59 +03:00
|
|
|
|
2017-10-29 10:43:52 +03:00
|
|
|
import SettingsStore from "./settings/SettingsStore";
|
2021-10-01 16:35:54 +03:00
|
|
|
import { IRoomState } from "./components/structures/RoomView";
|
2017-10-29 10:43:52 +03:00
|
|
|
|
2020-10-13 19:38:59 +03:00
|
|
|
interface IDiff {
|
|
|
|
isMemberEvent: boolean;
|
|
|
|
isJoin?: boolean;
|
|
|
|
isPart?: boolean;
|
|
|
|
isDisplaynameChange?: boolean;
|
|
|
|
isAvatarChange?: boolean;
|
|
|
|
}
|
|
|
|
|
|
|
|
function memberEventDiff(ev: MatrixEvent): IDiff {
|
|
|
|
const diff: IDiff = {
|
2022-04-08 14:10:10 +03:00
|
|
|
isMemberEvent: ev.getType() === EventType.RoomMember,
|
2017-08-04 19:22:01 +03:00
|
|
|
};
|
2017-07-21 21:38:01 +03:00
|
|
|
|
2017-08-10 17:22:53 +03:00
|
|
|
// If is not a Member Event then the other checks do not apply, so bail early.
|
2017-08-10 15:58:19 +03:00
|
|
|
if (!diff.isMemberEvent) return diff;
|
2017-07-21 21:38:01 +03:00
|
|
|
|
2017-08-04 19:22:01 +03:00
|
|
|
const content = ev.getContent();
|
|
|
|
const prevContent = ev.getPrevContent();
|
2017-07-26 13:51:41 +03:00
|
|
|
|
2018-02-28 03:49:14 +03:00
|
|
|
const isMembershipChanged = content.membership !== prevContent.membership;
|
2024-03-12 17:52:54 +03:00
|
|
|
diff.isJoin = isMembershipChanged && content.membership === KnownMembership.Join;
|
|
|
|
diff.isPart =
|
|
|
|
isMembershipChanged && content.membership === KnownMembership.Leave && ev.getStateKey() === ev.getSender();
|
2018-02-22 19:14:56 +03:00
|
|
|
|
2024-03-12 17:52:54 +03:00
|
|
|
const isJoinToJoin = !isMembershipChanged && content.membership === KnownMembership.Join;
|
2017-08-04 19:22:01 +03:00
|
|
|
diff.isDisplaynameChange = isJoinToJoin && content.displayname !== prevContent.displayname;
|
|
|
|
diff.isAvatarChange = isJoinToJoin && content.avatar_url !== prevContent.avatar_url;
|
|
|
|
return diff;
|
2017-07-21 21:38:01 +03:00
|
|
|
}
|
|
|
|
|
2021-06-05 08:25:01 +03:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
2021-10-01 16:35:54 +03:00
|
|
|
export default function shouldHideEvent(ev: MatrixEvent, ctx?: IRoomState): boolean {
|
2021-06-05 08:25:01 +03:00
|
|
|
// Accessing the settings store directly can be expensive if done frequently,
|
|
|
|
// so we should prefer using cached values if a RoomContext is available
|
2023-02-13 14:39:16 +03:00
|
|
|
const isEnabled = ctx
|
|
|
|
? (name: keyof IRoomState) => ctx[name]
|
|
|
|
: (name: string) => SettingsStore.getValue(name, ev.getRoomId());
|
2017-10-29 10:43:52 +03:00
|
|
|
|
2017-07-21 21:38:01 +03:00
|
|
|
// Hide redacted events
|
2022-01-14 17:41:40 +03:00
|
|
|
// 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;
|
2019-06-03 19:51:40 +03:00
|
|
|
|
2019-06-24 17:53:42 +03:00
|
|
|
// Hide replacement events since they update the original tile (if enabled)
|
2022-04-08 14:10:10 +03:00
|
|
|
if (ev.isRelation(RelationType.Replace)) return true;
|
2017-08-04 19:22:01 +03:00
|
|
|
|
|
|
|
const eventDiff = memberEventDiff(ev);
|
|
|
|
|
2017-08-10 15:58:19 +03:00
|
|
|
if (eventDiff.isMemberEvent) {
|
2019-01-25 06:57:40 +03:00
|
|
|
if ((eventDiff.isJoin || eventDiff.isPart) && !isEnabled("showJoinLeaves")) return true;
|
|
|
|
if (eventDiff.isAvatarChange && !isEnabled("showAvatarChanges")) return true;
|
|
|
|
if (eventDiff.isDisplaynameChange && !isEnabled("showDisplaynameChanges")) return true;
|
2017-08-04 19:22:01 +03:00
|
|
|
}
|
|
|
|
|
2017-07-21 21:38:01 +03:00
|
|
|
return false;
|
|
|
|
}
|