mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-08-13 00:45:11 +09:00
Add exp_roles plugin to sync roles from the controller
Clusterio already stores roles, the permissions they grant, and which user holds which role, along with a web UI for all three. What it does not have is the properties a role only needs in game, or a way for an instance to learn about any of it, since role and user updates are only sent to control connections. This plugin fills both gaps. The controller keeps a record per role holding the order, priority, short hand, tag, colour and auto assign threshold, created automatically for any role which does not have one. It then rebroadcasts roles and assignments on its own events so instances can follow them. The lua module presents the same interface the legacy expcore.roles module did, so the call sites can be moved over without being rewritten. Permission checks translate the legacy action strings using the same mapping exp_scenario defines. Two things replace features the legacy system had: - Priority replaces disallow. Only the roles with the highest priority a player holds are considered, so Jail can suppress every other role including the default one, without needing to take roles away first. - Assignments made in game are applied locally and then sent to the controller, which keeps assign_player synchronous for callers. A role which should never leave this map, such as one earned from time on the map, is assigned with assign_player_local instead. Roles earned from online time across the cluster are granted by the controller from the threshold on the role, using the online time clusterio already tracks. Nothing requires this plugin yet; moving the call sites off expcore.roles and removing the legacy config is left for a follow up. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
bbassie
@@ -0,0 +1,299 @@
|
||||
import { BaseControllerPlugin, InstanceRecord } from "@clusterio/controller";
|
||||
import * as lib from "@clusterio/lib";
|
||||
import * as messages from "./messages";
|
||||
import * as path from "node:path";
|
||||
|
||||
export class ControllerPlugin extends BaseControllerPlugin {
|
||||
roleMeta!: lib.SubscribableDatastore<messages.RoleMetaRecord>;
|
||||
|
||||
async init() {
|
||||
const databaseDirectory = this.controller.config.get("controller.database_directory");
|
||||
|
||||
this.roleMeta = new lib.SubscribableDatastore(
|
||||
...await new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_roles", "role_meta.json"),
|
||||
messages.RoleMetaRecord.fromJSON.bind(messages.RoleMetaRecord),
|
||||
).bootstrap()
|
||||
);
|
||||
|
||||
// Roles created before this plugin was installed have no properties yet
|
||||
this.ensureRoleMeta();
|
||||
|
||||
this.controller.subscriptions.handle(messages.RoleUpdatedEvent, this.handleRoleSubscription.bind(this));
|
||||
this.controller.subscriptions.handle(
|
||||
messages.AssignmentUpdatedEvent, this.handleAssignmentSubscription.bind(this)
|
||||
);
|
||||
|
||||
this.roleMeta.on("update", this.roleMetaUpdated.bind(this));
|
||||
this.controller.roles.on("update", this.rolesUpdated.bind(this));
|
||||
this.controller.users.records.on("update", this.usersUpdated.bind(this));
|
||||
|
||||
this.controller.handle(messages.RoleListRequest, this.handleRoleListRequest.bind(this));
|
||||
this.controller.handle(messages.RoleMetaUpdateRequest, this.handleRoleMetaUpdateRequest.bind(this));
|
||||
|
||||
this.controller.handle(messages.AssignmentListRequest, this.handleAssignmentListRequest.bind(this));
|
||||
this.controller.handle(messages.AssignmentUpdateRequest, this.handleAssignmentUpdateRequest.bind(this));
|
||||
}
|
||||
|
||||
async onShutdown() {
|
||||
await this.roleMeta.save();
|
||||
}
|
||||
|
||||
/*
|
||||
Role properties
|
||||
*/
|
||||
|
||||
/** Create properties for any role which does not have them yet, ordered after every existing role. */
|
||||
ensureRoleMeta() {
|
||||
const created = [];
|
||||
let nextOrder = 0;
|
||||
for (const meta of this.roleMeta.values()) {
|
||||
nextOrder = Math.max(nextOrder, meta.order);
|
||||
}
|
||||
|
||||
for (const role of this.controller.roles.values()) {
|
||||
if (!this.roleMeta.has(role.id)) {
|
||||
nextOrder += 1;
|
||||
created.push(new messages.RoleMetaRecord(role.id, nextOrder));
|
||||
}
|
||||
}
|
||||
|
||||
if (created.length) {
|
||||
this.roleMeta.setMany(created);
|
||||
}
|
||||
|
||||
return created;
|
||||
}
|
||||
|
||||
/** Combine a clusterio role with its in game properties. */
|
||||
buildRoleRecord(role: Readonly<lib.Role>) {
|
||||
const meta = this.roleMeta.get(role.id) ?? new messages.RoleMetaRecord(role.id, role.id);
|
||||
return new messages.RoleRecord(
|
||||
role.id,
|
||||
role.name,
|
||||
[...role.permissions],
|
||||
meta,
|
||||
role.id === this.controller.config.get("controller.default_role_id"),
|
||||
Math.max(role.updatedAtMs, meta.updatedAtMs),
|
||||
role.isDeleted,
|
||||
);
|
||||
}
|
||||
|
||||
async onControllerConfigFieldChanged(field: string, curr: unknown, prev: unknown) {
|
||||
// Which role is the default is carried on the role records themselves
|
||||
if (field === "controller.default_role_id") {
|
||||
this.controller.subscriptions.broadcast(new messages.RoleUpdatedEvent(this.listRoleRecords()));
|
||||
}
|
||||
}
|
||||
|
||||
/** Every role which currently exists, in the form sent to instances. */
|
||||
listRoleRecords() {
|
||||
return [...this.controller.roles.values()].map(role => this.buildRoleRecord(role));
|
||||
}
|
||||
|
||||
async handleRoleListRequest() {
|
||||
return this.listRoleRecords();
|
||||
}
|
||||
|
||||
async handleRoleMetaUpdateRequest(request: messages.RoleMetaUpdateRequest) {
|
||||
const meta = request.meta;
|
||||
if (!this.controller.roles.has(meta.id)) {
|
||||
throw new lib.RequestError(`Role with ID ${meta.id} does not exist`);
|
||||
}
|
||||
|
||||
this.roleMeta.set(meta);
|
||||
}
|
||||
|
||||
/** A clusterio role was created, changed or deleted. */
|
||||
rolesUpdated(roles: lib.Role[]) {
|
||||
const created = this.ensureRoleMeta();
|
||||
|
||||
// Deleting a role leaves its properties behind, which would be reused by
|
||||
// the next role to be given the same id
|
||||
const orphaned = [];
|
||||
for (const role of roles) {
|
||||
if (role.isDeleted) {
|
||||
const meta = this.roleMeta.getMutable(role.id);
|
||||
if (meta) {
|
||||
orphaned.push(meta);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (orphaned.length) {
|
||||
this.roleMeta.deleteMany(orphaned);
|
||||
}
|
||||
|
||||
// Newly created properties broadcast on their own through roleMetaUpdated
|
||||
const createdIds = new Set(created.map(meta => meta.id));
|
||||
const updates = roles.filter(role => !createdIds.has(role.id)).map(role => this.buildRoleRecord(role));
|
||||
if (updates.length) {
|
||||
this.controller.subscriptions.broadcast(new messages.RoleUpdatedEvent(updates));
|
||||
}
|
||||
|
||||
this.applyAutoAssign();
|
||||
}
|
||||
|
||||
/** The in game properties of a role changed. */
|
||||
roleMetaUpdated(metas: messages.RoleMetaRecord[]) {
|
||||
const updates = [];
|
||||
for (const meta of metas) {
|
||||
const role = this.controller.roles.get(meta.id);
|
||||
// A deleted role broadcasts through rolesUpdated instead
|
||||
if (role) {
|
||||
updates.push(this.buildRoleRecord(role));
|
||||
}
|
||||
}
|
||||
|
||||
if (updates.length) {
|
||||
this.controller.subscriptions.broadcast(new messages.RoleUpdatedEvent(updates));
|
||||
}
|
||||
|
||||
this.applyAutoAssign();
|
||||
}
|
||||
|
||||
async handleRoleSubscription(request: lib.SubscriptionRequest) {
|
||||
const roles = this.listRoleRecords().filter(role => role.updatedAtMs > request.lastRequestTimeMs);
|
||||
return roles.length ? new messages.RoleUpdatedEvent(roles) : null;
|
||||
}
|
||||
|
||||
/*
|
||||
Assignments
|
||||
*/
|
||||
|
||||
/**
|
||||
* The roles of a user as seen in game.
|
||||
*
|
||||
* The default role is left out because every player has it, which keeps the
|
||||
* assignments to only those users who have been given a role.
|
||||
*/
|
||||
buildAssignmentRecord(user: Readonly<lib.UserDetails>) {
|
||||
const defaultRoleId = this.controller.config.get("controller.default_role_id");
|
||||
const roleIds = new Set(user.roleIds);
|
||||
if (defaultRoleId !== null) {
|
||||
roleIds.delete(defaultRoleId);
|
||||
}
|
||||
|
||||
return new messages.AssignmentRecord(
|
||||
user.name,
|
||||
roleIds,
|
||||
user.updatedAtMs,
|
||||
user.isDeleted || roleIds.size === 0,
|
||||
);
|
||||
}
|
||||
|
||||
listAssignmentRecords() {
|
||||
const assignments = [];
|
||||
for (const user of this.controller.users.records.values()) {
|
||||
const assignment = this.buildAssignmentRecord(user);
|
||||
if (!assignment.isDeleted) {
|
||||
assignments.push(assignment);
|
||||
}
|
||||
}
|
||||
return assignments;
|
||||
}
|
||||
|
||||
async handleAssignmentListRequest() {
|
||||
return this.listAssignmentRecords();
|
||||
}
|
||||
|
||||
usersUpdated(users: lib.UserDetails[]) {
|
||||
this.controller.subscriptions.broadcast(
|
||||
new messages.AssignmentUpdatedEvent(users.map(user => this.buildAssignmentRecord(user)))
|
||||
);
|
||||
|
||||
this.applyAutoAssign(users.map(user => user.name));
|
||||
}
|
||||
|
||||
async handleAssignmentSubscription(request: lib.SubscriptionRequest) {
|
||||
const assignments = this.listAssignmentRecords()
|
||||
.filter(assignment => assignment.updatedAtMs > request.lastRequestTimeMs);
|
||||
return assignments.length ? new messages.AssignmentUpdatedEvent(assignments) : null;
|
||||
}
|
||||
|
||||
async handleAssignmentUpdateRequest(request: messages.AssignmentUpdateRequest) {
|
||||
const user = this.controller.users.getByNameMutable(request.name);
|
||||
if (!user) {
|
||||
throw new lib.RequestError(`User '${request.name}' does not exist`);
|
||||
}
|
||||
|
||||
for (const roleId of [...request.assign, ...request.unassign]) {
|
||||
if (!this.controller.roles.has(roleId)) {
|
||||
throw new lib.RequestError(`Role with ID ${roleId} does not exist`);
|
||||
}
|
||||
}
|
||||
|
||||
const roleIds = new Set(user.roleIds);
|
||||
for (const roleId of request.assign) {
|
||||
roleIds.add(roleId);
|
||||
}
|
||||
for (const roleId of request.unassign) {
|
||||
roleIds.delete(roleId);
|
||||
}
|
||||
|
||||
user.set("roleIds", roleIds);
|
||||
this.controller.userPermissionsUpdated(user);
|
||||
}
|
||||
|
||||
/*
|
||||
Automatic assignment
|
||||
*/
|
||||
|
||||
/**
|
||||
* Grant roles which are earned by online time across the cluster.
|
||||
*
|
||||
* Roles are only ever granted, never taken away, so a player who earns a
|
||||
* role keeps it even if their statistics are later reduced.
|
||||
*
|
||||
* @param userNames - Users to consider, defaults to every user.
|
||||
*/
|
||||
applyAutoAssign(userNames?: string[]) {
|
||||
const autoAssigned = [...this.roleMeta.values()].filter(
|
||||
meta => meta.autoAssignOnlineTimeMs !== null && !meta.isDeleted
|
||||
);
|
||||
if (!autoAssigned.length) {
|
||||
return;
|
||||
}
|
||||
|
||||
const blocking = new Set(
|
||||
[...this.roleMeta.values()].filter(meta => meta.blockAutoAssign).map(meta => meta.id)
|
||||
);
|
||||
|
||||
const users = userNames
|
||||
? userNames.map(name => this.controller.users.getByNameMutable(name))
|
||||
: [...this.controller.users.valuesMutable()]
|
||||
;
|
||||
|
||||
for (const user of users) {
|
||||
if (!user || user.isDeleted) {
|
||||
continue;
|
||||
}
|
||||
if ([...user.roleIds].some(roleId => blocking.has(roleId))) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const onlineTimeMs = user.playerStats.onlineTimeMs;
|
||||
const granted = [];
|
||||
for (const meta of autoAssigned) {
|
||||
if (!user.roleIds.has(meta.id) && onlineTimeMs >= meta.autoAssignOnlineTimeMs!) {
|
||||
granted.push(meta.id);
|
||||
}
|
||||
}
|
||||
|
||||
if (granted.length) {
|
||||
// set rather than addRole so that a single update is emitted
|
||||
user.set("roleIds", new Set([...user.roleIds, ...granted]));
|
||||
this.controller.userPermissionsUpdated(user);
|
||||
this.logger.info(
|
||||
`Granted ${granted.length} role(s) to ${user.name} from their online time`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async onPlayerEvent(instance: InstanceRecord, event: lib.PlayerEvent) {
|
||||
// Online time is committed to the user record when a player leaves
|
||||
if (event.type === "leave") {
|
||||
this.applyAutoAssign([event.name]);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user