Allow knocking rooms (#11353)

Signed-off-by: Charly Nguyen <charly.nguyen@nordeck.net>

src/components/structures/RoomView.tsx

@@ -37,7 +37,7 @@ import { MatrixError } from "matrix-js-sdk/src/http-api";
 import { ClientEvent } from "matrix-js-sdk/src/client";
 import { CryptoEvent } from "matrix-js-sdk/src/crypto";
 import { THREAD_RELATION_TYPE } from "matrix-js-sdk/src/models/thread";
-import { HistoryVisibility } from "matrix-js-sdk/src/@types/partials";
+import { HistoryVisibility, JoinRule } from "matrix-js-sdk/src/@types/partials";
 import { ISearchResults } from "matrix-js-sdk/src/@types/search";
 import { IRoomTimelineData } from "matrix-js-sdk/src/models/event-timeline-set";
 
@@ -125,6 +125,8 @@ import WidgetUtils from "../../utils/WidgetUtils";
 import { shouldEncryptRoomWithSingle3rdPartyInvite } from "../../utils/room/shouldEncryptRoomWithSingle3rdPartyInvite";
 import { WaitingForThirdPartyRoomView } from "./WaitingForThirdPartyRoomView";
 import { isNotUndefined } from "../../Typeguards";
+import { CancelAskToJoinPayload } from "../../dispatcher/payloads/CancelAskToJoinPayload";
+import { SubmitAskToJoinPayload } from "../../dispatcher/payloads/SubmitAskToJoinPayload";
 
 const DEBUG = false;
 const PREVENT_MULTIPLE_JITSI_WITHIN = 30_000;
@@ -238,6 +240,10 @@ export interface IRoomState {
     liveTimeline?: EventTimeline;
     narrow: boolean;
     msc3946ProcessDynamicPredecessor: boolean;
+
+    canAskToJoin: boolean;
+    promptAskToJoin: boolean;
+    knocked: boolean;
 }
 
 interface LocalRoomViewProps {
@@ -384,6 +390,7 @@ function LocalRoomCreateLoader(props: ILocalRoomCreateLoaderProps): ReactElement
 }
 
 export class RoomView extends React.Component<IRoomProps, IRoomState> {
+    private readonly askToJoinEnabled: boolean;
     private readonly dispatcherRef: string;
     private settingWatchers: string[];
 
@@ -401,6 +408,8 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
     public constructor(props: IRoomProps, context: React.ContextType<typeof SDKContext>) {
         super(props, context);
 
+        this.askToJoinEnabled = SettingsStore.getValue("feature_ask_to_join");
+
         if (!context.client) {
             throw new Error("Unable to create RoomView without MatrixClient");
         }
@@ -445,6 +454,9 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             liveTimeline: undefined,
             narrow: false,
             msc3946ProcessDynamicPredecessor: SettingsStore.getValue("feature_dynamic_room_predecessors"),
+            canAskToJoin: this.askToJoinEnabled,
+            promptAskToJoin: false,
+            knocked: false,
         };
 
         this.dispatcherRef = dis.register(this.onAction);
@@ -649,6 +661,8 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
                   )
                 : false,
             activeCall: roomId ? CallStore.instance.getActiveCall(roomId) : null,
+            promptAskToJoin: this.context.roomViewStore.promptAskToJoin(),
+            knocked: this.context.roomViewStore.knocked(),
         };
 
         if (
@@ -891,6 +905,7 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
                         this.setState({
                             room: room,
                             peekLoading: false,
+                            canAskToJoin: this.askToJoinEnabled && room.getJoinRule() === JoinRule.Knock,
                         });
                         this.onRoomLoaded(room);
                     })
@@ -919,7 +934,10 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             } else if (room) {
                 // Stop peeking because we have joined this room previously
                 this.context.client?.stopPeeking();
-                this.setState({ isPeeking: false });
+                this.setState({
+                    isPeeking: false,
+                    canAskToJoin: this.askToJoinEnabled && room.getJoinRule() === JoinRule.Knock,
+                });
             }
         }
     }
@@ -1593,6 +1611,7 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
                         roomId,
                         opts: { inviteSignUrl: signUrl },
                         metricsTrigger: this.state.room?.getMyMembership() === "invite" ? "Invite" : "RoomPreview",
