RocketChat/Rocket.Chat

View on GitHub
apps/meteor/server/services/federation/Federation.ts

Summary

Maintainability
A
3 hrs
Test Coverage
import type { IRoom, IUser, ValueOf } from '@rocket.chat/core-typings';
import { isRoomFederated, isDirectMessageRoom } from '@rocket.chat/core-typings';
import { Subscriptions } from '@rocket.chat/models';

import { RoomMemberActions, RoomSettingsEnum } from '../../../definition/IRoomTypeConfig';
import {
    escapeExternalFederationEventId,
    unescapeExternalFederationEventId,
} from './infrastructure/rocket-chat/adapters/federation-id-escape-helper';

const allowedActionsInFederatedRooms: ValueOf<typeof RoomMemberActions>[] = [
    RoomMemberActions.REMOVE_USER,
    RoomMemberActions.SET_AS_OWNER,
    RoomMemberActions.SET_AS_MODERATOR,
    RoomMemberActions.INVITE,
    RoomMemberActions.JOIN,
    RoomMemberActions.LEAVE,
];

const allowedActionsForModerators = allowedActionsInFederatedRooms.filter((action) => action !== RoomMemberActions.SET_AS_OWNER);

const allowedRoomSettingsChangesInFederatedRooms: ValueOf<typeof RoomSettingsEnum>[] = [RoomSettingsEnum.NAME, RoomSettingsEnum.TOPIC];

export class Federation {
    public static async actionAllowed(room: IRoom, action: ValueOf<typeof RoomMemberActions>, userId?: IUser['_id']): Promise<boolean> {
        if (!isRoomFederated(room)) {
            return false;
        }
        if (isDirectMessageRoom(room)) {
            return false;
        }
        if (!userId) {
            return true;
        }

        const userSubscription = await Subscriptions.findOneByRoomIdAndUserId(room._id, userId);
        if (!userSubscription) {
            return true;
        }

        if (action === RoomMemberActions.LEAVE) {
            return true;
        }

        if (userSubscription.roles?.includes('owner')) {
            return allowedActionsInFederatedRooms.includes(action);
        }

        if (userSubscription.roles?.includes('moderator')) {
            return allowedActionsForModerators.includes(action);
        }

        return false;
    }

    public static isAFederatedUsername(username: string): boolean {
        return username.includes('@') && username.includes(':');
    }

    public static escapeExternalFederationEventId(externalEventId: string): string {
        return escapeExternalFederationEventId(externalEventId);
    }

    public static unescapeExternalFederationEventId(externalEventId: string): string {
        return unescapeExternalFederationEventId(externalEventId);
    }

    public static isRoomSettingAllowed(room: Partial<IRoom>, setting: ValueOf<typeof RoomSettingsEnum>): boolean {
        if (!isRoomFederated(room)) {
            return false;
        }

        if (isDirectMessageRoom(room)) {
            return false;
        }
        return allowedRoomSettingsChangesInFederatedRooms.includes(setting);
    }
}