1
0
mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00
hack-chat-main/commands/internal/disconnect.js
marzavec 7ecb31c46c channel ownership base, part 1
Fleshing out the new channel ownership feature, along with a typo fix and small syntax updates.

A claim can now be staked with /claimchannel, a channel owner may change a trip's level using /setlevel

To do: unclaimchannel, setmotd, makeprivate, makepublic, renewclaim, garbage keeping, update mod commands to accept channelOwner and channelModerator, etc
2024-01-05 00:30:28 -08:00

67 lines
1.8 KiB
JavaScript

/**
* @author Marzavec ( https://github.com/marzavec )
* @summary Disconnection handler
* @version 1.0.0
* @description The server invokes this module each time a websocket connection is disconnected
* @module disconnect
*/
import {
socketInChannel,
} from '../utility/_Channels.js';
/**
* Executes when invoked by a remote client
* @param {Object} env - Environment object with references to core, server, socket & payload
* @public
* @return {void}
*/
export async function run({ server, socket, payload }) {
if (payload.cmdKey !== server.cmdKey) {
// internal command attempt by client, increase rate limit chance and ignore
return server.police.frisk(socket, 20);
}
// send leave notice to client peers
// @todo Multichannel update
if (socket.channel) {
const isDuplicate = socketInChannel(server, socket.channel, socket);
if (isDuplicate === false) {
server.broadcast({
cmd: 'onlineRemove',
nick: socket.nick,
}, { channel: socket.channel });
}
}
// commit close just in case
socket.terminate();
return true;
}
/**
* The following payload properties are required to invoke this module:
* "cmdKey"
* @public
* @typedef {Array} disconnect/requiredData
*/
export const requiredData = ['cmdKey'];
/**
* Module meta information
* @public
* @typedef {Object} disconnect/info
* @property {string} name - Module command name
* @property {string} category - Module category name
* @property {string} description - Information about module
* @property {string} usage - Information about module usage
*/
export const info = {
name: 'disconnect',
category: 'internal',
description: 'Internally used to relay disconnect events to clients',
usage: 'Internal Use Only',
};