Files
burrow-server/lib/itemcontrol.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

142 lines
5.0 KiB
JavaScript

"use strict";
const accounts = require("./accounts.js");
const customItems = require("./customitems.js");
const defpacks = require("./defpacks.js");
// what staff who make items (items.create: admins and developers) may do
// about who has them:
//
// - lock an item out of the item finder (lib/admin.js): players no longer
// find it there or take it from it. staff who may lock still do, with the
// item marked locked. it stays wherever else it is (a shop, a trade).
// - take an item from one player: every one of it they have.
// - delete a custom item (lib/customitems.js): out of the game, and out of
// every inventory.
const LOCKS_SETTING = "finderLocks";
const KINDS = ["clothing", "den"];
let locks = null; // Set of "kind:id"
const key = (kind, id) => `${kind}:${Number(id)}`;
const lockSet = () => {
if (!locks) {
let saved = [];
try {
saved = JSON.parse(accounts.setting(LOCKS_SETTING) || "[]");
}
catch {
saved = [];
}
locks = new Set(Array.isArray(saved) ? saved.map(String) : []);
}
return locks;
};
const saveLocks = () => accounts.setSetting(LOCKS_SETTING, JSON.stringify([...lockSet()]));
const defOf = (kind, id) => (kind === "den" ? defpacks.denItemDef(id) : defpacks.itemDef(id));
const nameOf = (kind, id) => {
const def = defOf(kind, id);
if (!def) {
return "";
}
return kind === "den" ? defpacks.string(def.nameStrId) || def.abbrName || "" : defpacks.string(def.titleStrId);
};
const describe = (kind, id) => `${nameOf(kind, id) || "(no name)"} (${kind === "den" ? "den item" : "clothing"} ${Number(id)})`;
// checks a kind and id typed by staff: {kind, id} of an item that exists, or {error}.
const item = (kind, id) => {
const number = Number(id);
if (!KINDS.includes(kind)) {
return {error: "The kind is clothing or den."};
}
if (!Number.isInteger(number) || !defOf(kind, number) || (kind === "clothing" && !defpacks.clothingIds().includes(number))) {
return {error: `No ${kind === "den" ? "den item" : "clothing"} with the id ${id}.`};
}
return {kind, id: number};
};
const isLocked = (kind, id) => lockSet().has(key(kind, id));
// returns {ok} or {error}.
const setLocked = (kind, id, locked) => {
const found = item(kind, id);
if (found.error) {
return found;
}
const was = isLocked(found.kind, found.id);
if (was === locked) {
return {error: `${describe(found.kind, found.id)} is ${locked ? "already" : "not"} locked.`};
}
lockSet()[locked ? "add" : "delete"](key(found.kind, found.id));
saveLocks();
return {ok: `${describe(found.kind, found.id)} is ${locked ? "locked out of" : "back in"} the item finder.`};
};
const lockedList = () => [...lockSet()].map(entry => {
const [kind, id] = entry.split(":");
return {kind, id: Number(id), name: nameOf(kind, id)};
});
// every one of an item an account has, out of its inventory (and its trade
// list). `world` tells a game playing (lib/world.js itemsTaken). returns how
// many went.
const takeFromAccount = (account, kind, id, world) => {
const number = Number(id);
const collection = kind === "den" ? "denItems" : "items";
const gone = account[collection].filter(entry => entry.def === number);
if (!gone.length) {
return 0;
}
const invs = new Set(gone.map(entry => entry.inv));
account[collection] = account[collection].filter(entry => !invs.has(entry.inv));
account.tradeList = account.tradeList.filter(entry => !invs.has(entry.inv));
accounts.save();
world.itemsTaken(account, kind, [...invs], kind === "clothing" && gone.some(entry => entry.on.length > 0));
return gone.length;
};
// from one player, by username. returns {ok, count} or {error}.
const take = (username, kind, id, world) => {
const account = accounts.byName(username);
if (!account) {
return {error: `No player called ${username}.`};
}
// a deleted custom item can be gone from the tables and still be owned:
// the id is taken as it is then.
const found = item(kind, id);
if (found.error && !(KINDS.includes(kind) && Number.isInteger(Number(id)))) {
return found;
}
const count = takeFromAccount(account, kind, id, world);
return count ? {ok: `Took ${count} of ${describe(kind, id)} from ${account.username}.`, count}
: {error: `${account.username} has no ${describe(kind, id)}.`};
};
// a custom item out of the game, and out of everyone's inventory. returns {ok} or {error}.
const deleteCustom = (kind, id, world) => {
const entry = customItems.get(kind, id);
if (!entry) {
return {error: "No such custom item."};
}
let count = 0;
for (const account of accounts.all()) {
count += takeFromAccount(account, kind, entry.id, world);
}
if (entry.art) {
require("./itemart.js").remove(kind, entry.id);
}
customItems.remove(kind, entry.id);
if (lockSet().delete(key(kind, entry.id))) {
saveLocks();
}
return {ok: `Deleted ${entry.name} (${kind === "den" ? "den item" : "clothing"} ${entry.id})${count ? `, and took ${count} from players` : ""}.`};
};
module.exports = {isLocked, setLocked, lockedList, take, deleteCustom};