mirror of
https://github.com/burrow-dev/burrow-server.git
synced 2026-11-18 17:27:50 -05:00
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]>
168 lines
6.4 KiB
JavaScript
168 lines
6.4 KiB
JavaScript
"use strict";
|
|
|
|
const accounts = require("./accounts.js");
|
|
const totp = require("./totp.js");
|
|
|
|
// staff roles, and what each may do. an account holds at most one role
|
|
// (`role` on the account), set by the admin. an account from before roles
|
|
// that is only marked `moderator` counts as a moderator, so nothing that
|
|
// worked before stops working.
|
|
//
|
|
// a role is a list of permissions, and every staff action checks the one it
|
|
// needs, in the moderator panel (lib/modpanel.js) and in the game
|
|
// (lib/commands.js) alike. a higher role holds everything a lower one does.
|
|
// staff never act on staff of their own rank or above: that is for someone
|
|
// higher up, and for the admin in the end.
|
|
|
|
const PERMISSIONS = {
|
|
"player.view": "see players, chat, reports, requests, bans and paintings in the moderator panel, and keep notes on players (!note, !notes)",
|
|
"staff.list": "see which staff are online (!staff)",
|
|
"player.warn": "warn a player, take a warning back and send them a message (!warn, !unwarn, !warnings, !message)",
|
|
"player.goto": "go to the room a player is in (!goto)",
|
|
"chat.silence": "silence and unsilence a player (!silence)",
|
|
"player.kick": "disconnect a player (!kick)",
|
|
"player.summon": "bring a player to the room you are in (!summon)",
|
|
"staff.invisible": "go unseen in rooms, as the game's moderators could (!invisible)",
|
|
"player.ban": "ban, unban and change a ban's reason",
|
|
"player.names": "reject or accept a name, clear a bio",
|
|
"address.ban": "ban the address a player last signed in from",
|
|
"items.approve": "approve or turn away the items and pictures players make, when the admin has asked for that",
|
|
"items.create": "make new items from the game's art, change and delete them, lock items out of the item finder and take items from players (!item, !lock, !unlock, !locked, !take)",
|
|
};
|
|
|
|
const HELPER = ["player.view", "staff.list", "player.warn", "player.goto", "chat.silence"];
|
|
const MODERATOR = [...HELPER, "player.kick", "player.summon", "staff.invisible", "player.ban", "player.names", "address.ban", "items.approve"];
|
|
const ADMIN = [...MODERATOR, "items.create"];
|
|
// a developer makes things, and moderates nobody.
|
|
const DEVELOPER = ["staff.list", "items.create"];
|
|
|
|
const ROLES = {
|
|
developer: {rank: 1, label: "Developer", permissions: DEVELOPER},
|
|
helper: {rank: 1, label: "Helper", permissions: HELPER},
|
|
moderator: {rank: 2, label: "Moderator", permissions: MODERATOR},
|
|
admin: {rank: 3, label: "Admin", permissions: ADMIN},
|
|
};
|
|
|
|
// the role an account holds, or null.
|
|
const roleOf = account => {
|
|
if (!account) {
|
|
return null;
|
|
}
|
|
if (Object.hasOwn(ROLES, account.role)) {
|
|
return account.role;
|
|
}
|
|
return account.moderator ? "moderator" : null;
|
|
};
|
|
|
|
const rankOf = account => {
|
|
const role = roleOf(account);
|
|
return role ? ROLES[role].rank : 0;
|
|
};
|
|
|
|
// may this account act as staff at all right now? as for the moderator
|
|
// panel: a role, 2FA turned on, not locked and not banned. `banned` says
|
|
// whether the account is banned (passed in, so that this file needs nothing
|
|
// of the world's).
|
|
const isActiveStaff = (account, banned = false) =>
|
|
Boolean(roleOf(account) && totp.isOn(account) && !account.locked && !banned);
|
|
|
|
// what each role may do can be changed by the admin (the admin panel's
|
|
// Moderators page): kept as a setting, {role: [permission, ...]}, a role
|
|
// not in it holding its defaults above. one staff member can be given more
|
|
// than their role, or less (`permGrants`, `permDenies` on the account, from
|
|
// their page in the admin panel). a role and 2FA are still what makes
|
|
// someone staff at all (isActiveStaff).
|
|
const ROLE_SETTING = "rolePermissions";
|
|
let roleOverrides = null;
|
|
|
|
const overrides = () => {
|
|
if (!roleOverrides) {
|
|
try {
|
|
const saved = JSON.parse(accounts.setting(ROLE_SETTING) || "{}");
|
|
roleOverrides = saved && typeof saved === "object" && !Array.isArray(saved) ? saved : {};
|
|
}
|
|
catch {
|
|
roleOverrides = {};
|
|
}
|
|
}
|
|
return roleOverrides;
|
|
};
|
|
|
|
// the permissions in a list that are ones, each once
|
|
const known = list => [...new Set(Array.isArray(list) ? list.map(String) : [])].filter(permission => Object.hasOwn(PERMISSIONS, permission));
|
|
|
|
const rolePermissions = role => (Object.hasOwn(overrides(), role) ? known(overrides()[role]) : [...ROLES[role].permissions]);
|
|
|
|
const roleChanged = role => Object.hasOwn(overrides(), role);
|
|
|
|
// a role's permissions, or its defaults again (`list` null). false for no such role.
|
|
const setRolePermissions = (role, list) => {
|
|
if (!Object.hasOwn(ROLES, role)) {
|
|
return false;
|
|
}
|
|
const changed = {...overrides()};
|
|
if (list === null) {
|
|
delete changed[role];
|
|
}
|
|
else {
|
|
changed[role] = known(list);
|
|
}
|
|
accounts.setSetting(ROLE_SETTING, JSON.stringify(changed));
|
|
roleOverrides = changed;
|
|
return true;
|
|
};
|
|
|
|
const permissionsOf = account => {
|
|
const role = roleOf(account);
|
|
if (!role) {
|
|
return [];
|
|
}
|
|
const denied = new Set(known(account.permDenies));
|
|
return [...new Set([...rolePermissions(role), ...known(account.permGrants)])].filter(permission => !denied.has(permission));
|
|
};
|
|
|
|
// one staff member's own: given beyond their role, and taken from it. a
|
|
// permission in both is given. the caller saves the account.
|
|
const setAccountPermissions = (account, grants, denies) => {
|
|
const given = known(grants);
|
|
const taken = known(denies).filter(permission => !given.includes(permission));
|
|
if (given.length) {
|
|
account.permGrants = given;
|
|
}
|
|
else {
|
|
delete account.permGrants;
|
|
}
|
|
if (taken.length) {
|
|
account.permDenies = taken;
|
|
}
|
|
else {
|
|
delete account.permDenies;
|
|
}
|
|
};
|
|
|
|
const can = (account, permission, banned = false) =>
|
|
isActiveStaff(account, banned) && permissionsOf(account).includes(permission);
|
|
|
|
// may `actor` act on `target`? never on themselves, nor on staff of their
|
|
// own rank or above.
|
|
const outranks = (actor, target) => actor !== target && rankOf(actor) > rankOf(target);
|
|
|
|
// sets the role (one of ROLES, or null for none). `moderator` is kept in
|
|
// step for anything that still reads it.
|
|
const setRole = (account, role) => {
|
|
if (role === null || role === "" || role === "none") {
|
|
delete account.role;
|
|
delete account.moderator;
|
|
return true;
|
|
}
|
|
if (!Object.hasOwn(ROLES, role)) {
|
|
return false;
|
|
}
|
|
account.role = role;
|
|
account.moderator = true;
|
|
return true;
|
|
};
|
|
|
|
module.exports = {PERMISSIONS, ROLES, roleOf, rankOf, isActiveStaff, permissionsOf, rolePermissions, roleChanged, setRolePermissions,
|
|
setAccountPermissions, can, outranks, setRole};
|