/* Copyright 2019 - 2023 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, ReactNode, SyntheticEvent } from "react"; import classNames from "classnames"; import { RoomMember, Room, MatrixError } from "matrix-js-sdk/src/matrix"; import { MatrixCall } from "matrix-js-sdk/src/webrtc/call"; import { logger } from "matrix-js-sdk/src/logger"; import { uniqBy } from "lodash"; import { Icon as InfoIcon } from "../../../../res/img/element-icons/info.svg"; import { Icon as EmailPillAvatarIcon } from "../../../../res/img/icon-email-pill-avatar.svg"; import { _t, _td } from "../../../languageHandler"; import { MatrixClientPeg } from "../../../MatrixClientPeg"; import { makeRoomPermalink, makeUserPermalink } from "../../../utils/permalinks/Permalinks"; import DMRoomMap from "../../../utils/DMRoomMap"; import SdkConfig from "../../../SdkConfig"; import * as Email from "../../../email"; import { getDefaultIdentityServerUrl, setToDefaultIdentityServer } from "../../../utils/IdentityServerUtils"; import { buildActivityScores, buildMemberScores, compareMembers } from "../../../utils/SortMembers"; import { abbreviateUrl } from "../../../utils/UrlUtils"; import IdentityAuthClient from "../../../IdentityAuthClient"; import { humanizeTime } from "../../../utils/humanize"; import { IInviteResult, inviteMultipleToRoom, showAnyInviteErrors } from "../../../RoomInvite"; import { Action } from "../../../dispatcher/actions"; import { DefaultTagID } from "../../../stores/room-list/models"; import RoomListStore from "../../../stores/room-list/RoomListStore"; import SettingsStore from "../../../settings/SettingsStore"; import { UIFeature } from "../../../settings/UIFeature"; import { mediaFromMxc } from "../../../customisations/Media"; import BaseAvatar from "../avatars/BaseAvatar"; import { SearchResultAvatar } from "../avatars/SearchResultAvatar"; import AccessibleButton, { ButtonEvent } from "../elements/AccessibleButton"; import { selectText } from "../../../utils/strings"; import Field from "../elements/Field"; import TabbedView, { Tab, TabLocation } from "../../structures/TabbedView"; import Dialpad from "../voip/DialPad"; import QuestionDialog from "./QuestionDialog"; import Spinner from "../elements/Spinner"; import BaseDialog from "./BaseDialog"; import DialPadBackspaceButton from "../elements/DialPadBackspaceButton"; import LegacyCallHandler from "../../../LegacyCallHandler"; import UserIdentifierCustomisations from "../../../customisations/UserIdentifier"; import CopyableText from "../elements/CopyableText"; import { ScreenName } from "../../../PosthogTrackers"; import { KeyBindingAction } from "../../../accessibility/KeyboardShortcuts"; import { getKeyBindingsManager } from "../../../KeyBindingsManager"; import { DirectoryMember, IDMUserTileProps, Member, startDmOnFirstMessage, ThreepidMember, } from "../../../utils/direct-messages"; import { InviteKind } from "./InviteDialogTypes"; import Modal from "../../../Modal"; import dis from "../../../dispatcher/dispatcher"; import { privateShouldBeEncrypted } from "../../../utils/rooms"; import { NonEmptyArray } from "../../../@types/common"; import { UNKNOWN_PROFILE_ERRORS } from "../../../utils/MultiInviter"; import AskInviteAnywayDialog, { UnknownProfiles } from "./AskInviteAnywayDialog"; import { SdkContextClass } from "../../../contexts/SDKContext"; import { UserProfilesStore } from "../../../stores/UserProfilesStore"; // we have a number of types defined from the Matrix spec which can't reasonably be altered here. /* eslint-disable camelcase */ const extractTargetUnknownProfiles = async ( targets: Member[], profilesStores: UserProfilesStore, ): Promise => { const directoryMembers = targets.filter((t): t is DirectoryMember => t instanceof DirectoryMember); await Promise.all(directoryMembers.map((t) => profilesStores.getOrFetchProfile(t.userId))); return directoryMembers.reduce((unknownProfiles: UnknownProfiles, target: DirectoryMember) => { const lookupError = profilesStores.getProfileLookupError(target.userId); if ( lookupError instanceof MatrixError && lookupError.errcode && UNKNOWN_PROFILE_ERRORS.includes(lookupError.errcode) ) { unknownProfiles.push({ userId: target.userId, errorText: lookupError.data.error || "", }); } return unknownProfiles; }, []); }; interface Result { userId: string; user: Member; lastActive?: number; } const INITIAL_ROOMS_SHOWN = 3; // Number of rooms to show at first const INCREMENT_ROOMS_SHOWN = 5; // Number of rooms to add when 'show more' is clicked enum TabId { UserDirectory = "users", DialPad = "dialpad", } class DMUserTile extends React.PureComponent { private onRemove = (e: ButtonEvent): void => { // Stop the browser from highlighting text e.preventDefault(); e.stopPropagation(); this.props.onRemove!(this.props.member); }; public render(): React.ReactNode { const avatarSize = 20; const avatar = ; let closeButton; if (this.props.onRemove) { closeButton = ( {_t("Remove")} ); } return ( {avatar} {this.props.member.name} {closeButton} ); } } /** * Converts a RoomMember to a Member. * Returns the Member if it is already a Member. */ const toMember = (member: RoomMember | Member): Member => { return member instanceof RoomMember ? new DirectoryMember({ user_id: member.userId, display_name: member.name, avatar_url: member.getMxcAvatarUrl(), }) : member; }; interface IDMRoomTileProps { member: Member; lastActiveTs?: number; onToggle(member: Member): void; highlightWord: string; isSelected: boolean; } class DMRoomTile extends React.PureComponent { private onClick = (e: ButtonEvent): void => { // Stop the browser from highlighting text e.preventDefault(); e.stopPropagation(); this.props.onToggle(this.props.member); }; private highlightName(str: string): ReactNode { if (!this.props.highlightWord) return str; // We convert things to lowercase for index searching, but pull substrings from // the submitted text to preserve case. Note: we don't need to htmlEntities the // string because React will safely encode the text for us. const lowerStr = str.toLowerCase(); const filterStr = this.props.highlightWord.toLowerCase(); const result: JSX.Element[] = []; let i = 0; let ii: number; while ((ii = lowerStr.indexOf(filterStr, i)) >= 0) { // Push any text we missed (first bit/middle of text) if (ii > i) { // Push any text we aren't highlighting (middle of text match, or beginning of text) result.push({str.substring(i, ii)}); } i = ii; // copy over ii only if we have a match (to preserve i for end-of-text matching) // Highlight the word the user entered const substr = str.substring(i, filterStr.length + i); result.push( {substr} , ); i += substr.length; } // Push any text we missed (end of text) if (i < str.length) { result.push({str.substring(i)}); } return result; } public render(): React.ReactNode { let timestamp: JSX.Element | undefined; if (this.props.lastActiveTs) { const humanTs = humanizeTime(this.props.lastActiveTs); timestamp = {humanTs}; } const avatarSize = 36; const avatar = (this.props.member as ThreepidMember).isEmail ? ( ) : ( ); let checkmark: JSX.Element | undefined; if (this.props.isSelected) { // To reduce flickering we put the 'selected' room tile above the real avatar checkmark =
; } // To reduce flickering we put the checkmark on top of the actual avatar (prevents // the browser from reloading the image source when the avatar remounts). const stackedAvatar = ( {avatar} {checkmark} ); const userIdentifier = UserIdentifierCustomisations.getDisplayUserIdentifier(this.props.member.userId, { withDisplayName: true, }); const caption = (this.props.member as ThreepidMember).isEmail ? _t("Invite by email") : this.highlightName(userIdentifier || this.props.member.userId); return (
{stackedAvatar}
{this.highlightName(this.props.member.name)}
{caption}
{timestamp}
); } } interface BaseProps { // Takes a boolean which is true if a user / users were invited / // a call transfer was initiated or false if the dialog was cancelled // with no action taken. onFinished: (success?: boolean) => void; // Initial value to populate the filter with initialText?: string; } interface InviteDMProps extends BaseProps { // The kind of invite being performed. Assumed to be InviteKind.Dm if not provided. kind?: InviteKind.Dm; } interface InviteRoomProps extends BaseProps { kind: InviteKind.Invite; // The room ID this dialog is for. Only required for InviteKind.Invite. roomId: string; } function isRoomInvite(props: Props): props is InviteRoomProps { return props.kind === InviteKind.Invite; } interface InviteCallProps extends BaseProps { kind: InviteKind.CallTransfer; // The call to transfer. Only required for InviteKind.CallTransfer. call: MatrixCall; } type Props = InviteDMProps | InviteRoomProps | InviteCallProps; interface IInviteDialogState { targets: Member[]; // array of Member objects (see interface above) filterText: string; recents: Result[]; numRecentsShown: number; suggestions: Result[]; numSuggestionsShown: number; serverResultsMixin: Result[]; threepidResultsMixin: Result[]; canUseIdentityServer: boolean; tryingIdentityServer: boolean; consultFirst: boolean; dialPadValue: string; currentTabId: TabId; // These two flags are used for the 'Go' button to communicate what is going on. busy: boolean; errorText?: string; } export default class InviteDialog extends React.PureComponent { public static defaultProps: Partial = { kind: InviteKind.Dm, initialText: "", }; private debounceTimer: number | null = null; // actually number because we're in the browser private editorRef = createRef(); private numberEntryFieldRef: React.RefObject = createRef(); private unmounted = false; private encryptionByDefault = false; private profilesStore: UserProfilesStore; public constructor(props: Props) { super(props); if (props.kind === InviteKind.Invite && !props.roomId) { throw new Error("When using InviteKind.Invite a roomId is required for an InviteDialog"); } else if (props.kind === InviteKind.CallTransfer && !props.call) { throw new Error("When using InviteKind.CallTransfer a call is required for an InviteDialog"); } this.profilesStore = SdkContextClass.instance.userProfilesStore; const alreadyInvited = new Set([MatrixClientPeg.safeGet().getUserId()!]); const welcomeUserId = SdkConfig.get("welcome_user_id"); if (welcomeUserId) alreadyInvited.add(welcomeUserId); if (isRoomInvite(props)) { const room = MatrixClientPeg.safeGet().getRoom(props.roomId); if (!room) throw new Error("Room ID given to InviteDialog does not look like a room"); room.getMembersWithMembership("invite").forEach((m) => alreadyInvited.add(m.userId)); room.getMembersWithMembership("join").forEach((m) => alreadyInvited.add(m.userId)); // add banned users, so we don't try to invite them room.getMembersWithMembership("ban").forEach((m) => alreadyInvited.add(m.userId)); } this.state = { targets: [], // array of Member objects (see interface above) filterText: this.props.initialText || "", // Mutates alreadyInvited set so that buildSuggestions doesn't duplicate any users recents: InviteDialog.buildRecents(alreadyInvited), numRecentsShown: INITIAL_ROOMS_SHOWN, suggestions: this.buildSuggestions(alreadyInvited), numSuggestionsShown: INITIAL_ROOMS_SHOWN, serverResultsMixin: [], threepidResultsMixin: [], canUseIdentityServer: !!MatrixClientPeg.safeGet().getIdentityServerUrl(), tryingIdentityServer: false, consultFirst: false, dialPadValue: "", currentTabId: TabId.UserDirectory, // These two flags are used for the 'Go' button to communicate what is going on. busy: false, }; } public componentDidMount(): void { this.encryptionByDefault = privateShouldBeEncrypted(MatrixClientPeg.safeGet()); if (this.props.initialText) { this.updateSuggestions(this.props.initialText); } } public componentWillUnmount(): void { this.unmounted = true; } private onConsultFirstChange = (ev: React.ChangeEvent): void => { this.setState({ consultFirst: ev.target.checked }); }; public static buildRecents(excludedTargetIds: Set): Result[] { const rooms = DMRoomMap.shared().getUniqueRoomsWithIndividuals(); // map of userId => js-sdk Room // Also pull in all the rooms tagged as DefaultTagID.DM so we don't miss anything. Sometimes the // room list doesn't tag the room for the DMRoomMap, but does for the room list. const dmTaggedRooms = RoomListStore.instance.orderedLists[DefaultTagID.DM] || []; const myUserId = MatrixClientPeg.safeGet().getUserId(); for (const dmRoom of dmTaggedRooms) { const otherMembers = dmRoom.getJoinedMembers().filter((u) => u.userId !== myUserId); for (const member of otherMembers) { if (rooms[member.userId]) continue; // already have a room logger.warn(`Adding DM room for ${member.userId} as ${dmRoom.roomId} from tag, not DM map`); rooms[member.userId] = dmRoom; } } const recents: { userId: string; user: Member; lastActive: number; }[] = []; for (const userId in rooms) { // Filter out user IDs that are already in the room / should be excluded if (excludedTargetIds.has(userId)) { logger.warn(`[Invite:Recents] Excluding ${userId} from recents`); continue; } const room = rooms[userId]; const roomMember = room.getMember(userId); if (!roomMember) { // just skip people who don't have memberships for some reason logger.warn(`[Invite:Recents] ${userId} is missing a member object in their own DM (${room.roomId})`); continue; } // Find the last timestamp for a message event const searchTypes = ["m.room.message", "m.room.encrypted", "m.sticker"]; const maxSearchEvents = 20; // to prevent traversing history let lastEventTs = 0; if (room.timeline && room.timeline.length) { for (let i = room.timeline.length - 1; i >= 0; i--) { const ev = room.timeline[i]; if (searchTypes.includes(ev.getType())) { lastEventTs = ev.getTs(); break; } if (room.timeline.length - i > maxSearchEvents) break; } } if (!lastEventTs) { // something weird is going on with this room logger.warn(`[Invite:Recents] ${userId} (${room.roomId}) has a weird last timestamp: ${lastEventTs}`); continue; } recents.push({ userId, user: toMember(roomMember), lastActive: lastEventTs }); // We mutate the given set so that any later callers avoid duplicating these users excludedTargetIds.add(userId); } if (!recents) logger.warn("[Invite:Recents] No recents to suggest!"); // Sort the recents by last active to save us time later recents.sort((a, b) => b.lastActive - a.lastActive); return recents; } private buildSuggestions(excludedTargetIds: Set): { userId: string; user: Member }[] { const cli = MatrixClientPeg.safeGet(); const activityScores = buildActivityScores(cli); const memberScores = buildMemberScores(cli); const memberComparator = compareMembers(activityScores, memberScores); return Object.values(memberScores) .map(({ member }) => member) .filter((member) => !excludedTargetIds.has(member.userId)) .sort(memberComparator) .map((member) => ({ userId: member.userId, user: toMember(member) })); } private shouldAbortAfterInviteError(result: IInviteResult, room: Room): boolean { this.setState({ busy: false }); const userMap = new Map(this.state.targets.map((member) => [member.userId, member])); return !showAnyInviteErrors(result.states, room, result.inviter, userMap); } private convertFilter(): Member[] { // Check to see if there's anything to convert first if (!this.state.filterText || !this.state.filterText.includes("@")) return this.state.targets || []; if (!this.canInviteMore()) { // There should only be one third-party invite → do not allow more targets return this.state.targets; } let newMember: Member | undefined; if (this.state.filterText.startsWith("@")) { // Assume mxid newMember = new DirectoryMember({ user_id: this.state.filterText }); } else if (SettingsStore.getValue(UIFeature.IdentityServer)) { // Assume email if (this.canInviteThirdParty()) { newMember = new ThreepidMember(this.state.filterText); } } if (!newMember) return this.state.targets; const newTargets = [...(this.state.targets || []), newMember]; this.setState({ targets: newTargets, filterText: "" }); return newTargets; } /** * Check if there are unknown profiles if promptBeforeInviteUnknownUsers setting is enabled. * If so show the "invite anyway?" dialog. Otherwise directly create the DM local room. */ private checkProfileAndStartDm = async (): Promise => { this.setBusy(true); const targets = this.convertFilter(); if (SettingsStore.getValue("promptBeforeInviteUnknownUsers")) { const unknownProfileUsers = await extractTargetUnknownProfiles(targets, this.profilesStore); if (unknownProfileUsers.length) { this.showAskInviteAnywayDialog(unknownProfileUsers); return; } } await this.startDm(); }; private startDm = async (): Promise => { this.setBusy(true); try { const cli = MatrixClientPeg.safeGet(); const targets = this.convertFilter(); await startDmOnFirstMessage(cli, targets); this.props.onFinished(true); } catch (err) { logger.error(err); this.setState({ busy: false, errorText: _t("We couldn't create your DM."), }); } }; private setBusy(busy: boolean): void { this.setState({ busy, }); } private showAskInviteAnywayDialog(unknownProfileUsers: { userId: string; errorText: string }[]): void { Modal.createDialog(AskInviteAnywayDialog, { unknownProfileUsers, onInviteAnyways: () => this.startDm(), onGiveUp: () => { this.setBusy(false); }, description: _t( "Unable to find profiles for the Matrix IDs listed below - would you like to start a DM anyway?", ), inviteNeverWarnLabel: _t("Start DM anyway and never warn me again"), inviteLabel: _t("Start DM anyway"), }); } private inviteUsers = async (): Promise => { if (this.props.kind !== InviteKind.Invite) return; this.setState({ busy: true }); this.convertFilter(); const targets = this.convertFilter(); const targetIds = targets.map((t) => t.userId); const cli = MatrixClientPeg.safeGet(); const room = cli.getRoom(this.props.roomId); if (!room) { logger.error("Failed to find the room to invite users to"); this.setState({ busy: false, errorText: _t("Something went wrong trying to invite the users."), }); return; } try { const result = await inviteMultipleToRoom(cli, this.props.roomId, targetIds, true); if (!this.shouldAbortAfterInviteError(result, room)) { // handles setting error message too this.props.onFinished(true); } } catch (err) { logger.error(err); this.setState({ busy: false, errorText: _t( "We couldn't invite those users. Please check the users you want to invite and try again.", ), }); } }; private transferCall = async (): Promise => { if (this.props.kind !== InviteKind.CallTransfer) return; if (this.state.currentTabId == TabId.UserDirectory) { this.convertFilter(); const targets = this.convertFilter(); const targetIds = targets.map((t) => t.userId); if (targetIds.length > 1) { this.setState({ errorText: _t("A call can only be transferred to a single user."), }); return; } LegacyCallHandler.instance.startTransferToMatrixID(this.props.call, targetIds[0], this.state.consultFirst); } else { LegacyCallHandler.instance.startTransferToPhoneNumber( this.props.call, this.state.dialPadValue, this.state.consultFirst, ); } this.props.onFinished(true); }; private onKeyDown = (e: React.KeyboardEvent): void => { if (this.state.busy) return; let handled = false; const value = e.currentTarget.value.trim(); const action = getKeyBindingsManager().getAccessibilityAction(e); switch (action) { case KeyBindingAction.Backspace: if (value || this.state.targets.length <= 0) break; // when the field is empty and the user hits backspace remove the right-most target this.removeMember(this.state.targets[this.state.targets.length - 1]); handled = true; break; case KeyBindingAction.Space: if (!value || !value.includes("@") || value.includes(" ")) break; // when the user hits space and their input looks like an e-mail/MXID then try to convert it this.convertFilter(); handled = true; break; case KeyBindingAction.Enter: if (!value) break; // when the user hits enter with something in their field try to convert it this.convertFilter(); handled = true; break; } if (handled) { e.preventDefault(); } }; private onCancel = (): void => { this.props.onFinished(false); }; private updateSuggestions = async (term: string): Promise => { MatrixClientPeg.safeGet() .searchUserDirectory({ term }) .then(async (r): Promise => { if (term !== this.state.filterText) { // Discard the results - we were probably too slow on the server-side to make // these results useful. This is a race we want to avoid because we could overwrite // more accurate results. return; } if (!r.results) r.results = []; // While we're here, try and autocomplete a search result for the mxid itself // if there's no matches (and the input looks like a mxid). if (term[0] === "@" && term.indexOf(":") > 1) { try { const profile = await this.profilesStore.getOrFetchProfile(term, { shouldThrow: true }); if (profile) { // If we have a profile, we have enough information to assume that // the mxid can be invited - add it to the list. We stick it at the // top so it is most obviously presented to the user. r.results.splice(0, 0, { user_id: term, display_name: profile["displayname"], avatar_url: profile["avatar_url"], }); } } catch (e) { logger.warn("Non-fatal error trying to make an invite for a user ID", e); } } this.setState({ serverResultsMixin: r.results.map((u) => ({ userId: u.user_id, user: new DirectoryMember(u), })), }); }) .catch((e) => { logger.error("Error searching user directory:"); logger.error(e); this.setState({ serverResultsMixin: [] }); // clear results because it's moderately fatal }); // Whenever we search the directory, also try to search the identity server. It's // all debounced the same anyways. if (!this.state.canUseIdentityServer) { // The user doesn't have an identity server set - warn them of that. this.setState({ tryingIdentityServer: true }); return; } if (Email.looksValid(term) && this.canInviteThirdParty() && SettingsStore.getValue(UIFeature.IdentityServer)) { // Start off by suggesting the plain email while we try and resolve it // to a real account. this.setState({ // per above: the userId is a lie here - it's just a regular identifier threepidResultsMixin: [{ user: new ThreepidMember(term), userId: term }], }); try { const authClient = new IdentityAuthClient(); const token = await authClient.getAccessToken(); // No token → unable to try a lookup if (!token) return; if (term !== this.state.filterText) return; // abandon hope const lookup = await MatrixClientPeg.safeGet().lookupThreePid("email", term, token); if (term !== this.state.filterText) return; // abandon hope if (!lookup || !("mxid" in lookup)) { // We weren't able to find anyone - we're already suggesting the plain email // as an alternative, so do nothing. return; } // We append the user suggestion to give the user an option to click // the email anyways, and so we don't cause things to jump around. In // theory, the user would see the user pop up and think "ah yes, that // person!" const profile = await this.profilesStore.getOrFetchProfile(lookup.mxid); if (term !== this.state.filterText || !profile) return; // abandon hope this.setState({ threepidResultsMixin: [ ...this.state.threepidResultsMixin, { user: new DirectoryMember({ user_id: lookup.mxid, display_name: profile.displayname, avatar_url: profile.avatar_url, }), // Use the search term as identifier, so that it shows up in suggestions. userId: term, }, ], }); } catch (e) { logger.error("Error searching identity server:"); logger.error(e); this.setState({ threepidResultsMixin: [] }); // clear results because it's moderately fatal } } }; private updateFilter = (e: React.ChangeEvent): void => { const term = e.target.value; this.setState({ filterText: term }); // Debounce server lookups to reduce spam. We don't clear the existing server // results because they might still be vaguely accurate, likewise for races which // could happen here. if (this.debounceTimer) { clearTimeout(this.debounceTimer); } this.debounceTimer = window.setTimeout(() => { this.updateSuggestions(term); }, 150); // 150ms debounce (human reaction time + some) }; private showMoreRecents = (): void => { this.setState({ numRecentsShown: this.state.numRecentsShown + INCREMENT_ROOMS_SHOWN }); }; private showMoreSuggestions = (): void => { this.setState({ numSuggestionsShown: this.state.numSuggestionsShown + INCREMENT_ROOMS_SHOWN }); }; private toggleMember = (member: Member): void => { if (!this.state.busy) { let filterText = this.state.filterText; let targets = this.state.targets.map((t) => t); // cheap clone for mutation const idx = targets.findIndex((m) => m.userId === member.userId); if (idx >= 0) { targets.splice(idx, 1); } else { if (this.props.kind === InviteKind.CallTransfer && targets.length > 0) { targets = []; } targets.push(member); filterText = ""; // clear the filter when the user accepts a suggestion } this.setState({ targets, filterText }); if (this.editorRef && this.editorRef.current) { this.editorRef.current.focus(); } } }; private removeMember = (member: Member): void => { const targets = this.state.targets.map((t) => t); // cheap clone for mutation const idx = targets.indexOf(member); if (idx >= 0) { targets.splice(idx, 1); this.setState({ targets }); } if (this.editorRef && this.editorRef.current) { this.editorRef.current.focus(); } }; private parseFilter(filter: string): string[] { return filter .split(/[\s,]+/) .map((p) => p.trim()) .filter((p) => !!p); // filter empty strings } private onPaste = async (e: React.ClipboardEvent): Promise => { if (this.state.filterText) { // if the user has already typed something, just let them // paste normally. return; } const text = e.clipboardData.getData("text"); const potentialAddresses = this.parseFilter(text); // one search term which is not a mxid or email address if (potentialAddresses.length === 1 && !potentialAddresses[0].includes("@")) { return; } // Prevent the text being pasted into the input e.preventDefault(); // Process it as a list of addresses to add instead const possibleMembers = [ // If we can avoid hitting the profile endpoint, we should. ...this.state.recents, ...this.state.suggestions, ...this.state.serverResultsMixin, ...this.state.threepidResultsMixin, ]; const toAdd: Member[] = []; const failed: string[] = []; // Addresses that could not be added. // Will be displayed as filter text to provide feedback. const unableToAddMore: string[] = []; for (const address of potentialAddresses) { const member = possibleMembers.find((m) => m.userId === address); if (member) { if (this.canInviteMore([...this.state.targets, ...toAdd])) { toAdd.push(member.user); } else { // Invite not possible for current targets and pasted targets. unableToAddMore.push(address); } continue; } if (Email.looksValid(address)) { if (this.canInviteThirdParty([...this.state.targets, ...toAdd])) { toAdd.push(new ThreepidMember(address)); } else { // Third-party invite not possible for current targets and pasted targets. unableToAddMore.push(address); } continue; } if (address[0] !== "@") { failed.push(address); // not a user ID continue; } try { const profile = await this.profilesStore.getOrFetchProfile(address); toAdd.push( new DirectoryMember({ user_id: address, display_name: profile?.displayname, avatar_url: profile?.avatar_url, }), ); } catch (e) { logger.error("Error looking up profile for " + address); logger.error(e); failed.push(address); } } if (this.unmounted) return; if (failed.length > 0) { Modal.createDialog(QuestionDialog, { title: _t("Failed to find the following users"), description: _t( "The following users might not exist or are invalid, and cannot be invited: %(csvNames)s", { csvNames: failed.join(", ") }, ), button: _t("OK"), }); } if (unableToAddMore) { this.setState({ filterText: unableToAddMore.join(" "), targets: uniqBy([...this.state.targets, ...toAdd], (t) => t.userId), }); } else { this.setState({ targets: uniqBy([...this.state.targets, ...toAdd], (t) => t.userId), }); } }; private onClickInputArea = (e: React.MouseEvent): void => { // Stop the browser from highlighting text e.preventDefault(); e.stopPropagation(); if (this.editorRef && this.editorRef.current) { this.editorRef.current.focus(); } }; private onUseDefaultIdentityServerClick = (e: ButtonEvent): void => { e.preventDefault(); // Update the IS in account data. Actually using it may trigger terms. // eslint-disable-next-line react-hooks/rules-of-hooks setToDefaultIdentityServer(MatrixClientPeg.safeGet()); this.setState({ canUseIdentityServer: true, tryingIdentityServer: false }); }; private onManageSettingsClick = (e: ButtonEvent): void => { e.preventDefault(); dis.fire(Action.ViewUserSettings); this.props.onFinished(false); }; private renderSection(kind: "recents" | "suggestions"): ReactNode { let sourceMembers = kind === "recents" ? this.state.recents : this.state.suggestions; let showNum = kind === "recents" ? this.state.numRecentsShown : this.state.numSuggestionsShown; const showMoreFn = kind === "recents" ? this.showMoreRecents.bind(this) : this.showMoreSuggestions.bind(this); const lastActive = (m: Result): number | undefined => (kind === "recents" ? m.lastActive : undefined); let sectionName = kind === "recents" ? _t("Recent Conversations") : _t("Suggestions"); if (this.props.kind === InviteKind.Invite) { sectionName = kind === "recents" ? _t("Recently Direct Messaged") : _t("Suggestions"); } // Mix in the server results if we have any, but only if we're searching. We track the additional // members separately because we want to filter sourceMembers but trust the mixin arrays to have // the right members in them. let priorityAdditionalMembers: Result[] = []; // Shows up before our own suggestions, higher quality let otherAdditionalMembers: Result[] = []; // Shows up after our own suggestions, lower quality const hasMixins = this.state.serverResultsMixin || this.state.threepidResultsMixin; if (this.state.filterText && hasMixins && kind === "suggestions") { // We don't want to duplicate members though, so just exclude anyone we've already seen. // The type of u is a pain to define but members of both mixins have the 'userId' property const notAlreadyExists = (u: any): boolean => { return ( !this.state.recents.some((m) => m.userId === u.userId) && !sourceMembers.some((m) => m.userId === u.userId) && !priorityAdditionalMembers.some((m) => m.userId === u.userId) && !otherAdditionalMembers.some((m) => m.userId === u.userId) ); }; otherAdditionalMembers = this.state.serverResultsMixin.filter(notAlreadyExists); priorityAdditionalMembers = this.state.threepidResultsMixin.filter(notAlreadyExists); } const hasAdditionalMembers = priorityAdditionalMembers.length > 0 || otherAdditionalMembers.length > 0; // Hide the section if there's nothing to filter by if (sourceMembers.length === 0 && !hasAdditionalMembers) return null; if (!this.canInviteThirdParty()) { // It is currently not allowed to add more third-party invites. Filter them out. priorityAdditionalMembers = priorityAdditionalMembers.filter((s) => s instanceof ThreepidMember); } // Do some simple filtering on the input before going much further. If we get no results, say so. if (this.state.filterText) { const filterBy = this.state.filterText.toLowerCase(); sourceMembers = sourceMembers.filter( (m) => m.user.name.toLowerCase().includes(filterBy) || m.userId.toLowerCase().includes(filterBy), ); if (sourceMembers.length === 0 && !hasAdditionalMembers) { return (

{sectionName}

{_t("No results")}

); } } // Now we mix in the additional members. Again, we presume these have already been filtered. We // also assume they are more relevant than our suggestions and prepend them to the list. sourceMembers = [...priorityAdditionalMembers, ...sourceMembers, ...otherAdditionalMembers]; // If we're going to hide one member behind 'show more', just use up the space of the button // with the member's tile instead. if (showNum === sourceMembers.length - 1) showNum++; // .slice() will return an incomplete array but won't error on us if we go too far const toRender = sourceMembers.slice(0, showNum); const hasMore = toRender.length < sourceMembers.length; let showMore: JSX.Element | undefined; if (hasMore) { showMore = (
{_t("Show more")}
); } const tiles = toRender.map((r) => ( t.userId === r.userId)} /> )); return (

{sectionName}

{tiles} {showMore}
); } private renderEditor(): JSX.Element { const hasPlaceholder = this.props.kind == InviteKind.CallTransfer && this.state.targets.length === 0 && this.state.filterText.length === 0; const targets = this.state.targets.map((t) => ( )); const input = ( 0) } autoComplete="off" placeholder={hasPlaceholder ? _t("Search") : undefined} data-testid="invite-dialog-input" /> ); return (
{targets} {input}
); } private renderIdentityServerWarning(): ReactNode { if ( !this.state.tryingIdentityServer || this.state.canUseIdentityServer || !SettingsStore.getValue(UIFeature.IdentityServer) ) { return null; } const defaultIdentityServerUrl = getDefaultIdentityServerUrl(); if (defaultIdentityServerUrl) { return (
{_t( "Use an identity server to invite by email. " + "Use the default (%(defaultIdentityServerName)s) " + "or manage in Settings.", { defaultIdentityServerName: abbreviateUrl(defaultIdentityServerUrl), }, { default: (sub) => ( {sub} ), settings: (sub) => ( {sub} ), }, )}
); } else { return (
{_t( "Use an identity server to invite by email. " + "Manage in Settings.", {}, { settings: (sub) => ( {sub} ), }, )}
); } } private onDialFormSubmit = (ev: SyntheticEvent): void => { ev.preventDefault(); this.transferCall(); }; private onDialChange = (ev: React.ChangeEvent): void => { this.setState({ dialPadValue: ev.currentTarget.value }); }; private onDigitPress = (digit: string, ev: ButtonEvent): void => { this.setState({ dialPadValue: this.state.dialPadValue + digit }); // Keep the number field focused so that keyboard entry is still available // However, don't focus if this wasn't the result of directly clicking on the button, // i.e someone using keyboard navigation. if (ev.type === "click") { this.numberEntryFieldRef.current?.focus(); } }; private onDeletePress = (ev: ButtonEvent): void => { if (this.state.dialPadValue.length === 0) return; this.setState({ dialPadValue: this.state.dialPadValue.slice(0, -1) }); // Keep the number field focused so that keyboard entry is still available // However, don't focus if this wasn't the result of directly clicking on the button, // i.e someone using keyboard navigation. if (ev.type === "click") { this.numberEntryFieldRef.current?.focus(); } }; private onTabChange = (tabId: TabId): void => { this.setState({ currentTabId: tabId }); }; private async onLinkClick(e: React.MouseEvent): Promise { e.preventDefault(); selectText(e.currentTarget); } private get screenName(): ScreenName | undefined { switch (this.props.kind) { case InviteKind.Dm: return "StartChat"; default: return undefined; } } /** * If encryption by default is enabled, third-party invites should be encrypted as well. * For encryption to work, the other side requires a device. * To achieve this Element implements a waiting room until all have joined. * Waiting for many users degrades the UX → only one email invite is allowed at a time. * * @param targets - Optional member list to check. Uses targets from state if not provided. */ private canInviteMore(targets?: (Member | RoomMember)[]): boolean { targets = targets || this.state.targets; return this.canInviteThirdParty(targets) || !targets.some((t) => t instanceof ThreepidMember); } /** * A third-party invite is possible if * - this is a non-DM dialog or * - there are no invites yet or * - encryption by default is not enabled * * Also see {@link InviteDialog#canInviteMore}. * * @param targets - Optional member list to check. Uses targets from state if not provided. */ private canInviteThirdParty(targets?: (Member | RoomMember)[]): boolean { targets = targets || this.state.targets; return this.props.kind !== InviteKind.Dm || targets.length === 0 || !this.encryptionByDefault; } private hasFilterAtLeastOneEmail(): boolean { if (!this.state.filterText) return false; return this.parseFilter(this.state.filterText).some((address: string) => { return Email.looksValid(address); }); } public render(): React.ReactNode { let spinner: JSX.Element | undefined; if (this.state.busy) { spinner = ; } let title; let helpText; let buttonText; let goButtonFn: (() => Promise) | null = null; let consultConnectSection; let extraSection; let footer; let keySharingWarning = ; const identityServersEnabled = SettingsStore.getValue(UIFeature.IdentityServer); const hasSelection = this.state.targets.length > 0 || (this.state.filterText && this.state.filterText.includes("@")); const cli = MatrixClientPeg.safeGet(); const userId = cli.getUserId()!; if (this.props.kind === InviteKind.Dm) { title = _t("Direct Messages"); if (identityServersEnabled) { helpText = _t( "Start a conversation with someone using their name, email address or username (like ).", {}, { userId: () => { return ( {userId} ); }, }, ); } else { helpText = _t( "Start a conversation with someone using their name or username (like ).", {}, { userId: () => { return ( {userId} ); }, }, ); } buttonText = _t("Go"); goButtonFn = this.checkProfileAndStartDm; extraSection = (
{_t("Some suggestions may be hidden for privacy.")}

{_t("If you can't see who you're looking for, send them your invite link below.")}

); const link = makeUserPermalink(MatrixClientPeg.safeGet().getSafeUserId()); footer = (

{_t("Or send invite link")}

makeUserPermalink(MatrixClientPeg.safeGet().getSafeUserId())}> {link}
); } else if (this.props.kind === InviteKind.Invite) { const roomId = this.props.roomId; const room = MatrixClientPeg.get()?.getRoom(roomId); const isSpace = room?.isSpaceRoom(); title = isSpace ? _t("Invite to %(spaceName)s", { spaceName: room?.name || _t("Unnamed Space"), }) : _t("Invite to %(roomName)s", { roomName: room?.name || _t("Unnamed Room"), }); let helpTextUntranslated; if (isSpace) { if (identityServersEnabled) { helpTextUntranslated = _td( "Invite someone using their name, email address, username " + "(like ) or share this space.", ); } else { helpTextUntranslated = _td( "Invite someone using their name, username " + "(like ) or share this space.", ); } } else { if (identityServersEnabled) { helpTextUntranslated = _td( "Invite someone using their name, email address, username " + "(like ) or share this room.", ); } else { helpTextUntranslated = _td( "Invite someone using their name, username " + "(like ) or share this room.", ); } } helpText = _t( helpTextUntranslated, {}, { userId: () => ( {userId} ), a: (sub) => ( {sub} ), }, ); buttonText = _t("Invite"); goButtonFn = this.inviteUsers; if (cli.isRoomEncrypted(this.props.roomId)) { const room = cli.getRoom(this.props.roomId)!; const visibilityEvent = room.currentState.getStateEvents("m.room.history_visibility", ""); const visibility = visibilityEvent && visibilityEvent.getContent() && visibilityEvent.getContent().history_visibility; if (visibility === "world_readable" || visibility === "shared") { keySharingWarning = (

{" " + _t("Invited people will be able to read old messages.")}

); } } } else if (this.props.kind === InviteKind.CallTransfer) { title = _t("Transfer"); consultConnectSection = (
{_t("Cancel")} {_t("Transfer")}
); } const goButton = this.props.kind == InviteKind.CallTransfer ? null : ( {buttonText} ); let results: React.ReactNode | null = null; let onlyOneThreepidNote: React.ReactNode | null = null; if (!this.canInviteMore() || (this.hasFilterAtLeastOneEmail() && !this.canInviteThirdParty())) { // We are in DM case here, because of the checks in canInviteMore() / canInviteThirdParty(). onlyOneThreepidNote = (
{_t("Invites by email can only be sent one at a time")}
); } else { results = (
{this.renderSection("recents")} {this.renderSection("suggestions")} {extraSection}
); } const usersSection = (

{helpText}

{this.renderEditor()}
{goButton} {spinner}
{keySharingWarning} {this.renderIdentityServerWarning()}
{this.state.errorText}
{onlyOneThreepidNote} {results} {footer}
); let dialogContent; if (this.props.kind === InviteKind.CallTransfer) { const tabs: NonEmptyArray> = [ new Tab(TabId.UserDirectory, _td("User Directory"), "mx_InviteDialog_userDirectoryIcon", usersSection), ]; const backspaceButton = ; // Only show the backspace button if the field has content let dialPadField; if (this.state.dialPadValue.length !== 0) { dialPadField = ( ); } else { dialPadField = ( ); } const dialPadSection = (
{dialPadField}
); tabs.push(new Tab(TabId.DialPad, _td("Dial pad"), "mx_InviteDialog_dialPadIcon", dialPadSection)); dialogContent = ( {consultConnectSection} ); } else { dialogContent = ( {usersSection} {consultConnectSection} ); } return (
{dialogContent}
); } }