+                        canAskToJoin: this.state.canAskToJoin,
                     });
                 }
 
@@ -1997,6 +2016,40 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
         );
     }
 
+    /**
+     * Handles the submission of a request to join a room.
+     *
+     * @param {string} reason - An optional reason for the request to join.
+     * @returns {void}
+     */
+    private onSubmitAskToJoin = (reason?: string): void => {
+        const roomId = this.getRoomId();
+
+        if (isNotUndefined(roomId)) {
+            dis.dispatch<SubmitAskToJoinPayload>({
+                action: Action.SubmitAskToJoin,
+                roomId,
+                opts: { reason },
+            });
+        }
+    };
+
+    /**
+     * Handles the cancellation of a request to join a room.
+     *
+     * @returns {void}
+     */
+    private onCancelAskToJoin = (): void => {
+        const roomId = this.getRoomId();
+
+        if (isNotUndefined(roomId)) {
+            dis.dispatch<CancelAskToJoinPayload>({
+                action: Action.CancelAskToJoin,
+                roomId,
+            });
+        }
+    };
+
     public render(): ReactNode {
         if (!this.context.client) return null;
 
@@ -2062,6 +2115,10 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
                                 oobData={this.props.oobData}
                                 signUrl={this.props.threepidInvite?.signUrl}
                                 roomId={this.state.roomId}
+                                promptAskToJoin={this.state.promptAskToJoin}
+                                knocked={this.state.knocked}
+                                onSubmitAskToJoin={this.onSubmitAskToJoin}
+                                onCancelAskToJoin={this.onCancelAskToJoin}
                             />
                         </ErrorBoundary>
                     </div>
@@ -2136,6 +2193,22 @@ export class RoomView extends React.Component<IRoomProps, IRoomState> {
             }
         }
 
+        if (this.state.canAskToJoin && ["knock", "leave"].includes(myMembership)) {
+            return (
+                <div className="mx_RoomView">
+                    <ErrorBoundary>
+                        <RoomPreviewBar
+                            room={this.state.room}
+                            promptAskToJoin={myMembership === "leave" || this.state.promptAskToJoin}
+                            knocked={myMembership === "knock" || this.state.knocked}
+                            onSubmitAskToJoin={this.onSubmitAskToJoin}
+                            onCancelAskToJoin={this.onCancelAskToJoin}
+                        />
+                    </ErrorBoundary>
+                </div>
+            );
+        }
+
         // We have successfully loaded this room, and are not previewing.
         // Display the "normal" room view.
 

src/components/views/rooms/RoomPreviewBar.tsx

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import React, { ReactNode } from "react";
+import React, { ChangeEvent, ReactNode } from "react";
 import { Room, RoomMember } from "matrix-js-sdk/src/matrix";
 import { MatrixError } from "matrix-js-sdk/src/http-api";
 import { EventType, RoomType } from "matrix-js-sdk/src/@types/event";
@@ -35,6 +35,8 @@ import RoomAvatar from "../avatars/RoomAvatar";
 import SettingsStore from "../../../settings/SettingsStore";
 import { UIFeature } from "../../../settings/UIFeature";
 import { ModuleRunner } from "../../../modules/ModuleRunner";
+import { Icon as AskToJoinIcon } from "../../../../res/img/element-icons/ask-to-join.svg";
+import Field from "../elements/Field";
 
 const MemberEventHtmlReasonField = "io.element.html_reason";
 
