/* Copyright 2015, 2016 OpenMarket Ltd Copyright 2017, 2018 Vector Creations Ltd Copyright 2020 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 * as React from "react"; import { Dispatcher } from "flux"; import { Room } from "matrix-js-sdk/src/models/room"; import * as fbEmitter from "fbemitter"; import { _t, _td } from "../../../languageHandler"; import { RovingTabIndexProvider } from "../../../accessibility/RovingTabIndex"; import { ResizeNotifier } from "../../../utils/ResizeNotifier"; import RoomListStore, { LISTS_UPDATE_EVENT } from "../../../stores/room-list/RoomListStore"; import RoomViewStore from "../../../stores/RoomViewStore"; import { ITagMap } from "../../../stores/room-list/algorithms/models"; import { DefaultTagID, isCustomTag, TagID } from "../../../stores/room-list/models"; import dis from "../../../dispatcher/dispatcher"; import defaultDispatcher from "../../../dispatcher/dispatcher"; import RoomSublist from "./RoomSublist"; import { ActionPayload } from "../../../dispatcher/payloads"; import { MatrixClientPeg } from "../../../MatrixClientPeg"; import GroupAvatar from "../avatars/GroupAvatar"; import TemporaryTile from "./TemporaryTile"; import { StaticNotificationState } from "../../../stores/notifications/StaticNotificationState"; import { NotificationColor } from "../../../stores/notifications/NotificationColor"; import { Action } from "../../../dispatcher/actions"; import { ViewRoomDeltaPayload } from "../../../dispatcher/payloads/ViewRoomDeltaPayload"; import { RoomNotificationStateStore } from "../../../stores/notifications/RoomNotificationStateStore"; import SettingsStore from "../../../settings/SettingsStore"; import CustomRoomTagStore from "../../../stores/CustomRoomTagStore"; import { arrayFastClone, arrayHasDiff } from "../../../utils/arrays"; import { objectShallowClone, objectWithOnly } from "../../../utils/objects"; import { IconizedContextMenuOption, IconizedContextMenuOptionList } from "../context_menus/IconizedContextMenu"; import AccessibleButton from "../elements/AccessibleButton"; import { CommunityPrototypeStore } from "../../../stores/CommunityPrototypeStore"; import CallHandler from "../../../CallHandler"; import SpaceStore, { SUGGESTED_ROOMS } from "../../../stores/SpaceStore"; import { showAddExistingRooms, showCreateNewRoom } from "../../../utils/space"; import { EventType } from "matrix-js-sdk/src/@types/event"; import { ISpaceSummaryRoom } from "../../structures/SpaceRoomDirectory"; import RoomAvatar from "../avatars/RoomAvatar"; interface IProps { onKeyDown: (ev: React.KeyboardEvent) => void; onFocus: (ev: React.FocusEvent) => void; onBlur: (ev: React.FocusEvent) => void; onResize: () => void; resizeNotifier: ResizeNotifier; isMinimized: boolean; } interface IState { sublists: ITagMap; isNameFiltering: boolean; currentRoomId?: string; suggestedRooms: ISpaceSummaryRoom[]; } const TAG_ORDER: TagID[] = [ DefaultTagID.Invite, DefaultTagID.Favourite, DefaultTagID.DM, DefaultTagID.Untagged, // -- Custom Tags Placeholder -- DefaultTagID.LowPriority, DefaultTagID.ServerNotice, DefaultTagID.Suggested, DefaultTagID.Archived, ]; const CUSTOM_TAGS_BEFORE_TAG = DefaultTagID.LowPriority; const ALWAYS_VISIBLE_TAGS: TagID[] = [ DefaultTagID.DM, DefaultTagID.Untagged, ]; interface ITagAesthetics { sectionLabel: string; sectionLabelRaw?: string; addRoomLabel?: string; onAddRoom?: (dispatcher?: Dispatcher) => void; addRoomContextMenu?: (onFinished: () => void) => React.ReactNode; isInvite: boolean; defaultHidden: boolean; } interface ITagAestheticsMap { // @ts-ignore - TS wants this to be a string but we know better [tagId: TagID]: ITagAesthetics; } // If we have no dialer support, we just show the create chat dialog const dmOnAddRoom = (dispatcher?: Dispatcher) => { (dispatcher || defaultDispatcher).dispatch({action: 'view_create_chat'}); }; // If we have dialer support, show a context menu so the user can pick between // the dialer and the create chat dialog const dmAddRoomContextMenu = (onFinished: () => void) => { return { e.preventDefault(); e.stopPropagation(); onFinished(); defaultDispatcher.dispatch({action: "view_create_chat"}); }} /> { e.preventDefault(); e.stopPropagation(); onFinished(); defaultDispatcher.fire(Action.OpenDialPad); }} /> ; }; const TAG_AESTHETICS: ITagAestheticsMap = { [DefaultTagID.Invite]: { sectionLabel: _td("Invites"), isInvite: true, defaultHidden: false, }, [DefaultTagID.Favourite]: { sectionLabel: _td("Favourites"), isInvite: false, defaultHidden: false, }, [DefaultTagID.DM]: { sectionLabel: _td("People"), isInvite: false, defaultHidden: false, addRoomLabel: _td("Start chat"), // Either onAddRoom or addRoomContextMenu are set depending on whether we // have dialer support. }, [DefaultTagID.Untagged]: { sectionLabel: _td("Rooms"), isInvite: false, defaultHidden: false, addRoomLabel: _td("Add room"), addRoomContextMenu: (onFinished: () => void) => { if (SpaceStore.instance.activeSpace) { const canAddRooms = SpaceStore.instance.activeSpace.currentState.maySendStateEvent(EventType.SpaceChild, MatrixClientPeg.get().getUserId()); return { e.preventDefault(); e.stopPropagation(); onFinished(); showCreateNewRoom(MatrixClientPeg.get(), SpaceStore.instance.activeSpace); }} disabled={!canAddRooms} tooltip={canAddRooms ? undefined : _t("You do not have permissions to create new rooms in this space")} /> { e.preventDefault(); e.stopPropagation(); onFinished(); showAddExistingRooms(MatrixClientPeg.get(), SpaceStore.instance.activeSpace); }} disabled={!canAddRooms} tooltip={canAddRooms ? undefined : _t("You do not have permissions to add rooms to this space")} /> { e.preventDefault(); e.stopPropagation(); onFinished(); defaultDispatcher.fire(Action.ViewRoomDirectory); }} /> ; } return { e.preventDefault(); e.stopPropagation(); onFinished(); defaultDispatcher.dispatch({action: "view_create_room"}); }} /> { e.preventDefault(); e.stopPropagation(); onFinished(); defaultDispatcher.fire(Action.ViewRoomDirectory); }} /> ; }, }, [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, }, }; function customTagAesthetics(tagId: TagID): ITagAesthetics { if (tagId.startsWith("u.")) { tagId = tagId.substring(2); } return { sectionLabel: _td("Custom Tag"), sectionLabelRaw: tagId, isInvite: false, defaultHidden: false, }; } export default class RoomList extends React.PureComponent { private dispatcherRef; private customTagStoreRef; private tagAesthetics: ITagAestheticsMap; private roomStoreToken: fbEmitter.EventSubscription; constructor(props: IProps) { super(props); this.state = { sublists: {}, isNameFiltering: !!RoomListStore.instance.getFirstNameFilterCondition(), suggestedRooms: SpaceStore.instance.suggestedRooms, }; // shallow-copy from the template as we need to make modifications to it this.tagAesthetics = objectShallowClone(TAG_AESTHETICS); this.updateDmAddRoomAction(); this.dispatcherRef = defaultDispatcher.register(this.onAction); this.roomStoreToken = RoomViewStore.addListener(this.onRoomViewStoreUpdate); } public componentDidMount(): void { SpaceStore.instance.on(SUGGESTED_ROOMS, this.updateSuggestedRooms); RoomListStore.instance.on(LISTS_UPDATE_EVENT, this.updateLists); this.customTagStoreRef = CustomRoomTagStore.addListener(this.updateLists); this.updateLists(); // trigger the first update } public componentWillUnmount() { SpaceStore.instance.off(SUGGESTED_ROOMS, this.updateSuggestedRooms); RoomListStore.instance.off(LISTS_UPDATE_EVENT, this.updateLists); defaultDispatcher.unregister(this.dispatcherRef); if (this.customTagStoreRef) this.customTagStoreRef.remove(); if (this.roomStoreToken) this.roomStoreToken.remove(); } private onRoomViewStoreUpdate = () => { this.setState({ currentRoomId: RoomViewStore.getRoomId(), }); }; private updateDmAddRoomAction() { const dmTagAesthetics = objectShallowClone(TAG_AESTHETICS[DefaultTagID.DM]); if (CallHandler.sharedInstance().getSupportsPstnProtocol()) { dmTagAesthetics.addRoomContextMenu = dmAddRoomContextMenu; } else { dmTagAesthetics.onAddRoom = dmOnAddRoom; } this.tagAesthetics[DefaultTagID.DM] = dmTagAesthetics; } private onAction = (payload: ActionPayload) => { if (payload.action === Action.ViewRoomDelta) { const viewRoomDeltaPayload = payload as ViewRoomDeltaPayload; const currentRoomId = RoomViewStore.getRoomId(); const room = this.getRoomDelta(currentRoomId, viewRoomDeltaPayload.delta, viewRoomDeltaPayload.unread); if (room) { dis.dispatch({ action: 'view_room', room_id: room.roomId, show_room_tile: true, // to make sure the room gets scrolled into view }); } } else if (payload.action === Action.PstnSupportUpdated) { this.updateDmAddRoomAction(); this.updateLists(); } }; private getRoomDelta = (roomId: string, delta: number, unread = false) => { 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: ISpaceSummaryRoom[]) => { this.setState({ suggestedRooms }); }; private updateLists = () => { const newLists = RoomListStore.instance.orderedLists; if (SettingsStore.getValue("advancedRoomListLogging")) { // TODO: Remove debug: https://github.com/vector-im/element-web/issues/14602 console.log("new lists", newLists); } const previousListIds = Object.keys(this.state.sublists); const newListIds = Object.keys(newLists).filter(t => { if (!isCustomTag(t)) return true; // always include non-custom tags // if the tag is custom though, only include it if it is enabled return CustomRoomTagStore.getTags()[t]; }); const isNameFiltering = !!RoomListStore.instance.getFirstNameFilterCondition(); let doUpdate = this.state.isNameFiltering !== isNameFiltering || 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, isNameFiltering}, () => { this.props.onResize(); }); } }; private onStartChat = () => { const initialText = RoomListStore.instance.getFirstNameFilterCondition()?.search; dis.dispatch({ action: "view_create_chat", initialText }); }; private onExplore = () => { const initialText = RoomListStore.instance.getFirstNameFilterCondition()?.search; dis.dispatch({ action: Action.ViewRoomDirectory, initialText }); }; private renderSuggestedRooms(): JSX.Element[] { return this.state.suggestedRooms.map(room => { const name = room.name || room.canonical_alias || room.aliases.pop() || _t("Empty room"); const avatar = ( ); const viewRoom = () => { defaultDispatcher.dispatch({ action: "view_room", room_id: room.room_id, }); }; return ( ); }); } private renderCommunityInvites(): TemporaryTile[] { // TODO: Put community invites in a more sensible place (not in the room list) // See https://github.com/vector-im/element-web/issues/14456 return MatrixClientPeg.get().getGroups().filter(g => { return g.myMembership === 'invite'; }).map(g => { const avatar = ( ); const openGroup = () => { defaultDispatcher.dispatch({ action: 'view_group', group_id: g.groupId, }); }; return ( ); }); } private renderSublists(): React.ReactElement[] { const components: React.ReactElement[] = []; const tagOrder = TAG_ORDER.reduce((p, c) => { if (c === CUSTOM_TAGS_BEFORE_TAG) { const customTags = Object.keys(this.state.sublists) .filter(t => isCustomTag(t)); p.push(...customTags); } p.push(c); return p; }, [] as TagID[]); // show a skeleton UI if the user is in no rooms and they are not filtering const showSkeleton = !this.state.isNameFiltering && Object.values(RoomListStore.instance.unfilteredLists).every(list => !list?.length); for (const orderedTagId of tagOrder) { const orderedRooms = this.state.sublists[orderedTagId] || []; let extraTiles = null; if (orderedTagId === DefaultTagID.Invite) { extraTiles = this.renderCommunityInvites(); } else if (orderedTagId === DefaultTagID.Suggested) { extraTiles = this.renderSuggestedRooms(); } const totalTiles = orderedRooms.length + (extraTiles ? extraTiles.length : 0); if (totalTiles === 0 && !ALWAYS_VISIBLE_TAGS.includes(orderedTagId)) { continue; // skip tag - not needed } const aesthetics: ITagAesthetics = isCustomTag(orderedTagId) ? customTagAesthetics(orderedTagId) : this.tagAesthetics[orderedTagId]; if (!aesthetics) throw new Error(`Tag ${orderedTagId} does not have aesthetics`); components.push(); } return components; } public render() { let explorePrompt: JSX.Element; if (!this.props.isMinimized) { if (this.state.isNameFiltering) { explorePrompt =
{_t("Can't see what you’re looking for?")}
{_t("Start a new chat")} {_t("Explore all public rooms")}
; } else if (Object.values(this.state.sublists).some(list => list.length > 0)) { const unfilteredLists = RoomListStore.instance.unfilteredLists const unfilteredRooms = unfilteredLists[DefaultTagID.Untagged] || []; const unfilteredHistorical = unfilteredLists[DefaultTagID.Archived] || []; const unfilteredFavourite = unfilteredLists[DefaultTagID.Favourite] || []; // show a prompt to join/create rooms if the user is in 0 rooms and no historical if (unfilteredRooms.length < 1 && unfilteredHistorical < 1 && unfilteredFavourite < 1) { explorePrompt =
{_t("Use the + to make a new room or explore existing ones below")}
{_t("Start a new chat")} {_t("Explore all public rooms")}
; } } } const sublists = this.renderSublists(); return ( {({onKeyDownHandler}) => (
{sublists} {explorePrompt}
)}
); } }