|
| 1 | +import type { IUser, IRole } from '@rocket.chat/core-typings'; |
| 2 | +import { Subscriptions } from '@rocket.chat/models'; |
| 3 | +import { escapeRegExp } from '@rocket.chat/string-helpers'; |
| 4 | +import type { Document, FilterOperators } from 'mongodb'; |
| 5 | + |
| 6 | +import { settings } from '../../app/settings/server'; |
| 7 | + |
| 8 | +type FindUsersParam = { |
| 9 | + rid: string; |
| 10 | + status?: FilterOperators<string>; |
| 11 | + skip?: number; |
| 12 | + limit?: number; |
| 13 | + filter?: string; |
| 14 | + sort?: Record<string, any>; |
| 15 | + rolesInOrder?: IRole['_id'][]; |
| 16 | + exceptions?: string[]; |
| 17 | + extraQuery?: Document[]; |
| 18 | +}; |
| 19 | + |
| 20 | +type UserWithRoleData = IUser & { |
| 21 | + roles: IRole['_id'][]; |
| 22 | +}; |
| 23 | + |
| 24 | +export async function findUsersOfRoomOrderedByRole({ |
| 25 | + rid, |
| 26 | + status, |
| 27 | + skip = 0, |
| 28 | + limit = 0, |
| 29 | + filter = '', |
| 30 | + sort, |
| 31 | + rolesInOrder = [], |
| 32 | + exceptions = [], |
| 33 | + extraQuery = [], |
| 34 | +}: FindUsersParam): Promise<{ members: UserWithRoleData[]; total: number }> { |
| 35 | + const searchFields = settings.get<string>('Accounts_SearchFields').trim().split(','); |
| 36 | + const termRegex = new RegExp(escapeRegExp(filter), 'i'); |
| 37 | + const orStmt = filter && searchFields.length ? searchFields.map((field) => ({ [field.trim()]: termRegex })) : []; |
| 38 | + |
| 39 | + const useRealName = settings.get('UI_Use_Real_Name'); |
| 40 | + const defaultSort = useRealName ? { name: 1 } : { username: 1 }; |
| 41 | + |
| 42 | + const sortCriteria = { |
| 43 | + rolePriority: 1, |
| 44 | + statusConnection: -1, |
| 45 | + ...(sort || defaultSort), |
| 46 | + }; |
| 47 | + |
| 48 | + const userLookupPipeline: Document[] = [{ $match: { $expr: { $eq: ['$_id', '$$userId'] } } }]; |
| 49 | + |
| 50 | + if (status) { |
| 51 | + userLookupPipeline.push({ $match: { status } }); |
| 52 | + } |
| 53 | + |
| 54 | + userLookupPipeline.push({ |
| 55 | + $match: { |
| 56 | + $and: [ |
| 57 | + { |
| 58 | + active: true, |
| 59 | + username: { |
| 60 | + $exists: true, |
| 61 | + ...(exceptions.length > 0 && { $nin: exceptions }), |
| 62 | + }, |
| 63 | + ...(filter && orStmt.length > 0 && { $or: orStmt }), |
| 64 | + }, |
| 65 | + ...extraQuery, |
| 66 | + ], |
| 67 | + }, |
| 68 | + }); |
| 69 | + |
| 70 | + userLookupPipeline.push({ |
| 71 | + $project: { |
| 72 | + _id: 1, |
| 73 | + username: 1, |
| 74 | + name: 1, |
| 75 | + nickname: 1, |
| 76 | + status: 1, |
| 77 | + avatarETag: 1, |
| 78 | + _updatedAt: 1, |
| 79 | + federated: 1, |
| 80 | + statusConnection: 1, |
| 81 | + }, |
| 82 | + }); |
| 83 | + |
| 84 | + const defaultPriority = rolesInOrder.length + 1; |
| 85 | + |
| 86 | + const branches = rolesInOrder.map((role, index) => ({ |
| 87 | + case: { $eq: ['$$this', role] }, |
| 88 | + then: index + 1, |
| 89 | + })); |
| 90 | + |
| 91 | + const filteredPipeline: Document[] = [ |
| 92 | + { |
| 93 | + $lookup: { |
| 94 | + from: 'users', |
| 95 | + let: { userId: '$u._id' }, |
| 96 | + pipeline: userLookupPipeline, |
| 97 | + as: 'userDetails', |
| 98 | + }, |
| 99 | + }, |
| 100 | + { $unwind: '$userDetails' }, |
| 101 | + { |
| 102 | + $addFields: { |
| 103 | + primaryRole: { |
| 104 | + $reduce: { |
| 105 | + input: '$roles', |
| 106 | + initialValue: { role: null, priority: defaultPriority }, |
| 107 | + in: { |
| 108 | + $let: { |
| 109 | + vars: { |
| 110 | + currentPriority: { |
| 111 | + $switch: { |
| 112 | + branches, |
| 113 | + default: defaultPriority, |
| 114 | + }, |
| 115 | + }, |
| 116 | + }, |
| 117 | + in: { |
| 118 | + $cond: [ |
| 119 | + { |
| 120 | + $and: [{ $in: ['$$this', rolesInOrder] }, { $lt: ['$$currentPriority', '$$value.priority'] }], |
| 121 | + }, |
| 122 | + { role: '$$this', priority: '$$currentPriority' }, |
| 123 | + '$$value', |
| 124 | + ], |
| 125 | + }, |
| 126 | + }, |
| 127 | + }, |
| 128 | + }, |
| 129 | + }, |
| 130 | + }, |
| 131 | + }, |
| 132 | + { |
| 133 | + $addFields: { |
| 134 | + rolePriority: { $ifNull: ['$primaryRole.priority', defaultPriority] }, |
| 135 | + }, |
| 136 | + }, |
| 137 | + { |
| 138 | + $project: { |
| 139 | + _id: '$userDetails._id', |
| 140 | + rid: 1, |
| 141 | + roles: 1, |
| 142 | + primaryRole: '$primaryRole.role', |
| 143 | + rolePriority: 1, |
| 144 | + username: '$userDetails.username', |
| 145 | + name: '$userDetails.name', |
| 146 | + nickname: '$userDetails.nickname', |
| 147 | + status: '$userDetails.status', |
| 148 | + avatarETag: '$userDetails.avatarETag', |
| 149 | + _updatedAt: '$userDetails._updatedAt', |
| 150 | + federated: '$userDetails.federated', |
| 151 | + statusConnection: '$userDetails.statusConnection', |
| 152 | + }, |
| 153 | + }, |
| 154 | + ]; |
| 155 | + |
| 156 | + const facetPipeline: Document[] = [ |
| 157 | + { $match: { rid } }, |
| 158 | + { |
| 159 | + $facet: { |
| 160 | + totalCount: [{ $match: { rid } }, ...filteredPipeline, { $count: 'total' }], |
| 161 | + members: [ |
| 162 | + { $match: { rid } }, |
| 163 | + ...filteredPipeline, |
| 164 | + { $sort: sortCriteria }, |
| 165 | + ...(skip > 0 ? [{ $skip: skip }] : []), |
| 166 | + ...(limit > 0 ? [{ $limit: limit }] : []), |
| 167 | + ], |
| 168 | + }, |
| 169 | + }, |
| 170 | + { |
| 171 | + $project: { |
| 172 | + members: 1, |
| 173 | + totalCount: { $arrayElemAt: ['$totalCount.total', 0] }, |
| 174 | + }, |
| 175 | + }, |
| 176 | + ]; |
| 177 | + |
| 178 | + const [result] = await Subscriptions.col.aggregate(facetPipeline, { allowDiskUse: true }).toArray(); |
| 179 | + |
| 180 | + return { |
| 181 | + members: result.members.map((member: any) => { |
| 182 | + delete member.primaryRole; |
| 183 | + delete member.rolePriority; |
| 184 | + return member; |
| 185 | + }), |
| 186 | + total: result.totalCount, |
| 187 | + }; |
| 188 | +} |
0 commit comments