@@ -53,6 +55,8 @@ enum MessageCase {
     ViewingRoom = "ViewingRoom",
     RoomNotFound = "RoomNotFound",
     OtherError = "OtherError",
+    PromptAskToJoin = "PromptAskToJoin",
+    Knocked = "Knocked",
 }
 
 interface IProps {
@@ -95,6 +99,11 @@ interface IProps {
     onRejectClick?(): void;
     onRejectAndIgnoreClick?(): void;
     onForgetClick?(): void;
+
+    promptAskToJoin?: boolean;
+    knocked?: boolean;
+    onSubmitAskToJoin?(reason?: string): void;
+    onCancelAskToJoin?(): void;
 }
 
 interface IState {
@@ -102,6 +111,7 @@ interface IState {
     accountEmails?: string[];
     invitedEmailMxid?: string;
     threePidFetchError?: MatrixError;
+    reason?: string;
 }
 
 export default class RoomPreviewBar extends React.Component<IProps, IState> {
@@ -186,6 +196,10 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
             return MessageCase.Rejecting;
         } else if (this.props.loading || this.state.busy) {
             return MessageCase.Loading;
+        } else if (this.props.knocked) {
+            return MessageCase.Knocked;
+        } else if (this.props.promptAskToJoin) {
+            return MessageCase.PromptAskToJoin;
         }
 
         if (this.props.inviterName) {
@@ -281,6 +295,10 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
         dis.dispatch({ action: "start_registration", screenAfterLogin: this.makeScreenAfterLogin() });
     };
 
+    private onChangeReason = (event: ChangeEvent<HTMLTextAreaElement>): void => {
+        this.setState({ reason: event.target.value });
+    };
+
     public render(): React.ReactNode {
         const brand = SdkConfig.get().brand;
         const roomName = this.props.room?.name ?? this.props.roomAlias ?? "";
@@ -581,6 +599,54 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
                 ];
                 break;
             }
+            case MessageCase.PromptAskToJoin: {
+                if (roomName) {
+                    title = _t("Ask to join %(roomName)s?", { roomName });
+                } else {
+                    title = _t("Ask to join?");
+                }
+
+                const avatar = <RoomAvatar room={this.props.room} oobData={this.props.oobData} />;
+                subTitle = [
+                    avatar,
+                    _t(
+                        "You need to be granted access to this room in order to view or participate in the conversation. You can send a request to join below.",
+                    ),
+                ];
+
+                reasonElement = (
+                    <Field
+                        autoFocus
+                        className="mx_RoomPreviewBar_fullWidth"
+                        element="textarea"
+                        onChange={this.onChangeReason}
+                        placeholder={_t("Message (optional)")}
+                        type="text"
+                        value={this.state.reason ?? ""}
+                    />
+                );
+
+                primaryActionHandler = () =>
+                    this.props.onSubmitAskToJoin && this.props.onSubmitAskToJoin(this.state.reason);
+                primaryActionLabel = _t("Request access");
+
+                break;
+            }
+            case MessageCase.Knocked: {
+                title = _t("Request to join sent");
+
+                subTitle = [
+                    <>
+                        <AskToJoinIcon className="mx_Icon mx_Icon_16 mx_RoomPreviewBar_icon" />
+                        {_t("Your request to join is pending.")}
+                    </>,
+                ];
+
+                secondaryActionHandler = this.props.onCancelAskToJoin;
+                secondaryActionLabel = _t("Cancel request");
+
+                break;
+            }
         }
 
         let subTitleElements;
@@ -650,7 +716,13 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
                     {subTitleElements}
                 </div>
                 {reasonElement}
-                <div className="mx_RoomPreviewBar_actions">{actions}</div>
+                <div
+                    className={classNames("mx_RoomPreviewBar_actions", {
+                        mx_RoomPreviewBar_fullWidth: messageCase === MessageCase.PromptAskToJoin,
+                    })}
+                >
+                    {actions}
+                </div>
                 <div className="mx_RoomPreviewBar_footer">{footer}</div>
             </div>
         );

src/contexts/RoomContext.ts

@@ -71,6 +71,9 @@ const RoomContext = createContext<
     narrow: false,
     activeCall: null,
     msc3946ProcessDynamicPredecessor: false,
+    canAskToJoin: false,
+    promptAskToJoin: false,
+    knocked: false,
 });
 RoomContext.displayName = "RoomContext";
 export default RoomContext;

src/dispatcher/actions.ts

@@ -351,4 +351,19 @@ export enum Action {
      * Fired when we want to view a thread, either a new one or an existing one
      */
     ShowThread = "show_thread",
+
+    /**
+     * Fired when requesting to prompt for ask to join a room.
+     */
+    PromptAskToJoin = "prompt_ask_to_join",
+
+    /**
+     * Fired when requesting to submit an ask to join a room. Use with a SubmitAskToJoinPayload.
+     */
+    SubmitAskToJoin = "submit_ask_to_join",
+
+    /**
+     * Fired when requesting to cancel an ask to join a room. Use with a CancelAskToJoinPayload.
+     */
+    CancelAskToJoin = "cancel_ask_to_join",
 }

