RocketChat/Rocket.Chat

View on GitHub
apps/meteor/app/user-status/server/methods/insertOrUpdateUserStatus.ts

Summary

Maintainability
B
5 hrs
Test Coverage
import { api } from '@rocket.chat/core-services';
import type { ICustomUserStatus } from '@rocket.chat/core-typings';
import type { ServerMethods } from '@rocket.chat/ddp-client';
import type { InsertionModel } from '@rocket.chat/model-typings';
import { CustomUserStatus } from '@rocket.chat/models';
import { Meteor } from 'meteor/meteor';

import { trim } from '../../../../lib/utils/stringUtils';
import { hasPermissionAsync } from '../../../authorization/server/functions/hasPermission';

declare module '@rocket.chat/ddp-client' {
    // eslint-disable-next-line @typescript-eslint/naming-convention
    interface ServerMethods {
        insertOrUpdateUserStatus(userStatusData: {
            _id?: string;
            name: string;
            statusType: string;
            status: string;
            emoji: string;
            message: string;
            order: number;
            previousName?: string;
            previousStatusType?: string;
        }): string | boolean;
    }
}

Meteor.methods<ServerMethods>({
    async insertOrUpdateUserStatus(userStatusData) {
        if (!this.userId || !(await hasPermissionAsync(this.userId, 'manage-user-status'))) {
            throw new Meteor.Error('not_authorized');
        }

        if (!trim(userStatusData.name)) {
            throw new Meteor.Error('error-the-field-is-required', 'The field Name is required', {
                method: 'insertOrUpdateUserStatus',
                field: 'Name',
            });
        }

        // allow all characters except >, <, &, ", '
        // more practical than allowing specific sets of characters; also allows foreign languages
        const nameValidation = /[><&"']/;

        if (nameValidation.test(userStatusData.name)) {
            throw new Meteor.Error('error-input-is-not-a-valid-field', `${userStatusData.name} is not a valid name`, {
                method: 'insertOrUpdateUserStatus',
                input: userStatusData.name,
                field: 'Name',
            });
        }

        let matchingResults = [];

        if (userStatusData._id) {
            matchingResults = await CustomUserStatus.findByNameExceptId(userStatusData.name, userStatusData._id).toArray();
        } else {
            matchingResults = await CustomUserStatus.findByName(userStatusData.name).toArray();
        }

        if (matchingResults.length > 0) {
            throw new Meteor.Error('Custom_User_Status_Error_Name_Already_In_Use', 'The custom user status name is already in use', {
                method: 'insertOrUpdateUserStatus',
            });
        }

        const validStatusTypes = ['online', 'away', 'busy', 'offline'];
        if (userStatusData.statusType && validStatusTypes.indexOf(userStatusData.statusType) < 0) {
            throw new Meteor.Error('error-input-is-not-a-valid-field', `${userStatusData.statusType} is not a valid status type`, {
                method: 'insertOrUpdateUserStatus',
                input: userStatusData.statusType,
                field: 'StatusType',
            });
        }

        if (!userStatusData._id) {
            // insert user status
            const createUserStatus: InsertionModel<ICustomUserStatus> = {
                name: userStatusData.name,
                statusType: userStatusData.statusType,
            };

            const _id = (await CustomUserStatus.create(createUserStatus)).insertedId;

            void api.broadcast('user.updateCustomStatus', { ...createUserStatus, _id });

            return _id;
        }

        // update User status
        if (userStatusData.name !== userStatusData.previousName) {
            await CustomUserStatus.setName(userStatusData._id, userStatusData.name);
        }

        if (userStatusData.statusType !== userStatusData.previousStatusType) {
            await CustomUserStatus.setStatusType(userStatusData._id, userStatusData.statusType);
        }

        void api.broadcast('user.updateCustomStatus', { ...userStatusData, _id: userStatusData._id });

        return true;
    },
});