2022-06-23 00:32:51 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: core/stats.js</title>
|
|
|
|
|
|
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
|
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: core/stats.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
|
|
|
* @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
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes when invoked by a remote client
|
|
|
|
|
* @param {Object} env - Enviroment object with references to core, server, socket & payload
|
|
|
|
|
* @public
|
|
|
|
|
* @return {void}
|
|
|
|
|
*/
|
|
|
|
|
export async function run({ core, server, socket }) {
|
|
|
|
|
// gather connection and channel count
|
|
|
|
|
let ips = {};
|
|
|
|
|
let channels = {};
|
|
|
|
|
// for (const client of server.clients) {
|
|
|
|
|
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`,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
|
|
|
|
|
// stats are fun
|
|
|
|
|
core.stats.increment('stats-requested');
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 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' }`,
|
|
|
|
|
};
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
|
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-addmod.html">addmod</a></li><li><a href="module-ban.html">ban</a></li><li><a href="module-changecolor.html">changecolor</a></li><li><a href="module-changenick.html">changenick</a></li><li><a href="module-chat.html">chat</a></li><li><a href="module-disconnect.html">disconnect</a></li><li><a href="module-dumb.html">dumb</a></li><li><a href="module-emote.html">emote</a></li><li><a href="module-forcecolor.html">forcecolor</a></li><li><a href="module-help.html">help</a></li><li><a href="module-invite.html">invite</a></li><li><a href="module-join.html">join</a></li><li><a href="module-kick.html">kick</a></li><li><a href="module-listusers.html">listusers</a></li><li><a href="module-morestats.html">morestats</a></li><li><a href="module-ping.html">ping</a></li><li><a href="module-reload.html">reload</a></li><li><a href="module-removemod.html">removemod</a></li><li><a href="module-saveconfig.html">saveconfig</a></li><li><a href="module-session.html">session</a></li><li><a href="module-shout.html">shout</a></li><li><a href="module-socketreply.html">socketreply</a></li><li><a href="module-speak.html">speak</a></li><li><a href="module-stats.html">stats</a></li><li><a href="module-unban.html">unban</a></li><li><a href="module-unbanall.html">unbanall</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2023-12-22 15:14:03 +08:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 05 2022 00:29:35 GMT-0700 (Pacific Daylight Time)
|
2022-06-23 00:32:51 +08:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
