Kuma/server/socket-handlers/general-socket-handler.js
google-labs-jules[bot] d94126dce6 feat: Implement user management with user types
Adds a user management module allowing administrators to assign types (roles) to users.

- Adds `user_type` column to the `user` table (default 'admin').
- Updates user model and adds backend logic for managing user types.
- Introduces a new 'User Management' section in Settings UI for admins.
- Admins can now view all users and change their user types.
- Access to user management functions is restricted to admin users.
2025-06-29 19:13:06 +00:00

214 lines
6.6 KiB
JavaScript

const { log } = require("../../src/util");
const { Settings } = require("../settings");
const { sendInfo } = require("../client");
const { checkLogin, isAdmin } = require("../util-server"); // Added isAdmin
const { R } = require("redbean-node"); // Added R for database operations
const User = require("../model/user"); // Added User model
const GameResolver = require("gamedig/lib/GameResolver");
const { testChrome } = require("../monitor-types/real-browser-monitor-type");
const fsAsync = require("fs").promises;
const path = require("path");
let gameResolver = new GameResolver();
let gameList = null;
/**
* Get a game list via GameDig
* @returns {object[]} list of games supported by GameDig
*/
function getGameList() {
if (gameList == null) {
gameList = gameResolver._readGames().games.sort((a, b) => {
if ( a.pretty < b.pretty ) {
return -1;
}
if ( a.pretty > b.pretty ) {
return 1;
}
return 0;
});
}
return gameList;
}
/**
* Handler for general events
* @param {Socket} socket Socket.io instance
* @param {UptimeKumaServer} server Uptime Kuma server
* @returns {void}
*/
module.exports.generalSocketHandler = (socket, server) => {
socket.on("initServerTimezone", async (timezone) => {
try {
checkLogin(socket);
log.debug("generalSocketHandler", "Timezone: " + timezone);
await Settings.set("initServerTimezone", true);
await server.setTimezone(timezone);
await sendInfo(socket);
} catch (e) {
log.warn("initServerTimezone", e.message);
}
});
socket.on("getGameList", async (callback) => {
try {
checkLogin(socket);
callback({
ok: true,
gameList: getGameList(),
});
} catch (e) {
callback({
ok: false,
msg: e.message,
});
}
});
socket.on("testChrome", (executable, callback) => {
try {
checkLogin(socket);
// Just noticed that await call could block the whole socket.io server!!! Use pure promise instead.
testChrome(executable).then((version) => {
callback({
ok: true,
msg: {
key: "foundChromiumVersion",
values: [ version ],
},
msgi18n: true,
});
}).catch((e) => {
callback({
ok: false,
msg: e.message,
});
});
} catch (e) {
callback({
ok: false,
msg: e.message,
});
}
});
socket.on("getPushExample", async (language, callback) => {
try {
checkLogin(socket);
if (!/^[a-z-]+$/.test(language)) {
throw new Error("Invalid language");
}
} catch (e) {
callback({
ok: false,
msg: e.message,
});
return;
}
try {
let dir = path.join("./extra/push-examples", language);
let files = await fsAsync.readdir(dir);
for (let file of files) {
if (file.startsWith("index.")) {
callback({
ok: true,
code: await fsAsync.readFile(path.join(dir, file), "utf8"),
});
return;
}
}
} catch (e) {
}
callback({
ok: false,
msg: "Not found",
});
});
// Disconnect all other socket clients of the user
socket.on("disconnectOtherSocketClients", async () => {
try {
checkLogin(socket);
server.disconnectAllSocketClients(socket.userID, socket.id);
} catch (e) {
log.warn("disconnectAllSocketClients", e.message);
}
});
// User Management Socket Handlers
// Only admins should be able to manage users.
socket.on("getUsers", async (callback) => {
try {
checkLogin(socket);
await isAdmin(socket); // Ensure the user is an admin
const userList = await R.findAll("user", "ORDER BY username");
// Avoid sending password hashes to the client
const sanitizedUserList = userList.map(user => {
const { password, ...sanitizedUser } = user.export();
return sanitizedUser;
});
callback({
ok: true,
users: sanitizedUserList,
});
} catch (e) {
log.error("getUsers", e.message);
callback({
ok: false,
msg: e.message,
});
}
});
socket.on("updateUserType", async (userID, newUserType, callback) => {
try {
checkLogin(socket);
await isAdmin(socket); // Ensure the user is an admin
if (!userID || !newUserType) {
throw new Error("User ID and new user type are required.");
}
// Prevent admin from changing their own type if they are the only admin?
// Or prevent changing the type of the main admin user? (e.g., user with ID 1)
// For now, let's assume such checks are handled by higher-level logic or are not required.
const user = await R.findOne("user", "id = ?", [userID]);
if (!user) {
throw new Error("User not found.");
}
// Potentially validate newUserType against a list of allowed types
const allowedTypes = ["admin", "editor", "viewer"]; // Example types
if (!allowedTypes.includes(newUserType)) {
throw new Error(`Invalid user type: ${newUserType}. Allowed types are: ${allowedTypes.join(", ")}`);
}
user.user_type = newUserType;
await R.store(user);
// Optionally, emit an event to other admins that a user type has changed
// server.sendToAdmins("userTypeChanged", { userID, newUserType });
callback({
ok: true,
msg: `User type for user ID ${userID} updated to ${newUserType}.`,
});
} catch (e) {
log.error("updateUserType", e.message);
callback({
ok: false,
msg: e.message,
});
}
});
};