Files
burrow-server/lib/cdn.js
T
SnipzilandClaude Opus 5.5 e05565787f feat(server): staff tools, player-made items, picture safety, chat, multiplayer games
Staff and moderation
- Invisible staff (!invisible, "xiv"): hidden from players, half see-through
  to other staff, cannot chat while hidden. New permission staff.invisible.
- Summon and goto land on the player's exact spot ("xgt" before the move).
- Custom warnings (!warn PLAYER custom TEXT), shown in the warning popup.
- Mod notes (!note, !notes; lib/modnotes.js), on the player page and the
  dashboard.
- Granular permissions: per-role overrides (setting rolePermissions) and
  per-account grants and denies, applied live to staff who are playing
  (refreshStaff re-sends "xsp").
- Item control (lib/itemcontrol.js): lock items out of the item finder
  (!lock, !unlock, !locked), take an item from a player (!take), delete a
  custom item from the game and every inventory.
- GET items/find: search any item by name or id, marked locked, for the
  dashboards' quick lock.

Player-made items (lib/playeritems.js, "xcm")
- The Item Maker: make, rename, set the worn look, delete. 5 a day, 20 in all;
  names go through the name filter.
- Admin switches: Item Maker on/off, new items wait for approval, and a
  separate switch (on by default) that holds every player-uploaded picture
  for a moderator. Review queue for items.approve (moderator and up).
- Pictures (lib/itemart.js): PNG, JPEG and GIF cleaned of metadata, BMP
  converted to PNG; 512px and 300KB at most once cleaned.
