2022-06-23 00:32:51 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: mod/kick.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: mod/kick.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
|
|
|
* @author Marzavec ( https://github.com/marzavec )
|
|
|
|
|
* @summary Give da boot
|
|
|
|
|
* @version 1.0.0
|
|
|
|
|
* @description Silently forces target client(s) into another channel
|
|
|
|
|
* @module kick
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
isModerator,
|
|
|
|
|
levels,
|
|
|
|
|
getUserDetails,
|
|
|
|
|
} from '../utility/_UAC.js';
|
|
|
|
|
import {
|
|
|
|
|
Errors,
|
|
|
|
|
} from '../utility/_Constants.js';
|
|
|
|
|
import {
|
|
|
|
|
findUsers,
|
|
|
|
|
} from '../utility/_Channels.js';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 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, payload,
|
|
|
|
|
}) {
|
|
|
|
|
// increase rate limit chance and ignore if not admin or mod
|
|
|
|
|
if (!isModerator(socket.level)) {
|
2023-12-27 16:26:49 +08:00
|
|
|
return server.police.frisk(socket, 10);
|
2022-06-23 00:32:51 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check user input
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
if (typeof payload.nick !== 'string') {
|
|
|
|
|
if (typeof payload.nick !== 'object' && !Array.isArray(payload.nick)) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
payload.channel = socket.channel; // eslint-disable-line no-param-reassign
|
|
|
|
|
} else if (typeof payload.userid !== 'number') {
|
|
|
|
|
// @todo create multi-ban ui
|
|
|
|
|
if (typeof payload.userid !== 'object' && !Array.isArray(payload.userid)) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// find target user(s)
|
|
|
|
|
const badClients = findUsers(server, payload);
|
|
|
|
|
if (badClients.length === 0) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Could not find user(s) in that channel',
|
|
|
|
|
id: Errors.Global.UNKNOWN_USER,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check if found targets are kickable, add them to the list if they are
|
|
|
|
|
const kicked = [];
|
|
|
|
|
for (let i = 0, j = badClients.length; i < j; i += 1) {
|
|
|
|
|
if (badClients[i].level >= socket.level) {
|
|
|
|
|
server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Cannot kick other users with the same level, how rude',
|
|
|
|
|
id: Errors.Global.PERMISSION,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
} else {
|
|
|
|
|
kicked.push(badClients[i]);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (kicked.length === 0) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let destChannel;
|
|
|
|
|
if (typeof payload.to === 'string' && !!payload.to.trim()) {
|
|
|
|
|
destChannel = payload.to;
|
|
|
|
|
} else {
|
|
|
|
|
destChannel = Math.random().toString(36).substr(2, 8);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Announce the kicked clients arrival in destChannel and that they were kicked
|
|
|
|
|
// Before they arrive, so they don't see they got moved
|
|
|
|
|
for (let i = 0; i < kicked.length; i += 1) {
|
|
|
|
|
server.broadcast({
|
|
|
|
|
...getUserDetails(kicked[i]),
|
|
|
|
|
...{
|
|
|
|
|
cmd: 'onlineAdd',
|
|
|
|
|
channel: destChannel, // @todo Multichannel
|
|
|
|
|
},
|
|
|
|
|
}, { channel: destChannel });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Move all kicked clients to the new channel
|
|
|
|
|
for (let i = 0; i < kicked.length; i += 1) {
|
|
|
|
|
// @todo multi-channel update
|
|
|
|
|
kicked[i].channel = destChannel;
|
|
|
|
|
|
|
|
|
|
server.broadcast({
|
|
|
|
|
cmd: 'info',
|
|
|
|
|
text: `${kicked[i].nick} was banished to ?${destChannel}`,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, { channel: socket.channel, level: isModerator });
|
|
|
|
|
|
|
|
|
|
console.log(`${socket.nick} [${socket.trip}] kicked ${kicked[i].nick} in ${socket.channel} to ${destChannel} `);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// broadcast client leave event
|
|
|
|
|
for (let i = 0, j = kicked.length; i < j; i += 1) {
|
|
|
|
|
server.broadcast({
|
|
|
|
|
cmd: 'onlineRemove',
|
|
|
|
|
userid: kicked[i].userid,
|
|
|
|
|
nick: kicked[i].nick,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, { channel: socket.channel });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// publicly broadcast kick event
|
|
|
|
|
server.broadcast({
|
|
|
|
|
cmd: 'info',
|
|
|
|
|
text: `Kicked ${kicked.map((k) => k.nick).join(', ')}`,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, { channel: socket.channel, level: (level) => level < levels.moderator });
|
|
|
|
|
|
|
|
|
|
// stats are fun
|
|
|
|
|
core.stats.increment('users-kicked', kicked.length);
|
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Module meta information
|
|
|
|
|
* @public
|
|
|
|
|
* @typedef {Object} kick/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: 'kick',
|
|
|
|
|
category: 'moderators',
|
|
|
|
|
description: 'Silently forces target client(s) into another channel. `nick` may be string or array of strings',
|
|
|
|
|
usage: `
|
|
|
|
|
API: { cmd: 'kick', nick: '<target nick>', to: '<optional target channel>' }`,
|
|
|
|
|
};
|
|
|
|
|
</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>
|
