/* Copyright 2015-2018, 2020, 2021 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 { EventType, RoomType } from "matrix-js-sdk/src/@types/event"; import { Room } from "matrix-js-sdk/src/models/room"; import React, { ComponentType, createRef, ReactComponentElement, RefObject, SyntheticEvent } from "react"; import { IState as IRovingTabIndexState, RovingTabIndexProvider } from "../../../accessibility/RovingTabIndex"; import MatrixClientContext from "../../../contexts/MatrixClientContext"; import { shouldShowComponent } from "../../../customisations/helpers/UIComponents"; import { Action } from "../../../dispatcher/actions"; import defaultDispatcher from "../../../dispatcher/dispatcher"; import { ActionPayload } from "../../../dispatcher/payloads"; import { ViewRoomDeltaPayload } from "../../../dispatcher/payloads/ViewRoomDeltaPayload"; import { ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload"; import { useEventEmitterState } from "../../../hooks/useEventEmitter"; import { _t, _td } from "../../../languageHandler"; import { MatrixClientPeg } from "../../../MatrixClientPeg"; import PosthogTrackers from "../../../PosthogTrackers"; import SettingsStore from "../../../settings/SettingsStore"; import { useFeatureEnabled } from "../../../hooks/useSettings"; import { UIComponent } from "../../../settings/UIFeature"; import { RoomNotificationStateStore } from "../../../stores/notifications/RoomNotificationStateStore"; import { ITagMap } from "../../../stores/room-list/algorithms/models"; import { DefaultTagID, TagID } from "../../../stores/room-list/models"; import { UPDATE_EVENT } from "../../../stores/AsyncStore"; import RoomListStore, { LISTS_UPDATE_EVENT } from "../../../stores/room-list/RoomListStore"; import { isMetaSpace, ISuggestedRoom, MetaSpace, SpaceKey, UPDATE_SELECTED_SPACE, UPDATE_SUGGESTED_ROOMS, } from "../../../stores/spaces"; import SpaceStore from "../../../stores/spaces/SpaceStore"; import { arrayFastClone, arrayHasDiff } from "../../../utils/arrays"; import { objectShallowClone, objectWithOnly } from "../../../utils/objects"; import ResizeNotifier from "../../../utils/ResizeNotifier"; import { shouldShowSpaceInvite, showAddExistingRooms, showCreateNewRoom, showSpaceInvite } from "../../../utils/space"; import { ChevronFace, ContextMenuTooltipButton, MenuProps, useContextMenu } from "../../structures/ContextMenu"; import RoomAvatar from "../avatars/RoomAvatar"; import { BetaPill } from "../beta/BetaCard"; import IconizedContextMenu, { IconizedContextMenuOption, IconizedContextMenuOptionList, } from "../context_menus/IconizedContextMenu"; import AccessibleTooltipButton from "../elements/AccessibleTooltipButton"; import ExtraTile from "./ExtraTile"; import RoomSublist, { IAuxButtonProps } from "./RoomSublist"; import { SdkContextClass } from "../../../contexts/SDKContext"; interface IProps { onKeyDown: (ev: React.KeyboardEvent, state: IRovingTabIndexState) => void; onFocus: (ev: React.FocusEvent) => void; onBlur: (ev: React.FocusEvent) => void; onResize: () => void; onListCollapse?: (isExpanded: boolean) => void; resizeNotifier: ResizeNotifier; isMinimized: boolean; activeSpace: SpaceKey; } interface IState { sublists: ITagMap; currentRoomId?: string; suggestedRooms: ISuggestedRoom[]; feature_favourite_messages: boolean; } export const TAG_ORDER: TagID[] = [ DefaultTagID.Invite, DefaultTagID.SavedItems, DefaultTagID.Favourite, DefaultTagID.DM, DefaultTagID.Untagged, DefaultTagID.LowPriority, DefaultTagID.ServerNotice, DefaultTagID.Suggested, DefaultTagID.Archived, ]; const ALWAYS_VISIBLE_TAGS: TagID[] = [DefaultTagID.DM, DefaultTagID.Untagged]; interface ITagAesthetics { sectionLabel: string; sectionLabelRaw?: string; AuxButtonComponent?: ComponentType; isInvite: boolean; defaultHidden: boolean; } type TagAestheticsMap = Partial<{ [tagId in TagID]: ITagAesthetics; }>; const auxButtonContextMenuPosition = (handle: RefObject): MenuProps => { const rect = handle.current.getBoundingClientRect(); return { chevronFace: ChevronFace.None, left: rect.left - 7, top: rect.top + rect.height, }; }; const DmAuxButton: React.FC = ({ tabIndex, dispatcher = defaultDispatcher }) => { const [menuDisplayed, handle, openMenu, closeMenu] = useContextMenu(); const activeSpace = useEventEmitterState(SpaceStore.instance, UPDATE_SELECTED_SPACE, () => { return SpaceStore.instance.activeSpaceRoom; }); const showCreateRooms = shouldShowComponent(UIComponent.CreateRooms); const showInviteUsers = shouldShowComponent(UIComponent.InviteUsers); if (activeSpace && (showCreateRooms || showInviteUsers)) { let contextMenu: JSX.Element | undefined; if (menuDisplayed) { const canInvite = shouldShowSpaceInvite(activeSpace); contextMenu = ( {showCreateRooms && ( { e.preventDefault(); e.stopPropagation(); closeMenu(); defaultDispatcher.dispatch({ action: "view_create_chat" }); PosthogTrackers.trackInteraction( "WebRoomListRoomsSublistPlusMenuCreateChatItem", e, ); }} /> )} {showInviteUsers && ( { e.preventDefault(); e.stopPropagation(); closeMenu(); showSpaceInvite(activeSpace); }} disabled={!canInvite} tooltip={ canInvite ? undefined : _t("You do not have permissions to invite people to this space") } /> )} ); } return ( <> {contextMenu} ); } else if (!activeSpace && showCreateRooms) { return ( { dispatcher.dispatch({ action: "view_create_chat" }); PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuCreateChatItem", e); }} className="mx_RoomSublist_auxButton" tooltipClassName="mx_RoomSublist_addRoomTooltip" aria-label={_t("Start chat")} title={_t("Start chat")} /> ); } return null; }; const UntaggedAuxButton: React.FC = ({ tabIndex }) => { const [menuDisplayed, handle, openMenu, closeMenu] = useContextMenu(); const activeSpace = useEventEmitterState(SpaceStore.instance, UPDATE_SELECTED_SPACE, () => { return SpaceStore.instance.activeSpaceRoom; }); const showCreateRoom = shouldShowComponent(UIComponent.CreateRooms); const videoRoomsEnabled = useFeatureEnabled("feature_video_rooms"); const elementCallVideoRoomsEnabled = useFeatureEnabled("feature_element_call_video_rooms"); let contextMenuContent: JSX.Element | undefined; if (menuDisplayed && activeSpace) { const canAddRooms = activeSpace.currentState.maySendStateEvent( EventType.SpaceChild, MatrixClientPeg.get().getUserId()!, ); contextMenuContent = ( { e.preventDefault(); e.stopPropagation(); closeMenu(); defaultDispatcher.dispatch({ action: Action.ViewRoom, room_id: activeSpace.roomId, metricsTrigger: undefined, // other }); PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); }} /> {showCreateRoom ? ( <> { e.preventDefault(); e.stopPropagation(); closeMenu(); showCreateNewRoom(activeSpace); PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuCreateRoomItem", e); }} disabled={!canAddRooms} tooltip={ canAddRooms ? undefined : _t("You do not have permissions to create new rooms in this space") } /> {videoRoomsEnabled && ( { e.preventDefault(); e.stopPropagation(); closeMenu(); showCreateNewRoom( activeSpace, elementCallVideoRoomsEnabled ? RoomType.UnstableCall : RoomType.ElementVideo, ); }} disabled={!canAddRooms} tooltip={ canAddRooms ? undefined : _t("You do not have permissions to create new rooms in this space") } > )} { e.preventDefault(); e.stopPropagation(); closeMenu(); showAddExistingRooms(activeSpace); }} disabled={!canAddRooms} tooltip={ canAddRooms ? undefined : _t("You do not have permissions to add rooms to this space") } /> ) : null} ); } else if (menuDisplayed) { contextMenuContent = ( {showCreateRoom && ( <> { e.preventDefault(); e.stopPropagation(); closeMenu(); defaultDispatcher.dispatch({ action: "view_create_room" }); PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuCreateRoomItem", e); }} /> {videoRoomsEnabled && ( { e.preventDefault(); e.stopPropagation(); closeMenu(); defaultDispatcher.dispatch({ action: "view_create_room", type: elementCallVideoRoomsEnabled ? RoomType.UnstableCall : RoomType.ElementVideo, }); }} > )} )} { e.preventDefault(); e.stopPropagation(); closeMenu(); PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); defaultDispatcher.fire(Action.ViewRoomDirectory); }} /> ); } let contextMenu: JSX.Element | null = null; if (menuDisplayed) { contextMenu = ( {contextMenuContent} ); } return ( <> {contextMenu} ); }; const TAG_AESTHETICS: TagAestheticsMap = { [DefaultTagID.Invite]: { sectionLabel: _td("Invites"), isInvite: true, defaultHidden: false, }, [DefaultTagID.Favourite]: { sectionLabel: _td("Favourites"), isInvite: false, defaultHidden: false, }, [DefaultTagID.SavedItems]: { sectionLabel: _td("Saved Items"), isInvite: false, defaultHidden: false, }, [DefaultTagID.DM]: { sectionLabel: _td("People"), isInvite: false, defaultHidden: false, AuxButtonComponent: DmAuxButton, }, [DefaultTagID.Untagged]: { sectionLabel: _td("Rooms"), isInvite: false, defaultHidden: false, AuxButtonComponent: UntaggedAuxButton, }, [DefaultTagID.LowPriority]: { sectionLabel: _td("Low priority"), isInvite: false, defaultHidden: false, }, [DefaultTagID.ServerNotice]: { sectionLabel: _td("System Alerts"), isInvite: false, defaultHidden: false, }, // TODO: Replace with archived view: https://github.com/vector-im/element-web/issues/14038 [DefaultTagID.Archived]: { sectionLabel: _td("Historical"), isInvite: false, defaultHidden: true, }, [DefaultTagID.Suggested]: { sectionLabel: _td("Suggested Rooms"), isInvite: false, defaultHidden: false, }, }; export default class RoomList extends React.PureComponent { private dispatcherRef?: string; private treeRef = createRef(); private favouriteMessageWatcher: string; public static contextType = MatrixClientContext; public context!: React.ContextType; public constructor(props: IProps) { super(props); this.state = { sublists: {}, suggestedRooms: SpaceStore.instance.suggestedRooms, feature_favourite_messages: SettingsStore.getValue("feature_favourite_messages"), }; } public componentDidMount(): void { this.dispatcherRef = defaultDispatcher.register(this.onAction); SdkContextClass.instance.roomViewStore.on(UPDATE_EVENT, this.onRoomViewStoreUpdate); SpaceStore.instance.on(UPDATE_SUGGESTED_ROOMS, this.updateSuggestedRooms); RoomListStore.instance.on(LISTS_UPDATE_EVENT, this.updateLists); this.favouriteMessageWatcher = SettingsStore.watchSetting( "feature_favourite_messages", null, (...[, , , value]) => { this.setState({ feature_favourite_messages: value }); }, ); this.updateLists(); // trigger the first update } public componentWillUnmount(): void { SpaceStore.instance.off(UPDATE_SUGGESTED_ROOMS, this.updateSuggestedRooms); RoomListStore.instance.off(LISTS_UPDATE_EVENT, this.updateLists); SettingsStore.unwatchSetting(this.favouriteMessageWatcher); if (this.dispatcherRef) defaultDispatcher.unregister(this.dispatcherRef); SdkContextClass.instance.roomViewStore.off(UPDATE_EVENT, this.onRoomViewStoreUpdate); } private onRoomViewStoreUpdate = (): void => { this.setState({ currentRoomId: SdkContextClass.instance.roomViewStore.getRoomId() ?? undefined, }); }; private onAction = (payload: ActionPayload): void => { if (payload.action === Action.ViewRoomDelta) { const viewRoomDeltaPayload = payload as ViewRoomDeltaPayload; const currentRoomId = SdkContextClass.instance.roomViewStore.getRoomId(); const room = this.getRoomDelta(currentRoomId, viewRoomDeltaPayload.delta, viewRoomDeltaPayload.unread); if (room) { defaultDispatcher.dispatch({ action: Action.ViewRoom, room_id: room.roomId, show_room_tile: true, // to make sure the room gets scrolled into view metricsTrigger: "WebKeyboardShortcut", metricsViaKeyboard: true, }); } } else if (payload.action === Action.PstnSupportUpdated) { this.updateLists(); } }; private getRoomDelta = (roomId: string, delta: number, unread = false): Room => { const lists = RoomListStore.instance.orderedLists; const rooms: Room[] = []; TAG_ORDER.forEach((t) => { let listRooms = lists[t]; if (unread) { // filter to only notification rooms (and our current active room so we can index properly) listRooms = listRooms.filter((r) => { const state = RoomNotificationStateStore.instance.getRoomState(r); return state.room.roomId === roomId || state.isUnread; }); } rooms.push(...listRooms); }); const currentIndex = rooms.findIndex((r) => r.roomId === roomId); // use slice to account for looping around the start const [room] = rooms.slice((currentIndex + delta) % rooms.length); return room; }; private updateSuggestedRooms = (suggestedRooms: ISuggestedRoom[]): void => { this.setState({ suggestedRooms }); }; private updateLists = (): void => { const newLists = RoomListStore.instance.orderedLists; const previousListIds = Object.keys(this.state.sublists); const newListIds = Object.keys(newLists); let doUpdate = arrayHasDiff(previousListIds, newListIds); if (!doUpdate) { // so we didn't have the visible sublists change, but did the contents of those // sublists change significantly enough to break the sticky headers? Probably, so // let's check the length of each. for (const tagId of newListIds) { const oldRooms = this.state.sublists[tagId]; const newRooms = newLists[tagId]; if (oldRooms.length !== newRooms.length) { doUpdate = true; break; } } } if (doUpdate) { // We have to break our reference to the room list store if we want to be able to // diff the object for changes, so do that. // @ts-ignore - ITagMap is ts-ignored so this will have to be too const newSublists = objectWithOnly(newLists, newListIds); const sublists = objectShallowClone(newSublists, (k, v) => arrayFastClone(v)); this.setState({ sublists }, () => { this.props.onResize(); }); } }; private renderSuggestedRooms(): ReactComponentElement[] { return this.state.suggestedRooms.map((room) => { const name = room.name || room.canonical_alias || room.aliases?.[0] || _t("Empty room"); const avatar = ( ); const viewRoom = (ev: SyntheticEvent): void => { defaultDispatcher.dispatch({ action: Action.ViewRoom, room_alias: room.canonical_alias || room.aliases?.[0], room_id: room.room_id, via_servers: room.viaServers, oob_data: { avatarUrl: room.avatar_url, name, }, metricsTrigger: "RoomList", metricsViaKeyboard: ev.type !== "click", }); }; return ( ); }); } private renderFavoriteMessagesList(): ReactComponentElement[] { const avatar = ( ); return [ ""} key="favMessagesTile_key" />, ]; } private renderSublists(): React.ReactElement[] { // show a skeleton UI if the user is in no rooms and they are not filtering and have no suggested rooms const showSkeleton = !this.state.suggestedRooms?.length && Object.values(RoomListStore.instance.orderedLists).every((list) => !list?.length); return TAG_ORDER.map((orderedTagId) => { let extraTiles: ReactComponentElement[] | undefined; if (orderedTagId === DefaultTagID.Suggested) { extraTiles = this.renderSuggestedRooms(); } else if (this.state.feature_favourite_messages && orderedTagId === DefaultTagID.SavedItems) { extraTiles = this.renderFavoriteMessagesList(); } const aesthetics = TAG_AESTHETICS[orderedTagId]; if (!aesthetics) throw new Error(`Tag ${orderedTagId} does not have aesthetics`); let alwaysVisible = ALWAYS_VISIBLE_TAGS.includes(orderedTagId); if ( (this.props.activeSpace === MetaSpace.Favourites && orderedTagId !== DefaultTagID.Favourite) || (this.props.activeSpace === MetaSpace.People && orderedTagId !== DefaultTagID.DM) || (this.props.activeSpace === MetaSpace.Orphans && orderedTagId === DefaultTagID.DM) || (!isMetaSpace(this.props.activeSpace) && orderedTagId === DefaultTagID.DM && !SettingsStore.getValue("Spaces.showPeopleInSpace", this.props.activeSpace)) ) { alwaysVisible = false; } let forceExpanded = false; if ( (this.props.activeSpace === MetaSpace.Favourites && orderedTagId === DefaultTagID.Favourite) || (this.props.activeSpace === MetaSpace.People && orderedTagId === DefaultTagID.DM) ) { forceExpanded = true; } // The cost of mounting/unmounting this component offsets the cost // of keeping it in the DOM and hiding it when it is not required return ( ); }); } public focus(): void { // focus the first focusable element in this aria treeview widget const treeItems = this.treeRef.current?.querySelectorAll('[role="treeitem"]'); if (!treeItems) return; [...treeItems].find((e) => e.offsetParent !== null)?.focus(); } public render(): React.ReactNode { const sublists = this.renderSublists(); return ( {({ onKeyDownHandler }) => (
{sublists}
)}
); } }