- Worn as the maker chooses: a sticker (the picture) or a texture (the
  item's shape painted with the picture).

Picture safety
- A picture waiting for approval is never served publicly: /itemart/ 404s it,
  and it is only shown through /account|/mod|/admin/api/itemart to its maker
  and to staff who review or make items.
- A picture turned away or taken off is remembered by SHA-256 and cannot be
  uploaded again.
- Three strikes: three pictures turned away stops a player's uploads until a
  moderator lets them again. Staff can stop or allow uploads by hand.
- Accounts under 24 hours old cannot upload pictures (AJ_ITEM_ART_MIN_HOURS);
  uploads capped at 10 a day.
- Optional Google Cloud Vision SafeSearch (lib/image-moderation.js) for item
  pictures and Art Studio paintings when AJ_GOOGLE_VISION_API_KEY is set;
  fails closed when the scanner is unreachable.

Chat
- Emoji: Twemoji pictures served at /emoji/<codepoints>.png and cached in
  data/emoji (lib/emoji.js).
- Smart spam filtering before the word filter (lib/chatspam.js): long runs of
  one character, repeated words and lines, huge words and emoji floods are
  tidied, and repeats within 20 seconds are dropped.
- Typing indicator: "xty" is passed on to everyone in the room who can see
  the player, at most every 2 seconds.

Games (lib/minigames.js)
- Room games can be played together: a MULTIPLAYER table gives a game a
  waiting list (Single Player / Multiplayer). Players in the same room are
  matched, taken into the game together, and each one's moves are relayed to
  the others. Gem Breaker is the first: two players, "pos", "shoot" and
  "playerLost" relayed.
- Gem Breaker's start message now lists each player's id. Without it no
  player counted as local, so even single player could not aim.

Other
- Players stay connected through the client's new 75-minute AFK limit
  (idleTimeoutMs 80 minutes).
- Jam-a-Grams carry custom items and colours; Jammer Wall avatar photos are
  validated (walls.js photoParam).
- Weak passwords refused (common words, or containing the username).
- Code-scanning fixes: every logged value goes through logText
  (lib/logtext.js) against log injection, HSTS, path-only error logs, a
  single file read in lib/names.js.

Tests: items (pictures, approval, strikes, re-upload refusal, the hidden
waiting picture, the dashboard search), staff (invisibility, goto and summon
spots, custom warnings, notes), buddygames (two-player Gem Breaker, the
typing relay), and updates for main's verified badge and spawn rooms.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 21:44:10 -04:00

180 lines
6.4 KiB
JavaScript

"use strict";
const {logText} = require("./logtext.js");
const crypto = require("crypto");
const fs = require("fs");
const path = require("path");
const config = require("../config.js");
// mirrors LoaderCache.hashItV2 in the client: the last path component of every
// versioned asset is obfuscated this way before it is requested.
const hashName = name => {
const salted = "W3 7r4Ck h4X0r3rs" + name;
let out = "";
for (let i = 0; i < salted.length; i++) {
out = i % 2 === 0 ? out + salted[i] : salted[i] + out;
}
return crypto.createHash("md5").update(out).digest("hex");
};
// "defPacks/1003" -> "1830/defPacks/<hash>"
const hashedPath = assetPath => {
const parts = assetPath.split("/");
parts.push(hashName(parts.pop()));
return `${config.deployVersion}/${parts.join("/")}`;
};
const missing = new Set();
const inFlight = new Map();
// asset paths are short and plain; anything else is not worth asking the
// upstream CDN about on a stranger's behalf.
const ASSET_PATH = /^[A-Za-z0-9_.\-\/]{1,200}$/;
const MAX_MISSING = 20000;
const MAX_DOWNLOADS = 64; // at once
// the builds this server has any use for: the one the game runs on, the
// older ones room files are taken from, and the themes' (config.js). the
// official CDN holds a good deal more under other names (every other build,
// and two folders of players' own data); none of that is fetched, kept or
// handed on for anyone.
const BUILDS = new Set([config.deployVersion, ...config.olderBuilds, ...Object.values(config.themes).map(theme => theme.build)].map(String));
// the path as it is kept and asked for: "a/./b" and "a//b" are "a/b", and
// nothing climbs out of its build. null for a path that is not an asset's.
const clean = relPath => {
if (typeof relPath !== "string" || !ASSET_PATH.test(relPath)) {
return null;
}
const parts = relPath.split("/").filter(part => part !== "" && part !== ".");
return parts.length >= 2 && !parts.includes("..") && BUILDS.has(parts[0]) ? parts.join("/") : null;
};
const cacheFile = relPath => {
const file = path.join(config.cacheDir, relPath);
return file.startsWith(config.cacheDir + path.sep) ? file : null;
};
// how much the cache holds: counted once at start (in the background), then
// kept up as files are added.
let cacheBytes = 0;
const measure = async folder => {
for (const entry of await fs.promises.readdir(folder, {withFileTypes: true}).catch(() => [])) {
if (entry.isDirectory()) {
await measure(path.join(folder, entry.name));
}
else {
cacheBytes += (await fs.promises.stat(path.join(folder, entry.name)).catch(() => ({size: 0}))).size;
}
}
};
measure(config.cacheDir).then(() => {
if (cacheBytes > config.maxCacheBytes) {
console.log(`[cdn] the cache holds ${logText(Math.round(cacheBytes / 1048576))} MB, over its limit: new files are served but not kept (AJ_MAX_CACHE_MB)`);
}
});
const download = async (relPath, file) => {
const url = new URL(relPath, config.upstreamContent);
url.searchParams.set("v", config.upstreamBuildVersion);
const res = await fetch(url, {headers: {"User-Agent": "Mozilla/5.0"}, signal: AbortSignal.timeout(config.upstreamTimeoutMs)});
if (!res.ok) {
if (res.status === 404 || res.status === 403) {
if (missing.size >= MAX_MISSING) {
missing.clear();
}
missing.add(relPath);
}
console.log(`[cdn] ${logText(res.status)} ${logText(relPath)}`);
return null;
}
const body = Buffer.from(await res.arrayBuffer());
// A cache that cannot be written to (wrong owner, full disk) costs a
// download each time; it must not cost the player the file.
try {
if (cacheBytes + body.length > config.maxCacheBytes) {
return body;
}
cacheBytes += body.length;
await fs.promises.mkdir(path.dirname(file), {recursive: true});
const tmp = `${file}.${process.pid}.tmp`;
await fs.promises.writeFile(tmp, body);
await fs.promises.rename(tmp, file);
console.log(`[cdn] cached ${logText(relPath)} (${logText(body.length)} bytes)`);
}
catch (err) {
console.log(`[cdn] could not cache ${logText(relPath)}: ${logText(err.message)}`);
}
return body;
};
// `mayFetch`: may a file that is not in the cache be asked of the official
// CDN for this request? (Whoever asks for too many is given only what is
// there already: lib/http.js.)
const getExact = async (asked, mayFetch = () => true) => {
const relPath = clean(asked);
const file = relPath && cacheFile(relPath);
if (!file) {
return null;
}
try {
return await fs.promises.readFile(file);
}
catch (err) {
if (err.code !== "ENOENT" && err.code !== "EISDIR" && err.code !== "ENOTDIR") {
throw err;
}
}
if (config.offline || missing.has(relPath)) {
return null;
}
if (!inFlight.has(relPath) && (inFlight.size >= MAX_DOWNLOADS || !mayFetch())) {
return null;
}
if (!inFlight.has(relPath)) {
// A download that fails (the CDN not answering in time) is "not there"
// for now, and is tried again the next time the file is asked for.
inFlight.set(relPath, download(relPath, file).catch(err => {
console.log(`[cdn] could not fetch ${logText(relPath)}: ${logText(err.message)}`);
return null;
}).finally(() => inFlight.delete(relPath)));
}
return inFlight.get(relPath);
};
// returns the asset's bytes, or null when it does not exist. A room file the
// current build no longer has is looked for in the older builds named in
// config.olderBuilds (the client asks for everything under the current one).
const CURRENT_ROOM_FILE = new RegExp(`^${config.deployVersion}/(roomDefs/.+)$`);
const get = async (relPath, mayFetch) => {
const body = await getExact(relPath, mayFetch);
const room = body ? null : CURRENT_ROOM_FILE.exec(clean(relPath) || "");
if (room) {
for (const build of config.olderBuilds) {
const older = await getExact(`${build}/${room[1]}`, mayFetch);
if (older) {
return older;
}
}
}
return body;
};
// the asset's bytes if it is already in the cache, else null; never downloads.
const cached = async asked => {
const relPath = clean(asked);
const file = relPath && cacheFile(relPath);
try {
return file ? await fs.promises.readFile(file) : null;
}
catch (err) {
return null;
}
};
// whether the official CDN said it has no such file (a 404 or 403 when it
// was asked), as against one not asked for yet or not fetched just now.
const knownMissing = asked => missing.has(clean(asked));
module.exports = {get, cached, knownMissing, hashName, hashedPath};