diff --git a/assets/schemas.json b/assets/schemas.json index 5226bbad..6e8f2f48 100644 Binary files a/assets/schemas.json and b/assets/schemas.json differ diff --git a/src/gateway/opcodes/RequestGuildMembers.ts b/src/gateway/opcodes/RequestGuildMembers.ts index 304d4b39..68c7b7f4 100644 --- a/src/gateway/opcodes/RequestGuildMembers.ts +++ b/src/gateway/opcodes/RequestGuildMembers.ts @@ -1,23 +1,111 @@ /* Spacebar: A FOSS re-implementation and extension of the Discord.com backend. Copyright (C) 2023 Spacebar and Spacebar Contributors - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. - + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ -import { WebSocket } from "@spacebar/gateway"; +import { + getPermission, + GuildMembersChunkEvent, + Member, + Presence, + RequestGuildMembersSchema, +} from "@spacebar/util"; +import { + WebSocket, + Payload, + OPCODES, + Send, +} from "@spacebar/gateway"; +import { check } from "./instanceOf"; +import { FindManyOptions, In, Like } from "typeorm"; -export function onRequestGuildMembers(this: WebSocket) { - // return this.close(CLOSECODES.Unknown_error); +export async function onRequestGuildMembers(this: WebSocket, { d }: Payload) { + // TODO: check data + check.call(this, RequestGuildMembersSchema, d); + + const { guild_id, query, presences, nonce } = + d as RequestGuildMembersSchema; + let { limit, user_ids } = + d as RequestGuildMembersSchema; + + if ("query" in d && (!limit || Number.isNaN(limit))) throw new Error("\"query\" requires \"limit\" to be set"); + if ("query" in d && user_ids) throw new Error("\"query\" and \"user_ids\" are mutually exclusive"); + if (user_ids && !Array.isArray(user_ids)) user_ids = [user_ids]; + user_ids = user_ids as string[] | undefined; + + // TODO: Configurable limit? + if ((query || (user_ids && user_ids.length > 0)) && (!limit || limit > 100)) limit = 100; + + const permissions = await getPermission(this.user_id, guild_id); + permissions.hasThrow("VIEW_CHANNEL"); + + const whereQuery: any = {}; + if (query) { + whereQuery.user = { + username: Like(query + "%") + }; + } else if (user_ids && user_ids.length > 0) { + whereQuery.id = In(user_ids); + } + + const memberFind: FindManyOptions = { + where: { + ...whereQuery, + guild_id + }, + relations: ["user", "roles", ...(presences ? ["presence"] : [])], + }; + if (limit) memberFind.take = Math.abs(Number(limit || 100)); + const members = await Member.find(memberFind); + + const baseData = { + guild_id, + nonce, + } + + const chunks: GuildMembersChunkEvent["data"][] = []; + while (members.length > 0) { + const chunk = members.splice(0, 1000); + + const presenceList: Presence[] = []; + if (presences) { + for await (const member of chunk) { + presenceList.push(member.presence); + delete member.presence; + } + } + + chunks.push({ + ...baseData, + members: chunk.map(member => member.toPublicMember()), + presences: presences ? presenceList : undefined, + chunk_index: chunks.length, + chunk_count: Math.ceil(members.length / 1000), + }); + } + + if (user_ids && user_ids.length > 0) + chunks[0].not_found = user_ids.filter(id => !members.some(member => member.user.id == id)); + + chunks.forEach((chunk) => { + Send(this, { + op: OPCODES.Dispatch, + s: this.sequence++, + t: "GUILD_MEMBERS_CHUNK", + d: chunk, + }); + }); } diff --git a/src/util/interfaces/Event.ts b/src/util/interfaces/Event.ts index 98a64e94..a31e2263 100644 --- a/src/util/interfaces/Event.ts +++ b/src/util/interfaces/Event.ts @@ -1,17 +1,17 @@ /* Spacebar: A FOSS re-implementation and extension of the Discord.com backend. Copyright (C) 2023 Spacebar and Spacebar Contributors - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. - + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ @@ -280,8 +280,8 @@ export interface GuildMembersChunkEvent extends Event { members: PublicMember[]; chunk_index: number; chunk_count: number; - not_found: string[]; - presences: Presence[]; + not_found?: string[]; + presences?: Presence[]; nonce?: string; }; } diff --git a/src/util/schemas/RequestGuildMembersSchema.ts b/src/util/schemas/RequestGuildMembersSchema.ts new file mode 100644 index 00000000..01ba4f2e --- /dev/null +++ b/src/util/schemas/RequestGuildMembersSchema.ts @@ -0,0 +1,35 @@ +/* + Spacebar: A FOSS re-implementation and extension of the Discord.com backend. + Copyright (C) 2023 Spacebar and Spacebar Contributors + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . +*/ + +export interface RequestGuildMembersSchema { + guild_id: string; + query?: string; + limit?: number; + presences?: boolean; + user_ids?: string | string[]; + nonce?: string; +} + +export const RequestGuildMembersSchema = { + guild_id: String, + $query: String, + $limit: Number, + $presences: Boolean, + $user_ids: [] as string | string[], + $nonce: String, +}; diff --git a/src/util/schemas/index.ts b/src/util/schemas/index.ts index 4812b535..62199dfb 100644 --- a/src/util/schemas/index.ts +++ b/src/util/schemas/index.ts @@ -1,17 +1,17 @@ /* Spacebar: A FOSS re-implementation and extension of the Discord.com backend. Copyright (C) 2023 Spacebar and Spacebar Contributors - + This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. - + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . */ @@ -58,6 +58,7 @@ export * from "./PurgeSchema"; export * from "./RegisterSchema"; export * from "./RelationshipPostSchema"; export * from "./RelationshipPutSchema"; +export * from "./RequestGuildMembersSchema"; export * from "./RoleModifySchema"; export * from "./RolePositionUpdateSchema"; export * from "./SelectProtocolSchema";