2023-12-30 15:24:12 +08:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: mod/enablecaptcha.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/enablecaptcha.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/* eslint no-param-reassign: 0 */
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @author Marzavec ( https://github.com/marzavec )
|
|
|
|
|
* @summary Enables the captcha
|
|
|
|
|
* @version 1.0.0
|
|
|
|
|
* @description Enables the captcha on the channel specified in the channel property,
|
|
|
|
|
* default is current channel
|
|
|
|
|
* @module enablecaptcha
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import captcha from 'ascii-captcha';
|
|
|
|
|
|
|
|
|
|
import {
|
|
|
|
|
isTrustedUser,
|
|
|
|
|
isModerator,
|
|
|
|
|
verifyNickname,
|
|
|
|
|
getUserPerms,
|
|
|
|
|
} from '../utility/_UAC.js';
|
|
|
|
|
import {
|
|
|
|
|
canJoinChannel,
|
|
|
|
|
} from '../utility/_Channels.js';
|
|
|
|
|
import {
|
|
|
|
|
upgradeLegacyJoin,
|
|
|
|
|
legacyLevelToLabel,
|
|
|
|
|
} from '../utility/_LegacyFunctions.js';
|
|
|
|
|
import {
|
|
|
|
|
Errors,
|
|
|
|
|
} from '../utility/_Constants.js';
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Automatically executes once after server is ready
|
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 16:30:28 +08:00
|
|
|
* @param {Object} core - Reference to core environment object
|
2023-12-30 15:24:12 +08:00
|
|
|
* @public
|
|
|
|
|
* @return {void}
|
|
|
|
|
*/
|
|
|
|
|
export async function init(core) {
|
|
|
|
|
if (typeof core.captchas === 'undefined') {
|
|
|
|
|
core.captchas = {};
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes when invoked by a remote client
|
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 16:30:28 +08:00
|
|
|
* @param {Object} env - Environment object with references to core, server, socket & payload
|
2023-12-30 15:24:12 +08:00
|
|
|
* @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)) {
|
|
|
|
|
return server.police.frisk(socket, 10);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let targetChannel;
|
|
|
|
|
|
|
|
|
|
if (typeof payload.channel !== 'string') {
|
|
|
|
|
if (typeof socket.channel !== 'string') { // @todo Multichannel
|
|
|
|
|
return false; // silently fail
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
targetChannel = socket.channel;
|
|
|
|
|
} else {
|
|
|
|
|
targetChannel = payload.channel;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (core.captchas[targetChannel]) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'info',
|
|
|
|
|
text: 'Captcha is already enabled.',
|
|
|
|
|
channel: socket.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
core.captchas[targetChannel] = true;
|
|
|
|
|
|
|
|
|
|
server.broadcast({
|
|
|
|
|
cmd: 'info',
|
|
|
|
|
text: `Captcha enabled on: ${targetChannel}`,
|
|
|
|
|
channel: socket.channel, // @todo Multichannel, false for global info
|
|
|
|
|
}, { channel: socket.channel, level: isModerator });
|
|
|
|
|
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Automatically executes once after server is ready to register this modules hooks
|
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 16:30:28 +08:00
|
|
|
* @param {Object} server - Reference to server environment object
|
2023-12-30 15:24:12 +08:00
|
|
|
* @public
|
|
|
|
|
* @return {void}
|
|
|
|
|
*/
|
|
|
|
|
export function initHooks(server) {
|
|
|
|
|
server.registerHook('in', 'chat', this.chatCheck.bind(this), 5);
|
|
|
|
|
server.registerHook('in', 'join', this.joinCheck.bind(this), 5);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes every time an incoming chat command is invoked;
|
|
|
|
|
* hook incoming chat commands, check if they are answering a captcha
|
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 16:30:28 +08:00
|
|
|
* @param {Object} env - Environment object with references to core, server, socket & payload
|
2023-12-30 15:24:12 +08:00
|
|
|
* @public
|
|
|
|
|
* @return {(Object|boolean|string)} Object = same/altered payload,
|
|
|
|
|
* false = suppress action,
|
|
|
|
|
* string = error
|
|
|
|
|
*/
|
|
|
|
|
export function chatCheck({
|
|
|
|
|
core, server, socket, payload,
|
|
|
|
|
}) {
|
|
|
|
|
// always verifiy user input
|
|
|
|
|
if (typeof payload.text !== 'string') {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (typeof socket.captcha !== 'undefined') {
|
|
|
|
|
if (socket.captcha.awaiting === true) {
|
|
|
|
|
if (payload.text === socket.captcha.solution) {
|
|
|
|
|
if (typeof socket.captcha.whitelist === 'undefined') {
|
|
|
|
|
socket.captcha.whitelist = [];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
socket.captcha.whitelist.push(socket.captcha.origChannel);
|
|
|
|
|
socket.captcha.awaiting = false;
|
|
|
|
|
|
|
|
|
|
if (socket.hcProtocol === 1) {
|
|
|
|
|
core.commands.handleCommand(server, socket, {
|
|
|
|
|
cmd: 'join',
|
|
|
|
|
nick: `${socket.captcha.origNick}#${socket.captcha.origPass}`,
|
|
|
|
|
channel: socket.captcha.origChannel,
|
|
|
|
|
});
|
|
|
|
|
} else {
|
|
|
|
|
core.commands.handleCommand(server, socket, {
|
|
|
|
|
cmd: 'join',
|
|
|
|
|
nick: socket.captcha.origNick,
|
|
|
|
|
pass: socket.captcha.origPass,
|
|
|
|
|
channel: socket.captcha.origChannel,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
server.police.frisk(socket, 7);
|
|
|
|
|
socket.terminate();
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return payload;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Executes every time an incoming join command is invoked;
|
|
|
|
|
* hook incoming join commands, check if they are joining a captcha protected channel
|
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 16:30:28 +08:00
|
|
|
* @param {Object} env - Environment object with references to core, server, socket & payload
|
2023-12-30 15:24:12 +08:00
|
|
|
* @public
|
|
|
|
|
* @return {(Object|boolean|string)} Object = same/altered payload,
|
|
|
|
|
* false = suppress action,
|
|
|
|
|
* string = error
|
|
|
|
|
*/
|
|
|
|
|
export function joinCheck({
|
|
|
|
|
core, server, socket, payload,
|
|
|
|
|
}) {
|
|
|
|
|
// check if channel has captcha enabled
|
|
|
|
|
if (core.captchas[payload.channel] !== true) {
|
|
|
|
|
return payload;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// `join` is the legacy entry point, check if it needs to be upgraded
|
|
|
|
|
const origPayload = { ...payload };
|
|
|
|
|
if (typeof socket.hcProtocol === 'undefined') {
|
|
|
|
|
payload = upgradeLegacyJoin(server, socket, payload);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// store payload values
|
|
|
|
|
const { channel, nick, pass } = payload;
|
|
|
|
|
|
|
|
|
|
// check if a client is able to join target channel
|
|
|
|
|
const mayJoin = canJoinChannel(channel, socket);
|
|
|
|
|
if (mayJoin !== true) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'You may not join that channel.',
|
|
|
|
|
id: mayJoin,
|
|
|
|
|
channel: false, // @todo Multichannel, false for global event
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// calling socket already in a channel
|
|
|
|
|
// @todo multichannel update, will remove
|
|
|
|
|
if (typeof socket.channel !== 'undefined') {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn', // @todo Remove this
|
|
|
|
|
text: 'Joining more than one channel is not currently supported',
|
|
|
|
|
id: Errors.Join.ALREADY_JOINED,
|
|
|
|
|
channel: false, // @todo Multichannel, false for global event
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
// end todo
|
|
|
|
|
|
|
|
|
|
// validates the user input for `nick`
|
|
|
|
|
if (verifyNickname(nick, socket) !== true) {
|
|
|
|
|
return server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Nickname must consist of up to 24 letters, numbers, and underscores',
|
|
|
|
|
id: Errors.Join.INVALID_NICK,
|
|
|
|
|
channel: false, // @todo Multichannel, false for global event
|
|
|
|
|
}, socket);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// get trip and level
|
|
|
|
|
const { trip, level } = getUserPerms(pass, core.saltKey, core.appConfig.data, channel);
|
|
|
|
|
|
|
|
|
|
// store the user values
|
|
|
|
|
const userInfo = {
|
|
|
|
|
nick,
|
|
|
|
|
trip,
|
|
|
|
|
uType: legacyLevelToLabel(level),
|
|
|
|
|
hash: socket.hash,
|
|
|
|
|
level,
|
|
|
|
|
userid: socket.userid,
|
|
|
|
|
isBot: socket.isBot,
|
|
|
|
|
color: socket.color,
|
|
|
|
|
channel,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
if (userInfo.uType === 'user') {
|
|
|
|
|
if (userInfo.trip == null || isTrustedUser(level) === false) {
|
|
|
|
|
if (typeof socket.captcha === 'undefined') {
|
|
|
|
|
socket.captcha = {
|
|
|
|
|
awaiting: true,
|
|
|
|
|
origChannel: payload.channel,
|
|
|
|
|
origNick: payload.nick,
|
|
|
|
|
origPass: pass,
|
|
|
|
|
solution: captcha.generateRandomText(6),
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
server.reply({
|
|
|
|
|
cmd: 'warn',
|
|
|
|
|
text: 'Enter the following to join (case-sensitive):',
|
|
|
|
|
channel: payload.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
|
|
|
|
|
server.reply({
|
|
|
|
|
cmd: 'captcha',
|
|
|
|
|
text: captcha.word2Transformedstr(socket.captcha.solution),
|
|
|
|
|
channel: payload.channel, // @todo Multichannel
|
|
|
|
|
}, socket);
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
socket.terminate();
|
|
|
|
|
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return origPayload;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Module meta information
|
|
|
|
|
* @public
|
|
|
|
|
* @typedef {Object} enablecaptcha/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: 'enablecaptcha',
|
|
|
|
|
category: 'moderators',
|
|
|
|
|
description: 'Enables a captcha in the current channel you are in',
|
|
|
|
|
usage: `
|
|
|
|
|
API: { cmd: 'enablecaptcha', channel: '<optional channel, defaults to your current 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-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>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
|
|
|
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)
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
