72 lines
1.7 KiB
JavaScript
72 lines
1.7 KiB
JavaScript
/**
|
|
* @author Marzavec ( https://github.com/marzavec )
|
|
* @summary Simple stats
|
|
* @version 1.0.0
|
|
* @description Sends back legacy server stats to the calling client
|
|
* @module stats
|
|
*/
|
|
|
|
import {
|
|
Info,
|
|
} from '../utility/_Constants.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({ core, server, socket }) {
|
|
// must be in a channel to run this command
|
|
if (typeof socket.channel === 'undefined') {
|
|
return server.police.frisk(socket, 1);
|
|
}
|
|
|
|
// gather connection and channel count
|
|
let ips = {};
|
|
let channels = {};
|
|
|
|
server.clients.forEach((client) => {
|
|
if (client.channel) {
|
|
channels[client.channel] = true;
|
|
ips[client.address] = true;
|
|
}
|
|
});
|
|
|
|
const uniqueClientCount = Object.keys(ips).length;
|
|
const uniqueChannels = Object.keys(channels).length;
|
|
|
|
ips = null;
|
|
channels = null;
|
|
|
|
// dispatch info
|
|
server.reply({
|
|
cmd: 'info',
|
|
text: `${uniqueClientCount} unique IPs in ${uniqueChannels} channels`,
|
|
id: Info.Core.STATS_BASIC,
|
|
channel: socket.channel, // @todo Multichannel
|
|
}, socket);
|
|
|
|
// stats are fun
|
|
core.stats.increment('stats-requested');
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Module meta information
|
|
* @public
|
|
* @typedef {Object} stats/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: 'stats',
|
|
category: 'core',
|
|
description: 'Sends back legacy server stats to the calling client',
|
|
usage: `
|
|
API: { cmd: 'stats' }`,
|
|
};
|