/* 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 { EventType, RoomType } from "matrix-js-sdk/src/@types/event"; import { JoinRule, Preset } from "matrix-js-sdk/src/@types/partials"; import { logger } from "matrix-js-sdk/src/logger"; import { Room, RoomEvent } from "matrix-js-sdk/src/models/room"; import React, { RefObject, useCallback, useContext, useRef, useState } from "react"; import MatrixClientContext from "../../contexts/MatrixClientContext"; import createRoom, { IOpts } from "../../createRoom"; import { shouldShowComponent } from "../../customisations/helpers/UIComponents"; import { Action } from "../../dispatcher/actions"; import defaultDispatcher from "../../dispatcher/dispatcher"; import { ActionPayload } from "../../dispatcher/payloads"; import { ViewRoomPayload } from "../../dispatcher/payloads/ViewRoomPayload"; import * as Email from "../../email"; import { useEventEmitterState } from "../../hooks/useEventEmitter"; import { useMyRoomMembership } from "../../hooks/useRoomMembers"; import { useFeatureEnabled } from "../../hooks/useSettings"; import { useStateArray } from "../../hooks/useStateArray"; import { _t } from "../../languageHandler"; import PosthogTrackers from "../../PosthogTrackers"; import { inviteMultipleToRoom, showRoomInviteDialog } from "../../RoomInvite"; import { UIComponent } from "../../settings/UIFeature"; import { UPDATE_EVENT } from "../../stores/AsyncStore"; import RightPanelStore from "../../stores/right-panel/RightPanelStore"; import { IRightPanelCard } from "../../stores/right-panel/RightPanelStoreIPanelState"; import { RightPanelPhases } from "../../stores/right-panel/RightPanelStorePhases"; import ResizeNotifier from "../../utils/ResizeNotifier"; import { shouldShowSpaceInvite, shouldShowSpaceSettings, showAddExistingRooms, showCreateNewRoom, showCreateNewSubspace, showSpaceInvite, showSpaceSettings, } from "../../utils/space"; import RoomAvatar from "../views/avatars/RoomAvatar"; import { BetaPill } from "../views/beta/BetaCard"; import IconizedContextMenu, { IconizedContextMenuOption, IconizedContextMenuOptionList, } from "../views/context_menus/IconizedContextMenu"; import { AddExistingToSpace, defaultDmsRenderer, defaultRoomsRenderer, } from "../views/dialogs/AddExistingToSpaceDialog"; import AccessibleButton, { ButtonEvent } from "../views/elements/AccessibleButton"; import AccessibleTooltipButton from "../views/elements/AccessibleTooltipButton"; import ErrorBoundary from "../views/elements/ErrorBoundary"; import Field from "../views/elements/Field"; import RoomFacePile from "../views/elements/RoomFacePile"; import RoomName from "../views/elements/RoomName"; import RoomTopic from "../views/elements/RoomTopic"; import withValidation from "../views/elements/Validation"; import RoomInfoLine from "../views/rooms/RoomInfoLine"; import RoomPreviewCard from "../views/rooms/RoomPreviewCard"; import { SpaceFeedbackPrompt } from "../views/spaces/SpaceCreateMenu"; import SpacePublicShare from "../views/spaces/SpacePublicShare"; import { ChevronFace, ContextMenuButton, useContextMenu } from "./ContextMenu"; import MainSplit from "./MainSplit"; import RightPanel from "./RightPanel"; import SpaceHierarchy, { showRoom } from "./SpaceHierarchy"; interface IProps { space: Room; justCreatedOpts?: IOpts; resizeNotifier: ResizeNotifier; onJoinButtonClicked(): void; onRejectButtonClicked(): void; } interface IState { phase: Phase; firstRoomId?: string; // internal state for the creation wizard showRightPanel: boolean; myMembership: string; } enum Phase { Landing, PublicCreateRooms, PublicShare, PrivateScope, PrivateInvite, PrivateCreateRooms, PrivateExistingRooms, } const SpaceLandingAddButton: React.FC<{ space: Room }> = ({ space }) => { const [menuDisplayed, handle, openMenu, closeMenu] = useContextMenu(); const canCreateRoom = shouldShowComponent(UIComponent.CreateRooms); const canCreateSpace = shouldShowComponent(UIComponent.CreateSpaces); const videoRoomsEnabled = useFeatureEnabled("feature_video_rooms"); const elementCallVideoRoomsEnabled = useFeatureEnabled("feature_element_call_video_rooms"); let contextMenu: JSX.Element | null = null; if (menuDisplayed) { const rect = handle.current.getBoundingClientRect(); contextMenu = ( {canCreateRoom && ( <> => { e.preventDefault(); e.stopPropagation(); closeMenu(); PosthogTrackers.trackInteraction("WebSpaceHomeCreateRoomButton", e); if (await showCreateNewRoom(space)) { defaultDispatcher.fire(Action.UpdateSpaceHierarchy); } }} /> {videoRoomsEnabled && ( => { e.preventDefault(); e.stopPropagation(); closeMenu(); if ( await showCreateNewRoom( space, elementCallVideoRoomsEnabled ? RoomType.UnstableCall : RoomType.ElementVideo, ) ) { defaultDispatcher.fire(Action.UpdateSpaceHierarchy); } }} > )} )} { e.preventDefault(); e.stopPropagation(); closeMenu(); showAddExistingRooms(space); }} /> {canCreateSpace && ( { e.preventDefault(); e.stopPropagation(); closeMenu(); showCreateNewSubspace(space); }} > )} ); } return ( <> {_t("Add")} {contextMenu} ); }; const SpaceLanding: React.FC<{ space: Room }> = ({ space }) => { const cli = useContext(MatrixClientContext); const myMembership = useMyRoomMembership(space); const userId = cli.getUserId(); const storeIsShowingSpaceMembers = useCallback( () => RightPanelStore.instance.isOpenForRoom(space.roomId) && RightPanelStore.instance.currentCardForRoom(space.roomId)?.phase === RightPanelPhases.SpaceMemberList, [space.roomId], ); const isShowingMembers = useEventEmitterState(RightPanelStore.instance, UPDATE_EVENT, storeIsShowingSpaceMembers); let inviteButton; if (shouldShowSpaceInvite(space) && shouldShowComponent(UIComponent.InviteUsers)) { inviteButton = ( { showSpaceInvite(space); }} > {_t("Invite")} ); } const hasAddRoomPermissions = myMembership === "join" && space.currentState.maySendStateEvent(EventType.SpaceChild, userId); let addRoomButton; if (hasAddRoomPermissions) { addRoomButton = ; } let settingsButton; if (shouldShowSpaceSettings(space)) { settingsButton = ( { showSpaceSettings(space); }} title={_t("Settings")} /> ); } const onMembersClick = (): void => { RightPanelStore.instance.setCard({ phase: RightPanelPhases.SpaceMemberList }); }; return (
{(name) => { const tags = { name: () =>

{name}

}; return _t("Welcome to ", {}, tags) as JSX.Element; }}
{inviteButton} {settingsButton}
); }; const SpaceSetupFirstRooms: React.FC<{ space: Room; title: string; description: JSX.Element; onFinished(firstRoomId?: string): void; }> = ({ space, title, description, onFinished }) => { const [busy, setBusy] = useState(false); const [error, setError] = useState(""); const numFields = 3; const placeholders = [_t("General"), _t("Random"), _t("Support")]; const [roomNames, setRoomName] = useStateArray(numFields, [_t("General"), _t("Random"), ""]); const fields = new Array(numFields).fill(0).map((x, i) => { const name = "roomName" + i; return ( setRoomName(i, ev.target.value)} autoFocus={i === 2} disabled={busy} autoComplete="off" /> ); }); const onNextClick = async (ev: ButtonEvent): Promise => { ev.preventDefault(); if (busy) return; setError(""); setBusy(true); try { const isPublic = space.getJoinRule() === JoinRule.Public; const filteredRoomNames = roomNames.map((name) => name.trim()).filter(Boolean); const roomIds = await Promise.all( filteredRoomNames.map((name) => { return createRoom({ createOpts: { preset: isPublic ? Preset.PublicChat : Preset.PrivateChat, name, }, spinner: false, encryption: false, andView: false, inlineErrors: true, parentSpace: space, joinRule: !isPublic ? JoinRule.Restricted : undefined, suggested: true, }); }), ); onFinished(roomIds[0]); } catch (e) { logger.error("Failed to create initial space rooms", e); setError(_t("Failed to create initial space rooms")); } setBusy(false); }; let onClick = (ev: ButtonEvent): void => { ev.preventDefault(); onFinished(); }; let buttonLabel = _t("Skip for now"); if (roomNames.some((name) => name.trim())) { onClick = onNextClick; buttonLabel = busy ? _t("Creating rooms...") : _t("Continue"); } return (

{title}

{description}
{error &&
{error}
}
{fields}
); }; const SpaceAddExistingRooms: React.FC<{ space: Room; onFinished(): void; }> = ({ space, onFinished }) => { return (

{_t("What do you want to organise?")}

{_t( "Pick rooms or conversations to add. This is just a space for you, " + "no one will be informed. You can add more later.", )}
{_t("Skip for now")} } filterPlaceholder={_t("Search for rooms or spaces")} onFinished={onFinished} roomsRenderer={defaultRoomsRenderer} dmsRenderer={defaultDmsRenderer} />
); }; interface ISpaceSetupPublicShareProps extends Pick { onFinished(): void; } const SpaceSetupPublicShare: React.FC = ({ justCreatedOpts, space, onFinished, firstRoomId, }) => { return (

{_t("Share %(name)s", { name: justCreatedOpts?.createOpts?.name || space.name, })}

{_t("It's just you at the moment, it will be even better with others.")}
{firstRoomId ? _t("Go to my first room") : _t("Go to my space")}
); }; const SpaceSetupPrivateScope: React.FC<{ space: Room; justCreatedOpts: IOpts; onFinished(createRooms: boolean): void; }> = ({ space, justCreatedOpts, onFinished }) => { return (

{_t("Who are you working with?")}

{_t("Make sure the right people have access to %(name)s", { name: justCreatedOpts?.createOpts?.name || space.name, })}
{ onFinished(false); }} >

{_t("Just me")}

{_t("A private space to organise your rooms")}
{ onFinished(true); }} >

{_t("Me and my teammates")}

{_t("A private space for you and your teammates")}
); }; const validateEmailRules = withValidation({ rules: [ { key: "email", test: ({ value }) => !value || Email.looksValid(value), invalid: () => _t("Doesn't look like a valid email address"), }, ], }); const SpaceSetupPrivateInvite: React.FC<{ space: Room; onFinished(): void; }> = ({ space, onFinished }) => { const [busy, setBusy] = useState(false); const [error, setError] = useState(""); const numFields = 3; const fieldRefs: RefObject[] = [useRef(), useRef(), useRef()]; const [emailAddresses, setEmailAddress] = useStateArray(numFields, ""); const fields = new Array(numFields).fill(0).map((x, i) => { const name = "emailAddress" + i; return ( ) => setEmailAddress(i, ev.target.value)} ref={fieldRefs[i]} onValidate={validateEmailRules} autoFocus={i === 0} disabled={busy} /> ); }); const onNextClick = async (ev: ButtonEvent): Promise => { ev.preventDefault(); if (busy) return; setError(""); for (const fieldRef of fieldRefs) { const valid = await fieldRef.current.validate({ allowEmpty: true }); if (valid === false) { // true/null are allowed fieldRef.current.focus(); fieldRef.current.validate({ allowEmpty: true, focused: true }); return; } } setBusy(true); const targetIds = emailAddresses.map((name) => name.trim()).filter(Boolean); try { const result = await inviteMultipleToRoom(space.roomId, targetIds); const failedUsers = Object.keys(result.states).filter((a) => result.states[a] === "error"); if (failedUsers.length > 0) { logger.log("Failed to invite users to space: ", result); setError( _t("Failed to invite the following users to your space: %(csvUsers)s", { csvUsers: failedUsers.join(", "), }), ); } else { onFinished(); } } catch (err) { logger.error("Failed to invite users to space: ", err); setError(_t("We couldn't invite those users. Please check the users you want to invite and try again.")); } setBusy(false); }; let onClick = (ev: ButtonEvent): void => { ev.preventDefault(); onFinished(); }; let buttonLabel = _t("Skip for now"); if (emailAddresses.some((name) => name.trim())) { onClick = onNextClick; buttonLabel = busy ? _t("Inviting...") : _t("Continue"); } return (

{_t("Invite your teammates")}

{_t("Make sure the right people have access. You can invite more later.")}
{_t( "This is an experimental feature. For now, " + "new users receiving an invite will have to open the invite on to actually join.", {}, { b: (sub) => {sub}, link: () => ( app.element.io ), }, )}
{error &&
{error}
}
{fields}
showRoomInviteDialog(space.roomId)} > {_t("Invite by username")}
); }; export default class SpaceRoomView extends React.PureComponent { public static contextType = MatrixClientContext; public context!: React.ContextType; private readonly creator: string; private readonly dispatcherRef: string; public constructor(props: IProps, context: React.ContextType) { super(props, context); let phase = Phase.Landing; this.creator = this.props.space.currentState.getStateEvents(EventType.RoomCreate, "")?.getSender(); const showSetup = this.props.justCreatedOpts && context.getUserId() === this.creator; if (showSetup) { phase = this.props.justCreatedOpts.createOpts.preset === Preset.PublicChat ? Phase.PublicCreateRooms : Phase.PrivateScope; } this.state = { phase, showRightPanel: RightPanelStore.instance.isOpenForRoom(this.props.space.roomId), myMembership: this.props.space.getMyMembership(), }; this.dispatcherRef = defaultDispatcher.register(this.onAction); RightPanelStore.instance.on(UPDATE_EVENT, this.onRightPanelStoreUpdate); } public componentDidMount(): void { this.context.on(RoomEvent.MyMembership, this.onMyMembership); } public componentWillUnmount(): void { defaultDispatcher.unregister(this.dispatcherRef); RightPanelStore.instance.off(UPDATE_EVENT, this.onRightPanelStoreUpdate); this.context.off(RoomEvent.MyMembership, this.onMyMembership); } private onMyMembership = (room: Room, myMembership: string): void => { if (room.roomId === this.props.space.roomId) { this.setState({ myMembership }); } }; private onRightPanelStoreUpdate = (): void => { this.setState({ showRightPanel: RightPanelStore.instance.isOpenForRoom(this.props.space.roomId), }); }; private onAction = (payload: ActionPayload): void => { if (payload.action === Action.ViewRoom && payload.room_id === this.props.space.roomId) { this.setState({ phase: Phase.Landing }); return; } if (payload.action !== Action.ViewUser && payload.action !== "view_3pid_invite") return; if (payload.action === Action.ViewUser && payload.member) { const spaceMemberInfoCard: IRightPanelCard = { phase: RightPanelPhases.SpaceMemberInfo, state: { spaceId: this.props.space.roomId, member: payload.member }, }; if (payload.push) { RightPanelStore.instance.pushCard(spaceMemberInfoCard); } else { RightPanelStore.instance.setCards([ { phase: RightPanelPhases.SpaceMemberList, state: { spaceId: this.props.space.roomId } }, spaceMemberInfoCard, ]); } } else if (payload.action === "view_3pid_invite" && payload.event) { RightPanelStore.instance.setCard({ phase: RightPanelPhases.Space3pidMemberInfo, state: { spaceId: this.props.space.roomId, memberInfoEvent: payload.event }, }); } else { RightPanelStore.instance.setCard({ phase: RightPanelPhases.SpaceMemberList, state: { spaceId: this.props.space.roomId }, }); } }; private goToFirstRoom = async (): Promise => { if (this.state.firstRoomId) { defaultDispatcher.dispatch({ action: Action.ViewRoom, room_id: this.state.firstRoomId, metricsTrigger: undefined, // other }); return; } this.setState({ phase: Phase.Landing }); }; private renderBody(): JSX.Element { switch (this.state.phase) { case Phase.Landing: if (this.state.myMembership === "join") { return ; } else { return ( ); } case Phase.PublicCreateRooms: return ( {_t("Let's create a room for each of them.")}
{_t("You can add more later too, including already existing ones.")} } onFinished={(firstRoomId: string) => this.setState({ phase: Phase.PublicShare, firstRoomId })} /> ); case Phase.PublicShare: return ( ); case Phase.PrivateScope: return ( { this.setState({ phase: invite ? Phase.PrivateCreateRooms : Phase.PrivateExistingRooms }); }} /> ); case Phase.PrivateInvite: return ( this.setState({ phase: Phase.Landing })} /> ); case Phase.PrivateCreateRooms: return ( {_t("We'll create rooms for each of them.")}
{_t("You can add more later too, including already existing ones.")} } onFinished={(firstRoomId: string) => this.setState({ phase: Phase.PrivateInvite, firstRoomId })} /> ); case Phase.PrivateExistingRooms: return ( this.setState({ phase: Phase.Landing })} /> ); } } public render(): JSX.Element { const rightPanel = this.state.showRightPanel && this.state.phase === Phase.Landing ? ( ) : null; return (
{this.renderBody()}
); } }