src/dispatcher/payloads/CancelAskToJoinPayload.ts

@@ -0,0 +1,24 @@
+/*
+Copyright 2023 Nordeck IT + Consulting GmbH
+
+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 { Action } from "../actions";
+import { ActionPayload } from "../payloads";
+
+export interface CancelAskToJoinPayload extends Pick<ActionPayload, "action"> {
+    action: Action.CancelAskToJoin;
+
+    roomId: string;
+}

src/dispatcher/payloads/JoinRoomErrorPayload.ts

@@ -24,4 +24,6 @@ export interface JoinRoomErrorPayload extends Pick<ActionPayload, "action"> {
 
     roomId: string;
     err: MatrixError;
+
+    canAskToJoin?: boolean;
 }

src/dispatcher/payloads/JoinRoomPayload.ts

@@ -29,5 +29,7 @@ export interface JoinRoomPayload extends Pick<ActionPayload, "action"> {
 
     // additional parameters for the purpose of metrics & instrumentation
     metricsTrigger: JoinedRoomEvent["trigger"];
+
+    canAskToJoin?: boolean;
 }
 /* eslint-enable camelcase */

src/dispatcher/payloads/SubmitAskToJoinPayload.ts

@@ -0,0 +1,27 @@
+/*
+Copyright 2023 Nordeck IT + Consulting GmbH
+
+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 { KnockRoomOpts } from "matrix-js-sdk/src/@types/requests";
+
+import { Action } from "../actions";
+import { ActionPayload } from "../payloads";
+
+export interface SubmitAskToJoinPayload extends Pick<ActionPayload, "action"> {
+    action: Action.SubmitAskToJoin;
+
+    roomId: string;
+    opts?: KnockRoomOpts;
+}

src/i18n/strings/en_EN.json

@@ -893,6 +893,8 @@
     "You attempted to join using a room ID without providing a list of servers to join through. Room IDs are internal identifiers and cannot be used to join a room without additional information.": "You attempted to join using a room ID without providing a list of servers to join through. Room IDs are internal identifiers and cannot be used to join a room without additional information.",
     "If you know a room address, try joining through that instead.": "If you know a room address, try joining through that instead.",
     "Failed to join": "Failed to join",
+    "You need an invite to access this room.": "You need an invite to access this room.",
+    "Failed to cancel": "Failed to cancel",
     "Connection lost": "Connection lost",
     "You were disconnected from the call. (Error: %(message)s)": "You were disconnected from the call. (Error: %(message)s)",
     "All rooms": "All rooms",
@@ -2124,6 +2126,14 @@
     "This room or space is not accessible at this time.": "This room or space is not accessible at this time.",
     "Try again later, or ask a room or space admin to check if you have access.": "Try again later, or ask a room or space admin to check if you have access.",
     "%(errcode)s was returned while trying to access the room or space. If you think you're seeing this message in error, please <issueLink>submit a bug report</issueLink>.": "%(errcode)s was returned while trying to access the room or space. If you think you're seeing this message in error, please <issueLink>submit a bug report</issueLink>.",
+    "Ask to join %(roomName)s?": "Ask to join %(roomName)s?",
+    "Ask to join?": "Ask to join?",
+    "You need to be granted access to this room in order to view or participate in the conversation. You can send a request to join below.": "You need to be granted access to this room in order to view or participate in the conversation. You can send a request to join below.",
+    "Message (optional)": "Message (optional)",
+    "Request access": "Request access",
+    "Request to join sent": "Request to join sent",
+    "Your request to join is pending.": "Your request to join is pending.",
+    "Cancel request": "Cancel request",
     "Leave": "Leave",
     "<inviter/> invites you": "<inviter/> invites you",
     "To view %(roomName)s, you need an invite": "To view %(roomName)s, you need an invite",

src/stores/RoomViewStore.tsx

@@ -61,6 +61,8 @@ import { IRoomStateEventsActionPayload } from "../actions/MatrixActionCreators";
 import { showCantStartACallDialog } from "../voice-broadcast/utils/showCantStartACallDialog";
 import { pauseNonLiveBroadcastFromOtherRoom } from "../voice-broadcast/utils/pauseNonLiveBroadcastFromOtherRoom";
 import { ActionPayload } from "../dispatcher/payloads";
+import { CancelAskToJoinPayload } from "../dispatcher/payloads/CancelAskToJoinPayload";
+import { SubmitAskToJoinPayload } from "../dispatcher/payloads/SubmitAskToJoinPayload";
 
 const NUM_JOIN_RETRY = 5;
 
@@ -118,6 +120,9 @@ interface State {
      * Whether we're viewing a call or call lobby in this room
      */
     viewingCall: boolean;
