matrix-react-sdk/src/stores/CommunityPrototypeStore.ts

SDK for matrix.org using React

/*
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.
*/

import { AsyncStoreWithClient } from "./AsyncStoreWithClient";
import defaultDispatcher from "../dispatcher/dispatcher";
import { ActionPayload } from "../dispatcher/payloads";
import { Room } from "matrix-js-sdk/src/models/room";
import { EffectiveMembership, getEffectiveMembership } from "../utils/membership";
import SettingsStore from "../settings/SettingsStore";
import * as utils from "matrix-js-sdk/src/utils";
import { UPDATE_EVENT } from "./AsyncStore";
import FlairStore from "./FlairStore";
import GroupFilterOrderStore from "./GroupFilterOrderStore";
import GroupStore from "./GroupStore";
import dis from "../dispatcher/dispatcher";
import { isNullOrUndefined } from "matrix-js-sdk/src/utils";

interface IState {
    // nothing of value - we use account data
}

export interface IRoomProfile {
    displayName: string;
    avatarMxc: string;
}

export class CommunityPrototypeStore extends AsyncStoreWithClient<IState> {
    private static internalInstance = new CommunityPrototypeStore();

    private constructor() {
        super(defaultDispatcher, {});
    }

    public static get instance(): CommunityPrototypeStore {
        return CommunityPrototypeStore.internalInstance;
    }

    public static getUpdateEventName(roomId: string): string {
        return `${UPDATE_EVENT}:${roomId}`;
    }

    public getSelectedCommunityId(): string {
        if (SettingsStore.getValue("feature_communities_v2_prototypes")) {
            return GroupFilterOrderStore.getSelectedTags()[0];
        }
        return null; // no selection as far as this function is concerned
    }

    public getSelectedCommunityName(): string {
        return CommunityPrototypeStore.instance.getCommunityName(this.getSelectedCommunityId());
    }

    public getSelectedCommunityGeneralChat(): Room {
        const communityId = this.getSelectedCommunityId();
        if (communityId) {
            return this.getGeneralChat(communityId);
        }
    }

    public getCommunityName(communityId: string): string {
        const profile = FlairStore.getGroupProfileCachedFast(this.matrixClient, communityId);
        return profile?.name || communityId;
    }

    public getCommunityProfile(communityId: string): { name?: string, avatarUrl?: string } {
        return FlairStore.getGroupProfileCachedFast(this.matrixClient, communityId);
    }

    public getGeneralChat(communityId: string): Room {
        const rooms = GroupStore.getGroupRooms(communityId)
            .map(r => this.matrixClient.getRoom(r.roomId))
            .filter(r => !!r);
        let chat = rooms.find(r => {
            const idState = r.currentState.getStateEvents("im.vector.general_chat", "");
            if (!idState || idState.getContent()['groupId'] !== communityId) return false;
            return true;
        });
        if (!chat) chat = rooms[0];
        return chat; // can be null
    }

    public isAdminOf(communityId: string): boolean {
        const members = GroupStore.getGroupMembers(communityId);
        const myMember = members.find(m => m.userId === this.matrixClient.getUserId());
        return myMember?.isPrivileged;
    }

    public canInviteTo(communityId: string): boolean {
        const generalChat = this.getGeneralChat(communityId);
        if (!generalChat) return this.isAdminOf(communityId);

        const myMember = generalChat.getMember(this.matrixClient.getUserId());
        if (!myMember) return this.isAdminOf(communityId);

        const pl = generalChat.currentState.getStateEvents("m.room.power_levels", "");
        if (!pl) return this.isAdminOf(communityId);

        const invitePl = isNullOrUndefined(pl.invite) ? 50 : Number(pl.invite);
        return invitePl <= myMember.powerLevel;
    }

    protected async onAction(payload: ActionPayload): Promise<any> {
        if (!this.matrixClient || !SettingsStore.getValue("feature_communities_v2_prototypes")) {
            return;
        }

        if (payload.action === "MatrixActions.Room.myMembership") {
            const room: Room = payload.room;
            const membership = getEffectiveMembership(payload.membership);
            const oldMembership = getEffectiveMembership(payload.oldMembership);
            if (membership === oldMembership) return;

            if (membership === EffectiveMembership.Invite) {
                try {
                    const path = utils.encodeUri("/rooms/$roomId/group_info", {$roomId: room.roomId});
                    const profile = await this.matrixClient._http.authedRequest(
                        undefined, "GET", path,
                        undefined, undefined,
                        {prefix: "/_matrix/client/unstable/im.vector.custom"});
                    // we use global account data because per-room account data on invites is unreliable
                    await this.matrixClient.setAccountData("im.vector.group_info." + room.roomId, profile);
                } catch (e) {
                    console.warn("Non-fatal error getting group information for invite:", e);
                }
            }
        } else if (payload.action === "MatrixActions.accountData") {
            if (payload.event_type.startsWith("im.vector.group_info.")) {
                const roomId = payload.event_type.substring("im.vector.group_info.".length);
                this.emit(CommunityPrototypeStore.getUpdateEventName(roomId), roomId);
            }
        } else if (payload.action === "select_tag") {
            // Automatically select the general chat when switching communities
            const chat = this.getGeneralChat(payload.tag);
            if (chat) {
                dis.dispatch({
                    action: 'view_room',
                    room_id: chat.roomId,
                });
            }
        }
    }

    public getInviteProfile(roomId: string): IRoomProfile {
        if (!this.matrixClient) return {displayName: null, avatarMxc: null};
        const room = this.matrixClient.getRoom(roomId);
        if (SettingsStore.getValue("feature_communities_v2_prototypes")) {
            const data = this.matrixClient.getAccountData("im.vector.group_info." + roomId);
            if (data && data.getContent()) {
                return {displayName: data.getContent().name, avatarMxc: data.getContent().avatar_url};
            }
        }
        return {displayName: room.name, avatarMxc: room.avatar_url};
    }

    protected async onReady(): Promise<any> {
        for (const room of this.matrixClient.getRooms()) {
            const myMember = room.currentState.getMembers().find(m => m.userId === this.matrixClient.getUserId());
            if (!myMember) continue;
            if (getEffectiveMembership(myMember.membership) === EffectiveMembership.Invite) {
                // Fake an update for anything that might have started listening before the invite
                // data was available (eg: RoomPreviewBar after a refresh)
                this.emit(CommunityPrototypeStore.getUpdateEventName(room.roomId), room.roomId);
            }
        }
    }
}