2022-06-23 00:32:51 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: core/whisper.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/whisper.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/**
|
|
|
|
|
* @author Marzavec ( https://github.com/marzavec )
|
|
|
|
|
* @summary Send whisper
|
|
|
|
|
* @version 1.0.0
|
|
|
|
|
* @description Display text on target users screen that only they can see
|
|
|
|
|
* @module whisper
|
|
|
|
|
* @todo This should be changed to it's own event type, instead of `info`
|
|
|
|
|
and accept a `userid` rather than `nick`
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
findUser,
|
|
|
|
|
} from '../utility/_Channels.js';
|
|
|
|
|
import {
|
|
|
|
|
Errors,
|
|
|
|
|
} from '../utility/_Constants.js';
|
|
|
|
|
import {
|
|
|
|
|
legacyWhisperOut,
|
|
|
|
|
legacyWhisperReply,
|
|
|
|
|
} from '../utility/_LegacyFunctions.js';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Check and trim string provided by remote client
|
|
|
|
|
* @param {string} text - Subject string
|
|
|
|
|
* @private
|
|
|
|
|
* @todo Move into utility module
|
|
|
|
|
* @return {string|boolean}
|
|
|
|
|
*/
|
|
|
|
|
const parseText = (text) => {
|
|
|
|
|
// verifies user input is text
|
|
|
|
|
if (typeof text !== 'string') {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let sanitizedText = text;
|
|
|
|
|
|
|
|
|
|
// strip newlines from beginning and end
|
|
|
|
|
sanitizedText = sanitizedText.replace(/^\s*\n|^\s+$|\n\s*$/g, '');
|
|
|
|
|
// replace 3+ newlines with just 2 newlines
|
|
|
|
|
sanitizedText = sanitizedText.replace(/\n{3,}/g, '\n\n');
|
|
|
|
|
|
|
|
|
|
return sanitizedText;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 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({ server, socket, payload }) {
|
|
|
|
|
// if this is a legacy client add missing params to payload
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
payload.channel = socket.channel; // eslint-disable-line no-param-reassign
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// verify user input
|
|
|
|
|
const text = parseText(payload.text);
|
|
|
|
|
|
|
|
|
|
if (!text) {
|
|
|
|
|
// lets not send objects or empty text, yea?
|
2023-12-27 16:26:49 +08:00
|
|
|
return server.police.frisk(socket, 13);
|
2022-06-23 00:32:51 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// check for spam
|
|
|
|
|
const score = text.length / 83 / 4;
|
2023-12-27 16:26:49 +08:00
|
|
|
if (server.police.frisk(socket, score)) {
|
2022-06-23 00:32:51 +08:00
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn', // @todo Add numeric error code as `id`
|
|
|
|
|
text: 'You are sending too much text. Wait a moment and try again.\nPress the up arrow key to restore your last message.',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const targetUser = findUser(server, payload);
|
|
|
|
|
if (!targetUser) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Could not find user in that channel',
|
|
|
|
|
id: Errors.Global.UNKNOWN_USER,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const outgoingPayload = {
|
|
|
|
|
cmd: 'whisper',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
from: socket.userid,
|
|
|
|
|
to: targetUser.userid,
|
|
|
|
|
text,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// send invite notice to target client
|
|
|
|
|
if (targetUser.hcProtocol === 1) {
|
|
|
|
|
server.reply(legacyWhisperOut(outgoingPayload, socket), targetUser);
|
|
|
|
|
} else {
|
|
|
|
|
server.reply(outgoingPayload, targetUser);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// send invite notice to this client
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
server.reply(legacyWhisperReply(outgoingPayload, targetUser.nick), socket);
|
|
|
|
|
} else {
|
|
|
|
|
server.reply(outgoingPayload, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
targetUser.whisperReply = socket.nick;
|
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Automatically executes once after server is ready to register this modules hooks
|
|
|
|
|
* @param {Object} server - Reference to server enviroment object
|
|
|
|
|
* @public
|
|
|
|
|
* @return {void}
|
|
|
|
|
*/
|
|
|
|
|
export function initHooks(server) {
|
|
|
|
|
server.registerHook('in', 'chat', this.whisperCheck.bind(this), 20);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes every time an incoming chat command is invoked;
|
|
|
|
|
* hooks chat commands checking for /whisper
|
|
|
|
|
* @param {Object} env - Enviroment object with references to core, server, socket & payload
|
|
|
|
|
* @public
|
2023-12-30 15:24:12 +08:00
|
|
|
* @return {(Object|boolean|string)} Object = same/altered payload,
|
2022-06-23 00:32:51 +08:00
|
|
|
* false = suppress action,
|
|
|
|
|
* string = error
|
|
|
|
|
*/
|
|
|
|
|
export function whisperCheck({
|
|
|
|
|
core, server, socket, payload,
|
|
|
|
|
}) {
|
|
|
|
|
if (typeof payload.text !== 'string') {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (payload.text.startsWith('/whisper ') || payload.text.startsWith('/w ')) {
|
|
|
|
|
const input = payload.text.split(' ');
|
|
|
|
|
|
|
|
|
|
// If there is no nickname target parameter
|
|
|
|
|
if (!input[1]) {
|
|
|
|
|
server.reply({
|
|
|
|
|
cmd: 'warn', // @todo Add numeric error code as `id`
|
|
|
|
|
text: 'Refer to `/help whisper` for instructions on how to use this command.',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const target = input[1].replace(/@/g, '');
|
|
|
|
|
input.splice(0, 2);
|
|
|
|
|
const whisperText = input.join(' ');
|
|
|
|
|
|
|
|
|
|
this.run({
|
|
|
|
|
core,
|
|
|
|
|
server,
|
|
|
|
|
socket,
|
|
|
|
|
payload: {
|
|
|
|
|
cmd: 'whisper',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
nick: target,
|
|
|
|
|
text: whisperText,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (payload.text.startsWith('/reply ') || payload.text.startsWith('/r ')) {
|
|
|
|
|
if (typeof socket.whisperReply === 'undefined') {
|
|
|
|
|
server.reply({
|
|
|
|
|
cmd: 'warn', // @todo Add numeric error code as `id`
|
|
|
|
|
text: 'Cannot reply to nobody',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const input = payload.text.split(' ');
|
|
|
|
|
input.splice(0, 1);
|
|
|
|
|
const whisperText = input.join(' ');
|
|
|
|
|
|
|
|
|
|
this.run({
|
|
|
|
|
core,
|
|
|
|
|
server,
|
|
|
|
|
socket,
|
|
|
|
|
payload: {
|
|
|
|
|
cmd: 'whisper',
|
|
|
|
|
nick: socket.whisperReply,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
text: whisperText,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return payload;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* The following payload properties are required to invoke this module:
|
|
|
|
|
* "nick", "text"
|
|
|
|
|
* @public
|
|
|
|
|
* @typedef {Array} whisper/requiredData
|
|
|
|
|
*/
|
|
|
|
|
export const requiredData = ['nick', 'text'];
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Module meta information
|
|
|
|
|
* @public
|
|
|
|
|
* @typedef {Object} whisper/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: 'whisper',
|
|
|
|
|
category: 'core',
|
|
|
|
|
description: 'Display text on target users screen that only they can see',
|
|
|
|
|
usage: `
|
|
|
|
|
API: { cmd: 'whisper', nick: '<target name>', text: '<text to whisper>' }
|
|
|
|
|
Text: /whisper <target name> <text to whisper>
|
|
|
|
|
Text: /w <target name> <text to whisper>
|
|
|
|
|
Alt Text: /reply <text to whisper, this will auto reply to the last person who whispered to you>
|
|
|
|
|
Alt Text: /r <text to whisper, this will auto reply to the last person who whispered to you>`,
|
|
|
|
|
};
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
2023-12-30 15:24:12 +08:00
|
|
|
<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-disablecaptcha.html">disablecaptcha</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-enablecaptcha.html">enablecaptcha</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-lockroom.html">lockroom</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-unlockroom.html">unlockroom</a></li><li><a href="module-updateMessage.html">updateMessage</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
|
2022-06-23 00:32:51 +08:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
2023-12-30 15:24:12 +08:00
|
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Dec 29 2023 23:22:35 GMT-0800 (Pacific Standard Time)
|
2022-06-23 00:32:51 +08:00
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
