matrix-nodejs-homeserver 0.0.0-stage → 0.2.0

package/dist/api/spaces.js

@@ -0,0 +1,172 @@
+import { splitStateKey, stripState } from "../core/events.js";
+import { errors } from "../core/errors.js";
+import { getState, membershipOf } from "../core/authrules.js";
+//#region src/api/spaces.ts
+/** Room-level details shared by /hierarchy, /room_summary and /publicRooms. */
+async function roomDetails(hs, roomId) {
+	const state = await hs.rooms.currentState(roomId);
+	const get = (t) => getState(state, t)?.content;
+	const out = {
+		room_id: roomId,
+		num_joined_members: (await hs.rooms.joinedMembers(roomId)).length,
+		world_readable: get("m.room.history_visibility")?.history_visibility === "world_readable",
+		guest_can_join: get("m.room.guest_access")?.guest_access === "can_join",
+		join_rule: get("m.room.join_rules")?.join_rule ?? "invite"
+	};
+	const str = (v) => typeof v === "string" ? v : void 0;
+	if (str(get("m.room.name")?.name)) out.name = get("m.room.name").name;
+	if (str(get("m.room.topic")?.topic)) out.topic = get("m.room.topic").topic;
+	if (str(get("m.room.canonical_alias")?.alias)) out.canonical_alias = get("m.room.canonical_alias").alias;
+	if (str(get("m.room.avatar")?.url)) out.avatar_url = get("m.room.avatar").url;
+	if (str(get("m.room.create")?.type)) out.room_type = get("m.room.create").type;
+	return out;
+}
+/** Whether a user may see a room's summary (spec: "accessible" rooms). */
+async function canAccess(hs, roomId, userId) {
+	const state = await hs.rooms.currentState(roomId);
+	if (userId && [
+		"join",
+		"invite",
+		"knock"
+	].includes(membershipOf(state, userId))) return true;
+	if (getState(state, "m.room.history_visibility")?.content?.history_visibility === "world_readable") return true;
+	const joinRules = getState(state, "m.room.join_rules")?.content;
+	const rule = joinRules?.join_rule ?? "invite";
+	if (rule === "public" || rule === "knock") return true;
+	if ((rule === "restricted" || rule === "knock_restricted") && userId) {
+		if (rule === "knock_restricted") return true;
+		for (const allow of Array.isArray(joinRules?.allow) ? joinRules.allow : []) if (allow?.type === "m.room_membership" && typeof allow.room_id === "string" && await hs.rooms.exists(allow.room_id)) {
+			if (await hs.rooms.membership(allow.room_id, userId) === "join") return true;
+		}
+	}
+	return false;
+}
+function allowedRoomIds(joinRules) {
+	if (!joinRules || !["restricted", "knock_restricted"].includes(joinRules.join_rule)) return void 0;
+	return (Array.isArray(joinRules.allow) ? joinRules.allow : []).filter((a) => a?.type === "m.room_membership" && typeof a.room_id === "string").map((a) => a.room_id);
+}
+/** Spec ordering of space children: valid `order` strings first, then child event timestamp, then room ID. */
+function childOrder(a, b) {
+	const valid = (o) => typeof o === "string" && o.length <= 50 && /^[\x20-\x7E]*$/.test(o) ? o : null;
+	const oa = valid(a.content?.order);
+	const ob = valid(b.content?.order);
+	if (oa !== null && ob === null) return -1;
+	if (oa === null && ob !== null) return 1;
+	if (oa !== null && ob !== null && oa !== ob) return oa < ob ? -1 : 1;
+	return (a.origin_server_ts ?? 0) - (b.origin_server_ts ?? 0) || (a.state_key < b.state_key ? -1 : a.state_key > b.state_key ? 1 : 0);
+}
+/** Fetch a room's summary from another server via federation /hierarchy, if the user may see it. */
+async function remoteSummary(hs, roomId, via, suggestedOnly, userId) {
+	if (!hs.federation.enabled) return null;
+	for (const server of via.filter((v) => v !== hs.serverName)) try {
+		const room = (await hs.federation.queryHierarchy(server, roomId, suggestedOnly)).room;
+		if (!room || room.room_id !== roomId) continue;
+		const rule = room.join_rule ?? "invite";
+		let accessible = room.world_readable === true || [
+			"public",
+			"knock",
+			"knock_restricted"
+		].includes(rule);
+		if (!accessible && rule === "restricted" && Array.isArray(room.allowed_room_ids)) {
+			for (const allowed of room.allowed_room_ids) if (await hs.rooms.exists(allowed) && await hs.rooms.membership(allowed, userId) === "join") {
+				accessible = true;
+				break;
+			}
+		}
+		return accessible ? room : null;
+	} catch {}
+	return null;
+}
+function registerSpaceRoutes(r) {
+	r.client("GET", "/rooms/:roomId/hierarchy", async (ctx) => {
+		const s = await ctx.auth();
+		const hs = ctx.hs;
+		const rootId = ctx.params.roomId;
+		if (!await hs.rooms.exists(rootId) || !await canAccess(hs, rootId, s.userId)) throw errors.forbidden("You cannot view this room");
+		const suggestedOnly = ctx.query.get("suggested_only") === "true";
+		const maxDepth = ctx.query.has("max_depth") ? Number.parseInt(ctx.query.get("max_depth"), 10) : Infinity;
+		const limit = Math.min(Math.max(Number.parseInt(ctx.query.get("limit") ?? "50", 10) || 50, 1), 100);
+		const from = ctx.query.get("from");
+		let offset = 0;
+		if (from) {
+			const m = /^(\d+)_(.+)$/.exec(from);
+			if (!m || m[2] !== `${rootId}|${suggestedOnly}|${ctx.query.get("max_depth") ?? ""}`) throw errors.invalidParam("Invalid pagination token");
+			offset = Number(m[1]);
+		}
+		const rooms = [];
+		const seen = /* @__PURE__ */ new Set();
+		const queue = [{
+			roomId: rootId,
+			depth: 0,
+			via: []
+		}];
+		while (queue.length) {
+			const { roomId, depth, via } = queue.pop();
+			if (seen.has(roomId)) continue;
+			seen.add(roomId);
+			if (!await hs.rooms.serverIsJoined(roomId)) {
+				const remote = await remoteSummary(hs, roomId, via, suggestedOnly, s.userId);
+				if (!remote) continue;
+				rooms.push(remote);
+				const remoteChildren = (remote.room_type === "m.space" ? remote.children_state ?? [] : []).filter((c) => Array.isArray(c.content?.via) && c.content.via.length).sort(childOrder);
+				if (depth < maxDepth) for (const child of [...remoteChildren].reverse()) queue.push({
+					roomId: child.state_key,
+					depth: depth + 1,
+					via: child.content.via
+				});
+				continue;
+			}
+			if (roomId !== rootId && !await canAccess(hs, roomId, s.userId)) continue;
+			const state = await hs.rooms.currentState(roomId);
+			const children = [];
+			const isSpace = getState(state, "m.room.create")?.content?.type === "m.space";
+			for (const [key, ev] of isSpace ? state : []) {
+				const [type] = splitStateKey(key);
+				if (type !== "m.space.child" || !Array.isArray(ev.content?.via) || ev.content.via.length === 0) continue;
+				if (suggestedOnly && ev.content.suggested !== true) continue;
+				children.push({
+					...stripState(ev),
+					origin_server_ts: ev.origin_server_ts
+				});
+			}
+			children.sort(childOrder);
+			if (depth < maxDepth) for (const child of [...children].reverse()) queue.push({
+				roomId: child.state_key,
+				depth: depth + 1,
+				via: child.content.via
+			});
+			const details = await roomDetails(hs, roomId);
+			const allowed = allowedRoomIds(getState(state, "m.room.join_rules")?.content);
+			if (allowed) details.allowed_room_ids = allowed;
+			details.children_state = children;
+			rooms.push(details);
+		}
+		const out = { rooms: rooms.slice(offset, offset + limit) };
+		if (offset + limit < rooms.length) out.next_batch = `${offset + limit}_${rootId}|${suggestedOnly}|${ctx.query.get("max_depth") ?? ""}`;
+		return out;
+	}, ["v1"]);
+	const summary = async (ctx) => {
+		const s = await ctx.optionalAuth();
+		const hs = ctx.hs;
+		let roomId;
+		try {
+			roomId = await hs.rooms.resolveRoomIdOrAlias(ctx.params.roomIdOrAlias);
+		} catch {
+			throw errors.notFound("Room not found");
+		}
+		if (!await hs.rooms.exists(roomId) || !await canAccess(hs, roomId, s?.userId ?? null)) throw errors.notFound("Room not found");
+		const state = await hs.rooms.currentState(roomId);
+		const out = await roomDetails(hs, roomId);
+		out.room_version = await hs.rooms.roomVersion(roomId);
+		const enc = getState(state, "m.room.encryption")?.content?.algorithm;
+		if (typeof enc === "string") out.encryption = enc;
+		if (s) out.membership = membershipOf(state, s.userId);
+		const allowed = allowedRoomIds(getState(state, "m.room.join_rules")?.content);
+		if (allowed) out.allowed_room_ids = allowed;
+		return out;
+	};
+	r.client("GET", "/room_summary/:roomIdOrAlias", summary, ["v1"]);
+	r.get("/_matrix/client/unstable/im.nheko.summary/summary/:roomIdOrAlias", summary);
+}
+//#endregion
+export { registerSpaceRoutes, roomDetails };