/* Copyright 2021 - 2022 The Matrix.org Foundation C.I.C. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ import React, { createRef, KeyboardEvent } from 'react'; import { Thread, THREAD_RELATION_TYPE, ThreadEvent } from 'matrix-js-sdk/src/models/thread'; import { Room, RoomEvent } from 'matrix-js-sdk/src/models/room'; import { IEventRelation, MatrixEvent } from 'matrix-js-sdk/src/models/event'; import { TimelineWindow } from 'matrix-js-sdk/src/timeline-window'; import { Direction } from 'matrix-js-sdk/src/models/event-timeline'; import { IRelationsRequestOpts } from 'matrix-js-sdk/src/@types/requests'; import { logger } from 'matrix-js-sdk/src/logger'; import classNames from 'classnames'; import BaseCard from "../views/right_panel/BaseCard"; import { RightPanelPhases } from "../../stores/right-panel/RightPanelStorePhases"; import ResizeNotifier from '../../utils/ResizeNotifier'; import MessageComposer from '../views/rooms/MessageComposer'; import { RoomPermalinkCreator } from '../../utils/permalinks/Permalinks'; import { Layout } from '../../settings/enums/Layout'; import TimelinePanel from './TimelinePanel'; import dis from "../../dispatcher/dispatcher"; import { ActionPayload } from '../../dispatcher/payloads'; import { Action } from '../../dispatcher/actions'; import { MatrixClientPeg } from '../../MatrixClientPeg'; import { E2EStatus } from '../../utils/ShieldUtils'; import EditorStateTransfer from '../../utils/EditorStateTransfer'; import RoomContext, { TimelineRenderingType } from '../../contexts/RoomContext'; import ContentMessages from '../../ContentMessages'; import UploadBar from './UploadBar'; import { _t } from '../../languageHandler'; import ThreadListContextMenu from '../views/context_menus/ThreadListContextMenu'; import RightPanelStore from '../../stores/right-panel/RightPanelStore'; import SettingsStore from "../../settings/SettingsStore"; import { ViewRoomPayload } from "../../dispatcher/payloads/ViewRoomPayload"; import FileDropTarget from "./FileDropTarget"; import { getKeyBindingsManager } from "../../KeyBindingsManager"; import { KeyBindingAction } from "../../accessibility/KeyboardShortcuts"; import Measured from '../views/elements/Measured'; import PosthogTrackers from "../../PosthogTrackers"; import { ButtonEvent } from "../views/elements/AccessibleButton"; import Spinner from "../views/elements/Spinner"; import { ComposerInsertPayload, ComposerType } from "../../dispatcher/payloads/ComposerInsertPayload"; import Heading from '../views/typography/Heading'; import { SdkContextClass } from '../../contexts/SDKContext'; import { ThreadPayload } from '../../dispatcher/payloads/ThreadPayload'; interface IProps { room: Room; onClose: () => void; resizeNotifier: ResizeNotifier; mxEvent: MatrixEvent; permalinkCreator?: RoomPermalinkCreator; e2eStatus?: E2EStatus; initialEvent?: MatrixEvent; isInitialEventHighlighted?: boolean; initialEventScrollIntoView?: boolean; } interface IState { thread?: Thread; lastReply?: MatrixEvent | null; layout: Layout; editState?: EditorStateTransfer; replyToEvent?: MatrixEvent; narrow: boolean; } export default class ThreadView extends React.Component { static contextType = RoomContext; public context!: React.ContextType; private dispatcherRef: string; private readonly layoutWatcherRef: string; private timelinePanel = createRef(); private card = createRef(); constructor(props: IProps) { super(props); const thread = this.props.room.getThread(this.props.mxEvent.getId()); this.setupThreadListeners(thread); this.state = { layout: SettingsStore.getValue("layout"), narrow: false, thread, lastReply: thread?.lastReply((ev: MatrixEvent) => { return ev.isRelation(THREAD_RELATION_TYPE.name) && !ev.status; }), }; this.layoutWatcherRef = SettingsStore.watchSetting("layout", null, (...[,,, value]) => this.setState({ layout: value as Layout }), ); } public componentDidMount(): void { if (this.state.thread) { this.postThreadUpdate(this.state.thread); } this.setupThread(this.props.mxEvent); this.dispatcherRef = dis.register(this.onAction); const room = MatrixClientPeg.get().getRoom(this.props.mxEvent.getRoomId()); room.on(ThreadEvent.New, this.onNewThread); } public componentWillUnmount(): void { if (this.dispatcherRef) dis.unregister(this.dispatcherRef); const roomId = this.props.mxEvent.getRoomId(); const room = MatrixClientPeg.get().getRoom(roomId); room.removeListener(ThreadEvent.New, this.onNewThread); SettingsStore.unwatchSetting(this.layoutWatcherRef); const hasRoomChanged = SdkContextClass.instance.roomViewStore.getRoomId() !== roomId; if (this.props.isInitialEventHighlighted && !hasRoomChanged) { dis.dispatch({ action: Action.ViewRoom, room_id: this.props.room.roomId, metricsTrigger: undefined, // room doesn't change }); } dis.dispatch({ action: Action.ViewThread, thread_id: null, }); } public componentDidUpdate(prevProps) { if (prevProps.mxEvent !== this.props.mxEvent) { this.setupThread(this.props.mxEvent); } if (prevProps.room !== this.props.room) { RightPanelStore.instance.setCard({ phase: RightPanelPhases.RoomSummary }); } } private onAction = (payload: ActionPayload): void => { if (payload.phase == RightPanelPhases.ThreadView && payload.event) { this.setupThread(payload.event); } switch (payload.action) { case Action.ComposerInsert: { if (payload.composerType) break; if (payload.timelineRenderingType !== TimelineRenderingType.Thread) break; // re-dispatch to the correct composer dis.dispatch({ ...(payload as ComposerInsertPayload), composerType: this.state.editState ? ComposerType.Edit : ComposerType.Send, }); break; } case Action.EditEvent: // Quit early if it's not a thread context if (payload.timelineRenderingType !== TimelineRenderingType.Thread) return; // Quit early if that's not a thread event if (payload.event && !payload.event.getThread()) return; this.setState({ editState: payload.event ? new EditorStateTransfer(payload.event) : null, }, () => { if (payload.event) { this.timelinePanel.current?.scrollToEventIfNeeded(payload.event.getId()); } }); break; case 'reply_to_event': if (payload.context === TimelineRenderingType.Thread) { this.setState({ replyToEvent: payload.event, }); } break; default: break; } }; private setupThread = (mxEv: MatrixEvent) => { let thread = this.props.room.getThread(mxEv.getId()); if (!thread) { thread = this.props.room.createThread(mxEv.getId(), mxEv, [mxEv], true); } this.updateThread(thread); }; private onNewThread = (thread: Thread) => { if (thread.id === this.props.mxEvent.getId()) { this.setupThread(this.props.mxEvent); } }; private updateThreadRelation = (): void => { this.setState({ lastReply: this.threadLastReply, }); }; private get threadLastReply(): MatrixEvent | undefined { return this.state.thread?.lastReply((ev: MatrixEvent) => { return ev.isRelation(THREAD_RELATION_TYPE.name) && !ev.status; }); } private updateThread = (thread?: Thread) => { if (this.state.thread === thread) return; this.setupThreadListeners(thread, this.state.thread); if (thread) { this.setState({ thread, lastReply: this.threadLastReply, }, async () => this.postThreadUpdate(thread)); } }; private async postThreadUpdate(thread: Thread): Promise { dis.dispatch({ action: Action.ViewThread, thread_id: thread.id, }); thread.emit(ThreadEvent.ViewThread); await thread.fetchInitialEvents(); this.updateThreadRelation(); this.nextBatch = thread.liveTimeline.getPaginationToken(Direction.Backward); this.timelinePanel.current?.refreshTimeline(); } private setupThreadListeners(thread?: Thread | undefined, oldThread?: Thread | undefined): void { if (oldThread) { this.state.thread.off(ThreadEvent.NewReply, this.updateThreadRelation); this.props.room.off(RoomEvent.LocalEchoUpdated, this.updateThreadRelation); } if (thread) { thread.on(ThreadEvent.NewReply, this.updateThreadRelation); this.props.room.on(RoomEvent.LocalEchoUpdated, this.updateThreadRelation); } } private resetJumpToEvent = (event?: string): void => { if (this.props.initialEvent && this.props.initialEventScrollIntoView && event === this.props.initialEvent?.getId()) { dis.dispatch({ action: Action.ViewRoom, room_id: this.props.room.roomId, event_id: this.props.initialEvent?.getId(), highlighted: this.props.isInitialEventHighlighted, scroll_into_view: false, replyingToEvent: this.state.replyToEvent, metricsTrigger: undefined, // room doesn't change }); } }; private onMeasurement = (narrow: boolean): void => { this.setState({ narrow }); }; private onKeyDown = (ev: KeyboardEvent) => { let handled = false; const action = getKeyBindingsManager().getRoomAction(ev); switch (action) { case KeyBindingAction.UploadFile: { dis.dispatch({ action: "upload_file", context: TimelineRenderingType.Thread, }, true); handled = true; break; } } if (handled) { ev.stopPropagation(); ev.preventDefault(); } }; private nextBatch: string | undefined | null = null; private onPaginationRequest = async ( timelineWindow: TimelineWindow | null, direction = Direction.Backward, limit = 20, ): Promise => { if (!Thread.hasServerSideSupport && timelineWindow) { timelineWindow.extend(direction, limit); return true; } const opts: IRelationsRequestOpts = { limit, }; if (this.nextBatch) { opts.from = this.nextBatch; } let nextBatch: string | null | undefined = null; if (this.state.thread) { const response = await this.state.thread.fetchEvents(opts); nextBatch = response.nextBatch; this.nextBatch = nextBatch; } // Advances the marker on the TimelineWindow to define the correct // window of events to display on screen timelineWindow?.extend(direction, limit); return !!nextBatch; }; private onFileDrop = (dataTransfer: DataTransfer) => { const roomId = this.props.mxEvent.getRoomId(); if (roomId) { ContentMessages.sharedInstance().sendContentListToRoom( Array.from(dataTransfer.files), roomId, this.threadRelation, MatrixClientPeg.get(), TimelineRenderingType.Thread, ); } else { console.warn("Unknwon roomId for event", this.props.mxEvent); } }; private get threadRelation(): IEventRelation { const relation = { "rel_type": THREAD_RELATION_TYPE.name, "event_id": this.state.thread?.id, "is_falling_back": true, }; const fallbackEventId = this.state.lastReply?.getId() ?? this.state.thread?.id; if (fallbackEventId) { relation["m.in_reply_to"] = { "event_id": fallbackEventId, }; } return relation; } private renderThreadViewHeader = (): JSX.Element => { return
{ _t("Thread") }
; }; public render(): JSX.Element { const highlightedEventId = this.props.isInitialEventHighlighted ? this.props.initialEvent?.getId() : null; const threadRelation = this.threadRelation; let timeline: JSX.Element | null; if (this.state.thread) { if (this.props.initialEvent && this.props.initialEvent.getRoomId() !== this.state.thread.roomId) { logger.warn("ThreadView attempting to render TimelinePanel with mismatched initialEvent", this.state.thread.roomId, this.props.initialEvent.getRoomId(), this.props.initialEvent.getId(), ); } timeline = <>