2020-04-28 23:12:58 +03:00
|
|
|
/*
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
2020-05-12 01:12:45 +03:00
|
|
|
import { Room } from "matrix-js-sdk/src/models/room";
|
2020-08-20 04:21:40 +03:00
|
|
|
import { MatrixClientPeg } from "../MatrixClientPeg";
|
|
|
|
import { _t } from "../languageHandler";
|
|
|
|
import Modal from "../Modal";
|
|
|
|
import ErrorDialog from "../components/views/dialogs/ErrorDialog";
|
|
|
|
import React from "react";
|
|
|
|
import dis from "../dispatcher/dispatcher";
|
|
|
|
import RoomViewStore from "../stores/RoomViewStore";
|
2020-04-28 23:12:58 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Approximation of a membership status for a given room.
|
|
|
|
*/
|
|
|
|
export enum EffectiveMembership {
|
|
|
|
/**
|
|
|
|
* The user is effectively joined to the room. For example, actually joined
|
|
|
|
* or knocking on the room (when that becomes possible).
|
|
|
|
*/
|
|
|
|
Join = "JOIN",
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The user is effectively invited to the room. Currently this is a direct map
|
|
|
|
* to the invite membership as no other membership states are effectively
|
|
|
|
* invites.
|
|
|
|
*/
|
|
|
|
Invite = "INVITE",
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The user is effectively no longer in the room. For example, kicked,
|
|
|
|
* banned, or voluntarily left.
|
|
|
|
*/
|
|
|
|
Leave = "LEAVE",
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface MembershipSplit {
|
|
|
|
// @ts-ignore - TS wants this to be a string key, but we know better.
|
|
|
|
[state: EffectiveMembership]: Room[];
|
|
|
|
}
|
|
|
|
|
|
|
|
export function splitRoomsByMembership(rooms: Room[]): MembershipSplit {
|
|
|
|
const split: MembershipSplit = {
|
|
|
|
[EffectiveMembership.Invite]: [],
|
|
|
|
[EffectiveMembership.Join]: [],
|
|
|
|
[EffectiveMembership.Leave]: [],
|
|
|
|
};
|
|
|
|
|
|
|
|
for (const room of rooms) {
|
|
|
|
split[getEffectiveMembership(room.getMyMembership())].push(room);
|
|
|
|
}
|
|
|
|
|
|
|
|
return split;
|
|
|
|
}
|
|
|
|
|
|
|
|
export function getEffectiveMembership(membership: string): EffectiveMembership {
|
|
|
|
if (membership === 'invite') {
|
|
|
|
return EffectiveMembership.Invite;
|
|
|
|
} else if (membership === 'join') {
|
2020-08-03 18:02:26 +03:00
|
|
|
// TODO: Include knocks? Update docs as needed in the enum. https://github.com/vector-im/element-web/issues/14237
|
2020-04-28 23:12:58 +03:00
|
|
|
return EffectiveMembership.Join;
|
|
|
|
} else {
|
|
|
|
// Probably a leave, kick, or ban
|
|
|
|
return EffectiveMembership.Leave;
|
|
|
|
}
|
|
|
|
}
|
2020-08-20 04:21:40 +03:00
|
|
|
|
|
|
|
export async function leaveRoomBehaviour(roomId: string): Promise<boolean> {
|
|
|
|
let leavingAllVersions = true;
|
|
|
|
const history = await MatrixClientPeg.get().getRoomUpgradeHistory(roomId);
|
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
let results: { [roomId: string]: Error & { errcode: string, message: string } } = {};
|
|
|
|
if (!leavingAllVersions || true) {
|
|
|
|
try {
|
|
|
|
await MatrixClientPeg.get().leave(roomId);
|
|
|
|
} catch (e) {
|
|
|
|
if (e && e.data && 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});
|
|
|
|
} else {
|
|
|
|
results[roomId] = e || new Error("Failed to leave room for unknown causes");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
results = await MatrixClientPeg.get().leaveRoomChain(roomId);
|
|
|
|
}
|
|
|
|
|
|
|
|
const errors = Object.entries(results).filter(r => !!r[1]);
|
|
|
|
if (errors.length > 0) {
|
|
|
|
let messages = [];
|
|
|
|
for (const err of errors) {
|
|
|
|
let message = _t("Unexpected server error trying to leave the room");
|
|
|
|
if (results[roomId].errcode && results[roomId].message) {
|
|
|
|
if (results[roomId].errcode === 'M_CANNOT_LEAVE_SERVER_NOTICE_ROOM') {
|
|
|
|
Modal.createTrackedDialog('Error Leaving Room', '', ErrorDialog, {
|
|
|
|
title: _t("Can't leave Server Notices room"),
|
|
|
|
description: _t(
|
|
|
|
"This room is used for important messages from the Homeserver, " +
|
|
|
|
"so you cannot leave it.",
|
|
|
|
),
|
|
|
|
});
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
message = results[roomId].message;
|
|
|
|
}
|
|
|
|
messages.push(message, React.createElement('BR')); // createElement to avoid using a tsx file in utils
|
|
|
|
}
|
|
|
|
Modal.createTrackedDialog('Error Leaving Room', '', ErrorDialog, {
|
|
|
|
title: _t("Error leaving room"),
|
|
|
|
description: messages,
|
|
|
|
});
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (RoomViewStore.getRoomId() === roomId) {
|
|
|
|
dis.dispatch({action: 'view_next_room'});
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|