+
+    promptAskToJoin: boolean;
+    knocked: boolean;
 }
 
 const INITIAL_STATE: State = {
@@ -138,6 +143,8 @@ const INITIAL_STATE: State = {
     viaServers: [],
     wasContextSwitch: false,
     viewingCall: false,
+    promptAskToJoin: false,
+    knocked: false,
 };
 
 type Listener = (isActive: boolean) => void;
@@ -356,6 +363,18 @@ export class RoomViewStore extends EventEmitter {
                     }
                 }
                 break;
+            case Action.PromptAskToJoin: {
+                this.setState({ promptAskToJoin: true });
+                break;
+            }
+            case Action.SubmitAskToJoin: {
+                this.submitAskToJoin(payload as SubmitAskToJoinPayload);
+                break;
+            }
+            case Action.CancelAskToJoin: {
+                this.cancelAskToJoin(payload as CancelAskToJoinPayload);
+                break;
+            }
         }
     }
 
@@ -563,7 +582,12 @@ export class RoomViewStore extends EventEmitter {
                 action: Action.JoinRoomError,
                 roomId,
                 err,
+                canAskToJoin: payload.canAskToJoin,
             });
+
+            if (payload.canAskToJoin) {
+                this.dis?.dispatch({ action: Action.PromptAskToJoin });
+            }
         }
     }
 
@@ -632,7 +656,7 @@ export class RoomViewStore extends EventEmitter {
             joining: false,
             joinError: payload.err,
         });
-        if (payload.err) {
+        if (payload.err && !payload.canAskToJoin) {
             this.showJoinRoomError(payload.err, payload.roomId);
         }
     }
@@ -746,4 +770,57 @@ export class RoomViewStore extends EventEmitter {
     public isViewingCall(): boolean {
         return this.state.viewingCall;
     }
+
+    /**
+     * Gets the current state of the 'promptForAskToJoin' property.
+     *
+     * @returns {boolean} The value of the 'promptForAskToJoin' property.
+     */
+    public promptAskToJoin(): boolean {
+        return this.state.promptAskToJoin;
+    }
+
+    /**
+     * Gets the current state of the 'knocked' property.
+     *
+     * @returns {boolean} The value of the 'knocked' property.
+     */
+    public knocked(): boolean {
+        return this.state.knocked;
+    }
+
+    /**
+     * Submits a request to join a room by sending a knock request.
+     *
+     * @param {SubmitAskToJoinPayload} payload - The payload containing information to submit the request.
+     * @returns {void}
+     */
+    private submitAskToJoin(payload: SubmitAskToJoinPayload): void {
+        MatrixClientPeg.safeGet()
+            .knockRoom(payload.roomId, { viaServers: this.state.viaServers, ...payload.opts })
+            .then(() => this.setState({ promptAskToJoin: false, knocked: true }))
+            .catch((err: MatrixError) => {
+                this.setState({ promptAskToJoin: false });
+
+                Modal.createDialog(ErrorDialog, {
+                    title: _t("Failed to join"),
+                    description: err.httpStatus === 403 ? _t("You need an invite to access this room.") : err.message,
+                });
+            });
+    }
+
+    /**
+     * Cancels a request to join a room by sending a leave request.
+     *
+     * @param {CancelAskToJoinPayload} payload - The payload containing information to cancel the request.
+     * @returns {void}
+     */
+    private cancelAskToJoin(payload: CancelAskToJoinPayload): void {
+        MatrixClientPeg.safeGet()
+            .leave(payload.roomId)
+            .then(() => this.setState({ knocked: false }))
+            .catch((err: MatrixError) =>
+                Modal.createDialog(ErrorDialog, { title: _t("Failed to cancel"), description: err.message }),
+            );
+    }
 }