2022-03-24 21:25:44 +00:00
|
|
|
/*
|
|
|
|
Copyright 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 { sleep } from "matrix-js-sdk/src/utils";
|
2023-02-27 09:15:27 +00:00
|
|
|
import React, { ReactNode } from "react";
|
2022-03-24 21:25:44 +00:00
|
|
|
import { EventStatus } from "matrix-js-sdk/src/models/event-status";
|
|
|
|
import { MatrixEventEvent } from "matrix-js-sdk/src/models/event";
|
|
|
|
import { Room } from "matrix-js-sdk/src/models/room";
|
2023-03-16 10:35:17 +00:00
|
|
|
import { MatrixError } from "matrix-js-sdk/src/matrix";
|
2022-03-24 21:25:44 +00:00
|
|
|
|
|
|
|
import Modal, { IHandle } from "../Modal";
|
|
|
|
import Spinner from "../components/views/elements/Spinner";
|
|
|
|
import { MatrixClientPeg } from "../MatrixClientPeg";
|
|
|
|
import { _t } from "../languageHandler";
|
|
|
|
import ErrorDialog from "../components/views/dialogs/ErrorDialog";
|
|
|
|
import { isMetaSpace } from "../stores/spaces";
|
|
|
|
import SpaceStore from "../stores/spaces/SpaceStore";
|
|
|
|
import dis from "../dispatcher/dispatcher";
|
|
|
|
import { ViewRoomPayload } from "../dispatcher/payloads/ViewRoomPayload";
|
|
|
|
import { Action } from "../dispatcher/actions";
|
|
|
|
import { ViewHomePagePayload } from "../dispatcher/payloads/ViewHomePagePayload";
|
|
|
|
import LeaveSpaceDialog from "../components/views/dialogs/LeaveSpaceDialog";
|
|
|
|
import { AfterLeaveRoomPayload } from "../dispatcher/payloads/AfterLeaveRoomPayload";
|
|
|
|
import { bulkSpaceBehaviour } from "./space";
|
2022-10-19 12:07:03 +00:00
|
|
|
import { SdkContextClass } from "../contexts/SDKContext";
|
2023-03-09 14:49:59 +00:00
|
|
|
import SettingsStore from "../settings/SettingsStore";
|
2022-03-24 21:25:44 +00:00
|
|
|
|
2023-01-12 13:25:14 +00:00
|
|
|
export async function leaveRoomBehaviour(roomId: string, retry = true, spinner = true): Promise<void> {
|
2023-02-16 17:21:44 +00:00
|
|
|
let spinnerModal: IHandle<any> | undefined;
|
2022-03-24 21:25:44 +00:00
|
|
|
if (spinner) {
|
2023-02-03 15:27:47 +00:00
|
|
|
spinnerModal = Modal.createDialog(Spinner, undefined, "mx_Dialog_spinner");
|
2022-03-24 21:25:44 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const cli = MatrixClientPeg.get();
|
|
|
|
let leavingAllVersions = true;
|
2023-03-09 14:49:59 +00:00
|
|
|
const history = cli.getRoomUpgradeHistory(
|
|
|
|
roomId,
|
|
|
|
false,
|
|
|
|
SettingsStore.getValue("feature_dynamic_room_predecessors"),
|
|
|
|
);
|
2022-03-24 21:25:44 +00:00
|
|
|
if (history && history.length > 0) {
|
|
|
|
const currentRoom = history[history.length - 1];
|
|
|
|
if (currentRoom.roomId !== roomId) {
|
|
|
|
// The user is trying to leave an older version of the room. Let them through
|
|
|
|
// without making them leave the current version of the room.
|
|
|
|
leavingAllVersions = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
const room = cli.getRoom(roomId);
|
|
|
|
// await any queued messages being sent so that they do not fail
|
2022-12-12 11:24:14 +00:00
|
|
|
await Promise.all(
|
|
|
|
room
|
|
|
|
.getPendingEvents()
|
|
|
|
.filter((ev) => {
|
2023-02-16 17:21:44 +00:00
|
|
|
return [EventStatus.QUEUED, EventStatus.ENCRYPTING, EventStatus.SENDING].includes(ev.status!);
|
2022-12-12 11:24:14 +00:00
|
|
|
})
|
|
|
|
.map(
|
|
|
|
(ev) =>
|
|
|
|
new Promise<void>((resolve, reject) => {
|
2023-01-12 13:25:14 +00:00
|
|
|
const handler = (): void => {
|
2022-12-12 11:24:14 +00:00
|
|
|
if (ev.status === EventStatus.NOT_SENT) {
|
|
|
|
spinnerModal?.close();
|
|
|
|
reject(ev.error);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!ev.status || ev.status === EventStatus.SENT) {
|
|
|
|
ev.off(MatrixEventEvent.Status, handler);
|
|
|
|
resolve();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
ev.on(MatrixEventEvent.Status, handler);
|
|
|
|
}),
|
|
|
|
),
|
|
|
|
);
|
|
|
|
|
2023-03-16 10:35:17 +00:00
|
|
|
let results: { [roomId: string]: Error | MatrixError | null } = {};
|
2022-03-24 21:25:44 +00:00
|
|
|
if (!leavingAllVersions) {
|
|
|
|
try {
|
|
|
|
await cli.leave(roomId);
|
|
|
|
} catch (e) {
|
|
|
|
if (e?.data?.errcode) {
|
|
|
|
const message = e.data.error || _t("Unexpected server error trying to leave the room");
|
|
|
|
results[roomId] = Object.assign(new Error(message), { errcode: e.data.errcode, data: e.data });
|
|
|
|
} else {
|
|
|
|
results[roomId] = e || new Error("Failed to leave room for unknown causes");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
results = await cli.leaveRoomChain(roomId, retry);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (retry) {
|
2023-03-16 10:35:17 +00:00
|
|
|
const limitExceededError = Object.values(results).find(
|
|
|
|
(e) => (e as MatrixError)?.errcode === "M_LIMIT_EXCEEDED",
|
|
|
|
) as MatrixError;
|
2022-03-24 21:25:44 +00:00
|
|
|
if (limitExceededError) {
|
|
|
|
await sleep(limitExceededError.data.retry_after_ms ?? 100);
|
|
|
|
return leaveRoomBehaviour(roomId, false, false);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
spinnerModal?.close();
|
|
|
|
|
2022-12-12 11:24:14 +00:00
|
|
|
const errors = Object.entries(results).filter((r) => !!r[1]);
|
2022-03-24 21:25:44 +00:00
|
|
|
if (errors.length > 0) {
|
2023-02-27 09:15:27 +00:00
|
|
|
const messages: ReactNode[] = [];
|
2022-03-24 21:25:44 +00:00
|
|
|
for (const roomErr of errors) {
|
2023-03-16 10:35:17 +00:00
|
|
|
const err = roomErr[1] as MatrixError; // [0] is the roomId
|
2022-03-24 21:25:44 +00:00
|
|
|
let message = _t("Unexpected server error trying to leave the room");
|
2023-03-16 10:35:17 +00:00
|
|
|
if (err?.errcode && err.message) {
|
2022-12-12 11:24:14 +00:00
|
|
|
if (err.errcode === "M_CANNOT_LEAVE_SERVER_NOTICE_ROOM") {
|
2022-06-14 16:51:51 +00:00
|
|
|
Modal.createDialog(ErrorDialog, {
|
2022-03-24 21:25:44 +00:00
|
|
|
title: _t("Can't leave Server Notices room"),
|
|
|
|
description: _t(
|
|
|
|
"This room is used for important messages from the Homeserver, " +
|
2022-12-12 11:24:14 +00:00
|
|
|
"so you cannot leave it.",
|
2022-03-24 21:25:44 +00:00
|
|
|
),
|
|
|
|
});
|
|
|
|
return;
|
|
|
|
}
|
2023-03-16 10:35:17 +00:00
|
|
|
message = results[roomId]!.message;
|
2022-03-24 21:25:44 +00:00
|
|
|
}
|
2022-12-12 11:24:14 +00:00
|
|
|
messages.push(message, React.createElement("BR")); // createElement to avoid using a tsx file in utils
|
2022-03-24 21:25:44 +00:00
|
|
|
}
|
2022-06-14 16:51:51 +00:00
|
|
|
Modal.createDialog(ErrorDialog, {
|
2022-03-24 21:25:44 +00:00
|
|
|
title: _t("Error leaving room"),
|
|
|
|
description: messages,
|
|
|
|
});
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2022-11-10 12:34:43 +00:00
|
|
|
if (SdkContextClass.instance.roomViewStore.getRoomId() === roomId) {
|
|
|
|
// We were viewing the room that was just left. In order to avoid
|
|
|
|
// accidentally viewing the next room in the list and clearing its
|
|
|
|
// notifications, switch to a neutral ground such as the home page or
|
|
|
|
// space landing page.
|
|
|
|
if (isMetaSpace(SpaceStore.instance.activeSpace)) {
|
|
|
|
dis.dispatch<ViewHomePagePayload>({ action: Action.ViewHomePage });
|
|
|
|
} else if (SpaceStore.instance.activeSpace === roomId) {
|
|
|
|
// View the parent space, if there is one
|
|
|
|
const parent = SpaceStore.instance.getCanonicalParent(roomId);
|
|
|
|
if (parent !== null) {
|
|
|
|
dis.dispatch<ViewRoomPayload>({
|
|
|
|
action: Action.ViewRoom,
|
|
|
|
room_id: parent.roomId,
|
|
|
|
metricsTrigger: undefined, // other
|
|
|
|
});
|
|
|
|
} else {
|
|
|
|
dis.dispatch<ViewHomePagePayload>({ action: Action.ViewHomePage });
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
dis.dispatch<ViewRoomPayload>({
|
|
|
|
action: Action.ViewRoom,
|
|
|
|
room_id: SpaceStore.instance.activeSpace,
|
|
|
|
metricsTrigger: undefined, // other
|
|
|
|
});
|
|
|
|
}
|
2022-03-24 21:25:44 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-01-12 13:25:14 +00:00
|
|
|
export const leaveSpace = (space: Room): void => {
|
2022-12-12 11:24:14 +00:00
|
|
|
Modal.createDialog(
|
|
|
|
LeaveSpaceDialog,
|
|
|
|
{
|
|
|
|
space,
|
2023-01-12 13:25:14 +00:00
|
|
|
onFinished: async (leave: boolean, rooms: Room[]): Promise<void> => {
|
2022-12-12 11:24:14 +00:00
|
|
|
if (!leave) return;
|
|
|
|
await bulkSpaceBehaviour(space, rooms, (room) => leaveRoomBehaviour(room.roomId));
|
|
|
|
|
|
|
|
dis.dispatch<AfterLeaveRoomPayload>({
|
|
|
|
action: Action.AfterLeaveRoom,
|
|
|
|
room_id: space.roomId,
|
|
|
|
});
|
|
|
|
},
|
2022-03-24 21:25:44 +00:00
|
|
|
},
|
2022-12-12 11:24:14 +00:00
|
|
|
"mx_LeaveSpaceDialog_wrapper",
|
|
|
|
);
|
2022-03-24 21:25:44 +00:00
|
|
|
};
|