Add attachment list API

2026-08-23 20:29:53 +00:00 · 2026-08-02 01:00:21 +02:00
parent fbd4bd2b5a
commit ffd7f00336
8 changed files with 223 additions and 2 deletions
@@ -0,0 +1,97 @@
+/*
+	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 <https://www.gnu.org/licenses/>.
+*/
+
+import { Request, Response, Router } from "express";
+import { HTTPError } from "lambert-server/HTTPError";
+import { FindOptionsOrderValue, LessThan, MoreThan } from "typeorm";
+import { route } from "@spacebar/api/middlewares";
+import { Attachment, Channel, Message } from "@spacebar/database";
+import { FieldErrors, getPermission } from "@spacebar/util";
+import { AttachmentListResponse } from "@spacebar/schemas/api/spacebar/AttachmentListResponse";
+
+const router: Router = Router({ mergeParams: true });
+
+router.get(
+    "/",
+    route({
+        responses: {
+            200: {
+                body: "AttachmentListResponse",
+            },
+            403: {
+                body: "APIErrorResponse",
+            },
+            422: {
+                body: "APIErrorResponse",
+            },
+        },
+    }),
+    async (req: Request, res: Response) => {
+        const { channel_id } = req.params as { [key: string]: string };
+        const channel = await Channel.findOneOrFail({
+            where: { id: channel_id },
+        });
+        const { sort_order, limit } = req.query;
+
+        const parsedLimit = Number(limit) || 50;
+        if (parsedLimit < 1 || parsedLimit > 100) throw new HTTPError("limit must be between 1 and 100", 422);
+
+        if (sort_order) {
+            if (typeof sort_order != "string" || ["desc", "asc"].indexOf(sort_order) == -1)
+                throw FieldErrors({
+                    sort_order: {
+                        message: "Value must be one of ('desc', 'asc').",
+                        code: "BASE_TYPE_CHOICES",
+                    },
+                }); // todo this is wrong
+        }
+
+        const permissions = await getPermission(req.user_id, channel.guild_id, channel_id as string | undefined);
+        permissions.hasThrow("VIEW_CHANNEL");
+        if (!permissions.has("READ_MESSAGE_HISTORY")) return res.json({ items: [], total: 0 } satisfies AttachmentListResponse);
+
+        const attCount = Attachment.count({ where: { channel_id: req.params.channel_id as string } });
+        const atts = await Attachment.find({
+            where: {
+                channel_id: req.params.channel_id as string,
+                id: (sort_order == "asc" ? MoreThan : LessThan)((req.params.after as string) ?? "0"),
+            },
+            order: {
+                id: sort_order as FindOptionsOrderValue,
+            },
+            take: parsedLimit,
+        });
+
+        return res.json({
+            items: atts.map((x) => ({
+                attachment: x.signUrls({
+                    userAgent: req.headers["user-agent"],
+                    ip: req.ip,
+                }),
+                message_reference: {
+                    message_id: x.message_id,
+                    channel_id: x.channel_id,
+                    guild_id: channel.guild_id,
+                },
+            })),
+            total: await attCount,
+        } satisfies AttachmentListResponse);
+    },
+);
+
+export default router;