mirror of
https://github.com/burrow-dev/burrow-server.git
synced 2026-11-18 17:27:50 -05:00
Moderators were one flag on the account. Now an account can hold a staff
role (lib/roles.js): helper, moderator or admin, each a list of named
permissions, with a higher role holding everything below it. An account
only marked `moderator` still counts as a moderator.
Every staff action checks the permission it needs, and staff never act
on staff of their own rank or above:
- warnings: kept on the account (who, when, the reason, a note for
staff), and shown to the player with the game's own warning popup for
the reason ("fw": inappropriate behavior, bullying, personal
information, scamming), which this server's strings already word as the
Burrow Rules.
- moderator panel: each action is checked against the role; new actions
"warn" (with a reason and note), "summon" (bring a player to the room you
are in) and "goto"; the player's page shows their warnings; GET
/mod/api/me returns your role and permissions, and the page hides the
buttons yours does not allow.
- in the game: !staff, !summon, !goto, !kick, !silence (HOURS, 0, or
off), !warn PLAYER [reason] [note], !warnings PLAYER and !message, for
staff whose role allows each, written to the moderators' log like the
panel's actions, marked "(in game)". To anyone else they are plain chat.
Usernames with spaces work.
- the login reply carries the player's own staffRole and
staffPermissions (empty for everyone else), so a client can show staff
tools only to staff.
- admin panel: a role picker on the account, "role" on POST
/admin/api/account, and GET /admin/api/roles listing what each allows.
The old moderator switch still works.
Also: the moderators' message box showed "--Message From Moderator--\n\n"
with the "\n" as written (strings 11134 and 11135 keep it as two
characters); they get real line breaks.
Staff powers need 2FA turned on, as the moderator panel already did. In
the game they come with the game session, which a trusted device opens
without a code; requiring a recent code there is left for later.
test/staff.js covers all of the above end to end.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
90 lines
3.3 KiB
JavaScript
90 lines
3.3 KiB
JavaScript
"use strict";
|
|
|
|
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 = {
|
|
"staff.list": "see which staff are online (!staff)",
|
|
"player.warn": "warn a player and send them a message (!warn, !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)",
|
|
"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",
|
|
};
|
|
|
|
const HELPER = ["staff.list", "player.warn", "player.goto", "chat.silence"];
|
|
const MODERATOR = [...HELPER, "player.kick", "player.summon", "player.ban", "player.names", "address.ban"];
|
|
const ADMIN = [...MODERATOR];
|
|
|
|
const ROLES = {
|
|
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);
|
|
|
|
const permissionsOf = account => {
|
|
const role = roleOf(account);
|
|
return role ? [...ROLES[role].permissions] : [];
|
|
};
|
|
|
|
const can = (account, permission, banned = false) =>
|
|
isActiveStaff(account, banned) && ROLES[roleOf(account)].permissions.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, can, outranks, setRole};
|